@eventcatalog/create-eventcatalog 1.2.1 → 2.0.0

package/templates/default/services/NotificationService/index.md

@@ -0,0 +1,36 @@
+---
+id: NotificationService
+version: 0.0.2
+name: Notifications
+summary: |
+  Service that handles orders
+owners:
+    - dboyne
+receives:
+  - id: InventoryAdjusted
+    version: 0.0.1
+repository:
+  language: JavaScript
+  url: https://github.com/boyney123/pretend-shipping-service
+---
+
+## Overview
+
+The Notification Service is responsible for managing and delivering notifications to users and other services. It supports various notification channels such as email, SMS, push notifications, and in-app notifications. The service ensures reliable and timely delivery of messages and integrates with other services to trigger notifications based on specific events.
+
+## Architecture diagram
+
+<NodeGraph />
+
+## Core Concepts
+
+<AccordionGroup>
+  <Accordion title="Notification">
+    - Description: A message that is sent to a user or a service.
+    - Attributes: notificationId, type, recipient, content, channel, status, timestamp
+  </Accordion>
+  <Accordion title="Channel">
+    - Description: The medium through which the notification is delivered (e.g., email, SMS, push notification).
+    - Attributes: channelId, name, provider, configuration 
+  </Accordion>
+</AccordionGroup>

package/templates/default/services/OrdersService/index.md

@@ -0,0 +1,29 @@
+---
+id: OrdersService
+version: 0.0.2
+name: Orders Service
+summary: |
+  Service that handles orders
+owners:
+    - dboyne
+receives:
+  - id: InventoryAdjusted
+    version: 0.0.3
+sends:
+  - id: AddInventory  
+    version: 0.0.3
+repository:
+  language: JavaScript
+  url: https://github.com/boyney123/pretend-shipping-service
+schemaPath: "openapi.yml"
+---
+
+## Overview
+
+The Orders Service is responsible for managing customer orders within the system. It handles order creation, updating, status tracking, and interactions with other services such as Inventory, Payment, and Notification services to ensure smooth order processing and fulfillment.
+
+<OpenAPI />
+
+## Architecture diagram 
+
+<NodeGraph />

package/templates/default/services/OrdersService/openapi.yml

@@ -0,0 +1,170 @@
+openapi: "3.0.0"
+info:
+  title: Simple API overview
+  version: 2.0.0
+paths:
+  /:
+    get:
+      operationId: listVersionsv2
+      summary: List API versions
+      responses:
+        '200':
+          description: |-
+            200 response
+          content:
+            application/json:
+              examples: 
+                foo:
+                  value:
+                    {
+                      "versions": [
+                        {
+                            "status": "CURRENT",
+                            "updated": "2011-01-21T11:33:21Z",
+                            "id": "v2.0",
+                            "links": [
+                                {
+                                    "href": "http://127.0.0.1:8774/v2/",
+                                    "rel": "self"
+                                }
+                            ]
+                        },
+                        {
+                            "status": "EXPERIMENTAL",
+                            "updated": "2013-07-23T11:33:21Z",
+                            "id": "v3.0",
+                            "links": [
+                                {
+                                    "href": "http://127.0.0.1:8774/v3/",
+                                    "rel": "self"
+                                }
+                            ]
+                        }
+                      ]
+                    }
+        '300':
+          description: |-
+            300 response
+          content:
+            application/json: 
+              examples: 
+                foo:
+                  value: |
+                   {
+                    "versions": [
+                          {
+                            "status": "CURRENT",
+                            "updated": "2011-01-21T11:33:21Z",
+                            "id": "v2.0",
+                            "links": [
+                                {
+                                    "href": "http://127.0.0.1:8774/v2/",
+                                    "rel": "self"
+                                }
+                            ]
+                        },
+                        {
+                            "status": "EXPERIMENTAL",
+                            "updated": "2013-07-23T11:33:21Z",
+                            "id": "v3.0",
+                            "links": [
+                                {
+                                    "href": "http://127.0.0.1:8774/v3/",
+                                    "rel": "self"
+                                }
+                            ]
+                        }
+                    ]
+                   }
+  /v2:
+    get:
+      operationId: getVersionDetailsv2
+      summary: Show API version details
+      responses:
+        '200':
+          description: |-
+            200 response
+          content:
+            application/json: 
+              examples:
+                foo:
+                  value:
+                    {
+                      "version": {
+                        "status": "CURRENT",
+                        "updated": "2011-01-21T11:33:21Z",
+                        "media-types": [
+                          {
+                              "base": "application/xml",
+                              "type": "application/vnd.openstack.compute+xml;version=2"
+                          },
+                          {
+                              "base": "application/json",
+                              "type": "application/vnd.openstack.compute+json;version=2"
+                          }
+                        ],
+                        "id": "v2.0",
+                        "links": [
+                          {
+                              "href": "http://127.0.0.1:8774/v2/",
+                              "rel": "self"
+                          },
+                          {
+                              "href": "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf",
+                              "type": "application/pdf",
+                              "rel": "describedby"
+                          },
+                          {
+                              "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl",
+                              "type": "application/vnd.sun.wadl+xml",
+                              "rel": "describedby"
+                          },
+                          {
+                            "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl",
+                            "type": "application/vnd.sun.wadl+xml",
+                            "rel": "describedby"
+                          }
+                        ]
+                      }
+                    }
+        '203':
+          description: |-
+            203 response
+          content:
+            application/json: 
+              examples:
+                foo:
+                  value:
+                    {
+                      "version": {
+                        "status": "CURRENT",
+                        "updated": "2011-01-21T11:33:21Z",
+                        "media-types": [
+                          {
+                              "base": "application/xml",
+                              "type": "application/vnd.openstack.compute+xml;version=2"
+                          },
+                          {
+                              "base": "application/json",
+                              "type": "application/vnd.openstack.compute+json;version=2"
+                          }
+                        ],
+                        "id": "v2.0",
+                        "links": [
+                          {
+                              "href": "http://23.253.228.211:8774/v2/",
+                              "rel": "self"
+                          },
+                          {
+                              "href": "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf",
+                              "type": "application/pdf",
+                              "rel": "describedby"
+                          },
+                          {
+                              "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl",
+                              "type": "application/vnd.sun.wadl+xml",
+                              "rel": "describedby"
+                          }
+                        ]
+                      }
+                    }

package/templates/default/services/PaymentService/index.md

@@ -0,0 +1,31 @@
+---
+id: PaymentService
+name: Payment Service
+version: 0.0.1
+summary: |
+  Service that handles payments
+owners:
+    - dboyne
+receives:
+  - id: PaymentInitiated
+    version: 0.0.1
+sends:
+  - id: PaymentProcessed
+    version: 0.0.1
+repository:
+  language: JavaScript
+  url: https://github.com/boyney123/pretend-shipping-service
+---
+
+The Payment Service is a crucial component of our system that handles all payment-related operations. It processes payments, manages transactions, and communicates with other services through events. Using an event-driven architecture, it ensures that all actions are asynchronous, decoupled, and scalable.
+
+<NodeGraph />
+
+### Key Components
+- Payment API: Exposes endpoints for initiating payments and querying payment status.
+- Payment Processor: Handles the core payment processing logic.
+- Event Bus: Manages the communication between services using events.
+- Payment Gateway: Interfaces with external payment providers.
+- Transaction Service: Manages transaction records and states.
+- Notification Service: Sends notifications related to payment status changes.
+- Database: Stores transaction data and payment status.

package/templates/default/teams/full-stack.md

@@ -0,0 +1,26 @@
+---
+id: full-stack
+name: Full stackers
+summmary: Full stack developers based in London, UK
+members:
+    - dboyne
+    - asmith
+    - msmith
+email: test@test.com
+slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
+---
+
+## Overview
+
+The Full Stack Team is responsible for developing and maintaining both the front-end and back-end components of our applications. This team ensures that the user interfaces are intuitive and responsive, and that the server-side logic and database interactions are efficient and secure. The Full Stack Team handles the entire lifecycle of web applications, from initial development to deployment and ongoing maintenance.
+
+## Responsibilities
+
+### Key Responsibilities
+- **Front-End Development**: Design and implement user interfaces using modern web technologies (e.g., HTML, CSS, JavaScript, React).
+- **Back-End Development**: Develop and maintain server-side logic, APIs, and database interactions (e.g., Node.js, Express, SQL/NoSQL databases).
+- **Integration**: Ensure seamless communication between the front-end and back-end components.
+- **Performance Optimization**: Optimize the performance and scalability of web applications.
+- **Testing and Debugging**: Write and maintain unit, integration, and end-to-end tests to ensure the quality and reliability of the applications.
+- **Deployment**: Manage the deployment of applications to production environments using CI/CD pipelines.
+

package/templates/default/teams/mobile-devs.md

@@ -0,0 +1,20 @@
+---
+id: mobile-devs
+name: The mobile devs
+members:
+    - dboyne
+---
+
+The Mobile Devs team is responsible for the development and maintenance of the mobile applications for our company. This includes the iOS and Android apps that customers use to interact with our services, make purchases, and manage their accounts. The team ensures that the mobile apps are user-friendly, secure, and performant.
+
+## Responsibilities
+
+### 1. Mobile Application Development
+- **Platform Support**: Developing and maintaining apps for iOS and Android platforms.
+- **Feature Implementation**: Implementing new features based on product requirements and user feedback.
+- **User Interface Design**: Ensuring a consistent and intuitive user interface across all mobile platforms.
+- **Performance Optimization**: Optimizing the performance of mobile apps to ensure fast and smooth user experiences.
+
+### 2. Integration with Backend Services
+- **API Integration**: Integrating mobile apps with backend services using RESTful APIs and other communication protocols.
+- **Real-time Updates**: Implementing real-time data updates and synchronization with backend services.

package/templates/default/users/aSmith.md

@@ -0,0 +1,27 @@
+---
+id: asmith
+name: Amy Smith
+avatarUrl: https://randomuser.me/api/portraits/women/48.jpg
+role: Product owner
+---
+
+Hello! I'm Amy Smith, the Product Owner of the innovative Full Stackers team. With a strong focus on delivering exceptional value, I specialize in connecting business objectives with technical solutions to create products that users love.
+
+### About Me
+
+With a comprehensive background in product management and a solid understanding of software development, I bring a unique perspective to the table. My career has been driven by a passion for understanding user needs, defining clear product visions, and leading teams to successful product deliveries.
+
+### What I Do
+
+As the Product Owner for Full Stackers, my role involves a wide range of responsibilities aimed at ensuring our products are both high-quality and user-centric. Key aspects of my role include:
+
+- **Product Vision & Strategy**: Defining and communicating the long-term vision and strategy for our products, ensuring alignment with the company's objectives and market demands.
+- **Roadmap Planning**: Developing and maintaining a product roadmap that highlights key features and milestones, prioritizing tasks based on their business value and user feedback.
+- **Stakeholder Management**: Engaging with stakeholders across the organization to gather requirements, provide updates, and ensure everyone is aligned on the product's direction.
+- **User-Centric Design**: Championing the end-users by conducting user research, analyzing feedback, and ensuring our products effectively solve their problems.
+- **Agile Leadership**: Leading the development process using Agile methodologies, facilitating sprint planning, and ensuring the team has clear priorities and objectives.
+
+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/default/users/dboyne.md

@@ -0,0 +1,32 @@
+---
+id: dboyne
+name: David Boyne
+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
+---
+
+Hello! I'm David Boyne, the Tech Lead of an amazing team called Full Stackers. With a passion for building robust and scalable systems, I specialize in designing and implementing event-driven architectures that power modern, responsive applications.
+
+### About Me
+
+With over a decade of experience in the tech industry, I have honed my skills in full-stack development, cloud computing, and distributed systems. My journey has taken me through various roles, from software engineer to architect, and now as a tech lead, I am committed to driving innovation and excellence within my team.
+
+### What I Do
+
+At Full Stackers, we focus on creating seamless and efficient event-driven architectures that enhance the performance and scalability of our applications. My role involves:
+
+- **Architecture Design**: Crafting scalable and resilient system architectures using event-driven paradigms.
+- **Team Leadership**: Guiding a talented team of developers, fostering a collaborative and innovative environment.
+- **Code Reviews & Mentorship**: Ensuring code quality and sharing knowledge to help the team grow.
+- **Stakeholder Collaboration**: Working closely with other teams and stakeholders to align our technical solutions with business goals.
+- **Continuous Improvement**: Advocating for best practices in software development, deployment, and monitoring.
+
+I am passionate about leveraging the power of events to build systems that are not only highly responsive but also easier to maintain and extend. In an ever-evolving tech landscape, I strive to stay ahead of the curve, continuously learning and adapting to new technologies and methodologies.
+
+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*

package/templates/default/users/mSmith.md

@@ -0,0 +1,8 @@
+---
+id: msmith
+name: Martin Smith
+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.

package/templates/index.ts

@@ -0,0 +1,137 @@
+import { copy } from "../helpers/copy";
+import { install } from "../helpers/install";
+
+import os from "os";
+import fs from "fs";
+import path from "path";
+import chalk from "chalk";
+
+import { GetTemplateFileArgs, InstallTemplateArgs } from "./types";
+
+/**
+ * Get the file path for a given file in a template, e.g. "next.config.js".
+ */
+export const getTemplateFile = ({
+  template,
+  mode,
+  file,
+}: GetTemplateFileArgs): string => {
+  return path.join(__dirname, template, mode, file);
+};
+
+/**
+ * Install a Next.js internal template to a given `root` directory.
+ */
+export const installTemplate = async ({
+  appName,
+  root,
+  packageManager,
+  isOnline,
+  template,
+  mode,
+  eslint,
+}: InstallTemplateArgs) => {
+  console.log(chalk.bold(`Using ${packageManager}.`));
+
+  /**
+   * Create a package.json for the new project
+   */
+  const packageJson = {
+    name: appName,
+    version: "0.1.0",
+    private: true,
+    scripts: {
+      start: "eventcatalog start",
+      dev: "eventcatalog dev",
+      build: "eventcatalog build",
+      generate: "eventcatalog generate",
+      test: 'echo "Error: no test specified" && exit 1',
+    },
+    dependencies: {
+      "@eventcatalogtest/core-test": "latest"
+    }
+  };
+  /**
+   * Write it to disk.
+   */
+  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.
+   */
+  const installFlags = { packageManager, isOnline };
+
+  /**
+   * Default dependencies.
+   */
+  // const dependencies = ["@eventcatalog/eventcatalog-2"];
+  const dependencies = [] as any;
+  // "@myuser/my-package": "file:../lib"
+  const devDependencies = [
+    "@parcel/watcher",
+    "concurrently",
+  ] as any;
+
+  /**
+   * Install package.json dependencies if they exist.
+   */
+  if (dependencies.length) {
+    console.log();
+    console.log("Installing dependencies:");
+    for (const dependency of dependencies) {
+      console.log(`- ${chalk.cyan(dependency)}`);
+    }
+    console.log();
+
+    await install(root, dependencies, installFlags);
+  }
+
+  if (devDependencies.length) {
+    console.log();
+    console.log("Installing devDependencies:");
+    for (const devDependency of devDependencies) {
+      // console.log(`- ${chalk.cyan(devDependency)}`);
+    }
+
+    const devInstallFlags = { devDependencies: true, ...installFlags };
+    await install(root, devDependencies, devInstallFlags);
+  }
+  /**
+   * Copy the template files to the target directory.
+   */
+  console.log("\nInitializing project with template:", template, "\n");
+  const templatePath = path.join(__dirname, "../templates", template);
+  // console.log("templatePath", templatePath, __dirname, template);
+  await copy("**", root, {
+    parents: true,
+    cwd: templatePath,
+    rename: (name) => {
+      switch (name) {
+        case "env":
+        case "gitignore":
+        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";
+        }
+        default: {
+          return name;
+        }
+      }
+    },
+  });
+
+  if (!eslint) {
+    // remove un-necessary template file if eslint is not desired
+    await fs.promises.unlink(path.join(root, ".eslintrc.json"));
+  }
+};
+
+export * from "./types";

package/templates/types.ts

@@ -0,0 +1,21 @@
+import { PackageManager } from "../helpers/get-pkg-manager";
+
+export type TemplateType = "default" | "app";
+export type TemplateMode = "js" | "ts";
+
+export interface GetTemplateFileArgs {
+  template: TemplateType;
+  mode: TemplateMode;
+  file: string;
+}
+
+export interface InstallTemplateArgs {
+  appName: string;
+  root: string;
+  packageManager: PackageManager;
+  isOnline: boolean;
+
+  template: TemplateType;
+  mode: TemplateMode;
+  eslint: boolean;
+}

package/dist/default/Dockerfile

@@ -1,20 +0,0 @@
-# Build Stage
-FROM node:16-alpine AS BUILD_IMAGE
-WORKDIR /app
-COPY package*.json ./
-RUN npm ci
-COPY . .
-RUN npm run build
-
-
-# Production Stage
-FROM node:16-alpine AS PRODUCTION_STAGE
-WORKDIR /app
-COPY --from=BUILD_IMAGE /app/package*.json ./
-COPY --from=BUILD_IMAGE /app/.next ./.next
-COPY --from=BUILD_IMAGE /app/.eventcatalog-core ./.eventcatalog-core
-COPY --from=BUILD_IMAGE /app/public ./public
-COPY --from=BUILD_IMAGE /app/node_modules ./node_modules
-ENV NODE_ENV=production
-EXPOSE 3000
-CMD ["npm", "start"]

package/dist/default/README-template.md

@@ -1 +0,0 @@
-# My Event Catalog

package/dist/default/dockerignore

@@ -1,7 +0,0 @@
-Dockerfile
-.dockerignore
-node_modules
-npm-debug.log
-README.md
-.next
-.eventcatalog-core

package/dist/default/domains/Shopping/events/AddedItemToCart/examples/example.js

@@ -1,17 +0,0 @@
-var kafka = require('kafka-node'),
-  Consumer = kafka.Consumer,
-  client = new kafka.KafkaClient(),
-  consumer = new Consumer(
-    client,
-    [
-      { topic: 't', partition: 0 },
-      { topic: 'AddedItemToCart', partition: 1 },
-    ],
-    {
-      autoCommit: false,
-    }
-  );
-
-consumer.on('message', function (message) {
-  console.log(message);
-});

package/dist/default/domains/Shopping/events/AddedItemToCart/index.md

@@ -1,29 +0,0 @@
----
-name: AddedItemToCart
-version: 0.0.2
-summary: |
-  Holds information about what the user added to their shopping cart.
-producers:
-    - Basket Service
-consumers:
-    - Data Lake
-owners:
-    - dboyne
-    - mSmith
----
-
-<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>
-
-### Details
-
-This event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.
-
-We have a frontend application that allows users to buy things from our store. This front end interacts directly with the `Basket Service` to add items to the cart. The `Basket Service` will raise the events.
-
-<NodeGraph title="Consumer / Producer Diagram" />
-
-<EventExamples title="How to trigger event" />
-
-<Schema />
-
-<SchemaViewer renderRootTreeLines defaultExpandedDepth='0' maxHeight="500" />

package/dist/default/domains/Shopping/events/AddedItemToCart/schema.json

@@ -1,46 +0,0 @@
-{
-  "$id": "https://example.com/AddedItemToCart.json",
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "title": "AddedItemToCart",
-  "type": "object",
-  "properties": {
-    "metadata": {
-      "type": "object",
-      "properties": {
-        "correlationId": {
-          "type": "string",
-          "description": "The ID of the user"
-        },
-        "domain": {
-          "type": "string",
-          "description": "The domain of the event"
-        },
-        "service": {
-          "type": "string",
-          "description": "The name of the service that triggered the event"
-        }
-      },
-      "required": ["correlationId", "domain"]
-    },
-    "data": {
-      "type": "object",
-      "properties": {
-        "userId": {
-          "type": "string",
-          "description": "The ID of the user"
-        },
-        "itemId": {
-          "type": "string",
-          "description": "The ID of the shopping item"
-        },
-        "quantity": {
-          "type": "number",
-          "description": "How many items the user wants to add to their shopping cart",
-          "minimum": 1,
-          "maximum": 1000,
-          "default": 1
-        }
-      }
-    }
-  }
-}