fix(prompt): fix validation and return type of object option values for checkbox and seleect prompt (#718)

Author: c4spar

prompt/checkbox.ts

@@ -1,4 +1,5 @@
 import type { KeyCode } from "@cliffy/keycode";
+import { equal } from "@std/assert/equal";
 import { WidenType } from "./_utils.ts";
 import { brightBlue, dim, green, red } from "@std/fmt/colors";
 import { Figures, getFiguresByKeys } from "./_figures.ts";
@@ -24,7 +25,7 @@ export interface CheckboxOptions<TValue>
   keys?: CheckboxKeys;
   /** An array of child options. */
   options: Array<
-    | Extract<TValue, string | number>
+    // | Extract<TValue, string | number>
     | Extract<WidenType<TValue>, string | number>
     | CheckboxOption<TValue>
     | CheckboxOptionGroup<TValue>
@@ -460,7 +461,7 @@ export class Checkbox<TValue> extends GenericList<
     const isValidValue = Array.isArray(value) &&
       value.every((val) =>
         options.findIndex((option: CheckboxOptionSettings<TValue>) =>
-          option.value === val
+          equal(option.value, val)
         ) !== -1
       );
 

prompt/select.ts

@@ -15,6 +15,7 @@ import {
 } from "./_generic_list.ts";
 import { GenericPrompt } from "./_generic_prompt.ts";
 import { getFiguresByKeys } from "./_figures.ts";
+import { equal } from "@std/assert/equal";
 
 /** Select prompt options. */
 export interface SelectOptions<TValue>
@@ -23,7 +24,7 @@ export interface SelectOptions<TValue>
   keys?: SelectKeys;
   /** An array of child options. */
   options: Array<
-    | Extract<TValue, string | number>
+    // | Extract<TValue, string | number>
     | Extract<WidenType<TValue>, string | number>
     | SelectOption<TValue>
     | SelectOptionGroup<TValue>
@@ -158,7 +159,7 @@ export class Select<TValue> extends GenericList<
    *
    * @param value Input value.
    */
-  public static inject(value: string): void {
+  public static inject<TValue>(value: TValue): void {
     GenericPrompt.inject(value);
   }
 
@@ -238,7 +239,7 @@ export class Select<TValue> extends GenericList<
   protected validate(value: TValue): boolean | string {
     return this.options.findIndex((
       option: SelectOptionSettings<TValue> | SelectOptionGroupSettings<TValue>,
-    ) => isOption(option) && option.value === value) !== -1;
+    ) => isOption(option) && equal(option.value, value)) !== -1;
   }
 
   /**

prompt/test/checkbox_test.ts

@@ -1,5 +1,6 @@
 import { assertEquals, assertRejects } from "@std/assert";
 import { bold, red } from "@std/fmt/colors";
+import { assertType, IsExact } from "@std/testing/types";
 import { Checkbox } from "../checkbox.ts";
 
 Deno.test("prompt checkbox: valid value", async () => {
@@ -17,9 +18,27 @@ Deno.test("prompt checkbox: empty value", async () => {
     message: "message",
     options: [{ value: "value1" }, { value: "value2" }, "value3"],
   });
+
   assertEquals(result, []);
 });
 
+Deno.test("prompt checkbox: object value", async () => {
+  Checkbox.inject([{ id: 1, name: "foo" }]);
+
+  const books = [
+    { id: 1, name: "foo" },
+    { id: 2, name: "bar" },
+  ];
+
+  const result = await Checkbox.prompt({
+    message: "please select a book",
+    options: books.map((x) => ({ name: x.name, value: x })),
+  });
+
+  assertEquals(result, [{ id: 1, name: "foo" }]);
+  assertType<IsExact<typeof result, Array<{ id: number; name: string }>>>(true);
+});
+
 Deno.test("prompt checkbox: invalid value", async () => {
   await assertRejects(
     async () => {

prompt/test/select_test.ts

@@ -1,5 +1,6 @@
 import { assertEquals, assertRejects } from "@std/assert";
 import { bold, red } from "@std/fmt/colors";
+import { assertType, IsExact } from "@std/testing/types";
 import { Select } from "../select.ts";
 
 Deno.test("prompt select: value", async () => {
@@ -12,6 +13,23 @@ Deno.test("prompt select: value", async () => {
   assertEquals(result, "value2");
 });
 
+Deno.test("prompt select: object value", async () => {
+  Select.inject({ id: 1, name: "foo" });
+
+  const books = [
+    { id: 1, name: "foo" },
+    { id: 2, name: "bar" },
+  ];
+
+  const result = await Select.prompt({
+    message: "please select a book",
+    options: books.map((x) => ({ name: x.name, value: x })),
+  });
+
+  assertEquals(result, { id: 1, name: "foo" });
+  assertType<IsExact<typeof result, { id: number; name: string }>>(true);
+});
+
 Deno.test("prompt select: empty value", async () => {
   await assertRejects(
     async () => {