api-def 0.12.0-alpha.44 → 0.12.0-alpha.45

package/cjs/Endpoint.d.ts

@@ -1,6 +1,6 @@
 import type { Api } from "./Api";
 import type { RequestMethod, ResponseType } from "./ApiConstants";
-import type { ApiResponse, BaseRequestConfig, Body, ComputedRequestConfig, Params, Query, RawHeaders, RequestConfig, RequestHost, State } from "./ApiTypes";
+import type { ApiResponse, BaseRequestConfig, Body, ComputedRequestConfig, Params, Query, RawHeaders, RequestConfig, RequestHost, RequestMiddleware, State } from "./ApiTypes";
 import type * as Mocking from "./MockingTypes";
 import type { Validation } from "./Validation";
 import type RequestBackend from "./backend/RequestBackend";
@@ -24,7 +24,12 @@ export interface EndpointOptions<TResponse, TParams extends Params | undefined,
      * Describe your endpoint to help with debugging and documentation
      */
     readonly description?: string;
+    /** @deprecated use `defaultRequestConfig` instead */
     readonly config?: BaseRequestConfig;
+    /**
+     * Default request configuration for this endpoint
+     */
+    readonly defaultRequestConfig?: BaseRequestConfig;
     /**
      * Let the backend requestor (fetch, axios, etc.) know what type of response
      * you are expecting from this endpoint
@@ -37,9 +42,13 @@ export interface EndpointOptions<TResponse, TParams extends Params | undefined,
      * Enable/disable mocked returns for all endpoints on your API object.
      */
     readonly mocking?: Mocking.EndpointMockingConfig<TResponse, TParams, TQuery, TBody, TState>;
+    /**
+     * Middleware specific to this endpoint. These will be executed after API-level middleware.
+     */
+    readonly middleware?: RequestMiddleware[];
     readonly validation?: Validation<TResponse, TParams, TQuery, TBody, TState>;
 }
-export type EndpointInfo<TResponse, TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State = State, TPath extends string = string, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined, TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined> = EndpointOptions<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders> & Required<Pick<EndpointOptions<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>, "name" | "validation">>;
+export type EndpointInfo<TResponse, TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State = State, TPath extends string = string, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined, TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined> = EndpointOptions<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders> & Omit<Required<Pick<EndpointOptions<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>, "name" | "validation" | "defaultRequestConfig">>, "config">;
 /**
  * @deprecated Use `EndpointInfo` instead
  */
@@ -53,16 +62,19 @@ export default class Endpoint<TResponse = any, TParams extends Params | undefine
     get path(): TPath;
     get name(): string;
     get description(): string | undefined;
+    /** @deprecated Use `defaultRequestConfig` instead */
     get config(): BaseRequestConfig;
+    get defaultRequestConfig(): BaseRequestConfig;
     get responseType(): ResponseType | undefined;
     get mocking(): Mocking.EndpointMockingConfig<TResponse, TParams, TQuery, TBody, TState> | undefined;
     get validation(): Validation<TResponse, TParams, TQuery, TBody, TState>;
+    get middleware(): RequestMiddleware[];
     submit(config: RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>): Promise<ApiResponse<TResponse>>;
     resolveUrl(options: EndpointResolveUrlOptions<TParams, TQuery>): URL;
     resolvePath(options: EndpointResolvePathOptions<TParams>): string;
     get baseUrl(): string;
     /**
-     * @deprecated Use `computeRequestConfig` instead
+     * @deprecated Use `defaultRequestConfig` instead
      */
     computeConfig<TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State, TRequestHeaders extends RawHeaders | undefined>(config: RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>): ComputedRequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>;
     computeRequestConfig<TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State, TRequestHeaders extends RawHeaders | undefined>(config: RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>): ComputedRequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>;

package/cjs/Endpoint.js

@@ -52,8 +52,9 @@ var ApiUtils_1 = require("./ApiUtils");
 var RequestConfig_1 = require("./RequestConfig");
 var Endpoint = /** @class */ (function () {
     function Endpoint(api, options) {
+        var _a, _b;
         this.api = api;
-        this.info = __assign(__assign({}, options), { name: options.name || options.id, validation: options.validation || {} });
+        this.info = __assign(__assign({}, options), { config: undefined, name: options.name || options.id, validation: options.validation || {}, middleware: options.middleware || [], defaultRequestConfig: (_b = (_a = options.defaultRequestConfig) !== null && _a !== void 0 ? _a : options.config) !== null && _b !== void 0 ? _b : {} });
     }
     Object.defineProperty(Endpoint.prototype, "id", {
         get: function () {
@@ -91,8 +92,16 @@ var Endpoint = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(Endpoint.prototype, "config", {
+        /** @deprecated Use `defaultRequestConfig` instead */
         get: function () {
-            return this.info.config || {};
+            return this.defaultRequestConfig;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Endpoint.prototype, "defaultRequestConfig", {
+        get: function () {
+            return this.info.defaultRequestConfig;
         },
         enumerable: false,
         configurable: true
@@ -118,6 +127,13 @@ var Endpoint = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(Endpoint.prototype, "middleware", {
+        get: function () {
+            return this.info.middleware || [];
+        },
+        enumerable: false,
+        configurable: true
+    });
     Endpoint.prototype.submit = function (config) {
         return __awaiter(this, void 0, void 0, function () {
             var mock, apiMocking, mockingEnabled;
@@ -158,14 +174,15 @@ var Endpoint = /** @class */ (function () {
         configurable: true
     });
     /**
-     * @deprecated Use `computeRequestConfig` instead
+     * @deprecated Use `defaultRequestConfig` instead
      */
     Endpoint.prototype.computeConfig = function (config) {
         return this.computeRequestConfig(config);
     };
     Endpoint.prototype.computeRequestConfig = function (config) {
         var apiDefaults = this.api.computeRequestConfig();
-        return (0, RequestConfig_1.processRequestConfigs)([apiDefaults, this.config, config]);
+        var endpointDefaults = this.defaultRequestConfig || {};
+        return (0, RequestConfig_1.processRequestConfigs)([apiDefaults, endpointDefaults, config]);
     };
     Endpoint.prototype.getRequestBackend = function () {
         return this.api.requestBackend;

package/cjs/RequestContext.js

@@ -35,6 +35,15 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 var ApiUtils_1 = require("./ApiUtils");
 var Utils = require("./Utils");
@@ -106,9 +115,11 @@ var RequestContext = /** @class */ (function () {
         configurable: true
     });
     RequestContext.prototype.initMiddleware = function () {
-        var middleware = this.api.middleware;
-        for (var i = 0; i < middleware.length; i++) {
-            var events = middleware[i];
+        // Merge API-level and endpoint-level middleware
+        var allMiddleware = __spreadArray(__spreadArray([], this.api.middleware, true), ("middleware" in this.host && Array.isArray(this.host.middleware) ? this.host.middleware : []), true);
+        // Process all middleware in one pass
+        for (var i = 0; i < allMiddleware.length; i++) {
+            var events = allMiddleware[i];
             var eventTypes = Object.keys(events);
             for (var n = 0; n < eventTypes.length; n++) {
                 var eventType = eventTypes[n];

package/esm/Endpoint.d.ts

@@ -1,6 +1,6 @@
 import type { Api } from "./Api";
 import type { RequestMethod, ResponseType } from "./ApiConstants";
-import type { ApiResponse, BaseRequestConfig, Body, ComputedRequestConfig, Params, Query, RawHeaders, RequestConfig, RequestHost, State } from "./ApiTypes";
+import type { ApiResponse, BaseRequestConfig, Body, ComputedRequestConfig, Params, Query, RawHeaders, RequestConfig, RequestHost, RequestMiddleware, State } from "./ApiTypes";
 import type * as Mocking from "./MockingTypes";
 import type { Validation } from "./Validation";
 import type RequestBackend from "./backend/RequestBackend";
@@ -24,7 +24,12 @@ export interface EndpointOptions<TResponse, TParams extends Params | undefined,
      * Describe your endpoint to help with debugging and documentation
      */
     readonly description?: string;
+    /** @deprecated use `defaultRequestConfig` instead */
     readonly config?: BaseRequestConfig;
+    /**
+     * Default request configuration for this endpoint
+     */
+    readonly defaultRequestConfig?: BaseRequestConfig;
     /**
      * Let the backend requestor (fetch, axios, etc.) know what type of response
      * you are expecting from this endpoint
@@ -37,9 +42,13 @@ export interface EndpointOptions<TResponse, TParams extends Params | undefined,
      * Enable/disable mocked returns for all endpoints on your API object.
      */
     readonly mocking?: Mocking.EndpointMockingConfig<TResponse, TParams, TQuery, TBody, TState>;
+    /**
+     * Middleware specific to this endpoint. These will be executed after API-level middleware.
+     */
+    readonly middleware?: RequestMiddleware[];
     readonly validation?: Validation<TResponse, TParams, TQuery, TBody, TState>;
 }
-export type EndpointInfo<TResponse, TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State = State, TPath extends string = string, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined, TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined> = EndpointOptions<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders> & Required<Pick<EndpointOptions<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>, "name" | "validation">>;
+export type EndpointInfo<TResponse, TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State = State, TPath extends string = string, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined, TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined> = EndpointOptions<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders> & Omit<Required<Pick<EndpointOptions<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>, "name" | "validation" | "defaultRequestConfig">>, "config">;
 /**
  * @deprecated Use `EndpointInfo` instead
  */
@@ -53,16 +62,19 @@ export default class Endpoint<TResponse = any, TParams extends Params | undefine
     get path(): TPath;
     get name(): string;
     get description(): string | undefined;
+    /** @deprecated Use `defaultRequestConfig` instead */
     get config(): BaseRequestConfig;
+    get defaultRequestConfig(): BaseRequestConfig;
     get responseType(): ResponseType | undefined;
     get mocking(): Mocking.EndpointMockingConfig<TResponse, TParams, TQuery, TBody, TState> | undefined;
     get validation(): Validation<TResponse, TParams, TQuery, TBody, TState>;
+    get middleware(): RequestMiddleware[];
     submit(config: RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>): Promise<ApiResponse<TResponse>>;
     resolveUrl(options: EndpointResolveUrlOptions<TParams, TQuery>): URL;
     resolvePath(options: EndpointResolvePathOptions<TParams>): string;
     get baseUrl(): string;
     /**
-     * @deprecated Use `computeRequestConfig` instead
+     * @deprecated Use `defaultRequestConfig` instead
      */
     computeConfig<TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State, TRequestHeaders extends RawHeaders | undefined>(config: RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>): ComputedRequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>;
     computeRequestConfig<TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State, TRequestHeaders extends RawHeaders | undefined>(config: RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>): ComputedRequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>;

package/esm/Endpoint.js

@@ -12,8 +12,9 @@ import { resolvePathParams } from "./ApiUtils";
 import { processRequestConfigs } from "./RequestConfig";
 export default class Endpoint {
     constructor(api, options) {
+        var _a, _b;
         this.api = api;
-        this.info = Object.assign(Object.assign({}, options), { name: options.name || options.id, validation: options.validation || {} });
+        this.info = Object.assign(Object.assign({}, options), { config: undefined, name: options.name || options.id, validation: options.validation || {}, middleware: options.middleware || [], defaultRequestConfig: (_b = (_a = options.defaultRequestConfig) !== null && _a !== void 0 ? _a : options.config) !== null && _b !== void 0 ? _b : {} });
     }
     get id() {
         return this.info.id;
@@ -30,8 +31,12 @@ export default class Endpoint {
     get description() {
         return this.info.description;
     }
+    /** @deprecated Use `defaultRequestConfig` instead */
     get config() {
-        return this.info.config || {};
+        return this.defaultRequestConfig;
+    }
+    get defaultRequestConfig() {
+        return this.info.defaultRequestConfig;
     }
     get responseType() {
         return this.info.responseType;
@@ -42,6 +47,9 @@ export default class Endpoint {
     get validation() {
         return this.info.validation;
     }
+    get middleware() {
+        return this.info.middleware || [];
+    }
     submit(config) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b;
@@ -75,14 +83,15 @@ export default class Endpoint {
         return this.api.baseUrl;
     }
     /**
-     * @deprecated Use `computeRequestConfig` instead
+     * @deprecated Use `defaultRequestConfig` instead
      */
     computeConfig(config) {
         return this.computeRequestConfig(config);
     }
     computeRequestConfig(config) {
         const apiDefaults = this.api.computeRequestConfig();
-        return processRequestConfigs([apiDefaults, this.config, config]);
+        const endpointDefaults = this.defaultRequestConfig || {};
+        return processRequestConfigs([apiDefaults, endpointDefaults, config]);
     }
     getRequestBackend() {
         return this.api.requestBackend;

package/esm/RequestContext.js

@@ -57,9 +57,14 @@ export default class RequestContext {
         return this.host.responseType;
     }
     initMiddleware() {
-        const { middleware } = this.api;
-        for (let i = 0; i < middleware.length; i++) {
-            const events = middleware[i];
+        // Merge API-level and endpoint-level middleware
+        const allMiddleware = [
+            ...this.api.middleware,
+            ...("middleware" in this.host && Array.isArray(this.host.middleware) ? this.host.middleware : []),
+        ];
+        // Process all middleware in one pass
+        for (let i = 0; i < allMiddleware.length; i++) {
+            const events = allMiddleware[i];
             const eventTypes = Object.keys(events);
             for (let n = 0; n < eventTypes.length; n++) {
                 const eventType = eventTypes[n];

package/package.json

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