@xyo-network/api-models 2.39.0-rc.5

package/dist/esm/Config.d.ts

@@ -0,0 +1,25 @@
+import { XyoApiReportable } from './Reportable';
+interface XyoApiConfig extends XyoApiReportable {
+    /** @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?: XyoApiReportable;
+    /** @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 { XyoApiConfig };
+//# sourceMappingURL=Config.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAE/C,UAAU,YAAa,SAAQ,gBAAgB;IAC7C,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,gBAAgB,CAAA;IAEnC,iFAAiF;IACjF,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,kCAAkC;IAClC,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB,qCAAqC;IACrC,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB,0CAA0C;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,YAAY,EAAE,YAAY,EAAE,CAAA"}

package/dist/esm/Config.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Config.js.map

package/dist/esm/Config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Config.js","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":""}

package/dist/esm/Envelope.d.ts

@@ -0,0 +1,15 @@
+import { XyoApiError } from './Error';
+import { XyoApiWarning } from './Warning';
+export interface XyoApiEnvelopeBase {
+    warning?: XyoApiWarning[];
+}
+export interface XyoApiEnvelopeSuccess<T> extends XyoApiEnvelopeBase {
+    data: T;
+    error: never;
+}
+export interface XyoApiEnvelopeError extends XyoApiEnvelopeBase {
+    data: never;
+    error: XyoApiError[];
+}
+export declare type XyoApiEnvelope<T> = XyoApiEnvelopeSuccess<T> | XyoApiEnvelopeError;
+//# sourceMappingURL=Envelope.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Envelope.d.ts","sourceRoot":"","sources":["../../src/Envelope.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AAEzC,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,aAAa,EAAE,CAAA;CAC1B;AAED,MAAM,WAAW,qBAAqB,CAAC,CAAC,CAAE,SAAQ,kBAAkB;IAClE,IAAI,EAAE,CAAC,CAAA;IACP,KAAK,EAAE,KAAK,CAAA;CACb;AAED,MAAM,WAAW,mBAAoB,SAAQ,kBAAkB;IAC7D,IAAI,EAAE,KAAK,CAAA;IACX,KAAK,EAAE,WAAW,EAAE,CAAA;CACrB;AAED,oBAAY,cAAc,CAAC,CAAC,IAAI,qBAAqB,CAAC,CAAC,CAAC,GAAG,mBAAmB,CAAA"}

package/dist/esm/Envelope.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Envelope.js.map

package/dist/esm/Envelope.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Envelope.js","sourceRoot":"","sources":["../../src/Envelope.ts"],"names":[],"mappings":""}

package/dist/esm/Error.d.ts

@@ -0,0 +1,5 @@
+import { AxiosError } from 'axios';
+export interface XyoApiError<T = any, D = any> extends AxiosError<T, D> {
+    isXyoError: true;
+}
+//# sourceMappingURL=Error.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Error.d.ts","sourceRoot":"","sources":["../../src/Error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAA;AAGlC,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,CAAE,SAAQ,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC;IACrE,UAAU,EAAE,IAAI,CAAA;CACjB"}

package/dist/esm/Error.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Error.js.map

package/dist/esm/Error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Error.js","sourceRoot":"","sources":["../../src/Error.ts"],"names":[],"mappings":""}

package/dist/esm/Reportable.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"Reportable.d.ts","sourceRoot":"","sources":["../../src/Reportable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAE3C,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IAErD,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IAE7D,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;CAC9D"}

package/dist/esm/Reportable.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Reportable.js.map

package/dist/esm/Reportable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Reportable.js","sourceRoot":"","sources":["../../src/Reportable.ts"],"names":[],"mappings":""}

package/dist/esm/Response.d.ts

@@ -0,0 +1,8 @@
+import { AxiosResponse } from 'axios';
+import { XyoApiEnvelope } from './Envelope';
+export declare type XyoApiResponse<T = unknown, D = unknown> = AxiosResponse<T, D>;
+export declare type XyoApiResponseBody<T> = T | undefined;
+export declare type XyoApiResponseTuple<T> = [T | undefined, XyoApiEnvelope<T | undefined>, XyoApiResponse<XyoApiEnvelope<T | undefined>>];
+export declare type XyoApiResponseTupleOrBody<T> = XyoApiResponseTuple<T> | XyoApiResponseBody<T>;
+export declare type XyoApiResponseType = 'body' | 'tuple';
+//# sourceMappingURL=Response.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Response.d.ts","sourceRoot":"","sources":["../../src/Response.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAErC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAE3C,oBAAY,cAAc,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,IAAI,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AAE1E,oBAAY,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,SAAS,CAAA;AAEjD,oBAAY,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,SAAS,EAAE,cAAc,CAAC,CAAC,GAAG,SAAS,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;AAElI,oBAAY,yBAAyB,CAAC,CAAC,IAAI,mBAAmB,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAA;AAEzF,oBAAY,kBAAkB,GAAG,MAAM,GAAG,OAAO,CAAA"}

package/dist/esm/Response.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Response.js.map

package/dist/esm/Response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Response.js","sourceRoot":"","sources":["../../src/Response.ts"],"names":[],"mappings":""}

package/dist/esm/Warning.d.ts

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

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

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

package/dist/esm/Warning.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Warning.js.map

package/dist/esm/Warning.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Warning.js","sourceRoot":"","sources":["../../src/Warning.ts"],"names":[],"mappings":""}

package/dist/esm/index.d.ts

@@ -0,0 +1,7 @@
+export * from './Config';
+export * from './Envelope';
+export * from './Error';
+export * from './Reportable';
+export * from './Response';
+export * from './Warning';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,SAAS,CAAA;AACvB,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA"}

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+export * from './Config';
+export * from './Envelope';
+export * from './Error';
+export * from './Reportable';
+export * from './Response';
+export * from './Warning';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,SAAS,CAAA;AACvB,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA"}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+  },
+  "dependencies": {
+    "tslib": "^2.4.1"
+  },
+  "peerDependencies": {
+    "axios": "^1.1.3"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "browser": "dist/esm/index.js",
+  "docs": "dist/docs.json",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "browser": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "default": "./dist/esm/index.js"
+    },
+    "./dist/docs.json": {
+      "default": "./dist/docs.json"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0-only",
+  "name": "@xyo-network/api-models",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "types": "dist/esm/index.d.ts",
+  "version": "2.39.0-rc.5",
+  "stableVersion": "2.38.8"
+}

package/src/Config.ts

@@ -0,0 +1,35 @@
+import { XyoApiReportable } from './Reportable'
+
+interface XyoApiConfig extends XyoApiReportable {
+  /** @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?: XyoApiReportable
+
+  /** @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 { XyoApiConfig }

package/src/Envelope.ts

@@ -0,0 +1,18 @@
+import { XyoApiError } from './Error'
+import { XyoApiWarning } from './Warning'
+
+export interface XyoApiEnvelopeBase {
+  warning?: XyoApiWarning[]
+}
+
+export interface XyoApiEnvelopeSuccess<T> extends XyoApiEnvelopeBase {
+  data: T
+  error: never
+}
+
+export interface XyoApiEnvelopeError extends XyoApiEnvelopeBase {
+  data: never
+  error: XyoApiError[]
+}
+
+export type XyoApiEnvelope<T> = XyoApiEnvelopeSuccess<T> | XyoApiEnvelopeError

package/src/Error.ts

@@ -0,0 +1,6 @@
+import { AxiosError } from 'axios'
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export interface XyoApiError<T = any, D = any> extends AxiosError<T, D> {
+  isXyoError: true
+}

package/src/Reportable.ts

@@ -0,0 +1,10 @@
+import { XyoApiError } from './Error'
+import { XyoApiResponse } from './Response'
+
+export interface XyoApiReportable {
+  onError?: (error: XyoApiError, depth: number) => void
+
+  onFailure?: (response: XyoApiResponse, depth: number) => void
+
+  onSuccess?: (response: XyoApiResponse, depth: number) => void
+}

package/src/Response.ts

@@ -0,0 +1,13 @@
+import { AxiosResponse } from 'axios'
+
+import { XyoApiEnvelope } from './Envelope'
+
+export type XyoApiResponse<T = unknown, D = unknown> = AxiosResponse<T, D>
+
+export type XyoApiResponseBody<T> = T | undefined
+
+export type XyoApiResponseTuple<T> = [T | undefined, XyoApiEnvelope<T | undefined>, XyoApiResponse<XyoApiEnvelope<T | undefined>>]
+
+export type XyoApiResponseTupleOrBody<T> = XyoApiResponseTuple<T> | XyoApiResponseBody<T>
+
+export type XyoApiResponseType = 'body' | 'tuple'

package/src/Warning.ts

@@ -0,0 +1 @@
+export type XyoApiWarning = Error

package/src/index.ts

@@ -0,0 +1,6 @@
+export * from './Config'
+export * from './Envelope'
+export * from './Error'
+export * from './Reportable'
+export * from './Response'
+export * from './Warning'

package/typedoc.json

@@ -0,0 +1,11 @@
+{
+  "intentionallyNotExported": [
+    "WithXyoPayloadMeta",
+    "XyoPayload",
+    "XyoPayloadFull",
+    "XyoBoundWitness",
+    "XyoDataLike",
+    "Huri",
+    "XyoSchemaPayload"
+  ]
+}