@nahisaho/yata-ui 1.7.0

package/bin/yata-ui.js

@@ -0,0 +1,42 @@
+#!/usr/bin/env node
+/**
+ * YATA UI CLI
+ *
+ * Start the YATA Knowledge Graph Web UI server.
+ *
+ * @see REQ-YI-WEB-001
+ */
+
+import { createYataUIServer } from '../dist/index.js';
+
+const args = process.argv.slice(2);
+const portArg = args.find(a => a.startsWith('--port='));
+const port = portArg ? parseInt(portArg.split('=')[1], 10) : 3000;
+
+const server = createYataUIServer({ port });
+
+// Demo data provider
+server.setDataProvider(async () => ({
+  nodes: [
+    { id: '1', label: 'UserService', type: 'class', namespace: 'app.services' },
+    { id: '2', label: 'UserRepository', type: 'interface', namespace: 'app.repositories' },
+    { id: '3', label: 'User', type: 'entity', namespace: 'app.domain' },
+    { id: '4', label: 'createUser', type: 'function', namespace: 'app.services' },
+  ],
+  edges: [
+    { id: 'e1', source: '1', target: '2', type: 'uses', label: 'uses' },
+    { id: 'e2', source: '1', target: '3', type: 'returns', label: 'returns' },
+    { id: 'e3', source: '4', target: '3', type: 'creates', label: 'creates' },
+  ],
+}));
+
+server.start().then(() => {
+  console.log(`🌐 YATA UI running at ${server.getUrl()}`);
+  console.log('Press Ctrl+C to stop');
+});
+
+process.on('SIGINT', async () => {
+  console.log('\nShutting down...');
+  await server.stop();
+  process.exit(0);
+});

package/dist/index.d.ts

@@ -0,0 +1,203 @@
+/**
+ * YATA UI Server
+ *
+ * Web-based visualization and management interface for YATA knowledge graphs.
+ *
+ * @packageDocumentation
+ * @module @nahisaho/yata-ui
+ *
+ * @see REQ-YI-WEB-001 - Web-based Visualization
+ * @see REQ-YI-WEB-002 - Interactive Graph Editing
+ * @see REQ-YI-WEB-003 - Real-time Updates
+ * @see DES-YATA-IMPROVEMENTS-001 - Design Document
+ */
+import { Express } from 'express';
+/**
+ * UI Server configuration
+ * @see REQ-YI-WEB-001
+ */
+export interface UIServerConfig {
+    /** Server port */
+    port: number;
+    /** Host to bind to */
+    host?: string;
+    /** Enable CORS */
+    cors?: boolean;
+    /** Static files directory */
+    staticDir?: string;
+    /** API base path */
+    apiBasePath?: string;
+    /** Enable real-time updates via SSE */
+    enableRealtime?: boolean;
+}
+/**
+ * Graph data for visualization
+ */
+export interface GraphData {
+    /** Nodes (entities) */
+    nodes: GraphNode[];
+    /** Edges (relationships) */
+    edges: GraphEdge[];
+    /** Graph metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Graph node
+ */
+export interface GraphNode {
+    /** Node ID */
+    id: string;
+    /** Node label */
+    label: string;
+    /** Node type */
+    type: string;
+    /** Namespace */
+    namespace?: string;
+    /** Position (optional) */
+    position?: {
+        x: number;
+        y: number;
+    };
+    /** Custom data */
+    data?: Record<string, unknown>;
+}
+/**
+ * Graph edge
+ */
+export interface GraphEdge {
+    /** Edge ID */
+    id: string;
+    /** Source node ID */
+    source: string;
+    /** Target node ID */
+    target: string;
+    /** Relationship type */
+    type: string;
+    /** Edge label */
+    label?: string;
+    /** Edge weight */
+    weight?: number;
+    /** Custom data */
+    data?: Record<string, unknown>;
+}
+/**
+ * API response
+ */
+export interface ApiResponse<T> {
+    /** Success status */
+    success: boolean;
+    /** Response data */
+    data?: T;
+    /** Error message */
+    error?: string;
+    /** Timestamp */
+    timestamp: string;
+}
+/**
+ * Default configuration
+ */
+export declare const DEFAULT_UI_CONFIG: Partial<UIServerConfig>;
+/**
+ * YATA Knowledge Graph Web UI Server
+ *
+ * Provides web-based visualization and management for YATA knowledge graphs.
+ *
+ * @example
+ * ```typescript
+ * const server = new YataUIServer({
+ *   port: 3000,
+ *   enableRealtime: true,
+ * });
+ *
+ * // Set data provider
+ * server.setDataProvider(async () => {
+ *   return {
+ *     nodes: [{ id: '1', label: 'Node 1', type: 'entity' }],
+ *     edges: [],
+ *   };
+ * });
+ *
+ * await server.start();
+ * console.log('UI available at http://localhost:3000');
+ * ```
+ *
+ * @see REQ-YI-WEB-001
+ * @see REQ-YI-WEB-002
+ * @see REQ-YI-WEB-003
+ */
+export declare class YataUIServer {
+    private app;
+    private server;
+    private config;
+    private sseClients;
+    private dataProvider;
+    constructor(config?: Partial<UIServerConfig>);
+    /**
+     * Set data provider function
+     * @param provider - Function that returns graph data
+     */
+    setDataProvider(provider: () => Promise<GraphData>): void;
+    /**
+     * Start the server
+     * @see REQ-YI-WEB-001
+     */
+    start(): Promise<void>;
+    /**
+     * Stop the server
+     */
+    stop(): Promise<void>;
+    /**
+     * Get server URL
+     */
+    getUrl(): string;
+    /**
+     * Check if server is running
+     */
+    isRunning(): boolean;
+    /**
+     * Broadcast update to all SSE clients
+     * @see REQ-YI-WEB-003
+     */
+    broadcastUpdate(event: string, data: unknown): void;
+    /**
+     * Get Express app instance for testing
+     */
+    getApp(): Express;
+    private setupMiddleware;
+    private setupRoutes;
+    /**
+     * Handle SSE connection
+     * @see REQ-YI-WEB-003
+     */
+    private handleSSEConnection;
+    /**
+     * Get graph data from provider
+     */
+    private getGraphData;
+    /**
+     * Send API response
+     */
+    private sendResponse;
+    /**
+     * Send error response
+     */
+    private sendError;
+    /**
+     * Convert to Cytoscape.js format
+     * @see REQ-YI-WEB-001
+     */
+    private toCytoscapeFormat;
+    /**
+     * Count items by type
+     */
+    private countByType;
+    /**
+     * Get built-in UI HTML
+     */
+    private getBuiltInUI;
+}
+/**
+ * Factory function to create YataUIServer
+ */
+export declare function createYataUIServer(config?: Partial<UIServerConfig>): YataUIServer;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAgB,EAAE,OAAO,EAA6B,MAAM,SAAS,CAAC;AAOtE;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kBAAkB;IAClB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oBAAoB;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uCAAuC;IACvC,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,uBAAuB;IACvB,KAAK,EAAE,SAAS,EAAE,CAAC;IACnB,4BAA4B;IAC5B,KAAK,EAAE,SAAS,EAAE,CAAC;IACnB,qBAAqB;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,cAAc;IACd,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0BAA0B;IAC1B,QAAQ,CAAC,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACpC,kBAAkB;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,cAAc;IACd,EAAE,EAAE,MAAM,CAAC;IACX,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kBAAkB;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kBAAkB;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,qBAAqB;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,oBAAoB;IACpB,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gBAAgB;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAWD;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,OAAO,CAAC,cAAc,CAMrD,CAAC;AAMF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,GAAG,CAAU;IACrB,OAAO,CAAC,MAAM,CAA4B;IAC1C,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,UAAU,CAAqC;IACvD,OAAO,CAAC,YAAY,CAA2C;gBAEnD,MAAM,GAAE,OAAO,CAAC,cAAc,CAAM;IAWhD;;;OAGG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,OAAO,CAAC,SAAS,CAAC,GAAG,IAAI;IAIzD;;;OAGG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAa5B;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAwB3B;;OAEG;IACH,MAAM,IAAI,MAAM;IAIhB;;OAEG;IACH,SAAS,IAAI,OAAO;IAIpB;;;OAGG;IACH,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,IAAI;IAQnD;;OAEG;IACH,MAAM,IAAI,OAAO;IAQjB,OAAO,CAAC,eAAe;IAmBvB,OAAO,CAAC,WAAW;IA0GnB;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IA6B3B;;OAEG;YACW,YAAY;IAO1B;;OAEG;IACH,OAAO,CAAC,YAAY;IASpB;;OAEG;IACH,OAAO,CAAC,SAAS;IASjB;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAmCzB;;OAEG;IACH,OAAO,CAAC,WAAW;IAQnB;;OAEG;IACH,OAAO,CAAC,YAAY;CAyKrB;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,YAAY,CAEjF"}