@crowdin/app-project-module 1.11.0 → 1.12.0

package/out/modules/ai-prompt-provider/handlers/status.d.ts

@@ -0,0 +1,4 @@
+import { Response } from 'express';
+import { CrowdinClientRequest } from '../../../types';
+import { AiPromptProviderModule } from '../types';
+export default function handle(aiPromptProvider: AiPromptProviderModule): (req: import("express").Request | CrowdinClientRequest, res: Response, next: Function) => void;

package/out/modules/ai-prompt-provider/handlers/status.js

@@ -0,0 +1,43 @@
+"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 });
+exports.default = handle;
+const util_1 = require("../../../util");
+const logger_1 = require("../../../util/logger");
+function handle(aiPromptProvider) {
+    return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        if (!aiPromptProvider.status) {
+            res.status(204).send();
+            return;
+        }
+        try {
+            const { options, aiPromptId } = req.body;
+            const result = yield aiPromptProvider.status({
+                options,
+                aiPromptId,
+                client: req.crowdinApiClient,
+                context: req.crowdinContext,
+            });
+            res.send({
+                usedAiProviderIds: result.usedAiProviderIds,
+                isConfigured: result.isConfigured,
+                errors: result.errors,
+                warnings: result.warnings,
+            });
+        }
+        catch (e) {
+            if (req.logError) {
+                req.logError(e);
+            }
+            res.status(500).send({ error: { message: (0, logger_1.getErrorMessage)(e) } });
+        }
+    }));
+}

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

@@ -10,6 +10,7 @@ const render_ui_module_1 = __importDefault(require("../../middlewares/render-ui-
 const util_1 = require("../../util");
 const crowdin_client_1 = __importDefault(require("../../middlewares/crowdin-client"));
 const compile_1 = __importDefault(require("./handlers/compile"));
+const status_1 = __importDefault(require("./handlers/status"));
 const normalize_module_1 = require("../../util/normalize-module");
 function register({ config, app }) {
     var _a;
@@ -34,6 +35,14 @@ function register({ config, app }) {
             checkSubscriptionExpiration: true,
             moduleKey: key,
         }), (0, compile_1.default)(provider));
+        if (provider.status) {
+            app.post(`${base}/status`, json_response_1.default, (0, crowdin_client_1.default)({
+                config,
+                optional: false,
+                checkSubscriptionExpiration: true,
+                moduleKey: key,
+            }), (0, status_1.default)(provider));
+        }
         if (provider.formSchema || provider.uiPath) {
             app.use(`${base}/settings`, (0, ui_module_1.default)({ config, allowUnauthorized: true, moduleType: key }), (0, render_ui_module_1.default)(provider, config));
         }

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

@@ -25,4 +25,25 @@ export interface AiPromptProviderModule extends UiModule {
      * Default: true
      */
     allowRetryOnQaIssues?: boolean;
+    /**
+     * Optional handler that returns prompt status info (used providers, configuration state, errors).
+     * When provided, Crowdin will call this to display real-time status for external prompts.
+     */
+    status?: (options: {
+        options: any;
+        aiPromptId: number;
+        client: Crowdin;
+        context: CrowdinContextInfo;
+    }) => Promise<{
+        usedAiProviderIds: number[];
+        isConfigured: boolean;
+        errors: Array<{
+            code: string;
+            message: string;
+        }>;
+        warnings: Array<{
+            code: string;
+            message: string;
+        }>;
+    }>;
 }

package/out/modules/manifest.js

@@ -575,9 +575,9 @@ function handle(config) {
             item.key = key;
             const base = isSingle ? '/prompt-provider' : `/prompt-provider/${key}`;
             const logoPath = isSingle ? '/ai-prompt-provider' : `/ai-prompt-provider-${key}`;
-            return Object.assign(Object.assign(Object.assign({ key, name: item.name || config.name, logo: (0, util_1.getLogoUrl)(config, item, logoPath), compileUrl: `${base}/compile` }, ((0, util_1.isDefined)(item.allowRetryOnQaIssues) && {
+            return Object.assign(Object.assign(Object.assign(Object.assign({ key, name: item.name || config.name, logo: (0, util_1.getLogoUrl)(config, item, logoPath), compileUrl: `${base}/compile` }, ((0, util_1.isDefined)(item.allowRetryOnQaIssues) && {
                 allowRetryOnQaIssues: item.allowRetryOnQaIssues,
-            })), (item.actions ? { actions: item.actions } : {})), (item.formSchema || item.uiPath
+            })), (item.actions ? { actions: item.actions } : {})), (item.status ? { statusUrl: `${base}/status` } : {})), (item.formSchema || item.uiPath
                 ? { configuratorUrl: `${base}/settings/` + (item.fileName || 'index.html') }
                 : {}));
         });

package/package.json

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