@flink-app/flink 0.13.5 → 0.14.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @flink-app/flink
 
+## 0.14.0
+
+### Minor Changes
+
+-   7da5227: Pass extra arguments through to forked process in flink run command. This enables passing arguments like --filter to test runners or other CLI flags to the application being run. Example usage: `npm run test -- --filter="spec/file.spec.ts"`
+
+### Patch Changes
+
+-   8ad040f: Support void and undefined types in handler schemas. Handlers can now use `void` or `undefined` for request/response type arguments to explicitly indicate no schema validation is needed. Example: `Handler<Ctx, void, void>` for endpoints with no request or response body.
+
 ## 0.13.5
 
 ### Patch Changes

package/cli/run.ts

@@ -40,7 +40,14 @@ module.exports = async function run(args: string[]) {
             console.warn("WARNING: --entry is ignored when using --precompiled");
         }
 
-        const forkedProcess = require("child_process").fork(dir + "/dist/.flink/start.js");
+        // Collect extra arguments to pass through to the forked process
+        const extraArgs = args.filter(arg =>
+            arg !== "--precompiled" &&
+            !arg.startsWith("--entry") &&
+            arg !== args[args.indexOf("--entry") + 1]
+        ).filter(arg => arg !== args[0] || args[0].startsWith("--"));
+
+        const forkedProcess = require("child_process").fork(dir + "/dist/.flink/start.js", extraArgs);
 
         forkedProcess.on("exit", (code: any) => {
             process.exit(code);
@@ -62,7 +69,13 @@ module.exports = async function run(args: string[]) {
 
     compiler.emit();
 
-    const forkedProcess = require("child_process").fork(dir + "/dist/.flink/start.js");
+    // Collect extra arguments to pass through to the forked process
+    const extraArgs = args.filter(arg =>
+        !arg.startsWith("--entry") &&
+        arg !== args[args.indexOf("--entry") + 1]
+    ).filter(arg => arg !== args[0] || args[0].startsWith("--"));
+
+    const forkedProcess = require("child_process").fork(dir + "/dist/.flink/start.js", extraArgs);
 
     forkedProcess.on("exit", (code: any) => {
         process.exit(code);

package/dist/cli/run.js

@@ -43,7 +43,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var TypeScriptCompiler_1 = __importDefault(require("../src/TypeScriptCompiler"));
 module.exports = function run(args) {
     return __awaiter(this, void 0, void 0, function () {
-        var startTime, dir, entry, forkedProcess_1, compiler, forkedProcess;
+        var startTime, dir, entry, extraArgs_1, forkedProcess_1, compiler, extraArgs, forkedProcess;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
@@ -65,7 +65,12 @@ module.exports = function run(args) {
                         if (args.includes("--entry")) {
                             console.warn("WARNING: --entry is ignored when using --precompiled");
                         }
-                        forkedProcess_1 = require("child_process").fork(dir + "/dist/.flink/start.js");
+                        extraArgs_1 = args.filter(function (arg) {
+                            return arg !== "--precompiled" &&
+                                !arg.startsWith("--entry") &&
+                                arg !== args[args.indexOf("--entry") + 1];
+                        }).filter(function (arg) { return arg !== args[0] || args[0].startsWith("--"); });
+                        forkedProcess_1 = require("child_process").fork(dir + "/dist/.flink/start.js", extraArgs_1);
                         forkedProcess_1.on("exit", function (code) {
                             process.exit(code);
                         });
@@ -83,7 +88,11 @@ module.exports = function run(args) {
                     _a.sent();
                     console.log("Compilation done, took ".concat(Date.now() - startTime, "ms"));
                     compiler.emit();
-                    forkedProcess = require("child_process").fork(dir + "/dist/.flink/start.js");
+                    extraArgs = args.filter(function (arg) {
+                        return !arg.startsWith("--entry") &&
+                            arg !== args[args.indexOf("--entry") + 1];
+                    }).filter(function (arg) { return arg !== args[0] || args[0].startsWith("--"); });
+                    forkedProcess = require("child_process").fork(dir + "/dist/.flink/start.js", extraArgs);
                     forkedProcess.on("exit", function (code) {
                         process.exit(code);
                     });

package/dist/src/TypeScriptCompiler.js

@@ -522,11 +522,15 @@ var TypeScriptCompiler = /** @class */ (function () {
     };
     TypeScriptCompiler.prototype.saveIntermediateTsSchema = function (schema, handlerFile, suffix) {
         return __awaiter(this, void 0, void 0, function () {
-            var handlerFileName, generatedSchemaInterfaceStr, schemaInterfaceName, schemaSymbol, interfaceName, declaration, _i, _a, typeToImport, typeSymbol, declaredTypeSymbol, _b, _c, prop, propDecl, propText, interfaceNameMatches, _d, interfaceNameMatches_1, match, referencedInterfaceName, referencedInterfaceDecl, arrayTypeArg, schemaSymbol, interfaceName, declaration, props, _e, _f, typeToImport, typeSymbol, declaredTypeSymbol, schemaSymbol, declarations, declaration, propertySignatures, _g, _h, prop, propType, typeSymbol, typeDeclaration, elementType, elementSymbol, elementDeclaration, currentPropTypeText, interfaceNameMatches, _j, interfaceNameMatches_2, match, interfaceName, interfaceDecl, typeArgs, _k, typeArgs_1, typeArg, argSymbol, argDeclaration, _l, _m, typeToImport, typeSymbol, declaredTypeSymbol;
+            var schemaText, handlerFileName, generatedSchemaInterfaceStr, schemaInterfaceName, schemaSymbol, interfaceName, declaration, _i, _a, typeToImport, typeSymbol, declaredTypeSymbol, _b, _c, prop, propDecl, propText, interfaceNameMatches, _d, interfaceNameMatches_1, match, referencedInterfaceName, referencedInterfaceDecl, arrayTypeArg, schemaSymbol, interfaceName, declaration, props, _e, _f, typeToImport, typeSymbol, declaredTypeSymbol, schemaSymbol, declarations, declaration, propertySignatures, _g, _h, prop, propType, typeSymbol, typeDeclaration, elementType, elementSymbol, elementDeclaration, currentPropTypeText, interfaceNameMatches, _j, interfaceNameMatches_2, match, interfaceName, interfaceDecl, typeArgs, _k, typeArgs_1, typeArg, argSymbol, argDeclaration, _l, _m, typeToImport, typeSymbol, declaredTypeSymbol;
             return __generator(this, function (_o) {
                 if (schema.isAny()) {
                     return [2 /*return*/]; // 'any' indicates that no schema is used
                 }
+                schemaText = schema.getText();
+                if (schemaText === 'void' || schemaText === 'undefined') {
+                    return [2 /*return*/];
+                }
                 handlerFileName = handlerFile.getBaseNameWithoutExtension().replace(/\./g, "_");
                 generatedSchemaInterfaceStr = "";
                 schemaInterfaceName = "".concat(handlerFileName, "_").concat(suffix);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flink-app/flink",
-  "version": "0.13.5",
+  "version": "0.14.0",
   "description": "Typescript only framework for creating REST-like APIs on top of Express and mongodb",
   "types": "dist/src/index.d.ts",
   "main": "dist/src/index.js",

package/spec/mock-project/dist/src/handlers/DeleteCar.js

@@ -0,0 +1,54 @@
+"use strict";
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        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]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.__schemas = exports.__params = exports.__query = exports.__file = exports.__assumedHttpMethod = exports.Route = void 0;
+exports.Route = {
+    path: "/car/:id",
+};
+var DeleteCar = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
+    var ctx = _b.ctx, req = _b.req;
+    return __generator(this, function (_c) {
+        // Delete car logic here
+        return [2 /*return*/, {
+                data: undefined,
+            }];
+    });
+}); };
+exports.default = DeleteCar;
+exports.__assumedHttpMethod = "delete", exports.__file = "DeleteCar.ts", exports.__query = [], exports.__params = [];
+exports.__schemas = { reqSchema: undefined, resSchema: undefined };

package/spec/mock-project/dist/src/handlers/PostVoidRequest.js

@@ -0,0 +1,55 @@
+"use strict";
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        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]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.__schemas = exports.__params = exports.__query = exports.__file = exports.__assumedHttpMethod = exports.Route = void 0;
+exports.Route = {
+    path: "/void-request",
+};
+var PostVoidRequest = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
+    var ctx = _b.ctx, req = _b.req;
+    return __generator(this, function (_c) {
+        return [2 /*return*/, {
+                data: {
+                    success: true,
+                },
+            }];
+    });
+}); };
+exports.default = PostVoidRequest;
+exports.__assumedHttpMethod = "post", exports.__file = "PostVoidRequest.ts", exports.__query = [], exports.__params = [];
+exports.__schemas = { reqSchema: undefined, resSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "success": { "type": "boolean" } }, "required": ["success"], "additionalProperties": false, "definitions": {} } };

package/src/TypeScriptCompiler.ts

@@ -456,6 +456,12 @@ export default {}; // Export an empty object to make it a module
             return; // 'any' indicates that no schema is used
         }
 
+        // Check for void and undefined types - these indicate no schema validation needed
+        const schemaText = schema.getText();
+        if (schemaText === 'void' || schemaText === 'undefined') {
+            return;
+        }
+
         const handlerFileName = handlerFile.getBaseNameWithoutExtension().replace(/\./g, "_");
 
         let generatedSchemaInterfaceStr = "";