@open-skills-hub/api 1.0.0

package/dist/server.js

@@ -0,0 +1,166 @@
+/**
+ * Open Skills Hub - API Server Configuration
+ */
+import Fastify from 'fastify';
+import cors from '@fastify/cors';
+import helmet from '@fastify/helmet';
+import rateLimit from '@fastify/rate-limit';
+import multipart from '@fastify/multipart';
+import { getConfig, getStorage, logger, } from '@open-skills-hub/core';
+import { errorHandler, notFoundHandler } from './middleware/error.js';
+import { requestLogger } from './middleware/logger.js';
+import { skillsRoutes } from './routes/skills.js';
+import { versionsRoutes } from './routes/versions.js';
+import { searchRoutes } from './routes/search.js';
+import { scanRoutes } from './routes/scan.js';
+import { feedbackRoutes } from './routes/feedback.js';
+import { auditRoutes } from './routes/audit.js';
+import { cacheRoutes } from './routes/cache.js';
+import { healthRoutes } from './routes/health.js';
+/**
+ * Create and configure the Fastify server
+ */
+export async function createServer(options) {
+    const config = getConfig().get();
+    const serverConfig = config.server;
+    const server = Fastify({
+        logger: false, // We use our own logger
+        trustProxy: serverConfig.trustProxy,
+        requestIdHeader: 'x-request-id',
+        requestIdLogLabel: 'requestId',
+        genReqId: () => `req_${Date.now().toString(36)}_${Math.random().toString(36).substr(2, 9)}`,
+        // Increase body size limit to support large skills with many files (e.g., XSD schemas)
+        bodyLimit: 50 * 1024 * 1024, // 50MB
+    });
+    // Register plugins
+    await registerPlugins(server, config);
+    // Register middleware
+    await registerMiddleware(server);
+    // Register routes
+    await registerRoutes(server);
+    // Set error handlers
+    server.setNotFoundHandler(notFoundHandler);
+    server.setErrorHandler(errorHandler);
+    return server;
+}
+/**
+ * Register Fastify plugins
+ */
+async function registerPlugins(server, config) {
+    // CORS
+    if (config.server.cors) {
+        await server.register(cors, {
+            origin: true,
+            methods: ['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS'],
+            allowedHeaders: ['Content-Type', 'Authorization', 'X-Request-ID'],
+            exposedHeaders: ['X-Request-ID', 'X-RateLimit-Limit', 'X-RateLimit-Remaining'],
+            credentials: true,
+            maxAge: 86400,
+        });
+    }
+    // Security headers
+    await server.register(helmet, {
+        contentSecurityPolicy: false, // Disabled for API
+        crossOriginResourcePolicy: { policy: 'cross-origin' },
+    });
+    // Rate limiting
+    if (config.rateLimit.enabled) {
+        await server.register(rateLimit, {
+            global: true,
+            max: config.rateLimit.max,
+            timeWindow: config.rateLimit.windowMs,
+            allowList: ['127.0.0.1'],
+            addHeadersOnExceeding: {
+                'x-ratelimit-limit': true,
+                'x-ratelimit-remaining': true,
+                'x-ratelimit-reset': true,
+            },
+            addHeaders: {
+                'x-ratelimit-limit': true,
+                'x-ratelimit-remaining': true,
+                'x-ratelimit-reset': true,
+                'retry-after': true,
+            },
+        });
+    }
+    // Multipart form data (for file uploads)
+    await server.register(multipart, {
+        limits: {
+            fileSize: 10 * 1024 * 1024, // 10MB max file size
+            files: 10, // Max number of files
+        },
+    });
+}
+/**
+ * Register middleware
+ */
+async function registerMiddleware(server) {
+    // Request logging
+    server.addHook('onRequest', requestLogger);
+    // Add request timing
+    server.addHook('onRequest', async (request) => {
+        request.startTime = Date.now();
+    });
+    // Add response timing header
+    server.addHook('onSend', async (request, reply) => {
+        if (request.startTime) {
+            const duration = Date.now() - request.startTime;
+            reply.header('X-Response-Time', `${duration}ms`);
+        }
+    });
+}
+/**
+ * Register API routes
+ */
+async function registerRoutes(server) {
+    // Health check (no prefix)
+    await server.register(healthRoutes);
+    // API v1 routes
+    await server.register(async (api) => {
+        await api.register(skillsRoutes, { prefix: '/skills' });
+        await api.register(versionsRoutes, { prefix: '/skills' });
+        await api.register(searchRoutes, { prefix: '/search' });
+        await api.register(scanRoutes, { prefix: '/scan' });
+        await api.register(feedbackRoutes, { prefix: '/feedback' });
+        await api.register(auditRoutes, { prefix: '/audit' });
+        await api.register(cacheRoutes, { prefix: '/cache' });
+    }, { prefix: '/v1' });
+}
+/**
+ * Start the server
+ */
+export async function startServer(server, options) {
+    const config = getConfig().get();
+    const host = options?.host ?? config.server.host;
+    const port = options?.port ?? config.server.port;
+    try {
+        // Initialize storage
+        const storage = await getStorage();
+        await storage.initialize();
+        logger.info('Storage initialized');
+        // Start listening
+        const address = await server.listen({ host, port });
+        logger.info(`Server started`, { address, mode: config.mode });
+        return address;
+    }
+    catch (error) {
+        logger.error('Failed to start server', { error });
+        throw error;
+    }
+}
+/**
+ * Stop the server gracefully
+ */
+export async function stopServer(server) {
+    try {
+        await server.close();
+        const storage = await getStorage();
+        await storage.close();
+        logger.info('Server stopped gracefully');
+    }
+    catch (error) {
+        logger.error('Error during server shutdown', { error });
+        throw error;
+    }
+}
+//# sourceMappingURL=server.js.map

package/dist/server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.js","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,OAA4B,MAAM,SAAS,CAAC;AACnD,OAAO,IAAI,MAAM,eAAe,CAAC;AACjC,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,OAAO,SAAS,MAAM,qBAAqB,CAAC;AAC5C,OAAO,SAAS,MAAM,oBAAoB,CAAC;AAE3C,OAAO,EACL,SAAS,EACT,UAAU,EACV,MAAM,GACP,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAOlD;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAAuB;IACxD,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC,GAAG,EAAE,CAAC;IACjC,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC;IAEnC,MAAM,MAAM,GAAG,OAAO,CAAC;QACrB,MAAM,EAAE,KAAK,EAAE,wBAAwB;QACvC,UAAU,EAAE,YAAY,CAAC,UAAU;QACnC,eAAe,EAAE,cAAc;QAC/B,iBAAiB,EAAE,WAAW;QAC9B,QAAQ,EAAE,GAAG,EAAE,CAAC,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE;QAC3F,uFAAuF;QACvF,SAAS,EAAE,EAAE,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO;KACrC,CAAC,CAAC;IAEH,mBAAmB;IACnB,MAAM,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEtC,sBAAsB;IACtB,MAAM,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAEjC,kBAAkB;IAClB,MAAM,cAAc,CAAC,MAAM,CAAC,CAAC;IAE7B,qBAAqB;IACrB,MAAM,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;IAC3C,MAAM,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;IAErC,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,eAAe,CAAC,MAAuB,EAAE,MAAuD;IAC7G,OAAO;IACP,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QACvB,MAAM,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE;YAC1B,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC;YAC7D,cAAc,EAAE,CAAC,cAAc,EAAE,eAAe,EAAE,cAAc,CAAC;YACjE,cAAc,EAAE,CAAC,cAAc,EAAE,mBAAmB,EAAE,uBAAuB,CAAC;YAC9E,WAAW,EAAE,IAAI;YACjB,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;IACL,CAAC;IAED,mBAAmB;IACnB,MAAM,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE;QAC5B,qBAAqB,EAAE,KAAK,EAAE,mBAAmB;QACjD,yBAAyB,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE;KACtD,CAAC,CAAC;IAEH,gBAAgB;IAChB,IAAI,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QAC7B,MAAM,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE;YAC/B,MAAM,EAAE,IAAI;YACZ,GAAG,EAAE,MAAM,CAAC,SAAS,CAAC,GAAG;YACzB,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ;YACrC,SAAS,EAAE,CAAC,WAAW,CAAC;YACxB,qBAAqB,EAAE;gBACrB,mBAAmB,EAAE,IAAI;gBACzB,uBAAuB,EAAE,IAAI;gBAC7B,mBAAmB,EAAE,IAAI;aAC1B;YACD,UAAU,EAAE;gBACV,mBAAmB,EAAE,IAAI;gBACzB,uBAAuB,EAAE,IAAI;gBAC7B,mBAAmB,EAAE,IAAI;gBACzB,aAAa,EAAE,IAAI;aACpB;SACF,CAAC,CAAC;IACL,CAAC;IAED,yCAAyC;IACzC,MAAM,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE;QAC/B,MAAM,EAAE;YACN,QAAQ,EAAE,EAAE,GAAG,IAAI,GAAG,IAAI,EAAE,qBAAqB;YACjD,KAAK,EAAE,EAAE,EAAE,sBAAsB;SAClC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,kBAAkB,CAAC,MAAuB;IACvD,kBAAkB;IAClB,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IAE3C,qBAAqB;IACrB,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;QAC5C,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,6BAA6B;IAC7B,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;QAChD,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,SAAS,CAAC;YAChD,KAAK,CAAC,MAAM,CAAC,iBAAiB,EAAE,GAAG,QAAQ,IAAI,CAAC,CAAC;QACnD,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,cAAc,CAAC,MAAuB;IACnD,2BAA2B;IAC3B,MAAM,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IAEpC,gBAAgB;IAChB,MAAM,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QAClC,MAAM,GAAG,CAAC,QAAQ,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QACxD,MAAM,GAAG,CAAC,QAAQ,CAAC,cAAc,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QAC1D,MAAM,GAAG,CAAC,QAAQ,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QACxD,MAAM,GAAG,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;QACpD,MAAM,GAAG,CAAC,QAAQ,CAAC,cAAc,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;QAC5D,MAAM,GAAG,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;QACtD,MAAM,GAAG,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;IACxD,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;AACxB,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,MAAuB,EAAE,OAAuB;IAChF,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC,GAAG,EAAE,CAAC;IACjC,MAAM,IAAI,GAAG,OAAO,EAAE,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;IACjD,MAAM,IAAI,GAAG,OAAO,EAAE,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;IAEjD,IAAI,CAAC;QACH,qBAAqB;QACrB,MAAM,OAAO,GAAG,MAAM,UAAU,EAAE,CAAC;QACnC,MAAM,OAAO,CAAC,UAAU,EAAE,CAAC;QAC3B,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAEnC,kBAAkB;QAClB,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACpD,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QAE9D,OAAO,OAAO,CAAC;IACjB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,KAAK,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAClD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,MAAuB;IACtD,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QAErB,MAAM,OAAO,GAAG,MAAM,UAAU,EAAE,CAAC;QACnC,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;QAEtB,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;IAC3C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,KAAK,CAAC,8BAA8B,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QACxD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC"}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@open-skills-hub/api",
+  "version": "1.0.0",
+  "description": "REST API server for Open Skills Hub",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "skills-api": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsx watch src/index.ts",
+    "start": "node dist/index.js",
+    "clean": "rm -rf dist"
+  },
+  "dependencies": {
+    "@open-skills-hub/core": "1.0.0",
+    "fastify": "^4.25.2",
+    "@fastify/cors": "^8.5.0",
+    "@fastify/helmet": "^11.1.1",
+    "@fastify/rate-limit": "^9.1.0",
+    "@fastify/multipart": "^8.1.0",
+    "zod": "^3.22.4",
+    "pino": "^8.17.2"
+  },
+  "devDependencies": {
+    "tsx": "^4.7.0",
+    "@types/node": "^20.10.6"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/OpenSkillsHub/open-skills-hub.git",
+    "directory": "packages/api"
+  },
+  "bugs": {
+    "url": "https://github.com/OpenSkillsHub/open-skills-hub/issues"
+  },
+  "homepage": "https://github.com/OpenSkillsHub/open-skills-hub#readme",
+  "author": "Open Skills Hub Team",
+  "license": "MIT"
+}

package/src/controllers/audit.ts

@@ -0,0 +1,175 @@
+/**
+ * Open Skills Hub - Audit Controller
+ */
+
+import type { FastifyRequest, FastifyReply } from 'fastify';
+import {
+  getStorage,
+  buildSkillFullName,
+  parseSkillFullName,
+  AppError,
+  ErrorCodes,
+} from '@open-skills-hub/core';
+import { sendSuccess } from '../middleware/error.js';
+import type {
+  SkillNameParam,
+  IdParam,
+  AuditQuery,
+} from '../middleware/validation.js';
+
+/**
+ * Get audit logs
+ */
+export async function getAuditLogs(
+  request: FastifyRequest<{ Querystring: AuditQuery }>,
+  reply: FastifyReply
+): Promise<void> {
+  const storage = await getStorage();
+  const { eventType, actor, resourceType, resourceName, from, to, cursor, limit } = request.query;
+
+  const result = await storage.getAuditLogs({
+    eventType,
+    actor,
+    resourceType,
+    resourceName,
+    from,
+    to,
+    cursor,
+    limit,
+  });
+
+  sendSuccess(request, reply, result.items, 200, result.pagination);
+}
+
+/**
+ * Get audit logs for a specific skill
+ */
+export async function getSkillAuditLogs(
+  request: FastifyRequest<{ Params: SkillNameParam; Querystring: AuditQuery }>,
+  reply: FastifyReply
+): Promise<void> {
+  const storage = await getStorage();
+  const { name } = request.params;
+  const { from, to, cursor, limit } = request.query;
+
+  // Parse name
+  const { scope, name: skillName } = parseSkillFullName(name);
+  const fullName = buildSkillFullName(skillName, scope);
+
+  const skill = await storage.getSkillByName(fullName);
+  if (!skill) {
+    throw new AppError(
+      ErrorCodes.SKILL_NOT_FOUND,
+      `Skill '${fullName}' not found`,
+      404
+    );
+  }
+
+  const result = await storage.getResourceAuditLogs('skill', skill.id, {
+    cursor,
+    limit,
+  });
+
+  // Filter by date if provided
+  let items = result.items;
+  if (from || to) {
+    items = items.filter(log => {
+      const timestamp = new Date(log.timestamp).getTime();
+      if (from && timestamp < new Date(from).getTime()) return false;
+      if (to && timestamp > new Date(to).getTime()) return false;
+      return true;
+    });
+  }
+
+  sendSuccess(request, reply, items, 200, result.pagination);
+}
+
+/**
+ * Get audit log by ID
+ */
+export async function getAuditLogById(
+  request: FastifyRequest<{ Params: IdParam }>,
+  reply: FastifyReply
+): Promise<void> {
+  const storage = await getStorage();
+  const { id } = request.params;
+
+  // Search for the log
+  const result = await storage.getAuditLogs({ limit: 1000 });
+  const log = result.items.find(l => l.id === id);
+
+  if (!log) {
+    throw new AppError(
+      ErrorCodes.SKILL_NOT_FOUND, // Using generic not found
+      `Audit log '${id}' not found`,
+      404
+    );
+  }
+
+  sendSuccess(request, reply, log);
+}
+
+/**
+ * Get audit statistics
+ */
+export async function getAuditStats(
+  request: FastifyRequest<{ Querystring: { days?: number } }>,
+  reply: FastifyReply
+): Promise<void> {
+  const storage = await getStorage();
+  const days = request.query.days ?? 30;
+
+  const fromDate = new Date();
+  fromDate.setDate(fromDate.getDate() - days);
+
+  const result = await storage.getAuditLogs({
+    from: fromDate.toISOString(),
+    limit: 10000,
+  });
+
+  const logs = result.items;
+
+  // Calculate stats
+  const byEventType: Record<string, number> = {};
+  const byActorType: Record<string, number> = {};
+  const byResult: Record<string, number> = {};
+  const byDay: Record<string, number> = {};
+
+  for (const log of logs) {
+    // By event type
+    byEventType[log.eventType] = (byEventType[log.eventType] || 0) + 1;
+
+    // By actor type
+    byActorType[log.actor.type] = (byActorType[log.actor.type] || 0) + 1;
+
+    // By result
+    byResult[log.result] = (byResult[log.result] || 0) + 1;
+
+    // By day
+    const day = log.timestamp.split('T')[0];
+    if (day) {
+      byDay[day] = (byDay[day] || 0) + 1;
+    }
+  }
+
+  // Convert byDay to sorted array
+  const dailyActivity = Object.entries(byDay)
+    .map(([date, count]) => ({ date, count }))
+    .sort((a, b) => a.date.localeCompare(b.date));
+
+  sendSuccess(request, reply, {
+    total: logs.length,
+    period: {
+      from: fromDate.toISOString(),
+      to: new Date().toISOString(),
+      days,
+    },
+    byEventType,
+    byActorType,
+    byResult,
+    dailyActivity,
+    successRate: logs.length > 0
+      ? (byResult['success'] || 0) / logs.length
+      : 0,
+  });
+}