@revisium/endpoint 2.2.0-alpha.3 → 2.2.0

package/dist/src/endpoint-microservice/restapi/queries/handlers/get-open-api-schema.handler.js

@@ -16,22 +16,24 @@ const internal_core_api_service_1 = require("../../../core-api/internal-core-api
 const impl_1 = require("../impl");
 const lib_1 = require("@revisium/schema-toolkit/lib");
 const system_tables_consts_1 = require("../../../shared/system-tables.consts");
-const open_api_shema_utils_1 = require("./open-api-shema.utils");
+const open_api_schema_utils_1 = require("./open-api-schema.utils");
 const HARDCODED_LIMIT_FOR_TABLES = 1000;
 let GetOpenApiSchemaHandler = class GetOpenApiSchemaHandler {
     constructor(internalCoreApi) {
         this.internalCoreApi = internalCoreApi;
     }
     execute({ data }) {
-        return this.getOpenApiSchema(data.revisionId);
+        return this.getOpenApiSchema(data.revisionId, data.projectName);
     }
-    async getOpenApiSchema(revisionId) {
+    async getOpenApiSchema(revisionId, projectName) {
         const schemas = await this.getSchemas(revisionId);
         const isDraftRevision = await this.getIsDraftRevision(revisionId);
+        const tableInfoMap = (0, open_api_schema_utils_1.createTableInfoMap)(schemas.map((s) => s.id), projectName);
         const openApiJson = {
-            openapi: '3.0.2',
+            openapi: '3.1.0',
             info: { version: revisionId, title: '' },
             servers: [],
+            tags: this.createTags(tableInfoMap),
             paths: {},
             components: {
                 securitySchemes: {
@@ -41,48 +43,45 @@ let GetOpenApiSchemaHandler = class GetOpenApiSchemaHandler {
                         type: 'http',
                     },
                 },
-                schemas: {},
+                schemas: {
+                    ...(0, open_api_schema_utils_1.getFilterAndSortSchemas)(projectName),
+                },
             },
         };
-        if (!openApiJson.paths) {
-            openApiJson.paths = {};
-        }
+        openApiJson.paths ??= {};
         for (const schemaRow of schemas) {
-            const schemaId = schemaRow.id;
-            openApiJson.paths[`/${schemaId}`] = (0, open_api_shema_utils_1.createGetListPath)(schemaId);
-            openApiJson.paths[`/${schemaId}/{id}`] = {
-                ...(0, open_api_shema_utils_1.createGetByIdPath)(schemaId),
-                ...(isDraftRevision ? (0, open_api_shema_utils_1.createCRUDPaths)(schemaId) : {}),
-            };
-            const foreignKeys = await this.getForeignKeys(revisionId, schemaId);
-            for (const fk of foreignKeys) {
-                openApiJson.paths[`/${schemaId}/{id}/foreign-keys-by/${fk.id}`] = {
-                    get: {
-                        security: [{ 'access-token': [] }],
-                        tags: [schemaId],
-                        parameters: [(0, open_api_shema_utils_1.getIdPathParam)(), ...(0, open_api_shema_utils_1.getPaginationParams)()],
-                        responses: {
-                            '200': {
-                                content: {
-                                    'application/json': {
-                                        schema: (0, open_api_shema_utils_1.getPaginatedResponseSchema)(),
-                                    },
-                                },
-                            },
-                        },
-                    },
-                };
+            const rawTableId = schemaRow.id;
+            const info = tableInfoMap.get(rawTableId);
+            if (!info) {
+                continue;
             }
-            if (!openApiJson.components) {
-                openApiJson.components = { schemas: {} };
+            openApiJson.paths[`/tables/${rawTableId}/rows`] = (0, open_api_schema_utils_1.createTableRowsPath)(info, projectName, isDraftRevision);
+            openApiJson.paths[`/tables/${rawTableId}/row/{rowId}`] =
+                (0, open_api_schema_utils_1.createSingleRowPath)(info, projectName, isDraftRevision);
+            if (isDraftRevision) {
+                openApiJson.paths[`/tables/${rawTableId}/row/{rowId}/files/{fileId}`] =
+                    (0, open_api_schema_utils_1.createFileUploadPath)(info);
             }
-            if (!openApiJson.components.schemas) {
-                openApiJson.components.schemas = {};
+            const foreignKeys = await this.getForeignKeys(revisionId, rawTableId);
+            for (const fk of foreignKeys) {
+                const fkInfo = tableInfoMap.get(fk.id);
+                if (!fkInfo) {
+                    continue;
+                }
+                openApiJson.paths[`/tables/${rawTableId}/row/{rowId}/foreign-keys-by/${fk.id}`] = (0, open_api_schema_utils_1.createForeignKeyPath)(info, fkInfo);
             }
-            openApiJson.components.schemas[schemaRow.id] = (0, lib_1.resolveRefs)(schemaRow.data);
+            openApiJson.components ??= { schemas: {} };
+            openApiJson.components.schemas ??= {};
+            openApiJson.components.schemas[info.schemaName] = (0, lib_1.resolveRefs)(schemaRow.data);
         }
         return openApiJson;
     }
+    createTags(tableInfoMap) {
+        return Array.from(tableInfoMap.values()).map((info) => ({
+            name: info.tag,
+            description: `Operations on ${info.rawTableId} table`,
+        }));
+    }
     async getIsDraftRevision(revisionId) {
         const { data, error } = await this.internalCoreApi.api.revision(revisionId);
         if (error) {

package/dist/src/endpoint-microservice/restapi/queries/handlers/get-open-api-schema.handler.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-open-api-schema.handler.js","sourceRoot":"","sources":["../../../../../../src/endpoint-microservice/restapi/queries/handlers/get-open-api-schema.handler.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA+C;AAC/C,uCAA2D;AAC3D,2FAAsG;AACtG,kCAAuF;AACvF,sDAA2D;AAE3D,+EAAqF;AAErF,iEAOgC;AAEhC,MAAM,0BAA0B,GAAG,IAAI,CAAC;AAGjC,IAAM,uBAAuB,GAA7B,MAAM,uBAAuB;IAGlC,YACmB,eAAuC;QAAvC,oBAAe,GAAf,eAAe,CAAwB;IACvD,CAAC;IAEG,OAAO,CAAC,EAAE,IAAI,EAAyB;QAC5C,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAChD,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,UAAkB;QAC/C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAClD,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAElE,MAAM,WAAW,GAAkB;YACjC,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,EAAE;YACxC,OAAO,EAAE,EAAE;YACX,KAAK,EAAE,EAAE;YACT,UAAU,EAAE;gBACV,eAAe,EAAE;oBACf,cAAc,EAAE;wBACd,MAAM,EAAE,QAAQ;wBAChB,YAAY,EAAE,KAAK;wBACnB,IAAI,EAAE,MAAM;qBACb;iBACF;gBACD,OAAO,EAAE,EAAE;aACZ;SACF,CAAC;QAEF,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;YACvB,WAAW,CAAC,KAAK,GAAG,EAAE,CAAC;QACzB,CAAC;QAED,KAAK,MAAM,SAAS,IAAI,OAAO,EAAE,CAAC;YAChC,MAAM,QAAQ,GAAG,SAAS,CAAC,EAAE,CAAC;YAE9B,WAAW,CAAC,KAAK,CAAC,IAAI,QAAQ,EAAE,CAAC,GAAG,IAAA,wCAAiB,EAAC,QAAQ,CAAC,CAAC;YAEhE,WAAW,CAAC,KAAK,CAAC,IAAI,QAAQ,OAAO,CAAC,GAAG;gBACvC,GAAG,IAAA,wCAAiB,EAAC,QAAQ,CAAC;gBAC9B,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,IAAA,sCAAe,EAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;aACtD,CAAC;YAEF,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YAEpE,KAAK,MAAM,EAAE,IAAI,WAAW,EAAE,CAAC;gBAC7B,WAAW,CAAC,KAAK,CAAC,IAAI,QAAQ,yBAAyB,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG;oBAChE,GAAG,EAAE;wBACH,QAAQ,EAAE,CAAC,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC;wBAClC,IAAI,EAAE,CAAC,QAAQ,CAAC;wBAChB,UAAU,EAAE,CAAC,IAAA,qCAAc,GAAE,EAAE,GAAG,IAAA,0CAAmB,GAAE,CAAC;wBACxD,SAAS,EAAE;4BACT,KAAK,EAAE;gCACL,OAAO,EAAE;oCACP,kBAAkB,EAAE;wCAClB,MAAM,EAAE,IAAA,iDAA0B,GAAE;qCACrC;iCACF;6BACF;yBACF;qBACF;iBACF,CAAC;YACJ,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;gBAC5B,WAAW,CAAC,UAAU,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;YAC3C,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;gBACpC,WAAW,CAAC,UAAU,CAAC,OAAO,GAAG,EAAE,CAAC;YACtC,CAAC;YACD,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,GAAG,IAAA,iBAAW,EACxD,SAAS,CAAC,IAAkB,CAC7B,CAAC;QACJ,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,UAAkB;QACjD,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAE5E,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,IAAI,sBAAa,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QACnD,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,UAAkB;QACzC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CACzD,UAAU,EACV,mCAAY,CAAC,MAAM,EACnB;YACE,KAAK,EAAE,0BAA0B;SAClC,CACF,CAAC;QAEF,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,IAAI,sBAAa,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QACnD,CAAC;QAED,OAAO,IAAI,CAAC,KAAK;aACd,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;aAClB,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9C,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,UAAkB,EAAE,OAAe;QAC9D,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,kBAAkB,CAAC;YACxE,UAAU;YACV,OAAO;YACP,KAAK,EAAE,GAAG;SACX,CAAC,CAAC;QAEH,IAAI,KAAK;YAAE,MAAM,IAAI,sBAAa,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;CACF,CAAA;AAtHY,0DAAuB;kCAAvB,uBAAuB;IADnC,IAAA,mBAAY,EAAC,4BAAqB,CAAC;qCAKE,kDAAsB;GAJ/C,uBAAuB,CAsHnC"}
+{"version":3,"file":"get-open-api-schema.handler.js","sourceRoot":"","sources":["../../../../../../src/endpoint-microservice/restapi/queries/handlers/get-open-api-schema.handler.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA+C;AAC/C,uCAA2D;AAC3D,2FAAsG;AACtG,kCAAuF;AACvF,sDAA2D;AAE3D,+EAAqF;AAErF,mEAQiC;AAEjC,MAAM,0BAA0B,GAAG,IAAI,CAAC;AAGjC,IAAM,uBAAuB,GAA7B,MAAM,uBAAuB;IAGlC,YACmB,eAAuC;QAAvC,oBAAe,GAAf,eAAe,CAAwB;IACvD,CAAC;IAEG,OAAO,CAAC,EAAE,IAAI,EAAyB;QAC5C,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAClE,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,UAAkB,EAAE,WAAmB;QACpE,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAClD,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAElE,MAAM,YAAY,GAAG,IAAA,0CAAkB,EACrC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EACxB,WAAW,CACZ,CAAC;QAEF,MAAM,WAAW,GAAkB;YACjC,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,EAAE;YACxC,OAAO,EAAE,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;YACnC,KAAK,EAAE,EAAE;YACT,UAAU,EAAE;gBACV,eAAe,EAAE;oBACf,cAAc,EAAE;wBACd,MAAM,EAAE,QAAQ;wBAChB,YAAY,EAAE,KAAK;wBACnB,IAAI,EAAE,MAAM;qBACb;iBACF;gBACD,OAAO,EAAE;oBACP,GAAG,IAAA,+CAAuB,EAAC,WAAW,CAAC;iBACxC;aACF;SACF,CAAC;QAEF,WAAW,CAAC,KAAK,KAAK,EAAE,CAAC;QAEzB,KAAK,MAAM,SAAS,IAAI,OAAO,EAAE,CAAC;YAChC,MAAM,UAAU,GAAG,SAAS,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAE1C,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,SAAS;YACX,CAAC;YAED,WAAW,CAAC,KAAK,CAAC,WAAW,UAAU,OAAO,CAAC,GAAG,IAAA,2CAAmB,EACnE,IAAI,EACJ,WAAW,EACX,eAAe,CAChB,CAAC;YAEF,WAAW,CAAC,KAAK,CAAC,WAAW,UAAU,cAAc,CAAC;gBACpD,IAAA,2CAAmB,EAAC,IAAI,EAAE,WAAW,EAAE,eAAe,CAAC,CAAC;YAE1D,IAAI,eAAe,EAAE,CAAC;gBACpB,WAAW,CAAC,KAAK,CAAC,WAAW,UAAU,6BAA6B,CAAC;oBACnE,IAAA,4CAAoB,EAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;YAED,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YAEtE,KAAK,MAAM,EAAE,IAAI,WAAW,EAAE,CAAC;gBAC7B,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gBACvC,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,SAAS;gBACX,CAAC;gBAED,WAAW,CAAC,KAAK,CACf,WAAW,UAAU,gCAAgC,EAAE,CAAC,EAAE,EAAE,CAC7D,GAAG,IAAA,4CAAoB,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YACzC,CAAC;YAED,WAAW,CAAC,UAAU,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;YAC3C,WAAW,CAAC,UAAU,CAAC,OAAO,KAAK,EAAE,CAAC;YACtC,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,IAAA,iBAAW,EAC3D,SAAS,CAAC,IAAkB,CAC7B,CAAC;QACJ,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAEO,UAAU,CAChB,YAAwC;QAExC,OAAO,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACtD,IAAI,EAAE,IAAI,CAAC,GAAG;YACd,WAAW,EAAE,iBAAiB,IAAI,CAAC,UAAU,QAAQ;SACtD,CAAC,CAAC,CAAC;IACN,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,UAAkB;QACjD,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAE5E,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,IAAI,sBAAa,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QACnD,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,UAAkB;QACzC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CACzD,UAAU,EACV,mCAAY,CAAC,MAAM,EACnB;YACE,KAAK,EAAE,0BAA0B;SAClC,CACF,CAAC;QAEF,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,IAAI,sBAAa,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QACnD,CAAC;QAED,OAAO,IAAI,CAAC,KAAK;aACd,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;aAClB,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9C,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,UAAkB,EAAE,OAAe;QAC9D,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,kBAAkB,CAAC;YACxE,UAAU;YACV,OAAO;YACP,KAAK,EAAE,GAAG;SACX,CAAC,CAAC;QAEH,IAAI,KAAK;YAAE,MAAM,IAAI,sBAAa,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;CACF,CAAA;AAtIY,0DAAuB;kCAAvB,uBAAuB;IADnC,IAAA,mBAAY,EAAC,4BAAqB,CAAC;qCAKE,kDAAsB;GAJ/C,uBAAuB,CAsInC"}

package/dist/src/endpoint-microservice/restapi/queries/handlers/open-api-schema.utils.d.ts

@@ -0,0 +1,20 @@
+import { oas31 } from 'openapi3-ts';
+export interface TablePathInfo {
+    rawTableId: string;
+    schemaName: string;
+    tag: string;
+}
+export declare const getFilterAndSortSchemas: (projectName: string) => Record<string, oas31.SchemaObject>;
+export declare const getRowIdPathParam: () => oas31.ParameterObject;
+export declare const getPaginationParams: () => oas31.ParameterObject[];
+export declare const getSystemFieldsProperties: () => Record<string, oas31.SchemaObject>;
+export declare const getSystemFieldsRequired: () => string[];
+export declare const getRowNodeSchema: (dataSchemaRef: string) => oas31.SchemaObject;
+export declare const getSingleRowResponseSchema: (dataSchemaRef: string) => oas31.SchemaObject;
+export declare const getPaginatedResponseSchema: (dataSchemaRef: string) => oas31.SchemaObject;
+export declare const getQueryBodySchema: (projectName: string) => oas31.SchemaObject;
+export declare const createTableRowsPath: (info: TablePathInfo, projectName: string, isDraft: boolean) => oas31.PathItemObject;
+export declare const createSingleRowPath: (info: TablePathInfo, projectName: string, isDraft: boolean) => oas31.PathItemObject;
+export declare const createForeignKeyPath: (info: TablePathInfo, fkInfo: TablePathInfo) => oas31.PathItemObject;
+export declare const createFileUploadPath: (info: TablePathInfo) => oas31.PathItemObject;
+export declare const createTableInfoMap: (tableIds: string[], projectName: string) => Map<string, TablePathInfo>;