@alextheman/utility 5.0.0 → 5.1.0

package/dist/index.cjs

@@ -28,8 +28,6 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 //#endregion
 let zod = require("zod");
 zod = __toESM(zod);
-let node_path = require("node:path");
-node_path = __toESM(node_path);
 let libsodium_wrappers = require("libsodium-wrappers");
 libsodium_wrappers = __toESM(libsodium_wrappers);
 
@@ -615,6 +613,25 @@ function isMonthlyMultiple(firstDate, secondDate) {
 	return firstDate.getDate() === secondDate.getDate();
 }
 
+//#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/root/functions/miscellaneous/convertFileToBase64.ts
 /**
@@ -714,25 +731,6 @@ function createFormData(data, options = {
 	return formData;
 }
 
-//#endregion
-//#region src/root/functions/miscellaneous/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/root/functions/miscellaneous/isOrdered.ts
 /**
@@ -1333,37 +1331,6 @@ function parseEnv(input) {
 	return parseZodSchema(zod.z.enum(Env), input, new DataError({ input }, "INVALID_ENV", "The provided environment type must be one of `test | development | production`"));
 }
 
-//#endregion
-//#region src/root/functions/parsers/parseFilePath.ts
-/**
-* Takes a file path string and parses it into the directory part, the base part, and the full path.
-*
-* @category Parsers
-*
-* @param filePath - The file path to parse.
-*
-* @throws {DataError} If the file path is invalid.
-*
-* @returns An object representing the different ways the file path can be represented.
-*/
-function parseFilePath(filePath) {
-	const caughtGroups = filePath.match(RegExp(FILE_PATH_REGEX));
-	if (!caughtGroups) {
-		if (!(filePath.includes("/") || filePath.includes("\\")) && filePath.includes(".")) return {
-			directory: "",
-			base: filePath,
-			fullPath: filePath
-		};
-		throw new DataError({ filePath }, "INVALID_FILE_PATH", "The file path you provided is not valid.");
-	}
-	if (!caughtGroups.groups) throw new DataError({ filePath }, "PARSING_ERROR", "An error occurred while trying to parse the data.");
-	return {
-		directory: caughtGroups.groups.directory,
-		base: caughtGroups.groups.base,
-		fullPath: node_path.default.join(caughtGroups.groups.directory.replaceAll("\\", "/"), caughtGroups.groups.base)
-	};
-}
-
 //#endregion
 //#region src/root/functions/parsers/parseFormData.ts
 /**
@@ -1639,7 +1606,6 @@ exports.omitProperties = omitProperties;
 exports.paralleliseArrays = paralleliseArrays;
 exports.parseBoolean = parseBoolean;
 exports.parseEnv = parseEnv;
-exports.parseFilePath = parseFilePath;
 exports.parseFormData = parseFormData;
 exports.parseIntStrict = parseIntStrict;
 exports.parseVersionType = parseVersionType;

package/dist/index.d.cts

@@ -190,6 +190,26 @@ declare function isMonthlyMultiple(firstDate: Date, secondDate: Date): boolean;
  */
 declare function isSameDate(firstDate: Date, secondDate: Date): boolean;
 //#endregion
+//#region src/internal/DependencyGroup.d.ts
+declare const DependencyGroup: {
+  readonly DEPENDENCIES: "dependencies";
+  readonly DEV_DEPENDENCIES: "devDependencies";
+};
+type DependencyGroup = CreateEnumType<typeof DependencyGroup>;
+//#endregion
+//#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/functions/miscellaneous/convertFileToBase64.d.ts
 /**
  * Asynchronously converts a file to a base 64 string
@@ -498,24 +518,6 @@ type CreateFormDataOptions<Key extends RecordKey> = CreateFormDataOptionsUndefin
  */
 declare function createFormData<DataType extends Record<RecordKey, unknown>>(data: DataType, options?: CreateFormDataOptions<keyof DataType>): FormData;
 //#endregion
-//#region src/root/functions/miscellaneous/getDependenciesFromGroup.d.ts
-declare const DependencyGroup: {
-  readonly DEPENDENCIES: "dependencies";
-  readonly DEV_DEPENDENCIES: "devDependencies";
-};
-type DependencyGroup = CreateEnumType<typeof DependencyGroup>;
-/**
- * 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/functions/miscellaneous/getRandomNumber.d.ts
 /**
  * Gets a random number between the given bounds.
@@ -688,28 +690,6 @@ type Env = CreateEnumType<typeof Env>;
  */
 declare function parseEnv(input: unknown): Env;
 //#endregion
-//#region src/root/functions/parsers/parseFilePath.d.ts
-interface FilePathData {
-  /** The file path without the final part. */
-  directory: string;
-  /** The final part of the file path. */
-  base: string;
-  /** The full file path, normalised. */
-  fullPath: string;
-}
-/**
- * Takes a file path string and parses it into the directory part, the base part, and the full path.
- *
- * @category Parsers
- *
- * @param filePath - The file path to parse.
- *
- * @throws {DataError} If the file path is invalid.
- *
- * @returns An object representing the different ways the file path can be represented.
- */
-declare function parseFilePath(filePath: string): FilePathData;
-//#endregion
 //#region src/root/functions/parsers/parseFormData.d.ts
 /**
  * Returns a parsed object given FormData and a data parser function to call on the resulting object.
@@ -1092,4 +1072,4 @@ declare function normaliseIndents(strings: TemplateStringsArray, ...interpolatio
  */
 declare const normalizeIndents: typeof normaliseIndents;
 //#endregion
-export { APIError, ArrayElement, CallReturnType, CamelToKebabOptions, CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FILE_PATH_REGEX, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, IsTypeArgumentString, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParallelTuple, RecordKey, RemoveUndefined, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, FormatOptionsBase as VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, encryptWithKey, fillArray, formatDateAndTime, getDependenciesFromGroup, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFilePath, parseFormData, parseIntStrict, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, truncate, wait, zodVersionNumber };
+export { APIError, ArrayElement, CallReturnType, CamelToKebabOptions, CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FILE_PATH_REGEX, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, IsTypeArgumentString, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParallelTuple, RecordKey, RemoveUndefined, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, FormatOptionsBase as VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, encryptWithKey, fillArray, formatDateAndTime, getDependenciesFromGroup, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, truncate, wait, zodVersionNumber };

package/dist/index.d.ts

@@ -190,6 +190,26 @@ declare function isMonthlyMultiple(firstDate: Date, secondDate: Date): boolean;
  */
 declare function isSameDate(firstDate: Date, secondDate: Date): boolean;
 //#endregion
+//#region src/internal/DependencyGroup.d.ts
+declare const DependencyGroup: {
+  readonly DEPENDENCIES: "dependencies";
+  readonly DEV_DEPENDENCIES: "devDependencies";
+};
+type DependencyGroup = CreateEnumType<typeof DependencyGroup>;
+//#endregion
+//#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/functions/miscellaneous/convertFileToBase64.d.ts
 /**
  * Asynchronously converts a file to a base 64 string
@@ -498,24 +518,6 @@ type CreateFormDataOptions<Key extends RecordKey> = CreateFormDataOptionsUndefin
  */
 declare function createFormData<DataType extends Record<RecordKey, unknown>>(data: DataType, options?: CreateFormDataOptions<keyof DataType>): FormData;
 //#endregion
-//#region src/root/functions/miscellaneous/getDependenciesFromGroup.d.ts
-declare const DependencyGroup: {
-  readonly DEPENDENCIES: "dependencies";
-  readonly DEV_DEPENDENCIES: "devDependencies";
-};
-type DependencyGroup = CreateEnumType<typeof DependencyGroup>;
-/**
- * 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/functions/miscellaneous/getRandomNumber.d.ts
 /**
  * Gets a random number between the given bounds.
@@ -688,28 +690,6 @@ type Env = CreateEnumType<typeof Env>;
  */
 declare function parseEnv(input: unknown): Env;
 //#endregion
-//#region src/root/functions/parsers/parseFilePath.d.ts
-interface FilePathData {
-  /** The file path without the final part. */
-  directory: string;
-  /** The final part of the file path. */
-  base: string;
-  /** The full file path, normalised. */
-  fullPath: string;
-}
-/**
- * Takes a file path string and parses it into the directory part, the base part, and the full path.
- *
- * @category Parsers
- *
- * @param filePath - The file path to parse.
- *
- * @throws {DataError} If the file path is invalid.
- *
- * @returns An object representing the different ways the file path can be represented.
- */
-declare function parseFilePath(filePath: string): FilePathData;
-//#endregion
 //#region src/root/functions/parsers/parseFormData.d.ts
 /**
  * Returns a parsed object given FormData and a data parser function to call on the resulting object.
@@ -1092,4 +1072,4 @@ declare function normaliseIndents(strings: TemplateStringsArray, ...interpolatio
  */
 declare const normalizeIndents: typeof normaliseIndents;
 //#endregion
-export { APIError, type ArrayElement, type CallReturnType, CamelToKebabOptions, type CreateEnumType, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, Env, FILE_PATH_REGEX, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IsTypeArgumentString, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, type NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, type OptionalOnCondition, ParallelTuple, type RecordKey, type RemoveUndefined, type StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, type FormatOptionsBase as VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, encryptWithKey, fillArray, formatDateAndTime, getDependenciesFromGroup, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFilePath, parseFormData, parseIntStrict, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, truncate, wait, zodVersionNumber };
+export { APIError, type ArrayElement, type CallReturnType, CamelToKebabOptions, type CreateEnumType, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, Env, FILE_PATH_REGEX, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IsTypeArgumentString, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, type NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, type OptionalOnCondition, ParallelTuple, type RecordKey, type RemoveUndefined, type StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, type FormatOptionsBase as VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, encryptWithKey, fillArray, formatDateAndTime, getDependenciesFromGroup, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, truncate, wait, zodVersionNumber };

package/dist/index.js

@@ -1,5 +1,4 @@
 import z, { z as z$1 } from "zod";
-import path from "node:path";
 import sodium from "libsodium-wrappers";
 
 //#region src/root/constants/FILE_PATH_REGEX.ts
@@ -584,6 +583,25 @@ function isMonthlyMultiple(firstDate, secondDate) {
 	return firstDate.getDate() === secondDate.getDate();
 }
 
+//#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/root/functions/miscellaneous/convertFileToBase64.ts
 /**
@@ -683,25 +701,6 @@ function createFormData(data, options = {
 	return formData;
 }
 
-//#endregion
-//#region src/root/functions/miscellaneous/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/root/functions/miscellaneous/isOrdered.ts
 /**
@@ -1302,37 +1301,6 @@ function parseEnv(input) {
 	return parseZodSchema(z$1.enum(Env), input, new DataError({ input }, "INVALID_ENV", "The provided environment type must be one of `test | development | production`"));
 }
 
-//#endregion
-//#region src/root/functions/parsers/parseFilePath.ts
-/**
-* Takes a file path string and parses it into the directory part, the base part, and the full path.
-*
-* @category Parsers
-*
-* @param filePath - The file path to parse.
-*
-* @throws {DataError} If the file path is invalid.
-*
-* @returns An object representing the different ways the file path can be represented.
-*/
-function parseFilePath(filePath) {
-	const caughtGroups = filePath.match(RegExp(FILE_PATH_REGEX));
-	if (!caughtGroups) {
-		if (!(filePath.includes("/") || filePath.includes("\\")) && filePath.includes(".")) return {
-			directory: "",
-			base: filePath,
-			fullPath: filePath
-		};
-		throw new DataError({ filePath }, "INVALID_FILE_PATH", "The file path you provided is not valid.");
-	}
-	if (!caughtGroups.groups) throw new DataError({ filePath }, "PARSING_ERROR", "An error occurred while trying to parse the data.");
-	return {
-		directory: caughtGroups.groups.directory,
-		base: caughtGroups.groups.base,
-		fullPath: path.join(caughtGroups.groups.directory.replaceAll("\\", "/"), caughtGroups.groups.base)
-	};
-}
-
 //#endregion
 //#region src/root/functions/parsers/parseFormData.ts
 /**
@@ -1569,4 +1537,4 @@ function truncate(stringToTruncate, maxLength = 5) {
 }
 
 //#endregion
-export { APIError, DataError, Env, FILE_PATH_REGEX, NAMESPACE_EXPORT_REGEX, VERSION_NUMBER_REGEX, VersionNumber, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, encryptWithKey, fillArray, formatDateAndTime, getDependenciesFromGroup, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFilePath, parseFormData, parseIntStrict, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, truncate, wait, zodVersionNumber };
+export { APIError, DataError, Env, FILE_PATH_REGEX, NAMESPACE_EXPORT_REGEX, VERSION_NUMBER_REGEX, VersionNumber, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, encryptWithKey, fillArray, formatDateAndTime, getDependenciesFromGroup, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, truncate, wait, zodVersionNumber };

package/dist/internal/index.cjs

@@ -29,11 +29,18 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 let execa = require("execa");
 let zod = require("zod");
 zod = __toESM(zod);
-let node_path = require("node:path");
-node_path = __toESM(node_path);
 require("libsodium-wrappers");
 let node_fs_promises = require("node:fs/promises");
+let node_path = require("node:path");
+node_path = __toESM(node_path);
+
+//#region src/internal/DependencyGroup.ts
+const DependencyGroup = {
+	DEPENDENCIES: "dependencies",
+	DEV_DEPENDENCIES: "devDependencies"
+};
 
+//#endregion
 //#region src/root/functions/arrayHelpers/fillArray.ts
 /**
 * Creates a new array where each element is the result of the provided callback.
@@ -626,6 +633,27 @@ async function getPackageJsonContents(directory) {
 	}
 }
 
+//#endregion
+//#region src/internal/ModuleType.ts
+const ModuleType = {
+	COMMON_JS: "commonjs",
+	ES_MODULES: "module",
+	TYPESCRIPT: "typescript"
+};
+
+//#endregion
+//#region src/internal/packageJsonNotFoundError.ts
+function packageJsonNotFoundError(packagePath) {
+	return new DataError({ packagePath: getPackageJsonPath(packagePath) }, "PACKAGE_JSON_NOT_FOUND", "Could not find package.json in directory.");
+}
+
+//#endregion
+//#region src/internal/PackageManager.ts
+const PackageManager = {
+	NPM: "npm",
+	PNPM: "pnpm"
+};
+
 //#endregion
 //#region src/internal/parseJsonFromStdout.ts
 function parseJsonFromStdout(stdout) {
@@ -643,8 +671,30 @@ function parseJsonFromStdout(stdout) {
 var sayHello_default = sayHello;
 
 //#endregion
+//#region src/internal/setupPackageEndToEnd.ts
+async function setupPackageEndToEnd(temporaryPath, packageManager, moduleType, options) {
+	const { dependencyGroup = "dependencies" } = options ?? {};
+	await (0, execa.execa)({ cwd: process.cwd() })`${packageManager} pack --pack-destination ${temporaryPath}`;
+	const tgzFileName = await getExpectedTgzName(process.cwd(), packageManager);
+	const runCommandInTempDirectory = (0, execa.execa)({ cwd: temporaryPath });
+	if (packageManager === PackageManager.NPM) await runCommandInTempDirectory`npm init -y`;
+	else await runCommandInTempDirectory`pnpm init`;
+	const packageInfo = await getPackageJsonContents(temporaryPath);
+	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));
+	await runCommandInTempDirectory`${packageManager} install ${dependencyGroup === "devDependencies" ? "--save-dev" : "--save-prod"} ${node_path.default.join(temporaryPath, tgzFileName)}`;
+	return runCommandInTempDirectory;
+}
+
+//#endregion
+exports.DependencyGroup = DependencyGroup;
+exports.ModuleType = ModuleType;
+exports.PackageManager = PackageManager;
 exports.getExpectedTgzName = getExpectedTgzName;
 exports.getPackageJsonContents = getPackageJsonContents;
 exports.getPackageJsonPath = getPackageJsonPath;
+exports.packageJsonNotFoundError = packageJsonNotFoundError;
 exports.parseJsonFromStdout = parseJsonFromStdout;
-exports.sayHello = sayHello_default;
+exports.sayHello = sayHello_default;
+exports.setupPackageEndToEnd = setupPackageEndToEnd;

package/dist/internal/index.d.cts

@@ -1,14 +1,50 @@
-//#region src/internal/getExpectedTgzName.d.ts
-declare function getExpectedTgzName(packagePath: string, packageManager: string): Promise<string>;
-//#endregion
-//#region src/internal/getPackageJsonContents.d.ts
-declare function getPackageJsonContents(directory: string): Promise<Record<string, any> | null>;
+import { ExecaMethod } from "execa";
+
+//#region src/root/types/RecordKey.d.ts
+/**
+ * Represents the native Record's possible key type.
+ *
+ * @category Types
+ */
+type RecordKey = string | number | symbol;
 //#endregion
-//#region src/internal/getPackageJsonPath.d.ts
-declare function getPackageJsonPath(directory: string): string;
+//#region src/root/types/DataError.d.ts
+/**
+ * Represents errors you may get that may've been caused by a specific piece of data.
+ *
+ * @category Types
+ *
+ * @template DataType - The type of the data that caused the error.
+ */
+declare class DataError<DataType extends Record<RecordKey, unknown> = Record<RecordKey, unknown>> extends Error {
+  code: string;
+  data: DataType;
+  /**
+   * @param data - The data that caused the error.
+   * @param code - A standardised code (e.g. UNEXPECTED_DATA).
+   * @param message  - A human-readable error message (e.g. The data provided is invalid).
+   * @param options - Extra options to pass to super Error constructor.
+   */
+  constructor(data: DataType, code?: string, message?: string, options?: ErrorOptions);
+  /**
+   * Checks whether the given input may have been caused by a DataError.
+   *
+   * @param input - The input to check.
+   *
+   * @returns `true` if the input is a DataError, and `false` otherwise. The type of the input will also be narrowed down to DataError if `true`.
+   */
+  static check<DataType extends Record<RecordKey, unknown> = Record<RecordKey, unknown>>(input: unknown): input is DataError<DataType>;
+}
 //#endregion
-//#region src/internal/parseJsonFromStdout.d.ts
-declare function parseJsonFromStdout(stdout: string): Record<string, unknown>;
+//#region src/root/types/CreateEnumType.d.ts
+/**
+ * Get the value types from a const object so the object can behave similarly to an enum.
+ *
+ * @category Types
+ *
+ * @template ObjectType - The type of the object to get the value types for.
+ */
+type CreateEnumType<ObjectType extends Record<RecordKey, unknown>> = ObjectType[keyof ObjectType];
 //#endregion
 //#region src/root/types/IsTypeArgumentString.d.ts
 type IsTypeArgumentString<Argument extends string> = Argument;
@@ -23,4 +59,49 @@ type IsTypeArgumentString<Argument extends string> = Argument;
  */
 declare function sayHello(): string;
 //#endregion
-export { type IsTypeArgumentString, getExpectedTgzName, getPackageJsonContents, getPackageJsonPath, parseJsonFromStdout, sayHello };
+//#region src/internal/DependencyGroup.d.ts
+declare const DependencyGroup: {
+  readonly DEPENDENCIES: "dependencies";
+  readonly DEV_DEPENDENCIES: "devDependencies";
+};
+type DependencyGroup = CreateEnumType<typeof DependencyGroup>;
+//#endregion
+//#region src/internal/getExpectedTgzName.d.ts
+declare function getExpectedTgzName(packagePath: string, packageManager: string): Promise<string>;
+//#endregion
+//#region src/internal/getPackageJsonContents.d.ts
+declare function getPackageJsonContents(directory: string): Promise<Record<string, any> | null>;
+//#endregion
+//#region src/internal/getPackageJsonPath.d.ts
+declare function getPackageJsonPath(directory: string): string;
+//#endregion
+//#region src/internal/ModuleType.d.ts
+declare const ModuleType: {
+  readonly COMMON_JS: "commonjs";
+  readonly ES_MODULES: "module";
+  readonly TYPESCRIPT: "typescript";
+};
+type ModuleType = CreateEnumType<typeof ModuleType>;
+//#endregion
+//#region src/internal/packageJsonNotFoundError.d.ts
+declare function packageJsonNotFoundError(packagePath: string): DataError;
+//#endregion
+//#region src/internal/PackageManager.d.ts
+declare const PackageManager: {
+  readonly NPM: "npm";
+  readonly PNPM: "pnpm";
+};
+type PackageManager = CreateEnumType<typeof PackageManager>;
+//#endregion
+//#region src/internal/parseJsonFromStdout.d.ts
+declare function parseJsonFromStdout(stdout: string): Record<string, unknown>;
+//#endregion
+//#region src/internal/setupPackageEndToEnd.d.ts
+interface SetupPackageEndToEndOptions {
+  dependencyGroup?: DependencyGroup;
+}
+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 };