@eventcatalog/create-eventcatalog 2.1.0 → 2.1.1
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.
package/dist/index.js
CHANGED
|
@@ -22466,7 +22466,7 @@ var import_os2 = __toESM(require("os"));
|
|
|
22466
22466
|
var package_default = {
|
|
22467
22467
|
name: "@eventcatalog/create-eventcatalog",
|
|
22468
22468
|
description: "Create EventCatalog with one command",
|
|
22469
|
-
version: "2.1.
|
|
22469
|
+
version: "2.1.1",
|
|
22470
22470
|
bin: {
|
|
22471
22471
|
"create-catalog": "./dist/index.js"
|
|
22472
22472
|
},
|
package/package.json
CHANGED
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
---
|
|
2
|
+
dictionary:
|
|
3
|
+
- id: Payment
|
|
4
|
+
name: Payment
|
|
5
|
+
summary: "The act of paying for magical goods or services."
|
|
6
|
+
icon: Wand2
|
|
7
|
+
- id: Purchase Order
|
|
8
|
+
name: Purchase Order
|
|
9
|
+
summary: "A mystical document issued by a buyer to a seller indicating the types, quantities, and agreed prices for enchanted products or services."
|
|
10
|
+
description: |
|
|
11
|
+
A purchase order (PO) is a magical document that initiates the buying process between mystical entities. It protects both buyer and seller by clearly documenting the transaction details. Key components include:
|
|
12
|
+
|
|
13
|
+
- Unique PO number for tracking
|
|
14
|
+
- Detailed item specifications and quantities
|
|
15
|
+
- Agreed prices and payment terms
|
|
16
|
+
- Delivery requirements and timelines
|
|
17
|
+
- Terms and conditions of the purchase
|
|
18
|
+
|
|
19
|
+
POs are essential for budget control, audit trails, and inventory management. They help prevent unauthorized purchases and provide a clear record for accounting and reconciliation purposes.
|
|
20
|
+
icon: FileText
|
|
21
|
+
- id: Order Line
|
|
22
|
+
name: Order Line
|
|
23
|
+
summary: "An individual enchanted item within a purchase order, representing a specific magical product or service being ordered."
|
|
24
|
+
description: |
|
|
25
|
+
Order lines are the fundamental building blocks of any purchase order. Each line represents a distinct item or service and contains critical information for order fulfillment:
|
|
26
|
+
|
|
27
|
+
- Product identifier (SKU or part number)
|
|
28
|
+
- Quantity ordered
|
|
29
|
+
- Unit price and total line value
|
|
30
|
+
- Special handling instructions
|
|
31
|
+
- Required delivery date
|
|
32
|
+
|
|
33
|
+
Order lines drive warehouse picking operations, shipping processes, and financial calculations. They are essential for tracking partial shipments and managing order modifications.
|
|
34
|
+
icon: ListOrdered
|
|
35
|
+
- id: SKU
|
|
36
|
+
name: SKU
|
|
37
|
+
summary: "Sorcery Keeping Unit - A unique identifier for distinct magical products and their variants in inventory."
|
|
38
|
+
description: |
|
|
39
|
+
SKUs are the cornerstone of effective inventory management systems. Each SKU represents a unique combination of product attributes:
|
|
40
|
+
|
|
41
|
+
- Product variations (size, color, style)
|
|
42
|
+
- Storage location identifiers
|
|
43
|
+
- Supplier information
|
|
44
|
+
- Reorder points and quantities
|
|
45
|
+
|
|
46
|
+
SKUs enable precise inventory tracking, automated reordering, and detailed sales analytics. They are crucial for maintaining optimal stock levels and preventing stockouts or overstock situations.
|
|
47
|
+
icon: Tag
|
|
48
|
+
- id: Consignment
|
|
49
|
+
name: Consignment
|
|
50
|
+
summary: "A batch of enchanted goods destined for or delivered to someone."
|
|
51
|
+
description: |
|
|
52
|
+
A consignment represents the physical movement of goods through the supply chain. It encompasses all aspects of the shipping process:
|
|
53
|
+
|
|
54
|
+
- Packaging and labeling requirements
|
|
55
|
+
- Transportation method and routing
|
|
56
|
+
- Customs documentation for international shipments
|
|
57
|
+
- Tracking and proof of delivery
|
|
58
|
+
|
|
59
|
+
Consignments may combine multiple orders for efficient shipping and can be tracked as a single unit throughout the delivery process. They are crucial for managing logistics costs and ensuring timely delivery to customers.
|
|
60
|
+
icon: Package
|
|
61
|
+
- id: Invoice
|
|
62
|
+
name: Invoice
|
|
63
|
+
summary: "A document issued by a seller to a buyer, listing enchanted goods or services provided and the amount due."
|
|
64
|
+
description: |
|
|
65
|
+
Invoices are critical for financial transactions, serving as a request for payment from the buyer. They include:
|
|
66
|
+
|
|
67
|
+
- Invoice number for tracking
|
|
68
|
+
- List of products or services provided
|
|
69
|
+
- Total amount due and payment terms
|
|
70
|
+
- Seller and buyer contact information
|
|
71
|
+
- Due date for payment
|
|
72
|
+
|
|
73
|
+
Invoices are essential for accounting, tax purposes, and maintaining cash flow.
|
|
74
|
+
icon: Receipt
|
|
75
|
+
- id: Supplier
|
|
76
|
+
name: Supplier
|
|
77
|
+
summary: "An entity that provides enchanted goods or services to another organization."
|
|
78
|
+
description: |
|
|
79
|
+
Suppliers are key partners in the supply chain, responsible for delivering the necessary products or services. Key aspects include:
|
|
80
|
+
|
|
81
|
+
- Supplier identification and contact details
|
|
82
|
+
- Product or service offerings
|
|
83
|
+
- Pricing and payment terms
|
|
84
|
+
- Delivery schedules and reliability
|
|
85
|
+
|
|
86
|
+
Effective supplier management ensures quality, cost-effectiveness, and timely delivery.
|
|
87
|
+
icon: Truck
|
|
88
|
+
- id: Inventory
|
|
89
|
+
name: Inventory
|
|
90
|
+
summary: "The complete list of enchanted items held in stock by a business."
|
|
91
|
+
description: |
|
|
92
|
+
Inventory management is crucial for balancing supply and demand. It involves:
|
|
93
|
+
|
|
94
|
+
- Tracking stock levels and locations
|
|
95
|
+
- Managing reorder points and quantities
|
|
96
|
+
- Conducting regular stock audits
|
|
97
|
+
- Analyzing inventory turnover rates
|
|
98
|
+
|
|
99
|
+
Proper inventory management minimizes costs and maximizes service levels.
|
|
100
|
+
icon: Warehouse
|
|
101
|
+
- id: Fulfillment
|
|
102
|
+
name: Fulfillment
|
|
103
|
+
summary: "The process of completing an order and delivering it to the customer."
|
|
104
|
+
description: |
|
|
105
|
+
Fulfillment encompasses all steps from order receipt to delivery, including:
|
|
106
|
+
|
|
107
|
+
- Order processing and picking
|
|
108
|
+
- Packaging and shipping
|
|
109
|
+
- Delivery tracking and confirmation
|
|
110
|
+
- Handling returns and exchanges
|
|
111
|
+
|
|
112
|
+
Efficient fulfillment is key to customer satisfaction and operational efficiency.
|
|
113
|
+
icon: PackageCheck
|
|
114
|
+
- id: Return
|
|
115
|
+
name: Return
|
|
116
|
+
summary: "The process of sending back enchanted goods to the seller for a refund or exchange."
|
|
117
|
+
description: |
|
|
118
|
+
Returns management is an important aspect of customer service and inventory control. It involves:
|
|
119
|
+
|
|
120
|
+
- Processing return requests and authorizations
|
|
121
|
+
- Inspecting returned items for quality
|
|
122
|
+
- Restocking or disposing of returned goods
|
|
123
|
+
- Issuing refunds or exchanges
|
|
124
|
+
|
|
125
|
+
A streamlined returns process enhances customer loyalty and operational efficiency.
|
|
126
|
+
icon: PackageX
|
|
127
|
+
---
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
---
|
|
2
|
+
dictionary:
|
|
3
|
+
- id: Transaction
|
|
4
|
+
name: Transaction
|
|
5
|
+
summary: "The process of transferring funds from one party to another."
|
|
6
|
+
icon: CreditCard
|
|
7
|
+
- id: Invoice
|
|
8
|
+
name: Invoice
|
|
9
|
+
summary: "A document issued by a seller to a buyer, listing goods or services provided and the amount due."
|
|
10
|
+
description: |
|
|
11
|
+
Invoices are critical for financial transactions, serving as a request for payment from the buyer. They include:
|
|
12
|
+
|
|
13
|
+
- Invoice number for tracking
|
|
14
|
+
- List of products or services provided
|
|
15
|
+
- Total amount due and payment terms
|
|
16
|
+
- Seller and buyer contact information
|
|
17
|
+
- Due date for payment
|
|
18
|
+
|
|
19
|
+
Invoices are essential for accounting, tax purposes, and maintaining cash flow.
|
|
20
|
+
icon: CreditCard
|
|
21
|
+
- id: Payment Method
|
|
22
|
+
name: Payment Method
|
|
23
|
+
summary: "The means by which a payment is made, such as credit card or bank transfer."
|
|
24
|
+
description: |
|
|
25
|
+
Payment methods are the various ways customers can pay for goods or services. Common methods include:
|
|
26
|
+
|
|
27
|
+
- Credit and debit cards
|
|
28
|
+
- Bank transfers
|
|
29
|
+
- Digital wallets
|
|
30
|
+
- Cash on delivery
|
|
31
|
+
|
|
32
|
+
Offering multiple payment methods can enhance customer satisfaction and increase sales.
|
|
33
|
+
icon: Wallet
|
|
34
|
+
- id: Receipt
|
|
35
|
+
name: Receipt
|
|
36
|
+
summary: "A document acknowledging that a payment has been made."
|
|
37
|
+
description: |
|
|
38
|
+
Receipts serve as proof of payment and are important for record-keeping. They typically include:
|
|
39
|
+
|
|
40
|
+
- Receipt number
|
|
41
|
+
- Date and time of payment
|
|
42
|
+
- Amount paid
|
|
43
|
+
- Payment method used
|
|
44
|
+
- Details of the transaction
|
|
45
|
+
|
|
46
|
+
Receipts are essential for both customers and businesses to track financial transactions.
|
|
47
|
+
icon: Receipt
|
|
48
|
+
- id: Refund
|
|
49
|
+
name: Refund
|
|
50
|
+
summary: "The process of returning funds to a customer for a returned product or service."
|
|
51
|
+
description: |
|
|
52
|
+
Refunds are issued when a customer returns a product or cancels a service. The process involves:
|
|
53
|
+
|
|
54
|
+
- Verifying the return or cancellation
|
|
55
|
+
- Processing the refund through the original payment method
|
|
56
|
+
- Updating financial records
|
|
57
|
+
|
|
58
|
+
Efficient refund processes can improve customer satisfaction and loyalty.
|
|
59
|
+
icon: RotateCcw
|
|
60
|
+
- id: Currency
|
|
61
|
+
name: Currency
|
|
62
|
+
summary: "The system of money in general use in a particular country."
|
|
63
|
+
description: |
|
|
64
|
+
Currency is the medium of exchange for goods and services. Key aspects include:
|
|
65
|
+
|
|
66
|
+
- Currency code (e.g., USD, EUR)
|
|
67
|
+
- Exchange rates
|
|
68
|
+
- Currency symbols
|
|
69
|
+
|
|
70
|
+
Understanding currency is crucial for international transactions and financial reporting.
|
|
71
|
+
icon: DollarSign
|
|
72
|
+
- id: Payment Gateway
|
|
73
|
+
name: Payment Gateway
|
|
74
|
+
summary: "A service that authorizes and processes payments for online and offline transactions."
|
|
75
|
+
description: |
|
|
76
|
+
Payment gateways facilitate the transfer of payment information between the customer and the merchant. They ensure secure and efficient transactions by:
|
|
77
|
+
|
|
78
|
+
- Encrypting sensitive data
|
|
79
|
+
- Authorizing payments
|
|
80
|
+
- Providing transaction reports
|
|
81
|
+
|
|
82
|
+
Choosing a reliable payment gateway is essential for business operations.
|
|
83
|
+
icon: Server
|
|
84
|
+
- id: Chargeback
|
|
85
|
+
name: Chargeback
|
|
86
|
+
summary: "A demand by a credit card provider for a retailer to make good the loss on a fraudulent or disputed transaction."
|
|
87
|
+
description: |
|
|
88
|
+
Chargebacks occur when a customer disputes a transaction, and the funds are returned to their account. The process involves:
|
|
89
|
+
|
|
90
|
+
- Investigating the dispute
|
|
91
|
+
- Providing evidence to the payment processor
|
|
92
|
+
- Resolving the issue with the customer
|
|
93
|
+
|
|
94
|
+
Managing chargebacks effectively can prevent financial losses and maintain customer trust.
|
|
95
|
+
icon: AlertCircle
|
|
96
|
+
---
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
---
|
|
2
|
+
dictionary:
|
|
3
|
+
- id: Subscription
|
|
4
|
+
name: Subscription
|
|
5
|
+
summary: "A recurring agreement where a customer pays for access to a product or service at regular intervals."
|
|
6
|
+
description: |
|
|
7
|
+
A subscription represents an ongoing relationship between customer and provider. Key aspects include:
|
|
8
|
+
|
|
9
|
+
- Subscription plan details
|
|
10
|
+
- Billing frequency
|
|
11
|
+
- Access rights and limitations
|
|
12
|
+
- Start and end dates
|
|
13
|
+
- Auto-renewal settings
|
|
14
|
+
|
|
15
|
+
Subscriptions provide predictable revenue for businesses and convenient access for customers.
|
|
16
|
+
icon: Repeat
|
|
17
|
+
- id: Billing Cycle
|
|
18
|
+
name: Billing Cycle
|
|
19
|
+
summary: "The recurring period for which a subscription is billed."
|
|
20
|
+
description: |
|
|
21
|
+
Billing cycles define when payments are collected and services are provided. They include:
|
|
22
|
+
|
|
23
|
+
- Cycle duration (monthly, annually, etc.)
|
|
24
|
+
- Billing date
|
|
25
|
+
- Payment due dates
|
|
26
|
+
- Pro-ration rules
|
|
27
|
+
- Grace periods
|
|
28
|
+
|
|
29
|
+
Clear billing cycles help manage customer expectations and cash flow.
|
|
30
|
+
icon: Calendar
|
|
31
|
+
- id: Plan
|
|
32
|
+
name: Plan
|
|
33
|
+
summary: "A specific subscription offering with defined features, pricing, and terms."
|
|
34
|
+
description: |
|
|
35
|
+
Subscription plans define the service levels available to customers. They specify:
|
|
36
|
+
|
|
37
|
+
- Feature sets and limitations
|
|
38
|
+
- Pricing structure
|
|
39
|
+
- Billing frequency options
|
|
40
|
+
- Usage allowances
|
|
41
|
+
- Additional benefits
|
|
42
|
+
|
|
43
|
+
Well-designed plans cater to different customer segments and needs.
|
|
44
|
+
icon: Layout
|
|
45
|
+
- id: Trial Period
|
|
46
|
+
name: Trial Period
|
|
47
|
+
summary: "A promotional period allowing customers to test a subscription service before committing."
|
|
48
|
+
description: |
|
|
49
|
+
Trial periods help customers evaluate the service risk-free. They include:
|
|
50
|
+
|
|
51
|
+
- Duration of trial
|
|
52
|
+
- Available features
|
|
53
|
+
- Conversion process
|
|
54
|
+
- Payment information requirements
|
|
55
|
+
- Trial end notifications
|
|
56
|
+
|
|
57
|
+
Effective trials can increase conversion rates to paid subscriptions.
|
|
58
|
+
icon: Clock
|
|
59
|
+
- id: Auto-Renewal
|
|
60
|
+
name: Auto-Renewal
|
|
61
|
+
summary: "Automatic continuation of a subscription at the end of each billing period."
|
|
62
|
+
description: |
|
|
63
|
+
Auto-renewal ensures service continuity for customers. The process includes:
|
|
64
|
+
|
|
65
|
+
- Renewal notifications
|
|
66
|
+
- Payment processing
|
|
67
|
+
- Service extension
|
|
68
|
+
- Failed payment handling
|
|
69
|
+
- Cancellation options
|
|
70
|
+
|
|
71
|
+
Auto-renewal reduces churn and maintains steady revenue streams.
|
|
72
|
+
icon: RefreshCw
|
|
73
|
+
- id: Upgrade
|
|
74
|
+
name: Upgrade
|
|
75
|
+
summary: "The process of moving to a higher-tier subscription plan."
|
|
76
|
+
description: |
|
|
77
|
+
Upgrades allow customers to access more features or capacity. This involves:
|
|
78
|
+
|
|
79
|
+
- Plan comparison
|
|
80
|
+
- Pro-rated billing adjustments
|
|
81
|
+
- Feature activation
|
|
82
|
+
- Data migration if needed
|
|
83
|
+
- Service level changes
|
|
84
|
+
|
|
85
|
+
Smooth upgrade processes encourage customer growth.
|
|
86
|
+
icon: ArrowUpCircle
|
|
87
|
+
- id: Downgrade
|
|
88
|
+
name: Downgrade
|
|
89
|
+
summary: "The process of moving to a lower-tier subscription plan."
|
|
90
|
+
description: |
|
|
91
|
+
Downgrades adjust service levels to match customer needs. This includes:
|
|
92
|
+
|
|
93
|
+
- Feature reduction
|
|
94
|
+
- Billing adjustments
|
|
95
|
+
- Data retention policies
|
|
96
|
+
- Service level changes
|
|
97
|
+
- Customer retention strategies
|
|
98
|
+
|
|
99
|
+
Flexible downgrade options can prevent complete cancellations.
|
|
100
|
+
icon: ArrowDownCircle
|
|
101
|
+
- id: Cancellation
|
|
102
|
+
name: Cancellation
|
|
103
|
+
summary: "The termination of a subscription service."
|
|
104
|
+
description: |
|
|
105
|
+
Cancellation processes handle the end of subscription relationships. They cover:
|
|
106
|
+
|
|
107
|
+
- Notice periods
|
|
108
|
+
- Final billing
|
|
109
|
+
- Data retention/export
|
|
110
|
+
- Service access termination
|
|
111
|
+
- Reactivation options
|
|
112
|
+
|
|
113
|
+
Clear cancellation policies protect both customer and provider interests.
|
|
114
|
+
icon: XCircle
|
|
115
|
+
- id: Usage Limit
|
|
116
|
+
name: Usage Limit
|
|
117
|
+
summary: "Restrictions on service usage within a subscription plan."
|
|
118
|
+
description: |
|
|
119
|
+
Usage limits define the boundaries of service consumption. They include:
|
|
120
|
+
|
|
121
|
+
- Quantitative restrictions
|
|
122
|
+
- Monitoring systems
|
|
123
|
+
- Overage handling
|
|
124
|
+
- Alert mechanisms
|
|
125
|
+
- Upgrade triggers
|
|
126
|
+
|
|
127
|
+
Well-defined limits help manage resources and encourage appropriate plan selection.
|
|
128
|
+
icon: Gauge
|
|
129
|
+
---
|