@gryt/core 0.11.0 → 0.12.0

package/README.md

@@ -53,7 +53,10 @@ goes missing **and** when one appears that nobody listed.
   the interfaces in `src/mls/interfaces.ts`. `mlsPinsFromPeerPins` builds the
   pins from the peer pins `@gryt/crypto` already keeps.
   `encodeMlsDmContent` and `decodeMlsDmContent` write and read what goes inside
-  each message, so both apps use the same JSON. It's the one module with a
+  each message, so both apps use the same JSON: a message, an edit, a delete or
+  a reaction. `readMlsDmContent` also says when something came from a newer app,
+  so it can be skipped quietly rather than counted as broken. `applyMlsReaction` puts a reaction on a message in the archive,
+  since the server never sees one. It's the one module with a
   dependency, `@gryt/crypto`, pinned exactly the way the apps pin it.
 
 ## What deliberately isn't

package/dist/index.d.ts

@@ -12,5 +12,6 @@ export { describeFolderRules, folderFollowNote, folderPhrase, } from "./permissi
 export { agreementAt, createTermsGate, GUIDELINES_URL, TERMS_STORAGE_KEY, TERMS_URL, TERMS_VERSION, } from "./terms/termsAgreement.js";
 export { createMlsDmDriver, MlsDriverError, type MlsDriverErrorCode } from "./mls/dmDriver.js";
 export { mlsPinsFromPeerPins } from "./mls/pins.js";
-export { decodeMlsDmContent, encodeMlsDmContent, MLS_DM_CONTENT_VERSION, type MlsDmContent, } from "./mls/content.js";
+export { decodeMlsDmContent, encodeMlsDmContent, MLS_DM_CONTENT_VERSION, type MlsDmContent, readMlsDmContent, } from "./mls/content.js";
+export { applyMlsReaction, mlsReactionAction, type MlsReaction } from "./mls/reactions.js";
 export type { DmSealingMode, MlsClaimedKeyPackage, MlsDecryptedMessage, MlsDeviceRecord, MlsDeviceRef, MlsDmDriver, MlsDmDriverOptions, MlsDmEvents, MlsGroupRecord, MlsGroupView, MlsKeyPackageRecord, MlsLogEntry, MlsPins, MlsRefusal, MlsReply, MlsServerCapability, MlsStateStore, MlsTransport, MlsWelcomeDelivery, } from "./mls/interfaces.js";

package/dist/index.js

@@ -14,4 +14,5 @@ export { describeFolderRules, folderFollowNote, folderPhrase, } from "./permissi
 export { agreementAt, createTermsGate, GUIDELINES_URL, TERMS_STORAGE_KEY, TERMS_URL, TERMS_VERSION, } from "./terms/termsAgreement.js";
 export { createMlsDmDriver, MlsDriverError } from "./mls/dmDriver.js";
 export { mlsPinsFromPeerPins } from "./mls/pins.js";
-export { decodeMlsDmContent, encodeMlsDmContent, MLS_DM_CONTENT_VERSION, } from "./mls/content.js";
+export { decodeMlsDmContent, encodeMlsDmContent, MLS_DM_CONTENT_VERSION, readMlsDmContent, } from "./mls/content.js";
+export { applyMlsReaction, mlsReactionAction } from "./mls/reactions.js";

package/dist/mls/content.d.ts

@@ -14,9 +14,22 @@ export type MlsDmContent = {
 } | {
     type: "delete";
     id: string;
+} | {
+    type: "reaction";
+    /** The message reacted to, the way edits and deletes name theirs. */
+    id: string;
+    /** A Unicode emoji, or a server emoji as `:name:`, the same string `chat:react` carries. */
+    emoji: string;
+    /** Explicit rather than a toggle, so a repeat or a reorder lands the same on every device. */
+    action: "add" | "remove";
 };
 export declare const MLS_DM_CONTENT_VERSION = 1;
 /** The same bytes the phone writes: `v` first, then the content's fields in this order. */
 export declare function encodeMlsDmContent(content: MlsDmContent): Uint8Array;
 /** Null for anything this version can't read: a newer version, a new type, or junk. */
 export declare function decodeMlsDmContent(bytes: Uint8Array): MlsDmContent | null;
+/**
+ * Like `decodeMlsDmContent`, but tells content from a newer app ("newer", skip it quietly)
+ * apart from junk (null, which is worth counting). A known type with a bad field is junk.
+ */
+export declare function readMlsDmContent(bytes: Uint8Array): MlsDmContent | "newer" | null;

package/dist/mls/content.js

@@ -6,10 +6,27 @@ const MAX_TEXT = 32_000;
 const MAX_ATTACHMENTS = 10;
 const MAX_LABEL = 255;
 const UPLOAD_ID = /^[A-Za-z0-9_-]{1,128}$/;
+/** The server's own rule for an emoji's name, in `emojiShared.ts`. */
+const CUSTOM_EMOJI = /^:[A-Za-z0-9_]{2,32}:$/;
+/** The longest RGI emoji, a kiss with two skin tones, is ten code points. */
+const MAX_EMOJI_CODE_POINTS = 12;
+const EMOJI_PART = /^(?:\p{Extended_Pictographic}|\p{Emoji_Component}|\uFE0E)$/u;
+const EMOJI_BASE = /^(?:\p{Extended_Pictographic}|\p{Regional_Indicator}|\u20E3)$/u;
 const isId = (v) => typeof v === "string" && v.length > 0 && v.length <= MAX_ID;
 const isText = (v) => typeof v === "string" && v.length <= MAX_TEXT;
 const isCount = (v) => typeof v === "number" && Number.isSafeInteger(v) && v >= 0;
 const isLabel = (v) => typeof v === "string" && v.length <= MAX_LABEL;
+/** One emoji's worth of emoji characters, so a peer can't put a sentence on a message as a reaction. */
+function isReactionEmoji(v) {
+    if (typeof v !== "string")
+        return false;
+    if (CUSTOM_EMOJI.test(v))
+        return true;
+    const points = Array.from(v);
+    if (points.length === 0 || points.length > MAX_EMOJI_CODE_POINTS)
+        return false;
+    return points.every((p) => EMOJI_PART.test(p)) && points.some((p) => EMOJI_BASE.test(p));
+}
 function isObject(v) {
     return typeof v === "object" && v !== null && !Array.isArray(v);
 }
@@ -72,6 +89,9 @@ export function encodeMlsDmContent(content) {
     else if (content.type === "edit") {
         body = { type: content.type, id: content.id, text: content.text };
     }
+    else if (content.type === "reaction") {
+        body = { type: content.type, id: content.id, emoji: content.emoji, action: content.action };
+    }
     else {
         body = { type: content.type, id: content.id };
     }
@@ -82,13 +102,35 @@ export function encodeMlsDmContent(content) {
 }
 /** Null for anything this version can't read: a newer version, a new type, or junk. */
 export function decodeMlsDmContent(bytes) {
-    let raw;
+    return fromRaw(parse(bytes));
+}
+/**
+ * Like `decodeMlsDmContent`, but tells content from a newer app ("newer", skip it quietly)
+ * apart from junk (null, which is worth counting). A known type with a bad field is junk.
+ */
+export function readMlsDmContent(bytes) {
+    const raw = parse(bytes);
+    return fromRaw(raw) ?? (isNewer(raw) ? "newer" : null);
+}
+const KNOWN_TYPES = new Set(["message", "edit", "delete", "reaction"]);
+const TYPE_NAME = /^[a-z][a-z0-9_]{0,31}$/;
+/** A later version, or a type this one doesn't know that names its message the way ours do. */
+function isNewer(raw) {
+    if (!isObject(raw) || typeof raw.type !== "string" || !TYPE_NAME.test(raw.type))
+        return false;
+    if (raw.v === MLS_DM_CONTENT_VERSION)
+        return !KNOWN_TYPES.has(raw.type) && isId(raw.id);
+    return typeof raw.v === "number" && Number.isSafeInteger(raw.v) && raw.v > MLS_DM_CONTENT_VERSION;
+}
+function parse(bytes) {
     try {
-        raw = JSON.parse(new TextDecoder("utf-8", { fatal: true }).decode(bytes));
+        return JSON.parse(new TextDecoder("utf-8", { fatal: true }).decode(bytes));
     }
     catch {
         return null;
     }
+}
+function fromRaw(raw) {
     if (!isObject(raw) || raw.v !== MLS_DM_CONTENT_VERSION || !isId(raw.id))
         return null;
     const { type, id, text } = raw;
@@ -111,5 +153,8 @@ export function decodeMlsDmContent(bytes) {
         return { type, id, text };
     if (type === "delete")
         return { type, id };
+    if (type === "reaction" && isReactionEmoji(raw.emoji) && (raw.action === "add" || raw.action === "remove")) {
+        return { type, id, emoji: raw.emoji, action: raw.action };
+    }
     return null;
 }

package/dist/mls/reactions.d.ts

@@ -0,0 +1,13 @@
+export interface MlsReaction {
+    src: string;
+    amount: number;
+    users: string[];
+}
+/** Adding twice or removing what isn't there changes nothing, so replays and reorders are safe. */
+export declare function applyMlsReaction(reactions: readonly MlsReaction[] | null | undefined, change: {
+    emoji: string;
+    userId: string;
+    action: "add" | "remove";
+}): MlsReaction[];
+/** What a tap on a reaction chip means for this person: take theirs off, or put it on. */
+export declare function mlsReactionAction(reactions: readonly MlsReaction[] | null | undefined, emoji: string, userId: string): "add" | "remove";

package/dist/mls/reactions.js

@@ -0,0 +1,26 @@
+/* Reactions on an MLS message live only in each device's archive. One reducer for both apps,
+   in the `{ src, amount, users }` shape the server sends for every other message. */
+/** Adding twice or removing what isn't there changes nothing, so replays and reorders are safe. */
+export function applyMlsReaction(reactions, change) {
+    const { emoji, userId, action } = change;
+    const list = (reactions ?? []).map((r) => ({ src: r.src, amount: r.users.length, users: [...r.users] }));
+    const existing = list.find((r) => r.src === emoji);
+    if (action === "add") {
+        if (!existing)
+            list.push({ src: emoji, amount: 1, users: [userId] });
+        else if (!existing.users.includes(userId)) {
+            existing.users.push(userId);
+            existing.amount = existing.users.length;
+        }
+        return list;
+    }
+    if (existing) {
+        existing.users = existing.users.filter((u) => u !== userId);
+        existing.amount = existing.users.length;
+    }
+    return list.filter((r) => r.amount > 0);
+}
+/** What a tap on a reaction chip means for this person: take theirs off, or put it on. */
+export function mlsReactionAction(reactions, emoji, userId) {
+    return reactions?.some((r) => r.src === emoji && r.users.includes(userId)) ? "remove" : "add";
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gryt/core",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Gryt's shared application logic: one implementation of the things the desktop and mobile apps both do.",
   "license": "AGPL-3.0-only",
   "repository": {