shopify-webhook-schemas 0.1.8 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (113) hide show
  1. package/dist/src/index.d.ts +2 -0
  2. package/dist/src/index.js +3 -0
  3. package/dist/src/infer-schema.d.ts +18 -0
  4. package/dist/src/infer-schema.js +717 -0
  5. package/dist/src/scrape.js +11 -623
  6. package/metadatas/2025-04/app_purchases_one_time/update.json +1 -1
  7. package/metadatas/2025-04/app_subscriptions/approaching_capped_amount.json +1 -1
  8. package/metadatas/2025-04/app_subscriptions/update.json +5 -2
  9. package/metadatas/2025-04/bulk_operations/finish.json +1 -1
  10. package/metadatas/2025-04/checkouts/create.json +6 -6
  11. package/metadatas/2025-04/checkouts/update.json +6 -6
  12. package/metadatas/2025-04/discounts/create.json +2 -2
  13. package/metadatas/2025-04/discounts/delete.json +1 -1
  14. package/metadatas/2025-04/discounts/redeemcode_added.json +1 -1
  15. package/metadatas/2025-04/discounts/redeemcode_removed.json +1 -1
  16. package/metadatas/2025-04/discounts/update.json +2 -2
  17. package/metadatas/2025-04/draft_orders/create.json +24 -24
  18. package/metadatas/2025-04/draft_orders/update.json +26 -26
  19. package/metadatas/2025-04/fulfillments/create.json +71 -24
  20. package/metadatas/2025-04/fulfillments/update.json +71 -24
  21. package/metadatas/2025-04/inventory_items/create.json +2 -1
  22. package/metadatas/2025-04/inventory_items/delete.json +2 -1
  23. package/metadatas/2025-04/inventory_items/update.json +2 -1
  24. package/metadatas/2025-04/markets_backup_region/update.json +18 -0
  25. package/metadatas/2025-04/order_transactions/create.json +3 -3
  26. package/metadatas/2025-04/orders/cancelled.json +91 -41
  27. package/metadatas/2025-04/orders/create.json +91 -41
  28. package/metadatas/2025-04/orders/edited.json +1 -1
  29. package/metadatas/2025-04/orders/fulfilled.json +91 -41
  30. package/metadatas/2025-04/orders/paid.json +91 -41
  31. package/metadatas/2025-04/orders/partially_fulfilled.json +91 -41
  32. package/metadatas/2025-04/orders/updated.json +91 -41
  33. package/metadatas/2025-04/refunds/create.json +110 -34
  34. package/metadatas/2025-04/selling_plan_groups/create.json +2 -2
  35. package/metadatas/2025-04/selling_plan_groups/delete.json +2 -2
  36. package/metadatas/2025-04/selling_plan_groups/update.json +2 -2
  37. package/metadatas/2025-04/subscription_billing_attempts/challenged.json +2 -2
  38. package/metadatas/2025-04/subscription_billing_attempts/failure.json +2 -2
  39. package/metadatas/2025-04/subscription_billing_attempts/success.json +2 -2
  40. package/metadatas/2025-04/subscription_contracts/activate.json +4 -4
  41. package/metadatas/2025-04/subscription_contracts/cancel.json +4 -4
  42. package/metadatas/2025-04/subscription_contracts/create.json +4 -4
  43. package/metadatas/2025-04/subscription_contracts/expire.json +4 -4
  44. package/metadatas/2025-04/subscription_contracts/fail.json +4 -4
  45. package/metadatas/2025-04/subscription_contracts/pause.json +4 -4
  46. package/metadatas/2025-04/subscription_contracts/update.json +4 -4
  47. package/metadatas/2025-04/tender_transactions/create.json +1 -1
  48. package/package.json +6 -6
  49. package/schemas/2025-04/app_subscriptions/update.json +12 -0
  50. package/schemas/2025-04/carts/create.json +4 -1
  51. package/schemas/2025-04/carts/update.json +4 -1
  52. package/schemas/2025-04/checkouts/create.json +26 -16
  53. package/schemas/2025-04/checkouts/delete.json +3 -0
  54. package/schemas/2025-04/checkouts/update.json +26 -16
  55. package/schemas/2025-04/collections/create.json +20 -0
  56. package/schemas/2025-04/collections/update.json +20 -0
  57. package/schemas/2025-04/company_locations/create.json +37 -6
  58. package/schemas/2025-04/company_locations/delete.json +37 -6
  59. package/schemas/2025-04/company_locations/update.json +37 -6
  60. package/schemas/2025-04/customer_payment_methods/create.json +1 -1
  61. package/schemas/2025-04/customer_payment_methods/revoke.json +1 -1
  62. package/schemas/2025-04/customer_payment_methods/update.json +1 -1
  63. package/schemas/2025-04/customers/create.json +86 -4
  64. package/schemas/2025-04/customers/delete.json +78 -2
  65. package/schemas/2025-04/customers/disable.json +86 -4
  66. package/schemas/2025-04/customers/enable.json +86 -4
  67. package/schemas/2025-04/customers/update.json +86 -4
  68. package/schemas/2025-04/customers_email_marketing_consent/update.json +13 -3
  69. package/schemas/2025-04/customers_marketing_consent/update.json +13 -3
  70. package/schemas/2025-04/disputes/create.json +0 -1
  71. package/schemas/2025-04/disputes/update.json +0 -1
  72. package/schemas/2025-04/domains/create.json +4 -2
  73. package/schemas/2025-04/domains/destroy.json +4 -2
  74. package/schemas/2025-04/domains/update.json +4 -2
  75. package/schemas/2025-04/draft_orders/create.json +138 -4
  76. package/schemas/2025-04/draft_orders/update.json +138 -4
  77. package/schemas/2025-04/fulfillments/create.json +196 -66
  78. package/schemas/2025-04/fulfillments/update.json +196 -66
  79. package/schemas/2025-04/inventory_items/create.json +7 -3
  80. package/schemas/2025-04/inventory_items/update.json +7 -3
  81. package/schemas/2025-04/markets_backup_region/update.json +17 -0
  82. package/schemas/2025-04/order_transactions/create.json +15 -5
  83. package/schemas/2025-04/orders/cancelled.json +76 -4
  84. package/schemas/2025-04/orders/create.json +76 -4
  85. package/schemas/2025-04/orders/edited.json +8 -2
  86. package/schemas/2025-04/orders/fulfilled.json +76 -4
  87. package/schemas/2025-04/orders/paid.json +76 -4
  88. package/schemas/2025-04/orders/partially_fulfilled.json +76 -4
  89. package/schemas/2025-04/orders/risk_assessment_changed.json +9 -2
  90. package/schemas/2025-04/orders/shopify_protect_eligibility_changed.json +8 -1
  91. package/schemas/2025-04/orders/updated.json +76 -4
  92. package/schemas/2025-04/payment_terms/create.json +4 -1
  93. package/schemas/2025-04/payment_terms/update.json +4 -1
  94. package/schemas/2025-04/products/create.json +160 -64
  95. package/schemas/2025-04/products/update.json +160 -64
  96. package/schemas/2025-04/refunds/create.json +764 -17
  97. package/schemas/2025-04/selling_plan_groups/create.json +66 -10
  98. package/schemas/2025-04/selling_plan_groups/update.json +66 -10
  99. package/schemas/2025-04/shop/update.json +4 -3
  100. package/schemas/2025-04/subscription_billing_attempts/challenged.json +0 -1
  101. package/schemas/2025-04/subscription_billing_attempts/failure.json +0 -1
  102. package/schemas/2025-04/subscription_billing_attempts/success.json +0 -1
  103. package/schemas/2025-04/subscription_contracts/activate.json +8 -2
  104. package/schemas/2025-04/subscription_contracts/cancel.json +8 -2
  105. package/schemas/2025-04/subscription_contracts/create.json +8 -2
  106. package/schemas/2025-04/subscription_contracts/expire.json +8 -2
  107. package/schemas/2025-04/subscription_contracts/fail.json +8 -2
  108. package/schemas/2025-04/subscription_contracts/pause.json +8 -2
  109. package/schemas/2025-04/subscription_contracts/update.json +8 -2
  110. package/schemas/2025-04/tender_transactions/create.json +9 -16
  111. package/schemas/2025-04/themes/create.json +4 -1
  112. package/schemas/2025-04/themes/publish.json +4 -1
  113. package/schemas/2025-04/themes/update.json +4 -1
@@ -1,3 +1,5 @@
1
+ import { inferSchemaFromExamplePayload } from "./infer-schema";
2
+ export { inferSchemaFromExamplePayload };
1
3
  export declare function getPackageRootDir(): string;
2
4
  /** Return a metadata blob from Shopify's docs describing a webhook topic */
3
5
  export declare function metadataForWebhook(apiVersion: string, topic: string): any;
package/dist/src/index.js CHANGED
@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.inferSchemaFromExamplePayload = void 0;
6
7
  exports.getPackageRootDir = getPackageRootDir;
7
8
  exports.metadataForWebhook = metadataForWebhook;
8
9
  exports.schemaForWebhook = schemaForWebhook;
@@ -10,6 +11,8 @@ exports.allTopicsForVersion = allTopicsForVersion;
10
11
  const fs_1 = __importDefault(require("fs"));
11
12
  const path_1 = __importDefault(require("path"));
12
13
  const fast_glob_1 = __importDefault(require("fast-glob"));
14
+ const infer_schema_1 = require("./infer-schema");
15
+ Object.defineProperty(exports, "inferSchemaFromExamplePayload", { enumerable: true, get: function () { return infer_schema_1.inferSchemaFromExamplePayload; } });
13
16
  const loaded = { metadatas: {}, schemas: {} };
14
17
  function getPackageRootDir() {
15
18
  let currentDir = __dirname;
@@ -0,0 +1,18 @@
1
+ export declare const startVersion = "2024-04";
2
+ export type Error = {
3
+ message: string;
4
+ path: string;
5
+ };
6
+ export declare const inferSchemaFromExamplePayload: (examplePayload: Record<string, any>, metadata: {
7
+ name: string;
8
+ }) => {
9
+ schema: any;
10
+ warnings: number;
11
+ errors: Error[];
12
+ };
13
+ export declare const manualExamples: [RegExp, Record<string, any>][];
14
+ export declare const overrides: {
15
+ topics: string[];
16
+ schema: any;
17
+ versions?: string[];
18
+ }[];