@sovecom/client-js 1.0.0-rc.1

package/dist/client.d.ts

@@ -0,0 +1,71 @@
+/**
+ * @sovecom/client-js — thin typed fetch wrapper over the OpenAPI-generated `paths`.
+ *
+ * No runtime dependency beyond the platform `fetch`. The generated spec (Zod DTOs via nestjs-zod)
+ * types request path/query/header params and bodies, but does not carry response body schemas, so
+ * `request()` returns a caller-supplied generic (default `unknown`). Auth is layered as headers:
+ * a customer bearer (via `getToken`), the cart cookie token, and the guest-order `X-Order-Token`
+ * (never in the URL).
+ */
+import type { paths } from './generated/api.js';
+export type HttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete';
+/** Paths in the spec that define operation `M` (e.g. every path with a `post`). */
+export type PathFor<M extends HttpMethod> = {
+    [P in keyof paths]: paths[P] extends Record<M, infer O> ? [O] extends [never] ? never : O extends undefined ? never : P : never;
+}[keyof paths];
+type Op<P extends keyof paths, M extends HttpMethod> = M extends keyof paths[P] ? paths[P][M] : never;
+type ParamsOf<O> = O extends {
+    parameters: infer Pr;
+} ? Pr : Record<never, never>;
+type PathParamsOf<O> = ParamsOf<O> extends {
+    path: infer X;
+} ? (X extends undefined | never ? never : X) : never;
+type QueryOf<O> = ParamsOf<O> extends {
+    query?: infer X;
+} ? (X extends undefined | never ? never : X) : never;
+type HeaderOf<O> = ParamsOf<O> extends {
+    header?: infer X;
+} ? (X extends undefined | never ? never : X) : never;
+type BodyOf<O> = O extends {
+    requestBody?: infer R;
+} ? R extends {
+    content: {
+        'application/json': infer B;
+    };
+} ? B : never : never;
+/** Present a key in the options object only when the operation actually defines it. */
+type Opt<K extends string, V> = [V] extends [never] ? Record<never, never> : {
+    [P in K]: V;
+};
+export type RequestOptions<P extends keyof paths, M extends HttpMethod> = Opt<'path', PathParamsOf<Op<P, M>>> & Opt<'query', QueryOf<Op<P, M>>> & Opt<'headers', HeaderOf<Op<P, M>>> & Opt<'body', BodyOf<Op<P, M>>> & {
+    /** A per-request signal for cancellation/timeouts. */
+    signal?: AbortSignal;
+};
+export interface SovEcomClientOptions {
+    /** API origin, e.g. `https://api.example.com` (no trailing slash required). */
+    baseUrl: string;
+    /** Returns the customer bearer token (JWT) to send as `Authorization`, if any. Sync or async. */
+    getToken?: () => string | undefined | null | Promise<string | undefined | null>;
+    /** Default headers merged into every request (e.g. a cart token your app manages). */
+    headers?: Record<string, string>;
+    /** Override the fetch implementation (tests, non-browser runtimes). Defaults to global `fetch`. */
+    fetch?: typeof fetch;
+}
+/** Thrown for any non-2xx response. Carries the status + parsed body (never a secret in the URL). */
+export declare class SovEcomApiError extends Error {
+    readonly status: number;
+    readonly statusText: string;
+    readonly body: unknown;
+    constructor(status: number, statusText: string, body: unknown);
+}
+export interface SovEcomClient {
+    /** Low-level typed request. `TResponse` defaults to `unknown` (the spec carries no response bodies). */
+    request<P extends PathFor<M>, M extends HttpMethod, TResponse = unknown>(method: M, path: P, options?: RequestOptions<P, M>): Promise<TResponse>;
+    /** Create an order from a cart (cart cookie token must be supplied via `headers`/`getToken`). */
+    checkout<TResponse = unknown>(cartId: string): Promise<TResponse>;
+    /** Guest order lookup — the token travels in the `X-Order-Token` header, never the URL. */
+    getOrderByNumber<TResponse = unknown>(orderNumber: string, orderToken: string): Promise<TResponse>;
+}
+export declare function createSovEcomClient(options: SovEcomClientOptions): SovEcomClient;
+export {};
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAEhD,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AAErE,mFAAmF;AACnF,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,UAAU,IAAI;KACzC,CAAC,IAAI,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GACnD,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACjB,KAAK,GACL,CAAC,SAAS,SAAS,GACjB,KAAK,GACL,CAAC,GACL,KAAK;CACV,CAAC,MAAM,KAAK,CAAC,CAAC;AAEf,KAAK,EAAE,CAAC,CAAC,SAAS,MAAM,KAAK,EAAE,CAAC,SAAS,UAAU,IAAI,CAAC,SAAS,MAAM,KAAK,CAAC,CAAC,CAAC,GAC3E,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACX,KAAK,CAAC;AAEV,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,UAAU,EAAE,MAAM,EAAE,CAAA;CAAE,GAAG,EAAE,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAClF,KAAK,YAAY,CAAC,CAAC,IACjB,QAAQ,CAAC,CAAC,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,KAAK,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC;AAC5F,KAAK,OAAO,CAAC,CAAC,IACZ,QAAQ,CAAC,CAAC,CAAC,SAAS;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,KAAK,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC;AAC9F,KAAK,QAAQ,CAAC,CAAC,IACb,QAAQ,CAAC,CAAC,CAAC,SAAS;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,KAAK,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC;AAG/F,KAAK,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,WAAW,CAAC,EAAE,MAAM,CAAC,CAAA;CAAE,GAChD,CAAC,SAAS;IAAE,OAAO,EAAE;QAAE,kBAAkB,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GACpD,CAAC,GACD,KAAK,GACP,KAAK,CAAC;AAEV,uFAAuF;AACvF,KAAK,GAAG,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG;KAAG,CAAC,IAAI,CAAC,GAAG,CAAC;CAAE,CAAC;AAE7F,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,MAAM,KAAK,EAAE,CAAC,SAAS,UAAU,IAAI,GAAG,CAC3E,MAAM,EACN,YAAY,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CACvB,GACC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAC/B,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAClC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG;IAC9B,sDAAsD;IACtD,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEJ,MAAM,WAAW,oBAAoB;IACnC,+EAA+E;IAC/E,OAAO,EAAE,MAAM,CAAC;IAChB,iGAAiG;IACjG,QAAQ,CAAC,EAAE,MAAM,MAAM,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC,CAAC;IAChF,sFAAsF;IACtF,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,mGAAmG;IACnG,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;CACtB;AAED,qGAAqG;AACrG,qBAAa,eAAgB,SAAQ,KAAK;IAEtC,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,QAAQ,CAAC,UAAU,EAAE,MAAM;IAC3B,QAAQ,CAAC,IAAI,EAAE,OAAO;gBAFb,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,OAAO;CAKzB;AA2BD,MAAM,WAAW,aAAa;IAC5B,wGAAwG;IACxG,OAAO,CAAC,CAAC,SAAS,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,UAAU,EAAE,SAAS,GAAG,OAAO,EACrE,MAAM,EAAE,CAAC,EACT,IAAI,EAAE,CAAC,EACP,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,GAC7B,OAAO,CAAC,SAAS,CAAC,CAAC;IACtB,iGAAiG;IACjG,QAAQ,CAAC,SAAS,GAAG,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAClE,2FAA2F;IAC3F,gBAAgB,CAAC,SAAS,GAAG,OAAO,EAClC,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,SAAS,CAAC,CAAC;CACvB;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,oBAAoB,GAAG,aAAa,CA6EhF"}

package/dist/client.js

@@ -0,0 +1,102 @@
+/** Thrown for any non-2xx response. Carries the status + parsed body (never a secret in the URL). */
+export class SovEcomApiError extends Error {
+    status;
+    statusText;
+    body;
+    constructor(status, statusText, body) {
+        super(`SovEcom API ${status} ${statusText}`);
+        this.status = status;
+        this.statusText = statusText;
+        this.body = body;
+        this.name = 'SovEcomApiError';
+    }
+}
+function fillPath(path, params) {
+    return path.replace(/\{([^}]+)\}/g, (_m, key) => {
+        const value = params?.[key];
+        if (value === undefined || value === null) {
+            throw new Error(`Missing path parameter "${key}" for ${path}`);
+        }
+        return encodeURIComponent(String(value));
+    });
+}
+function buildQuery(query) {
+    if (!query)
+        return '';
+    const usp = new URLSearchParams();
+    for (const [key, value] of Object.entries(query)) {
+        if (value === undefined || value === null)
+            continue;
+        if (Array.isArray(value)) {
+            for (const v of value)
+                usp.append(key, String(v));
+        }
+        else {
+            usp.append(key, String(value));
+        }
+    }
+    const qs = usp.toString();
+    return qs ? `?${qs}` : '';
+}
+export function createSovEcomClient(options) {
+    const baseUrl = options.baseUrl.replace(/\/+$/, '');
+    const doFetch = options.fetch ?? globalThis.fetch;
+    if (typeof doFetch !== 'function') {
+        throw new Error('No fetch implementation available; pass `fetch` in SovEcomClientOptions.');
+    }
+    async function request(method, path, opts) {
+        const o = (opts ?? {});
+        const url = `${baseUrl}${fillPath(path, o.path)}${buildQuery(o.query)}`;
+        // A `Headers` instance is case-INSENSITIVE, so a caller-supplied `content-type` /
+        // `authorization` (any casing) is recognised rather than silently duplicated. Per-request
+        // headers override the client defaults; an explicit caller `Authorization` is NOT clobbered
+        // by `getToken` (the bearer only fills in when the caller didn't set one).
+        const headers = new Headers(options.headers);
+        if (o.headers) {
+            for (const [k, v] of Object.entries(o.headers))
+                headers.set(k, v);
+        }
+        const token = options.getToken ? await options.getToken() : undefined;
+        if (token && !headers.has('authorization'))
+            headers.set('authorization', `Bearer ${token}`);
+        const hasBody = o.body !== undefined;
+        if (hasBody && !headers.has('content-type'))
+            headers.set('content-type', 'application/json');
+        const res = await doFetch(url, {
+            method: method.toUpperCase(),
+            headers,
+            body: hasBody ? JSON.stringify(o.body) : undefined,
+            signal: o.signal,
+        });
+        const text = await res.text();
+        const parsed = text ? safeJson(text) : undefined;
+        if (!res.ok) {
+            throw new SovEcomApiError(res.status, res.statusText, parsed);
+        }
+        return parsed;
+    }
+    return {
+        request,
+        // NB: these convenience methods pass UNCAST option objects on purpose — if the spec drifts
+        // (a path/param/header renamed), regeneration changes `paths` and these stop compiling, which
+        // (with the CI regen-diff guard) surfaces the drift instead of silently sending a wrong request.
+        checkout(cartId) {
+            return request('post', '/store/v1/carts/{cartId}/checkout', { path: { cartId } });
+        },
+        getOrderByNumber(orderNumber, orderToken) {
+            return request('get', '/store/v1/orders/by-number/{orderNumber}', {
+                path: { orderNumber },
+                headers: { 'x-order-token': orderToken },
+            });
+        },
+    };
+}
+function safeJson(text) {
+    try {
+        return JSON.parse(text);
+    }
+    catch {
+        return text;
+    }
+}
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAoEA,qGAAqG;AACrG,MAAM,OAAO,eAAgB,SAAQ,KAAK;IAE7B;IACA;IACA;IAHX,YACW,MAAc,EACd,UAAkB,EAClB,IAAa;QAEtB,KAAK,CAAC,eAAe,MAAM,IAAI,UAAU,EAAE,CAAC,CAAC;QAJpC,WAAM,GAAN,MAAM,CAAQ;QACd,eAAU,GAAV,UAAU,CAAQ;QAClB,SAAI,GAAJ,IAAI,CAAS;QAGtB,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;IAChC,CAAC;CACF;AAED,SAAS,QAAQ,CAAC,IAAY,EAAE,MAA2C;IACzE,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,EAAE,EAAE,GAAW,EAAE,EAAE;QACtD,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YAC1C,MAAM,IAAI,KAAK,CAAC,2BAA2B,GAAG,SAAS,IAAI,EAAE,CAAC,CAAC;QACjE,CAAC;QACD,OAAO,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,UAAU,CAAC,KAA0C;IAC5D,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC;IACtB,MAAM,GAAG,GAAG,IAAI,eAAe,EAAE,CAAC;IAClC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACjD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;YAAE,SAAS;QACpD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,KAAK,MAAM,CAAC,IAAI,KAAK;gBAAE,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACpD,CAAC;aAAM,CAAC;YACN,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IACD,MAAM,EAAE,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC;IAC1B,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AAC5B,CAAC;AAkBD,MAAM,UAAU,mBAAmB,CAAC,OAA6B;IAC/D,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACpD,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC;IAClD,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,0EAA0E,CAAC,CAAC;IAC9F,CAAC;IAED,KAAK,UAAU,OAAO,CACpB,MAAS,EACT,IAAO,EACP,IAA2B;QAE3B,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAMpB,CAAC;QAEF,MAAM,GAAG,GAAG,GAAG,OAAO,GAAG,QAAQ,CAAC,IAAc,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;QAElF,kFAAkF;QAClF,0FAA0F;QAC1F,4FAA4F;QAC5F,2EAA2E;QAC3E,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;YACd,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC;gBAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACpE,CAAC;QACD,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACtE,IAAI,KAAK,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;YAAE,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,KAAK,EAAE,CAAC,CAAC;QAE5F,MAAM,OAAO,GAAG,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC;QACrC,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;YAAE,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAE7F,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE;YAC7B,MAAM,EAAE,MAAM,CAAC,WAAW,EAAE;YAC5B,OAAO;YACP,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;YAClD,MAAM,EAAE,CAAC,CAAC,MAAM;SACjB,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAC9B,MAAM,MAAM,GAAY,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1D,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,MAAM,IAAI,eAAe,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,MAAmB,CAAC;IAC7B,CAAC;IAED,OAAO;QACL,OAAO;QACP,2FAA2F;QAC3F,8FAA8F;QAC9F,iGAAiG;QACjG,QAAQ,CAAsB,MAAc;YAC1C,OAAO,OAAO,CACZ,MAAM,EACN,mCAAmC,EACnC,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,CACrB,CAAC;QACJ,CAAC;QACD,gBAAgB,CACd,WAAmB,EACnB,UAAkB;YAElB,OAAO,OAAO,CACZ,KAAK,EACL,0CAA0C,EAC1C;gBACE,IAAI,EAAE,EAAE,WAAW,EAAE;gBACrB,OAAO,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;aACzC,CACF,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,IAAY;IAC5B,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC"}