@crowdin/app-project-module 0.50.1 → 0.51.0

package/out/index.js

@@ -60,6 +60,7 @@ const apiApp = __importStar(require("./modules/api"));
 const contextMenuApp = __importStar(require("./modules/context-menu"));
 const customMTApp = __importStar(require("./modules/custom-mt"));
 const spellCheckApp = __importStar(require("./modules/custom-spell-check"));
+const aiProvider = __importStar(require("./modules/ai-provider"));
 const editorRightPanelApp = __importStar(require("./modules/editor-right-panel"));
 const editorThemesApp = __importStar(require("./modules/editor-themes"));
 const fileProcessingApps = __importStar(require("./modules/file-processing"));
@@ -163,6 +164,7 @@ function addCrowdinEndpoints(app, clientConfig) {
     fileProcessingApps.registerFilePreExport({ config, app });
     fileProcessingApps.registerFilePostExport({ config, app });
     apiApp.register({ config, app });
+    aiProvider.register({ config, app });
     addFormSchema({ config, app });
     return Object.assign(Object.assign({}, exports.metadataStore), { establishCrowdinConnection: (authRequest) => {
             let jwtToken = '';

package/out/modules/ai-provider/handlers/chat-completions.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="qs" />
+import { Response } from 'express';
+import { CrowdinClientRequest } from '../../../types';
+import { AiProviderModule } from '../types';
+export default function handle(aiProvider: AiProviderModule): (req: CrowdinClientRequest | 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/modules/ai-provider/handlers/chat-completions.js

@@ -0,0 +1,53 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("../../../util");
+const logger_1 = require("../../../util/logger");
+const files_1 = require("../../integration/util/files");
+function handle(aiProvider) {
+    return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        try {
+            let choices;
+            let message;
+            let data;
+            const result = yield aiProvider.chatCompletions({
+                messages: req.body.messages,
+                model: req.body.model,
+                client: req.crowdinApiClient,
+                context: req.crowdinContext,
+                req,
+            });
+            if ((0, files_1.isExtendedResultType)(result)) {
+                data = result.data;
+                message = result.message;
+            }
+            else {
+                data = result;
+            }
+            if (data && data.length > 0) {
+                choices = data.map((message) => ({
+                    message: {
+                        role: message.role || 'assistant',
+                        content: message.content,
+                    },
+                }));
+            }
+            res.send({ choices, message });
+        }
+        catch (e) {
+            if (req.logError) {
+                req.logError(e);
+            }
+            res.send({ error: { message: (0, logger_1.getErrorMessage)(e) } });
+        }
+    }));
+}
+exports.default = handle;

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

@@ -0,0 +1,5 @@
+/// <reference types="qs" />
+import { Response } from 'express';
+import { CrowdinClientRequest } from '../../../types';
+import { AiProviderModule } from '../types';
+export default function handle(aiProvider: AiProviderModule): (req: CrowdinClientRequest | 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/modules/ai-provider/handlers/get-model-list.js

@@ -0,0 +1,31 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("../../../util");
+const logger_1 = require("../../../util/logger");
+function handle(aiProvider) {
+    return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        try {
+            const data = yield aiProvider.getModelsList({
+                client: req.crowdinApiClient,
+                context: req.crowdinContext,
+            });
+            res.send({ data });
+        }
+        catch (e) {
+            if (req.logError) {
+                req.logError(e);
+            }
+            res.send({ error: { message: (0, logger_1.getErrorMessage)(e) } });
+        }
+    }));
+}
+exports.default = handle;

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

@@ -0,0 +1,6 @@
+import { Express } from 'express';
+import { Config } from '../../types';
+export declare function register({ config, app }: {
+    config: Config;
+    app: Express;
+}): void;

package/out/modules/ai-provider/index.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.register = void 0;
+const json_response_1 = __importDefault(require("../../middlewares/json-response"));
+const get_model_list_1 = __importDefault(require("./handlers/get-model-list"));
+const chat_completions_1 = __importDefault(require("./handlers/chat-completions"));
+const ui_module_1 = __importDefault(require("../../middlewares/ui-module"));
+const render_ui_module_1 = __importDefault(require("../../middlewares/render-ui-module"));
+const util_1 = require("../../util");
+const crowdin_client_1 = __importDefault(require("../../middlewares/crowdin-client"));
+function register({ config, app }) {
+    if (!config.aiProvider) {
+        return;
+    }
+    if (config.aiProvider.settingsUiModule) {
+        app.use('/settings', (0, ui_module_1.default)(config, true), (0, render_ui_module_1.default)(config.aiProvider.settingsUiModule));
+    }
+    app.get((0, util_1.getLogoUrl)(config.aiProvider, '/aiprovider'), (req, res) => { var _a; return res.sendFile(((_a = config.aiProvider) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath); });
+    app.get('/models', json_response_1.default, (0, crowdin_client_1.default)(config), (0, get_model_list_1.default)(config.aiProvider));
+    app.post('/completions', json_response_1.default, (0, crowdin_client_1.default)(config), (0, chat_completions_1.default)(config.aiProvider));
+}
+exports.register = register;

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

@@ -0,0 +1,41 @@
+import { CrowdinClientRequest, CrowdinContextInfo, Environments, UiModule } from '../../types';
+import Crowdin from '@crowdin/crowdin-api-client';
+import { ExtendedResult } from '../integration/types';
+export interface AiProviderModule extends Environments {
+    /**
+     * module name
+     */
+    name: string;
+    /**
+     * module description
+     */
+    description: string;
+    /**
+     * Settings UI module
+     */
+    settingsUiModule?: UiModule;
+    /**
+     * processes a sequence of conversation messages and generates responses from the assistant
+     */
+    chatCompletions: ({ messages, model, client, context, req, }: {
+        messages: Message[];
+        model: string;
+        client: Crowdin;
+        context: CrowdinContextInfo;
+        req: CrowdinClientRequest;
+    }) => Promise<Message[] | ExtendedResult<Message[]>>;
+    /**
+     * provides a list of available model
+     */
+    getModelsList: ({ client, context, }: {
+        client: Crowdin;
+        context: CrowdinContextInfo;
+    }) => Promise<SupportedModels[]>;
+}
+export interface SupportedModels {
+    id: string;
+}
+export interface Message {
+    role?: string;
+    content: string;
+}

package/out/modules/ai-provider/types.js

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

package/out/modules/manifest.js

@@ -171,6 +171,14 @@ function handle(config) {
             })), (uiModule ? { url: '/settings/' + (uiModule.fileName || 'index.html') } : {})),
         ];
     }
+    if (config.aiProvider) {
+        const uiModule = config.aiProvider.settingsUiModule;
+        modules['ai-provider'] = [
+            Object.assign(Object.assign({ key: config.identifier + '-aiprovider', name: config.aiProvider.name || config.name, description: config.aiProvider.description || config.description, logo: (0, util_1.getLogoUrl)(config.aiProvider, '/aiprovider'), chatCompletionsUrl: '/completions', modelsUrl: '/models' }, (!!config.aiProvider.environments && {
+                environments: normalizeEnvironments(config.aiProvider.environments),
+            })), (uiModule ? { url: '/settings/' + (uiModule.fileName || 'index.html') } : {})),
+        ];
+    }
     const events = {
         installed: '/installed',
         uninstall: '/uninstall',

package/out/types.d.ts

@@ -12,6 +12,7 @@ import { MySQLStorageConfig } from './storage/mysql';
 import { PostgreStorageConfig } from './storage/postgre';
 import { ApiModule } from './modules/api/types';
 import { LogErrorFunction, LogFunction } from './util/logger';
+import { AiProviderModule } from './modules/ai-provider/types';
 export interface ClientConfig extends ImagePath {
     /**
      * Authentication Crowdin App type: "authorization_code", "crowdin_app". Default: "crowdin_app"
@@ -171,6 +172,10 @@ export interface ClientConfig extends ImagePath {
      */
     awsConfig?: AWSConfig;
     customSpellchecker?: CustomSpellcheckerModule;
+    /**
+     * ai provider module
+     */
+    aiProvider?: AiProviderModule & ImagePath;
 }
 export interface Environments {
     environments?: Environment | Environment[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdin/app-project-module",
-  "version": "0.50.1",
+  "version": "0.51.0",
   "description": "Module that generates for you all common endpoints for serving standalone Crowdin App",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -28,7 +28,7 @@
     "express": "4.19.2",
     "express-handlebars": "^5.3.5",
     "lodash.uniqby": "^4.7.0",
-    "mysql2": "^3.9.4",
+    "mysql2": "^3.9.7",
     "node-cron": "^3.0.3",
     "pg": "^8.11.5",
     "redoc-express": "^2.1.0",