@eventcatalog/generator-asyncapi 6.0.1 → 6.1.1

package/dist/index.d.mts

@@ -241,6 +241,7 @@ declare const optionsSchema: z.ZodObject<{
     debug: z.ZodOptional<z.ZodBoolean>;
     parseSchemas: z.ZodOptional<z.ZodBoolean>;
     parseChannels: z.ZodOptional<z.ZodBoolean>;
+    parseExamples: z.ZodOptional<z.ZodBoolean>;
     attachHeadersToSchema: z.ZodOptional<z.ZodBoolean>;
     saveParsedSpecFile: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
@@ -304,6 +305,7 @@ declare const optionsSchema: z.ZodObject<{
     debug?: boolean | undefined;
     parseSchemas?: boolean | undefined;
     parseChannels?: boolean | undefined;
+    parseExamples?: boolean | undefined;
     attachHeadersToSchema?: boolean | undefined;
     saveParsedSpecFile?: boolean | undefined;
 }, {
@@ -367,6 +369,7 @@ declare const optionsSchema: z.ZodObject<{
     debug?: boolean | undefined;
     parseSchemas?: boolean | undefined;
     parseChannels?: boolean | undefined;
+    parseExamples?: boolean | undefined;
     attachHeadersToSchema?: boolean | undefined;
     saveParsedSpecFile?: boolean | undefined;
 }>;

package/dist/index.d.ts

@@ -241,6 +241,7 @@ declare const optionsSchema: z.ZodObject<{
     debug: z.ZodOptional<z.ZodBoolean>;
     parseSchemas: z.ZodOptional<z.ZodBoolean>;
     parseChannels: z.ZodOptional<z.ZodBoolean>;
+    parseExamples: z.ZodOptional<z.ZodBoolean>;
     attachHeadersToSchema: z.ZodOptional<z.ZodBoolean>;
     saveParsedSpecFile: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
@@ -304,6 +305,7 @@ declare const optionsSchema: z.ZodObject<{
     debug?: boolean | undefined;
     parseSchemas?: boolean | undefined;
     parseChannels?: boolean | undefined;
+    parseExamples?: boolean | undefined;
     attachHeadersToSchema?: boolean | undefined;
     saveParsedSpecFile?: boolean | undefined;
 }, {
@@ -367,6 +369,7 @@ declare const optionsSchema: z.ZodObject<{
     debug?: boolean | undefined;
     parseSchemas?: boolean | undefined;
     parseChannels?: boolean | undefined;
+    parseExamples?: boolean | undefined;
     attachHeadersToSchema?: boolean | undefined;
     saveParsedSpecFile?: boolean | undefined;
 }>;

package/dist/index.js

@@ -1543,7 +1543,7 @@ var import_path3 = __toESM(require("path"));
 // package.json
 var package_default = {
   name: "@eventcatalog/generator-asyncapi",
-  version: "6.0.1",
+  version: "6.1.1",
   description: "AsyncAPI generator for EventCatalog",
   scripts: {
     build: "tsup",
@@ -1581,10 +1581,10 @@ var package_default = {
   dependencies: {
     "@asyncapi/avro-schema-parser": "3.0.24",
     "@asyncapi/parser": "3.6.0",
-    "@eventcatalog/sdk": "2.12.1",
+    "@eventcatalog/sdk": "2.17.4",
     chalk: "4.1.2",
     "fs-extra": "^11.2.0",
-    glob: "^11.0.0",
+    glob: "^12.0.0",
     "gray-matter": "^4.0.3",
     "js-yaml": "^4.1.0",
     lodash: "^4.17.23",
@@ -4071,6 +4071,26 @@ Failed to verify license key`));
 // src/index.ts
 var import_node_path = require("path");
 var parser = new import_parser.Parser();
+var safeStringify = (obj, indent) => {
+  const seen = /* @__PURE__ */ new WeakSet();
+  return JSON.stringify(
+    obj,
+    (_key, value) => {
+      if (typeof value === "object" && value !== null) {
+        if (seen.has(value)) {
+          const schemaId = value["x-parser-schema-id"];
+          if (schemaId && typeof schemaId === "string") {
+            return { $ref: `#/components/schemas/${schemaId}` };
+          }
+          return { $ref: "#" };
+        }
+        seen.add(value);
+      }
+      return value;
+    },
+    indent
+  );
+};
 parser.registerSchemaParser((0, import_avro_schema_parser.AvroSchemaParser)());
 var cliArgs = (0, import_minimist.default)(process.argv.slice(2));
 var optionsSchema = import_zod.z.object({
@@ -4139,6 +4159,7 @@ var optionsSchema = import_zod.z.object({
   debug: import_zod.z.boolean().optional(),
   parseSchemas: import_zod.z.boolean().optional(),
   parseChannels: import_zod.z.boolean().optional(),
+  parseExamples: import_zod.z.boolean().optional(),
   attachHeadersToSchema: import_zod.z.boolean().optional(),
   saveParsedSpecFile: import_zod.z.boolean({ invalid_type_error: "The saveParsedSpecFile is not a boolean in options" }).optional()
 });
@@ -4192,7 +4213,10 @@ var index_default = async (config, options) => {
     getSpecificationFilesForService,
     writeChannel,
     getChannel,
-    versionChannel
+    versionChannel,
+    addExampleToEvent,
+    addExampleToCommand,
+    addExampleToQuery
   } = (0, import_sdk.default)(process.env.PROJECT_DIR);
   const MESSAGE_OPERATIONS = {
     event: {
@@ -4200,6 +4224,7 @@ var index_default = async (config, options) => {
       version: versionEvent,
       get: getEvent,
       addSchema: addSchemaToEvent,
+      addExample: addExampleToEvent,
       collection: "events"
     },
     command: {
@@ -4207,6 +4232,7 @@ var index_default = async (config, options) => {
       version: versionCommand,
       get: getCommand,
       addSchema: addSchemaToCommand,
+      addExample: addExampleToCommand,
       collection: "commands"
     },
     query: {
@@ -4214,6 +4240,7 @@ var index_default = async (config, options) => {
       version: versionQuery,
       get: getQuery,
       addSchema: addSchemaToQuery,
+      addExample: addExampleToQuery,
       collection: "queries"
     }
   };
@@ -4223,6 +4250,7 @@ var index_default = async (config, options) => {
     saveParsedSpecFile = false,
     parseSchemas = true,
     parseChannels = false,
+    parseExamples = true,
     attachHeadersToSchema = false
   } = options;
   console.log(import_chalk4.default.green(`Processing ${services.length} AsyncAPI files...`));
@@ -4379,6 +4407,7 @@ Processing domain: ${domainName} (v${domainVersion})`));
           version: versionMessage,
           get: getMessage,
           addSchema: addSchemaToMessage,
+          addExample: addExampleToMessage,
           collection: folder
         } = MESSAGE_OPERATIONS[eventType];
         const generatedMarkdownForMessage = defaultMarkdown(document2, message2);
@@ -4431,13 +4460,27 @@ Processing domain: ${domainName} (v${domainVersion})`));
               messageId,
               {
                 fileName: getSchemaFileName(message2),
-                schema: JSON.stringify(schema, null, 4)
+                schema: safeStringify(schema, 4)
               },
               messageVersion,
               { path: cleanedMessagePath }
             );
             console.log(import_chalk4.default.cyan(` - Schema added to message (v${messageVersion})`));
           }
+          if (parseExamples) {
+            const messageExamples = message2.examples().all();
+            for (let i = 0; i < messageExamples.length; i++) {
+              const example = messageExamples[i];
+              const payload = example.payload();
+              if (payload) {
+                const fileName2 = example.hasName() ? `${example.name()}.json` : `example-${i}.json`;
+                await addExampleToMessage(messageId, { content: JSON.stringify(payload, null, 2), fileName: fileName2 }, messageVersion);
+              }
+            }
+            if (messageExamples.length > 0) {
+              console.log(import_chalk4.default.cyan(` - ${messageExamples.length} example(s) added to message (v${messageVersion})`));
+            }
+          }
         } else {
           console.log(import_chalk4.default.yellow(` - Skipping external message: ${getMessageName(message2)}(v${messageVersion})`));
         }
@@ -4539,7 +4582,7 @@ Finished generating event catalog for AsyncAPI ${serviceId} (v${version})`));
 };
 var getParsedSpecFile = (service, document2) => {
   const isSpecFileJSON = service.path.endsWith(".json");
-  return isSpecFileJSON ? JSON.stringify(document2.meta().asyncapi.parsed, null, 4) : import_js_yaml.default.dump(document2.meta().asyncapi.parsed, { noRefs: true });
+  return isSpecFileJSON ? safeStringify(document2.meta().asyncapi.parsed, 4) : import_js_yaml.default.dump(document2.meta().asyncapi.parsed, { noRefs: true });
 };
 var getRawSpecFile = async (service) => {
   if (service.path.startsWith("http")) {