@webstir-io/module-contract 0.5.0 → 0.7.0

package/dist/index.d.ts

@@ -1608,6 +1608,8 @@ export declare const routeDefinitionSchema: z.ZodObject<{
         mode?: "optional" | "required" | undefined;
         write?: boolean | undefined;
     }>>;
+    /** `required`: only a signed-in user reaches the route; others are sent to sign in. */
+    auth: z.ZodOptional<z.ZodEnum<["required"]>>;
     flash: z.ZodOptional<z.ZodObject<{
         consume: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
         publish: z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -2311,6 +2313,7 @@ export declare const routeDefinitionSchema: z.ZodObject<{
         mode?: "optional" | "required" | undefined;
         write?: boolean | undefined;
     } | undefined;
+    auth?: "required" | undefined;
     flash?: {
         consume?: string[] | undefined;
         publish?: {
@@ -2474,6 +2477,7 @@ export declare const routeDefinitionSchema: z.ZodObject<{
         mode?: "optional" | "required" | undefined;
         write?: boolean | undefined;
     } | undefined;
+    auth?: "required" | undefined;
     flash?: {
         consume?: string[] | undefined;
         publish?: {
@@ -2704,6 +2708,8 @@ export declare const viewDefinitionSchema: z.ZodObject<{
     summary: z.ZodOptional<z.ZodString>;
     description: z.ZodOptional<z.ZodString>;
     tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    /** `required`: only a signed-in user sees the page; others are sent to sign in. */
+    auth: z.ZodOptional<z.ZodEnum<["required"]>>;
     params: z.ZodOptional<z.ZodObject<{
         kind: z.ZodDefault<z.ZodEnum<["zod", "json-schema", "ts-rest"]>>;
         name: z.ZodString;
@@ -2746,6 +2752,7 @@ export declare const viewDefinitionSchema: z.ZodObject<{
     summary?: string | undefined;
     description?: string | undefined;
     tags?: string[] | undefined;
+    auth?: "required" | undefined;
     params?: {
         kind: "json-schema" | "ts-rest" | "zod";
         name: string;
@@ -2768,6 +2775,7 @@ export declare const viewDefinitionSchema: z.ZodObject<{
     summary?: string | undefined;
     description?: string | undefined;
     tags?: string[] | undefined;
+    auth?: "required" | undefined;
     params?: {
         kind?: "json-schema" | "ts-rest" | "zod" | undefined;
         name: string;
@@ -2909,6 +2917,8 @@ export declare const moduleManifestSchema: z.ZodObject<{
             mode?: "optional" | "required" | undefined;
             write?: boolean | undefined;
         }>>;
+        /** `required`: only a signed-in user reaches the route; others are sent to sign in. */
+        auth: z.ZodOptional<z.ZodEnum<["required"]>>;
         flash: z.ZodOptional<z.ZodObject<{
             consume: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
             publish: z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -3612,6 +3622,7 @@ export declare const moduleManifestSchema: z.ZodObject<{
             mode?: "optional" | "required" | undefined;
             write?: boolean | undefined;
         } | undefined;
+        auth?: "required" | undefined;
         flash?: {
             consume?: string[] | undefined;
             publish?: {
@@ -3775,6 +3786,7 @@ export declare const moduleManifestSchema: z.ZodObject<{
             mode?: "optional" | "required" | undefined;
             write?: boolean | undefined;
         } | undefined;
+        auth?: "required" | undefined;
         flash?: {
             consume?: string[] | undefined;
             publish?: {
@@ -3931,6 +3943,8 @@ export declare const moduleManifestSchema: z.ZodObject<{
         summary: z.ZodOptional<z.ZodString>;
         description: z.ZodOptional<z.ZodString>;
         tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        /** `required`: only a signed-in user sees the page; others are sent to sign in. */
+        auth: z.ZodOptional<z.ZodEnum<["required"]>>;
         params: z.ZodOptional<z.ZodObject<{
             kind: z.ZodDefault<z.ZodEnum<["zod", "json-schema", "ts-rest"]>>;
             name: z.ZodString;
@@ -3973,6 +3987,7 @@ export declare const moduleManifestSchema: z.ZodObject<{
         summary?: string | undefined;
         description?: string | undefined;
         tags?: string[] | undefined;
+        auth?: "required" | undefined;
         params?: {
             kind: "json-schema" | "ts-rest" | "zod";
             name: string;
@@ -3995,6 +4010,7 @@ export declare const moduleManifestSchema: z.ZodObject<{
         summary?: string | undefined;
         description?: string | undefined;
         tags?: string[] | undefined;
+        auth?: "required" | undefined;
         params?: {
             kind?: "json-schema" | "ts-rest" | "zod" | undefined;
             name: string;
@@ -4101,6 +4117,7 @@ export declare const moduleManifestSchema: z.ZodObject<{
             mode?: "optional" | "required" | undefined;
             write?: boolean | undefined;
         } | undefined;
+        auth?: "required" | undefined;
         flash?: {
             consume?: string[] | undefined;
             publish?: {
@@ -4257,6 +4274,7 @@ export declare const moduleManifestSchema: z.ZodObject<{
         summary?: string | undefined;
         description?: string | undefined;
         tags?: string[] | undefined;
+        auth?: "required" | undefined;
         params?: {
             kind: "json-schema" | "ts-rest" | "zod";
             name: string;
@@ -4323,6 +4341,7 @@ export declare const moduleManifestSchema: z.ZodObject<{
             mode?: "optional" | "required" | undefined;
             write?: boolean | undefined;
         } | undefined;
+        auth?: "required" | undefined;
         flash?: {
             consume?: string[] | undefined;
             publish?: {
@@ -4479,6 +4498,7 @@ export declare const moduleManifestSchema: z.ZodObject<{
         summary?: string | undefined;
         description?: string | undefined;
         tags?: string[] | undefined;
+        auth?: "required" | undefined;
         params?: {
             kind?: "json-schema" | "ts-rest" | "zod" | undefined;
             name: string;

package/dist/index.js

@@ -159,6 +159,8 @@ export const routeDefinitionSchema = z.object({
     interaction: routeInteractionKindSchema.optional(),
     requestHooks: z.array(requestHookReferenceSchema).optional(),
     session: routeSessionSchema.optional(),
+    /** `required`: only a signed-in user reaches the route; others are sent to sign in. */
+    auth: z.enum(['required']).optional(),
     flash: routeFlashSchema.optional(),
     form: routeFormSchema.optional(),
     fragment: routeFragmentSchema.optional(),
@@ -180,6 +182,8 @@ export const viewDefinitionSchema = z.object({
     summary: z.string().optional(),
     description: z.string().optional(),
     tags: z.array(z.string()).optional(),
+    /** `required`: only a signed-in user sees the page; others are sent to sign in. */
+    auth: z.enum(['required']).optional(),
     params: schemaReferenceSchema.optional(),
     data: schemaReferenceSchema.optional(),
     renderMode: z.enum(['ssg', 'ssr', 'spa']).optional(),

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.7.0",
   "description": "Public contract definitions for Webstir frontend and backend module providers.",
   "type": "module",
   "main": "dist/index.js",

package/schema/module-manifest.schema.json

@@ -146,6 +146,12 @@
                 },
                 "additionalProperties": false
               },
+              "auth": {
+                "type": "string",
+                "enum": [
+                  "required"
+                ]
+              },
               "flash": {
                 "type": "object",
                 "properties": {
@@ -479,6 +485,12 @@
                   "type": "string"
                 }
               },
+              "auth": {
+                "type": "string",
+                "enum": [
+                  "required"
+                ]
+              },
               "params": {
                 "$ref": "#/definitions/module-manifest/properties/routes/items/properties/input/properties/params"
               },

package/schema/route-definition.schema.json

@@ -75,6 +75,12 @@
           },
           "additionalProperties": false
         },
+        "auth": {
+          "type": "string",
+          "enum": [
+            "required"
+          ]
+        },
         "flash": {
           "type": "object",
           "properties": {

package/schema/view-definition.schema.json

@@ -28,6 +28,12 @@
             "type": "string"
           }
         },
+        "auth": {
+          "type": "string",
+          "enum": [
+            "required"
+          ]
+        },
         "params": {
           "type": "object",
           "properties": {