@eventcatalog/generator-asyncapi 4.5.1 → 4.5.3

package/dist/index.d.mts

@@ -8,6 +8,7 @@ declare const optionsSchema: z.ZodObject<{
         path: z.ZodString;
         draft: z.ZodOptional<z.ZodBoolean>;
         name: z.ZodOptional<z.ZodString>;
+        summary: z.ZodOptional<z.ZodString>;
         owners: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
         generateMarkdown: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
             service: z.ZodObject<{
@@ -47,6 +48,7 @@ declare const optionsSchema: z.ZodObject<{
         id: string;
         draft?: boolean | undefined;
         name?: string | undefined;
+        summary?: string | undefined;
         owners?: string[] | undefined;
         generateMarkdown?: ((args_0: {
             service: {
@@ -62,6 +64,7 @@ declare const optionsSchema: z.ZodObject<{
         id: string;
         draft?: boolean | undefined;
         name?: string | undefined;
+        summary?: string | undefined;
         owners?: string[] | undefined;
         generateMarkdown?: ((args_0: {
             service: {
@@ -198,6 +201,7 @@ declare const optionsSchema: z.ZodObject<{
         id: string;
         draft?: boolean | undefined;
         name?: string | undefined;
+        summary?: string | undefined;
         owners?: string[] | undefined;
         generateMarkdown?: ((args_0: {
             service: {
@@ -248,6 +252,7 @@ declare const optionsSchema: z.ZodObject<{
         id: string;
         draft?: boolean | undefined;
         name?: string | undefined;
+        summary?: string | undefined;
         owners?: string[] | undefined;
         generateMarkdown?: ((args_0: {
             service: {

package/dist/index.d.ts

@@ -8,6 +8,7 @@ declare const optionsSchema: z.ZodObject<{
         path: z.ZodString;
         draft: z.ZodOptional<z.ZodBoolean>;
         name: z.ZodOptional<z.ZodString>;
+        summary: z.ZodOptional<z.ZodString>;
         owners: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
         generateMarkdown: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
             service: z.ZodObject<{
@@ -47,6 +48,7 @@ declare const optionsSchema: z.ZodObject<{
         id: string;
         draft?: boolean | undefined;
         name?: string | undefined;
+        summary?: string | undefined;
         owners?: string[] | undefined;
         generateMarkdown?: ((args_0: {
             service: {
@@ -62,6 +64,7 @@ declare const optionsSchema: z.ZodObject<{
         id: string;
         draft?: boolean | undefined;
         name?: string | undefined;
+        summary?: string | undefined;
         owners?: string[] | undefined;
         generateMarkdown?: ((args_0: {
             service: {
@@ -198,6 +201,7 @@ declare const optionsSchema: z.ZodObject<{
         id: string;
         draft?: boolean | undefined;
         name?: string | undefined;
+        summary?: string | undefined;
         owners?: string[] | undefined;
         generateMarkdown?: ((args_0: {
             service: {
@@ -248,6 +252,7 @@ declare const optionsSchema: z.ZodObject<{
         id: string;
         draft?: boolean | undefined;
         name?: string | undefined;
+        summary?: string | undefined;
         owners?: string[] | undefined;
         generateMarkdown?: ((args_0: {
             service: {

package/dist/index.js

@@ -303,7 +303,7 @@ var import_path3 = __toESM(require("path"));
 // package.json
 var package_default = {
   name: "@eventcatalog/generator-asyncapi",
-  version: "4.5.1",
+  version: "4.5.3",
   description: "AsyncAPI generator for EventCatalog",
   scripts: {
     build: "tsup",
@@ -341,7 +341,7 @@ var package_default = {
   dependencies: {
     "@asyncapi/avro-schema-parser": "^3.0.24",
     "@asyncapi/parser": "^3.4.0",
-    "@eventcatalog/sdk": "^2.6.9",
+    "@eventcatalog/sdk": "^2.7.5",
     chalk: "^4",
     "fs-extra": "^11.2.0",
     glob: "^11.0.0",
@@ -1183,31 +1183,34 @@ var getInstalledVersionOfPackage = (packageName) => {
 async function checkForPackageUpdate(packageName) {
   const installedVersion = getInstalledVersionOfPackage(packageName);
   if (!installedVersion || installedVersion === "latest") return;
-  const pkg = { name: packageName, version: installedVersion };
-  const updateNotifierModule = await import("update-notifier");
-  const notifier = updateNotifierModule.default({ pkg, updateCheckInterval: 0, shouldNotifyInNpmScript: true });
-  const info = await notifier.fetchInfo();
-  if (info?.type !== "latest") {
-    const message2 = `Package ${packageName} update available ${info.current} \u2192 ${info.latest}
+  try {
+    const pkg = { name: packageName, version: installedVersion };
+    const updateNotifierModule = await import("update-notifier");
+    const notifier = updateNotifierModule.default({ pkg, updateCheckInterval: 0, shouldNotifyInNpmScript: true });
+    const info = await notifier.fetchInfo();
+    if (info?.type !== "latest") {
+      const message2 = `Package ${packageName} update available ${info.current} \u2192 ${info.latest}
 Run npm i ${packageName} to update`;
-    console.log(
-      boxen(message2, {
-        padding: 1,
-        margin: 1,
-        align: "center",
-        borderColor: "yellow",
-        borderStyle: {
-          topLeft: " ",
-          topRight: " ",
-          bottomLeft: " ",
-          bottomRight: " ",
-          right: " ",
-          top: "-",
-          bottom: "-",
-          left: " "
-        }
-      })
-    );
+      console.log(
+        boxen(message2, {
+          padding: 1,
+          margin: 1,
+          align: "center",
+          borderColor: "yellow",
+          borderStyle: {
+            topLeft: " ",
+            topRight: " ",
+            bottomLeft: " ",
+            bottomRight: " ",
+            right: " ",
+            top: "-",
+            bottom: "-",
+            left: " "
+          }
+        })
+      );
+    }
+  } catch (error) {
   }
 }
 
@@ -2727,6 +2730,7 @@ var optionsSchema = import_zod.z.object({
       path: import_zod.z.string({ required_error: "The service path is required. please provide the path to specification file" }),
       draft: import_zod.z.boolean().optional(),
       name: import_zod.z.string().optional(),
+      summary: import_zod.z.string().optional(),
       owners: import_zod.z.array(import_zod.z.string()).optional(),
       generateMarkdown: import_zod.z.function().args(
         import_zod.z.object({
@@ -2877,6 +2881,8 @@ var index_default = async (config, options) => {
     let receives = [];
     let owners = service.owners || null;
     let repository = null;
+    let badges = null;
+    let attachments = null;
     let serviceSpecifications = {};
     let serviceSpecificationsFiles = [];
     const generatedMarkdownForService = defaultMarkdown2(document);
@@ -2998,7 +3004,9 @@ Processing domain: ${domainName} (v${domainVersion})`));
         } = MESSAGE_OPERATIONS[eventType];
         const generatedMarkdownForMessage = defaultMarkdown(document, message2);
         let messageMarkdown = options.messages?.generateMarkdown ? options.messages.generateMarkdown({ message: message2, document, markdown: generatedMarkdownForMessage }) : generatedMarkdownForMessage;
-        const badges = message2.tags().all() || [];
+        const badges2 = message2.tags().all() || [];
+        let messageBadges = null;
+        let messageAttachments = null;
         console.log(import_chalk4.default.blue(`Processing message: ${getMessageName(message2)} (v${messageVersion})`));
         let messagePath = (0, import_node_path.join)(servicePath, folder, message2.id());
         if (options.writeFilesToRoot) {
@@ -3008,6 +3016,8 @@ Processing domain: ${domainName} (v${domainVersion})`));
           const catalogedMessage = await getMessage(message2.id().toLowerCase(), "latest");
           if (catalogedMessage) {
             messageMarkdown = catalogedMessage.markdown;
+            messageBadges = catalogedMessage.badges || null;
+            messageAttachments = catalogedMessage.attachments || null;
             if (catalogedMessage.version !== messageVersion) {
               await versionMessage(messageId);
               console.log(import_chalk4.default.cyan(` - Versioned previous message: (v${catalogedMessage.version})`));
@@ -3021,9 +3031,10 @@ Processing domain: ${domainName} (v${domainVersion})`));
               name: getMessageName(message2),
               summary: getSummary(message2),
               markdown: messageMarkdown,
-              badges: badges.map((badge) => ({ content: badge.name(), textColor: "blue", backgroundColor: "blue" })),
+              badges: messageBadges || badges2.map((badge) => ({ content: badge.name(), textColor: "blue", backgroundColor: "blue" })),
               ...messageHasSchema(message2) && { schemaPath: getSchemaFileName(message2) },
               ...owners && { owners },
+              ...messageAttachments && { attachments: messageAttachments },
               ...channelsForMessage.length > 0 && { channels: channelsForMessage },
               ...deprecatedDate && {
                 deprecated: { date: deprecatedDate, ...deprecatedMessage && { message: deprecatedMessage } }
@@ -3065,6 +3076,8 @@ Processing domain: ${domainName} (v${domainVersion})`));
       owners = latestServiceInCatalog.owners || owners;
       repository = latestServiceInCatalog.repository || null;
       styles2 = latestServiceInCatalog.styles || null;
+      badges = latestServiceInCatalog.badges || null;
+      attachments = latestServiceInCatalog.attachments || null;
       if (latestServiceInCatalog.version !== version) {
         await versionService(serviceId);
         console.log(import_chalk4.default.cyan(` - Versioned previous service (v${latestServiceInCatalog.version})`));
@@ -3083,8 +3096,8 @@ Processing domain: ${domainName} (v${domainVersion})`));
         id: serviceId,
         name: serviceName,
         version,
-        summary: getSummary2(document),
-        badges: documentTags.map((tag2) => ({ content: tag2.name(), textColor: "blue", backgroundColor: "blue" })),
+        summary: service.summary || getSummary2(document),
+        badges: badges || documentTags.map((tag2) => ({ content: tag2.name(), textColor: "blue", backgroundColor: "blue" })),
         markdown: serviceMarkdown,
         sends,
         receives,
@@ -3096,7 +3109,8 @@ Processing domain: ${domainName} (v${domainVersion})`));
         ...owners && { owners },
         ...repository && { repository },
         ...styles2 && { styles: styles2 },
-        ...isServiceMarkedAsDraft && { draft: true }
+        ...isServiceMarkedAsDraft && { draft: true },
+        ...attachments && { attachments }
       },
       {
         path: servicePath,