@hamak/smart-data-dico 1.0.4 → 1.1.1

package/bin/cli.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 import { fileURLToPath } from 'url';
-import { dirname, join, resolve } from 'path';
+import { dirname, join, resolve } from 'node:path';
 import { existsSync, mkdirSync, cpSync } from 'fs';
 import { spawn } from 'child_process';
 
@@ -25,7 +25,7 @@ if (flags.help) {
 
   Usage:
     smart-data-dico [options]
-    npx smart-data-dico [options]
+    npx @hamak/smart-data-dico [options]
 
   Options:
     --port <number>     Server port (default: 3001)
@@ -59,14 +59,33 @@ if (!existsSync(dataDir)) {
   mkdirSync(join(dataDir, 'perspectives'), { recursive: true });
 }
 
-const serverTs = join(PKG_ROOT, 'backend', 'src', 'server.ts');
-const frontendDist = join(PKG_ROOT, 'frontend', 'dist');
-
-if (!existsSync(serverTs)) {
-  console.error('Error: Backend source not found.');
+// Determine how to run the server:
+// 1. Bundled (production/npm): single .mjs file, run with node — no deps needed
+// 2. Source (dev): TypeScript source, run with tsx
+const bundledServer = join(PKG_ROOT, 'backend', 'dist', 'server.mjs');
+const sourceServer = join(PKG_ROOT, 'backend', 'src', 'server.ts');
+
+let bin, binArgs;
+
+if (existsSync(bundledServer)) {
+  // Production: bundled server — all deps inlined, just node
+  bin = process.execPath; // 'node'
+  binArgs = [bundledServer];
+} else if (existsSync(sourceServer)) {
+  // Development: run TypeScript source via tsx
+  const tsxPaths = [
+    join(PKG_ROOT, 'node_modules', '.bin', 'tsx'),
+    join(PKG_ROOT, 'backend', 'node_modules', '.bin', 'tsx'),
+  ];
+  bin = tsxPaths.find(p => existsSync(p)) || 'npx';
+  binArgs = bin.endsWith('npx') ? ['tsx', sourceServer] : [sourceServer];
+} else {
+  console.error('Error: No server found (neither bundled nor source).');
   process.exit(1);
 }
 
+const frontendDist = join(PKG_ROOT, 'frontend', 'dist');
+
 console.log(`
   Smart Data Dictionary
 
@@ -76,16 +95,8 @@ console.log(`
   Frontend:   ${existsSync(frontendDist) ? 'bundled' : 'dev (use frontend dev server on :3000)'}
 `);
 
-// Find tsx binary — check local node_modules first, then global
-const tsxPaths = [
-  join(PKG_ROOT, 'node_modules', '.bin', 'tsx'),
-  join(PKG_ROOT, 'backend', 'node_modules', '.bin', 'tsx'),
-];
-let tsxBin = tsxPaths.find(p => existsSync(p)) || 'npx';
-const tsxArgs = tsxBin === 'npx' ? ['tsx', serverTs] : [serverTs];
-
-const child = spawn(tsxBin, tsxArgs, {
-  cwd: join(PKG_ROOT, 'backend'),
+const child = spawn(bin, binArgs, {
+  cwd: PKG_ROOT,
   env: {
     ...process.env,
     PORT: port,

package/package.json

@@ -1,46 +1,24 @@
 {
   "name": "@hamak/smart-data-dico",
-  "version": "1.0.4",
+  "version": "1.1.1",
   "description": "Collaborative data dictionary management system — model, document, and govern your data landscape",
   "type": "module",
   "bin": {
     "smart-data-dico": "bin/cli.js"
   },
   "scripts": {
-    "build": "cd frontend && npm run build",
+    "build": "npm run build:frontend && npm run build:backend",
+    "build:frontend": "cd frontend && npm run build",
+    "build:backend": "node scripts/build-backend.mjs",
     "start": "node bin/cli.js",
     "prepublishOnly": "npm run build"
   },
   "files": [
     "bin/",
-    "backend/src/",
-    "backend/package.json",
-    "backend/tsconfig.json",
+    "backend/dist/",
     "frontend/dist/",
     "data-dictionaries/stereotypes.yaml"
   ],
-  "dependencies": {
-    "tsx": "^4.0.0",
-    "cors": "^2.8.5",
-    "dotenv": "^16.3.1",
-    "express": "^4.18.2",
-    "jsonschema": "^1.4.1",
-    "jsonwebtoken": "^9.0.2",
-    "swagger-jsdoc": "^6.2.8",
-    "swagger-ui-express": "^5.0.1",
-    "yaml": "^2.3.1",
-    "@hamak/filesystem-server-api": "^0.5.2",
-    "@hamak/filesystem-server-impl": "^0.5.2",
-    "@hamak/filesystem-server-spi": "^0.5.2",
-    "@hamak/shared-utils": "^0.5.2",
-    "@hamak/ui-remote-git-fs-backend": "^0.5.2",
-    "@types/jsonwebtoken": "^9.0.9",
-    "@types/cors": "^2.8.13",
-    "@types/express": "^4.17.17",
-    "@types/node": "^20.17.50",
-    "@types/swagger-jsdoc": "^6.0.4",
-    "@types/swagger-ui-express": "^4.1.8"
-  },
   "keywords": [
     "data-dictionary",
     "data-modeling",
@@ -57,5 +35,28 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/amah/smart-data-dico.git"
+  },
+  "devDependencies": {
+    "@hamak/filesystem-server-api": "^0.5.2",
+    "@hamak/filesystem-server-impl": "^0.5.2",
+    "@hamak/filesystem-server-spi": "^0.5.2",
+    "@hamak/shared-utils": "^0.5.2",
+    "@hamak/ui-remote-git-fs-backend": "^0.5.2",
+    "@types/cors": "^2.8.13",
+    "@types/express": "^4.17.17",
+    "@types/jsonwebtoken": "^9.0.9",
+    "@types/node": "^20.17.50",
+    "@types/swagger-jsdoc": "^6.0.4",
+    "@types/swagger-ui-express": "^4.1.8",
+    "cors": "^2.8.5",
+    "dotenv": "^16.3.1",
+    "esbuild": "^0.27.4",
+    "express": "^4.18.2",
+    "jsonschema": "^1.4.1",
+    "jsonwebtoken": "^9.0.2",
+    "swagger-jsdoc": "^6.2.8",
+    "swagger-ui-express": "^5.0.1",
+    "tsx": "^4.0.0",
+    "yaml": "^2.3.1"
   }
 }

package/backend/package.json

@@ -1,51 +0,0 @@
-{
-  "name": "data-dictionary-backend",
-  "version": "0.1.0",
-  "description": "Backend for Data Dictionary Management System",
-  "type": "module",
-  "main": "dist/server.js",
-  "scripts": {
-    "start": "node dist/server.js",
-    "dev": "nodemon --exec tsx src/server.ts",
-    "build": "tsc",
-    "test": "jest",
-    "lint": "eslint . --ext .ts",
-    "test:coverage": "jest --coverage"
-  },
-  "dependencies": {
-    "@hamak/filesystem-server-api": "^0.5.2",
-    "@hamak/filesystem-server-impl": "^0.5.2",
-    "@hamak/filesystem-server-spi": "^0.5.2",
-    "@hamak/shared-utils": "^0.5.2",
-    "@hamak/ui-remote-git-fs-backend": "^0.5.2",
-    "@types/jsonwebtoken": "^9.0.9",
-    "cors": "^2.8.5",
-    "dotenv": "^16.3.1",
-    "express": "^4.18.2",
-    "jsonschema": "^1.4.1",
-    "jsonwebtoken": "^9.0.2",
-    "swagger-jsdoc": "^6.2.8",
-    "swagger-ui-express": "^5.0.1",
-    "yaml": "^2.3.1"
-  },
-  "devDependencies": {
-    "@jest/globals": "^30.3.0",
-    "@types/cors": "^2.8.13",
-    "@types/express": "^4.17.17",
-    "@types/jest": "^29.5.3",
-    "@types/node": "^20.17.50",
-    "@types/supertest": "^6.0.3",
-    "@types/swagger-jsdoc": "^6.0.4",
-    "@types/swagger-ui-express": "^4.1.8",
-    "@typescript-eslint/eslint-plugin": "^6.0.0",
-    "@typescript-eslint/parser": "^6.0.0",
-    "eslint": "^8.45.0",
-    "jest": "^29.6.2",
-    "nodemon": "^3.0.1",
-    "supertest": "^7.1.1",
-    "ts-jest": "^29.1.1",
-    "ts-node": "^10.9.1",
-    "tsx": "^4.21.0",
-    "typescript": "^5.1.6"
-  }
-}

package/backend/src/__tests__/integration/api.test.ts

@@ -1,149 +0,0 @@
-import { NextFunction, Request, Response } from 'express';
-import request from 'supertest';
-
-import { UserRole } from '../../middleware/auth.js';
-import app from '../../server.js';
-
-// Extend Request type to include user property
-declare global {
-  namespace Express {
-    interface Request {
-      user?: {
-        id: string;
-        role: string;
-      };
-    }
-  }
-}
-
-// Mock auth middleware to bypass authentication
-jest.mock('../../middleware/auth', () => ({
-  UserRole: {
-    ADMIN: 'admin',
-    EDITOR: 'editor',
-    VIEWER: 'viewer',
-  },
-  authenticate: jest.fn().mockImplementation((_roles: string[]) => (req: Request, _res: Response, next: NextFunction) => {
-    req.user = { id: 'test-user', role: 'admin' };
-    next();
-  }),
-}));
-
-// Mock JWT auth to bypass token verification
-jest.mock('../../middleware/jwtAuth', () => ({
-  verifyToken: jest.fn().mockImplementation((req: Request, _res: Response, next: NextFunction) => {
-    req.user = { id: 'test-user', role: 'admin' };
-    next();
-  }),
-  authorizeJwt: jest.fn().mockImplementation((_roles: string[]) => (req: Request, _res: Response, next: NextFunction) => {
-    req.user = { id: 'test-user', role: 'admin' };
-    next();
-  }),
-}));
-
-// Mock services (uses __mocks__ directory auto-mocks)
-jest.mock('../../services/dictionaryService');
-jest.mock('../../services/entityService');
-jest.mock('../../services/serviceService');
-jest.mock('../../services/versionService');
-jest.mock('../../utils/logger');
-
-describe('API Integration Tests', () => {
-  describe('Health & Status', () => {
-    it('should return health status', async () => {
-      const response = await request(app).get('/health');
-      expect(response.status).toBe(200);
-      expect(response.body).toHaveProperty('status', 'ok');
-    });
-  });
-
-  describe('Service Endpoints', () => {
-    it('GET /api/services should return service list', async () => {
-      const response = await request(app).get('/api/services');
-      expect(response.status).toBe(200);
-      expect(response.body).toHaveProperty('data');
-      expect(Array.isArray(response.body.data)).toBe(true);
-      expect(response.body.data).toContain('user-service');
-    });
-
-    it('GET /api/services/:service/entities should return entities', async () => {
-      const response = await request(app).get('/api/services/user-service/entities');
-      expect(response.status).toBe(200);
-    });
-
-    it('GET /api/services/:service/entities/:entity should return entity schema', async () => {
-      const response = await request(app).get('/api/services/user-service/entities/User');
-      expect(response.status).toBe(200);
-    });
-
-    it('POST /api/services/:service/entities should create entity', async () => {
-      const response = await request(app)
-        .post('/api/services/user-service/entities')
-        .send({
-          uuid: 'a38d1597-cc4f-4934-bb08-c876c023f693',
-          name: 'NewEntity',
-          description: 'A new entity',
-          attributes: [{ uuid: 'b49e2608-dd5f-4045-aa09-d464c234e694', name: 'id', description: 'ID', type: 'string', required: true }],
-        });
-      expect(response.status).toBe(201);
-    });
-
-    it('PUT /api/services/:service/entities/:entity should update entity', async () => {
-      const response = await request(app)
-        .put('/api/services/user-service/entities/User')
-        .send({
-          uuid: 'a38d1597-cc4f-4934-bb08-c876c023f693',
-          name: 'User',
-          description: 'Updated user',
-          attributes: [{ uuid: 'b49e2608-dd5f-4045-aa09-d464c234e694', name: 'id', description: 'ID', type: 'string', required: true }],
-        });
-      expect(response.status).toBe(200);
-    });
-
-    it('DELETE /api/services/:service/entities/:entity should delete entity', async () => {
-      const response = await request(app).delete('/api/services/user-service/entities/User');
-      expect(response.status).toBe(200);
-    });
-  });
-
-  describe('Search & Graph', () => {
-    it('GET /api/search should return results', async () => {
-      const response = await request(app).get('/api/search?q=user');
-      expect(response.status).toBe(200);
-    });
-
-    it('GET /api/graph/:service should return graph data', async () => {
-      const response = await request(app).get('/api/graph/user-service');
-      expect(response.status).toBe(200);
-    });
-  });
-
-  describe('Version Control', () => {
-    it('POST /api/commit should commit changes', async () => {
-      const response = await request(app)
-        .post('/api/commit')
-        .send({ message: 'Test commit' });
-      expect(response.status).toBe(200);
-    });
-
-    it('GET /api/history should return commit history', async () => {
-      const response = await request(app).get('/api/history');
-      expect(response.status).toBe(200);
-    });
-
-    it('POST /api/revert should revert to commit', async () => {
-      const response = await request(app)
-        .post('/api/revert')
-        .send({ commitHash: 'mock-commit-1' });
-      expect(response.status).toBe(200);
-    });
-  });
-
-  describe('Relationship Endpoints', () => {
-    it('GET /api/packages/:packageName/relationships should return relationships', async () => {
-      const response = await request(app).get('/api/packages/user-service/relationships');
-      expect(response.status).toBe(200);
-      expect(response.body).toHaveProperty('data');
-    });
-  });
-});

package/backend/src/__tests__/setup.ts

@@ -1,24 +0,0 @@
-import dotenv from 'dotenv';
-
-// Load environment variables for testing
-dotenv.config({ path: '.env.test' });
-
-// Mock logger to prevent console output during tests
-jest.mock('../utils/logger', () => ({
-  logger: {
-    info: jest.fn(),
-    error: jest.fn(),
-    warn: jest.fn(),
-    debug: jest.fn(),
-  },
-}));
-
-// Global test setup
-beforeAll(() => {
-  // Setup any global test requirements here
-});
-
-// Global test teardown
-afterAll(() => {
-  // Clean up any global test resources here
-});

package/backend/src/__tests__/utils/testUtils.ts

@@ -1,76 +0,0 @@
-import { Express } from 'express';
-import request from 'supertest';
-import fs from 'fs';
-import path from 'path';
-
-/**
- * Creates a test client for making HTTP requests to the Express app
- * @param app Express application
- * @returns Supertest instance
- */
-export const createTestClient = (app: Express) => {
-  return request(app);
-};
-
-/**
- * Creates a temporary test directory for file operations
- * @param dirPath Directory path to create
- */
-export const createTestDirectory = (dirPath: string): void => {
-  if (!fs.existsSync(dirPath)) {
-    fs.mkdirSync(dirPath, { recursive: true });
-  }
-};
-
-/**
- * Removes a test directory and all its contents
- * @param dirPath Directory path to remove
- */
-export const removeTestDirectory = (dirPath: string): void => {
-  if (fs.existsSync(dirPath)) {
-    fs.rmSync(dirPath, { recursive: true, force: true });
-  }
-};
-
-/**
- * Creates a test YAML file with the given content
- * @param filePath Path to create the file
- * @param content Content to write to the file
- */
-export const createTestYamlFile = (filePath: string, content: string): void => {
-  const dir = path.dirname(filePath);
-  if (!fs.existsSync(dir)) {
-    fs.mkdirSync(dir, { recursive: true });
-  }
-  fs.writeFileSync(filePath, content);
-};
-
-/**
- * Generates a random entity for testing
- * @param overrides Properties to override in the generated entity
- * @returns A test entity
- */
-export const generateTestEntity = (overrides = {}) => {
-  return {
-    id: `test-entity-${Date.now()}`,
-    name: 'TestEntity',
-    description: 'A test entity for unit tests',
-    microservice: 'test-service',
-    version: '1.0.0',
-    attributes: [
-      {
-        name: 'id',
-        description: 'Primary identifier',
-        type: 'string',
-        required: true,
-      },
-      {
-        name: 'name',
-        description: 'Entity name',
-        type: 'string',
-        required: true,
-      },
-    ],
-    ...overrides,
-  };
-};

package/backend/src/adapters/EntityFileAdapter.ts

@@ -1,154 +0,0 @@
-/**
- * EntityFileAdapter
- *
- * Wraps @hamak/filesystem-server-impl's WorkspaceManager to provide
- * the same API as current fileOperations.ts functions.
- * Uses dynamic imports since the framework packages are ESM-only.
- */
-
-import path from 'path';
-import YAML from 'yaml';
-import { logger } from '../utils/logger.js';
-import { Entity, validateEntity } from '../models/EntitySchema.js';
-import { generateEntityFilename } from '../utils/uuid.js';
-import { config } from '../kernel/config.js';
-
-// Lazy-loaded framework modules (ESM)
-let WorkspaceManager: any;
-let FileRouter: any;
-let FileInfoEnricherRegistry: any;
-
-let workspaceManager: any = null;
-let enricherRegistry: any = null;
-let fileRouter: any = null;
-
-/**
- * Initialize the framework filesystem components.
- * Must be called once at startup (async because of ESM dynamic imports).
- */
-export async function initializeFileSystem(): Promise<{
-  workspaceManager: any;
-  fileRouter: any;
-  enricherRegistry: any;
-}> {
-  if (workspaceManager) {
-    return { workspaceManager, fileRouter, enricherRegistry };
-  }
-
-  const fsModule = await import('@hamak/filesystem-server-impl');
-  WorkspaceManager = fsModule.WorkspaceManager;
-  FileRouter = fsModule.FileRouter;
-  FileInfoEnricherRegistry = fsModule.FileInfoEnricherRegistry;
-
-  const baseDirectory = config.dataDir;
-
-  const workspacesConfig: Record<string, string> = {
-    dictionaries: '.',
-  };
-
-  workspaceManager = new WorkspaceManager(workspacesConfig, { baseDirectory });
-  enricherRegistry = new FileInfoEnricherRegistry();
-  fileRouter = new FileRouter(workspaceManager, { enricherRegistry });
-
-  logger.info('Framework filesystem initialized', { baseDirectory });
-
-  return { workspaceManager, fileRouter, enricherRegistry };
-}
-
-/**
- * Get the Express router for the /fs endpoint.
- */
-export function getFileRouter(): any {
-  if (!fileRouter) {
-    throw new Error('FileRouter not initialized. Call initializeFileSystem() first.');
-  }
-  return fileRouter.router;
-}
-
-/**
- * Get the enricher registry for registering file info enrichers.
- */
-export function getEnricherRegistry(): any {
-  if (!enricherRegistry) {
-    throw new Error('EnricherRegistry not initialized. Call initializeFileSystem() first.');
-  }
-  return enricherRegistry;
-}
-
-/**
- * Get the workspace manager instance.
- */
-export function getWorkspaceManager(): any {
-  if (!workspaceManager) {
-    throw new Error('WorkspaceManager not initialized. Call initializeFileSystem() first.');
-  }
-  return workspaceManager;
-}
-
-/**
- * Read an entity file using WorkspaceManager.
- */
-export async function readEntityViaAdapter(
-  packageName: string,
-  entityName: string
-): Promise<Entity | null> {
-  if (!workspaceManager) {
-    return null;
-  }
-
-  try {
-    const dirPath = `microservices/${packageName}`;
-    const files = await workspaceManager.listFiles('dictionaries', dirPath);
-
-    for (const file of files) {
-      if (!file.name.endsWith('.yaml') && !file.name.endsWith('.yml')) {
-        continue;
-      }
-      if (file.name === 'metadata.yaml' || file.name === 'relationships.yaml') {
-        continue;
-      }
-
-      const filePath = `${dirPath}/${file.name}`;
-      const content = await workspaceManager.readFile('dictionaries', filePath);
-      const entity = YAML.parse(content) as Entity;
-
-      if (entity.name === entityName) {
-        return entity;
-      }
-    }
-
-    return null;
-  } catch (error) {
-    logger.error(`EntityFileAdapter.readEntity error: ${error}`);
-    return null;
-  }
-}
-
-/**
- * Write an entity file using WorkspaceManager.
- */
-export async function writeEntityViaAdapter(entity: Entity, packageName: string): Promise<boolean> {
-  if (!workspaceManager) {
-    return false;
-  }
-
-  try {
-    const validation = validateEntity(entity);
-    if (!validation.valid) {
-      logger.error(`Invalid entity: ${validation.errors.join(', ')}`);
-      return false;
-    }
-
-    const filename = generateEntityFilename(entity.uuid, entity.name);
-    const filePath = `microservices/${packageName}/${filename}`;
-    const yamlContent = YAML.stringify(entity);
-
-    await workspaceManager.writeFile('dictionaries', filePath, yamlContent);
-    logger.info(`Entity written via adapter: ${filePath}`);
-
-    return true;
-  } catch (error) {
-    logger.error(`EntityFileAdapter.writeEntity error: ${error}`);
-    return false;
-  }
-}

package/backend/src/adapters/YamlFileInfoEnricher.ts

@@ -1,52 +0,0 @@
-/**
- * YamlFileInfoEnricher
- *
- * FileInfoEnricher that parses .yaml files and adds entity metadata
- * (entity name, uuid) to the file info response.
- */
-
-import YAML from 'yaml';
-import { logger } from '../utils/logger.js';
-
-export interface YamlEnrichedData {
-  entityName?: string;
-  entityUuid?: string;
-}
-
-/**
- * Creates a YAML file info enricher compatible with
- * @hamak/filesystem-server-impl's FileInfoEnricherRegistry.
- */
-export function createYamlFileInfoEnricher() {
-  return {
-    name: 'yaml-entity',
-    extensionKey: 'entity',
-
-    canEnrich(fileInfo: any): boolean {
-      const name: string = fileInfo?.name || '';
-      return name.endsWith('.yaml') || name.endsWith('.yml');
-    },
-
-    async enrich(fileInfo: any, context: any): Promise<YamlEnrichedData | null> {
-      try {
-        const content = context?.content;
-        if (!content) {
-          return null;
-        }
-
-        const parsed = YAML.parse(content);
-        if (!parsed || typeof parsed !== 'object') {
-          return null;
-        }
-
-        return {
-          entityName: parsed.name,
-          entityUuid: parsed.uuid,
-        };
-      } catch (error) {
-        logger.debug(`YamlFileInfoEnricher: could not parse ${fileInfo?.name}: ${error}`);
-        return null;
-      }
-    },
-  };
-}