@bccampus/utils 0.2.2 → 0.3.0

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

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

package/dist/string/strip-html-tags.cjs

@@ -1,7 +1,8 @@
-"use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const htmlTagRegExp = /(<([^>]+)>)/g;
+//#region src/string/strip-html-tags.ts
+var htmlTagRegExp = /(<([^>]+)>)/g;
 function stripHtmlTags(text) {
-  return text.replace(htmlTagRegExp, "");
+	return text.replace(htmlTagRegExp, "");
 }
+//#endregion
 exports.stripHtmlTags = stripHtmlTags;

package/dist/string/strip-html-tags.js

@@ -1,7 +1,7 @@
-const htmlTagRegExp = /(<([^>]+)>)/g;
+//#region src/string/strip-html-tags.ts
+var htmlTagRegExp = /(<([^>]+)>)/g;
 function stripHtmlTags(text) {
-  return text.replace(htmlTagRegExp, "");
+	return text.replace(htmlTagRegExp, "");
 }
-export {
-  stripHtmlTags
-};
+//#endregion
+export { stripHtmlTags };

package/dist/string/strip-html-tags.test.d.ts

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

package/dist/string/to-int.cjs

@@ -1,10 +1,18 @@
-"use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/string/to-int.ts
+/**
+* Converts a string (or a number) into a number.
+* If the input can not be successfully converted, it will return the fallback.
+* It will not return NaN.
+* @param value - The value to convert
+* @param fallback - The value to fallback to. Defaults to 0
+* @returns number
+*/
 function stringToInt(value, fallback = 0) {
-  let returnValue = value;
-  if (typeof returnValue === "string")
-    returnValue = Number.parseInt(returnValue);
-  if (Number.isNaN(returnValue)) returnValue = fallback;
-  return returnValue;
+	let returnValue = value;
+	if (typeof returnValue === "string") returnValue = Number.parseInt(returnValue);
+	if (Number.isNaN(returnValue)) returnValue = fallback;
+	return returnValue;
 }
+//#endregion
 exports.stringToInt = stringToInt;

package/dist/string/to-int.js

@@ -1,10 +1,17 @@
+//#region src/string/to-int.ts
+/**
+* Converts a string (or a number) into a number.
+* If the input can not be successfully converted, it will return the fallback.
+* It will not return NaN.
+* @param value - The value to convert
+* @param fallback - The value to fallback to. Defaults to 0
+* @returns number
+*/
 function stringToInt(value, fallback = 0) {
-  let returnValue = value;
-  if (typeof returnValue === "string")
-    returnValue = Number.parseInt(returnValue);
-  if (Number.isNaN(returnValue)) returnValue = fallback;
-  return returnValue;
+	let returnValue = value;
+	if (typeof returnValue === "string") returnValue = Number.parseInt(returnValue);
+	if (Number.isNaN(returnValue)) returnValue = fallback;
+	return returnValue;
 }
-export {
-  stringToInt
-};
+//#endregion
+export { stringToInt };

package/dist/string/to-int.test.d.ts

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

package/dist/string/to-sentence-case.cjs

@@ -1,8 +1,8 @@
-"use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const specialCharRegExp = /[\s-_.+]+/g;
-const toSentenceCase = (s) => (s[0].toUpperCase() + s.slice(1).toLowerCase()).replace(
-  specialCharRegExp,
-  " "
-);
+//#region src/string/to-sentence-case.ts
+var specialCharRegExp = /[\s\-_.+]+/g;
+function toSentenceCase(s) {
+	return (s[0].toUpperCase() + s.slice(1).toLowerCase()).replace(specialCharRegExp, " ");
+}
+//#endregion
 exports.toSentenceCase = toSentenceCase;

package/dist/string/to-sentence-case.d.ts

@@ -1 +1 @@
-export declare const toSentenceCase: <T extends string>(s: T) => string;
+export declare function toSentenceCase<T extends string>(s: T): string;

package/dist/string/to-sentence-case.js

@@ -1,8 +1,7 @@
-const specialCharRegExp = /[\s-_.+]+/g;
-const toSentenceCase = (s) => (s[0].toUpperCase() + s.slice(1).toLowerCase()).replace(
-  specialCharRegExp,
-  " "
-);
-export {
-  toSentenceCase
-};
+//#region src/string/to-sentence-case.ts
+var specialCharRegExp = /[\s\-_.+]+/g;
+function toSentenceCase(s) {
+	return (s[0].toUpperCase() + s.slice(1).toLowerCase()).replace(specialCharRegExp, " ");
+}
+//#endregion
+export { toSentenceCase };

package/dist/string/to-sentence-case.test.d.ts

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

package/dist/string/trim.cjs

@@ -1,11 +1,12 @@
-"use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/string/trim.ts
 function trim(text, chars = " ") {
-  let start = 0;
-  let end = text.length;
-  if (!Array.isArray(chars)) chars = [chars];
-  while (start < end && chars.includes(text[start])) start += 1;
-  while (end > start && chars.includes(text[end - 1])) end -= 1;
-  return start > 0 || end < text.length ? text.substring(start, end) : text;
+	let start = 0;
+	let end = text.length;
+	if (!Array.isArray(chars)) chars = [chars];
+	while (start < end && chars.includes(text[start])) start += 1;
+	while (end > start && chars.includes(text[end - 1])) end -= 1;
+	return start > 0 || end < text.length ? text.substring(start, end) : text;
 }
+//#endregion
 exports.trim = trim;

package/dist/string/trim.js

@@ -1,11 +1,11 @@
+//#region src/string/trim.ts
 function trim(text, chars = " ") {
-  let start = 0;
-  let end = text.length;
-  if (!Array.isArray(chars)) chars = [chars];
-  while (start < end && chars.includes(text[start])) start += 1;
-  while (end > start && chars.includes(text[end - 1])) end -= 1;
-  return start > 0 || end < text.length ? text.substring(start, end) : text;
+	let start = 0;
+	let end = text.length;
+	if (!Array.isArray(chars)) chars = [chars];
+	while (start < end && chars.includes(text[start])) start += 1;
+	while (end > start && chars.includes(text[end - 1])) end -= 1;
+	return start > 0 || end < text.length ? text.substring(start, end) : text;
 }
-export {
-  trim
-};
+//#endregion
+export { trim };

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

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

package/dist/string/truncate.cjs

@@ -1,20 +1,21 @@
-"use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const defaultOptions = {
-  ending: "...",
-  maxlength: 100,
-  noWordBreak: false
+//#region src/string/truncate.ts
+var defaultOptions = {
+	ending: "...",
+	maxlength: 100,
+	noWordBreak: false
 };
 function truncate(text, options) {
-  const conf = { ...defaultOptions, ...options };
-  text = text.trim();
-  if (conf.noWordBreak) {
-    const lastSpaceIndex = text.indexOf(" ", conf.maxlength);
-    if (lastSpaceIndex >= conf.maxlength)
-      return text.substring(0, lastSpaceIndex) + conf.ending;
-  } else if (text.length > conf.maxlength + conf.ending.length) {
-    return text.substring(0, conf.maxlength) + conf.ending;
-  }
-  return text;
+	const conf = {
+		...defaultOptions,
+		...options
+	};
+	text = text.trim();
+	if (conf.noWordBreak) {
+		const lastSpaceIndex = text.indexOf(" ", conf.maxlength);
+		if (lastSpaceIndex >= conf.maxlength) return text.substring(0, lastSpaceIndex) + conf.ending;
+	} else if (text.length > conf.maxlength + conf.ending.length) return text.substring(0, conf.maxlength) + conf.ending;
+	return text;
 }
+//#endregion
 exports.truncate = truncate;

package/dist/string/truncate.js

@@ -1,20 +1,20 @@
-const defaultOptions = {
-  ending: "...",
-  maxlength: 100,
-  noWordBreak: false
+//#region src/string/truncate.ts
+var defaultOptions = {
+	ending: "...",
+	maxlength: 100,
+	noWordBreak: false
 };
 function truncate(text, options) {
-  const conf = { ...defaultOptions, ...options };
-  text = text.trim();
-  if (conf.noWordBreak) {
-    const lastSpaceIndex = text.indexOf(" ", conf.maxlength);
-    if (lastSpaceIndex >= conf.maxlength)
-      return text.substring(0, lastSpaceIndex) + conf.ending;
-  } else if (text.length > conf.maxlength + conf.ending.length) {
-    return text.substring(0, conf.maxlength) + conf.ending;
-  }
-  return text;
+	const conf = {
+		...defaultOptions,
+		...options
+	};
+	text = text.trim();
+	if (conf.noWordBreak) {
+		const lastSpaceIndex = text.indexOf(" ", conf.maxlength);
+		if (lastSpaceIndex >= conf.maxlength) return text.substring(0, lastSpaceIndex) + conf.ending;
+	} else if (text.length > conf.maxlength + conf.ending.length) return text.substring(0, conf.maxlength) + conf.ending;
+	return text;
 }
-export {
-  truncate
-};
+//#endregion
+export { truncate };

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

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

package/dist/value/is-empty.cjs

@@ -1,14 +1,32 @@
-"use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const isEmpty = (value) => {
-  if (value === void 0) return true;
-  if (value === null) return true;
-  if (typeof value === "string") return value.trim() === "";
-  if (typeof value === "object") {
-    if (Array.isArray(value) && value.length === 0) return true;
-    if (value instanceof Map || value instanceof Set) return value.size === 0;
-    return Object.keys(value).length === 0;
-  }
-  return false;
-};
+//#region src/value/is-empty.ts
+/**
+* Checks if the value is `empty`
+*
+* returns `true`, if the value
+*
+* - `undefined`
+* - `null`
+* - `string` and there is no character in the string or all white space
+* - `array` and there is no item in the array
+* - `map` and there is no item in the map
+* - `set` and there is no item in the set
+* - `object` and there is no property in the object
+*
+* otherwise, false
+*
+*/
+function isEmpty(value) {
+	if (value === void 0) return true;
+	if (value === null) return true;
+	if (typeof value === "string") return value.trim() === "";
+	if (typeof value === "object") {
+		if (Array.isArray(value) && value.length === 0) return true;
+		if (value instanceof Map || value instanceof Set) return value.size === 0;
+		if (value instanceof Date) return false;
+		return Object.keys(value).length === 0;
+	}
+	return false;
+}
+//#endregion
 exports.isEmpty = isEmpty;

package/dist/value/is-empty.d.ts

@@ -14,4 +14,4 @@
  * otherwise, false
  *
  */
-export declare const isEmpty: (value: unknown) => boolean;
+export declare function isEmpty(value: unknown): boolean;

package/dist/value/is-empty.js

@@ -1,14 +1,31 @@
-const isEmpty = (value) => {
-  if (value === void 0) return true;
-  if (value === null) return true;
-  if (typeof value === "string") return value.trim() === "";
-  if (typeof value === "object") {
-    if (Array.isArray(value) && value.length === 0) return true;
-    if (value instanceof Map || value instanceof Set) return value.size === 0;
-    return Object.keys(value).length === 0;
-  }
-  return false;
-};
-export {
-  isEmpty
-};
+//#region src/value/is-empty.ts
+/**
+* Checks if the value is `empty`
+*
+* returns `true`, if the value
+*
+* - `undefined`
+* - `null`
+* - `string` and there is no character in the string or all white space
+* - `array` and there is no item in the array
+* - `map` and there is no item in the map
+* - `set` and there is no item in the set
+* - `object` and there is no property in the object
+*
+* otherwise, false
+*
+*/
+function isEmpty(value) {
+	if (value === void 0) return true;
+	if (value === null) return true;
+	if (typeof value === "string") return value.trim() === "";
+	if (typeof value === "object") {
+		if (Array.isArray(value) && value.length === 0) return true;
+		if (value instanceof Map || value instanceof Set) return value.size === 0;
+		if (value instanceof Date) return false;
+		return Object.keys(value).length === 0;
+	}
+	return false;
+}
+//#endregion
+export { isEmpty };

package/dist/value/value.test.d.ts

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

package/package.json

@@ -1,54 +1,168 @@
 {
   "name": "@bccampus/utils",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "BCcampus' utility box",
   "type": "module",
   "license": "UNLICENSED",
+  "packageManager": "yarn@4.16.0",
+  "scripts": {
+    "_postinstall": "husky",
+    "prepack": "pinst --disable && yarn build",
+    "postpack": "pinst --enable",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint ./src",
+    "lint:fix": "eslint --fix ./src",
+    "test": "vitest",
+    "coverage": "vitest run --reporter=minimal --coverage",
+    "build": "yarn typecheck && yarn lint && yarn coverage && vite build",
+    "publish": "yarn npm publish --access public --tolerate-republish"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^9.0.0",
+    "@types/node": "^24.13.0",
+    "@vitest/coverage-v8": "4.1.8",
+    "baseline-browser-mapping": "^2.10.33",
+    "eslint": "^10.4.1",
+    "eslint-plugin-format": "^2.0.1",
+    "globals": "^17.6.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^17.0.7",
+    "pinst": "^3.0.0",
+    "tinyglobby": "^0.2.17",
+    "typescript": "~6.0.3",
+    "unplugin-dts": "^1.0.2",
+    "vite": "^8.0.16",
+    "vitest": "^4.1.8"
+  },
+  "dependencies": {
+    "@sindresorhus/slugify": "^3.0.0"
+  },
+  "lint-staged": {
+    "!(*test).ts": [
+      "vitest related --run",
+      "eslint --fix"
+    ]
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "files": [
+    "dist"
+  ],
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     },
-    "./array": {
-      "types": "./dist/array/index.d.ts",
-      "import": "./dist/array/index.js",
-      "require": "./dist/array/index.cjs"
-    },
-    "./date": {
-      "types": "./dist/date/index.d.ts",
-      "import": "./dist/date/index.js",
-      "require": "./dist/date/index.cjs"
-    },
-    "./duration": {
-      "types": "./dist/duration/index.d.ts",
-      "import": "./dist/duration/index.js",
-      "require": "./dist/duration/index.cjs"
-    },
-    "./format": {
-      "types": "./dist/format/index.d.ts",
-      "import": "./dist/format/index.js",
-      "require": "./dist/format/index.cjs"
-    },
-    "./object": {
-      "types": "./dist/object/index.d.ts",
-      "import": "./dist/object/index.js",
-      "require": "./dist/object/index.cjs"
-    },
-    "./path": {
-      "types": "./dist/path/index.d.ts",
-      "import": "./dist/path/index.js",
-      "require": "./dist/path/index.cjs"
-    },
-    "./set": {
-      "types": "./dist/set/index.d.ts",
-      "import": "./dist/set/index.js",
-      "require": "./dist/set/index.cjs"
-    },
-    "./string": {
-      "types": "./dist/string/index.d.ts",
-      "import": "./dist/string/index.js",
-      "require": "./dist/string/index.cjs"
+    "./array/chunk": {
+      "types": "./dist/array/chunk.d.ts",
+      "import": "./dist/array/chunk.js",
+      "require": "./dist/array/chunk.cjs"
+    },
+    "./date/iso-date-time": {
+      "types": "./dist/date/iso-date-time/index.d.ts",
+      "import": "./dist/date/iso-date-time/index.js",
+      "require": "./dist/date/iso-date-time/index.cjs"
+    },
+    "./duration/add-durations": {
+      "types": "./dist/duration/add-durations.d.ts",
+      "import": "./dist/duration/add-durations.js",
+      "require": "./dist/duration/add-durations.cjs"
+    },
+    "./duration/is-duration": {
+      "types": "./dist/duration/is-duration.d.ts",
+      "import": "./dist/duration/is-duration.js",
+      "require": "./dist/duration/is-duration.cjs"
+    },
+    "./duration/to-number": {
+      "types": "./dist/duration/to-number.d.ts",
+      "import": "./dist/duration/to-number.js",
+      "require": "./dist/duration/to-number.cjs"
+    },
+    "./format/formatter": {
+      "types": "./dist/format/formatter.d.ts",
+      "import": "./dist/format/formatter.js",
+      "require": "./dist/format/formatter.cjs"
+    },
+    "./format/stringify": {
+      "types": "./dist/format/stringify.d.ts",
+      "import": "./dist/format/stringify.js",
+      "require": "./dist/format/stringify.cjs"
+    },
+    "./format/template": {
+      "types": "./dist/format/template.d.ts",
+      "import": "./dist/format/template.js",
+      "require": "./dist/format/template.cjs"
+    },
+    "./object/get": {
+      "types": "./dist/object/get.d.ts",
+      "import": "./dist/object/get.js",
+      "require": "./dist/object/get.cjs"
+    },
+    "./object/is-object": {
+      "types": "./dist/object/is-object.d.ts",
+      "import": "./dist/object/is-object.js",
+      "require": "./dist/object/is-object.cjs"
+    },
+    "./object/omit": {
+      "types": "./dist/object/omit.d.ts",
+      "import": "./dist/object/omit.js",
+      "require": "./dist/object/omit.cjs"
+    },
+    "./object/pick": {
+      "types": "./dist/object/pick.d.ts",
+      "import": "./dist/object/pick.js",
+      "require": "./dist/object/pick.cjs"
+    },
+    "./object/set": {
+      "types": "./dist/object/set.d.ts",
+      "import": "./dist/object/set.js",
+      "require": "./dist/object/set.cjs"
+    },
+    "./path/file-url-to-path": {
+      "types": "./dist/path/file-url-to-path.d.ts",
+      "import": "./dist/path/file-url-to-path.js",
+      "require": "./dist/path/file-url-to-path.cjs"
+    },
+    "./path/normalize": {
+      "types": "./dist/path/normalize.d.ts",
+      "import": "./dist/path/normalize.js",
+      "require": "./dist/path/normalize.cjs"
+    },
+    "./set/difference": {
+      "types": "./dist/set/difference.d.ts",
+      "import": "./dist/set/difference.js",
+      "require": "./dist/set/difference.cjs"
+    },
+    "./set/intersection": {
+      "types": "./dist/set/intersection.d.ts",
+      "import": "./dist/set/intersection.js",
+      "require": "./dist/set/intersection.cjs"
+    },
+    "./set/is-superset": {
+      "types": "./dist/set/is-superset.d.ts",
+      "import": "./dist/set/is-superset.js",
+      "require": "./dist/set/is-superset.cjs"
+    },
+    "./set/symmetric-difference": {
+      "types": "./dist/set/symmetric-difference.d.ts",
+      "import": "./dist/set/symmetric-difference.js",
+      "require": "./dist/set/symmetric-difference.cjs"
+    },
+    "./set/union": {
+      "types": "./dist/set/union.d.ts",
+      "import": "./dist/set/union.js",
+      "require": "./dist/set/union.cjs"
+    },
+    "./string/capitalize": {
+      "types": "./dist/string/capitalize.d.ts",
+      "import": "./dist/string/capitalize.js",
+      "require": "./dist/string/capitalize.cjs"
+    },
+    "./string/normalize": {
+      "types": "./dist/string/normalize.d.ts",
+      "import": "./dist/string/normalize.js",
+      "require": "./dist/string/normalize.cjs"
     },
     "./string/pluralize": {
       "types": "./dist/string/pluralize/index.d.ts",
@@ -60,33 +174,35 @@
       "import": "./dist/string/slugify/index.js",
       "require": "./dist/string/slugify/index.cjs"
     },
-    "./value": {
-      "types": "./dist/value/index.d.ts",
-      "import": "./dist/value/index.js",
-      "require": "./dist/value/index.cjs"
+    "./string/strip-html-tags": {
+      "types": "./dist/string/strip-html-tags.d.ts",
+      "import": "./dist/string/strip-html-tags.js",
+      "require": "./dist/string/strip-html-tags.cjs"
+    },
+    "./string/to-int": {
+      "types": "./dist/string/to-int.d.ts",
+      "import": "./dist/string/to-int.js",
+      "require": "./dist/string/to-int.cjs"
+    },
+    "./string/to-sentence-case": {
+      "types": "./dist/string/to-sentence-case.d.ts",
+      "import": "./dist/string/to-sentence-case.js",
+      "require": "./dist/string/to-sentence-case.cjs"
+    },
+    "./string/trim": {
+      "types": "./dist/string/trim.d.ts",
+      "import": "./dist/string/trim.js",
+      "require": "./dist/string/trim.cjs"
+    },
+    "./string/truncate": {
+      "types": "./dist/string/truncate.d.ts",
+      "import": "./dist/string/truncate.js",
+      "require": "./dist/string/truncate.cjs"
+    },
+    "./value/is-empty": {
+      "types": "./dist/value/is-empty.d.ts",
+      "import": "./dist/value/is-empty.js",
+      "require": "./dist/value/is-empty.cjs"
     }
-  },
-  "packageManager": "yarn@4.15.0",
-  "scripts": {
-    "check": "tsc -b && eslint ./src",
-    "build": "tsc -b && vite build",
-    "lint": "eslint .",
-    "prepublish": "yarn build",
-    "publish": "yarn npm publish --access public --tolerate-republish"
-  },
-  "devDependencies": {
-    "@eslint/js": "^9.39.4",
-    "@types/node": "^24.12.3",
-    "baseline-browser-mapping": "^2.10.27",
-    "eslint": "^9.39.4",
-    "globals": "^17.6.0",
-    "tinyglobby": "^0.2.16",
-    "typescript": "~5.9.3",
-    "typescript-eslint": "^8.59.2",
-    "vite": "^7.3.3",
-    "vite-plugin-dts": "^4.5.4"
-  },
-  "dependencies": {
-    "@sindresorhus/slugify": "^3.0.0"
   }
 }

package/dist/array/index.cjs

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const array_chunk = require("./chunk.cjs");
-exports.chunk = array_chunk.chunk;

package/dist/array/index.d.ts

@@ -1 +0,0 @@
-export * from './chunk';

package/dist/array/index.js

@@ -1,4 +0,0 @@
-import { chunk } from "./chunk.js";
-export {
-  chunk
-};