@xylabs/api 2.9.0 → 2.9.2

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/docs.json CHANGED
@@ -1,30 +1,29 @@
1
1
  {
2
2
  "id": 0,
3
3
  "name": "@xylabs/api",
4
+ "variant": "project",
4
5
  "kind": 1,
5
- "kindString": "Project",
6
6
  "flags": {},
7
- "originalName": "",
8
7
  "children": [
9
8
  {
10
9
  "id": 40,
11
10
  "name": "ApiStage",
11
+ "variant": "declaration",
12
12
  "kind": 8,
13
- "kindString": "Enumeration",
14
13
  "flags": {},
15
14
  "children": [
16
15
  {
17
16
  "id": 41,
18
17
  "name": "Beta",
18
+ "variant": "declaration",
19
19
  "kind": 16,
20
- "kindString": "Enumeration Member",
21
20
  "flags": {},
22
21
  "sources": [
23
22
  {
24
23
  "fileName": "ApiStage.ts",
25
24
  "line": 2,
26
25
  "character": 2,
27
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiStage.ts#L2"
26
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiStage.ts#L2"
28
27
  }
29
28
  ],
30
29
  "type": {
@@ -35,15 +34,15 @@
35
34
  {
36
35
  "id": 42,
37
36
  "name": "Local",
37
+ "variant": "declaration",
38
38
  "kind": 16,
39
- "kindString": "Enumeration Member",
40
39
  "flags": {},
41
40
  "sources": [
42
41
  {
43
42
  "fileName": "ApiStage.ts",
44
43
  "line": 3,
45
44
  "character": 2,
46
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiStage.ts#L3"
45
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiStage.ts#L3"
47
46
  }
48
47
  ],
49
48
  "type": {
@@ -54,15 +53,15 @@
54
53
  {
55
54
  "id": 43,
56
55
  "name": "Prod",
56
+ "variant": "declaration",
57
57
  "kind": 16,
58
- "kindString": "Enumeration Member",
59
58
  "flags": {},
60
59
  "sources": [
61
60
  {
62
61
  "fileName": "ApiStage.ts",
63
62
  "line": 4,
64
63
  "character": 2,
65
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiStage.ts#L4"
64
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiStage.ts#L4"
66
65
  }
67
66
  ],
68
67
  "type": {
@@ -86,15 +85,15 @@
86
85
  "fileName": "ApiStage.ts",
87
86
  "line": 1,
88
87
  "character": 5,
89
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiStage.ts#L1"
88
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiStage.ts#L1"
90
89
  }
91
90
  ]
92
91
  },
93
92
  {
94
93
  "id": 1,
95
94
  "name": "ApiClient",
95
+ "variant": "declaration",
96
96
  "kind": 128,
97
- "kindString": "Class",
98
97
  "flags": {
99
98
  "isAbstract": true
100
99
  },
@@ -102,8 +101,8 @@
102
101
  {
103
102
  "id": 2,
104
103
  "name": "constructor",
104
+ "variant": "declaration",
105
105
  "kind": 512,
106
- "kindString": "Constructor",
107
106
  "flags": {
108
107
  "isPublic": true
109
108
  },
@@ -112,22 +111,30 @@
112
111
  "fileName": "ApiClient.ts",
113
112
  "line": 4,
114
113
  "character": 2,
115
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiClient.ts#L4"
114
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiClient.ts#L4"
116
115
  }
117
116
  ],
118
117
  "signatures": [
119
118
  {
120
119
  "id": 3,
121
120
  "name": "new ApiClient",
121
+ "variant": "signature",
122
122
  "kind": 16384,
123
- "kindString": "Constructor signature",
124
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
+ ],
125
132
  "parameters": [
126
133
  {
127
134
  "id": 4,
128
135
  "name": "token",
136
+ "variant": "param",
129
137
  "kind": 32768,
130
- "kindString": "Parameter",
131
138
  "flags": {
132
139
  "isOptional": true
133
140
  },
@@ -148,22 +155,24 @@
148
155
  {
149
156
  "id": 5,
150
157
  "name": "stage",
158
+ "variant": "param",
151
159
  "kind": 32768,
152
- "kindString": "Parameter",
153
160
  "flags": {
154
161
  "isOptional": true
155
162
  },
156
163
  "type": {
157
164
  "type": "reference",
158
- "id": 40,
159
- "name": "ApiStage"
165
+ "target": 40,
166
+ "name": "ApiStage",
167
+ "package": "@xylabs/api"
160
168
  }
161
169
  }
162
170
  ],
163
171
  "type": {
164
172
  "type": "reference",
165
- "id": 1,
166
- "name": "ApiClient"
173
+ "target": 1,
174
+ "name": "ApiClient",
175
+ "package": "@xylabs/api"
167
176
  }
168
177
  }
169
178
  ]
@@ -171,8 +180,8 @@
171
180
  {
172
181
  "id": 7,
173
182
  "name": "stage",
183
+ "variant": "declaration",
174
184
  "kind": 1024,
175
- "kindString": "Property",
176
185
  "flags": {
177
186
  "isProtected": true,
178
187
  "isOptional": true
@@ -182,20 +191,21 @@
182
191
  "fileName": "ApiClient.ts",
183
192
  "line": 4,
184
193
  "character": 64,
185
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiClient.ts#L4"
194
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiClient.ts#L4"
186
195
  }
187
196
  ],
188
197
  "type": {
189
198
  "type": "reference",
190
- "id": 40,
191
- "name": "ApiStage"
199
+ "target": 40,
200
+ "name": "ApiStage",
201
+ "package": "@xylabs/api"
192
202
  }
193
203
  },
194
204
  {
195
205
  "id": 6,
196
206
  "name": "token",
207
+ "variant": "declaration",
197
208
  "kind": 1024,
198
- "kindString": "Property",
199
209
  "flags": {
200
210
  "isProtected": true,
201
211
  "isOptional": true
@@ -205,7 +215,7 @@
205
215
  "fileName": "ApiClient.ts",
206
216
  "line": 4,
207
217
  "character": 31,
208
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiClient.ts#L4"
218
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiClient.ts#L4"
209
219
  }
210
220
  ],
211
221
  "type": {
@@ -225,8 +235,8 @@
225
235
  {
226
236
  "id": 8,
227
237
  "name": "endPoint",
238
+ "variant": "declaration",
228
239
  "kind": 2048,
229
- "kindString": "Method",
230
240
  "flags": {
231
241
  "isAbstract": true
232
242
  },
@@ -235,16 +245,24 @@
235
245
  "fileName": "ApiClient.ts",
236
246
  "line": 9,
237
247
  "character": 11,
238
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiClient.ts#L9"
248
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiClient.ts#L9"
239
249
  }
240
250
  ],
241
251
  "signatures": [
242
252
  {
243
253
  "id": 9,
244
254
  "name": "endPoint",
255
+ "variant": "signature",
245
256
  "kind": 4096,
246
- "kindString": "Call signature",
247
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
+ ],
248
266
  "type": {
249
267
  "type": "intrinsic",
250
268
  "name": "string"
@@ -279,44 +297,52 @@
279
297
  "fileName": "ApiClient.ts",
280
298
  "line": 3,
281
299
  "character": 15,
282
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiClient.ts#L3"
300
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiClient.ts#L3"
283
301
  }
284
302
  ]
285
303
  },
286
304
  {
287
305
  "id": 15,
288
306
  "name": "ApiEndpoint",
307
+ "variant": "declaration",
289
308
  "kind": 128,
290
- "kindString": "Class",
291
309
  "flags": {},
292
310
  "children": [
293
311
  {
294
312
  "id": 16,
295
313
  "name": "constructor",
314
+ "variant": "declaration",
296
315
  "kind": 512,
297
- "kindString": "Constructor",
298
316
  "flags": {},
299
317
  "sources": [
300
318
  {
301
319
  "fileName": "ApiEndpoint.ts",
302
320
  "line": 10,
303
321
  "character": 2,
304
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiEndpoint.ts#L10"
322
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L10"
305
323
  }
306
324
  ],
307
325
  "signatures": [
308
326
  {
309
327
  "id": 17,
310
328
  "name": "new ApiEndpoint",
329
+ "variant": "signature",
311
330
  "kind": 16384,
312
- "kindString": "Constructor signature",
313
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
+ ],
314
340
  "typeParameter": [
315
341
  {
316
342
  "id": 18,
317
343
  "name": "T",
344
+ "variant": "typeParam",
318
345
  "kind": 131072,
319
- "kindString": "Type parameter",
320
346
  "flags": {}
321
347
  }
322
348
  ],
@@ -324,20 +350,21 @@
324
350
  {
325
351
  "id": 19,
326
352
  "name": "config",
353
+ "variant": "param",
327
354
  "kind": 32768,
328
- "kindString": "Parameter",
329
355
  "flags": {},
330
356
  "type": {
331
357
  "type": "reference",
332
- "id": 10,
333
- "name": "ApiConfig"
358
+ "target": 10,
359
+ "name": "ApiConfig",
360
+ "package": "@xylabs/api"
334
361
  }
335
362
  },
336
363
  {
337
364
  "id": 20,
338
365
  "name": "path",
366
+ "variant": "param",
339
367
  "kind": 32768,
340
- "kindString": "Parameter",
341
368
  "flags": {},
342
369
  "type": {
343
370
  "type": "intrinsic",
@@ -347,15 +374,17 @@
347
374
  ],
348
375
  "type": {
349
376
  "type": "reference",
350
- "id": 15,
377
+ "target": 15,
351
378
  "typeArguments": [
352
379
  {
353
380
  "type": "reference",
354
- "id": 18,
355
- "name": "T"
381
+ "target": -1,
382
+ "name": "T",
383
+ "refersToTypeParameter": true
356
384
  }
357
385
  ],
358
- "name": "ApiEndpoint"
386
+ "name": "ApiEndpoint",
387
+ "package": "@xylabs/api"
359
388
  }
360
389
  }
361
390
  ]
@@ -363,8 +392,8 @@
363
392
  {
364
393
  "id": 21,
365
394
  "name": "_value",
395
+ "variant": "declaration",
366
396
  "kind": 1024,
367
- "kindString": "Property",
368
397
  "flags": {
369
398
  "isPrivate": true,
370
399
  "isOptional": true
@@ -374,20 +403,21 @@
374
403
  "fileName": "ApiEndpoint.ts",
375
404
  "line": 6,
376
405
  "character": 10,
377
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiEndpoint.ts#L6"
406
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L6"
378
407
  }
379
408
  ],
380
409
  "type": {
381
410
  "type": "reference",
382
- "id": 18,
383
- "name": "T"
411
+ "target": -1,
412
+ "name": "T",
413
+ "refersToTypeParameter": true
384
414
  }
385
415
  },
386
416
  {
387
417
  "id": 22,
388
418
  "name": "config",
419
+ "variant": "declaration",
389
420
  "kind": 1024,
390
- "kindString": "Property",
391
421
  "flags": {
392
422
  "isPrivate": true
393
423
  },
@@ -396,20 +426,21 @@
396
426
  "fileName": "ApiEndpoint.ts",
397
427
  "line": 7,
398
428
  "character": 10,
399
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiEndpoint.ts#L7"
429
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L7"
400
430
  }
401
431
  ],
402
432
  "type": {
403
433
  "type": "reference",
404
- "id": 10,
405
- "name": "ApiConfig"
434
+ "target": 10,
435
+ "name": "ApiConfig",
436
+ "package": "@xylabs/api"
406
437
  }
407
438
  },
408
439
  {
409
440
  "id": 23,
410
441
  "name": "path",
442
+ "variant": "declaration",
411
443
  "kind": 1024,
412
- "kindString": "Property",
413
444
  "flags": {
414
445
  "isPrivate": true
415
446
  },
@@ -418,7 +449,7 @@
418
449
  "fileName": "ApiEndpoint.ts",
419
450
  "line": 8,
420
451
  "character": 10,
421
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiEndpoint.ts#L8"
452
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L8"
422
453
  }
423
454
  ],
424
455
  "type": {
@@ -429,8 +460,8 @@
429
460
  {
430
461
  "id": 26,
431
462
  "name": "headers",
463
+ "variant": "declaration",
432
464
  "kind": 262144,
433
- "kindString": "Accessor",
434
465
  "flags": {
435
466
  "isPrivate": true
436
467
  },
@@ -439,15 +470,23 @@
439
470
  "fileName": "ApiEndpoint.ts",
440
471
  "line": 19,
441
472
  "character": 14,
442
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiEndpoint.ts#L19"
473
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L19"
443
474
  }
444
475
  ],
445
476
  "getSignature": {
446
477
  "id": 27,
447
478
  "name": "headers",
479
+ "variant": "signature",
448
480
  "kind": 524288,
449
- "kindString": "Get signature",
450
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
+ ],
451
490
  "type": {
452
491
  "type": "union",
453
492
  "types": [
@@ -460,22 +499,22 @@
460
499
  "declaration": {
461
500
  "id": 28,
462
501
  "name": "__type",
502
+ "variant": "declaration",
463
503
  "kind": 65536,
464
- "kindString": "Type literal",
465
504
  "flags": {},
466
505
  "children": [
467
506
  {
468
507
  "id": 29,
469
508
  "name": "Authorization",
509
+ "variant": "declaration",
470
510
  "kind": 1024,
471
- "kindString": "Property",
472
511
  "flags": {},
473
512
  "sources": [
474
513
  {
475
514
  "fileName": "ApiEndpoint.ts",
476
515
  "line": 20,
477
516
  "character": 36,
478
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiEndpoint.ts#L20"
517
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L20"
479
518
  }
480
519
  ],
481
520
  "type": {
@@ -498,7 +537,7 @@
498
537
  "fileName": "ApiEndpoint.ts",
499
538
  "line": 20,
500
539
  "character": 34,
501
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiEndpoint.ts#L20"
540
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L20"
502
541
  }
503
542
  ]
504
543
  }
@@ -510,8 +549,8 @@
510
549
  {
511
550
  "id": 30,
512
551
  "name": "url",
552
+ "variant": "declaration",
513
553
  "kind": 262144,
514
- "kindString": "Accessor",
515
554
  "flags": {
516
555
  "isPrivate": true
517
556
  },
@@ -520,15 +559,23 @@
520
559
  "fileName": "ApiEndpoint.ts",
521
560
  "line": 23,
522
561
  "character": 14,
523
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiEndpoint.ts#L23"
562
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L23"
524
563
  }
525
564
  ],
526
565
  "getSignature": {
527
566
  "id": 31,
528
567
  "name": "url",
568
+ "variant": "signature",
529
569
  "kind": 524288,
530
- "kindString": "Get signature",
531
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
+ ],
532
579
  "type": {
533
580
  "type": "intrinsic",
534
581
  "name": "string"
@@ -538,8 +585,8 @@
538
585
  {
539
586
  "id": 24,
540
587
  "name": "value",
588
+ "variant": "declaration",
541
589
  "kind": 262144,
542
- "kindString": "Accessor",
543
590
  "flags": {
544
591
  "isPublic": true
545
592
  },
@@ -548,15 +595,23 @@
548
595
  "fileName": "ApiEndpoint.ts",
549
596
  "line": 15,
550
597
  "character": 13,
551
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiEndpoint.ts#L15"
598
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L15"
552
599
  }
553
600
  ],
554
601
  "getSignature": {
555
602
  "id": 25,
556
603
  "name": "value",
604
+ "variant": "signature",
557
605
  "kind": 524288,
558
- "kindString": "Get signature",
559
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
+ ],
560
615
  "type": {
561
616
  "type": "union",
562
617
  "types": [
@@ -566,8 +621,9 @@
566
621
  },
567
622
  {
568
623
  "type": "reference",
569
- "id": 18,
570
- "name": "T"
624
+ "target": -1,
625
+ "name": "T",
626
+ "refersToTypeParameter": true
571
627
  }
572
628
  ]
573
629
  }
@@ -576,8 +632,8 @@
576
632
  {
577
633
  "id": 32,
578
634
  "name": "fetch",
635
+ "variant": "declaration",
579
636
  "kind": 2048,
580
- "kindString": "Method",
581
637
  "flags": {
582
638
  "isPublic": true
583
639
  },
@@ -586,27 +642,39 @@
586
642
  "fileName": "ApiEndpoint.ts",
587
643
  "line": 27,
588
644
  "character": 15,
589
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiEndpoint.ts#L27"
645
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L27"
590
646
  }
591
647
  ],
592
648
  "signatures": [
593
649
  {
594
650
  "id": 33,
595
651
  "name": "fetch",
652
+ "variant": "signature",
596
653
  "kind": 4096,
597
- "kindString": "Call signature",
598
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
+ ],
599
663
  "type": {
600
664
  "type": "reference",
665
+ "target": {
666
+ "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
667
+ "qualifiedName": "Promise"
668
+ },
601
669
  "typeArguments": [
602
670
  {
603
671
  "type": "reference",
604
- "id": 18,
605
- "name": "T"
672
+ "target": -1,
673
+ "name": "T",
674
+ "refersToTypeParameter": true
606
675
  }
607
676
  ],
608
677
  "name": "Promise",
609
- "qualifiedName": "Promise",
610
678
  "package": "typescript"
611
679
  }
612
680
  }
@@ -615,8 +683,8 @@
615
683
  {
616
684
  "id": 34,
617
685
  "name": "get",
686
+ "variant": "declaration",
618
687
  "kind": 2048,
619
- "kindString": "Method",
620
688
  "flags": {
621
689
  "isPublic": true
622
690
  },
@@ -625,45 +693,61 @@
625
693
  "fileName": "ApiEndpoint.ts",
626
694
  "line": 37,
627
695
  "character": 15,
628
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiEndpoint.ts#L37"
696
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L37"
629
697
  }
630
698
  ],
631
699
  "signatures": [
632
700
  {
633
701
  "id": 35,
634
702
  "name": "get",
703
+ "variant": "signature",
635
704
  "kind": 4096,
636
- "kindString": "Call signature",
637
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
+ ],
638
714
  "type": {
639
715
  "type": "reference",
716
+ "target": {
717
+ "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
718
+ "qualifiedName": "Promise"
719
+ },
640
720
  "typeArguments": [
641
721
  {
642
722
  "type": "union",
643
723
  "types": [
644
724
  {
645
725
  "type": "reference",
646
- "id": 18,
647
- "name": "T"
726
+ "target": -1,
727
+ "name": "T",
728
+ "refersToTypeParameter": true
648
729
  },
649
730
  {
650
731
  "type": "reference",
732
+ "target": {
733
+ "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
734
+ "qualifiedName": "NonNullable"
735
+ },
651
736
  "typeArguments": [
652
737
  {
653
738
  "type": "reference",
654
- "id": 18,
655
- "name": "T"
739
+ "target": -1,
740
+ "name": "T",
741
+ "refersToTypeParameter": true
656
742
  }
657
743
  ],
658
744
  "name": "NonNullable",
659
- "qualifiedName": "NonNullable",
660
745
  "package": "typescript"
661
746
  }
662
747
  ]
663
748
  }
664
749
  ],
665
750
  "name": "Promise",
666
- "qualifiedName": "Promise",
667
751
  "package": "typescript"
668
752
  }
669
753
  }
@@ -672,8 +756,8 @@
672
756
  {
673
757
  "id": 36,
674
758
  "name": "insert",
759
+ "variant": "declaration",
675
760
  "kind": 2048,
676
- "kindString": "Method",
677
761
  "flags": {
678
762
  "isPublic": true
679
763
  },
@@ -682,41 +766,54 @@
682
766
  "fileName": "ApiEndpoint.ts",
683
767
  "line": 41,
684
768
  "character": 15,
685
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiEndpoint.ts#L41"
769
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L41"
686
770
  }
687
771
  ],
688
772
  "signatures": [
689
773
  {
690
774
  "id": 37,
691
775
  "name": "insert",
776
+ "variant": "signature",
692
777
  "kind": 4096,
693
- "kindString": "Call signature",
694
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
+ ],
695
787
  "parameters": [
696
788
  {
697
789
  "id": 38,
698
790
  "name": "value",
791
+ "variant": "param",
699
792
  "kind": 32768,
700
- "kindString": "Parameter",
701
793
  "flags": {},
702
794
  "type": {
703
795
  "type": "reference",
704
- "id": 18,
705
- "name": "T"
796
+ "target": -1,
797
+ "name": "T",
798
+ "refersToTypeParameter": true
706
799
  }
707
800
  }
708
801
  ],
709
802
  "type": {
710
803
  "type": "reference",
804
+ "target": {
805
+ "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
806
+ "qualifiedName": "Promise"
807
+ },
711
808
  "typeArguments": [
712
809
  {
713
810
  "type": "reference",
714
- "id": 18,
715
- "name": "T"
811
+ "target": -1,
812
+ "name": "T",
813
+ "refersToTypeParameter": true
716
814
  }
717
815
  ],
718
816
  "name": "Promise",
719
- "qualifiedName": "Promise",
720
817
  "package": "typescript"
721
818
  }
722
819
  }
@@ -760,15 +857,15 @@
760
857
  "fileName": "ApiEndpoint.ts",
761
858
  "line": 5,
762
859
  "character": 6,
763
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiEndpoint.ts#L5"
860
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiEndpoint.ts#L5"
764
861
  }
765
862
  ],
766
863
  "typeParameters": [
767
864
  {
768
865
  "id": 39,
769
866
  "name": "T",
867
+ "variant": "typeParam",
770
868
  "kind": 131072,
771
- "kindString": "Type parameter",
772
869
  "flags": {}
773
870
  }
774
871
  ]
@@ -776,22 +873,22 @@
776
873
  {
777
874
  "id": 10,
778
875
  "name": "ApiConfig",
876
+ "variant": "declaration",
779
877
  "kind": 256,
780
- "kindString": "Interface",
781
878
  "flags": {},
782
879
  "children": [
783
880
  {
784
881
  "id": 11,
785
882
  "name": "apiDomain",
883
+ "variant": "declaration",
786
884
  "kind": 1024,
787
- "kindString": "Property",
788
885
  "flags": {},
789
886
  "sources": [
790
887
  {
791
888
  "fileName": "ApiConfig.ts",
792
889
  "line": 2,
793
890
  "character": 2,
794
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiConfig.ts#L2"
891
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiConfig.ts#L2"
795
892
  }
796
893
  ],
797
894
  "type": {
@@ -802,8 +899,8 @@
802
899
  {
803
900
  "id": 12,
804
901
  "name": "apiKey",
902
+ "variant": "declaration",
805
903
  "kind": 1024,
806
- "kindString": "Property",
807
904
  "flags": {
808
905
  "isOptional": true
809
906
  },
@@ -812,7 +909,7 @@
812
909
  "fileName": "ApiConfig.ts",
813
910
  "line": 3,
814
911
  "character": 2,
815
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiConfig.ts#L3"
912
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiConfig.ts#L3"
816
913
  }
817
914
  ],
818
915
  "type": {
@@ -823,8 +920,8 @@
823
920
  {
824
921
  "id": 13,
825
922
  "name": "jwtToken",
923
+ "variant": "declaration",
826
924
  "kind": 1024,
827
- "kindString": "Property",
828
925
  "flags": {
829
926
  "isOptional": true
830
927
  },
@@ -833,7 +930,7 @@
833
930
  "fileName": "ApiConfig.ts",
834
931
  "line": 4,
835
932
  "character": 2,
836
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiConfig.ts#L4"
933
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiConfig.ts#L4"
837
934
  }
838
935
  ],
839
936
  "type": {
@@ -844,8 +941,8 @@
844
941
  {
845
942
  "id": 14,
846
943
  "name": "userid",
944
+ "variant": "declaration",
847
945
  "kind": 1024,
848
- "kindString": "Property",
849
946
  "flags": {
850
947
  "isOptional": true
851
948
  },
@@ -854,7 +951,7 @@
854
951
  "fileName": "ApiConfig.ts",
855
952
  "line": 5,
856
953
  "character": 2,
857
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiConfig.ts#L5"
954
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiConfig.ts#L5"
858
955
  }
859
956
  ],
860
957
  "type": {
@@ -879,37 +976,45 @@
879
976
  "fileName": "ApiConfig.ts",
880
977
  "line": 1,
881
978
  "character": 10,
882
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/ApiConfig.ts#L1"
979
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/ApiConfig.ts#L1"
883
980
  }
884
981
  ]
885
982
  },
886
983
  {
887
984
  "id": 44,
888
985
  "name": "getApiStage",
986
+ "variant": "declaration",
889
987
  "kind": 64,
890
- "kindString": "Function",
891
988
  "flags": {},
892
989
  "sources": [
893
990
  {
894
991
  "fileName": "getApiStage.ts",
895
992
  "line": 3,
896
993
  "character": 6,
897
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/getApiStage.ts#L3"
994
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/api/src/getApiStage.ts#L3"
898
995
  }
899
996
  ],
900
997
  "signatures": [
901
998
  {
902
999
  "id": 45,
903
1000
  "name": "getApiStage",
1001
+ "variant": "signature",
904
1002
  "kind": 4096,
905
- "kindString": "Call signature",
906
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
+ ],
907
1012
  "parameters": [
908
1013
  {
909
1014
  "id": 46,
910
1015
  "name": "hostname",
1016
+ "variant": "param",
911
1017
  "kind": 32768,
912
- "kindString": "Parameter",
913
1018
  "flags": {},
914
1019
  "type": {
915
1020
  "type": "intrinsic",
@@ -919,7 +1024,9 @@
919
1024
  ],
920
1025
  "type": {
921
1026
  "type": "reference",
922
- "name": "ApiStage"
1027
+ "target": -1,
1028
+ "name": "ApiStage",
1029
+ "refersToTypeParameter": true
923
1030
  }
924
1031
  }
925
1032
  ]
@@ -952,12 +1059,217 @@
952
1059
  ]
953
1060
  }
954
1061
  ],
955
- "sources": [
1062
+ "packageName": "@xylabs/api",
1063
+ "readme": [
956
1064
  {
957
- "fileName": "index.ts",
958
- "line": 1,
959
- "character": 0,
960
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/api/src/index.ts#L1"
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"
961
1273
  }
962
- ]
1274
+ }
963
1275
  }