d5-mermaid 0.3.0

package/dist/index.d.cts

@@ -0,0 +1,280 @@
+type Direction = 'LR' | 'RL' | 'TB' | 'BT';
+
+type SubdomainType$1 = 'core' | 'supporting' | 'generic';
+interface Domain {
+    id: string;
+    label: string;
+}
+interface Subdomain$1 {
+    id: string;
+    label: string;
+    type: SubdomainType$1;
+}
+interface Relationship$2 {
+    source: string;
+    target: string;
+    label: string;
+}
+declare class D5DomainDb {
+    private domain;
+    private subdomains;
+    private relationships;
+    private direction;
+    private title;
+    private accTitle;
+    private accDescription;
+    getDomain(): Domain | undefined;
+    setDomain(id: string, label: string): void;
+    getSubdomains(): Subdomain$1[];
+    addSubdomain(id: string, label: string, type: SubdomainType$1): void;
+    getRelationships(): Relationship$2[];
+    addRelationship(source: string, target: string, label: string): void;
+    /** Accepts `LR` / `RL` / `TB` / `TD` / `BT` (case-insensitive); `TD` is stored as `TB`. */
+    setDirection(dir: string): void;
+    getDirection(): Direction;
+    clear(): void;
+    setTitle(title: string): void;
+    getTitle(): string | undefined;
+    setDiagramTitle(title: string): void;
+    getDiagramTitle(): string;
+    setAccTitle(title: string): void;
+    getAccTitle(): string;
+    setAccDescription(desc: string): void;
+    getAccDescription(): string;
+}
+
+type SubdomainType = 'core' | 'supporting' | 'generic';
+interface Subdomain {
+    id: string;
+    label: string;
+    type: SubdomainType;
+}
+interface BoundedContext$1 {
+    id: string;
+    label: string;
+    subdomainId: string;
+    team: string | undefined;
+}
+interface Relationship$1 {
+    source: string;
+    target: string;
+    label: string;
+}
+declare class D5SubdomainDb {
+    private subdomains;
+    private boundedContexts;
+    private relationships;
+    private direction;
+    private title;
+    private accTitle;
+    private accDescription;
+    setTitle(title: string): void;
+    getTitle(): string | undefined;
+    /** Accepts `LR` / `RL` / `TB` / `TD` / `BT` (case-insensitive); `TD` is stored as `TB`. */
+    setDirection(dir: string): void;
+    getDirection(): Direction;
+    addSubdomain(id: string, label: string, type: SubdomainType): void;
+    getSubdomains(): Subdomain[];
+    addBoundedContext(id: string, label: string, subdomainId: string, team?: string): void;
+    getBoundedContexts(): BoundedContext$1[];
+    addRelationship(source: string, target: string, label: string): void;
+    getRelationships(): Relationship$1[];
+    clear(): void;
+    setDiagramTitle(title: string): void;
+    getDiagramTitle(): string;
+    setAccTitle(title: string): void;
+    getAccTitle(): string;
+    setAccDescription(desc: string): void;
+    getAccDescription(): string;
+}
+
+interface BoundedContext {
+    id: string;
+    label: string;
+    team: string | undefined;
+}
+interface Aggregate$1 {
+    id: string;
+    label: string;
+    root: string;
+    fields?: string[];
+}
+/** A denormalised query-side view built from domain events (CQRS read model). */
+interface ReadModel {
+    id: string;
+    label: string;
+}
+interface Term {
+    term: string;
+    definition: string;
+}
+interface Relationship {
+    source: string;
+    target: string;
+    label: string;
+}
+/** A domain event flowing from one aggregate to another: `source` emits, `target` reacts. */
+interface DomainEvent {
+    source: string;
+    target: string;
+    name: string;
+}
+/**
+ * A reactive policy ("whenever … then …"). `source` is the aggregate whose activity
+ * triggers it, `target` the aggregate that reacts (they may be the same for a
+ * scheduled / self-directed policy). `rule` is the free-text statement.
+ */
+interface Policy {
+    source: string;
+    target: string;
+    rule: string;
+}
+declare class D5ContextDb {
+    private boundedContext;
+    private aggregates;
+    private readModels;
+    private terms;
+    private relationships;
+    private events;
+    private policies;
+    private direction;
+    private title;
+    private accTitle;
+    private accDescription;
+    setTitle(title: string): void;
+    getTitle(): string | undefined;
+    /** Accepts `LR` / `RL` / `TB` / `TD` / `BT` (case-insensitive); `TD` is stored as `TB`. */
+    setDirection(dir: string): void;
+    getDirection(): Direction;
+    setBoundedContext(id: string, label: string, team?: string): void;
+    getBoundedContext(): BoundedContext | undefined;
+    addAggregate(id: string, label: string, root: string, fields?: string[]): void;
+    getAggregates(): Aggregate$1[];
+    addReadModel(id: string, label: string): void;
+    getReadModels(): ReadModel[];
+    addTerm(term: string, definition: string): void;
+    getTerms(): Term[];
+    addRelationship(source: string, target: string, label: string): void;
+    getRelationships(): Relationship[];
+    addEvent(source: string, target: string, name: string): void;
+    getEvents(): DomainEvent[];
+    addPolicy(source: string, target: string, rule: string): void;
+    getPolicies(): Policy[];
+    clear(): void;
+    setDiagramTitle(title: string): void;
+    getDiagramTitle(): string;
+    setAccTitle(title: string): void;
+    getAccTitle(): string;
+    setAccDescription(desc: string): void;
+    getAccDescription(): string;
+}
+
+interface Aggregate {
+    id: string;
+    label: string;
+    root: string;
+}
+interface Entity {
+    id: string;
+    label: string;
+}
+interface ValueObject {
+    id: string;
+    label: string;
+}
+interface Invariant {
+    /** optional short name / subject */
+    name: string | undefined;
+    /** the rule statement */
+    text: string;
+}
+declare class D5AggregateDb {
+    private aggregate;
+    private entities;
+    private valueObjects;
+    private invariants;
+    private title;
+    private accTitle;
+    private accDescription;
+    getAggregate(): Aggregate | undefined;
+    setAggregate(id: string, label: string, root: string): void;
+    getEntities(): Entity[];
+    addEntity(id: string, label: string): void;
+    getValueObjects(): ValueObject[];
+    addValueObject(id: string, label: string): void;
+    getInvariants(): Invariant[];
+    addInvariant(text: string, name?: string): void;
+    clear(): void;
+    setTitle(title: string): void;
+    getTitle(): string | undefined;
+    setDiagramTitle(title: string): void;
+    getDiagramTitle(): string;
+    setAccTitle(title: string): void;
+    getAccTitle(): string;
+    setAccDescription(desc: string): void;
+    getAccDescription(): string;
+}
+
+declare const d5Diagrams: ({
+    id: string;
+    detector: (text: string, _config?: unknown) => boolean;
+    loader: () => Promise<{
+        id: "d5-domain";
+        diagram: {
+            db: D5DomainDb;
+            renderer: {
+                draw(_text: string, id: string, _version: string, _diagramObject: unknown): void;
+            };
+            parser: {
+                parse(text: string): void;
+            };
+        };
+    }>;
+} | {
+    id: string;
+    detector: (text: string, _config?: unknown) => boolean;
+    loader: () => Promise<{
+        id: "d5-subdomain";
+        diagram: {
+            db: D5SubdomainDb;
+            renderer: {
+                draw(_text: string, id: string, _version: string, _diagramObject: unknown): void;
+            };
+            parser: {
+                parse(text: string): void;
+            };
+        };
+    }>;
+} | {
+    id: string;
+    detector: (text: string, _config?: unknown) => boolean;
+    loader: () => Promise<{
+        id: "d5-context";
+        diagram: {
+            db: D5ContextDb;
+            renderer: {
+                draw(_text: string, id: string, _version: string, _diagramObject: unknown): void;
+            };
+            parser: {
+                parse(text: string): void;
+            };
+        };
+    }>;
+} | {
+    id: string;
+    detector: (text: string, _config?: unknown) => boolean;
+    loader: () => Promise<{
+        id: "d5-aggregate";
+        diagram: {
+            db: D5AggregateDb;
+            renderer: {
+                draw(_text: string, id: string, _version: string, _diagramObject: unknown): void;
+            };
+            parser: {
+                parse(text: string): void;
+            };
+        };
+    }>;
+})[];
+
+export { d5Diagrams };

package/dist/index.d.ts

@@ -0,0 +1,280 @@
+type Direction = 'LR' | 'RL' | 'TB' | 'BT';
+
+type SubdomainType$1 = 'core' | 'supporting' | 'generic';
+interface Domain {
+    id: string;
+    label: string;
+}
+interface Subdomain$1 {
+    id: string;
+    label: string;
+    type: SubdomainType$1;
+}
+interface Relationship$2 {
+    source: string;
+    target: string;
+    label: string;
+}
+declare class D5DomainDb {
+    private domain;
+    private subdomains;
+    private relationships;
+    private direction;
+    private title;
+    private accTitle;
+    private accDescription;
+    getDomain(): Domain | undefined;
+    setDomain(id: string, label: string): void;
+    getSubdomains(): Subdomain$1[];
+    addSubdomain(id: string, label: string, type: SubdomainType$1): void;
+    getRelationships(): Relationship$2[];
+    addRelationship(source: string, target: string, label: string): void;
+    /** Accepts `LR` / `RL` / `TB` / `TD` / `BT` (case-insensitive); `TD` is stored as `TB`. */
+    setDirection(dir: string): void;
+    getDirection(): Direction;
+    clear(): void;
+    setTitle(title: string): void;
+    getTitle(): string | undefined;
+    setDiagramTitle(title: string): void;
+    getDiagramTitle(): string;
+    setAccTitle(title: string): void;
+    getAccTitle(): string;
+    setAccDescription(desc: string): void;
+    getAccDescription(): string;
+}
+
+type SubdomainType = 'core' | 'supporting' | 'generic';
+interface Subdomain {
+    id: string;
+    label: string;
+    type: SubdomainType;
+}
+interface BoundedContext$1 {
+    id: string;
+    label: string;
+    subdomainId: string;
+    team: string | undefined;
+}
+interface Relationship$1 {
+    source: string;
+    target: string;
+    label: string;
+}
+declare class D5SubdomainDb {
+    private subdomains;
+    private boundedContexts;
+    private relationships;
+    private direction;
+    private title;
+    private accTitle;
+    private accDescription;
+    setTitle(title: string): void;
+    getTitle(): string | undefined;
+    /** Accepts `LR` / `RL` / `TB` / `TD` / `BT` (case-insensitive); `TD` is stored as `TB`. */
+    setDirection(dir: string): void;
+    getDirection(): Direction;
+    addSubdomain(id: string, label: string, type: SubdomainType): void;
+    getSubdomains(): Subdomain[];
+    addBoundedContext(id: string, label: string, subdomainId: string, team?: string): void;
+    getBoundedContexts(): BoundedContext$1[];
+    addRelationship(source: string, target: string, label: string): void;
+    getRelationships(): Relationship$1[];
+    clear(): void;
+    setDiagramTitle(title: string): void;
+    getDiagramTitle(): string;
+    setAccTitle(title: string): void;
+    getAccTitle(): string;
+    setAccDescription(desc: string): void;
+    getAccDescription(): string;
+}
+
+interface BoundedContext {
+    id: string;
+    label: string;
+    team: string | undefined;
+}
+interface Aggregate$1 {
+    id: string;
+    label: string;
+    root: string;
+    fields?: string[];
+}
+/** A denormalised query-side view built from domain events (CQRS read model). */
+interface ReadModel {
+    id: string;
+    label: string;
+}
+interface Term {
+    term: string;
+    definition: string;
+}
+interface Relationship {
+    source: string;
+    target: string;
+    label: string;
+}
+/** A domain event flowing from one aggregate to another: `source` emits, `target` reacts. */
+interface DomainEvent {
+    source: string;
+    target: string;
+    name: string;
+}
+/**
+ * A reactive policy ("whenever … then …"). `source` is the aggregate whose activity
+ * triggers it, `target` the aggregate that reacts (they may be the same for a
+ * scheduled / self-directed policy). `rule` is the free-text statement.
+ */
+interface Policy {
+    source: string;
+    target: string;
+    rule: string;
+}
+declare class D5ContextDb {
+    private boundedContext;
+    private aggregates;
+    private readModels;
+    private terms;
+    private relationships;
+    private events;
+    private policies;
+    private direction;
+    private title;
+    private accTitle;
+    private accDescription;
+    setTitle(title: string): void;
+    getTitle(): string | undefined;
+    /** Accepts `LR` / `RL` / `TB` / `TD` / `BT` (case-insensitive); `TD` is stored as `TB`. */
+    setDirection(dir: string): void;
+    getDirection(): Direction;
+    setBoundedContext(id: string, label: string, team?: string): void;
+    getBoundedContext(): BoundedContext | undefined;
+    addAggregate(id: string, label: string, root: string, fields?: string[]): void;
+    getAggregates(): Aggregate$1[];
+    addReadModel(id: string, label: string): void;
+    getReadModels(): ReadModel[];
+    addTerm(term: string, definition: string): void;
+    getTerms(): Term[];
+    addRelationship(source: string, target: string, label: string): void;
+    getRelationships(): Relationship[];
+    addEvent(source: string, target: string, name: string): void;
+    getEvents(): DomainEvent[];
+    addPolicy(source: string, target: string, rule: string): void;
+    getPolicies(): Policy[];
+    clear(): void;
+    setDiagramTitle(title: string): void;
+    getDiagramTitle(): string;
+    setAccTitle(title: string): void;
+    getAccTitle(): string;
+    setAccDescription(desc: string): void;
+    getAccDescription(): string;
+}
+
+interface Aggregate {
+    id: string;
+    label: string;
+    root: string;
+}
+interface Entity {
+    id: string;
+    label: string;
+}
+interface ValueObject {
+    id: string;
+    label: string;
+}
+interface Invariant {
+    /** optional short name / subject */
+    name: string | undefined;
+    /** the rule statement */
+    text: string;
+}
+declare class D5AggregateDb {
+    private aggregate;
+    private entities;
+    private valueObjects;
+    private invariants;
+    private title;
+    private accTitle;
+    private accDescription;
+    getAggregate(): Aggregate | undefined;
+    setAggregate(id: string, label: string, root: string): void;
+    getEntities(): Entity[];
+    addEntity(id: string, label: string): void;
+    getValueObjects(): ValueObject[];
+    addValueObject(id: string, label: string): void;
+    getInvariants(): Invariant[];
+    addInvariant(text: string, name?: string): void;
+    clear(): void;
+    setTitle(title: string): void;
+    getTitle(): string | undefined;
+    setDiagramTitle(title: string): void;
+    getDiagramTitle(): string;
+    setAccTitle(title: string): void;
+    getAccTitle(): string;
+    setAccDescription(desc: string): void;
+    getAccDescription(): string;
+}
+
+declare const d5Diagrams: ({
+    id: string;
+    detector: (text: string, _config?: unknown) => boolean;
+    loader: () => Promise<{
+        id: "d5-domain";
+        diagram: {
+            db: D5DomainDb;
+            renderer: {
+                draw(_text: string, id: string, _version: string, _diagramObject: unknown): void;
+            };
+            parser: {
+                parse(text: string): void;
+            };
+        };
+    }>;
+} | {
+    id: string;
+    detector: (text: string, _config?: unknown) => boolean;
+    loader: () => Promise<{
+        id: "d5-subdomain";
+        diagram: {
+            db: D5SubdomainDb;
+            renderer: {
+                draw(_text: string, id: string, _version: string, _diagramObject: unknown): void;
+            };
+            parser: {
+                parse(text: string): void;
+            };
+        };
+    }>;
+} | {
+    id: string;
+    detector: (text: string, _config?: unknown) => boolean;
+    loader: () => Promise<{
+        id: "d5-context";
+        diagram: {
+            db: D5ContextDb;
+            renderer: {
+                draw(_text: string, id: string, _version: string, _diagramObject: unknown): void;
+            };
+            parser: {
+                parse(text: string): void;
+            };
+        };
+    }>;
+} | {
+    id: string;
+    detector: (text: string, _config?: unknown) => boolean;
+    loader: () => Promise<{
+        id: "d5-aggregate";
+        diagram: {
+            db: D5AggregateDb;
+            renderer: {
+                draw(_text: string, id: string, _version: string, _diagramObject: unknown): void;
+            };
+            parser: {
+                parse(text: string): void;
+            };
+        };
+    }>;
+})[];
+
+export { d5Diagrams };