@e280/stz 0.0.0-0 → 0.0.0-10

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@e280/stz",
-	"version": "0.0.0-0",
+	"version": "0.0.0-10",
 	"description": "everyday ts fns for everything",
 	"license": "MIT",
 	"author": "Chase Moskal <chasemoskal@gmail.com>",
@@ -12,15 +12,18 @@
 	],
 	"scripts": {
 		"build": "run-s _clean _links _tsc",
+		"test": "node x/tests.test.js",
+		"count": "find s -path '*/_archive' -prune -o -name '*.ts' -exec wc -l {} +",
+		"start": "run-p _tscw _testw",
 		"_clean": "rm -rf x && mkdir x",
 		"_links": "ln -s \"$(realpath node_modules)\" x/node_modules",
 		"_tsc": "tsc",
-		"start": "exit 0",
-		"count": "find s -path '*/_archive' -prune -o -name '*.ts' -exec wc -l {} +",
-		"test": "exit 0"
+		"_tscw": "tsc -w",
+		"_testw": "node --watch x/tests.test.js"
 	},
 	"devDependencies": {
-		"@types/node": "^22.14.1",
+		"@e280/science": "^0.0.4",
+		"@types/node": "^22.15.3",
 		"npm-run-all": "^4.1.5",
 		"typescript": "^5.8.3"
 	},

package/s/clone/clone.test.ts

@@ -1,124 +1,124 @@
-//
-// import {Suite, expect} from "cynic"
-// import {clone} from "./clone.js"
-//
-// function checkMapOrSetEquality(original: any, cloned: any) {
-// 	const originalEntries = JSON.stringify(Array.from(original))
-// 	const clonedEntries = JSON.stringify(Array.from(cloned))
-// 	expect(clonedEntries).equals(originalEntries)
-// 	expect(cloned).not.equals(original) // check for deep cloning
-// }
-//
-// export default <Suite>{
-//
-// 	async "clone primitive types"() {
-// 		expect(clone(123)).equals(123)
-// 		expect(clone("abc")).equals("abc")
-// 		expect(clone(true)).equals(true)
-// 	},
-//
-// 	async "clone arrays"() {
-// 		const array = [1, 2, 3]
-// 		const clonedArray = clone(array)
-// 		expect(JSON.stringify(clonedArray)).equals(JSON.stringify(array))
-// 		expect(clonedArray).not.equals(array) // check for deep cloning
-// 	},
-//
-// 	async "clone plain objects"() {
-// 		const object = {foo: "bar", baz: 123}
-// 		const clonedObject = clone(object)
-// 		expect(JSON.stringify(clonedObject)).equals(JSON.stringify(object))
-// 		expect(clonedObject).not.equals(object) // check for deep cloning
-// 	},
-//
-// 	async "clone Map"() {
-// 		const map = new Map()
-// 		map.set("key", "value")
-// 		const clonedMap = clone(map)
-// 		expect(map.get("key")).equals("value")
-// 		expect(clonedMap).not.equals(map)
-// 	},
-//
-// 	async "clone Set"() {
-// 		const set = new Set()
-// 		set.add("value")
-// 		const clonedSet = clone(set)
-// 		expect(clonedSet.has("value")).ok()
-// 		expect(clonedSet).not.equals(set)
-// 	},
-//
-// 	async "clone Date"() {
-// 		const date = new Date()
-// 		const clonedDate = clone(date)
-// 		expect(clonedDate.getTime()).equals(date.getTime())
-// 		expect(clonedDate).not.equals(date) // check for deep cloning
-// 	},
-//
-// 	async "clone objects with circular reference"() {
-// 		const object: any = {foo: "bar"}
-// 		object.self = object // create circular reference
-// 		let error: any
-// 		try {
-// 			clone(object)
-// 		} catch (e) {
-// 			error = e
-// 		}
-// 		expect(error).not.equals(undefined)
-// 		expect(error instanceof Error).ok()
-// 	},
-//
-// 	async "clone nested objects"() {
-// 		const object = {foo: "bar", inner: {baz: 123, deeper: {qux: true}}}
-// 		const clonedObject = clone(object)
-// 		expect(JSON.stringify(clonedObject)).equals(JSON.stringify(object))
-// 		expect(clonedObject).not.equals(object) // check for deep cloning
-// 		expect(clonedObject.inner).not.equals(object.inner) // check for deep cloning
-// 		expect(clonedObject.inner.deeper).not.equals(object.inner.deeper) // check for deep cloning
-// 	},
-//
-// 	async "clone array of objects"() {
-// 		const array = [{foo: "bar"}, {baz: 123}, {qux: true}]
-// 		const clonedArray = clone(array)
-// 		expect(JSON.stringify(clonedArray)).equals(JSON.stringify(array))
-// 		expect(clonedArray).not.equals(array) // check for deep cloning
-// 	},
-//
-// 	async "clone object with array"() {
-// 		const object = {foo: "bar", array: [1, 2, 3]}
-// 		const clonedObject = clone(object)
-// 		expect(JSON.stringify(clonedObject)).equals(JSON.stringify(object))
-// 		expect(clonedObject).not.equals(object) // check for deep cloning
-// 	},
-//
-// 	async "clone object with Map"() {
-// 		const map = new Map()
-// 		map.set("key", "value")
-// 		const object = {foo: "bar", map}
-// 		const clonedObject = clone(object)
-// 		expect(JSON.stringify(clonedObject.foo)).equals(JSON.stringify(object.foo))
-// 		checkMapOrSetEquality(object.map, clonedObject.map)
-// 	},
-//
-// 	async "clone object with duplicate sibling references"() {
-// 		const dupeObject = { id: 1, name: "H4CK3RM4N" }
-// 		const data = { obj1: dupeObject, obj2: dupeObject }
-//
-// 		let didThrow = false
-// 		let clonedData: typeof data = {} as typeof data
-//
-// 		try {
-// 			clonedData = clone(data)
-// 		}
-// 		catch (error) {
-// 			didThrow = true
-// 		}
-//
-// 		expect(didThrow).not.equals(true)
-// 		expect(clonedData.obj1).not.equals(clonedData.obj2)
-// 		expect(clonedData.obj1.id).equals(1)
-// 		expect(clonedData.obj1.name).equals("H4CK3RM4N")
-// 		expect(clonedData.obj2.id).equals(1)
-// 		expect(clonedData.obj2.name).equals("H4CK3RM4N")
-// 	},
-// }
+
+import {clone} from "./clone.js"
+import {Science, expect} from "@e280/science"
+
+function checkMapOrSetEquality(original: any, cloned: any) {
+	const originalEntries = JSON.stringify(Array.from(original))
+	const clonedEntries = JSON.stringify(Array.from(cloned))
+	expect(clonedEntries).is(originalEntries)
+	expect(cloned).not.is(original) // check for deep cloning
+}
+
+export default Science.suite({
+
+	async "clone primitive types"() {
+		expect(clone(123)).is(123)
+		expect(clone("abc")).is("abc")
+		expect(clone(true)).is(true)
+	},
+
+	async "clone arrays"() {
+		const array = [1, 2, 3]
+		const clonedArray = clone(array)
+		expect(JSON.stringify(clonedArray)).is(JSON.stringify(array))
+		expect(clonedArray).not.is(array) // check for deep cloning
+	},
+
+	async "clone plain objects"() {
+		const object = {foo: "bar", baz: 123}
+		const clonedObject = clone(object)
+		expect(JSON.stringify(clonedObject)).is(JSON.stringify(object))
+		expect(clonedObject).not.is(object) // check for deep cloning
+	},
+
+	async "clone Map"() {
+		const map = new Map()
+		map.set("key", "value")
+		const clonedMap = clone(map)
+		expect(map.get("key")).is("value")
+		expect(clonedMap).not.is(map)
+	},
+
+	async "clone Set"() {
+		const set = new Set()
+		set.add("value")
+		const clonedSet = clone(set)
+		expect(clonedSet.has("value")).ok()
+		expect(clonedSet).not.is(set)
+	},
+
+	async "clone Date"() {
+		const date = new Date()
+		const clonedDate = clone(date)
+		expect(clonedDate.getTime()).is(date.getTime())
+		expect(clonedDate).not.is(date) // check for deep cloning
+	},
+
+	async "clone objects with circular reference"() {
+		const object: any = {foo: "bar"}
+		object.self = object // create circular reference
+		let error: any
+		try {
+			clone(object)
+		} catch (e) {
+			error = e
+		}
+		expect(error).not.is(undefined)
+		expect(error instanceof Error).ok()
+	},
+
+	async "clone nested objects"() {
+		const object = {foo: "bar", inner: {baz: 123, deeper: {qux: true}}}
+		const clonedObject = clone(object)
+		expect(JSON.stringify(clonedObject)).is(JSON.stringify(object))
+		expect(clonedObject).not.is(object) // check for deep cloning
+		expect(clonedObject.inner).not.is(object.inner) // check for deep cloning
+		expect(clonedObject.inner.deeper).not.is(object.inner.deeper) // check for deep cloning
+	},
+
+	async "clone array of objects"() {
+		const array = [{foo: "bar"}, {baz: 123}, {qux: true}]
+		const clonedArray = clone(array)
+		expect(JSON.stringify(clonedArray)).is(JSON.stringify(array))
+		expect(clonedArray).not.is(array) // check for deep cloning
+	},
+
+	async "clone object with array"() {
+		const object = {foo: "bar", array: [1, 2, 3]}
+		const clonedObject = clone(object)
+		expect(JSON.stringify(clonedObject)).is(JSON.stringify(object))
+		expect(clonedObject).not.is(object) // check for deep cloning
+	},
+
+	async "clone object with Map"() {
+		const map = new Map()
+		map.set("key", "value")
+		const object = {foo: "bar", map}
+		const clonedObject = clone(object)
+		expect(JSON.stringify(clonedObject.foo)).is(JSON.stringify(object.foo))
+		checkMapOrSetEquality(object.map, clonedObject.map)
+	},
+
+	async "clone object with duplicate sibling references"() {
+		const dupeObject = { id: 1, name: "H4CK3RM4N" }
+		const data = { obj1: dupeObject, obj2: dupeObject }
+
+		let didThrow = false
+		let clonedData: typeof data = {} as typeof data
+
+		try {
+			clonedData = clone(data)
+		}
+		catch (error) {
+			didThrow = true
+		}
+
+		expect(didThrow).not.is(true)
+		expect(clonedData.obj1).not.is(clonedData.obj2)
+		expect(clonedData.obj1.id).is(1)
+		expect(clonedData.obj1.name).is("H4CK3RM4N")
+		expect(clonedData.obj2.id).is(1)
+		expect(clonedData.obj2.name).is("H4CK3RM4N")
+	},
+})
 

package/s/coalesce.ts

@@ -0,0 +1,5 @@
+
+export function coalesce<A extends any[] = []>(...fns: ((...a: A) => void)[]) {
+	return (...a: A) => fns.forEach(fn => fn(...a))
+}
+

package/s/data/bytename/badge.test.ts

@@ -0,0 +1,53 @@
+
+import {Hex} from "../hex.js"
+import {Badge} from "./badge.js"
+import {Bytes} from "../bytes.js"
+import {Science, test, expect} from "@e280/science"
+
+const sampleBadge = "nodlyn.fasrep::39gfeGFAAnBzH5pkT7EdoETMUMAekG9h1iymk6k"
+const sampleHex = "88e8c3fad1028fcf6ce5ac491578850f4d833336feca03b608265501c3019d59"
+const sampleBytes = Hex.bytes(sampleHex)
+
+function good(bytes: Uint8Array) {
+	expect(Bytes.eq(bytes, sampleBytes)).ok()
+}
+
+export default Science.suite({
+	"bytes->string->bytes": test(async() => {
+		const text = Badge.string(sampleBytes)
+		expect(text).is(sampleBadge)
+		good(Badge.bytes(text))
+	}),
+
+	"zero bytes": test(async() => {
+		const text = Badge.string(new Uint8Array([]))
+		expect(text).is("")
+		expect(Bytes.eq(Badge.bytes(text), new Uint8Array([]))).ok()
+	}),
+
+	"one byte": test(async() => {
+		const text = Badge.string(new Uint8Array([0x00]))
+		expect(text).is("doz")
+		expect(Bytes.eq(Badge.bytes(text), new Uint8Array([0x00]))).ok()
+	}),
+
+	"partially": Science.suite({
+		"normal": test(async() => expect(Badge.bytes("nodlyn.fasrep::39gfeGFAAnBzH5pkT7EdoETMUMAekG9h1iymk6k").length).ok()),
+		"nothing": test(async() => expect(Badge.bytes("").length).is(0)),
+		"no-rest": test(async() => expect(Badge.bytes("nodlyn.fasrep").length).ok()),
+		"one-byte": test(async() => expect(Badge.bytes("nod").length).is(1)),
+		"three-byte": test(async() => expect(Badge.bytes("nodlynfas").length).is(3)),
+		"one-byte-lead": test(async() => expect(Badge.bytes("nod::39gfeGFAAnBzH5pkT7EdoETMUMAekG9h1iymk6k").length).ok()),
+	}),
+
+	"tolerance": Science.suite({
+		"normal": test(async() => good(Badge.bytes("nodlyn.fasrep::39gfeGFAAnBzH5pkT7EdoETMUMAekG9h1iymk6k"))),
+		"coolio": test(async() => good(Badge.bytes("nodlyn.fasrep..39gfeGFAAnBzH5pkT7EdoETMUMAekG9h1iymk6k"))),
+		"spaces": test(async() => good(Badge.bytes("nodlyn fasrep 39gfeGFAAnBzH5pkT7EdoETMUMAekG9h1iymk6k"))),
+		"dots": test(async() => good(Badge.bytes("nodlyn.fasrep.39gfeGFAAnBzH5pkT7EdoETMUMAekG9h1iymk6k"))),
+		"one-space": test(async() => good(Badge.bytes("nodlynfasrep 39gfeGFAAnBzH5pkT7EdoETMUMAekG9h1iymk6k"))),
+		"one-newline": test(async() => good(Badge.bytes("nodlynfasrep\n39gfeGFAAnBzH5pkT7EdoETMUMAekG9h1iymk6k"))),
+		"whitespace": test(async() => good(Badge.bytes("\t\n nodlyn\n fasrep \n\n\t\n 39gfeGFAAnBzH5pkT7EdoETMUMAekG9h1iymk6k\n\t"))),
+	}),
+})
+

package/s/data/bytename/badge.ts

@@ -0,0 +1,80 @@
+
+import {Hex} from "../hex.js"
+import {Base58} from "../base58.js"
+import {Bytename} from "./bytename.js"
+
+export type BadgeOptions = {
+	leadBytes: number
+	leadSeparator: string
+	restSeparator: string
+}
+
+export type ParsedBadge = {
+	lead: string
+	rest: string
+	bytes: Uint8Array
+}
+
+/**
+ * Badge is a human-friendly presentation format for arbitrary binary data.
+ *  - looks like "nodlyn.fasrep::39gfeGFAAnBzH5pkT7EdoETMUMAekG9h1iymk6k"
+ *  - the first lead bytes are shown in bytename format
+ *  - the rest of the data is in base58
+ *  - designed to be a nice way to present 256-bit passport thumbprints
+ *  - can actually represent any number of bytes
+ */
+export const Badge = {
+	defaults: (<BadgeOptions>{
+		leadBytes: 4,
+		leadSeparator: ".",
+		restSeparator: "::",
+	}),
+
+	string(bytes: Uint8Array, options: Partial<BadgeOptions> = {}) {
+		const {leadBytes, leadSeparator, restSeparator}
+			= {...Badge.defaults, ...options}
+
+		const appetizer = Bytename.string(bytes.slice(0, leadBytes), {
+			wordSeparator: leadSeparator,
+			groupSeparator: leadSeparator,
+		})
+
+		return (bytes.length > leadBytes)
+			? `${appetizer}${restSeparator}${Base58.string(bytes.slice(leadBytes))}`
+			: appetizer
+	},
+
+	parse(badge: string): ParsedBadge {
+		badge = badge.trim()
+		const parts = badge.split(/[^a-zA-Z0-9]+/m)
+			.filter(Boolean)
+			.map(s => s.trim())
+
+		if (parts.length < 2) {
+			const lead = parts.join(".")
+			const bytes = Bytename.bytes(lead)
+			return {lead, rest: "", bytes}
+		}
+
+		const rest = parts.pop()!
+		const lead = parts.join(".")
+		const bytes = new Uint8Array([
+			...Bytename.bytes(lead),
+			...Base58.bytes(rest),
+		])
+		return {lead, rest, bytes}
+	},
+
+	bytes(badge: string) {
+		return Badge.parse(badge).bytes
+	},
+
+	hex(badge: string) {
+		return Hex.string(Badge.bytes(badge))
+	},
+
+	fromHex(hex: string, options?: Partial<BadgeOptions>) {
+		return Badge.string(Hex.bytes(hex), options)
+	},
+}
+

package/s/data/bytename/bytename.test.ts

@@ -0,0 +1,49 @@
+
+import {Bytes} from "../bytes.js"
+import {Bytename} from "./bytename.js"
+import {Science, test, expect} from "@e280/science"
+
+const deadbeef = new Uint8Array([0xDE, 0xAD, 0xBE, 0xEF])
+
+function good(bytes: Uint8Array) {
+	expect(Bytes.eq(bytes, deadbeef)).ok()
+}
+
+export default Science.suite({
+	"bytes->string->bytes": test(async() => {
+		const text = Bytename.string(deadbeef)
+		expect(text).is("ribmug.hilmun")
+		good(Bytename.bytes(text))
+	}),
+
+	"zero bytes": test(async() => {
+		const text = Bytename.string(new Uint8Array([]))
+		expect(text).is("")
+	}),
+
+	"one byte": test(async() => {
+		const text = Bytename.string(new Uint8Array([0x00]))
+		expect(text).is("doz")
+	}),
+
+	"groupings": test(async() => {
+		const bytes = new Uint8Array([...deadbeef, ...deadbeef])
+		const text = Bytename.string(bytes, {
+			groupSize: 2,
+			groupSeparator: " ",
+			wordSeparator: ".",
+		})
+		expect(text).is("ribmug.hilmun ribmug.hilmun")
+	}),
+
+	"wordsep": Science.suite({
+		"underscore": test(async() => good(Bytename.bytes("ribmug_hilmun"))),
+		"uppercase": test(async() => good(Bytename.bytes("RIBMUG_HILMUN"))),
+		"dots": test(async() => good(Bytename.bytes("ribmug.hilmun"))),
+		"crushed": test(async() => good(Bytename.bytes("ribmughilmun"))),
+		"space": test(async() => good(Bytename.bytes("ribmug hilmun"))),
+		"spaces": test(async() => good(Bytename.bytes("ribmug  hilmun"))),
+		"whitespace": test(async() => good(Bytename.bytes("\n ribmug \n \t \n hilmun \n"))),
+	}),
+})
+

package/s/data/{barname/barname.ts → bytename/bytename.ts}

@@ -1,19 +1,40 @@
 
+import {Hex} from "../hex.js"
 import {Bytes} from "../bytes.js"
 import {prefixes} from "./utils/prefixes.js"
 import {suffixes} from "./utils/suffixes.js"
 
-const wordSeparator = "_"
-const groupSeparator = " "
-const defaultWordsPerGroup = 4
+export type BytenameOptions = {
+	groupSize: number
+	wordSeparator: string
+	groupSeparator: string
+}
+
+/**
+ * Bytename is a human-friendly presentation format for arbitrary binary data.
+ *  - looks like "midsen.picmyn.widrep.baclut dotreg.filtyp.nosnus.siptev"
+ *  - each byte maps to a three-letter triplet
+ *  - six-letter words are separated by a delimiter
+ *  - four-word groups are separated by a delimiter
+ *  - all delimiters are just sugar, parser doesn't care
+ */
+export const Bytename = {
+	defaults: (<BytenameOptions>{
+		groupSize: 4,
+		wordSeparator: ".",
+		groupSeparator: " ",
+	}),
 
-export const Barname = {
-	random(byteCount: number) {
-		return this.string(Bytes.random(byteCount))
+	random(byteCount: number, options?: Partial<BytenameOptions>) {
+		return this.string(Bytes.random(byteCount), options)
 	},
 
-	string(bytes: Uint8Array, options?: {wordsPerGroup?: number}) {
-		const groupSize = options?.wordsPerGroup ?? defaultWordsPerGroup
+	string(bytes: Uint8Array, options: Partial<BytenameOptions> = {}) {
+		const {
+			groupSize = Bytename.defaults.groupSize,
+			wordSeparator = Bytename.defaults.wordSeparator,
+			groupSeparator = Bytename.defaults.groupSeparator,
+		} = options
 
 		const words: string[] = []
 		let currentWord: string[] = []
@@ -37,8 +58,8 @@ export const Barname = {
 		return grouped.join(groupSeparator)
 	},
 
-	bytes(string: string) {
-		const letters = string
+	bytes(bytename: string) {
+		const letters = bytename
 			.toLowerCase()
 			.replace(/[^a-z]/g, "") // strip everything except letters
 
@@ -58,5 +79,13 @@ export const Barname = {
 			return number
 		}))
 	},
+
+	hex(bytename: string) {
+		return Hex.string(Bytename.bytes(bytename))
+	},
+
+	fromHex(hex: string, options?: Partial<BytenameOptions>) {
+		return Bytename.string(Hex.bytes(hex), options)
+	},
 }
 

package/s/data/bytename/index.ts

@@ -0,0 +1,4 @@
+
+export * from "./bytename.js"
+export * from "./badge.js"
+

package/s/data/bytes.ts

@@ -1,5 +1,15 @@
 
 export const Bytes = {
+	eq(a: Uint8Array, b: Uint8Array) {
+		if (a.length !== b.length)
+			return false
+		for (let i = 0; i <= a.length; i++) {
+			if (a.at(i) !== b.at(i))
+				return false
+		}
+		return true
+	},
+
 	random(count: number) {
 		return crypto.getRandomValues(new Uint8Array(count))
 	},

package/s/deadline.ts

@@ -1,17 +1,20 @@
 
 export class DeadlineError extends Error {
 	name = this.constructor.name
-	constructor(milliseconds: number) {
-		super(`deadline exceeded (${milliseconds.toLocaleString()} ms)`)
+	constructor(public milliseconds: number, message: string) {
+		super(`${message}, timed out in ${(milliseconds / 1000).toFixed(1)} seconds`)
 	}
 }
 
 /** set a deadline for a fn to do something, will reject with a `DeadlineError` if it takes too long */
-export function deadline<R>(milliseconds: number, fn: () => Promise<R>) {
+export function deadline<R>(milliseconds: number, message: string, fn: () => Promise<R>) {
+	if (milliseconds <= 0 || milliseconds === Infinity)
+		return fn()
+
 	return new Promise<R>((resolve, reject) => {
 
 		const id = setTimeout(
-			() => reject(new DeadlineError(milliseconds)),
+			() => reject(new DeadlineError(milliseconds, message)),
 			milliseconds,
 		)
 
@@ -21,4 +24,3 @@ export function deadline<R>(milliseconds: number, fn: () => Promise<R>) {
 			.finally(() => clearTimeout(id))
 	})
 }
-