@eventcatalog/sdk 2.3.6 → 2.3.7

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.
package/dist/index.d.mts CHANGED
@@ -462,12 +462,7 @@ declare const _default: (path: string) => {
462
462
  }, options?: {
463
463
  path?: string;
464
464
  format?: "md" | "mdx";
465
- override? /**
466
- * Remove an command by an Event id
467
- *
468
- * @param id - The id of the command you want to remove
469
- *
470
- */: boolean;
465
+ override?: boolean;
471
466
  }) => Promise<void>;
472
467
  /**
473
468
  * Returns a service from EventCatalog
@@ -813,6 +808,19 @@ declare const _default: (path: string) => {
813
808
  dumpCatalog: (options?: {
814
809
  includeMarkdown?: boolean;
815
810
  }) => Promise<EventCatalogObject>;
811
+ /**
812
+ * ================================
813
+ * Resources Utils
814
+ * ================================
815
+ */
816
+ /**
817
+ * Returns the path to a given resource by id and version
818
+ */
819
+ getResourcePath: (catalogDir: string, id: string, version?: string) => Promise<{
820
+ fullPath: string;
821
+ relativePath: string;
822
+ directory: string;
823
+ } | undefined>;
816
824
  };
817
825
 
818
826
  export { _default as default };
package/dist/index.d.ts CHANGED
@@ -462,12 +462,7 @@ declare const _default: (path: string) => {
462
462
  }, options?: {
463
463
  path?: string;
464
464
  format?: "md" | "mdx";
465
- override? /**
466
- * Remove an command by an Event id
467
- *
468
- * @param id - The id of the command you want to remove
469
- *
470
- */: boolean;
465
+ override?: boolean;
471
466
  }) => Promise<void>;
472
467
  /**
473
468
  * Returns a service from EventCatalog
@@ -813,6 +808,19 @@ declare const _default: (path: string) => {
813
808
  dumpCatalog: (options?: {
814
809
  includeMarkdown?: boolean;
815
810
  }) => Promise<EventCatalogObject>;
811
+ /**
812
+ * ================================
813
+ * Resources Utils
814
+ * ================================
815
+ */
816
+ /**
817
+ * Returns the path to a given resource by id and version
818
+ */
819
+ getResourcePath: (catalogDir: string, id: string, version?: string) => Promise<{
820
+ fullPath: string;
821
+ relativePath: string;
822
+ directory: string;
823
+ } | undefined>;
816
824
  };
817
825
 
818
826
  export { _default as default };
package/dist/index.js CHANGED
@@ -1517,7 +1517,16 @@ var index_default = (path4) => {
1517
1517
  * @param directory - The directory to dump the catalog to
1518
1518
  * @returns A JSON file with the catalog
1519
1519
  */
1520
- dumpCatalog: dumpCatalog((0, import_node_path12.join)(path4))
1520
+ dumpCatalog: dumpCatalog((0, import_node_path12.join)(path4)),
1521
+ /**
1522
+ * ================================
1523
+ * Resources Utils
1524
+ * ================================
1525
+ */
1526
+ /**
1527
+ * Returns the path to a given resource by id and version
1528
+ */
1529
+ getResourcePath
1521
1530
  };
1522
1531
  };
1523
1532
  //# sourceMappingURL=index.js.map