wire-mesh-core 1.3.0 → 1.4.0

package/dist/domain/room-path.cjs

@@ -0,0 +1,58 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/domain/room-path.ts
+/**
+* Room paths — the naming and parsing convention core/room's device-keyed membership uses, mirroring spec/room.cddl's own owner-named-room-path/dm-room-path grammar exactly: an owner-named room is `<owner-hex>/<local-name>`, trust rooted at the owner named in the path; a DM is the bytewise-ascending sorted pair `<lower-hex>+<higher-hex>`, trust rooted at the verifier itself rather than either named party (see room.cddl's own comments for why that asymmetry is load-bearing, not incidental).
+*/
+const DEVICE_ID_HEX_PATTERN = /^[0-9a-f]{64}$/;
+const LOCAL_NAME_PATTERN = /^[A-Za-z0-9_-]+$/;
+const SLUG_INVALID_RUN = /[^A-Za-z0-9_-]+/g;
+function assertDeviceIdHex(value, label) {
+	if (!DEVICE_ID_HEX_PATTERN.test(value)) throw new Error(`expected ${label} to be a 64-character lowercase hex device-id, got ${JSON.stringify(value)}`);
+}
+/** `<owner-hex>/<local-name>`. localName must already satisfy [A-Za-z0-9_-]+ -- run an untrusted name through slugRoomName first. */
+function ownerNamedRoomPath(owner, localName) {
+	assertDeviceIdHex(owner, "owner");
+	if (!LOCAL_NAME_PATTERN.test(localName)) throw new Error(`expected localName to match [A-Za-z0-9_-]+, got ${JSON.stringify(localName)}`);
+	return `${owner}/${localName}`;
+}
+/** `<lower-hex>+<higher-hex>`, the bytewise-ascending sorted pair. Refuses a==b outright: a path naming the same device twice is not a valid DM path at all, and a self-DM is a purely local concept a consumer models its own way, needing no path. */
+function dmRoomPath(a, b) {
+	assertDeviceIdHex(a, "a");
+	assertDeviceIdHex(b, "b");
+	if (a === b) throw new Error(`a DM room path cannot name the same device twice (${a})`);
+	return a < b ? `${a}+${b}` : `${b}+${a}`;
+}
+/** Parses a room-path back into its owner-named or DM shape. Throws on anything matching neither -- there is no third path shape. */
+function parseRoomPath(path) {
+	const slashIndex = path.indexOf("/");
+	if (slashIndex !== -1) {
+		const owner = path.slice(0, slashIndex);
+		const localName = path.slice(slashIndex + 1);
+		if (DEVICE_ID_HEX_PATTERN.test(owner) && LOCAL_NAME_PATTERN.test(localName)) return {
+			kind: "owner-named",
+			owner,
+			localName
+		};
+	}
+	const plusIndex = path.indexOf("+");
+	if (plusIndex !== -1) {
+		const first = path.slice(0, plusIndex);
+		const second = path.slice(plusIndex + 1);
+		if (DEVICE_ID_HEX_PATTERN.test(first) && DEVICE_ID_HEX_PATTERN.test(second) && first !== second) return {
+			kind: "dm",
+			participants: [first, second]
+		};
+	}
+	throw new Error(`${JSON.stringify(path)} is not a valid room-path`);
+}
+/** Sanitises an arbitrary name (e.g. a directory basename) into a valid room-path localName by replacing every run of characters outside [A-Za-z0-9_-] with a single hyphen. Throws if nothing valid remains. */
+function slugRoomName(name) {
+	const slug = name.replace(SLUG_INVALID_RUN, "-").replace(/^-+|-+$/g, "");
+	if (slug.length === 0) throw new Error(`${JSON.stringify(name)} has no valid room-name characters to slug`);
+	return slug;
+}
+//#endregion
+exports.dmRoomPath = dmRoomPath;
+exports.ownerNamedRoomPath = ownerNamedRoomPath;
+exports.parseRoomPath = parseRoomPath;
+exports.slugRoomName = slugRoomName;

package/dist/domain/room-path.d.cts

@@ -0,0 +1,21 @@
+//#region src/domain/room-path.d.ts
+/**
+ * Room paths — the naming and parsing convention core/room's device-keyed membership uses, mirroring spec/room.cddl's own owner-named-room-path/dm-room-path grammar exactly: an owner-named room is `<owner-hex>/<local-name>`, trust rooted at the owner named in the path; a DM is the bytewise-ascending sorted pair `<lower-hex>+<higher-hex>`, trust rooted at the verifier itself rather than either named party (see room.cddl's own comments for why that asymmetry is load-bearing, not incidental).
+ */
+/** `<owner-hex>/<local-name>`. localName must already satisfy [A-Za-z0-9_-]+ -- run an untrusted name through slugRoomName first. */
+export declare function ownerNamedRoomPath(owner: string, localName: string): string;
+/** `<lower-hex>+<higher-hex>`, the bytewise-ascending sorted pair. Refuses a==b outright: a path naming the same device twice is not a valid DM path at all, and a self-DM is a purely local concept a consumer models its own way, needing no path. */
+export declare function dmRoomPath(a: string, b: string): string;
+export type ParsedRoomPath = {
+  kind: "owner-named";
+  owner: string;
+  localName: string;
+} | {
+  kind: "dm";
+  participants: [string, string];
+};
+/** Parses a room-path back into its owner-named or DM shape. Throws on anything matching neither -- there is no third path shape. */
+export declare function parseRoomPath(path: string): ParsedRoomPath;
+/** Sanitises an arbitrary name (e.g. a directory basename) into a valid room-path localName by replacing every run of characters outside [A-Za-z0-9_-] with a single hyphen. Throws if nothing valid remains. */
+export declare function slugRoomName(name: string): string;
+//#endregion

package/dist/domain/room-path.d.mts

@@ -0,0 +1,21 @@
+//#region src/domain/room-path.d.ts
+/**
+ * Room paths — the naming and parsing convention core/room's device-keyed membership uses, mirroring spec/room.cddl's own owner-named-room-path/dm-room-path grammar exactly: an owner-named room is `<owner-hex>/<local-name>`, trust rooted at the owner named in the path; a DM is the bytewise-ascending sorted pair `<lower-hex>+<higher-hex>`, trust rooted at the verifier itself rather than either named party (see room.cddl's own comments for why that asymmetry is load-bearing, not incidental).
+ */
+/** `<owner-hex>/<local-name>`. localName must already satisfy [A-Za-z0-9_-]+ -- run an untrusted name through slugRoomName first. */
+export declare function ownerNamedRoomPath(owner: string, localName: string): string;
+/** `<lower-hex>+<higher-hex>`, the bytewise-ascending sorted pair. Refuses a==b outright: a path naming the same device twice is not a valid DM path at all, and a self-DM is a purely local concept a consumer models its own way, needing no path. */
+export declare function dmRoomPath(a: string, b: string): string;
+export type ParsedRoomPath = {
+  kind: "owner-named";
+  owner: string;
+  localName: string;
+} | {
+  kind: "dm";
+  participants: [string, string];
+};
+/** Parses a room-path back into its owner-named or DM shape. Throws on anything matching neither -- there is no third path shape. */
+export declare function parseRoomPath(path: string): ParsedRoomPath;
+/** Sanitises an arbitrary name (e.g. a directory basename) into a valid room-path localName by replacing every run of characters outside [A-Za-z0-9_-] with a single hyphen. Throws if nothing valid remains. */
+export declare function slugRoomName(name: string): string;
+//#endregion

package/dist/domain/room-path.mjs

@@ -0,0 +1,54 @@
+//#region src/domain/room-path.ts
+/**
+* Room paths — the naming and parsing convention core/room's device-keyed membership uses, mirroring spec/room.cddl's own owner-named-room-path/dm-room-path grammar exactly: an owner-named room is `<owner-hex>/<local-name>`, trust rooted at the owner named in the path; a DM is the bytewise-ascending sorted pair `<lower-hex>+<higher-hex>`, trust rooted at the verifier itself rather than either named party (see room.cddl's own comments for why that asymmetry is load-bearing, not incidental).
+*/
+const DEVICE_ID_HEX_PATTERN = /^[0-9a-f]{64}$/;
+const LOCAL_NAME_PATTERN = /^[A-Za-z0-9_-]+$/;
+const SLUG_INVALID_RUN = /[^A-Za-z0-9_-]+/g;
+function assertDeviceIdHex(value, label) {
+	if (!DEVICE_ID_HEX_PATTERN.test(value)) throw new Error(`expected ${label} to be a 64-character lowercase hex device-id, got ${JSON.stringify(value)}`);
+}
+/** `<owner-hex>/<local-name>`. localName must already satisfy [A-Za-z0-9_-]+ -- run an untrusted name through slugRoomName first. */
+function ownerNamedRoomPath(owner, localName) {
+	assertDeviceIdHex(owner, "owner");
+	if (!LOCAL_NAME_PATTERN.test(localName)) throw new Error(`expected localName to match [A-Za-z0-9_-]+, got ${JSON.stringify(localName)}`);
+	return `${owner}/${localName}`;
+}
+/** `<lower-hex>+<higher-hex>`, the bytewise-ascending sorted pair. Refuses a==b outright: a path naming the same device twice is not a valid DM path at all, and a self-DM is a purely local concept a consumer models its own way, needing no path. */
+function dmRoomPath(a, b) {
+	assertDeviceIdHex(a, "a");
+	assertDeviceIdHex(b, "b");
+	if (a === b) throw new Error(`a DM room path cannot name the same device twice (${a})`);
+	return a < b ? `${a}+${b}` : `${b}+${a}`;
+}
+/** Parses a room-path back into its owner-named or DM shape. Throws on anything matching neither -- there is no third path shape. */
+function parseRoomPath(path) {
+	const slashIndex = path.indexOf("/");
+	if (slashIndex !== -1) {
+		const owner = path.slice(0, slashIndex);
+		const localName = path.slice(slashIndex + 1);
+		if (DEVICE_ID_HEX_PATTERN.test(owner) && LOCAL_NAME_PATTERN.test(localName)) return {
+			kind: "owner-named",
+			owner,
+			localName
+		};
+	}
+	const plusIndex = path.indexOf("+");
+	if (plusIndex !== -1) {
+		const first = path.slice(0, plusIndex);
+		const second = path.slice(plusIndex + 1);
+		if (DEVICE_ID_HEX_PATTERN.test(first) && DEVICE_ID_HEX_PATTERN.test(second) && first !== second) return {
+			kind: "dm",
+			participants: [first, second]
+		};
+	}
+	throw new Error(`${JSON.stringify(path)} is not a valid room-path`);
+}
+/** Sanitises an arbitrary name (e.g. a directory basename) into a valid room-path localName by replacing every run of characters outside [A-Za-z0-9_-] with a single hyphen. Throws if nothing valid remains. */
+function slugRoomName(name) {
+	const slug = name.replace(SLUG_INVALID_RUN, "-").replace(/^-+|-+$/g, "");
+	if (slug.length === 0) throw new Error(`${JSON.stringify(name)} has no valid room-name characters to slug`);
+	return slug;
+}
+//#endregion
+export { dmRoomPath, ownerNamedRoomPath, parseRoomPath, slugRoomName };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wire-mesh-core",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "type": "module",
   "packageManager": "pnpm@10.33.0",
   "repository": {
@@ -100,6 +100,10 @@
       "import": "./dist/domain/revocation-view.mjs",
       "require": "./dist/domain/revocation-view.cjs"
     },
+    "./domain/room-path": {
+      "import": "./dist/domain/room-path.mjs",
+      "require": "./dist/domain/room-path.cjs"
+    },
     "./domain/tokens": {
       "import": "./dist/domain/tokens.mjs",
       "require": "./dist/domain/tokens.cjs"