data-structure-typed 1.35.0 → 1.40.0-rc

package/dist/types/utils/validate-type.d.ts

@@ -0,0 +1,19 @@
+export type KeyValueObject = {
+    [key: string]: any;
+};
+export type KeyValueObjectWithKey = {
+    [key: string]: any;
+    key: string | number | symbol;
+};
+export type NonNumberNonObjectButDefined = string | boolean | symbol | null;
+export type ObjectWithoutKey = Omit<KeyValueObject, 'key'>;
+export type ObjectWithNonNumberKey = {
+    [key: string]: any;
+    key: string | boolean | symbol | null | object | undefined;
+};
+export type ObjectWithNumberKey = {
+    [key: string]: any;
+    key: number;
+};
+export type RestrictValByKey = NonNumberNonObjectButDefined | ObjectWithoutKey | ObjectWithNonNumberKey | ObjectWithNumberKey;
+export type DummyAny = string | number | boolean | null | undefined | object | symbol | void | ((...args: []) => any) | never;

package/dist/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './utils';

package/dist/utils/utils.d.ts

@@ -0,0 +1,19 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+import type { Thunk, ToThunkFn, TrlAsyncFn, TrlFn } from '../types';
+export declare const uuidV4: () => string;
+export declare const arrayRemove: <T>(array: T[], predicate: (item: T, index: number, array: T[]) => boolean) => T[];
+export declare const THUNK_SYMBOL: unique symbol;
+export declare const isThunk: (fnOrValue: any) => boolean;
+export declare const toThunk: (fn: ToThunkFn) => Thunk;
+export declare const trampoline: (fn: TrlFn) => ((...args: [...Parameters<TrlFn>]) => any) & {
+    cont: (...args: [...Parameters<TrlFn>]) => Thunk;
+};
+export declare const trampolineAsync: (fn: TrlAsyncFn) => ((...args: [...Parameters<TrlAsyncFn>]) => Promise<any>) & {
+    cont: (...args: [...Parameters<TrlAsyncFn>]) => Thunk;
+};

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "data-structure-typed",
-  "version": "1.35.0",
+  "version": "1.40.0-rc",
   "description": "Data Structures of Javascript & TypeScript. Binary Tree, BST, Graph, Heap, Priority Queue, Linked List, Queue, Deque, Stack, AVL Tree, Tree Multiset, Trie, Directed Graph, Undirected Graph, Singly Linked List, Doubly Linked List, Max Heap, Max Priority Queue, Min Heap, Min Priority Queue.",
   "main": "dist/index.js",
   "module": "lib/index.js",
   "types": "lib/index.d.ts",
   "source": "src/index.ts",
   "umd:main": "umd/bundle.min.js",
+  "exports": {
+    "import": "./lib/index.js",
+    "require": "./dist/index.js"
+  },
   "scripts": {
     "build": "npm run build:es6 && npm run build:commonjs && npm run build:umd && npm run build:docs",
     "build:es6": "rm -rf lib && tsc",
@@ -28,13 +32,13 @@
     "check:deps": "dependency-cruiser src",
     "changelog": "auto-changelog",
     "coverage:badge": "istanbul-badges-readme",
-    "ci": "env && npm run lint && npm run build && npm run test && git fetch --tags && npm run changelog"
+    "ci": "env && npm run lint && npm run build && npm run update:individuals && npm run test && git fetch --tags && npm run changelog"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/zrwusa/data-structure-typed.git"
   },
-  "author": "Tyler Zeng zrwusa@gmail.com",
+  "author": "Tyler Zeng <zrwusa@gmail.com>",
   "license": "MIT",
   "publishConfig": {
     "@zrwusa:registry": "https://npm.pkg.github.com"
@@ -50,17 +54,17 @@
     "@typescript-eslint/eslint-plugin": "^6.7.4",
     "@typescript-eslint/parser": "^6.7.4",
     "auto-changelog": "^2.4.0",
-    "avl-tree-typed": "^1.34.8",
+    "avl-tree-typed": "^1.35.1",
     "benchmark": "^2.1.4",
-    "binary-tree-typed": "^1.34.8",
-    "bst-typed": "^1.34.8",
+    "binary-tree-typed": "^1.35.1",
+    "bst-typed": "^1.35.1",
     "dependency-cruiser": "^14.1.0",
     "eslint": "^8.50.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-import-resolver-alias": "^1.1.2",
     "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-import": "^2.28.1",
-    "heap-typed": "^1.34.8",
+    "heap-typed": "^1.35.1",
     "istanbul-badges-readme": "^1.8.5",
     "jest": "^29.7.0",
     "prettier": "^3.0.3",

package/test/integration/avl-tree.test.ts

@@ -31,12 +31,12 @@ describe('AVL Tree Test', () => {
     // node15 has type problem. After the uniform design, the generics of containers (DirectedGraph, BST) are based on the type of value. However, this design has a drawback: when I attempt to inherit from the Vertex or BSTNode classes, the types of the results obtained by all methods are those of the parent class.
     expect(node15?.val).toBe(15);
 
-    const dfs = tree.DFS('in', 'node');
+    const dfs = tree.dfs('in', 'node');
     expect(dfs[0].key).toBe(1);
     expect(dfs[dfs.length - 1].key).toBe(16);
 
     tree.perfectlyBalance();
-    const bfs = tree.BFS('node');
+    const bfs = tree.bfs('node');
     expect(tree.isPerfectlyBalanced()).toBe(true);
     expect(bfs[0].key).toBe(8);
     expect(bfs[bfs.length - 1].key).toBe(16);
@@ -95,12 +95,12 @@ describe('AVL Tree Test', () => {
     expect(tree.getHeight()).toBe(1);
 
     expect(tree.isAVLBalanced()).toBe(true);
-    const lastBFSIds = tree.BFS();
+    const lastBFSIds = tree.bfs();
     expect(lastBFSIds[0]).toBe(12);
     expect(lastBFSIds[1]).toBe(2);
     expect(lastBFSIds[2]).toBe(16);
 
-    const lastBFSNodes = tree.BFS('node');
+    const lastBFSNodes = tree.bfs('node');
     expect(lastBFSNodes[0].key).toBe(12);
     expect(lastBFSNodes[1].key).toBe(2);
     expect(lastBFSNodes[2].key).toBe(16);

package/test/integration/bst.test.ts

@@ -44,14 +44,14 @@ describe('Individual package BST operations test', () => {
     const node11 = bst.get(11);
     expect(node11).toBeInstanceOf(BSTNode);
 
-    const dfsInorderNodes = bst.DFS('in', 'node');
+    const dfsInorderNodes = bst.dfs('in', 'node');
     expect(dfsInorderNodes[0].key).toBe(1);
     expect(dfsInorderNodes[dfsInorderNodes.length - 1].key).toBe(16);
 
     bst.perfectlyBalance();
     expect(bst.isPerfectlyBalanced()).toBe(true);
 
-    const bfsNodesAfterBalanced = bst.BFS('node');
+    const bfsNodesAfterBalanced = bst.bfs('node');
     expect(bfsNodesAfterBalanced[0].key).toBe(8);
     expect(bfsNodesAfterBalanced[bfsNodesAfterBalanced.length - 1].key).toBe(16);
 
@@ -169,12 +169,12 @@ describe('Individual package BST operations test', () => {
 
     expect(bst.isAVLBalanced()).toBe(false);
 
-    const bfsIDs = bst.BFS();
+    const bfsIDs = bst.bfs();
     expect(bfsIDs[0]).toBe(2);
     expect(bfsIDs[1]).toBe(12);
     expect(bfsIDs[2]).toBe(16);
 
-    const bfsNodes = bst.BFS('node');
+    const bfsNodes = bst.bfs('node');
     expect(bfsNodes[0].key).toBe(2);
     expect(bfsNodes[1].key).toBe(12);
     expect(bfsNodes[2].key).toBe(16);
@@ -242,14 +242,14 @@ describe('Individual package BST operations test', () => {
     const node11 = objBST.get(11);
     expect(node11).toBeInstanceOf(BSTNode);
 
-    const dfsInorderNodes = objBST.DFS('in', 'node');
+    const dfsInorderNodes = objBST.dfs('in', 'node');
     expect(dfsInorderNodes[0].key).toBe(1);
     expect(dfsInorderNodes[dfsInorderNodes.length - 1].key).toBe(16);
 
     objBST.perfectlyBalance();
     expect(objBST.isPerfectlyBalanced()).toBe(true);
 
-    const bfsNodesAfterBalanced = objBST.BFS('node');
+    const bfsNodesAfterBalanced = objBST.bfs('node');
     expect(bfsNodesAfterBalanced[0].key).toBe(8);
     expect(bfsNodesAfterBalanced[bfsNodesAfterBalanced.length - 1].key).toBe(16);
 
@@ -367,12 +367,12 @@ describe('Individual package BST operations test', () => {
 
     expect(objBST.isAVLBalanced()).toBe(false);
 
-    const bfsIDs = objBST.BFS();
+    const bfsIDs = objBST.bfs();
     expect(bfsIDs[0]).toBe(2);
     expect(bfsIDs[1]).toBe(12);
     expect(bfsIDs[2]).toBe(16);
 
-    const bfsNodes = objBST.BFS('node');
+    const bfsNodes = objBST.bfs('node');
     expect(bfsNodes[0].key).toBe(2);
     expect(bfsNodes[1].key).toBe(12);
     expect(bfsNodes[2].key).toBe(16);

package/test/unit/data-structures/graph/directed-graph.test.ts

@@ -1,4 +1,4 @@
-import {DirectedEdge, DirectedGraph, DirectedVertex, VertexId} from '../../../../src';
+import {DirectedEdge, DirectedGraph, DirectedVertex, VertexKey} from '../../../../src';
 
 describe('DirectedGraph Operation Test', () => {
   let graph: DirectedGraph;
@@ -63,7 +63,7 @@ describe('DirectedGraph Operation Test', () => {
 });
 
 class MyVertex<V extends string> extends DirectedVertex<V> {
-  constructor(key: VertexId, val?: V) {
+  constructor(key: VertexKey, val?: V) {
     super(key, val);
     this._data = val;
   }
@@ -80,7 +80,7 @@ class MyVertex<V extends string> extends DirectedVertex<V> {
 }
 
 class MyEdge<E extends string> extends DirectedEdge<E> {
-  constructor(v1: VertexId, v2: VertexId, weight?: number, val?: E) {
+  constructor(v1: VertexKey, v2: VertexKey, weight?: number, val?: E) {
     super(v1, v2, weight, val);
     this._data = val;
   }
@@ -97,11 +97,11 @@ class MyEdge<E extends string> extends DirectedEdge<E> {
 }
 
 class MyDirectedGraph<V extends MyVertex<string>, E extends MyEdge<string>> extends DirectedGraph<V, E> {
-  createVertex(key: VertexId, val: V['val']): V {
+  createVertex(key: VertexKey, val: V['val']): V {
     return new MyVertex(key, val) as V;
   }
 
-  createEdge(src: VertexId, dest: VertexId, weight?: number, val?: E['val']): E {
+  createEdge(src: VertexKey, dest: VertexKey, weight?: number, val?: E['val']): E {
     return new MyEdge(src, dest, weight ?? 1, val) as E;
   }
 }

package/test/unit/data-structures/graph/overall.test.ts

@@ -29,8 +29,8 @@ describe('Overall Graph Operation Test', () => {
     graph.addEdge('A', 'B');
     graph.addEdge('B', 'C');
 
-    const topologicalOrderIds = graph.topologicalSort();
-    expect(topologicalOrderIds).toEqual(['A', 'B', 'C']);
+    const topologicalOrderKeys = graph.topologicalSort();
+    expect(topologicalOrderKeys).toEqual(['A', 'B', 'C']);
   });
   it('Overall UndirectedGraph Operation Test', () => {
     const graph = new UndirectedGraph();

package/test/unit/data-structures/linked-list/singly-linked-list.test.ts

@@ -384,7 +384,7 @@ describe('SinglyLinkedList Performance Test', () => {
     for (let i = 0; i < magnitude.LINEAR; i++) {
       list.push(i);
     }
-    expect(performance.now() - startPushTime).toBeLessThan(bigO.LINEAR * 10);
+    expect(performance.now() - startPushTime).toBeLessThan(bigO.LINEAR * 20);
 
     const startPopTime = performance.now();
 

package/test/unit/data-structures/graph/index.ts

@@ -1,2 +0,0 @@
-export * from './directed-graph.test';
-export * from './undirected-graph.test';

package/test/unit/data-structures/linked-list/index.ts

@@ -1,4 +0,0 @@
-export * from './singly-linked-list.test';
-export * from './doubly-linked-list.test';
-export * from './linked-list.test';
-export * from './skip-linked-list.test';