Merge pull request #2060 from hey-api/feat/plugin-valibot

fix(valibot): add valibot plugin

Author: mrlubos

.changeset/three-lobsters-grow.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix(valibot): add valibot plugin

docs/.vitepress/config/en.ts

@@ -94,6 +94,10 @@ export default defineConfig({
           {
             collapsed: true,
             items: [
+              {
+                link: '/openapi-ts/plugins/valibot',
+                text: 'Valibot',
+              },
               {
                 link: '/openapi-ts/plugins/zod',
                 text: 'Zod',
@@ -118,10 +122,6 @@ export default defineConfig({
                 link: '/openapi-ts/plugins/typebox',
                 text: 'TypeBox <span data-soon>soon</span>',
               },
-              {
-                link: '/openapi-ts/plugins/valibot',
-                text: 'Valibot <span data-soon>soon</span>',
-              },
               {
                 link: '/openapi-ts/plugins/yup',
                 text: 'Yup <span data-soon>soon</span>',

docs/openapi-ts/plugins.md

@@ -26,6 +26,7 @@ These plugins help reduce boilerplate associated with third-party dependencies.
 - [`@tanstack/svelte-query`](/openapi-ts/plugins/tanstack-query)
 - [`@tanstack/vue-query`](/openapi-ts/plugins/tanstack-query)
 - [`fastify`](/openapi-ts/plugins/fastify)
+- [`valibot`](/openapi-ts/plugins/valibot)
 - [`zod`](/openapi-ts/plugins/zod)
 
 ## Upcoming
@@ -47,7 +48,6 @@ The following plugins are planned but not in development yet. You can help us pr
 - [Supertest](/openapi-ts/plugins/supertest) <span data-soon>Soon</span>
 - [SWR](/openapi-ts/plugins/swr) <span data-soon>Soon</span>
 - [TypeBox](/openapi-ts/plugins/typebox) <span data-soon>Soon</span>
-- [Valibot](/openapi-ts/plugins/valibot) <span data-soon>Soon</span>
 - [Yup](/openapi-ts/plugins/yup) <span data-soon>Soon</span>
 - [Zustand](/openapi-ts/plugins/zustand) <span data-soon>Soon</span>
 

docs/openapi-ts/plugins/valibot.md

@@ -3,14 +3,74 @@ title: Valibot
 description: Valibot plugin for Hey API. Compatible with all our features.
 ---
 
-# Valibot <span data-soon>soon</span>
+# Valibot
 
 ::: warning
-This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1474).
+This feature is in development! :tada: Try it out and provide feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues/1474).
 :::
 
 ### About
 
 [Valibot](https://valibot.dev) is the open source schema library for TypeScript with bundle size, type safety and developer experience in mind.
 
+<!-- ### Demo
+
+<button class="buttonLink" @click="(event) => embedProject('hey-api-client-fetch-plugin-valibot-example')(event)">
+Launch demo
+</button> -->
+
+## Features
+
+- seamless integration with `@hey-api/openapi-ts` ecosystem
+- Valibot schemas for requests, responses, and reusable components
+
+## Installation
+
+In your [configuration](/openapi-ts/get-started), add `valibot` to your plugins and you'll be ready to generate Valibot artifacts. :tada:
+
+```js
+import { defaultPlugins } from '@hey-api/openapi-ts';
+
+export default {
+  input: 'https://get.heyapi.dev/hey-api/backend',
+  output: 'src/client',
+  plugins: [
+    ...defaultPlugins,
+    '@hey-api/client-fetch',
+    'valibot', // [!code ++]
+  ],
+};
+```
+
+## SDKs
+
+To automatically validate response data in your SDKs, set `sdk.validator` to `true`.
+
+```js
+import { defaultPlugins } from '@hey-api/openapi-ts';
+
+export default {
+  input: 'https://get.heyapi.dev/hey-api/backend',
+  output: 'src/client',
+  plugins: [
+    ...defaultPlugins,
+    '@hey-api/client-fetch',
+    'valibot',
+    {
+      name: '@hey-api/sdk', // [!code ++]
+      validator: true, // [!code ++]
+    },
+  ],
+};
+```
+
+## Output
+
+The Valibot plugin will generate the following artifacts, depending on the input specification.
+
+## Schemas
+
+More information will be provided as we finalize the plugin.
+
+<!--@include: ../../examples.md-->
 <!--@include: ../../sponsors.md-->

docs/openapi-ts/validators.md

@@ -13,12 +13,12 @@ Whatever your reason to use validators might be, you can rest assured that you'r
 
 Hey API natively supports the following validators.
 
+- [Valibot](/openapi-ts/plugins/valibot)
 - [Zod](/openapi-ts/plugins/zod)
 - [Ajv](/openapi-ts/plugins/ajv) <span data-soon>Soon</span>
 - [Arktype](/openapi-ts/plugins/arktype) <span data-soon>Soon</span>
 - [Joi](/openapi-ts/plugins/joi) <span data-soon>Soon</span>
 - [TypeBox](/openapi-ts/plugins/typebox) <span data-soon>Soon</span>
-- [Valibot](/openapi-ts/plugins/valibot) <span data-soon>Soon</span>
 - [Yup](/openapi-ts/plugins/yup) <span data-soon>Soon</span>
 
 Don't see your validator? Let us know your interest by [opening an issue](https://github.com/hey-api/openapi-ts/issues).

packages/openapi-ts-tests/package.json

@@ -58,6 +58,7 @@
     "ts-node": "10.9.2",
     "tslib": "2.8.1",
     "typescript": "5.8.3",
+    "valibot": "1.1.0",
     "vue": "3.5.13",
     "zod": "3.23.8"
   }

packages/openapi-ts-tests/test/3.0.x.test.ts

@@ -419,7 +419,7 @@ describe(`OpenAPI ${version}`, () => {
       config: createConfig({
         input: 'enum-null.json',
         output: 'enum-null',
-        plugins: ['@hey-api/typescript', 'zod'],
+        plugins: ['@hey-api/typescript', 'valibot', 'zod'],
       }),
       description: 'handles null enums',
     },
@@ -586,9 +586,9 @@ describe(`OpenAPI ${version}`, () => {
       config: createConfig({
         input: 'validators.json',
         output: 'validators',
-        plugins: ['zod'],
+        plugins: ['valibot', 'zod'],
       }),
-      description: 'generates Zod schemas',
+      description: 'generates validator schemas',
     },
   ];
 

packages/openapi-ts-tests/test/3.1.x.test.ts

@@ -433,7 +433,7 @@ describe(`OpenAPI ${version}`, () => {
       config: createConfig({
         input: 'enum-null.json',
         output: 'enum-null',
-        plugins: ['@hey-api/typescript', 'zod'],
+        plugins: ['@hey-api/typescript', 'valibot', 'zod'],
       }),
       description: 'handles null enums',
     },
@@ -567,7 +567,7 @@ describe(`OpenAPI ${version}`, () => {
       config: createConfig({
         input: 'schema-const.yaml',
         output: 'schema-const',
-        plugins: ['@hey-api/typescript', 'zod'],
+        plugins: ['@hey-api/typescript', 'valibot', 'zod'],
       }),
       description: 'handles various constants',
     },
@@ -684,41 +684,41 @@ describe(`OpenAPI ${version}`, () => {
       config: createConfig({
         input: 'validators.json',
         output: 'validators',
-        plugins: ['zod'],
+        plugins: ['valibot', 'zod'],
       }),
-      description: 'generates Zod schemas',
+      description: 'generates validator schemas',
     },
     {
       config: createConfig({
-        input: 'zod-bigint-min-max.json',
-        output: 'zod-bigint-min-max',
-        plugins: ['zod'],
+        input: 'validators-bigint-min-max.json',
+        output: 'validators-bigint-min-max',
+        plugins: ['valibot', 'zod'],
       }),
-      description: 'Zod schemas with BigInt and min/max constraints',
+      description: 'validator schemas with BigInt and min/max constraints',
     },
     {
       config: createConfig({
-        input: 'zod-circular-ref.json',
-        output: 'zod-circular-ref',
-        plugins: ['zod'],
+        input: 'validators-circular-ref.json',
+        output: 'validators-circular-ref',
+        plugins: ['valibot', 'zod'],
       }),
-      description: 'Zod schemas with circular reference',
+      description: 'validator schemas with circular reference',
     },
     {
       config: createConfig({
-        input: 'zod-circular-ref-2.yaml',
-        output: 'zod-circular-ref-2',
-        plugins: ['zod'],
+        input: 'validators-circular-ref-2.yaml',
+        output: 'validators-circular-ref-2',
+        plugins: ['valibot', 'zod'],
       }),
-      description: 'Zod schemas with circular reference 2',
+      description: 'validator schemas with circular reference 2',
     },
     {
       config: createConfig({
-        input: 'zod-union-merge.json',
-        output: 'zod-union-merge',
-        plugins: ['zod'],
+        input: 'validators-union-merge.json',
+        output: 'validators-union-merge',
+        plugins: ['valibot', 'zod'],
       }),
-      description: "Zod schemas with merged unions (can't use .merge())",
+      description: "validator schemas with merged unions (can't use .merge())",
     },
   ];
 

packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/transformers/type-format/client.gen.ts renamed to packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/transformers/type-format-valibot/client.gen.ts

@@ -0,0 +1,33 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
+import type { PostFooData, PostFooResponse } from './types.gen';
+import { postFooResponseTransformer } from './transformers.gen';
+import { vPostFooResponse } from './valibot.gen';
+import * as v from 'valibot';
+import { client as _heyApiClient } from './client.gen';
+
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
+};
+
+export const postFoo = <ThrowOnError extends boolean = false>(options?: Options<PostFooData, ThrowOnError>) => {
+    return (options?.client ?? _heyApiClient).post<PostFooResponse, unknown, ThrowOnError>({
+        responseTransformer: postFooResponseTransformer,
+        responseValidator: async (data) => {
+            return await v.parseAsync(vPostFooResponse, data);
+        },
+        url: '/foo',
+        ...options
+    });
+};

packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/transformers/type-format/index.ts renamed to packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/transformers/type-format-valibot/index.ts

@@ -0,0 +1,15 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import * as v from 'valibot';
+
+export const vFoo = v.object({
+    bar: v.optional(v.pipe(v.number(), v.integer())),
+    foo: v.bigint(),
+    id: v.string()
+});
+
+export const vBar = v.object({
+    foo: v.pipe(v.number(), v.integer())
+});
+
+export const vPostFooResponse = vFoo;

packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/transformers/type-format-valibot/sdk.gen.ts

@@ -0,0 +1,32 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type Foo = {
+    bar?: number;
+    foo: bigint;
+    id: string;
+};
+
+export type Bar = {
+    foo: number;
+    [key: string]: number;
+};
+
+export type PostFooData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/foo';
+};
+
+export type PostFooResponses = {
+    /**
+     * OK
+     */
+    200: Foo;
+};
+
+export type PostFooResponse = PostFooResponses[keyof PostFooResponses];
+
+export type ClientOptions = {
+    baseUrl: string;
+};