@servemate/dto 1.0.3 → 1.0.4
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/README.md +39 -26
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
Data Transfer Objects (DTOs) package for the ServeMate restaurant management service. This package provides strongly typed DTOs using Zod for runtime validation.
|
|
4
4
|
|
|
5
|
+
This package is part of the [ServeMate](https://github.com/inmorpher/ServeMate-service) restaurant management system.
|
|
6
|
+
|
|
5
7
|
## Installation
|
|
6
8
|
|
|
7
9
|
```bash
|
|
@@ -19,6 +21,7 @@ npm install @servemate/dto
|
|
|
19
21
|
## Available DTOs
|
|
20
22
|
|
|
21
23
|
### User Management
|
|
24
|
+
|
|
22
25
|
- `UserDTO` - Complete user data structure
|
|
23
26
|
- `CreateUserDTO` - For user creation
|
|
24
27
|
- `UpdateUserDTO` - For partial user updates
|
|
@@ -26,6 +29,7 @@ npm install @servemate/dto
|
|
|
26
29
|
- `UserCredentials` - For authentication
|
|
27
30
|
|
|
28
31
|
### Order Management
|
|
32
|
+
|
|
29
33
|
- `OrderDTO` - Complete order structure
|
|
30
34
|
- `OrderCreateDTO` - For creating new orders
|
|
31
35
|
- `OrderUpdateDTO` - For updating orders
|
|
@@ -33,11 +37,13 @@ npm install @servemate/dto
|
|
|
33
37
|
- `OrderItemDTO` - For individual order items
|
|
34
38
|
|
|
35
39
|
### Payment Processing
|
|
40
|
+
|
|
36
41
|
- `PaymentDTO` - Complete payment data
|
|
37
42
|
- `PaymentSearchDTO` - For payment queries
|
|
38
43
|
- `RefundDTO` - For refund operations
|
|
39
44
|
|
|
40
45
|
### Table Management
|
|
46
|
+
|
|
41
47
|
- `TableDTO` - Complete table data
|
|
42
48
|
- `TableCreateDTO` - For creating tables
|
|
43
49
|
- `TableUpdateDTO` - For updating tables
|
|
@@ -45,6 +51,7 @@ npm install @servemate/dto
|
|
|
45
51
|
- `TableAssignmentDTO` - For server assignments
|
|
46
52
|
|
|
47
53
|
### Menu Items
|
|
54
|
+
|
|
48
55
|
- `FoodItemDTO` - For food items
|
|
49
56
|
- `DrinkItemDTO` - For drink items
|
|
50
57
|
- `CreateFoodItemDTO` - For creating food items
|
|
@@ -55,58 +62,62 @@ npm install @servemate/dto
|
|
|
55
62
|
## Enums
|
|
56
63
|
|
|
57
64
|
### User Related
|
|
65
|
+
|
|
58
66
|
```typescript
|
|
59
67
|
import { UserRole } from '@servemate/dto';
|
|
60
68
|
|
|
61
69
|
// Available roles
|
|
62
|
-
UserRole.ADMIN
|
|
63
|
-
UserRole.USER
|
|
64
|
-
UserRole.HOST
|
|
65
|
-
UserRole.MANAGER
|
|
70
|
+
UserRole.ADMIN;
|
|
71
|
+
UserRole.USER;
|
|
72
|
+
UserRole.HOST;
|
|
73
|
+
UserRole.MANAGER;
|
|
66
74
|
```
|
|
67
75
|
|
|
68
76
|
### Order Related
|
|
77
|
+
|
|
69
78
|
```typescript
|
|
70
79
|
import { OrderState } from '@servemate/dto';
|
|
71
80
|
|
|
72
81
|
// Order states
|
|
73
|
-
OrderState.AWAITING
|
|
74
|
-
OrderState.RECEIVED
|
|
75
|
-
OrderState.SERVED
|
|
76
|
-
OrderState.CANCELED
|
|
77
|
-
OrderState.DISPUTED
|
|
78
|
-
OrderState.READY_TO_PAY
|
|
79
|
-
OrderState.COMPLETED
|
|
82
|
+
OrderState.AWAITING;
|
|
83
|
+
OrderState.RECEIVED;
|
|
84
|
+
OrderState.SERVED;
|
|
85
|
+
OrderState.CANCELED;
|
|
86
|
+
OrderState.DISPUTED;
|
|
87
|
+
OrderState.READY_TO_PAY;
|
|
88
|
+
OrderState.COMPLETED;
|
|
80
89
|
```
|
|
81
90
|
|
|
82
91
|
### Payment Related
|
|
92
|
+
|
|
83
93
|
```typescript
|
|
84
94
|
import { PaymentMethod, PaymentState } from '@servemate/dto';
|
|
85
95
|
|
|
86
96
|
// Payment methods
|
|
87
|
-
PaymentMethod.CASH
|
|
88
|
-
PaymentMethod.CREDIT_CARD
|
|
89
|
-
PaymentMethod.DEBIT_CARD
|
|
97
|
+
PaymentMethod.CASH;
|
|
98
|
+
PaymentMethod.CREDIT_CARD;
|
|
99
|
+
PaymentMethod.DEBIT_CARD;
|
|
90
100
|
|
|
91
101
|
// Payment states
|
|
92
|
-
PaymentState.NONE
|
|
93
|
-
PaymentState.PAID
|
|
94
|
-
PaymentState.REFUNDED
|
|
95
|
-
PaymentState.CANCELLED
|
|
96
|
-
PaymentState.PENDING
|
|
102
|
+
PaymentState.NONE;
|
|
103
|
+
PaymentState.PAID;
|
|
104
|
+
PaymentState.REFUNDED;
|
|
105
|
+
PaymentState.CANCELLED;
|
|
106
|
+
PaymentState.PENDING;
|
|
97
107
|
```
|
|
98
108
|
|
|
99
109
|
## Usage Examples
|
|
100
110
|
|
|
101
111
|
### Creating a User
|
|
112
|
+
|
|
102
113
|
```typescript
|
|
103
114
|
import { CreateUserSchema, UserRole } from '@servemate/dto';
|
|
104
115
|
|
|
105
116
|
const userData = {
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
117
|
+
name: 'John Doe',
|
|
118
|
+
email: 'john@example.com',
|
|
119
|
+
role: UserRole.HOST,
|
|
120
|
+
password: 'secure123',
|
|
110
121
|
};
|
|
111
122
|
|
|
112
123
|
// Validates the data and returns typed result
|
|
@@ -114,6 +125,7 @@ const validUser = CreateUserSchema.parse(userData);
|
|
|
114
125
|
```
|
|
115
126
|
|
|
116
127
|
### Processing an Order
|
|
128
|
+
|
|
117
129
|
```typescript
|
|
118
130
|
import { OrderSchema, OrderState } from '@servemate/dto';
|
|
119
131
|
|
|
@@ -129,13 +141,14 @@ const validOrder = OrderSchema.parse(orderData);
|
|
|
129
141
|
```
|
|
130
142
|
|
|
131
143
|
### Handling Payments
|
|
144
|
+
|
|
132
145
|
```typescript
|
|
133
146
|
import { PaymentSchema, PaymentMethod } from '@servemate/dto';
|
|
134
147
|
|
|
135
148
|
const paymentData = {
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
149
|
+
amount: 50.0,
|
|
150
|
+
paymentType: PaymentMethod.CREDIT_CARD,
|
|
151
|
+
orderId: 123,
|
|
139
152
|
};
|
|
140
153
|
|
|
141
154
|
// Validates payment data
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@servemate/dto",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.4",
|
|
4
4
|
"description": "Comprehensive DTO package for ServeMate restaurant management system. Includes type-safe DTOs with Zod validation for users, orders, payments, tables, and menu items management.",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|