@holochain/client 0.20.0 → 0.20.1

package/lib/utils/holo-hash-map.js

@@ -0,0 +1,312 @@
+import { encodeHashToBase64, decodeHashFromBase64 } from "./base64.js";
+/**
+ * A Map of HoloHashB64 to a value.
+ *
+ * @param initialEntries - Optional array of [key, value] pairs to insert into the map.
+ *
+ * @public
+ */
+export class HoloHashB64Map extends Map {
+    constructor(initialEntries) {
+        super();
+        if (initialEntries) {
+            for (const [key, value] of initialEntries) {
+                this.set(key, value);
+            }
+        }
+    }
+}
+/**
+ * @public
+ */
+export class AgentPubKeyB64Map extends HoloHashB64Map {
+}
+/**
+ * @public
+ */
+export class DnaHashB64Map extends HoloHashB64Map {
+}
+/**
+ * @public
+ */
+export class WasmHashB64Map extends HoloHashB64Map {
+}
+/**
+ * @public
+ */
+export class EntryHashB64Map extends HoloHashB64Map {
+}
+/**
+ * @public
+ */
+export class ActionHashB64Map extends HoloHashB64Map {
+}
+/**
+ * @public
+ */
+export class AnyDhtHashB64Map extends HoloHashB64Map {
+}
+/**
+ * @public
+ */
+export class ExternalHashB64Map extends HoloHashB64Map {
+}
+/**
+ * @public
+ */
+export class DhtOpHashB64Map extends HoloHashB64Map {
+}
+/**
+ * @public
+ */
+export class WarrantHashB64Map extends HoloHashB64Map {
+}
+/**
+ * A Map of HoloHash to a value.
+ *
+ * @param initialEntries - Optional array of [key, value] pairs to insert into the map.
+ *
+ * @public
+ */
+export class HoloHashMap {
+    _map;
+    constructor(initialEntries) {
+        const encodedEntries = initialEntries?.map(([k, v]) => [this._encodeKey(k), v]);
+        this._map = new HoloHashB64Map(encodedEntries);
+    }
+    /**
+     * Removes all entries from the map.
+     */
+    clear() {
+        this._map.clear();
+    }
+    /**
+     * Returns an iterator of values in the map.
+     *
+     * @returns An iterator of all values
+     */
+    values() {
+        return this._map.values();
+    }
+    /**
+     * Checks if a key exists in the map.
+     *
+     * @param key - The HoloHash key to check
+     * @returns True if the key exists, false otherwise
+     */
+    has(key) {
+        const k = this._encodeKey(key);
+        return this._map.has(k);
+    }
+    /**
+     * Gets the value associated with a key.
+     *
+     * @param key - The HoloHash key
+     * @returns The value if found, undefined otherwise
+     */
+    get(key) {
+        const k = this._encodeKey(key);
+        return this._map.get(k);
+    }
+    /**
+     * Sets a key-value pair in the map.
+     *
+     * @param key - The HoloHash key
+     * @param value - The value to store
+     * @returns This map instance for chaining
+     */
+    set(key, value) {
+        const k = this._encodeKey(key);
+        this._map.set(k, value);
+        return this;
+    }
+    /**
+     * Deletes an entry from the map.
+     *
+     * @param key - The HoloHash key to delete
+     * @returns True if the entry was deleted, false if it didn't exist
+     */
+    delete(key) {
+        const k = this._encodeKey(key);
+        return this._map.delete(k);
+    }
+    /**
+     * Returns an iterator of keys in the map.
+     *
+     * @returns An iterator of all HoloHash keys
+     */
+    keys() {
+        return Array.from(this._map.keys())
+            .map((key) => this._decodeKey(key))[Symbol.iterator]();
+    }
+    /**
+     * Returns an iterator of [key, value] pairs.
+     *
+     * @returns An iterator of all entries
+     */
+    entries() {
+        return Array.from(this._map.entries())
+            .map(([key, v]) => [this._decodeKey(key), v])[Symbol.iterator]();
+    }
+    /**
+     * Executes a callback function for each entry in the map.
+     *
+     * @param callbackfn - Function to execute for each entry
+     * @param thisArg - Optional value to use as 'this' when executing the callback
+     */
+    forEach(callbackfn, 
+    // This 'any' is inherited from the Map interface.
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    thisArg) {
+        this._map.forEach((v, k) => {
+            callbackfn(v, this._decodeKey(k), this);
+        }, thisArg);
+    }
+    [Symbol.iterator]() {
+        return this.entries();
+    }
+    get [Symbol.toStringTag]() {
+        return this._map[Symbol.toStringTag];
+    }
+    /**
+     * The number of entries in the map.
+     *
+     * @returns The size of the map
+     */
+    get size() {
+        return this._map.size;
+    }
+    _encodeKey(key) {
+        return encodeHashToBase64(key);
+    }
+    _decodeKey(encoded) {
+        return decodeHashFromBase64(encoded);
+    }
+}
+/**
+ * @public
+ */
+export class AgentPubKeyMap extends HoloHashMap {
+}
+/**
+ * @public
+ */
+export class DnaHashMap extends HoloHashMap {
+}
+/**
+ * @public
+ */
+export class WasmHashMap extends HoloHashMap {
+}
+/**
+ * @public
+ */
+export class EntryHashMap extends HoloHashMap {
+}
+/**
+ * @public
+ */
+export class ActionHashMap extends HoloHashMap {
+}
+/**
+ * @public
+ */
+export class AnyDhtHashMap extends HoloHashMap {
+}
+/**
+ * @public
+ */
+export class ExternalHashMap extends HoloHashMap {
+}
+/**
+ * @public
+ */
+export class DhtOpHashMap extends HoloHashMap {
+}
+/**
+ * @public
+ */
+export class WarrantHashMap extends HoloHashMap {
+}
+/**
+ * A HoloHashMap that will fetch and store a value if it is not found in a 'get' call.
+ *
+ * @param fetchValue - A function that takes a key and fetches its value.
+ * @param initialEntries - Optional array of [key, value] pairs to insert into the map.
+ *
+ * @public
+ */
+export class LazyHoloHashMap extends HoloHashMap {
+    fetchValue;
+    constructor(fetchValue, initialEntries) {
+        super(initialEntries);
+        this.fetchValue = fetchValue;
+    }
+    /**
+     *
+     * Get a value for a key.
+     *
+     * If no value for a key is found, it is fetched, inserted into the Map, then returned.
+     *
+     * @param key - HoloHash key
+     * @returns value if found
+     */
+    get(key) {
+        const currentVal = super.get(key);
+        if (currentVal !== undefined) {
+            return currentVal;
+        }
+        else {
+            const val = this.fetchValue(key);
+            if (val !== undefined) {
+                super.set(key, val);
+            }
+            return val;
+        }
+    }
+}
+/**
+ * @public
+ */
+export class LazyAgentPubKeyMap extends LazyHoloHashMap {
+}
+/**
+ * @public
+ */
+export class LazyDnaHashMap extends LazyHoloHashMap {
+}
+/**
+ * @public
+ */
+export class LazyWasmHashMap extends LazyHoloHashMap {
+}
+/**
+ * @public
+ */
+export class LazyEntryHashMap extends LazyHoloHashMap {
+}
+/**
+ * @public
+ */
+export class LazyActionHashMap extends LazyHoloHashMap {
+}
+/**
+ * @public
+ */
+export class LazyAnyDhtHashMap extends LazyHoloHashMap {
+}
+/**
+ * @public
+ */
+export class LazyExternalHashMap extends LazyHoloHashMap {
+}
+/**
+ * @public
+ */
+export class LazyDhtOpHashMap extends LazyHoloHashMap {
+}
+/**
+ * @public
+ */
+export class LazyWarrantHashMap extends LazyHoloHashMap {
+}

package/lib/utils/index.d.ts

@@ -1,4 +1,6 @@
 export * from "./base64.js";
+export * from "./cell.js";
+export * from "./dna-holo-hash-map.js";
 export * from "./fake-hash.js";
 export * from "./hash-parts.js";
-export * from "./cell.js";
+export * from "./holo-hash-map.js";

package/lib/utils/index.js

@@ -1,4 +1,6 @@
 export * from "./base64.js";
+export * from "./cell.js";
+export * from "./dna-holo-hash-map.js";
 export * from "./fake-hash.js";
 export * from "./hash-parts.js";
-export * from "./cell.js";
+export * from "./holo-hash-map.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@holochain/client",
-  "version": "0.20.0",
+  "version": "0.20.1",
   "description": "A JavaScript client for the Holochain Conductor API",
   "author": "Holochain Foundation <info@holochain.org> (https://holochain.org)",
   "license": "CAL-1.0",
@@ -31,46 +31,48 @@
     "lib"
   ],
   "scripts": {
-    "lint": "eslint --fix --ext .ts src test .eslintrc.cjs",
+    "lint": "eslint --fix --ext .ts src test eslint.config.cjs",
     "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",
-    "prepublishOnly": "npm run lint && npm run build"
+    "build": "npm run build:lib && npm run build:docs"
   },
   "dependencies": {
     "@bitgo/blake2b": "^3.2.4",
-    "@msgpack/msgpack": "^3.1.1",
-    "emittery": "^1.0.1",
+    "@msgpack/msgpack": "^3.1.2",
+    "emittery": "^1.2.0",
     "isomorphic-ws": "^5.0.0",
-    "js-base64": "^3.7.5",
+    "js-base64": "^3.7.8",
     "js-sha512": "^0.9.0",
-    "libsodium-wrappers": "^0.7.13",
+    "libsodium-wrappers": "^0.7.15",
     "lodash-es": "^4.17.21",
-    "ws": "^8.14.2"
+    "ws": "^8.18.3"
   },
   "devDependencies": {
-    "@microsoft/api-documenter": "^7.21.7",
-    "@microsoft/api-extractor": "^7.34.4",
+    "@eslint/eslintrc": "^3.3.3",
+    "@eslint/js": "^9.39.1",
+    "@microsoft/api-documenter": "^7.28.1",
+    "@microsoft/api-extractor": "^7.55.1",
     "@types/js-yaml": "4.0.9",
-    "@types/libsodium-wrappers": "^0.7.11",
-    "@types/lodash-es": "^4.17.6",
-    "@types/tape": "^4.13.2",
-    "@types/ws": "^8.5.5",
-    "@typescript-eslint/eslint-plugin": "^5.62.0",
-    "@typescript-eslint/parser": "^5.62.0",
-    "eslint": "^8.49.0",
-    "eslint-config-prettier": "^8.10.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-tsdoc": "^0.2.17",
-    "js-yaml": "^4.1.0",
-    "prettier": "^2.8.8",
-    "rimraf": "^3.0.2",
-    "tape": "^5.6.6",
-    "tsx": "^4.7.2",
-    "typescript": "^4.9.5"
+    "@types/libsodium-wrappers": "^0.7.14",
+    "@types/lodash-es": "^4.17.12",
+    "@types/tape": "^5.8.1",
+    "@types/ws": "^8.18.1",
+    "@typescript-eslint/eslint-plugin": "^8.48.1",
+    "@typescript-eslint/parser": "^8.48.1",
+    "eslint": "^9.39.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-tsdoc": "^0.5.0",
+    "globals": "^16.5.0",
+    "js-yaml": "^4.1.1",
+    "prettier": "^3.7.3",
+    "rimraf": "^6.1.2",
+    "tape": "^5.9.0",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3"
   }
 }