@continuum-dev/contract 0.1.1-alpha.0

package/lib/view-definition.d.ts

@@ -0,0 +1,257 @@
+/**
+ * The root AST representing the AI-generated UI layout and structure.
+ * The AI owns this structure, while the user owns the corresponding DataSnapshot.
+ */
+export interface ViewDefinition {
+    /**
+     * Stable logical identity of the view family.
+     */
+    viewId: string;
+    /**
+     * View revision identifier for ordering and compatibility checks.
+     */
+    version: string;
+    /**
+     * Top-level nodes in render order.
+     */
+    nodes: ViewNode[];
+}
+/**
+ * Discriminated union of all supported view node types.
+ */
+export type ViewNode = FieldNode | GroupNode | CollectionNode | ActionNode | PresentationNode | RowNode | GridNode;
+/**
+ * Base properties shared by all nodes in the ViewDefinition tree.
+ */
+export interface BaseNode {
+    /**
+     * Required per-version structural identifier.
+     */
+    id: string;
+    /**
+     * Node discriminant.
+     */
+    type: string;
+    /**
+     * Optional semantic identity for cross-version data matching.
+     */
+    key?: string;
+    /**
+     * Optional visibility hint.
+     */
+    hidden?: boolean;
+    /**
+     * Structural fingerprint used to detect node-configuration changes.
+     */
+    hash?: string;
+    /**
+     * Rules for safely migrating data when node hashes change.
+     */
+    migrations?: MigrationRule[];
+}
+/**
+ * Select option for constrained field values.
+ */
+export interface FieldOption {
+    /**
+     * Canonical option value.
+     */
+    value: string;
+    /**
+     * User-facing option label.
+     */
+    label: string;
+}
+/**
+ * Data-bearing input node.
+ */
+export interface FieldNode extends BaseNode {
+    type: 'field';
+    /**
+     * Primitive value domain expected for this field.
+     */
+    dataType: 'string' | 'number' | 'boolean';
+    /**
+     * User-facing field label.
+     */
+    label?: string;
+    /**
+     * Placeholder hint for empty state.
+     */
+    placeholder?: string;
+    /**
+     * Optional helper text.
+     */
+    description?: string;
+    /**
+     * Disables user edits when true.
+     */
+    readOnly?: boolean;
+    /**
+     * Initial value before user interaction.
+     */
+    defaultValue?: unknown;
+    /**
+     * Optional validation constraints.
+     */
+    constraints?: FieldConstraints;
+    /**
+     * Optional list of allowed values.
+     */
+    options?: FieldOption[];
+}
+/**
+ * Structural container that groups child nodes.
+ */
+export interface GroupNode extends BaseNode {
+    type: 'group';
+    /**
+     * Optional group label.
+     */
+    label?: string;
+    /**
+     * Suggested layout strategy for rendering children.
+     */
+    layout?: 'vertical' | 'horizontal' | 'grid';
+    /**
+     * Optional column count when layout is grid-like.
+     */
+    columns?: number;
+    /**
+     * Child nodes in order.
+     */
+    children: ViewNode[];
+}
+/**
+ * Repeatable node pattern with a single item template.
+ */
+export interface CollectionNode extends BaseNode {
+    type: 'collection';
+    /**
+     * Optional collection label.
+     */
+    label?: string;
+    /**
+     * Template applied to each item.
+     */
+    template: ViewNode;
+    /**
+     * Minimum item count.
+     */
+    minItems?: number;
+    /**
+     * Maximum item count.
+     */
+    maxItems?: number;
+    /**
+     * Optional default payloads for initial items.
+     */
+    defaultValues?: Array<Record<string, unknown>>;
+}
+/**
+ * Trigger node that emits intents.
+ */
+export interface ActionNode extends BaseNode {
+    type: 'action';
+    /**
+     * Intent identifier emitted by this action.
+     */
+    intentId: string;
+    /**
+     * User-facing action text.
+     */
+    label: string;
+    /**
+     * Optional disabled state.
+     */
+    disabled?: boolean;
+}
+/**
+ * Read-only content node.
+ */
+export interface PresentationNode extends BaseNode {
+    type: 'presentation';
+    /**
+     * Rendering mode for content.
+     */
+    contentType: 'text' | 'markdown';
+    /**
+     * Raw content payload.
+     */
+    content: string;
+}
+/**
+ * Horizontal structural container.
+ */
+export interface RowNode extends BaseNode {
+    type: 'row';
+    /**
+     * Child nodes in order.
+     */
+    children: ViewNode[];
+}
+/**
+ * Grid structural container.
+ */
+export interface GridNode extends BaseNode {
+    type: 'grid';
+    /**
+     * Explicit column count for grid layout.
+     */
+    columns?: number;
+    /**
+     * Child nodes in order.
+     */
+    children: ViewNode[];
+}
+/**
+ * Portable field validation metadata.
+ */
+export interface FieldConstraints {
+    /**
+     * Whether a value is required.
+     */
+    required?: boolean;
+    /**
+     * Inclusive minimum for numeric values.
+     */
+    min?: number;
+    /**
+     * Inclusive maximum for numeric values.
+     */
+    max?: number;
+    /**
+     * Minimum string length.
+     */
+    minLength?: number;
+    /**
+     * Maximum string length.
+     */
+    maxLength?: number;
+    /**
+     * Regex pattern string for value validation.
+     */
+    pattern?: string;
+}
+/**
+ * Declares an allowed data-shape transition when a node changes structure.
+ */
+export interface MigrationRule {
+    /**
+     * Source node hash.
+     */
+    fromHash: string;
+    /**
+     * Destination node hash.
+     */
+    toHash: string;
+    /**
+     * Identifier matching a registered migration strategy.
+     */
+    strategyId?: string;
+}
+/**
+ * Returns child nodes for recursive traversal.
+ */
+export declare function getChildNodes(node: ViewNode): ViewNode[];
+//# sourceMappingURL=view-definition.d.ts.map

package/lib/view-definition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"view-definition.d.ts","sourceRoot":"","sources":["../../../../packages/contract/src/lib/view-definition.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,EAAE,QAAQ,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,GAChB,SAAS,GACT,SAAS,GACT,cAAc,GACd,UAAU,GACV,gBAAgB,GAChB,OAAO,GACP,QAAQ,CAAC;AAEb;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,UAAU,CAAC,EAAE,aAAa,EAAE,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,SAAU,SAAQ,QAAQ;IACzC,IAAI,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,QAAQ,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;IAC1C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,WAAW,CAAC,EAAE,gBAAgB,CAAC;IAC/B;;OAEG;IACH,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,SAAU,SAAQ,QAAQ;IACzC,IAAI,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,MAAM,CAAC;IAC5C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,QAAQ,EAAE,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,QAAQ;IAC9C,IAAI,EAAE,YAAY,CAAC;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,QAAQ;IAC1C,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,QAAQ;IAChD,IAAI,EAAE,cAAc,CAAC;IACrB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,UAAU,CAAC;IACjC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,OAAQ,SAAQ,QAAQ;IACvC,IAAI,EAAE,KAAK,CAAC;IACZ;;OAEG;IACH,QAAQ,EAAE,QAAQ,EAAE,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,QAAQ;IACxC,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,QAAQ,EAAE,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,QAAQ,GAAG,QAAQ,EAAE,CAQxD"}

package/lib/view-definition.js

@@ -0,0 +1,12 @@
+/**
+ * Returns child nodes for recursive traversal.
+ */
+export function getChildNodes(node) {
+    if (node.type === 'group' || node.type === 'row' || node.type === 'grid') {
+        return node.children;
+    }
+    if (node.type === 'collection') {
+        return [node.template];
+    }
+    return [];
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@continuum-dev/contract",
+  "version": "0.1.1-alpha.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "Type definitions and constants for the Continuum continuity runtime",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/brytoncooper/cooper-continuum.git",
+    "directory": "packages/contract"
+  },
+  "author": "CooperContinuum",
+  "keywords": [
+    "continuum",
+    "ai",
+    "ui",
+    "continuity",
+    "reconciliation",
+    "types"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "default": "./index.js"
+    }
+  },
+  "files": [
+    "**/*.js",
+    "**/*.d.ts",
+    "**/*.d.ts.map",
+    "README.md",
+    "CONTRACT_REFERENCE.md",
+    "LICENSE*"
+  ]
+}