@arkcit/engine-schema 0.3.0

package/README.md

@@ -0,0 +1,55 @@
+# @arkcit/engine-schema
+
+Canonical schema contract for the Arkcit platform.
+
+## Position In The Flow
+
+```text
+@arkcit/studio
+   ↓ authors schema JSON
+@arkcit/engine-schema
+   ↓ defines the canonical document shape
+@arkcit/engine-runtime
+@arkcit/engine-core
+@arkcit/engine-render-layer
+   ↓ consume the same contract
+@arkcit/engine*
+   ↓ adapt it to concrete targets
+@arkcit/*-ui
+```
+
+## What Goes In
+
+- node definitions
+- layout definitions
+- schema metadata
+- long-lived persisted document concerns
+
+## What Comes Out
+
+- portable schema types
+- shared node and layout contracts
+- the stable shape consumed by studio, engine layers, and adapters
+
+## Responsibilities
+
+- own the canonical schema contract
+- stay framework-neutral
+- protect persistence from target-specific forks
+
+## Do Not Put Here
+
+- JSX
+- DOM concepts
+- React Native widget semantics
+- Angular component details
+- authoring-only overlay state
+
+## Used By
+
+- `@arkcit/studio`
+- `@arkcit/engine-runtime`
+- `@arkcit/engine-core`
+- `@arkcit/engine-render-layer`
+- `@arkcit/engine`
+- all target adapters

package/dist/contracts.d.ts

@@ -0,0 +1,2 @@
+export { UIExprValue, UII18nValue, UINode, UINodeActionRef, UINodeEventName, UINodeLayout, UINodeProps, UIRefValue, UIRenderBindingMeta, UISchema, UISchemaNodeMeta, UIValue } from './index.js';
+import '@arkcit/engine-runtime';

package/dist/index.d.ts

@@ -0,0 +1,70 @@
+import { UIActionRef } from '@arkcit/engine-runtime';
+
+type UII18nValue = {
+    $t: string;
+    values?: Record<string, string | number>;
+    defaultValue?: string;
+};
+type UIRefValue = {
+    $ref: string;
+};
+type UIExprValue = {
+    $expr: string;
+};
+type UIValue = string | number | boolean | null | UII18nValue | UIRefValue | UIExprValue;
+type UINodeLayout = {
+    widthPct?: number;
+    heightPct?: number;
+    heightPx?: number;
+    colSpan?: number;
+    wrapperClassName?: string;
+    cardSection?: "header" | "body" | "footer";
+    wizardStep?: boolean;
+    wizardStepRole?: "title" | "description";
+    wizardContent?: boolean;
+    accordionItem?: boolean;
+    formRole?: "field" | "title" | "submit" | "reset" | "step" | "step-content" | "trigger" | "content";
+    tabId?: string;
+};
+type UIRenderBindingMeta = {
+    bindingEnabled?: boolean;
+    valueBindingKey?: string;
+    optionsBindingKey?: string;
+    useBindingData?: boolean;
+    entitiesBindingKey?: string;
+    videoBindingKey?: string;
+    mapBindingKey?: string;
+    productBindingKey?: string;
+    useTranslationKeys?: boolean;
+    tagContentTranslationKey?: string;
+    tagContentTranslationValue?: string;
+    hrefTranslationKey?: string;
+    hrefTranslationValue?: string;
+    mediaSource?: string;
+    mediaSrc?: string;
+    mediaAlt?: string;
+    rowsBindingKey?: string;
+    columnsBindingKey?: string;
+};
+type UISchemaNodeMeta = UIRenderBindingMeta;
+type UINodeActionRef = UIActionRef;
+type UINodeProps = Record<string, unknown> & {
+    layout?: UINodeLayout;
+    __studio?: UISchemaNodeMeta & Record<string, unknown>;
+};
+type UINodeEventName = "onClick" | "onChange" | "onSubmit" | "onOpenChange";
+type UINode = {
+    id: string;
+    type: string;
+    props?: UINodeProps;
+    children?: UINode[];
+    visibleIf?: unknown;
+    events?: Partial<Record<UINodeEventName, UINodeActionRef>>;
+};
+type UISchema = {
+    version: 1;
+    title?: string;
+    nodes: UINode[];
+};
+
+export type { UIExprValue, UII18nValue, UINode, UINodeActionRef, UINodeEventName, UINodeLayout, UINodeProps, UIRefValue, UIRenderBindingMeta, UISchema, UISchemaNodeMeta, UIValue };

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@arkcit/engine-schema",
+  "private": false,
+  "version": "0.3.0",
+  "type": "module",
+  "sideEffects": false,
+  "description": "Staging extraction package for Arkcit schema contracts.",
+  "license": "UNLICENSED",
+  "keywords": [
+    "arkcit",
+    "engine",
+    "schema",
+    "contracts"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Arkcit/ui-orchestrator.git"
+  },
+  "homepage": "https://github.com/Arkcit/ui-orchestrator",
+  "bugs": {
+    "url": "https://github.com/Arkcit/ui-orchestrator/issues"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./contracts": {
+      "types": "./dist/contracts.d.ts",
+      "import": "./dist/contracts.js",
+      "default": "./dist/contracts.js"
+    }
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "scripts": {
+    "build": "tsup --config tsup.config.ts",
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "test:smoke": "node tests/run-all.mjs",
+    "test": "npm run test:smoke"
+  },
+  "dependencies": {
+    "@arkcit/engine-runtime": "^0.3.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.5.1",
+    "typescript": "~5.9.3"
+  }
+}