@objectstack/objectql 3.1.1 → 3.2.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @objectstack/objectql@3.1.1 build /home/runner/work/spec/spec/packages/objectql
+> @objectstack/objectql@3.2.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     95.52 KB
-CJS dist/index.js.map 193.28 KB
-CJS ⚡️ Build success in 194ms
 ESM dist/index.mjs     93.78 KB
 ESM dist/index.mjs.map 191.98 KB
-ESM ⚡️ Build success in 201ms
+ESM ⚡️ Build success in 179ms
+CJS dist/index.js     95.52 KB
+CJS dist/index.js.map 193.28 KB
+CJS ⚡️ Build success in 181ms
 DTS Build start
-DTS ⚡️ Build success in 20923ms
-DTS dist/index.d.mts 74.26 KB
-DTS dist/index.d.ts  74.26 KB
+DTS ⚡️ Build success in 22038ms
+DTS dist/index.d.mts 77.32 KB
+DTS dist/index.d.ts  77.32 KB

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @objectstack/objectql
 
+## 3.2.0
+
+### Patch Changes
+
+- Updated dependencies [5901c29]
+  - @objectstack/spec@3.2.0
+  - @objectstack/core@3.2.0
+  - @objectstack/types@3.2.0
+
 ## 3.1.1
 
 ### Patch Changes

package/dist/index.d.mts

@@ -462,6 +462,65 @@ declare class SchemaRegistry {
         recordTypes?: string[] | undefined;
         sharingModel?: "full" | "private" | "read" | "read_write" | undefined;
         keyPrefix?: string | undefined;
+        actions?: {
+            name: string;
+            label: string | {
+                key: string;
+                defaultValue?: string | undefined;
+                params?: Record<string, string | number | boolean> | undefined;
+            };
+            type: "url" | "script" | "modal" | "flow" | "api";
+            refreshAfter: boolean;
+            objectName?: string | undefined;
+            icon?: string | undefined;
+            locations?: ("list_toolbar" | "list_item" | "record_header" | "record_more" | "record_related" | "global_nav")[] | undefined;
+            component?: "action:button" | "action:icon" | "action:menu" | "action:group" | undefined;
+            target?: string | undefined;
+            execute?: string | undefined;
+            params?: {
+                name: string;
+                label: string | {
+                    key: string;
+                    defaultValue?: string | undefined;
+                    params?: Record<string, string | number | boolean> | undefined;
+                };
+                type: "number" | "boolean" | "date" | "lookup" | "file" | "url" | "json" | "text" | "textarea" | "email" | "phone" | "password" | "markdown" | "html" | "richtext" | "currency" | "percent" | "datetime" | "time" | "toggle" | "select" | "multiselect" | "radio" | "checkboxes" | "master_detail" | "tree" | "image" | "avatar" | "video" | "audio" | "formula" | "summary" | "autonumber" | "location" | "address" | "code" | "color" | "rating" | "slider" | "signature" | "qrcode" | "progress" | "tags" | "vector";
+                required: boolean;
+                options?: {
+                    label: string | {
+                        key: string;
+                        defaultValue?: string | undefined;
+                        params?: Record<string, string | number | boolean> | undefined;
+                    };
+                    value: string;
+                }[] | undefined;
+            }[] | undefined;
+            variant?: "link" | "primary" | "secondary" | "danger" | "ghost" | undefined;
+            confirmText?: string | {
+                key: string;
+                defaultValue?: string | undefined;
+                params?: Record<string, string | number | boolean> | undefined;
+            } | undefined;
+            successMessage?: string | {
+                key: string;
+                defaultValue?: string | undefined;
+                params?: Record<string, string | number | boolean> | undefined;
+            } | undefined;
+            visible?: string | undefined;
+            disabled?: string | boolean | undefined;
+            shortcut?: string | undefined;
+            bulkEnabled?: boolean | undefined;
+            timeout?: number | undefined;
+            aria?: {
+                ariaLabel?: string | {
+                    key: string;
+                    defaultValue?: string | undefined;
+                    params?: Record<string, string | number | boolean> | undefined;
+                } | undefined;
+                ariaDescribedBy?: string | undefined;
+                role?: string | undefined;
+            } | undefined;
+        }[] | undefined;
     } | {
         name: string;
         label: string | {
@@ -845,7 +904,7 @@ declare class SchemaRegistry {
                 objectstack: string;
             } | undefined;
         };
-        status: "error" | "disabled" | "installed" | "installing" | "upgrading" | "uninstalling";
+        status: "disabled" | "error" | "installed" | "installing" | "upgrading" | "uninstalling";
         enabled: boolean;
         installedAt?: string | undefined;
         updatedAt?: string | undefined;

package/dist/index.d.ts

@@ -462,6 +462,65 @@ declare class SchemaRegistry {
         recordTypes?: string[] | undefined;
         sharingModel?: "full" | "private" | "read" | "read_write" | undefined;
         keyPrefix?: string | undefined;
+        actions?: {
+            name: string;
+            label: string | {
+                key: string;
+                defaultValue?: string | undefined;
+                params?: Record<string, string | number | boolean> | undefined;
+            };
+            type: "url" | "script" | "modal" | "flow" | "api";
+            refreshAfter: boolean;
+            objectName?: string | undefined;
+            icon?: string | undefined;
+            locations?: ("list_toolbar" | "list_item" | "record_header" | "record_more" | "record_related" | "global_nav")[] | undefined;
+            component?: "action:button" | "action:icon" | "action:menu" | "action:group" | undefined;
+            target?: string | undefined;
+            execute?: string | undefined;
+            params?: {
+                name: string;
+                label: string | {
+                    key: string;
+                    defaultValue?: string | undefined;
+                    params?: Record<string, string | number | boolean> | undefined;
+                };
+                type: "number" | "boolean" | "date" | "lookup" | "file" | "url" | "json" | "text" | "textarea" | "email" | "phone" | "password" | "markdown" | "html" | "richtext" | "currency" | "percent" | "datetime" | "time" | "toggle" | "select" | "multiselect" | "radio" | "checkboxes" | "master_detail" | "tree" | "image" | "avatar" | "video" | "audio" | "formula" | "summary" | "autonumber" | "location" | "address" | "code" | "color" | "rating" | "slider" | "signature" | "qrcode" | "progress" | "tags" | "vector";
+                required: boolean;
+                options?: {
+                    label: string | {
+                        key: string;
+                        defaultValue?: string | undefined;
+                        params?: Record<string, string | number | boolean> | undefined;
+                    };
+                    value: string;
+                }[] | undefined;
+            }[] | undefined;
+            variant?: "link" | "primary" | "secondary" | "danger" | "ghost" | undefined;
+            confirmText?: string | {
+                key: string;
+                defaultValue?: string | undefined;
+                params?: Record<string, string | number | boolean> | undefined;
+            } | undefined;
+            successMessage?: string | {
+                key: string;
+                defaultValue?: string | undefined;
+                params?: Record<string, string | number | boolean> | undefined;
+            } | undefined;
+            visible?: string | undefined;
+            disabled?: string | boolean | undefined;
+            shortcut?: string | undefined;
+            bulkEnabled?: boolean | undefined;
+            timeout?: number | undefined;
+            aria?: {
+                ariaLabel?: string | {
+                    key: string;
+                    defaultValue?: string | undefined;
+                    params?: Record<string, string | number | boolean> | undefined;
+                } | undefined;
+                ariaDescribedBy?: string | undefined;
+                role?: string | undefined;
+            } | undefined;
+        }[] | undefined;
     } | {
         name: string;
         label: string | {
@@ -845,7 +904,7 @@ declare class SchemaRegistry {
                 objectstack: string;
             } | undefined;
         };
-        status: "error" | "disabled" | "installed" | "installing" | "upgrading" | "uninstalling";
+        status: "disabled" | "error" | "installed" | "installing" | "upgrading" | "uninstalling";
         enabled: boolean;
         installedAt?: string | undefined;
         updatedAt?: string | undefined;

package/package.json

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

package/src/protocol-data.test.ts

@@ -0,0 +1,242 @@
+// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
+
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import { ObjectStackProtocolImplementation } from './protocol.js';
+
+/**
+ * Tests for the Protocol Implementation's data methods (findData, getData).
+ * Validates that expand/populate/select parameters are correctly normalized
+ * and forwarded to the underlying engine.
+ */
+describe('ObjectStackProtocolImplementation - Data Operations', () => {
+    let protocol: ObjectStackProtocolImplementation;
+    let mockEngine: any;
+
+    beforeEach(() => {
+        mockEngine = {
+            find: vi.fn().mockResolvedValue([]),
+            findOne: vi.fn().mockResolvedValue(null),
+        };
+        protocol = new ObjectStackProtocolImplementation(mockEngine);
+    });
+
+    // ═══════════════════════════════════════════════════════════════
+    // findData — expand/populate normalization
+    // ═══════════════════════════════════════════════════════════════
+
+    describe('findData', () => {
+        it('should normalize expand string to populate array', async () => {
+            await protocol.findData({ object: 'order_item', query: { expand: 'order,product' } });
+
+            expect(mockEngine.find).toHaveBeenCalledWith(
+                'order_item',
+                expect.objectContaining({
+                    populate: ['order', 'product'],
+                }),
+            );
+            // expand should be deleted from options
+            const callArgs = mockEngine.find.mock.calls[0][1];
+            expect(callArgs.expand).toBeUndefined();
+            expect(callArgs.$expand).toBeUndefined();
+        });
+
+        it('should normalize $expand (OData) to populate array', async () => {
+            await protocol.findData({ object: 'task', query: { $expand: 'assignee,project' } });
+
+            expect(mockEngine.find).toHaveBeenCalledWith(
+                'task',
+                expect.objectContaining({
+                    populate: ['assignee', 'project'],
+                }),
+            );
+        });
+
+        it('should pass populate array as-is if already an array', async () => {
+            await protocol.findData({ object: 'task', query: { populate: ['assignee'] } });
+
+            expect(mockEngine.find).toHaveBeenCalledWith(
+                'task',
+                expect.objectContaining({
+                    populate: ['assignee'],
+                }),
+            );
+        });
+
+        it('should normalize populate string to array', async () => {
+            await protocol.findData({ object: 'task', query: { populate: 'assignee,project' } });
+
+            expect(mockEngine.find).toHaveBeenCalledWith(
+                'task',
+                expect.objectContaining({
+                    populate: ['assignee', 'project'],
+                }),
+            );
+        });
+
+        it('should prefer explicit populate over expand', async () => {
+            await protocol.findData({
+                object: 'task',
+                query: { populate: ['assignee'], expand: 'project' },
+            });
+
+            // populate takes precedence; expand is not converted
+            expect(mockEngine.find).toHaveBeenCalledWith(
+                'task',
+                expect.objectContaining({
+                    populate: ['assignee'],
+                }),
+            );
+        });
+
+        it('should normalize expand array to populate array', async () => {
+            await protocol.findData({ object: 'task', query: { expand: ['owner', 'team'] } });
+
+            expect(mockEngine.find).toHaveBeenCalledWith(
+                'task',
+                expect.objectContaining({
+                    populate: ['owner', 'team'],
+                }),
+            );
+        });
+
+        it('should normalize select string to array', async () => {
+            await protocol.findData({ object: 'task', query: { select: 'name,status,assignee' } });
+
+            expect(mockEngine.find).toHaveBeenCalledWith(
+                'task',
+                expect.objectContaining({
+                    select: ['name', 'status', 'assignee'],
+                }),
+            );
+        });
+
+        it('should pass numeric pagination params correctly', async () => {
+            await protocol.findData({ object: 'task', query: { top: '10', skip: '20' } });
+
+            expect(mockEngine.find).toHaveBeenCalledWith(
+                'task',
+                expect.objectContaining({
+                    top: 10,
+                    skip: 20,
+                }),
+            );
+        });
+
+        it('should work with no query options', async () => {
+            await protocol.findData({ object: 'task' });
+
+            expect(mockEngine.find).toHaveBeenCalledWith('task', {});
+        });
+
+        it('should return records and standard response shape', async () => {
+            mockEngine.find.mockResolvedValue([{ _id: 't1', name: 'Task 1' }]);
+
+            const result = await protocol.findData({ object: 'task', query: {} });
+
+            expect(result).toEqual(
+                expect.objectContaining({
+                    object: 'task',
+                    records: [{ _id: 't1', name: 'Task 1' }],
+                    total: 1,
+                }),
+            );
+        });
+    });
+
+    // ═══════════════════════════════════════════════════════════════
+    // getData — expand/select normalization
+    // ═══════════════════════════════════════════════════════════════
+
+    describe('getData', () => {
+        it('should convert expand string to populate array', async () => {
+            mockEngine.findOne.mockResolvedValue({ _id: 'oi_1', name: 'Item 1' });
+
+            await protocol.getData({ object: 'order_item', id: 'oi_1', expand: 'order,product' });
+
+            expect(mockEngine.findOne).toHaveBeenCalledWith(
+                'order_item',
+                expect.objectContaining({
+                    filter: { _id: 'oi_1' },
+                    populate: ['order', 'product'],
+                }),
+            );
+        });
+
+        it('should convert expand array to populate array', async () => {
+            mockEngine.findOne.mockResolvedValue({ _id: 't1' });
+
+            await protocol.getData({ object: 'task', id: 't1', expand: ['assignee', 'project'] });
+
+            expect(mockEngine.findOne).toHaveBeenCalledWith(
+                'task',
+                expect.objectContaining({
+                    populate: ['assignee', 'project'],
+                }),
+            );
+        });
+
+        it('should convert select string to array', async () => {
+            mockEngine.findOne.mockResolvedValue({ _id: 't1', name: 'Test' });
+
+            await protocol.getData({ object: 'task', id: 't1', select: 'name,status' });
+
+            expect(mockEngine.findOne).toHaveBeenCalledWith(
+                'task',
+                expect.objectContaining({
+                    select: ['name', 'status'],
+                }),
+            );
+        });
+
+        it('should pass both expand and select together', async () => {
+            mockEngine.findOne.mockResolvedValue({ _id: 'oi_1' });
+
+            await protocol.getData({
+                object: 'order_item',
+                id: 'oi_1',
+                expand: 'order',
+                select: ['name', 'total'],
+            });
+
+            expect(mockEngine.findOne).toHaveBeenCalledWith(
+                'order_item',
+                expect.objectContaining({
+                    filter: { _id: 'oi_1' },
+                    populate: ['order'],
+                    select: ['name', 'total'],
+                }),
+            );
+        });
+
+        it('should work without expand or select', async () => {
+            mockEngine.findOne.mockResolvedValue({ _id: 't1' });
+
+            await protocol.getData({ object: 'task', id: 't1' });
+
+            expect(mockEngine.findOne).toHaveBeenCalledWith(
+                'task',
+                { filter: { _id: 't1' } },
+            );
+        });
+
+        it('should return standard GetDataResponse shape', async () => {
+            mockEngine.findOne.mockResolvedValue({ _id: 'oi_1', name: 'Item 1' });
+
+            const result = await protocol.getData({ object: 'order_item', id: 'oi_1' });
+
+            expect(result).toEqual({
+                object: 'order_item',
+                id: 'oi_1',
+                record: { _id: 'oi_1', name: 'Item 1' },
+            });
+        });
+
+        it('should throw when record not found', async () => {
+            mockEngine.findOne.mockResolvedValue(null);
+
+            await expect(
+                protocol.getData({ object: 'task', id: 'missing_id' })
+            ).rejects.toThrow('not found');
+        });
+    });
+});