feat(model): add domain types and model factory
This commit is contained in:
110
src/model/types.ts
Normal file
110
src/model/types.ts
Normal file
@@ -0,0 +1,110 @@
|
||||
/**
|
||||
* The domain Model — the single source of truth for a meadows document.
|
||||
*
|
||||
* The Vue Flow graph is a derived projection of this (ADR-0002); the future
|
||||
* simulator reads this and knows nothing of the view layer. Everything here is
|
||||
* plain, serialisable data (no class instances, no functions) so it round-trips
|
||||
* as JSON (F8) and deep-clones cheaply for undo snapshots (F9).
|
||||
*
|
||||
* Vocabulary follows CONTEXT.md. Structural rules follow the ADRs:
|
||||
* - A Flow is a *node* with `source`/`target` references, not an edge (ADR-0003).
|
||||
* - Source/Sink boundaries are materialised Cloud nodes, so no end is ever null.
|
||||
* - The only stored edge type is the Information Link; loops are detected, never
|
||||
* stored (ADR-0001).
|
||||
*/
|
||||
|
||||
/** Schema version stamped on every Model for round-trip migrations (F8). */
|
||||
export const MODEL_VERSION = 1
|
||||
|
||||
/** The four node kinds. A `kind` field discriminates the `ModelNode` union. */
|
||||
export type NodeKind = "stock" | "flow" | "converter" | "cloud"
|
||||
|
||||
/**
|
||||
* The sign on an Information Link (and inherent to a Flow): `+` when more cause
|
||||
* means more effect, `−` when more cause means less effect. The input that lets
|
||||
* loops be classified Reinforcing/Balancing.
|
||||
*/
|
||||
export type Polarity = "+" | "-"
|
||||
|
||||
export interface Position {
|
||||
x: number
|
||||
y: number
|
||||
}
|
||||
|
||||
interface BaseNode {
|
||||
id: string
|
||||
position: Position
|
||||
}
|
||||
|
||||
/**
|
||||
* An accumulation that holds a quantity over time — the system's memory and the
|
||||
* only stateful element. Changes only through Flows.
|
||||
*/
|
||||
export interface StockNode extends BaseNode {
|
||||
kind: "stock"
|
||||
name: string
|
||||
/** Initial accumulated quantity. Optional in the diagram phase; the simulator reads it. */
|
||||
initialValue?: number
|
||||
}
|
||||
|
||||
/**
|
||||
* A rate that moves quantity between two ends. A Flow is a node (ADR-0003): the
|
||||
* pipe-with-valve you see is rendered from `source`/`target`. Inflow/outflow is
|
||||
* relative to a given Stock, not a separate type — a stock→stock Flow is an
|
||||
* outflow for `source` and an inflow for `target`.
|
||||
*/
|
||||
export interface FlowNode extends BaseNode {
|
||||
kind: "flow"
|
||||
name: string
|
||||
/** Node id of the Stock or Cloud the Flow draws from. */
|
||||
source: string
|
||||
/** Node id of the Stock or Cloud the Flow feeds into. */
|
||||
target: string
|
||||
/** Rate expression, recomputed each instant. Optional in the diagram phase. */
|
||||
equation?: string
|
||||
}
|
||||
|
||||
/**
|
||||
* A stateless helper value, recomputed each instant from its inputs (or a fixed
|
||||
* constant). Feeds Flows or other Converters via Information Links.
|
||||
*/
|
||||
export interface ConverterNode extends BaseNode {
|
||||
kind: "converter"
|
||||
name: string
|
||||
/** Expression or constant. Optional in the diagram phase. */
|
||||
equation?: string
|
||||
}
|
||||
|
||||
/**
|
||||
* A model boundary (Source/Sink) on an open Flow end — drawn as a cloud.
|
||||
* Auto-managed: spawned when a Flow is left open-ended, removed when the Flow
|
||||
* attaches to a Stock (ADR-0003). Carries no name and no value.
|
||||
*/
|
||||
export interface CloudNode extends BaseNode {
|
||||
kind: "cloud"
|
||||
}
|
||||
|
||||
export type ModelNode = StockNode | FlowNode | ConverterNode | CloudNode
|
||||
|
||||
/**
|
||||
* Shows that one element's value influences a Flow's or Converter's value.
|
||||
* Carries a Polarity; carries no quantity and never targets a Stock (a Stock
|
||||
* changes only via Flows).
|
||||
*/
|
||||
export interface InformationLink {
|
||||
id: string
|
||||
/** Source node id — a Stock, Flow, or Converter (the value being read). */
|
||||
source: string
|
||||
/** Target node id — a Flow or Converter, never a Stock (ADR-0001). */
|
||||
target: string
|
||||
polarity: Polarity
|
||||
}
|
||||
|
||||
/** One saved document: the unit of save / export / reopen. */
|
||||
export interface Model {
|
||||
version: number
|
||||
id: string
|
||||
name: string
|
||||
nodes: ModelNode[]
|
||||
infoLinks: InformationLink[]
|
||||
}
|
||||
Reference in New Issue
Block a user