@eventcatalog/sdk 2.14.0 → 2.14.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/dist/index.d.mts +46 -11
  2. package/dist/index.d.ts +46 -11
  3. package/dist/index.js +203 -47
  4. package/dist/index.js.map +1 -1
  5. package/dist/index.mjs +204 -48
  6. package/dist/index.mjs.map +1 -1
  7. package/package.json +1 -2
package/dist/index.d.mts CHANGED
@@ -637,13 +637,7 @@ declare const _default: (path: string) => {
637
637
  content: string;
638
638
  fileName: string;
639
639
  }, version?: string, options?: {
640
- path? /**
641
- * Adds a schema to the given command
642
- * @param id - The id of the command to add the schema to
643
- * @param schema - Schema contents to add including the content and the file name
644
- * @param version - Optional version of the command to add the schema to
645
- * @returns
646
- */: string;
640
+ path?: string;
647
641
  }) => Promise<void>;
648
642
  /**
649
643
  * Adds a schema to the given query
@@ -743,7 +737,18 @@ declare const _default: (path: string) => {
743
737
  addEventToChannel: (id: string, _message: {
744
738
  id: string;
745
739
  version: string;
746
- parameters?: {
740
+ parameters
741
+ /**
742
+ * Returns a query from EventCatalog
743
+ * @param id - The id of the query to retrieve
744
+ * @param version - Optional id of the version to get (supports semver)
745
+ * @returns Query|Undefined
746
+ */
747
+ ? /**
748
+ * ================================
749
+ * Queries
750
+ * ================================
751
+ */: {
747
752
  [key: string]: string;
748
753
  };
749
754
  }, version?: string) => Promise<void>;
@@ -766,7 +771,18 @@ declare const _default: (path: string) => {
766
771
  addCommandToChannel: (id: string, _message: {
767
772
  id: string;
768
773
  version: string;
769
- parameters?: {
774
+ parameters
775
+ /**
776
+ * Returns a query from EventCatalog
777
+ * @param id - The id of the query to retrieve
778
+ * @param version - Optional id of the version to get (supports semver)
779
+ * @returns Query|Undefined
780
+ */
781
+ ? /**
782
+ * ================================
783
+ * Queries
784
+ * ================================
785
+ */: {
770
786
  [key: string]: string;
771
787
  };
772
788
  }, version?: string) => Promise<void>;
@@ -789,7 +805,18 @@ declare const _default: (path: string) => {
789
805
  addQueryToChannel: (id: string, _message: {
790
806
  id: string;
791
807
  version: string;
792
- parameters?: {
808
+ parameters
809
+ /**
810
+ * Returns a query from EventCatalog
811
+ * @param id - The id of the query to retrieve
812
+ * @param version - Optional id of the version to get (supports semver)
813
+ * @returns Query|Undefined
814
+ */
815
+ ? /**
816
+ * ================================
817
+ * Queries
818
+ * ================================
819
+ */: {
793
820
  [key: string]: string;
794
821
  };
795
822
  }, version?: string) => Promise<void>;
@@ -808,7 +835,15 @@ declare const _default: (path: string) => {
808
835
  writeService: (service: Service, options?: {
809
836
  path?: string;
810
837
  override?: boolean;
811
- versionExistingContent?: boolean;
838
+ versionExistingContent
839
+ /**
840
+ * Moves a given event id to the version directory
841
+ * @param directory
842
+ */
843
+ ? /**
844
+ * Moves a given event id to the version directory
845
+ * @param directory
846
+ */: boolean;
812
847
  format?: "md" | "mdx";
813
848
  }) => Promise<void>;
814
849
  /**
package/dist/index.d.ts CHANGED
@@ -637,13 +637,7 @@ declare const _default: (path: string) => {
637
637
  content: string;
638
638
  fileName: string;
639
639
  }, version?: string, options?: {
640
- path? /**
641
- * Adds a schema to the given command
642
- * @param id - The id of the command to add the schema to
643
- * @param schema - Schema contents to add including the content and the file name
644
- * @param version - Optional version of the command to add the schema to
645
- * @returns
646
- */: string;
640
+ path?: string;
647
641
  }) => Promise<void>;
648
642
  /**
649
643
  * Adds a schema to the given query
@@ -743,7 +737,18 @@ declare const _default: (path: string) => {
743
737
  addEventToChannel: (id: string, _message: {
744
738
  id: string;
745
739
  version: string;
746
- parameters?: {
740
+ parameters
741
+ /**
742
+ * Returns a query from EventCatalog
743
+ * @param id - The id of the query to retrieve
744
+ * @param version - Optional id of the version to get (supports semver)
745
+ * @returns Query|Undefined
746
+ */
747
+ ? /**
748
+ * ================================
749
+ * Queries
750
+ * ================================
751
+ */: {
747
752
  [key: string]: string;
748
753
  };
749
754
  }, version?: string) => Promise<void>;
@@ -766,7 +771,18 @@ declare const _default: (path: string) => {
766
771
  addCommandToChannel: (id: string, _message: {
767
772
  id: string;
768
773
  version: string;
769
- parameters?: {
774
+ parameters
775
+ /**
776
+ * Returns a query from EventCatalog
777
+ * @param id - The id of the query to retrieve
778
+ * @param version - Optional id of the version to get (supports semver)
779
+ * @returns Query|Undefined
780
+ */
781
+ ? /**
782
+ * ================================
783
+ * Queries
784
+ * ================================
785
+ */: {
770
786
  [key: string]: string;
771
787
  };
772
788
  }, version?: string) => Promise<void>;
@@ -789,7 +805,18 @@ declare const _default: (path: string) => {
789
805
  addQueryToChannel: (id: string, _message: {
790
806
  id: string;
791
807
  version: string;
792
- parameters?: {
808
+ parameters
809
+ /**
810
+ * Returns a query from EventCatalog
811
+ * @param id - The id of the query to retrieve
812
+ * @param version - Optional id of the version to get (supports semver)
813
+ * @returns Query|Undefined
814
+ */
815
+ ? /**
816
+ * ================================
817
+ * Queries
818
+ * ================================
819
+ */: {
793
820
  [key: string]: string;
794
821
  };
795
822
  }, version?: string) => Promise<void>;
@@ -808,7 +835,15 @@ declare const _default: (path: string) => {
808
835
  writeService: (service: Service, options?: {
809
836
  path?: string;
810
837
  override?: boolean;
811
- versionExistingContent?: boolean;
838
+ versionExistingContent
839
+ /**
840
+ * Moves a given event id to the version directory
841
+ * @param directory
842
+ */
843
+ ? /**
844
+ * Moves a given event id to the version directory
845
+ * @param directory
846
+ */: boolean;
812
847
  format?: "md" | "mdx";
813
848
  }) => Promise<void>;
814
849
  /**