shopify_storefront_sdk 1.0.3 → 2.0.0

package/dist/utils/pagination.d.ts

@@ -0,0 +1,20 @@
+export interface PageInfo {
+    hasNextPage: boolean;
+    endCursor?: string | null;
+}
+export interface Edge<TNode> {
+    node: TNode;
+}
+export interface Connection<TNode> {
+    edges: Edge<TNode>[];
+    pageInfo: PageInfo;
+}
+/**
+ * Automatically fetches all pages of a Shopify GraphQL Connection and flattens the nodes into an array.
+ *
+ * @param fetchPage A function that takes an optional cursor and returns a promise of the API response.
+ * @param getConnection A selector function that extracts the Connection object from the API response.
+ * @returns A flat array of all nodes across all pages.
+ */
+export declare function autoPaginate<TResponse, TNode>(fetchPage: (cursor?: string) => Promise<TResponse>, getConnection: (response: TResponse) => Connection<TNode> | undefined | null): Promise<TNode[]>;
+//# sourceMappingURL=pagination.d.ts.map

package/dist/utils/pagination.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["../../src/utils/pagination.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,QAAQ;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,IAAI,CAAC,KAAK;IACzB,IAAI,EAAE,KAAK,CAAC;CACb;AAED,MAAM,WAAW,UAAU,CAAC,KAAK;IAC/B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;IACrB,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED;;;;;;GAMG;AACH,wBAAsB,YAAY,CAAC,SAAS,EAAE,KAAK,EACjD,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,SAAS,CAAC,EAClD,aAAa,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,UAAU,CAAC,KAAK,CAAC,GAAG,SAAS,GAAG,IAAI,GAC3E,OAAO,CAAC,KAAK,EAAE,CAAC,CAwBlB"}

package/dist/utils/pagination.js

@@ -0,0 +1,28 @@
+/**
+ * Automatically fetches all pages of a Shopify GraphQL Connection and flattens the nodes into an array.
+ *
+ * @param fetchPage A function that takes an optional cursor and returns a promise of the API response.
+ * @param getConnection A selector function that extracts the Connection object from the API response.
+ * @returns A flat array of all nodes across all pages.
+ */
+export async function autoPaginate(fetchPage, getConnection) {
+    const results = [];
+    let hasNextPage = true;
+    let cursor = undefined;
+    while (hasNextPage) {
+        const response = await fetchPage(cursor);
+        const connection = getConnection(response);
+        if (!connection || !connection.edges || !connection.pageInfo) {
+            break;
+        }
+        for (const edge of connection.edges) {
+            if (edge && edge.node) {
+                results.push(edge.node);
+            }
+        }
+        hasNextPage = connection.pageInfo.hasNextPage;
+        cursor = connection.pageInfo.endCursor || undefined;
+    }
+    return results;
+}
+//# sourceMappingURL=pagination.js.map

package/dist/utils/pagination.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.js","sourceRoot":"","sources":["../../src/utils/pagination.ts"],"names":[],"mappings":"AAcA;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,SAAkD,EAClD,aAA4E;IAE5E,MAAM,OAAO,GAAY,EAAE,CAAC;IAC5B,IAAI,WAAW,GAAG,IAAI,CAAC;IACvB,IAAI,MAAM,GAAuB,SAAS,CAAC;IAE3C,OAAO,WAAW,EAAE,CAAC;QACnB,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC;QACzC,MAAM,UAAU,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;QAE3C,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;YAC7D,MAAM;QACR,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;YACpC,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACtB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC;QAED,WAAW,GAAG,UAAU,CAAC,QAAQ,CAAC,WAAW,CAAC;QAC9C,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC,SAAS,IAAI,SAAS,CAAC;IACtD,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/utils/webhooks.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Verifies a Shopify webhook's HMAC signature.
+ *
+ * @param rawBody The raw, unparsed request body string or buffer.
+ * @param hmacHeader The `x-shopify-hmac-sha256` header provided by Shopify.
+ * @param secret Your Shopify app or storefront webhook API secret.
+ * @returns A boolean indicating whether the webhook signature is valid.
+ */
+export declare function verifyWebhook(rawBody: string | Buffer, hmacHeader: string, secret: string): boolean;
+//# sourceMappingURL=webhooks.d.ts.map

package/dist/utils/webhooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.d.ts","sourceRoot":"","sources":["../../src/utils/webhooks.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAuBnG"}

package/dist/utils/webhooks.js

@@ -0,0 +1,31 @@
+import * as crypto from "node:crypto";
+/**
+ * Verifies a Shopify webhook's HMAC signature.
+ *
+ * @param rawBody The raw, unparsed request body string or buffer.
+ * @param hmacHeader The `x-shopify-hmac-sha256` header provided by Shopify.
+ * @param secret Your Shopify app or storefront webhook API secret.
+ * @returns A boolean indicating whether the webhook signature is valid.
+ */
+export function verifyWebhook(rawBody, hmacHeader, secret) {
+    if (!rawBody || !hmacHeader || !secret) {
+        return false;
+    }
+    try {
+        const generatedHash = crypto
+            .createHmac("sha256", secret)
+            .update(rawBody)
+            .digest("base64");
+        const generatedBuffer = Buffer.from(generatedHash);
+        const hmacBuffer = Buffer.from(hmacHeader);
+        // Use timingSafeEqual to prevent timing attacks
+        if (generatedBuffer.length !== hmacBuffer.length) {
+            return false;
+        }
+        return crypto.timingSafeEqual(generatedBuffer, hmacBuffer);
+    }
+    catch (err) {
+        return false;
+    }
+}
+//# sourceMappingURL=webhooks.js.map

package/dist/utils/webhooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../../src/utils/webhooks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AAEtC;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,OAAwB,EAAE,UAAkB,EAAE,MAAc;IACxF,IAAI,CAAC,OAAO,IAAI,CAAC,UAAU,IAAI,CAAC,MAAM,EAAE,CAAC;QACvC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC;QACH,MAAM,aAAa,GAAG,MAAM;aACzB,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC;aAC5B,MAAM,CAAC,OAAO,CAAC;aACf,MAAM,CAAC,QAAQ,CAAC,CAAC;QAEpB,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACnD,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE3C,gDAAgD;QAChD,IAAI,eAAe,CAAC,MAAM,KAAK,UAAU,CAAC,MAAM,EAAE,CAAC;YACjD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,MAAM,CAAC,eAAe,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;IAC7D,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shopify_storefront_sdk",
-  "version": "1.0.3",
+  "version": "2.0.0",
   "main": "cjs-wrapper.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -22,12 +22,14 @@
   "sideEffects": false,
   "scripts": {
     "clean": "rimraf dist",
-    "dev": "node --loader ts-node/esm src/tests/test.ts",
+    "dev": "node --loader ts-node/esm src/tests/integration/sdk.test.ts",
     "build": "rimraf dist && npm run build:esm && npm run build:cjs",
     "build:esm": "tsc --project tsconfig.json",
     "build:cjs": "tsc --project tsconfig.cjs.json",
-    "dev:test": "node --loader ts-node/esm src/tests/test.ts",
-    "test": "node dist/tests/test.js",
+    "build:docs": "typedoc --plugin typedoc-plugin-markdown --out docs src/index.ts",
+    "test": "vitest run",
+    "test:unit": "vitest run src/tests/unit",
+    "test:integration": "vitest run src/tests/integration",
     "codegen": "graphql-codegen --config codegen.yml",
     "prepare": "npm run build"
   },
@@ -58,10 +60,12 @@
     "@graphql-codegen/typescript": "^5.0.5",
     "@graphql-codegen/typescript-graphql-request": "^6.3.0",
     "@graphql-codegen/typescript-operations": "^5.0.5",
-    "@types/node": "^24.10.1",
-    "axios": "^1.13.2",
+    "@types/node": "^24.13.3",
     "ts-node": "^10.9.2",
-    "typescript": "^5.9.3"
+    "typedoc": "^0.28.20",
+    "typedoc-plugin-markdown": "^4.13.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.11"
   },
   "dependencies": {
     "dotenv": "^17.2.3",

package/dist/cjs/client/client.d.ts

@@ -1,9 +0,0 @@
-import type { StoreConfig } from "../utils/config.js";
-declare class ShopifyClient {
-    private endpoint;
-    private token;
-    constructor({ storeUrl, storefrontToken }: StoreConfig);
-    query<T = any>(query: string, variables?: {}): Promise<T>;
-}
-export default ShopifyClient;
-//# sourceMappingURL=client.d.ts.map

package/dist/cjs/client/client.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/client/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGtD,cAAM,aAAa;IACjB,OAAO,CAAC,QAAQ,CAAC;IACjB,OAAO,CAAC,KAAK,CAAC;gBACF,EAAE,QAAQ,EAAE,eAAe,EAAE,EAAE,WAAW;IAQhD,KAAK,CAAC,CAAC,GAAG,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC;CAsBhE;AAED,eAAe,aAAa,CAAC"}

package/dist/cjs/client/client.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/client/client.ts"],"names":[],"mappings":";;AACA,iCAA0B;AAE1B,MAAM,aAAa;IAGjB,YAAY,EAAE,QAAQ,EAAE,eAAe,EAAe;QACpD,IAAI,CAAC,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,QAAQ,CAAC,gBAAgB,CAAC,CAAA,EAAE,CAAC;YAC1C,MAAM,IAAI,KAAK,CAAC,iBAAiB,QAAQ,8BAA8B,CAAC,CAAC;QAC3E,CAAC;QACD,CAAC,IAAI,CAAC,QAAQ,GAAG,WAAW,QAAQ,2BAA2B,CAAC;YAC9D,CAAC,IAAI,CAAC,KAAK,GAAG,eAAe,CAAC,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,KAAK,CAAU,KAAa,EAAE,SAAS,GAAG,EAAE;;QAChD,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,eAAK,CAAC,IAAI,CAC1B,IAAI,CAAC,QAAQ,EACb;gBACE,KAAK;gBACL,SAAS;aACV,EACD;gBACE,OAAO,EAAE;oBACP,mCAAmC,EAAE,IAAI,CAAC,KAAK;oBAC/C,cAAc,EAAE,kBAAkB;iBACnC;aACF,CACF,CAAC;YACF,IAAI,MAAA,GAAG,CAAC,IAAI,0CAAE,MAAM;gBAClB,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YAC5D,OAAO,MAAA,GAAG,CAAC,IAAI,0CAAE,IAAI,CAAC;QACxB,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,kBAAkB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;CACF;AAED,kBAAe,aAAa,CAAC"}