@spinajs/http-swagger 2.0.480 → 2.0.482

package/lib/mjs/swagger-service.d.ts

@@ -12,9 +12,27 @@ export declare class SwaggerService extends AsyncService {
     protected ControllersService: Controllers;
     protected DocCache: SwaggerDocCache;
     protected SwaggerConfig: ISwaggerConfig;
+    /**
+     * The global route prefix the runtime prepends to every controller route
+     * (see BaseController route registration). Documented paths must include it
+     * or Swagger "Try it out" hits the wrong URL. Only used as a fallback when
+     * an explicit swagger.basePath isn't configured.
+     */
+    protected RoutePrefix: string;
     private _spec;
+    /**
+     * In-flight build, shared so concurrent first requests don't each kick off a
+     * full (expensive) rebuild. Cleared once the build settles.
+     */
+    private _buildPromise;
     get IsEnabled(): boolean;
     resolve(): Promise<void>;
+    /**
+     * Drop the cached spec so the next getSpec() rebuilds it. Call after
+     * registering controllers at runtime (Controllers.add) so they appear in
+     * the documentation.
+     */
+    invalidate(): void;
     getSpec(): Promise<IOpenApiDocument | null>;
     /**
      * Rebuild the OpenAPI specification from current controllers.

package/lib/mjs/swagger-service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"swagger-service.d.ts","sourceRoot":"","sources":["../../src/swagger-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAyC,MAAM,aAAa,CAAC;AAElF,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAU,GAAG,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAEnE;;;GAGG;AACH,qBACa,cAAe,SAAQ,YAAY;IAE9C,SAAS,CAAC,GAAG,EAAG,GAAG,CAAC;IAGpB,SAAS,CAAC,kBAAkB,EAAG,WAAW,CAAC;IAG3C,SAAS,CAAC,QAAQ,EAAG,eAAe,CAAC;IAGrC,SAAS,CAAC,aAAa,EAAG,cAAc,CAAC;IAEzC,OAAO,CAAC,KAAK,CAAiC;IAE9C,IAAW,SAAS,IAAI,OAAO,CAE9B;IAEY,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxB,OAAO,IAAI,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAUxD;;OAEG;IACU,SAAS,IAAI,OAAO,CAAC,gBAAgB,CAAC;CAsBpD"}
+{"version":3,"file":"swagger-service.d.ts","sourceRoot":"","sources":["../../src/swagger-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAyC,MAAM,aAAa,CAAC;AAElF,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAU,GAAG,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAEnE;;;GAGG;AACH,qBACa,cAAe,SAAQ,YAAY;IAE9C,SAAS,CAAC,GAAG,EAAG,GAAG,CAAC;IAGpB,SAAS,CAAC,kBAAkB,EAAG,WAAW,CAAC;IAG3C,SAAS,CAAC,QAAQ,EAAG,eAAe,CAAC;IAGrC,SAAS,CAAC,aAAa,EAAG,cAAc,CAAC;IAEzC;;;;;OAKG;IAEH,SAAS,CAAC,WAAW,EAAG,MAAM,CAAC;IAE/B,OAAO,CAAC,KAAK,CAAiC;IAE9C;;;OAGG;IACH,OAAO,CAAC,aAAa,CAA0C;IAE/D,IAAW,SAAS,IAAI,OAAO,CAE9B;IAEY,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrC;;;;OAIG;IACI,UAAU,IAAI,IAAI;IAIZ,OAAO,IAAI,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAqBxD;;OAEG;IACU,SAAS,IAAI,OAAO,CAAC,gBAAgB,CAAC;CA6BpD"}

package/lib/mjs/swagger-service.js

@@ -21,6 +21,11 @@ let SwaggerService = class SwaggerService extends AsyncService {
     constructor() {
         super(...arguments);
         this._spec = null;
+        /**
+         * In-flight build, shared so concurrent first requests don't each kick off a
+         * full (expensive) rebuild. Cleared once the build settles.
+         */
+        this._buildPromise = null;
     }
     get IsEnabled() {
         return this.SwaggerConfig?.enabled !== false;
@@ -28,25 +33,49 @@ let SwaggerService = class SwaggerService extends AsyncService {
     async resolve() {
         await super.resolve();
     }
+    /**
+     * Drop the cached spec so the next getSpec() rebuilds it. Call after
+     * registering controllers at runtime (Controllers.add) so they appear in
+     * the documentation.
+     */
+    invalidate() {
+        this._spec = null;
+    }
     async getSpec() {
         if (!this.IsEnabled)
             return null;
-        if (!this._spec) {
+        if (this._spec)
+            return this._spec;
+        // Coalesce concurrent builds onto a single in-flight promise.
+        if (!this._buildPromise) {
             this.Log.info('Building Swagger/OpenAPI documentation...');
-            const spec = await this.buildSpec();
-            this.Log.info(`Swagger documentation ready. ${Object.keys(spec.paths ?? {}).length} paths documented.`);
+            this._buildPromise = this.buildSpec()
+                .then((spec) => {
+                this.Log.info(`Swagger documentation ready. ${Object.keys(spec.paths ?? {}).length} paths documented.`);
+                return spec;
+            })
+                .finally(() => {
+                this._buildPromise = null;
+            });
         }
+        await this._buildPromise;
         return this._spec;
     }
     /**
      * Rebuild the OpenAPI specification from current controllers.
      */
     async buildSpec() {
-        const config = this.SwaggerConfig || {
+        const baseConfig = this.SwaggerConfig || {
             enabled: true,
             title: 'API Documentation',
             version: '1.0.0',
         };
+        // Fall back to the runtime route prefix so documented paths match the
+        // actual mounted URLs when no explicit swagger.basePath is set.
+        const config = {
+            ...baseConfig,
+            basePath: baseConfig.basePath || this.RoutePrefix || '',
+        };
         const builder = await DI.resolve(OpenApiBuilder, [config]);
         const controllers = await this.ControllersService.Controllers;
         for (const controller of controllers) {
@@ -78,6 +107,10 @@ __decorate([
     Config('http.swagger'),
     __metadata("design:type", Object)
 ], SwaggerService.prototype, "SwaggerConfig", void 0);
+__decorate([
+    Config('http.controllers.route.prefix', { defaultValue: '' }),
+    __metadata("design:type", String)
+], SwaggerService.prototype, "RoutePrefix", void 0);
 SwaggerService = __decorate([
     Singleton()
 ], SwaggerService);

package/lib/mjs/swagger-service.js.map

@@ -1 +1 @@
-{"version":3,"file":"swagger-service.js","sourceRoot":"","sources":["../../src/swagger-service.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAClF,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAGtD;;;GAGG;AAEI,IAAM,cAAc,GAApB,MAAM,cAAe,SAAQ,YAAY;IAAzC;;QAaG,UAAK,GAA4B,IAAI,CAAC;IA6ChD,CAAC;IA3CC,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,aAAa,EAAE,OAAO,KAAK,KAAK,CAAC;IAC/C,CAAC;IAEM,KAAK,CAAC,OAAO;QAClB,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,OAAO;QAClB,IAAI,CAAC,IAAI,CAAC,SAAS;YAAE,OAAO,IAAI,CAAC;QACjC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAC;YAC3D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;YACpC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,gCAAgC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,oBAAoB,CAAC,CAAC;QAC1G,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS;QACpB,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,IAAI;YACnC,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,mBAAmB;YAC1B,OAAO,EAAE,OAAO;SACjB,CAAC;QAEF,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QAC3D,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC;QAE9D,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;YACrC,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBAC1D,OAAO,CAAC,aAAa,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YAC9C,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,gCAAgC,UAAU,CAAC,IAAI,KAAK,GAAG,EAAE,CAAC,CAAC;YAC3E,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;CACF,CAAA;AAxDW;IADT,MAAM,CAAC,cAAc,CAAC;8BACP,GAAG;2CAAC;AAGV;IADT,UAAU,EAAE;8BACkB,WAAW;0DAAC;AAGjC;IADT,UAAU,EAAE;8BACQ,eAAe;gDAAC;AAG3B;IADT,MAAM,CAAC,cAAc,CAAC;;qDACkB;AAX9B,cAAc;IAD1B,SAAS,EAAE;GACC,cAAc,CA0D1B"}
+{"version":3,"file":"swagger-service.js","sourceRoot":"","sources":["../../src/swagger-service.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAClF,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAGtD;;;GAGG;AAEI,IAAM,cAAc,GAApB,MAAM,cAAe,SAAQ,YAAY;IAAzC;;QAsBG,UAAK,GAA4B,IAAI,CAAC;QAE9C;;;WAGG;QACK,kBAAa,GAAqC,IAAI,CAAC;IAwEjE,CAAC;IAtEC,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,aAAa,EAAE,OAAO,KAAK,KAAK,CAAC;IAC/C,CAAC;IAEM,KAAK,CAAC,OAAO;QAClB,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,UAAU;QACf,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAEM,KAAK,CAAC,OAAO;QAClB,IAAI,CAAC,IAAI,CAAC,SAAS;YAAE,OAAO,IAAI,CAAC;QACjC,IAAI,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC,KAAK,CAAC;QAElC,8DAA8D;QAC9D,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAC;YAC3D,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,EAAE;iBAClC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;gBACb,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,gCAAgC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,oBAAoB,CAAC,CAAC;gBACxG,OAAO,IAAI,CAAC;YACd,CAAC,CAAC;iBACD,OAAO,CAAC,GAAG,EAAE;gBACZ,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;YAC5B,CAAC,CAAC,CAAC;QACP,CAAC;QAED,MAAM,IAAI,CAAC,aAAa,CAAC;QACzB,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS;QACpB,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,IAAI;YACvC,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,mBAAmB;YAC1B,OAAO,EAAE,OAAO;SACjB,CAAC;QAEF,sEAAsE;QACtE,gEAAgE;QAChE,MAAM,MAAM,GAAG;YACb,GAAG,UAAU;YACb,QAAQ,EAAE,UAAU,CAAC,QAAQ,IAAI,IAAI,CAAC,WAAW,IAAI,EAAE;SACxD,CAAC;QAEF,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QAC3D,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC;QAE9D,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;YACrC,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBAC1D,OAAO,CAAC,aAAa,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YAC9C,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,gCAAgC,UAAU,CAAC,IAAI,KAAK,GAAG,EAAE,CAAC,CAAC;YAC3E,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;CACF,CAAA;AAlGW;IADT,MAAM,CAAC,cAAc,CAAC;8BACP,GAAG;2CAAC;AAGV;IADT,UAAU,EAAE;8BACkB,WAAW;0DAAC;AAGjC;IADT,UAAU,EAAE;8BACQ,eAAe;gDAAC;AAG3B;IADT,MAAM,CAAC,cAAc,CAAC;;qDACkB;AAS/B;IADT,MAAM,CAAC,+BAA+B,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;;mDAC/B;AApBpB,cAAc;IAD1B,SAAS,EAAE;GACC,cAAc,CAoG1B"}