@acorex-platform/framework-server 0.0.10 → 0.0.15

package/swagger/src/lib/runtime-openapi-catalog.provider.js

@@ -0,0 +1,63 @@
+"use strict";
+var RuntimeOpenApiEntityCatalogProvider_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RuntimeOpenApiEntityCatalogProvider = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+//#region ---- Load catalog rows from entity storage ----
+const COMMAND_DEFINITION_ENTITY = 'PlatformManagement.CommandDefinition';
+const QUERY_DEFINITION_ENTITY = 'PlatformManagement.QueryDefinition';
+const CATALOG_TAKE = 10_000;
+let RuntimeOpenApiEntityCatalogProvider = RuntimeOpenApiEntityCatalogProvider_1 = class RuntimeOpenApiEntityCatalogProvider {
+    constructor(storage) {
+        this.storage = storage;
+        this.logger = new common_1.Logger(RuntimeOpenApiEntityCatalogProvider_1.name);
+    }
+    async loadCommands() {
+        return this.load(COMMAND_DEFINITION_ENTITY, 'command');
+    }
+    async loadQueries() {
+        return this.load(QUERY_DEFINITION_ENTITY, 'query');
+    }
+    async load(entityName, kind) {
+        if (!this.storage) {
+            return [];
+        }
+        try {
+            const page = await this.storage.query(entityName, { skip: 0, take: CATALOG_TAKE });
+            const items = (page.items ?? []);
+            return items
+                .map((row) => this.mapRow(row, kind))
+                .filter((entry) => entry != null);
+        }
+        catch (error) {
+            this.logger.warn(`Could not load ${entityName} for runtime OpenAPI: ${error instanceof Error ? error.message : String(error)}`);
+            return [];
+        }
+    }
+    mapRow(row, kind) {
+        const name = typeof row['name'] === 'string' ? row['name'].trim() : '';
+        if (!name || name.includes('${')) {
+            return null;
+        }
+        return {
+            name,
+            kind,
+            catalogTitle: typeof row['catalogTitle'] === 'string' ? row['catalogTitle'] : undefined,
+            description: typeof row['description'] === 'string' ? row['description'] : undefined,
+            executionMode: row['executionMode'],
+            active: row['active'] !== false,
+            inputOptionDefinitions: row['inputOptionDefinitions'],
+            outputOptionDefinitions: row['outputOptionDefinitions'],
+            categories: row['categories'],
+        };
+    }
+};
+exports.RuntimeOpenApiEntityCatalogProvider = RuntimeOpenApiEntityCatalogProvider;
+exports.RuntimeOpenApiEntityCatalogProvider = RuntimeOpenApiEntityCatalogProvider = RuntimeOpenApiEntityCatalogProvider_1 = tslib_1.__decorate([
+    (0, common_1.Injectable)(),
+    tslib_1.__param(0, (0, common_1.Optional)()),
+    tslib_1.__metadata("design:paramtypes", [Object])
+], RuntimeOpenApiEntityCatalogProvider);
+//#endregion
+//# sourceMappingURL=runtime-openapi-catalog.provider.js.map

package/swagger/src/lib/runtime-openapi-catalog.provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime-openapi-catalog.provider.js","sourceRoot":"","sources":["../../../../../../../libs/framework/server/swagger/src/lib/runtime-openapi-catalog.provider.ts"],"names":[],"mappings":";;;;;AAAA,2CAA8D;AAU9D,yDAAyD;AAEzD,MAAM,yBAAyB,GAAG,sCAAsC,CAAC;AACzE,MAAM,uBAAuB,GAAG,oCAAoC,CAAC;AACrE,MAAM,YAAY,GAAG,MAAM,CAAC;AAGrB,IAAM,mCAAmC,2CAAzC,MAAM,mCAAmC;IAG9C,YACc,OAA+D;QAA9C,YAAO,GAAP,OAAO,CAAuC;QAH5D,WAAM,GAAG,IAAI,eAAM,CAAC,qCAAmC,CAAC,IAAI,CAAC,CAAC;IAI5E,CAAC;IAEJ,KAAK,CAAC,YAAY;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,yBAAyB,EAAE,SAAS,CAAC,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,WAAW;QACf,OAAO,IAAI,CAAC,IAAI,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAEO,KAAK,CAAC,IAAI,CAChB,UAAkB,EAClB,IAAyB;QAEzB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;YACnF,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAA8B,CAAC;YAC9D,OAAO,KAAK;iBACT,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;iBACpC,MAAM,CAAC,CAAC,KAAK,EAAuC,EAAE,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;QAC3E,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,kBAAkB,UAAU,yBAC1B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CACvD,EAAE,CACH,CAAC;YACF,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;IAEO,MAAM,CACZ,GAA4B,EAC5B,IAAyB;QAEzB,MAAM,IAAI,GAAG,OAAO,GAAG,CAAC,MAAM,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvE,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACjC,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO;YACL,IAAI;YACJ,IAAI;YACJ,YAAY,EAAE,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS;YACvF,WAAW,EAAE,OAAO,GAAG,CAAC,aAAa,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS;YACpF,aAAa,EAAE,GAAG,CAAC,eAAe,CAA4C;YAC9E,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,KAAK,KAAK;YAC/B,sBAAsB,EAAE,GAAG,CAAC,wBAAwB,CAAwC;YAC5F,uBAAuB,EAAE,GAAG,CAAC,yBAAyB,CAAwC;YAC9F,UAAU,EAAE,GAAG,CAAC,YAAY,CAAyC;SACtE,CAAC;IACJ,CAAC;CACF,CAAA;AA5DY,kFAAmC;8CAAnC,mCAAmC;IAD/C,IAAA,mBAAU,GAAE;IAKR,mBAAA,IAAA,iBAAQ,GAAE,CAAA;;GAJF,mCAAmC,CA4D/C;AAED,YAAY"}

package/swagger/src/lib/runtime-openapi.controller.d.ts

@@ -0,0 +1,20 @@
+import type { OpenAPIObject } from '@nestjs/swagger/dist/interfaces/open-api-spec.interface';
+import { RuntimeOpenApiService } from './runtime-openapi.service';
+import type { EntitySwaggerManifest, SwaggerDocumentOptions } from './swagger.types';
+export interface RuntimeOpenApiControllerOptions {
+    document: SwaggerDocumentOptions;
+    globalPrefix: string;
+    entityManifests: EntitySwaggerManifest[];
+}
+/**
+ * Serves the generated runtime OpenAPI document for Postman import / tooling.
+ * Document options are set by {@link configureSwagger} after bootstrap.
+ */
+export declare class RuntimeOpenApiController {
+    private readonly runtimeOpenApi;
+    private options;
+    constructor(runtimeOpenApi: RuntimeOpenApiService);
+    configure(options: RuntimeOpenApiControllerOptions): void;
+    getRuntimeOpenApi(): Promise<OpenAPIObject>;
+}
+//# sourceMappingURL=runtime-openapi.controller.d.ts.map

package/swagger/src/lib/runtime-openapi.controller.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime-openapi.controller.d.ts","sourceRoot":"","sources":["../../../../../../../libs/framework/server/swagger/src/lib/runtime-openapi.controller.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yDAAyD,CAAC;AAC7F,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,KAAK,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAMrF,MAAM,WAAW,+BAA+B;IAC9C,QAAQ,EAAE,sBAAsB,CAAC;IACjC,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,qBAAqB,EAAE,CAAC;CAC1C;AAED;;;GAGG;AACH,qBAEa,wBAAwB;IAGvB,OAAO,CAAC,QAAQ,CAAC,cAAc;IAF3C,OAAO,CAAC,OAAO,CAAgD;gBAElC,cAAc,EAAE,qBAAqB;IAElE,SAAS,CAAC,OAAO,EAAE,+BAA+B,GAAG,IAAI;IAOnD,iBAAiB,IAAI,OAAO,CAAC,aAAa,CAAC;CAelD"}

package/swagger/src/lib/runtime-openapi.controller.js

@@ -0,0 +1,48 @@
+"use strict";
+//#region ---- Imports ----
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RuntimeOpenApiController = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const swagger_1 = require("@nestjs/swagger");
+const runtime_openapi_service_1 = require("./runtime-openapi.service");
+/**
+ * Serves the generated runtime OpenAPI document for Postman import / tooling.
+ * Document options are set by {@link configureSwagger} after bootstrap.
+ */
+let RuntimeOpenApiController = class RuntimeOpenApiController {
+    constructor(runtimeOpenApi) {
+        this.runtimeOpenApi = runtimeOpenApi;
+        this.options = null;
+    }
+    configure(options) {
+        this.options = options;
+        this.runtimeOpenApi.clearCache();
+    }
+    async getRuntimeOpenApi() {
+        const opts = this.options ?? {
+            document: {
+                title: 'ACoreX Runtime Commands & Queries',
+                version: '1.0',
+            },
+            globalPrefix: 'api',
+            entityManifests: [],
+        };
+        return this.runtimeOpenApi.getDocument(opts.document, opts.globalPrefix, opts.entityManifests);
+    }
+};
+exports.RuntimeOpenApiController = RuntimeOpenApiController;
+tslib_1.__decorate([
+    (0, common_1.Get)('v1/openapi/runtime.json'),
+    (0, common_1.Header)('Content-Type', 'application/json'),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", Promise)
+], RuntimeOpenApiController.prototype, "getRuntimeOpenApi", null);
+exports.RuntimeOpenApiController = RuntimeOpenApiController = tslib_1.__decorate([
+    (0, swagger_1.ApiExcludeController)(),
+    (0, common_1.Controller)(),
+    tslib_1.__metadata("design:paramtypes", [runtime_openapi_service_1.RuntimeOpenApiService])
+], RuntimeOpenApiController);
+//#endregion
+//# sourceMappingURL=runtime-openapi.controller.js.map

package/swagger/src/lib/runtime-openapi.controller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime-openapi.controller.js","sourceRoot":"","sources":["../../../../../../../libs/framework/server/swagger/src/lib/runtime-openapi.controller.ts"],"names":[],"mappings":";AAAA,2BAA2B;;;;AAE3B,2CAAyD;AACzD,6CAAuD;AAEvD,uEAAkE;AAalE;;;GAGG;AAGI,IAAM,wBAAwB,GAA9B,MAAM,wBAAwB;IAGnC,YAA6B,cAAqC;QAArC,mBAAc,GAAd,cAAc,CAAuB;QAF1D,YAAO,GAA2C,IAAI,CAAC;IAEM,CAAC;IAEtE,SAAS,CAAC,OAAwC;QAChD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;IACnC,CAAC;IAIK,AAAN,KAAK,CAAC,iBAAiB;QACrB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,IAAI;YAC3B,QAAQ,EAAE;gBACR,KAAK,EAAE,mCAAmC;gBAC1C,OAAO,EAAE,KAAK;aACf;YACD,YAAY,EAAE,KAAK;YACnB,eAAe,EAAE,EAAE;SACpB,CAAC;QACF,OAAO,IAAI,CAAC,cAAc,CAAC,WAAW,CACpC,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,eAAe,CACrB,CAAC;IACJ,CAAC;CACF,CAAA;AA3BY,4DAAwB;AAY7B;IAFL,IAAA,YAAG,EAAC,yBAAyB,CAAC;IAC9B,IAAA,eAAM,EAAC,cAAc,EAAE,kBAAkB,CAAC;;;;iEAe1C;mCA1BU,wBAAwB;IAFpC,IAAA,8BAAoB,GAAE;IACtB,IAAA,mBAAU,GAAE;6CAIkC,+CAAqB;GAHvD,wBAAwB,CA2BpC;AAED,YAAY"}

package/swagger/src/lib/runtime-openapi.module.d.ts

@@ -0,0 +1,3 @@
+export declare class RuntimeOpenApiModule {
+}
+//# sourceMappingURL=runtime-openapi.module.d.ts.map

package/swagger/src/lib/runtime-openapi.module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime-openapi.module.d.ts","sourceRoot":"","sources":["../../../../../../../libs/framework/server/swagger/src/lib/runtime-openapi.module.ts"],"names":[],"mappings":"AASA,qBAaa,oBAAoB;CAAG"}

package/swagger/src/lib/runtime-openapi.module.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RuntimeOpenApiModule = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const core_1 = require("@acorex-platform/framework-server/core");
+const swagger_tokens_1 = require("./swagger.tokens");
+const runtime_openapi_catalog_provider_1 = require("./runtime-openapi-catalog.provider");
+const runtime_openapi_controller_1 = require("./runtime-openapi.controller");
+const runtime_openapi_service_1 = require("./runtime-openapi.service");
+//#region ---- Runtime OpenAPI module ----
+let RuntimeOpenApiModule = class RuntimeOpenApiModule {
+};
+exports.RuntimeOpenApiModule = RuntimeOpenApiModule;
+exports.RuntimeOpenApiModule = RuntimeOpenApiModule = tslib_1.__decorate([
+    (0, common_1.Module)({
+        imports: [core_1.EntityStorageModule],
+        controllers: [runtime_openapi_controller_1.RuntimeOpenApiController],
+        providers: [
+            runtime_openapi_service_1.RuntimeOpenApiService,
+            runtime_openapi_catalog_provider_1.RuntimeOpenApiEntityCatalogProvider,
+            {
+                provide: swagger_tokens_1.AXP_RUNTIME_OPENAPI_CATALOG,
+                useExisting: runtime_openapi_catalog_provider_1.RuntimeOpenApiEntityCatalogProvider,
+            },
+        ],
+        exports: [runtime_openapi_service_1.RuntimeOpenApiService, swagger_tokens_1.AXP_RUNTIME_OPENAPI_CATALOG],
+    })
+], RuntimeOpenApiModule);
+//#endregion
+//# sourceMappingURL=runtime-openapi.module.js.map

package/swagger/src/lib/runtime-openapi.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime-openapi.module.js","sourceRoot":"","sources":["../../../../../../../libs/framework/server/swagger/src/lib/runtime-openapi.module.ts"],"names":[],"mappings":";;;;AAAA,2CAAwC;AACxC,iEAA6E;AAC7E,qDAA+D;AAC/D,yFAAyF;AACzF,6EAAwE;AACxE,uEAAkE;AAElE,0CAA0C;AAenC,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;CAAG,CAAA;AAAvB,oDAAoB;+BAApB,oBAAoB;IAbhC,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,0BAAmB,CAAC;QAC9B,WAAW,EAAE,CAAC,qDAAwB,CAAC;QACvC,SAAS,EAAE;YACT,+CAAqB;YACrB,sEAAmC;YACnC;gBACE,OAAO,EAAE,4CAA2B;gBACpC,WAAW,EAAE,sEAAmC;aACjD;SACF;QACD,OAAO,EAAE,CAAC,+CAAqB,EAAE,4CAA2B,CAAC;KAC9D,CAAC;GACW,oBAAoB,CAAG;AAEpC,YAAY"}

package/swagger/src/lib/runtime-openapi.service.d.ts

@@ -0,0 +1,33 @@
+import type { OpenAPIObject } from '@nestjs/swagger/dist/interfaces/open-api-spec.interface';
+import { DomainDefinitionLoader, type AXPServerCommandRegistry, type AXPServerQueryRegistry } from '@acorex-platform/framework-server/domain/abstract';
+import { DomainEntityCatalogRegistry, type AXPDomainEntityCatalog } from '@acorex-platform/framework-server/domain/seed';
+import type { EntitySwaggerManifest, SwaggerDocumentOptions } from './swagger.types';
+import type { RuntimeOpenApiCatalogProvider } from './runtime-openapi.types';
+export declare class RuntimeOpenApiService {
+    private readonly domainLoader;
+    private readonly catalogProvider;
+    private readonly commandRegistry;
+    private readonly queryRegistry;
+    private readonly entityCatalogRegistry;
+    private readonly extraEntityCatalogs;
+    private readonly logger;
+    private cached;
+    constructor(domainLoader: DomainDefinitionLoader, catalogProvider: RuntimeOpenApiCatalogProvider | null, commandRegistry: AXPServerCommandRegistry | null, queryRegistry: AXPServerQueryRegistry | null, entityCatalogRegistry: DomainEntityCatalogRegistry | null, extraEntityCatalogs: readonly AXPDomainEntityCatalog[] | null);
+    clearCache(): void;
+    getDocument(documentOptions: SwaggerDocumentOptions, globalPrefix?: string, entityManifests?: EntitySwaggerManifest[]): Promise<OpenAPIObject>;
+    buildDocument(documentOptions: SwaggerDocumentOptions, globalPrefix?: string, entityManifests?: EntitySwaggerManifest[]): Promise<OpenAPIObject>;
+    private loadCatalogEntries;
+    private shouldExposeCatalogEntry;
+    private addEnvelopePaths;
+    private addCatalogOperation;
+    private addEntityOperationsFromManifest;
+    private addEntityOperationsFromDomainCatalogs;
+    private addEntityCrudOperations;
+    private entityOperationInputSchema;
+    private addRegistryOnlyKeys;
+    private pathExistsForKey;
+    private tagForEntry;
+    private moduleFromKey;
+    private loadEntityDefinition;
+}
+//# sourceMappingURL=runtime-openapi.service.d.ts.map

package/swagger/src/lib/runtime-openapi.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime-openapi.service.d.ts","sourceRoot":"","sources":["../../../../../../../libs/framework/server/swagger/src/lib/runtime-openapi.service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yDAAyD,CAAC;AAK7F,OAAO,EACL,sBAAsB,EAItB,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC5B,MAAM,mDAAmD,CAAC;AAC3D,OAAO,EAGL,2BAA2B,EAC3B,KAAK,sBAAsB,EAC5B,MAAM,+CAA+C,CAAC;AAGvD,OAAO,KAAK,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AACrF,OAAO,KAAK,EAEV,6BAA6B,EAC9B,MAAM,yBAAyB,CAAC;AAuCjC,qBACa,qBAAqB;IAK9B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAG7B,OAAO,CAAC,QAAQ,CAAC,eAAe;IAGhC,OAAO,CAAC,QAAQ,CAAC,eAAe;IAGhC,OAAO,CAAC,QAAQ,CAAC,aAAa;IAE9B,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IAGtC,OAAO,CAAC,QAAQ,CAAC,mBAAmB;IAlBtC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA0C;IACjE,OAAO,CAAC,MAAM,CAA8B;gBAGzB,YAAY,EAAE,sBAAsB,EAGpC,eAAe,EAAE,6BAA6B,GAAG,IAAI,EAGrD,eAAe,EAAE,wBAAwB,GAAG,IAAI,EAGhD,aAAa,EAAE,sBAAsB,GAAG,IAAI,EAE5C,qBAAqB,EAAE,2BAA2B,GAAG,IAAI,EAGzD,mBAAmB,EAAE,SAAS,sBAAsB,EAAE,GAAG,IAAI;IAGhF,UAAU,IAAI,IAAI;IAIZ,WAAW,CACf,eAAe,EAAE,sBAAsB,EACvC,YAAY,GAAE,MAA8B,EAC5C,eAAe,GAAE,qBAAqB,EAAO,GAC5C,OAAO,CAAC,aAAa,CAAC;IAOnB,aAAa,CACjB,eAAe,EAAE,sBAAsB,EACvC,YAAY,GAAE,MAA8B,EAC5C,eAAe,GAAE,qBAAqB,EAAO,GAC5C,OAAO,CAAC,aAAa,CAAC;YAwDX,kBAAkB;IAWhC,OAAO,CAAC,wBAAwB;IAUhC,OAAO,CAAC,gBAAgB;IAsJxB,OAAO,CAAC,mBAAmB;YAoEb,+BAA+B;YAmB/B,qCAAqC;YAgCrC,uBAAuB;IAgErC,OAAO,CAAC,0BAA0B;IAwDlC,OAAO,CAAC,mBAAmB;IAmC3B,OAAO,CAAC,gBAAgB;IASxB,OAAO,CAAC,WAAW;IASnB,OAAO,CAAC,aAAa;YAQP,oBAAoB;CAYnC"}