@arkcit/engine-core 0.3.0

package/README.md

@@ -0,0 +1,53 @@
+# @arkcit/engine-core
+
+Shared engine primitives and cross-adapter contracts.
+
+## Position In The Flow
+
+```text
+@arkcit/engine-schema
+        +
+@arkcit/engine-runtime
+        ↓
+@arkcit/engine-core
+        ↓
+@arkcit/engine-render-layer
+        ↓
+@arkcit/engine*
+        ↓
+framework adapters and UI libraries
+```
+
+## What Goes In
+
+- schema contracts
+- runtime contracts
+- shared engine semantics
+
+## What Comes Out
+
+- engine-neutral primitives
+- resolved-node related contracts
+- adapter-facing core types
+
+## Responsibilities
+
+- hold framework-neutral engine primitives
+- define shared cross-adapter contracts
+- keep the center of the engine stack portable
+
+## Do Not Put Here
+
+- direct React rendering
+- Angular templates
+- native widget instances
+- studio-only canvas behavior
+
+## Used By
+
+- `@arkcit/engine-render-layer`
+- `@arkcit/engine`
+- `@arkcit/engine-react`
+- `@arkcit/engine-angular`
+- `@arkcit/engine-react-native`
+- `@arkcit/*-ui`

package/dist/contracts.d.ts

@@ -0,0 +1,4 @@
+export { ComponentRegistry, ComponentRegistryEntry, ReactWebRendererProps, ResolvedNode, ResolvedNodeBase, ResolvedNodeChildDescriptor, ResolvedNodeContentDescriptor, RuntimeRenderInput, SchemaRenderInput, StudioAuthoringProps, UIEngineProps, UINodeDropPreview, UINodeDropState, UINodeDropTarget, UINodeSize, UINodeWrapperProps, createResolvedNode, createResolvedNodeBase } from './index.js';
+import 'react';
+import '@arkcit/engine-runtime';
+import '@arkcit/engine-schema';

package/dist/contracts.js

@@ -0,0 +1,32 @@
+// src/contracts/core.types.ts
+var createResolvedNodeBase = ({
+  node,
+  componentProps,
+  renderBindingProps,
+  childDescriptors,
+  childContentDescriptor
+}) => ({
+  node,
+  componentType: node.type,
+  componentProps,
+  renderBindingProps,
+  childDescriptors,
+  childContentDescriptor
+});
+var createResolvedNode = ({
+  contentPlans,
+  navigationPlans,
+  renderDirectivePlans,
+  finalRenderPlans,
+  ...base
+}) => ({
+  ...base,
+  contentPlans,
+  navigationPlans,
+  renderDirectivePlans,
+  finalRenderPlans
+});
+export {
+  createResolvedNode,
+  createResolvedNodeBase
+};

package/dist/index.d.ts

@@ -0,0 +1,134 @@
+import React from 'react';
+import { UIRuntime } from '@arkcit/engine-runtime';
+import { UINode, UISchema } from '@arkcit/engine-schema';
+
+type ComponentRegistryEntry = {
+    Component: React.ComponentType<Record<string, unknown>>;
+    meta?: {
+        editableProps?: string[];
+        editableTextProps?: string[];
+        editableEnumProps?: Record<string, string[]>;
+        editableBooleanProps?: string[];
+        editableNumberProps?: string[];
+        container?: boolean;
+        folder?: "primitives" | "patterns" | "overlays" | "media" | "domain" | "docs";
+        family?: string;
+    };
+};
+type ComponentRegistry = Record<string, ComponentRegistryEntry>;
+type UINodeWrapperProps = {
+    nodeId: string;
+    wrapperClassName?: string;
+    cursorClassName?: string;
+    isSelected: boolean;
+    allowDragHandle?: boolean;
+    allowResizeHandle?: boolean;
+    style?: React.CSSProperties;
+    onClick?: (event: React.MouseEvent<HTMLDivElement>) => void;
+    onDoubleClick?: (event: React.MouseEvent<HTMLDivElement>) => void;
+    onTouchStart?: (event: React.TouchEvent<HTMLDivElement>) => void;
+    onTouchMove?: (event: React.TouchEvent<HTMLDivElement>) => void;
+    onTouchEnd?: (event: React.TouchEvent<HTMLDivElement>) => void;
+    showResizeHandle: boolean;
+    onResizeMouseDown?: (event: React.MouseEvent<HTMLButtonElement>) => void;
+    isInlineEditing: boolean;
+    preserveContentWhileInlineEditing?: boolean;
+    children: React.ReactNode;
+    inlineEditor?: React.ReactNode;
+};
+type UINodeSize = {
+    widthPct: number;
+    heightPct: number;
+    heightPx?: number;
+};
+type UINodeDropTarget = {
+    nodeId: string;
+    position: "before" | "inside" | "after";
+    source: "canvas";
+};
+type UINodeDropPreview = {
+    width: number;
+    height: number;
+    label: string;
+};
+type UINodeDropState = {
+    visible: boolean;
+    active: boolean;
+    status: "valid" | "warning" | "invalid" | null;
+    preview: UINodeDropPreview | null;
+};
+type SchemaRenderInput = {
+    schema: UISchema;
+};
+type RuntimeRenderInput = {
+    store?: UIRuntime;
+};
+type ReactWebRendererProps = {
+    registry?: ComponentRegistry;
+};
+type StudioAuthoringProps = {
+    onNodeClick?: (nodeId: string) => void;
+    onInlineTextEdit?: (nodeId: string, propName: string, value: unknown) => void;
+    onNodeResize?: (nodeId: string, size: UINodeSize) => void;
+    onNodeResizeStart?: (nodeId: string) => void;
+    onNodeResizeEnd?: (nodeId: string, size: UINodeSize) => void;
+    onNodeDragStart?: (nodeId: string, event: React.DragEvent<HTMLElement>) => void;
+    onNodeDragEnd?: (event: React.DragEvent<HTMLElement>) => void;
+    onNodeDragSuspend?: () => void;
+    onNodeDragResume?: () => void;
+    onNodeDragOverTarget?: (target: UINodeDropTarget, event: React.DragEvent<HTMLElement>) => void;
+    onNodeDropTarget?: (target: UINodeDropTarget, event: React.DragEvent<HTMLElement>) => void;
+    getNodeDropState?: (target: UINodeDropTarget) => UINodeDropState;
+    selectedNodeId?: string | null;
+    nodeWrapper?: React.ComponentType<UINodeWrapperProps>;
+};
+type UIEngineProps = SchemaRenderInput & RuntimeRenderInput & ReactWebRendererProps & StudioAuthoringProps;
+type ResolvedNodeChildDescriptor = {
+    kind: "node";
+    child: UINode;
+} | {
+    kind: "grid-item";
+    child: UINode;
+    colSpan: number;
+};
+type ResolvedNodeContentDescriptor = {
+    kind: "empty";
+} | {
+    kind: "single";
+    child: ResolvedNodeChildDescriptor;
+} | {
+    kind: "list";
+    children: ResolvedNodeChildDescriptor[];
+};
+type ResolvedNodeBase = {
+    node: UINode;
+    componentType: string;
+    componentProps: Record<string, unknown>;
+    renderBindingProps: Record<string, unknown>;
+    childDescriptors: ResolvedNodeChildDescriptor[];
+    childContentDescriptor: ResolvedNodeContentDescriptor;
+};
+type ResolvedNode<TContentPlan = unknown, TNavigationPlan = unknown, TDirectivePlan = unknown, TFinalPlan = unknown> = ResolvedNodeBase & {
+    contentPlans: TContentPlan[];
+    navigationPlans: TNavigationPlan[];
+    renderDirectivePlans: TDirectivePlan[];
+    finalRenderPlans: TFinalPlan[];
+};
+declare const createResolvedNodeBase: ({ node, componentProps, renderBindingProps, childDescriptors, childContentDescriptor, }: Omit<ResolvedNodeBase, "componentType"> & {
+    componentType?: string;
+}) => {
+    node: UINode;
+    componentType: string;
+    componentProps: Record<string, unknown>;
+    renderBindingProps: Record<string, unknown>;
+    childDescriptors: ResolvedNodeChildDescriptor[];
+    childContentDescriptor: ResolvedNodeContentDescriptor;
+};
+declare const createResolvedNode: <TContentPlan = unknown, TNavigationPlan = unknown, TDirectivePlan = unknown, TFinalPlan = unknown>({ contentPlans, navigationPlans, renderDirectivePlans, finalRenderPlans, ...base }: ResolvedNodeBase & {
+    contentPlans: TContentPlan[];
+    navigationPlans: TNavigationPlan[];
+    renderDirectivePlans: TDirectivePlan[];
+    finalRenderPlans: TFinalPlan[];
+}) => ResolvedNode<TContentPlan, TNavigationPlan, TDirectivePlan, TFinalPlan>;
+
+export { type ComponentRegistry, type ComponentRegistryEntry, type ReactWebRendererProps, type ResolvedNode, type ResolvedNodeBase, type ResolvedNodeChildDescriptor, type ResolvedNodeContentDescriptor, type RuntimeRenderInput, type SchemaRenderInput, type StudioAuthoringProps, type UIEngineProps, type UINodeDropPreview, type UINodeDropState, type UINodeDropTarget, type UINodeSize, type UINodeWrapperProps, createResolvedNode, createResolvedNodeBase };

package/dist/index.js

@@ -0,0 +1,32 @@
+// src/contracts/core.types.ts
+var createResolvedNodeBase = ({
+  node,
+  componentProps,
+  renderBindingProps,
+  childDescriptors,
+  childContentDescriptor
+}) => ({
+  node,
+  componentType: node.type,
+  componentProps,
+  renderBindingProps,
+  childDescriptors,
+  childContentDescriptor
+});
+var createResolvedNode = ({
+  contentPlans,
+  navigationPlans,
+  renderDirectivePlans,
+  finalRenderPlans,
+  ...base
+}) => ({
+  ...base,
+  contentPlans,
+  navigationPlans,
+  renderDirectivePlans,
+  finalRenderPlans
+});
+export {
+  createResolvedNode,
+  createResolvedNodeBase
+};

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@arkcit/engine-core",
+  "private": false,
+  "version": "0.3.0",
+  "type": "module",
+  "sideEffects": false,
+  "description": "Workspace extraction candidate for Arkcit core contracts.",
+  "license": "UNLICENSED",
+  "keywords": [
+    "arkcit",
+    "engine",
+    "core",
+    "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-schema": "^0.3.0",
+    "@arkcit/engine-runtime": "^0.3.0"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0"
+  },
+  "devDependencies": {
+    "@types/react": "^19.2.5",
+    "tsup": "^8.5.1",
+    "typescript": "~5.9.3"
+  }
+}