@alextheman/utility 5.1.0 → 5.1.2

package/dist/internal/index.cjs

@@ -26,10 +26,10 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 }) : target, mod));
 
 //#endregion
-let execa = require("execa");
 let zod = require("zod");
 zod = __toESM(zod);
 require("libsodium-wrappers");
+let execa = require("execa");
 let node_fs_promises = require("node:fs/promises");
 let node_path = require("node:path");
 node_path = __toESM(node_path);
@@ -605,6 +605,25 @@ const VersionType = {
 	PATCH: "patch"
 };
 
+//#endregion
+//#region src/internal/getDependenciesFromGroup.ts
+/**
+* Get the dependencies from a given dependency group in `package.json`.
+*
+* @category Miscellaneous
+*
+* @param packageInfo - The data coming from `package.json`.
+* @param dependencyGroup - The group to get dependency information about (can be `dependencies` or `devDependencies`).
+*
+* @returns A record consisting of the package names and version ranges from the given dependency group.
+*/
+function getDependenciesFromGroup(packageInfo, dependencyGroup) {
+	return {
+		dependencies: parseZodSchema(zod.default.record(zod.default.string(), zod.default.string()), packageInfo.dependencies ?? {}),
+		devDependencies: parseZodSchema(zod.default.record(zod.default.string(), zod.default.string()), packageInfo.devDependencies ?? {})
+	}[dependencyGroup];
+}
+
 //#endregion
 //#region src/internal/getExpectedTgzName.ts
 async function getExpectedTgzName(packagePath, packageManager) {
@@ -683,6 +702,8 @@ async function setupPackageEndToEnd(temporaryPath, packageManager, moduleType, o
 	if (packageInfo === null) throw packageJsonNotFoundError(temporaryPath);
 	packageInfo.type = moduleType === ModuleType.TYPESCRIPT ? ModuleType.ES_MODULES : moduleType;
 	await (0, node_fs_promises.writeFile)(node_path.default.join(temporaryPath, "package.json"), JSON.stringify(packageInfo, null, 2));
+	if (options?.additionalDependencies?.dependencies?.length) await runCommandInTempDirectory`${packageManager} install ${options.additionalDependencies.dependencies.join(" ")}`;
+	if (options?.additionalDependencies?.devDependencies?.length) await runCommandInTempDirectory`${packageManager} install --save-dev ${options.additionalDependencies.devDependencies.join(" ")}`;
 	await runCommandInTempDirectory`${packageManager} install ${dependencyGroup === "devDependencies" ? "--save-dev" : "--save-prod"} ${node_path.default.join(temporaryPath, tgzFileName)}`;
 	return runCommandInTempDirectory;
 }
@@ -691,6 +712,7 @@ async function setupPackageEndToEnd(temporaryPath, packageManager, moduleType, o
 exports.DependencyGroup = DependencyGroup;
 exports.ModuleType = ModuleType;
 exports.PackageManager = PackageManager;
+exports.getDependenciesFromGroup = getDependenciesFromGroup;
 exports.getExpectedTgzName = getExpectedTgzName;
 exports.getPackageJsonContents = getPackageJsonContents;
 exports.getPackageJsonPath = getPackageJsonPath;

package/dist/internal/index.d.cts

@@ -1,5 +1,18 @@
 import { ExecaMethod } from "execa";
 
+//#region src/internal/getDependenciesFromGroup.d.ts
+/**
+ * Get the dependencies from a given dependency group in `package.json`.
+ *
+ * @category Miscellaneous
+ *
+ * @param packageInfo - The data coming from `package.json`.
+ * @param dependencyGroup - The group to get dependency information about (can be `dependencies` or `devDependencies`).
+ *
+ * @returns A record consisting of the package names and version ranges from the given dependency group.
+ */
+declare function getDependenciesFromGroup(packageInfo: Record<string, unknown>, dependencyGroup: DependencyGroup): Record<string, string>;
+//#endregion
 //#region src/root/types/RecordKey.d.ts
 /**
  * Represents the native Record's possible key type.
@@ -99,9 +112,10 @@ declare function parseJsonFromStdout(stdout: string): Record<string, unknown>;
 //#region src/internal/setupPackageEndToEnd.d.ts
 interface SetupPackageEndToEndOptions {
   dependencyGroup?: DependencyGroup;
+  additionalDependencies?: Record<DependencyGroup, string[]>;
 }
 declare function setupPackageEndToEnd(temporaryPath: string, packageManager: PackageManager, moduleType: ModuleType, options?: SetupPackageEndToEndOptions): Promise<ExecaMethod<{
   cwd: string;
 }>>;
 //#endregion
-export { DependencyGroup, type IsTypeArgumentString, ModuleType, PackageManager, getExpectedTgzName, getPackageJsonContents, getPackageJsonPath, packageJsonNotFoundError, parseJsonFromStdout, sayHello, setupPackageEndToEnd };
+export { DependencyGroup, type IsTypeArgumentString, ModuleType, PackageManager, getDependenciesFromGroup, getExpectedTgzName, getPackageJsonContents, getPackageJsonPath, packageJsonNotFoundError, parseJsonFromStdout, sayHello, setupPackageEndToEnd };

package/dist/internal/index.d.ts

@@ -1,6 +1,19 @@
-import { ExecaMethod } from "execa";
 import z from "zod";
+import { ExecaMethod } from "execa";
 
+//#region src/internal/getDependenciesFromGroup.d.ts
+/**
+ * Get the dependencies from a given dependency group in `package.json`.
+ *
+ * @category Miscellaneous
+ *
+ * @param packageInfo - The data coming from `package.json`.
+ * @param dependencyGroup - The group to get dependency information about (can be `dependencies` or `devDependencies`).
+ *
+ * @returns A record consisting of the package names and version ranges from the given dependency group.
+ */
+declare function getDependenciesFromGroup(packageInfo: Record<string, unknown>, dependencyGroup: DependencyGroup): Record<string, string>;
+//#endregion
 //#region src/root/types/RecordKey.d.ts
 /**
  * Represents the native Record's possible key type.
@@ -100,9 +113,10 @@ declare function parseJsonFromStdout(stdout: string): Record<string, unknown>;
 //#region src/internal/setupPackageEndToEnd.d.ts
 interface SetupPackageEndToEndOptions {
   dependencyGroup?: DependencyGroup;
+  additionalDependencies?: Record<DependencyGroup, string[]>;
 }
 declare function setupPackageEndToEnd(temporaryPath: string, packageManager: PackageManager, moduleType: ModuleType, options?: SetupPackageEndToEndOptions): Promise<ExecaMethod<{
   cwd: string;
 }>>;
 //#endregion
-export { DependencyGroup, type IsTypeArgumentString, ModuleType, PackageManager, getExpectedTgzName, getPackageJsonContents, getPackageJsonPath, packageJsonNotFoundError, parseJsonFromStdout, sayHello, setupPackageEndToEnd };
+export { DependencyGroup, type IsTypeArgumentString, ModuleType, PackageManager, getDependenciesFromGroup, getExpectedTgzName, getPackageJsonContents, getPackageJsonPath, packageJsonNotFoundError, parseJsonFromStdout, sayHello, setupPackageEndToEnd };

package/dist/internal/index.js

@@ -1,6 +1,6 @@
-import { execa } from "execa";
 import z from "zod";
 import "libsodium-wrappers";
+import { execa } from "execa";
 import { readFile, writeFile } from "node:fs/promises";
 import path from "node:path";
 
@@ -575,6 +575,25 @@ const VersionType = {
 	PATCH: "patch"
 };
 
+//#endregion
+//#region src/internal/getDependenciesFromGroup.ts
+/**
+* Get the dependencies from a given dependency group in `package.json`.
+*
+* @category Miscellaneous
+*
+* @param packageInfo - The data coming from `package.json`.
+* @param dependencyGroup - The group to get dependency information about (can be `dependencies` or `devDependencies`).
+*
+* @returns A record consisting of the package names and version ranges from the given dependency group.
+*/
+function getDependenciesFromGroup(packageInfo, dependencyGroup) {
+	return {
+		dependencies: parseZodSchema(z.record(z.string(), z.string()), packageInfo.dependencies ?? {}),
+		devDependencies: parseZodSchema(z.record(z.string(), z.string()), packageInfo.devDependencies ?? {})
+	}[dependencyGroup];
+}
+
 //#endregion
 //#region src/internal/getExpectedTgzName.ts
 async function getExpectedTgzName(packagePath, packageManager) {
@@ -653,9 +672,11 @@ async function setupPackageEndToEnd(temporaryPath, packageManager, moduleType, o
 	if (packageInfo === null) throw packageJsonNotFoundError(temporaryPath);
 	packageInfo.type = moduleType === ModuleType.TYPESCRIPT ? ModuleType.ES_MODULES : moduleType;
 	await writeFile(path.join(temporaryPath, "package.json"), JSON.stringify(packageInfo, null, 2));
+	if (options?.additionalDependencies?.dependencies?.length) await runCommandInTempDirectory`${packageManager} install ${options.additionalDependencies.dependencies.join(" ")}`;
+	if (options?.additionalDependencies?.devDependencies?.length) await runCommandInTempDirectory`${packageManager} install --save-dev ${options.additionalDependencies.devDependencies.join(" ")}`;
 	await runCommandInTempDirectory`${packageManager} install ${dependencyGroup === "devDependencies" ? "--save-dev" : "--save-prod"} ${path.join(temporaryPath, tgzFileName)}`;
 	return runCommandInTempDirectory;
 }
 
 //#endregion
-export { DependencyGroup, ModuleType, PackageManager, getExpectedTgzName, getPackageJsonContents, getPackageJsonPath, packageJsonNotFoundError, parseJsonFromStdout, sayHello_default as sayHello, setupPackageEndToEnd };
+export { DependencyGroup, ModuleType, PackageManager, getDependenciesFromGroup, getExpectedTgzName, getPackageJsonContents, getPackageJsonPath, packageJsonNotFoundError, parseJsonFromStdout, sayHello_default as sayHello, setupPackageEndToEnd };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/utility",
-  "version": "5.1.0",
+  "version": "5.1.2",
   "description": "Helpful utility functions.",
   "repository": {
     "type": "git",
@@ -36,7 +36,7 @@
     "zod": "^4.3.6"
   },
   "devDependencies": {
-    "@alextheman/eslint-plugin": "^5.7.0",
+    "@alextheman/eslint-plugin": "^5.7.1",
     "@types/node": "^25.2.3",
     "alex-c-line": "^1.26.2",
     "dotenv-cli": "^11.0.0",