data-structure-typed 2.4.5 → 2.5.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "data-structure-typed",
-  "version": "2.4.5",
+  "version": "2.5.1",
   "description": "Standard data structure",
   "browser": "dist/umd/data-structure-typed.min.js",
   "umd:main": "dist/umd/data-structure-typed.min.js",
@@ -30,7 +30,98 @@
       "types": "./dist/types/index.d.ts",
       "import": "./dist/esm-legacy/index.mjs",
       "require": "./dist/cjs-legacy/index.cjs"
-    }
+    },
+    "./binary-tree": {
+      "types": "./dist/types/data-structures/binary-tree/index.d.ts",
+      "node": {
+        "import": "./dist/esm/binary-tree.mjs",
+        "require": "./dist/cjs/binary-tree.cjs"
+      },
+      "import": "./dist/esm-legacy/binary-tree.mjs",
+      "require": "./dist/cjs-legacy/binary-tree.cjs"
+    },
+    "./graph": {
+      "types": "./dist/types/data-structures/graph/index.d.ts",
+      "node": {
+        "import": "./dist/esm/graph.mjs",
+        "require": "./dist/cjs/graph.cjs"
+      },
+      "import": "./dist/esm-legacy/graph.mjs",
+      "require": "./dist/cjs-legacy/graph.cjs"
+    },
+    "./hash": {
+      "types": "./dist/types/data-structures/hash/index.d.ts",
+      "node": {
+        "import": "./dist/esm/hash.mjs",
+        "require": "./dist/cjs/hash.cjs"
+      },
+      "import": "./dist/esm-legacy/hash.mjs",
+      "require": "./dist/cjs-legacy/hash.cjs"
+    },
+    "./heap": {
+      "types": "./dist/types/data-structures/heap/index.d.ts",
+      "node": {
+        "import": "./dist/esm/heap.mjs",
+        "require": "./dist/cjs/heap.cjs"
+      },
+      "import": "./dist/esm-legacy/heap.mjs",
+      "require": "./dist/cjs-legacy/heap.cjs"
+    },
+    "./linked-list": {
+      "types": "./dist/types/data-structures/linked-list/index.d.ts",
+      "node": {
+        "import": "./dist/esm/linked-list.mjs",
+        "require": "./dist/cjs/linked-list.cjs"
+      },
+      "import": "./dist/esm-legacy/linked-list.mjs",
+      "require": "./dist/cjs-legacy/linked-list.cjs"
+    },
+    "./matrix": {
+      "types": "./dist/types/data-structures/matrix/index.d.ts",
+      "node": {
+        "import": "./dist/esm/matrix.mjs",
+        "require": "./dist/cjs/matrix.cjs"
+      },
+      "import": "./dist/esm-legacy/matrix.mjs",
+      "require": "./dist/cjs-legacy/matrix.cjs"
+    },
+    "./priority-queue": {
+      "types": "./dist/types/data-structures/priority-queue/index.d.ts",
+      "node": {
+        "import": "./dist/esm/priority-queue.mjs",
+        "require": "./dist/cjs/priority-queue.cjs"
+      },
+      "import": "./dist/esm-legacy/priority-queue.mjs",
+      "require": "./dist/cjs-legacy/priority-queue.cjs"
+    },
+    "./queue": {
+      "types": "./dist/types/data-structures/queue/index.d.ts",
+      "node": {
+        "import": "./dist/esm/queue.mjs",
+        "require": "./dist/cjs/queue.cjs"
+      },
+      "import": "./dist/esm-legacy/queue.mjs",
+      "require": "./dist/cjs-legacy/queue.cjs"
+    },
+    "./stack": {
+      "types": "./dist/types/data-structures/stack/index.d.ts",
+      "node": {
+        "import": "./dist/esm/stack.mjs",
+        "require": "./dist/cjs/stack.cjs"
+      },
+      "import": "./dist/esm-legacy/stack.mjs",
+      "require": "./dist/cjs-legacy/stack.cjs"
+    },
+    "./trie": {
+      "types": "./dist/types/data-structures/trie/index.d.ts",
+      "node": {
+        "import": "./dist/esm/trie.mjs",
+        "require": "./dist/cjs/trie.cjs"
+      },
+      "import": "./dist/esm-legacy/trie.mjs",
+      "require": "./dist/cjs-legacy/trie.cjs"
+    },
+    "./package.json": "./package.json"
   },
   "sideEffects": false,
   "engines": {
@@ -44,8 +135,9 @@
     "build:types": "rm -rf dist/types && tsc -p tsconfig.types.json",
     "build:ecut": "npm run build:node && npm run build:types && npm run build:umd",
     "build:leetcode": "tsup --config tsup.leetcode.config.js",
-    "build:docs": "npm run gen:examples && npm run generate:schema && typedoc --out docs/api ./src",
-    "build:docs-class": "npm run gen:examples && typedoc --out docs/api ./src/data-structures",
+    "build:typedoc-plugin": "tsc scripts/typedoc-plugin-example-rewrite.ts --outDir scripts --esModuleInterop --module commonjs --target es2020 --moduleResolution node --skipLibCheck",
+    "build:docs": "npm run gen:examples && npm run generate:schema && npm run build:typedoc-plugin && typedoc --plugin ./scripts/typedoc-plugin-example-rewrite.js --out docs/api ./src",
+    "build:docs-class": "npm run gen:examples && npm run build:typedoc-plugin && typedoc --plugin ./scripts/typedoc-plugin-example-rewrite.js --out docs/api ./src/data-structures",
     "gen:examples": "ts-node scripts/test-to-example.ts",
     "test:in-band": "jest --runInBand",
     "test": "npm run test:in-band",
@@ -75,7 +167,11 @@
     "publish:subs": "npm run copy:to-subs && sh scripts/publish_all_subs.sh",
     "publish:docs": "sh scripts/publish_docs.sh",
     "publish:all": "npm run ci && npm publish && npm run publish:docs && npm run check:exist-latest && npm run publish:subs",
-    "generate:schema": "ts-node scripts/generate-schema.ts"
+    "generate:schema": "ts-node scripts/generate-schema.ts",
+    "docs:api": "npm run gen:examples && npm run build:typedoc-plugin && cd docs-site-docusaurus && npx typedoc --options typedoc.json && node sort-protected.mjs",
+    "docs:dev": "cd docs-site-docusaurus && npm run start",
+    "docs:build": "cd docs-site-docusaurus && rm -rf docs/api && npx typedoc --options typedoc.json && node sort-protected.mjs && npm run build",
+    "docs:preview": "cd docs-site-docusaurus && npm run serve"
   },
   "repository": {
     "type": "git",
@@ -101,11 +197,11 @@
     "@typescript-eslint/eslint-plugin": "^8.12.1",
     "@typescript-eslint/parser": "^8.12.1",
     "auto-changelog": "^2.5.0",
-    "avl-tree-typed": "^1.54.3",
+    "avl-tree-typed": "^2.5.0",
     "benchmark": "^2.1.4",
-    "binary-tree-typed": "^1.54.3",
-    "bst-typed": "^1.54.3",
-    "data-structure-typed": "^2.4.4",
+    "binary-tree-typed": "^2.5.0",
+    "bst-typed": "^2.5.0",
+    "data-structure-typed": "^2.5.0",
     "dependency-cruiser": "^16.5.0",
     "doctoc": "^2.2.1",
     "eslint": "^9.13.0",
@@ -114,7 +210,7 @@
     "eslint-import-resolver-typescript": "^3.6.3",
     "eslint-plugin-import": "^2.31.0",
     "fast-glob": "^3.3.2",
-    "heap-typed": "^1.54.3",
+    "heap-typed": "^2.5.0",
     "istanbul-badges-readme": "^1.9.0",
     "jest": "^29.7.0",
     "js-sdsl": "^4.4.2",
@@ -124,8 +220,9 @@
     "ts-morph": "^27.0.2",
     "ts-node": "^10.9.2",
     "tsup": "^8.5.1",
-    "typedoc": "^0.26.10",
-    "typescript": "^5.6.3"
+    "typedoc": "^0.28.18",
+    "typedoc-plugin-markdown": "^4.11.0",
+    "typescript": "~5.9"
   },
   "keywords": [
     "data structures typescript",

package/src/data-structures/base/index.ts

@@ -1,2 +1,3 @@
 export * from './iterable-entry-base';
 export * from './iterable-element-base';
+export * from './linear-base';

package/src/data-structures/base/iterable-element-base.ts

@@ -1,5 +1,4 @@
 import type { ElementCallback, IterableElementBaseOptions, ReduceElementCallback } from '../../types';
-import { ERR } from '../../common';
 
 /**
  * Base class that makes a data structure iterable and provides common
@@ -26,7 +25,7 @@ export abstract class IterableElementBase<E, R> implements Iterable<E> {
     if (options) {
       const { toElementFn } = options;
       if (typeof toElementFn === 'function') this._toElementFn = toElementFn;
-      else if (toElementFn) throw new TypeError(ERR.notAFunction('toElementFn'));
+      else if (toElementFn) throw new TypeError('toElementFn must be a function type');
     }
   }
 
@@ -36,7 +35,7 @@ export abstract class IterableElementBase<E, R> implements Iterable<E> {
    * @remarks
    * Time O(1), Space O(1).
    */
-  protected readonly _toElementFn?: (rawElement: R) => E;
+  protected _toElementFn?: (rawElement: R) => E;
 
   /**
    * Exposes the current `toElementFn`, if configured.
@@ -225,12 +224,12 @@ export abstract class IterableElementBase<E, R> implements Iterable<E> {
       acc = initialValue as U;
     } else {
       const first = iter.next();
-      if (first.done) throw new TypeError(ERR.reduceEmpty());
+      if (first.done) throw new TypeError('Reduce of empty structure with no initial value');
       acc = first.value as unknown as U;
       index = 1;
     }
 
-    for (const value of iter) {
+    for (const value of iter as unknown as Iterable<E>) {
       acc = callbackfn(acc, value, index++, this);
     }
     return acc;

package/src/data-structures/base/iterable-entry-base.ts

@@ -19,7 +19,7 @@ export abstract class IterableEntryBase<K = any, V = any> {
    * @returns Iterator of `[K, V]`.
    * @remarks Time O(n) to iterate, Space O(1)
    */
-  *[Symbol.iterator](...args: any[]): IterableIterator<[K, V]> {
+  *[Symbol.iterator](...args: unknown[]): IterableIterator<[K, V]> {
     yield* this._getIterator(...args);
   }
 
@@ -63,7 +63,7 @@ export abstract class IterableEntryBase<K = any, V = any> {
    * @returns `true` if all pass; otherwise `false`.
    * @remarks Time O(n), Space O(1)
    */
-  every(predicate: EntryCallback<K, V, boolean>, thisArg?: any): boolean {
+  every(predicate: EntryCallback<K, V, boolean>, thisArg?: unknown): boolean {
     let index = 0;
     for (const item of this) {
       if (!predicate.call(thisArg, item[1], item[0], index++, this)) {
@@ -80,7 +80,7 @@ export abstract class IterableEntryBase<K = any, V = any> {
    * @returns `true` if any passes; otherwise `false`.
    * @remarks Time O(n), Space O(1)
    */
-  some(predicate: EntryCallback<K, V, boolean>, thisArg?: any): boolean {
+  some(predicate: EntryCallback<K, V, boolean>, thisArg?: unknown): boolean {
     let index = 0;
     for (const item of this) {
       if (predicate.call(thisArg, item[1], item[0], index++, this)) {
@@ -96,7 +96,7 @@ export abstract class IterableEntryBase<K = any, V = any> {
    * @param thisArg - Optional `this` for callback.
    * @remarks Time O(n), Space O(1)
    */
-  forEach(callbackfn: EntryCallback<K, V, void>, thisArg?: any): void {
+  forEach(callbackfn: EntryCallback<K, V, void>, thisArg?: unknown): void {
     let index = 0;
     for (const item of this) {
       const [key, value] = item;
@@ -111,7 +111,7 @@ export abstract class IterableEntryBase<K = any, V = any> {
    * @returns Matching `[key, value]` or `undefined`.
    * @remarks Time O(n), Space O(1)
    */
-  find(callbackfn: EntryCallback<K, V, boolean>, thisArg?: any): [K, V] | undefined {
+  find(callbackfn: EntryCallback<K, V, boolean>, thisArg?: unknown): [K, V] | undefined {
     let index = 0;
     for (const item of this) {
       const [key, value] = item;
@@ -228,19 +228,19 @@ export abstract class IterableEntryBase<K = any, V = any> {
    * Map entries using an implementation-specific strategy.
    * @remarks Time O(n), Space O(n)
    */
-  abstract map(...args: any[]): any;
+  abstract map(...args: unknown[]): unknown;
 
   /**
    * Filter entries and return the same-species structure.
    * @returns A new instance of the same concrete class (`this` type).
    * @remarks Time O(n), Space O(n)
    */
-  abstract filter(...args: any[]): this;
+  abstract filter(...args: unknown[]): this;
 
   /**
    * Underlying iterator for the default iteration protocol.
    * @returns Iterator of `[K, V]`.
    * @remarks Time O(n), Space O(1)
    */
-  protected abstract _getIterator(...args: any[]): IterableIterator<[K, V]>;
+  protected abstract _getIterator(...args: unknown[]): IterableIterator<[K, V]>;
 }

package/src/data-structures/base/linear-base.ts

@@ -148,7 +148,7 @@ export abstract class LinearBase<
    * @returns Index or `-1`.
    * @remarks Time O(n), Space O(1)
    */
-  findIndex(predicate: ElementCallback<E, R, boolean>, thisArg?: any): number {
+  findIndex(predicate: ElementCallback<E, R, boolean>, thisArg?: unknown): number {
     for (let i = 0; i < this.length; i++) {
       const item = this.at(i);
       if (item !== undefined && predicate.call(thisArg, item, i, this)) return i;
@@ -389,7 +389,7 @@ export abstract class LinearBase<
    * @returns Iterator of elements from tail to head.
    * @remarks Time O(n), Space O(1)
    */
-  protected abstract _getReverseIterator(...args: any[]): IterableIterator<E>;
+  protected abstract _getReverseIterator(...args: unknown[]): IterableIterator<E>;
 }
 
 /**
@@ -621,7 +621,7 @@ export abstract class LinearLinkedBase<
    * @returns Iterator over nodes.
    * @remarks Time O(n), Space O(1)
    */
-  protected abstract _getNodeIterator(...args: any[]): IterableIterator<NODE>;
+  protected abstract _getNodeIterator(...args: unknown[]): IterableIterator<NODE>;
 
   /**
    * Get previous node of a given node.