@crowdin/app-project-module 0.44.0 → 0.45.1

package/out/modules/project-tools/index.d.ts

@@ -1,5 +1,5 @@
 import { Express } from 'express';
-import { Config, UnauthorizedConfig } from '../../models';
+import { Config, UnauthorizedConfig } from '../../types';
 export declare function register({ config, app }: {
     config: Config | UnauthorizedConfig;
     app: Express;

package/out/modules/project-tools/index.js

@@ -7,12 +7,11 @@ exports.register = void 0;
 const render_ui_module_1 = __importDefault(require("../../middlewares/render-ui-module"));
 const ui_module_1 = __importDefault(require("../../middlewares/ui-module"));
 const util_1 = require("../../util");
-const defaults_1 = require("../../util/defaults");
 function register({ config, app }) {
     if (!config.projectTools) {
         return;
     }
-    const allowUnauthorized = !(0, defaults_1.isAuthorizedConfig)(config);
+    const allowUnauthorized = !(0, util_1.isAuthorizedConfig)(config);
     app.get((0, util_1.getLogoUrl)(config.projectTools, '/tools'), (req, res) => { var _a; return res.sendFile(((_a = config.projectTools) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath); });
     app.use('/tools', (0, ui_module_1.default)(config, allowUnauthorized), (0, render_ui_module_1.default)(config.projectTools));
 }

package/out/modules/subscription-paid.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="qs" />
 import { Request, Response } from 'express';
-export default function handle(): (req: import("../models").CrowdinClientRequest | Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: Function) => void;
+export default function handle(): (req: import("../types").CrowdinClientRequest | Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: Function) => void;

package/out/modules/subscription-paid.js

@@ -10,13 +10,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const util_1 = require("../util");
-const connection_1 = require("../util/connection");
+const subscription_1 = require("../util/subscription");
 const logger_1 = require("../util/logger");
 function handle() {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
         const organizationId = (req.query || {})['organization_id'] || (req.body || {})['organization_id'];
         (0, logger_1.log)(`Received subscription paid request for organization ${organizationId}`);
-        (0, connection_1.clearCache)(organizationId);
+        (0, subscription_1.clearCache)(organizationId);
         res.status(204).end();
     }));
 }

package/out/modules/uninstall.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="qs" />
 import { Request, Response } from 'express';
-import { Config } from '../models';
-export default function handle(config: Config): (req: import("../models").CrowdinClientRequest | Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: Function) => void;
+import { Config } from '../types';
+export default function handle(config: Config): (req: import("../types").CrowdinClientRequest | Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: Function) => void;

package/out/modules/uninstall.js

@@ -13,7 +13,7 @@ const storage_1 = require("../storage");
 const util_1 = require("../util");
 const connection_1 = require("../util/connection");
 const logger_1 = require("../util/logger");
-const webhooks_1 = require("../util/webhooks");
+const webhooks_1 = require("./integration/util/webhooks");
 function handle(config) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
         const event = req.body;
@@ -40,7 +40,11 @@ function handle(config) {
         }
         if (projectIntegration) {
             if (projectIntegration.webhooks) {
-                yield (0, webhooks_1.unregisterAllCrowdinWebhooks)(config, projectIntegration, organization);
+                yield (0, webhooks_1.unregisterAllCrowdinWebhooks)({
+                    config,
+                    integration: projectIntegration,
+                    crowdinId: organization,
+                });
             }
             (0, logger_1.log)(`Deleting all integration credentials for ${organization} organization`);
             yield (0, storage_1.getStorage)().deleteAllIntegrationCredentials(organization);

package/out/storage/index.d.ts

@@ -1,6 +1,7 @@
 import { IntegrationConfig, IntegrationCredentials, IntegrationFilesSnapshot, IntegrationSyncSettings, IntegrationWebhooks, Provider } from '../modules/integration/types';
-import { Config, CrowdinCredentials, UserErrors, UnauthorizedConfig } from '../models';
-import { CreateJobParams, GetActiveJobsParams, GetJobParams, Job, UpdateJobParams } from '../models/job';
+import { Config, CrowdinCredentials, UnauthorizedConfig } from '../types';
+import { CreateJobParams, GetActiveJobsParams, GetJobParams, Job, UpdateJobParams } from '../modules/integration/util/types';
+import { UserErrors } from './types';
 export interface Storage {
     migrate(): Promise<void>;
     saveCrowdinCredentials(credentials: CrowdinCredentials): Promise<void>;

package/out/storage/mysql.d.ts

@@ -1,7 +1,8 @@
 import { Storage } from '.';
-import { CrowdinCredentials, UserErrors } from '../models';
-import { CreateJobParams, GetActiveJobsParams, GetJobParams, Job, UpdateJobParams } from '../models/job';
+import { CrowdinCredentials } from '../types';
+import { CreateJobParams, GetActiveJobsParams, GetJobParams, Job, UpdateJobParams } from '../modules/integration/util/types';
 import { IntegrationConfig, IntegrationCredentials, IntegrationFilesSnapshot, IntegrationSyncSettings, IntegrationWebhooks } from '../modules/integration/types';
+import { UserErrors } from './types';
 export interface MySQLStorageConfig {
     uri?: string;
     host?: string;

package/out/storage/mysql.js

@@ -14,7 +14,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MySQLStorage = void 0;
 const uuid_1 = require("uuid");
-const job_1 = require("../models/job");
+const types_1 = require("../modules/integration/util/types");
 const util_1 = require("../util");
 class MySQLStorage {
     constructor(config) {
@@ -156,7 +156,7 @@ class MySQLStorage {
                 payload        text,
                 title          text,
                 progress       int 0,
-                status         varchar(255)     '${job_1.JobStatus.CREATED}',
+                status         varchar(255)     '${types_1.JobStatus.CREATED}',
                 payload        text,
                 info           text,
                 data           text,
@@ -518,7 +518,7 @@ class MySQLStorage {
             if (status) {
                 updateFields.push('status = ?');
                 updateParams.push(status);
-                if (!updateFields.includes('finished_at = ?') && [job_1.JobStatus.FAILED, job_1.JobStatus.CANCELED].includes(status)) {
+                if (!updateFields.includes('finished_at = ?') && [types_1.JobStatus.FAILED, types_1.JobStatus.CANCELED].includes(status)) {
                     updateFields.push('finished_at = ?');
                     updateParams.push(Date.now().toString());
                 }

package/out/storage/postgre.d.ts

@@ -1,8 +1,9 @@
 import { Client } from 'pg';
 import { Storage } from '.';
-import { CrowdinCredentials, UserErrors } from '../models';
-import { CreateJobParams, GetActiveJobsParams, GetJobParams, Job, UpdateJobParams } from '../models/job';
+import { CrowdinCredentials } from '../types';
 import { IntegrationConfig, IntegrationCredentials, IntegrationFilesSnapshot, IntegrationSyncSettings, IntegrationWebhooks } from '../modules/integration/types';
+import { CreateJobParams, GetActiveJobsParams, GetJobParams, Job, UpdateJobParams } from '../modules/integration/util/types';
+import { UserErrors } from './types';
 export interface PostgreStorageConfig {
     host?: string;
     connectionString?: string;

package/out/storage/postgre.js

@@ -13,7 +13,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PostgreStorage = void 0;
 const pg_1 = require("pg");
 const uuid_1 = require("uuid");
-const job_1 = require("../models/job");
+const types_1 = require("../modules/integration/util/types");
 const util_1 = require("../util");
 class PostgreStorage {
     constructor(config) {
@@ -169,7 +169,7 @@ class PostgreStorage {
                 type           varchar not null,
                 title          varchar     null,
                 progress       int default 0,
-                status         varchar default '${job_1.JobStatus.CREATED}',
+                status         varchar default '${types_1.JobStatus.CREATED}',
                 payload        varchar     null,
                 info           varchar     null,
                 data           varchar     null,
@@ -534,7 +534,7 @@ class PostgreStorage {
             if (status) {
                 updateFields.push('status = $' + updateParams.length.toString());
                 updateParams.push(status);
-                if ((!progress || progress <= 100) && [job_1.JobStatus.FAILED, job_1.JobStatus.CANCELED].includes(status)) {
+                if ((!progress || progress <= 100) && [types_1.JobStatus.FAILED, types_1.JobStatus.CANCELED].includes(status)) {
                     updateFields.push('finished_at = $' + updateParams.length.toString());
                     updateParams.push(Date.now().toString());
                 }

package/out/storage/sqlite.d.ts

@@ -1,7 +1,8 @@
 import { Storage } from '.';
-import { CrowdinCredentials, UserErrors } from '../models';
-import { CreateJobParams, GetActiveJobsParams, GetJobParams, Job, UpdateJobParams } from '../models/job';
+import { CrowdinCredentials } from '../types';
 import { IntegrationConfig, IntegrationCredentials, IntegrationFilesSnapshot, IntegrationSyncSettings, IntegrationWebhooks } from '../modules/integration/types';
+import { CreateJobParams, GetActiveJobsParams, GetJobParams, Job, UpdateJobParams } from '../modules/integration/util/types';
+import { UserErrors } from './types';
 export interface SQLiteStorageConfig {
     dbFolder: string;
 }

package/out/storage/sqlite.js

@@ -16,7 +16,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SQLiteStorage = void 0;
 const path_1 = require("path");
 const uuid_1 = require("uuid");
-const job_1 = require("../models/job");
+const types_1 = require("../modules/integration/util/types");
 class SQLiteStorage {
     constructor(config) {
         this.dbPromise = new Promise((res, rej) => {
@@ -247,7 +247,7 @@ class SQLiteStorage {
                 type           varchar not null,
                 title          varchar     null,
                 progress       integer DEFAULT 0,
-                status         varchar DEFAULT '${job_1.JobStatus.CREATED}',
+                status         varchar DEFAULT '${types_1.JobStatus.CREATED}',
                 payload        varchar     null,
                 info           varchar     null,
                 data           varchar     null,
@@ -524,7 +524,7 @@ class SQLiteStorage {
         if (status) {
             updateFields.push('status = ?');
             updateParams.push(status);
-            if (!updateFields.includes('finished_at = ?') && [job_1.JobStatus.FAILED, job_1.JobStatus.CANCELED].includes(status)) {
+            if (!updateFields.includes('finished_at = ?') && [types_1.JobStatus.FAILED, types_1.JobStatus.CANCELED].includes(status)) {
                 updateFields.push('finished_at = ?');
                 updateParams.push(Date.now().toString());
             }

package/out/storage/types.d.ts

@@ -0,0 +1,9 @@
+export interface UserErrors {
+    id: number;
+    action: string;
+    message: string;
+    data: any;
+    createdAt: string;
+    crowdinId: string;
+    integrationId?: string;
+}

package/out/storage/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/out/{models/index.d.ts → types.d.ts}

@@ -1,14 +1,17 @@
 import Crowdin from '@crowdin/crowdin-api-client';
 import { JwtPayload, VerifyOptions } from '@crowdin/crowdin-apps-functions';
 import { Request } from 'express';
-import { CustomMTLogic } from '../modules/custom-mt/types';
-import { CustomSpellcheckerModule } from '../modules/custom-spell-check/types';
-import { EditorPanels } from '../modules/editor-right-panel/types';
-import { CustomFileFormatLogic, FilePostExportLogic, FilePostImportLogic, FilePreExportLogic, FilePreImportLogic } from '../modules/file-processing/types';
-import { IntegrationLogic } from '../modules/integration/types';
-import { MySQLStorageConfig } from '../storage/mysql';
-import { PostgreStorageConfig } from '../storage/postgre';
-import { LogErrorFunction, LogFunction } from '../util/logger';
+import { ContextModule } from './modules/context-menu/types';
+import { CustomMTLogic } from './modules/custom-mt/types';
+import { CustomSpellcheckerModule } from './modules/custom-spell-check/types';
+import { EditorPanels } from './modules/editor-right-panel/types';
+import { EditorThemes } from './modules/editor-themes/types';
+import { CustomFileFormatLogic, FilePostExportLogic, FilePostImportLogic, FilePreExportLogic, FilePreImportLogic } from './modules/file-processing/types';
+import { IntegrationLogic } from './modules/integration/types';
+import { MySQLStorageConfig } from './storage/mysql';
+import { PostgreStorageConfig } from './storage/postgre';
+import { ApiModule } from './modules/api/types';
+import { LogErrorFunction, LogFunction } from './util/logger';
 export interface ClientConfig extends ImagePath {
     /**
      * Authentication Crowdin App type: "authorization_code", "crowdin_app". Default: "crowdin_app"
@@ -170,7 +173,7 @@ export interface ClientConfig extends ImagePath {
     customSpellchecker?: CustomSpellcheckerModule;
 }
 export interface Environments {
-    environments: Environment | Environment[];
+    environments?: Environment | Environment[];
 }
 type Environment = 'crowdin' | 'crowdin-enterprise';
 export type Config = ClientConfig & {
@@ -254,22 +257,6 @@ export interface SubscriptionInfo {
     daysLeft?: number;
     type?: SubscriptionInfoType;
 }
-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",
@@ -282,36 +269,6 @@ interface ModuleContent {
      */
     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 interface SignaturePatterns {
-    fileName?: string;
-    fileContent?: 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 extends CrowdinMetadataStore {
     establishCrowdinConnection: (authRequest: string | CrowdinClientRequest) => Promise<{
         context: CrowdinContextInfo;
@@ -368,41 +325,12 @@ export interface UiModule {
      */
     name?: string;
 }
-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 Logger {
     enabled: boolean;
     log?: (message: string, context?: CrowdinContextInfo) => void;
@@ -439,4 +367,8 @@ export interface AWSConfig {
      */
     region?: string;
 }
+export interface SignaturePatterns {
+    fileName?: string;
+    fileContent?: string;
+}
 export {};

package/out/{models/index.js → types.js}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProjectPermissions = exports.UserPermissions = exports.RequestMethods = exports.ContextOptionsTypes = exports.ContextOptionsLocations = exports.EditorMode = exports.SubscriptionInfoType = exports.AccountType = exports.Scope = exports.AuthenticationType = void 0;
+exports.ProjectPermissions = exports.UserPermissions = exports.EditorMode = exports.SubscriptionInfoType = exports.AccountType = exports.Scope = exports.AuthenticationType = void 0;
 var AuthenticationType;
 (function (AuthenticationType) {
     AuthenticationType["CODE"] = "authorization_code";
@@ -45,29 +45,6 @@ var EditorMode;
     EditorMode["TRANSLATE"] = "TRANSLATE";
     EditorMode["PROOFREAD"] = "proofread";
 })(EditorMode = exports.EditorMode || (exports.EditorMode = {}));
-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 RequestMethods;
-(function (RequestMethods) {
-    RequestMethods["GET"] = "GET";
-    RequestMethods["POST"] = "POST";
-    RequestMethods["PUT"] = "PUT";
-    RequestMethods["PATCH"] = "PATCH";
-    RequestMethods["DELETE"] = "DELETE";
-})(RequestMethods = exports.RequestMethods || (exports.RequestMethods = {}));
 var UserPermissions;
 (function (UserPermissions) {
     UserPermissions["OWNER"] = "owner";

package/out/util/connection.d.ts

@@ -1,6 +1,6 @@
 import Crowdin from '@crowdin/crowdin-api-client';
-import { AccountType, Config, CrowdinContextInfo, CrowdinCredentials, SubscriptionInfo, UnauthorizedConfig } from '../models';
 import { IntegrationCredentials, IntegrationLogic } from '../modules/integration/types';
+import { Config, CrowdinContextInfo, CrowdinCredentials } from '../types';
 export declare function prepareCrowdinClient({ config, credentials, autoRenew, context, }: {
     config: Config;
     credentials: CrowdinCredentials;
@@ -11,11 +11,3 @@ export declare function prepareCrowdinClient({ config, credentials, autoRenew, c
     token: string;
 }>;
 export declare function prepareIntegrationCredentials(config: Config, integration: IntegrationLogic, integrationCredentials: IntegrationCredentials): Promise<any>;
-export declare function clearCache(organization: string): void;
-export declare function isAppFree(config: Config | UnauthorizedConfig): boolean;
-export declare function checkSubscription({ config, token, organization, accountType, }: {
-    config: Config;
-    token: string;
-    organization: string;
-    accountType: AccountType;
-}): Promise<SubscriptionInfo>;