Merge in development state

Author: mfederczuk

.mocharc.json

@@ -1,4 +1,5 @@
 {
 	"extension": ["ts"],
-	"require": "ts-node/register"
+	"require": "ts-node/register",
+	"use_strict": true
 }

CHANGELOG.md

@@ -1,5 +1,5 @@
 <!--
-  Copyright (c) 2022 Michael Federczuk
+  Copyright (c) 2023 Michael Federczuk
   SPDX-License-Identifier: CC-BY-SA-4.0
 -->
 
@@ -11,6 +11,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [**Keep a Changelog v1.0.0**](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [**Semantic Versioning v2.0.0**](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased ##
+
+Minor internal improvements.
+
+### Security ###
+
+* Update dependencies
+
 ## [v2.0.0-indev02] - 2023-01-27 ##
 
 [v2.0.0-indev02]: https://github.com/mfederczuk/deeptools/releases/v2.0.0-indev02

package-lock.json

@@ -4,8 +4,14 @@
 	"description": "A set of utility functions that recursively operate on objects",
 	"keywords": [
 		"deep",
+		"clone",
 		"copy",
-		"freeze"
+		"freeze",
+		"deepclone",
+		"deepcopy",
+		"deepequal",
+		"deepequals",
+		"deepfreeze"
 	],
 	"homepage": "https://github.com/mfederczuk/deeptools#readme",
 	"bugs": {
@@ -26,9 +32,6 @@
 	],
 	"main": "out/index.js",
 	"types": "types/index.d.ts",
-	"directories": {
-		"lib": "out"
-	},
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/mfederczuk/deeptools.git"
@@ -55,7 +58,7 @@
 		"@types/node": "^18.11.18",
 		"@typescript-eslint/eslint-plugin": "^5.49.0",
 		"@typescript-eslint/parser": "^5.49.0",
-		"eslint": "^8.32.0",
+		"eslint": "^8.33.0",
 		"mocha": "^10.2.0",
 		"npm-check-updates": "^16.6.3",
 		"ts-node": "^10.9.1",

package.json

@@ -1,9 +1,9 @@
 /*
- * Copyright (c) 2022 Michael Federczuk
+ * Copyright (c) 2023 Michael Federczuk
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-import { GenericKey } from "../types";
+import type { GenericKey } from "../types";
 
 export type NonEmptyArray<T> = ([T, ...T[]] | [...T[], T]);
 

src/_internal/utils.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 Michael Federczuk
+ * Copyright (c) 2023 Michael Federczuk
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
@@ -82,7 +82,6 @@ const initCopy = (obj: NonNullable<object>): NonNullable<object> => {
 
 	return Object.create(obj);
 };
-
 deepFreeze(initCopy);
 
 /**
@@ -92,7 +91,7 @@ deepFreeze(initCopy);
  *
  * @returns A deep copy of **obj**.
  */
-function deepCopy<T>(obj: T): T {
+export function deepCopy<T>(obj: T): T {
 	if (!(canValueHaveProperties(obj))) {
 		return obj;
 	}
@@ -124,7 +123,4 @@ function deepCopy<T>(obj: T): T {
 
 	return (copy as T);
 }
-
 deepFreeze(deepCopy);
-
-export { deepCopy };

src/deepCopy.ts

@@ -1,10 +1,10 @@
 /*
- * Copyright (c) 2022 Michael Federczuk
+ * Copyright (c) 2023 Michael Federczuk
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
 import { deepFreeze } from "./deepFreeze";
-import { GenericKey } from "./types";
+import type { GenericKey } from "./types";
 import { canValueHaveProperties, getPropertyKeys } from "./_internal/utils";
 
 export type DeepEqualsOptions = {
@@ -25,7 +25,7 @@ export type DeepEqualsOptions = {
  *
  * @returns `true` if **obj1** and **obj2** are deeply equal, `false` if otherwise.
  */
-function deepEquals(
+export function deepEquals(
 	obj1: unknown,
 	obj2: unknown,
 	options?: Readonly<DeepEqualsOptions>,
@@ -88,7 +88,7 @@ function deepEquals(
 		}
 
 		if ((obj1PropDescriptor.get !== obj2PropDescriptor.get) ||
-			(obj1PropDescriptor.set !== obj2PropDescriptor.set)) {
+		    (obj1PropDescriptor.set !== obj2PropDescriptor.set)) {
 
 			return false;
 		}
@@ -98,5 +98,3 @@ function deepEquals(
 }
 
 deepFreeze(deepEquals);
-
-export { deepEquals };

src/deepEquals.ts

@@ -1,9 +1,9 @@
 /*
- * Copyright (c) 2022 Michael Federczuk
+ * Copyright (c) 2023 Michael Federczuk
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-import { GenericKey } from "./types";
+import type { GenericKey } from "./types";
 import { canValueHaveProperties, getPropertyKeys } from "./_internal/utils";
 
 const deepFreezeKeysOfObject = (obj: Record<GenericKey, unknown>, keys: readonly GenericKey[]) => {
@@ -15,7 +15,6 @@ const deepFreezeKeysOfObject = (obj: Record<GenericKey, unknown>, keys: readonly
 		deepFreeze(descriptor.value);
 	}
 };
-
 deepFreeze(deepFreezeKeysOfObject);
 
 const deepFreezePrototypeExcludingConstructor = (prototype: Record<GenericKey, unknown>) => {
@@ -24,7 +23,6 @@ const deepFreezePrototypeExcludingConstructor = (prototype: Record<GenericKey, u
 
 	deepFreezeKeysOfObject(prototype, keys);
 };
-
 deepFreeze(deepFreezePrototypeExcludingConstructor);
 
 // eslint-disable-next-line @typescript-eslint/ban-types
@@ -40,9 +38,9 @@ const deepFreezeFunctionWithPrototype = <F extends Function>(func: F): Readonly<
 
 	return Object.freeze(func);
 };
-
 deepFreeze(deepFreezeFunctionWithPrototype);
 
+
 /**
  * Recursively freezes **arr** and all of its items & other properties.
  *

src/deepFreeze.ts

@@ -1,10 +1,10 @@
 /*
- * Copyright (c) 2022 Michael Federczuk
+ * Copyright (c) 2023 Michael Federczuk
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
 import { deepFreeze } from "./deepFreeze";
-import { GenericKey } from "./types";
+import type { GenericKey } from "./types";
 import { canValueHaveProperties, getPropertyKeys, NonEmptyArray } from "./_internal/utils";
 
 export type KeyPath = NonEmptyArray<GenericKey>;
@@ -65,24 +65,22 @@ const deepWalkInternal = (
 		}
 	}
 };
-
 deepFreeze(deepWalkInternal);
 
 /**
  * Recursively walks through **obj**.
  *
+ * ### This is an experimental function, use with caution. ###
+ *
  * @param obj The object to walk through.
  * @param visitorFunc The visitor callback function to call on every property.
  * @param options Options object to change the behavior of `deepWalk`.
  */
-function deepWalk(
+export function deepWalk(
 	obj: unknown,
 	visitorFunc: PropertyVisitorFunc,
 	options?: Readonly<DeepWalkOptions>,
 ) {
 	return deepWalkInternal([], obj, visitorFunc, options, obj);
 }
-
 deepFreeze(deepWalk);
-
-export { deepWalk };

src/deepWalk.ts

@@ -12,6 +12,9 @@ import { deepFreeze } from "./deepFreeze";
  * @param arr The 3-dimensional array to create a deeply frozen copy of.
  *
  * @returns A deeply frozen copy of **arr**.
+ *
+ * @see {@link deepCopy}
+ * @see {@link deepFreeze}
  */
 function safeCopy<T>(arr: readonly (readonly (readonly T[])[])[]): readonly (readonly (readonly Readonly<T>[])[])[];
 
@@ -21,6 +24,9 @@ function safeCopy<T>(arr: readonly (readonly (readonly T[])[])[]): readonly (rea
  * @param arr The 2-dimensional array to create a deeply frozen copy of.
  *
  * @returns A deeply frozen copy of **arr**.
+ *
+ * @see {@link deepCopy}
+ * @see {@link deepFreeze}
  */
 function safeCopy<T>(arr: readonly (readonly T[])[]): readonly (readonly Readonly<T>[])[];
 
@@ -30,6 +36,9 @@ function safeCopy<T>(arr: readonly (readonly T[])[]): readonly (readonly Readonl
  * @param arr The 1-dimensional array to create a deeply frozen copy of.
  *
  * @returns A deeply frozen copy of **arr**.
+ *
+ * @see {@link deepCopy}
+ * @see {@link deepFreeze}
  */
 function safeCopy<T>(arr: readonly T[]): readonly Readonly<T>[];
 
@@ -39,6 +48,9 @@ function safeCopy<T>(arr: readonly T[]): readonly Readonly<T>[];
  * @param obj The object to create a deeply frozen copy of.
  *
  * @returns A deeply frozen copy of **obj**.
+ *
+ * @see {@link deepCopy}
+ * @see {@link deepFreeze}
  */
 function safeCopy<T>(obj: T): Readonly<T>;