@crowdin/app-project-module 0.39.1 → 0.41.0

package/out/models/index.d.ts

@@ -5,6 +5,7 @@ import { Request } from 'express';
 import { MySQLStorageConfig } from '../storage/mysql';
 import { PostgreStorageConfig } from '../storage/postgre';
 import { LogErrorFunction, LogFunction } from '../util/logger';
+import { JobClient } from './job';
 export interface ClientConfig extends ImagePath {
     /**
      * Authentication Crowdin App type: "authorization_code", "crowdin_app". Default: "crowdin_app"
@@ -153,10 +154,6 @@ export interface ClientConfig extends ImagePath {
     filePostImport?: FilePostImportLogic;
     filePreExport?: FilePreExportLogic;
     filePostExport?: FilePostExportLogic;
-    /**
-     * sentry dsn identifier of sentry project
-     */
-    sentryDsn?: string;
     /**
      * Disable formatting logs
      */
@@ -201,7 +198,8 @@ export declare enum Scope {
     SOURCE_FILES_AND_STRINGS = "project.source",
     WEBHOOKS = "project.webhook",
     TRANSLATIONS = "project.translation",
-    SCREENSHOTS = "project.screenshot"
+    SCREENSHOTS = "project.screenshot",
+    SECURITY_LOGS = "security-log"
 }
 export interface IntegrationLogic {
     /**
@@ -235,11 +233,28 @@ export interface IntegrationLogic {
     /**
      * function to update crowdin files (e.g. pull integration data to crowdin source files)
      */
-    updateCrowdin: (projectId: number, client: Crowdin, apiCredentials: any, request: IntegrationFile[], appRootFolder?: SourceFilesModel.Directory, config?: any, uploadTranslations?: boolean) => Promise<void | ExtendedResult<void>>;
+    updateCrowdin: ({ projectId, client, credentials, request, rootFolder, appSettings, uploadTranslations, job, }: {
+        projectId: number;
+        client: Crowdin;
+        credentials: any;
+        request: IntegrationFile[];
+        rootFolder?: SourceFilesModel.Directory;
+        appSettings?: any;
+        uploadTranslations?: boolean;
+        job: JobClient;
+    }) => Promise<void | ExtendedResult<void>>;
     /**
      * function to update integration content (e.g. load crowdin translations and push them to integration service)
      */
-    updateIntegration: (projectId: number, client: Crowdin, apiCredentials: any, request: UpdateIntegrationRequest, appRootFolder?: SourceFilesModel.Directory, config?: any) => Promise<void | ExtendedResult<void>>;
+    updateIntegration: ({ projectId, client, credentials, request, rootFolder, appSettings, job, }: {
+        projectId: number;
+        client: Crowdin;
+        credentials: any;
+        request: UpdateIntegrationRequest;
+        rootFolder?: SourceFilesModel.Directory;
+        appSettings?: any;
+        job: JobClient;
+    }) => Promise<void | ExtendedResult<void>>;
     /**
      * function to define configuration(settings) modal for you app (by default app will not have any custom settings)
      */
@@ -317,6 +332,19 @@ export interface IntegrationLogic {
         icon: boolean;
         close: boolean;
     };
+    skipIntegrationNodes?: SkipIntegrationNodes;
+    /**
+     * Async progress checking time interval to update job progress, im ms.
+     *
+     * Default 1000
+     */
+    asyncProgress?: {
+        checkInterval?: number;
+    };
+}
+export interface SkipIntegrationNodes {
+    fileNamePattern?: string;
+    folderNamePattern?: string;
 }
 export type FormEntity = FormField | FormDelimiter;
 export interface FormDelimiter {
@@ -533,6 +561,7 @@ export interface CrowdinContextInfo {
     jwtPayload: JwtPayload;
     crowdinId: string;
     clientId: string;
+    appIdentifier: string;
 }
 export declare enum SubscriptionInfoType {
     TRIAL = "trial",
@@ -548,7 +577,12 @@ export interface IntegrationCredentials {
     id: string;
     credentials: any;
     crowdinId: string;
-    config?: any;
+}
+export interface IntegrationConfig {
+    id: number;
+    integrationId: string;
+    crowdinId: string;
+    config: any;
 }
 export interface IntegrationFile {
     id: string;
@@ -814,14 +848,7 @@ export declare enum ContextOptionsTypes {
     NEW_TAB = "new_tab",
     REDIRECT = "redirect"
 }
-export interface CrowdinAppUtilities {
-    saveMetadata: (id: string, metadata: any, crowdinId?: string) => Promise<void>;
-    getMetadata: (id: string) => Promise<any | undefined>;
-    deleteMetadata: (id: string) => Promise<void>;
-    /**
-     * Settings that users manage in the integration module
-     */
-    getUserSettings: (clientId: string) => Promise<any | undefined>;
+export interface CrowdinAppUtilities extends CrowdinMetadataStore {
     establishCrowdinConnection: (authRequest: string | CrowdinClientRequest) => Promise<{
         context: CrowdinContextInfo;
         client?: Crowdin;
@@ -835,6 +862,15 @@ export interface CrowdinAppUtilities {
         extra: Record<string, any>;
     }>;
 }
+export interface CrowdinMetadataStore {
+    saveMetadata: (id: string, metadata: any, crowdinId?: string) => Promise<void>;
+    getMetadata: (id: string) => Promise<any | undefined>;
+    deleteMetadata: (id: string) => Promise<void>;
+    /**
+     * Settings that users manage in the integration module
+     */
+    getUserSettings: (clientId: string) => Promise<any | undefined>;
+}
 export declare enum Provider {
     CROWDIN = "crowdin",
     INTEGRATION = "integration"
@@ -914,7 +950,7 @@ export interface Webhooks {
     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, webhookRequest?: any) => Promise<IntegrationFile[]>;
+    integrationWebhookInterceptor?: (projectId: number, client: Crowdin, apiCredentials: any, appRootFolder?: SourceFilesModel.Directory, config?: AppSettings, syncSettings?: any, webhookRequests?: any) => Promise<IntegrationFile[]>;
     queueUrl: string;
 }
 export declare enum SyncCondition {
@@ -951,7 +987,7 @@ export interface GetAllNewFilesArgs {
 export interface UpdateCrowdinWebhookPayloadsArgs {
     integration: IntegrationLogic;
     webhookData: any;
-    req: Request;
+    req: Request[];
 }
 export interface FilterSyncFilesArgs {
     projectId: number;

package/out/models/index.js

@@ -24,6 +24,7 @@ var Scope;
     Scope["WEBHOOKS"] = "project.webhook";
     Scope["TRANSLATIONS"] = "project.translation";
     Scope["SCREENSHOTS"] = "project.screenshot";
+    Scope["SECURITY_LOGS"] = "security-log";
 })(Scope = exports.Scope || (exports.Scope = {}));
 var AccountType;
 (function (AccountType) {

package/out/models/job.d.ts

@@ -0,0 +1,44 @@
+export declare enum JobType {
+    UPDATE_TO_CROWDIN = "updateCrowdin",
+    UPDATE_TO_INTEGRATION = "updateIntegration"
+}
+export declare enum JobStatus {
+    CREATED = "created",
+    IN_PROGRESS = "inProgress",
+    FINISHED = "finished",
+    FAILED = "failed",
+    CANCELED = "canceled"
+}
+export interface Job {
+    id: string;
+    integrationId: string;
+    crowdinId: string;
+    type: JobType;
+    title: string;
+    progress: number;
+    status: JobStatus;
+    payload?: any;
+    data?: any;
+    createdAt: number;
+    updatedAt?: number;
+    finishedAt?: number;
+    eta?: number;
+    info?: string;
+}
+export type GetJobParams = Pick<Job, 'id'>;
+export type GetActiveJobsParams = Pick<Job, 'integrationId' | 'crowdinId'>;
+export type CreateJobParams = Pick<Job, 'integrationId' | 'crowdinId' | 'type' | 'payload' | 'title'>;
+export type UpdateJobParams = {
+    id: string;
+    progress?: number;
+    status?: JobStatus;
+    info?: string;
+    data?: string;
+};
+export type JobClient = {
+    get: () => Promise<Job | undefined>;
+    update: UpdateJobProgress;
+};
+export type UpdateJobProgress = ({ progress, status, info, data, }: Omit<UpdateJobParams, 'id'>) => Promise<{
+    isCanceled: boolean;
+}>;

package/out/models/job.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobStatus = exports.JobType = void 0;
+var JobType;
+(function (JobType) {
+    JobType["UPDATE_TO_CROWDIN"] = "updateCrowdin";
+    JobType["UPDATE_TO_INTEGRATION"] = "updateIntegration";
+})(JobType = exports.JobType || (exports.JobType = {}));
+var JobStatus;
+(function (JobStatus) {
+    JobStatus["CREATED"] = "created";
+    JobStatus["IN_PROGRESS"] = "inProgress";
+    JobStatus["FINISHED"] = "finished";
+    JobStatus["FAILED"] = "failed";
+    JobStatus["CANCELED"] = "canceled";
+})(JobStatus = exports.JobStatus || (exports.JobStatus = {}));