@volorio/chat-e2ee 0.2.0

package/README.md

@@ -0,0 +1,18 @@
+# @volorio/chat-e2ee
+
+Volorio Chat end-to-end encryption add-on contracts.
+
+This package exposes Volorio-branded Signal Protocol compatible envelope helpers for customer clients. It does not send plaintext to Volorio services. A real Signal Protocol engine must be provided by the application; otherwise `createEnvelope` fails with `volorio_signal_protocol_engine_required`.
+
+```ts
+import { createVolorioChatE2eeClient } from "@volorio/chat-e2ee";
+
+const e2ee = createVolorioChatE2eeClient(signalEngine);
+const encryption = await e2ee.createEnvelope({
+  plaintext: new TextEncoder().encode("secret"),
+  senderDeviceId: "device_a",
+  recipientDeviceIds: ["device_b"],
+});
+```
+
+Send the returned `encryption` object through `@volorio/chat`. The chat service stores only encrypted payload metadata and marks moderation status as `encrypted_unscanned`.

package/dist/src/index.d.ts

@@ -0,0 +1,22 @@
+import type { VolorioSignalE2eeEnvelope } from "@volorio/chat";
+export interface VolorioSignalProtocolEncryptInput {
+    plaintext: Uint8Array;
+    senderDeviceId: string;
+    recipientDeviceIds: string[];
+    aad?: Uint8Array;
+}
+export interface VolorioSignalProtocolEngine {
+    encrypt(input: VolorioSignalProtocolEncryptInput): Promise<{
+        ciphertext: string;
+        contentHash: string;
+    }>;
+}
+export declare class MissingSignalProtocolEngineError extends Error {
+    constructor();
+}
+export declare class VolorioChatE2eeClient {
+    private readonly engine?;
+    constructor(engine?: VolorioSignalProtocolEngine | undefined);
+    createEnvelope(input: VolorioSignalProtocolEncryptInput): Promise<VolorioSignalE2eeEnvelope>;
+}
+export declare function createVolorioChatE2eeClient(engine?: VolorioSignalProtocolEngine): VolorioChatE2eeClient;

package/dist/src/index.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VolorioChatE2eeClient = exports.MissingSignalProtocolEngineError = void 0;
+exports.createVolorioChatE2eeClient = createVolorioChatE2eeClient;
+class MissingSignalProtocolEngineError extends Error {
+    constructor() {
+        super("volorio_signal_protocol_engine_required");
+    }
+}
+exports.MissingSignalProtocolEngineError = MissingSignalProtocolEngineError;
+class VolorioChatE2eeClient {
+    engine;
+    constructor(engine) {
+        this.engine = engine;
+    }
+    async createEnvelope(input) {
+        if (this.engine === undefined) {
+            throw new MissingSignalProtocolEngineError();
+        }
+        const encrypted = await this.engine.encrypt(input);
+        return {
+            enabled: true,
+            protocol: "signal",
+            version: "x3dh-double-ratchet-v1",
+            senderDeviceId: input.senderDeviceId,
+            recipientDeviceIds: input.recipientDeviceIds,
+            ciphertext: encrypted.ciphertext,
+            contentHash: encrypted.contentHash,
+        };
+    }
+}
+exports.VolorioChatE2eeClient = VolorioChatE2eeClient;
+function createVolorioChatE2eeClient(engine) {
+    return new VolorioChatE2eeClient(engine);
+}
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AA0CA,kEAEC;AA5BD,MAAa,gCAAiC,SAAQ,KAAK;IACzD;QACE,KAAK,CAAC,yCAAyC,CAAC,CAAC;IACnD,CAAC;CACF;AAJD,4EAIC;AAED,MAAa,qBAAqB;IACH;IAA7B,YAA6B,MAAoC;QAApC,WAAM,GAAN,MAAM,CAA8B;IAAG,CAAC;IAErE,KAAK,CAAC,cAAc,CAAC,KAAwC;QAC3D,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,IAAI,gCAAgC,EAAE,CAAC;QAC/C,CAAC;QACD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACnD,OAAO;YACL,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,QAAQ;YAClB,OAAO,EAAE,wBAAwB;YACjC,cAAc,EAAE,KAAK,CAAC,cAAc;YACpC,kBAAkB,EAAE,KAAK,CAAC,kBAAkB;YAC5C,UAAU,EAAE,SAAS,CAAC,UAAU;YAChC,WAAW,EAAE,SAAS,CAAC,WAAW;SACnC,CAAC;IACJ,CAAC;CACF;AAlBD,sDAkBC;AAED,SAAgB,2BAA2B,CAAC,MAAoC;IAC9E,OAAO,IAAI,qBAAqB,CAAC,MAAM,CAAC,CAAC;AAC3C,CAAC"}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@volorio/chat-e2ee",
+  "version": "0.2.0",
+  "private": false,
+  "description": "Volorio Signal Protocol compatible end-to-end encryption add-on contracts for chat.",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "default": "./dist/src/index.js"
+    }
+  },
+  "files": ["dist/src", "README.md"],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "test": "pnpm build",
+    "pack:local": "pnpm build && npm pack --pack-destination dist"
+  },
+  "dependencies": {
+    "@privacyresearch/libsignal-protocol-typescript": "^0.0.16",
+    "@volorio/chat": "^0.2.0"
+  }
+}