Request ID should be sometimes undefined

[jkjustjoshing]

The event argument type passed to the onSubmit callback (and probably others, I didn't check) can be undefined when sandbox mode is enabled. However, the type definition says it's always a string.

Can be seen when using React

<Widget 
  onSubmit={(event) => console.log(typeof event.responseId)}
  sandboxMode={true}
/>

event.responseId is undefined when sandbox mode is enabled, but the type definition is string, not string | undefined.

The fix

Update this line to be

  onSubmit?: (event: WithFormId & Partial<WithResponseId>) => void

However, that may indicate responseId is missing, not set to undefined, so you could also update WithResponseId to be { responseId: string | undefined }, but I'm not sure where else that type is used and what the repercussion is.

[mathio]

Hello @jkjustjoshing

Good catch! From the top of my head I dont see any issues with updating this to { responseId: string | undefined }. I think we can update the type.

[mathio]

Hello again.

After considering changing types, we will be passing a "__sandbox" string value for responseId instead. Changing the type would mean everyone implementing the onSubmit callback would need to check if the responseId is defined, even if they do not care about the sandbox (I assume most customers do not implement sandboxed embeds).

I also noticed the onStarted was not called for sandboxed embeds at all. The upcoming change will also fix this (it will be called with object { formId: "actual-form-id", responseId: "__sandbox" } as param). Docs update coming after the change is released.

[typeform-ops-gha]

🎉 This issue has been resolved in version @typeform/embed-v5.2.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀