@bccampus/utils 0.2.2 → 0.3.0

package/dist/string/index.cjs

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const string_truncate = require("./truncate.cjs");
-const string_trim = require("./trim.cjs");
-const string_stripHtmlTags = require("./strip-html-tags.cjs");
-const string_capitalize = require("./capitalize.cjs");
-const string_toSentenceCase = require("./to-sentence-case.cjs");
-const string_toInt = require("./to-int.cjs");
-exports.truncate = string_truncate.truncate;
-exports.trim = string_trim.trim;
-exports.stripHtmlTags = string_stripHtmlTags.stripHtmlTags;
-exports.capitalize = string_capitalize.capitalize;
-exports.toSentenceCase = string_toSentenceCase.toSentenceCase;
-exports.stringToInt = string_toInt.stringToInt;

package/dist/string/index.d.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/dist/string/index.js

@@ -1,14 +0,0 @@
-import { truncate } from "./truncate.js";
-import { trim } from "./trim.js";
-import { stripHtmlTags } from "./strip-html-tags.js";
-import { capitalize } from "./capitalize.js";
-import { toSentenceCase } from "./to-sentence-case.js";
-import { stringToInt } from "./to-int.js";
-export {
-  capitalize,
-  stringToInt,
-  stripHtmlTags,
-  toSentenceCase,
-  trim,
-  truncate
-};

package/dist/value/index.cjs

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

package/dist/value/index.d.ts

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

package/dist/value/index.js

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

package/eslint.config.js

@@ -1,19 +0,0 @@
-import js from '@eslint/js'
-import globals from 'globals'
-import tseslint from 'typescript-eslint'
-import { defineConfig, globalIgnores } from 'eslint/config'
-
-export default defineConfig([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      js.configs.recommended,
-      tseslint.configs.recommended,
-    ],
-    languageOptions: {
-      ecmaVersion: 2020,
-      globals: globals.browser,
-    },
-  }
-])

package/src/array/chunk.ts

@@ -1,6 +0,0 @@
-export function chunk<T>(arr: T[], size: number = 5) {
-  const chunks: T[][] = [];
-  for (let i = 0; i < arr.length; i += size)
-    chunks.push(arr.slice(i, i + size));
-  return chunks;
-}

package/src/array/index.ts

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

package/src/date/index.ts

@@ -1 +0,0 @@
-export * from "./iso-date-time";

package/src/date/iso-date-time.ts

@@ -1,356 +0,0 @@
-const isoDateTimeRegEx = new RegExp('^([0-9-]+)(T([0-9:.,]+)(Z|[+-]([0-9:]+))?)?$');
-const dateRegEx = new RegExp('^(\\d{4})-?(\\d{2})?-?(\\d{2})?$');
-const timeRegEx = new RegExp('^(\\d{2}):?(\\d{2})?:?(\\d{2})?(\\.(\\d{3}))?$');
-const timezoneRegEx = new RegExp('^Z|^[+-]((\\d{2}):?(\\d{2})?)$');
-
-export const InvalidDate: unique symbol = Symbol('Invalid Date');
-export type InvalidDate = typeof InvalidDate;
-
-export const DefaultDateFormat: DateFormatOptions = {
-  year: 'numeric',
-  month: 'long',
-  day: '2-digit',
-};
-
-export const DefaultTimeFormat: DateFormatOptions = {
-  hour: '2-digit',
-  minute: '2-digit',
-  timeZoneName: 'short',
-};
-
-export const DefaultTimezone = 'America/Vancouver';
-
-/**
- * Enables storage, retrieval and formating of ISO dates and times
- * with time zone information.
- */
-export class ISODateTime {
-  #parsed?: ParsedDateTime;
-  #date: Date | InvalidDate;
-  #string: string;
-
-  constructor();
-  constructor(isoDatetime: number);
-  constructor(isoDatetime: string);
-  constructor(isoDatetime?: string | number) {
-    if (typeof isoDatetime === 'string') {
-      this.#parsed = ISODateTime.parse(isoDatetime);
-      if (this.#parsed) {
-        this.#date = new Date(ISODateTime.toString(this));
-      } else {
-        this.#date = InvalidDate;
-        console.error(`Failed to parse date for value: ${isoDatetime}`);
-      }
-    } else if (typeof isoDatetime === 'number' && Number.isFinite(isoDatetime)) {
-      this.#date = new Date(isoDatetime);
-      this.#parsed = ISODateTime.parse(this.#date.toISOString());
-    } else {
-      this.#date = new Date();
-      this.#parsed = ISODateTime.parse(this.#date.toISOString());
-    }
-
-    if (this.#date !== InvalidDate) this.#string = this.#date.toISOString();
-    else this.#string = 'Invalid Date';
-  }
-
-  /**
-   * Get date and time components
-   */
-  get parts() {
-    return this.#parsed;
-  }
-
-  /**
-   * Get timezone
-   */
-  get timezone() {
-    return this.parts?.timezone ?? 'UTC';
-  }
-
-  /**
-   * Parse a string in ISO DateTime format.
-   * If the input is valid, returns date and time components;
-   * otherwise, returns `undefined`.
-   */
-  static parse(isoDatetime: string) {
-    const isoDatetimeParts = isoDatetime.match(isoDateTimeRegEx);
-    if (isoDatetimeParts) {
-      const dateParts = isoDatetimeParts[1] && isoDatetimeParts[1].match(dateRegEx);
-      if (!dateParts) return undefined;
-      const parsedDateTime: ParsedDateTime = {
-        date: { year: dateParts[1], month: dateParts[2], day: dateParts[3] },
-      };
-
-      const timeParts = isoDatetimeParts[3] && isoDatetimeParts[3].match(timeRegEx);
-      if (timeParts) {
-        parsedDateTime.time = {
-          hours: timeParts[1],
-          minutes: timeParts[2],
-          seconds: timeParts[3],
-          milliseconds: timeParts[5],
-        };
-      }
-
-      const tzParts = isoDatetimeParts[4] && isoDatetimeParts[4].match(timezoneRegEx);
-      if (tzParts) {
-        parsedDateTime.timezone = tzParts[0] as ISOTimezone;
-      }
-
-      return parsedDateTime;
-    }
-
-    return undefined;
-  }
-
-  static getISOString(parts?: ParsedDateTime) {
-    if (!parts) return 'Invalid Date';
-    return `${parts.date.year}-${parts.date.month ?? '01'}-${parts.date.day ?? '01'}T${parts.time?.hours ?? '00'}:${parts.time?.minutes ?? '00'}:${parts.time?.seconds ?? '00'}.${parts.time?.milliseconds ?? '000'}${parts.timezone ?? 'Z'}`;
-  }
-
-  /**
-   * Retruns ISO date and time string
-   */
-  static toString(parsedDateTime: string): string;
-  static toString(parsedDateTime: ISODateTime): string;
-  static toString(dateTime: ISODateTime | string) {
-    const _p = typeof dateTime === 'string' ? ISODateTime.parse(dateTime) : dateTime.parts;
-
-    return ISODateTime.getISOString(_p);
-  }
-
-  /**
-   * Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC.
-   */
-  valueOf() {
-    if (this.#date === InvalidDate) return Number.NaN;
-
-    return this.#date.valueOf();
-  }
-
-  /**
-   * Retruns ISO date and time string
-   */
-  toString() {
-    return this.#string;
-  }
-
-  /**
-   * Retruns Javascript date object
-   */
-  toDate() {
-    return this.#date;
-  }
-
-  get [Symbol.toStringTag]() {
-    return 'ISODateTime';
-  }
-
-  [Symbol.toPrimitive](hint: 'default'): number;
-  [Symbol.toPrimitive](hint: 'string'): string;
-  [Symbol.toPrimitive](hint: 'number'): number;
-  [Symbol.toPrimitive](hint: string) {
-    if (hint === 'string') return this.toString();
-
-    return this.valueOf();
-  }
-
-  toJSON() {
-    return this.toString();
-  }
-
-  private static getFormatter(isoDatetime: ISODateTime, config?: DateFormatterConfig) {
-    let _format: Partial<Intl.DateTimeFormatOptions> = {};
-
-    if (config?.customFormat?.dateStyle || config?.customFormat?.timeStyle) {
-      _format = {
-        dateStyle: config?.customFormat?.dateStyle,
-        timeStyle: config?.customFormat?.timeStyle,
-      };
-    } else {
-      if (config?.noDate === true && config?.noTime === true) {
-        _format = { ...config.customFormat };
-      } else if (config?.noDate === true && !config?.noTime) {
-        _format = { ...DefaultTimeFormat, ...config.customFormat };
-      } else if (config?.noTime === true && !config.noDate) {
-        _format = { ...DefaultDateFormat, ...config.customFormat };
-      } else {
-        _format = { ...DefaultDateFormat, ...DefaultTimeFormat, ...config?.customFormat };
-      }
-    }
-
-    if (config?.customFormat?.timeZone) _format.timeZone = config.customFormat.timeZone;
-    else if (isoDatetime.parts?.time === undefined) _format.timeZone = 'UTC';
-    else _format.timeZone = DefaultTimezone;
-
-    return new Intl.DateTimeFormat('en', _format);
-  }
-
-  /**
-   * Returns formated date and time string
-   */
-  static format(isoDatetime: string, config?: DateFormatterConfig): string;
-  static format(isoDatetime: ISODateTime, config?: DateFormatterConfig): string;
-  static format(isoDatetime: ISODateTime | string, config?: DateFormatterConfig) {
-    const _isoDatetime = typeof isoDatetime === 'string' ? new ISODateTime(isoDatetime) : isoDatetime;
-
-    const _date = _isoDatetime.toDate();
-    if (_date === InvalidDate) return _isoDatetime.toString();
-
-    const formatter = ISODateTime.getFormatter(_isoDatetime, config);
-    return formatter.format(_date);
-  }
-
-  /**
-   * Returns formated date and time range string
-   */
-  static formatRange(startDate: string, endDate: string, config?: DateFormatterConfig): string;
-  static formatRange(startDate: ISODateTime, endDate: ISODateTime, config?: DateFormatterConfig): string;
-  static formatRange(startDate: ISODateTime | string, endDate: ISODateTime | string, config?: DateFormatterConfig) {
-    const _startISODateTime = typeof startDate === 'string' ? new ISODateTime(startDate) : startDate;
-
-    const _startDate = _startISODateTime.toDate();
-    if (_startDate === InvalidDate) return _startISODateTime.toString();
-
-    const _endISODateTime = typeof endDate === 'string' ? new ISODateTime(endDate) : endDate;
-    const _endDate = _endISODateTime.toDate();
-    if (_endDate === InvalidDate) return _endISODateTime.toString();
-
-    if (_startISODateTime.timezone !== _endISODateTime.timezone) throw 'Start and end dates in different time zones';
-
-    const formatter = ISODateTime.getFormatter(_startISODateTime, config);
-
-    const formatedRange = formatter.formatRange(_startDate, _endDate).replace(/\s/g, ' ');
-
-    // normalize space usage,
-    // `formatRange` uses u+202f to separate the parts in some systems and the standard space in the others
-    return formatedRange.replace(/\s/g, ' ');
-  }
-
-  /**
-   * Returns formated date and time string
-   */
-  format(config?: DateFormatterConfig) {
-    return ISODateTime.format(this, config);
-  }
-
-  /**
-   * Adds milliseconds to the date and returns it as a new ISODateTime object
-   */
-  addMillisecond(milliseconds: number) {
-    return new ISODateTime(this.valueOf() + milliseconds);
-  }
-  /**
-   * Adds seconds to the date and returns it as a new ISODateTime object
-   */
-  addSecond(seconds: number) {
-    return this.addMillisecond(seconds * 1000);
-  }
-  /**
-   * Adds minutes to the date and returns it as a new ISODateTime object
-   */
-  addMinute(minutes: number) {
-    return this.addMillisecond(minutes * 60_000);
-  }
-  /**
-   * Adds hours to the date and returns it as a new ISODateTime object
-   */
-  addHour(hours: number) {
-    return this.addMillisecond(hours * 3_600_000);
-  }
-  /**
-   * Adds days to the date and returns it as a new ISODateTime object
-   */
-  addDay(days: number) {
-    return this.addMillisecond(days * 86_400_000);
-  }
-
-  /**
-   * Returns the start of the previous month as a new ISODateTime object
-   */
-  static getPrevMonthStart(date: ISODateTime) {
-    if (date.parts) {
-      const month = date.parts.date.month ? Number(date.parts.date.month) : 1;
-      const prevMonth = month === 1 ? 12 : month - 1;
-      const year = month === 1 ? (Number(date.parts.date.year) - 1).toString() : date.parts.date.year;
-      const prevParts: ParsedDateTime = {
-        date: {
-          year: year,
-          month: prevMonth.toString().padStart(2, '0'),
-          day: '01',
-        },
-        timezone: date.parts.timezone,
-      };
-
-      return new ISODateTime(ISODateTime.getISOString(prevParts));
-    }
-
-    return date;
-  }
-
-  /**
-   * Returns the start of the previous month as a new ISODateTime object
-   */
-  getPrevMonthStart() {
-    return ISODateTime.getPrevMonthStart(this);
-  }
-
-  /**
-   * Returns the start of the next month as a new ISODateTime object
-   */
-  static getNextMonthStart(date: ISODateTime) {
-    if (date.parts) {
-      const month = date.parts.date.month ? Number(date.parts.date.month) : 1;
-      const nextMonth = (month % 12) + 1;
-      const year = month === 12 ? (Number(date.parts.date.year) + 1).toString() : date.parts.date.year;
-
-      const nextParts: ParsedDateTime = {
-        date: {
-          year: year,
-          month: nextMonth.toString().padStart(2, '0'),
-          day: '01',
-        },
-        timezone: date.parts.timezone,
-      };
-
-      return new ISODateTime(ISODateTime.getISOString(nextParts));
-    }
-
-    return date;
-  }
-
-  /**
-   * Returns the start of the next month as a new ISODateTime object
-   */
-  getNextMonthStart() {
-    return ISODateTime.getNextMonthStart(this);
-  }
-}
-
-interface ISODateParts {
-  year: string;
-  month?: string;
-  day?: string;
-}
-
-interface ISOTimeParts {
-  hours: string;
-  minutes?: string;
-  seconds?: string;
-  milliseconds?: string;
-}
-
-type ISOTimezone = 'Z' | `${'+' | '-'}${string}`;
-
-export interface ParsedDateTime {
-  date: ISODateParts;
-  time?: ISOTimeParts;
-  timezone?: ISOTimezone;
-}
-
-export type DateFormatOptions = Partial<Intl.DateTimeFormatOptions>;
-
-export interface DateFormatterConfig {
-  noDate?: boolean;
-  noTime?: boolean;
-  customFormat?: DateFormatOptions;
-}

package/src/duration/add-durations.ts

@@ -1,16 +0,0 @@
-import { toNumber } from "./to-number";
-
-export function addDuration(left: string, right: string) {
-  const totalDurationInSeconds =
-    toNumber(left, "second") + toNumber(right, "second");
-
-  const hours = Math.floor(totalDurationInSeconds / 3600)
-    .toString()
-    .padStart(2, "0");
-  const minutes = Math.floor((totalDurationInSeconds % 3600) / 60)
-    .toString()
-    .padStart(2, "0");
-  const seconds = (totalDurationInSeconds % 60).toString().padStart(2, "0");
-
-  return `${hours}:${minutes}:${seconds}`;
-}

package/src/duration/index.ts

@@ -1,3 +0,0 @@
-export * from "./is-duration";
-export * from "./to-number";
-export * from "./add-durations";

package/src/duration/is-duration.ts

@@ -1,5 +0,0 @@
-const durationRegExp = /^\d{2}:\d{2}:\d{2}$/;
-
-export function isDuration(duration: string) {
-  return durationRegExp.test(duration);
-}

package/src/duration/to-number.ts

@@ -1,18 +0,0 @@
-import { isDuration } from "./is-duration";
-
-export function toNumber(
-  duration: string,
-  unit: "hour" | "minute" | "second" = "hour",
-) {
-  if (!isDuration(duration)) {
-    console.error(new Error(`Malformed duration value: ${duration}`));
-    return 0;
-  }
-
-  const parts = duration.split(":").map((p) => Number(p));
-
-  if (unit === "minute") return parts[0] * 60 + parts[1] + parts[2] / 60;
-  if (unit === "second") return parts[0] * 3600 + parts[1] * 60 + parts[2];
-
-  return parts[0] + parts[1] / 60 + parts[2] / 3600;
-}

package/src/format/formatter.ts

@@ -1,37 +0,0 @@
-export const dateFormatter = new Intl.DateTimeFormat("en", {
-  dateStyle: "full",
-  timeStyle: "short",
-  timeZone: "America/Vancouver",
-});
-export const formatDate = (date?: Date | null) => {
-  if (date) return dateFormatter.format(date);
-  return "";
-};
-
-const listFormatter = new Intl.ListFormat("en", {
-  style: "long",
-  type: "conjunction",
-});
-
-export const formatList = (list?: string[] | null) => {
-  if (Array.isArray(list)) return listFormatter.format(list);
-  return "";
-};
-
-const numberFormatter = new Intl.NumberFormat("en", {
-  maximumFractionDigits: 2,
-});
-export const formatNumber = (num?: number | null) => {
-  if (num) return numberFormatter.format(num);
-  return "";
-};
-
-const currencyFormatter = new Intl.NumberFormat("en", {
-  style: "currency",
-  currency: "CAD",
-  maximumFractionDigits: 2,
-});
-export const formatCurrency = (num?: number | null) => {
-  if (num) return currencyFormatter.format(num);
-  return "";
-};

package/src/format/index.ts

@@ -1,3 +0,0 @@
-export * from "./formatter";
-export * from "./stringify";
-export * from "./template";

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,
-    );