@readme/httpsnippet 4.0.2 → 4.0.3

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

@@ -0,0 +1,49 @@
+export declare type PostProcessor = (unreplacedCode: string) => string;
+export 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;
+}
+export declare class CodeBuilder {
+    postProcessors: PostProcessor[];
+    code: string[];
+    indentationCharacter: string;
+    lineJoin: string;
+    /**
+     * Helper object to format and aggragate lines of code.
+     * Lines are aggregated in a `code` array, and need to be joined to obtain a proper code snippet.
+     */
+    constructor({ indent, join }?: CodeBuilderOptions);
+    /**
+     * Add given indentation level to given line of code
+     */
+    indentLine: (line: string, indentationLevel?: number) => string;
+    /**
+     * Add the line at the beginning of the current lines
+     */
+    unshift: (line: string, indentationLevel?: number) => void;
+    /**
+     * Add the line at the end of the current lines
+     */
+    push: (line: string, indentationLevel?: number) => void;
+    /**
+     * Add an empty line at the end of current lines
+     */
+    blank: () => void;
+    /**
+     * Concatenate all current lines using the given lineJoin, then apply any replacers that may have been added
+     */
+    join: () => string;
+    /**
+     * 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.
+     * To do so, you can provide a PostProcessor function and it will be run automatically for you when you call `join()` later on.
+     */
+    addPostProcessor: (postProcessor: PostProcessor) => void;
+}

package/dist/helpers/form-data.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @license https://raw.githubusercontent.com/node-fetch/node-fetch/master/LICENSE.md
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2016 - 2020 Node Fetch Team
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ * Extracted from https://github.com/node-fetch/node-fetch/blob/64c5c296a0250b852010746c76144cb9e14698d9/src/utils/form-data.js
+ */
+import type FormData from 'form-data';
+export declare const isBlob: (object: any) => boolean;
+export declare const formDataIterator: (form: FormData, boundary: string) => Generator<any, void, any>;

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

@@ -0,0 +1,9 @@
+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/headers.d.ts

@@ -0,0 +1,18 @@
+declare type Headers<T> = Record<string, T>;
+/**
+ * Given a headers object retrieve a specific header out of it via a case-insensitive key.
+ */
+export declare const getHeaderName: <T>(headers: Headers<T>, name: string) => string | undefined;
+/**
+ * Given a headers object retrieve the contents of a header out of it via a case-insensitive key.
+ */
+export declare const getHeader: <T>(headers: Headers<T>, name: string) => T | undefined;
+/**
+ * Determine if a given case-insensitive header exists within a header object.
+ */
+export declare const hasHeader: <T>(headers: Headers<T>, name: string) => boolean;
+/**
+ * Determines if a given MIME type is JSON, or a variant of such.
+ */
+export declare const isMimeTypeJSON: (mimeType: string) => boolean;
+export {};

package/dist/helpers/reducer.d.ts

@@ -0,0 +1,5 @@
+export declare type ReducedHelperObject = Record<string, string[] | string>;
+export declare const reducer: <T extends {
+    name: string;
+    value: string;
+}>(accumulator: ReducedHelperObject, pair: T) => ReducedHelperObject;

package/dist/helpers/shell.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 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 declare const quote: (value?: string) => string;
+export declare const escape: (value: string) => string;

package/dist/helpers/utils.d.ts

@@ -0,0 +1,6 @@
+import type { ClientInfo, TargetId, TargetInfo } from '../targets/targets';
+export interface AvailableTarget extends TargetInfo {
+    clients: ClientInfo[];
+}
+export declare const availableTargets: () => AvailableTarget[];
+export declare const extname: (targetId: TargetId) => "" | `.${string}`;

package/dist/index.d.ts

@@ -0,0 +1,95 @@
+/// <reference types="node" />
+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';
+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`.
+ */
+declare type PostDataBase = PostDataCommon & {
+    text?: string;
+    params?: Param[];
+};
+export declare 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 declare 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;
+}
+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;
+        };
+        comment?: string | undefined;
+        method: string;
+        httpVersion: string;
+        cookies: import("har-format").Cookie[];
+        headers: import("har-format").Header[];
+        queryString: import("har-format").QueryString[];
+        headersSize: number;
+        bodySize: number;
+        postData: PostDataCommon & {
+            text?: string | undefined;
+            params?: Param[] | undefined;
+        } & {
+            jsonObj?: ReducedHelperObject | undefined;
+            paramsObj?: ReducedHelperObject | undefined;
+            boundary?: string | undefined;
+        };
+        queryObj: ReducedHelperObject;
+        headersObj: ReducedHelperObject;
+        cookiesObj: ReducedHelperObject;
+    };
+    convert: (targetId: TargetId, clientId?: ClientId, options?: any) => string | false | string[];
+}

package/dist/targets/c/libcurl/client.d.ts

@@ -0,0 +1,2 @@
+import type { Client } from '../../targets';
+export declare const libcurl: Client;

package/dist/targets/c/target.d.ts

@@ -0,0 +1,2 @@
+import type { Target } from '../targets';
+export declare const c: Target;

package/dist/targets/clojure/clj_http/client.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @description
+ * HTTP code snippet generator for Clojure using clj-http.
+ *
+ * @author
+ * @tggreene
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export declare const clj_http: Client;

package/dist/targets/clojure/target.d.ts

@@ -0,0 +1,2 @@
+import type { Target } from '../targets';
+export declare const clojure: Target;

package/dist/targets/csharp/httpclient/client.d.ts

@@ -0,0 +1,2 @@
+import type { Client } from '../../targets';
+export declare const httpclient: Client;

package/dist/targets/csharp/restsharp/client.d.ts

@@ -0,0 +1,2 @@
+import type { Client } from '../../targets';
+export declare const restsharp: Client;

package/dist/targets/csharp/target.d.ts

@@ -0,0 +1,2 @@
+import type { Target } from '../targets';
+export declare const csharp: Target;

package/dist/targets/go/native/client.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @description
+ * HTTP code snippet generator for native Go.
+ *
+ * @author
+ * @montanaflynn
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export interface GoNativeOptions {
+    showBoilerplate?: boolean;
+    checkErrors?: boolean;
+    printBody?: boolean;
+    timeout?: number;
+}
+export declare const native: Client<GoNativeOptions>;

package/dist/targets/go/target.d.ts

@@ -0,0 +1,2 @@
+import type { Target } from '../targets';
+export declare const go: Target;

package/dist/targets/http/http1.1/client.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @description
+ * HTTP code snippet generator to generate raw HTTP/1.1 request strings,
+ * in accordance to the RFC 7230 (and RFC 7231) specifications.
+ *
+ * @author
+ * @irvinlim
+ *
+ * For any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+interface Http11Options {
+    absoluteURI?: boolean;
+    autoContentLength?: boolean;
+    autoHost?: boolean;
+}
+/**
+ * Request follows the request message format in accordance to RFC 7230, Section 3.
+ * Each section is prepended with the RFC and section number.
+ * See more at https://tools.ietf.org/html/rfc7230#section-3.
+ */
+export declare const http11: Client<Http11Options>;
+export {};

package/dist/targets/http/target.d.ts

@@ -0,0 +1,2 @@
+import type { Target } from '../targets';
+export declare const http: Target;

package/dist/targets/java/asynchttp/client.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @description
+ * Asynchronous Http and WebSocket Client library for Java
+ *
+ * @author
+ * @windard
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export declare const asynchttp: Client;

package/dist/targets/java/nethttp/client.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @description
+ * HTTP code snippet generator for Java using java.net.http.
+ *
+ * @author
+ * @wtetsu
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export interface NetHttpOptions {
+    indent?: string;
+}
+export declare const nethttp: Client;

package/dist/targets/java/okhttp/client.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @description
+ * HTTP code snippet generator for Java using OkHttp.
+ *
+ * @author
+ * @shashiranjan84
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export declare const okhttp: Client;

package/dist/targets/java/target.d.ts

@@ -0,0 +1,2 @@
+import type { Target } from '../targets';
+export declare const java: Target;

package/dist/targets/java/unirest/client.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @description
+ * HTTP code snippet generator for Java using Unirest.
+ *
+ * @author
+ * @shashiranjan84
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export declare const unirest: Client;

package/dist/targets/javascript/axios/client.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @description
+ * HTTP code snippet generator for Javascript & Node.js using Axios.
+ *
+ * @author
+ * @rohit-gohri
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export declare const axios: Client;

package/dist/targets/javascript/axios/fixtures/application-form-encoded.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/javascript/axios/fixtures/application-json.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/javascript/axios/fixtures/cookies.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/javascript/axios/fixtures/custom-method.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/javascript/axios/fixtures/full.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/javascript/axios/fixtures/headers.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/javascript/axios/fixtures/http-insecure.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/javascript/axios/fixtures/jsonObj-multiline.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/javascript/axios/fixtures/jsonObj-null-value.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/javascript/axios/fixtures/multipart-data.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/javascript/axios/fixtures/multipart-file.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/javascript/axios/fixtures/multipart-form-data-no-params.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/javascript/axios/fixtures/multipart-form-data.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/javascript/axios/fixtures/nested.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/javascript/axios/fixtures/query-encoded.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/javascript/axios/fixtures/query.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/javascript/axios/fixtures/short.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/javascript/axios/fixtures/text-plain.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/javascript/fetch/client.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @description
+ * HTTP code snippet generator for fetch
+ *
+ * @author
+ * @pmdroid
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+interface FetchOptions {
+    credentials?: Record<string, string> | null;
+}
+export declare const fetch: Client<FetchOptions>;
+export {};

package/dist/targets/javascript/fetch/fixtures/application-form-encoded.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+declare namespace options {
+    const method: string;
+    const headers: {
+        'content-type': string;
+    };
+    const body: import("url").URLSearchParams;
+}

package/dist/targets/javascript/fetch/fixtures/application-json.d.ts

@@ -0,0 +1,7 @@
+declare namespace options {
+    const method: string;
+    const headers: {
+        'content-type': string;
+    };
+    const body: string;
+}

package/dist/targets/javascript/fetch/fixtures/cookies.d.ts

@@ -0,0 +1,6 @@
+declare namespace options {
+    const method: string;
+    namespace headers {
+        const cookie: string;
+    }
+}

package/dist/targets/javascript/fetch/fixtures/custom-method.d.ts

@@ -0,0 +1,3 @@
+declare namespace options {
+    const method: string;
+}