@eventcatalog/create-eventcatalog 2.2.1 → 2.2.3

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

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

@@ -0,0 +1,68 @@
+openapi: 3.0.0
+info:
+  title: Product API
+  description: API for managing and retrieving product details in the shopping application.
+  version: 1.0.0
+servers:
+  - url: https://api.yourshoppingapp.com/products
+    description: Product API Server
+paths:
+  /:
+    get:
+      summary: List all products
+      description: Retrieve a list of all available products.
+      x-eventcatalog-message-type: query
+      operationId: listProducts
+      responses:
+        '200':
+          description: A list of products
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Product'
+  /{productId}:
+    get:
+      summary: Get a product by ID
+      description: Retrieve details of a specific product by its ID.
+      x-eventcatalog-message-type: query
+      operationId: getProductById
+      parameters:
+        - name: productId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: A single product
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Product'
+        '404':
+          description: Product not found
+components:
+  schemas:
+    Product:
+      type: object
+      properties:
+        id:
+          type: string
+        name:
+          type: string
+        description:
+          type: string
+        price:
+          type: number
+          format: float
+        category:
+          type: string
+        imageUrl:
+          type: string
+      required:
+        - id
+        - name
+        - price
+        - category

package/templates/openapi/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/openapi/teams/payment-management.md

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

package/templates/openapi/teams/product-management.md

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

package/templates/openapi/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/openapi/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/openapi/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/openapi/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/openapi/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/openapi/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/openapi/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/types.ts

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