@splendidlabz/utils 1.6.0 → 1.7.0

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

@@ -1,14 +1,24 @@
-export function mix(...sources) {
-  const result = {}
-  for (const source of sources) {
-    // Skip null or undefined sources
-    if (source == null) continue
-    merge(result, source)
+const DEFAULT_OPTIONS = { array: 'concat' }
+
+export const mix = createMix()
+
+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 result
+
+  return _mix
 }
 
-function merge(output, input) {
+function merge(output, input, options) {
   const props = Object.keys(input)
 
   for (const prop of props) {
@@ -31,14 +41,23 @@ function merge(output, input) {
       continue
     }
 
-    // If have prop, but type is Object => Concat the arrays together.
+    // 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] = output[prop].concat(descriptor.value)
+      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)
+    merge(output[prop], descriptor.value, options)
 
     // Not sure if I have to deal with overwriting maps / dates. When it comes, I guess!
   }

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

@@ -1,6 +1,6 @@
 import { expect, it } from 'vitest'
 
-import { mix } from './mix.js'
+import { createMix, mix } from './mix.js'
 
 it('Merge objects', () => {
   const one = { one: 'one', overwrite: 'nope' }
@@ -346,3 +346,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/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;

package/dist/lib/arrays/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./item-position.js";
-export * from "./join.js";
-export * from "./shuffle.js";
-export * from "./sort.js";
-export * from "./unique.js";

package/dist/lib/arrays/shuffle.d.ts

@@ -1 +0,0 @@
-export function shuffle(array: any): any;

package/dist/lib/arrays/unique.d.ts

@@ -1 +0,0 @@
-export function uniqueArray(array: any): any[];

package/dist/lib/auth/index.d.ts

@@ -1 +0,0 @@
-export * from "./route-manager.js";

package/dist/lib/date/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./days.js";
-export * from "./months.js";
-export * from "./time.js";

package/dist/lib/date/time.d.ts

@@ -1,8 +0,0 @@
-/**
- * Convert a time string to milliseconds
- * @param {string} arg - The time string to convert
- * @returns {number}
- */
-export function ms(arg: string): number;
-export function seconds(arg: any): number;
-export function getTimeInMs(value: any, unit?: string): any;

package/dist/lib/form/form-data.d.ts

@@ -1,7 +0,0 @@
-/**
- * Converts Form Data into an object
- * @param {FormData} formData
- * @returns Object
- */
-export function formDataToObject(formData: FormData): {};
-export function flattenArrayFields(inputObject: any): {};

package/dist/lib/form/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./form-data.js";
-export * from "./sanitize.js";

package/dist/lib/functions/debounce.d.ts

@@ -1 +0,0 @@
-export function debounce(callback: any, wait: any, immediate?: boolean): () => void;

package/dist/lib/functions/env.d.ts

@@ -1 +0,0 @@
-export function getEnv(): "browser" | "node";

package/dist/lib/functions/functional.d.ts

@@ -1,4 +0,0 @@
-export function curry(fn: any): (...args: any[]) => any;
-export function compose(...fns: any[]): (value: any) => any;
-export function pipe(...fns: any[]): (value: any) => any;
-export function times(fn: any, n: any): any[];

package/dist/lib/functions/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./debounce.js";
-export * from "./env.js";
-export * from "./functional.js";
-export * from "./throttle.js";
-export * from "./timeout.js";

package/dist/lib/functions/throttle.d.ts

@@ -1 +0,0 @@
-export function throttle(callback: any, wait: any): (...args: any[]) => void;

package/dist/lib/functions/timeout.d.ts

@@ -1,3 +0,0 @@
-export function timeout(wait: any, callback: any): void;
-export function delay(ms: any): Promise<any>;
-export function wait(ms: any): Promise<any>;

package/dist/lib/hash.d.ts

@@ -1 +0,0 @@
-export function isHashedValue(value: any, type?: string): boolean;

package/dist/lib/index.d.ts

@@ -1,14 +0,0 @@
-export * from "./arrays/index.js";
-export * from "./auth/index.js";
-export * from "./checks.js";
-export * from "./date/index.js";
-export * from "./form/index.js";
-export * from "./functions/index.js";
-export * from "./hash.js";
-export * from "./numbers/index.js";
-export * from "./objects/index.js";
-export * from "./promises/index.js";
-export * from "./sse.js";
-export * from "./strings/index.js";
-export * from "./style/index.js";
-export * from "./symbols/index.js";

package/dist/lib/numbers/index.d.ts

@@ -1,2 +0,0 @@
-export function splitUnit(string: any): any[];
-export * from "./math.js";

package/dist/lib/numbers/math.d.ts

@@ -1,2 +0,0 @@
-export function toDegrees(angle: any): number;
-export function toRadians(angle: any): number;

package/dist/lib/objects/camelcase-keys.d.ts

@@ -1 +0,0 @@
-export function camelCaseKeys(obj: any): any;

package/dist/lib/objects/empty.d.ts

@@ -1,2 +0,0 @@
-export function isEmpty(obj: any): boolean;
-export function notEmpty(obj: any): boolean;

package/dist/lib/objects/equal.d.ts

@@ -1,2 +0,0 @@
-export function isEqual(a: any, b: any): boolean;
-export function notEqual(a: any, b: any): boolean;

package/dist/lib/objects/extend.d.ts

@@ -1,4 +0,0 @@
-export function extendObject(object: any): {
-    orig: any;
-    extended: {};
-};

package/dist/lib/objects/flatten.d.ts

@@ -1,4 +0,0 @@
-export function flattenObject(obj: any, { separator, prefix }: {
-    separator: any;
-    prefix?: string;
-}): {};

package/dist/lib/objects/index.d.ts

@@ -1,13 +0,0 @@
-export * from "./camelcase-keys.js";
-export * from "./empty.js";
-export * from "./equal.js";
-export * from "./extend.js";
-export * from "./flatten.js";
-export * from "./json.js";
-export * from "./loop.js";
-export * from "./mix/mix.js";
-export * from "./nested-property.js";
-export * from "./normalize-object.js";
-export * from "./omit-empty.js";
-export * from "./size.js";
-export * from "./split.js";

package/dist/lib/objects/json.d.ts

@@ -1 +0,0 @@
-export function parseJSON(value: any, defaultValue?: {}): any;

package/dist/lib/objects/loop.d.ts

@@ -1,2 +0,0 @@
-export function objectForEach(object: any, callback: any): void;
-export function objectMap(object: any, callback: any): any[];

package/dist/lib/objects/mix/mix.d.ts

@@ -1 +0,0 @@
-export function mix(...sources: any[]): {};

package/dist/lib/objects/normalize-object.d.ts

@@ -1 +0,0 @@
-export function normalizeObject(object: any): any;

package/dist/lib/objects/omit-empty.d.ts

@@ -1 +0,0 @@
-export function omitEmpty(obj: any, shallow?: boolean): any;

package/dist/lib/objects/size.d.ts

@@ -1 +0,0 @@
-export function sizeOf(obj: any): string;

package/dist/lib/promises/index.d.ts

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

package/dist/lib/promises/reject.d.ts

@@ -1,3 +0,0 @@
-export function reject(props: any, { includeStack }?: {
-    includeStack?: boolean;
-}): Promise<never>;

package/dist/lib/strings/convert-case/convert-case.d.ts

@@ -1,8 +0,0 @@
-export function toKebab(string: any): any;
-export function toCamel(string: any): any;
-export function toPascal(string: any): any;
-export function toTitle(string: any): any;
-export function toSlug(string: any): any;
-export function toSentence(string: any): any;
-export function toUpper(string: any): any;
-export function toLower(string: any): any;

package/dist/lib/strings/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./convert-case/convert-case.js";
-export * from "./markdown.js";
-export * from "./name.js";
-export * from "./pluralize.js";
-export * from "./query-string.js";

package/dist/lib/strings/name.d.ts

@@ -1,5 +0,0 @@
-export function parseFullName(name: any): {
-    firstName: any;
-    middleName: any;
-    lastName: any;
-};

package/dist/lib/strings/pluralize.d.ts

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

package/dist/lib/strings/query-string.d.ts

@@ -1,8 +0,0 @@
-/**
- * Converts object into a query string
- * @param {Object} object
- * @returns
- */
-export function toQueryString(object: any): string;
-export function plural(count: any, noun: any, suffix?: string): string;
-export function stripNumbers(string: any): any;

package/dist/lib/style/index.d.ts

@@ -1 +0,0 @@
-export function toStyleString(style: any): string;

package/dist/lib/symbols/index.d.ts

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

package/dist/lib/symbols/symbols.d.ts

@@ -1,2 +0,0 @@
-export function getSymbol(object: any, description: any): symbol;
-export function getSymbolValue(object: any, description: any): any;

package/dist/node/common.d.ts

@@ -1 +0,0 @@
-export function uuid(): `${string}-${string}-${string}-${string}-${string}`;

package/dist/node/dirname.d.ts

@@ -1,7 +0,0 @@
-/**
- * Returns __dirname
- * @param url — import.meta.url
- * @returns
- */
-export function __dirname(url: any): string;
-export function dirname(url: any): string;

package/dist/node/file.d.ts

@@ -1,2 +0,0 @@
-export function mkdir(path: any): Promise<string>;
-export function copyFile(from: any, to: any): Promise<void>;

package/dist/node/hash.d.ts

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

package/dist/node/index.d.ts

@@ -1,7 +0,0 @@
-export * from "./common.js";
-export * from "./dirname.js";
-export * from "./file-cache.js";
-export * from "./hash.js";
-export * from "./pkce.js";
-export * from "./random-string.js";
-export * from "./sanitize.js";

package/dist/node/random-string.d.ts

@@ -1 +0,0 @@
-export function randomString(length?: number): string;

package/lib/strings/pluralize.js

@@ -1,2 +0,0 @@
-import pluralize from 'pluralize'
-export { pluralize }