npm - @eventcatalog/create-eventcatalog - Versions diffs - 4.1.2 → 4.1.3 - Mend

@eventcatalog/create-eventcatalog 4.1.2 → 4.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (24) hide show

package/dist/index.js CHANGED Viewed

@@ -29809,7 +29809,7 @@ var import_os2 = __toESM(require("os"));
 var package_default = {
   name: "@eventcatalog/create-eventcatalog",
   description: "Create EventCatalog with one command",
-  version: "4.1.2",
+  version: "4.1.3",
   bin: {
     "create-catalog": "./dist/index.js"
   },

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@eventcatalog/create-eventcatalog",
   "description": "Create EventCatalog with one command",
-  "version": "4.1.2",
+  "version": "4.1.3",
   "bin": {
     "create-catalog": "./dist/index.js"
   },

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/0.0.1/index.mdx CHANGED Viewed

@@ -2,6 +2,7 @@
 id: InventoryAdjusted
 name: Inventory adjusted
 version: 0.0.1
+schemaPath: schema.json
 summary: |
   Indicates a change in inventory level
 owners:

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/0.0.1/schema.json ADDED Viewed

@@ -0,0 +1,36 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "event_id": {
+      "type": "string",
+      "description": "Unique identifier for the event"
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Timestamp of the inventory adjustment"
+    },
+    "product_id": {
+      "type": "string",
+      "description": "Identifier of the adjusted product"
+    },
+    "adjusted_quantity": {
+      "type": "integer",
+      "description": "The quantity adjusted (positive or negative)"
+    },
+    "new_quantity": {
+      "type": "integer",
+      "description": "The new total inventory quantity"
+    },
+    "adjustment_reason": {
+      "type": "string",
+      "description": "Reason for the adjustment"
+    },
+    "adjusted_by": {
+      "type": "string",
+      "description": "Identifier of the user who made the adjustment"
+    }
+  },
+  "required": ["event_id", "timestamp", "product_id", "adjusted_quantity", "new_quantity"]
+}

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/1.0.0/index.mdx CHANGED Viewed

@@ -2,6 +2,7 @@
 id: InventoryAdjusted
 name: Inventory adjusted
 version: 1.0.0
+schemaPath: schema.json
 summary: |
   Indicates a change in inventory level
 owners:

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/1.0.0/schema.json ADDED Viewed

@@ -0,0 +1,36 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "event_id": {
+      "type": "string",
+      "description": "Unique identifier for the event"
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Timestamp of the inventory adjustment"
+    },
+    "product_id": {
+      "type": "string",
+      "description": "Identifier of the adjusted product"
+    },
+    "adjusted_quantity": {
+      "type": "integer",
+      "description": "The quantity adjusted (positive or negative)"
+    },
+    "new_quantity": {
+      "type": "integer",
+      "description": "The new total inventory quantity"
+    },
+    "adjustment_reason": {
+      "type": "string",
+      "description": "Reason for the adjustment"
+    },
+    "adjusted_by": {
+      "type": "string",
+      "description": "Identifier of the user who made the adjustment"
+    }
+  },
+  "required": ["event_id", "timestamp", "product_id", "adjusted_quantity", "new_quantity"]
+}

package/templates/default/domains/Orders/services/InventoryService/events/OutOfStock/index.mdx CHANGED Viewed

@@ -2,6 +2,7 @@
 id: OutOfStock
 name: Inventory out of stock
 version: 0.0.4
+schemaPath: schema.json
 summary: |
   Indicates inventory is out of stock
 owners:

package/templates/default/domains/Orders/services/InventoryService/events/OutOfStock/schema.json ADDED Viewed

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "event_id": {
+      "type": "string",
+      "description": "Unique identifier for the event"
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Timestamp when the out-of-stock condition was detected"
+    },
+    "product_id": {
+      "type": "string",
+      "description": "Identifier of the out-of-stock product"
+    },
+    "last_available_quantity": {
+      "type": "integer",
+      "description": "The last known available quantity before stock ran out"
+    },
+    "warehouse_id": {
+      "type": "string",
+      "description": "Identifier of the warehouse reporting the stock-out"
+    }
+  },
+  "required": ["event_id", "timestamp", "product_id"]
+}

package/templates/default/domains/Orders/services/InventoryService/events/OutOfStock/versioned/0.0.1/index.mdx CHANGED Viewed

@@ -2,6 +2,7 @@
 id: OutOfStock
 name: Inventory out of stock
 version: 0.0.1
+schemaPath: schema.json
 summary: |
   Indicates inventory is out of stock
 owners:

package/templates/default/domains/Orders/services/InventoryService/events/OutOfStock/versioned/0.0.1/schema.json ADDED Viewed

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "event_id": {
+      "type": "string",
+      "description": "Unique identifier for the event"
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Timestamp when the out-of-stock condition was detected"
+    },
+    "product_id": {
+      "type": "string",
+      "description": "Identifier of the out-of-stock product"
+    },
+    "last_available_quantity": {
+      "type": "integer",
+      "description": "The last known available quantity before stock ran out"
+    },
+    "warehouse_id": {
+      "type": "string",
+      "description": "Identifier of the warehouse reporting the stock-out"
+    }
+  },
+  "required": ["event_id", "timestamp", "product_id"]
+}

package/templates/default/domains/Payment/services/PaymentService/events/PaymentInitiated/index.mdx CHANGED Viewed

@@ -2,6 +2,7 @@
 id: PaymentInitiated
 name: Payment Initiated
 version: 0.0.1
+schemaPath: schema.json
 summary: Event is triggered when a user initiates a payment through the Payment Service
 owners:
   - dboyne

package/templates/default/domains/Payment/services/PaymentService/events/PaymentInitiated/schema.json ADDED Viewed

@@ -0,0 +1,31 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "userId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the user initiating the payment"
+    },
+    "orderId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the associated order"
+    },
+    "amount": {
+      "type": "number",
+      "description": "Payment amount"
+    },
+    "paymentMethod": {
+      "type": "string",
+      "enum": ["CreditCard", "DebitCard", "BankTransfer", "PayPal"],
+      "description": "The payment method used"
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the payment was initiated"
+    }
+  },
+  "required": ["userId", "orderId", "amount", "paymentMethod", "timestamp"]
+}

package/templates/default/domains/Payment/services/PaymentService/events/PaymentProcessed/index.mdx CHANGED Viewed

@@ -2,6 +2,7 @@
 id: PaymentProcessed
 name: Payment Processed
 version: 1.0.0
+schemaPath: schema.json
 summary: Event is triggered after the payment has been successfully processed
 owners:
   - dboyne

package/templates/default/domains/Payment/services/PaymentService/events/PaymentProcessed/schema.json ADDED Viewed

@@ -0,0 +1,54 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "transactionId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier for the transaction"
+    },
+    "userId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the user"
+    },
+    "orderId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the associated order"
+    },
+    "amount": {
+      "type": "number",
+      "description": "Payment amount processed"
+    },
+    "paymentMethod": {
+      "type": "string",
+      "enum": ["CreditCard", "DebitCard", "BankTransfer", "PayPal"],
+      "description": "The payment method used"
+    },
+    "status": {
+      "type": "string",
+      "enum": ["confirmed", "pending", "failed"],
+      "description": "Status of the payment"
+    },
+    "confirmationDetails": {
+      "type": "object",
+      "properties": {
+        "gatewayResponse": {
+          "type": "string",
+          "description": "Response from the payment gateway"
+        },
+        "transactionId": {
+          "type": "string",
+          "description": "Gateway transaction identifier"
+        }
+      }
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the payment was processed"
+    }
+  },
+  "required": ["transactionId", "userId", "orderId", "amount", "status", "timestamp"]
+}

package/templates/default/domains/Payment/services/PaymentService/events/PaymentProcessed/versioned/0.0.1/index.mdx CHANGED Viewed

@@ -2,6 +2,7 @@
 id: PaymentProcessed
 name: Payment Processed
 version: 0.0.1
+schemaPath: schema.json
 summary: Event is triggered after the payment has been successfully processed
 owners:
     - dboyne

package/templates/default/domains/Payment/services/PaymentService/events/PaymentProcessed/versioned/0.0.1/schema.json ADDED Viewed

@@ -0,0 +1,54 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "transactionId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier for the transaction"
+    },
+    "userId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the user"
+    },
+    "orderId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the associated order"
+    },
+    "amount": {
+      "type": "number",
+      "description": "Payment amount processed"
+    },
+    "paymentMethod": {
+      "type": "string",
+      "enum": ["CreditCard", "DebitCard", "BankTransfer", "PayPal"],
+      "description": "The payment method used"
+    },
+    "status": {
+      "type": "string",
+      "enum": ["confirmed", "pending", "failed"],
+      "description": "Status of the payment"
+    },
+    "confirmationDetails": {
+      "type": "object",
+      "properties": {
+        "gatewayResponse": {
+          "type": "string",
+          "description": "Response from the payment gateway"
+        },
+        "transactionId": {
+          "type": "string",
+          "description": "Gateway transaction identifier"
+        }
+      }
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the payment was processed"
+    }
+  },
+  "required": ["transactionId", "userId", "orderId", "amount", "status", "timestamp"]
+}

package/templates/default/domains/Subscriptions/services/SubscriptionService/commands/CancelSubscription/index.mdx CHANGED Viewed

@@ -2,6 +2,7 @@
 id: CancelSubscription
 name: Cancel subscription
 version: 0.0.1
+schemaPath: schema.json
 summary: |
   Command that will try and cancel a users subscription
 owners:

package/templates/default/domains/Subscriptions/services/SubscriptionService/commands/CancelSubscription/schema.json ADDED Viewed

@@ -0,0 +1,30 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "subscriptionId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the subscription to cancel"
+    },
+    "userId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the user requesting cancellation"
+    },
+    "reason": {
+      "type": "string",
+      "description": "Reason for cancellation"
+    },
+    "cancelImmediately": {
+      "type": "boolean",
+      "description": "Whether to cancel immediately or at end of billing period"
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the cancellation was requested"
+    }
+  },
+  "required": ["subscriptionId", "userId", "timestamp"]
+}

package/templates/default/domains/Subscriptions/services/SubscriptionService/commands/SubscribeUser/index.mdx CHANGED Viewed

@@ -2,6 +2,7 @@
 id: SubscribeUser
 name: Subscribe user
 version: 0.0.1
+schemaPath: schema.json
 summary: |
   Command that will try and subscribe a given user
 owners:

package/templates/default/domains/Subscriptions/services/SubscriptionService/commands/SubscribeUser/schema.json ADDED Viewed

@@ -0,0 +1,31 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "userId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the user to subscribe"
+    },
+    "planId": {
+      "type": "string",
+      "description": "Identifier of the subscription plan"
+    },
+    "paymentMethod": {
+      "type": "string",
+      "enum": ["CreditCard", "DebitCard", "BankTransfer", "PayPal"],
+      "description": "The payment method for the subscription"
+    },
+    "startDate": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the subscription should start"
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the command was issued"
+    }
+  },
+  "required": ["userId", "planId", "paymentMethod", "timestamp"]
+}

package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionCancelled/index.mdx CHANGED Viewed

@@ -2,6 +2,7 @@
 id: UserSubscriptionCancelled
 name: User subscription cancelled
 version: 0.0.1
+schemaPath: schema.json
 summary: |
   An event that is triggered when a users subscription has been cancelled
 owners:

package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionCancelled/schema.json ADDED Viewed

@@ -0,0 +1,35 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "subscriptionId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the cancelled subscription"
+    },
+    "userId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the user"
+    },
+    "planId": {
+      "type": "string",
+      "description": "Identifier of the subscription plan"
+    },
+    "cancellationReason": {
+      "type": "string",
+      "description": "Reason for the cancellation"
+    },
+    "effectiveDate": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the cancellation takes effect"
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the cancellation event occurred"
+    }
+  },
+  "required": ["subscriptionId", "userId", "timestamp"]
+}

package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionStarted/index.mdx CHANGED Viewed

@@ -2,6 +2,7 @@
 id: UserSubscriptionStarted
 name: User subscription started
 version: 0.0.1
+schemaPath: schema.json
 summary: |
   An event that is triggered when a new user subscription has started
 owners:

package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionStarted/schema.json ADDED Viewed

@@ -0,0 +1,36 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "subscriptionId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the new subscription"
+    },
+    "userId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier of the subscribed user"
+    },
+    "planId": {
+      "type": "string",
+      "description": "Identifier of the subscription plan"
+    },
+    "startDate": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the subscription started"
+    },
+    "billingCycle": {
+      "type": "string",
+      "enum": ["monthly", "quarterly", "yearly"],
+      "description": "The billing cycle for the subscription"
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the subscription started event occurred"
+    }
+  },
+  "required": ["subscriptionId", "userId", "planId", "startDate", "timestamp"]
+}