@zixcel/projection-contracts 0.10.2 → 0.10.4

package/src/scene.d.mts

@@ -0,0 +1,4 @@
+import type { DataProjection, SceneProjection } from './types/snapshot.mjs';
+import type { SceneConfiguration } from './types/input.mjs';
+export declare function scene(data: DataProjection, configuration: SceneConfiguration): SceneProjection;
+export declare function buildScene(value: unknown, configuration: unknown): SceneProjection;

package/src/seal.d.mts

@@ -0,0 +1,6 @@
+import type { Snapshot } from './types/publication.mjs';
+type ForKind<K extends Snapshot['kind']> = Extract<Snapshot, {
+    kind: K;
+}>;
+export declare function seal<K extends Snapshot['kind']>(kind: K, key: string, lineage: ForKind<K>['lineage'], data: ForKind<K>['data'], maximum: number): ForKind<K>;
+export {};

package/src/snapshot.d.mts

@@ -0,0 +1,2 @@
+import type { Snapshot } from './types/publication.mjs';
+export declare function validateSnapshot(v: unknown): Snapshot;

package/src/source-items.d.mts

@@ -0,0 +1,4 @@
+import type { Item, Relation, SourceRef, Unresolved } from './types/snapshot.mjs';
+export declare function item(v: unknown, source: SourceRef): Item | null;
+export declare function unresolved(v: unknown, source: SourceRef): Unresolved;
+export declare function relation(v: unknown, source: SourceRef): Relation;

package/src/types/input.d.mts

@@ -1,24 +1,63 @@
 import type { Item, SourceRef, Unresolved, Relation, Region, Action } from './snapshot.mjs';
 /** Exact producer identity: no request-provided code or implicit latest revision. */
-export interface ProducerIdentity { readonly id: string; readonly version: string; readonly contract: string; readonly configuration: string }
-export interface ProjectionLimits { sources: number; items: number; relations: number; provenance: number; unresolved: number; regions: number; actions: number; snapshotBytes: number }
+export interface ProducerIdentity {
+    readonly id: string;
+    readonly version: string;
+    readonly contract: string;
+    readonly configuration: string;
+}
+export interface ProjectionLimits {
+    sources: number;
+    items: number;
+    relations: number;
+    provenance: number;
+    unresolved: number;
+    regions: number;
+    actions: number;
+    snapshotBytes: number;
+}
 export interface ProjectionRequest {
-  readonly key: string; readonly producer: ProducerIdentity; readonly sources: readonly SourceRef[];
-  readonly focus: string; readonly purpose: string; readonly visibilityRef: string; readonly limits: Partial<ProjectionLimits>;
+    readonly key: string;
+    readonly producer: ProducerIdentity;
+    readonly sources: readonly SourceRef[];
+    readonly focus: string;
+    readonly purpose: string;
+    readonly visibilityRef: string;
+    readonly limits: Partial<ProjectionLimits>;
 }
 export interface ExactSource {
-  readonly source: SourceRef; readonly items: readonly (Omit<Item, 'sourceRefs' | 'visibility'> & { readonly visibility: 'visible' | 'redacted' | 'omitted' })[];
-  readonly unresolved: readonly Omit<Unresolved, 'sourceRefs'>[];
-  readonly relations: readonly Omit<Relation, 'sourceRefs'>[]; readonly truncated: boolean;
+    readonly source: SourceRef;
+    readonly items: readonly (Omit<Item, 'sourceRefs' | 'visibility'> & {
+        readonly visibility: 'visible' | 'redacted' | 'omitted';
+    })[];
+    readonly unresolved: readonly Omit<Unresolved, 'sourceRefs'>[];
+    readonly relations: readonly Omit<Relation, 'sourceRefs'>[];
+    readonly truncated: boolean;
 }
 export interface SceneConfiguration {
-  readonly key: string; readonly focus: string; readonly purpose: string;
-  readonly regions: readonly Region[]; readonly actions: readonly Action[];
-  readonly temporal?: { readonly label: string; readonly items: readonly { readonly itemId: string; readonly valuePath: readonly string[]; readonly format: 'utcInstant' | 'unixMilliseconds' }[] };
-  readonly presentation?: readonly {
-    readonly itemId: string; readonly title?: string; readonly titlePath?: readonly string[];
-    readonly summaryPath?: readonly string[]; readonly symbol?: string;
-    readonly fields?: readonly { readonly label: string; readonly valuePath: readonly string[] }[];
-  }[];
+    readonly key: string;
+    readonly focus: string;
+    readonly purpose: string;
+    readonly regions: readonly Region[];
+    readonly actions: readonly Action[];
+    readonly temporal?: {
+        readonly label: string;
+        readonly items: readonly {
+            readonly itemId: string;
+            readonly valuePath: readonly string[];
+            readonly format: 'utcInstant' | 'unixMilliseconds';
+        }[];
+    };
+    readonly presentation?: readonly {
+        readonly itemId: string;
+        readonly title?: string;
+        readonly titlePath?: readonly string[];
+        readonly summaryPath?: readonly string[];
+        readonly symbol?: string;
+        readonly fields?: readonly {
+            readonly label: string;
+            readonly valuePath: readonly string[];
+        }[];
+    }[];
 }
 export type ReadExact = (source: SourceRef) => ExactSource | null;

package/src/types/publication.d.mts

@@ -0,0 +1,16 @@
+import type { DataProjection, SceneProjection } from './snapshot.mjs';
+import type { ProjectionRequest } from './input.mjs';
+export type Snapshot = DataProjection | SceneProjection;
+export interface PublicationTicket {
+    readonly key: string;
+    readonly expected: string;
+}
+export interface PublicationReceipt extends PublicationTicket {
+    readonly publication: string;
+    readonly revision: string;
+}
+export interface PendingRepair {
+    readonly ticket: PublicationTicket;
+    readonly request: ProjectionRequest;
+    readonly failure: 'ProjectionUnavailable' | 'ProjectionLimitExceeded';
+}

package/src/types/snapshot.d.mts

@@ -1,43 +1,117 @@
 import type { InputDeclaration } from '@zixcel/interaction/input';
 import type { ProducerIdentity, ProjectionRequest, SceneConfiguration } from './input.mjs';
-export type Json = null | boolean | number | string | readonly Json[] | { readonly [key: string]: Json };
-export interface SourceRef { readonly owner: string; readonly ref: string; readonly revision: string; readonly kind: string }
+export type Json = null | boolean | number | string | readonly Json[] | {
+    readonly [key: string]: Json;
+};
+export interface SourceRef {
+    readonly owner: string;
+    readonly ref: string;
+    readonly revision: string;
+    readonly kind: string;
+}
 export interface Item {
-  readonly id: string; readonly semanticRef: string | null;
-  readonly group: { readonly kind: 'semantic' | 'structural' | 'presentation'; readonly ref: string };
-  readonly value: Json; readonly evidence: readonly string[]; readonly provenance: readonly string[];
-  readonly resolutionRefs: readonly string[]; readonly visibility: 'visible' | 'redacted'; readonly sourceRefs: readonly SourceRef[];
+    readonly id: string;
+    readonly semanticRef: string | null;
+    readonly group: {
+        readonly kind: 'semantic' | 'structural' | 'presentation';
+        readonly ref: string;
+    };
+    readonly value: Json;
+    readonly evidence: readonly string[];
+    readonly provenance: readonly string[];
+    readonly resolutionRefs: readonly string[];
+    readonly visibility: 'visible' | 'redacted';
+    readonly sourceRefs: readonly SourceRef[];
 }
 export interface Unresolved {
-  readonly id: string; readonly reason: string; readonly evidence: readonly string[];
-  readonly contextRefs: readonly string[]; readonly actionRefs: readonly string[]; readonly sourceRefs: readonly SourceRef[];
+    readonly id: string;
+    readonly reason: string;
+    readonly evidence: readonly string[];
+    readonly contextRefs: readonly string[];
+    readonly actionRefs: readonly string[];
+    readonly sourceRefs: readonly SourceRef[];
 }
 export type RegionRole = 'Primary' | 'Context' | 'Interpretation' | 'Evidence' | 'Provenance' | 'Resolution' | 'Inspector' | 'Actions' | 'Activity';
-export interface Region { readonly id: string; readonly role: RegionRole; readonly itemIds: readonly string[] }
+export interface Region {
+    readonly id: string;
+    readonly role: RegionRole;
+    readonly itemIds: readonly string[];
+}
 export interface ProjectedInteraction {
-  readonly ref: string; readonly generation: string; readonly inputContractRef: string; readonly input: InputDeclaration;
+    readonly ref: string;
+    readonly generation: string;
+    readonly inputContractRef: string;
+    readonly input: InputDeclaration;
 }
 export interface Action {
-  readonly id: string; readonly targetOwner: string; readonly commandRef: string; readonly label: string;
-  readonly contextRefs: readonly string[]; readonly sourceRefs: readonly SourceRef[]; readonly interaction?: ProjectedInteraction;
+    readonly id: string;
+    readonly targetOwner: string;
+    readonly commandRef: string;
+    readonly label: string;
+    readonly contextRefs: readonly string[];
+    readonly sourceRefs: readonly SourceRef[];
+    readonly interaction?: ProjectedInteraction;
+}
+export interface Relation {
+    readonly id: string;
+    readonly from: string;
+    readonly to: string;
+    readonly relationRef: string;
+    readonly sourceRefs: readonly SourceRef[];
+}
+export interface SourceLineage {
+    readonly sources: readonly SourceRef[];
+    readonly producer: ProducerIdentity;
+    readonly request: ProjectionRequest;
+}
+export interface ProjectionIdentity {
+    readonly key: string;
+    readonly revision: string;
+    readonly lineage: SourceLineage;
 }
-export interface Relation { readonly id: string; readonly from: string; readonly to: string; readonly relationRef: string; readonly sourceRefs: readonly SourceRef[] }
-export interface SourceLineage { readonly sources: readonly SourceRef[]; readonly producer: ProducerIdentity; readonly request: ProjectionRequest }
-export interface ProjectionIdentity { readonly key: string; readonly revision: string; readonly lineage: SourceLineage }
 export interface ProjectionData {
-  readonly items: readonly Item[]; readonly unresolved: readonly Unresolved[]; readonly relations: readonly Relation[];
-  readonly truncated: boolean; readonly omittedByPolicy: number;
+    readonly items: readonly Item[];
+    readonly unresolved: readonly Unresolved[];
+    readonly relations: readonly Relation[];
+    readonly truncated: boolean;
+    readonly omittedByPolicy: number;
+}
+export interface DataProjection extends ProjectionIdentity {
+    readonly contract: 'projection/0.10.0';
+    readonly kind: 'Data';
+    readonly data: ProjectionData;
 }
-export interface DataProjection extends ProjectionIdentity { readonly contract: 'projection/0.10.0'; readonly kind: 'Data'; readonly data: ProjectionData }
 export interface SceneProjection extends ProjectionIdentity {
-  readonly contract: 'projection/0.10.0'; readonly kind: 'Scene';
-  readonly lineage: SourceLineage & { readonly dataProjection: { readonly key: string; readonly revision: string }; readonly sceneConfiguration: SceneConfiguration };
-  readonly data: ProjectionData & {
-    readonly regions: readonly Region[]; readonly actions: readonly Action[]; readonly focus: string; readonly purpose: string;
-    readonly temporal?: { readonly label: string; readonly items: readonly { readonly itemId: string; readonly at: string }[] };
-    readonly presentation?: readonly {
-      readonly itemId: string; readonly title: string; readonly summary?: string; readonly symbol?: string;
-      readonly fields?: readonly { readonly label: string; readonly value: string | number | boolean | null }[];
-    }[];
-  };
+    readonly contract: 'projection/0.10.0';
+    readonly kind: 'Scene';
+    readonly lineage: SourceLineage & {
+        readonly dataProjection: {
+            readonly key: string;
+            readonly revision: string;
+        };
+        readonly sceneConfiguration: SceneConfiguration;
+    };
+    readonly data: ProjectionData & {
+        readonly regions: readonly Region[];
+        readonly actions: readonly Action[];
+        readonly focus: string;
+        readonly purpose: string;
+        readonly temporal?: {
+            readonly label: string;
+            readonly items: readonly {
+                readonly itemId: string;
+                readonly at: string;
+            }[];
+        };
+        readonly presentation?: readonly {
+            readonly itemId: string;
+            readonly title: string;
+            readonly summary?: string;
+            readonly symbol?: string;
+            readonly fields?: readonly {
+                readonly label: string;
+                readonly value: string | number | boolean | null;
+            }[];
+        }[];
+    };
 }