@vnphu/nestjs-api-explorer 0.1.0 → 0.2.0

package/dist/api-docs-parser.js

@@ -0,0 +1,234 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseDocsFile = parseDocsFile;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const KNOWN_TYPES = new Set(['string', 'number', 'boolean', 'array', 'object']);
+/**
+ * Rule tokens are either:
+ *   - bare keywords: required, isEmail, isUrl, isInt, isFloat, isDate,
+ *                    isBoolean, isString, isNumber, isArray, isObject, isUUID,
+ *                    isAlpha, isAlphanumeric, isNotEmpty
+ *   - parameterized: minLength(n), maxLength(n), min(n), max(n),
+ *                    default(val), isIn(a,b,c), matches(regex)
+ */
+const RULE_RE = /^(required|isEmail|isUrl|isInt|isFloat|isDate|isBoolean|isString|isNumber|isArray|isObject|isUUID|isAlpha|isAlphanumeric|isNotEmpty|minLength\([^)]+\)|maxLength\([^)]+\)|min\([^)]+\)|max\([^)]+\)|default\([^)]+\)|isIn\([^)]+\)|matches\([^)]+\))$/i;
+/**
+ * Split a comma-separated string while respecting parentheses.
+ * e.g.  "string, required, isIn(a,b,c), some description"
+ *   →   ["string", "required", "isIn(a,b,c)", "some description"]
+ */
+function splitTokens(raw) {
+    const tokens = [];
+    let current = '';
+    let depth = 0;
+    for (const ch of raw) {
+        if (ch === '(') {
+            depth++;
+            current += ch;
+        }
+        else if (ch === ')') {
+            depth--;
+            current += ch;
+        }
+        else if (ch === ',' && depth === 0) {
+            tokens.push(current.trim());
+            current = '';
+        }
+        else {
+            current += ch;
+        }
+    }
+    if (current.trim())
+        tokens.push(current.trim());
+    return tokens.filter(Boolean);
+}
+/**
+ * Parse one field line into a DocField.
+ *
+ * Format:  <name>: [type,] [rules...,] [description...]
+ *
+ * Examples:
+ *   email: string, required, isEmail
+ *   password: string, required, minLength(6), mật khẩu tối thiểu 6 ký tự
+ *   role: string, isIn(admin,user,guest)
+ *   page: number, default(1)
+ *   tags: array
+ *   meta: object
+ *   Authorization: required, Bearer token
+ */
+function parseField(line) {
+    const trimmed = line.trim();
+    if (!trimmed || !trimmed.includes(':'))
+        return null;
+    const colonIdx = trimmed.indexOf(':');
+    const name = trimmed.slice(0, colonIdx).trim();
+    const rest = trimmed.slice(colonIdx + 1).trim();
+    if (!name)
+        return null;
+    const tokens = splitTokens(rest);
+    let type = '';
+    let required = false;
+    const rules = [];
+    const descParts = [];
+    let isFirst = true;
+    for (const token of tokens) {
+        const t = token.trim();
+        if (!t)
+            continue;
+        // First token may be a type declaration
+        if (isFirst) {
+            isFirst = false;
+            if (KNOWN_TYPES.has(t.toLowerCase())) {
+                type = t.toLowerCase();
+                continue;
+            }
+        }
+        if (t.toLowerCase() === 'required') {
+            required = true;
+        }
+        else if (RULE_RE.test(t)) {
+            rules.push(t);
+        }
+        else {
+            descParts.push(t);
+        }
+    }
+    return {
+        name,
+        type,
+        required,
+        rules,
+        description: descParts.join(', '),
+    };
+}
+/**
+ * Parse a full docs file (absolute path) into a map of
+ * `"METHOD:path"` → RouteDoc.
+ */
+function parseDocsFile(filePath) {
+    const map = new Map();
+    let raw;
+    try {
+        const resolved = path.isAbsolute(filePath)
+            ? filePath
+            : path.resolve(process.cwd(), filePath);
+        raw = fs.readFileSync(resolved, 'utf-8');
+    }
+    catch {
+        return map;
+    }
+    const lines = raw.split(/\r?\n/);
+    let currentGroup = '';
+    let currentRoute = null;
+    let currentSection = null;
+    const flush = () => {
+        if (!currentRoute)
+            return;
+        map.set(`${currentRoute.method}:${currentRoute.path}`, currentRoute);
+        currentRoute = null;
+        currentSection = null;
+    };
+    for (const rawLine of lines) {
+        // ── Group heading  # Group Name ──────────────────────────────
+        if (/^#\s+/.test(rawLine) && !/^##\s+/.test(rawLine)) {
+            flush();
+            currentGroup = rawLine.replace(/^#\s+/, '').trim();
+            continue;
+        }
+        // ── Route heading  ## METHOD /path ───────────────────────────
+        const routeMatch = rawLine.match(/^##\s+(GET|POST|PUT|PATCH|DELETE|OPTIONS|HEAD)\s+(\/\S*)/i);
+        if (routeMatch) {
+            flush();
+            currentRoute = {
+                method: routeMatch[1].toUpperCase(),
+                path: routeMatch[2],
+                group: currentGroup,
+                description: '',
+                body: [],
+                query: [],
+                params: [],
+                headers: [],
+                response: [],
+            };
+            currentSection = null;
+            continue;
+        }
+        if (!currentRoute)
+            continue;
+        // ── Description lines  > text ─────────────────────────────────
+        if (/^>\s*/.test(rawLine)) {
+            const desc = rawLine.replace(/^>\s*/, '').trim();
+            currentRoute.description = currentRoute.description
+                ? currentRoute.description + '\n' + desc
+                : desc;
+            continue;
+        }
+        // ── Section headers  body: / query: / params: / headers: / response: ──
+        if (/^body:\s*$/.test(rawLine.trim())) {
+            currentSection = 'body';
+            continue;
+        }
+        if (/^query:\s*$/.test(rawLine.trim())) {
+            currentSection = 'query';
+            continue;
+        }
+        if (/^params:\s*$/.test(rawLine.trim())) {
+            currentSection = 'params';
+            continue;
+        }
+        if (/^headers:\s*$/.test(rawLine.trim())) {
+            currentSection = 'headers';
+            continue;
+        }
+        if (/^response:\s*$/.test(rawLine.trim())) {
+            currentSection = 'response';
+            continue;
+        }
+        // ── Separator / blank / comments — skip ──────────────────────
+        if (/^---/.test(rawLine.trim()) || rawLine.trim() === '')
+            continue;
+        // ── Field lines  (indented or starts with content) ────────────
+        if (currentSection && rawLine.match(/^\s+\S/)) {
+            const field = parseField(rawLine);
+            if (field)
+                currentRoute[currentSection].push(field);
+        }
+    }
+    flush();
+    return map;
+}
+//# sourceMappingURL=api-docs-parser.js.map

package/dist/api-docs-parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-docs-parser.js","sourceRoot":"","sources":["../src/api-docs-parser.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoIA,sCAmFC;AAvND,uCAAyB;AACzB,2CAA6B;AA4B7B,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;AAEhF;;;;;;;GAOG;AACH,MAAM,OAAO,GACX,wPAAwP,CAAC;AAE3P;;;;GAIG;AACH,SAAS,WAAW,CAAC,GAAW;IAC9B,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;QACrB,IAAI,EAAE,KAAK,GAAG,EAAE,CAAC;YAAC,KAAK,EAAE,CAAC;YAAC,OAAO,IAAI,EAAE,CAAC;QAAC,CAAC;aACtC,IAAI,EAAE,KAAK,GAAG,EAAE,CAAC;YAAC,KAAK,EAAE,CAAC;YAAC,OAAO,IAAI,EAAE,CAAC;QAAC,CAAC;aAC3C,IAAI,EAAE,KAAK,GAAG,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YACnC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;YAC5B,OAAO,GAAG,EAAE,CAAC;QACf,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;IACH,CAAC;IACD,IAAI,OAAO,CAAC,IAAI,EAAE;QAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAChD,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAS,UAAU,CAAC,IAAY;IAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC5B,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IAEpD,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;IAC/C,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAEhD,IAAI,CAAC,IAAI;QAAE,OAAO,IAAI,CAAC;IAEvB,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAEjC,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,SAAS,GAAa,EAAE,CAAC;IAE/B,IAAI,OAAO,GAAG,IAAI,CAAC;IACnB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QACvB,IAAI,CAAC,CAAC;YAAE,SAAS;QAEjB,wCAAwC;QACxC,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,GAAG,KAAK,CAAC;YAChB,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;gBACrC,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC;gBACvB,SAAS;YACX,CAAC;QACH,CAAC;QAED,IAAI,CAAC,CAAC,WAAW,EAAE,KAAK,UAAU,EAAE,CAAC;YACnC,QAAQ,GAAG,IAAI,CAAC;QAClB,CAAC;aAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3B,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChB,CAAC;aAAM,CAAC;YACN,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC;IACH,CAAC;IAED,OAAO;QACL,IAAI;QACJ,IAAI;QACJ,QAAQ;QACR,KAAK;QACL,WAAW,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;KAClC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAgB,aAAa,CAAC,QAAgB;IAC5C,MAAM,GAAG,GAAG,IAAI,GAAG,EAAoB,CAAC;IAExC,IAAI,GAAW,CAAC;IAChB,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;YACxC,CAAC,CAAC,QAAQ;YACV,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,CAAC,CAAC;QAC1C,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC3C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,GAAG,CAAC;IACb,CAAC;IAED,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAEjC,IAAI,YAAY,GAAG,EAAE,CAAC;IACtB,IAAI,YAAY,GAAoB,IAAI,CAAC;IACzC,IAAI,cAAc,GAAY,IAAI,CAAC;IAEnC,MAAM,KAAK,GAAG,GAAG,EAAE;QACjB,IAAI,CAAC,YAAY;YAAE,OAAO;QAC1B,GAAG,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,MAAM,IAAI,YAAY,CAAC,IAAI,EAAE,EAAE,YAAY,CAAC,CAAC;QACrE,YAAY,GAAG,IAAI,CAAC;QACpB,cAAc,GAAG,IAAI,CAAC;IACxB,CAAC,CAAC;IAEF,KAAK,MAAM,OAAO,IAAI,KAAK,EAAE,CAAC;QAC5B,gEAAgE;QAChE,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YACrD,KAAK,EAAE,CAAC;YACR,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YACnD,SAAS;QACX,CAAC;QAED,gEAAgE;QAChE,MAAM,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC,2DAA2D,CAAC,CAAC;QAC9F,IAAI,UAAU,EAAE,CAAC;YACf,KAAK,EAAE,CAAC;YACR,YAAY,GAAG;gBACb,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE;gBACnC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;gBACnB,KAAK,EAAE,YAAY;gBACnB,WAAW,EAAE,EAAE;gBACf,IAAI,EAAE,EAAE;gBACR,KAAK,EAAE,EAAE;gBACT,MAAM,EAAE,EAAE;gBACV,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,EAAE;aACb,CAAC;YACF,cAAc,GAAG,IAAI,CAAC;YACtB,SAAS;QACX,CAAC;QAED,IAAI,CAAC,YAAY;YAAE,SAAS;QAE5B,iEAAiE;QACjE,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YACjD,YAAY,CAAC,WAAW,GAAG,YAAY,CAAC,WAAW;gBACjD,CAAC,CAAC,YAAY,CAAC,WAAW,GAAG,IAAI,GAAG,IAAI;gBACxC,CAAC,CAAC,IAAI,CAAC;YACT,SAAS;QACX,CAAC;QAED,yEAAyE;QACzE,IAAI,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,EAAM,CAAC;YAAC,cAAc,GAAG,MAAM,CAAC;YAAK,SAAS;QAAC,CAAC;QACrF,IAAI,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,EAAK,CAAC;YAAC,cAAc,GAAG,OAAO,CAAC;YAAI,SAAS;QAAC,CAAC;QACrF,IAAI,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,EAAI,CAAC;YAAC,cAAc,GAAG,QAAQ,CAAC;YAAG,SAAS;QAAC,CAAC;QACrF,IAAI,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,EAAG,CAAC;YAAC,cAAc,GAAG,SAAS,CAAC;YAAE,SAAS;QAAC,CAAC;QACrF,IAAI,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;YAAC,cAAc,GAAG,UAAU,CAAC;YAAC,SAAS;QAAC,CAAC;QAErF,gEAAgE;QAChE,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,IAAI,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE;YAAE,SAAS;QAEnE,iEAAiE;QACjE,IAAI,cAAc,IAAI,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAG,CAAC;YAC/C,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;YAClC,IAAI,KAAK;gBAAE,YAAY,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAED,KAAK,EAAE,CAAC;IACR,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/api-explorer.html.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api-explorer.html.d.ts","sourceRoot":"","sources":["../src/api-explorer.html.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,uBAAuB,CAAC;AAEnE,wBAAgB,eAAe,CAAC,OAAO,EAAE,0BAA0B,GAAG,MAAM,CAsiC3E"}
+{"version":3,"file":"api-explorer.html.d.ts","sourceRoot":"","sources":["../src/api-explorer.html.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,uBAAuB,CAAC;AAEnE,wBAAgB,eAAe,CAAC,OAAO,EAAE,0BAA0B,GAAG,MAAM,CAmhD3E"}