@drone1/alt 0.4.0

package/src/utils.js

@@ -0,0 +1,108 @@
+import { Buffer } from 'buffer'
+import * as crypto from 'crypto'
+
+export function obj2Str(obj, exclude = null, expandJson = false) {
+	let result = ''
+
+	const maybeJson = x => {
+		return expandJson && isObject(x) ? j2s(x) : x
+	}
+
+	if (exclude) {
+		for (let p in obj) {
+			if (exclude.includes(p)) continue
+			result += `${p}=${maybeJson(obj[p])}; `
+		}
+	} else {
+		for (let p in obj) {
+			result += `${p}=${maybeJson(obj[p])}; `
+		}
+	}
+	return result.substring(0, result.length - 2) // Remove trailing semicolon+space
+}
+
+export const REPLACESTRINGVARSWITHOBJECTVALUESWARNINGCODE_MISSINGVAR = 0
+export const REPLACESTRINGVARSWITHOBJECTVALUESWARNINGCODE_UNKNOWNVARSPECIFIED = 1
+
+/**
+ * Replaces variables in a string (format %%varName%%) with their corresponding values
+ * from an object.
+ *
+ * @param {string} format - The string containing variables like %%var1%%
+ * @param {object} data - Object with keys matching the variable names
+ * @param {array} outWarningsArray - Output array for tracking warnings
+ * @returns {string} - The string with all variables replaced with their values
+ */
+export function replaceStringVarsWithObjectValues({format, data, outWarningsArray}) {
+	//assertIsString(format)
+	//assertIsObj(data)
+	//assert(!outWarningsArray || Array.isArray(outWarningsArray))
+
+	// Regex pattern to match %%varName%% patterns
+	const regex = /%%([^%]+)%%/g
+
+	// NB: No need to add 'format' to 'message'; a calling func can print that once
+	const addWarning = (code, message) => outWarningsArray?.push({ code, message })
+
+	// Replace all matches using the replacement function
+	const dataKeySet = new Set(Object.keys(data))	// For tracking if we've got superfluous keys in 'data'
+	const result = format.replace(regex, (match, varName) => {
+		if (data.hasOwnProperty(varName)) {
+			dataKeySet.delete(varName)	// OK to call if doesn't exist (which can happen for situations with multiple vars with the same name)
+			return data[varName]
+		}
+
+		addWarning(REPLACESTRINGVARSWITHOBJECTVALUESWARNINGCODE_MISSINGVAR, `'format' string missing data for var "${varName}"`)
+
+		// Return the original match if the variable doesn't exist
+		return match
+	})
+
+	if (dataKeySet.size) {
+		for (const varName of dataKeySet) {
+			addWarning(REPLACESTRINGVARSWITHOBJECTVALUESWARNINGCODE_UNKNOWNVARSPECIFIED, `unknown var "${varName}" specified in data obj`)
+		}
+	}
+
+	return result
+}
+
+export function sleep(ms, log) {
+	if (ms === 0) return
+	return new Promise(resolve => setTimeout(resolve, ms))
+}
+
+export function ensureExtension(filename, extension) {
+	if (!extension.startsWith('.')) extension = '.' + extension
+	return filename.endsWith(extension) ? filename : filename + extension
+}
+
+export function unique(array) {
+	return [ ...new Set(array) ]
+}
+
+// Calculate hash of a string
+export function calculateHash(content) {
+	return crypto.createHash('sha256').update(content).digest('hex')
+}
+
+export function normalizeKey(key) {
+	return key.normalize('NFC')
+}
+
+export function normalizeData(data) {
+	if (!data) return null
+	const normalizedData = {}
+	for (const [ key, value ] of Object.entries(data)) {
+		// Force UTF-8 encoding for the key
+		const utf8Key = Buffer.from(key, 'utf8').toString('utf8')
+
+		// Force UTF-8 encoding for string values
+		const utf8Value = typeof value === 'string'
+			? Buffer.from(value, 'utf8').toString('utf8')
+			: value
+
+		normalizedData[normalizeKey(utf8Key)] = utf8Value
+	}
+	return normalizedData
+}