@sorrell/utilities 1.1.59 → 1.1.61

package/Distribution/Types/Npm/Index.Effect.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @file      Index.Effect.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+export * from "./Npm.Effect.ts";
+export * from "./Npm.Effect.Types.ts";
+//# sourceMappingURL=Index.Effect.d.ts.map

package/Distribution/Types/Npm/Index.Effect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Index.Effect.d.ts","sourceRoot":"","sources":["../../../Source/Npm/Index.Effect.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC"}

package/Distribution/Types/Npm/Npm.Effect.Internal.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @file      Npm.Effect.Internal.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+/**
+ * Returns whether a given {@link Value} contains a `readonly` `string` `"code"`.
+ *
+ * @param Value - The value to test.
+ * @returns {Value is { readonly code: string }} Whether {@link Value} is a
+ * `{ readonly code: string }`.
+ */
+export declare function HasErrorCode(Value: unknown): Value is {
+    readonly code: string;
+};
+//# sourceMappingURL=Npm.Effect.Internal.d.ts.map

package/Distribution/Types/Npm/Npm.Effect.Internal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Npm.Effect.Internal.d.ts","sourceRoot":"","sources":["../../../Source/Npm/Npm.Effect.Internal.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAM/E"}

package/Distribution/Types/Npm/Npm.Effect.Types.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @file      Npm.Effect.Types.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+import type { PackageJsonParseError, RootDirectoryNotFoundError } from "./Npm.Error.ts";
+import type { Effect } from "effect";
+import type { IPackageJson } from "package-json-type";
+export type EGetPackageJson = Effect.Effect<IPackageJson, PackageJsonParseError | RootDirectoryNotFoundError, never>;
+export type EGetPackageRootDirectory = Effect.Effect<string, RootDirectoryNotFoundError, never>;
+//# sourceMappingURL=Npm.Effect.Types.d.ts.map

package/Distribution/Types/Npm/Npm.Effect.Types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Npm.Effect.Types.d.ts","sourceRoot":"","sources":["../../../Source/Npm/Npm.Effect.Types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,MAAM,gBAAgB,CAAC;AACxF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtD,MAAM,MAAM,eAAe,GACvB,MAAM,CAAC,MAAM,CACT,YAAY,EACZ,qBAAqB,GAAG,0BAA0B,EAClD,KAAK,CACR,CAAC;AAEN,MAAM,MAAM,wBAAwB,GAChC,MAAM,CAAC,MAAM,CACT,MAAM,EACN,0BAA0B,EAC1B,KAAK,CACR,CAAC"}

package/Distribution/Types/Npm/Npm.Effect.d.ts

@@ -0,0 +1,92 @@
+/**
+ * @file      Npm.Effect.ts
+ * @author    Gage Sorrell <gage@sorrell.sh>
+ * @copyright (c) 2026 Gage Sorrell
+ * @license   MIT
+ */
+import type { EGetPackageJson, EGetPackageRootDirectory } from "./Npm.Effect.Types.ts";
+/**
+ * Get the `package.json` of the Node.js project in which the
+ * given path, or the current working directory, resides.
+ *
+ * @param Path - The given path from which to look for a root directory.
+ *
+ * @returns {EGetPackageJson} An Effect that succeeds with the parsed `package.json`, or fails
+ * with {@link RootDirectoryNotFoundError} or {@link PackageJsonParseError}.
+ *
+ * @example
+ * Suppose `process.cwd() === "./MyPackage"`,
+ * ```typescript
+ * Effect.gen(function* ()
+ * {
+ *     const PackageJson: IPackageJson = yield* GetPackageJson();
+ *     // `PackageJson` <- *The parsed `package.json` of `MyPackage`.*
+ * }
+ * ```
+ */
+export declare function GetPackageJson(Path?: string): EGetPackageJson;
+/**
+ * Get the root directory of the Node.js project in which the
+ * current working directory resides.
+ *
+ * @param Path - *(Optional)* The given path from which to look for a root directory.
+ *
+ * @returns {EGetPackageRootDirectory} An Effect that succeeds with the package root
+ * directory, or fails with {@link RootDirectoryNotFoundError}.
+ *
+ * @example
+ * Suppose `process.cwd()` is any one of the following,
+ *   - `/home/alex/myPackage`,
+ *   - `/home/alex/myPackage/src/MyModule`,
+ *   - `/home/alex/myPackage/resource/Images`,
+ *
+ * then,
+ *
+ * ```typescript
+ * import { Effect } from "effect";
+ * const Root: string = await Effect.runPromise(GetPackageRootDirectory());
+ * // `Root` <- `"/home/alex/myPackage"`
+ * ```
+ *
+ * @example
+ * Suppose `TestPath === "/home/alex/Documents"` is *not* a NodeJS package root
+ * (of course, neither are `/home/alex` or `/home`).  Then,
+ *
+ * ```typescript
+ * import { Effect } from "effect";
+ * const TestPath: string = "/home/alex/Documents";
+ * let Root: string | undefined = undefined;
+ * try
+ * {
+ *     Root = await Effect.runPromise(
+ *         GetPackageRootDirectory(TestPath)
+ *     );
+ * }
+ * catch (Error: unknown)
+ * {
+ *      // `Error instanceof RootDirectoryNotFound`
+ * }
+ *
+ * // `Root` <- `undefined`
+ * ```
+ *
+ * @example
+ * Suppose `process.cwd() === /home/alex/Downloads`, which is *not* a NodeJS package
+ * (of course, neither are `/home/alex` or `/home`).  Then,
+ *
+ * ```typescript
+ * import { Effect } from "effect";
+ * let Root: string | undefined = undefined;
+ * try
+ * {
+ *     Root = await Effect.runPromise(GetPackageRootDirectory());
+ * }
+ * catch (Error: unknown)
+ * {
+ *      // `Error instanceof RootDirectoryNotFound`
+ * }
+ * // `Root` <- `undefined`
+ * ```
+ */
+export declare function GetPackageRootDirectory(Path?: string): EGetPackageRootDirectory;
+//# sourceMappingURL=Npm.Effect.d.ts.map

package/Distribution/Types/Npm/Npm.Effect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Npm.Effect.d.ts","sourceRoot":"","sources":["../../../Source/Npm/Npm.Effect.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AASvF;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,cAAc,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,eAAe,CAyB7D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8DG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,wBAAwB,CA6C/E"}

package/Distribution/Types/Npm/Npm.Error.d.ts

@@ -10,8 +10,9 @@ declare const PackageJsonParseError_base: new <A extends Record<string, any> = {
 /**
  * An error describing that {@link GetPackageJson} failed to parse the discovered `package.json` file.
  *
- * @field Path - The `Path` argument passed to the effect returning this error, if one was given.
- * @field Cause - The cause of this error.
+ * @property {string | undefined} Path - The `Path` argument passed to the effect returning this error,
+ * if one was given.
+ * @property {unknown} Cause - The cause of this error.
  */
 export declare class PackageJsonParseError extends PackageJsonParseError_base<{
     readonly Path: string | undefined;
@@ -24,7 +25,8 @@ declare const RootDirectoryNotFoundError_base: new <A extends Record<string, any
 /**
  * An error describing that {@link GetPackageRootDirectory} failed.
  *
- * @field Path - The `Path` argument passed to the effect returning this error, if one was given.
+ * @property {string | undefined} Path - The `Path` argument passed to the effect returning
+ * this error, if one was given.
  */
 export declare class RootDirectoryNotFoundError extends RootDirectoryNotFoundError_base<{
     readonly Path: string | undefined;

package/Distribution/Types/Npm/Npm.Error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Npm.Error.d.ts","sourceRoot":"","sources":["../../../Source/Npm/Npm.Error.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;;;;AAIH;;;;;GAKG;AACH,qBAAa,qBAAsB,SAAQ,2BAA0C;IACjF,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CAC3B,CAAC;CAAI;;;;AAEN;;;;GAIG;AACH,qBAAa,0BAA2B,SAAQ,gCAA0C;IACtF,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;CACrC,CAAC;CAAI"}
+{"version":3,"file":"Npm.Error.d.ts","sourceRoot":"","sources":["../../../Source/Npm/Npm.Error.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;;;;AAIH;;;;;;GAMG;AACH,qBAAa,qBACT,SAAQ,2BAA0C;IAC9C,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CAC3B,CAAC;CAAI;;;;AAEV;;;;;GAKG;AACH,qBAAa,0BACT,SAAQ,gCAA0C;IAC9C,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;CACrC,CAAC;CAAI"}

package/Distribution/Types/Npm/Npm.d.ts

@@ -4,27 +4,39 @@
  * @copyright (c) 2026 Gage Sorrell
  * @license   MIT
  */
-import { RootDirectoryNotFoundError } from "./Npm.Error.ts";
-import { Effect } from "effect";
-import type { GetPackageJsonEffect } from "./Npm.Types.ts";
+import type { IPackageJson } from "package-json-type";
 /**
  * Get the `package.json` of the Node.js project in which the
  * given path, or the current working directory, resides.
  *
- * @param Path - *(Optional)* The given path from which to look for a root directory.
+ * @param Path - The given path from which to look for a root directory.
  *
- * @returns An Effect that succeeds with the parsed `package.json`, or fails
- * with {@link RootDirectoryNotFoundError} or {@link PackageJsonParseError}.
+ * @throws {RootDirectoryNotFoundError | PackageJsonParseError} An error
+ * describing either failure to identify a root directory, or failing to
+ * parse the discovered `package.json`.
+ *
+ * @returns {Promise<IPackageJson>} The {@link IPackageJson} of {@link Path}
+ * if provided, otherwise of `process.cwd()`.
+ *
+ * @example
+ * Suppose `process.cwd() === "./MyPackage"`,
+ * ```typescript
+ * const PackageJson: IPackageJson = await GetPackageJson();
+ * // `PackageJson` <- *The parsed `package.json` of `MyPackage`.*
+ * ```
  */
-export declare function GetPackageJson(Path?: string): GetPackageJsonEffect;
+export declare function GetPackageJson(Path?: string): Promise<IPackageJson>;
 /**
  * Get the root directory of the Node.js project in which the
  * current working directory resides.
  *
- * @param Path - *(Optional)* The given path from which to look for a root directory.
+ * @param Path - The given path from which to look for a root directory.
+ *
+ * @throws {RootDirectoryNotFoundError} An error iff the root directory
+ * of a NodeJS package could not be found.
  *
- * @returns An Effect that succeeds with the package root directory, or fails
- * with {@link RootDirectoryNotFoundError}.
+ * @returns {Promise<string>} The path to the root directory of the package
+ * containing {@link Path} if specified, otherwise containing `process.cwd()`.
  *
  * @example
  * Suppose `process.cwd()` is any one of the following,
@@ -35,8 +47,7 @@ export declare function GetPackageJson(Path?: string): GetPackageJsonEffect;
  * then,
  *
  * ```typescript
- * import { Effect } from "effect";
- * const Root: string = await Effect.runPromise(GetPackageRootDirectory());
+ * const Root: string = await GetPackageRootDirectory();
  * // `Root` <- `"/home/alex/myPackage"`
  * ```
  *
@@ -45,14 +56,11 @@ export declare function GetPackageJson(Path?: string): GetPackageJsonEffect;
  * (of course, neither are `/home/alex` or `/home`).  Then,
  *
  * ```typescript
- * import { Effect } from "effect";
  * const TestPath: string = "/home/alex/Documents";
  * let Root: string | undefined = undefined;
  * try
  * {
- *     Root = await Effect.runPromise(
- *         GetPackageRootDirectory(TestPath)
- *     );
+ *     Root = await GetPackageRootDirectory(TestPath);
  * }
  * catch (Error: unknown)
  * {
@@ -67,11 +75,10 @@ export declare function GetPackageJson(Path?: string): GetPackageJsonEffect;
  * (of course, neither are `/home/alex` or `/home`).  Then,
  *
  * ```typescript
- * import { Effect } from "effect";
  * let Root: string | undefined = undefined;
  * try
  * {
- *     Root = await Effect.runPromise(GetPackageRootDirectory());
+ *     Root = await GetPackageRootDirectory();
  * }
  * catch (Error: unknown)
  * {
@@ -80,5 +87,5 @@ export declare function GetPackageJson(Path?: string): GetPackageJsonEffect;
  * // `Root` <- `undefined`
  * ```
  */
-export declare function GetPackageRootDirectory(Path?: string): Effect.Effect<string, RootDirectoryNotFoundError, never>;
+export declare function GetPackageRootDirectory(Path?: string): Promise<string>;
 //# sourceMappingURL=Npm.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Npm.d.ts","sourceRoot":"","sources":["../../../Source/Npm/Npm.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAyB,0BAA0B,EAAE,MAAM,gBAAgB,CAAC;AAEnF,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAa3D;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAC1B,IAAI,CAAC,EAAE,MAAM,GACd,oBAAoB,CAyBtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8DG;AACH,wBAAgB,uBAAuB,CACnC,IAAI,CAAC,EAAE,MAAM,GACd,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,0BAA0B,EAAE,KAAK,CAAC,CA6C1D"}
+{"version":3,"file":"Npm.d.ts","sourceRoot":"","sources":["../../../Source/Npm/Npm.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGtD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,cAAc,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAoBzE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AACH,wBAAsB,uBAAuB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAmC5E"}

package/Distribution/Types/Npm/index.d.ts

@@ -12,5 +12,4 @@
  */
 export * from "./Npm.ts";
 export * from "./Npm.Error.ts";
-export * from "./Npm.Types.ts";
 //# sourceMappingURL=index.d.ts.map

package/Distribution/Types/Npm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../Source/Npm/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;GAKG;AAEH,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../Source/Npm/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;GAKG;AAEH,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC"}

package/License.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Gage Sorrell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/ReadMe.md

@@ -1,5 +1,5 @@
+*Copyright © 2026 Gage Sorrell.  Released under the [MIT license](./License.md).*
+
 # `@sorrell/utilities`
 
 **Purpose.** This package hosts general-purpose utility functions and types.
-
-

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sorrell/utilities",
-    "version": "1.1.59",
+    "version": "1.1.61",
     "private": false,
     "description": "Various TypeScript utilities.",
     "keywords": [
@@ -84,6 +84,12 @@
             "require": "./Distribution/CJS/npm.js",
             "default": "./Distribution/ESM/npm.js"
         },
+        "./npm/effect": {
+            "types": "./Distribution/Types/Npm/Index.Effect.d.ts",
+            "import": "./Distribution/ESM/npm-effect.js",
+            "require": "./Distribution/CJS/npm-effect.js",
+            "default": "./Distribution/ESM/npm-effect.js"
+        },
         "./math": {
             "types": "./Distribution/Types/Math/index.d.ts",
             "import": "./Distribution/ESM/math.js",
@@ -108,7 +114,6 @@
             "optional": true
         }
     },
-    "main": "./Distribution/ESM/index.js",
     "types": "./Distribution/Types/index.d.ts",
     "scripts": {
         "prepublish": "npm run build",
@@ -117,13 +122,10 @@
         "build": "npm run build:js && npm run build:types"
     },
     "devDependencies": {
-        "@rollup/plugin-node-resolve": "^16.0.3",
-        "@rollup/plugin-typescript": "^12.3.0",
         "@types/node": "^25.6.0",
         "clipboardy": "^5.3.1",
         "esbuild": "^0.28.0",
         "package-json-type": "^1.1.2",
-        "rollup": "^4.60.2",
         "tslib": "^2.8.1",
         "tsover": "^6.0.0",
         "tsover-runtime": "0.0.6"

package/Distribution/Types/Npm/Npm.Types.d.ts

@@ -1,11 +0,0 @@
-/**
- * @file      Npm.Types.ts
- * @author    Gage Sorrell <gage@sorrell.sh>
- * @copyright (c) 2026 Gage Sorrell
- * @license   MIT
- */
-import type { PackageJsonParseError, RootDirectoryNotFoundError } from "./Npm.Error.ts";
-import type { Effect } from "effect";
-import type { IPackageJson } from "package-json-type";
-export type GetPackageJsonEffect = Effect.Effect<IPackageJson, PackageJsonParseError | RootDirectoryNotFoundError, never>;
-//# sourceMappingURL=Npm.Types.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"Npm.Types.d.ts","sourceRoot":"","sources":["../../../Source/Npm/Npm.Types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,MAAM,gBAAgB,CAAC;AACxF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtD,MAAM,MAAM,oBAAoB,GAC5B,MAAM,CAAC,MAAM,CACT,YAAY,EACZ,qBAAqB,GAAG,0BAA0B,EAClD,KAAK,CACR,CAAC"}