@ddd-qc/cell-proxy 0.9.8 → 0.10.0

package/dist/ConductorAppProxy.d.ts

@@ -1,71 +1,74 @@
-import { AppApi, AppInfoRequest, AppInfoResponse, AppSignal, AppSignalCb, AppWebsocket, CallZomeRequest, CellId, InstalledAppId, InstalledCell } from "@holochain/client";
-import { CellProxy } from "./CellProxy";
-import { CellsMap, BaseRoleName, RoleInstanceId, RoleCells } from "./types";
-import { ArchiveCloneCellRequest, CreateCloneCellRequest } from "@holochain/client/lib/api/app/types";
-import { HCL, HCLString } from "./hcl";
-/** */
-export interface SignalUnsubscriber {
-    unsubscribe: () => void;
-}
-/**
- * Creates, connects and holds a appWebsocket.
- * Creates and holds Cell proxies for this appWebsocket.
- * Maintains a mapping between CellIds and HCLs
- * Handles SignalHandlers per HCL
- * Stores appSignal logs
- * TODO Implement Singleton per App port?
- */
-export declare class ConductorAppProxy implements AppApi {
-    defaultTimeout: number;
-    /** -- Fields -- */
-    private _appWs;
-    /** [Timestamp, CellIdStr, Signal] */
-    private _signalLogs;
-    /** InstalledAppId -> (BaseRoleName -> RoleInstalledCells) */
-    private _installedCellsByApp;
-    /** CellIdStr -> HCL[] */
-    private _hclMap;
-    /** HCLString -> AppSignalCb */
-    private _signalHandlers;
-    /** CellIdStr -> CellProxy */
-    private _cellProxies;
-    /** -- Getters -- */
-    /** */
-    getAppCells(appId: InstalledAppId): CellsMap | undefined;
-    /** */
-    getLocations(cellId: CellId): HCL[] | undefined;
-    /** */
-    getCell(hcl: HCL): InstalledCell;
-    /** Get stored CellProxy or attempt to create it */
-    getCellProxy(cellIdOrLoc: HCL | CellId): CellProxy;
-    /** */
-    getAppRoleInstanceIds(installedAppId: InstalledAppId): RoleInstanceId[] | undefined;
-    /** */
-    getClones(appId: InstalledAppId, baseRoleName: BaseRoleName): InstalledCell[];
-    /** -- AppApi (Passthrough to appWebsocket) -- */
-    createCloneCell(request: CreateCloneCellRequest): Promise<InstalledCell>;
-    archiveCloneCell(request: ArchiveCloneCellRequest): Promise<void>;
-    appInfo(args: AppInfoRequest): Promise<AppInfoResponse>;
-    callZome(req: CallZomeRequest, timeout?: number): Promise<any>;
-    /** -- Creation -- */
-    /** async Factory */
-    static new(port_or_socket: number | AppWebsocket, defaultTimeout?: number): Promise<ConductorAppProxy>;
-    /** */
-    private static fromSocket;
-    /** Ctor */
-    private constructor();
-    /** -- Methods -- */
-    fetchCells(appId: InstalledAppId, baseRoleName: BaseRoleName): Promise<RoleCells>;
-    /** */
-    addClone(hcl: HCL, cloneCell: InstalledCell): void;
-    /** */
-    createCellProxy(hcl: HCL): CellProxy;
-    /** */
-    onSignal(signal: AppSignal): void;
-    /** Store signalHandler to internal handler array */
-    addSignalHandler(handler: AppSignalCb, hcl?: HCLString): SignalUnsubscriber;
-    /** Log all signals received */
-    private logSignal;
-    /** */
-    dumpSignals(cellId?: CellId): void;
-}
+import { AppApi, AppInfoRequest, AppInfoResponse, AppSignal, AppSignalCb, AppWebsocket, CallZomeRequest, CellId, InstalledAppId, InstalledCell, CreateCloneCellRequest, DisableCloneCellRequest, EnableCloneCellRequest, Cell } from "@holochain/client";
+import { CellProxy } from "./CellProxy";
+import { RoleCellsMap, BaseRoleName, CellsForRole } from "./types";
+import { HCL, HCLString } from "./hcl";
+/** */
+export interface SignalUnsubscriber {
+    unsubscribe: () => void;
+}
+/**
+ * Creates, connects and holds a appWebsocket.
+ * Creates and holds Cell proxies for this appWebsocket.
+ * Maintains a mapping between CellIds and HCLs
+ * Handles SignalHandlers per HCL
+ * Stores appSignal logs
+ * TODO Implement Singleton per App port?
+ */
+export declare class ConductorAppProxy implements AppApi {
+    defaultTimeout: number;
+    /** -- Fields -- */
+    private _appWs;
+    /** Signal log: [Timestamp, CellIdStr, Signal] */
+    private _signalLogs;
+    /** Map cells per App: InstalledAppId -> (BaseRoleName -> RoleInstalledCells) */
+    private _cellsByApp;
+    /** Map cell locations: CellIdStr -> HCL[] */
+    private _hclMap;
+    /** Store handlers per cell locaiton: HCLString -> AppSignalCb */
+    private _signalHandlers;
+    /** Store cell proxies per cell: CellIdStr -> CellProxy */
+    private _cellProxies;
+    /** -- Getters -- */
+    /** */
+    getAppCells(appId: InstalledAppId): RoleCellsMap | undefined;
+    /** */
+    getLocations(cellId: CellId): HCL[] | undefined;
+    /** */
+    getCell(hcl: HCL): Cell;
+    /** Get stored CellProxy or attempt to create it */
+    getCellProxy(cellIdOrLoc: HCL | CellId): CellProxy;
+    /** */
+    getAppRoles(installedAppId: InstalledAppId): BaseRoleName[] | undefined;
+    /** */
+    getClones(appId: InstalledAppId, baseRoleName: BaseRoleName): Cell[];
+    createCloneCell(request: CreateCloneCellRequest): Promise<InstalledCell>;
+    /** -- AppApi (Passthrough to appWebsocket) -- */
+    enableCloneCell(request: EnableCloneCellRequest): Promise<InstalledCell>;
+    disableCloneCell(request: DisableCloneCellRequest): Promise<void>;
+    appInfo(args: AppInfoRequest): Promise<AppInfoResponse>;
+    callZome(req: CallZomeRequest, timeout?: number): Promise<any>;
+    /** -- Creation -- */
+    /** async Factory */
+    static new(port_or_socket: number | AppWebsocket, defaultTimeout?: number): Promise<ConductorAppProxy>;
+    /** */
+    private static fromSocket;
+    /** Ctor */
+    private constructor();
+    /** -- Methods -- */
+    /** */
+    fetchCell(appId: InstalledAppId, cellId: CellId): Promise<Cell>;
+    /** */
+    fetchCells(appId: InstalledAppId, baseRoleName: BaseRoleName): Promise<CellsForRole>;
+    /** */
+    addClone(hcl: HCL, cloneCell: Cell): void;
+    /** */
+    createCellProxy(hcl: HCL): CellProxy;
+    /** */
+    onSignal(signal: AppSignal): void;
+    /** Store signalHandler to internal handler array */
+    addSignalHandler(handler: AppSignalCb, hcl?: HCLString): SignalUnsubscriber;
+    /** Log all signals received */
+    private logSignal;
+    /** */
+    dumpSignals(cellId?: CellId): void;
+}