@douglasneuroinformatics/libjs 0.2.0 → 0.3.1

package/dist/index.d.ts

@@ -4,4 +4,5 @@ export * from './object.js';
 export * from './random.js';
 export * from './range.js';
 export * from './string.js';
+export * from './types.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC"}

package/dist/index.js

@@ -4,3 +4,4 @@ export * from './object.js';
 export * from './random.js';
 export * from './range.js';
 export * from './string.js';
+export * from './types.js';

package/dist/object.d.ts

@@ -1,7 +1,9 @@
 export type ReadonlyDeep<T extends object> = Readonly<{
     [K in keyof T]: T[K] extends object ? ReadonlyDeep<T[K]> : T[K];
 }>;
-export declare function deepFreeze<T extends object>(obj: T): ReadonlyDeep<T>;
+export declare function deepFreeze<T extends object, TReadonly extends boolean = true>(obj: T, options?: {
+    readonlyType: TReadonly;
+}): TReadonly extends true ? ReadonlyDeep<T> : T;
 /**
  * Checks if `value` is the [language type](http://www.ecma-international.org/ecma-262/7.0/#sec-ecmascript-language-types)
  * of `Object`. (e.g. arrays, functions, objects, regexes, `new Number(0)`, and `new String('')`)

package/dist/object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,IAAI,QAAQ,CAAC;KACnD,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAChE,CAAC,CAAC;AAEH,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAQpE;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAGxD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAE5D;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAUjF"}
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,IAAI,QAAQ,CAAC;KACnD,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAChE,CAAC,CAAC;AAEH,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,SAAS,OAAO,GAAG,IAAI,EAC3E,GAAG,EAAE,CAAC,EACN,OAAO,CAAC,EAAE;IAAE,YAAY,EAAE,SAAS,CAAA;CAAE,GACpC,SAAS,SAAS,IAAI,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAQ9C;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAGxD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAE5D;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAUjF"}

package/dist/object.js

@@ -1,8 +1,8 @@
-export function deepFreeze(obj) {
+export function deepFreeze(obj, options) {
     Object.keys(obj).forEach((key) => {
         const value = obj[key];
         if (value && typeof value === 'object') {
-            deepFreeze(value);
+            deepFreeze(value, options);
         }
     });
     return Object.freeze(obj);

package/dist/types.d.ts

@@ -0,0 +1,19 @@
+import type { IfNever } from 'type-fest';
+/**
+ * Return whether `T` or any record nested therein contains the key `K`
+ *
+ * @example
+ * HasNestedKey<{ a: string; b: { c: { d: number }[] } }, 'a'>; // true
+ * HasNestedKey<{ a: string; b: { c: { d: number }[] } }, 'b'>; // true
+ * HasNestedKey<{ a: string; b: { c: { d: number }[] } }, 'c'>; // true
+ * HasNestedKey<{ a: string; b: { c: { d: number }[] } }, 'd'>; // true
+ * HasNestedKey<{ a: string; b: { c: { d: number }[] } }, 'e'>; // false
+ * HasNestedKey<{ a: string; b: { c: { d: number }[] } }, 'd' | 'e'>; // true
+ * HasNestedKey<{ a: string; b: { c: { d: number }[] } }, string>; // true
+ */
+export type HasNestedKey<T, P extends string> = T extends {
+    [key: string]: unknown;
+} ? IfNever<keyof {
+    [K in keyof T as K extends P ? K : HasNestedKey<T[K], P> extends true ? K : never]: never;
+}, false, true> : T extends (infer U)[] ? HasNestedKey<U, P> : false;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,GAChF,OAAO,CACL,MAAM;KACH,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,GAAG,KAAK;CAC1F,EACD,KAAK,EACL,IAAI,CACL,GACD,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GACnB,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAClB,KAAK,CAAC"}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@douglasneuroinformatics/libjs",
   "type": "module",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "packageManager": "pnpm@8.15.3",
   "description": "A collection of utility functions and types for Node.js and the browser",
   "author": {
@@ -22,20 +22,11 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "tsc",
-    "build:docs": "typedoc",
-    "format": "prettier --write src",
-    "lint": "tsc --noEmit && eslint --fix src",
-    "prepare": "husky",
-    "test": "vitest run",
-    "test:coverage": "vitest run --coverage"
-  },
   "peerDependencies": {
     "typescript": "^5.1.0"
   },
   "dependencies": {
-    "type-fest": "^4.11.1"
+    "type-fest": "^4.15.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.2.1",
@@ -45,13 +36,21 @@
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/npm": "^12.0.0",
-    "@vitest/coverage-v8": "^1.3.1",
+    "@vitest/coverage-v8": "^1.4.0",
     "eslint": "^8.57.0",
     "husky": "^9.0.11",
     "prettier": "^3.2.5",
-    "semantic-release": "^23.0.5",
-    "typedoc": "^0.25.2",
-    "typescript": "~5.3.3",
-    "vitest": "^1.3.1"
+    "semantic-release": "^23.0.8",
+    "typedoc": "^0.25.13",
+    "typescript": "~5.4.5",
+    "vitest": "^1.4.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "build:docs": "typedoc",
+    "format": "prettier --write src",
+    "lint": "tsc --noEmit && eslint --fix src",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage"
   }
-}
+}