@eventcatalog/sdk 2.1.2 → 2.2.1

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 (53) hide show
  1. package/dist/channels.d.mts +1 -1
  2. package/dist/channels.d.ts +1 -1
  3. package/dist/channels.js +1 -1
  4. package/dist/channels.js.map +1 -1
  5. package/dist/channels.mjs +1 -1
  6. package/dist/channels.mjs.map +1 -1
  7. package/dist/commands.d.mts +1 -1
  8. package/dist/commands.d.ts +1 -1
  9. package/dist/commands.js +17 -4
  10. package/dist/commands.js.map +1 -1
  11. package/dist/commands.mjs +17 -4
  12. package/dist/commands.mjs.map +1 -1
  13. package/dist/custom-docs.js.map +1 -1
  14. package/dist/custom-docs.mjs.map +1 -1
  15. package/dist/domains.d.mts +1 -1
  16. package/dist/domains.d.ts +1 -1
  17. package/dist/domains.js +1 -1
  18. package/dist/domains.js.map +1 -1
  19. package/dist/domains.mjs +1 -1
  20. package/dist/domains.mjs.map +1 -1
  21. package/dist/events.d.mts +1 -1
  22. package/dist/events.d.ts +1 -1
  23. package/dist/events.js +15 -2
  24. package/dist/events.js.map +1 -1
  25. package/dist/events.mjs +15 -2
  26. package/dist/events.mjs.map +1 -1
  27. package/dist/index.d.mts +6 -6
  28. package/dist/index.d.ts +6 -6
  29. package/dist/index.js +38 -17
  30. package/dist/index.js.map +1 -1
  31. package/dist/index.mjs +40 -19
  32. package/dist/index.mjs.map +1 -1
  33. package/dist/queries.d.mts +1 -1
  34. package/dist/queries.d.ts +1 -1
  35. package/dist/queries.js +15 -2
  36. package/dist/queries.js.map +1 -1
  37. package/dist/queries.mjs +15 -2
  38. package/dist/queries.mjs.map +1 -1
  39. package/dist/services.d.mts +1 -1
  40. package/dist/services.d.ts +1 -1
  41. package/dist/services.js +1 -1
  42. package/dist/services.js.map +1 -1
  43. package/dist/services.mjs +1 -1
  44. package/dist/services.mjs.map +1 -1
  45. package/dist/teams.js +4 -4
  46. package/dist/teams.js.map +1 -1
  47. package/dist/teams.mjs +4 -4
  48. package/dist/teams.mjs.map +1 -1
  49. package/dist/users.js +4 -4
  50. package/dist/users.js.map +1 -1
  51. package/dist/users.mjs +4 -4
  52. package/dist/users.mjs.map +1 -1
  53. package/package.json +1 -1
package/dist/index.mjs CHANGED
@@ -106,7 +106,7 @@ var versionResource = async (catalogDir, id) => {
106
106
  const files = await getFiles(`${catalogDir}/**/index.{md,mdx}`);
107
107
  const matchedFiles = await searchFilesForId(files, id);
108
108
  if (matchedFiles.length === 0) {
109
- throw new Error(`No event found with id: ${id}`);
109
+ throw new Error(`No resource found with id: ${id}`);
110
110
  }
111
111
  const file = matchedFiles[0];
112
112
  const sourceDirectory = dirname(file);
@@ -176,6 +176,15 @@ var getResource = async (catalogDir, id, version, options) => {
176
176
  markdown: content.trim()
177
177
  };
178
178
  };
179
+ var getResourcePath = async (catalogDir, id, version) => {
180
+ const file = await findFileById(catalogDir, id, version);
181
+ if (!file) return;
182
+ return {
183
+ fullPath: file,
184
+ relativePath: file.replace(catalogDir, ""),
185
+ directory: dirname(file.replace(catalogDir, ""))
186
+ };
187
+ };
179
188
  var getResources = async (catalogDir, {
180
189
  type,
181
190
  latestOnly = false,
@@ -236,7 +245,11 @@ var getEvent = (directory) => async (id, version) => getResource(directory, id,
236
245
  var getEvents = (directory) => async (options) => getResources(directory, { type: "events", ...options });
237
246
  var writeEvent = (directory) => async (event, options = { path: "", override: false }) => writeResource(directory, { ...event }, { ...options, type: "event" });
238
247
  var writeEventToService = (directory) => async (event, service, options = { path: "" }) => {
239
- let pathForEvent = service.version && service.version !== "latest" ? `/${service.id}/versioned/${service.version}/events` : `/${service.id}/events`;
248
+ const resourcePath = await getResourcePath(directory, service.id, service.version);
249
+ if (!resourcePath) {
250
+ throw new Error("Service not found");
251
+ }
252
+ let pathForEvent = service.version && service.version !== "latest" ? `${resourcePath.directory}/versioned/${service.version}/events` : `${resourcePath.directory}/events`;
240
253
  pathForEvent = join3(pathForEvent, event.id);
241
254
  await writeResource(directory, { ...event }, { ...options, path: pathForEvent, type: "event" });
242
255
  };
@@ -263,9 +276,13 @@ var getCommand = (directory) => async (id, version) => getResource(directory, id
263
276
  var getCommands = (directory) => async (options) => getResources(directory, { type: "commands", ...options });
264
277
  var writeCommand = (directory) => async (command, options = { path: "" }) => writeResource(directory, { ...command }, { ...options, type: "command" });
265
278
  var writeCommandToService = (directory) => async (command, service, options = { path: "" }) => {
266
- let pathForEvent = service.version && service.version !== "latest" ? `/${service.id}/versioned/${service.version}/commands` : `/${service.id}/commands`;
267
- pathForEvent = join4(pathForEvent, command.id);
268
- await writeResource(directory, { ...command }, { ...options, path: pathForEvent, type: "command" });
279
+ const resourcePath = await getResourcePath(directory, service.id, service.version);
280
+ if (!resourcePath) {
281
+ throw new Error("Service not found");
282
+ }
283
+ let pathForCommand = service.version && service.version !== "latest" ? `${resourcePath.directory}/versioned/${service.version}/commands` : `${resourcePath.directory}/commands`;
284
+ pathForCommand = join4(pathForCommand, command.id);
285
+ await writeResource(directory, { ...command }, { ...options, path: pathForCommand, type: "command" });
269
286
  };
270
287
  var rmCommand = (directory) => async (path3) => {
271
288
  await fs3.rm(join4(directory, path3), { recursive: true });
@@ -288,7 +305,11 @@ var getQuery = (directory) => async (id, version) => getResource(directory, id,
288
305
  var writeQuery = (directory) => async (query, options = { path: "" }) => writeResource(directory, { ...query }, { ...options, type: "query" });
289
306
  var getQueries = (directory) => async (options) => getResources(directory, { type: "queries", ...options });
290
307
  var writeQueryToService = (directory) => async (query, service, options = { path: "" }) => {
291
- let pathForQuery = service.version && service.version !== "latest" ? `/${service.id}/versioned/${service.version}/queries` : `/${service.id}/queries`;
308
+ const resourcePath = await getResourcePath(directory, service.id, service.version);
309
+ if (!resourcePath) {
310
+ throw new Error("Service not found");
311
+ }
312
+ let pathForQuery = service.version && service.version !== "latest" ? `${resourcePath.directory}/versioned/${service.version}/queries` : `${resourcePath.directory}/queries`;
292
313
  pathForQuery = join5(pathForQuery, query.id);
293
314
  await writeResource(directory, { ...query }, { ...options, path: pathForQuery, type: "query" });
294
315
  };
@@ -310,7 +331,7 @@ var queryHasVersion = (directory) => async (id, version) => {
310
331
 
311
332
  // src/services.ts
312
333
  import fs5 from "node:fs/promises";
313
- import { join as join6, dirname as dirname2 } from "node:path";
334
+ import { join as join6, dirname as dirname3 } from "node:path";
314
335
  var getService = (directory) => async (id, version) => getResource(directory, id, version, { type: "service" });
315
336
  var getServices = (directory) => async (options) => getResources(directory, {
316
337
  type: "services",
@@ -357,7 +378,7 @@ var getSpecificationFilesForService = (directory) => async (id, version) => {
357
378
  throw new Error(`Specification file name for ${specFile} is undefined`);
358
379
  }
359
380
  const rawFile = await getFileFromResource(directory, id, { fileName }, version);
360
- return { key: specFile, content: rawFile, fileName, path: join6(dirname2(filePathToService), fileName) };
381
+ return { key: specFile, content: rawFile, fileName, path: join6(dirname3(filePathToService), fileName) };
361
382
  });
362
383
  specs = await Promise.all(getSpecs);
363
384
  }
@@ -554,7 +575,7 @@ import fsSync5 from "node:fs";
554
575
  import { join as join10 } from "node:path";
555
576
  import matter5 from "gray-matter";
556
577
  var getTeam = (catalogDir) => async (id) => {
557
- const files = await getFiles(`${catalogDir}/${id}.md`);
578
+ const files = await getFiles(`${catalogDir}/${id}.{md,mdx}`);
558
579
  if (files.length == 0) return void 0;
559
580
  const file = files[0];
560
581
  const { data, content } = matter5.read(file);
@@ -566,7 +587,7 @@ var getTeam = (catalogDir) => async (id) => {
566
587
  };
567
588
  };
568
589
  var getTeams = (catalogDir) => async (options) => {
569
- const files = await getFiles(`${catalogDir}/teams/*.md`);
590
+ const files = await getFiles(`${catalogDir}/teams/*.{md,mdx}`);
570
591
  if (files.length === 0) return [];
571
592
  return files.map((file) => {
572
593
  const { data, content } = matter5.read(file);
@@ -588,10 +609,10 @@ var writeTeam = (catalogDir) => async (team, options = {}) => {
588
609
  const { markdown, ...frontmatter } = resource;
589
610
  const document = matter5.stringify(markdown, frontmatter);
590
611
  fsSync5.mkdirSync(join10(catalogDir, ""), { recursive: true });
591
- fsSync5.writeFileSync(join10(catalogDir, "", `${resource.id}.md`), document);
612
+ fsSync5.writeFileSync(join10(catalogDir, "", `${resource.id}.mdx`), document);
592
613
  };
593
614
  var rmTeamById = (catalogDir) => async (id) => {
594
- await fs9.rm(join10(catalogDir, `${id}.md`), { recursive: true });
615
+ await fs9.rm(join10(catalogDir, `${id}.mdx`), { recursive: true });
595
616
  };
596
617
 
597
618
  // src/users.ts
@@ -599,7 +620,7 @@ import fsSync6 from "node:fs";
599
620
  import { join as join11 } from "node:path";
600
621
  import matter6 from "gray-matter";
601
622
  var getUser = (catalogDir) => async (id) => {
602
- const files = await getFiles(`${catalogDir}/${id}.md`);
623
+ const files = await getFiles(`${catalogDir}/${id}.{md,mdx}`);
603
624
  if (files.length == 0) return void 0;
604
625
  const file = files[0];
605
626
  const { data, content } = matter6.read(file);
@@ -612,7 +633,7 @@ var getUser = (catalogDir) => async (id) => {
612
633
  };
613
634
  };
614
635
  var getUsers = (catalogDir) => async (options) => {
615
- const files = await getFiles(`${catalogDir}/users/*.md`);
636
+ const files = await getFiles(`${catalogDir}/users/*.{md,mdx}`);
616
637
  if (files.length === 0) return [];
617
638
  return files.map((file) => {
618
639
  const { data, content } = matter6.read(file);
@@ -635,10 +656,10 @@ var writeUser = (catalogDir) => async (user, options = {}) => {
635
656
  const { markdown, ...frontmatter } = resource;
636
657
  const document = matter6.stringify(markdown, frontmatter);
637
658
  fsSync6.mkdirSync(join11(catalogDir, ""), { recursive: true });
638
- fsSync6.writeFileSync(join11(catalogDir, "", `${resource.id}.md`), document);
659
+ fsSync6.writeFileSync(join11(catalogDir, "", `${resource.id}.mdx`), document);
639
660
  };
640
661
  var rmUserById = (catalogDir) => async (id) => {
641
- fsSync6.rmSync(join11(catalogDir, `${id}.md`), { recursive: true });
662
+ fsSync6.rmSync(join11(catalogDir, `${id}.mdx`), { recursive: true });
642
663
  };
643
664
 
644
665
  // src/index.ts
@@ -673,7 +694,7 @@ var index_default = (path3) => {
673
694
  * @param options - Optional options to write the event
674
695
  *
675
696
  */
676
- writeEventToService: writeEventToService(join12(path3, "services")),
697
+ writeEventToService: writeEventToService(join12(path3)),
677
698
  /**
678
699
  * Remove an event to EventCatalog (modeled on the standard POSIX rm utility)
679
700
  *
@@ -750,7 +771,7 @@ var index_default = (path3) => {
750
771
  * @param options - Optional options to write the command
751
772
  *
752
773
  */
753
- writeCommandToService: writeCommandToService(join12(path3, "services")),
774
+ writeCommandToService: writeCommandToService(join12(path3)),
754
775
  /**
755
776
  * Remove an command to EventCatalog (modeled on the standard POSIX rm utility)
756
777
  *
@@ -827,7 +848,7 @@ var index_default = (path3) => {
827
848
  * @param options - Optional options to write the query
828
849
  *
829
850
  */
830
- writeQueryToService: writeQueryToService(join12(path3, "services")),
851
+ writeQueryToService: writeQueryToService(join12(path3)),
831
852
  /**
832
853
  * Remove an query to EventCatalog (modeled on the standard POSIX rm utility)
833
854
  *