@readme/httpsnippet 11.0.0 → 11.1.0

package/dist/targets/index.d.cts

@@ -1,6 +1,160 @@
-import '../helpers/code-builder.cjs';
-export { c as Client, C as ClientId, a as ClientInfo, d as ClientPlugin, b as Converter, E as Extension, f as Target, T as TargetId, e as TargetInfo, j as addClientPlugin, g as addTarget, k as addTargetClient, h as isClient, i as isTarget, t as targets } from '../index-CM3ebXTM.cjs';
-import 'type-fest';
-import 'har-format';
-import '../helpers/reducer.cjs';
-import 'node:url';
+import { UrlWithParsedQuery } from 'node:url';
+import { Request as Request$1, PostDataCommon, Param } from 'har-format';
+import { Merge } from 'type-fest';
+import { CodeBuilderOptions } from '../helpers/code-builder.cjs';
+import { ReducedHelperObject } from '../helpers/reducer.cjs';
+
+type TargetId = keyof typeof targets;
+type ClientId = string;
+interface ClientInfo<T extends Record<string, any> = Record<string, any>> {
+    /**
+     * A description of the client.
+     *
+     * @example Promise based HTTP client for the browser and node.js
+     */
+    description: string;
+    /**
+     * The default file extension for the client.
+     *
+     * @example `.js`
+     */
+    extname: Extension;
+    /**
+     * Retrieve or generate a command to install the client.
+     *
+     * @example () => 'npm install axios --save';
+     */
+    installation?: Converter<T>;
+    /**
+     * A unique identifier for the client.
+     *
+     * This should be a string that is unique to the client for the given target.
+     *
+     * @example `axios`
+     */
+    key: ClientId;
+    /**
+     * A link to the documentation or homepage of the client.
+     *
+     * @example https://github.com/axios/axios
+     */
+    link: string;
+    /**
+     * The formatted name of the client.
+     *
+     * @example Axios
+     */
+    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<T>;
+}
+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;
+}
+type supportedTargets = 'c' | 'clojure' | 'csharp' | 'go' | 'http' | 'java' | 'javascript' | 'json' | 'kotlin' | 'node' | 'objc' | 'ocaml' | 'php' | 'powershell' | 'python' | 'r' | 'ruby' | 'shell' | 'swift';
+declare const targets: Record<supportedTargets, 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}`;
+
+/** biome-ignore-all lint/performance/noBarrelFile: This doesn't really have the aspects of being a barrel file. */
+
+/** 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;
+    };
+}
+type Options = Merge<CodeBuilderOptions, Record<string, any>>;
+interface HTTPSnippetOptions {
+    harIsAlreadyEncoded?: boolean;
+}
+declare class HTTPSnippet {
+    initCalled: boolean;
+    entries: Entry[];
+    requests: Request[];
+    options: HTTPSnippetOptions;
+    constructor(input: HarEntry | HarRequest, opts?: HTTPSnippetOptions);
+    init(): HTTPSnippet;
+    prepare(harRequest: HarRequest, options: HTTPSnippetOptions): Request & {
+        allHeaders: Record<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;
+        };
+    };
+    convert(targetId: TargetId, clientId?: ClientId, options?: Options): (string | false)[];
+    installation(targetId: TargetId, clientId?: ClientId, options?: Options): (string | false)[];
+}
+
+export { type Client, type ClientId, type ClientInfo, type ClientPlugin, type Converter, type Extension, type HarRequest as H, type Options as O, type RequestExtras as R, type Target, type TargetId, type TargetInfo, type Request as a, addClientPlugin, addTarget, addTargetClient, type HTTPSnippetOptions as b, HTTPSnippet as c, availableTargets as d, extname as e, isClient, isTarget, targets };

package/dist/targets/index.d.ts

@@ -1,6 +1,160 @@
-import '../helpers/code-builder.js';
-export { c as Client, C as ClientId, a as ClientInfo, d as ClientPlugin, b as Converter, E as Extension, f as Target, T as TargetId, e as TargetInfo, j as addClientPlugin, g as addTarget, k as addTargetClient, h as isClient, i as isTarget, t as targets } from '../index-Bi-oJSCB.js';
-import 'type-fest';
-import 'har-format';
-import '../helpers/reducer.js';
-import 'node:url';
+import { UrlWithParsedQuery } from 'node:url';
+import { Request as Request$1, PostDataCommon, Param } from 'har-format';
+import { Merge } from 'type-fest';
+import { CodeBuilderOptions } from '../helpers/code-builder.js';
+import { ReducedHelperObject } from '../helpers/reducer.js';
+
+type TargetId = keyof typeof targets;
+type ClientId = string;
+interface ClientInfo<T extends Record<string, any> = Record<string, any>> {
+    /**
+     * A description of the client.
+     *
+     * @example Promise based HTTP client for the browser and node.js
+     */
+    description: string;
+    /**
+     * The default file extension for the client.
+     *
+     * @example `.js`
+     */
+    extname: Extension;
+    /**
+     * Retrieve or generate a command to install the client.
+     *
+     * @example () => 'npm install axios --save';
+     */
+    installation?: Converter<T>;
+    /**
+     * A unique identifier for the client.
+     *
+     * This should be a string that is unique to the client for the given target.
+     *
+     * @example `axios`
+     */
+    key: ClientId;
+    /**
+     * A link to the documentation or homepage of the client.
+     *
+     * @example https://github.com/axios/axios
+     */
+    link: string;
+    /**
+     * The formatted name of the client.
+     *
+     * @example Axios
+     */
+    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<T>;
+}
+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;
+}
+type supportedTargets = 'c' | 'clojure' | 'csharp' | 'go' | 'http' | 'java' | 'javascript' | 'json' | 'kotlin' | 'node' | 'objc' | 'ocaml' | 'php' | 'powershell' | 'python' | 'r' | 'ruby' | 'shell' | 'swift';
+declare const targets: Record<supportedTargets, 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}`;
+
+/** biome-ignore-all lint/performance/noBarrelFile: This doesn't really have the aspects of being a barrel file. */
+
+/** 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;
+    };
+}
+type Options = Merge<CodeBuilderOptions, Record<string, any>>;
+interface HTTPSnippetOptions {
+    harIsAlreadyEncoded?: boolean;
+}
+declare class HTTPSnippet {
+    initCalled: boolean;
+    entries: Entry[];
+    requests: Request[];
+    options: HTTPSnippetOptions;
+    constructor(input: HarEntry | HarRequest, opts?: HTTPSnippetOptions);
+    init(): HTTPSnippet;
+    prepare(harRequest: HarRequest, options: HTTPSnippetOptions): Request & {
+        allHeaders: Record<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;
+        };
+    };
+    convert(targetId: TargetId, clientId?: ClientId, options?: Options): (string | false)[];
+    installation(targetId: TargetId, clientId?: ClientId, options?: Options): (string | false)[];
+}
+
+export { type Client, type ClientId, type ClientInfo, type ClientPlugin, type Converter, type Extension, type HarRequest as H, type Options as O, type RequestExtras as R, type Target, type TargetId, type TargetInfo, type Request as a, addClientPlugin, addTarget, addTargetClient, type HTTPSnippetOptions as b, HTTPSnippet as c, availableTargets as d, extname as e, isClient, isTarget, targets };

package/dist/targets/index.js

@@ -1,4 +1,4 @@
-export { addClientPlugin, addTarget, addTargetClient, isClient, isTarget, targets } from '../chunk-452Q5GGQ.js';
-import '../chunk-Y7NI4MMY.js';
+export { addClientPlugin, addTarget, addTargetClient, isClient, isTarget, targets } from '../chunk-EFUQ6POB.js';
+import '../chunk-6B3J3CUI.js';
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@readme/httpsnippet",
-  "version": "11.0.0",
+  "version": "11.1.0",
   "description": "HTTP Request snippet generator for *most* languages",
   "homepage": "https://github.com/readmeio/httpsnippet",
   "license": "MIT",
@@ -70,8 +70,9 @@
     "attw": "attw --pack --format table-flipped",
     "build": "tsup",
     "clean": "rm -rf dist/",
-    "lint": "npm run lint:js && npm run prettier",
-    "lint:js": "eslint . --ext .js,.cjs,.ts && prettier --check .",
+    "format": "npm run prettier:write && npx biome check --write",
+    "lint": "npm run lint:js && npm run prettier && tsc",
+    "lint:js": "biome check",
     "prebuild": "npm run clean",
     "prepack": "npm run build",
     "prettier": "prettier --check .",
@@ -79,24 +80,23 @@
     "test": "vitest run --coverage"
   },
   "dependencies": {
-    "qs": "^6.11.2",
-    "stringify-object": "^3.3.0"
+    "qs": "^6.15.0",
+    "stringify-object": "^3.3.0",
+    "type-fest": "^5.4.4"
   },
   "devDependencies": {
-    "@readme/eslint-config": "^14.0.0",
-    "@types/eslint": "^8.44.7",
+    "@biomejs/biome": "^2.4.4",
+    "@readme/standards": "^2.2.0",
     "@types/har-format": "^1.2.15",
-    "@types/node": "^22.0.2",
+    "@types/node": "^25.3.0",
     "@types/qs": "^6.9.10",
     "@types/stringify-object": "^4.0.5",
-    "@vitest/coverage-v8": "^2.0.5",
-    "eslint": "^8.57.0",
+    "@vitest/coverage-v8": "^4.0.2",
     "prettier": "^3.0.3",
     "require-directory": "^2.1.1",
     "tsup": "^8.0.1",
-    "type-fest": "^4.15.0",
-    "typescript": "^5.4.4",
-    "vitest": "^2.0.5"
+    "typescript": "^5.8.3",
+    "vitest": "^4.0.2"
   },
-  "prettier": "@readme/eslint-config/prettier"
+  "prettier": "@readme/standards/prettier"
 }