@holochain/client 0.12.5 → 0.12.7

package/lib/api/common.js

@@ -1,5 +1,5 @@
 const ERROR_TYPE = "error";
-export const DEFAULT_TIMEOUT = 15000;
+export const DEFAULT_TIMEOUT = 60000;
 /**
  * Take a Requester function which deals with tagged requests and responses,
  * and return a Requester which deals only with the inner data types, also
@@ -19,16 +19,32 @@ const identityTransformer = {
     input: identity,
     output: identity,
 };
+/**
+ * Error thrown when response from Holochain is an error.
+ *
+ * @public
+ */
+export class HolochainError extends Error {
+    constructor(name, message) {
+        super();
+        this.name = name;
+        this.message = message;
+    }
+}
+// this determines the error format of all error responses
 export const catchError = (res) => {
-    return res.type === ERROR_TYPE ? Promise.reject(res) : Promise.resolve(res);
+    if (res.type === ERROR_TYPE) {
+        const error = new HolochainError(res.data.type, res.data.data);
+        return Promise.reject(error);
+    }
+    else {
+        return Promise.resolve(res);
+    }
 };
 export const promiseTimeout = (promise, tag, ms) => {
     let id;
     const timeout = new Promise((_, reject) => {
-        id = setTimeout(() => {
-            clearTimeout(id);
-            reject(new Error(`Timed out in ${ms}ms: ${tag}`));
-        }, ms);
+        id = setTimeout(() => reject(new Error(`Timed out in ${ms}ms: ${tag}`)), ms);
     });
     return new Promise((res, rej) => {
         Promise.race([promise, timeout])

package/lib/api/index.d.ts

@@ -2,6 +2,6 @@ export { hashZomeCall } from "@holochain/serialization";
 export * from "./admin/index.js";
 export * from "./app-agent/index.js";
 export * from "./app/index.js";
-export { CloneId, Requester, Transformer } from "./common.js";
-export { WsClient } from "./client.js";
+export { IsoWebSocket, WsClient } from "./client.js";
+export { CloneId, HolochainError, Requester, Transformer, getBaseRoleNameFromCloneId, isCloneId, } from "./common.js";
 export * from "./zome-call-signing.js";

package/lib/api/index.js

@@ -2,6 +2,6 @@ export { hashZomeCall } from "@holochain/serialization";
 export * from "./admin/index.js";
 export * from "./app-agent/index.js";
 export * from "./app/index.js";
-export { CloneId } from "./common.js";
-export { WsClient } from "./client.js";
+export { IsoWebSocket, WsClient } from "./client.js";
+export { CloneId, HolochainError, getBaseRoleNameFromCloneId, isCloneId, } from "./common.js";
 export * from "./zome-call-signing.js";

package/lib/api/zome-call-signing.d.ts

@@ -1,16 +1,16 @@
-import nacl from "tweetnacl";
-import { CapSecret } from "../hdk/capabilities.js";
-import { AgentPubKey, CellId } from "../types.js";
+import { type KeyPair } from "libsodium-wrappers";
+import type { CapSecret } from "../hdk/capabilities.js";
+import type { AgentPubKey, CellId } from "../types.js";
 /**
  * @public
  */
-export declare type Nonce256Bit = Uint8Array;
+export type Nonce256Bit = Uint8Array;
 /**
  * @public
  */
 export interface SigningCredentials {
     capSecret: CapSecret;
-    keyPair: nacl.SignKeyPair;
+    keyPair: KeyPair;
     signingKey: AgentPubKey;
 }
 /**
@@ -33,14 +33,13 @@ export declare const setSigningCredentials: (cellId: CellId, credentials: Signin
 /**
  * Generates a key pair for signing zome calls.
  *
+ * @param agentPubKey - The agent pub key to take 4 last bytes (= DHT location)
+ * from (optional).
  * @returns The signing key pair and an agent pub key based on the public key.
  *
  * @public
  */
-export declare const generateSigningKeyPair: () => [
-    nacl.SignKeyPair,
-    AgentPubKey
-];
+export declare const generateSigningKeyPair: (agentPubKey?: AgentPubKey) => Promise<[KeyPair, AgentPubKey]>;
 /**
  * @public
  */

package/lib/api/zome-call-signing.js

@@ -1,4 +1,4 @@
-import nacl from "tweetnacl";
+import _sodium from "libsodium-wrappers";
 import { encodeHashToBase64 } from "../utils/base64.js";
 const signingCredentials = new Map();
 /**
@@ -27,19 +27,24 @@ export const setSigningCredentials = (cellId, credentials) => {
 /**
  * Generates a key pair for signing zome calls.
  *
+ * @param agentPubKey - The agent pub key to take 4 last bytes (= DHT location)
+ * from (optional).
  * @returns The signing key pair and an agent pub key based on the public key.
  *
  * @public
  */
-export const generateSigningKeyPair = () => {
-    const keyPair = nacl.sign.keyPair();
-    const signingKey = new Uint8Array([132, 32, 36].concat(...keyPair.publicKey).concat(...[0, 0, 0, 0]));
+export const generateSigningKeyPair = async (agentPubKey) => {
+    await _sodium.ready;
+    const sodium = _sodium;
+    const keyPair = sodium.crypto_sign_keypair();
+    const locationBytes = agentPubKey ? agentPubKey.subarray(35) : [0, 0, 0, 0];
+    const signingKey = new Uint8Array([132, 32, 36].concat(...keyPair.publicKey).concat(...locationBytes));
     return [keyPair, signingKey];
 };
 /**
  * @public
  */
-export const randomCapSecret = () => randomByteArray(64);
+export const randomCapSecret = async () => randomByteArray(64);
 /**
  * @public
  */
@@ -48,15 +53,12 @@ export const randomNonce = async () => randomByteArray(32);
  * @public
  */
 export const randomByteArray = async (length) => {
-    if (typeof window !== "undefined" &&
-        "crypto" in window &&
-        "getRandomValues" in window.crypto) {
-        return window.crypto.getRandomValues(new Uint8Array(length));
-    }
-    else {
-        const crypto = await import("crypto");
-        return new Uint8Array(crypto.randomBytes(length));
+    if (globalThis.crypto && "getRandomValues" in globalThis.crypto) {
+        return globalThis.crypto.getRandomValues(new Uint8Array(length));
     }
+    await _sodium.ready;
+    const sodium = _sodium;
+    return sodium.randombytes_buf(length);
 };
 /**
  * @public

package/lib/environments/launcher.d.ts

@@ -1,17 +1,45 @@
+import { CallZomeRequest } from "../api/app/types.js";
+import { CallZomeRequestSigned, CallZomeRequestUnsigned } from "../api/app/websocket.js";
 import { InstalledAppId } from "../types.js";
-import { CallZomeRequest, CallZomeRequestSigned } from "../api/index.js";
 export interface LauncherEnvironment {
     APP_INTERFACE_PORT?: number;
     ADMIN_INTERFACE_PORT?: number;
     INSTALLED_APP_ID?: InstalledAppId;
+    FRAMEWORK?: "tauri" | "electron";
+}
+export interface HostZomeCallSigner {
+    signZomeCall: (request: CallZomeRequest) => Promise<CallZomeRequestSigned>;
 }
 declare const __HC_LAUNCHER_ENV__ = "__HC_LAUNCHER_ENV__";
-export declare const isLauncher: boolean;
+declare const __HC_ZOME_CALL_SIGNER__ = "__HC_ZOME_CALL_SIGNER__";
+export declare const isLauncher: () => boolean;
 export declare const getLauncherEnvironment: () => LauncherEnvironment | undefined;
+export declare const getHostZomeCallSigner: () => HostZomeCallSigner | undefined;
 declare global {
     interface Window {
-        [__HC_LAUNCHER_ENV__]: LauncherEnvironment | undefined;
+        [__HC_LAUNCHER_ENV__]?: LauncherEnvironment;
+        [__HC_ZOME_CALL_SIGNER__]?: HostZomeCallSigner;
+        electronAPI?: {
+            signZomeCall: (data: CallZomeRequestUnsignedElectron) => CallZomeRequestSignedElectron;
+        };
     }
 }
+interface CallZomeRequestSignedElectron extends Omit<CallZomeRequestSigned, "cap_secret" | "cell_id" | "provenance" | "nonce" | "zome_name" | "fn_name" | "expires_at"> {
+    cellId: [Array<number>, Array<number>];
+    provenance: Array<number>;
+    zomeName: string;
+    fnName: string;
+    nonce: Array<number>;
+    expiresAt: number;
+}
+interface CallZomeRequestUnsignedElectron extends Omit<CallZomeRequestUnsigned, "cap_secret" | "cell_id" | "provenance" | "nonce" | "zome_name" | "fn_name" | "expires_at"> {
+    cellId: [Array<number>, Array<number>];
+    provenance: Array<number>;
+    zomeName: string;
+    fnName: string;
+    nonce: Array<number>;
+    expiresAt: number;
+}
 export declare const signZomeCallTauri: (request: CallZomeRequest) => Promise<CallZomeRequestSigned>;
+export declare const signZomeCallElectron: (request: CallZomeRequest) => Promise<CallZomeRequestSigned>;
 export {};

package/lib/environments/launcher.js

@@ -1,9 +1,11 @@
-import { invoke } from "@tauri-apps/api/tauri";
-import { getNonceExpiration, randomNonce, } from "../api/index.js";
 import { encode } from "@msgpack/msgpack";
+import { invoke } from "@tauri-apps/api/tauri";
+import { getNonceExpiration, randomNonce } from "../api/zome-call-signing.js";
 const __HC_LAUNCHER_ENV__ = "__HC_LAUNCHER_ENV__";
-export const isLauncher = typeof window === "object" && __HC_LAUNCHER_ENV__ in window;
-export const getLauncherEnvironment = () => isLauncher ? window[__HC_LAUNCHER_ENV__] : undefined;
+const __HC_ZOME_CALL_SIGNER__ = "__HC_ZOME_CALL_SIGNER__";
+export const isLauncher = () => globalThis.window && __HC_LAUNCHER_ENV__ in globalThis.window;
+export const getLauncherEnvironment = () => isLauncher() ? globalThis.window[__HC_LAUNCHER_ENV__] : undefined;
+export const getHostZomeCallSigner = () => globalThis.window && globalThis.window[__HC_ZOME_CALL_SIGNER__];
 export const signZomeCallTauri = async (request) => {
     const zomeCallUnsigned = {
         provenance: Array.from(request.provenance),
@@ -31,3 +33,33 @@ export const signZomeCallTauri = async (request) => {
     };
     return signedZomeCall;
 };
+export const signZomeCallElectron = async (request) => {
+    if (!window.electronAPI) {
+        throw Error("Unable to signZomeCallElectron. window.electronAPI not defined");
+    }
+    const zomeCallUnsignedElectron = {
+        provenance: Array.from(request.provenance),
+        cellId: [Array.from(request.cell_id[0]), Array.from(request.cell_id[1])],
+        zomeName: request.zome_name,
+        fnName: request.fn_name,
+        payload: Array.from(encode(request.payload)),
+        nonce: Array.from(await randomNonce()),
+        expiresAt: getNonceExpiration(),
+    };
+    const zomeCallSignedElectron = await window.electronAPI.signZomeCall(zomeCallUnsignedElectron);
+    const zomeCallSigned = {
+        provenance: Uint8Array.from(zomeCallSignedElectron.provenance),
+        cap_secret: null,
+        cell_id: [
+            Uint8Array.from(zomeCallSignedElectron.cellId[0]),
+            Uint8Array.from(zomeCallSignedElectron.cellId[1]),
+        ],
+        zome_name: zomeCallSignedElectron.zomeName,
+        fn_name: zomeCallSignedElectron.fnName,
+        payload: Uint8Array.from(zomeCallSignedElectron.payload),
+        signature: Uint8Array.from(zomeCallSignedElectron.signature),
+        expires_at: zomeCallSignedElectron.expiresAt,
+        nonce: Uint8Array.from(zomeCallSignedElectron.nonce),
+    };
+    return zomeCallSigned;
+};

package/lib/hdk/action.d.ts

@@ -1,5 +1,6 @@
 import { AgentPubKey, DnaHash, EntryHash, ActionHash, HoloHashed, Signature, Timestamp } from "../types.js";
-import { EntryType } from "./entry.js";
+import { Entry, EntryType } from "./entry.js";
+import { LinkTag, LinkType, RateWeight } from "./link.js";
 /**
  * @public
  */
@@ -10,7 +11,14 @@ export interface SignedActionHashed<H extends Action = Action> {
 /**
  * @public
  */
-export declare type ActionHashed = HoloHashed<Action>;
+export interface RegisterAgentActivity {
+    action: SignedActionHashed;
+    cached_entry?: Entry;
+}
+/**
+ * @public
+ */
+export type ActionHashed = HoloHashed<Action>;
 /**
  * @public
  */
@@ -29,11 +37,11 @@ export declare enum ActionType {
 /**
  * @public
  */
-export declare type Action = Dna | AgentValidationPkg | InitZomesComplete | CreateLink | DeleteLink | OpenChain | CloseChain | Delete | NewEntryAction;
+export type Action = Dna | AgentValidationPkg | InitZomesComplete | CreateLink | DeleteLink | OpenChain | CloseChain | Delete | NewEntryAction;
 /**
  * @public
  */
-export declare type NewEntryAction = Create | Update;
+export type NewEntryAction = Create | Update;
 /**
  * @public
  */
@@ -75,8 +83,10 @@ export interface CreateLink {
     prev_action: ActionHash;
     base_address: EntryHash;
     target_address: EntryHash;
-    zome_id: number;
-    tag: any;
+    zome_index: number;
+    link_type: LinkType;
+    tag: LinkTag;
+    weight: RateWeight;
 }
 /**
  * @public

package/lib/hdk/capabilities.d.ts

@@ -1,9 +1,9 @@
-import { FunctionName, ZomeName } from "../api/index.js";
+import { FunctionName, ZomeName } from "../api/admin/types.js";
 import { AgentPubKey } from "../types.js";
 /**
  * @public
  */
-export declare type CapSecret = Uint8Array;
+export type CapSecret = Uint8Array;
 /**
  * @public
  */
@@ -22,7 +22,7 @@ export declare enum GrantedFunctionsType {
 /**
  * @public
  */
-export declare type GrantedFunctions = {
+export type GrantedFunctions = {
     [GrantedFunctionsType.All]: null;
 } | {
     [GrantedFunctionsType.Listed]: [ZomeName, FunctionName][];
@@ -38,12 +38,22 @@ export interface ZomeCallCapGrant {
 /**
  * @public
  */
-export declare type CapAccess = "Unrestricted" | {
-    Transferable: {
+export declare enum CapAccessType {
+    Unrestricted = "Unrestricted",
+    Transferable = "Transferable",
+    Assigned = "Assigned"
+}
+/**
+ * @public
+ */
+export type CapAccess = {
+    [CapAccessType.Unrestricted]: null;
+} | {
+    [CapAccessType.Transferable]: {
         secret: CapSecret;
     };
 } | {
-    Assigned: {
+    [CapAccessType.Assigned]: {
         secret: CapSecret;
         assignees: AgentPubKey[];
     };
@@ -51,7 +61,7 @@ export declare type CapAccess = "Unrestricted" | {
 /**
  * @public
  */
-export declare type CapGrant = {
+export type CapGrant = {
     ChainAuthor: AgentPubKey;
 } | {
     RemoteAgent: ZomeCallCapGrant;

package/lib/hdk/capabilities.js

@@ -6,3 +6,12 @@ export var GrantedFunctionsType;
     GrantedFunctionsType["All"] = "All";
     GrantedFunctionsType["Listed"] = "Listed";
 })(GrantedFunctionsType || (GrantedFunctionsType = {}));
+/**
+ * @public
+ */
+export var CapAccessType;
+(function (CapAccessType) {
+    CapAccessType["Unrestricted"] = "Unrestricted";
+    CapAccessType["Transferable"] = "Transferable";
+    CapAccessType["Assigned"] = "Assigned";
+})(CapAccessType || (CapAccessType = {}));

package/lib/hdk/countersigning.d.ts

@@ -28,7 +28,7 @@ export interface CounterSigningSessionTimes {
 /**
  * @public
  */
-export declare type ActionBase = {
+export type ActionBase = {
     Create: CreateBase;
 } | {
     Update: UpdateBase;
@@ -50,15 +50,15 @@ export interface UpdateBase {
 /**
  * @public
  */
-export declare type CounterSigningAgents = Array<[AgentPubKey, Array<Role>]>;
+export type CounterSigningAgents = Array<[AgentPubKey, Array<Role>]>;
 /**
  * @public
  */
-export declare type PreflightBytes = Uint8Array;
+export type PreflightBytes = Uint8Array;
 /**
  * @public
  */
-export declare type Role = number;
+export type Role = number;
 /**
  * @public
  */

package/lib/hdk/dht-ops.d.ts

@@ -18,7 +18,7 @@ export declare enum DhtOpType {
 /**
  * @public
  */
-export declare type DhtOp = {
+export type DhtOp = {
     [DhtOpType.StoreRecord]: [Signature, Action, Entry | undefined];
 } | {
     [DhtOpType.StoreEntry]: [Signature, NewEntryAction, Entry];

package/lib/hdk/entry.d.ts

@@ -4,7 +4,7 @@ import { CounterSigningSessionData } from "./countersigning.js";
 /**
  * @public
  */
-export declare type EntryVisibility = {
+export type EntryVisibility = {
     Public: null;
 } | {
     Private: null;
@@ -12,7 +12,7 @@ export declare type EntryVisibility = {
 /**
  * @public
  */
-export declare type AppEntryDef = {
+export type AppEntryDef = {
     entry_index: number;
     zome_index: number;
     visibility: EntryVisibility;
@@ -20,7 +20,7 @@ export declare type AppEntryDef = {
 /**
  * @public
  */
-export declare type EntryType = "Agent" | {
+export type EntryType = "Agent" | {
     App: AppEntryDef;
 } | "CapClaim" | "CapGrant";
 /**
@@ -33,4 +33,4 @@ export interface EntryContent<E extends string, C> {
 /**
  * @public
  */
-export declare type Entry = EntryContent<"Agent", AgentPubKey> | EntryContent<"App", Uint8Array> | EntryContent<"CounterSign", [CounterSigningSessionData, Uint8Array]> | EntryContent<"CapGrant", ZomeCallCapGrant> | EntryContent<"CapClaim", CapClaim>;
+export type Entry = EntryContent<"Agent", AgentPubKey> | EntryContent<"App", Uint8Array> | EntryContent<"CounterSign", [CounterSigningSessionData, Uint8Array]> | EntryContent<"CapGrant", ZomeCallCapGrant> | EntryContent<"CapClaim", CapClaim>;

package/lib/hdk/index.d.ts

@@ -3,4 +3,5 @@ export * from "./capabilities.js";
 export * from "./countersigning.js";
 export * from "./dht-ops.js";
 export * from "./entry.js";
+export * from "./link.js";
 export * from "./record.js";

package/lib/hdk/index.js

@@ -3,4 +3,5 @@ export * from "./capabilities.js";
 export * from "./countersigning.js";
 export * from "./dht-ops.js";
 export * from "./entry.js";
+export * from "./link.js";
 export * from "./record.js";

package/lib/hdk/link.d.ts

@@ -0,0 +1,48 @@
+import { ActionHash, AgentPubKey, EntryHash, ExternalHash, Timestamp } from "../types.js";
+/**
+ * @public
+ */
+export type AnyLinkableHash = EntryHash | ActionHash | ExternalHash;
+/**
+ * An internal zome index within the DNA, from 0 to 255.
+ *
+ * @public
+ */
+export type ZomeIndex = number;
+/**
+ * An internal link type index within the DNA, from 0 to 255.
+ *
+ * @public
+ */
+export type LinkType = number;
+/**
+ * @public
+ */
+export type LinkTag = Uint8Array;
+/**
+ * @public
+ */
+export interface RateWeight {
+    bucket_id: RateBucketId;
+    units: RateUnits;
+}
+/**
+ * @public
+ */
+export type RateBucketId = number;
+/**
+ * @public
+ */
+export type RateUnits = number;
+/**
+ * @public
+ */
+export interface Link {
+    author: AgentPubKey;
+    target: AnyLinkableHash;
+    timestamp: Timestamp;
+    zome_index: ZomeIndex;
+    link_type: LinkType;
+    tag: Uint8Array;
+    create_link_hash: ActionHash;
+}

package/lib/hdk/link.js

@@ -0,0 +1 @@
+export {};

package/lib/hdk/record.d.ts

@@ -3,14 +3,14 @@ import { Entry } from "./entry.js";
 /**
  * @public
  */
-export declare type Record = {
+export type Record = {
     signed_action: SignedActionHashed;
     entry: RecordEntry;
 };
 /**
  * @public
  */
-export declare type RecordEntry = {
+export type RecordEntry = {
     Present: Entry;
 } | {
     Hidden: void;

package/lib/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.33.7"
+      "packageVersion": "7.34.4"
     }
   ]
 }