api-machine 1.0.0

package/router/endpoint.d.ts

@@ -0,0 +1,44 @@
+import { Router as ExpressRouter, Request as ExpressRequest, Response as ExpressResponse, NextFunction as ExpressNextFunction } from 'express';
+import { ObjectSanitizer } from 'valsan/object-sanitizer';
+import { BaseApiRoute } from './base';
+import { HTTPError } from '../error';
+export type ApiRequest = ExpressRequest;
+export type ApiResponse = ExpressResponse;
+export type ApiNextFunction = ExpressNextFunction;
+export type ApiResponseData = {
+    [key: string]: any;
+} | {
+    [key: string]: any;
+}[];
+export declare enum EndpointMethod {
+    GET = "get",
+    POST = "post",
+    PUT = "put",
+    DELETE = "delete",
+    PATCH = "patch"
+}
+export declare abstract class BaseApiEndpoint extends BaseApiRoute {
+    path: string;
+    tag?: string;
+    method: EndpointMethod;
+    statusCode: number;
+    body?: ObjectSanitizer;
+    bodyExample?: any;
+    query?: ObjectSanitizer;
+    queryExample?: any;
+    params?: ObjectSanitizer;
+    paramsExample?: any;
+    headers?: ObjectSanitizer;
+    headersExample?: any;
+    getErrors(): {
+        [key: string]: HTTPError;
+    };
+    getTag(): string;
+    register(parentRouter: ExpressRouter, parentPath: string): Promise<void>;
+    handleWrapper(request: ApiRequest, response: ApiResponse, next: ApiNextFunction): Promise<ApiResponseData>;
+    abstract handle(request: ApiRequest, response: ApiResponse, next: ApiNextFunction): Promise<ApiResponseData>;
+    checkRequest(request: ApiRequest): Promise<void>;
+}
+export type ApiEndpoint = {
+    new (): BaseApiEndpoint;
+};

package/router/endpoint.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseApiEndpoint = exports.EndpointMethod = void 0;
+const base_1 = require("./base");
+const validation_middleware_1 = require("./validation-middleware");
+const error_1 = require("../error");
+var EndpointMethod;
+(function (EndpointMethod) {
+    EndpointMethod["GET"] = "get";
+    EndpointMethod["POST"] = "post";
+    EndpointMethod["PUT"] = "put";
+    EndpointMethod["DELETE"] = "delete";
+    EndpointMethod["PATCH"] = "patch";
+})(EndpointMethod || (exports.EndpointMethod = EndpointMethod = {}));
+class BaseApiEndpoint extends base_1.BaseApiRoute {
+    path = '';
+    tag;
+    method = EndpointMethod.GET;
+    statusCode = 200;
+    body;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    bodyExample;
+    query;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    queryExample;
+    params;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    paramsExample;
+    headers;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    headersExample;
+    getErrors() {
+        return {
+            parse: new error_1.BadRequestError(),
+            validation: new error_1.UnprocessableEntityError(),
+        };
+    }
+    getTag() {
+        // Determine tag from router if available, fallback to class name
+        return this.tag || this.constructor.name.replace(/Endpoint$/, '');
+    }
+    async register(parentRouter, parentPath) {
+        if (!this.name) {
+            this.name = this.constructor.name.replace(/Endpoint$/, '');
+        }
+        this.registerRoutePath(parentPath);
+        // Collect middleware including authentication
+        const endpointMiddleware = [...this.middleware];
+        // Add authentication middleware based on effective authentication
+        // This implements the cascading: endpoint → router → server
+        const effectiveAuth = this.getEffectiveAuthentication();
+        if (effectiveAuth) {
+            endpointMiddleware.push(effectiveAuth.getMiddleware());
+        }
+        // Register with middleware (if any) before the handler
+        if (endpointMiddleware.length > 0) {
+            parentRouter[this.method](this.path, ...endpointMiddleware, this.handleWrapper.bind(this));
+        }
+        else {
+            parentRouter[this.method](this.path, this.handleWrapper.bind(this));
+        }
+    }
+    async handleWrapper(request, response, next) {
+        await this.checkRequest(request);
+        const data = await this.handle(request, response, next);
+        response.status(this.statusCode);
+        return response.send(data);
+    }
+    async checkRequest(request) {
+        // Validate request parts (body, query, params, headers)
+        // 	if sanitizers are present
+        await (0, validation_middleware_1.validateRequest)(this, request);
+    }
+}
+exports.BaseApiEndpoint = BaseApiEndpoint;
+//# sourceMappingURL=endpoint.js.map

package/router/endpoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"endpoint.js","sourceRoot":"","sources":["../../../src/router/endpoint.ts"],"names":[],"mappings":";;;AASA,iCAAsC;AACtC,mEAA0D;AAC1D,oCAAgF;AAShF,IAAY,cAMX;AAND,WAAY,cAAc;IACzB,6BAAW,CAAA;IACX,+BAAa,CAAA;IACb,6BAAW,CAAA;IACX,mCAAiB,CAAA;IACjB,iCAAe,CAAA;AAChB,CAAC,EANW,cAAc,8BAAd,cAAc,QAMzB;AAED,MAAsB,eAAgB,SAAQ,mBAAY;IAChD,IAAI,GAAG,EAAE,CAAC;IACZ,GAAG,CAAU;IACb,MAAM,GAAmB,cAAc,CAAC,GAAG,CAAC;IAC5C,UAAU,GAAW,GAAG,CAAC;IAEzB,IAAI,CAAmB;IAC9B,8DAA8D;IACvD,WAAW,CAAO;IAElB,KAAK,CAAmB;IAC/B,8DAA8D;IACvD,YAAY,CAAO;IAEnB,MAAM,CAAmB;IAChC,8DAA8D;IACvD,aAAa,CAAO;IAEpB,OAAO,CAAmB;IACjC,8DAA8D;IACvD,cAAc,CAAO;IAErB,SAAS;QACf,OAAO;YACN,KAAK,EAAE,IAAI,uBAAe,EAAE;YAC5B,UAAU,EAAE,IAAI,gCAAwB,EAAE;SAC1C,CAAC;IACH,CAAC;IAEM,MAAM;QACZ,iEAAiE;QACjE,OAAO,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IACnE,CAAC;IAEe,KAAK,CAAC,QAAQ,CAC7B,YAA2B,EAC3B,UAAkB;QAElB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YAChB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAC5D,CAAC;QAED,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAEnC,8CAA8C;QAC9C,MAAM,kBAAkB,GAAG,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;QAEhD,kEAAkE;QAClE,4DAA4D;QAC5D,MAAM,aAAa,GAAG,IAAI,CAAC,0BAA0B,EAAE,CAAC;QACxD,IAAI,aAAa,EAAE,CAAC;YACnB,kBAAkB,CAAC,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE,CAAC,CAAC;QACxD,CAAC;QAED,uDAAuD;QACvD,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CACxB,IAAI,CAAC,IAAI,EACT,GAAG,kBAAkB,EACrB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAC7B,CAAC;QACH,CAAC;aACI,CAAC;YACL,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACrE,CAAC;IACF,CAAC;IAEM,KAAK,CAAC,aAAa,CACzB,OAAmB,EACnB,QAAqB,EACrB,IAAqB;QAErB,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QACjC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QAExD,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACjC,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAQM,KAAK,CAAC,YAAY,CAAC,OAAmB;QAC5C,wDAAwD;QACxD,6BAA6B;QAC7B,MAAM,IAAA,uCAAe,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;CACD;AA1FD,0CA0FC"}

package/router/endpoints/delete-endpoint.d.ts

@@ -0,0 +1,5 @@
+import { BaseApiEndpoint, EndpointMethod } from '../endpoint';
+export declare abstract class DeleteEndpoint extends BaseApiEndpoint {
+    method: EndpointMethod;
+    statusCode: number;
+}

package/router/endpoints/delete-endpoint.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeleteEndpoint = void 0;
+const endpoint_1 = require("../endpoint");
+class DeleteEndpoint extends endpoint_1.BaseApiEndpoint {
+    method = endpoint_1.EndpointMethod.DELETE;
+    statusCode = 204;
+}
+exports.DeleteEndpoint = DeleteEndpoint;
+//# sourceMappingURL=delete-endpoint.js.map

package/router/endpoints/delete-endpoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete-endpoint.js","sourceRoot":"","sources":["../../../../src/router/endpoints/delete-endpoint.ts"],"names":[],"mappings":";;;AAAA,0CAA8D;AAE9D,MAAsB,cAAe,SAAQ,0BAAe;IAClD,MAAM,GAAG,yBAAc,CAAC,MAAM,CAAC;IAC/B,UAAU,GAAG,GAAG,CAAC;CAC1B;AAHD,wCAGC"}

package/router/endpoints/get-endpoint.d.ts

@@ -0,0 +1,5 @@
+import { BaseApiEndpoint, EndpointMethod } from '../endpoint';
+export declare abstract class GetEndpoint extends BaseApiEndpoint {
+    method: EndpointMethod;
+    statusCode: number;
+}

package/router/endpoints/get-endpoint.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetEndpoint = void 0;
+const endpoint_1 = require("../endpoint");
+class GetEndpoint extends endpoint_1.BaseApiEndpoint {
+    method = endpoint_1.EndpointMethod.GET;
+    statusCode = 200;
+}
+exports.GetEndpoint = GetEndpoint;
+//# sourceMappingURL=get-endpoint.js.map

package/router/endpoints/get-endpoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-endpoint.js","sourceRoot":"","sources":["../../../../src/router/endpoints/get-endpoint.ts"],"names":[],"mappings":";;;AAAA,0CAA8D;AAE9D,MAAsB,WAAY,SAAQ,0BAAe;IAC/C,MAAM,GAAG,yBAAc,CAAC,GAAG,CAAC;IAC5B,UAAU,GAAG,GAAG,CAAC;CAC1B;AAHD,kCAGC"}

package/router/endpoints/health-check-endpoint.d.ts

@@ -0,0 +1,15 @@
+import { ApiRequest, ApiResponse } from '../endpoint';
+import { GetEndpoint } from './get-endpoint';
+export declare class HealthCheckEndpoint extends GetEndpoint {
+    path: string;
+    handle(_request: ApiRequest, _response: ApiResponse): Promise<{
+        status: string;
+        timestamp: string;
+        uptime: number;
+        environment: string;
+    }>;
+    getStatus(): Promise<string>;
+    getTimestamp(): Promise<string>;
+    getUptime(): Promise<number>;
+    getEnvironment(): Promise<string>;
+}

package/router/endpoints/health-check-endpoint.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthCheckEndpoint = void 0;
+const get_endpoint_1 = require("./get-endpoint");
+class HealthCheckEndpoint extends get_endpoint_1.GetEndpoint {
+    path = '/health';
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async handle(_request, _response) {
+        return {
+            status: await this.getStatus(),
+            timestamp: await this.getTimestamp(),
+            uptime: await this.getUptime(),
+            environment: await this.getEnvironment(),
+        };
+    }
+    async getStatus() {
+        return 'ok';
+    }
+    async getTimestamp() {
+        return new Date().toISOString();
+    }
+    async getUptime() {
+        return process.uptime();
+    }
+    async getEnvironment() {
+        return process.env['NODE_ENV'] || 'development';
+    }
+}
+exports.HealthCheckEndpoint = HealthCheckEndpoint;
+//# sourceMappingURL=health-check-endpoint.js.map

package/router/endpoints/health-check-endpoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health-check-endpoint.js","sourceRoot":"","sources":["../../../../src/router/endpoints/health-check-endpoint.ts"],"names":[],"mappings":";;;AACA,iDAA6C;AAE7C,MAAa,mBAAoB,SAAQ,0BAAW;IAC1C,IAAI,GAAG,SAAS,CAAC;IAE1B,6DAA6D;IAC7D,KAAK,CAAC,MAAM,CAAC,QAAoB,EAAE,SAAsB;QACxD,OAAO;YACN,MAAM,EAAE,MAAM,IAAI,CAAC,SAAS,EAAE;YAC9B,SAAS,EAAE,MAAM,IAAI,CAAC,YAAY,EAAE;YACpC,MAAM,EAAE,MAAM,IAAI,CAAC,SAAS,EAAE;YAC9B,WAAW,EAAE,MAAM,IAAI,CAAC,cAAc,EAAE;SACxC,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,SAAS;QACrB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,KAAK,CAAC,YAAY;QACxB,OAAO,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,SAAS;QACrB,OAAO,OAAO,CAAC,MAAM,EAAE,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,cAAc;QAC1B,OAAO,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,aAAa,CAAC;IACjD,CAAC;CACD;AA5BD,kDA4BC"}

package/router/endpoints/index.d.ts

@@ -0,0 +1,6 @@
+export { GetEndpoint } from './get-endpoint';
+export { PostEndpoint } from './post-endpoint';
+export { PutEndpoint } from './put-endpoint';
+export { DeleteEndpoint } from './delete-endpoint';
+export { PatchEndpoint } from './patch-endpoint';
+export { HealthCheckEndpoint } from './health-check-endpoint';

package/router/endpoints/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthCheckEndpoint = exports.PatchEndpoint = exports.DeleteEndpoint = exports.PutEndpoint = exports.PostEndpoint = exports.GetEndpoint = void 0;
+var get_endpoint_1 = require("./get-endpoint");
+Object.defineProperty(exports, "GetEndpoint", { enumerable: true, get: function () { return get_endpoint_1.GetEndpoint; } });
+var post_endpoint_1 = require("./post-endpoint");
+Object.defineProperty(exports, "PostEndpoint", { enumerable: true, get: function () { return post_endpoint_1.PostEndpoint; } });
+var put_endpoint_1 = require("./put-endpoint");
+Object.defineProperty(exports, "PutEndpoint", { enumerable: true, get: function () { return put_endpoint_1.PutEndpoint; } });
+var delete_endpoint_1 = require("./delete-endpoint");
+Object.defineProperty(exports, "DeleteEndpoint", { enumerable: true, get: function () { return delete_endpoint_1.DeleteEndpoint; } });
+var patch_endpoint_1 = require("./patch-endpoint");
+Object.defineProperty(exports, "PatchEndpoint", { enumerable: true, get: function () { return patch_endpoint_1.PatchEndpoint; } });
+var health_check_endpoint_1 = require("./health-check-endpoint");
+Object.defineProperty(exports, "HealthCheckEndpoint", { enumerable: true, get: function () { return health_check_endpoint_1.HealthCheckEndpoint; } });
+//# sourceMappingURL=index.js.map

package/router/endpoints/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/router/endpoints/index.ts"],"names":[],"mappings":";;;AAAA,+CAA6C;AAApC,2GAAA,WAAW,OAAA;AACpB,iDAA+C;AAAtC,6GAAA,YAAY,OAAA;AACrB,+CAA6C;AAApC,2GAAA,WAAW,OAAA;AACpB,qDAAmD;AAA1C,iHAAA,cAAc,OAAA;AACvB,mDAAiD;AAAxC,+GAAA,aAAa,OAAA;AACtB,iEAA8D;AAArD,4HAAA,mBAAmB,OAAA"}

package/router/endpoints/patch-endpoint.d.ts

@@ -0,0 +1,5 @@
+import { BaseApiEndpoint, EndpointMethod } from '../endpoint';
+export declare abstract class PatchEndpoint extends BaseApiEndpoint {
+    method: EndpointMethod;
+    statusCode: number;
+}

package/router/endpoints/patch-endpoint.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PatchEndpoint = void 0;
+const endpoint_1 = require("../endpoint");
+class PatchEndpoint extends endpoint_1.BaseApiEndpoint {
+    method = endpoint_1.EndpointMethod.PATCH;
+    statusCode = 200;
+}
+exports.PatchEndpoint = PatchEndpoint;
+//# sourceMappingURL=patch-endpoint.js.map

package/router/endpoints/patch-endpoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"patch-endpoint.js","sourceRoot":"","sources":["../../../../src/router/endpoints/patch-endpoint.ts"],"names":[],"mappings":";;;AAAA,0CAA8D;AAE9D,MAAsB,aAAc,SAAQ,0BAAe;IACjD,MAAM,GAAG,yBAAc,CAAC,KAAK,CAAC;IAC9B,UAAU,GAAG,GAAG,CAAC;CAC1B;AAHD,sCAGC"}

package/router/endpoints/post-endpoint.d.ts

@@ -0,0 +1,5 @@
+import { BaseApiEndpoint, EndpointMethod } from '../endpoint';
+export declare abstract class PostEndpoint extends BaseApiEndpoint {
+    method: EndpointMethod;
+    statusCode: number;
+}

package/router/endpoints/post-endpoint.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostEndpoint = void 0;
+const endpoint_1 = require("../endpoint");
+class PostEndpoint extends endpoint_1.BaseApiEndpoint {
+    method = endpoint_1.EndpointMethod.POST;
+    statusCode = 201;
+}
+exports.PostEndpoint = PostEndpoint;
+//# sourceMappingURL=post-endpoint.js.map

package/router/endpoints/post-endpoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"post-endpoint.js","sourceRoot":"","sources":["../../../../src/router/endpoints/post-endpoint.ts"],"names":[],"mappings":";;;AAAA,0CAA8D;AAE9D,MAAsB,YAAa,SAAQ,0BAAe;IAChD,MAAM,GAAG,yBAAc,CAAC,IAAI,CAAC;IAC7B,UAAU,GAAG,GAAG,CAAC;CAC1B;AAHD,oCAGC"}

package/router/endpoints/put-endpoint.d.ts

@@ -0,0 +1,5 @@
+import { BaseApiEndpoint, EndpointMethod } from '../endpoint';
+export declare abstract class PutEndpoint extends BaseApiEndpoint {
+    method: EndpointMethod;
+    statusCode: number;
+}

package/router/endpoints/put-endpoint.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PutEndpoint = void 0;
+const endpoint_1 = require("../endpoint");
+class PutEndpoint extends endpoint_1.BaseApiEndpoint {
+    method = endpoint_1.EndpointMethod.PUT;
+    statusCode = 200;
+}
+exports.PutEndpoint = PutEndpoint;
+//# sourceMappingURL=put-endpoint.js.map

package/router/endpoints/put-endpoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"put-endpoint.js","sourceRoot":"","sources":["../../../../src/router/endpoints/put-endpoint.ts"],"names":[],"mappings":";;;AAAA,0CAA8D;AAE9D,MAAsB,WAAY,SAAQ,0BAAe;IAC/C,MAAM,GAAG,yBAAc,CAAC,GAAG,CAAC;IAC5B,UAAU,GAAG,GAAG,CAAC;CAC1B;AAHD,kCAGC"}

package/router/index.d.ts

@@ -0,0 +1,3 @@
+export { ApiEndpoint, ApiRequest, ApiResponse, ApiNextFunction, BaseApiEndpoint, } from './endpoint';
+export { ApiRouter, BaseApiRouter } from './router';
+export { GetEndpoint, PostEndpoint, PutEndpoint, DeleteEndpoint, PatchEndpoint, HealthCheckEndpoint, } from './endpoints';

package/router/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthCheckEndpoint = exports.PatchEndpoint = exports.DeleteEndpoint = exports.PutEndpoint = exports.PostEndpoint = exports.GetEndpoint = exports.BaseApiRouter = exports.BaseApiEndpoint = void 0;
+var endpoint_1 = require("./endpoint");
+Object.defineProperty(exports, "BaseApiEndpoint", { enumerable: true, get: function () { return endpoint_1.BaseApiEndpoint; } });
+var router_1 = require("./router");
+Object.defineProperty(exports, "BaseApiRouter", { enumerable: true, get: function () { return router_1.BaseApiRouter; } });
+var endpoints_1 = require("./endpoints");
+Object.defineProperty(exports, "GetEndpoint", { enumerable: true, get: function () { return endpoints_1.GetEndpoint; } });
+Object.defineProperty(exports, "PostEndpoint", { enumerable: true, get: function () { return endpoints_1.PostEndpoint; } });
+Object.defineProperty(exports, "PutEndpoint", { enumerable: true, get: function () { return endpoints_1.PutEndpoint; } });
+Object.defineProperty(exports, "DeleteEndpoint", { enumerable: true, get: function () { return endpoints_1.DeleteEndpoint; } });
+Object.defineProperty(exports, "PatchEndpoint", { enumerable: true, get: function () { return endpoints_1.PatchEndpoint; } });
+Object.defineProperty(exports, "HealthCheckEndpoint", { enumerable: true, get: function () { return endpoints_1.HealthCheckEndpoint; } });
+//# sourceMappingURL=index.js.map

package/router/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/router/index.ts"],"names":[],"mappings":";;;AAAA,uCAMoB;AADnB,2GAAA,eAAe,OAAA;AAGhB,mCAAoD;AAAhC,uGAAA,aAAa,OAAA;AAEjC,yCAOqB;AANpB,wGAAA,WAAW,OAAA;AACX,yGAAA,YAAY,OAAA;AACZ,wGAAA,WAAW,OAAA;AACX,2GAAA,cAAc,OAAA;AACd,0GAAA,aAAa,OAAA;AACb,gHAAA,mBAAmB,OAAA"}

package/router/router.d.ts

@@ -0,0 +1,15 @@
+import { Router as ExpressRouter } from 'express';
+import { ApiRoute, BaseApiRoute } from './base';
+export declare abstract class BaseApiRouter extends BaseApiRoute {
+    protected router: ExpressRouter;
+    registeredRoutes: BaseApiRoute[];
+    protected abstract routes(): Promise<ApiRoute[]>;
+    protected routeInstances: {
+        [key: string]: BaseApiRoute;
+    };
+    getTag(): string;
+    register(parent: ExpressRouter, parentPath: string): Promise<void>;
+}
+export type ApiRouter = {
+    new (): BaseApiRouter;
+};

package/router/router.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseApiRouter = void 0;
+const express_1 = require("express");
+const base_1 = require("./base");
+const endpoint_1 = require("./endpoint");
+class BaseApiRouter extends base_1.BaseApiRoute {
+    router;
+    registeredRoutes = [];
+    routeInstances = {};
+    getTag() {
+        return this.name || this.constructor.name.replace(/Router$/, '');
+    }
+    async register(parent, parentPath) {
+        this.router = (0, express_1.Router)();
+        this.registerRoutePath(parentPath);
+        // Collect non-authentication middleware
+        // Authentication is handled at the endpoint level to allow overrides
+        const middlewareWithoutAuth = [...this.middleware];
+        // Register router with non-auth middleware if any
+        if (middlewareWithoutAuth.length > 0) {
+            parent.use(this.path, ...middlewareWithoutAuth, this.router);
+        }
+        else {
+            parent.use(this.path, this.router);
+        }
+        const routes = await this.routes();
+        // Track which paths have which methods
+        const pathMethods = new Map();
+        const tag = this.getTag();
+        // First pass: register all endpoints and track their methods
+        for (const route of routes) {
+            const instance = new route();
+            // Set parent relationship for authentication cascading
+            instance.parentRoute = this;
+            if (instance instanceof endpoint_1.BaseApiEndpoint) {
+                instance.tag = tag;
+            }
+            await instance.register(this.router, this.fullPath);
+            this.registeredRoutes.push(instance);
+            // Track endpoint methods for 405 handling
+            if (instance instanceof endpoint_1.BaseApiEndpoint) {
+                const path = instance.path;
+                if (!pathMethods.has(path)) {
+                    pathMethods.set(path, new Set());
+                }
+                pathMethods.get(path).add(instance.method);
+            }
+        }
+        // Second pass: add 405 handlers for unsupported methods
+        const allMethods = Object.values(endpoint_1.EndpointMethod);
+        pathMethods.forEach((supportedMethods, path) => {
+            allMethods.forEach((method) => {
+                if (!supportedMethods.has(method)) {
+                    this.router[method](path, (req, res) => {
+                        res.status(405).send({
+                            error: 'Method Not Allowed',
+                            message: `Method ${req.method} not allowed`,
+                        });
+                    });
+                }
+            });
+        });
+    }
+}
+exports.BaseApiRouter = BaseApiRouter;
+//# sourceMappingURL=router.js.map

package/router/router.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"router.js","sourceRoot":"","sources":["../../../src/router/router.ts"],"names":[],"mappings":";;;AAAA,qCAAkD;AAClD,iCAAgD;AAChD,yCAA6D;AAE7D,MAAsB,aAAc,SAAQ,mBAAY;IAC7C,MAAM,CAAgB;IAEzB,gBAAgB,GAAmB,EAAE,CAAC;IAEnC,cAAc,GAAoC,EAAE,CAAC;IAExD,MAAM;QACZ,OAAO,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IAClE,CAAC;IAEM,KAAK,CAAC,QAAQ,CACpB,MAAqB,EACrB,UAAkB;QAElB,IAAI,CAAC,MAAM,GAAG,IAAA,gBAAa,GAAE,CAAC;QAC9B,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAEnC,wCAAwC;QACxC,qEAAqE;QACrE,MAAM,qBAAqB,GAAG,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;QAEnD,kDAAkD;QAClD,IAAI,qBAAqB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,qBAAqB,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAC9D,CAAC;aACI,CAAC;YACL,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACpC,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QAEnC,uCAAuC;QACvC,MAAM,WAAW,GAAG,IAAI,GAAG,EAA+B,CAAC;QAC3D,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAE1B,6DAA6D;QAC7D,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC5B,MAAM,QAAQ,GAAG,IAAI,KAAK,EAAE,CAAC;YAE7B,uDAAuD;YACvD,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC;YAE5B,IAAI,QAAQ,YAAY,0BAAe,EAAE,CAAC;gBACzC,QAAQ,CAAC,GAAG,GAAG,GAAG,CAAC;YACpB,CAAC;YAED,MAAM,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAEpD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAErC,0CAA0C;YAC1C,IAAI,QAAQ,YAAY,0BAAe,EAAE,CAAC;gBACzC,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;gBAE3B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC5B,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;gBAClC,CAAC;gBAED,WAAW,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC7C,CAAC;QACF,CAAC;QAED,wDAAwD;QACxD,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,yBAAc,CAAC,CAAC;QACjD,WAAW,CAAC,OAAO,CAAC,CAAC,gBAAgB,EAAE,IAAI,EAAE,EAAE;YAC9C,UAAU,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;gBAC7B,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;oBACnC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;wBACtC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;4BACpB,KAAK,EAAE,oBAAoB;4BAC3B,OAAO,EAAE,UAAU,GAAG,CAAC,MAAM,cAAc;yBAC3C,CAAC,CAAC;oBACJ,CAAC,CAAC,CAAC;gBACJ,CAAC;YACF,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;CACD;AA9ED,sCA8EC"}

package/router/validation-middleware.d.ts

@@ -0,0 +1,13 @@
+import { ObjectSanitizer } from 'valsan';
+import { ApiRequest, BaseApiEndpoint } from './endpoint';
+/**
+ * Runs a valsan ObjectSanitizer on a value,
+ *  throws with error details if validation fails.
+ */
+export declare function runSanitizer(sanitizer: ObjectSanitizer, value: any): Promise<Record<string, unknown> | undefined>;
+/**
+ * Validates and sanitizes request parts
+ *  (body, query, params, headers) if the
+ *  endpoint defines a ObjectSanitizers
+ */
+export declare function validateRequest(endpoint: BaseApiEndpoint, request: ApiRequest): Promise<void>;

package/router/validation-middleware.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateRequest = exports.runSanitizer = void 0;
+const error_1 = require("../error");
+/**
+ * Runs a valsan ObjectSanitizer on a value,
+ *  throws with error details if validation fails.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+async function runSanitizer(sanitizer, value) {
+    const result = await sanitizer.run(value);
+    if (!result.success) {
+        throw new error_1.UnprocessableEntityError('Validation failed', {
+            details: result.errors,
+        });
+    }
+    return result.data;
+}
+exports.runSanitizer = runSanitizer;
+/**
+ * Validates and sanitizes request parts
+ *  (body, query, params, headers) if the
+ *  endpoint defines a ObjectSanitizers
+ */
+async function validateRequest(endpoint, request) {
+    for (const part of ['body', 'query', 'params', 'headers']) {
+        const sanitizer = endpoint[part];
+        if (!sanitizer) {
+            continue;
+        }
+        const sanitized = await runSanitizer(sanitizer, request[part]);
+        if (part === 'query') {
+            // Mutate the query object instead of reassigning
+            Object.keys(request.query).forEach((key) => {
+                delete request.query[key];
+            });
+            Object.assign(request.query, sanitized);
+        }
+        else {
+            request[part] = sanitized;
+        }
+    }
+}
+exports.validateRequest = validateRequest;
+//# sourceMappingURL=validation-middleware.js.map

package/router/validation-middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation-middleware.js","sourceRoot":"","sources":["../../../src/router/validation-middleware.ts"],"names":[],"mappings":";;;AAEA,oCAAoD;AAEpD;;;GAGG;AACH,8DAA8D;AACvD,KAAK,UAAU,YAAY,CAAC,SAA0B,EAAE,KAAU;IACxE,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAE1C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACrB,MAAM,IAAI,gCAAwB,CAAC,mBAAmB,EAAE;YACvD,OAAO,EAAE,MAAM,CAAC,MAAM;SACtB,CAAC,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC;AACpB,CAAC;AAVD,oCAUC;AAED;;;;GAIG;AACI,KAAK,UAAU,eAAe,CACpC,QAAyB,EACzB,OAAmB;IAEnB,KAAK,MAAM,IAAI,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAU,EAAE,CAAC;QACpE,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAEjC,IAAI,CAAC,SAAS,EAAE,CAAC;YAChB,SAAS;QACV,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QAE/D,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;YACtB,iDAAiD;YACjD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC1C,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACzC,CAAC;aACI,CAAC;YACL,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;QAC3B,CAAC;IACF,CAAC;AACF,CAAC;AAxBD,0CAwBC"}

package/server/index.d.ts

@@ -0,0 +1,2 @@
+export { RestServer } from './server';
+export { RestServerOptions, defaultRestServerOptions } from './server-options';

package/server/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultRestServerOptions = exports.RestServer = void 0;
+var server_1 = require("./server");
+Object.defineProperty(exports, "RestServer", { enumerable: true, get: function () { return server_1.RestServer; } });
+var server_options_1 = require("./server-options");
+Object.defineProperty(exports, "defaultRestServerOptions", { enumerable: true, get: function () { return server_options_1.defaultRestServerOptions; } });
+//# sourceMappingURL=index.js.map

package/server/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/server/index.ts"],"names":[],"mappings":";;;AAAA,mCAAsC;AAA7B,oGAAA,UAAU,OAAA;AACnB,mDAA+E;AAAnD,0HAAA,wBAAwB,OAAA"}

package/server/server-options.d.ts

@@ -0,0 +1,46 @@
+import { LogInterface } from '../log';
+import { AuthenticationScheme } from '../authentication/authentication-scheme';
+export interface SecurityHeadersOptions {
+    /**
+     * Disable the X-Powered-By header to prevent server fingerprinting
+     * @default true
+     */
+    disableXPoweredBy: boolean;
+    /**
+     * Set X-Content-Type-Options: nosniff to prevent MIME type sniffing
+     * @default true
+     */
+    noSniff: boolean;
+    /**
+     * Set X-Frame-Options header to prevent clickjacking
+     * Options: 'DENY', 'SAMEORIGIN', or false to disable
+     * @default 'DENY'
+     */
+    frameOptions: 'DENY' | 'SAMEORIGIN' | false;
+    /**
+     * Set X-XSS-Protection header for legacy browser protection
+     * @default true
+     */
+    xssProtection: boolean;
+    /**
+     * Set Strict-Transport-Security header (only use with HTTPS)
+     * Provide max-age value or false to disable
+     * @default false
+     */
+    hsts: number | false;
+}
+export interface RestServerOptions {
+    port: number;
+    maxPayloadSizeMB: number;
+    maxUrlEncodedSizeMB: number;
+    log: LogInterface;
+    securityHeaders: SecurityHeadersOptions;
+    swaggerEnabled?: boolean;
+    /**
+     * Server-level authentication scheme
+     * This will be applied to all routers and endpoints unless overridden
+     */
+    authentication?: AuthenticationScheme;
+}
+export declare const defaultSecurityHeadersOptions: SecurityHeadersOptions;
+export declare const defaultRestServerOptions: RestServerOptions;

package/server/server-options.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultRestServerOptions = exports.defaultSecurityHeadersOptions = void 0;
+exports.defaultSecurityHeadersOptions = {
+    disableXPoweredBy: true,
+    noSniff: true,
+    frameOptions: 'DENY',
+    xssProtection: true,
+    hsts: false, // Disabled by default, enable when using HTTPS
+};
+exports.defaultRestServerOptions = {
+    port: 5000,
+    maxPayloadSizeMB: 10,
+    maxUrlEncodedSizeMB: 1,
+    log: {
+        ...console,
+        // eslint-disable-next-line no-console
+        fatal: console.error,
+        // eslint-disable-next-line no-console
+        info: console.log,
+    },
+    securityHeaders: exports.defaultSecurityHeadersOptions,
+};
+//# sourceMappingURL=server-options.js.map

package/server/server-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server-options.js","sourceRoot":"","sources":["../../../src/server/server-options.ts"],"names":[],"mappings":";;;AAoDa,QAAA,6BAA6B,GAA2B;IACpE,iBAAiB,EAAE,IAAI;IACvB,OAAO,EAAE,IAAI;IACb,YAAY,EAAE,MAAM;IACpB,aAAa,EAAE,IAAI;IACnB,IAAI,EAAE,KAAK,EAAE,+CAA+C;CAC5D,CAAC;AAEW,QAAA,wBAAwB,GAAsB;IAC1D,IAAI,EAAE,IAAI;IACV,gBAAgB,EAAE,EAAE;IACpB,mBAAmB,EAAE,CAAC;IACtB,GAAG,EAAE;QACJ,GAAG,OAAO;QACV,sCAAsC;QACtC,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,sCAAsC;QACtC,IAAI,EAAE,OAAO,CAAC,GAAG;KACjB;IACD,eAAe,EAAE,qCAA6B;CAC9C,CAAC"}

package/server/server.d.ts

@@ -0,0 +1,38 @@
+/// <reference types="node" />
+import express from 'express';
+import http from 'http';
+import { RestServerOptions } from './server-options';
+import { ApiRouter, BaseApiRouter } from '../router';
+import { AuthenticationScheme } from '../authentication/authentication-scheme';
+import { LogInterface } from '../log';
+export declare abstract class RestServer {
+    name: string;
+    description: string;
+    version: string;
+    router: ApiRouter;
+    routerInstance: BaseApiRouter;
+    readonly port: number;
+    readonly maxPayloadSizeMB: number;
+    readonly maxUrlEncodedSizeMB: number;
+    readonly securityHeaders: RestServerOptions['securityHeaders'];
+    swaggerEnabled: boolean;
+    authentication?: AuthenticationScheme;
+    protected app: express.Express;
+    protected listener: http.Server;
+    protected log: LogInterface;
+    constructor(options: Partial<RestServerOptions>);
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    protected createRouter(): Promise<void>;
+    protected registerAuthentication(): Promise<void>;
+    protected registerRoutes(): Promise<void>;
+    protected registerSwagger(): Promise<void>;
+    protected setupExpress(): Promise<void>;
+    protected setupSecurityHeaders(): Promise<void>;
+    protected setupExpressCors(): Promise<void>;
+    protected setupExpressJson(): Promise<void>;
+    protected setupExpressUrlEncoded(): Promise<void>;
+    protected setup404Handler(): Promise<void>;
+    protected setupErrorHandler(): Promise<void>;
+    protected startListening(): Promise<void>;
+}