@eventcatalog/sdk 0.0.4 → 0.0.6

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 (50) hide show
  1. package/dist/commands.d.mts +172 -0
  2. package/dist/commands.d.ts +172 -0
  3. package/dist/commands.js +191 -0
  4. package/dist/commands.js.map +1 -0
  5. package/dist/commands.mjs +150 -0
  6. package/dist/commands.mjs.map +1 -0
  7. package/dist/events.d.mts +3 -3
  8. package/dist/events.d.ts +3 -3
  9. package/dist/events.js +59 -47
  10. package/dist/events.js.map +1 -1
  11. package/dist/events.mjs +60 -48
  12. package/dist/events.mjs.map +1 -1
  13. package/dist/index.d.mts +64 -1
  14. package/dist/index.d.ts +64 -1
  15. package/dist/index.js +133 -105
  16. package/dist/index.js.map +1 -1
  17. package/dist/index.mjs +147 -119
  18. package/dist/index.mjs.map +1 -1
  19. package/dist/services.d.mts +2 -2
  20. package/dist/services.d.ts +2 -2
  21. package/dist/services.js +54 -41
  22. package/dist/services.js.map +1 -1
  23. package/dist/services.mjs +54 -41
  24. package/dist/services.mjs.map +1 -1
  25. package/dist/types.d.js.map +1 -1
  26. package/package.json +2 -2
  27. package/dist/docs.d.mts +0 -3
  28. package/dist/docs.d.ts +0 -3
  29. package/dist/docs.js +0 -259
  30. package/dist/docs.js.map +0 -1
  31. package/dist/docs.mjs +0 -210
  32. package/dist/docs.mjs.map +0 -1
  33. package/dist/internal/utils.d.mts +0 -19
  34. package/dist/internal/utils.d.ts +0 -19
  35. package/dist/internal/utils.js +0 -103
  36. package/dist/internal/utils.js.map +0 -1
  37. package/dist/internal/utils.mjs +0 -64
  38. package/dist/internal/utils.mjs.map +0 -1
  39. package/dist/test/events.test.d.mts +0 -2
  40. package/dist/test/events.test.d.ts +0 -2
  41. package/dist/test/events.test.js +0 -16942
  42. package/dist/test/events.test.js.map +0 -1
  43. package/dist/test/events.test.mjs +0 -16927
  44. package/dist/test/events.test.mjs.map +0 -1
  45. package/dist/test/services.test.d.mts +0 -2
  46. package/dist/test/services.test.d.ts +0 -2
  47. package/dist/test/services.test.js +0 -16888
  48. package/dist/test/services.test.js.map +0 -1
  49. package/dist/test/services.test.mjs +0 -16873
  50. package/dist/test/services.test.mjs.map +0 -1
@@ -0,0 +1,150 @@
1
+ // src/commands.ts
2
+ import fs3 from "fs/promises";
3
+ import { join as join3 } from "path";
4
+
5
+ // src/internal/resources.ts
6
+ import { dirname, join as join2 } from "path";
7
+
8
+ // src/internal/utils.ts
9
+ import { glob } from "glob";
10
+ import fs from "fs/promises";
11
+ import { copy } from "fs-extra";
12
+ import { join } from "path";
13
+ var versionExists = async (catalogDir, id, version) => {
14
+ const files = await getFiles(`${catalogDir}/**/index.md`);
15
+ const matchedFiles = await searchFilesForId(files, id, version) || [];
16
+ return matchedFiles.length > 0;
17
+ };
18
+ var findFileById = async (catalogDir, id, version) => {
19
+ const files = await getFiles(`${catalogDir}/**/index.md`);
20
+ const matchedFiles = await searchFilesForId(files, id) || [];
21
+ if (!version) {
22
+ return matchedFiles.find((path) => !path.includes("versioned"));
23
+ }
24
+ return matchedFiles.find((path) => path.includes(`versioned/${version}`));
25
+ };
26
+ var getFiles = async (pattern) => {
27
+ try {
28
+ const files = await glob(pattern, { ignore: "node_modules/**" });
29
+ return files;
30
+ } catch (error) {
31
+ throw new Error(`Error finding files: ${error}`);
32
+ }
33
+ };
34
+ var searchFilesForId = async (files, id, version) => {
35
+ const idRegex = new RegExp(`^id:\\s*['"]?${id}['"]?\\s*$`, "m");
36
+ const versionRegex = new RegExp(`^version:\\s*['"]?${version}['"]?\\s*$`, "m");
37
+ const matches = await Promise.all(
38
+ files.map(async (file) => {
39
+ const content = await fs.readFile(file, "utf-8");
40
+ const hasIdMatch = content.match(idRegex);
41
+ if (version && !content.match(versionRegex)) {
42
+ return void 0;
43
+ }
44
+ if (hasIdMatch) {
45
+ return file;
46
+ }
47
+ })
48
+ );
49
+ return matches.filter(Boolean).filter((file) => file !== void 0);
50
+ };
51
+ var copyDir = async (catalogDir, source, target, filter) => {
52
+ const tmpDirectory = join(catalogDir, "tmp");
53
+ await fs.mkdir(tmpDirectory, { recursive: true });
54
+ await copy(source, tmpDirectory, {
55
+ overwrite: true,
56
+ filter
57
+ });
58
+ await copy(tmpDirectory, target, {
59
+ overwrite: true,
60
+ filter
61
+ });
62
+ await fs.rm(tmpDirectory, { recursive: true });
63
+ };
64
+
65
+ // src/internal/resources.ts
66
+ import matter from "gray-matter";
67
+ import fs2 from "fs/promises";
68
+ var versionResource = async (catalogDir, id) => {
69
+ const files = await getFiles(`${catalogDir}/**/index.md`);
70
+ const matchedFiles = await searchFilesForId(files, id);
71
+ if (matchedFiles.length === 0) {
72
+ throw new Error(`No event found with id: ${id}`);
73
+ }
74
+ const file = matchedFiles[0];
75
+ const sourceDirectory = dirname(file);
76
+ const { data: { version = "0.0.1" } = {} } = matter.read(file);
77
+ const targetDirectory = join2(sourceDirectory, "versioned", version);
78
+ await fs2.mkdir(targetDirectory, { recursive: true });
79
+ await copyDir(catalogDir, sourceDirectory, targetDirectory, (src) => {
80
+ return !src.includes("versioned");
81
+ });
82
+ await fs2.readdir(sourceDirectory).then(async (resourceFiles) => {
83
+ await Promise.all(
84
+ resourceFiles.map(async (file2) => {
85
+ if (file2 !== "versioned") {
86
+ await fs2.rm(join2(sourceDirectory, file2), { recursive: true });
87
+ }
88
+ })
89
+ );
90
+ });
91
+ };
92
+ var writeResource = async (catalogDir, resource, options = { path: "", type: "" }) => {
93
+ const path = options.path || `/${resource.id}`;
94
+ const exists = await versionExists(catalogDir, resource.id, resource.version);
95
+ if (exists) {
96
+ throw new Error(`Failed to write ${options.type} as the version ${resource.version} already exists`);
97
+ }
98
+ const { markdown, ...frontmatter } = resource;
99
+ const document = matter.stringify(markdown.trim(), frontmatter);
100
+ await fs2.mkdir(join2(catalogDir, path), { recursive: true });
101
+ await fs2.writeFile(join2(catalogDir, path, "index.md"), document);
102
+ };
103
+ var getResource = async (catalogDir, id, version, options) => {
104
+ const file = await findFileById(catalogDir, id, version);
105
+ if (!file)
106
+ throw new Error(
107
+ `No ${options?.type || "resource"} found for the given id: ${id}` + (version ? ` and version ${version}` : "")
108
+ );
109
+ const { data, content } = matter.read(file);
110
+ return {
111
+ ...data,
112
+ markdown: content.trim()
113
+ };
114
+ };
115
+ var rmResourceById = async (catalogDir, id, version, options) => {
116
+ const files = await getFiles(`${catalogDir}/**/index.md`);
117
+ const matchedFiles = await searchFilesForId(files, id, version);
118
+ if (matchedFiles.length === 0) {
119
+ throw new Error(`No ${options?.type || "resource"} found with id: ${id}`);
120
+ }
121
+ await Promise.all(matchedFiles.map((file) => fs2.rm(file)));
122
+ };
123
+ var addFileToResource = async (catalogDir, id, file, version) => {
124
+ const pathToResource = await findFileById(catalogDir, id, version);
125
+ if (!pathToResource) throw new Error("Cannot find directory to write file to");
126
+ await fs2.writeFile(join2(dirname(pathToResource), file.fileName), file.content);
127
+ };
128
+
129
+ // src/commands.ts
130
+ var getCommand = (directory) => async (id, version) => getResource(directory, id, version, { type: "command" });
131
+ var writeCommand = (directory) => async (command, options = { path: "" }) => writeResource(directory, { ...command }, { ...options, type: "command" });
132
+ var rmCommand = (directory) => async (path) => {
133
+ await fs3.rm(join3(directory, path), { recursive: true });
134
+ };
135
+ var rmCommandById = (directory) => async (id, version) => rmResourceById(directory, id, version, { type: "command" });
136
+ var versionCommand = (directory) => async (id) => versionResource(directory, id);
137
+ var addFileToCommand = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
138
+ var addSchemaToCommand = (directory) => async (id, schema, version) => {
139
+ await addFileToCommand(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);
140
+ };
141
+ export {
142
+ addFileToCommand,
143
+ addSchemaToCommand,
144
+ getCommand,
145
+ rmCommand,
146
+ rmCommandById,
147
+ versionCommand,
148
+ writeCommand
149
+ };
150
+ //# sourceMappingURL=commands.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/commands.ts","../src/internal/resources.ts","../src/internal/utils.ts"],"sourcesContent":["import fs from 'node:fs/promises';\nimport { join } from 'node:path';\nimport type { Command } from './types';\nimport { addFileToResource, getResource, rmResourceById, versionResource, writeResource } from './internal/resources';\n\n/**\n * Returns a command from EventCatalog.\n *\n * You can optionally specify a version to get a specific version of the command\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getCommand } = utils('/path/to/eventcatalog');\n *\n * // Gets the latest version of the command\n * const command = await getCommand('UpdateInventory');\n *\n * // Gets a version of the command\n * const command = await getCommand('UpdateInventory', '0.0.1');\n * ```\n */\nexport const getCommand =\n (directory: string) =>\n async (id: string, version?: string): Promise<Command> =>\n getResource(directory, id, version, { type: 'command' }) as Promise<Command>;\n\n/**\n * Write a command to EventCatalog.\n *\n * You can optionally override the path of the command.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { writeCommand } = utils('/path/to/eventcatalog');\n *\n * // Write a command to the catalog\n * // Command would be written to commands/UpdateInventory\n * await writeCommand({\n * id: 'UpdateInventory',\n * name: 'Update Inventory',\n * version: '0.0.1',\n * summary: 'This is a summary',\n * markdown: '# Hello world',\n * });\n *\n * // Write a command to the catalog but override the path\n * // Command would be written to commands/Inventory/UpdateInventory\n * await writeCommand({\n * id: 'UpdateInventory',\n * name: 'Update Inventory',\n * version: '0.0.1',\n * summary: 'This is a summary',\n * markdown: '# Hello world',\n * }, { path: \"/Inventory/UpdateInventory\"});\n * ```\n */\nexport const writeCommand =\n (directory: string) =>\n async (command: Command, options: { path: string } = { path: '' }) =>\n writeResource(directory, { ...command }, { ...options, type: 'command' });\n\n/**\n * Delete a command at it's given path.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { rmCommand } = utils('/path/to/eventcatalog');\n *\n * // removes a command at the given path (commands dir is appended to the given path)\n * // Removes the command at commands/UpdateInventory\n * await rmCommand('/UpdateInventory');\n * ```\n */\nexport const rmCommand = (directory: string) => async (path: string) => {\n await fs.rm(join(directory, path), { recursive: true });\n};\n\n/**\n * Delete a command by it's id.\n *\n * Optionally specify a version to delete a specific version of the command.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { rmCommandById } = utils('/path/to/eventcatalog');\n *\n * // deletes the latest UpdateInventory command\n * await rmCommandById('UpdateInventory');\n *\n * // deletes a specific version of the UpdateInventory command\n * await rmCommandById('UpdateInventory', '0.0.1');\n * ```\n */\nexport const rmCommandById = (directory: string) => async (id: string, version?: string) =>\n rmResourceById(directory, id, version, { type: 'command' });\n\n/**\n * Version a command by it's id.\n *\n * Takes the latest command and moves it to a versioned directory.\n * All files with this command are also versioned (e.g /commands/UpdateInventory/schema.json)\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { versionCommand } = utils('/path/to/eventcatalog');\n *\n * // moves the latest UpdateInventory command to a versioned directory\n * // the version within that command is used as the version number.\n * await versionCommand('UpdateInventory');\n *\n * ```\n */\nexport const versionCommand = (directory: string) => async (id: string) => versionResource(directory, id);\n\n/**\n * Add a file to a command by it's id.\n *\n * Optionally specify a version to add a file to a specific version of the command.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { addFileToCommand } = utils('/path/to/eventcatalog');\n *\n * // adds a file to the latest UpdateInventory command\n * await addFileToCommand('UpdateInventory', { content: 'Hello world', fileName: 'hello.txt' });\n *\n * // adds a file to a specific version of the UpdateInventory command\n * await addFileToCommand('UpdateInventory', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');\n *\n * ```\n */\nexport const addFileToCommand =\n (directory: string) => async (id: string, file: { content: string; fileName: string }, version?: string) =>\n addFileToResource(directory, id, file, version);\n\n/**\n * Add a schema to a command by it's id.\n *\n * Optionally specify a version to add a schema to a specific version of the command.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { addSchemaToCommand } = utils('/path/to/eventcatalog');\n *\n * // JSON schema example\n * const schema = {\n * \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n * \"type\": \"object\",\n * \"properties\": {\n * \"name\": {\n * \"type\": \"string\"\n * },\n * \"age\": {\n * \"type\": \"number\"\n * }\n * },\n * \"required\": [\"name\", \"age\"]\n * };\n *\n * // adds a schema to the latest UpdateInventory command\n * await addSchemaToCommand('UpdateInventory', { schema, fileName: 'schema.json' });\n *\n * // adds a file to a specific version of the UpdateInventory command\n * await addSchemaToCommand('UpdateInventory', { schema, fileName: 'schema.json' }, '0.0.1');\n *\n * ```\n */\nexport const addSchemaToCommand =\n (directory: string) => async (id: string, schema: { schema: string; fileName: string }, version?: string) => {\n await addFileToCommand(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);\n };\n","import { dirname, join } from 'path';\nimport { copyDir, findFileById, getFiles, searchFilesForId, versionExists } from './utils';\nimport matter from 'gray-matter';\nimport fs from 'node:fs/promises';\nimport { Message, Service } from '../types';\n\ntype Resource = Service | Message;\n\nexport const versionResource = async (catalogDir: string, id: string) => {\n // Find all the events in the directory\n const files = await getFiles(`${catalogDir}/**/index.md`);\n const matchedFiles = await searchFilesForId(files, id);\n\n if (matchedFiles.length === 0) {\n throw new Error(`No event found with id: ${id}`);\n }\n\n // Event that is in the route of the project\n const file = matchedFiles[0];\n const sourceDirectory = dirname(file);\n const { data: { version = '0.0.1' } = {} } = matter.read(file);\n const targetDirectory = join(sourceDirectory, 'versioned', version);\n\n await fs.mkdir(targetDirectory, { recursive: true });\n\n // Copy the event to the versioned directory\n await copyDir(catalogDir, sourceDirectory, targetDirectory, (src) => {\n return !src.includes('versioned');\n });\n\n // Remove all the files in the root of the resource as they have now been versioned\n await fs.readdir(sourceDirectory).then(async (resourceFiles) => {\n await Promise.all(\n resourceFiles.map(async (file) => {\n if (file !== 'versioned') {\n await fs.rm(join(sourceDirectory, file), { recursive: true });\n }\n })\n );\n });\n};\n\nexport const writeResource = async (\n catalogDir: string,\n resource: Resource,\n options: { path: string; type: string } = { path: '', type: '' }\n) => {\n // Get the path\n const path = options.path || `/${resource.id}`;\n const exists = await versionExists(catalogDir, resource.id, resource.version);\n\n if (exists) {\n throw new Error(`Failed to write ${options.type} as the version ${resource.version} already exists`);\n }\n\n const { markdown, ...frontmatter } = resource;\n const document = matter.stringify(markdown.trim(), frontmatter);\n await fs.mkdir(join(catalogDir, path), { recursive: true });\n await fs.writeFile(join(catalogDir, path, 'index.md'), document);\n};\n\nexport const getResource = async (\n catalogDir: string,\n id: string,\n version?: string,\n options?: { type: string }\n): Promise<Resource> => {\n const file = await findFileById(catalogDir, id, version);\n\n if (!file)\n throw new Error(\n `No ${options?.type || 'resource'} found for the given id: ${id}` + (version ? ` and version ${version}` : '')\n );\n\n const { data, content } = matter.read(file);\n\n return {\n ...data,\n markdown: content.trim(),\n } as Resource;\n};\n\nexport const rmResourceById = async (catalogDir: string, id: string, version?: string, options?: { type: string }) => {\n const files = await getFiles(`${catalogDir}/**/index.md`);\n const matchedFiles = await searchFilesForId(files, id, version);\n\n if (matchedFiles.length === 0) {\n throw new Error(`No ${options?.type || 'resource'} found with id: ${id}`);\n }\n\n await Promise.all(matchedFiles.map((file) => fs.rm(file)));\n};\n\nexport const addFileToResource = async (\n catalogDir: string,\n id: string,\n file: { content: string; fileName: string },\n version?: string\n) => {\n const pathToResource = await findFileById(catalogDir, id, version);\n\n if (!pathToResource) throw new Error('Cannot find directory to write file to');\n\n await fs.writeFile(join(dirname(pathToResource), file.fileName), file.content);\n};\n","import { glob } from 'glob';\nimport fs from 'node:fs/promises';\nimport { copy, CopyFilterAsync, CopyFilterSync } from 'fs-extra';\nimport { join } from 'node:path';\n\n/**\n * Returns true if a given version of a resource id exists in the catalog\n */\nexport const versionExists = async (catalogDir: string, id: string, version: string) => {\n const files = await getFiles(`${catalogDir}/**/index.md`);\n const matchedFiles = (await searchFilesForId(files, id, version)) || [];\n return matchedFiles.length > 0;\n};\n\nexport const findFileById = async (catalogDir: string, id: string, version?: string): Promise<string | undefined> => {\n const files = await getFiles(`${catalogDir}/**/index.md`);\n const matchedFiles = (await searchFilesForId(files, id)) || [];\n\n // Return the latest one\n if (!version) {\n return matchedFiles.find((path) => !path.includes('versioned'));\n }\n\n // Find the versioned event\n return matchedFiles.find((path) => path.includes(`versioned/${version}`));\n};\n\nexport const getFiles = async (pattern: string) => {\n try {\n const files = await glob(pattern, { ignore: 'node_modules/**' });\n return files;\n } catch (error) {\n throw new Error(`Error finding files: ${error}`);\n }\n};\n\nexport const searchFilesForId = async (files: string[], id: string, version?: string) => {\n const idRegex = new RegExp(`^id:\\\\s*['\"]?${id}['\"]?\\\\s*$`, 'm');\n const versionRegex = new RegExp(`^version:\\\\s*['\"]?${version}['\"]?\\\\s*$`, 'm');\n\n const matches = await Promise.all(\n files.map(async (file) => {\n const content = await fs.readFile(file, 'utf-8');\n const hasIdMatch = content.match(idRegex);\n\n // Check version if provided\n if (version && !content.match(versionRegex)) {\n return undefined;\n }\n\n if (hasIdMatch) {\n return file;\n }\n })\n );\n\n return matches.filter(Boolean).filter((file) => file !== undefined);\n};\n\n/**\n * Function to copy a directory from source to target, uses a tmp directory\n * @param catalogDir\n * @param source\n * @param target\n * @param filter\n */\nexport const copyDir = async (catalogDir: string, source: string, target: string, filter?: CopyFilterAsync | CopyFilterSync) => {\n const tmpDirectory = join(catalogDir, 'tmp');\n await fs.mkdir(tmpDirectory, { recursive: true });\n\n // Copy everything over\n await copy(source, tmpDirectory, {\n overwrite: true,\n filter,\n });\n\n await copy(tmpDirectory, target, {\n overwrite: true,\n filter,\n });\n\n // Remove the tmp directory\n await fs.rm(tmpDirectory, { recursive: true });\n};\n"],"mappings":";AAAA,OAAOA,SAAQ;AACf,SAAS,QAAAC,aAAY;;;ACDrB,SAAS,SAAS,QAAAC,aAAY;;;ACA9B,SAAS,YAAY;AACrB,OAAO,QAAQ;AACf,SAAS,YAA6C;AACtD,SAAS,YAAY;AAKd,IAAM,gBAAgB,OAAO,YAAoB,IAAY,YAAoB;AACtF,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAgB,MAAM,iBAAiB,OAAO,IAAI,OAAO,KAAM,CAAC;AACtE,SAAO,aAAa,SAAS;AAC/B;AAEO,IAAM,eAAe,OAAO,YAAoB,IAAY,YAAkD;AACnH,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAgB,MAAM,iBAAiB,OAAO,EAAE,KAAM,CAAC;AAG7D,MAAI,CAAC,SAAS;AACZ,WAAO,aAAa,KAAK,CAAC,SAAS,CAAC,KAAK,SAAS,WAAW,CAAC;AAAA,EAChE;AAGA,SAAO,aAAa,KAAK,CAAC,SAAS,KAAK,SAAS,aAAa,OAAO,EAAE,CAAC;AAC1E;AAEO,IAAM,WAAW,OAAO,YAAoB;AACjD,MAAI;AACF,UAAM,QAAQ,MAAM,KAAK,SAAS,EAAE,QAAQ,kBAAkB,CAAC;AAC/D,WAAO;AAAA,EACT,SAAS,OAAO;AACd,UAAM,IAAI,MAAM,wBAAwB,KAAK,EAAE;AAAA,EACjD;AACF;AAEO,IAAM,mBAAmB,OAAO,OAAiB,IAAY,YAAqB;AACvF,QAAM,UAAU,IAAI,OAAO,gBAAgB,EAAE,cAAc,GAAG;AAC9D,QAAM,eAAe,IAAI,OAAO,qBAAqB,OAAO,cAAc,GAAG;AAE7E,QAAM,UAAU,MAAM,QAAQ;AAAA,IAC5B,MAAM,IAAI,OAAO,SAAS;AACxB,YAAM,UAAU,MAAM,GAAG,SAAS,MAAM,OAAO;AAC/C,YAAM,aAAa,QAAQ,MAAM,OAAO;AAGxC,UAAI,WAAW,CAAC,QAAQ,MAAM,YAAY,GAAG;AAC3C,eAAO;AAAA,MACT;AAEA,UAAI,YAAY;AACd,eAAO;AAAA,MACT;AAAA,IACF,CAAC;AAAA,EACH;AAEA,SAAO,QAAQ,OAAO,OAAO,EAAE,OAAO,CAAC,SAAS,SAAS,MAAS;AACpE;AASO,IAAM,UAAU,OAAO,YAAoB,QAAgB,QAAgB,WAA8C;AAC9H,QAAM,eAAe,KAAK,YAAY,KAAK;AAC3C,QAAM,GAAG,MAAM,cAAc,EAAE,WAAW,KAAK,CAAC;AAGhD,QAAM,KAAK,QAAQ,cAAc;AAAA,IAC/B,WAAW;AAAA,IACX;AAAA,EACF,CAAC;AAED,QAAM,KAAK,cAAc,QAAQ;AAAA,IAC/B,WAAW;AAAA,IACX;AAAA,EACF,CAAC;AAGD,QAAM,GAAG,GAAG,cAAc,EAAE,WAAW,KAAK,CAAC;AAC/C;;;ADjFA,OAAO,YAAY;AACnB,OAAOC,SAAQ;AAKR,IAAM,kBAAkB,OAAO,YAAoB,OAAe;AAEvE,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAe,MAAM,iBAAiB,OAAO,EAAE;AAErD,MAAI,aAAa,WAAW,GAAG;AAC7B,UAAM,IAAI,MAAM,2BAA2B,EAAE,EAAE;AAAA,EACjD;AAGA,QAAM,OAAO,aAAa,CAAC;AAC3B,QAAM,kBAAkB,QAAQ,IAAI;AACpC,QAAM,EAAE,MAAM,EAAE,UAAU,QAAQ,IAAI,CAAC,EAAE,IAAI,OAAO,KAAK,IAAI;AAC7D,QAAM,kBAAkBC,MAAK,iBAAiB,aAAa,OAAO;AAElE,QAAMD,IAAG,MAAM,iBAAiB,EAAE,WAAW,KAAK,CAAC;AAGnD,QAAM,QAAQ,YAAY,iBAAiB,iBAAiB,CAAC,QAAQ;AACnE,WAAO,CAAC,IAAI,SAAS,WAAW;AAAA,EAClC,CAAC;AAGD,QAAMA,IAAG,QAAQ,eAAe,EAAE,KAAK,OAAO,kBAAkB;AAC9D,UAAM,QAAQ;AAAA,MACZ,cAAc,IAAI,OAAOE,UAAS;AAChC,YAAIA,UAAS,aAAa;AACxB,gBAAMF,IAAG,GAAGC,MAAK,iBAAiBC,KAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AAAA,QAC9D;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF,CAAC;AACH;AAEO,IAAM,gBAAgB,OAC3B,YACA,UACA,UAA0C,EAAE,MAAM,IAAI,MAAM,GAAG,MAC5D;AAEH,QAAM,OAAO,QAAQ,QAAQ,IAAI,SAAS,EAAE;AAC5C,QAAM,SAAS,MAAM,cAAc,YAAY,SAAS,IAAI,SAAS,OAAO;AAE5E,MAAI,QAAQ;AACV,UAAM,IAAI,MAAM,mBAAmB,QAAQ,IAAI,mBAAmB,SAAS,OAAO,iBAAiB;AAAA,EACrG;AAEA,QAAM,EAAE,UAAU,GAAG,YAAY,IAAI;AACrC,QAAM,WAAW,OAAO,UAAU,SAAS,KAAK,GAAG,WAAW;AAC9D,QAAMF,IAAG,MAAMC,MAAK,YAAY,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AAC1D,QAAMD,IAAG,UAAUC,MAAK,YAAY,MAAM,UAAU,GAAG,QAAQ;AACjE;AAEO,IAAM,cAAc,OACzB,YACA,IACA,SACA,YACsB;AACtB,QAAM,OAAO,MAAM,aAAa,YAAY,IAAI,OAAO;AAEvD,MAAI,CAAC;AACH,UAAM,IAAI;AAAA,MACR,MAAM,SAAS,QAAQ,UAAU,4BAA4B,EAAE,MAAM,UAAU,gBAAgB,OAAO,KAAK;AAAA,IAC7G;AAEF,QAAM,EAAE,MAAM,QAAQ,IAAI,OAAO,KAAK,IAAI;AAE1C,SAAO;AAAA,IACL,GAAG;AAAA,IACH,UAAU,QAAQ,KAAK;AAAA,EACzB;AACF;AAEO,IAAM,iBAAiB,OAAO,YAAoB,IAAY,SAAkB,YAA+B;AACpH,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAe,MAAM,iBAAiB,OAAO,IAAI,OAAO;AAE9D,MAAI,aAAa,WAAW,GAAG;AAC7B,UAAM,IAAI,MAAM,MAAM,SAAS,QAAQ,UAAU,mBAAmB,EAAE,EAAE;AAAA,EAC1E;AAEA,QAAM,QAAQ,IAAI,aAAa,IAAI,CAAC,SAASD,IAAG,GAAG,IAAI,CAAC,CAAC;AAC3D;AAEO,IAAM,oBAAoB,OAC/B,YACA,IACA,MACA,YACG;AACH,QAAM,iBAAiB,MAAM,aAAa,YAAY,IAAI,OAAO;AAEjE,MAAI,CAAC,eAAgB,OAAM,IAAI,MAAM,wCAAwC;AAE7E,QAAMA,IAAG,UAAUC,MAAK,QAAQ,cAAc,GAAG,KAAK,QAAQ,GAAG,KAAK,OAAO;AAC/E;;;ADjFO,IAAM,aACX,CAAC,cACD,OAAO,IAAY,YACjB,YAAY,WAAW,IAAI,SAAS,EAAE,MAAM,UAAU,CAAC;AAkCpD,IAAM,eACX,CAAC,cACD,OAAO,SAAkB,UAA4B,EAAE,MAAM,GAAG,MAC9D,cAAc,WAAW,EAAE,GAAG,QAAQ,GAAG,EAAE,GAAG,SAAS,MAAM,UAAU,CAAC;AAgBrE,IAAM,YAAY,CAAC,cAAsB,OAAO,SAAiB;AACtE,QAAME,IAAG,GAAGC,MAAK,WAAW,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AACxD;AAoBO,IAAM,gBAAgB,CAAC,cAAsB,OAAO,IAAY,YACrE,eAAe,WAAW,IAAI,SAAS,EAAE,MAAM,UAAU,CAAC;AAoBrD,IAAM,iBAAiB,CAAC,cAAsB,OAAO,OAAe,gBAAgB,WAAW,EAAE;AAqBjG,IAAM,mBACX,CAAC,cAAsB,OAAO,IAAY,MAA6C,YACrF,kBAAkB,WAAW,IAAI,MAAM,OAAO;AAoC3C,IAAM,qBACX,CAAC,cAAsB,OAAO,IAAY,QAA8C,YAAqB;AAC3G,QAAM,iBAAiB,SAAS,EAAE,IAAI,EAAE,SAAS,OAAO,QAAQ,UAAU,OAAO,SAAS,GAAG,OAAO;AACtG;","names":["fs","join","join","fs","join","file","fs","join"]}
package/dist/events.d.mts CHANGED
@@ -12,10 +12,10 @@ import { Event } from './types.d.mjs';
12
12
  * const { getEvent } = utils('/path/to/eventcatalog');
13
13
  *
14
14
  * // Gets the latest version of the event
15
- * cont event = await getEvent('InventoryAdjusted');
15
+ * const event = await getEvent('InventoryAdjusted');
16
16
  *
17
17
  * // Gets a version of the event
18
- * cont event = await getEvent('InventoryAdjusted', '0.0.1');
18
+ * const event = await getEvent('InventoryAdjusted', '0.0.1');
19
19
  * ```
20
20
  */
21
21
  declare const getEvent: (directory: string) => (id: string, version?: string) => Promise<Event>;
@@ -133,7 +133,7 @@ declare const addFileToEvent: (directory: string) => (id: string, file: {
133
133
  /**
134
134
  * Add a schema to an event by it's id.
135
135
  *
136
- * Optionally specify a version to add a schame to a specific version of the event.
136
+ * Optionally specify a version to add a schema to a specific version of the event.
137
137
  *
138
138
  * @example
139
139
  * ```ts
package/dist/events.d.ts CHANGED
@@ -12,10 +12,10 @@ import { Event } from './types.d.js';
12
12
  * const { getEvent } = utils('/path/to/eventcatalog');
13
13
  *
14
14
  * // Gets the latest version of the event
15
- * cont event = await getEvent('InventoryAdjusted');
15
+ * const event = await getEvent('InventoryAdjusted');
16
16
  *
17
17
  * // Gets a version of the event
18
- * cont event = await getEvent('InventoryAdjusted', '0.0.1');
18
+ * const event = await getEvent('InventoryAdjusted', '0.0.1');
19
19
  * ```
20
20
  */
21
21
  declare const getEvent: (directory: string) => (id: string, version?: string) => Promise<Event>;
@@ -133,7 +133,7 @@ declare const addFileToEvent: (directory: string) => (id: string, file: {
133
133
  /**
134
134
  * Add a schema to an event by it's id.
135
135
  *
136
- * Optionally specify a version to add a schame to a specific version of the event.
136
+ * Optionally specify a version to add a schema to a specific version of the event.
137
137
  *
138
138
  * @example
139
139
  * ```ts
package/dist/events.js CHANGED
@@ -39,10 +39,11 @@ __export(events_exports, {
39
39
  writeEvent: () => writeEvent
40
40
  });
41
41
  module.exports = __toCommonJS(events_exports);
42
- var import_gray_matter = __toESM(require("gray-matter"));
43
- var import_promises2 = __toESM(require("fs/promises"));
42
+ var import_promises3 = __toESM(require("fs/promises"));
44
43
  var import_node_path2 = require("path");
45
- var import_node_path3 = require("path");
44
+
45
+ // src/internal/resources.ts
46
+ var import_path = require("path");
46
47
 
47
48
  // src/internal/utils.ts
48
49
  var import_glob = require("glob");
@@ -101,68 +102,79 @@ var copyDir = async (catalogDir, source, target, filter) => {
101
102
  await import_promises.default.rm(tmpDirectory, { recursive: true });
102
103
  };
103
104
 
104
- // src/events.ts
105
- var getEvent = (directory) => async (id, version) => {
106
- const file = await findFileById(directory, id, version);
107
- if (!file) throw new Error(`No event found for the given id: ${id}` + (version ? ` and version ${version}` : ""));
108
- const { data, content } = import_gray_matter.default.read(file);
109
- return {
110
- ...data,
111
- markdown: content.trim()
112
- };
113
- };
114
- var writeEvent = (directory) => async (event, options = { path: "" }) => {
115
- const path = options.path || `/${event.id}`;
116
- const exists = await versionExists(directory, event.id, event.version);
117
- if (exists) {
118
- throw new Error(`Failed to write event as the version ${event.version} already exists`);
119
- }
120
- const { markdown, ...frontmatter } = event;
121
- const document = import_gray_matter.default.stringify(markdown.trim(), frontmatter);
122
- await import_promises2.default.mkdir((0, import_node_path2.join)(directory, path), { recursive: true });
123
- await import_promises2.default.writeFile((0, import_node_path2.join)(directory, path, "index.md"), document);
124
- };
125
- var rmEvent = (directory) => async (path) => {
126
- await import_promises2.default.rm((0, import_node_path2.join)(directory, path), { recursive: true });
127
- };
128
- var rmEventById = (directory) => async (id, version) => {
129
- const files = await getFiles(`${directory}/**/index.md`);
130
- const matchedFiles = await searchFilesForId(files, id, version);
131
- if (matchedFiles.length === 0) {
132
- throw new Error(`No event found with id: ${id}`);
133
- }
134
- await Promise.all(matchedFiles.map((file) => import_promises2.default.rm(file)));
135
- };
136
- var versionEvent = (directory) => async (id) => {
137
- const files = await getFiles(`${directory}/**/index.md`);
105
+ // src/internal/resources.ts
106
+ var import_gray_matter = __toESM(require("gray-matter"));
107
+ var import_promises2 = __toESM(require("fs/promises"));
108
+ var versionResource = async (catalogDir, id) => {
109
+ const files = await getFiles(`${catalogDir}/**/index.md`);
138
110
  const matchedFiles = await searchFilesForId(files, id);
139
111
  if (matchedFiles.length === 0) {
140
112
  throw new Error(`No event found with id: ${id}`);
141
113
  }
142
114
  const file = matchedFiles[0];
143
- const eventDirectory = (0, import_node_path3.dirname)(file);
115
+ const sourceDirectory = (0, import_path.dirname)(file);
144
116
  const { data: { version = "0.0.1" } = {} } = import_gray_matter.default.read(file);
145
- const targetDirectory = (0, import_node_path2.join)(eventDirectory, "versioned", version);
117
+ const targetDirectory = (0, import_path.join)(sourceDirectory, "versioned", version);
146
118
  await import_promises2.default.mkdir(targetDirectory, { recursive: true });
147
- await copyDir(directory, eventDirectory, targetDirectory, (src) => {
119
+ await copyDir(catalogDir, sourceDirectory, targetDirectory, (src) => {
148
120
  return !src.includes("versioned");
149
121
  });
150
- await import_promises2.default.readdir(eventDirectory).then(async (resourceFiles) => {
122
+ await import_promises2.default.readdir(sourceDirectory).then(async (resourceFiles) => {
151
123
  await Promise.all(
152
124
  resourceFiles.map(async (file2) => {
153
125
  if (file2 !== "versioned") {
154
- await import_promises2.default.rm((0, import_node_path2.join)(eventDirectory, file2), { recursive: true });
126
+ await import_promises2.default.rm((0, import_path.join)(sourceDirectory, file2), { recursive: true });
155
127
  }
156
128
  })
157
129
  );
158
130
  });
159
131
  };
160
- var addFileToEvent = (directory) => async (id, file, version) => {
161
- const pathToEvent = await findFileById(directory, id, version);
162
- if (!pathToEvent) throw new Error("Cannot find directory to write file to");
163
- const contentDirectory = (0, import_node_path3.dirname)(pathToEvent);
164
- await import_promises2.default.writeFile((0, import_node_path2.join)(contentDirectory, file.fileName), file.content);
132
+ var writeResource = async (catalogDir, resource, options = { path: "", type: "" }) => {
133
+ const path = options.path || `/${resource.id}`;
134
+ const exists = await versionExists(catalogDir, resource.id, resource.version);
135
+ if (exists) {
136
+ throw new Error(`Failed to write ${options.type} as the version ${resource.version} already exists`);
137
+ }
138
+ const { markdown, ...frontmatter } = resource;
139
+ const document = import_gray_matter.default.stringify(markdown.trim(), frontmatter);
140
+ await import_promises2.default.mkdir((0, import_path.join)(catalogDir, path), { recursive: true });
141
+ await import_promises2.default.writeFile((0, import_path.join)(catalogDir, path, "index.md"), document);
142
+ };
143
+ var getResource = async (catalogDir, id, version, options) => {
144
+ const file = await findFileById(catalogDir, id, version);
145
+ if (!file)
146
+ throw new Error(
147
+ `No ${options?.type || "resource"} found for the given id: ${id}` + (version ? ` and version ${version}` : "")
148
+ );
149
+ const { data, content } = import_gray_matter.default.read(file);
150
+ return {
151
+ ...data,
152
+ markdown: content.trim()
153
+ };
154
+ };
155
+ var rmResourceById = async (catalogDir, id, version, options) => {
156
+ const files = await getFiles(`${catalogDir}/**/index.md`);
157
+ const matchedFiles = await searchFilesForId(files, id, version);
158
+ if (matchedFiles.length === 0) {
159
+ throw new Error(`No ${options?.type || "resource"} found with id: ${id}`);
160
+ }
161
+ await Promise.all(matchedFiles.map((file) => import_promises2.default.rm(file)));
162
+ };
163
+ var addFileToResource = async (catalogDir, id, file, version) => {
164
+ const pathToResource = await findFileById(catalogDir, id, version);
165
+ if (!pathToResource) throw new Error("Cannot find directory to write file to");
166
+ await import_promises2.default.writeFile((0, import_path.join)((0, import_path.dirname)(pathToResource), file.fileName), file.content);
167
+ };
168
+
169
+ // src/events.ts
170
+ var getEvent = (directory) => async (id, version) => getResource(directory, id, version, { type: "event" });
171
+ var writeEvent = (directory) => async (event, options = { path: "" }) => writeResource(directory, { ...event }, { ...options, type: "event" });
172
+ var rmEvent = (directory) => async (path) => {
173
+ await import_promises3.default.rm((0, import_node_path2.join)(directory, path), { recursive: true });
165
174
  };
175
+ var rmEventById = (directory) => async (id, version) => rmResourceById(directory, id, version, { type: "event" });
176
+ var versionEvent = (directory) => async (id) => versionResource(directory, id);
177
+ var addFileToEvent = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
166
178
  var addSchemaToEvent = (directory) => async (id, schema, version) => {
167
179
  await addFileToEvent(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);
168
180
  };
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/events.ts","../src/internal/utils.ts"],"sourcesContent":["import matter from 'gray-matter';\nimport fs from 'node:fs/promises';\nimport { join } from 'node:path';\nimport { dirname } from 'node:path';\nimport { copyDir, findFileById, getFiles, searchFilesForId, versionExists } from './internal/utils';\nimport type { Event } from './types';\n\n/**\n * Returns an event from EventCatalog.\n *\n * You can optionally specify a version to get a specific version of the event\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getEvent } = utils('/path/to/eventcatalog');\n *\n * // Gets the latest version of the event\n * cont event = await getEvent('InventoryAdjusted');\n *\n * // Gets a version of the event\n * cont event = await getEvent('InventoryAdjusted', '0.0.1');\n * ```\n */\nexport const getEvent =\n (directory: string) =>\n async (id: string, version?: string): Promise<Event> => {\n const file = await findFileById(directory, id, version);\n\n if (!file) throw new Error(`No event found for the given id: ${id}` + (version ? ` and version ${version}` : ''));\n\n const { data, content } = matter.read(file);\n\n return {\n ...data,\n markdown: content.trim(),\n } as Event;\n };\n\n/**\n * Write an event to EventCatalog.\n *\n * You can optionally overide the path of the event.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { writeEvent } = utils('/path/to/eventcatalog');\n *\n * // Write an event to the catalog\n * // Event would be written to events/InventoryAdjusted\n * await writeEvent({\n * id: 'InventoryAdjusted',\n * name: 'Inventory Adjusted',\n * version: '0.0.1',\n * summary: 'This is a summary',\n * markdown: '# Hello world',\n * });\n *\n * // Write an event to the catalog but override the path\n * // Event would be written to events/Inventory/InventoryAdjusted\n * await writeEvent({\n * id: 'InventoryAdjusted',\n * name: 'Inventory Adjusted',\n * version: '0.0.1',\n * summary: 'This is a summary',\n * markdown: '# Hello world',\n * }, { path: \"/Inventory/InventoryAdjusted\"});\n * ```\n */\nexport const writeEvent =\n (directory: string) =>\n async (event: Event, options: { path: string } = { path: '' }) => {\n // Get the path\n const path = options.path || `/${event.id}`;\n const exists = await versionExists(directory, event.id, event.version);\n\n if (exists) {\n throw new Error(`Failed to write event as the version ${event.version} already exists`);\n }\n\n const { markdown, ...frontmatter } = event;\n const document = matter.stringify(markdown.trim(), frontmatter);\n await fs.mkdir(join(directory, path), { recursive: true });\n await fs.writeFile(join(directory, path, 'index.md'), document);\n };\n\n/**\n * Delete an event at it's given path.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { rmEvent } = utils('/path/to/eventcatalog');\n *\n * // removes an event at the given path (events dir is appended to the given path)\n * // Removes the event at events/InventoryAdjusted\n * await rmEvent('/InventoryAdjusted');\n * ```\n */\nexport const rmEvent = (directory: string) => async (path: string) => {\n await fs.rm(join(directory, path), { recursive: true });\n};\n\n/**\n * Delete an event by it's id.\n *\n * Optionally specify a version to delete a specific version of the event.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { rmEventById } = utils('/path/to/eventcatalog');\n *\n * // deletes the latest InventoryAdjusted event\n * await rmEventById('InventoryAdjusted');\n *\n * // deletes a specific version of the InventoryAdjusted event\n * await rmEventById('InventoryAdjusted', '0.0.1');\n * ```\n */\nexport const rmEventById = (directory: string) => async (id: string, version?: string) => {\n // Find all the events in the directory\n const files = await getFiles(`${directory}/**/index.md`);\n\n const matchedFiles = await searchFilesForId(files, id, version);\n\n if (matchedFiles.length === 0) {\n throw new Error(`No event found with id: ${id}`);\n }\n\n await Promise.all(matchedFiles.map((file) => fs.rm(file)));\n};\n\n/**\n * Version an event by it's id.\n *\n * Takes the latest event and moves it to a versioned directory.\n * All files with this event are also versioned (e.g /events/InventoryAdjusted/schema.json)\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { versionEvent } = utils('/path/to/eventcatalog');\n *\n * // moves the latest InventoryAdjusted event to a versioned directory\n * // the version within that event is used as the version number.\n * await versionEvent('InventoryAdjusted');\n *\n * ```\n */\nexport const versionEvent = (directory: string) => async (id: string) => {\n // Find all the events in the directory\n const files = await getFiles(`${directory}/**/index.md`);\n const matchedFiles = await searchFilesForId(files, id);\n\n if (matchedFiles.length === 0) {\n throw new Error(`No event found with id: ${id}`);\n }\n\n // Event that is in the route of the project\n const file = matchedFiles[0];\n const eventDirectory = dirname(file);\n const { data: { version = '0.0.1' } = {} } = matter.read(file);\n const targetDirectory = join(eventDirectory, 'versioned', version);\n\n await fs.mkdir(targetDirectory, { recursive: true });\n\n // Copy the event to the versioned directory\n await copyDir(directory, eventDirectory, targetDirectory, (src) => {\n return !src.includes('versioned');\n });\n\n // Remove all the files in the root of the resource as they have now been versioned\n await fs.readdir(eventDirectory).then(async (resourceFiles) => {\n await Promise.all(\n resourceFiles.map(async (file) => {\n if (file !== 'versioned') {\n await fs.rm(join(eventDirectory, file), { recursive: true });\n }\n })\n );\n });\n};\n\n/**\n * Add a file to an event by it's id.\n *\n * Optionally specify a version to add a file to a specific version of the event.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { addFileToEvent } = utils('/path/to/eventcatalog');\n *\n * // adds a file to the latest InventoryAdjusted event\n * await addFileToEvent('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' });\n *\n * // adds a file to a specific version of the InventoryAdjusted event\n * await addFileToEvent('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');\n *\n * ```\n */\nexport const addFileToEvent =\n (directory: string) => async (id: string, file: { content: string; fileName: string }, version?: string) => {\n const pathToEvent = await findFileById(directory, id, version);\n if (!pathToEvent) throw new Error('Cannot find directory to write file to');\n const contentDirectory = dirname(pathToEvent);\n await fs.writeFile(join(contentDirectory, file.fileName), file.content);\n };\n\n/**\n * Add a schema to an event by it's id.\n *\n * Optionally specify a version to add a schame to a specific version of the event.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { addSchemaToEvent } = utils('/path/to/eventcatalog');\n *\n * // JSON schema example\n * const schema = {\n * \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n * \"type\": \"object\",\n * \"properties\": {\n * \"name\": {\n * \"type\": \"string\"\n * },\n * \"age\": {\n * \"type\": \"number\"\n * }\n * },\n * \"required\": [\"name\", \"age\"]\n * };\n *\n * // adds a schema to the latest InventoryAdjusted event\n * await addSchemaToEvent('InventoryAdjusted', { schema, fileName: 'schema.json' });\n *\n * // adds a file to a specific version of the InventoryAdjusted event\n * await addSchemaToEvent('InventoryAdjusted', { schema, fileName: 'schema.json' }, '0.0.1');\n *\n * ```\n */\nexport const addSchemaToEvent =\n (directory: string) => async (id: string, schema: { schema: string; fileName: string }, version?: string) => {\n await addFileToEvent(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);\n };\n","import { glob } from 'glob';\nimport fs from 'node:fs/promises';\nimport { copy, CopyFilterAsync, CopyFilterSync } from 'fs-extra';\nimport { join } from 'node:path';\n\n/**\n * Returns true if a given version of a resource id exists in the catalog\n */\nexport const versionExists = async (catalogDir: string, id: string, version: string) => {\n const files = await getFiles(`${catalogDir}/**/index.md`);\n const matchedFiles = (await searchFilesForId(files, id, version)) || [];\n return matchedFiles.length > 0;\n};\n\nexport const findFileById = async (catalogDir: string, id: string, version?: string): Promise<string | undefined> => {\n const files = await getFiles(`${catalogDir}/**/index.md`);\n const matchedFiles = (await searchFilesForId(files, id)) || [];\n\n // Return the latest one\n if (!version) {\n return matchedFiles.find((path) => !path.includes('versioned'));\n }\n\n // Find the versioned event\n return matchedFiles.find((path) => path.includes(`versioned/${version}`));\n};\n\nexport const getFiles = async (pattern: string) => {\n try {\n const files = await glob(pattern, { ignore: 'node_modules/**' });\n return files;\n } catch (error) {\n throw new Error(`Error finding files: ${error}`);\n }\n};\n\nexport const searchFilesForId = async (files: string[], id: string, version?: string) => {\n const idRegex = new RegExp(`^id:\\\\s*['\"]?${id}['\"]?\\\\s*$`, 'm');\n const versionRegex = new RegExp(`^version:\\\\s*['\"]?${version}['\"]?\\\\s*$`, 'm');\n\n const matches = await Promise.all(\n files.map(async (file) => {\n const content = await fs.readFile(file, 'utf-8');\n const hasIdMatch = content.match(idRegex);\n\n // Check version if provided\n if (version && !content.match(versionRegex)) {\n return undefined;\n }\n\n if (hasIdMatch) {\n return file;\n }\n })\n );\n\n return matches.filter(Boolean).filter((file) => file !== undefined);\n};\n\n/**\n * Function to copy a directory from source to target, uses a tmp directory\n * @param catalogDir\n * @param source\n * @param target\n * @param filter\n */\nexport const copyDir = async (catalogDir: string, source: string, target: string, filter?: CopyFilterAsync | CopyFilterSync) => {\n const tmpDirectory = join(catalogDir, 'tmp');\n await fs.mkdir(tmpDirectory, { recursive: true });\n\n // Copy everything over\n await copy(source, tmpDirectory, {\n overwrite: true,\n filter,\n });\n\n await copy(tmpDirectory, target, {\n overwrite: true,\n filter,\n });\n\n // Remove the tmp directory\n await fs.rm(tmpDirectory, { recursive: true });\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,yBAAmB;AACnB,IAAAA,mBAAe;AACf,IAAAC,oBAAqB;AACrB,IAAAA,oBAAwB;;;ACHxB,kBAAqB;AACrB,sBAAe;AACf,sBAAsD;AACtD,uBAAqB;AAKd,IAAM,gBAAgB,OAAO,YAAoB,IAAY,YAAoB;AACtF,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAgB,MAAM,iBAAiB,OAAO,IAAI,OAAO,KAAM,CAAC;AACtE,SAAO,aAAa,SAAS;AAC/B;AAEO,IAAM,eAAe,OAAO,YAAoB,IAAY,YAAkD;AACnH,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAgB,MAAM,iBAAiB,OAAO,EAAE,KAAM,CAAC;AAG7D,MAAI,CAAC,SAAS;AACZ,WAAO,aAAa,KAAK,CAAC,SAAS,CAAC,KAAK,SAAS,WAAW,CAAC;AAAA,EAChE;AAGA,SAAO,aAAa,KAAK,CAAC,SAAS,KAAK,SAAS,aAAa,OAAO,EAAE,CAAC;AAC1E;AAEO,IAAM,WAAW,OAAO,YAAoB;AACjD,MAAI;AACF,UAAM,QAAQ,UAAM,kBAAK,SAAS,EAAE,QAAQ,kBAAkB,CAAC;AAC/D,WAAO;AAAA,EACT,SAAS,OAAO;AACd,UAAM,IAAI,MAAM,wBAAwB,KAAK,EAAE;AAAA,EACjD;AACF;AAEO,IAAM,mBAAmB,OAAO,OAAiB,IAAY,YAAqB;AACvF,QAAM,UAAU,IAAI,OAAO,gBAAgB,EAAE,cAAc,GAAG;AAC9D,QAAM,eAAe,IAAI,OAAO,qBAAqB,OAAO,cAAc,GAAG;AAE7E,QAAM,UAAU,MAAM,QAAQ;AAAA,IAC5B,MAAM,IAAI,OAAO,SAAS;AACxB,YAAM,UAAU,MAAM,gBAAAC,QAAG,SAAS,MAAM,OAAO;AAC/C,YAAM,aAAa,QAAQ,MAAM,OAAO;AAGxC,UAAI,WAAW,CAAC,QAAQ,MAAM,YAAY,GAAG;AAC3C,eAAO;AAAA,MACT;AAEA,UAAI,YAAY;AACd,eAAO;AAAA,MACT;AAAA,IACF,CAAC;AAAA,EACH;AAEA,SAAO,QAAQ,OAAO,OAAO,EAAE,OAAO,CAAC,SAAS,SAAS,MAAS;AACpE;AASO,IAAM,UAAU,OAAO,YAAoB,QAAgB,QAAgB,WAA8C;AAC9H,QAAM,mBAAe,uBAAK,YAAY,KAAK;AAC3C,QAAM,gBAAAA,QAAG,MAAM,cAAc,EAAE,WAAW,KAAK,CAAC;AAGhD,YAAM,sBAAK,QAAQ,cAAc;AAAA,IAC/B,WAAW;AAAA,IACX;AAAA,EACF,CAAC;AAED,YAAM,sBAAK,cAAc,QAAQ;AAAA,IAC/B,WAAW;AAAA,IACX;AAAA,EACF,CAAC;AAGD,QAAM,gBAAAA,QAAG,GAAG,cAAc,EAAE,WAAW,KAAK,CAAC;AAC/C;;;AD1DO,IAAM,WACX,CAAC,cACD,OAAO,IAAY,YAAqC;AACtD,QAAM,OAAO,MAAM,aAAa,WAAW,IAAI,OAAO;AAEtD,MAAI,CAAC,KAAM,OAAM,IAAI,MAAM,oCAAoC,EAAE,MAAM,UAAU,gBAAgB,OAAO,KAAK,GAAG;AAEhH,QAAM,EAAE,MAAM,QAAQ,IAAI,mBAAAC,QAAO,KAAK,IAAI;AAE1C,SAAO;AAAA,IACL,GAAG;AAAA,IACH,UAAU,QAAQ,KAAK;AAAA,EACzB;AACF;AAkCK,IAAM,aACX,CAAC,cACD,OAAO,OAAc,UAA4B,EAAE,MAAM,GAAG,MAAM;AAEhE,QAAM,OAAO,QAAQ,QAAQ,IAAI,MAAM,EAAE;AACzC,QAAM,SAAS,MAAM,cAAc,WAAW,MAAM,IAAI,MAAM,OAAO;AAErE,MAAI,QAAQ;AACV,UAAM,IAAI,MAAM,wCAAwC,MAAM,OAAO,iBAAiB;AAAA,EACxF;AAEA,QAAM,EAAE,UAAU,GAAG,YAAY,IAAI;AACrC,QAAM,WAAW,mBAAAA,QAAO,UAAU,SAAS,KAAK,GAAG,WAAW;AAC9D,QAAM,iBAAAC,QAAG,UAAM,wBAAK,WAAW,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AACzD,QAAM,iBAAAA,QAAG,cAAU,wBAAK,WAAW,MAAM,UAAU,GAAG,QAAQ;AAChE;AAgBK,IAAM,UAAU,CAAC,cAAsB,OAAO,SAAiB;AACpE,QAAM,iBAAAA,QAAG,OAAG,wBAAK,WAAW,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AACxD;AAoBO,IAAM,cAAc,CAAC,cAAsB,OAAO,IAAY,YAAqB;AAExF,QAAM,QAAQ,MAAM,SAAS,GAAG,SAAS,cAAc;AAEvD,QAAM,eAAe,MAAM,iBAAiB,OAAO,IAAI,OAAO;AAE9D,MAAI,aAAa,WAAW,GAAG;AAC7B,UAAM,IAAI,MAAM,2BAA2B,EAAE,EAAE;AAAA,EACjD;AAEA,QAAM,QAAQ,IAAI,aAAa,IAAI,CAAC,SAAS,iBAAAA,QAAG,GAAG,IAAI,CAAC,CAAC;AAC3D;AAoBO,IAAM,eAAe,CAAC,cAAsB,OAAO,OAAe;AAEvE,QAAM,QAAQ,MAAM,SAAS,GAAG,SAAS,cAAc;AACvD,QAAM,eAAe,MAAM,iBAAiB,OAAO,EAAE;AAErD,MAAI,aAAa,WAAW,GAAG;AAC7B,UAAM,IAAI,MAAM,2BAA2B,EAAE,EAAE;AAAA,EACjD;AAGA,QAAM,OAAO,aAAa,CAAC;AAC3B,QAAM,qBAAiB,2BAAQ,IAAI;AACnC,QAAM,EAAE,MAAM,EAAE,UAAU,QAAQ,IAAI,CAAC,EAAE,IAAI,mBAAAD,QAAO,KAAK,IAAI;AAC7D,QAAM,sBAAkB,wBAAK,gBAAgB,aAAa,OAAO;AAEjE,QAAM,iBAAAC,QAAG,MAAM,iBAAiB,EAAE,WAAW,KAAK,CAAC;AAGnD,QAAM,QAAQ,WAAW,gBAAgB,iBAAiB,CAAC,QAAQ;AACjE,WAAO,CAAC,IAAI,SAAS,WAAW;AAAA,EAClC,CAAC;AAGD,QAAM,iBAAAA,QAAG,QAAQ,cAAc,EAAE,KAAK,OAAO,kBAAkB;AAC7D,UAAM,QAAQ;AAAA,MACZ,cAAc,IAAI,OAAOC,UAAS;AAChC,YAAIA,UAAS,aAAa;AACxB,gBAAM,iBAAAD,QAAG,OAAG,wBAAK,gBAAgBC,KAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AAAA,QAC7D;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF,CAAC;AACH;AAqBO,IAAM,iBACX,CAAC,cAAsB,OAAO,IAAY,MAA6C,YAAqB;AAC1G,QAAM,cAAc,MAAM,aAAa,WAAW,IAAI,OAAO;AAC7D,MAAI,CAAC,YAAa,OAAM,IAAI,MAAM,wCAAwC;AAC1E,QAAM,uBAAmB,2BAAQ,WAAW;AAC5C,QAAM,iBAAAD,QAAG,cAAU,wBAAK,kBAAkB,KAAK,QAAQ,GAAG,KAAK,OAAO;AACxE;AAoCK,IAAM,mBACX,CAAC,cAAsB,OAAO,IAAY,QAA8C,YAAqB;AAC3G,QAAM,eAAe,SAAS,EAAE,IAAI,EAAE,SAAS,OAAO,QAAQ,UAAU,OAAO,SAAS,GAAG,OAAO;AACpG;","names":["import_promises","import_node_path","fs","matter","fs","file"]}
1
+ {"version":3,"sources":["../src/events.ts","../src/internal/resources.ts","../src/internal/utils.ts"],"sourcesContent":["import matter from 'gray-matter';\nimport fs from 'node:fs/promises';\nimport { join } from 'node:path';\nimport { dirname } from 'node:path';\nimport { copyDir, findFileById, getFiles, searchFilesForId, versionExists } from './internal/utils';\nimport type { Event } from './types';\nimport { addFileToResource, getResource, rmResourceById, versionResource, writeResource } from './internal/resources';\n\n/**\n * Returns an event from EventCatalog.\n *\n * You can optionally specify a version to get a specific version of the event\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getEvent } = utils('/path/to/eventcatalog');\n *\n * // Gets the latest version of the event\n * const event = await getEvent('InventoryAdjusted');\n *\n * // Gets a version of the event\n * const event = await getEvent('InventoryAdjusted', '0.0.1');\n * ```\n */\nexport const getEvent =\n (directory: string) =>\n async (id: string, version?: string): Promise<Event> =>\n getResource(directory, id, version, { type: 'event' }) as Promise<Event>;\n\n/**\n * Write an event to EventCatalog.\n *\n * You can optionally overide the path of the event.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { writeEvent } = utils('/path/to/eventcatalog');\n *\n * // Write an event to the catalog\n * // Event would be written to events/InventoryAdjusted\n * await writeEvent({\n * id: 'InventoryAdjusted',\n * name: 'Inventory Adjusted',\n * version: '0.0.1',\n * summary: 'This is a summary',\n * markdown: '# Hello world',\n * });\n *\n * // Write an event to the catalog but override the path\n * // Event would be written to events/Inventory/InventoryAdjusted\n * await writeEvent({\n * id: 'InventoryAdjusted',\n * name: 'Inventory Adjusted',\n * version: '0.0.1',\n * summary: 'This is a summary',\n * markdown: '# Hello world',\n * }, { path: \"/Inventory/InventoryAdjusted\"});\n * ```\n */\nexport const writeEvent =\n (directory: string) =>\n async (event: Event, options: { path: string } = { path: '' }) =>\n writeResource(directory, { ...event }, { ...options, type: 'event' });\n\n/**\n * Delete an event at it's given path.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { rmEvent } = utils('/path/to/eventcatalog');\n *\n * // removes an event at the given path (events dir is appended to the given path)\n * // Removes the event at events/InventoryAdjusted\n * await rmEvent('/InventoryAdjusted');\n * ```\n */\nexport const rmEvent = (directory: string) => async (path: string) => {\n await fs.rm(join(directory, path), { recursive: true });\n};\n\n/**\n * Delete an event by it's id.\n *\n * Optionally specify a version to delete a specific version of the event.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { rmEventById } = utils('/path/to/eventcatalog');\n *\n * // deletes the latest InventoryAdjusted event\n * await rmEventById('InventoryAdjusted');\n *\n * // deletes a specific version of the InventoryAdjusted event\n * await rmEventById('InventoryAdjusted', '0.0.1');\n * ```\n */\nexport const rmEventById = (directory: string) => async (id: string, version?: string) =>\n rmResourceById(directory, id, version, { type: 'event' });\n\n/**\n * Version an event by it's id.\n *\n * Takes the latest event and moves it to a versioned directory.\n * All files with this event are also versioned (e.g /events/InventoryAdjusted/schema.json)\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { versionEvent } = utils('/path/to/eventcatalog');\n *\n * // moves the latest InventoryAdjusted event to a versioned directory\n * // the version within that event is used as the version number.\n * await versionEvent('InventoryAdjusted');\n *\n * ```\n */\nexport const versionEvent = (directory: string) => async (id: string) => versionResource(directory, id);\n\n/**\n * Add a file to an event by it's id.\n *\n * Optionally specify a version to add a file to a specific version of the event.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { addFileToEvent } = utils('/path/to/eventcatalog');\n *\n * // adds a file to the latest InventoryAdjusted event\n * await addFileToEvent('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' });\n *\n * // adds a file to a specific version of the InventoryAdjusted event\n * await addFileToEvent('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');\n *\n * ```\n */\nexport const addFileToEvent =\n (directory: string) => async (id: string, file: { content: string; fileName: string }, version?: string) =>\n addFileToResource(directory, id, file, version);\n\n/**\n * Add a schema to an event by it's id.\n *\n * Optionally specify a version to add a schema to a specific version of the event.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { addSchemaToEvent } = utils('/path/to/eventcatalog');\n *\n * // JSON schema example\n * const schema = {\n * \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n * \"type\": \"object\",\n * \"properties\": {\n * \"name\": {\n * \"type\": \"string\"\n * },\n * \"age\": {\n * \"type\": \"number\"\n * }\n * },\n * \"required\": [\"name\", \"age\"]\n * };\n *\n * // adds a schema to the latest InventoryAdjusted event\n * await addSchemaToEvent('InventoryAdjusted', { schema, fileName: 'schema.json' });\n *\n * // adds a file to a specific version of the InventoryAdjusted event\n * await addSchemaToEvent('InventoryAdjusted', { schema, fileName: 'schema.json' }, '0.0.1');\n *\n * ```\n */\nexport const addSchemaToEvent =\n (directory: string) => async (id: string, schema: { schema: string; fileName: string }, version?: string) => {\n await addFileToEvent(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);\n };\n","import { dirname, join } from 'path';\nimport { copyDir, findFileById, getFiles, searchFilesForId, versionExists } from './utils';\nimport matter from 'gray-matter';\nimport fs from 'node:fs/promises';\nimport { Message, Service } from '../types';\n\ntype Resource = Service | Message;\n\nexport const versionResource = async (catalogDir: string, id: string) => {\n // Find all the events in the directory\n const files = await getFiles(`${catalogDir}/**/index.md`);\n const matchedFiles = await searchFilesForId(files, id);\n\n if (matchedFiles.length === 0) {\n throw new Error(`No event found with id: ${id}`);\n }\n\n // Event that is in the route of the project\n const file = matchedFiles[0];\n const sourceDirectory = dirname(file);\n const { data: { version = '0.0.1' } = {} } = matter.read(file);\n const targetDirectory = join(sourceDirectory, 'versioned', version);\n\n await fs.mkdir(targetDirectory, { recursive: true });\n\n // Copy the event to the versioned directory\n await copyDir(catalogDir, sourceDirectory, targetDirectory, (src) => {\n return !src.includes('versioned');\n });\n\n // Remove all the files in the root of the resource as they have now been versioned\n await fs.readdir(sourceDirectory).then(async (resourceFiles) => {\n await Promise.all(\n resourceFiles.map(async (file) => {\n if (file !== 'versioned') {\n await fs.rm(join(sourceDirectory, file), { recursive: true });\n }\n })\n );\n });\n};\n\nexport const writeResource = async (\n catalogDir: string,\n resource: Resource,\n options: { path: string; type: string } = { path: '', type: '' }\n) => {\n // Get the path\n const path = options.path || `/${resource.id}`;\n const exists = await versionExists(catalogDir, resource.id, resource.version);\n\n if (exists) {\n throw new Error(`Failed to write ${options.type} as the version ${resource.version} already exists`);\n }\n\n const { markdown, ...frontmatter } = resource;\n const document = matter.stringify(markdown.trim(), frontmatter);\n await fs.mkdir(join(catalogDir, path), { recursive: true });\n await fs.writeFile(join(catalogDir, path, 'index.md'), document);\n};\n\nexport const getResource = async (\n catalogDir: string,\n id: string,\n version?: string,\n options?: { type: string }\n): Promise<Resource> => {\n const file = await findFileById(catalogDir, id, version);\n\n if (!file)\n throw new Error(\n `No ${options?.type || 'resource'} found for the given id: ${id}` + (version ? ` and version ${version}` : '')\n );\n\n const { data, content } = matter.read(file);\n\n return {\n ...data,\n markdown: content.trim(),\n } as Resource;\n};\n\nexport const rmResourceById = async (catalogDir: string, id: string, version?: string, options?: { type: string }) => {\n const files = await getFiles(`${catalogDir}/**/index.md`);\n const matchedFiles = await searchFilesForId(files, id, version);\n\n if (matchedFiles.length === 0) {\n throw new Error(`No ${options?.type || 'resource'} found with id: ${id}`);\n }\n\n await Promise.all(matchedFiles.map((file) => fs.rm(file)));\n};\n\nexport const addFileToResource = async (\n catalogDir: string,\n id: string,\n file: { content: string; fileName: string },\n version?: string\n) => {\n const pathToResource = await findFileById(catalogDir, id, version);\n\n if (!pathToResource) throw new Error('Cannot find directory to write file to');\n\n await fs.writeFile(join(dirname(pathToResource), file.fileName), file.content);\n};\n","import { glob } from 'glob';\nimport fs from 'node:fs/promises';\nimport { copy, CopyFilterAsync, CopyFilterSync } from 'fs-extra';\nimport { join } from 'node:path';\n\n/**\n * Returns true if a given version of a resource id exists in the catalog\n */\nexport const versionExists = async (catalogDir: string, id: string, version: string) => {\n const files = await getFiles(`${catalogDir}/**/index.md`);\n const matchedFiles = (await searchFilesForId(files, id, version)) || [];\n return matchedFiles.length > 0;\n};\n\nexport const findFileById = async (catalogDir: string, id: string, version?: string): Promise<string | undefined> => {\n const files = await getFiles(`${catalogDir}/**/index.md`);\n const matchedFiles = (await searchFilesForId(files, id)) || [];\n\n // Return the latest one\n if (!version) {\n return matchedFiles.find((path) => !path.includes('versioned'));\n }\n\n // Find the versioned event\n return matchedFiles.find((path) => path.includes(`versioned/${version}`));\n};\n\nexport const getFiles = async (pattern: string) => {\n try {\n const files = await glob(pattern, { ignore: 'node_modules/**' });\n return files;\n } catch (error) {\n throw new Error(`Error finding files: ${error}`);\n }\n};\n\nexport const searchFilesForId = async (files: string[], id: string, version?: string) => {\n const idRegex = new RegExp(`^id:\\\\s*['\"]?${id}['\"]?\\\\s*$`, 'm');\n const versionRegex = new RegExp(`^version:\\\\s*['\"]?${version}['\"]?\\\\s*$`, 'm');\n\n const matches = await Promise.all(\n files.map(async (file) => {\n const content = await fs.readFile(file, 'utf-8');\n const hasIdMatch = content.match(idRegex);\n\n // Check version if provided\n if (version && !content.match(versionRegex)) {\n return undefined;\n }\n\n if (hasIdMatch) {\n return file;\n }\n })\n );\n\n return matches.filter(Boolean).filter((file) => file !== undefined);\n};\n\n/**\n * Function to copy a directory from source to target, uses a tmp directory\n * @param catalogDir\n * @param source\n * @param target\n * @param filter\n */\nexport const copyDir = async (catalogDir: string, source: string, target: string, filter?: CopyFilterAsync | CopyFilterSync) => {\n const tmpDirectory = join(catalogDir, 'tmp');\n await fs.mkdir(tmpDirectory, { recursive: true });\n\n // Copy everything over\n await copy(source, tmpDirectory, {\n overwrite: true,\n filter,\n });\n\n await copy(tmpDirectory, target, {\n overwrite: true,\n filter,\n });\n\n // Remove the tmp directory\n await fs.rm(tmpDirectory, { recursive: true });\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,IAAAA,mBAAe;AACf,IAAAC,oBAAqB;;;ACFrB,kBAA8B;;;ACA9B,kBAAqB;AACrB,sBAAe;AACf,sBAAsD;AACtD,uBAAqB;AAKd,IAAM,gBAAgB,OAAO,YAAoB,IAAY,YAAoB;AACtF,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAgB,MAAM,iBAAiB,OAAO,IAAI,OAAO,KAAM,CAAC;AACtE,SAAO,aAAa,SAAS;AAC/B;AAEO,IAAM,eAAe,OAAO,YAAoB,IAAY,YAAkD;AACnH,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAgB,MAAM,iBAAiB,OAAO,EAAE,KAAM,CAAC;AAG7D,MAAI,CAAC,SAAS;AACZ,WAAO,aAAa,KAAK,CAAC,SAAS,CAAC,KAAK,SAAS,WAAW,CAAC;AAAA,EAChE;AAGA,SAAO,aAAa,KAAK,CAAC,SAAS,KAAK,SAAS,aAAa,OAAO,EAAE,CAAC;AAC1E;AAEO,IAAM,WAAW,OAAO,YAAoB;AACjD,MAAI;AACF,UAAM,QAAQ,UAAM,kBAAK,SAAS,EAAE,QAAQ,kBAAkB,CAAC;AAC/D,WAAO;AAAA,EACT,SAAS,OAAO;AACd,UAAM,IAAI,MAAM,wBAAwB,KAAK,EAAE;AAAA,EACjD;AACF;AAEO,IAAM,mBAAmB,OAAO,OAAiB,IAAY,YAAqB;AACvF,QAAM,UAAU,IAAI,OAAO,gBAAgB,EAAE,cAAc,GAAG;AAC9D,QAAM,eAAe,IAAI,OAAO,qBAAqB,OAAO,cAAc,GAAG;AAE7E,QAAM,UAAU,MAAM,QAAQ;AAAA,IAC5B,MAAM,IAAI,OAAO,SAAS;AACxB,YAAM,UAAU,MAAM,gBAAAC,QAAG,SAAS,MAAM,OAAO;AAC/C,YAAM,aAAa,QAAQ,MAAM,OAAO;AAGxC,UAAI,WAAW,CAAC,QAAQ,MAAM,YAAY,GAAG;AAC3C,eAAO;AAAA,MACT;AAEA,UAAI,YAAY;AACd,eAAO;AAAA,MACT;AAAA,IACF,CAAC;AAAA,EACH;AAEA,SAAO,QAAQ,OAAO,OAAO,EAAE,OAAO,CAAC,SAAS,SAAS,MAAS;AACpE;AASO,IAAM,UAAU,OAAO,YAAoB,QAAgB,QAAgB,WAA8C;AAC9H,QAAM,mBAAe,uBAAK,YAAY,KAAK;AAC3C,QAAM,gBAAAA,QAAG,MAAM,cAAc,EAAE,WAAW,KAAK,CAAC;AAGhD,YAAM,sBAAK,QAAQ,cAAc;AAAA,IAC/B,WAAW;AAAA,IACX;AAAA,EACF,CAAC;AAED,YAAM,sBAAK,cAAc,QAAQ;AAAA,IAC/B,WAAW;AAAA,IACX;AAAA,EACF,CAAC;AAGD,QAAM,gBAAAA,QAAG,GAAG,cAAc,EAAE,WAAW,KAAK,CAAC;AAC/C;;;ADjFA,yBAAmB;AACnB,IAAAC,mBAAe;AAKR,IAAM,kBAAkB,OAAO,YAAoB,OAAe;AAEvE,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAe,MAAM,iBAAiB,OAAO,EAAE;AAErD,MAAI,aAAa,WAAW,GAAG;AAC7B,UAAM,IAAI,MAAM,2BAA2B,EAAE,EAAE;AAAA,EACjD;AAGA,QAAM,OAAO,aAAa,CAAC;AAC3B,QAAM,sBAAkB,qBAAQ,IAAI;AACpC,QAAM,EAAE,MAAM,EAAE,UAAU,QAAQ,IAAI,CAAC,EAAE,IAAI,mBAAAC,QAAO,KAAK,IAAI;AAC7D,QAAM,sBAAkB,kBAAK,iBAAiB,aAAa,OAAO;AAElE,QAAM,iBAAAC,QAAG,MAAM,iBAAiB,EAAE,WAAW,KAAK,CAAC;AAGnD,QAAM,QAAQ,YAAY,iBAAiB,iBAAiB,CAAC,QAAQ;AACnE,WAAO,CAAC,IAAI,SAAS,WAAW;AAAA,EAClC,CAAC;AAGD,QAAM,iBAAAA,QAAG,QAAQ,eAAe,EAAE,KAAK,OAAO,kBAAkB;AAC9D,UAAM,QAAQ;AAAA,MACZ,cAAc,IAAI,OAAOC,UAAS;AAChC,YAAIA,UAAS,aAAa;AACxB,gBAAM,iBAAAD,QAAG,OAAG,kBAAK,iBAAiBC,KAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AAAA,QAC9D;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF,CAAC;AACH;AAEO,IAAM,gBAAgB,OAC3B,YACA,UACA,UAA0C,EAAE,MAAM,IAAI,MAAM,GAAG,MAC5D;AAEH,QAAM,OAAO,QAAQ,QAAQ,IAAI,SAAS,EAAE;AAC5C,QAAM,SAAS,MAAM,cAAc,YAAY,SAAS,IAAI,SAAS,OAAO;AAE5E,MAAI,QAAQ;AACV,UAAM,IAAI,MAAM,mBAAmB,QAAQ,IAAI,mBAAmB,SAAS,OAAO,iBAAiB;AAAA,EACrG;AAEA,QAAM,EAAE,UAAU,GAAG,YAAY,IAAI;AACrC,QAAM,WAAW,mBAAAF,QAAO,UAAU,SAAS,KAAK,GAAG,WAAW;AAC9D,QAAM,iBAAAC,QAAG,UAAM,kBAAK,YAAY,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AAC1D,QAAM,iBAAAA,QAAG,cAAU,kBAAK,YAAY,MAAM,UAAU,GAAG,QAAQ;AACjE;AAEO,IAAM,cAAc,OACzB,YACA,IACA,SACA,YACsB;AACtB,QAAM,OAAO,MAAM,aAAa,YAAY,IAAI,OAAO;AAEvD,MAAI,CAAC;AACH,UAAM,IAAI;AAAA,MACR,MAAM,SAAS,QAAQ,UAAU,4BAA4B,EAAE,MAAM,UAAU,gBAAgB,OAAO,KAAK;AAAA,IAC7G;AAEF,QAAM,EAAE,MAAM,QAAQ,IAAI,mBAAAD,QAAO,KAAK,IAAI;AAE1C,SAAO;AAAA,IACL,GAAG;AAAA,IACH,UAAU,QAAQ,KAAK;AAAA,EACzB;AACF;AAEO,IAAM,iBAAiB,OAAO,YAAoB,IAAY,SAAkB,YAA+B;AACpH,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAe,MAAM,iBAAiB,OAAO,IAAI,OAAO;AAE9D,MAAI,aAAa,WAAW,GAAG;AAC7B,UAAM,IAAI,MAAM,MAAM,SAAS,QAAQ,UAAU,mBAAmB,EAAE,EAAE;AAAA,EAC1E;AAEA,QAAM,QAAQ,IAAI,aAAa,IAAI,CAAC,SAAS,iBAAAC,QAAG,GAAG,IAAI,CAAC,CAAC;AAC3D;AAEO,IAAM,oBAAoB,OAC/B,YACA,IACA,MACA,YACG;AACH,QAAM,iBAAiB,MAAM,aAAa,YAAY,IAAI,OAAO;AAEjE,MAAI,CAAC,eAAgB,OAAM,IAAI,MAAM,wCAAwC;AAE7E,QAAM,iBAAAA,QAAG,cAAU,sBAAK,qBAAQ,cAAc,GAAG,KAAK,QAAQ,GAAG,KAAK,OAAO;AAC/E;;;AD9EO,IAAM,WACX,CAAC,cACD,OAAO,IAAY,YACjB,YAAY,WAAW,IAAI,SAAS,EAAE,MAAM,QAAQ,CAAC;AAkClD,IAAM,aACX,CAAC,cACD,OAAO,OAAc,UAA4B,EAAE,MAAM,GAAG,MAC1D,cAAc,WAAW,EAAE,GAAG,MAAM,GAAG,EAAE,GAAG,SAAS,MAAM,QAAQ,CAAC;AAgBjE,IAAM,UAAU,CAAC,cAAsB,OAAO,SAAiB;AACpE,QAAM,iBAAAE,QAAG,OAAG,wBAAK,WAAW,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AACxD;AAoBO,IAAM,cAAc,CAAC,cAAsB,OAAO,IAAY,YACnE,eAAe,WAAW,IAAI,SAAS,EAAE,MAAM,QAAQ,CAAC;AAoBnD,IAAM,eAAe,CAAC,cAAsB,OAAO,OAAe,gBAAgB,WAAW,EAAE;AAqB/F,IAAM,iBACX,CAAC,cAAsB,OAAO,IAAY,MAA6C,YACrF,kBAAkB,WAAW,IAAI,MAAM,OAAO;AAoC3C,IAAM,mBACX,CAAC,cAAsB,OAAO,IAAY,QAA8C,YAAqB;AAC3G,QAAM,eAAe,SAAS,EAAE,IAAI,EAAE,SAAS,OAAO,QAAQ,UAAU,OAAO,SAAS,GAAG,OAAO;AACpG;","names":["import_promises","import_node_path","fs","import_promises","matter","fs","file","fs"]}
package/dist/events.mjs CHANGED
@@ -1,8 +1,9 @@
1
1
  // src/events.ts
2
- import matter from "gray-matter";
3
- import fs2 from "fs/promises";
4
- import { join as join2 } from "path";
5
- import { dirname } from "path";
2
+ import fs3 from "fs/promises";
3
+ import { join as join3 } from "path";
4
+
5
+ // src/internal/resources.ts
6
+ import { dirname, join as join2 } from "path";
6
7
 
7
8
  // src/internal/utils.ts
8
9
  import { glob } from "glob";
@@ -61,68 +62,79 @@ var copyDir = async (catalogDir, source, target, filter) => {
61
62
  await fs.rm(tmpDirectory, { recursive: true });
62
63
  };
63
64
 
64
- // src/events.ts
65
- var getEvent = (directory) => async (id, version) => {
66
- const file = await findFileById(directory, id, version);
67
- if (!file) throw new Error(`No event found for the given id: ${id}` + (version ? ` and version ${version}` : ""));
68
- const { data, content } = matter.read(file);
69
- return {
70
- ...data,
71
- markdown: content.trim()
72
- };
73
- };
74
- var writeEvent = (directory) => async (event, options = { path: "" }) => {
75
- const path = options.path || `/${event.id}`;
76
- const exists = await versionExists(directory, event.id, event.version);
77
- if (exists) {
78
- throw new Error(`Failed to write event as the version ${event.version} already exists`);
79
- }
80
- const { markdown, ...frontmatter } = event;
81
- const document = matter.stringify(markdown.trim(), frontmatter);
82
- await fs2.mkdir(join2(directory, path), { recursive: true });
83
- await fs2.writeFile(join2(directory, path, "index.md"), document);
84
- };
85
- var rmEvent = (directory) => async (path) => {
86
- await fs2.rm(join2(directory, path), { recursive: true });
87
- };
88
- var rmEventById = (directory) => async (id, version) => {
89
- const files = await getFiles(`${directory}/**/index.md`);
90
- const matchedFiles = await searchFilesForId(files, id, version);
91
- if (matchedFiles.length === 0) {
92
- throw new Error(`No event found with id: ${id}`);
93
- }
94
- await Promise.all(matchedFiles.map((file) => fs2.rm(file)));
95
- };
96
- var versionEvent = (directory) => async (id) => {
97
- const files = await getFiles(`${directory}/**/index.md`);
65
+ // src/internal/resources.ts
66
+ import matter from "gray-matter";
67
+ import fs2 from "fs/promises";
68
+ var versionResource = async (catalogDir, id) => {
69
+ const files = await getFiles(`${catalogDir}/**/index.md`);
98
70
  const matchedFiles = await searchFilesForId(files, id);
99
71
  if (matchedFiles.length === 0) {
100
72
  throw new Error(`No event found with id: ${id}`);
101
73
  }
102
74
  const file = matchedFiles[0];
103
- const eventDirectory = dirname(file);
75
+ const sourceDirectory = dirname(file);
104
76
  const { data: { version = "0.0.1" } = {} } = matter.read(file);
105
- const targetDirectory = join2(eventDirectory, "versioned", version);
77
+ const targetDirectory = join2(sourceDirectory, "versioned", version);
106
78
  await fs2.mkdir(targetDirectory, { recursive: true });
107
- await copyDir(directory, eventDirectory, targetDirectory, (src) => {
79
+ await copyDir(catalogDir, sourceDirectory, targetDirectory, (src) => {
108
80
  return !src.includes("versioned");
109
81
  });
110
- await fs2.readdir(eventDirectory).then(async (resourceFiles) => {
82
+ await fs2.readdir(sourceDirectory).then(async (resourceFiles) => {
111
83
  await Promise.all(
112
84
  resourceFiles.map(async (file2) => {
113
85
  if (file2 !== "versioned") {
114
- await fs2.rm(join2(eventDirectory, file2), { recursive: true });
86
+ await fs2.rm(join2(sourceDirectory, file2), { recursive: true });
115
87
  }
116
88
  })
117
89
  );
118
90
  });
119
91
  };
120
- var addFileToEvent = (directory) => async (id, file, version) => {
121
- const pathToEvent = await findFileById(directory, id, version);
122
- if (!pathToEvent) throw new Error("Cannot find directory to write file to");
123
- const contentDirectory = dirname(pathToEvent);
124
- await fs2.writeFile(join2(contentDirectory, file.fileName), file.content);
92
+ var writeResource = async (catalogDir, resource, options = { path: "", type: "" }) => {
93
+ const path = options.path || `/${resource.id}`;
94
+ const exists = await versionExists(catalogDir, resource.id, resource.version);
95
+ if (exists) {
96
+ throw new Error(`Failed to write ${options.type} as the version ${resource.version} already exists`);
97
+ }
98
+ const { markdown, ...frontmatter } = resource;
99
+ const document = matter.stringify(markdown.trim(), frontmatter);
100
+ await fs2.mkdir(join2(catalogDir, path), { recursive: true });
101
+ await fs2.writeFile(join2(catalogDir, path, "index.md"), document);
102
+ };
103
+ var getResource = async (catalogDir, id, version, options) => {
104
+ const file = await findFileById(catalogDir, id, version);
105
+ if (!file)
106
+ throw new Error(
107
+ `No ${options?.type || "resource"} found for the given id: ${id}` + (version ? ` and version ${version}` : "")
108
+ );
109
+ const { data, content } = matter.read(file);
110
+ return {
111
+ ...data,
112
+ markdown: content.trim()
113
+ };
114
+ };
115
+ var rmResourceById = async (catalogDir, id, version, options) => {
116
+ const files = await getFiles(`${catalogDir}/**/index.md`);
117
+ const matchedFiles = await searchFilesForId(files, id, version);
118
+ if (matchedFiles.length === 0) {
119
+ throw new Error(`No ${options?.type || "resource"} found with id: ${id}`);
120
+ }
121
+ await Promise.all(matchedFiles.map((file) => fs2.rm(file)));
122
+ };
123
+ var addFileToResource = async (catalogDir, id, file, version) => {
124
+ const pathToResource = await findFileById(catalogDir, id, version);
125
+ if (!pathToResource) throw new Error("Cannot find directory to write file to");
126
+ await fs2.writeFile(join2(dirname(pathToResource), file.fileName), file.content);
127
+ };
128
+
129
+ // src/events.ts
130
+ var getEvent = (directory) => async (id, version) => getResource(directory, id, version, { type: "event" });
131
+ var writeEvent = (directory) => async (event, options = { path: "" }) => writeResource(directory, { ...event }, { ...options, type: "event" });
132
+ var rmEvent = (directory) => async (path) => {
133
+ await fs3.rm(join3(directory, path), { recursive: true });
125
134
  };
135
+ var rmEventById = (directory) => async (id, version) => rmResourceById(directory, id, version, { type: "event" });
136
+ var versionEvent = (directory) => async (id) => versionResource(directory, id);
137
+ var addFileToEvent = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
126
138
  var addSchemaToEvent = (directory) => async (id, schema, version) => {
127
139
  await addFileToEvent(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);
128
140
  };