@crowdin/app-project-module 0.16.1 → 0.16.3

package/README.md

@@ -519,6 +519,42 @@ const configuration = {
 crowdinModule.createApp(configuration);
 ```
 
+Also custom file format module can support strings export.
+
+```javascript
+const crowdinModule = require('@crowdin/app-project-module');
+const convert = require('xml-js');
+
+const configuration = {
+    baseUrl: 'https://123.ngrok.io',
+    clientId: 'clientId',
+    clientSecret: 'clientSecret',
+    name: 'Sample App',
+    identifier: 'sample-app',
+    description: 'Sample App description',
+    dbFolder: __dirname,
+    imagePath: __dirname + '/' + 'logo.png',
+    customFileFormat: {
+        type: 'type-xyz',
+        stringsExport: true,
+        extensions: [
+            '.resx'
+        ],
+        parseFile: async (file, req, client, context, projectId) => {
+            //parse logic
+            return { strings: [] };
+        },
+        buildFile: async (file, req, strings, client, context, projectId) => {
+            const isStringsExport = !!req.file.path;
+            //export logic
+            return { contentFile: {} }
+        }
+    }
+};
+
+crowdinModule.createApp(configuration);
+```
+
 ### Custom MT
 
 Example of [custom mt module](https://support.crowdin.com/crowdin-apps-modules/#custom-mt-machine-translation-module).

package/out/handlers/manifest.js

@@ -15,14 +15,28 @@ function handle(config) {
         ];
     }
     if (config.customFileFormat) {
-        modules['custom-file-format'] = [
-            {
-                key: config.identifier + '-ff',
-                type: config.customFileFormat.type,
-                signaturePatterns: config.customFileFormat.signaturePatterns,
-                url: '/process',
-            },
-        ];
+        if (config.customFileFormat.stringsExport) {
+            modules['custom-file-format'] = [
+                {
+                    key: config.identifier + '-ff',
+                    type: config.customFileFormat.type,
+                    stringsExport: true,
+                    extensions: config.customFileFormat.extensions,
+                    url: '/process',
+                },
+            ];
+        }
+        else {
+            modules['custom-file-format'] = [
+                {
+                    key: config.identifier + '-ff',
+                    type: config.customFileFormat.type,
+                    multilingual: !!config.customFileFormat.multilingual,
+                    signaturePatterns: config.customFileFormat.signaturePatterns,
+                    url: '/process',
+                },
+            ];
+        }
     }
     if (config.customMT) {
         modules['custom-mt'] = [

package/out/handlers/subscription-info.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const models_1 = require("../models");
 function handle(config) {
     return (req, res) => {
         var _a;
         const subscriptionInfo = req.subscriptionInfo;
-        let showInfo = true;
-        if ((_a = config.pricing) === null || _a === void 0 ? void 0 : _a.infoDisplayDaysThreshold) {
+        let showInfo = (subscriptionInfo === null || subscriptionInfo === void 0 ? void 0 : subscriptionInfo.type) === models_1.SubscriptionInfoType.TRIAL;
+        if (showInfo && ((_a = config.pricing) === null || _a === void 0 ? void 0 : _a.infoDisplayDaysThreshold)) {
             showInfo = config.pricing.infoDisplayDaysThreshold >= ((subscriptionInfo === null || subscriptionInfo === void 0 ? void 0 : subscriptionInfo.daysLeft) || 0);
         }
         res.send(Object.assign(Object.assign({}, (subscriptionInfo || {})), { showInfo }));

package/out/models/index.d.ts

@@ -340,10 +340,15 @@ export interface CrowdinContextInfo {
     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;
@@ -385,6 +390,14 @@ export interface CustomFileFormatLogic {
      * Flag to automatically upload translations
      */
     autoUploadTranslations?: boolean;
+    /**
+     * Enable strings export
+     */
+    stringsExport?: boolean;
+    /**
+     * File extensions (used for strings export)
+     */
+    extensions?: string[];
     /**
      * Used for initial source file upload, source file update, and translation upload
      */
@@ -392,7 +405,7 @@ export interface CustomFileFormatLogic {
     /**
      * Used for translation download
      */
-    buildFile: (fileContent: string | object, req: Omit<ProcessFileRequest, 'jobType' | 'file'>, strings: ProcessFileString[], client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
+    buildFile: (fileContent: string | object, req: Omit<ProcessFileRequest, 'jobType'>, strings: ProcessFileString[], client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
 }
 export interface SignaturePatterns {
     fileName?: string;
@@ -409,6 +422,7 @@ export interface ProcessFileRequest {
 export interface ProcessFileRecord {
     content?: string;
     contentUrl?: string;
+    path?: string;
 }
 export declare enum ProcessFileJobType {
     PARSE_FILE = "parse-file",

package/out/models/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EditorPanelsMode = exports.ProcessFileJobType = exports.AccountType = exports.Scope = void 0;
+exports.EditorPanelsMode = exports.ProcessFileJobType = exports.SubscriptionInfoType = exports.AccountType = exports.Scope = void 0;
 var Scope;
 (function (Scope) {
     Scope["ALL_SCOPES"] = "all";
@@ -22,6 +22,11 @@ var 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";

package/out/util/connection.js

@@ -112,7 +112,7 @@ function prepareIntegrationCredentials(config, integration, integrationCredentia
 }
 exports.prepareIntegrationCredentials = prepareIntegrationCredentials;
 const subscriptionCache = {};
-function addToCache(organization, appIdenfifier, validUntil, cachingSeconds, subscribeLink) {
+function addToCache(organization, appIdenfifier, validUntil, type, cachingSeconds, subscribeLink) {
     if (!cachingSeconds) {
         return;
     }
@@ -123,6 +123,7 @@ function addToCache(organization, appIdenfifier, validUntil, cachingSeconds, sub
         cacheValidUntil: now,
         validUntil,
         subscribeLink,
+        type,
     };
     subscriptionCache[organization] = orgCache;
 }
@@ -148,25 +149,16 @@ function checkSubscription(config, token, organization, accountType) {
         if (isAppFree(config)) {
             return { expired: false };
         }
-        //default 2 weeks
-        const defaultSubscriptionPlan = 14;
-        let days;
-        if (organization) {
-            days = ((_a = config.pricing) === null || _a === void 0 ? void 0 : _a.trialEnterprise) || ((_b = config.pricing) === null || _b === void 0 ? void 0 : _b.trial) || defaultSubscriptionPlan;
-        }
-        else {
-            days = ((_c = config.pricing) === null || _c === void 0 ? void 0 : _c.trialCrowdin) || ((_d = config.pricing) === null || _d === void 0 ? void 0 : _d.trial) || defaultSubscriptionPlan;
-        }
-        (0, _1.log)(`Checking subscription plan. Subscriptino plan ${days} days`, config.logger);
+        (0, _1.log)('Checking subscription plan', config.logger);
         const appIdentifier = config.identifier;
         const cacheEntry = getFromCache(organization, appIdentifier);
         if (cacheEntry) {
-            const { cacheValidUntil, validUntil, subscribeLink } = cacheEntry;
+            const { cacheValidUntil, validUntil, subscribeLink, type } = cacheEntry;
             if (cacheValidUntil.getTime() > Date.now()) {
-                (0, _1.log)(`Loaded data from cache. Subscription is vali until ${validUntil.toISOString()}`, config.logger);
+                (0, _1.log)(`Loaded data from cache. Subscription is valid until ${validUntil.toISOString()}`, config.logger);
                 const { expired, daysLeft } = validateSubscription(new Date(validUntil));
                 (0, _1.log)(`expired ${expired}`, config.logger);
-                return { expired, subscribeLink, daysLeft };
+                return { expired, subscribeLink, daysLeft, type };
             }
         }
         try {
@@ -178,19 +170,29 @@ function checkSubscription(config, token, organization, accountType) {
             (0, _1.log)(`Recieved subscription info. ${JSON.stringify(subscription)}`, config.logger);
             const { expired, daysLeft } = validateSubscription(new Date(subscription.expires));
             (0, _1.log)(`expired ${expired}`, config.logger);
-            addToCache(organization, appIdentifier, new Date(subscription.expires), (_e = config.pricing) === null || _e === void 0 ? void 0 : _e.cachingSeconds);
-            return { expired, daysLeft };
+            addToCache(organization, appIdentifier, new Date(subscription.expires), models_1.SubscriptionInfoType.SUBSCRIPTION, (_a = config.pricing) === null || _a === void 0 ? void 0 : _a.cachingSeconds);
+            return { expired, daysLeft, type: models_1.SubscriptionInfoType.SUBSCRIPTION };
         }
         catch (e) {
             if (e instanceof crowdinAppFunctions.PaymentRequiredError) {
                 const { initializedAt, subscribeLink } = e;
                 (0, _1.log)(`Recieved 402 payment error. initializedAt ${initializedAt}`, config.logger);
+                //default 2 weeks
+                const defaultSubscriptionPlan = 14;
+                let days;
+                if (organization) {
+                    days = ((_b = config.pricing) === null || _b === void 0 ? void 0 : _b.trialEnterprise) || ((_c = config.pricing) === null || _c === void 0 ? void 0 : _c.trial) || defaultSubscriptionPlan;
+                }
+                else {
+                    days = ((_d = config.pricing) === null || _d === void 0 ? void 0 : _d.trialCrowdin) || ((_e = config.pricing) === null || _e === void 0 ? void 0 : _e.trial) || defaultSubscriptionPlan;
+                }
+                (0, _1.log)(`Subscriptino trial plan ${days} days`, config.logger);
                 const date = new Date(initializedAt);
                 date.setDate(date.getDate() + days);
                 const { expired, daysLeft } = validateSubscription(date);
                 (0, _1.log)(`expired ${expired}`, config.logger);
-                addToCache(organization, appIdentifier, new Date(date), (_f = config.pricing) === null || _f === void 0 ? void 0 : _f.cachingSeconds, subscribeLink);
-                return { expired, subscribeLink, daysLeft };
+                addToCache(organization, appIdentifier, new Date(date), models_1.SubscriptionInfoType.TRIAL, (_f = config.pricing) === null || _f === void 0 ? void 0 : _f.cachingSeconds, subscribeLink);
+                return { expired, subscribeLink, daysLeft, type: models_1.SubscriptionInfoType.TRIAL };
             }
             if (config.onError) {
                 config.onError(e);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdin/app-project-module",
-  "version": "0.16.1",
+  "version": "0.16.3",
   "description": "Module that generates for you all common endpoints for serving standalone Crowdin App",
   "main": "out/index.js",
   "types": "out/index.d.ts",