@bccampus/utils 0.2.2 → 0.2.3

package/src/format/stringify.ts

@@ -1,87 +0,0 @@
-import { dateFormatter, formatList, formatNumber } from "./formatter";
-import { ISODateTime } from "../date/iso-date-time";
-
-export interface StringifyValueOptions {
-  /**
-   * String value to return when the value undefined or null.
-   *
-   * Default Unicode NUL(\u0000) character,
-   * guarantees that the function always returns a string and
-   * allows to distinguish invalid values from an empty string.
-   *
-   * ```ts
-   *   const stringValue = stringify(value);
-   *   console.log(stringValue !== '\u0000' ? 'Invalid' : stringValue)
-   * ```
-   */
-  invalidValueString?: string;
-  /**
-   * `stringify` prepends type info to the return value.
-   */
-  withTypeInfo?: boolean;
-  /**
-   * If the value is a function that doesn't expect an argument,
-   * `stringify` calls the function recursively.
-   */
-  callFunctions?: boolean;
-  /**
-   * `stringify` adds indentation and new lines to object return values.
-   */
-  prettyObjects?: boolean;
-  /**
-   * `stringify` returns verbose value.
-   */
-  verbose?: boolean;
-}
-
-/**
- * Returns string representation of the value;
- *
- * If the valid is null or undefined, returns `options.invalidValueString`.
- */
-export const stringify = (
-  value: unknown,
-  options?: StringifyValueOptions,
-): string => {
-  const _options = {
-    invalidValueString: "\u0000", // Unicode NUL
-    withTypeInfo: options?.verbose,
-    prettyObjects: options?.verbose,
-    ...options,
-  };
-
-  if (value === undefined)
-    return _options.withTypeInfo ? "[undefined]" : _options.invalidValueString;
-  if (value === null)
-    return _options.withTypeInfo ? "[null]" : _options.invalidValueString;
-
-  if (typeof value === "string")
-    return `${_options.withTypeInfo ? "[string] " : ""}${value}`;
-  if (typeof value === "number")
-    return `${_options.withTypeInfo ? "[number] " : ""}${formatNumber(value)}`;
-  if (typeof value === "bigint")
-    return `${_options.withTypeInfo ? "[bigint] " : ""}${value}`;
-  if (typeof value === "boolean")
-    return `${_options.withTypeInfo ? "[boolean] " : ""}${value}`;
-  if (typeof value === "object") {
-    if (Array.isArray(value)) {
-      const stringfiedValue = value.map((el) => stringify(el, _options));
-      return `${_options.withTypeInfo ? "[array] " : ""}${_options.verbose ? stringfiedValue.join(", ") : formatList(stringfiedValue)}`;
-    }
-
-    if (value instanceof Date)
-      return `${_options.withTypeInfo ? "[date] " : ""}${dateFormatter.format(value)}`;
-    if (value instanceof ISODateTime)
-      return `${_options.withTypeInfo ? "[date] " : ""}${value.format()}`;
-
-    return `${_options.withTypeInfo ? "[object] " : ""}${JSON.stringify(value, null, _options.prettyObjects ? 2 : undefined)}`;
-  }
-
-  if (typeof value === "function")
-    return `${_options.withTypeInfo ? "[function] " : ""}${_options.callFunctions && value.length === 0 ? stringify(value(), _options) : value.toString()}`;
-
-  if (typeof value === "symbol")
-    return `${_options.withTypeInfo ? "[symbol] " : ""}${value.toString()}`;
-
-  return _options.invalidValueString;
-};

package/src/format/template.ts

@@ -1,48 +0,0 @@
-import { get } from "../object/get";
-import { stringify } from "./stringify";
-
-type TemplateVarValue = unknown | undefined | null;
-export type TemplateVar = TemplateVarValue | (() => TemplateVarValue);
-export type TemplateVars = Record<string, TemplateVar>;
-
-const tagRegExp = new RegExp(/\${([a-zA-Z0-9_.]+)}/gm);
-
-export const template = (text: string, templateVars: TemplateVars) => {
-  return text.replace(tagRegExp, (match, key) => {
-    const templateVar = get(templateVars, key) as TemplateVar;
-    const value =
-      typeof templateVar === "function" ? templateVar() : templateVar;
-
-    if (value === undefined) return match;
-    if (value === null) return "";
-
-    return stringify(value, { invalidValueString: "" });
-  });
-};
-
-export const templateObject = <T extends object>(
-  obj: T,
-  templateVars: TemplateVars,
-) => {
-  const _objClone: Record<string, unknown> = {};
-
-  for (const [key, value] of Object.entries(obj)) {
-    const _key = template(key, templateVars);
-
-    if (typeof value === "string") {
-      _objClone[_key] = template(value, templateVars);
-    } else if (value && typeof value === "object") {
-      if (Array.isArray(value))
-        _objClone[_key] = value.map((valueItem) =>
-          typeof valueItem === "string"
-            ? template(valueItem, templateVars)
-            : valueItem,
-        );
-      else _objClone[_key] = templateObject(value, templateVars);
-    } else {
-      _objClone[_key] = value;
-    }
-  }
-
-  return _objClone as T;
-};

package/src/index.ts

@@ -1 +0,0 @@
-export const USE_SUBPATH_EXPORTS = true;

package/src/object/get.ts

@@ -1,9 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-export const get = <T extends object>(object: T, prop: string) =>
-  prop
-    .split(".")
-    .reduce<any>(
-      (reducedObject, key) =>
-        reducedObject && key in reducedObject ? reducedObject[key] : undefined,
-      object,
-    );

package/src/object/index.ts

@@ -1,5 +0,0 @@
-export * from "./is-object";
-export * from "./get";
-export * from "./set";
-export * from "./omit";
-export * from "./pick";

package/src/object/is-object.ts

@@ -1,2 +0,0 @@
-export const isObject = (object: unknown) =>
-  typeof object === "object" && !Array.isArray(object) && object !== null;

package/src/object/omit.ts

@@ -1,21 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-export const omit = <T extends object>(object: T, props: string[]) => {
-  const result: Partial<T> = { ...object };
-
-  props.forEach((prop) => {
-    const propChunks = prop.split(".");
-    const lastChunk = propChunks.pop();
-    if (lastChunk) {
-      const ref = propChunks.reduce<any>(
-        (reducedObject, key) =>
-          reducedObject && key in reducedObject
-            ? reducedObject[key]
-            : undefined,
-        result,
-      );
-      if (ref && lastChunk in ref) delete ref[lastChunk];
-    }
-  });
-
-  return result;
-};

package/src/object/pick.ts

@@ -1,10 +0,0 @@
-import { set } from ".";
-import { get } from "./get";
-
-export const pick = <T extends object>(object: T, props: string[]) => {
-  return props.reduce<Record<string, unknown>>((result, key) => {
-    set(result, key, get(object, key));
-
-    return result;
-  }, {}) as Partial<T>;
-};

package/src/object/set.ts

@@ -1,15 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-export const set = <T extends object, V>(object: T, prop: string, value: V) => {
-  const propChunks = prop.split(".");
-  const lastChunk = propChunks.pop();
-  if (!lastChunk) return object;
-
-  const ref = propChunks.reduce<any>((reducedObject, key) => {
-    if (reducedObject[key] === undefined) reducedObject[key] = {};
-    return reducedObject[key];
-  }, object);
-
-  ref[lastChunk] = value;
-
-  return object;
-};

package/src/path/file-url-to-path.ts

@@ -1,12 +0,0 @@
-const windowsDriveRegExp = /^\/[a-zA-Z1-9_-]+:\//;
-
-/**
- * Browser compatible version of `node:url.fileURLToPath`
- */
-export function fileURLToPath(fileUrl: string) {
-  const url = new URL(fileUrl);
-  let path = decodeURIComponent(url.pathname);
-  if (windowsDriveRegExp.test(path)) path = path.slice(1);
-
-  return path;
-}

package/src/path/index.ts

@@ -1,2 +0,0 @@
-export * from "./normalize";
-export * from "./file-url-to-path";

package/src/path/normalize.ts

@@ -1,72 +0,0 @@
-import { fileURLToPath } from "./file-url-to-path";
-
-export interface NormalizeOptions {
-  /**
-   * - `always`: ensure leading slash exists
-   * - `never`: ensure leading slash does not exist
-   * - `as-is`: do not modify the leading char
-   *
-   * @default "always"
-   */
-  leadingSlash?: "always" | "never" | "as-is";
-
-  /**
-   * - `always`: ensure trailing slash exists
-   * - `never`: ensure trailing slash does not exist
-   * - `as-is`: do not modify the trailing char
-   *
-   * @default "never"
-   */
-  trailingSlash?: "always" | "never" | "as-is";
-}
-
-const defaultOptions: Required<NormalizeOptions> = {
-  leadingSlash: "always",
-  trailingSlash: "never",
-};
-
-const windowsPathSepRegExp = /[\\]+/g;
-const unixPathSepRegExp = /[/]+/g;
-const windowsDriveRegExp = /^[a-zA-Z1-9_-]+:\//;
-const fileProtocolRegExp = /^file:\/\//;
-const leadingSlashRegExp = /^\//g;
-const trailingSlashRegExp = /\/$/g;
-
-/**
- * Clears and converts the provided path to a Posix filepath
- *
- * By default, adds a leading slash and removes the trailing
- *
- * @example
- * ```
- *  normalize("src/test/"); //returns: /src/test
- *  normalize("C:\\Users\\test\\folder\\"); //returns: C:/Users/test/folder
- *  normalize("file:///C:/Users/test/folder/file.ts"); //returns: C:/Users/test/folder/file.ts
- * ```
- */
-export function normalize(path: string, options?: NormalizeOptions) {
-  const conf = { ...defaultOptions, ...options };
-  const sep = "\\";
-  let normalPath = path.trim();
-
-  if (fileProtocolRegExp.test(normalPath))
-    normalPath = fileURLToPath(normalPath);
-
-  normalPath = normalPath
-    .replace(windowsPathSepRegExp, sep) // windows -> linux
-    .replace(unixPathSepRegExp, sep); // multiple -> single
-
-  if (conf.leadingSlash !== "as-is") {
-    normalPath = normalPath.replace(leadingSlashRegExp, "");
-
-    if (conf.leadingSlash === "always" && !windowsDriveRegExp.test(normalPath))
-      normalPath = `${sep}${normalPath}`;
-  }
-
-  if (conf.trailingSlash !== "as-is") {
-    normalPath = normalPath.replace(trailingSlashRegExp, "");
-    if (conf.trailingSlash === "always") normalPath = `${normalPath}${sep}`;
-  }
-
-  return normalPath;
-}

package/src/set/difference.ts

@@ -1,9 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-export function difference(setA: Iterable<any>, setB: Iterable<any>) {
-  const _difference = new Set(setA);
-  for (const elem of setB) {
-    _difference.delete(elem);
-  }
-  return _difference;
-}

package/src/set/index.ts

@@ -1,5 +0,0 @@
-export * from "./union";
-export * from "./intersection";
-export * from "./is-superset";
-export * from "./difference";
-export * from "./symmetric-difference";

package/src/set/intersection.ts

@@ -1,12 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-export function intersection(setA: Iterable<any>, setB: Iterable<any>) {
-  const _setA = setA instanceof Set ? setA : new Set(setA);
-
-  const _intersection = new Set();
-  for (const elem of setB) {
-    if (_setA.has(elem)) {
-      _intersection.add(elem);
-    }
-  }
-  return _intersection;
-}

package/src/set/is-superset.ts

@@ -1,12 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-export function isSuperset(set: Iterable<any>, subset: Iterable<any>) {
-  const _set = set instanceof Set ? set : new Set(set);
-
-  for (const elem of subset) {
-    if (!_set.has(elem)) {
-      return false;
-    }
-  }
-  return true;
-}

package/src/set/symmetric-difference.ts

@@ -1,12 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-export function symmetricDifference(setA: Iterable<any>, setB: Iterable<any>) {
-  const _difference = new Set(setA);
-  for (const elem of setB) {
-    if (_difference.has(elem)) {
-      _difference.delete(elem);
-    } else {
-      _difference.add(elem);
-    }
-  }
-  return _difference;
-}

package/src/set/union.ts

@@ -1,8 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-export function union(setA: Iterable<any>, setB: Iterable<any>) {
-  const _union = new Set(setA);
-  for (const elem of setB) {
-    _union.add(elem);
-  }
-  return _union;
-}

package/src/string/capitalize.ts

@@ -1,2 +0,0 @@
-export const capitalize = <T extends string>(s: T) =>
-  (s[0].toUpperCase() + s.slice(1)) as Capitalize<typeof s>;

package/src/string/index.ts

@@ -1,6 +0,0 @@
-export * from "./truncate";
-export * from "./trim";
-export * from "./strip-html-tags";
-export * from "./capitalize";
-export * from "./to-sentence-case";
-export * from "./to-int";

package/src/string/normalize.ts

@@ -1,7 +0,0 @@
-/**
- * Trims white spaces and
- * replaces multiple white space characters with a single space
- */
-export function normalize(text: string) {
-  return text.trim().replace(/\s+/g, " ");
-}

package/src/string/pluralize/index.ts

@@ -1,7 +0,0 @@
-import { Pluralize } from "./pluralize";
-
-const pluralize = new Pluralize();
-
-export type * from "./types";
-
-export { pluralize, Pluralize };