@crowdin/app-project-module 0.15.4 → 0.16.0

package/README.md

@@ -186,7 +186,8 @@ configuration.pricing = {
     trial: 14, //amount of days to use app for free
     trialCrowdin: 14, //amount of days specifically in crowdin workspace
     trialEnterprise: 30, //amount of days specifically for enterprise
-    cachingSeconds: 12 * 60 * 60 //time in seconds of how long to cache subscription info
+    cachingSeconds: 12 * 60 * 60, //time in seconds of how long to cache subscription info
+    infoDisplayDaysThreshold: 14 //number of days threshold to check if subscription info should be displayed (if not defined then info will be always visible)
 };
 ```
 
@@ -326,6 +327,9 @@ It is also possible to define settings window for your app where users can custo
 ```javascript
 configuration.projectIntegration.getConfiguration = (projectId, crowdinClient, integrationCredentials) => {
     return [
+        {
+            label: 'GENERAL'
+        },
         {
             key: 'flag',
             label: 'Checkbox',
@@ -350,6 +354,9 @@ configuration.projectIntegration.getConfiguration = (projectId, crowdinClient, i
         }
     ]
 }
+
+//auto reload on settings updates
+configuration.projectIntegration.reloadOnConfigSave = true;
 ```
 
 ## Info window

package/out/handlers/main.js

@@ -10,6 +10,7 @@ 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 defaults_1 = require("../util/defaults");
 function constructOauthUrl(config, integration) {
     var _a, _b, _c;
@@ -49,11 +50,13 @@ function handle(config, integration) {
             const configurationFields = yield integration.getConfiguration(req.crowdinContext.jwtPayload.context.project_id, req.crowdinApiClient, req.integrationCredentials);
             options.configurationFields = configurationFields;
             options.config = JSON.stringify(req.integrationSettings || {});
+            options.reloadOnConfigSave = !!integration.reloadOnConfigSave;
             (0, util_1.log)(`Adding configuration fields ${JSON.stringify(configurationFields, null, 2)}`, config.logger);
         }
         options.infoModal = integration.infoModal;
         options.withCronSync = integration.withCronSync;
         options.withWebhookSync = integration.withWebhookSync;
+        options.checkSubscription = !(0, connection_1.isAppFree)(config);
         (0, util_1.log)(`Routing user to ${view} view`, config.logger);
         return res.render(view, options);
     }), config.onError);

package/out/handlers/subscription-info.d.ts

@@ -0,0 +1,3 @@
+import { Request, Response } from 'express';
+import { Config } from '../models';
+export default function handle(config: Config): (req: Request, res: Response) => void;

package/out/handlers/subscription-info.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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) {
+            showInfo = config.pricing.infoDisplayDaysThreshold >= ((subscriptionInfo === null || subscriptionInfo === void 0 ? void 0 : subscriptionInfo.daysLeft) || 0);
+        }
+        res.send(Object.assign(Object.assign({}, (subscriptionInfo || {})), { showInfo }));
+    };
+}
+exports.default = handle;

package/out/index.js

@@ -52,6 +52,7 @@ const main_1 = __importDefault(require("./handlers/main"));
 const manifest_1 = __importDefault(require("./handlers/manifest"));
 const oauth_login_1 = __importDefault(require("./handlers/oauth-login"));
 const settings_save_1 = __importDefault(require("./handlers/settings-save"));
+const subscription_info_1 = __importDefault(require("./handlers/subscription-info"));
 const sync_settings_1 = __importDefault(require("./handlers/sync-settings"));
 const sync_settings_save_1 = __importDefault(require("./handlers/sync-settings-save"));
 const uninstall_1 = __importDefault(require("./handlers/uninstall"));
@@ -97,6 +98,7 @@ function addCrowdinEndpoints(app, config) {
         (0, defaults_1.applyDefaults)(config, integrationLogic);
         app.get('/logo/integration/logo.png', (req, res) => res.sendFile(integrationLogic.imagePath || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')));
         app.get('/', (0, crowdin_client_1.default)(config, true, false), (0, integration_credentials_1.default)(config, integrationLogic, true), (0, main_1.default)(config, integrationLogic));
+        app.get('/api/subscription-info', json_response_1.default, (0, crowdin_client_1.default)(config), (0, subscription_info_1.default)(config));
         app.post('/api/settings', (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, integrationLogic), (0, settings_save_1.default)(config));
         app.post('/api/login', (0, crowdin_client_1.default)(config, false, false), (0, integration_login_1.default)(config, integrationLogic));
         app.post('/api/logout', (0, crowdin_client_1.default)(config, false, false), (0, integration_logout_1.default)(config));

package/out/middlewares/crowdin-client.d.ts

@@ -1,9 +1,10 @@
 /// <reference types="qs" />
 import Crowdin from '@crowdin/crowdin-api-client';
 import { Response } from 'express';
-import { Config, CrowdinContextInfo } from '../models';
+import { Config, CrowdinContextInfo, SubscriptionInfo } from '../models';
 export declare function prepareCrowdinRequest(jwtToken: string, config: Config, optional?: boolean, checkSubscriptionExpiration?: boolean): Promise<{
     context: CrowdinContextInfo;
     client?: Crowdin;
+    subscriptionInfo?: SubscriptionInfo;
 }>;
 export default function handle(config: Config, optional?: boolean, checkSubscriptionExpiration?: boolean): (req: import("express").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/middlewares/crowdin-client.js

@@ -44,13 +44,14 @@ function prepareCrowdinRequest(jwtToken, config, optional = false, checkSubscrip
         }
         (0, util_1.log)('Building crowdin client instance', config.logger);
         const { client, token } = yield (0, connection_1.prepareCrowdinClient)(config, credentials);
+        let subscriptionInfo;
         if (checkSubscriptionExpiration) {
-            const { expired, subscribeLink } = yield (0, connection_1.checkSubscription)(config, token, credentials.id, credentials.type);
-            if (expired) {
-                throw new util_1.CodeError(subscribeLink || '', 402);
+            subscriptionInfo = yield (0, connection_1.checkSubscription)(config, token, credentials.id, credentials.type);
+            if (subscriptionInfo.expired) {
+                throw new util_1.CodeError(subscriptionInfo.subscribeLink || '', 402);
             }
         }
-        return { context, client };
+        return { context, client, subscriptionInfo };
     });
 }
 exports.prepareCrowdinRequest = prepareCrowdinRequest;
@@ -66,6 +67,7 @@ function handle(config, optional = false, checkSubscriptionExpiration = true) {
             if (data.client) {
                 req.crowdinApiClient = data.client;
             }
+            req.subscriptionInfo = data.subscriptionInfo;
             next();
         }
         catch (e) {

package/out/models/index.d.ts

@@ -150,7 +150,11 @@ export interface IntegrationLogic {
     /**
      * 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<ConfigurationField[]>;
+    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)
      */
@@ -171,6 +175,7 @@ export interface IntegrationLogic {
         integration: boolean;
     };
 }
+export declare type ConfigurationModalEntity = ConfigurationField | ConfigurationDelimeter;
 export interface ConfigurationField {
     key: string;
     label: string;
@@ -188,6 +193,9 @@ export interface ConfigurationField {
         value: string;
     }[];
 }
+export interface ConfigurationDelimeter {
+    label: string;
+}
 export interface LoginForm {
     fields: FormField[];
 }
@@ -314,6 +322,7 @@ export interface IntegrationRequest extends CrowdinClientRequest {
 export interface CrowdinClientRequest extends Request {
     crowdinApiClient: Crowdin;
     crowdinContext: CrowdinContextInfo;
+    subscriptionInfo?: SubscriptionInfo;
 }
 export interface CrowdinCredentials {
     id: string;
@@ -331,6 +340,11 @@ export interface CrowdinContextInfo {
     crowdinId: string;
     clientId: string;
 }
+export interface SubscriptionInfo {
+    expired: boolean;
+    subscribeLink?: string;
+    daysLeft?: number;
+}
 export interface IntegrationCredentials {
     id: string;
     credentials: any;
@@ -490,5 +504,6 @@ export interface Pricing {
     trialCrowdin?: number;
     trialEnterprise?: number;
     cachingSeconds?: number;
+    infoDisplayDaysThreshold?: number;
 }
 export {};

package/out/static/css/styles.css

@@ -5,11 +5,9 @@
 }
 
 .center {
-    text-align: center;
-    min-height: calc(100vh - 64px);
     display: flex;
     align-items: center;
-    justify-content: space-around;
+    justify-content: center;
 }
 
 .top {
@@ -41,3 +39,11 @@
 .login crowdin-h4 {
     margin: 8px 0 16px;
 }
+
+.ml-1 {
+    margin-left: 8px;
+}
+
+.m-0 {
+    margin: 0;
+}

package/out/util/connection.d.ts

@@ -1,12 +1,10 @@
 import Crowdin from '@crowdin/crowdin-api-client';
-import { AccountType, Config, CrowdinCredentials, IntegrationCredentials, IntegrationLogic } from '../models';
+import { AccountType, Config, CrowdinCredentials, IntegrationCredentials, IntegrationLogic, SubscriptionInfo } from '../models';
 export declare function prepareCrowdinClient(config: Config, credentials: CrowdinCredentials): Promise<{
     client: Crowdin;
     token: string;
 }>;
 export declare function prepareIntegrationCredentials(config: Config, integration: IntegrationLogic, integrationCredentials: IntegrationCredentials): Promise<any>;
 export declare function clearCache(organization: string): void;
-export declare function checkSubscription(config: Config, token: string, organization: string, accountType: AccountType): Promise<{
-    expired: boolean;
-    subscribeLink?: string;
-}>;
+export declare function isAppFree(config: Config): boolean;
+export declare function checkSubscription(config: Config, token: string, organization: string, accountType: AccountType): Promise<SubscriptionInfo>;

package/out/util/connection.js

@@ -31,7 +31,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkSubscription = exports.clearCache = exports.prepareIntegrationCredentials = exports.prepareCrowdinClient = void 0;
+exports.checkSubscription = exports.isAppFree = exports.clearCache = exports.prepareIntegrationCredentials = exports.prepareCrowdinClient = void 0;
 const crowdin_api_client_1 = __importDefault(require("@crowdin/crowdin-api-client"));
 const crowdinAppFunctions = __importStar(require("@crowdin/crowdin-apps-functions"));
 const axios_1 = __importDefault(require("axios"));
@@ -133,19 +133,29 @@ function clearCache(organization) {
     delete subscriptionCache[organization];
 }
 exports.clearCache = clearCache;
+function isAppFree(config) {
+    return !config.pricing || config.pricing.planType === 'free';
+}
+exports.isAppFree = isAppFree;
+function validateSubscription(date) {
+    const expired = date.getTime() < Date.now();
+    const daysLeft = Math.round((date.getTime() - Date.now()) / (1000 * 60 * 60 * 24));
+    return { expired, daysLeft };
+}
 function checkSubscription(config, token, organization, accountType) {
+    var _a, _b, _c, _d, _e, _f;
     return __awaiter(this, void 0, void 0, function* () {
-        if (!config.pricing || config.pricing.planType === 'free') {
+        if (isAppFree(config)) {
             return { expired: false };
         }
         //default 2 weeks
         const defaultSubscriptionPlan = 14;
         let days;
         if (organization) {
-            days = config.pricing.trialEnterprise || config.pricing.trial || defaultSubscriptionPlan;
+            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 = config.pricing.trialCrowdin || config.pricing.trial || defaultSubscriptionPlan;
+            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);
         const appIdentifier = config.identifier;
@@ -154,9 +164,9 @@ function checkSubscription(config, token, organization, accountType) {
             const { cacheValidUntil, validUntil, subscribeLink } = cacheEntry;
             if (cacheValidUntil.getTime() > Date.now()) {
                 (0, _1.log)(`Loaded data from cache. Subscription is vali until ${validUntil.toISOString()}`, config.logger);
-                const expired = new Date(validUntil).getTime() < Date.now();
+                const { expired, daysLeft } = validateSubscription(new Date(validUntil));
                 (0, _1.log)(`expired ${expired}`, config.logger);
-                return { expired, subscribeLink };
+                return { expired, subscribeLink, daysLeft };
             }
         }
         try {
@@ -166,10 +176,10 @@ function checkSubscription(config, token, organization, accountType) {
                 token,
             });
             (0, _1.log)(`Recieved subscription info. ${JSON.stringify(subscription)}`, config.logger);
-            const expired = new Date(subscription.expires).getTime() < Date.now();
+            const { expired, daysLeft } = validateSubscription(new Date(subscription.expires));
             (0, _1.log)(`expired ${expired}`, config.logger);
-            addToCache(organization, appIdentifier, new Date(subscription.expires), config.pricing.cachingSeconds);
-            return { expired };
+            addToCache(organization, appIdentifier, new Date(subscription.expires), (_e = config.pricing) === null || _e === void 0 ? void 0 : _e.cachingSeconds);
+            return { expired, daysLeft };
         }
         catch (e) {
             if (e instanceof crowdinAppFunctions.PaymentRequiredError) {
@@ -177,10 +187,10 @@ function checkSubscription(config, token, organization, accountType) {
                 (0, _1.log)(`Recieved 402 payment error. initializedAt ${initializedAt}`, config.logger);
                 const date = new Date(initializedAt);
                 date.setDate(date.getDate() + days);
-                const expired = date.getTime() < Date.now();
+                const { expired, daysLeft } = validateSubscription(date);
                 (0, _1.log)(`expired ${expired}`, config.logger);
-                addToCache(organization, appIdentifier, new Date(date), config.pricing.cachingSeconds, subscribeLink);
-                return { expired, subscribeLink };
+                addToCache(organization, appIdentifier, new Date(date), (_f = config.pricing) === null || _f === void 0 ? void 0 : _f.cachingSeconds, subscribeLink);
+                return { expired, subscribeLink, daysLeft };
             }
             if (config.onError) {
                 config.onError(e);

package/out/util/defaults.js

@@ -105,6 +105,9 @@ function applyDefaults(config, integration) {
                 fields = yield getUserSettings(projectId, crowdinClient, integrationCredentials);
             }
             return [
+                {
+                    label: 'Background synchronization',
+                },
                 {
                     key: 'schedule',
                     label: 'Sync schedule',

package/out/views/main.handlebars

@@ -4,7 +4,15 @@
 
 <body>
     <div class="i_w">
-        <div class='top'>
+        <div class="top">
+            {{#if checkSubscription}}
+                <crowdin-alert id="subscription-info" no-icon="true" type="warning" style="display: none;">
+                    <div class="center">
+                        <p class="m-0"></p>
+                        <crowdin-button class="ml-1" primary onclick="window.open(subscriptionLink,'_blank')">Subscribe</crowdin-button>
+                    </div>
+                </crowdin-alert>
+            {{/if}}
             {{#if infoModal}}
             <crowdin-button icon-before="info" onclick="infoModal.open();">{{infoModal.title}}</crowdin-button>
             {{/if}}
@@ -59,50 +67,54 @@
         >
             <div id="modal-content">
                 {{#each configurationFields}}
-                    {{#ifeq type "checkbox"}}
-                            <crowdin-checkbox
-                                use-switch
-                                label="{{label}}"
-                                value="false"
-                                id="{{key}}-settings"
-                                key="{{key}}"
-                                {{#if helpText}}
-                                    help-text="{{helpText}}"
-                                {{/if}}
-                            >
-                            </crowdin-checkbox>
-                    {{/ifeq}}
-                    {{#ifeq type "select"}}
-                            <crowdin-select
-                                {{#if isMulti}}
-                                is-multi
-                                close-on-select="false"
-                                {{/if}}
-                                id="{{key}}-settings"
-                                key="{{key}}"
-                                label="{{label}}"
-                                {{#if helpText}}
-                                    help-text="{{helpText}}"
-                                {{/if}}
-                            >
-                                {{#each options}}
-                                    <option value="{{value}}">{{label}}</option>
-                                {{/each}}
-                            </crowdin-select>
-                    {{/ifeq}}
-                    {{#ifeq type "text"}}
-                            <crowdin-input
-                                    with-fixed-height
+                    {{#if key}}
+                        {{#ifeq type "checkbox"}}
+                                <crowdin-checkbox
+                                    use-switch
                                     label="{{label}}"
-                                    value=""
+                                    value="false"
                                     id="{{key}}-settings"
                                     key="{{key}}"
                                     {{#if helpText}}
                                         help-text="{{helpText}}"
                                     {{/if}}
-                             >
-                             </crowdin-input>
-                    {{/ifeq}}
+                                >
+                                </crowdin-checkbox>
+                        {{/ifeq}}
+                        {{#ifeq type "select"}}
+                                <crowdin-select
+                                    {{#if isMulti}}
+                                    is-multi
+                                    close-on-select="false"
+                                    {{/if}}
+                                    id="{{key}}-settings"
+                                    key="{{key}}"
+                                    label="{{label}}"
+                                    {{#if helpText}}
+                                        help-text="{{helpText}}"
+                                    {{/if}}
+                                >
+                                    {{#each options}}
+                                        <option value="{{value}}">{{label}}</option>
+                                    {{/each}}
+                                </crowdin-select>
+                        {{/ifeq}}
+                        {{#ifeq type "text"}}
+                                <crowdin-input
+                                        with-fixed-height
+                                        label="{{label}}"
+                                        value=""
+                                        id="{{key}}-settings"
+                                        key="{{key}}"
+                                        {{#if helpText}}
+                                            help-text="{{helpText}}"
+                                        {{/if}}
+                                >
+                                </crowdin-input>
+                        {{/ifeq}}
+                    {{else}}
+                        <crowdin-p>{{label}}</crowdin-p>
+                    {{/if}}
                     <div style="padding: 8px"></div>
                 {{/each}}
             </div>
@@ -350,6 +362,10 @@
             .finally(() => {
                 settingsSaveBtn.removeAttribute('disabled');
                 settingsModal.close();
+                {{#if reloadOnConfigSave}}
+                    getIntegrationData();
+                    getCrowdinData();
+                {{/if}}
             });
     }
     {{/if}}
@@ -431,6 +447,25 @@
                 .finally(() => (appComponent.setAttribute(`is-${provider}-loading`, false)));
         }
     {{/if}}
+
+    {{#if checkSubscription}}
+        const subscriptionInfo = document.getElementById('subscription-info');
+        const subscriptionInfoText = subscriptionInfo.getElementsByTagName('p')[0];
+        function getSubscriptionInfo() {
+            checkOrigin()
+                .then(restParams => fetch('api/subscription-info' + restParams))
+                .then(checkResponse)
+                .then((res) => {
+                    if (res.showInfo) {
+                        subscriptionLink = res.subscribeLink;
+                        subscriptionInfoText.textContent = `Your trial expires in ${res.daysLeft} days.`
+                        subscriptionInfo.style.display = 'block';
+                    }
+                });
+        }
+
+        getSubscriptionInfo();
+    {{/if}}
 </script>
 
 </html>

package/package.json

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