@eventcatalog/sdk 2.24.2 → 2.25.0-beta.1

package/dist/index.d.ts

@@ -52,6 +52,21 @@ type ResourcePointer = {
   type?: string;
 };
 
+type SystemScope = 'internal' | 'external';
+
+type SystemRelationshipPointer = {
+  id: string;
+  version?: string;
+  label?: string;
+};
+
+type SystemActorRelationship = {
+  id: string;
+  name?: string;
+  label?: string;
+  direction?: 'inbound' | 'outbound';
+};
+
 type SchemaPointer = {
   id?: string;
   ref?: string;
@@ -239,6 +254,7 @@ interface Domain extends BaseSchema {
   services?: ResourcePointer[];
   agents?: ResourcePointer[];
   domains?: ResourcePointer[];
+  systems?: ResourcePointer[];
   entities?: ResourcePointer[];
   dataProducts?: ResourcePointer[];
   flows?: ResourcePointer[];
@@ -247,6 +263,7 @@ interface Domain extends BaseSchema {
   detailsPanel?: {
     parentDomains?: DetailPanelProperty;
     subdomains?: DetailPanelProperty;
+    systems?: DetailPanelProperty;
     services?: DetailPanelProperty;
     agents?: DetailPanelProperty;
     entities?: DetailPanelProperty;
@@ -259,6 +276,28 @@ interface Domain extends BaseSchema {
   };
 }
 
+interface System extends BaseSchema {
+  scope?: SystemScope;
+  services?: ResourcePointer[];
+  flows?: ResourcePointer[];
+  entities?: ResourcePointer[];
+  containers?: ResourcePointer[];
+  relationships?: SystemRelationshipPointer[];
+  actors?: SystemActorRelationship[];
+  detailsPanel?: {
+    versions?: DetailPanelProperty;
+    repository?: DetailPanelProperty;
+    owners?: DetailPanelProperty;
+    changelog?: DetailPanelProperty;
+    attachments?: DetailPanelProperty;
+    services?: DetailPanelProperty;
+    flows?: DetailPanelProperty;
+    entities?: DetailPanelProperty;
+    containers?: DetailPanelProperty;
+    diagrams?: DetailPanelProperty;
+  };
+}
+
 interface Team {
   id: string;
   name: string;
@@ -363,6 +402,54 @@ interface Diagram extends BaseSchema {
   };
 }
 
+type AdrStatus = 'proposed' | 'accepted' | 'rejected' | 'deprecated' | 'superseded';
+
+type AdrPointer = {
+  id: string;
+  version?: string;
+};
+
+type AdrResourcePointer = AdrPointer & {
+  type:
+    | 'agent'
+    | 'service'
+    | 'event'
+    | 'command'
+    | 'query'
+    | 'flow'
+    | 'channel'
+    | 'domain'
+    | 'system'
+    | 'user'
+    | 'team'
+    | 'container'
+    | 'entity'
+    | 'diagram'
+    | 'data-product';
+};
+
+interface Adr extends BaseSchema {
+  status: AdrStatus;
+  date: Date | string;
+  decisionMakers?: string[];
+  appliesTo?: AdrResourcePointer[];
+  supersedes?: AdrPointer[];
+  supersededBy?: AdrPointer[];
+  amends?: AdrPointer[];
+  amendedBy?: AdrPointer[];
+  related?: AdrPointer[];
+  detailsPanel?: {
+    status?: DetailPanelProperty;
+    date?: DetailPanelProperty;
+    decisionMakers?: DetailPanelProperty;
+    appliesTo?: DetailPanelProperty;
+    relationships?: DetailPanelProperty;
+    owners?: DetailPanelProperty;
+    repository?: DetailPanelProperty;
+    changelog?: DetailPanelProperty;
+  };
+}
+
 type DataProductOutputPointer = {
   id: string;
   version?: string;
@@ -461,6 +548,7 @@ type EventCatalog = {
   createdAt: string;
   resources: {
     domains?: ExportedResource<Domain>[];
+    systems?: ExportedResource<System>[];
     services?: ExportedResource<Service>[];
     agents?: ExportedResource<Agent>[];
     messages?: {
@@ -474,6 +562,7 @@ type EventCatalog = {
     entities?: ExportedResource<Entity>[];
     containers?: ExportedResource<Container>[];
     flows?: ExportedResource<Flow>[];
+    adrs?: ExportedResource<Adr>[];
     customDocs?: ExportedResource<CustomDoc>[];
   };
 };
@@ -1350,7 +1439,23 @@ declare const _default: (path: string) => {
         id: string;
         version?: string;
     }, options?: {
-        path?: string;
+        path
+        /**
+         * Adds an event to a service in EventCatalog
+         *
+         * @param event - The event to write to the service
+         * @param service - The service and it's id to write to the event to
+         * @param options - Optional options to write the event
+         *
+         */
+        ? /**
+         * Adds an event to a service in EventCatalog
+         *
+         * @param event - The event to write to the service
+         * @param service - The service and it's id to write to the event to
+         * @param options - Optional options to write the event
+         *
+         */: string;
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
@@ -1585,6 +1690,22 @@ declare const _default: (path: string) => {
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
+    /**
+     * Adds a service to a system in EventCatalog
+     *
+     * @param service - The service to write
+     * @param system - The system to add the service to
+     * @param options - Optional options to write the service
+     *
+     */
+    writeServiceToSystem: (service: Service, system: {
+        id: string;
+        version?: string;
+    }, options?: {
+        path?: string;
+        format?: "md" | "mdx";
+        override?: boolean;
+    }) => Promise<void>;
     /**
      * Returns a service from EventCatalog
      * @param id - The id of the service to retrieve
@@ -1789,6 +1910,56 @@ declare const _default: (path: string) => {
      * @returns The service.
      */
     toService: (file: string) => Promise<Service>;
+    /**
+     * ================================
+     *            Systems
+     * ================================
+     */
+    writeSystem: (system: System, options?: {
+        path?: string;
+        override?: boolean;
+        versionExistingContent?: boolean;
+        format?: "md" | "mdx";
+    }) => Promise<void>;
+    writeSystemToDomain: (system: System, domain: {
+        id: string;
+        version?: string;
+    }, options?: {
+        path?: string;
+        format?: "md" | "mdx";
+        override?: boolean;
+    }) => Promise<void>;
+    getSystem: (id: string, version?: string) => Promise<System>;
+    getSystemByPath: (path: string) => Promise<System>;
+    getSystems: (options?: {
+        latestOnly?: boolean;
+    }) => Promise<System[]>;
+    versionSystem: (id: string) => Promise<void>;
+    rmSystem: (path: string) => Promise<void>;
+    rmSystemById: (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
+    addFileToSystem: (id: string, file: {
+        content: string;
+        fileName: string;
+    }, version?: string) => Promise<void>;
+    addServiceToSystem: (id: string, resource: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
+    addFlowToSystem: (id: string, resource: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
+    addEntityToSystem: (id: string, resource: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
+    addContainerToSystem: (id: string, resource: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
+    systemHasVersion: (id: string, version?: string) => Promise<boolean>;
+    isSystem: (path: string) => Promise<boolean>;
+    toSystem: (file: string) => Promise<System>;
     /**
      * ================================
      *            Agents
@@ -1969,6 +2140,17 @@ declare const _default: (path: string) => {
         id: string;
         version: string;
     }, version?: string) => Promise<void>;
+    /**
+     * Adds a given system to a domain
+     * @param id - The id of the domain
+     * @param system - The id and version of the system to add
+     * @param version - (Optional) The version of the domain to add the system to
+     * @returns
+     */
+    addSystemToDomain: (id: string, system: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
     /**
      * Adds an entity to a domain
      * @param id - The id of the domain
@@ -2241,7 +2423,7 @@ declare const _default: (path: string) => {
         latestOnly?: boolean;
         ignore?: string[];
         attachSchema?: boolean;
-    }) => Promise<(Service | CustomDoc | Message)[] | undefined>;
+    }) => Promise<(Service | CustomDoc | Message | Adr)[] | undefined>;
     /**
      * ================================
      *            General Message Utils
@@ -2331,6 +2513,22 @@ declare const _default: (path: string) => {
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
     }) => Promise<void>;
+    /**
+     * Adds an entity to a system in EventCatalog
+     *
+     * @param entity - The entity to write to the system
+     * @param system - The system and its id to write the entity to
+     * @param options - Optional options to write the entity
+     *
+     */
+    writeEntityToSystem: (entity: Entity, system: {
+        id: string;
+        version?: string;
+    }, options?: {
+        path?: string;
+        format?: "md" | "mdx";
+        override?: boolean;
+    }) => Promise<void>;
     /**
      * Remove an entity from EventCatalog (modeled on the standard POSIX rm utility)
      *
@@ -2410,7 +2608,11 @@ declare const _default: (path: string) => {
      */
     writeFlowToDomain: (flow: Flow, domain: {
         id: string;
-        version?: string;
+        version? /**
+         * Returns all events from EventCatalog
+         * @param latestOnly - optional boolean, set to true to get only latest versions
+         * @returns Event[]|Undefined
+         */: string;
     }, options?: {
         path?: string;
         format?: "md" | "mdx";
@@ -2427,6 +2629,27 @@ declare const _default: (path: string) => {
     writeFlowToService: (flow: Flow, service: {
         id: string;
         version?: string;
+    }, options?: {
+        path?: string;
+        format? /**
+         * Remove an event to EventCatalog (modeled on the standard POSIX rm utility)
+         *
+         * @param path - The path to your event, e.g. `/Inventory/InventoryAdjusted`
+         *
+         */: "md" | "mdx";
+        override?: boolean;
+    }) => Promise<void>;
+    /**
+     * Adds a flow to a system in EventCatalog
+     *
+     * @param flow - The flow to write to the system
+     * @param system - The system and its id to write the flow to
+     * @param options - Optional options to write the flow
+     *
+     */
+    writeFlowToSystem: (flow: Flow, system: {
+        id: string;
+        version?: string;
     }, options?: {
         path?: string;
         format?: "md" | "mdx";
@@ -2564,6 +2787,20 @@ declare const _default: (path: string) => {
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
+    /**
+     * Writes a data store to a system by its id
+     * @param dataStore - The data store to write
+     * @param system - The system to write the data store to
+     * @returns
+     */
+    writeDataStoreToSystem: (container: Container, system: {
+        id: string;
+        version?: string;
+    }, options?: {
+        path?: string;
+        format?: "md" | "mdx";
+        override?: boolean;
+    }) => Promise<void>;
     /**
      * ================================
      *            Data Products
@@ -2726,6 +2963,29 @@ declare const _default: (path: string) => {
         content: string;
         fileName: string;
     }, version?: string) => Promise<void>;
+    /**
+     * ================================
+     *            ADRs
+     * ================================
+     */
+    getAdr: (id: string, version?: string) => Promise<Adr>;
+    getAdrs: (options?: {
+        latestOnly?: boolean;
+    }) => Promise<Adr[]>;
+    writeAdr: (adr: Adr, options?: {
+        path?: string;
+        override?: boolean;
+        versionExistingContent?: boolean;
+        format?: "md" | "mdx";
+    }) => Promise<void>;
+    rmAdr: (path: string) => Promise<void>;
+    rmAdrById: (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
+    versionAdr: (id: string) => Promise<void>;
+    adrHasVersion: (id: string, version?: string) => Promise<boolean>;
+    addFileToAdr: (id: string, file: {
+        content: string;
+        fileName: string;
+    }, version?: string) => Promise<void>;
     /**
      * ================================
      *            DSL
@@ -2750,4 +3010,4 @@ declare const _default: (path: string) => {
     toDSL: (resource: (Event | Command | Query | Service | Domain) | (Event | Command | Query | Service | Domain)[], options: ToDSLOptions) => Promise<string>;
 };
 
-export { type Agent, type AgentModel, type AgentTool, type Badge, type BaseSchema, type CatalogSnapshot, type Changelog, type Channel, type ChannelPointer, type Command, type Container, type CustomDoc, type DataProduct, type DataProductOutputPointer, type Diagram, type DiffSummary, type Domain, type Entity, type Event, type EventCatalog, type Flow, type FlowActorStepInput, type FlowAgentStepInput, FlowBuilder, type FlowBuilderInput, type FlowCustomStepInput, type FlowDataProductStepInput, type FlowDataStoreStepInput, type FlowExternalSystemStepInput, type FlowMessageStepInput, type FlowServiceStepInput, type FlowStep, type FlowStepInput, type FlowSubFlowStepInput, type Message, type Operation, type Query, type ReceivesPointer, type RelationshipChange, type ResourceChange, type ResourceChangeType, type ResourceGroup, type ResourcePointer, type SchemaPointer, type SendsPointer, type Service, type SnapshotDiff, type SnapshotGitInfo, type SnapshotMeta, type SnapshotOptions, type SnapshotResourceType, type SnapshotResources, type SnapshotResult, type Specification, type Specifications, type Team, type UbiquitousLanguage, type UbiquitousLanguageDictionary, type User, _default as default };
+export { type Adr, type AdrPointer, type AdrResourcePointer, type AdrStatus, type Agent, type AgentModel, type AgentTool, type Badge, type BaseSchema, type CatalogSnapshot, type Changelog, type Channel, type ChannelPointer, type Command, type Container, type CustomDoc, type DataProduct, type DataProductOutputPointer, type Diagram, type DiffSummary, type Domain, type Entity, type Event, type EventCatalog, type Flow, type FlowActorStepInput, type FlowAgentStepInput, FlowBuilder, type FlowBuilderInput, type FlowCustomStepInput, type FlowDataProductStepInput, type FlowDataStoreStepInput, type FlowExternalSystemStepInput, type FlowMessageStepInput, type FlowServiceStepInput, type FlowStep, type FlowStepInput, type FlowSubFlowStepInput, type Message, type Operation, type Query, type ReceivesPointer, type RelationshipChange, type ResourceChange, type ResourceChangeType, type ResourceGroup, type ResourcePointer, type SchemaPointer, type SendsPointer, type Service, type SnapshotDiff, type SnapshotGitInfo, type SnapshotMeta, type SnapshotOptions, type SnapshotResourceType, type SnapshotResources, type SnapshotResult, type Specification, type Specifications, type System, type SystemActorRelationship, type SystemRelationshipPointer, type SystemScope, type Team, type UbiquitousLanguage, type UbiquitousLanguageDictionary, type User, _default as default };