Add support for input as value in v.recursive() getter

library/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to the library will be documented in this file.
 
+## vX.X.X (Month DD, YYYY)
+
+- Add `input` of schema to `getter` function of `recursive` and `recursiveAsync` schema (pull request #441)
+
 ## v0.28.1 (February 06, 2024)
 
 - Fix bug in `union` and `unionAsync` schema for transformed inputs (issue #420)

library/src/schemas/recursive/recursive.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, test } from 'vitest';
+import { describe, expect, test, vi } from 'vitest';
 import { parse } from '../../methods/index.ts';
 import { minLength } from '../../validations/index.ts';
 import { string } from '../string/index.ts';
@@ -15,4 +15,12 @@ describe('recursive', () => {
     expect(() => parse(schema, null)).toThrowError();
     expect(() => parse(schema, {})).toThrowError();
   });
+
+  test('should pass the input to the getter function as a parameter', () => {
+    const getter = vi.fn().mockReturnValue({ _parse: string()._parse });
+    const schema = recursive(getter);
+    const input = 'hello';
+    parse(schema, input);
+    expect(getter).toHaveBeenCalledWith(input);
+  });
 });

library/src/schemas/recursive/recursive.ts

@@ -4,7 +4,7 @@ import type { BaseSchema, Input, Output } from '../../types/index.ts';
  * Recursive schema type.
  */
 export type RecursiveSchema<
-  TGetter extends () => BaseSchema,
+  TGetter extends (input: unknown) => BaseSchema,
   TOutput = Output<ReturnType<TGetter>>
 > = BaseSchema<Input<ReturnType<TGetter>>, TOutput> & {
   /**
@@ -24,7 +24,7 @@ export type RecursiveSchema<
  *
  * @returns A recursive schema.
  */
-export function recursive<TGetter extends () => BaseSchema>(
+export function recursive<TGetter extends (input: unknown) => BaseSchema>(
   getter: TGetter
 ): RecursiveSchema<TGetter> {
   return {
@@ -33,7 +33,7 @@ export function recursive<TGetter extends () => BaseSchema>(
     async: false,
     getter,
     _parse(input, config) {
-      return this.getter()._parse(input, config);
+      return this.getter(input)._parse(input, config);
     },
   };
 }

library/src/schemas/recursive/recursiveAsync.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, test } from 'vitest';
+import { describe, expect, test, vi } from 'vitest';
 import { parseAsync } from '../../methods/index.ts';
 import { minLength } from '../../validations/index.ts';
 import { stringAsync } from '../string/index.ts';
@@ -15,4 +15,12 @@ describe('recursiveAsync', () => {
     await expect(parseAsync(schema, null)).rejects.toThrowError();
     await expect(parseAsync(schema, {})).rejects.toThrowError();
   });
+
+  test('should pass input to getter', async () => {
+    const getter = vi.fn().mockReturnValue({ _parse: stringAsync()._parse });
+    const schema = recursiveAsync(getter);
+    const input = 'hello';
+    await parseAsync(schema, input);
+    expect(getter).toHaveBeenCalledWith(input);
+  });
 });

library/src/schemas/recursive/recursiveAsync.ts

@@ -2,16 +2,19 @@ import type {
   BaseSchema,
   BaseSchemaAsync,
   Input,
+  MaybePromise,
   Output,
 } from '../../types/index.ts';
 
 /**
  * Recursive schema async type.
  */
 export type RecursiveSchemaAsync<
-  TGetter extends () => BaseSchema | BaseSchemaAsync,
-  TOutput = Output<ReturnType<TGetter>>
-> = BaseSchemaAsync<Input<ReturnType<TGetter>>, TOutput> & {
+  TGetter extends (
+    input: unknown
+  ) => MaybePromise<BaseSchema | BaseSchemaAsync>,
+  TOutput = Output<Awaited<ReturnType<TGetter>>>
+> = BaseSchemaAsync<Input<Awaited<ReturnType<TGetter>>>, TOutput> & {
   /**
    * The schema type.
    */
@@ -30,15 +33,15 @@ export type RecursiveSchemaAsync<
  * @returns An async recursive schema.
  */
 export function recursiveAsync<
-  TGetter extends () => BaseSchema | BaseSchemaAsync
+  TGetter extends (input: unknown) => MaybePromise<BaseSchema | BaseSchemaAsync>
 >(getter: TGetter): RecursiveSchemaAsync<TGetter> {
   return {
     type: 'recursive',
     expects: 'unknown',
     async: true,
     getter,
     async _parse(input, config) {
-      return this.getter()._parse(input, config);
+      return (await this.getter(input))._parse(input, config);
     },
   };
 }

library/src/types/other.ts

@@ -10,7 +10,14 @@ export type ObjectKeys<
 /**
  * Maybe readonly type.
  */
-export type MaybeReadonly<T> = Readonly<T> | T;
+export type MaybeReadonly<T> = T | Readonly<T>;
+
+/**
+ * Maybe promise type.
+ *
+ * TODO: Refactor library with this type.
+ */
+export type MaybePromise<T> = T | Promise<T>;
 
 /**
  * Resolve type.

website/src/routes/api/(schemas)/recursive/properties.ts

@@ -5,7 +5,7 @@ export const properties: Record<string, PropertyProps> = {
     modifier: 'extends',
     type: {
       type: 'function',
-      params: [],
+      params: [{ name: 'input', type: 'unknown' }],
       return: {
         type: 'custom',
         name: 'BaseSchema',

website/src/routes/api/(types)/RecursiveSchema/properties.ts

@@ -5,7 +5,7 @@ export const properties: Record<string, PropertyProps> = {
     modifier: 'extends',
     type: {
       type: 'function',
-      params: [],
+      params: [{ name: 'input', type: 'unknown' }],
       return: {
         type: 'custom',
         name: 'BaseSchema',