@notambourine/metafields 0.0.6 → 0.1.0

package/dist/type-check.d.ts

@@ -0,0 +1,14 @@
+import type { Registry } from './type-registry.js';
+export interface TypeDifference {
+    readonly kind: 'added' | 'removed' | 'changed';
+    readonly name: string;
+    readonly detail?: string;
+}
+export interface TypeCheck {
+    readonly version: string;
+    readonly matches: boolean;
+    readonly types: readonly TypeDifference[];
+    readonly owners: readonly TypeDifference[];
+}
+export declare function compareRegistry(registry: Registry): TypeCheck;
+//# sourceMappingURL=type-check.d.ts.map

package/dist/type-check.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-check.d.ts","sourceRoot":"","sources":["../src/type-check.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,QAAQ,EAAgB,MAAM,oBAAoB,CAAC;AAEjE,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;IAC/C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,SAAS,cAAc,EAAE,CAAC;IAC1C,QAAQ,CAAC,MAAM,EAAE,SAAS,cAAc,EAAE,CAAC;CAC5C;AAoCD,wBAAgB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAoB7D"}

package/dist/type-check.js

@@ -0,0 +1,61 @@
+// A difference on the generated API version means this release is stale; on another version,
+// the shipped table was never authoritative and upgrading cannot repair the mismatch.
+import { METAFIELD_OWNER_TYPES, METAFIELD_TYPES } from './metafield-types.js';
+function validationsOf(type) {
+    return type.supportedValidations.map((validation) => validation.name).sort();
+}
+// Only what the generated table actually carries. A field the generator drops is not a
+// difference this package can act on, and reporting it would be noise in someone else's CI.
+function changes(live, shipped) {
+    const differences = [];
+    if (live.category !== shipped.category) {
+        differences.push(`category ${shipped.category} -> ${live.category}`);
+    }
+    if (live.supportsDefinitionMigrations !== shipped.migratable) {
+        differences.push(`migratable ${String(shipped.migratable)} -> ${String(live.supportsDefinitionMigrations)}`);
+    }
+    const now = validationsOf(live);
+    const before = [...shipped.validations].sort();
+    const added = now.filter((name) => !before.includes(name));
+    const removed = before.filter((name) => !now.includes(name));
+    if (added.length > 0)
+        differences.push(`validations +${added.join(' +')}`);
+    if (removed.length > 0)
+        differences.push(`validations -${removed.join(' -')}`);
+    return differences;
+}
+function compareNames(live, shipped) {
+    const differences = [];
+    for (const name of [...live].sort()) {
+        if (!shipped.includes(name))
+            differences.push({ kind: 'added', name });
+    }
+    for (const name of [...shipped].sort()) {
+        if (!live.includes(name))
+            differences.push({ kind: 'removed', name });
+    }
+    return differences;
+}
+export function compareRegistry(registry) {
+    const shipped = METAFIELD_TYPES;
+    const types = [];
+    for (const type of [...registry.types].sort((a, b) => a.name.localeCompare(b.name))) {
+        const known = shipped[type.name];
+        if (!known) {
+            types.push({ kind: 'added', name: type.name });
+            continue;
+        }
+        const differences = changes(type, known);
+        if (differences.length > 0) {
+            types.push({ kind: 'changed', name: type.name, detail: differences.join(', ') });
+        }
+    }
+    const live = new Set(registry.types.map((type) => type.name));
+    for (const name of Object.keys(METAFIELD_TYPES).sort()) {
+        if (!live.has(name))
+            types.push({ kind: 'removed', name });
+    }
+    const owners = compareNames(registry.owners, METAFIELD_OWNER_TYPES);
+    return { version: registry.version, matches: types.length === 0 && owners.length === 0, types, owners };
+}
+//# sourceMappingURL=type-check.js.map

package/dist/type-check.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-check.js","sourceRoot":"","sources":["../src/type-check.ts"],"names":[],"mappings":"AAAA,6FAA6F;AAC7F,sFAAsF;AAEtF,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAA0B,MAAM,sBAAsB,CAAC;AAgBtG,SAAS,aAAa,CAAC,IAAkB;IACvC,OAAO,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;AAC/E,CAAC;AAED,uFAAuF;AACvF,4FAA4F;AAC5F,SAAS,OAAO,CAAC,IAAkB,EAAE,OAA0B;IAC7D,MAAM,WAAW,GAAa,EAAE,CAAC;IACjC,IAAI,IAAI,CAAC,QAAQ,KAAK,OAAO,CAAC,QAAQ,EAAE,CAAC;QACvC,WAAW,CAAC,IAAI,CAAC,YAAY,OAAO,CAAC,QAAQ,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IACvE,CAAC;IACD,IAAI,IAAI,CAAC,4BAA4B,KAAK,OAAO,CAAC,UAAU,EAAE,CAAC;QAC7D,WAAW,CAAC,IAAI,CAAC,cAAc,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,EAAE,CAAC,CAAC;IAC/G,CAAC;IACD,MAAM,GAAG,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IAChC,MAAM,MAAM,GAAG,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,CAAC;IAC/C,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7D,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,WAAW,CAAC,IAAI,CAAC,gBAAgB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC3E,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,WAAW,CAAC,IAAI,CAAC,gBAAgB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC/E,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,SAAS,YAAY,CAAC,IAAuB,EAAE,OAA0B;IACvE,MAAM,WAAW,GAAqB,EAAE,CAAC;IACzC,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;QACpC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,WAAW,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IACzE,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;QACvC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,WAAW,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACxE,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,QAAkB;IAChD,MAAM,OAAO,GAAkD,eAAe,CAAC;IAC/E,MAAM,KAAK,GAAqB,EAAE,CAAC;IACnC,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACpF,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;YAC/C,SAAS;QACX,CAAC;QACD,MAAM,WAAW,GAAG,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACzC,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACnF,CAAC;IACH,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9D,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;QACvD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7D,CAAC;IACD,MAAM,MAAM,GAAG,YAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IACpE,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AAC1G,CAAC"}

package/dist/type-registry.d.ts

@@ -0,0 +1,21 @@
+export interface RegistryType {
+    readonly name: string;
+    readonly category: string;
+    readonly supportsDefinitionMigrations: boolean;
+    readonly supportedValidations: readonly {
+        readonly name: string;
+        readonly type: string;
+    }[];
+}
+export interface Registry {
+    readonly version: string;
+    readonly types: readonly RegistryType[];
+    readonly owners: readonly string[];
+}
+export type RegistryFailure = 'unsupported-version' | 'unavailable';
+export declare class RegistryError extends Error {
+    readonly kind: RegistryFailure;
+    constructor(kind: RegistryFailure, message: string);
+}
+export declare function fetchRegistry(version: string): Promise<Registry>;
+//# sourceMappingURL=type-registry.d.ts.map

package/dist/type-registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-registry.d.ts","sourceRoot":"","sources":["../src/type-registry.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,4BAA4B,EAAE,OAAO,CAAC;IAC/C,QAAQ,CAAC,oBAAoB,EAAE,SAAS;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC5F;AAED,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,SAAS,YAAY,EAAE,CAAC;IACxC,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;CACpC;AAUD,MAAM,MAAM,eAAe,GAAG,qBAAqB,GAAG,aAAa,CAAC;AAEpE,qBAAa,aAAc,SAAQ,KAAK;IACtC,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;IAE/B,YAAY,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,EAIjD;CACF;AAwBD,wBAAsB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAetE"}

package/dist/type-registry.js

@@ -0,0 +1,48 @@
+// shopify.dev exposes Shopify's type registry without store credentials and rejects aged-out
+// API versions, so the same request supplies metadata and validates the version pin.
+const PROXY = 'https://shopify.dev/admin-graphql-direct-proxy';
+const TYPES_QUERY = '{ metafieldDefinitionTypes { name category supportsDefinitionMigrations supportedValidations { name type } } }';
+const OWNERS_QUERY = '{ __type(name: "MetafieldOwnerType") { enumValues { name } } }';
+export class RegistryError extends Error {
+    kind;
+    constructor(kind, message) {
+        super(message);
+        this.name = 'RegistryError';
+        this.kind = kind;
+    }
+}
+async function query(version, document) {
+    let response;
+    try {
+        response = await fetch(`${PROXY}/${version}`, {
+            method: 'POST',
+            headers: { 'content-type': 'application/json' },
+            body: JSON.stringify({ query: document }),
+        });
+    }
+    catch (error) {
+        throw new RegistryError('unavailable', `cannot reach shopify.dev: ${error instanceof Error ? error.message : String(error)}`);
+    }
+    const body = await response.json().catch(() => undefined);
+    // Read before the status: the refusal arrives as a 400 carrying {"error":"Invalid API version"}.
+    if (body?.error)
+        throw new RegistryError('unsupported-version', body.error);
+    if (!response.ok)
+        throw new RegistryError('unavailable', `proxy answered HTTP ${response.status}`);
+    if (!body?.data) {
+        throw new RegistryError('unavailable', `proxy returned no data: ${JSON.stringify(body?.errors)}`);
+    }
+    return body.data;
+}
+export async function fetchRegistry(version) {
+    const { metafieldDefinitionTypes } = await query(version, TYPES_QUERY);
+    const { __type: ownerEnum } = await query(version, OWNERS_QUERY);
+    if (!ownerEnum)
+        throw new RegistryError('unavailable', 'MetafieldOwnerType is missing from the schema');
+    return {
+        version,
+        types: metafieldDefinitionTypes,
+        owners: ownerEnum.enumValues.map((value) => value.name),
+    };
+}
+//# sourceMappingURL=type-registry.js.map

package/dist/type-registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-registry.js","sourceRoot":"","sources":["../src/type-registry.ts"],"names":[],"mappings":"AAAA,6FAA6F;AAC7F,qFAAqF;AAerF,MAAM,KAAK,GAAG,gDAAgD,CAAC;AAE/D,MAAM,WAAW,GACf,gHAAgH,CAAC;AACnH,MAAM,YAAY,GAAG,gEAAgE,CAAC;AAMtF,MAAM,OAAO,aAAc,SAAQ,KAAK;IAC7B,IAAI,CAAkB;IAE/B,YAAY,IAAqB,EAAE,OAAe;QAChD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED,KAAK,UAAU,KAAK,CAAI,OAAe,EAAE,QAAgB;IACvD,IAAI,QAAkB,CAAC;IACvB,IAAI,CAAC;QACH,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,KAAK,IAAI,OAAO,EAAE,EAAE;YAC5C,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;SAC1C,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,aAAa,CAAC,aAAa,EAAE,6BAA6B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAChI,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CACI,CAAC;IAC7D,iGAAiG;IACjG,IAAI,IAAI,EAAE,KAAK;QAAE,MAAM,IAAI,aAAa,CAAC,qBAAqB,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5E,IAAI,CAAC,QAAQ,CAAC,EAAE;QAAE,MAAM,IAAI,aAAa,CAAC,aAAa,EAAE,uBAAuB,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IACnG,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC;QAChB,MAAM,IAAI,aAAa,CAAC,aAAa,EAAE,2BAA2B,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;IACpG,CAAC;IACD,OAAO,IAAI,CAAC,IAAI,CAAC;AACnB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAAe;IACjD,MAAM,EAAE,wBAAwB,EAAE,GAAG,MAAM,KAAK,CAC9C,OAAO,EACP,WAAW,CACZ,CAAC;IACF,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,KAAK,CACvC,OAAO,EACP,YAAY,CACb,CAAC;IACF,IAAI,CAAC,SAAS;QAAE,MAAM,IAAI,aAAa,CAAC,aAAa,EAAE,+CAA+C,CAAC,CAAC;IACxG,OAAO;QACL,OAAO;QACP,KAAK,EAAE,wBAAwB;QAC/B,MAAM,EAAE,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;KACxD,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@notambourine/metafields",
-  "version": "0.0.6",
+  "version": "0.1.0",
   "description": "Create-only Shopify custom-data schema CLI",
   "type": "module",
   "license": "MIT",
@@ -31,7 +31,8 @@
   ],
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
-    "check": "npm run build && tsc -p test/tsconfig.json --noEmit && tsc -p test-d/tsconfig.json --noEmit",
+    "check": "npm run build && tsc -p test/tsconfig.json --noEmit && tsc -p test-d/tsconfig.json --noEmit && tsc -p scripts/tsconfig.json --noEmit",
+    "generate:metafield-types": "npm run build && node scripts/generate-metafield-types.ts",
     "test": "npm run build && node --test test/*.test.ts",
     "prepack": "npm run build"
   },