@xyo-network/api-models 2.72.9 → 2.73.0

package/dist/index.d.mts

@@ -0,0 +1,57 @@
+import { AxiosError, AxiosResponse } from '@xyo-network/axios';
+
+interface ApiError<T = any, D = any> extends AxiosError<T, D> {
+    isError: true;
+}
+
+type ApiWarning = Error;
+
+interface ApiEnvelopeBase {
+    warning?: ApiWarning[];
+}
+interface ApiEnvelopeSuccess<T> extends ApiEnvelopeBase {
+    data: T;
+    errors: never;
+}
+interface ApiEnvelopeError extends ApiEnvelopeBase {
+    data: never;
+    errors: ApiError[];
+}
+type ApiEnvelope<T> = ApiEnvelopeSuccess<T> | ApiEnvelopeError;
+
+type ApiResponse<T = unknown, D = unknown> = AxiosResponse<T, D>;
+type ApiResponseBody<T> = T | undefined;
+type ApiResponseTuple<T> = [T | undefined, ApiEnvelope<T | undefined>, ApiResponse<ApiEnvelope<T | undefined>>];
+type ApiResponseTupleOrBody<T> = ApiResponseTuple<T> | ApiResponseBody<T>;
+type ApiResponseType = 'body' | 'tuple';
+
+interface ApiReportable {
+    onError?: (error: ApiError, depth: number) => void;
+    onFailure?: (response: ApiResponse, depth: number) => void;
+    onSuccess?: (response: ApiResponse, depth: number) => void;
+}
+
+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 { ApiConfig, ApiEnvelope, ApiEnvelopeBase, ApiEnvelopeError, ApiEnvelopeSuccess, ApiError, ApiReportable, ApiResponse, ApiResponseBody, ApiResponseTuple, ApiResponseTupleOrBody, ApiResponseType, ApiWarning };

package/dist/index.d.ts

@@ -0,0 +1,57 @@
+import { AxiosError, AxiosResponse } from '@xyo-network/axios';
+
+interface ApiError<T = any, D = any> extends AxiosError<T, D> {
+    isError: true;
+}
+
+type ApiWarning = Error;
+
+interface ApiEnvelopeBase {
+    warning?: ApiWarning[];
+}
+interface ApiEnvelopeSuccess<T> extends ApiEnvelopeBase {
+    data: T;
+    errors: never;
+}
+interface ApiEnvelopeError extends ApiEnvelopeBase {
+    data: never;
+    errors: ApiError[];
+}
+type ApiEnvelope<T> = ApiEnvelopeSuccess<T> | ApiEnvelopeError;
+
+type ApiResponse<T = unknown, D = unknown> = AxiosResponse<T, D>;
+type ApiResponseBody<T> = T | undefined;
+type ApiResponseTuple<T> = [T | undefined, ApiEnvelope<T | undefined>, ApiResponse<ApiEnvelope<T | undefined>>];
+type ApiResponseTupleOrBody<T> = ApiResponseTuple<T> | ApiResponseBody<T>;
+type ApiResponseType = 'body' | 'tuple';
+
+interface ApiReportable {
+    onError?: (error: ApiError, depth: number) => void;
+    onFailure?: (response: ApiResponse, depth: number) => void;
+    onSuccess?: (response: ApiResponse, depth: number) => void;
+}
+
+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 { ApiConfig, ApiEnvelope, ApiEnvelopeBase, ApiEnvelopeError, ApiEnvelopeSuccess, ApiError, ApiReportable, ApiResponse, ApiResponseBody, ApiResponseTuple, ApiResponseTupleOrBody, ApiResponseType, ApiWarning };

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+module.exports = __toCommonJS(src_exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +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;","names":[]}

package/dist/index.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -9,35 +9,44 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "dependencies": {
-    "@xyo-network/axios": "~2.72.9"
+    "@xyo-network/axios": "~2.73.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^2.19.3",
-    "@xylabs/tsconfig": "^2.19.3",
+    "@xylabs/ts-scripts-yarn3": "^2.19.5",
+    "@xylabs/tsconfig": "^2.19.5",
+    "publint": "^0.2.2",
+    "tsup": "^7.2.0",
     "typescript": "^5.2.2"
   },
   "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"
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
       },
-      "browser": {
-        "import": "./dist/esm/index.js",
-        "require": "./dist/cjs/index.js"
-      },
-      "default": "./dist/esm/index.js"
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      }
     },
     "./dist/docs.json": {
       "default": "./dist/docs.json"
     },
+    "./cjs": {
+      "default": "./dist/index.js"
+    },
+    "./docs": {
+      "default": "./dist/docs.json"
+    },
+    "./esm": {
+      "default": "./dist/index.mjs"
+    },
     "./package.json": "./package.json"
   },
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "homepage": "https://xyo.network",
   "license": "LGPL-3.0",
   "name": "@xyo-network/api-models",
@@ -48,7 +57,11 @@
     "type": "git",
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
   },
+  "scripts": {
+    "package-compile": "tsup && publint",
+    "package-recompile": "tsup && publint"
+  },
   "sideEffects": false,
-  "types": "dist/types/index.d.ts",
-  "version": "2.72.9"
+  "types": "dist/index.d.ts",
+  "version": "2.73.0"
 }

package/tsup.config.ts

@@ -0,0 +1,16 @@
+import { defineConfig } from 'tsup'
+
+// eslint-disable-next-line import/no-default-export
+export default defineConfig({
+  bundle: true,
+  cjsInterop: true,
+  clean: true,
+  dts: {
+    entry: ['src/index.ts'],
+  },
+  entry: ['src/index.ts'],
+  format: ['cjs', 'esm'],
+  sourcemap: true,
+  splitting: false,
+  tsconfig: 'tsconfig.json',
+})

package/dist/cjs/Config.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Config.js.map

package/dist/cjs/Config.js.map

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

package/dist/cjs/Envelope.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Envelope.js.map

package/dist/cjs/Envelope.js.map

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

package/dist/cjs/Error.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Error.js.map

package/dist/cjs/Error.js.map

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

package/dist/cjs/Reportable.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Reportable.js.map

package/dist/cjs/Reportable.js.map

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

package/dist/cjs/Response.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Response.js.map

package/dist/cjs/Response.js.map

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

package/dist/cjs/Warning.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Warning.js.map

package/dist/cjs/Warning.js.map

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

package/dist/cjs/index.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./Config"), exports);
-tslib_1.__exportStar(require("./Envelope"), exports);
-tslib_1.__exportStar(require("./Error"), exports);
-tslib_1.__exportStar(require("./Reportable"), exports);
-tslib_1.__exportStar(require("./Response"), exports);
-tslib_1.__exportStar(require("./Warning"), exports);
-//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,mDAAwB;AACxB,qDAA0B;AAC1B,kDAAuB;AACvB,uDAA4B;AAC5B,qDAA0B;AAC1B,oDAAyB"}