@eventcatalog/sdk 2.11.0 → 2.12.0

package/dist/events.d.mts

@@ -1,276 +0,0 @@
-import { Event } from './types.d.mjs';
-
-/**
- * Returns an event from EventCatalog.
- *
- * You can optionally specify a version to get a specific version of the event
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getEvent } = utils('/path/to/eventcatalog');
- *
- * // Gets the latest version of the event
- * const event = await getEvent('InventoryAdjusted');
- *
- * // Gets a version of the event
- * const event = await getEvent('InventoryAdjusted', '0.0.1');
- *
- * // Get the event with the schema attached
- * const event = await getEvent('InventoryAdjusted', '0.0.1', { attachSchema: true });
- * ```
- */
-declare const getEvent: (directory: string) => (id: string, version?: string, options?: {
-    attachSchema?: boolean;
-}) => Promise<Event>;
-/**
- * Returns all events from EventCatalog.
- *
- * You can optionally specify if you want to get the latest version of the events.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getEvents } = utils('/path/to/eventcatalog');
- *
- * // Gets all events (and versions) from the catalog
- * const events = await getEvents();
- *
- * // Gets all events (only latest version) from the catalog
- * const events = await getEvents({ latestOnly: true });
- *
- * // Get all events with the schema attached
- * const events = await getEvents({ attachSchema: true });
- * ```
- */
-declare const getEvents: (directory: string) => (options?: {
-    latestOnly?: boolean;
-    attachSchema?: boolean;
-}) => Promise<Event[]>;
-/**
- * Write an event to EventCatalog.
- *
- * You can optionally overide the path of the event.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeEvent } = utils('/path/to/eventcatalog');
- *
- * // Write an event to the catalog
- * // Event would be written to events/InventoryAdjusted
- * await writeEvent({
- *   id: 'InventoryAdjusted',
- *   name: 'Inventory Adjusted',
- *   version: '0.0.1',
- *   summary: 'This is a summary',
- *   markdown: '# Hello world',
- * });
- *
- * // Write an event to the catalog but override the path
- * // Event would be written to events/Inventory/InventoryAdjusted
- * await writeEvent({
- *    id: 'InventoryAdjusted',
- *    name: 'Inventory Adjusted',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { path: "/Inventory/InventoryAdjusted"});
- *
- * // Write a event to the catalog and override the existing content (if there is any)
- * await writeEvent({
- *    id: 'InventoryAdjusted',
- *    name: 'Inventory Adjusted',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { override: true });
- *
- * // Write a event to the catalog and version the previous version
- * // only works if the new version is greater than the previous version
- * await writeEvent({
- *    id: 'InventoryAdjusted',
- *    name: 'Inventory Adjusted',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { versionExistingContent: true });
- *
- * ```
- */
-declare const writeEvent: (directory: string) => (event: Event, options?: {
-    path?: string;
-    override?: boolean;
-    versionExistingContent?: boolean;
-    format?: "md" | "mdx";
-}) => Promise<void>;
-/**
- * Write an event to a service in EventCatalog.
- *
- * You can optionally override the path of the event.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeEventToService } = utils('/path/to/eventcatalog');
- *
- * // Write an event to a given service in the catalog
- * // Event would be written to services/Inventory/events/InventoryAdjusted
- * await writeEventToService({
- *   id: 'InventoryAdjusted',
- *   name: 'Inventory Adjusted',
- *   version: '0.0.1',
- *   summary: 'This is a summary',
- *   markdown: '# Hello world',
- * }, { id: 'Inventory' });
- * ```
- */
-declare const writeEventToService: (directory: string) => (event: Event, service: {
-    id: string;
-    version?: string;
-}, options?: {
-    path?: string;
-    format?: "md" | "mdx";
-    override?: boolean;
-}) => Promise<void>;
-/**
- * Delete an event at it's given path.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmEvent } = utils('/path/to/eventcatalog');
- *
- * // removes an event at the given path (events dir is appended to the given path)
- * // Removes the event at events/InventoryAdjusted
- * await rmEvent('/InventoryAdjusted');
- * ```
- */
-declare const rmEvent: (directory: string) => (path: string) => Promise<void>;
-/**
- * Delete an event by it's id.
- *
- * Optionally specify a version to delete a specific version of the event.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmEventById } = utils('/path/to/eventcatalog');
- *
- * // deletes the latest InventoryAdjusted event
- * await rmEventById('InventoryAdjusted');
- *
- * // deletes a specific version of the InventoryAdjusted event
- * await rmEventById('InventoryAdjusted', '0.0.1');
- * ```
- */
-declare const rmEventById: (directory: string) => (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
-/**
- * Version an event by it's id.
- *
- * Takes the latest event and moves it to a versioned directory.
- * All files with this event are also versioned (e.g /events/InventoryAdjusted/schema.json)
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { versionEvent } = utils('/path/to/eventcatalog');
- *
- * // moves the latest InventoryAdjusted event to a versioned directory
- * // the version within that event is used as the version number.
- * await versionEvent('InventoryAdjusted');
- *
- * ```
- */
-declare const versionEvent: (directory: string) => (id: string) => Promise<void>;
-/**
- * Add a file to an event by it's id.
- *
- * Optionally specify a version to add a file to a specific version of the event.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { addFileToEvent } = utils('/path/to/eventcatalog');
- *
- * // adds a file to the latest InventoryAdjusted event
- * await addFileToEvent('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' });
- *
- * // adds a file to a specific version of the InventoryAdjusted event
- * await addFileToEvent('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');
- *
- * ```
- */
-declare const addFileToEvent: (directory: string) => (id: string, file: {
-    content: string;
-    fileName: string;
-}, version?: string, options?: {
-    path?: string;
-}) => Promise<void>;
-/**
- * Add a schema to an event by it's id.
- *
- * Optionally specify a version to add a schema to a specific version of the event.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { addFileToEvent } = utils('/path/to/eventcatalog');
- *
- * // JSON schema example
- * const schema = {
- *    "$schema": "http://json-schema.org/draft-07/schema#",
- *    "type": "object",
- *    "properties": {
- *        "name": {
- *        "type": "string"
- *    },
- *    "age": {
- *      "type": "number"
- *    }
- *  },
- *  "required": ["name", "age"]
- * };
- *
- * // adds a file to the latest InventoryAdjusted event
- * await addFileToEvent('InventoryAdjusted', { schema, fileName: 'schema.json' });
- *
- * // adds a file to a specific version of the InventoryAdjusted event
- * await addFileToEvent('InventoryAdjusted', { schema, fileName: 'schema.json' }, '0.0.1');
- *
- * ```
- */
-declare const addSchemaToEvent: (directory: string) => (id: string, schema: {
-    schema: string;
-    fileName: string;
-}, version?: string, options?: {
-    path?: string;
-}) => Promise<void>;
-/**
- * Check to see if the catalog has a version for the given event.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { eventHasVersion } = utils('/path/to/eventcatalog');
- *
- * // returns true if version is found for the given event and version (supports semver)
- * await eventHasVersion('InventoryAdjusted', '0.0.1');
- * await eventHasVersion('InventoryAdjusted', 'latest');
- * await eventHasVersion('InventoryAdjusted', '0.0.x');*
- *
- * ```
- */
-declare const eventHasVersion: (directory: string) => (id: string, version?: string) => Promise<boolean>;
-
-export { addFileToEvent, addSchemaToEvent, eventHasVersion, getEvent, getEvents, rmEvent, rmEventById, versionEvent, writeEvent, writeEventToService };

package/dist/events.d.ts

@@ -1,276 +0,0 @@
-import { Event } from './types.d.js';
-
-/**
- * Returns an event from EventCatalog.
- *
- * You can optionally specify a version to get a specific version of the event
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getEvent } = utils('/path/to/eventcatalog');
- *
- * // Gets the latest version of the event
- * const event = await getEvent('InventoryAdjusted');
- *
- * // Gets a version of the event
- * const event = await getEvent('InventoryAdjusted', '0.0.1');
- *
- * // Get the event with the schema attached
- * const event = await getEvent('InventoryAdjusted', '0.0.1', { attachSchema: true });
- * ```
- */
-declare const getEvent: (directory: string) => (id: string, version?: string, options?: {
-    attachSchema?: boolean;
-}) => Promise<Event>;
-/**
- * Returns all events from EventCatalog.
- *
- * You can optionally specify if you want to get the latest version of the events.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getEvents } = utils('/path/to/eventcatalog');
- *
- * // Gets all events (and versions) from the catalog
- * const events = await getEvents();
- *
- * // Gets all events (only latest version) from the catalog
- * const events = await getEvents({ latestOnly: true });
- *
- * // Get all events with the schema attached
- * const events = await getEvents({ attachSchema: true });
- * ```
- */
-declare const getEvents: (directory: string) => (options?: {
-    latestOnly?: boolean;
-    attachSchema?: boolean;
-}) => Promise<Event[]>;
-/**
- * Write an event to EventCatalog.
- *
- * You can optionally overide the path of the event.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeEvent } = utils('/path/to/eventcatalog');
- *
- * // Write an event to the catalog
- * // Event would be written to events/InventoryAdjusted
- * await writeEvent({
- *   id: 'InventoryAdjusted',
- *   name: 'Inventory Adjusted',
- *   version: '0.0.1',
- *   summary: 'This is a summary',
- *   markdown: '# Hello world',
- * });
- *
- * // Write an event to the catalog but override the path
- * // Event would be written to events/Inventory/InventoryAdjusted
- * await writeEvent({
- *    id: 'InventoryAdjusted',
- *    name: 'Inventory Adjusted',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { path: "/Inventory/InventoryAdjusted"});
- *
- * // Write a event to the catalog and override the existing content (if there is any)
- * await writeEvent({
- *    id: 'InventoryAdjusted',
- *    name: 'Inventory Adjusted',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { override: true });
- *
- * // Write a event to the catalog and version the previous version
- * // only works if the new version is greater than the previous version
- * await writeEvent({
- *    id: 'InventoryAdjusted',
- *    name: 'Inventory Adjusted',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { versionExistingContent: true });
- *
- * ```
- */
-declare const writeEvent: (directory: string) => (event: Event, options?: {
-    path?: string;
-    override?: boolean;
-    versionExistingContent?: boolean;
-    format?: "md" | "mdx";
-}) => Promise<void>;
-/**
- * Write an event to a service in EventCatalog.
- *
- * You can optionally override the path of the event.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeEventToService } = utils('/path/to/eventcatalog');
- *
- * // Write an event to a given service in the catalog
- * // Event would be written to services/Inventory/events/InventoryAdjusted
- * await writeEventToService({
- *   id: 'InventoryAdjusted',
- *   name: 'Inventory Adjusted',
- *   version: '0.0.1',
- *   summary: 'This is a summary',
- *   markdown: '# Hello world',
- * }, { id: 'Inventory' });
- * ```
- */
-declare const writeEventToService: (directory: string) => (event: Event, service: {
-    id: string;
-    version?: string;
-}, options?: {
-    path?: string;
-    format?: "md" | "mdx";
-    override?: boolean;
-}) => Promise<void>;
-/**
- * Delete an event at it's given path.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmEvent } = utils('/path/to/eventcatalog');
- *
- * // removes an event at the given path (events dir is appended to the given path)
- * // Removes the event at events/InventoryAdjusted
- * await rmEvent('/InventoryAdjusted');
- * ```
- */
-declare const rmEvent: (directory: string) => (path: string) => Promise<void>;
-/**
- * Delete an event by it's id.
- *
- * Optionally specify a version to delete a specific version of the event.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmEventById } = utils('/path/to/eventcatalog');
- *
- * // deletes the latest InventoryAdjusted event
- * await rmEventById('InventoryAdjusted');
- *
- * // deletes a specific version of the InventoryAdjusted event
- * await rmEventById('InventoryAdjusted', '0.0.1');
- * ```
- */
-declare const rmEventById: (directory: string) => (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
-/**
- * Version an event by it's id.
- *
- * Takes the latest event and moves it to a versioned directory.
- * All files with this event are also versioned (e.g /events/InventoryAdjusted/schema.json)
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { versionEvent } = utils('/path/to/eventcatalog');
- *
- * // moves the latest InventoryAdjusted event to a versioned directory
- * // the version within that event is used as the version number.
- * await versionEvent('InventoryAdjusted');
- *
- * ```
- */
-declare const versionEvent: (directory: string) => (id: string) => Promise<void>;
-/**
- * Add a file to an event by it's id.
- *
- * Optionally specify a version to add a file to a specific version of the event.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { addFileToEvent } = utils('/path/to/eventcatalog');
- *
- * // adds a file to the latest InventoryAdjusted event
- * await addFileToEvent('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' });
- *
- * // adds a file to a specific version of the InventoryAdjusted event
- * await addFileToEvent('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');
- *
- * ```
- */
-declare const addFileToEvent: (directory: string) => (id: string, file: {
-    content: string;
-    fileName: string;
-}, version?: string, options?: {
-    path?: string;
-}) => Promise<void>;
-/**
- * Add a schema to an event by it's id.
- *
- * Optionally specify a version to add a schema to a specific version of the event.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { addFileToEvent } = utils('/path/to/eventcatalog');
- *
- * // JSON schema example
- * const schema = {
- *    "$schema": "http://json-schema.org/draft-07/schema#",
- *    "type": "object",
- *    "properties": {
- *        "name": {
- *        "type": "string"
- *    },
- *    "age": {
- *      "type": "number"
- *    }
- *  },
- *  "required": ["name", "age"]
- * };
- *
- * // adds a file to the latest InventoryAdjusted event
- * await addFileToEvent('InventoryAdjusted', { schema, fileName: 'schema.json' });
- *
- * // adds a file to a specific version of the InventoryAdjusted event
- * await addFileToEvent('InventoryAdjusted', { schema, fileName: 'schema.json' }, '0.0.1');
- *
- * ```
- */
-declare const addSchemaToEvent: (directory: string) => (id: string, schema: {
-    schema: string;
-    fileName: string;
-}, version?: string, options?: {
-    path?: string;
-}) => Promise<void>;
-/**
- * Check to see if the catalog has a version for the given event.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { eventHasVersion } = utils('/path/to/eventcatalog');
- *
- * // returns true if version is found for the given event and version (supports semver)
- * await eventHasVersion('InventoryAdjusted', '0.0.1');
- * await eventHasVersion('InventoryAdjusted', 'latest');
- * await eventHasVersion('InventoryAdjusted', '0.0.x');*
- *
- * ```
- */
-declare const eventHasVersion: (directory: string) => (id: string, version?: string) => Promise<boolean>;
-
-export { addFileToEvent, addSchemaToEvent, eventHasVersion, getEvent, getEvents, rmEvent, rmEventById, versionEvent, writeEvent, writeEventToService };