@ordersail/storefront-sdk 0.6.0 → 0.8.0

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 (33) hide show
  1. package/README.md +82 -12
  2. package/dist/http.d.ts +27 -1
  3. package/dist/http.d.ts.map +1 -1
  4. package/dist/http.js +71 -20
  5. package/dist/http.js.map +1 -1
  6. package/dist/index.d.ts +1 -1
  7. package/dist/index.d.ts.map +1 -1
  8. package/dist/index.js +9 -7
  9. package/dist/index.js.map +1 -1
  10. package/dist/resources/brands.d.ts +2 -2
  11. package/dist/resources/brands.d.ts.map +1 -1
  12. package/dist/resources/brands.js +2 -2
  13. package/dist/resources/brands.js.map +1 -1
  14. package/dist/resources/cart.d.ts.map +1 -1
  15. package/dist/resources/cart.js +5 -5
  16. package/dist/resources/cart.js.map +1 -1
  17. package/dist/resources/categories.d.ts +2 -2
  18. package/dist/resources/categories.d.ts.map +1 -1
  19. package/dist/resources/categories.js +2 -2
  20. package/dist/resources/categories.js.map +1 -1
  21. package/dist/resources/checkout.js +4 -4
  22. package/dist/resources/checkout.js.map +1 -1
  23. package/dist/resources/customer.d.ts +1 -1
  24. package/dist/resources/customer.d.ts.map +1 -1
  25. package/dist/resources/customer.js +4 -4
  26. package/dist/resources/customer.js.map +1 -1
  27. package/dist/resources/products.d.ts +1 -1
  28. package/dist/resources/products.d.ts.map +1 -1
  29. package/dist/resources/products.js +2 -2
  30. package/dist/resources/products.js.map +1 -1
  31. package/dist/types.gen.d.ts +289 -115
  32. package/dist/types.gen.d.ts.map +1 -1
  33. package/package.json +1 -1
package/dist/types.gen.d.ts CHANGED
@@ -3,23 +3,7 @@
3
3
  * Do not make direct changes to the file.
4
4
  */
5
5
  export interface paths {
6
- "/": {
7
- parameters: {
8
- query?: never;
9
- header?: never;
10
- path?: never;
11
- cookie?: never;
12
- };
13
- get: operations["AppController_getHello"];
14
- put?: never;
15
- post?: never;
16
- delete?: never;
17
- options?: never;
18
- head?: never;
19
- patch?: never;
20
- trace?: never;
21
- };
22
- "/products": {
6
+ "/v1/products": {
23
7
  parameters: {
24
8
  query?: never;
25
9
  header?: never;
@@ -35,7 +19,7 @@ export interface paths {
35
19
  patch?: never;
36
20
  trace?: never;
37
21
  };
38
- "/products/{id}": {
22
+ "/v1/products/{id}": {
39
23
  parameters: {
40
24
  query?: never;
41
25
  header?: never;
@@ -51,7 +35,7 @@ export interface paths {
51
35
  patch?: never;
52
36
  trace?: never;
53
37
  };
54
- "/categories": {
38
+ "/v1/categories": {
55
39
  parameters: {
56
40
  query?: never;
57
41
  header?: never;
@@ -67,7 +51,7 @@ export interface paths {
67
51
  patch?: never;
68
52
  trace?: never;
69
53
  };
70
- "/categories/{id}": {
54
+ "/v1/categories/{id}": {
71
55
  parameters: {
72
56
  query?: never;
73
57
  header?: never;
@@ -83,7 +67,7 @@ export interface paths {
83
67
  patch?: never;
84
68
  trace?: never;
85
69
  };
86
- "/brands": {
70
+ "/v1/brands": {
87
71
  parameters: {
88
72
  query?: never;
89
73
  header?: never;
@@ -99,7 +83,7 @@ export interface paths {
99
83
  patch?: never;
100
84
  trace?: never;
101
85
  };
102
- "/brands/{id}": {
86
+ "/v1/brands/{id}": {
103
87
  parameters: {
104
88
  query?: never;
105
89
  header?: never;
@@ -115,7 +99,7 @@ export interface paths {
115
99
  patch?: never;
116
100
  trace?: never;
117
101
  };
118
- "/cart/items": {
102
+ "/v1/cart/items": {
119
103
  parameters: {
120
104
  query?: never;
121
105
  header?: never;
@@ -131,7 +115,7 @@ export interface paths {
131
115
  patch?: never;
132
116
  trace?: never;
133
117
  };
134
- "/cart": {
118
+ "/v1/cart": {
135
119
  parameters: {
136
120
  query?: never;
137
121
  header?: never;
@@ -147,7 +131,7 @@ export interface paths {
147
131
  patch?: never;
148
132
  trace?: never;
149
133
  };
150
- "/cart/items/{variantId}": {
134
+ "/v1/cart/items/{variantId}": {
151
135
  parameters: {
152
136
  query?: never;
153
137
  header?: never;
@@ -163,7 +147,7 @@ export interface paths {
163
147
  patch: operations["CartController_updateItem"];
164
148
  trace?: never;
165
149
  };
166
- "/checkout/config": {
150
+ "/v1/checkout/config": {
167
151
  parameters: {
168
152
  query?: never;
169
153
  header?: never;
@@ -179,7 +163,7 @@ export interface paths {
179
163
  patch?: never;
180
164
  trace?: never;
181
165
  };
182
- "/checkout/session": {
166
+ "/v1/checkout/session": {
183
167
  parameters: {
184
168
  query?: never;
185
169
  header?: never;
@@ -195,7 +179,7 @@ export interface paths {
195
179
  patch?: never;
196
180
  trace?: never;
197
181
  };
198
- "/checkout/shipping-options": {
182
+ "/v1/checkout/shipping-options": {
199
183
  parameters: {
200
184
  query?: never;
201
185
  header?: never;
@@ -211,7 +195,7 @@ export interface paths {
211
195
  patch?: never;
212
196
  trace?: never;
213
197
  };
214
- "/checkout/session/{sessionId}": {
198
+ "/v1/checkout/session/{sessionId}": {
215
199
  parameters: {
216
200
  query?: never;
217
201
  header?: never;
@@ -227,7 +211,7 @@ export interface paths {
227
211
  patch?: never;
228
212
  trace?: never;
229
213
  };
230
- "/customer": {
214
+ "/v1/customer": {
231
215
  parameters: {
232
216
  query?: never;
233
217
  header?: never;
@@ -243,7 +227,7 @@ export interface paths {
243
227
  patch: operations["CustomerController_update"];
244
228
  trace?: never;
245
229
  };
246
- "/customer/orders": {
230
+ "/v1/customer/orders": {
247
231
  parameters: {
248
232
  query?: never;
249
233
  header?: never;
@@ -259,7 +243,7 @@ export interface paths {
259
243
  patch?: never;
260
244
  trace?: never;
261
245
  };
262
- "/customer/orders/{id}": {
246
+ "/v1/customer/orders/{id}": {
263
247
  parameters: {
264
248
  query?: never;
265
249
  header?: never;
@@ -275,7 +259,7 @@ export interface paths {
275
259
  patch?: never;
276
260
  trace?: never;
277
261
  };
278
- "/auth/signup": {
262
+ "/v1/auth/signup": {
279
263
  parameters: {
280
264
  query?: never;
281
265
  header?: never;
@@ -291,7 +275,7 @@ export interface paths {
291
275
  patch?: never;
292
276
  trace?: never;
293
277
  };
294
- "/auth/signin": {
278
+ "/v1/auth/signin": {
295
279
  parameters: {
296
280
  query?: never;
297
281
  header?: never;
@@ -307,7 +291,7 @@ export interface paths {
307
291
  patch?: never;
308
292
  trace?: never;
309
293
  };
310
- "/auth/token/refresh": {
294
+ "/v1/auth/token/refresh": {
311
295
  parameters: {
312
296
  query?: never;
313
297
  header?: never;
@@ -323,7 +307,7 @@ export interface paths {
323
307
  patch?: never;
324
308
  trace?: never;
325
309
  };
326
- "/auth/logout": {
310
+ "/v1/auth/logout": {
327
311
  parameters: {
328
312
  query?: never;
329
313
  header?: never;
@@ -631,6 +615,25 @@ export interface components {
631
615
  RefreshTokenDto: {
632
616
  refresh_token: string;
633
617
  };
618
+ ErrorResponse: {
619
+ error: {
620
+ /** @enum {string} */
621
+ type: "invalid_request_error" | "authentication_error" | "permission_error" | "rate_limit_error" | "api_error";
622
+ /** @enum {string} */
623
+ code: "bad_request" | "unauthenticated" | "forbidden" | "not_found" | "method_not_allowed" | "not_acceptable" | "request_timeout" | "conflict" | "gone" | "precondition_failed" | "content_too_large" | "unsupported_media_type" | "misdirected_request" | "unprocessable_content" | "rate_limited" | "internal_error" | "not_implemented" | "bad_gateway" | "service_unavailable" | "gateway_timeout" | "http_version_not_supported" | "validation_failed" | "invalid_access_token" | "invalid_app_key" | "invalid_device_token" | "invalid_credentials" | "mfa_factor_required" | "email_taken";
624
+ /** @description For people. Never parse it; branch on `code`. */
625
+ message: string;
626
+ /** @description The request field that caused the error. */
627
+ param?: string;
628
+ /** Format: uri */
629
+ doc_url: string;
630
+ /** @description The x-request-id of the request; quote it when reporting a problem. */
631
+ request_id: string | null;
632
+ details?: {
633
+ [key: string]: unknown;
634
+ };
635
+ };
636
+ };
634
637
  };
635
638
  responses: never;
636
639
  parameters: never;
@@ -640,23 +643,6 @@ export interface components {
640
643
  }
641
644
  export type $defs = Record<string, never>;
642
645
  export interface operations {
643
- AppController_getHello: {
644
- parameters: {
645
- query?: never;
646
- header?: never;
647
- path?: never;
648
- cookie?: never;
649
- };
650
- requestBody?: never;
651
- responses: {
652
- 200: {
653
- headers: {
654
- [name: string]: unknown;
655
- };
656
- content?: never;
657
- };
658
- };
659
- };
660
646
  ProductsController_findAll: {
661
647
  parameters: {
662
648
  query?: {
@@ -691,6 +677,15 @@ export interface operations {
691
677
  "application/json": components["schemas"]["PaginatedProducts"];
692
678
  };
693
679
  };
680
+ /** @description Error */
681
+ default: {
682
+ headers: {
683
+ [name: string]: unknown;
684
+ };
685
+ content: {
686
+ "application/json": components["schemas"]["ErrorResponse"];
687
+ };
688
+ };
694
689
  };
695
690
  };
696
691
  ProductsController_findOne: {
@@ -716,7 +711,18 @@ export interface operations {
716
711
  headers: {
717
712
  [name: string]: unknown;
718
713
  };
719
- content?: never;
714
+ content: {
715
+ "application/json": components["schemas"]["ErrorResponse"];
716
+ };
717
+ };
718
+ /** @description Error */
719
+ default: {
720
+ headers: {
721
+ [name: string]: unknown;
722
+ };
723
+ content: {
724
+ "application/json": components["schemas"]["ErrorResponse"];
725
+ };
720
726
  };
721
727
  };
722
728
  };
@@ -740,6 +746,15 @@ export interface operations {
740
746
  "application/json": components["schemas"]["PaginatedCategories"];
741
747
  };
742
748
  };
749
+ /** @description Error */
750
+ default: {
751
+ headers: {
752
+ [name: string]: unknown;
753
+ };
754
+ content: {
755
+ "application/json": components["schemas"]["ErrorResponse"];
756
+ };
757
+ };
743
758
  };
744
759
  };
745
760
  CategoriesController_findOne: {
@@ -782,7 +797,18 @@ export interface operations {
782
797
  headers: {
783
798
  [name: string]: unknown;
784
799
  };
785
- content?: never;
800
+ content: {
801
+ "application/json": components["schemas"]["ErrorResponse"];
802
+ };
803
+ };
804
+ /** @description Error */
805
+ default: {
806
+ headers: {
807
+ [name: string]: unknown;
808
+ };
809
+ content: {
810
+ "application/json": components["schemas"]["ErrorResponse"];
811
+ };
786
812
  };
787
813
  };
788
814
  };
@@ -806,6 +832,15 @@ export interface operations {
806
832
  "application/json": components["schemas"]["PaginatedBrands"];
807
833
  };
808
834
  };
835
+ /** @description Error */
836
+ default: {
837
+ headers: {
838
+ [name: string]: unknown;
839
+ };
840
+ content: {
841
+ "application/json": components["schemas"]["ErrorResponse"];
842
+ };
843
+ };
809
844
  };
810
845
  };
811
846
  BrandsController_findOne: {
@@ -848,7 +883,18 @@ export interface operations {
848
883
  headers: {
849
884
  [name: string]: unknown;
850
885
  };
851
- content?: never;
886
+ content: {
887
+ "application/json": components["schemas"]["ErrorResponse"];
888
+ };
889
+ };
890
+ /** @description Error */
891
+ default: {
892
+ headers: {
893
+ [name: string]: unknown;
894
+ };
895
+ content: {
896
+ "application/json": components["schemas"]["ErrorResponse"];
897
+ };
852
898
  };
853
899
  };
854
900
  };
@@ -873,6 +919,15 @@ export interface operations {
873
919
  "application/json": components["schemas"]["Cart"];
874
920
  };
875
921
  };
922
+ /** @description Error */
923
+ default: {
924
+ headers: {
925
+ [name: string]: unknown;
926
+ };
927
+ content: {
928
+ "application/json": components["schemas"]["ErrorResponse"];
929
+ };
930
+ };
876
931
  };
877
932
  };
878
933
  CartController_getCart: {
@@ -896,7 +951,18 @@ export interface operations {
896
951
  headers: {
897
952
  [name: string]: unknown;
898
953
  };
899
- content?: never;
954
+ content: {
955
+ "application/json": components["schemas"]["ErrorResponse"];
956
+ };
957
+ };
958
+ /** @description Error */
959
+ default: {
960
+ headers: {
961
+ [name: string]: unknown;
962
+ };
963
+ content: {
964
+ "application/json": components["schemas"]["ErrorResponse"];
965
+ };
900
966
  };
901
967
  };
902
968
  };
@@ -921,7 +987,18 @@ export interface operations {
921
987
  headers: {
922
988
  [name: string]: unknown;
923
989
  };
924
- content?: never;
990
+ content: {
991
+ "application/json": components["schemas"]["ErrorResponse"];
992
+ };
993
+ };
994
+ /** @description Error */
995
+ default: {
996
+ headers: {
997
+ [name: string]: unknown;
998
+ };
999
+ content: {
1000
+ "application/json": components["schemas"]["ErrorResponse"];
1001
+ };
925
1002
  };
926
1003
  };
927
1004
  };
@@ -948,7 +1025,18 @@ export interface operations {
948
1025
  headers: {
949
1026
  [name: string]: unknown;
950
1027
  };
951
- content?: never;
1028
+ content: {
1029
+ "application/json": components["schemas"]["ErrorResponse"];
1030
+ };
1031
+ };
1032
+ /** @description Error */
1033
+ default: {
1034
+ headers: {
1035
+ [name: string]: unknown;
1036
+ };
1037
+ content: {
1038
+ "application/json": components["schemas"]["ErrorResponse"];
1039
+ };
952
1040
  };
953
1041
  };
954
1042
  };
@@ -979,7 +1067,18 @@ export interface operations {
979
1067
  headers: {
980
1068
  [name: string]: unknown;
981
1069
  };
982
- content?: never;
1070
+ content: {
1071
+ "application/json": components["schemas"]["ErrorResponse"];
1072
+ };
1073
+ };
1074
+ /** @description Error */
1075
+ default: {
1076
+ headers: {
1077
+ [name: string]: unknown;
1078
+ };
1079
+ content: {
1080
+ "application/json": components["schemas"]["ErrorResponse"];
1081
+ };
983
1082
  };
984
1083
  };
985
1084
  };
@@ -1000,6 +1099,15 @@ export interface operations {
1000
1099
  "application/json": components["schemas"]["CheckoutConfig"];
1001
1100
  };
1002
1101
  };
1102
+ /** @description Error */
1103
+ default: {
1104
+ headers: {
1105
+ [name: string]: unknown;
1106
+ };
1107
+ content: {
1108
+ "application/json": components["schemas"]["ErrorResponse"];
1109
+ };
1110
+ };
1003
1111
  };
1004
1112
  };
1005
1113
  CheckoutController_createSession: {
@@ -1023,6 +1131,15 @@ export interface operations {
1023
1131
  "application/json": components["schemas"]["CheckoutSession"];
1024
1132
  };
1025
1133
  };
1134
+ /** @description Error */
1135
+ default: {
1136
+ headers: {
1137
+ [name: string]: unknown;
1138
+ };
1139
+ content: {
1140
+ "application/json": components["schemas"]["ErrorResponse"];
1141
+ };
1142
+ };
1026
1143
  };
1027
1144
  };
1028
1145
  CheckoutController_getShippingOptions: {
@@ -1046,6 +1163,15 @@ export interface operations {
1046
1163
  "application/json": components["schemas"]["ShippingOptionsResult"];
1047
1164
  };
1048
1165
  };
1166
+ /** @description Error */
1167
+ default: {
1168
+ headers: {
1169
+ [name: string]: unknown;
1170
+ };
1171
+ content: {
1172
+ "application/json": components["schemas"]["ErrorResponse"];
1173
+ };
1174
+ };
1049
1175
  };
1050
1176
  };
1051
1177
  CheckoutController_getSessionStatus: {
@@ -1067,6 +1193,15 @@ export interface operations {
1067
1193
  "application/json": components["schemas"]["CheckoutSessionStatus"];
1068
1194
  };
1069
1195
  };
1196
+ /** @description Error */
1197
+ default: {
1198
+ headers: {
1199
+ [name: string]: unknown;
1200
+ };
1201
+ content: {
1202
+ "application/json": components["schemas"]["ErrorResponse"];
1203
+ };
1204
+ };
1070
1205
  };
1071
1206
  };
1072
1207
  CustomerController_findOne: {
@@ -1086,6 +1221,15 @@ export interface operations {
1086
1221
  "application/json": components["schemas"]["Customer"];
1087
1222
  };
1088
1223
  };
1224
+ /** @description Error */
1225
+ default: {
1226
+ headers: {
1227
+ [name: string]: unknown;
1228
+ };
1229
+ content: {
1230
+ "application/json": components["schemas"]["ErrorResponse"];
1231
+ };
1232
+ };
1089
1233
  };
1090
1234
  };
1091
1235
  CustomerController_update: {
@@ -1109,6 +1253,15 @@ export interface operations {
1109
1253
  "application/json": components["schemas"]["Customer"];
1110
1254
  };
1111
1255
  };
1256
+ /** @description Error */
1257
+ default: {
1258
+ headers: {
1259
+ [name: string]: unknown;
1260
+ };
1261
+ content: {
1262
+ "application/json": components["schemas"]["ErrorResponse"];
1263
+ };
1264
+ };
1112
1265
  };
1113
1266
  };
1114
1267
  CustomerOrdersController_findAll: {
@@ -1131,6 +1284,15 @@ export interface operations {
1131
1284
  "application/json": components["schemas"]["PaginatedCustomerOrders"];
1132
1285
  };
1133
1286
  };
1287
+ /** @description Error */
1288
+ default: {
1289
+ headers: {
1290
+ [name: string]: unknown;
1291
+ };
1292
+ content: {
1293
+ "application/json": components["schemas"]["ErrorResponse"];
1294
+ };
1295
+ };
1134
1296
  };
1135
1297
  };
1136
1298
  CustomerOrdersController_findOne: {
@@ -1156,7 +1318,18 @@ export interface operations {
1156
1318
  headers: {
1157
1319
  [name: string]: unknown;
1158
1320
  };
1159
- content?: never;
1321
+ content: {
1322
+ "application/json": components["schemas"]["ErrorResponse"];
1323
+ };
1324
+ };
1325
+ /** @description Error */
1326
+ default: {
1327
+ headers: {
1328
+ [name: string]: unknown;
1329
+ };
1330
+ content: {
1331
+ "application/json": components["schemas"]["ErrorResponse"];
1332
+ };
1160
1333
  };
1161
1334
  };
1162
1335
  };
@@ -1185,7 +1358,18 @@ export interface operations {
1185
1358
  headers: {
1186
1359
  [name: string]: unknown;
1187
1360
  };
1188
- content?: never;
1361
+ content: {
1362
+ "application/json": components["schemas"]["ErrorResponse"];
1363
+ };
1364
+ };
1365
+ /** @description Error */
1366
+ default: {
1367
+ headers: {
1368
+ [name: string]: unknown;
1369
+ };
1370
+ content: {
1371
+ "application/json": components["schemas"]["ErrorResponse"];
1372
+ };
1189
1373
  };
1190
1374
  };
1191
1375
  };
@@ -1214,7 +1398,18 @@ export interface operations {
1214
1398
  headers: {
1215
1399
  [name: string]: unknown;
1216
1400
  };
1217
- content?: never;
1401
+ content: {
1402
+ "application/json": components["schemas"]["ErrorResponse"];
1403
+ };
1404
+ };
1405
+ /** @description Error */
1406
+ default: {
1407
+ headers: {
1408
+ [name: string]: unknown;
1409
+ };
1410
+ content: {
1411
+ "application/json": components["schemas"]["ErrorResponse"];
1412
+ };
1218
1413
  };
1219
1414
  };
1220
1415
  };
@@ -1243,7 +1438,18 @@ export interface operations {
1243
1438
  headers: {
1244
1439
  [name: string]: unknown;
1245
1440
  };
1246
- content?: never;
1441
+ content: {
1442
+ "application/json": components["schemas"]["ErrorResponse"];
1443
+ };
1444
+ };
1445
+ /** @description Error */
1446
+ default: {
1447
+ headers: {
1448
+ [name: string]: unknown;
1449
+ };
1450
+ content: {
1451
+ "application/json": components["schemas"]["ErrorResponse"];
1452
+ };
1247
1453
  };
1248
1454
  };
1249
1455
  };
@@ -1266,6 +1472,15 @@ export interface operations {
1266
1472
  };
1267
1473
  content?: never;
1268
1474
  };
1475
+ /** @description Error */
1476
+ default: {
1477
+ headers: {
1478
+ [name: string]: unknown;
1479
+ };
1480
+ content: {
1481
+ "application/json": components["schemas"]["ErrorResponse"];
1482
+ };
1483
+ };
1269
1484
  };
1270
1485
  };
1271
1486
  HealthController_check: {
@@ -1331,57 +1546,16 @@ export interface operations {
1331
1546
  [name: string]: unknown;
1332
1547
  };
1333
1548
  content: {
1334
- "application/json": {
1335
- /** @example error */
1336
- status?: string;
1337
- /**
1338
- * @example {
1339
- * "database": {
1340
- * "status": "up"
1341
- * }
1342
- * }
1343
- */
1344
- info?: {
1345
- [key: string]: {
1346
- status: string;
1347
- } & {
1348
- [key: string]: unknown;
1349
- };
1350
- } | null;
1351
- /**
1352
- * @example {
1353
- * "redis": {
1354
- * "status": "down",
1355
- * "message": "Could not connect"
1356
- * }
1357
- * }
1358
- */
1359
- error?: {
1360
- [key: string]: {
1361
- status: string;
1362
- } & {
1363
- [key: string]: unknown;
1364
- };
1365
- } | null;
1366
- /**
1367
- * @example {
1368
- * "database": {
1369
- * "status": "up"
1370
- * },
1371
- * "redis": {
1372
- * "status": "down",
1373
- * "message": "Could not connect"
1374
- * }
1375
- * }
1376
- */
1377
- details?: {
1378
- [key: string]: {
1379
- status: string;
1380
- } & {
1381
- [key: string]: unknown;
1382
- };
1383
- };
1384
- };
1549
+ "application/json": components["schemas"]["ErrorResponse"];
1550
+ };
1551
+ };
1552
+ /** @description Error */
1553
+ default: {
1554
+ headers: {
1555
+ [name: string]: unknown;
1556
+ };
1557
+ content: {
1558
+ "application/json": components["schemas"]["ErrorResponse"];
1385
1559
  };
1386
1560
  };
1387
1561
  };