api-def 0.6.2-alpha.1 → 0.6.2-alpha.2

package/cjs/RequestContext.d.ts

@@ -34,4 +34,5 @@ export default class RequestContext<R = any, P extends Params | undefined = Para
     triggerEvent(eventType: RequestEvent): Promise<EventResult<R> | undefined>;
     addCanceller(canceler: () => void): void;
     cancel(): void;
+    getRequestUrl(): URL;
 }

package/cjs/RequestContext.js

@@ -191,6 +191,38 @@ var RequestContext = /** @class */ (function () {
             this.canceler();
         }
     };
+    RequestContext.prototype.getRequestUrl = function () {
+        var _a;
+        var path = !this.baseUrl.endsWith("/")
+            ? this.baseUrl + "/"
+            : this.baseUrl;
+        path += this.computedPath.startsWith("/")
+            ? this.computedPath.substring(1)
+            : this.computedPath;
+        var origin = undefined;
+        if (typeof window !== "undefined") {
+            origin = window.origin;
+        }
+        if (!origin) {
+            if (path.indexOf("://") === -1) {
+                path = "https://".concat(path);
+            }
+        }
+        var url = new URL(path, origin);
+        if (this.computedConfig.query) {
+            if (this.computedConfig.queryParser) {
+                url.search = this.computedConfig.queryParser(this.computedConfig.query);
+            }
+            else {
+                var queryKeys = Object.keys(this.computedConfig.query);
+                for (var i = 0; i < queryKeys.length; i++) {
+                    var key = queryKeys[i];
+                    url.searchParams.append(key, ((_a = this.computedConfig.query[key]) === null || _a === void 0 ? void 0 : _a.toString()) || "");
+                }
+            }
+        }
+        return url;
+    };
     return RequestContext;
 }());
 exports.default = RequestContext;

package/cjs/RequestError.d.ts

@@ -1,5 +1,6 @@
 import { ApiResponse } from "./ApiTypes";
 import { EnumOf } from "./Utils";
+import RequestContext from "./RequestContext";
 export declare const RequestErrorCode: {
     readonly MISC_UNKNOWN_ERROR: "misc/unknown-error";
     readonly REQUEST_NETWORK_ERROR: "request/network-error";
@@ -17,6 +18,7 @@ export declare const isRequestError: (error: Error) => error is RequestError;
 export interface RequestErrorConfig {
     error: Error;
     code: string;
+    context: RequestContext;
     response?: ApiResponse | null;
 }
 export declare const convertToRequestError: (config: RequestErrorConfig) => RequestError;

package/cjs/RequestError.js

@@ -13,15 +13,21 @@ var isRequestError = function (error) {
 };
 exports.isRequestError = isRequestError;
 var convertToRequestError = function (config) {
-    var error = config.error, response = config.response, code = config.code;
-    return Object.assign(error, {
+    var error = config.error, context = config.context, response = config.response, code = config.code;
+    var resultError = Object.assign(error, {
         name: "RequestError",
         response: response,
         code: code,
         isRequestError: true,
-        config: undefined,
-        request: undefined,
-        toJSON: undefined,
+        request: {
+            url: context.getRequestUrl().href,
+            query: context.computedConfig.query,
+            headers: context.computedConfig.headers,
+            body: context.getParsedBody(),
+        },
     });
+    delete resultError.config;
+    delete resultError.toJSON;
+    return resultError;
 };
 exports.convertToRequestError = convertToRequestError;

package/cjs/Requester.js

@@ -161,6 +161,7 @@ var makeRequest = function (context) { return __awaiter(void 0, void 0, void 0,
                                         error: new Error("[api-def] Invalid response status code '".concat(parsedResponse.status, "'")),
                                         response: parsedResponse,
                                         code: RequestError_1.RequestErrorCode.REQUEST_INVALID_STATUS,
+                                        context: context,
                                     });
                                 }
                                 context.response = parsedResponse;
@@ -234,6 +235,7 @@ var parseResponse = function (context, response, error) { return __awaiter(void
                             error: new Error("[api-def] Expected '".concat(context.responseType, "' response, got '").concat(inferredResponseType, "' (from 'Content-Type' of '").concat(contentType, "')")),
                             code: RequestError_1.RequestErrorCode.REQUEST_MISMATCH_RESPONSE_TYPE,
                             response: parsedResponse_1,
+                            context: context,
                         });
                     }
                     // transform arrayBuffer to json
@@ -251,6 +253,7 @@ var parseResponse = function (context, response, error) { return __awaiter(void
                                         error: new Error("[api-def] Expected '".concat(context.responseType, "' response, got '").concat(inferredResponseType, "' (from 'Content-Type' of '").concat(contentType, "')")),
                                         code: RequestError_1.RequestErrorCode.REQUEST_MISMATCH_RESPONSE_TYPE,
                                         response: parsedResponse_1,
+                                        context: context,
                                     });
                                 }
                             }
@@ -287,7 +290,7 @@ var parseError = function (context, rawError) { return __awaiter(void 0, void 0,
                     }
                 }
                 errorInfo = context.backend.getErrorInfo(rawError, errorResponse);
-                error = (0, RequestError_1.convertToRequestError)(__assign({ error: rawError, response: errorResponse, code: code }, errorInfo));
+                error = (0, RequestError_1.convertToRequestError)(__assign({ error: rawError, response: errorResponse, code: code, context: context }, errorInfo));
                 _a.label = 5;
             case 5: return [2 /*return*/, error];
         }

package/cjs/backend/FetchRequestBackend.js

@@ -128,34 +128,10 @@ var FetchRequestBackend = /** @class */ (function () {
         });
     };
     FetchRequestBackend.prototype.makeRequest = function (context) {
-        var _a;
         if (!this.fetch) {
             throw new Error("[api-def] No fetch impl was provided to FetchRequestBackend");
         }
         var computedConfig = context.computedConfig;
-        var path = !context.baseUrl.endsWith("/")
-            ? context.baseUrl + "/"
-            : context.baseUrl;
-        path += context.computedPath.startsWith("/")
-            ? context.computedPath.substring(1)
-            : context.computedPath;
-        var origin = undefined;
-        if (typeof window !== "undefined") {
-            origin = window.origin;
-        }
-        var url = new URL(path, origin);
-        if (computedConfig.query) {
-            if (context.computedConfig.queryParser) {
-                url.search = context.computedConfig.queryParser(computedConfig.query);
-            }
-            else {
-                var queryKeys = Object.keys(computedConfig.query);
-                for (var i = 0; i < queryKeys.length; i++) {
-                    var key = queryKeys[i];
-                    url.searchParams.append(key, ((_a = computedConfig.query[key]) === null || _a === void 0 ? void 0 : _a.toString()) || "");
-                }
-            }
-        }
         // abort controller is a newer feature than fetch
         var abortController = AbortController && new AbortController();
         var abortSignal = abortController ? abortController.signal : undefined;
@@ -174,6 +150,7 @@ var FetchRequestBackend = /** @class */ (function () {
             }
             return parsedHeaders;
         }, {});
+        var url = context.getRequestUrl();
         var promise = this.fetch(url.href, {
             method: context.method,
             body: bodyJsonify ? JSON.stringify(body) : body,

package/cjs/backend/MockRequestBackend.js

@@ -74,6 +74,7 @@ var MockRequestBackend = /** @class */ (function () {
                             throw (0, RequestError_1.convertToRequestError)({
                                 error: new Error("[api-def] Attempted to run mocked request without mocking function"),
                                 code: RequestError_1.RequestErrorCode.REQUEST_INVALID_CONFIG,
+                                context: context,
                             });
                         }
                         req = {
@@ -110,6 +111,7 @@ var MockRequestBackend = /** @class */ (function () {
                                 throw (0, RequestError_1.convertToRequestError)({
                                     error: new Error("[api-def] Min delay cannot be greater than max delay"),
                                     code: RequestError_1.RequestErrorCode.REQUEST_INVALID_CONFIG,
+                                    context: context,
                                 });
                             }
                             delayMs = (0, Utils_1.randInt)(min, max);
@@ -129,6 +131,7 @@ var MockRequestBackend = /** @class */ (function () {
                             throw (0, RequestError_1.convertToRequestError)({
                                 error: new Error("[api-def] Mocked API did not respond"),
                                 code: RequestError_1.RequestErrorCode.REQUEST_INVALID_CONFIG,
+                                context: context,
                             });
                         }
                         parsedHeaders = Object.keys(res.headers).reduce(function (parsedHeaders, key) {

package/esm/RequestContext.d.ts

@@ -34,4 +34,5 @@ export default class RequestContext<R = any, P extends Params | undefined = Para
     triggerEvent(eventType: RequestEvent): Promise<EventResult<R> | undefined>;
     addCanceller(canceler: () => void): void;
     cancel(): void;
+    getRequestUrl(): URL;
 }

package/esm/RequestContext.js

@@ -189,6 +189,38 @@ var RequestContext = /** @class */ (function () {
             this.canceler();
         }
     };
+    RequestContext.prototype.getRequestUrl = function () {
+        var _a;
+        var path = !this.baseUrl.endsWith("/")
+            ? this.baseUrl + "/"
+            : this.baseUrl;
+        path += this.computedPath.startsWith("/")
+            ? this.computedPath.substring(1)
+            : this.computedPath;
+        var origin = undefined;
+        if (typeof window !== "undefined") {
+            origin = window.origin;
+        }
+        if (!origin) {
+            if (path.indexOf("://") === -1) {
+                path = "https://".concat(path);
+            }
+        }
+        var url = new URL(path, origin);
+        if (this.computedConfig.query) {
+            if (this.computedConfig.queryParser) {
+                url.search = this.computedConfig.queryParser(this.computedConfig.query);
+            }
+            else {
+                var queryKeys = Object.keys(this.computedConfig.query);
+                for (var i = 0; i < queryKeys.length; i++) {
+                    var key = queryKeys[i];
+                    url.searchParams.append(key, ((_a = this.computedConfig.query[key]) === null || _a === void 0 ? void 0 : _a.toString()) || "");
+                }
+            }
+        }
+        return url;
+    };
     return RequestContext;
 }());
 export default RequestContext;

package/esm/RequestError.d.ts

@@ -1,5 +1,6 @@
 import { ApiResponse } from "./ApiTypes";
 import { EnumOf } from "./Utils";
+import RequestContext from "./RequestContext";
 export declare const RequestErrorCode: {
     readonly MISC_UNKNOWN_ERROR: "misc/unknown-error";
     readonly REQUEST_NETWORK_ERROR: "request/network-error";
@@ -17,6 +18,7 @@ export declare const isRequestError: (error: Error) => error is RequestError;
 export interface RequestErrorConfig {
     error: Error;
     code: string;
+    context: RequestContext;
     response?: ApiResponse | null;
 }
 export declare const convertToRequestError: (config: RequestErrorConfig) => RequestError;

package/esm/RequestError.js

@@ -9,14 +9,20 @@ export var isRequestError = function (error) {
     return "isRequestError" in error;
 };
 export var convertToRequestError = function (config) {
-    var error = config.error, response = config.response, code = config.code;
-    return Object.assign(error, {
+    var error = config.error, context = config.context, response = config.response, code = config.code;
+    var resultError = Object.assign(error, {
         name: "RequestError",
         response: response,
         code: code,
         isRequestError: true,
-        config: undefined,
-        request: undefined,
-        toJSON: undefined,
+        request: {
+            url: context.getRequestUrl().href,
+            query: context.computedConfig.query,
+            headers: context.computedConfig.headers,
+            body: context.getParsedBody(),
+        },
     });
+    delete resultError.config;
+    delete resultError.toJSON;
+    return resultError;
 };

package/esm/Requester.js

@@ -157,6 +157,7 @@ var makeRequest = function (context) { return __awaiter(void 0, void 0, void 0,
                                         error: new Error("[api-def] Invalid response status code '".concat(parsedResponse.status, "'")),
                                         response: parsedResponse,
                                         code: RequestErrorCode.REQUEST_INVALID_STATUS,
+                                        context: context,
                                     });
                                 }
                                 context.response = parsedResponse;
@@ -230,6 +231,7 @@ var parseResponse = function (context, response, error) { return __awaiter(void
                             error: new Error("[api-def] Expected '".concat(context.responseType, "' response, got '").concat(inferredResponseType, "' (from 'Content-Type' of '").concat(contentType, "')")),
                             code: RequestErrorCode.REQUEST_MISMATCH_RESPONSE_TYPE,
                             response: parsedResponse_1,
+                            context: context,
                         });
                     }
                     // transform arrayBuffer to json
@@ -247,6 +249,7 @@ var parseResponse = function (context, response, error) { return __awaiter(void
                                         error: new Error("[api-def] Expected '".concat(context.responseType, "' response, got '").concat(inferredResponseType, "' (from 'Content-Type' of '").concat(contentType, "')")),
                                         code: RequestErrorCode.REQUEST_MISMATCH_RESPONSE_TYPE,
                                         response: parsedResponse_1,
+                                        context: context,
                                     });
                                 }
                             }
@@ -283,7 +286,7 @@ var parseError = function (context, rawError) { return __awaiter(void 0, void 0,
                     }
                 }
                 errorInfo = context.backend.getErrorInfo(rawError, errorResponse);
-                error = convertToRequestError(__assign({ error: rawError, response: errorResponse, code: code }, errorInfo));
+                error = convertToRequestError(__assign({ error: rawError, response: errorResponse, code: code, context: context }, errorInfo));
                 _a.label = 5;
             case 5: return [2 /*return*/, error];
         }

package/esm/backend/FetchRequestBackend.js

@@ -126,34 +126,10 @@ var FetchRequestBackend = /** @class */ (function () {
         });
     };
     FetchRequestBackend.prototype.makeRequest = function (context) {
-        var _a;
         if (!this.fetch) {
             throw new Error("[api-def] No fetch impl was provided to FetchRequestBackend");
         }
         var computedConfig = context.computedConfig;
-        var path = !context.baseUrl.endsWith("/")
-            ? context.baseUrl + "/"
-            : context.baseUrl;
-        path += context.computedPath.startsWith("/")
-            ? context.computedPath.substring(1)
-            : context.computedPath;
-        var origin = undefined;
-        if (typeof window !== "undefined") {
-            origin = window.origin;
-        }
-        var url = new URL(path, origin);
-        if (computedConfig.query) {
-            if (context.computedConfig.queryParser) {
-                url.search = context.computedConfig.queryParser(computedConfig.query);
-            }
-            else {
-                var queryKeys = Object.keys(computedConfig.query);
-                for (var i = 0; i < queryKeys.length; i++) {
-                    var key = queryKeys[i];
-                    url.searchParams.append(key, ((_a = computedConfig.query[key]) === null || _a === void 0 ? void 0 : _a.toString()) || "");
-                }
-            }
-        }
         // abort controller is a newer feature than fetch
         var abortController = AbortController && new AbortController();
         var abortSignal = abortController ? abortController.signal : undefined;
@@ -172,6 +148,7 @@ var FetchRequestBackend = /** @class */ (function () {
             }
             return parsedHeaders;
         }, {});
+        var url = context.getRequestUrl();
         var promise = this.fetch(url.href, {
             method: context.method,
             body: bodyJsonify ? JSON.stringify(body) : body,

package/esm/backend/MockRequestBackend.js

@@ -72,6 +72,7 @@ var MockRequestBackend = /** @class */ (function () {
                             throw convertToRequestError({
                                 error: new Error("[api-def] Attempted to run mocked request without mocking function"),
                                 code: RequestErrorCode.REQUEST_INVALID_CONFIG,
+                                context: context,
                             });
                         }
                         req = {
@@ -108,6 +109,7 @@ var MockRequestBackend = /** @class */ (function () {
                                 throw convertToRequestError({
                                     error: new Error("[api-def] Min delay cannot be greater than max delay"),
                                     code: RequestErrorCode.REQUEST_INVALID_CONFIG,
+                                    context: context,
                                 });
                             }
                             delayMs = randInt(min, max);
@@ -127,6 +129,7 @@ var MockRequestBackend = /** @class */ (function () {
                             throw convertToRequestError({
                                 error: new Error("[api-def] Mocked API did not respond"),
                                 code: RequestErrorCode.REQUEST_INVALID_CONFIG,
+                                context: context,
                             });
                         }
                         parsedHeaders = Object.keys(res.headers).reduce(function (parsedHeaders, key) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-def",
-  "version": "0.6.2-alpha.1",
+  "version": "0.6.2-alpha.2",
   "description": "Typed API definitions with middleware support",
   "main": "cjs/index.js",
   "types": "esm/index.d.ts",