@objectstack/objectql 2.0.6 → 3.0.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @objectstack/objectql@2.0.6 build /home/runner/work/spec/spec/packages/objectql
+> @objectstack/objectql@3.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
-ESM dist/index.mjs     71.78 KB
-ESM dist/index.mjs.map 145.78 KB
-ESM ⚡️ Build success in 80ms
-CJS dist/index.js     73.33 KB
-CJS dist/index.js.map 146.65 KB
-CJS ⚡️ Build success in 82ms
+ESM dist/index.mjs     75.55 KB
+ESM dist/index.mjs.map 152.89 KB
+ESM ⚡️ Build success in 120ms
+CJS dist/index.js     77.09 KB
+CJS dist/index.js.map 153.77 KB
+CJS ⚡️ Build success in 127ms
 DTS Build start
-DTS ⚡️ Build success in 12684ms
-DTS dist/index.d.mts 70.72 KB
-DTS dist/index.d.ts  70.72 KB
+DTS ⚡️ Build success in 13686ms
+DTS dist/index.d.mts 75.15 KB
+DTS dist/index.d.ts  75.15 KB

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @objectstack/objectql
 
+## 3.0.0
+
+### Major Changes
+
+- Release v3.0.0 — unified version bump for all ObjectStack packages.
+
+### Patch Changes
+
+- Updated dependencies
+  - @objectstack/spec@3.0.0
+  - @objectstack/core@3.0.0
+  - @objectstack/types@3.0.0
+
+## 2.0.7
+
+### Patch Changes
+
+- Updated dependencies
+  - @objectstack/spec@2.0.7
+  - @objectstack/core@2.0.7
+  - @objectstack/types@2.0.7
+
 ## 2.0.6
 
 ### Patch Changes

package/dist/index.d.mts

@@ -353,6 +353,8 @@ declare class SchemaRegistry {
                     threshold: number;
                 } | undefined;
             } | undefined;
+            group?: string | undefined;
+            conditionalRequired?: string | undefined;
             inlineHelpText?: string | undefined;
             trackFeedHistory?: boolean | undefined;
             caseSensitive?: boolean | undefined;
@@ -430,6 +432,12 @@ declare class SchemaRegistry {
                 description?: string | undefined;
             }[]> | undefined;
         }> | undefined;
+        displayNameField?: string | undefined;
+        recordName?: {
+            type: "text" | "autonumber";
+            displayFormat?: string | undefined;
+            startNumber?: number | undefined;
+        } | undefined;
         titleFormat?: string | undefined;
         compactLayout?: string[] | undefined;
         search?: {
@@ -454,11 +462,19 @@ declare class SchemaRegistry {
         keyPrefix?: string | undefined;
     } | {
         name: string;
-        label: string;
+        label: string | {
+            key: string;
+            defaultValue?: string | undefined;
+            params?: Record<string, string | number | boolean> | undefined;
+        };
         active: boolean;
         isDefault: boolean;
         version?: string | undefined;
-        description?: string | undefined;
+        description?: string | {
+            key: string;
+            defaultValue?: string | undefined;
+            params?: Record<string, string | number | boolean> | undefined;
+        } | undefined;
         icon?: string | undefined;
         branding?: {
             primaryColor?: string | undefined;
@@ -470,11 +486,24 @@ declare class SchemaRegistry {
         requiredPermissions?: string[] | undefined;
         objects?: unknown[] | undefined;
         apis?: unknown[] | undefined;
+        mobileNavigation?: {
+            mode: "drawer" | "bottom_nav" | "hamburger";
+            bottomNavItems?: string[] | undefined;
+        } | undefined;
+        aria?: {
+            ariaLabel?: string | {
+                key: string;
+                defaultValue?: string | undefined;
+                params?: Record<string, string | number | boolean> | undefined;
+            } | undefined;
+            ariaDescribedBy?: string | undefined;
+            role?: string | undefined;
+        } | undefined;
     } | {
         manifest: {
             id: string;
             version: string;
-            type: "theme" | "driver" | "app" | "server" | "ui" | "agent" | "objectql" | "plugin" | "module" | "gateway" | "adapter";
+            type: "theme" | "driver" | "app" | "server" | "ui" | "module" | "agent" | "objectql" | "plugin" | "gateway" | "adapter";
             name: string;
             namespace?: string | undefined;
             description?: string | undefined;
@@ -542,6 +571,11 @@ declare class SchemaRegistry {
                     service: string;
                     methods?: string[] | undefined;
                 }[] | undefined;
+                commands?: {
+                    name: string;
+                    description?: string | undefined;
+                    module?: string | undefined;
+                }[] | undefined;
             } | undefined;
             data?: {
                 object: string;
@@ -636,7 +670,7 @@ declare class SchemaRegistry {
                 preload?: {
                     enabled: boolean;
                     priority: number;
-                    resources?: ("dependencies" | "code" | "metadata" | "assets" | "services")[] | undefined;
+                    resources?: ("dependencies" | "code" | "metadata" | "services" | "assets")[] | undefined;
                     conditions?: {
                         routes?: string[] | undefined;
                         roles?: string[] | undefined;
@@ -680,7 +714,7 @@ declare class SchemaRegistry {
                     healthCheckInterval?: number | undefined;
                 } | undefined;
                 dependencyResolution?: {
-                    strategy: "strict" | "latest" | "compatible" | "pinned";
+                    strategy: "strict" | "pinned" | "latest" | "compatible";
                     conflictResolution: "latest" | "manual" | "fail" | "oldest";
                     circularDependencies: "warn" | "error" | "allow";
                     peerDependencies?: {
@@ -722,7 +756,7 @@ declare class SchemaRegistry {
                 } | undefined;
                 caching?: {
                     enabled: boolean;
-                    storage: "hybrid" | "memory" | "disk" | "indexeddb";
+                    storage: "hybrid" | "indexeddb" | "memory" | "disk";
                     keyStrategy: "hash" | "version" | "timestamp";
                     ttl?: number | undefined;
                     maxSize?: number | undefined;
@@ -771,17 +805,19 @@ declare class SchemaRegistry {
                 } | undefined;
             } | undefined;
         };
-        status: "error" | "disabled" | "installed" | "installing" | "uninstalling";
+        status: "error" | "disabled" | "installed" | "installing" | "upgrading" | "uninstalling";
         enabled: boolean;
         installedAt?: string | undefined;
         updatedAt?: string | undefined;
+        installedVersion?: string | undefined;
+        previousVersion?: string | undefined;
         statusChangedAt?: string | undefined;
         errorMessage?: string | undefined;
         settings?: Record<string, unknown> | undefined;
     } | {
         id: string;
         version: string;
-        type: "theme" | "driver" | "app" | "server" | "ui" | "agent" | "objectql" | "plugin" | "module" | "gateway" | "adapter";
+        type: "theme" | "driver" | "app" | "server" | "ui" | "module" | "agent" | "objectql" | "plugin" | "gateway" | "adapter";
         name: string;
         namespace?: string | undefined;
         description?: string | undefined;
@@ -849,6 +885,11 @@ declare class SchemaRegistry {
                 service: string;
                 methods?: string[] | undefined;
             }[] | undefined;
+            commands?: {
+                name: string;
+                description?: string | undefined;
+                module?: string | undefined;
+            }[] | undefined;
         } | undefined;
         data?: {
             object: string;
@@ -943,7 +984,7 @@ declare class SchemaRegistry {
             preload?: {
                 enabled: boolean;
                 priority: number;
-                resources?: ("dependencies" | "code" | "metadata" | "assets" | "services")[] | undefined;
+                resources?: ("dependencies" | "code" | "metadata" | "services" | "assets")[] | undefined;
                 conditions?: {
                     routes?: string[] | undefined;
                     roles?: string[] | undefined;
@@ -987,7 +1028,7 @@ declare class SchemaRegistry {
                 healthCheckInterval?: number | undefined;
             } | undefined;
             dependencyResolution?: {
-                strategy: "strict" | "latest" | "compatible" | "pinned";
+                strategy: "strict" | "pinned" | "latest" | "compatible";
                 conflictResolution: "latest" | "manual" | "fail" | "oldest";
                 circularDependencies: "warn" | "error" | "allow";
                 peerDependencies?: {
@@ -1029,7 +1070,7 @@ declare class SchemaRegistry {
             } | undefined;
             caching?: {
                 enabled: boolean;
-                storage: "hybrid" | "memory" | "disk" | "indexeddb";
+                storage: "hybrid" | "indexeddb" | "memory" | "disk";
                 keyStrategy: "hash" | "version" | "timestamp";
                 ttl?: number | undefined;
                 maxSize?: number | undefined;
@@ -1126,18 +1167,7 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
     getDiscovery(): Promise<{
         version: string;
         apiName: string;
-        capabilities: {
-            graphql: boolean;
-            search: boolean;
-            websockets: boolean;
-            files: boolean;
-            analytics: boolean;
-            ai: boolean;
-            workflow: boolean;
-            notifications: boolean;
-            i18n: boolean;
-        };
-        endpoints: {
+        routes: {
             data: string;
             metadata: string;
             ui?: string | undefined;
@@ -1155,7 +1185,7 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
         };
         services: Record<string, {
             enabled: boolean;
-            status: "degraded" | "available" | "unavailable" | "stub";
+            status: "degraded" | "stub" | "available" | "unavailable";
             route?: string | undefined;
             provider?: string | undefined;
             message?: string | undefined;
@@ -1336,6 +1366,7 @@ declare class ObjectQL implements IDataEngine {
     private logger;
     private hooks;
     private middlewares;
+    private actions;
     private hostContext;
     constructor(hostContext?: Record<string, any>);
     /**
@@ -1367,6 +1398,24 @@ declare class ObjectQL implements IDataEngine {
         priority?: number;
     }): void;
     triggerHooks(event: string, context: HookContext): Promise<void>;
+    /**
+     * Register a named action on an object.
+     * Actions are custom business logic callable via `repo.execute(actionName, params)`.
+     *
+     * @param objectName Target object
+     * @param actionName Unique action name within the object
+     * @param handler Handler function
+     * @param packageName Optional package owner (for cleanup)
+     */
+    registerAction(objectName: string, actionName: string, handler: (ctx: any) => Promise<any> | any, packageName?: string): void;
+    /**
+     * Execute a named action on an object.
+     */
+    executeAction(objectName: string, actionName: string, ctx: any): Promise<any>;
+    /**
+     * Remove all actions registered by a specific package.
+     */
+    removeActionsByPackage(packageName: string): void;
     /**
      * Register a middleware function
      * Middlewares execute in onion model around every data operation.
@@ -1570,6 +1619,8 @@ declare class ObjectQL implements IDataEngine {
                     threshold: number;
                 } | undefined;
             } | undefined;
+            group?: string | undefined;
+            conditionalRequired?: string | undefined;
             inlineHelpText?: string | undefined;
             trackFeedHistory?: boolean | undefined;
             caseSensitive?: boolean | undefined;
@@ -1647,6 +1698,12 @@ declare class ObjectQL implements IDataEngine {
                 description?: string | undefined;
             }[]> | undefined;
         }> | undefined;
+        displayNameField?: string | undefined;
+        recordName?: {
+            type: "text" | "autonumber";
+            displayFormat?: string | undefined;
+            startNumber?: number | undefined;
+        } | undefined;
         titleFormat?: string | undefined;
         compactLayout?: string[] | undefined;
         search?: {
@@ -1711,21 +1768,41 @@ declare class ObjectQL implements IDataEngine {
 }
 /**
  * Repository scoped to a single object, bound to an execution context.
+ *
+ * Provides both IDataEngine-style methods (find, insert, update, delete)
+ * and convenience aliases (create, updateById, deleteById) matching
+ * the @objectql/core ObjectRepository API.
  */
 declare class ObjectRepository {
     private objectName;
     private context;
     private engine;
-    constructor(objectName: string, context: ExecutionContext, engine: IDataEngine);
+    constructor(objectName: string, context: ExecutionContext, engine: IDataEngine & {
+        executeAction?: (o: string, a: string, c: any) => Promise<any>;
+    });
     find(query?: any): Promise<any[]>;
     findOne(query?: any): Promise<any>;
     insert(data: any): Promise<any>;
+    /** Alias for insert() — matches @objectql/core convention */
+    create(data: any): Promise<any>;
     update(data: any, options?: any): Promise<any>;
+    /** Update a single record by ID */
+    updateById(id: string | number, data: any): Promise<any>;
     delete(options?: any): Promise<any>;
+    /** Delete a single record by ID */
+    deleteById(id: string | number): Promise<any>;
     count(query?: any): Promise<number>;
+    /** Aggregate query */
+    aggregate(query?: any): Promise<any[]>;
+    /** Execute a named action registered on this object */
+    execute(actionName: string, params?: any): Promise<any>;
 }
 /**
  * Scoped execution context with object() accessor.
+ *
+ * Provides identity (userId, tenantId/spaceId, roles),
+ * repository access via object(), privilege escalation via sudo(),
+ * and transactional execution via transaction().
  */
 declare class ScopedContext {
     private executionContext;
@@ -1735,9 +1812,25 @@ declare class ScopedContext {
     object(name: string): ObjectRepository;
     /** Create an elevated (system) context */
     sudo(): ScopedContext;
+    /**
+     * Execute a callback within a database transaction.
+     *
+     * The callback receives a new ScopedContext whose operations
+     * share the same transaction handle. If the callback throws,
+     * the transaction is rolled back; otherwise it is committed.
+     *
+     * Falls back to non-transactional execution if the driver
+     * does not support transactions.
+     */
+    transaction(callback: (trxCtx: ScopedContext) => Promise<any>): Promise<any>;
     get userId(): string | undefined;
     get tenantId(): string | undefined;
+    /** Alias for tenantId — matches ObjectQLContext.spaceId convention */
+    get spaceId(): string | undefined;
     get roles(): string[];
+    get isSystem(): boolean;
+    /** Internal: expose the transaction handle for driver-level access */
+    get transactionHandle(): unknown;
 }
 
 /**
@@ -1746,16 +1839,19 @@ declare class ScopedContext {
  * Provides a clean, injectable interface over SchemaRegistry.
  * Registered as the 'metadata' kernel service to eliminate
  * downstream packages needing to manually wrap SchemaRegistry.
+ *
+ * Implements the async IMetadataService interface.
+ * Internally delegates to SchemaRegistry (in-memory) with Promise wrappers.
  */
 declare class MetadataFacade {
     /**
      * Register a metadata item
      */
-    register(type: string, definition: any): void;
+    register(type: string, name: string, data: any): Promise<void>;
     /**
      * Get a metadata item by type and name
      */
-    get(type: string, name: string): any;
+    get(type: string, name: string): Promise<any>;
     /**
      * Get the raw entry (with metadata wrapper)
      */
@@ -1763,23 +1859,31 @@ declare class MetadataFacade {
     /**
      * List all items of a type
      */
-    list(type: string): any[];
+    list(type: string): Promise<any[]>;
     /**
      * Unregister a metadata item
      */
-    unregister(type: string, name: string): void;
+    unregister(type: string, name: string): Promise<void>;
+    /**
+     * Check if a metadata item exists
+     */
+    exists(type: string, name: string): Promise<boolean>;
+    /**
+     * List all names of metadata items of a given type
+     */
+    listNames(type: string): Promise<string[]>;
     /**
      * Unregister all metadata from a package
      */
-    unregisterPackage(packageName: string): void;
+    unregisterPackage(packageName: string): Promise<void>;
     /**
      * Convenience: get object definition
      */
-    getObject(name: string): any;
+    getObject(name: string): Promise<any>;
     /**
      * Convenience: list all objects
      */
-    listObjects(): any[];
+    listObjects(): Promise<any[]>;
 }
 
 declare class ObjectQLPlugin implements Plugin {