@openrouter/sdk 0.0.1-beta.3 → 0.0.1-beta.6

package/funcs/parametersGetParameters.js

@@ -0,0 +1,95 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { resolveSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as errors from "../models/errors/index.js";
+import * as operations from "../models/operations/index.js";
+import { APIPromise } from "../types/async.js";
+/**
+ * Get a model's supported parameters and data about which are most popular
+ */
+export function parametersGetParameters(client, security, request, options) {
+    return new APIPromise($do(client, security, request, options));
+}
+async function $do(client, security, request, options) {
+    const parsed = safeParse(request, (value) => operations.GetParametersRequest$outboundSchema.parse(value), "Input validation failed");
+    if (!parsed.ok) {
+        return [parsed, { status: "invalid" }];
+    }
+    const payload = parsed.value;
+    const body = null;
+    const pathParams = {
+        author: encodeSimple("author", payload.author, {
+            explode: false,
+            charEncoding: "percent",
+        }),
+        slug: encodeSimple("slug", payload.slug, {
+            explode: false,
+            charEncoding: "percent",
+        }),
+    };
+    const path = pathToFunc("/parameters/{author}/{slug}")(pathParams);
+    const query = encodeFormQuery({
+        "provider": payload.provider,
+    });
+    const headers = new Headers(compactMap({
+        Accept: "application/json",
+    }));
+    const requestSecurity = resolveSecurity([
+        {
+            fieldName: "Authorization",
+            type: "http:bearer",
+            value: security?.bearer,
+        },
+    ]);
+    const context = {
+        options: client._options,
+        baseURL: options?.serverURL ?? client._baseURL ?? "",
+        operationID: "getParameters",
+        oAuth2Scopes: null,
+        resolvedSecurity: requestSecurity,
+        securitySource: security,
+        retryConfig: options?.retries
+            || client._options.retryConfig
+            || { strategy: "none" },
+        retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    };
+    const requestRes = client._createRequest(context, {
+        security: requestSecurity,
+        method: "GET",
+        baseURL: options?.serverURL,
+        path: path,
+        headers: headers,
+        query: query,
+        body: body,
+        userAgent: client._options.userAgent,
+        timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+    }, options);
+    if (!requestRes.ok) {
+        return [requestRes, { status: "invalid" }];
+    }
+    const req = requestRes.value;
+    const doResult = await client._do(req, {
+        context,
+        errorCodes: ["4XX", "5XX"],
+        retryConfig: context.retryConfig,
+        retryCodes: context.retryCodes,
+    });
+    if (!doResult.ok) {
+        return [doResult, { status: "request-error", request: req }];
+    }
+    const response = doResult.value;
+    const responseFields = {
+        HttpMeta: { Response: response, Request: req },
+    };
+    const [result] = await M.match(M.json(200, operations.GetParametersResponse$inboundSchema), M.jsonErr("4XX", errors.ErrorResponse$inboundSchema), M.jsonErr("5XX", errors.ErrorResponse$inboundSchema))(response, req, { extraFields: responseFields });
+    if (!result.ok) {
+        return [result, { status: "complete", request: req, response }];
+    }
+    return [result, { status: "complete", request: req, response }];
+}

package/funcs/providersList.d.ts

@@ -0,0 +1,14 @@
+import { OpenRouterCore } from "../core.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { OpenRouterError } from "../models/errors/openroutererror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+/**
+ * List all providers
+ */
+export declare function providersList(client: OpenRouterCore, options?: RequestOptions): APIPromise<Result<operations.ListProvidersResponse, errors.InternalServerError | OpenRouterError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;

package/funcs/providersList.js

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as errors from "../models/errors/index.js";
+import * as operations from "../models/operations/index.js";
+import { APIPromise } from "../types/async.js";
+/**
+ * List all providers
+ */
+export function providersList(client, options) {
+    return new APIPromise($do(client, options));
+}
+async function $do(client, options) {
+    const path = pathToFunc("/providers")();
+    const headers = new Headers(compactMap({
+        Accept: "application/json",
+    }));
+    const secConfig = await extractSecurity(client._options.apiKey);
+    const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+    const requestSecurity = resolveGlobalSecurity(securityInput);
+    const context = {
+        options: client._options,
+        baseURL: options?.serverURL ?? client._baseURL ?? "",
+        operationID: "listProviders",
+        oAuth2Scopes: null,
+        resolvedSecurity: requestSecurity,
+        securitySource: client._options.apiKey,
+        retryConfig: options?.retries
+            || client._options.retryConfig
+            || { strategy: "none" },
+        retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    };
+    const requestRes = client._createRequest(context, {
+        security: requestSecurity,
+        method: "GET",
+        baseURL: options?.serverURL,
+        path: path,
+        headers: headers,
+        userAgent: client._options.userAgent,
+        timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+    }, options);
+    if (!requestRes.ok) {
+        return [requestRes, { status: "invalid" }];
+    }
+    const req = requestRes.value;
+    const doResult = await client._do(req, {
+        context,
+        errorCodes: ["4XX", "500", "5XX"],
+        retryConfig: context.retryConfig,
+        retryCodes: context.retryCodes,
+    });
+    if (!doResult.ok) {
+        return [doResult, { status: "request-error", request: req }];
+    }
+    const response = doResult.value;
+    const responseFields = {
+        HttpMeta: { Response: response, Request: req },
+    };
+    const [result] = await M.match(M.json(200, operations.ListProvidersResponse$inboundSchema), M.jsonErr(500, errors.InternalServerError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
+    if (!result.ok) {
+        return [result, { status: "complete", request: req, response }];
+    }
+    return [result, { status: "complete", request: req, response }];
+}

package/hooks/hooks.d.ts

@@ -0,0 +1,24 @@
+import { SDKOptions } from "../lib/config.js";
+import { RequestInput } from "../lib/http.js";
+import { AfterErrorContext, AfterErrorHook, AfterSuccessContext, AfterSuccessHook, BeforeCreateRequestContext, BeforeCreateRequestHook, BeforeRequestContext, BeforeRequestHook, Hooks, SDKInitHook } from "./types.js";
+export declare class SDKHooks implements Hooks {
+    sdkInitHooks: SDKInitHook[];
+    beforeCreateRequestHooks: BeforeCreateRequestHook[];
+    beforeRequestHooks: BeforeRequestHook[];
+    afterSuccessHooks: AfterSuccessHook[];
+    afterErrorHooks: AfterErrorHook[];
+    constructor();
+    registerSDKInitHook(hook: SDKInitHook): void;
+    registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook): void;
+    registerBeforeRequestHook(hook: BeforeRequestHook): void;
+    registerAfterSuccessHook(hook: AfterSuccessHook): void;
+    registerAfterErrorHook(hook: AfterErrorHook): void;
+    sdkInit(opts: SDKOptions): SDKOptions;
+    beforeCreateRequest(hookCtx: BeforeCreateRequestContext, input: RequestInput): RequestInput;
+    beforeRequest(hookCtx: BeforeRequestContext, request: Request): Promise<Request>;
+    afterSuccess(hookCtx: AfterSuccessContext, response: Response): Promise<Response>;
+    afterError(hookCtx: AfterErrorContext, response: Response | null, error: unknown): Promise<{
+        response: Response | null;
+        error: unknown;
+    }>;
+}

package/hooks/hooks.js

@@ -0,0 +1,81 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import { initHooks } from "./registration.js";
+export class SDKHooks {
+    constructor() {
+        this.sdkInitHooks = [];
+        this.beforeCreateRequestHooks = [];
+        this.beforeRequestHooks = [];
+        this.afterSuccessHooks = [];
+        this.afterErrorHooks = [];
+        const presetHooks = [];
+        for (const hook of presetHooks) {
+            if ("sdkInit" in hook) {
+                this.registerSDKInitHook(hook);
+            }
+            if ("beforeCreateRequest" in hook) {
+                this.registerBeforeCreateRequestHook(hook);
+            }
+            if ("beforeRequest" in hook) {
+                this.registerBeforeRequestHook(hook);
+            }
+            if ("afterSuccess" in hook) {
+                this.registerAfterSuccessHook(hook);
+            }
+            if ("afterError" in hook) {
+                this.registerAfterErrorHook(hook);
+            }
+        }
+        initHooks(this);
+    }
+    registerSDKInitHook(hook) {
+        this.sdkInitHooks.push(hook);
+    }
+    registerBeforeCreateRequestHook(hook) {
+        this.beforeCreateRequestHooks.push(hook);
+    }
+    registerBeforeRequestHook(hook) {
+        this.beforeRequestHooks.push(hook);
+    }
+    registerAfterSuccessHook(hook) {
+        this.afterSuccessHooks.push(hook);
+    }
+    registerAfterErrorHook(hook) {
+        this.afterErrorHooks.push(hook);
+    }
+    sdkInit(opts) {
+        return this.sdkInitHooks.reduce((opts, hook) => hook.sdkInit(opts), opts);
+    }
+    beforeCreateRequest(hookCtx, input) {
+        let inp = input;
+        for (const hook of this.beforeCreateRequestHooks) {
+            inp = hook.beforeCreateRequest(hookCtx, inp);
+        }
+        return inp;
+    }
+    async beforeRequest(hookCtx, request) {
+        let req = request;
+        for (const hook of this.beforeRequestHooks) {
+            req = await hook.beforeRequest(hookCtx, req);
+        }
+        return req;
+    }
+    async afterSuccess(hookCtx, response) {
+        let res = response;
+        for (const hook of this.afterSuccessHooks) {
+            res = await hook.afterSuccess(hookCtx, res);
+        }
+        return res;
+    }
+    async afterError(hookCtx, response, error) {
+        let res = response;
+        let err = error;
+        for (const hook of this.afterErrorHooks) {
+            const result = await hook.afterError(hookCtx, res, err);
+            res = result.response;
+            err = result.error;
+        }
+        return { response: res, error: err };
+    }
+}

package/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./hooks.js";
+export * from "./types.js";

package/hooks/index.js

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

package/hooks/registration.d.ts

@@ -0,0 +1,2 @@
+import { Hooks } from "./types.js";
+export declare function initHooks(hooks: Hooks): void;

package/hooks/registration.js

@@ -0,0 +1,11 @@
+/*
+ * This file is only ever generated once on the first generation and then is free to be modified.
+ * Any hooks you wish to add should be registered in the initHooks function. Feel free to define them
+ * in this file or in separate files in the hooks folder.
+ */
+// @ts-expect-error remove this line when you add your first hook and hooks is used
+export function initHooks(hooks) {
+    // Add hooks by calling hooks.register{ClientInit/BeforeCreateRequest/BeforeRequest/AfterSuccess/AfterError}Hook
+    // with an instance of a hook that implements that specific Hook interface
+    // Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance
+}

package/hooks/types.d.ts

@@ -0,0 +1,75 @@
+import { SDKOptions } from "../lib/config.js";
+import { RequestInput } from "../lib/http.js";
+import { RetryConfig } from "../lib/retries.js";
+import { SecurityState } from "../lib/security.js";
+export type HookContext = {
+    baseURL: string | URL;
+    operationID: string;
+    oAuth2Scopes: string[] | null;
+    securitySource?: any | (() => Promise<any>);
+    retryConfig: RetryConfig;
+    resolvedSecurity: SecurityState | null;
+    options: SDKOptions;
+};
+export type Awaitable<T> = T | Promise<T>;
+export type BeforeCreateRequestContext = HookContext & {};
+export type BeforeRequestContext = HookContext & {};
+export type AfterSuccessContext = HookContext & {};
+export type AfterErrorContext = HookContext & {};
+/**
+ * SDKInitHook is called when the SDK is initializing. The
+ * hook can return a new baseURL and HTTP client to be used by the SDK.
+ */
+export interface SDKInitHook {
+    sdkInit: (opts: SDKOptions) => SDKOptions;
+}
+export interface BeforeCreateRequestHook {
+    /**
+     * A hook that is called before the SDK creates a `Request` object. The hook
+     * can modify how a request is constructed since certain modifications, like
+     * changing the request URL, cannot be done on a request object directly.
+     */
+    beforeCreateRequest: (hookCtx: BeforeCreateRequestContext, input: RequestInput) => RequestInput;
+}
+export interface BeforeRequestHook {
+    /**
+     * A hook that is called before the SDK sends a request. The hook can
+     * introduce instrumentation code such as logging, tracing and metrics or
+     * replace the request before it is sent or throw an error to stop the
+     * request from being sent.
+     */
+    beforeRequest: (hookCtx: BeforeRequestContext, request: Request) => Awaitable<Request>;
+}
+export interface AfterSuccessHook {
+    /**
+     * A hook that is called after the SDK receives a response. The hook can
+     * introduce instrumentation code such as logging, tracing and metrics or
+     * modify the response before it is handled or throw an error to stop the
+     * response from being handled.
+     */
+    afterSuccess: (hookCtx: AfterSuccessContext, response: Response) => Awaitable<Response>;
+}
+export interface AfterErrorHook {
+    /**
+     * A hook that is called after the SDK encounters an error, or a
+     * non-successful response. The hook can introduce instrumentation code such
+     * as logging, tracing and metrics or modify the response or error values.
+     */
+    afterError: (hookCtx: AfterErrorContext, response: Response | null, error: unknown) => Awaitable<{
+        response: Response | null;
+        error: unknown;
+    }>;
+}
+export interface Hooks {
+    /** Registers a hook to be used by the SDK for initialization event. */
+    registerSDKInitHook(hook: SDKInitHook): void;
+    /** Registers a hook to be used by the SDK for to modify `Request` construction. */
+    registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook): void;
+    /** Registers a hook to be used by the SDK for the before request event. */
+    registerBeforeRequestHook(hook: BeforeRequestHook): void;
+    /** Registers a hook to be used by the SDK for the after success event. */
+    registerAfterSuccessHook(hook: AfterSuccessHook): void;
+    /** Registers a hook to be used by the SDK for the after error event. */
+    registerAfterErrorHook(hook: AfterErrorHook): void;
+}
+export type Hook = SDKInitHook | BeforeCreateRequestHook | BeforeRequestHook | AfterSuccessHook | AfterErrorHook;

package/hooks/types.js

@@ -0,0 +1,4 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+export {};

package/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./lib/config.js";
+export * as files from "./lib/files.js";
+export { HTTPClient } from "./lib/http.js";
+export type { Fetcher, HTTPClientOptions } from "./lib/http.js";
+export * from "./sdk/sdk.js";

package/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 { HTTPClient } from "./lib/http.js";
+export * from "./sdk/sdk.js";

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@openrouter/sdk",
-  "version": "0.0.1-beta.3",
+  "version": "0.0.1-beta.6",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/lib/base64.d.ts

@@ -0,0 +1,9 @@
+import * as z from "zod/v3";
+export declare function bytesToBase64(u8arr: Uint8Array): string;
+export declare function bytesFromBase64(encoded: string): Uint8Array;
+export declare function stringToBytes(str: string): Uint8Array;
+export declare function stringFromBytes(u8arr: Uint8Array): string;
+export declare function stringToBase64(str: string): string;
+export declare function stringFromBase64(b64str: string): string;
+export declare const zodOutbound: z.ZodUnion<[z.ZodType<Uint8Array<ArrayBuffer>, z.ZodTypeDef, Uint8Array<ArrayBuffer>>, z.ZodEffects<z.ZodString, Uint8Array<ArrayBufferLike>, string>]>;
+export declare const zodInbound: z.ZodUnion<[z.ZodType<Uint8Array<ArrayBuffer>, z.ZodTypeDef, Uint8Array<ArrayBuffer>>, z.ZodEffects<z.ZodString, Uint8Array<ArrayBufferLike>, string>]>;

package/lib/base64.js

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+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));

package/lib/config.d.ts

@@ -0,0 +1,43 @@
+import { HTTPClient } from "./http.js";
+import { Logger } from "./logger.js";
+import { RetryConfig } from "./retries.js";
+/**
+ * Production server
+ */
+export declare const ServerProduction = "production";
+/**
+ * Contains the list of servers available to the SDK
+ */
+export declare const ServerList: {
+    readonly production: "https://openrouter.ai/api/v1";
+};
+export type SDKOptions = {
+    apiKey?: string | (() => Promise<string>) | undefined;
+    httpClient?: HTTPClient;
+    /**
+     * Allows overriding the default server used by the SDK
+     */
+    server?: keyof typeof ServerList | undefined;
+    /**
+     * Allows overriding the default server URL used by the SDK
+     */
+    serverURL?: string | undefined;
+    /**
+     * Allows overriding the default user agent used by the SDK
+     */
+    userAgent?: string | undefined;
+    /**
+     * 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.0";
+    readonly sdkVersion: "0.0.1-beta.6";
+    readonly genVersion: "2.729.3";
+    readonly userAgent: "speakeasy-sdk/typescript 0.0.1-beta.6 2.729.3 1.0.0 @openrouter/sdk";
+};

package/lib/config.js

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import { pathToFunc } from "./url.js";
+/**
+ * Production server
+ */
+export const ServerProduction = "production";
+/**
+ * Contains the list of servers available to the SDK
+ */
+export const ServerList = {
+    [ServerProduction]: "https://openrouter.ai/api/v1",
+};
+export function serverURLFromOptions(options) {
+    let serverURL = options.serverURL;
+    const params = {};
+    if (!serverURL) {
+        const server = options.server ?? ServerProduction;
+        serverURL = ServerList[server] || "";
+    }
+    const u = pathToFunc(serverURL)(params);
+    return new URL(u);
+}
+export const SDK_METADATA = {
+    language: "typescript",
+    openapiDocVersion: "1.0.0",
+    sdkVersion: "0.0.1-beta.6",
+    genVersion: "2.729.3",
+    userAgent: "speakeasy-sdk/typescript 0.0.1-beta.6 2.729.3 1.0.0 @openrouter/sdk",
+};

package/lib/dlv.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @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 declare function dlv<T = any>(obj: any, key: string | string[], def?: T, p?: number, undef?: never): T | undefined;

package/lib/dlv.js

@@ -0,0 +1,45 @@
+/*
+ * 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;
+}

package/lib/encodings.d.ts

@@ -0,0 +1,51 @@
+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 {};