@crowdin/app-project-module 2.9.1 → 2.10.0

package/out/util/cron.d.ts

@@ -12,8 +12,6 @@ export interface Cron {
  */
 export declare class NodeCron implements Cron {
     private cron;
-    private pendingSchedules;
-    private initialized;
     constructor();
     schedule(expression: string, task: () => Promise<void>): void;
 }

package/out/util/cron.js

@@ -1,72 +1,25 @@
 "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.NodeCron = void 0;
 exports.initialize = initialize;
 exports.getCron = getCron;
+const logs_formatter_1 = require("@crowdin/logs-formatter");
 const logger_1 = require("./logger");
 /**
  * Default Node.js cron handler that uses node-cron
  */
 class NodeCron {
     constructor() {
-        this.pendingSchedules = [];
-        this.initialized = false;
-        // Dynamically import node-cron
-        Promise.resolve().then(() => __importStar(require('node-cron'))).then((nodeCron) => {
+        try {
+            const nodeCron = require('node-cron');
             this.cron = nodeCron.default || nodeCron;
-            this.initialized = true;
-            // Schedule all pending tasks
-            this.pendingSchedules.forEach(({ expression, task }) => {
-                this.cron.schedule(expression, task);
-            });
-            this.pendingSchedules = [];
-        })
-            .catch((error) => {
-            console.error('Failed to load node-cron:', error);
+        }
+        catch (error) {
             throw new Error('node-cron is required for the default cron. Please install it or provide a custom cron in config.');
-        });
+        }
     }
     schedule(expression, task) {
-        if (this.initialized && this.cron) {
-            this.cron.schedule(expression, task);
-        }
-        else {
-            // Queue the task until node-cron is loaded
-            this.pendingSchedules.push({ expression, task });
-        }
+        this.cron.schedule(expression, task);
     }
 }
 exports.NodeCron = NodeCron;
@@ -78,13 +31,22 @@ let cron;
 function initialize(config) {
     if (config.cron) {
         (0, logger_1.log)('Using custom cron implementation');
-        cron = config.cron;
+        cron = withContextScope(config.cron);
     }
     else {
         (0, logger_1.log)('Using default NodeCron implementation');
-        cron = new NodeCron();
+        cron = withContextScope(new NodeCron());
     }
 }
+/**
+ * Gives every scheduled run its own log context scope, isolating it from requests and other runs.
+ * A run that itself fans out across tenants opens per-branch scopes with `runWithContext`.
+ */
+function withContextScope(cron) {
+    return {
+        schedule: (expression, task) => cron.schedule(expression, () => (0, logs_formatter_1.runWithContext)({}, task)),
+    };
+}
 /**
  * Get the initialized cron instance
  * @returns The cron instance

package/out/util/logger.d.ts

@@ -1,5 +1,6 @@
 import { AxiosError } from 'axios';
-import { Config, CrowdinClientRequest, CrowdinContextInfo, UnauthorizedConfig } from '../types';
+import { Context } from '@crowdin/logs-formatter';
+import { Config, CrowdinClientRequest, CrowdinContextInfo, CrowdinCredentials, UnauthorizedConfig } from '../types';
 import { IntegrationRequest } from '../modules/integration/types';
 import { Request } from 'express';
 export type LogFunction = (message: string) => void;
@@ -11,6 +12,27 @@ export type LogContext = {
 };
 export declare function initialize(config: Config | UnauthorizedConfig): void;
 export declare function prepareContext(context: CrowdinContextInfo): LogContext;
+/**
+ * Maps a framework object to the log context the formatter's record schema expects.
+ * A field the source has no value for is omitted, not `''` - the record would emit `''` verbatim.
+ * `appIdentifier` is not mapped: it is set once at startup via the formatter's `setup()`.
+ * @param source - A `CrowdinContextInfo` yields the full tenant. `CrowdinCredentials` carry no
+ * project, so that source yields the organization-level tenant - the shape the record's
+ * organization/user fallbacks read.
+ * @returns The mapped context. The `Context` return type is load-bearing: the formatter's
+ * `setContext()` takes `any` and drops a wrong shape silently.
+ */
+export declare function logContext(source: CrowdinContextInfo): Context;
+export declare function logContext(source: CrowdinCredentials): Context;
+/**
+ * Stamps the active scope's log context with the tenant of a Crowdin context - the one place a
+ * Crowdin context reaches the formatter. Guarded, so a disabled formatter is never touched (its
+ * out-of-scope warning included). Outside any scope the formatter ignores the write and warns once
+ * per call site; open one first with `runWithContext` when the work is not a request.
+ * @param context - The Crowdin context of the unit of work being logged.
+ * @returns The mapped log context, for callers that carry it onward.
+ */
+export declare function setLogCrowdinContext(context: CrowdinContextInfo): Context;
 export declare function withContext(context: CrowdinContextInfo): LogFunction;
 export declare function withContextError(context: CrowdinContextInfo): LogFunction;
 export declare function log(message: string, context?: CrowdinContextInfo): void;

package/out/util/logger.js

@@ -45,6 +45,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AppModuleAggregateError = exports.AppUserModuleError = exports.AppModuleError = void 0;
 exports.initialize = initialize;
 exports.prepareContext = prepareContext;
+exports.logContext = logContext;
+exports.setLogCrowdinContext = setLogCrowdinContext;
 exports.withContext = withContext;
 exports.withContextError = withContextError;
 exports.log = log;
@@ -58,9 +60,11 @@ const logsFormatter = __importStar(require("@crowdin/logs-formatter"));
 const storage_1 = require("../storage");
 let logConfig;
 let onError;
+let formatterDisabled = false;
 function initialize(config) {
     logConfig = config.logger;
     onError = config.onError;
+    formatterDisabled = Boolean(config.disableLogsFormatter);
 }
 function prepareContext(context) {
     return {
@@ -69,6 +73,36 @@ function prepareContext(context) {
         projectId: context.jwtPayload.context.project_id,
     };
 }
+function logContext(source) {
+    if (!('jwtPayload' in source)) {
+        return {
+            organization: Object.assign({ id: source.organizationId }, (source.domain && { domain: source.domain })),
+            user: { id: source.userId },
+        };
+    }
+    const payload = source.jwtPayload.context;
+    return {
+        project: Object.assign(Object.assign({ id: payload.project_id }, (payload.project_identifier && { identifier: payload.project_identifier })), { organization_id: payload.organization_id, user_id: payload.user_id }),
+        user: Object.assign({ id: payload.user_id }, (payload.user_login && { login: payload.user_login })),
+        // the cast: the formatter's type insists on `domain`, and an absent one must stay absent
+        organization: Object.assign({ id: payload.organization_id }, (payload.organization_domain && { domain: payload.organization_domain })),
+    };
+}
+/**
+ * Stamps the active scope's log context with the tenant of a Crowdin context - the one place a
+ * Crowdin context reaches the formatter. Guarded, so a disabled formatter is never touched (its
+ * out-of-scope warning included). Outside any scope the formatter ignores the write and warns once
+ * per call site; open one first with `runWithContext` when the work is not a request.
+ * @param context - The Crowdin context of the unit of work being logged.
+ * @returns The mapped log context, for callers that carry it onward.
+ */
+function setLogCrowdinContext(context) {
+    const mapped = logContext(context);
+    if (!formatterDisabled) {
+        logsFormatter.setContext(mapped);
+    }
+    return mapped;
+}
 function withContext(context) {
     return (message) => log(message, context);
 }
@@ -76,7 +110,6 @@ function withContextError(context) {
     return (e) => logError(e, context);
 }
 function log(message, context) {
-    var _a, _b, _c;
     if (logConfig === null || logConfig === void 0 ? void 0 : logConfig.enabled) {
         if (logConfig.log) {
             logConfig.log({ message, context });
@@ -84,24 +117,7 @@ function log(message, context) {
         else {
             let prefix = `[${new Date().toISOString()}]`;
             if (context) {
-                logsFormatter.resetContext();
-                logsFormatter.setContext({
-                    appIdentifier: context.appIdentifier || '',
-                    project: {
-                        id: context.jwtPayload.context.project_id,
-                        identifier: (_a = context.jwtPayload.context.project_identifier) !== null && _a !== void 0 ? _a : '',
-                        organization_id: context.jwtPayload.context.organization_id,
-                        user_id: context.jwtPayload.context.user_id,
-                    },
-                    user: {
-                        id: context.jwtPayload.context.user_id,
-                        login: (_b = context.jwtPayload.context.user_login) !== null && _b !== void 0 ? _b : '',
-                    },
-                    organization: {
-                        id: context.jwtPayload.context.organization_id,
-                        domain: (_c = context.jwtPayload.context.organization_domain) !== null && _c !== void 0 ? _c : '',
-                    },
-                });
+                setLogCrowdinContext(context);
                 prefix += ` Context [${JSON.stringify(prepareContext(context))}]`;
             }
             // eslint-disable-next-line no-console
@@ -110,30 +126,12 @@ function log(message, context) {
     }
 }
 function logError(e, context) {
-    var _a, _b, _c;
     if (onError) {
         onError({ error: e, context });
     }
     else {
         if (context) {
-            logsFormatter.resetContext();
-            logsFormatter.setContext({
-                appIdentifier: context.appIdentifier || '',
-                project: {
-                    id: context.jwtPayload.context.project_id,
-                    identifier: (_a = context.jwtPayload.context.project_identifier) !== null && _a !== void 0 ? _a : '',
-                    organization_id: context.jwtPayload.context.organization_id,
-                    user_id: context.jwtPayload.context.user_id,
-                },
-                user: {
-                    id: context.jwtPayload.context.user_id,
-                    login: (_b = context.jwtPayload.context.user_login) !== null && _b !== void 0 ? _b : '',
-                },
-                organization: {
-                    id: context.jwtPayload.context.organization_id,
-                    domain: (_c = context.jwtPayload.context.organization_domain) !== null && _c !== void 0 ? _c : '',
-                },
-            });
+            setLogCrowdinContext(context);
         }
         if (e instanceof AppModuleAggregateError) {
             if (e.errors && e.errors.length > 0) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdin/app-project-module",
-  "version": "2.9.1",
+  "version": "2.10.0",
   "description": "Module that generates for you all common endpoints for serving standalone Crowdin App",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -38,12 +38,12 @@
   },
   "scripts": {
     "sandbox": "vite --config sandbox/vite.config.ts",
-    "build": "npm run build-css && npm run build-main && npm run build-ui",
+    "build": "pnpm run build-css && pnpm run build-main && pnpm run build-ui",
     "build-css": "tailwindcss -i ./ui/styles/tailwind.css -o ./static/css/styles.css --minify",
-    "build-main": "tsc -p ./ && cp -R static out && cp logo.png out && npm run copy-migrations",
+    "build-main": "tsc -p ./ && cp -R static out && cp logo.png out && pnpm run copy-migrations",
     "build-ui": "rollup -c rollup-ui.config.mjs",
     "watch-main": "tsc --watch -p ./ && cp -R static out && cp logo.png out",
-    "format": "npm run prettier && npm run lint",
+    "format": "pnpm run prettier && pnpm run lint",
     "lint": "eslint --fix \"{src,tests,ui}/**/*.{js,ts,tsx}\"",
     "prettier": "prettier --config .prettierrc {src,ui}/**/*.{ts,tsx} --write",
     "lint-ci": "eslint \"{src,tests}/**/*.{js,ts}\"",
@@ -58,10 +58,11 @@
   ],
   "dependencies": {
     "@crowdin/crowdin-api-client": "^1.56.1",
-    "@crowdin/logs-formatter": "^2.4.0",
+    "@crowdin/logs-formatter": "^3.0.0",
     "@godaddy/terminus": "^4.12.1",
     "ajv": "^8.20.0",
     "amqplib": "^2.0.1",
+    "axios": "^1.18.1",
     "better-sqlite3": "^13.0.2",
     "cors": "^2.8.6",
     "drizzle-orm": "^0.45.2",
@@ -97,6 +98,7 @@
     "@cloudflare/workers-types": "^4.20260228.0",
     "@eslint/eslintrc": "^3.3.3",
     "@eslint/js": "^10.0.1",
+    "@jest/globals": "^30.4.1",
     "@monaco-editor/react": "^4.7.0",
     "@rjsf/core": "^6.6.2",
     "@rjsf/shadcn": "^6.6.2",
@@ -111,6 +113,7 @@
     "@types/better-sqlite3": "^7.6.13",
     "@types/cors": "^2.8.19",
     "@types/express": "^5.0.3",
+    "@types/express-serve-static-core": "^5.1.2",
     "@types/jest": "^30.0.0",
     "@types/jsonwebtoken": "^9.0.10",
     "@types/minimatch": "^5.1.2",
@@ -118,6 +121,7 @@
     "@types/pg": "^8.16.0",
     "@types/react": "^19.2.18",
     "@types/react-dom": "^19.2.4",
+    "@types/serve-static": "^2.2.0",
     "@types/swagger-jsdoc": "^6.0.4",
     "@typescript-eslint/eslint-plugin": "^8.56.0",
     "@typescript-eslint/parser": "^8.56.0",
@@ -150,5 +154,6 @@
   "bugs": {
     "url": "https://github.com/crowdin/app-project-module/issues"
   },
-  "homepage": "https://crowdin.github.io/app-project-module"
+  "homepage": "https://crowdin.github.io/app-project-module",
+  "packageManager": "pnpm@11.20.0+sha512.9a6f330a95b66446ea088faf1521405a8a01f07fde7124cc9958dfed52d4bb436737e65b08f85f37b46fcba375092558ac51262b816844b22f63406ed166bfee"
 }