shopify-webhook-schemas 0.1.4 → 0.1.5

package/dist/src/anonymize-exemplars.js

@@ -19,7 +19,7 @@ const main = async () => {
             }
             else if (typeof value == "string") {
                 const type = (0, json_infer_types_1.inferType)(value);
-                if ('format' in type && type.format) {
+                if ("format" in type && type.format) {
                     switch (type.format.name) {
                         case "email": {
                             return "eallam@example.com";

package/dist/src/index.js

@@ -3,7 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.allTopicsForVersion = exports.schemaForWebhook = exports.metadataForWebhook = exports.getPackageRootDir = void 0;
+exports.getPackageRootDir = getPackageRootDir;
+exports.metadataForWebhook = metadataForWebhook;
+exports.schemaForWebhook = schemaForWebhook;
+exports.allTopicsForVersion = allTopicsForVersion;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const fast_glob_1 = __importDefault(require("fast-glob"));
@@ -15,7 +18,6 @@ function getPackageRootDir() {
     }
     return currentDir;
 }
-exports.getPackageRootDir = getPackageRootDir;
 const rootDir = getPackageRootDir();
 for (const kind of ["metadatas", "schemas"]) {
     const dir = `${rootDir}/${kind}`;
@@ -39,14 +41,11 @@ const getVersion = (obj, version) => {
 function metadataForWebhook(apiVersion, topic) {
     return getVersion(loaded.metadatas, apiVersion)[topic];
 }
-exports.metadataForWebhook = metadataForWebhook;
 /** Return the inferred JSON schema describing a webhook payload */
 function schemaForWebhook(apiVersion, topic) {
     return getVersion(loaded.schemas, apiVersion)[topic];
 }
-exports.schemaForWebhook = schemaForWebhook;
 /** Return all the known webhook topics */
 function allTopicsForVersion(apiVersion) {
     return Object.keys(getVersion(loaded.schemas, apiVersion));
 }
-exports.allTopicsForVersion = allTopicsForVersion;

package/dist/src/scrape.js

@@ -13,6 +13,7 @@ const got_1 = __importDefault(require("got"));
 const lodash_1 = require("lodash");
 const path_1 = __importDefault(require("path"));
 const src_1 = require("src");
+const shopify_js_1 = require("./shopify.js");
 const startVersion = "2024-04";
 function assert(value, message) {
     if (!value) {
@@ -26,20 +27,45 @@ function assert(value, message) {
 const loadRailsData = async (url) => {
     const shopifyDocsSource = await (0, got_1.default)(url);
     const $ = cheerio_1.default.load(shopifyDocsSource.body);
-    const scriptTag = assert($("script")
+    const jsonScriptTag = $("script")
         .toArray()
-        .find((script) => $(script).html()?.includes("window.RailsData")), "expected to find window.RailsData script tag in shopify source but couldn't");
-    const scriptText = $(scriptTag).html();
-    const jsonMatch = scriptText.match(/window\.RailsData = (\{[\s\S]*?\}\s*)\/\/\]\]/m);
-    if (!jsonMatch) {
-        throw new Error("RailsData object literal not found in script tag or is in an unexpected format");
+        .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");
     }
-    return JSON.parse(jsonMatch[1]);
 };
 const docsWebhooksPageForVersion = (version) => `https://shopify.dev/docs/api/admin-rest/${version}/resources/webhook#event-topics`;
 let warnings = 0;
 let errors = 0;
-const inferSchemaFromExamplePayload = async (examplePayload, metadata) => {
+const inferSchemaFromExamplePayload = (examplePayload, metadata) => {
     const inference = (0, schema_infer_1.inferSchema)(examplePayload);
     // build a copy of the payload and apply overrides based on the webhook name
     for (const [matcher, override] of manualExamples) {
@@ -82,7 +108,7 @@ const loadExemplars = async () => {
         const segments = file.split(path_1.default.sep);
         const _filename = segments.pop();
         const topicPattern = new RegExp(`${segments.pop()}.+`);
-        const version = segments.pop();
+        const _version = segments.pop();
         const exemplar = await fs_extra_1.default.readJSON(file);
         manualExamples.push([topicPattern, exemplar]);
     }
@@ -101,18 +127,25 @@ const main = async () => {
         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) {
-            webhook.response = JSON.parse(webhook.response);
+            if (webhook.response === "") {
+                console.warn(`${webhook.name} has an empty response`);
+                warnings += 1;
+                webhook.response = {};
+            }
+            else {
+                webhook.response = JSON.parse(webhook.response);
+            }
             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");
-            const schema = await inferSchemaFromExamplePayload(webhook.response, webhook);
+            const schema = inferSchemaFromExamplePayload(webhook.response, webhook);
             const schemaFile = path_1.default.join(rootDir, "schemas", version, webhook.name + ".json");
             await fs_extra_1.default.mkdir(path_1.default.dirname(schemaFile), { recursive: true });
             await fs_extra_1.default.writeFile(schemaFile, JSON.stringify(schema, null, 2), "utf-8");
         }
     }
-    if (warnings > 0) {
-        console.log(`Done with ${warnings} warnings`);
+    if (warnings > 0 || errors > 0) {
+        console.log(`Done with ${warnings} warnings and ${errors} errors`);
         process.exitCode = 1;
     }
     else {
@@ -164,7 +197,7 @@ const unknownPaths = [
         ["properties.collection_listing.properties.default_product_image", "properties.collection_listing.properties.image"],
     ],
     [/domains\/.+/, ["properties.localization.properties.country"]],
-    [/orders\/.+/, ["properties.client_details.properties.session_hash"]]
+    [/orders\/.+/, ["properties.client_details.properties.session_hash"]],
 ];
 // example data we feed the schema infer-er for each topic to allow it to discover real types
 const manualExamples = [
@@ -388,7 +421,7 @@ const manualExamples = [
             collection_listing: {
                 updated_at: "2021-12-30T19:00:00-05:00",
                 sort_order: 1,
-            }
+            },
         },
     ],
     [
@@ -396,10 +429,10 @@ const manualExamples = [
         {
             buyer_experience_configuration: { pay_now_only: true },
             billing_address: {
-                address2: "suite 101"
+                address2: "suite 101",
             },
             shipping_address: {
-                address2: "suite 101"
+                address2: "suite 101",
             },
         },
     ],
@@ -680,7 +713,7 @@ const overrides = [
             receipt: {
                 type: "object",
                 additionalProperties: true,
-            }
-        }
-    }
+            },
+        },
+    },
 ];

package/metadatas/2024-01/app/uninstalled.json

@@ -1,13 +1,12 @@
 {
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a shop has uninstalled the app.",
   "name": "app/uninstalled",
-  "pii": [
-    "merchant"
-  ],
   "related_resource": "Shop",
   "response": {
     "id": 548380009,
@@ -64,7 +63,8 @@
     "enabled_presentment_currencies": [
       "USD"
     ],
-    "transactional_sms_disabled": false,
-    "marketing_sms_consent_enabled_at_checkout": false
-  }
+    "marketing_sms_consent_enabled_at_checkout": false,
+    "transactional_sms_disabled": false
+  },
+  "shop_feature": false
 }

package/metadatas/2024-01/app_purchases_one_time/update.json

@@ -1,18 +1,21 @@
 {
   "available_on": [
-    "graphql"
+    "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/1017262354",
+      "admin_graphql_api_id": "gid://shopify/AppPurchaseOneTime/1017262351",
       "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/2024-01/app_subscriptions/approaching_capped_amount.json

@@ -1,13 +1,15 @@
 {
   "available_on": [
-    "graphql"
+    "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/1029266969",
+      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266947",
       "name": "Webhook Test",
       "balance_used": 0,
       "capped_amount": "20.0",
@@ -16,5 +18,6 @@
       "created_at": "2021-12-31T19:00:00-05:00",
       "updated_at": "2021-12-31T19:00:00-05:00"
     }
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-01/app_subscriptions/update.json

@@ -1,14 +1,16 @@
 {
   "available_on": [
     "graphql",
-    "rest"
+    "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",
+      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266951",
       "name": "Webhook Test",
       "status": "PENDING",
       "admin_graphql_api_shop_id": "gid://shopify/Shop/548380009",
@@ -17,5 +19,6 @@
       "currency": "USD",
       "capped_amount": "20.0"
     }
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-01/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": true
+}

package/metadatas/2024-01/bulk_operations/finish.json

@@ -1,17 +1,20 @@
 {
   "available_on": [
     "graphql",
-    "rest"
+    "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-04-19T14:38:41-04:00",
-    "created_at": "2024-04-19T14:38:41-04:00",
+    "completed_at": "2024-10-16T12:53:08-04:00",
+    "created_at": "2024-10-16T12:53:08-04:00",
     "error_code": null,
     "status": "completed",
     "type": "query"
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-01/carts/create.json

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "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": [
@@ -33,7 +35,7 @@
         "product_id": 788032119674292900,
         "sku": "example-shirt-s",
         "taxable": true,
-        "title": "Example T-Shirt",
+        "title": "Example T-Shirt - Small",
         "total_discount": "0.00",
         "vendor": "Acme",
         "discounted_price_set": {
@@ -91,5 +93,6 @@
     "note": null,
     "updated_at": "2022-01-01T00:00:00.000Z",
     "created_at": "2022-01-01T00:00:00.000Z"
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-01/carts/update.json

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "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": [
@@ -33,7 +35,7 @@
         "product_id": 788032119674292900,
         "sku": "example-shirt-s",
         "taxable": true,
-        "title": "Example T-Shirt",
+        "title": "Example T-Shirt - Small",
         "total_discount": "0.00",
         "vendor": "Acme",
         "discounted_price_set": {
@@ -91,5 +93,6 @@
     "note": null,
     "updated_at": "2022-01-01T00:00:00.000Z",
     "created_at": "2022-01-01T00:00:00.000Z"
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-01/channels/delete.json

@@ -0,0 +1,21 @@
+{
+  "access_scopes": [
+    "publications"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a channel is deleted.",
+  "name": "channels/delete",
+  "related_resource": "Channel",
+  "response": {
+    "id": "123456789"
+  },
+  "shop_feature": false,
+  "shopify_approval_scope": [
+    "write_publications"
+  ]
+}

package/metadatas/2024-01/checkouts/create.json

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a checkout is created.",
   "name": "checkouts/create",
   "pii": [
@@ -42,12 +44,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "415af760930068ebeaef7558276dbc39",
-        "destination_location_id": 938998239,
+        "key": "139cb5712fb4c8d9957dcfad9a3028da",
+        "destination_location_id": 1015975142,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 938998238,
+        "origin_location_id": 1015975141,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -74,6 +76,7 @@
             "reporting_jurisdiction_code": null,
             "tax_api_client_id": null,
             "tax_calculation_price": "11.94",
+            "tax_registration_id": null,
             "compare_at": 0.06,
             "channel_liable": false
           }
@@ -100,12 +103,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "415af760930068ebeaef7558276dbc39",
-        "destination_location_id": 938998239,
+        "key": "139cb5712fb4c8d9957dcfad9a3028da",
+        "destination_location_id": 1015975142,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 938998238,
+        "origin_location_id": 1015975141,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -132,6 +135,7 @@
             "reporting_jurisdiction_code": null,
             "tax_api_client_id": null,
             "tax_calculation_price": "11.94",
+            "tax_registration_id": null,
             "compare_at": 0.06,
             "channel_liable": false
           }
@@ -259,5 +263,6 @@
         "default": true
       }
     }
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-01/checkouts/delete.json

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a checkout is deleted.",
   "name": "checkouts/delete",
   "related_resource": "Checkout",
@@ -21,5 +23,6 @@
     "subtotal_price": "398.00",
     "cart_token": "eeafa272cebfd4b22385bc4b645e762c",
     "total_duties": null
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-01/checkouts/update.json

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a checkout is updated.",
   "name": "checkouts/update",
   "pii": [
@@ -42,12 +44,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "6041b2de1a788066788f441512ff904d",
-        "destination_location_id": 938998235,
+        "key": "0fede25d9590a4b164cd8391fc839d37",
+        "destination_location_id": 1015975136,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 938998234,
+        "origin_location_id": 1015975135,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -74,6 +76,7 @@
             "reporting_jurisdiction_code": null,
             "tax_api_client_id": null,
             "tax_calculation_price": "11.94",
+            "tax_registration_id": null,
             "compare_at": 0.06,
             "channel_liable": false
           }
@@ -100,12 +103,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "6041b2de1a788066788f441512ff904d",
-        "destination_location_id": 938998235,
+        "key": "0fede25d9590a4b164cd8391fc839d37",
+        "destination_location_id": 1015975136,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 938998234,
+        "origin_location_id": 1015975135,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -132,6 +135,7 @@
             "reporting_jurisdiction_code": null,
             "tax_api_client_id": null,
             "tax_calculation_price": "11.94",
+            "tax_registration_id": null,
             "compare_at": 0.06,
             "channel_liable": false
           }
@@ -259,5 +263,6 @@
         "default": true
       }
     }
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-01/collection_listings/add.json

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a collection listing is added.",
   "name": "collection_listings/add",
   "related_resource": "CollectionPublication",
@@ -21,5 +23,6 @@
       "sort_order": null,
       "published_at": "2021-12-31T19:00:00-05:00"
     }
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-01/collection_listings/remove.json

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a collection listing is removed.",
   "name": "collection_listings/remove",
   "related_resource": "CollectionPublication",
@@ -13,5 +15,6 @@
     "collection_listing": {
       "collection_id": 408372092144951400
     }
-  }
+  },
+  "shop_feature": false
 }