@algomotion/spec 0.0.0-stage → 1.0.0-alpha.1

package/dist/kinds/graph.js

@@ -0,0 +1,229 @@
+/**
+ * The `graph` kind: directed or undirected graphs with optional edge
+ * weights, for traversals, shortest paths, spanning trees, topological
+ * sorting and flows.
+ *
+ * Node ids double as names: the shorthand `"nodes": ["A", "B"]` declares
+ * nodes A and B, and the edge `["A", "B", 4]` gets the id `A-B`.
+ *
+ * Marks: `highlight` lasts one step; `visit`, `settle`, `group`, `pointer`,
+ * `annotate` and `markEdge` persist until changed or `resetMarks`.
+ */
+import { z } from 'zod';
+import { ElementId, Group, LIMITS, Place, PointerName, Scalar, } from "../common.js";
+import { typesOf } from "./kind.js";
+const Coordinate = z.number().min(-1e5).max(1e5);
+export const GraphNode = z
+    .strictObject({
+    id: ElementId,
+    value: Scalar,
+    x: Coordinate.optional(),
+    y: Coordinate.optional(),
+})
+    .describe('A node. `x` and `y` place it by hand (units are pixels at 1×; used by the "manual" layout).');
+const NodeInput = z
+    .union([
+    GraphNode.extend({ value: Scalar.optional() }),
+    z.string(),
+    z.number(),
+])
+    .describe('A node, or a bare name such as "A" or 3 that serves as both id and value. Without `value`, a node shows its id.');
+const NodeRef = ElementId.describe('A node id.');
+const EdgeRef = ElementId.describe('An edge id, by default "from-to".');
+const Weight = Scalar.describe('Shown beside the edge: a weight, a capacity, or text such as "3/5".');
+export const GraphEdge = z
+    .strictObject({
+    id: ElementId,
+    from: NodeRef,
+    to: NodeRef,
+    weight: Weight.optional(),
+})
+    .describe('An edge; in undirected graphs `from` and `to` are interchangeable.');
+const EdgeInput = z
+    .union([
+    GraphEdge.extend({ id: ElementId.optional() }),
+    z.tuple([NodeRef, NodeRef]),
+    z.tuple([NodeRef, NodeRef, Weight]),
+])
+    .describe('An edge, or `[from, to]` / `[from, to, weight]`. The id defaults to "from-to".');
+export const GraphLayout = z
+    .enum(['auto', 'circle', 'layered', 'grid', 'manual'])
+    .describe('"layered" ranks nodes top to bottom along edges (good for DAGs and trees); "circle" places them on a circle; "grid" in rows; "manual" uses each node’s x and y. "auto" (default) is manual when every node has x and y, else layered for acyclic directed graphs, else circle.');
+export const GraphDecl = z
+    .strictObject({
+    kind: z.literal('graph'),
+    label: z.string().max(LIMITS.textLength).optional(),
+    place: Place.optional(),
+    directed: z.boolean(),
+    layout: GraphLayout,
+    nodes: z.array(GraphNode).max(LIMITS.elementsPerStructure),
+    edges: z.array(GraphEdge).max(LIMITS.edgesPerStructure),
+})
+    .describe('A graph.');
+export const GraphDeclInput = z.strictObject({
+    kind: z.literal('graph'),
+    label: z.string().max(LIMITS.textLength).optional(),
+    place: Place.optional(),
+    directed: z.boolean().optional().describe('Default false.'),
+    layout: GraphLayout.optional(),
+    nodes: z.array(NodeInput).max(LIMITS.elementsPerStructure).optional(),
+    edges: z.array(EdgeInput).max(LIMITS.edgesPerStructure).optional(),
+});
+const normalizeNode = (input) => typeof input === 'object'
+    ? { ...input, value: input.value === undefined ? input.id : input.value }
+    : { id: String(input), value: input };
+const normalizeEdge = (input) => {
+    if (Array.isArray(input)) {
+        const [from, to, weight] = input;
+        return {
+            id: `${from}-${to}`,
+            from,
+            to,
+            ...(weight === undefined ? {} : { weight }),
+        };
+    }
+    return { ...input, id: input.id ?? `${input.from}-${input.to}` };
+};
+function normalizeGraphDecl(input) {
+    const { nodes, edges, directed, layout, ...rest } = input;
+    return {
+        ...rest,
+        directed: directed ?? false,
+        layout: layout ?? 'auto',
+        nodes: (nodes ?? []).map(normalizeNode),
+        edges: (edges ?? []).map(normalizeEdge),
+    };
+}
+/** Ids generated from names must still be valid ids. */
+function idIssues(id, path) {
+    return ElementId.safeParse(id).success
+        ? []
+        : [
+            {
+                path,
+                message: `"${id}" is not a valid id`,
+                hint: 'Ids use letters, digits and _ . : - (at most 64). Give the node as { "id", "value" } to show other text.',
+            },
+        ];
+}
+export function validateGraphDecl(decl) {
+    const nodes = new Set(decl.nodes.map((n) => n.id));
+    const issues = decl.nodes.flatMap((n, k) => idIssues(n.id, ['nodes', k]));
+    decl.edges.forEach((edge, k) => {
+        issues.push(...idIssues(edge.id, ['edges', k]));
+        for (const end of ['from', 'to'])
+            if (!nodes.has(edge[end]))
+                issues.push({
+                    path: ['edges', k, end],
+                    message: `Edge "${edge.id}" ends at "${edge[end]}", which is not a node`,
+                });
+    });
+    if (decl.layout === 'manual')
+        decl.nodes.forEach((n, k) => {
+            if (n.x === undefined || n.y === undefined)
+                issues.push({
+                    path: ['nodes', k],
+                    message: `Node "${n.id}" needs x and y for the manual layout`,
+                });
+        });
+    return issues;
+}
+const nodes = z.array(NodeRef).max(LIMITS.elementsPerStructure);
+const edges = z.array(EdgeRef).max(LIMITS.edgesPerStructure);
+const actions = (newNode, newEdge) => z.discriminatedUnion('type', [
+    z
+        .strictObject({ type: z.literal('addNode'), node: newNode })
+        .describe('Add a node.'),
+    z
+        .strictObject({ type: z.literal('removeNode'), node: NodeRef })
+        .describe('Remove a node and every edge at it.'),
+    z
+        .strictObject({
+        type: z.literal('setValue'),
+        node: NodeRef,
+        value: Scalar,
+    })
+        .describe('Change the text shown in a node.'),
+    z
+        .strictObject({ type: z.literal('addEdge'), edge: newEdge })
+        .describe('Add an edge between existing nodes.'),
+    z
+        .strictObject({ type: z.literal('removeEdge'), edge: EdgeRef })
+        .describe('Remove an edge.'),
+    z
+        .strictObject({
+        type: z.literal('setWeight'),
+        edge: EdgeRef,
+        weight: Weight.nullable(),
+    })
+        .describe('Change an edge’s weight or label; null removes it.'),
+    z
+        .strictObject({
+        type: z.literal('highlight'),
+        nodes: nodes.optional(),
+        edges: edges.optional(),
+    })
+        .describe('Highlight nodes and edges (this step only), e.g. an edge being relaxed.'),
+    z
+        .strictObject({ type: z.literal('visit'), node: NodeRef })
+        .describe('Mark a node as visited, e.g. discovered by a search.'),
+    z
+        .strictObject({ type: z.literal('settle'), node: NodeRef })
+        .describe('Mark a node as finished, e.g. its distance is final.'),
+    z
+        .strictObject({ type: z.literal('group'), node: NodeRef, group: Group })
+        .describe('Put a node in a categorical group 0–5 (e.g. a component or a colour); null removes it.'),
+    z
+        .strictObject({
+        type: z.literal('pointer'),
+        name: PointerName,
+        node: NodeRef.nullable(),
+    })
+        .describe('Point a named pointer at a node; null removes it.'),
+    z
+        .strictObject({
+        type: z.literal('annotate'),
+        node: NodeRef,
+        text: z.string().max(32).nullable(),
+    })
+        .describe('Show a short note above a node, e.g. a distance "d=4" or "∞"; null removes it.'),
+    z
+        .strictObject({
+        type: z.literal('markEdge'),
+        edge: EdgeRef,
+        mark: z.enum(['selected', 'rejected']).nullable(),
+    })
+        .describe('Mark an edge as selected (e.g. in the spanning tree or shortest-path tree) or rejected (e.g. it would close a cycle); null clears it.'),
+    z
+        .strictObject({ type: z.literal('resetMarks') })
+        .describe('Clear every mark: visits, settled nodes, groups, pointers, notes and edge marks.'),
+]);
+export const GraphAction = actions(GraphNode, GraphEdge);
+export const GraphActionInput = actions(NodeInput, EdgeInput);
+export const graphSpec = {
+    kind: 'graph',
+    decl: GraphDecl,
+    declInput: GraphDeclInput,
+    action: GraphAction,
+    actionInput: GraphActionInput,
+    actionTypes: typesOf(GraphAction),
+    normalizeDecl: normalizeGraphDecl,
+    declIds: (decl) => [
+        ...decl.nodes.map((n, k) => ({ id: n.id, path: ['nodes', k] })),
+        ...decl.edges.map((e, k) => ({ id: e.id, path: ['edges', k] })),
+    ],
+    validateDecl: validateGraphDecl,
+    normalizeAction: (input) => {
+        if (input.type === 'addNode')
+            return { ...input, node: normalizeNode(input.node) };
+        if (input.type === 'addEdge')
+            return { ...input, edge: normalizeEdge(input.edge) };
+        return input;
+    },
+    introducedIds: (action) => action.type === 'addNode'
+        ? [{ id: action.node.id, path: ['node'] }]
+        : action.type === 'addEdge'
+            ? [{ id: action.edge.id, path: ['edge'] }]
+            : [],
+};
+//# sourceMappingURL=graph.js.map

package/dist/kinds/graph.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"graph.js","sourceRoot":"","sources":["../../src/kinds/graph.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EACL,SAAS,EACT,KAAK,EACL,MAAM,EACN,KAAK,EACL,WAAW,EACX,MAAM,GACP,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,OAAO,EAA6C,MAAM,WAAW,CAAC;AAE/E,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAEjD,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC;KACvB,YAAY,CAAC;IACZ,EAAE,EAAE,SAAS;IACb,KAAK,EAAE,MAAM;IACb,CAAC,EAAE,UAAU,CAAC,QAAQ,EAAE;IACxB,CAAC,EAAE,UAAU,CAAC,QAAQ,EAAE;CACzB,CAAC;KACD,QAAQ,CACP,6FAA6F,CAC9F,CAAC;AAGJ,MAAM,SAAS,GAAG,CAAC;KAChB,KAAK,CAAC;IACL,SAAS,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;IAC9C,CAAC,CAAC,MAAM,EAAE;IACV,CAAC,CAAC,MAAM,EAAE;CACX,CAAC;KACD,QAAQ,CACP,iHAAiH,CAClH,CAAC;AAGJ,MAAM,OAAO,GAAG,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;AACjD,MAAM,OAAO,GAAG,SAAS,CAAC,QAAQ,CAAC,mCAAmC,CAAC,CAAC;AAExE,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAC5B,qEAAqE,CACtE,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC;KACvB,YAAY,CAAC;IACZ,EAAE,EAAE,SAAS;IACb,IAAI,EAAE,OAAO;IACb,EAAE,EAAE,OAAO;IACX,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE;CAC1B,CAAC;KACD,QAAQ,CACP,oEAAoE,CACrE,CAAC;AAGJ,MAAM,SAAS,GAAG,CAAC;KAChB,KAAK,CAAC;IACL,SAAS,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,SAAS,CAAC,QAAQ,EAAE,EAAE,CAAC;IAC9C,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC3B,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;CACpC,CAAC;KACD,QAAQ,CACP,gFAAgF,CACjF,CAAC;AAGJ,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC;KACzB,IAAI,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;KACrD,QAAQ,CACP,gRAAgR,CACjR,CAAC;AAGJ,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC;KACvB,YAAY,CAAC;IACZ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IACxB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE;IACnD,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;IACvB,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,MAAM,EAAE,WAAW;IACnB,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,oBAAoB,CAAC;IAC1D,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,iBAAiB,CAAC;CACxD,CAAC;KACD,QAAQ,CAAC,UAAU,CAAC,CAAC;AAGxB,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,YAAY,CAAC;IAC3C,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IACxB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE;IACnD,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;IACvB,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IAC3D,MAAM,EAAE,WAAW,CAAC,QAAQ,EAAE;IAC9B,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,QAAQ,EAAE;IACrE,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAAE;CACnE,CAAC,CAAC;AAGH,MAAM,aAAa,GAAG,CAAC,KAAgB,EAAa,EAAE,CACpD,OAAO,KAAK,KAAK,QAAQ;IACvB,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE;IACzE,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AAE1C,MAAM,aAAa,GAAG,CAAC,KAAgB,EAAa,EAAE;IACpD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,KAAK,CAAC;QACjC,OAAO;YACL,EAAE,EAAE,GAAG,IAAI,IAAI,EAAE,EAAE;YACnB,IAAI;YACJ,EAAE;YACF,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;SAC5C,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,GAAG,KAAK,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC;AACnE,CAAC,CAAC;AAEF,SAAS,kBAAkB,CAAC,KAAqB;IAC/C,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;IAC1D,OAAO;QACL,GAAG,IAAI;QACP,QAAQ,EAAE,QAAQ,IAAI,KAAK;QAC3B,MAAM,EAAE,MAAM,IAAI,MAAM;QACxB,KAAK,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC;QACvC,KAAK,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC;KACxC,CAAC;AACJ,CAAC;AAED,wDAAwD;AACxD,SAAS,QAAQ,CAAC,EAAU,EAAE,IAA4B;IACxD,OAAO,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,OAAO;QACpC,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC;YACE;gBACE,IAAI;gBACJ,OAAO,EAAE,IAAI,EAAE,qBAAqB;gBACpC,IAAI,EAAE,0GAA0G;aACjH;SACF,CAAC;AACR,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,IAAe;IAC/C,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACnD,MAAM,MAAM,GAAgB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACtD,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAC7B,CAAC;IACF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;QAC7B,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAChD,KAAK,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,CAAU;YACvC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACvB,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC,EAAE,GAAG,CAAC;oBACvB,OAAO,EAAE,SAAS,IAAI,CAAC,EAAE,cAAc,IAAI,CAAC,GAAG,CAAC,wBAAwB;iBACzE,CAAC,CAAC;IACT,CAAC,CAAC,CAAC;IACH,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ;QAC1B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YAC1B,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS;gBACxC,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;oBAClB,OAAO,EAAE,SAAS,CAAC,CAAC,EAAE,uCAAuC;iBAC9D,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACL,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;AAChE,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;AAE7D,MAAM,OAAO,GAAG,CACd,OAAU,EACV,OAAU,EACV,EAAE,CACF,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IAC3B,CAAC;SACE,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;SAC3D,QAAQ,CAAC,aAAa,CAAC;IAC1B,CAAC;SACE,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;SAC9D,QAAQ,CAAC,qCAAqC,CAAC;IAClD,CAAC;SACE,YAAY,CAAC;QACZ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;QAC3B,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,MAAM;KACd,CAAC;SACD,QAAQ,CAAC,kCAAkC,CAAC;IAC/C,CAAC;SACE,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;SAC3D,QAAQ,CAAC,qCAAqC,CAAC;IAClD,CAAC;SACE,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;SAC9D,QAAQ,CAAC,iBAAiB,CAAC;IAC9B,CAAC;SACE,YAAY,CAAC;QACZ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;QAC5B,IAAI,EAAE,OAAO;QACb,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE;KAC1B,CAAC;SACD,QAAQ,CAAC,oDAAoD,CAAC;IACjE,CAAC;SACE,YAAY,CAAC;QACZ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;QAC5B,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;QACvB,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;KACxB,CAAC;SACD,QAAQ,CACP,yEAAyE,CAC1E;IACH,CAAC;SACE,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;SACzD,QAAQ,CAAC,sDAAsD,CAAC;IACnE,CAAC;SACE,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;SAC1D,QAAQ,CAAC,sDAAsD,CAAC;IACnE,CAAC;SACE,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;SACvE,QAAQ,CACP,wFAAwF,CACzF;IACH,CAAC;SACE,YAAY,CAAC;QACZ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;QAC1B,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,OAAO,CAAC,QAAQ,EAAE;KACzB,CAAC;SACD,QAAQ,CAAC,mDAAmD,CAAC;IAChE,CAAC;SACE,YAAY,CAAC;QACZ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;QAC3B,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;KACpC,CAAC;SACD,QAAQ,CACP,gFAAgF,CACjF;IACH,CAAC;SACE,YAAY,CAAC;QACZ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;QAC3B,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE;KAClD,CAAC;SACD,QAAQ,CACP,uIAAuI,CACxI;IACH,CAAC;SACE,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;SAC/C,QAAQ,CACP,kFAAkF,CACnF;CACJ,CAAC,CAAC;AAEL,MAAM,CAAC,MAAM,WAAW,GAAG,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;AAEzD,MAAM,CAAC,MAAM,gBAAgB,GAAG,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;AAG9D,MAAM,CAAC,MAAM,SAAS,GAKjB;IACH,IAAI,EAAE,OAAO;IACb,IAAI,EAAE,SAAS;IACf,SAAS,EAAE,cAAc;IACzB,MAAM,EAAE,WAAW;IACnB,WAAW,EAAE,gBAAgB;IAC7B,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC;IACjC,aAAa,EAAE,kBAAkB;IACjC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC;QACjB,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAS,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACtE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAS,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;KACvE;IACD,YAAY,EAAE,iBAAiB;IAC/B,eAAe,EAAE,CAAC,KAAK,EAAE,EAAE;QACzB,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;YAC1B,OAAO,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACvD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;YAC1B,OAAO,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACvD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,aAAa,EAAE,CAAC,MAAM,EAAE,EAAE,CACxB,MAAM,CAAC,IAAI,KAAK,SAAS;QACvB,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1C,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,SAAS;YACzB,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1C,CAAC,CAAC,EAAE;CACX,CAAC"}

package/dist/kinds/hash-table.d.ts

@@ -0,0 +1,108 @@
+/**
+ * The `hashTable` kind: a hash table with separate chaining. Each bucket
+ * holds a chain of elements, addressed as `bucket` and `index` in the
+ * chain. (Open addressing needs no kind of its own: it is an array.)
+ *
+ * The hash function is the author's: actions name the bucket, and step
+ * narration can show the computation.
+ *
+ * Marks: `highlight` lasts one step; `settle` persists until `resetMarks`.
+ */
+import { z } from 'zod';
+import { type KindSpec } from './kind.ts';
+export declare const HashTableDecl: z.ZodObject<{
+    kind: z.ZodLiteral<"hashTable">;
+    label: z.ZodOptional<z.ZodString>;
+    place: z.ZodOptional<z.ZodEnum<{
+        main: "main";
+        side: "side";
+    }>>;
+    buckets: z.ZodArray<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        value: z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean, z.ZodNull]>;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
+export type HashTableDecl = z.infer<typeof HashTableDecl>;
+export declare const HashTableDeclInput: z.ZodObject<{
+    kind: z.ZodLiteral<"hashTable">;
+    label: z.ZodOptional<z.ZodString>;
+    place: z.ZodOptional<z.ZodEnum<{
+        main: "main";
+        side: "side";
+    }>>;
+    size: z.ZodOptional<z.ZodInt>;
+    initial: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+        id: z.ZodString;
+        value: z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean, z.ZodNull]>;
+    }, z.core.$strict>, z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean, z.ZodNull]>]>>>>;
+    buckets: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        value: z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean, z.ZodNull]>;
+    }, z.core.$strict>>>>;
+}, z.core.$strict>;
+export type HashTableDeclInput = z.infer<typeof HashTableDeclInput>;
+export declare const HashTableAction: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"insert">;
+    bucket: z.ZodInt;
+    element: z.ZodObject<{
+        id: z.ZodString;
+        value: z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean, z.ZodNull]>;
+    }, z.core.$strict>;
+    index: z.ZodOptional<z.ZodInt>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"remove">;
+    bucket: z.ZodInt;
+    index: z.ZodInt;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"set">;
+    bucket: z.ZodInt;
+    index: z.ZodInt;
+    value: z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean, z.ZodNull]>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"highlight">;
+    bucket: z.ZodInt;
+    indices: z.ZodOptional<z.ZodArray<z.ZodInt>>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"settle">;
+    bucket: z.ZodInt;
+    index: z.ZodInt;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"resetMarks">;
+}, z.core.$strict>], "type">;
+export type HashTableAction = z.infer<typeof HashTableAction>;
+export declare const HashTableActionInput: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"insert">;
+    bucket: z.ZodInt;
+    element: z.ZodUnion<readonly [z.ZodObject<{
+        id: z.ZodString;
+        value: z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean, z.ZodNull]>;
+    }, z.core.$strict>, z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean, z.ZodNull]>]>;
+    index: z.ZodOptional<z.ZodInt>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"remove">;
+    bucket: z.ZodInt;
+    index: z.ZodInt;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"set">;
+    bucket: z.ZodInt;
+    index: z.ZodInt;
+    value: z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean, z.ZodNull]>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"highlight">;
+    bucket: z.ZodInt;
+    indices: z.ZodOptional<z.ZodArray<z.ZodInt>>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"settle">;
+    bucket: z.ZodInt;
+    index: z.ZodInt;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"resetMarks">;
+}, z.core.$strict>], "type">;
+export type HashTableActionInput = z.infer<typeof HashTableActionInput>;
+export declare const hashTableSpec: KindSpec<{
+    decl: HashTableDecl;
+    declInput: HashTableDeclInput;
+    action: HashTableAction;
+    actionInput: HashTableActionInput;
+}>;
+//# sourceMappingURL=hash-table.d.ts.map

package/dist/kinds/hash-table.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hash-table.d.ts","sourceRoot":"","sources":["../../src/kinds/hash-table.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAWxB,OAAO,EAAuC,KAAK,QAAQ,EAAE,MAAM,WAAW,CAAC;AAU/E,eAAO,MAAM,aAAa;;;;;;;;;;;kBAUyB,CAAC;AACpD,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAE1D,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;kBAgCuB,CAAC;AACvD,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAuDpE,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;4BAAmB,CAAC;AAChD,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAC9D,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;4BAAwB,CAAC;AAC1D,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAExE,eAAO,MAAM,aAAa,EAAE,QAAQ,CAAC;IACnC,IAAI,EAAE,aAAa,CAAC;IACpB,SAAS,EAAE,kBAAkB,CAAC;IAC9B,MAAM,EAAE,eAAe,CAAC;IACxB,WAAW,EAAE,oBAAoB,CAAC;CACnC,CAgCA,CAAC"}

package/dist/kinds/hash-table.js

@@ -0,0 +1,133 @@
+/**
+ * The `hashTable` kind: a hash table with separate chaining. Each bucket
+ * holds a chain of elements, addressed as `bucket` and `index` in the
+ * chain. (Open addressing needs no kind of its own: it is an array.)
+ *
+ * The hash function is the author's: actions name the bucket, and step
+ * narration can show the computation.
+ *
+ * Marks: `highlight` lasts one step; `settle` persists until `resetMarks`.
+ */
+import { z } from 'zod';
+import { Element, ElementInput, Index, isElement, LIMITS, Place, Scalar, } from "../common.js";
+import { typesOf } from "./kind.js";
+const MAX_BUCKETS = 100;
+const Bucket = z
+    .int()
+    .min(0)
+    .max(MAX_BUCKETS - 1)
+    .describe('Bucket number.');
+export const HashTableDecl = z
+    .strictObject({
+    kind: z.literal('hashTable'),
+    label: z.string().max(LIMITS.textLength).optional(),
+    place: Place.optional(),
+    buckets: z
+        .array(z.array(Element).max(LIMITS.elementsPerStructure))
+        .min(1)
+        .max(MAX_BUCKETS),
+})
+    .describe('A hash table with separate chaining.');
+export const HashTableDeclInput = z
+    .strictObject({
+    kind: z.literal('hashTable'),
+    label: z.string().max(LIMITS.textLength).optional(),
+    place: Place.optional(),
+    size: z
+        .int()
+        .min(1)
+        .max(MAX_BUCKETS)
+        .optional()
+        .describe('Number of buckets; at least the length of `initial`.'),
+    initial: z
+        .array(z.array(ElementInput).max(LIMITS.elementsPerStructure))
+        .max(MAX_BUCKETS)
+        .optional()
+        .describe('Chains per bucket, e.g. [[10, 20], [], [7]]; bare values get ids e0, e1, … in reading order.'),
+    buckets: z
+        .array(z.array(Element).max(LIMITS.elementsPerStructure))
+        .min(1)
+        .max(MAX_BUCKETS)
+        .optional()
+        .describe('The canonical form: every bucket with explicit elements. Accepted so that parsed documents can be read again.'),
+})
+    .refine((d) => d.buckets === undefined || d.initial === undefined, {
+    message: 'Give either `initial` or `buckets`, not both',
+    path: ['buckets'],
+})
+    // The same rule for JSON Schema validators, which cannot run the refinement.
+    .meta({ not: { required: ['initial', 'buckets'] } });
+function normalizeHashTableDecl(input) {
+    const { size, buckets: given, ...others } = input;
+    const { initial = given ?? [], ...rest } = others;
+    let next = 0;
+    const count = Math.max(size ?? 0, initial.length, 1);
+    const buckets = Array.from({ length: count }, (_, b) => (initial[b] ?? []).map((x) => isElement(x) ? x : { id: `e${next++}`, value: x }));
+    return { ...rest, buckets };
+}
+const actions = (element) => z.discriminatedUnion('type', [
+    z
+        .strictObject({
+        type: z.literal('insert'),
+        bucket: Bucket,
+        element,
+        index: Index.optional().describe('Position in the chain; default the end.'),
+    })
+        .describe('Insert an element into a bucket’s chain.'),
+    z
+        .strictObject({ type: z.literal('remove'), bucket: Bucket, index: Index })
+        .describe('Remove an element from a chain.'),
+    z
+        .strictObject({
+        type: z.literal('set'),
+        bucket: Bucket,
+        index: Index,
+        value: Scalar,
+    })
+        .describe('Change an element’s value, e.g. update the value for a key.'),
+    z
+        .strictObject({
+        type: z.literal('highlight'),
+        bucket: Bucket,
+        indices: z.array(Index).max(LIMITS.elementsPerStructure).optional(),
+    })
+        .describe('Highlight a bucket and, optionally, elements of its chain (this step only), e.g. while probing.'),
+    z
+        .strictObject({ type: z.literal('settle'), bucket: Bucket, index: Index })
+        .describe('Mark an element as found (persists).'),
+    z
+        .strictObject({ type: z.literal('resetMarks') })
+        .describe('Clear every mark.'),
+]);
+export const HashTableAction = actions(Element);
+export const HashTableActionInput = actions(ElementInput);
+export const hashTableSpec = {
+    kind: 'hashTable',
+    decl: HashTableDecl,
+    declInput: HashTableDeclInput,
+    action: HashTableAction,
+    actionInput: HashTableActionInput,
+    actionTypes: typesOf(HashTableAction),
+    normalizeDecl: normalizeHashTableDecl,
+    declIds: (decl) => decl.buckets.flatMap((chain, b) => 
+    // Reported against the authoring field, `initial`.
+    chain.map((e, k) => ({ id: e.id, path: ['initial', b, k, 'id'] }))),
+    validateDecl: (decl) => {
+        const total = decl.buckets.reduce((n, chain) => n + chain.length, 0);
+        return total <= LIMITS.elementsPerStructure
+            ? []
+            : [
+                {
+                    path: ['initial'],
+                    message: `The table holds ${total} elements; at most ${LIMITS.elementsPerStructure} are allowed`,
+                },
+            ];
+    },
+    normalizeAction: (input, ctx) => input.type === 'insert' && !isElement(input.element)
+        ? { ...input, element: { id: ctx.allocateId('e'), value: input.element } }
+        : input,
+    introducedIds: (action) => action.type === 'insert'
+        ? [{ id: action.element.id, path: ['element', 'id'] }]
+        : [],
+};
+//# sourceMappingURL=hash-table.js.map

package/dist/kinds/hash-table.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hash-table.js","sourceRoot":"","sources":["../../src/kinds/hash-table.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EACL,OAAO,EACP,YAAY,EACZ,KAAK,EACL,SAAS,EACT,MAAM,EACN,KAAK,EACL,MAAM,GACP,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,OAAO,EAA6C,MAAM,WAAW,CAAC;AAE/E,MAAM,WAAW,GAAG,GAAG,CAAC;AAExB,MAAM,MAAM,GAAG,CAAC;KACb,GAAG,EAAE;KACL,GAAG,CAAC,CAAC,CAAC;KACN,GAAG,CAAC,WAAW,GAAG,CAAC,CAAC;KACpB,QAAQ,CAAC,gBAAgB,CAAC,CAAC;AAE9B,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC;KAC3B,YAAY,CAAC;IACZ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;IAC5B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE;IACnD,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;IACvB,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;SACxD,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,WAAW,CAAC;CACpB,CAAC;KACD,QAAQ,CAAC,sCAAsC,CAAC,CAAC;AAGpD,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,YAAY,CAAC;IACZ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;IAC5B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE;IACnD,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;IACvB,IAAI,EAAE,CAAC;SACJ,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,WAAW,CAAC;SAChB,QAAQ,EAAE;SACV,QAAQ,CAAC,sDAAsD,CAAC;IACnE,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;SAC7D,GAAG,CAAC,WAAW,CAAC;SAChB,QAAQ,EAAE;SACV,QAAQ,CACP,8FAA8F,CAC/F;IACH,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;SACxD,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,WAAW,CAAC;SAChB,QAAQ,EAAE;SACV,QAAQ,CACP,+GAA+G,CAChH;CACJ,CAAC;KACD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,CAAC,OAAO,KAAK,SAAS,EAAE;IACjE,OAAO,EAAE,8CAA8C;IACvD,IAAI,EAAE,CAAC,SAAS,CAAC;CAClB,CAAC;IACF,6EAA6E;KAC5E,IAAI,CAAC,EAAE,GAAG,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,CAAC;AAGvD,SAAS,sBAAsB,CAAC,KAAyB;IACvD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,MAAM,EAAE,GAAG,KAAK,CAAC;IAClD,MAAM,EAAE,OAAO,GAAG,KAAK,IAAI,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IAClD,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACrD,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACrD,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAC3B,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAClD,CACF,CAAC;IACF,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,CAAC;AAC9B,CAAC;AAED,MAAM,OAAO,GAAG,CAAsB,OAAU,EAAE,EAAE,CAClD,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IAC3B,CAAC;SACE,YAAY,CAAC;QACZ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;QACzB,MAAM,EAAE,MAAM;QACd,OAAO;QACP,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAC9B,yCAAyC,CAC1C;KACF,CAAC;SACD,QAAQ,CAAC,0CAA0C,CAAC;IACvD,CAAC;SACE,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;SACzE,QAAQ,CAAC,iCAAiC,CAAC;IAC9C,CAAC;SACE,YAAY,CAAC;QACZ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;QACtB,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,KAAK;QACZ,KAAK,EAAE,MAAM;KACd,CAAC;SACD,QAAQ,CAAC,6DAA6D,CAAC;IAC1E,CAAC;SACE,YAAY,CAAC;QACZ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;QAC5B,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,QAAQ,EAAE;KACpE,CAAC;SACD,QAAQ,CACP,iGAAiG,CAClG;IACH,CAAC;SACE,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;SACzE,QAAQ,CAAC,sCAAsC,CAAC;IACnD,CAAC;SACE,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;SAC/C,QAAQ,CAAC,mBAAmB,CAAC;CACjC,CAAC,CAAC;AAEL,MAAM,CAAC,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AAEhD,MAAM,CAAC,MAAM,oBAAoB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AAG1D,MAAM,CAAC,MAAM,aAAa,GAKrB;IACH,IAAI,EAAE,WAAW;IACjB,IAAI,EAAE,aAAa;IACnB,SAAS,EAAE,kBAAkB;IAC7B,MAAM,EAAE,eAAe;IACvB,WAAW,EAAE,oBAAoB;IACjC,WAAW,EAAE,OAAO,CAAC,eAAe,CAAC;IACrC,aAAa,EAAE,sBAAsB;IACrC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAChB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;IAChC,mDAAmD;IACnD,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAS,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAC1E;IACH,YAAY,EAAE,CAAC,IAAI,EAAe,EAAE;QAClC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACrE,OAAO,KAAK,IAAI,MAAM,CAAC,oBAAoB;YACzC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC;gBACE;oBACE,IAAI,EAAE,CAAC,SAAS,CAAC;oBACjB,OAAO,EAAE,mBAAmB,KAAK,sBAAsB,MAAM,CAAC,oBAAoB,cAAc;iBACjG;aACF,CAAC;IACR,CAAC;IACD,eAAe,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAC9B,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC;QAClD,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,EAAE;QAC1E,CAAC,CAAE,KAAyB;IAChC,aAAa,EAAE,CAAC,MAAM,EAAE,EAAE,CACxB,MAAM,CAAC,IAAI,KAAK,QAAQ;QACtB,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,CAAC;QACtD,CAAC,CAAC,EAAE;CACT,CAAC"}

package/dist/kinds/index.d.ts

@@ -0,0 +1,98 @@
+import type { KindSpec } from './kind.ts';
+export * from './array.ts';
+export * from './btree.ts';
+export * from './graph.ts';
+export * from './hash-table.ts';
+export * from './kind.ts';
+export * from './linked-list.ts';
+export * from './plane.ts';
+export * from './priority-queue.ts';
+export * from './queue.ts';
+export * from './stack.ts';
+export * from './table.ts';
+export * from './tree.ts';
+declare const registry: {
+    array: KindSpec<{
+        decl: import("./array.ts").ArrayDecl;
+        declInput: import("./array.ts").ArrayDeclInput;
+        action: import("./array.ts").ArrayAction;
+        actionInput: import("./array.ts").ArrayActionInput;
+    }>;
+    stack: KindSpec<{
+        decl: import("./stack.ts").StackDecl;
+        declInput: import("./stack.ts").StackDeclInput;
+        action: import("./stack.ts").StackAction;
+        actionInput: import("./stack.ts").StackActionInput;
+    }>;
+    queue: KindSpec<{
+        decl: import("./queue.ts").QueueDecl;
+        declInput: import("./queue.ts").QueueDeclInput;
+        action: import("./queue.ts").QueueAction;
+        actionInput: import("./queue.ts").QueueActionInput;
+    }>;
+    linkedList: KindSpec<{
+        decl: import("./linked-list.ts").LinkedListDecl;
+        declInput: import("./linked-list.ts").LinkedListDeclInput;
+        action: import("./linked-list.ts").LinkedListAction;
+        actionInput: import("./linked-list.ts").LinkedListActionInput;
+    }>;
+    tree: KindSpec<{
+        decl: import("./tree.ts").TreeDecl;
+        declInput: import("./tree.ts").TreeDeclInput;
+        action: import("./tree.ts").TreeAction;
+        actionInput: import("./tree.ts").TreeActionInput;
+    }>;
+    graph: KindSpec<{
+        decl: import("./graph.ts").GraphDecl;
+        declInput: import("./graph.ts").GraphDeclInput;
+        action: import("./graph.ts").GraphAction;
+        actionInput: import("./graph.ts").GraphActionInput;
+    }>;
+    table: KindSpec<{
+        decl: import("./table.ts").TableDecl;
+        declInput: import("./table.ts").TableDeclInput;
+        action: import("./table.ts").TableAction;
+        actionInput: import("./table.ts").TableAction;
+    }>;
+    hashTable: KindSpec<{
+        decl: import("./hash-table.ts").HashTableDecl;
+        declInput: import("./hash-table.ts").HashTableDeclInput;
+        action: import("./hash-table.ts").HashTableAction;
+        actionInput: import("./hash-table.ts").HashTableActionInput;
+    }>;
+    priorityQueue: KindSpec<{
+        decl: import("./priority-queue.ts").PriorityQueueDecl;
+        declInput: import("./priority-queue.ts").PriorityQueueDeclInput;
+        action: import("./priority-queue.ts").PriorityQueueAction;
+        actionInput: import("./priority-queue.ts").PriorityQueueActionInput;
+    }>;
+    btree: KindSpec<{
+        decl: import("./btree.ts").BTreeDecl;
+        declInput: import("./btree.ts").BTreeDeclInput;
+        action: import("./btree.ts").BTreeAction;
+        actionInput: import("./btree.ts").BTreeActionInput;
+    }>;
+    plane: KindSpec<{
+        decl: import("./plane.ts").PlaneDecl;
+        declInput: import("./plane.ts").PlaneDeclInput;
+        action: import("./plane.ts").PlaneAction;
+        actionInput: import("./plane.ts").PlaneActionInput;
+    }>;
+};
+export type StructureKindName = keyof typeof registry;
+/** The types of each kind, keyed by kind name. */
+export type KindTypeMap = {
+    [K in StructureKindName]: (typeof registry)[K] extends KindSpec<infer T> ? T : never;
+};
+/**
+ * The registry, typed so that `kinds[k]` for a generic `K` is
+ * `KindSpec<KindTypeMap[K]>`; that lets callers dispatch on a kind name
+ * without a switch (TypeScript's "correlated union" pattern).
+ */
+export declare const kinds: {
+    readonly [K in StructureKindName]: KindSpec<KindTypeMap[K]>;
+};
+export declare const kindNames: StructureKindName[];
+/** The action `type` values defined for a kind, e.g. `['set', 'swap', …]`. */
+export declare const actionTypesOf: (kind: StructureKindName) => readonly string[];
+//# sourceMappingURL=index.d.ts.map

package/dist/kinds/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/kinds/index.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,QAAQ,EAAa,MAAM,WAAW,CAAC;AASrD,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,WAAW,CAAC;AAC1B,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAE1B,QAAA,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAYb,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,MAAM,OAAO,QAAQ,CAAC;AAEtD,kDAAkD;AAClD,MAAM,MAAM,WAAW,GAAG;KACvB,CAAC,IAAI,iBAAiB,GAAG,CAAC,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,CAAC,MAAM,CAAC,CAAC,GACpE,CAAC,GACD,KAAK;CACV,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,KAAK,EAAE;IAClB,QAAQ,EAAE,CAAC,IAAI,iBAAiB,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;CACjD,CAAC;AAEb,eAAO,MAAM,SAAS,EAA4B,iBAAiB,EAAE,CAAC;AAEtE,8EAA8E;AAC9E,eAAO,MAAM,aAAa,GAAI,MAAM,iBAAiB,KAAG,SAAS,MAAM,EAC9C,CAAC"}

package/dist/kinds/index.js

@@ -0,0 +1,53 @@
+/**
+ * Registry of built-in structure kinds (ADR 0012). Adding a kind means
+ * writing its module and adding one entry here and in `visualization.ts`.
+ */
+import { arraySpec } from "./array.js";
+import { btreeSpec } from "./btree.js";
+import { graphSpec } from "./graph.js";
+import { hashTableSpec } from "./hash-table.js";
+import { linkedListSpec } from "./linked-list.js";
+import { planeSpec } from "./plane.js";
+import { priorityQueueSpec } from "./priority-queue.js";
+import { queueSpec } from "./queue.js";
+import { stackSpec } from "./stack.js";
+import { tableSpec } from "./table.js";
+import { treeSpec } from "./tree.js";
+export * from "./array.js";
+export * from "./btree.js";
+export * from "./graph.js";
+export * from "./hash-table.js";
+export * from "./kind.js";
+export * from "./linked-list.js";
+export * from "./plane.js";
+export * from "./priority-queue.js";
+export * from "./queue.js";
+export * from "./stack.js";
+export * from "./table.js";
+export * from "./tree.js";
+const registry = {
+    array: arraySpec,
+    stack: stackSpec,
+    queue: queueSpec,
+    linkedList: linkedListSpec,
+    tree: treeSpec,
+    graph: graphSpec,
+    table: tableSpec,
+    hashTable: hashTableSpec,
+    priorityQueue: priorityQueueSpec,
+    btree: btreeSpec,
+    plane: planeSpec,
+};
+/**
+ * The registry, typed so that `kinds[k]` for a generic `K` is
+ * `KindSpec<KindTypeMap[K]>`; that lets callers dispatch on a kind name
+ * without a switch (TypeScript's "correlated union" pattern).
+ */
+export const kinds = registry;
+export const kindNames = Object.keys(registry);
+/** The action `type` values defined for a kind, e.g. `['set', 'swap', …]`. */
+export const actionTypesOf = (kind) => kinds[kind].actionTypes;
+// Every entry must satisfy the generic contract.
+const _check = registry;
+void _check;
+//# sourceMappingURL=index.js.map

package/dist/kinds/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/kinds/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,WAAW,CAAC;AAC1B,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAE1B,MAAM,QAAQ,GAAG;IACf,KAAK,EAAE,SAAS;IAChB,KAAK,EAAE,SAAS;IAChB,KAAK,EAAE,SAAS;IAChB,UAAU,EAAE,cAAc;IAC1B,IAAI,EAAE,QAAQ;IACd,KAAK,EAAE,SAAS;IAChB,KAAK,EAAE,SAAS;IAChB,SAAS,EAAE,aAAa;IACxB,aAAa,EAAE,iBAAiB;IAChC,KAAK,EAAE,SAAS;IAChB,KAAK,EAAE,SAAS;CACjB,CAAC;AAWF;;;;GAIG;AACH,MAAM,CAAC,MAAM,KAAK,GAEd,QAAQ,CAAC;AAEb,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAwB,CAAC;AAEtE,8EAA8E;AAC9E,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAAuB,EAAqB,EAAE,CAC1E,KAAK,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC;AAE1B,iDAAiD;AACjD,MAAM,MAAM,GAAwC,QAAQ,CAAC;AAC7D,KAAK,MAAM,CAAC"}