@crowdin/app-project-module 0.108.0 → 1.0.0

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

@@ -1,7 +1,8 @@
 import Crowdin, { SourceFilesModel, TranslationStatusModel } from '@crowdin/crowdin-api-client';
 import { Request } from 'express';
 import { CrowdinClientRequest, ModuleKey } from '../../types';
-import { JobClient, JobStoreType } from './util/types';
+import { IntegrationSyncedData, JobClient, JobStoreType } from './util/types';
+import { AppModuleError, AppUserModuleError } from '../../util/logger';
 export interface IntegrationLogic extends ModuleKey {
     /**
      * Customize your app login form
@@ -22,35 +23,61 @@ export interface IntegrationLogic extends ModuleKey {
     /**
      * Validate integration settings before saving
      */
-    validateSettings?: ({ client, credentials, appSettings, }: {
+    validateSettings?: ({ client, credentials, settings, }: {
         client: Crowdin;
         credentials: any;
-        appSettings: AppSettings;
+        settings: any;
     }) => Promise<{
         [key: string]: string;
     } | null>;
     /**
      * function which will be used to check connection with integration service
      */
-    checkConnection?: (apiCredentials: any) => Promise<void>;
+    checkConnection?: (credentials: any) => Promise<void>;
     /**
      * function to get crowdin files that are related with this integration
      */
-    getCrowdinFiles?: (projectId: number, client: Crowdin, appRootFolder?: SourceFilesModel.Directory, config?: any, mode?: CrowdinFilesLoadMode) => Promise<TreeItem[]>;
+    getCrowdinFiles?: (options: {
+        projectId: number;
+        client: Crowdin;
+        rootFolder?: SourceFilesModel.Directory;
+        settings?: any;
+        mode?: CrowdinFilesLoadMode;
+    }) => Promise<TreeItem[]>;
+    /**
+     * Match Crowdin files to integration files or vice versa.
+     */
+    matchCrowdinFilesToIntegrationFiles?: ({ projectId, client, credentials, crowdinFiles, integrationFiles, settings, rootFolder, syncedData, }: {
+        projectId: number;
+        client: Crowdin;
+        credentials: any;
+        crowdinFiles?: UpdateIntegrationRequest;
+        integrationFiles?: IntegrationFile[];
+        settings?: any;
+        rootFolder?: SourceFilesModel.Directory;
+        syncedData?: IntegrationSyncedData | undefined;
+    }) => Promise<IntegrationFile[] | UpdateIntegrationRequest | MatchingResult<IntegrationFile[] | UpdateIntegrationRequest>>;
     /**
      * function to get data from integration
      */
-    getIntegrationFiles: (apiCredentials: any, config?: any, parentId?: any, search?: any, page?: any, paginationData?: any) => Promise<TreeItem[] | ExtendedResult<TreeItem[]>>;
+    getIntegrationFiles: (options: {
+        credentials: any;
+        settings?: any;
+        parentId?: any;
+        search?: any;
+        page?: any;
+        paginationData?: any;
+    }) => Promise<TreeItem[] | ExtendedResult<TreeItem[]>>;
     /**
      * function to update crowdin files (e.g. pull integration data to crowdin source files)
      */
-    updateCrowdin: ({ projectId, client, credentials, request, rootFolder, appSettings, uploadTranslations, job, excludedTargetLanguages, }: {
+    updateCrowdin: ({ projectId, client, credentials, request, rootFolder, settings, uploadTranslations, job, excludedTargetLanguages, }: {
         projectId: number;
         client: Crowdin;
         credentials: any;
         request: IntegrationFile[];
         rootFolder?: SourceFilesModel.Directory;
-        appSettings?: any;
+        settings?: any;
         uploadTranslations?: boolean;
         job: JobClient;
         excludedTargetLanguages?: string[];
@@ -58,13 +85,13 @@ export interface IntegrationLogic extends ModuleKey {
     /**
      * function to update integration content (e.g. load crowdin translations and push them to integration service)
      */
-    updateIntegration: ({ projectId, client, credentials, request, rootFolder, appSettings, job, }: {
+    updateIntegration: ({ projectId, client, credentials, request, rootFolder, settings, job, }: {
         projectId: number;
         client: Crowdin;
         credentials: any;
         request: UpdateIntegrationRequest;
         rootFolder?: SourceFilesModel.Directory;
-        appSettings?: any;
+        settings?: any;
         job: JobClient;
     }) => Promise<void | ExtendedResult<void>>;
     /**
@@ -74,19 +101,30 @@ export interface IntegrationLogic extends ModuleKey {
     /**
      * function to define configuration(settings) modal for you app (by default app will not have any custom settings)
      */
-    getConfiguration?: (projectId: number, client: Crowdin, apiCredentials: any) => Promise<FormEntity[]>;
+    getConfiguration?: (options: {
+        projectId: number;
+        client: Crowdin;
+        credentials: any;
+        settings: any;
+        clientId: string;
+    }) => Promise<FormEntity[]>;
     /**
      * function to normalize saved settings
      */
-    normalizeSettings?: ({ appSettings, apiCredentials, client, }: {
-        appSettings: FormEntity[];
-        apiCredentials: any;
+    normalizeSettings?: ({ settings, credentials, client, }: {
+        settings: FormEntity[];
+        credentials: any;
         client?: Crowdin;
     }) => Promise<FormEntity[]>;
     /**
      * Logout hook for cleanup logic
      */
-    onLogout?: (projectId: number, client: Crowdin, apiCredentials: any, config?: any) => Promise<void>;
+    onLogout?: (options: {
+        projectId: number;
+        client: Crowdin;
+        credentials: any;
+        settings?: any;
+    }) => Promise<void>;
     /**
      * flag to turn on auto reload of the tree whenever user updates the configuration
      */
@@ -184,6 +222,15 @@ export interface IntegrationLogic extends ModuleKey {
      * Enable the option to upload file for translation into selected languages.
      */
     excludedTargetLanguages?: boolean;
+    /**
+     * function to update target languages for existing Crowdin files.
+     */
+    updateFilesTargetLanguages?: ({ projectId, client, fileIds, excludedTargetLanguages, }: {
+        projectId: number;
+        client: Crowdin;
+        fileIds: number[];
+        excludedTargetLanguages: string[];
+    }) => Promise<void>;
     /**
      * Enable the option to add 'Exclude paths' and 'Include paths' text fields to integration settings
      */
@@ -191,7 +238,11 @@ export interface IntegrationLogic extends ModuleKey {
     /**
      * function to get crowdin file translation progress
      */
-    getFileProgress?: (projectId: number, client: Crowdin, fileId: number) => Promise<{
+    getFileProgress?: (options: {
+        projectId: number;
+        client: Crowdin;
+        fileId: number;
+    }) => Promise<{
         [key: number]: TranslationStatusModel.LanguageProgress[];
     }>;
     /**
@@ -264,7 +315,10 @@ export interface OAuthLogin {
     /**
      * Authorization url getter
      */
-    getAuthorizationUrl?: (redirectUrl: string, loginForm: any) => string;
+    getAuthorizationUrl?: (options: {
+        redirectUrl: string;
+        loginForm: any;
+    }) => string;
     /**
      * Access token url (e.g. https://github.com/login/oauth/access_token)
      */
@@ -356,13 +410,22 @@ export interface OAuthLogin {
     /**
      * Override to implement request for retrieving access token (and refresh token if 'refresh' is enabled)
      */
-    performGetTokenRequest?: (code: string, query: {
-        [key: string]: any;
-    }, url: string, redirectUri: string, loginForm?: any) => Promise<any>;
+    performGetTokenRequest?: (options: {
+        code: string;
+        query: {
+            [key: string]: any;
+        };
+        url: string;
+        redirectUri: string;
+        loginForm?: any;
+    }) => Promise<any>;
     /**
      * Override to implement request for refreshing token (only if 'refresh' is enabled)
      */
-    performRefreshTokenRequest?: (currentCredentials: any, loginForm?: any) => Promise<any>;
+    performRefreshTokenRequest?: (options: {
+        credentials: any;
+        loginForm?: any;
+    }) => Promise<any>;
 }
 export type CrowdinFilesLoadMode = 'directories' | 'files';
 export interface BaseTreeItem {
@@ -461,12 +524,22 @@ export interface IntegrationFile {
 export interface UpdateIntegrationRequest {
     [fileId: string]: string[];
 }
+export interface UpdateTargetLanguagesRequest {
+    fileIds: number[];
+    languages: string[];
+}
 export interface IntegrationRequest extends CrowdinClientRequest {
     integrationCredentials: any;
     integrationSettings?: any;
 }
 export interface CronJob {
-    task: (projectId: number, client: Crowdin, apiCredentials: any, appRootFolder?: SourceFilesModel.Directory, config?: any) => Promise<void>;
+    task: (options: {
+        projectId: number;
+        client: Crowdin;
+        credentials: any;
+        rootFolder?: SourceFilesModel.Directory;
+        settings?: any;
+    }) => Promise<void>;
     expression: string;
 }
 export interface ExtendedResult<T> {
@@ -474,6 +547,10 @@ export interface ExtendedResult<T> {
     message?: string;
     stopPagination?: boolean;
 }
+export interface MatchingResult<T> {
+    data: T;
+    errors?: Error[] | AppModuleError[] | AppUserModuleError[];
+}
 type LabelTreeElementType = 'primary' | 'secondary' | 'success' | 'warning' | 'info' | 'danger' | 'dark' | 'light';
 export interface LabelTreeElement {
     text: string;
@@ -514,10 +591,36 @@ export interface Webhooks {
     crowdinWebhookUrl?: string;
     integrationWebhookUrl?: string;
     urlParam?: string;
-    crowdinWebhooks?: (client: Crowdin, projectId: number, available: boolean, config?: AppSettings) => Promise<void>;
-    integrationWebhooks?: (apiCredentials: any, urlParam: string, available: boolean, config?: AppSettings, syncSettings?: any) => Promise<void>;
-    crowdinWebhookInterceptor?: (projectId: number, client: Crowdin, appRootFolder?: SourceFilesModel.Directory, config?: any, syncSettings?: any, webhookRequest?: any) => Promise<UpdateIntegrationRequest>;
-    integrationWebhookInterceptor?: (projectId: number, client: Crowdin, apiCredentials: any, appRootFolder?: SourceFilesModel.Directory, config?: AppSettings, syncSettings?: any, webhookRequests?: any) => Promise<IntegrationFile[]>;
+    crowdinWebhooks?: (options: {
+        client: Crowdin;
+        projectId: number;
+        available: boolean;
+        settings?: AppSettings;
+    }) => Promise<void>;
+    integrationWebhooks?: (options: {
+        credentials: any;
+        urlParam: string;
+        available: boolean;
+        settings?: AppSettings;
+        syncSettings?: any;
+    }) => Promise<void>;
+    crowdinWebhookInterceptor?: (options: {
+        projectId: number;
+        client: Crowdin;
+        rootFolder?: SourceFilesModel.Directory;
+        settings?: any;
+        syncSettings?: any;
+        webhookRequest?: any;
+    }) => Promise<UpdateIntegrationRequest>;
+    integrationWebhookInterceptor?: (options: {
+        projectId: number;
+        client: Crowdin;
+        credentials: any;
+        rootFolder?: SourceFilesModel.Directory;
+        settings?: AppSettings;
+        syncSettings?: any;
+        webhookRequests?: any;
+    }) => Promise<IntegrationFile[]>;
     queueUrl: string;
 }
 export declare enum SyncCondition {
@@ -547,10 +650,10 @@ export interface UpdateCrowdinWebhookPayloadsArgs {
 }
 export interface FilterSyncFilesArgs {
     projectId: number;
-    crowdinClient: Crowdin;
+    client: Crowdin;
     events: Payload[];
     syncFileSettings: UpdateIntegrationRequest;
-    appSettings: AppSettings;
+    settings: AppSettings;
 }
 export interface AppSettings {
     schedule?: number;
@@ -566,6 +669,7 @@ interface LoginFormTokenResponse {
 }
 export declare enum DefaultCategory {
     GENERAL = "General Settings",
-    SYNC = "Sync settings"
+    SYNC = "Sync settings",
+    ADVANCED = "Advanced"
 }
 export {};

package/out/modules/integration/types.js

@@ -21,4 +21,5 @@ var DefaultCategory;
 (function (DefaultCategory) {
     DefaultCategory["GENERAL"] = "General Settings";
     DefaultCategory["SYNC"] = "Sync settings";
+    DefaultCategory["ADVANCED"] = "Advanced";
 })(DefaultCategory = exports.DefaultCategory || (exports.DefaultCategory = {}));

package/out/modules/integration/util/cron.d.ts

@@ -7,7 +7,7 @@ export declare function runJob({ config, integration, job, }: {
     integration: IntegrationLogic;
     job: CronJob;
 }): Promise<void>;
-export declare function runUpdateProviderJob({ integrationId, crowdinId, type, title, payload, jobType, projectId, client, integration, context, credentials, rootFolder, appSettings, reRunJobId, }: {
+export declare function runUpdateProviderJob({ integrationId, crowdinId, type, title, payload, jobType, projectId, client, integration, context, credentials, rootFolder, settings, reRunJobId, }: {
     integrationId: string;
     crowdinId: string;
     type: JobType;
@@ -20,7 +20,7 @@ export declare function runUpdateProviderJob({ integrationId, crowdinId, type, t
     context: CrowdinContextInfo;
     credentials: any;
     rootFolder?: SourceFilesModel.Directory;
-    appSettings?: any;
+    settings?: any;
     reRunJobId?: string;
 }): Promise<void>;
 export declare function filesCron({ config, integration, period, }: {

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

@@ -69,11 +69,17 @@ function runJob({ config, integration, job, }) {
             for (const integrationCredentials of integrationCredentialsList) {
                 const integrationConfig = allIntegrationConfigs.find(({ integrationId }) => integrationId === integrationCredentials.id);
                 const projectId = crowdinAppFunctions.getProjectId(integrationCredentials.id);
-                const apiCredentials = yield (0, connection_1.prepareIntegrationCredentials)(config, integration, integrationCredentials);
+                const credentials = yield (0, connection_1.prepareIntegrationCredentials)(config, integration, integrationCredentials);
                 const rootFolder = yield (0, defaults_1.getRootFolder)(config, integration, crowdinClient, projectId);
                 const intConfig = (integrationConfig === null || integrationConfig === void 0 ? void 0 : integrationConfig.config) ? JSON.parse(integrationConfig.config) : undefined;
                 (0, logger_1.log)(`Executing task for cron job with expression [${job.expression}] for project ${projectId}`);
-                yield job.task(projectId, crowdinClient, apiCredentials, rootFolder, intConfig);
+                yield job.task({
+                    projectId,
+                    client: crowdinClient,
+                    credentials,
+                    rootFolder,
+                    settings: intConfig,
+                });
                 (0, logger_1.log)(`Task for cron job with expression [${job.expression}] for project ${projectId} completed`);
             }
         })));
@@ -81,7 +87,7 @@ function runJob({ config, integration, job, }) {
     });
 }
 exports.runJob = runJob;
-function runUpdateProviderJob({ integrationId, crowdinId, type, title, payload, jobType, projectId, client, integration, context, credentials, rootFolder, appSettings, reRunJobId, }) {
+function runUpdateProviderJob({ integrationId, crowdinId, type, title, payload, jobType, projectId, client, integration, context, credentials, rootFolder, settings, reRunJobId, }) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
             yield (0, job_1.runAsJob)({
@@ -96,17 +102,16 @@ function runUpdateProviderJob({ integrationId, crowdinId, type, title, payload,
                 reRunJobId,
                 jobStoreType: integration.jobStoreType,
                 jobCallback: (job) => __awaiter(this, void 0, void 0, function* () {
-                    const updateParams = {
-                        projectId,
-                        client,
-                        credentials,
-                        request: payload,
-                        rootFolder,
-                        appSettings,
-                        job,
-                    };
                     if (type === types_2.JobType.UPDATE_TO_CROWDIN) {
-                        yield integration.updateCrowdin(updateParams);
+                        yield integration.updateCrowdin({
+                            projectId,
+                            client,
+                            credentials,
+                            request: payload,
+                            rootFolder,
+                            settings,
+                            job,
+                        });
                         try {
                             yield (0, files_1.updateSyncedData)(integrationId, crowdinId, payload, types_1.Provider.INTEGRATION);
                         }
@@ -115,7 +120,15 @@ function runUpdateProviderJob({ integrationId, crowdinId, type, title, payload,
                         }
                     }
                     else if (type === types_2.JobType.UPDATE_TO_INTEGRATION) {
-                        yield integration.updateIntegration(updateParams);
+                        yield integration.updateIntegration({
+                            projectId,
+                            client,
+                            credentials,
+                            request: payload,
+                            rootFolder,
+                            settings,
+                            job,
+                        });
                     }
                 }),
             });
@@ -219,7 +232,7 @@ function processSyncSettings({ config, integration, period, syncSettings, }) {
         }
         context.jwtPayload.context.project_identifier = projectData.identifier;
         const rootFolder = yield (0, defaults_1.getRootFolder)(config, integration, crowdinClient, projectId);
-        const apiCredentials = yield (0, connection_1.prepareIntegrationCredentials)(config, integration, integrationCredentials);
+        const credentials = yield (0, connection_1.prepareIntegrationCredentials)(config, integration, integrationCredentials);
         let currentFileSnapshot = [];
         const needsSnapshotForNewFiles = !integration.webhooks &&
             ((_a = integration.syncNewElements) === null || _a === void 0 ? void 0 : _a[syncSettings.provider]) &&
@@ -227,7 +240,7 @@ function processSyncSettings({ config, integration, period, syncSettings, }) {
         const needsIntegrationSnapshot = needsSnapshotForNewFiles && syncSettings.provider !== types_1.Provider.CROWDIN;
         const needsCrowdinSnapshot = needsSnapshotForNewFiles && syncSettings.provider === types_1.Provider.CROWDIN;
         if (needsIntegrationSnapshot) {
-            currentFileSnapshot = yield (0, snapshot_1.getIntegrationSnapshot)(integration, apiCredentials, intConfig);
+            currentFileSnapshot = yield (0, snapshot_1.getIntegrationSnapshot)(integration, credentials, intConfig);
         }
         else if (needsCrowdinSnapshot) {
             currentFileSnapshot = yield (0, snapshot_1.getCrowdinSnapshot)(config, integration, crowdinClient, projectData.id, intConfig);
@@ -311,7 +324,7 @@ function processSyncSettings({ config, integration, period, syncSettings, }) {
                     return;
                 }
             }
-            const apiCredentials = yield (0, connection_1.prepareIntegrationCredentials)(config, integration, integrationCredentials);
+            const credentials = yield (0, connection_1.prepareIntegrationCredentials)(config, integration, integrationCredentials);
             if (!(intConfig === null || intConfig === void 0 ? void 0 : intConfig.inContext)) {
                 removeInContextLanguage(filesToProcess, projectData);
             }
@@ -327,9 +340,9 @@ function processSyncSettings({ config, integration, period, syncSettings, }) {
                     client: crowdinClient,
                     integration,
                     context,
-                    credentials: apiCredentials,
+                    credentials,
                     rootFolder,
-                    appSettings: intConfig,
+                    settings: intConfig,
                 });
             }
             catch (e) {
@@ -361,12 +374,15 @@ function processSyncSettings({ config, integration, period, syncSettings, }) {
                 return;
             }
             (0, logger_1.log)(`Executing updateCrowdin task for files cron job with period [${period}] for project ${projectId}. Files ${intFiles.length}`);
-            const apiCredentials = yield (0, connection_1.prepareIntegrationCredentials)(config, integration, integrationCredentials);
+            const credentials = yield (0, connection_1.prepareIntegrationCredentials)(config, integration, integrationCredentials);
             if (integration.filterByPathIntegrationFiles) {
                 const includePatterns = (_b = intConfig === null || intConfig === void 0 ? void 0 : intConfig.includeByFilePath) === null || _b === void 0 ? void 0 : _b.split('\n').filter(Boolean);
                 const excludePatterns = (_c = intConfig === null || intConfig === void 0 ? void 0 : intConfig.excludeByFilePath) === null || _c === void 0 ? void 0 : _c.split('\n').filter(Boolean);
                 try {
-                    const fullTreeResult = yield integration.getIntegrationFiles(apiCredentials, intConfig);
+                    const fullTreeResult = yield integration.getIntegrationFiles({
+                        credentials,
+                        settings: intConfig,
+                    });
                     const fullTree = (0, files_1.isExtendedResultType)(fullTreeResult) ? fullTreeResult.data || [] : fullTreeResult;
                     const filteredFiles = (0, files_1.filterFilesByPath)(fullTree, includePatterns, excludePatterns);
                     const filteredFileIds = new Set(filteredFiles.map((f) => f.id));
@@ -394,9 +410,9 @@ function processSyncSettings({ config, integration, period, syncSettings, }) {
                     client: crowdinClient,
                     integration,
                     context,
-                    credentials: apiCredentials,
+                    credentials,
                     rootFolder,
-                    appSettings: intConfig,
+                    settings: intConfig,
                 });
             }
             catch (e) {
@@ -405,7 +421,7 @@ function processSyncSettings({ config, integration, period, syncSettings, }) {
             if (Object.keys(newFiles).length) {
                 const newSyncSettingsFields = allIntFiles.map((file) => (Object.assign(Object.assign({}, file), { schedule: true, sync: false })));
                 yield (0, storage_1.getStorage)().updateSyncSettings(JSON.stringify(newSyncSettingsFields), syncSettings.integrationId, syncSettings.crowdinId, 'schedule', syncSettings.provider);
-                const currentFileSnapshot = yield (0, snapshot_1.getIntegrationSnapshot)(integration, apiCredentials, intConfig);
+                const currentFileSnapshot = yield (0, snapshot_1.getIntegrationSnapshot)(integration, credentials, intConfig);
                 yield (0, storage_1.getStorage)().updateFilesSnapshot(JSON.stringify(currentFileSnapshot), syncSettings.integrationId, syncSettings.crowdinId, syncSettings.provider);
             }
             (0, logger_1.log)(`updateCrowdin task for files cron job with period [${period}] for project ${projectId} completed`);

package/out/modules/integration/util/defaults.d.ts

@@ -16,3 +16,7 @@ export declare function groupFieldsByCategory(fields: FormEntity[]): {
     name: string;
     fields: FormField[];
 }[];
+export declare function buildMenuItems(integration: IntegrationLogic, appName: string): {
+    integrationButtonMenuItems: string | null;
+    crowdinButtonMenuItems: string | null;
+};