@holochain/client 0.11.12 → 0.11.14

package/lib/hdk/action.d.ts

@@ -1,10 +1,19 @@
 import { AgentPubKey, DnaHash, EntryHash, ActionHash, HoloHashed, Signature, Timestamp } from "../types.js";
 import { EntryType } from "./entry.js";
+/**
+ * @public
+ */
 export interface SignedActionHashed<H extends Action = Action> {
     hashed: HoloHashed<H>;
     signature: Signature;
 }
+/**
+ * @public
+ */
 export declare type ActionHashed = HoloHashed<Action>;
+/**
+ * @public
+ */
 export declare enum ActionType {
     Dna = "Dna",
     AgentValidationPkg = "AgentValidationPkg",
@@ -17,14 +26,26 @@ export declare enum ActionType {
     Update = "Update",
     Delete = "Delete"
 }
+/**
+ * @public
+ */
 export declare type Action = Dna | AgentValidationPkg | InitZomesComplete | CreateLink | DeleteLink | OpenChain | CloseChain | Delete | NewEntryAction;
+/**
+ * @public
+ */
 export declare type NewEntryAction = Create | Update;
+/**
+ * @public
+ */
 export interface Dna {
     type: ActionType.Dna;
     author: AgentPubKey;
     timestamp: Timestamp;
     hash: DnaHash;
 }
+/**
+ * @public
+ */
 export interface AgentValidationPkg {
     type: ActionType.AgentValidationPkg;
     author: AgentPubKey;
@@ -33,6 +54,9 @@ export interface AgentValidationPkg {
     prev_action: ActionHash;
     membrane_proof: any;
 }
+/**
+ * @public
+ */
 export interface InitZomesComplete {
     type: ActionType.InitZomesComplete;
     author: AgentPubKey;
@@ -40,6 +64,9 @@ export interface InitZomesComplete {
     action_seq: number;
     prev_action: ActionHash;
 }
+/**
+ * @public
+ */
 export interface CreateLink {
     type: ActionType.CreateLink;
     author: AgentPubKey;
@@ -51,6 +78,9 @@ export interface CreateLink {
     zome_id: number;
     tag: any;
 }
+/**
+ * @public
+ */
 export interface DeleteLink {
     type: ActionType.DeleteLink;
     author: AgentPubKey;
@@ -60,6 +90,9 @@ export interface DeleteLink {
     base_address: EntryHash;
     link_add_address: ActionHash;
 }
+/**
+ * @public
+ */
 export interface OpenChain {
     type: ActionType.OpenChain;
     author: AgentPubKey;
@@ -68,6 +101,9 @@ export interface OpenChain {
     prev_action: ActionHash;
     prev_dna_hash: DnaHash;
 }
+/**
+ * @public
+ */
 export interface CloseChain {
     type: ActionType.CloseChain;
     author: AgentPubKey;
@@ -76,6 +112,9 @@ export interface CloseChain {
     prev_action: ActionHash;
     new_dna_hash: DnaHash;
 }
+/**
+ * @public
+ */
 export interface Update {
     type: ActionType.Update;
     author: AgentPubKey;
@@ -87,6 +126,9 @@ export interface Update {
     entry_type: EntryType;
     entry_hash: EntryHash;
 }
+/**
+ * @public
+ */
 export interface Delete {
     type: ActionType.Delete;
     author: AgentPubKey;
@@ -96,6 +138,9 @@ export interface Delete {
     deletes_address: ActionHash;
     deletes_entry_address: EntryHash;
 }
+/**
+ * @public
+ */
 export interface Create {
     type: ActionType.Create;
     author: AgentPubKey;

package/lib/hdk/action.js

@@ -1,3 +1,6 @@
+/**
+ * @public
+ */
 export var ActionType;
 (function (ActionType) {
     ActionType["Dna"] = "Dna";
@@ -11,4 +14,3 @@ export var ActionType;
     ActionType["Update"] = "Update";
     ActionType["Delete"] = "Delete";
 })(ActionType || (ActionType = {}));
-//# sourceMappingURL=action.js.map

package/lib/hdk/capabilities.d.ts

@@ -1,25 +1,43 @@
 import { FunctionName, ZomeName } from "../api/index.js";
 import { AgentPubKey } from "../types.js";
+/**
+ * @public
+ */
 export declare type CapSecret = Uint8Array;
+/**
+ * @public
+ */
 export interface CapClaim {
     tag: string;
     grantor: AgentPubKey;
     secret: CapSecret;
 }
+/**
+ * @public
+ */
 export declare enum GrantedFunctionsType {
     All = "All",
     Listed = "Listed"
 }
+/**
+ * @public
+ */
 export declare type GrantedFunctions = {
     [GrantedFunctionsType.All]: null;
 } | {
     [GrantedFunctionsType.Listed]: [ZomeName, FunctionName][];
 };
+/**
+ * @public
+ */
 export interface ZomeCallCapGrant {
     tag: string;
     access: CapAccess;
     functions: GrantedFunctions;
 }
+/**
+ * @public
+ */
 export declare type CapAccess = "Unrestricted" | {
     Transferable: {
         secret: CapSecret;
@@ -30,6 +48,9 @@ export declare type CapAccess = "Unrestricted" | {
         assignees: AgentPubKey[];
     };
 };
+/**
+ * @public
+ */
 export declare type CapGrant = {
     ChainAuthor: AgentPubKey;
 } | {

package/lib/hdk/capabilities.js

@@ -1,6 +1,8 @@
+/**
+ * @public
+ */
 export var GrantedFunctionsType;
 (function (GrantedFunctionsType) {
     GrantedFunctionsType["All"] = "All";
     GrantedFunctionsType["Listed"] = "Listed";
 })(GrantedFunctionsType || (GrantedFunctionsType = {}));
-//# sourceMappingURL=capabilities.js.map

package/lib/hdk/countersigning.d.ts

@@ -1,9 +1,15 @@
 import { ActionHash, AgentPubKey, EntryHash, Signature, Timestamp } from "../types.js";
 import { EntryType } from "./entry.js";
+/**
+ * @public
+ */
 export interface CounterSigningSessionData {
     preflight_request: PreflightRequest;
     responses: Array<[CountersigningAgentState, Signature]>;
 }
+/**
+ * @public
+ */
 export interface PreflightRequest {
     app_entry_hash: EntryHash;
     signing_agents: CounterSigningAgents;
@@ -12,26 +18,50 @@ export interface PreflightRequest {
     action_base: ActionBase;
     preflight_bytes: PreflightBytes;
 }
+/**
+ * @public
+ */
 export interface CounterSigningSessionTimes {
     start: Timestamp;
     end: Timestamp;
 }
+/**
+ * @public
+ */
 export declare type ActionBase = {
     Create: CreateBase;
 } | {
     Update: UpdateBase;
 };
+/**
+ * @public
+ */
 export interface CreateBase {
     entry_type: EntryType;
 }
+/**
+ * @public
+ */
 export interface UpdateBase {
     original_action_address: ActionHash;
     original_entry_address: EntryHash;
     entry_type: EntryType;
 }
+/**
+ * @public
+ */
 export declare type CounterSigningAgents = Array<[AgentPubKey, Array<Role>]>;
+/**
+ * @public
+ */
 export declare type PreflightBytes = Uint8Array;
+/**
+ * @public
+ */
 export declare type Role = number;
+/**
+ * @public
+ */
 export interface CountersigningAgentState {
     agent_index: number;
     chain_top: ActionHash;

package/lib/hdk/countersigning.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=countersigning.js.map

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

@@ -1,6 +1,9 @@
 import { Signature } from "../types.js";
 import { Entry } from "./entry.js";
 import { CreateLink, Delete, DeleteLink, Action, NewEntryAction, Update } from "./action.js";
+/**
+ * @public
+ */
 export declare enum DhtOpType {
     StoreRecord = "StoreRecord",
     StoreEntry = "StoreEntry",
@@ -12,6 +15,9 @@ export declare enum DhtOpType {
     RegisterAddLink = "RegisterAddLink",
     RegisterRemoveLink = "RegisterRemoveLink"
 }
+/**
+ * @public
+ */
 export declare type DhtOp = {
     [DhtOpType.StoreRecord]: [Signature, Action, Entry | undefined];
 } | {
@@ -35,7 +41,19 @@ export declare type DhtOp = {
 } | {
     [DhtOpType.RegisterRemoveLink]: [Signature, DeleteLink];
 };
+/**
+ * @public
+ */
 export declare function getDhtOpType(op: DhtOp): DhtOpType;
+/**
+ * @public
+ */
 export declare function getDhtOpAction(op: DhtOp): Action;
+/**
+ * @public
+ */
 export declare function getDhtOpEntry(op: DhtOp): Entry | undefined;
+/**
+ * @public
+ */
 export declare function getDhtOpSignature(op: DhtOp): Signature;

package/lib/hdk/dht-ops.js

@@ -1,4 +1,7 @@
 // https://github.com/holochain/holochain/blob/develop/crates/types/src/dht_op.rs
+/**
+ * @public
+ */
 export var DhtOpType;
 (function (DhtOpType) {
     DhtOpType["StoreRecord"] = "StoreRecord";
@@ -11,9 +14,15 @@ export var DhtOpType;
     DhtOpType["RegisterAddLink"] = "RegisterAddLink";
     DhtOpType["RegisterRemoveLink"] = "RegisterRemoveLink";
 })(DhtOpType || (DhtOpType = {}));
+/**
+ * @public
+ */
 export function getDhtOpType(op) {
     return Object.keys(op)[0];
 }
+/**
+ * @public
+ */
 export function getDhtOpAction(op) {
     const opType = getDhtOpType(op);
     const action = Object.values(op)[0][1];
@@ -40,10 +49,15 @@ export function getDhtOpAction(op) {
         };
     }
 }
+/**
+ * @public
+ */
 export function getDhtOpEntry(op) {
     return Object.values(op)[0][2];
 }
+/**
+ * @public
+ */
 export function getDhtOpSignature(op) {
     return Object.values(op)[0][1];
 }
-//# sourceMappingURL=dht-ops.js.map

package/lib/hdk/entry.d.ts

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

package/lib/hdk/entry.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=entry.js.map

package/lib/hdk/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./action.js";
 export * from "./capabilities.js";
+export * from "./countersigning.js";
 export * from "./dht-ops.js";
 export * from "./entry.js";
 export * from "./record.js";

package/lib/hdk/index.js

@@ -1,6 +1,6 @@
 export * from "./action.js";
 export * from "./capabilities.js";
+export * from "./countersigning.js";
 export * from "./dht-ops.js";
 export * from "./entry.js";
 export * from "./record.js";
-//# sourceMappingURL=index.js.map

package/lib/hdk/record.d.ts

@@ -1,9 +1,15 @@
 import { SignedActionHashed } from "./action.js";
 import { Entry } from "./entry.js";
+/**
+ * @public
+ */
 export declare type Record = {
     signed_action: SignedActionHashed;
     entry: RecordEntry;
 };
+/**
+ * @public
+ */
 export declare type RecordEntry = {
     Present: Entry;
 } | {

package/lib/hdk/record.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=record.js.map

package/lib/index.js

@@ -2,4 +2,3 @@ export * from "./api/index.js";
 export * from "./hdk/index.js";
 export * from "./types.js";
 export * from "./utils/index.js";
-//# sourceMappingURL=index.js.map

package/lib/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.33.7"
+    }
+  ]
+}

package/lib/types.d.ts

@@ -1,41 +1,122 @@
+/**
+ * @public
+ */
 export declare type HoloHash = Uint8Array;
+/**
+ * @public
+ */
 export declare type AgentPubKey = HoloHash;
+/**
+ * @public
+ */
 export declare type DnaHash = HoloHash;
+/**
+ * @public
+ */
 export declare type WasmHash = HoloHash;
+/**
+ * @public
+ */
 export declare type EntryHash = HoloHash;
+/**
+ * @public
+ */
 export declare type ActionHash = HoloHash;
+/**
+ * @public
+ */
 export declare type AnyDhtHash = HoloHash;
+/**
+ * @public
+ */
 export declare type KitsuneAgent = Uint8Array;
+/**
+ * @public
+ */
 export declare type KitsuneSpace = Uint8Array;
 /** Base64 hash types */
+/**
+ * @public
+ */
 export declare type HoloHashB64 = string;
+/**
+ * @public
+ */
 export declare type AgentPubKeyB64 = HoloHashB64;
+/**
+ * @public
+ */
 export declare type DnaHashB64 = HoloHashB64;
+/**
+ * @public
+ */
 export declare type WasmHashB64 = HoloHashB64;
+/**
+ * @public
+ */
 export declare type EntryHashB64 = HoloHashB64;
+/**
+ * @public
+ */
 export declare type ActionHashB64 = HoloHashB64;
+/**
+ * @public
+ */
 export declare type AnyDhtHashB64 = HoloHashB64;
+/**
+ * @public
+ */
 export declare type InstalledAppId = string;
+/**
+ * @public
+ */
 export declare type Signature = Uint8Array;
+/**
+ * @public
+ */
 export declare type CellId = [DnaHash, AgentPubKey];
+/**
+ * @public
+ */
 export declare type DnaProperties = any;
+/**
+ * @public
+ */
 export declare type RoleName = string;
+/**
+ * @public
+ */
 export declare type InstalledCell = {
     cell_id: CellId;
     role_name: RoleName;
 };
+/**
+ * @public
+ */
 export declare type Timestamp = number;
+/**
+ * @public
+ */
 export interface Duration {
     secs: number;
     nanos: number;
 }
+/**
+ * @public
+ */
 export interface HoloHashed<T> {
     hash: HoloHash;
     content: T;
 }
+/**
+ * @public
+ */
 export interface NetworkInfo {
     fetch_queue_info: FetchQueueInfo;
 }
+/**
+ * @public
+ */
 export interface FetchQueueInfo {
     op_bytes_to_fetch: number;
     num_ops_to_fetch: number;

package/lib/types.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=types.js.map

package/lib/utils/base64.d.ts

@@ -1,3 +1,19 @@
 import { HoloHash, HoloHashB64 } from "../types.js";
+/**
+ * Decodes a Base64 encoded string to a byte array hash.
+ *
+ * @param hash - The Base64 encoded string to decode.
+ * @returns The hash in byte format.
+ *
+ * @public
+ */
 export declare function decodeHashFromBase64(hash: HoloHashB64): HoloHash;
+/**
+ * Encode a byte array hash to a Base64 string.
+ *
+ * @param hash - The hash to encode to a Base64 string.
+ * @returns The Base64 encoded string
+ *
+ * @public
+ */
 export declare function encodeHashToBase64(hash: HoloHash): HoloHashB64;

package/lib/utils/base64.js

@@ -1,8 +1,23 @@
 import { Base64 } from "js-base64";
+/**
+ * Decodes a Base64 encoded string to a byte array hash.
+ *
+ * @param hash - The Base64 encoded string to decode.
+ * @returns The hash in byte format.
+ *
+ * @public
+ */
 export function decodeHashFromBase64(hash) {
     return Base64.toUint8Array(hash.slice(1));
 }
+/**
+ * Encode a byte array hash to a Base64 string.
+ *
+ * @param hash - The hash to encode to a Base64 string.
+ * @returns The Base64 encoded string
+ *
+ * @public
+ */
 export function encodeHashToBase64(hash) {
     return `u${Base64.fromUint8Array(hash, true)}`;
 }
-//# sourceMappingURL=base64.js.map

package/lib/utils/fake-hash.d.ts

@@ -1,5 +1,27 @@
 import { ActionHash, AgentPubKey, EntryHash } from "../types.js";
-/** From https://github.com/holochain/holochain/blob/develop/crates/holo_hash/src/hash_type/primitive.rs */
+/**
+ * Generate a valid hash of a non-existing entry.
+ *
+ * From https://github.com/holochain/holochain/blob/develop/crates/holo_hash/src/hash_type/primitive.rs
+ *
+ * @returns An {@link EntryHash}.
+ *
+ * @public
+ */
 export declare function fakeEntryHash(): Promise<EntryHash>;
+/**
+ * Generate a valid agent key of a non-existing agent.
+ *
+ * @returns An {@link AgentPubKey}.
+ *
+ * @public
+ */
 export declare function fakeAgentPubKey(): Promise<AgentPubKey>;
+/**
+ * Generate a valid hash of a non-existing action.
+ *
+ * @returns An {@link ActionHash}.
+ *
+ * @public
+ */
 export declare function fakeActionHash(): Promise<ActionHash>;

package/lib/utils/fake-hash.js

@@ -1,15 +1,36 @@
 import { randomByteArray } from "../api/zome-call-signing.js";
-/** From https://github.com/holochain/holochain/blob/develop/crates/holo_hash/src/hash_type/primitive.rs */
+/**
+ * Generate a valid hash of a non-existing entry.
+ *
+ * From https://github.com/holochain/holochain/blob/develop/crates/holo_hash/src/hash_type/primitive.rs
+ *
+ * @returns An {@link EntryHash}.
+ *
+ * @public
+ */
 export async function fakeEntryHash() {
     const randomBytes = await randomByteArray(36);
     return new Uint8Array([0x84, 0x21, 0x24, ...randomBytes]);
 }
+/**
+ * Generate a valid agent key of a non-existing agent.
+ *
+ * @returns An {@link AgentPubKey}.
+ *
+ * @public
+ */
 export async function fakeAgentPubKey() {
     const randomBytes = await randomByteArray(36);
     return new Uint8Array([0x84, 0x20, 0x24, ...randomBytes]);
 }
+/**
+ * Generate a valid hash of a non-existing action.
+ *
+ * @returns An {@link ActionHash}.
+ *
+ * @public
+ */
 export async function fakeActionHash() {
     const randomBytes = await randomByteArray(36);
     return new Uint8Array([0x84, 0x29, 0x24, ...randomBytes]);
 }
-//# sourceMappingURL=fake-hash.js.map

package/lib/utils/index.js

@@ -1,3 +1,2 @@
 export * from "./base64.js";
 export * from "./fake-hash.js";
-//# sourceMappingURL=index.js.map