@flink-app/flink 0.3.11 → 0.4.0

package/cli/run.ts

@@ -2,10 +2,10 @@
 import TypeScriptCompiler from "../src/TypeScriptCompiler";
 
 module.exports = async function run(args: string[]) {
-  const startTime = Date.now();
+    const startTime = Date.now();
 
-  if (args.includes("--help")) {
-    console.log(`
+    if (args.includes("--help")) {
+        console.log(`
     Description
       Compiles and starts the application.
 
@@ -20,37 +20,33 @@ module.exports = async function run(args: string[]) {
       --help    Displays this message
       `);
 
-    process.exit(0);
-  }
+        process.exit(0);
+    }
 
-  let dir = "./";
-  if (args[0] && !args[0].startsWith("--")) {
-    dir = args[0];
-  }
+    let dir = "./";
+    if (args[0] && !args[0].startsWith("--")) {
+        dir = args[0];
+    }
 
-  let entry = "/src/index.ts";
-  if (args.includes("--entry")) {
-    entry = args[args.indexOf("--entry") + 1];
-    entry = entry.startsWith("/") ? entry : "/" + entry;
-  }
+    let entry = "/src/index.ts";
+    if (args.includes("--entry")) {
+        entry = args[args.indexOf("--entry") + 1];
+        entry = entry.startsWith("/") ? entry : "/" + entry;
+    }
 
-  await TypeScriptCompiler.clean(dir);
+    await TypeScriptCompiler.clean(dir);
 
-  const compiler = new TypeScriptCompiler(dir);
+    const compiler = new TypeScriptCompiler(dir);
 
-  if (!compiler.getPreEmitDiagnostics()) {
-    process.exit(1);
-  }
+    if (!compiler.getPreEmitDiagnostics()) {
+        process.exit(1);
+    }
 
-  await Promise.all([
-    compiler.parseRepos(),
-    compiler.parseHandlers(),
-    compiler.generateStartScript(entry),
-  ]);
+    await Promise.all([compiler.parseRepos(), compiler.parseHandlers(), compiler.parseJobs(), compiler.generateStartScript(entry)]);
 
-  console.log(`Compilation done, took ${Date.now() - startTime}ms`);
+    console.log(`Compilation done, took ${Date.now() - startTime}ms`);
 
-  compiler.emit();
+    compiler.emit();
 
-  require("child_process").fork(dir + "/dist/.flink/start.js");
+    require("child_process").fork(dir + "/dist/.flink/start.js");
 };

package/dist/cli/run.js

@@ -68,11 +68,7 @@ module.exports = function run(args) {
                     if (!compiler.getPreEmitDiagnostics()) {
                         process.exit(1);
                     }
-                    return [4 /*yield*/, Promise.all([
-                            compiler.parseRepos(),
-                            compiler.parseHandlers(),
-                            compiler.generateStartScript(entry),
-                        ])];
+                    return [4 /*yield*/, Promise.all([compiler.parseRepos(), compiler.parseHandlers(), compiler.parseJobs(), compiler.generateStartScript(entry)])];
                 case 2:
                     _a.sent();
                     console.log("Compilation done, took ".concat(Date.now() - startTime, "ms"));

package/dist/src/FlinkApp.d.ts

@@ -1,15 +1,18 @@
+import { OptionsJson } from "body-parser";
 import { Express } from "express";
 import { JSONSchema7 } from "json-schema";
 import { Db } from "mongodb";
+import { ToadScheduler } from "toad-scheduler";
 import { FlinkAuthPlugin } from "./auth/FlinkAuthPlugin";
 import { FlinkContext } from "./FlinkContext";
 import { HandlerFile, HttpMethod, QueryParamMetadata, RouteProps } from "./FlinkHttpHandler";
+import { FlinkJobFile } from "./FlinkJob";
 import { FlinkPlugin } from "./FlinkPlugin";
 import { FlinkRepo } from "./FlinkRepo";
 export type JSONSchema = JSONSchema7;
 /**
  * This will be populated at compile time when the apps handlers
- * are picked up by typescript compiler
+ * are picked up by TypeScript compiler
  */
 export declare const autoRegisteredHandlers: {
     handler: HandlerFile;
@@ -17,13 +20,18 @@ export declare const autoRegisteredHandlers: {
 }[];
 /**
  * This will be populated at compile time when the apps repos
- * are picked up by typescript compiler
+ * are picked up by TypeScript compiler
  */
 export declare const autoRegisteredRepos: {
     collectionName: string;
     repoInstanceName: string;
     Repo: any;
 }[];
+/**
+ * This will be populated at compile time when the apps jobs
+ * are picked up by TypeScript compiler
+ */
+export declare const autoRegisteredJobs: FlinkJobFile[];
 export interface FlinkOptions {
     /**
      * Name of application, will only show in logs and in HTTP header.
@@ -88,6 +96,17 @@ export interface FlinkOptions {
      * Optional root folder of app. Defaults to `./`
      */
     appRoot?: string;
+    /**
+     * Options for json body parser
+     */
+    jsonOptions?: OptionsJson;
+    scheduling?: {
+        /**
+         * If true, the scheduler will be enabled.
+         * Defaults to true.
+         */
+        enabled?: boolean;
+    };
 }
 export interface HandlerConfig {
     schema?: {
@@ -124,11 +143,14 @@ export declare class FlinkApp<C extends FlinkContext> {
     private auth?;
     private corsOpts;
     private routingConfigured;
+    private jsonOptions?;
+    private schedulingOptions?;
     private repos;
     /**
      * Internal cache used to track registered handlers and potentially any overlapping routes
      */
     private handlerRouteCache;
+    scheduler?: ToadScheduler;
     constructor(opts: FlinkOptions);
     get ctx(): C;
     start(): Promise<this>;
@@ -147,6 +169,7 @@ export declare class FlinkApp<C extends FlinkContext> {
      * Will not register any handlers added programmatically.
      */
     private registerAutoRegisterableHandlers;
+    private registerAutoRegisterableJobs;
     addRepo(instanceName: string, repoInstance: FlinkRepo<C>): void;
     /**
      * Constructs the app context. Will inject context in all components
@@ -163,4 +186,5 @@ export declare class FlinkApp<C extends FlinkContext> {
     private initPluginDb;
     private authenticate;
     getRegisteredRoutes(): string[];
+    private get isSchedulingEnabled();
 }

package/dist/src/FlinkApp.js

@@ -50,16 +50,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FlinkApp = exports.autoRegisteredRepos = exports.autoRegisteredHandlers = void 0;
+exports.FlinkApp = exports.autoRegisteredJobs = exports.autoRegisteredRepos = exports.autoRegisteredHandlers = void 0;
 var ajv_1 = __importDefault(require("ajv"));
 var ajv_formats_1 = __importDefault(require("ajv-formats"));
 var body_parser_1 = __importDefault(require("body-parser"));
 var cors_1 = __importDefault(require("cors"));
 var express_1 = __importDefault(require("express"));
 var mongodb_1 = __importDefault(require("mongodb"));
-var node_color_log_1 = __importDefault(require("node-color-log"));
+var ms_1 = __importDefault(require("ms"));
+var toad_scheduler_1 = require("toad-scheduler");
 var uuid_1 = require("uuid");
 var FlinkErrors_1 = require("./FlinkErrors");
+var FlinkLog_1 = require("./FlinkLog");
 var mock_data_generator_1 = __importDefault(require("./mock-data-generator"));
 var utils_1 = require("./utils");
 var ajv = new ajv_1.default();
@@ -71,14 +73,19 @@ var defaultCorsOptions = {
 };
 /**
  * This will be populated at compile time when the apps handlers
- * are picked up by typescript compiler
+ * are picked up by TypeScript compiler
  */
 exports.autoRegisteredHandlers = [];
 /**
  * This will be populated at compile time when the apps repos
- * are picked up by typescript compiler
+ * are picked up by TypeScript compiler
  */
 exports.autoRegisteredRepos = [];
+/**
+ * This will be populated at compile time when the apps jobs
+ * are picked up by TypeScript compiler
+ */
+exports.autoRegisteredJobs = [];
 var FlinkApp = /** @class */ (function () {
     function FlinkApp(opts) {
         this.handlers = [];
@@ -99,6 +106,8 @@ var FlinkApp = /** @class */ (function () {
         this.plugins = opts.plugins || [];
         this.corsOpts = __assign(__assign({}, defaultCorsOptions), opts.cors);
         this.auth = opts.auth;
+        this.jsonOptions = opts.jsonOptions || { limit: "1mb" };
+        this.schedulingOptions = opts.scheduling;
     }
     Object.defineProperty(FlinkApp.prototype, "ctx", {
         get: function () {
@@ -125,22 +134,21 @@ var FlinkApp = /** @class */ (function () {
                         _c.sent();
                         if (this.debug) {
                             offsetTime = Date.now();
-                            node_color_log_1.default.bgColorLog("cyan", "Init db took ".concat(offsetTime - startTime, " ms"));
+                            FlinkLog_1.log.bgColorLog("cyan", "Init db took ".concat(offsetTime - startTime, " ms"));
                         }
                         return [4 /*yield*/, this.buildContext()];
                     case 2:
                         _c.sent();
                         if (this.debug) {
-                            node_color_log_1.default.bgColorLog("cyan", "Build context took ".concat(Date.now() - offsetTime, " ms"));
+                            FlinkLog_1.log.bgColorLog("cyan", "Build context took ".concat(Date.now() - offsetTime, " ms"));
                             offsetTime = Date.now();
                         }
-                        if (this.debug) {
-                            node_color_log_1.default.bgColorLog("cyan", "Registered JSON schemas took ".concat(Date.now() - offsetTime, " ms"));
-                            offsetTime = Date.now();
+                        if (this.isSchedulingEnabled) {
+                            this.scheduler = new toad_scheduler_1.ToadScheduler();
                         }
                         this.expressApp = (0, express_1.default)();
                         this.expressApp.use((0, cors_1.default)(this.corsOpts));
-                        this.expressApp.use(body_parser_1.default.json());
+                        this.expressApp.use(body_parser_1.default.json(this.jsonOptions));
                         this.expressApp.use(function (req, res, next) {
                             req.reqId = (0, uuid_1.v4)();
                             next();
@@ -163,7 +171,7 @@ var FlinkApp = /** @class */ (function () {
                         _c.sent();
                         _c.label = 7;
                     case 7:
-                        node_color_log_1.default.info("Initialized plugin '".concat(plugin.id, "'"));
+                        FlinkLog_1.log.info("Initialized plugin '".concat(plugin.id, "'"));
                         _c.label = 8;
                     case 8:
                         _i++;
@@ -172,9 +180,19 @@ var FlinkApp = /** @class */ (function () {
                     case 10:
                         _c.sent();
                         if (this.debug) {
-                            node_color_log_1.default.bgColorLog("cyan", "Register handlers took ".concat(Date.now() - offsetTime, " ms"));
+                            FlinkLog_1.log.bgColorLog("cyan", "Register handlers took ".concat(Date.now() - offsetTime, " ms"));
                             offsetTime = Date.now();
                         }
+                        if (!this.isSchedulingEnabled) return [3 /*break*/, 12];
+                        return [4 /*yield*/, this.registerAutoRegisterableJobs()];
+                    case 11:
+                        _c.sent();
+                        if (this.debug) {
+                            FlinkLog_1.log.bgColorLog("cyan", "Register jobs took ".concat(Date.now() - offsetTime, " ms"));
+                            offsetTime = Date.now();
+                        }
+                        _c.label = 12;
+                    case 12:
                         // Register 404 with slight delay to allow all manually added routes to be added
                         // TODO: Is there a better solution to force this handler to always run last?
                         setTimeout(function () {
@@ -184,7 +202,7 @@ var FlinkApp = /** @class */ (function () {
                             _this.routingConfigured = true;
                         });
                         (_a = this.expressApp) === null || _a === void 0 ? void 0 : _a.listen(this.port, function () {
-                            node_color_log_1.default.fontColorLog("magenta", "\u26A1\uFE0F HTTP server '".concat(_this.name, "' is running and waiting for connections on ").concat(_this.port));
+                            FlinkLog_1.log.fontColorLog("magenta", "\u26A1\uFE0F HTTP server '".concat(_this.name, "' is running and waiting for connections on ").concat(_this.port));
                             _this.started = true;
                         });
                         return [2 /*return*/, this];
@@ -205,18 +223,18 @@ var FlinkApp = /** @class */ (function () {
         }
         var routeProps = __assign(__assign({}, (handler.Route || {})), routePropsOverride);
         if (!routeProps.method) {
-            node_color_log_1.default.error("Failed to register handler '".concat(handler.__file, "': Missing 'method' in route props, either set it or name handler file with HTTP method as prefix"));
+            FlinkLog_1.log.error("Failed to register handler '".concat(handler.__file, "': Missing 'method' in route props, either set it or name handler file with HTTP method as prefix"));
             return;
         }
         if (!routeProps.path) {
-            node_color_log_1.default.error("Failed to register handler '".concat(handler.__file, "': Missing 'path' in route props"));
+            FlinkLog_1.log.error("Failed to register handler '".concat(handler.__file, "': Missing 'path' in route props"));
             return;
         }
         var dup = this.handlers.find(function (h) { return h.routeProps.path === routeProps.path && h.routeProps.method === routeProps.method; });
         var methodAndPath = "".concat(routeProps.method.toUpperCase(), " ").concat(routeProps.path);
         if (dup) {
             // TODO: Not sure if there is a case where you'd want to overwrite a route?
-            node_color_log_1.default.warn("".concat(methodAndPath, " overlaps existing route"));
+            FlinkLog_1.log.warn("".concat(methodAndPath, " overlaps existing route"));
         }
         var handlerConfig = {
             routeProps: __assign(__assign({}, routeProps), { method: routeProps.method, path: routeProps.path }),
@@ -228,10 +246,10 @@ var FlinkApp = /** @class */ (function () {
             paramsMetadata: handler.__params || [],
         };
         if (((_c = handler.__schemas) === null || _c === void 0 ? void 0 : _c.reqSchema) && !((_d = handlerConfig.schema) === null || _d === void 0 ? void 0 : _d.reqSchema)) {
-            node_color_log_1.default.warn("Expected request schema ".concat(handler.__schemas.reqSchema, " for handler ").concat(methodAndPath, " but no such schema was found"));
+            FlinkLog_1.log.warn("Expected request schema ".concat(handler.__schemas.reqSchema, " for handler ").concat(methodAndPath, " but no such schema was found"));
         }
         if (((_e = handler.__schemas) === null || _e === void 0 ? void 0 : _e.resSchema) && !((_f = handlerConfig.schema) === null || _f === void 0 ? void 0 : _f.resSchema)) {
-            node_color_log_1.default.warn("Expected response schema ".concat(handler.__schemas.resSchema, " for handler ").concat(methodAndPath, " but no such schema was found"));
+            FlinkLog_1.log.warn("Expected response schema ".concat(handler.__schemas.resSchema, " for handler ").concat(methodAndPath, " but no such schema was found"));
         }
         this.registerHandler(handlerConfig, handler.default);
     };
@@ -242,7 +260,7 @@ var FlinkApp = /** @class */ (function () {
         var method = routeProps.method;
         var app = this.expressApp;
         if (!method) {
-            node_color_log_1.default.error("Route ".concat(routeProps.path, " is missing http method"));
+            FlinkLog_1.log.error("Route ".concat(routeProps.path, " is missing http method"));
         }
         if (method) {
             var methodAndRoute_1 = "".concat(method.toUpperCase(), " ").concat(routeProps.path);
@@ -263,8 +281,8 @@ var FlinkApp = /** @class */ (function () {
                                 validate = ajv.compile(schema.reqSchema);
                                 valid = validate(req.body);
                                 if (!valid) {
-                                    node_color_log_1.default.warn("".concat(methodAndRoute_1, ": Bad request ").concat(JSON.stringify(validate.errors, null, 2)));
-                                    node_color_log_1.default.debug("Invalid json: ".concat(JSON.stringify(req.body)));
+                                    FlinkLog_1.log.warn("".concat(methodAndRoute_1, ": Bad request ").concat(JSON.stringify(validate.errors, null, 2)));
+                                    FlinkLog_1.log.debug("Invalid json: ".concat(JSON.stringify(req.body)));
                                     return [2 /*return*/, res.status(400).json({
                                             status: 400,
                                             error: {
@@ -276,7 +294,7 @@ var FlinkApp = /** @class */ (function () {
                                 }
                             }
                             if (routeProps.mockApi && schema.resSchema) {
-                                node_color_log_1.default.warn("Mock response for ".concat(req.method.toUpperCase(), " ").concat(req.path));
+                                FlinkLog_1.log.warn("Mock response for ".concat(req.method.toUpperCase(), " ").concat(req.path));
                                 data = (0, mock_data_generator_1.default)(schema.resSchema);
                                 res.status(200).json({
                                     status: 200,
@@ -298,7 +316,7 @@ var FlinkApp = /** @class */ (function () {
                             return [3 /*break*/, 6];
                         case 5:
                             err_1 = _a.sent();
-                            node_color_log_1.default.warn("Handler '".concat(methodAndRoute_1, "' threw unhandled exception ").concat(err_1));
+                            FlinkLog_1.log.warn("Handler '".concat(methodAndRoute_1, "' threw unhandled exception ").concat(err_1));
                             console.error(err_1);
                             return [2 /*return*/, res.status(500).json((0, FlinkErrors_1.internalServerError)(err_1))];
                         case 6:
@@ -306,8 +324,8 @@ var FlinkApp = /** @class */ (function () {
                                 validate = ajv.compile(schema.resSchema);
                                 valid = validate(JSON.parse(JSON.stringify(handlerRes.data)));
                                 if (!valid) {
-                                    node_color_log_1.default.warn("[".concat(req.reqId, "] ").concat(methodAndRoute_1, ": Bad response ").concat(JSON.stringify(validate.errors, null, 2)));
-                                    node_color_log_1.default.debug("Invalid json: ".concat(JSON.stringify(handlerRes.data)));
+                                    FlinkLog_1.log.warn("[".concat(req.reqId, "] ").concat(methodAndRoute_1, ": Bad response ").concat(JSON.stringify(validate.errors, null, 2)));
+                                    FlinkLog_1.log.debug("Invalid json: ".concat(JSON.stringify(handlerRes.data)));
                                     // log.debug(JSON.stringify(schema, null, 2));
                                     return [2 /*return*/, res.status(500).json({
                                             status: 500,
@@ -326,12 +344,12 @@ var FlinkApp = /** @class */ (function () {
                 });
             }); });
             if (this.handlerRouteCache.has(methodAndRoute_1)) {
-                node_color_log_1.default.error("Cannot register handler ".concat(methodAndRoute_1, " - route already registered"));
+                FlinkLog_1.log.error("Cannot register handler ".concat(methodAndRoute_1, " - route already registered"));
                 return process.exit(1); // TODO: Do we need to exit?
             }
             else {
                 this.handlerRouteCache.set(methodAndRoute_1, JSON.stringify(routeProps));
-                node_color_log_1.default.info("Registered route ".concat(methodAndRoute_1));
+                FlinkLog_1.log.info("Registered route ".concat(methodAndRoute_1));
             }
         }
     };
@@ -349,11 +367,11 @@ var FlinkApp = /** @class */ (function () {
                 for (_i = 0, autoRegisteredHandlers_1 = exports.autoRegisteredHandlers; _i < autoRegisteredHandlers_1.length; _i++) {
                     _c = autoRegisteredHandlers_1[_i], handler = _c.handler, assumedHttpMethod = _c.assumedHttpMethod;
                     if (!handler.Route) {
-                        node_color_log_1.default.error("Missing Props in handler ".concat(handler.__file));
+                        FlinkLog_1.log.error("Missing Props in handler ".concat(handler.__file));
                         continue;
                     }
                     if (!handler.default) {
-                        node_color_log_1.default.error("Missing exported handler function in handler ".concat(handler.__file));
+                        FlinkLog_1.log.error("Missing exported handler function in handler ".concat(handler.__file));
                         continue;
                     }
                     this.registerHandler({
@@ -370,6 +388,91 @@ var FlinkApp = /** @class */ (function () {
             });
         });
     };
+    FlinkApp.prototype.registerAutoRegisterableJobs = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _loop_1, this_1, _i, autoRegisteredJobs_1, _a, jobProps, jobFn, __file;
+            var _this = this;
+            return __generator(this, function (_b) {
+                if (!this.scheduler) {
+                    throw new Error("Scheduler not initialized"); // should never happen
+                }
+                _loop_1 = function (jobProps, jobFn, __file) {
+                    if (jobProps.cron && jobProps.interval) {
+                        FlinkLog_1.log.error("Cannot register job ".concat(jobProps.id, " - both cron and interval are set in ").concat(__file));
+                        return "continue";
+                    }
+                    if (jobProps.cron && jobProps.afterDelay) {
+                        FlinkLog_1.log.error("Cannot register job ".concat(jobProps.id, " - both cron and afterDelay are set in ").concat(__file));
+                        return "continue";
+                    }
+                    if (jobProps.interval && jobProps.afterDelay) {
+                        FlinkLog_1.log.error("Cannot register job ".concat(jobProps.id, " - both interval and afterDelay are set in ").concat(__file));
+                        return "continue";
+                    }
+                    if (this_1.scheduler.existsById(jobProps.id)) {
+                        FlinkLog_1.log.error("Job with id ".concat(jobProps.id, " is already registered, found duplicate in ").concat(__file));
+                        return "continue";
+                    }
+                    FlinkLog_1.log.debug("Registering job ".concat(jobProps.id, ": ").concat(JSON.stringify(jobProps), " from ").concat(__file));
+                    var task = new toad_scheduler_1.AsyncTask(jobProps.id, function () { return __awaiter(_this, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            switch (_a.label) {
+                                case 0: return [4 /*yield*/, jobFn({ ctx: this.ctx })];
+                                case 1:
+                                    _a.sent();
+                                    FlinkLog_1.log.debug("Job ".concat(jobProps.id, " completed"));
+                                    if (jobProps.afterDelay) {
+                                        // afterDelay runs only once, so we remove the job
+                                        this.scheduler.removeById(jobProps.id);
+                                    }
+                                    return [2 /*return*/];
+                            }
+                        });
+                    }); }, function (err) {
+                        FlinkLog_1.log.error("Job ".concat(jobProps.id, " threw unhandled exception ").concat(err));
+                        console.error(err);
+                    });
+                    if (jobProps.cron) {
+                        var job = new toad_scheduler_1.CronJob({ timezone: jobProps.timezone, cronExpression: jobProps.cron }, task, {
+                            id: jobProps.id,
+                            preventOverrun: jobProps.singleton,
+                        });
+                        this_1.scheduler.addCronJob(job);
+                    }
+                    else if (jobProps.interval) {
+                        var job = new toad_scheduler_1.SimpleIntervalJob({
+                            milliseconds: (0, ms_1.default)(jobProps.interval),
+                            runImmediately: false, // TODO: Expose to props?
+                        }, task, {
+                            id: jobProps.id,
+                            preventOverrun: jobProps.singleton,
+                        });
+                        this_1.scheduler.addSimpleIntervalJob(job);
+                    }
+                    else if (jobProps.afterDelay !== undefined) {
+                        var job = new toad_scheduler_1.SimpleIntervalJob({
+                            milliseconds: (0, ms_1.default)(jobProps.afterDelay),
+                            runImmediately: false,
+                        }, task, {
+                            id: jobProps.id,
+                            preventOverrun: jobProps.singleton,
+                        });
+                        this_1.scheduler.addSimpleIntervalJob(job);
+                    }
+                    else {
+                        FlinkLog_1.log.error("Cannot register job ".concat(jobProps.id, " - no cron, interval or once set in ").concat(__file));
+                        return "continue";
+                    }
+                };
+                this_1 = this;
+                for (_i = 0, autoRegisteredJobs_1 = exports.autoRegisteredJobs; _i < autoRegisteredJobs_1.length; _i++) {
+                    _a = autoRegisteredJobs_1[_i], jobProps = _a.Job, jobFn = _a.default, __file = _a.__file;
+                    _loop_1(jobProps, jobFn, __file);
+                }
+                return [2 /*return*/];
+            });
+        });
+    };
     FlinkApp.prototype.addRepo = function (instanceName, repoInstance) {
         this.repos[instanceName] = repoInstance;
         // TODO: Find out if we need to set ctx here or wanted not to if plugin has its own context
@@ -388,11 +491,11 @@ var FlinkApp = /** @class */ (function () {
                         _a = autoRegisteredRepos_1[_i], collectionName = _a.collectionName, repoInstanceName = _a.repoInstanceName, Repo = _a.Repo;
                         repoInstance = new Repo(collectionName, this.db);
                         this.repos[repoInstanceName] = repoInstance;
-                        node_color_log_1.default.info("Registered repo ".concat(repoInstanceName));
+                        FlinkLog_1.log.info("Registered repo ".concat(repoInstanceName));
                     }
                 }
                 else if (exports.autoRegisteredRepos.length > 0) {
-                    node_color_log_1.default.warn("No db configured but found repo(s)");
+                    FlinkLog_1.log.warn("No db configured but found repo(s)");
                 }
                 pluginCtx = this.plugins.reduce(function (out, plugin) {
                     if (out[plugin.id]) {
@@ -427,7 +530,7 @@ var FlinkApp = /** @class */ (function () {
                         _a.label = 1;
                     case 1:
                         _a.trys.push([1, 3, , 4]);
-                        node_color_log_1.default.debug("Connecting to db");
+                        FlinkLog_1.log.debug("Connecting to db");
                         return [4 /*yield*/, mongodb_1.default.connect(this.dbOpts.uri, {
                                 useUnifiedTopology: true,
                                 connectTimeoutMS: 4000,
@@ -438,7 +541,7 @@ var FlinkApp = /** @class */ (function () {
                         return [3 /*break*/, 4];
                     case 3:
                         err_2 = _a.sent();
-                        node_color_log_1.default.error("Failed to connect to db: " + err_2);
+                        FlinkLog_1.log.error("Failed to connect to db: " + err_2);
                         process.exit(1);
                         return [3 /*break*/, 4];
                     case 4:
@@ -467,7 +570,7 @@ var FlinkApp = /** @class */ (function () {
                         if (!plugin.db) return [3 /*break*/, 5];
                         if (!plugin.db.useHostDb) return [3 /*break*/, 1];
                         if (!this.db) {
-                            node_color_log_1.default.error("Plugin '".concat(this.name, " configured to use host app db, but no db exists in FlinkApp'"));
+                            FlinkLog_1.log.error("Plugin '".concat(this.name, " configured to use host app db, but no db exists in FlinkApp'"));
                         }
                         else {
                             return [2 /*return*/, this.db];
@@ -478,7 +581,7 @@ var FlinkApp = /** @class */ (function () {
                         _a.label = 2;
                     case 2:
                         _a.trys.push([2, 4, , 5]);
-                        node_color_log_1.default.debug("Connecting to '".concat(plugin.id, "' db"));
+                        FlinkLog_1.log.debug("Connecting to '".concat(plugin.id, "' db"));
                         return [4 /*yield*/, mongodb_1.default.connect(plugin.db.uri, {
                                 useUnifiedTopology: true,
                             })];
@@ -487,7 +590,7 @@ var FlinkApp = /** @class */ (function () {
                         return [2 /*return*/, client.db()];
                     case 4:
                         err_3 = _a.sent();
-                        node_color_log_1.default.error("Failed to connect to db defined in plugin '".concat(plugin.id, "': ") + err_3);
+                        FlinkLog_1.log.error("Failed to connect to db defined in plugin '".concat(plugin.id, "': ") + err_3);
                         return [3 /*break*/, 5];
                     case 5: return [2 /*return*/];
                 }
@@ -511,6 +614,14 @@ var FlinkApp = /** @class */ (function () {
     FlinkApp.prototype.getRegisteredRoutes = function () {
         return Array.from(this.handlerRouteCache.values());
     };
+    Object.defineProperty(FlinkApp.prototype, "isSchedulingEnabled", {
+        get: function () {
+            var _a;
+            return ((_a = this.schedulingOptions) === null || _a === void 0 ? void 0 : _a.enabled) !== false;
+        },
+        enumerable: false,
+        configurable: true
+    });
     return FlinkApp;
 }());
 exports.FlinkApp = FlinkApp;

package/dist/src/FlinkJob.d.ts

@@ -0,0 +1,58 @@
+import { FlinkContext } from "./FlinkContext";
+export type FlinkJobProps = {
+    /**
+     * Id of job, must be unique
+     */
+    id: string;
+    /**
+     * Cron expression for scheduling job with minute precision
+     * Example: * * * * *
+     */
+    cron?: string;
+    /**
+     * Timezone for cron expression
+     * Example: Europe/Stockholm
+     */
+    timezone?: string;
+    /**
+     * Interval for scheduling job
+     * Uses ms syntax, i.e. 1s, 1m, 1h, 1d
+     */
+    interval?: string;
+    /**
+     * If true, job will only run once at startup after delay.
+     * Uses ms syntax, i.e. 1s, 1m, 1h, 1d
+     */
+    afterDelay?: string;
+    /**
+     * If true, job will only one at a time.
+     *
+     * If a job is already running, the next invocation will be ignored and will be
+     * retried after the next interval.
+     */
+    singleton?: boolean;
+};
+/**
+ * Type for Flink job function. This function should be default exported from
+ * a Job file and the body is what will be executed when the job is invoked.
+ */
+export interface FlinkJob<C extends FlinkContext> {
+    (params: {
+        ctx: C;
+    }): Promise<any>;
+}
+/**
+ * Type for Job file.
+ *
+ * Describes shape of exports when using syntax like:
+ *
+ * `import * as FooJob from "./src/jobs/FooJob"
+ */
+export type FlinkJobFile = {
+    default: FlinkJob<any>;
+    Job: FlinkJobProps;
+    /**
+     * Typescript source file name, is set at compile time by Flink compiler.
+     */
+    __file?: string;
+};

package/dist/src/FlinkJob.js

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

package/dist/src/FlinkLog.d.ts

@@ -4,5 +4,21 @@ export declare const log: {
     warn: (...args: any[]) => void;
     error: (...args: any[]) => void;
     json: (...args: any) => void;
+    bgColorLog: (ticket: "black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white", text: string, setting?: {
+        bold?: boolean | undefined;
+        italic?: boolean | undefined;
+        dim?: boolean | undefined;
+        underscore?: boolean | undefined;
+        reverse?: boolean | undefined;
+        strikethrough?: boolean | undefined;
+    } | undefined) => void;
+    fontColorLog: (ticket: "black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white", text: string, setting?: {
+        bold?: boolean | undefined;
+        italic?: boolean | undefined;
+        dim?: boolean | undefined;
+        underscore?: boolean | undefined;
+        reverse?: boolean | undefined;
+        strikethrough?: boolean | undefined;
+    } | undefined) => void;
     setLevel: (level: "debug" | "info" | "warn" | "error") => void;
 };