@readme/httpsnippet 4.0.0 → 4.0.3

package/src/helpers/reducer.test.ts

@@ -1,27 +0,0 @@
-import { reducer } from './reducer';
-
-describe('reducer', () => {
-  it('should convert array object pair to key-value object', () => {
-    const query = [
-      { name: 'key', value: 'value' },
-      { name: 'foo', value: 'bar' },
-    ];
-
-    const result = query.reduce(reducer, {});
-
-    expect(result).toMatchObject({ key: 'value', foo: 'bar' });
-  });
-
-  it('should convert multi-dimensional arrays to key=[array] object', () => {
-    const query = [
-      { name: 'key', value: 'value' },
-      { name: 'foo', value: 'bar1' },
-      { name: 'foo', value: 'bar2' },
-      { name: 'foo', value: 'bar3' },
-    ];
-
-    const result = query.reduce(reducer, {});
-
-    expect(result).toMatchObject({ key: 'value', foo: ['bar1', 'bar2', 'bar3'] });
-  });
-});

package/src/helpers/reducer.ts

@@ -1,19 +0,0 @@
-export type ReducedHelperObject = Record<string, string[] | string>;
-
-export const reducer = <T extends { name: string; value: string }>(accumulator: ReducedHelperObject, pair: T) => {
-  const currentValue = accumulator[pair.name];
-  if (currentValue === undefined) {
-    accumulator[pair.name] = pair.value;
-    return accumulator;
-  }
-
-  // If we already have it as array just push the value
-  if (Array.isArray(currentValue)) {
-    currentValue.push(pair.value);
-    return accumulator;
-  }
-
-  // convert to array since now we have more than one value for this key
-  accumulator[pair.name] = [currentValue, pair.value];
-  return accumulator;
-};

package/src/helpers/shell.ts

@@ -1,18 +0,0 @@
-/**
- * Use 'strong quoting' using single quotes so that we only need to deal with nested single quote characters.
- * see: http://wiki.bash-hackers.org/syntax/quoting#strong_quoting
- */
-export const quote = (value = '') => {
-  const safe = /^[a-z0-9-_/.@%^=:]+$/i;
-
-  const isShellSafe = safe.test(value);
-
-  if (isShellSafe) {
-    return value;
-  }
-
-  // if the value is not shell safe, then quote it
-  return `'${value.replace(/'/g, "'\\''")}'`;
-};
-
-export const escape = (value: string) => value.replace(/\r/g, '\\r').replace(/\n/g, '\\n');

package/src/helpers/utils.test.ts

@@ -1,19 +0,0 @@
-import { availableTargets, extname } from './utils';
-
-describe('availableTargets', () => {
-  it('returns all available targets', () => {
-    expect(availableTargets()).toMatchSnapshot();
-  });
-});
-
-describe('extname', () => {
-  it('returns the correct extension', () => {
-    expect(extname('c')).toBe('.c');
-    expect(extname('clojure')).toBe('.clj');
-  });
-
-  it('returns empty string if the extension is not found', () => {
-    // @ts-expect-error intentionally incorrect
-    expect(extname('ziltoid')).toBe('');
-  });
-});

package/src/helpers/utils.ts

@@ -1,16 +0,0 @@
-import type { ClientInfo, TargetId, TargetInfo } from '../targets/targets';
-import { targets } from '../targets/targets';
-
-export interface AvailableTarget extends TargetInfo {
-  clients: ClientInfo[];
-}
-
-export const availableTargets = () =>
-  Object.keys(targets).map<AvailableTarget>(targetId => ({
-    ...targets[targetId as TargetId].info,
-    clients: Object.keys(targets[targetId as TargetId].clientsById).map(
-      clientId => targets[targetId as TargetId].clientsById[clientId].info
-    ),
-  }));
-
-export const extname = (targetId: TargetId) => targets[targetId]?.info.extname || '';

package/src/index.test.ts

@@ -1,221 +0,0 @@
-import type { Request } from '.';
-import { mimetypes } from './fixtures/mimetypes';
-import headers from './fixtures/requests/headers';
-import query from './fixtures/requests/query';
-import short from './fixtures/requests/short';
-import { HTTPSnippet } from '.';
-
-describe('HTTPSnippet', () => {
-  it('should return false if no matching target', () => {
-    const snippet = new HTTPSnippet(short.log.entries[0].request as Request);
-    // @ts-expect-error intentionally incorrect
-    const result = snippet.convert(null);
-
-    expect(result).toBe(false);
-  });
-
-  it('should fail validation for non-HAR inputs', () => {
-    expect.assertions(1);
-
-    // @ts-expect-error intentionally incorrect
-    const attempt = () => new HTTPSnippet({ ziltoid: 'the omniscient' });
-
-    expect(attempt).toThrow('validation failed');
-  });
-
-  it('should parse HAR file with multiple entries', () => {
-    const snippet = new HTTPSnippet({
-      log: {
-        version: '1.2',
-        creator: {
-          name: 'HTTPSnippet',
-          version: '1.0.0',
-        },
-        entries: [
-          {
-            request: {
-              method: 'GET',
-              url: 'https://httpbin.org/anything',
-            },
-          },
-          {
-            request: {
-              method: 'POST',
-              url: 'https://httpbin.org/anything',
-            },
-          },
-        ],
-      },
-    });
-
-    expect(snippet).toHaveProperty('requests');
-    expect(Array.isArray(snippet.requests)).toBeTruthy();
-    expect(snippet.requests).toHaveLength(2);
-  });
-
-  describe('mimetype conversion', () => {
-    it.each([
-      {
-        input: 'multipart/mixed',
-        expected: 'multipart/form-data',
-      },
-      {
-        input: 'multipart/related',
-        expected: 'multipart/form-data',
-      },
-      {
-        input: 'multipart/alternative',
-        expected: 'multipart/form-data',
-      },
-      {
-        input: 'text/json',
-        expected: 'application/json',
-      },
-      {
-        input: 'text/x-json',
-        expected: 'application/json',
-      },
-      {
-        input: 'application/x-json',
-        expected: 'application/json',
-      },
-      {
-        input: 'invalid-json',
-        expected: 'text/plain',
-      },
-    ] as {
-      input: keyof typeof mimetypes;
-      expected: string;
-    }[])('mimetype conversion of $input to $output', ({ input, expected }) => {
-      const snippet = new HTTPSnippet(mimetypes[input]);
-      const request = snippet.requests[0];
-
-      expect(request.postData.mimeType).toStrictEqual(expected);
-    });
-  });
-
-  it('should set postData.text to empty string when postData.params is undefined in application/x-www-form-urlencoded', () => {
-    const snippet = new HTTPSnippet(mimetypes['application/x-www-form-urlencoded']);
-    const request = snippet.requests[0];
-
-    expect(request.postData.text).toBe('');
-  });
-
-  describe('requestExtras', () => {
-    describe('uriObj', () => {
-      it('should add uriObj', () => {
-        const snippet = new HTTPSnippet(query.log.entries[0].request as Request);
-        const request = snippet.requests[0];
-
-        expect(request.uriObj).toMatchObject({
-          auth: null,
-          hash: null,
-          host: 'httpbin.org',
-          hostname: 'httpbin.org',
-          href: 'https://httpbin.org/anything?key=value',
-          path: '/anything?foo=bar&foo=baz&baz=abc&key=value',
-          pathname: '/anything',
-          port: null,
-          protocol: 'https:',
-          query: {
-            baz: 'abc',
-            key: 'value',
-            foo: ['bar', 'baz'],
-          },
-          search: 'foo=bar&foo=baz&baz=abc&key=value',
-          slashes: true,
-        });
-      });
-
-      it('should fix the `path` property of uriObj to match queryString', () => {
-        const snippet = new HTTPSnippet(query.log.entries[0].request as Request);
-        const request = snippet.requests[0];
-
-        expect(request.uriObj.path).toBe('/anything?foo=bar&foo=baz&baz=abc&key=value');
-      });
-    });
-
-    describe('queryObj', () => {
-      it('should add queryObj', () => {
-        const snippet = new HTTPSnippet(query.log.entries[0].request as Request);
-        const request = snippet.requests[0];
-
-        expect(request.queryObj).toMatchObject({ baz: 'abc', key: 'value', foo: ['bar', 'baz'] });
-      });
-    });
-
-    describe('headersObj', () => {
-      it('should add headersObj', () => {
-        const snippet = new HTTPSnippet(headers.log.entries[0].request as Request);
-        const request = snippet.requests[0];
-
-        expect(request.headersObj).toMatchObject({
-          accept: 'application/json',
-          'x-foo': 'Bar',
-        });
-      });
-
-      it('should add headersObj to source object case insensitive when HTTP/1.0', () => {
-        const snippet = new HTTPSnippet({
-          ...headers.log.entries[0].request,
-          httpVersion: 'HTTP/1.1',
-          headers: [
-            ...headers.log.entries[0].request.headers,
-            {
-              name: 'Kong-Admin-Token',
-              value: 'Ziltoid The Omniscient',
-            },
-          ],
-        } as Request);
-
-        const request = snippet.requests[0];
-
-        expect(request.headersObj).toMatchObject({
-          'Kong-Admin-Token': 'Ziltoid The Omniscient',
-          accept: 'application/json',
-          'x-foo': 'Bar',
-        });
-      });
-
-      it('should add headersObj to source object lowercased when HTTP/2.x', () => {
-        const snippet = new HTTPSnippet({
-          ...headers.log.entries[0].request,
-          httpVersion: 'HTTP/2',
-          headers: [
-            ...headers.log.entries[0].request.headers,
-            {
-              name: 'Kong-Admin-Token',
-              value: 'Ziltoid The Omniscient',
-            },
-          ],
-        } as Request);
-
-        const request = snippet.requests[0];
-
-        expect(request.headersObj).toMatchObject({
-          'kong-admin-token': 'Ziltoid The Omniscient',
-          accept: 'application/json',
-          'x-foo': 'Bar',
-        });
-      });
-    });
-
-    describe('url', () => {
-      it('should modify the original url to strip query string', () => {
-        const snippet = new HTTPSnippet(query.log.entries[0].request as Request);
-        const request = snippet.requests[0];
-
-        expect(request.url).toBe('https://httpbin.org/anything');
-      });
-    });
-
-    describe('fullUrl', () => {
-      it('adds fullURL', () => {
-        const snippet = new HTTPSnippet(query.log.entries[0].request as Request);
-        const request = snippet.requests[0];
-
-        expect(request.fullUrl).toBe('https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value');
-      });
-    });
-  });
-});

package/src/index.ts

@@ -1,361 +0,0 @@
-import type { Param, PostDataCommon, Request as NpmHarRequest } from 'har-format';
-import type { UrlWithParsedQuery } from 'url';
-import type { ReducedHelperObject } from './helpers/reducer';
-import type { ClientId, TargetId } from './targets/targets';
-import { map as eventStreamMap } from 'event-stream';
-import FormData from 'form-data';
-import { stringify as queryStringify } from 'qs';
-// eslint-disable-next-line node/no-deprecated-api
-import { format as urlFormat, parse as urlParse } from 'url';
-
-import { formDataIterator, isBlob } from './helpers/form-data';
-import { validateHarRequest } from './helpers/har-validator';
-import { getHeaderName } from './helpers/headers';
-import { reducer } from './helpers/reducer';
-import { targets } from './targets/targets';
-
-export { availableTargets, extname } from './helpers/utils';
-export { addTarget, addTargetClient } from './targets/targets';
-
-const DEBUG_MODE = false;
-
-const debug = {
-  // eslint-disable-next-line @typescript-eslint/no-empty-function -- intentional noop
-  info: DEBUG_MODE ? console.info : () => {},
-};
-
-/** is this wrong?  yes.  according to the spec (http://www.softwareishard.com/blog/har-12-spec/#postData) it's technically wrong since `params` and `text` are (by the spec) mutually exclusive.  However, in practice, this is not what is often the case.
- *
- * In general, this library takes a _descriptive_ rather than _perscriptive_ approach (see https://amyrey.web.unc.edu/classes/ling-101-online/tutorials/understanding-prescriptive-vs-descriptive-grammar/).
- *
- * 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`.
- */
-type PostDataBase = PostDataCommon & {
-  text?: string;
-  params?: Param[];
-};
-
-export type HarRequest = Omit<NpmHarRequest, 'postData'> & { postData: PostDataBase };
-
-export interface RequestExtras {
-  postData: PostDataBase & {
-    jsonObj?: ReducedHelperObject;
-    paramsObj?: ReducedHelperObject;
-    boundary?: string;
-  };
-  fullUrl: string;
-  queryObj: ReducedHelperObject;
-  headersObj: ReducedHelperObject;
-  uriObj: UrlWithParsedQuery;
-  cookiesObj: ReducedHelperObject;
-  allHeaders: ReducedHelperObject;
-}
-
-export type Request = HarRequest & RequestExtras;
-
-interface Entry {
-  request: Partial<HarRequest>;
-}
-
-interface HarEntry {
-  log: {
-    version: string;
-    creator: {
-      name: string;
-      version: string;
-    };
-    entries: Entry[];
-  };
-}
-
-export interface HTTPSnippetOptions {
-  harIsAlreadyEncoded?: boolean;
-}
-
-const isHarEntry = (value: any): value is HarEntry =>
-  typeof value === 'object' &&
-  'log' in value &&
-  typeof value.log === 'object' &&
-  'entries' in value.log &&
-  Array.isArray(value.log.entries);
-
-export class HTTPSnippet {
-  requests: Request[] = [];
-
-  constructor(input: HarEntry | HarRequest, opts: HTTPSnippetOptions = {}) {
-    let entries: Entry[] = [];
-
-    const options = {
-      harIsAlreadyEncoded: false,
-      ...opts,
-    };
-
-    // prep the main container
-    this.requests = [];
-
-    // is it har?
-    if (isHarEntry(input)) {
-      entries = input.log.entries;
-    } else {
-      entries = [
-        {
-          request: input,
-        },
-      ];
-    }
-
-    entries.forEach(({ request }) => {
-      // add optional properties to make validation successful
-      const req = {
-        bodySize: 0,
-        headersSize: 0,
-        headers: [],
-        cookies: [],
-        httpVersion: 'HTTP/1.1',
-        queryString: [],
-        postData: {
-          mimeType: request.postData?.mimeType || 'application/octet-stream',
-        },
-        ...request,
-      };
-
-      if (validateHarRequest(req)) {
-        this.requests.push(this.prepare(req, options));
-      }
-    });
-  }
-
-  prepare = (harRequest: HarRequest, options: HTTPSnippetOptions) => {
-    const request: Request = {
-      ...harRequest,
-      fullUrl: '',
-      uriObj: {} as UrlWithParsedQuery,
-      queryObj: {},
-      headersObj: {},
-      cookiesObj: {},
-      allHeaders: {},
-    };
-
-    // construct query objects
-    if (request.queryString && request.queryString.length) {
-      debug.info('queryString found, constructing queryString pair map');
-
-      request.queryObj = request.queryString.reduce(reducer, {});
-    }
-
-    // construct headers objects
-    if (request.headers && request.headers.length) {
-      const http2VersionRegex = /^HTTP\/2/;
-      request.headersObj = request.headers.reduce((accumulator, { name, value }) => {
-        const headerName = http2VersionRegex.exec(request.httpVersion) ? name.toLocaleLowerCase() : name;
-        return {
-          ...accumulator,
-          [headerName]: value,
-        };
-      }, {});
-    }
-
-    // construct headers objects
-    if (request.cookies && request.cookies.length) {
-      request.cookiesObj = request.cookies.reduceRight(
-        (accumulator, { name, value }) => ({
-          ...accumulator,
-          [name]: value,
-        }),
-        {}
-      );
-    }
-
-    // construct Cookie header
-    const cookies = request.cookies?.map(({ name, value }) => {
-      if (options.harIsAlreadyEncoded) {
-        return `${name}=${value}`;
-      }
-
-      return `${encodeURIComponent(name)}=${encodeURIComponent(value)}`;
-    });
-
-    if (cookies?.length) {
-      request.allHeaders.cookie = cookies.join('; ');
-    }
-
-    switch (request.postData.mimeType) {
-      case 'multipart/mixed':
-      case 'multipart/related':
-      case 'multipart/form-data':
-      case 'multipart/alternative':
-        // reset values
-        request.postData.text = '';
-        request.postData.mimeType = 'multipart/form-data';
-
-        if (request.postData?.params) {
-          const form = new FormData();
-
-          // The `form-data` module returns one of two things: a native FormData object, or its own polyfill
-          // Since the polyfill does not support the full API of the native FormData object, when this library is running in a browser environment it'll fail on two things:
-          //
-          //  1. The API for `form.append()` has three arguments and the third should only be present when the second is a
-          //    Blob or USVString.
-          //  1. `FormData.pipe()` isn't a function.
-          //
-          // Since the native FormData object is iterable, we easily detect what version of `form-data` we're working with here to allow `multipart/form-data` requests to be compiled under both browser and Node environments.
-          //
-          // This hack is pretty awful but it's the only way we can use this library in the browser as if we code this against just the native FormData object, we can't polyfill that back into Node because Blob and File objects, which something like `formdata-polyfill` requires, don't exist there.
-          // @ts-expect-error TODO
-          const isNativeFormData = typeof form[Symbol.iterator] === 'function';
-
-          // TODO: THIS ABSOLUTELY MUST BE REMOVED.
-          // IT BREAKS SOME USE-CASES FOR MULTIPART FORMS THAT DEPEND ON BEING ABLE TO SET THE BOUNDARY.
-          // easter egg
-          const boundary = '---011000010111000001101001'; // this is binary for "api". yep.
-          if (!isNativeFormData) {
-            // @ts-expect-error THIS IS WRONG.  VERY WRONG.
-            form._boundary = boundary;
-          }
-
-          request.postData?.params.forEach(param => {
-            const name = param.name;
-            const value = param.value || '';
-            const filename = param.fileName || null;
-
-            if (isNativeFormData) {
-              if (isBlob(value)) {
-                // @ts-expect-error TODO
-                form.append(name, value, filename);
-              } else {
-                form.append(name, value);
-              }
-            } else {
-              form.append(name, value, {
-                // @ts-expect-error TODO
-                filename,
-                // @ts-expect-error TODO
-                contentType: param.contentType || null,
-              });
-            }
-          });
-
-          if (isNativeFormData) {
-            // eslint-disable-next-line no-restricted-syntax
-            for (const data of formDataIterator(form, boundary)) {
-              request.postData.text += data;
-            }
-          } else {
-            form.pipe(
-              // @ts-expect-error TODO
-              eventStreamMap(data => {
-                request.postData.text += data;
-              })
-            );
-          }
-
-          request.postData.boundary = boundary;
-
-          // Since headers are case-sensitive we need to see if there's an existing `Content-Type` header that we can override.
-          const contentTypeHeader = getHeaderName(request.headersObj, 'content-type') || 'content-type';
-
-          request.headersObj[contentTypeHeader] = `multipart/form-data; boundary=${boundary}`;
-        }
-        break;
-
-      case 'application/x-www-form-urlencoded':
-        if (!request.postData.params) {
-          request.postData.text = '';
-        } else {
-          // @ts-expect-error the `har-format` types make this challenging
-          request.postData.paramsObj = request.postData.params.reduce(reducer, {});
-
-          // always overwrite
-          request.postData.text = queryStringify(request.postData.paramsObj);
-        }
-        break;
-
-      case 'text/json':
-      case 'text/x-json':
-      case 'application/json':
-      case 'application/x-json':
-        request.postData.mimeType = 'application/json';
-
-        if (request.postData.text) {
-          try {
-            request.postData.jsonObj = JSON.parse(request.postData.text);
-          } catch (e) {
-            debug.info(e);
-
-            // force back to `text/plain` if headers have proper content-type value, then this should also work
-            request.postData.mimeType = 'text/plain';
-          }
-        }
-        break;
-    }
-
-    // create allHeaders object
-    const allHeaders = {
-      ...request.allHeaders,
-      ...request.headersObj,
-    };
-
-    const urlWithParsedQuery = urlParse(request.url, true, true); //?
-
-    // query string key/value pairs in with literal querystrings containd within the url
-    request.queryObj = {
-      ...request.queryObj,
-      ...(urlWithParsedQuery.query as ReducedHelperObject),
-    }; //?
-
-    // reset uriObj values for a clean url
-    let search;
-    if (options.harIsAlreadyEncoded) {
-      search = queryStringify(request.queryObj, {
-        encode: false,
-        indices: false,
-      });
-    } else {
-      search = queryStringify(request.queryObj, {
-        indices: false,
-      });
-    }
-
-    const uriObj = {
-      ...urlWithParsedQuery,
-      query: request.queryObj,
-      search,
-      path: search ? `${urlWithParsedQuery.pathname}?${search}` : urlWithParsedQuery.pathname,
-    };
-
-    // keep the base url clean of queryString
-    const url = urlFormat({
-      ...urlWithParsedQuery,
-      query: null,
-      search: null,
-    }); //?
-
-    const fullUrl = urlFormat({
-      ...urlWithParsedQuery,
-      ...uriObj,
-    }); //?
-
-    return {
-      ...request,
-      allHeaders,
-      fullUrl,
-      url,
-      uriObj,
-    };
-  };
-
-  convert = (targetId: TargetId, clientId?: ClientId, options?: any) => {
-    if (!options && clientId) {
-      options = clientId;
-    }
-
-    const target = targets[targetId];
-    if (!target) {
-      return false;
-    }
-
-    const { convert } = target.clientsById[clientId || target.info.default];
-    const results = this.requests.map(request => convert(request, options));
-    return results.length === 1 ? results[0] : results;
-  };
-}