@readme/httpsnippet 6.2.0 → 7.0.0

package/dist/index-acc66e3d.d.ts

@@ -0,0 +1,167 @@
+import * as har_format from 'har-format';
+import { Request as Request$1, PostDataCommon, Param } from 'har-format';
+import { UrlWithParsedQuery } from 'node:url';
+import { Merge } from 'type-fest';
+
+type ReducedHelperObject = Record<string, string[] | string>;
+
+interface CodeBuilderOptions {
+    /**
+     * Desired indentation character for aggregated lines of code
+     * @default ''
+     */
+    indent?: string;
+    /**
+     * Desired character to join each line of code
+     * @default \n
+     */
+    join?: string;
+}
+
+type TargetId = keyof typeof targets;
+type ClientId = string;
+interface ClientInfo {
+    description: 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;
+}
+type Extension = `.${string}` | null;
+interface TargetInfo {
+    cli?: string;
+    default: string;
+    extname: Extension;
+    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<Record<string, any>>;
+declare const addTargetClient: (targetId: TargetId, client: Client) => void;
+
+interface AvailableTarget extends TargetInfo {
+    clients: ClientInfo[];
+}
+declare const availableTargets: () => AvailableTarget[];
+declare const extname: (targetId: TargetId) => "" | `.${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 {
+    requests: Request[];
+    constructor(input: HarEntry | HarRequest, opts?: HTTPSnippetOptions);
+    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[] | undefined;
+            text?: string | undefined;
+        } & {
+            boundary?: string | undefined;
+            jsonObj?: ReducedHelperObject | undefined;
+            paramsObj?: ReducedHelperObject | undefined;
+        };
+        cookiesObj: ReducedHelperObject;
+        headersObj: ReducedHelperObject;
+        queryObj: ReducedHelperObject;
+    };
+    convert: (targetId: TargetId, clientId?: ClientId, options?: any) => string | false | string[];
+}
+
+export { ClientId as C, Extension as E, HarRequest as H, RequestExtras as R, TargetId as T, ClientInfo as a, Converter as b, Client as c, TargetInfo as d, Target as e, addTarget as f, isClient as g, addTargetClient as h, isTarget as i, Request as j, HTTPSnippetOptions as k, HTTPSnippet as l, availableTargets as m, extname as n, targets as t };

package/dist/index.d.mts

@@ -0,0 +1,4 @@
+import 'har-format';
+export { l as HTTPSnippet, k as HTTPSnippetOptions, H as HarRequest, j as Request, R as RequestExtras, f as addTarget, h as addTargetClient, m as availableTargets, n as extname } from './index-acc66e3d.js';
+import 'node:url';
+import 'type-fest';

package/dist/index.d.ts

@@ -1,95 +1,4 @@
-/// <reference types="node" />
-import type { ReducedHelperObject } from './helpers/reducer';
-import type { ClientId, TargetId } from './targets/targets';
-import type { Param, PostDataCommon, Request as NpmHarRequest } from 'har-format';
-import type { UrlWithParsedQuery } from 'url';
-export { availableTargets, extname } from './helpers/utils';
-export { addTarget, addTargetClient } from './targets/targets';
-/** 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;
-};
-export type HarRequest = Omit<NpmHarRequest, 'postData'> & {
-    postData: PostDataBase;
-};
-export interface RequestExtras {
-    allHeaders: ReducedHelperObject;
-    cookiesObj: ReducedHelperObject;
-    fullUrl: string;
-    headersObj: ReducedHelperObject;
-    postData: PostDataBase & {
-        boundary?: string;
-        jsonObj?: ReducedHelperObject;
-        paramsObj?: ReducedHelperObject;
-    };
-    queryObj: ReducedHelperObject;
-    uriObj: UrlWithParsedQuery;
-}
-export type Request = HarRequest & RequestExtras;
-interface Entry {
-    request: Partial<HarRequest>;
-}
-interface HarEntry {
-    log: {
-        creator: {
-            name: string;
-            version: string;
-        };
-        entries: Entry[];
-        version: string;
-    };
-}
-export interface HTTPSnippetOptions {
-    harIsAlreadyEncoded?: boolean;
-}
-export declare class HTTPSnippet {
-    requests: Request[];
-    constructor(input: HarEntry | HarRequest, opts?: HTTPSnippetOptions);
-    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: import("har-format").Cookie[];
-        headers: import("har-format").Header[];
-        queryString: import("har-format").QueryString[];
-        headersSize: number;
-        bodySize: number;
-        comment?: string | undefined;
-        postData: PostDataCommon & {
-            params?: Param[] | undefined;
-            text?: string | undefined;
-        } & {
-            boundary?: string | undefined;
-            jsonObj?: ReducedHelperObject | undefined;
-            paramsObj?: ReducedHelperObject | undefined;
-        };
-        cookiesObj: ReducedHelperObject;
-        headersObj: ReducedHelperObject;
-        queryObj: ReducedHelperObject;
-    };
-    convert: (targetId: TargetId, clientId?: ClientId, options?: any) => string | false | string[];
-}
+import 'har-format';
+export { l as HTTPSnippet, k as HTTPSnippetOptions, H as HarRequest, j as Request, R as RequestExtras, f as addTarget, h as addTargetClient, m as availableTargets, n as extname } from './index-acc66e3d.js';
+import 'node:url';
+import 'type-fest';