@webstir-io/module-contract 0.5.0 → 0.6.0

package/dist/render-execute.js

@@ -73,6 +73,14 @@ function run(nodes, data, scopes, options, out) {
             }
             case 'attr': {
                 const value = read(node.path, data, scopes);
+                if (node.json) {
+                    // An island's props: the value as JSON, escaped like any attribute.
+                    if (value !== undefined) {
+                        const json = toJson(value, node.loc, `data-props="${node.path.source}"`);
+                        out.push(` ${node.name}="${escapeAttribute(json)}"`);
+                    }
+                    break;
+                }
                 // ARIA states are the words "true" and "false", not an attribute's presence.
                 if (typeof value === 'boolean' && ARIA_TRUE_FALSE.has(node.name.toLowerCase())) {
                     out.push(` ${node.name}="${value}"`);
@@ -133,6 +141,19 @@ function toText(value, loc, label) {
     }
     throw new RenderProgramError(loc, `${label} needs a string or number, got ${describe(value)}`);
 }
+function toJson(value, loc, label) {
+    let json;
+    try {
+        json = JSON.stringify(value);
+    }
+    catch (error) {
+        throw new RenderProgramError(loc, `${label} needs JSON data: ${error.message}`);
+    }
+    if (json === undefined) {
+        throw new RenderProgramError(loc, `${label} needs JSON data, got ${describe(value)}`);
+    }
+    return json;
+}
 /** Every URL in the value is checked: `srcset` lists candidates, `ping` lists URLs. */
 function safeAttributeUrl(name, value) {
     if (name === 'srcset' || name === 'imagesrcset') {

package/dist/render-program.d.ts

@@ -33,6 +33,8 @@ export type RenderNode = string | {
     readonly op: 'attr';
     readonly name: string;
     readonly url: boolean;
+    /** Writes the value as JSON (an island's `data-props`) rather than as text. */
+    readonly json?: boolean;
     readonly path: RenderPath;
     readonly loc: RenderSourceLocation;
 } | {
@@ -52,19 +54,19 @@ export type RenderNode = string | {
 };
 export declare const renderNodeSchema: z.ZodType<RenderNode>;
 export declare const renderProgramSchema: z.ZodObject<{
-    version: z.ZodLiteral<1>;
+    version: z.ZodLiteral<2>;
     page: z.ZodString;
     source: z.ZodString;
     bindings: z.ZodNumber;
     nodes: z.ZodArray<z.ZodType<RenderNode, z.ZodTypeDef, RenderNode>, "many">;
 }, "strip", z.ZodTypeAny, {
-    version: 1;
+    version: 2;
     page: string;
     source: string;
     bindings: number;
     nodes: RenderNode[];
 }, {
-    version: 1;
+    version: 2;
     page: string;
     source: string;
     bindings: number;

package/dist/render-program.js

@@ -17,6 +17,7 @@ export const renderNodeSchema = z.lazy(() => z.union([
         op: z.literal('attr'),
         name: z.string().min(1),
         url: z.boolean(),
+        json: z.boolean().optional(),
         path: renderPathSchema,
         loc: renderSourceLocationSchema,
     }),

package/dist/render-version.d.ts

@@ -1,2 +1,2 @@
-export declare const RENDER_PROGRAM_VERSION = 1;
+export declare const RENDER_PROGRAM_VERSION = 2;
 export declare const RENDER_PROGRAM_FILE = "index.program.json";

package/dist/render-version.js

@@ -1,2 +1,2 @@
-export const RENDER_PROGRAM_VERSION = 1;
+export const RENDER_PROGRAM_VERSION = 2;
 export const RENDER_PROGRAM_FILE = 'index.program.json';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webstir-io/module-contract",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Public contract definitions for Webstir frontend and backend module providers.",
   "type": "module",
   "main": "dist/index.js",