@crowdin/app-project-module 0.28.11 → 0.29.0

package/out/storage/sqlite.d.ts

@@ -1,5 +1,5 @@
 import { Storage } from '.';
-import { CrowdinCredentials, IntegrationCredentials, IntegrationSyncSettings } from '../models';
+import { CrowdinCredentials, IntegrationCredentials, IntegrationFilesSnapshot, IntegrationSyncSettings } from '../models';
 export interface SQLiteStorageConfig {
     dbFolder: string;
 }
@@ -37,4 +37,7 @@ export declare class SQLiteStorage implements Storage {
     saveSyncSettings(files: any, integrationId: string, crowdinId: string, type: string, provider: string): Promise<void>;
     updateSyncSettings(files: any, integrationId: string, crowdinId: string, type: string, provider: string): Promise<void>;
     getSyncSettings(integrationId: string, crowdinId: string, type: string, provider: string): Promise<IntegrationSyncSettings | undefined>;
+    saveFilesSnapshot(files: any, integrationId: string, crowdinId: string, provider: string): Promise<void>;
+    updateFilesSnapshot(files: any, integrationId: string, crowdinId: string, provider: string): Promise<void>;
+    getFilesSnapshot(integrationId: string, crowdinId: string, provider: string): Promise<IntegrationFilesSnapshot | undefined>;
 }

package/out/storage/sqlite.js

@@ -169,6 +169,16 @@ class SQLiteStorage {
                 id        varchar not null primary key,
                 data      varchar     null
             );
+            `, []);
+                yield this._run(`
+            create table if not exists files_snapshot
+            (
+                id             integer not null primary key autoincrement,
+                integration_id varchar not null,
+                crowdin_id     varchar not null,
+                files          varchar     null,
+                provider       varchar not null
+            );
             `, []);
                 this._res && this._res();
                 // TODO: temporary code
@@ -222,6 +232,7 @@ class SQLiteStorage {
             yield this.run('DELETE FROM crowdin_credentials where id = ?', [id]);
             yield this.run('DELETE FROM integration_credentials where crowdin_id = ?', [id]);
             yield this.run('DELETE FROM sync_settings WHERE crowdin_id = ?', [id]);
+            yield this.run('DELETE FROM files_snapshot WHERE crowdin_id = ?', [id]);
         });
     }
     saveIntegrationCredentials(id, credentials, crowdinId) {
@@ -252,12 +263,14 @@ class SQLiteStorage {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.run('DELETE FROM integration_credentials where id = ?', [id]);
             yield this.run('DELETE FROM sync_settings where integration_id = ?', [id]);
+            yield this.run('DELETE FROM files_snapshot where integration_id = ?', [id]);
         });
     }
     deleteAllIntegrationCredentials(crowdinId) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.run('DELETE FROM integration_credentials where crowdin_id = ?', [crowdinId]);
             yield this.run('DELETE FROM sync_settings where crowdin_id = ?', [crowdinId]);
+            yield this.run('DELETE FROM files_snapshot where crowdin_id = ?', [crowdinId]);
         });
     }
     saveMetadata(id, metadata) {
@@ -298,7 +311,26 @@ class SQLiteStorage {
     }
     getSyncSettings(integrationId, crowdinId, type, provider) {
         return __awaiter(this, void 0, void 0, function* () {
-            const row = yield this.get('SELECT id, files, integration_id as integrationId, crowdin_id as crowdinId, type FROM sync_settings WHERE integration_id = ? AND crowdin_id = ? AND type = ? AND provider = ?', [integrationId, crowdinId, type, provider]);
+            const row = yield this.get('SELECT id, files, integration_id as integrationId, crowdin_id as crowdinId, type, provider FROM sync_settings WHERE integration_id = ? AND crowdin_id = ? AND type = ? AND provider = ?', [integrationId, crowdinId, type, provider]);
+            if (row) {
+                return row;
+            }
+        });
+    }
+    saveFilesSnapshot(files, integrationId, crowdinId, provider) {
+        return this.run('INSERT INTO files_snapshot(files, integration_id, crowdin_id, provider) VALUES (?, ?, ?, ?)', [
+            files,
+            integrationId,
+            crowdinId,
+            provider,
+        ]);
+    }
+    updateFilesSnapshot(files, integrationId, crowdinId, provider) {
+        return this.run('UPDATE files_snapshot SET files = ? WHERE integration_id = ? AND crowdin_id = ? AND provider = ? ', [files, integrationId, crowdinId, provider]);
+    }
+    getFilesSnapshot(integrationId, crowdinId, provider) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const row = yield this.get('SELECT id, files, integration_id as integrationId, crowdin_id as crowdinId, provider FROM files_snapshot WHERE integration_id = ? AND crowdin_id = ? AND provider = ?', [integrationId, crowdinId, provider]);
             if (row) {
                 return row;
             }

package/out/util/api/api.d.ts

@@ -0,0 +1,6 @@
+import { ApiEndpoints, ApiModule, Config, CrowdinClientRequest, CrowdinContextInfo } from '../../models';
+import { Express } from 'express';
+export declare function getApiManifest(config: Config, apiModule: ApiModule): ApiEndpoints[];
+export declare function updateCrowdinContext(req: CrowdinClientRequest, context: CrowdinContextInfo): CrowdinContextInfo;
+export declare function addDefaultApiEndpoints(app: Express, config: Config): void;
+export declare function addSwagerApiDocumentation(app: Express, config: Config): void;

package/out/util/api/api.js

@@ -0,0 +1,452 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addSwagerApiDocumentation = exports.addDefaultApiEndpoints = exports.updateCrowdinContext = exports.getApiManifest = void 0;
+const models_1 = require("../../models");
+const redoc_express_1 = __importDefault(require("redoc-express"));
+const swagger_jsdoc_1 = __importDefault(require("swagger-jsdoc"));
+const json_response_1 = __importDefault(require("../../middlewares/json-response"));
+const crowdin_client_1 = __importDefault(require("../../middlewares/crowdin-client"));
+const integration_credentials_1 = __importDefault(require("../../middlewares/integration-credentials"));
+const crowdin_files_1 = __importDefault(require("../../handlers/crowdin-files"));
+const integration_data_1 = __importDefault(require("../../handlers/integration-data"));
+const crowdin_file_progress_1 = __importDefault(require("../../handlers/crowdin-file-progress"));
+const crowdin_update_1 = __importDefault(require("../../handlers/crowdin-update"));
+const sync_settings_1 = __importDefault(require("../../handlers/sync-settings"));
+const sync_settings_save_1 = __importDefault(require("../../handlers/sync-settings-save"));
+const settings_save_1 = __importDefault(require("../../handlers/settings-save"));
+const settings_1 = __importDefault(require("../../handlers/settings"));
+const integration_update_1 = __importDefault(require("../../handlers/integration-update"));
+const path_1 = __importDefault(require("path"));
+const integration_login_1 = __importDefault(require("../../handlers/integration-login"));
+function getApiManifest(config, apiModule) {
+    const apiModuleManifest = [];
+    if (apiModule.endpoints) {
+        const userEndpoints = getUsersApiManifest(apiModule.endpoints);
+        apiModuleManifest.push(...userEndpoints);
+    }
+    if (apiModule.default) {
+        const defaultEndpoints = getDefaultApiEndpointsManifest(config);
+        apiModuleManifest.push(...defaultEndpoints);
+    }
+    return apiModuleManifest;
+}
+exports.getApiManifest = getApiManifest;
+function generateModuleKey(moduleName) {
+    return moduleName.toLowerCase().split(' ').join('-') + '-api';
+}
+function getUsersApiManifest(endpoints) {
+    const apiModuleManifest = [];
+    for (const endpoint of endpoints) {
+        apiModuleManifest.push(Object.assign({ key: generateModuleKey(endpoint.name), name: endpoint.name, url: endpoint.url, method: endpoint.method, description: endpoint.description }, (endpoint.documentationUrl ? { documentationUrl: endpoint.documentationUrl } : {})));
+    }
+    return apiModuleManifest;
+}
+function getDefaultApiEndpointsManifest(config) {
+    var _a;
+    const apiModuleManifest = [
+        {
+            key: 'crowdin-files-api',
+            name: 'Get Crowdin Files',
+            url: '/crowdin-files',
+            method: models_1.RequestMethods.GET,
+            description: 'Get a list of synced files',
+            documentationUrl: '/api-docs#tag/Files/operation/crowdin.files',
+        },
+        {
+            key: 'crowdin-files-api',
+            name: 'File Translation Progress',
+            url: '/file-progress',
+            method: models_1.RequestMethods.GET,
+            description: 'Get file translation progress',
+            documentationUrl: '/api-docs#tag/Files/operation/file.progress',
+        },
+        {
+            key: 'integration-files-api',
+            name: 'Get Integration Files',
+            url: '/integration-files',
+            method: models_1.RequestMethods.GET,
+            description: 'Get integration data',
+            documentationUrl: '/api-docs#tag/Files/operation/integration.files',
+        },
+        {
+            key: 'crowdin-update-api',
+            name: 'Update Crowdin',
+            url: '/crowdin-update',
+            method: models_1.RequestMethods.POST,
+            description: 'Update crowdin data',
+            documentationUrl: '/api-docs#tag/Files/operation/crowdin.update',
+        },
+        {
+            key: 'integration-update-api',
+            name: 'Update Integration',
+            url: '/integration-update',
+            method: models_1.RequestMethods.POST,
+            description: 'Update integration data',
+            documentationUrl: '/api-docs#tag/Files/operation/integration.update',
+        },
+        {
+            key: 'settings-api',
+            name: 'Get App Settings',
+            url: '/settings',
+            method: models_1.RequestMethods.GET,
+            documentationUrl: '/api-docs#tag/Settings/operation/settings.get',
+        },
+        {
+            key: 'settings-update-api',
+            name: 'Update App Settings',
+            url: '/settings',
+            method: models_1.RequestMethods.POST,
+            documentationUrl: '/api-docs#tag/Settings/operation/settings.update',
+        },
+        {
+            key: 'sync-settings-api',
+            name: 'Get Sync Settings',
+            url: '/sync-settings',
+            method: models_1.RequestMethods.GET,
+            documentationUrl: '/api-docs#tag/Settings/operation/sync.settings.get',
+        },
+        {
+            key: 'sync-settings-update-api',
+            name: 'Update Sync Settings',
+            url: '/sync-settings',
+            method: models_1.RequestMethods.POST,
+            documentationUrl: '/api-docs#tag/Settings/operation/sync.settings.update',
+        },
+    ];
+    if ((_a = config.projectIntegration) === null || _a === void 0 ? void 0 : _a.loginForm) {
+        apiModuleManifest.push({
+            key: 'login-data',
+            name: 'Get Login Fields',
+            url: '/login-fields',
+            method: models_1.RequestMethods.GET,
+            documentationUrl: '/api-docs#tag/Login/operation/integration.fields',
+        }, {
+            key: 'login',
+            name: 'Login',
+            url: '/login',
+            method: models_1.RequestMethods.POST,
+            documentationUrl: '/api-docs#tag/Login/operation/integration.login',
+        });
+    }
+    return apiModuleManifest;
+}
+function updateCrowdinContext(req, context) {
+    var _a, _b, _c;
+    if ((_a = req.body) === null || _a === void 0 ? void 0 : _a.projectId) {
+        if (context.clientId.includes('undefined')) {
+            context.clientId = `${context.jwtPayload.domain || context.jwtPayload.context.organization_id}__${(_b = req.body) === null || _b === void 0 ? void 0 : _b.projectId}__${context.jwtPayload.sub}`;
+        }
+        // eslint-disable-next-line @typescript-eslint/camelcase
+        context.jwtPayload.context.project_id = (_c = req.body) === null || _c === void 0 ? void 0 : _c.projectId;
+    }
+    return context;
+}
+exports.updateCrowdinContext = updateCrowdinContext;
+function getFormFields(fields) {
+    const formFields = [];
+    for (const field of fields) {
+        if (field === null || field === void 0 ? void 0 : field.key) {
+            formFields.push({
+                name: field.label,
+                key: field.key,
+            });
+        }
+    }
+    return formFields;
+}
+function addDefaultApiEndpoints(app, config) {
+    if (config.projectIntegration) {
+        /**
+         * @openapi
+         * /crowdin-files:
+         *   get:
+         *     summary: List Crowdin Files
+         *     operationId: crowdin.files
+         *     tags:
+         *        - 'Files'
+         *     parameters:
+         *       - $ref: '#/components/parameters/ProjectId'
+         *     responses:
+         *       200:
+         *         description: 'Project files list'
+         *         content:
+         *           application/json:
+         *             schema:
+         *               properties:
+         *                 data:
+         *                   $ref: '#/components/schemas/CrowdinFiles'
+         */
+        app.get('/crowdin-files', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, config.projectIntegration), (0, crowdin_files_1.default)(config, config.projectIntegration));
+        /**
+         * @openapi
+         * /file-progress:
+         *   get:
+         *     tags:
+         *       - 'Files'
+         *     summary: 'Get File Progress'
+         *     operationId: file.progress
+         *     parameters:
+         *       - $ref: '#/components/parameters/ProjectId'
+         *       -
+         *         name: fileId
+         *         in: query
+         *         required: true
+         *         description: 'Filter branch by name. Get via [List Crowdin Files](#operation/crowdin.files)'
+         *         schema:
+         *           type: integer
+         *           example: 102
+         *     responses:
+         *      200:
+         *        description: 'File translation progress'
+         *        content:
+         *          application/json:
+         *            schema:
+         *              properties:
+         *                data:
+         *                  $ref: '#/components/schemas/FileProgress'
+         */
+        app.get('/file-progress', (0, crowdin_client_1.default)(config), (0, crowdin_file_progress_1.default)(config, config.projectIntegration));
+        /**
+         * @openapi
+         * /integration-files:
+         *   get:
+         *     summary: 'List Integration Files'
+         *     operationId: integration.files
+         *     tags:
+         *       - 'Files'
+         *     parameters:
+         *       - $ref: '#/components/parameters/ProjectId'
+         *     responses:
+         *       200:
+         *         description: 'Integration files list'
+         *         content:
+         *           application/json:
+         *             schema:
+         *               properties:
+         *                 data:
+         *                   $ref: '#/components/schemas/IntegrationFiles'
+         *
+         */
+        app.get('/integration-files', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, config.projectIntegration), (0, integration_data_1.default)(config, config.projectIntegration));
+        /**
+         * @openapi
+         * /crowdin-update:
+         *   post:
+         *     tags:
+         *       - 'Files'
+         *     summary: 'Update Crowdin Files'
+         *     operationId: crowdin.update
+         *     requestBody:
+         *       content:
+         *         application/json:
+         *           schema:
+         *             $ref: '#/components/schemas/UpdateCrowdinFiles'
+         *     responses:
+         *       200:
+         *         content:
+         *           application/json:
+         *             schema:
+         *               properties:
+         *                 data:
+         *                  $ref: '#/components/schemas/UpdateResponse'
+         */
+        app.post('/crowdin-update', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, config.projectIntegration), (0, crowdin_update_1.default)(config, config.projectIntegration));
+        /**
+         * @openapi
+         * /integration-update:
+         *   post:
+         *     tags:
+         *       - 'Files'
+         *     summary: 'Update Integration Files'
+         *     operationId: integration.update
+         *     requestBody:
+         *       content:
+         *         application/json:
+         *           schema:
+         *             $ref: '#/components/schemas/FileLanguagePair'
+         *     responses:
+         *       200:
+         *         content:
+         *           application/json:
+         *             schema:
+         *               properties:
+         *                 data:
+         *                  $ref: '#/components/schemas/UpdateResponse'
+         */
+        app.post('/integration-update', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, config.projectIntegration), (0, integration_update_1.default)(config, config.projectIntegration));
+        /**
+         * @openapi
+         * /settings:
+         *   get:
+         *     tags:
+         *       - 'Settings'
+         *     summary: 'Get Application Settings'
+         *     operationId: settings.get
+         *     parameters:
+         *       - $ref: '#/components/parameters/ProjectId'
+         *     responses:
+         *      200:
+         *        description: 'File translation progress'
+         *        content:
+         *          application/json:
+         *            schema:
+         *              properties:
+         *                data:
+         *                  $ref: '#/components/schemas/SettingsResponse'
+         */
+        app.get('/settings', (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, config.projectIntegration), (0, settings_1.default)(config));
+        /**
+         * @openapi
+         * /settings:
+         *   post:
+         *     tags:
+         *       - 'Settings'
+         *     summary: 'Update Application Settings'
+         *     operationId: settings.update
+         *     requestBody:
+         *       content:
+         *         application/json:
+         *           schema:
+         *             $ref: '#/components/schemas/UpdateSettingsData'
+         *     responses:
+         *       204:
+         *         description: 'Application Settings was successfully update'
+         */
+        app.post('/settings', (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, config.projectIntegration), (0, settings_save_1.default)(config, config.projectIntegration));
+        /**
+         * @openapi
+         * /sync-settings:
+         *   get:
+         *     tags:
+         *       - 'Settings'
+         *     summary: 'Get Sync Settings'
+         *     operationId: sync.settings.get
+         *     parameters:
+         *       - $ref: '#/components/parameters/ProjectId'
+         *       - name: provider
+         *         in: query
+         *         required: true
+         *         schema:
+         *           type: string
+         *           enum:
+         *             - crowdin
+         *             - integration
+         *     responses:
+         *      200:
+         *        description: 'Application Sync Settings'
+         *        content:
+         *          application/json:
+         *            schema:
+         *              properties:
+         *                data:
+         *                  oneOf:
+         *                    - { $ref: '#/components/schemas/CrowdinSyncSettingsResponse' }
+         *                    - { $ref: '#/components/schemas/IntegrationSyncSettingsResponse' }
+         */
+        app.get('/sync-settings', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, config.projectIntegration), (0, sync_settings_1.default)(config));
+        /**
+         * @openapi
+         * /sync-settings:
+         *   post:
+         *     tags:
+         *       - 'Settings'
+         *     summary: 'Update Sync Settings'
+         *     operationId: sync.settings.update
+         *     requestBody:
+         *       content:
+         *         application/json:
+         *           schema:
+         *             $ref: '#/components/schemas/UpdateSyncSettingsData'
+         *     responses:
+         *       204:
+         *         description: 'Application Sync Settings was successfully update'
+         */
+        app.post('/sync-settings', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, config.projectIntegration), (0, sync_settings_save_1.default)(config, config.projectIntegration));
+        if (config.projectIntegration.loginForm) {
+            /**
+             * @openapi
+             * /login-fields:
+             *   get:
+             *     tags:
+             *       - 'Login'
+             *     summary: 'Integration Login Form Fields'
+             *     operationId: integration.fields
+             *     responses:
+             *      200:
+             *        description: 'File translation progress'
+             *        content:
+             *          application/json:
+             *            schema:
+             *              properties:
+             *                data:
+             *                  $ref: '#/components/schemas/LoginFieldsResponse'
+             */
+            app.get('/login-fields', json_response_1.default, (0, crowdin_client_1.default)(config), (req, res) => {
+                var _a;
+                let fields = [];
+                if ((_a = config.projectIntegration) === null || _a === void 0 ? void 0 : _a.loginForm.fields) {
+                    fields = getFormFields(config === null || config === void 0 ? void 0 : config.projectIntegration.loginForm.fields);
+                }
+                res.send({ fields });
+            });
+            /**
+             * @openapi
+             * /login:
+             *   post:
+             *     tags:
+             *       - 'Login'
+             *     summary: 'Integration Login'
+             *     operationId: integration.login
+             *     requestBody:
+             *       content:
+             *         application/json:
+             *           schema:
+             *             $ref: '#/components/schemas/Login'
+             *     responses:
+             *       204:
+             *         description: 'Login successful'
+             */
+            app.post('/login', (0, crowdin_client_1.default)(config, false, false), (0, integration_login_1.default)(config, config.projectIntegration));
+        }
+    }
+}
+exports.addDefaultApiEndpoints = addDefaultApiEndpoints;
+function addSwagerApiDocumentation(app, config) {
+    var _a, _b;
+    const options = {
+        swaggerDefinition: {
+            openapi: '3.0.0',
+            info: {
+                title: `${config.name} Application API`,
+                version: '1.0.0',
+                'x-logo': {
+                    url: 'https://support.crowdin.com/assets/crowdin-logo.svg',
+                },
+            },
+            servers: [
+                {
+                    url: `{protocol}//{host}/api/v2/applications/${config.identifier}/api`,
+                },
+            ],
+        },
+        apis: [path_1.default.resolve(__dirname, './base.js'), path_1.default.resolve(__dirname, './components.js'), __filename],
+    };
+    if ((_a = config.api) === null || _a === void 0 ? void 0 : _a.docFile) {
+        options.apis.push(config.api.docFile);
+    }
+    const swaggerSpec = (0, swagger_jsdoc_1.default)(options);
+    // remove Login info from doc
+    if (!((_b = config.projectIntegration) === null || _b === void 0 ? void 0 : _b.loginForm)) {
+        delete swaggerSpec.paths['/login'];
+        delete swaggerSpec.paths['/login-fields'];
+        delete swaggerSpec.components.schemas['Login'];
+        delete swaggerSpec.components.schemas['LoginData'];
+        swaggerSpec.tags = swaggerSpec.tags.filter((tag) => tag.name !== 'Login');
+    }
+    app.get('/api-docs/swagger.json', (req, res) => res.send(swaggerSpec));
+    app.use('/api-docs', (0, redoc_express_1.default)({ title: '', specUrl: '/api-docs/swagger.json' }));
+}
+exports.addSwagerApiDocumentation = addSwagerApiDocumentation;

package/out/util/api/base.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @openapi
+ * tags:
+ *   - name: 'Files'
+ *   - name: 'Settings'
+ *   - name: 'Login'
+ */

package/out/util/api/base.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * @openapi
+ * tags:
+ *   - name: 'Files'
+ *   - name: 'Settings'
+ *   - name: 'Login'
+ */