添加内存驱动插件及相关配置，导出驱动协议，更新 TypeScript 配置

Author: hotlong

examples/plugin-driver-memory/objectstack.config.ts

@@ -0,0 +1,27 @@
+import { ObjectStackManifest } from '@objectstack/spec';
+
+const MemoryDriverPlugin: ObjectStackManifest = {
+  id: 'com.objectstack.driver.memory',
+  name: 'In-Memory Driver',
+  version: '1.0.0',
+  type: 'plugin', // Acts as a plugin that contributes a driver
+  description: 'A reference specificiation implementation of the DriverInterface using in-memory arrays.',
+  
+  configuration: {
+    title: 'Memory Driver Settings',
+    properties: {
+      seedData: {
+        type: 'boolean',
+        default: false,
+        description: 'Pre-populate the database with example data on startup'
+      }
+    }
+  },
+
+  contributes: {
+     // If there was a 'drivers' definition here, we would use it.
+     // For now, we register via code (src/index.ts)
+  }
+};
+
+export default MemoryDriverPlugin;

examples/plugin-driver-memory/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@objectstack/plugin-driver-memory",
+  "version": "0.0.1",
+  "description": "Example: In-Memory Database Driver for ObjectStack",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc -w"
+  },
+  "dependencies": {
+    "@objectstack/spec": "workspace:*"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  }
+}

examples/plugin-driver-memory/src/index.ts

@@ -0,0 +1,31 @@
+import { InMemoryDriver } from './memory-driver';
+
+// Note: In a real environment, you would import these from @objectstack/spec
+// But distinct PluginDefinition interface might not be strictly defined in schema yet, 
+// usually it mimics the Manifest structure + runtime hooks.
+
+// For this example, we define a basic shape if not available, or use "any" to bypass strictness for the demo.
+// In plugin-bi it imported: import { PluginDefinition, PluginContextData } from '@objectstack/spec';
+
+// Let's rely on the environment being set up like plugin-bi.
+// If types are missing, this is just an example file.
+
+export default {
+  id: 'com.objectstack.driver.memory',
+  version: '1.0.0',
+
+  onEnable: async (context: any) => {
+    const { logger } = context;
+    logger.info('[Memory Driver] Initializing...');
+
+    // Simulate driver registration
+    // This assumes the runtime exposes a 'drivers' registry
+    if (context.drivers) {
+       const driver = new InMemoryDriver();
+       context.drivers.register(driver);
+       logger.info(`[Memory Driver] Registered driver: ${driver.name}`);
+    } else {
+       logger.warn('[Memory Driver] No driver registry found in context.');
+    }
+  }
+};

examples/plugin-driver-memory/src/memory-driver.ts

@@ -0,0 +1,179 @@
+import { 
+  DriverInterface, 
+  DriverOptions, 
+  QueryAST // Ensure this is exported from spec
+} from '@objectstack/spec';
+
+/**
+ * Example: In-Memory Driver
+ * 
+ * A minimal reference implementation of the ObjectStack Driver Protocol.
+ * This driver stores data in a simple JavaScript object (Heap).
+ */
+export class InMemoryDriver implements DriverInterface {
+  name = 'in-memory-driver';
+  version = '0.0.1';
+  
+  supports = {
+    transactions: false, 
+    joins: false,        
+    fullTextSearch: false,
+    jsonFields: true,    
+    arrayFields: true,   
+  };
+
+  /**
+   * The "Database": A map of TableName -> Array of Records
+   */
+  private db: Record<string, any[]> = {};
+
+  // ===================================
+  // Lifecycle
+  // ===================================
+
+  async connect() {
+    console.log('🔌 [InMemory] Database Connected (Virtual)');
+  }
+
+  async disconnect() {
+    this.db = {};
+    console.log('🔌 [InMemory] Database Disconnected & Cleared');
+  }
+
+  async checkHealth() {
+    return true; 
+  }
+
+  // ===================================
+  // Execution
+  // ===================================
+
+  async execute(command: any, params?: any[]) {
+    console.log('⚠️ [InMemory] Raw execution not supported, received:', command);
+    return null;
+  }
+
+  // ===================================
+  // CRUD
+  // ===================================
+
+  async find(object: string, query: QueryAST, options?: DriverOptions) {
+    const table = this.getTable(object);
+    
+    // 💡 Naive Implementation
+    let results = [...table];
+
+    // Simple limiting for demonstration
+    if (query.top) {
+      results = results.slice(0, query.top);
+    }
+
+    return results;
+  }
+
+  async findOne(object: string, query: QueryAST, options?: DriverOptions) {
+    const results = await this.find(object, { ...query, top: 1 }, options);
+    return results[0] || null;
+  }
+
+  async create(object: string, data: Record<string, any>, options?: DriverOptions) {
+    const table = this.getTable(object);
+    
+    const newRecord = {
+      id: this.generateId(),
+      ...data,
+      created_at: new Date(),
+      updated_at: new Date(),
+    };
+
+    table.push(newRecord);
+    return newRecord;
+  }
+
+  async update(object: string, id: string | number, data: Record<string, any>, options?: DriverOptions) {
+    const table = this.getTable(object);
+    const index = table.findIndex(r => r.id == id);
+    
+    if (index === -1) {
+      throw new Error(`Record with ID ${id} not found in ${object}`);
+    }
+
+    const updatedRecord = {
+      ...table[index],
+      ...data,
+      updated_at: new Date()
+    };
+    
+    table[index] = updatedRecord;
+    return updatedRecord;
+  }
+
+  async delete(object: string, id: string | number, options?: DriverOptions) {
+    const table = this.getTable(object);
+    const index = table.findIndex(r => r.id == id);
+    
+    if (index === -1) return false;
+
+    table.splice(index, 1);
+    return true;
+  }
+
+  async count(object: string, query?: QueryAST, options?: DriverOptions) {
+    return this.getTable(object).length;
+  }
+
+  // ===================================
+  // Bulk Operations
+  // ===================================
+
+  async bulkCreate(object: string, dataArray: Record<string, any>[], options?: DriverOptions) {
+    return Promise.all(dataArray.map(data => this.create(object, data, options)));
+  }
+
+  async bulkUpdate(object: string, updates: { id: string | number, data: Record<string, any> }[], options?: DriverOptions) {
+    return Promise.all(updates.map(u => this.update(object, u.id, u.data, options)));
+  }
+
+  async bulkDelete(object: string, ids: (string | number)[], options?: DriverOptions) {
+    await Promise.all(ids.map(id => this.delete(object, id, options)));
+  }
+
+  // ===================================
+  // Schema & Transactions
+  // ===================================
+
+  async syncSchema(object: string, schema: any, options?: DriverOptions) {
+    if (!this.db[object]) {
+      this.db[object] = [];
+      console.log(`✨ [InMemory] Created table: ${object}`);
+    }
+  }
+
+  async dropTable(object: string, options?: DriverOptions) {
+    if (this.db[object]) {
+      delete this.db[object];
+    }
+  }
+
+  async beginTransaction() {
+    throw new Error('Transactions not supported in InMemoryDriver');
+  }
+
+  async commit() { /* No-op */ }
+  async rollback() { /* No-op */ }
+
+  // ===================================
+  // Helpers
+  // ===================================
+
+  private getTable(name: string) {
+    if (!this.db[name]) {
+      this.db[name] = [];
+    }
+    return this.db[name];
+  }
+
+  private generateId() {
+    return Math.random().toString(36).substring(2, 15);
+  }
+}

examples/plugin-driver-memory/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src/**/*", "objectstack.config.ts"]
+}

packages/spec/src/index.ts

@@ -47,6 +47,7 @@ export * from './system/territory.zod';
 export * from './system/license.zod';
 export * from './system/webhook.zod';
 export * from './system/translation.zod';
+export * from './system/driver.zod'; // Export Driver Protocol
 export * from './system/constants';
 export * from './system/types';
 export * from './system/discovery.zod';