step functions: Map.jsonata does not support assign

[joerino96]

Describe the bug

Map.jsonata does not support the assign field provided by CDK, causing a compile error.

Regression Issue

• Select this option if this issue appears to be a regression.

Last Known Working CDK Version

No response

Expected Behavior

Map.jsonata is able to set the assign field.

Current Behavior

A compile error is thrown: Object literal may only specify known properties, and 'assign' does not exist in type 'MapJsonataProps'.

Reproduction Steps

The following code causes a compile error:

    const myMap = Map.jsonata(scope, "MyMap", {
        items: ProvideItems.jsonata("{% $runInput %}"),
        itemSelector: {
            runs: "{% $states.context.Map.Item.Value %}",
        },
        assign: {},
    })

However, the workaround for using the classic Map constructor and setting the query language to jsonata compiles correctly.

    const myMap = new Map(scope, "MyMap", {
        queryLanguage: QueryLanguage.JSONATA,
        items: ProvideItems.jsonata("{% $runInput %}"),
        itemSelector: {
            runs: "{% $states.context.Map.Item.Value %}",
        },
        assign: {},
    })

Possible Solution

No response

Additional Information/Context

No response

CDK CLI Version

2.178.1

Framework Version

No response

Node.js Version

Node 18

OS

macOS 15.3

Language

TypeScript

Language Version

No response

Other information

No response

[pahud]

Hi @joerino96,

Thank you for reporting this issue. After investigation, this appears to be a valid bug where the MapJsonataProps interface is missing the assign property that should be supported, similar to the classic Map constructor.

Issue Analysis:

• The assign property is correctly supported when using new Map() with QueryLanguage.JSONATA
• However, the same property is not included in the type definitions for Map.jsonata()
• This is likely an oversight in the type definitions since both APIs should support the same functionality

Current Workaround:
As you've discovered, you can use the classic constructor approach:

new Map(scope, "MyMap", {
    queryLanguage: QueryLanguage.JSONATA,
    items: ProvideItems.jsonata("{% $runInput %}"),
    itemSelector: {
        runs: "{% $states.context.Map.Item.Value %}",
    },
    assign: {},
})

We'll work on fixing this by updating the MapJsonataProps interface to include the assign property. Making it a p1.

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.