@crowdin/app-project-module 0.89.0 → 0.91.0

package/out/index.js

@@ -98,13 +98,11 @@ exports.metadataStore = {
     },
     saveMetadata: (id, metadata, crowdinId) => __awaiter(void 0, void 0, void 0, function* () {
         if (!crowdinId) {
-            console.warn('Warning: The crowdinId parameter in saveMetadata will be required. Please update your code to provide this parameter.');
+            throw new Error('The crowdinId parameter is required.');
         }
-        else {
-            const crowdinCredentials = yield storage.getStorage().getCrowdinCredentials(crowdinId);
-            if (!crowdinCredentials) {
-                console.error('Invalid crowdinId parameter: You can get your crowdinId from the JWT payload');
-            }
+        const crowdinCredentials = yield storage.getStorage().getCrowdinCredentials(crowdinId);
+        if (!crowdinCredentials) {
+            throw new Error('Invalid crowdinId parameter: You can get your crowdinId from the JWT payload.');
         }
         const existing = yield storage.getStorage().getMetadata(id);
         if (existing) {

package/out/modules/integration/util/defaults.js

@@ -146,7 +146,7 @@ function applyIntegrationModuleDefaults(config, integration) {
     }
     const getUserSettings = integration.getConfiguration;
     integration.getConfiguration = (projectId, crowdinClient, integrationCredentials) => __awaiter(this, void 0, void 0, function* () {
-        var _m, _o;
+        var _m, _o, _p;
         let fields = [];
         const project = (yield crowdinClient.projectsGroupsApi.getProject(projectId));
         if (getUserSettings) {
@@ -163,42 +163,49 @@ function applyIntegrationModuleDefaults(config, integration) {
             });
         }
         if (integration.withCronSync || integration.webhooks) {
-            defaultSettings.push({
-                key: 'schedule',
-                label: 'Sync schedule',
-                helpText: `Defines how often content is synced between ${config.name} and Crowdin. Make sure Auto Sync is enabled for selected directories and files in the dual pane view.`,
-                type: 'select',
-                defaultValue: '0',
-                category: types_1.DefaultCategory.SYNC,
-                position: 0,
-                options: [
-                    {
-                        value: '0',
-                        label: 'Disabled',
-                    },
-                    {
-                        value: '1',
-                        label: '1 hour',
-                    },
-                    {
-                        value: '3',
-                        label: '3 hours',
-                    },
-                    {
-                        value: '6',
-                        label: '6 hours',
-                    },
-                    {
-                        value: '12',
-                        label: '12 hours',
-                    },
-                    {
-                        value: '24',
-                        label: '24 hours',
-                    },
-                ],
-            });
-            if ((_m = integration.syncNewElements) === null || _m === void 0 ? void 0 : _m.crowdin) {
+            const userSchedule = fields.find((field) => 'key' in field && field.key === 'schedule');
+            if (userSchedule) {
+                userSchedule.position = (_m = userSchedule.position) !== null && _m !== void 0 ? _m : 0;
+                userSchedule.category = types_1.DefaultCategory.SYNC;
+            }
+            else {
+                defaultSettings.push({
+                    key: 'schedule',
+                    label: 'Sync schedule',
+                    helpText: `Defines how often content is synced between ${config.name} and Crowdin. Make sure Auto Sync is enabled for selected directories and files in the dual pane view.`,
+                    type: 'select',
+                    defaultValue: '0',
+                    category: types_1.DefaultCategory.SYNC,
+                    position: 0,
+                    options: [
+                        {
+                            value: '0',
+                            label: 'Disabled',
+                        },
+                        {
+                            value: '1',
+                            label: '1 hour',
+                        },
+                        {
+                            value: '3',
+                            label: '3 hours',
+                        },
+                        {
+                            value: '6',
+                            label: '6 hours',
+                        },
+                        {
+                            value: '12',
+                            label: '12 hours',
+                        },
+                        {
+                            value: '24',
+                            label: '24 hours',
+                        },
+                    ],
+                });
+            }
+            if ((_o = integration.syncNewElements) === null || _o === void 0 ? void 0 : _o.crowdin) {
                 defaultSettings.push({
                     key: 'new-crowdin-files',
                     label: 'Automatically sync new translations from Crowdin',
@@ -208,7 +215,7 @@ function applyIntegrationModuleDefaults(config, integration) {
                     position: 1,
                 });
             }
-            if ((_o = integration.syncNewElements) === null || _o === void 0 ? void 0 : _o.integration) {
+            if ((_p = integration.syncNewElements) === null || _p === void 0 ? void 0 : _p.integration) {
                 defaultSettings.push({
                     key: 'new-integration-files',
                     label: `Automatically sync new content from  ${config.name}`,

package/out/modules/manifest.js

@@ -193,11 +193,21 @@ function handle(config) {
         ];
     }
     if (config.modal) {
-        // prevent possible overrides of the other modules
-        config.modal = Object.assign(Object.assign({}, config.modal), { key: config.identifier + '-modal' });
-        modules['modal'] = [
-            Object.assign({ key: config.modal.key, name: config.modal.name || config.name, url: config.modal.url || '/modal/' + (config.modal.fileName || 'index.html') }, (!!config.modal.environments && { environments: normalizeEnvironments(config.modal.environments) })),
-        ];
+        let modals = [];
+        if (Array.isArray(config.modal)) {
+            modals = config.modal.map((modal, i) => {
+                const moduleKey = modal.key || `${config.identifier}-modal-${i}`;
+                return Object.assign({ key: moduleKey, name: modal.name || config.name, url: modal.url || `/modal-${moduleKey}/` + (modal.fileName || 'index.html') }, (!!modal.environments && { environments: normalizeEnvironments(modal.environments) }));
+            });
+        }
+        else {
+            modals = [
+                Object.assign({ key: config.identifier + '-modal', name: config.modal.name || config.name, url: config.modal.url || '/modal/' + (config.modal.fileName || 'index.html') }, (!!config.modal.environments && {
+                    environments: normalizeEnvironments(config.modal.environments),
+                })),
+            ];
+        }
+        modules['modal'] = modals;
     }
     if (config.contextMenu) {
         // prevent possible overrides of the other modules

package/out/modules/modal/index.js

@@ -10,8 +10,20 @@ const util_1 = require("../../util");
 function register({ config, app }) {
     var _a, _b;
     const allowUnauthorized = !(0, util_1.isAuthorizedConfig)(config);
-    if (((_a = config.modal) === null || _a === void 0 ? void 0 : _a.uiPath) || ((_b = config.modal) === null || _b === void 0 ? void 0 : _b.formSchema)) {
-        app.use('/modal', (0, ui_module_1.default)({ config, allowUnauthorized, moduleType: config.modal.key }), (0, render_ui_module_1.default)(config.modal));
+    if (!config.modal) {
+        return;
+    }
+    if (Array.isArray(config.modal)) {
+        config.modal.forEach((modal) => {
+            if ((modal === null || modal === void 0 ? void 0 : modal.uiPath) || (modal === null || modal === void 0 ? void 0 : modal.formSchema)) {
+                app.use(`/modal-${modal.key}`, (0, ui_module_1.default)({ config, allowUnauthorized, moduleType: modal.key }), (0, render_ui_module_1.default)(modal));
+            }
+        });
+    }
+    else {
+        if (((_a = config.modal) === null || _a === void 0 ? void 0 : _a.uiPath) || ((_b = config.modal) === null || _b === void 0 ? void 0 : _b.formSchema)) {
+            app.use('/modal', (0, ui_module_1.default)({ config, allowUnauthorized, moduleType: config.modal.key }), (0, render_ui_module_1.default)(config.modal));
+        }
     }
 }
 exports.register = register;

package/out/modules/webhooks/handlers/webhook-handler.js

@@ -69,7 +69,16 @@ function webhookHandler(config, webhooks) {
         const json = JSON.parse(req.body.toString());
         for (const webhook of webhooks) {
             if (webhook.key === moduleKey) {
-                yield webhook.callback({ events: json.events, client });
+                yield webhook.callback({
+                    events: json.events,
+                    client,
+                    webhookContext: {
+                        domain: credentials.domain,
+                        organizationId: credentials.organizationId,
+                        userId: credentials.userId,
+                        agentId: credentials.agentId,
+                    },
+                });
             }
         }
     }));

package/out/modules/webhooks/types.d.ts

@@ -9,10 +9,17 @@ export interface Webhook extends ModuleKey {
      * handle function
      */
     callback: (data: {
+        webhookContext: WebhookContext;
         events: Event[];
         client: Crowdin;
     }) => Promise<void>;
 }
+interface WebhookContext {
+    domain?: string;
+    organizationId?: number;
+    userId?: number;
+    agentId?: number;
+}
 interface EventPayload {
     event: string;
 }

package/out/storage/index.d.ts

@@ -30,8 +30,8 @@ export interface Storage {
     getAllIntegrationCredentials(crowdinId: string): Promise<IntegrationCredentials[]>;
     deleteIntegrationCredentials(id: string): Promise<void>;
     deleteAllIntegrationCredentials(crowdinId: string): Promise<void>;
-    saveMetadata(id: string, metadata: any, crowdinId?: string): Promise<void>;
-    updateMetadata(id: string, metadata: any, crowdinId?: string): Promise<void>;
+    saveMetadata(id: string, metadata: any, crowdinId: string): Promise<void>;
+    updateMetadata(id: string, metadata: any, crowdinId: string): Promise<void>;
     getMetadata(id: string): Promise<any | undefined>;
     getAllMetadata(): Promise<any[] | undefined>;
     deleteMetadata(id: string): Promise<void>;

package/out/storage/mysql.d.ts

@@ -17,6 +17,11 @@ export declare class MySQLStorage implements Storage {
     private _rej?;
     private dbPromise;
     private config;
+    tableIndexes: {
+        [key: string]: {
+            [key: string]: string;
+        };
+    };
     tables: {
         crowdin_credentials: string;
         integration_credentials: string;
@@ -48,7 +53,7 @@ export declare class MySQLStorage implements Storage {
     deleteIntegrationCredentials(id: string): Promise<void>;
     deleteAllIntegrationCredentials(crowdinId: string): Promise<void>;
     saveMetadata(id: string, metadata: any, crowdinId: string): Promise<void>;
-    updateMetadata(id: string, metadata: any, crowdinId?: string): Promise<void>;
+    updateMetadata(id: string, metadata: any, crowdinId: string): Promise<void>;
     getMetadata(id: string): Promise<any>;
     getAllMetadata(): Promise<any[]>;
     deleteMetadata(id: string): Promise<void>;

package/out/storage/mysql.js

@@ -24,6 +24,46 @@ class MySQLStorage {
             this._res = res;
             this._rej = rej;
         });
+        this.tableIndexes = {
+            integration_credentials: {
+                idx_crowdin: '(crowdin_id)',
+            },
+            sync_settings: {
+                idx_integration_provider: '(integration_id, provider)',
+                idx_crowdin: '(crowdin_id)',
+                idx_type: '(type)',
+            },
+            files_snapshot: {
+                idx_integration: '(integration_id)',
+                idx_crowdin: '(crowdin_id)',
+            },
+            webhooks: {
+                idx_integration_crowdin: '(integration_id, crowdin_id)',
+                idx_file_provider: '(file_id, provider)',
+            },
+            user_errors: {
+                idx_integration_crowdin: '(integration_id, crowdin_id)',
+                idx_crowdin: '(crowdin_id)',
+                idx_created_at: '(created_at)',
+            },
+            integration_settings: {
+                idx_integration: '(integration_id)',
+                idx_crowdin: '(crowdin_id)',
+            },
+            job: {
+                idx_integration_crowdin: '(integration_id, crowdin_id)',
+                idx_finished_at: '(finished_at)',
+                idx_status: '(status)',
+            },
+            translation_file_cache: {
+                idx_integration_crowdin_file_language: '(integration_id, crowdin_id, file_id, language_id)',
+                idx_crowdin: '(crowdin_id)',
+            },
+            unsynced_files: {
+                idx_integration_crowdin: '(integration_id, crowdin_id)',
+                idx_crowdin: '(crowdin_id)',
+            },
+        };
         this.tables = {
             crowdin_credentials: `(
             id              varchar(255) primary key,
@@ -168,6 +208,14 @@ class MySQLStorage {
         return __awaiter(this, void 0, void 0, function* () {
             for (const [tableName, tableSchema] of Object.entries(this.tables)) {
                 yield connection.execute(`create table if not exists ${tableName} ${tableSchema}`);
+                if (this.tableIndexes[tableName]) {
+                    for (const [indexName, indexSchema] of Object.entries(this.tableIndexes[tableName])) {
+                        // For MySQL, we need to handle partial indexes differently since MySQL doesn't support WHERE clauses in indexes
+                        // We'll create the basic index without the WHERE clause
+                        const indexColumns = indexSchema.replace(/WHERE.*$/, '').trim();
+                        yield connection.execute(`create index if not exists ${indexName} on ${tableName}${indexColumns}`);
+                    }
+                }
             }
         });
     }

package/out/storage/postgre.d.ts

@@ -62,7 +62,7 @@ export declare class PostgreStorage implements Storage {
     deleteIntegrationCredentials(id: string): Promise<void>;
     deleteAllIntegrationCredentials(crowdinId: string): Promise<void>;
     saveMetadata(id: string, metadata: any, crowdinId: string): Promise<void>;
-    updateMetadata(id: string, metadata: any, crowdinId?: string): Promise<void>;
+    updateMetadata(id: string, metadata: any, crowdinId: string): Promise<void>;
     getMetadata(id: string): Promise<any>;
     getAllMetadata(): Promise<any[]>;
     deleteMetadata(id: string): Promise<void>;

package/out/storage/sqlite.d.ts

@@ -50,8 +50,8 @@ export declare class SQLiteStorage implements Storage {
     getAllIntegrationCredentials(crowdinId: string): Promise<IntegrationCredentials[]>;
     deleteIntegrationCredentials(id: string): Promise<void>;
     deleteAllIntegrationCredentials(crowdinId: string): Promise<void>;
-    saveMetadata(id: string, metadata: any, crowdinId?: string): Promise<void>;
-    updateMetadata(id: string, metadata: any, crowdinId?: string): Promise<void>;
+    saveMetadata(id: string, metadata: any, crowdinId: string): Promise<void>;
+    updateMetadata(id: string, metadata: any, crowdinId: string): Promise<void>;
     getMetadata(id: string): Promise<any>;
     getAllMetadata(): Promise<any[]>;
     deleteMetadata(id: string): Promise<void>;

package/out/types.d.ts

@@ -159,7 +159,7 @@ export interface ClientConfig extends ImagePath {
     /**
      * modal module
      */
-    modal?: ModuleContent & UiModule & Environments;
+    modal?: ModalModule | ModalModule[];
     /**
      * Install hook
      */
@@ -394,7 +394,7 @@ export interface CrowdinAppUtilities extends CrowdinMetadataStore {
     storage: Storage;
 }
 export interface CrowdinMetadataStore {
-    saveMetadata: (id: string, metadata: any, crowdinId?: string) => Promise<void>;
+    saveMetadata: (id: string, metadata: any, crowdinId: string) => Promise<void>;
     getMetadata: (id: string) => Promise<any | undefined>;
     deleteMetadata: (id: string) => Promise<void>;
     /**
@@ -497,4 +497,6 @@ export declare enum storageFiles {
     SQLITE_BACKUP = "backup_app.sqlite",
     DUMP = "dump_table_%s.sql"
 }
+export interface ModalModule extends ModuleContent, UiModule, Environments {
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdin/app-project-module",
-  "version": "0.89.0",
+  "version": "0.91.0",
   "description": "Module that generates for you all common endpoints for serving standalone Crowdin App",
   "main": "out/index.js",
   "types": "out/index.d.ts",