shopify-webhook-schemas 0.3.0 → 0.3.2

package/schemas/2026-01/themes/create.json

@@ -0,0 +1,50 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "admin_graphql_api_id": {
+      "format": "uri",
+      "type": "string"
+    },
+    "created_at": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "id": {
+      "type": "integer"
+    },
+    "name": {
+      "type": "string"
+    },
+    "previewable": {
+      "type": "boolean"
+    },
+    "processing": {
+      "type": "boolean"
+    },
+    "role": {
+      "type": "string"
+    },
+    "theme_store_id": {
+      "type": [
+        "integer",
+        "null"
+      ]
+    },
+    "updated_at": {
+      "format": "date-time",
+      "type": "string"
+    }
+  },
+  "required": [
+    "admin_graphql_api_id",
+    "created_at",
+    "id",
+    "name",
+    "previewable",
+    "processing",
+    "role",
+    "theme_store_id",
+    "updated_at"
+  ],
+  "type": "object"
+}

package/schemas/2026-01/themes/delete.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "id": {
+      "type": "integer"
+    }
+  },
+  "required": [
+    "id"
+  ],
+  "type": "object"
+}

package/schemas/2026-01/themes/publish.json

@@ -0,0 +1,50 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "admin_graphql_api_id": {
+      "format": "uri",
+      "type": "string"
+    },
+    "created_at": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "id": {
+      "type": "integer"
+    },
+    "name": {
+      "type": "string"
+    },
+    "previewable": {
+      "type": "boolean"
+    },
+    "processing": {
+      "type": "boolean"
+    },
+    "role": {
+      "type": "string"
+    },
+    "theme_store_id": {
+      "type": [
+        "integer",
+        "null"
+      ]
+    },
+    "updated_at": {
+      "format": "date-time",
+      "type": "string"
+    }
+  },
+  "required": [
+    "admin_graphql_api_id",
+    "created_at",
+    "id",
+    "name",
+    "previewable",
+    "processing",
+    "role",
+    "theme_store_id",
+    "updated_at"
+  ],
+  "type": "object"
+}

package/schemas/2026-01/themes/update.json

@@ -0,0 +1,50 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "admin_graphql_api_id": {
+      "format": "uri",
+      "type": "string"
+    },
+    "created_at": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "id": {
+      "type": "integer"
+    },
+    "name": {
+      "type": "string"
+    },
+    "previewable": {
+      "type": "boolean"
+    },
+    "processing": {
+      "type": "boolean"
+    },
+    "role": {
+      "type": "string"
+    },
+    "theme_store_id": {
+      "type": [
+        "integer",
+        "null"
+      ]
+    },
+    "updated_at": {
+      "format": "date-time",
+      "type": "string"
+    }
+  },
+  "required": [
+    "admin_graphql_api_id",
+    "created_at",
+    "id",
+    "name",
+    "previewable",
+    "processing",
+    "role",
+    "theme_store_id",
+    "updated_at"
+  ],
+  "type": "object"
+}

package/schemas/2026-01/variants/in_stock.json

@@ -0,0 +1,87 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "admin_graphql_api_id": {
+      "format": "uri",
+      "type": "string"
+    },
+    "barcode": {
+      "type": "null"
+    },
+    "compare_at_price": {
+      "type": "string"
+    },
+    "created_at": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "id": {
+      "type": "integer"
+    },
+    "image_id": {
+      "type": "null"
+    },
+    "inventory_policy": {
+      "type": "string"
+    },
+    "inventory_quantity": {
+      "type": "integer"
+    },
+    "old_inventory_quantity": {
+      "type": "integer"
+    },
+    "option1": {
+      "type": "string"
+    },
+    "option2": {
+      "type": "null"
+    },
+    "option3": {
+      "type": "null"
+    },
+    "position": {
+      "type": "integer"
+    },
+    "price": {
+      "type": "string"
+    },
+    "product_id": {
+      "type": "integer"
+    },
+    "sku": {
+      "type": "null"
+    },
+    "taxable": {
+      "type": "boolean"
+    },
+    "title": {
+      "type": "string"
+    },
+    "updated_at": {
+      "format": "date-time",
+      "type": "string"
+    }
+  },
+  "required": [
+    "admin_graphql_api_id",
+    "barcode",
+    "compare_at_price",
+    "created_at",
+    "id",
+    "image_id",
+    "inventory_policy",
+    "inventory_quantity",
+    "old_inventory_quantity",
+    "option1",
+    "option2",
+    "option3",
+    "position",
+    "price",
+    "product_id",
+    "sku",
+    "taxable",
+    "title",
+    "updated_at"
+  ],
+  "type": "object"
+}

package/schemas/2026-01/variants/out_of_stock.json

@@ -0,0 +1,87 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "admin_graphql_api_id": {
+      "format": "uri",
+      "type": "string"
+    },
+    "barcode": {
+      "type": "null"
+    },
+    "compare_at_price": {
+      "type": "string"
+    },
+    "created_at": {
+      "format": "date-time",
+      "type": "string"
+    },
+    "id": {
+      "type": "integer"
+    },
+    "image_id": {
+      "type": "null"
+    },
+    "inventory_policy": {
+      "type": "string"
+    },
+    "inventory_quantity": {
+      "type": "integer"
+    },
+    "old_inventory_quantity": {
+      "type": "integer"
+    },
+    "option1": {
+      "type": "string"
+    },
+    "option2": {
+      "type": "null"
+    },
+    "option3": {
+      "type": "null"
+    },
+    "position": {
+      "type": "integer"
+    },
+    "price": {
+      "type": "string"
+    },
+    "product_id": {
+      "type": "integer"
+    },
+    "sku": {
+      "type": "null"
+    },
+    "taxable": {
+      "type": "boolean"
+    },
+    "title": {
+      "type": "string"
+    },
+    "updated_at": {
+      "format": "date-time",
+      "type": "string"
+    }
+  },
+  "required": [
+    "admin_graphql_api_id",
+    "barcode",
+    "compare_at_price",
+    "created_at",
+    "id",
+    "image_id",
+    "inventory_policy",
+    "inventory_quantity",
+    "old_inventory_quantity",
+    "option1",
+    "option2",
+    "option3",
+    "position",
+    "price",
+    "product_id",
+    "sku",
+    "taxable",
+    "title",
+    "updated_at"
+  ],
+  "type": "object"
+}

package/dist/src/anonymize-exemplars.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/src/anonymize-exemplars.js

@@ -1,51 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const json_infer_types_1 = require("@jsonhero/json-infer-types");
-const globby_1 = require("globby");
-const fs_extra_1 = __importDefault(require("fs-extra"));
-const traverse_1 = __importDefault(require("traverse"));
-const main = async () => {
-    const files = await (0, globby_1.globby)(path_1.default.join(__dirname, "../exemplars/**/*.json"));
-    console.log(`anonymizing ${files.length} files`);
-    for (const file of files) {
-        let json = await fs_extra_1.default.readJSON(file);
-        json = (0, traverse_1.default)(json).map(function (value) {
-            if (typeof value == "number") {
-                return Math.round(value) == value ? 123 : 123.456;
-            }
-            else if (typeof value == "string") {
-                const type = (0, json_infer_types_1.inferType)(value);
-                if ("format" in type && type.format) {
-                    switch (type.format.name) {
-                        case "email": {
-                            return "eallam@example.com";
-                        }
-                        case "date": {
-                            return "2016-05-25";
-                        }
-                        case "datetime": {
-                            return "2019-01-01 00:00:00.000Z";
-                        }
-                        case "uri": {
-                            return "https://www.example.com/";
-                        }
-                        case "ip": {
-                            return "192.168.0.1";
-                        }
-                    }
-                }
-                return "example string";
-            }
-            else {
-                return value;
-            }
-        });
-        await fs_extra_1.default.writeJSON(file, json, { spaces: 2 });
-    }
-    console.log("done");
-};
-void main();

package/dist/src/index.d.ts

@@ -1,9 +0,0 @@
-import { inferSchemaFromExamplePayload } from "./infer-schema";
-export { inferSchemaFromExamplePayload };
-export declare function getPackageRootDir(): string;
-/** Return a metadata blob from Shopify's docs describing a webhook topic */
-export declare function metadataForWebhook(apiVersion: string, topic: string): any;
-/** Return the inferred JSON schema describing a webhook payload */
-export declare function schemaForWebhook(apiVersion: string, topic: string): any;
-/** Return all the known webhook topics */
-export declare function allTopicsForVersion(apiVersion: string): string[];

package/dist/src/index.js

@@ -1,54 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.inferSchemaFromExamplePayload = 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"));
-const infer_schema_1 = require("./infer-schema");
-Object.defineProperty(exports, "inferSchemaFromExamplePayload", { enumerable: true, get: function () { return infer_schema_1.inferSchemaFromExamplePayload; } });
-const loaded = { metadatas: {}, schemas: {} };
-function getPackageRootDir() {
-    let currentDir = __dirname;
-    while (!fs_1.default.existsSync(path_1.default.join(currentDir, "package.json"))) {
-        currentDir = path_1.default.join(currentDir, "..");
-    }
-    return currentDir;
-}
-const rootDir = getPackageRootDir();
-for (const kind of ["metadatas", "schemas"]) {
-    const dir = `${rootDir}/${kind}`;
-    for (const version of fs_1.default.readdirSync(dir)) {
-        const root = {};
-        loaded[kind][version] = root;
-        const searchPath = `${dir}/${version}/`;
-        for (const file of fast_glob_1.default.sync(`${searchPath}**/*.json`)) {
-            const topic = file.replace(searchPath, "").replace(/\.json$/, "");
-            root[topic] = JSON.parse(fs_1.default.readFileSync(file, "utf-8"));
-        }
-    }
-}
-const getVersion = (obj, version) => {
-    const value = obj[version];
-    if (value)
-        return value;
-    throw new Error(`Unknown shopify api version ${version} in shopify-webhook-schemas package -- please pass a real version or regenerate the metadata`);
-};
-/** Return a metadata blob from Shopify's docs describing a webhook topic */
-function metadataForWebhook(apiVersion, topic) {
-    return getVersion(loaded.metadatas, apiVersion)[topic];
-}
-/** Return the inferred JSON schema describing a webhook payload */
-function schemaForWebhook(apiVersion, topic) {
-    return getVersion(loaded.schemas, apiVersion)[topic];
-}
-/** Return all the known webhook topics */
-function allTopicsForVersion(apiVersion) {
-    return Object.keys(getVersion(loaded.schemas, apiVersion));
-}

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

@@ -1,19 +0,0 @@
-export declare const getStartVersion: (date?: Date) => string;
-export type Error = {
-    message: string;
-    path: string;
-};
-export declare const inferSchemaFromExamplePayload: (version: string, examplePayload: Record<string, any>, metadata: {
-    name: string;
-}) => {
-    schema: any;
-    warnings: number;
-    errors: Error[];
-};
-export declare const manualExamples: [RegExp, Record<string, any>][];
-export declare const overrides: {
-    topics: string[];
-    schema: any;
-    required?: string[];
-    versions?: string[];
-}[];