api-def 0.10.1 → 0.11.0-alpha.1

package/cjs/ApiTypes.d.ts

@@ -4,7 +4,7 @@ import type RequestContext from "./RequestContext";
 import type { Validation } from "./Validation";
 import type RequestBackend from "./backend/RequestBackend";
 export type AcceptableStatus = number | [min: number, max: number];
-export type Headers = Record<string, string | number | boolean | null | undefined>;
+export type RawHeaders = Record<string, string | number | boolean | null | undefined>;
 export type Params = string;
 export type Query = string | undefined | Record<string, any>;
 export type Body = string | number | Record<string, any>;
@@ -14,7 +14,7 @@ export interface ApiResponse<T = any> {
     readonly url: string;
     readonly status: number;
     readonly data: T;
-    readonly headers: Record<string, string>;
+    readonly headers: Headers;
     readonly state: State;
 }
 export type RequestLock = string | false;
@@ -35,7 +35,7 @@ export interface BaseRequestConfig {
     lock?: RequestLock;
     credentials?: "omit" | "same-origin" | "include";
     retry?: number | false | RetryOptions;
-    headers?: Readonly<Headers>;
+    headers?: Readonly<RawHeaders>;
     acceptableStatus?: AcceptableStatus[];
     /**
      * @deprecated use `queryHandling.stringify` instead

package/cjs/MockingTypes.d.ts

@@ -1,4 +1,4 @@
-import type { ApiResponse, Body, Headers, Params, Query, State } from "./ApiTypes";
+import type { ApiResponse, Body, Params, Query, RawHeaders, State } from "./ApiTypes";
 export interface ApiMockingConfig {
     enabled: boolean | (() => boolean);
 }
@@ -6,14 +6,14 @@ export interface MockRequest<TResponse = any, TParams extends Params | undefined
     params: TParams extends Params ? Record<TParams, string> : {};
     body: TBody;
     query: TQuery;
-    headers: Readonly<Headers>;
+    headers: Readonly<RawHeaders>;
     url: string;
     state: TState;
 }
 export interface MockResponse<TResponse = any, TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> {
     statusCode: number;
     response: TResponse | undefined;
-    headers: Headers;
+    headers: RawHeaders;
     status(statusCode: number): this;
     send(response: TResponse): this;
 }

package/cjs/RequestContext.d.ts

@@ -1,6 +1,6 @@
 import type { Api } from "./Api";
 import type { RequestEvent, RequestMethod, ResponseType } from "./ApiConstants";
-import type { ApiResponse, Body, ComputedRequestConfig, EventResult, Headers, Params, Query, RequestCacheInfo, RequestContextStats, RequestEventHandlers, RequestHost, State } from "./ApiTypes";
+import type { ApiResponse, Body, ComputedRequestConfig, EventResult, Params, Query, RawHeaders, RequestCacheInfo, RequestContextStats, RequestEventHandlers, RequestHost, State } from "./ApiTypes";
 import type { EndpointMockingConfig } from "./MockingTypes";
 import type { RequestError } from "./RequestError";
 import type { Validation } from "./Validation";
@@ -36,7 +36,7 @@ export default class RequestContext<TResponse = any, TParams extends Params | un
     get responseType(): ResponseType | undefined;
     private initMiddleware;
     private generateKey;
-    updateHeaders(newHeaders: Headers): this;
+    updateHeaders(newHeaders: RawHeaders): this;
     private parseRequestBody;
     getParsedBody(): any;
     updateQuery(newQuery: Partial<TQuery>): this;

package/cjs/RequestError.d.ts

@@ -14,13 +14,14 @@ export declare const RequestErrorCode: {
     readonly VALIDATION_RESPONSE_VALIDATE_ERROR: "validation/response-validate-error";
 };
 export type RequestErrorCode = EnumOf<typeof RequestErrorCode>;
+declare const REQUEST_ERROR_SYMBOL: unique symbol;
 export interface RequestError extends Error {
-    isRequestError: true;
+    [REQUEST_ERROR_SYMBOL]: true;
     response: ApiResponse | undefined | null;
     code: string;
     attempts: number;
 }
-export declare const isRequestError: (error: Error) => error is RequestError;
+export declare const isRequestError: (error: any) => error is RequestError;
 export interface RequestErrorConfig {
     error: Error;
     code: string;
@@ -28,3 +29,4 @@ export interface RequestErrorConfig {
     response?: ApiResponse | null;
 }
 export declare const convertToRequestError: (config: RequestErrorConfig) => RequestError;
+export {};

package/cjs/RequestError.js

@@ -13,26 +13,35 @@ exports.RequestErrorCode = {
     VALIDATION_BODY_VALIDATE_ERROR: "validation/body-validate-error",
     VALIDATION_RESPONSE_VALIDATE_ERROR: "validation/response-validate-error",
 };
+var REQUEST_ERROR_SYMBOL = Symbol("isRequestError");
 var isRequestError = function (error) {
-    return "isRequestError" in error;
+    if (!error) {
+        return false;
+    }
+    if (typeof error !== "object") {
+        return false;
+    }
+    return error[REQUEST_ERROR_SYMBOL] === true;
 };
 exports.isRequestError = isRequestError;
 var convertToRequestError = function (config) {
+    var _a;
     var error = config.error, context = config.context, response = config.response, code = config.code;
     var body = context.getParsedBody();
-    var resultError = Object.assign(error, {
-        name: "RequestError",
-        response: response,
-        code: code,
-        isRequestError: true,
-        attempts: context.stats.attempt,
-        request: {
+    var resultError = Object.assign(error, (_a = {
+            name: "RequestError",
+            response: response,
+            code: code
+        },
+        _a[REQUEST_ERROR_SYMBOL] = true,
+        _a.attempts = context.stats.attempt,
+        _a.request = {
             url: context.requestUrl.href,
             query: context.computedConfig.queryObject,
             headers: context.computedConfig.headers,
             body: body,
         },
-    });
+        _a));
     try {
         Object.defineProperty(resultError, "message", {
             value: "Request failed".concat((response === null || response === void 0 ? void 0 : response.status) ? " with status code ".concat(response.status) : "", " [").concat(code, "]: ").concat(resultError.message),

package/cjs/Requester.js

@@ -242,7 +242,7 @@ var makeRequest = function (context) { return __awaiter(void 0, void 0, void 0,
     });
 }); };
 var parseResponse = function (context, response, error) { return __awaiter(void 0, void 0, void 0, function () {
-    var parsedResponse_1, contentType, inferredResponseType, data, decodedData;
+    var parsedResponse, contentType, inferredResponseType, data, decodedData;
     var _a;
     return __generator(this, function (_b) {
         switch (_b.label) {
@@ -250,15 +250,8 @@ var parseResponse = function (context, response, error) { return __awaiter(void
                 if (!response) return [3 /*break*/, 2];
                 return [4 /*yield*/, context.backend.convertResponse(context, response)];
             case 1:
-                parsedResponse_1 = _b.sent();
-                // lowercase all header names
-                parsedResponse_1.headers =
-                    parsedResponse_1.__lowercaseHeaders ||
-                        Object.keys(parsedResponse_1.headers).reduce(function (headers, header) {
-                            headers[header.toLowerCase()] = parsedResponse_1.headers[header];
-                            return headers;
-                        }, {});
-                contentType = parsedResponse_1.headers["content-type"];
+                parsedResponse = _b.sent();
+                contentType = parsedResponse.headers.get("content-type");
                 inferredResponseType = (0, ApiUtils_1.inferResponseType)(contentType);
                 if (!error) {
                     // expand to array buffer once we support that in inferResponseType
@@ -266,13 +259,13 @@ var parseResponse = function (context, response, error) { return __awaiter(void
                         throw (0, RequestError_1.convertToRequestError)({
                             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,
+                            response: parsedResponse,
                             context: context,
                         });
                     }
                     // transform arrayBuffer to json
                     if (inferredResponseType === "arraybuffer" && context.responseType === "json") {
-                        if (parsedResponse_1.data && typeof parsedResponse_1.data === "object") {
+                        if (parsedResponse.data && typeof parsedResponse.data === "object") {
                             data = response.data;
                             if (((_a = data.constructor) === null || _a === void 0 ? void 0 : _a.name) === "ArrayBuffer") {
                                 try {
@@ -283,7 +276,7 @@ var parseResponse = function (context, response, error) { return __awaiter(void
                                     throw (0, RequestError_1.convertToRequestError)({
                                         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,
+                                        response: parsedResponse,
                                         context: context,
                                     });
                                 }
@@ -291,7 +284,7 @@ var parseResponse = function (context, response, error) { return __awaiter(void
                         }
                     }
                 }
-                return [2 /*return*/, parsedResponse_1];
+                return [2 /*return*/, parsedResponse];
             case 2: return [2 /*return*/, response];
         }
     });

package/cjs/backend/FetchRequestBackend.js

@@ -88,23 +88,18 @@ var FetchRequestBackend = /** @class */ (function () {
     };
     FetchRequestBackend.prototype.convertResponse = function (context, response) {
         return __awaiter(this, void 0, void 0, function () {
-            var status, headers, processedHeaders, convertedResponse, responseType, text, data, error_1;
+            var status, headers, convertedResponse, responseType, text, data, error_1;
             var _a;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
                         status = response.status, headers = response.headers;
-                        processedHeaders = {};
-                        headers.forEach(function (value, key) {
-                            processedHeaders[key] = value;
-                        });
                         convertedResponse = {
-                            __lowercaseHeaders: processedHeaders,
                             method: context.method,
                             url: response.url,
                             data: undefined,
                             status: status,
-                            headers: processedHeaders,
+                            headers: headers,
                             state: context.requestConfig.state,
                         };
                         responseType = (_a = context.responseType) !== null && _a !== void 0 ? _a : (0, ApiUtils_1.inferResponseType)(response.headers.get("Content-Type"));

package/cjs/backend/MockRequestBackend.js

@@ -137,9 +137,9 @@ var MockRequestBackend = /** @class */ (function () {
                             });
                         }
                         parsedHeaders = Object.keys(res.headers).reduce(function (parsedHeaders, key) {
-                            parsedHeaders[key] = res.headers[key].toString();
+                            parsedHeaders.set(key, res.headers[key].toString());
                             return parsedHeaders;
-                        }, {});
+                        }, new Headers());
                         return [2 /*return*/, {
                                 url: context.requestUrl.href,
                                 method: context.method,

package/cjs/index.d.ts

@@ -2,8 +2,8 @@ export * from "./Api";
 export * from "./ApiTypes";
 export * from "./UtilTypes";
 export * from "./ApiConstants";
-export { isRequestError } from "./RequestError";
-export { default as Endpoint, EndpointConfig } from "./Endpoint";
+export { isRequestError, type RequestError } from "./RequestError";
+export { default as Endpoint, type EndpointConfig } from "./Endpoint";
 export { clearCache, setCacheBackend } from "./cache/Caching";
 export { default as LocalStorageCacheBackend } from "./cache/LocalStorageCacheBackend";
 export { default as LocaleForageCacheBackend } from "./cache/LocalForageCacheBackend";

package/esm/ApiTypes.d.ts

@@ -4,7 +4,7 @@ import type RequestContext from "./RequestContext";
 import type { Validation } from "./Validation";
 import type RequestBackend from "./backend/RequestBackend";
 export type AcceptableStatus = number | [min: number, max: number];
-export type Headers = Record<string, string | number | boolean | null | undefined>;
+export type RawHeaders = Record<string, string | number | boolean | null | undefined>;
 export type Params = string;
 export type Query = string | undefined | Record<string, any>;
 export type Body = string | number | Record<string, any>;
@@ -14,7 +14,7 @@ export interface ApiResponse<T = any> {
     readonly url: string;
     readonly status: number;
     readonly data: T;
-    readonly headers: Record<string, string>;
+    readonly headers: Headers;
     readonly state: State;
 }
 export type RequestLock = string | false;
@@ -35,7 +35,7 @@ export interface BaseRequestConfig {
     lock?: RequestLock;
     credentials?: "omit" | "same-origin" | "include";
     retry?: number | false | RetryOptions;
-    headers?: Readonly<Headers>;
+    headers?: Readonly<RawHeaders>;
     acceptableStatus?: AcceptableStatus[];
     /**
      * @deprecated use `queryHandling.stringify` instead

package/esm/MockingTypes.d.ts

@@ -1,4 +1,4 @@
-import type { ApiResponse, Body, Headers, Params, Query, State } from "./ApiTypes";
+import type { ApiResponse, Body, Params, Query, RawHeaders, State } from "./ApiTypes";
 export interface ApiMockingConfig {
     enabled: boolean | (() => boolean);
 }
@@ -6,14 +6,14 @@ export interface MockRequest<TResponse = any, TParams extends Params | undefined
     params: TParams extends Params ? Record<TParams, string> : {};
     body: TBody;
     query: TQuery;
-    headers: Readonly<Headers>;
+    headers: Readonly<RawHeaders>;
     url: string;
     state: TState;
 }
 export interface MockResponse<TResponse = any, TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> {
     statusCode: number;
     response: TResponse | undefined;
-    headers: Headers;
+    headers: RawHeaders;
     status(statusCode: number): this;
     send(response: TResponse): this;
 }

package/esm/RequestContext.d.ts

@@ -1,6 +1,6 @@
 import type { Api } from "./Api";
 import type { RequestEvent, RequestMethod, ResponseType } from "./ApiConstants";
-import type { ApiResponse, Body, ComputedRequestConfig, EventResult, Headers, Params, Query, RequestCacheInfo, RequestContextStats, RequestEventHandlers, RequestHost, State } from "./ApiTypes";
+import type { ApiResponse, Body, ComputedRequestConfig, EventResult, Params, Query, RawHeaders, RequestCacheInfo, RequestContextStats, RequestEventHandlers, RequestHost, State } from "./ApiTypes";
 import type { EndpointMockingConfig } from "./MockingTypes";
 import type { RequestError } from "./RequestError";
 import type { Validation } from "./Validation";
@@ -36,7 +36,7 @@ export default class RequestContext<TResponse = any, TParams extends Params | un
     get responseType(): ResponseType | undefined;
     private initMiddleware;
     private generateKey;
-    updateHeaders(newHeaders: Headers): this;
+    updateHeaders(newHeaders: RawHeaders): this;
     private parseRequestBody;
     getParsedBody(): any;
     updateQuery(newQuery: Partial<TQuery>): this;

package/esm/RequestError.d.ts

@@ -14,13 +14,14 @@ export declare const RequestErrorCode: {
     readonly VALIDATION_RESPONSE_VALIDATE_ERROR: "validation/response-validate-error";
 };
 export type RequestErrorCode = EnumOf<typeof RequestErrorCode>;
+declare const REQUEST_ERROR_SYMBOL: unique symbol;
 export interface RequestError extends Error {
-    isRequestError: true;
+    [REQUEST_ERROR_SYMBOL]: true;
     response: ApiResponse | undefined | null;
     code: string;
     attempts: number;
 }
-export declare const isRequestError: (error: Error) => error is RequestError;
+export declare const isRequestError: (error: any) => error is RequestError;
 export interface RequestErrorConfig {
     error: Error;
     code: string;
@@ -28,3 +29,4 @@ export interface RequestErrorConfig {
     response?: ApiResponse | null;
 }
 export declare const convertToRequestError: (config: RequestErrorConfig) => RequestError;
+export {};

package/esm/RequestError.js

@@ -10,8 +10,15 @@ export const RequestErrorCode = {
     VALIDATION_BODY_VALIDATE_ERROR: "validation/body-validate-error",
     VALIDATION_RESPONSE_VALIDATE_ERROR: "validation/response-validate-error",
 };
+const REQUEST_ERROR_SYMBOL = Symbol("isRequestError");
 export const isRequestError = (error) => {
-    return "isRequestError" in error;
+    if (!error) {
+        return false;
+    }
+    if (typeof error !== "object") {
+        return false;
+    }
+    return error[REQUEST_ERROR_SYMBOL] === true;
 };
 export const convertToRequestError = (config) => {
     const { error, context, response, code } = config;
@@ -20,7 +27,7 @@ export const convertToRequestError = (config) => {
         name: "RequestError",
         response: response,
         code: code,
-        isRequestError: true,
+        [REQUEST_ERROR_SYMBOL]: true,
         attempts: context.stats.attempt,
         request: {
             url: context.requestUrl.href,

package/esm/Requester.js

@@ -178,14 +178,7 @@ const parseResponse = (context, response, error) => __awaiter(void 0, void 0, vo
     var _d;
     if (response) {
         const parsedResponse = yield context.backend.convertResponse(context, response);
-        // lowercase all header names
-        parsedResponse.headers =
-            parsedResponse.__lowercaseHeaders ||
-                Object.keys(parsedResponse.headers).reduce((headers, header) => {
-                    headers[header.toLowerCase()] = parsedResponse.headers[header];
-                    return headers;
-                }, {});
-        const contentType = parsedResponse.headers["content-type"];
+        const contentType = parsedResponse.headers.get("content-type");
         const inferredResponseType = inferResponseType(contentType);
         if (!error) {
             // expand to array buffer once we support that in inferResponseType

package/esm/backend/FetchRequestBackend.js

@@ -38,17 +38,12 @@ export default class FetchRequestBackend {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
             const { status, headers } = response;
-            const processedHeaders = {};
-            headers.forEach((value, key) => {
-                processedHeaders[key] = value;
-            });
             const convertedResponse = {
-                __lowercaseHeaders: processedHeaders,
                 method: context.method,
                 url: response.url,
                 data: undefined,
                 status: status,
-                headers: processedHeaders,
+                headers: headers,
                 state: context.requestConfig.state,
             };
             const responseType = (_a = context.responseType) !== null && _a !== void 0 ? _a : inferResponseType(response.headers.get("Content-Type"));

package/esm/backend/MockRequestBackend.js

@@ -93,9 +93,9 @@ export default class MockRequestBackend {
                 });
             }
             const parsedHeaders = Object.keys(res.headers).reduce((parsedHeaders, key) => {
-                parsedHeaders[key] = res.headers[key].toString();
+                parsedHeaders.set(key, res.headers[key].toString());
                 return parsedHeaders;
-            }, {});
+            }, new Headers());
             return {
                 url: context.requestUrl.href,
                 method: context.method,

package/esm/index.d.ts

@@ -2,8 +2,8 @@ export * from "./Api";
 export * from "./ApiTypes";
 export * from "./UtilTypes";
 export * from "./ApiConstants";
-export { isRequestError } from "./RequestError";
-export { default as Endpoint, EndpointConfig } from "./Endpoint";
+export { isRequestError, type RequestError } from "./RequestError";
+export { default as Endpoint, type EndpointConfig } from "./Endpoint";
 export { clearCache, setCacheBackend } from "./cache/Caching";
 export { default as LocalStorageCacheBackend } from "./cache/LocalStorageCacheBackend";
 export { default as LocaleForageCacheBackend } from "./cache/LocalForageCacheBackend";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-def",
-  "version": "0.10.1",
+  "version": "0.11.0-alpha.1",
   "description": "Typed API definitions with middleware support",
   "main": "cjs/index.js",
   "types": "esm/index.d.ts",
@@ -30,19 +30,19 @@
   },
   "repository": "https://github.com/Censkh/api-def",
   "devDependencies": {
-    "@biomejs/biome": "1.7.3",
+    "@biomejs/biome": "1.8.1",
     "@swc/core": "latest",
     "@swc/jest": "latest",
     "@types/axios": "0.14.0",
     "@types/jest": "^29.5.12",
-    "@types/node": "20.12.11",
+    "@types/node": "20.14.2",
     "@types/qs": "6.9.15",
-    "axios": "1.6.8",
+    "axios": "1.7.2",
     "cross-env": "7.0.3",
     "jest": "latest",
     "npm-run-all": "4.1.5",
     "qs": "6.12.1",
-    "rimraf": "5.0.6",
+    "rimraf": "5.0.7",
     "typescript": "5.4.5",
     "zod": "3.23.8"
   }