@xyo-network/api-models 5.3.29 → 5.4.0

package/README.md

@@ -38,542 +38,6 @@ bun add {{name}}
 
 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)
-
-***
-
-```ts
-type ApiWarning = Error;
-```
 
 
 [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png

package/dist/neutral/Error.d.ts

@@ -1,5 +1,5 @@
-import type { AxiosError } from 'axios';
-export interface ApiError<T = any, D = any> extends AxiosError<T, D> {
+import type { FetchClientError } from '@xylabs/sdk-js';
+export interface ApiError<T = unknown> extends FetchClientError<T> {
     isError: true;
 }
 //# sourceMappingURL=Error.d.ts.map

package/dist/neutral/Error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Error.d.ts","sourceRoot":"","sources":["../../src/Error.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,OAAO,CAAA;AAGvC,MAAM,WAAW,QAAQ,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,CAAE,SAAQ,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC;IAClE,OAAO,EAAE,IAAI,CAAA;CACd"}
+{"version":3,"file":"Error.d.ts","sourceRoot":"","sources":["../../src/Error.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAEtD,MAAM,WAAW,QAAQ,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,gBAAgB,CAAC,CAAC,CAAC;IAChE,OAAO,EAAE,IAAI,CAAA;CACd"}

package/dist/neutral/Response.d.ts

@@ -1,6 +1,6 @@
-import type { AxiosResponse } from 'axios';
+import type { FetchJsonResponse } from '@xylabs/sdk-js';
 import type { ApiEnvelope } from './Envelope.ts';
-export type ApiResponse<T = unknown, D = unknown> = AxiosResponse<T, D>;
+export type ApiResponse<T = unknown> = FetchJsonResponse<T>;
 export type ApiResponseBody<T> = T | undefined;
 export type ApiResponseTuple<T> = [T | undefined, ApiEnvelope<T | undefined>, ApiResponse<ApiEnvelope<T | undefined>>];
 export type ApiResponseTupleOrBody<T> = ApiResponseTuple<T> | ApiResponseBody<T>;

package/dist/neutral/Response.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Response.d.ts","sourceRoot":"","sources":["../../src/Response.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAE1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAEhD,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,IAAI,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AAEvE,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,GAAG,SAAS,CAAA;AAE9C,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,SAAS,EAAE,WAAW,CAAC,CAAC,GAAG,SAAS,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;AAEtH,MAAM,MAAM,sBAAsB,CAAC,CAAC,IAAI,gBAAgB,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAA;AAEhF,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,OAAO,CAAA"}
+{"version":3,"file":"Response.d.ts","sourceRoot":"","sources":["../../src/Response.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AAEvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAEhD,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAA;AAE3D,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,GAAG,SAAS,CAAA;AAE9C,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,SAAS,EAAE,WAAW,CAAC,CAAC,GAAG,SAAS,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;AAEtH,MAAM,MAAM,sBAAsB,CAAC,CAAC,IAAI,gBAAgB,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAA;AAEhF,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,OAAO,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/api-models",
-  "version": "5.3.29",
+  "version": "5.4.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -22,12 +22,10 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
-      "import": "./dist/neutral/index.mjs",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
     "!**/*.bench.*",
@@ -36,14 +34,16 @@
     "README.md"
   ],
   "devDependencies": {
-    "@xylabs/ts-scripts-common": "~7.8.4",
-    "@xylabs/ts-scripts-pnpm": "~7.8.4",
-    "@xylabs/tsconfig": "~7.8.4",
-    "axios": "^1.14.0",
-    "typescript": "~5.9.3"
+    "@opentelemetry/api": "^1.9.1",
+    "@xylabs/sdk-js": "^5.0.96",
+    "@xylabs/toolchain": "~7.10.8",
+    "@xylabs/tsconfig": "~7.10.8",
+    "pako": "~2.1.0",
+    "typescript": "~5.9.3",
+    "zod": "^4.3.6"
   },
   "peerDependencies": {
-    "axios": "^1"
+    "@xylabs/sdk-js": "^5.0.96"
   },
   "publishConfig": {
     "access": "public"