@eventcatalog/sdk 0.0.3 → 0.0.5

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.js CHANGED
@@ -36,10 +36,11 @@ module.exports = __toCommonJS(src_exports);
36
36
  var import_node_path4 = require("path");
37
37
 
38
38
  // src/events.ts
39
- var import_gray_matter = __toESM(require("gray-matter"));
40
- var import_promises2 = __toESM(require("fs/promises"));
39
+ var import_promises3 = __toESM(require("fs/promises"));
41
40
  var import_node_path2 = require("path");
42
- var import_node_path3 = require("path");
41
+
42
+ // src/internal/resources.ts
43
+ var import_path = require("path");
43
44
 
44
45
  // src/internal/utils.ts
45
46
  var import_glob = require("glob");
@@ -98,72 +99,95 @@ var copyDir = async (catalogDir, source, target, filter) => {
98
99
  await import_promises.default.rm(tmpDirectory, { recursive: true });
99
100
  };
100
101
 
101
- // src/events.ts
102
- var getEvent = (directory) => async (id, version) => {
103
- const file = await findFileById(directory, id, version);
104
- if (!file) throw new Error(`No event found for the given id: ${id}` + (version ? ` and version ${version}` : ""));
105
- const { data, content } = import_gray_matter.default.read(file);
106
- return {
107
- ...data,
108
- markdown: content.trim()
109
- };
110
- };
111
- var writeEvent = (directory) => async (event, options = { path: "" }) => {
112
- const path = options.path || `/${event.id}`;
113
- const exists = await versionExists(directory, event.id, event.version);
114
- if (exists) {
115
- throw new Error(`Failed to write event as the version ${event.version} already exists`);
116
- }
117
- const { markdown, ...frontmatter } = event;
118
- const document = import_gray_matter.default.stringify(markdown.trim(), frontmatter);
119
- await import_promises2.default.mkdir((0, import_node_path2.join)(directory, path), { recursive: true });
120
- await import_promises2.default.writeFile((0, import_node_path2.join)(directory, path, "index.md"), document);
121
- };
122
- var rmEvent = (directory) => async (path) => {
123
- await import_promises2.default.rm((0, import_node_path2.join)(directory, path), { recursive: true });
124
- };
125
- var rmEventById = (directory) => async (id, version) => {
126
- const files = await getFiles(`${directory}/**/index.md`);
127
- const matchedFiles = await searchFilesForId(files, id, version);
128
- if (matchedFiles.length === 0) {
129
- throw new Error(`No event found with id: ${id}`);
130
- }
131
- await Promise.all(matchedFiles.map((file) => import_promises2.default.rm(file)));
132
- };
133
- var versionEvent = (directory) => async (id) => {
134
- const files = await getFiles(`${directory}/**/index.md`);
102
+ // src/internal/resources.ts
103
+ var import_gray_matter = __toESM(require("gray-matter"));
104
+ var import_promises2 = __toESM(require("fs/promises"));
105
+ var versionResource = async (catalogDir, id) => {
106
+ const files = await getFiles(`${catalogDir}/**/index.md`);
135
107
  const matchedFiles = await searchFilesForId(files, id);
136
108
  if (matchedFiles.length === 0) {
137
109
  throw new Error(`No event found with id: ${id}`);
138
110
  }
139
111
  const file = matchedFiles[0];
140
- const eventDirectory = (0, import_node_path3.dirname)(file);
112
+ const sourceDirectory = (0, import_path.dirname)(file);
141
113
  const { data: { version = "0.0.1" } = {} } = import_gray_matter.default.read(file);
142
- const targetDirectory = (0, import_node_path2.join)(eventDirectory, "versioned", version);
114
+ const targetDirectory = (0, import_path.join)(sourceDirectory, "versioned", version);
143
115
  await import_promises2.default.mkdir(targetDirectory, { recursive: true });
144
- await copyDir(directory, eventDirectory, targetDirectory, (src) => {
116
+ await copyDir(catalogDir, sourceDirectory, targetDirectory, (src) => {
145
117
  return !src.includes("versioned");
146
118
  });
147
- await import_promises2.default.readdir(eventDirectory).then(async (resourceFiles) => {
119
+ await import_promises2.default.readdir(sourceDirectory).then(async (resourceFiles) => {
148
120
  await Promise.all(
149
121
  resourceFiles.map(async (file2) => {
150
122
  if (file2 !== "versioned") {
151
- await import_promises2.default.rm((0, import_node_path2.join)(eventDirectory, file2), { recursive: true });
123
+ await import_promises2.default.rm((0, import_path.join)(sourceDirectory, file2), { recursive: true });
152
124
  }
153
125
  })
154
126
  );
155
127
  });
156
128
  };
157
- var addFileToEvent = (directory) => async (id, file, version) => {
158
- const pathToEvent = await findFileById(directory, id, version);
159
- if (!pathToEvent) throw new Error("Cannot find directory to write file to");
160
- const contentDirectory = (0, import_node_path3.dirname)(pathToEvent);
161
- await import_promises2.default.writeFile((0, import_node_path2.join)(contentDirectory, file.fileName), file.content);
129
+ var writeResource = async (catalogDir, resource, options = { path: "", type: "" }) => {
130
+ const path = options.path || `/${resource.id}`;
131
+ const exists = await versionExists(catalogDir, resource.id, resource.version);
132
+ if (exists) {
133
+ throw new Error(`Failed to write ${options.type} as the version ${resource.version} already exists`);
134
+ }
135
+ const { markdown, ...frontmatter } = resource;
136
+ const document = import_gray_matter.default.stringify(markdown.trim(), frontmatter);
137
+ await import_promises2.default.mkdir((0, import_path.join)(catalogDir, path), { recursive: true });
138
+ await import_promises2.default.writeFile((0, import_path.join)(catalogDir, path, "index.md"), document);
139
+ };
140
+ var getResource = async (catalogDir, id, version, options) => {
141
+ const file = await findFileById(catalogDir, id, version);
142
+ if (!file)
143
+ throw new Error(
144
+ `No ${options?.type || "resource"} found for the given id: ${id}` + (version ? ` and version ${version}` : "")
145
+ );
146
+ const { data, content } = import_gray_matter.default.read(file);
147
+ return {
148
+ ...data,
149
+ markdown: content.trim()
150
+ };
151
+ };
152
+ var rmResourceById = async (catalogDir, id, version, options) => {
153
+ const files = await getFiles(`${catalogDir}/**/index.md`);
154
+ const matchedFiles = await searchFilesForId(files, id, version);
155
+ if (matchedFiles.length === 0) {
156
+ throw new Error(`No ${options?.type || "resource"} found with id: ${id}`);
157
+ }
158
+ await Promise.all(matchedFiles.map((file) => import_promises2.default.rm(file)));
159
+ };
160
+ var addFileToResource = async (catalogDir, id, file, version) => {
161
+ const pathToResource = await findFileById(catalogDir, id, version);
162
+ if (!pathToResource) throw new Error("Cannot find directory to write file to");
163
+ await import_promises2.default.writeFile((0, import_path.join)((0, import_path.dirname)(pathToResource), file.fileName), file.content);
162
164
  };
165
+
166
+ // src/events.ts
167
+ var getEvent = (directory) => async (id, version) => getResource(directory, id, version, { type: "event" });
168
+ var writeEvent = (directory) => async (event, options = { path: "" }) => writeResource(directory, { ...event }, { ...options, type: "event" });
169
+ var rmEvent = (directory) => async (path) => {
170
+ await import_promises3.default.rm((0, import_node_path2.join)(directory, path), { recursive: true });
171
+ };
172
+ var rmEventById = (directory) => async (id, version) => rmResourceById(directory, id, version, { type: "event" });
173
+ var versionEvent = (directory) => async (id) => versionResource(directory, id);
174
+ var addFileToEvent = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
163
175
  var addSchemaToEvent = (directory) => async (id, schema, version) => {
164
176
  await addFileToEvent(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);
165
177
  };
166
178
 
179
+ // src/services.ts
180
+ var import_promises4 = __toESM(require("fs/promises"));
181
+ var import_node_path3 = require("path");
182
+ var getService = (directory) => async (id, version) => getResource(directory, id, version, { type: "service" });
183
+ var writeService = (directory) => async (service, options = { path: "" }) => writeResource(directory, { ...service }, { ...options, type: "service" });
184
+ var versionService = (directory) => async (id) => versionResource(directory, id);
185
+ var rmService = (directory) => async (path) => {
186
+ await import_promises4.default.rm((0, import_node_path3.join)(directory, path), { recursive: true });
187
+ };
188
+ var rmServiceById = (directory) => async (id, version) => rmResourceById(directory, id, version, { type: "service" });
189
+ var addFileToService = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
190
+
167
191
  // src/index.ts
168
192
  var src_default = (path) => {
169
193
  return {
@@ -216,7 +240,54 @@ var src_default = (path) => {
216
240
  * @param version - Optional version of the event to add the schema to
217
241
  * @returns
218
242
  */
219
- addSchemaToEvent: addSchemaToEvent((0, import_node_path4.join)(path, "events"))
243
+ addSchemaToEvent: addSchemaToEvent((0, import_node_path4.join)(path, "events")),
244
+ /**
245
+ * ================================
246
+ * SERVICES
247
+ * ================================
248
+ */
249
+ /**
250
+ * Adds a service to EventCatalog
251
+ *
252
+ * @param service - The service to write
253
+ * @param options - Optional options to write the event
254
+ *
255
+ */
256
+ writeService: writeService((0, import_node_path4.join)(path, "services")),
257
+ /**
258
+ * Returns a service from EventCatalog
259
+ * @param id - The id of the service to retrieve
260
+ * @param version - Optional id of the version to get
261
+ * @returns
262
+ */
263
+ getService: getService((0, import_node_path4.join)(path, "services")),
264
+ /**
265
+ * Moves a given service id to the version directory
266
+ * @param directory
267
+ */
268
+ versionService: versionService((0, import_node_path4.join)(path, "services")),
269
+ /**
270
+ * Remove a service from EventCatalog (modeled on the standard POSIX rm utility)
271
+ *
272
+ * @param path - The path to your service, e.g. `/InventoryService`
273
+ *
274
+ */
275
+ rmService: rmService((0, import_node_path4.join)(path, "services")),
276
+ /**
277
+ * Remove an service by an service id
278
+ *
279
+ * @param id - The id of the service you want to remove
280
+ *
281
+ */
282
+ rmServiceById: rmServiceById((0, import_node_path4.join)(path, "services")),
283
+ /**
284
+ * Adds a file to the given service
285
+ * @param id - The id of the service to add the file to
286
+ * @param file - File contents to add including the content and the file name
287
+ * @param version - Optional version of the service to add the file to
288
+ * @returns
289
+ */
290
+ addFileToService: addFileToService((0, import_node_path4.join)(path, "services"))
220
291
  };
221
292
  };
222
293
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts","../src/events.ts","../src/internal/utils.ts"],"sourcesContent":["import { join } from 'node:path';\nimport { rmEvent, rmEventById, writeEvent, versionEvent, getEvent, addFileToEvent, addSchemaToEvent } from './events';\n\n/**\n * Init the SDK for EventCatalog\n *\n * @param path - The path to the EventCatalog directory\n *\n */\nexport default (path: string) => {\n return {\n /**\n * Returns an events from EventCatalog\n * @param id - The id of the event to retrieve\n * @param version - Optional id of the version to get\n * @returns\n */\n getEvent: getEvent(join(path, 'events')),\n /**\n * Adds an event to EventCatalog\n *\n * @param event - The event to write\n * @param options - Optional options to write the event\n *\n */\n writeEvent: writeEvent(join(path, 'events')),\n /**\n * Remove an event to EventCatalog (modeled on the standard POSIX rm utility)\n *\n * @param path - The path to your event, e.g. `/Inventory/InventoryAdjusted`\n *\n */\n rmEvent: rmEvent(join(path, 'events')),\n /**\n * Remove an event by an Event id\n *\n * @param id - The id of the event you want to remove\n *\n */\n rmEventById: rmEventById(join(path, 'events')),\n /**\n * Moves a given event id to the version directory\n * @param directory\n */\n versionEvent: versionEvent(join(path, 'events')),\n /**\n * Adds a file to the given event\n * @param id - The id of the event to add the file to\n * @param file - File contents to add including the content and the file name\n * @param version - Optional version of the event to add the file to\n * @returns\n */\n addFileToEvent: addFileToEvent(join(path, 'events')),\n /**\n * Adds a schema to the given event\n * @param id - The id of the event to add the schema to\n * @param schema - Schema contents to add including the content and the file name\n * @param version - Optional version of the event to add the schema to\n * @returns\n */\n addSchemaToEvent: addSchemaToEvent(join(path, 'events')),\n };\n};\n","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 *\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 verionEvent('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,IAAAA,oBAAqB;;;ACArB,yBAAmB;AACnB,IAAAC,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;AAmBO,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;;;ADpPF,IAAO,cAAQ,CAAC,SAAiB;AAC/B,SAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOL,UAAU,aAAS,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQvC,YAAY,eAAW,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO3C,SAAS,YAAQ,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOrC,aAAa,gBAAY,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,IAK7C,cAAc,iBAAa,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQ/C,gBAAgB,mBAAe,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQnD,kBAAkB,qBAAiB,wBAAK,MAAM,QAAQ,CAAC;AAAA,EACzD;AACF;","names":["import_node_path","import_promises","import_node_path","fs","matter","fs","file"]}
1
+ {"version":3,"sources":["../src/index.ts","../src/events.ts","../src/internal/resources.ts","../src/internal/utils.ts","../src/services.ts"],"sourcesContent":["import { join } from 'node:path';\nimport { rmEvent, rmEventById, writeEvent, versionEvent, getEvent, addFileToEvent, addSchemaToEvent } from './events';\nimport { writeService, getService, versionService, rmService, rmServiceById, addFileToService } from './services';\n\n/**\n * Init the SDK for EventCatalog\n *\n * @param path - The path to the EventCatalog directory\n *\n */\nexport default (path: string) => {\n return {\n /**\n * Returns an events from EventCatalog\n * @param id - The id of the event to retrieve\n * @param version - Optional id of the version to get\n * @returns\n */\n getEvent: getEvent(join(path, 'events')),\n /**\n * Adds an event to EventCatalog\n *\n * @param event - The event to write\n * @param options - Optional options to write the event\n *\n */\n writeEvent: writeEvent(join(path, 'events')),\n /**\n * Remove an event to EventCatalog (modeled on the standard POSIX rm utility)\n *\n * @param path - The path to your event, e.g. `/Inventory/InventoryAdjusted`\n *\n */\n rmEvent: rmEvent(join(path, 'events')),\n /**\n * Remove an event by an Event id\n *\n * @param id - The id of the event you want to remove\n *\n */\n rmEventById: rmEventById(join(path, 'events')),\n /**\n * Moves a given event id to the version directory\n * @param directory\n */\n versionEvent: versionEvent(join(path, 'events')),\n /**\n * Adds a file to the given event\n * @param id - The id of the event to add the file to\n * @param file - File contents to add including the content and the file name\n * @param version - Optional version of the event to add the file to\n * @returns\n */\n addFileToEvent: addFileToEvent(join(path, 'events')),\n /**\n * Adds a schema to the given event\n * @param id - The id of the event to add the schema to\n * @param schema - Schema contents to add including the content and the file name\n * @param version - Optional version of the event to add the schema to\n * @returns\n */\n addSchemaToEvent: addSchemaToEvent(join(path, 'events')),\n\n /**\n * ================================\n * SERVICES\n * ================================\n */\n\n /**\n * Adds a service to EventCatalog\n *\n * @param service - The service to write\n * @param options - Optional options to write the event\n *\n */\n writeService: writeService(join(path, 'services')),\n /**\n * Returns a service from EventCatalog\n * @param id - The id of the service to retrieve\n * @param version - Optional id of the version to get\n * @returns\n */\n getService: getService(join(path, 'services')),\n /**\n * Moves a given service id to the version directory\n * @param directory\n */\n versionService: versionService(join(path, 'services')),\n /**\n * Remove a service from EventCatalog (modeled on the standard POSIX rm utility)\n *\n * @param path - The path to your service, e.g. `/InventoryService`\n *\n */\n rmService: rmService(join(path, 'services')),\n /**\n * Remove an service by an service id\n *\n * @param id - The id of the service you want to remove\n *\n */\n rmServiceById: rmServiceById(join(path, 'services')),\n /**\n * Adds a file to the given service\n * @param id - The id of the service to add the file to\n * @param file - File contents to add including the content and the file name\n * @param version - Optional version of the service to add the file to\n * @returns\n */\n addFileToService: addFileToService(join(path, 'services')),\n };\n};\n","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 * 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 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 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 { 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","import matter from 'gray-matter';\nimport { copyDir, findFileById, getFiles, searchFilesForId, versionExists } from './internal/utils';\nimport type { Service } from './types';\nimport fs from 'node:fs/promises';\nimport { dirname, join } from 'node:path';\nimport { addFileToResource, getResource, rmResourceById, versionResource, writeResource } from './internal/resources';\n\n/**\n * Returns a service from EventCatalog.\n *\n * You can optionally specify a version to get a specific version of the service\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getService } = utils('/path/to/eventcatalog');\n *\n * // Gets the latest version of the event\n * cont event = await getService('InventoryService');\n *\n * // Gets a version of the event\n * cont event = await getService('InventoryService', '0.0.1');\n * ```\n */\nexport const getService =\n (directory: string) =>\n async (id: string, version?: string): Promise<Service> =>\n getResource(directory, id, version, { type: 'service' }) as Promise<Service>;\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 { writeService } = utils('/path/to/eventcatalog');\n *\n * // Write a service\n * // Event would be written to services/InventoryService\n * await writeService({\n * id: 'InventoryService',\n * name: 'Inventory Service',\n * version: '0.0.1',\n * summary: 'Service that handles the inventory',\n * markdown: '# Hello world',\n * });\n *\n * // Write an event to the catalog but override the path\n * // Event would be written to services/Inventory/InventoryService\n * await writeService({\n * id: 'InventoryService',\n * name: 'Inventory Adjusted',\n * version: '0.0.1',\n * summary: 'This is a summary',\n * markdown: '# Hello world',\n * }, { path: \"/Inventory/InventoryService\"});\n * ```\n */\nexport const writeService =\n (directory: string) =>\n async (service: Service, options: { path: string } = { path: '' }) =>\n writeResource(directory, { ...service }, { ...options, type: 'service' });\n\n/**\n * Version a service by it's id.\n *\n * Takes the latest service and moves it to a versioned directory.\n * All files with this service are also versioned. (e.g /services/InventoryService/openapi.yml)\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { versionService } = utils('/path/to/eventcatalog');\n *\n * // moves the latest InventoryService service to a versioned directory\n * // the version within that service is used as the version number.\n * await versionService('InventoryService');\n *\n * ```\n */\nexport const versionService = (directory: string) => async (id: string) => versionResource(directory, id);\n\n/**\n * Delete a service at it's given path.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { rmService } = utils('/path/to/eventcatalog');\n *\n * // Removes the service at services/InventoryService\n * await rmService('/InventoryService');\n * ```\n */\nexport const rmService = (directory: string) => async (path: string) => {\n await fs.rm(join(directory, path), { recursive: true });\n};\n\n/**\n * Delete a service by it's id.\n *\n * Optionally specify a version to delete a specific version of the service.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { rmServiceById } = utils('/path/to/eventcatalog');\n *\n * // deletes the latest InventoryService event\n * await rmServiceById('InventoryService');\n *\n * // deletes a specific version of the InventoryService event\n * await rmServiceById('InventoryService', '0.0.1');\n * ```\n */\nexport const rmServiceById = (directory: string) => async (id: string, version?: string) =>\n rmResourceById(directory, id, version, { type: 'service' });\n\n/**\n * Add a file to a service by it's id.\n *\n * Optionally specify a version to add a file to a specific version of the service.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { addFileToService } = utils('/path/to/eventcatalog');\n *\n * // adds a file to the latest InventoryService event\n * await addFileToService('InventoryService', { content: 'Hello world', fileName: 'hello.txt' });\n *\n * // adds a file to a specific version of the InventoryService event\n * await addFileToService('InventoryService', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');\n *\n * ```\n */\n\nexport const addFileToService =\n (directory: string) => async (id: string, file: { content: string; fileName: string }, version?: string) =>\n addFileToResource(directory, id, file, version);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAAA,oBAAqB;;;ACCrB,IAAAC,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;;;AGxLF,IAAAC,mBAAe;AACf,IAAAC,oBAA8B;AAqBvB,IAAM,aACX,CAAC,cACD,OAAO,IAAY,YACjB,YAAY,WAAW,IAAI,SAAS,EAAE,MAAM,UAAU,CAAC;AAiCpD,IAAM,eACX,CAAC,cACD,OAAO,SAAkB,UAA4B,EAAE,MAAM,GAAG,MAC9D,cAAc,WAAW,EAAE,GAAG,QAAQ,GAAG,EAAE,GAAG,SAAS,MAAM,UAAU,CAAC;AAoBrE,IAAM,iBAAiB,CAAC,cAAsB,OAAO,OAAe,gBAAgB,WAAW,EAAE;AAejG,IAAM,YAAY,CAAC,cAAsB,OAAO,SAAiB;AACtE,QAAM,iBAAAC,QAAG,OAAG,wBAAK,WAAW,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AACxD;AAoBO,IAAM,gBAAgB,CAAC,cAAsB,OAAO,IAAY,YACrE,eAAe,WAAW,IAAI,SAAS,EAAE,MAAM,UAAU,CAAC;AAsBrD,IAAM,mBACX,CAAC,cAAsB,OAAO,IAAY,MAA6C,YACrF,kBAAkB,WAAW,IAAI,MAAM,OAAO;;;AJxIlD,IAAO,cAAQ,CAAC,SAAiB;AAC/B,SAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOL,UAAU,aAAS,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQvC,YAAY,eAAW,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO3C,SAAS,YAAQ,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOrC,aAAa,gBAAY,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,IAK7C,cAAc,iBAAa,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQ/C,gBAAgB,mBAAe,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQnD,kBAAkB,qBAAiB,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAevD,cAAc,iBAAa,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOjD,YAAY,eAAW,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,IAK7C,gBAAgB,mBAAe,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOrD,WAAW,cAAU,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO3C,eAAe,kBAAc,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQnD,kBAAkB,qBAAiB,wBAAK,MAAM,UAAU,CAAC;AAAA,EAC3D;AACF;","names":["import_node_path","import_promises","import_node_path","fs","import_promises","matter","fs","file","fs","import_promises","import_node_path","fs"]}
package/dist/index.mjs CHANGED
@@ -1,11 +1,12 @@
1
1
  // src/index.ts
2
- import { join as join3 } from "path";
2
+ import { join as join5 } from "path";
3
3
 
4
4
  // src/events.ts
5
- import matter from "gray-matter";
6
- import fs2 from "fs/promises";
7
- import { join as join2 } from "path";
8
- import { dirname } from "path";
5
+ import fs3 from "fs/promises";
6
+ import { join as join3 } from "path";
7
+
8
+ // src/internal/resources.ts
9
+ import { dirname, join as join2 } from "path";
9
10
 
10
11
  // src/internal/utils.ts
11
12
  import { glob } from "glob";
@@ -64,72 +65,95 @@ var copyDir = async (catalogDir, source, target, filter) => {
64
65
  await fs.rm(tmpDirectory, { recursive: true });
65
66
  };
66
67
 
67
- // src/events.ts
68
- var getEvent = (directory) => async (id, version) => {
69
- const file = await findFileById(directory, id, version);
70
- if (!file) throw new Error(`No event found for the given id: ${id}` + (version ? ` and version ${version}` : ""));
71
- const { data, content } = matter.read(file);
72
- return {
73
- ...data,
74
- markdown: content.trim()
75
- };
76
- };
77
- var writeEvent = (directory) => async (event, options = { path: "" }) => {
78
- const path = options.path || `/${event.id}`;
79
- const exists = await versionExists(directory, event.id, event.version);
80
- if (exists) {
81
- throw new Error(`Failed to write event as the version ${event.version} already exists`);
82
- }
83
- const { markdown, ...frontmatter } = event;
84
- const document = matter.stringify(markdown.trim(), frontmatter);
85
- await fs2.mkdir(join2(directory, path), { recursive: true });
86
- await fs2.writeFile(join2(directory, path, "index.md"), document);
87
- };
88
- var rmEvent = (directory) => async (path) => {
89
- await fs2.rm(join2(directory, path), { recursive: true });
90
- };
91
- var rmEventById = (directory) => async (id, version) => {
92
- const files = await getFiles(`${directory}/**/index.md`);
93
- const matchedFiles = await searchFilesForId(files, id, version);
94
- if (matchedFiles.length === 0) {
95
- throw new Error(`No event found with id: ${id}`);
96
- }
97
- await Promise.all(matchedFiles.map((file) => fs2.rm(file)));
98
- };
99
- var versionEvent = (directory) => async (id) => {
100
- const files = await getFiles(`${directory}/**/index.md`);
68
+ // src/internal/resources.ts
69
+ import matter from "gray-matter";
70
+ import fs2 from "fs/promises";
71
+ var versionResource = async (catalogDir, id) => {
72
+ const files = await getFiles(`${catalogDir}/**/index.md`);
101
73
  const matchedFiles = await searchFilesForId(files, id);
102
74
  if (matchedFiles.length === 0) {
103
75
  throw new Error(`No event found with id: ${id}`);
104
76
  }
105
77
  const file = matchedFiles[0];
106
- const eventDirectory = dirname(file);
78
+ const sourceDirectory = dirname(file);
107
79
  const { data: { version = "0.0.1" } = {} } = matter.read(file);
108
- const targetDirectory = join2(eventDirectory, "versioned", version);
80
+ const targetDirectory = join2(sourceDirectory, "versioned", version);
109
81
  await fs2.mkdir(targetDirectory, { recursive: true });
110
- await copyDir(directory, eventDirectory, targetDirectory, (src) => {
82
+ await copyDir(catalogDir, sourceDirectory, targetDirectory, (src) => {
111
83
  return !src.includes("versioned");
112
84
  });
113
- await fs2.readdir(eventDirectory).then(async (resourceFiles) => {
85
+ await fs2.readdir(sourceDirectory).then(async (resourceFiles) => {
114
86
  await Promise.all(
115
87
  resourceFiles.map(async (file2) => {
116
88
  if (file2 !== "versioned") {
117
- await fs2.rm(join2(eventDirectory, file2), { recursive: true });
89
+ await fs2.rm(join2(sourceDirectory, file2), { recursive: true });
118
90
  }
119
91
  })
120
92
  );
121
93
  });
122
94
  };
123
- var addFileToEvent = (directory) => async (id, file, version) => {
124
- const pathToEvent = await findFileById(directory, id, version);
125
- if (!pathToEvent) throw new Error("Cannot find directory to write file to");
126
- const contentDirectory = dirname(pathToEvent);
127
- await fs2.writeFile(join2(contentDirectory, file.fileName), file.content);
95
+ var writeResource = async (catalogDir, resource, options = { path: "", type: "" }) => {
96
+ const path = options.path || `/${resource.id}`;
97
+ const exists = await versionExists(catalogDir, resource.id, resource.version);
98
+ if (exists) {
99
+ throw new Error(`Failed to write ${options.type} as the version ${resource.version} already exists`);
100
+ }
101
+ const { markdown, ...frontmatter } = resource;
102
+ const document = matter.stringify(markdown.trim(), frontmatter);
103
+ await fs2.mkdir(join2(catalogDir, path), { recursive: true });
104
+ await fs2.writeFile(join2(catalogDir, path, "index.md"), document);
105
+ };
106
+ var getResource = async (catalogDir, id, version, options) => {
107
+ const file = await findFileById(catalogDir, id, version);
108
+ if (!file)
109
+ throw new Error(
110
+ `No ${options?.type || "resource"} found for the given id: ${id}` + (version ? ` and version ${version}` : "")
111
+ );
112
+ const { data, content } = matter.read(file);
113
+ return {
114
+ ...data,
115
+ markdown: content.trim()
116
+ };
117
+ };
118
+ var rmResourceById = async (catalogDir, id, version, options) => {
119
+ const files = await getFiles(`${catalogDir}/**/index.md`);
120
+ const matchedFiles = await searchFilesForId(files, id, version);
121
+ if (matchedFiles.length === 0) {
122
+ throw new Error(`No ${options?.type || "resource"} found with id: ${id}`);
123
+ }
124
+ await Promise.all(matchedFiles.map((file) => fs2.rm(file)));
125
+ };
126
+ var addFileToResource = async (catalogDir, id, file, version) => {
127
+ const pathToResource = await findFileById(catalogDir, id, version);
128
+ if (!pathToResource) throw new Error("Cannot find directory to write file to");
129
+ await fs2.writeFile(join2(dirname(pathToResource), file.fileName), file.content);
130
+ };
131
+
132
+ // src/events.ts
133
+ var getEvent = (directory) => async (id, version) => getResource(directory, id, version, { type: "event" });
134
+ var writeEvent = (directory) => async (event, options = { path: "" }) => writeResource(directory, { ...event }, { ...options, type: "event" });
135
+ var rmEvent = (directory) => async (path) => {
136
+ await fs3.rm(join3(directory, path), { recursive: true });
128
137
  };
138
+ var rmEventById = (directory) => async (id, version) => rmResourceById(directory, id, version, { type: "event" });
139
+ var versionEvent = (directory) => async (id) => versionResource(directory, id);
140
+ var addFileToEvent = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
129
141
  var addSchemaToEvent = (directory) => async (id, schema, version) => {
130
142
  await addFileToEvent(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);
131
143
  };
132
144
 
145
+ // src/services.ts
146
+ import fs4 from "fs/promises";
147
+ import { join as join4 } from "path";
148
+ var getService = (directory) => async (id, version) => getResource(directory, id, version, { type: "service" });
149
+ var writeService = (directory) => async (service, options = { path: "" }) => writeResource(directory, { ...service }, { ...options, type: "service" });
150
+ var versionService = (directory) => async (id) => versionResource(directory, id);
151
+ var rmService = (directory) => async (path) => {
152
+ await fs4.rm(join4(directory, path), { recursive: true });
153
+ };
154
+ var rmServiceById = (directory) => async (id, version) => rmResourceById(directory, id, version, { type: "service" });
155
+ var addFileToService = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
156
+
133
157
  // src/index.ts
134
158
  var src_default = (path) => {
135
159
  return {
@@ -139,7 +163,7 @@ var src_default = (path) => {
139
163
  * @param version - Optional id of the version to get
140
164
  * @returns
141
165
  */
142
- getEvent: getEvent(join3(path, "events")),
166
+ getEvent: getEvent(join5(path, "events")),
143
167
  /**
144
168
  * Adds an event to EventCatalog
145
169
  *
@@ -147,26 +171,26 @@ var src_default = (path) => {
147
171
  * @param options - Optional options to write the event
148
172
  *
149
173
  */
150
- writeEvent: writeEvent(join3(path, "events")),
174
+ writeEvent: writeEvent(join5(path, "events")),
151
175
  /**
152
176
  * Remove an event to EventCatalog (modeled on the standard POSIX rm utility)
153
177
  *
154
178
  * @param path - The path to your event, e.g. `/Inventory/InventoryAdjusted`
155
179
  *
156
180
  */
157
- rmEvent: rmEvent(join3(path, "events")),
181
+ rmEvent: rmEvent(join5(path, "events")),
158
182
  /**
159
183
  * Remove an event by an Event id
160
184
  *
161
185
  * @param id - The id of the event you want to remove
162
186
  *
163
187
  */
164
- rmEventById: rmEventById(join3(path, "events")),
188
+ rmEventById: rmEventById(join5(path, "events")),
165
189
  /**
166
190
  * Moves a given event id to the version directory
167
191
  * @param directory
168
192
  */
169
- versionEvent: versionEvent(join3(path, "events")),
193
+ versionEvent: versionEvent(join5(path, "events")),
170
194
  /**
171
195
  * Adds a file to the given event
172
196
  * @param id - The id of the event to add the file to
@@ -174,7 +198,7 @@ var src_default = (path) => {
174
198
  * @param version - Optional version of the event to add the file to
175
199
  * @returns
176
200
  */
177
- addFileToEvent: addFileToEvent(join3(path, "events")),
201
+ addFileToEvent: addFileToEvent(join5(path, "events")),
178
202
  /**
179
203
  * Adds a schema to the given event
180
204
  * @param id - The id of the event to add the schema to
@@ -182,7 +206,54 @@ var src_default = (path) => {
182
206
  * @param version - Optional version of the event to add the schema to
183
207
  * @returns
184
208
  */
185
- addSchemaToEvent: addSchemaToEvent(join3(path, "events"))
209
+ addSchemaToEvent: addSchemaToEvent(join5(path, "events")),
210
+ /**
211
+ * ================================
212
+ * SERVICES
213
+ * ================================
214
+ */
215
+ /**
216
+ * Adds a service to EventCatalog
217
+ *
218
+ * @param service - The service to write
219
+ * @param options - Optional options to write the event
220
+ *
221
+ */
222
+ writeService: writeService(join5(path, "services")),
223
+ /**
224
+ * Returns a service from EventCatalog
225
+ * @param id - The id of the service to retrieve
226
+ * @param version - Optional id of the version to get
227
+ * @returns
228
+ */
229
+ getService: getService(join5(path, "services")),
230
+ /**
231
+ * Moves a given service id to the version directory
232
+ * @param directory
233
+ */
234
+ versionService: versionService(join5(path, "services")),
235
+ /**
236
+ * Remove a service from EventCatalog (modeled on the standard POSIX rm utility)
237
+ *
238
+ * @param path - The path to your service, e.g. `/InventoryService`
239
+ *
240
+ */
241
+ rmService: rmService(join5(path, "services")),
242
+ /**
243
+ * Remove an service by an service id
244
+ *
245
+ * @param id - The id of the service you want to remove
246
+ *
247
+ */
248
+ rmServiceById: rmServiceById(join5(path, "services")),
249
+ /**
250
+ * Adds a file to the given service
251
+ * @param id - The id of the service to add the file to
252
+ * @param file - File contents to add including the content and the file name
253
+ * @param version - Optional version of the service to add the file to
254
+ * @returns
255
+ */
256
+ addFileToService: addFileToService(join5(path, "services"))
186
257
  };
187
258
  };
188
259
  export {