@xylabs/api 2.9.2 → 2.10.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 (81) hide show
  1. package/dist/ApiClient.d.mts +10 -0
  2. package/dist/{types/ApiClient.d.ts → ApiClient.d.ts} +3 -2
  3. package/dist/ApiClient.js +38 -0
  4. package/dist/ApiClient.js.map +1 -0
  5. package/dist/ApiClient.mjs +13 -0
  6. package/dist/ApiClient.mjs.map +1 -0
  7. package/dist/ApiConfig.d.mts +8 -0
  8. package/dist/{types/ApiConfig.d.ts → ApiConfig.d.ts} +2 -2
  9. package/dist/ApiConfig.js +19 -0
  10. package/dist/ApiConfig.js.map +1 -0
  11. package/dist/ApiConfig.mjs +1 -0
  12. package/dist/ApiConfig.mjs.map +1 -0
  13. package/dist/ApiEndpoint.d.mts +16 -0
  14. package/dist/{types/ApiEndpoint.d.ts → ApiEndpoint.d.ts} +3 -2
  15. package/dist/ApiEndpoint.js +80 -0
  16. package/dist/ApiEndpoint.js.map +1 -0
  17. package/dist/ApiEndpoint.mjs +45 -0
  18. package/dist/ApiEndpoint.mjs.map +1 -0
  19. package/dist/ApiStage.d.mts +7 -0
  20. package/dist/{types/ApiStage.d.ts → ApiStage.d.ts} +1 -1
  21. package/dist/ApiStage.js +36 -0
  22. package/dist/ApiStage.js.map +1 -0
  23. package/dist/ApiStage.mjs +11 -0
  24. package/dist/ApiStage.mjs.map +1 -0
  25. package/dist/getApiStage.d.mts +5 -0
  26. package/dist/{types/getApiStage.d.ts → getApiStage.d.ts} +3 -2
  27. package/dist/getApiStage.js +39 -0
  28. package/dist/getApiStage.js.map +1 -0
  29. package/dist/getApiStage.mjs +14 -0
  30. package/dist/getApiStage.mjs.map +1 -0
  31. package/dist/index.d.mts +5 -0
  32. package/dist/index.d.ts +5 -0
  33. package/dist/index.js +117 -0
  34. package/dist/index.js.map +1 -0
  35. package/dist/index.mjs +77 -0
  36. package/dist/index.mjs.map +1 -0
  37. package/package.json +30 -17
  38. package/tsup.config.ts +14 -0
  39. package/dist/cjs/ApiClient.js +0 -14
  40. package/dist/cjs/ApiClient.js.map +0 -1
  41. package/dist/cjs/ApiConfig.js +0 -3
  42. package/dist/cjs/ApiConfig.js.map +0 -1
  43. package/dist/cjs/ApiEndpoint.js +0 -52
  44. package/dist/cjs/ApiEndpoint.js.map +0 -1
  45. package/dist/cjs/ApiStage.js +0 -10
  46. package/dist/cjs/ApiStage.js.map +0 -1
  47. package/dist/cjs/getApiStage.js +0 -17
  48. package/dist/cjs/getApiStage.js.map +0 -1
  49. package/dist/cjs/index.js +0 -9
  50. package/dist/cjs/index.js.map +0 -1
  51. package/dist/docs.json +0 -1275
  52. package/dist/esm/ApiClient.js +0 -13
  53. package/dist/esm/ApiClient.js.map +0 -1
  54. package/dist/esm/ApiConfig.js +0 -2
  55. package/dist/esm/ApiConfig.js.map +0 -1
  56. package/dist/esm/ApiEndpoint.js +0 -44
  57. package/dist/esm/ApiEndpoint.js.map +0 -1
  58. package/dist/esm/ApiStage.js +0 -8
  59. package/dist/esm/ApiStage.js.map +0 -1
  60. package/dist/esm/getApiStage.js +0 -14
  61. package/dist/esm/getApiStage.js.map +0 -1
  62. package/dist/esm/index.js +0 -6
  63. package/dist/esm/index.js.map +0 -1
  64. package/dist/types/ApiClient.d.ts.map +0 -1
  65. package/dist/types/ApiConfig.d.ts.map +0 -1
  66. package/dist/types/ApiEndpoint.d.ts.map +0 -1
  67. package/dist/types/ApiStage.d.ts.map +0 -1
  68. package/dist/types/getApiStage.d.ts.map +0 -1
  69. package/dist/types/index.d.ts +0 -6
  70. package/dist/types/index.d.ts.map +0 -1
  71. package/docs/assets/highlight.css +0 -50
  72. package/docs/assets/main.js +0 -58
  73. package/docs/assets/search.js +0 -1
  74. package/docs/assets/style.css +0 -1367
  75. package/docs/classes/ApiClient.html +0 -113
  76. package/docs/classes/ApiEndpoint.html +0 -190
  77. package/docs/enums/ApiStage.html +0 -79
  78. package/docs/functions/getApiStage.html +0 -54
  79. package/docs/index.html +0 -86
  80. package/docs/interfaces/ApiConfig.html +0 -90
  81. package/docs/modules.html +0 -59
package/dist/docs.json DELETED
@@ -1,1275 +0,0 @@
1
- {
2
- "id": 0,
3
- "name": "@xylabs/api",
4
- "variant": "project",
5
- "kind": 1,
6
- "flags": {},
7
- "children": [
8
- {
9
- "id": 40,
10
- "name": "ApiStage",
11
- "variant": "declaration",
12
- "kind": 8,
13
- "flags": {},
14
- "children": [
15
- {
16
- "id": 41,
17
- "name": "Beta",
18
- "variant": "declaration",
19
- "kind": 16,
20
- "flags": {},
21
- "sources": [
22
- {
23
- "fileName": "ApiStage.ts",
24
- "line": 2,
25
- "character": 2,
26
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiStage.ts#L2"
27
- }
28
- ],
29
- "type": {
30
- "type": "literal",
31
- "value": "beta"
32
- }
33
- },
34
- {
35
- "id": 42,
36
- "name": "Local",
37
- "variant": "declaration",
38
- "kind": 16,
39
- "flags": {},
40
- "sources": [
41
- {
42
- "fileName": "ApiStage.ts",
43
- "line": 3,
44
- "character": 2,
45
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiStage.ts#L3"
46
- }
47
- ],
48
- "type": {
49
- "type": "literal",
50
- "value": "local"
51
- }
52
- },
53
- {
54
- "id": 43,
55
- "name": "Prod",
56
- "variant": "declaration",
57
- "kind": 16,
58
- "flags": {},
59
- "sources": [
60
- {
61
- "fileName": "ApiStage.ts",
62
- "line": 4,
63
- "character": 2,
64
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiStage.ts#L4"
65
- }
66
- ],
67
- "type": {
68
- "type": "literal",
69
- "value": "prod"
70
- }
71
- }
72
- ],
73
- "groups": [
74
- {
75
- "title": "Enumeration Members",
76
- "children": [
77
- 41,
78
- 42,
79
- 43
80
- ]
81
- }
82
- ],
83
- "sources": [
84
- {
85
- "fileName": "ApiStage.ts",
86
- "line": 1,
87
- "character": 5,
88
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiStage.ts#L1"
89
- }
90
- ]
91
- },
92
- {
93
- "id": 1,
94
- "name": "ApiClient",
95
- "variant": "declaration",
96
- "kind": 128,
97
- "flags": {
98
- "isAbstract": true
99
- },
100
- "children": [
101
- {
102
- "id": 2,
103
- "name": "constructor",
104
- "variant": "declaration",
105
- "kind": 512,
106
- "flags": {
107
- "isPublic": true
108
- },
109
- "sources": [
110
- {
111
- "fileName": "ApiClient.ts",
112
- "line": 4,
113
- "character": 2,
114
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiClient.ts#L4"
115
- }
116
- ],
117
- "signatures": [
118
- {
119
- "id": 3,
120
- "name": "new ApiClient",
121
- "variant": "signature",
122
- "kind": 16384,
123
- "flags": {},
124
- "sources": [
125
- {
126
- "fileName": "ApiClient.ts",
127
- "line": 4,
128
- "character": 2,
129
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiClient.ts#L4"
130
- }
131
- ],
132
- "parameters": [
133
- {
134
- "id": 4,
135
- "name": "token",
136
- "variant": "param",
137
- "kind": 32768,
138
- "flags": {
139
- "isOptional": true
140
- },
141
- "type": {
142
- "type": "union",
143
- "types": [
144
- {
145
- "type": "literal",
146
- "value": null
147
- },
148
- {
149
- "type": "intrinsic",
150
- "name": "string"
151
- }
152
- ]
153
- }
154
- },
155
- {
156
- "id": 5,
157
- "name": "stage",
158
- "variant": "param",
159
- "kind": 32768,
160
- "flags": {
161
- "isOptional": true
162
- },
163
- "type": {
164
- "type": "reference",
165
- "target": 40,
166
- "name": "ApiStage",
167
- "package": "@xylabs/api"
168
- }
169
- }
170
- ],
171
- "type": {
172
- "type": "reference",
173
- "target": 1,
174
- "name": "ApiClient",
175
- "package": "@xylabs/api"
176
- }
177
- }
178
- ]
179
- },
180
- {
181
- "id": 7,
182
- "name": "stage",
183
- "variant": "declaration",
184
- "kind": 1024,
185
- "flags": {
186
- "isProtected": true,
187
- "isOptional": true
188
- },
189
- "sources": [
190
- {
191
- "fileName": "ApiClient.ts",
192
- "line": 4,
193
- "character": 64,
194
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiClient.ts#L4"
195
- }
196
- ],
197
- "type": {
198
- "type": "reference",
199
- "target": 40,
200
- "name": "ApiStage",
201
- "package": "@xylabs/api"
202
- }
203
- },
204
- {
205
- "id": 6,
206
- "name": "token",
207
- "variant": "declaration",
208
- "kind": 1024,
209
- "flags": {
210
- "isProtected": true,
211
- "isOptional": true
212
- },
213
- "sources": [
214
- {
215
- "fileName": "ApiClient.ts",
216
- "line": 4,
217
- "character": 31,
218
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiClient.ts#L4"
219
- }
220
- ],
221
- "type": {
222
- "type": "union",
223
- "types": [
224
- {
225
- "type": "literal",
226
- "value": null
227
- },
228
- {
229
- "type": "intrinsic",
230
- "name": "string"
231
- }
232
- ]
233
- }
234
- },
235
- {
236
- "id": 8,
237
- "name": "endPoint",
238
- "variant": "declaration",
239
- "kind": 2048,
240
- "flags": {
241
- "isAbstract": true
242
- },
243
- "sources": [
244
- {
245
- "fileName": "ApiClient.ts",
246
- "line": 9,
247
- "character": 11,
248
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiClient.ts#L9"
249
- }
250
- ],
251
- "signatures": [
252
- {
253
- "id": 9,
254
- "name": "endPoint",
255
- "variant": "signature",
256
- "kind": 4096,
257
- "flags": {},
258
- "sources": [
259
- {
260
- "fileName": "ApiClient.ts",
261
- "line": 9,
262
- "character": 2,
263
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiClient.ts#L9"
264
- }
265
- ],
266
- "type": {
267
- "type": "intrinsic",
268
- "name": "string"
269
- }
270
- }
271
- ]
272
- }
273
- ],
274
- "groups": [
275
- {
276
- "title": "Constructors",
277
- "children": [
278
- 2
279
- ]
280
- },
281
- {
282
- "title": "Properties",
283
- "children": [
284
- 7,
285
- 6
286
- ]
287
- },
288
- {
289
- "title": "Methods",
290
- "children": [
291
- 8
292
- ]
293
- }
294
- ],
295
- "sources": [
296
- {
297
- "fileName": "ApiClient.ts",
298
- "line": 3,
299
- "character": 15,
300
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiClient.ts#L3"
301
- }
302
- ]
303
- },
304
- {
305
- "id": 15,
306
- "name": "ApiEndpoint",
307
- "variant": "declaration",
308
- "kind": 128,
309
- "flags": {},
310
- "children": [
311
- {
312
- "id": 16,
313
- "name": "constructor",
314
- "variant": "declaration",
315
- "kind": 512,
316
- "flags": {},
317
- "sources": [
318
- {
319
- "fileName": "ApiEndpoint.ts",
320
- "line": 10,
321
- "character": 2,
322
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L10"
323
- }
324
- ],
325
- "signatures": [
326
- {
327
- "id": 17,
328
- "name": "new ApiEndpoint",
329
- "variant": "signature",
330
- "kind": 16384,
331
- "flags": {},
332
- "sources": [
333
- {
334
- "fileName": "ApiEndpoint.ts",
335
- "line": 10,
336
- "character": 2,
337
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L10"
338
- }
339
- ],
340
- "typeParameter": [
341
- {
342
- "id": 18,
343
- "name": "T",
344
- "variant": "typeParam",
345
- "kind": 131072,
346
- "flags": {}
347
- }
348
- ],
349
- "parameters": [
350
- {
351
- "id": 19,
352
- "name": "config",
353
- "variant": "param",
354
- "kind": 32768,
355
- "flags": {},
356
- "type": {
357
- "type": "reference",
358
- "target": 10,
359
- "name": "ApiConfig",
360
- "package": "@xylabs/api"
361
- }
362
- },
363
- {
364
- "id": 20,
365
- "name": "path",
366
- "variant": "param",
367
- "kind": 32768,
368
- "flags": {},
369
- "type": {
370
- "type": "intrinsic",
371
- "name": "string"
372
- }
373
- }
374
- ],
375
- "type": {
376
- "type": "reference",
377
- "target": 15,
378
- "typeArguments": [
379
- {
380
- "type": "reference",
381
- "target": -1,
382
- "name": "T",
383
- "refersToTypeParameter": true
384
- }
385
- ],
386
- "name": "ApiEndpoint",
387
- "package": "@xylabs/api"
388
- }
389
- }
390
- ]
391
- },
392
- {
393
- "id": 21,
394
- "name": "_value",
395
- "variant": "declaration",
396
- "kind": 1024,
397
- "flags": {
398
- "isPrivate": true,
399
- "isOptional": true
400
- },
401
- "sources": [
402
- {
403
- "fileName": "ApiEndpoint.ts",
404
- "line": 6,
405
- "character": 10,
406
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L6"
407
- }
408
- ],
409
- "type": {
410
- "type": "reference",
411
- "target": -1,
412
- "name": "T",
413
- "refersToTypeParameter": true
414
- }
415
- },
416
- {
417
- "id": 22,
418
- "name": "config",
419
- "variant": "declaration",
420
- "kind": 1024,
421
- "flags": {
422
- "isPrivate": true
423
- },
424
- "sources": [
425
- {
426
- "fileName": "ApiEndpoint.ts",
427
- "line": 7,
428
- "character": 10,
429
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L7"
430
- }
431
- ],
432
- "type": {
433
- "type": "reference",
434
- "target": 10,
435
- "name": "ApiConfig",
436
- "package": "@xylabs/api"
437
- }
438
- },
439
- {
440
- "id": 23,
441
- "name": "path",
442
- "variant": "declaration",
443
- "kind": 1024,
444
- "flags": {
445
- "isPrivate": true
446
- },
447
- "sources": [
448
- {
449
- "fileName": "ApiEndpoint.ts",
450
- "line": 8,
451
- "character": 10,
452
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L8"
453
- }
454
- ],
455
- "type": {
456
- "type": "intrinsic",
457
- "name": "string"
458
- }
459
- },
460
- {
461
- "id": 26,
462
- "name": "headers",
463
- "variant": "declaration",
464
- "kind": 262144,
465
- "flags": {
466
- "isPrivate": true
467
- },
468
- "sources": [
469
- {
470
- "fileName": "ApiEndpoint.ts",
471
- "line": 19,
472
- "character": 14,
473
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L19"
474
- }
475
- ],
476
- "getSignature": {
477
- "id": 27,
478
- "name": "headers",
479
- "variant": "signature",
480
- "kind": 524288,
481
- "flags": {},
482
- "sources": [
483
- {
484
- "fileName": "ApiEndpoint.ts",
485
- "line": 19,
486
- "character": 2,
487
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L19"
488
- }
489
- ],
490
- "type": {
491
- "type": "union",
492
- "types": [
493
- {
494
- "type": "intrinsic",
495
- "name": "undefined"
496
- },
497
- {
498
- "type": "reflection",
499
- "declaration": {
500
- "id": 28,
501
- "name": "__type",
502
- "variant": "declaration",
503
- "kind": 65536,
504
- "flags": {},
505
- "children": [
506
- {
507
- "id": 29,
508
- "name": "Authorization",
509
- "variant": "declaration",
510
- "kind": 1024,
511
- "flags": {},
512
- "sources": [
513
- {
514
- "fileName": "ApiEndpoint.ts",
515
- "line": 20,
516
- "character": 36,
517
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L20"
518
- }
519
- ],
520
- "type": {
521
- "type": "intrinsic",
522
- "name": "string"
523
- },
524
- "defaultValue": "..."
525
- }
526
- ],
527
- "groups": [
528
- {
529
- "title": "Properties",
530
- "children": [
531
- 29
532
- ]
533
- }
534
- ],
535
- "sources": [
536
- {
537
- "fileName": "ApiEndpoint.ts",
538
- "line": 20,
539
- "character": 34,
540
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L20"
541
- }
542
- ]
543
- }
544
- }
545
- ]
546
- }
547
- }
548
- },
549
- {
550
- "id": 30,
551
- "name": "url",
552
- "variant": "declaration",
553
- "kind": 262144,
554
- "flags": {
555
- "isPrivate": true
556
- },
557
- "sources": [
558
- {
559
- "fileName": "ApiEndpoint.ts",
560
- "line": 23,
561
- "character": 14,
562
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L23"
563
- }
564
- ],
565
- "getSignature": {
566
- "id": 31,
567
- "name": "url",
568
- "variant": "signature",
569
- "kind": 524288,
570
- "flags": {},
571
- "sources": [
572
- {
573
- "fileName": "ApiEndpoint.ts",
574
- "line": 23,
575
- "character": 2,
576
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L23"
577
- }
578
- ],
579
- "type": {
580
- "type": "intrinsic",
581
- "name": "string"
582
- }
583
- }
584
- },
585
- {
586
- "id": 24,
587
- "name": "value",
588
- "variant": "declaration",
589
- "kind": 262144,
590
- "flags": {
591
- "isPublic": true
592
- },
593
- "sources": [
594
- {
595
- "fileName": "ApiEndpoint.ts",
596
- "line": 15,
597
- "character": 13,
598
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L15"
599
- }
600
- ],
601
- "getSignature": {
602
- "id": 25,
603
- "name": "value",
604
- "variant": "signature",
605
- "kind": 524288,
606
- "flags": {},
607
- "sources": [
608
- {
609
- "fileName": "ApiEndpoint.ts",
610
- "line": 15,
611
- "character": 2,
612
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L15"
613
- }
614
- ],
615
- "type": {
616
- "type": "union",
617
- "types": [
618
- {
619
- "type": "intrinsic",
620
- "name": "undefined"
621
- },
622
- {
623
- "type": "reference",
624
- "target": -1,
625
- "name": "T",
626
- "refersToTypeParameter": true
627
- }
628
- ]
629
- }
630
- }
631
- },
632
- {
633
- "id": 32,
634
- "name": "fetch",
635
- "variant": "declaration",
636
- "kind": 2048,
637
- "flags": {
638
- "isPublic": true
639
- },
640
- "sources": [
641
- {
642
- "fileName": "ApiEndpoint.ts",
643
- "line": 27,
644
- "character": 15,
645
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L27"
646
- }
647
- ],
648
- "signatures": [
649
- {
650
- "id": 33,
651
- "name": "fetch",
652
- "variant": "signature",
653
- "kind": 4096,
654
- "flags": {},
655
- "sources": [
656
- {
657
- "fileName": "ApiEndpoint.ts",
658
- "line": 27,
659
- "character": 2,
660
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L27"
661
- }
662
- ],
663
- "type": {
664
- "type": "reference",
665
- "target": {
666
- "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
667
- "qualifiedName": "Promise"
668
- },
669
- "typeArguments": [
670
- {
671
- "type": "reference",
672
- "target": -1,
673
- "name": "T",
674
- "refersToTypeParameter": true
675
- }
676
- ],
677
- "name": "Promise",
678
- "package": "typescript"
679
- }
680
- }
681
- ]
682
- },
683
- {
684
- "id": 34,
685
- "name": "get",
686
- "variant": "declaration",
687
- "kind": 2048,
688
- "flags": {
689
- "isPublic": true
690
- },
691
- "sources": [
692
- {
693
- "fileName": "ApiEndpoint.ts",
694
- "line": 37,
695
- "character": 15,
696
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L37"
697
- }
698
- ],
699
- "signatures": [
700
- {
701
- "id": 35,
702
- "name": "get",
703
- "variant": "signature",
704
- "kind": 4096,
705
- "flags": {},
706
- "sources": [
707
- {
708
- "fileName": "ApiEndpoint.ts",
709
- "line": 37,
710
- "character": 2,
711
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L37"
712
- }
713
- ],
714
- "type": {
715
- "type": "reference",
716
- "target": {
717
- "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
718
- "qualifiedName": "Promise"
719
- },
720
- "typeArguments": [
721
- {
722
- "type": "union",
723
- "types": [
724
- {
725
- "type": "reference",
726
- "target": -1,
727
- "name": "T",
728
- "refersToTypeParameter": true
729
- },
730
- {
731
- "type": "reference",
732
- "target": {
733
- "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
734
- "qualifiedName": "NonNullable"
735
- },
736
- "typeArguments": [
737
- {
738
- "type": "reference",
739
- "target": -1,
740
- "name": "T",
741
- "refersToTypeParameter": true
742
- }
743
- ],
744
- "name": "NonNullable",
745
- "package": "typescript"
746
- }
747
- ]
748
- }
749
- ],
750
- "name": "Promise",
751
- "package": "typescript"
752
- }
753
- }
754
- ]
755
- },
756
- {
757
- "id": 36,
758
- "name": "insert",
759
- "variant": "declaration",
760
- "kind": 2048,
761
- "flags": {
762
- "isPublic": true
763
- },
764
- "sources": [
765
- {
766
- "fileName": "ApiEndpoint.ts",
767
- "line": 41,
768
- "character": 15,
769
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L41"
770
- }
771
- ],
772
- "signatures": [
773
- {
774
- "id": 37,
775
- "name": "insert",
776
- "variant": "signature",
777
- "kind": 4096,
778
- "flags": {},
779
- "sources": [
780
- {
781
- "fileName": "ApiEndpoint.ts",
782
- "line": 41,
783
- "character": 2,
784
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L41"
785
- }
786
- ],
787
- "parameters": [
788
- {
789
- "id": 38,
790
- "name": "value",
791
- "variant": "param",
792
- "kind": 32768,
793
- "flags": {},
794
- "type": {
795
- "type": "reference",
796
- "target": -1,
797
- "name": "T",
798
- "refersToTypeParameter": true
799
- }
800
- }
801
- ],
802
- "type": {
803
- "type": "reference",
804
- "target": {
805
- "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
806
- "qualifiedName": "Promise"
807
- },
808
- "typeArguments": [
809
- {
810
- "type": "reference",
811
- "target": -1,
812
- "name": "T",
813
- "refersToTypeParameter": true
814
- }
815
- ],
816
- "name": "Promise",
817
- "package": "typescript"
818
- }
819
- }
820
- ]
821
- }
822
- ],
823
- "groups": [
824
- {
825
- "title": "Constructors",
826
- "children": [
827
- 16
828
- ]
829
- },
830
- {
831
- "title": "Properties",
832
- "children": [
833
- 21,
834
- 22,
835
- 23
836
- ]
837
- },
838
- {
839
- "title": "Accessors",
840
- "children": [
841
- 26,
842
- 30,
843
- 24
844
- ]
845
- },
846
- {
847
- "title": "Methods",
848
- "children": [
849
- 32,
850
- 34,
851
- 36
852
- ]
853
- }
854
- ],
855
- "sources": [
856
- {
857
- "fileName": "ApiEndpoint.ts",
858
- "line": 5,
859
- "character": 6,
860
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L5"
861
- }
862
- ],
863
- "typeParameters": [
864
- {
865
- "id": 39,
866
- "name": "T",
867
- "variant": "typeParam",
868
- "kind": 131072,
869
- "flags": {}
870
- }
871
- ]
872
- },
873
- {
874
- "id": 10,
875
- "name": "ApiConfig",
876
- "variant": "declaration",
877
- "kind": 256,
878
- "flags": {},
879
- "children": [
880
- {
881
- "id": 11,
882
- "name": "apiDomain",
883
- "variant": "declaration",
884
- "kind": 1024,
885
- "flags": {},
886
- "sources": [
887
- {
888
- "fileName": "ApiConfig.ts",
889
- "line": 2,
890
- "character": 2,
891
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiConfig.ts#L2"
892
- }
893
- ],
894
- "type": {
895
- "type": "intrinsic",
896
- "name": "string"
897
- }
898
- },
899
- {
900
- "id": 12,
901
- "name": "apiKey",
902
- "variant": "declaration",
903
- "kind": 1024,
904
- "flags": {
905
- "isOptional": true
906
- },
907
- "sources": [
908
- {
909
- "fileName": "ApiConfig.ts",
910
- "line": 3,
911
- "character": 2,
912
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiConfig.ts#L3"
913
- }
914
- ],
915
- "type": {
916
- "type": "intrinsic",
917
- "name": "string"
918
- }
919
- },
920
- {
921
- "id": 13,
922
- "name": "jwtToken",
923
- "variant": "declaration",
924
- "kind": 1024,
925
- "flags": {
926
- "isOptional": true
927
- },
928
- "sources": [
929
- {
930
- "fileName": "ApiConfig.ts",
931
- "line": 4,
932
- "character": 2,
933
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiConfig.ts#L4"
934
- }
935
- ],
936
- "type": {
937
- "type": "intrinsic",
938
- "name": "string"
939
- }
940
- },
941
- {
942
- "id": 14,
943
- "name": "userid",
944
- "variant": "declaration",
945
- "kind": 1024,
946
- "flags": {
947
- "isOptional": true
948
- },
949
- "sources": [
950
- {
951
- "fileName": "ApiConfig.ts",
952
- "line": 5,
953
- "character": 2,
954
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiConfig.ts#L5"
955
- }
956
- ],
957
- "type": {
958
- "type": "intrinsic",
959
- "name": "string"
960
- }
961
- }
962
- ],
963
- "groups": [
964
- {
965
- "title": "Properties",
966
- "children": [
967
- 11,
968
- 12,
969
- 13,
970
- 14
971
- ]
972
- }
973
- ],
974
- "sources": [
975
- {
976
- "fileName": "ApiConfig.ts",
977
- "line": 1,
978
- "character": 10,
979
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiConfig.ts#L1"
980
- }
981
- ]
982
- },
983
- {
984
- "id": 44,
985
- "name": "getApiStage",
986
- "variant": "declaration",
987
- "kind": 64,
988
- "flags": {},
989
- "sources": [
990
- {
991
- "fileName": "getApiStage.ts",
992
- "line": 3,
993
- "character": 6,
994
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/getApiStage.ts#L3"
995
- }
996
- ],
997
- "signatures": [
998
- {
999
- "id": 45,
1000
- "name": "getApiStage",
1001
- "variant": "signature",
1002
- "kind": 4096,
1003
- "flags": {},
1004
- "sources": [
1005
- {
1006
- "fileName": "getApiStage.ts",
1007
- "line": 3,
1008
- "character": 20,
1009
- "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/getApiStage.ts#L3"
1010
- }
1011
- ],
1012
- "parameters": [
1013
- {
1014
- "id": 46,
1015
- "name": "hostname",
1016
- "variant": "param",
1017
- "kind": 32768,
1018
- "flags": {},
1019
- "type": {
1020
- "type": "intrinsic",
1021
- "name": "string"
1022
- }
1023
- }
1024
- ],
1025
- "type": {
1026
- "type": "reference",
1027
- "target": -1,
1028
- "name": "ApiStage",
1029
- "refersToTypeParameter": true
1030
- }
1031
- }
1032
- ]
1033
- }
1034
- ],
1035
- "groups": [
1036
- {
1037
- "title": "Enumerations",
1038
- "children": [
1039
- 40
1040
- ]
1041
- },
1042
- {
1043
- "title": "Classes",
1044
- "children": [
1045
- 1,
1046
- 15
1047
- ]
1048
- },
1049
- {
1050
- "title": "Interfaces",
1051
- "children": [
1052
- 10
1053
- ]
1054
- },
1055
- {
1056
- "title": "Functions",
1057
- "children": [
1058
- 44
1059
- ]
1060
- }
1061
- ],
1062
- "packageName": "@xylabs/api",
1063
- "readme": [
1064
- {
1065
- "kind": "text",
1066
- "text": "[![logo][]](https://xylabs.com)\n\n# @xylabs/sdk-js\n\n[![main-build][]][main-build-link]\n[![beta-build][]][beta-build-link]\n[![npm-badge][]][npm-link]\n[![bch-badge][]][bch-link]\n[![codacy-badge][]][codacy-link]\n[![codeclimate-badge][]][codeclimate-link]\n[![snyk-badge][]][snyk-link]\n\n## Table of Contents\n\n- [Description](#description)\n- [Install](#install)\n- [Scripts](#scripts)\n- [Maintainers](#maintainers)\n- [License](#license)\n- [Credits](#credits)\n\n## Description\n\nSDK for base code for Typescript and Javascript Libraries.\n\n## Install\n\nUsing npm:\n\n"
1067
- },
1068
- {
1069
- "kind": "code",
1070
- "text": "```sh\nnpm i --save @xylabs/sdk-js\n```"
1071
- },
1072
- {
1073
- "kind": "text",
1074
- "text": "\n\nUsing yarn:\n\n"
1075
- },
1076
- {
1077
- "kind": "code",
1078
- "text": "```sh\nyarn add @xylabs/sdk-js\n```"
1079
- },
1080
- {
1081
- "kind": "text",
1082
- "text": "\n\n## Scripts\n\nSee [ts-scripts](https://github.com/xylabs/ts-scripts/blob/main/README.md)\nfor list of shared scripts.\n\n## Maintainers\n\n- [Arie Trouw](https://github.com/arietrouw) (<https://arietrouw.com>)\n\n## License\n\nSee the [LICENSE](LICENSE) file for license details\n\n## Credits\n\n[Made with 🔥 and ❄️ by XY Labs](https://xylabs.com)\n\n[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg\n[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build-main.yml/badge.svg\n[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build-main.yml\n[beta-build]: https://github.com/xylabs/sdk-js/actions/workflows/build-beta.yml/badge.svg\n[beta-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build-beta.yml\n[npm-badge]: https://img.shields.io/npm/v/@xylabs/sdk-js.svg\n[npm-link]: https://www.npmjs.com/package/@xylabs/sdk-js\n[bch-badge]: https://bettercodehub.com/edge/badge/xylabs/sdk-js?branch=main\n[bch-link]: https://bettercodehub.com/results/xylabs/sdk-js\n[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698\n[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade\n[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability\n[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability\n[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json\n[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json"
1083
- }
1084
- ],
1085
- "symbolIdMap": {
1086
- "0": {
1087
- "sourceFileName": "src/index.ts",
1088
- "qualifiedName": ""
1089
- },
1090
- "1": {
1091
- "sourceFileName": "src/ApiClient.ts",
1092
- "qualifiedName": "ApiClient"
1093
- },
1094
- "2": {
1095
- "sourceFileName": "src/ApiClient.ts",
1096
- "qualifiedName": "ApiClient.__constructor"
1097
- },
1098
- "3": {
1099
- "sourceFileName": "src/ApiClient.ts",
1100
- "qualifiedName": "ApiClient"
1101
- },
1102
- "4": {
1103
- "sourceFileName": "src/ApiClient.ts",
1104
- "qualifiedName": "token"
1105
- },
1106
- "5": {
1107
- "sourceFileName": "src/ApiClient.ts",
1108
- "qualifiedName": "stage"
1109
- },
1110
- "6": {
1111
- "sourceFileName": "src/ApiClient.ts",
1112
- "qualifiedName": "ApiClient.token"
1113
- },
1114
- "7": {
1115
- "sourceFileName": "src/ApiClient.ts",
1116
- "qualifiedName": "ApiClient.stage"
1117
- },
1118
- "8": {
1119
- "sourceFileName": "src/ApiClient.ts",
1120
- "qualifiedName": "ApiClient.endPoint"
1121
- },
1122
- "9": {
1123
- "sourceFileName": "src/ApiClient.ts",
1124
- "qualifiedName": "ApiClient.endPoint"
1125
- },
1126
- "10": {
1127
- "sourceFileName": "src/ApiConfig.ts",
1128
- "qualifiedName": "ApiConfig"
1129
- },
1130
- "11": {
1131
- "sourceFileName": "src/ApiConfig.ts",
1132
- "qualifiedName": "ApiConfig.apiDomain"
1133
- },
1134
- "12": {
1135
- "sourceFileName": "src/ApiConfig.ts",
1136
- "qualifiedName": "ApiConfig.apiKey"
1137
- },
1138
- "13": {
1139
- "sourceFileName": "src/ApiConfig.ts",
1140
- "qualifiedName": "ApiConfig.jwtToken"
1141
- },
1142
- "14": {
1143
- "sourceFileName": "src/ApiConfig.ts",
1144
- "qualifiedName": "ApiConfig.userid"
1145
- },
1146
- "15": {
1147
- "sourceFileName": "src/ApiEndpoint.ts",
1148
- "qualifiedName": "ApiEndpoint"
1149
- },
1150
- "16": {
1151
- "sourceFileName": "src/ApiEndpoint.ts",
1152
- "qualifiedName": "ApiEndpoint.__constructor"
1153
- },
1154
- "17": {
1155
- "sourceFileName": "src/ApiEndpoint.ts",
1156
- "qualifiedName": "ApiEndpoint"
1157
- },
1158
- "18": {
1159
- "sourceFileName": "src/ApiEndpoint.ts",
1160
- "qualifiedName": "ApiEndpoint.T"
1161
- },
1162
- "19": {
1163
- "sourceFileName": "src/ApiEndpoint.ts",
1164
- "qualifiedName": "config"
1165
- },
1166
- "20": {
1167
- "sourceFileName": "src/ApiEndpoint.ts",
1168
- "qualifiedName": "path"
1169
- },
1170
- "21": {
1171
- "sourceFileName": "src/ApiEndpoint.ts",
1172
- "qualifiedName": "ApiEndpoint._value"
1173
- },
1174
- "22": {
1175
- "sourceFileName": "src/ApiEndpoint.ts",
1176
- "qualifiedName": "ApiEndpoint.config"
1177
- },
1178
- "23": {
1179
- "sourceFileName": "src/ApiEndpoint.ts",
1180
- "qualifiedName": "ApiEndpoint.path"
1181
- },
1182
- "24": {
1183
- "sourceFileName": "src/ApiEndpoint.ts",
1184
- "qualifiedName": "ApiEndpoint.value"
1185
- },
1186
- "25": {
1187
- "sourceFileName": "src/ApiEndpoint.ts",
1188
- "qualifiedName": "ApiEndpoint.value"
1189
- },
1190
- "26": {
1191
- "sourceFileName": "src/ApiEndpoint.ts",
1192
- "qualifiedName": "ApiEndpoint.headers"
1193
- },
1194
- "27": {
1195
- "sourceFileName": "src/ApiEndpoint.ts",
1196
- "qualifiedName": "ApiEndpoint.headers"
1197
- },
1198
- "28": {
1199
- "sourceFileName": "src/ApiEndpoint.ts",
1200
- "qualifiedName": "__object"
1201
- },
1202
- "29": {
1203
- "sourceFileName": "src/ApiEndpoint.ts",
1204
- "qualifiedName": "__object.Authorization"
1205
- },
1206
- "30": {
1207
- "sourceFileName": "src/ApiEndpoint.ts",
1208
- "qualifiedName": "ApiEndpoint.url"
1209
- },
1210
- "31": {
1211
- "sourceFileName": "src/ApiEndpoint.ts",
1212
- "qualifiedName": "ApiEndpoint.url"
1213
- },
1214
- "32": {
1215
- "sourceFileName": "src/ApiEndpoint.ts",
1216
- "qualifiedName": "ApiEndpoint.fetch"
1217
- },
1218
- "33": {
1219
- "sourceFileName": "src/ApiEndpoint.ts",
1220
- "qualifiedName": "ApiEndpoint.fetch"
1221
- },
1222
- "34": {
1223
- "sourceFileName": "src/ApiEndpoint.ts",
1224
- "qualifiedName": "ApiEndpoint.get"
1225
- },
1226
- "35": {
1227
- "sourceFileName": "src/ApiEndpoint.ts",
1228
- "qualifiedName": "ApiEndpoint.get"
1229
- },
1230
- "36": {
1231
- "sourceFileName": "src/ApiEndpoint.ts",
1232
- "qualifiedName": "ApiEndpoint.insert"
1233
- },
1234
- "37": {
1235
- "sourceFileName": "src/ApiEndpoint.ts",
1236
- "qualifiedName": "ApiEndpoint.insert"
1237
- },
1238
- "38": {
1239
- "sourceFileName": "src/ApiEndpoint.ts",
1240
- "qualifiedName": "value"
1241
- },
1242
- "39": {
1243
- "sourceFileName": "src/ApiEndpoint.ts",
1244
- "qualifiedName": "ApiEndpoint.T"
1245
- },
1246
- "40": {
1247
- "sourceFileName": "src/ApiStage.ts",
1248
- "qualifiedName": "ApiStage"
1249
- },
1250
- "41": {
1251
- "sourceFileName": "src/ApiStage.ts",
1252
- "qualifiedName": "ApiStage.Beta"
1253
- },
1254
- "42": {
1255
- "sourceFileName": "src/ApiStage.ts",
1256
- "qualifiedName": "ApiStage.Local"
1257
- },
1258
- "43": {
1259
- "sourceFileName": "src/ApiStage.ts",
1260
- "qualifiedName": "ApiStage.Prod"
1261
- },
1262
- "44": {
1263
- "sourceFileName": "src/getApiStage.ts",
1264
- "qualifiedName": "getApiStage"
1265
- },
1266
- "45": {
1267
- "sourceFileName": "src/getApiStage.ts",
1268
- "qualifiedName": "getApiStage"
1269
- },
1270
- "46": {
1271
- "sourceFileName": "src/getApiStage.ts",
1272
- "qualifiedName": "hostname"
1273
- }
1274
- }
1275
- }