@crowdin/app-project-module 1.12.0 → 1.13.1

package/out/index.d.ts

@@ -3,7 +3,7 @@ import { ClientConfig, Config, CrowdinAppUtilities, CrowdinMetadataStore } from
 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 * from './types';
 export { Cron } from './util/cron';
 export { express };
 export declare const metadataStore: CrowdinMetadataStore;

package/out/index.js

@@ -32,6 +32,9 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 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) {
@@ -45,7 +48,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.metadataStore = exports.express = exports.UserPermissions = exports.Scope = exports.ProjectPermissions = exports.maskKey = exports.postRequestCredentialsMasker = exports.getRequestCredentialsMasker = void 0;
+exports.metadataStore = exports.express = exports.maskKey = exports.postRequestCredentialsMasker = exports.getRequestCredentialsMasker = void 0;
 exports.createApp = createApp;
 exports.addCrowdinEndpoints = addCrowdinEndpoints;
 const logsFormatter = __importStar(require("@crowdin/logs-formatter"));
@@ -106,10 +109,7 @@ const aiRequestProcessors = __importStar(require("./modules/ai-request-processor
 const automationAction = __importStar(require("./modules/automation-action"));
 const authGuard = __importStar(require("./modules/auth-guard"));
 const subscription_1 = require("./util/subscription");
-var types_2 = require("./types");
-Object.defineProperty(exports, "ProjectPermissions", { enumerable: true, get: function () { return types_2.ProjectPermissions; } });
-Object.defineProperty(exports, "Scope", { enumerable: true, get: function () { return types_2.Scope; } });
-Object.defineProperty(exports, "UserPermissions", { enumerable: true, get: function () { return types_2.UserPermissions; } });
+__exportStar(require("./types"), exports);
 exports.metadataStore = {
     getMetadata: (id) => {
         return storage.getStorage().getMetadata(id);

package/out/middlewares/export.d.ts

@@ -0,0 +1,2 @@
+export { getToken } from './crowdin-client';
+export * as jsonResponse from './json-response';

package/out/middlewares/export.js

@@ -0,0 +1,39 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsonResponse = exports.getToken = void 0;
+var crowdin_client_1 = require("./crowdin-client");
+Object.defineProperty(exports, "getToken", { enumerable: true, get: function () { return crowdin_client_1.getToken; } });
+exports.jsonResponse = __importStar(require("./json-response"));

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

@@ -35,7 +35,10 @@ function handle(aiProvider) {
             let message;
             let data;
             const chunks = [];
-            const { crowdinApiClient: client, crowdinContext: context, body: { messages, model, action, stream, tools, tool_choice: toolChoice, responseFormat: { type: responseFormatType } = { type: undefined }, }, } = req;
+            const { crowdinApiClient: client, crowdinContext: context, body: { messages, model, action, stream, tools, tool_choice: toolChoice, responseFormat: { type: responseFormatType, json_schema: jsonSchema } = {
+                type: undefined,
+                json_schema: undefined,
+            }, }, } = req;
             isStream = !!stream;
             const startStream = () => {
                 if (!res.headersSent) {
@@ -52,6 +55,7 @@ function handle(aiProvider) {
                 model,
                 action,
                 responseFormat: responseFormatType,
+                jsonSchema,
                 client,
                 context,
                 request: req,

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

@@ -23,15 +23,16 @@ function handle(aiProvider) {
                 context: req.crowdinContext,
             });
             const data = modelList.map((model) => {
-                var _a, _b, _c, _d, _e, _f;
+                var _a, _b, _c, _d, _e, _f, _g;
                 return ({
                     id: model.id,
                     supportsJsonMode: (_a = model.supportsJsonMode) !== null && _a !== void 0 ? _a : false,
-                    supportsFunctionCalling: (_b = model.supportsFunctionCalling) !== null && _b !== void 0 ? _b : false,
-                    supportsStreaming: (_c = model.supportsStreaming) !== null && _c !== void 0 ? _c : false,
-                    supportsVision: (_d = model.supportsVision) !== null && _d !== void 0 ? _d : false,
-                    contextWindowLimit: (_e = model.contextWindowLimit) !== null && _e !== void 0 ? _e : exports.CONTEXT_WINDOW_LIMIT,
-                    outputLimit: (_f = model.outputLimit) !== null && _f !== void 0 ? _f : exports.CONTEXT_WINDOW_LIMIT,
+                    supportsJsonSchema: (_b = model.supportsJsonSchema) !== null && _b !== void 0 ? _b : false,
+                    supportsFunctionCalling: (_c = model.supportsFunctionCalling) !== null && _c !== void 0 ? _c : false,
+                    supportsStreaming: (_d = model.supportsStreaming) !== null && _d !== void 0 ? _d : false,
+                    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,
                 });
             });
             res.send({ data });

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

@@ -17,11 +17,12 @@ 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, request, isStream, sendEvent, tools, toolChoice, }: {
+    chatCompletions: ({ messages, model, action, responseFormat, jsonSchema, client, context, request, isStream, sendEvent, tools, toolChoice, }: {
         messages: ChatCompletionMessage[];
         model: string;
         action: string;
-        responseFormat: string;
+        responseFormat?: ChatCompletionResponseFormat;
+        jsonSchema?: ChatCompletionJsonSchema;
         client: Crowdin;
         context: CrowdinContextInfo;
         request: CrowdinClientRequest;
@@ -41,6 +42,7 @@ export interface AiProviderModule extends Environments, ModuleKey {
 export interface SupportedModels {
     id: string;
     supportsJsonMode?: boolean;
+    supportsJsonSchema?: boolean;
     supportsFunctionCalling?: boolean;
     supportsStreaming?: boolean;
     supportsVision?: boolean;
@@ -64,7 +66,7 @@ export interface ChatCompletionToolFunctionDeclaration {
      * The parameters the functions accepts, described as a JSON Schema object.
      * https://json-schema.org/understanding-json-schema/
      */
-    parameters?: object;
+    parameters?: Record<string, unknown>;
 }
 export interface AiToolChoice {
     type: 'function';
@@ -75,6 +77,26 @@ export interface AiToolChoice {
         name: string;
     };
 }
+export interface ChatCompletionJsonSchema {
+    /**
+     * The name of the response format.
+     */
+    name: string;
+    /**
+     * A description of what the response format is for, used by the model to determine how to respond in the format.
+     */
+    description?: string;
+    /**
+     * The schema for the response format, described as a JSON Schema object.
+     * https://json-schema.org/understanding-json-schema/
+     */
+    schema: Record<string, unknown>;
+    /**
+     * Whether to enable strict schema adherence when generating the output.
+     */
+    strict?: boolean;
+}
+export type ChatCompletionResponseFormat = 'text' | 'json_object' | 'json_schema';
 export type ChatCompletionMessage = ChatCompletionSystemMessage | ChatCompletionUserMessage | ChatCompletionAssistantMessage | ChatCompletionToolMessage;
 export interface ChatCompletionSystemMessage {
     role: 'system';

package/out/modules/integration/handlers/integration-data.d.ts

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

package/out/modules/integration/handlers/invite-users.d.ts

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

package/out/modules/integration/handlers/job-cancel.d.ts

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

package/out/modules/integration/handlers/job-info.d.ts

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

package/out/modules/integration/handlers/job-list.d.ts

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

package/out/modules/integration/handlers/settings-schema.d.ts

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

package/out/modules/integration/handlers/settings.d.ts

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

package/out/modules/integration/handlers/sync-settings.d.ts

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

package/out/modules/integration/handlers/user-errors.d.ts

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

package/out/modules/integration/handlers/users.d.ts

@@ -1,7 +1,7 @@
 import Crowdin, { UsersModel } from '@crowdin/crowdin-api-client';
 import { Response } from 'express';
 export type ProjectMember = UsersModel.ProjectMember | UsersModel.EnterpriseProjectMember;
-export default function handle(): (req: import("express").Request | import("../../../types").CrowdinClientRequest, res: Response, next: Function) => void;
+export default function handle(): (req: import("express").Request | import("../../..").CrowdinClientRequest, res: Response, next: Function) => void;
 export declare function isManager({ client, projectId, memberId, }: {
     client: Crowdin;
     projectId: number;

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

@@ -306,6 +306,7 @@ function processSyncSettings(_a) {
                     onlyApproved,
                     onlyTranslated,
                     context,
+                    integration,
                 });
                 filesToProcess = result.filteredFiles;
                 deletedFileIds = result.deletedFiles;
@@ -494,22 +495,36 @@ function getNewFoldersFile(folders, snapshotFiles) {
     return files;
 }
 function getOnlyTranslatedOrApprovedFiles(_a) {
-    return __awaiter(this, arguments, void 0, function* ({ projectId, crowdinFiles, crowdinClient, onlyApproved, onlyTranslated, context, }) {
+    return __awaiter(this, arguments, void 0, function* ({ projectId, crowdinFiles, crowdinClient, onlyApproved, onlyTranslated, context, integration, }) {
         const deletedFiles = [];
         (0, logger_1.log)(`Filtering files to process only ${onlyApproved ? 'approved' : 'translated'} files`);
         const filesInfo = yield Promise.all(Object.keys(crowdinFiles).map((fileId) => __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e;
             try {
-                const res = yield crowdinClient.translationStatusApi
-                    .withFetchAll()
-                    .getFileProgress(projectId, Number(fileId));
+                let info;
+                if (integration.getFileProgress) {
+                    const progress = yield integration.getFileProgress({
+                        projectId,
+                        client: crowdinClient,
+                        fileId: Number(fileId),
+                    });
+                    info = (_b = (_a = progress[Number(fileId)]) !== null && _a !== void 0 ? _a : progress[fileId]) !== null && _b !== void 0 ? _b : [];
+                }
+                else {
+                    const res = yield crowdinClient.translationStatusApi
+                        .withFetchAll()
+                        .getFileProgress(projectId, Number(fileId));
+                    info = res.data.map((e) => e.data);
+                }
                 return {
                     id: fileId,
-                    info: res.data.map((e) => e.data),
+                    info,
                 };
             }
             catch (e) {
                 delete crowdinFiles[fileId];
-                if ((e === null || e === void 0 ? void 0 : e.status) === 404 || (e === null || e === void 0 ? void 0 : e.code) === 404) {
+                const status = (_e = (_d = (_c = e === null || e === void 0 ? void 0 : e.response) === null || _c === void 0 ? void 0 : _c.status) !== null && _d !== void 0 ? _d : e === null || e === void 0 ? void 0 : e.status) !== null && _e !== void 0 ? _e : e === null || e === void 0 ? void 0 : e.code;
+                if (status === 404) {
                     (0, logger_1.log)(`File ${fileId} not found in Crowdin (404), marking for removal from sync settings`);
                     deletedFiles.push(Number(fileId));
                 }

package/out/modules/integration/util/export.d.ts

@@ -0,0 +1,3 @@
+export * from './types';
+export * from './cron';
+export * from './defaults';

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

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);
+__exportStar(require("./cron"), exports);
+__exportStar(require("./defaults"), exports);

package/out/modules/subscription-paid.d.ts

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

package/out/storage/export.d.ts

@@ -0,0 +1 @@
+export { Storage } from './';

package/out/storage/export.js

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

package/out/util/export.d.ts

@@ -0,0 +1,4 @@
+export { prepareCrowdinClient } from './connection';
+export { isAppFree } from './subscription';
+export { CodeError, extractBaseUrlFromRequest, encryptData, decryptData, executeWithRetry } from './';
+export * as logger from './logger';

package/out/util/export.js

@@ -0,0 +1,47 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = exports.executeWithRetry = exports.decryptData = exports.encryptData = exports.extractBaseUrlFromRequest = exports.CodeError = exports.isAppFree = exports.prepareCrowdinClient = void 0;
+var connection_1 = require("./connection");
+Object.defineProperty(exports, "prepareCrowdinClient", { enumerable: true, get: function () { return connection_1.prepareCrowdinClient; } });
+var subscription_1 = require("./subscription");
+Object.defineProperty(exports, "isAppFree", { enumerable: true, get: function () { return subscription_1.isAppFree; } });
+var _1 = require("./");
+Object.defineProperty(exports, "CodeError", { enumerable: true, get: function () { return _1.CodeError; } });
+Object.defineProperty(exports, "extractBaseUrlFromRequest", { enumerable: true, get: function () { return _1.extractBaseUrlFromRequest; } });
+Object.defineProperty(exports, "encryptData", { enumerable: true, get: function () { return _1.encryptData; } });
+Object.defineProperty(exports, "decryptData", { enumerable: true, get: function () { return _1.decryptData; } });
+Object.defineProperty(exports, "executeWithRetry", { enumerable: true, get: function () { return _1.executeWithRetry; } });
+exports.logger = __importStar(require("./logger"));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdin/app-project-module",
-  "version": "1.12.0",
+  "version": "1.13.1",
   "description": "Module that generates for you all common endpoints for serving standalone Crowdin App",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -24,6 +24,26 @@
       "require": "./out/modules/*/types.js",
       "import": "./out/modules/*/types.js",
       "types": "./out/modules/*/types.d.ts"
+    },
+    "./storage": {
+      "require": "./out/storage/export.js",
+      "import": "./out/storage/export.js",
+      "types": "./out/storage/export.d.ts"
+    },
+    "./util": {
+      "require": "./out/util/export.js",
+      "import": "./out/util/export.js",
+      "types": "./out/util/export.d.ts"
+    },
+    "./middlewares": {
+      "require": "./out/middlewares/export.js",
+      "import": "./out/middlewares/export.js",
+      "types": "./out/middlewares/export.d.ts"
+    },
+    "./modules/integration/util": {
+      "require": "./out/modules/integration/util/export.js",
+      "import": "./out/modules/integration/util/export.js",
+      "types": "./out/modules/integration/util/export.d.ts"
     }
   },
   "scripts": {