@the-package-labs/idocs-core 0.3.1 → 0.5.0

package/dist/schema.d.ts

@@ -28,10 +28,24 @@ export declare const DirectionSchema: z.ZodEnum<{
     RIGHT: "RIGHT";
     UP: "UP";
 }>;
+/** One field per list item: `- name`, `- name: type` or `- name: { type, key, ref, note }`. */
+declare const FieldSchema: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNull, z.ZodObject<{
+    type: z.ZodOptional<z.ZodString>;
+    key: z.ZodOptional<z.ZodBoolean>;
+    ref: z.ZodOptional<z.ZodString>;
+    note: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>]>>]>;
 export declare const NodeSchema: z.ZodObject<{
     title: z.ZodOptional<z.ZodString>;
     sub: z.ZodOptional<z.ZodString>;
+    pill: z.ZodOptional<z.ZodString>;
     lines: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    fields: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNull, z.ZodObject<{
+        type: z.ZodOptional<z.ZodString>;
+        key: z.ZodOptional<z.ZodBoolean>;
+        ref: z.ZodOptional<z.ZodString>;
+        note: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>]>>]>>>;
     icon: z.ZodOptional<z.ZodString>;
     kind: z.ZodOptional<z.ZodString>;
     family: z.ZodOptional<z.ZodEnum<{
@@ -65,6 +79,17 @@ export declare const NodeSchema: z.ZodObject<{
     }, z.core.$strict>>>;
     refs: z.ZodOptional<z.ZodArray<z.ZodString>>;
     tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    diagram: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        name: z.ZodString;
+        view: z.ZodOptional<z.ZodString>;
+        scenario: z.ZodOptional<z.ZodString>;
+        mode: z.ZodOptional<z.ZodEnum<{
+            both: "both";
+            expand: "expand";
+            open: "open";
+        }>>;
+        expanded: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>]>>;
 }, z.core.$strict>;
 export declare const GroupSchema: z.ZodObject<{
     label: z.ZodString;
@@ -429,10 +454,34 @@ export declare const ScenarioSchema: z.ZodObject<{
         }, z.core.$strict>], "type">>;
     }, z.core.$strict>], "type">>>;
 }, z.core.$strict>;
+export declare const DefaultsSchema: z.ZodObject<{
+    view: z.ZodOptional<z.ZodString>;
+    scenario: z.ZodOptional<z.ZodString>;
+    mode: z.ZodOptional<z.ZodEnum<{
+        flow: "flow";
+        sequence: "sequence";
+        story: "story";
+    }>>;
+    sidebar: z.ZodOptional<z.ZodBoolean>;
+    subtitles: z.ZodOptional<z.ZodBoolean>;
+    autoplay: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
 export declare const RootSchema: z.ZodObject<{
     $schema: z.ZodOptional<z.ZodString>;
     title: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
+    defaults: z.ZodOptional<z.ZodObject<{
+        view: z.ZodOptional<z.ZodString>;
+        scenario: z.ZodOptional<z.ZodString>;
+        mode: z.ZodOptional<z.ZodEnum<{
+            flow: "flow";
+            sequence: "sequence";
+            story: "story";
+        }>>;
+        sidebar: z.ZodOptional<z.ZodBoolean>;
+        subtitles: z.ZodOptional<z.ZodBoolean>;
+        autoplay: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>>;
     kinds: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
         icon: z.ZodOptional<z.ZodString>;
         family: z.ZodOptional<z.ZodEnum<{
@@ -487,7 +536,14 @@ export declare const RootSchema: z.ZodObject<{
     nodes: z.ZodRecord<z.ZodString, z.ZodObject<{
         title: z.ZodOptional<z.ZodString>;
         sub: z.ZodOptional<z.ZodString>;
+        pill: z.ZodOptional<z.ZodString>;
         lines: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        fields: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNull, z.ZodObject<{
+            type: z.ZodOptional<z.ZodString>;
+            key: z.ZodOptional<z.ZodBoolean>;
+            ref: z.ZodOptional<z.ZodString>;
+            note: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>]>>]>>>;
         icon: z.ZodOptional<z.ZodString>;
         kind: z.ZodOptional<z.ZodString>;
         family: z.ZodOptional<z.ZodEnum<{
@@ -521,6 +577,17 @@ export declare const RootSchema: z.ZodObject<{
         }, z.core.$strict>>>;
         refs: z.ZodOptional<z.ZodArray<z.ZodString>>;
         tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        diagram: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+            name: z.ZodString;
+            view: z.ZodOptional<z.ZodString>;
+            scenario: z.ZodOptional<z.ZodString>;
+            mode: z.ZodOptional<z.ZodEnum<{
+                both: "both";
+                expand: "expand";
+                open: "open";
+            }>>;
+            expanded: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strict>]>>;
     }, z.core.$strict>>;
     edges: z.ZodOptional<z.ZodArray<z.ZodObject<{
         id: z.ZodOptional<z.ZodString>;
@@ -762,6 +829,7 @@ export declare const RootSchema: z.ZodObject<{
     }, z.core.$strict>>>;
 }, z.core.$strict>;
 export type RootInput = z.infer<typeof RootSchema>;
+export type FieldInput = z.infer<typeof FieldSchema>;
 export type Step = z.infer<typeof StepSchema>;
 export declare const KNOWN_KEYS: {
     readonly root: string[];
@@ -770,6 +838,7 @@ export declare const KNOWN_KEYS: {
     readonly edge: string[];
     readonly view: string[];
     readonly scenario: string[];
+    readonly defaults: string[];
 };
 type Json = Record<string, unknown>;
 /**

package/dist/scrubber.d.ts

@@ -0,0 +1,34 @@
+import type { Timeline } from './timeline';
+/** One stop of the slider: a step, or the steps of a `par` block that start together. */
+export interface Slot {
+    /** First and last step of the slot, as indexes into `scenario.steps`. */
+    from: number;
+    to: number;
+    /** The time it covers. A slot runs until the next one starts, so pauses belong to the step before. */
+    t0: number;
+    t1: number;
+}
+/** A run of slots under one phase. A scenario without named phases is one section with no title. */
+export interface Section {
+    /** Index in `scenario.phases`. */
+    phase: number;
+    title: string;
+    caption?: string;
+    /** First and last slot. */
+    from: number;
+    to: number;
+}
+export interface Scrubber {
+    slots: Slot[];
+    sections: Section[];
+    duration: number;
+}
+export declare function buildScrubber(tl: Timeline): Scrubber;
+/** Where on the slider, 0 to 1, the moment `t` falls. */
+export declare function positionAt(s: Scrubber, t: number): number;
+/** The moment a place on the slider stands for. The inverse of `positionAt`. */
+export declare function timeAt(s: Scrubber, position: number): number;
+/** The slot a place on the slider falls in. */
+export declare function slotAt(s: Scrubber, position: number): number;
+/** The slot that holds step `index`, or -1. */
+export declare function slotOfStep(s: Scrubber, index: number): number;

package/dist/start.d.ts

@@ -0,0 +1,22 @@
+import type { CompiledDiagram, ScenarioMode } from './types';
+/** What the page that shows a diagram asked for, if anything. Its choices win over the diagram's. */
+export interface StartWant {
+    view?: string;
+    scenario?: string;
+    mode?: ScenarioMode;
+}
+export interface Start {
+    /** Always one of the diagram's views. */
+    view: string;
+    /** The scenario selected first, or null for the overview. */
+    scenario: string | null;
+    mode: ScenarioMode;
+}
+/** The mode a scenario is drawn in when neither it nor the page says: the diagram's, then `flow`. */
+export declare const defaultMode: (diagram: CompiledDiagram) => ScenarioMode;
+/**
+ * Where a diagram opens. The page's props come first, then what the diagram's author wrote under
+ * `defaults`, then the first view with nothing selected. The page choosing a scenario takes its
+ * view along, and one choosing a view leaves the default scenario out unless it plays there.
+ */
+export declare function startOf(diagram: CompiledDiagram, want?: StartWant): Start;

package/dist/suggest.d.ts

@@ -0,0 +1 @@
+export declare function didYouMean(word: string, options: readonly string[]): string | undefined;

package/dist/types.d.ts

@@ -19,11 +19,37 @@ export interface NodeLink {
     label: string;
     url: string;
 }
+/** Another diagram that shows the inside of a node. Resolved by name against the project's diagrams. */
+export interface NodeDiagram {
+    name: string;
+    view?: string;
+    scenario?: string;
+    /** How a reader can get at it: shown in place (`expand`), moved into (`open`), or either. */
+    mode?: 'both' | 'expand' | 'open';
+    /** Starts shown in place. */
+    expanded?: boolean;
+}
+/** A row of an entity card: one column, property or attribute of what the node stores. */
+export interface CompiledField {
+    name: string;
+    type?: string;
+    /** Part of the primary key. */
+    key?: boolean;
+    /** The node (and field) this one points at, like a foreign key. Each one draws a relation. */
+    ref?: {
+        node: string;
+        field?: string;
+    };
+    note?: string;
+}
 export interface CompiledNode {
     id: string;
     title: string;
     sub?: string;
+    /** A short label in the card header, like `TABLE` or `ES INDEX`. */
+    pill?: string;
     lines: string[];
+    fields: CompiledField[];
     icon?: IconData;
     kind?: string;
     family?: Family;
@@ -37,6 +63,8 @@ export interface CompiledNode {
     links: NodeLink[];
     refs: string[];
     tags: string[];
+    /** Opens one level deeper: the diagram that describes this node's inside. */
+    diagram?: NodeDiagram;
 }
 export interface CompiledGroup {
     id: string;
@@ -64,6 +92,9 @@ export interface CompiledEdge {
     id: string;
     from: string;
     to: string;
+    /** Set when the edge starts or ends on one field of an entity card. */
+    fromField?: string;
+    toField?: string;
     label?: string;
     kind: string;
     both: boolean;
@@ -135,16 +166,35 @@ export interface CompiledScenario {
     phases: CompiledPhase[];
     steps: CompiledStep[];
 }
+/**
+ * How a diagram opens, as its author wrote it. A page's own choices (the props of `<Diagram>`) win
+ * over these. Validated by the compiler: the view and the scenario exist, and agree.
+ */
+export interface DiagramDefaults {
+    view?: string;
+    scenario?: string;
+    mode?: ScenarioMode;
+    sidebar?: boolean;
+    subtitles?: boolean;
+    autoplay?: boolean;
+}
 export interface CompiledDiagram {
     name: string;
     title: string;
     descriptionHtml?: string;
+    defaults?: DiagramDefaults;
     nodes: Record<string, CompiledNode>;
     groups: Record<string, CompiledGroup>;
     edges: Record<string, CompiledEdge>;
     edgeKinds: Record<string, EdgeKindDef>;
     views: CompiledView[];
     scenarios: CompiledScenario[];
+    /**
+     * The diagrams its nodes open, by name, and the ones those open in turn. Added once every
+     * diagram of the project has compiled (`attachNested`), so a diagram is all a viewer needs. The
+     * entries themselves carry no `nested`.
+     */
+    nested?: Record<string, CompiledDiagram>;
 }
 export interface Pt {
     x: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@the-package-labs/idocs-core",
-  "version": "0.3.1",
+  "version": "0.5.0",
   "type": "module",
   "exports": {
     ".": {