Merge pull request #1359 from open-circle/feat-export-raw-check-and-raw-transform-types

Export raw check and transform types for improved DX

Author: fabian-hiller

library/CHANGELOG.md

@@ -5,6 +5,7 @@ All notable changes to the library will be documented in this file.
 ## vX.X.X (Month DD, YYYY)
 
 - Add `toBigint`, `toBoolean`, `toDate`, `toNumber` and `toString` transformation actions (pull request #1212)
+- Export `RawCheckAddIssue`, `RawCheckContext`, `RawCheckIssueInfo`, `RawTransformAddIssue`, `RawTransformContext` and `RawTransformIssueInfo` types for better developer experience with `rawCheck` and `rawTransform` actions (pull request #1358)
 - Change build step to tsdown
 
 ## v1.1.0 (May 06, 2025)

library/src/actions/rawCheck/index.ts

@@ -1,3 +1,3 @@
 export * from './rawCheck.ts';
 export * from './rawCheckAsync.ts';
-export type { RawCheckIssue } from './types.ts';
+export * from './types.ts';

library/src/actions/rawCheck/rawCheck.ts

@@ -1,6 +1,6 @@
 import type { BaseValidation } from '../../types/index.ts';
 import { _addIssue } from '../../utils/index.ts';
-import type { Context, RawCheckIssue } from './types.ts';
+import type { RawCheckContext, RawCheckIssue } from './types.ts';
 
 /**
  * Raw check action interface.
@@ -30,7 +30,7 @@ export interface RawCheckAction<TInput>
  */
 // @__NO_SIDE_EFFECTS__
 export function rawCheck<TInput>(
-  action: (context: Context<TInput>) => void
+  action: (context: RawCheckContext<TInput>) => void
 ): RawCheckAction<TInput> {
   return {
     kind: 'validation',

library/src/actions/rawCheck/rawCheckAsync.ts

@@ -1,6 +1,6 @@
 import type { BaseValidationAsync, MaybePromise } from '../../types/index.ts';
 import { _addIssue } from '../../utils/index.ts';
-import type { Context, RawCheckIssue } from './types.ts';
+import type { RawCheckContext, RawCheckIssue } from './types.ts';
 
 /**
  * Raw check action async interface.
@@ -30,7 +30,7 @@ export interface RawCheckActionAsync<TInput>
  */
 // @__NO_SIDE_EFFECTS__
 export function rawCheckAsync<TInput>(
-  action: (context: Context<TInput>) => MaybePromise<void>
+  action: (context: RawCheckContext<TInput>) => MaybePromise<void>
 ): RawCheckActionAsync<TInput> {
   return {
     kind: 'validation',

library/src/actions/rawCheck/types.ts

@@ -21,9 +21,9 @@ export interface RawCheckIssue<TInput> extends BaseIssue<TInput> {
 }
 
 /**
- * Issue info interface.
+ * Raw check issue info interface.
  */
-interface IssueInfo<TInput> {
+export interface RawCheckIssueInfo<TInput> {
   label?: string | undefined;
   input?: unknown | undefined;
   expected?: string | undefined;
@@ -33,15 +33,17 @@ interface IssueInfo<TInput> {
 }
 
 /**
- * Add issue type.
+ * Raw check add issue type.
  */
-type AddIssue<TInput> = (info?: IssueInfo<TInput>) => void;
+export type RawCheckAddIssue<TInput> = (
+  info?: RawCheckIssueInfo<TInput>
+) => void;
 
 /**
- * Context interface.
+ * Raw check context interface.
  */
-export interface Context<TInput> {
+export interface RawCheckContext<TInput> {
   readonly dataset: OutputDataset<TInput, BaseIssue<unknown>>;
   readonly config: Config<RawCheckIssue<TInput>>;
-  readonly addIssue: AddIssue<TInput>;
+  readonly addIssue: RawCheckAddIssue<TInput>;
 }

library/src/actions/rawTransform/index.ts

@@ -1,3 +1,3 @@
 export * from './rawTransform.ts';
 export * from './rawTransformAsync.ts';
-export type { RawTransformIssue } from './types.ts';
+export * from './types.ts';

library/src/actions/rawTransform/rawTransform.ts

@@ -4,7 +4,7 @@ import type {
   OutputDataset,
 } from '../../types/index.ts';
 import { _addIssue } from '../../utils/index.ts';
-import type { Context, RawTransformIssue } from './types.ts';
+import type { RawTransformContext, RawTransformIssue } from './types.ts';
 
 /**
  * Raw transform action interface.
@@ -30,7 +30,7 @@ export interface RawTransformAction<TInput, TOutput>
  */
 // @__NO_SIDE_EFFECTS__
 export function rawTransform<TInput, TOutput>(
-  action: (context: Context<TInput>) => TOutput
+  action: (context: RawTransformContext<TInput>) => TOutput
 ): RawTransformAction<TInput, TOutput> {
   return {
     kind: 'transformation',

library/src/actions/rawTransform/rawTransformAsync.ts

@@ -5,7 +5,7 @@ import type {
   OutputDataset,
 } from '../../types/index.ts';
 import { _addIssue } from '../../utils/index.ts';
-import type { Context, RawTransformIssue } from './types.ts';
+import type { RawTransformContext, RawTransformIssue } from './types.ts';
 
 /**
  * Raw transform action async interface.
@@ -31,7 +31,7 @@ export interface RawTransformActionAsync<TInput, TOutput>
  */
 // @__NO_SIDE_EFFECTS__
 export function rawTransformAsync<TInput, TOutput>(
-  action: (context: Context<TInput>) => MaybePromise<TOutput>
+  action: (context: RawTransformContext<TInput>) => MaybePromise<TOutput>
 ): RawTransformActionAsync<TInput, TOutput> {
   return {
     kind: 'transformation',

library/src/actions/rawTransform/types.ts

@@ -21,9 +21,9 @@ export interface RawTransformIssue<TInput> extends BaseIssue<TInput> {
 }
 
 /**
- * Issue info interface.
+ * Raw transform issue info interface.
  */
-interface IssueInfo<TInput> {
+export interface RawTransformIssueInfo<TInput> {
   label?: string | undefined;
   input?: unknown | undefined;
   expected?: string | undefined;
@@ -33,16 +33,18 @@ interface IssueInfo<TInput> {
 }
 
 /**
- * Add issue type.
+ * Raw transform add issue type.
  */
-type AddIssue<TInput> = (info?: IssueInfo<TInput>) => void;
+export type RawTransformAddIssue<TInput> = (
+  info?: RawTransformIssueInfo<TInput>
+) => void;
 
 /**
- * Context interface.
+ * Raw transform context interface.
  */
-export interface Context<TInput> {
+export interface RawTransformContext<TInput> {
   readonly dataset: SuccessDataset<TInput>;
   readonly config: Config<RawTransformIssue<TInput>>;
-  readonly addIssue: AddIssue<TInput>;
+  readonly addIssue: RawTransformAddIssue<TInput>;
   readonly NEVER: never;
 }