@douglasneuroinformatics/libjs 0.0.2 → 0.1.0

package/dist/object.d.ts

@@ -2,4 +2,21 @@ 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>;
+/**
+ * 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('')`)
+ */
+export declare function isObject(value: unknown): value is object;
+/**
+ * Checks if `value` is object-like. A value is object-like if it's not `null`
+ * and has a `typeof` result of "object".
+ */
+export declare function isObjectLike(value: unknown): value is object;
+/**
+ * Checks if `value` is a plain object. An object is plain if it is created by either
+ * `{}`, `new Object()`, or `Object.create(null)`.
+ */
+export declare function isPlainObject(value: unknown): value is {
+    [key: string]: unknown;
+};
 //# 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,GAAG,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAQpE"}
+{"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"}

package/dist/object.js

@@ -7,3 +7,31 @@ export function deepFreeze(obj) {
     });
     return Object.freeze(obj);
 }
+/**
+ * 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('')`)
+ */
+export function isObject(value) {
+    const type = typeof value;
+    return value !== null && (type === 'object' || type === 'function');
+}
+/**
+ * Checks if `value` is object-like. A value is object-like if it's not `null`
+ * and has a `typeof` result of "object".
+ */
+export function isObjectLike(value) {
+    return value !== null && typeof value === 'object';
+}
+/**
+ * Checks if `value` is a plain object. An object is plain if it is created by either
+ * `{}`, `new Object()`, or `Object.create(null)`.
+ */
+export function isPlainObject(value) {
+    if (typeof value !== 'object' || value === null) {
+        return false;
+    }
+    const prototype = Object.getPrototypeOf(value);
+    return ((prototype === null || prototype === Object.prototype || Object.getPrototypeOf(prototype) === null) &&
+        !(Symbol.toStringTag in value) &&
+        !(Symbol.iterator in value));
+}

package/dist/object.test.js

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest';
-import { deepFreeze } from './object.js';
+import { deepFreeze, isObject, isObjectLike, isPlainObject } from './object.js';
 describe('deepFreeze', () => {
     it('should not allow mutating a primitive value', () => {
         const obj = deepFreeze({ foo: 1 });
@@ -23,3 +23,51 @@ describe('deepFreeze', () => {
         }).toThrow();
     });
 });
+describe('isObject', () => {
+    it('should return true for an object literal', () => {
+        expect(isObject({})).toBe(true);
+    });
+    it('should return true for an array', () => {
+        expect(isObject([])).toBe(true);
+    });
+    it('should return true for a function', () => {
+        expect(isObject(() => null)).toBe(true);
+    });
+    it('should return false for null', () => {
+        expect(isObject(null)).toBe(false);
+    });
+});
+describe('isObjectLike', () => {
+    it('should return true for an object literal', () => {
+        expect(isObjectLike({})).toBe(true);
+    });
+    it('should return true for an array', () => {
+        expect(isObjectLike([])).toBe(true);
+    });
+    it('should return false for a function', () => {
+        expect(isObjectLike(() => null)).toBe(false);
+    });
+    it('should return false for null', () => {
+        expect(isObjectLike(() => null)).toBe(false);
+    });
+});
+describe('isPlainObject', () => {
+    it('should return true for an object literal', () => {
+        expect(isPlainObject({ foo: null })).toBe(true);
+    });
+    it('should return true for an object created with the Object constructor', () => {
+        expect(isPlainObject(new Object())).toBe(true);
+    });
+    it('should return true for an object with a null prototype', () => {
+        expect(isPlainObject(Object.create(null))).toBe(true);
+    });
+    it('should return false for an array', () => {
+        expect(isPlainObject([])).toBe(false);
+    });
+    it('should return false for a function', () => {
+        expect(isPlainObject(() => null)).toBe(false);
+    });
+    it('should return false for null', () => {
+        expect(isPlainObject(() => null)).toBe(false);
+    });
+});

package/dist/string.d.ts

@@ -1,4 +1,8 @@
 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>;
+export declare function toLowerCase<T extends string>(s: T): Lowercase<T>;
+export declare function toUpperCase<T extends string>(s: T): Uppercase<T>;
 //# sourceMappingURL=string.d.ts.map

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,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"}
+{"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;AAED,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,gBAEjD;AAED,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,gBAEjD"}

package/dist/string.js

@@ -6,3 +6,15 @@ 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));
+}
+export function toLowerCase(s) {
+    return s.toLowerCase();
+}
+export function toUpperCase(s) {
+    return s.toUpperCase();
+}

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, toLowerCase, toUpperCase, uncapitalize } from './string.js';
 describe('camelToSnakeCase', () => {
     it('should convert from camel to snake case ', () => {
         expect(camelToSnakeCase('toSnakeCase')).toBe('to_snake_case');
@@ -14,3 +14,27 @@ 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');
+    });
+});
+describe('toLowerCase', () => {
+    it('should convert to lower case', () => {
+        expect(toLowerCase('FOO')).toBe('foo');
+    });
+});
+describe('toUpperCase', () => {
+    it('should convert to upper case', () => {
+        expect(toUpperCase('foo')).toBe('FOO');
+    });
+});

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "@douglasneuroinformatics/libjs",
   "type": "module",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "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": {
@@ -23,6 +27,7 @@
     "build:docs": "typedoc",
     "format": "prettier --write src",
     "lint": "tsc --noEmit && eslint --fix src",
+    "prepare": "husky",
     "test": "vitest run",
     "test:coverage": "vitest run --coverage"
   },
@@ -33,10 +38,18 @@
     "type-fest": "^4.11.1"
   },
   "devDependencies": {
-    "@douglasneuroinformatics/eslint-config": "^4.0.0",
+    "@commitlint/cli": "^19.2.1",
+    "@commitlint/config-conventional": "^19.1.0",
+    "@commitlint/types": "^19.0.3",
+    "@douglasneuroinformatics/eslint-config": "^4.2.1",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/npm": "^12.0.0",
     "@vitest/coverage-v8": "^1.3.1",
     "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"