@alextheman/utility 5.5.0 → 5.6.1

package/dist/index.d.cts

@@ -467,6 +467,17 @@ type IsTypeArgumentString<Argument extends string> = Argument;
  */
 type NonUndefined<InputType> = InputType extends undefined ? never : InputType;
 //#endregion
+//#region src/root/types/NullableOnCondition.d.ts
+/**
+ * Resolves to the given type if the first type is `true`, otherwise resolves to `null`
+ *
+ * @category Types
+ *
+ * @param Condition - The condition to check.
+ * @param ResolvedTypeIfTrue - The type to resolve to if the condition may be `true`.
+ */
+type NullableOnCondition<Condition extends boolean, ResolvedTypeIfTrue> = Condition extends true ? ResolvedTypeIfTrue : ResolvedTypeIfTrue | null;
+//#endregion
 //#region src/root/types/OptionalOnCondition.d.ts
 /**
  * Resolves to the given type if the first type is `true`, otherwise resolves to `undefined`
@@ -1112,4 +1123,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_PATTERN, FILE_PATH_REGEX, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, IsTypeArgumentString, KebabToCamelOptions, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, ONE_DAY_IN_MILLISECONDS, OptionalOnCondition, ParallelTuple, RecordKey, RemoveUndefined, StringListToArrayOptions, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, FormatOptionsBase as VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, calculateMonthlyDifference, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, encryptWithKey, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, 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_PATTERN, FILE_PATH_REGEX, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, IsTypeArgumentString, KebabToCamelOptions, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, NullableOnCondition, ONE_DAY_IN_MILLISECONDS, OptionalOnCondition, ParallelTuple, RecordKey, RemoveUndefined, StringListToArrayOptions, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, FormatOptionsBase as VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, calculateMonthlyDifference, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, encryptWithKey, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, truncate, wait, zodVersionNumber };

package/dist/index.d.ts

@@ -467,6 +467,17 @@ type IsTypeArgumentString<Argument extends string> = Argument;
  */
 type NonUndefined<InputType> = InputType extends undefined ? never : InputType;
 //#endregion
+//#region src/root/types/NullableOnCondition.d.ts
+/**
+ * Resolves to the given type if the first type is `true`, otherwise resolves to `null`
+ *
+ * @category Types
+ *
+ * @param Condition - The condition to check.
+ * @param ResolvedTypeIfTrue - The type to resolve to if the condition may be `true`.
+ */
+type NullableOnCondition<Condition extends boolean, ResolvedTypeIfTrue> = Condition extends true ? ResolvedTypeIfTrue : ResolvedTypeIfTrue | null;
+//#endregion
 //#region src/root/types/OptionalOnCondition.d.ts
 /**
  * Resolves to the given type if the first type is `true`, otherwise resolves to `undefined`
@@ -1112,4 +1123,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_PATTERN, FILE_PATH_REGEX, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IsTypeArgumentString, KebabToCamelOptions, type NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, ONE_DAY_IN_MILLISECONDS, type OptionalOnCondition, ParallelTuple, type RecordKey, type RemoveUndefined, type StringListToArrayOptions, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, type FormatOptionsBase as VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, calculateMonthlyDifference, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, encryptWithKey, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, 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_PATTERN, FILE_PATH_REGEX, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IsTypeArgumentString, KebabToCamelOptions, type NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, type NullableOnCondition, ONE_DAY_IN_MILLISECONDS, type OptionalOnCondition, ParallelTuple, type RecordKey, type RemoveUndefined, type StringListToArrayOptions, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, type FormatOptionsBase as VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, calculateMonthlyDifference, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, encryptWithKey, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, truncate, wait, zodVersionNumber };

package/dist/internal/index.cjs

@@ -701,13 +701,21 @@ function getPackageJsonPath(directory) {
 	return node_path.default.join(...directory.endsWith("package.json") ? [directory] : [directory, "package.json"]);
 }
 
+//#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/getPackageJsonContents.ts
-async function getPackageJsonContents(directory) {
+async function getPackageJsonContents(directory, options) {
+	const { strict = true } = options ?? {};
 	try {
 		return JSON.parse(await (0, node_fs_promises.readFile)(getPackageJsonPath(directory), "utf-8"));
 	} catch (error) {
-		if (error instanceof Error && "code" in error && error.code === "ENOENT") return null;
+		if (error instanceof Error && "code" in error && error.code === "ENOENT") if (strict) throw packageJsonNotFoundError(directory);
+		else return null;
 		throw error;
 	}
 }
@@ -720,12 +728,6 @@ const ModuleType = {
 	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 = {

package/dist/internal/index.d.cts

@@ -77,6 +77,17 @@ type CreateEnumType<ObjectType extends Record<RecordKey, unknown>> = ObjectType[
 //#region src/root/types/IsTypeArgumentString.d.ts
 type IsTypeArgumentString<Argument extends string> = Argument;
 //#endregion
+//#region src/root/types/NullableOnCondition.d.ts
+/**
+ * Resolves to the given type if the first type is `true`, otherwise resolves to `null`
+ *
+ * @category Types
+ *
+ * @param Condition - The condition to check.
+ * @param ResolvedTypeIfTrue - The type to resolve to if the condition may be `true`.
+ */
+type NullableOnCondition<Condition extends boolean, ResolvedTypeIfTrue> = Condition extends true ? ResolvedTypeIfTrue : ResolvedTypeIfTrue | null;
+//#endregion
 //#region src/root/functions/miscellaneous/sayHello.d.ts
 /**
  * Returns a string representing the lyrics to the package's theme song, Commit To You
@@ -111,7 +122,10 @@ declare function getDependenciesFromGroup(packageInfo: Record<string, unknown>,
 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>;
+interface GetPackageJsonContentsOptions<Strict extends boolean = true> {
+  strict?: Strict;
+}
+declare function getPackageJsonContents<Strict extends boolean = true>(directory: string, options?: GetPackageJsonContentsOptions<Strict>): Promise<NullableOnCondition<Strict, Record<string, any>>>;
 //#endregion
 //#region src/internal/getPackageJsonPath.d.ts
 declare function getPackageJsonPath(directory: string): string;

package/dist/internal/index.d.ts

@@ -78,6 +78,17 @@ type CreateEnumType<ObjectType extends Record<RecordKey, unknown>> = ObjectType[
 //#region src/root/types/IsTypeArgumentString.d.ts
 type IsTypeArgumentString<Argument extends string> = Argument;
 //#endregion
+//#region src/root/types/NullableOnCondition.d.ts
+/**
+ * Resolves to the given type if the first type is `true`, otherwise resolves to `null`
+ *
+ * @category Types
+ *
+ * @param Condition - The condition to check.
+ * @param ResolvedTypeIfTrue - The type to resolve to if the condition may be `true`.
+ */
+type NullableOnCondition<Condition extends boolean, ResolvedTypeIfTrue> = Condition extends true ? ResolvedTypeIfTrue : ResolvedTypeIfTrue | null;
+//#endregion
 //#region src/root/functions/miscellaneous/sayHello.d.ts
 /**
  * Returns a string representing the lyrics to the package's theme song, Commit To You
@@ -112,7 +123,10 @@ declare function getDependenciesFromGroup(packageInfo: Record<string, unknown>,
 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>;
+interface GetPackageJsonContentsOptions<Strict extends boolean = true> {
+  strict?: Strict;
+}
+declare function getPackageJsonContents<Strict extends boolean = true>(directory: string, options?: GetPackageJsonContentsOptions<Strict>): Promise<NullableOnCondition<Strict, Record<string, any>>>;
 //#endregion
 //#region src/internal/getPackageJsonPath.d.ts
 declare function getPackageJsonPath(directory: string): string;

package/dist/internal/index.js

@@ -671,13 +671,21 @@ function getPackageJsonPath(directory) {
 	return path.join(...directory.endsWith("package.json") ? [directory] : [directory, "package.json"]);
 }
 
+//#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/getPackageJsonContents.ts
-async function getPackageJsonContents(directory) {
+async function getPackageJsonContents(directory, options) {
+	const { strict = true } = options ?? {};
 	try {
 		return JSON.parse(await readFile(getPackageJsonPath(directory), "utf-8"));
 	} catch (error) {
-		if (error instanceof Error && "code" in error && error.code === "ENOENT") return null;
+		if (error instanceof Error && "code" in error && error.code === "ENOENT") if (strict) throw packageJsonNotFoundError(directory);
+		else return null;
 		throw error;
 	}
 }
@@ -690,12 +698,6 @@ const ModuleType = {
 	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 = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/utility",
-  "version": "5.5.0",
+  "version": "5.6.1",
   "description": "Helpful utility functions.",
   "repository": {
     "type": "git",
@@ -36,11 +36,12 @@
     "zod": "^4.3.6"
   },
   "devDependencies": {
-    "@alextheman/eslint-plugin": "^5.8.2",
-    "@types/node": "^25.3.0",
-    "alex-c-line": "^1.28.0",
+    "@alextheman/eslint-plugin": "^5.9.1",
+    "@types/node": "^25.3.3",
+    "alex-c-line": "^2.0.0",
+    "cross-env": "^10.1.0",
     "dotenv-cli": "^11.0.0",
-    "eslint": "^10.0.1",
+    "eslint": "^10.0.2",
     "globals": "^17.3.0",
     "husky": "^9.1.7",
     "jsdom": "^28.1.0",
@@ -60,25 +61,26 @@
     "build": "tsdown",
     "create-feature-docs": "typedoc",
     "create-local-package": "pnpm run build && rm -f alextheman-utility-*.tgz && pnpm pack",
-    "create-release-note": "bash -c 'git pull origin main && alex-c-line create-release-note-2 $@' --",
+    "create-release-note": "bash -c 'git pull origin main && alex-c-line template release-note create $@' --",
     "format": "pnpm run format-prettier && pnpm run format-eslint",
     "format-eslint": "eslint --fix --suppress-all \"package.json\" \"src/**/*.ts\" \"tests/**/*.ts\" && rm -f eslint-suppressions.json",
     "format-prettier": "pnpm run format-prettier-typescript && pnpm run format-prettier-javascript && pnpm run format-prettier-yml",
     "format-prettier-javascript": "prettier --write \"./**/*.js\"",
     "format-prettier-typescript": "prettier --write --parser typescript \"./**/*.ts\"",
     "format-prettier-yml": "prettier --write \"./**/*.{yml,yaml}\"",
-    "lint": "pnpm run lint-tsc && pnpm run lint-eslint && pnpm run lint-prettier",
+    "lint": "pnpm run lint-tsc && pnpm run lint-eslint && pnpm run lint-prettier && pnpm run lint-pre-release",
     "lint-eslint": "eslint \"package.json\" \"src/**/*.ts\" \"tests/**/*.ts\"",
+    "lint-pre-release": "alex-c-line package-json check --rules no-pre-release-dependencies",
     "lint-prettier": "pnpm run lint-prettier-typescript && pnpm run lint-prettier-javascript && pnpm run lint-prettier-yml",
     "lint-prettier-javascript": "prettier --check \"./**/*.js\"",
     "lint-prettier-typescript": "prettier --check --parser typescript \"./**/*.ts\"",
     "lint-prettier-yml": "prettier --check \"./**/*.{yml,yaml}\"",
     "lint-tsc": "tsc --noEmit",
-    "pre-commit": "alex-c-line pre-commit-2",
+    "pre-commit": "alex-c-line pre-commit",
     "prepare-live-eslint-plugin": "pnpm uninstall @alextheman/eslint-plugin && pnpm install --save-dev @alextheman/eslint-plugin",
     "prepare-local-eslint-plugin": "dotenv -e .env -- sh -c 'ESLINT_PLUGIN_PATH=${LOCAL_ESLINT_PLUGIN_PATH:-../eslint-plugin}; pnpm --prefix \"$ESLINT_PLUGIN_PATH\" run build && pnpm uninstall @alextheman/eslint-plugin && pnpm install --save-dev file:\"$ESLINT_PLUGIN_PATH\"'",
     "test": "vitest run",
-    "test-end-to-end": "RUN_END_TO_END=true vitest run tests/end-to-end --reporter verbose",
+    "test-end-to-end": "cross-env RUN_END_TO_END=true vitest run tests/end-to-end --reporter verbose",
     "test-watch": "vitest",
     "update-dependencies": "pnpm update --latest && pnpm update",
     "use-live-eslint-plugin": "pnpm run prepare-live-eslint-plugin && pnpm run lint",