@rse/specbook 1.5.2 → 1.6.1

package/dst/specbook-format-schema.d.ts

@@ -12,11 +12,25 @@ export type SchemaObject = {
     referenced?: string[];
     coverage?: string[];
     automaton?: SchemaAutomaton;
-    diagram?: SchemaDiagram;
+    badge?: SchemaBadge;
+    multiple?: SchemaMultiple;
+    diagram?: SchemaDiagram | SchemaDiagram[];
     format?: SchemaFormat;
     props?: SchemaProperty[];
     children?: SchemaObject[];
 };
+export declare const badgeIcons: readonly ["person", "team", "bot", "device", "mobile", "browser", "service", "function", "api", "code", "package", "database", "cache", "queue", "document", "mail", "communication", "clock", "security", "cloud", "network"];
+export type BadgeIcon = typeof badgeIcons[number];
+export type SchemaMultiple = {
+    property: string;
+    pattern: string;
+};
+export declare const reservedAttributes: readonly ["url", "type", "primary", "group", "cluster", "parent", "container", "order", "badge", "multiple", "mark", "layer", "slice", "state", "region", "petri", "tokens", "capacity", "duration", "start"];
+export type SchemaBadge = BadgeIcon | {
+    property: string;
+    map: Record<string, BadgeIcon>;
+    default?: BadgeIcon;
+};
 export type SchemaAutomaton = {
     nodes: string;
     edges: string;
@@ -46,23 +60,38 @@ export type SchemaDiagramNest = {
     layout?: "graph" | "hub" | "grid";
     crossing?: "nodes" | "target" | "both";
 };
+export declare const diagramTypes: readonly ["graph", "hub", "grid", "state", "layer", "slice", "tree", "matrix", "sequence", "petri", "gantt"];
+export type DiagramType = typeof diagramTypes[number];
 export type SchemaDiagram = {
-    type?: "graph" | "hub" | "grid";
+    type?: DiagramType;
     nodes?: string;
     edges?: string;
+    local?: boolean;
     center?: string | SchemaDiagramCenter;
     centerEdges?: SchemaDiagramCenterEdges;
-    links?: "props" | "all";
+    links?: "props" | "all" | string[];
     labeled?: boolean;
     edgeSource?: string;
     edgeTarget?: string;
     edgeArity?: string;
+    edgeGuard?: string;
+    edgeKind?: string;
+    edgeDuration?: string;
+    edgeTime?: string;
+    places?: string;
+    tokens?: string;
+    capacity?: string;
+    duration?: string;
+    start?: string;
     hierarchy?: boolean;
     deep?: boolean;
+    descend?: string[];
+    reverse?: string[];
     onlyConnected?: boolean;
     collapse?: boolean;
     qualified?: boolean;
     ordered?: boolean;
+    markUncovered?: "none" | "referenced" | "coverage" | "all";
     nest?: SchemaDiagramNest;
     properties?: string[];
     config?: Partial<GradiaConfig>;
@@ -85,3 +114,4 @@ export type SchemaProperty = {
     acyclic?: boolean;
 };
 export declare const Schema: v.GenericSchema<Schema>;
+export declare const diagramsOf: (schema: SchemaObject | undefined) => SchemaDiagram[];

package/dst/specbook-format-schema.js

@@ -5,6 +5,20 @@
 */
 import * as v from "valibot";
 import { Gradia } from "@rse/gradia";
+/*  the badge icons Gradia draws inside a node box (mirroring its
+    unexported list, as Gradia silently ignores an unknown icon)  */
+export const badgeIcons = ["person", "team", "bot", "device", "mobile", "browser", "service",
+    "function", "api", "code", "package", "database", "cache", "queue", "document", "mail",
+    "communication", "clock", "security", "cloud", "network"];
+/*  the node attribute keys Gradia consumes instead of displaying them
+    (generally, or for one of its diagram types), which hence cannot
+    name a displayed diagram property  */
+export const reservedAttributes = ["url", "type", "primary", "group", "cluster", "parent",
+    "container", "order", "badge", "multiple", "mark", "layer", "slice", "state", "region",
+    "petri", "tokens", "capacity", "duration", "start"];
+/*  the types of the diagrams derived from the object model  */
+export const diagramTypes = ["graph", "hub", "grid", "state", "layer", "slice", "tree", "matrix",
+    "sequence", "petri", "gantt"];
 /*  ==== Schema ====  */
 /*  the Gradia rendering options, derived from the configuration
     defaults of Gradia: the option names constrain the allowed keys and
@@ -37,6 +51,19 @@ const SchemaAutomaton = v.strictObject({
     initial: v.string(),
     final: v.string()
 });
+const SchemaBadgeIcon = v.picklist(badgeIcons);
+const SchemaBadge = v.union([
+    SchemaBadgeIcon,
+    v.strictObject({
+        property: v.string(),
+        map: v.record(v.string(), SchemaBadgeIcon),
+        default: v.optional(SchemaBadgeIcon)
+    })
+]);
+const SchemaMultiple = v.strictObject({
+    property: v.string(),
+    pattern: v.string()
+});
 const SchemaDiagramCenter = v.strictObject({
     source: v.optional(v.string()),
     property: v.optional(v.string()),
@@ -59,22 +86,35 @@ const SchemaDiagramNest = v.strictObject({
     crossing: v.optional(v.picklist(["nodes", "target", "both"]))
 });
 const SchemaDiagram = v.strictObject({
-    type: v.optional(v.picklist(["graph", "hub", "grid"])),
+    type: v.optional(v.picklist(diagramTypes)),
     nodes: v.optional(v.string()),
     edges: v.optional(v.string()),
+    local: v.optional(v.boolean()),
     center: v.optional(v.union([v.string(), SchemaDiagramCenter])),
     centerEdges: v.optional(SchemaDiagramCenterEdges),
-    links: v.optional(v.picklist(["props", "all"])),
+    links: v.optional(v.union([v.picklist(["props", "all"]), v.array(v.string())])),
     labeled: v.optional(v.boolean()),
     edgeSource: v.optional(v.string()),
     edgeTarget: v.optional(v.string()),
     edgeArity: v.optional(v.string()),
+    edgeGuard: v.optional(v.string()),
+    edgeKind: v.optional(v.string()),
+    edgeDuration: v.optional(v.string()),
+    edgeTime: v.optional(v.string()),
+    places: v.optional(v.string()),
+    tokens: v.optional(v.string()),
+    capacity: v.optional(v.string()),
+    duration: v.optional(v.string()),
+    start: v.optional(v.string()),
     hierarchy: v.optional(v.boolean()),
     deep: v.optional(v.boolean()),
+    descend: v.optional(v.array(v.string())),
+    reverse: v.optional(v.array(v.string())),
     onlyConnected: v.optional(v.boolean()),
     collapse: v.optional(v.boolean()),
     qualified: v.optional(v.boolean()),
     ordered: v.optional(v.boolean()),
+    markUncovered: v.optional(v.picklist(["none", "referenced", "coverage", "all"])),
     nest: v.optional(SchemaDiagramNest),
     properties: v.optional(v.array(v.string())),
     config: v.optional(SchemaDiagramConfig)
@@ -96,9 +136,15 @@ const SchemaObject = v.strictObject({
     referenced: v.optional(v.pipe(v.array(v.string()), v.minLength(1))),
     coverage: v.optional(v.pipe(v.array(v.string()), v.minLength(1))),
     automaton: v.optional(SchemaAutomaton),
-    diagram: v.optional(SchemaDiagram),
+    badge: v.optional(SchemaBadge),
+    multiple: v.optional(SchemaMultiple),
+    diagram: v.optional(v.union([SchemaDiagram, v.pipe(v.array(SchemaDiagram), v.minLength(1))])),
     format: v.optional(SchemaFormat),
     props: v.optional(v.array(SchemaProperty)),
     children: v.optional(v.array(v.lazy(() => SchemaObject)))
 });
 export const Schema = v.pipe(v.array(SchemaObject), v.minLength(1));
+/*  ==== Helpers ====  */
+/*  the diagrams configured on an object kind: none, a single one,
+    or a list of them, normalized into a list  */
+export const diagramsOf = (schema) => schema?.diagram === undefined ? [] : Array.isArray(schema.diagram) ? schema.diagram : [schema.diagram];