@crowdin/app-project-module 0.98.0-cf-12 → 0.98.0-cf-13

package/out/index.d.ts

@@ -4,6 +4,7 @@ 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

@@ -51,6 +51,7 @@ 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");
@@ -139,6 +140,7 @@ 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 {
@@ -208,7 +210,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({}, exports.metadataStore);
+        return Object.assign(Object.assign({}, exports.metadataStore), { cron: cron.getCron() });
     }
     app.post('/installed', (0, install_1.default)(config));
     app.post('/uninstall', (0, uninstall_1.default)(config));
@@ -221,7 +223,7 @@ function addCrowdinEndpoints(app, clientConfig) {
      *     /util -> folder for utilities
      *     /handlers -> for http handlers
      */
-    const { cronExecutions } = integrationApp.register({ config, app });
+    integrationApp.register({ config, app });
     customMTApp.register({ config, app });
     fileProcessingApps.registerCustomFileFormat({ config, app });
     fileProcessingApps.registerFilePreImport({ config, app });
@@ -238,8 +240,7 @@ function addCrowdinEndpoints(app, clientConfig) {
     workflowStepType.register({ config, app });
     aiRequestProcessors.register({ config, app });
     addFormSchema({ config, app });
-    return Object.assign(Object.assign({}, exports.metadataStore), { //TODO for backward compatibility (needs to be removed)
-        cronExecutions, storage: storage.getStorage(), establishCrowdinConnection: (authRequest, moduleKey) => {
+    return Object.assign(Object.assign({}, exports.metadataStore), { storage: storage.getStorage(), cron: cron.getCron(), establishCrowdinConnection: (authRequest, moduleKey) => {
             let jwtToken = '';
             if (typeof authRequest === 'string') {
                 jwtToken = authRequest;

package/out/modules/integration/index.d.ts

@@ -3,6 +3,4 @@ import { Config } from '../../types';
 export declare function register({ config, app }: {
     config: Config;
     app: Express;
-}): {
-    cronExecutions: {};
-};
+}): void;

package/out/modules/integration/index.js

@@ -1,27 +1,4 @@
 "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) {
@@ -41,6 +18,7 @@ const integration_credentials_1 = __importDefault(require("../../middlewares/int
 const json_response_1 = __importDefault(require("../../middlewares/json-response"));
 const util_1 = require("../../util");
 const static_files_1 = require("../../util/static-files");
+const cron_1 = require("../../util/cron");
 const defaults_1 = require("./util/defaults");
 const webhooks_1 = require("./util/webhooks");
 const crowdin_file_progress_1 = __importDefault(require("./handlers/crowdin-file-progress"));
@@ -66,14 +44,13 @@ const sync_settings_save_1 = __importDefault(require("./handlers/sync-settings-s
 const user_errors_1 = __importDefault(require("./handlers/user-errors"));
 const users_1 = __importDefault(require("./handlers/users"));
 const invite_users_1 = __importDefault(require("./handlers/invite-users"));
-const cron_1 = require("./util/cron");
+const cron_2 = require("./util/cron");
 const storage_1 = require("../../storage");
 function register({ config, app }) {
     var _a, _b, _c;
-    let cronExecutions = {};
     const integrationLogic = config.projectIntegration;
     if (!integrationLogic) {
-        return { cronExecutions };
+        return;
     }
     (0, defaults_1.applyIntegrationModuleDefaults)(config, integrationLogic);
     app.get((0, util_1.getLogoUrl)(integrationLogic, '/integration'), (0, static_files_1.serveFile)(config, integrationLogic.imagePath || config.imagePath));
@@ -184,39 +161,27 @@ function register({ config, app }) {
             }), (0, oauth_polling_1.default)(integrationLogic));
         }
     }
-    Promise.resolve().then(() => __importStar(require('node-cron'))).then((nodeCron) => {
-        const cron = nodeCron.default || nodeCron;
-        if (integrationLogic.cronJobs) {
-            integrationLogic.cronJobs.forEach((job) => {
-                cron.schedule(job.expression, () => (0, cron_1.runJob)({ config, integration: integrationLogic, job }).catch(console.error));
-            });
-        }
-        if (integrationLogic.withCronSync) {
-            cron.schedule('0 * * * *', () => (0, cron_1.filesCron)({ config, integration: integrationLogic, period: '1' }).catch(console.error));
-            cron.schedule('0 */3 * * *', () => (0, cron_1.filesCron)({ config, integration: integrationLogic, period: '3' }).catch(console.error));
-            cron.schedule('0 */6 * * *', () => (0, cron_1.filesCron)({ config, integration: integrationLogic, period: '6' }).catch(console.error));
-            cron.schedule('0 */12 * * *', () => (0, cron_1.filesCron)({ config, integration: integrationLogic, period: '12' }).catch(console.error));
-            cron.schedule('0 0 * * *', () => (0, cron_1.filesCron)({ config, integration: integrationLogic, period: '24' }).catch(console.error));
+    const cron = (0, cron_1.getCron)();
+    if (integrationLogic.cronJobs) {
+        integrationLogic.cronJobs.forEach((job) => {
+            cron.schedule(job.expression, () => (0, cron_2.runJob)({ config, integration: integrationLogic, job }).catch(console.error));
+        });
+    }
+    if (integrationLogic.withCronSync) {
+        cron.schedule('0 * * * *', () => (0, cron_2.filesCron)({ config, integration: integrationLogic, period: '1' }).catch(console.error));
+        cron.schedule('0 */3 * * *', () => (0, cron_2.filesCron)({ config, integration: integrationLogic, period: '3' }).catch(console.error));
+        cron.schedule('0 */6 * * *', () => (0, cron_2.filesCron)({ config, integration: integrationLogic, period: '6' }).catch(console.error));
+        cron.schedule('0 */12 * * *', () => (0, cron_2.filesCron)({ config, integration: integrationLogic, period: '12' }).catch(console.error));
+        cron.schedule('0 0 * * *', () => (0, cron_2.filesCron)({ config, integration: integrationLogic, period: '24' }).catch(console.error));
+    }
+    // remove user errors
+    cron.schedule('0 0 * * *', () => __awaiter(this, void 0, void 0, function* () {
+        if (integrationLogic.userErrorLifetimeDays) {
+            const date = (0, util_1.getPreviousDate)(integrationLogic.userErrorLifetimeDays);
+            yield (0, storage_1.getStorage)().deleteAllUsersErrorsOlderThan(`${date.getTime()}`);
         }
-        // remove user errors
-        cron.schedule('0 0 * * *', () => __awaiter(this, void 0, void 0, function* () {
-            if (integrationLogic.userErrorLifetimeDays) {
-                const date = (0, util_1.getPreviousDate)(integrationLogic.userErrorLifetimeDays);
-                yield (0, storage_1.getStorage)().deleteAllUsersErrorsOlderThan(`${date.getTime()}`);
-            }
-        }));
-        cron.schedule('0 0 1 * *', () => (0, cron_1.removeFinishedJobs)());
-    })
-        .catch(() => {
-        // node-cron not available (e.g., Cloudflare Workers), delegating to external cron handler
-        cronExecutions = {
-            '0 * * * *': (0, cron_1.filesCron)({ config, integration: integrationLogic, period: '1' }).catch(console.error),
-            '0 */3 * * *': (0, cron_1.filesCron)({ config, integration: integrationLogic, period: '3' }).catch(console.error),
-            '0 */6 * * *': (0, cron_1.filesCron)({ config, integration: integrationLogic, period: '6' }).catch(console.error),
-            '0 */12 * * *': (0, cron_1.filesCron)({ config, integration: integrationLogic, period: '12' }).catch(console.error),
-            '0 0 * * *': (0, cron_1.filesCron)({ config, integration: integrationLogic, period: '24' }).catch(console.error),
-        };
-    });
+    }));
+    cron.schedule('0 0 1 * *', () => (0, cron_2.removeFinishedJobs)());
     if (integrationLogic.webhooks) {
         app.post(`${integrationLogic.webhooks.crowdinWebhookUrl
             ? integrationLogic.webhooks.crowdinWebhookUrl
@@ -253,6 +218,5 @@ function register({ config, app }) {
         checkSubscriptionExpiration: true,
         moduleKey: integrationLogic.key,
     }), (0, integration_credentials_1.default)(config, integrationLogic), (0, invite_users_1.default)());
-    return { cronExecutions };
 }
 exports.register = register;

package/out/types.d.ts

@@ -23,6 +23,8 @@ import { ExternalQaCheckModule } from './modules/external-qa-check/types';
 import { Webhook } from './modules/webhooks/types';
 import { WorkflowStepTypeModule } from './modules/workflow-step-type/types';
 import { AiRequestProcessorModule, AiStreamProcessorModule } from './modules/ai-request-processors/types';
+import { Cron } from './util/cron';
+export { Cron };
 export interface ClientConfig extends ImagePath {
     /**
      * Authentication Crowdin App type: "authorization_code", "crowdin_app", "crowdin_agent". Default: "crowdin_app"
@@ -108,6 +110,12 @@ export interface ClientConfig extends ImagePath {
      * config to configure Cloudflare D1 as a storage
      */
     d1Config?: D1StorageConfig;
+    /**
+     * Custom cron for scheduling background jobs.
+     * If not provided, the default node-cron will be used.
+     * Useful for external cron systems like Cloudflare Workers Scheduled Events.
+     */
+    cron?: Cron;
     /**
      * Cloudflare Workers Assets configuration
      */
@@ -414,7 +422,7 @@ export interface CrowdinAppUtilities extends CrowdinMetadataStore {
         extra: Record<string, any>;
     }>;
     storage: Storage;
-    cronExecutions?: Record<string, () => Promise<void>>;
+    cron: Cron;
 }
 export interface CrowdinMetadataStore {
     saveMetadata: (id: string, metadata: any, crowdinId: string) => Promise<void>;
@@ -529,4 +537,3 @@ export interface FileStore {
     storeFile: (content: Buffer) => Promise<string>;
     deleteFile: (fileRef: string) => Promise<void>;
 }
-export {};

package/out/util/cron.d.ts

@@ -0,0 +1,29 @@
+import { Config, UnauthorizedConfig } from '../types';
+export interface Cron {
+    /**
+     * Schedule a task to run on a cron expression
+     * @param expression - Cron expression (e.g., '0 * * * *' for hourly)
+     * @param task - Async task to execute
+     */
+    schedule(expression: string, task: () => Promise<void>): void;
+}
+/**
+ * Default Node.js cron handler that uses node-cron
+ */
+export declare class NodeCron implements Cron {
+    private cron;
+    private pendingSchedules;
+    private initialized;
+    constructor();
+    schedule(expression: string, task: () => Promise<void>): void;
+}
+/**
+ * Initialize the cron instance
+ * @param config - Client configuration
+ */
+export declare function initialize(config: Config | UnauthorizedConfig): void;
+/**
+ * Get the initialized cron instance
+ * @returns The cron instance
+ */
+export declare function getCron(): Cron;

package/out/util/cron.js

@@ -0,0 +1,87 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCron = exports.initialize = exports.NodeCron = void 0;
+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) => {
+            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);
+            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 });
+        }
+    }
+}
+exports.NodeCron = NodeCron;
+let cron;
+/**
+ * Initialize the cron instance
+ * @param config - Client configuration
+ */
+function initialize(config) {
+    if (config.cron) {
+        (0, logger_1.log)('Using custom cron implementation');
+        cron = config.cron;
+    }
+    else {
+        (0, logger_1.log)('Using default NodeCron implementation');
+        cron = new NodeCron();
+    }
+}
+exports.initialize = initialize;
+/**
+ * Get the initialized cron instance
+ * @returns The cron instance
+ */
+function getCron() {
+    if (!cron) {
+        throw new Error('Cron not initialized');
+    }
+    return cron;
+}
+exports.getCron = getCron;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdin/app-project-module",
-  "version": "0.98.0-cf-12",
+  "version": "0.98.0-cf-13",
   "description": "Module that generates for you all common endpoints for serving standalone Crowdin App",
   "main": "out/index.js",
   "types": "out/index.d.ts",