Fix issues with enum options filtering logic in enum_ function

[ikeyan]

The current implementation of the enum_ function in Valibot filters enum options using the following code:

valibot/library/src/schemas/enum/enum.ts

Lines 92 to 98 in 8ab047f

	export function enum_(
	enum__: Enum,
	message?: ErrorMessage<EnumIssue>
	): EnumSchema<Enum, ErrorMessage<EnumIssue> | undefined> {
	const options = Object.entries(enum__)
	.filter(([key]) => isNaN(+key))
	.map(([, value]) => value);

The purpose of this filtering logic is to remove the reverse mapping entries that TypeScript adds when transpiling enums. Specifically, when an enum member is defined as Name = value and value is a number, TypeScript generates a reverse mapping in the form Enum[value] = 'Name'. The key of this reverse mapping is stringified by Number.prototype.toString with radix=10 via ToPropertyKey as defined by the ECMAScript specification.

There are several issues with using +key and isNaN in the filtering logic:

• String Conversion: The +key operation follows the StringToNumber abstract operation as defined in the ECMAScript specification. Since enum_ filters out any number, this operation has several implications:

  • It trims leading and/or trailing whitespaces or line terminators.
  • If the string is empty after trimming, it returns 0.
  • Strings such as Infinity or -Infinity are interpreted as their respective number representations.
  • It interprets prefixes like 0b, 0o, or 0x as binary, octal, or hexadecimal literals.
  • Decimal variations such as 0.1, .1, and 0. are all valid and yield the respective numeric values.
  • It also allows leading zeros.
  • It accepts the + symbol as a valid sign.

• NaN Values in Enum: If the enum contains NaN, as in the following example:

  enum N { X = NaN }
  // equivalent to js: const N = { X: NaN, NaN: 'X' }

  The isNaN check will not work as expected since isNaN(key) will return true when key is 'NaN', causing the 'NaN' key to be retained rather than filtered out.

To correctly filter out these reverse mappings, I made the filtering logic more precise. In this PR, rather than isNaN, the parsed value is stringified and is matched against the original key. If it matches, it is filtered out.

Additionally, the filtering logic is not reflected in the EnumSchema type. For example, when using enum_({ 1: "A" }), the options end up being empty, which was not obvious until runtime. Therefore I implemented type-level option filtering.

[fabian-hiller]

Thanks for creating this PR! Unfortunately I have almost no time to review and merge it in the next 3 weeks, but I plan to do it before we release our stable v1.

[fabian-hiller]

Thank you for creating this PR! I look forward to your feedback to merge this PR soon.

[fabian-hiller]

I will improve the filtering of reverse mappings, undo the changes to types and merge this PR if you have no objections.

[pkg-pr-new]

Open in Stackblitz

npm i https://pkg.pr.new/valibot@941

commit: 79ee211

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
valibot	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 4, 2025 11:27pm

[fabian-hiller]

Thank you! 🧩

[fabian-hiller]

v1.0.0-beta.10 is available