shopify-webhook-schemas 0.2.1 → 0.2.3

package/dist/src/infer-schema.d.ts

@@ -1,4 +1,4 @@
-export declare const startVersion = "2024-04";
+export declare const getStartVersion: (date?: Date) => string;
 export type Error = {
     message: string;
     path: string;

package/dist/src/infer-schema.js

@@ -1,14 +1,40 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.overrides = exports.manualExamples = exports.inferSchemaFromExamplePayload = exports.startVersion = void 0;
+exports.overrides = exports.manualExamples = exports.inferSchemaFromExamplePayload = exports.getStartVersion = void 0;
 const json_schema_walker_1 = require("@cloudflare/json-schema-walker");
 const schema_infer_1 = require("@jsonhero/schema-infer");
 const lodash_1 = require("lodash");
 const safe_stable_stringify_1 = require("safe-stable-stringify");
 const stringify = (0, safe_stable_stringify_1.configure)({ deterministic: true });
-exports.startVersion = "2024-04";
+const getStartVersion = (date = new Date()) => {
+    const year = date.getUTCFullYear();
+    const month = date.getUTCMonth() + 1; // 1-12
+    // Map month to quarter
+    let quarter;
+    if (month <= 3)
+        quarter = 1; // Jan-Mar -> Q1 (01)
+    else if (month <= 6)
+        quarter = 2; // Apr-Jun -> Q2 (04)
+    else if (month <= 9)
+        quarter = 3; // Jul-Sep -> Q3 (07)
+    else
+        quarter = 4; // Oct-Dec -> Q4 (10)
+    // Go back 3 quarters (4 quarters including current)
+    let targetYear = year;
+    let targetQuarter = quarter - 3;
+    // Handle year wraparound
+    while (targetQuarter <= 0) {
+        targetQuarter += 4;
+        targetYear -= 1;
+    }
+    // Map quarter to month string
+    const quarterToMonth = { 1: "01", 2: "04", 3: "07", 4: "10" };
+    return `${targetYear}-${quarterToMonth[targetQuarter]}`;
+};
+exports.getStartVersion = getStartVersion;
 const inferSchemaFromExamplePayload = (examplePayload, metadata) => {
     const inference = (0, schema_infer_1.inferSchema)(examplePayload);
+    const startVersion = (0, exports.getStartVersion)();
     // build a copy of the payload and apply overrides based on the webhook name
     for (const [matcher, override] of exports.manualExamples) {
         if (matcher.test(metadata.name)) {
@@ -23,7 +49,7 @@ const inferSchemaFromExamplePayload = (examplePayload, metadata) => {
         ...inference.toJSONSchema(),
     };
     for (const override of exports.overrides) {
-        if (override.topics.includes(metadata.name) && (!override.versions || override.versions.includes(exports.startVersion))) {
+        if (override.topics.includes(metadata.name) && (!override.versions || override.versions.includes(startVersion))) {
             for (const [key, schemaOverride] of Object.entries(override.schema)) {
                 schema.properties[key] = schemaOverride;
             }

package/dist/src/scrape.js

@@ -76,8 +76,9 @@ const loadExemplars = async () => {
     console.log(`loaded ${files.length} exemplars`);
 };
 const getAllVersions = async () => {
-    const rootPage = await loadRailsData(docsWebhooksPageForVersion(infer_schema_1.startVersion));
-    return (0, lodash_1.uniq)([infer_schema_1.startVersion, ...rootPage.api.selectable_versions]).filter((version) => version != "unstable");
+    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 main = async () => {
     await loadExemplars();
@@ -96,6 +97,11 @@ const main = async () => {
             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 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/2024-07/app_purchases_one_time/update.json

@@ -9,7 +9,7 @@
   "related_resource": "ApplicationCharge",
   "response": {
     "app_purchase_one_time": {
-      "admin_graphql_api_id": "gid://shopify/AppPurchaseOneTime/1017262347",
+      "admin_graphql_api_id": "gid://shopify/AppPurchaseOneTime/1017262351",
       "name": "Webhook Test",
       "status": "PENDING",
       "admin_graphql_api_shop_id": "gid://shopify/Shop/548380009",

package/metadatas/2024-07/app_subscriptions/approaching_capped_amount.json

@@ -9,7 +9,7 @@
   "related_resource": "RecurringApplicationCharge",
   "response": {
     "app_subscription": {
-      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266953",
+      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266957",
       "name": "Webhook Test",
       "balance_used": 0,
       "capped_amount": "20.0",

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

@@ -10,7 +10,7 @@
   "related_resource": "RecurringApplicationCharge",
   "response": {
     "app_subscription": {
-      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266952",
+      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266953",
       "name": "Webhook Test",
       "status": "PENDING",
       "admin_graphql_api_shop_id": "gid://shopify/Shop/548380009",

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

@@ -11,7 +11,7 @@
   "response": {
     "admin_graphql_api_id": "gid://shopify/BulkOperation/147595010",
     "completed_at": "2024-01-01T07:34:56-05:00",
-    "created_at": "2025-01-30T15:41:03-05:00",
+    "created_at": "2025-06-13T11:19:23-04:00",
     "error_code": null,
     "status": "completed",
     "type": "query"

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

@@ -44,12 +44,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "696c9d8bedd4c2932b904c49cf955b86",
-        "destination_location_id": 1015975134,
+        "key": "8e17664a36a4c27f7e85cfaa22cf2adf",
+        "destination_location_id": 1015975124,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 1015975133,
+        "origin_location_id": 1015975123,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -103,12 +103,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "696c9d8bedd4c2932b904c49cf955b86",
-        "destination_location_id": 1015975134,
+        "key": "8e17664a36a4c27f7e85cfaa22cf2adf",
+        "destination_location_id": 1015975124,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 1015975133,
+        "origin_location_id": 1015975123,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,

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

@@ -44,12 +44,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "bff422fa7717dc622afd0a63413f6269",
-        "destination_location_id": 1015975140,
+        "key": "fdc2f3d43cec601dbe9d1a7b86152329",
+        "destination_location_id": 1015975130,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 1015975139,
+        "origin_location_id": 1015975129,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -103,12 +103,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "bff422fa7717dc622afd0a63413f6269",
-        "destination_location_id": 1015975140,
+        "key": "fdc2f3d43cec601dbe9d1a7b86152329",
+        "destination_location_id": 1015975130,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 1015975139,
+        "origin_location_id": 1015975129,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,

package/metadatas/2024-07/customer.tags_added.json

@@ -19,7 +19,7 @@
       "tag1",
       "tag2"
     ],
-    "occurredAt": "2005-05-05T07:00:00.000Z"
+    "occurredAt": "2005-05-05T04:00:00.000Z"
   },
   "shop_feature": false
 }

package/metadatas/2024-07/customer.tags_removed.json

@@ -19,7 +19,7 @@
       "tag1",
       "tag2"
     ],
-    "occurredAt": "2005-05-05T07:00:00.000Z"
+    "occurredAt": "2005-05-05T04:00:00.000Z"
   },
   "shop_feature": false
 }

package/metadatas/2024-07/discounts/create.json

@@ -15,8 +15,8 @@
     "admin_graphql_api_id": "gid://shopify/DiscountAutomaticNode/1",
     "title": "Automatic free shipping",
     "status": "ACTIVE",
-    "created_at": "2016-08-29T15:00:00-04:00",
-    "updated_at": "2016-08-29T15:00:00-04:00"
+    "created_at": "2016-08-29T12:00:00-04:00",
+    "updated_at": "2016-08-29T12:00:00-04:00"
   },
   "shop_feature": false
 }

package/metadatas/2024-07/discounts/delete.json

@@ -13,7 +13,7 @@
   "related_resource": "PriceRule",
   "response": {
     "admin_graphql_api_id": "gid://shopify/DiscountAutomaticNode/1",
-    "deleted_at": "2018-08-29T15:00:00-04:00"
+    "deleted_at": "2018-08-29T12:00:00-04:00"
   },
   "shop_feature": false
 }

package/metadatas/2024-07/discounts/redeemcode_added.json

@@ -17,7 +17,7 @@
       "id": "gid://shopify/DiscountRedeemCode/1",
       "code": "code1"
     },
-    "updated_at": "2018-08-29T19:00:00.000Z"
+    "updated_at": "2018-08-29T16:00:00.000Z"
   },
   "shop_feature": false
 }

package/metadatas/2024-07/discounts/redeemcode_removed.json

@@ -17,7 +17,7 @@
       "id": "gid://shopify/DiscountRedeemCode/1",
       "code": "code1"
     },
-    "updated_at": "2018-08-29T19:00:00.000Z"
+    "updated_at": "2018-08-29T16:00:00.000Z"
   },
   "shop_feature": false
 }

package/metadatas/2024-07/discounts/update.json

@@ -15,8 +15,8 @@
     "admin_graphql_api_id": "gid://shopify/DiscountAutomaticNode/1",
     "title": "Automatic free shipping updated",
     "status": "ACTIVE",
-    "created_at": "2016-08-29T15:00:00-04:00",
-    "updated_at": "2016-08-29T15:00:00-04:00"
+    "created_at": "2016-08-29T12:00:00-04:00",
+    "updated_at": "2016-08-29T12:00:00-04:00"
   },
   "shop_feature": false
 }

package/metadatas/2024-07/draft_orders/create.json

@@ -25,20 +25,20 @@
     "updated_at": "2021-12-31T19:00:00-05:00",
     "tax_exempt": false,
     "completed_at": null,
-    "name": "#D166",
+    "name": "#D167",
     "allow_discount_codes_in_checkout?": false,
     "b2b?": false,
     "status": "open",
     "line_items": [
       {
-        "id": 1328348,
+        "id": 2341721,
         "variant_id": 49148385,
         "product_id": 632910392,
         "title": "IPod Nano - 8GB",
         "variant_title": "Red",
         "sku": "IPOD2008RED",
         "vendor": "Apple",
-        "quantity": 10,
+        "quantity": 3,
         "requires_shipping": true,
         "taxable": true,
         "gift_card": false,
@@ -50,10 +50,10 @@
         "properties": [],
         "custom": false,
         "price": "199.00",
-        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/1328348"
+        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/2341721"
       },
       {
-        "id": 460387,
+        "id": 3532383,
         "variant_id": 457924702,
         "product_id": 632910392,
         "title": "IPod Nano - 8GB",
@@ -72,17 +72,17 @@
         "properties": [],
         "custom": false,
         "price": "199.00",
-        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/460387"
+        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/3532383"
       },
       {
-        "id": 2134263,
+        "id": 2050618,
         "variant_id": 808950810,
         "product_id": 632910392,
         "title": "IPod Nano - 8GB",
         "variant_title": "Pink",
         "sku": "IPOD2008PINK",
         "vendor": "Apple",
-        "quantity": 9,
+        "quantity": 3,
         "requires_shipping": true,
         "taxable": true,
         "gift_card": false,
@@ -94,7 +94,7 @@
         "properties": [],
         "custom": false,
         "price": "199.00",
-        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/2134263"
+        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/2050618"
       }
     ],
     "api_client_id": null,
@@ -136,9 +136,9 @@
     "created_on_api_version_handle": null,
     "applied_discount": {
       "description": "ABC 123",
-      "value": "8.0",
+      "value": "6.0",
       "title": "ABC 123",
-      "amount": "6.00",
+      "amount": "9.00",
       "value_type": "percentage"
     },
     "order_id": null,
@@ -146,30 +146,30 @@
       "title": "ABC 123",
       "custom": true,
       "handle": null,
-      "price": "1.00"
+      "price": "6.00"
     },
     "tax_lines": [
       {
-        "rate": 0.04940551024998377,
+        "rate": 0.03505923645967149,
         "title": "State tax",
-        "price": "2.00"
+        "price": "4.00"
       },
       {
-        "rate": 0.04940551024998377,
+        "rate": 0.03505923645967149,
         "title": "State tax",
-        "price": "5.00"
+        "price": "2.00"
       },
       {
-        "rate": 0.04940551024998377,
+        "rate": 0.03505923645967149,
         "title": "State tax",
-        "price": "4.00"
+        "price": "3.00"
       }
     ],
     "tags": "",
     "note_attributes": [],
     "total_price": "421.00",
-    "subtotal_price": "445.00",
-    "total_tax": "460.00",
+    "subtotal_price": "480.00",
+    "total_tax": "496.00",
     "payment_terms": {
       "id": 706405506930370000,
       "payment_terms_name": "Net 7",

package/metadatas/2024-07/draft_orders/update.json

@@ -25,20 +25,20 @@
     "updated_at": "2021-12-31T19:00:00-05:00",
     "tax_exempt": false,
     "completed_at": null,
-    "name": "#D187",
+    "name": "#D155",
     "allow_discount_codes_in_checkout?": false,
     "b2b?": false,
     "status": "open",
     "line_items": [
       {
-        "id": 2942397,
+        "id": 590192,
         "variant_id": 49148385,
         "product_id": 632910392,
         "title": "IPod Nano - 8GB",
         "variant_title": "Red",
         "sku": "IPOD2008RED",
         "vendor": "Apple",
-        "quantity": 4,
+        "quantity": 5,
         "requires_shipping": true,
         "taxable": true,
         "gift_card": false,
@@ -50,10 +50,10 @@
         "properties": [],
         "custom": false,
         "price": "199.00",
-        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/2942397"
+        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/590192"
       },
       {
-        "id": 254251,
+        "id": 583497,
         "variant_id": 457924702,
         "product_id": 632910392,
         "title": "IPod Nano - 8GB",
@@ -72,10 +72,10 @@
         "properties": [],
         "custom": false,
         "price": "199.00",
-        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/254251"
+        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/583497"
       },
       {
-        "id": 4016759,
+        "id": 1386102,
         "variant_id": 808950810,
         "product_id": 632910392,
         "title": "IPod Nano - 8GB",
@@ -94,7 +94,7 @@
         "properties": [],
         "custom": false,
         "price": "199.00",
-        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/4016759"
+        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/1386102"
       }
     ],
     "api_client_id": null,
@@ -136,9 +136,9 @@
     "created_on_api_version_handle": null,
     "applied_discount": {
       "description": "ABC 123",
-      "value": "9.0",
+      "value": "4.0",
       "title": "ABC 123",
-      "amount": "4.00",
+      "amount": "3.00",
       "value_type": "percentage"
     },
     "order_id": null,
@@ -146,30 +146,30 @@
       "title": "ABC 123",
       "custom": true,
       "handle": null,
-      "price": "10.00"
+      "price": "5.00"
     },
     "tax_lines": [
       {
-        "rate": 0.034081506957887635,
+        "rate": 0.04103447592738446,
         "title": "State tax",
-        "price": "5.00"
+        "price": "1.00"
       },
       {
-        "rate": 0.034081506957887635,
+        "rate": 0.04103447592738446,
         "title": "State tax",
         "price": "1.00"
       },
       {
-        "rate": 0.034081506957887635,
+        "rate": 0.04103447592738446,
         "title": "State tax",
-        "price": "3.00"
+        "price": "2.00"
       }
     ],
     "tags": "",
     "note_attributes": [],
-    "total_price": "425.00",
-    "subtotal_price": "439.00",
-    "total_tax": "416.00",
+    "total_price": "490.00",
+    "subtotal_price": "438.00",
+    "total_tax": "435.00",
     "payment_terms": {
       "id": 706405506930370000,
       "payment_terms_name": "Net 7",
@@ -188,15 +188,15 @@
           "issued_at": "2021-01-01T00:00:00-05:00",
           "due_at": "2021-01-02T00:00:00-05:00",
           "completed_at": "2021-01-02T00:00:00-05:00",
-          "amount": "425.00",
+          "amount": "490.00",
           "currency": "USD",
-          "total_price": "425.00",
+          "total_price": "490.00",
           "total_price_currency": "USD",
-          "balance_due": "425.00",
+          "balance_due": "490.00",
           "balance_due_currency": "USD",
-          "total_balance": "425.00",
+          "total_balance": "490.00",
           "total_balance_currency": "USD",
-          "outstanding_balance": "425.00",
+          "outstanding_balance": "490.00",
           "outstanding_balance_currency": "USD"
         }
       ],