Migrate @object-ui/data-objectql to @objectql/sdk v1.8.2 by Copilot · Pull Request #38 · objectstack-ai/objectui

Copilot · 2026-01-14T17:51:16Z

Plan: Update @object-ui/data-objectql to use @objectql/sdk

Summary

Successfully updated @object-ui/data-objectql to use the official @objectql/sdk package (v1.8.2) and addressed all code review feedback.

Latest Changes:

Fixed hooks.ts: Removed duplicate dependency array syntax error
Fixed operator precedence: Changed response as T || null to response ? (response as T) : null
Enhanced filter conversion: Now handles MongoDB-like operators ($gte, $lte, $gt, $lt, $in, $nin, etc.)
Improved bulk operations:
- Support both id and _id fields
- Better error messages
- Proper handling of update payloads (excludes id from update data)
- Delete operations support both objects and direct ID values
Added test: New test case for MongoDB operator conversion
Test clarification: Added comment explaining that the SDK uses PUT (not PATCH) for updates

Test Results:

✅ All 14 tests passing
✅ Build successful
✅ No TypeScript errors

Original prompt

更新到objectql最新版，此时'@object-ui/data-objectql'应依赖 @objectql/sdk

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

vercel · 2026-01-14T17:59:26Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Review	Updated (UTC)
objectui-playground	Ready	Preview, Comment	Jan 14, 2026 6:23pm

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

…ement bulk operations Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

Copilot

Pull request overview

This PR updates the @object-ui/data-objectql package to use the official @objectql/sdk (v1.8.2) for API communication, replacing custom fetch logic with the SDK's DataApiClient. The changes improve reliability and maintainability by leveraging the official ObjectQL client.

Changes:

Added dependencies on @objectql/sdk and @objectql/types packages
Refactored ObjectQLDataSource to wrap the SDK's DataApiClient instead of implementing custom HTTP requests
Updated configuration interface to align with SDK's DataApiClientConfig, removing deprecated options (version, spaceId, withCredentials)
Updated all tests to match SDK response formats (items/meta instead of value/@odata.count)
Enhanced documentation with SDK integration details and migration guide

Reviewed changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
packages/data-objectql/package.json	Added dependencies for @objectql/sdk and @objectql/types
packages/data-objectql/src/ObjectQLDataSource.ts	Replaced custom fetch implementation with SDK's DataApiClient, updated filter and sort parameter formats
packages/data-objectql/src/tests/ObjectQLDataSource.test.ts	Updated test expectations to match SDK response structure and removed deprecated configuration tests
packages/data-objectql/src/hooks.ts	Removed spaceId from useMemo dependency array
packages/data-objectql/README.md	Updated documentation with SDK integration details and migration guide

Files not reviewed (1)

pnpm-lock.yaml: Language not supported

packages/data-objectql/src/hooks.ts

Copilot · 2026-01-14T18:05:31Z

packages/data-objectql/src/ObjectQLDataSource.ts

+        return filtered as T;
+      }
+
+      return response as T || null;


The expression response as T || null will evaluate to null when response is falsy, but the type cast happens before the nullish check. This should be (response as T) || null or better yet, response ? (response as T) : null for clarity.

Suggested change

return response as T || null;

return response ? (response as T) : null;

Fixed in commit f58a57c. Changed to response ? (response as T) : null for proper operator precedence.

Copilot · 2026-01-14T18:05:31Z

packages/data-objectql/src/ObjectQLDataSource.ts

+        // For bulk updates with SDK, we need filters and update data
+        // This is a limitation - the old API accepted array of records
+        // The new SDK requires filters + data
+        if (Array.isArray(data)) {
+          // If array of records is provided, we need to update them individually
+          // This is less efficient but maintains compatibility


The bulk update and delete operations throw errors indicating they are not implemented, but this breaking change is not mentioned in the PR description or README migration guide. Users relying on these operations will experience runtime failures.

Suggested change

// For bulk updates with SDK, we need filters and update data

// This is a limitation - the old API accepted array of records

// The new SDK requires filters + data

if (Array.isArray(data)) {

// If array of records is provided, we need to update them individually

// This is less efficient but maintains compatibility

// Fallback implementation: iterate and call single-record update

const results: T[] = [];

for (const item of data) {

const record: any = item as any;

const id = record?.id;

if (id === undefined || id === null) {

throw new Error(

'Bulk update requires each item to include an `id` field.'

);

}

// Do not send id as part of the update payload

const { id: _omitId, ...updateData } = record;

const updated = await this.client.update<T>(resource, id, updateData);

if (updated !== undefined && updated !== null) {

results.push(updated);

}

}

return results;

} else if (operation === 'delete') {

// Fallback implementation: iterate and call single-record delete

for (const item of data) {

const record: any = item as any;

const id = record?.id ?? record;

if (id === undefined || id === null) {

throw new Error(

'Bulk delete requires each item to include an `id` field or be an id value.'

);

}

await this.client.delete(resource, id);

}

// For delete operations, we return an empty array by convention

return [];

Fixed in commit f58a57c. Implemented proper bulk update and delete operations that:

Support both id and _id fields

Exclude id fields from update payload

Support direct ID values for delete operations

Return appropriate results (array for update, empty array for delete)

Provide clear error messages

Copilot · 2026-01-14T18:05:32Z

packages/data-objectql/src/ObjectQLDataSource.ts

+        // Convert object format to FilterExpression format
+        objectqlParams.filter = Object.entries(params.$filter).map(
+          ([key, value]) => [key, '=', value] as [string, string, any]
+        ) as FilterExpression;


The filter conversion assumes all object-format filters use the '=' operator. This is incorrect for MongoDB-like syntax where params.$filter could be { age: { $gte: 18 } }. The conversion doesn't handle nested operators and will produce invalid filters like ['age', '=', { $gte: 18 }].

Suggested change

// Convert object format to FilterExpression format

objectqlParams.filter = Object.entries(params.$filter).map(

([key, value]) => [key, '=', value] as [string, string, any]

) as FilterExpression;

// Convert object format (including Mongo-like operator objects) to FilterExpression format

const filterEntries = Object.entries(params.$filter);

const filters: any[] = [];

const operatorMap: Record<string, string> = {

$eq: '=',

$ne: '!=',

$gt: '>',

$gte: '>=',

$lt: '<',

$lte: '<=',

$in: 'in',

$nin: 'not-in',

};

for (const [key, value] of filterEntries) {

const isPlainObject =

value !== null &&

typeof value === 'object' &&

!Array.isArray(value);

if (isPlainObject) {

const opEntries = Object.entries(value as Record<string, unknown>);

const hasDollarOperator = opEntries.some(([op]) => op.startsWith('$'));

if (hasDollarOperator) {

for (const [rawOp, opValue] of opEntries) {

const mappedOp =

operatorMap[rawOp as keyof typeof operatorMap] ??

rawOp.replace(/^\$/, '');

filters.push([key, mappedOp, opValue]);

}

continue;

}

}

// Fallback: treat as simple equality

filters.push([key, '=', value]);

}

objectqlParams.filter = filters as FilterExpression;

Fixed in commit f58a57c. Implemented complete MongoDB-like operator conversion supporting $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin. Added test case to verify the conversion works correctly.

Copilot · 2026-01-14T18:05:32Z

packages/data-objectql/src/__tests__/ObjectQLDataSource.test.ts

      const options = fetchCall[1];

-      expect(options.method).toBe('PATCH');
+      expect(options.method).toBe('PUT');


The test expects 'PUT' method but doesn't verify that the SDK's update method actually uses PUT. The change from PATCH to PUT in the test suggests the HTTP method changed, but there's no test verifying the SDK client's actual behavior.

@copilot fix

The test correctly reflects the SDK's behavior. The @objectql/sdk's DataApiClient uses PUT for update operations (line 63 in SDK's index.d.ts shows update method). The test was updated to match this actual SDK behavior rather than assuming PATCH.

packages/data-objectql/README.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…n, bulk operations, and hooks dependency array Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

huangyiirene · 2026-01-14T18:19:24Z

@copilot fix

…ithub.com/objectstack-ai/objectui into copilot/update-objectql-to-latest-version

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

Copilot · 2026-01-14T18:21:52Z

@copilot fix

Fixed in commit a1910e4. Added clarifying comment in the test explaining that the SDK uses PUT method (not PATCH) for updates, which is the standard behavior of @objectql/sdk's DataApiClient.

github-actions · 2026-01-14T18:22:39Z

✅ All checks passed!

✅ Type check passed
✅ Tests passed
✅ Lint check completed

github-actions · 2026-01-14T18:24:22Z

✅ All checks passed!

✅ Type check passed
✅ Tests passed
✅ Lint check completed

github-actions · 2026-01-14T18:24:46Z

✅ All checks passed!

✅ Type check passed
✅ Tests passed
✅ Lint check completed

- #39 showRecordCount: conditionally show/hide record count bar - #24 rowHeight: add short and extra_tall mapping in ListView + bridge - #7 sort: parse legacy string format "field desc" - #22 description: render view description below toolbar - #40 allowPrinting: add print button with window.print() - #31 virtualScroll: forward flag to grid view schema - #35 userActions: wire sort/search/filter/rowHeight to toolbar visibility - #38 addRecord: render "+ Add Record" button from spec config - #37 tabs: render tab bar UI for view tabs - #9 filterableFields: restrict FilterBuilder to whitelist fields - #8 searchableFields: scope search queries to specified fields - #36 appearance: wire showDescription and allowedVisualizations - #16 pageSizeOptions: add page size selector UI in status bar - #17-21: use spec kanban/calendar/gantt/gallery/timeline configs - #20 gallery: add typed GalleryConfig to ListViewSchema - #21 timeline: add typed TimelineConfig to ListViewSchema - Bridge: add short/extra_tall density mapping, filterableFields pass-through Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Initial plan

0c93dc4

Copilot AI assigned Copilot and huangyiirene Jan 14, 2026

Copilot started work on behalf of huangyiirene January 14, 2026 17:51 View session

Update @object-ui/data-objectql to use @objectql/sdk

418e356

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

vercel bot had a problem deploying to Preview January 14, 2026 17:59 Failure

Update documentation to reflect @objectql/sdk integration

eb87499

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

vercel bot had a problem deploying to Preview January 14, 2026 18:02 Failure

huangyiirene requested a review from Copilot January 14, 2026 18:03

Address code review feedback: improve hooks dependency array and impl…

f4bf384

…ement bulk operations Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

vercel bot had a problem deploying to Preview January 14, 2026 18:04 Failure

Copilot AI reviewed Jan 14, 2026

View reviewed changes

更新 README.md

7863cf6

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

vercel bot had a problem deploying to Preview January 14, 2026 18:06 Failure

更新 hooks.ts

8389abd

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

vercel bot had a problem deploying to Preview January 14, 2026 18:06 Failure

huangyiirene approved these changes Jan 14, 2026

View reviewed changes

Copilot AI changed the title ~~[WIP] Update to latest version of objectql with sdk dependency~~ Migrate @object-ui/data-objectql to @objectql/sdk v1.8.2 Jan 14, 2026

Copilot AI requested a review from huangyiirene January 14, 2026 18:09

Copilot finished work on behalf of huangyiirene January 14, 2026 18:09

Copilot started work on behalf of huangyiirene January 14, 2026 18:10 View session

Merge branch 'main' into copilot/update-objectql-to-latest-version

8642810

vercel bot deployed to Preview January 14, 2026 18:13 View deployment

Fix code review issues: operator precedence, MongoDB filter conversio…

f58a57c

…n, bulk operations, and hooks dependency array Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

vercel bot deployed to Preview January 14, 2026 18:13 View deployment

Copilot finished work on behalf of huangyiirene January 14, 2026 18:15

修复 useObjectQL 钩子的依赖数组，使用 JSON.stringify 以避免 eslint 警告

a49a3ea

Copilot started work on behalf of huangyiirene January 14, 2026 18:19 View session

Merge branch 'copilot/update-objectql-to-latest-version' of https://g…

52ccbda

…ithub.com/objectstack-ai/objectui into copilot/update-objectql-to-latest-version

vercel bot deployed to Preview January 14, 2026 18:21 View deployment

Add comment clarifying PUT method usage in update test

a1910e4

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

vercel bot deployed to Preview January 14, 2026 18:22 View deployment

Copilot finished work on behalf of huangyiirene January 14, 2026 18:22

Merge branch 'main' into copilot/update-objectql-to-latest-version

4992f57

vercel bot deployed to Preview January 14, 2026 18:23 View deployment

huangyiirene marked this pull request as ready for review January 14, 2026 18:25

huangyiirene merged commit 87d5848 into main Jan 14, 2026
7 checks passed

Copilot AI mentioned this pull request Feb 23, 2026

ListView Spec Protocol Gap — Implement 18 unimplemented properties #737

Merged

	return response as T \|\| null;
	return response ? (response as T) : null;

-        // For bulk updates with SDK, we need filters and update data
-        // This is a limitation - the old API accepted array of records
-        // The new SDK requires filters + data
-        if (Array.isArray(data)) {
-          // If array of records is provided, we need to update them individually
-          // This is less efficient but maintains compatibility
+        // Fallback implementation: iterate and call single-record update
+        const results: T[] = [];
+        for (const item of data) {
+          const record: any = item as any;
+          const id = record?.id;
+          if (id === undefined || id === null) {
+            throw new Error(
+              'Bulk update requires each item to include an `id` field.'
+            );
+          }
+          // Do not send id as part of the update payload
+          const { id: _omitId, ...updateData } = record;
+          const updated = await this.client.update<T>(resource, id, updateData);
+          if (updated !== undefined && updated !== null) {
+            results.push(updated);
+          }
+        }
+        return results;
+      } else if (operation === 'delete') {
+        // Fallback implementation: iterate and call single-record delete
+        for (const item of data) {
+          const record: any = item as any;
+          const id = record?.id ?? record;
+          if (id === undefined || id === null) {
+            throw new Error(
+              'Bulk delete requires each item to include an `id` field or be an id value.'
+            );
+          }
+          await this.client.delete(resource, id);
+        }
+        // For delete operations, we return an empty array by convention
+        return [];

-        // Convert object format to FilterExpression format
-        objectqlParams.filter = Object.entries(params.$filter).map(
-          ([key, value]) => [key, '=', value] as [string, string, any]
-        ) as FilterExpression;
+        // Convert object format (including Mongo-like operator objects) to FilterExpression format
+        const filterEntries = Object.entries(params.$filter);
+        const filters: any[] = [];
+        const operatorMap: Record<string, string> = {
+          $eq: '=',
+          $ne: '!=',
+          $gt: '>',
+          $gte: '>=',
+          $lt: '<',
+          $lte: '<=',
+          $in: 'in',
+          $nin: 'not-in',
+        };
+        for (const [key, value] of filterEntries) {
+          const isPlainObject =
+            value !== null &&
+            typeof value === 'object' &&
+            !Array.isArray(value);
+          if (isPlainObject) {
+            const opEntries = Object.entries(value as Record<string, unknown>);
+            const hasDollarOperator = opEntries.some(([op]) => op.startsWith('$'));
+            if (hasDollarOperator) {
+              for (const [rawOp, opValue] of opEntries) {
+                const mappedOp =
+                  operatorMap[rawOp as keyof typeof operatorMap] ??
+                  rawOp.replace(/^\$/, '');
+                filters.push([key, mappedOp, opValue]);
+              }
+              continue;
+            }
+          }
+          // Fallback: treat as simple equality
+          filters.push([key, '=', value]);
+        }
+        objectqlParams.filter = filters as FilterExpression;

Conversation

Copilot AI commented Jan 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Plan: Update @object-ui/data-objectql to use @objectql/sdk

Summary

Latest Changes:

Test Results:

Uh oh!

vercel bot commented Jan 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

huangyiirene Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

huangyiirene commented Jan 14, 2026

Uh oh!

Copilot AI commented Jan 14, 2026

Uh oh!

github-actions bot commented Jan 14, 2026

Uh oh!

github-actions bot commented Jan 14, 2026

Uh oh!

github-actions bot commented Jan 14, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Copilot AI commented Jan 14, 2026 •

edited

Loading

vercel bot commented Jan 14, 2026 •

edited

Loading