@xyo-network/api-models 2.75.0 → 2.75.1

package/dist/node/Config.d.cts

@@ -0,0 +1,25 @@
+import { ApiReportable } from './Reportable';
+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/node/Config.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAE5C,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,0CAA0C;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,YAAY,EAAE,SAAS,EAAE,CAAA"}

package/dist/node/Config.js

@@ -12,6 +12,8 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/Config.ts
 var Config_exports = {};
 module.exports = __toCommonJS(Config_exports);
 //# sourceMappingURL=Config.js.map

package/dist/node/Config.js.map

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

package/dist/node/Envelope.d.cts

@@ -0,0 +1,15 @@
+import { ApiError } from './Error';
+import { ApiWarning } from './Warning';
+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/node/Envelope.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Envelope.d.ts","sourceRoot":"","sources":["../../src/Envelope.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAEtC,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/node/Envelope.js

@@ -12,6 +12,8 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/Envelope.ts
 var Envelope_exports = {};
 module.exports = __toCommonJS(Envelope_exports);
 //# sourceMappingURL=Envelope.js.map

package/dist/node/Envelope.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Envelope.ts"],"sourcesContent":["import { ApiError } from './Error'\nimport { ApiWarning } from './Warning'\n\nexport interface ApiEnvelopeBase {\n  warning?: ApiWarning[]\n}\n\nexport interface ApiEnvelopeSuccess<T> extends ApiEnvelopeBase {\n  data: T\n  errors: never\n}\n\nexport interface ApiEnvelopeError extends ApiEnvelopeBase {\n  data: never\n  errors: ApiError[]\n}\n\nexport type ApiEnvelope<T> = ApiEnvelopeSuccess<T> | ApiEnvelopeError\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../src/Envelope.ts"],"sourcesContent":["import { ApiError } from './Error'\nimport { ApiWarning } from './Warning'\n\nexport interface ApiEnvelopeBase {\n  warning?: ApiWarning[]\n}\n\nexport interface ApiEnvelopeSuccess<T> extends ApiEnvelopeBase {\n  data: T\n  errors: never\n}\n\nexport interface ApiEnvelopeError extends ApiEnvelopeBase {\n  data: never\n  errors: ApiError[]\n}\n\nexport type ApiEnvelope<T> = ApiEnvelopeSuccess<T> | ApiEnvelopeError\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/node/Error.d.cts

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

package/dist/node/Error.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Error.d.ts","sourceRoot":"","sources":["../../src/Error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAG/C,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"}

package/dist/node/Error.js

@@ -12,6 +12,8 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/Error.ts
 var Error_exports = {};
 module.exports = __toCommonJS(Error_exports);
 //# sourceMappingURL=Error.js.map

package/dist/node/Error.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Error.ts"],"sourcesContent":["import { AxiosError } from '@xyo-network/axios'\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport interface ApiError<T = any, D = any> extends AxiosError<T, D> {\n  isError: true\n}\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../src/Error.ts"],"sourcesContent":["import { AxiosError } from '@xyo-network/axios'\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport interface ApiError<T = any, D = any> extends AxiosError<T, D> {\n  isError: true\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/node/Reportable.d.cts

@@ -0,0 +1,8 @@
+import { ApiError } from './Error';
+import { ApiResponse } from './Response';
+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/node/Reportable.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Reportable.d.ts","sourceRoot":"","sources":["../../src/Reportable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAClC,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAExC,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/node/Reportable.js

@@ -12,6 +12,8 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/Reportable.ts
 var Reportable_exports = {};
 module.exports = __toCommonJS(Reportable_exports);
 //# sourceMappingURL=Reportable.js.map

package/dist/node/Reportable.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Reportable.ts"],"sourcesContent":["import { ApiError } from './Error'\nimport { ApiResponse } from './Response'\n\nexport interface ApiReportable {\n  onError?: (error: ApiError, depth: number) => void\n\n  onFailure?: (response: ApiResponse, depth: number) => void\n\n  onSuccess?: (response: ApiResponse, depth: number) => void\n}\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../src/Reportable.ts"],"sourcesContent":["import { ApiError } from './Error'\nimport { ApiResponse } from './Response'\n\nexport interface ApiReportable {\n  onError?: (error: ApiError, depth: number) => void\n\n  onFailure?: (response: ApiResponse, depth: number) => void\n\n  onSuccess?: (response: ApiResponse, depth: number) => void\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/node/Response.d.cts

@@ -0,0 +1,8 @@
+import { AxiosResponse } from '@xyo-network/axios';
+import { ApiEnvelope } from './Envelope';
+export type ApiResponse<T = unknown, D = unknown> = AxiosResponse<T, D>;
+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/node/Response.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Response.d.ts","sourceRoot":"","sources":["../../src/Response.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAElD,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAExC,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"}

package/dist/node/Response.js

@@ -12,6 +12,8 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/Response.ts
 var Response_exports = {};
 module.exports = __toCommonJS(Response_exports);
 //# sourceMappingURL=Response.js.map

package/dist/node/Response.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Response.ts"],"sourcesContent":["import { AxiosResponse } from '@xyo-network/axios'\n\nimport { ApiEnvelope } from './Envelope'\n\nexport type ApiResponse<T = unknown, D = unknown> = AxiosResponse<T, D>\n\nexport type ApiResponseBody<T> = T | undefined\n\nexport type ApiResponseTuple<T> = [T | undefined, ApiEnvelope<T | undefined>, ApiResponse<ApiEnvelope<T | undefined>>]\n\nexport type ApiResponseTupleOrBody<T> = ApiResponseTuple<T> | ApiResponseBody<T>\n\nexport type ApiResponseType = 'body' | 'tuple'\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../src/Response.ts"],"sourcesContent":["import { AxiosResponse } from '@xyo-network/axios'\n\nimport { ApiEnvelope } from './Envelope'\n\nexport type ApiResponse<T = unknown, D = unknown> = AxiosResponse<T, D>\n\nexport type ApiResponseBody<T> = T | undefined\n\nexport type ApiResponseTuple<T> = [T | undefined, ApiEnvelope<T | undefined>, ApiResponse<ApiEnvelope<T | undefined>>]\n\nexport type ApiResponseTupleOrBody<T> = ApiResponseTuple<T> | ApiResponseBody<T>\n\nexport type ApiResponseType = 'body' | 'tuple'\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/node/Warning.d.cts

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

package/dist/node/Warning.d.cts.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/node/Warning.js

@@ -12,6 +12,8 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/Warning.ts
 var Warning_exports = {};
 module.exports = __toCommonJS(Warning_exports);
 //# sourceMappingURL=Warning.js.map

package/dist/node/Warning.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Warning.ts"],"sourcesContent":["export type ApiWarning = Error\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../src/Warning.ts"],"sourcesContent":["export type ApiWarning = Error\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/node/index.d.cts

@@ -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/node/index.d.cts.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/node/index.js

@@ -11,23 +11,9 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
-var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
 var src_exports = {};
 module.exports = __toCommonJS(src_exports);
-__reExport(src_exports, require("./Config"), module.exports);
-__reExport(src_exports, require("./Envelope"), module.exports);
-__reExport(src_exports, require("./Error"), module.exports);
-__reExport(src_exports, require("./Reportable"), module.exports);
-__reExport(src_exports, require("./Response"), module.exports);
-__reExport(src_exports, require("./Warning"), module.exports);
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  ...require("./Config"),
-  ...require("./Envelope"),
-  ...require("./Error"),
-  ...require("./Reportable"),
-  ...require("./Response"),
-  ...require("./Warning")
-});
 //# sourceMappingURL=index.js.map

package/dist/node/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from './Config'\nexport * from './Envelope'\nexport * from './Error'\nexport * from './Reportable'\nexport * from './Response'\nexport * from './Warning'\n"],"mappings":";;;;;;;;;;;;;;;AAAA;AAAA;AAAA,wBAAc,qBAAd;AACA,wBAAc,uBADd;AAEA,wBAAc,oBAFd;AAGA,wBAAc,yBAHd;AAIA,wBAAc,uBAJd;AAKA,wBAAc,sBALd;","names":[]}
+{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from './Config'\nexport * from './Envelope'\nexport * from './Error'\nexport * from './Reportable'\nexport * from './Response'\nexport * from './Warning'\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/node/index.mjs

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

package/dist/node/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from './Config'\nexport * from './Envelope'\nexport * from './Error'\nexport * from './Reportable'\nexport * from './Response'\nexport * from './Warning'\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -9,11 +9,11 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "dependencies": {
-    "@xyo-network/axios": "~2.75.0"
+    "@xyo-network/axios": "~2.75.1"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^3.0.70",
-    "@xylabs/tsconfig": "^3.0.70",
+    "@xylabs/ts-scripts-yarn3": "^3.0.77",
+    "@xylabs/tsconfig": "^3.0.77",
     "typescript": "^5.2.2"
   },
   "description": "Primary SDK for using XYO Protocol 2.0",
@@ -22,7 +22,7 @@
     ".": {
       "browser": {
         "require": {
-          "types": "./dist/browser/index.d.ts",
+          "types": "./dist/browser/index.d.cts",
           "default": "./dist/browser/index.cjs"
         },
         "import": {
@@ -60,5 +60,5 @@
   },
   "sideEffects": false,
   "types": "dist/node/index.d.ts",
-  "version": "2.75.0"
+  "version": "2.75.1"
 }