@eventcatalog/create-eventcatalog 2.2.1 → 2.2.3

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'), owners: ['order-management'], 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'), owners: ['order-management'], 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'), owners: ['user-management'], 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/asyncapi/teams/order-management.md

@@ -0,0 +1,31 @@
+---
+id: order-management
+name: Order Management
+summmary: Order Management team based in London, UK
+members:
+    - dboyne
+    - asmith
+    - msmith
+    - alee
+    - azhang
+email: test@test.com
+slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
+---
+
+## Overview
+
+The Order Management team is responsible for managing orders, inventory, shipment and payment.
+
+## Responsibilities
+
+- Manage orders and order processing
+- Manage inventory and inventory processing
+- Manage shipment and shipment processing
+- Manage payment and payment processing
+- Manage user and user processing
+
+## Key Contacts
+
+- David Boyne
+- Alice Smith
+- Mike Smith

package/templates/asyncapi/teams/user-management.md

@@ -0,0 +1,18 @@
+---
+id: user-management
+name: User Management
+members:
+    - dboyne
+    - jbrown
+    - dkim
+---
+
+The user management team is responsible for managing users and user accounts.
+
+## Responsibilities
+
+- Manage user and user account management
+- Manage user and user account provisioning
+- Manage user and user account deprovisioning
+- Manage user and user account password management
+- Manage user and user account role management

package/templates/asyncapi/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/asyncapi/users/alee.md

@@ -0,0 +1,8 @@
+---
+id: alee
+name: Alice Lee
+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. 

package/templates/asyncapi/users/azhang.md

@@ -0,0 +1,11 @@
+---
+id: azhang
+name: Alice Zhang
+avatarUrl: https://randomuser.me/api/portraits/women/97.jpg
+role: Data Engineer
+email: azhang@company.com
+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... 

package/templates/asyncapi/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/asyncapi/users/dkim.md

@@ -0,0 +1,11 @@
+---
+id: dkim
+name: David Kim
+avatarUrl: https://randomuser.me/api/portraits/men/96.jpg
+role: Performance Engineer
+email: dkim@company.com
+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... 

package/templates/asyncapi/users/jbrown.md

@@ -0,0 +1,11 @@
+---
+id: jbrown
+name: Jessica Brown
+avatarUrl: https://randomuser.me/api/portraits/women/95.jpg
+role: UI/UX Designer
+email: jbrown@company.com
+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... 

package/templates/asyncapi/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

@@ -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"), id: 'product-service', owners: ['product-management'] },
+        ],
+        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', 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",
+        },
+      },
+    ],
+    [
+      "@eventcatalog/generator-openapi",
+      {
+        services: [
+          { path: path.join(__dirname, "openapi-files", "payment-api.yml"), id: 'payment-service', owners: ['payment-management'] },
+        ],
+        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