@xyo-network/api-models 7.0.12 → 7.0.14

package/README.md

@@ -1,3 +1,49 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/api-models
 
-Deprecated compatibility stub. Use `@xyo-network/sdk-protocol/api-models` instead.
+[![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:
+
+```sh
+yarn add {{name}}
+```
+
+Using pnpm:
+
+```sh
+pnpm add {{name}}
+```
+
+Using bun:
+
+```sh
+bun add {{name}}
+```
+
+
+## License
+
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
+## Credits
+
+[Made with 🔥 and ❄️ by XYO Foundation](https://xyo.network)
+
+[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
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png

package/dist/neutral/Config.d.ts

@@ -0,0 +1,25 @@
+import type { ApiReportable } from './Reportable.ts';
+interface ApiConfig extends ApiReportable {
+    /** @description The domain where the API is located */
+    apiDomain: string;
+    /** @description The apiKey used for authentication */
+    apiKey?: string;
+    /** @description Threshold for Content-Size to cause automatic gzip of request body [default = 1024] */
+    compressionThreshold?: number;
+    /** @description The jwtToken of the currently logged in user */
+    jwtToken?: string;
+    /** @description The query string, if any, that is added to the end of every request */
+    query?: string;
+    /** @description Parent that should also report events from this API */
+    reportableParent?: ApiReportable;
+    /** @description The location in the API tree where this API object is mounted */
+    root?: string;
+    /** @description Throw on error */
+    throwError?: boolean;
+    /** @description Throw on failures */
+    throwFailure?: boolean;
+    /** @deprecated use the jwtToken instead */
+    userid?: string;
+}
+export type { ApiConfig };
+//# sourceMappingURL=Config.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAEpD,UAAU,SAAU,SAAQ,aAAa;IACvC,uDAAuD;IACvD,SAAS,EAAE,MAAM,CAAA;IAEjB,sDAAsD;IACtD,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,uGAAuG;IACvG,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAE7B,gEAAgE;IAChE,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB,uFAAuF;IACvF,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd,uEAAuE;IACvE,gBAAgB,CAAC,EAAE,aAAa,CAAA;IAEhC,iFAAiF;IACjF,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,kCAAkC;IAClC,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB,qCAAqC;IACrC,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB,2CAA2C;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,YAAY,EAAE,SAAS,EAAE,CAAA"}

package/dist/neutral/Envelope.d.ts

@@ -0,0 +1,15 @@
+import type { ApiError } from './Error.ts';
+import type { ApiWarning } from './Warning.ts';
+export interface ApiEnvelopeBase {
+    warning?: ApiWarning[];
+}
+export interface ApiEnvelopeSuccess<T> extends ApiEnvelopeBase {
+    data: T;
+    errors: never;
+}
+export interface ApiEnvelopeError extends ApiEnvelopeBase {
+    data: never;
+    errors: ApiError[];
+}
+export type ApiEnvelope<T> = ApiEnvelopeSuccess<T> | ApiEnvelopeError;
+//# sourceMappingURL=Envelope.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Envelope.d.ts","sourceRoot":"","sources":["../../src/Envelope.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAC1C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAE9C,MAAM,WAAW,eAAe;IAC9B,OAAO,CAAC,EAAE,UAAU,EAAE,CAAA;CACvB;AAED,MAAM,WAAW,kBAAkB,CAAC,CAAC,CAAE,SAAQ,eAAe;IAC5D,IAAI,EAAE,CAAC,CAAA;IACP,MAAM,EAAE,KAAK,CAAA;CACd;AAED,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,IAAI,EAAE,KAAK,CAAA;IACX,MAAM,EAAE,QAAQ,EAAE,CAAA;CACnB;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAA"}

package/dist/neutral/Error.d.ts

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

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

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

package/dist/neutral/Reportable.d.ts

@@ -0,0 +1,8 @@
+import type { ApiError } from './Error.ts';
+import type { ApiResponse } from './Response.ts';
+export interface ApiReportable {
+    onError?: (error: ApiError, depth: number) => void;
+    onFailure?: (response: ApiResponse, depth: number) => void;
+    onSuccess?: (response: ApiResponse, depth: number) => void;
+}
+//# sourceMappingURL=Reportable.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Reportable.d.ts","sourceRoot":"","sources":["../../src/Reportable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAC1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAEhD,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IAElD,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IAE1D,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;CAC3D"}

package/dist/neutral/Response.d.ts

@@ -0,0 +1,8 @@
+import type { FetchJsonResponse } from '@ariestools/sdk';
+import type { ApiEnvelope } from './Envelope.ts';
+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>;
+export type ApiResponseType = 'body' | 'tuple';
+//# sourceMappingURL=Response.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Response.d.ts","sourceRoot":"","sources":["../../src/Response.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AAExD,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/dist/neutral/Warning.d.ts

@@ -0,0 +1,2 @@
+export type ApiWarning = Error;
+//# sourceMappingURL=Warning.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Warning.d.ts","sourceRoot":"","sources":["../../src/Warning.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG,KAAK,CAAA"}

package/dist/neutral/index.d.ts

@@ -1,6 +1,7 @@
-/**
- * @deprecated Use `@xyo-network/sdk-protocol/api-models` instead.
- * `@xyo-network/api-models` is a backward-compatibility re-export stub.
- */
-export * from '@xyo-network/sdk-protocol/api-models';
+export * from './Config.ts';
+export * from './Envelope.ts';
+export * from './Error.ts';
+export * from './Reportable.ts';
+export * from './Response.ts';
+export * from './Warning.ts';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,cAAc,sCAAsC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA;AAC7B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA"}

package/dist/neutral/index.mjs

@@ -1,3 +1 @@
-// src/index.ts
-export * from "@xyo-network/sdk-protocol/api-models";
 //# sourceMappingURL=index.mjs.map

package/dist/neutral/index.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
-  "sources": ["../../src/index.ts"],
-  "sourcesContent": ["/**\n * @deprecated Use `@xyo-network/sdk-protocol/api-models` instead.\n * `@xyo-network/api-models` is a backward-compatibility re-export stub.\n */\nexport * from '@xyo-network/sdk-protocol/api-models'\n"],
-  "mappings": ";AAIA,cAAc;",
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
   "names": []
 }

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@xyo-network/api-models",
-  "version": "7.0.12",
-  "description": "DEPRECATED - use @xyo-network/sdk-protocol/api-models. Backward-compatibility re-export stub for @xyo-network/api-models.",
-  "deprecated": "Use @xyo-network/sdk-protocol/api-models instead. @xyo-network/api-models is a backward-compatibility re-export stub and will not receive further updates.",
+  "version": "7.0.14",
+  "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
     "url": "git+https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues",
@@ -34,35 +33,24 @@
     "!**/*.test.*",
     "README.md"
   ],
-  "dependencies": {
-    "@xyo-network/sdk-protocol": "~7.0.12"
-  },
   "devDependencies": {
-    "@xylabs/toolchain": "~8.5.15",
-    "@xylabs/tsconfig": "~8.5.15",
-    "browserslist": "4.28.4",
-    "eslint": "^10.6.0",
-    "eslint-import-resolver-typescript": "^4.4.5",
-    "typescript": "~6.0.3"
+    "@ariestools/sdk": "~8.0.2",
+    "@opentelemetry/api": "~1.9.1",
+    "@opentelemetry/sdk-trace-base": "~2.9.0",
+    "@xylabs/toolchain": "~8.6.3",
+    "@xylabs/tsconfig": "~8.6.3",
+    "async-mutex": "~0.5.0",
+    "eslint": "~10.6.0",
+    "eslint-import-resolver-typescript": "~4.4.5",
+    "typescript": "~6.0.3",
+    "zod": "~4.4.3"
   },
   "peerDependencies": {
-    "@ariestools/sdk": "^7.0.4",
-    "@bitauth/libauth": "~3.0",
-    "@noble/post-quantum": "~0.6.1",
-    "@opentelemetry/api": "^1.9",
-    "@opentelemetry/sdk-trace-base": "^2.7",
-    "@scure/base": "~2.2",
-    "@scure/bip39": "~2.2",
-    "@xylabs/geo": "^7.0",
-    "@xylabs/threads": "^7.0",
-    "ajv": "^8.20",
-    "async-mutex": "^0.5",
-    "debug": "^4.4",
-    "ethers": "^6.16",
-    "hash-wasm": "~4.12",
-    "idb": "^8.0",
-    "observable-fns": "^0.6",
-    "zod": "^4.4"
+    "@ariestools/sdk": "^8.0.2",
+    "@opentelemetry/api": "^1.9.1",
+    "@opentelemetry/sdk-trace-base": "^2.9.0",
+    "async-mutex": "^0.5.0",
+    "zod": "^4.4.3"
   },
   "engines": {
     "node": "^24"