@splendidlabz/utils 1.6.0 → 1.8.1

package/{lib → src/lib}/date/time.js

@@ -16,10 +16,12 @@ export function ms(arg) {
   if (unit === 'hours') return getTimeInMs(value, 'hours')
   if (unit === 'm') return getTimeInMs(value, 'minutes')
   if (unit === 'min') return getTimeInMs(value, 'minutes')
+  if (unit === 'mins') return getTimeInMs(value, 'minutes')
   if (unit === 'minute') return getTimeInMs(value, 'minutes')
   if (unit === 'minutes') return getTimeInMs(value, 'minutes')
   if (unit === 's') return getTimeInMs(value, 'seconds')
   if (unit === 'sec') return getTimeInMs(value, 'seconds')
+  if (unit === 'secs') return getTimeInMs(value, 'seconds')
   if (unit === 'second') return getTimeInMs(value, 'seconds')
   if (unit === 'seconds') return getTimeInMs(value, 'seconds')
 
@@ -27,11 +29,6 @@ export function ms(arg) {
   return value
 }
 
-export function seconds(arg) {
-  const value = ms(arg)
-  return value / 1000
-}
-
 export function getTimeInMs(value, unit = 'ms') {
   switch (unit) {
     case 'ms':
@@ -48,3 +45,39 @@ export function getTimeInMs(value, unit = 'ms') {
       return value * 1000 * 60 * 60 * 24 * 7
   }
 }
+
+export function toWeeks(ms) {
+  return ms / 1000 / 60 / 60 / 24 / 7
+}
+
+export function toDays(ms) {
+  return ms / 1000 / 60 / 60 / 24
+}
+
+export function toHours(ms) {
+  return ms / 1000 / 60 / 60
+}
+
+export function toMinutes(ms) {
+  return ms / 1000 / 60
+}
+
+export function toSeconds(ms) {
+  return ms / 1000
+}
+
+// Get the total number of weeks, days, hours, minutes, and seconds
+export function toReadableTime(ms) {
+  const weekMs = 1000 * 60 * 60 * 24 * 7
+  const dayMs = 1000 * 60 * 60 * 24
+  const hourMs = 1000 * 60 * 60
+  const minuteMs = 1000 * 60
+
+  const weeks = Math.floor(ms / weekMs)
+  const days = Math.floor((ms % weekMs) / dayMs)
+  const hours = Math.floor((ms % dayMs) / hourMs)
+  const minutes = Math.floor((ms % hourMs) / minuteMs)
+  const seconds = Math.floor((ms % minuteMs) / 1000)
+
+  return { weeks, days, hours, minutes, seconds }
+}

package/{lib → src/lib}/numbers/index.js

@@ -4,7 +4,7 @@ export function splitUnit(string) {
   // If there are no units, return the number straight.
   if (typeof string === 'number') return [string, null]
 
-  const regex = /(-?\d*\.?\d+)([a-z]+)/i
+  const regex = /(-?\d*\.?\d+)\s*([a-z]+)/i
   const match = string.match(regex)
 
   if (match) return [parseFloat(match[1]), match[2]]

package/src/lib/numbers/split-unit.test.js

@@ -0,0 +1,45 @@
+import { describe, expect, test } from 'vitest'
+import { splitUnit } from './index.js'
+
+describe('splitUnit', () => {
+  test('handles number input', () => {
+    const result = splitUnit(42)
+    expect(result).toEqual([42, null])
+  })
+
+  test('handles unitless string numbers', () => {
+    const result = splitUnit('100')
+    expect(result).toEqual([100, null])
+  })
+
+  test('handles "3hours" without space', () => {
+    const result = splitUnit('3hours')
+    expect(result).toEqual([3, 'hours'])
+  })
+
+  test('handles "2rem" CSS unit', () => {
+    const result = splitUnit('2rem')
+    expect(result).toEqual([2, 'rem'])
+  })
+
+  test('handles decimal values', () => {
+    const result = splitUnit('1.5em')
+    expect(result).toEqual([1.5, 'em'])
+  })
+
+  test('handles negative values', () => {
+    const result = splitUnit('-10px')
+    expect(result).toEqual([-10, 'px'])
+  })
+
+  // Tests with spaces
+  test('handles values with spaces', () => {
+    const result = splitUnit('30 days')
+    expect(result).toEqual([30, 'days'])
+  })
+
+  test('handles values with many spaces between number and unit', () => {
+    const result = splitUnit('10   em')
+    expect(result).toEqual([10, 'em'])
+  })
+})

package/src/lib/objects/mix/mix.js

@@ -0,0 +1,191 @@
+const DEFAULT_OPTIONS = { array: 'replace' } // Can be concat or replace
+
+/**
+ * Deep merges multiple objects into a new object with intelligent handling of arrays and nested objects.
+ *
+ * @param {...Object} sources - Objects to merge. Null and undefined values are skipped.
+ * @return {Object} A new object containing the merged properties from all sources.
+ *
+ * @example
+ * const obj1 = { a: 1, b: { x: 10 } }
+ * const obj2 = { b: { y: 20 }, c: 3 }
+ * const result = mix(obj1, obj2)
+ * // Returns: { a: 1, b: { x: 10, y: 20 }, c: 3 }
+ */
+export const mix = createMix()
+export const concatMix = createMix({ array: 'concat' })
+
+/**
+ * Creates a customized mix function with specific options for array handling.
+ *
+ * @param {Object} [userOptions={}] - Configuration options for the mix function.
+ * @param {('replace'|'concat')} [userOptions.array='replace'] - How to handle array merging:
+ *   - 'replace': Arrays from later sources completely replace arrays from earlier sources
+ *   - 'concat': Arrays are concatenated together
+ * @return {Function} A mix function configured with the provided options.
+ *
+ * @example
+ * // Create mix function that concatenates arrays
+ * const concatMix = createMix({ array: 'concat' })
+ * const obj1 = { items: [1, 2] }
+ * const obj2 = { items: [3, 4] }
+ * const result = concatMix(obj1, obj2)
+ * // Returns: { items: [1, 2, 3, 4] }
+ *
+ * @example
+ * // Create mix function that replaces arrays (default behavior)
+ * const replaceMix = createMix({ array: 'replace' })
+ * const obj1 = { items: [1, 2] }
+ * const obj2 = { items: [3, 4] }
+ * const result = replaceMix(obj1, obj2)
+ * // Returns: { items: [3, 4] }
+ */
+export function createMix(userOptions = {}) {
+  const options = { ...DEFAULT_OPTIONS, ...userOptions }
+
+  function _mix(...sources) {
+    const result = {}
+    for (const source of sources) {
+      // Skip null or undefined sources
+      if (source == null) continue
+      merge(result, source, options)
+    }
+    return result
+  }
+
+  return _mix
+}
+
+/**
+ * Recursively merges properties from input object into output object.
+ * Handles property descriptors, prevents prototype pollution, and deep clones values.
+ *
+ * @param {Object} output - The target object to merge properties into.
+ * @param {Object} input - The source object to merge properties from.
+ * @param {Object} options - Merge options including array handling strategy.
+ * @property {('replace'|'concat')} options.array - How to handle array merging.
+ */
+function merge(output, input, options) {
+  const props = Object.keys(input)
+
+  for (const prop of props) {
+    // Prevents Prototype Pollution
+    if (prop === '__proto__') continue
+
+    const descriptor = Object.getOwnPropertyDescriptor(input, prop)
+    const value = descriptor.value
+    if (value) descriptor.value = cloneDescriptorValue(value)
+
+    // If don't have prop => Define property
+    if (!output[prop]) {
+      Object.defineProperty(output, prop, descriptor)
+      continue
+    }
+
+    // If have prop, but type is not object => Overwrite by redefining property
+    if (typeof output[prop] !== 'object') {
+      Object.defineProperty(output, prop, descriptor)
+      continue
+    }
+
+    // Incoming non-object (primitive/null) => always overwrite
+    if (descriptor.value == null || typeof descriptor.value !== 'object') {
+      Object.defineProperty(output, prop, descriptor)
+      continue
+    }
+
+    // If have prop, and incoming is Array => concat or replace
+    if (objectType(descriptor.value) === '[object Array]') {
+      output[prop] =
+        options.array === 'replace'
+          ? descriptor.value.slice()
+          : output[prop].concat(descriptor.value)
+      continue
+    }
+
+    // If have prop, but type is Object => Merge.
+    merge(output[prop], descriptor.value, options)
+
+    // Not sure if I have to deal with overwriting maps / dates. When it comes, I guess!
+  }
+}
+
+/**
+ * Creates a deep clone of a property descriptor value.
+ * Handles arrays, objects, dates, maps, sets, and other types appropriately.
+ *
+ * @param {*} value - The value to clone.
+ * @return {*} A deep clone of the input value.
+ * @property {Array} value - Cloned recursively with all elements deep cloned.
+ * @property {Object} value - Cloned with all properties and descriptors preserved.
+ * @property {Date} value - Cloned as new Date with same time value.
+ * @property {Map} value - Cloned with all entries deep cloned.
+ * @property {Set} value - Cloned with all entries deep cloned.
+ */
+function cloneDescriptorValue(value) {
+  // Arrays
+  if (objectType(value) === '[object Array]') {
+    const array = []
+    for (let v of value) {
+      v = cloneDescriptorValue(v)
+      array.push(v)
+    }
+    return array
+  }
+
+  // Objects
+  if (objectType(value) === '[object Object]') {
+    const obj = {}
+    const props = Object.keys(value)
+    for (const prop of props) {
+      const descriptor = Object.getOwnPropertyDescriptor(value, prop)
+      if (descriptor.value)
+        descriptor.value = cloneDescriptorValue(descriptor.value)
+      Object.defineProperty(obj, prop, descriptor)
+    }
+    return obj
+  }
+
+  // Other Types of Objects
+  if (objectType(value) === '[object Date]') {
+    return new Date(value.getTime())
+  }
+
+  if (objectType(value) === '[object Map]') {
+    const map = new Map()
+    for (const entry of value) {
+      map.set(entry[0], cloneDescriptorValue(entry[1]))
+    }
+    return map
+  }
+
+  if (objectType(value) === '[object Set]') {
+    const set = new Set()
+    for (const entry of value.entries()) {
+      set.add(cloneDescriptorValue(entry[0]))
+    }
+    return set
+  }
+
+  // Types we don't need to clone or cannot clone.
+  // Examples:
+  // - Primitives don't need to clone
+  // - Functions cannot clone
+  return value
+}
+
+/**
+ * Returns the precise object type of a value using Object.prototype.toString.
+ *
+ * @param {*} value - The value to get the type of.
+ * @return {string} The object type string (e.g., '[object Array]', '[object Object]', '[object Date]').
+ *
+ * @example
+ * objectType([]) // '[object Array]'
+ * objectType({}) // '[object Object]'
+ * objectType(new Date()) // '[object Date]'
+ * objectType(null) // '[object Null]'
+ */
+function objectType(value) {
+  return Object.prototype.toString.call(value)
+}

package/{lib → src/lib}/objects/mix/mix.test.js

@@ -1,6 +1,6 @@
 import { expect, it } from 'vitest'
 
-import { mix } from './mix.js'
+import { concatMix, createMix, mix } from './mix.js'
 
 it('Merge objects', () => {
   const one = { one: 'one', overwrite: 'nope' }
@@ -176,7 +176,8 @@ it('Double objects with nested same array', () => {
 
   const three = mix(one, two)
   expect(typeof three.array.push).toBe('function')
-  expect(three.array).toHaveLength(6)
+  expect(three.array).toHaveLength(3)
+  expect(three.array).toEqual([4, 5, 6])
 })
 
 it('Objects in Arrays', () => {
@@ -217,6 +218,54 @@ it('Deep nested arrays', () => {
   expect(two.array[1]).not.toBe(three.array[1])
 })
 
+it('concatMix: concatenates arrays', () => {
+  const one = {
+    array: [1, 2, 3],
+  }
+  const two = {
+    array: [4, 5, 6],
+  }
+
+  const three = concatMix(one, two)
+  expect(typeof three.array.push).toBe('function')
+  expect(three.array).toHaveLength(6)
+  expect(three.array).toEqual([1, 2, 3, 4, 5, 6])
+})
+
+it('concatMix: empty array concat', () => {
+  const one = {}
+  const two = { array: [1, 2, 3] }
+  const three = concatMix(one, two)
+
+  expect(three).toEqual(two)
+  expect(typeof three.array.push).toBe('function')
+  expect(three.array).toHaveLength(3)
+
+  // Prevent mutation
+  three.array.push(4)
+  expect(two.array).toHaveLength(3)
+  expect(three.array).toHaveLength(4)
+})
+
+it('concatMix: nested objects with concatenated arrays', () => {
+  const one = {
+    nested: {
+      items: [1, 2],
+      other: 'value1',
+    },
+  }
+  const two = {
+    nested: {
+      items: [3, 4],
+      other: 'value2',
+    },
+  }
+
+  const three = concatMix(one, two)
+  expect(three.nested.items).toEqual([1, 2, 3, 4])
+  expect(three.nested.other).toBe('value2')
+})
+
 it('Functions (cannot be cloned)', () => {
   const one = {}
   const two = {
@@ -346,3 +395,51 @@ it('should not skip null and false properties', () => {
 
   expect(mix(obj1, obj2)).toEqual(expected)
 })
+
+it('Real Nested Example', () => {
+  const defaultOpts = {
+    transforms: {
+      extractFromFileName: { date: 'pubDate', slug: 'slug' },
+      setLatestDate: {
+        targetProperty: 'date',
+        sourceProperties: ['pubDate', 'updateDate'],
+      },
+      generateExcerpt: true,
+      stripFileNumbering: true,
+      stripMore: true,
+    },
+    sort: {
+      props: ['data.date', 'data.pubDate', 'data.title'],
+      reverse: true,
+    },
+    filter: 'published',
+  }
+
+  const newOptions = {
+    transforms: {
+      extractFromFileName: false,
+      generateExcerpt: false,
+      stripMore: false,
+      // stripFileNumbering: true,
+    },
+    sort: { props: ['filePath'], reverse: false },
+    filter: false,
+  }
+  const expected = {
+    transforms: {
+      setLatestDate: {
+        targetProperty: 'date',
+        sourceProperties: ['pubDate', 'updateDate'],
+      },
+      extractFromFileName: false,
+      generateExcerpt: false,
+      stripFileNumbering: true,
+      stripMore: false,
+    },
+    sort: { props: ['filePath'], reverse: false },
+    filter: false,
+  }
+
+  const mixReplace = createMix({ array: 'replace' })
+  expect(mixReplace(defaultOpts, newOptions)).toEqual(expected)
+})

package/src/lib/strings/pluralize.js

@@ -0,0 +1,2 @@
+import pluralizeLib from 'pluralize'
+export const pluralize = pluralizeLib

package/{lib → src/lib}/style/index.js

@@ -1,6 +1,8 @@
 import { toKebab } from '../strings/convert-case/convert-case.js'
 
 export function toStyleString(style) {
+  if (!style) return null
+  if (typeof style === 'string') return style
   return Object.entries(style)
     .map(([k, v]) => {
       if (k.startsWith('--')) return `${k}:${v}`

package/{node → src/node}/file-cache.js

@@ -1,5 +1,5 @@
 import fs from 'fs/promises'
-import glob from 'glob-promise'
+import { glob } from 'glob'
 import path from 'node:path'
 import { sort } from '../lib/arrays/index.js'
 

package/tsconfig.json

@@ -6,18 +6,18 @@
     "allowJs": true,
     "checkJs": true,
     "declaration": true,
-    "emitDeclarationOnly": true,
-    "outDir": "./dist",
+    "emitDeclarationOnly": false,
+    "outDir": "./dist/temp",
     "strict": false,
     "noImplicitAny": false,
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,
     "resolveJsonModule": true,
     "isolatedModules": true,
-    "noEmit": false,
+    "noEmit": true,
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true
   },
-  "include": ["lib/**/*", "dom/**/*", "node/**/*"],
-  "exclude": ["node_modules", "**/*.test.js", "**/*.spec.js"]
-} 
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "**/*.test.js", "**/*.spec.js", "dist/**/*"]
+}

package/tsup.config.js

@@ -0,0 +1,38 @@
+import { defineConfig } from 'tsup'
+
+export default defineConfig([
+  // ESM build
+  {
+    entry: 'src/**/*.js',
+    format: ['esm'],
+    outDir: 'dist/esm',
+    clean: true,
+    splitting: false,
+    sourcemap: false,
+    dts: false,
+    ignoreWatch: ['**/*.test.js', '**/*.spec.js'],
+  },
+  // CJS build
+  {
+    entry: 'src/**/*.js',
+    format: ['cjs'],
+    outDir: 'dist/cjs',
+    outExtension: () => ({ js: '.cjs' }),
+    clean: false,
+    splitting: false,
+    sourcemap: false,
+    dts: false,
+    ignoreWatch: ['**/*.test.js', '**/*.spec.js'],
+  },
+  // Types build
+  {
+    entry: 'src/**/*.js',
+    dts: {
+      only: true,
+    },
+    outDir: 'dist/types',
+    outExtension: () => ({ dts: '.d.cts' }),
+    clean: false,
+    ignoreWatch: ['**/*.test.js', '**/*.spec.js'],
+  },
+])

package/tsup.config.mjs

@@ -0,0 +1,43 @@
+import { glob } from 'glob'
+import { defineConfig } from 'tsup'
+
+function getEntryPoints() {
+  // Get all JS files except test files
+  return glob.sync('src/**/*.js', {
+    ignore: ['**/*.test.js', '**/*.spec.js'],
+  })
+}
+
+export default defineConfig([
+  // ESM build
+  {
+    entry: getEntryPoints(),
+    format: ['esm'],
+    outDir: 'dist/esm',
+    clean: true,
+    splitting: false,
+    sourcemap: false,
+    dts: false,
+  },
+  // CJS build
+  {
+    entry: getEntryPoints(),
+    format: ['cjs'],
+    outDir: 'dist/cjs',
+    outExtension: () => ({ js: '.cjs' }),
+    clean: false,
+    splitting: false,
+    sourcemap: false,
+    dts: false,
+  },
+  // Types build
+  {
+    entry: getEntryPoints(),
+    dts: {
+      only: true,
+    },
+    outDir: 'dist/types',
+    outExtension: () => ({ dts: '.d.cts' }),
+    clean: false,
+  },
+])

package/dist/dom/actions/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./masonry.js";
-export * from "./prefer-horizontal-scroll.js";
-export * from "./sticky.js";

package/dist/dom/actions/masonry.d.ts

@@ -1,3 +0,0 @@
-export function masonry(node: any): Promise<{
-    destroy(): void;
-}>;

package/dist/dom/actions/prefer-horizontal-scroll.d.ts

@@ -1,3 +0,0 @@
-export function preferHorizontalScroll(node: any, props?: {}): {
-    destroy(): void;
-};

package/dist/dom/actions/sticky.d.ts

@@ -1,3 +0,0 @@
-export function sticky(node: any, props?: {}): {
-    destroy(): void;
-};

package/dist/dom/cookie.d.ts

@@ -1,5 +0,0 @@
-export function getCookie(name: any): any;
-export namespace cookies {
-    function get(name: any): any;
-    function set(name: any, value: any, days: any): void;
-}

package/dist/dom/css-vars.d.ts

@@ -1,4 +0,0 @@
-export function getCSSValue(element: any, prop: any): string;
-export function setCSSValue(element: any, prop: any, value: any): void;
-export function getCSSVar(element: any, prop: any): string;
-export function setCSSVar(element: any, prop: any, value: any): void;

package/dist/dom/events.d.ts

@@ -1,18 +0,0 @@
-export function addListeners(listeners: any): void;
-export function removeListeners(listeners: any): void;
-export function dispatchEvent(node: any, eventName: any, detail: any, options?: {}): void;
-export function updateEvent(event: any, updates: any): CustomEvent<any>;
-export function createListeners(listeners: any): {
-    readonly list: any;
-    add({ node, event, handler }: {
-        node: any;
-        event: any;
-        handler: any;
-    }): void;
-    remove({ node, event, handler }: {
-        node: any;
-        event: any;
-        handler: any;
-    }): void;
-    clear(): void;
-};

package/dist/dom/font-size.d.ts

@@ -1,5 +0,0 @@
-export function getUnit(value: any): any;
-export function em(element?: HTMLElement, multiple?: number): number;
-export function rem(multiple?: number): number;
-export function lh(element?: HTMLElement, multiple?: number): number;
-export function toPx(value: any, element?: any): number;

package/dist/dom/hash.d.ts

@@ -1 +0,0 @@
-export function sha256Hash(string: any): Promise<string>;

package/dist/dom/index.d.ts

@@ -1,22 +0,0 @@
-export * from "./accessibility.js";
-export * from "./actions/index.js";
-export * from "./bounding-box.js";
-export * from "./clipboard.js";
-export * from "./cookie.js";
-export * from "./css-vars.js";
-export * from "./events.js";
-export * from "./focusable.js";
-export * from "./font-size.js";
-export * from "./get-element.js";
-export * from "./hash.js";
-export * from "./keyboard.js";
-export * from "./local-store.js";
-export * from "./media.js";
-export * from "./observers/index.js";
-export * from "./pkce.js";
-export * from "./query-params.js";
-export * from "./random-string.js";
-export * from "./sanitize.js";
-export * from "./session-store.js";
-export * from "./trap-focus.js";
-export * from "./ui/index.js";

package/dist/dom/media.d.ts

@@ -1,3 +0,0 @@
-export function imagesLoaded(node: any): Promise<any[]>;
-export function videosLoaded(node: any): Promise<any[]>;
-export function mediaLoaded(node: any): Promise<[any[], any[]]>;

package/dist/dom/observers/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./intersection-observer.js";
-export * from "./mutation-observer.js";
-export * from "./resize-observer.js";

package/dist/dom/observers/observer.d.ts

@@ -1 +0,0 @@
-export function useObserverMethodOnTarget(target: any, observer: any, method?: string, options?: any): void;

package/dist/dom/ui/aria-current.d.ts

@@ -1,5 +0,0 @@
-export function markActiveAnchorIn(container: any, anchorType?: string): any;
-export function goToElement(element: any, { scrollBehaviour, scrollMargin }?: {
-    scrollBehaviour?: string;
-    scrollMargin?: string;
-}): void;

package/dist/dom/ui/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./aria-current.js";
-export * from "./inconsistent-button-fix.js";
-export * from "./scroll-container.js";
-export * from "./traverse-and-scramble.js";

package/dist/dom/ui/scroll-container.d.ts

@@ -1 +0,0 @@
-export function findScrollContainer(element: any, direction?: string): any;