@thi.ng/bidir-index 1.3.13 → 1.4.0

package/README.md

@@ -7,7 +7,7 @@
 [![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 > [!NOTE]
-> This is one of 210 standalone projects, maintained as part
+> This is one of 211 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >
@@ -67,11 +67,14 @@ For Node.js REPL:
 const bi = await import("@thi.ng/bidir-index");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 884 bytes
+Package sizes (brotli'd, pre-treeshake): ESM: 999 bytes
 
 ## Dependencies
 
-None
+- [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/develop/packages/api)
+- [@thi.ng/checks](https://github.com/thi-ng/umbrella/tree/develop/packages/checks)
+
+Note: @thi.ng/api is in _most_ cases a type-only import (not used at runtime)
 
 ## API
 

package/bidir-index.d.ts

@@ -1,8 +1,9 @@
+import type { IClear, ICopy, IEmpty } from "@thi.ng/api";
 import type { BidirIndexOpts, SerializedBidirIndex } from "./api.js";
 /**
  * Bi-directional index to map arbitrary keys to numeric IDs and vice versa.
  */
-export declare class BidirIndex<T> {
+export declare class BidirIndex<T> implements IClear, ICopy<BidirIndex<T>>, IEmpty<BidirIndex<T>> {
     fwd: Map<T, number>;
     rev: Map<number, T>;
     nextID: number;
@@ -12,6 +13,9 @@ export declare class BidirIndex<T> {
      * Yields same result as {@link BidirIndex.entries}.
      */
     [Symbol.iterator](): MapIterator<[T, number]>;
+    clear(): void;
+    copy(): BidirIndex<T>;
+    empty(): BidirIndex<T>;
     /**
      * Returns iterator of `[key,id]` pairs.
      */

package/bidir-index.js

@@ -1,3 +1,4 @@
+import { implementsFunction } from "@thi.ng/checks/implements-function";
 class BidirIndex {
   fwd;
   rev;
@@ -17,6 +18,25 @@ class BidirIndex {
   [Symbol.iterator]() {
     return this.entries();
   }
+  clear() {
+    this.fwd.clear();
+    this.rev.clear();
+    this.nextID = 0;
+  }
+  copy() {
+    const result = new BidirIndex();
+    result.fwd = implementsFunction(this.fwd, "copy") ? this.fwd.copy() : new Map(this.fwd);
+    result.rev = new Map(this.rev);
+    result.nextID = this.nextID;
+    return result;
+  }
+  empty() {
+    const result = new BidirIndex();
+    if (implementsFunction(this.fwd, "empty")) {
+      result.fwd = this.fwd.empty();
+    }
+    return result;
+  }
   /**
    * Returns iterator of `[key,id]` pairs.
    */
@@ -92,7 +112,7 @@ class BidirIndex {
    */
   addAll(keys) {
     const res = [];
-    for (let k of keys) {
+    for (const k of keys) {
       res.push(this.add(k));
     }
     return res;
@@ -105,7 +125,7 @@ class BidirIndex {
    */
   addAllUnique(keys) {
     const res = /* @__PURE__ */ new Set();
-    for (let k of keys) {
+    for (const k of keys) {
       res.add(this.add(k));
     }
     return res;
@@ -134,7 +154,7 @@ class BidirIndex {
    * @param keys
    */
   deleteAll(keys) {
-    for (let k of keys) this.delete(k);
+    for (const k of keys) this.delete(k);
   }
   /**
    * Batch version of {@link BidirIndex.deleteID}.
@@ -142,7 +162,7 @@ class BidirIndex {
    * @param ids
    */
   deleteAllIDs(ids) {
-    for (let id of ids) this.deleteID(id);
+    for (const id of ids) this.deleteID(id);
   }
   /**
    * Returns array of IDs for all given keys. If `fail` is true (default:
@@ -200,7 +220,7 @@ const __delete = (fwd, rev, key) => {
 };
 const __iterate = (index, keys, fail) => {
   const res = [];
-  for (let k of keys) {
+  for (const k of keys) {
     const val = index.get(k);
     if (val === void 0) {
       if (fail) throw new Error(`unknwon key/ID: ${k}`);

package/encode.js

@@ -2,7 +2,7 @@ const encodeObject = (index, obj, defaultValue, indexKeys = true) => {
   const keys = Object.keys(obj);
   const ids = indexKeys ? index.addAll(keys) : index.getAll(keys);
   const res = new Array(index.size).fill(defaultValue);
-  for (let id of ids) {
+  for (const id of ids) {
     const val = obj[index.getID(id)];
     if (val != null) res[id] = val;
   }
@@ -10,15 +10,15 @@ const encodeObject = (index, obj, defaultValue, indexKeys = true) => {
 };
 const encodeObjectIterator = function* (index, objects, defaultValue, indexKeys = true) {
   if (indexKeys) {
-    for (let o of objects) index.addAll(Object.keys(o));
+    for (const o of objects) index.addAll(Object.keys(o));
   }
-  for (let o of objects) {
+  for (const o of objects) {
     yield* encodeObject(index, o, defaultValue, false);
   }
 };
 const decodeObject = (index, values, defaults) => {
   const res = {};
-  for (let [k, id] of index) {
+  for (const [k, id] of index) {
     const val = values[id] ?? defaults?.[k];
     if (val != null) res[k] = val;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@thi.ng/bidir-index",
-	"version": "1.3.13",
+	"version": "1.4.0",
 	"description": "Bi-directional index mapping arbitrary keys to numeric IDs & vice versa",
 	"type": "module",
 	"module": "./index.js",
@@ -38,6 +38,10 @@
 		"test": "bun test",
 		"tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
 	},
+	"dependencies": {
+		"@thi.ng/api": "^8.12.10",
+		"@thi.ng/checks": "^3.8.0"
+	},
 	"devDependencies": {
 		"esbuild": "^0.27.0",
 		"typedoc": "^0.28.14",
@@ -53,6 +57,7 @@
 		"iterator",
 		"keys",
 		"map",
+		"number",
 		"typescript"
 	],
 	"publishConfig": {
@@ -89,5 +94,5 @@
 		],
 		"year": 2022
 	},
-	"gitHead": "be6e7657b1e5c54d7d648d1b52888a7297e95a17\n"
+	"gitHead": "824bf9047b5a10f777c5c5b4aeecf0c750a22c75\n"
 }