create-rstack 1.7.20 → 1.8.0

package/dist/index.d.ts

@@ -1,3 +1,6 @@
+import { Readable } from 'node:stream';
+import { Writable } from 'node:stream';
+
 export declare type Argv = {
     help?: boolean;
     dir?: string;
@@ -17,6 +20,13 @@ export declare function checkCancel<T>(value: unknown): T;
  */
 export declare function collectAgentsFiles(agentsMdSearchDirs: string[]): string[];
 
+declare interface CommonOptions {
+    input?: Readable;
+    output?: Writable;
+    signal?: AbortSignal;
+    withGuide?: boolean;
+}
+
 /**
  * Copy files from one folder to another.
  * @param from Source folder
@@ -89,6 +99,12 @@ declare type ExtraTool = {
      * If undefined, the tool will be displayed after built-in tools.
      */
     order?: 'pre' | 'post';
+    /**
+     * Condition to determine whether this tool should be displayed.
+     * If returns false, the tool will not be shown in the selection.
+     * @default () => true
+     */
+    when?: (templateName: string) => boolean;
 };
 
 /**
@@ -103,9 +119,9 @@ export declare function mergeAgentsFiles(agentsFiles: string[]): string;
  */
 export declare function mergePackageJson(targetPackage: string, extraPackage: string): void;
 
-export declare const multiselect: <Value>(opts: MultiSelectOptions<Value>) => Promise<symbol | Value[]>;
+export declare const multiselect: <Value>(opts: MultiSelectOptions<Value>) => Promise<Value[] | symbol>;
 
-declare interface MultiSelectOptions<Value> {
+declare interface MultiSelectOptions<Value> extends CommonOptions {
     message: string;
     options: Option_2<Value>[];
     initialValues?: Value[];
@@ -132,6 +148,13 @@ declare type Option_2<Value> = Value extends Primitive ? {
      * By default, no `hint` is displayed.
      */
     hint?: string;
+    /**
+     * Whether this option is disabled.
+     * Disabled options are visible but cannot be selected.
+     *
+     * By default, options are not disabled.
+     */
+    disabled?: boolean;
 } : {
     /**
      * Internal data for this option.
@@ -148,13 +171,20 @@ declare type Option_2<Value> = Value extends Primitive ? {
      * By default, no `hint` is displayed.
      */
     hint?: string;
+    /**
+     * Whether this option is disabled.
+     * Disabled options are visible but cannot be selected.
+     *
+     * By default, options are not disabled.
+     */
+    disabled?: boolean;
 };
 
 declare type Primitive = Readonly<string | boolean | number>;
 
-export declare const select: <Value>(opts: SelectOptions<Value>) => Promise<symbol | Value>;
+export declare const select: <Value>(opts: SelectOptions<Value>) => Promise<Value | symbol>;
 
-declare interface SelectOptions<Value> {
+declare interface SelectOptions<Value> extends CommonOptions {
     message: string;
     options: Option_2<Value>[];
     initialValue?: Value;
@@ -163,12 +193,12 @@ declare interface SelectOptions<Value> {
 
 export declare const text: (opts: TextOptions) => Promise<string | symbol>;
 
-declare interface TextOptions {
+declare interface TextOptions extends CommonOptions {
     message: string;
     placeholder?: string;
     defaultValue?: string;
     initialValue?: string;
-    validate?: (value: string) => string | Error | undefined;
+    validate?: (value: string | undefined) => string | Error | undefined;
 }
 
 export { }