@eventcatalog/visualiser 5.0.0-beta.5 → 5.0.0-beta.7

package/dist/schema-DKA0EQ_H.d.mts

@@ -0,0 +1,484 @@
+import { z } from 'zod';
+
+/**
+ * The architecture model agents send us: EventCatalog's vocabulary (domains, systems, services, messages,
+ * channels, containers) and how they relate. Shared by the MCP server and the view, so no server-only imports.
+ */
+
+declare const RESOURCE_TYPES: readonly ["domain", "system", "service", "event", "command", "query", "channel", "container", "actor", "external-system", "agent", "view", "entity", "team"];
+declare const ResourceType: z.ZodEnum<{
+    system: "system";
+    actor: "actor";
+    domain: "domain";
+    service: "service";
+    agent: "agent";
+    event: "event";
+    query: "query";
+    command: "command";
+    channel: "channel";
+    view: "view";
+    team: "team";
+    entity: "entity";
+    container: "container";
+    "external-system": "external-system";
+}>;
+type ResourceType = z.infer<typeof ResourceType>;
+declare const MESSAGE_TYPES: Set<"system" | "actor" | "domain" | "service" | "agent" | "event" | "query" | "command" | "channel" | "view" | "team" | "entity" | "container" | "external-system">;
+declare const SCHEMA_FORMATS: readonly ["json-schema", "avro", "protobuf", "json", "yaml", "xml", "graphql", "other"];
+/** A field of an entity (as EventCatalog's entities have them), e.g. { name: "orderId", type: "string" } */
+declare const EntityProperty: z.ZodObject<{
+    name: z.ZodString;
+    type: z.ZodString;
+    required: z.ZodOptional<z.ZodBoolean>;
+    description: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type EntityProperty = z.infer<typeof EntityProperty>;
+/** The kinds of data store (EventCatalog's container_type), e.g. a Redis cache is "cache" */
+declare const CONTAINER_TYPES: readonly ["database", "cache", "objectStore", "searchIndex", "dataWarehouse", "dataLake", "externalSaaS", "other"];
+type ContainerType = (typeof CONTAINER_TYPES)[number];
+declare const Resource: z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodEnum<{
+        system: "system";
+        actor: "actor";
+        domain: "domain";
+        service: "service";
+        agent: "agent";
+        event: "event";
+        query: "query";
+        command: "command";
+        channel: "channel";
+        view: "view";
+        team: "team";
+        entity: "entity";
+        container: "container";
+        "external-system": "external-system";
+    }>;
+    name: z.ZodString;
+    summary: z.ZodOptional<z.ZodString>;
+    parent: z.ZodOptional<z.ZodString>;
+    version: z.ZodOptional<z.ZodString>;
+    owners: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    technology: z.ZodOptional<z.ZodString>;
+    containerType: z.ZodOptional<z.ZodEnum<{
+        other: "other";
+        database: "database";
+        cache: "cache";
+        searchIndex: "searchIndex";
+        objectStore: "objectStore";
+        dataWarehouse: "dataWarehouse";
+        dataLake: "dataLake";
+        externalSaaS: "externalSaaS";
+    }>>;
+    evidence: z.ZodOptional<z.ZodString>;
+    properties: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        type: z.ZodString;
+        required: z.ZodOptional<z.ZodBoolean>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    card: z.ZodOptional<z.ZodBoolean>;
+    url: z.ZodOptional<z.ZodURL>;
+    schema: z.ZodOptional<z.ZodObject<{
+        format: z.ZodEnum<{
+            other: "other";
+            "json-schema": "json-schema";
+            avro: "avro";
+            protobuf: "protobuf";
+            json: "json";
+            yaml: "yaml";
+            xml: "xml";
+            graphql: "graphql";
+        }>;
+        content: z.ZodString;
+        path: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+type Resource = z.infer<typeof Resource>;
+declare const RELATION_KINDS: readonly ["sends", "receives", "routes-through", "reads", "writes", "connects"];
+declare const RelationKind: z.ZodEnum<{
+    sends: "sends";
+    receives: "receives";
+    "routes-through": "routes-through";
+    reads: "reads";
+    writes: "writes";
+    connects: "connects";
+}>;
+type RelationKind = z.infer<typeof RelationKind>;
+declare const Relation: z.ZodObject<{
+    from: z.ZodString;
+    to: z.ZodString;
+    kind: z.ZodEnum<{
+        sends: "sends";
+        receives: "receives";
+        "routes-through": "routes-through";
+        reads: "reads";
+        writes: "writes";
+        connects: "connects";
+    }>;
+    label: z.ZodOptional<z.ZodString>;
+    fromField: z.ZodOptional<z.ZodString>;
+    toField: z.ZodOptional<z.ZodString>;
+    inferred: z.ZodOptional<z.ZodBoolean>;
+    evidence: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type Relation = z.infer<typeof Relation>;
+declare const NOTE_COLOR_NAMES: readonly ["yellow", "blue", "green", "pink", "purple", "gray"];
+declare const LEVELS: readonly ["overview", "services", "messages"];
+type Level = (typeof LEVELS)[number];
+declare const Note: z.ZodObject<{
+    text: z.ZodString;
+    resource: z.ZodOptional<z.ZodString>;
+    author: z.ZodOptional<z.ZodString>;
+    x: z.ZodOptional<z.ZodNumber>;
+    y: z.ZodOptional<z.ZodNumber>;
+    color: z.ZodOptional<z.ZodEnum<{
+        blue: "blue";
+        gray: "gray";
+        green: "green";
+        pink: "pink";
+        purple: "purple";
+        yellow: "yellow";
+    }>>;
+    width: z.ZodOptional<z.ZodNumber>;
+    kind: z.ZodOptional<z.ZodEnum<{
+        text: "text";
+        sticky: "sticky";
+    }>>;
+    fontSize: z.ZodOptional<z.ZodNumber>;
+    angle: z.ZodOptional<z.ZodNumber>;
+    createdAt: z.ZodOptional<z.ZodNumber>;
+    level: z.ZodOptional<z.ZodEnum<{
+        services: "services";
+        messages: "messages";
+        overview: "overview";
+    }>>;
+}, z.core.$strip>;
+type Note = z.infer<typeof Note>;
+declare const Layout: z.ZodObject<{
+    overview: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>>;
+    services: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>>;
+    messages: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+type Layout = z.infer<typeof Layout>;
+/** Who wrote a comment: a person (their name and colour on the canvas) or an agent */
+declare const CommentAuthor: z.ZodObject<{
+    name: z.ZodString;
+    color: z.ZodDefault<z.ZodString>;
+    agent: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+/**
+ * A comment thread on the canvas, as EventCatalog Studio's: pinned at a place, or on a resource (nodeId, the resource
+ * id, with an offset from its top left, so it moves with it), with its messages (the first one starts it, the rest
+ * reply), and resolved once it's dealt with
+ */
+declare const CommentThread: z.ZodObject<{
+    id: z.ZodString;
+    position: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, z.core.$strip>;
+    nodeId: z.ZodOptional<z.ZodString>;
+    offset: z.ZodOptional<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, z.core.$strip>>;
+    level: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<1>, z.ZodLiteral<2>]>>;
+    author: z.ZodObject<{
+        name: z.ZodString;
+        color: z.ZodDefault<z.ZodString>;
+        agent: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>;
+    createdAt: z.ZodNumber;
+    resolved: z.ZodDefault<z.ZodBoolean>;
+    messages: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        text: z.ZodString;
+        author: z.ZodObject<{
+            name: z.ZodString;
+            color: z.ZodDefault<z.ZodString>;
+            agent: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>;
+        createdAt: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+type CommentThread = z.infer<typeof CommentThread>;
+/** How much a hotspot matters: critical (red), warning (amber) or info (blue) */
+declare const HOTSPOT_SEVERITIES: readonly ["critical", "warning", "info"];
+type HotspotSeverity = (typeof HOTSPOT_SEVERITIES)[number];
+/**
+ * A hotspot: something on the diagram people should know about, as an architect would flag it: a risk, a single
+ * point of failure, a known problem, or the key part to understand. On a resource (shown on it), or at a place
+ */
+declare const Hotspot: z.ZodObject<{
+    id: z.ZodDefault<z.ZodString>;
+    severity: z.ZodDefault<z.ZodEnum<{
+        critical: "critical";
+        warning: "warning";
+        info: "info";
+    }>>;
+    title: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    resource: z.ZodOptional<z.ZodString>;
+    position: z.ZodOptional<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, z.core.$strip>>;
+    level: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<1>, z.ZodLiteral<2>]>>;
+    author: z.ZodOptional<z.ZodObject<{
+        name: z.ZodString;
+        color: z.ZodDefault<z.ZodString>;
+        agent: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    createdAt: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+type Hotspot = z.infer<typeof Hotspot>;
+declare const Model: z.ZodObject<{
+    title: z.ZodString;
+    resources: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        type: z.ZodEnum<{
+            system: "system";
+            actor: "actor";
+            domain: "domain";
+            service: "service";
+            agent: "agent";
+            event: "event";
+            query: "query";
+            command: "command";
+            channel: "channel";
+            view: "view";
+            team: "team";
+            entity: "entity";
+            container: "container";
+            "external-system": "external-system";
+        }>;
+        name: z.ZodString;
+        summary: z.ZodOptional<z.ZodString>;
+        parent: z.ZodOptional<z.ZodString>;
+        version: z.ZodOptional<z.ZodString>;
+        owners: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        technology: z.ZodOptional<z.ZodString>;
+        containerType: z.ZodOptional<z.ZodEnum<{
+            other: "other";
+            database: "database";
+            cache: "cache";
+            searchIndex: "searchIndex";
+            objectStore: "objectStore";
+            dataWarehouse: "dataWarehouse";
+            dataLake: "dataLake";
+            externalSaaS: "externalSaaS";
+        }>>;
+        evidence: z.ZodOptional<z.ZodString>;
+        properties: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            type: z.ZodString;
+            required: z.ZodOptional<z.ZodBoolean>;
+            description: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        card: z.ZodOptional<z.ZodBoolean>;
+        url: z.ZodOptional<z.ZodURL>;
+        schema: z.ZodOptional<z.ZodObject<{
+            format: z.ZodEnum<{
+                other: "other";
+                "json-schema": "json-schema";
+                avro: "avro";
+                protobuf: "protobuf";
+                json: "json";
+                yaml: "yaml";
+                xml: "xml";
+                graphql: "graphql";
+            }>;
+            content: z.ZodString;
+            path: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    relations: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        from: z.ZodString;
+        to: z.ZodString;
+        kind: z.ZodEnum<{
+            sends: "sends";
+            receives: "receives";
+            "routes-through": "routes-through";
+            reads: "reads";
+            writes: "writes";
+            connects: "connects";
+        }>;
+        label: z.ZodOptional<z.ZodString>;
+        fromField: z.ZodOptional<z.ZodString>;
+        toField: z.ZodOptional<z.ZodString>;
+        inferred: z.ZodOptional<z.ZodBoolean>;
+        evidence: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    notes: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        text: z.ZodString;
+        resource: z.ZodOptional<z.ZodString>;
+        author: z.ZodOptional<z.ZodString>;
+        x: z.ZodOptional<z.ZodNumber>;
+        y: z.ZodOptional<z.ZodNumber>;
+        color: z.ZodOptional<z.ZodEnum<{
+            blue: "blue";
+            gray: "gray";
+            green: "green";
+            pink: "pink";
+            purple: "purple";
+            yellow: "yellow";
+        }>>;
+        width: z.ZodOptional<z.ZodNumber>;
+        kind: z.ZodOptional<z.ZodEnum<{
+            text: "text";
+            sticky: "sticky";
+        }>>;
+        fontSize: z.ZodOptional<z.ZodNumber>;
+        angle: z.ZodOptional<z.ZodNumber>;
+        createdAt: z.ZodOptional<z.ZodNumber>;
+        level: z.ZodOptional<z.ZodEnum<{
+            services: "services";
+            messages: "messages";
+            overview: "overview";
+        }>>;
+    }, z.core.$strip>>>;
+    comments: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        position: z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+        }, z.core.$strip>;
+        nodeId: z.ZodOptional<z.ZodString>;
+        offset: z.ZodOptional<z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+        }, z.core.$strip>>;
+        level: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<1>, z.ZodLiteral<2>]>>;
+        author: z.ZodObject<{
+            name: z.ZodString;
+            color: z.ZodDefault<z.ZodString>;
+            agent: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>;
+        createdAt: z.ZodNumber;
+        resolved: z.ZodDefault<z.ZodBoolean>;
+        messages: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            text: z.ZodString;
+            author: z.ZodObject<{
+                name: z.ZodString;
+                color: z.ZodDefault<z.ZodString>;
+                agent: z.ZodOptional<z.ZodBoolean>;
+            }, z.core.$strip>;
+            createdAt: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+    hotspots: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodDefault<z.ZodString>;
+        severity: z.ZodDefault<z.ZodEnum<{
+            critical: "critical";
+            warning: "warning";
+            info: "info";
+        }>>;
+        title: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        resource: z.ZodOptional<z.ZodString>;
+        position: z.ZodOptional<z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+        }, z.core.$strip>>;
+        level: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<1>, z.ZodLiteral<2>]>>;
+        author: z.ZodOptional<z.ZodObject<{
+            name: z.ZodString;
+            color: z.ZodDefault<z.ZodString>;
+            agent: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>;
+        createdAt: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>>;
+    layout: z.ZodOptional<z.ZodObject<{
+        overview: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+            width: z.ZodOptional<z.ZodNumber>;
+            height: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>>;
+        services: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+            width: z.ZodOptional<z.ZodNumber>;
+            height: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>>;
+        messages: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+            width: z.ZodOptional<z.ZodNumber>;
+            height: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+type Model = z.infer<typeof Model>;
+/**
+ * A scene of a tour: the agent showing the user something on the diagram, as a person at the canvas would. It
+ * switches level, zooms to resources, highlights them (fading the rest), writes notes next to them and pins code.
+ */
+declare const Scene: z.ZodObject<{
+    caption: z.ZodOptional<z.ZodString>;
+    level: z.ZodOptional<z.ZodEnum<{
+        services: "services";
+        messages: "messages";
+        overview: "overview";
+    }>>;
+    focus: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    highlight: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    notes: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        resource: z.ZodString;
+        text: z.ZodString;
+    }, z.core.$strip>>>;
+    code: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        resource: z.ZodString;
+        title: z.ZodOptional<z.ZodString>;
+        language: z.ZodOptional<z.ZodString>;
+        code: z.ZodString;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+type Scene = z.infer<typeof Scene>;
+declare const Tour: z.ZodArray<z.ZodObject<{
+    caption: z.ZodOptional<z.ZodString>;
+    level: z.ZodOptional<z.ZodEnum<{
+        services: "services";
+        messages: "messages";
+        overview: "overview";
+    }>>;
+    focus: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    highlight: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    notes: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        resource: z.ZodString;
+        text: z.ZodString;
+    }, z.core.$strip>>>;
+    code: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        resource: z.ZodString;
+        title: z.ZodOptional<z.ZodString>;
+        language: z.ZodOptional<z.ZodString>;
+        code: z.ZodString;
+    }, z.core.$strip>>>;
+}, z.core.$strip>>;
+/** What the view shows: the model, where to start, and a tour to play */
+type ArchitecturePayload = {
+    model: Model;
+    focus?: string;
+    level?: Level;
+    viewUrl?: string;
+    tour?: Scene[];
+};
+
+export { type ArchitecturePayload as A, CONTAINER_TYPES as C, EntityProperty as E, HOTSPOT_SEVERITIES as H, type Level as L, Model as M, NOTE_COLOR_NAMES as N, Resource as R, Scene as S, Tour as T, RESOURCE_TYPES as a, ResourceType as b, MESSAGE_TYPES as c, SCHEMA_FORMATS as d, type ContainerType as e, RELATION_KINDS as f, RelationKind as g, Relation as h, LEVELS as i, Note as j, Layout as k, CommentAuthor as l, CommentThread as m, type HotspotSeverity as n, Hotspot as o };

package/dist/studio-fonts.css

@@ -0,0 +1,10 @@
+/*
+ * Excalifont, Excalidraw's hand-drawn font (OFL-1.1, see fonts/README.md), for the welcome on an empty canvas and its
+ * hints: its Latin subset. Apps that bundle the font themselves (Studio on the web, one self-contained page) leave
+ * this out.
+ */
+@font-face {
+  font-family: 'Excalifont';
+  src: url('./fonts/Excalifont-Regular.woff2') format('woff2');
+  font-display: swap;
+}