@xyo-network/api-models 4.0.3 → 4.1.1

package/dist/neutral/index.d.ts

@@ -0,0 +1,58 @@
+import { AxiosError, AxiosResponse } from '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;
+}
+//# sourceMappingURL=Config.d.ts.map
+
+export type { ApiConfig, ApiEnvelope, ApiEnvelopeBase, ApiEnvelopeError, ApiEnvelopeSuccess, ApiError, ApiReportable, ApiResponse, ApiResponseBody, ApiResponseTuple, ApiResponseTupleOrBody, ApiResponseType, ApiWarning };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/api-models",
-  "version": "4.0.3",
+  "version": "4.1.1",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,19 +21,19 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.ts",
+      "types": "./dist/neutral/index.d.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "dist/neutral/index.mjs",
-  "types": "dist/types/index.d.ts",
+  "types": "dist/neutral/index.d.ts",
   "dependencies": {
     "axios": "^1.10.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^6.5.18",
-    "@xylabs/tsconfig": "^6.5.18",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.23",
+    "@xylabs/tsconfig": "^7.0.0-rc.23",
     "typescript": "^5.8.3"
   },
   "publishConfig": {

package/dist/types/index.d.ts

@@ -1,7 +0,0 @@
-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