@crowdin/app-project-module 0.54.1 → 0.55.0

package/out/types.d.ts

@@ -13,6 +13,7 @@ import { PostgreStorageConfig } from './storage/postgre';
 import { ApiModule } from './modules/api/types';
 import { LogErrorFunction, LogFunction } from './util/logger';
 import { AiProviderModule } from './modules/ai-provider/types';
+import { AiPromptProviderModule } from './modules/ai-prompt-provider/types';
 export interface ClientConfig extends ImagePath {
     /**
      * Authentication Crowdin App type: "authorization_code", "crowdin_app". Default: "crowdin_app"
@@ -42,6 +43,10 @@ export interface ClientConfig extends ImagePath {
      * define custom Crowdin urls (e.g. to work against local Crowdin server)
      */
     crowdinUrls?: CrowdinUrls;
+    /**
+     * define custom User Agent in requests to Crowdin
+     */
+    crowdinApiUserAgent?: string;
     /**
      * Set of scopes requested by this app (default 'project')
      */
@@ -176,6 +181,10 @@ export interface ClientConfig extends ImagePath {
      * ai provider module
      */
     aiProvider?: AiProviderModule & ImagePath;
+    /**
+     * ai prompt provider module
+     */
+    aiPromptProvider?: AiPromptProviderModule & ImagePath;
 }
 export interface Environments {
     environments?: Environment | Environment[];

package/out/util/connection.js

@@ -1,4 +1,27 @@
 "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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 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) {
@@ -21,10 +44,18 @@ const storage_1 = require("../storage");
 const types_1 = require("../types");
 const axios_2 = require("./axios");
 const logger_1 = require("./logger");
+const os = __importStar(require("os"));
 const axiosCustom = new axios_2.AxiosProvider().axios;
 function prepareCrowdinClient({ config, credentials, autoRenew = false, context, }) {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
+        let userAgent;
+        if (config.crowdinApiUserAgent) {
+            userAgent = config.crowdinApiUserAgent;
+        }
+        else {
+            userAgent = `app/${config.name} node/v${process.versions.node} ${os.type()}/${os.platform()}/${os.release()}`;
+        }
         //2 min as an extra buffer
         const isExpired = +credentials.expire - 120 < Date.now() / 1000;
         const organization = credentials.type === types_1.AccountType.ENTERPRISE ? credentials.id : undefined;
@@ -41,7 +72,7 @@ function prepareCrowdinClient({ config, credentials, autoRenew = false, context,
         }
         if (!autoRenew) {
             return {
-                client: new crowdin_api_client_1.default({ token, organization, baseUrl: (_a = config.crowdinUrls) === null || _a === void 0 ? void 0 : _a.apiUrl }),
+                client: new crowdin_api_client_1.default({ token, organization, baseUrl: (_a = config.crowdinUrls) === null || _a === void 0 ? void 0 : _a.apiUrl }, { userAgent }),
                 token,
             };
         }
@@ -49,7 +80,11 @@ function prepareCrowdinClient({ config, credentials, autoRenew = false, context,
             if (!config) {
                 return;
             }
-            return { headers: Object.assign(Object.assign({}, config.headers), { Authorization: `Bearer ${token}` }) };
+            const headers = Object.assign(Object.assign({}, config.headers), { Authorization: `Bearer ${token}` });
+            if (userAgent) {
+                headers['User-Agent'] = userAgent;
+            }
+            return { headers };
         };
         const renewToken = () => __awaiter(this, void 0, void 0, function* () {
             const res = yield refreshCrowdinCreds({ config, credentials: crowdinCreds });
@@ -173,6 +208,7 @@ function prepareCrowdinClient({ config, credentials, autoRenew = false, context,
                         });
                     },
                 },
+                userAgent,
             }),
             token,
         };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdin/app-project-module",
-  "version": "0.54.1",
+  "version": "0.55.0",
   "description": "Module that generates for you all common endpoints for serving standalone Crowdin App",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -18,10 +18,10 @@
     "out/**/*"
   ],
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.540.0",
-    "@aws-sdk/s3-request-presigner": "^3.484.0",
-    "@crowdin/crowdin-apps-functions": "0.6.0",
-    "@crowdin/logs-formatter": "^2.1.3",
+    "@aws-sdk/client-s3": "^3.598.0",
+    "@aws-sdk/s3-request-presigner": "^3.598.0",
+    "@crowdin/crowdin-apps-functions": "0.7.0",
+    "@crowdin/logs-formatter": "^2.1.4",
     "@godaddy/terminus": "^4.12.1",
     "amqplib": "^0.10.3",
     "crypto-js": "^4.2.0",