@douglasneuroinformatics/libjs 1.0.2 → 1.2.0

package/dist/datetime.d.ts

@@ -7,6 +7,16 @@ export type Duration = {
 };
 /** A map that associates time units with their corresponding values in milliseconds */
 export declare const TIME_MAP: Map<"day" | "hour" | "minute" | "second" | "millisecond", number>;
+/**
+ * Converts a given Date object to an ISO 8601 string that represents the local time.
+ *
+ * The function adjusts the input date by accounting for the local timezone offset so
+ * the resulting ISO string reflects the local time rather than UTC.
+ *
+ * @param date - The Date object to be converted.
+ * @returns An ISO 8601 formatted string representing the local time.
+ */
+export declare function toLocalISOString(date: Date): string;
 /**
  * Returns the data in basic ISO format, e.g., yyyy-mm-dd
  * @example

package/dist/datetime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"datetime.d.ts","sourceRoot":"","sources":["../src/datetime.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,uFAAuF;AACvF,eAAO,MAAM,QAAQ,mEAMV,CAAC;AAEZ;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEnD;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAE9C;AAED;;;;;;GAMG;AACH,wBAAsB,KAAK,CAAC,OAAO,EAAE,MAAM,oBAE1C;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,QAAQ,CAY5D"}
+{"version":3,"file":"datetime.d.ts","sourceRoot":"","sources":["../src/datetime.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,uFAAuF;AACvF,eAAO,MAAM,QAAQ,mEAMV,CAAC;AAEZ;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,IAAI,UAE1C;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEnD;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAE9C;AAED;;;;;;GAMG;AACH,wBAAsB,KAAK,CAAC,OAAO,EAAE,MAAM,oBAE1C;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,QAAQ,CAY5D"}

package/dist/datetime.js

@@ -6,6 +6,18 @@ export const TIME_MAP = new Map([
     ['second', 1000],
     ['millisecond', 1]
 ]);
+/**
+ * Converts a given Date object to an ISO 8601 string that represents the local time.
+ *
+ * The function adjusts the input date by accounting for the local timezone offset so
+ * the resulting ISO string reflects the local time rather than UTC.
+ *
+ * @param date - The Date object to be converted.
+ * @returns An ISO 8601 formatted string representing the local time.
+ */
+export function toLocalISOString(date) {
+    return new Date(date.getTime() - date.getTimezoneOffset() * 60000).toISOString().slice(0, -1);
+}
 /**
  * Returns the data in basic ISO format, e.g., yyyy-mm-dd
  * @example

package/dist/datetime.test.js

@@ -1,5 +1,30 @@
-import { describe, expect, it } from 'vitest';
-import { parseDuration, sleep, toBasicISOString, yearsPassed } from './datetime.js';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import { parseDuration, sleep, toBasicISOString, toLocalISOString, yearsPassed } from './datetime.js';
+describe('toLocalISOString', () => {
+    let getTimezoneOffset;
+    beforeEach(() => {
+        getTimezoneOffset = vi.spyOn(Date.prototype, 'getTimezoneOffset');
+    });
+    afterEach(() => {
+        vi.clearAllMocks();
+    });
+    it('should return the correct string when the current timezone is is UTC+00:00', () => {
+        getTimezoneOffset.mockReturnValueOnce(0);
+        expect(toLocalISOString(new Date('2025-01-01T00:00:00.000Z'))).toBe('2025-01-01T00:00:00.000');
+    });
+    it('should return the correct string when the current timezone is UTC-05:00', () => {
+        getTimezoneOffset.mockReturnValueOnce(300);
+        expect(toLocalISOString(new Date('2025-01-01T05:00:00.000Z'))).toBe('2025-01-01T00:00:00.000');
+    });
+    it('should return the correct string when the current timezone is UTC-08:00', () => {
+        getTimezoneOffset.mockReturnValueOnce(480);
+        expect(toLocalISOString(new Date('2025-01-01T05:00:00.000Z'))).toBe('2024-12-31T21:00:00.000');
+    });
+    it('should return the correct string when the current timezone is UTC+03:00', () => {
+        getTimezoneOffset.mockReturnValueOnce(-180);
+        expect(toLocalISOString(new Date('2025-01-01T05:00:00.000Z'))).toBe('2025-01-01T08:00:00.000');
+    });
+});
 describe('toBasicISOString', () => {
     it('should return a string of the format yyyy-mm-dd', () => {
         expect(toBasicISOString(new Date(2000, 0, 1))).toBe('2000-01-01');

package/dist/object.d.ts

@@ -21,4 +21,7 @@ export declare function isObjectLike(value: unknown): value is object;
 export declare function isPlainObject(value: unknown): value is {
     [key: string]: unknown;
 };
+export declare function isAllUndefined<T extends {
+    [key: string]: unknown;
+}>(obj: T): boolean;
 //# sourceMappingURL=object.d.ts.map

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,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"}
+{"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;AAED,wBAAgB,cAAc,CAAC,CAAC,SAAS;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,EAAE,GAAG,EAAE,CAAC,WAE1E"}

package/dist/object.js

@@ -35,3 +35,6 @@ export function isPlainObject(value) {
         !(Symbol.toStringTag in value) &&
         !(Symbol.iterator in value));
 }
+export function isAllUndefined(obj) {
+    return Object.values(obj).every((value) => value === undefined);
+}

package/dist/object.test.js

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest';
-import { deepFreeze, isObject, isObjectLike, isPlainObject } from './object.js';
+import { deepFreeze, isAllUndefined, isObject, isObjectLike, isPlainObject } from './object.js';
 describe('deepFreeze', () => {
     it('should not allow mutating a primitive value', () => {
         const obj = deepFreeze({ foo: 1 });
@@ -71,3 +71,14 @@ describe('isPlainObject', () => {
         expect(isPlainObject(() => null)).toBe(false);
     });
 });
+describe('isAllUndefined', () => {
+    it('should return true for an empty object', () => {
+        expect(isAllUndefined({})).toBe(true);
+    });
+    it('should return true for an object with an undefined property', () => {
+        expect(isAllUndefined({ foo: undefined })).toBe(true);
+    });
+    it('should return true for an object with a defined property', () => {
+        expect(isAllUndefined({ bar: null, foo: undefined })).toBe(false);
+    });
+});

package/dist/range.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"range.d.ts","sourceRoot":"","sources":["../src/range.ts"],"names":[],"mappings":"AAEA,kFAAkF;AAClF,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,CAAC;AAEtD,wFAAwF;AACxF,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,CAAC"}
+{"version":3,"file":"range.d.ts","sourceRoot":"","sources":["../src/range.ts"],"names":[],"mappings":"AAAA,kFAAkF;AAClF,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,CAAC;AAEtD,wFAAwF;AACxF,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,CAAC"}

package/dist/range.js

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/unified-signatures */
 export function range(...args) {
     const start = args.length === 2 ? args[0] : 0;
     const end = args.length === 2 ? args[1] : args[0];

package/dist/string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../src/string.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEjE,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,gBAEtD;AAED,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,gBAItD;AAED,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,mBAElD;AAED,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,iBAEhD;AAED,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,gBAEjD;AAED,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,gBAEjD;AAED,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,UAKtE"}
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../src/string.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEjE,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,GACiB,SAAS,CAAC,CAAC,CAAC,CACnF;AAED,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,GAG2C,SAAS,CAAC,CAAC,CAAC,CAC7G;AAED,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,GACE,YAAY,CAAC,CAAC,CAAC,CACnE;AAED,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,GACI,UAAU,CAAC,CAAC,CAAC,CACjE;AAED,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,GACtB,SAAS,CAAC,CAAC,CAAC,CACvC;AAED,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,GACtB,SAAS,CAAC,CAAC,CAAC,CACvC;AAED,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,UAKtE"}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@douglasneuroinformatics/libjs",
   "type": "module",
-  "version": "1.0.2",
-  "packageManager": "pnpm@9.11.0",
+  "version": "1.2.0",
+  "packageManager": "pnpm@9.15.1",
   "description": "A collection of utility functions and types for Node.js and the browser",
   "author": "Joshua Unrau",
   "license": "Apache-2.0",
@@ -29,25 +29,25 @@
     "test:coverage": "vitest run --coverage"
   },
   "peerDependencies": {
-    "typescript": "^5.1.0"
+    "typescript": "^5.5.0"
   },
   "dependencies": {
-    "type-fest": "^4.15.0"
+    "type-fest": "^4.30.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "^19.3.0",
-    "@commitlint/config-conventional": "^19.2.2",
-    "@douglasneuroinformatics/eslint-config": "^4.2.1",
+    "@commitlint/cli": "^19.6.1",
+    "@commitlint/config-conventional": "^19.6.0",
+    "@douglasneuroinformatics/eslint-config": "^5.2.4",
     "@douglasneuroinformatics/prettier-config": "^0.0.1",
     "@douglasneuroinformatics/semantic-release": "^0.0.1",
-    "@douglasneuroinformatics/tsconfig": "^1.0.1",
-    "@vitest/coverage-v8": "^1.4.0",
-    "eslint": "^8.57.0",
-    "husky": "^9.0.11",
-    "prettier": "^3.2.5",
-    "typedoc": "^0.25.13",
-    "typescript": "~5.4.5",
-    "vitest": "^1.4.0"
+    "@douglasneuroinformatics/tsconfig": "^1.0.2",
+    "@vitest/coverage-v8": "^2.1.8",
+    "eslint": "^9.17.0",
+    "husky": "^9.1.7",
+    "prettier": "^3.4.2",
+    "typedoc": "^0.27.5",
+    "typescript": "5.5.x",
+    "vitest": "^2.1.8"
   },
   "commitlint": {
     "extends": [