@douglasneuroinformatics/libjs 0.0.1 → 0.0.3

package/dist/datetime.d.ts

@@ -25,3 +25,4 @@ export declare function yearsPassed(date: Date): number;
  * ```
  */
 export declare function sleep(seconds: number): Promise<unknown>;
+//# sourceMappingURL=datetime.d.ts.map

package/dist/datetime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"datetime.d.ts","sourceRoot":"","sources":["../src/datetime.ts"],"names":[],"mappings":"AAAA;;;;;;;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"}

package/dist/datetime.js

@@ -29,5 +29,5 @@ export function yearsPassed(date) {
  * ```
  */
 export async function sleep(seconds) {
-    return new Promise((resolve) => setTimeout(resolve, seconds / 1000));
+    return new Promise((resolve) => setTimeout(resolve, seconds * 1000));
 }

package/dist/datetime.test.d.ts

@@ -1 +1,2 @@
 export {};
+//# sourceMappingURL=datetime.test.d.ts.map

package/dist/datetime.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"datetime.test.d.ts","sourceRoot":"","sources":["../src/datetime.test.ts"],"names":[],"mappings":""}

package/dist/datetime.test.js

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest';
-import { toBasicISOString, yearsPassed } from './datetime.js';
+import { sleep, toBasicISOString, yearsPassed } from './datetime.js';
 describe('toBasicISOString', () => {
     it('should return a string of the format yyyy-mm-dd', () => {
         expect(toBasicISOString(new Date(2000, 0, 1))).toBe('2000-01-01');
@@ -17,3 +17,11 @@ describe('yearsPassed', () => {
         expect(yearsPassed(date)).toBe(1);
     });
 });
+describe('sleep', () => {
+    it('should wait for at least the specified time', async () => {
+        const start = Date.now();
+        await sleep(0.2);
+        const end = Date.now();
+        expect(end - start).toBeGreaterThanOrEqual(200);
+    });
+});

package/dist/index.d.ts

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

package/dist/index.d.ts.map

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

package/dist/object.d.ts

@@ -2,3 +2,4 @@ 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>;
+//# sourceMappingURL=object.d.ts.map

package/dist/object.d.ts.map

@@ -0,0 +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"}

package/dist/object.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=object.test.d.ts.map

package/dist/object.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.test.d.ts","sourceRoot":"","sources":["../src/object.test.ts"],"names":[],"mappings":""}

package/dist/object.test.js

@@ -0,0 +1,25 @@
+import { describe, expect, it } from 'vitest';
+import { deepFreeze } from './object.js';
+describe('deepFreeze', () => {
+    it('should not allow mutating a primitive value', () => {
+        const obj = deepFreeze({ foo: 1 });
+        expect(() => {
+            // @ts-expect-error - check runtime behavior
+            obj.foo = 2;
+        }).toThrow();
+    });
+    it('should not allow mutating a nested object', () => {
+        const obj = deepFreeze({ foo: { bar: 1 } });
+        expect(() => {
+            // @ts-expect-error - check runtime behavior
+            obj.foo.bar = 2;
+        }).toThrow();
+    });
+    it('should not allow mutating a deeply nested array', () => {
+        const obj = deepFreeze({ foo: { bar: [1, 2, 3] } });
+        expect(() => {
+            // @ts-expect-error - check runtime behavior
+            obj.foo.bar[0] = 2;
+        }).toThrow();
+    });
+});

package/dist/random.d.ts

@@ -4,3 +4,4 @@ export declare function randomInt(min: number, max: number): number;
 export declare function randomDate(start: Date, end: Date): Date;
 /** Returns a random value from the array */
 export declare function randomValue<T>(arr: T[]): T;
+//# sourceMappingURL=random.d.ts.map

package/dist/random.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"random.d.ts","sourceRoot":"","sources":["../src/random.ts"],"names":[],"mappings":"AAAA,mFAAmF;AACnF,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,UAKjD;AAED,uEAAuE;AACvE,wBAAgB,UAAU,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,QAKhD;AAED,4CAA4C;AAC5C,wBAAgB,WAAW,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAKtC"}

package/dist/random.test.d.ts

@@ -1 +1,2 @@
 export {};
+//# sourceMappingURL=random.test.d.ts.map

package/dist/random.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"random.test.d.ts","sourceRoot":"","sources":["../src/random.test.ts"],"names":[],"mappings":""}

package/dist/random.test.js

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest';
-import { randomDate, randomInt } from './random.js';
+import { randomDate, randomInt, randomValue } from './random.js';
 describe('randomInt', () => {
     it('should return an integer value within the range', () => {
         const min = 5;
@@ -37,3 +37,17 @@ describe('randomDate', () => {
         expect(() => randomDate(new Date(), new Date(2000, 0, 1))).toThrow();
     });
 });
+describe('randomValue', () => {
+    it('should throw if given an empty array', () => {
+        expect(() => randomValue([])).toThrow();
+    });
+    it('should return a value in the array', () => {
+        const arr = [-10, -20, -30];
+        expect(arr.includes(randomValue(arr)));
+    });
+    it('should not mutate the array', () => {
+        const arr = [-10, -20, -30];
+        randomValue(arr);
+        expect(arr).toMatchObject([-10, -20, -30]);
+    });
+});

package/dist/range.d.ts

@@ -2,3 +2,4 @@
 export declare function range(end: number): readonly number[];
 /** Return an array of integers between `start` (inclusive) and `end` (not inclusive) */
 export declare function range(start: number, end: number): readonly number[];
+//# sourceMappingURL=range.d.ts.map

package/dist/range.d.ts.map

@@ -0,0 +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"}

package/dist/range.test.d.ts

@@ -1 +1,2 @@
 export {};
+//# sourceMappingURL=range.test.d.ts.map

package/dist/range.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"range.test.d.ts","sourceRoot":"","sources":["../src/range.test.ts"],"names":[],"mappings":""}

package/dist/range.test.js

@@ -5,4 +5,7 @@ describe('range', () => {
         const arr = range(10);
         expect(arr.length).toBe(10);
     });
+    it('should throw an error if the start is equal to the end', () => {
+        expect(() => range(1, 1)).toThrow();
+    });
 });

package/dist/string.d.ts

@@ -1,3 +1,6 @@
 import type { CamelCase, SnakeCase } from 'type-fest';
 export declare function camelToSnakeCase<T extends string>(s: T): SnakeCase<T>;
 export declare function snakeToCamelCase<T extends string>(s: T): CamelCase<T>;
+export declare function uncapitalize<T extends string>(s: T): Uncapitalize<T>;
+export declare function capitalize<T extends string>(s: T): Capitalize<T>;
+//# sourceMappingURL=string.d.ts.map

package/dist/string.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../src/string.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtD,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"}

package/dist/string.js

@@ -6,3 +6,9 @@ export function snakeToCamelCase(s) {
         .toLowerCase()
         .replace(/([-_][a-z])/g, (group) => group.toUpperCase().replace('-', '').replace('_', ''));
 }
+export function uncapitalize(s) {
+    return (s.charAt(0).toLowerCase() + s.slice(1));
+}
+export function capitalize(s) {
+    return (s.charAt(0).toUpperCase() + s.slice(1));
+}

package/dist/string.test.d.ts

@@ -1 +1,2 @@
 export {};
+//# sourceMappingURL=string.test.d.ts.map

package/dist/string.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.test.d.ts","sourceRoot":"","sources":["../src/string.test.ts"],"names":[],"mappings":""}

package/dist/string.test.js

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest';
-import { camelToSnakeCase, snakeToCamelCase } from './string.js';
+import { camelToSnakeCase, capitalize, snakeToCamelCase, uncapitalize } from './string.js';
 describe('camelToSnakeCase', () => {
     it('should convert from camel to snake case ', () => {
         expect(camelToSnakeCase('toSnakeCase')).toBe('to_snake_case');
@@ -14,3 +14,17 @@ describe('snakeToCamelCase', () => {
         expect(camelToSnakeCase('')).toBe('');
     });
 });
+describe('capitalize', () => {
+    it('should convert the first letter of the string to a capital letter', () => {
+        expect(capitalize('foo')).toBe('Foo');
+        expect(capitalize('FOO')).toBe('FOO');
+        expect(capitalize('foo bar')).toBe('Foo bar');
+    });
+});
+describe('uncapitalize', () => {
+    it('should convert the first letter of the string to a lowercase letter', () => {
+        expect(uncapitalize('Foo')).toBe('foo');
+        expect(uncapitalize('foo')).toBe('foo');
+        expect(uncapitalize('Foo bar')).toBe('foo bar');
+    });
+});

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "@douglasneuroinformatics/libjs",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "packageManager": "pnpm@8.15.3",
   "description": "A collection of utility functions and types for Node.js and the browser",
+  "author": {
+    "name": "Douglas Neuroinformatics",
+    "email": "support@douglasneuroinformatics.ca"
+  },
   "license": "LGPL-3.0",
   "homepage": "https://github.com/DouglasNeuroInformatics/libjs/#readme",
   "repository": {
@@ -28,6 +32,7 @@
     "@douglasneuroinformatics/eslint-config": "^4.0.0",
     "@vitest/coverage-v8": "^1.3.1",
     "eslint": "^8.57.0",
+    "husky": "^9.0.11",
     "prettier": "^3.2.5",
     "typedoc": "^0.25.2",
     "typescript": "~5.3.3",