@crowdin/app-project-module 0.17.4 → 0.17.5

package/out/models/index.d.ts

@@ -1,538 +0,0 @@
-import Crowdin, { LanguagesModel, SourceFilesModel, SourceStringsModel } from '@crowdin/crowdin-api-client';
-import { JwtPayload } from '@crowdin/crowdin-apps-functions';
-import { Request } from 'express';
-export interface Config extends ImagePath {
-    /**
-     * 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;
-    /**
-     * https url where an app is reachable from the internet (e.g. the one that ngrok generates for us)
-     */
-    baseUrl: string;
-    /**
-     * Set of scopes requested by this app (default 'project')
-     */
-    scopes?: Scope[];
-    /**
-     * app name
-     */
-    name: string;
-    /**
-     * app identifier
-     */
-    identifier: string;
-    /**
-     * app description
-     */
-    description: string;
-    /**
-     * 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;
-    /**
-     * integration module logic
-     */
-    projectIntegration?: IntegrationLogic & ImagePath;
-    /**
-     * custom file format module logic
-     */
-    customFileFormat?: CustomFileFormatLogic;
-    /**
-     * custom MT module logic
-     */
-    customMT?: CustomMTLogic;
-    /**
-     * resources module
-     */
-    profileResourcesMenu?: UiModule & ImagePath;
-    /**
-     * organization-menu module
-     */
-    organizationMenu?: UiModule & ImagePath;
-    /**
-     * editor-right-panel module
-     */
-    editorRightPanel?: EditorPanels;
-    /**
-     * project menu module
-     */
-    projectMenu?: UiModule;
-    /**
-     * tools module
-     */
-    projectTools?: UiModule & ImagePath;
-    /**
-     * reports module
-     */
-    projectReports?: UiModule & ImagePath;
-    /**
-     * Uninstall hook for cleanup logic
-     */
-    onUninstall?: (organization: string) => Promise<void>;
-    /**
-     * Error interceptor (can be used to log error in centralized place)
-     */
-    onError?: (error: any) => void;
-    /**
-     * Configuration to log everything that are happening in the app
-     */
-    logger?: Logger;
-    /**
-     * Configuration of app pricing
-     */
-    pricing?: Pricing;
-}
-export declare enum Scope {
-    ALL_SCOPES = "all",
-    NOTIFICATIONS = "notification",
-    TRANSLATION_MEMORIES = "tm",
-    MACHINE_TRANSLATION_ENGINES = "mt",
-    GLOSSARIES = "glossary",
-    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"
-}
-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) => Promise<TreeItem[]>;
-    /**
-     * 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) => Promise<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>;
-    /**
-     * 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<ConfigurationModalEntity[]>;
-    /**
-     * 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[];
-    withCronSync?: {
-        crowdin: boolean;
-        integration: boolean;
-    };
-    withWebhookSync?: {
-        crowdin: boolean;
-        integration: boolean;
-    };
-}
-export declare type ConfigurationModalEntity = ConfigurationField | ConfigurationDelimeter;
-export interface ConfigurationField {
-    key: string;
-    label: string;
-    type: 'text' | 'checkbox' | 'select';
-    helpText?: string;
-    /**
-     * only for select
-     */
-    isMulti?: boolean;
-    /**
-     * only for select
-     */
-    options?: {
-        label: string;
-        value: string;
-    }[];
-}
-export interface ConfigurationDelimeter {
-    label: string;
-}
-export interface LoginForm {
-    fields: FormField[];
-}
-export interface OAuthLogin {
-    /**
-     * Authorization url (e.g. https://github.com/login/oauth/authorize or https://accounts.google.com/o/oauth2/v2/auth)
-     */
-    authorizationUrl: 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) => Promise<any>;
-    /**
-     * Override to implement request for refreshing token (only if 'refresh' is enabled)
-     */
-    performRefreshTokenRequest?: (currentCredentials: any) => Promise<any>;
-}
-export interface FormField {
-    key: string;
-    helpText?: string;
-    helpTextHtml?: string;
-    label: string;
-    type?: 'text' | 'password' | 'checkbox';
-}
-export declare type TreeItem = File | Folder;
-export interface File {
-    id: string;
-    name: string;
-    type: SourceFilesModel.FileType;
-    parentId?: string;
-}
-export interface Folder {
-    id: string;
-    name: string;
-    parentId?: string;
-}
-export interface IntegrationRequest extends CrowdinClientRequest {
-    integrationCredentials: any;
-    integrationSettings?: any;
-}
-export interface CrowdinClientRequest extends Request {
-    crowdinApiClient: Crowdin;
-    crowdinContext: CrowdinContextInfo;
-    subscriptionInfo?: SubscriptionInfo;
-}
-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;
-}
-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;
-    config?: any;
-}
-export interface IntegrationFile {
-    id: string;
-    name: string;
-    type: SourceFilesModel.FileType;
-    parentId: string;
-}
-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 CustomFileFormatLogic {
-    /**
-     * The type parameter value for a custom file format. Used for a custom format file upload via API.
-     */
-    type: string;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * Used for initial source file upload, source file update, and translation upload
-     */
-    parseFile?: (fileContent: string | object, req: Omit<ProcessFileRequest, 'jobType' | 'file'>, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<ParseFileResponse>;
-    /**
-     * Used for translation download
-     */
-    buildFile?: (fileContent: string | object, 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 interface SignaturePatterns {
-    fileName?: string;
-    fileContent?: string;
-}
-export interface ProcessFileRequest {
-    jobType: ProcessFileJobType;
-    file: ProcessFileRecord;
-    sourceLanguage: LanguagesModel.Language;
-    targetLanguages: LanguagesModel.Language[];
-    strings: ProcessFileString[];
-    stringsUrl: string;
-}
-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"
-}
-export interface ParseFileResponse {
-    previewFile?: string;
-    strings?: ProcessFileString[];
-}
-export interface BuildFileResponse {
-    contentFile: string;
-}
-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;
-}
-export interface StringTranslations {
-    [language: string]: {
-        text: string | SourceStringsModel.PluralText;
-    };
-}
-export interface CustomMTLogic {
-    translate: (client: Crowdin, context: CrowdinContextInfo, projectId: number, source: string, target: string, strings: string[]) => Promise<string[]>;
-    validate?: (client: Crowdin) => Promise<void>;
-}
-export interface CustomMTRequest {
-    strings: string[];
-}
-export interface UiModule {
-    /**
-     * path to ui folder (e.g. {@example join(__dirname, 'public')})
-     */
-    uiPath: string;
-    /**
-     * page name (default index.html)
-     */
-    fileName?: string;
-}
-export interface EditorPanels extends UiModule {
-    /**
-     * The Editor's mode list where the module will be available.
-     */
-    modes: EditorPanelsMode[];
-}
-export declare enum EditorPanelsMode {
-    ASSETS = "assets",
-    REVIEW = "review",
-    TRANSLATE = "TRANSLATE",
-    PROOFREAD = "proofread"
-}
-export interface CrowdinAppUtilities {
-    saveMetadata: (id: string, metadata: any) => 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>;
-    establishCrowdinConnection: (jwtToken: string) => Promise<{
-        context: CrowdinContextInfo;
-        client?: Crowdin;
-    }>;
-}
-export interface IntegrationSyncSettings {
-    id: string;
-    files?: any;
-    integrationId: string;
-    crowdinId: string;
-    provider: string;
-}
-interface ImagePath {
-    /**
-     * path to app logo (e.g. {@example join(__dirname, 'logo.png')})
-     */
-    imagePath?: string;
-}
-export interface Logger {
-    enabled: boolean;
-    log?: (message: string) => void;
-}
-export interface Pricing {
-    planType: 'free' | 'recurring';
-    trial?: number;
-    trialCrowdin?: number;
-    trialEnterprise?: number;
-    cachingSeconds?: number;
-    infoDisplayDaysThreshold?: number;
-}
-export {};

package/out/models/index.js

@@ -1,41 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EditorPanelsMode = exports.ProcessFileJobType = exports.SubscriptionInfoType = exports.AccountType = exports.Scope = void 0;
-var Scope;
-(function (Scope) {
-    Scope["ALL_SCOPES"] = "all";
-    Scope["NOTIFICATIONS"] = "notification";
-    Scope["TRANSLATION_MEMORIES"] = "tm";
-    Scope["MACHINE_TRANSLATION_ENGINES"] = "mt";
-    Scope["GLOSSARIES"] = "glossary";
-    Scope["PROJECTS"] = "project";
-    Scope["TASKS"] = "project.task";
-    Scope["REPORTS"] = "project.report";
-    Scope["TRANSLATION_STATUS"] = "project.status";
-    Scope["SOURCE_FILES_AND_STRINGS"] = "project.source";
-    Scope["WEBHOOKS"] = "project.webhook";
-    Scope["TRANSLATIONS"] = "project.translation";
-    Scope["SCREENSHOTS"] = "project.screenshot";
-})(Scope = exports.Scope || (exports.Scope = {}));
-var AccountType;
-(function (AccountType) {
-    AccountType["NORMAL"] = "normal";
-    AccountType["ENTERPRISE"] = "enterprise";
-})(AccountType = exports.AccountType || (exports.AccountType = {}));
-var SubscriptionInfoType;
-(function (SubscriptionInfoType) {
-    SubscriptionInfoType["TRIAL"] = "trial";
-    SubscriptionInfoType["SUBSCRIPTION"] = "subscription";
-})(SubscriptionInfoType = exports.SubscriptionInfoType || (exports.SubscriptionInfoType = {}));
-var ProcessFileJobType;
-(function (ProcessFileJobType) {
-    ProcessFileJobType["PARSE_FILE"] = "parse-file";
-    ProcessFileJobType["BUILD_FILE"] = "build-file";
-})(ProcessFileJobType = exports.ProcessFileJobType || (exports.ProcessFileJobType = {}));
-var EditorPanelsMode;
-(function (EditorPanelsMode) {
-    EditorPanelsMode["ASSETS"] = "assets";
-    EditorPanelsMode["REVIEW"] = "review";
-    EditorPanelsMode["TRANSLATE"] = "TRANSLATE";
-    EditorPanelsMode["PROOFREAD"] = "proofread";
-})(EditorPanelsMode = exports.EditorPanelsMode || (exports.EditorPanelsMode = {}));

package/out/static/css/styles.css

@@ -1,57 +0,0 @@
-.i_w {
-    padding: 16px 24px;
-    max-width: 1420px;
-    margin: 0 auto;
-}
-
-.center {
-    text-align: center;
-    min-height: calc(100vh - 64px);
-    display: flex;
-    align-items: center;
-    justify-content: space-around;
-}
-
-.box-center {
-    display: flex;
-    align-items: center;
-    justify-content: center;
-}
-
-.top {
-    text-align: right;
-    margin-bottom: 10px;
-}
-
-.login {
-    margin-bottom: 10px;
-}
-
-.login img {
-    max-width: 70px;
-    max-height: 70px;
-    width: auto;
-    height: auto;
-}
-
-.login crowdin-input {
-    margin-bottom: 8px;
-    display: block;
-}
-
-.login .inputs {
-    margin-bottom: 24px;
-    text-align: left;
-}
-
-.login crowdin-h4 {
-    margin: 8px 0 16px;
-}
-
-.ml-1 {
-    margin-left: 8px;
-}
-
-.m-0 {
-    margin: 0;
-}