@eventcatalog/create-eventcatalog 2.2.1 → 2.2.2

package/templates/asyncapi/eventcatalog.config.js

@@ -0,0 +1,55 @@
+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: 'Discover, Explore and Document your Event Driven Architectures',
+  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: '/',
+  logo: {
+    alt: 'EventCatalog Logo',
+    src: '/logo.png',
+    text: 'EventCatalog',
+  },
+  generators: [
+    [
+      '@eventcatalog/generator-asyncapi',
+      {
+        services: [
+          { path: path.join(__dirname, 'asyncapi-files', 'orders-service.yml'), id: 'Orders Service' },
+        ],
+        domain: { id: 'orders', name: 'Orders', version: '0.0.1' },
+      },
+    ],
+    [
+      '@eventcatalog/generator-asyncapi',
+      {
+        services: [
+          { path: path.join(__dirname, 'asyncapi-files', 'payment-service.yml'), id: 'Payment Service' },
+        ],
+        domain: { id: 'payment', name: 'Payment', version: '0.0.1' },
+      },
+    ],
+    [
+      '@eventcatalog/generator-asyncapi',
+      {
+        services: [
+          { path: path.join(__dirname, 'asyncapi-files', 'user-service.yml'), id: 'User Service' },
+        ],
+        domain: { id: 'user-domain', name: 'User Domain', version: '0.0.1' },
+        debug: true
+      },
+    ],
+  ],
+  // required random generated id used by eventcatalog
+  cId: '<cId>'
+};

package/templates/asyncapi/eventcatalog.styles.css

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

package/templates/asyncapi/gitignore

@@ -0,0 +1,24 @@
+# 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

package/templates/asyncapi/npmrc

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

package/templates/index.ts

@@ -72,6 +72,16 @@ export const installTemplate = async ({
   const dependencies = [
     "@eventcatalog/core"
   ] as any;
+
+  // if asyncapi is selected, add the asyncapi dependencies
+  if (template === "asyncapi") {
+    dependencies.push("@eventcatalog/generator-asyncapi");
+  }
+
+  if (template === "openapi") {
+    dependencies.push("@eventcatalog/generator-openapi");
+  }
+
   // "@myuser/my-package": "file:../lib"
   const devDependencies = [] as any;
 

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

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

package/templates/openapi/dockerignore

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

package/templates/openapi/eventcatalog.config.js

@@ -0,0 +1,60 @@
+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: "Discover, Explore and Document your Event Driven Architectures",
+  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",
+  },
+  generators: [
+    [
+      "@eventcatalog/generator-openapi",
+      {
+        services: [
+          { path: path.join(__dirname, "openapi-files", "product-api.yml") },
+        ],
+        domain: { id: "products", name: "Products", version: "0.0.1" },
+      },
+    ],
+    [
+      "@eventcatalog/generator-openapi",
+      {
+        services: [
+          { path: path.join(__dirname, "openapi-files", "order-api.yml"), id: 'order-service' },
+          { path: path.join(__dirname, "openapi-files", "order-history.yml"), id: 'order-history' },
+        ],
+        domain: {
+          id: "order-management",
+          name: "Order management",
+          version: "0.0.1",
+        },
+      },
+    ],
+    [
+      "@eventcatalog/generator-openapi",
+      {
+        services: [
+          { path: path.join(__dirname, "openapi-files", "payment-api.yml"), id: 'payment-service' },
+        ],
+        domain: { id: "payment", name: "Payment", version: "0.0.1" },
+      },
+    ],
+  ],
+  // required random generated id used by eventcatalog
+  cId: '<cId>'
+};

package/templates/openapi/eventcatalog.styles.css

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

package/templates/openapi/gitignore

@@ -0,0 +1,24 @@
+# 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

package/templates/openapi/npmrc

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

package/templates/openapi/openapi-files/cart-api.yml

@@ -0,0 +1,107 @@
+openapi: 3.0.0
+info:
+  title: Cart API
+  description: API for managing shopping cart operations.
+  version: 1.0.0
+servers:
+  - url: https://api.yourshoppingapp.com/cart
+    description: Cart API Server
+paths:
+  /:
+    get:
+      summary: Retrieve shopping cart
+      description: Get the contents of the user's shopping cart.
+      x-eventcatalog-message-type: query
+      operationId: getCart
+      responses:
+        '200':
+          description: Shopping cart details
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Cart'
+    post:
+      summary: Add item to cart
+      description: Add a product to the shopping cart.
+      x-eventcatalog-message-type: command
+      requestBody:
+        description: Product information to add to the cart.
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CartItem'
+      responses:
+        '201':
+          description: Product added to cart
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Cart'
+  /{productId}:
+    patch:
+      summary: Update item quantity
+      description: Update the quantity of an item in the cart.
+      x-eventcatalog-message-type: command
+      operationId: updateCartItem
+      parameters:
+        - name: productId
+          in: path
+          required: true
+          schema:
+            type: string
+      requestBody:
+        description: Updated quantity
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                quantity:
+                  type: integer
+                  minimum: 1
+      responses:
+        '200':
+          description: Quantity updated
+        '404':
+          description: Product not found in cart
+    delete:
+      summary: Remove item from cart
+      description: Remove a product from the shopping cart.
+      x-eventcatalog-message-type: command
+      parameters:
+        - name: productId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          description: Product removed from cart
+components:
+  schemas:
+    Cart:
+      type: object
+      properties:
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/CartItem'
+    CartItem:
+      type: object
+      properties:
+        productId:
+          type: string
+        name:
+          type: string
+        quantity:
+          type: integer
+        price:
+          type: number
+          format: float
+      required:
+        - productId
+        - name
+        - quantity
+        - price

package/templates/openapi/openapi-files/order-api.yml

@@ -0,0 +1,148 @@
+openapi: 3.0.0
+info:
+  title: Order API
+  description: API for managing orders in the shopping application.
+  version: 1.0.0
+servers:
+  - url: https://api.yourshoppingapp.com/orders
+    description: Order API Server
+paths:
+  /:
+    get:
+      summary: Get list of orders
+      description: Retrieve a list of all orders made by the user.
+      x-eventcatalog-message-type: query
+      operationId: listOrders
+      responses:
+        '200':
+          description: A list of orders
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Order'
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+  /{orderId}:
+    get:
+      summary: Get order by ID
+      description: Retrieve details of a specific order.
+      operationId: getOrderById
+      x-eventcatalog-message-type: query
+      parameters:
+        - name: orderId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Order details
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Order'
+        '404':
+          description: Order not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+    patch:
+      summary: Update order status
+      description: Update the status of an order (e.g., cancel).
+      x-eventcatalog-message-type: command
+      parameters:
+        - name: orderId
+          in: path
+          required: true
+          schema:
+            type: string
+      requestBody:
+        description: Updated order status
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                status:
+                  type: string
+                  enum: [pending, shipped, delivered, canceled]
+      responses:
+        '200':
+          description: Order status updated
+        '404':
+          description: Order not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+components:
+  schemas:
+    Order:
+      type: object
+      properties:
+        id:
+          type: string
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/CartItem'
+        status:
+          type: string
+          enum: [pending, shipped, delivered, canceled]
+        totalAmount:
+          type: number
+          format: float
+      required:
+        - id
+        - items
+        - status
+        - totalAmount
+    CartItem:
+      type: object
+      properties:
+        productId:
+          type: string
+        name:
+          type: string
+        quantity:
+          type: integer
+        price:
+          type: number
+          format: float
+      required:
+        - productId
+        - name
+        - quantity
+        - price
+    ErrorResponse:
+      type: object
+      properties:
+        code:
+          type: integer
+          description: Error code representing the issue
+        message:
+          type: string
+          description: A description of the error
+      required:
+        - code
+        - message

package/templates/openapi/openapi-files/order-history.yml

@@ -0,0 +1,93 @@
+openapi: 3.0.0
+info:
+  title: Order History API
+  description: API for retrieving a history of past orders.
+  version: 1.0.0
+servers:
+  - url: https://api.yourshoppingapp.com/order-history
+    description: Order History API Server
+paths:
+  /:
+    get:
+      summary: Retrieve order history
+      description: Fetch a list of past orders with optional filters like date range and status.
+      x-eventcatalog-message-type: query
+      operationId: getOrderHistory
+      parameters:
+        - name: startDate
+          in: query
+          description: Start date for the order history range (YYYY-MM-DD)
+          schema:
+            type: string
+            format: date
+        - name: endDate
+          in: query
+          description: End date for the order history range (YYYY-MM-DD)
+          schema:
+            type: string
+            format: date
+        - name: status
+          in: query
+          description: Filter orders by status (pending, shipped, delivered, canceled)
+          schema:
+            type: string
+            enum: [pending, shipped, delivered, canceled]
+        - name: customerId
+          in: query
+          description: Customer ID for retrieving specific customer order history (optional if authenticated user)
+          schema:
+            type: string
+      responses:
+        '200':
+          description: A list of past orders
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Order'
+        '400':
+          description: Invalid date range or other input
+components:
+  schemas:
+    Order:
+      type: object
+      properties:
+        id:
+          type: string
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/CartItem'
+        status:
+          type: string
+          enum: [pending, shipped, delivered, canceled]
+        totalAmount:
+          type: number
+          format: float
+        orderDate:
+          type: string
+          format: date
+      required:
+        - id
+        - items
+        - status
+        - totalAmount
+        - orderDate
+    CartItem:
+      type: object
+      properties:
+        productId:
+          type: string
+        name:
+          type: string
+        quantity:
+          type: integer
+        price:
+          type: number
+          format: float
+      required:
+        - productId
+        - name
+        - quantity
+        - price

package/templates/openapi/openapi-files/payment-api.yml

@@ -0,0 +1,74 @@
+openapi: 3.0.0
+info:
+  title: Payment API
+  description: API for handling payment transactions.
+  version: 1.0.0
+servers:
+  - url: https://api.yourshoppingapp.com/payments
+    description: Payment API Server
+paths:
+  /:
+    post:
+      summary: Initiate payment
+      description: Start a payment process for an order.
+      x-eventcatalog-message-type: command
+      operationId: initiatePayment
+      requestBody:
+        description: Payment details
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PaymentRequest'
+      responses:
+        '201':
+          description: Payment initiated
+        '400':
+          description: Invalid payment request
+  /{paymentId}:
+    get:
+      summary: Get payment status
+      operationId: getPaymentStatus
+      description: Check the status of a specific payment by its ID.
+      x-eventcatalog-message-type: query
+      parameters:
+        - name: paymentId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Payment status details
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PaymentStatus'
+components:
+  schemas:
+    PaymentRequest:
+      type: object
+      properties:
+        orderId:
+          type: string
+        amount:
+          type: number
+          format: float
+        paymentMethod:
+          type: string
+          enum: [credit_card, paypal, bank_transfer]
+      required:
+        - orderId
+        - amount
+        - paymentMethod
+    PaymentStatus:
+      type: object
+      properties:
+        id:
+          type: string
+        status:
+          type: string
+          enum: [pending, successful, failed]
+      required:
+        - id
+        - status