@vscada/core 0.0.1

package/dist/registry/element-catalog.d.ts

@@ -0,0 +1,805 @@
+/**
+ * Story 5.1 (builder Task 2, AD-10): a hand-authored catalog of known
+ * element types and their canonical ports, giving the typed builder
+ * (`@vscada/builder`) something to generate compile-time port unions from.
+ *
+ * This does NOT come from `@vscada/primitives` — AD-10 forbids `builder`
+ * depending on anything but core's public entry points, and forbids core
+ * depending on primitives. Ports are runtime scene data (`SceneElement.ports`
+ * in `scene-schema.ts`), never declared by a primitive's `build()` (AD-3:
+ * primitives are pure structure factories, no knowledge of their own scene
+ * placement). So there is no single existing source of truth to import
+ * from; this catalog IS that source of truth for authoring tools, kept in
+ * sync by hand as `doc/SCADA-COMPONENT-SPEC.md#6.1`'s primitive kit grows.
+ * `tank-vertical` / `pump-centrifugal` ports below intentionally match
+ * `packages/core/test/fixtures/scenes/valid-tank-pump.json` (the
+ * walking-skeleton fixture) exactly — Story 5.1 Task 4 rebuilds that scene
+ * with the builder and asserts equivalence.
+ *
+ * Exported only from the `scene-authoring` subpath (never `index.ts`) —
+ * it is authoring-time metadata, not something `<scada-view>`'s render path
+ * ever reads.
+ */
+export type PortDirection = 'up' | 'down' | 'left' | 'right';
+export interface PortDefinition {
+    x: number;
+    y: number;
+    dir: PortDirection;
+}
+export interface ElementCatalogEntry {
+    defaultSize: {
+        w: number;
+        h: number;
+    };
+    ports: Record<string, PortDefinition>;
+}
+export declare const ELEMENT_CATALOG: {
+    'tank-vertical': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            'inlet-top': {
+                x: number;
+                y: number;
+                dir: "up";
+            };
+            'outlet-bot': {
+                x: number;
+                y: number;
+                dir: "down";
+            };
+            overflow: {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    'tank-horizontal': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            'inlet-top': {
+                x: number;
+                y: number;
+                dir: "up";
+            };
+            'outlet-bot': {
+                x: number;
+                y: number;
+                dir: "down";
+            };
+            drain: {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+        };
+    };
+    'tank-spherical': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            'inlet-top': {
+                x: number;
+                y: number;
+                dir: "up";
+            };
+            'outlet-bot': {
+                x: number;
+                y: number;
+                dir: "down";
+            };
+        };
+    };
+    hopper: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            'inlet-top': {
+                x: number;
+                y: number;
+                dir: "up";
+            };
+            'outlet-bot': {
+                x: number;
+                y: number;
+                dir: "down";
+            };
+        };
+    };
+    silo: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            'inlet-top': {
+                x: number;
+                y: number;
+                dir: "up";
+            };
+            'outlet-bot': {
+                x: number;
+                y: number;
+                dir: "down";
+            };
+        };
+    };
+    drum: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            'inlet-top': {
+                x: number;
+                y: number;
+                dir: "up";
+            };
+            'outlet-bot': {
+                x: number;
+                y: number;
+                dir: "down";
+            };
+        };
+    };
+    'pump-centrifugal': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            suction: {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            discharge: {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    'pump-positive-displacement': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            suction: {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            discharge: {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    'fan-axial': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            inlet: {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            outlet: {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    'fan-centrifugal': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            inlet: {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            outlet: {
+                x: number;
+                y: number;
+                dir: "up";
+            };
+        };
+    };
+    compressor: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            suction: {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            discharge: {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    turbine: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            inlet: {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            outlet: {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    motor: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {};
+    };
+    'valve-gate': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            inlet: {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            outlet: {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    'valve-ball': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            inlet: {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            outlet: {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    'valve-butterfly': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            inlet: {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            outlet: {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    'valve-control': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            inlet: {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            outlet: {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    'valve-check': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            inlet: {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            outlet: {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    'valve-relief': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            inlet: {
+                x: number;
+                y: number;
+                dir: "down";
+            };
+            outlet: {
+                x: number;
+                y: number;
+                dir: "up";
+            };
+        };
+    };
+    'heat-exchanger-shell-tube': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            'tube-inlet': {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            'tube-outlet': {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+            'shell-inlet': {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            'shell-outlet': {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    'heat-exchanger-coil': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            inlet: {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            outlet: {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    boiler: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            'feedwater-inlet': {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            'steam-outlet': {
+                x: number;
+                y: number;
+                dir: "up";
+            };
+        };
+    };
+    furnace: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            'fuel-inlet': {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            'flue-outlet': {
+                x: number;
+                y: number;
+                dir: "up";
+            };
+        };
+    };
+    condenser: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            inlet: {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            outlet: {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    'cooling-tower': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            'inlet-top': {
+                x: number;
+                y: number;
+                dir: "up";
+            };
+            'outlet-bot': {
+                x: number;
+                y: number;
+                dir: "down";
+            };
+        };
+    };
+    duct: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            inlet: {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            outlet: {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    conveyor: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            infeed: {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            discharge: {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    'screw-feeder': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            'inlet-top': {
+                x: number;
+                y: number;
+                dir: "up";
+            };
+            outlet: {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    'gauge-analog': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {};
+    };
+    'gauge-digital': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {};
+    };
+    'indicator-lamp': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {};
+    };
+    'readout-panel': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {};
+    };
+    bargraph: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {};
+    };
+    'trend-mini': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {};
+    };
+    pushbutton: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {};
+    };
+    'selector-switch': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {};
+    };
+    'motor-starter-panel': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {};
+    };
+    breaker: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            'line-in': {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            'line-out': {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    transformer: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            primary: {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            secondary: {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    busbar: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            'line-in': {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            'line-out': {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    generator: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            output: {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    'bag-filter': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            inlet: {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            outlet: {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+            drain: {
+                x: number;
+                y: number;
+                dir: "down";
+            };
+        };
+    };
+    cyclone: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            inlet: {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            'gas-outlet': {
+                x: number;
+                y: number;
+                dir: "up";
+            };
+            'solids-outlet': {
+                x: number;
+                y: number;
+                dir: "down";
+            };
+        };
+    };
+    scrubber: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            'gas-inlet': {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+            'gas-outlet': {
+                x: number;
+                y: number;
+                dir: "up";
+            };
+            'liquid-inlet': {
+                x: number;
+                y: number;
+                dir: "right";
+            };
+        };
+    };
+    stack: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            inlet: {
+                x: number;
+                y: number;
+                dir: "down";
+            };
+        };
+    };
+    plume: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {};
+    };
+    'steam-vent': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            inlet: {
+                x: number;
+                y: number;
+                dir: "down";
+            };
+        };
+    };
+    'off-page': {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {
+            link: {
+                x: number;
+                y: number;
+                dir: "left";
+            };
+        };
+    };
+    readout: {
+        defaultSize: {
+            w: number;
+            h: number;
+        };
+        ports: {};
+    };
+};
+export type ElementTypeName = keyof typeof ELEMENT_CATALOG;
+export type PortName<T extends ElementTypeName> = keyof (typeof ELEMENT_CATALOG)[T]['ports'] & string;
+//# sourceMappingURL=element-catalog.d.ts.map