@crowdin/app-project-module 0.66.0 → 0.67.0

package/README.md

@@ -2,26 +2,12 @@
 
 Module that will automatically add all necessary endpoints for Crowdin App.
 
-:bookmark: See the [docs](/docs) for more information.
+:bookmark: See the [docs](https://crowdin.github.io/app-project-module/) for more information.
 
 ## Contributing
 
-If you want to contribute please read the [Contributing](/CONTRIBUTING.md) guidelines.
+If you would like to contribute please read the [Contributing](/CONTRIBUTING.md) guidelines.
 
 ## Seeking Assistance
 
-If you find any problems or would like to suggest a feature, please feel free to file an issue on Github at [Issues Page](https://github.com/crowdin/app-project-module/issues).
-
-If you've found an error in these samples, please [Contact Customer Success Service](https://crowdin.com/contacts).
-
-## License
-
-<pre>
-The Crowdin App Project module is licensed under the MIT License.
-See the LICENSE.md file distributed with this work for additional
-information regarding copyright ownership.
-
-Except as contained in the LICENSE file, the name(s) of the above copyright
-holders shall not be used in advertising or otherwise to promote the sale,
-use or other dealings in this Software without prior written authorization.
-</pre>
+If you find any problems or would like to suggest a feature, please feel free to file an issue on GitHub at [Issues Page](https://github.com/crowdin/app-project-module/issues) or [Contact Customer Success Service](https://crowdin.com/contacts).

package/out/modules/ai-provider/handlers/chat-completions.js

@@ -13,13 +13,43 @@ const util_1 = require("../../../util");
 const logger_1 = require("../../../util/logger");
 const files_1 = require("../../integration/util/files");
 const util_2 = require("../util");
+// more about roles in AI messages https://platform.openai.com/docs/api-reference/chat/create#chat-create-messages
+// Crowdin documentation https://support.crowdin.com/developer/crowdin-apps-module-custom-ai/#expected-response-from-the-app
+const ROLES = {
+    assistant: 'assistant',
+};
+const DEFAULT_ROLE = ROLES.assistant;
+const getErrorStatus = (e) => {
+    if (typeof e === 'object' && 'status' in e && typeof e.status === 'number') {
+        return e.status;
+    }
+    return 500;
+};
+const getErrorCode = (e) => {
+    if (typeof e === 'object' && 'code' in e) {
+        return e.code;
+    }
+    return undefined;
+};
 function handle(aiProvider) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        let isStream = false;
         try {
             let choices;
             let message;
             let data;
-            const { crowdinApiClient: client, crowdinContext: context, body: { messages, model, action, responseFormat: { type: responseFormatType } = { type: undefined } }, } = req;
+            const chunks = [];
+            const { crowdinApiClient: client, crowdinContext: context, body: { messages, model, action, stream, responseFormat: { type: responseFormatType } = { type: undefined }, }, } = req;
+            isStream = !!stream;
+            const startStream = () => {
+                if (!res.headersSent) {
+                    res.writeHead(200, {
+                        Connection: 'keep-alive',
+                        'Cache-Control': 'no-cache',
+                        'Content-Type': 'text/event-stream',
+                    });
+                }
+            };
             const result = yield aiProvider.chatCompletions({
                 messages,
                 model,
@@ -28,7 +58,32 @@ function handle(aiProvider) {
                 client,
                 context,
                 req,
+                isStream,
+                sendEvent: ({ content, role }) => __awaiter(this, void 0, void 0, function* () {
+                    if (!isStream) {
+                        chunks.push({ content, role });
+                        return;
+                    }
+                    startStream();
+                    const message = {
+                        choices: [
+                            {
+                                delta: {
+                                    role: role || DEFAULT_ROLE,
+                                    content,
+                                },
+                            },
+                        ],
+                    };
+                    res.write(`data: ${JSON.stringify(message)}\n\n`);
+                }),
             });
+            if (isStream) {
+                startStream();
+                res.write('[DONE]');
+                res.end();
+                return;
+            }
             if ((0, files_1.isExtendedResultType)(result)) {
                 data = result.data;
                 message = result.message;
@@ -36,10 +91,18 @@ function handle(aiProvider) {
             else {
                 data = result;
             }
+            if (chunks.length) {
+                data = [
+                    {
+                        role: chunks[0].role || DEFAULT_ROLE,
+                        content: chunks.map((chunk) => chunk.content).join(''),
+                    },
+                ];
+            }
             if (data && data.length > 0) {
                 choices = data.map((message) => ({
                     message: {
-                        role: message.role || 'assistant',
+                        role: message.role || DEFAULT_ROLE,
                         content: message.content,
                     },
                 }));
@@ -50,10 +113,17 @@ function handle(aiProvider) {
             if (req.logError) {
                 req.logError(e);
             }
-            if ((0, util_2.isRateLimitError)(e)) {
-                res.status(429);
+            if (!res.headersSent) {
+                res.status((0, util_2.isRateLimitError)(e) ? 429 : getErrorStatus(e));
+            }
+            if (isStream && res.headersSent) {
+                res.write(`data: ${JSON.stringify({ error: { message: (0, logger_1.getErrorMessage)(e), code: getErrorCode(e) } })}\n\n`);
+                res.write('[DONE]');
+                res.end();
+            }
+            else {
+                res.send({ error: { message: (0, logger_1.getErrorMessage)(e) } });
             }
-            res.send({ error: { message: (0, logger_1.getErrorMessage)(e) } });
         }
     }));
 }

package/out/modules/ai-provider/handlers/get-model-list.js

@@ -22,12 +22,13 @@ function handle(aiProvider) {
                 context: req.crowdinContext,
             });
             const data = modelList.map((model) => {
-                var _a, _b, _c;
+                var _a, _b, _c, _d;
                 return ({
                     id: model.id,
                     supportsJsonMode: (_a = model.supportsJsonMode) !== null && _a !== void 0 ? _a : false,
                     supportsFunctionCalling: (_b = model.supportsFunctionCalling) !== null && _b !== void 0 ? _b : false,
-                    contextWindowLimit: (_c = model.contextWindowLimit) !== null && _c !== void 0 ? _c : exports.CONTEXT_WINDOW_LIMIT,
+                    supportsStreaming: (_c = model.supportsStreaming) !== null && _c !== void 0 ? _c : false,
+                    contextWindowLimit: (_d = model.contextWindowLimit) !== null && _d !== void 0 ? _d : exports.CONTEXT_WINDOW_LIMIT,
                 });
             });
             res.send({ data });

package/out/modules/ai-provider/types.d.ts

@@ -25,6 +25,8 @@ export interface AiProviderModule extends Environments {
         client: Crowdin;
         context: CrowdinContextInfo;
         req: CrowdinClientRequest;
+        isStream: boolean;
+        sendEvent: (chunk: Message) => Promise<void>;
     }) => Promise<Message[] | ExtendedResult<Message[]>>;
     /**
      * provides a list of available model
@@ -38,6 +40,7 @@ export interface SupportedModels {
     id: string;
     supportsJsonMode?: boolean;
     supportsFunctionCalling?: boolean;
+    supportsStreaming?: boolean;
     contextWindowLimit?: number;
 }
 export interface Message {

package/out/modules/install.js

@@ -14,16 +14,19 @@ const types_1 = require("../types");
 const storage_1 = require("../storage");
 const util_1 = require("../util");
 const logger_1 = require("../util/logger");
+const connection_1 = require("../util/connection");
 function handle(config) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
         const event = req.body;
         (0, logger_1.log)(`Received install request ${JSON.stringify(event, null, 2)}`);
         const token = yield fetchToken(config, event);
+        const userId = event.userId;
+        const organization = (event.domain || event.organizationId).toString();
         const credentials = {
-            id: (event.domain || event.organizationId).toString(),
+            id: organization,
             appSecret: event.appSecret,
             domain: event.domain,
-            userId: event.userId,
+            userId,
             agentId: event.agentId,
             organizationId: event.organizationId,
             baseUrl: event.baseUrl,
@@ -41,6 +44,11 @@ function handle(config) {
             yield (0, storage_1.getStorage)().saveCrowdinCredentials(credentials);
             (0, logger_1.log)('A new App has been installed');
         }
+        if (config.onInstall) {
+            const { client } = yield (0, connection_1.prepareCrowdinClient)({ config, credentials, autoRenew: true });
+            (0, logger_1.log)('Invoking onInstall hook');
+            yield config.onInstall({ organization, userId, client });
+        }
         res.status(204).end();
     }));
 }

package/out/modules/integration/index.js

@@ -106,6 +106,7 @@ function register({ config, app }) {
         cron.schedule('0 */3 * * *', () => (0, cron_1.filesCron)({ config, integration: integrationLogic, period: '3' }).catch(console.error));
         cron.schedule('0 */6 * * *', () => (0, cron_1.filesCron)({ config, integration: integrationLogic, period: '6' }).catch(console.error));
         cron.schedule('0 */12 * * *', () => (0, cron_1.filesCron)({ config, integration: integrationLogic, period: '12' }).catch(console.error));
+        cron.schedule('0 0 * * *', () => (0, cron_1.filesCron)({ config, integration: integrationLogic, period: '24' }).catch(console.error));
     }
     // remove user errors
     cron.schedule('0 0 * * *', () => __awaiter(this, void 0, void 0, function* () {

package/out/static/css/crowdin-ui-colors.css

@@ -0,0 +1,115 @@
+/* text color */
+*[class*="crdn-text"] {
+    color: var(--crdn-color, var(--crowdin-body-color));
+}
+
+.crdn-text\:primary {
+    --crdn-color: var(--crowdin-primary);
+}
+
+.crdn-text\:title {
+    --crdn-color: var(--crowdin-title-color);
+}
+
+.crdn-text\:body {
+    --crdn-color: var(--crowdin-body-color);
+}
+
+.crdn-text\:muted {
+    --crdn-color: var(--crowdin-text-muted);
+}
+
+.crdn-text\:disabled {
+    --crdn-color: var(--crowdin-text-disabled);
+}
+
+.crdn-text\:info {
+    --crdn-color: var(--crowdin-info)
+}
+
+.crdn-text\:success {
+    --crdn-color: var(--crowdin-success)
+}
+
+.crdn-text\:warning {
+    --crdn-color: var(--crowdin-warning)
+}
+
+.crdn-text\:danger {
+    --crdn-color: var(--crowdin-danger)
+}
+
+/* backgrounds */
+
+*[class*="crdn-bg"] {
+    background-color: var(--crdn-bg, var(--crowdin-body-bg));
+}
+
+.crdn-bg\:lvl-0 {
+    --crdn-bg: var(--crowdin-level-0-bg);
+}
+
+.crdn-bg\:lvl-1 {
+    --crdn-bg: var(--crowdin-level-1-bg);
+}
+
+.crdn-bg\:lvl-2 {
+    --crdn-bg: var(--crowdin-level-2-bg);
+}
+
+.crdn-bg\:lvl-2\:05 {
+    --crdn-bg: var(--crowdin-level-2-bg-05);
+}
+
+.crdn-bg\:lvl-3 {
+    --crdn-bg: var(--crowdin-level-3-bg);
+}
+
+.crdn-bg\:primary {
+    --crdn-bg: var(--crowdin-primary);
+}
+
+.crdn-bg\:success {
+    --crdn-bg: var(--crowdin-success-bg)
+}
+
+.crdn-bg\:success {
+    --crdn-bg: var(--crowdin-success-bg)
+}
+
+
+.crdn-bg\:warning {
+    --crdn-bg: var(--crowdin-warning-bg)
+}
+
+.crdn-bg\:danger {
+    --crdn-bg: var(--crowdin-danger-bg)
+}
+
+/* borders */
+
+*[class*="crdn-border"] {
+    border-width: 1px;
+    border-style: solid;
+    border-color: var(--crdn-border, var(--crowdin-border-color));
+}
+
+.crdn-border\:primary {
+    --crdn-border: var(--crowdin-primary);
+}
+
+.crdn-border\:danger {
+    --crdn-border: var(--crowdin-danger);
+}
+
+.crdn-border\:info {
+    --crdn-border: var(--crowdin-danger);
+}
+
+.crdn-border\:success {
+    --crdn-border: var(--crowdin-success);
+}
+
+.crdn-border\:warning {
+    --crdn-border: var(--crowdin-warning);
+}

package/out/types.d.ts

@@ -140,6 +140,14 @@ export interface ClientConfig extends ImagePath {
      * modal module
      */
     modal?: ModuleContent & UiModule & Environments;
+    /**
+     * Install hook
+     */
+    onInstall?: ({ organization, userId, client, }: {
+        organization: string;
+        userId: number;
+        client: Crowdin;
+    }) => Promise<void>;
     /**
      * Uninstall hook for cleanup logic
      */

package/out/util/handlebars.js

@@ -25,10 +25,10 @@ exports.engine = (0, express_handlebars_1.default)({
             if (a !== undefined && a !== null && b !== undefined && b !== null) {
                 let bArray;
                 if (Array.isArray(b)) {
-                    bArray = b;
+                    bArray = b.map((item) => item.toString());
                 }
                 else {
-                    bArray = b.split(' ');
+                    bArray = b.toString().split(' ');
                 }
                 if (bArray.includes(a === null || a === void 0 ? void 0 : a.toString())) {
                     return options.fn(this);

package/out/views/main.handlebars

@@ -44,18 +44,6 @@
                 {{/if}}
                 <crowdin-button icon-before="account_circle" onclick="integrationLogout()">Log out</crowdin-button>
             </div>
-                {{#if uploadTranslations}}
-                <crowdin-alert id="translation-info" no-icon="true" style="display: none;">
-                    <div class="box-center">
-                        <p class="info-text">
-                            We recommend importing existing translations into your Crowdin project for newly uploaded source content.
-                            Please note that translations imported for non-key-value formats may require additional review.
-                            Read more about <crowdin-a href="https://support.crowdin.com/uploading-translations/" target="_blank">Uploading Translations</crowdin-a>.
-                        </p>
-                    </div>
-                    <crowdin-button onclick="closeAlert(this)" class="dismiss-alert" icon>close</crowdin-button>
-                </crowdin-alert>
-                {{/if}}
         </div>
         <crowdin-simple-integration
                 async-progress
@@ -83,7 +71,7 @@
                 integration-name="{{name}}"
                 integration-logo="logo.png"
                 {{#if uploadTranslations}}
-                    integration-button-menu-items='[{"label":"Upload Translations", "action":"uploadTranslations"}]'
+                    integration-button-menu-items='[{"label":"Sync translations", "title":"Sync translations to Crowdin", "action":"uploadTranslations"}]'
                 {{/if}}
                 {{#if filtering.crowdinLanguages}}
                 crowdin-filter
@@ -126,7 +114,7 @@
         <crowdin-modal
                 id="settings-modal"
                 body-overflow-unset="{{#checkLength configurationFields 3}}false{{else}}true{{/checkLength}}"
-                modal-width="50"
+                modal-width="65"
                 modal-title="Settings"
                 close-button-title="Close"
         >
@@ -179,6 +167,7 @@
                                 {{#if dependencySettings}}
                                     data-dependency="{{dependencySettings}}"
                                 {{/if}}
+                                is-position-fixed
                             >
                                 {{#each options}}
                                     <option
@@ -467,18 +456,19 @@
                     appComponent.setIntegrationFilesData(tree);
                 } else if (tree.length) {
                     appComponent.pushIntegrationFilesData(tree).then(() => {
-                        appIntegrationFiles.getSelected().then(selection => {
-                            selection = selection?.filter((node) => node);
-                            if (!selection?.length) {
-                                return;
-                            }
-
-                            const selectedIds = selection.map(({id}) => id.toString());
-                            tree.forEach((node) => {
-                                selectedIds.includes(node.parent_id.toString()) && selectedIds.push(node.id.toString());
+                        if (parentId) {
+                            appIntegrationFiles.getSelected().then(selection => {
+                                const selectedIds = selection?.filter((node) => node).map(({id}) => id.toString());
+                                if (!selectedIds?.length) {
+                                    return;
+                                }
+                                const filteredNodes = tree.filter((node) => selectedIds.includes(node.parent_id.toString()));
+                                filteredNodes.forEach((node) => {
+                                    selectedIds.push(node.id);
+                                });
+                                appIntegrationFiles.setSelected(selectedIds);
                             });
-                            appIntegrationFiles.setSelected(selectedIds);
-                        });
+                        }
                     });
                 }
                 {{#if integrationPagination}}
@@ -1118,11 +1108,6 @@
         localStorage.setItem(`revised_${name}`, 1);
     }
 
-    {{#if uploadTranslations}}
-        const translationInfo = document.getElementById('translation-info');
-        checkAlert(translationInfo);
-    {{/if}}
-
     {{#if notice}}
         const notice = document.getElementById('notice');
         checkAlert(notice, 'notice');

package/out/views/partials/head.handlebars

@@ -4,6 +4,7 @@
         <meta http-equiv="X-UA-Compatible" content="ie=edge">
         <title></title>
         <link rel="stylesheet" href="/assets/css/styles.css">
+        <link rel="stylesheet" href="/assets/css/crowdin-ui-colors.css">
         <script type="module"
             src="https://crowdin-web-components.s3.amazonaws.com/crowdin-web-components/crowdin-web-components.esm.js"></script>
         <script nomodule=""

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdin/app-project-module",
-  "version": "0.66.0",
+  "version": "0.67.0",
   "description": "Module that generates for you all common endpoints for serving standalone Crowdin App",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -21,11 +21,11 @@
     "@aws-sdk/client-s3": "^3.606.0",
     "@aws-sdk/s3-request-presigner": "^3.598.0",
     "@crowdin/crowdin-apps-functions": "0.8.1",
-    "@crowdin/logs-formatter": "^2.1.5",
+    "@crowdin/logs-formatter": "^2.1.6",
     "@godaddy/terminus": "^4.12.1",
     "amqplib": "^0.10.4",
     "crypto-js": "^4.2.0",
-    "express": "4.19.2",
+    "express": "^4.21.0",
     "express-handlebars": "^5.3.5",
     "lodash.get": "^4.4.2",
     "lodash.uniqby": "^4.7.0",
@@ -58,8 +58,8 @@
     "@types/express": "4.17.21",
     "@types/express-handlebars": "^5.3.1",
     "@types/jest": "^29.5.12",
-    "@types/lodash.uniqby": "^4.7.9",
     "@types/lodash.get": "^4.4.9",
+    "@types/lodash.uniqby": "^4.7.9",
     "@types/node": "^16.18.101",
     "@types/node-cron": "^3.0.11",
     "@types/pg": "^8.11.6",
@@ -67,6 +67,7 @@
     "@types/uuid": "^9.0.7",
     "@typescript-eslint/eslint-plugin": "^2.3.1",
     "@typescript-eslint/parser": "^2.3.1",
+    "auto-changelog": "^2.5.0",
     "eslint": "^6.4.0",
     "eslint-config-prettier": "^6.3.0",
     "eslint-plugin-prettier": "^3.1.1",