@open-mercato/shared 0.6.1-develop.3090.06ab462170 → 0.6.1-develop.3102.d6e7e6d57a

package/dist/lib/version.js

@@ -1,4 +1,4 @@
-const APP_VERSION = "0.6.1-develop.3090.06ab462170";
+const APP_VERSION = "0.6.1-develop.3102.d6e7e6d57a";
 const appVersion = APP_VERSION;
 export {
   APP_VERSION,

package/dist/lib/version.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/lib/version.ts"],
-  "sourcesContent": ["// Build-time generated version\nexport const APP_VERSION = '0.6.1-develop.3090.06ab462170'\nexport const appVersion = APP_VERSION\n"],
+  "sourcesContent": ["// Build-time generated version\nexport const APP_VERSION = '0.6.1-develop.3102.d6e7e6d57a'\nexport const appVersion = APP_VERSION\n"],
   "mappings": "AACO,MAAM,cAAc;AACpB,MAAM,aAAa;",
   "names": []
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-mercato/shared",
-  "version": "0.6.1-develop.3090.06ab462170",
+  "version": "0.6.1-develop.3102.d6e7e6d57a",
   "type": "module",
   "main": "./dist/index.js",
   "scripts": {
@@ -89,10 +89,10 @@
     }
   },
   "dependencies": {
-    "@mikro-orm/core": "^7.0.13",
-    "@mikro-orm/decorators": "^7.0.13",
-    "@mikro-orm/postgresql": "^7.0.13",
-    "@open-mercato/cache": "0.6.1-develop.3090.06ab462170",
+    "@mikro-orm/core": "^7.0.14",
+    "@mikro-orm/decorators": "^7.0.14",
+    "@mikro-orm/postgresql": "^7.0.14",
+    "@open-mercato/cache": "0.6.1-develop.3102.d6e7e6d57a",
     "dotenv": "^17.4.2",
     "rate-limiter-flexible": "^11.0.1",
     "reflect-metadata": "^0.2.2",

package/src/lib/crud/__tests__/custom-fields.test.ts

@@ -1,4 +1,5 @@
 import {
+  applyCustomFieldsNormalization,
   buildCustomFieldFiltersFromQuery,
   decorateRecordWithCustomFields,
   extractAllCustomFieldEntries,
@@ -298,6 +299,62 @@ describe('decorateRecordWithCustomFields', () => {
   })
 })
 
+describe('applyCustomFieldsNormalization', () => {
+  const definitionIndex: CustomFieldDefinitionIndex = new Map([
+    [
+      'priority',
+      [
+        {
+          key: 'priority',
+          label: 'Priority',
+          kind: 'integer',
+          multi: false,
+          organizationId: null,
+          tenantId: null,
+          priority: 0,
+          updatedAt: 1,
+        },
+      ],
+    ],
+  ])
+
+  it('preserves cf_* keys by default for backward compatibility', () => {
+    const record = { id: 'r-1', name: 'Item', cf_priority: 5, 'cf:priority': 5 }
+    const decorated = decorateRecordWithCustomFields(record, definitionIndex, {})
+    const result = applyCustomFieldsNormalization(record, decorated)
+
+    expect(result.id).toBe('r-1')
+    expect(result.cf_priority).toBe(5)
+    expect(result['cf:priority']).toBe(5)
+    expect(result.customValues).toEqual({ priority: 5 })
+    expect(Array.isArray(result.customFields)).toBe(true)
+    expect((result.customFields as any[])[0]).toMatchObject({ key: 'priority', value: 5 })
+  })
+
+  it('strips cf_* and cf:* keys when stripPrefixedKeys is enabled (issue #1769)', () => {
+    const record = { id: 'r-1', name: 'Item', cf_priority: 5, 'cf:priority': 5 }
+    const decorated = decorateRecordWithCustomFields(record, definitionIndex, {})
+    const result = applyCustomFieldsNormalization(record, decorated, { stripPrefixedKeys: true })
+
+    expect(result.id).toBe('r-1')
+    expect(result.name).toBe('Item')
+    expect('cf_priority' in result).toBe(false)
+    expect('cf:priority' in result).toBe(false)
+    expect(result.customValues).toEqual({ priority: 5 })
+    expect(Array.isArray(result.customFields)).toBe(true)
+  })
+
+  it('emits null customValues when no active definitions match', () => {
+    const record = { id: 'r-1', cf_unknown: 'leftover' }
+    const decorated = decorateRecordWithCustomFields(record, new Map(), {})
+    const result = applyCustomFieldsNormalization(record, decorated, { stripPrefixedKeys: true })
+
+    expect(result.customValues).toBeNull()
+    expect(result.customFields).toEqual([])
+    expect('cf_unknown' in result).toBe(false)
+  })
+})
+
 describe('loadCustomFieldDefinitionIndex', () => {
   it('filters definition summaries by selected fieldset membership', async () => {
     const em = mockEntityManager([

package/src/lib/crud/custom-fields.ts

@@ -406,6 +406,32 @@ export async function loadCustomFieldDefinitionIndex(opts: {
   return index
 }
 
+export type ApplyCustomFieldsNormalizationOptions = {
+  /**
+   * When true, removes raw `cf_*` and `cf:*` keys from the record once they
+   * have been extracted into `customValues` / `customFields`. Produces a single
+   * canonical response shape (issue #1769). Defaults to `false` to preserve the
+   * existing wire format for callers that read `cf_*` from the top level.
+   */
+  stripPrefixedKeys?: boolean
+}
+
+export function applyCustomFieldsNormalization(
+  record: Record<string, unknown>,
+  decorated: CustomFieldDisplayPayload,
+  options: ApplyCustomFieldsNormalizationOptions = {},
+): Record<string, unknown> {
+  const stripPrefixedKeys = options.stripPrefixedKeys === true
+  const base: Record<string, unknown> = {}
+  for (const [key, value] of Object.entries(record)) {
+    if (stripPrefixedKeys && (key.startsWith('cf_') || key.startsWith('cf:'))) continue
+    base[key] = value
+  }
+  base.customValues = decorated.customValues
+  base.customFields = decorated.customFields
+  return base
+}
+
 export function decorateRecordWithCustomFields(
   record: Record<string, unknown>,
   definitions: CustomFieldDefinitionIndex,

package/src/lib/crud/factory.ts

@@ -30,6 +30,7 @@ import {
   extractCustomFieldValuesFromPayload,
   extractAllCustomFieldEntries,
   decorateRecordWithCustomFields,
+  applyCustomFieldsNormalization,
   loadCustomFieldDefinitionIndex,
 } from './custom-fields'
 import { serializeExport, normalizeExportFormat, defaultExportFilename, ensureColumns, type CrudExportFormat, type PreparedExport } from './exporters'
@@ -162,6 +163,14 @@ export type CustomFieldsConfig =
 export type CrudListCustomFieldDecorator = {
   entityIds: EntityId | EntityId[]
   resolveContext?: (item: any, ctx: CrudCtx) => { organizationId?: string | null; tenantId?: string | null }
+  /**
+   * When true, the factory removes raw `cf_*` and `cf:*` keys from each list
+   * item after extracting them into `customValues` / `customFields`. Recommended
+   * for new modules — produces the single canonical response shape requested in
+   * #1769. Defaults to `false` so existing callers that read `cf_*` from the
+   * top level keep working until they migrate.
+   */
+  stripPrefixedKeys?: boolean
 }
 
 export type ListConfig<TList> = {
@@ -924,12 +933,9 @@ export function makeCrudRoute<TCreate = any, TUpdate = any, TList = any>(opts: C
           organizationId: organizationId ?? null,
           tenantId: tenantId ?? null,
         })
-        const output = {
-          ...item,
-          customValues: decorated.customValues,
-          customFields: decorated.customFields,
-        }
-        return output
+        return applyCustomFieldsNormalization(item, decorated, {
+          stripPrefixedKeys: listCustomFieldDecorator.stripPrefixedKeys === true,
+        })
       })
       cfProfiler.mark('decorate_complete', { itemCount: decoratedItems.length })
       endProfile({