npm - @zixcel/view-delivery-contracts - Versions diffs - 0.10.2 → 0.10.4 - Mend

@zixcel/view-delivery-contracts 0.10.2 → 0.10.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@zixcel/view-delivery-contracts",
-  "version": "0.10.2",
+  "version": "0.10.4",
   "type": "module",
   "license": "Apache-2.0",
   "description": "Bounded site delivery and per-source readiness over exact Projection contracts",
@@ -18,12 +18,9 @@
     }
   },
   "dependencies": {
-    "@zixcel/projection-contracts": "0.10.3",
+    "@zixcel/projection-contracts": "0.10.4",
     "@zixcel/interaction": "0.10.1"
   },
-  "scripts": {
-    "test": "node --test test/*.test.mjs"
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/zixcel/data-presentation.git",
@@ -33,5 +30,16 @@
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
+  },
+  "keywords": [
+    "typed-contracts",
+    "schema-validation",
+    "artifact-distribution",
+    "javascript"
+  ],
+  "scripts": {
+    "test": "node --test test/*.test.mts",
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc -p tsconfig.build.json --noEmit"
   }
-}
+}

package/src/index.d.mts CHANGED Viewed

@@ -1,44 +1,21 @@
-import type {Action, Json, ProjectionIdentity, SceneProjection} from '@zixcel/projection-contracts/client'
-export interface Submission {
-  readonly projectionKey:string
-  readonly projectionRevision:string
-  readonly sceneId:string
-  readonly actionId:string
-  readonly interactionRef:string
-  readonly generation:string
-  readonly inputContractRef:string
-  readonly values:Readonly<Record<string,string|boolean|number>>
+import type { Submission, Requirement, Readiness, Delivery } from './types.mjs';
+import type { SceneProjection } from '@zixcel/projection-contracts/client';
+export type * from './types.mjs';
+export declare const bounds: Readonly<{
+    documentBytes: 1048576;
+    assets: 8;
+    assetBytes: 1048576;
+    requirements: 16;
+    requestBytes: 32768;
+    requests: 16;
+    bodyMs: 5000;
+}>;
+export declare class DeliveryError extends Error {
+    readonly code: string;
+    constructor(code: string);
 }
-export interface OwnerFailure {
-  readonly owner:string
-  readonly operation:string
-  readonly code:string
-  readonly requirementRef:string
-  readonly detail:Json
-}
-export interface Setup {readonly id:string;readonly owner:string;readonly operation:string}
-export type Requirement =
-  | {readonly ref:string;readonly owner:string;readonly state:'Ready';readonly failure:null;readonly setup:null}
-  | {readonly ref:string;readonly owner:string;readonly state:'SetupRequired'|'Unavailable';readonly failure:OwnerFailure;readonly setup:Setup|null}
-export interface Readiness {
-  readonly state:'Ready'|'SetupRequired'|'Unavailable'
-  readonly requirements:readonly Requirement[]
-}
-export interface Asset {readonly path:string;readonly digest:string;readonly bytes:number;readonly kind:'script'|'style'}
-export interface Delivery {
-  readonly contract:string
-  readonly site:{readonly id:string;readonly revision:string}
-  readonly initial:ProjectionIdentity|null
-  readonly snapshot:SceneProjection|null
-  readonly readiness:Readiness
-  readonly assets:readonly Asset[]
-  readonly transport:{readonly path:'/api/projection-live';readonly classes:readonly ['STATE']}
-}
-export const bounds:Readonly<{documentBytes:1048576;assets:8;assetBytes:1048576;requirements:16;requestBytes:32768;requests:16;bodyMs:5000}>
-export class DeliveryError extends Error {readonly code:string;constructor(code:string)}
-export function validateSubmission(value:unknown):Submission
-export function inputAction(snapshot:SceneProjection,submission:Submission):Action
-export function requirement(value:unknown):Requirement
-export function readiness(refs:readonly string[],owners:readonly Requirement[]):Readiness
-export function validateDelivery(value:unknown,expectedContract?:string):Delivery
+export declare function validateSubmission(value: unknown): Submission;
+export declare function inputAction(snapshot: SceneProjection, submission: Submission): import("@zixcel/projection-contracts/client").Action;
+export declare function requirement(value: unknown): Requirement;
+export declare function readiness(refs: readonly string[], owners: readonly unknown[]): Readiness;
+export declare function validateDelivery(value: unknown, expectedContract?: string): Delivery;

package/src/index.mjs CHANGED Viewed

@@ -1,66 +1,113 @@
 // Snapshot delivery contracts: no framework, business policy, transport or renderer.
-import {canonical,shape,text,copy,frozen} from '@zixcel/projection-contracts/client'
-import {validateSnapshot} from '@zixcel/projection-contracts/client'
-import {validateInputValues} from '@zixcel/interaction/input'
-export const bounds=Object.freeze({documentBytes:1048576,assets:8,assetBytes:1048576,requirements:16,requestBytes:32768,requests:16,bodyMs:5000})
-export class DeliveryError extends Error {constructor(code){super(code);this.code=code}}
-const fail=code=>{throw new DeliveryError(code)}
-const list=(v,maximum)=>{if(!Array.isArray(v)||v.length>maximum)fail('DeliveryLimitExceeded');return v}
-export function validateSubmission(v){
- const fields=['projectionKey','projectionRevision','sceneId','actionId','interactionRef','generation','inputContractRef','values']
- if(!v||Object.getPrototypeOf(v)!==Object.prototype||Object.keys(v).length!==fields.length||fields.some(k=>!Object.hasOwn(v,k)))fail('InvalidInput')
- for(const k of fields.filter(k=>k!=='values'))if(typeof v[k]!=='string'||!v[k]||v[k].length>512)fail('InvalidInput')
- if(!v.values||Object.getPrototypeOf(v.values)!==Object.prototype||Object.keys(v.values).length>32||Object.values(v.values).some(x=>!['string','boolean','number'].includes(typeof x)||typeof x==='number'&&!Number.isFinite(x)))fail('InvalidInput')
- canonical(v,bounds.requestBytes);return v
+import { canonical, shape, text, copy, frozen } from '@zixcel/projection-contracts/client';
+import { validateSnapshot } from '@zixcel/projection-contracts/client';
+import { validateInputValues } from '@zixcel/interaction/input';
+export const bounds = Object.freeze({ documentBytes: 1048576, assets: 8, assetBytes: 1048576, requirements: 16, requestBytes: 32768, requests: 16, bodyMs: 5000 });
+export class DeliveryError extends Error {
+    code;
+    constructor(code) { super(code); this.code = code; }
 }
-export function inputAction(snapshot,submission){
- validateSubmission(submission);validateSnapshot(snapshot)
- if(snapshot.kind!=='Scene'||snapshot.key!==submission.sceneId||snapshot.revision!==submission.projectionRevision)fail('StaleSceneAction')
- const action=snapshot.data.actions.find(a=>a.id===submission.actionId),binding=action?.interaction
- if(!binding)fail('InteractionUnavailable')
- if(binding.ref!==submission.interactionRef||binding.generation!==submission.generation||binding.inputContractRef!==submission.inputContractRef)fail('StaleSceneAction')
- if(validateInputValues(binding.input,submission.values).length)fail('InvalidInput')
- return action
+function fail(code) { throw new DeliveryError(code); }
+const list = (v, maximum) => { if (!Array.isArray(v) || v.length > maximum)
+    fail('DeliveryLimitExceeded'); return v; };
+const object = (v, fields) => { shape(v, fields); return v; };
+export function validateSubmission(value) {
+    const fields = ['projectionKey', 'projectionRevision', 'sceneId', 'actionId', 'interactionRef', 'generation', 'inputContractRef', 'values'];
+    // Preserve the existing input refusal code rather than exposing field contents.
+    if (!value || Object.getPrototypeOf(value) !== Object.prototype || Object.keys(value).length !== fields.length || fields.some(k => !Object.hasOwn(value, k)))
+        fail('InvalidInput');
+    const v = value;
+    canonical(v, bounds.requestBytes); // Refuse accessor-backed input before reading fields.
+    for (const k of fields.filter(k => k !== 'values'))
+        if (typeof v[k] !== 'string' || !v[k] || v[k].length > 512)
+            fail('InvalidInput');
+    const values = v.values;
+    if (!values || Object.getPrototypeOf(values) !== Object.prototype || Object.keys(values).length > 32 || Object.values(values).some(x => !['string', 'boolean', 'number'].includes(typeof x) || typeof x === 'number' && !Number.isFinite(x)))
+        fail('InvalidInput');
+    return value;
 }
-export function requirement(v){
- shape(v,['ref','owner','state','failure','setup']);text(v.ref);text(v.owner)
- if(!['Ready','SetupRequired','Unavailable'].includes(v.state))fail('InvalidReadiness')
- if(v.state==='Ready'){if(v.failure!==null||v.setup!==null)fail('InvalidReadiness')}
- else{
-  shape(v.failure,['owner','operation','code','requirementRef','detail'])
-  for(const k of ['owner','operation','code','requirementRef'])text(v.failure[k])
-  if(v.failure.owner!==v.owner||v.failure.requirementRef!==v.ref)fail('InvalidReadiness')
-  canonical(v.failure.detail,32768)
-  if(v.setup!==null){shape(v.setup,['id','owner','operation']);for(const x of Object.values(v.setup))text(x)}
- }
- return frozen(copy(v))
+export function inputAction(snapshot, submission) {
+    validateSubmission(submission);
+    validateSnapshot(snapshot);
+    if (snapshot.kind !== 'Scene' || snapshot.key !== submission.sceneId || snapshot.revision !== submission.projectionRevision)
+        fail('StaleSceneAction');
+    const action = snapshot.data.actions.find(a => a.id === submission.actionId), binding = action?.interaction;
+    if (!binding)
+        fail('InteractionUnavailable');
+    if (binding.ref !== submission.interactionRef || binding.generation !== submission.generation || binding.inputContractRef !== submission.inputContractRef)
+        fail('StaleSceneAction');
+    if (validateInputValues(binding.input, submission.values).length)
+        fail('InvalidInput');
+    return action;
 }
-export function readiness(refs,owners){
- list(refs,bounds.requirements);list(owners,bounds.requirements)
- const inventory=owners.map(requirement)
- if(new Set(refs).size!==refs.length||new Set(inventory.map(v=>v.ref)).size!==inventory.length)fail('InvalidReadiness')
- const required=refs.map(ref=>{text(ref);const found=inventory.find(v=>v.ref===ref);if(!found)fail('UndeclaredRequirement');return found})
- return frozen({state:required.some(v=>v.state==='Unavailable')?'Unavailable':required.some(v=>v.state==='SetupRequired')?'SetupRequired':'Ready',requirements:required})
+export function requirement(value) {
+    const v = object(value, ['ref', 'owner', 'state', 'failure', 'setup']);
+    text(v.ref);
+    text(v.owner);
+    if (typeof v.state !== 'string' || !['Ready', 'SetupRequired', 'Unavailable'].includes(v.state))
+        fail('InvalidReadiness');
+    if (v.state === 'Ready') {
+        if (v.failure !== null || v.setup !== null)
+            fail('InvalidReadiness');
+    }
+    else {
+        const failure = object(v.failure, ['owner', 'operation', 'code', 'requirementRef', 'detail']);
+        for (const k of ['owner', 'operation', 'code', 'requirementRef'])
+            text(failure[k]);
+        if (failure.owner !== v.owner || failure.requirementRef !== v.ref)
+            fail('InvalidReadiness');
+        canonical(failure.detail, 32768);
+        if (v.setup !== null) {
+            const setup = object(v.setup, ['id', 'owner', 'operation']);
+            for (const x of Object.values(setup))
+                text(x);
+        }
+    }
+    return frozen(copy(v));
 }
-export function validateDelivery(v,expectedContract='zixcel/view-delivery/1'){
- canonical(v,bounds.documentBytes);shape(v,['contract','site','initial','snapshot','readiness','assets','transport'])
- if(typeof expectedContract!=='string'||!expectedContract||expectedContract.length>128||v.contract!==expectedContract)fail('InvalidDelivery')
- shape(v.site,['id','revision']);text(v.site.id);text(v.site.revision)
- if(!/^[a-f0-9]{64}$/.test(v.site.revision))fail('InvalidDelivery')
- if(v.snapshot===null){if(v.initial!==null)fail('InitialSnapshotMismatch')}
- else{
-  validateSnapshot(v.snapshot)
-  if(v.snapshot.kind!=='Scene'||canonical(v.initial)!==canonical({key:v.snapshot.key,revision:v.snapshot.revision,lineage:v.snapshot.lineage}))fail('InitialSnapshotMismatch')
- }
- shape(v.readiness,['state','requirements'])
- if(canonical(readiness(v.readiness.requirements.map(r=>r.ref),v.readiness.requirements))!==canonical(v.readiness))fail('InvalidReadiness')
- list(v.assets,bounds.assets)
- if(new Set(v.assets.map(a=>a.path)).size!==v.assets.length)fail('InvalidAsset')
- for(const a of v.assets){
-  shape(a,['path','digest','bytes','kind'])
-  if(!/^\/assets\/[a-zA-Z0-9._-]{1,100}$/.test(a.path)||!['script','style'].includes(a.kind)
-   ||!Number.isSafeInteger(a.bytes)||a.bytes<1||a.bytes>bounds.assetBytes||!/^[a-f0-9]{64}$/.test(a.digest))fail('InvalidAsset')
- }
- if(canonical(v.transport)!==canonical({path:'/api/projection-live',classes:['STATE']}))fail('InvalidDelivery')
- return frozen(copy(v))
+export function readiness(refs, owners) {
+    list(refs, bounds.requirements);
+    list(owners, bounds.requirements);
+    const inventory = owners.map(requirement);
+    if (new Set(refs).size !== refs.length || new Set(inventory.map(v => v.ref)).size !== inventory.length)
+        fail('InvalidReadiness');
+    const required = refs.map(ref => { text(ref); const found = inventory.find(v => v.ref === ref); if (!found)
+        fail('UndeclaredRequirement'); return found; });
+    return frozen({ state: required.some(v => v.state === 'Unavailable') ? 'Unavailable' : required.some(v => v.state === 'SetupRequired') ? 'SetupRequired' : 'Ready', requirements: required });
+}
+export function validateDelivery(value, expectedContract = 'zixcel/view-delivery/1') {
+    canonical(value, bounds.documentBytes);
+    const v = object(value, ['contract', 'site', 'initial', 'snapshot', 'readiness', 'assets', 'transport']);
+    if (typeof expectedContract !== 'string' || !expectedContract || expectedContract.length > 128 || v.contract !== expectedContract)
+        fail('InvalidDelivery');
+    const site = object(v.site, ['id', 'revision']);
+    text(site.id);
+    text(site.revision);
+    if (!/^[a-f0-9]{64}$/.test(text(site.revision)))
+        fail('InvalidDelivery');
+    if (v.snapshot === null) {
+        if (v.initial !== null)
+            fail('InitialSnapshotMismatch');
+    }
+    else {
+        const snapshot = validateSnapshot(v.snapshot);
+        if (snapshot.kind !== 'Scene' || canonical(v.initial) !== canonical({ key: snapshot.key, revision: snapshot.revision, lineage: snapshot.lineage }))
+            fail('InitialSnapshotMismatch');
+    }
+    const status = object(v.readiness, ['state', 'requirements']);
+    const requirements = list(status.requirements, bounds.requirements).map(requirement);
+    if (canonical(readiness(requirements.map(r => r.ref), requirements)) !== canonical(v.readiness))
+        fail('InvalidReadiness');
+    const assets = list(v.assets, bounds.assets).map(a => object(a, ['path', 'digest', 'bytes', 'kind']));
+    if (new Set(assets.map(a => a.path)).size !== assets.length)
+        fail('InvalidAsset');
+    for (const a of assets) {
+        shape(a, ['path', 'digest', 'bytes', 'kind']);
+        if (typeof a.path !== 'string' || !/^\/assets\/[a-zA-Z0-9._-]{1,100}$/.test(a.path) || typeof a.kind !== 'string' || !['script', 'style'].includes(a.kind)
+            || typeof a.bytes !== 'number' || !Number.isSafeInteger(a.bytes) || a.bytes < 1 || a.bytes > bounds.assetBytes || typeof a.digest !== 'string' || !/^[a-f0-9]{64}$/.test(a.digest))
+            fail('InvalidAsset');
+    }
+    if (canonical(v.transport) !== canonical({ path: '/api/projection-live', classes: ['STATE'] }))
+        fail('InvalidDelivery');
+    return frozen(copy(v));
 }

package/src/types.d.mts ADDED Viewed

@@ -0,0 +1,61 @@
+import type { Json, ProjectionIdentity, SceneProjection } from '@zixcel/projection-contracts/client';
+export interface Submission {
+    readonly projectionKey: string;
+    readonly projectionRevision: string;
+    readonly sceneId: string;
+    readonly actionId: string;
+    readonly interactionRef: string;
+    readonly generation: string;
+    readonly inputContractRef: string;
+    readonly values: Readonly<Record<string, string | boolean | number>>;
+}
+export interface OwnerFailure {
+    readonly owner: string;
+    readonly operation: string;
+    readonly code: string;
+    readonly requirementRef: string;
+    readonly detail: Json;
+}
+export interface Setup {
+    readonly id: string;
+    readonly owner: string;
+    readonly operation: string;
+}
+export type Requirement = {
+    readonly ref: string;
+    readonly owner: string;
+    readonly state: 'Ready';
+    readonly failure: null;
+    readonly setup: null;
+} | {
+    readonly ref: string;
+    readonly owner: string;
+    readonly state: 'SetupRequired' | 'Unavailable';
+    readonly failure: OwnerFailure;
+    readonly setup: Setup | null;
+};
+export interface Readiness {
+    readonly state: 'Ready' | 'SetupRequired' | 'Unavailable';
+    readonly requirements: readonly Requirement[];
+}
+export interface Asset {
+    readonly path: string;
+    readonly digest: string;
+    readonly bytes: number;
+    readonly kind: 'script' | 'style';
+}
+export interface Delivery {
+    readonly contract: string;
+    readonly site: {
+        readonly id: string;
+        readonly revision: string;
+    };
+    readonly initial: ProjectionIdentity | null;
+    readonly snapshot: SceneProjection | null;
+    readonly readiness: Readiness;
+    readonly assets: readonly Asset[];
+    readonly transport: {
+        readonly path: '/api/projection-live';
+        readonly classes: readonly ['STATE'];
+    };
+}

package/src/types.mjs ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};