cleye 2.1.0 → 2.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/index.d.cts +27 -3
  2. package/dist/index.d.mts +27 -3
  3. package/package.json +1 -1
package/dist/index.d.cts CHANGED
@@ -206,17 +206,41 @@ type ParseArgv<Options extends {
206
206
  * when excess properties are passed.
207
207
  */
208
208
  type StrictOptions<T> = T & Record<Exclude<keyof T, keyof CliOptions>, never>;
209
+ /**
210
+ * Helper type to conditionally add Promise<void> to return type
211
+ * only when callback returns a Promise.
212
+ */
213
+ type MaybePromise<Result, CallbackReturn> = CallbackReturn extends Promise<void> ? Result & Promise<void> : Result;
209
214
 
210
- declare function cli<Options extends CliOptions<undefined, [...Parameters]>, Parameters extends string[]>(options: StrictOptions<Options> & CliOptions<undefined, [...Parameters]>, callback?: CallbackFunction<ParseArgv<Options, Parameters>>, argv?: string[]): ({
215
+ declare function cli<Options extends CliOptions<undefined, [...Parameters]>, Parameters extends string[]>(options: StrictOptions<Options> & CliOptions<undefined, [...Parameters]> & {
216
+ commands?: undefined;
217
+ }, callback?: undefined, argv?: string[]): {
218
+ [Key in keyof ParseArgv<Options, Parameters, undefined>]: ParseArgv<Options, Parameters, undefined>[Key];
219
+ };
220
+ declare function cli<Options extends CliOptions<undefined, [...Parameters]>, Parameters extends string[], CallbackReturn extends void | Promise<void>>(options: StrictOptions<Options> & CliOptions<undefined, [...Parameters]> & {
221
+ commands?: undefined;
222
+ }, callback: (parsed: ParseArgv<Options, Parameters>) => CallbackReturn, argv?: string[]): MaybePromise<{
223
+ [Key in keyof ParseArgv<Options, Parameters, undefined>]: ParseArgv<Options, Parameters, undefined>[Key];
224
+ }, CallbackReturn>;
225
+ declare function cli<Options extends CliOptions<[...Commands], [...Parameters]>, Commands extends Command[], Parameters extends string[]>(options: StrictOptions<Options> & CliOptions<[...Commands], [...Parameters]> & {
226
+ commands: [...Commands];
227
+ }, callback?: undefined, argv?: string[]): ({
211
228
  [Key in keyof ParseArgv<Options, Parameters, undefined>]: ParseArgv<Options, Parameters, undefined>[Key];
212
- } & Promise<void>);
213
- declare function cli<Options extends CliOptions<[...Commands], [...Parameters]>, Commands extends Command[], Parameters extends string[]>(options: StrictOptions<Options> & CliOptions<[...Commands], [...Parameters]>, callback?: CallbackFunction<ParseArgv<Options, Parameters>>, argv?: string[]): (({
229
+ } | {
230
+ [KeyA in keyof Commands]: (Commands[KeyA] extends Command ? ({
231
+ [KeyB in keyof Commands[KeyA][typeof parsedType]]: Commands[KeyA][typeof parsedType][KeyB];
232
+ }) : never);
233
+ }[number]) & Promise<void>;
234
+ declare function cli<Options extends CliOptions<[...Commands], [...Parameters]>, Commands extends Command[], Parameters extends string[]>(options: StrictOptions<Options> & CliOptions<[...Commands], [...Parameters]> & {
235
+ commands: [...Commands];
236
+ }, callback: (parsed: ParseArgv<Options, Parameters>) => void | Promise<void>, argv?: string[]): (({
214
237
  [Key in keyof ParseArgv<Options, Parameters, undefined>]: ParseArgv<Options, Parameters, undefined>[Key];
215
238
  } | {
216
239
  [KeyA in keyof Commands]: (Commands[KeyA] extends Command ? ({
217
240
  [KeyB in keyof Commands[KeyA][typeof parsedType]]: Commands[KeyA][typeof parsedType][KeyB];
218
241
  }) : never);
219
242
  }[number]) & Promise<void>);
243
+ declare function cli(options: CliOptions, callback?: CallbackFunction<any>, argv?: string[]): ParseArgv<CliOptions, string[], undefined>;
220
244
 
221
245
  export { Renderers, cli, command };
222
246
  export type { Command, Flags };
package/dist/index.d.mts CHANGED
@@ -206,17 +206,41 @@ type ParseArgv<Options extends {
206
206
  * when excess properties are passed.
207
207
  */
208
208
  type StrictOptions<T> = T & Record<Exclude<keyof T, keyof CliOptions>, never>;
209
+ /**
210
+ * Helper type to conditionally add Promise<void> to return type
211
+ * only when callback returns a Promise.
212
+ */
213
+ type MaybePromise<Result, CallbackReturn> = CallbackReturn extends Promise<void> ? Result & Promise<void> : Result;
209
214
 
210
- declare function cli<Options extends CliOptions<undefined, [...Parameters]>, Parameters extends string[]>(options: StrictOptions<Options> & CliOptions<undefined, [...Parameters]>, callback?: CallbackFunction<ParseArgv<Options, Parameters>>, argv?: string[]): ({
215
+ declare function cli<Options extends CliOptions<undefined, [...Parameters]>, Parameters extends string[]>(options: StrictOptions<Options> & CliOptions<undefined, [...Parameters]> & {
216
+ commands?: undefined;
217
+ }, callback?: undefined, argv?: string[]): {
218
+ [Key in keyof ParseArgv<Options, Parameters, undefined>]: ParseArgv<Options, Parameters, undefined>[Key];
219
+ };
220
+ declare function cli<Options extends CliOptions<undefined, [...Parameters]>, Parameters extends string[], CallbackReturn extends void | Promise<void>>(options: StrictOptions<Options> & CliOptions<undefined, [...Parameters]> & {
221
+ commands?: undefined;
222
+ }, callback: (parsed: ParseArgv<Options, Parameters>) => CallbackReturn, argv?: string[]): MaybePromise<{
223
+ [Key in keyof ParseArgv<Options, Parameters, undefined>]: ParseArgv<Options, Parameters, undefined>[Key];
224
+ }, CallbackReturn>;
225
+ declare function cli<Options extends CliOptions<[...Commands], [...Parameters]>, Commands extends Command[], Parameters extends string[]>(options: StrictOptions<Options> & CliOptions<[...Commands], [...Parameters]> & {
226
+ commands: [...Commands];
227
+ }, callback?: undefined, argv?: string[]): ({
211
228
  [Key in keyof ParseArgv<Options, Parameters, undefined>]: ParseArgv<Options, Parameters, undefined>[Key];
212
- } & Promise<void>);
213
- declare function cli<Options extends CliOptions<[...Commands], [...Parameters]>, Commands extends Command[], Parameters extends string[]>(options: StrictOptions<Options> & CliOptions<[...Commands], [...Parameters]>, callback?: CallbackFunction<ParseArgv<Options, Parameters>>, argv?: string[]): (({
229
+ } | {
230
+ [KeyA in keyof Commands]: (Commands[KeyA] extends Command ? ({
231
+ [KeyB in keyof Commands[KeyA][typeof parsedType]]: Commands[KeyA][typeof parsedType][KeyB];
232
+ }) : never);
233
+ }[number]) & Promise<void>;
234
+ declare function cli<Options extends CliOptions<[...Commands], [...Parameters]>, Commands extends Command[], Parameters extends string[]>(options: StrictOptions<Options> & CliOptions<[...Commands], [...Parameters]> & {
235
+ commands: [...Commands];
236
+ }, callback: (parsed: ParseArgv<Options, Parameters>) => void | Promise<void>, argv?: string[]): (({
214
237
  [Key in keyof ParseArgv<Options, Parameters, undefined>]: ParseArgv<Options, Parameters, undefined>[Key];
215
238
  } | {
216
239
  [KeyA in keyof Commands]: (Commands[KeyA] extends Command ? ({
217
240
  [KeyB in keyof Commands[KeyA][typeof parsedType]]: Commands[KeyA][typeof parsedType][KeyB];
218
241
  }) : never);
219
242
  }[number]) & Promise<void>);
243
+ declare function cli(options: CliOptions, callback?: CallbackFunction<any>, argv?: string[]): ParseArgv<CliOptions, string[], undefined>;
220
244
 
221
245
  export { Renderers, cli, command };
222
246
  export type { Command, Flags };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cleye",
3
- "version": "2.1.0",
3
+ "version": "2.1.1",
4
4
  "description": "The intuitive CLI development tool",
5
5
  "keywords": [
6
6
  "cli",