@rivascva/dt-idl 1.1.64 → 1.1.65

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.d.ts CHANGED
@@ -1073,6 +1073,57 @@ interface operations$2 {
1073
1073
  * Do not make direct changes to the file.
1074
1074
  */
1075
1075
  interface paths$1 {
1076
+ "/login": {
1077
+ parameters: {
1078
+ query?: never;
1079
+ header?: never;
1080
+ path?: never;
1081
+ cookie?: never;
1082
+ };
1083
+ get?: never;
1084
+ put?: never;
1085
+ /** @description Logs in a user */
1086
+ post: operations$1["login"];
1087
+ delete?: never;
1088
+ options?: never;
1089
+ head?: never;
1090
+ patch?: never;
1091
+ trace?: never;
1092
+ };
1093
+ "/login/provider": {
1094
+ parameters: {
1095
+ query?: never;
1096
+ header?: never;
1097
+ path?: never;
1098
+ cookie?: never;
1099
+ };
1100
+ get?: never;
1101
+ put?: never;
1102
+ /** @description Logs in a user by a provider */
1103
+ post: operations$1["loginByProvider"];
1104
+ delete?: never;
1105
+ options?: never;
1106
+ head?: never;
1107
+ patch?: never;
1108
+ trace?: never;
1109
+ };
1110
+ "/logout": {
1111
+ parameters: {
1112
+ query?: never;
1113
+ header?: never;
1114
+ path?: never;
1115
+ cookie?: never;
1116
+ };
1117
+ get?: never;
1118
+ put?: never;
1119
+ /** @description Logs out a user */
1120
+ post: operations$1["logout"];
1121
+ delete?: never;
1122
+ options?: never;
1123
+ head?: never;
1124
+ patch?: never;
1125
+ trace?: never;
1126
+ };
1076
1127
  "/users": {
1077
1128
  parameters: {
1078
1129
  query?: never;
@@ -1112,6 +1163,20 @@ interface paths$1 {
1112
1163
  }
1113
1164
  interface components$1 {
1114
1165
  schemas: {
1166
+ /** @description Payload to log in a user */
1167
+ LoginPayload: {
1168
+ /** @example sam.smith@example.com */
1169
+ email: string;
1170
+ /** @example Password123! */
1171
+ password: string;
1172
+ };
1173
+ /** @description Payload to log in a user by a provider */
1174
+ LoginByProviderPayload: {
1175
+ /** @example GOOGLE */
1176
+ provider: components$1["schemas"]["Provider"];
1177
+ /** @example 123456 */
1178
+ authorizationCode: string;
1179
+ };
1115
1180
  /** @description Payload to add a new user */
1116
1181
  AddUserPayload: {
1117
1182
  /** @example sam.smith@example.com */
@@ -1154,8 +1219,22 @@ interface components$1 {
1154
1219
  };
1155
1220
  /** @enum {string} */
1156
1221
  ErrorCode: "ERROR";
1222
+ /** @enum {string} */
1223
+ Provider: "GOOGLE";
1157
1224
  };
1158
1225
  responses: {
1226
+ /** @description Login success */
1227
+ LoginSuccess: {
1228
+ headers: {
1229
+ [name: string]: unknown;
1230
+ };
1231
+ content: {
1232
+ "application/json": {
1233
+ /** @example ABCD.1234.abcd */
1234
+ token: string;
1235
+ };
1236
+ };
1237
+ };
1159
1238
  /** @description No content */
1160
1239
  NoContent: {
1161
1240
  headers: {
@@ -1197,6 +1276,59 @@ interface components$1 {
1197
1276
  pathItems: never;
1198
1277
  }
1199
1278
  interface operations$1 {
1279
+ login: {
1280
+ parameters: {
1281
+ query?: never;
1282
+ header?: never;
1283
+ path?: never;
1284
+ cookie?: never;
1285
+ };
1286
+ /** @description The request body to log in a user */
1287
+ requestBody: {
1288
+ content: {
1289
+ "application/json": components$1["schemas"]["LoginPayload"];
1290
+ };
1291
+ };
1292
+ responses: {
1293
+ 200: components$1["responses"]["LoginSuccess"];
1294
+ 400: components$1["responses"]["BadRequest"];
1295
+ 500: components$1["responses"]["InternalServerError"];
1296
+ };
1297
+ };
1298
+ loginByProvider: {
1299
+ parameters: {
1300
+ query?: never;
1301
+ header?: never;
1302
+ path?: never;
1303
+ cookie?: never;
1304
+ };
1305
+ /** @description The request body to log in a user by a provider */
1306
+ requestBody: {
1307
+ content: {
1308
+ "application/json": components$1["schemas"]["LoginByProviderPayload"];
1309
+ };
1310
+ };
1311
+ responses: {
1312
+ 200: components$1["responses"]["LoginSuccess"];
1313
+ 400: components$1["responses"]["BadRequest"];
1314
+ 404: components$1["responses"]["NotFound"];
1315
+ 500: components$1["responses"]["InternalServerError"];
1316
+ };
1317
+ };
1318
+ logout: {
1319
+ parameters: {
1320
+ query?: never;
1321
+ header?: never;
1322
+ path?: never;
1323
+ cookie?: never;
1324
+ };
1325
+ requestBody?: never;
1326
+ responses: {
1327
+ 204: components$1["responses"]["NoContent"];
1328
+ 400: components$1["responses"]["BadRequest"];
1329
+ 500: components$1["responses"]["InternalServerError"];
1330
+ };
1331
+ };
1200
1332
  getUsers: {
1201
1333
  parameters: {
1202
1334
  query?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rivascva/dt-idl",
3
- "version": "1.1.64",
3
+ "version": "1.1.65",
4
4
  "description": "Dream Trade - Interface Definition Language",
5
5
  "main": "dist/index.cjs.js",
6
6
  "module": "dist/index.esm.js",
@@ -8,6 +8,64 @@ servers:
8
8
  - url: http://localhost:8084/v1
9
9
 
10
10
  paths:
11
+ /login:
12
+ post:
13
+ description: Logs in a user
14
+ operationId: login
15
+ tags:
16
+ - Auth
17
+ requestBody:
18
+ description: The request body to log in a user
19
+ required: true
20
+ content:
21
+ application/json:
22
+ schema:
23
+ $ref: '#/components/schemas/LoginPayload'
24
+ responses:
25
+ 200:
26
+ $ref: '#/components/responses/LoginSuccess'
27
+ 400:
28
+ $ref: '#/components/responses/BadRequest'
29
+ 500:
30
+ $ref: '#/components/responses/InternalServerError'
31
+
32
+ /login/provider:
33
+ post:
34
+ description: Logs in a user by a provider
35
+ operationId: loginByProvider
36
+ tags:
37
+ - Auth
38
+ requestBody:
39
+ description: The request body to log in a user by a provider
40
+ required: true
41
+ content:
42
+ application/json:
43
+ schema:
44
+ $ref: '#/components/schemas/LoginByProviderPayload'
45
+ responses:
46
+ 200:
47
+ $ref: '#/components/responses/LoginSuccess'
48
+ 400:
49
+ $ref: '#/components/responses/BadRequest'
50
+ 404:
51
+ $ref: '#/components/responses/NotFound'
52
+ 500:
53
+ $ref: '#/components/responses/InternalServerError'
54
+
55
+ /logout:
56
+ post:
57
+ description: Logs out a user
58
+ operationId: logout
59
+ tags:
60
+ - Auth
61
+ responses:
62
+ 204:
63
+ $ref: '#/components/responses/NoContent'
64
+ 400:
65
+ $ref: '#/components/responses/BadRequest'
66
+ 500:
67
+ $ref: '#/components/responses/InternalServerError'
68
+
11
69
  /users:
12
70
  get:
13
71
  description: Gets all users
@@ -113,6 +171,32 @@ paths:
113
171
 
114
172
  components:
115
173
  schemas:
174
+ LoginPayload:
175
+ description: Payload to log in a user
176
+ properties:
177
+ email:
178
+ type: string
179
+ example: sam.smith@example.com
180
+ password:
181
+ type: string
182
+ example: Password123!
183
+ required:
184
+ - email
185
+ - password
186
+
187
+ LoginByProviderPayload:
188
+ description: Payload to log in a user by a provider
189
+ properties:
190
+ provider:
191
+ $ref: '#/components/schemas/Provider'
192
+ example: GOOGLE
193
+ authorizationCode:
194
+ type: string
195
+ example: 123456
196
+ required:
197
+ - provider
198
+ - authorizationCode
199
+
116
200
  AddUserPayload:
117
201
  description: Payload to add a new user
118
202
  properties:
@@ -183,7 +267,24 @@ components:
183
267
  enum:
184
268
  - ERROR
185
269
 
270
+ Provider:
271
+ type: string
272
+ enum:
273
+ - GOOGLE
274
+
186
275
  responses:
276
+ LoginSuccess:
277
+ description: Login success
278
+ content:
279
+ application/json:
280
+ schema:
281
+ properties:
282
+ token:
283
+ type: string
284
+ example: ABCD.1234.abcd
285
+ required:
286
+ - token
287
+
187
288
  NoContent:
188
289
  description: No content
189
290
 
@@ -4,6 +4,57 @@
4
4
  */
5
5
 
6
6
  export interface paths {
7
+ "/login": {
8
+ parameters: {
9
+ query?: never;
10
+ header?: never;
11
+ path?: never;
12
+ cookie?: never;
13
+ };
14
+ get?: never;
15
+ put?: never;
16
+ /** @description Logs in a user */
17
+ post: operations["login"];
18
+ delete?: never;
19
+ options?: never;
20
+ head?: never;
21
+ patch?: never;
22
+ trace?: never;
23
+ };
24
+ "/login/provider": {
25
+ parameters: {
26
+ query?: never;
27
+ header?: never;
28
+ path?: never;
29
+ cookie?: never;
30
+ };
31
+ get?: never;
32
+ put?: never;
33
+ /** @description Logs in a user by a provider */
34
+ post: operations["loginByProvider"];
35
+ delete?: never;
36
+ options?: never;
37
+ head?: never;
38
+ patch?: never;
39
+ trace?: never;
40
+ };
41
+ "/logout": {
42
+ parameters: {
43
+ query?: never;
44
+ header?: never;
45
+ path?: never;
46
+ cookie?: never;
47
+ };
48
+ get?: never;
49
+ put?: never;
50
+ /** @description Logs out a user */
51
+ post: operations["logout"];
52
+ delete?: never;
53
+ options?: never;
54
+ head?: never;
55
+ patch?: never;
56
+ trace?: never;
57
+ };
7
58
  "/users": {
8
59
  parameters: {
9
60
  query?: never;
@@ -44,6 +95,20 @@ export interface paths {
44
95
  export type webhooks = Record<string, never>;
45
96
  export interface components {
46
97
  schemas: {
98
+ /** @description Payload to log in a user */
99
+ LoginPayload: {
100
+ /** @example sam.smith@example.com */
101
+ email: string;
102
+ /** @example Password123! */
103
+ password: string;
104
+ };
105
+ /** @description Payload to log in a user by a provider */
106
+ LoginByProviderPayload: {
107
+ /** @example GOOGLE */
108
+ provider: components["schemas"]["Provider"];
109
+ /** @example 123456 */
110
+ authorizationCode: string;
111
+ };
47
112
  /** @description Payload to add a new user */
48
113
  AddUserPayload: {
49
114
  /** @example sam.smith@example.com */
@@ -86,8 +151,22 @@ export interface components {
86
151
  };
87
152
  /** @enum {string} */
88
153
  ErrorCode: "ERROR";
154
+ /** @enum {string} */
155
+ Provider: "GOOGLE";
89
156
  };
90
157
  responses: {
158
+ /** @description Login success */
159
+ LoginSuccess: {
160
+ headers: {
161
+ [name: string]: unknown;
162
+ };
163
+ content: {
164
+ "application/json": {
165
+ /** @example ABCD.1234.abcd */
166
+ token: string;
167
+ };
168
+ };
169
+ };
91
170
  /** @description No content */
92
171
  NoContent: {
93
172
  headers: {
@@ -130,6 +209,59 @@ export interface components {
130
209
  }
131
210
  export type $defs = Record<string, never>;
132
211
  export interface operations {
212
+ login: {
213
+ parameters: {
214
+ query?: never;
215
+ header?: never;
216
+ path?: never;
217
+ cookie?: never;
218
+ };
219
+ /** @description The request body to log in a user */
220
+ requestBody: {
221
+ content: {
222
+ "application/json": components["schemas"]["LoginPayload"];
223
+ };
224
+ };
225
+ responses: {
226
+ 200: components["responses"]["LoginSuccess"];
227
+ 400: components["responses"]["BadRequest"];
228
+ 500: components["responses"]["InternalServerError"];
229
+ };
230
+ };
231
+ loginByProvider: {
232
+ parameters: {
233
+ query?: never;
234
+ header?: never;
235
+ path?: never;
236
+ cookie?: never;
237
+ };
238
+ /** @description The request body to log in a user by a provider */
239
+ requestBody: {
240
+ content: {
241
+ "application/json": components["schemas"]["LoginByProviderPayload"];
242
+ };
243
+ };
244
+ responses: {
245
+ 200: components["responses"]["LoginSuccess"];
246
+ 400: components["responses"]["BadRequest"];
247
+ 404: components["responses"]["NotFound"];
248
+ 500: components["responses"]["InternalServerError"];
249
+ };
250
+ };
251
+ logout: {
252
+ parameters: {
253
+ query?: never;
254
+ header?: never;
255
+ path?: never;
256
+ cookie?: never;
257
+ };
258
+ requestBody?: never;
259
+ responses: {
260
+ 204: components["responses"]["NoContent"];
261
+ 400: components["responses"]["BadRequest"];
262
+ 500: components["responses"]["InternalServerError"];
263
+ };
264
+ };
133
265
  getUsers: {
134
266
  parameters: {
135
267
  query?: never;