feat: support metadata

library/src/methods/merge/merge.test.ts

@@ -61,4 +61,25 @@ describe('merge', () => {
     expect(output1).toEqual(transformInput());
     expect(output2).toEqual(transformInput());
   });
+
+  test('should expose the metadata', async () => {
+    const schema1 = merge(
+      [object({ key1: string() }), object({ key2: number() })],
+      { description: 'a simple object' }
+    );
+    expect(schema1.metadata).toEqual({ description: 'a simple object' });
+    const schema2 = merge(
+      [object({ key1: string() }), object({ key2: number() })],
+      number(),
+      { description: 'an object with a rest' }
+    );
+    expect(schema2.metadata).toEqual({ description: 'an object with a rest' });
+
+    const schema3 = merge(
+      [object({ key1: string() }), object({ key2: number() })],
+      { description: 'a simple object', message: 'Value is not an object!' }
+    );
+    expect(schema3.metadata).toEqual({ description: 'a simple object' });
+    expect(schema3.message).toEqual('Value is not an object!');
+  });
 });

library/src/methods/merge/merge.ts

@@ -3,7 +3,11 @@ import {
   type ObjectOutput,
   type ObjectSchema,
 } from '../../schemas/index.ts';
-import type { BaseSchema, ErrorMessage, Pipe } from '../../types/index.ts';
+import type {
+  BaseSchema,
+  ErrorMessageOrMetadata,
+  Pipe,
+} from '../../types/index.ts';
 import { restAndDefaultArgs } from '../../utils/index.ts';
 import type { MergeObjects } from './types.ts';
 
@@ -35,14 +39,14 @@ export function merge<TSchemas extends ObjectSchemas>(
  * overwrite the previous ones.
  *
  * @param schemas The schemas to be merged.
- * @param message The error message.
+ * @param messageOrMetadata The error message or schema metadata.
  * @param pipe A validation and transformation pipe.
  *
  * @returns An object schema.
  */
 export function merge<TSchemas extends ObjectSchemas>(
   schemas: TSchemas,
-  message?: ErrorMessage,
+  messageOrMetadata?: ErrorMessageOrMetadata,
   pipe?: Pipe<ObjectOutput<MergeObjects<TSchemas>, undefined>>
 ): ObjectSchema<MergeObjects<TSchemas>>;
 
@@ -71,7 +75,7 @@ export function merge<
  *
  * @param schemas The schemas to be merged.
  * @param rest The object rest.
- * @param message The error message.
+ * @param messageOrMetadata The error message or schema metadata.
  * @param pipe A validation and transformation pipe.
  *
  * @returns An object schema.
@@ -82,7 +86,7 @@ export function merge<
 >(
   schemas: TSchemas,
   rest: TRest,
-  message?: ErrorMessage,
+  messageOrMetadata?: ErrorMessageOrMetadata,
   pipe?: Pipe<ObjectOutput<MergeObjects<TSchemas>, TRest>>
 ): ObjectSchema<MergeObjects<TSchemas>, TRest>;
 
@@ -93,13 +97,15 @@ export function merge<
   schemas: TSchemas,
   arg2?:
     | Pipe<ObjectOutput<MergeObjects<TSchemas>, TRest>>
-    | ErrorMessage
+    | ErrorMessageOrMetadata
     | TRest,
-  arg3?: Pipe<ObjectOutput<MergeObjects<TSchemas>, TRest>> | ErrorMessage,
+  arg3?:
+    | Pipe<ObjectOutput<MergeObjects<TSchemas>, TRest>>
+    | ErrorMessageOrMetadata,
   arg4?: Pipe<ObjectOutput<MergeObjects<TSchemas>, TRest>>
 ): ObjectSchema<MergeObjects<TSchemas>, TRest> {
   // Get rest, message and pipe argument
-  const [rest, message, pipe] = restAndDefaultArgs<
+  const [rest, message, pipe, metadata] = restAndDefaultArgs<
     TRest,
     Pipe<ObjectOutput<MergeObjects<TSchemas>, TRest>>
   >(arg2, arg3, arg4);
@@ -111,7 +117,7 @@ export function merge<
       {}
     ) as MergeObjects<TSchemas>,
     rest,
-    message,
+    metadata === undefined ? message : { message, ...metadata },
     pipe
   );
 }

library/src/methods/merge/mergeAsync.test.ts

@@ -63,4 +63,25 @@ describe('mergeAsync', () => {
     expect(output1).toEqual(transformInput());
     expect(output2).toEqual(transformInput());
   });
+
+  test('should expose the metadata', async () => {
+    const schema1 = mergeAsync(
+      [objectAsync({ key1: string() }), object({ key2: number() })],
+      { description: 'a simple object' }
+    );
+    expect(schema1.metadata).toEqual({ description: 'a simple object' });
+    const schema2 = mergeAsync(
+      [objectAsync({ key1: string() }), object({ key2: number() })],
+      number(),
+      { description: 'an object with a rest' }
+    );
+    expect(schema2.metadata).toEqual({ description: 'an object with a rest' });
+
+    const schema3 = mergeAsync(
+      [object({ key1: string() }), object({ key2: number() })],
+      { description: 'a simple object', message: 'Value is not an object!' }
+    );
+    expect(schema3.metadata).toEqual({ description: 'a simple object' });
+    expect(schema3.message).toEqual('Value is not an object!');
+  });
 });

library/src/methods/merge/mergeAsync.ts

@@ -7,7 +7,7 @@ import {
 import type {
   BaseSchema,
   BaseSchemaAsync,
-  ErrorMessage,
+  ErrorMessageOrMetadata,
   PipeAsync,
 } from '../../types/index.ts';
 import { restAndDefaultArgs } from '../../utils/index.ts';
@@ -41,14 +41,14 @@ export function mergeAsync<TSchemas extends ObjectSchemas>(
  * entries overwrite the previous ones.
  *
  * @param schemas The schemas to be merged.
- * @param message The error message.
+ * @param messageOrMetadata The error message or schema metadata.
  * @param pipe A validation and transformation pipe.
  *
  * @returns An async object schema.
  */
 export function mergeAsync<TSchemas extends ObjectSchemas>(
   schemas: TSchemas,
-  message?: ErrorMessage,
+  messageOrMetadata?: ErrorMessageOrMetadata,
   pipe?: PipeAsync<ObjectOutput<MergeObjects<TSchemas>, undefined>>
 ): ObjectSchemaAsync<MergeObjects<TSchemas>>;
 
@@ -77,7 +77,7 @@ export function mergeAsync<
  *
  * @param schemas The schemas to be merged.
  * @param rest The object rest.
- * @param message The error message.
+ * @param messageOrMetadata The error message or schema metadata.
  * @param pipe A validation and transformation pipe.
  *
  * @returns An async object schema.
@@ -88,7 +88,7 @@ export function mergeAsync<
 >(
   schemas: TSchemas,
   rest: TRest,
-  message?: ErrorMessage,
+  messageOrMetadata?: ErrorMessageOrMetadata,
   pipe?: PipeAsync<ObjectOutput<MergeObjects<TSchemas>, TRest>>
 ): ObjectSchemaAsync<MergeObjects<TSchemas>, TRest>;
 
@@ -99,13 +99,15 @@ export function mergeAsync<
   schemas: TSchemas,
   arg2?:
     | PipeAsync<ObjectOutput<MergeObjects<TSchemas>, TRest>>
-    | ErrorMessage
+    | ErrorMessageOrMetadata
     | TRest,
-  arg3?: PipeAsync<ObjectOutput<MergeObjects<TSchemas>, TRest>> | ErrorMessage,
+  arg3?:
+    | PipeAsync<ObjectOutput<MergeObjects<TSchemas>, TRest>>
+    | ErrorMessageOrMetadata,
   arg4?: PipeAsync<ObjectOutput<MergeObjects<TSchemas>, TRest>>
 ): ObjectSchemaAsync<MergeObjects<TSchemas>, TRest> {
   // Get rest, message and pipe argument
-  const [rest, message, pipe] = restAndDefaultArgs<
+  const [rest, message, pipe, metadata] = restAndDefaultArgs<
     TRest,
     PipeAsync<ObjectOutput<MergeObjects<TSchemas>, TRest>>
   >(arg2, arg3, arg4);
@@ -117,7 +119,7 @@ export function mergeAsync<
       {}
     ) as MergeObjects<TSchemas>,
     rest,
-    message,
+    metadata === undefined ? message : { message, ...metadata },
     pipe
   );
 }

library/src/methods/omit/omit.test.ts

@@ -1,6 +1,6 @@
 import { describe, expect, test } from 'vitest';
 import { comparable } from '../../comparable.ts';
-import { object, string } from '../../schemas/index.ts';
+import { number, object, string } from '../../schemas/index.ts';
 import { toCustom } from '../../transformations/index.ts';
 import { omit } from '../omit/index.ts';
 import { parse } from '../parse/index.ts';
@@ -48,4 +48,29 @@ describe('omit', () => {
     expect(output1).toEqual(transformInput());
     expect(output2).toEqual(transformInput());
   });
+
+  test('should expose the metadata', async () => {
+    const schema1 = omit(
+      object({ key1: string(), key2: string(), key3: string() }),
+      ['key1', 'key3'],
+      { description: 'a simple object' }
+    );
+    expect(schema1.metadata).toEqual({ description: 'a simple object' });
+
+    const schema2 = omit(
+      object({ key1: string(), key2: string(), key3: string() }),
+      ['key1', 'key3'],
+      number(),
+      { description: 'an object with a rest' }
+    );
+    expect(schema2.metadata).toEqual({ description: 'an object with a rest' });
+
+    const schema3 = omit(
+      object({ key1: string(), key2: string(), key3: string() }),
+      ['key1', 'key3'],
+      { description: 'a simple object', message: 'Value is not an object!' }
+    );
+    expect(schema3.metadata).toEqual({ description: 'a simple object' });
+    expect(schema3.message).toEqual('Value is not an object!');
+  });
 });

library/src/methods/omit/omit.ts

@@ -5,7 +5,7 @@ import {
 } from '../../schemas/index.ts';
 import type {
   BaseSchema,
-  ErrorMessage,
+  ErrorMessageOrMetadata,
   ObjectKeys,
   Pipe,
 } from '../../types/index.ts';
@@ -36,7 +36,7 @@ export function omit<
  *
  * @param schema The schema to omit from.
  * @param keys The selected keys
- * @param message The error message.
+ * @param messageOrMetadata The error message or schema metadata.
  * @param pipe A validation and transformation pipe.
  *
  * @returns An object schema.
@@ -47,7 +47,7 @@ export function omit<
 >(
   schema: TSchema,
   keys: TKeys,
-  message?: ErrorMessage,
+  messageOrMetadata?: ErrorMessageOrMetadata,
   pipe?: Pipe<ObjectOutput<Omit<TSchema['entries'], TKeys[number]>, undefined>>
 ): ObjectSchema<Omit<TSchema['entries'], TKeys[number]>>;
 
@@ -80,7 +80,7 @@ export function omit<
  * @param schema The schema to omit from.
  * @param keys The selected keys
  * @param rest The object rest.
- * @param message The error message.
+ * @param messageOrMetadata The error message or schema metadata.
  * @param pipe A validation and transformation pipe.
  *
  * @returns An object schema.
@@ -93,7 +93,7 @@ export function omit<
   schema: TSchema,
   keys: TKeys,
   rest: TRest,
-  message?: ErrorMessage,
+  messageOrMetadata?: ErrorMessageOrMetadata,
   pipe?: Pipe<ObjectOutput<Omit<TSchema['entries'], TKeys[number]>, TRest>>
 ): ObjectSchema<Omit<TSchema['entries'], TKeys[number]>, TRest>;
 
@@ -106,15 +106,15 @@ export function omit<
   keys: TKeys,
   arg3?:
     | Pipe<ObjectOutput<Omit<TSchema['entries'], TKeys[number]>, TRest>>
-    | ErrorMessage
+    | ErrorMessageOrMetadata
     | TRest,
   arg4?:
     | Pipe<ObjectOutput<Omit<TSchema['entries'], TKeys[number]>, TRest>>
-    | ErrorMessage,
+    | ErrorMessageOrMetadata,
   arg5?: Pipe<ObjectOutput<Omit<TSchema['entries'], TKeys[number]>, TRest>>
 ): ObjectSchema<Omit<TSchema['entries'], TKeys[number]>, TRest> {
   // Get rest, message and pipe argument
-  const [rest, message, pipe] = restAndDefaultArgs<
+  const [rest, message, pipe, metadata] = restAndDefaultArgs<
     TRest,
     Pipe<ObjectOutput<Omit<TSchema['entries'], TKeys[number]>, TRest>>
   >(arg3, arg4, arg5);
@@ -127,7 +127,7 @@ export function omit<
       {}
     ) as Omit<TSchema['entries'], TKeys[number]>,
     rest,
-    message,
+    metadata === undefined ? message : { message, ...metadata },
     pipe
   );
 }

library/src/methods/omit/omitAsync.test.ts

@@ -48,4 +48,29 @@ describe('omitAsync', () => {
     expect(output1).toEqual(transformInput());
     expect(output2).toEqual(transformInput());
   });
+
+  test('should expose the metadata', async () => {
+    const schema1 = omitAsync(
+      object({ key1: string(), key2: string(), key3: string() }),
+      ['key1', 'key3'],
+      { description: 'a simple object' }
+    );
+    expect(schema1.metadata).toEqual({ description: 'a simple object' });
+
+    const schema2 = omitAsync(
+      object({ key1: string(), key2: string(), key3: string() }),
+      ['key1', 'key3'],
+      string(),
+      { description: 'an object with a rest' }
+    );
+    expect(schema2.metadata).toEqual({ description: 'an object with a rest' });
+
+    const schema3 = omitAsync(
+      object({ key1: string(), key2: string(), key3: string() }),
+      ['key1', 'key3'],
+      { description: 'a simple object', message: 'Value is not an object!' }
+    );
+    expect(schema3.metadata).toEqual({ description: 'a simple object' });
+    expect(schema3.message).toEqual('Value is not an object!');
+  });
 });