@eventcatalog/generator-apicurio 0.0.3

package/dist/types.d.mts

@@ -0,0 +1,139 @@
+interface ArtifactMetadata {
+    id: string;
+    version: string;
+    type: string;
+    state: string;
+    createdOn: string;
+    modifiedOn: string;
+    globalId: number;
+    contentId: number;
+}
+interface Artifact {
+    id?: string;
+    artifactId?: string;
+    name?: string;
+    description?: string;
+    createdOn: string;
+    createdBy?: string;
+    owner?: string;
+    type?: string;
+    artifactType?: string;
+    labels?: Record<string, string>;
+    state?: string;
+    modifiedOn: string;
+    modifiedBy?: string;
+    groupId: string;
+}
+interface ArtifactSearchResults {
+    artifacts: Artifact[];
+    count: number;
+}
+interface Version {
+    version: string;
+    globalId: number;
+    state: string;
+    createdOn: string;
+    modifiedOn: string;
+    type: string;
+}
+interface VersionSearchResults {
+    versions: Version[];
+    count: number;
+}
+interface ArtifactWithVersions {
+    artifact: Artifact;
+    versions: Version[];
+    latestVersion: string;
+    content?: any;
+}
+declare enum SchemaType {
+    OPENAPI = "OPENAPI",
+    ASYNCAPI = "ASYNCAPI",
+    AVRO = "AVRO",
+    JSON = "JSON",
+    PROTOBUF = "PROTOBUF"
+}
+type EventCatalogConfig = any;
+type MessageType = 'event' | 'command' | 'query';
+type FilterCriterion = string | string[] | {
+    exact?: string | string[];
+    prefix?: string | string[];
+    suffix?: string | string[];
+    includes?: string | string[];
+};
+type Filter = {
+    events?: FilterCriterion;
+    commands?: FilterCriterion;
+    queries?: FilterCriterion;
+};
+type SpecificationType = 'openapi' | 'asyncapi';
+/**
+ * Generator configuration tuple: [generatorPackage, options]
+ * Example: ['@eventcatalog/generator-openapi', { debug: true }]
+ */
+type GeneratorConfig = [string, Record<string, any>?];
+type ServiceSpecification = {
+    type: SpecificationType;
+    artifactId: string;
+    version?: string;
+    /**
+     * Optional generator to run on the specification to create message documentation.
+     * When specified, the generator will be dynamically imported and executed with the spec file.
+     * Example: ['@eventcatalog/generator-openapi', { debug: true }]
+     */
+    generator?: GeneratorConfig;
+};
+type Service = {
+    id: string;
+    name?: string;
+    sends?: Filter[];
+    receives?: Filter[];
+    version: string;
+    writesTo?: {
+        id: string;
+        version?: string;
+    }[];
+    readsFrom?: {
+        id: string;
+        version?: string;
+    }[];
+    summary?: string;
+    specifications?: ServiceSpecification[];
+};
+type Schema = {
+    artifactId: string;
+    messageId: string;
+    version: string;
+    globalId: number;
+    schemaType: SchemaType;
+    schema: string;
+    latestVersion?: boolean;
+    messageType?: MessageType;
+    groupId?: string;
+};
+type Domain = {
+    id: string;
+    name: string;
+    version: string;
+};
+type GeneratorProps = {
+    licenseKey?: string;
+    /**
+     * URL of the Apicurio Registry
+     */
+    registryUrl: string;
+    /**
+     * Include all versions of the schemas in the catalog
+     */
+    includeAllVersions?: boolean;
+    /**
+     * Optional list of services to add to the catalog
+     */
+    services?: Service[];
+    /**
+     * Optional domain to add to the catalog and attach the services too
+     */
+    domain?: Domain;
+};
+
+export { type Artifact, type ArtifactMetadata, type ArtifactSearchResults, type ArtifactWithVersions, type Domain, type EventCatalogConfig, type Filter, type FilterCriterion, type GeneratorConfig, type GeneratorProps, type MessageType, type Schema, SchemaType, type Service, type ServiceSpecification, type SpecificationType, type Version, type VersionSearchResults };

package/dist/types.d.ts

@@ -0,0 +1,139 @@
+interface ArtifactMetadata {
+    id: string;
+    version: string;
+    type: string;
+    state: string;
+    createdOn: string;
+    modifiedOn: string;
+    globalId: number;
+    contentId: number;
+}
+interface Artifact {
+    id?: string;
+    artifactId?: string;
+    name?: string;
+    description?: string;
+    createdOn: string;
+    createdBy?: string;
+    owner?: string;
+    type?: string;
+    artifactType?: string;
+    labels?: Record<string, string>;
+    state?: string;
+    modifiedOn: string;
+    modifiedBy?: string;
+    groupId: string;
+}
+interface ArtifactSearchResults {
+    artifacts: Artifact[];
+    count: number;
+}
+interface Version {
+    version: string;
+    globalId: number;
+    state: string;
+    createdOn: string;
+    modifiedOn: string;
+    type: string;
+}
+interface VersionSearchResults {
+    versions: Version[];
+    count: number;
+}
+interface ArtifactWithVersions {
+    artifact: Artifact;
+    versions: Version[];
+    latestVersion: string;
+    content?: any;
+}
+declare enum SchemaType {
+    OPENAPI = "OPENAPI",
+    ASYNCAPI = "ASYNCAPI",
+    AVRO = "AVRO",
+    JSON = "JSON",
+    PROTOBUF = "PROTOBUF"
+}
+type EventCatalogConfig = any;
+type MessageType = 'event' | 'command' | 'query';
+type FilterCriterion = string | string[] | {
+    exact?: string | string[];
+    prefix?: string | string[];
+    suffix?: string | string[];
+    includes?: string | string[];
+};
+type Filter = {
+    events?: FilterCriterion;
+    commands?: FilterCriterion;
+    queries?: FilterCriterion;
+};
+type SpecificationType = 'openapi' | 'asyncapi';
+/**
+ * Generator configuration tuple: [generatorPackage, options]
+ * Example: ['@eventcatalog/generator-openapi', { debug: true }]
+ */
+type GeneratorConfig = [string, Record<string, any>?];
+type ServiceSpecification = {
+    type: SpecificationType;
+    artifactId: string;
+    version?: string;
+    /**
+     * Optional generator to run on the specification to create message documentation.
+     * When specified, the generator will be dynamically imported and executed with the spec file.
+     * Example: ['@eventcatalog/generator-openapi', { debug: true }]
+     */
+    generator?: GeneratorConfig;
+};
+type Service = {
+    id: string;
+    name?: string;
+    sends?: Filter[];
+    receives?: Filter[];
+    version: string;
+    writesTo?: {
+        id: string;
+        version?: string;
+    }[];
+    readsFrom?: {
+        id: string;
+        version?: string;
+    }[];
+    summary?: string;
+    specifications?: ServiceSpecification[];
+};
+type Schema = {
+    artifactId: string;
+    messageId: string;
+    version: string;
+    globalId: number;
+    schemaType: SchemaType;
+    schema: string;
+    latestVersion?: boolean;
+    messageType?: MessageType;
+    groupId?: string;
+};
+type Domain = {
+    id: string;
+    name: string;
+    version: string;
+};
+type GeneratorProps = {
+    licenseKey?: string;
+    /**
+     * URL of the Apicurio Registry
+     */
+    registryUrl: string;
+    /**
+     * Include all versions of the schemas in the catalog
+     */
+    includeAllVersions?: boolean;
+    /**
+     * Optional list of services to add to the catalog
+     */
+    services?: Service[];
+    /**
+     * Optional domain to add to the catalog and attach the services too
+     */
+    domain?: Domain;
+};
+
+export { type Artifact, type ArtifactMetadata, type ArtifactSearchResults, type ArtifactWithVersions, type Domain, type EventCatalogConfig, type Filter, type FilterCriterion, type GeneratorConfig, type GeneratorProps, type MessageType, type Schema, SchemaType, type Service, type ServiceSpecification, type SpecificationType, type Version, type VersionSearchResults };

package/dist/types.js

@@ -0,0 +1,38 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/types.ts
+var types_exports = {};
+__export(types_exports, {
+  SchemaType: () => SchemaType
+});
+module.exports = __toCommonJS(types_exports);
+var SchemaType = /* @__PURE__ */ ((SchemaType2) => {
+  SchemaType2["OPENAPI"] = "OPENAPI";
+  SchemaType2["ASYNCAPI"] = "ASYNCAPI";
+  SchemaType2["AVRO"] = "AVRO";
+  SchemaType2["JSON"] = "JSON";
+  SchemaType2["PROTOBUF"] = "PROTOBUF";
+  return SchemaType2;
+})(SchemaType || {});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  SchemaType
+});
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["// Apicurio API response types\nexport interface ArtifactMetadata {\n  id: string;\n  version: string;\n  type: string;\n  state: string;\n  createdOn: string;\n  modifiedOn: string;\n  globalId: number;\n  contentId: number;\n}\n\nexport interface Artifact {\n  // V2 uses 'id', V3 uses 'artifactId'\n  id?: string;\n  artifactId?: string;\n  name?: string;\n  description?: string;\n  createdOn: string;\n  createdBy?: string;\n  owner?: string; // V3 uses 'owner' instead of 'createdBy'\n  // V2 uses 'type', V3 uses 'artifactType'\n  type?: string;\n  artifactType?: string;\n  labels?: Record<string, string>;\n  state?: string;\n  modifiedOn: string;\n  modifiedBy?: string;\n  groupId: string;\n}\n\nexport interface ArtifactSearchResults {\n  artifacts: Artifact[];\n  count: number;\n}\n\nexport interface Version {\n  version: string;\n  globalId: number;\n  state: string;\n  createdOn: string;\n  modifiedOn: string;\n  type: string;\n}\n\nexport interface VersionSearchResults {\n  versions: Version[];\n  count: number;\n}\n\nexport interface ArtifactWithVersions {\n  artifact: Artifact;\n  versions: Version[];\n  latestVersion: string;\n  content?: any;\n}\n\nexport enum SchemaType {\n  OPENAPI = 'OPENAPI',\n  ASYNCAPI = 'ASYNCAPI',\n  AVRO = 'AVRO',\n  JSON = 'JSON',\n  PROTOBUF = 'PROTOBUF',\n}\n\n// EventCatalog generator types\nexport type EventCatalogConfig = any;\n\nexport type MessageType = 'event' | 'command' | 'query';\n\nexport type FilterCriterion =\n  | string\n  | string[]\n  | { exact?: string | string[]; prefix?: string | string[]; suffix?: string | string[]; includes?: string | string[] };\n\nexport type Filter = {\n  events?: FilterCriterion;\n  commands?: FilterCriterion;\n  queries?: FilterCriterion;\n};\n\nexport type SpecificationType = 'openapi' | 'asyncapi';\n\n/**\n * Generator configuration tuple: [generatorPackage, options]\n * Example: ['@eventcatalog/generator-openapi', { debug: true }]\n */\nexport type GeneratorConfig = [string, Record<string, any>?];\n\nexport type ServiceSpecification = {\n  type: SpecificationType;\n  artifactId: string;\n  version?: string; // If not provided, uses latest\n  /**\n   * Optional generator to run on the specification to create message documentation.\n   * When specified, the generator will be dynamically imported and executed with the spec file.\n   * Example: ['@eventcatalog/generator-openapi', { debug: true }]\n   */\n  generator?: GeneratorConfig;\n};\n\nexport type Service = {\n  id: string;\n  name?: string;\n  sends?: Filter[];\n  receives?: Filter[];\n  version: string;\n  writesTo?: { id: string; version?: string }[];\n  readsFrom?: { id: string; version?: string }[];\n  summary?: string;\n  specifications?: ServiceSpecification[];\n};\n\nexport type Schema = {\n  artifactId: string;\n  messageId: string;\n  version: string;\n  globalId: number;\n  schemaType: SchemaType;\n  schema: string;\n  latestVersion?: boolean;\n  messageType?: MessageType;\n  groupId?: string;\n};\n\nexport type Domain = {\n  id: string;\n  name: string;\n  version: string;\n};\n\nexport type GeneratorProps = {\n  licenseKey?: string;\n  /**\n   * URL of the Apicurio Registry\n   */\n  registryUrl: string;\n\n  /**\n   * Include all versions of the schemas in the catalog\n   */\n  includeAllVersions?: boolean;\n\n  /**\n   * Optional list of services to add to the catalog\n   */\n  services?: Service[];\n\n  /**\n   * Optional domain to add to the catalog and attach the services too\n   */\n  domain?: Domain;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAyDO,IAAK,aAAL,kBAAKA,gBAAL;AACL,EAAAA,YAAA,aAAU;AACV,EAAAA,YAAA,cAAW;AACX,EAAAA,YAAA,UAAO;AACP,EAAAA,YAAA,UAAO;AACP,EAAAA,YAAA,cAAW;AALD,SAAAA;AAAA,GAAA;","names":["SchemaType"]}

package/dist/types.mjs

@@ -0,0 +1,13 @@
+// src/types.ts
+var SchemaType = /* @__PURE__ */ ((SchemaType2) => {
+  SchemaType2["OPENAPI"] = "OPENAPI";
+  SchemaType2["ASYNCAPI"] = "ASYNCAPI";
+  SchemaType2["AVRO"] = "AVRO";
+  SchemaType2["JSON"] = "JSON";
+  SchemaType2["PROTOBUF"] = "PROTOBUF";
+  return SchemaType2;
+})(SchemaType || {});
+export {
+  SchemaType
+};
+//# sourceMappingURL=types.mjs.map

package/dist/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["// Apicurio API response types\nexport interface ArtifactMetadata {\n  id: string;\n  version: string;\n  type: string;\n  state: string;\n  createdOn: string;\n  modifiedOn: string;\n  globalId: number;\n  contentId: number;\n}\n\nexport interface Artifact {\n  // V2 uses 'id', V3 uses 'artifactId'\n  id?: string;\n  artifactId?: string;\n  name?: string;\n  description?: string;\n  createdOn: string;\n  createdBy?: string;\n  owner?: string; // V3 uses 'owner' instead of 'createdBy'\n  // V2 uses 'type', V3 uses 'artifactType'\n  type?: string;\n  artifactType?: string;\n  labels?: Record<string, string>;\n  state?: string;\n  modifiedOn: string;\n  modifiedBy?: string;\n  groupId: string;\n}\n\nexport interface ArtifactSearchResults {\n  artifacts: Artifact[];\n  count: number;\n}\n\nexport interface Version {\n  version: string;\n  globalId: number;\n  state: string;\n  createdOn: string;\n  modifiedOn: string;\n  type: string;\n}\n\nexport interface VersionSearchResults {\n  versions: Version[];\n  count: number;\n}\n\nexport interface ArtifactWithVersions {\n  artifact: Artifact;\n  versions: Version[];\n  latestVersion: string;\n  content?: any;\n}\n\nexport enum SchemaType {\n  OPENAPI = 'OPENAPI',\n  ASYNCAPI = 'ASYNCAPI',\n  AVRO = 'AVRO',\n  JSON = 'JSON',\n  PROTOBUF = 'PROTOBUF',\n}\n\n// EventCatalog generator types\nexport type EventCatalogConfig = any;\n\nexport type MessageType = 'event' | 'command' | 'query';\n\nexport type FilterCriterion =\n  | string\n  | string[]\n  | { exact?: string | string[]; prefix?: string | string[]; suffix?: string | string[]; includes?: string | string[] };\n\nexport type Filter = {\n  events?: FilterCriterion;\n  commands?: FilterCriterion;\n  queries?: FilterCriterion;\n};\n\nexport type SpecificationType = 'openapi' | 'asyncapi';\n\n/**\n * Generator configuration tuple: [generatorPackage, options]\n * Example: ['@eventcatalog/generator-openapi', { debug: true }]\n */\nexport type GeneratorConfig = [string, Record<string, any>?];\n\nexport type ServiceSpecification = {\n  type: SpecificationType;\n  artifactId: string;\n  version?: string; // If not provided, uses latest\n  /**\n   * Optional generator to run on the specification to create message documentation.\n   * When specified, the generator will be dynamically imported and executed with the spec file.\n   * Example: ['@eventcatalog/generator-openapi', { debug: true }]\n   */\n  generator?: GeneratorConfig;\n};\n\nexport type Service = {\n  id: string;\n  name?: string;\n  sends?: Filter[];\n  receives?: Filter[];\n  version: string;\n  writesTo?: { id: string; version?: string }[];\n  readsFrom?: { id: string; version?: string }[];\n  summary?: string;\n  specifications?: ServiceSpecification[];\n};\n\nexport type Schema = {\n  artifactId: string;\n  messageId: string;\n  version: string;\n  globalId: number;\n  schemaType: SchemaType;\n  schema: string;\n  latestVersion?: boolean;\n  messageType?: MessageType;\n  groupId?: string;\n};\n\nexport type Domain = {\n  id: string;\n  name: string;\n  version: string;\n};\n\nexport type GeneratorProps = {\n  licenseKey?: string;\n  /**\n   * URL of the Apicurio Registry\n   */\n  registryUrl: string;\n\n  /**\n   * Include all versions of the schemas in the catalog\n   */\n  includeAllVersions?: boolean;\n\n  /**\n   * Optional list of services to add to the catalog\n   */\n  services?: Service[];\n\n  /**\n   * Optional domain to add to the catalog and attach the services too\n   */\n  domain?: Domain;\n};\n"],"mappings":";AAyDO,IAAK,aAAL,kBAAKA,gBAAL;AACL,EAAAA,YAAA,aAAU;AACV,EAAAA,YAAA,cAAW;AACX,EAAAA,YAAA,UAAO;AACP,EAAAA,YAAA,UAAO;AACP,EAAAA,YAAA,cAAW;AALD,SAAAA;AAAA,GAAA;","names":["SchemaType"]}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@eventcatalog/generator-apicurio",
+  "version": "0.0.3",
+  "description": "Apicurio Registry generator for EventCatalog",
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest",
+    "format": "prettier --write .",
+    "changeset": "changeset",
+    "format:diff": "prettier --list-different .",
+    "release": "changeset publish"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "Dual License",
+  "devDependencies": {
+    "@types/node": "^20.16.1",
+    "prettier": "^3.3.3",
+    "tsup": "^8.1.0",
+    "typescript": "^5.5.3",
+    "vitest": "^2.0.2"
+  },
+  "files": [
+    "dist",
+    "package.json"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "dependencies": {
+    "@changesets/cli": "^2.27.8",
+    "@eventcatalog/sdk": "^2.8.3",
+    "axios": "^1.8.4",
+    "chalk": "4.1.2",
+    "update-notifier": "^7.3.1"
+  },
+  "peerDependencies": {
+    "@eventcatalog/generator-openapi": ">=7.6.2",
+    "@eventcatalog/generator-asyncapi": ">=5.1.3"
+  },
+  "peerDependenciesMeta": {
+    "@eventcatalog/generator-openapi": {
+      "optional": true
+    },
+    "@eventcatalog/generator-asyncapi": {
+      "optional": true
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/event-catalog/generators",
+    "directory": "packages/generator-apicurio"
+  }
+}