@decocms/apps-magento 8.1.0-next.1 → 8.1.0-next.2

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { createMagentoClient, type MagentoClient, type MagentoClientConfig, type MagentoClientOptions, MagentoError, type MagentoRequestInit, } from "./magentoClient.ts";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,mBAAmB,EACnB,KAAK,aAAa,EAClB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,YAAY,EACZ,KAAK,kBAAkB,GACxB,MAAM,oBAAoB,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+// `@decocms/apps-magento`: the thin Magento client (see /next/upstream-clients).
+export { createMagentoClient, MagentoError, } from "./magentoClient.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,iFAAiF;AACjF,OAAO,EACL,mBAAmB,EAInB,YAAY,GAEb,MAAM,oBAAoB,CAAC"}

package/dist/magentoClient.d.ts

@@ -0,0 +1,62 @@
+/**
+ * The Magento client: a thin client for a Magento store's REST and GraphQL
+ * APIs, over the framework's instrumented fetch (provider "magento"). See
+ * /next/upstream-clients.
+ *
+ * Configuration comes in as arguments; the site reads its environment (or a
+ * `secret` block) where it creates the client. Converters, hooks, cart and
+ * session flows, caching and feature toggles belong to the site (platform
+ * templates), not here.
+ */
+import { createInstrumentedFetch } from "@decocms/blocks/fetch";
+export interface MagentoClientConfig {
+    /** The store's origin, e.g. `https://store.example.com`. Every request goes here. */
+    baseUrl: string;
+    /** Integration access token, sent as `Authorization: Bearer` unless a call opts out. */
+    apiKey?: string;
+    /** Optional value sent as `x-origin-header`, for stores behind an origin guard. */
+    originHeader?: string;
+}
+export interface MagentoClientOptions {
+    /** The fetch underneath, e.g. a fake in tests. Defaults to `globalThis.fetch`. */
+    fetch?: Parameters<typeof createInstrumentedFetch>[0]["fetch"];
+}
+export interface MagentoRequestInit extends RequestInit {
+    /** The operation label, the API's own name for the call (e.g. `getCart`), never a URL. */
+    operation: string;
+    /**
+     * Send the `apiKey` bearer token. Default true for `request`/`rest`, false
+     * for `graphql`. Never replaces an `Authorization` header the call sets
+     * (e.g. a customer token).
+     */
+    authenticated?: boolean;
+}
+/** Thrown on a non-2xx response or a GraphQL `errors` payload. Never carries bodies or tokens. */
+export declare class MagentoError extends Error {
+    readonly operation: string;
+    readonly status: number;
+    /** How many GraphQL errors the response carried (0 for an HTTP failure). */
+    readonly graphqlErrors: number;
+    constructor(operation: string, status: number, 
+    /** How many GraphQL errors the response carried (0 for an HTTP failure). */
+    graphqlErrors?: number);
+}
+export type MagentoClient = ReturnType<typeof createMagentoClient>;
+export declare function createMagentoClient(config: MagentoClientConfig, options?: MagentoClientOptions): {
+    request: (path: string, init: MagentoRequestInit) => Promise<Response>;
+    /** A REST call (`/rest/<store>/V1/...`) returning its parsed JSON body. */
+    rest<T>(path: string, init: MagentoRequestInit): Promise<T>;
+    /**
+     * A GraphQL operation on `/graphql`. `operationName` is sent with the
+     * request and is the operation label. `headers` adds per-call headers,
+     * such as `Store` or a customer `Authorization` token. Storefront
+     * GraphQL is public, so the `apiKey` is sent only with
+     * `authenticated: true`, and never over a customer token.
+     */
+    graphql<TData, TVariables = Record<string, unknown>>(query: string, variables: TVariables | undefined, init: {
+        operationName: string;
+        headers?: Record<string, string>;
+        authenticated?: boolean;
+    }): Promise<TData>;
+};
+//# sourceMappingURL=magentoClient.d.ts.map

package/dist/magentoClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"magentoClient.d.ts","sourceRoot":"","sources":["../src/magentoClient.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAEhE,MAAM,WAAW,mBAAmB;IAClC,qFAAqF;IACrF,OAAO,EAAE,MAAM,CAAC;IAChB,wFAAwF;IACxF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mFAAmF;IACnF,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,oBAAoB;IACnC,kFAAkF;IAClF,KAAK,CAAC,EAAE,UAAU,CAAC,OAAO,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;CAChE;AAED,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD,0FAA0F;IAC1F,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,kGAAkG;AAClG,qBAAa,YAAa,SAAQ,KAAK;IAEnC,QAAQ,CAAC,SAAS,EAAE,MAAM;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,4EAA4E;IAC5E,QAAQ,CAAC,aAAa;IAJxB,YACW,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM;IACvB,4EAA4E;IACnE,aAAa,SAAI,EAQ3B;CACF;AAED,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEnE,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,mBAAmB,EAC3B,OAAO,GAAE,oBAAyB;oBAUL,MAAM,QAAQ,kBAAkB,KAAG,OAAO,CAAC,QAAQ,CAAC;IAiB/E,2EAA2E;SAChE,CAAC,QAAQ,MAAM,QAAQ,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;IAWjE;;;;;;OAMG;YACW,KAAK,EAAE,UAAU,mCACtB,MAAM,aACF,UAAU,GAAG,SAAS,QAC3B;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAAC,aAAa,CAAC,EAAE,OAAO,CAAA;KAAE,GACzF,OAAO,CAAC,KAAK,CAAC;EAoBpB"}

package/dist/magentoClient.js

@@ -0,0 +1,96 @@
+/**
+ * The Magento client: a thin client for a Magento store's REST and GraphQL
+ * APIs, over the framework's instrumented fetch (provider "magento"). See
+ * /next/upstream-clients.
+ *
+ * Configuration comes in as arguments; the site reads its environment (or a
+ * `secret` block) where it creates the client. Converters, hooks, cart and
+ * session flows, caching and feature toggles belong to the site (platform
+ * templates), not here.
+ */
+import { createInstrumentedFetch } from "@decocms/blocks/fetch";
+/** Thrown on a non-2xx response or a GraphQL `errors` payload. Never carries bodies or tokens. */
+export class MagentoError extends Error {
+    operation;
+    status;
+    graphqlErrors;
+    constructor(operation, status, 
+    /** How many GraphQL errors the response carried (0 for an HTTP failure). */
+    graphqlErrors = 0) {
+        super(graphqlErrors > 0
+            ? `magento ${operation} returned ${graphqlErrors} GraphQL error(s)`
+            : `magento ${operation} failed with HTTP ${status}`);
+        this.operation = operation;
+        this.status = status;
+        this.graphqlErrors = graphqlErrors;
+        this.name = "MagentoError";
+    }
+}
+export function createMagentoClient(config, options = {}) {
+    const instrumented = createInstrumentedFetch({ provider: "magento", fetch: options.fetch });
+    const origin = new URL(config.baseUrl).origin;
+    /**
+     * A request to a path on the store, e.g. `/rest/default/V1/carts/mine` or
+     * `/customer/section/load`, returning the raw response. Paths only: the
+     * store's credentials never go to another origin.
+     */
+    async function request(path, init) {
+        const { operation, authenticated = true, ...rest } = init;
+        const url = new URL(path, origin);
+        if (url.origin !== origin) {
+            throw new Error(`magento ${operation}: only paths on the configured store are allowed`);
+        }
+        const headers = new Headers(rest.headers);
+        if (authenticated && config.apiKey && !headers.has("authorization")) {
+            headers.set("authorization", `Bearer ${config.apiKey}`);
+        }
+        if (config.originHeader)
+            headers.set("x-origin-header", config.originHeader);
+        return instrumented(url, { ...rest, headers, operation });
+    }
+    return {
+        request,
+        /** A REST call (`/rest/<store>/V1/...`) returning its parsed JSON body. */
+        async rest(path, init) {
+            const headers = new Headers(init.headers);
+            if (init.body !== undefined && !headers.has("content-type")) {
+                headers.set("content-type", "application/json");
+            }
+            const response = await request(path, { ...init, headers });
+            if (!response.ok)
+                throw new MagentoError(init.operation, response.status);
+            if (response.status === 204)
+                return undefined;
+            return (await response.json());
+        },
+        /**
+         * A GraphQL operation on `/graphql`. `operationName` is sent with the
+         * request and is the operation label. `headers` adds per-call headers,
+         * such as `Store` or a customer `Authorization` token. Storefront
+         * GraphQL is public, so the `apiKey` is sent only with
+         * `authenticated: true`, and never over a customer token.
+         */
+        async graphql(query, variables, init) {
+            const { operationName, ...rest } = init;
+            const headers = new Headers(rest.headers);
+            headers.set("content-type", "application/json");
+            const response = await request("/graphql", {
+                operation: operationName,
+                authenticated: rest.authenticated ?? false,
+                method: "POST",
+                headers,
+                body: JSON.stringify({ query, variables, operationName }),
+            });
+            if (!response.ok)
+                throw new MagentoError(operationName, response.status);
+            const body = (await response.json());
+            if (body.errors?.length) {
+                throw new MagentoError(operationName, response.status, body.errors.length);
+            }
+            if (body.data === undefined)
+                throw new MagentoError(operationName, response.status);
+            return body.data;
+        },
+    };
+}
+//# sourceMappingURL=magentoClient.js.map

package/dist/magentoClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"magentoClient.js","sourceRoot":"","sources":["../src/magentoClient.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AA2BhE,kGAAkG;AAClG,MAAM,OAAO,YAAa,SAAQ,KAAK;IAE1B,SAAS;IACT,MAAM;IAEN,aAAa;IAJxB,YACW,SAAiB,EACjB,MAAc;IACvB,4EAA4E;IACnE,aAAa,GAAG,CAAC;QAE1B,KAAK,CACH,aAAa,GAAG,CAAC;YACf,CAAC,CAAC,WAAW,SAAS,aAAa,aAAa,mBAAmB;YACnE,CAAC,CAAC,WAAW,SAAS,qBAAqB,MAAM,EAAE,CACtD,CAAC;yBATO,SAAS;sBACT,MAAM;6BAEN,aAAa;QAOtB,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;IAC7B,CAAC;CACF;AAID,MAAM,UAAU,mBAAmB,CACjC,MAA2B,EAC3B,OAAO,GAAyB,EAAE;IAElC,MAAM,YAAY,GAAG,uBAAuB,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;IAC5F,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;IAE9C;;;;OAIG;IACH,KAAK,UAAU,OAAO,CAAC,IAAY,EAAE,IAAwB;QAC3D,MAAM,EAAE,SAAS,EAAE,aAAa,GAAG,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QAC1D,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAClC,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,WAAW,SAAS,kDAAkD,CAAC,CAAC;QAC1F,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,IAAI,aAAa,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC;YACpE,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,MAAM,CAAC,YAAY;YAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC;QAC7E,OAAO,YAAY,CAAC,GAAG,EAAE,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO;QACL,OAAO;QAEP,2EAA2E;QAC3E,KAAK,CAAC,IAAI,CAAI,IAAY,EAAE,IAAwB;YAClD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC1C,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC;gBAC5D,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;YAClD,CAAC;YACD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,IAAI,EAAE,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;YAC3D,IAAI,CAAC,QAAQ,CAAC,EAAE;gBAAE,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC1E,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;gBAAE,OAAO,SAAc,CAAC;YACnD,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,CAAC;QACtC,CAAC;QAED;;;;;;WAMG;QACH,KAAK,CAAC,OAAO,CACX,KAAa,EACb,SAAiC,EACjC,IAA0F;YAE1F,MAAM,EAAE,aAAa,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;YACxC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC1C,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;YAChD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,UAAU,EAAE;gBACzC,SAAS,EAAE,aAAa;gBACxB,aAAa,EAAE,IAAI,CAAC,aAAa,IAAI,KAAK;gBAC1C,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC;aAC1D,CAAC,CAAC;YACH,IAAI,CAAC,QAAQ,CAAC,EAAE;gBAAE,MAAM,IAAI,YAAY,CAAC,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;YACzE,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAyC,CAAC;YAC7E,IAAI,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;gBACxB,MAAM,IAAI,YAAY,CAAC,aAAa,EAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAC7E,CAAC;YACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS;gBAAE,MAAM,IAAI,YAAY,CAAC,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;YACpF,OAAO,IAAI,CAAC,IAAI,CAAC;QACnB,CAAC;KACF,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decocms/apps-magento",
-  "version": "8.1.0-next.1",
+  "version": "8.1.0-next.2",
   "type": "module",
   "description": "Thin Magento (Adobe Commerce) API client for Deco sites",
   "repository": {
@@ -9,24 +9,28 @@
     "directory": "packages/apps-magento"
   },
   "files": [
+    "dist",
     "src",
     "!src/**/*.test.ts",
     "!src/**/__tests__"
   ],
-  "main": "./src/index.ts",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
-    ".": "./src/index.ts"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "source": "./src/index.ts",
+      "default": "./dist/index.js"
+    }
   },
   "scripts": {
-    "build": "tsc",
+    "build": "node ../../scripts/tsc.mjs --clean dist -p tsconfig.build.json",
+    "prepack": "npm run build",
     "test": "vitest run --root ../.. packages/apps-magento/",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "node ../../scripts/tsc.mjs -p tsconfig.json"
   },
   "dependencies": {
-    "@decocms/blocks": "8.1.0-next.1"
-  },
-  "devDependencies": {
-    "typescript": "^5.9.0"
+    "@decocms/blocks": "8.1.0-next.2"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org",

package/src/index.ts

@@ -6,4 +6,4 @@ export {
   type MagentoClientOptions,
   MagentoError,
   type MagentoRequestInit,
-} from "./magentoClient";
+} from "./magentoClient.ts";