npm - @0xobelisk/graphql-server - Versions diffs - 1.2.0-pre.24 - Mend

@0xobelisk/graphql-server 1.2.0-pre.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (79) hide show

package/Dockerfile +31 -0
package/EXPRESS_MIGRATION.md +176 -0
package/LICENSE +92 -0
package/README.md +908 -0
package/dist/config/subscription-config.d.ts +47 -0
package/dist/config/subscription-config.d.ts.map +1 -0
package/dist/config/subscription-config.js +133 -0
package/dist/config/subscription-config.js.map +1 -0
package/dist/index.d.ts +2 -0
package/dist/index.d.ts.map +1 -0
package/dist/index.js +217 -0
package/dist/index.js.map +1 -0
package/dist/plugins/all-fields-filter-plugin.d.ts +4 -0
package/dist/plugins/all-fields-filter-plugin.d.ts.map +1 -0
package/dist/plugins/all-fields-filter-plugin.js +132 -0
package/dist/plugins/all-fields-filter-plugin.js.map +1 -0
package/dist/plugins/database-introspector.d.ts +23 -0
package/dist/plugins/database-introspector.d.ts.map +1 -0
package/dist/plugins/database-introspector.js +96 -0
package/dist/plugins/database-introspector.js.map +1 -0
package/dist/plugins/enhanced-playground.d.ts +9 -0
package/dist/plugins/enhanced-playground.d.ts.map +1 -0
package/dist/plugins/enhanced-playground.js +97 -0
package/dist/plugins/enhanced-playground.js.map +1 -0
package/dist/plugins/enhanced-server-manager.d.ts +28 -0
package/dist/plugins/enhanced-server-manager.d.ts.map +1 -0
package/dist/plugins/enhanced-server-manager.js +232 -0
package/dist/plugins/enhanced-server-manager.js.map +1 -0
package/dist/plugins/index.d.ts +9 -0
package/dist/plugins/index.d.ts.map +1 -0
package/dist/plugins/index.js +26 -0
package/dist/plugins/index.js.map +1 -0
package/dist/plugins/postgraphile-config.d.ts +94 -0
package/dist/plugins/postgraphile-config.d.ts.map +1 -0
package/dist/plugins/postgraphile-config.js +183 -0
package/dist/plugins/postgraphile-config.js.map +1 -0
package/dist/plugins/query-filter.d.ts +4 -0
package/dist/plugins/query-filter.d.ts.map +1 -0
package/dist/plugins/query-filter.js +42 -0
package/dist/plugins/query-filter.js.map +1 -0
package/dist/plugins/simple-naming.d.ts +4 -0
package/dist/plugins/simple-naming.d.ts.map +1 -0
package/dist/plugins/simple-naming.js +79 -0
package/dist/plugins/simple-naming.js.map +1 -0
package/dist/plugins/welcome-page.d.ts +11 -0
package/dist/plugins/welcome-page.d.ts.map +1 -0
package/dist/plugins/welcome-page.js +203 -0
package/dist/plugins/welcome-page.js.map +1 -0
package/dist/universal-subscriptions.d.ts +32 -0
package/dist/universal-subscriptions.d.ts.map +1 -0
package/dist/universal-subscriptions.js +318 -0
package/dist/universal-subscriptions.js.map +1 -0
package/dist/utils/logger/index.d.ts +80 -0
package/dist/utils/logger/index.d.ts.map +1 -0
package/dist/utils/logger/index.js +232 -0
package/dist/utils/logger/index.js.map +1 -0
package/docker-compose.yml +87 -0
package/package.json +71 -0
package/server.log +62 -0
package/src/config/subscription-config.ts +186 -0
package/src/index.ts +239 -0
package/src/plugins/README.md +123 -0
package/src/plugins/all-fields-filter-plugin.ts +158 -0
package/src/plugins/database-introspector.ts +126 -0
package/src/plugins/enhanced-playground.ts +105 -0
package/src/plugins/enhanced-server-manager.ts +282 -0
package/src/plugins/index.ts +9 -0
package/src/plugins/postgraphile-config.ts +226 -0
package/src/plugins/query-filter.ts +50 -0
package/src/plugins/simple-naming.ts +105 -0
package/src/plugins/welcome-page.ts +218 -0
package/src/universal-subscriptions.ts +397 -0
package/src/utils/logger/README.md +193 -0
package/src/utils/logger/index.ts +315 -0
package/sui-indexer-schema.graphql +1004 -0
package/test-express.js +124 -0
package/test_listen_subscription.js +121 -0
package/test_notification.js +63 -0
package/tsconfig.json +28 -0

package/src/plugins/welcome-page.ts ADDED Viewed

@@ -0,0 +1,218 @@
+import type { DynamicTable } from './database-introspector';
+export interface WelcomePageConfig {
+  port: string | number;
+  graphqlEndpoint: string;
+  nodeEnv: string;
+  schema: string;
+  enableCors: string;
+  enableSubscriptions: string;
+}
+// Create custom welcome page
+export function createWelcomePage(tables: DynamicTable[], config: WelcomePageConfig): string {
+  const { port, graphqlEndpoint, nodeEnv, schema, enableCors, enableSubscriptions } = config;
+  const tableList = tables
+    .map((table) => {
+      const keyFields = table.fields.filter((f) => f.is_key).map((f) => f.field_name);
+      const valueFields = table.fields.filter((f) => !f.is_key).map((f) => f.field_name);
+      return `
+			<div class="table-info">
+				<h3>📊 ${table.table_name}</h3>
+				<div class="fields">
+					<div><strong>Key Fields:</strong> ${keyFields.join(', ') || 'None'}</div>
+					<div><strong>Value Fields:</strong> ${valueFields.join(', ')}</div>
+				</div>
+			</div>
+		`;
+    })
+    .join('');
+  return `
+		<!DOCTYPE html>
+		<html>
+			<head>
+				<title>🚀 Sui Indexer GraphQL API</title>
+				<meta charset="utf-8">
+				<meta name="viewport" content="width=device-width, initial-scale=1">
+				<style>
+					body {
+						font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
+						margin: 0;
+						padding: 20px;
+						background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
+						color: #333;
+						min-height: 100vh;
+					}
+					.container {
+						max-width: 1200px;
+						margin: 0 auto;
+						background: white;
+						padding: 40px;
+						border-radius: 16px;
+						box-shadow: 0 20px 40px rgba(0,0,0,0.1);
+					}
+					h1 {
+						color: #2c3e50;
+						text-align: center;
+						margin-bottom: 10px;
+						font-size: 2.5em;
+					}
+					.subtitle {
+						text-align: center;
+						color: #7f8c8d;
+						margin-bottom: 40px;
+						font-size: 1.2em;
+					}
+					.link {
+						display: inline-block;
+						margin: 10px;
+						padding: 15px 25px;
+						background: linear-gradient(135deg, #74b9ff, #0984e3);
+						color: white;
+						text-decoration: none;
+						border-radius: 8px;
+						text-align: center;
+						font-weight: 500;
+						transition: transform 0.2s ease;
+					}
+					.link:hover {
+						transform: translateY(-2px);
+						box-shadow: 0 8px 15px rgba(116, 185, 255, 0.4);
+					}
+					.status {
+						color: #00b894;
+						font-weight: bold;
+						text-align: center;
+						font-size: 1.1em;
+						margin: 20px 0;
+					}
+					.warning {
+						background: #ffeaa7;
+						border-left: 4px solid #fdcb6e;
+						padding: 15px;
+						margin: 20px 0;
+						border-radius: 4px;
+					}
+					.warning h4 {
+						margin-top: 0;
+						color: #e17055;
+					}
+					.table-info {
+						background: #f8f9fa;
+						padding: 20px;
+						margin: 15px 0;
+						border-radius: 8px;
+						border-left: 4px solid #74b9ff;
+					}
+					.table-info h3 {
+						margin: 0 0 10px 0;
+						color: #2c3e50;
+					}
+					.fields div {
+						margin: 5px 0;
+						color: #555;
+					}
+					.info-grid {
+						display: grid;
+						grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
+						gap: 20px;
+						margin: 30px 0;
+					}
+					.info-card {
+						background: #f8f9fa;
+						padding: 20px;
+						border-radius: 8px;
+						border: 1px solid #e9ecef;
+					}
+					.info-card h3 {
+						color: #495057;
+						margin-top: 0;
+					}
+					.center {
+						text-align: center;
+					}
+					.highlight {
+						background: linear-gradient(135deg, #fdcb6e, #e17055);
+						color: white;
+						padding: 2px 8px;
+						border-radius: 4px;
+						font-weight: 500;
+					}
+				</style>
+			</head>
+			<body>
+				<div class="container">
+					<h1>🚀 Sui Indexer GraphQL API</h1>
+					<p class="subtitle">Dynamically scan database, automatically generate GraphQL API</p>
+					<p class="status">● Server Status: Running Normally | Scanned <span class="highlight">${
+            tables.length
+          }</span> tables</p>
+					${
+            enableSubscriptions === 'false'
+              ? `
+					<div class="warning">
+						<h4>⚠️ WebSocket subscription feature is temporarily disabled</h4>
+						<p>Currently fixing subscription configuration issues. Basic GraphQL query and mutation functions work perfectly.</p>
+					</div>
+					`
+              : `
+					<div class="status">
+						<p>📡 Real-time subscription feature: ${enableSubscriptions === 'true' ? 'Enabled' : 'Disabled'}</p>
+					</div>
+					`
+          }
+					<div class="center">
+						<a href="${graphqlEndpoint}" class="link">📊 GraphQL API</a>
+						<a href="/playground" class="link">🎮 Enhanced GraphQL Playground</a>
+					</div>
+					<div class="info-grid">
+						<div class="info-card">
+							<h3>🎯 Core Features</h3>
+							<ul>
+								<li>✨ Auto-scan sui-rust-indexer database</li>
+								<li>🔄 Dynamically generate GraphQL schema</li>
+								<li>📡 Support real-time subscription features ${enableSubscriptions === 'true' ? '✅' : '⚠️'}</li>
+								<li>🚀 Complete CRUD operations</li>
+								<li>🛡️ PostGraphile powerful features</li>
+							</ul>
+						</div>
+						<div class="info-card">
+							<h3>📊 Server Information</h3>
+							<ul>
+								<li>Environment: ${nodeEnv}</li>
+								<li>Port: ${port}</li>
+								<li>Database Schema: ${schema}</li>
+								<li>CORS: ${enableCors === 'true' ? 'Enabled' : 'Disabled'}</li>
+								<li>Subscriptions: ${enableSubscriptions === 'true' ? 'Enabled' : 'Disabled'}</li>
+							</ul>
+						</div>
+					</div>
+					<h2>📋 Detected Data Tables</h2>
+					${tableList}
+					<div style="margin-top: 40px; padding: 20px; background: #e3f2fd; border-radius: 8px;">
+						<h3>💡 Usage Tips</h3>
+						<p>1. Visit <strong>Enhanced GraphQL Playground</strong> for better query experience</p>
+						<p>   • 📊 Visual Schema Explorer - Click-to-build queries</p>
+						<p>   • 🎨 Modern UI interface and enhanced code highlighting</p>
+						<p>   • 📝 Code export feature - Generate client code in multiple languages</p>
+						<p>   • ⌨️ Keyboard shortcuts support - Ctrl/Cmd+Enter to execute queries</p>
+						<p>2. All tables support standard GraphQL query, mutation${
+              enableSubscriptions === 'true' ? ' and subscription' : ''
+            } operations</p>
+						<p>3. Dynamic tables (store_*) automatically generate fields based on table_fields metadata</p>
+						<p>4. System tables provide core data access for sui-indexer</p>
+						${enableSubscriptions === 'true' ? '<p>5. Use WebSocket for real-time data subscriptions</p>' : ''}
+					</div>
+				</div>
+			</body>
+		</html>
+	`;
+}

package/src/universal-subscriptions.ts ADDED Viewed

@@ -0,0 +1,397 @@
+import { makeExtendSchemaPlugin, gql } from 'postgraphile';
+import { subscriptionLogger } from './utils/logger';
+// Database table information interface
+interface TableInfo {
+  tableName: string;
+  fullTableName: string;
+  columns: ColumnInfo[];
+  primaryKeys: string[];
+  statistics?: {
+    rowCount: number;
+    totalSize: string;
+    tableSize: string;
+  };
+  generatedAt?: string;
+}
+interface ColumnInfo {
+  columnName: string;
+  dataType: string;
+  isNullable: boolean;
+  defaultValue?: any;
+  maxLength?: number;
+  precision?: number;
+  scale?: number;
+}
+// Cached table information
+let cachedTables: Record<string, TableInfo> = {};
+let schemaGenerated = false;
+/**
+ * Dynamically retrieve schema information for all store tables
+ */
+async function discoverStoreTables(pgClient: any): Promise<Record<string, TableInfo>> {
+  if (schemaGenerated && Object.keys(cachedTables).length > 0) {
+    return cachedTables;
+  }
+  try {
+    subscriptionLogger.info('Starting discovery of database store table structure...');
+    // 1. Get all store_* tables
+    const tablesResult = await pgClient.query(`
+			SELECT table_name
+			FROM information_schema.tables
+			WHERE table_schema = 'public'
+			AND table_name LIKE 'store_%'
+			ORDER BY table_name
+		`);
+    const tables: Record<string, TableInfo> = {};
+    // 2. Get detailed information for each table
+    for (const tableRow of tablesResult.rows) {
+      const fullTableName = tableRow.table_name;
+      const tableName = fullTableName.replace(/^store_/, '');
+      const tableInfo = await getTableInfo(pgClient, fullTableName);
+      tables[tableName] = tableInfo;
+    }
+    cachedTables = tables;
+    schemaGenerated = true;
+    subscriptionLogger.info(
+      `Discovered ${Object.keys(tables).length} store tables: ${Object.keys(tables).join(', ')}`
+    );
+    return tables;
+  } catch (error) {
+    subscriptionLogger.error('Failed to discover store tables', error);
+    return {};
+  }
+}
+/**
+ * Generate pre-built table information - called at server startup
+ */
+export async function generateStoreTablesInfo(pgPool: any): Promise<Record<string, TableInfo>> {
+  const pgClient = await pgPool.connect();
+  try {
+    const tables = await discoverStoreTables(pgClient);
+    subscriptionLogger.info(
+      `Pre-generated schema information for ${Object.keys(tables).length} tables`
+    );
+    return tables;
+  } finally {
+    pgClient.release();
+  }
+}
+/**
+ * Simplified tools plugin - only provides basic query functionality, let PostGraphile's built-in listen subscriptions work normally
+ */
+export function createUniversalSubscriptionsPlugin(preGeneratedTables?: Record<string, TableInfo>) {
+  return makeExtendSchemaPlugin((build) => {
+    subscriptionLogger.info(
+      'Enabling simplified tools plugin - only keeping basic query functionality'
+    );
+    // Use pre-generated table information if available
+    if (preGeneratedTables && Object.keys(preGeneratedTables).length > 0) {
+      cachedTables = preGeneratedTables;
+      schemaGenerated = true;
+    }
+    const tableNames = Object.keys(cachedTables);
+    subscriptionLogger.info(`Discovered store tables: ${tableNames.join(', ')}`);
+    return {
+      typeDefs: gql`
+        extend type Query {
+          """
+          Get Schema information for all store tables
+          """
+          storeSchema: JSON
+          """
+          Query data from specified store table
+          """
+          storeData(table: String!): JSON
+          """
+          Get list of all available store table names
+          """
+          availableStoreTables: [String!]!
+        }
+        # Removed custom subscription types, now only use PostGraphile's built-in listen subscriptions
+      `,
+      resolvers: {
+        Query: {
+          storeSchema: async (root: any, args: any, context: any, info: any) => {
+            const { pgClient } = context;
+            try {
+              const tables = await discoverStoreTables(pgClient);
+              return {
+                tables,
+                generatedAt: new Date().toISOString()
+              };
+            } catch (error) {
+              return {
+                error: (error as Error).message,
+                tables: {}
+              };
+            }
+          },
+          storeData: async (root: any, args: any, context: any, info: any) => {
+            return await executeTableQuery(context, args.table);
+          },
+          availableStoreTables: async (root: any, args: any, context: any, info: any) => {
+            const { pgClient } = context;
+            try {
+              const tables = await discoverStoreTables(pgClient);
+              return Object.keys(tables);
+            } catch (error) {
+              subscriptionLogger.error('Failed to get available table list', error);
+              return [];
+            }
+          }
+        }
+      }
+    };
+  });
+}
+// Default plugin export (for backward compatibility)
+export const UniversalSubscriptionsPlugin = createUniversalSubscriptionsPlugin();
+// =========================
+// Database query functions
+// =========================
+/**
+ * Get detailed table information (columns, primary keys, data statistics, etc.)
+ */
+async function getTableInfo(pgClient: any, fullTableName: string): Promise<TableInfo> {
+  const tableName = fullTableName.replace(/^store_/, '');
+  // 1. Get column information
+  const columnsResult = await pgClient.query(
+    `
+		SELECT
+			column_name,
+			data_type,
+			is_nullable,
+			column_default,
+			character_maximum_length,
+			numeric_precision,
+			numeric_scale
+		FROM information_schema.columns
+		WHERE table_name = $1
+		ORDER BY ordinal_position
+	`,
+    [fullTableName]
+  );
+  // 2. Get primary key information
+  const primaryKeysResult = await pgClient.query(
+    `
+		SELECT column_name
+		FROM information_schema.table_constraints tc
+		JOIN information_schema.key_column_usage kcu
+			ON tc.constraint_name = kcu.constraint_name
+		WHERE tc.table_name = $1
+		AND tc.constraint_type = 'PRIMARY KEY'
+		ORDER BY kcu.ordinal_position
+	`,
+    [fullTableName]
+  );
+  // 3. Try to get primary key information from table_fields table (if exists)
+  let tableFieldsKeys: string[] = [];
+  try {
+    const tableFieldsResult = await pgClient.query(
+      `
+			SELECT field_name
+			FROM table_fields
+			WHERE table_name = $1 AND is_key = true
+			ORDER BY field_name
+		`,
+      [tableName]
+    );
+    tableFieldsKeys = tableFieldsResult.rows.map((row: any) => row.field_name);
+  } catch (e) {
+    // table_fields table may not exist, ignore error
+  }
+  // 4. Get data statistics
+  const statsResult = await pgClient.query(`
+		SELECT count(*) as row_count
+		FROM ${fullTableName}
+	`);
+  // 5. Get table size information
+  const sizeResult = await pgClient.query(
+    `
+		SELECT
+			pg_size_pretty(pg_total_relation_size($1)) as total_size,
+			pg_size_pretty(pg_relation_size($1)) as table_size
+	`,
+    [fullTableName]
+  );
+  const columns: ColumnInfo[] = columnsResult.rows.map((row: any) => ({
+    columnName: row.column_name,
+    dataType: row.data_type,
+    isNullable: row.is_nullable === 'YES',
+    defaultValue: row.column_default,
+    maxLength: row.character_maximum_length,
+    precision: row.numeric_precision,
+    scale: row.numeric_scale
+  }));
+  const primaryKeys = primaryKeysResult.rows.map((row: any) => row.column_name);
+  return {
+    tableName,
+    fullTableName,
+    columns,
+    primaryKeys: primaryKeys.length > 0 ? primaryKeys : tableFieldsKeys,
+    statistics: {
+      rowCount: parseInt(statsResult.rows[0]?.row_count || '0'),
+      totalSize: sizeResult.rows[0]?.total_size || 'unknown',
+      tableSize: sizeResult.rows[0]?.table_size || 'unknown'
+    },
+    generatedAt: new Date().toISOString()
+  };
+}
+/**
+ * Dynamically execute table queries
+ */
+async function executeTableQuery(context: any, tableName: string): Promise<any> {
+  const { pgClient } = context;
+  const fullTableName = `store_${tableName}`;
+  try {
+    subscriptionLogger.debug(`Executing table query: ${fullTableName}`);
+    // 1. Get table information
+    const tableInfo = cachedTables[tableName] || (await getTableInfo(pgClient, fullTableName));
+    if (tableInfo.columns.length === 0) {
+      return {
+        nodes: [],
+        totalCount: 0,
+        tableName,
+        generatedAt: new Date().toISOString()
+      };
+    }
+    // 2. Build dynamic nodeId expression
+    const nodeIdExpression = buildNodeIdExpression(tableInfo);
+    // 3. Build query fields
+    const columnFields = tableInfo.columns
+      .map((col) => `'${col.columnName}', ${col.columnName}`)
+      .join(', ');
+    // 4. Build WHERE condition
+    const whereCondition = buildWhereCondition(tableInfo);
+    // 5. Execute query
+    const sql = `
+			SELECT
+				COALESCE(
+					json_agg(
+						json_build_object(
+							'nodeId', ${nodeIdExpression},
+							${columnFields}
+						)
+					),
+					'[]'::json
+				) as nodes,
+				count(*) as total_count
+			FROM ${fullTableName}
+			WHERE ${whereCondition}
+		`;
+    subscriptionLogger.debug(`Executing SQL: ${sql}`);
+    const result = await pgClient.query(sql);
+    const row = result.rows[0];
+    const data = {
+      nodes: row?.nodes || [],
+      totalCount: parseInt(row?.total_count || '0'),
+      tableName,
+      generatedAt: new Date().toISOString()
+    };
+    subscriptionLogger.debug(`Query result: ${fullTableName} found ${data.totalCount} records`);
+    return data;
+  } catch (error) {
+    subscriptionLogger.error(`Failed to query ${fullTableName}`, error);
+    return {
+      nodes: [],
+      totalCount: 0,
+      tableName,
+      generatedAt: new Date().toISOString(),
+      error: (error as Error).message
+    };
+  }
+}
+/**
+ * Dynamically build NodeId expression
+ */
+function buildNodeIdExpression(tableInfo: TableInfo): string {
+  const { tableName, primaryKeys, columns } = tableInfo;
+  if (primaryKeys.length > 0) {
+    // Use primary keys to build nodeId
+    const keyExpression = primaryKeys
+      .map((key) => `COALESCE(${key}::text, 'null')`)
+      .join(" || ':' || ");
+    return `encode(('${tableName}:' || ${keyExpression})::bytea, 'base64')`;
+  }
+  // If no primary key, use first column
+  const firstColumn = columns[0]?.columnName || 'unknown';
+  return `encode(('${tableName}:' || COALESCE(${firstColumn}::text, 'unknown'))::bytea, 'base64')`;
+}
+/**
+ * Dynamically build WHERE condition - completely generic, no hardcoded field names
+ */
+function buildWhereCondition(tableInfo: TableInfo): string {
+  const { primaryKeys, columns } = tableInfo;
+  // 1. Prioritize primary key fields as filter conditions (most reliable)
+  if (primaryKeys.length > 0) {
+    const conditions = primaryKeys.map((key) => `${key} IS NOT NULL`);
+    return conditions.join(' AND ');
+  }
+  // 2. If no primary key, find first non-null field (reduce empty data)
+  const nonNullableColumns = columns.filter((col) => !col.isNullable);
+  if (nonNullableColumns.length > 0) {
+    return `${nonNullableColumns[0].columnName} IS NOT NULL`;
+  }
+  // 3. If all fields can be null, use first field for basic filtering
+  if (columns.length > 0) {
+    return `${columns[0].columnName} IS NOT NULL`;
+  }
+  // 4. Final fallback - return all rows (no filtering)
+  return 'true';
+}
+// Removed getLatestInsertedData function, now only use listen subscriptions
+// Removed getLatestInsertedDataSince function, now only use simple listen subscriptions