fnts 2.1.0 → 2.2.0

package/get.d.ts

@@ -1,25 +1,19 @@
 /**
  * @module Get
  */
-/**
- * Recursively flattens object type to a union of its keys
- * combined through dot-notation.
- */
-export type Flatten<Source extends Record<string, unknown> | any[]> = keyof Source extends keyof any[] ? `${number}` : (keyof Source | keyof {
-    [Key in keyof Source as Key extends string ? Source[Key] extends Record<string, unknown> ? `${Key}.${Flatten<Source[Key]>}` : Source[Key] extends any[] ? Source[Key] extends Array<any[]> | Record<string, unknown>[] ? `${Key}.${number}` | `${Key}.${number}.${Flatten<Source[Key][number]>}` : `${Key}.${number}` : Key : never]: never;
-});
+import type { Flatten, Flattenable } from './types/flatten';
 /**
  * Gets the value type inside a nested object type `Source` by provided `Path`
  * written in dot-notation.
  */
-export type Get<Source, Path extends string> = Source extends Record<string, unknown> ? Path extends `${infer Index extends number}.${infer Right}` ? Get<Source, Right> : Path extends `${infer Left extends keyof Source}.${infer Right}` ? Get<Exclude<Source[Left], undefined>, Right> | Extract<Source[Left], undefined> : Path extends keyof Source ? Source[Path] : never : Source extends any[] ? Path extends `${infer Left extends number}.${infer Right}` ? Get<Exclude<Source[Left], undefined>, Right> | Extract<Source[Left], undefined> : Path extends `${infer Index extends number}` ? Source[Index] : never : never;
+export type Get<Source extends Flattenable, Path extends string> = Source extends Record<string, unknown> ? Path extends `${number}.${infer Right}` ? Get<Source, Right> : Path extends `${infer Left extends keyof Source}.${infer Right}` ? Get<Exclude<Source[Left], undefined>, Right> | Extract<Source[Left], undefined> : Path extends keyof Source ? Source[Path] : never : Source extends any[] ? Path extends `${infer Left extends number}.${infer Right}` ? Get<Exclude<Source[Left], undefined>, Right> | Extract<Source[Left], undefined> : Path extends `${infer Index extends number}` ? Source[Index] : never : never;
 /**
  * Gets the value inside a nested `source` object by provided `path`
  * written in dot-notation.
  */
-export default function get<Source extends Record<string, unknown> | any[], Path extends Flatten<Source>>(path: Path): (source: Source) => Get<Source, Path>;
+export default function get<Source extends Flattenable, Path extends Flatten<Source>>(path: Path): (source: Source) => Get<Source, Path>;
 /**
  * Gets the value inside a nested `source` object by provided `path`
  * written in dot-notation.
  */
-export default function get<Source extends Record<string, unknown> | any[], Path extends Flatten<Source>>(source: Source, path: Path): Get<Source, Path>;
+export default function get<Source extends Flattenable, Path extends Flatten<Source>>(source: Source, path: Path): Get<Source, Path>;

package/index.d.ts

@@ -1,9 +1,10 @@
 export { default as get } from './get';
+export { default as set } from './set';
 export { default as tap } from './tap';
 export { default as pipe } from './pipe';
 export { default as apply } from './apply';
 export { default as curry } from './curry';
-export { default as match } from './guard';
+export { default as guard } from './guard';
 export { default as inject } from './inject';
 export { default as compose } from './compose';
 export { default as rethrow } from './rethrow';

package/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.identity = exports.rethrow = exports.compose = exports.inject = exports.match = exports.curry = exports.apply = exports.pipe = exports.tap = exports.get = void 0;
+exports.identity = exports.rethrow = exports.compose = exports.inject = exports.guard = exports.curry = exports.apply = exports.pipe = exports.tap = exports.set = exports.get = void 0;
 var get_1 = require("./get");
 Object.defineProperty(exports, "get", { enumerable: true, get: function () { return get_1.default; } });
+var set_1 = require("./set");
+Object.defineProperty(exports, "set", { enumerable: true, get: function () { return set_1.default; } });
 var tap_1 = require("./tap");
 Object.defineProperty(exports, "tap", { enumerable: true, get: function () { return tap_1.default; } });
 var pipe_1 = require("./pipe");
@@ -12,7 +14,7 @@ Object.defineProperty(exports, "apply", { enumerable: true, get: function () { r
 var curry_1 = require("./curry");
 Object.defineProperty(exports, "curry", { enumerable: true, get: function () { return curry_1.default; } });
 var guard_1 = require("./guard");
-Object.defineProperty(exports, "match", { enumerable: true, get: function () { return guard_1.default; } });
+Object.defineProperty(exports, "guard", { enumerable: true, get: function () { return guard_1.default; } });
 var inject_1 = require("./inject");
 Object.defineProperty(exports, "inject", { enumerable: true, get: function () { return inject_1.default; } });
 var compose_1 = require("./compose");

package/maybe/operators/fold-map.js

@@ -5,8 +5,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 var compose_1 = require("../../compose");
 var permutation_2_1 = require("../../permutation/permutation-2");
-var guards_1 = require("./guards");
 var fold_1 = require("./fold");
+var guards_1 = require("./guards");
 function foldMap() {
     var args = [];
     for (var _i = 0; _i < arguments.length; _i++) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fnts",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "license": "MIT",
   "author": "Dmytro Vasylkivskyi",
   "description": "TypeScript / JavaScript FP utilities",

package/set.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @module Set
+ */
+import type { Unshift } from './types/unshift';
+import type { Flatten, Flattenable } from './types/flatten';
+/**
+ * Sets the `Value` type inside a nested object type `Source` by provided `Path`
+ * written in dot-notation.
+ */
+export type Set<Source extends Flattenable, Path extends string, Value> = Source extends Record<string, unknown> ? Path extends `${number}.${infer Right}` ? Set<Source, Right, Value> : Path extends `${infer Left extends keyof Source}.${infer Right}` ? {
+    [Key in keyof Source]: Key extends Exclude<keyof Source, Left> ? Source[Key] : Set<Exclude<Source[Left], undefined>, Right, Value>;
+} : Path extends keyof Source ? {
+    [Key in keyof Source]: Key extends Exclude<keyof Source, Path> ? Source[Key] : Value;
+} : never : Source extends any[] ? Path extends `${infer Index extends number}.${infer Right}` ? Unshift<Source, Index, Set<Exclude<Source[Index], undefined>, Right, Value>> : Path extends `${infer Index extends number}` ? Unshift<Source, Index, Value> : never : never;
+/**
+ * Sets the `value` inside a nested `source` object by provided `path`
+ * written in dot-notation.
+ */
+export default function set<Source extends Flattenable, Path extends Flatten<Source>, Value>(path: Path, value: Value): (source: Source) => Set<Source, Path, Value>;
+/**
+ * Sets the `value` inside a nested `source` object by provided `path`
+ * written in dot-notation.
+ */
+export default function set<Source extends Flattenable, Path extends Flatten<Source>, Value>(source: Source, path: Path, value: Value): Set<Source, Path, Value>;

package/set.js

@@ -0,0 +1,42 @@
+"use strict";
+/**
+ * @module Set
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+var permutation_3_1 = require("./permutation/permutation-3");
+/**
+ * Sets the `value` inside a nested `source` object by provided `path`
+ * written in dot-notation.
+ */
+function set() {
+    var args = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        args[_i] = arguments[_i];
+    }
+    // @ts-ignore
+    return (0, permutation_3_1.default)(
+    // @ts-ignore
+    function (source, path, value
+    // @ts-ignore
+    ) {
+        // @ts-ignore
+        var keys = path.split('.');
+        var length = keys.length;
+        var result = structuredClone(source);
+        if (length === 0) {
+            result[path] = value;
+        }
+        var scope = result[keys[0]];
+        for (var index = 1; index < length; index += 1) {
+            if (index === length - 1) {
+                scope[keys === null || keys === void 0 ? void 0 : keys[index]] = value;
+            }
+            else {
+                scope = scope === null || scope === void 0 ? void 0 : scope[keys === null || keys === void 0 ? void 0 : keys[index]];
+            }
+        }
+        // @ts-ignore
+        return result;
+    }).apply(void 0, args);
+}
+exports.default = set;

package/tsconfig.json

@@ -5,7 +5,8 @@
     "moduleResolution": "node",
     "lib": [
       "es2015.iterable",
-      "es2019"
+      "es2019",
+      "dom"
     ],
     "strict": true,
     "alwaysStrict": true,

package/types/effect.d.ts

@@ -2,7 +2,7 @@
  * @module Types
  */
 
-import type { VariadicFunction } from './function';
+import type { VariadicFunction } from './function'
 
 /**
  * A simple side effect function descriptor.

package/types/flatten.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @module Types
+ */
+
+/**
+ * Type subjective to flattening.
+ */
+export type Flattenable = Record<string, unknown> | any[]
+
+/**
+ * Recursively flattens object type to a union of its keys
+ * combined through dot-notation.
+ */
+export type Flatten<
+  Source extends Record<string, unknown> | any[],
+> = keyof Source extends keyof any[]
+  ? `${number}`
+  : (
+    | keyof Source
+    | keyof {
+      [
+        Key in keyof Source as
+          Key extends string
+            ? Source[Key] extends Record<string, unknown>
+              ? `${Key}.${Flatten<Source[Key]>}`
+              : Source[Key] extends any[]
+                ? Source[Key] extends Array<any[]> | Record<string, unknown>[]
+                    ? `${Key}.${number}` | `${Key}.${number}.${Flatten<Source[Key][number]>}`
+                    : `${Key}.${number}`
+                : Key
+            : never
+      ] : never
+    }
+  )

package/types/index.d.ts

@@ -1,7 +1,10 @@
-export type { Map } from './map';
-export type { Last } from './last';
-export type { Slice } from './slice';
-export type { Tuple } from './tuple';
-export type { Effect } from './effect';
-export type { Gradual } from './gradual';
-export type { UnaryFunction, VariadicFunction } from './function';
+export type { Map } from './map'
+export type { Last } from './last'
+export type { Trim } from './trim'
+export type { Slice } from './slice'
+export type { Tuple } from './tuple'
+export type { Effect } from './effect'
+export type { Gradual } from './gradual'
+export type { Unshift } from './unshift'
+export type { Flatten } from './flatten'
+export type { UnaryFunction, VariadicFunction } from './function'

package/types/slice.d.ts

@@ -5,7 +5,7 @@
 import type { Tuple } from './tuple'
 
 /**
- * Slices the tuple by `C` amount of entries from the **end**.
+ * Removes `C` amount of `T` elements from the **start**.
  */
 export type Slice<
   T extends any[] | readonly any[],

package/types/trim.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @module Types
+ */
+
+import { Tuple } from './tuple'
+
+/**
+ * Removes `C` amount of `T` elements from the **end**.
+ */
+export type Trim<
+  T extends any[] | readonly any[],
+  C extends number
+> = T['length'] extends C
+  ? T
+  : T extends readonly [...infer S, ...Tuple<C>]
+    ? S
+    : T extends [...infer S, ...Tuple<C>]
+      ? S
+      : T

package/types/unshift.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @module Types
+ */
+
+import { Trim } from './trim'
+import { Slice } from './slice'
+
+/**
+ * Replaces `T` element on specified index `I` with `E`.
+ */
+export type Unshift<T extends any[] | readonly any[], I extends number, E> =
+  I extends 0
+    ? [E, ...Slice<T, 1>]
+    : I extends Trim<T, 1>['length']
+      ? [...Trim<T, 1>, E]
+      : [...Trim<T, Slice<T, I>['length']>, E, ...Slice<Slice<T, I>, 1>]