@sorrell/utilities 1.2.5 → 1.2.6

package/Distribution/npm.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../Source/Npm/Npm.ts", "../Source/Npm/Npm.Error.ts"],
+  "sourcesContent": ["/**\n * @file      Npm.ts\n * @author    Gage Sorrell <gage@sorrell.sh>\n * @copyright (c) 2026 Gage Sorrell\n * @license   MIT\n */\nimport { promises as Fs, constants as FsConstants } from \"fs\";\nimport { PackageJsonParseError, RootDirectoryNotFoundError } from \"./Npm.Error.ts\";\nimport { dirname, join } from \"path\";\nimport type { IPackageJson } from \"package-json-type\";\nimport Process from \"process\";\n/**\n * Get the `package.json` of the Node.js project in which the\n * given path, or the current working directory, resides.\n *\n * @param Path - The given path from which to look for a root directory.\n *\n * @throws {RootDirectoryNotFoundError | PackageJsonParseError} An error\n * describing either failure to identify a root directory, or failing to\n * parse the discovered `package.json`.\n *\n * @returns {Promise<IPackageJson>} The {@link IPackageJson} of {@link Path}\n * if provided, otherwise of `process.cwd()`.\n *\n * @example\n * Suppose `process.cwd() === \"./MyPackage\"`,\n * ```typescript\n * const PackageJson: IPackageJson = await GetPackageJson();\n * // `PackageJson` <- *The parsed `package.json` of `MyPackage`.*\n * ```\n */\nexport async function GetPackageJson(Path?: string): Promise<IPackageJson> {\n    const RootDirectory: string = await GetPackageRootDirectory(Path);\n    const PackageJsonPath: string = join(RootDirectory, \"package.json\");\n    const FileContents: string = await Fs.readFile(PackageJsonPath, \"utf-8\");\n    const PackageJson: IPackageJson = await (async (): Promise<IPackageJson> => {\n        try {\n            return JSON.parse(FileContents) as IPackageJson;\n        }\n        catch (Cause: unknown) {\n            throw new PackageJsonParseError({ Cause, Path: PackageJsonPath });\n        }\n    })();\n    return PackageJson;\n}\n/**\n * Get the root directory of the Node.js project in which the\n * current working directory resides.\n *\n * @param Path - The given path from which to look for a root directory.\n *\n * @throws {RootDirectoryNotFoundError} An error iff the root directory\n * of a NodeJS package could not be found.\n *\n * @returns {Promise<string>} The path to the root directory of the package\n * containing {@link Path} if specified, otherwise containing `process.cwd()`.\n *\n * @example\n * Suppose `process.cwd()` is any one of the following,\n *   - `/home/alex/myPackage`,\n *   - `/home/alex/myPackage/src/MyModule`,\n *   - `/home/alex/myPackage/resource/Images`,\n *\n * then,\n *\n * ```typescript\n * const Root: string = await GetPackageRootDirectory();\n * // `Root` <- `\"/home/alex/myPackage\"`\n * ```\n *\n * @example\n * Suppose `TestPath === \"/home/alex/Documents\"` is *not* a NodeJS package root\n * (of course, neither are `/home/alex` or `/home`).  Then,\n *\n * ```typescript\n * const TestPath: string = \"/home/alex/Documents\";\n * let Root: string | undefined = undefined;\n * try\n * {\n *     Root = await GetPackageRootDirectory(TestPath);\n * }\n * catch (Error: unknown)\n * {\n *      // `Error instanceof RootDirectoryNotFound`\n * }\n *\n * // `Root` <- `undefined`\n * ```\n *\n * @example\n * Suppose `process.cwd() === /home/alex/Downloads`, which is *not* a NodeJS package\n * (of course, neither are `/home/alex` or `/home`).  Then,\n *\n * ```typescript\n * let Root: string | undefined = undefined;\n * try\n * {\n *     Root = await GetPackageRootDirectory();\n * }\n * catch (Error: unknown)\n * {\n *      // `Error instanceof RootDirectoryNotFound`\n * }\n * // `Root` <- `undefined`\n * ```\n */\nexport async function GetPackageRootDirectory(Path?: string): Promise<string> {\n    let CurrentDirectory: string = await Fs.realpath(Path ?? Process.cwd());\n    while (true) {\n        const PackageJsonPath: string = join(CurrentDirectory, \"package.json\");\n        const PackageJsonExists: boolean = await (async (): Promise<boolean> => {\n            try {\n                await Fs.access(PackageJsonPath, FsConstants.F_OK);\n                return true;\n            }\n            catch {\n                return false;\n            }\n        })();\n        if (PackageJsonExists) {\n            return CurrentDirectory;\n        }\n        const ParentDirectory: string = dirname(CurrentDirectory);\n        if (ParentDirectory === CurrentDirectory) {\n            throw new RootDirectoryNotFoundError({ Path });\n        }\n        CurrentDirectory = ParentDirectory;\n    }\n}\n", "/**\n * @file      Npm.Error.ts\n * @author    Gage Sorrell <gage@sorrell.sh>\n * @copyright (c) 2026 Gage Sorrell\n * @license   MIT\n */\nimport { Data } from \"effect\";\n/**\n * An error describing that {@link GetPackageJson} failed to parse the discovered `package.json` file.\n *\n * @property {string | undefined} Path - The `Path` argument passed to the effect returning this error,\n * if one was given.\n * @property {unknown} Cause - The cause of this error.\n */\nexport class PackageJsonParseError extends Data.TaggedError(\"PackageJsonParseError\")<{\n    readonly Path: string | undefined;\n    readonly Cause: unknown;\n}> {\n}\n/**\n * An error describing that {@link GetPackageRootDirectory} failed.\n *\n * @property {string | undefined} Path - The `Path` argument passed to the effect returning\n * this error, if one was given.\n */\nexport class RootDirectoryNotFoundError extends Data.TaggedError(\"RootDirectoryNotFound\")<{\n    readonly Path: string | undefined;\n}> {\n}\n"],
+  "mappings": ";AAMA,SAAS,YAAY,IAAI,aAAa,mBAAmB;;;ACAzD,SAAS,YAAY;AAQd,IAAM,wBAAN,cAAoC,KAAK,YAAY,uBAAuB,EAGhF;AACH;AAOO,IAAM,6BAAN,cAAyC,KAAK,YAAY,uBAAuB,EAErF;AACH;;;ADpBA,SAAS,SAAS,YAAY;AAE9B,OAAO,aAAa;AAqBpB,eAAsB,eAAe,MAAsC;AACvE,QAAM,gBAAwB,MAAM,wBAAwB,IAAI;AAChE,QAAM,kBAA0B,KAAK,eAAe,cAAc;AAClE,QAAM,eAAuB,MAAM,GAAG,SAAS,iBAAiB,OAAO;AACvE,QAAM,cAA4B,OAAO,YAAmC;AACxE,QAAI;AACA,aAAO,KAAK,MAAM,YAAY;AAAA,IAClC,SACO,OAAgB;AACnB,YAAM,IAAI,sBAAsB,EAAE,OAAO,MAAM,gBAAgB,CAAC;AAAA,IACpE;AAAA,EACJ,GAAG;AACH,SAAO;AACX;AA8DA,eAAsB,wBAAwB,MAAgC;AAC1E,MAAI,mBAA2B,MAAM,GAAG,SAAS,QAAQ,QAAQ,IAAI,CAAC;AACtE,SAAO,MAAM;AACT,UAAM,kBAA0B,KAAK,kBAAkB,cAAc;AACrE,UAAM,oBAA6B,OAAO,YAA8B;AACpE,UAAI;AACA,cAAM,GAAG,OAAO,iBAAiB,YAAY,IAAI;AACjD,eAAO;AAAA,MACX,QACM;AACF,eAAO;AAAA,MACX;AAAA,IACJ,GAAG;AACH,QAAI,mBAAmB;AACnB,aAAO;AAAA,IACX;AACA,UAAM,kBAA0B,QAAQ,gBAAgB;AACxD,QAAI,oBAAoB,kBAAkB;AACtC,YAAM,IAAI,2BAA2B,EAAE,KAAK,CAAC;AAAA,IACjD;AACA,uBAAmB;AAAA,EACvB;AACJ;",
+  "names": []
+}

package/Distribution/path.cjs

@@ -0,0 +1,63 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// Source/Path/index.ts
+var Path_exports = {};
+__export(Path_exports, {
+  FPath: () => FPath
+});
+module.exports = __toCommonJS(Path_exports);
+
+// Source/Path/Path.ts
+var import_path = require("path");
+var import_tsover_runtime = require("tsover-runtime");
+var FPath = class _FPath {
+  toString() {
+    return this.Raw;
+  }
+  constructor(Argument) {
+    if (typeof Argument === "string") {
+      this.Raw = Argument;
+    } else {
+      this.Raw = Argument.Raw;
+    }
+  }
+  [import_tsover_runtime.Operator.slash](A, B) {
+    if (typeof A === "string") {
+      return new _FPath((0, import_path.join)(A, B.Raw));
+    } else if (typeof B === "string") {
+      return new _FPath((0, import_path.join)(A.Raw, B));
+    } else {
+      return new _FPath((0, import_path.join)(A.Raw, B.Raw));
+    }
+  }
+};
+/**
+ * @file      Path.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+/**
+ * @file      index.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+//# sourceMappingURL=path.cjs.map

package/Distribution/path.cjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../Source/Path/index.ts", "../Source/Path/Path.ts"],
+  "sourcesContent": ["/**\n * @file      index.ts\n * @author    Gage Sorrell <gage@sorrell.sh>\n * @copyright (c) 2026 Gage Sorrell\n * @license   MIT\n */\nexport * from \"./Path.ts\";\n", "/**\n * @file      Path.ts\n * @author    Gage Sorrell <gage@sorrell.sh>\n * @copyright (c) 2026 Gage Sorrell\n * @license   MIT\n */\nimport { join } from \"path\";\nimport { Operator } from \"tsover-runtime\";\nexport class FPath {\n    public readonly Raw: string;\n    public toString(): string {\n        return this.Raw;\n    }\n    public constructor(String: string);\n    public constructor(Other: FPath);\n    public constructor(Argument: string | FPath) {\n        if (typeof Argument === \"string\") {\n            this.Raw = Argument;\n        }\n        else {\n            this.Raw = Argument.Raw;\n        }\n    }\n    [Operator.slash](A: FPath, B: FPath): FPath;\n    [Operator.slash](A: string, B: FPath): FPath;\n    [Operator.slash](A: FPath, B: string): FPath;\n    [Operator.slash](A: FPath | string, B: FPath | string): FPath {\n        if (typeof A === \"string\") {\n            return new FPath(join(A, (B as FPath).Raw));\n        }\n        else if (typeof B === \"string\") {\n            return new FPath(join((A as FPath).Raw, B));\n        }\n        else {\n            return new FPath(join((A as FPath).Raw, (B as FPath).Raw));\n        }\n    }\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACMA,kBAAqB;AACrB,4BAAyB;AAClB,IAAM,QAAN,MAAM,OAAM;AAAA,EAER,WAAmB;AACtB,WAAO,KAAK;AAAA,EAChB;AAAA,EAGO,YAAY,UAA0B;AACzC,QAAI,OAAO,aAAa,UAAU;AAC9B,WAAK,MAAM;AAAA,IACf,OACK;AACD,WAAK,MAAM,SAAS;AAAA,IACxB;AAAA,EACJ;AAAA,EAIA,CAAC,+BAAS,KAAK,EAAE,GAAmB,GAA0B;AAC1D,QAAI,OAAO,MAAM,UAAU;AACvB,aAAO,IAAI,WAAM,kBAAK,GAAI,EAAY,GAAG,CAAC;AAAA,IAC9C,WACS,OAAO,MAAM,UAAU;AAC5B,aAAO,IAAI,WAAM,kBAAM,EAAY,KAAK,CAAC,CAAC;AAAA,IAC9C,OACK;AACD,aAAO,IAAI,WAAM,kBAAM,EAAY,KAAM,EAAY,GAAG,CAAC;AAAA,IAC7D;AAAA,EACJ;AACJ;",
+  "names": []
+}

package/Distribution/path.js

@@ -0,0 +1,40 @@
+// Source/Path/Path.ts
+import { join } from "path";
+import { Operator } from "tsover-runtime";
+var FPath = class _FPath {
+  toString() {
+    return this.Raw;
+  }
+  constructor(Argument) {
+    if (typeof Argument === "string") {
+      this.Raw = Argument;
+    } else {
+      this.Raw = Argument.Raw;
+    }
+  }
+  [Operator.slash](A, B) {
+    if (typeof A === "string") {
+      return new _FPath(join(A, B.Raw));
+    } else if (typeof B === "string") {
+      return new _FPath(join(A.Raw, B));
+    } else {
+      return new _FPath(join(A.Raw, B.Raw));
+    }
+  }
+};
+export {
+  FPath
+};
+/**
+ * @file      Path.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+/**
+ * @file      index.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+//# sourceMappingURL=path.js.map

package/Distribution/path.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../Source/Path/Path.ts"],
+  "sourcesContent": ["/**\n * @file      Path.ts\n * @author    Gage Sorrell <gage@sorrell.sh>\n * @copyright (c) 2026 Gage Sorrell\n * @license   MIT\n */\nimport { join } from \"path\";\nimport { Operator } from \"tsover-runtime\";\nexport class FPath {\n    public readonly Raw: string;\n    public toString(): string {\n        return this.Raw;\n    }\n    public constructor(String: string);\n    public constructor(Other: FPath);\n    public constructor(Argument: string | FPath) {\n        if (typeof Argument === \"string\") {\n            this.Raw = Argument;\n        }\n        else {\n            this.Raw = Argument.Raw;\n        }\n    }\n    [Operator.slash](A: FPath, B: FPath): FPath;\n    [Operator.slash](A: string, B: FPath): FPath;\n    [Operator.slash](A: FPath, B: string): FPath;\n    [Operator.slash](A: FPath | string, B: FPath | string): FPath {\n        if (typeof A === \"string\") {\n            return new FPath(join(A, (B as FPath).Raw));\n        }\n        else if (typeof B === \"string\") {\n            return new FPath(join((A as FPath).Raw, B));\n        }\n        else {\n            return new FPath(join((A as FPath).Raw, (B as FPath).Raw));\n        }\n    }\n}\n"],
+  "mappings": ";AAMA,SAAS,YAAY;AACrB,SAAS,gBAAgB;AAClB,IAAM,QAAN,MAAM,OAAM;AAAA,EAER,WAAmB;AACtB,WAAO,KAAK;AAAA,EAChB;AAAA,EAGO,YAAY,UAA0B;AACzC,QAAI,OAAO,aAAa,UAAU;AAC9B,WAAK,MAAM;AAAA,IACf,OACK;AACD,WAAK,MAAM,SAAS;AAAA,IACxB;AAAA,EACJ;AAAA,EAIA,CAAC,SAAS,KAAK,EAAE,GAAmB,GAA0B;AAC1D,QAAI,OAAO,MAAM,UAAU;AACvB,aAAO,IAAI,OAAM,KAAK,GAAI,EAAY,GAAG,CAAC;AAAA,IAC9C,WACS,OAAO,MAAM,UAAU;AAC5B,aAAO,IAAI,OAAM,KAAM,EAAY,KAAK,CAAC,CAAC;AAAA,IAC9C,OACK;AACD,aAAO,IAAI,OAAM,KAAM,EAAY,KAAM,EAAY,GAAG,CAAC;AAAA,IAC7D;AAAA,EACJ;AACJ;",
+  "names": []
+}

package/Distribution/record.cjs

@@ -0,0 +1,116 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// Source/Record/index.ts
+var Record_exports = {};
+__export(Record_exports, {
+  FlatMapRecord: () => FlatMapRecord,
+  GetPropertyFromPath: () => GetPropertyFromPath,
+  MakeRef: () => MakeRef,
+  MapRecord: () => MapRecord,
+  SetPropertyFromPath: () => SetPropertyFromPath
+});
+module.exports = __toCommonJS(Record_exports);
+
+// Source/Record/Record.ts
+function SetPropertyFromPath(InRecord, Path, Value) {
+  if (Array.isArray(Path)) {
+    throw new Error("SetPropertyFromPath does not support Array-based paths yet.");
+  }
+  const PathSplit = Path.split(".");
+  const Last = PathSplit.pop();
+  if (Last === void 0) {
+    return;
+  }
+  if (PathSplit.length === 0) {
+    if (!Array.isArray(Path)) {
+      InRecord.Ref[Path] = Value;
+    }
+  }
+  const Recurrence = (In) => {
+    const NextPropertyNameBase = PathSplit.shift();
+    if (NextPropertyNameBase !== void 0) {
+      const NextPropertyName = isNaN(parseInt(NextPropertyNameBase)) ? NextPropertyNameBase : parseInt(NextPropertyNameBase);
+      const Out = In[NextPropertyName];
+      return Recurrence(Out);
+    } else {
+      return In;
+    }
+  };
+  const PropertyRef = Recurrence(InRecord);
+  const LastTyped = isNaN(parseInt(Last)) ? Last : parseInt(Last);
+  PropertyRef.Ref[LastTyped] = Value;
+}
+function GetPropertyFromPath(InRecord, Path) {
+  if (Array.isArray(Path)) {
+    throw new Error("GetPropertyFromPath does not support Array-based paths yet.");
+  }
+  const PathSplit = Path.split(".");
+  const Recurrence = (In, Index = 0) => {
+    const Key = isNaN(parseInt(PathSplit[Index] || "")) ? PathSplit[Index] : parseInt(PathSplit[Index] || "");
+    if (Key !== void 0) {
+      const Next = In[Key];
+      if (Index !== PathSplit.length - 1) {
+        return Recurrence(Next, Index + 1);
+      } else {
+        return Next;
+      }
+    } else {
+      return void 0;
+    }
+  };
+  return Recurrence(InRecord);
+}
+function MakeRef() {
+  return {
+    Ref: void 0
+  };
+}
+function MapRecord(InRecord, InFunction) {
+  return Object.keys(InRecord).map((InKey, Index) => {
+    const Key = InKey;
+    return InFunction(Key, InRecord[Key], Index);
+  });
+}
+function FlatMapRecord(InRecord, InFunction) {
+  return Object.keys(InRecord).flatMap((InKey, Index) => {
+    const Key = InKey;
+    const Transform = InFunction(Key, InRecord[Key], Index);
+    return Array.isArray(Transform) ? Transform : [Transform];
+  });
+}
+/**
+ * @file      Record.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+/**
+ * @file      Record.Types.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+/**
+ * @file      index.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+//# sourceMappingURL=record.cjs.map

package/Distribution/record.cjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../Source/Record/index.ts", "../Source/Record/Record.ts"],
+  "sourcesContent": ["/**\n * @file      index.ts\n * @author    Gage Sorrell <gage@sorrell.sh>\n * @copyright (c) 2026 Gage Sorrell\n * @license   MIT\n */\nexport * from \"./Record.ts\";\nexport * from \"./Record.Types.ts\";\n", "/**\n * @file      Record.ts\n * @author    Gage Sorrell <gage@sorrell.sh>\n * @copyright (c) 2026 Gage Sorrell\n * @license   MIT\n */\nimport type { TFlatMapRecordTransformer, TFromPath, TMapRecordTransformer, TPath, TRef } from \"./Record.Types.ts\";\n// @TODO Write example for `SetPropertyFromPath`.\n/* eslint-disable jsdoc/require-example */\n/**\n * Set a value within a given {@link InRecord | Record} at a given {@link Path} to be a given\n * {@link Value}.\n *\n * @param InRecord - The {@link Record} that holds the value with path {@link Path} to be retrieved\n * by this function.\n * @param Path - The {@link PathType} that describes the property to be retrieved by this.\n * @param Value - The value to be set at the given {@link Path} of the given {@link InRecord | Record}.\n *\n * @throws {Error} An {@link Error} iff the given {@link Path} is an {@link Array}, rather than a\n * `.`-delimited `string`.\n */\nexport function SetPropertyFromPath<RecordType extends Record<string | number, unknown>, PathType extends TPath<RecordType>>(InRecord: RecordType, Path: PathType, Value: TFromPath<RecordType, PathType>): void {\n    type FProperty = TFromPath<RecordType, PathType>;\n    if (Array.isArray(Path)) {\n        throw new Error(\"SetPropertyFromPath does not support Array-based paths yet.\");\n    }\n    const PathSplit: Array<string> = Path.split(\".\");\n    const Last: string | undefined = PathSplit.pop();\n    if (Last === undefined) {\n        return;\n    }\n    if (PathSplit.length === 0) {\n        if (!Array.isArray(Path)) {\n            ((InRecord.Ref as Record<string, unknown>)[(Path as string)]) = Value;\n        }\n    }\n    const Recurrence = (In: unknown): unknown | undefined => {\n        const NextPropertyNameBase: string | undefined = PathSplit.shift();\n        if (NextPropertyNameBase !== undefined) {\n            const NextPropertyName: string | number = isNaN(parseInt(NextPropertyNameBase))\n                ? NextPropertyNameBase\n                : parseInt(NextPropertyNameBase);\n            const Out: unknown = (In as Record<string, unknown>)[NextPropertyName] as unknown;\n            return Recurrence(Out);\n        }\n        else {\n            return In;\n        }\n    };\n    const PropertyRef: TRef<FProperty> = Recurrence(InRecord) as TRef<FProperty>;\n    const LastTyped: string | number = isNaN(parseInt(Last))\n        ? Last\n        : parseInt(Last);\n    (PropertyRef.Ref as Record<string, unknown>)[LastTyped] = Value;\n}\n;\n/* eslint-enable jsdoc/require-example */\n// @TODO Write example for `GetPropertyFromPath`.\n/* eslint-disable jsdoc/require-example */\n/**\n * Get a value within a given {@link InRecord | Record} at a given {@link Path}.\n *\n * @param InRecord - The {@link Record} that holds the value with path {@link Path} to be retrieved\n * by this function.\n * @param Path - The {@link PathType} that describes the property to be retrieved by this.\n *\n * @throws {Error} An {@link Error} iff the given {@link Path} is an {@link Array}, rather than a\n * `.`-delimited `string`.\n *\n * @returns {TFromPath<RecordType, PathType>} The value in the {@link InRecord} at the given {@link Path}.\n */\nexport function GetPropertyFromPath<RecordType extends Record<string, unknown>, PathType extends TPath<RecordType>>(InRecord: RecordType, Path: PathType): TFromPath<RecordType, PathType> {\n    if (Array.isArray(Path)) {\n        throw new Error(\"GetPropertyFromPath does not support Array-based paths yet.\");\n    }\n    const PathSplit: Array<string> = Path.split(\".\");\n    const Recurrence = (In: unknown, Index: number = 0): unknown => {\n        const Key: string | number | undefined = isNaN(parseInt(PathSplit[Index] || \"\"))\n            ? PathSplit[Index]\n            : parseInt(PathSplit[Index] || \"\");\n        if (Key !== undefined) {\n            const Next: unknown = (In as Record<string, unknown>)[Key];\n            if (Index !== PathSplit.length - 1) {\n                return Recurrence(Next, Index + 1);\n            }\n            else {\n                return Next;\n            }\n        }\n        else {\n            return undefined;\n        }\n    };\n    return Recurrence(InRecord) as TFromPath<RecordType, PathType>;\n}\n;\n/* eslint-enable jsdoc/require-example */\n/**\n * Creates a {@link TRef} of a given {@link Type}.  Useful for passing\n * primitives to functions by-reference.\n *\n * @template Type - The type of the value wrapped by the returned {@link TRef}.\n *\n * @returns {TRef<Type>} A {@link TRef} of the given {@link Type}.\n */\nexport function MakeRef<Type>(): TRef<Type> {\n    return {\n        Ref: undefined\n    } as TRef<Type>;\n}\n;\n// @TODO Write example for `MapRecord`.\n/* eslint-disable jsdoc/require-example */\n/**\n * Maps a {@link Record} to an {@link Array}.\n *\n * @param InRecord - The {@link Record} over which this function maps.\n * @param InFunction - The {@link TFlatMapRecordTransformer | transformer} that maps\n * the record to an {@link Array}.\n *\n * @returns {Array<ElementType>} An {@link Array} of elements, mapped from the given {@link InRecord}.\n */\nexport function MapRecord<KeyType extends PropertyKey, PropertyType, ElementType>(InRecord: Record<KeyType, PropertyType>, InFunction: TMapRecordTransformer<KeyType, PropertyType, ElementType>): Array<ElementType> {\n    return Object.keys(InRecord).map((InKey: string, Index: number): ElementType => {\n        const Key: KeyType = InKey as KeyType;\n        return InFunction(Key, InRecord[Key], Index);\n    });\n}\n;\n/* eslint-enable jsdoc/require-example */\n// @TODO Write example for `FlatMapRecord`.\n/* eslint-disable jsdoc/require-example */\n/**\n * Maps a {@link Record} to an {@link Array}.\n *\n * @param InRecord - The {@link Record} over which this function maps.\n * @param InFunction - The {@link TFlatMapRecordTransformer | transformer} that maps\n * the record to an {@link Array}.\n *\n * @returns {Array<ElementType>} An {@link Array} of elements, mapped from the given {@link InRecord}.\n */\nexport function FlatMapRecord<KeyType extends PropertyKey, PropertyType, ElementType>(InRecord: Record<KeyType, PropertyType>, InFunction: TFlatMapRecordTransformer<KeyType, PropertyType, ElementType>): Array<ElementType> {\n    return Object.keys(InRecord).flatMap((InKey: string, Index: number): Array<ElementType> => {\n        const Key: KeyType = InKey as KeyType;\n        const Transform: ElementType | Array<ElementType> = InFunction(Key, InRecord[Key], Index);\n        return Array.isArray(Transform)\n            ? Transform\n            : [Transform];\n    });\n}\n/* eslint-enable jsdoc/require-example */\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACqBO,SAAS,oBAA6G,UAAsB,MAAgB,OAA8C;AAE7M,MAAI,MAAM,QAAQ,IAAI,GAAG;AACrB,UAAM,IAAI,MAAM,6DAA6D;AAAA,EACjF;AACA,QAAM,YAA2B,KAAK,MAAM,GAAG;AAC/C,QAAM,OAA2B,UAAU,IAAI;AAC/C,MAAI,SAAS,QAAW;AACpB;AAAA,EACJ;AACA,MAAI,UAAU,WAAW,GAAG;AACxB,QAAI,CAAC,MAAM,QAAQ,IAAI,GAAG;AACtB,MAAE,SAAS,IAAiC,IAAe,IAAK;AAAA,IACpE;AAAA,EACJ;AACA,QAAM,aAAa,CAAC,OAAqC;AACrD,UAAM,uBAA2C,UAAU,MAAM;AACjE,QAAI,yBAAyB,QAAW;AACpC,YAAM,mBAAoC,MAAM,SAAS,oBAAoB,CAAC,IACxE,uBACA,SAAS,oBAAoB;AACnC,YAAM,MAAgB,GAA+B,gBAAgB;AACrE,aAAO,WAAW,GAAG;AAAA,IACzB,OACK;AACD,aAAO;AAAA,IACX;AAAA,EACJ;AACA,QAAM,cAA+B,WAAW,QAAQ;AACxD,QAAM,YAA6B,MAAM,SAAS,IAAI,CAAC,IACjD,OACA,SAAS,IAAI;AACnB,EAAC,YAAY,IAAgC,SAAS,IAAI;AAC9D;AAiBO,SAAS,oBAAoG,UAAsB,MAAiD;AACvL,MAAI,MAAM,QAAQ,IAAI,GAAG;AACrB,UAAM,IAAI,MAAM,6DAA6D;AAAA,EACjF;AACA,QAAM,YAA2B,KAAK,MAAM,GAAG;AAC/C,QAAM,aAAa,CAAC,IAAa,QAAgB,MAAe;AAC5D,UAAM,MAAmC,MAAM,SAAS,UAAU,KAAK,KAAK,EAAE,CAAC,IACzE,UAAU,KAAK,IACf,SAAS,UAAU,KAAK,KAAK,EAAE;AACrC,QAAI,QAAQ,QAAW;AACnB,YAAM,OAAiB,GAA+B,GAAG;AACzD,UAAI,UAAU,UAAU,SAAS,GAAG;AAChC,eAAO,WAAW,MAAM,QAAQ,CAAC;AAAA,MACrC,OACK;AACD,eAAO;AAAA,MACX;AAAA,IACJ,OACK;AACD,aAAO;AAAA,IACX;AAAA,EACJ;AACA,SAAO,WAAW,QAAQ;AAC9B;AAWO,SAAS,UAA4B;AACxC,SAAO;AAAA,IACH,KAAK;AAAA,EACT;AACJ;AAaO,SAAS,UAAkE,UAAyC,YAA2F;AAClN,SAAO,OAAO,KAAK,QAAQ,EAAE,IAAI,CAAC,OAAe,UAA+B;AAC5E,UAAM,MAAe;AACrB,WAAO,WAAW,KAAK,SAAS,GAAG,GAAG,KAAK;AAAA,EAC/C,CAAC;AACL;AAcO,SAAS,cAAsE,UAAyC,YAA+F;AAC1N,SAAO,OAAO,KAAK,QAAQ,EAAE,QAAQ,CAAC,OAAe,UAAsC;AACvF,UAAM,MAAe;AACrB,UAAM,YAA8C,WAAW,KAAK,SAAS,GAAG,GAAG,KAAK;AACxF,WAAO,MAAM,QAAQ,SAAS,IACxB,YACA,CAAC,SAAS;AAAA,EACpB,CAAC;AACL;",
+  "names": []
+}

package/Distribution/record.js

@@ -0,0 +1,93 @@
+// Source/Record/Record.ts
+function SetPropertyFromPath(InRecord, Path, Value) {
+  if (Array.isArray(Path)) {
+    throw new Error("SetPropertyFromPath does not support Array-based paths yet.");
+  }
+  const PathSplit = Path.split(".");
+  const Last = PathSplit.pop();
+  if (Last === void 0) {
+    return;
+  }
+  if (PathSplit.length === 0) {
+    if (!Array.isArray(Path)) {
+      InRecord.Ref[Path] = Value;
+    }
+  }
+  const Recurrence = (In) => {
+    const NextPropertyNameBase = PathSplit.shift();
+    if (NextPropertyNameBase !== void 0) {
+      const NextPropertyName = isNaN(parseInt(NextPropertyNameBase)) ? NextPropertyNameBase : parseInt(NextPropertyNameBase);
+      const Out = In[NextPropertyName];
+      return Recurrence(Out);
+    } else {
+      return In;
+    }
+  };
+  const PropertyRef = Recurrence(InRecord);
+  const LastTyped = isNaN(parseInt(Last)) ? Last : parseInt(Last);
+  PropertyRef.Ref[LastTyped] = Value;
+}
+function GetPropertyFromPath(InRecord, Path) {
+  if (Array.isArray(Path)) {
+    throw new Error("GetPropertyFromPath does not support Array-based paths yet.");
+  }
+  const PathSplit = Path.split(".");
+  const Recurrence = (In, Index = 0) => {
+    const Key = isNaN(parseInt(PathSplit[Index] || "")) ? PathSplit[Index] : parseInt(PathSplit[Index] || "");
+    if (Key !== void 0) {
+      const Next = In[Key];
+      if (Index !== PathSplit.length - 1) {
+        return Recurrence(Next, Index + 1);
+      } else {
+        return Next;
+      }
+    } else {
+      return void 0;
+    }
+  };
+  return Recurrence(InRecord);
+}
+function MakeRef() {
+  return {
+    Ref: void 0
+  };
+}
+function MapRecord(InRecord, InFunction) {
+  return Object.keys(InRecord).map((InKey, Index) => {
+    const Key = InKey;
+    return InFunction(Key, InRecord[Key], Index);
+  });
+}
+function FlatMapRecord(InRecord, InFunction) {
+  return Object.keys(InRecord).flatMap((InKey, Index) => {
+    const Key = InKey;
+    const Transform = InFunction(Key, InRecord[Key], Index);
+    return Array.isArray(Transform) ? Transform : [Transform];
+  });
+}
+export {
+  FlatMapRecord,
+  GetPropertyFromPath,
+  MakeRef,
+  MapRecord,
+  SetPropertyFromPath
+};
+/**
+ * @file      Record.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+/**
+ * @file      Record.Types.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+/**
+ * @file      index.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+//# sourceMappingURL=record.js.map

package/Distribution/record.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../Source/Record/Record.ts"],
+  "sourcesContent": ["/**\n * @file      Record.ts\n * @author    Gage Sorrell <gage@sorrell.sh>\n * @copyright (c) 2026 Gage Sorrell\n * @license   MIT\n */\nimport type { TFlatMapRecordTransformer, TFromPath, TMapRecordTransformer, TPath, TRef } from \"./Record.Types.ts\";\n// @TODO Write example for `SetPropertyFromPath`.\n/* eslint-disable jsdoc/require-example */\n/**\n * Set a value within a given {@link InRecord | Record} at a given {@link Path} to be a given\n * {@link Value}.\n *\n * @param InRecord - The {@link Record} that holds the value with path {@link Path} to be retrieved\n * by this function.\n * @param Path - The {@link PathType} that describes the property to be retrieved by this.\n * @param Value - The value to be set at the given {@link Path} of the given {@link InRecord | Record}.\n *\n * @throws {Error} An {@link Error} iff the given {@link Path} is an {@link Array}, rather than a\n * `.`-delimited `string`.\n */\nexport function SetPropertyFromPath<RecordType extends Record<string | number, unknown>, PathType extends TPath<RecordType>>(InRecord: RecordType, Path: PathType, Value: TFromPath<RecordType, PathType>): void {\n    type FProperty = TFromPath<RecordType, PathType>;\n    if (Array.isArray(Path)) {\n        throw new Error(\"SetPropertyFromPath does not support Array-based paths yet.\");\n    }\n    const PathSplit: Array<string> = Path.split(\".\");\n    const Last: string | undefined = PathSplit.pop();\n    if (Last === undefined) {\n        return;\n    }\n    if (PathSplit.length === 0) {\n        if (!Array.isArray(Path)) {\n            ((InRecord.Ref as Record<string, unknown>)[(Path as string)]) = Value;\n        }\n    }\n    const Recurrence = (In: unknown): unknown | undefined => {\n        const NextPropertyNameBase: string | undefined = PathSplit.shift();\n        if (NextPropertyNameBase !== undefined) {\n            const NextPropertyName: string | number = isNaN(parseInt(NextPropertyNameBase))\n                ? NextPropertyNameBase\n                : parseInt(NextPropertyNameBase);\n            const Out: unknown = (In as Record<string, unknown>)[NextPropertyName] as unknown;\n            return Recurrence(Out);\n        }\n        else {\n            return In;\n        }\n    };\n    const PropertyRef: TRef<FProperty> = Recurrence(InRecord) as TRef<FProperty>;\n    const LastTyped: string | number = isNaN(parseInt(Last))\n        ? Last\n        : parseInt(Last);\n    (PropertyRef.Ref as Record<string, unknown>)[LastTyped] = Value;\n}\n;\n/* eslint-enable jsdoc/require-example */\n// @TODO Write example for `GetPropertyFromPath`.\n/* eslint-disable jsdoc/require-example */\n/**\n * Get a value within a given {@link InRecord | Record} at a given {@link Path}.\n *\n * @param InRecord - The {@link Record} that holds the value with path {@link Path} to be retrieved\n * by this function.\n * @param Path - The {@link PathType} that describes the property to be retrieved by this.\n *\n * @throws {Error} An {@link Error} iff the given {@link Path} is an {@link Array}, rather than a\n * `.`-delimited `string`.\n *\n * @returns {TFromPath<RecordType, PathType>} The value in the {@link InRecord} at the given {@link Path}.\n */\nexport function GetPropertyFromPath<RecordType extends Record<string, unknown>, PathType extends TPath<RecordType>>(InRecord: RecordType, Path: PathType): TFromPath<RecordType, PathType> {\n    if (Array.isArray(Path)) {\n        throw new Error(\"GetPropertyFromPath does not support Array-based paths yet.\");\n    }\n    const PathSplit: Array<string> = Path.split(\".\");\n    const Recurrence = (In: unknown, Index: number = 0): unknown => {\n        const Key: string | number | undefined = isNaN(parseInt(PathSplit[Index] || \"\"))\n            ? PathSplit[Index]\n            : parseInt(PathSplit[Index] || \"\");\n        if (Key !== undefined) {\n            const Next: unknown = (In as Record<string, unknown>)[Key];\n            if (Index !== PathSplit.length - 1) {\n                return Recurrence(Next, Index + 1);\n            }\n            else {\n                return Next;\n            }\n        }\n        else {\n            return undefined;\n        }\n    };\n    return Recurrence(InRecord) as TFromPath<RecordType, PathType>;\n}\n;\n/* eslint-enable jsdoc/require-example */\n/**\n * Creates a {@link TRef} of a given {@link Type}.  Useful for passing\n * primitives to functions by-reference.\n *\n * @template Type - The type of the value wrapped by the returned {@link TRef}.\n *\n * @returns {TRef<Type>} A {@link TRef} of the given {@link Type}.\n */\nexport function MakeRef<Type>(): TRef<Type> {\n    return {\n        Ref: undefined\n    } as TRef<Type>;\n}\n;\n// @TODO Write example for `MapRecord`.\n/* eslint-disable jsdoc/require-example */\n/**\n * Maps a {@link Record} to an {@link Array}.\n *\n * @param InRecord - The {@link Record} over which this function maps.\n * @param InFunction - The {@link TFlatMapRecordTransformer | transformer} that maps\n * the record to an {@link Array}.\n *\n * @returns {Array<ElementType>} An {@link Array} of elements, mapped from the given {@link InRecord}.\n */\nexport function MapRecord<KeyType extends PropertyKey, PropertyType, ElementType>(InRecord: Record<KeyType, PropertyType>, InFunction: TMapRecordTransformer<KeyType, PropertyType, ElementType>): Array<ElementType> {\n    return Object.keys(InRecord).map((InKey: string, Index: number): ElementType => {\n        const Key: KeyType = InKey as KeyType;\n        return InFunction(Key, InRecord[Key], Index);\n    });\n}\n;\n/* eslint-enable jsdoc/require-example */\n// @TODO Write example for `FlatMapRecord`.\n/* eslint-disable jsdoc/require-example */\n/**\n * Maps a {@link Record} to an {@link Array}.\n *\n * @param InRecord - The {@link Record} over which this function maps.\n * @param InFunction - The {@link TFlatMapRecordTransformer | transformer} that maps\n * the record to an {@link Array}.\n *\n * @returns {Array<ElementType>} An {@link Array} of elements, mapped from the given {@link InRecord}.\n */\nexport function FlatMapRecord<KeyType extends PropertyKey, PropertyType, ElementType>(InRecord: Record<KeyType, PropertyType>, InFunction: TFlatMapRecordTransformer<KeyType, PropertyType, ElementType>): Array<ElementType> {\n    return Object.keys(InRecord).flatMap((InKey: string, Index: number): Array<ElementType> => {\n        const Key: KeyType = InKey as KeyType;\n        const Transform: ElementType | Array<ElementType> = InFunction(Key, InRecord[Key], Index);\n        return Array.isArray(Transform)\n            ? Transform\n            : [Transform];\n    });\n}\n/* eslint-enable jsdoc/require-example */\n"],
+  "mappings": ";AAqBO,SAAS,oBAA6G,UAAsB,MAAgB,OAA8C;AAE7M,MAAI,MAAM,QAAQ,IAAI,GAAG;AACrB,UAAM,IAAI,MAAM,6DAA6D;AAAA,EACjF;AACA,QAAM,YAA2B,KAAK,MAAM,GAAG;AAC/C,QAAM,OAA2B,UAAU,IAAI;AAC/C,MAAI,SAAS,QAAW;AACpB;AAAA,EACJ;AACA,MAAI,UAAU,WAAW,GAAG;AACxB,QAAI,CAAC,MAAM,QAAQ,IAAI,GAAG;AACtB,MAAE,SAAS,IAAiC,IAAe,IAAK;AAAA,IACpE;AAAA,EACJ;AACA,QAAM,aAAa,CAAC,OAAqC;AACrD,UAAM,uBAA2C,UAAU,MAAM;AACjE,QAAI,yBAAyB,QAAW;AACpC,YAAM,mBAAoC,MAAM,SAAS,oBAAoB,CAAC,IACxE,uBACA,SAAS,oBAAoB;AACnC,YAAM,MAAgB,GAA+B,gBAAgB;AACrE,aAAO,WAAW,GAAG;AAAA,IACzB,OACK;AACD,aAAO;AAAA,IACX;AAAA,EACJ;AACA,QAAM,cAA+B,WAAW,QAAQ;AACxD,QAAM,YAA6B,MAAM,SAAS,IAAI,CAAC,IACjD,OACA,SAAS,IAAI;AACnB,EAAC,YAAY,IAAgC,SAAS,IAAI;AAC9D;AAiBO,SAAS,oBAAoG,UAAsB,MAAiD;AACvL,MAAI,MAAM,QAAQ,IAAI,GAAG;AACrB,UAAM,IAAI,MAAM,6DAA6D;AAAA,EACjF;AACA,QAAM,YAA2B,KAAK,MAAM,GAAG;AAC/C,QAAM,aAAa,CAAC,IAAa,QAAgB,MAAe;AAC5D,UAAM,MAAmC,MAAM,SAAS,UAAU,KAAK,KAAK,EAAE,CAAC,IACzE,UAAU,KAAK,IACf,SAAS,UAAU,KAAK,KAAK,EAAE;AACrC,QAAI,QAAQ,QAAW;AACnB,YAAM,OAAiB,GAA+B,GAAG;AACzD,UAAI,UAAU,UAAU,SAAS,GAAG;AAChC,eAAO,WAAW,MAAM,QAAQ,CAAC;AAAA,MACrC,OACK;AACD,eAAO;AAAA,MACX;AAAA,IACJ,OACK;AACD,aAAO;AAAA,IACX;AAAA,EACJ;AACA,SAAO,WAAW,QAAQ;AAC9B;AAWO,SAAS,UAA4B;AACxC,SAAO;AAAA,IACH,KAAK;AAAA,EACT;AACJ;AAaO,SAAS,UAAkE,UAAyC,YAA2F;AAClN,SAAO,OAAO,KAAK,QAAQ,EAAE,IAAI,CAAC,OAAe,UAA+B;AAC5E,UAAM,MAAe;AACrB,WAAO,WAAW,KAAK,SAAS,GAAG,GAAG,KAAK;AAAA,EAC/C,CAAC;AACL;AAcO,SAAS,cAAsE,UAAyC,YAA+F;AAC1N,SAAO,OAAO,KAAK,QAAQ,EAAE,QAAQ,CAAC,OAAe,UAAsC;AACvF,UAAM,MAAe;AACrB,UAAM,YAA8C,WAAW,KAAK,SAAS,GAAG,GAAG,KAAK;AACxF,WAAO,MAAM,QAAQ,SAAS,IACxB,YACA,CAAC,SAAS;AAAA,EACpB,CAAC;AACL;",
+  "names": []
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sorrell/utilities",
-    "version": "1.2.5",
+    "version": "1.2.6",
     "private": false,
     "description": "Various TypeScript utilities.",
     "keywords": [
@@ -101,6 +101,16 @@
                 "default": "./Distribution/functional.cjs"
             }
         },
+        "./dependency": {
+            "import": {
+                "types": "./Distribution/Types/Dependency/index.d.mts",
+                "default": "./Distribution/dependency.js"
+            },
+            "require": {
+                "types": "./Distribution/Types/Dependency/index.d.cts",
+                "default": "./Distribution/dependency.cjs"
+            }
+        },
         "./misc": {
             "import": {
                 "types": "./Distribution/Types/Miscellaneous/index.d.mts",