@objectstack/objectql 3.2.1 → 3.2.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@objectstack/objectql",
-  "version": "3.2.1",
+  "version": "3.2.3",
   "license": "Apache-2.0",
   "description": "Isomorphic ObjectQL Engine for ObjectStack",
   "main": "dist/index.js",
@@ -13,9 +13,9 @@
     }
   },
   "dependencies": {
-    "@objectstack/spec": "3.2.1",
-    "@objectstack/core": "3.2.1",
-    "@objectstack/types": "3.2.1"
+    "@objectstack/core": "3.2.3",
+    "@objectstack/spec": "3.2.3",
+    "@objectstack/types": "3.2.3"
   },
   "devDependencies": {
     "typescript": "^5.0.0",

package/src/engine.test.ts

@@ -239,20 +239,20 @@ describe('ObjectQL Engine', () => {
             // Primary find returns tasks with assignee IDs
             vi.mocked(mockDriver.find)
                 .mockResolvedValueOnce([
-                    { _id: 't1', title: 'Task 1', assignee: 'u1' },
-                    { _id: 't2', title: 'Task 2', assignee: 'u2' },
+                    { id: 't1', title: 'Task 1', assignee: 'u1' },
+                    { id: 't2', title: 'Task 2', assignee: 'u2' },
                 ])
                 // Second call (expand): returns user records
                 .mockResolvedValueOnce([
-                    { _id: 'u1', name: 'Alice' },
-                    { _id: 'u2', name: 'Bob' },
+                    { id: 'u1', name: 'Alice' },
+                    { id: 'u2', name: 'Bob' },
                 ]);
 
             const result = await engine.find('task', { populate: ['assignee'] });
 
             expect(result).toHaveLength(2);
-            expect(result[0].assignee).toEqual({ _id: 'u1', name: 'Alice' });
-            expect(result[1].assignee).toEqual({ _id: 'u2', name: 'Bob' });
+            expect(result[0].assignee).toEqual({ id: 'u1', name: 'Alice' });
+            expect(result[1].assignee).toEqual({ id: 'u2', name: 'Bob' });
 
             // Verify the expand query used $in
             expect(mockDriver.find).toHaveBeenCalledTimes(2);
@@ -260,7 +260,7 @@ describe('ObjectQL Engine', () => {
                 'user',
                 expect.objectContaining({
                     object: 'user',
-                    where: { _id: { $in: ['u1', 'u2'] } },
+                    where: { id: { $in: ['u1', 'u2'] } },
                 }),
             );
         });
@@ -282,14 +282,14 @@ describe('ObjectQL Engine', () => {
 
             vi.mocked(mockDriver.find)
                 .mockResolvedValueOnce([
-                    { _id: 'oi1', order: 'o1' },
+                    { id: 'oi1', order: 'o1' },
                 ])
                 .mockResolvedValueOnce([
-                    { _id: 'o1', total: 100 },
+                    { id: 'o1', total: 100 },
                 ]);
 
             const result = await engine.find('order_item', { populate: ['order'] });
-            expect(result[0].order).toEqual({ _id: 'o1', total: 100 });
+            expect(result[0].order).toEqual({ id: 'o1', total: 100 });
         });
 
         it('should skip expand for fields without reference definition', async () => {
@@ -301,7 +301,7 @@ describe('ObjectQL Engine', () => {
             } as any);
 
             vi.mocked(mockDriver.find).mockResolvedValueOnce([
-                { _id: 't1', title: 'Task 1' },
+                { id: 't1', title: 'Task 1' },
             ]);
 
             const result = await engine.find('task', { populate: ['title'] });
@@ -313,7 +313,7 @@ describe('ObjectQL Engine', () => {
             vi.mocked(SchemaRegistry.getObject).mockReturnValue(undefined);
 
             vi.mocked(mockDriver.find).mockResolvedValueOnce([
-                { _id: 't1', assignee: 'u1' },
+                { id: 't1', assignee: 'u1' },
             ]);
 
             const result = await engine.find('task', { populate: ['assignee'] });
@@ -338,16 +338,16 @@ describe('ObjectQL Engine', () => {
 
             vi.mocked(mockDriver.find)
                 .mockResolvedValueOnce([
-                    { _id: 't1', assignee: null },
-                    { _id: 't2', assignee: 'u1' },
+                    { id: 't1', assignee: null },
+                    { id: 't2', assignee: 'u1' },
                 ])
                 .mockResolvedValueOnce([
-                    { _id: 'u1', name: 'Alice' },
+                    { id: 'u1', name: 'Alice' },
                 ]);
 
             const result = await engine.find('task', { populate: ['assignee'] });
             expect(result[0].assignee).toBeNull();
-            expect(result[1].assignee).toEqual({ _id: 'u1', name: 'Alice' });
+            expect(result[1].assignee).toEqual({ id: 'u1', name: 'Alice' });
         });
 
         it('should de-duplicate foreign key IDs in batch query', async () => {
@@ -367,13 +367,13 @@ describe('ObjectQL Engine', () => {
 
             vi.mocked(mockDriver.find)
                 .mockResolvedValueOnce([
-                    { _id: 't1', assignee: 'u1' },
-                    { _id: 't2', assignee: 'u1' }, // Same user
-                    { _id: 't3', assignee: 'u2' },
+                    { id: 't1', assignee: 'u1' },
+                    { id: 't2', assignee: 'u1' }, // Same user
+                    { id: 't3', assignee: 'u2' },
                 ])
                 .mockResolvedValueOnce([
-                    { _id: 'u1', name: 'Alice' },
-                    { _id: 'u2', name: 'Bob' },
+                    { id: 'u1', name: 'Alice' },
+                    { id: 'u2', name: 'Bob' },
                 ]);
 
             const result = await engine.find('task', { populate: ['assignee'] });
@@ -382,11 +382,11 @@ describe('ObjectQL Engine', () => {
             expect(mockDriver.find).toHaveBeenLastCalledWith(
                 'user',
                 expect.objectContaining({
-                    where: { _id: { $in: ['u1', 'u2'] } },
+                    where: { id: { $in: ['u1', 'u2'] } },
                 }),
             );
-            expect(result[0].assignee).toEqual({ _id: 'u1', name: 'Alice' });
-            expect(result[1].assignee).toEqual({ _id: 'u1', name: 'Alice' });
+            expect(result[0].assignee).toEqual({ id: 'u1', name: 'Alice' });
+            expect(result[1].assignee).toEqual({ id: 'u1', name: 'Alice' });
         });
 
         it('should keep raw ID when referenced record not found', async () => {
@@ -406,7 +406,7 @@ describe('ObjectQL Engine', () => {
 
             vi.mocked(mockDriver.find)
                 .mockResolvedValueOnce([
-                    { _id: 't1', assignee: 'u_deleted' },
+                    { id: 't1', assignee: 'u_deleted' },
                 ])
                 .mockResolvedValueOnce([]); // No records found
 
@@ -436,15 +436,15 @@ describe('ObjectQL Engine', () => {
 
             vi.mocked(mockDriver.find)
                 .mockResolvedValueOnce([
-                    { _id: 't1', assignee: 'u1', project: 'p1' },
+                    { id: 't1', assignee: 'u1', project: 'p1' },
                 ])
-                .mockResolvedValueOnce([{ _id: 'u1', name: 'Alice' }])
-                .mockResolvedValueOnce([{ _id: 'p1', name: 'Project X' }]);
+                .mockResolvedValueOnce([{ id: 'u1', name: 'Alice' }])
+                .mockResolvedValueOnce([{ id: 'p1', name: 'Project X' }]);
 
             const result = await engine.find('task', { populate: ['assignee', 'project'] });
 
-            expect(result[0].assignee).toEqual({ _id: 'u1', name: 'Alice' });
-            expect(result[0].project).toEqual({ _id: 'p1', name: 'Project X' });
+            expect(result[0].assignee).toEqual({ id: 'u1', name: 'Alice' });
+            expect(result[0].project).toEqual({ id: 'p1', name: 'Project X' });
             expect(mockDriver.find).toHaveBeenCalledTimes(3);
         });
 
@@ -464,15 +464,15 @@ describe('ObjectQL Engine', () => {
             });
 
             vi.mocked(mockDriver.findOne as any).mockResolvedValueOnce(
-                { _id: 't1', title: 'Task 1', assignee: 'u1' },
+                { id: 't1', title: 'Task 1', assignee: 'u1' },
             );
             vi.mocked(mockDriver.find).mockResolvedValueOnce([
-                { _id: 'u1', name: 'Alice' },
+                { id: 'u1', name: 'Alice' },
             ]);
 
             const result = await engine.findOne('task', { populate: ['assignee'] });
 
-            expect(result.assignee).toEqual({ _id: 'u1', name: 'Alice' });
+            expect(result.assignee).toEqual({ id: 'u1', name: 'Alice' });
         });
 
         it('should handle already-expanded objects (skip re-expansion)', async () => {
@@ -492,14 +492,14 @@ describe('ObjectQL Engine', () => {
 
             // Driver returns an already-expanded object
             vi.mocked(mockDriver.find).mockResolvedValueOnce([
-                { _id: 't1', assignee: { _id: 'u1', name: 'Alice' } },
+                { id: 't1', assignee: { id: 'u1', name: 'Alice' } },
             ]);
 
             const result = await engine.find('task', { populate: ['assignee'] });
 
             // No expand query should have been made — the value was already an object
             expect(mockDriver.find).toHaveBeenCalledTimes(1);
-            expect(result[0].assignee).toEqual({ _id: 'u1', name: 'Alice' });
+            expect(result[0].assignee).toEqual({ id: 'u1', name: 'Alice' });
         });
 
         it('should gracefully handle expand errors and keep raw IDs', async () => {
@@ -519,7 +519,7 @@ describe('ObjectQL Engine', () => {
 
             vi.mocked(mockDriver.find)
                 .mockResolvedValueOnce([
-                    { _id: 't1', assignee: 'u1' },
+                    { id: 't1', assignee: 'u1' },
                 ])
                 .mockRejectedValueOnce(new Error('Driver connection failed'));
 
@@ -544,17 +544,17 @@ describe('ObjectQL Engine', () => {
 
             vi.mocked(mockDriver.find)
                 .mockResolvedValueOnce([
-                    { _id: 't1', watchers: ['u1', 'u2'] },
+                    { id: 't1', watchers: ['u1', 'u2'] },
                 ])
                 .mockResolvedValueOnce([
-                    { _id: 'u1', name: 'Alice' },
-                    { _id: 'u2', name: 'Bob' },
+                    { id: 'u1', name: 'Alice' },
+                    { id: 'u2', name: 'Bob' },
                 ]);
 
             const result = await engine.find('task', { populate: ['watchers'] });
             expect(result[0].watchers).toEqual([
-                { _id: 'u1', name: 'Alice' },
-                { _id: 'u2', name: 'Bob' },
+                { id: 'u1', name: 'Alice' },
+                { id: 'u2', name: 'Bob' },
             ]);
         });
 
@@ -570,14 +570,14 @@ describe('ObjectQL Engine', () => {
             });
 
             vi.mocked(mockDriver.find)
-                .mockResolvedValueOnce([{ _id: 't1', project: 'p1' }])  // find task
-                .mockResolvedValueOnce([{ _id: 'p1', org: 'o1' }]);     // expand project (depth 0)
+                .mockResolvedValueOnce([{ id: 't1', project: 'p1' }])  // find task
+                .mockResolvedValueOnce([{ id: 'p1', org: 'o1' }]);     // expand project (depth 0)
                 // org should NOT be expanded further — flat populate doesn't create nested expand
 
             const result = await engine.find('task', { populate: ['project'] });
 
             // Project expanded, but org inside project remains as raw ID
-            expect(result[0].project).toEqual({ _id: 'p1', org: 'o1' });
+            expect(result[0].project).toEqual({ id: 'p1', org: 'o1' });
             expect(mockDriver.find).toHaveBeenCalledTimes(2); // Only primary + 1 expand query
         });
 
@@ -588,11 +588,11 @@ describe('ObjectQL Engine', () => {
             } as any);
 
             vi.mocked(mockDriver.find).mockResolvedValueOnce([
-                { _id: 't1', title: 'Task 1' },
+                { id: 't1', title: 'Task 1' },
             ]);
 
             const result = await engine.find('task', {});
-            expect(result).toEqual([{ _id: 't1', title: 'Task 1' }]);
+            expect(result).toEqual([{ id: 't1', title: 'Task 1' }]);
             expect(mockDriver.find).toHaveBeenCalledTimes(1);
         });
     });

package/src/engine.ts

@@ -681,7 +681,7 @@ export class ObjectQL implements IDataEngine {
       try {
         const relatedQuery: QueryAST = {
           object: referenceObject,
-          where: { _id: { $in: uniqueIds } },
+          where: { id: { $in: uniqueIds } },
           ...(nestedAST.fields ? { fields: nestedAST.fields } : {}),
           ...(nestedAST.orderBy ? { orderBy: nestedAST.orderBy } : {}),
         };
@@ -692,7 +692,7 @@ export class ObjectQL implements IDataEngine {
         // Build a lookup map: id → record
         const recordMap = new Map<string, any>();
         for (const rec of relatedRecords) {
-          const id = rec._id ?? rec.id;
+          const id = rec.id;
           if (id != null) recordMap.set(String(id), rec);
         }
 
@@ -707,7 +707,7 @@ export class ObjectQL implements IDataEngine {
           // Rebuild map with expanded records
           recordMap.clear();
           for (const rec of expandedRelated) {
-            const id = rec._id ?? rec.id;
+            const id = rec.id;
             if (id != null) recordMap.set(String(id), rec);
           }
         }
@@ -921,10 +921,9 @@ export class ObjectQL implements IDataEngine {
      const driver = this.getDriver(object);
      
      // 1. Extract ID from data or filter if it's a single update by ID
-     let id = data.id || data._id;
+     let id = data.id;
      if (!id && options?.filter) {
          if (typeof options.filter === 'string') id = options.filter;
-         else if (options.filter._id) id = options.filter._id;
          else if (options.filter.id) id = options.filter.id;
      }
 
@@ -980,7 +979,6 @@ export class ObjectQL implements IDataEngine {
     let id: any = undefined;
     if (options?.filter) {
          if (typeof options.filter === 'string') id = options.filter;
-         else if (options.filter._id) id = options.filter._id;
          else if (options.filter.id) id = options.filter.id;
     }
 
@@ -1043,7 +1041,7 @@ export class ObjectQL implements IDataEngine {
            return driver.count(object, ast);
        }
        // Fallback to find().length
-       const res = await this.find(object, { filter: query?.filter, select: ['_id'] });
+       const res = await this.find(object, { filter: query?.filter, select: ['id'] });
        return res.length;
      });
 
@@ -1335,8 +1333,8 @@ export class ObjectRepository {
 
   /** Update a single record by ID */
   async updateById(id: string | number, data: any): Promise<any> {
-    return this.engine.update(this.objectName, { ...data, _id: id }, {
-      filter: { _id: id },
+    return this.engine.update(this.objectName, { ...data, id: id }, {
+      filter: { id: id },
       context: this.context,
     });
   }
@@ -1351,7 +1349,7 @@ export class ObjectRepository {
   /** Delete a single record by ID */
   async deleteById(id: string | number): Promise<any> {
     return this.engine.delete(this.objectName, {
-      filter: { _id: id },
+      filter: { id: id },
       context: this.context,
     });
   }

package/src/plugin.integration.test.ts

@@ -16,7 +16,7 @@ describe('ObjectQLPlugin - Metadata Service Integration', () => {
     it('should register ObjectQL as metadata service provider', async () => {
       // Arrange
       const plugin = new ObjectQLPlugin();
-      kernel.use(plugin);
+      await kernel.use(plugin);
 
       // Act
       await kernel.bootstrap();
@@ -24,16 +24,19 @@ describe('ObjectQLPlugin - Metadata Service Integration', () => {
       // Assert
       const metadataService = kernel.getService('metadata');
       expect(metadataService).toBeDefined();
-      
-      // Should be the ObjectQL instance
+
+      // ObjectQL registers a MetadataFacade as the metadata service;
+      // it is separate from (but backed by the same registry as) the objectql service.
       const objectql = kernel.getService('objectql');
-      expect(metadataService).toBe(objectql);
+      expect(objectql).toBeDefined();
+      // metadata and objectql are distinct service instances
+      expect(metadataService).not.toBe(objectql);
     });
 
     it('should serve in-memory metadata definitions', async () => {
       // Arrange
       const plugin = new ObjectQLPlugin();
-      kernel.use(plugin);
+      await kernel.use(plugin);
       await kernel.bootstrap();
 
       const objectql = kernel.getService('objectql') as any;
@@ -49,17 +52,13 @@ describe('ObjectQLPlugin - Metadata Service Integration', () => {
         }
       };
 
-      // Act - Register object programmatically
-      objectql.registry.registerObject({
-        packageId: 'test',
-        namespace: 'test',
-        ownership: 'own',
-        object: testObject
-      });
+      // Act - Register object programmatically via the SchemaRegistry API
+      objectql.registry.registerObject(testObject, 'test', 'test');
 
-      // Assert - Should be retrievable via registry
-      const objects = objectql.registry.listObjects();
-      expect(objects).toContain('test__test_object');
+      // Assert - Should be retrievable via registry (getAllObjects returns ServiceObject[])
+      const objects = objectql.registry.getAllObjects();
+      const fqns = objects.map((o: any) => o.name);
+      expect(fqns).toContain('test__test_object');
     });
   });
 
@@ -67,7 +66,7 @@ describe('ObjectQLPlugin - Metadata Service Integration', () => {
     it('should register objectql, data, and protocol services', async () => {
       // Arrange
       const plugin = new ObjectQLPlugin();
-      kernel.use(plugin);
+      await kernel.use(plugin);
 
       // Act
       await kernel.bootstrap();
@@ -88,7 +87,7 @@ describe('ObjectQLPlugin - Metadata Service Integration', () => {
         list: async () => []
       };
 
-      kernel.use({
+      await kernel.use({
         name: 'mock-metadata',
         type: 'test',
         version: '1.0.0',
@@ -98,7 +97,7 @@ describe('ObjectQLPlugin - Metadata Service Integration', () => {
       });
 
       const plugin = new ObjectQLPlugin();
-      kernel.use(plugin);
+      await kernel.use(plugin);
 
       // Act
       await kernel.bootstrap();
@@ -125,7 +124,7 @@ describe('ObjectQLPlugin - Metadata Service Integration', () => {
         delete: async () => ({ count: 1 })
       };
 
-      kernel.use({
+      await kernel.use({
         name: 'mock-driver-plugin',
         type: 'driver',
         version: '1.0.0',
@@ -135,7 +134,7 @@ describe('ObjectQLPlugin - Metadata Service Integration', () => {
       });
 
       const plugin = new ObjectQLPlugin();
-      kernel.use(plugin);
+      await kernel.use(plugin);
 
       // Act
       await kernel.bootstrap();
@@ -156,7 +155,7 @@ describe('ObjectQLPlugin - Metadata Service Integration', () => {
         }
       };
 
-      kernel.use({
+      await kernel.use({
         name: 'mock-app-plugin',
         type: 'app',
         version: '1.0.0',
@@ -166,7 +165,7 @@ describe('ObjectQLPlugin - Metadata Service Integration', () => {
       });
 
       const plugin = new ObjectQLPlugin();
-      kernel.use(plugin);
+      await kernel.use(plugin);
 
       // Act
       await kernel.bootstrap();
@@ -212,7 +211,7 @@ describe('ObjectQLPlugin - Metadata Service Integration', () => {
       };
 
       // Register mock metadata service BEFORE ObjectQL
-      kernel.use({
+      await kernel.use({
         name: 'mock-metadata',
         type: 'metadata',
         version: '1.0.0',
@@ -222,7 +221,7 @@ describe('ObjectQLPlugin - Metadata Service Integration', () => {
       });
 
       const plugin = new ObjectQLPlugin();
-      kernel.use(plugin);
+      await kernel.use(plugin);
 
       // Act
       await kernel.bootstrap();

package/src/plugin.ts

@@ -116,6 +116,9 @@ export class ObjectQLPlugin implements Plugin {
         }
     }
 
+    // Initialize drivers (calls driver.connect() which sets up persistence)
+    await this.ql?.init();
+
     // Register built-in audit hooks
     this.registerAuditHooks(ctx);
 
@@ -129,35 +132,35 @@ export class ObjectQLPlugin implements Plugin {
   }
 
   /**
-   * Register built-in audit hooks for auto-stamping createdBy/modifiedBy
+   * Register built-in audit hooks for auto-stamping created_by/updated_by
    * and fetching previousData for update/delete operations.
    */
   private registerAuditHooks(ctx: PluginContext) {
     if (!this.ql) return;
 
-    // Auto-stamp createdBy/modifiedBy on insert
+    // Auto-stamp created_by/updated_by on insert
     this.ql.registerHook('beforeInsert', async (hookCtx) => {
       if (hookCtx.session?.userId && hookCtx.input?.data) {
         const data = hookCtx.input.data as Record<string, any>;
         if (typeof data === 'object' && data !== null) {
           data.created_by = data.created_by ?? hookCtx.session.userId;
-          data.modified_by = hookCtx.session.userId;
+          data.updated_by = hookCtx.session.userId;
           data.created_at = data.created_at ?? new Date().toISOString();
-          data.modified_at = new Date().toISOString();
+          data.updated_at = new Date().toISOString();
           if (hookCtx.session.tenantId) {
-            data.space_id = data.space_id ?? hookCtx.session.tenantId;
+            data.tenant_id = data.tenant_id ?? hookCtx.session.tenantId;
           }
         }
       }
     }, { object: '*', priority: 10 });
 
-    // Auto-stamp modifiedBy on update
+    // Auto-stamp updated_by on update
     this.ql.registerHook('beforeUpdate', async (hookCtx) => {
       if (hookCtx.session?.userId && hookCtx.input?.data) {
         const data = hookCtx.input.data as Record<string, any>;
         if (typeof data === 'object' && data !== null) {
-          data.modified_by = hookCtx.session.userId;
-          data.modified_at = new Date().toISOString();
+          data.updated_by = hookCtx.session.userId;
+          data.updated_at = new Date().toISOString();
         }
       }
     }, { object: '*', priority: 10 });
@@ -167,7 +170,7 @@ export class ObjectQLPlugin implements Plugin {
       if (hookCtx.input?.id && !hookCtx.previous) {
         try {
           const existing = await this.ql!.findOne(hookCtx.object, {
-            filter: { _id: hookCtx.input.id }
+            filter: { id: hookCtx.input.id }
           });
           if (existing) {
             hookCtx.previous = existing;
@@ -183,7 +186,7 @@ export class ObjectQLPlugin implements Plugin {
       if (hookCtx.input?.id && !hookCtx.previous) {
         try {
           const existing = await this.ql!.findOne(hookCtx.object, {
-            filter: { _id: hookCtx.input.id }
+            filter: { id: hookCtx.input.id }
           });
           if (existing) {
             hookCtx.previous = existing;
@@ -194,11 +197,11 @@ export class ObjectQLPlugin implements Plugin {
       }
     }, { object: '*', priority: 5 });
 
-    ctx.logger.debug('Audit hooks registered (createdBy/modifiedBy, previousData)');
+    ctx.logger.debug('Audit hooks registered (created_by/updated_by, previousData)');
   }
 
   /**
-   * Register tenant isolation middleware that auto-injects space_id filter
+   * Register tenant isolation middleware that auto-injects tenant_id filter
    * for multi-tenant operations.
    */
   private registerTenantMiddleware(ctx: PluginContext) {
@@ -210,10 +213,10 @@ export class ObjectQLPlugin implements Plugin {
         return next();
       }
 
-      // Read operations: inject space_id filter into AST
+      // Read operations: inject tenant_id filter into AST
       if (['find', 'findOne', 'count', 'aggregate'].includes(opCtx.operation)) {
         if (opCtx.ast) {
-          const tenantFilter = { space_id: opCtx.context.tenantId };
+          const tenantFilter = { tenant_id: opCtx.context.tenantId };
           if (opCtx.ast.where) {
             opCtx.ast.where = { $and: [opCtx.ast.where, tenantFilter] };
           } else {