@nlozgachev/pipekit 0.2.0 → 0.3.0

package/esm/src/Core/These.js

@@ -2,23 +2,23 @@ import { Result } from "./Result.js";
 export var These;
 (function (These) {
     /**
-     * Creates a These holding only an error/warning (no success value).
+     * Creates a These holding only a success value (no error).
      *
      * @example
      * ```ts
-     * These.err("Something went wrong");
+     * These.ok(42);
      * ```
      */
-    These.err = (error) => Result.err(error);
+    These.ok = (value) => Result.ok(value);
     /**
-     * Creates a These holding only a success value (no error).
+     * Creates a These holding only an error/warning (no success value).
      *
      * @example
      * ```ts
-     * These.ok(42);
+     * These.err("Something went wrong");
      * ```
      */
-    These.ok = (value) => Result.ok(value);
+    These.err = (error) => Result.err(error);
     /**
      * Creates a These holding both an error/warning and a success value.
      *

package/esm/src/Core/Validation.js

@@ -6,56 +6,55 @@ export var Validation;
      *
      * @example
      * ```ts
-     * Validation.of(42); // Valid(42)
+     * Validation.valid(42); // Valid(42)
      * ```
      */
-    Validation.of = (value) => ({
+    Validation.valid = (value) => ({
         kind: "Valid",
         value,
     });
     /**
-     * Creates a valid Validation with the given value.
-     */
-    Validation.toValid = (value) => ({ kind: "Valid", value });
-    /**
-     * Type guard that checks if a Validation is valid.
+     * Creates an invalid Validation from a single error.
+     *
+     * @example
+     * ```ts
+     * Validation.invalid("Invalid input");
+     * ```
      */
-    Validation.isValid = (data) => data.kind === "Valid";
+    Validation.invalid = (error) => ({
+        kind: "Invalid",
+        errors: [error],
+    });
     /**
-     * Creates an invalid Validation with the given errors.
+     * Creates an invalid Validation from multiple errors.
      *
      * @example
      * ```ts
-     * Validation.toInvalid(["Email is invalid", "Password too short"]);
+     * Validation.invalidAll(["Invalid input"]);
      * ```
      */
-    Validation.toInvalid = (errors) => ({
+    Validation.invalidAll = (errors) => ({
         kind: "Invalid",
         errors,
     });
     /**
-     * Type guard that checks if a Validation is invalid.
+     * Type guard that checks if a Validation is valid.
      */
-    Validation.isInvalid = (data) => data.kind === "Invalid";
+    Validation.isValid = (data) => data.kind === "Valid";
     /**
-     * Creates an invalid Validation from a single error.
-     *
-     * @example
-     * ```ts
-     * Validation.fail("Invalid input");
-     * ```
+     * Type guard that checks if a Validation is invalid.
      */
-    Validation.fail = (error) => Validation.toInvalid([error]);
+    Validation.isInvalid = (data) => data.kind === "Invalid";
     /**
      * Transforms the success value inside a Validation.
      *
      * @example
      * ```ts
-     * pipe(Validation.of(5), Validation.map(n => n * 2)); // Valid(10)
-     * pipe(Validation.fail("oops"), Validation.map(n => n * 2)); // Invalid(["oops"])
+     * pipe(Validation.valid(5), Validation.map(n => n * 2)); // Valid(10)
+     * pipe(Validation.invalid("oops"), Validation.map(n => n * 2)); // Invalid(["oops"])
      * ```
      */
-    Validation.map = (f) => (data) => Validation.isValid(data) ? Validation.of(f(data.value)) : data;
+    Validation.map = (f) => (data) => Validation.isValid(data) ? Validation.valid(f(data.value)) : data;
     /**
      * Chains Validation computations. If the first is Valid, passes the value to f.
      * If the first is Invalid, propagates the errors.
@@ -65,10 +64,10 @@ export var Validation;
      * @example
      * ```ts
      * const validatePositive = (n: number): Validation<string, number> =>
-     *   n > 0 ? Validation.of(n) : Validation.fail("Must be positive");
+     *   n > 0 ? Validation.valid(n) : Validation.invalid("Must be positive");
      *
-     * pipe(Validation.of(5), Validation.chain(validatePositive)); // Valid(5)
-     * pipe(Validation.of(-1), Validation.chain(validatePositive)); // Invalid(["Must be positive"])
+     * pipe(Validation.valid(5), Validation.chain(validatePositive)); // Valid(5)
+     * pipe(Validation.valid(-1), Validation.chain(validatePositive)); // Invalid(["Must be positive"])
      * ```
      */
     Validation.chain = (f) => (data) => Validation.isValid(data) ? f(data.value) : data;
@@ -80,26 +79,26 @@ export var Validation;
      * ```ts
      * const add = (a: number) => (b: number) => a + b;
      * pipe(
-     *   Validation.of(add),
-     *   Validation.ap(Validation.of(5)),
-     *   Validation.ap(Validation.of(3))
+     *   Validation.valid(add),
+     *   Validation.ap(Validation.valid(5)),
+     *   Validation.ap(Validation.valid(3))
      * ); // Valid(8)
      *
      * pipe(
-     *   Validation.of(add),
-     *   Validation.ap(Validation.fail<string, number>("bad a")),
-     *   Validation.ap(Validation.fail<string, number>("bad b"))
+     *   Validation.valid(add),
+     *   Validation.ap(Validation.invalid<string, number>("bad a")),
+     *   Validation.ap(Validation.invalid<string, number>("bad b"))
      * ); // Invalid(["bad a", "bad b"])
      * ```
      */
     Validation.ap = (arg) => (data) => {
         if (Validation.isValid(data) && Validation.isValid(arg))
-            return Validation.of(data.value(arg.value));
+            return Validation.valid(data.value(arg.value));
         const errors = [
             ...(Validation.isInvalid(data) ? data.errors : []),
             ...(Validation.isInvalid(arg) ? arg.errors : []),
         ];
-        return isNonEmptyList(errors) ? Validation.toInvalid(errors) : Validation.of(data);
+        return isNonEmptyList(errors) ? Validation.invalidAll(errors) : Validation.valid(data);
     };
     /**
      * Extracts the value from a Validation by providing handlers for both cases.
@@ -107,7 +106,7 @@ export var Validation;
      * @example
      * ```ts
      * pipe(
-     *   Validation.of(42),
+     *   Validation.valid(42),
      *   Validation.fold(
      *     errors => `Errors: ${errors.join(", ")}`,
      *     value => `Value: ${value}`
@@ -136,8 +135,8 @@ export var Validation;
      *
      * @example
      * ```ts
-     * pipe(Validation.of(5), Validation.getOrElse(0)); // 5
-     * pipe(Validation.fail("oops"), Validation.getOrElse(0)); // 0
+     * pipe(Validation.valid(5), Validation.getOrElse(0)); // 5
+     * pipe(Validation.invalid("oops"), Validation.getOrElse(0)); // 0
      * ```
      */
     Validation.getOrElse = (defaultValue) => (data) => Validation.isValid(data) ? data.value : defaultValue;
@@ -147,7 +146,7 @@ export var Validation;
      * @example
      * ```ts
      * pipe(
-     *   Validation.of(5),
+     *   Validation.valid(5),
      *   Validation.tap(n => console.log("Value:", n)),
      *   Validation.map(n => n * 2)
      * );
@@ -177,13 +176,13 @@ export var Validation;
      * @example
      * ```ts
      * Validation.combine(
-     *   Validation.fail("Error 1"),
-     *   Validation.fail("Error 2")
+     *   Validation.invalid("Error 1"),
+     *   Validation.invalid("Error 2")
      * ); // Invalid(["Error 1", "Error 2"])
      *
      * Validation.combine(
-     *   Validation.of("a"),
-     *   Validation.of("b")
+     *   Validation.valid("a"),
+     *   Validation.valid("b")
      * ); // Valid("b")
      * ```
      */
@@ -195,7 +194,7 @@ export var Validation;
             ...(Validation.isInvalid(first) ? first.errors : []),
             ...(Validation.isInvalid(second) ? second.errors : []),
         ];
-        return isNonEmptyList(errors) ? Validation.toInvalid(errors) : second;
+        return isNonEmptyList(errors) ? Validation.invalidAll(errors) : second;
     };
     /**
      * Combines multiple Validation instances, accumulating all errors.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nlozgachev/pipekit",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Simple functional programming toolkit for TypeScript",
   "keywords": [
     "functional",

package/script/src/Composition/flip.js

@@ -9,13 +9,13 @@ exports.flip = void 0;
  * ```ts
  * // Original data-last (for pipe)
  * pipe(
- *   Option.of(5),
+ *   Option.some(5),
  *   Option.map(n => n * 2)
  * ); // Some(10)
  *
  * // Flipped to data-first
  * const mapFirst = flip(Option.map);
- * mapFirst(Option.of(5))(n => n * 2); // Some(10)
+ * mapFirst(Option.some(5))(n => n * 2); // Some(10)
  * ```
  *
  * @see {@link uncurry} for converting curried functions to multi-argument functions

package/script/src/Composition/fn.js

@@ -7,7 +7,7 @@ exports.once = exports.or = exports.and = exports.constVoid = exports.constUndef
  * @example
  * ```ts
  * identity(42); // 42
- * pipe(Option.of(5), Option.fold(() => 0, identity)); // 5
+ * pipe(Option.some(5), Option.fold(() => 0, identity)); // 5
  * ```
  */
 const identity = (a) => a;

package/script/src/Composition/tap.js

@@ -9,7 +9,7 @@ exports.tap = void 0;
  * ```ts
  * // Debugging a pipeline
  * pipe(
- *   Option.of(5),
+ *   Option.some(5),
  *   tap(x => console.log("Before map:", x)),
  *   Option.map(n => n * 2),
  *   tap(x => console.log("After map:", x)),

package/script/src/Core/Arr.js

@@ -306,7 +306,7 @@ var Arr;
      * ```ts
      * const parseNum = (s: string): Option<number> => {
      *   const n = Number(s);
-     *   return isNaN(n) ? Option.none() : Option.of(n);
+     *   return isNaN(n) ? Option.none() : Option.some(n);
      * };
      *
      * pipe(["1", "2", "3"], Arr.traverse(parseNum)); // Some([1, 2, 3])
@@ -352,7 +352,7 @@ var Arr;
      * ```ts
      * pipe(
      *   [1, 2, 3],
-     *   Arr.traverseTask(n => Task.of(n * 2))
+     *   Arr.traverseTask(n => Task.resolve(n * 2))
      * )(); // Promise<[2, 4, 6]>
      * ```
      */
@@ -363,8 +363,8 @@ var Arr;
      *
      * @example
      * ```ts
-     * Arr.sequence([Option.of(1), Option.of(2)]); // Some([1, 2])
-     * Arr.sequence([Option.of(1), Option.none()]); // None
+     * Arr.sequence([Option.some(1), Option.some(2)]); // Some([1, 2])
+     * Arr.sequence([Option.some(1), Option.none()]); // None
      * ```
      */
     Arr.sequence = (data) => Arr.traverse((a) => a)(data);

package/script/src/Core/Option.js

@@ -4,15 +4,6 @@ exports.Option = void 0;
 const Result_js_1 = require("./Result.js");
 var Option;
 (function (Option) {
-    /**
-     * Wraps a value in a Some.
-     *
-     * @example
-     * ```ts
-     * Option.of(42); // Some(42)
-     * ```
-     */
-    Option.of = (value) => Option.some(value);
     /**
      * Creates a Some containing the given value.
      */
@@ -60,7 +51,7 @@ var Option;
      * @example
      * ```ts
      * pipe(
-     *   Option.of(42),
+     *   Option.some(42),
      *   Option.toResult(() => "Value was missing")
      * ); // Ok(42)
      *
@@ -87,7 +78,7 @@ var Option;
      *
      * @example
      * ```ts
-     * pipe(Option.of(5), Option.map(n => n * 2)); // Some(10)
+     * pipe(Option.some(5), Option.map(n => n * 2)); // Some(10)
      * pipe(Option.none(), Option.map(n => n * 2)); // None
      * ```
      */
@@ -100,11 +91,11 @@ var Option;
      * ```ts
      * const parseNumber = (s: string): Option<number> => {
      *   const n = parseInt(s, 10);
-     *   return isNaN(n) ? Option.none() : Option.of(n);
+     *   return isNaN(n) ? Option.none() : Option.some(n);
      * };
      *
-     * pipe(Option.of("42"), Option.chain(parseNumber)); // Some(42)
-     * pipe(Option.of("abc"), Option.chain(parseNumber)); // None
+     * pipe(Option.some("42"), Option.chain(parseNumber)); // Some(42)
+     * pipe(Option.some("abc"), Option.chain(parseNumber)); // None
      * ```
      */
     Option.chain = (f) => (data) => Option.isSome(data) ? f(data.value) : data;
@@ -114,7 +105,7 @@ var Option;
      * @example
      * ```ts
      * pipe(
-     *   Option.of(5),
+     *   Option.some(5),
      *   Option.fold(
      *     () => "No value",
      *     n => `Value: ${n}`
@@ -143,7 +134,7 @@ var Option;
      *
      * @example
      * ```ts
-     * pipe(Option.of(5), Option.getOrElse(0)); // 5
+     * pipe(Option.some(5), Option.getOrElse(0)); // 5
      * pipe(Option.none(), Option.getOrElse(0)); // 0
      * ```
      */
@@ -155,7 +146,7 @@ var Option;
      * @example
      * ```ts
      * pipe(
-     *   Option.of(5),
+     *   Option.some(5),
      *   Option.tap(n => console.log("Value:", n)),
      *   Option.map(n => n * 2)
      * );
@@ -172,8 +163,8 @@ var Option;
      *
      * @example
      * ```ts
-     * pipe(Option.of(5), Option.filter(n => n > 3)); // Some(5)
-     * pipe(Option.of(2), Option.filter(n => n > 3)); // None
+     * pipe(Option.some(5), Option.filter(n => n > 3)); // Some(5)
+     * pipe(Option.some(2), Option.filter(n => n > 3)); // None
      * ```
      */
     Option.filter = (predicate) => (data) => Option.isSome(data) && predicate(data.value) ? data : Option.none();
@@ -188,9 +179,9 @@ var Option;
      * ```ts
      * const add = (a: number) => (b: number) => a + b;
      * pipe(
-     *   Option.of(add),
-     *   Option.ap(Option.of(5)),
-     *   Option.ap(Option.of(3))
+     *   Option.some(add),
+     *   Option.ap(Option.some(5)),
+     *   Option.ap(Option.some(3))
      * ); // Some(8)
      * ```
      */

package/script/src/Core/RemoteData.js

@@ -25,10 +25,6 @@ var RemoteData;
         kind: "Success",
         value,
     });
-    /**
-     * Wraps a value in a Success RemoteData. Alias for `success`.
-     */
-    RemoteData.of = RemoteData.success;
     /**
      * Type guard that checks if a RemoteData is NotAsked.
      */
@@ -50,7 +46,7 @@ var RemoteData;
      *
      * @example
      * ```ts
-     * pipe(RemoteData.of(5), RemoteData.map(n => n * 2)); // Success(10)
+     * pipe(RemoteData.success(5), RemoteData.map(n => n * 2)); // Success(10)
      * pipe(RemoteData.loading(), RemoteData.map(n => n * 2)); // Loading
      * ```
      */
@@ -71,8 +67,8 @@ var RemoteData;
      * @example
      * ```ts
      * pipe(
-     *   RemoteData.of(5),
-     *   RemoteData.chain(n => n > 0 ? RemoteData.of(n) : RemoteData.failure("negative"))
+     *   RemoteData.success(5),
+     *   RemoteData.chain(n => n > 0 ? RemoteData.success(n) : RemoteData.failure("negative"))
      * );
      * ```
      */
@@ -84,9 +80,9 @@ var RemoteData;
      * ```ts
      * const add = (a: number) => (b: number) => a + b;
      * pipe(
-     *   RemoteData.of(add),
-     *   RemoteData.ap(RemoteData.of(5)),
-     *   RemoteData.ap(RemoteData.of(3))
+     *   RemoteData.success(add),
+     *   RemoteData.ap(RemoteData.success(5)),
+     *   RemoteData.ap(RemoteData.success(3))
      * ); // Success(8)
      * ```
      */
@@ -163,7 +159,7 @@ var RemoteData;
      *
      * @example
      * ```ts
-     * pipe(RemoteData.of(5), RemoteData.getOrElse(0)); // 5
+     * pipe(RemoteData.success(5), RemoteData.getOrElse(0)); // 5
      * pipe(RemoteData.loading(), RemoteData.getOrElse(0)); // 0
      * ```
      */
@@ -174,7 +170,7 @@ var RemoteData;
      * @example
      * ```ts
      * pipe(
-     *   RemoteData.of(5),
+     *   RemoteData.success(5),
      *   RemoteData.tap(n => console.log("Value:", n)),
      *   RemoteData.map(n => n * 2)
      * );
@@ -202,7 +198,7 @@ var RemoteData;
      * @example
      * ```ts
      * pipe(
-     *   RemoteData.of(42),
+     *   RemoteData.success(42),
      *   RemoteData.toResult(() => "not loaded")
      * ); // Ok(42)
      * ```

package/script/src/Core/Result.js

@@ -4,22 +4,13 @@ exports.Result = void 0;
 var Result;
 (function (Result) {
     /**
-     * Wraps a value in a successful Result (Ok).
-     *
-     * @example
-     * ```ts
-     * Result.of(42); // Ok(42)
-     * ```
+     * Creates a successful Result with the given value.
      */
-    Result.of = (value) => Result.ok(value);
+    Result.ok = (value) => ({ kind: "Ok", value });
     /**
      * Creates a failed Result with the given error.
      */
     Result.err = (error) => ({ kind: "Error", error });
-    /**
-     * Creates a successful Result with the given value.
-     */
-    Result.ok = (value) => ({ kind: "Ok", value });
     /**
      * Type guard that checks if an Result is Ok.
      */
@@ -54,7 +45,7 @@ var Result;
      *
      * @example
      * ```ts
-     * pipe(Result.of(5), Result.map(n => n * 2)); // Ok(10)
+     * pipe(Result.ok(5), Result.map(n => n * 2)); // Ok(10)
      * pipe(Result.err("error"), Result.map(n => n * 2)); // Err("error")
      * ```
      */
@@ -75,10 +66,10 @@ var Result;
      * @example
      * ```ts
      * const validatePositive = (n: number): Result<string, number> =>
-     *   n > 0 ? Result.of(n) : Result.err("Must be positive");
+     *   n > 0 ? Result.ok(n) : Result.err("Must be positive");
      *
-     * pipe(Result.of(5), Result.chain(validatePositive)); // Ok(5)
-     * pipe(Result.of(-1), Result.chain(validatePositive)); // Err("Must be positive")
+     * pipe(Result.ok(5), Result.chain(validatePositive)); // Ok(5)
+     * pipe(Result.ok(-1), Result.chain(validatePositive)); // Err("Must be positive")
      * ```
      */
     Result.chain = (f) => (data) => Result.isOk(data) ? f(data.value) : data;
@@ -88,7 +79,7 @@ var Result;
      * @example
      * ```ts
      * pipe(
-     *   Result.of(5),
+     *   Result.ok(5),
      *   Result.fold(
      *     e => `Error: ${e}`,
      *     n => `Value: ${n}`
@@ -117,7 +108,7 @@ var Result;
      *
      * @example
      * ```ts
-     * pipe(Result.of(5), Result.getOrElse(0)); // 5
+     * pipe(Result.ok(5), Result.getOrElse(0)); // 5
      * pipe(Result.err("error"), Result.getOrElse(0)); // 0
      * ```
      */
@@ -129,7 +120,7 @@ var Result;
      * @example
      * ```ts
      * pipe(
-     *   Result.of(5),
+     *   Result.ok(5),
      *   Result.tap(n => console.log("Value:", n)),
      *   Result.map(n => n * 2)
      * );
@@ -166,9 +157,9 @@ var Result;
      * ```ts
      * const add = (a: number) => (b: number) => a + b;
      * pipe(
-     *   Result.of(add),
-     *   Result.ap(Result.of(5)),
-     *   Result.ap(Result.of(3))
+     *   Result.ok(add),
+     *   Result.ap(Result.ok(5)),
+     *   Result.ap(Result.ok(3))
      * ); // Ok(8)
      * ```
      */

package/script/src/Core/Task.js

@@ -5,22 +5,22 @@ const Result_js_1 = require("./Result.js");
 var Task;
 (function (Task) {
     /**
-     * Wraps a value in a Task that immediately resolves to that value.
+     * Creates a Task that immediately resolves to the given value.
      *
      * @example
      * ```ts
-     * const task = Task.of(42);
+     * const task = Task.resolve(42);
      * task().then(console.log); // 42
      * ```
      */
-    Task.of = (value) => () => Promise.resolve(value);
+    Task.resolve = (value) => () => Promise.resolve(value);
     /**
      * Creates a Task from a function that returns a Promise.
      * Alias for directly creating a Task.
      *
      * @example
      * ```ts
-     * const fetchUser = Task.from(() => fetch('/user').then(r => r.json()));
+     * const getTimestamp = Task.from(() => Promise.resolve(Date.now()));
      * ```
      */
     Task.from = (f) => f;
@@ -30,7 +30,7 @@ var Task;
      * @example
      * ```ts
      * pipe(
-     *   Task.of(5),
+     *   Task.resolve(5),
      *   Task.map(n => n * 2)
      * )(); // Promise<10>
      * ```
@@ -41,13 +41,13 @@ var Task;
      *
      * @example
      * ```ts
-     * const fetchUser = (id: string): Task<User> => () => fetch(`/users/${id}`).then(r => r.json());
-     * const fetchPosts = (user: User): Task<Post[]> => () => fetch(`/posts?userId=${user.id}`).then(r => r.json());
+     * const readUserId: Task<string> = () => Promise.resolve(session.userId);
+     * const loadPrefs = (id: string): Task<Preferences> => () => Promise.resolve(prefsCache.get(id));
      *
      * pipe(
-     *   fetchUser("123"),
-     *   Task.chain(fetchPosts)
-     * )(); // Promise<Post[]>
+     *   readUserId,
+     *   Task.chain(loadPrefs)
+     * )(); // Promise<Preferences>
      * ```
      */
     Task.chain = (f) => (data) => () => data().then((a) => f(a)());
@@ -59,9 +59,9 @@ var Task;
      * ```ts
      * const add = (a: number) => (b: number) => a + b;
      * pipe(
-     *   Task.of(add),
-     *   Task.ap(Task.of(5)),
-     *   Task.ap(Task.of(3))
+     *   Task.resolve(add),
+     *   Task.ap(Task.resolve(5)),
+     *   Task.ap(Task.resolve(3))
      * )(); // Promise<8>
      * ```
      */
@@ -73,9 +73,9 @@ var Task;
      * @example
      * ```ts
      * pipe(
-     *   fetchData,
-     *   Task.tap(data => console.log("Fetched:", data)),
-     *   Task.map(transform)
+     *   loadConfig,
+     *   Task.tap(cfg => console.log("Config:", cfg)),
+     *   Task.map(buildReport)
      * );
      * ```
      */
@@ -88,8 +88,8 @@ var Task;
      *
      * @example
      * ```ts
-     * Task.all([fetchUser, fetchPosts, fetchComments])();
-     * // Promise<[User, Post[], Comment[]]>
+     * Task.all([loadConfig, detectLocale, loadTheme])();
+     * // Promise<[Config, string, Theme]>
      * ```
      */
     Task.all = (tasks) => () => Promise.all(tasks.map((t) => t()));
@@ -100,7 +100,7 @@ var Task;
      * @example
      * ```ts
      * pipe(
-     *   Task.of(42),
+     *   Task.resolve(42),
      *   Task.delay(1000)
      * )(); // Resolves after 1 second
      * ```
@@ -161,16 +161,19 @@ var Task;
      * @example
      * ```ts
      * pipe(
-     *   fetchUser,
-     *   Task.timeout(5000, () => new TimeoutError("fetch user timed out")),
-     *   TaskResult.chain(processUser)
+     *   heavyComputation,
+     *   Task.timeout(5000, () => "timed out"),
+     *   TaskResult.chain(processResult)
      * );
      * ```
      */
     Task.timeout = (ms, onTimeout) => (task) => () => {
         let timerId;
         return Promise.race([
-            task().then((a) => { clearTimeout(timerId); return Result_js_1.Result.ok(a); }),
+            task().then((a) => {
+                clearTimeout(timerId);
+                return Result_js_1.Result.ok(a);
+            }),
             new Promise((resolve) => {
                 timerId = setTimeout(() => resolve(Result_js_1.Result.err(onTimeout())), ms);
             }),