@eventcatalog/create-eventcatalog 3.0.5 → 3.0.7

package/dist/index.js

@@ -22466,7 +22466,7 @@ var import_os2 = __toESM(require("os"));
 var package_default = {
   name: "@eventcatalog/create-eventcatalog",
   description: "Create EventCatalog with one command",
-  version: "3.0.5",
+  version: "3.0.7",
   bin: {
     "create-catalog": "./dist/index.js"
   },
@@ -22582,6 +22582,16 @@ var installTemplate = async ({
   if (template === "openapi") {
     dependencies.push("@eventcatalog/generator-openapi");
   }
+  if (template === "confluent") {
+    dependencies.push("@eventcatalog/generator-confluent-schema-registry");
+  }
+  if (template === "eventbridge") {
+    dependencies.push("@eventcatalog/generator-eventbridge");
+  }
+  if (template === "amazon-apigateway") {
+    dependencies.push("@eventcatalog/generator-amazon-apigateway");
+    dependencies.push("@eventcatalog/generator-openapi");
+  }
   const devDependencies = [];
   if (dependencies.length) {
     console.log();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eventcatalog/create-eventcatalog",
   "description": "Create EventCatalog with one command",
-  "version": "3.0.5",
+  "version": "3.0.7",
   "bin": {
     "create-catalog": "./dist/index.js"
   },

package/templates/amazon-api-gateway/Dockerfile

@@ -0,0 +1,23 @@
+## Stage 1: Build the app
+FROM node:lts AS build
+
+WORKDIR /app
+
+# Install dependencies
+COPY package.json package-lock.json ./
+RUN npm install
+
+# Copy source code
+COPY . .
+
+# Fix for Astro in Docker: https://github.com/withastro/astro/issues/2596
+ENV NODE_OPTIONS=--max_old_space_size=2048
+# Build the app
+RUN npm run build
+
+
+## Stage 2: Serve app with httpd server
+FROM httpd:2.4
+
+# Copy built app to serve
+COPY --from=build /app/dist /usr/local/apache2/htdocs

package/templates/amazon-api-gateway/Dockerfile.server

@@ -0,0 +1,23 @@
+# Use this Docker file if your EventCatalog output is set to `server`.
+# When EventCatalog output is set to `server`, the output will be a node server.
+# This server is required for certain features like the EventCatalog Chat (with your own keys).
+
+FROM node:lts AS runtime
+WORKDIR /app
+
+# Install dependencies
+COPY package.json package-lock.json ./
+RUN npm install
+
+COPY . .
+
+# Fix for Astro in Docker: https://github.com/withastro/astro/issues/2596
+ENV NODE_OPTIONS=--max_old_space_size=2048
+RUN npm run build
+
+ENV HOST=0.0.0.0
+ENV PORT=3000
+EXPOSE 3000
+
+# Start the server
+CMD npm run start

package/templates/amazon-api-gateway/README-template.md

@@ -0,0 +1,31 @@
+# My Amazon API Gateway Event Catalog
+
+Welcome to your new Amazon API Gateway EventCatalog!
+
+Getting started:
+
+1. Edit the `.env` file to configure your environment variables.
+1. Configure the apis in the `eventcatalog.config.js` file 
+2. Run `npm run generate` to import your OpenAPI specs from apigateway and document them.
+3. Run `npm run dev` to start the development server.
+4. Go to localhost:3000 to view your catalog.
+
+### What else can you do?
+
+With the ApiGateway integration you can :
+
+- Document your apis
+- Assign your apis to producers and consumers
+- Assign resources to users and teams in your organization
+- Visualize your APIGateway architecture
+- And much more!
+
+The easiest way to get started and dive deeper is to read the [EventCatalog documentation](https://www.eventcatalog.dev/docs/plugins/amazon-apigateway/intro).
+
+
+### Found a problem?
+
+If you found a problem or have a feature request, please open an issue on [GitHub](https://github.com/event-catalog/generators).
+
+
+

package/templates/amazon-api-gateway/dockerignore

@@ -0,0 +1,8 @@
+.eventcatalog-core/
+.git/
+dist/
+node_modules/
+.gitignore
+.dockerignore
+Dockerfile
+README.md

package/templates/amazon-api-gateway/env

@@ -0,0 +1,4 @@
+
+# Get 14 day trial license key from https://eventcatalog.cloud/
+EVENTCATALOG_LICENSE_KEY_AMAZON_APIGATEWAY=
+EVENTCATALOG_LICENSE_KEY_OPENAPI=

package/templates/amazon-api-gateway/eventcatalog.config.js

@@ -0,0 +1,64 @@
+/** @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 EventBridge schemas, services and domains, and understand the message contracts that connect our infrastructure',
+  organizationName: '<organizationName>',
+  homepageLink: 'https://eventcatalog.dev/',
+  editUrl: 'https://github.com/boyney123/eventcatalog-demo/edit/master',
+  // By default set to false, add true to get urls ending in /
+  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: '/',
+  // Customize the logo, add your logo to public/ folder
+  logo: {
+    alt: 'EventCatalog Logo',
+    src: '/logo.png',
+    text: 'EventCatalog'
+  },
+  // Enable RSS feed for your eventcatalog
+  rss: {
+    enabled: true,
+    // number of items to include in the feed per resource (event, service, etc)
+    limit: 20
+  },
+  docs: {
+    sidebar: {
+      // TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
+      // LIST_VIEW will render the DOCS that look familiar to API documentation websites
+      type: 'LIST_VIEW'
+    },
+  },
+  // required random generated id used by eventcatalog
+  cId: '<cId>',
+  generators: [
+    [
+      "@eventcatalog/generator-amazon-apigateway",
+      {
+        output: 'amazon-api-gateway-output',
+        apis: [
+          {
+            // The name of the API we want to process
+            name: 'EcommerceApi',
+            // Assume it's deployed to us-east-1, change this if you deployed somewhere else
+            region: 'us-east-1',
+            // The API stage name
+            stageName: 'prod',
+            version: '2',
+          }
+        ]
+      },
+    ],
+    // This will process the output of the amazon api gateway generator
+    // it will process the OpenAPI file and map it into a service and domain
+    // All routes are mapped to messages.
+    [
+      "@eventcatalog/generator-openapi",
+      {
+        services: [
+          { path: path.join(__dirname, "amazon-api-gateway-output", "EcommerceApi.json"), id: 'ecommerce-api', owners: ['full-stack'] },
+        ]
+      },
+    ],
+  ],
+}

package/templates/amazon-api-gateway/eventcatalog.styles.css

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

package/templates/amazon-api-gateway/gitignore

@@ -0,0 +1,27 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.astro
+out
+dist
+
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+.eventcatalog-core
+
+.env
+.env-*

package/templates/amazon-api-gateway/npmrc

@@ -0,0 +1 @@
+strict-peer-dependencies=false

package/templates/confluent/Dockerfile

@@ -0,0 +1,23 @@
+## Stage 1: Build the app
+FROM node:lts AS build
+
+WORKDIR /app
+
+# Install dependencies
+COPY package.json package-lock.json ./
+RUN npm install
+
+# Copy source code
+COPY . .
+
+# Fix for Astro in Docker: https://github.com/withastro/astro/issues/2596
+ENV NODE_OPTIONS=--max_old_space_size=2048
+# Build the app
+RUN npm run build
+
+
+## Stage 2: Serve app with httpd server
+FROM httpd:2.4
+
+# Copy built app to serve
+COPY --from=build /app/dist /usr/local/apache2/htdocs

package/templates/confluent/Dockerfile.server

@@ -0,0 +1,23 @@
+# Use this Docker file if your EventCatalog output is set to `server`.
+# When EventCatalog output is set to `server`, the output will be a node server.
+# This server is required for certain features like the EventCatalog Chat (with your own keys).
+
+FROM node:lts AS runtime
+WORKDIR /app
+
+# Install dependencies
+COPY package.json package-lock.json ./
+RUN npm install
+
+COPY . .
+
+# Fix for Astro in Docker: https://github.com/withastro/astro/issues/2596
+ENV NODE_OPTIONS=--max_old_space_size=2048
+RUN npm run build
+
+ENV HOST=0.0.0.0
+ENV PORT=3000
+EXPOSE 3000
+
+# Start the server
+CMD npm run start

package/templates/confluent/README-template.md

@@ -0,0 +1,32 @@
+# My Confluent Event Catalog
+
+Welcome to your new Confluent Event Catalog!
+
+Getting started:
+
+1. Edit the `.env` file to configure your environment variables.
+1. Run Confluent Cloud locally, or configure your `schemaRegistryUrl` in the `eventcatalog.config.js` file 
+2. Run `npm run generate` to import your schemas from confluent schema registry.
+3. Run `npm run dev` to start the development server.
+4. Go to localhost:3000 to view your catalog.
+
+### What else can you do?
+
+With the Confluent Schema Registry integration you can :
+
+- Document your schemas, topics
+- Assign your schemas to producers and consumers
+- Assign resources to users and teams in your organization
+- Visualize your Kafka architecture
+- Add semantic meaning to your schemas and topics
+- And much more!
+
+The easiest way to get started and dive deeper is to read the [Event Catalog documentation](https://eventcatalog.dev/docs/plugins/confluent-schema-registry/intro).
+
+
+### Found a problem?
+
+If you found a problem or have a feature request, please open an issue on [GitHub](https://github.com/event-catalog/generators).
+
+
+

package/templates/confluent/dockerignore

@@ -0,0 +1,8 @@
+.eventcatalog-core/
+.git/
+dist/
+node_modules/
+.gitignore
+.dockerignore
+Dockerfile
+README.md

package/templates/confluent/env

@@ -0,0 +1,7 @@
+
+# Get 14 day trial license key from https://eventcatalog.cloud/
+EVENTCATALOG_LICENSE_KEY_CONFLUENT_SCHEMA_REGISTRY=
+
+# Confluent Schema Registry API Keys (you can get them from Confluent cloud)
+CONFLUENT_SCHEMA_REGISTRY_KEY=
+CONFLUENT_SCHEMA_REGISTRY_KEY_SECRET=

package/templates/confluent/eventcatalog.config.js

@@ -0,0 +1,45 @@
+/** @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 kafka schemas, topics, services and domains, and understand the message contracts that connect our infrastructure',
+  organizationName: '<organizationName>',
+  homepageLink: 'https://eventcatalog.dev/',
+  editUrl: 'https://github.com/boyney123/eventcatalog-demo/edit/master',
+  // By default set to false, add true to get urls ending in /
+  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: '/',
+  // Customize the logo, add your logo to public/ folder
+  logo: {
+    alt: 'EventCatalog Logo',
+    src: '/logo.png',
+    text: 'EventCatalog'
+  },
+  // Enable RSS feed for your eventcatalog
+  rss: {
+    enabled: true,
+    // number of items to include in the feed per resource (event, service, etc)
+    limit: 20
+  },
+  docs: {
+    sidebar: {
+      // TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
+      // LIST_VIEW will render the DOCS that look familiar to API documentation websites
+      type: 'LIST_VIEW'
+    },
+  },
+  // required random generated id used by eventcatalog
+  cId: '<cId>',
+  generators: [
+    [
+      '@eventcatalog/generator-confluent-schema-registry',
+      {
+        // The URL for your schema registry
+        schemaRegistryUrl: 'http://localhost:8081',
+        // This will document all the schemas in the registry, not just the latest version (default is false)
+        includeAllVersions: true
+      },
+    ],
+  ],
+}

package/templates/confluent/eventcatalog.styles.css

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

package/templates/confluent/gitignore

@@ -0,0 +1,27 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.astro
+out
+dist
+
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+.eventcatalog-core
+
+.env
+.env-*

package/templates/confluent/npmrc

@@ -0,0 +1 @@
+strict-peer-dependencies=false

package/templates/eventbridge/Dockerfile

@@ -0,0 +1,23 @@
+## Stage 1: Build the app
+FROM node:lts AS build
+
+WORKDIR /app
+
+# Install dependencies
+COPY package.json package-lock.json ./
+RUN npm install
+
+# Copy source code
+COPY . .
+
+# Fix for Astro in Docker: https://github.com/withastro/astro/issues/2596
+ENV NODE_OPTIONS=--max_old_space_size=2048
+# Build the app
+RUN npm run build
+
+
+## Stage 2: Serve app with httpd server
+FROM httpd:2.4
+
+# Copy built app to serve
+COPY --from=build /app/dist /usr/local/apache2/htdocs

package/templates/eventbridge/Dockerfile.server

@@ -0,0 +1,23 @@
+# Use this Docker file if your EventCatalog output is set to `server`.
+# When EventCatalog output is set to `server`, the output will be a node server.
+# This server is required for certain features like the EventCatalog Chat (with your own keys).
+
+FROM node:lts AS runtime
+WORKDIR /app
+
+# Install dependencies
+COPY package.json package-lock.json ./
+RUN npm install
+
+COPY . .
+
+# Fix for Astro in Docker: https://github.com/withastro/astro/issues/2596
+ENV NODE_OPTIONS=--max_old_space_size=2048
+RUN npm run build
+
+ENV HOST=0.0.0.0
+ENV PORT=3000
+EXPOSE 3000
+
+# Start the server
+CMD npm run start

package/templates/eventbridge/README-template.md

@@ -0,0 +1,31 @@
+# My EventBridge Event Catalog
+
+Welcome to your new EventBridge EventCatalog!
+
+Getting started:
+
+1. Edit the `.env` file to configure your environment variables.
+1. Configure the region and schema registry name in the `eventcatalog.config.js` file 
+2. Run `npm run generate` to import your schemas from confluent schema registry.
+3. Run `npm run dev` to start the development server.
+4. Go to localhost:3000 to view your catalog.
+
+### What else can you do?
+
+With the EventBridge integration you can :
+
+- Document your schemas
+- Assign your schemas to producers and consumers
+- Assign resources to users and teams in your organization
+- Visualize your EventBridge architecture
+- And much more!
+
+The easiest way to get started and dive deeper is to read the [EventCatalog documentation](https://www.eventcatalog.dev/docs/plugins/eventbridge/intro).
+
+
+### Found a problem?
+
+If you found a problem or have a feature request, please open an issue on [GitHub](https://github.com/event-catalog/generators).
+
+
+

package/templates/eventbridge/dockerignore

@@ -0,0 +1,8 @@
+.eventcatalog-core/
+.git/
+dist/
+node_modules/
+.gitignore
+.dockerignore
+Dockerfile
+README.md

package/templates/eventbridge/env

@@ -0,0 +1,3 @@
+
+# Get 14 day trial license key from https://eventcatalog.cloud/
+EVENTCATALOG_LICENSE_KEY_EVENTBRIDGE=

package/templates/eventbridge/eventcatalog.config.js

@@ -0,0 +1,44 @@
+/** @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 EventBridge schemas, services and domains, and understand the message contracts that connect our infrastructure',
+  organizationName: '<organizationName>',
+  homepageLink: 'https://eventcatalog.dev/',
+  editUrl: 'https://github.com/boyney123/eventcatalog-demo/edit/master',
+  // By default set to false, add true to get urls ending in /
+  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: '/',
+  // Customize the logo, add your logo to public/ folder
+  logo: {
+    alt: 'EventCatalog Logo',
+    src: '/logo.png',
+    text: 'EventCatalog'
+  },
+  // Enable RSS feed for your eventcatalog
+  rss: {
+    enabled: true,
+    // number of items to include in the feed per resource (event, service, etc)
+    limit: 20
+  },
+  docs: {
+    sidebar: {
+      // TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
+      // LIST_VIEW will render the DOCS that look familiar to API documentation websites
+      type: 'LIST_VIEW'
+    },
+  },
+  // required random generated id used by eventcatalog
+  cId: '<cId>',
+  // Just import all events into the Catalog from a registry
+  generators: [
+    '@eventcatalog/generator-eventbridge',
+    {
+      // The region of your EventBridge registry
+      region: 'us-east-1',
+      // The name of your EventBridge registry
+      registryName: 'discovered-schemas'
+    },
+  ],
+}

package/templates/eventbridge/eventcatalog.styles.css

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

package/templates/eventbridge/gitignore

@@ -0,0 +1,27 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.astro
+out
+dist
+
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+.eventcatalog-core
+
+.env
+.env-*

package/templates/eventbridge/npmrc

@@ -0,0 +1 @@
+strict-peer-dependencies=false

package/templates/index.ts

@@ -82,6 +82,19 @@ export const installTemplate = async ({
     dependencies.push("@eventcatalog/generator-openapi");
   }
 
+  if (template === "confluent") {
+    dependencies.push("@eventcatalog/generator-confluent-schema-registry");
+  }
+
+  if (template === "eventbridge") {
+    dependencies.push("@eventcatalog/generator-eventbridge");
+  }
+
+  if (template === "amazon-apigateway") {
+    dependencies.push("@eventcatalog/generator-amazon-apigateway");
+    dependencies.push("@eventcatalog/generator-openapi");
+  }
+
   // "@myuser/my-package": "file:../lib"
   const devDependencies = [] as any;
 

package/templates/types.ts

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