@douglasneuroinformatics/libjs 0.0.1

package/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -0,0 +1,49 @@
+<!-- PROJECT LOGO -->
+<div align="center">
+  <a href="https://github.com/DouglasNeuroInformatics/libjs">
+    <img src="https://raw.githubusercontent.com/DouglasNeuroInformatics/libjs/main/.github/assets/libjs-logo.png" alt="Logo" width="100" >
+  </a>
+  <h3 align="center">@douglasneuroinformatics/libjs</h3>
+  <p align="center">
+    A collection of utility functions and types for Node.js and the browser
+    <br />
+    <a href="https://douglasneuroinformatics.github.io/libjs/">
+      <strong>Explore the docs »
+      </strong>
+    </a>
+    <br />
+    <br />
+    <a href="https://github.com/DouglasNeuroInformatics/libjs/issues" rel="noreferrer" target="_blank">Report Bug</a>
+    ·
+    <a href="https://github.com/DouglasNeuroInformatics/libjs/issues" rel="noreferrer" target="_blank">Request Feature</a>
+  </p>
+</div>
+
+<!-- PROJECT SHIELDS -->
+<div align="center">
+
+![license](https://img.shields.io/github/license/DouglasNeuroInformatics/libjs)
+![version](https://img.shields.io/github/package-json/v/DouglasNeuroInformatics/libjs)
+[![codecov](https://codecov.io/gh/DouglasNeuroInformatics/libjs/graph/badge.svg?token=J9XY9jkGs1)](https://codecov.io/gh/DouglasNeuroInformatics/libjs)
+
+</div>
+<hr />
+
+## Installation
+
+```sh
+pnpm install @douglasneuroinformatics/libjs
+```
+
+## Contributing
+
+We welcome contributions! If you're interested in improving the library or adding new features, please refer to our contribution guide.
+
+## License
+
+Copyright (C) 2024 Douglas Neuroinformatics Platform
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.

package/dist/datetime.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Returns the data in basic ISO format, e.g., yyyy-mm-dd
+ * @example
+ * ```ts
+ * // returns '2000-01-01'
+ * toBasicISOString(new Date(2000, 0, 1))
+ * ```
+ */
+export declare function toBasicISOString(date: Date): string;
+/**
+ * Returns the number of years since `date`, rounded down
+ * @example
+ * ```ts
+ * const today = new Date();
+ * const date = new Date(today.setMonth(today.getMonth() - 18));
+ * yearsPassed(date); // 1
+ * ```
+ */
+export declare function yearsPassed(date: Date): number;
+/**
+ * Pause the flow of execution in an async function
+ *  * @example
+ * ```ts
+ * await sleep(5);
+ * ```
+ */
+export declare function sleep(seconds: number): Promise<unknown>;

package/dist/datetime.js

@@ -0,0 +1,33 @@
+/**
+ * Returns the data in basic ISO format, e.g., yyyy-mm-dd
+ * @example
+ * ```ts
+ * // returns '2000-01-01'
+ * toBasicISOString(new Date(2000, 0, 1))
+ * ```
+ */
+export function toBasicISOString(date) {
+    return date.toISOString().split('T')[0];
+}
+/**
+ * Returns the number of years since `date`, rounded down
+ * @example
+ * ```ts
+ * const today = new Date();
+ * const date = new Date(today.setMonth(today.getMonth() - 18));
+ * yearsPassed(date); // 1
+ * ```
+ */
+export function yearsPassed(date) {
+    return new Date(Date.now() - date.getTime()).getFullYear() - 1970;
+}
+/**
+ * Pause the flow of execution in an async function
+ *  * @example
+ * ```ts
+ * await sleep(5);
+ * ```
+ */
+export async function sleep(seconds) {
+    return new Promise((resolve) => setTimeout(resolve, seconds / 1000));
+}

package/dist/datetime.test.d.ts

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

package/dist/datetime.test.js

@@ -0,0 +1,19 @@
+import { describe, expect, it } from 'vitest';
+import { 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');
+    });
+});
+describe('yearsPassed', () => {
+    it('should return zero for the date eleven months ago', () => {
+        const today = new Date();
+        const date = new Date(today.setMonth(today.getMonth() - 11));
+        expect(yearsPassed(date)).toBe(0);
+    });
+    it('should return one for the date eighteen months ago', () => {
+        const today = new Date();
+        const date = new Date(today.setMonth(today.getMonth() - 18));
+        expect(yearsPassed(date)).toBe(1);
+    });
+});

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './datetime.js';
+export * from './object.js';
+export * from './random.js';
+export * from './range.js';
+export * from './string.js';

package/dist/index.js

@@ -0,0 +1,5 @@
+export * from './datetime.js';
+export * from './object.js';
+export * from './random.js';
+export * from './range.js';
+export * from './string.js';

package/dist/object.d.ts

@@ -0,0 +1,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>;

package/dist/object.js

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

package/dist/random.d.ts

@@ -0,0 +1,6 @@
+/** Returns a random integer between `min` (inclusive) and `max` (not inclusive) */
+export declare function randomInt(min: number, max: number): number;
+/** Returns a random date between `start` and `end` (both inclusive) */
+export declare function randomDate(start: Date, end: Date): Date;
+/** Returns a random value from the array */
+export declare function randomValue<T>(arr: T[]): T;

package/dist/random.js

@@ -0,0 +1,21 @@
+/** Returns a random integer between `min` (inclusive) and `max` (not inclusive) */
+export function randomInt(min, max) {
+    if (min >= max) {
+        throw new Error(`Min value '${min}' must not be greater than or equal to the max value '${max}'`);
+    }
+    return Math.floor(Math.random() * (max - min)) + min;
+}
+/** Returns a random date between `start` and `end` (both inclusive) */
+export function randomDate(start, end) {
+    if (start > end) {
+        throw new Error(`Start date '${start.toISOString()}' cannot be greater than end date '${end.toISOString()}'`);
+    }
+    return new Date(start.getTime() + Math.random() * (end.getTime() - start.getTime()));
+}
+/** Returns a random value from the array */
+export function randomValue(arr) {
+    if (arr.length === 0) {
+        throw new Error('Cannot select random value from array of length zero');
+    }
+    return arr[randomInt(0, arr.length)];
+}

package/dist/random.test.d.ts

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

package/dist/random.test.js

@@ -0,0 +1,39 @@
+import { describe, expect, it } from 'vitest';
+import { randomDate, randomInt } from './random.js';
+describe('randomInt', () => {
+    it('should return an integer value within the range', () => {
+        const min = 5;
+        const max = 8;
+        const result = randomInt(min, max);
+        expect(result).toBeGreaterThanOrEqual(min);
+        expect(result).toBeLessThan(8);
+        expect(Number.isInteger(result)).toBe(true);
+    });
+    it('should throw if the min value is larger than the max', () => {
+        expect(() => randomInt(10, 5)).toThrow();
+    });
+    it('should throw if the min value equals the max', () => {
+        expect(() => randomInt(10, 10)).toThrow();
+    });
+    it('should handle negative values', () => {
+        const min = -5;
+        const max = -3;
+        const result = randomInt(min, max);
+        expect(result).toBeGreaterThanOrEqual(min);
+        expect(result).toBeLessThan(8);
+        expect(Number.isInteger(result)).toBe(true);
+        expect(() => randomInt(max, min)).toThrow();
+    });
+});
+describe('randomDate', () => {
+    it('should return a date within the range', () => {
+        const start = new Date(2000, 0, 1);
+        const end = new Date();
+        const random = randomDate(start, end);
+        expect(random.getTime() >= start.getTime()).toBe(true);
+        expect(random.getTime() <= end.getTime()).toBe(true);
+    });
+    it('should throw if the end is before the start', () => {
+        expect(() => randomDate(new Date(), new Date(2000, 0, 1))).toThrow();
+    });
+});

package/dist/range.d.ts

@@ -0,0 +1,4 @@
+/** Return an array of integers between 0 (inclusive) and `end` (not inclusive) */
+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[];

package/dist/range.js

@@ -0,0 +1,13 @@
+/* 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];
+    if (start >= end) {
+        throw new Error(`End of range '${end}' must be greater than start '${start}'`);
+    }
+    const values = [];
+    for (let i = start; i < end; i++) {
+        values.push(i);
+    }
+    return values;
+}

package/dist/range.test.d.ts

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

package/dist/range.test.js

@@ -0,0 +1,8 @@
+import { describe, expect, it } from 'vitest';
+import { range } from './range.js';
+describe('range', () => {
+    it('should return an array equal in length to the range', () => {
+        const arr = range(10);
+        expect(arr.length).toBe(10);
+    });
+});

package/dist/string.d.ts

@@ -0,0 +1,3 @@
+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>;

package/dist/string.js

@@ -0,0 +1,8 @@
+export function camelToSnakeCase(s) {
+    return s.replace(/[A-Z]/g, (letter) => `_${letter.toLowerCase()}`);
+}
+export function snakeToCamelCase(s) {
+    return s
+        .toLowerCase()
+        .replace(/([-_][a-z])/g, (group) => group.toUpperCase().replace('-', '').replace('_', ''));
+}

package/dist/string.test.d.ts

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

package/dist/string.test.js

@@ -0,0 +1,16 @@
+import { describe, expect, it } from 'vitest';
+import { camelToSnakeCase, snakeToCamelCase } from './string.js';
+describe('camelToSnakeCase', () => {
+    it('should convert from camel to snake case ', () => {
+        expect(camelToSnakeCase('toSnakeCase')).toBe('to_snake_case');
+        expect(camelToSnakeCase('foo')).toBe('foo');
+        expect(camelToSnakeCase('')).toBe('');
+    });
+});
+describe('snakeToCamelCase', () => {
+    it('should convert from snake to camel case ', () => {
+        expect(snakeToCamelCase('to_camel_case')).toBe('toCamelCase');
+        expect(camelToSnakeCase('foo')).toBe('foo');
+        expect(camelToSnakeCase('')).toBe('');
+    });
+});

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@douglasneuroinformatics/libjs",
+  "type": "module",
+  "version": "0.0.1",
+  "packageManager": "pnpm@8.15.3",
+  "description": "A collection of utility functions and types for Node.js and the browser",
+  "license": "LGPL-3.0",
+  "homepage": "https://github.com/DouglasNeuroInformatics/libjs/#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/DouglasNeuroInformatics/libjs/.git"
+  },
+  "bugs": {
+    "url": "https://github.com/DouglasNeuroInformatics/libjs/issues"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "typescript": "^5.1.0"
+  },
+  "dependencies": {
+    "type-fest": "^4.11.1"
+  },
+  "devDependencies": {
+    "@douglasneuroinformatics/eslint-config": "^4.0.0",
+    "@vitest/coverage-v8": "^1.3.1",
+    "eslint": "^8.57.0",
+    "prettier": "^3.2.5",
+    "typedoc": "^0.25.2",
+    "typescript": "~5.3.3",
+    "vitest": "^1.3.1"
+  },
+  "scripts": {
+    "build": "tsc",
+    "build:docs": "typedoc",
+    "format": "prettier --write src",
+    "lint": "tsc --noEmit && eslint --fix src",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage"
+  }
+}