@crowdin/app-project-module 0.43.1 → 0.45.0

package/out/models/index.d.ts

@@ -1,1088 +0,0 @@
-/// <reference types="node" />
-import Crowdin, { LanguagesModel, SourceFilesModel, SourceStringsModel, TranslationStatusModel } from '@crowdin/crowdin-api-client';
-import { JwtPayload, VerifyOptions } from '@crowdin/crowdin-apps-functions';
-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"
-     */
-    authenticationType?: AuthenticationType;
-    /**
-     * client id that we received when registering the app
-     */
-    clientId?: string;
-    /**
-     * client secret that we received when registering the app
-     */
-    clientSecret?: string;
-    /**
-     * Secret to encrypt/decrypt credentials (by default @clientSecret will be used)
-     */
-    cryptoSecret?: string;
-    /**
-     * Options to validate Crowdin JWT token
-     */
-    jwtValidationOptions?: VerifyOptions;
-    /**
-     * https url where an app is reachable from the internet (e.g. the one that ngrok generates for us)
-     */
-    baseUrl?: string;
-    /**
-     * define custom Crowdin urls (e.g. to work against local Crowdin server)
-     */
-    crowdinUrls?: CrowdinUrls;
-    /**
-     * Set of scopes requested by this app (default 'project')
-     */
-    scopes?: Scope[];
-    /**
-     * app name
-     */
-    name: string;
-    /**
-     * app identifier
-     */
-    identifier: string;
-    /**
-     * app description
-     */
-    description: string;
-    /**
-     * Set default app permissions
-     */
-    defaultPermissions?: DefaultPermissions;
-    /**
-     * port where to start express application
-     */
-    port?: number;
-    /**
-     * folder where module will create sqlite db file to persist credentials (e.g. {@example __dirname})
-     */
-    dbFolder?: string;
-    /**
-     * config to configure PostgreSQL as a storage
-     */
-    postgreConfig?: PostgreStorageConfig;
-    /**
-     * config to configure MySQL as a storage
-     */
-    mysqlConfig?: MySQLStorageConfig;
-    /**
-     * integration module logic
-     */
-    projectIntegration?: IntegrationLogic & ImagePath & Environments;
-    /**
-     * custom file format module logic
-     */
-    customFileFormat?: CustomFileFormatLogic;
-    /**
-     * custom MT module logic
-     */
-    customMT?: CustomMTLogic & ImagePath & Environments;
-    /**
-     * resources module
-     */
-    profileResourcesMenu?: UiModule & ImagePath & Environments;
-    /**
-     * organization-menu module
-     */
-    organizationMenu?: UiModule & ImagePath;
-    /**
-     * editor-right-panel module
-     */
-    editorRightPanel?: EditorPanels & Environments;
-    /**
-     * editor-themes module
-     */
-    editorThemes?: EditorThemes & ImagePath & Environments;
-    /**
-     * project menu module
-     */
-    projectMenu?: UiModule & Environments;
-    /**
-     * project menu crowdsource module
-     */
-    projectMenuCrowdsource?: UiModule;
-    /**
-     * tools module
-     */
-    projectTools?: UiModule & ImagePath & Environments;
-    /**
-     * reports module
-     */
-    projectReports?: UiModule & ImagePath;
-    /**
-     * API module
-     */
-    api?: ApiModule;
-    /**
-     * context menu module
-     */
-    contextMenu?: ContextModule & UiModule & Environments;
-    /**
-     * modal module
-     */
-    modal?: ModuleContent & UiModule & Environments;
-    /**
-     * Uninstall hook for cleanup logic
-     */
-    onUninstall?: (organization: string, allCredentials: {
-        settings?: any;
-        credentials: any;
-    }[]) => Promise<void>;
-    /**
-     * Error interceptor (can be used to log error in centralized place)
-     */
-    onError?: (error: any, context?: CrowdinContextInfo) => void;
-    /**
-     * Disable global error handling of unhandledRejection and uncaughtException events
-     */
-    disableGlobalErrorHandling?: boolean;
-    /**
-     * Configuration to log everything that are happening in the app
-     */
-    logger?: Logger;
-    /**
-     * Configuration of app pricing
-     */
-    pricing?: Pricing;
-    filePreImport?: FilePreImportLogic;
-    filePostImport?: FilePostImportLogic;
-    filePreExport?: FilePreExportLogic;
-    filePostExport?: FilePostExportLogic;
-    /**
-     * Disable formatting logs
-     */
-    disableLogsFormatter?: boolean;
-    /**
-     * AWS configuration for uploading big files to temporary bucket. Used with customFileFormat and file processors modules.
-     *
-     * Not necessary to configure if environment variables AWS_REGION and AWS_TMP_BUCKET_NAME are properly set.
-     */
-    awsConfig?: AWSConfig;
-    customSpellchecker?: CustomSpellcheckerModule;
-}
-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"
-}
-export interface CrowdinUrls {
-    apiUrl?: string;
-    accountUrl?: string;
-    subscriptionUrl?: string;
-}
-export declare enum Scope {
-    ALL_SCOPES = "all",
-    NOTIFICATIONS = "notification",
-    TRANSLATION_MEMORIES = "tm",
-    MACHINE_TRANSLATION_ENGINES = "mt",
-    GLOSSARIES = "glossary",
-    USERS = "user",
-    TEAMS = "team",
-    GROUPS = "group",
-    PROJECTS = "project",
-    TASKS = "project.task",
-    REPORTS = "project.report",
-    TRANSLATION_STATUS = "project.status",
-    SOURCE_FILES_AND_STRINGS = "project.source",
-    WEBHOOKS = "project.webhook",
-    TRANSLATIONS = "project.translation",
-    SCREENSHOTS = "project.screenshot",
-    SECURITY_LOGS = "security-log",
-    VENDORS = "vendor"
-}
-export interface IntegrationLogic {
-    /**
-     * Customize your app login form
-     */
-    loginForm: LoginForm;
-    /**
-     * Define login process via OAuth2 protocol
-     */
-    oauthLogin?: OAuthLogin;
-    /**
-     * name of the root folder in Crowdin where files from integration will be stored, default your app name, will be ignored in case if {@link withRootFolder} is false
-     */
-    appFolderName?: string;
-    /**
-     * flag that defines if the app should have a dedicated root folder in Crowdin files, default 'false'
-     */
-    withRootFolder?: boolean;
-    /**
-     * function which will be used to check connection with integration service
-     */
-    checkConnection?: (apiCredentials: any) => Promise<void>;
-    /**
-     * function to get crowdin files that are related with this integration
-     */
-    getCrowdinFiles?: (projectId: number, client: Crowdin, appRootFolder?: SourceFilesModel.Directory, config?: any) => Promise<TreeItem[]>;
-    /**
-     * function to get data from integration
-     */
-    getIntegrationFiles: (apiCredentials: any, config?: any, parentId?: any, search?: any, page?: 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, }: {
-        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, 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)
-     */
-    getConfiguration?: (projectId: number, client: Crowdin, apiCredentials: any) => Promise<FormEntity[]>;
-    /**
-     * Logout hook for cleanup logic
-     */
-    onLogout?: (projectId: number, client: Crowdin, apiCredentials: any, config?: any) => Promise<void>;
-    /**
-     * flag to turn on auto reload of the tree whenever user updates the configuration
-     */
-    reloadOnConfigSave?: boolean;
-    /**
-     * define info modal (help section) for you app (by default app will not have own info section)
-     */
-    infoModal?: {
-        title: string;
-        content: string;
-    };
-    /**
-     * background jobs that will be executed for each crowdin project and user
-     */
-    cronJobs?: CronJob[];
-    /**
-     * Enable new file sync when syncing via cron or webhook
-     */
-    syncNewElements?: {
-        crowdin: boolean;
-        integration: boolean;
-    };
-    withCronSync?: {
-        crowdin: boolean;
-        integration: boolean;
-    };
-    withWebhookSync?: {
-        crowdin: boolean;
-        integration: boolean;
-    };
-    filtering?: {
-        crowdinLanguages: boolean;
-    };
-    /**
-     * Enable integration folder open event
-     */
-    integrationOneLevelFetching?: boolean;
-    /**
-     * Enable integration search event
-     */
-    integrationSearchListener?: boolean;
-    /**
-     * Enable integration next page event
-     */
-    integrationPagination?: boolean;
-    /**
-     * Enable the option to upload translations to crowdin that are already present in the integration.
-     */
-    uploadTranslations?: boolean;
-    /**
-     * function to get crowdin file translation progress
-     */
-    getFileProgress?: (projectId: number, client: Crowdin, fileId: number) => Promise<{
-        [key: number]: TranslationStatusModel.LanguageProgress[];
-    }>;
-    /**
-     * Register Crowdin webhook to get notified when translations are ready
-     */
-    webhooks?: Webhooks;
-    /**
-     * define a notification for your application at the top of the screen
-     */
-    notice?: {
-        title: string;
-        content: string;
-        type: NoticeType;
-        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 {
-    label?: string;
-    labelHtml?: string;
-}
-export interface LoginForm {
-    fields: FormEntity[];
-}
-export interface OAuthLogin {
-    /**
-     * Extra field for login form
-     */
-    loginFields?: FormField[];
-    /**
-     * Authorization url (e.g. https://github.com/login/oauth/authorize or https://accounts.google.com/o/oauth2/v2/auth)
-     */
-    authorizationUrl?: string;
-    /**
-     * Authorization url getter
-     */
-    getAuthorizationUrl?: (redirectUrl: string, loginForm?: any) => string;
-    /**
-     * Access token url (e.g. https://github.com/login/oauth/access_token)
-     */
-    accessTokenUrl: string;
-    /**
-     * Url to refresh token, default will use {@link accessTokenUrl}. Needed when {@link refresh} is enabled
-     */
-    refreshTokenUrl?: string;
-    /**
-     * The scopes of access, usually expressed as a list of space-delimited, case-sensitive strings
-     */
-    scope?: string;
-    /**
-     * Client id
-     */
-    clientId: string;
-    /**
-     * Client secret
-     */
-    clientSecret: string;
-    /**
-     * default '/oauth/code'
-     */
-    redirectUriRoute?: string;
-    /**
-     * request/response fields mapping
-     */
-    fieldsMapping?: {
-        /**
-         * default 'client_id'
-         */
-        clientId?: string;
-        /**
-         * default 'client_secret'
-         */
-        clientSecret?: string;
-        /**
-         * default 'scope'
-         */
-        scope?: string;
-        /**
-         * default 'redirect_uri'
-         */
-        redirectUri?: string;
-        /**
-         * default 'code'
-         */
-        code: string;
-        /**
-         * default 'access_token'
-         */
-        accessToken?: string;
-        /**
-         * default 'refresh_token'
-         */
-        refreshToken?: string;
-        /**
-         * default 'expires_in'
-         */
-        expiresIn?: string;
-    };
-    /**
-     * default 'false' which means that the access token has no expiration date
-     */
-    refresh?: boolean;
-    /**
-     * Additional URL parameters for authorizarion url
-     */
-    extraAutorizationUrlParameters?: {
-        [key: string]: string;
-    };
-    /**
-     * Additional parameters for access token request
-     */
-    extraAccessTokenParameters?: {
-        [key: string]: any;
-    };
-    /**
-     * Additional parameters for refresh token request
-     */
-    extraRefreshTokenParameters?: {
-        [key: string]: any;
-    };
-    /**
-     * Override to implement request for retrieving access token (and refresh token if 'refresh' is enabled)
-     */
-    performGetTokenRequest?: (code: string, query: {
-        [key: string]: any;
-    }, url: string) => Promise<any>;
-    /**
-     * Override to implement request for refreshing token (only if 'refresh' is enabled)
-     */
-    performRefreshTokenRequest?: (currentCredentials: any) => Promise<any>;
-}
-export interface Environments {
-    environments: 'crowdin' | 'crowdin-enterprise';
-}
-export interface FormField {
-    key: string;
-    helpText?: string;
-    helpTextHtml?: string;
-    label: string;
-    type?: 'text' | 'password' | 'checkbox' | 'select' | 'textarea' | 'file';
-    defaultValue?: any;
-    /**
-     * only for select
-     */
-    isMulti?: boolean;
-    /**
-     * only for select
-     */
-    isSearchable?: boolean;
-    /**
-     * only for select
-     */
-    options?: {
-        label: string;
-        value: string;
-    }[];
-    /**
-     * only for type file
-     */
-    accept?: string;
-    /**
-     * field dependency settings
-     */
-    dependencySettings?: string;
-}
-export interface ExtendedResult<T> {
-    data?: T;
-    message?: string;
-    stopPagination?: boolean;
-}
-export type TreeItem = File | Folder;
-/**
- * 0 - folder
- * 1 - file
- * 2 - branch
- */
-type IntegrationTreeElementType = '0' | '1' | '2';
-type LabelTreeElementType = 'primary' | 'secondary' | 'success' | 'warning' | 'info' | 'danger' | 'dark' | 'light';
-export interface LabelTreeElement {
-    text: string;
-    type?: LabelTreeElementType;
-    color?: string;
-}
-export interface File {
-    id: string;
-    name: string;
-    type: SourceFilesModel.FileType;
-    parentId?: string;
-    nodeType?: IntegrationTreeElementType;
-    customContent?: string;
-    labels?: LabelTreeElement;
-}
-export interface Folder {
-    id: string;
-    name: string;
-    parentId?: string;
-    nodeType?: IntegrationTreeElementType;
-    customContent?: string;
-    labels?: LabelTreeElement;
-}
-export interface IntegrationRequest extends CrowdinClientRequest {
-    integrationCredentials: any;
-    integrationSettings?: any;
-}
-export interface CrowdinClientRequest extends Request {
-    crowdinApiClient: Crowdin;
-    crowdinContext: CrowdinContextInfo;
-    subscriptionInfo?: SubscriptionInfo;
-    logInfo: LogFunction;
-    logError: LogErrorFunction;
-}
-export interface CrowdinCredentials {
-    id: string;
-    appSecret: string;
-    domain?: string;
-    userId: number;
-    organizationId: number;
-    baseUrl: string;
-    accessToken: string;
-    refreshToken: string;
-    expire: string;
-    type: AccountType;
-}
-export declare enum AccountType {
-    NORMAL = "normal",
-    ENTERPRISE = "enterprise"
-}
-export interface CrowdinContextInfo {
-    jwtPayload: JwtPayload;
-    crowdinId: string;
-    clientId: string;
-    appIdentifier: string;
-}
-export declare enum SubscriptionInfoType {
-    TRIAL = "trial",
-    SUBSCRIPTION = "subscription"
-}
-export interface SubscriptionInfo {
-    expired: boolean;
-    subscribeLink?: string;
-    daysLeft?: number;
-    type?: SubscriptionInfoType;
-}
-export interface IntegrationCredentials {
-    id: string;
-    credentials: any;
-    crowdinId: string;
-}
-export interface IntegrationConfig {
-    id: number;
-    integrationId: string;
-    crowdinId: string;
-    config: any;
-}
-export interface IntegrationFile {
-    id: string;
-    name: string;
-    type: SourceFilesModel.FileType;
-    parentId: string;
-    nodeType?: IntegrationTreeElementType;
-}
-export interface UpdateIntegrationRequest {
-    [fileId: string]: string[];
-}
-export interface CronJob {
-    task: (projectId: number, client: Crowdin, apiCredentials: any, appRootFolder?: SourceFilesModel.Directory, config?: any) => Promise<void>;
-    expression: string;
-}
-export interface FileProcessLogic {
-    /**
-     * Folder where larger file will be temporary stored (default "{@link dbFolder}/custom-file-format")
-     */
-    filesFolder?: string;
-    /**
-     * 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: Buffer) => 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
-     */
-    autoUploadTranslations?: boolean;
-    /**
-     * Enable strings export
-     */
-    stringsExport?: boolean;
-    /**
-     * File extensions (used for strings export)
-     */
-    extensions?: string[];
-    /**
-     * Enable custom srx
-     */
-    customSrxSupported?: boolean;
-    /**
-     * Enable multi language strings export
-     */
-    multilingualExport?: boolean;
-    /**
-     * Used for initial source file upload, source file update, and translation upload
-     */
-    parseFile?: (fileContent: Buffer, req: Omit<ProcessFileRequest, 'jobType' | 'file'>, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<ParseFileResponse>;
-    /**
-     * Used for translation download
-     */
-    buildFile?: (fileContent: Buffer, req: Omit<ProcessFileRequest, 'jobType' | 'file'>, strings: ProcessFileString[], client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
-    /**
-     * Used for strings export
-     */
-    exportStrings?: (req: Omit<ProcessFileRequest, 'jobType'>, strings: ProcessFileString[], client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
-}
-export type FileImportExportLogic = FilePreImportLogic | FilePostImportLogic | FilePreExportLogic | FilePostExportLogic;
-export type FileImportExportContent = ProcessFileString[] | Buffer | undefined;
-export interface FilePreImportLogic extends FileProcessLogic {
-    fileProcess: (req: ProcessFileRequest, content: FileImportExportContent, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<ContentFileResponse>;
-}
-export interface FilePostImportLogic extends FileProcessLogic {
-    fileProcess: (req: ProcessFileRequest, content: FileImportExportContent, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<StringsFileResponse>;
-}
-export interface FilePreExportLogic extends FileProcessLogic {
-    fileProcess: (req: ProcessFileRequest, content: FileImportExportContent, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<StringsFileResponse>;
-}
-export interface FilePostExportLogic extends FileProcessLogic {
-    fileProcess: (req: ProcessFileRequest, content: FileImportExportContent, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<ContentFileResponse>;
-}
-export interface SignaturePatterns {
-    fileName?: string;
-    fileContent?: string;
-}
-export interface ProcessFileRequest {
-    jobType: ProcessFileJobType;
-    file: ProcessFileRecord;
-    sourceLanguage: LanguagesModel.Language;
-    targetLanguages: LanguagesModel.Language[];
-    strings: ProcessFileString[];
-    stringsUrl: string;
-    getRawContent?: (encoding: BufferEncoding) => Promise<string | Buffer>;
-}
-export interface ProcessFileRecord {
-    content?: string;
-    contentUrl?: string;
-    path?: string;
-    id?: number;
-    name?: string;
-}
-export declare enum ProcessFileJobType {
-    PARSE_FILE = "parse-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?: Buffer;
-    strings?: ProcessFileString[];
-    error?: string;
-}
-export interface BuildFileResponse {
-    contentFile: Buffer;
-    error?: string;
-    fileName?: string;
-    fileType?: string;
-}
-export interface StringsFileResponse extends Omit<ParseFileResponse, 'previewFile'> {
-    notModified?: boolean;
-}
-export interface ContentFileResponse extends BuildFileResponse {
-    notModified?: boolean;
-}
-export interface ProcessFileString {
-    previewId?: number;
-    id: number;
-    identifier: string;
-    context?: string;
-    customData?: string;
-    maxLength?: number;
-    isHidden?: boolean;
-    hasPlurals?: boolean;
-    labels?: string[];
-    text: string | SourceStringsModel.PluralText;
-    translations?: StringTranslations;
-    uniqId?: string;
-}
-export interface StringTranslations {
-    [language: string]: {
-        text: string | SourceStringsModel.PluralText;
-    };
-}
-export interface CustomMTLogic {
-    withContext?: boolean;
-    translate: (client: Crowdin, context: CrowdinContextInfo, projectId: number, source: string, target: string, strings: CustomMtString[]) => Promise<string[]>;
-    validate?: (client: Crowdin) => Promise<void>;
-}
-export interface CustomMTRequest {
-    strings: CustomMtString[];
-}
-export type CustomMtString = string | {
-    id: number;
-    projectId: number;
-    fileId: number;
-    identifier: string;
-    context: string;
-    maxLength: number;
-    isHidden: boolean;
-    text: string | SourceStringsModel.PluralText;
-    isPlural: boolean;
-    pluralForm: any;
-};
-export interface UiModule {
-    /**
-     * Form schema for react-jsonschema-doc to be used as front-end
-     * https://rjsf-team.github.io/react-jsonschema-form/docs
-     */
-    formSchema?: object;
-    /**
-     * 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
-     */
-    formUiSchema?: object;
-    /**
-     * path to ui folder (e.g. {@example join(__dirname, 'public')})
-     */
-    uiPath?: string;
-    /**
-     * page name (default index.html)
-     */
-    fileName?: string;
-    /**
-     * make module publicly available without crowdin context
-     */
-    allowUnauthorized?: boolean;
-    /**
-     * Module name
-     */
-    name?: string;
-}
-export interface EditorPanels extends UiModule {
-    /**
-     * The Editor's mode list where the module will be available.
-     */
-    modes: EditorMode[];
-}
-export interface EditorThemes {
-    /**
-     * Module name
-     */
-    name?: string;
-    /**
-     * Defines a set of CSS custom variables for theming purposes
-     */
-    styles: {
-        [key: string]: string;
-    };
-    /**
-     * The Editor's mode list where the module will be available.
-     */
-    modes: EditorMode[];
-}
-export declare enum EditorMode {
-    ASSETS = "assets",
-    REVIEW = "review",
-    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;
-    /**
-     * Context menu name
-     */
-    name?: string;
-    /**
-     * Support fileName pattern only. Contains fileName field regular expressions used to detect the file type. If the file name matches any of the regular expressions, the context menu will be displayed.
-     */
-    signaturePatterns?: SignaturePatterns;
-}
-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 extends CrowdinMetadataStore {
-    establishCrowdinConnection: (authRequest: string | CrowdinClientRequest) => Promise<{
-        context: CrowdinContextInfo;
-        client?: Crowdin;
-    }>;
-    encryptCrowdinConnection: (data: {
-        crowdinId: string;
-        extra: Record<string, any>;
-    }) => string;
-    dencryptCrowdinConnection: (hash: string) => Promise<{
-        client: Crowdin;
-        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"
-}
-export interface IntegrationSyncSettings {
-    id: number;
-    files?: any;
-    integrationId: string;
-    crowdinId: string;
-    provider: Provider;
-}
-export interface IntegrationFilesSnapshot {
-    id: number;
-    files?: any;
-    integrationId: string;
-    crowdinId: string;
-    provider: Provider;
-}
-export interface IntegrationWebhooks {
-    id: number;
-    fileId: number;
-    integrationId: string;
-    crowdinId: string;
-    provider: Provider;
-}
-export interface UserErrors {
-    id: number;
-    action: string;
-    message: string;
-    data: any;
-    createdAt: string;
-    crowdinId: string;
-    integrationId?: string;
-}
-export interface ImagePath {
-    /**
-     * path to app logo (e.g. {@example join(__dirname, 'logo.png')})
-     */
-    imagePath?: string;
-}
-export declare enum RequestMethods {
-    GET = "GET",
-    POST = "POST",
-    PUT = "PUT",
-    PATCH = "PATCH",
-    DELETE = "DELETE"
-}
-export interface ApiEndpoints {
-    key: string;
-    name: string;
-    url: string;
-    method: RequestMethods;
-    description?: string;
-    documentationUrl?: string;
-}
-export interface ApiModule {
-    default?: boolean;
-    endpoints?: ApiEndpoints[];
-    docFile?: string;
-}
-export interface CustomSpellCheckRequest {
-    language: string;
-    texts: string[];
-}
-export type SpellCheckCategory = 'typography' | 'casing' | 'grammar' | 'typos' | 'punctuation' | 'confused_words' | 'redundancy' | 'style' | 'gender_neutrality' | 'semantics' | 'colloquialisms' | 'wikipedia' | 'barbarism' | 'misc';
-export interface SupportedLanguage {
-    code: string;
-    name: string;
-}
-export interface SpellCheckMatch {
-    category: SpellCheckCategory;
-    message: string;
-    shortMessage: string;
-    offset: number;
-    length: number;
-    replacements: string[];
-}
-export interface CustomSpellCheckResponse {
-    texts: {
-        text: string;
-        matches: SpellCheckMatch[];
-    }[];
-    error?: string;
-}
-export interface CustomSpellcheckerModule extends Environments {
-    /**
-     * module description
-     */
-    description?: string;
-    /**
-     * module name
-     */
-    name?: string;
-    /**
-     * Settings UI module
-     */
-    settingsUiModule?: UiModule;
-    /**
-     * function to get list of supported languages that are supports by current spellchecker
-     */
-    getSupportedLanguage: ({ client, context, }: {
-        client: Crowdin;
-        context: CrowdinContextInfo;
-    }) => Promise<SupportedLanguage[]>;
-    /**
-     * function to check spelling
-     */
-    runSpellCheck: ({ client, context, language, texts, }: {
-        client: Crowdin;
-        context: CrowdinContextInfo;
-        language: string;
-        texts: string[];
-    }) => Promise<CustomSpellCheckResponse>;
-}
-export interface Logger {
-    enabled: boolean;
-    log?: (message: string, context?: CrowdinContextInfo) => void;
-}
-export interface Pricing {
-    planType: 'free' | 'recurring';
-    trial?: number;
-    trialCrowdin?: number;
-    trialEnterprise?: number;
-    cachingSeconds?: number;
-    infoDisplayDaysThreshold?: number;
-}
-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[]>;
-    queueUrl: string;
-}
-export declare enum SyncCondition {
-    ALL = 0,
-    TRANSLATED = 1,
-    APPROVED = 2
-}
-export declare enum SyncSchedule {
-    DISABLED = 0,
-    ACTIVE
-}
-export type Payload = {
-    event: string;
-    projectId: string;
-    language: string;
-    fileId: string;
-};
-export type WebhookUrlParams = {
-    projectId: number;
-    crowdinId: string;
-    clientId: string;
-};
-export interface GetAllNewFilesArgs {
-    config: Config;
-    integration: IntegrationLogic;
-    crowdinApiClient: Crowdin;
-    crowdinId: string;
-    integrationCredentials: any;
-    integrationId: string;
-    projectId: number;
-    integrationSettings: any;
-    syncSettings: IntegrationSyncSettings;
-}
-export interface UpdateCrowdinWebhookPayloadsArgs {
-    integration: IntegrationLogic;
-    webhookData: any;
-    req: Request[];
-}
-export interface FilterSyncFilesArgs {
-    projectId: number;
-    crowdinClient: Crowdin;
-    events: Payload[];
-    syncFileSettings: UpdateIntegrationRequest;
-    appSettings: AppSettings;
-}
-export interface AppSettings {
-    schedule?: number;
-    condition?: number;
-    'new-crowdin-files'?: boolean;
-    'new-integration-files'?: boolean;
-    [key: string]: any;
-}
-export declare enum UserPermissions {
-    OWNER = "owner",
-    MANAGERS = "managers",
-    ALL_MEMBERS = "all",
-    GUESTS = "guests"
-}
-export declare enum ProjectPermissions {
-    OWN = "own",
-    RESTRICTED = "restricted"
-}
-export interface DefaultPermissions {
-    user?: UserPermissions;
-    project?: ProjectPermissions;
-}
-type NoticeType = 'info' | 'warning' | 'danger' | 'success' | 'error' | 'dataLostWarning';
-export interface AWSConfig {
-    /**
-     * AWS bucket name for temporary files
-     */
-    tmpBucketName?: string;
-    /**
-     * AWS region
-     */
-    region?: string;
-}
-export {};