@xylabs/api 2.6.14

package/dist/docs.json

@@ -0,0 +1,961 @@
+{
+	"id": 0,
+	"name": "@xylabs/api",
+	"kind": 1,
+	"kindString": "Project",
+	"flags": {},
+	"originalName": "",
+	"children": [
+		{
+			"id": 40,
+			"name": "ApiStage",
+			"kind": 8,
+			"kindString": "Enumeration",
+			"flags": {},
+			"children": [
+				{
+					"id": 41,
+					"name": "Beta",
+					"kind": 16,
+					"kindString": "Enumeration Member",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "ApiStage.ts",
+							"line": 2,
+							"character": 2,
+							"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiStage.ts#L2"
+						}
+					],
+					"type": {
+						"type": "literal",
+						"value": "beta"
+					}
+				},
+				{
+					"id": 42,
+					"name": "Local",
+					"kind": 16,
+					"kindString": "Enumeration Member",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "ApiStage.ts",
+							"line": 3,
+							"character": 2,
+							"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiStage.ts#L3"
+						}
+					],
+					"type": {
+						"type": "literal",
+						"value": "local"
+					}
+				},
+				{
+					"id": 43,
+					"name": "Prod",
+					"kind": 16,
+					"kindString": "Enumeration Member",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "ApiStage.ts",
+							"line": 4,
+							"character": 2,
+							"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiStage.ts#L4"
+						}
+					],
+					"type": {
+						"type": "literal",
+						"value": "prod"
+					}
+				}
+			],
+			"groups": [
+				{
+					"title": "Enumeration Members",
+					"children": [
+						41,
+						42,
+						43
+					]
+				}
+			],
+			"sources": [
+				{
+					"fileName": "ApiStage.ts",
+					"line": 1,
+					"character": 5,
+					"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiStage.ts#L1"
+				}
+			]
+		},
+		{
+			"id": 1,
+			"name": "ApiClient",
+			"kind": 128,
+			"kindString": "Class",
+			"flags": {
+				"isAbstract": true
+			},
+			"children": [
+				{
+					"id": 2,
+					"name": "constructor",
+					"kind": 512,
+					"kindString": "Constructor",
+					"flags": {
+						"isPublic": true
+					},
+					"sources": [
+						{
+							"fileName": "ApiClient.ts",
+							"line": 4,
+							"character": 2,
+							"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiClient.ts#L4"
+						}
+					],
+					"signatures": [
+						{
+							"id": 3,
+							"name": "new ApiClient",
+							"kind": 16384,
+							"kindString": "Constructor signature",
+							"flags": {},
+							"parameters": [
+								{
+									"id": 4,
+									"name": "token",
+									"kind": 32768,
+									"kindString": "Parameter",
+									"flags": {
+										"isOptional": true
+									},
+									"type": {
+										"type": "union",
+										"types": [
+											{
+												"type": "literal",
+												"value": null
+											},
+											{
+												"type": "intrinsic",
+												"name": "string"
+											}
+										]
+									}
+								},
+								{
+									"id": 5,
+									"name": "stage",
+									"kind": 32768,
+									"kindString": "Parameter",
+									"flags": {
+										"isOptional": true
+									},
+									"type": {
+										"type": "reference",
+										"id": 40,
+										"name": "ApiStage"
+									}
+								}
+							],
+							"type": {
+								"type": "reference",
+								"id": 1,
+								"name": "ApiClient"
+							}
+						}
+					]
+				},
+				{
+					"id": 6,
+					"name": "stage",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isProtected": true
+					},
+					"sources": [
+						{
+							"fileName": "ApiClient.ts",
+							"line": 9,
+							"character": 12,
+							"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiClient.ts#L9"
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "string"
+					}
+				},
+				{
+					"id": 7,
+					"name": "token",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isProtected": true,
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "ApiClient.ts",
+							"line": 11,
+							"character": 12,
+							"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiClient.ts#L11"
+						}
+					],
+					"type": {
+						"type": "union",
+						"types": [
+							{
+								"type": "literal",
+								"value": null
+							},
+							{
+								"type": "intrinsic",
+								"name": "string"
+							}
+						]
+					}
+				},
+				{
+					"id": 8,
+					"name": "endPoint",
+					"kind": 2048,
+					"kindString": "Method",
+					"flags": {
+						"isAbstract": true
+					},
+					"sources": [
+						{
+							"fileName": "ApiClient.ts",
+							"line": 13,
+							"character": 11,
+							"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiClient.ts#L13"
+						}
+					],
+					"signatures": [
+						{
+							"id": 9,
+							"name": "endPoint",
+							"kind": 4096,
+							"kindString": "Call signature",
+							"flags": {},
+							"type": {
+								"type": "intrinsic",
+								"name": "string"
+							}
+						}
+					]
+				}
+			],
+			"groups": [
+				{
+					"title": "Constructors",
+					"children": [
+						2
+					]
+				},
+				{
+					"title": "Properties",
+					"children": [
+						6,
+						7
+					]
+				},
+				{
+					"title": "Methods",
+					"children": [
+						8
+					]
+				}
+			],
+			"sources": [
+				{
+					"fileName": "ApiClient.ts",
+					"line": 3,
+					"character": 15,
+					"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiClient.ts#L3"
+				}
+			]
+		},
+		{
+			"id": 15,
+			"name": "ApiEndpoint",
+			"kind": 128,
+			"kindString": "Class",
+			"flags": {},
+			"children": [
+				{
+					"id": 16,
+					"name": "constructor",
+					"kind": 512,
+					"kindString": "Constructor",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "ApiEndpoint.ts",
+							"line": 9,
+							"character": 2,
+							"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiEndpoint.ts#L9"
+						}
+					],
+					"signatures": [
+						{
+							"id": 17,
+							"name": "new ApiEndpoint",
+							"kind": 16384,
+							"kindString": "Constructor signature",
+							"flags": {},
+							"typeParameter": [
+								{
+									"id": 18,
+									"name": "T",
+									"kind": 131072,
+									"kindString": "Type parameter",
+									"flags": {}
+								}
+							],
+							"parameters": [
+								{
+									"id": 19,
+									"name": "config",
+									"kind": 32768,
+									"kindString": "Parameter",
+									"flags": {},
+									"type": {
+										"type": "reference",
+										"id": 10,
+										"name": "ApiConfig"
+									}
+								},
+								{
+									"id": 20,
+									"name": "path",
+									"kind": 32768,
+									"kindString": "Parameter",
+									"flags": {},
+									"type": {
+										"type": "intrinsic",
+										"name": "string"
+									}
+								}
+							],
+							"type": {
+								"type": "reference",
+								"id": 15,
+								"typeArguments": [
+									{
+										"type": "reference",
+										"id": 18,
+										"name": "T"
+									}
+								],
+								"name": "ApiEndpoint"
+							}
+						}
+					]
+				},
+				{
+					"id": 29,
+					"name": "_value",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isPrivate": true,
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "ApiEndpoint.ts",
+							"line": 22,
+							"character": 10,
+							"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiEndpoint.ts#L22"
+						}
+					],
+					"type": {
+						"type": "reference",
+						"id": 18,
+						"name": "T"
+					}
+				},
+				{
+					"id": 21,
+					"name": "config",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isPrivate": true
+					},
+					"sources": [
+						{
+							"fileName": "ApiEndpoint.ts",
+							"line": 6,
+							"character": 10,
+							"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiEndpoint.ts#L6"
+						}
+					],
+					"type": {
+						"type": "reference",
+						"id": 10,
+						"name": "ApiConfig"
+					}
+				},
+				{
+					"id": 22,
+					"name": "path",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isPrivate": true
+					},
+					"sources": [
+						{
+							"fileName": "ApiEndpoint.ts",
+							"line": 7,
+							"character": 10,
+							"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiEndpoint.ts#L7"
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "string"
+					}
+				},
+				{
+					"id": 23,
+					"name": "headers",
+					"kind": 262144,
+					"kindString": "Accessor",
+					"flags": {
+						"isPrivate": true
+					},
+					"sources": [
+						{
+							"fileName": "ApiEndpoint.ts",
+							"line": 14,
+							"character": 14,
+							"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiEndpoint.ts#L14"
+						}
+					],
+					"getSignature": {
+						"id": 24,
+						"name": "headers",
+						"kind": 524288,
+						"kindString": "Get signature",
+						"flags": {},
+						"type": {
+							"type": "union",
+							"types": [
+								{
+									"type": "intrinsic",
+									"name": "undefined"
+								},
+								{
+									"type": "reflection",
+									"declaration": {
+										"id": 25,
+										"name": "__type",
+										"kind": 65536,
+										"kindString": "Type literal",
+										"flags": {},
+										"children": [
+											{
+												"id": 26,
+												"name": "Authorization",
+												"kind": 1024,
+												"kindString": "Property",
+												"flags": {},
+												"sources": [
+													{
+														"fileName": "ApiEndpoint.ts",
+														"line": 15,
+														"character": 36,
+														"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiEndpoint.ts#L15"
+													}
+												],
+												"type": {
+													"type": "intrinsic",
+													"name": "string"
+												},
+												"defaultValue": "..."
+											}
+										],
+										"groups": [
+											{
+												"title": "Properties",
+												"children": [
+													26
+												]
+											}
+										],
+										"sources": [
+											{
+												"fileName": "ApiEndpoint.ts",
+												"line": 15,
+												"character": 34,
+												"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiEndpoint.ts#L15"
+											}
+										]
+									}
+								}
+							]
+						}
+					}
+				},
+				{
+					"id": 27,
+					"name": "url",
+					"kind": 262144,
+					"kindString": "Accessor",
+					"flags": {
+						"isPrivate": true
+					},
+					"sources": [
+						{
+							"fileName": "ApiEndpoint.ts",
+							"line": 18,
+							"character": 14,
+							"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiEndpoint.ts#L18"
+						}
+					],
+					"getSignature": {
+						"id": 28,
+						"name": "url",
+						"kind": 524288,
+						"kindString": "Get signature",
+						"flags": {},
+						"type": {
+							"type": "intrinsic",
+							"name": "string"
+						}
+					}
+				},
+				{
+					"id": 30,
+					"name": "value",
+					"kind": 262144,
+					"kindString": "Accessor",
+					"flags": {
+						"isPublic": true
+					},
+					"sources": [
+						{
+							"fileName": "ApiEndpoint.ts",
+							"line": 24,
+							"character": 13,
+							"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiEndpoint.ts#L24"
+						}
+					],
+					"getSignature": {
+						"id": 31,
+						"name": "value",
+						"kind": 524288,
+						"kindString": "Get signature",
+						"flags": {},
+						"type": {
+							"type": "union",
+							"types": [
+								{
+									"type": "intrinsic",
+									"name": "undefined"
+								},
+								{
+									"type": "reference",
+									"id": 18,
+									"name": "T"
+								}
+							]
+						}
+					}
+				},
+				{
+					"id": 34,
+					"name": "fetch",
+					"kind": 2048,
+					"kindString": "Method",
+					"flags": {
+						"isPublic": true
+					},
+					"sources": [
+						{
+							"fileName": "ApiEndpoint.ts",
+							"line": 32,
+							"character": 15,
+							"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiEndpoint.ts#L32"
+						}
+					],
+					"signatures": [
+						{
+							"id": 35,
+							"name": "fetch",
+							"kind": 4096,
+							"kindString": "Call signature",
+							"flags": {},
+							"type": {
+								"type": "reference",
+								"typeArguments": [
+									{
+										"type": "reference",
+										"id": 18,
+										"name": "T"
+									}
+								],
+								"name": "Promise",
+								"qualifiedName": "Promise",
+								"package": "typescript"
+							}
+						}
+					]
+				},
+				{
+					"id": 32,
+					"name": "get",
+					"kind": 2048,
+					"kindString": "Method",
+					"flags": {
+						"isPublic": true
+					},
+					"sources": [
+						{
+							"fileName": "ApiEndpoint.ts",
+							"line": 28,
+							"character": 15,
+							"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiEndpoint.ts#L28"
+						}
+					],
+					"signatures": [
+						{
+							"id": 33,
+							"name": "get",
+							"kind": 4096,
+							"kindString": "Call signature",
+							"flags": {},
+							"type": {
+								"type": "reference",
+								"typeArguments": [
+									{
+										"type": "union",
+										"types": [
+											{
+												"type": "reference",
+												"id": 18,
+												"name": "T"
+											},
+											{
+												"type": "reference",
+												"typeArguments": [
+													{
+														"type": "reference",
+														"id": 18,
+														"name": "T"
+													}
+												],
+												"name": "NonNullable",
+												"qualifiedName": "NonNullable",
+												"package": "typescript"
+											}
+										]
+									}
+								],
+								"name": "Promise",
+								"qualifiedName": "Promise",
+								"package": "typescript"
+							}
+						}
+					]
+				},
+				{
+					"id": 36,
+					"name": "insert",
+					"kind": 2048,
+					"kindString": "Method",
+					"flags": {
+						"isPublic": true
+					},
+					"sources": [
+						{
+							"fileName": "ApiEndpoint.ts",
+							"line": 42,
+							"character": 15,
+							"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiEndpoint.ts#L42"
+						}
+					],
+					"signatures": [
+						{
+							"id": 37,
+							"name": "insert",
+							"kind": 4096,
+							"kindString": "Call signature",
+							"flags": {},
+							"parameters": [
+								{
+									"id": 38,
+									"name": "value",
+									"kind": 32768,
+									"kindString": "Parameter",
+									"flags": {},
+									"type": {
+										"type": "reference",
+										"id": 18,
+										"name": "T"
+									}
+								}
+							],
+							"type": {
+								"type": "reference",
+								"typeArguments": [
+									{
+										"type": "reference",
+										"id": 18,
+										"name": "T"
+									}
+								],
+								"name": "Promise",
+								"qualifiedName": "Promise",
+								"package": "typescript"
+							}
+						}
+					]
+				}
+			],
+			"groups": [
+				{
+					"title": "Constructors",
+					"children": [
+						16
+					]
+				},
+				{
+					"title": "Properties",
+					"children": [
+						29,
+						21,
+						22
+					]
+				},
+				{
+					"title": "Accessors",
+					"children": [
+						23,
+						27,
+						30
+					]
+				},
+				{
+					"title": "Methods",
+					"children": [
+						34,
+						32,
+						36
+					]
+				}
+			],
+			"sources": [
+				{
+					"fileName": "ApiEndpoint.ts",
+					"line": 5,
+					"character": 6,
+					"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiEndpoint.ts#L5"
+				}
+			],
+			"typeParameters": [
+				{
+					"id": 39,
+					"name": "T",
+					"kind": 131072,
+					"kindString": "Type parameter",
+					"flags": {}
+				}
+			]
+		},
+		{
+			"id": 10,
+			"name": "ApiConfig",
+			"kind": 256,
+			"kindString": "Interface",
+			"flags": {},
+			"children": [
+				{
+					"id": 11,
+					"name": "apiDomain",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "ApiConfig.ts",
+							"line": 2,
+							"character": 2,
+							"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiConfig.ts#L2"
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "string"
+					}
+				},
+				{
+					"id": 14,
+					"name": "apiKey",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "ApiConfig.ts",
+							"line": 5,
+							"character": 2,
+							"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiConfig.ts#L5"
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "string"
+					}
+				},
+				{
+					"id": 13,
+					"name": "jwtToken",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "ApiConfig.ts",
+							"line": 4,
+							"character": 2,
+							"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiConfig.ts#L4"
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "string"
+					}
+				},
+				{
+					"id": 12,
+					"name": "userid",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "ApiConfig.ts",
+							"line": 3,
+							"character": 2,
+							"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiConfig.ts#L3"
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "string"
+					}
+				}
+			],
+			"groups": [
+				{
+					"title": "Properties",
+					"children": [
+						11,
+						14,
+						13,
+						12
+					]
+				}
+			],
+			"sources": [
+				{
+					"fileName": "ApiConfig.ts",
+					"line": 1,
+					"character": 10,
+					"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/ApiConfig.ts#L1"
+				}
+			]
+		},
+		{
+			"id": 44,
+			"name": "getApiStage",
+			"kind": 64,
+			"kindString": "Function",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "getApiStage.ts",
+					"line": 3,
+					"character": 6,
+					"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/getApiStage.ts#L3"
+				}
+			],
+			"signatures": [
+				{
+					"id": 45,
+					"name": "getApiStage",
+					"kind": 4096,
+					"kindString": "Call signature",
+					"flags": {},
+					"parameters": [
+						{
+							"id": 46,
+							"name": "hostname",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {},
+							"type": {
+								"type": "intrinsic",
+								"name": "string"
+							}
+						}
+					],
+					"type": {
+						"type": "reference",
+						"name": "ApiStage"
+					}
+				}
+			]
+		}
+	],
+	"groups": [
+		{
+			"title": "Enumerations",
+			"children": [
+				40
+			]
+		},
+		{
+			"title": "Classes",
+			"children": [
+				1,
+				15
+			]
+		},
+		{
+			"title": "Interfaces",
+			"children": [
+				10
+			]
+		},
+		{
+			"title": "Functions",
+			"children": [
+				44
+			]
+		}
+	],
+	"sources": [
+		{
+			"fileName": "index.ts",
+			"line": 1,
+			"character": 0,
+			"url": "https://github.com/xylabs/sdk-js/blob/d374ec6/packages/api/src/index.ts#L1"
+		}
+	]
+}