@readme/httpsnippet 4.1.0 → 5.0.0

package/README.md

@@ -157,6 +157,7 @@ There are some major differences between this library and the [httpsnippet](http
 
 * Includes a full integration test suite for a handful of clients and targets.
 * Does not ship with a CLI component.
+* Does not do any HAR schema validation. It's just assumed that the HAR you're supplying to the library is already valid.
 * The main `HTTPSnippet` export contains an `options` argument for an `harIsAlreadyEncoded` option for disabling [escaping](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) of cookies and query strings in URLs.
   * We added this because all HARs that we interact with already have this data escaped and this option prevents them from being double encoded, thus corrupting the data.
 * Node

package/dist/helpers/code-builder.d.ts

@@ -1,4 +1,4 @@
-export declare type PostProcessor = (unreplacedCode: string) => string;
+export type PostProcessor = (unreplacedCode: string) => string;
 export interface CodeBuilderOptions {
     /**
      * Desired indentation character for aggregated lines of code

package/dist/helpers/form-data.js

@@ -32,7 +32,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {

package/dist/helpers/headers.d.ts

@@ -1,4 +1,4 @@
-declare type Headers<T> = Record<string, T>;
+type Headers<T> = Record<string, T>;
 /**
  * Given a headers object retrieve a specific header out of it via a case-insensitive key.
  */

package/dist/helpers/reducer.d.ts

@@ -1,4 +1,4 @@
-export declare type ReducedHelperObject = Record<string, string[] | string>;
+export type ReducedHelperObject = Record<string, string[] | string>;
 export declare const reducer: <T extends {
     name: string;
     value: string;

package/dist/index.d.ts

@@ -11,11 +11,11 @@ export { addTarget, addTargetClient } from './targets/targets';
  *
  * Then, in addition to that, it really adds to complexity with TypeScript (TypeScript takes this constraint very very seriously) in a way that's not actually super useful.  So, we treat this object as though it could have both or either of `params` and/or `text`.
  */
-declare type PostDataBase = PostDataCommon & {
+type PostDataBase = PostDataCommon & {
     text?: string;
     params?: Param[];
 };
-export declare type HarRequest = Omit<NpmHarRequest, 'postData'> & {
+export type HarRequest = Omit<NpmHarRequest, 'postData'> & {
     postData: PostDataBase;
 };
 export interface RequestExtras {
@@ -31,7 +31,7 @@ export interface RequestExtras {
     cookiesObj: ReducedHelperObject;
     allHeaders: ReducedHelperObject;
 }
-export declare type Request = HarRequest & RequestExtras;
+export type Request = HarRequest & RequestExtras;
 interface Entry {
     request: Partial<HarRequest>;
 }

package/dist/index.js

@@ -43,7 +43,6 @@ var event_stream_1 = require("event-stream");
 var form_data_1 = __importDefault(require("form-data"));
 var qs_1 = require("qs");
 var form_data_2 = require("./helpers/form-data");
-var har_validator_1 = require("./helpers/har-validator");
 var headers_1 = require("./helpers/headers");
 var reducer_1 = require("./helpers/reducer");
 var targets_1 = require("./targets/targets");
@@ -279,9 +278,7 @@ var HTTPSnippet = /** @class */ (function () {
             if (req.postData && !req.postData.mimeType) {
                 req.postData.mimeType = 'application/octet-stream';
             }
-            if ((0, har_validator_1.validateHarRequest)(req)) {
-                _this.requests.push(_this.prepare(req, options));
-            }
+            _this.requests.push(_this.prepare(req, options));
         });
     }
     return HTTPSnippet;

package/dist/targets/powershell/common.d.ts

@@ -1,3 +1,3 @@
 import type { Converter } from '../targets';
-export declare type PowershellCommand = 'Invoke-RestMethod' | 'Invoke-WebRequest';
+export type PowershellCommand = 'Invoke-RestMethod' | 'Invoke-WebRequest';
 export declare const generatePowershellConvert: (command: PowershellCommand) => Converter<any>;

package/dist/targets/targets.d.ts

@@ -1,20 +1,20 @@
 import type { Request } from '..';
 import type { CodeBuilderOptions } from '../helpers/code-builder';
 import type { Merge } from 'type-fest';
-export declare type TargetId = keyof typeof targets;
-export declare type ClientId = string;
+export type TargetId = keyof typeof targets;
+export type ClientId = string;
 export interface ClientInfo {
     key: ClientId;
     title: string;
     link: string;
     description: string;
 }
-export declare type Converter<T extends Record<string, any>> = (request: Request, options?: Merge<CodeBuilderOptions, T>) => string;
+export type Converter<T extends Record<string, any>> = (request: Request, options?: Merge<CodeBuilderOptions, T>) => string;
 export interface Client<T extends Record<string, any> = Record<string, any>> {
     info: ClientInfo;
     convert: Converter<T>;
 }
-export declare type Extension = `.${string}` | null;
+export type Extension = `.${string}` | null;
 export interface TargetInfo {
     key: TargetId;
     title: string;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "4.1.0",
+  "version": "5.0.0",
   "name": "@readme/httpsnippet",
   "description": "HTTP Request snippet generator for *most* languages",
   "homepage": "https://github.com/readmeio/httpsnippet",
@@ -57,28 +57,26 @@
     "test": "jest --coverage"
   },
   "devDependencies": {
-    "@readme/eslint-config": "^10.1.0",
+    "@readme/eslint-config": "^10.3.2",
     "@types/eslint": "^8.4.1",
     "@types/event-stream": "^4.0.0",
     "@types/har-format": "^1.2.8",
     "@types/jest": "^28.1.6",
-    "@types/node": "^18.6.3",
+    "@types/node": "^18.11.18",
     "@types/qs": "^6.9.7",
-    "@types/stringify-object": "^4.0.1",
-    "eslint": "^8.19.0",
+    "@types/stringify-object": "^4.0.2",
+    "eslint": "^8.31.0",
     "glob": "^8.0.1",
     "jest": "^28.0.3",
-    "prettier": "^2.7.1",
+    "prettier": "^2.8.1",
     "require-directory": "^2.1.1",
     "ts-jest": "^28.0.5",
-    "type-fest": "^3.0.0",
-    "typescript": "^4.6.3"
+    "type-fest": "^3.5.0",
+    "typescript": "^4.9.4"
   },
   "dependencies": {
-    "ajv": "^6.12.6",
     "event-stream": "4.0.1",
     "form-data": "^4.0.0",
-    "har-schema": "^2.0.0",
     "qs": "^6.10.1",
     "stringify-object": "^3.3.0"
   },

package/dist/helpers/har-validator.d.ts

@@ -1,9 +0,0 @@
-import type { ErrorObject } from 'ajv';
-import type { Request } from 'har-format';
-export declare class HARError extends Error {
-    name: string;
-    message: string;
-    errors: ErrorObject[];
-    constructor(errors: ErrorObject[]);
-}
-export declare const validateHarRequest: (request: any) => request is Request;

package/dist/helpers/har-validator.js

@@ -1,76 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-exports.__esModule = true;
-exports.validateHarRequest = exports.HARError = void 0;
-var ajv_1 = __importDefault(require("ajv"));
-var schema = __importStar(require("har-schema"));
-var HARError = /** @class */ (function (_super) {
-    __extends(HARError, _super);
-    function HARError(errors) {
-        var _this = _super.call(this) || this;
-        _this.name = 'HARError';
-        _this.message = 'validation failed';
-        _this.errors = [];
-        _this.errors = errors;
-        Error.captureStackTrace(_this, _this.constructor);
-        return _this;
-    }
-    return HARError;
-}(Error));
-exports.HARError = HARError;
-var ajv = new ajv_1["default"]({
-    allErrors: true
-});
-ajv.addSchema(schema);
-var validateHarRequest = function (request) {
-    var validate = ajv.getSchema('request.json');
-    if (!validate) {
-        throw new Error('failed to find HAR request schema');
-    }
-    var valid = validate(request);
-    if (!valid && validate.errors) {
-        throw new HARError(validate.errors);
-    }
-    return true;
-};
-exports.validateHarRequest = validateHarRequest;