@keyhive/keyhive 0.0.0-alpha.0

package/README.md

@@ -0,0 +1,34 @@
+# Keyhive WASM bindings
+
+## Build package
+
+```
+wasm-pack build --target web --out-dir pkg -- --features web-sys
+```
+
+To build with the `ingest_static` feature:
+```
+wasm-pack build --target web --out-dir pkg -- --features web-sys,ingest_static
+```
+
+## Run tests
+
+Install dependencies:
+```
+pnpm install
+```
+
+Install Playwright's browser binaries:
+```
+npx playwright install
+```
+
+Run tests:
+```
+npx playwright test
+```
+
+View Playwright report:
+```
+npx playwright show-report
+```

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@keyhive/keyhive",
+  "version": "0.0.0-alpha.0",
+  "description": "",
+  "main": "pkg/keyhive_wasm.js",
+  "keywords": [],
+  "author": "",
+  "license": "Apache-2.0",
+  "type": "module",
+  "module": "pkg/keyhive_wasm.js",
+  "types": "pkg/keyhive_wasm.d.ts",
+  "files": [
+    "pkg/*",
+    "pkg-node/*"
+  ],
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./pkg-node/keyhive_wasm.js",
+        "require": "./pkg-node/keyhive_wasm.js",
+        "types": "./pkg-node/keyhive_wasm.d.ts"
+      },
+      "import": "./pkg/keyhive_wasm.js",
+      "require": "./pkg/keyhive_wasm.js",
+      "types": "./pkg/keyhive_wasm.d.ts"
+    }
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.55.0",
+    "@types/node": "^22.17.2",
+    "html-webpack-plugin": "^5.6.4",
+    "ts-loader": "^9.5.2",
+    "typescript": "^5.9.2",
+    "vite": "^5.4.19",
+    "vite-plugin-top-level-await": "^1.6.0",
+    "vite-plugin-wasm": "^3.5.0",
+    "webpack": "^5.101.3",
+    "webpack-cli": "^5.1.4",
+    "webpack-dev-server": "^5.2.2"
+  },
+  "scripts": {
+    "build": "npm run build-node && npm run build-bundler",
+    "build-node": "wasm-pack build --out-dir pkg-node --target nodejs --release",
+    "build-bundler": "wasm-pack build --out-dir pkg --target bundler --release"
+  }
+}

package/pkg/.gitignore

@@ -0,0 +1 @@
+*

package/pkg/README.md

@@ -0,0 +1,34 @@
+# Keyhive WASM bindings
+
+## Build package
+
+```
+wasm-pack build --target web --out-dir pkg -- --features web-sys
+```
+
+To build with the `ingest_static` feature:
+```
+wasm-pack build --target web --out-dir pkg -- --features web-sys,ingest_static
+```
+
+## Run tests
+
+Install dependencies:
+```
+pnpm install
+```
+
+Install Playwright's browser binaries:
+```
+npx playwright install
+```
+
+Run tests:
+```
+npx playwright test
+```
+
+View Playwright report:
+```
+npx playwright show-report
+```

package/pkg/keyhive_wasm.d.ts

@@ -0,0 +1,349 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Panic hook lets us get better error messages if our Rust code ever panics.
+ *
+ * This function needs to be called at least once during initialisation.
+ * https://rustwasm.github.io/docs/wasm-pack/tutorials/npm-browser-packages/template-deep-dive/src-utils-rs.html#2-what-is-console_error_panic_hook
+ */
+export function setPanicHook(): void;
+export class Access {
+  private constructor();
+  free(): void;
+  static tryFromString(s: string): Access | undefined;
+  toString(): string;
+}
+export class AddMemberError {
+  private constructor();
+  free(): void;
+  message(): string;
+}
+export class Agent {
+  private constructor();
+  free(): void;
+  toString(): string;
+  isIndividual(): boolean;
+  isGroup(): boolean;
+  isDocument(): boolean;
+  readonly id: Identifier;
+}
+export class Archive {
+  free(): void;
+  constructor(bytes: Uint8Array);
+  toBytes(): Uint8Array;
+  tryToKeyhive(ciphertext_store: CiphertextStore, signer: Signer, event_handler: Function): Keyhive;
+}
+export class CannotParseEd25519SigningKey {
+  private constructor();
+  free(): void;
+}
+export class CannotParseIdentifier {
+  private constructor();
+  free(): void;
+}
+export class Capability {
+  private constructor();
+  free(): void;
+  readonly who: Agent;
+  readonly can: Access;
+  readonly proof: SignedDelegation;
+}
+export class CgkaOperation {
+  private constructor();
+  free(): void;
+  readonly variant: string;
+}
+export class ChangeRef {
+  free(): void;
+  constructor(bytes: Uint8Array);
+  readonly bytes: Uint8Array;
+}
+export class CiphertextStore {
+  private constructor();
+  free(): void;
+  static newInMemory(): CiphertextStore;
+  static newFromWebStorage(storage: Storage): CiphertextStore;
+}
+export class ContactCard {
+  private constructor();
+  free(): void;
+  signature(): Uint8Array;
+  static fromJson(json: string): ContactCard;
+  toJson(): string;
+  readonly id: IndividualId;
+  readonly shareKey: ShareKey;
+}
+export class Delegation {
+  private constructor();
+  free(): void;
+  readonly delegate: Agent;
+  readonly can: Access;
+  readonly proof: SignedDelegation | undefined;
+  readonly after: History;
+}
+export class DelegationError {
+  private constructor();
+  free(): void;
+}
+export class DocContentRefs {
+  free(): void;
+  constructor(doc_id: DocumentId, change_hashes: ChangeRef[]);
+  addChangeRef(hash: ChangeRef): void;
+  readonly docId: DocumentId;
+  readonly change_hashes: ChangeRef[];
+}
+export class Document {
+  private constructor();
+  free(): void;
+  toPeer(): Peer;
+  toAgent(): Agent;
+  readonly id: Identifier;
+  readonly doc_id: DocumentId;
+}
+export class DocumentId {
+  free(): void;
+  constructor(bytes: Uint8Array);
+  fromString(): string;
+  toJsValue(): any;
+  toBytes(): Uint8Array;
+}
+export class Encrypted {
+  private constructor();
+  free(): void;
+  toBytes(): Uint8Array;
+  readonly ciphertext: Uint8Array;
+  readonly nonce: Uint8Array;
+  readonly pcs_key_hash: Uint8Array;
+  readonly content_ref: Uint8Array;
+  readonly pred_refs: Uint8Array;
+}
+export class EncryptedContentWithUpdate {
+  private constructor();
+  free(): void;
+  encrypted_content(): Encrypted;
+  update_op(): SignedCgkaOperation | undefined;
+}
+export class Event {
+  private constructor();
+  free(): void;
+  tryIntoSignedDelegation(): SignedDelegation | undefined;
+  tryIntoSignedRevocation(): SignedRevocation | undefined;
+  readonly variant: string;
+  readonly isDelegated: boolean;
+  readonly isRevoked: boolean;
+}
+export class GenerateDocError {
+  private constructor();
+  free(): void;
+  message(): string;
+}
+export class GenerateWebCryptoError {
+  private constructor();
+  free(): void;
+  message(): string;
+}
+export class GetCiphertextError {
+  private constructor();
+  free(): void;
+  readonly message: string;
+}
+export class Group {
+  private constructor();
+  free(): void;
+  toPeer(): Peer;
+  toAgent(): Agent;
+  toMembered(): Membered;
+  readonly id: Identifier;
+  readonly groupId: GroupId;
+  readonly members: Capability[];
+}
+export class GroupId {
+  private constructor();
+  free(): void;
+  toString(): string;
+}
+export class History {
+  private constructor();
+  free(): void;
+  delegations(): SignedDelegation[];
+  revocations(): SignedRevocation[];
+  contentRefs(): DocContentRefs[];
+}
+export class Identifier {
+  free(): void;
+  constructor(bytes: Uint8Array);
+  toBytes(): Uint8Array;
+}
+export class Individual {
+  private constructor();
+  free(): void;
+  toPeer(): Peer;
+  toAgent(): Agent;
+  pickPrekey(doc_id: DocumentId): ShareKey;
+  readonly id: Identifier;
+  readonly individualId: IndividualId;
+}
+export class IndividualId {
+  private constructor();
+  free(): void;
+  readonly bytes: Uint8Array;
+}
+export class Invocation {
+  private constructor();
+  free(): void;
+}
+export class JsDecryptError {
+  private constructor();
+  free(): void;
+}
+export class JsEncryptError {
+  private constructor();
+  free(): void;
+}
+export class JsReceivePreKeyOpError {
+  private constructor();
+  free(): void;
+}
+export class JsReceiveStaticEventError {
+  private constructor();
+  free(): void;
+}
+export class Keyhive {
+  private constructor();
+  free(): void;
+  static init(signer: Signer, ciphertext_store: CiphertextStore, event_handler: Function): Promise<Keyhive>;
+  generateGroup(coparents: Peer[]): Promise<Group>;
+  generateDocument(coparents: Peer[], initial_content_ref_head: ChangeRef, more_initial_content_refs: ChangeRef[]): Promise<Document>;
+  trySign(data: Uint8Array): Promise<Signed>;
+  tryEncrypt(doc: Document, content_ref: ChangeRef, pred_refs: ChangeRef[], content: Uint8Array): Promise<EncryptedContentWithUpdate>;
+  tryEncryptArchive(doc: Document, content_ref: ChangeRef, pred_refs: ChangeRef[], content: Uint8Array): Promise<EncryptedContentWithUpdate>;
+  tryDecrypt(doc: Document, encrypted: Encrypted): Uint8Array;
+  addMember(to_add: Agent, membered: Membered, access: Access, other_relevant_docs: Document[]): Promise<SignedDelegation>;
+  revokeMember(to_revoke: Agent, retain_all_other_members: boolean, membered: Membered): Promise<SignedRevocation[]>;
+  reachableDocs(): Summary[];
+  forcePcsUpdate(doc: Document): Promise<void>;
+  rotatePrekey(prekey: ShareKey): Promise<ShareKey>;
+  expandPrekeys(): Promise<ShareKey>;
+  contactCard(): Promise<ContactCard>;
+  receiveContactCard(contact_card: ContactCard): Individual;
+  getAgent(id: Identifier): Agent | undefined;
+  getGroup(id: Identifier): Group | undefined;
+  docMemberCapabilities(doc_id: DocumentId): SimpleCapability[];
+  accessForDoc(id: Identifier, doc_id: DocumentId): Access | undefined;
+  intoArchive(): Archive;
+  toArchive(): Archive;
+  readonly id: IndividualId;
+  readonly whoami: IndividualId;
+  readonly idString: string;
+}
+export class Membered {
+  private constructor();
+  free(): void;
+}
+export class Peer {
+  private constructor();
+  free(): void;
+  toString(): string;
+  isIndividual(): boolean;
+  isGroup(): boolean;
+  isDocument(): boolean;
+}
+export class RemoveCiphertextError {
+  private constructor();
+  free(): void;
+}
+export class Revocation {
+  private constructor();
+  free(): void;
+  readonly subject_id: Identifier;
+  readonly revoked: SignedDelegation;
+  readonly proof: SignedDelegation | undefined;
+  readonly after: History;
+}
+export class RevokeMemberError {
+  private constructor();
+  free(): void;
+  readonly message: string;
+}
+export class SerializationError {
+  private constructor();
+  free(): void;
+  toError(): any;
+}
+export class ShareKey {
+  private constructor();
+  free(): void;
+}
+export class Signed {
+  private constructor();
+  free(): void;
+  static fromBytes(bytes: Uint8Array): Signed;
+  toBytes(): Uint8Array;
+  verify(): boolean;
+  readonly payload: Uint8Array;
+  readonly verifyingKey: Uint8Array;
+  readonly signature: Uint8Array;
+}
+export class SignedCgkaOperation {
+  private constructor();
+  free(): void;
+  verify(): boolean;
+  readonly delegation: CgkaOperation;
+  readonly verifyingKey: Uint8Array;
+  readonly signature: Uint8Array;
+}
+export class SignedDelegation {
+  private constructor();
+  free(): void;
+  verify(): boolean;
+  readonly delegation: Delegation;
+  readonly verifyingKey: Uint8Array;
+  readonly signature: Uint8Array;
+}
+export class SignedInvocation {
+  private constructor();
+  free(): void;
+}
+export class SignedRevocation {
+  private constructor();
+  free(): void;
+  verify(): boolean;
+  readonly delegation: Revocation;
+  readonly verifyingKey: Uint8Array;
+  readonly signature: Uint8Array;
+}
+export class Signer {
+  private constructor();
+  free(): void;
+  static generate(): Promise<Signer>;
+  static generateMemory(): Signer;
+  static generateWebCrypto(): Promise<Signer>;
+  static memorySignerFromBytes(bytes: Uint8Array): Signer;
+  static webCryptoSigner(keypair: any): Promise<Signer>;
+  trySign(bytes: Uint8Array): Promise<Signed>;
+  clone(): Signer;
+  readonly variant: string;
+  readonly verifyingKey: Uint8Array;
+}
+export class SigningError {
+  private constructor();
+  free(): void;
+  message(): string;
+}
+export class SimpleCapability {
+  private constructor();
+  free(): void;
+  readonly who: Agent;
+  readonly can: Access;
+}
+export class Summary {
+  private constructor();
+  free(): void;
+  readonly doc: Document;
+  readonly access: Access;
+}
+export class TryFromArchiveError {
+  private constructor();
+  free(): void;
+  toError(): any;
+}

package/pkg/keyhive_wasm.js

@@ -0,0 +1,5 @@
+import * as wasm from "./keyhive_wasm_bg.wasm";
+export * from "./keyhive_wasm_bg.js";
+import { __wbg_set_wasm } from "./keyhive_wasm_bg.js";
+__wbg_set_wasm(wasm);
+wasm.__wbindgen_start();