equipped 5.0.0-alpha.1 → 5.0.0-alpha.2

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [5.0.0-alpha.2](https://github.com/kevinand11/equipped/compare/v5.0.0-alpha.1...v5.0.0-alpha.2) (2024-06-16)
+
+
+### Features
+
+* open api base url ([2a1becf](https://github.com/kevinand11/equipped/commit/2a1becf5f18f2b62ec5b2aada4c14db349e449bc))
+
 ## [5.0.0-alpha.1](https://github.com/kevinand11/equipped/compare/v5.0.0-beta.17...v5.0.0-alpha.1) (2024-06-09)
 
 ## [5.0.0-beta.17](https://github.com/kevinand11/equipped/compare/v5.0.0-beta.16...v5.0.0-beta.17) (2024-06-03)

package/lib/instance/settings.d.ts

@@ -25,7 +25,8 @@ export type Settings = {
     paginationDefaultLimit: number;
     server: ServerTypes;
     openapiDocsVersion: string;
-    openapiDocsUrl: string;
+    openapiDocsBaseUrl: string[];
+    openapiDocsPath: string;
     logLevel: Level;
     logRequests: boolean;
     requestSchemaValidation: boolean;

package/lib/instance/settings.js

@@ -26,7 +26,8 @@ exports.defaulInstanceSetting = {
     paginationDefaultLimit: 100,
     server: 'express',
     openapiDocsVersion: '1.0.0',
-    openapiDocsUrl: '/__docs',
+    openapiDocsBaseUrl: ['/'],
+    openapiDocsPath: '/__docs',
     logLevel: 'info',
     logRequests: true,
     requestSchemaValidation: false,

package/lib/server/impls/base.js

@@ -35,6 +35,7 @@ class Server {
         this.baseOpenapiDoc = {
             openapi: '3.0.0',
             info: { title: this.settings.appId, version: this.settings.openapiDocsVersion },
+            servers: this.settings.openapiDocsBaseUrl.map((url) => ({ url })),
             paths: {},
             components: {
                 schemas: {},

package/lib/server/impls/express.js

@@ -40,7 +40,7 @@ class ExpressServer extends base_1.Server {
         const app = (0, express_1.default)();
         super(http_1.default.createServer(app));
         _ExpressServer_expressApp.set(this, void 0);
-        _ExpressServer_oapi.set(this, (0, openapi_1.default)(`${this.settings.openapiDocsUrl}/json`, this.baseOpenapiDoc, { coerce: false }));
+        _ExpressServer_oapi.set(this, (0, openapi_1.default)(`${this.settings.openapiDocsPath}/json`, this.baseOpenapiDoc, { coerce: false }));
         _ExpressServer_ref.set(this, (0, json_schema_resolver_1.default)({ clone: true }));
         __classPrivateFieldSet(this, _ExpressServer_expressApp, app, "f");
         app.disable('x-powered-by');
@@ -54,7 +54,7 @@ class ExpressServer extends base_1.Server {
         app.use(express_1.default.urlencoded({ extended: false }));
         app.use(express_1.default.static(this.staticPath));
         app.use(__classPrivateFieldGet(this, _ExpressServer_oapi, "f"));
-        app.use(this.settings.openapiDocsUrl, __classPrivateFieldGet(this, _ExpressServer_oapi, "f").swaggerui());
+        app.use(this.settings.openapiDocsPath, __classPrivateFieldGet(this, _ExpressServer_oapi, "f").swaggerui());
         app.use((0, express_fileupload_1.default)({
             limits: { fileSize: this.settings.maxFileUploadSizeInMb * 1024 * 1024 },
             useTempFiles: false

package/lib/server/impls/fastify.js

@@ -38,6 +38,7 @@ const base_1 = require("./base");
 function getFastifyApp() {
     const instance = instance_1.Instance.get();
     return (0, fastify_1.default)({
+        caseSensitive: false,
         logger: instance.settings.logRequests ? instance.logger : false,
         ajv: { customOptions: { coerceTypes: false } },
         schemaErrorFormatter: (errors, data) => new errors_1.ValidationError(errors.map((error) => ({ messages: [error.message ?? ''], field: `${data}${error.instancePath}`.replaceAll('/', '.') })))
@@ -54,7 +55,7 @@ class FastifyServer extends base_1.Server {
         app.register(cookie_1.default, {});
         app.register(cors_1.default, { origin: '*' });
         app.register(swagger_1.default, { openapi: this.baseOpenapiDoc });
-        app.register(swagger_ui_1.default, { routePrefix: this.settings.openapiDocsUrl });
+        app.register(swagger_ui_1.default, { routePrefix: this.settings.openapiDocsPath });
         app.register(formbody_1.default, { parser: (str) => qs_1.default.parse(str) });
         app.register(helmet_1.default, { crossOriginResourcePolicy: { policy: 'cross-origin' } });
         app.register(multipart_1.default, {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "equipped",
-	"version": "5.0.0-alpha.1",
+	"version": "5.0.0-alpha.2",
 	"private": false,
 	"description": "",
 	"main": "lib/index.js",