SPMenu corrupts widgetParameters (regression in 4.10.0)

[chasingtheflow]

SPMenu corrupts widgetParameters (regression in 4.10.0)

@servicenow/sdk 4.10.0 changed how the SPMenu helper serialises
widgetParameters. It now wraps each entry in a { value, displayValue }
envelope without checking whether the entry is already in that shape. Entries
written as { displayValue, value } get wrapped a second time, and
displayValue is set from String(object), so it becomes the literal
"[object Object]".

Last good version: 4.9.2. Broken in 4.10.0, 4.10.1, 4.11.0.

The build exits 0 with no warning. Installing the artifact overwrites the live
sp_instance_menu record, so the widget options it configures (enable_cart,
enable_requests, enable_tasks, ...) stop working.

Repro

import { SPMenu } from '@servicenow/sdk/core'

SPMenu({
    $id: Now.ID['repro'],
    title: 'repro',
    widget: '5ef595c1cb12020000f8d856634c9c6e', // any sp_wid
    column: '',
    widgetParameters: {
        enable_cart: { displayValue: 'false', value: false },
    },
    items: [],
})

Run now-sdk build and read <widget_parameters> from the emitted
dist/app/update/sp_instance_menu_<sys_id>.xml.

4.9.2:

{"enable_cart":{"displayValue":"false","value":false}}

4.10.0, 4.10.1, 4.11.0:

{"enable_cart":{"value":{"displayValue":"false","value":false},"displayValue":"[object Object]"}}

Scope

Only the SPMenu path is affected. A raw Record() carrying
string passes through correctly on every version:

Record({
    table: 'sp_instance_menu' as any,
    data: { widget_parameters: `{"enable_cart":{"displayValue },
})

Our project contains both forms on the same table with identi
On 4.11.0, of 7 built records carrying widget_parameters, only the SPMenu one
was corrupted. placeholderDimensions on the same SPMenu c
so this is specific to the widgetParameters serialiser.

Fix

Treat an entry that already has displayValue/value keys as final rather than
re-wrapping. If re-wrapping is intended, derive `displayValue
scalar instead of stringifying the object.

Workaround

Pin to 4.9.2, or define the record with Record() and a pre-serialised
widget_parameters string.

Environment

macOS 26.0, Node 22.22.3, pnpm 11.5.3. Scoped application, no
packageResolverVersion in now.config.json. Clean pnpm install per version,
dist/ cleared between builds.

[venkat-kaluva]

Hi @chasingtheflow — thanks for the detailed repro, this made it easy to track down.

This is a regression introduced in the SPMenu widget-parameter serialization logic , shipped in 4.10.0. We will fix this in the next patch release

Workaround until the fix ships:

Pass widgetParameters as a pre-serialized JSON string instead of an object literal:

SPMenu({
    $id: Now.ID['my-menu'],
    title: 'My Menu',
    widget: '...',
    widgetParameters: JSON.stringify({
        enable_cart: { value: true, displayValue: 'true' },
        enable_requests: { value: true, displayValue: 'true' },
        enable_tasks: { value: true, displayValue: 'true' },
    }),
})

[bryce-godfrey]

4.12.0 is available to address this