@readme/httpsnippet 10.1.1 → 11.1.0

package/dist/chunk-KT7MO6Z4.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/helpers/reducer.ts"],"names":[],"mappings":";AAEa,IAAA,OAAA,GAAU,CAA4C,WAAA,EAAkC,IAAY,KAAA;AAC/G,EAAM,MAAA,YAAA,GAAe,WAAY,CAAA,IAAA,CAAK,IAAI,CAAA,CAAA;AAC1C,EAAA,IAAI,iBAAiB,KAAW,CAAA,EAAA;AAC9B,IAAY,WAAA,CAAA,IAAA,CAAK,IAAI,CAAA,GAAI,IAAK,CAAA,KAAA,CAAA;AAC9B,IAAO,OAAA,WAAA,CAAA;AAAA,GACT;AAGA,EAAI,IAAA,KAAA,CAAM,OAAQ,CAAA,YAAY,CAAG,EAAA;AAC/B,IAAa,YAAA,CAAA,IAAA,CAAK,KAAK,KAAK,CAAA,CAAA;AAC5B,IAAO,OAAA,WAAA,CAAA;AAAA,GACT;AAGA,EAAA,WAAA,CAAY,KAAK,IAAI,CAAA,GAAI,CAAC,YAAA,EAAc,KAAK,KAAK,CAAA,CAAA;AAClD,EAAO,OAAA,WAAA,CAAA;AACT","file":"chunk-KT7MO6Z4.js","sourcesContent":["export type ReducedHelperObject = Record<string, string[] | string>;\n\nexport const reducer = <T extends { name: string; value: string }>(accumulator: ReducedHelperObject, pair: T) => {\n  const currentValue = accumulator[pair.name];\n  if (currentValue === undefined) {\n    accumulator[pair.name] = pair.value;\n    return accumulator;\n  }\n\n  // If we already have it as array just push the value\n  if (Array.isArray(currentValue)) {\n    currentValue.push(pair.value);\n    return accumulator;\n  }\n\n  // convert to array since now we have more than one value for this key\n  accumulator[pair.name] = [currentValue, pair.value];\n  return accumulator;\n};\n"]}

package/dist/chunk-Y7NI4MMY.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/helpers/code-builder.ts"],"names":[],"mappings":";AAAA,IAAM,6BAAgC,GAAA,EAAA,CAAA;AACtC,IAAM,iBAAoB,GAAA,IAAA,CAAA;AAkBnB,IAAM,cAAN,MAAkB;AAAA;AAAA;AAAA;AAAA;AAAA,EAavB,YAAY,EAAE,MAAA,EAAQ,IAAK,EAAA,GAAwB,EAAI,EAAA;AAZvD,IAAA,IAAA,CAAA,cAAA,GAAkC,EAAC,CAAA;AAEnC,IAAA,IAAA,CAAA,IAAA,GAAiB,EAAC,CAAA;AAElB,IAA+B,IAAA,CAAA,oBAAA,GAAA,6BAAA,CAAA;AAE/B,IAAW,IAAA,CAAA,QAAA,GAAA,iBAAA,CAAA;AAcX;AAAA;AAAA;AAAA,IAAa,IAAA,CAAA,UAAA,GAAA,CAAC,IAAc,EAAA,gBAAA,GAAmB,CAAM,KAAA;AACnD,MAAA,MAAM,MAAS,GAAA,IAAA,CAAK,oBAAqB,CAAA,MAAA,CAAO,gBAAgB,CAAA,CAAA;AAChE,MAAO,OAAA,CAAA,EAAG,MAAM,CAAA,EAAG,IAAI,CAAA,CAAA,CAAA;AAAA,KACzB,CAAA;AAKA;AAAA;AAAA;AAAA,IAAU,IAAA,CAAA,OAAA,GAAA,CAAC,MAAc,gBAA8B,KAAA;AACrD,MAAA,MAAM,OAAU,GAAA,IAAA,CAAK,UAAW,CAAA,IAAA,EAAM,gBAAgB,CAAA,CAAA;AACtD,MAAK,IAAA,CAAA,IAAA,CAAK,QAAQ,OAAO,CAAA,CAAA;AAAA,KAC3B,CAAA;AAKA;AAAA;AAAA;AAAA,IAAO,IAAA,CAAA,IAAA,GAAA,CAAC,MAAc,gBAA8B,KAAA;AAClD,MAAA,MAAM,OAAU,GAAA,IAAA,CAAK,UAAW,CAAA,IAAA,EAAM,gBAAgB,CAAA,CAAA;AACtD,MAAK,IAAA,CAAA,IAAA,CAAK,KAAK,OAAO,CAAA,CAAA;AAAA,KACxB,CAAA;AAKA;AAAA;AAAA;AAAA,IAAA,IAAA,CAAA,KAAA,GAAQ,MAAM;AACZ,MAAK,IAAA,CAAA,IAAA,CAAK,KAAK,EAAE,CAAA,CAAA;AAAA,KACnB,CAAA;AAKA;AAAA;AAAA;AAAA,IAAA,IAAA,CAAA,IAAA,GAAO,MAAM;AACX,MAAA,MAAM,cAAiB,GAAA,IAAA,CAAK,IAAK,CAAA,IAAA,CAAK,KAAK,QAAQ,CAAA,CAAA;AACnD,MAAM,MAAA,cAAA,GAAiB,IAAK,CAAA,cAAA,CAAe,MAAO,CAAA,CAAC,aAAa,QAAa,KAAA,QAAA,CAAS,WAAW,CAAA,EAAG,cAAc,CAAA,CAAA;AAClH,MAAO,OAAA,cAAA,CAAA;AAAA,KACT,CAAA;AAMA;AAAA;AAAA;AAAA;AAAA,IAAA,IAAA,CAAA,gBAAA,GAAmB,CAAC,aAAiC,KAAA;AACnD,MAAA,IAAA,CAAK,cAAiB,GAAA,CAAC,GAAG,IAAA,CAAK,gBAAgB,aAAa,CAAA,CAAA;AAAA,KAC9D,CAAA;AAlDE,IAAA,IAAA,CAAK,uBAAuB,MAAU,IAAA,6BAAA,CAAA;AACtC,IAAA,IAAA,CAAK,WAAW,IAAQ,IAAA,iBAAA,CAAA;AAAA,GAC1B;AAiDF","file":"chunk-Y7NI4MMY.js","sourcesContent":["const DEFAULT_INDENTATION_CHARACTER = '';\nconst DEFAULT_LINE_JOIN = '\\n';\n\nexport type PostProcessor = (unreplacedCode: string) => string;\n\nexport interface CodeBuilderOptions {\n  /**\n   * Desired indentation character for aggregated lines of code\n   * @default ''\n   */\n  indent?: string;\n\n  /**\n   * Desired character to join each line of code\n   * @default \\n\n   */\n  join?: string;\n}\n\nexport class CodeBuilder {\n  postProcessors: PostProcessor[] = [];\n\n  code: string[] = [];\n\n  indentationCharacter: string = DEFAULT_INDENTATION_CHARACTER;\n\n  lineJoin = DEFAULT_LINE_JOIN;\n\n  /**\n   * Helper object to format and aggragate lines of code.\n   * Lines are aggregated in a `code` array, and need to be joined to obtain a proper code snippet.\n   */\n  constructor({ indent, join }: CodeBuilderOptions = {}) {\n    this.indentationCharacter = indent || DEFAULT_INDENTATION_CHARACTER;\n    this.lineJoin = join ?? DEFAULT_LINE_JOIN;\n  }\n\n  /**\n   * Add given indentation level to given line of code\n   */\n  indentLine = (line: string, indentationLevel = 0) => {\n    const indent = this.indentationCharacter.repeat(indentationLevel);\n    return `${indent}${line}`;\n  };\n\n  /**\n   * Add the line at the beginning of the current lines\n   */\n  unshift = (line: string, indentationLevel?: number) => {\n    const newLine = this.indentLine(line, indentationLevel);\n    this.code.unshift(newLine);\n  };\n\n  /**\n   * Add the line at the end of the current lines\n   */\n  push = (line: string, indentationLevel?: number) => {\n    const newLine = this.indentLine(line, indentationLevel);\n    this.code.push(newLine);\n  };\n\n  /**\n   * Add an empty line at the end of current lines\n   */\n  blank = () => {\n    this.code.push('');\n  };\n\n  /**\n   * Concatenate all current lines using the given lineJoin, then apply any replacers that may have been added\n   */\n  join = () => {\n    const unreplacedCode = this.code.join(this.lineJoin);\n    const replacedOutput = this.postProcessors.reduce((accumulator, replacer) => replacer(accumulator), unreplacedCode);\n    return replacedOutput;\n  };\n\n  /**\n   * Often when writing modules you may wish to add a literal tag or bit of metadata that you wish to transform after other processing as a final step.\n   * To do so, you can provide a PostProcessor function and it will be run automatically for you when you call `join()` later on.\n   */\n  addPostProcessor = (postProcessor: PostProcessor) => {\n    this.postProcessors = [...this.postProcessors, postProcessor];\n  };\n}\n"]}

package/dist/index-Bi-oJSCB.d.ts

@@ -1,164 +0,0 @@
-import * as har_format from 'har-format';
-import { Request as Request$1, PostDataCommon, Param } from 'har-format';
-import { ReducedHelperObject } from './helpers/reducer.js';
-import { CodeBuilderOptions } from './helpers/code-builder.js';
-import { UrlWithParsedQuery } from 'node:url';
-import { Merge } from 'type-fest';
-
-type TargetId = keyof typeof targets;
-type ClientId = string;
-interface ClientInfo {
-    description: string;
-    extname: Extension;
-    installation?: string;
-    key: ClientId;
-    link: string;
-    title: string;
-}
-type Converter<T extends Record<string, any>> = (request: Request, options?: Merge<CodeBuilderOptions, T>) => string;
-interface Client<T extends Record<string, any> = Record<string, any>> {
-    convert: Converter<T>;
-    info: ClientInfo;
-}
-interface ClientPlugin<T extends Record<string, any> = Record<string, any>> {
-    client: Client<T>;
-    target: TargetId;
-}
-type Extension = `.${string}` | null;
-interface TargetInfo {
-    cli?: string;
-    default: string;
-    key: TargetId;
-    title: string;
-}
-interface Target {
-    clientsById: Record<ClientId, Client>;
-    info: TargetInfo;
-}
-declare const targets: {
-    c: Target;
-    clojure: Target;
-    csharp: Target;
-    go: Target;
-    http: Target;
-    java: Target;
-    javascript: Target;
-    json: Target;
-    kotlin: Target;
-    node: Target;
-    objc: Target;
-    ocaml: Target;
-    php: Target;
-    powershell: Target;
-    python: Target;
-    r: Target;
-    ruby: Target;
-    shell: Target;
-    swift: Target;
-};
-declare const isTarget: (target: Target) => target is Target;
-declare const addTarget: (target: Target) => void;
-declare const isClient: (client: Client) => client is Client;
-declare const addClientPlugin: (plugin: ClientPlugin) => void;
-declare const addTargetClient: (targetId: TargetId, client: Client) => void;
-
-interface AvailableTarget extends TargetInfo {
-    clients: ClientInfo[];
-}
-declare const availableTargets: () => AvailableTarget[];
-declare const extname: (targetId: TargetId, clientId: ClientId) => "" | `.${string}`;
-
-/** 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 & {
-    params?: Param[];
-    text?: string;
-};
-type HarRequest = Omit<Request$1, 'postData'> & {
-    postData: PostDataBase;
-};
-interface RequestExtras {
-    allHeaders: ReducedHelperObject;
-    cookiesObj: ReducedHelperObject;
-    fullUrl: string;
-    headersObj: ReducedHelperObject;
-    postData: PostDataBase & {
-        boundary?: string;
-        jsonObj?: ReducedHelperObject;
-        paramsObj?: ReducedHelperObject;
-    };
-    queryObj: ReducedHelperObject;
-    uriObj: UrlWithParsedQuery;
-}
-type Request = HarRequest & RequestExtras;
-interface Entry {
-    request: Partial<HarRequest>;
-}
-interface HarEntry {
-    log: {
-        creator: {
-            name: string;
-            version: string;
-        };
-        entries: Entry[];
-        version: string;
-    };
-}
-interface HTTPSnippetOptions {
-    harIsAlreadyEncoded?: boolean;
-}
-declare class HTTPSnippet {
-    initCalled: boolean;
-    entries: Entry[];
-    requests: Request[];
-    options: HTTPSnippetOptions;
-    constructor(input: HarEntry | HarRequest, opts?: HTTPSnippetOptions);
-    init(): this;
-    prepare(harRequest: HarRequest, options: HTTPSnippetOptions): {
-        allHeaders: {
-            [x: string]: string | string[];
-        };
-        fullUrl: string;
-        url: string;
-        uriObj: {
-            query: ReducedHelperObject;
-            search: string;
-            path: string | null;
-            auth: string | null;
-            hash: string | null;
-            host: string | null;
-            hostname: string | null;
-            href: string;
-            pathname: string | null;
-            protocol: string | null;
-            slashes: boolean | null;
-            port: string | null;
-        };
-        method: string;
-        httpVersion: string;
-        cookies: har_format.Cookie[];
-        headers: har_format.Header[];
-        queryString: har_format.QueryString[];
-        headersSize: number;
-        bodySize: number;
-        comment?: string | undefined;
-        postData: PostDataCommon & {
-            params?: Param[];
-            text?: string;
-        } & {
-            boundary?: string;
-            jsonObj?: ReducedHelperObject;
-            paramsObj?: ReducedHelperObject;
-        };
-        cookiesObj: ReducedHelperObject;
-        headersObj: ReducedHelperObject;
-        queryObj: ReducedHelperObject;
-    };
-    convert(targetId: TargetId, clientId?: ClientId, options?: any): false | string[];
-}
-
-export { type ClientId as C, type Extension as E, type HarRequest as H, type RequestExtras as R, type TargetId as T, type ClientInfo as a, type Converter as b, type Client as c, type ClientPlugin as d, type TargetInfo as e, type Target as f, addTarget as g, isClient as h, isTarget as i, addClientPlugin as j, addTargetClient as k, type Request as l, type HTTPSnippetOptions as m, HTTPSnippet as n, availableTargets as o, extname as p, targets as t };

package/dist/index-CM3ebXTM.d.cts

@@ -1,164 +0,0 @@
-import * as har_format from 'har-format';
-import { Request as Request$1, PostDataCommon, Param } from 'har-format';
-import { ReducedHelperObject } from './helpers/reducer.cjs';
-import { CodeBuilderOptions } from './helpers/code-builder.cjs';
-import { UrlWithParsedQuery } from 'node:url';
-import { Merge } from 'type-fest';
-
-type TargetId = keyof typeof targets;
-type ClientId = string;
-interface ClientInfo {
-    description: string;
-    extname: Extension;
-    installation?: string;
-    key: ClientId;
-    link: string;
-    title: string;
-}
-type Converter<T extends Record<string, any>> = (request: Request, options?: Merge<CodeBuilderOptions, T>) => string;
-interface Client<T extends Record<string, any> = Record<string, any>> {
-    convert: Converter<T>;
-    info: ClientInfo;
-}
-interface ClientPlugin<T extends Record<string, any> = Record<string, any>> {
-    client: Client<T>;
-    target: TargetId;
-}
-type Extension = `.${string}` | null;
-interface TargetInfo {
-    cli?: string;
-    default: string;
-    key: TargetId;
-    title: string;
-}
-interface Target {
-    clientsById: Record<ClientId, Client>;
-    info: TargetInfo;
-}
-declare const targets: {
-    c: Target;
-    clojure: Target;
-    csharp: Target;
-    go: Target;
-    http: Target;
-    java: Target;
-    javascript: Target;
-    json: Target;
-    kotlin: Target;
-    node: Target;
-    objc: Target;
-    ocaml: Target;
-    php: Target;
-    powershell: Target;
-    python: Target;
-    r: Target;
-    ruby: Target;
-    shell: Target;
-    swift: Target;
-};
-declare const isTarget: (target: Target) => target is Target;
-declare const addTarget: (target: Target) => void;
-declare const isClient: (client: Client) => client is Client;
-declare const addClientPlugin: (plugin: ClientPlugin) => void;
-declare const addTargetClient: (targetId: TargetId, client: Client) => void;
-
-interface AvailableTarget extends TargetInfo {
-    clients: ClientInfo[];
-}
-declare const availableTargets: () => AvailableTarget[];
-declare const extname: (targetId: TargetId, clientId: ClientId) => "" | `.${string}`;
-
-/** 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 & {
-    params?: Param[];
-    text?: string;
-};
-type HarRequest = Omit<Request$1, 'postData'> & {
-    postData: PostDataBase;
-};
-interface RequestExtras {
-    allHeaders: ReducedHelperObject;
-    cookiesObj: ReducedHelperObject;
-    fullUrl: string;
-    headersObj: ReducedHelperObject;
-    postData: PostDataBase & {
-        boundary?: string;
-        jsonObj?: ReducedHelperObject;
-        paramsObj?: ReducedHelperObject;
-    };
-    queryObj: ReducedHelperObject;
-    uriObj: UrlWithParsedQuery;
-}
-type Request = HarRequest & RequestExtras;
-interface Entry {
-    request: Partial<HarRequest>;
-}
-interface HarEntry {
-    log: {
-        creator: {
-            name: string;
-            version: string;
-        };
-        entries: Entry[];
-        version: string;
-    };
-}
-interface HTTPSnippetOptions {
-    harIsAlreadyEncoded?: boolean;
-}
-declare class HTTPSnippet {
-    initCalled: boolean;
-    entries: Entry[];
-    requests: Request[];
-    options: HTTPSnippetOptions;
-    constructor(input: HarEntry | HarRequest, opts?: HTTPSnippetOptions);
-    init(): this;
-    prepare(harRequest: HarRequest, options: HTTPSnippetOptions): {
-        allHeaders: {
-            [x: string]: string | string[];
-        };
-        fullUrl: string;
-        url: string;
-        uriObj: {
-            query: ReducedHelperObject;
-            search: string;
-            path: string | null;
-            auth: string | null;
-            hash: string | null;
-            host: string | null;
-            hostname: string | null;
-            href: string;
-            pathname: string | null;
-            protocol: string | null;
-            slashes: boolean | null;
-            port: string | null;
-        };
-        method: string;
-        httpVersion: string;
-        cookies: har_format.Cookie[];
-        headers: har_format.Header[];
-        queryString: har_format.QueryString[];
-        headersSize: number;
-        bodySize: number;
-        comment?: string | undefined;
-        postData: PostDataCommon & {
-            params?: Param[];
-            text?: string;
-        } & {
-            boundary?: string;
-            jsonObj?: ReducedHelperObject;
-            paramsObj?: ReducedHelperObject;
-        };
-        cookiesObj: ReducedHelperObject;
-        headersObj: ReducedHelperObject;
-        queryObj: ReducedHelperObject;
-    };
-    convert(targetId: TargetId, clientId?: ClientId, options?: any): false | string[];
-}
-
-export { type ClientId as C, type Extension as E, type HarRequest as H, type RequestExtras as R, type TargetId as T, type ClientInfo as a, type Converter as b, type Client as c, type ClientPlugin as d, type TargetInfo as e, type Target as f, addTarget as g, isClient as h, isTarget as i, addClientPlugin as j, addTargetClient as k, type Request as l, type HTTPSnippetOptions as m, HTTPSnippet as n, availableTargets as o, extname as p, targets as t };