data-structure-typed 1.15.1 → 1.16.1

package/dist/data-structures/priority-queue/priority-queue.js

@@ -51,9 +51,9 @@ var PriorityQueue = /** @class */ (function () {
         };
         var nodes = options.nodes, comparator = options.comparator, _a = options.isFix, isFix = _a === void 0 ? true : _a;
         this._comparator = comparator;
-        if (nodes && nodes instanceof Array && nodes.length > 0) {
+        if (nodes && Array.isArray(nodes) && nodes.length > 0) {
             // TODO support distinct
-            this._nodes = Array.isArray(nodes) ? __spreadArray([], __read(nodes), false) : [];
+            this._nodes = __spreadArray([], __read(nodes), false);
             isFix && this._fix();
         }
     }
@@ -67,12 +67,6 @@ var PriorityQueue = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
-    /**
-     * Starting from TypeScript version 5.0 and onwards, the use of distinct access modifiers for Getters and Setters is not permitted. As an alternative, to ensure compatibility, it is necessary to adopt a Java-style approach for Setters (using the same name as the property) while utilizing separate method names for Getters.
-     */
-    PriorityQueue.prototype.getNodes = function () {
-        return this._nodes;
-    };
     Object.defineProperty(PriorityQueue.prototype, "size", {
         get: function () {
             return this.nodes.length;
@@ -100,7 +94,13 @@ var PriorityQueue = /** @class */ (function () {
      * @returns the result of calling the `isValid()` method on a new instance of the `PriorityQueue` class.
      */
     PriorityQueue.isPriorityQueueified = function (options) {
-        return new PriorityQueue(__assign(__assign({}, options), { isFix: true })).isValid();
+        return new PriorityQueue(__assign(__assign({}, options), { isFix: false })).isValid();
+    };
+    /**
+     * Starting from TypeScript version 5.0 and onwards, the use of distinct access modifiers for Getters and Setters is not permitted. As an alternative, to ensure compatibility, it is necessary to adopt a Java-style approach for Setters (using the same name as the property) while utilizing separate method names for Getters.
+     */
+    PriorityQueue.prototype.getNodes = function () {
+        return this._nodes;
     };
     /**
      * The "add" function adds a node to the heap and ensures that the heap property is maintained.
@@ -111,6 +111,15 @@ var PriorityQueue = /** @class */ (function () {
         this.nodes.push(node);
         this._heapifyUp(this.size - 1);
     };
+    /**
+     * The "has" function checks if a given node is present in the list of nodes.
+     * @param {T} node - The parameter `node` is of type `T`, which means it can be any type. It represents the node that
+     * we want to check if it exists in the `nodes` array.
+     * @returns a boolean value indicating whether the given node is included in the array of nodes.
+     */
+    PriorityQueue.prototype.has = function (node) {
+        return this.nodes.includes(node);
+    };
     /**
      * The `peek` function returns the first element of the `nodes` array if it exists, otherwise it returns `null`.
      * @returns The `peek()` function is returning the first element (`T`) of the `nodes` array if the `size` is not zero.
@@ -182,31 +191,28 @@ var PriorityQueue = /** @class */ (function () {
      * @returns The function `isValid()` returns a boolean value.
      */
     PriorityQueue.prototype.isValid = function () {
-        var _this = this;
-        var isValidRecursive = function (parentIndex) {
-            var isValidLeft = true;
-            var isValidRight = true;
-            if (_this._getLeft(parentIndex) !== -1) {
-                var leftChildIndex = (parentIndex * 2) + 1;
-                if (!_this._compare(parentIndex, leftChildIndex))
-                    return false;
-                isValidLeft = isValidRecursive(leftChildIndex);
+        for (var i = 0; i < this.nodes.length; i++) {
+            var leftChildIndex = this._getLeft(i);
+            var rightChildIndex = this._getRight(i);
+            if (this._isValidIndex(leftChildIndex) && !this._compare(leftChildIndex, i)) {
+                return false;
             }
-            if (_this._getRight(parentIndex) !== -1) {
-                var rightChildIndex = (parentIndex * 2) + 2;
-                if (!_this._compare(parentIndex, rightChildIndex))
-                    return false;
-                isValidRight = isValidRecursive(rightChildIndex);
+            if (this._isValidIndex(rightChildIndex) && !this._compare(rightChildIndex, i)) {
+                return false;
             }
-            return isValidLeft && isValidRight;
-        };
-        return isValidRecursive(0);
+        }
+        return true;
     };
     /**
-     * The function sorts the elements in a data structure and returns them in ascending order.
-     * @returns The `sort()` function is returning an array of type `T[]`.
+     * Plan to support sorting of duplicate elements.
+     */
+    /**
+     * The function sorts the elements in a data structure and returns them in an array.
+     * Plan to support sorting of duplicate elements.
+     * @returns The `sort()` method is returning an array of type `T[]`.
      */
     PriorityQueue.prototype.sort = function () {
+        // TODO Plan to support sorting of duplicate elements.
         var visitedNode = [];
         while (this.size !== 0) {
             var top = this.poll();

package/dist/data-structures/queue/deque.d.ts

@@ -9,6 +9,7 @@ import { DoublyLinkedList } from '../linked-list';
 export declare class Deque<T> extends DoublyLinkedList<T> {
 }
 export declare class ObjectDeque<T> {
+    constructor(capacity?: number);
     private _nodes;
     get nodes(): {
         [p: number]: T;
@@ -28,7 +29,6 @@ export declare class ObjectDeque<T> {
     private _size;
     get size(): number;
     protected set size(value: number);
-    constructor(capacity?: number);
     addFirst(value: T): void;
     addLast(value: T): void;
     pollFirst(): T | undefined;

package/dist/data-structures/tree/index.d.ts

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

package/dist/data-structures/tree/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./tree"), exports);

package/dist/data-structures/tree/tree.d.ts

@@ -0,0 +1,9 @@
+export declare class TreeNode<T = number> {
+    id: string;
+    name?: string | undefined;
+    value?: T | undefined;
+    children?: TreeNode<T>[] | undefined;
+    constructor(id: string, name?: string, value?: T, children?: TreeNode<T>[]);
+    addChildren(children: TreeNode<T> | TreeNode<T>[]): void;
+    getHeight(): number;
+}

package/dist/data-structures/tree/tree.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TreeNode = void 0;
+var TreeNode = /** @class */ (function () {
+    function TreeNode(id, name, value, children) {
+        this.id = id;
+        this.name = name || '';
+        this.value = value || undefined;
+        this.children = children || [];
+    }
+    // TODO get set
+    // get name (): string | undefined {
+    //     return this.name;
+    // }
+    //
+    // set name (name: string | undefined) {
+    //     this.name = name;
+    // }
+    TreeNode.prototype.addChildren = function (children) {
+        if (!this.children) {
+            this.children = [];
+        }
+        if (children instanceof TreeNode) {
+            this.children.push(children);
+        }
+        else {
+            this.children = this.children.concat(children);
+        }
+    };
+    TreeNode.prototype.getHeight = function () {
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
+        var beginRoot = this;
+        var maxDepth = 1;
+        if (beginRoot) {
+            var bfs_1 = function (node, level) {
+                if (level > maxDepth) {
+                    maxDepth = level;
+                }
+                var children = node.children;
+                if (children) {
+                    for (var i = 0, len = children.length; i < len; i++) {
+                        bfs_1(children[i], level + 1);
+                    }
+                }
+            };
+            bfs_1(beginRoot, 1);
+        }
+        return maxDepth;
+    };
+    return TreeNode;
+}());
+exports.TreeNode = TreeNode;

package/dist/data-structures/types/heap.d.ts

@@ -1,7 +1,3 @@
 export interface HeapOptions<T> {
     priority?: (element: T) => number;
 }
-export interface HeapItem<T> {
-    priority: number;
-    element: T | null;
-}

package/dist/utils/types/utils.d.ts

@@ -1,9 +1,7 @@
-/**
- * A function that emits a side effect and does not return anything.
- */
 export type ToThunkFn = () => ReturnType<TrlFn>;
 export type Thunk = () => ReturnType<ToThunkFn> & {
     __THUNK__: Symbol;
 };
 export type TrlFn = (...args: any[]) => any;
 export type TrlAsyncFn = (...args: any[]) => any;
+export type SpecifyOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;

package/dist/utils/types/utils.js

@@ -1,16 +1,2 @@
 "use strict";
-// export type JSONSerializable = {
-//     [key: string]: any
-// }
 Object.defineProperty(exports, "__esModule", { value: true });
-// export type CaseType =
-//     'camel'
-//     | 'snake'
-//     | 'pascal'
-//     | 'constant'
-//     | 'kebab'
-//     | 'lower'
-//     | 'title'
-//     | 'sentence'
-//     | 'path'
-//     | 'dot';

package/dist/utils/utils.js

@@ -1,6 +1,4 @@
 "use strict";
-// import _ from 'lodash';
-// import type {AnyFunction, CaseType, JSONObject, JSONSerializable} from './types';
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -71,201 +69,6 @@ var uuidV4 = function () {
     });
 };
 exports.uuidV4 = uuidV4;
-// export const isObject = (object: string | JSONObject | boolean | AnyFunction | number) => object != null && typeof object === 'object';
-// export const deepObjectStrictEqual = (object1: JSONSerializable, object2: JSONSerializable) => {
-//     const keys1 = Object.keys(object1);
-//     const keys2 = Object.keys(object2);
-//     if (keys1.length !== keys2.length) {
-//         return false;
-//     }
-//     for (const key of keys1) {
-//         const val1 = object1[key];
-//         const val2 = object2[key];
-//         const areObjects = isObject(val1) && isObject(val2);
-//         if (
-//             areObjects && !deepObjectStrictEqual(val1, val2) ||
-//             !areObjects && val1 !== val2
-//         ) {
-//             return false;
-//         }
-//     }
-//     return true;
-// };
-// export class StringUtil {
-//     // camelCase
-//     static toCamelCase(str: string) {
-//         return _.camelCase(str);
-//     }
-//
-//     // snake_case
-//     static toSnakeCase(str: string) {
-//         return _.snakeCase(str);
-//     }
-//
-//     // PascalCase
-//     static toPascalCase(str: string) {
-//         return _.startCase(_.camelCase(str)).replace(/ /g, '');
-//     }
-//
-//     // CONSTANT_CASE
-//     static toConstantCase(str: string) {
-//         return _.upperCase(str).replace(/ /g, '_');
-//     }
-//
-//     // kebab-case
-//     static toKebabCase(str: string) {
-//         return _.kebabCase(str);
-//     }
-//
-//     // lowercase
-//     static toLowerCase(str: string) {
-//         return _.lowerCase(str).replace(/ /g, '');
-//     }
-//
-//     // Title Case
-//     static toTitleCase(str: string) {
-//         return _.startCase(_.camelCase(str));
-//     }
-//
-//     // Sentence case
-//     static toSentenceCase(str: string) {
-//         return _.upperFirst(_.lowerCase(str));
-//     }
-//
-//     // path/case
-//     static toPathCase(str: string) {
-//         return _.lowerCase(str).replace(/ /g, '/');
-//     }
-//
-//     // dot.case
-//     static toDotCase(str: string) {
-//         return _.lowerCase(str).replace(/ /g, '.');
-//     }
-// }
-// export const deepKeysConvert = (obj: any, toType?: CaseType): any => {
-//     const _toType = toType || 'snake';
-//     if (Array.isArray(obj)) {
-//         return obj.map(v => deepKeysConvert(v, _toType));
-//     } else if (obj !== null && obj.constructor === Object) {
-//         return Object.keys(obj).reduce(
-//             (result, key) => {
-//                 let newKey = '';
-//                 switch (_toType) {
-//                     case 'camel':
-//                         newKey = StringUtil.toCamelCase(key);
-//                         break;
-//                     case 'snake':
-//                         newKey = StringUtil.toSnakeCase(key);
-//                         break;
-//                     case 'pascal':
-//                         newKey = StringUtil.toPascalCase(key);
-//                         break;
-//                     case 'constant':
-//                         newKey = StringUtil.toConstantCase(key);
-//                         break;
-//                     case 'kebab':
-//                         newKey = StringUtil.toKebabCase(key);
-//                         break;
-//                     case 'lower':
-//                         newKey = StringUtil.toLowerCase(key);
-//                         break;
-//                     case 'title':
-//                         newKey = StringUtil.toTitleCase(key);
-//                         break;
-//                     case 'sentence':
-//                         newKey = StringUtil.toSentenceCase(key);
-//                         break;
-//                     case 'path':
-//                         newKey = StringUtil.toPathCase(key);
-//                         break;
-//                     case 'dot':
-//                         newKey = StringUtil.toDotCase(key);
-//                         break;
-//                     default:
-//                         newKey = StringUtil.toDotCase(key);
-//                         break;
-//                 }
-//                 return {
-//                     ...result,
-//                     [newKey]: deepKeysConvert(obj[key], _toType),
-//                 };
-//             },
-//             {},
-//         );
-//     }
-//     return obj;
-// };
-// export const deepRemoveByKey = (obj: any, keysToBeRemoved: string[]) => {
-//     const result = _.transform(obj, function (result: JSONSerializable, value: any, key: string) {
-//         if (_.isObject(value)) {
-//             value = deepRemoveByKey(value, keysToBeRemoved);
-//         }
-//         if (!keysToBeRemoved.includes(key)) {
-//             _.isArray(obj) ? result.push(value) : result[key] = value;
-//         }
-//     });
-//     return result as typeof obj;
-// };
-// export const deepRenameKeys = (obj: JSONSerializable, keysMap: { [key in string]: string }) => {
-//     return _.transform(obj, function (result: JSONSerializable, value: any, key: string | number) {
-//         const currentKey = keysMap[key] || key;
-//         result[currentKey] = _.isObject(value) ? deepRenameKeys(value, keysMap) : value;
-//     });
-// };
-// export const deepReplaceValues = (obj: JSONSerializable, keyReducerMap: { [key in string]: (item: JSONSerializable) => any }) => {
-//     const newObject = _.clone(obj) as JSONSerializable;
-//     _.each(obj, (val: any, key: string) => {
-//         for (const item in keyReducerMap) {
-//             if (key === item) {
-//                 newObject[key] = keyReducerMap[item](newObject);
-//             } else if (typeof (val) === 'object' || val instanceof Array) {
-//                 newObject[key] = deepReplaceValues(val, keyReducerMap);
-//             }
-//         }
-//     });
-//     return newObject;
-// };
-// TODO determine depth and pass root node as a param through callback
-// export const deepAdd = (obj: JSONSerializable, keyReducerMap: { [key in string]: (item: JSONSerializable) => any }, isItemRootParent?: boolean) => {
-//     const newObject = _.clone(obj) as JSONObject | [];
-//     if (_.isObject(newObject) && !_.isArray(newObject)) {
-//         for (const item in keyReducerMap) {
-//             newObject[item] = keyReducerMap[item](newObject);
-//         }
-//     }
-//     _.each(obj, (val: any, key: string | number) => {
-//         if (_.isObject(val)) {
-//             for (const item in keyReducerMap) {
-//                 // @ts-ignore
-//                 newObject[key] = deepAdd(val, keyReducerMap, isItemRootParent);
-//             }
-//         }
-//     });
-//     return newObject;
-// };
-// const styleString = (color: string) => `color: ${color}; font-weight: bold`;
-// const styleHeader = (header: string) => `%c[${header}]`;
-// export const bunnyConsole = {
-//     log: (headerLog = 'bunny', ...args: any[]) => {
-//         return console.log(styleHeader(headerLog), styleString('black'), ...args);
-//     },
-//     warn: (headerLog = 'bunny', ...args: any[]) => {
-//         return console.warn(styleHeader(headerLog), styleString('orange'), ...args);
-//     },
-//     error: (headerLog = 'bunny', ...args: any[]) => {
-//         return console.error(styleHeader(headerLog), styleString('red'), ...args);
-//     }
-// };
-// export const timeStart = () => {
-//     return performance ? performance.now() : new Date().getTime();
-// };
-// export const timeEnd = (startTime: number, headerLog?: string, consoleConditionFn?: (timeSpent: number) => boolean) => {
-//     const timeSpent = (performance ? performance.now() : new Date().getTime()) - startTime;
-//     const isPassCondition = consoleConditionFn ? consoleConditionFn(timeSpent) : true;
-//     if (isPassCondition) {
-//         bunnyConsole.log(headerLog ? headerLog : 'time spent', timeSpent.toFixed(2));
-//     }
-// };
 var arrayRemove = function (array, predicate) {
     var i = -1, len = array ? array.length : 0;
     var result = [];

package/docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/docs/assets/highlight.css

@@ -0,0 +1,92 @@
+:root {
+    --light-hl-0: #795E26;
+    --dark-hl-0: #DCDCAA;
+    --light-hl-1: #000000;
+    --dark-hl-1: #D4D4D4;
+    --light-hl-2: #A31515;
+    --dark-hl-2: #CE9178;
+    --light-hl-3: #AF00DB;
+    --dark-hl-3: #C586C0;
+    --light-hl-4: #001080;
+    --dark-hl-4: #9CDCFE;
+    --light-hl-5: #0000FF;
+    --dark-hl-5: #569CD6;
+    --light-hl-6: #0070C1;
+    --dark-hl-6: #4FC1FF;
+    --light-hl-7: #098658;
+    --dark-hl-7: #B5CEA8;
+    --light-hl-8: #267F99;
+    --dark-hl-8: #4EC9B0;
+    --light-hl-9: #008000;
+    --dark-hl-9: #6A9955;
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --code-background: var(--dark-code-background);
+}
+
+.hl-0 { color: var(--hl-0); }
+.hl-1 { color: var(--hl-1); }
+.hl-2 { color: var(--hl-2); }
+.hl-3 { color: var(--hl-3); }
+.hl-4 { color: var(--hl-4); }
+.hl-5 { color: var(--hl-5); }
+.hl-6 { color: var(--hl-6); }
+.hl-7 { color: var(--hl-7); }
+.hl-8 { color: var(--hl-8); }
+.hl-9 { color: var(--hl-9); }
+pre, code { background: var(--code-background); }