@eventcatalog/sdk 2.11.0 → 2.12.0

package/dist/types.d.d.ts

@@ -1,331 +0,0 @@
-// Base type for all resources (domains, services and messages)
-interface BaseSchema {
-  id: string;
-  name: string;
-  summary?: string;
-  version: string;
-  badges?: Badge[];
-  sidebar?: {
-    badge?: string;
-  };
-  owners?: string[];
-  schemaPath?: string;
-  markdown: string;
-  repository?: {
-    language?: string;
-    url?: string;
-  };
-  deprecated?:
-    | boolean
-    | {
-        date?: string;
-        message?: string;
-      };
-  styles?: {
-    icon?: string;
-    node?: {
-      color?: string;
-      label?: string;
-    };
-  };
-  attachments?:
-    | string[]
-    | {
-        url: string;
-        title?: string;
-        type?: string;
-        description?: string;
-        icon?: string;
-      }[];
-  resourceGroups?: ResourceGroup[];
-  diagrams?: ResourcePointer[];
-  editUrl?: string;
-  draft?: boolean | { title?: string; message?: string };
-  // SDK types
-  schema?: any;
-}
-
-type ResourcePointer = {
-  id: string;
-  version?: string;
-  type?: string;
-};
-
-type SendsPointer = {
-  id: string;
-  version?: string;
-  to?: ChannelPointer[];
-};
-
-type ReceivesPointer = {
-  id: string;
-  version?: string;
-  from?: ChannelPointer[];
-};
-
-interface ResourceGroup {
-  id?: string;
-  title?: string;
-  items: ResourcePointer[];
-  limit?: number;
-  sidebar?: boolean;
-}
-
-interface ChannelPointer extends ResourcePointer {
-  parameters?: Record<string, string>;
-}
-
-type Message = Event | Command | Query;
-
-interface CustomDoc {
-  title: string;
-  summary: string;
-  slug?: string;
-  sidebar?: {
-    label: string;
-    order: number;
-  };
-  owners?: string[];
-  badges?: Badge[];
-  fileName?: string;
-  markdown: string;
-}
-
-interface MessageDetailsPanelProperty {
-  producers?: DetailPanelProperty;
-  consumers?: DetailPanelProperty;
-  channels?: DetailPanelProperty;
-  versions?: DetailPanelProperty;
-  repository?: DetailPanelProperty;
-}
-
-interface Event extends BaseSchema {
-  channels?: ChannelPointer[];
-  detailsPanel?: MessageDetailsPanelProperty;
-}
-interface Command extends BaseSchema {
-  channels?: ChannelPointer[];
-  detailsPanel?: MessageDetailsPanelProperty;
-}
-interface Query extends BaseSchema {
-  channels?: ChannelPointer[];
-  detailsPanel?: MessageDetailsPanelProperty;
-}
-interface Channel extends BaseSchema {
-  address?: string;
-  protocols?: string[];
-  routes?: ChannelPointer[];
-  detailsPanel?: {
-    producers?: DetailPanelProperty;
-    consumers?: DetailPanelProperty;
-    messages?: DetailPanelProperty;
-    protocols?: DetailPanelProperty;
-    versions?: DetailPanelProperty;
-    repository?: DetailPanelProperty;
-    owners?: DetailPanelProperty;
-    changelog?: DetailPanelProperty;
-  };
-  // parameters?: Record<string, Parameter>;
-  parameters?: {
-    [key: string]: {
-      enum?: string[];
-      default?: string;
-      examples?: string[];
-      description?: string;
-    };
-  };
-}
-
-interface Specifications {
-  asyncapiPath?: string;
-  openapiPath?: string;
-  graphqlPath?: string;
-}
-
-interface Specification {
-  type: 'openapi' | 'asyncapi' | 'graphql';
-  path: string;
-  name?: string;
-}
-
-interface Service extends BaseSchema {
-  sends?: SendsPointer[];
-  receives?: ReceivesPointer[];
-  entities?: ResourcePointer[];
-  writesTo?: ResourcePointer[];
-  readsFrom?: ResourcePointer[];
-  specifications?: Specifications | Specification[];
-  detailsPanel?: {
-    domains?: DetailPanelProperty;
-    messages?: DetailPanelProperty;
-    versions?: DetailPanelProperty;
-    specifications?: DetailPanelProperty;
-    entities?: DetailPanelProperty;
-    repository?: DetailPanelProperty;
-    owners?: DetailPanelProperty;
-    changelog?: DetailPanelProperty;
-  };
-}
-
-interface Domain extends BaseSchema {
-  services?: ResourcePointer[];
-  domains?: ResourcePointer[];
-  entities?: ResourcePointer[];
-  dataProducts?: ResourcePointer[];
-  sends?: SendsPointer[];
-  receives?: ReceivesPointer[];
-  detailsPanel?: {
-    parentDomains?: DetailPanelProperty;
-    subdomains?: DetailPanelProperty;
-    services?: DetailPanelProperty;
-    entities?: DetailPanelProperty;
-    messages?: DetailPanelProperty;
-    ubiquitousLanguage?: DetailPanelProperty;
-    repository?: DetailPanelProperty;
-    versions?: DetailPanelProperty;
-    owners?: DetailPanelProperty;
-    changelog?: DetailPanelProperty;
-  };
-}
-
-interface Team {
-  id: string;
-  name: string;
-  summary?: string;
-  email?: string;
-  hidden?: boolean;
-  slackDirectMessageUrl?: string;
-  members?: User[];
-  ownedCommands?: Command[];
-  ownedServices?: Service[];
-  ownedEvents?: Event[];
-  markdown: string;
-}
-
-interface User {
-  id: string;
-  name: string;
-  avatarUrl: string;
-  role?: string;
-  hidden?: boolean;
-  email?: string;
-  slackDirectMessageUrl?: string;
-  ownedServices?: Service[];
-  ownedEvents?: Event[];
-  ownedCommands?: Command[];
-  associatedTeams?: Team[];
-  markdown: string;
-}
-
-interface Badge {
-  content: string;
-  backgroundColor: string;
-  textColor: string;
-  icon?: string;
-}
-
-interface UbiquitousLanguage {
-  id: string;
-  name: string;
-  summary?: string;
-  description?: string;
-  icon?: string;
-}
-
-interface UbiquitousLanguageDictionary {
-  dictionary: UbiquitousLanguage[];
-}
-
-interface DetailPanelProperty {
-  visible: boolean;
-}
-
-interface Entity extends BaseSchema {
-  aggregateRoot?: boolean;
-  identifier?: string;
-  properties?: {
-    name: string;
-    type: string;
-    required?: boolean;
-    description?: string;
-    references?: string;
-    referencesIdentifier?: string;
-    relationType?: string;
-  }[];
-  detailsPanel?: {
-    domains?: DetailPanelProperty;
-    services?: DetailPanelProperty;
-    messages?: DetailPanelProperty;
-    versions?: DetailPanelProperty;
-    owners?: DetailPanelProperty;
-    changelog?: DetailPanelProperty;
-  };
-}
-
-type DataProductOutputPointer = {
-  id: string;
-  version?: string;
-  contract?: {
-    path: string;
-    name: string;
-    type?: string;
-  };
-};
-
-interface DataProduct extends BaseSchema {
-  inputs?: ResourcePointer[];
-  outputs?: DataProductOutputPointer[];
-  detailsPanel?: {
-    domains?: DetailPanelProperty;
-    inputs?: DetailPanelProperty;
-    outputs?: DetailPanelProperty;
-    versions?: DetailPanelProperty;
-    repository?: DetailPanelProperty;
-    owners?: DetailPanelProperty;
-    changelog?: DetailPanelProperty;
-  };
-}
-
-declare enum DataClassification {
-  Public = 'public',
-  Internal = 'internal',
-  Confidential = 'confidential',
-  Regulated = 'regulated',
-}
-
-interface Container extends BaseSchema {
-  container_type: 'database' | 'cache' | 'objectStore' | 'searchIndex' | 'dataWarehouse' | 'dataLake' | 'externalSaaS' | 'other';
-  technology?: string;
-  authoritative?: boolean;
-  access_mode?: string;
-  classification?: DataClassification;
-  residency?: string;
-  retention?: string;
-  detailsPanel?: {
-    versions?: DetailPanelProperty;
-    repository?: DetailPanelProperty;
-    owners?: DetailPanelProperty;
-    changelog?: DetailPanelProperty;
-  };
-}
-
-type EventCatalog = {
-  version: string;
-  catalogVersion: string;
-  createdAt: string;
-  resources: {
-    domains?: ExportedResource<Domain>[];
-    services?: ExportedResource<Service>[];
-    messages?: {
-      events?: ExportedResource<Event>[];
-      queries?: ExportedResource<Query>[];
-      commands?: ExportedResource<Command>[];
-    };
-    teams?: ExportedResource<Team>[];
-    users?: ExportedResource<User>[];
-    channels?: ExportedResource<Channel>[];
-    customDocs?: ExportedResource<CustomDoc>[];
-  };
-};
-
-export type { Badge, BaseSchema, Channel, ChannelPointer, Command, Container, CustomDoc, DataProduct, DataProductOutputPointer, Domain, Entity, Event, EventCatalog, Message, Query, ReceivesPointer, ResourceGroup, ResourcePointer, SendsPointer, Service, Specification, Specifications, Team, UbiquitousLanguage, UbiquitousLanguageDictionary, User };

package/dist/types.d.js

@@ -1,19 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/types.d.ts
-var types_d_exports = {};
-module.exports = __toCommonJS(types_d_exports);
-//# sourceMappingURL=types.d.js.map

package/dist/types.d.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/types.d.ts"],"sourcesContent":["// Base type for all resources (domains, services and messages)\nexport interface BaseSchema {\n  id: string;\n  name: string;\n  summary?: string;\n  version: string;\n  badges?: Badge[];\n  sidebar?: {\n    badge?: string;\n  };\n  owners?: string[];\n  schemaPath?: string;\n  markdown: string;\n  repository?: {\n    language?: string;\n    url?: string;\n  };\n  deprecated?:\n    | boolean\n    | {\n        date?: string;\n        message?: string;\n      };\n  styles?: {\n    icon?: string;\n    node?: {\n      color?: string;\n      label?: string;\n    };\n  };\n  attachments?:\n    | string[]\n    | {\n        url: string;\n        title?: string;\n        type?: string;\n        description?: string;\n        icon?: string;\n      }[];\n  resourceGroups?: ResourceGroup[];\n  diagrams?: ResourcePointer[];\n  editUrl?: string;\n  draft?: boolean | { title?: string; message?: string };\n  // SDK types\n  schema?: any;\n}\n\nexport type ResourcePointer = {\n  id: string;\n  version?: string;\n  type?: string;\n};\n\nexport type SendsPointer = {\n  id: string;\n  version?: string;\n  to?: ChannelPointer[];\n};\n\nexport type ReceivesPointer = {\n  id: string;\n  version?: string;\n  from?: ChannelPointer[];\n};\n\nexport interface ResourceGroup {\n  id?: string;\n  title?: string;\n  items: ResourcePointer[];\n  limit?: number;\n  sidebar?: boolean;\n}\n\nexport interface ChannelPointer extends ResourcePointer {\n  parameters?: Record<string, string>;\n}\n\nexport type Message = Event | Command | Query;\n\nenum ResourceType {\n  Service = 'service',\n  Event = 'event',\n  Command = 'command',\n}\n\nexport interface CustomDoc {\n  title: string;\n  summary: string;\n  slug?: string;\n  sidebar?: {\n    label: string;\n    order: number;\n  };\n  owners?: string[];\n  badges?: Badge[];\n  fileName?: string;\n  markdown: string;\n}\n\ninterface MessageDetailsPanelProperty {\n  producers?: DetailPanelProperty;\n  consumers?: DetailPanelProperty;\n  channels?: DetailPanelProperty;\n  versions?: DetailPanelProperty;\n  repository?: DetailPanelProperty;\n}\n\nexport interface Event extends BaseSchema {\n  channels?: ChannelPointer[];\n  detailsPanel?: MessageDetailsPanelProperty;\n}\nexport interface Command extends BaseSchema {\n  channels?: ChannelPointer[];\n  detailsPanel?: MessageDetailsPanelProperty;\n}\nexport interface Query extends BaseSchema {\n  channels?: ChannelPointer[];\n  detailsPanel?: MessageDetailsPanelProperty;\n}\nexport interface Channel extends BaseSchema {\n  address?: string;\n  protocols?: string[];\n  routes?: ChannelPointer[];\n  detailsPanel?: {\n    producers?: DetailPanelProperty;\n    consumers?: DetailPanelProperty;\n    messages?: DetailPanelProperty;\n    protocols?: DetailPanelProperty;\n    versions?: DetailPanelProperty;\n    repository?: DetailPanelProperty;\n    owners?: DetailPanelProperty;\n    changelog?: DetailPanelProperty;\n  };\n  // parameters?: Record<string, Parameter>;\n  parameters?: {\n    [key: string]: {\n      enum?: string[];\n      default?: string;\n      examples?: string[];\n      description?: string;\n    };\n  };\n}\n\nexport interface Specifications {\n  asyncapiPath?: string;\n  openapiPath?: string;\n  graphqlPath?: string;\n}\n\nexport interface Specification {\n  type: 'openapi' | 'asyncapi' | 'graphql';\n  path: string;\n  name?: string;\n}\n\nexport interface Service extends BaseSchema {\n  sends?: SendsPointer[];\n  receives?: ReceivesPointer[];\n  entities?: ResourcePointer[];\n  writesTo?: ResourcePointer[];\n  readsFrom?: ResourcePointer[];\n  specifications?: Specifications | Specification[];\n  detailsPanel?: {\n    domains?: DetailPanelProperty;\n    messages?: DetailPanelProperty;\n    versions?: DetailPanelProperty;\n    specifications?: DetailPanelProperty;\n    entities?: DetailPanelProperty;\n    repository?: DetailPanelProperty;\n    owners?: DetailPanelProperty;\n    changelog?: DetailPanelProperty;\n  };\n}\n\nexport interface Domain extends BaseSchema {\n  services?: ResourcePointer[];\n  domains?: ResourcePointer[];\n  entities?: ResourcePointer[];\n  dataProducts?: ResourcePointer[];\n  sends?: SendsPointer[];\n  receives?: ReceivesPointer[];\n  detailsPanel?: {\n    parentDomains?: DetailPanelProperty;\n    subdomains?: DetailPanelProperty;\n    services?: DetailPanelProperty;\n    entities?: DetailPanelProperty;\n    messages?: DetailPanelProperty;\n    ubiquitousLanguage?: DetailPanelProperty;\n    repository?: DetailPanelProperty;\n    versions?: DetailPanelProperty;\n    owners?: DetailPanelProperty;\n    changelog?: DetailPanelProperty;\n  };\n}\n\nexport interface Team {\n  id: string;\n  name: string;\n  summary?: string;\n  email?: string;\n  hidden?: boolean;\n  slackDirectMessageUrl?: string;\n  members?: User[];\n  ownedCommands?: Command[];\n  ownedServices?: Service[];\n  ownedEvents?: Event[];\n  markdown: string;\n}\n\nexport interface User {\n  id: string;\n  name: string;\n  avatarUrl: string;\n  role?: string;\n  hidden?: boolean;\n  email?: string;\n  slackDirectMessageUrl?: string;\n  ownedServices?: Service[];\n  ownedEvents?: Event[];\n  ownedCommands?: Command[];\n  associatedTeams?: Team[];\n  markdown: string;\n}\n\nexport interface Badge {\n  content: string;\n  backgroundColor: string;\n  textColor: string;\n  icon?: string;\n}\n\nexport interface UbiquitousLanguage {\n  id: string;\n  name: string;\n  summary?: string;\n  description?: string;\n  icon?: string;\n}\n\nexport interface UbiquitousLanguageDictionary {\n  dictionary: UbiquitousLanguage[];\n}\n\ninterface DetailPanelProperty {\n  visible: boolean;\n}\n\nexport interface Entity extends BaseSchema {\n  aggregateRoot?: boolean;\n  identifier?: string;\n  properties?: {\n    name: string;\n    type: string;\n    required?: boolean;\n    description?: string;\n    references?: string;\n    referencesIdentifier?: string;\n    relationType?: string;\n  }[];\n  detailsPanel?: {\n    domains?: DetailPanelProperty;\n    services?: DetailPanelProperty;\n    messages?: DetailPanelProperty;\n    versions?: DetailPanelProperty;\n    owners?: DetailPanelProperty;\n    changelog?: DetailPanelProperty;\n  };\n}\n\nexport type DataProductOutputPointer = {\n  id: string;\n  version?: string;\n  contract?: {\n    path: string;\n    name: string;\n    type?: string;\n  };\n};\n\nexport interface DataProduct extends BaseSchema {\n  inputs?: ResourcePointer[];\n  outputs?: DataProductOutputPointer[];\n  detailsPanel?: {\n    domains?: DetailPanelProperty;\n    inputs?: DetailPanelProperty;\n    outputs?: DetailPanelProperty;\n    versions?: DetailPanelProperty;\n    repository?: DetailPanelProperty;\n    owners?: DetailPanelProperty;\n    changelog?: DetailPanelProperty;\n  };\n}\n\nenum DataClassification {\n  Public = 'public',\n  Internal = 'internal',\n  Confidential = 'confidential',\n  Regulated = 'regulated',\n}\n\nexport interface Container extends BaseSchema {\n  container_type: 'database' | 'cache' | 'objectStore' | 'searchIndex' | 'dataWarehouse' | 'dataLake' | 'externalSaaS' | 'other';\n  technology?: string;\n  authoritative?: boolean;\n  access_mode?: string;\n  classification?: DataClassification;\n  residency?: string;\n  retention?: string;\n  detailsPanel?: {\n    versions?: DetailPanelProperty;\n    repository?: DetailPanelProperty;\n    owners?: DetailPanelProperty;\n    changelog?: DetailPanelProperty;\n  };\n}\n\nexport type EventCatalog = {\n  version: string;\n  catalogVersion: string;\n  createdAt: string;\n  resources: {\n    domains?: ExportedResource<Domain>[];\n    services?: ExportedResource<Service>[];\n    messages?: {\n      events?: ExportedResource<Event>[];\n      queries?: ExportedResource<Query>[];\n      commands?: ExportedResource<Command>[];\n    };\n    teams?: ExportedResource<Team>[];\n    users?: ExportedResource<User>[];\n    channels?: ExportedResource<Channel>[];\n    customDocs?: ExportedResource<CustomDoc>[];\n  };\n};\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/types.d.mjs

@@ -1 +0,0 @@
-//# sourceMappingURL=types.d.mjs.map

package/dist/types.d.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/users.d.mts

@@ -1,83 +0,0 @@
-import { User } from './types.d.mjs';
-
-/**
- * Returns a user from EventCatalog.
- *
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getUser } = utils('/path/to/eventcatalog');
- *
- * // Gets the user with the given id
- * const user = await getUser('eventcatalog-core-user');
- *
- * ```
- */
-declare const getUser: (catalogDir: string) => (id: string) => Promise<User | undefined>;
-/**
- * Returns all users from EventCatalog.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getUsers } = utils('/path/to/eventcatalog');
- *
- * // Gets all users from the catalog
- * const channels = await getUsers();
- *
- * ```
- */
-declare const getUsers: (catalogDir: string) => (options?: {}) => Promise<User[]>;
-/**
- * Write a user to EventCatalog.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeUser } = utils('/path/to/eventcatalog');
- *
- * // Write a user to the catalog
- * // user would be written to users/eventcatalog-tech-lead
- * await writeUser({
- *   id: 'eventcatalog-tech-lead',
- *   name: 'EventCatalog Tech Lead',
- *   email: 'test@test.com',
- *   avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png',
- *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
- * });
- *
- * // Write a team to the catalog and override the existing content (if there is any)
- * await writeUser({
- *   id: 'eventcatalog-tech-lead',
- *   name: 'EventCatalog Tech Lead',
- *   email: 'test@test.com',
- *   avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png',
- *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
- * }, { override: true });
- *
- * ```
- */
-declare const writeUser: (catalogDir: string) => (user: User, options?: {
-    override?: boolean;
-}) => Promise<void>;
-/**
- * Delete a user by it's id.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmUserById } = utils('/path/to/eventcatalog');
- *
- * // deletes the user with id eventcatalog-core-user
- * await rmUserById('eventcatalog-core-user');
- *
- * ```
- */
-declare const rmUserById: (catalogDir: string) => (id: string) => Promise<void>;
-
-export { getUser, getUsers, rmUserById, writeUser };

package/dist/users.d.ts

@@ -1,83 +0,0 @@
-import { User } from './types.d.js';
-
-/**
- * Returns a user from EventCatalog.
- *
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getUser } = utils('/path/to/eventcatalog');
- *
- * // Gets the user with the given id
- * const user = await getUser('eventcatalog-core-user');
- *
- * ```
- */
-declare const getUser: (catalogDir: string) => (id: string) => Promise<User | undefined>;
-/**
- * Returns all users from EventCatalog.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getUsers } = utils('/path/to/eventcatalog');
- *
- * // Gets all users from the catalog
- * const channels = await getUsers();
- *
- * ```
- */
-declare const getUsers: (catalogDir: string) => (options?: {}) => Promise<User[]>;
-/**
- * Write a user to EventCatalog.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeUser } = utils('/path/to/eventcatalog');
- *
- * // Write a user to the catalog
- * // user would be written to users/eventcatalog-tech-lead
- * await writeUser({
- *   id: 'eventcatalog-tech-lead',
- *   name: 'EventCatalog Tech Lead',
- *   email: 'test@test.com',
- *   avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png',
- *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
- * });
- *
- * // Write a team to the catalog and override the existing content (if there is any)
- * await writeUser({
- *   id: 'eventcatalog-tech-lead',
- *   name: 'EventCatalog Tech Lead',
- *   email: 'test@test.com',
- *   avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png',
- *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
- * }, { override: true });
- *
- * ```
- */
-declare const writeUser: (catalogDir: string) => (user: User, options?: {
-    override?: boolean;
-}) => Promise<void>;
-/**
- * Delete a user by it's id.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmUserById } = utils('/path/to/eventcatalog');
- *
- * // deletes the user with id eventcatalog-core-user
- * await rmUserById('eventcatalog-core-user');
- *
- * ```
- */
-declare const rmUserById: (catalogDir: string) => (id: string) => Promise<void>;
-
-export { getUser, getUsers, rmUserById, writeUser };

package/dist/users.js

@@ -1,127 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/users.ts
-var users_exports = {};
-__export(users_exports, {
-  getUser: () => getUser,
-  getUsers: () => getUsers,
-  rmUserById: () => rmUserById,
-  writeUser: () => writeUser
-});
-module.exports = __toCommonJS(users_exports);
-var import_node_fs2 = __toESM(require("fs"));
-var import_node_path2 = require("path");
-var import_gray_matter2 = __toESM(require("gray-matter"));
-
-// src/internal/utils.ts
-var import_glob = require("glob");
-var import_node_fs = __toESM(require("fs"));
-var import_fs_extra = require("fs-extra");
-var import_node_path = require("path");
-var import_gray_matter = __toESM(require("gray-matter"));
-var import_semver = require("semver");
-var getFiles = async (pattern, ignore = "") => {
-  try {
-    const normalizedInputPattern = (0, import_node_path.normalize)(pattern);
-    const absoluteBaseDir = (0, import_node_path.resolve)(
-      normalizedInputPattern.includes("**") ? normalizedInputPattern.split("**")[0] : (0, import_node_path.dirname)(normalizedInputPattern)
-    );
-    let relativePattern = (0, import_node_path.relative)(absoluteBaseDir, normalizedInputPattern);
-    relativePattern = relativePattern.replace(/\\/g, "/");
-    const ignoreList = Array.isArray(ignore) ? ignore : [ignore];
-    const files = (0, import_glob.globSync)(relativePattern, {
-      cwd: absoluteBaseDir,
-      ignore: ["node_modules/**", ...ignoreList],
-      absolute: true,
-      nodir: true
-    });
-    return files.map(import_node_path.normalize);
-  } catch (error) {
-    const absoluteBaseDirForError = (0, import_node_path.resolve)(
-      (0, import_node_path.normalize)(pattern).includes("**") ? (0, import_node_path.normalize)(pattern).split("**")[0] : (0, import_node_path.dirname)((0, import_node_path.normalize)(pattern))
-    );
-    const relativePatternForError = (0, import_node_path.relative)(absoluteBaseDirForError, (0, import_node_path.normalize)(pattern)).replace(/\\/g, "/");
-    throw new Error(
-      `Error finding files for pattern "${pattern}" (using cwd: "${absoluteBaseDirForError}", globPattern: "${relativePatternForError}"): ${error.message}`
-    );
-  }
-};
-
-// src/users.ts
-var getUser = (catalogDir) => async (id) => {
-  const files = await getFiles(`${catalogDir}/${id}.{md,mdx}`);
-  if (files.length == 0) return void 0;
-  const file = files[0];
-  const { data, content } = import_gray_matter2.default.read(file);
-  return {
-    ...data,
-    id: data.id,
-    name: data.name,
-    avatarUrl: data.avatarUrl,
-    markdown: content.trim()
-  };
-};
-var getUsers = (catalogDir) => async (options) => {
-  const files = await getFiles(`${catalogDir}/users/*.{md,mdx}`);
-  if (files.length === 0) return [];
-  return files.map((file) => {
-    const { data, content } = import_gray_matter2.default.read(file);
-    return {
-      ...data,
-      id: data.id,
-      name: data.name,
-      avatarUrl: data.avatarUrl,
-      markdown: content.trim()
-    };
-  });
-};
-var writeUser = (catalogDir) => async (user, options = {}) => {
-  const resource = { ...user };
-  const currentUser = await getUser(catalogDir)(resource.id);
-  const exists = currentUser !== void 0;
-  if (exists && !options.override) {
-    throw new Error(`Failed to write ${resource.id} (user) as it already exists`);
-  }
-  const { markdown, ...frontmatter } = resource;
-  const document = import_gray_matter2.default.stringify(markdown, frontmatter);
-  import_node_fs2.default.mkdirSync((0, import_node_path2.join)(catalogDir, ""), { recursive: true });
-  import_node_fs2.default.writeFileSync((0, import_node_path2.join)(catalogDir, "", `${resource.id}.mdx`), document);
-};
-var rmUserById = (catalogDir) => async (id) => {
-  import_node_fs2.default.rmSync((0, import_node_path2.join)(catalogDir, `${id}.mdx`), { recursive: true });
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  getUser,
-  getUsers,
-  rmUserById,
-  writeUser
-});
-//# sourceMappingURL=users.js.map