@holochain/client 0.17.0-dev.8 → 0.18.0-dev.0

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@holochain/client",
-  "version": "0.17.0-dev.8",
+  "version": "0.18.0-dev.0",
   "description": "A JavaScript client for the Holochain Conductor API",
-  "author": "Holochain Foundation <info@holochain.org> (http://holochain.org)",
+  "author": "Holochain Foundation <info@holochain.org> (https://holochain.org)",
   "license": "CAL-1.0",
   "repository": {
     "type": "git",
@@ -32,9 +32,10 @@
   ],
   "scripts": {
     "lint": "eslint --fix --ext .ts src test .eslintrc.cjs",
-    "test:app-agent": "RUST_LOG=error RUST_BACKTRACE=1 node --loader ts-node/esm test/e2e/app-agent-websocket.ts",
-    "test:utils": "RUST_LOG=error RUST_BACKTRACE=1 node --loader ts-node/esm test/e2e/utils.ts",
-    "test": "RUST_LOG=error RUST_BACKTRACE=1 node --loader ts-node/esm test/index.ts",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "test:app-agent": "RUST_LOG=error RUST_BACKTRACE=1 tsx test/e2e/app-websocket.ts",
+    "test:utils": "RUST_LOG=error RUST_BACKTRACE=1 tsx test/e2e/utils.ts",
+    "test": "RUST_LOG=error RUST_BACKTRACE=1 tsx test/index.ts",
     "build:lib": "rimraf ./lib && tsc -p tsconfig.build.json",
     "build:docs": "api-extractor run --local && api-documenter markdown -i docs/temp -o docs",
     "build": "npm run build:lib && npm run build:docs",
@@ -44,7 +45,6 @@
     "@bitgo/blake2b": "^3.2.4",
     "@holochain/serialization": "^0.1.0-beta-rc.3",
     "@msgpack/msgpack": "^2.8.0",
-    "@tauri-apps/api": "^1.4.0",
     "emittery": "^1.0.1",
     "isomorphic-ws": "^5.0.0",
     "js-base64": "^3.7.5",
@@ -69,7 +69,7 @@
     "prettier": "^2.8.8",
     "rimraf": "^3.0.2",
     "tape": "^5.6.6",
-    "ts-node": "^10.9.1",
+    "tsx": "^4.7.2",
     "typescript": "^4.9.5"
   }
-}
+}

package/lib/api/app-agent/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./types.js";
-export * from "./websocket.js";

package/lib/api/app-agent/index.js

@@ -1,2 +0,0 @@
-export * from "./types.js";
-export * from "./websocket.js";

package/lib/api/app-agent/types.d.ts

@@ -1,59 +0,0 @@
-import { UnsubscribeFunction } from "emittery";
-import { AgentPubKey, RoleName } from "../../index.js";
-import { AppInfoResponse, AppSignal, AppSignalCb, CallZomeRequest, CallZomeRequestSigned, DisableCloneCellRequest, EnableCloneCellRequest, EnableCloneCellResponse, NetworkInfoRequest, NetworkInfoResponse } from "../app/index.js";
-import { CreateCloneCellRequest, CreateCloneCellResponse, DisableCloneCellResponse } from "../index.js";
-/**
- * @public
- */
-export type NonProvenanceCallZomeRequest = Omit<CallZomeRequest, "provenance">;
-/**
- * @public
- */
-export type RoleNameCallZomeRequest = Omit<NonProvenanceCallZomeRequest, "cell_id"> & {
-    role_name: RoleName;
-};
-/**
- * @public
- */
-export type RoleNameCallZomeRequestSigned = Omit<CallZomeRequestSigned, "cell_id"> & {
-    role_name: RoleName;
-};
-/**
- * @public
- */
-export type AppAgentCallZomeRequest = NonProvenanceCallZomeRequest | RoleNameCallZomeRequest | CallZomeRequestSigned | RoleNameCallZomeRequestSigned;
-/**
- * @public
- */
-export type AppCreateCloneCellRequest = Omit<CreateCloneCellRequest, "app_id">;
-/**
- * @public
- */
-export type AppEnableCloneCellRequest = Omit<EnableCloneCellRequest, "app_id">;
-/**
- * @public
- */
-export type AppDisableCloneCellRequest = Omit<DisableCloneCellRequest, "app_id">;
-/**
- * @public
- */
-export type AppAgentNetworkInfoRequest = Omit<NetworkInfoRequest, "agent_pub_key">;
-/**
- * @public
- */
-export interface AppAgentEvents {
-    signal: AppSignal;
-}
-/**
- * @public
- */
-export interface AppAgentClient {
-    callZome(args: AppAgentCallZomeRequest, timeout?: number): Promise<any>;
-    on<Name extends keyof AppAgentEvents>(eventName: Name | readonly Name[], listener: AppSignalCb): UnsubscribeFunction;
-    appInfo(): Promise<AppInfoResponse>;
-    myPubKey: AgentPubKey;
-    createCloneCell(args: AppCreateCloneCellRequest): Promise<CreateCloneCellResponse>;
-    enableCloneCell(args: AppEnableCloneCellRequest): Promise<EnableCloneCellResponse>;
-    disableCloneCell(args: AppDisableCloneCellRequest): Promise<DisableCloneCellResponse>;
-    networkInfo(args: AppAgentNetworkInfoRequest): Promise<NetworkInfoResponse>;
-}

package/lib/api/app-agent/types.js

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

package/lib/api/app-agent/websocket.d.ts

@@ -1,86 +0,0 @@
-import Emittery, { UnsubscribeFunction } from "emittery";
-import { AgentPubKey, CellId, InstalledAppId, RoleName } from "../../types.js";
-import { AppInfo } from "../admin/types.js";
-import { AppSignalCb, CallZomeResponse, CreateCloneCellResponse, DisableCloneCellResponse, EnableCloneCellResponse, NetworkInfoResponse } from "../app/types.js";
-import { AppWebsocket } from "../app/websocket.js";
-import { WebsocketConnectionOptions } from "../common.js";
-import { AppAgentCallZomeRequest, AppAgentClient, AppAgentEvents, AppAgentNetworkInfoRequest, AppCreateCloneCellRequest, AppDisableCloneCellRequest, AppEnableCloneCellRequest } from "./types.js";
-/**
- * A class to establish a websocket connection to an App interface, for a
- * specific agent and app.
- *
- * @public
- */
-export declare class AppAgentWebsocket implements AppAgentClient {
-    readonly appWebsocket: AppWebsocket;
-    installedAppId: InstalledAppId;
-    cachedAppInfo?: AppInfo | null;
-    myPubKey: AgentPubKey;
-    readonly emitter: Emittery<AppAgentEvents>;
-    private constructor();
-    /**
-     * Request the app's info, including all cell infos.
-     *
-     * @returns The app's {@link AppInfo}.
-     */
-    appInfo(): Promise<AppInfo>;
-    /**
-     * Instance factory for creating AppAgentWebsockets.
-     *
-     * @param installed_app_id - ID of the App to link to.
-     * @param options - {@link (WebsocketConnectionOptions:interface)}
-     * @returns A new instance of an AppAgentWebsocket.
-     */
-    static connect(installed_app_id: InstalledAppId, options?: WebsocketConnectionOptions): Promise<AppAgentWebsocket>;
-    /**
-     * Get a cell id by its role name or clone id.
-     *
-     * @param roleName - The role name or clone id of the cell.
-     * @param appInfo - The app info containing all cell infos.
-     * @returns The cell id or throws an error if not found.
-     */
-    getCellIdFromRoleName(roleName: RoleName, appInfo: AppInfo): CellId;
-    /**
-     * Call a zome.
-     *
-     * @param request - The zome call arguments.
-     * @param timeout - A timeout to override the default.
-     * @returns The zome call's response.
-     */
-    callZome(request: AppAgentCallZomeRequest, timeout?: number): Promise<CallZomeResponse>;
-    /**
-     * Clone an existing provisioned cell.
-     *
-     * @param args - Specify the cell to clone.
-     * @returns The created clone cell.
-     */
-    createCloneCell(args: AppCreateCloneCellRequest): Promise<CreateCloneCellResponse>;
-    /**
-     * Enable a disabled clone cell.
-     *
-     * @param args - Specify the clone cell to enable.
-     * @returns The enabled clone cell.
-     */
-    enableCloneCell(args: AppEnableCloneCellRequest): Promise<EnableCloneCellResponse>;
-    /**
-     * Disable an enabled clone cell.
-     *
-     * @param args - Specify the clone cell to disable.
-     */
-    disableCloneCell(args: AppDisableCloneCellRequest): Promise<DisableCloneCellResponse>;
-    /**
-     * Request network info about gossip status.
-     *  @param args - Specify the DNAs for which you want network info
-     *  @returns Network info for the specified DNAs
-     */
-    networkInfo(args: AppAgentNetworkInfoRequest): Promise<NetworkInfoResponse>;
-    /**
-     * Register an event listener for signals.
-     *
-     * @param eventName - Event name to listen to (currently only "signal").
-     * @param listener - The function to call when event is triggered.
-     * @returns A function to unsubscribe the event listener.
-     */
-    on<Name extends keyof AppAgentEvents>(eventName: Name | readonly Name[], listener: AppSignalCb): UnsubscribeFunction;
-    private containsCell;
-}

package/lib/api/app-agent/websocket.js

@@ -1,209 +0,0 @@
-import Emittery from "emittery";
-import { omit } from "lodash-es";
-import { getLauncherEnvironment } from "../../environments/launcher.js";
-import { CellType } from "../admin/types.js";
-import { AppWebsocket } from "../app/websocket.js";
-import { HolochainError, getBaseRoleNameFromCloneId, isCloneId, } from "../common.js";
-/**
- * A class to establish a websocket connection to an App interface, for a
- * specific agent and app.
- *
- * @public
- */
-export class AppAgentWebsocket {
-    appWebsocket;
-    installedAppId;
-    cachedAppInfo;
-    myPubKey;
-    emitter;
-    constructor(appWebsocket, installedAppId, myPubKey) {
-        this.appWebsocket = appWebsocket;
-        this.cachedAppInfo = null;
-        this.emitter = new Emittery();
-        // Ensure all super methods are bound to this instance because Emittery relies on `this` being the instance.
-        // Please retain until the upstream is fixed https://github.com/sindresorhus/emittery/issues/86.
-        Object.getOwnPropertyNames(Emittery.prototype).forEach((name) => {
-            const to_bind = this.emitter[name];
-            if (typeof to_bind === "function") {
-                this.emitter[name] =
-                    to_bind.bind(this.emitter);
-            }
-        });
-        const env = getLauncherEnvironment();
-        this.installedAppId = env?.INSTALLED_APP_ID || installedAppId;
-        this.myPubKey = myPubKey;
-        this.appWebsocket.on("signal", (signal) => {
-            if (this.containsCell(signal.cell_id)) {
-                this.emitter.emit("signal", signal);
-            }
-        });
-    }
-    /**
-     * Request the app's info, including all cell infos.
-     *
-     * @returns The app's {@link AppInfo}.
-     */
-    async appInfo() {
-        const appInfo = await this.appWebsocket.appInfo({
-            installed_app_id: this.installedAppId,
-        });
-        if (!appInfo) {
-            throw new HolochainError("AppNotFound", `App info not found for the provided id "${this.installedAppId}". App needs to be installed and enabled.`);
-        }
-        this.cachedAppInfo = appInfo;
-        return appInfo;
-    }
-    /**
-     * Instance factory for creating AppAgentWebsockets.
-     *
-     * @param installed_app_id - ID of the App to link to.
-     * @param options - {@link (WebsocketConnectionOptions:interface)}
-     * @returns A new instance of an AppAgentWebsocket.
-     */
-    static async connect(installed_app_id, options = {}) {
-        const appWebsocket = await AppWebsocket.connect(options);
-        const appInfo = await appWebsocket.appInfo({ installed_app_id });
-        if (!appInfo) {
-            throw new HolochainError("AppNotFound", `App info not found for the provided id "${installed_app_id}". App needs to be installed and enabled.`);
-        }
-        const appAgentWs = new AppAgentWebsocket(appWebsocket, installed_app_id, appInfo.agent_pub_key);
-        appAgentWs.cachedAppInfo = appInfo;
-        return appAgentWs;
-    }
-    /**
-     * Get a cell id by its role name or clone id.
-     *
-     * @param roleName - The role name or clone id of the cell.
-     * @param appInfo - The app info containing all cell infos.
-     * @returns The cell id or throws an error if not found.
-     */
-    getCellIdFromRoleName(roleName, appInfo) {
-        if (isCloneId(roleName)) {
-            const baseRoleName = getBaseRoleNameFromCloneId(roleName);
-            if (!(baseRoleName in appInfo.cell_info)) {
-                throw new HolochainError("NoCellForRoleName", `no cell found with role_name ${roleName}`);
-            }
-            const cloneCell = appInfo.cell_info[baseRoleName].find((c) => CellType.Cloned in c && c[CellType.Cloned].clone_id === roleName);
-            if (!cloneCell || !(CellType.Cloned in cloneCell)) {
-                throw new HolochainError("NoCellForCloneId", `no clone cell found with clone id ${roleName}`);
-            }
-            return cloneCell[CellType.Cloned].cell_id;
-        }
-        if (!(roleName in appInfo.cell_info)) {
-            throw new HolochainError("NoCellForRoleName", `no cell found with role_name ${roleName}`);
-        }
-        const cell = appInfo.cell_info[roleName].find((c) => CellType.Provisioned in c);
-        if (!cell || !(CellType.Provisioned in cell)) {
-            throw new HolochainError("NoProvisionedCellForRoleName", `no provisioned cell found with role_name ${roleName}`);
-        }
-        return cell[CellType.Provisioned].cell_id;
-    }
-    /**
-     * Call a zome.
-     *
-     * @param request - The zome call arguments.
-     * @param timeout - A timeout to override the default.
-     * @returns The zome call's response.
-     */
-    async callZome(request, timeout) {
-        if (!("provenance" in request)) {
-            request = {
-                ...request,
-                provenance: this.myPubKey,
-            };
-        }
-        if ("role_name" in request && request.role_name) {
-            const appInfo = this.cachedAppInfo || (await this.appInfo());
-            const cell_id = this.getCellIdFromRoleName(request.role_name, appInfo);
-            const zomeCallPayload = {
-                ...omit(request, "role_name"),
-                provenance: this.myPubKey,
-                cell_id: [cell_id[0], cell_id[1]],
-            };
-            return this.appWebsocket.callZome(zomeCallPayload, timeout);
-        }
-        else if ("cell_id" in request && request.cell_id) {
-            return this.appWebsocket.callZome(request, timeout);
-        }
-        throw new HolochainError("MissingRoleNameOrCellId", "callZome requires a role_name or cell_id argument");
-    }
-    /**
-     * Clone an existing provisioned cell.
-     *
-     * @param args - Specify the cell to clone.
-     * @returns The created clone cell.
-     */
-    async createCloneCell(args) {
-        const clonedCell = this.appWebsocket.createCloneCell({
-            app_id: this.installedAppId,
-            ...args,
-        });
-        this.cachedAppInfo = undefined;
-        return clonedCell;
-    }
-    /**
-     * Enable a disabled clone cell.
-     *
-     * @param args - Specify the clone cell to enable.
-     * @returns The enabled clone cell.
-     */
-    async enableCloneCell(args) {
-        return this.appWebsocket.enableCloneCell({
-            app_id: this.installedAppId,
-            ...args,
-        });
-    }
-    /**
-     * Disable an enabled clone cell.
-     *
-     * @param args - Specify the clone cell to disable.
-     */
-    async disableCloneCell(args) {
-        return this.appWebsocket.disableCloneCell({
-            app_id: this.installedAppId,
-            ...args,
-        });
-    }
-    /**
-     * Request network info about gossip status.
-     *  @param args - Specify the DNAs for which you want network info
-     *  @returns Network info for the specified DNAs
-     */
-    async networkInfo(args) {
-        return this.appWebsocket.networkInfo({
-            ...args,
-            agent_pub_key: this.myPubKey,
-        });
-    }
-    /**
-     * Register an event listener for signals.
-     *
-     * @param eventName - Event name to listen to (currently only "signal").
-     * @param listener - The function to call when event is triggered.
-     * @returns A function to unsubscribe the event listener.
-     */
-    on(eventName, listener) {
-        return this.emitter.on(eventName, listener);
-    }
-    containsCell(cellId) {
-        const appInfo = this.cachedAppInfo;
-        if (!appInfo) {
-            return false;
-        }
-        for (const roleName of Object.keys(appInfo.cell_info)) {
-            for (const cellInfo of appInfo.cell_info[roleName]) {
-                const currentCellId = CellType.Provisioned in cellInfo
-                    ? cellInfo[CellType.Provisioned].cell_id
-                    : CellType.Cloned in cellInfo
-                        ? cellInfo[CellType.Cloned].cell_id
-                        : undefined;
-                if (currentCellId && isSameCell(currentCellId, cellId)) {
-                    return true;
-                }
-            }
-        }
-        return false;
-    }
-}
-const isSameCell = (cellId1, cellId2) => cellId1[0].every((byte, index) => byte === cellId2[0][index]) &&
-    cellId1[1].every((byte, index) => byte === cellId2[1][index]);