@shoplix-ai/sdui-schema 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Rastova
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/action.d.ts

@@ -0,0 +1,26 @@
+import { z } from 'zod';
+/**
+ * The closed action set for standalone tappable blocks. It doubles as the
+ * deep-link vocabulary for the future push composer. Cards inside bound
+ * lists navigate implicitly and never carry an action.
+ */
+export declare const actionSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"open_screen">;
+    screenId: z.ZodUUID;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"open_cart">;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"open_url">;
+    url: z.ZodURL;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"none">;
+}, z.core.$strip>], "type">;
+export type Action = z.infer<typeof actionSchema>;
+export type ActionType = Action['type'];
+/**
+ * One resolved value read back as an action, or nothing when it is not one.
+ * A setting a definition names may be absent from a placed block's props, and
+ * a renderer must draw nothing rather than run a guess.
+ */
+export declare function actionOf(value: unknown): Action | undefined;
+//# sourceMappingURL=action.d.ts.map

package/dist/action.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../src/action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;GAIG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;2BAUvB,CAAC;AAEH,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAClD,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;AAExC;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAG3D"}

package/dist/action.js

@@ -0,0 +1,27 @@
+import { z } from 'zod';
+/**
+ * The closed action set for standalone tappable blocks. It doubles as the
+ * deep-link vocabulary for the future push composer. Cards inside bound
+ * lists navigate implicitly and never carry an action.
+ */
+export const actionSchema = z.discriminatedUnion('type', [
+    z.object({ type: z.literal('open_screen'), screenId: z.uuid() }),
+    z.object({ type: z.literal('open_cart') }),
+    z.object({
+        type: z.literal('open_url'),
+        url: z
+            .url()
+            .refine((value) => value.startsWith('https://'), { message: 'external links must be https' }),
+    }),
+    z.object({ type: z.literal('none') }),
+]);
+/**
+ * One resolved value read back as an action, or nothing when it is not one.
+ * A setting a definition names may be absent from a placed block's props, and
+ * a renderer must draw nothing rather than run a guess.
+ */
+export function actionOf(value) {
+    const parsed = actionSchema.safeParse(value);
+    return parsed.success ? parsed.data : undefined;
+}
+//# sourceMappingURL=action.js.map

package/dist/action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"action.js","sourceRoot":"","sources":["../src/action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IACvD,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;IAChE,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;IAC1C,CAAC,CAAC,MAAM,CAAC;QACP,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;QAC3B,GAAG,EAAE,CAAC;aACH,GAAG,EAAE;aACL,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,EAAE,OAAO,EAAE,8BAA8B,EAAE,CAAC;KAChG,CAAC;IACF,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;CACtC,CAAC,CAAC;AAKH;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,MAAM,MAAM,GAAG,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC7C,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;AAClD,CAAC"}

package/dist/assets.d.ts

@@ -0,0 +1,80 @@
+import { z } from 'zod';
+import { type Block } from './blocks.js';
+/** One asset id a block carries, with the path of the prop that carries it. */
+export interface AssetReference {
+    readonly assetId: string;
+    readonly path: readonly (string | number)[];
+}
+/**
+ * Every asset id a block references. Owned here so the api never learns
+ * which prop of which block type carries an asset — a new asset-bearing
+ * block updates this walker in the same change.
+ */
+export declare function assetReferencesOf(block: Block): readonly AssetReference[];
+/** One picture a block cannot be published without, and does not have yet. */
+export interface MissingMedia {
+    readonly path: readonly (string | number)[];
+    /** What the merchant still has to choose, in their own words. */
+    readonly label: string;
+}
+/**
+ * The media a block needs before a buyer can see it. An image block with no
+ * picture is a fine draft and a broken screen, so this is what the publish
+ * gate asks, and never what a save asks.
+ */
+export declare function missingMediaOf(block: Block): readonly MissingMedia[];
+/**
+ * An editor holds half-filled media while the merchant works: alt text typed
+ * before the picture is chosen, a poster field opened and left empty. The
+ * document never carries a picture without an id, so those are dropped on the
+ * way out rather than saved as an empty one.
+ */
+export declare function withoutUnchosenMedia<T extends Block>(block: T): T;
+declare const assetRenditionSchema: z.ZodObject<{
+    url: z.ZodString;
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * How an envelope serves one referenced asset: URLs assembled from config
+ * plus rendition data at serve time — documents keep carrying ids only.
+ */
+export declare const assetDisplaySchema: z.ZodObject<{
+    kind: z.ZodEnum<{
+        image: "image";
+        video: "video";
+    }>;
+    url: z.ZodString;
+    width: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+    placeholder: z.ZodOptional<z.ZodString>;
+    dominantColor: z.ZodOptional<z.ZodString>;
+    durationMs: z.ZodOptional<z.ZodNumber>;
+    renditions: z.ZodArray<z.ZodObject<{
+        url: z.ZodString;
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const envelopeAssetsSchema: z.ZodDefault<z.ZodRecord<z.ZodUUID, z.ZodObject<{
+    kind: z.ZodEnum<{
+        image: "image";
+        video: "video";
+    }>;
+    url: z.ZodString;
+    width: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+    placeholder: z.ZodOptional<z.ZodString>;
+    dominantColor: z.ZodOptional<z.ZodString>;
+    durationMs: z.ZodOptional<z.ZodNumber>;
+    renditions: z.ZodArray<z.ZodObject<{
+        url: z.ZodString;
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>>>;
+export type AssetRendition = z.infer<typeof assetRenditionSchema>;
+export type AssetDisplay = z.infer<typeof assetDisplaySchema>;
+export type EnvelopeAssets = z.infer<typeof envelopeAssetsSchema>;
+export {};
+//# sourceMappingURL=assets.d.ts.map

package/dist/assets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assets.d.ts","sourceRoot":"","sources":["../src/assets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAe,KAAK,KAAK,EAAmB,MAAM,aAAa,CAAC;AAIvE,+EAA+E;AAC/E,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;CAC7C;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,cAAc,EAAE,CA0BzE;AAED,8EAA8E;AAC9E,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAC5C,iEAAiE;IACjE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,YAAY,EAAE,CAYpE;AAID;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,KAAK,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAkBjE;AAED,QAAA,MAAM,oBAAoB;;;;iBAIxB,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;iBAS7B,CAAC;AAEH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;mBAAqD,CAAC;AAEvF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAClE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAC9D,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC"}

package/dist/assets.js

@@ -0,0 +1,101 @@
+import { z } from 'zod';
+import { BLOCK_TYPES } from './blocks.js';
+const KNOWN_TYPES = new Set(BLOCK_TYPES);
+/**
+ * Every asset id a block references. Owned here so the api never learns
+ * which prop of which block type carries an asset — a new asset-bearing
+ * block updates this walker in the same change.
+ */
+export function assetReferencesOf(block) {
+    if (!KNOWN_TYPES.has(block.type))
+        return [];
+    const known = block;
+    switch (known.type) {
+        case 'image':
+            return known.props.image
+                ? [{ assetId: known.props.image.assetId, path: ['props', 'image', 'assetId'] }]
+                : [];
+        case 'video': {
+            const refs = [];
+            if (known.props.assetId) {
+                refs.push({ assetId: known.props.assetId, path: ['props', 'assetId'] });
+            }
+            if (known.props.poster) {
+                refs.push({ assetId: known.props.poster.assetId, path: ['props', 'poster', 'assetId'] });
+            }
+            return refs;
+        }
+        case 'hero_banner':
+        case 'promo_banner':
+            return known.props.image
+                ? [{ assetId: known.props.image.assetId, path: ['props', 'image', 'assetId'] }]
+                : [];
+        default:
+            return [];
+    }
+}
+/**
+ * The media a block needs before a buyer can see it. An image block with no
+ * picture is a fine draft and a broken screen, so this is what the publish
+ * gate asks, and never what a save asks.
+ */
+export function missingMediaOf(block) {
+    if (!KNOWN_TYPES.has(block.type))
+        return [];
+    const known = block;
+    switch (known.type) {
+        case 'image':
+        case 'promo_banner':
+            return known.props.image ? [] : [{ path: ['props', 'image'], label: 'an image' }];
+        case 'video':
+            return known.props.assetId ? [] : [{ path: ['props', 'assetId'], label: 'a video' }];
+        default:
+            return [];
+    }
+}
+/**
+ * An editor holds half-filled media while the merchant works: alt text typed
+ * before the picture is chosen, a poster field opened and left empty. The
+ * document never carries a picture without an id, so those are dropped on the
+ * way out rather than saved as an empty one.
+ */
+export function withoutUnchosenMedia(block) {
+    const props = block.props;
+    if (!props)
+        return block;
+    const cleaned = { ...props };
+    let changed = false;
+    for (const key of ['image', 'poster']) {
+        const ref = cleaned[key];
+        if (ref && !ref.assetId) {
+            delete cleaned[key];
+            changed = true;
+        }
+    }
+    if (cleaned.assetId === '') {
+        delete cleaned.assetId;
+        changed = true;
+    }
+    return changed ? { ...block, props: cleaned } : block;
+}
+const assetRenditionSchema = z.object({
+    url: z.string().min(1),
+    width: z.number().int().positive(),
+    height: z.number().int().positive(),
+});
+/**
+ * How an envelope serves one referenced asset: URLs assembled from config
+ * plus rendition data at serve time — documents keep carrying ids only.
+ */
+export const assetDisplaySchema = z.object({
+    kind: z.enum(['image', 'video']),
+    url: z.string().min(1),
+    width: z.number().int().positive().optional(),
+    height: z.number().int().positive().optional(),
+    placeholder: z.string().min(1).optional(),
+    dominantColor: z.string().min(1).optional(),
+    durationMs: z.number().int().positive().optional(),
+    renditions: z.array(assetRenditionSchema),
+});
+export const envelopeAssetsSchema = z.record(z.uuid(), assetDisplaySchema).default({});
+//# sourceMappingURL=assets.js.map

package/dist/assets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assets.js","sourceRoot":"","sources":["../src/assets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,WAAW,EAA+B,MAAM,aAAa,CAAC;AAEvE,MAAM,WAAW,GAAG,IAAI,GAAG,CAAS,WAAW,CAAC,CAAC;AAQjD;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAY;IAC5C,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;QAAE,OAAO,EAAE,CAAC;IAC5C,MAAM,KAAK,GAAG,KAAmB,CAAC;IAClC,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,OAAO;YACV,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK;gBACtB,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;gBAC/E,CAAC,CAAC,EAAE,CAAC;QACT,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,MAAM,IAAI,GAAqB,EAAE,CAAC;YAClC,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;gBACxB,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC;YAC1E,CAAC;YACD,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;gBACvB,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC;YAC3F,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,KAAK,aAAa,CAAC;QACnB,KAAK,cAAc;YACjB,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK;gBACtB,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;gBAC/E,CAAC,CAAC,EAAE,CAAC;QACT;YACE,OAAO,EAAE,CAAC;IACd,CAAC;AACH,CAAC;AASD;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,KAAY;IACzC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;QAAE,OAAO,EAAE,CAAC;IAC5C,MAAM,KAAK,GAAG,KAAmB,CAAC;IAClC,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,OAAO,CAAC;QACb,KAAK,cAAc;YACjB,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;QACpF,KAAK,OAAO;YACV,OAAO,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QACvF;YACE,OAAO,EAAE,CAAC;IACd,CAAC;AACH,CAAC;AAID;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAkB,KAAQ;IAC5D,MAAM,KAAK,GAAG,KAAK,CAAC,KAA4C,CAAC;IACjE,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC;IAEzB,MAAM,OAAO,GAA4B,EAAE,GAAG,KAAK,EAAE,CAAC;IACtD,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,KAAK,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAU,EAAE,CAAC;QAC/C,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAkB,CAAC;QAC1C,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACxB,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;YACpB,OAAO,GAAG,IAAI,CAAC;QACjB,CAAC;IACH,CAAC;IACD,IAAI,OAAO,CAAC,OAAO,KAAK,EAAE,EAAE,CAAC;QAC3B,OAAO,OAAO,CAAC,OAAO,CAAC;QACvB,OAAO,GAAG,IAAI,CAAC;IACjB,CAAC;IACD,OAAO,OAAO,CAAC,CAAC,CAAE,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,OAAO,EAAQ,CAAC,CAAC,CAAC,KAAK,CAAC;AAC/D,CAAC;AAED,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACtB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAClC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;CACpC,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAChC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACtB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC7C,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC9C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACzC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC3C,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAClD,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC;CAC1C,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,kBAAkB,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC"}

package/dist/binding.d.ts

@@ -0,0 +1,144 @@
+import { z } from 'zod';
+export declare const PRODUCT_SORT_KEYS: readonly ["collection_default", "best_selling", "newest", "price_asc", "price_desc", "title"];
+declare const productSortKeySchema: z.ZodEnum<{
+    collection_default: "collection_default";
+    best_selling: "best_selling";
+    newest: "newest";
+    price_asc: "price_asc";
+    price_desc: "price_desc";
+    title: "title";
+}>;
+/** The two ways a Binding names its target: a chosen entity, or the Screen Subject. */
+export declare const BINDING_TARGET_FORMS: readonly ["literal", "subject"];
+/**
+ * A Binding targets either a chosen entity (literal) or the Screen Subject.
+ * Whether a subject form is valid on a given screen kind is the validation
+ * ladder's call, driven by the block manifest.
+ */
+declare const entityTargetSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    form: z.ZodLiteral<"literal">;
+    id: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    form: z.ZodLiteral<"subject">;
+}, z.core.$strip>], "form">;
+export declare const productBindingSchema: z.ZodObject<{
+    kind: z.ZodLiteral<"product">;
+    target: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        form: z.ZodLiteral<"literal">;
+        id: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        form: z.ZodLiteral<"subject">;
+    }, z.core.$strip>], "form">;
+}, z.core.$strip>;
+/** The subject-only narrowing used by blocks welded to the Screen Subject. */
+export declare const subjectProductBindingSchema: z.ZodObject<{
+    kind: z.ZodLiteral<"product">;
+    target: z.ZodObject<{
+        form: z.ZodLiteral<"subject">;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/** The literal-only narrowing used by blocks that always pick their product. */
+export declare const literalProductBindingSchema: z.ZodObject<{
+    kind: z.ZodLiteral<"product">;
+    target: z.ZodObject<{
+        form: z.ZodLiteral<"literal">;
+        id: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const productsBindingSchema: z.ZodObject<{
+    kind: z.ZodLiteral<"products">;
+    selection: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        mode: z.ZodLiteral<"handpicked">;
+        ids: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>, z.ZodObject<{
+        mode: z.ZodLiteral<"collection">;
+        target: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            form: z.ZodLiteral<"literal">;
+            id: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            form: z.ZodLiteral<"subject">;
+        }, z.core.$strip>], "form">;
+        limit: z.ZodNumber;
+        sort: z.ZodEnum<{
+            collection_default: "collection_default";
+            best_selling: "best_selling";
+            newest: "newest";
+            price_asc: "price_asc";
+            price_desc: "price_desc";
+            title: "title";
+        }>;
+    }, z.core.$strip>], "mode">;
+}, z.core.$strip>;
+export declare const collectionBindingSchema: z.ZodObject<{
+    kind: z.ZodLiteral<"collection">;
+    target: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        form: z.ZodLiteral<"literal">;
+        id: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        form: z.ZodLiteral<"subject">;
+    }, z.core.$strip>], "form">;
+}, z.core.$strip>;
+export declare const collectionsBindingSchema: z.ZodObject<{
+    kind: z.ZodLiteral<"collections">;
+    ids: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * The four provider-silent Binding kinds. A Binding never names a data
+ * source; resolving it into display shapes is a Provider's job.
+ */
+export declare const bindingSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"product">;
+    target: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        form: z.ZodLiteral<"literal">;
+        id: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        form: z.ZodLiteral<"subject">;
+    }, z.core.$strip>], "form">;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"products">;
+    selection: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        mode: z.ZodLiteral<"handpicked">;
+        ids: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>, z.ZodObject<{
+        mode: z.ZodLiteral<"collection">;
+        target: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            form: z.ZodLiteral<"literal">;
+            id: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            form: z.ZodLiteral<"subject">;
+        }, z.core.$strip>], "form">;
+        limit: z.ZodNumber;
+        sort: z.ZodEnum<{
+            collection_default: "collection_default";
+            best_selling: "best_selling";
+            newest: "newest";
+            price_asc: "price_asc";
+            price_desc: "price_desc";
+            title: "title";
+        }>;
+    }, z.core.$strip>], "mode">;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"collection">;
+    target: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        form: z.ZodLiteral<"literal">;
+        id: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        form: z.ZodLiteral<"subject">;
+    }, z.core.$strip>], "form">;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"collections">;
+    ids: z.ZodArray<z.ZodString>;
+}, z.core.$strip>], "kind">;
+export type EntityTarget = z.infer<typeof entityTargetSchema>;
+export type BindingTargetForm = EntityTarget['form'];
+export type ProductSortKey = z.infer<typeof productSortKeySchema>;
+export type ProductBinding = z.infer<typeof productBindingSchema>;
+export type ProductsBinding = z.infer<typeof productsBindingSchema>;
+export type CollectionBinding = z.infer<typeof collectionBindingSchema>;
+export type CollectionsBinding = z.infer<typeof collectionsBindingSchema>;
+export type Binding = z.infer<typeof bindingSchema>;
+export type BindingKind = Binding['kind'];
+/** A JSON Schema for one Binding kind, for an editor completing a file that carries one. */
+export declare function describeBinding(kind: BindingKind): Record<string, unknown>;
+export {};
+//# sourceMappingURL=binding.d.ts.map

package/dist/binding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"binding.d.ts","sourceRoot":"","sources":["../src/binding.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,eAAO,MAAM,iBAAiB,+FAOpB,CAAC;AAEX,QAAA,MAAM,oBAAoB;;;;;;;EAA4B,CAAC;AAEvD,uFAAuF;AACvF,eAAO,MAAM,oBAAoB,iCAAkC,CAAC;AAEpE;;;;GAIG;AACH,QAAA,MAAM,kBAAkB;;;;;2BAGtB,CAAC;AAEH,eAAO,MAAM,oBAAoB;;;;;;;;iBAG/B,CAAC;AAEH,8EAA8E;AAC9E,eAAO,MAAM,2BAA2B;;;;;iBAGtC,CAAC;AAEH,gFAAgF;AAChF,eAAO,MAAM,2BAA2B;;;;;;iBAGtC,CAAC;AAEH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;iBAchC,CAAC;AAEH,eAAO,MAAM,uBAAuB;;;;;;;;iBAGlC,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;iBAGnC,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAKxB,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAC9D,MAAM,MAAM,iBAAiB,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;AACrD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAClE,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAClE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACpE,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AACpD,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAS1C,4FAA4F;AAC5F,wBAAgB,eAAe,CAAC,IAAI,EAAE,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAE1E"}

package/dist/binding.js

@@ -0,0 +1,80 @@
+import { z } from 'zod';
+const entityIdSchema = z.string().regex(/^\d+$/, 'expected a Shopify numeric id as a string');
+export const PRODUCT_SORT_KEYS = [
+    'collection_default',
+    'best_selling',
+    'newest',
+    'price_asc',
+    'price_desc',
+    'title',
+];
+const productSortKeySchema = z.enum(PRODUCT_SORT_KEYS);
+/** The two ways a Binding names its target: a chosen entity, or the Screen Subject. */
+export const BINDING_TARGET_FORMS = ['literal', 'subject'];
+/**
+ * A Binding targets either a chosen entity (literal) or the Screen Subject.
+ * Whether a subject form is valid on a given screen kind is the validation
+ * ladder's call, driven by the block manifest.
+ */
+const entityTargetSchema = z.discriminatedUnion('form', [
+    z.object({ form: z.literal('literal'), id: entityIdSchema }),
+    z.object({ form: z.literal('subject') }),
+]);
+export const productBindingSchema = z.object({
+    kind: z.literal('product'),
+    target: entityTargetSchema,
+});
+/** The subject-only narrowing used by blocks welded to the Screen Subject. */
+export const subjectProductBindingSchema = z.object({
+    kind: z.literal('product'),
+    target: z.object({ form: z.literal('subject') }),
+});
+/** The literal-only narrowing used by blocks that always pick their product. */
+export const literalProductBindingSchema = z.object({
+    kind: z.literal('product'),
+    target: z.object({ form: z.literal('literal'), id: entityIdSchema }),
+});
+export const productsBindingSchema = z.object({
+    kind: z.literal('products'),
+    selection: z.discriminatedUnion('mode', [
+        z.object({
+            mode: z.literal('handpicked'),
+            ids: z.array(entityIdSchema).min(1).max(24),
+        }),
+        z.object({
+            mode: z.literal('collection'),
+            target: entityTargetSchema,
+            limit: z.number().int().min(1).max(24),
+            sort: productSortKeySchema,
+        }),
+    ]),
+});
+export const collectionBindingSchema = z.object({
+    kind: z.literal('collection'),
+    target: entityTargetSchema,
+});
+export const collectionsBindingSchema = z.object({
+    kind: z.literal('collections'),
+    ids: z.array(entityIdSchema).min(1).max(24),
+});
+/**
+ * The four provider-silent Binding kinds. A Binding never names a data
+ * source; resolving it into display shapes is a Provider's job.
+ */
+export const bindingSchema = z.discriminatedUnion('kind', [
+    productBindingSchema,
+    productsBindingSchema,
+    collectionBindingSchema,
+    collectionsBindingSchema,
+]);
+const bindingSchemaByKind = {
+    product: productBindingSchema,
+    products: productsBindingSchema,
+    collection: collectionBindingSchema,
+    collections: collectionsBindingSchema,
+};
+/** A JSON Schema for one Binding kind, for an editor completing a file that carries one. */
+export function describeBinding(kind) {
+    return z.toJSONSchema(bindingSchemaByKind[kind], { unrepresentable: 'any' });
+}
+//# sourceMappingURL=binding.js.map

package/dist/binding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"binding.js","sourceRoot":"","sources":["../src/binding.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,2CAA2C,CAAC,CAAC;AAE9F,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,oBAAoB;IACpB,cAAc;IACd,QAAQ;IACR,WAAW;IACX,YAAY;IACZ,OAAO;CACC,CAAC;AAEX,MAAM,oBAAoB,GAAG,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;AAEvD,uFAAuF;AACvF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,SAAS,EAAE,SAAS,CAAU,CAAC;AAEpE;;;;GAIG;AACH,MAAM,kBAAkB,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IACtD,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,cAAc,EAAE,CAAC;IAC5D,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;CACzC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;IAC1B,MAAM,EAAE,kBAAkB;CAC3B,CAAC,CAAC;AAEH,8EAA8E;AAC9E,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;IAC1B,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;CACjD,CAAC,CAAC;AAEH,gFAAgF;AAChF,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;IAC1B,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,cAAc,EAAE,CAAC;CACrE,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;IAC3B,SAAS,EAAE,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;QACtC,CAAC,CAAC,MAAM,CAAC;YACP,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;YAC7B,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;SAC5C,CAAC;QACF,CAAC,CAAC,MAAM,CAAC;YACP,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;YAC7B,MAAM,EAAE,kBAAkB;YAC1B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;YACtC,IAAI,EAAE,oBAAoB;SAC3B,CAAC;KACH,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;IAC7B,MAAM,EAAE,kBAAkB;CAC3B,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;IAC9B,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;CAC5C,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IACxD,oBAAoB;IACpB,qBAAqB;IACrB,uBAAuB;IACvB,wBAAwB;CACzB,CAAC,CAAC;AAYH,MAAM,mBAAmB,GAAG;IAC1B,OAAO,EAAE,oBAAoB;IAC7B,QAAQ,EAAE,qBAAqB;IAC/B,UAAU,EAAE,uBAAuB;IACnC,WAAW,EAAE,wBAAwB;CAC7B,CAAC;AAEX,4FAA4F;AAC5F,MAAM,UAAU,eAAe,CAAC,IAAiB;IAC/C,OAAO,CAAC,CAAC,YAAY,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,EAAE,eAAe,EAAE,KAAK,EAAE,CAAC,CAAC;AAC/E,CAAC"}