@dr2rai/raid-canvas 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,162 @@
+/**
+ * @file types.ts
+ * @description Core ontological types, metamodel contracts, and SVG attributes
+ * for the RaidCanvas AOAIM visual modeler.
+ *
+ * Honors Alan Kay's vision of living, reactive object systems and Rainer Burkhardt's
+ * C++ GrafObj graphical object hierarchies.
+ */
+/**
+ * Canonical AOAIM (Activity-Object-AI Model) entity archetypes.
+ *
+ * - 'uc'  : UseCase (elliptical boundary, Cascais Net Gold accent)
+ * - 'act' : Activity (rounded rectangle process step, Heraldic Green accent)
+ * - 'cls' : Class (compartmentalized class specification card)
+ * - 'obj' : Object / Instance (runtime instance card with underlined title)
+ * - 'per' : Person / Actor (Initiating or Defined role stick-figure/card)
+ */
+export type AimOntologyKind = 'uc' | 'act' | 'cls' | 'obj' | 'per';
+/**
+ * Ontological relationship classifications in AOAIM.
+ */
+export type AimEdgeKind = 'association' | 'dependency' | 'generalization' | 'realization' | 'aggregation' | 'composition';
+/**
+ * 2D Cartesian coordinate pair for geometry and Manhattan orthogonal routing.
+ */
+export interface Point {
+    readonly x: number;
+    readonly y: number;
+}
+/**
+ * Single bend point (vertex) along an orthogonal Manhattan edge path.
+ */
+export interface SvgBendPoint {
+    readonly x: number;
+    readonly y: number;
+}
+/**
+ * 2D Bounding box for nodes and frames.
+ */
+export interface Bounds {
+    readonly x: number;
+    readonly y: number;
+    readonly width: number;
+    readonly height: number;
+}
+/**
+ * Canonical port identifiers for 4-way orthogonal docking.
+ */
+export type OrthogonalPortId = 'port-top' | 'port-right' | 'port-bottom' | 'port-left';
+/**
+ * Metadata carried by an ontological node inside AntV X6.
+ */
+export interface RaidNodeData {
+    /** Unique entity identifier in the metamodel (e.g., 'SignContract_UC'). */
+    readonly id: string;
+    /** Ontological kind of the node. */
+    readonly kind: AimOntologyKind;
+    /** Display label presented on the canvas. */
+    readonly displayName: string;
+    /** Optional ontological stereotype (e.g., '«initiates»', '«executes»'). */
+    readonly stereotype?: string;
+    /** Subtitle, frame, or namespace tag. */
+    readonly namespace?: string;
+    /** For 'cls' / 'obj': list of attribute or field declarations. */
+    readonly attributes?: readonly string[];
+    /** For 'cls': list of method or operation declarations. */
+    readonly methods?: readonly string[];
+    /** Spatial bounds of the node. */
+    readonly bounds: Bounds;
+    /** Custom extension properties passed from or serialized to .raid manifests. */
+    readonly properties?: Readonly<Record<string, unknown>>;
+}
+/**
+ * Metadata carried by an ontological edge inside AntV X6.
+ */
+export interface RaidEdgeData {
+    /** Unique edge identifier. */
+    readonly id: string;
+    /** Ontological relationship type. */
+    readonly kind: AimEdgeKind;
+    /** Identifier of the source node. */
+    readonly sourceId: string;
+    /** Identifier of the target node. */
+    readonly targetId: string;
+    /** Optional docking port on source node. */
+    readonly sourcePort?: OrthogonalPortId | string;
+    /** Optional docking port on target node. */
+    readonly targetPort?: OrthogonalPortId | string;
+    /** Optional edge label text. */
+    readonly label?: string;
+    /** Optional edge stereotype annotation (e.g., '«DependsOn»'). */
+    readonly stereotype?: string;
+    /** Multiplicity / Cardinality at the source end (e.g., '1', '0..*'). */
+    readonly sourceCardinality?: string;
+    /** Multiplicity / Cardinality at the target end (e.g., '0..1', '*'). */
+    readonly targetCardinality?: string;
+    /** User-editable or router-computed Manhattan bend points. */
+    readonly bendPoints: readonly SvgBendPoint[];
+}
+/**
+ * Full in-memory metamodel representation corresponding to a `.raid` manifest.
+ */
+export interface RaidMetamodel {
+    /** Diagram identifier (e.g., 'SignContract_UCD'). */
+    readonly diagramId: string;
+    /** Optional human-readable title. */
+    readonly title?: string;
+    /** Archetype classification (e.g., 'OneUseCaseDiagram', 'ClassDiagram', 'ActivityDiagram'). */
+    readonly archetype: string;
+    /** Entity nodes projected in the diagram. */
+    readonly nodes: readonly RaidNodeData[];
+    /** Relationships connecting projected nodes. */
+    readonly edges: readonly RaidEdgeData[];
+    /** Additional diagram-level metadata. */
+    readonly metadata?: Readonly<Record<string, unknown>>;
+}
+/**
+ * Contractual SVG attribute names adhering to the 'aim-*' standard.
+ */
+export declare const AimSvgContract: {
+    readonly ATTR_NODE: 'aim-node';
+    readonly ATTR_ID: 'aim-id';
+    readonly ATTR_KIND: 'aim-kind';
+    readonly ATTR_DISPLAY_NAME: 'aim-display-name';
+    readonly ATTR_STEREOTYPE: 'aim-stereotype';
+    readonly ATTR_NAMESPACE: 'aim-namespace';
+    readonly ATTR_EDGE: 'aim-edge';
+    readonly ATTR_EDGE_KIND: 'aim-edge-kind';
+    readonly ATTR_SOURCE: 'aim-source';
+    readonly ATTR_TARGET: 'aim-target';
+    readonly ATTR_SOURCE_PORT: 'aim-source-port';
+    readonly ATTR_TARGET_PORT: 'aim-target-port';
+    readonly ATTR_BENDS: 'aim-bends';
+    readonly SELECTOR_NODE: '[aim-node], [data-node], g[aim-kind]';
+    readonly SELECTOR_EDGE: '[aim-edge], path[aim-edge-kind]';
+};
+/**
+ * Options for hydrating an AntV X6 graph from an SVG document.
+ */
+export interface HydrationOptions {
+    /** If true, clears any existing graph elements before populating. Default: true. */
+    readonly clearGraph?: boolean;
+    /** If true, automatically executes Manhattan routing if bend points are missing. Default: true. */
+    readonly autoRouteEdges?: boolean;
+    /** Default fallback dimensions when width/height are unspecified in SVG. */
+    readonly defaultNodeSize?: {
+        readonly width: number;
+        readonly height: number;
+    };
+}
+/**
+ * Options for serializing an AntV X6 graph to an SVG document.
+ */
+export interface SerializationOptions {
+    /** Base SVG template to inject updated coordinates and bend points into. */
+    readonly baseSvg?: string;
+    /** Pretty-print XML output with indentation. Default: true. */
+    readonly format?: boolean;
+    /** Inject Cascais design token CSS variables into `<defs><style>`. Default: true. */
+    readonly embedStyles?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,GAAG,IAAI,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,aAAa,GACb,YAAY,GACZ,gBAAgB,GAChB,aAAa,GACb,aAAa,GACb,aAAa,CAAC;AAElB;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,YAAY,GAAG,aAAa,GAAG,WAAW,CAAC;AAEvF;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,oCAAoC;IACpC,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;IAE/B,6CAA6C;IAC7C,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAE7B,2EAA2E;IAC3E,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAE7B,yCAAyC;IACzC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAE5B,kEAAkE;IAClE,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAExC,2DAA2D;IAC3D,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAErC,kCAAkC;IAClC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB,gFAAgF;IAChF,QAAQ,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACzD;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,qCAAqC;IACrC,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAE3B,qCAAqC;IACrC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B,qCAAqC;IACrC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B,4CAA4C;IAC5C,QAAQ,CAAC,UAAU,CAAC,EAAE,gBAAgB,GAAG,MAAM,CAAC;IAEhD,4CAA4C;IAC5C,QAAQ,CAAC,UAAU,CAAC,EAAE,gBAAgB,GAAG,MAAM,CAAC;IAEhD,gCAAgC;IAChC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAExB,iEAAiE;IACjE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAE7B,wEAAwE;IACxE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAEpC,wEAAwE;IACxE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAEpC,8DAA8D;IAC9D,QAAQ,CAAC,UAAU,EAAE,SAAS,YAAY,EAAE,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,qDAAqD;IACrD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B,qCAAqC;IACrC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAExB,+FAA+F;IAC/F,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B,6CAA6C;IAC7C,QAAQ,CAAC,KAAK,EAAE,SAAS,YAAY,EAAE,CAAC;IAExC,gDAAgD;IAChD,QAAQ,CAAC,KAAK,EAAE,SAAS,YAAY,EAAE,CAAC;IAExC,yCAAyC;IACzC,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACvD;AAED;;GAEG;AACH,eAAO,MAAM,cAAc;aAEzB,SAAS,EAAE,UAAU;aACrB,OAAO,EAAE,QAAQ;aACjB,SAAS,EAAE,UAAU;aACrB,iBAAiB,EAAE,kBAAkB;aACrC,eAAe,EAAE,gBAAgB;aACjC,cAAc,EAAE,eAAe;aAG/B,SAAS,EAAE,UAAU;aACrB,cAAc,EAAE,eAAe;aAC/B,WAAW,EAAE,YAAY;aACzB,WAAW,EAAE,YAAY;aACzB,gBAAgB,EAAE,iBAAiB;aACnC,gBAAgB,EAAE,iBAAiB;aACnC,UAAU,EAAE,WAAW;aAGvB,aAAa,EAAE,sCAAsC;aACrD,aAAa,EAAE,iCAAiC;CACxC,CAAC;AAEX;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,oFAAoF;IACpF,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAE9B,mGAAmG;IACnG,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAElC,4EAA4E;IAC5E,QAAQ,CAAC,eAAe,CAAC,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CAChF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,4EAA4E;IAC5E,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAE1B,+DAA+D;IAC/D,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAE1B,qFAAqF;IACrF,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;CAChC"}

package/dist/types.js

@@ -0,0 +1,32 @@
+/**
+ * @file types.ts
+ * @description Core ontological types, metamodel contracts, and SVG attributes
+ * for the RaidCanvas AOAIM visual modeler.
+ *
+ * Honors Alan Kay's vision of living, reactive object systems and Rainer Burkhardt's
+ * C++ GrafObj graphical object hierarchies.
+ */
+/**
+ * Contractual SVG attribute names adhering to the 'aim-*' standard.
+ */
+export const AimSvgContract = {
+    // Node marking & attributes
+    ATTR_NODE: 'aim-node',
+    ATTR_ID: 'aim-id',
+    ATTR_KIND: 'aim-kind',
+    ATTR_DISPLAY_NAME: 'aim-display-name',
+    ATTR_STEREOTYPE: 'aim-stereotype',
+    ATTR_NAMESPACE: 'aim-namespace',
+    // Edge marking & attributes
+    ATTR_EDGE: 'aim-edge',
+    ATTR_EDGE_KIND: 'aim-edge-kind',
+    ATTR_SOURCE: 'aim-source',
+    ATTR_TARGET: 'aim-target',
+    ATTR_SOURCE_PORT: 'aim-source-port',
+    ATTR_TARGET_PORT: 'aim-target-port',
+    ATTR_BENDS: 'aim-bends',
+    // Selectors for DOM queries
+    SELECTOR_NODE: '[aim-node], [data-node], g[aim-kind]',
+    SELECTOR_EDGE: '[aim-edge], path[aim-edge-kind]',
+};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAoJH;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,4BAA4B;IAC5B,SAAS,EAAE,UAAU;IACrB,OAAO,EAAE,QAAQ;IACjB,SAAS,EAAE,UAAU;IACrB,iBAAiB,EAAE,kBAAkB;IACrC,eAAe,EAAE,gBAAgB;IACjC,cAAc,EAAE,eAAe;IAE/B,4BAA4B;IAC5B,SAAS,EAAE,UAAU;IACrB,cAAc,EAAE,eAAe;IAC/B,WAAW,EAAE,YAAY;IACzB,WAAW,EAAE,YAAY;IACzB,gBAAgB,EAAE,iBAAiB;IACnC,gBAAgB,EAAE,iBAAiB;IACnC,UAAU,EAAE,WAAW;IAEvB,4BAA4B;IAC5B,aAAa,EAAE,sCAAsC;IACrD,aAAa,EAAE,iCAAiC;CACxC,CAAC"}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@dr2rai/raid-canvas",
+  "version": "0.1.0",
+  "description": "Interactive AntV X6 diagram canvas for AOAIM (.raid) models and ontological SVG contracts",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./styles": "./src/styles/aoaim-theme.css",
+    "./styles/*": "./src/styles/*"
+  },
+  "files": [
+    "dist",
+    "src",
+    "README.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "dependencies": {
+    "@antv/x6": "^2.18.1"
+  },
+  "devDependencies": {
+    "@types/node": "^22.5.5",
+    "typescript": "^7.0.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "Apache-2.0",
+  "copyright": "© Rainer Burkhardt. All rights reserved.",
+  "scripts": {
+    "build": "tsc -b --force",
+    "typecheck": "tsc --noEmit",
+    "test": "node --test test/canvas.test.mjs"
+  }
+}