shopify-webhook-schemas 0.1.2 → 0.1.4

package/Readme.md

@@ -2,15 +2,20 @@
 
 This repo contains inferred JSONSchemas for each Shopify webhook topic payload. Find them all in the `schemas` directory.
 
-### Usage from JavaScript
+They're built by scraping Shopify's example payloads in their docs as well as comparing to a bunch of anonymized example payloads in this repo.
 
-If you want to load the metadata or the json schemas programmatically from JS, you can do so with the exported functions from this library.
+Contributions to correct the types or add new examples of rare payloads are welcome!
+
+## Usage from JavaScript
+
+If you want to load the json schemas programmatically from JS, or the metadata objects that Shopify exposes under the hood, you can do so with the exported functions from this library.
 
 ```typescript
 import { metadataForWebhook, schemaForWebhook } from "shopify-webhook-schemas";
 
 // get the JSONSchema for a webhook payload
 const schema = schemaForWebhook("2024-04", "products/update");
+
 // returns {
 //   "$schema": "https://json-schema.org/draft/2020-12/schema",
 //   "type": "object",
@@ -26,6 +31,7 @@ const schema = schemaForWebhook("2024-04", "products/update");
 
 // get the metadata blob with an description and example payload that shopify puts in their docs
 const metadata = metadataForWebhook("2024-04", "products/update");
+
 // returns {
 // "access_scopes": [
 //   "products"
@@ -53,6 +59,12 @@ const topics = allTopicsForVersion("2024-04");
 // ...
 ```
 
+### Editorialization
+
+This repo includes some inferred types beyond what Shopify's docs offer based on observed data in the wild. Shopify's example payloads are the ground truth, but they often include `null` for field values, so we have to guess what the real type of the value is. If you believe there to be an error, please open a PR adjusting the overrides in `src/scrape.ts`.
+
 ### Refreshing
 
 Run `pnpm x src/scrape.ts` to re-scrape Shopify's docs. See `src/scrape.ts` for the logic and the overrides.
+
+Add new exemplars in in the `exemplars/` directory, and then run `pnpm x src/anonymize-exemplars.ts` to remove any PII.

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

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

package/dist/src/anonymize-exemplars.js

@@ -0,0 +1,51 @@
+"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.js

@@ -10,8 +10,8 @@ const fast_glob_1 = __importDefault(require("fast-glob"));
 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, '..');
+    while (!fs_1.default.existsSync(path_1.default.join(currentDir, "package.json"))) {
+        currentDir = path_1.default.join(currentDir, "..");
     }
     return currentDir;
 }
@@ -29,18 +29,24 @@ for (const kind of ["metadatas", "schemas"]) {
         }
     }
 }
+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 loaded.metadatas[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 loaded.schemas[apiVersion][topic];
+    return getVersion(loaded.schemas, apiVersion)[topic];
 }
 exports.schemaForWebhook = schemaForWebhook;
 /** Return all the known webhook topics */
 function allTopicsForVersion(apiVersion) {
-    return Object.keys(loaded.schemas[apiVersion]);
+    return Object.keys(getVersion(loaded.schemas, apiVersion));
 }
 exports.allTopicsForVersion = allTopicsForVersion;