@eventcatalog/create-eventcatalog 4.3.3 → 4.3.4

package/templates/default/domains/Orders/services/OrdersService/events/OrderConfirmed/examples/gift-order.json

@@ -1,38 +0,0 @@
-{
-  "eventId": "evt_7f8e9d0c-1b2a-3c4d-5e6f-7a8b9c0d1e2f",
-  "eventType": "OrderConfirmed",
-  "timestamp": "2025-11-16T12:15:44.882Z",
-  "orderId": "ord_85412",
-  "userId": "usr_72019",
-  "items": [
-    {
-      "productId": "prod_6300",
-      "productName": "Scented Candle Gift Set",
-      "sku": "SCG-050-AST",
-      "quantity": 1,
-      "unitPrice": 59.99,
-      "lineTotal": 59.99
-    }
-  ],
-  "orderTotal": 65.98,
-  "currency": "USD",
-  "isGift": true,
-  "giftMessage": "Happy Birthday! Hope you enjoy these.",
-  "giftWrapping": true,
-  "giftWrappingCost": 5.99,
-  "shippingAddress": {
-    "line1": "305 Pine Lane",
-    "line2": "Suite 4",
-    "city": "Seattle",
-    "state": "WA",
-    "postalCode": "98101",
-    "country": "US"
-  },
-  "shippingMethod": "express",
-  "estimatedDelivery": "2025-11-18",
-  "paymentMethod": "paypal",
-  "metadata": {
-    "source": "mobile-app",
-    "correlationId": "corr_ffeeddcc-bbaa-9988-7766-554433221100"
-  }
-}

package/templates/default/domains/Orders/services/OrdersService/events/OrderConfirmed/examples/standard-order.json

@@ -1,42 +0,0 @@
-{
-  "eventId": "evt_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
-  "eventType": "OrderConfirmed",
-  "timestamp": "2025-11-16T08:30:12.654Z",
-  "orderId": "ord_85330",
-  "userId": "usr_61482",
-  "items": [
-    {
-      "productId": "prod_5210",
-      "productName": "USB-C Charging Cable 2m",
-      "sku": "UCC-200-WHT",
-      "quantity": 2,
-      "unitPrice": 14.99,
-      "lineTotal": 29.98
-    },
-    {
-      "productId": "prod_5211",
-      "productName": "Wireless Mouse",
-      "sku": "WM-300-BLK",
-      "quantity": 1,
-      "unitPrice": 34.99,
-      "lineTotal": 34.99
-    }
-  ],
-  "orderTotal": 64.97,
-  "currency": "USD",
-  "shippingAddress": {
-    "line1": "720 Elm Drive",
-    "line2": null,
-    "city": "Austin",
-    "state": "TX",
-    "postalCode": "73301",
-    "country": "US"
-  },
-  "shippingMethod": "standard",
-  "estimatedDelivery": "2025-11-21",
-  "paymentMethod": "credit_card",
-  "metadata": {
-    "source": "web",
-    "correlationId": "corr_11223344-5566-7788-99aa-bbccddeeff00"
-  }
-}

package/templates/default/domains/Orders/services/OrdersService/events/OrderConfirmed/index.mdx

@@ -1,55 +0,0 @@
----
-id: OrderConfirmed
-name: Order confirmed
-version: 0.0.1
-summary: |
-  Indicates an order has been confirmed
-owners:
-  - dboyne
-  - msmith
-badges:
-  - content: Recently updated!
-    backgroundColor: green
-    textColor: green
-  - content: 'Channel:Apache Kafka'
-    backgroundColor: yellow
-    textColor: yellow
-schemaPath: schema.json
----
-
-import Footer from '@catalog/components/footer.astro';
-
-## Overview
-
-The OrderConfirmed event is triggered when an order has been successfully confirmed. This event notifies relevant services that the order is ready for further processing, such as inventory adjustment, payment finalization, and preparation for shipping.
-
-## Architecture Diagram
-
-<NodeGraph />
-
-## Payload
-
-```json title="Example payload"
-{
-  "orderId": "123e4567-e89b-12d3-a456-426614174000",
-  "userId": "123e4567-e89b-12d3-a456-426614174000",
-  "orderItems": [
-    {
-      "productId": "789e1234-b56c-78d9-e012-3456789fghij",
-      "productName": "Example Product",
-      "quantity": 2,
-      "unitPrice": 29.99,
-      "totalPrice": 59.98
-    }
-  ],
-  "orderStatus": "confirmed",
-  "totalAmount": 150.75,
-  "confirmationTimestamp": "2024-07-04T14:48:00Z"
-}
-```
-
-## Schema
-
-<Schema file="schema.json" />
-
-<Footer />

package/templates/default/domains/Orders/services/OrdersService/events/OrderConfirmed/schema.json

@@ -1,66 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "OrderConfirmedEvent",
-  "type": "object",
-  "properties": {
-    "orderId": {
-      "type": "string",
-      "format": "uuid",
-      "description": "The unique identifier of the confirmed order."
-    },
-    "userId": {
-      "type": "string",
-      "format": "uuid",
-      "description": "The unique identifier of the user who placed the order."
-    },
-    "orderItems": {
-      "type": "array",
-      "description": "A list of items included in the confirmed order, each containing product details and quantities.",
-      "items": {
-        "type": "object",
-        "properties": {
-          "productId": {
-            "type": "string",
-            "format": "uuid",
-            "description": "The unique identifier of the product."
-          },
-          "productName": {
-            "type": "string",
-            "description": "The name of the product."
-          },
-          "quantity": {
-            "type": "integer",
-            "description": "The quantity of the product ordered."
-          },
-          "unitPrice": {
-            "type": "number",
-            "format": "float",
-            "description": "The price per unit of the product."
-          },
-          "totalPrice": {
-            "type": "number",
-            "format": "float",
-            "description": "The total price for this order item (quantity * unitPrice)."
-          }
-        },
-        "required": ["productId", "productName", "quantity", "unitPrice", "totalPrice"]
-      }
-    },
-    "orderStatus": {
-      "type": "string",
-      "description": "The current status of the order after confirmation."
-    },
-    "totalAmount": {
-      "type": "number",
-      "format": "float",
-      "description": "The total amount of the confirmed order."
-    },
-    "confirmationTimestamp": {
-      "type": "string",
-      "format": "date-time",
-      "description": "The date and time when the order was confirmed."
-    }
-  },
-  "required": ["orderId", "userId", "orderItems", "orderStatus", "totalAmount", "confirmationTimestamp"],
-  "additionalProperties": false
-}

package/templates/default/domains/Orders/services/OrdersService/index.mdx

@@ -1,81 +0,0 @@
----
-id: OrdersService
-version: 0.0.3
-name: Orders Service
-summary: |
-  Service that handles orders
-owners:
-  - dboyne
-receives:
-  - id: InventoryAdjusted
-    version: 1.0.1
-    from:
-      - id: 'inventory.{env}.events'
-  - id: CreateReturnLabel
-  - id: PlaceOrder
-  - id: GetOrder
-sends:
-  - id: OrderAmended
-    to:
-      - id: 'orders.{env}.events'
-        parameters:
-          env: staging
-  - id: OrderCancelled
-    to:
-      - id: 'orders.{env}.events'
-  - id: OrderConfirmed
-    to:
-      - id: 'orders.{env}.events'
-  - id: AddInventory
-    version: 0.0.3
-    to:
-      - id: 'inventory.{env}.events'
-        parameters:
-          env: staging
-repository:
-  language: JavaScript
-  url: 'https://github.com/event-catalog/pretend-shipping-service'
-schemaPath: openapi.yml
-specifications:
-  asyncapiPath: order-service-asyncapi.yaml
-  openapiPath: openapi.yml
----
-
-import Footer from '@catalog/components/footer.astro';
-
-## 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.
-
-<Tiles>
-  <Tile
-    icon="DocumentIcon"
-    href={`/docs/services/${frontmatter.id}/${frontmatter.version}/changelog`}
-    title="View the changelog"
-    description="Want to know the history of this service? View the change logs"
-  />
-  <Tile
-    icon="UserGroupIcon"
-    href="/docs/teams/full-stack"
-    title="Contact the team"
-    description="Any questions? Feel free to contact the owners"
-  />
-  <Tile
-    icon="BoltIcon"
-    href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`}
-    title={`Sends ${frontmatter.sends.length} messages`}
-    description="This service sends messages to downstream consumers"
-  />
-  <Tile
-    icon="BoltIcon"
-    href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`}
-    title={`Receives ${frontmatter.receives.length} messages`}
-    description="This service receives messages from other services"
-  />
-</Tiles>
-
-## Architecture diagram
-
-<NodeGraph />
-
-<Footer />

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

@@ -1,185 +0,0 @@
-openapi: 3.1.0
-info:
-  title: Simple Task - API
-  version: 1.0.2
-  description: Simple Api
-  contact: {}
-  license:
-    name: apache 2.0
-    identifier: apache-2.0
-    url: https://www.apache.org/licenses/LICENSE-2.0.html
-
-servers:
-  - url: https://example.com/
-
-paths:
-  /v1/task/{id}:
-    put:
-      summary: Do Simple Task
-      operationId: DoSimpleTask
-      responses:
-        '200':
-          description: do a task by id
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Task'
-        '204':
-          description: No content
-        '400':
-          description: Problem with data
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        '403':
-          description: Not Authorized
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Unauthorized'
-        '404':
-          description: not found
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        '500':
-          description: Internal server error
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-      description: Allows to do a simple task
-      security:
-        - authorization: []
-      parameters:
-        - in: path
-          name: id
-          required: true
-          schema:
-            type: string
-    delete:
-      summary: Delete Task
-      operationId: DeleteTask
-      responses:
-        '204':
-          description: Task deleted
-        '400':
-          description: Problem with data
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        '403':
-          description: Not Authorized
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Unauthorized'
-        '404':
-          description: not found
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        '500':
-          description: Internal server error
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-      description: Delete a task
-      security:
-        - authorization: []
-      parameters:
-        - in: path
-          name: id
-          required: true
-          schema:
-            type: string
-  /v1/tasks:
-    get:
-      summary: Get List of Tasks
-      operationId: GetTaskList
-      responses:
-        '200':
-          description: Successfully retrieved list of tasks
-          content:
-            application/json:
-              schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/Task'
-        '400':
-          description: Bad request
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        '403':
-          description: Not Authorized
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Unauthorized'
-        '500':
-          description: Internal server error
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-      description: Retrieves a list of all tasks
-      security:
-        - authorization: []
-      parameters:
-        - in: query
-          name: limit
-          schema:
-            type: integer
-            minimum: 1
-            maximum: 100
-            default: 20
-          description: The maximum number of tasks to return
-        - in: query
-          name: offset
-          schema:
-            type: integer
-            minimum: 0
-            default: 0
-          description: The number of tasks to skip before starting to return results
-
-components:
-  schemas:
-    Task:
-      properties:
-        comments:
-          type: string
-        creationDate:
-          type: string
-        taskId:
-          type: string
-        description:
-          type: string
-        lastUpdate:
-          type: string
-      type: object
-      additionalProperties: false
-    Error:
-      properties:
-        error:
-          type: string
-      required:
-        - error
-      type: object
-    Unauthorized:
-      properties:
-        message:
-          type: string
-      required:
-        - message
-      type: object
-  securitySchemes:
-    authorization:
-      type: http
-      scheme: bearer

package/templates/default/domains/Orders/services/OrdersService/order-service-asyncapi.yaml

@@ -1,148 +0,0 @@
-asyncapi: 3.0.0
-
-info:
-  title: Order service
-  description: |
-    This service is in charge of processing order events.
-  version: '1.0.0'
-
-servers:
-  topic:
-    host: https://mytopic.com
-    description: Custom Topic.
-    protocol: HTTPS
-
-defaultContentType: application/json
-
-channels:
-  orderEventsChannel:
-    address: 'orders.{orderId}'
-    description: All Order related events are distributed and broadcasted for the interested consumers.
-    title: Order events channel
-    messages:
-      OrderConfirmed:
-        summary: Order confirmed event
-        $ref: '#/components/messages/OrderConfirmed'
-      OrderPlaced:
-        summary: Order placed event
-        $ref: '#/components/messages/OrderPlaced'
-
-operations:
-  onOrderConfirmation:
-    summary: Action to confirm an order.
-    description: The product availability of an order will lead to the confirmation of the order.
-    title: Order Confirmed
-    channel:
-      $ref: '#/channels/orderEventsChannel'
-    action: send
-  onOrderPlacement:
-    summary: Action to place an order.
-    description: The reception and validation of an order will lead to the placement of the order.
-    title: Order Placed
-    channel:
-      $ref: '#/channels/orderEventsChannel'
-    action: send
-
-components:
-  messages:
-    OrderConfirmed:
-      payload:
-        $ref: '#/components/schemas/OrderConfirmed'
-
-    OrderPlaced:
-      payload:
-        $ref: '#/components/schemas/OrderPlaced'
-
-  schemas:
-    orderId:
-      description: The unique identifier of an order
-      type: string
-      pattern: ^([A-Za-z0-9_-]{21})$
-
-    userId:
-      description: The unique identifier of a user
-      type: string
-      pattern: ^([A-Za-z0-9_-]{21})$
-
-    productId:
-      description: The product unique identifier
-      type: string
-      pattern: ^([A-Za-z0-9_-]{21})$
-
-    Order:
-      required:
-        - orderId
-        - userId
-        - productId
-        - price
-        - quantity
-        - orderDate
-      type: object
-      description: order model
-      properties:
-        orderId:
-          '$ref': '#/components/schemas/orderId'
-        orderDate:
-          description: Date of order submition.
-          type: string
-          format: date-time
-        userId:
-          '$ref': '#/components/schemas/userId'
-        productId:
-          '$ref': '#/components/schemas/productId'
-        price:
-          type: number
-        quantity:
-          type: integer
-      title: Order
-
-    EventEnvelope:
-      type: object
-      allOf:
-        - $ref: 'https://raw.githubusercontent.com/cloudevents/spec/v1.0.1/spec.json'
-      properties:
-        id:
-          type: string
-          format: uuid
-        idempotencykey:
-          type: string
-          format: uuid
-        correlationid:
-          type: string
-          format: uuid
-        causationid:
-          type: string
-          format: uuid
-
-    EventType:
-      type: string
-      enum:
-        - 'order.placed'
-        - 'order.confirmed'
-
-    OrderConfirmed:
-      type: object
-      additionalProperties: false
-      allOf:
-        - $ref: '#/components/schemas/EventEnvelope'
-      properties:
-        data:
-          $ref: '#/components/schemas/Order'
-        type:
-          $ref: '#/components/schemas/EventType'
-
-      required:
-        - data
-
-    OrderPlaced:
-      type: object
-      additionalProperties: false
-      allOf:
-        - $ref: '#/components/schemas/EventEnvelope'
-      properties:
-        data:
-          $ref: '#/components/schemas/Order'
-        type:
-          $ref: '#/components/schemas/EventType'
-      required:
-        - data

package/templates/default/domains/Orders/services/OrdersService/queries/GetOrder/index.mdx

@@ -1,26 +0,0 @@
----
-id: GetOrder
-name: Get order details
-version: 0.0.1
-summary: |
-  GET request that will return detailed information about a specific order, identified by its orderId.
-owners:
-  - dboyne
-badges:
-  - content: Recently updated!
-    backgroundColor: green
-    textColor: green
-schemaPath: schema.json
----
-
-import Footer from '@catalog/components/footer.astro';
-
-## Overview
-
-The `GetOrder` message is a query used to retrieve detailed information about a specific order, identified by its `orderId`. It provides information such as the order status (e.g., pending, completed, shipped), the items within the order, billing and shipping details, payment information, and the order's total amount. This query is commonly used by systems managing order processing, customer service, or order tracking functionalities.
-
-This query can be applied in e-commerce systems, marketplaces, or any platform where users and systems need real-time order data for tracking, auditing, or managing customer purchases.
-
-<NodeGraph />
-
-<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/OrdersService/versioned/0.0.2/changelog.mdx

@@ -1,3 +0,0 @@
----
-createdAt: 2024-08-01
----

package/templates/default/domains/Orders/services/OrdersService/versioned/0.0.2/index.mdx

@@ -1,40 +0,0 @@
----
-id: OrdersService
-version: 0.0.2
-name: Orders Service
-summary: |
-  Service that handles orders
-owners:
-  - dboyne
-receives:
-  - id: InventoryAdjusted
-    version: 1.0.1
-    from:
-      - id: 'inventory.{env}.events'
-sends:
-  - id: AddInventory
-    version: 0.0.3
-    to:
-      - id: 'inventory.{env}.events'
-        parameters:
-          env: staging
-repository:
-  language: JavaScript
-  url: 'https://github.com/event-catalog/pretend-shipping-service'
-schemaPath: openapi.yml
-specifications:
-  asyncapiPath: order-service-asyncapi.yaml
-  openapiPath: openapi.yml
----
-
-import Footer from '@catalog/components/footer.astro';
-
-## 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.
-
-## Architecture diagram
-
-<NodeGraph />
-
-<Footer />