Parsing from snake_case to camelCase

[krokyze]

Hey.

Is it possible to define the key for specific entries like productCount: v.pipe(v.key('product_count'), v.number(), v.integer()) so it would be parsed as product_count into productCount?

Or maybe something similar like yup which has camelCase().

[fabian-hiller]

Great idea! Thank you for creating this issue. I think this only works in the pipeline of your object. But it will be challenging to get the types right. A package like ts-case-convert might help. We could add a toCamelCase and toSnakeCase action. Here is a simple code example:

import { objectToSnake } from 'ts-case-convert';
import * as v from 'valibot';

// With `ts-case-convert`
const Schema = v.pipe(
  v.object({ productCount: v.number() }),
  v.transform(objectToSnake)
);

// With a `toSnakeCase` action (not implemented yet)
const Schema = v.pipe(
  v.object({ productCount: v.number() }),
  v.toSnakeCase()
);

[krokyze]

Thanks for the recommendation!

The only issue I see when using ts-case-convert is that the "Go to Definition" feature in VSCode doesn't work, but I'm fine with that. TypeScript hinting for non-existent properties works fine. Here's a video demonstrating the issue:

Screen.Recording.2024-12-19.at.20.06.05.mov

That said, how should I implement this for a recursive schema? I'm encountering some issues:

Type 'SchemaWithPipe<[ObjectSchema<{ readonly id: SchemaWithPipe<[NumberSchema<undefined>, IntegerAction<number, undefined>]>; readonly title: StringSchema<undefined>; readonly link: StringSchema<...>; readonly product_count: NumberSchema<...>; readonly children: LazySchema<...>; }, undefined>, TransformAction<...>]>' is not assignable to type 'GenericSchema<CategoryRecursive, CategoryRecursive, BaseIssue<unknown>>'.
  Types of property ''~standard'' are incompatible.
    Type 'StandardSchemaProps<{ id: number; title: string; link: string; product_count: number; children: CategoryRecursive[]; }, { id: number; title: string; link: string; productCount: number; children: { ...; }[]; }>' is not assignable to type 'StandardSchemaProps<CategoryRecursive, CategoryRecursive>'.
      Property 'product_count' is missing in type '{ id: number; title: string; link: string; productCount: number; children: { id: number; title: string; link: string; productCount: number; children: ...[]; }[]; }' but required in type 'CategoryRecursive'.

[fabian-hiller]

Here is an example:

import { objectToSnake, ObjectToSnake } from "ts-case-convert";
import * as v from "valibot";

type InputType = {
  fooBar: number;
  nested: InputType;
};

type OutputType = ObjectToSnake<InputType>;

const Schema: v.GenericSchema<InputType, OutputType> = v.pipe(
  v.object({
    fooBar: v.number(),
    nested: v.lazy(() => Schema),
  }),
  v.transform(objectToSnake)
);

type Input = v.InferInput<typeof Schema>;
type Output = v.InferOutput<typeof Schema>;

[fabian-hiller]

Probably after v1 is out we will investigate the implementation of a toSnakeCase and toCamelCase transformation action.

[krokyze]

Thanks! Works as expected!