@eventcatalog/create-eventcatalog 4.1.2 → 4.2.0-beta.0

package/templates/index.ts

@@ -1,22 +1,18 @@
-import { copy } from "../helpers/copy";
-import { install } from "../helpers/install";
+import { copy } from '../helpers/copy';
+import { install } from '../helpers/install';
 
-import os from "os";
-import fs from "fs";
-import path from "path";
-import { v4 } from 'uuid'
+import os from 'os';
+import fs from 'fs';
+import path from 'path';
+import { v4 } from 'uuid';
 
-import { GetTemplateFileArgs, InstallTemplateArgs } from "./types";
-import { raiseEvent } from "./analytics";
+import { GetTemplateFileArgs, InstallTemplateArgs } from './types';
+import { raiseEvent } from './analytics';
 
 /**
  * Get the file path for a given file in a template, e.g. "next.config.js".
  */
-export const getTemplateFile = ({
-  template,
-  mode,
-  file,
-}: GetTemplateFileArgs): string => {
+export const getTemplateFile = ({ template, mode, file }: GetTemplateFileArgs): string => {
   return path.join(__dirname, template, mode, file);
 };
 
@@ -31,32 +27,29 @@ export const installTemplate = async ({
   template,
   mode,
   eslint,
-  organizationName
+  organizationName,
 }: InstallTemplateArgs) => {
   /**
    * Create a package.json for the new project
    */
   const packageJson = {
     name: appName,
-    version: "0.1.0",
+    version: '0.1.0',
     private: true,
     scripts: {
-      dev: "eventcatalog dev",
-      build: "eventcatalog build",
-      start: "eventcatalog start",
-      preview: "eventcatalog preview",
-      generate: "eventcatalog generate",
-      lint: "eventcatalog-linter",
+      dev: 'eventcatalog dev',
+      build: 'eventcatalog build',
+      start: 'eventcatalog start',
+      preview: 'eventcatalog preview',
+      generate: 'eventcatalog generate',
+      lint: 'eventcatalog-linter',
       test: 'echo "Error: no test specified" && exit 1',
-    }
+    },
   };
   /**
    * Write it to disk.
    */
-  fs.writeFileSync(
-    path.join(root, "package.json"),
-    JSON.stringify(packageJson, null, 2) + os.EOL,
-  );
+  fs.writeFileSync(path.join(root, 'package.json'), JSON.stringify(packageJson, null, 2) + os.EOL);
   /**
    * These flags will be passed to `install()`, which calls the package manager
    * install process.
@@ -67,35 +60,32 @@ export const installTemplate = async ({
    * Default dependencies.
    */
   // const dependencies = ["@eventcatalog/eventcatalog-2"];
-  const dependencies = [
-    "@eventcatalog/core",
-    "@eventcatalog/linter"
-  ] as any;
+  const dependencies = ['@eventcatalog/core', '@eventcatalog/linter'] as any;
 
   // if asyncapi is selected, add the asyncapi dependencies
-  if (template === "asyncapi") {
-    dependencies.push("@eventcatalog/generator-asyncapi");
+  if (template === 'asyncapi') {
+    dependencies.push('@eventcatalog/generator-asyncapi');
   }
 
-  if (template === "openapi") {
-    dependencies.push("@eventcatalog/generator-openapi");
+  if (template === 'openapi') {
+    dependencies.push('@eventcatalog/generator-openapi');
   }
 
-  if (template === "graphql") {
-    dependencies.push("@eventcatalog/generator-graphql");
+  if (template === 'graphql') {
+    dependencies.push('@eventcatalog/generator-graphql');
   }
 
-  if (template === "confluent") {
-    dependencies.push("@eventcatalog/generator-confluent-schema-registry");
+  if (template === 'confluent') {
+    dependencies.push('@eventcatalog/generator-confluent-schema-registry');
   }
 
-  if (template === "eventbridge") {
-    dependencies.push("@eventcatalog/generator-eventbridge");
+  if (template === 'eventbridge') {
+    dependencies.push('@eventcatalog/generator-eventbridge');
   }
 
-  if (template === "amazon-apigateway") {
-    dependencies.push("@eventcatalog/generator-amazon-apigateway");
-    dependencies.push("@eventcatalog/generator-openapi");
+  if (template === 'amazon-apigateway') {
+    dependencies.push('@eventcatalog/generator-amazon-apigateway');
+    dependencies.push('@eventcatalog/generator-openapi');
   }
 
   // "@myuser/my-package": "file:../lib"
@@ -115,24 +105,24 @@ export const installTemplate = async ({
   /**
    * Copy the template files to the target directory.
    */
-  const templatePath = path.join(__dirname, "../templates", template);
+  const templatePath = path.join(__dirname, '../templates', template);
   // console.log("templatePath", templatePath, __dirname, template);
-  await copy("**", root, {
+  await copy('**', root, {
     parents: true,
     cwd: templatePath,
     rename: (name) => {
       switch (name) {
-        case "env":
-        case "gitignore":
-        case "npmrc":
-        case "dockerignore":
-        case "eslintrc.json": {
-          return ".".concat(name);
+        case 'env':
+        case 'gitignore':
+        case 'npmrc':
+        case 'dockerignore':
+        case 'eslintrc.json': {
+          return '.'.concat(name);
         }
         // README.md is ignored by webpack-asset-relocator-loader used by ncc:
         // https://github.com/vercel/webpack-asset-relocator-loader/blob/e9308683d47ff507253e37c9bcbb99474603192b/src/asset-relocator.js#L227
-        case "README-template.md": {
-          return "README.md";
+        case 'README-template.md': {
+          return 'README.md';
         }
         default: {
           return name;
@@ -144,18 +134,18 @@ export const installTemplate = async ({
   const cId = v4();
 
   // update the properties in the eventcatalog.config.js
-  const eventCatalogConfigPath = path.join(root, "eventcatalog.config.js");
-  let eventCatalogConfig = fs.readFileSync(eventCatalogConfigPath, "utf8");
-  eventCatalogConfig = eventCatalogConfig.replace( /<organizationName>/g, organizationName );
-  eventCatalogConfig = eventCatalogConfig.replace( /<cId>/g, cId );
+  const eventCatalogConfigPath = path.join(root, 'eventcatalog.config.js');
+  let eventCatalogConfig = fs.readFileSync(eventCatalogConfigPath, 'utf8');
+  eventCatalogConfig = eventCatalogConfig.replace(/<organizationName>/g, organizationName);
+  eventCatalogConfig = eventCatalogConfig.replace(/<cId>/g, cId);
   fs.writeFileSync(eventCatalogConfigPath, eventCatalogConfig);
 
   await raiseEvent({ command: 'create', org: organizationName, cId });
 
   if (!eslint) {
     // remove un-necessary template file if eslint is not desired
-    await fs.promises.unlink(path.join(root, ".eslintrc.json"));
+    await fs.promises.unlink(path.join(root, '.eslintrc.json'));
   }
 };
 
-export * from "./types";
+export * from './types';

package/templates/openapi/eventcatalog.auth.js

@@ -1,13 +1,12 @@
-
 /**
  * This is an optional file that can add authentication to your EventCatalog.
- * 
+ *
  * To enable authentication you need to set `server:output` in your `eventcatalog.config.js` file.
  * And then pick which provider you want to use.
- * 
+ *
  * You can read more in the documentation:
  * https://www.eventcatalog.dev/docs/development/guides/authentication/introduction
- * 
+ *
  */
 
 // export default {
@@ -42,4 +41,4 @@
 //       issuer: process.env.AUTH_OKTA_ISSUER,
 //     },
 //   },
-// }
+// }

package/templates/openapi/eventcatalog.config.js

@@ -1,15 +1,16 @@
-import path from "path";
-import url from "url";
+import path from 'path';
+import url from 'url';
 
 const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
 
 /** @type {import('@eventcatalog/core/bin/eventcatalog.config').Config} */
 export default {
-  title: "EventCatalog",
-  tagline: 'This internal platform provides a comprehensive view of our event-driven architecture across all systems. Use this portal to discover existing domains, explore services and their dependencies, and understand the message contracts that connect our infrastructure',
+  title: 'EventCatalog',
+  tagline:
+    'This internal platform provides a comprehensive view of our event-driven architecture across all systems. Use this portal to discover existing domains, explore services and their dependencies, and understand the message contracts that connect our infrastructure',
   organizationName: '<organizationName>',
-  homepageLink: "https://eventcatalog.dev/",
-  editUrl: "https://github.com/boyney123/eventcatalog-demo/edit/master",
+  homepageLink: 'https://eventcatalog.dev/',
+  editUrl: 'https://github.com/boyney123/eventcatalog-demo/edit/master',
   // Supports static or server. Static renders a static site, server renders a server side rendered site
   // large catalogs may benefit from server side rendering
   output: 'static',
@@ -17,19 +18,17 @@ export default {
   trailingSlash: false,
   // Change to make the base url of the site different, by default https://{website}.com/docs,
   // changing to /company would be https://{website}.com/company/docs,
-  base: "/",
+  base: '/',
   // Customize the navigation for your docs sidebar.
   // read more at https://eventcatalog.dev/docs/development/customization/customize-sidebars/documentation-sidebar
   navigation: {
-    pages: [
-      'list:all',
-    ]
+    pages: ['list:all'],
   },
   // Customize the logo, add your logo to public/ folder
   logo: {
-    alt: "EventCatalog Logo",
-    src: "/logo.png",
-    text: "EventCatalog",
+    alt: 'EventCatalog Logo',
+    src: '/logo.png',
+    text: 'EventCatalog',
   },
   // This lets you copy markdown contents from EventCatalog to your clipboard
   // Including schemas for your events and services
@@ -38,38 +37,46 @@ export default {
   },
   generators: [
     [
-      "@eventcatalog/generator-openapi",
+      '@eventcatalog/generator-openapi',
       {
         services: [
-          { path: path.join(__dirname, "openapi-files", "product-api.yml"), id: 'product-service', owners: ['product-management'] },
+          {
+            path: path.join(__dirname, 'openapi-files', 'product-api.yml'),
+            id: 'product-service',
+            owners: ['product-management'],
+          },
         ],
-        domain: { id: "products", name: "Products", version: "0.0.1" },
+        domain: { id: 'products', name: 'Products', version: '0.0.1' },
       },
     ],
     [
-      "@eventcatalog/generator-openapi",
+      '@eventcatalog/generator-openapi',
       {
         services: [
-          { path: path.join(__dirname, "openapi-files", "order-api.yml"), id: 'order-service', owners: ['order-management'] },
-          { path: path.join(__dirname, "openapi-files", "order-history.yml"), id: 'order-history', owners: ['order-management'] },
+          { path: path.join(__dirname, 'openapi-files', 'order-api.yml'), id: 'order-service', owners: ['order-management'] },
+          { path: path.join(__dirname, 'openapi-files', 'order-history.yml'), id: 'order-history', owners: ['order-management'] },
         ],
         domain: {
-          id: "order-management",
-          name: "Order management",
-          version: "0.0.1",
+          id: 'order-management',
+          name: 'Order management',
+          version: '0.0.1',
         },
       },
     ],
     [
-      "@eventcatalog/generator-openapi",
+      '@eventcatalog/generator-openapi',
       {
         services: [
-          { path: path.join(__dirname, "openapi-files", "payment-api.yml"), id: 'payment-service', owners: ['payment-management'] },
+          {
+            path: path.join(__dirname, 'openapi-files', 'payment-api.yml'),
+            id: 'payment-service',
+            owners: ['payment-management'],
+          },
         ],
-        domain: { id: "payment", name: "Payment", version: "0.0.1" },
+        domain: { id: 'payment', name: 'Payment', version: '0.0.1' },
       },
     ],
   ],
   // required random generated id used by eventcatalog
-  cId: '<cId>'
+  cId: '<cId>',
 };

package/templates/openapi/eventcatalog.styles.css

@@ -1 +1 @@
-/* Custom styling support coming soon. */
+/* Custom styling support coming soon. */

package/templates/openapi/teams/order-management.mdx

@@ -3,11 +3,11 @@ id: order-management
 name: Order Management
 summmary: Order Management team based in London, UK
 members:
-    - dboyne
-    - asmith
-    - msmith
-    - alee
-    - azhang
+  - dboyne
+  - asmith
+  - msmith
+  - alee
+  - azhang
 email: test@test.com
 slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
 ---
@@ -28,4 +28,4 @@ The Order Management team is responsible for managing orders, inventory, shipmen
 
 - David Boyne
 - Alice Smith
-- Mike Smith
+- Mike Smith

package/templates/openapi/teams/payment-management.mdx

@@ -2,9 +2,9 @@
 id: payment-management
 name: Payment Management
 members:
-    - dboyne
-    - jbrown
-    - dkim
+  - dboyne
+  - jbrown
+  - dkim
 ---
 
 The payment management team is responsible for managing payments and payment accounts.
@@ -15,4 +15,4 @@ The payment management team is responsible for managing payments and payment acc
 - Manage payment and payment account provisioning
 - Manage payment and payment account deprovisioning
 - Manage user and user account password management
-- Manage user and user account role management
+- Manage user and user account role management

package/templates/openapi/teams/product-management.mdx

@@ -2,9 +2,9 @@
 id: product-management
 name: Product Management
 members:
-    - dboyne
-    - jbrown
-    - dkim
+  - dboyne
+  - jbrown
+  - dkim
 ---
 
 The product management team is responsible for managing products and product accounts.
@@ -15,4 +15,4 @@ The product management team is responsible for managing products and product acc
 - Manage product and product account provisioning
 - Manage product and product account deprovisioning
 - Manage product and product account password management
-- Manage product and product account role management
+- Manage product and product account role management

package/templates/openapi/users/aSmith.mdx

@@ -24,4 +24,3 @@ As the Product Owner for Full Stackers, my role involves a wide range of respons
 My mission is to deliver products that not only meet but exceed customer expectations. I thrive on the challenge of translating complex requirements into simple, intuitive solutions.
 
 If you’re interested in product management, user experience, or discussing the latest trends in technology, feel free to reach out!
-

package/templates/openapi/users/alee.mdx

@@ -5,4 +5,4 @@ avatarUrl: https://randomuser.me/api/portraits/women/91.jpg
 role: Technical Writer
 ---
 
-As a Technical Writer on the Documentation team, I create clear, comprehensive documentation for our products and APIs. My focus is on making complex technical concepts accessible to developers and end-users alike. I collaborate with engineering teams to ensure our documentation stays current and accurate. 
+As a Technical Writer on the Documentation team, I create clear, comprehensive documentation for our products and APIs. My focus is on making complex technical concepts accessible to developers and end-users alike. I collaborate with engineering teams to ensure our documentation stays current and accurate.

package/templates/openapi/users/azhang.mdx

@@ -8,4 +8,4 @@ slackDirectMessageUrl: https://yourteam.slack.com/channels/azhang
 msTeamsDirectMessageUrl: https://teams.microsoft.com/l/chat/0/0?users=azhang@company.com
 ---
 
-Building and maintaining data pipelines and infrastructure... 
+Building and maintaining data pipelines and infrastructure...

package/templates/openapi/users/dboyne.mdx

@@ -1,7 +1,7 @@
 ---
 id: dboyne
 name: David Boyne
-avatarUrl: "https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png"
+avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png'
 role: Lead developer
 email: test@test.com
 slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
@@ -28,5 +28,6 @@ I am passionate about leveraging the power of events to build systems that are n
 Feel free to connect with me to discuss all things tech, event-driven architectures, or to exchange ideas on building better software systems!
 
 ---
-*David Boyne*
-*Tech Lead, Full Stackers*
+
+_David Boyne_
+_Tech Lead, Full Stackers_

package/templates/openapi/users/dkim.mdx

@@ -8,4 +8,4 @@ slackDirectMessageUrl: https://yourteam.slack.com/channels/dkim
 msTeamsDirectMessageUrl: https://teams.microsoft.com/l/chat/0/0?users=dkim@company.com
 ---
 
-Optimizing application performance and user experience... 
+Optimizing application performance and user experience...

package/templates/openapi/users/jbrown.mdx

@@ -8,4 +8,4 @@ slackDirectMessageUrl: https://yourteam.slack.com/channels/jbrown
 msTeamsDirectMessageUrl: https://teams.microsoft.com/l/chat/0/0?users=jbrown@company.com
 ---
 
-Creating intuitive and engaging user interfaces... 
+Creating intuitive and engaging user interfaces...

package/templates/openapi/users/mSmith.mdx

@@ -1,8 +1,8 @@
 ---
 id: msmith
 name: Martin Smith
-avatarUrl: "https://randomuser.me/api/portraits/men/51.jpg"
+avatarUrl: 'https://randomuser.me/api/portraits/men/51.jpg'
 role: Senior software engineer
 ---
 
-As a Senior Mobile Developer on The Mobile Devs team, I play a key role in designing, developing, and maintaining our company’s mobile applications. My focus is on creating a seamless and intuitive user experience for our customers on both iOS and Android platforms. I work closely with cross-functional teams, including backend developers, UX/UI designers, and product managers, to deliver high-quality mobile solutions that meet business objectives and exceed user expectations.
+As a Senior Mobile Developer on The Mobile Devs team, I play a key role in designing, developing, and maintaining our company’s mobile applications. My focus is on creating a seamless and intuitive user experience for our customers on both iOS and Android platforms. I work closely with cross-functional teams, including backend developers, UX/UI designers, and product managers, to deliver high-quality mobile solutions that meet business objectives and exceed user expectations.

package/templates/types.ts

@@ -1,7 +1,16 @@
-import { PackageManager } from "../helpers/get-pkg-manager";
+import { PackageManager } from '../helpers/get-pkg-manager';
 
-export type TemplateType = "default" | "app" | "empty" | "asyncapi" | "openapi" | "confluent" | "eventbridge" | "amazon-apigateway" | "graphql";
-export type TemplateMode = "js" | "ts";
+export type TemplateType =
+  | 'default'
+  | 'app'
+  | 'empty'
+  | 'asyncapi'
+  | 'openapi'
+  | 'confluent'
+  | 'eventbridge'
+  | 'amazon-apigateway'
+  | 'graphql';
+export type TemplateMode = 'js' | 'ts';
 
 export interface GetTemplateFileArgs {
   template: TemplateType;