@crowdin/app-project-module 0.28.0 → 0.28.2

package/out/models/index.d.ts

@@ -3,7 +3,7 @@ import { JwtPayload, VerifyOptions } from '@crowdin/crowdin-apps-functions';
 import { Request } from 'express';
 import { MySQLStorageConfig } from '../storage/mysql';
 import { PostgreStorageConfig } from '../storage/postgre';
-export interface Config extends ImagePath {
+export interface ClientConfig extends ImagePath {
     /**
      * Authentication Crowdin App type: "authorization_code", "crowdin_app". Default: "crowdin_app"
      */
@@ -11,11 +11,11 @@ export interface Config extends ImagePath {
     /**
      * client id that we received when registering the app
      */
-    clientId: string;
+    clientId?: string;
     /**
      * client secret that we received when registering the app
      */
-    clientSecret: string;
+    clientSecret?: string;
     /**
      * Secret to encrypt/decrypt credentials (by default @clientSecret will be used)
      */
@@ -27,7 +27,7 @@ export interface Config extends ImagePath {
     /**
      * https url where an app is reachable from the internet (e.g. the one that ngrok generates for us)
      */
-    baseUrl: string;
+    baseUrl?: string;
     /**
      * define custom Crowdin urls (e.g. to work against local Crowdin server)
      */
@@ -104,6 +104,14 @@ export interface Config extends ImagePath {
      * reports module
      */
     projectReports?: UiModule & ImagePath;
+    /**
+     * context menu module
+     */
+    contextMenu?: ContextModule & UiModule & Environments;
+    /**
+     * modal module
+     */
+    modal?: ModuleContent & UiModule & Environments;
     /**
      * Uninstall hook for cleanup logic
      */
@@ -127,7 +135,19 @@ export interface Config extends ImagePath {
      * Configuration of app pricing
      */
     pricing?: Pricing;
+    filePreImport?: FilePreImportLogic;
+    filePostImport?: FilePostImportLogic;
+    filePreExport?: FilePreExportLogic;
+    filePostExport?: FilePostExportLogic;
 }
+export type Config = ClientConfig & {
+    baseUrl: string;
+    clientId: string;
+    clientSecret: string;
+    port: number;
+    dbFolder: string;
+    imagePath: string;
+};
 export declare enum AuthenticationType {
     CODE = "authorization_code",
     APP = "crowdin_app"
@@ -250,7 +270,7 @@ export interface IntegrationLogic {
      */
     webhooks?: Webhooks;
 }
-export declare type FormEntity = FormField | FormDelimeter;
+export type FormEntity = FormField | FormDelimeter;
 export interface FormDelimeter {
     label: string;
 }
@@ -403,13 +423,13 @@ export interface ExtendedResult<T> {
     message?: string;
     stopPagination?: boolean;
 }
-export declare type TreeItem = File | Folder;
+export type TreeItem = File | Folder;
 /**
  * 0 - folder
  * 1 - file
  * 2 - branch
  */
-declare type IntegrationTreeElementType = '0' | '1' | '2';
+type IntegrationTreeElementType = '0' | '1' | '2';
 export interface File {
     id: string;
     name: string;
@@ -484,23 +504,29 @@ export interface CronJob {
     task: (projectId: number, client: Crowdin, apiCredentials: any, appRootFolder?: SourceFilesModel.Directory, config?: any) => Promise<void>;
     expression: string;
 }
-export interface CustomFileFormatLogic {
-    /**
-     * The type parameter value for a custom file format. Used for a custom format file upload via API.
-     */
-    type: string;
+export interface FileProcessLogic {
     /**
      * Folder where larger file will be temporary stored (default "{@link dbFolder}/custom-file-format")
      */
     filesFolder?: string;
-    /**
-     * This parameter is used to combine the content of multiple languages into one request when uploading and downloading translations in your Crowdin project.
-     */
-    multilingual?: boolean;
     /**
      * Contains fileName and/or fileContent regular expressions used to detect file type when uploading a new source file via UI (or via API without specified type parameter). If the file matches regular expressions, it's labeled as a custom format file.
      */
     signaturePatterns?: SignaturePatterns;
+    /**
+     * Override to store huge responses (by default they will be stored in fs)
+     */
+    storeFile?: (content: string) => Promise<string>;
+}
+export interface CustomFileFormatLogic extends FileProcessLogic {
+    /**
+     * The type parameter value for a custom file format. Used for a custom format file upload via API.
+     */
+    type: string;
+    /**
+     * This parameter is used to combine the content of multiple languages into one request when uploading and downloading translations in your Crowdin project.
+     */
+    multilingual?: boolean;
     /**
      * Flag to automatically upload translations
      */
@@ -533,10 +559,19 @@ export interface CustomFileFormatLogic {
      * Used for strings export
      */
     exportStrings?: (req: Omit<ProcessFileRequest, 'jobType'>, strings: ProcessFileString[], client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
-    /**
-     * Override to store huge responses (by default they will be stored in fs)
-     */
-    storeFile?: (content: string) => Promise<string>;
+}
+export type FileImportExportLogic = FilePreImportLogic | FilePostImportLogic | FilePreExportLogic | FilePostExportLogic;
+export interface FilePreImportLogic extends FileProcessLogic {
+    fileProcess: (req: ProcessFileRequest, content: string, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
+}
+export interface FilePostImportLogic extends FileProcessLogic {
+    fileProcess: (req: ProcessFileRequest, content: string, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<ParseFileResponse>;
+}
+export interface FilePreExportLogic extends FileProcessLogic {
+    fileProcess: (req: ProcessFileRequest, content: string, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<ParseFileResponse>;
+}
+export interface FilePostExportLogic extends FileProcessLogic {
+    fileProcess: (req: ProcessFileRequest, content: string, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
 }
 export interface SignaturePatterns {
     fileName?: string;
@@ -559,7 +594,11 @@ export interface ProcessFileRecord {
 }
 export declare enum ProcessFileJobType {
     PARSE_FILE = "parse-file",
-    BUILD_FILE = "build-file"
+    BUILD_FILE = "build-file",
+    PRE_IMPORT = "pre-import-file",
+    POST_IMPORT = "post-import-file",
+    PRE_EXPORT = "pre-export-file",
+    POST_EXPORT = "post-export-file"
 }
 export interface ParseFileResponse {
     previewFile?: string;
@@ -568,7 +607,10 @@ export interface ParseFileResponse {
 }
 export interface BuildFileResponse {
     contentFile: string;
+    base64EncodedContent?: string;
     error?: string;
+    fileName?: string;
+    fileType?: string;
 }
 export interface ProcessFileString {
     previewId?: number;
@@ -582,6 +624,7 @@ export interface ProcessFileString {
     labels?: string[];
     text: string | SourceStringsModel.PluralText;
     translations?: StringTranslations;
+    uniqId?: string;
 }
 export interface StringTranslations {
     [language: string]: {
@@ -602,10 +645,19 @@ export interface UiModule {
      */
     formSchema?: object;
     /**
-     * URL to custom endpoint that can be used instead of default one to save and retrieve form data.
-     * Endpoint should accept both POST requests for data saving and GET requests for data retrieving.
+     * URL to custom endpoint that can be used instead of default one to save form data.
+     * Endpoint should accept POST requests.
+     */
+    formPostDataUrl?: string;
+    /**
+     * URL to custom endpoint that can be used instead of default one to retrieve form data.
+     * Endpoint should accept GET requests.
+     */
+    formGetDataUrl?: string;
+    /**
+     * Additional attributes for react-jsonschema-doc
      */
-    formDataUrl?: string;
+    formUiSchema?: object;
     /**
      * path to ui folder (e.g. {@example join(__dirname, 'public')})
      */
@@ -631,6 +683,30 @@ export declare enum EditorPanelsMode {
     TRANSLATE = "TRANSLATE",
     PROOFREAD = "proofread"
 }
+interface ModuleContent {
+    /**
+     * relative URL to the content page of the module
+     */
+    url?: string;
+}
+export interface ContextModule {
+    location: ContextOptionsLocations;
+    type: ContextOptionsTypes;
+    module: string;
+}
+export declare enum ContextOptionsLocations {
+    TM = "tm",
+    GLOSSARY = "glossary",
+    LANGUAGE = "language",
+    SCREENSHOT = "screenshot",
+    SOURCE_FILE = "source_file",
+    TRANSLATED_FILE = "translated_file"
+}
+export declare enum ContextOptionsTypes {
+    MODAL = "modal",
+    NEW_TAB = "new_tab",
+    REDIRECT = "redirect"
+}
 export interface CrowdinAppUtilities {
     saveMetadata: (id: string, metadata: any) => Promise<void>;
     getMetadata: (id: string) => Promise<any | undefined>;
@@ -675,8 +751,8 @@ export interface Webhooks {
     urlParam?: string;
     crowdinWebhooks?: (client: Crowdin, projectId: number, available: boolean, config?: any) => Promise<void>;
     integrationWebhooks?: (apiCredentials: any, urlParam: string, available: boolean, config?: any, syncSettings?: any) => Promise<void>;
-    crowdinWebhookInterceptor?: (projectId: number, client: Crowdin, appRootFolder?: SourceFilesModel.Directory, config?: any, syncSettings?: any) => Promise<UpdateIntegrationRequest>;
-    integrationWebhookInterceptor?: (projectId: number, client: Crowdin, appRootFolder?: SourceFilesModel.Directory, config?: any, syncSettings?: any, webhookRequest?: any) => Promise<IntegrationFile[]>;
+    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?: any, syncSettings?: any, webhookRequest?: any) => Promise<IntegrationFile[]>;
     queueUrl: string;
 }
 export declare enum SyncCondition {
@@ -689,13 +765,13 @@ export declare enum SyncType {
     SCHEDULE = 1,
     WEBHOOKS = 2
 }
-export declare type Payload = {
+export type Payload = {
     event: string;
     projectId: string;
     language: string;
     fileId: string;
 };
-export declare type WebhookUrlParams = {
+export type WebhookUrlParams = {
     projectId: number;
     crowdinId: string;
     clientId: string;

package/out/models/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SyncType = exports.SyncCondition = exports.EditorPanelsMode = exports.ProcessFileJobType = exports.SubscriptionInfoType = exports.AccountType = exports.Scope = exports.AuthenticationType = void 0;
+exports.SyncType = exports.SyncCondition = exports.ContextOptionsTypes = exports.ContextOptionsLocations = exports.EditorPanelsMode = exports.ProcessFileJobType = exports.SubscriptionInfoType = exports.AccountType = exports.Scope = exports.AuthenticationType = void 0;
 var AuthenticationType;
 (function (AuthenticationType) {
     AuthenticationType["CODE"] = "authorization_code";
@@ -39,6 +39,10 @@ var ProcessFileJobType;
 (function (ProcessFileJobType) {
     ProcessFileJobType["PARSE_FILE"] = "parse-file";
     ProcessFileJobType["BUILD_FILE"] = "build-file";
+    ProcessFileJobType["PRE_IMPORT"] = "pre-import-file";
+    ProcessFileJobType["POST_IMPORT"] = "post-import-file";
+    ProcessFileJobType["PRE_EXPORT"] = "pre-export-file";
+    ProcessFileJobType["POST_EXPORT"] = "post-export-file";
 })(ProcessFileJobType = exports.ProcessFileJobType || (exports.ProcessFileJobType = {}));
 var EditorPanelsMode;
 (function (EditorPanelsMode) {
@@ -47,6 +51,21 @@ var EditorPanelsMode;
     EditorPanelsMode["TRANSLATE"] = "TRANSLATE";
     EditorPanelsMode["PROOFREAD"] = "proofread";
 })(EditorPanelsMode = exports.EditorPanelsMode || (exports.EditorPanelsMode = {}));
+var ContextOptionsLocations;
+(function (ContextOptionsLocations) {
+    ContextOptionsLocations["TM"] = "tm";
+    ContextOptionsLocations["GLOSSARY"] = "glossary";
+    ContextOptionsLocations["LANGUAGE"] = "language";
+    ContextOptionsLocations["SCREENSHOT"] = "screenshot";
+    ContextOptionsLocations["SOURCE_FILE"] = "source_file";
+    ContextOptionsLocations["TRANSLATED_FILE"] = "translated_file";
+})(ContextOptionsLocations = exports.ContextOptionsLocations || (exports.ContextOptionsLocations = {}));
+var ContextOptionsTypes;
+(function (ContextOptionsTypes) {
+    ContextOptionsTypes["MODAL"] = "modal";
+    ContextOptionsTypes["NEW_TAB"] = "new_tab";
+    ContextOptionsTypes["REDIRECT"] = "redirect";
+})(ContextOptionsTypes = exports.ContextOptionsTypes || (exports.ContextOptionsTypes = {}));
 var SyncCondition;
 (function (SyncCondition) {
     SyncCondition[SyncCondition["ALL"] = 0] = "ALL";