@keyhive/keyhive 0.0.0-alpha.58 → 0.0.0-alpha.58b

package/pkg-node/keyhive_wasm.d.ts

@@ -0,0 +1,476 @@
+/* tslint:disable */
+/* eslint-disable */
+
+export class Access {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    toString(): string;
+    static tryFromString(s: string): Access | undefined;
+}
+
+export class Agent {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    isDocument(): boolean;
+    isGroup(): boolean;
+    isIndividual(): boolean;
+    /**
+     * Returns prekey operation hashes for this [`Agent`] as an array of hash bytes.
+     */
+    keyOpHashes(): Promise<Uint8Array[]>;
+    /**
+     * Returns prekey operations for this agent as a Map of hash -> serialized bytes for [`StaticEvent`]
+     */
+    keyOps(): Promise<Map<any, any>>;
+    toString(): string;
+    readonly id: Identifier;
+}
+
+/**
+ * Result of [`JsKeyhive::all_agent_events`], containing all events for all agents
+ * with deduplicated storage and two-tier indirection for membership, prekey, and CGKA ops.
+ *
+ * The consumer follows: agent -> source IDs -> hashes -> event bytes.
+ */
+export class AllAgentEvents {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    readonly agentCgkaSources: Map<any, any>;
+    readonly agentMembershipSources: Map<any, any>;
+    readonly agentPrekeySources: Map<any, any>;
+    readonly cgkaSources: Map<any, any>;
+    readonly events: Map<any, any>;
+    readonly membershipSources: Map<any, any>;
+    readonly prekeySources: Map<any, any>;
+}
+
+export class Archive {
+    free(): void;
+    [Symbol.dispose](): void;
+    toBytes(): Uint8Array;
+    tryToKeyhive(ciphertext_store: CiphertextStore, signer: Signer, event_handler: Function): Promise<Keyhive>;
+    constructor(bytes: Uint8Array);
+}
+
+export class CannotParseEd25519SigningKey {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+}
+
+export class CannotParseIdentifier {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+}
+
+export class Capability {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    readonly can: Access;
+    readonly proof: SignedDelegation;
+    readonly who: Agent;
+}
+
+export class CgkaOperation {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    readonly variant: string;
+}
+
+export class ChangeId {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Upcasts; to the JS-import type for [`JsChangeId`].
+     */
+    __wasm_refgen_toJsChangeId(): ChangeId;
+    constructor(bytes: Uint8Array);
+    readonly bytes: Uint8Array;
+}
+
+export class CiphertextStore {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    static newFromWebStorage(storage: Storage): CiphertextStore;
+    static newInMemory(): CiphertextStore;
+}
+
+export class ContactCard {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    static fromJson(json: string): ContactCard;
+    signature(): Uint8Array;
+    toJson(): string;
+    readonly id: Identifier;
+    readonly individualId: IndividualId;
+    readonly op: Event;
+    readonly shareKey: ShareKey;
+}
+
+export class Delegation {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    readonly after: History;
+    readonly can: Access;
+    readonly delegate: Agent;
+    readonly proof: SignedDelegation | undefined;
+}
+
+export class DocContentRefs {
+    free(): void;
+    [Symbol.dispose](): void;
+    addChangeId(hash: ChangeId): Promise<void>;
+    constructor(doc_id: DocumentId, change_hashes: ChangeId[]);
+    readonly change_hashes: Promise<ChangeId[]>;
+    readonly docId: DocumentId;
+}
+
+export class Document {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Upcasts; to the JS-import type for [`JsDocument`].
+     */
+    __wasm_refgen_toJsDocument(): Document;
+    members(): Promise<Capability[]>;
+    toAgent(): Agent;
+    toMembered(): Membered;
+    toPeer(): Peer;
+    readonly doc_id: DocumentId;
+    readonly id: Identifier;
+}
+
+export class DocumentId {
+    free(): void;
+    [Symbol.dispose](): void;
+    constructor(bytes: Uint8Array);
+    toBytes(): Uint8Array;
+    toJsValue(): any;
+    toString(): string;
+}
+
+export class Encrypted {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    static fromBytes(bytes: Uint8Array): Encrypted;
+    serialize(): Uint8Array;
+    toBytes(): Uint8Array;
+    readonly ciphertext: Uint8Array;
+    readonly content_ref: Uint8Array;
+    readonly nonce: Uint8Array;
+    readonly pcs_key_hash: Uint8Array;
+    readonly pred_refs: Uint8Array;
+}
+
+export class EncryptedContentWithUpdate {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    encrypted_content(): Encrypted;
+    update_op(): SignedCgkaOperation | undefined;
+}
+
+export class Event {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Converts the underlying [`Event`] to a [`StaticEvent`] and then
+     * serializes it.
+     */
+    toBytes(): Uint8Array;
+    tryIntoSignedDelegation(): SignedDelegation | undefined;
+    tryIntoSignedRevocation(): SignedRevocation | undefined;
+    readonly isDelegated: boolean;
+    readonly isRevoked: boolean;
+    readonly variant: string;
+}
+
+export class GenerateWebCryptoError {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    message(): string;
+}
+
+export class Group {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Upcasts; to the JS-import type for [`JsGroup`].
+     */
+    __wasm_refgen_toJsGroup(): Group;
+    members(): Promise<Capability[]>;
+    toAgent(): Agent;
+    toMembered(): Membered;
+    toPeer(): Peer;
+    readonly groupId: GroupId;
+    readonly id: Identifier;
+}
+
+export class GroupId {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    toString(): string;
+}
+
+export class History {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    contentRefs(): DocContentRefs[];
+    delegations(): SignedDelegation[];
+    revocations(): SignedRevocation[];
+}
+
+export class Identifier {
+    free(): void;
+    [Symbol.dispose](): void;
+    constructor(bytes: Uint8Array);
+    static publicId(): Identifier;
+    toBytes(): Uint8Array;
+}
+
+export class Individual {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    pickPrekey(doc_id: DocumentId): Promise<ShareKey>;
+    toAgent(): Agent;
+    toPeer(): Peer;
+    readonly id: Identifier;
+    readonly individualId: IndividualId;
+}
+
+export class IndividualId {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    readonly bytes: Uint8Array;
+}
+
+export class Invocation {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+}
+
+export class Keyhive {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    accessForDoc(id: Identifier, doc_id: DocumentId): Promise<Access | undefined>;
+    addMember(to_add: Agent, membered: Membered, access: Access, other_relevant_docs: Document[]): Promise<SignedDelegation>;
+    /**
+     * Returns all agent events with deduplicated storage and two-tier indirection
+     * for membership, prekey, and CGKA ops.
+     */
+    allAgentEvents(): Promise<AllAgentEvents>;
+    contactCard(): Promise<ContactCard>;
+    docMemberCapabilities(doc_id: DocumentId): Promise<Membership[]>;
+    /**
+     * Returns event hashes for provided [`JsAgent`] as an array of hash bytes.
+     */
+    eventHashesForAgent(agent: Agent): Promise<Array<any>>;
+    /**
+     * Returns events for provided [`Agent`] as a map from hash to serialized [`StaticEvent`] bytes.
+     */
+    eventsForAgent(agent: Agent): Promise<Map<any, any>>;
+    expandPrekeys(): Promise<ShareKey>;
+    exportPrekeySecrets(): Promise<Uint8Array>;
+    forcePcsUpdate(doc: Document): Promise<void>;
+    generateDocument(coparents: Peer[], initial_content_ref_head: ChangeId, more_initial_content_refs: ChangeId[]): Promise<Document>;
+    generateGroup(js_coparents: Peer[]): Promise<Group>;
+    getAgent(id: Identifier): Promise<Agent | undefined>;
+    getDocument(doc_id: DocumentId): Promise<Document | undefined>;
+    getExistingContactCard(): Promise<ContactCard>;
+    getGroup(group_id: GroupId): Promise<Group | undefined>;
+    getIndividual(id: IndividualId): Promise<Individual | undefined>;
+    importPrekeySecrets(bytes: Uint8Array): Promise<void>;
+    ingestArchive(archive: Archive): Promise<void>;
+    ingestEventsBytes(events_bytes_array: Array<any>): Promise<Array<any>>;
+    static init(signer: Signer, ciphertext_store: CiphertextStore, event_handler: Function): Promise<Keyhive>;
+    intoArchive(): Promise<Archive>;
+    membershipOpsForAgent(agent: Agent): Promise<Map<any, any>>;
+    pendingEventHashes(): Promise<Set<any>>;
+    reachableDocs(): Promise<Summary[]>;
+    receiveContactCard(contact_card: ContactCard): Promise<Individual>;
+    revokeMember(to_revoke: Agent, retain_all_other_members: boolean, membered: Membered): Promise<SignedRevocation[]>;
+    revokedMembersForDoc(doc_id: DocumentId): Promise<Membership[]>;
+    rotatePrekey(prekey: ShareKey): Promise<ShareKey>;
+    stats(): Promise<Stats>;
+    toArchive(): Promise<Archive>;
+    tryDecrypt(doc: Document, encrypted: Encrypted): Promise<Uint8Array>;
+    tryEncrypt(doc: Document, content_ref: ChangeId, js_pred_refs: ChangeId[], content: Uint8Array): Promise<EncryptedContentWithUpdate>;
+    tryEncryptArchive(doc: Document, content_ref: ChangeId, pred_refs: ChangeId[], content: Uint8Array): Promise<EncryptedContentWithUpdate>;
+    trySign(data: Uint8Array): Promise<Signed>;
+    readonly id: IndividualId;
+    readonly idString: string;
+    readonly individual: Promise<Individual>;
+    readonly whoami: IndividualId;
+}
+
+export class Membered {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+}
+
+export class Membership {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    readonly can: Access;
+    readonly who: Agent;
+}
+
+export class Peer {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Upcasts; to the JS-import type for [`JsPeer`].
+     */
+    __wasm_refgen_toJsPeer(): Peer;
+    isDocument(): boolean;
+    isGroup(): boolean;
+    isIndividual(): boolean;
+    toString(): string;
+    readonly id: Identifier;
+}
+
+export class Revocation {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    readonly after: History;
+    readonly proof: SignedDelegation | undefined;
+    readonly revoked: SignedDelegation;
+    readonly subject_id: Identifier;
+}
+
+export class ShareKey {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+}
+
+export class Signed {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    static fromBytes(bytes: Uint8Array): Signed;
+    toBytes(): Uint8Array;
+    verify(): boolean;
+    readonly payload: Uint8Array;
+    readonly signature: Uint8Array;
+    readonly verifyingKey: Uint8Array;
+}
+
+export class SignedCgkaOperation {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    verify(): boolean;
+    readonly delegation: CgkaOperation;
+    readonly signature: Uint8Array;
+    readonly verifyingKey: Uint8Array;
+}
+
+export class SignedDelegation {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    verify(): boolean;
+    readonly delegation: Delegation;
+    readonly signature: Uint8Array;
+    readonly subjectId: Identifier;
+    readonly verifyingKey: Uint8Array;
+}
+
+export class SignedInvocation {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+}
+
+export class SignedRevocation {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    verify(): boolean;
+    readonly delegation: Revocation;
+    readonly signature: Uint8Array;
+    readonly verifyingKey: Uint8Array;
+}
+
+export class Signer {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    clone(): Signer;
+    static generate(): Promise<Signer>;
+    static generateMemory(): Signer;
+    static generateWebCrypto(): Promise<Signer>;
+    static memorySignerFromBytes(bytes: Uint8Array): Signer;
+    trySign(bytes: Uint8Array): Promise<Signed>;
+    static webCryptoSigner(keypair: any): Promise<Signer>;
+    readonly variant: string;
+    readonly verifyingKey: Uint8Array;
+}
+
+export class Stats {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    readonly activePrekeyCount: bigint;
+    readonly cgkaOperations: bigint;
+    readonly delegations: bigint;
+    readonly docs: bigint;
+    readonly groups: bigint;
+    readonly individuals: bigint;
+    readonly pendingCgkaOperation: bigint;
+    readonly pendingCgkaOperationByActive: bigint;
+    readonly pendingDelegated: bigint;
+    readonly pendingDelegatedByActive: bigint;
+    readonly pendingPrekeyRotated: bigint;
+    readonly pendingPrekeyRotatedByActive: bigint;
+    readonly pendingPrekeysExpanded: bigint;
+    readonly pendingPrekeysExpandedByActive: bigint;
+    readonly pendingRevoked: bigint;
+    readonly pendingRevokedByActive: bigint;
+    readonly prekeyRotations: bigint;
+    readonly prekeysExpanded: bigint;
+    readonly revocations: bigint;
+    readonly totalOps: bigint;
+    readonly totalPendingOps: bigint;
+}
+
+export class Summary {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    readonly access: Access;
+    readonly doc: Document;
+}
+
+/**
+ * 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;