@objectstack/objectql 3.3.0 → 4.0.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @objectstack/objectql@3.3.0 build /home/runner/work/spec/spec/packages/objectql
+> @objectstack/objectql@4.0.0 build /home/runner/work/spec/spec/packages/objectql
 > tsup --config ../../tsup.config.ts
 
 CLI Building entry: src/index.ts
@@ -10,13 +10,13 @@
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-CJS dist/index.js     98.69 KB
-CJS dist/index.js.map 199.38 KB
-CJS ⚡️ Build success in 147ms
-ESM dist/index.mjs     96.95 KB
-ESM dist/index.mjs.map 198.08 KB
-ESM ⚡️ Build success in 148ms
+ESM dist/index.mjs     102.95 KB
+ESM dist/index.mjs.map 211.04 KB
+ESM ⚡️ Build success in 184ms
+CJS dist/index.js     104.68 KB
+CJS dist/index.js.map 212.34 KB
+CJS ⚡️ Build success in 187ms
 DTS Build start
-DTS ⚡️ Build success in 25675ms
-DTS dist/index.d.mts 78.59 KB
-DTS dist/index.d.ts  78.59 KB
+DTS ⚡️ Build success in 20424ms
+DTS dist/index.d.mts 79.12 KB
+DTS dist/index.d.ts  79.12 KB

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # @objectstack/objectql
 
+## 4.0.0
+
+### Minor Changes
+
+- e0b0a78: Deprecate DataEngineQueryOptions in favor of QueryAST-aligned EngineQueryOptions.
+
+  Engine, Protocol, and Client now use standard QueryAST parameter names:
+
+  - `filter` → `where`
+  - `select` → `fields`
+  - `sort` → `orderBy`
+  - `skip` → `offset`
+  - `populate` → `expand`
+  - `top` → `limit`
+
+  The old DataEngine\* schemas and types are preserved with `@deprecated` markers for backward compatibility.
+
+### Patch Changes
+
+- Updated dependencies [f08ffc3]
+- Updated dependencies [e0b0a78]
+  - @objectstack/spec@4.0.0
+  - @objectstack/core@4.0.0
+  - @objectstack/types@4.0.0
+
+## 3.3.1
+
+### Patch Changes
+
+- @objectstack/spec@3.3.1
+- @objectstack/core@3.3.1
+- @objectstack/types@3.3.1
+
 ## 3.3.0
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 import * as _objectstack_spec_data from '@objectstack/spec/data';
-import { ServiceObject, ObjectOwnership, HookContext, QueryAST, DataEngineQueryOptions, DataEngineInsertOptions, DataEngineUpdateOptions, DataEngineDeleteOptions, DataEngineCountOptions, DataEngineAggregateOptions } from '@objectstack/spec/data';
+import { ObjectOwnership, ServiceObject, QueryAST, HookContext, EngineQueryOptions, DataEngineInsertOptions, EngineUpdateOptions, EngineDeleteOptions, EngineCountOptions, EngineAggregateOptions } from '@objectstack/spec/data';
 import { ObjectStackManifest, InstalledPackage, ExecutionContext } from '@objectstack/spec/kernel';
 import { ObjectStackProtocol, MetadataCacheRequest, MetadataCacheResponse, BatchUpdateRequest, BatchUpdateResponse, UpdateManyDataRequest, DeleteManyDataRequest } from '@objectstack/spec/api';
 import { IDataEngine, DriverInterface, Logger, Plugin, PluginContext, ObjectKernel } from '@objectstack/core';
@@ -1289,6 +1289,7 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
         routes: {
             data: string;
             metadata: string;
+            discovery?: string | undefined;
             ui?: string | undefined;
             auth?: string | undefined;
             automation?: string | undefined;
@@ -1301,6 +1302,7 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
             notifications?: string | undefined;
             ai?: string | undefined;
             i18n?: string | undefined;
+            feed?: string | undefined;
         };
         services: Record<string, {
             enabled: boolean;
@@ -1316,15 +1318,10 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
                 retryAfterMs?: number | undefined;
             } | undefined;
         }>;
-        capabilities: {
-            feed: boolean;
-            comments: boolean;
-            automation: boolean;
-            cron: boolean;
-            search: boolean;
-            export: boolean;
-            chunkedUpload: boolean;
-        };
+        capabilities: Record<string, {
+            enabled: boolean;
+            description?: string;
+        }>;
     }>;
     getMetaTypes(): Promise<{
         types: string[];
@@ -1453,6 +1450,20 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
     }): Promise<{
         success: boolean;
         message: string;
+        warning?: undefined;
+    } | {
+        success: boolean;
+        message: string;
+        warning: any;
+    }>;
+    /**
+     * Hydrate SchemaRegistry from the database on startup.
+     * Loads all active metadata records and registers them in the in-memory registry.
+     * Safe to call repeatedly — idempotent (latest DB record wins).
+     */
+    loadMetaFromDb(): Promise<{
+        loaded: number;
+        errors: number;
     }>;
     listFeed(request: any): Promise<any>;
     createFeedItem(request: any): Promise<any>;
@@ -1652,14 +1663,13 @@ declare class ObjectQL implements IDataEngine {
      * @returns Records with expanded lookup fields (IDs replaced by full objects)
      */
     private expandRelatedRecords;
-    private toQueryAST;
-    find(object: string, query?: DataEngineQueryOptions): Promise<any[]>;
-    findOne(objectName: string, query?: DataEngineQueryOptions): Promise<any>;
+    find(object: string, query?: EngineQueryOptions): Promise<any[]>;
+    findOne(objectName: string, query?: EngineQueryOptions): Promise<any>;
     insert(object: string, data: any | any[], options?: DataEngineInsertOptions): Promise<any>;
-    update(object: string, data: any, options?: DataEngineUpdateOptions): Promise<any>;
-    delete(object: string, options?: DataEngineDeleteOptions): Promise<any>;
-    count(object: string, query?: DataEngineCountOptions): Promise<number>;
-    aggregate(object: string, query: DataEngineAggregateOptions): Promise<any[]>;
+    update(object: string, data: any, options?: EngineUpdateOptions): Promise<any>;
+    delete(object: string, options?: EngineDeleteOptions): Promise<any>;
+    count(object: string, query?: EngineCountOptions): Promise<number>;
+    aggregate(object: string, query: EngineAggregateOptions): Promise<any[]>;
     execute(command: any, options?: Record<string, any>): Promise<any>;
     /**
      * Register a single object definition.
@@ -1897,9 +1907,13 @@ declare class ObjectQLPlugin implements Plugin {
     /**
      * Synchronize all registered object schemas to the database.
      *
-     * Iterates every object in the SchemaRegistry and calls the
-     * responsible driver's `syncSchema()` for each one.  This is
-     * idempotent — drivers must tolerate repeated calls without
+     * Groups objects by their responsible driver, then:
+     * - If the driver advertises `supports.batchSchemaSync` and implements
+     *   `syncSchemasBatch()`, submits all schemas in a single call (reducing
+     *   network round-trips for remote drivers like Turso).
+     * - Otherwise falls back to sequential `syncSchema()` per object.
+     *
+     * This is idempotent — drivers must tolerate repeated calls without
      * duplicating tables or erroring out.
      *
      * Drivers that do not implement `syncSchema` are silently skipped.

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 import * as _objectstack_spec_data from '@objectstack/spec/data';
-import { ServiceObject, ObjectOwnership, HookContext, QueryAST, DataEngineQueryOptions, DataEngineInsertOptions, DataEngineUpdateOptions, DataEngineDeleteOptions, DataEngineCountOptions, DataEngineAggregateOptions } from '@objectstack/spec/data';
+import { ObjectOwnership, ServiceObject, QueryAST, HookContext, EngineQueryOptions, DataEngineInsertOptions, EngineUpdateOptions, EngineDeleteOptions, EngineCountOptions, EngineAggregateOptions } from '@objectstack/spec/data';
 import { ObjectStackManifest, InstalledPackage, ExecutionContext } from '@objectstack/spec/kernel';
 import { ObjectStackProtocol, MetadataCacheRequest, MetadataCacheResponse, BatchUpdateRequest, BatchUpdateResponse, UpdateManyDataRequest, DeleteManyDataRequest } from '@objectstack/spec/api';
 import { IDataEngine, DriverInterface, Logger, Plugin, PluginContext, ObjectKernel } from '@objectstack/core';
@@ -1289,6 +1289,7 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
         routes: {
             data: string;
             metadata: string;
+            discovery?: string | undefined;
             ui?: string | undefined;
             auth?: string | undefined;
             automation?: string | undefined;
@@ -1301,6 +1302,7 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
             notifications?: string | undefined;
             ai?: string | undefined;
             i18n?: string | undefined;
+            feed?: string | undefined;
         };
         services: Record<string, {
             enabled: boolean;
@@ -1316,15 +1318,10 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
                 retryAfterMs?: number | undefined;
             } | undefined;
         }>;
-        capabilities: {
-            feed: boolean;
-            comments: boolean;
-            automation: boolean;
-            cron: boolean;
-            search: boolean;
-            export: boolean;
-            chunkedUpload: boolean;
-        };
+        capabilities: Record<string, {
+            enabled: boolean;
+            description?: string;
+        }>;
     }>;
     getMetaTypes(): Promise<{
         types: string[];
@@ -1453,6 +1450,20 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
     }): Promise<{
         success: boolean;
         message: string;
+        warning?: undefined;
+    } | {
+        success: boolean;
+        message: string;
+        warning: any;
+    }>;
+    /**
+     * Hydrate SchemaRegistry from the database on startup.
+     * Loads all active metadata records and registers them in the in-memory registry.
+     * Safe to call repeatedly — idempotent (latest DB record wins).
+     */
+    loadMetaFromDb(): Promise<{
+        loaded: number;
+        errors: number;
     }>;
     listFeed(request: any): Promise<any>;
     createFeedItem(request: any): Promise<any>;
@@ -1652,14 +1663,13 @@ declare class ObjectQL implements IDataEngine {
      * @returns Records with expanded lookup fields (IDs replaced by full objects)
      */
     private expandRelatedRecords;
-    private toQueryAST;
-    find(object: string, query?: DataEngineQueryOptions): Promise<any[]>;
-    findOne(objectName: string, query?: DataEngineQueryOptions): Promise<any>;
+    find(object: string, query?: EngineQueryOptions): Promise<any[]>;
+    findOne(objectName: string, query?: EngineQueryOptions): Promise<any>;
     insert(object: string, data: any | any[], options?: DataEngineInsertOptions): Promise<any>;
-    update(object: string, data: any, options?: DataEngineUpdateOptions): Promise<any>;
-    delete(object: string, options?: DataEngineDeleteOptions): Promise<any>;
-    count(object: string, query?: DataEngineCountOptions): Promise<number>;
-    aggregate(object: string, query: DataEngineAggregateOptions): Promise<any[]>;
+    update(object: string, data: any, options?: EngineUpdateOptions): Promise<any>;
+    delete(object: string, options?: EngineDeleteOptions): Promise<any>;
+    count(object: string, query?: EngineCountOptions): Promise<number>;
+    aggregate(object: string, query: EngineAggregateOptions): Promise<any[]>;
     execute(command: any, options?: Record<string, any>): Promise<any>;
     /**
      * Register a single object definition.
@@ -1897,9 +1907,13 @@ declare class ObjectQLPlugin implements Plugin {
     /**
      * Synchronize all registered object schemas to the database.
      *
-     * Iterates every object in the SchemaRegistry and calls the
-     * responsible driver's `syncSchema()` for each one.  This is
-     * idempotent — drivers must tolerate repeated calls without
+     * Groups objects by their responsible driver, then:
+     * - If the driver advertises `supports.batchSchemaSync` and implements
+     *   `syncSchemasBatch()`, submits all schemas in a single call (reducing
+     *   network round-trips for remote drivers like Turso).
+     * - Otherwise falls back to sequential `syncSchema()` per object.
+     *
+     * This is idempotent — drivers must tolerate repeated calls without
      * duplicating tables or erroring out.
      *
      * Drivers that do not implement `syncSchema` are silently skipped.