ce-storefront 0.0.1

package/src/funcs/wishlistDelete.ts

@@ -0,0 +1,139 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CeStorefrontCore } from "../core.js";
+import { encodeJSON as encodeJSON$, encodeSimple as encodeSimple$ } from "../lib/encodings.js";
+import * as m$ from "../lib/matchers.js";
+import * as schemas$ from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+    ConnectionError,
+    InvalidRequestError,
+    RequestAbortedError,
+    RequestTimeoutError,
+    UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Delete product from wishlist
+ *
+ * @remarks
+ * Remove product from wishlist
+ */
+export async function wishlistDelete(
+    client$: CeStorefrontCore,
+    request: operations.DeleteWishlistRequest,
+    options?: RequestOptions
+): Promise<
+    Result<
+        operations.DeleteWishlistResponseBody,
+        | errors.Unauthorized
+        | errors.NotFound
+        | SDKError
+        | SDKValidationError
+        | UnexpectedClientError
+        | InvalidRequestError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | ConnectionError
+    >
+> {
+    const input$ = request;
+
+    const parsed$ = schemas$.safeParse(
+        input$,
+        (value$) => operations.DeleteWishlistRequest$outboundSchema.parse(value$),
+        "Input validation failed"
+    );
+    if (!parsed$.ok) {
+        return parsed$;
+    }
+    const payload$ = parsed$.value;
+    const body$ = encodeJSON$("body", payload$.RequestBody, { explode: true });
+
+    const pathParams$ = {
+        user_id: encodeSimple$("user_id", payload$.user_id, {
+            explode: false,
+            charEncoding: "percent",
+        }),
+    };
+
+    const path$ = pathToFunc("/wishlist/{user_id}")(pathParams$);
+
+    const headers$ = new Headers({
+        "Content-Type": "application/json",
+        Accept: "application/json",
+    });
+
+    const authorization$ = await extractSecurity(client$.options$.authorization);
+    const security$ = authorization$ == null ? {} : { authorization: authorization$ };
+    const context = {
+        operationID: "delete-wishlist",
+        oAuth2Scopes: [],
+        securitySource: client$.options$.authorization,
+    };
+    const securitySettings$ = resolveGlobalSecurity(security$);
+
+    const requestRes = client$.createRequest$(
+        context,
+        {
+            security: securitySettings$,
+            method: "DELETE",
+            path: path$,
+            headers: headers$,
+            body: body$,
+            timeoutMs: options?.timeoutMs || client$.options$.timeoutMs || -1,
+        },
+        options
+    );
+    if (!requestRes.ok) {
+        return requestRes;
+    }
+    const request$ = requestRes.value;
+
+    const doResult = await client$.do$(request$, {
+        context,
+        errorCodes: ["401", "404", "4XX", "5XX"],
+        retryConfig: options?.retries || client$.options$.retryConfig,
+        retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    });
+    if (!doResult.ok) {
+        return doResult;
+    }
+    const response = doResult.value;
+
+    const responseFields$ = {
+        HttpMeta: { Response: response, Request: request$ },
+    };
+
+    const [result$] = await m$.match<
+        operations.DeleteWishlistResponseBody,
+        | errors.Unauthorized
+        | errors.NotFound
+        | SDKError
+        | SDKValidationError
+        | UnexpectedClientError
+        | InvalidRequestError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | ConnectionError
+    >(
+        m$.json(200, operations.DeleteWishlistResponseBody$inboundSchema),
+        m$.jsonErr(401, errors.Unauthorized$inboundSchema),
+        m$.jsonErr(404, errors.NotFound$inboundSchema),
+        m$.fail(["4XX", "5XX"])
+    )(response, { extraFields: responseFields$ });
+    if (!result$.ok) {
+        return result$;
+    }
+
+    return result$;
+}

package/src/funcs/wishlistGet.ts

@@ -0,0 +1,127 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CeStorefrontCore } from "../core.js";
+import { encodeSimple as encodeSimple$ } from "../lib/encodings.js";
+import * as m$ from "../lib/matchers.js";
+import * as schemas$ from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+    ConnectionError,
+    InvalidRequestError,
+    RequestAbortedError,
+    RequestTimeoutError,
+    UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Retrieve wishlist
+ *
+ * @remarks
+ * Retrieve products in wishlist
+ */
+export async function wishlistGet(
+    client$: CeStorefrontCore,
+    request: operations.GetWishtlistRequest,
+    options?: RequestOptions
+): Promise<
+    Result<
+        operations.GetWishtlistResponseBody,
+        | SDKError
+        | SDKValidationError
+        | UnexpectedClientError
+        | InvalidRequestError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | ConnectionError
+    >
+> {
+    const input$ = request;
+
+    const parsed$ = schemas$.safeParse(
+        input$,
+        (value$) => operations.GetWishtlistRequest$outboundSchema.parse(value$),
+        "Input validation failed"
+    );
+    if (!parsed$.ok) {
+        return parsed$;
+    }
+    const payload$ = parsed$.value;
+    const body$ = null;
+
+    const pathParams$ = {
+        user_id: encodeSimple$("user_id", payload$.user_id, {
+            explode: false,
+            charEncoding: "percent",
+        }),
+    };
+
+    const path$ = pathToFunc("/wishlist/{user_id}")(pathParams$);
+
+    const headers$ = new Headers({
+        Accept: "application/json",
+    });
+
+    const authorization$ = await extractSecurity(client$.options$.authorization);
+    const security$ = authorization$ == null ? {} : { authorization: authorization$ };
+    const context = {
+        operationID: "get-wishtlist",
+        oAuth2Scopes: [],
+        securitySource: client$.options$.authorization,
+    };
+    const securitySettings$ = resolveGlobalSecurity(security$);
+
+    const requestRes = client$.createRequest$(
+        context,
+        {
+            security: securitySettings$,
+            method: "GET",
+            path: path$,
+            headers: headers$,
+            body: body$,
+            timeoutMs: options?.timeoutMs || client$.options$.timeoutMs || -1,
+        },
+        options
+    );
+    if (!requestRes.ok) {
+        return requestRes;
+    }
+    const request$ = requestRes.value;
+
+    const doResult = await client$.do$(request$, {
+        context,
+        errorCodes: ["4XX", "5XX"],
+        retryConfig: options?.retries || client$.options$.retryConfig,
+        retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    });
+    if (!doResult.ok) {
+        return doResult;
+    }
+    const response = doResult.value;
+
+    const [result$] = await m$.match<
+        operations.GetWishtlistResponseBody,
+        | SDKError
+        | SDKValidationError
+        | UnexpectedClientError
+        | InvalidRequestError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | ConnectionError
+    >(
+        m$.json(200, operations.GetWishtlistResponseBody$inboundSchema),
+        m$.fail(["4XX", "5XX"])
+    )(response);
+    if (!result$.ok) {
+        return result$;
+    }
+
+    return result$;
+}

package/src/hooks/hooks.ts

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { RequestInput } from "../lib/http.js";
+import {
+    AfterErrorContext,
+    AfterErrorHook,
+    AfterSuccessContext,
+    AfterSuccessHook,
+    BeforeRequestContext,
+    BeforeRequestHook,
+    BeforeCreateRequestHook,
+    BeforeCreateRequestContext,
+    Hooks,
+    SDKInitHook,
+    SDKInitOptions,
+} from "./types.js";
+
+export class SDKHooks implements Hooks {
+    sdkInitHooks: SDKInitHook[] = [];
+    beforeCreateRequestHooks: BeforeCreateRequestHook[] = [];
+    beforeRequestHooks: BeforeRequestHook[] = [];
+    afterSuccessHooks: AfterSuccessHook[] = [];
+    afterErrorHooks: AfterErrorHook[] = [];
+
+    constructor() {}
+
+    registerSDKInitHook(hook: SDKInitHook) {
+        this.sdkInitHooks.push(hook);
+    }
+
+    registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook) {
+        this.beforeCreateRequestHooks.push(hook);
+    }
+
+    registerBeforeRequestHook(hook: BeforeRequestHook) {
+        this.beforeRequestHooks.push(hook);
+    }
+
+    registerAfterSuccessHook(hook: AfterSuccessHook) {
+        this.afterSuccessHooks.push(hook);
+    }
+
+    registerAfterErrorHook(hook: AfterErrorHook) {
+        this.afterErrorHooks.push(hook);
+    }
+
+    sdkInit(opts: SDKInitOptions): SDKInitOptions {
+        return this.sdkInitHooks.reduce((opts, hook) => hook.sdkInit(opts), opts);
+    }
+
+    beforeCreateRequest(hookCtx: BeforeCreateRequestContext, input: RequestInput): RequestInput {
+        let inp = input;
+
+        for (const hook of this.beforeCreateRequestHooks) {
+            inp = hook.beforeCreateRequest(hookCtx, inp);
+        }
+
+        return inp;
+    }
+
+    async beforeRequest(hookCtx: BeforeRequestContext, request: Request): Promise<Request> {
+        let req = request;
+
+        for (const hook of this.beforeRequestHooks) {
+            req = await hook.beforeRequest(hookCtx, req);
+        }
+
+        return req;
+    }
+
+    async afterSuccess(hookCtx: AfterSuccessContext, response: Response): Promise<Response> {
+        let res = response;
+
+        for (const hook of this.afterSuccessHooks) {
+            res = await hook.afterSuccess(hookCtx, res);
+        }
+
+        return res;
+    }
+
+    async afterError(
+        hookCtx: AfterErrorContext,
+        response: Response | null,
+        error: unknown
+    ): Promise<{ response: Response | null; error: unknown }> {
+        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/src/hooks/index.ts

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

package/src/hooks/types.ts

@@ -0,0 +1,89 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { HTTPClient, RequestInput } from "../lib/http.js";
+
+export type HookContext = {
+    operationID: string;
+    oAuth2Scopes?: string[];
+    securitySource?: any | (() => Promise<any>);
+};
+
+export type Awaitable<T> = T | Promise<T>;
+
+export type SDKInitOptions = {
+    baseURL: URL | null;
+    client: HTTPClient;
+};
+
+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: SDKInitOptions) => SDKInitOptions;
+}
+
+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;
+}

package/src/index.ts

@@ -0,0 +1,6 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./sdk/sdk.js";
+export * from "./lib/config.js";

package/src/lib/base64.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export function bytesToBase64(u8arr: Uint8Array): string {
+  return btoa(String.fromCodePoint(...u8arr));
+}
+
+export function bytesFromBase64(encoded: string): Uint8Array {
+  return Uint8Array.from(atob(encoded), (c) => c.charCodeAt(0));
+}
+
+export function stringToBytes(str: string): Uint8Array {
+  return new TextEncoder().encode(str);
+}
+
+export function stringFromBytes(u8arr: Uint8Array): string {
+  return new TextDecoder().decode(u8arr);
+}
+
+export function stringToBase64(str: string): string {
+  return bytesToBase64(stringToBytes(str));
+}
+
+export function stringFromBase64(b64str: string): string {
+  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/src/lib/config.ts

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { HTTPClient } from "./http.js";
+import { Logger } from "./logger.js";
+import { RetryConfig } from "./retries.js";
+import { Params, 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",
+    /**
+     * Mock Server
+     */
+    "https://stoplight.io/mocks/tarkaikaman/ce-apis/217963442",
+] as const;
+
+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 function serverURLFromOptions(options: SDKOptions): URL | null {
+    let serverURL = options.serverURL;
+
+    const serverParams: Params[] = [
+        {
+            store_id: options.storeId ?? "x2yh61zw4k",
+        },
+        {
+            store_id: options.storeId ?? "x2yh61zw4k",
+        },
+        {},
+    ];
+    let params: 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.0.1",
+    genVersion: "2.404.2",
+    userAgent: "speakeasy-sdk/typescript 0.0.1 2.404.2 1.0 ce-storefront",
+} as const;

package/src/lib/dlv.ts

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