@eventcatalog/sdk 2.24.1 → 2.25.0-beta.0

package/dist/index.d.mts

@@ -10,6 +10,7 @@ interface BaseSchema {
   };
   owners?: string[];
   schemaPath?: string;
+  schemas?: SchemaPointer[];
   markdown: string;
   repository?: {
     language?: string;
@@ -51,6 +52,32 @@ 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;
+  file?: string;
+  path?: string;
+  name?: string;
+  format?: string;
+  environments?: string[];
+  default?: boolean;
+};
+
 type SendsPointer = {
   id: string;
   version?: string;
@@ -227,6 +254,7 @@ interface Domain extends BaseSchema {
   services?: ResourcePointer[];
   agents?: ResourcePointer[];
   domains?: ResourcePointer[];
+  systems?: ResourcePointer[];
   entities?: ResourcePointer[];
   dataProducts?: ResourcePointer[];
   flows?: ResourcePointer[];
@@ -235,6 +263,7 @@ interface Domain extends BaseSchema {
   detailsPanel?: {
     parentDomains?: DetailPanelProperty;
     subdomains?: DetailPanelProperty;
+    systems?: DetailPanelProperty;
     services?: DetailPanelProperty;
     agents?: DetailPanelProperty;
     entities?: DetailPanelProperty;
@@ -247,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;
@@ -449,6 +500,7 @@ type EventCatalog = {
   createdAt: string;
   resources: {
     domains?: ExportedResource<Domain>[];
+    systems?: ExportedResource<System>[];
     services?: ExportedResource<Service>[];
     agents?: ExportedResource<Agent>[];
     messages?: {
@@ -1566,13 +1618,35 @@ declare const _default: (path: string) => {
      */
     writeServiceToDomain: (service: Service, domain: {
         id: string;
-        version?: string;
+        version? /**
+         * Adds a file to the given event
+         * @param id - The id of the event to add the file to
+         * @param file - File contents to add including the content and the file name
+         * @param version - Optional version of the event to add the file to
+         * @returns
+         */: string;
         direction?: string;
     }, options?: {
         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
@@ -1777,6 +1851,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
@@ -1957,6 +2081,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
@@ -2220,6 +2355,16 @@ declare const _default: (path: string) => {
      * Returns the folder name of a given resource
      */
     getResourceFolderName: (catalogDir: string, id: string, version?: string) => Promise<string | undefined>;
+    /**
+     * Returns resources from the catalog for a given type
+     */
+    getResources: (catalogDir: string, { type, latestOnly, ignore, pattern, attachSchema, }: {
+        type: string;
+        pattern?: string;
+        latestOnly?: boolean;
+        ignore?: string[];
+        attachSchema?: boolean;
+    }) => Promise<(Service | CustomDoc | Message)[] | undefined>;
     /**
      * ================================
      *            General Message Utils
@@ -2309,6 +2454,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)
      *
@@ -2407,13 +2568,23 @@ declare const _default: (path: string) => {
         version?: string;
     }, options?: {
         path?: string;
-        format? /**
-         * Adds a file to the given event
-         * @param id - The id of the event to add the file to
-         * @param file - File contents to add including the content and the file name
-         * @param version - Optional version of the event to add the file to
-         * @returns
-         */: "md" | "mdx";
+        format?: "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";
         override?: boolean;
     }) => Promise<void>;
     /**
@@ -2548,6 +2719,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
@@ -2734,4 +2919,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 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 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 };

package/dist/index.d.ts

@@ -10,6 +10,7 @@ interface BaseSchema {
   };
   owners?: string[];
   schemaPath?: string;
+  schemas?: SchemaPointer[];
   markdown: string;
   repository?: {
     language?: string;
@@ -51,6 +52,32 @@ 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;
+  file?: string;
+  path?: string;
+  name?: string;
+  format?: string;
+  environments?: string[];
+  default?: boolean;
+};
+
 type SendsPointer = {
   id: string;
   version?: string;
@@ -227,6 +254,7 @@ interface Domain extends BaseSchema {
   services?: ResourcePointer[];
   agents?: ResourcePointer[];
   domains?: ResourcePointer[];
+  systems?: ResourcePointer[];
   entities?: ResourcePointer[];
   dataProducts?: ResourcePointer[];
   flows?: ResourcePointer[];
@@ -235,6 +263,7 @@ interface Domain extends BaseSchema {
   detailsPanel?: {
     parentDomains?: DetailPanelProperty;
     subdomains?: DetailPanelProperty;
+    systems?: DetailPanelProperty;
     services?: DetailPanelProperty;
     agents?: DetailPanelProperty;
     entities?: DetailPanelProperty;
@@ -247,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;
@@ -449,6 +500,7 @@ type EventCatalog = {
   createdAt: string;
   resources: {
     domains?: ExportedResource<Domain>[];
+    systems?: ExportedResource<System>[];
     services?: ExportedResource<Service>[];
     agents?: ExportedResource<Agent>[];
     messages?: {
@@ -1566,13 +1618,35 @@ declare const _default: (path: string) => {
      */
     writeServiceToDomain: (service: Service, domain: {
         id: string;
-        version?: string;
+        version? /**
+         * Adds a file to the given event
+         * @param id - The id of the event to add the file to
+         * @param file - File contents to add including the content and the file name
+         * @param version - Optional version of the event to add the file to
+         * @returns
+         */: string;
         direction?: string;
     }, options?: {
         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
@@ -1777,6 +1851,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
@@ -1957,6 +2081,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
@@ -2220,6 +2355,16 @@ declare const _default: (path: string) => {
      * Returns the folder name of a given resource
      */
     getResourceFolderName: (catalogDir: string, id: string, version?: string) => Promise<string | undefined>;
+    /**
+     * Returns resources from the catalog for a given type
+     */
+    getResources: (catalogDir: string, { type, latestOnly, ignore, pattern, attachSchema, }: {
+        type: string;
+        pattern?: string;
+        latestOnly?: boolean;
+        ignore?: string[];
+        attachSchema?: boolean;
+    }) => Promise<(Service | CustomDoc | Message)[] | undefined>;
     /**
      * ================================
      *            General Message Utils
@@ -2309,6 +2454,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)
      *
@@ -2407,13 +2568,23 @@ declare const _default: (path: string) => {
         version?: string;
     }, options?: {
         path?: string;
-        format? /**
-         * Adds a file to the given event
-         * @param id - The id of the event to add the file to
-         * @param file - File contents to add including the content and the file name
-         * @param version - Optional version of the event to add the file to
-         * @returns
-         */: "md" | "mdx";
+        format?: "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";
         override?: boolean;
     }) => Promise<void>;
     /**
@@ -2548,6 +2719,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
@@ -2734,4 +2919,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 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 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 };