ice-entity-designer-dsl 0.0.1

package/README.md

@@ -0,0 +1,70 @@
+# ice-entity-designer-dsl
+
+JSON-first ER DSL for AI agents to drive `ice-entity-designer` without learning the imperative canvas API.
+
+The package contains:
+
+- DSL types and schema
+- structural validator
+- compiler from DSL to Entity/Relation props
+- browser runtime that renders DSL through `ice-entity-designer`
+- browser example with a JSON editor
+
+## Install
+
+```bash
+npm install
+npm run build
+```
+
+## Browser usage
+
+```html
+<canvas id="canvas" width="1200" height="800"></canvas>
+
+<script src="node_modules/ice-entity-designer/dist/index.umd.js"></script>
+<script src="dist/index.umd.js"></script>
+<script>
+  const dsl = {
+    schemaVersion: 1,
+    layout: 'layered',
+    entities: [
+      { id: 'customer', name: 'Customer', fields: [{ name: 'id', type: 'number', primary: true }] },
+      { id: 'order', name: 'Order', fields: [{ name: 'id', type: 'number', primary: true }] },
+    ],
+    relations: [
+      { source: 'customer', target: 'order', type: 'one-to-many' },
+    ],
+  };
+
+  const { ice, designer } = ICEDSL.renderDsl('canvas', dsl);
+</script>
+```
+
+## Node/ESM usage
+
+```ts
+import { validateDsl, compileDsl, renderDsl } from 'ice-render-dsl';
+```
+
+## API
+
+- `validateDsl(dsl)`
+- `compileDsl(dsl)`
+- `renderDsl(canvasOrId, dsl)`
+- `DSL_SCHEMA_VERSION`
+
+## Example
+
+Open `examples/entity-editor-dsl.html` after building.
+
+## Agent discovery
+
+Agents can use this project through:
+
+1. npm package exports
+2. `AGENTS.md`
+3. `skills/ice-render-dsl/SKILL.md`
+4. optional MCP wrapper in a separate package
+
+The core runtime does not require MCP.

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("ice-entity-designer");function validateDsl(e){const t=[];if(!e||"object"!=typeof e||Array.isArray(e))return{valid:!1,errors:["DSL root must be an object"]};if(void 0!==e.schemaVersion&&1!==e.schemaVersion&&t.push("Unsupported schemaVersion: "+e.schemaVersion),Array.isArray(e.entities)){const i=new Set;e.entities.forEach((e,r)=>{const n=`entities[${r}]`;e&&"object"==typeof e?("string"==typeof e.id&&e.id.trim()?i.has(e.id)?t.push(`${n}.id is duplicated: ${e.id}`):i.add(e.id):t.push(n+".id must be a non-empty string"),Array.isArray(e.fields)?e.fields.forEach((e,i)=>{e&&"object"==typeof e&&"string"==typeof e.name&&e.name.trim()||t.push(`${n}.fields[${i}].name must be a non-empty string`)}):t.push(n+".fields must be an array")):t.push(n+" must be an object")})}else t.push("entities must be an array");return void 0===e.relations||Array.isArray(e.relations)?(e.relations||[]).forEach((e,i)=>{const r=`relations[${i}]`;e&&"object"==typeof e?("string"==typeof e.source&&e.source.trim()||t.push(r+".source must be a non-empty string"),"string"==typeof e.target&&e.target.trim()||t.push(r+".target must be a non-empty string")):t.push(r+" must be an object")}):t.push("relations must be an array"),{valid:0===t.length,errors:t}}function entityName(e){return e.entityName||e.name||e.id}function relationType(e){return e.relationType||e.type||"one-to-many"}function compileDsl(e){return{entities:e.entities.map(e=>({id:e.id,entityName:entityName(e),fields:e.fields||[],left:e.left,top:e.top,width:e.width,height:e.height,style:e.style,headerStyle:e.headerStyle,fieldStyle:e.fieldStyle,dividerStyle:e.dividerStyle,draggable:e.draggable,interactive:e.interactive})),relations:(e.relations||[]).map((e,t)=>({id:e.id||"relation-"+t,relationType:relationType(e),sourceId:e.source,targetId:e.target,sourceField:e.sourceField||"id",targetField:e.targetField||"id",nullable:e.nullable,onDelete:e.onDelete,onUpdate:e.onUpdate,joinTableName:e.joinTableName,fromKey:e.fromKey,toKey:e.toKey,sourceCardinality:e.sourceCardinality,targetCardinality:e.targetCardinality,label:e.label,style:e.style,arrow:e.arrow,linkShape:e.linkShape,routeType:e.routeType,routeOffset:e.routeOffset,curveType:e.curveType,lineDash:e.lineDash})),layout:e.layout,options:e.options}}exports.DSL_SCHEMA_VERSION=1,exports.compileDsl=compileDsl,exports.renderDsl=function renderDsl(t,i){const r=validateDsl(i);if(!r.valid)throw new Error(r.errors.join("\n"));const n=compileDsl(i),a=(new e.ICE).init(t),o=new e.EntityDesigner(a);if(n.entities.forEach(e=>{o.createEntity(e)}),function positionLinks(e,t){const i=new Map;return e.entities.forEach(e=>{i.set(e.state.id,e.getMinBoundingBox(!0))}),t.relations.map(e=>{const t=i.get(e.sourceId),r=i.get(e.targetId);let n="R",a="L";if(t&&r){const e=r.center[0]-t.center[0],i=r.center[1]-t.center[1];Math.abs(e)>Math.abs(i)?(n=e>=0?"R":"L",a=e>=0?"L":"R"):(n=i>=0?"B":"T",a=i>=0?"T":"B")}return{...e,routeType:e.routeType||"orthogonal",linkShape:e.linkShape||"visio",links:{start:{id:e.sourceId,position:n},end:{id:e.targetId,position:a}}}})}(o,n).forEach(e=>{o.createRelation(e)}),"layered"===n.layout||"horizontal"===n.layout){const t=n.options||{};new e.ICELayeredLayout({gapX:t.gapX||120,gapY:t.gapY||50}).layoutContainer(a)}return{ice:a,designer:o}},exports.validateDsl=validateDsl;

package/dist/index.mjs

@@ -0,0 +1 @@
+import{ICE as e,EntityDesigner as t,ICELayeredLayout as i}from"ice-entity-designer";const r=1;function validateDsl(e){const t=[];if(!e||"object"!=typeof e||Array.isArray(e))return{valid:!1,errors:["DSL root must be an object"]};if(void 0!==e.schemaVersion&&1!==e.schemaVersion&&t.push("Unsupported schemaVersion: "+e.schemaVersion),Array.isArray(e.entities)){const i=new Set;e.entities.forEach((e,r)=>{const n=`entities[${r}]`;e&&"object"==typeof e?("string"==typeof e.id&&e.id.trim()?i.has(e.id)?t.push(`${n}.id is duplicated: ${e.id}`):i.add(e.id):t.push(n+".id must be a non-empty string"),Array.isArray(e.fields)?e.fields.forEach((e,i)=>{e&&"object"==typeof e&&"string"==typeof e.name&&e.name.trim()||t.push(`${n}.fields[${i}].name must be a non-empty string`)}):t.push(n+".fields must be an array")):t.push(n+" must be an object")})}else t.push("entities must be an array");return void 0===e.relations||Array.isArray(e.relations)?(e.relations||[]).forEach((e,i)=>{const r=`relations[${i}]`;e&&"object"==typeof e?("string"==typeof e.source&&e.source.trim()||t.push(r+".source must be a non-empty string"),"string"==typeof e.target&&e.target.trim()||t.push(r+".target must be a non-empty string")):t.push(r+" must be an object")}):t.push("relations must be an array"),{valid:0===t.length,errors:t}}function entityName(e){return e.entityName||e.name||e.id}function relationType(e){return e.relationType||e.type||"one-to-many"}function compileDsl(e){return{entities:e.entities.map(e=>({id:e.id,entityName:entityName(e),fields:e.fields||[],left:e.left,top:e.top,width:e.width,height:e.height,style:e.style,headerStyle:e.headerStyle,fieldStyle:e.fieldStyle,dividerStyle:e.dividerStyle,draggable:e.draggable,interactive:e.interactive})),relations:(e.relations||[]).map((e,t)=>({id:e.id||"relation-"+t,relationType:relationType(e),sourceId:e.source,targetId:e.target,sourceField:e.sourceField||"id",targetField:e.targetField||"id",nullable:e.nullable,onDelete:e.onDelete,onUpdate:e.onUpdate,joinTableName:e.joinTableName,fromKey:e.fromKey,toKey:e.toKey,sourceCardinality:e.sourceCardinality,targetCardinality:e.targetCardinality,label:e.label,style:e.style,arrow:e.arrow,linkShape:e.linkShape,routeType:e.routeType,routeOffset:e.routeOffset,curveType:e.curveType,lineDash:e.lineDash})),layout:e.layout,options:e.options}}function renderDsl(r,n){const a=validateDsl(n);if(!a.valid)throw new Error(a.errors.join("\n"));const o=compileDsl(n),s=(new e).init(r),l=new t(s);if(o.entities.forEach(e=>{l.createEntity(e)}),function positionLinks(e,t){const i=new Map;return e.entities.forEach(e=>{i.set(e.state.id,e.getMinBoundingBox(!0))}),t.relations.map(e=>{const t=i.get(e.sourceId),r=i.get(e.targetId);let n="R",a="L";if(t&&r){const e=r.center[0]-t.center[0],i=r.center[1]-t.center[1];Math.abs(e)>Math.abs(i)?(n=e>=0?"R":"L",a=e>=0?"L":"R"):(n=i>=0?"B":"T",a=i>=0?"T":"B")}return{...e,routeType:e.routeType||"orthogonal",linkShape:e.linkShape||"visio",links:{start:{id:e.sourceId,position:n},end:{id:e.targetId,position:a}}}})}(l,o).forEach(e=>{l.createRelation(e)}),"layered"===o.layout||"horizontal"===o.layout){const e=o.options||{};new i({gapX:e.gapX||120,gapY:e.gapY||50}).layoutContainer(s)}return{ice:s,designer:l}}export{r as DSL_SCHEMA_VERSION,compileDsl,renderDsl,validateDsl};

package/dist/index.umd.js

@@ -0,0 +1 @@
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports,require("ice-entity-designer")):"function"==typeof define&&define.amd?define(["exports","ice-entity-designer"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).ICEDSL={},e.IED)}(this,(function(e,t){"use strict";function validateDsl(e){const t=[];if(!e||"object"!=typeof e||Array.isArray(e))return{valid:!1,errors:["DSL root must be an object"]};if(void 0!==e.schemaVersion&&1!==e.schemaVersion&&t.push("Unsupported schemaVersion: "+e.schemaVersion),Array.isArray(e.entities)){const i=new Set;e.entities.forEach((e,r)=>{const n=`entities[${r}]`;e&&"object"==typeof e?("string"==typeof e.id&&e.id.trim()?i.has(e.id)?t.push(`${n}.id is duplicated: ${e.id}`):i.add(e.id):t.push(n+".id must be a non-empty string"),Array.isArray(e.fields)?e.fields.forEach((e,i)=>{e&&"object"==typeof e&&"string"==typeof e.name&&e.name.trim()||t.push(`${n}.fields[${i}].name must be a non-empty string`)}):t.push(n+".fields must be an array")):t.push(n+" must be an object")})}else t.push("entities must be an array");return void 0===e.relations||Array.isArray(e.relations)?(e.relations||[]).forEach((e,i)=>{const r=`relations[${i}]`;e&&"object"==typeof e?("string"==typeof e.source&&e.source.trim()||t.push(r+".source must be a non-empty string"),"string"==typeof e.target&&e.target.trim()||t.push(r+".target must be a non-empty string")):t.push(r+" must be an object")}):t.push("relations must be an array"),{valid:0===t.length,errors:t}}function entityName(e){return e.entityName||e.name||e.id}function relationType(e){return e.relationType||e.type||"one-to-many"}function compileDsl(e){return{entities:e.entities.map(e=>({id:e.id,entityName:entityName(e),fields:e.fields||[],left:e.left,top:e.top,width:e.width,height:e.height,style:e.style,headerStyle:e.headerStyle,fieldStyle:e.fieldStyle,dividerStyle:e.dividerStyle,draggable:e.draggable,interactive:e.interactive})),relations:(e.relations||[]).map((e,t)=>({id:e.id||"relation-"+t,relationType:relationType(e),sourceId:e.source,targetId:e.target,sourceField:e.sourceField||"id",targetField:e.targetField||"id",nullable:e.nullable,onDelete:e.onDelete,onUpdate:e.onUpdate,joinTableName:e.joinTableName,fromKey:e.fromKey,toKey:e.toKey,sourceCardinality:e.sourceCardinality,targetCardinality:e.targetCardinality,label:e.label,style:e.style,arrow:e.arrow,linkShape:e.linkShape,routeType:e.routeType,routeOffset:e.routeOffset,curveType:e.curveType,lineDash:e.lineDash})),layout:e.layout,options:e.options}}e.DSL_SCHEMA_VERSION=1,e.compileDsl=compileDsl,e.renderDsl=function renderDsl(e,i){const r=validateDsl(i);if(!r.valid)throw new Error(r.errors.join("\n"));const n=compileDsl(i),o=(new t.ICE).init(e),a=new t.EntityDesigner(o);if(n.entities.forEach(e=>{a.createEntity(e)}),function positionLinks(e,t){const i=new Map;return e.entities.forEach(e=>{i.set(e.state.id,e.getMinBoundingBox(!0))}),t.relations.map(e=>{const t=i.get(e.sourceId),r=i.get(e.targetId);let n="R",o="L";if(t&&r){const e=r.center[0]-t.center[0],i=r.center[1]-t.center[1];Math.abs(e)>Math.abs(i)?(n=e>=0?"R":"L",o=e>=0?"L":"R"):(n=i>=0?"B":"T",o=i>=0?"T":"B")}return{...e,routeType:e.routeType||"orthogonal",linkShape:e.linkShape||"visio",links:{start:{id:e.sourceId,position:n},end:{id:e.targetId,position:o}}}})}(a,n).forEach(e=>{a.createRelation(e)}),"layered"===n.layout||"horizontal"===n.layout){const e=n.options||{};new t.ICELayeredLayout({gapX:e.gapX||120,gapY:e.gapY||50}).layoutContainer(o)}return{ice:o,designer:a}},e.validateDsl=validateDsl,Object.defineProperty(e,"__esModule",{value:!0})}));

package/dist/types/compiler/dslToScene.d.ts

@@ -0,0 +1,8 @@
+import type { DslDocument } from '../types';
+export declare type CompiledScene = {
+    entities: Array<Record<string, any>>;
+    relations: Array<Record<string, any>>;
+    layout?: string;
+    options?: Record<string, any>;
+};
+export declare function compileDsl(dsl: DslDocument): CompiledScene;

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from './types';
+export { DSL_SCHEMA_VERSION, validateDsl } from './validate';
+export { compileDsl } from './compiler/dslToScene';
+export type { CompiledScene } from './compiler/dslToScene';
+export { renderDsl } from './runtime/renderDsl';
+export type { RenderDslResult } from './runtime/renderDsl';

package/dist/types/runtime/renderDsl.d.ts

@@ -0,0 +1,6 @@
+import type { DslDocument } from '../types';
+export declare type RenderDslResult = {
+    ice: any;
+    designer: any;
+};
+export declare function renderDsl(canvasOrId: any, dsl: DslDocument): RenderDslResult;

package/dist/types/types.d.ts

@@ -0,0 +1,73 @@
+export declare type DslRelationType = 'one-to-many' | 'many-to-one' | 'one-to-one' | 'many-to-many';
+export declare type DslField = {
+    name: string;
+    type?: string;
+    length?: number | string;
+    primary?: boolean;
+    foreignKey?: boolean;
+    generated?: boolean;
+    autoIncrement?: boolean;
+    nullable?: boolean;
+    unique?: boolean;
+    default?: any;
+    comment?: string;
+    index?: boolean;
+};
+export declare type DslEntity = {
+    id: string;
+    name?: string;
+    entityName?: string;
+    fields?: DslField[];
+    left?: number;
+    top?: number;
+    width?: number;
+    height?: number;
+    style?: Record<string, any>;
+    headerStyle?: Record<string, any>;
+    fieldStyle?: Record<string, any>;
+    dividerStyle?: Record<string, any>;
+    draggable?: boolean;
+    interactive?: boolean;
+};
+export declare type DslRelation = {
+    id?: string;
+    source: string;
+    target: string;
+    type?: DslRelationType;
+    relationType?: DslRelationType;
+    sourceField?: string;
+    targetField?: string;
+    nullable?: boolean;
+    onDelete?: string;
+    onUpdate?: string;
+    joinTableName?: string;
+    fromKey?: string;
+    toKey?: string;
+    sourceCardinality?: string;
+    targetCardinality?: string;
+    label?: string;
+    style?: Record<string, any>;
+    arrow?: string;
+    linkShape?: string;
+    routeType?: string;
+    routeOffset?: number;
+    curveType?: string;
+    lineDash?: number[];
+};
+export declare type DslLayout = 'grid' | 'layered' | 'horizontal' | 'vertical';
+export declare type DslDocument = {
+    schemaVersion?: number;
+    entities: DslEntity[];
+    relations?: DslRelation[];
+    layout?: DslLayout;
+    options?: {
+        fitViewport?: boolean;
+        routeType?: string;
+        gapX?: number;
+        gapY?: number;
+    };
+};
+export declare type DslValidationResult = {
+    valid: boolean;
+    errors: string[];
+};

package/dist/types/validate.d.ts

@@ -0,0 +1,3 @@
+import type { DslDocument, DslValidationResult } from './types';
+export declare const DSL_SCHEMA_VERSION = 1;
+export declare function validateDsl(dsl: DslDocument): DslValidationResult;

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "ice-entity-designer-dsl",
+  "version": "0.0.1",
+  "description": "A JSON-first DSL layer for AI agents to drive ice-entity-designer.",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "browser": "dist/index.umd.js",
+  "types": "dist/types/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "npm run clean && npm run build:types && npm run build:js",
+    "build:js": "rollup -c --environment NODE_ENV:production",
+    "build:types": "tsc --emitDeclarationOnly",
+    "clean": "rimraf dist",
+    "dev": "rollup -c -w --environment NODE_ENV:development",
+    "test": "jest --runInBand",
+    "types:check": "tsc --noEmit"
+  },
+  "dependencies": {
+    "ice-entity-designer": "file:../ice-entity-designer"
+  },
+  "devDependencies": {
+    "@babel/core": "7.17.8",
+    "@babel/preset-env": "7.16.11",
+    "@babel/preset-typescript": "7.9.0",
+    "@rollup/plugin-commonjs": "21.0.2",
+    "@rollup/plugin-json": "4.1.0",
+    "@rollup/plugin-node-resolve": "13.1.3",
+    "@types/node": "^14.18.63",
+    "jest": "25.4.0",
+    "rimraf": "3.0.2",
+    "rollup": "2.70.1",
+    "rollup-plugin-babel": "4.4.0",
+    "rollup-plugin-terser": "5.3.0",
+    "typescript": "4.6.2"
+  }
+}