@eventcatalog/sdk 2.24.0 → 2.24.2

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,17 @@ type ResourcePointer = {
   type?: string;
 };
 
+type SchemaPointer = {
+  id?: string;
+  ref?: string;
+  file?: string;
+  path?: string;
+  name?: string;
+  format?: string;
+  environments?: string[];
+  default?: boolean;
+};
+
 type SendsPointer = {
   id: string;
   version?: string;
@@ -257,6 +269,7 @@ interface Team {
   hidden?: boolean;
   source?: {
     provider: string;
+    id?: string;
     url?: string;
   };
   readOnly?: boolean;
@@ -271,11 +284,12 @@ interface Team {
 interface User {
   id: string;
   name: string;
-  avatarUrl: string;
+  avatarUrl?: string;
   role?: string;
   hidden?: boolean;
   source?: {
     provider: string;
+    id?: string;
     url?: string;
   };
   readOnly?: boolean;
@@ -2218,6 +2232,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
@@ -2405,13 +2429,7 @@ 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>;
     /**
@@ -2732,4 +2750,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 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,17 @@ type ResourcePointer = {
   type?: string;
 };
 
+type SchemaPointer = {
+  id?: string;
+  ref?: string;
+  file?: string;
+  path?: string;
+  name?: string;
+  format?: string;
+  environments?: string[];
+  default?: boolean;
+};
+
 type SendsPointer = {
   id: string;
   version?: string;
@@ -257,6 +269,7 @@ interface Team {
   hidden?: boolean;
   source?: {
     provider: string;
+    id?: string;
     url?: string;
   };
   readOnly?: boolean;
@@ -271,11 +284,12 @@ interface Team {
 interface User {
   id: string;
   name: string;
-  avatarUrl: string;
+  avatarUrl?: string;
   role?: string;
   hidden?: boolean;
   source?: {
     provider: string;
+    id?: string;
     url?: string;
   };
   readOnly?: boolean;
@@ -2218,6 +2232,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
@@ -2405,13 +2429,7 @@ 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>;
     /**
@@ -2732,4 +2750,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 Team, type UbiquitousLanguage, type UbiquitousLanguageDictionary, type User, _default as default };

package/dist/index.js

@@ -4280,6 +4280,10 @@ var src_default = (path9) => {
      * Returns the folder name of a given resource
      */
     getResourceFolderName,
+    /**
+     * Returns resources from the catalog for a given type
+     */
+    getResources,
     /**
      * ================================
      *            General Message Utils