@eventcatalog/create-eventcatalog 4.3.3 → 4.3.4

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

@@ -1,96 +0,0 @@
-openapi: 3.1.0
-info:
-  title: Simple Task - API
-  version: 1.0.0
-  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
-
-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/versioned/0.0.2/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/ShippingService/commands/CancelShipment/index.mdx

@@ -1,22 +0,0 @@
----
-id: CancelShipment
-name: Cancel shipment
-version: 0.0.1
-summary: |
-  POST request that will cancel a shipment, identified by its shipmentId.
-owners:
-  - dboyne
-schemaPath: schema.json
----
-
-import Footer from '@catalog/components/footer.astro';
-
-## Overview
-
-The `CancelShipment` message is a command used to cancel a shipment, identified by its `shipmentId`. It provides information such as the shipment status (e.g., pending, completed, shipped), the items within the shipment, 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 command can be applied in e-commerce systems, marketplaces, or any platform where users and systems need real-time shipment data for tracking, auditing, or managing customer purchases.
-
-<SchemaViewer file="schema.json" title="Schema" maxHeight="500" />
-
-<NodeGraph />

package/templates/default/domains/Orders/services/ShippingService/commands/CancelShipment/schema.json

@@ -1,13 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "title": "CancelShipment",
-  "description": "Schema for cancelling a shipment",
-  "properties": {
-    "shipmentId": {
-      "type": "string",
-      "description": "Unique identifier for the shipment"
-    }
-  },
-  "required": ["shipmentId"]
-}

package/templates/default/domains/Orders/services/ShippingService/commands/CreateReturnLabel/index.mdx

@@ -1,22 +0,0 @@
----
-id: CreateReturnLabel
-name: Create return label
-version: 0.0.1
-summary: |
-  POST request that will create a return label for a specific shipment, identified by its shipmentId.
-owners:
-  - dboyne
-schemaPath: schema.json
----
-
-import Footer from '@catalog/components/footer.astro';
-
-## Overview
-
-The `CreateReturnLabel` message is a command used to create a return label for a specific shipment, identified by its `shipmentId`. It provides information such as the shipment status (e.g., pending, completed, shipped), the items within the shipment, 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 command can be applied in e-commerce systems, marketplaces, or any platform where users and systems need real-time shipment data for tracking, auditing, or managing customer purchases.
-
-<NodeGraph />
-
-<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/ShippingService/commands/CreateReturnLabel/schema.json

@@ -1,19 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "title": "CreateReturnLabel",
-  "description": "Schema for creating a return shipping label",
-  "properties": {
-    "CreateReturnLabel": {
-      "type": "object",
-      "properties": {
-        "shipmentId": {
-          "type": "string",
-          "description": "Unique identifier for the shipment"
-        }
-      },
-      "required": ["shipmentId"]
-    }
-  },
-  "required": ["CreateReturnLabel"]
-}

package/templates/default/domains/Orders/services/ShippingService/commands/CreateShipment/index.mdx

@@ -1,22 +0,0 @@
----
-id: CreateShipment
-name: Create shipment
-version: 0.0.1
-summary: |
-  POST request that will create a shipment for a specific order, identified by its orderId.
-owners:
-  - dboyne
-schemaPath: schema.json
----
-
-import Footer from '@catalog/components/footer.astro';
-
-## Overview
-
-The `CreateShipment` message is a command used to create a shipment for 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 command 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/ShippingService/commands/CreateShipment/schema.json

@@ -1,62 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "properties": {
-    "shipmentId": {
-      "type": "string",
-      "description": "Unique identifier for the shipment"
-    },
-    "orderId": {
-      "type": "string",
-      "description": "Identifier for the associated order"
-    },
-    "address": {
-      "type": "object",
-      "properties": {
-        "street": {
-          "type": "string",
-          "description": "Street address for the shipment"
-        },
-        "city": {
-          "type": "string",
-          "description": "City for the shipment"
-        },
-        "state": {
-          "type": "string",
-          "description": "State for the shipment"
-        },
-        "postalCode": {
-          "type": "string",
-          "description": "Postal code for the shipment"
-        },
-        "country": {
-          "type": "string",
-          "description": "Country for the shipment"
-        }
-      },
-      "required": ["street", "city", "state", "postalCode", "country"]
-    },
-    "items": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "properties": {
-          "itemId": {
-            "type": "string",
-            "description": "Identifier for the item"
-          },
-          "quantity": {
-            "type": "integer",
-            "description": "Quantity of the item"
-          }
-        },
-        "required": ["itemId", "quantity"]
-      }
-    },
-    "shippingMethod": {
-      "type": "string",
-      "description": "Method of shipping (e.g., standard, express)"
-    }
-  },
-  "required": ["shipmentId", "orderId", "address", "items", "shippingMethod"]
-}

package/templates/default/domains/Orders/services/ShippingService/commands/UpdateShipmentStatus/index.mdx

@@ -1,22 +0,0 @@
----
-id: UpdateShipmentStatus
-name: Update shipment status
-version: 0.0.1
-summary: |
-  POST request that will update the status of a shipment, identified by its shipmentId.
-owners:
-  - dboyne
-schemaPath: schema.json
----
-
-import Footer from '@catalog/components/footer.astro';
-
-## Overview
-
-The `UpdateShipmentStatus` message is a command used to update the status of a shipment, identified by its `shipmentId`. It provides information such as the shipment status (e.g., pending, completed, shipped), the items within the shipment, 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 command can be applied in e-commerce systems, marketplaces, or any platform where users and systems need real-time shipment data for tracking, auditing, or managing customer purchases.
-
-<NodeGraph />
-
-<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/ShippingService/commands/UpdateShipmentStatus/schema.json

@@ -1,29 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "title": "UpdateShipmentStatus",
-  "description": "Schema for updating a shipment's status",
-  "properties": {
-    "UpdateShipmentStatus": {
-      "type": "object",
-      "properties": {
-        "shipmentId": {
-          "type": "string",
-          "description": "Unique identifier for the shipment"
-        },
-        "status": {
-          "type": "string",
-          "enum": ["pending", "shipped", "delivered", "returned"],
-          "description": "Current status of the shipment"
-        },
-        "updatedAt": {
-          "type": "string",
-          "format": "date-time",
-          "description": "Timestamp when the status was last updated"
-        }
-      },
-      "required": ["shipmentId", "status"]
-    }
-  },
-  "required": ["UpdateShipmentStatus"]
-}

package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/examples/address-not-found.json

@@ -1,23 +0,0 @@
-{
-  "eventId": "evt_df_60101",
-  "shipmentId": "shp_84201",
-  "orderId": "ord_10482",
-  "failedAt": "2026-03-14T14:30:00Z",
-  "carrier": "FedEx",
-  "trackingNumber": "FX7829041890",
-  "failureReason": "address_not_found",
-  "failureDetails": "Delivery address not found. The provided address does not match any known location.",
-  "deliveryAttempts": 1,
-  "destination": {
-    "line1": "999 Phantom Lane",
-    "city": "Denver",
-    "state": "CO",
-    "zipCode": "80201",
-    "country": "US"
-  },
-  "nextAction": "contact_customer",
-  "customer": {
-    "customerId": "cust_8901",
-    "email": "taylor.morgan@example.com"
-  }
-}

package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/examples/customer-unavailable.json

@@ -1,40 +0,0 @@
-{
-  "eventId": "evt_df_60108",
-  "shipmentId": "shp_84305",
-  "orderId": "ord_10596",
-  "failedAt": "2026-03-15T17:45:00Z",
-  "carrier": "UPS",
-  "trackingNumber": "1Z9R8F030392850142",
-  "failureReason": "customer_unavailable",
-  "failureDetails": "Customer unavailable. Three delivery attempts were made with no response.",
-  "deliveryAttempts": 3,
-  "attemptHistory": [
-    {
-      "attempt": 1,
-      "timestamp": "2026-03-13T10:30:00Z",
-      "notes": "No answer at door"
-    },
-    {
-      "attempt": 2,
-      "timestamp": "2026-03-14T14:15:00Z",
-      "notes": "No answer at door, left notice"
-    },
-    {
-      "attempt": 3,
-      "timestamp": "2026-03-15T17:45:00Z",
-      "notes": "Final attempt, no answer"
-    }
-  ],
-  "destination": {
-    "line1": "310 Oak Avenue",
-    "city": "Seattle",
-    "state": "WA",
-    "zipCode": "98101",
-    "country": "US"
-  },
-  "nextAction": "return_to_warehouse",
-  "customer": {
-    "customerId": "cust_9340",
-    "email": "chris.baker@example.com"
-  }
-}

package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/examples/damaged-in-transit.json

@@ -1,33 +0,0 @@
-{
-  "eventId": "evt_df_60115",
-  "shipmentId": "shp_84410",
-  "orderId": "ord_10703",
-  "failedAt": "2026-03-13T08:20:00Z",
-  "carrier": "FedEx",
-  "trackingNumber": "FX7829042104",
-  "failureReason": "damaged_in_transit",
-  "failureDetails": "Package damaged in transit. Item was returned to the warehouse for inspection.",
-  "deliveryAttempts": 0,
-  "damageReport": {
-    "reportId": "dmg_5501",
-    "severity": "major",
-    "description": "Outer packaging crushed, visible damage to contents",
-    "reportedBy": "warehouse_staff",
-    "photos": [
-      "https://cdn.shipping.example.com/damage-reports/dmg_5501_01.jpg",
-      "https://cdn.shipping.example.com/damage-reports/dmg_5501_02.jpg"
-    ]
-  },
-  "destination": {
-    "line1": "88 River Road",
-    "city": "Portland",
-    "state": "OR",
-    "zipCode": "97201",
-    "country": "US"
-  },
-  "nextAction": "reship_order",
-  "customer": {
-    "customerId": "cust_9412",
-    "email": "sam.nguyen@example.com"
-  }
-}

package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/examples/examples.config.yaml

@@ -1,23 +0,0 @@
-address-not-found.json:
-  name: Address Not Found
-  summary: Delivery failed because the provided address could not be located by the carrier.
-  usage: |
-    curl -X POST http://localhost:3000/events/publish \
-      -H "Content-Type: application/json" \
-      -d @address-not-found.json
-
-customer-unavailable.json:
-  name: Customer Unavailable
-  summary: Three delivery attempts were made but the customer was not available to receive the package.
-  usage: |
-    curl -X POST http://localhost:3000/events/publish \
-      -H "Content-Type: application/json" \
-      -d @customer-unavailable.json
-
-damaged-in-transit.json:
-  name: Damaged in Transit
-  summary: Package was damaged during shipping and returned to the warehouse for inspection.
-  usage: |
-    curl -X POST http://localhost:3000/events/publish \
-      -H "Content-Type: application/json" \
-      -d @damaged-in-transit.json

package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/index.mdx

@@ -1,22 +0,0 @@
----
-id: DeliveryFailed
-name: Delivery failed
-version: 0.0.1
-summary: |
-  Event that is emitted when a shipment delivery fails.
-owners:
-  - dboyne
-schemaPath: schema.json
----
-
-import Footer from '@catalog/components/footer.astro';
-
-## Overview
-
-The `DeliveryFailed` event is emitted when a shipment delivery fails. It provides information such as the shipment status (e.g., pending, completed, shipped), the items within the shipment, 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 event can be applied in e-commerce systems, marketplaces, or any platform where users and systems need real-time shipment data for tracking, auditing, or managing customer purchases.
-
-<NodeGraph />
-
-<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/schema.json

@@ -1,17 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "title": "DeliveryFailed",
-  "description": "Schema for delivery failed event",
-  "properties": {
-    "shipmentId": {
-      "type": "string",
-      "description": "Unique identifier for the shipment"
-    },
-    "orderId": {
-      "type": "string",
-      "description": "Identifier for the associated order"
-    }
-  },
-  "required": ["shipmentId", "orderId"]
-}

package/templates/default/domains/Orders/services/ShippingService/events/ReturnInitiated/examples/defective-item.json

@@ -1,33 +0,0 @@
-{
-  "eventId": "evt_ret_70301",
-  "returnId": "ret_22010",
-  "shipmentId": "shp_88190",
-  "orderId": "ord_10450",
-  "initiatedAt": "2026-03-09T10:22:00Z",
-  "reason": "defective_item",
-  "reasonDetails": "Screen has a dead pixel cluster in the upper-left corner. Noticed after unboxing.",
-  "items": [
-    {
-      "itemId": "item_30291",
-      "sku": "ELEC-MON-27-4K",
-      "name": "27\" 4K Monitor",
-      "quantity": 1,
-      "pricePerUnit": 449.99
-    }
-  ],
-  "customer": {
-    "customerId": "cust_8842",
-    "email": "alex.rivera@example.com"
-  },
-  "returnMethod": "carrier_pickup",
-  "returnLabel": {
-    "carrier": "UPS",
-    "trackingNumber": "1Z9R8F030392811204",
-    "labelUrl": "https://cdn.shipping.example.com/return-labels/ret_22010.pdf"
-  },
-  "refundEstimate": {
-    "amount": 449.99,
-    "currency": "USD",
-    "method": "original_payment"
-  }
-}