@objectstack/objectql 0.4.1 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @objectstack/objectql
 
+## 0.6.0
+
+### Minor Changes
+
+- b2df5f7: Unified version bump to 0.5.0
+
+  - Standardized all package versions to 0.5.0 across the monorepo
+  - Fixed driver-memory package.json paths for proper module resolution
+  - Ensured all packages are in sync for the 0.5.0 release
+
+### Patch Changes
+
+- Updated dependencies [b2df5f7]
+  - @objectstack/spec@0.6.0
+  - @objectstack/types@0.6.0
+  - @objectstack/core@0.6.0
+
+## 0.4.2
+
+### Patch Changes
+
+- Unify all package versions to 0.4.2
+- Updated dependencies
+  - @objectstack/spec@0.4.2
+
 ## 0.4.1
 
 ### Patch Changes

package/README.md

@@ -12,16 +12,18 @@
 
 ## Usage
 
+### 1. Standalone Usage
+
 ```typescript
 import { ObjectQL } from '@objectstack/objectql';
-import { MemoryDriver } from '@objectstack/driver-memory'; // Example driver
+import { InMemoryDriver } from '@objectstack/driver-memory'; // Note: Package name might export InMemoryDriver now
 
 async function main() {
   // 1. Initialize Engine
   const ql = new ObjectQL();
 
   // 2. Register Drivers
-  const memDriver = new MemoryDriver({ name: 'default' });
+  const memDriver = new InMemoryDriver({ name: 'default' });
   ql.registerDriver(memDriver, true);
 
   // 3. Load Schema (via Plugin/Manifest)
@@ -61,6 +63,26 @@ async function main() {
 }
 ```
 
+### 2. Using with ObjectKernel (Recommended)
+
+When building full applications, use the `ObjectKernel` to manage plugins and configuration.
+
+```typescript
+import { ObjectKernel } from '@objectstack/core';
+import { ObjectQLPlugin, DriverPlugin } from '@objectstack/runtime';
+import { InMemoryDriver } from '@objectstack/driver-memory';
+
+const kernel = new ObjectKernel();
+
+// Register Engine and Drivers as Kernel Plugins
+kernel.use(new ObjectQLPlugin())
+      .use(new DriverPlugin(new InMemoryDriver(), 'default'));
+
+await kernel.bootstrap();
+
+// The engine automatically discovers drivers and apps registered in the kernel.
+```
+
 ## Architecture
 
 - **SchemaRegistry**: Central store for all metadata (Objects, Apps, Config).

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 import { HookContext } from '@objectstack/spec/data';
-import { DriverInterface, DriverOptions } from '@objectstack/spec/system';
+import { DriverOptions } from '@objectstack/spec/system';
+import { DriverInterface, IDataEngine, DataEngineQueryOptions } from '@objectstack/core';
 export { SchemaRegistry } from './registry';
+export { ObjectStackProtocolImplementation } from './protocol';
 export type HookHandler = (context: HookContext) => Promise<void> | void;
 /**
  * Host Context provided to plugins
@@ -12,8 +14,10 @@ export interface PluginContext {
 }
 /**
  * ObjectQL Engine
+ *
+ * Implements the IDataEngine interface for data persistence.
  */
-export declare class ObjectQL {
+export declare class ObjectQL implements IDataEngine {
     private drivers;
     private defaultDriver;
     private hooks;
@@ -30,6 +34,7 @@ export declare class ObjectQL {
      */
     registerHook(event: string, handler: HookHandler): void;
     private triggerHooks;
+    registerApp(manifestPart: any): void;
     /**
      * Register a new storage driver
      */
@@ -155,10 +160,40 @@ export declare class ObjectQL {
      */
     init(): Promise<void>;
     destroy(): Promise<void>;
-    find(object: string, query?: any, options?: DriverOptions): Promise<any>;
-    findOne(object: string, idOrQuery: string | any, options?: DriverOptions): Promise<Record<string, any> | null>;
-    insert(object: string, data: Record<string, any>, options?: DriverOptions): Promise<any>;
-    update(object: string, id: string | number, data: Record<string, any>, options?: DriverOptions): Promise<any>;
-    delete(object: string, id: string | number, options?: DriverOptions): Promise<any>;
+    /**
+     * Find records matching a query (IDataEngine interface)
+     *
+     * @param object - Object name
+     * @param query - Query options (IDataEngine format)
+     * @returns Promise resolving to array of records
+     */
+    find(object: string, query?: DataEngineQueryOptions): Promise<any[]>;
+    findOne(object: string, idOrQuery: string | any, options?: DriverOptions): Promise<any>;
+    /**
+     * Insert a new record (IDataEngine interface)
+     *
+     * @param object - Object name
+     * @param data - Data to insert
+     * @returns Promise resolving to the created record
+     */
+    insert(object: string, data: any): Promise<any>;
+    /**
+     * Update a record by ID (IDataEngine interface)
+     *
+     * @param object - Object name
+     * @param id - Record ID
+     * @param data - Updated data
+     * @returns Promise resolving to the updated record
+     */
+    update(object: string, id: any, data: any): Promise<any>;
+    /**
+     * Delete a record by ID (IDataEngine interface)
+     *
+     * @param object - Object name
+     * @param id - Record ID
+     * @returns Promise resolving to true if deleted, false otherwise
+     */
+    delete(object: string, id: any): Promise<boolean>;
 }
+export * from './plugin';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAE/D,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAI1E,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,QAAQ,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;IAEhB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,OAAO,CAAsC;IACrD,OAAO,CAAC,aAAa,CAAuB;IAG5C,OAAO,CAAC,KAAK,CAKX;IAGF,OAAO,CAAC,WAAW,CAA2B;gBAElC,WAAW,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM;IAKjD;;OAEG;IACG,GAAG,CAAC,YAAY,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,GAAG;IA4D9C;;;;OAIG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW;YAQlC,YAAY;IAQ1B;;OAEG;IACH,cAAc,CAAC,MAAM,EAAE,eAAe,EAAE,SAAS,GAAE,OAAe;IAclE;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,MAAM;;;;;;;;;;;;;mBAyMi/T,CAAC;;;qBAA2E,CAAC;uBAAyC,CAAC;;eAA2D,CAAC;eAAiC,CAAC;mBAAqC,CAAC;iBAAmC,CAAC;qBAAuC,CAAC;gBAAkC,CAAC;uBAAyC,CAAC;kBAAoC,CAAC;wBAA0C,CAAC;qBAAwB,CAAC;qBAAuC,CAAC;iBAAmC,CAAC;qBAAuC,CAAC;4BAA8C,CAAC;mCAAuD,CAAC;sBAAyC,CAAC;6BAA+C,CAAC;;;;;oBAAiK,CAAC;iBAAmC,CAAC;uBAAyC,CAAC;qBAAwC,CAAC;qBAAuC,CAAC;sBAAyC,CAAC;0BAA6C,CAAC;yBAA4C,CAAC;uBAAgE,CAAC;sBAAgE,CAAC;wBAA2C,CAAC;gBAAoC,CAAC;qBAAuC,CAAC;iBAAoC,CAAC;yBAA2D,CAAC;6BAAyG,CAAC;wBAAyD,CAAC;yBAA4C,CAAC;0BAA6C,CAAC;;;;;wBAAkK,CAAC;;;;;yBAAyM,CAAC;;;;;;;;;;;;;yBAA4V,CAAC;mBAAuC,CAAC;;;;;;;gBAA0M,CAAC;gBAA6D,CAAC;kBAAoC,CAAC;;;;;;;;;;;;;;;sBAA8a,CAAC;;;IArM/ya;;OAEG;IACH,OAAO,CAAC,SAAS;IAqCjB;;OAEG;IACG,IAAI;IAYJ,OAAO;IAUP,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,GAAE,GAAQ,EAAE,OAAO,CAAC,EAAE,aAAa;IAqC7D,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,GAAG,EAAE,OAAO,CAAC,EAAE,aAAa;IAwBxE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,CAAC,EAAE,aAAa;IA+BzE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,CAAC,EAAE,aAAa;IAoB9F,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CAmB1E"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAE/D,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAIzF,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,iCAAiC,EAAE,MAAM,YAAY,CAAC;AAG/D,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,QAAQ,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;IAEhB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;;GAIG;AACH,qBAAa,QAAS,YAAW,WAAW;IAC1C,OAAO,CAAC,OAAO,CAAsC;IACrD,OAAO,CAAC,aAAa,CAAuB;IAG5C,OAAO,CAAC,KAAK,CAKX;IAGF,OAAO,CAAC,WAAW,CAA2B;gBAElC,WAAW,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM;IAKjD;;OAEG;IACG,GAAG,CAAC,YAAY,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,GAAG;IAyB9C;;;;OAIG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW;YAQlC,YAAY;IAQ1B,WAAW,CAAC,YAAY,EAAE,GAAG;IAsC7B;;OAEG;IACH,cAAc,CAAC,MAAM,EAAE,eAAe,EAAE,SAAS,GAAE,OAAe;IAclE;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,MAAM;;;;;;;;;;;;;mBA+PwqQ,CAAC;;;qBAA2E,CAAC;uBAAyC,CAAC;;eAA2D,CAAC;eAAiC,CAAC;mBAAqC,CAAC;iBAAmC,CAAC;qBAAuC,CAAC;gBAAkC,CAAC;uBAAyC,CAAC;kBAAoC,CAAC;wBAA0C,CAAC;qBAAwB,CAAC;qBAAuC,CAAC;iBAAmC,CAAC;qBAAuC,CAAC;4BAA8C,CAAC;mCAAuD,CAAC;sBAAyC,CAAC;6BAA+C,CAAC;;;;;oBAAiK,CAAC;iBAAmC,CAAC;uBAAyC,CAAC;qBAAwC,CAAC;qBAAuC,CAAC;sBAAyC,CAAC;0BAA6C,CAAC;yBAA4C,CAAC;uBAAgE,CAAC;sBAAgE,CAAC;wBAA2C,CAAC;gBAAoC,CAAC;qBAAuC,CAAC;iBAAoC,CAAC;yBAA2D,CAAC;6BAAyG,CAAC;wBAAyD,CAAC;yBAA4C,CAAC;0BAA6C,CAAC;;;;;wBAAkK,CAAC;;;;;yBAAyM,CAAC;;;;;;;;;;;;;yBAA4V,CAAC;mBAAuC,CAAC;;;;;;;gBAA0M,CAAC;gBAA6D,CAAC;kBAAoC,CAAC;;;;;;;;;;;;;;;sBAA8a,CAAC;;;IA3Pt+W;;OAEG;IACH,OAAO,CAAC,SAAS;IAqCjB;;OAEG;IACG,IAAI;IAYJ,OAAO;IAUb;;;;;;OAMG;IACG,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IA4DpE,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,GAAG,EAAE,OAAO,CAAC,EAAE,aAAa;IAwB9E;;;;;;OAMG;IACG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IA+BrD;;;;;;;OAOG;IACG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAoB9D;;;;;;OAMG;IACG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;CAoBxD;AACD,cAAc,UAAU,CAAC"}

package/dist/index.js

@@ -1,8 +1,11 @@
 import { SchemaRegistry } from './registry';
 // Export Registry for consumers
 export { SchemaRegistry } from './registry';
+export { ObjectStackProtocolImplementation } from './protocol';
 /**
  * ObjectQL Engine
+ *
+ * Implements the IDataEngine interface for data persistence.
  */
 export class ObjectQL {
     constructor(hostContext = {}) {
@@ -26,37 +29,7 @@ export class ObjectQL {
     async use(manifestPart, runtimePart) {
         // 1. Validate / Register Manifest
         if (manifestPart) {
-            // 1. Handle Module Imports (commonjs/esm interop)
-            // If the passed object is a module namespace with a default export, use that.
-            const manifest = manifestPart.default || manifestPart;
-            // In a real scenario, we might strictly parse this using Zod
-            // For now, simple ID check
-            const id = manifest.id || manifest.name;
-            if (!id) {
-                console.warn(`[ObjectQL] Plugin manifest missing ID (keys: ${Object.keys(manifest)})`, manifest);
-                // Don't return, try to proceed if it looks like an App (Apps might use 'name' instead of 'id')
-                // return; 
-            }
-            console.log(`[ObjectQL] Loading Plugin: ${id}`);
-            SchemaRegistry.registerPlugin(manifest);
-            // Register Objects from App/Plugin
-            if (manifest.objects) {
-                for (const obj of manifest.objects) {
-                    // Ensure object name is registered globally
-                    SchemaRegistry.registerObject(obj);
-                    console.log(`[ObjectQL] Registered Object: ${obj.name}`);
-                }
-            }
-            // Register contributions
-            if (manifest.contributes?.kinds) {
-                for (const kind of manifest.contributes.kinds) {
-                    SchemaRegistry.registerKind(kind);
-                }
-            }
-            // Register Data Seeding (Lazy execution or immediate?)
-            // We store it in a temporary registry or execute immediately if engine is ready.
-            // Since `use` is init time, we might need to store it and run later in `seed()`.
-            // For this MVP, let's attach it to the manifest object in registry so Kernel can find it.
+            this.registerApp(manifestPart);
         }
         // 2. Execute Runtime
         if (runtimePart) {
@@ -94,6 +67,38 @@ export class ObjectQL {
             await handler(context);
         }
     }
+    registerApp(manifestPart) {
+        // 1. Handle Module Imports (commonjs/esm interop)
+        // If the passed object is a module namespace with a default export, use that.
+        const raw = manifestPart.default || manifestPart;
+        // Support nested manifest property (Stack Definition)
+        // We merge the inner manifest metadata (id, version, etc) with the outer container (objects, apps)
+        const manifest = raw.manifest ? { ...raw, ...raw.manifest } : raw;
+        // In a real scenario, we might strictly parse this using Zod
+        // For now, simple ID check
+        const id = manifest.id || manifest.name;
+        if (!id) {
+            console.warn(`[ObjectQL] Plugin manifest missing ID (keys: ${Object.keys(manifest)})`, manifest);
+            // Don't return, try to proceed if it looks like an App (Apps might use 'name' instead of 'id')
+            // return; 
+        }
+        console.log(`[ObjectQL] Loading App: ${id}`);
+        SchemaRegistry.registerPlugin(manifest);
+        // Register Objects from App/Plugin
+        if (manifest.objects) {
+            for (const obj of manifest.objects) {
+                // Ensure object name is registered globally
+                SchemaRegistry.registerObject(obj);
+                console.log(`[ObjectQL] Registered Object: ${obj.name}`);
+            }
+        }
+        // Register contributions
+        if (manifest.contributes?.kinds) {
+            for (const kind of manifest.contributes.kinds) {
+                SchemaRegistry.registerKind(kind);
+            }
+        }
+    }
     /**
      * Register a new storage driver
      */
@@ -171,25 +176,54 @@ export class ObjectQL {
         }
     }
     // ============================================
-    // Data Access Methods
+    // Data Access Methods (IDataEngine Interface)
     // ============================================
-    async find(object, query = {}, options) {
+    /**
+     * Find records matching a query (IDataEngine interface)
+     *
+     * @param object - Object name
+     * @param query - Query options (IDataEngine format)
+     * @returns Promise resolving to array of records
+     */
+    async find(object, query) {
         const driver = this.getDriver(object);
-        // Normalize QueryAST
-        let ast;
-        if (query.where || query.fields || query.orderBy || query.limit) {
-            ast = { object, ...query };
-        }
-        else {
-            ast = { object, where: query };
+        // Convert DataEngineQueryOptions to QueryAST
+        let ast = { object };
+        if (query) {
+            // Map DataEngineQueryOptions to QueryAST
+            if (query.filter) {
+                ast.where = query.filter;
+            }
+            if (query.select) {
+                ast.fields = query.select;
+            }
+            if (query.sort) {
+                // Convert sort Record to orderBy array
+                // sort: { createdAt: -1, name: 'asc' } => orderBy: [{ field: 'createdAt', order: 'desc' }, { field: 'name', order: 'asc' }]
+                ast.orderBy = Object.entries(query.sort).map(([field, order]) => ({
+                    field,
+                    order: (order === -1 || order === 'desc') ? 'desc' : 'asc'
+                }));
+            }
+            // Handle both limit and top (top takes precedence)
+            if (query.top !== undefined) {
+                ast.limit = query.top;
+            }
+            else if (query.limit !== undefined) {
+                ast.limit = query.limit;
+            }
+            if (query.skip !== undefined) {
+                ast.offset = query.skip;
+            }
         }
+        // Set default limit if not specified
         if (ast.limit === undefined)
             ast.limit = 100;
         // Trigger Before Hook
         const hookContext = {
             object,
             event: 'beforeFind',
-            input: { ast, options }, // Hooks can modify AST here
+            input: { ast, options: undefined },
             ql: this
         };
         await this.triggerHooks('beforeFind', hookContext);
@@ -229,7 +263,14 @@ export class ObjectQL {
         ast.limit = 1;
         return driver.findOne(object, ast, options);
     }
-    async insert(object, data, options) {
+    /**
+     * Insert a new record (IDataEngine interface)
+     *
+     * @param object - Object name
+     * @param data - Data to insert
+     * @returns Promise resolving to the created record
+     */
+    async insert(object, data) {
         const driver = this.getDriver(object);
         // 1. Get Schema
         const schema = SchemaRegistry.getObject(object);
@@ -241,7 +282,7 @@ export class ObjectQL {
         const hookContext = {
             object,
             event: 'beforeInsert',
-            input: { data, options },
+            input: { data, options: undefined },
             ql: this
         };
         await this.triggerHooks('beforeInsert', hookContext);
@@ -253,12 +294,20 @@ export class ObjectQL {
         await this.triggerHooks('afterInsert', hookContext);
         return hookContext.result;
     }
-    async update(object, id, data, options) {
+    /**
+     * Update a record by ID (IDataEngine interface)
+     *
+     * @param object - Object name
+     * @param id - Record ID
+     * @param data - Updated data
+     * @returns Promise resolving to the updated record
+     */
+    async update(object, id, data) {
         const driver = this.getDriver(object);
         const hookContext = {
             object,
             event: 'beforeUpdate',
-            input: { id, data, options },
+            input: { id, data, options: undefined },
             ql: this
         };
         await this.triggerHooks('beforeUpdate', hookContext);
@@ -268,12 +317,19 @@ export class ObjectQL {
         await this.triggerHooks('afterUpdate', hookContext);
         return hookContext.result;
     }
-    async delete(object, id, options) {
+    /**
+     * Delete a record by ID (IDataEngine interface)
+     *
+     * @param object - Object name
+     * @param id - Record ID
+     * @returns Promise resolving to true if deleted, false otherwise
+     */
+    async delete(object, id) {
         const driver = this.getDriver(object);
         const hookContext = {
             object,
             event: 'beforeDelete',
-            input: { id, options },
+            input: { id, options: undefined },
             ql: this
         };
         await this.triggerHooks('beforeDelete', hookContext);
@@ -281,6 +337,8 @@ export class ObjectQL {
         hookContext.event = 'afterDelete';
         hookContext.result = result;
         await this.triggerHooks('afterDelete', hookContext);
+        // Driver.delete() already returns boolean per DriverInterface spec
         return hookContext.result;
     }
 }
+export * from './plugin';

package/dist/plugin.d.ts

@@ -0,0 +1,14 @@
+import { ObjectQL } from './index';
+import { Plugin, PluginContext } from '@objectstack/core';
+export type { Plugin, PluginContext };
+export declare class ObjectQLPlugin implements Plugin {
+    name: string;
+    type: "objectql";
+    version: string;
+    private ql;
+    private hostContext?;
+    constructor(ql?: ObjectQL, hostContext?: Record<string, any>);
+    init(ctx: PluginContext): Promise<void>;
+    start(ctx: PluginContext): Promise<void>;
+}
+//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAE1D,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;AAEtC,qBAAa,cAAe,YAAW,MAAM;IAC3C,IAAI,SAAqC;IACzC,IAAI,EAAG,UAAU,CAAU;IAC3B,OAAO,SAAW;IAElB,OAAO,CAAC,EAAE,CAAuB;IACjC,OAAO,CAAC,WAAW,CAAC,CAAsB;gBAE9B,EAAE,CAAC,EAAE,QAAQ,EAAE,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAStD,IAAI,CAAC,GAAG,EAAE,aAAa;IAkBvB,KAAK,CAAC,GAAG,EAAE,aAAa;CAoB/B"}

package/dist/plugin.js

@@ -0,0 +1,54 @@
+import { ObjectQL } from './index';
+import { ObjectStackProtocolImplementation } from './protocol';
+export class ObjectQLPlugin {
+    constructor(ql, hostContext) {
+        this.name = 'com.objectstack.engine.objectql';
+        this.type = 'objectql';
+        this.version = '1.0.0';
+        if (ql) {
+            this.ql = ql;
+        }
+        else {
+            this.hostContext = hostContext;
+            // Lazily created in init
+        }
+    }
+    async init(ctx) {
+        if (!this.ql) {
+            this.ql = new ObjectQL(this.hostContext);
+        }
+        ctx.registerService('objectql', this.ql);
+        if (ctx.logger)
+            ctx.logger.log(`[ObjectQLPlugin] ObjectQL engine registered as service`);
+        // Register Protocol Implementation
+        if (!this.ql) {
+            throw new Error('ObjectQL engine not initialized');
+        }
+        const protocolShim = new ObjectStackProtocolImplementation(this.ql);
+        ctx.registerService('protocol', protocolShim);
+        if (ctx.logger)
+            ctx.logger.log(`[ObjectQLPlugin] Protocol service registered`);
+    }
+    async start(ctx) {
+        if (ctx.logger)
+            ctx.logger.log(`[ObjectQLPlugin] ObjectQL engine initialized`);
+        // Discover features from Kernel Services
+        if (ctx.getServices && this.ql) {
+            const services = ctx.getServices();
+            for (const [name, service] of services.entries()) {
+                if (name.startsWith('driver.')) {
+                    // Register Driver
+                    this.ql.registerDriver(service);
+                    if (ctx.logger)
+                        ctx.logger.log(`[ObjectQLPlugin] Discovered and registered driver service: ${name}`);
+                }
+                if (name.startsWith('app.')) {
+                    // Register App
+                    this.ql.registerApp(service); // service is Manifest
+                    if (ctx.logger)
+                        ctx.logger.log(`[ObjectQLPlugin] Discovered and registered app service: ${name}`);
+                }
+            }
+        }
+    }
+}

package/dist/protocol.d.ts

@@ -0,0 +1,43 @@
+import { IObjectStackProtocol } from '@objectstack/spec/api';
+import { IDataEngine } from '@objectstack/core';
+export declare class ObjectStackProtocolImplementation implements IObjectStackProtocol {
+    private engine;
+    constructor(engine: IDataEngine);
+    getDiscovery(): {
+        name: string;
+        version: string;
+        capabilities: {
+            metadata: boolean;
+            data: boolean;
+            ui: boolean;
+        };
+    };
+    getMetaTypes(): string[];
+    getMetaItems(type: string): unknown[];
+    getMetaItem(type: string, name: string): unknown;
+    getUiView(object: string, type: 'list' | 'form'): {
+        type: string;
+        object: string;
+        columns: {
+            field: string;
+            label: string;
+        }[];
+        sections?: undefined;
+    } | {
+        type: string;
+        object: string;
+        sections: {
+            label: string;
+            fields: {
+                field: string;
+            }[];
+        }[];
+        columns?: undefined;
+    };
+    findData(object: string, query: any): Promise<any[]>;
+    getData(object: string, id: string): Promise<any>;
+    createData(object: string, data: any): Promise<any>;
+    updateData(object: string, id: string, data: any): Promise<any>;
+    deleteData(object: string, id: string): Promise<boolean>;
+}
+//# sourceMappingURL=protocol.d.ts.map

package/dist/protocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAKhD,qBAAa,iCAAkC,YAAW,oBAAoB;IAC1E,OAAO,CAAC,MAAM,CAAc;gBAEhB,MAAM,EAAE,WAAW;IAI/B,YAAY;;;;;;;;;IAYZ,YAAY;IAIZ,YAAY,CAAC,IAAI,EAAE,MAAM;IAIzB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAItC,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;;;;;;;;;;;;;;;;;;;IA6B/C,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAI7B,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM;IAsBxC,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG;IAIpC,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG;IAIhD,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM;CAGxC"}

package/dist/protocol.js

@@ -0,0 +1,87 @@
+// We import SchemaRegistry directly since this class lives in the same package
+import { SchemaRegistry } from './registry';
+export class ObjectStackProtocolImplementation {
+    constructor(engine) {
+        this.engine = engine;
+    }
+    getDiscovery() {
+        return {
+            name: 'ObjectStack API',
+            version: '1.0',
+            capabilities: {
+                metadata: true,
+                data: true,
+                ui: true
+            }
+        };
+    }
+    getMetaTypes() {
+        return SchemaRegistry.getRegisteredTypes();
+    }
+    getMetaItems(type) {
+        return SchemaRegistry.listItems(type);
+    }
+    getMetaItem(type, name) {
+        return SchemaRegistry.getItem(type, name);
+    }
+    getUiView(object, type) {
+        const schema = SchemaRegistry.getObject(object);
+        if (!schema)
+            throw new Error(`Object ${object} not found`);
+        if (type === 'list') {
+            return {
+                type: 'list',
+                object: object,
+                columns: Object.keys(schema.fields || {}).slice(0, 5).map(f => ({
+                    field: f,
+                    label: schema.fields[f].label || f
+                }))
+            };
+        }
+        else {
+            return {
+                type: 'form',
+                object: object,
+                sections: [
+                    {
+                        label: 'General',
+                        fields: Object.keys(schema.fields || {}).map(f => ({
+                            field: f
+                        }))
+                    }
+                ]
+            };
+        }
+    }
+    findData(object, query) {
+        return this.engine.find(object, query);
+    }
+    async getData(object, id) {
+        // IDataEngine doesn't have findOne, so we simulate it with find and limit 1
+        // Assuming the ID field is named '_id' or 'id'. 
+        // For broad compatibility, we might need to know the ID field name.
+        // But traditionally it is _id in ObjectStack/mongo or id in others.
+        // Let's rely on finding by ID if the engine supports it via find?
+        // Actually, ObjectQL (the implementation) DOES have findOne.
+        // But we are programming against IDataEngine interface here.
+        // If the engine IS ObjectQL (which it practically is), we could cast it.
+        // But let's try to stick to interface.
+        const results = await this.engine.find(object, {
+            filter: { _id: id }, // Default Assumption: _id
+            limit: 1
+        });
+        if (results && results.length > 0) {
+            return results[0];
+        }
+        throw new Error(`Record ${id} not found in ${object}`);
+    }
+    createData(object, data) {
+        return this.engine.insert(object, data);
+    }
+    updateData(object, id, data) {
+        return this.engine.update(object, id, data);
+    }
+    deleteData(object, id) {
+        return this.engine.delete(object, id);
+    }
+}

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "@objectstack/objectql",
-  "version": "0.4.1",
+  "version": "0.6.0",
   "description": "Isomorphic ObjectQL Engine for ObjectStack",
   "main": "src/index.ts",
   "types": "src/index.ts",
   "dependencies": {
-    "@objectstack/spec": "0.4.1"
+    "@objectstack/core": "0.6.0",
+    "@objectstack/spec": "0.6.0",
+    "@objectstack/types": "0.6.0"
   },
   "devDependencies": {
     "typescript": "^5.0.0",

package/src/index.ts

@@ -1,10 +1,13 @@
 import { QueryAST, HookContext } from '@objectstack/spec/data';
 import { ObjectStackManifest } from '@objectstack/spec/system';
-import { DriverInterface, DriverOptions } from '@objectstack/spec/system';
+import { DriverOptions } from '@objectstack/spec/system';
+import { DriverInterface, IDataEngine, DataEngineQueryOptions } from '@objectstack/core';
 import { SchemaRegistry } from './registry';
 
 // Export Registry for consumers
 export { SchemaRegistry } from './registry';
+export { ObjectStackProtocolImplementation } from './protocol';
+
 
 export type HookHandler = (context: HookContext) => Promise<void> | void;
 
@@ -20,8 +23,10 @@ export interface PluginContext {
 
 /**
  * ObjectQL Engine
+ * 
+ * Implements the IDataEngine interface for data persistence.
  */
-export class ObjectQL {
+export class ObjectQL implements IDataEngine {
   private drivers = new Map<string, DriverInterface>();
   private defaultDriver: string | null = null;
   
@@ -47,42 +52,7 @@ export class ObjectQL {
   async use(manifestPart: any, runtimePart?: any) {
     // 1. Validate / Register Manifest
     if (manifestPart) {
-      // 1. Handle Module Imports (commonjs/esm interop)
-      // If the passed object is a module namespace with a default export, use that.
-      const manifest = manifestPart.default || manifestPart;
-
-      // In a real scenario, we might strictly parse this using Zod
-      // For now, simple ID check
-      const id = manifest.id || manifest.name;
-      if (!id) {
-        console.warn(`[ObjectQL] Plugin manifest missing ID (keys: ${Object.keys(manifest)})`, manifest);
-        // Don't return, try to proceed if it looks like an App (Apps might use 'name' instead of 'id')
-        // return; 
-      }
-      
-      console.log(`[ObjectQL] Loading Plugin: ${id}`);
-      SchemaRegistry.registerPlugin(manifest as ObjectStackManifest);
-
-      // Register Objects from App/Plugin
-      if (manifest.objects) {
-        for (const obj of manifest.objects) {
-            // Ensure object name is registered globally
-            SchemaRegistry.registerObject(obj);
-            console.log(`[ObjectQL] Registered Object: ${obj.name}`);
-        }
-      }
-
-      // Register contributions
-       if (manifest.contributes?.kinds) {
-          for (const kind of manifest.contributes.kinds) {
-            SchemaRegistry.registerKind(kind);
-          }
-       }
-
-       // Register Data Seeding (Lazy execution or immediate?)
-       // We store it in a temporary registry or execute immediately if engine is ready.
-       // Since `use` is init time, we might need to store it and run later in `seed()`.
-       // For this MVP, let's attach it to the manifest object in registry so Kernel can find it.
+      this.registerApp(manifestPart);
     }
 
     // 2. Execute Runtime
@@ -125,6 +95,44 @@ export class ObjectQL {
     }
   }
 
+  registerApp(manifestPart: any) {
+      // 1. Handle Module Imports (commonjs/esm interop)
+      // If the passed object is a module namespace with a default export, use that.
+      const raw = manifestPart.default || manifestPart;
+      
+      // Support nested manifest property (Stack Definition)
+      // We merge the inner manifest metadata (id, version, etc) with the outer container (objects, apps)
+      const manifest = raw.manifest ? { ...raw, ...raw.manifest } : raw;
+
+      // In a real scenario, we might strictly parse this using Zod
+      // For now, simple ID check
+      const id = manifest.id || manifest.name;
+      if (!id) {
+        console.warn(`[ObjectQL] Plugin manifest missing ID (keys: ${Object.keys(manifest)})`, manifest);
+        // Don't return, try to proceed if it looks like an App (Apps might use 'name' instead of 'id')
+        // return; 
+      }
+      
+      console.log(`[ObjectQL] Loading App: ${id}`);
+      SchemaRegistry.registerPlugin(manifest as ObjectStackManifest);
+
+      // Register Objects from App/Plugin
+      if (manifest.objects) {
+        for (const obj of manifest.objects) {
+            // Ensure object name is registered globally
+            SchemaRegistry.registerObject(obj);
+            console.log(`[ObjectQL] Registered Object: ${obj.name}`);
+        }
+      }
+
+      // Register contributions
+       if (manifest.contributes?.kinds) {
+          for (const kind of manifest.contributes.kinds) {
+            SchemaRegistry.registerKind(kind);
+          }
+       }
+  }
+
   /**
    * Register a new storage driver
    */
@@ -211,27 +219,57 @@ export class ObjectQL {
   }
 
   // ============================================
-  // Data Access Methods
+  // Data Access Methods (IDataEngine Interface)
   // ============================================
 
-  async find(object: string, query: any = {}, options?: DriverOptions) {
+  /**
+   * Find records matching a query (IDataEngine interface)
+   * 
+   * @param object - Object name
+   * @param query - Query options (IDataEngine format)
+   * @returns Promise resolving to array of records
+   */
+  async find(object: string, query?: DataEngineQueryOptions): Promise<any[]> {
     const driver = this.getDriver(object);
     
-    // Normalize QueryAST
-    let ast: QueryAST;
-    if (query.where || query.fields || query.orderBy || query.limit) {
-      ast = { object, ...query } as QueryAST;
-    } else {
-      ast = { object, where: query } as QueryAST;
+    // Convert DataEngineQueryOptions to QueryAST
+    let ast: QueryAST = { object };
+    
+    if (query) {
+      // Map DataEngineQueryOptions to QueryAST
+      if (query.filter) {
+        ast.where = query.filter;
+      }
+      if (query.select) {
+        ast.fields = query.select;
+      }
+      if (query.sort) {
+        // Convert sort Record to orderBy array
+        // sort: { createdAt: -1, name: 'asc' } => orderBy: [{ field: 'createdAt', order: 'desc' }, { field: 'name', order: 'asc' }]
+        ast.orderBy = Object.entries(query.sort).map(([field, order]) => ({
+          field,
+          order: (order === -1 || order === 'desc') ? 'desc' : 'asc'
+        }));
+      }
+      // Handle both limit and top (top takes precedence)
+      if (query.top !== undefined) {
+        ast.limit = query.top;
+      } else if (query.limit !== undefined) {
+        ast.limit = query.limit;
+      }
+      if (query.skip !== undefined) {
+        ast.offset = query.skip;
+      }
     }
 
+    // Set default limit if not specified
     if (ast.limit === undefined) ast.limit = 100;
 
     // Trigger Before Hook
     const hookContext: HookContext = {
         object,
         event: 'beforeFind',
-        input: { ast, options }, // Hooks can modify AST here
+        input: { ast, options: undefined },
         ql: this
     };
     await this.triggerHooks('beforeFind', hookContext);
@@ -275,7 +313,14 @@ export class ObjectQL {
     return driver.findOne(object, ast, options);
   }
 
-  async insert(object: string, data: Record<string, any>, options?: DriverOptions) {
+  /**
+   * Insert a new record (IDataEngine interface)
+   * 
+   * @param object - Object name
+   * @param data - Data to insert
+   * @returns Promise resolving to the created record
+   */
+  async insert(object: string, data: any): Promise<any> {
     const driver = this.getDriver(object);
     
     // 1. Get Schema
@@ -290,7 +335,7 @@ export class ObjectQL {
     const hookContext: HookContext = {
         object,
         event: 'beforeInsert',
-        input: { data, options },
+        input: { data, options: undefined },
         ql: this
     };
     await this.triggerHooks('beforeInsert', hookContext);
@@ -306,13 +351,21 @@ export class ObjectQL {
     return hookContext.result;
   }
 
-  async update(object: string, id: string | number, data: Record<string, any>, options?: DriverOptions) {
+  /**
+   * Update a record by ID (IDataEngine interface)
+   * 
+   * @param object - Object name
+   * @param id - Record ID
+   * @param data - Updated data
+   * @returns Promise resolving to the updated record
+   */
+  async update(object: string, id: any, data: any): Promise<any> {
     const driver = this.getDriver(object);
 
     const hookContext: HookContext = {
         object,
         event: 'beforeUpdate',
-        input: { id, data, options },
+        input: { id, data, options: undefined },
         ql: this
     };
     await this.triggerHooks('beforeUpdate', hookContext);
@@ -326,13 +379,20 @@ export class ObjectQL {
     return hookContext.result;
   }
 
-  async delete(object: string, id: string | number, options?: DriverOptions) {
+  /**
+   * Delete a record by ID (IDataEngine interface)
+   * 
+   * @param object - Object name
+   * @param id - Record ID
+   * @returns Promise resolving to true if deleted, false otherwise
+   */
+  async delete(object: string, id: any): Promise<boolean> {
     const driver = this.getDriver(object);
 
     const hookContext: HookContext = {
         object,
         event: 'beforeDelete',
-        input: { id, options },
+        input: { id, options: undefined },
         ql: this
     };
     await this.triggerHooks('beforeDelete', hookContext);
@@ -343,6 +403,8 @@ export class ObjectQL {
     hookContext.result = result;
     await this.triggerHooks('afterDelete', hookContext);
 
+    // Driver.delete() already returns boolean per DriverInterface spec
     return hookContext.result;
   }
 }
+export * from './plugin';

package/src/plugin.ts

@@ -0,0 +1,62 @@
+import { ObjectQL } from './index';
+import { ObjectStackProtocolImplementation } from './protocol';
+import { Plugin, PluginContext } from '@objectstack/core';
+
+export type { Plugin, PluginContext };
+
+export class ObjectQLPlugin implements Plugin {
+  name = 'com.objectstack.engine.objectql';
+  type = 'objectql' as const;
+  version = '1.0.0';
+  
+  private ql: ObjectQL | undefined;
+  private hostContext?: Record<string, any>;
+
+  constructor(ql?: ObjectQL, hostContext?: Record<string, any>) {
+    if (ql) {
+        this.ql = ql;
+    } else {
+        this.hostContext = hostContext;
+        // Lazily created in init
+    }
+  }
+
+  async init(ctx: PluginContext) {
+    if (!this.ql) {
+        this.ql = new ObjectQL(this.hostContext);
+    }
+    
+    ctx.registerService('objectql', this.ql);
+    if(ctx.logger) ctx.logger.log(`[ObjectQLPlugin] ObjectQL engine registered as service`);
+
+    // Register Protocol Implementation
+    if (!this.ql) {
+        throw new Error('ObjectQL engine not initialized');
+    }
+    const protocolShim = new ObjectStackProtocolImplementation(this.ql);
+
+    ctx.registerService('protocol', protocolShim);
+    if(ctx.logger) ctx.logger.log(`[ObjectQLPlugin] Protocol service registered`);
+  }
+
+  async start(ctx: PluginContext) {
+    if(ctx.logger) ctx.logger.log(`[ObjectQLPlugin] ObjectQL engine initialized`);
+    
+    // Discover features from Kernel Services
+    if (ctx.getServices && this.ql) {
+        const services = ctx.getServices();
+        for (const [name, service] of services.entries()) {
+            if (name.startsWith('driver.')) {
+                 // Register Driver
+                 this.ql.registerDriver(service);
+                 if(ctx.logger) ctx.logger.log(`[ObjectQLPlugin] Discovered and registered driver service: ${name}`);
+            }
+            if (name.startsWith('app.')) {
+                // Register App
+                this.ql.registerApp(service); // service is Manifest
+                if(ctx.logger) ctx.logger.log(`[ObjectQLPlugin] Discovered and registered app service: ${name}`);
+            }
+        }
+    }
+  }
+}

package/src/protocol.ts

@@ -0,0 +1,104 @@
+import { IObjectStackProtocol } from '@objectstack/spec/api';
+import { IDataEngine } from '@objectstack/core';
+
+// We import SchemaRegistry directly since this class lives in the same package
+import { SchemaRegistry } from './registry';
+
+export class ObjectStackProtocolImplementation implements IObjectStackProtocol {
+    private engine: IDataEngine;
+
+    constructor(engine: IDataEngine) {
+        this.engine = engine;
+    }
+
+    getDiscovery() {
+        return {
+            name: 'ObjectStack API',
+            version: '1.0',
+            capabilities: {
+                metadata: true,
+                data: true,
+                ui: true
+            }
+        };
+    }
+
+    getMetaTypes() {
+        return SchemaRegistry.getRegisteredTypes();
+    }
+
+    getMetaItems(type: string) {
+        return SchemaRegistry.listItems(type);
+    }
+
+    getMetaItem(type: string, name: string) {
+        return SchemaRegistry.getItem(type, name);
+    }
+
+    getUiView(object: string, type: 'list' | 'form') {
+        const schema = SchemaRegistry.getObject(object);
+        if (!schema) throw new Error(`Object ${object} not found`);
+
+        if (type === 'list') {
+            return {
+                type: 'list',
+                object: object,
+                columns: Object.keys(schema.fields || {}).slice(0, 5).map(f => ({
+                    field: f,
+                    label: schema.fields[f].label || f
+                }))
+            };
+        } else {
+             return {
+                type: 'form',
+                object: object,
+                sections: [
+                    {
+                        label: 'General',
+                        fields: Object.keys(schema.fields || {}).map(f => ({
+                            field: f
+                        }))
+                    }
+                ]
+            };
+        }
+    }
+
+    findData(object: string, query: any) {
+        return this.engine.find(object, query);
+    }
+
+    async getData(object: string, id: string) {
+        // IDataEngine doesn't have findOne, so we simulate it with find and limit 1
+        // Assuming the ID field is named '_id' or 'id'. 
+        // For broad compatibility, we might need to know the ID field name.
+        // But traditionally it is _id in ObjectStack/mongo or id in others.
+        // Let's rely on finding by ID if the engine supports it via find?
+        // Actually, ObjectQL (the implementation) DOES have findOne.
+        // But we are programming against IDataEngine interface here.
+        
+        // If the engine IS ObjectQL (which it practically is), we could cast it.
+        // But let's try to stick to interface.
+        
+        const results = await this.engine.find(object, {
+            filter: { _id: id }, // Default Assumption: _id
+            limit: 1
+        });
+        if (results && results.length > 0) {
+            return results[0];
+        }
+        throw new Error(`Record ${id} not found in ${object}`);
+    }
+
+    createData(object: string, data: any) {
+        return this.engine.insert(object, data);
+    }
+
+    updateData(object: string, id: string, data: any) {
+        return this.engine.update(object, id, data);
+    }
+
+    deleteData(object: string, id: string) {
+        return this.engine.delete(object, id);
+    }
+}