Merge pull request #1037 from objectstack-ai/copilot/remove-value-field-from-data-api

Author: hotlong

CHANGELOG.md

@@ -27,6 +27,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   reports listing every declared endpoint and its implementation status.
 - `ai` v6 as a dependency of `@objectstack/spec` for type re-exports
 
+### Removed
+- **Removed `value` field from data API responses** — The `findData` protocol
+  implementation no longer returns the deprecated `value` field alongside `records`.
+  Only `records` is returned, matching the `FindDataResponseSchema` spec. All
+  downstream consumers (Studio, app-host example, tests) updated to use `records`
+  exclusively. OData-specific responses (`ODataResponseSchema`) retain `value` per
+  the OData v4 standard — protocol-to-OData adaptation is handled in the HTTP
+  dispatch layer.
+
 ### Changed
 - **AI Chat Protocol Aligned with Vercel AI SDK** — Removed custom AI chat protocol
   types and Zod schemas (`AIMessage`, `AIToolCall`, `AIStreamEvent`,

apps/studio/ROADMAP.md

@@ -58,7 +58,7 @@
 | # | Task | Details |
 |---|------|---------|
 | 0.1 | **Add URL Router** | Integrate TanStack Router or React Router. Map views to URL paths: `/:package/objects/:name`, `/:package/metadata/:type/:name`, `/packages`, `/settings`. Enable browser back/forward and deep linking. |
-| 0.2 | **Centralize response normalization** | Create `src/lib/api-utils.ts` with `normalizeRecords()`, `normalizeMetadata()`. Remove inline `.records || .value || .data` from all components. |
+| 0.2 | **~~Centralize response normalization~~** | ✅ Done — `value` field removed from protocol implementation. All components now use `records` directly (spec-compliant). |
 | 0.3 | **Wire plugin sidebar groups** | Replace hardcoded `PROTOCOL_GROUPS` in `app-sidebar.tsx` with plugin-contributed `useSidebarGroups()`. |
 | 0.4 | **Clean dead code** | Remove stale `types.ts`, empty `app/dashboard/` directory. |
 | 0.5 | **Add React Testing Library** | Set up component test infrastructure. Write baseline tests for `ObjectDataTable`, `ObjectDataForm`, `AppSidebar`, Plugin system. Target: 50% component coverage. |

apps/studio/src/components/ObjectDataTable.tsx

@@ -123,7 +123,7 @@ export function ObjectDataTable({ objectApiName, onEdit }: ObjectDataTableProps)
 
                 if (mounted) {
                     // Spec: FindDataResponse = { object, records, total?, hasMore? }
-                    const records = result?.records || result?.value || (Array.isArray(result) ? result : []);
+                    const records = result?.records || (Array.isArray(result) ? result : []);
                     setRecords(records);
                     if (typeof result?.total === 'number') setTotal(result.total);
                     else if (typeof result?.count === 'number') setTotal(result.count);
@@ -150,7 +150,7 @@ export function ObjectDataTable({ objectApiName, onEdit }: ObjectDataTableProps)
                 }
             });
             // Spec: FindDataResponse = { object, records, total? }
-            const records = result?.records || result?.value || (Array.isArray(result) ? result : []);
+            const records = result?.records || (Array.isArray(result) ? result : []);
             setRecords(records);
             if (typeof result?.total === 'number') setTotal(result.total);
             else if (typeof result?.count === 'number') setTotal(result.count);
@@ -170,7 +170,7 @@ export function ObjectDataTable({ objectApiName, onEdit }: ObjectDataTableProps)
                 }
             });
             // Spec: FindDataResponse = { object, records, total? }
-            const records = result?.records || result?.value || (Array.isArray(result) ? result : []);
+            const records = result?.records || (Array.isArray(result) ? result : []);
             setRecords(records);
             if (typeof result?.total === 'number') setTotal(result.total);
             else if (typeof result?.count === 'number') setTotal(result.count);

apps/studio/test/api.test.ts

@@ -4,11 +4,11 @@ import { simulateBrowser } from '../src/mocks/simulateBrowser';
 /**
  * Helper: extract records array from the API response.
  * The client strips the HTTP envelope ({ success, data }) and returns the protocol response.
- * Protocol responses use `records` (spec-compliant) or `value` (deprecated alias).
+ * Protocol responses use `records` (spec-compliant).
  */
 function extractRecords(response: any): any[] {
     if (Array.isArray(response)) return response;
-    return response?.records || response?.value || response?.data || [];
+    return response?.records || response?.data || [];
 }
 
 describe('App React CRUD Integration Tests (Virtual Browser)', () => {

examples/app-host/public/index.html

@@ -41,7 +41,7 @@
             getData: async (object) => {
                 const res = await fetch(`/api/v1/data/${object}`);
                 const json = await res.json();
-                return json.value || []; 
+                return json.records || []; 
             }
         };
 

examples/app-host/test/e2e.test.ts

@@ -104,12 +104,12 @@ async function run() {
         // 5. Test Data
         console.log('Testing Data Fetch...');
         const result = await client.data.find('todo_task', { top: 10 });
-        console.log(`Received ${result.value?.length || 0} records`);
+        console.log(`Received ${result.records?.length || 0} records`);
 
-        expect(result.value).toBeDefined();
-        expect(result.value.length).toBeGreaterThan(0);
+        expect(result.records).toBeDefined();
+        expect(result.records.length).toBeGreaterThan(0);
 
-        const subjects = result.value.map((r: any) => r.subject);
+        const subjects = result.records.map((r: any) => r.subject);
         console.log('Task Subjects:', subjects);
         expect(subjects).toContain('Learn ObjectStack');
         expect(subjects).toContain('Build a cool app');

packages/objectql/src/protocol.ts

@@ -481,10 +481,11 @@ export class ObjectStackProtocolImplementation implements ObjectStackProtocol {
         }
 
         const records = await this.engine.find(request.object, options);
+        // Spec: FindDataResponseSchema — only `records` is returned.
+        // OData `value` adaptation (if needed) is handled in the HTTP dispatch layer.
         return {
             object: request.object,
-            value: records, // OData compatibility
-            records, // Legacy
+            records,
             total: records.length,
             hasMore: false
         };