@e280/stz 0.0.0-3 → 0.0.0-30

package/s/data/base64.ts

@@ -1,22 +1,31 @@
 
 import {Bytes} from "./bytes.js"
 
-export const Base64 = {
-
-	string(bytes: Uint8Array) {
+export const Base64 = Object.freeze({
+	fromBytes(bytes: Uint8Array) {
 		return (typeof btoa === "function")
 			? btoa(String.fromCharCode(...bytes))
 			: Buffer.from(bytes).toString("base64")
 	},
 
-	bytes(string: string) {
+	toBytes(string: string) {
 		return (typeof atob === "function")
 			? Uint8Array.from(atob(string), char => char.charCodeAt(0))
 			: Uint8Array.from(Buffer.from(string, "base64"))
 	},
 
 	random(count = 32) {
-		return this.string(Bytes.random(count))
+		return this.fromBytes(Bytes.random(count))
+	},
+
+	/** @deprecated rename to "fromBytes" */
+	string(bytes: Uint8Array) {
+		return Base64.fromBytes(bytes)
+	},
+
+	/** @deprecated rename to "toBytes" */
+	bytes(string: string) {
+		return Base64.toBytes(string)
 	},
-}
+})
 

package/s/data/base64url.ts

@@ -3,25 +3,34 @@ import {Bytes} from "./bytes.js"
 import {Base64} from "./base64.js"
 
 export const Base64url = {
-
-	string(bytes: Uint8Array) {
-		return Base64.string(bytes)
+	fromBytes(bytes: Uint8Array) {
+		return Base64.fromBytes(bytes)
 			.replace(/\+/g, "-")
 			.replace(/\//g, "_")
 			.replace(/=+$/g, "")
 	},
 
-	bytes(string: string) {
+	toBytes(string: string) {
 		let b64 = string
 			.replace(/-/g, "+")
 			.replace(/_/g, "/")
 		if (b64.length % 4 !== 0)
 			b64 = b64.padEnd(b64.length + (4 - b64.length % 4) % 4, "=")
-		return Base64.bytes(b64)
+		return Base64.toBytes(b64)
 	},
 
 	random(count = 32) {
-		return this.string(Bytes.random(count))
+		return this.fromBytes(Bytes.random(count))
+	},
+
+	/** @deprecated renamed to "fromBytes" */
+	string(bytes: Uint8Array) {
+		return Base64url.fromBytes(bytes)
+	},
+
+	/** @deprecated renamed to "toBytes" */
+	bytes(string: string) {
+		return Base64url.toBytes(string)
 	},
 }
 

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.fromBytes(deadbeef)
+		expect(text).is("ribmug.hilmun")
+		good(Bytename.toBytes(text))
+	}),
+
+	"zero bytes": test(async() => {
+		const text = Bytename.fromBytes(new Uint8Array([]))
+		expect(text).is("")
+	}),
+
+	"one byte": test(async() => {
+		const text = Bytename.fromBytes(new Uint8Array([0x00]))
+		expect(text).is("doz")
+	}),
+
+	"groupings": test(async() => {
+		const bytes = new Uint8Array([...deadbeef, ...deadbeef])
+		const text = Bytename.fromBytes(bytes, {
+			groupSize: 2,
+			groupSeparator: " ",
+			wordSeparator: ".",
+		})
+		expect(text).is("ribmug.hilmun ribmug.hilmun")
+	}),
+
+	"wordsep": Science.suite({
+		"underscore": test(async() => good(Bytename.toBytes("ribmug_hilmun"))),
+		"uppercase": test(async() => good(Bytename.toBytes("RIBMUG_HILMUN"))),
+		"dots": test(async() => good(Bytename.toBytes("ribmug.hilmun"))),
+		"crushed": test(async() => good(Bytename.toBytes("ribmughilmun"))),
+		"space": test(async() => good(Bytename.toBytes("ribmug hilmun"))),
+		"spaces": test(async() => good(Bytename.toBytes("ribmug  hilmun"))),
+		"whitespace": test(async() => good(Bytename.toBytes("\n ribmug \n \t \n hilmun \n"))),
+	}),
+})
+

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

@@ -1,19 +1,39 @@
 
+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 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
+ *  - 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>) {
+		const bytes = Bytes.random(byteCount)
+		return this.fromBytes(bytes, options)
 	},
 
-	string(bytes: Uint8Array, options?: {wordsPerGroup?: number}) {
-		const groupSize = options?.wordsPerGroup ?? defaultWordsPerGroup
+	fromBytes(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 +57,8 @@ export const Barname = {
 		return grouped.join(groupSeparator)
 	},
 
-	bytes(string: string) {
-		const letters = string
+	toBytes(bytename: string) {
+		const letters = bytename
 			.toLowerCase()
 			.replace(/[^a-z]/g, "") // strip everything except letters
 
@@ -58,5 +78,13 @@ export const Barname = {
 			return number
 		}))
 	},
+
+	toHex(bytename: string) {
+		return Hex.fromBytes(Bytename.toBytes(bytename))
+	},
+
+	fromHex(hex: string, options?: Partial<BytenameOptions>) {
+		return Bytename.fromBytes(Hex.toBytes(hex), options)
+	},
 }
 

package/s/data/bytename/index.ts

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

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

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

package/s/data/bytename/thumbprint.ts

@@ -0,0 +1,112 @@
+
+import {Hex} from "../hex.js"
+import {Base58} from "../base58.js"
+import {Bytename} from "./bytename.js"
+
+export type ThumbprintOptions = {
+	delimiter: string
+	sigilBytes: number
+	previewBytes: number
+}
+
+export type ThumbprintData = {
+	bytes: Uint8Array
+	thumbprint: string
+	preview: string
+	bulk: string
+	sigil: string
+}
+
+/**
+ * Thumbprint is a friendly presentation format for arbitrary binary data.
+ *  - looks like "nodlyn.fasrep.habbud.ralwel.Avo7gFmdWMRHkwsD149mcaBoZdS69iXuJ"
+ *  - the preview: "nodlyn.fasrep.habbud.ralwel" (bytename format)
+ *  - the bulk: "Avo7gFmdWMRHkwsD149mcaBoZdS69iXuJ" (base58 format)
+ *  - the sigil: "nodlyn.fasrep" (shorter part of the bytename)
+ *  - originally designed to be a nice way to present 256-bit ids, but can actually represent any number of bytes
+ */
+export const Thumbprint = {
+	defaults: (<ThumbprintOptions>{
+		delimiter: ".",
+		sigilBytes: 4,
+		previewBytes: 8,
+	}),
+
+	toBytes(thumbprint: string) {
+		thumbprint = thumbprint.trim()
+		const beans = thumbprint.split(/[^a-zA-Z0-9]+/m)
+			.filter(Boolean)
+			.map(s => s.trim())
+
+		if (beans.length < 2)
+			return Bytename.toBytes(beans.join(""))
+
+		const bulk = beans.pop()!
+		const preview = beans.join("")
+
+		return new Uint8Array([
+			...Bytename.toBytes(preview),
+			...Base58.toBytes(bulk),
+		])
+	},
+
+	parse(thumbprint: string, options?: Partial<ThumbprintOptions>): ThumbprintData {
+		const bytes = Thumbprint.toBytes(thumbprint)
+		return Thumbprint.build.fromBytes(bytes, options)
+	},
+
+	build: {
+		fromBytes(bytes: Uint8Array, options: Partial<ThumbprintOptions> = {}): ThumbprintData {
+			const {delimiter, previewBytes, sigilBytes}
+				= {...Thumbprint.defaults, ...options}
+
+			const yoink = (b: number) => (bytes.length > 0)
+				? Bytename.fromBytes(bytes.slice(0, b), {
+					wordSeparator: delimiter,
+					groupSeparator: delimiter,
+				})
+				: ""
+
+			const sigil = yoink(sigilBytes)
+			const preview = yoink(previewBytes)
+
+			const bulk = (bytes.length > previewBytes)
+				? Base58.fromBytes(bytes.slice(previewBytes))
+				: ""
+
+			const thumbprint = [preview, bulk]
+				.filter(s => s.length > 0)
+				.join(delimiter)
+
+			return {bytes, thumbprint, preview, bulk, sigil}
+		},
+
+		fromHex(hex: string, options?: Partial<ThumbprintOptions>) {
+			const bytes = Hex.toBytes(hex)
+			return Thumbprint.build.fromBytes(bytes, options)
+		},
+	},
+
+	toHex(thumbprint: string) {
+		const bytes = Thumbprint.toBytes(thumbprint)
+		return Hex.fromBytes(bytes)
+	},
+
+	fromBytes(bytes: Uint8Array, options?: Partial<ThumbprintOptions>) {
+		return Thumbprint.build.fromBytes(bytes, options).thumbprint
+	},
+
+	fromHex(hex: string, options?: Partial<ThumbprintOptions>) {
+		return Thumbprint.fromBytes(Hex.toBytes(hex), options)
+	},
+
+	sigil: {
+		fromHex(hex: string, options?: Partial<ThumbprintOptions>) {
+			return Thumbprint.build.fromHex(hex, options).sigil
+		},
+		fromBytes(bytes: Uint8Array, options?: Partial<ThumbprintOptions>) {
+			return Thumbprint.build.fromBytes(bytes, options).sigil
+		},
+	},
+}
+

package/s/data/bytes.ts

@@ -1,7 +1,17 @@
 
-export const Bytes = {
+export const Bytes = Object.freeze({
+	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/data/data.test.ts

@@ -0,0 +1,98 @@
+
+import {Science, test, expect} from "@e280/science"
+import {ob} from "../ob.js"
+import {Txt} from "./txt.js"
+import {Hex} from "./hex.js"
+import {Bytes} from "./bytes.js"
+import {BaseX} from "./base-x.js"
+import {Base58} from "./base58.js"
+import {Base64} from "./base64.js"
+import {Base64url} from "./base64url.js"
+
+const sampleBytes = Hex.toBytes("9960cd633a46acfe8307d8a400e842da0d930a75fb8188e0f5da264e4b6b4e5b")
+
+type ByteUtil = {
+	toBytes: (string: string) => Uint8Array
+	fromBytes: (bytes: Uint8Array) => string
+}
+
+type NumberUtil = {
+	toInteger: (s: string) => number
+	fromInteger: (n: number) => string
+}
+
+function testBytes(util: ByteUtil) {
+	return async() => {
+		const string = util.fromBytes(sampleBytes)
+		const recreated = util.toBytes(string)
+		expect(Bytes.eq(sampleBytes, recreated)).ok()
+	}
+}
+
+function testNumbers(util: NumberUtil) {
+	return {
+		positive: async() => {
+			const original = 123456789
+			const string = util.fromInteger(original)
+			const recreated = util.toInteger(string)
+			expect(original).is(recreated)
+			expect(util.toInteger("")).is(0)
+		},
+		negative: async() => {
+			const original = -123456789
+			const string = util.fromInteger(original)
+			const recreated = util.toInteger(string)
+			expect(original).is(recreated)
+			expect(util.toInteger("")).is(0)
+		},
+	}
+}
+
+function testBoth(util: ByteUtil & NumberUtil) {
+	return {
+		bytes: testBytes(util),
+		numbers: testNumbers(util),
+	}
+}
+
+function testCompat(alpha: ByteUtil, bravo: ByteUtil) {
+	return async() => {
+		expect(alpha.fromBytes(sampleBytes))
+			.is(bravo.fromBytes(sampleBytes))
+	}
+}
+
+export default Science.suite({
+	"Base58": testBytes(Base58),
+	"Base64": testBytes(Base64),
+	"Base64url": testBytes(Base64url),
+	"Hex": testBytes(Hex),
+
+	"Txt": test(async() => {
+		const original = `build or die. 💻>☠️ 命火工`
+		const bytes = Txt.toBytes(original)
+		const recreated = Txt.fromBytes(bytes)
+		expect(original).is(recreated)
+	}),
+
+	"BaseX": Science.suite({
+		lexicons: Science.suite(
+			ob(BaseX.lexicons).map(lex => testBoth(new BaseX(lex)))
+		),
+		compat: Science.suite({
+			"Hex": testCompat(Hex, new BaseX(BaseX.lexicons.hex)),
+			"Base64": testCompat(Base64, new BaseX(BaseX.lexicons.base64)),
+			"Base64url": testCompat(Base64url, new BaseX(BaseX.lexicons.base64url)),
+		}),
+		"base64 has padding": test(async() => {
+			const s = new BaseX(BaseX.lexicons.base64).fromBytes(sampleBytes)
+			expect(s.endsWith("=")).ok()
+		}),
+		"antagonistic base64 positive integer": test(async() => {
+			const base64url = new BaseX(BaseX.lexicons.base64url)
+			expect(base64url.toInteger(base64url.fromInteger(62))).is(62)
+			expect(base64url.toInteger(base64url.fromInteger(4030))).is(4030)
+		}),
+	}),
+})
+

package/s/data/hex.ts

@@ -11,14 +11,14 @@
 
 import {Bytes} from "./bytes.js"
 
-export const Hex = {
-	string(bytes: Uint8Array) {
+export const Hex = Object.freeze({
+	fromBytes(bytes: Uint8Array) {
 		return [...bytes]
 			.map(byte => byte.toString(16).padStart(2, "0"))
 			.join("")
 	},
 
-	bytes(string: string) {
+	toBytes(string: string) {
 		if (string.length % 2 !== 0)
 			throw new Error("must have even number of hex characters")
 		const bytes = new Uint8Array(string.length / 2)
@@ -29,7 +29,17 @@ export const Hex = {
 
 	/** generate a random hex string. byteCount defaults to 32. */
 	random(byteCount = 32) {
-		return this.string(Bytes.random(byteCount))
+		return this.fromBytes(Bytes.random(byteCount))
+	},
+
+	/** @deprecated renamed to `fromBytes` */
+	string(bytes: Uint8Array) {
+		return Hex.fromBytes(bytes)
+	},
+
+	/** @deprecated renamed to `toBytes` */
+	bytes(string: string) {
+		return Hex.toBytes(string)
 	},
-}
+})
 

package/s/data/txt.ts

@@ -1,11 +1,21 @@
 
-export const Txt = {
-	string(bytes: Uint8Array) {
+export const Txt = Object.freeze({
+	fromBytes(bytes: Uint8Array) {
 		return new TextDecoder().decode(bytes)
 	},
 
-	bytes(string: string) {
+	toBytes(string: string) {
 		return new TextEncoder().encode(string)
 	},
-}
+
+	/** @deprecated renamed to `fromBytes` */
+	string(bytes: Uint8Array) {
+		return Txt.fromBytes(bytes)
+	},
+
+	/** @deprecated renamed to `toBytes` */
+	bytes(string: string) {
+		return Txt.toBytes(string)
+	},
+})
 

package/s/deadline.ts

@@ -24,3 +24,4 @@ export function deadline<R>(milliseconds: number, message: string, fn: () => Pro
 			.finally(() => clearTimeout(id))
 	})
 }
+