@sorrell/cli-utilities 1.0.23 → 1.0.25

package/Distribution/Ora.Types.d.ts

@@ -0,0 +1,10 @@
+import type ora from "ora";
+/** The options object of {@link Ora}. */
+export type FOraOptions = Extract<Parameters<typeof ora>[0], object>;
+/**
+ * The `async` function or `Promise` passed to {@link Ora}.
+ *
+ * @typeParam Type - The type of the value returned by the task.
+ */
+export type TOraTaskArgument<Type> = (() => Promise<Type>) | Promise<Type> | ((SetPersistText: ((In: string) => void)) => Promise<Type>);
+//# sourceMappingURL=Ora.Types.d.ts.map

package/Distribution/Ora.Types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Ora.Types.d.ts","sourceRoot":"","sources":["../Source/Ora.Types.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAE3B,yCAAyC;AACzC,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAErE;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,IAAI,IAC3B,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,GACrB,OAAO,CAAC,IAAI,CAAC,GACb,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC"}

package/Distribution/Ora.Types.js

@@ -0,0 +1,7 @@
+/* File:      Ora.Types.ts
+ * Author:    Gage Sorrell <gage@sorrell.sh>
+ * Copyright: (c) 2026 Gage Sorrell
+ * License:   MIT
+ */
+export {};
+//# sourceMappingURL=Ora.Types.js.map

package/Distribution/Ora.Types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Ora.Types.js","sourceRoot":"","sources":["../Source/Ora.Types.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/Distribution/Ora.d.ts

@@ -0,0 +1,27 @@
+import type { FOraOptions, TOraTaskArgument } from "./Ora.Types.js";
+import { type TTryResult } from "@sorrell/utilities";
+import { type Ora as IOra } from "ora";
+/**
+ * Creates and starts an `Ora` instance with the given {@link Argument}.
+ *
+ * @param Argument - The options object.
+ *
+ * @returns An `Ora` instance with the specified options.
+ */
+export declare function Ora(Argument: FOraOptions): IOra;
+/**
+ * @deprecated Use {@link DoTask} instead.
+ *
+ * Executes an `async` function or `Promise` with a progress indicator.
+ *
+ * @typeParam Type - The type of the data to which the given {@link AsyncSource} resolves.
+ *
+ * @param AsyncSource - The `async` function or `Promise` whose state is conveyed
+ * by the returned instance of `Ora`.
+ * @param TaskDescription - The text to display in the `Ora` instance while the
+ * {@link AsyncSource} is pending.
+ *
+ * @returns The result of the {@link AsyncSource}, as a {@link TTryResult}.
+ */
+export declare function OraTask<Type>(AsyncSource: TOraTaskArgument<Type>, TaskDescription: string): Promise<TTryResult<Type>>;
+//# sourceMappingURL=Ora.d.ts.map

package/Distribution/Ora.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Ora.d.ts","sourceRoot":"","sources":["../Source/Ora.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACpE,OAAO,EAAE,KAAK,UAAU,EAAoC,MAAM,oBAAoB,CAAC;AACvF,OAAY,EAAE,KAAK,GAAG,IAAI,IAAI,EAAE,MAAM,KAAK,CAAC;AAE5C;;;;;;GAMG;AACH,wBAAgB,GAAG,CAAC,QAAQ,EAAE,WAAW,GAAG,IAAI,CAoB/C;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,OAAO,CAAC,IAAI,EAC9B,WAAW,EAAE,gBAAgB,CAAC,IAAI,CAAC,EACnC,eAAe,EAAE,MAAM,GACxB,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CA2C3B"}

package/Distribution/Ora.js

@@ -0,0 +1,75 @@
+/* File:      Ora.ts
+ * Author:    Gage Sorrell <gage@sorrell.sh>
+ * Copyright: (c) 2026 Gage Sorrell
+ * License:   MIT
+ */
+import { Try as TryAsync } from "@sorrell/utilities";
+import ora from "ora";
+/**
+ * Creates and starts an `Ora` instance with the given {@link Argument}.
+ *
+ * @param Argument - The options object.
+ *
+ * @returns An `Ora` instance with the specified options.
+ */
+export function Ora(Argument) {
+    const DefaultOptions = {
+        hideCursor: true
+    };
+    const EnforcedOptions = {
+        spinner: "point"
+    };
+    const Options = {
+        ...DefaultOptions,
+        ...Argument,
+        ...EnforcedOptions
+    };
+    return ora(Options).start();
+}
+/**
+ * @deprecated Use {@link DoTask} instead.
+ *
+ * Executes an `async` function or `Promise` with a progress indicator.
+ *
+ * @typeParam Type - The type of the data to which the given {@link AsyncSource} resolves.
+ *
+ * @param AsyncSource - The `async` function or `Promise` whose state is conveyed
+ * by the returned instance of `Ora`.
+ * @param TaskDescription - The text to display in the `Ora` instance while the
+ * {@link AsyncSource} is pending.
+ *
+ * @returns The result of the {@link AsyncSource}, as a {@link TTryResult}.
+ */
+export async function OraTask(AsyncSource, TaskDescription) {
+    const ThisOra = Ora({ text: TaskDescription });
+    let PersistText = undefined;
+    const SetPersistText = (In) => {
+        PersistText = In;
+    };
+    const OutAsyncSource = typeof AsyncSource === "function"
+        ? (AsyncSource.length > 0)
+            ? () => AsyncSource(SetPersistText)
+            : AsyncSource
+        : AsyncSource;
+    const Result = await TryAsync(OutAsyncSource);
+    if (Result.Error === undefined) {
+        if (PersistText !== undefined) {
+            ThisOra.succeed(PersistText);
+        }
+        else {
+            ThisOra.succeed();
+        }
+    }
+    else {
+        if (PersistText !== undefined) {
+            ThisOra.fail(PersistText);
+            console.error(Result.Error);
+        }
+        else {
+            ThisOra.fail();
+            console.error(Result.Error);
+        }
+    }
+    return Result;
+}
+//# sourceMappingURL=Ora.js.map

package/Distribution/Ora.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Ora.js","sourceRoot":"","sources":["../Source/Ora.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAoC,GAAG,IAAI,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACvF,OAAO,GAAyB,MAAM,KAAK,CAAC;AAE5C;;;;;;GAMG;AACH,MAAM,UAAU,GAAG,CAAC,QAAqB;IAErC,MAAM,cAAc,GAChB;QACI,UAAU,EAAE,IAAI;KACnB,CAAC;IAEN,MAAM,eAAe,GACjB;QACI,OAAO,EAAE,OAAO;KACnB,CAAC;IAEN,MAAM,OAAO,GACT;QACI,GAAG,cAAc;QACjB,GAAG,QAAQ;QACX,GAAG,eAAe;KACrB,CAAC;IAEN,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC;AAChC,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CACzB,WAAmC,EACnC,eAAuB;IAGvB,MAAM,OAAO,GAAS,GAAG,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC,CAAC;IACrD,IAAI,WAAW,GAAuB,SAAS,CAAC;IAEhD,MAAM,cAAc,GAAG,CAAC,EAAU,EAAQ,EAAE;QAExC,WAAW,GAAG,EAAE,CAAC;IACrB,CAAC,CAAC;IAEF,MAAM,cAAc,GAAqB,OAAO,WAAW,KAAK,UAAU;QACtE,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;YACtB,CAAC,CAAC,GAAkB,EAAE,CAAC,WAAW,CAAC,cAAc,CAAC;YAClD,CAAC,CAAE,WAAqC;QAC5C,CAAC,CAAC,WAAW,CAAC;IAElB,MAAM,MAAM,GAAqB,MAAM,QAAQ,CAAC,cAAc,CAAC,CAAC;IAChE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAC9B,CAAC;QACG,IAAI,WAAW,KAAK,SAAS,EAC7B,CAAC;YACG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACjC,CAAC;aAED,CAAC;YACG,OAAO,CAAC,OAAO,EAAE,CAAC;QACtB,CAAC;IACL,CAAC;SAED,CAAC;QACG,IAAI,WAAW,KAAK,SAAS,EAC7B,CAAC;YACG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC1B,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;aAED,CAAC;YACG,OAAO,CAAC,IAAI,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACL,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC"}

package/Distribution/Print/Print.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Print.d.ts","sourceRoot":"","sources":["../../Source/Print/Print.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAgBpD;;;;;;GAMG;AACH,wBAAgB,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAG5C;AAED;;;;;;;;GAQG;AACH,wBAAgB,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAGzC;AAED;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CAClB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,WAAW,GAAG,MAAM,CAY9B"}
+{"version":3,"file":"Print.d.ts","sourceRoot":"","sources":["../../Source/Print/Print.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAgBpD;;;;;;GAMG;AACH,wBAAgB,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAG5C;AAED;;;;;;;;GAQG;AACH,wBAAgB,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAGzC;AAED;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CAClB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,WAAW,GACnB,MAAM,CAYR"}

package/Distribution/Print/Print.js.map

@@ -1 +1 @@
-{"version":3,"file":"Print.js","sourceRoot":"","sources":["../../Source/Print/Print.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD;;;;;;GAMG;AACH,SAAS,UAAU,CAAC,OAAe;IAE/B,OAAO,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,IAAI,CAAC,OAAe;IAEhC,OAAO,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;AAC1C,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,IAAI,CAAC,IAAY;IAE7B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,MAAM,CAClB,OAAe,EACf,KAAkB;IAElB,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAE9B,MAAM,WAAW,GAAsB,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAE/D,KAAK,MAAM,CAAE,KAAK,EAAE,SAAS,CAAE,IAAI,WAAW,EAC9C,CAAC;QACG,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IACnD,CAAC;IAED,OAAO,OAAO,CAAC;AACnB,CAAC"}
+{"version":3,"file":"Print.js","sourceRoot":"","sources":["../../Source/Print/Print.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD;;;;;;GAMG;AACH,SAAS,UAAU,CAAC,OAAe;IAE/B,OAAO,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,IAAI,CAAC,OAAe;IAEhC,OAAO,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;AAC1C,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,IAAI,CAAC,IAAY;IAE7B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,MAAM,CAClB,OAAe,EACf,KAAkB;IAGlB,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAE9B,MAAM,WAAW,GAAsB,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAE/D,KAAK,MAAM,CAAE,KAAK,EAAE,SAAS,CAAE,IAAI,WAAW,EAC9C,CAAC;QACG,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IACnD,CAAC;IAED,OAAO,OAAO,CAAC;AACnB,CAAC"}

package/Distribution/index.d.ts

@@ -3,4 +3,6 @@ export * from "./Confirm.Types.js";
 export * from "./FileSelector.js";
 export * from "./FileSelector.Types.js";
 export * from "./Print/index.js";
+export * from "./Ora.js";
+export * from "./Ora.Types.js";
 //# sourceMappingURL=index.d.ts.map

package/Distribution/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../Source/index.ts"],"names":[],"mappings":"AAMA,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../Source/index.ts"],"names":[],"mappings":"AAMA,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC"}

package/Distribution/index.js

@@ -8,4 +8,6 @@ export * from "./Confirm.Types.js";
 export * from "./FileSelector.js";
 export * from "./FileSelector.Types.js";
 export * from "./Print/index.js";
+export * from "./Ora.js";
+export * from "./Ora.Types.js";
 //# sourceMappingURL=index.js.map

package/Distribution/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../Source/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../Source/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sorrell/cli-utilities",
-  "version": "1.0.23",
+  "version": "1.0.25",
   "description": "Utilities for CLI tools.",
   "keywords": [
     "cli",
@@ -23,6 +23,14 @@
   "license": "MIT",
   "author": "Gage Sorrell <gage@sorrell.sh>",
   "type": "module",
+  "exports": {
+    ".": {
+      "default": "./Distribution/index.js",
+      "import": "./Distribution/index.js",
+      "require": "./Distribution/index.js",
+      "types": "./Distribution/index.d.ts"
+    }
+  },
   "main": "./Distribution/index.js",
   "types": "./Distribution/index.d.ts",
   "scripts": {
@@ -37,6 +45,7 @@
     "@inquirer/prompts": "^8.3.2",
     "@inquirer/type": "^4.0.4",
     "@sorrell/inquirer-file-selector": "^1.0.4",
+    "@sorrell/utilities": "^1.1.11",
     "chalk": "^5.6.2",
     "cli-table3": "^0.6.5",
     "clipboardy": "^5.3.1",