@map-our-system/scanner-server 1.0.0

package/README.md

@@ -0,0 +1,88 @@
+# @map-our-system/scanner
+
+Pacote npm que expoe um servidor HTTP no projeto externo. Quando o botao "Scan" e clicado no frontend do Map Our System, o backend envia um webhook para este servidor, que le os arquivos por pasta e envia o snapshot JSONB de volta a API.
+
+## Instalacao
+
+```bash
+npm install @map-our-system/scanner
+```
+
+## Configuracao
+
+Crie um arquivo `.map-our-system.json` na raiz do seu projeto:
+
+```json
+{
+  "apiKey": "sua-api-key-aqui",
+  "projectId": "uuid-do-projeto",
+  "apiUrl": "http://localhost:3001",
+  "port": 4000,
+  "scanPaths": ["."],
+  "ignorePaths": ["node_modules", ".git", "dist", ".next", "build"]
+}
+```
+
+| Campo         | Obrigatorio | Padrao                                             | Descricao                                      |
+|---------------|-------------|---------------------------------------------------|------------------------------------------------|
+| `apiKey`      | sim         | -                                                 | Gerado automaticamente ao criar o projeto      |
+| `projectId`   | sim         | -                                                 | UUID do projeto no Map Our System              |
+| `apiUrl`      | sim         | -                                                 | URL base da API NestJS                         |
+| `port`        | nao         | `4000`                                            | Porta do servidor scanner                      |
+| `scanPaths`   | nao         | `["."]`                                           | Pastas a escanear (relativas a raiz)           |
+| `ignorePaths` | nao         | `["node_modules", ".git", "dist", ".next", ...]`  | Pastas/arquivos a ignorar                      |
+
+## Uso
+
+```bash
+# Iniciar o servidor scanner (porta do config ou padrao 4000)
+npx map-our-system start
+
+# Iniciar em porta especifica
+npx map-our-system start --port 5000
+```
+
+## Fluxo
+
+```
+[Frontend: botao Scan]
+        |
+        v
+[NestJS API: POST /user-projects/:id/scan]
+        |
+        v
+[Webhook: POST http://seu-servidor:4000/scan]
+        |
+        v
+[Scanner: le arquivos por pasta]
+        |
+        v
+[POST /user-projects/:id/code-snapshot com X-API-Key]
+        |
+        v
+[NestJS API: salva JSONB no PostgreSQL]
+        |
+        v
+[Frontend: exibe arvore de arquivos]
+```
+
+## Estrutura do JSONB salvo
+
+```json
+{
+  "src/components": {
+    "Button.tsx": "export function Button...",
+    "Header.tsx": "export function Header..."
+  },
+  "src/lib": {
+    "api.ts": "const API_BASE_URL..."
+  }
+}
+```
+
+## Endpoints do servidor scanner
+
+| Metodo | Path      | Descricao                            |
+|--------|-----------|--------------------------------------|
+| POST   | `/scan`   | Dispara leitura e envio do snapshot  |
+| GET    | `/health` | Verifica se o servidor esta rodando  |

package/dist/api-client.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendSnapshot = sendSnapshot;
+async function sendSnapshot(config, filesData) {
+    const url = `${config.apiUrl}/user-projects/${config.projectId}/code-snapshot`;
+    const response = await fetch(url, {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/json',
+            'x-api-key': config.apiKey,
+        },
+        body: JSON.stringify({ filesData }),
+    });
+    if (!response.ok) {
+        const text = await response.text().catch(() => '');
+        throw new Error(`API responded with ${response.status}: ${text}`);
+    }
+}

package/dist/cli.js

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_1 = require("./config");
+const server_1 = require("./server");
+const args = process.argv.slice(2);
+const portArgIndex = args.indexOf('--port');
+const portOverride = portArgIndex !== -1 ? parseInt(args[portArgIndex + 1], 10) : undefined;
+let port;
+try {
+    const config = (0, config_1.loadConfig)();
+    port = portOverride ?? config.port;
+}
+catch {
+    port = portOverride ?? 4000;
+}
+const app = (0, server_1.createServer)();
+app.listen(port, () => {
+    console.log(`[map-our-system/scanner] Server listening on http://localhost:${port}`);
+    console.log(`[map-our-system/scanner] POST http://localhost:${port}/scan  to trigger a scan`);
+});

package/dist/config.js

@@ -0,0 +1,65 @@
+"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.loadConfig = loadConfig;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const CONFIG_FILE = '.map-our-system.json';
+const DEFAULTS = {
+    port: 4000,
+    scanPaths: ['.'],
+    ignorePaths: ['node_modules', '.git', 'dist', '.next', 'build', 'coverage'],
+};
+function loadConfig() {
+    const configPath = path.resolve(process.cwd(), CONFIG_FILE);
+    if (!fs.existsSync(configPath)) {
+        throw new Error(`Config file not found: ${configPath}\nCreate a ${CONFIG_FILE} file at the root of your project.`);
+    }
+    const raw = fs.readFileSync(configPath, 'utf-8');
+    const parsed = JSON.parse(raw);
+    if (!parsed.apiKey)
+        throw new Error('Missing required config field: apiKey');
+    if (!parsed.projectId)
+        throw new Error('Missing required config field: projectId');
+    if (!parsed.apiUrl)
+        throw new Error('Missing required config field: apiUrl');
+    return {
+        ...DEFAULTS,
+        ...parsed,
+        apiKey: parsed.apiKey,
+        projectId: parsed.projectId,
+        apiUrl: parsed.apiUrl.replace(/\/$/, ''),
+    };
+}

package/dist/file-scanner.js

@@ -0,0 +1,89 @@
+"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.scanFiles = scanFiles;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+function shouldIgnore(name, ignorePaths) {
+    return ignorePaths.some((pattern) => name === pattern || name.startsWith(pattern));
+}
+function readDirectory(dirPath, baseDir, ignorePaths, result) {
+    let entries;
+    try {
+        entries = fs.readdirSync(dirPath, { withFileTypes: true });
+    }
+    catch {
+        return;
+    }
+    for (const entry of entries) {
+        if (shouldIgnore(entry.name, ignorePaths))
+            continue;
+        const fullPath = path.join(dirPath, entry.name);
+        if (entry.isDirectory()) {
+            readDirectory(fullPath, baseDir, ignorePaths, result);
+        }
+        else if (entry.isFile()) {
+            // Skip binary files and very large files (>512 KB)
+            const stats = fs.statSync(fullPath);
+            if (stats.size > 512 * 1024)
+                continue;
+            let content;
+            try {
+                content = fs.readFileSync(fullPath, 'utf-8');
+            }
+            catch {
+                continue; // Skip binary or unreadable files
+            }
+            const relativePath = path.relative(baseDir, fullPath);
+            const folder = path.dirname(relativePath).replace(/\\/g, '/');
+            const fileName = path.basename(relativePath);
+            if (!result[folder]) {
+                result[folder] = {};
+            }
+            result[folder][fileName] = content;
+        }
+    }
+}
+function scanFiles(scanPaths, ignorePaths) {
+    const result = {};
+    const baseDir = process.cwd();
+    for (const scanPath of scanPaths) {
+        const fullScanPath = path.resolve(baseDir, scanPath);
+        if (!fs.existsSync(fullScanPath))
+            continue;
+        readDirectory(fullScanPath, baseDir, ignorePaths, result);
+    }
+    return result;
+}

package/dist/server.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createServer = createServer;
+const express_1 = __importDefault(require("express"));
+const api_client_1 = require("./api-client");
+const config_1 = require("./config");
+const file_scanner_1 = require("./file-scanner");
+function createServer() {
+    const app = (0, express_1.default)();
+    app.use(express_1.default.json());
+    app.post('/scan', async (_req, res) => {
+        let config;
+        try {
+            config = (0, config_1.loadConfig)();
+        }
+        catch (err) {
+            const message = err instanceof Error ? err.message : 'Config error';
+            res.status(500).json({ error: message });
+            return;
+        }
+        try {
+            console.log('[scanner] Starting file scan...');
+            const filesData = (0, file_scanner_1.scanFiles)(config.scanPaths, config.ignorePaths);
+            const folderCount = Object.keys(filesData).length;
+            const fileCount = Object.values(filesData).reduce((acc, files) => acc + Object.keys(files).length, 0);
+            console.log(`[scanner] Found ${fileCount} files in ${folderCount} folders. Sending to API...`);
+            await (0, api_client_1.sendSnapshot)(config, filesData);
+            console.log('[scanner] Snapshot sent successfully.');
+            res.status(200).json({ message: 'Scan completed', files: fileCount, folders: folderCount });
+        }
+        catch (err) {
+            const message = err instanceof Error ? err.message : 'Scan failed';
+            console.error(`[scanner] Error: ${message}`);
+            res.status(500).json({ error: message });
+        }
+    });
+    app.get('/health', (_req, res) => {
+        res.json({ status: 'ok' });
+    });
+    return app;
+}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@map-our-system/scanner-server",
+  "version": "1.0.0",
+  "description": "Scanner HTTP server — reads project files by folder and sends JSONB snapshots to Map Our System API",
+  "main": "dist/cli.js",
+  "bin": {
+    "map-our-system": "dist/cli.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "start": "node dist/cli.js",
+    "dev": "ts-node src/cli.ts"
+  },
+  "files": [
+    "dist/",
+    "README.md"
+  ],
+  "keywords": [
+    "scanner",
+    "http",
+    "server",
+    "map-our-system"
+  ],
+  "license": "UNLICENSED",
+  "dependencies": {
+    "express": "^4.21.2"
+  },
+  "devDependencies": {
+    "@types/express": "^5.0.0",
+    "@types/node": "^22.0.0",
+    "typescript": "^5.7.0",
+    "ts-node": "^10.9.2"
+  }
+}