fexapi 0.1.2 → 0.1.3

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)

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.3",
   "description": "Mock API generation CLI tool for local development and testing",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",