ce-storefront 0.2.5 → 0.3.1

package/esm/hooks/index.js

@@ -0,0 +1,6 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+export * from "./hooks.js";
+export * from "./types.js";
+//# sourceMappingURL=index.js.map

package/esm/hooks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC"}

package/esm/hooks/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/hooks/types.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,cAAc,CAAC,EAAE,GAAG,GAAG,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5C,WAAW,EAAE,WAAW,CAAC;IACzB,gBAAgB,EAAE,aAAa,GAAG,IAAI,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAE1C,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;IACpB,MAAM,EAAE,UAAU,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,WAAW,GAAG,EAAE,CAAC;AAC1D,MAAM,MAAM,oBAAoB,GAAG,WAAW,GAAG,EAAE,CAAC;AACpD,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG,EAAE,CAAC;AACnD,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,EAAE,CAAC;AAEjD;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,cAAc,CAAC;CACnD;AAED,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,mBAAmB,EAAE,CACnB,OAAO,EAAE,0BAA0B,EACnC,KAAK,EAAE,YAAY,KAChB,YAAY,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,aAAa,EAAE,CACb,OAAO,EAAE,oBAAoB,EAC7B,OAAO,EAAE,OAAO,KACb,SAAS,CAAC,OAAO,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,YAAY,EAAE,CACZ,OAAO,EAAE,mBAAmB,EAC5B,QAAQ,EAAE,QAAQ,KACf,SAAS,CAAC,QAAQ,CAAC,CAAC;CAC1B;AAED,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,UAAU,EAAE,CACV,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,QAAQ,GAAG,IAAI,EACzB,KAAK,EAAE,OAAO,KACX,SAAS,CAAC;QACb,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;QAC1B,KAAK,EAAE,OAAO,CAAC;KAChB,CAAC,CAAC;CACJ;AAED,MAAM,WAAW,KAAK;IACpB,uEAAuE;IACvE,mBAAmB,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,CAAC;IAC7C,mFAAmF;IACnF,+BAA+B,CAAC,IAAI,EAAE,uBAAuB,GAAG,IAAI,CAAC;IACrE,2EAA2E;IAC3E,yBAAyB,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,CAAC;IACzD,0EAA0E;IAC1E,wBAAwB,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACvD,wEAAwE;IACxE,sBAAsB,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CAAC;CACpD;AAED,MAAM,MAAM,IAAI,GACZ,WAAW,GACX,uBAAuB,GACvB,iBAAiB,GACjB,gBAAgB,GAChB,cAAc,CAAC"}

package/esm/hooks/types.js

@@ -0,0 +1,5 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/esm/hooks/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/hooks/types.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,iBAAiB,CAAC;AAChC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,cAAc,cAAc,CAAC"}

package/esm/index.js

@@ -0,0 +1,7 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+export * from "./lib/config.js";
+export * as files from "./lib/files.js";
+export * from "./sdk/sdk.js";
+//# sourceMappingURL=index.js.map

package/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,iBAAiB,CAAC;AAChC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,cAAc,cAAc,CAAC"}

package/esm/lib/base64.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base64.d.ts","sourceRoot":"","sources":["../../src/lib/base64.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,wBAAgB,aAAa,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAEvD;AAED,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU,CAE3D;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAErD;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAEzD;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAElD;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEvD;AAED,eAAO,MAAM,WAAW,8GAEkB,CAAC;AAE3C,eAAO,MAAM,UAAU,8GAEqB,CAAC"}

package/esm/lib/base64.js

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod";
+export function bytesToBase64(u8arr) {
+    return btoa(String.fromCodePoint(...u8arr));
+}
+export function bytesFromBase64(encoded) {
+    return Uint8Array.from(atob(encoded), (c) => c.charCodeAt(0));
+}
+export function stringToBytes(str) {
+    return new TextEncoder().encode(str);
+}
+export function stringFromBytes(u8arr) {
+    return new TextDecoder().decode(u8arr);
+}
+export function stringToBase64(str) {
+    return bytesToBase64(stringToBytes(str));
+}
+export function stringFromBase64(b64str) {
+    return stringFromBytes(bytesFromBase64(b64str));
+}
+export const zodOutbound = z
+    .instanceof(Uint8Array)
+    .or(z.string().transform(stringToBytes));
+export const zodInbound = z
+    .instanceof(Uint8Array)
+    .or(z.string().transform(bytesFromBase64));
+//# sourceMappingURL=base64.js.map

package/esm/lib/base64.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base64.js","sourceRoot":"","sources":["../../src/lib/base64.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,MAAM,UAAU,aAAa,CAAC,KAAiB;IAC7C,OAAO,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,OAAe;IAC7C,OAAO,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,GAAW;IACvC,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,KAAiB;IAC/C,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACzC,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,GAAW;IACxC,OAAO,aAAa,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;AAC3C,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,MAAc;IAC7C,OAAO,eAAe,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC;KACzB,UAAU,CAAC,UAAU,CAAC;KACtB,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;AAE3C,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC;KACxB,UAAU,CAAC,UAAU,CAAC;KACtB,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC"}

package/esm/lib/config.d.ts

@@ -0,0 +1,38 @@
+import { HTTPClient } from "./http.js";
+import { Logger } from "./logger.js";
+import { RetryConfig } from "./retries.js";
+/**
+ * Contains the list of servers available to the SDK
+ */
+export declare const ServerList: readonly ["https://staging.api.commercengine.io/api/v1/{store_id}/storefront", "https://prod.api.commercengine.io/api/v1/{store_id}/storefront"];
+export type SDKOptions = {
+    authorization?: string | (() => Promise<string>);
+    httpClient?: HTTPClient;
+    /**
+     * Allows overriding the default server used by the SDK
+     */
+    serverIdx?: number;
+    /**
+     * Sets the store_id variable for url substitution
+     */
+    storeId?: string;
+    /**
+     * Allows overriding the default server URL used by the SDK
+     */
+    serverURL?: string;
+    /**
+     * Allows overriding the default retry config used by the SDK
+     */
+    retryConfig?: RetryConfig;
+    timeoutMs?: number;
+    debugLogger?: Logger;
+};
+export declare function serverURLFromOptions(options: SDKOptions): URL | null;
+export declare const SDK_METADATA: {
+    readonly language: "typescript";
+    readonly openapiDocVersion: "1.0";
+    readonly sdkVersion: "0.3.1";
+    readonly genVersion: "2.493.34";
+    readonly userAgent: "speakeasy-sdk/typescript 0.3.1 2.493.34 1.0 ce-storefront";
+};
+//# sourceMappingURL=config.d.ts.map

package/esm/lib/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/lib/config.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAG3C;;GAEG;AACH,eAAO,MAAM,UAAU,kJASb,CAAC;AAEX,MAAM,MAAM,UAAU,GAAG;IACvB,aAAa,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAEjD,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,UAAU,GAAG,GAAG,GAAG,IAAI,CAwBpE;AAED,eAAO,MAAM,YAAY;;;;;;CAMf,CAAC"}

package/esm/lib/config.js

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import { pathToFunc } from "./url.js";
+/**
+ * Contains the list of servers available to the SDK
+ */
+export const ServerList = [
+    /**
+     * Staging Server
+     */
+    "https://staging.api.commercengine.io/api/v1/{store_id}/storefront",
+    /**
+     * Prod Server
+     */
+    "https://prod.api.commercengine.io/api/v1/{store_id}/storefront",
+];
+export function serverURLFromOptions(options) {
+    let serverURL = options.serverURL;
+    const serverParams = [
+        {
+            "store_id": options.storeId ?? "x2yh61zw4k",
+        },
+        {
+            "store_id": options.storeId ?? "x2yh61zw4k",
+        },
+    ];
+    let params = {};
+    if (!serverURL) {
+        const serverIdx = options.serverIdx ?? 0;
+        if (serverIdx < 0 || serverIdx >= ServerList.length) {
+            throw new Error(`Invalid server index ${serverIdx}`);
+        }
+        serverURL = ServerList[serverIdx] || "";
+        params = serverParams[serverIdx] || {};
+    }
+    const u = pathToFunc(serverURL)(params);
+    return new URL(u);
+}
+export const SDK_METADATA = {
+    language: "typescript",
+    openapiDocVersion: "1.0",
+    sdkVersion: "0.3.1",
+    genVersion: "2.493.34",
+    userAgent: "speakeasy-sdk/typescript 0.3.1 2.493.34 1.0 ce-storefront",
+};
+//# sourceMappingURL=config.js.map

package/esm/lib/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/lib/config.ts"],"names":[],"mappings":"AAAA;;GAEG;AAKH,OAAO,EAAU,UAAU,EAAE,MAAM,UAAU,CAAC;AAE9C;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB;;OAEG;IACH,mEAAmE;IACnE;;OAEG;IACH,gEAAgE;CACxD,CAAC;AA0BX,MAAM,UAAU,oBAAoB,CAAC,OAAmB;IACtD,IAAI,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IAElC,MAAM,YAAY,GAAa;QAC7B;YACE,UAAU,EAAE,OAAO,CAAC,OAAO,IAAI,YAAY;SAC5C;QACD;YACE,UAAU,EAAE,OAAO,CAAC,OAAO,IAAI,YAAY;SAC5C;KACF,CAAC;IACF,IAAI,MAAM,GAAW,EAAE,CAAC;IAExB,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,CAAC,CAAC;QACzC,IAAI,SAAS,GAAG,CAAC,IAAI,SAAS,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;YACpD,MAAM,IAAI,KAAK,CAAC,wBAAwB,SAAS,EAAE,CAAC,CAAC;QACvD,CAAC;QACD,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QACxC,MAAM,GAAG,YAAY,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IACzC,CAAC;IAED,MAAM,CAAC,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;IACxC,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;AACpB,CAAC;AAED,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,QAAQ,EAAE,YAAY;IACtB,iBAAiB,EAAE,KAAK;IACxB,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE,UAAU;IACtB,SAAS,EAAE,2DAA2D;CAC9D,CAAC"}

package/esm/lib/dlv.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dlv.d.ts","sourceRoot":"","sources":["../../src/lib/dlv.ts"],"names":[],"mappings":"AA2BA;;;;;;;;;;;GAWG;AACH,wBAAgB,GAAG,CAAC,CAAC,GAAG,GAAG,EACzB,GAAG,EAAE,GAAG,EACR,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EACtB,GAAG,CAAC,EAAE,CAAC,EACP,CAAC,CAAC,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,KAAK,GACZ,CAAC,GAAG,SAAS,CAOf"}

package/esm/lib/dlv.js

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+/*
+MIT License
+
+Copyright (c) 2024 Jason Miller <jason@developit.ca> (http://jasonformat.com)
+
+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.
+*/
+/**
+ * @param obj The object to walk
+ * @param key The key path to walk the object with
+ * @param def A default value to return if the result is undefined
+ *
+ * @example
+ * dlv(obj, "a.b.c.d")
+ * @example
+ * dlv(object, ["a", "b", "c", "d"])
+ * @example
+ * dlv(object, "foo.bar.baz", "Hello, default value!")
+ */
+export function dlv(obj, key, def, p, undef) {
+    key = Array.isArray(key) ? key : key.split(".");
+    for (p = 0; p < key.length; p++) {
+        const k = key[p];
+        obj = k != null && obj ? obj[k] : undef;
+    }
+    return obj === undef ? def : obj;
+}
+//# sourceMappingURL=dlv.js.map

package/esm/lib/dlv.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dlv.js","sourceRoot":"","sources":["../../src/lib/dlv.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;;;;;;;;;;;;;;;;;EAqBE;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,GAAG,CACjB,GAAQ,EACR,GAAsB,EACtB,GAAO,EACP,CAAU,EACV,KAAa;IAEb,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAChD,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAChC,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QACjB,GAAG,GAAG,CAAC,IAAI,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC1C,CAAC;IACD,OAAO,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;AACnC,CAAC"}

package/esm/lib/encodings.d.ts

@@ -0,0 +1,52 @@
+export declare class EncodingError extends Error {
+    constructor(message: string);
+}
+export declare function encodeMatrix(key: string, value: unknown, options?: {
+    explode?: boolean;
+    charEncoding?: "percent" | "none";
+}): string | undefined;
+export declare function encodeLabel(key: string, value: unknown, options?: {
+    explode?: boolean;
+    charEncoding?: "percent" | "none";
+}): string | undefined;
+type FormEncoder = (key: string, value: unknown, options?: {
+    explode?: boolean;
+    charEncoding?: "percent" | "none";
+}) => string | undefined;
+export declare const encodeForm: FormEncoder;
+export declare const encodeSpaceDelimited: FormEncoder;
+export declare const encodePipeDelimited: FormEncoder;
+export declare function encodeBodyForm(key: string, value: unknown, options?: {
+    explode?: boolean;
+    charEncoding?: "percent" | "none";
+}): string;
+export declare function encodeDeepObject(key: string, value: unknown, options?: {
+    charEncoding?: "percent" | "none";
+}): string | undefined;
+export declare function encodeDeepObjectObject(key: string, value: unknown, options?: {
+    charEncoding?: "percent" | "none";
+}): string | undefined;
+export declare function encodeJSON(key: string, value: unknown, options?: {
+    explode?: boolean;
+    charEncoding?: "percent" | "none";
+}): string | undefined;
+export declare const encodeSimple: (key: string, value: unknown, options?: {
+    explode?: boolean;
+    charEncoding?: "percent" | "none";
+}) => string | undefined;
+export declare function queryJoin(...args: (string | undefined)[]): string;
+type QueryEncoderOptions = {
+    explode?: boolean;
+    charEncoding?: "percent" | "none";
+};
+type QueryEncoder = (key: string, value: unknown, options?: QueryEncoderOptions) => string | undefined;
+type BulkQueryEncoder = (values: Record<string, unknown>, options?: QueryEncoderOptions) => string;
+export declare function queryEncoder(f: QueryEncoder): BulkQueryEncoder;
+export declare const encodeJSONQuery: BulkQueryEncoder;
+export declare const encodeFormQuery: BulkQueryEncoder;
+export declare const encodeSpaceDelimitedQuery: BulkQueryEncoder;
+export declare const encodePipeDelimitedQuery: BulkQueryEncoder;
+export declare const encodeDeepObjectQuery: BulkQueryEncoder;
+export declare function appendForm(fd: FormData, key: string, value: unknown, fileName?: string): void;
+export {};
+//# sourceMappingURL=encodings.d.ts.map

package/esm/lib/encodings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encodings.d.ts","sourceRoot":"","sources":["../../src/lib/encodings.ts"],"names":[],"mappings":"AAOA,qBAAa,aAAc,SAAQ,KAAK;gBAC1B,OAAO,EAAE,MAAM;CAI5B;AAED,wBAAgB,YAAY,CAC1B,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,YAAY,CAAC,EAAE,SAAS,GAAG,MAAM,CAAA;CAAE,GACjE,MAAM,GAAG,SAAS,CAoDpB;AAED,wBAAgB,WAAW,CACzB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,YAAY,CAAC,EAAE,SAAS,GAAG,MAAM,CAAA;CAAE,GACjE,MAAM,GAAG,SAAS,CAqCpB;AAED,KAAK,WAAW,GAAG,CACjB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,YAAY,CAAC,EAAE,SAAS,GAAG,MAAM,CAAA;CAAE,KAC/D,MAAM,GAAG,SAAS,CAAC;AA2DxB,eAAO,MAAM,UAAU,aAAmB,CAAC;AAC3C,eAAO,MAAM,oBAAoB,aAAmB,CAAC;AACrD,eAAO,MAAM,mBAAmB,aAAmB,CAAC;AAEpD,wBAAgB,cAAc,CAC5B,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,YAAY,CAAC,EAAE,SAAS,GAAG,MAAM,CAAA;CAAE,GACjE,MAAM,CAqCR;AAED,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE;IAAE,YAAY,CAAC,EAAE,SAAS,GAAG,MAAM,CAAA;CAAE,GAC9C,MAAM,GAAG,SAAS,CAYpB;AAED,wBAAgB,sBAAsB,CACpC,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE;IAAE,YAAY,CAAC,EAAE,SAAS,GAAG,MAAM,CAAA;CAAE,GAC9C,MAAM,GAAG,SAAS,CAuCpB;AAED,wBAAgB,UAAU,CACxB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,YAAY,CAAC,EAAE,SAAS,GAAG,MAAM,CAAA;CAAE,GACjE,MAAM,GAAG,SAAS,CAYpB;AAED,eAAO,MAAM,YAAY,QAClB,MAAM,SACJ,OAAO,YACJ;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,YAAY,CAAC,EAAE,SAAS,GAAG,MAAM,CAAA;CAAE,KACjE,MAAM,GAAG,SAoCX,CAAC;AA2EF,wBAAgB,SAAS,CAAC,GAAG,IAAI,EAAE,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,GAAG,MAAM,CAEjE;AAED,KAAK,mBAAmB,GAAG;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;CACnC,CAAC;AAEF,KAAK,YAAY,GAAG,CAClB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,mBAAmB,KAC1B,MAAM,GAAG,SAAS,CAAC;AAExB,KAAK,gBAAgB,GAAG,CACtB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,OAAO,CAAC,EAAE,mBAAmB,KAC1B,MAAM,CAAC;AAEZ,wBAAgB,YAAY,CAAC,CAAC,EAAE,YAAY,GAAG,gBAAgB,CAkB9D;AAED,eAAO,MAAM,eAAe,kBAA2B,CAAC;AACxD,eAAO,MAAM,eAAe,kBAA2B,CAAC;AACxD,eAAO,MAAM,yBAAyB,kBAAqC,CAAC;AAC5E,eAAO,MAAM,wBAAwB,kBAAoC,CAAC;AAC1E,eAAO,MAAM,qBAAqB,kBAAiC,CAAC;AAEpE,wBAAgB,UAAU,CACxB,EAAE,EAAE,QAAQ,EACZ,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,QAAQ,CAAC,EAAE,MAAM,GAChB,IAAI,CAUN"}

package/esm/lib/encodings.js

@@ -0,0 +1,354 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import { bytesToBase64 } from "./base64.js";
+import { isPlainObject } from "./is-plain-object.js";
+export class EncodingError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "EncodingError";
+    }
+}
+export function encodeMatrix(key, value, options) {
+    let out = "";
+    const pairs = options?.explode
+        ? explode(key, value)
+        : [[key, value]];
+    if (pairs.every(([_, v]) => v == null)) {
+        return;
+    }
+    const encodeString = (v) => {
+        return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+    };
+    const encodeValue = (v) => encodeString(serializeValue(v));
+    pairs.forEach(([pk, pv]) => {
+        let tmp = "";
+        let encValue = null;
+        if (pv == null) {
+            return;
+        }
+        else if (Array.isArray(pv)) {
+            encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(",");
+        }
+        else if (isPlainObject(pv)) {
+            const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => {
+                return `,${encodeString(k)},${encodeValue(v)}`;
+            });
+            encValue = mapped?.join("").slice(1);
+        }
+        else {
+            encValue = `${encodeValue(pv)}`;
+        }
+        if (encValue == null) {
+            return;
+        }
+        const keyPrefix = encodeString(pk);
+        tmp = `${keyPrefix}=${encValue}`;
+        // trim trailing '=' if value was empty
+        if (tmp === `${keyPrefix}=`) {
+            tmp = tmp.slice(0, -1);
+        }
+        // If we end up with the nothing then skip forward
+        if (!tmp) {
+            return;
+        }
+        out += `;${tmp}`;
+    });
+    return out;
+}
+export function encodeLabel(key, value, options) {
+    let out = "";
+    const pairs = options?.explode
+        ? explode(key, value)
+        : [[key, value]];
+    if (pairs.every(([_, v]) => v == null)) {
+        return;
+    }
+    const encodeString = (v) => {
+        return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+    };
+    const encodeValue = (v) => encodeString(serializeValue(v));
+    pairs.forEach(([pk, pv]) => {
+        let encValue = "";
+        if (pv == null) {
+            return;
+        }
+        else if (Array.isArray(pv)) {
+            encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(".");
+        }
+        else if (isPlainObject(pv)) {
+            const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => {
+                return `.${encodeString(k)}.${encodeValue(v)}`;
+            });
+            encValue = mapped?.join("").slice(1);
+        }
+        else {
+            const k = options?.explode && isPlainObject(value) ? `${encodeString(pk)}=` : "";
+            encValue = `${k}${encodeValue(pv)}`;
+        }
+        out += encValue == null ? "" : `.${encValue}`;
+    });
+    return out;
+}
+function formEncoder(sep) {
+    return (key, value, options) => {
+        let out = "";
+        const pairs = options?.explode
+            ? explode(key, value)
+            : [[key, value]];
+        if (pairs.every(([_, v]) => v == null)) {
+            return;
+        }
+        const encodeString = (v) => {
+            return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+        };
+        const encodeValue = (v) => encodeString(serializeValue(v));
+        const encodedSep = encodeString(sep);
+        pairs.forEach(([pk, pv]) => {
+            let tmp = "";
+            let encValue = null;
+            if (pv == null) {
+                return;
+            }
+            else if (Array.isArray(pv)) {
+                encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(encodedSep);
+            }
+            else if (isPlainObject(pv)) {
+                encValue = mapDefinedEntries(Object.entries(pv), ([k, v]) => {
+                    return `${encodeString(k)}${encodedSep}${encodeValue(v)}`;
+                })?.join(encodedSep);
+            }
+            else {
+                encValue = `${encodeValue(pv)}`;
+            }
+            if (encValue == null) {
+                return;
+            }
+            tmp = `${encodeString(pk)}=${encValue}`;
+            // If we end up with the nothing then skip forward
+            if (!tmp || tmp === "=") {
+                return;
+            }
+            out += `&${tmp}`;
+        });
+        return out.slice(1);
+    };
+}
+export const encodeForm = formEncoder(",");
+export const encodeSpaceDelimited = formEncoder(" ");
+export const encodePipeDelimited = formEncoder("|");
+export function encodeBodyForm(key, value, options) {
+    let out = "";
+    const pairs = options?.explode
+        ? explode(key, value)
+        : [[key, value]];
+    const encodeString = (v) => {
+        return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+    };
+    const encodeValue = (v) => encodeString(serializeValue(v));
+    pairs.forEach(([pk, pv]) => {
+        let tmp = "";
+        let encValue = "";
+        if (pv == null) {
+            return;
+        }
+        else if (Array.isArray(pv)) {
+            encValue = JSON.stringify(pv, jsonReplacer);
+        }
+        else if (isPlainObject(pv)) {
+            encValue = JSON.stringify(pv, jsonReplacer);
+        }
+        else {
+            encValue = `${encodeValue(pv)}`;
+        }
+        tmp = `${encodeString(pk)}=${encValue}`;
+        // If we end up with the nothing then skip forward
+        if (!tmp || tmp === "=") {
+            return;
+        }
+        out += `&${tmp}`;
+    });
+    return out.slice(1);
+}
+export function encodeDeepObject(key, value, options) {
+    if (value == null) {
+        return;
+    }
+    if (!isPlainObject(value)) {
+        throw new EncodingError(`Value of parameter '${key}' which uses deepObject encoding must be an object or null`);
+    }
+    return encodeDeepObjectObject(key, value, options);
+}
+export function encodeDeepObjectObject(key, value, options) {
+    if (value == null) {
+        return;
+    }
+    let out = "";
+    const encodeString = (v) => {
+        return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+    };
+    if (!isPlainObject(value)) {
+        throw new EncodingError(`Expected parameter '${key}' to be an object.`);
+    }
+    Object.entries(value).forEach(([ck, cv]) => {
+        if (cv == null) {
+            return;
+        }
+        const pk = `${key}[${ck}]`;
+        if (isPlainObject(cv)) {
+            const objOut = encodeDeepObjectObject(pk, cv, options);
+            out += objOut == null ? "" : `&${objOut}`;
+            return;
+        }
+        const pairs = Array.isArray(cv) ? cv : [cv];
+        const encoded = mapDefined(pairs, (v) => {
+            return `${encodeString(pk)}=${encodeString(serializeValue(v))}`;
+        })?.join("&");
+        out += encoded == null ? "" : `&${encoded}`;
+    });
+    return out.slice(1);
+}
+export function encodeJSON(key, value, options) {
+    if (typeof value === "undefined") {
+        return;
+    }
+    const encodeString = (v) => {
+        return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+    };
+    const encVal = encodeString(JSON.stringify(value, jsonReplacer));
+    return options?.explode ? encVal : `${encodeString(key)}=${encVal}`;
+}
+export const encodeSimple = (key, value, options) => {
+    let out = "";
+    const pairs = options?.explode
+        ? explode(key, value)
+        : [[key, value]];
+    if (pairs.every(([_, v]) => v == null)) {
+        return;
+    }
+    const encodeString = (v) => {
+        return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+    };
+    const encodeValue = (v) => encodeString(serializeValue(v));
+    pairs.forEach(([pk, pv]) => {
+        let tmp = "";
+        if (pv == null) {
+            return;
+        }
+        else if (Array.isArray(pv)) {
+            tmp = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(",");
+        }
+        else if (isPlainObject(pv)) {
+            const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => {
+                return `,${encodeString(k)},${encodeValue(v)}`;
+            });
+            tmp = mapped?.join("").slice(1);
+        }
+        else {
+            const k = options?.explode && isPlainObject(value) ? `${pk}=` : "";
+            tmp = `${k}${encodeValue(pv)}`;
+        }
+        out += tmp ? `,${tmp}` : "";
+    });
+    return out.slice(1);
+};
+function explode(key, value) {
+    if (Array.isArray(value)) {
+        return value.map((v) => [key, v]);
+    }
+    else if (isPlainObject(value)) {
+        const o = value ?? {};
+        return Object.entries(o).map(([k, v]) => [k, v]);
+    }
+    else {
+        return [[key, value]];
+    }
+}
+function serializeValue(value) {
+    if (value == null) {
+        return "";
+    }
+    else if (value instanceof Date) {
+        return value.toISOString();
+    }
+    else if (value instanceof Uint8Array) {
+        return bytesToBase64(value);
+    }
+    else if (typeof value === "object") {
+        return JSON.stringify(value, jsonReplacer);
+    }
+    return `${value}`;
+}
+function jsonReplacer(_, value) {
+    if (value instanceof Uint8Array) {
+        return bytesToBase64(value);
+    }
+    else {
+        return value;
+    }
+}
+function mapDefined(inp, mapper) {
+    const res = inp.reduce((acc, v) => {
+        if (v == null) {
+            return acc;
+        }
+        const m = mapper(v);
+        if (m == null) {
+            return acc;
+        }
+        acc.push(m);
+        return acc;
+    }, []);
+    return res.length ? res : null;
+}
+function mapDefinedEntries(inp, mapper) {
+    const acc = [];
+    for (const [k, v] of inp) {
+        if (v == null) {
+            continue;
+        }
+        const m = mapper([k, v]);
+        if (m == null) {
+            continue;
+        }
+        acc.push(m);
+    }
+    return acc.length ? acc : null;
+}
+export function queryJoin(...args) {
+    return args.filter(Boolean).join("&");
+}
+export function queryEncoder(f) {
+    const bulkEncode = function (values, options) {
+        const opts = {
+            ...options,
+            explode: options?.explode ?? true,
+            charEncoding: options?.charEncoding ?? "percent",
+        };
+        const encoded = Object.entries(values).map(([key, value]) => {
+            return f(key, value, opts);
+        });
+        return queryJoin(...encoded);
+    };
+    return bulkEncode;
+}
+export const encodeJSONQuery = queryEncoder(encodeJSON);
+export const encodeFormQuery = queryEncoder(encodeForm);
+export const encodeSpaceDelimitedQuery = queryEncoder(encodeSpaceDelimited);
+export const encodePipeDelimitedQuery = queryEncoder(encodePipeDelimited);
+export const encodeDeepObjectQuery = queryEncoder(encodeDeepObject);
+export function appendForm(fd, key, value, fileName) {
+    if (value == null) {
+        return;
+    }
+    else if (value instanceof Blob && fileName) {
+        fd.append(key, value, fileName);
+    }
+    else if (value instanceof Blob) {
+        fd.append(key, value);
+    }
+    else {
+        fd.append(key, String(value));
+    }
+}
+//# sourceMappingURL=encodings.js.map