@webstir-io/module-contract 0.2.0 → 0.3.0

package/dist/client-nav.d.ts

@@ -0,0 +1,19 @@
+/**
+ * The wire protocol between the client-nav feature and the backend runtime. Constants only, so a
+ * browser bundle can import them without the rest of the contract.
+ */
+export declare const CLIENT_NAV_HEADERS: {
+    /** Sent on every request client-nav makes itself. */
+    readonly request: 'x-webstir-client-nav';
+    /**
+     * Sent when client-nav can follow a redirect itself: the backend then answers a redirect with
+     * 204 and `location` instead of 3xx, so the destination keeps its #fragment.
+     */
+    readonly acceptLocation: 'x-webstir-accept-location';
+    /** Where to go next, in place of a redirect's Location. */
+    readonly location: 'x-webstir-location';
+    /** Identifies one form submission, so the same post sent again gets the first answer. */
+    readonly submission: 'x-webstir-submission';
+};
+/** The form field carrying the submission id when client-nav falls back to a normal post. */
+export declare const CLIENT_NAV_SUBMISSION_FIELD = "_webstir_submission";

package/dist/client-nav.js

@@ -0,0 +1,19 @@
+/**
+ * The wire protocol between the client-nav feature and the backend runtime. Constants only, so a
+ * browser bundle can import them without the rest of the contract.
+ */
+export const CLIENT_NAV_HEADERS = {
+    /** Sent on every request client-nav makes itself. */
+    request: 'x-webstir-client-nav',
+    /**
+     * Sent when client-nav can follow a redirect itself: the backend then answers a redirect with
+     * 204 and `location` instead of 3xx, so the destination keeps its #fragment.
+     */
+    acceptLocation: 'x-webstir-accept-location',
+    /** Where to go next, in place of a redirect's Location. */
+    location: 'x-webstir-location',
+    /** Identifies one form submission, so the same post sent again gets the first answer. */
+    submission: 'x-webstir-submission',
+};
+/** The form field carrying the submission id when client-nav falls back to a normal post. */
+export const CLIENT_NAV_SUBMISSION_FIELD = '_webstir_submission';

package/dist/index.d.ts

@@ -4554,3 +4554,4 @@ export { RENDER_PROGRAM_FILE, RENDER_PROGRAM_VERSION, renderFlashMessageSchema,
 export type { RenderFlashMessage, RenderNode, RenderPath, RenderProgram, RenderSourceLocation, } from './render-program.js';
 export { executeRenderProgram, programUsesCsrf, readRenderProgram, RENDER_CSRF_FIELD, RenderProgramError, prepareViewData, schemaDeclaresField, } from './render-execute.js';
 export type { ExecuteRenderProgramOptions, PreparedViewData } from './render-execute.js';
+export { CLIENT_NAV_HEADERS, CLIENT_NAV_SUBMISSION_FIELD } from './client-nav.js';

package/dist/index.js

@@ -234,3 +234,4 @@ export function createModule(definition) {
 export { fromTsRestRoute, fromTsRestRouter } from './adapters/ts-rest.js';
 export { RENDER_PROGRAM_FILE, RENDER_PROGRAM_VERSION, renderFlashMessageSchema, renderFlashSchema, renderNodeSchema, renderPathSchema, renderProgramSchema, renderSourceLocationSchema, } from './render-program.js';
 export { executeRenderProgram, programUsesCsrf, readRenderProgram, RENDER_CSRF_FIELD, RenderProgramError, prepareViewData, schemaDeclaresField, } from './render-execute.js';
+export { CLIENT_NAV_HEADERS, CLIENT_NAV_SUBMISSION_FIELD } from './client-nav.js';

package/dist/render-execute.js

@@ -2,6 +2,27 @@ import { RENDER_PROGRAM_VERSION, } from './render-program.js';
 export const RENDER_CSRF_FIELD = '_csrf';
 const SAFE_URL_SCHEMES = new Set(['http', 'https', 'mailto', 'tel']);
 const BLOCKED_URL = 'about:invalid';
+// ARIA attributes whose values include the tokens "true" and "false" (WAI-ARIA 1.2). The rest take
+// text or ids, where false still leaves the attribute out.
+const ARIA_TRUE_FALSE = new Set([
+    'aria-atomic',
+    'aria-busy',
+    'aria-checked',
+    'aria-current',
+    'aria-disabled',
+    'aria-expanded',
+    'aria-grabbed',
+    'aria-haspopup',
+    'aria-hidden',
+    'aria-invalid',
+    'aria-modal',
+    'aria-multiline',
+    'aria-multiselectable',
+    'aria-pressed',
+    'aria-readonly',
+    'aria-required',
+    'aria-selected',
+]);
 export class RenderProgramError extends Error {
     loc;
     constructor(loc, message) {
@@ -52,7 +73,11 @@ function run(nodes, data, scopes, options, out) {
             }
             case 'attr': {
                 const value = read(node.path, data, scopes);
-                if (value === true) {
+                // 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}"`);
+                }
+                else if (value === true) {
                     out.push(` ${node.name}`);
                 }
                 else if (value !== false && value !== null && value !== undefined) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webstir-io/module-contract",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Public contract definitions for Webstir frontend and backend module providers.",
   "type": "module",
   "main": "dist/index.js",
@@ -11,6 +11,11 @@
       "import": "./dist/index.js",
       "default": "./dist/index.js"
     },
+    "./client-nav": {
+      "types": "./dist/client-nav.d.ts",
+      "import": "./dist/client-nav.js",
+      "default": "./dist/client-nav.js"
+    },
     "./ts-rest": {
       "types": "./dist/adapters/ts-rest.d.ts",
       "import": "./dist/adapters/ts-rest.js",