@objectstack/objectql 0.3.1 → 0.3.3

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @objectstack/objectql
 
+## 0.3.3
+
+### Patch Changes
+
+- Workflow and configuration improvements
+
+  - Enhanced GitHub workflows for CI, release, and PR automation
+  - Added comprehensive prompt templates for different protocol areas
+  - Improved project documentation and automation guides
+  - Updated changeset configuration
+  - Added cursor rules for better development experience
+
+- Updated dependencies
+  - @objectstack/spec@0.3.3
+
+## 0.3.2
+
+### Patch Changes
+
+- Patch release for maintenance and stability improvements
+- Updated dependencies
+  - @objectstack/spec@0.3.2
+
 ## 0.3.1
 
 ### Patch Changes

package/README.md

@@ -0,0 +1,78 @@
+# ObjectQL Engine
+
+**ObjectQL** is a schema-driven, cross-datasource query engine for the [ObjectStack](https://github.com/steedos/objectstack) ecosystem. It acts as a virtual "Meta-Database" that unifies access to SQL, NoSQL, and API data sources under a single semantic layer.
+
+## Features
+
+- **Protocol Agnostic**: Uses standard `ObjectSchema` and `QueryAST` from `@objectstack/spec`.
+- **Cross-Datasource**: Routes queries to the correct driver (Postgres, MongoDB, Redis, etc.) based on Object definition.
+- **Unified API**: Single `find`, `insert`, `update`, `delete` API regardless of the underlying storage.
+- **Plugin System**: Load objects and logic via standard Manifests.
+- **Middleware**: (Planned) Support for Hooks and Validators.
+
+## Usage
+
+```typescript
+import { ObjectQL } from '@objectstack/objectql';
+import { MemoryDriver } from '@objectstack/driver-memory'; // Example driver
+
+async function main() {
+  // 1. Initialize Engine
+  const ql = new ObjectQL();
+
+  // 2. Register Drivers
+  const memDriver = new MemoryDriver({ name: 'default' });
+  ql.registerDriver(memDriver, true);
+
+  // 3. Load Schema (via Plugin/Manifest)
+  await ql.use({
+    name: 'my-app',
+    objects: [
+      {
+        name: 'todo',
+        fields: {
+          title: { type: 'text' },
+          completed: { type: 'boolean' }
+        },
+        datasource: 'default'
+      }
+    ]
+  });
+
+  await ql.init();
+
+  // 4. Execute Queries
+  // Insert
+  await ql.insert('todo', { title: 'Buy Milk', completed: false });
+
+  // Find (Simple)
+  const todos = await ql.find('todo', { completed: false });
+
+  // Find (Advanced AST)
+  const results = await ql.find('todo', {
+    where: { 
+      title: { $contains: 'Milk' } 
+    },
+    limit: 10,
+    orderBy: [{ field: 'title', order: 'desc' }]
+  });
+
+  console.log(results);
+}
+```
+
+## Architecture
+
+- **SchemaRegistry**: Central store for all metadata (Objects, Apps, Config).
+- **DriverRegistry**: Manages connections to physical data sources.
+- **QueryPlanner**: (Internal) Normalizes simplified queries into `QueryAST`.
+- **Executor**: Routes AST to the correct driver.
+
+## Roadmap
+
+- [x] Basic CRUD
+- [x] Driver Routing
+- [ ] Cross-Object Joins (Federation)
+- [ ] Validation Layer (Zod)
+- [ ] Access Control (ACL)
+- [ ] Caching Layer

package/dist/index.d.ts

@@ -1,5 +1,7 @@
-import { DriverInterface, DriverOptions } from '@objectstack/spec/system';
+import { HookContext } from '@objectstack/spec/data';
+import { DriverInterface, DriverOptions } from '@objectstack/spec/driver';
 export { SchemaRegistry } from './registry';
+export type HookHandler = (context: HookContext) => Promise<void> | void;
 /**
  * Host Context provided to plugins
  */
@@ -14,16 +16,129 @@ export interface PluginContext {
 export declare class ObjectQL {
     private drivers;
     private defaultDriver;
+    private hooks;
     private hostContext;
     constructor(hostContext?: Record<string, any>);
     /**
      * Load and Register a Plugin
      */
     use(manifestPart: any, runtimePart?: any): Promise<void>;
+    /**
+     * Register a hook
+     * @param event The event name (e.g. 'beforeFind', 'afterInsert')
+     * @param handler The handler function
+     */
+    registerHook(event: string, handler: HookHandler): void;
+    private triggerHooks;
     /**
      * Register a new storage driver
      */
     registerDriver(driver: DriverInterface, isDefault?: boolean): void;
+    /**
+     * Helper to get object definition
+     */
+    getSchema(objectName: string): {
+        fields: Record<string, {
+            type: "number" | "boolean" | "code" | "date" | "text" | "textarea" | "email" | "url" | "phone" | "password" | "markdown" | "html" | "richtext" | "currency" | "percent" | "datetime" | "time" | "select" | "lookup" | "master_detail" | "image" | "file" | "avatar" | "formula" | "summary" | "autonumber" | "location" | "geolocation" | "address" | "color" | "rating" | "slider" | "signature" | "qrcode";
+            required: boolean;
+            searchable: boolean;
+            multiple: boolean;
+            unique: boolean;
+            deleteBehavior: "set_null" | "cascade" | "restrict";
+            hidden: boolean;
+            readonly: boolean;
+            encryption: boolean;
+            index: boolean;
+            externalId: boolean;
+            options?: {
+                value: string;
+                label: string;
+                color?: string | undefined;
+                default?: boolean | undefined;
+            }[] | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            formula?: string | undefined;
+            label?: string | undefined;
+            precision?: number | undefined;
+            name?: string | undefined;
+            description?: string | undefined;
+            format?: string | undefined;
+            defaultValue?: any;
+            maxLength?: number | undefined;
+            minLength?: number | undefined;
+            scale?: number | undefined;
+            reference?: string | undefined;
+            referenceFilters?: string[] | undefined;
+            writeRequiresMasterRead?: boolean | undefined;
+            expression?: string | undefined;
+            summaryOperations?: {
+                object: string;
+                function: "count" | "sum" | "avg" | "min" | "max";
+                field: string;
+            } | undefined;
+            language?: string | undefined;
+            theme?: string | undefined;
+            lineNumbers?: boolean | undefined;
+            maxRating?: number | undefined;
+            allowHalf?: boolean | undefined;
+            displayMap?: boolean | undefined;
+            allowGeocoding?: boolean | undefined;
+            addressFormat?: "us" | "uk" | "international" | undefined;
+            colorFormat?: "hex" | "rgb" | "rgba" | "hsl" | undefined;
+            allowAlpha?: boolean | undefined;
+            presetColors?: string[] | undefined;
+            step?: number | undefined;
+            showValue?: boolean | undefined;
+            marks?: Record<string, string> | undefined;
+            barcodeFormat?: "qr" | "ean13" | "ean8" | "code128" | "code39" | "upca" | "upce" | undefined;
+            qrErrorCorrection?: "L" | "M" | "Q" | "H" | undefined;
+            displayValue?: boolean | undefined;
+            allowScanning?: boolean | undefined;
+            currencyConfig?: {
+                precision: number;
+                currencyMode: "dynamic" | "fixed";
+                defaultCurrency: string;
+            } | undefined;
+        }>;
+        name: string;
+        active: boolean;
+        isSystem: boolean;
+        abstract: boolean;
+        datasource: string;
+        label?: string | undefined;
+        description?: string | undefined;
+        tags?: string[] | undefined;
+        search?: {
+            fields: string[];
+            displayFields?: string[] | undefined;
+            filters?: string[] | undefined;
+        } | undefined;
+        pluralLabel?: string | undefined;
+        icon?: string | undefined;
+        tableName?: string | undefined;
+        indexes?: {
+            fields: string[];
+            type?: "hash" | "btree" | "gin" | "gist" | undefined;
+            name?: string | undefined;
+            unique?: boolean | undefined;
+        }[] | undefined;
+        validations?: any[] | undefined;
+        titleFormat?: string | undefined;
+        compactLayout?: string[] | undefined;
+        enable?: {
+            searchable: boolean;
+            trackHistory: boolean;
+            apiEnabled: boolean;
+            files: boolean;
+            feeds: boolean;
+            activities: boolean;
+            trash: boolean;
+            mru: boolean;
+            clone: boolean;
+            apiMethods?: ("update" | "delete" | "get" | "list" | "create" | "upsert" | "bulk" | "aggregate" | "history" | "search" | "restore" | "purge" | "import" | "export")[] | undefined;
+        } | undefined;
+    } | undefined;
     /**
      * Helper to get the target driver
      */
@@ -33,9 +148,10 @@ export declare class ObjectQL {
      */
     init(): Promise<void>;
     destroy(): Promise<void>;
-    find(object: string, filters?: any, options?: DriverOptions): Promise<Record<string, any>[]>;
-    insert(object: string, data: Record<string, any>, options?: DriverOptions): Promise<Record<string, any>>;
-    update(object: string, id: string, data: Record<string, any>, options?: DriverOptions): Promise<Record<string, any>>;
-    delete(object: string, id: string, options?: DriverOptions): Promise<boolean>;
+    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>;
 }
 //# 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":"AACA,OAAO,EAAE,eAAe,EAAE,aAAa,EAAuB,MAAM,0BAA0B,CAAC;AAI/F,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C;;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,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;;OAEG;IACH,cAAc,CAAC,MAAM,EAAE,eAAe,EAAE,SAAS,GAAE,OAAe;IAclE;;OAEG;IACH,OAAO,CAAC,SAAS;IASjB;;OAEG;IACG,IAAI;IAYJ,OAAO;IAUP,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,GAAQ,EAAE,OAAO,CAAC,EAAE,aAAa;IAmB/D,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,CAAC,EAAE,aAAa;IAYzE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,CAAC,EAAE,aAAa;IAMrF,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CAKjE"}
+{"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;;;;;;;;;;;;;mBAyMg/P,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;;;;;;;;;;;;;;;;yBAAwa,CAAC;mBAAuC,CAAC;;;;;;;gBAA0M,CAAC;gBAA6D,CAAC;kBAAoC,CAAC;;;;;;;;;;;;;;;sBAA8a,CAAC;;;IArM7gW;;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"}

package/dist/index.js

@@ -8,6 +8,13 @@ export class ObjectQL {
     constructor(hostContext = {}) {
         this.drivers = new Map();
         this.defaultDriver = null;
+        // Hooks Registry
+        this.hooks = {
+            'beforeFind': [], 'afterFind': [],
+            'beforeInsert': [], 'afterInsert': [],
+            'beforeUpdate': [], 'afterUpdate': [],
+            'beforeDelete': [], 'afterDelete': [],
+        };
         // Host provided context additions (e.g. Server router)
         this.hostContext = {};
         this.hostContext = hostContext;
@@ -68,6 +75,25 @@ export class ObjectQL {
             }
         }
     }
+    /**
+     * Register a hook
+     * @param event The event name (e.g. 'beforeFind', 'afterInsert')
+     * @param handler The handler function
+     */
+    registerHook(event, handler) {
+        if (!this.hooks[event]) {
+            this.hooks[event] = [];
+        }
+        this.hooks[event].push(handler);
+        console.log(`[ObjectQL] Registered hook for ${event}`);
+    }
+    async triggerHooks(event, context) {
+        const handlers = this.hooks[event] || [];
+        for (const handler of handlers) {
+            // In a real system, we might want to catch errors here or allow them to bubble up
+            await handler(context);
+        }
+    }
     /**
      * Register a new storage driver
      */
@@ -82,16 +108,47 @@ export class ObjectQL {
             this.defaultDriver = driver.name;
         }
     }
+    /**
+     * Helper to get object definition
+     */
+    getSchema(objectName) {
+        return SchemaRegistry.getObject(objectName);
+    }
     /**
      * Helper to get the target driver
      */
-    getDriver(_object) {
-        // TODO: Look up Object definition to see if it specifies a specific datasource/driver
-        // For now, always return default
-        if (!this.defaultDriver) {
-            throw new Error('[ObjectQL] No drivers registered!');
+    getDriver(objectName) {
+        const object = SchemaRegistry.getObject(objectName);
+        // 1. If object definition exists, check for explicit datasource
+        if (object) {
+            const datasourceName = object.datasource || 'default';
+            // If configured for 'default', try to find the default driver
+            if (datasourceName === 'default') {
+                if (this.defaultDriver && this.drivers.has(this.defaultDriver)) {
+                    return this.drivers.get(this.defaultDriver);
+                }
+                // Fallback: If 'default' not explicitly set, use the first available driver?
+                // Better to be strict.
+            }
+            else {
+                // Specific datasource requested
+                if (this.drivers.has(datasourceName)) {
+                    return this.drivers.get(datasourceName);
+                }
+                // If not found, fall back to default? Or error?
+                // Standard behavior: Error if specific datasource is missing.
+                throw new Error(`[ObjectQL] Datasource '${datasourceName}' configured for object '${objectName}' is not registered.`);
+            }
+        }
+        // 2. Fallback for ad-hoc objects or missing definitions
+        // If we have a default driver, use it.
+        if (this.defaultDriver) {
+            if (!object) {
+                console.warn(`[ObjectQL] Object '${objectName}' not found in registry. Using default driver.`);
+            }
+            return this.drivers.get(this.defaultDriver);
         }
-        return this.drivers.get(this.defaultDriver);
+        throw new Error(`[ObjectQL] No driver available for object '${objectName}'`);
     }
     /**
      * Initialize the engine and all registered drivers
@@ -116,39 +173,114 @@ export class ObjectQL {
     // ============================================
     // Data Access Methods
     // ============================================
-    async find(object, filters = {}, options) {
+    async find(object, query = {}, options) {
         const driver = this.getDriver(object);
-        console.log(`[ObjectQL] Finding ${object} on ${driver.name}...`);
-        // Transform simplified filters to QueryAST
-        // This is a simplified "Mock" transform. 
-        // Real implementation would parse complex JSON or FilterBuilders.
-        const ast = {
-            object, // Add missing required field
-            // Pass through if it looks like AST, otherwise empty
-            // In this demo, we assume the caller passes a simplified object or raw AST
-            filters: filters.filters || undefined,
-            top: filters.top || 100,
-            sort: filters.sort || []
+        // Normalize QueryAST
+        let ast;
+        if (query.where || query.fields || query.orderBy || query.limit) {
+            ast = { object, ...query };
+        }
+        else {
+            ast = { object, where: query };
+        }
+        if (ast.limit === undefined)
+            ast.limit = 100;
+        // Trigger Before Hook
+        const hookContext = {
+            object,
+            event: 'beforeFind',
+            input: { ast, options }, // Hooks can modify AST here
+            ql: this
         };
-        return driver.find(object, ast, options);
+        await this.triggerHooks('beforeFind', hookContext);
+        try {
+            const result = await driver.find(object, hookContext.input.ast, hookContext.input.options);
+            // Trigger After Hook
+            hookContext.event = 'afterFind';
+            hookContext.result = result;
+            await this.triggerHooks('afterFind', hookContext);
+            return hookContext.result;
+        }
+        catch (e) {
+            // hookContext.error = e;
+            throw e;
+        }
+    }
+    async findOne(object, idOrQuery, options) {
+        const driver = this.getDriver(object);
+        let ast;
+        if (typeof idOrQuery === 'string') {
+            ast = {
+                object,
+                where: { _id: idOrQuery }
+            };
+        }
+        else {
+            // Assume query object
+            // reuse logic from find() or just wrap it
+            if (idOrQuery.where || idOrQuery.fields) {
+                ast = { object, ...idOrQuery };
+            }
+            else {
+                ast = { object, where: idOrQuery };
+            }
+        }
+        // Limit 1 for findOne
+        ast.limit = 1;
+        return driver.findOne(object, ast, options);
     }
     async insert(object, data, options) {
         const driver = this.getDriver(object);
-        console.log(`[ObjectQL] Creating ${object} on ${driver.name}...`);
-        // 1. Validate Schema
-        // 2. Run "Before Insert" Triggers
-        const result = await driver.create(object, data, options);
-        // 3. Run "After Insert" Triggers
-        return result;
+        // 1. Get Schema
+        const schema = SchemaRegistry.getObject(object);
+        if (schema) {
+            // TODO: Validation Logic
+            // validate(schema, data);
+        }
+        // 2. Trigger Before Hook
+        const hookContext = {
+            object,
+            event: 'beforeInsert',
+            input: { data, options },
+            ql: this
+        };
+        await this.triggerHooks('beforeInsert', hookContext);
+        // 3. Execute Driver
+        const result = await driver.create(object, hookContext.input.data, hookContext.input.options);
+        // 4. Trigger After Hook
+        hookContext.event = 'afterInsert';
+        hookContext.result = result;
+        await this.triggerHooks('afterInsert', hookContext);
+        return hookContext.result;
     }
     async update(object, id, data, options) {
         const driver = this.getDriver(object);
-        console.log(`[ObjectQL] Updating ${object} ${id}...`);
-        return driver.update(object, id, data, options);
+        const hookContext = {
+            object,
+            event: 'beforeUpdate',
+            input: { id, data, options },
+            ql: this
+        };
+        await this.triggerHooks('beforeUpdate', hookContext);
+        const result = await driver.update(object, hookContext.input.id, hookContext.input.data, hookContext.input.options);
+        hookContext.event = 'afterUpdate';
+        hookContext.result = result;
+        await this.triggerHooks('afterUpdate', hookContext);
+        return hookContext.result;
     }
     async delete(object, id, options) {
         const driver = this.getDriver(object);
-        console.log(`[ObjectQL] Deleting ${object} ${id}...`);
-        return driver.delete(object, id, options);
+        const hookContext = {
+            object,
+            event: 'beforeDelete',
+            input: { id, options },
+            ql: this
+        };
+        await this.triggerHooks('beforeDelete', hookContext);
+        const result = await driver.delete(object, hookContext.input.id, hookContext.input.options);
+        hookContext.event = 'afterDelete';
+        hookContext.result = result;
+        await this.triggerHooks('afterDelete', hookContext);
+        return hookContext.result;
     }
 }

package/dist/registry.d.ts

@@ -1,6 +1,5 @@
 import { ServiceObject } from '@objectstack/spec/data';
-import { App } from '@objectstack/spec/ui';
-import { ObjectStackManifest } from '@objectstack/spec/system';
+import { ObjectStackManifest } from '@objectstack/spec/kernel';
 /**
  * Global Schema Registry
  * Unified storage for all metadata types (Objects, Apps, Flows, Layouts, etc.)
@@ -32,12 +31,6 @@ export declare class SchemaRegistry {
     static registerObject(schema: ServiceObject): void;
     static getObject(name: string): ServiceObject | undefined;
     static getAllObjects(): ServiceObject[];
-    /**
-     * App Helpers
-     */
-    static registerApp(app: App): void;
-    static getApp(name: string): App | undefined;
-    static getAllApps(): App[];
     /**
      * Plugin Helpers
      */

package/dist/registry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../src/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,GAAG,EAAE,MAAM,sBAAsB,CAAC;AAC3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D;;;GAGG;AACH,qBAAa,cAAc;IAEzB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAuC;IAE9D;;;;;OAKG;IACH,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,GAAE,MAAM,CAAqB;IAcnF;;OAEG;IACH,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAI5D;;OAEG;IACH,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,EAAE;IAItC;;OAEG;IACH,MAAM,CAAC,kBAAkB,IAAI,MAAM,EAAE;IAQrC;;OAEG;IACH,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,aAAa;IAI3C,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS;IAIzD,MAAM,CAAC,aAAa,IAAI,aAAa,EAAE;IAIvC;;OAEG;IACH,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG;IAI3B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS;IAI5C,MAAM,CAAC,UAAU,IAAI,GAAG,EAAE;IAI1B;;OAEG;IACH,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,mBAAmB;IAInD,MAAM,CAAC,aAAa,IAAI,mBAAmB,EAAE;IAI7C;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,EAAE,CAAA;KAAE;IAIzD,MAAM,CAAC,WAAW,IAAI;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,EAAE,CAAA;KAAE,EAAE;CAGxD"}
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../src/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D;;;GAGG;AACH,qBAAa,cAAc;IAEzB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAuC;IAE9D;;;;;OAKG;IACH,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,GAAE,MAAM,CAAqB;IAcnF;;OAEG;IACH,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAI5D;;OAEG;IACH,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,EAAE;IAItC;;OAEG;IACH,MAAM,CAAC,kBAAkB,IAAI,MAAM,EAAE;IAQrC;;OAEG;IACH,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,aAAa;IAI3C,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS;IAIzD,MAAM,CAAC,aAAa,IAAI,aAAa,EAAE;IAIvC;;OAEG;IACH,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,mBAAmB;IAInD,MAAM,CAAC,aAAa,IAAI,mBAAmB,EAAE;IAI7C;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,EAAE,CAAA;KAAE;IAIzD,MAAM,CAAC,WAAW,IAAI;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,EAAE,CAAA;KAAE,EAAE;CAGxD"}

package/dist/registry.js

@@ -54,18 +54,6 @@ export class SchemaRegistry {
     static getAllObjects() {
         return this.listItems('object');
     }
-    /**
-     * App Helpers
-     */
-    static registerApp(app) {
-        this.registerItem('app', app, 'name');
-    }
-    static getApp(name) {
-        return this.getItem('app', name);
-    }
-    static getAllApps() {
-        return this.listItems('app');
-    }
     /**
      * Plugin Helpers
      */

package/package.json

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

package/src/index.ts

@@ -1,10 +1,13 @@
-import { QueryAST } from '@objectstack/spec/data';
-import { DriverInterface, DriverOptions, ObjectStackManifest } from '@objectstack/spec/system';
+import { QueryAST, HookContext } from '@objectstack/spec/data';
+import { ObjectStackManifest } from '@objectstack/spec/kernel';
+import { DriverInterface, DriverOptions } from '@objectstack/spec/driver';
 import { SchemaRegistry } from './registry';
 
 // Export Registry for consumers
 export { SchemaRegistry } from './registry';
 
+export type HookHandler = (context: HookContext) => Promise<void> | void;
+
 /**
  * Host Context provided to plugins
  */
@@ -22,6 +25,14 @@ export class ObjectQL {
   private drivers = new Map<string, DriverInterface>();
   private defaultDriver: string | null = null;
   
+  // Hooks Registry
+  private hooks: Record<string, HookHandler[]> = {
+    'beforeFind': [], 'afterFind': [],
+    'beforeInsert': [], 'afterInsert': [],
+    'beforeUpdate': [], 'afterUpdate': [],
+    'beforeDelete': [], 'afterDelete': [],
+  };
+  
   // Host provided context additions (e.g. Server router)
   private hostContext: Record<string, any> = {};
 
@@ -93,6 +104,27 @@ export class ObjectQL {
     }
   }
 
+  /**
+   * Register a hook
+   * @param event The event name (e.g. 'beforeFind', 'afterInsert')
+   * @param handler The handler function
+   */
+  registerHook(event: string, handler: HookHandler) {
+    if (!this.hooks[event]) {
+        this.hooks[event] = [];
+    }
+    this.hooks[event].push(handler);
+    console.log(`[ObjectQL] Registered hook for ${event}`);
+  }
+
+  private async triggerHooks(event: string, context: HookContext) {
+    const handlers = this.hooks[event] || [];
+    for (const handler of handlers) {
+      // In a real system, we might want to catch errors here or allow them to bubble up
+      await handler(context);
+    }
+  }
+
   /**
    * Register a new storage driver
    */
@@ -110,16 +142,51 @@ export class ObjectQL {
     }
   }
 
+  /**
+   * Helper to get object definition
+   */
+  getSchema(objectName: string) {
+    return SchemaRegistry.getObject(objectName);
+  }
+
   /**
    * Helper to get the target driver
    */
-  private getDriver(_object: string): DriverInterface {
-    // TODO: Look up Object definition to see if it specifies a specific datasource/driver
-    // For now, always return default
-    if (!this.defaultDriver) {
-      throw new Error('[ObjectQL] No drivers registered!');
+  private getDriver(objectName: string): DriverInterface {
+    const object = SchemaRegistry.getObject(objectName);
+    
+    // 1. If object definition exists, check for explicit datasource
+    if (object) {
+      const datasourceName = object.datasource || 'default';
+      
+      // If configured for 'default', try to find the default driver
+      if (datasourceName === 'default') {
+        if (this.defaultDriver && this.drivers.has(this.defaultDriver)) {
+          return this.drivers.get(this.defaultDriver)!;
+        }
+        // Fallback: If 'default' not explicitly set, use the first available driver?
+        // Better to be strict.
+      } else {
+        // Specific datasource requested
+        if (this.drivers.has(datasourceName)) {
+            return this.drivers.get(datasourceName)!;
+        }
+        // If not found, fall back to default? Or error?
+        // Standard behavior: Error if specific datasource is missing.
+        throw new Error(`[ObjectQL] Datasource '${datasourceName}' configured for object '${objectName}' is not registered.`);
+      }
     }
-    return this.drivers.get(this.defaultDriver)!;
+
+    // 2. Fallback for ad-hoc objects or missing definitions
+    // If we have a default driver, use it.
+    if (this.defaultDriver) {
+      if (!object) {
+        console.warn(`[ObjectQL] Object '${objectName}' not found in registry. Using default driver.`);
+      }
+      return this.drivers.get(this.defaultDriver)!;
+    }
+
+    throw new Error(`[ObjectQL] No driver available for object '${objectName}'`);
   }
 
   /**
@@ -147,46 +214,135 @@ export class ObjectQL {
   // Data Access Methods
   // ============================================
 
-  async find(object: string, filters: any = {}, options?: DriverOptions) {
+  async find(object: string, query: any = {}, options?: DriverOptions) {
     const driver = this.getDriver(object);
-    console.log(`[ObjectQL] Finding ${object} on ${driver.name}...`);
     
-    // Transform simplified filters to QueryAST
-    // This is a simplified "Mock" transform. 
-    // Real implementation would parse complex JSON or FilterBuilders.
-    const ast: QueryAST = {
-       object, // Add missing required field
-       // Pass through if it looks like AST, otherwise empty
-       // In this demo, we assume the caller passes a simplified object or raw AST
-       filters: filters.filters || undefined,
-       top: filters.top || 100,
-       sort: filters.sort || []
+    // 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;
+    }
+
+    if (ast.limit === undefined) ast.limit = 100;
+
+    // Trigger Before Hook
+    const hookContext: HookContext = {
+        object,
+        event: 'beforeFind',
+        input: { ast, options }, // Hooks can modify AST here
+        ql: this
     };
+    await this.triggerHooks('beforeFind', hookContext);
 
-    return driver.find(object, ast, options);
+    try {
+        const result = await driver.find(object, hookContext.input.ast, hookContext.input.options);
+        
+        // Trigger After Hook
+        hookContext.event = 'afterFind';
+        hookContext.result = result;
+        await this.triggerHooks('afterFind', hookContext);
+        
+        return hookContext.result;
+    } catch (e) {
+        // hookContext.error = e;
+        throw e;
+    }
+  }
+
+  async findOne(object: string, idOrQuery: string | any, options?: DriverOptions) {
+    const driver = this.getDriver(object);
+    
+    let ast: QueryAST;
+    if (typeof idOrQuery === 'string') {
+        ast = {
+            object,
+            where: { _id: idOrQuery }
+        };
+    } else {
+        // Assume query object
+        // reuse logic from find() or just wrap it
+        if (idOrQuery.where || idOrQuery.fields) {
+            ast = { object, ...idOrQuery };
+        } else {
+            ast = { object, where: idOrQuery };
+        }
+    }
+    // Limit 1 for findOne
+    ast.limit = 1;
+
+    return driver.findOne(object, ast, options);
   }
 
   async insert(object: string, data: Record<string, any>, options?: DriverOptions) {
     const driver = this.getDriver(object);
-    console.log(`[ObjectQL] Creating ${object} on ${driver.name}...`);
-    // 1. Validate Schema
-    // 2. Run "Before Insert" Triggers
     
-    const result = await driver.create(object, data, options);
+    // 1. Get Schema
+    const schema = SchemaRegistry.getObject(object);
+    
+    if (schema) {
+       // TODO: Validation Logic
+       // validate(schema, data);
+    }
+    
+    // 2. Trigger Before Hook
+    const hookContext: HookContext = {
+        object,
+        event: 'beforeInsert',
+        input: { data, options },
+        ql: this
+    };
+    await this.triggerHooks('beforeInsert', hookContext);
     
-    // 3. Run "After Insert" Triggers
-    return result;
+    // 3. Execute Driver
+    const result = await driver.create(object, hookContext.input.data, hookContext.input.options);
+    
+    // 4. Trigger After Hook
+    hookContext.event = 'afterInsert';
+    hookContext.result = result;
+    await this.triggerHooks('afterInsert', hookContext);
+
+    return hookContext.result;
   }
 
-  async update(object: string, id: string, data: Record<string, any>, options?: DriverOptions) {
+  async update(object: string, id: string | number, data: Record<string, any>, options?: DriverOptions) {
     const driver = this.getDriver(object);
-    console.log(`[ObjectQL] Updating ${object} ${id}...`);
-    return driver.update(object, id, data, options);
+
+    const hookContext: HookContext = {
+        object,
+        event: 'beforeUpdate',
+        input: { id, data, options },
+        ql: this
+    };
+    await this.triggerHooks('beforeUpdate', hookContext);
+
+    const result = await driver.update(object, hookContext.input.id, hookContext.input.data, hookContext.input.options);
+
+    hookContext.event = 'afterUpdate';
+    hookContext.result = result;
+    await this.triggerHooks('afterUpdate', hookContext);
+    
+    return hookContext.result;
   }
 
-  async delete(object: string, id: string, options?: DriverOptions) {
+  async delete(object: string, id: string | number, options?: DriverOptions) {
     const driver = this.getDriver(object);
-    console.log(`[ObjectQL] Deleting ${object} ${id}...`);
-    return driver.delete(object, id, options);
+
+    const hookContext: HookContext = {
+        object,
+        event: 'beforeDelete',
+        input: { id, options },
+        ql: this
+    };
+    await this.triggerHooks('beforeDelete', hookContext);
+
+    const result = await driver.delete(object, hookContext.input.id, hookContext.input.options);
+
+    hookContext.event = 'afterDelete';
+    hookContext.result = result;
+    await this.triggerHooks('afterDelete', hookContext);
+
+    return hookContext.result;
   }
 }

package/src/registry.ts

@@ -1,6 +1,5 @@
 import { ServiceObject } from '@objectstack/spec/data';
-import { App } from '@objectstack/spec/ui';
-import { ObjectStackManifest } from '@objectstack/spec/system';
+import { ObjectStackManifest } from '@objectstack/spec/kernel';
 
 /**
  * Global Schema Registry
@@ -70,21 +69,6 @@ export class SchemaRegistry {
     return this.listItems<ServiceObject>('object');
   }
 
-  /**
-   * App Helpers
-   */
-  static registerApp(app: App) {
-    this.registerItem('app', app, 'name');
-  }
-
-  static getApp(name: string): App | undefined {
-    return this.getItem<App>('app', name);
-  }
-
-  static getAllApps(): App[] {
-    return this.listItems<App>('app');
-  }
-
   /**
    * Plugin Helpers
    */