Merge pull request #877 from objectstack-ai/copilot/unify-id-field-naming

Author: hotlong

ROADMAP.md

@@ -126,6 +126,7 @@ This strategy ensures rapid iteration while maintaining a clear path to producti
 | CI lint rule rejecting new `z.any()` | 🔴 | Planned — eslint or custom lint rule to block `z.any()` additions |
 | Dispatcher async `getService` bug fix | ✅ | All `getService`/`getObjectQLService` calls in `http-dispatcher.ts` now properly `await` async service factories. Covers `handleAnalytics`, `handleAuth`, `handleStorage`, `handleAutomation`, `handleMetadata`, `handleUi`, `handlePackages`. All 7 framework adapters (Express, Fastify, Hono, Next.js, SvelteKit, NestJS, Nuxt) updated to use `getServiceAsync()` for auth service resolution. |
 | Analytics `getMetadata` → `getMeta` naming fix | ✅ | `handleAnalytics` in `http-dispatcher.ts` called `getMetadata({ request })` which didn't match the `IAnalyticsService` contract (`getMeta(cubeName?: string)`). Renamed to `getMeta()` and aligned call signature. Updated test mocks accordingly. |
+| Unified ID/audit/tenant field naming | ✅ | Eliminated `_id`/`modified_at`/`modified_by`/`space_id` from protocol layer. All protocol code uses `id`, `updated_at`, `updated_by`, `tenant_id` per `SystemFieldName`. Storage-layer (NoSQL driver internals) retains `_id` for MongoDB/Mingo compat. |
 
 ---
 

apps/studio/src/components/ObjectDataForm.tsx

@@ -57,7 +57,6 @@ export function ObjectDataForm({ objectApiName, record, onSuccess, onCancel }: O
 
         try {
             const dataToSubmit = { ...formData };
-            delete dataToSubmit._id;
             delete dataToSubmit.id;
             delete dataToSubmit.created_at;
             delete dataToSubmit.updated_at;
@@ -71,8 +70,8 @@ export function ObjectDataForm({ objectApiName, record, onSuccess, onCancel }: O
                 });
             }
 
-            if (record && (record.id || record._id)) {
-                await client.data.update(objectApiName, record.id || record._id, dataToSubmit);
+            if (record && record.id) {
+                await client.data.update(objectApiName, record.id, dataToSubmit);
             } else {
                 await client.data.create(objectApiName, dataToSubmit);
             }
@@ -109,10 +108,10 @@ export function ObjectDataForm({ objectApiName, record, onSuccess, onCancel }: O
 
     const fields = def.fields || {};
     const fieldKeys = Object.keys(fields).filter(k => {
-        return !['created_at', 'updated_at', 'created_by', 'modified_by'].includes(k);
+        return !['created_at', 'updated_at', 'created_by', 'updated_by'].includes(k);
     });
 
-    const isEdit = !!(record && (record.id || record._id));
+    const isEdit = !!(record && record.id);
 
     return (
         <Dialog open={true} onOpenChange={(open) => !open && onCancel()}>

apps/studio/src/components/ObjectDataTable.tsx

@@ -277,7 +277,7 @@ export function ObjectDataTable({ objectApiName, onEdit }: ObjectDataTableProps)
                             {loading && records.length === 0 ? (
                                 <TableSkeleton cols={columns.length} />
                             ) : filteredRecords.map(record => (
-                                <TableRow key={record.id || record._id} className="group">
+                                <TableRow key={record.id} className="group">
                                     {columns.map(col => (
                                         <TableCell key={col.name} className="py-2.5">
                                             <CellValue value={record[col.name]} type={col.type} />
@@ -302,7 +302,7 @@ export function ObjectDataTable({ objectApiName, onEdit }: ObjectDataTableProps)
                                                 </DropdownMenuItem>
                                                 <DropdownMenuSeparator />
                                                 <DropdownMenuItem 
-                                                    onClick={() => handleDelete(record.id || record._id)}
+                                                    onClick={() => handleDelete(record.id)}
                                                     className="text-destructive focus:text-destructive"
                                                 >
                                                     <Trash2 className="mr-2 h-4 w-4" />

apps/studio/src/mocks/createKernel.ts

@@ -65,7 +65,7 @@ export async function createKernel(options: KernelOptions) {
                 if (method === 'create') {
                      const res = await ql.insert(params.object, params.data);
                      const record = { ...params.data, ...res };
-                     return { object: params.object, id: record.id || record._id, record };
+                     return { object: params.object, id: record.id, record };
                 }
                 if (method === 'get') {
                      // Delegate to protocol for proper expand/select support
@@ -74,7 +74,7 @@ export async function createKernel(options: KernelOptions) {
                      }
                      let all = await ql.find(params.object);
                      if (!all) all = [];
-                     const match = all.find((i: any) => i.id === params.id || i._id === params.id);
+                     const match = all.find((i: any) => i.id === params.id);
                      return match ? { object: params.object, id: params.id, record: match } : null;
                 }
                 if (method === 'update') {
@@ -85,7 +85,7 @@ export async function createKernel(options: KernelOptions) {
                          if (all && (all as any).value) all = (all as any).value;
                          if (!all) all = [];
 
-                         const existing = all.find((i: any) => i.id === params.id || i._id === params.id);
+                         const existing = all.find((i: any) => i.id === params.id);
 
                          if (!existing) {
                              console.warn(`[BrokerShim] Update failed: Record ${params.id} not found.`);
@@ -183,7 +183,7 @@ export async function createKernel(options: KernelOptions) {
                              : String(queryOptions.select).split(',').map((s: string) => s.trim());
 
                         all = all.map((item: any) => {
-                            const projected: any = { id: item.id, _id: item._id }; // Always include ID
+                            const projected: any = { id: item.id }; // Always include ID
                             selectFields.forEach((f: string) => {
                                 if (item[f] !== undefined) projected[f] = item[f];
                             });

apps/studio/src/types.ts

@@ -4,8 +4,7 @@
  * Task type definition (todo_task)
  */
 export interface Task {
-  _id: string; // Internal ID
-  id: string; // External ID usually, but here we might get _id or id depending on driver
+  id: string;
   subject: string;
   priority: number;
   is_completed: boolean;

content/docs/guides/standards.mdx

@@ -545,7 +545,7 @@ describe('Account Object', () => {
 - [ ] All objects use `ObjectSchema.create()`
 - [ ] Field names are `snake_case`
 - [ ] Config keys are `camelCase`
-- [ ] Lookups don't have `_id` suffix
+- [ ] Lookups don't have `_id` suffix (use `id`)
 - [ ] All validations have clear messages
 - [ ] Documentation is up to date
 - [ ] Tests pass

content/docs/protocol/objectql/index.mdx

@@ -147,7 +147,7 @@ const query: Query = {
 -- PostgreSQL (with JOIN)
 SELECT c.company_name, c.industry, u.name AS "owner.name"
 FROM customer c
-LEFT JOIN user u ON c.owner_id = u._id
+LEFT JOIN user u ON c.owner_id = u.id
 WHERE c.industry = 'tech' AND c.annual_revenue > 1000000
 ORDER BY c.created_at DESC
 LIMIT 10;

content/docs/protocol/objectql/query-syntax.mdx

@@ -407,7 +407,7 @@ SELECT
   o.amount, 
   a.company_name AS "account.company_name"
 FROM opportunity o
-LEFT JOIN account a ON o.account_id = a._id
+LEFT JOIN account a ON o.account_id = a.id
 ```
 
 ### Multiple Relationships
@@ -594,7 +594,7 @@ const query = {
     ['exists', {
       object: 'opportunity',
       filters: [
-        ['account_id', '=', '{{parent._id}}'],
+        ['account_id', '=', '{{parent.id}}'],
         ['stage', '=', 'Closed Won']
       ]
     }]
@@ -603,7 +603,7 @@ const query = {
 
 // SQL: WHERE EXISTS (
 //   SELECT 1 FROM opportunity 
-//   WHERE opportunity.account_id = account._id 
+//   WHERE opportunity.account_id = account.id 
 //   AND opportunity.stage = 'Closed Won'
 // )
 ```
@@ -617,7 +617,7 @@ const query = {
     ['not_exists', {
       object: 'opportunity',
       filters: [
-        ['account_id', '=', '{{parent._id}}']
+        ['account_id', '=', '{{parent.id}}']
       ]
     }]
   ]
@@ -778,17 +778,17 @@ const page2 = await ObjectQL.query({
 const result = await ObjectQL.query({
   object: 'customer',
   limit: 10,
-  sort: [{ field: '_id', order: 'asc' }]
+  sort: [{ field: 'id', order: 'asc' }]
 });
 
-// Next page (use last _id as cursor)
+// Next page (use last id as cursor)
 const nextResult = await ObjectQL.query({
   object: 'customer',
   filters: [
-    ['_id', '>', result[result.length - 1]._id]
+    ['id', '>', result[result.length - 1].id]
   ],
   limit: 10,
-  sort: [{ field: '_id', order: 'asc' }]
+  sort: [{ field: 'id', order: 'asc' }]
 });
 ```
 
@@ -808,7 +808,7 @@ const customer = await ObjectQL.findOne('customer', '123');
 // Equivalent to:
 await ObjectQL.query({
   object: 'customer',
-  filters: [['_id', '=', '123']],
+  filters: [['id', '=', '123']],
   limit: 1
 });
 ```

content/docs/protocol/objectql/schema.mdx

@@ -75,7 +75,7 @@ label: Project
 ```
 
 This 2-line definition creates:
-- Database table `project` with system fields (`_id`, `created_at`, `updated_at`)
+- Database table `project` with system fields (`id`, `created_at`, `updated_at`)
 - REST API: `GET/POST/PUT/DELETE /api/project`
 - Admin UI: List view + Form
 - TypeScript types
@@ -303,7 +303,7 @@ Every object automatically includes system fields:
 
 ```yaml
 # Auto-generated (not defined in .object.yml)
-_id:
+id:
   type: id
   label: Record ID
   read_only: true
@@ -637,7 +637,7 @@ parent_id:
 Query polymorphic fields:
 ```typescript
 const activity = await ObjectQL.findOne('activity', id);
-// activity.parent_id = { _id: '123', _type: 'account' }
+// activity.parent_id = { id: '123', _type: 'account' }
 ```
 
 ### Computed Fields (Virtual)

content/docs/protocol/objectql/security.mdx

@@ -256,7 +256,7 @@ const user = await ObjectQL.findOne('user', '123');
 
 // Result (salary/ssn stripped):
 // {
-//   _id: '123',
+//   id: '123',
 //   name: 'John Doe',
 //   email: 'john@example.com'
 //   // salary: REMOVED
@@ -268,7 +268,7 @@ const user = await ObjectQL.findOne('user', '123');
 
 // Result (salary visible):
 // {
-//   _id: '123',
+//   id: '123',
 //   name: 'John Doe',
 //   email: 'john@example.com',
 //   salary: { amount: 120000, currency: 'USD' }