@crowdin/app-project-module 2.8.0 → 2.9.1

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

@@ -27,6 +27,10 @@ const getErrorCode = (e) => {
     }
     return undefined;
 };
+const normalizeUsage = (usage) => {
+    const values = Array.isArray(usage) ? usage : Object.values(usage !== null && usage !== void 0 ? usage : {});
+    return values.some(util_1.isDefined) ? usage : undefined;
+};
 function handle(aiProvider) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
         let isStream = false;
@@ -85,8 +89,12 @@ function handle(aiProvider) {
                     res.write(`data: ${JSON.stringify(message)}\n\n`);
                 }),
             });
+            const usage = normalizeUsage(!Array.isArray(result) ? result === null || result === void 0 ? void 0 : result.usage : undefined);
             if (isStream) {
                 startStream();
+                if (usage) {
+                    res.write(`data: ${JSON.stringify({ choices: [], usage })}\n\n`);
+                }
                 res.write('[DONE]');
                 res.end();
                 return;
@@ -110,7 +118,7 @@ function handle(aiProvider) {
                     },
                 }));
             }
-            res.send({ choices, message });
+            res.send({ choices, message, usage });
         }
         catch (e) {
             if (req.logError) {

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

@@ -15,6 +15,7 @@ const util_1 = require("../../../util");
 const logger_1 = require("../../../util/logger");
 const util_2 = require("../util");
 exports.CONTEXT_WINDOW_LIMIT = 4096;
+const sanitizePrice = (price) => typeof price === 'number' && Number.isFinite(price) && price >= 0 ? price : undefined;
 function handle(aiProvider) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
         try {
@@ -33,6 +34,8 @@ function handle(aiProvider) {
                     supportsVision: (_e = model.supportsVision) !== null && _e !== void 0 ? _e : false,
                     contextWindowLimit: (_f = model.contextWindowLimit) !== null && _f !== void 0 ? _f : exports.CONTEXT_WINDOW_LIMIT,
                     outputLimit: (_g = model.outputLimit) !== null && _g !== void 0 ? _g : exports.CONTEXT_WINDOW_LIMIT,
+                    priceInput: sanitizePrice(model.priceInput),
+                    priceOutput: sanitizePrice(model.priceOutput),
                 });
             });
             res.send({ data });

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

@@ -26,6 +26,8 @@ export interface AiProviderModule extends Environments, ModuleKey {
     settingsUiModule?: UiModule;
     /**
      * processes a sequence of conversation messages and generates responses from the assistant
+     *
+     * in stream mode only `usage` is read from the returned result, `data` and `message` are ignored
      */
     chatCompletions: ({ messages, model, action, responseFormat, jsonSchema, client, context, request, isStream, sendEvent, tools, toolChoice, }: {
         messages: ChatCompletionMessage[];
@@ -40,7 +42,7 @@ export interface AiProviderModule extends Environments, ModuleKey {
         sendEvent: (chunk: ChatCompletionChunkMessage) => Promise<void>;
         tools?: ChatCompletionTool[];
         toolChoice?: string | AiToolChoice;
-    }) => Promise<ChatCompletionResponseMessage[] | ExtendedResult<ChatCompletionResponseMessage[]> | void>;
+    }) => Promise<ChatCompletionResponseMessage[] | ChatCompletionResult | void>;
     /**
      * provides a list of available model
      */
@@ -58,6 +60,41 @@ export interface SupportedModels {
     supportsVision?: boolean;
     contextWindowLimit?: number;
     outputLimit?: number;
+    /**
+     * price of the input tokens, USD per 1M tokens, must be >= 0.
+     * a price above 0 makes the provider priceable - its reported costs count toward the organization's AI quota limits
+     */
+    priceInput?: number;
+    /**
+     * price of the output tokens, USD per 1M tokens, must be >= 0
+     */
+    priceOutput?: number;
+}
+export interface ChatCompletionUsage {
+    /**
+     * integer, non-integer values are ignored by Crowdin
+     */
+    prompt_tokens?: number;
+    /**
+     * integer, non-integer values are ignored by Crowdin
+     */
+    completion_tokens?: number;
+    /**
+     * cost in USD, takes precedence over the token count multiplied by the model price
+     */
+    cost?: number;
+}
+export interface ChatCompletionModelUsage extends ChatCompletionUsage {
+    /**
+     * non-empty model id, max 255 characters
+     */
+    model: string;
+}
+export interface ChatCompletionResult extends ExtendedResult<ChatCompletionResponseMessage[]> {
+    /**
+     * flat report when a single model served the request, or a per-model split report
+     */
+    usage?: ChatCompletionUsage | ChatCompletionModelUsage[];
 }
 export interface ChatCompletionTool {
     type: 'function';

package/out/modules/integration/handlers/invite-users.js

@@ -12,17 +12,46 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = handle;
 const util_1 = require("../../../util");
 const storage_1 = require("../../../storage");
+const token_1 = require("../../../util/app-functions/token");
+const users_1 = require("./users");
 function handle() {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        // The middleware resolves clientId to the owner connection, which is the one that
+        // stores the managers list.
         const clientId = req.crowdinContext.clientId;
         const users = req.body.users;
+        const allowSelfRemoval = req.body.allowSelfRemoval === true;
+        const actingUserId = req.crowdinContext.jwtPayload.context.user_id;
+        // Derived from the connection being written, never from a body-supplied project.
+        const projectId = (0, token_1.parseCrowdinId)(clientId).projectId;
         if (!users) {
             return res.send({
                 success: false,
                 message: 'No users provided',
             });
         }
-        yield (0, storage_1.getStorage)().updateIntegrationManagers(clientId, JSON.stringify(users.map((user) => `${user.id}`)));
+        // The UI already hides Share behind the same check; this blocks direct API calls
+        // from users who merely happen to be in the managers list.
+        const canManage = yield (0, users_1.isManager)({
+            client: req.crowdinApiClient,
+            projectId,
+            memberId: actingUserId,
+        }).catch(() => false);
+        if (!canManage) {
+            return res.status(403).send({
+                success: false,
+                message: 'Access denied',
+            });
+        }
+        const managerIds = new Set(users.map((user) => `${user.id}`));
+        // Kept by default, so a list that omits them (failed load, missing from the member
+        // list) can't cost the sharer their own access.
+        if (!allowSelfRemoval) {
+            managerIds.add(`${actingUserId}`);
+        }
+        // The integration owner (installer) can never be removed.
+        managerIds.add(`${(0, token_1.parseCrowdinId)(clientId).userId}`);
+        yield (0, storage_1.getStorage)().updateIntegrationManagers(clientId, JSON.stringify([...managerIds]));
         return res.send({
             success: true,
         });

package/out/modules/integration/handlers/users.js

@@ -13,6 +13,7 @@ exports.default = handle;
 exports.isManager = isManager;
 const util_1 = require("../../../util");
 const storage_1 = require("../../../storage");
+const token_1 = require("../../../util/app-functions/token");
 const MANAGER_ROLES = ['owner', 'manager'];
 function handle() {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
@@ -24,6 +25,8 @@ function handle() {
         res.json({
             data: {
                 managers: integrationManagers,
+                // Exposed so the UI can keep the owner's chip locked.
+                ownerId: `${(0, token_1.parseCrowdinId)(req.crowdinContext.clientId).userId}`,
             },
         });
     }));

package/out/modules/integration/util/cron.js

@@ -27,45 +27,56 @@ const files_1 = require("./files");
 const job_1 = require("./job");
 const snapshot_1 = require("./snapshot");
 const types_2 = require("./types");
+// Maximum number of organizations processed concurrently during a cron run.
+// Keeps DB connection and API usage bounded regardless of how many orgs are registered.
+const CRON_ORG_CONCURRENCY = (0, util_1.getEnvInt)('CRON_ORG_CONCURRENCY', 5);
 function runJob(_a) {
     return __awaiter(this, arguments, void 0, function* ({ config, integration, job, }) {
         (0, logger_1.log)(`Starting cron job with expression [${job.expression}]`);
         const crowdinCredentialsList = yield (0, storage_1.getStorage)().getAllCrowdinCredentials();
-        yield Promise.all(crowdinCredentialsList.map((crowdinCredentials) => __awaiter(this, void 0, void 0, function* () {
-            const { token, client: crowdinClient } = yield (0, connection_1.prepareCrowdinClient)({
-                config,
-                credentials: crowdinCredentials,
-                autoRenew: true,
-            });
-            const { expired } = yield (0, subscription_1.checkSubscription)({
-                config,
-                token,
-                organization: crowdinCredentials.id,
-                accountType: crowdinCredentials.type,
-            });
-            if (expired) {
-                (0, logger_1.log)(`Subscription expired. Skipping job [${job.expression}] for organization ${crowdinCredentials.id}`);
-                return;
-            }
-            const integrationCredentialsList = yield (0, storage_1.getStorage)().getAllIntegrationCredentials(crowdinCredentials.id);
-            const allIntegrationConfigs = yield (0, storage_1.getStorage)().getAllIntegrationConfigs(crowdinCredentials.id);
-            for (const integrationCredentials of integrationCredentialsList) {
-                const integrationConfig = allIntegrationConfigs.find(({ integrationId }) => integrationId === integrationCredentials.id);
-                const projectId = (0, token_1.getProjectId)(integrationCredentials.id);
-                const credentials = yield (0, connection_1.prepareIntegrationCredentials)(config, integration, integrationCredentials);
-                const rootFolder = yield (0, defaults_1.getRootFolder)(config, integration, crowdinClient, projectId);
-                const intConfig = (integrationConfig === null || integrationConfig === void 0 ? void 0 : integrationConfig.config) ? JSON.parse(integrationConfig.config) : undefined;
-                (0, logger_1.log)(`Executing task for cron job with expression [${job.expression}] for project ${projectId}`);
-                yield job.task({
-                    projectId,
-                    client: crowdinClient,
-                    credentials,
-                    rootFolder,
-                    settings: intConfig,
+        for (let i = 0; i < crowdinCredentialsList.length; i += CRON_ORG_CONCURRENCY) {
+            const batch = crowdinCredentialsList.slice(i, i + CRON_ORG_CONCURRENCY);
+            const results = yield Promise.allSettled(batch.map((crowdinCredentials) => __awaiter(this, void 0, void 0, function* () {
+                const { token, client: crowdinClient } = yield (0, connection_1.prepareCrowdinClient)({
+                    config,
+                    credentials: crowdinCredentials,
+                    autoRenew: true,
                 });
-                (0, logger_1.log)(`Task for cron job with expression [${job.expression}] for project ${projectId} completed`);
+                const { expired } = yield (0, subscription_1.checkSubscription)({
+                    config,
+                    token,
+                    organization: crowdinCredentials.id,
+                    accountType: crowdinCredentials.type,
+                });
+                if (expired) {
+                    (0, logger_1.log)(`Subscription expired. Skipping job [${job.expression}] for organization ${crowdinCredentials.id}`);
+                    return;
+                }
+                const integrationCredentialsList = yield (0, storage_1.getStorage)().getAllIntegrationCredentials(crowdinCredentials.id);
+                const allIntegrationConfigs = yield (0, storage_1.getStorage)().getAllIntegrationConfigs(crowdinCredentials.id);
+                for (const integrationCredentials of integrationCredentialsList) {
+                    const integrationConfig = allIntegrationConfigs.find(({ integrationId }) => integrationId === integrationCredentials.id);
+                    const projectId = (0, token_1.getProjectId)(integrationCredentials.id);
+                    const credentials = yield (0, connection_1.prepareIntegrationCredentials)(config, integration, integrationCredentials);
+                    const rootFolder = yield (0, defaults_1.getRootFolder)(config, integration, crowdinClient, projectId);
+                    const intConfig = (integrationConfig === null || integrationConfig === void 0 ? void 0 : integrationConfig.config) ? JSON.parse(integrationConfig.config) : undefined;
+                    (0, logger_1.log)(`Executing task for cron job with expression [${job.expression}] for project ${projectId}`);
+                    yield job.task({
+                        projectId,
+                        client: crowdinClient,
+                        credentials,
+                        rootFolder,
+                        settings: intConfig,
+                    });
+                    (0, logger_1.log)(`Task for cron job with expression [${job.expression}] for project ${projectId} completed`);
+                }
+            })));
+            for (const result of results) {
+                if (result.status === 'rejected') {
+                    (0, logger_1.logError)(result.reason);
+                }
             }
-        })));
+        }
         (0, logger_1.log)(`Cron job with expression [${job.expression}] completed`);
     });
 }

package/out/modules/integration/util/job.js

@@ -14,6 +14,7 @@ exports.reRunInProgressJobs = reRunInProgressJobs;
 const storage_1 = require("../../../storage");
 const token_1 = require("../../../util/app-functions/token");
 const connection_1 = require("../../../util/connection");
+const util_1 = require("../../../util");
 const logger_1 = require("../../../util/logger");
 const cron_1 = require("./cron");
 const defaults_1 = require("./defaults");
@@ -27,6 +28,8 @@ const blockingJobs = {
     [types_1.JobType.INTEGRATION_SETTINGS_SAVE]: [types_1.JobType.INTEGRATION_SETTINGS_SAVE],
 };
 const maxAttempts = 3;
+// Maximum number of in-progress jobs retried concurrently on startup.
+const RERUN_JOB_CONCURRENCY = (0, util_1.getEnvInt)('RERUN_JOB_CONCURRENCY', 5);
 const store = {};
 function runAsJob(_a) {
     return __awaiter(this, arguments, void 0, function* ({ integrationId, crowdinId, type, title, payload, res, projectId, client, jobType, jobStoreType, responseData, jobCallback, onError, reRunJobId, forcePushTranslations, initiatedBy, }) {
@@ -219,74 +222,82 @@ function reRunInProgressJobs(config) {
         if (!(inProgressJobs === null || inProgressJobs === void 0 ? void 0 : inProgressJobs.length)) {
             return;
         }
-        yield Promise.all(inProgressJobs.map((activeJob) => __awaiter(this, void 0, void 0, function* () {
-            if (activeJob && ![types_1.JobStatus.IN_PROGRESS, types_1.JobStatus.CREATED].includes(activeJob.status)) {
-                return;
-            }
-            if (activeJob.attempt && activeJob.attempt >= maxAttempts) {
-                yield storage.updateJob({ id: activeJob.id, status: types_1.JobStatus.FAILED });
-                return;
-            }
-            const { integrationId, crowdinId, type, title, payload } = activeJob;
-            const integration = config.projectIntegration;
-            let crowdinClient;
-            const integrationCredentials = yield (0, storage_1.getStorage)().getIntegrationCredentials(integrationId);
-            const crowdinCredentials = yield (0, storage_1.getStorage)().getCrowdinCredentials(crowdinId);
-            const integrationConfig = yield (0, storage_1.getStorage)().getIntegrationConfig(integrationId);
-            if (!integrationCredentials || !crowdinCredentials) {
-                return;
-            }
-            const projectId = (0, token_1.getProjectId)(integrationCredentials.id);
-            const context = {
-                jwtPayload: {
-                    context: {
-                        project_id: projectId,
-                        organization_id: crowdinCredentials.organizationId,
-                        organization_domain: crowdinCredentials.domain,
-                        user_id: crowdinCredentials.userId,
+        for (let i = 0; i < inProgressJobs.length; i += RERUN_JOB_CONCURRENCY) {
+            const batch = inProgressJobs.slice(i, i + RERUN_JOB_CONCURRENCY);
+            const results = yield Promise.allSettled(batch.map((activeJob) => __awaiter(this, void 0, void 0, function* () {
+                if (activeJob && ![types_1.JobStatus.IN_PROGRESS, types_1.JobStatus.CREATED].includes(activeJob.status)) {
+                    return;
+                }
+                if (activeJob.attempt && activeJob.attempt >= maxAttempts) {
+                    yield storage.updateJob({ id: activeJob.id, status: types_1.JobStatus.FAILED });
+                    return;
+                }
+                const { integrationId, crowdinId, type, title, payload } = activeJob;
+                const integration = config.projectIntegration;
+                let crowdinClient;
+                const integrationCredentials = yield (0, storage_1.getStorage)().getIntegrationCredentials(integrationId);
+                const crowdinCredentials = yield (0, storage_1.getStorage)().getCrowdinCredentials(crowdinId);
+                const integrationConfig = yield (0, storage_1.getStorage)().getIntegrationConfig(integrationId);
+                if (!integrationCredentials || !crowdinCredentials) {
+                    return;
+                }
+                const projectId = (0, token_1.getProjectId)(integrationCredentials.id);
+                const context = {
+                    jwtPayload: {
+                        context: {
+                            project_id: projectId,
+                            organization_id: crowdinCredentials.organizationId,
+                            organization_domain: crowdinCredentials.domain,
+                            user_id: crowdinCredentials.userId,
+                        },
                     },
-                },
-            };
-            try {
-                const preparedCrowdinClient = yield (0, connection_1.prepareCrowdinClient)({
-                    config,
-                    credentials: crowdinCredentials,
-                    autoRenew: true,
-                    context,
-                });
-                crowdinClient = preparedCrowdinClient.client;
-            }
-            catch (e) {
-                (0, logger_1.logError)(e);
-                return;
-            }
-            const rootFolder = yield (0, defaults_1.getRootFolder)(config, integration, crowdinClient, projectId);
-            const credentials = yield (0, connection_1.prepareIntegrationCredentials)(config, integration, integrationCredentials);
-            const intConfig = (integrationConfig === null || integrationConfig === void 0 ? void 0 : integrationConfig.config)
-                ? JSON.parse(integrationConfig.config)
-                : { schedule: '0', condition: '0' };
-            yield storage.updateJob({ attempt: +(activeJob.attempt || 0) + 1, id: activeJob.id });
-            if ([types_1.JobType.UPDATE_TO_CROWDIN, types_1.JobType.UPDATE_TO_INTEGRATION].includes(type)) {
-                yield (0, cron_1.runUpdateProviderJob)({
-                    integrationId,
-                    crowdinId,
-                    type,
-                    title,
-                    payload: JSON.parse(payload),
-                    jobType: types_1.JobClientType.RERUN,
-                    projectId,
-                    client: crowdinClient,
-                    integration,
-                    context,
-                    credentials,
-                    rootFolder,
-                    settings: intConfig,
-                    reRunJobId: activeJob.id,
-                });
-            }
-            else if ([types_1.JobType.CROWDIN_SYNC_SETTINGS_SAVE, types_1.JobType.INTEGRATION_SYNC_SETTINGS_SAVE].includes(type)) {
-                yield storage.updateJob({ status: types_1.JobStatus.CANCELED, id: activeJob.id });
+                };
+                try {
+                    const preparedCrowdinClient = yield (0, connection_1.prepareCrowdinClient)({
+                        config,
+                        credentials: crowdinCredentials,
+                        autoRenew: true,
+                        context,
+                    });
+                    crowdinClient = preparedCrowdinClient.client;
+                }
+                catch (e) {
+                    (0, logger_1.logError)(e);
+                    return;
+                }
+                const rootFolder = yield (0, defaults_1.getRootFolder)(config, integration, crowdinClient, projectId);
+                const credentials = yield (0, connection_1.prepareIntegrationCredentials)(config, integration, integrationCredentials);
+                const intConfig = (integrationConfig === null || integrationConfig === void 0 ? void 0 : integrationConfig.config)
+                    ? JSON.parse(integrationConfig.config)
+                    : { schedule: '0', condition: '0' };
+                yield storage.updateJob({ attempt: +(activeJob.attempt || 0) + 1, id: activeJob.id });
+                if ([types_1.JobType.UPDATE_TO_CROWDIN, types_1.JobType.UPDATE_TO_INTEGRATION].includes(type)) {
+                    yield (0, cron_1.runUpdateProviderJob)({
+                        integrationId,
+                        crowdinId,
+                        type,
+                        title,
+                        payload: JSON.parse(payload),
+                        jobType: types_1.JobClientType.RERUN,
+                        projectId,
+                        client: crowdinClient,
+                        integration,
+                        context,
+                        credentials,
+                        rootFolder,
+                        settings: intConfig,
+                        reRunJobId: activeJob.id,
+                    });
+                }
+                else if ([types_1.JobType.CROWDIN_SYNC_SETTINGS_SAVE, types_1.JobType.INTEGRATION_SYNC_SETTINGS_SAVE].includes(type)) {
+                    yield storage.updateJob({ status: types_1.JobStatus.CANCELED, id: activeJob.id });
+                }
+            })));
+            for (const result of results) {
+                if (result.status === 'rejected') {
+                    (0, logger_1.logError)(result.reason);
+                }
             }
-        })));
+        }
     });
 }