@open-mercato/shared 0.6.4-develop.4210.1.d412061cfe → 0.6.4-develop.4236.1.9fa6806b34

package/src/lib/query/__tests__/engine.test.ts

@@ -517,6 +517,86 @@ describe('BasicQueryEngine (Kysely)', () => {
     expect(hasInFilter).toBe(true)
   })
 
+  test('exposes resolved customFieldDefinitions when includeCustomFields is true (issue #2133)', async () => {
+    const fakeDb = createFakeKysely()
+    const engine = new BasicQueryEngine({} as any, () => fakeDb as any)
+    const res = await engine.query('auth:user', {
+      includeCustomFields: true,
+      fields: ['id'],
+      organizationId: '1',
+      tenantId: 't1',
+      page: { page: 1, pageSize: 10 },
+    })
+    expect(res.customFieldDefinitions).toBeDefined()
+    expect(res.customFieldDefinitions!.entityIds).toEqual(['auth:user'])
+    expect(res.customFieldDefinitions!.tenantId).toBe('t1')
+    expect(res.customFieldDefinitions!.organizationIds).toEqual(['1'])
+    expect(Array.from(res.customFieldDefinitions!.index.keys()).sort()).toEqual(['industry', 'vip'])
+  })
+
+  test('exposed customFieldDefinitions index drops soft-deleted and foreign-org defs', async () => {
+    const fakeDb = createFakeKysely({
+      custom_field_defs: [
+        { key: 'kept', entity_id: 'auth:user', is_active: true, config_json: '{}', kind: 'text', organization_id: null, tenant_id: 't1', updated_at: null, deleted_at: null },
+        { key: 'foreign', entity_id: 'auth:user', is_active: true, config_json: '{}', kind: 'text', organization_id: 'other-org', tenant_id: 't1', updated_at: null, deleted_at: null },
+        { key: 'gone', entity_id: 'auth:user', is_active: true, config_json: '{}', kind: 'text', organization_id: null, tenant_id: 't1', updated_at: null, deleted_at: '2026-01-01T00:00:00.000Z' },
+      ],
+      custom_field_values: [],
+    })
+    const engine = new BasicQueryEngine({} as any, () => fakeDb as any)
+    const res = await engine.query('auth:user', {
+      includeCustomFields: true,
+      fields: ['id'],
+      organizationId: 'allowed-org',
+      tenantId: 't1',
+      page: { page: 1, pageSize: 10 },
+    })
+    expect(Array.from(res.customFieldDefinitions!.index.keys())).toEqual(['kept'])
+  })
+
+  test('customFieldDefinitions entityIds include base entity plus custom field sources', async () => {
+    const fakeDb = createFakeKysely({
+      custom_field_defs: [
+        { key: 'birthday', entity_id: 'customers:customer_person_profile', is_active: true, config_json: '{}', kind: 'text', organization_id: null, tenant_id: 't1', updated_at: null, deleted_at: null },
+      ],
+      custom_field_values: [],
+      customer_entities: [],
+      customer_people: [],
+    })
+    const engine = new BasicQueryEngine({} as any, () => fakeDb as any)
+    const res = await engine.query('customers:customer_entity', {
+      tenantId: 't1',
+      includeCustomFields: true,
+      fields: ['id'],
+      customFieldSources: [
+        {
+          entityId: 'customers:customer_person_profile',
+          table: 'customer_people',
+          alias: 'person_profile',
+          recordIdColumn: 'id',
+          join: { fromField: 'id', toField: 'entity_id' },
+        },
+      ],
+      page: { page: 1, pageSize: 10 },
+    })
+    expect(res.customFieldDefinitions!.entityIds.sort()).toEqual([
+      'customers:customer_entity',
+      'customers:customer_person_profile',
+    ])
+  })
+
+  test('does not expose customFieldDefinitions when includeCustomFields is a key list', async () => {
+    const fakeDb = createFakeKysely()
+    const engine = new BasicQueryEngine({} as any, () => fakeDb as any)
+    const res = await engine.query('auth:user', {
+      includeCustomFields: ['vip'],
+      fields: ['id', 'cf:vip'],
+      tenantId: 't1',
+      page: { page: 1, pageSize: 10 },
+    })
+    expect(res.customFieldDefinitions).toBeUndefined()
+  })
+
   test('sorts encrypted base fields after decryption before pagination', async () => {
     const fakeDb = createFakeKysely({
       customer_entities: [

package/src/lib/query/engine.ts

@@ -14,6 +14,12 @@ import {
 import { resolveSearchConfig } from '../search/config'
 import { tokenizeText } from '../search/tokenize'
 import { runBeforeQueryPipeline, runAfterQueryPipeline, type QueryExtensionContext } from './query-extension-runner'
+import {
+  buildCustomFieldDefinitionIndexFromRows,
+  resolveCfDefIndexOrgCandidates,
+  type CustomFieldDefinitionRow,
+  type ResolvedCustomFieldDefinitions,
+} from '../crud/custom-field-definition-index'
 import { resolveEncryptedSortFields, sortRowsInMemory } from './encrypted-sort'
 
 type AnyDb = Kysely<any>
@@ -530,6 +536,9 @@ export class BasicQueryEngine implements QueryEngine {
       : []
     const cfKeys = new Set<string>()
     const keySource = new Map<string, ResolvedCustomFieldSource>()
+    // Custom-field definition index threaded onto the result so the CRUD factory
+    // can decorate list rows without reloading definitions from the DB (#2133).
+    let resolvedCustomFieldDefinitions: ResolvedCustomFieldDefinitions | undefined
     // Explicit in fields/filters
     for (const f of (opts.fields || [])) {
       if (typeof f === 'string' && f.startsWith('cf:')) cfKeys.add(f.slice(3))
@@ -544,21 +553,59 @@ export class BasicQueryEngine implements QueryEngine {
         entityIdList.forEach((id, idx) => entityOrder.set(id, idx))
         const rows = await db
           .selectFrom('custom_field_defs' as any)
-          .select(['key' as any, 'entity_id' as any, 'config_json' as any, 'kind' as any])
+          .select([
+            'key' as any,
+            'entity_id' as any,
+            'config_json' as any,
+            'kind' as any,
+            'organization_id' as any,
+            'tenant_id' as any,
+            'updated_at' as any,
+            'deleted_at' as any,
+          ])
           .where('entity_id' as any, 'in', entityIdList)
           .where('is_active' as any, '=', true)
           .where((eb: any) => eb.or([
             eb('tenant_id' as any, '=', tenantId),
             eb('tenant_id' as any, 'is', null),
           ]))
-          .execute() as Array<{ key: string; entity_id: string; config_json: unknown; kind: string }>
-        type CustomFieldDefinitionRow = {
+          .execute() as Array<{
+            key: string
+            entity_id: string
+            config_json: unknown
+            kind: string
+            organization_id: string | null
+            tenant_id: string | null
+            updated_at: Date | string | number | null
+            deleted_at: Date | string | number | null
+          }>
+        // Build the decoration index from the same rows, scoped exactly like the
+        // factory's loadCustomFieldDefinitionIndex (tenant + is_active already
+        // applied in SQL; org + soft-delete applied in the shared builder).
+        const orgCandidates = resolveCfDefIndexOrgCandidates(opts.organizationIds, opts.organizationId ?? null)
+        const definitionRows: CustomFieldDefinitionRow[] = rows.map((row) => ({
+          key: String(row.key),
+          entityId: String(row.entity_id),
+          kind: row.kind == null ? null : String(row.kind),
+          configJson: row.config_json,
+          organizationId: row.organization_id == null ? null : String(row.organization_id),
+          tenantId: row.tenant_id == null ? null : String(row.tenant_id),
+          deletedAt: row.deleted_at ?? null,
+          updatedAt: row.updated_at ?? null,
+        }))
+        resolvedCustomFieldDefinitions = {
+          index: buildCustomFieldDefinitionIndexFromRows(definitionRows, { organizationIds: orgCandidates }),
+          entityIds: entityIdList,
+          tenantId: tenantId ?? null,
+          organizationIds: orgCandidates,
+        }
+        type ScoredCustomFieldRow = {
           key: string
           entityId: string
           kind: string
           config: Record<string, unknown>
         }
-        const sorted: CustomFieldDefinitionRow[] = rows.map((row) => {
+        const sorted: ScoredCustomFieldRow[] = rows.map((row) => {
           const raw = row.config_json
           let cfg: Record<string, any> = {}
           if (raw && typeof raw === 'string') {
@@ -848,6 +895,12 @@ export class BasicQueryEngine implements QueryEngine {
       ) as QueryResult<T>
     }
 
+    // Attach after the extension pipeline so the field always survives even if a
+    // subscriber replaces the whole result object.
+    if (resolvedCustomFieldDefinitions) {
+      queryResult.customFieldDefinitions = resolvedCustomFieldDefinitions
+    }
+
     return queryResult
   }
 

package/src/lib/query/types.ts

@@ -1,5 +1,6 @@
 import type { EntityId } from '@open-mercato/shared/modules/entities'
 import type { Profiler } from '../profiler'
+import type { ResolvedCustomFieldDefinitions } from '../crud/custom-field-definition-index'
 
 export type FilterOp = 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'nin' | 'like' | 'ilike' | 'exists'
 
@@ -147,6 +148,14 @@ export type QueryResult<T = any> = {
   pageSize: number
   total: number
   meta?: QueryResultMeta
+  /**
+   * Custom-field definitions the engine resolved while building this result
+   * (only present when `includeCustomFields: true`). Lets the CRUD factory
+   * decorate list rows without reloading definitions from the DB (issue #2133).
+   * Internal contract — additive and optional; callers must treat absence as a
+   * cue to load definitions themselves.
+   */
+  customFieldDefinitions?: ResolvedCustomFieldDefinitions
 }
 
 export interface QueryEngine {