@crowdin/app-project-module 0.107.0 → 1.0.0

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

@@ -16,9 +16,9 @@ function register({ config, app }) {
         return;
     }
     if (config.aiProvider.settingsUiModule) {
-        app.use('/settings', (0, ui_module_1.default)({ config, allowUnauthorized: true, moduleType: config.aiProvider.key }), (0, render_ui_module_1.default)(config.aiProvider.settingsUiModule));
+        app.use('/settings', (0, ui_module_1.default)({ config, allowUnauthorized: true, moduleType: config.aiProvider.key }), (0, render_ui_module_1.default)(config.aiProvider.settingsUiModule, config));
     }
-    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.use('/logo/aiprovider', (0, util_1.serveLogo)(config, config.aiProvider));
     app.get('/ai-provider/models', json_response_1.default, (0, crowdin_client_1.default)({
         config,
         optional: false,

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

@@ -5,11 +5,11 @@ export interface AiProviderModule extends Environments, ModuleKey {
     /**
      * module name
      */
-    name: string;
+    name?: string;
     /**
      * module description
      */
-    description: string;
+    description?: string;
     /**
      * Settings UI module
      */
@@ -17,14 +17,14 @@ export interface AiProviderModule extends Environments, ModuleKey {
     /**
      * processes a sequence of conversation messages and generates responses from the assistant
      */
-    chatCompletions: ({ messages, model, action, responseFormat, client, context, req, isStream, sendEvent, tools, toolChoice, }: {
+    chatCompletions: ({ messages, model, action, responseFormat, client, context, request, isStream, sendEvent, tools, toolChoice, }: {
         messages: ChatCompletionMessage[];
         model: string;
         action: string;
         responseFormat: string;
         client: Crowdin;
         context: CrowdinContextInfo;
-        req: CrowdinClientRequest;
+        request: CrowdinClientRequest;
         isStream: boolean;
         sendEvent: (chunk: ChatCompletionChunkMessage) => Promise<void>;
         tools?: ChatCompletionTool[];

package/out/modules/ai-request-processors/handler.d.ts

@@ -2,4 +2,4 @@
 import { Response } from 'express';
 import { CrowdinClientRequest } from '../../types';
 import { AiRequestProcessorModule, AiStreamProcessorModule } from './types';
-export default function handle(module: AiRequestProcessorModule | AiStreamProcessorModule, canHandleStream?: boolean): (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;
+export default function handle(module: AiRequestProcessorModule | AiStreamProcessorModule, canHandleStream?: boolean): (req: import("express").Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>> | CrowdinClientRequest, res: Response<any, Record<string, any>>, next: Function) => void;

package/out/modules/ai-request-processors/handler.js

@@ -30,7 +30,12 @@ function handle(module, canHandleStream = false) {
                     let chunkStr = chunk.toString();
                     // actually we checked if processStream exists already, but need do to this again to calm down TS compiler
                     chunkStr = module.processStream
-                        ? yield module.processStream(chunkStr, req.query, req.crowdinApiClient, req.crowdinContext)
+                        ? yield module.processStream({
+                            chunk: chunkStr,
+                            requestContext: req.query,
+                            client: req.crowdinApiClient,
+                            context: req.crowdinContext,
+                        })
                         : chunkStr;
                     if (!chunkStr && typeof chunkStr !== 'string') {
                         res.write(BUFFERING_FLAG);
@@ -49,7 +54,12 @@ function handle(module, canHandleStream = false) {
                 });
                 return;
             }
-            const result = yield module.processRequest(req.body, req.query, req.crowdinApiClient, req.crowdinContext);
+            const result = yield module.processRequest({
+                requestData: req.body,
+                requestContext: req.query,
+                client: req.crowdinApiClient,
+                context: req.crowdinContext,
+            });
             res.send(result);
         }
         catch (e) {

package/out/modules/ai-request-processors/types.d.ts

@@ -4,11 +4,21 @@ export interface AiRequestProcessorModule extends ModuleKey {
     /**
      * updates request data
      */
-    processRequest: (requestData: any, requestContext: any, client: Crowdin, context: CrowdinContextInfo) => Promise<never>;
+    processRequest: (options: {
+        requestData: any;
+        requestContext: any;
+        client: Crowdin;
+        context: CrowdinContextInfo;
+    }) => Promise<never>;
 }
 export interface AiStreamProcessorModule extends AiRequestProcessorModule {
     /**
      * updates request data
      */
-    processStream?: (chunk: any, requestContext: any, client: Crowdin, context: CrowdinContextInfo) => Promise<string | null>;
+    processStream?: (options: {
+        chunk: any;
+        requestContext: any;
+        client: Crowdin;
+        context: CrowdinContextInfo;
+    }) => Promise<string | null>;
 }

package/out/modules/ai-tools/handlers/tool-calls.d.ts

@@ -2,4 +2,4 @@
 import { Response } from 'express';
 import { CrowdinClientRequest } from '../../../types';
 import { AiTool } from '../types';
-export default function handle(aiTool: AiTool): (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;
+export default function handle(aiTool: AiTool): (req: import("express").Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>> | CrowdinClientRequest, res: Response<any, Record<string, any>>, next: Function) => void;

package/out/modules/ai-tools/handlers/tool-calls.js

@@ -32,7 +32,7 @@ function handle(aiTool) {
                 projectId,
                 payload,
                 context,
-                req,
+                request: req,
             });
             res.send({
                 data: {

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

@@ -37,7 +37,7 @@ function registerAiToolWidgets({ config, app }) {
     const tools = Array.isArray(config.aiToolsWidget) ? config.aiToolsWidget : [config.aiToolsWidget];
     for (const tool of tools) {
         if ((0, util_1.isUniqueFunctionName)(tool)) {
-            app.use((0, util_1.getAiToolWidgetUrl)(tool), (0, ui_module_1.default)({ config, moduleType: tool.key }), (0, render_ui_module_1.default)(tool));
+            app.use((0, util_1.getAiToolWidgetUrl)(tool), (0, ui_module_1.default)({ config, moduleType: tool.key }), (0, render_ui_module_1.default)(tool, config));
         }
         else {
             throw new Error(`The function name '${tool.function.name}' is not unique within aiTools and aiToolsWidget`);

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

@@ -42,7 +42,7 @@ interface AiToolArguments {
     projectId: number;
     payload: AiToolPayload;
     context: CrowdinContextInfo;
-    req: CrowdinClientRequest;
+    request: CrowdinClientRequest;
 }
 interface AiToolPayload {
     function: {

package/out/modules/api/api.js

@@ -256,9 +256,14 @@ function addDefaultApiEndpoints(app, config) {
          *         content:
          *           application/json:
          *             schema:
+         *               type: object
          *               properties:
          *                 data:
          *                   $ref: '#/components/schemas/IntegrationFiles'
+         *                 message:
+         *                   type: string
+         *                   nullable: true
+         *                   description: 'Optional message (e.g., error info)'
          *
          */
         app.get('/integration-files', api_call_1.default, json_response_1.default, (0, crowdin_client_1.default)({
@@ -330,30 +335,36 @@ function addDefaultApiEndpoints(app, config) {
          *     tags:
          *       - 'Jobs'
          *     summary: 'List Jobs'
+         *     description: 'Retrieve a paginated list of all jobs for the current integration'
          *     operationId: job.list
          *     parameters:
          *       - $ref: '#/components/parameters/ProjectId'
          *       - name: limit
          *         in: query
          *         required: false
-         *         description: 'Number of jobs to return'
+         *         description: 'Maximum number of jobs to return'
          *         schema:
          *           type: integer
+         *           default: 25
+         *           minimum: 1
+         *           maximum: 100
          *           example: 25
          *       - name: offset
          *         in: query
          *         required: false
-         *         description: 'Number of jobs to skip'
+         *         description: 'Number of jobs to skip for pagination'
          *         schema:
          *           type: integer
+         *           default: 0
+         *           minimum: 0
          *           example: 0
          *     responses:
          *       200:
-         *         description: 'Job information retrieved successfully'
+         *         description: 'List of jobs retrieved successfully'
          *         content:
          *           application/json:
          *             schema:
-         *               $ref: '#/components/schemas/JobResponse'
+         *               $ref: '#/components/schemas/JobListResponse'
          */
         app.get('/all-jobs', api_call_1.default, json_response_1.default, (0, crowdin_client_1.default)({
             config,
@@ -368,12 +379,14 @@ function addDefaultApiEndpoints(app, config) {
          *     tags:
          *       - 'Jobs'
          *     summary: 'Get Job Info'
+         *     description: 'Retrieve detailed information about a specific job including progress, status, and timing data'
          *     operationId: job.info
          *     parameters:
          *       - $ref: '#/components/parameters/ProjectId'
          *       - name: jobId
          *         in: query
          *         required: true
+         *         description: 'Unique identifier of the job. Get via [List Jobs](#operation/job.list)'
          *         schema:
          *           type: string
          *           example: 067da473-fc0b-43e3-b0a2-09d26af130c1
@@ -383,7 +396,19 @@ function addDefaultApiEndpoints(app, config) {
          *         content:
          *           application/json:
          *             schema:
-         *               $ref: '#/components/schemas/JobResponse'
+         *               $ref: '#/components/schemas/JobInfoResponse'
+         *       400:
+         *         description: 'Bad Request - jobId parameter is missing'
+         *         content:
+         *           application/json:
+         *             schema:
+         *               $ref: '#/components/schemas/ErrorResponse'
+         *       404:
+         *         description: 'Job not found'
+         *         content:
+         *           application/json:
+         *             schema:
+         *               $ref: '#/components/schemas/ErrorResponse'
          */
         app.get('/job-info', api_call_1.default, json_response_1.default, (0, crowdin_client_1.default)({
             config,
@@ -429,18 +454,32 @@ function addDefaultApiEndpoints(app, config) {
          *     tags:
          *       - 'Jobs'
          *     summary: 'Cancel Job'
+         *     description: 'Cancel a running job. Only jobs with status "created" or "inProgress" can be canceled'
          *     operationId: job.cancel
          *     parameters:
          *       - $ref: '#/components/parameters/ProjectId'
          *       - name: jobId
          *         in: query
          *         required: true
+         *         description: 'Unique identifier of the job to cancel. Get via [List Jobs](#operation/job.list)'
          *         schema:
          *           type: string
          *           example: 067da473-fc0b-43e3-b0a2-09d26af130c1
          *     responses:
          *       204:
          *         description: 'Job canceled successfully'
+         *       400:
+         *         description: 'Bad Request - jobId parameter is missing'
+         *         content:
+         *           application/json:
+         *             schema:
+         *               $ref: '#/components/schemas/ErrorResponse'
+         *       404:
+         *         description: 'Job not found'
+         *         content:
+         *           application/json:
+         *             schema:
+         *               $ref: '#/components/schemas/ErrorResponse'
          */
         app.delete('/jobs', api_call_1.default, json_response_1.default, (0, crowdin_client_1.default)({
             config,
@@ -460,7 +499,7 @@ function addDefaultApiEndpoints(app, config) {
          *       - $ref: '#/components/parameters/ProjectId'
          *     responses:
          *      200:
-         *        description: 'File translation progress'
+         *        description: 'Application Settings'
          *        content:
          *          application/json:
          *            schema:
@@ -468,7 +507,7 @@ function addDefaultApiEndpoints(app, config) {
          *                data:
          *                  $ref: '#/components/schemas/SettingsResponse'
          */
-        app.get('/settings', api_call_1.default, (0, crowdin_client_1.default)({
+        app.get('/settings', api_call_1.default, json_response_1.default, (0, crowdin_client_1.default)({
             config,
             optional: false,
             checkSubscriptionExpiration: true,
@@ -510,6 +549,7 @@ function addDefaultApiEndpoints(app, config) {
          *       - name: provider
          *         in: query
          *         required: true
+         *         description: 'Data source: "crowdin" for Crowdin file-language pairs, "integration" for integration files with sync schedule'
          *         schema:
          *           type: string
          *           enum:
@@ -638,6 +678,17 @@ function addSwagerApiDocumentation(app, config) {
             servers: [
                 {
                     url: `{protocol}//{host}/api/v2/applications/${config.identifier}/api`,
+                    variables: {
+                        protocol: {
+                            default: 'https',
+                            enum: ['https', 'http'],
+                            description: 'Protocol (https for production)',
+                        },
+                        host: {
+                            default: 'crowdin.com',
+                            description: 'Crowdin host (crowdin.com or {organization}.crowdin.com for Enterprise)',
+                        },
+                    },
                 },
             ],
         },

package/out/modules/api/base.d.ts

@@ -4,4 +4,5 @@
  *   - name: 'Files'
  *   - name: 'Settings'
  *   - name: 'Login'
+ *   - name: 'Jobs'
  */

package/out/modules/api/base.js

@@ -5,4 +5,5 @@
  *   - name: 'Files'
  *   - name: 'Settings'
  *   - name: 'Login'
+ *   - name: 'Jobs'
  */