@eventcatalog/create-eventcatalog 2.2.0 → 2.2.2

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: "2.2.0",
+  version: "2.2.2",
   bin: {
     "create-catalog": "./dist/index.js"
   },
@@ -22576,6 +22576,12 @@ var installTemplate = async ({
   const dependencies = [
     "@eventcatalog/core"
   ];
+  if (template === "asyncapi") {
+    dependencies.push("@eventcatalog/generator-asyncapi");
+  }
+  if (template === "openapi") {
+    dependencies.push("@eventcatalog/generator-openapi");
+  }
   const devDependencies = [];
   if (dependencies.length) {
     console.log();
@@ -22603,6 +22609,7 @@ var installTemplate = async ({
       switch (name) {
         case "env":
         case "gitignore":
+        case "npmrc":
         case "dockerignore":
         case "eslintrc.json": {
           return ".".concat(name);
@@ -22640,11 +22647,12 @@ async function createApp({
   eslint,
   experimentalApp,
   organizationName: organizationName2,
-  initEmptyProject
+  initEmptyProject,
+  template: templateName
 }) {
   let repoInfo;
   const mode = typescript ? "ts" : "js";
-  const template = initEmptyProject ? "empty" : "default";
+  const template = initEmptyProject ? "empty" : templateName || "default";
   const root = import_path10.default.resolve(appPath);
   if (!await isWriteable(import_path10.default.dirname(root))) {
     console.error(
@@ -22809,6 +22817,12 @@ var program = new import_commander.default.Command(package_default.name).version
 
   The organization name.
 `
+).option(
+  "--template [name]",
+  `
+
+  The template to use.
+`
 ).option(
   "--empty",
   `
@@ -22866,6 +22880,7 @@ Run ${import_chalk5.default.cyan(`${program.name()} --help`)} to see all options
       organizationName = res.organizationName.trim();
     }
   }
+  const template = program.template || "default";
   const resolvedProjectPath = import_path11.default.resolve(projectPath);
   const projectName = import_path11.default.basename(resolvedProjectPath);
   const { valid, problems } = validateNpmName(projectName);
@@ -22897,7 +22912,8 @@ Run ${import_chalk5.default.cyan(`${program.name()} --help`)} to see all options
       eslint: true,
       experimentalApp: false,
       organizationName,
-      initEmptyProject
+      initEmptyProject,
+      template
     });
   } catch (reason) {
     if (!(reason instanceof DownloadError)) {

package/package.json

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

package/templates/asyncapi/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/asyncapi/README-template.md

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

package/templates/asyncapi/asyncapi-files/messages/user-signed-up.yml

@@ -0,0 +1,44 @@
+UserSignedUp:
+  name: UserSignedUp
+  title: User signup
+  summary: Action to sign a user up.
+  description: A longer description of the signup process
+  contentType: application/json
+  payload:
+    type: object
+    properties:
+      fullName:
+        description: 'The full name of the user.'
+        type: string
+        example: 'John Doe'
+      email:
+        description: "User's email address."
+        type: string
+        format: email
+        example: 'john.doe@example.com'
+      password:
+        description: "User's account password."
+        type: string
+        format: password
+        minLength: 8
+        example: 'password123'
+      dateOfBirth:
+        description: "User's date of birth."
+        type: string
+        format: date
+        example: '1990-01-01'
+      phoneNumber:
+        description: "User's phone number (optional)."
+        type: string
+        pattern: "^\\+?[1-9]\\d{1,14}$"
+        example: '+1234567890'
+      termsAccepted:
+        description: 'Whether the user has accepted the terms and conditions.'
+        type: boolean
+        example: true
+    required:
+      - fullName
+      - email
+      - password
+      - termsAccepted
+    additionalProperties: false

package/templates/asyncapi/asyncapi-files/orders-service.yml

@@ -0,0 +1,272 @@
+asyncapi: 3.0.0
+info:
+  title: Orders Service
+  version: 1.0.1
+  description: This service is in charge of processing orders
+
+operations:
+  sendOrderCreated:
+    action: send
+    channel:
+      $ref: '#/channels/orderCreated'
+    messages:
+      - $ref: '#/channels/orderCreated/messages/OrderCreated'
+
+  sendOrderUpdated:
+    action: send
+    channel:
+      $ref: '#/channels/orderUpdated'
+    messages:
+      - $ref: '#/channels/orderUpdated/messages/OrderUpdated'
+
+  sendOrderCancelled:
+    action: send
+    channel:
+      $ref: '#/channels/orderCancelled'
+    messages:
+      - $ref: '#/channels/orderCancelled/messages/OrderCancelled'
+
+  sendOrderCompleted:
+    action: send
+    channel:
+      $ref: '#/channels/orderCompleted'
+    messages:
+      - $ref: '#/channels/orderCompleted/messages/OrderCompleted'
+
+  receivePaymentProcessed:
+    action: receive
+    channel:
+      $ref: '#/channels/paymentProcessed'
+    messages:
+      - $ref: '#/channels/paymentProcessed/messages/PaymentProcessed'
+
+  receiveInventoryReserved:
+    action: receive
+    channel:
+      $ref: '#/channels/inventoryReserved'
+    messages:
+      - $ref: '#/channels/inventoryReserved/messages/InventoryReserved'
+
+  receiveShipmentDelivered:
+    action: receive
+    channel:
+      $ref: '#/channels/shipmentDelivered'
+    messages:
+      - $ref: '#/channels/shipmentDelivered/messages/ShipmentDelivered'
+
+channels:
+  orderCreated:
+    address: order/created
+    messages:
+      OrderCreated:
+        $ref: '#/components/messages/OrderCreated'
+
+  orderUpdated:
+    address: order/updated
+    messages:
+      OrderUpdated:
+        $ref: '#/components/messages/OrderUpdated'
+
+  orderCancelled:
+    address: order/cancelled
+    messages:
+      OrderCancelled:
+        $ref: '#/components/messages/OrderCancelled'
+
+  orderCompleted:
+    address: order/completed
+    messages:
+      OrderCompleted:
+        $ref: '#/components/messages/OrderCompleted'
+
+  paymentProcessed:
+    address: payment/processed
+    messages:
+      PaymentProcessed:
+        $ref: '#/components/messages/PaymentProcessed'
+
+  inventoryReserved:
+    address: inventory/reserved
+    messages:
+      InventoryReserved:
+        $ref: '#/components/messages/InventoryReserved'
+
+  shipmentDelivered:
+    address: shipment/delivered
+    messages:
+      ShipmentDelivered:
+        $ref: '#/components/messages/ShipmentDelivered'
+
+components:
+  messages:
+    OrderCreated:
+      description: 'Event triggered when an order is created'
+      x-eventcatalog-message-type: event
+      headers:
+        type: object
+        properties:
+          ec-message-type:
+            type: string
+            default: event
+            description: Type of message for EventCatalog
+      payload:
+        type: object
+        properties:
+          orderId:
+            type: string
+            description: Unique identifier for the order
+          userId:
+            type: string
+            description: Unique identifier for the user who placed the order
+          totalAmount:
+            type: number
+            format: float
+            description: Total amount of the order
+          items:
+            type: array
+            description: List of items in the order
+            items:
+              type: object
+              properties:
+                itemId:
+                  type: string
+                  description: Unique identifier for the item
+                quantity:
+                  type: integer
+                  description: Quantity of the item ordered
+                price:
+                  type: number
+                  format: float
+                  description: Price of the item
+
+    OrderUpdated:
+      description: 'Event triggered when an order is updated'
+      x-eventcatalog-message-type: event
+      headers:
+        type: object
+        properties:
+          ec-message-type:
+            type: string
+            default: event
+            description: Type of message for EventCatalog
+      payload:
+        type: object
+        properties:
+          orderId:
+            type: string
+            description: Unique identifier for the order
+          updatedFields:
+            type: object
+            description: Fields that were updated in the order
+            additionalProperties: true
+
+    OrderCancelled:
+      description: 'Event triggered when an order is cancelled'
+      x-eventcatalog-message-type: event
+      headers:
+        type: object
+        properties:
+          ec-message-type:
+            type: string
+            default: event
+            description: Type of message for EventCatalog
+      payload:
+        type: object
+        properties:
+          orderId:
+            type: string
+            description: Unique identifier for the order
+          reason:
+            type: string
+            description: Reason for the order cancellation
+
+    OrderCompleted:
+      description: 'Event triggered when an order is completed'
+      x-eventcatalog-message-type: event
+      headers:
+        type: object
+        properties:
+          ec-message-type:
+            type: string
+            default: event
+            description: Type of message for EventCatalog
+      payload:
+        type: object
+        properties:
+          orderId:
+            type: string
+            description: Unique identifier for the order
+          completionTime:
+            type: string
+            format: date-time
+            description: Time when the order was completed
+
+    PaymentProcessed:
+      description: 'Event triggered when a payment is processed'
+      x-eventcatalog-message-type: event
+      headers:
+        type: object
+        properties:
+          ec-message-type:
+            type: string
+            default: event
+            description: Type of message for EventCatalog
+      payload:
+        type: object
+        properties:
+          orderId:
+            type: string
+            description: Unique identifier for the order
+          paymentId:
+            type: string
+            description: Unique identifier for the payment
+          status:
+            type: string
+            description: Status of the payment
+
+    InventoryReserved:
+      description: 'Event triggered when inventory is reserved for an order'
+      x-eventcatalog-message-type: event
+      headers:
+        type: object
+        properties:
+          ec-message-type:
+            type: string
+            default: event
+            description: Type of message for EventCatalog
+      payload:
+        type: object
+        properties:
+          orderId:
+            type: string
+            description: Unique identifier for the order
+          reservationId:
+            type: string
+            description: Unique identifier for the inventory reservation
+          status:
+            type: string
+            description: Status of the inventory reservation
+
+    ShipmentDelivered:
+      description: 'Event triggered when a shipment is delivered'
+      x-eventcatalog-message-type: event
+      headers:
+        type: object
+        properties:
+          ec-message-type:
+            type: string
+            default: event
+            description: Type of message for EventCatalog
+      payload:
+        type: object
+        properties:
+          orderId:
+            type: string
+            description: Unique identifier for the order
+          shipmentId:
+            type: string
+            description: Unique identifier for the shipment
+          deliveryTime:
+            type: string
+            format: date-time
+            description: Time when the shipment was delivered

package/templates/asyncapi/asyncapi-files/payment-service.yml

@@ -0,0 +1,245 @@
+asyncapi: 3.0.0
+info:
+  title: Payments Service
+  version: 1.0.2
+  description: This service handles the payment processing for various transactions.
+
+operations:
+  sendPaymentInitiated:
+    action: send
+    channel:
+      $ref: '#/channels/paymentInitiated'
+    messages:
+      - $ref: '#/channels/paymentInitiated/messages/PaymentInitiated'
+
+  sendPaymentConfirmed:
+    action: send
+    channel:
+      $ref: '#/channels/paymentConfirmed'
+    messages:
+      - $ref: '#/channels/paymentConfirmed/messages/PaymentConfirmed'
+
+  sendPaymentFailed:
+    action: send
+    channel:
+      $ref: '#/channels/paymentFailed'
+    messages:
+      - $ref: '#/channels/paymentFailed/messages/PaymentFailed'
+
+  sendRefundInitiated:
+    action: send
+    channel:
+      $ref: '#/channels/refundInitiated'
+    messages:
+      - $ref: '#/channels/refundInitiated/messages/RefundInitiated'
+
+  sendRefundCompleted:
+    action: send
+    channel:
+      $ref: '#/channels/refundCompleted'
+    messages:
+      - $ref: '#/channels/refundCompleted/messages/RefundCompleted'
+
+  receiveTransactionVerified:
+    action: receive
+    channel:
+      $ref: '#/channels/transactionVerified'
+    messages:
+      - $ref: '#/channels/transactionVerified/messages/TransactionVerified'
+
+channels:
+  paymentInitiated:
+    address: payment/initiated
+    messages:
+      PaymentInitiated:
+        $ref: '#/components/messages/PaymentInitiated'
+
+  paymentConfirmed:
+    address: payment/confirmed
+    messages:
+      PaymentConfirmed:
+        $ref: '#/components/messages/PaymentConfirmed'
+
+  paymentFailed:
+    address: payment/failed
+    messages:
+      PaymentFailed:
+        $ref: '#/components/messages/PaymentFailed'
+
+  refundInitiated:
+    address: refund/initiated
+    messages:
+      RefundInitiated:
+        $ref: '#/components/messages/RefundInitiated'
+
+  refundCompleted:
+    address: refund/completed
+    messages:
+      RefundCompleted:
+        $ref: '#/components/messages/RefundCompleted'
+
+  transactionVerified:
+    address: transaction/verified
+    messages:
+      TransactionVerified:
+        $ref: '#/components/messages/TransactionVerified'
+
+components:
+  messages:
+    PaymentInitiated:
+      description: 'Event triggered when a payment is initiated'
+      x-eventcatalog-message-type: event
+      headers:
+        type: object
+        properties:
+          ec-message-type:
+            type: string
+            default: event
+            description: Type of message for EventCatalog
+      payload:
+        type: object
+        properties:
+          paymentId:
+            type: string
+            description: Unique identifier for the payment
+          orderId:
+            type: string
+            description: Unique identifier for the related order
+          amount:
+            type: number
+            format: float
+            description: Amount to be paid
+          currency:
+            type: string
+            description: Currency in which the payment is made
+
+    PaymentConfirmed:
+      description: 'Event triggered when a payment is confirmed'
+      x-eventcatalog-message-type: event
+      headers:
+        type: object
+        properties:
+          ec-message-type:
+            type: string
+            default: event
+            description: Type of message for EventCatalog
+      payload:
+        type: object
+        properties:
+          paymentId:
+            type: string
+            description: Unique identifier for the payment
+          orderId:
+            type: string
+            description: Unique identifier for the related order
+          confirmationTime:
+            type: string
+            format: date-time
+            description: Time when the payment was confirmed
+          status:
+            type: string
+            description: Status of the payment confirmation
+
+    PaymentFailed:
+      description: 'Event triggered when a payment fails'
+      x-eventcatalog-message-type: event
+      headers:
+        type: object
+        properties:
+          ec-message-type:
+            type: string
+            default: event
+            description: Type of message for EventCatalog
+      payload:
+        type: object
+        properties:
+          paymentId:
+            type: string
+            description: Unique identifier for the payment
+          orderId:
+            type: string
+            description: Unique identifier for the related order
+          failureReason:
+            type: string
+            description: Reason for the payment failure
+
+    RefundInitiated:
+      description: 'Event triggered when a refund is initiated'
+      x-eventcatalog-message-type: event
+      headers:
+        type: object
+        properties:
+          ec-message-type:
+            type: string
+            default: event
+            description: Type of message for EventCatalog
+      payload:
+        type: object
+        properties:
+          refundId:
+            type: string
+            description: Unique identifier for the refund
+          paymentId:
+            type: string
+            description: Unique identifier for the related payment
+          amount:
+            type: number
+            format: float
+            description: Amount to be refunded
+          currency:
+            type: string
+            description: Currency in which the refund is made
+          createdAt:
+            type: string
+            description: ISO Date String of when the refund was initiated
+
+    RefundCompleted:
+      description: 'Event triggered when a refund is completed'
+      x-eventcatalog-message-type: event
+      headers:
+        type: object
+        properties:
+          ec-message-type:
+            type: string
+            default: event
+            description: Type of message for EventCatalog
+      payload:
+        type: object
+        properties:
+          refundId:
+            type: string
+            description: Unique identifier for the refund
+          paymentId:
+            type: string
+            description: Unique identifier for the related payment
+          completionTime:
+            type: string
+            format: date-time
+            description: Time when the refund was completed
+          status:
+            type: string
+            description: Status of the refund process
+
+    TransactionVerified:
+      description: 'Command triggered when a transaction is verified'
+      x-eventcatalog-message-type: command
+      headers:
+        type: object
+        properties:
+          ec-message-type:
+            type: string
+            default: command
+            description: Type of message for EventCatalog
+      payload:
+        type: object
+        properties:
+          transactionId:
+            type: string
+            description: Unique identifier for the transaction
+          verificationTime:
+            type: string
+            format: date-time
+            description: Time when the transaction was verified
+          status:
+            type: string
+            description: Verification status of the transaction

package/templates/asyncapi/asyncapi-files/user-service.yml

@@ -0,0 +1,23 @@
+asyncapi: 3.0.0
+info:
+  title: USService
+  description: description
+  version: 1.1.0
+
+channels:
+  randomChannel:
+    address: myAddress
+    messages:
+      UserSignup:
+        $ref: '#/components/schemas/UserSignedUp/schema'
+operations:
+  sendNoise:
+    action: send
+    channel:
+      $ref: '#/channels/randomChannel'
+components:
+  schemas:
+    UserSignedUp:
+      schemaFormat: 'application/schema+json;version=draft-07'
+      schema:
+        '$ref': './messages/user-signed-up.yml#/UserSignedUp'

package/templates/asyncapi/dockerignore

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