@alextheman/utility 4.5.0 → 4.6.0

package/dist/index.cjs

@@ -708,6 +708,43 @@ function isOrdered(array) {
 }
 var isOrdered_default = isOrdered;
 
+//#endregion
+//#region src/functions/miscellaneous/stringifyDotenv.ts
+/**
+* Converts an object into a string in .env file format.
+*
+* @param contents - The object to convert. Must be a record whose values are strings.
+* @param options - Extra options to apply.
+*
+* @returns A string representation of the object in .env file format.
+*/
+function stringifyDotenv(contents, options) {
+	const { ...contentsCopy } = contents;
+	const { quoteStyle = "double" } = options ?? {};
+	let result = "";
+	for (const key in contentsCopy) {
+		if (/[ \t\r\n]/.test(key)) throw new DataError_default({ [key]: contentsCopy[key] }, "INVALID_KEY", "Environment variables are not allowed to have whitespace.");
+		if (quoteStyle === "none") if (/[ \t\r\n]/.test(contentsCopy[key]) || contentsCopy[key].includes("#")) throw new DataError_default({ [key]: contentsCopy[key] }, "INCOMPATIBLE_QUOTE_STYLE", "Cannot use `{ quoteStyle: \"none\" }` when value has whitespace or #");
+		else {
+			result += `${key}=${contentsCopy[key]}\n`;
+			continue;
+		}
+		const rawValue = contentsCopy[key].replace(/\r?\n/g, String.raw`\n`);
+		const chosenQuoteCharacter = {
+			double: "\"",
+			single: "'"
+		}[quoteStyle];
+		const otherQuoteCharacter = {
+			double: "'",
+			single: "\""
+		}[quoteStyle];
+		const finalQuoteCharacter = /[\r\n]/.test(contentsCopy[key]) ? `"` : rawValue.includes(chosenQuoteCharacter) ? otherQuoteCharacter : chosenQuoteCharacter;
+		result += `${key}=${finalQuoteCharacter}${rawValue}${finalQuoteCharacter}\n`;
+	}
+	return result;
+}
+var stringifyDotenv_default = stringifyDotenv;
+
 //#endregion
 //#region src/functions/miscellaneous/stringListToArray.ts
 /**
@@ -1484,5 +1521,6 @@ exports.randomiseArray = randomiseArray_default;
 exports.range = range_default;
 exports.removeDuplicates = removeDuplicates_default;
 exports.stringListToArray = stringListToArray_default;
+exports.stringifyDotenv = stringifyDotenv_default;
 exports.truncate = truncate_default;
 exports.wait = wait_default;

package/dist/index.d.cts

@@ -1,3 +1,4 @@
+import { DotenvParseOutput } from "dotenv";
 import { ZodError, ZodType, core } from "zod";
 
 //#region src/constants/NAMESPACE_EXPORT_REGEX.d.ts
@@ -490,6 +491,22 @@ declare function getRandomNumber(lowerBound: number, upperBound: number): number
  */
 declare function isOrdered(array: readonly number[]): boolean;
 //#endregion
+//#region src/functions/miscellaneous/stringifyDotenv.d.ts
+type QuoteStyle = "double" | "single" | "none";
+interface StringifyDotenvOptions {
+  /** The quote style to use for the values (defaults to `"double"`) */
+  quoteStyle: QuoteStyle;
+}
+/**
+ * Converts an object into a string in .env file format.
+ *
+ * @param contents - The object to convert. Must be a record whose values are strings.
+ * @param options - Extra options to apply.
+ *
+ * @returns A string representation of the object in .env file format.
+ */
+declare function stringifyDotenv(contents: Record<RecordKey, string> | DotenvParseOutput, options?: StringifyDotenvOptions): string;
+//#endregion
 //#region src/functions/miscellaneous/stringListToArray.d.ts
 /**
  * Options to apply to the conversion of a string list to an array.
@@ -1036,4 +1053,4 @@ interface ParseVersionOptions {
  */
 declare function parseVersion(input: string, options?: ParseVersionOptions): string;
 //#endregion
-export { APIError, ArrayElement, CamelToKebabOptions, CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParallelTuple, ParseVersionOptions, RecordKey, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, encryptWithKey, fillArray, formatDateAndTime, getIndividualVersionNumbers, getInterpolations, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseVersion, parseVersionType, parseZodSchema, randomiseArray, range, removeDuplicates, stringListToArray, truncate, wait };
+export { APIError, ArrayElement, CamelToKebabOptions, CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParallelTuple, ParseVersionOptions, RecordKey, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, encryptWithKey, fillArray, formatDateAndTime, getIndividualVersionNumbers, getInterpolations, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseVersion, parseVersionType, parseZodSchema, randomiseArray, range, removeDuplicates, stringListToArray, stringifyDotenv, truncate, wait };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { ZodError, ZodType, core } from "zod";
+import { DotenvParseOutput } from "dotenv";
 
 //#region src/constants/NAMESPACE_EXPORT_REGEX.d.ts
 declare const NAMESPACE_EXPORT_REGEX = "export\\s+\\*\\s+from";
@@ -490,6 +491,22 @@ declare function getRandomNumber(lowerBound: number, upperBound: number): number
  */
 declare function isOrdered(array: readonly number[]): boolean;
 //#endregion
+//#region src/functions/miscellaneous/stringifyDotenv.d.ts
+type QuoteStyle = "double" | "single" | "none";
+interface StringifyDotenvOptions {
+  /** The quote style to use for the values (defaults to `"double"`) */
+  quoteStyle: QuoteStyle;
+}
+/**
+ * Converts an object into a string in .env file format.
+ *
+ * @param contents - The object to convert. Must be a record whose values are strings.
+ * @param options - Extra options to apply.
+ *
+ * @returns A string representation of the object in .env file format.
+ */
+declare function stringifyDotenv(contents: Record<RecordKey, string> | DotenvParseOutput, options?: StringifyDotenvOptions): string;
+//#endregion
 //#region src/functions/miscellaneous/stringListToArray.d.ts
 /**
  * Options to apply to the conversion of a string list to an array.
@@ -1036,4 +1053,4 @@ interface ParseVersionOptions {
  */
 declare function parseVersion(input: string, options?: ParseVersionOptions): string;
 //#endregion
-export { APIError, ArrayElement, CamelToKebabOptions, CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, type IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParallelTuple, type ParseVersionOptions, RecordKey, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, encryptWithKey, fillArray, formatDateAndTime, getIndividualVersionNumbers, getInterpolations, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseVersion, parseVersionType, parseZodSchema, randomiseArray, range, removeDuplicates, stringListToArray, truncate, wait };
+export { APIError, ArrayElement, CamelToKebabOptions, CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, type IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParallelTuple, type ParseVersionOptions, RecordKey, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, encryptWithKey, fillArray, formatDateAndTime, getIndividualVersionNumbers, getInterpolations, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseVersion, parseVersionType, parseZodSchema, randomiseArray, range, removeDuplicates, stringListToArray, stringifyDotenv, truncate, wait };

package/dist/index.js

@@ -678,6 +678,43 @@ function isOrdered(array) {
 }
 var isOrdered_default = isOrdered;
 
+//#endregion
+//#region src/functions/miscellaneous/stringifyDotenv.ts
+/**
+* Converts an object into a string in .env file format.
+*
+* @param contents - The object to convert. Must be a record whose values are strings.
+* @param options - Extra options to apply.
+*
+* @returns A string representation of the object in .env file format.
+*/
+function stringifyDotenv(contents, options) {
+	const { ...contentsCopy } = contents;
+	const { quoteStyle = "double" } = options ?? {};
+	let result = "";
+	for (const key in contentsCopy) {
+		if (/[ \t\r\n]/.test(key)) throw new DataError_default({ [key]: contentsCopy[key] }, "INVALID_KEY", "Environment variables are not allowed to have whitespace.");
+		if (quoteStyle === "none") if (/[ \t\r\n]/.test(contentsCopy[key]) || contentsCopy[key].includes("#")) throw new DataError_default({ [key]: contentsCopy[key] }, "INCOMPATIBLE_QUOTE_STYLE", "Cannot use `{ quoteStyle: \"none\" }` when value has whitespace or #");
+		else {
+			result += `${key}=${contentsCopy[key]}\n`;
+			continue;
+		}
+		const rawValue = contentsCopy[key].replace(/\r?\n/g, String.raw`\n`);
+		const chosenQuoteCharacter = {
+			double: "\"",
+			single: "'"
+		}[quoteStyle];
+		const otherQuoteCharacter = {
+			double: "'",
+			single: "\""
+		}[quoteStyle];
+		const finalQuoteCharacter = /[\r\n]/.test(contentsCopy[key]) ? `"` : rawValue.includes(chosenQuoteCharacter) ? otherQuoteCharacter : chosenQuoteCharacter;
+		result += `${key}=${finalQuoteCharacter}${rawValue}${finalQuoteCharacter}\n`;
+	}
+	return result;
+}
+var stringifyDotenv_default = stringifyDotenv;
+
 //#endregion
 //#region src/functions/miscellaneous/stringListToArray.ts
 /**
@@ -1404,4 +1441,4 @@ function incrementVersion(version, incrementType, options) {
 var incrementVersion_default = incrementVersion;
 
 //#endregion
-export { APIError_default as APIError, DataError_default as DataError, Env, NAMESPACE_EXPORT_REGEX_default as NAMESPACE_EXPORT_REGEX, VERSION_NUMBER_REGEX_default as VERSION_NUMBER_REGEX, VersionNumber_default as VersionNumber, VersionType, addDaysToDate_default as addDaysToDate, appendSemicolon_default as appendSemicolon, camelToKebab_default as camelToKebab, convertFileToBase64_default as convertFileToBase64, createFormData_default as createFormData, createTemplateStringsArray_default as createTemplateStringsArray, deepCopy_default as deepCopy, deepFreeze_default as deepFreeze, determineVersionType_default as determineVersionType, encryptWithKey_default as encryptWithKey, fillArray_default as fillArray, formatDateAndTime_default as formatDateAndTime, getIndividualVersionNumbers_default as getIndividualVersionNumbers, getInterpolations_default as getInterpolations, getRandomNumber_default as getRandomNumber, getRecordKeys_default as getRecordKeys, httpErrorCodeLookup, incrementVersion_default as incrementVersion, interpolate_default as interpolate, interpolateObjects_default as interpolateObjects, isAnniversary_default as isAnniversary, isLeapYear_default as isLeapYear, isMonthlyMultiple_default as isMonthlyMultiple, isOrdered_default as isOrdered, isSameDate_default as isSameDate, kebabToCamel_default as kebabToCamel, normaliseImportPath, normaliseIndents_default as normaliseIndents, normalizeImportPath_default as normalizeImportPath, normalizeIndents, omitProperties_default as omitProperties, paralleliseArrays_default as paralleliseArrays, parseBoolean_default as parseBoolean, parseEnv_default as parseEnv, parseFormData_default as parseFormData, parseIntStrict_default as parseIntStrict, parseVersion_default as parseVersion, parseVersionType_default as parseVersionType, parseZodSchema_default as parseZodSchema, randomiseArray_default as randomiseArray, range_default as range, removeDuplicates_default as removeDuplicates, stringListToArray_default as stringListToArray, truncate_default as truncate, wait_default as wait };
+export { APIError_default as APIError, DataError_default as DataError, Env, NAMESPACE_EXPORT_REGEX_default as NAMESPACE_EXPORT_REGEX, VERSION_NUMBER_REGEX_default as VERSION_NUMBER_REGEX, VersionNumber_default as VersionNumber, VersionType, addDaysToDate_default as addDaysToDate, appendSemicolon_default as appendSemicolon, camelToKebab_default as camelToKebab, convertFileToBase64_default as convertFileToBase64, createFormData_default as createFormData, createTemplateStringsArray_default as createTemplateStringsArray, deepCopy_default as deepCopy, deepFreeze_default as deepFreeze, determineVersionType_default as determineVersionType, encryptWithKey_default as encryptWithKey, fillArray_default as fillArray, formatDateAndTime_default as formatDateAndTime, getIndividualVersionNumbers_default as getIndividualVersionNumbers, getInterpolations_default as getInterpolations, getRandomNumber_default as getRandomNumber, getRecordKeys_default as getRecordKeys, httpErrorCodeLookup, incrementVersion_default as incrementVersion, interpolate_default as interpolate, interpolateObjects_default as interpolateObjects, isAnniversary_default as isAnniversary, isLeapYear_default as isLeapYear, isMonthlyMultiple_default as isMonthlyMultiple, isOrdered_default as isOrdered, isSameDate_default as isSameDate, kebabToCamel_default as kebabToCamel, normaliseImportPath, normaliseIndents_default as normaliseIndents, normalizeImportPath_default as normalizeImportPath, normalizeIndents, omitProperties_default as omitProperties, paralleliseArrays_default as paralleliseArrays, parseBoolean_default as parseBoolean, parseEnv_default as parseEnv, parseFormData_default as parseFormData, parseIntStrict_default as parseIntStrict, parseVersion_default as parseVersion, parseVersionType_default as parseVersionType, parseZodSchema_default as parseZodSchema, randomiseArray_default as randomiseArray, range_default as range, removeDuplicates_default as removeDuplicates, stringListToArray_default as stringListToArray, stringifyDotenv_default as stringifyDotenv, truncate_default as truncate, wait_default as wait };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/utility",
-  "version": "4.5.0",
+  "version": "4.6.0",
   "description": "Helpful utility functions.",
   "repository": {
     "type": "git",
@@ -16,6 +16,7 @@
     "dist"
   ],
   "dependencies": {
+    "dotenv": "^17.2.3",
     "libsodium-wrappers": "^0.8.0",
     "zod": "^4.3.5"
   },