Add more support for AbortSignal

Author: rhyzx

library/src/actions/checkItems/checkItemsAsync.ts

@@ -78,7 +78,9 @@ export function checkItemsAsync(
     async '~run'(dataset, config) {
       if (dataset.typed) {
         const requirementResults = await Promise.all(
-          dataset.value.map(this.requirement)
+          dataset.value.map((...args) =>
+            this.requirement(...args, config.signal)
+          )
         );
         for (let index = 0; index < dataset.value.length; index++) {
           if (!requirementResults[index]) {

library/src/actions/partialCheck/partialCheckAsync.ts

@@ -42,7 +42,10 @@ export interface PartialCheckActionAsync<
   /**
    * The validation function.
    */
-  readonly requirement: (input: TSelection) => MaybePromise<boolean>;
+  readonly requirement: (
+    input: TSelection,
+    signal?: AbortSignal
+  ) => MaybePromise<boolean>;
   /**
    * The error message.
    */
@@ -63,7 +66,10 @@ export function partialCheckAsync<
   const TSelection extends DeepPickN<TInput, TPaths>,
 >(
   paths: ValidPaths<TInput, TPaths>,
-  requirement: (input: TSelection) => MaybePromise<boolean>
+  requirement: (
+    input: TSelection,
+    signal?: AbortSignal
+  ) => MaybePromise<boolean>
 ): PartialCheckActionAsync<TInput, TPaths, TSelection, undefined>;
 
 /**
@@ -84,14 +90,20 @@ export function partialCheckAsync<
     | undefined,
 >(
   paths: ValidPaths<TInput, TPaths>,
-  requirement: (input: TSelection) => MaybePromise<boolean>,
+  requirement: (
+    input: TSelection,
+    signal?: AbortSignal
+  ) => MaybePromise<boolean>,
   message: TMessage
 ): PartialCheckActionAsync<TInput, TPaths, TSelection, TMessage>;
 
 // @__NO_SIDE_EFFECTS__
 export function partialCheckAsync(
   paths: Paths,
-  requirement: (input: PartialInput) => MaybePromise<boolean>,
+  requirement: (
+    input: PartialInput,
+    signal?: AbortSignal
+  ) => MaybePromise<boolean>,
   message?: ErrorMessage<PartialCheckIssue<PartialInput>>
 ): PartialCheckActionAsync<
   PartialInput,
@@ -112,7 +124,7 @@ export function partialCheckAsync(
       if (
         (dataset.typed || _isPartiallyTyped(dataset, paths)) &&
         // @ts-expect-error
-        !(await this.requirement(dataset.value))
+        !(await this.requirement(dataset.value, config.signal))
       ) {
         _addIssue(this, 'input', dataset, config);
       }

library/src/actions/transform/transformAsync.ts

@@ -19,7 +19,7 @@ export interface TransformActionAsync<TInput, TOutput>
   /**
    * The transformation operation.
    */
-  readonly operation: (input: TInput) => Promise<TOutput>;
+  readonly operation: (input: TInput, signal?: AbortSignal) => Promise<TOutput>;
 }
 
 /**
@@ -31,17 +31,17 @@ export interface TransformActionAsync<TInput, TOutput>
  */
 // @__NO_SIDE_EFFECTS__
 export function transformAsync<TInput, TOutput>(
-  operation: (input: TInput) => Promise<TOutput>
+  operation: (input: TInput, signal?: AbortSignal) => Promise<TOutput>
 ): TransformActionAsync<TInput, TOutput> {
   return {
     kind: 'transformation',
     type: 'transform',
     reference: transformAsync,
     async: true,
     operation,
-    async '~run'(dataset) {
+    async '~run'(dataset, config) {
       // @ts-expect-error
-      dataset.value = await this.operation(dataset.value);
+      dataset.value = await this.operation(dataset.value, config.signal);
       // @ts-expect-error
       return dataset as SuccessDataset<TOutput>;
     },

library/src/actions/types.ts

@@ -20,7 +20,8 @@ export type ArrayRequirement<TInput extends ArrayInput> = (
 export type ArrayRequirementAsync<TInput extends ArrayInput> = (
   item: TInput[number],
   index: number,
-  array: TInput
+  array: TInput,
+  signal?: AbortSignal
 ) => MaybePromise<boolean>;
 
 /**

library/src/schemas/custom/customAsync.ts

@@ -11,7 +11,10 @@ import type { CustomIssue } from './types.ts';
 /**
  * Check async type.
  */
-type CheckAsync = (input: unknown) => MaybePromise<boolean>;
+type CheckAsync = (
+  input: unknown,
+  signal?: AbortSignal
+) => MaybePromise<boolean>;
 
 /**
  * Custom schema async interface.
@@ -85,7 +88,7 @@ export function customAsync<TInput>(
       return _getStandardProps(this);
     },
     async '~run'(dataset, config) {
-      if (await this.check(dataset.value)) {
+      if (await this.check(dataset.value, config.signal)) {
         // @ts-expect-error
         dataset.typed = true;
       } else {

library/src/schemas/lazy/lazyAsync.test.ts

@@ -99,6 +99,14 @@ describe('lazyAsync', () => {
     const getter = vi.fn(() => string());
     const dataset = { value: 'foo' };
     lazyAsync(getter)['~run'](dataset, {});
-    expect(getter).toHaveBeenCalledWith(dataset.value);
+    expect(getter).toHaveBeenCalledWith(dataset.value, undefined);
+  });
+
+  test('should call getter with signal', () => {
+    const getter = vi.fn(() => string());
+    const dataset = { value: 'foo' };
+    const signal = AbortSignal.abort();
+    lazyAsync(getter)['~run'](dataset, { signal });
+    expect(getter).toHaveBeenCalledWith(dataset.value, signal);
   });
 });

library/src/schemas/lazy/lazyAsync.ts

@@ -37,7 +37,10 @@ export interface LazySchemaAsync<
   /**
    * The schema getter.
    */
-  readonly getter: (input: unknown) => MaybePromise<TWrapped>;
+  readonly getter: (
+    input: unknown,
+    signal?: AbortSignal
+  ) => MaybePromise<TWrapped>;
 }
 
 /**
@@ -53,7 +56,7 @@ export function lazyAsync<
     | BaseSchema<unknown, unknown, BaseIssue<unknown>>
     | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
 >(
-  getter: (input: unknown) => MaybePromise<TWrapped>
+  getter: (input: unknown, signal?: AbortSignal) => MaybePromise<TWrapped>
 ): LazySchemaAsync<TWrapped> {
   return {
     kind: 'schema',
@@ -66,7 +69,10 @@ export function lazyAsync<
       return _getStandardProps(this);
     },
     async '~run'(dataset, config) {
-      return (await this.getter(dataset.value))['~run'](dataset, config);
+      return (await this.getter(dataset.value, config.signal))['~run'](
+        dataset,
+        config
+      );
     },
   };
 }