fexapi 0.1.2 → 0.1.4

package/README.md

@@ -37,15 +37,29 @@ Creates:
 
 ### 2) Edit schema file
 
-`fexapi/schema.fexapi` uses a simple DSL with only `:` and `,` (no semicolons):
+`fexapi/schema.fexapi` supports readable multi-line route fields (single-line still works):
 
 ```txt
 # Server
 port: 4100
 
 # Routes
-GET /users: id:uuid,name:name,email:email,age:number,phone:phone,pic:url,courseName:string
-GET /courses: id:uuid,courseName:string,mentor:name
+GET /users:
+  id:uuid
+  name:name
+  email:email
+  age:number
+  phone:phone
+  pic:url
+  courseName:string
+
+GET /courses:
+  id:uuid
+  courseName:string
+  mentor:name
+
+# one-line format is also valid:
+# GET /users: id:uuid,name:name,email:email
 ```
 
 ### 3) Generate artifacts (updates migration)
@@ -59,6 +73,16 @@ Generates:
 - `fexapi/generated.api.json`
 - `fexapi/migrations/schema.json`
 
+### 3a) Format schema (optional)
+
+Auto-format your schema to use readable multi-line field formatting:
+
+```bash
+npx fexapi format
+```
+
+This rewrites `fexapi/schema.fexapi` with each field on its own indented line for better readability.
+
 ### 4) Start server
 
 ```bash

package/dist/cli/args.d.ts

@@ -6,6 +6,9 @@ export declare const parseInitOptions: (initArgs: string[]) => {
 export declare const parseGenerateOptions: (generateArgs: string[]) => {
     error?: string;
 };
+export declare const parseFormatOptions: (formatArgs: string[]) => {
+    error?: string;
+};
 export declare const parseServeOptions: (serveArgs: string[]) => {
     host: string;
     port?: number;

package/dist/cli/args.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"args.d.ts","sourceRoot":"","sources":["../../src/cli/args.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,gBAAgB,GAC3B,UAAU,MAAM,EAAE,KACjB;IAAE,KAAK,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAWtC,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAC/B,cAAc,MAAM,EAAE,KACrB;IAAE,KAAK,CAAC,EAAE,MAAM,CAAA;CAQlB,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAC5B,WAAW,MAAM,EAAE,KAClB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAkDxE,CAAC;AAEF,eAAO,MAAM,eAAe,GAC1B,SAAS,MAAM,EAAE,KAEf;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,OAAO,CAAC;IAAC,UAAU,EAAE,OAAO,CAAA;CAAE,GAC3E;IAAE,KAAK,EAAE,MAAM,CAAA;CAwDlB,CAAC"}
+{"version":3,"file":"args.d.ts","sourceRoot":"","sources":["../../src/cli/args.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,gBAAgB,GAC3B,UAAU,MAAM,EAAE,KACjB;IAAE,KAAK,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAWtC,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAC/B,cAAc,MAAM,EAAE,KACrB;IAAE,KAAK,CAAC,EAAE,MAAM,CAAA;CAQlB,CAAC;AAEF,eAAO,MAAM,kBAAkB,GAC7B,YAAY,MAAM,EAAE,KACnB;IAAE,KAAK,CAAC,EAAE,MAAM,CAAA;CAQlB,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAC5B,WAAW,MAAM,EAAE,KAClB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAkDxE,CAAC;AAEF,eAAO,MAAM,eAAe,GAC1B,SAAS,MAAM,EAAE,KAEf;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,OAAO,CAAC;IAAC,UAAU,EAAE,OAAO,CAAA;CAAE,GAC3E;IAAE,KAAK,EAAE,MAAM,CAAA;CAwDlB,CAAC"}

package/dist/cli/args.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseDevOptions = exports.parseServeOptions = exports.parseGenerateOptions = exports.parseInitOptions = void 0;
+exports.parseDevOptions = exports.parseServeOptions = exports.parseFormatOptions = exports.parseGenerateOptions = exports.parseInitOptions = void 0;
 const parseInitOptions = (initArgs) => {
     const validFlags = new Set(["--force"]);
     const invalidFlags = initArgs.filter((value) => value.startsWith("-") && !validFlags.has(value));
@@ -18,6 +18,14 @@ const parseGenerateOptions = (generateArgs) => {
     return {};
 };
 exports.parseGenerateOptions = parseGenerateOptions;
+const parseFormatOptions = (formatArgs) => {
+    const invalidFlags = formatArgs.filter((value) => value.startsWith("-"));
+    if (invalidFlags.length > 0) {
+        return { error: `Unknown option(s): ${invalidFlags.join(", ")}` };
+    }
+    return {};
+};
+exports.parseFormatOptions = parseFormatOptions;
 const parseServeOptions = (serveArgs) => {
     const getFlagValue = (flagName) => {
         const index = serveArgs.indexOf(flagName);

package/dist/cli/help.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"help.d.ts","sourceRoot":"","sources":["../../src/cli/help.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS,YAgDrB,CAAC"}
+{"version":3,"file":"help.d.ts","sourceRoot":"","sources":["../../src/cli/help.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS,YAkDrB,CAAC"}

package/dist/cli/help.js

@@ -7,6 +7,7 @@ const printHelp = () => {
     console.log("Usage:");
     console.log("  fexapi init [--force]");
     console.log("  fexapi generate");
+    console.log("  fexapi format");
     console.log("  fexapi dev [--watch] [--host <host>] [--port <number>] [--log]");
     console.log("  fexapi serve [--host <host>] [--port <number>] [--log]");
     console.log("  fexapi run [--host <host>] [--port <number>] [--log]");
@@ -17,6 +18,7 @@ const printHelp = () => {
     console.log("  fexapi init");
     console.log("  fexapi init --force");
     console.log("  fexapi generate");
+    console.log("  fexapi format");
     console.log("  fexapi dev --watch");
     console.log("  fexapi dev --watch --log");
     console.log("  fexapi serve --log");

package/dist/commands/format.d.ts

@@ -0,0 +1,2 @@
+export declare const formatSchema: () => number;
+//# sourceMappingURL=format.d.ts.map

package/dist/commands/format.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../../src/commands/format.ts"],"names":[],"mappings":"AAmCA,eAAO,MAAM,YAAY,QAAO,MAuC/B,CAAC"}

package/dist/commands/format.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatSchema = void 0;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const schema_1 = require("../schema");
+const paths_1 = require("../project/paths");
+const formatSchemaToMultiline = (schemaText) => {
+    const parsed = (0, schema_1.parseFexapiSchema)(schemaText);
+    if (parsed.errors.length > 0 ||
+        !parsed.schema ||
+        parsed.schema.routes.length === 0) {
+        return schemaText;
+    }
+    const lines = [];
+    lines.push("# Server");
+    lines.push(`port: ${parsed.schema.port}`);
+    lines.push("");
+    lines.push("# Routes");
+    for (const route of parsed.schema.routes) {
+        lines.push(`${route.method} ${route.path}:`);
+        for (const field of route.fields) {
+            lines.push(`  ${field.name}:${field.type}`);
+        }
+        lines.push("");
+    }
+    return lines.join("\n").trimEnd() + "\n";
+};
+const formatSchema = () => {
+    const projectRoot = (0, paths_1.resolveProjectRoot)();
+    if (!projectRoot) {
+        console.error("Could not find package.json in this directory or parent directories.");
+        return 1;
+    }
+    const schemaPath = (0, node_path_1.join)(projectRoot, "fexapi", "schema.fexapi");
+    if (!(0, node_fs_1.existsSync)(schemaPath)) {
+        console.error(`Schema file not found: ${schemaPath}`);
+        console.error("Run `fexapi init` first.");
+        return 1;
+    }
+    const schemaText = (0, node_fs_1.readFileSync)(schemaPath, "utf-8");
+    const parsed = (0, schema_1.parseFexapiSchema)(schemaText);
+    if (parsed.errors.length > 0 || !parsed.schema) {
+        console.error("Failed to parse schema.fexapi");
+        for (const error of parsed.errors) {
+            console.error(`- ${error}`);
+        }
+        return 1;
+    }
+    const formatted = formatSchemaToMultiline(schemaText);
+    (0, node_fs_1.writeFileSync)(schemaPath, formatted, "utf-8");
+    console.log(`Formatted ${schemaPath}`);
+    console.log(`Routes: ${parsed.schema.routes.length} | Port: ${parsed.schema.port}`);
+    return 0;
+};
+exports.formatSchema = formatSchema;

package/dist/index.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const args_1 = require("./cli/args");
 const dev_1 = require("./commands/dev");
 const help_1 = require("./cli/help");
+const format_1 = require("./commands/format");
 const generate_1 = require("./commands/generate");
 const init_1 = require("./commands/init");
 const serve_1 = require("./commands/serve");
@@ -41,6 +42,21 @@ const main = async () => {
         }
         process.exit((0, generate_1.generateFromSchema)());
     }
+    else if (firstArg === "format") {
+        if (restArgs.includes("--help") || restArgs.includes("-h")) {
+            console.log("Usage: fexapi format");
+            console.log("Reformats fexapi/schema.fexapi to use readable multi-line field formatting.");
+            process.exit(0);
+        }
+        const formatOptions = (0, args_1.parseFormatOptions)(restArgs);
+        if (formatOptions.error) {
+            console.error(formatOptions.error);
+            console.log("");
+            console.log("Usage: fexapi format");
+            process.exit(1);
+        }
+        process.exit((0, format_1.formatSchema)());
+    }
     else if (firstArg === "dev") {
         if (restArgs.includes("--help") || restArgs.includes("-h")) {
             console.log("Usage: fexapi dev [--watch] [--host <host>] [--port <number>] [--log]");

package/dist/project/detect.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"detect.d.ts","sourceRoot":"","sources":["../../src/project/detect.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAyD5E,eAAO,MAAM,aAAa,GACxB,iBAAiB,MAAM,EACvB,aAAa,MAAM,KAClB,eAwDF,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAC5B,WAAW,kBAAkB,EAC7B,aAAW,KACV,MAkBF,CAAC"}
+{"version":3,"file":"detect.d.ts","sourceRoot":"","sources":["../../src/project/detect.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAyD5E,eAAO,MAAM,aAAa,GACxB,iBAAiB,MAAM,EACvB,aAAa,MAAM,KAClB,eAwDF,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAC5B,WAAW,kBAAkB,EAC7B,aAAW,KACV,MA+BF,CAAC"}

package/dist/project/detect.js

@@ -105,9 +105,22 @@ const getSchemaTemplate = (framework, port = 4000) => {
         `port: ${port}`,
         "",
         "# Routes",
-        "# Format: METHOD /endpoint: field:type,field:type",
-        "GET /users: id:uuid,fullName:name,username:string,email:email,avatarUrl:url",
-        "GET /posts: id:uuid,title:string,body:string,createdAt:date",
+        "# Format (single-line): METHOD /endpoint: field:type,field:type",
+        "# Format (multi-line):",
+        "# METHOD /endpoint:",
+        "#   field:type",
+        "#   field:type",
+        "GET /users:",
+        "  id:uuid",
+        "  fullName:name",
+        "  username:string",
+        "  email:email",
+        "  avatarUrl:url",
+        "GET /posts:",
+        "  id:uuid",
+        "  title:string",
+        "  body:string",
+        "  createdAt:date",
     ].join("\n");
 };
 exports.getSchemaTemplate = getSchemaTemplate;

package/dist/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GACvB,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,MAAM,GACN,MAAM,GACN,OAAO,GACP,KAAK,GACL,MAAM,GACN,OAAO,CAAC;AAEZ,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,eAAe,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,EAAE,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,EAAE,CAAC;CACvB,CAAC;AAiGF,eAAO,MAAM,iBAAiB,GAC5B,YAAY,MAAM,KACjB;IAAE,MAAM,CAAC,EAAE,YAAY,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAoD3C,CAAC"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GACvB,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,MAAM,GACN,MAAM,GACN,OAAO,GACP,KAAK,GACL,MAAM,GACN,OAAO,CAAC;AAEZ,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,eAAe,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,EAAE,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,EAAE,CAAC;CACvB,CAAC;AAqHF,eAAO,MAAM,iBAAiB,GAC5B,YAAY,MAAM,KACjB;IAAE,MAAM,CAAC,EAAE,YAAY,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAmG3C,CAAC"}

package/dist/schema.js

@@ -14,7 +14,27 @@ const VALID_TYPES = [
 ];
 const DEFAULT_PORT = 4000;
 const ROUTE_FORMAT_ERROR_MESSAGE = "Invalid route definition. Expected format: " +
-    "METHOD /endpoint: field:type,field:type";
+    "METHOD /endpoint: field:type,field:type (or multiline fields under METHOD /endpoint:)";
+const isPortLine = (line) => /^port\s*:/i.test(line.trim());
+const parseRouteHeader = (line) => {
+    const separatorIndex = line.indexOf(":");
+    if (separatorIndex === -1) {
+        return undefined;
+    }
+    const rawLeft = line.slice(0, separatorIndex);
+    const rawFields = line.slice(separatorIndex + 1);
+    const [rawMethod, rawPath] = rawLeft.trim().split(/\s+/, 2);
+    const method = rawMethod?.toUpperCase();
+    const path = rawPath?.trim();
+    if (!method || !path || !path.startsWith("/")) {
+        return undefined;
+    }
+    return {
+        method,
+        path,
+        inlineFields: rawFields,
+    };
+};
 const parseField = (rawField) => {
     const [rawName, rawType] = rawField.split(":");
     const name = rawName?.trim();
@@ -35,38 +55,23 @@ const parseField = (rawField) => {
         type: type,
     };
 };
-const parseRoute = (line) => {
-    const separatorIndex = line.indexOf(":");
-    if (separatorIndex === -1) {
-        return { error: ROUTE_FORMAT_ERROR_MESSAGE };
-    }
-    const rawLeft = line.slice(0, separatorIndex);
-    const rawFields = line.slice(separatorIndex + 1);
-    if (!rawLeft || !rawFields) {
-        return { error: ROUTE_FORMAT_ERROR_MESSAGE };
-    }
-    const [rawMethod, rawPath] = rawLeft.trim().split(/\s+/, 2);
-    const method = rawMethod?.toUpperCase();
-    const path = rawPath?.trim();
+const parseRoute = ({ method, path, rawFields, }) => {
     if (!method || !path) {
-        return {
-            error: "Invalid route definition. Missing METHOD or /endpoint before ':'.",
-        };
-    }
-    if (!path.startsWith("/")) {
-        return { error: `Route path must start with '/': ${path}` };
+        return { error: ROUTE_FORMAT_ERROR_MESSAGE };
     }
     const fields = [];
-    for (const part of rawFields.split(",")) {
-        const trimmedPart = part.trim();
-        if (!trimmedPart) {
-            continue;
-        }
-        const parsedField = parseField(trimmedPart);
-        if ("error" in parsedField) {
-            return { error: parsedField.error };
+    for (const rawFieldLine of rawFields) {
+        for (const part of rawFieldLine.split(",")) {
+            const trimmedPart = part.trim();
+            if (!trimmedPart) {
+                continue;
+            }
+            const parsedField = parseField(trimmedPart);
+            if ("error" in parsedField) {
+                return { error: parsedField.error };
+            }
+            fields.push(parsedField);
         }
-        fields.push(parsedField);
     }
     if (fields.length === 0) {
         return { error: `Route ${method} ${path} has no valid fields.` };
@@ -77,13 +82,15 @@ const parseFexapiSchema = (schemaText) => {
     let port = DEFAULT_PORT;
     const routes = [];
     const errors = [];
-    const lines = schemaText
-        .split(/\r?\n/)
-        .map((line) => line.trim())
-        .filter((line) => line.length > 0 && !line.startsWith("#"));
-    for (const line of lines) {
-        if (line.toLowerCase().startsWith("port:")) {
-            const rawPort = line.slice(line.indexOf(":") + 1).trim();
+    const lines = schemaText.split(/\r?\n/);
+    for (let index = 0; index < lines.length; index += 1) {
+        const rawLine = lines[index] ?? "";
+        const trimmedLine = rawLine.trim();
+        if (!trimmedLine || trimmedLine.startsWith("#")) {
+            continue;
+        }
+        if (isPortLine(trimmedLine)) {
+            const rawPort = trimmedLine.slice(trimmedLine.indexOf(":") + 1).trim();
             const parsedPort = Number(rawPort);
             if (!Number.isInteger(parsedPort) ||
                 parsedPort < 1 ||
@@ -95,12 +102,45 @@ const parseFexapiSchema = (schemaText) => {
             }
             continue;
         }
-        const parsedRoute = parseRoute(line);
+        const header = parseRouteHeader(trimmedLine);
+        if (!header) {
+            errors.push(ROUTE_FORMAT_ERROR_MESSAGE);
+            continue;
+        }
+        const rawFields = [];
+        if (header.inlineFields.trim()) {
+            rawFields.push(header.inlineFields);
+        }
+        let lookaheadIndex = index + 1;
+        while (lookaheadIndex < lines.length) {
+            const lookaheadRawLine = lines[lookaheadIndex] ?? "";
+            const lookaheadTrimmedLine = lookaheadRawLine.trim();
+            if (!lookaheadTrimmedLine || lookaheadTrimmedLine.startsWith("#")) {
+                lookaheadIndex += 1;
+                continue;
+            }
+            if (isPortLine(lookaheadTrimmedLine) ||
+                parseRouteHeader(lookaheadTrimmedLine)) {
+                break;
+            }
+            if (/^\s+/.test(lookaheadRawLine)) {
+                rawFields.push(lookaheadTrimmedLine.replace(/^-+\s*/, ""));
+                lookaheadIndex += 1;
+                continue;
+            }
+            break;
+        }
+        const parsedRoute = parseRoute({
+            method: header.method,
+            path: header.path,
+            rawFields,
+        });
         if ("error" in parsedRoute) {
             errors.push(parsedRoute.error);
             continue;
         }
         routes.push(parsedRoute);
+        index = lookaheadIndex - 1;
     }
     if (routes.length === 0) {
         errors.push("No routes defined in schema.fexapi.");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fexapi",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Mock API generation CLI tool for local development and testing",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",