@xyo-network/api-models 5.3.25 → 5.3.26

package/README.md

@@ -1,23 +1,583 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/api-models
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Primary SDK for using XYO Protocol 2.0
+
+## Install
+
+Using npm:
+
+```sh
+npm install {{name}}
+```
+
+Using yarn:
 
-Version: 5.0.2
+```sh
+yarn add {{name}}
+```
 
-Primary SDK for using XYO Protocol 2.0
+Using pnpm:
 
-## Documentation
+```sh
+pnpm add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__api-models)
+Using bun:
+
+```sh
+bun add {{name}}
+```
 
-Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
+## Reference
+
+### packages
+
+  ### sdk-utils
+
+    ### packages
+
+      ### api-models
+
+        ### .temp-typedoc
+
+          ### interfaces
+
+            ### <a id="ApiConfig"></a>ApiConfig
+
+[**@xyo-network/api-models**](#../README)
+
+***
+
+## Extends
+
+- [`ApiReportable`](#ApiReportable)
+
+## Properties
+
+### apiDomain
+
+```ts
+apiDomain: string;
+```
+
+### Description
+
+The domain where the api is located
+
+***
+
+### apiKey?
+
+```ts
+optional apiKey?: string;
+```
+
+### Description
+
+The apiKey used for authentication
+
+***
+
+### compressionThreshold?
+
+```ts
+optional compressionThreshold?: number;
+```
+
+### Description
+
+Threshold for Content-Size to cause automatic gzip of request body [default = 1024]
+
+***
+
+### jwtToken?
+
+```ts
+optional jwtToken?: string;
+```
+
+### Description
+
+The jwtToken of the currently logged in user
+
+***
+
+### query?
+
+```ts
+optional query?: string;
+```
+
+### Description
+
+The query string, if any, that is added to the end of every request
+
+***
+
+### reportableParent?
+
+```ts
+optional reportableParent?: ApiReportable;
+```
+
+### Description
+
+Parent that should also report events from this api
+
+***
+
+### root?
+
+```ts
+optional root?: string;
+```
+
+### Description
+
+The location in the API tree where this API object is mounted
+
+***
+
+### throwError?
+
+```ts
+optional throwError?: boolean;
+```
+
+### Description
+
+Throw on error
+
+***
+
+### throwFailure?
+
+```ts
+optional throwFailure?: boolean;
+```
+
+### Description
+
+Throw on failures
+
+***
+
+### ~~userid?~~
+
+```ts
+optional userid?: string;
+```
+
+### Deprecated
+
+use the jwtToken instead
+
+***
+
+### onError?
+
+```ts
+optional onError?: (error, depth) => void;
+```
+
+### Parameters
+
+#### error
+
+[`ApiError`](#ApiError)
+
+#### depth
+
+`number`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+[`ApiReportable`](#ApiReportable).[`onError`](ApiReportable.md#onerror)
+
+***
+
+### onFailure?
+
+```ts
+optional onFailure?: (response, depth) => void;
+```
+
+### Parameters
+
+#### response
+
+[`ApiResponse`](#../type-aliases/ApiResponse)
+
+#### depth
+
+`number`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+[`ApiReportable`](#ApiReportable).[`onFailure`](ApiReportable.md#onfailure)
+
+***
+
+### onSuccess?
+
+```ts
+optional onSuccess?: (response, depth) => void;
+```
+
+### Parameters
+
+#### response
+
+[`ApiResponse`](#../type-aliases/ApiResponse)
+
+#### depth
+
+`number`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+[`ApiReportable`](#ApiReportable).[`onSuccess`](ApiReportable.md#onsuccess)
+
+            ### <a id="ApiEnvelopeBase"></a>ApiEnvelopeBase
+
+[**@xyo-network/api-models**](#../README)
+
+***
+
+## Extended by
+
+- [`ApiEnvelopeSuccess`](#ApiEnvelopeSuccess)
+- [`ApiEnvelopeError`](#ApiEnvelopeError)
+
+## Properties
+
+### warning?
+
+```ts
+optional warning?: Error[];
+```
+
+            ### <a id="ApiEnvelopeError"></a>ApiEnvelopeError
+
+[**@xyo-network/api-models**](#../README)
+
+***
+
+## Extends
+
+- [`ApiEnvelopeBase`](#ApiEnvelopeBase)
+
+## Properties
+
+### warning?
+
+```ts
+optional warning?: Error[];
+```
+
+### Inherited from
+
+[`ApiEnvelopeBase`](#ApiEnvelopeBase).[`warning`](ApiEnvelopeBase.md#warning)
+
+***
+
+### data
+
+```ts
+data: never;
+```
+
+***
+
+### errors
+
+```ts
+errors: ApiError<any, any>[];
+```
+
+            ### <a id="ApiEnvelopeSuccess"></a>ApiEnvelopeSuccess
+
+[**@xyo-network/api-models**](#../README)
+
+***
+
+## Extends
+
+- [`ApiEnvelopeBase`](#ApiEnvelopeBase)
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Properties
+
+### warning?
+
+```ts
+optional warning?: Error[];
+```
+
+### Inherited from
+
+[`ApiEnvelopeBase`](#ApiEnvelopeBase).[`warning`](ApiEnvelopeBase.md#warning)
+
+***
+
+### data
+
+```ts
+data: T;
+```
+
+***
+
+### errors
+
+```ts
+errors: never;
+```
+
+            ### <a id="ApiError"></a>ApiError
+
+[**@xyo-network/api-models**](#../README)
+
+***
+
+## Extends
+
+- `AxiosError`\<`T`, `D`\>
+
+## Type Parameters
+
+### T
+
+`T` = `any`
+
+### D
+
+`D` = `any`
+
+## Properties
+
+### isError
+
+```ts
+isError: true;
+```
+
+            ### <a id="ApiReportable"></a>ApiReportable
+
+[**@xyo-network/api-models**](#../README)
+
+***
+
+## Extended by
+
+- [`ApiConfig`](#ApiConfig)
+
+## Properties
+
+### onError?
+
+```ts
+optional onError?: (error, depth) => void;
+```
+
+### Parameters
+
+#### error
+
+[`ApiError`](#ApiError)
+
+#### depth
+
+`number`
+
+### Returns
+
+`void`
+
+***
+
+### onFailure?
+
+```ts
+optional onFailure?: (response, depth) => void;
+```
+
+### Parameters
+
+#### response
+
+[`ApiResponse`](#../type-aliases/ApiResponse)
+
+#### depth
+
+`number`
+
+### Returns
+
+`void`
+
+***
+
+### onSuccess?
+
+```ts
+optional onSuccess?: (response, depth) => void;
+```
+
+### Parameters
+
+#### response
+
+[`ApiResponse`](#../type-aliases/ApiResponse)
+
+#### depth
+
+`number`
+
+### Returns
+
+`void`
+
+          ### type-aliases
+
+            ### <a id="ApiEnvelope"></a>ApiEnvelope
+
+[**@xyo-network/api-models**](#../README)
+
+***
+
+```ts
+type ApiEnvelope<T> = 
+  | ApiEnvelopeSuccess<T>
+  | ApiEnvelopeError;
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+            ### <a id="ApiResponse"></a>ApiResponse
+
+[**@xyo-network/api-models**](#../README)
+
+***
+
+```ts
+type ApiResponse<T, D> = AxiosResponse<T, D>;
+```
+
+## Type Parameters
+
+### T
+
+`T` = `unknown`
+
+### D
+
+`D` = `unknown`
+
+            ### <a id="ApiResponseBody"></a>ApiResponseBody
+
+[**@xyo-network/api-models**](#../README)
+
+***
+
+```ts
+type ApiResponseBody<T> = T | undefined;
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+            ### <a id="ApiResponseTuple"></a>ApiResponseTuple
+
+[**@xyo-network/api-models**](#../README)
+
+***
+
+```ts
+type ApiResponseTuple<T> = [T | undefined, ApiEnvelope<T | undefined>, ApiResponse<ApiEnvelope<T | undefined>>];
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+            ### <a id="ApiResponseTupleOrBody"></a>ApiResponseTupleOrBody
+
+[**@xyo-network/api-models**](#../README)
+
+***
+
+```ts
+type ApiResponseTupleOrBody<T> = 
+  | ApiResponseTuple<T>
+| ApiResponseBody<T>;
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+            ### <a id="ApiResponseType"></a>ApiResponseType
+
+[**@xyo-network/api-models**](#../README)
+
+***
+
+```ts
+type ApiResponseType = "body" | "tuple";
+```
+
+            ### <a id="ApiWarning"></a>ApiWarning
+
+[**@xyo-network/api-models**](#../README)
+
+***
 
-## Credits
+```ts
+type ApiWarning = Error;
+```
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/api-models.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/api-models
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/api-models.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/api-models",
-  "version": "5.3.25",
+  "version": "5.3.26",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -22,11 +22,11 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
+      "import": "./dist/neutral/index.mjs",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
@@ -36,10 +36,10 @@
     "README.md"
   ],
   "devDependencies": {
-    "@types/node": "^25.5.0",
-    "@xylabs/ts-scripts-common": "~7.6.16",
-    "@xylabs/ts-scripts-pnpm": "~7.6.16",
-    "@xylabs/tsconfig": "~7.6.16",
+    "@types/node": "^25.5.2",
+    "@xylabs/ts-scripts-common": "~7.7.5",
+    "@xylabs/ts-scripts-pnpm": "~7.7.5",
+    "@xylabs/tsconfig": "~7.7.5",
     "acorn": "^8.16.0",
     "axios": "^1.14.0",
     "esbuild": "^0.28.0",