@types/node on types package + add more helper functions to types/utils

Author: KTrain5169

packages/types/CHANGELOG.md

@@ -19,6 +19,22 @@ For prereleases:
 - Pre-release versions (x.x.x-pre.x) are unstable releases for the designated API version. These contain work-in-progress types and annotations. Pre-release versions are not meant to be used except for trying out new API interfaces and giving feedback, and may change without prior programmatic or verbal notice. Pre-release versions are meant to be used with new builds from the `dev` branch of the base extension repo.
 - Release candidates (x.x.x-rc.x) are stable previews for the designated API version. These contain types that are more or less finalized for the designated release. Breaking changes should not be expected, both in type signature and functionality, but will always be highlighted in the changelog if necessary. This is also meant for feedback, but only for more subtle feedback before releasing that version such that it simply just contains bug fixes and very minor changes.
 
+## 1.0.0-pre.15
+
+### Added
+
+- There are now some new helper functions exported from `./utils`, similar the `defineAction` helper:
+    - `defineValidator` for defining a validator (sync or async).
+    - `defineHandler` for defining a handler.
+    - `defineCancelEvent` for defining a cancel event generator.
+    - `defineCancelEventInitializer` for defining an object with arguments to construct a cancel event class.
+    - `defineEventInfoArray` for defining an array where the first element is a `vscode.Event` interface, and the second element is a predicate.
+    - `defineEventPredicate` for defining a predicate for a cancel event (sync and async).
+    - `definePromptGenerator` for defining a Copilot prompt generator.
+    - `defineReasonGenerator` for defining a cancel event reason generator.
+    - `defineSetupHook` for defining a context setup hook.
+    - Note that these are meant to be used standalone, so you can get type hints if you want to reuse these components across actions. If you're already defining an action via `defineAction` and don't need to reuse those components across actions, you shouldn't need to use these helper functions (and is discouraged since it can overcomplicate type checking).
+
 ## 1.0.0-pre.14
 
 ### Breaking changes

packages/types/package.json

@@ -28,6 +28,7 @@
   "license": "MIT",
   "devDependencies": {
     "@arethetypeswrong/core": "^0.18.4",
+    "@types/node": "^24.12.0",
     "@types/vscode": "^1.95.0",
     "@typescript/native-preview": "7.0.0-dev.20260418.1",
     "tsdown": "^0.22.3"

packages/types/src/utils/index.ts

@@ -1,5 +1,6 @@
 import * as vscode from 'vscode';
-import type { SchemaTypes, InferDataFromSchema, RCEAction } from '../actions/types';
+import type { SchemaTypes, InferDataFromSchema, RCEAction, ActionValidationResult, ActionHandlerResult } from '../actions/types';
+import { RCECancelEvent, RCECancelEventInitializer, RCEContext } from '../actions';
 
 //#region Context consistency
 
@@ -226,7 +227,6 @@ export function getRequiredFence(text: string): string {
  * @param action The action definition
  * @returns The same action with full type inference
  * @example
- * // Event type is inferred from cancelEvents
  * defineAction({
  *   name: 'my_action',
  *   schema: z.object({ file: z.string() }),
@@ -240,7 +240,94 @@ export function defineAction<
     const TData extends object | undefined,
     const TSchema extends SchemaTypes,
     const TInput extends InferDataFromSchema<TSchema>,
->(action: RCEAction<TData, TSchema, TInput>): RCEAction<TData, TSchema, TInput> {
+>(action: RCEAction<TData, TSchema, TInput>): typeof action {
     return action;
+};
+
+/* @__NO_SIDE_EFFECTS__ */
+export function defineValidator<
+    const TData extends object | undefined,
+    const TSchema extends SchemaTypes,
+    const TInput extends InferDataFromSchema<TSchema>,
+    const TReturn extends ActionValidationResult | Thenable<ActionValidationResult>,
+>(validator: (ctx: RCEContext<TData, TSchema, TInput>) => TReturn): typeof validator {
+    return validator;
+};
+
+/* @__NO_SIDE_EFFECTS__ */
+export function defineHandler<
+    const TData extends object | undefined,
+    const TSchema extends SchemaTypes,
+    const TInput extends InferDataFromSchema<TSchema>,
+    const TReturn extends ActionHandlerResult | Thenable<ActionHandlerResult>,
+>(handler: (ctx: RCEContext<TData, TSchema, TInput>) => TReturn): typeof handler {
+    return handler;
+};
+
+/* @__NO_SIDE_EFFECTS__ */
+export function definePreviewEffect<
+    const TData extends object | undefined,
+    const TSchema extends SchemaTypes,
+    const TInput extends InferDataFromSchema<TSchema>,
+    const TReturn extends { disopse: () => unknown },
+>(preview: (ctx: RCEContext<TData, TSchema, TInput>) => TReturn): typeof preview {
+    return preview;
+};
+
+/* @__NO_SIDE_EFFECTS__ */
+export function defineCancelEvent<
+    const TData extends object | undefined,
+    const TSchema extends SchemaTypes,
+    const TInput extends InferDataFromSchema<TSchema>,
+    const TEventData extends unknown | undefined,
+    const TReturn extends RCECancelEvent<TEventData> | null,
+>(event: (ctx: RCEContext<TData, TSchema, TInput>) => TReturn): typeof event {
+    return event;
+};
+
+/* @__NO_SIDE_EFFECTS__ */
+export function defineCancelEventInitializer<const T extends unknown | undefined>(init: RCECancelEventInitializer<T>): typeof init {
+    return init;
 }
 
+/* @__NO_SIDE_EFFECTS__ */
+export function defineEventInfoArray<const T extends unknown | undefined>(eventInfo: [vscode.Event<T>, ((event: T) => boolean | Promise<boolean>) | null]): typeof eventInfo {
+    return eventInfo;
+};
+
+/* @__NO_SIDE_EFFECTS__ */
+export function defineEventPredicate<
+    const T extends unknown | undefined,
+    const TReturn extends boolean | Promise<boolean>,
+>(predicate: (event: T) => TReturn): typeof predicate {
+    return predicate;
+};
+
+/* @__NO_SIDE_EFFECTS__ */
+export function definePromptGenerator<
+    const TData extends object | undefined,
+    const TSchema extends SchemaTypes,
+    const TInput extends InferDataFromSchema<TSchema>,
+>(generator: (ctx: RCEContext<TData, TSchema, TInput>) => string): typeof generator {
+    return generator;
+};
+
+/* @__NO_SIDE_EFFECTS__ */
+export function defineReasonGenerator<
+    const TEventData extends unknown | undefined,
+    const TData extends object | undefined,
+    const TSchema extends SchemaTypes,
+    const TInput extends InferDataFromSchema<TSchema>,
+>(generator: (ctx: RCEContext<TData, TSchema, TInput>, event: TEventData) => string): typeof generator {
+    return generator;
+};
+
+/* @__NO_SIDE_EFFECTS__ */
+export function defineSetupHook<
+    const TData extends object | undefined,
+    const TSchema extends SchemaTypes,
+    const TInput extends InferDataFromSchema<TSchema>,
+    const TReturn extends void | Thenable<void>,
+>(hook: (ctx: RCEContext<TData, TSchema, TInput>) => TReturn): typeof hook {
+    return hook;
+};

packages/types/tsconfig.json

@@ -11,7 +11,7 @@
     "module": "preserve",
     "moduleResolution": "bundler",
     "target": "esnext",
-    "types": [],
+    "types": ["node"],
     // For nodejs:
     // "lib": ["esnext"],
     // "types": ["node"],