shopify-webhook-schemas 0.2.7 → 0.2.8

package/dist/src/scrape.js

@@ -3,15 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const cheerio_1 = __importDefault(require("cheerio"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const globby_1 = require("globby");
-const got_1 = __importDefault(require("got"));
-const lodash_1 = require("lodash");
 const chalk_1 = __importDefault(require("chalk"));
 const path_1 = __importDefault(require("path"));
 const src_1 = require("src");
-const shopify_js_1 = require("./shopify.js");
 const infer_schema_1 = require("./infer-schema");
 function assert(value, message) {
     if (!value) {
@@ -19,48 +15,8 @@ function assert(value, message) {
     }
     return value;
 }
-/**
- * This script fetches shopify's docs for all their webhook topics, and dumps json schemas for each topic inferred from the example payloads
- */
-const loadRailsData = async (url) => {
-    const shopifyDocsSource = await (0, got_1.default)(url);
-    const $ = cheerio_1.default.load(shopifyDocsSource.body);
-    const jsonScriptTag = $("script")
-        .toArray()
-        .find((script) => $(script).html()?.includes("window.RailsData"));
-    const compressedScriptTag = $("script")
-        .toArray()
-        .find((script) => $(script).html()?.includes("rails_data"));
-    if (jsonScriptTag) {
-        const scriptText = $(jsonScriptTag).html();
-        const jsonMatch = scriptText.match(/window\.RailsData = (\{[\s\S]*?\}\s*)\/\/\]\]/m);
-        if (!jsonMatch) {
-            throw new Error("RailsData object literal is in an unexpected format");
-        }
-        return JSON.parse(jsonMatch[1]);
-    }
-    else if (compressedScriptTag) {
-        const scriptText = $(compressedScriptTag).html();
-        const jsonMatch = scriptText.match(/window.__reactRouterContext.streamController.enqueue\(([\s\S]*)\)/);
-        if (!jsonMatch) {
-            throw new Error("RailsData object literal not found in script tag or is in an unexpected format");
-        }
-        const data = jsonMatch[1].replace("\\\n", "");
-        const encoder = new TextEncoderStream();
-        const readableStream = new ReadableStream({
-            start(c) {
-                c.enqueue(JSON.parse(data));
-                c.close();
-            },
-        }).pipeThrough(encoder);
-        const result = await (0, shopify_js_1.startDecoding)(readableStream);
-        return result.value.loaderData["./routes/rest"].rails_data;
-    }
-    else {
-        throw new Error("expected to find rails_data or window.RailsData script in shopify source but couldn't");
-    }
-};
-const docsWebhooksPageForVersion = (version) => `https://shopify.dev/docs/api/admin-rest/${version}/resources/webhook#event-topics`;
+const dataUrl = "https://shopify.dev/docs/api/webhooks.data";
+const dataUrlForVersion = (version) => `https://shopify.dev/docs/api/webhooks/${version}.data`;
 let warnings = 0;
 let errors = 0;
 const loadExemplars = async () => {
@@ -75,33 +31,123 @@ const loadExemplars = async () => {
     }
     console.log(`loaded ${files.length} exemplars`);
 };
+const loadDataFromUrl = async (url) => {
+    const res = await fetch(url, { headers: { accept: "application/json" } });
+    if (!res.ok) {
+        console.error(`Failed to fetch ${url}: ${res.status} ${res.statusText}`);
+        process.exit(1);
+    }
+    const flat = await res.json();
+    return inflateShopifyData(flat);
+};
+const inflateShopifyData = (flat) => {
+    const cache = new Map();
+    const fromIndex = (i) => {
+        if (!Number.isInteger(i)) {
+            return i;
+        }
+        if (cache.has(i))
+            return cache.get(i);
+        const val = flat[i];
+        const out = deref(val);
+        cache.set(i, out);
+        return out;
+    };
+    const deref = (x) => {
+        if (typeof x === "number") {
+            return fromIndex(x);
+        }
+        if (Array.isArray(x)) {
+            return x.map(deref);
+        }
+        if (x && typeof x === "object") {
+            const out = {};
+            for (const [k, v] of Object.entries(x)) {
+                if (k.startsWith("_")) {
+                    const keyIdx = Number(k.slice(1));
+                    const key = fromIndex(keyIdx);
+                    out[key] = deref(v);
+                }
+                else {
+                    out[k] = deref(v);
+                }
+            }
+            return out;
+        }
+        return x;
+    };
+    return fromIndex(0);
+};
+const findFirstByPredicate = (node, predicate) => {
+    if (node && typeof node === "object") {
+        if (Array.isArray(node)) {
+            for (const child of node) {
+                const result = findFirstByPredicate(child, predicate);
+                if (result !== null)
+                    return result;
+            }
+        }
+        else {
+            if (predicate(node)) {
+                return node;
+            }
+            for (const value of Object.values(node)) {
+                const result = findFirstByPredicate(value, predicate);
+                if (result !== null)
+                    return result;
+            }
+        }
+    }
+    return null;
+};
+const findFirstByKey = (node, keyName) => {
+    return findFirstByPredicate(node, (node) => Object.prototype.hasOwnProperty.call(node, keyName))?.[keyName];
+};
 const getAllVersions = async () => {
-    const startVersion = (0, infer_schema_1.getStartVersion)();
-    const rootPage = await loadRailsData(docsWebhooksPageForVersion(startVersion));
-    return (0, lodash_1.uniq)([startVersion, ...rootPage.api.selectable_versions]).filter((version) => version != "unstable");
+    const data = await loadDataFromUrl(dataUrl);
+    const selectableVersions = findFirstByKey(data, "selectableVersions");
+    if (!selectableVersions || !Array.isArray(selectableVersions.default.values)) {
+        throw new Error("selectableVersions not found or is not an array");
+    }
+    return selectableVersions.default.values.filter((v) => v != "unstable");
 };
 const main = async () => {
     await loadExemplars();
     const rootDir = (0, src_1.getPackageRootDir)();
     const versions = process.env.VERSION ? [process.env.VERSION] : await getAllVersions();
     for (const version of versions) {
-        const page = await loadRailsData(docsWebhooksPageForVersion(version));
-        const webhooks = assert(page.api.rest_resource.info["x-description-list"]["items"]);
-        console.log(`Loaded ${webhooks.length} webhooks for version ${version}`);
-        for (const webhook of webhooks) {
-            if (webhook.response === "") {
-                console.warn(`${webhook.name} has an empty response`);
+        console.log(`Loading webhooks for version ${version}`);
+        const data = await loadDataFromUrl(dataUrlForVersion(version));
+        const webhooksAccordian = findFirstByPredicate(data, (node) => node.type === "WebhooksAccordion" && node.anchorLink === "list-of-topics");
+        const webhookContent = assert(webhooksAccordian.accordionContent);
+        for (const webhookNode of webhookContent) {
+            const examplePayload = webhookNode.codeblock?.tabs?.[0]?.code;
+            let response = {};
+            if (!examplePayload) {
+                console.warn(`${webhookNode.title} has no payload`);
                 warnings += 1;
-                webhook.response = {};
             }
             else {
-                webhook.response = JSON.parse(webhook.response);
-            }
-            if (webhook.response === undefined || webhook.response === null) {
-                console.warn(`${webhook.name} has an empty response`);
-                warnings += 1;
-                webhook.response = {};
+                const parsedPayload = JSON.parse(examplePayload);
+                if (!parsedPayload) {
+                    console.warn(`${webhookNode.title} has a null payload`);
+                    warnings += 1;
+                }
+                else {
+                    response = parsedPayload;
+                }
             }
+            const webhook = {
+                access_scopes: webhookNode.accessScopes,
+                available_on: webhookNode.availableOn,
+                deprecated: !!webhookNode.webhookNotices?.find((notice) => notice.type === "deprecated"),
+                description: webhookNode.description,
+                name: webhookNode.title,
+                pii: webhookNode.pii,
+                related_resource: webhookNode.relatedResource,
+                response,
+                shop_feature: !!webhookNode.webhookNotices?.find((notice) => notice.type === "shop_feature"),
+            };
             const metadataFile = path_1.default.join(rootDir, "metadatas", version, webhook.name + ".json");
             await fs_extra_1.default.mkdir(path_1.default.dirname(metadataFile), { recursive: true });
             await fs_extra_1.default.writeFile(metadataFile, JSON.stringify(webhook, null, 2), "utf-8");

package/metadatas/2025-10/app/scopes_update.json

@@ -0,0 +1,24 @@
+{
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever the access scopes of any installation are modified. Allows apps to keep track of the granted access scopes of their installations.",
+  "name": "app/scopes_update",
+  "related_resource": "Shop",
+  "response": {
+    "id": 1,
+    "shop_id": "gid://shopify/Shop/548380009",
+    "previous": [
+      "read_products"
+    ],
+    "current": [
+      "read_products",
+      "write_products"
+    ],
+    "updated_at": "2024-06-25T00:00:00.000Z"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/app/uninstalled.json

@@ -0,0 +1,70 @@
+{
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a shop has uninstalled the app.",
+  "name": "app/uninstalled",
+  "related_resource": "Shop",
+  "response": {
+    "id": 548380009,
+    "name": "Super Toys",
+    "email": "super@supertoys.com",
+    "domain": null,
+    "province": "Tennessee",
+    "country": "US",
+    "address1": "190 MacLaren Street",
+    "zip": "37178",
+    "city": "Houston",
+    "source": null,
+    "phone": "3213213210",
+    "latitude": null,
+    "longitude": null,
+    "primary_locale": "en",
+    "address2": null,
+    "created_at": null,
+    "updated_at": null,
+    "country_code": "US",
+    "country_name": "United States",
+    "currency": "USD",
+    "customer_email": "super@supertoys.com",
+    "timezone": "(GMT-05:00) Eastern Time (US & Canada)",
+    "iana_timezone": null,
+    "shop_owner": "John Smith",
+    "money_format": "${{amount}}",
+    "money_with_currency_format": "${{amount}} USD",
+    "weight_unit": "kg",
+    "province_code": "TN",
+    "taxes_included": null,
+    "auto_configure_tax_inclusivity": null,
+    "tax_shipping": null,
+    "county_taxes": null,
+    "plan_display_name": "Shopify Plus",
+    "plan_name": "enterprise",
+    "has_discounts": false,
+    "has_gift_cards": true,
+    "myshopify_domain": null,
+    "google_apps_domain": null,
+    "google_apps_login_enabled": null,
+    "money_in_emails_format": "${{amount}}",
+    "money_with_currency_in_emails_format": "${{amount}} USD",
+    "eligible_for_payments": true,
+    "requires_extra_payments_agreement": false,
+    "password_enabled": null,
+    "has_storefront": true,
+    "finances": true,
+    "primary_location_id": 655441491,
+    "checkout_api_supported": true,
+    "multi_location_enabled": true,
+    "setup_required": false,
+    "pre_launch_enabled": false,
+    "enabled_presentment_currencies": [
+      "USD"
+    ],
+    "marketing_sms_consent_enabled_at_checkout": false,
+    "transactional_sms_disabled": false
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/app_purchases_one_time/update.json

@@ -0,0 +1,21 @@
+{
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a one-time app charge is updated.",
+  "name": "app_purchases_one_time/update",
+  "related_resource": "ApplicationCharge",
+  "response": {
+    "app_purchase_one_time": {
+      "admin_graphql_api_id": "gid://shopify/AppPurchaseOneTime/1017262353",
+      "name": "Webhook Test",
+      "status": "PENDING",
+      "admin_graphql_api_shop_id": "gid://shopify/Shop/548380009",
+      "created_at": "2021-12-31T19:00:00-05:00",
+      "updated_at": "2021-12-31T19:00:00-05:00"
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/app_subscriptions/approaching_capped_amount.json

@@ -0,0 +1,23 @@
+{
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when the balance used on an app subscription crosses 90% of the capped amount.",
+  "name": "app_subscriptions/approaching_capped_amount",
+  "related_resource": "RecurringApplicationCharge",
+  "response": {
+    "app_subscription": {
+      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266968",
+      "name": "Webhook Test",
+      "balance_used": 0,
+      "capped_amount": "20.0",
+      "currency_code": "USD",
+      "admin_graphql_api_shop_id": "gid://shopify/Shop/548380009",
+      "created_at": "2021-12-31T19:00:00-05:00",
+      "updated_at": "2021-12-31T19:00:00-05:00"
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/app_subscriptions/update.json

@@ -0,0 +1,27 @@
+{
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever an app subscription is updated.",
+  "name": "app_subscriptions/update",
+  "related_resource": "RecurringApplicationCharge",
+  "response": {
+    "app_subscription": {
+      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266962",
+      "name": "Webhook Test",
+      "status": "PENDING",
+      "admin_graphql_api_shop_id": "gid://shopify/Shop/548380009",
+      "created_at": "2021-12-31T19:00:00-05:00",
+      "updated_at": "2021-12-31T19:00:00-05:00",
+      "currency": "USD",
+      "capped_amount": "20.0",
+      "price": "10.00",
+      "interval": "every_30_days",
+      "plan_handle": "plan-123"
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/audit_events/admin_api_activity.json

@@ -0,0 +1,67 @@
+{
+  "access_scopes": [
+    "audit_events"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Triggers for each auditable Admin API request. This topic is limited to one active subscription per Plus store and requires the use of Google Cloud Pub/Sub or AWS EventBridge.",
+  "name": "audit_events/admin_api_activity",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "AuditEvent",
+  "response": {
+    "events": [
+      {
+        "time": 1634678724,
+        "event": {
+          "context": {
+            "context_type": "network_request",
+            "context_identifier": "13493be9-24f2-4eea-b71d-a8acd7af7917",
+            "context_metadata": {
+              "client_ip": "192.168.64.1",
+              "content_type": "json",
+              "response_time_ms": 116.47000000812113,
+              "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.90 Safari/537.36",
+              "api_request_failed": false,
+              "response_code": 200
+            }
+          },
+          "action": "api_request",
+          "actor": {
+            "actor_type": "app",
+            "actor_identifier": 4,
+            "actor_metadata": {
+              "app_name": "Private app",
+              "api_version_requested": "unstable",
+              "api_version_served": "unstable",
+              "ecosystem_category": "private"
+            },
+            "on_behalf_of": {
+              "user_email": "dev@example.com"
+            }
+          },
+          "subject": {
+            "subject_type": "shop",
+            "subject_identifier": "shop1.myshopify.io",
+            "subject_metadata": {}
+          },
+          "timestamp": "2021-10-19T21:25:24Z",
+          "additional_metadata": {
+            "request_type": "GraphQL",
+            "mutation_names": [],
+            "query": "query orders {\n  orders(first: $first) {\n    edges {\n      node {\n        id\n      }\n    }\n  }\n}",
+            "variables": {
+              "first": 10
+            },
+            "error_codes": []
+          }
+        }
+      }
+    ]
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/bulk_operations/finish.json

@@ -0,0 +1,20 @@
+{
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Notifies when a Bulk Operation finishes.",
+  "name": "bulk_operations/finish",
+  "related_resource": "BulkOperation",
+  "response": {
+    "admin_graphql_api_id": "gid://shopify/BulkOperation/147595010",
+    "completed_at": "2024-01-01T07:34:56-05:00",
+    "created_at": "2025-09-10T14:39:08-04:00",
+    "error_code": null,
+    "status": "completed",
+    "type": "query"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/carts/create.json

@@ -0,0 +1,98 @@
+{
+  "access_scopes": [
+    "orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a cart is created in the online store. Other types of carts aren't supported. For example, the webhook doesn't support carts that are created in a custom storefront.",
+  "name": "carts/create",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "CartNext",
+  "response": {
+    "id": "exampleCartId",
+    "token": "exampleCartId",
+    "line_items": [
+      {
+        "id": 704912205188288500,
+        "properties": null,
+        "quantity": 3,
+        "variant_id": 704912205188288500,
+        "key": "704912205188288575:3abdf474dce81d0025dd15b9a02ef6bf",
+        "discounted_price": "19.99",
+        "discounts": [],
+        "gift_card": false,
+        "grams": 200,
+        "line_price": "59.97",
+        "original_line_price": "59.97",
+        "original_price": "19.99",
+        "price": "19.99",
+        "product_id": 788032119674292900,
+        "sku": "example-shirt-s",
+        "taxable": true,
+        "title": "Example T-Shirt - Small",
+        "total_discount": "39.98",
+        "vendor": "Acme",
+        "discounted_price_set": {
+          "shop_money": {
+            "amount": "19.99",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "19.99",
+            "currency_code": "USD"
+          }
+        },
+        "line_price_set": {
+          "shop_money": {
+            "amount": "59.97",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "59.97",
+            "currency_code": "USD"
+          }
+        },
+        "original_line_price_set": {
+          "shop_money": {
+            "amount": "59.97",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "59.97",
+            "currency_code": "USD"
+          }
+        },
+        "price_set": {
+          "shop_money": {
+            "amount": "19.99",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "19.99",
+            "currency_code": "USD"
+          }
+        },
+        "total_discount_set": {
+          "shop_money": {
+            "amount": "39.98",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "39.98",
+            "currency_code": "USD"
+          }
+        }
+      }
+    ],
+    "note": null,
+    "updated_at": "2022-01-01T00:00:00.000Z",
+    "created_at": "2022-01-01T00:00:00.000Z"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/carts/update.json

@@ -0,0 +1,98 @@
+{
+  "access_scopes": [
+    "orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a cart is updated in the online store. Other types of carts aren't supported. For example, the webhook doesn't support carts that are updated in a custom storefront.",
+  "name": "carts/update",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "CartNext",
+  "response": {
+    "id": "exampleCartId",
+    "token": "exampleCartId",
+    "line_items": [
+      {
+        "id": 704912205188288500,
+        "properties": null,
+        "quantity": 3,
+        "variant_id": 704912205188288500,
+        "key": "704912205188288575:3abdf474dce81d0025dd15b9a02ef6bf",
+        "discounted_price": "19.99",
+        "discounts": [],
+        "gift_card": false,
+        "grams": 200,
+        "line_price": "59.97",
+        "original_line_price": "59.97",
+        "original_price": "19.99",
+        "price": "19.99",
+        "product_id": 788032119674292900,
+        "sku": "example-shirt-s",
+        "taxable": true,
+        "title": "Example T-Shirt - Small",
+        "total_discount": "39.98",
+        "vendor": "Acme",
+        "discounted_price_set": {
+          "shop_money": {
+            "amount": "19.99",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "19.99",
+            "currency_code": "USD"
+          }
+        },
+        "line_price_set": {
+          "shop_money": {
+            "amount": "59.97",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "59.97",
+            "currency_code": "USD"
+          }
+        },
+        "original_line_price_set": {
+          "shop_money": {
+            "amount": "59.97",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "59.97",
+            "currency_code": "USD"
+          }
+        },
+        "price_set": {
+          "shop_money": {
+            "amount": "19.99",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "19.99",
+            "currency_code": "USD"
+          }
+        },
+        "total_discount_set": {
+          "shop_money": {
+            "amount": "39.98",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "39.98",
+            "currency_code": "USD"
+          }
+        }
+      }
+    ],
+    "note": null,
+    "updated_at": "2022-01-01T00:00:00.000Z",
+    "created_at": "2022-01-01T00:00:00.000Z"
+  },
+  "shop_feature": false
+}