@eventcatalog/sdk 2.25.0-beta.0 → 2.25.0

package/dist/index.d.mts

@@ -402,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;
@@ -514,6 +562,7 @@ type EventCatalog = {
     entities?: ExportedResource<Entity>[];
     containers?: ExportedResource<Container>[];
     flows?: ExportedResource<Flow>[];
+    adrs?: ExportedResource<Adr>[];
     customDocs?: ExportedResource<CustomDoc>[];
   };
 };
@@ -1390,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>;
@@ -1618,13 +1683,7 @@ declare const _default: (path: string) => {
      */
     writeServiceToDomain: (service: Service, domain: {
         id: 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;
+        version?: string;
         direction?: string;
     }, options?: {
         path?: string;
@@ -2364,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
@@ -2549,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";
@@ -2568,7 +2631,12 @@ declare const _default: (path: string) => {
         version?: string;
     }, options?: {
         path?: string;
-        format?: "md" | "mdx";
+        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>;
     /**
@@ -2895,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
@@ -2919,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 System, type SystemActorRelationship, type SystemRelationshipPointer, type SystemScope, 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 };

package/dist/index.d.ts

@@ -402,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;
@@ -514,6 +562,7 @@ type EventCatalog = {
     entities?: ExportedResource<Entity>[];
     containers?: ExportedResource<Container>[];
     flows?: ExportedResource<Flow>[];
+    adrs?: ExportedResource<Adr>[];
     customDocs?: ExportedResource<CustomDoc>[];
   };
 };
@@ -1390,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>;
@@ -1618,13 +1683,7 @@ declare const _default: (path: string) => {
      */
     writeServiceToDomain: (service: Service, domain: {
         id: 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;
+        version?: string;
         direction?: string;
     }, options?: {
         path?: string;
@@ -2364,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
@@ -2549,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";
@@ -2568,7 +2631,12 @@ declare const _default: (path: string) => {
         version?: string;
     }, options?: {
         path?: string;
-        format?: "md" | "mdx";
+        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>;
     /**
@@ -2895,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
@@ -2919,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 System, type SystemActorRelationship, type SystemRelationshipPointer, type SystemScope, 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 };