effect 4.0.0-rc.112 → 4.0.0-rc.113

package/dist/unstable/cli/Prompt.js

@@ -74,6 +74,8 @@ export const makeTheme = options => ({
 /**
  * Context reference for the theme used by built-in prompts.
  *
+ * **Details**
+ *
  * Provide this reference once to theme every prompt in an application. A
  * prompt's `theme` option takes precedence over the context value.
  *
@@ -185,12 +187,12 @@ const renderPagingPrefix = (theme, showArrowUp, showArrowDown) => {
  * `initial` defaults to `false`. Enter submits the current default, yes-style
  * input submits `true`, no-style input submits `false`, and other input beeps.
  *
- * @see {@link toggle} for an interactive switch-before-submit boolean prompt
+ * @see {@link Toggle} for an interactive switch-before-submit boolean prompt
  *
  * @category constructors
  * @since 4.0.0
  */
-export const confirm = options => {
+export const Confirm = options => {
   const opts = {
     initial: false,
     ...options,
@@ -208,7 +210,7 @@ export const confirm = options => {
   const initialState = {
     value: opts.initial
   };
-  return custom(initialState, {
+  return Custom(initialState, {
     render: handleConfirmRender(opts),
     process: input => handleConfirmProcess(input, opts.initial),
     clear: handleConfirmClear(opts)
@@ -236,7 +238,7 @@ export const confirm = options => {
  * @category constructors
  * @since 4.0.0
  */
-export const custom = (initialState, ...args) => {
+export const Custom = (initialState, ...args) => {
   const [events, handlers] = args.length === 1 ? [undefined, args[0]] : [args[0], args[1]];
   const op = Object.create(proto);
   op._tag = "Loop";
@@ -268,9 +270,9 @@ export const custom = (initialState, ...args) => {
  * @category constructors
  * @since 4.0.0
  */
-export const date = options => {
+export const Date = options => {
   const opts = {
-    initial: new Date(),
+    initial: new globalThis.Date(),
     dateMask: "YYYY-MM-DD HH:mm:ss",
     validate: Effect.succeed,
     ...options,
@@ -288,7 +290,7 @@ export const date = options => {
     value: opts.initial,
     error: Option.none()
   };
-  return custom(initialState, {
+  return Custom(initialState, {
     render: handleDateRender(opts),
     process: handleDateProcess(opts),
     clear: handleDateClear(opts)
@@ -310,7 +312,7 @@ export const date = options => {
  * @category constructors
  * @since 4.0.0
  */
-export const file = (options = {}) => {
+export const File = (options = {}) => {
   const opts = {
     ...options,
     type: options.type ?? "file",
@@ -336,7 +338,7 @@ export const file = (options = {}) => {
         return index === -1 ? 0 : index;
       }
     });
-    const confirm = Confirm.Hide();
+    const confirm = FileConfirm.Hide();
     return {
       cursor,
       files,
@@ -346,7 +348,7 @@ export const file = (options = {}) => {
       confirm
     };
   });
-  return custom(initialState, {
+  return Custom(initialState, {
     render: handleFileRender(opts),
     process: handleFileProcess(opts),
     clear: handleFileClear(opts)
@@ -376,11 +378,11 @@ export const flatMap = /*#__PURE__*/dual(2, (self, f) => {
  * @category constructors
  * @since 4.0.0
  */
-export const float = options => {
+export const Number = options => {
   const opts = {
     default: 0,
-    min: Number.NEGATIVE_INFINITY,
-    max: Number.POSITIVE_INFINITY,
+    min: globalThis.Number.NEGATIVE_INFINITY,
+    max: globalThis.Number.POSITIVE_INFINITY,
     incrementBy: 1,
     decrementBy: 1,
     precision: 2,
@@ -401,7 +403,7 @@ export const float = options => {
     value: initialValue,
     error: Option.none()
   };
-  return custom(initialState, {
+  return Custom(initialState, {
     render: handleRenderFloat(opts),
     process: handleProcessFloat(opts),
     clear: handleNumberClear(opts)
@@ -414,7 +416,7 @@ export const float = options => {
  * @category constructors
  * @since 4.0.0
  */
-export const hidden = options => basePrompt(options, "hidden").pipe(map(Redacted.make));
+export const Hidden = options => basePrompt(options, "hidden").pipe(map(Redacted.make));
 /**
  * Creates an integer prompt.
  *
@@ -426,11 +428,11 @@ export const hidden = options => basePrompt(options, "hidden").pipe(map(Redacted
  * @category constructors
  * @since 4.0.0
  */
-export const integer = options => {
+export const Int = options => {
   const opts = {
     default: 0,
-    min: Number.NEGATIVE_INFINITY,
-    max: Number.POSITIVE_INFINITY,
+    min: globalThis.Number.NEGATIVE_INFINITY,
+    max: globalThis.Number.POSITIVE_INFINITY,
     incrementBy: 1,
     decrementBy: 1,
     validate: n => {
@@ -450,7 +452,7 @@ export const integer = options => {
     value: initialValue,
     error: Option.none()
   };
-  return custom(initialState, {
+  return Custom(initialState, {
     render: handleRenderInteger(opts),
     process: handleProcessInteger(opts),
     clear: handleNumberClear(opts)
@@ -463,7 +465,7 @@ export const integer = options => {
  * @category constructors
  * @since 4.0.0
  */
-export const list = options => text(options).pipe(map(output => output.split(options.delimiter || ",")));
+export const List = options => String(options).pipe(map(output => output.split(options.delimiter || ",")));
 /**
  * Transforms the output value produced by a prompt.
  *
@@ -478,7 +480,7 @@ export const map = /*#__PURE__*/dual(2, (self, f) => flatMap(self, a => succeed(
  * @category constructors
  * @since 4.0.0
  */
-export const password = options => basePrompt(options, "password").pipe(map(Redacted.make));
+export const Password = options => basePrompt(options, "password").pipe(map(Redacted.make));
 /**
  * Runs a prompt by reading terminal input and rendering prompt frames until the
  * prompt submits a value.
@@ -503,7 +505,7 @@ const getSelectInitialIndex = choices => {
     const choice = choices[i];
     if (choice.selected === true) {
       if (seenSelected !== -1) {
-        throw new Error("InvalidArgumentException: only a single choice can be selected by default for Prompt.select");
+        throw new Error("InvalidArgumentException: only a single choice can be selected by default for Prompt.Select");
       }
       seenSelected = i;
     }
@@ -524,13 +526,13 @@ const getSelectInitialIndex = choices => {
  * @category constructors
  * @since 4.0.0
  */
-export const select = options => {
+export const Select = options => {
   const opts = {
     maxPerPage: 10,
     ...options
   };
   const initialIndex = getSelectInitialIndex(opts.choices);
-  return custom(initialIndex, {
+  return Custom(initialIndex, {
     render: handleSelectRender(opts),
     process: handleSelectProcess(opts),
     clear: handleSelectClear(opts)
@@ -550,7 +552,7 @@ export const select = options => {
  * ```ts import.meta.vitest
  * import { Prompt } from "effect/unstable/cli"
  *
- * const language = Prompt.autoComplete({
+ * const language = Prompt.AutoComplete({
  *   message: "Choose a language",
  *   choices: [
  *     { title: "TypeScript", value: "ts" },
@@ -565,7 +567,7 @@ export const select = options => {
  * @category constructors
  * @since 4.0.0
  */
-export const autoComplete = options => {
+export const AutoComplete = options => {
   const opts = {
     maxPerPage: 10,
     filterLabel: "filter",
@@ -581,7 +583,7 @@ export const autoComplete = options => {
     index,
     filtered
   };
-  return custom(initialState, {
+  return Custom(initialState, {
     render: handleAutoCompleteRender(opts),
     process: handleAutoCompleteProcess(opts),
     clear: handleAutoCompleteClear(opts)
@@ -599,7 +601,7 @@ export const autoComplete = options => {
  * @category constructors
  * @since 4.0.0
  */
-export const multiSelect = options => {
+export const MultiSelect = options => {
   const opts = {
     maxPerPage: 10,
     ...options
@@ -617,7 +619,7 @@ export const multiSelect = options => {
     selectedIndices: initialSelected,
     error: Option.none()
   };
-  return custom(initialState, {
+  return Custom(initialState, {
     render: handleMultiSelectRender(opts),
     process: handleMultiSelectProcess(opts),
     clear: handleMultiSelectClear(opts)
@@ -647,7 +649,7 @@ export const succeed = value => {
  * @category constructors
  * @since 4.0.0
  */
-export const text = options => basePrompt(options, "text");
+export const String = options => basePrompt(options, "text");
 /**
  * Creates a toggle prompt that lets the user switch between active and inactive
  * states and returns the selected boolean value.
@@ -655,14 +657,14 @@ export const text = options => basePrompt(options, "text");
  * @category constructors
  * @since 4.0.0
  */
-export const toggle = options => {
+export const Toggle = options => {
   const opts = {
     initial: false,
     active: "on",
     inactive: "off",
     ...options
   };
-  return custom(opts.initial, {
+  return Custom(opts.initial, {
     render: handleToggleRender(opts),
     process: handleToggleProcess,
     clear: () => handleToggleClear(opts)
@@ -715,9 +717,11 @@ const runLoop = /*#__PURE__*/Effect.fnUntraced(function* (loop, terminal, input)
   let action = Action.NextFrame({
     state
   });
+  let clear = "";
   while (true) {
     const msg = yield* loop.render(state, action);
-    yield* Effect.orDie(terminal.display(msg));
+    yield* Effect.orDie(terminal.display(clear + msg));
+    clear = "";
     if (loop.events) {
       const takeInput = Queue.take(input).pipe(Effect.map(input => ({
         _tag: "Input",
@@ -737,15 +741,15 @@ const runLoop = /*#__PURE__*/Effect.fnUntraced(function* (loop, terminal, input)
         continue;
       case "NextFrame":
         {
-          yield* Effect.orDie(terminal.display(yield* loop.clear(state, action)));
+          clear = yield* loop.clear(state, action);
           state = action.state;
           continue;
         }
       case "Submit":
         {
-          yield* Effect.orDie(terminal.display(yield* loop.clear(state, action)));
+          clear = yield* loop.clear(state, action);
           const msg = yield* loop.render(state, action);
-          yield* Effect.orDie(terminal.display(msg));
+          yield* Effect.orDie(terminal.display(clear + msg));
           return action.value;
         }
     }
@@ -957,6 +961,7 @@ const processDateNext = state => {
   return Action.NextFrame({
     state: {
       ...state,
+      typed: "",
       cursor
     }
   });
@@ -1100,7 +1105,7 @@ class DatePart {
   constructor(params) {
     this.token = params.token;
     this.locales = params.locales;
-    this.date = params.date || new Date();
+    this.date = params.date || new globalThis.Date();
     this.parts = params.parts || [this];
   }
   /**
@@ -1127,7 +1132,7 @@ class DatePart {
     return Option.none();
   }
   toString() {
-    return String(this.date);
+    return globalThis.String(this.date);
   }
 }
 class Token extends DatePart {
@@ -1151,7 +1156,7 @@ class Milliseconds extends DatePart {
     this.date.setMilliseconds(this.date.getMilliseconds() - 1);
   }
   setValue(value) {
-    this.date.setMilliseconds(Number.parseInt(value.slice(-this.token.length)));
+    this.date.setMilliseconds(globalThis.Number.parseInt(value.slice(-this.token.length)));
   }
   toString() {
     const millis = `${this.date.getMilliseconds()}`;
@@ -1166,7 +1171,7 @@ class Seconds extends DatePart {
     this.date.setSeconds(this.date.getSeconds() - 1);
   }
   setValue(value) {
-    this.date.setSeconds(Number.parseInt(value.slice(-2)));
+    this.date.setSeconds(globalThis.Number.parseInt(value.slice(-2)));
   }
   toString() {
     const seconds = `${this.date.getSeconds()}`;
@@ -1181,7 +1186,7 @@ class Minutes extends DatePart {
     this.date.setMinutes(this.date.getMinutes() - 1);
   }
   setValue(value) {
-    this.date.setMinutes(Number.parseInt(value.slice(-2)));
+    this.date.setMinutes(globalThis.Number.parseInt(value.slice(-2)));
   }
   toString() {
     const minutes = `${this.date.getMinutes()}`;
@@ -1196,7 +1201,7 @@ class Hours extends DatePart {
     this.date.setHours(this.date.getHours() - 1);
   }
   setValue(value) {
-    this.date.setHours(Number.parseInt(value.slice(-2)));
+    this.date.setHours(globalThis.Number.parseInt(value.slice(-2)));
   }
   toString() {
     const hours = /h/.test(this.token) ? this.date.getHours() % 12 || 12 : this.date.getHours();
@@ -1211,7 +1216,7 @@ class Day extends DatePart {
     this.date.setDate(this.date.getDate() - 1);
   }
   setValue(value) {
-    this.date.setDate(Number.parseInt(value.slice(-2)));
+    this.date.setDate(globalThis.Number.parseInt(value.slice(-2)));
   }
   toString() {
     const date = this.date.getDate();
@@ -1255,7 +1260,7 @@ class Month extends DatePart {
     this.date.setMonth(this.date.getMonth() - 1);
   }
   setValue(value) {
-    const month = Number.parseInt(value.slice(-2)) - 1;
+    const month = globalThis.Number.parseInt(value.slice(-2)) - 1;
     this.date.setMonth(month < 0 ? 0 : month);
   }
   toString() {
@@ -1280,7 +1285,7 @@ class Year extends DatePart {
     this.date.setFullYear(this.date.getFullYear() - 1);
   }
   setValue(value) {
-    this.date.setFullYear(Number.parseInt(value.slice(-4)));
+    this.date.setFullYear(globalThis.Number.parseInt(value.slice(-4)));
   }
   toString() {
     const year = `${this.date.getFullYear()}`.padStart(4, "0");
@@ -1304,8 +1309,8 @@ const CONFIRM_MESSAGE = "The selected directory contains files. Would you like t
 const FILE_FILTER_LABEL = "filter";
 const FILE_FILTER_PLACEHOLDER = "type to filter";
 const FILE_EMPTY_MESSAGE = "No matches";
-const Confirm = /*#__PURE__*/Data.taggedEnum();
-const showConfirmation = /*#__PURE__*/Confirm.$is("Show");
+const FileConfirm = /*#__PURE__*/Data.taggedEnum();
+const showConfirmation = /*#__PURE__*/FileConfirm.$is("Show");
 const resolveCurrentPath = (path, options) => {
   if (Option.isSome(path)) {
     return Effect.succeed(path.value);
@@ -1561,7 +1566,7 @@ const processSelection = /*#__PURE__*/Effect.fnUntraced(function* (state, option
       : Action.NextFrame({
         state: {
           ...state,
-          confirm: Confirm.Show()
+          confirm: FileConfirm.Show()
         }
       });
     }
@@ -1572,7 +1577,7 @@ const processSelection = /*#__PURE__*/Effect.fnUntraced(function* (state, option
         allFiles: files,
         query: "",
         path: Option.some(resolvedPath),
-        confirm: Confirm.Hide()
+        confirm: FileConfirm.Hide()
       }
     });
   }
@@ -1646,7 +1651,7 @@ const handleFileProcess = options => {
                 allFiles: files,
                 query: "",
                 path: Option.some(resolvedPath),
-                confirm: Confirm.Hide()
+                confirm: FileConfirm.Hide()
               }
             });
           }
@@ -1996,8 +2001,8 @@ const defaultIntProcessor = (input, state) => {
       }
     }));
   }
-  const parsed = Number.parseInt(state.value + input);
-  if (Number.isNaN(parsed)) {
+  const parsed = globalThis.Number.parseInt(state.value + input);
+  if (globalThis.Number.isNaN(parsed)) {
     return Effect.succeed(Action.Beep());
   } else {
     return Effect.succeed(Action.NextFrame({
@@ -2022,8 +2027,8 @@ const defaultFloatProcessor = (input, state) => {
       }
     }));
   }
-  const parsed = Number.parseFloat(state.value + input);
-  if (Number.isNaN(parsed)) {
+  const parsed = globalThis.Number.parseFloat(state.value + input);
+  if (globalThis.Number.isNaN(parsed)) {
     return Effect.succeed(Action.Beep());
   } else {
     return Effect.succeed(Action.NextFrame({
@@ -2062,7 +2067,7 @@ const handleProcessInteger = options => {
           return Effect.succeed(Action.NextFrame({
             state: {
               ...state,
-              value: state.value === "" || state.value === "-" ? `${options.incrementBy}` : `${Number.parseInt(state.value) + options.incrementBy}`,
+              value: state.value === "" || state.value === "-" ? `${options.incrementBy}` : `${globalThis.Number.parseInt(state.value) + options.incrementBy}`,
               error: Option.none()
             }
           }));
@@ -2073,7 +2078,7 @@ const handleProcessInteger = options => {
           return Effect.succeed(Action.NextFrame({
             state: {
               ...state,
-              value: state.value === "" || state.value === "-" ? `-${options.decrementBy}` : `${Number.parseInt(state.value) - options.decrementBy}`,
+              value: state.value === "" || state.value === "-" ? `-${options.decrementBy}` : `${globalThis.Number.parseInt(state.value) - options.decrementBy}`,
               error: Option.none()
             }
           }));
@@ -2081,8 +2086,8 @@ const handleProcessInteger = options => {
       case "enter":
       case "return":
         {
-          const parsed = Number.parseInt(state.value);
-          if (Number.isNaN(parsed)) {
+          const parsed = globalThis.Number.parseInt(state.value);
+          if (globalThis.Number.isNaN(parsed)) {
             return Effect.succeed(Action.NextFrame({
               state: {
                 ...state,
@@ -2137,7 +2142,7 @@ const handleProcessFloat = options => {
           return Effect.succeed(Action.NextFrame({
             state: {
               ...state,
-              value: state.value === "" || state.value === "-" ? `${options.incrementBy}` : `${Number.parseFloat(state.value) + options.incrementBy}`,
+              value: state.value === "" || state.value === "-" ? `${options.incrementBy}` : `${globalThis.Number.parseFloat(state.value) + options.incrementBy}`,
               error: Option.none()
             }
           }));
@@ -2148,7 +2153,7 @@ const handleProcessFloat = options => {
           return Effect.succeed(Action.NextFrame({
             state: {
               ...state,
-              value: state.value === "" || state.value === "-" ? `-${options.decrementBy}` : `${Number.parseFloat(state.value) - options.decrementBy}`,
+              value: state.value === "" || state.value === "-" ? `-${options.decrementBy}` : `${globalThis.Number.parseFloat(state.value) - options.decrementBy}`,
               error: Option.none()
             }
           }));
@@ -2156,8 +2161,8 @@ const handleProcessFloat = options => {
       case "enter":
       case "return":
         {
-          const parsed = Number.parseFloat(state.value);
-          if (Number.isNaN(parsed)) {
+          const parsed = globalThis.Number.parseFloat(state.value);
+          if (globalThis.Number.isNaN(parsed)) {
             return Effect.succeed(Action.NextFrame({
               state: {
                 ...state,
@@ -2829,7 +2834,7 @@ const basePrompt = (options, type) => {
     value: opts.default,
     error: Option.none()
   };
-  return custom(initialState, {
+  return Custom(initialState, {
     render: handleTextRender(opts),
     process: handleTextProcess(opts),
     clear: handleTextClear(opts)