@holochain/client 0.20.0 → 0.20.2

package/lib/api/admin/types.d.ts

@@ -266,13 +266,19 @@ export type CoordinatorZome = ZomeDefinition;
 /**
  * @public
  */
-export type DnaDefinition = {
+export type DnaDef = {
     name: string;
     modifiers: DnaModifiers;
     lineage: DnaHashB64[];
     integrity_zomes: IntegrityZome[];
     coordinator_zomes: CoordinatorZome[];
 };
+/**
+ * @public
+ *
+ * @deprecated Renamed to DnaDef. This alias will be removed in 0.22.0
+ */
+export type DnaDefinition = DnaDef;
 /**
  * @public
  */
@@ -280,7 +286,7 @@ export type GetDnaDefinitionRequest = CellId;
 /**
  * @public
  */
-export type GetDnaDefinitionResponse = DnaDefinition;
+export type GetDnaDefinitionResponse = DnaDef;
 /**
  * @public
  */
@@ -878,6 +884,9 @@ export interface IssueAppAuthenticationTokenResponse {
  * @public
  */
 export type DumpNetworkStatsRequest = void;
+/**
+ * @public
+ */
 export interface ApiTransportStats {
     /**
      * Stats from the configured transport implementation.
@@ -886,16 +895,23 @@ export interface ApiTransportStats {
     /**
      * Blocked message counts.
      */
-    blocked_message_counts: Record<Url, Record<SpaceId, MessageBlockCount>>;
+    blocked_message_counts: Record<PeerUrl, Record<SpaceId, MessageBlockCount>>;
 }
 /**
  * Peer Url
+ *
+ * @public
  */
-type Url = string;
+export type PeerUrl = string;
 /**
  * kitsune2 space id
+ *
+ * @public
+ */
+export type SpaceId = string;
+/**
+ * @public
  */
-type SpaceId = string;
 export interface MessageBlockCount {
     /**
      * Count of incoming messages that have been blocked and dropped.
@@ -1199,4 +1215,3 @@ export interface AdminApi {
     issueAppAuthenticationToken: Requester<IssueAppAuthenticationTokenRequest, IssueAppAuthenticationTokenResponse>;
     dumpNetworkStats: Requester<DumpNetworkStatsRequest, DumpNetworkStatsResponse>;
 }
-export {};

package/lib/api/admin/websocket.d.ts

@@ -25,7 +25,7 @@ export declare class AdminWebsocket implements AdminApi {
      * @returns A promise for a new connected instance.
      */
     static connect(options?: WebsocketConnectionOptions): Promise<AdminWebsocket>;
-    _requester<ReqI, ReqO, ResI, ResO>(tag: string, transformer?: Transformer<ReqI, ReqO, ResI, ResO>): (req: ReqI, timeout?: number | undefined) => Promise<ResO>;
+    _requester<ReqI, ReqO, ResI, ResO>(tag: string, transformer?: Transformer<ReqI, ReqO, ResI, ResO>): (req: ReqI, timeout?: number) => Promise<ResO>;
     /**
      * Send a request to open the given port for {@link AppWebsocket} connections.
      */

package/lib/api/client.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="ws" />
 import Emittery from "emittery";
 import IsoWebSocket from "isomorphic-ws";
 import { WsClientOptions } from "./common.js";

package/lib/api/common.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="ws" />
 import { RoleName } from "../types.js";
 import { IsoWebSocket } from "./client.js";
 export declare const DEFAULT_TIMEOUT = 60000;

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

@@ -51,7 +51,7 @@ export declare const randomNonce: () => Promise<Nonce256Bit>;
 /**
  * @public
  */
-export declare const randomByteArray: (length: number) => Promise<Uint8Array>;
+export declare const randomByteArray: (length: number) => Promise<Uint8Array<ArrayBufferLike>>;
 /**
  * @public
  */

package/lib/hdk/details.d.ts

@@ -0,0 +1,19 @@
+import { EntryDetails } from "./entry.js";
+import { RecordDetails } from "./record.js";
+/**
+ * @public
+ */
+export declare enum DetailsType {
+    Entry = "entry",
+    Record = "record"
+}
+/**
+ * @public
+ */
+export type Details = {
+    type: DetailsType.Record;
+    content: RecordDetails;
+} | {
+    type: DetailsType.Entry;
+    content: EntryDetails;
+};

package/lib/hdk/details.js

@@ -0,0 +1,8 @@
+/**
+ * @public
+ */
+export var DetailsType;
+(function (DetailsType) {
+    DetailsType["Entry"] = "entry";
+    DetailsType["Record"] = "record";
+})(DetailsType || (DetailsType = {}));

package/lib/hdk/entry.d.ts

@@ -1,6 +1,7 @@
 import { CapClaim, ZomeCallCapGrant } from "./capabilities.js";
 import { AgentPubKey } from "../types.js";
 import { CounterSigningSessionData } from "./countersigning.js";
+import { SignedActionHashed } from "./action.js";
 /**
  * @public
  */
@@ -30,3 +31,21 @@ export interface EntryContent<E extends string, C> {
  * @public
  */
 export type Entry = EntryContent<"Agent", AgentPubKey> | EntryContent<"App", Uint8Array> | EntryContent<"CounterSign", [CounterSigningSessionData, Uint8Array]> | EntryContent<"CapGrant", ZomeCallCapGrant> | EntryContent<"CapClaim", CapClaim>;
+/**
+ * @public
+ */
+export declare enum EntryDhtStatus {
+    Live = "live",
+    Dead = "dead"
+}
+/**
+ * @public
+ */
+export interface EntryDetails {
+    entry: Entry;
+    actions: Array<SignedActionHashed>;
+    rejected_actions: Array<SignedActionHashed>;
+    deletes: Array<SignedActionHashed>;
+    updates: Array<SignedActionHashed>;
+    entry_dht_status: EntryDhtStatus;
+}

package/lib/hdk/entry.js

@@ -1 +1,8 @@
-export {};
+/**
+ * @public
+ */
+export var EntryDhtStatus;
+(function (EntryDhtStatus) {
+    EntryDhtStatus["Live"] = "live";
+    EntryDhtStatus["Dead"] = "dead";
+})(EntryDhtStatus || (EntryDhtStatus = {}));

package/lib/hdk/index.d.ts

@@ -1,7 +1,9 @@
 export * from "./action.js";
 export * from "./capabilities.js";
 export * from "./countersigning.js";
+export * from "./details.js";
 export * from "./dht-ops.js";
 export * from "./entry.js";
 export * from "./link.js";
 export * from "./record.js";
+export * from "./validation-receipts.js";

package/lib/hdk/index.js

@@ -1,7 +1,9 @@
 export * from "./action.js";
 export * from "./capabilities.js";
 export * from "./countersigning.js";
+export * from "./details.js";
 export * from "./dht-ops.js";
 export * from "./entry.js";
 export * from "./link.js";
 export * from "./record.js";
+export * from "./validation-receipts.js";

package/lib/hdk/record.d.ts

@@ -1,5 +1,6 @@
 import { SignedActionHashed } from "./action.js";
 import { Entry } from "./entry.js";
+import { ValidationStatus } from "./validation-receipts.js";
 /**
  * @public
  */
@@ -19,3 +20,12 @@ export type RecordEntry = {
 } | {
     NotStored: void;
 };
+/**
+ * @public
+ */
+export interface RecordDetails {
+    record: Record;
+    validation_status: ValidationStatus;
+    deletes: Array<SignedActionHashed>;
+    updates: Array<SignedActionHashed>;
+}

package/lib/hdk/validation-receipts.d.ts

@@ -0,0 +1,18 @@
+import { AgentPubKey, DhtOpHash, Timestamp } from "../types";
+/**
+ * @public
+ */
+export declare enum ValidationStatus {
+    Valid = 0,
+    Rejected = 1,
+    Abandoned = 2
+}
+/**
+ * @public
+ */
+export interface ValidationReceipt {
+    dht_op_hash: DhtOpHash;
+    validation_status: ValidationStatus;
+    validator: AgentPubKey;
+    when_integrated: Timestamp;
+}

package/lib/hdk/validation-receipts.js

@@ -0,0 +1,9 @@
+/**
+ * @public
+ */
+export var ValidationStatus;
+(function (ValidationStatus) {
+    ValidationStatus[ValidationStatus["Valid"] = 0] = "Valid";
+    ValidationStatus[ValidationStatus["Rejected"] = 1] = "Rejected";
+    ValidationStatus[ValidationStatus["Abandoned"] = 2] = "Abandoned";
+})(ValidationStatus || (ValidationStatus = {}));

package/lib/tsdoc-metadata.json

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

package/lib/types.d.ts

@@ -1,3 +1,4 @@
+/** HoloHash Types */
 /**
  * @public
  */
@@ -30,6 +31,27 @@ export type AnyDhtHash = HoloHash;
  * @public
  */
 export type ExternalHash = HoloHash;
+/**
+ * @public
+ */
+export type DhtOpHash = HoloHash;
+/**
+ * @public
+ */
+export type WarrantHash = HoloHash;
+/**
+ * @public
+ */
+export declare enum HoloHashType {
+    Agent = "agent",
+    Entry = "entry",
+    DhtOp = "dhtop",
+    Warrant = "warrant",
+    Dna = "dna",
+    Action = "action",
+    Wasm = "wasm",
+    External = "external"
+}
 /**
  * @public
  */
@@ -67,6 +89,18 @@ export type ActionHashB64 = HoloHashB64;
  * @public
  */
 export type AnyDhtHashB64 = HoloHashB64;
+/**
+ * @public
+ */
+export type ExternalHashB64 = HoloHashB64;
+/**
+ * @public
+ */
+export type DhtOpHashB64 = HoloHashB64;
+/**
+ * @public
+ */
+export type WarrantHashB64 = HoloHashB64;
 /**
  * @public
  */

package/lib/types.js

@@ -1 +1,15 @@
-export {};
+/** HoloHash Types */
+/**
+ * @public
+ */
+export var HoloHashType;
+(function (HoloHashType) {
+    HoloHashType["Agent"] = "agent";
+    HoloHashType["Entry"] = "entry";
+    HoloHashType["DhtOp"] = "dhtop";
+    HoloHashType["Warrant"] = "warrant";
+    HoloHashType["Dna"] = "dna";
+    HoloHashType["Action"] = "action";
+    HoloHashType["Wasm"] = "wasm";
+    HoloHashType["External"] = "external";
+})(HoloHashType || (HoloHashType = {}));

package/lib/utils/dna-holo-hash-map.d.ts

@@ -0,0 +1,162 @@
+import { HoloHash, DnaHash, ActionHash, AgentPubKey, AnyDhtHash, DhtOpHash, EntryHash, ExternalHash, WarrantHash, WasmHash } from "../types.js";
+/**
+ * A Map of DnaHash to HoloHashMap.
+ *
+ * i.e. A Map of DnaHash to a Map of HoloHash to a value.
+ *
+ * @param initialEntries - Optional array of `[[DnaHash, HoloHash], value]` to insert into the map.
+ *
+ * @public
+ */
+export declare class DnaHoloHashMap<K extends HoloHash, T> {
+    private _dnaMap;
+    constructor(initialEntries?: Array<[[DnaHash, K], T]>);
+    /**
+     * Gets the value associated with a [DnaHash, HoloHash] key pair.
+     *
+     * @param key - Array of [DnaHash, HoloHash]
+     * @returns The value if found, undefined otherwise
+     */
+    get([dnaHash, key]: [DnaHash, K]): T | undefined;
+    /**
+     * Checks if a [DnaHash, HoloHash] key pair exists in the map.
+     *
+     * @param cellKey - Array of [DnaHash, HoloHash] to check
+     * @returns True if the key exists, false otherwise
+     */
+    has([dnaHash, key]: [DnaHash, K]): boolean;
+    /**
+     * Sets a value for a [DnaHash, HoloHash] key pair.
+     *
+     * @param key - Tuple of [DnaHash, HoloHash]
+     * @param value - The value to store
+     * @returns This map instance for chaining
+     */
+    set([dnaHash, key]: [DnaHash, K], value: T): this;
+    /**
+     * Removes all entries from the map.
+     */
+    clear(): void;
+    /**
+     * Deletes an entry from the map. If this was the last entry for a DNA, the DNA entry is also removed.
+     *
+     * @param key - Array of [DnaHash, HoloHash] to delete
+     * @returns True if the DNA entry was deleted (last entry for that DNA), false otherwise
+     */
+    delete([dnaHash, key]: [DnaHash, K]): boolean;
+    /**
+     * Returns all [DnaHash, HoloHash] key pairs in the map.
+     *
+     * @returns Array of all key tuples
+     */
+    keys(): Array<[DnaHash, K]>;
+    /**
+     * Returns all values in the map.
+     *
+     * @returns Array of all values
+     */
+    values(): Array<T>;
+    /**
+     * Returns all entries as [[DnaHash, HoloHash], value] Arrays.
+     *
+     * @returns Array of all entries
+     */
+    entries(): Array<[[DnaHash, K], T]>;
+    /**
+     * Creates a new DnaHoloHashMap containing only entries that match the filter predicate.
+     *
+     * @param fn - Predicate function to test each value
+     * @returns A new filtered map
+     */
+    filter(fn: (value: T) => boolean): DnaHoloHashMap<K, T>;
+    /**
+     * Creates a new DnaHoloHashMap with values transformed by the mapping function.
+     *
+     * @param fn - Function to transform each value
+     * @returns A new mapped map
+     */
+    map<R>(fn: (value: T) => R): DnaHoloHashMap<K, R>;
+    /**
+     * Returns all HoloHash keys for a specific DNA.
+     *
+     * @param dnaHash - The DNA hash to query
+     * @returns Array of HoloHash keys for this DNA
+     */
+    keysForDna(dnaHash: DnaHash): Array<K>;
+    /**
+     * Returns all values for a specific DNA.
+     *
+     * @param dnaHash - The DNA hash to query
+     * @returns Array of values for this DNA
+     */
+    valuesForDna(dnaHash: DnaHash): Array<T>;
+    /**
+     * Returns all [HoloHash, value] entries for a specific DNA.
+     *
+     * @param dnaHash - The DNA hash to query
+     * @returns Array of entries for this DNA
+     */
+    entriesForDna(dnaHash: DnaHash): Array<[K, T]>;
+    /**
+     * Removes all entries for a specific DNA.
+     *
+     * @param dnaHash - The DNA hash to clear
+     */
+    clearForDna(dnaHash: DnaHash): void;
+    /**
+     * The number of DNA entries in the map.
+     *
+     * @returns The number of unique DNAs
+     */
+    get size(): number;
+}
+/**
+ * @public
+ */
+export declare class DnaAgentPubKeyMap<V> extends DnaHoloHashMap<AgentPubKey, V> {
+}
+/**
+ * @public
+ */
+export declare class DnaDnaHashMap<V> extends DnaHoloHashMap<DnaHash, V> {
+}
+/**
+ * @public
+ */
+export declare class DnaWasmHashMap<V> extends DnaHoloHashMap<WasmHash, V> {
+}
+/**
+ * @public
+ */
+export declare class DnaEntryHashMap<V> extends DnaHoloHashMap<EntryHash, V> {
+}
+/**
+ * @public
+ */
+export declare class DnaActionHashMap<V> extends DnaHoloHashMap<ActionHash, V> {
+}
+/**
+ * @public
+ */
+export declare class DnaAnyDhtHashMap<V> extends DnaHoloHashMap<AnyDhtHash, V> {
+}
+/**
+ * @public
+ */
+export declare class DnaExternalHashMap<V> extends DnaHoloHashMap<ExternalHash, V> {
+}
+/**
+ * @public
+ */
+export declare class DnaDhtOpHashMap<V> extends DnaHoloHashMap<DhtOpHash, V> {
+}
+/**
+ * @public
+ */
+export declare class DnaWarrantHashMap<V> extends DnaHoloHashMap<WarrantHash, V> {
+}
+/**
+ * @public
+ */
+export declare class CellMap<V> extends DnaAgentPubKeyMap<V> {
+}