@flink-app/flink 0.3.12 → 0.4.0

package/.vscode/notes.txt

@@ -0,0 +1,11 @@
+1. Build time: Convert interfaces to JSON schemas
+
+
+./.flink/schemas
+
+2. Run time: Read JSON schemas from dir ./.flink/schemas/*.ts
+
+
+
+
+flink prepare

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/bin/flink.js

@@ -12,11 +12,11 @@ var commands = [
 var argv = process.argv.slice(2);
 var argCommand = argv[0];
 if (!argCommand || argv[0] === "help") {
-    console.log("Usage: flink [" + commands.join("|") + "]");
+    console.log("Usage: flink [".concat(commands.join("|"), "]"));
     process.exit();
 }
 if (!commands.includes(argv[0])) {
-    console.log("Invalid command: " + argCommand);
+    console.log("Invalid command: ".concat(argCommand));
     process.exit(1);
 }
 if (argCommand === "generate") {

package/dist/cli/build.js

@@ -15,7 +15,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {
@@ -57,7 +57,7 @@ module.exports = function run(args) {
                     if (args[0] && !args[0].startsWith("--")) {
                         dir = args[0];
                     }
-                    exclude = cli_utils_1.getOption(args, "exclude", "/spec");
+                    exclude = (0, cli_utils_1.getOption)(args, "exclude", "/spec");
                     return [4 /*yield*/, TypeScriptCompiler_1.default.clean(dir)];
                 case 1:
                     _a.sent();
@@ -72,7 +72,7 @@ module.exports = function run(args) {
                         ])];
                 case 2:
                     _a.sent();
-                    console.log("Compilation done, took " + (Date.now() - startTime) + "ms");
+                    console.log("Compilation done, took ".concat(Date.now() - startTime, "ms"));
                     compiler.emit();
                     return [2 /*return*/];
             }

package/dist/cli/clean.js

@@ -15,7 +15,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {
@@ -58,7 +58,7 @@ module.exports = function run(args) {
                     return [4 /*yield*/, TypeScriptCompiler_1.default.clean(dir)];
                 case 1:
                     cleanedFolder = _a.sent();
-                    console.log("Cleaned directory " + cleanedFolder);
+                    console.log("Cleaned directory ".concat(cleanedFolder));
                     return [2 /*return*/];
             }
         });

package/dist/cli/cli-utils.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getOption = void 0;
 function getOption(args, name, defaultValue, opts) {
     if (opts === void 0) { opts = {}; }
-    var option = "--" + name;
+    var option = "--".concat(name);
     if (args.includes(option)) {
         if (opts.isBoolean && args[args.indexOf(option) + 1] !== "false") {
             return true;

package/dist/cli/generate-schemas.js

@@ -26,7 +26,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {
@@ -47,10 +47,14 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
-var __spreadArray = (this && this.__spreadArray) || function (to, from) {
-    for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
-        to[j] = from[i];
-    return to;
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 var path_1 = require("path");
@@ -72,19 +76,19 @@ module.exports = function run(args) {
                     if (args[0] && !args[0].startsWith("--")) {
                         dir = args[0];
                     }
-                    verbose = cli_utils_1.getOption(args, "verbose", false, {
+                    verbose = (0, cli_utils_1.getOption)(args, "verbose", false, {
                         isBoolean: true,
                     });
-                    typesDir = cli_utils_1.getOption(args, "types-dir", "./src/schemas");
-                    outFile = cli_utils_1.getOption(args, "out-file", "./.flink/generated-schemas.json");
+                    typesDir = (0, cli_utils_1.getOption)(args, "types-dir", "./src/schemas");
+                    outFile = (0, cli_utils_1.getOption)(args, "out-file", "./.flink/generated-schemas.json");
                     project = new ts_morph_1.Project({
-                        tsConfigFilePath: path_1.join(dir, "tsconfig.json"),
+                        tsConfigFilePath: (0, path_1.join)(dir, "tsconfig.json"),
                         skipAddingFilesFromTsConfig: true,
                         compilerOptions: {
                             noEmit: true,
                         },
                     });
-                    project.addSourceFilesAtPaths(path_1.join(dir, typesDir, "**/*.ts"));
+                    project.addSourceFilesAtPaths((0, path_1.join)(dir, typesDir, "**/*.ts"));
                     console.log("Found", project.getSourceFiles().length, "files");
                     schemaDeclarations = [];
                     generator = initJsonSchemaGenerator(project);
@@ -92,11 +96,11 @@ module.exports = function run(args) {
                     for (_i = 0, _a = project.getSourceFiles(); _i < _a.length; _i++) {
                         sf = _a[_i];
                         if (sf.getDefaultExportSymbol()) {
-                            console.warn("WARN: Schema file " + sf.getBaseName() + " has default export, but only named exports are picked up by json schemas parser");
+                            console.warn("WARN: Schema file ".concat(sf.getBaseName(), " has default export, but only named exports are picked up by json schemas parser"));
                         }
                         sourceFileInterfaceDeclarations = sf.getChildrenOfKind(ts_morph_1.SyntaxKind.InterfaceDeclaration);
                         sourceFileEnumDeclarations = sf.getChildrenOfKind(ts_morph_1.SyntaxKind.EnumDeclaration);
-                        sourceFileDeclarations = __spreadArray(__spreadArray([], sourceFileEnumDeclarations), sourceFileInterfaceDeclarations);
+                        sourceFileDeclarations = __spreadArray(__spreadArray([], sourceFileEnumDeclarations, true), sourceFileInterfaceDeclarations, true);
                         schemaDeclarations.push.apply(schemaDeclarations, sourceFileDeclarations.map(function (d) { return d.compilerNode; }));
                         verbose &&
                             console.log("Found", sourceFileDeclarations.length, "schema(s) in file", sf.getBaseName());
@@ -120,8 +124,8 @@ module.exports = function run(args) {
                         $ref: "#/definitions/Schemas",
                         definitions: {},
                     });
-                    file = path_1.join(dir, outFile);
-                    return [4 /*yield*/, FsUtils_1.writeJsonFile(file, mergedSchemas, {
+                    file = (0, path_1.join)(dir, outFile);
+                    return [4 /*yield*/, (0, FsUtils_1.writeJsonFile)(file, mergedSchemas, {
                             ensureDir: true,
                         })];
                 case 1:
@@ -133,8 +137,8 @@ module.exports = function run(args) {
     });
 };
 function initJsonSchemaGenerator(project) {
-    var formatter = ts_json_schema_generator_1.createFormatter({});
-    var parser = ts_json_schema_generator_1.createParser(project.getProgram().compilerObject, {});
+    var formatter = (0, ts_json_schema_generator_1.createFormatter)({});
+    var parser = (0, ts_json_schema_generator_1.createParser)(project.getProgram().compilerObject, {});
     var generator = new ts_json_schema_generator_1.SchemaGenerator(project.getProgram().compilerObject, parser, formatter, { expose: "export" });
     return generator;
 }

package/dist/cli/run.js

@@ -15,7 +15,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {
@@ -68,14 +68,10 @@ 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 " + (Date.now() - startTime) + "ms");
+                    console.log("Compilation done, took ".concat(Date.now() - startTime, "ms"));
                     compiler.emit();
                     require("child_process").fork(dir + "/dist/.flink/start.js");
                     return [2 /*return*/];

package/dist/src/FlinkApp.d.ts

@@ -2,15 +2,17 @@ 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 declare type JSONSchema = JSONSchema7;
+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;
@@ -18,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.
@@ -93,6 +100,13 @@ export interface FlinkOptions {
      * Options for json body parser
      */
     jsonOptions?: OptionsJson;
+    scheduling?: {
+        /**
+         * If true, the scheduler will be enabled.
+         * Defaults to true.
+         */
+        enabled?: boolean;
+    };
 }
 export interface HandlerConfig {
     schema?: {
@@ -130,11 +144,13 @@ export declare class FlinkApp<C extends FlinkContext> {
     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>;
@@ -153,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
@@ -169,4 +186,5 @@ export declare class FlinkApp<C extends FlinkContext> {
     private initPluginDb;
     private authenticate;
     getRegisteredRoutes(): string[];
+    private get isSchedulingEnabled();
 }