@crowdin/app-project-module 0.107.0-cf-0 → 0.108.0

package/out/index.d.ts

@@ -4,7 +4,6 @@ import express from './util/terminus-express';
 import { getRequestCredentialsMasker, postRequestCredentialsMasker, maskKey } from './util/credentials-masker';
 export { getRequestCredentialsMasker, postRequestCredentialsMasker, maskKey };
 export { ProjectPermissions, Scope, UserPermissions } from './types';
-export { Cron } from './util/cron';
 export { express };
 export declare const metadataStore: CrowdinMetadataStore;
 export declare function createApp(clientConfig: ClientConfig): void;

package/out/index.js

@@ -50,12 +50,11 @@ const subscription_paid_1 = __importDefault(require("./modules/subscription-paid
 const uninstall_1 = __importDefault(require("./modules/uninstall"));
 const status_1 = __importDefault(require("./modules/status"));
 const storage = __importStar(require("./storage"));
-const d1_1 = require("./storage/d1");
-const cron = __importStar(require("./util/cron"));
 const types_1 = require("./types");
 const util_1 = require("./util");
 const form_schema_1 = require("./util/form-schema");
 const connection_1 = require("./util/connection");
+const handlebars_1 = require("./util/handlebars");
 const logger = __importStar(require("./util/logger"));
 const logger_1 = require("./util/logger");
 const terminus_express_1 = __importDefault(require("./util/terminus-express"));
@@ -64,8 +63,6 @@ const credentials_masker_1 = require("./util/credentials-masker");
 Object.defineProperty(exports, "getRequestCredentialsMasker", { enumerable: true, get: function () { return credentials_masker_1.getRequestCredentialsMasker; } });
 Object.defineProperty(exports, "postRequestCredentialsMasker", { enumerable: true, get: function () { return credentials_masker_1.postRequestCredentialsMasker; } });
 Object.defineProperty(exports, "maskKey", { enumerable: true, get: function () { return credentials_masker_1.maskKey; } });
-const static_files_1 = require("./util/static-files");
-const util_2 = require("./util");
 //apps
 const apiApp = __importStar(require("./modules/api"));
 const contextMenuApp = __importStar(require("./modules/context-menu"));
@@ -143,27 +140,6 @@ function addCrowdinEndpoints(app, clientConfig) {
     }
     storage.initialize(config);
     logger.initialize(config);
-    cron.initialize(config);
-    // Middleware to ensure D1 migration before handling requests
-    app.use((req, res, next) => __awaiter(this, void 0, void 0, function* () {
-        try {
-            const storageInstance = storage.getStorage();
-            if (storageInstance instanceof d1_1.D1Storage) {
-                yield storageInstance.ensureMigrated();
-            }
-            next();
-        }
-        catch (error) {
-            next(error);
-        }
-    }));
-    // Middleware to detect and cache baseUrl from request if not provided
-    app.use((req, res, next) => {
-        if (!config.baseUrl) {
-            config.baseUrl = (0, util_1.extractBaseUrlFromRequest)(req);
-        }
-        next();
-    });
     app.use((req, res, next) => {
         if (config.webhooks && req.path === '/webhooks') {
             return terminus_express_1.default.raw({ type: '*/*', limit: '50mb' })(req, res, next);
@@ -177,8 +153,11 @@ function addCrowdinEndpoints(app, clientConfig) {
         app.use(logsFormatter.contextResolverMiddleware());
         app.use(logsFormatter.expressMiddleware());
     }
-    app.use('/assets', (0, static_files_1.serveStatic)(config, config.assetsPath || 'static'));
-    app.use('/', (0, util_2.serveLogo)(config));
+    app.use('/assets', terminus_express_1.default.static((0, path_1.join)(__dirname, 'static')));
+    app.set('views', (0, path_1.join)(__dirname, 'views'));
+    app.engine('handlebars', handlebars_1.engine);
+    app.set('view engine', 'handlebars');
+    app.get((0, util_1.getLogoUrl)(), (req, res) => res.sendFile(config.imagePath));
     app.get('/manifest.json', json_response_1.default, (0, manifest_1.default)(config));
     app.get('/', (0, about_1.default)(config));
     if (((_a = config === null || config === void 0 ? void 0 : config.enableStatusPage) === null || _a === void 0 ? void 0 : _a.database) || ((_b = config === null || config === void 0 ? void 0 : config.enableStatusPage) === null || _b === void 0 ? void 0 : _b.filesystem)) {
@@ -213,7 +192,7 @@ function addCrowdinEndpoints(app, clientConfig) {
     contextMenuApp.register({ config, app });
     //other apps only work in authorized context
     if (!(0, util_1.isAuthorizedConfig)(config)) {
-        return Object.assign(Object.assign({}, exports.metadataStore), { cron: cron.getCron() });
+        return Object.assign({}, exports.metadataStore);
     }
     app.post('/installed', (0, install_1.default)(config));
     app.post('/uninstall', (0, uninstall_1.default)(config));
@@ -246,7 +225,7 @@ function addCrowdinEndpoints(app, clientConfig) {
     automationAction.register({ config, app });
     authGuard.register({ config, app });
     addFormSchema({ config, app });
-    return Object.assign(Object.assign({}, exports.metadataStore), { storage: storage.getStorage(), cron: cron.getCron(), establishCrowdinConnection: (authRequest, moduleKey) => {
+    return Object.assign(Object.assign({}, exports.metadataStore), { storage: storage.getStorage(), establishCrowdinConnection: (authRequest, moduleKey) => {
             let jwtToken = '';
             if (typeof authRequest === 'string') {
                 jwtToken = authRequest;
@@ -300,6 +279,9 @@ function convertClientConfig(clientConfig) {
     const clientSecret = clientConfig.clientSecret || process.env.CROWDIN_CLIENT_SECRET;
     const port = clientConfig.port || process.env.PORT || 3000;
     const { region = process.env.AWS_REGION || process.env.AWS_DEFAULT_REGION, tmpBucketName = process.env.AWS_TMP_BUCKET_NAME, } = clientConfig.awsConfig || {};
+    if (!baseUrl) {
+        throw new Error('Missing baseUrl parameter');
+    }
     if (clientConfig.authenticationType !== types_1.AuthenticationType.NONE) {
         if (!clientId && !clientSecret) {
             throw new Error('Missing [clientId, clientSecret] parameters');
@@ -309,7 +291,7 @@ function convertClientConfig(clientConfig) {
         clientConfig.api = Object.assign({ default: true }, clientConfig.api);
     }
     clientConfig.enableStatusPage = Object.assign({ database: true, filesystem: true }, (clientConfig.enableStatusPage || {}));
-    return Object.assign(Object.assign({}, clientConfig), { baseUrl: baseUrl ? (baseUrl.endsWith('/') ? baseUrl.slice(0, -1) : baseUrl) : undefined, clientId,
+    return Object.assign(Object.assign({}, clientConfig), { baseUrl: baseUrl.endsWith('/') ? baseUrl.slice(0, -1) : baseUrl, clientId,
         clientSecret, awsConfig: {
             tmpBucketName,
             region,

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

@@ -21,5 +21,5 @@ export default function handle({ config, optional, checkSubscriptionExpiration,
     optional: boolean;
     checkSubscriptionExpiration: boolean;
     moduleKey?: string[] | string | undefined;
-}): (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;
+}): (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 declare function getToken(req: CrowdinClientRequest): string | undefined;

package/out/middlewares/integration-credentials.d.ts

@@ -2,4 +2,4 @@
 import { Response } from 'express';
 import { Config } from '../types';
 import { IntegrationLogic } from '../modules/integration/types';
-export default function handle(config: Config, integration: IntegrationLogic, optional?: boolean): (req: import("express").Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>> | import("../types").CrowdinClientRequest, res: Response<any, Record<string, any>>, next: Function) => void;
+export default function handle(config: Config, integration: IntegrationLogic, optional?: boolean): (req: import("../types").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/middlewares/integration-credentials.js

@@ -37,7 +37,6 @@ const util_1 = require("../util");
 const connection_1 = require("../util/connection");
 const logger_1 = require("../util/logger");
 const crowdinAppFunctions = __importStar(require("@crowdin/crowdin-apps-functions"));
-const views_1 = require("../views");
 function handle(config, integration, optional = false) {
     return (0, util_1.runAsyncWrapper)((req, res, next) => __awaiter(this, void 0, void 0, function* () {
         let clientId = req.crowdinContext.clientId;
@@ -90,9 +89,7 @@ function handle(config, integration, optional = false) {
             else {
                 (0, logger_1.temporaryErrorDebug)('Access denied: integration-credentials', req);
             }
-            const html = (0, util_1.renderJSX)(views_1.ErrorPage, errorOptions);
-            res.setHeader('Content-Type', 'text/html; charset=utf-8');
-            return res.send(html);
+            return res.render('error', errorOptions);
         }
         try {
             req.integrationCredentials = yield (0, connection_1.prepareIntegrationCredentials)(config, integration, integrationCredentials);

package/out/middlewares/render-ui-module.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="qs" />
-import { Request, Response } from 'express';
-import { UiModule, Config, UnauthorizedConfig } from '../types';
-export default function handle(moduleConfig: UiModule, config: Config | UnauthorizedConfig): (req: Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>> | import("../types").CrowdinClientRequest, res: Response<any, Record<string, any>>, next: Function) => void;
+import express from 'express';
+import { UiModule } from '../types';
+export default function handle(moduleConfig: UiModule): (req: import("../types").CrowdinClientRequest | express.Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: express.Response<any, Record<string, any>>, next: Function) => void;

package/out/middlewares/render-ui-module.js

@@ -8,25 +8,29 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+const express_1 = __importDefault(require("express"));
 const util_1 = require("../util");
-const static_files_1 = require("../util/static-files");
-const views_1 = require("../views");
-function handle(moduleConfig, config) {
+function handle(moduleConfig) {
     return (0, util_1.runAsyncWrapper)((req, res, next) => __awaiter(this, void 0, void 0, function* () {
         if (moduleConfig.formSchema) {
-            const html = (0, util_1.renderJSX)(views_1.FormPage, {
-                formGetDataUrl: moduleConfig.formGetDataUrl || `/api/${moduleConfig.key}/form-data`,
-                formPostDataUrl: moduleConfig.formPostDataUrl || `/api/${moduleConfig.key}/form-data`,
+            return res.render('form', {
+                formGetDataUrl: moduleConfig.formGetDataUrl
+                    ? moduleConfig.formGetDataUrl
+                    : `/api/${moduleConfig.key}/form-data`,
+                formPostDataUrl: moduleConfig.formPostDataUrl
+                    ? moduleConfig.formPostDataUrl
+                    : `/api/${moduleConfig.key}/form-data`,
                 formSchema: JSON.stringify(moduleConfig.formSchema),
                 formUiSchema: moduleConfig.formUiSchema ? JSON.stringify(moduleConfig.formUiSchema) : '{}',
                 formPatchDataUrl: moduleConfig.formPatchDataUrl,
             });
-            res.setHeader('Content-Type', 'text/html; charset=utf-8');
-            return res.send(html);
         }
         if (moduleConfig.uiPath) {
-            return (0, static_files_1.serveStatic)(config, moduleConfig.uiPath)(req, res, next);
+            return express_1.default.static(moduleConfig.uiPath)(req, res, next);
         }
         throw new Error('uiPath or formSchema should be provided for module');
     }));

package/out/middlewares/ui-module.d.ts

@@ -5,4 +5,4 @@ export default function handle({ config, allowUnauthorized, moduleType, }: {
     config: Config | UnauthorizedConfig;
     allowUnauthorized?: boolean;
     moduleType?: string | undefined;
-}): (req: Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>> | import("../types").CrowdinClientRequest, res: Response<any, Record<string, any>>, next: Function) => void;
+}): (req: import("../types").CrowdinClientRequest | 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/ui-module.js

@@ -16,15 +16,8 @@ const util_1 = require("../util");
 const connection_1 = require("../util/connection");
 const logger_1 = require("../util/logger");
 const subscription_1 = require("../util/subscription");
-const views_1 = require("../views");
 function handle({ config, allowUnauthorized = false, moduleType, }) {
     return (0, util_1.runAsyncWrapper)((req, res, next) => __awaiter(this, void 0, void 0, function* () {
-        // Allow access to non-HTML files
-        const isHtmlFile = /\.html?$/i.test(req.path);
-        if (!isHtmlFile) {
-            next();
-            return;
-        }
         if (allowUnauthorized) {
             next();
             return;
@@ -67,9 +60,7 @@ function handle({ config, allowUnauthorized = false, moduleType, }) {
                 accountType: credentials.type,
             });
             if (expired) {
-                const html = (0, util_1.renderJSX)(views_1.SubscriptionPage, { subscribeLink });
-                res.setHeader('Content-Type', 'text/html; charset=utf-8');
-                return res.send(html);
+                return res.render('subscription', { subscribeLink });
             }
         }
         next();

package/out/modules/about.d.ts

@@ -5,6 +5,5 @@ export declare function getAboutPageOptions(config: Config | UnauthorizedConfig)
     logo: string;
     manifest: string;
     storeLink: string;
-    showDebugLink: boolean;
 }>;
-export default function handle(config: Config | UnauthorizedConfig): (req: Request, res: Response, next: NextFunction) => Promise<Response<any, Record<string, any>> | undefined>;
+export default function handle(config: Config | UnauthorizedConfig): (req: Request, res: Response, next: NextFunction) => Promise<void>;

package/out/modules/about.js

@@ -16,8 +16,6 @@ exports.getAboutPageOptions = void 0;
 const axios_1 = __importDefault(require("axios"));
 const util_1 = require("../util");
 const crowdin_client_1 = require("../middlewares/crowdin-client");
-const jsx_renderer_1 = require("../util/jsx-renderer");
-const views_1 = require("../views");
 function getAboutPageOptions(config) {
     return __awaiter(this, void 0, void 0, function* () {
         let detailPage = '';
@@ -32,10 +30,9 @@ function getAboutPageOptions(config) {
         }
         return {
             name: config.name,
-            logo: (0, util_1.getLogoUrl)(config),
+            logo: (0, util_1.getLogoUrl)(),
             manifest: config.baseUrl + '/manifest.json',
             storeLink: (config === null || config === void 0 ? void 0 : config.detailPage) || detailPage,
-            showDebugLink: process.env.SHOW_DEBUG_LINK === 'true',
         };
     });
 }
@@ -46,9 +43,7 @@ function handle(config) {
             const jwtToken = (0, crowdin_client_1.getToken)(req);
             if (!jwtToken) {
                 const options = yield getAboutPageOptions(config);
-                const html = (0, jsx_renderer_1.renderJSX)(views_1.AboutPage, options);
-                res.setHeader('Content-Type', 'text/html; charset=utf-8');
-                return res.send(html);
+                return res.render('about', options);
             }
             else {
                 next();
@@ -56,9 +51,7 @@ function handle(config) {
             }
         }
         const options = yield getAboutPageOptions(config);
-        const html = (0, jsx_renderer_1.renderJSX)(views_1.AboutPage, options);
-        res.setHeader('Content-Type', 'text/html; charset=utf-8');
-        return res.send(html);
+        return res.render('about', options);
     });
 }
 exports.default = handle;

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

@@ -2,4 +2,4 @@
 import { Response } from 'express';
 import { CrowdinClientRequest } from '../../../types';
 import { AiPromptProviderModule } from '../types';
-export default function handle(aiPromptProvider: AiPromptProviderModule): (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;
+export default function handle(aiPromptProvider: AiPromptProviderModule): (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-prompt-provider/index.js

@@ -21,8 +21,8 @@ function register({ config, app }) {
         moduleKey: config.aiPromptProvider.key,
     }), (0, compile_1.default)(config.aiPromptProvider));
     if (config.aiPromptProvider.formSchema || config.aiPromptProvider.uiPath) {
-        app.use('/prompt-provider/settings', (0, ui_module_1.default)({ config, allowUnauthorized: true, moduleType: config.aiPromptProvider.key }), (0, render_ui_module_1.default)(config.aiPromptProvider, config));
+        app.use('/prompt-provider/settings', (0, ui_module_1.default)({ config, allowUnauthorized: true, moduleType: config.aiPromptProvider.key }), (0, render_ui_module_1.default)(config.aiPromptProvider));
     }
-    app.use('/logo/ai-prompt-provider', (0, util_1.serveLogo)(config, config.aiPromptProvider));
+    app.get((0, util_1.getLogoUrl)(config.aiPromptProvider, '/ai-prompt-provider'), (req, res) => { var _a; return res.sendFile(((_a = config.aiPromptProvider) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath); });
 }
 exports.register = register;

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

@@ -2,4 +2,4 @@
 import { Response } from 'express';
 import { CrowdinClientRequest } from '../../../types';
 import { AiProviderModule } from '../types';
-export default function handle(aiProvider: AiProviderModule): (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;
+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.d.ts

@@ -3,4 +3,4 @@ import { Response } from 'express';
 import { CrowdinClientRequest } from '../../../types';
 import { AiProviderModule } from '../types';
 export declare const CONTEXT_WINDOW_LIMIT = 4096;
-export default function handle(aiProvider: AiProviderModule): (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;
+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/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, config));
+        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('/logo/aiprovider', (0, util_1.serveLogo)(config, config.aiProvider));
+    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('/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
      */

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: 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;
+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;

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: 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;
+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;

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, config));
+            app.use((0, util_1.getAiToolWidgetUrl)(tool), (0, ui_module_1.default)({ config, moduleType: tool.key }), (0, render_ui_module_1.default)(tool));
         }
         else {
             throw new Error(`The function name '${tool.function.name}' is not unique within aiTools and aiToolsWidget`);

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'
  */