@splendidlabz/utils 1.11.3 → 1.11.5

package/dist/types/lib/objects/split.d.cts

@@ -0,0 +1,14 @@
+/**
+ * Split on object up based on the keys provided.
+ * @param {Object} obj
+ * @param {Array} keys
+ * @returns
+ */
+declare function splitObject(obj: any, keys: any[]): {
+    picked: {};
+    omitted: any;
+    p: {};
+    o: any;
+};
+
+export { splitObject };

package/dist/types/lib/promises/index.d.cts

@@ -0,0 +1 @@
+export { reject } from './reject.cjs';

package/dist/types/lib/promises/reject.d.cts

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

package/dist/types/lib/sse.d.cts

@@ -0,0 +1,18 @@
+declare function createSSE({ event, data, id, retry }: {
+    event: any;
+    data: any;
+    id: any;
+    retry: any;
+}): string;
+/**
+ * Parses a single SSE message into a structured object
+ * @param {string} message - The raw SSE message
+ * @returns {Object|null} The parsed message or null if invalid
+ * @property {string} [event] - The event type if specified
+ * @property {string|Object} data - The message data (parsed as JSON if possible)
+ * @property {string} [id] - The message ID if specified
+ * @property {number} [retry] - The retry interval if specified
+ */
+declare function parseSSE(message: string): any | null;
+
+export { createSSE, parseSSE };

package/dist/types/lib/strings/convert-case/convert-case.d.cts

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

package/dist/types/lib/strings/index.d.cts

@@ -0,0 +1,5 @@
+export { toCamel, toKebab, toLower, toPascal, toSentence, toSlug, toTitle, toUpper } from './convert-case/convert-case.cjs';
+export { markdown, treatMarkdownWhitespace } from './markdown.cjs';
+export { parseFullName } from './name.cjs';
+export { pluralize } from './pluralize.cjs';
+export { plural, stripNumbers, toQueryString } from './query-string.cjs';

package/dist/types/lib/strings/markdown.d.cts

@@ -0,0 +1,25 @@
+/**
+ * Converts markdown content to HTML with whitespace handling
+ * @param {string} content - Markdown content to convert
+ * @param {Object} [options={}] - Conversion options
+ * @param {boolean} [options.inline=false] - Whether content should be treated as inline markdown
+ * @returns {string} Converted HTML string
+ */
+declare function markdown(content: string, options?: {
+    inline?: boolean;
+}): string;
+/**
+ * Handles whitespace in markdown content to ensure proper rendering
+ * @param {string} content - Markdown content to process
+ * @param {Object} [options={}] - Processing options
+ * @param {boolean} [options.inline=false] - Whether content is inline markdown
+ * @returns {{ content: string, inline: boolean }} Processed content and inline status
+ */
+declare function treatMarkdownWhitespace(content: string, { inline }?: {
+    inline?: boolean;
+}): {
+    content: string;
+    inline: boolean;
+};
+
+export { markdown, treatMarkdownWhitespace };

package/dist/types/lib/strings/name.d.cts

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

package/dist/types/lib/strings/pluralize.d.cts

@@ -0,0 +1,3 @@
+declare const pluralize: any;
+
+export { pluralize };

package/dist/types/lib/strings/query-string.d.cts

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

package/dist/types/lib/style/index.d.cts

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

package/dist/types/lib/symbols/index.d.cts

@@ -0,0 +1 @@
+export { getSymbol, getSymbolValue } from './symbols.cjs';

package/dist/types/lib/symbols/symbols.d.cts

@@ -0,0 +1,4 @@
+declare function getSymbol(object: any, description: any): symbol;
+declare function getSymbolValue(object: any, description: any): any;
+
+export { getSymbol, getSymbolValue };

package/dist/types/node/context.d.cts

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

package/dist/types/node/dirname.d.cts

@@ -0,0 +1,9 @@
+/**
+ * Returns __dirname
+ * @param url — import.meta.url
+ * @returns
+ */
+declare function __dirname$1(url: any): string;
+declare function dirname(url: any): string;
+
+export { __dirname$1 as __dirname, dirname };

package/dist/types/node/file-cache.d.cts

@@ -0,0 +1,56 @@
+/**
+ * Creates a file cache instance for managing cached files in a directory
+ * @param {string} dir - Absolute or relative path to cache directory
+ * @returns {Promise<object>} Cache instance
+ * @property {function(string): Promise<number>} cacheAt - Returns the cached file's modified timestamp, or directory's last modified time if no file specified
+ * @property {function(string): string} getAbsPath - Returns absolute path for a file in cache
+ * @property {function(string): Promise<boolean>} hasFile - Checks if a file exists in cache
+ * @property {function(string): Promise<Buffer|undefined>} loadFile - Loads file contents from cache
+ * @property {function(string, string|Buffer): Promise<void>} saveFile - Saves data to cache file
+ * @property {function(string): Promise<object>} loadJSON - Loads and parses JSON from cache file
+ * @property {function(string, object): Promise<void>} saveJSON - Saves object as JSON to cache file
+ */
+declare function createCache(dir: string): Promise<object>;
+/**
+ * Legacy file cache API for managing a single cached file
+ * @param {Object} options
+ * @param {string} options.dir - Absolute or relative path to cache directory
+ * @param {string} options.file - Filename to cache
+ * @returns {Promise<{
+ *   modifiedAt: number,
+ *   load: () => Promise<Buffer>,
+ *   save: (data: string|Buffer) => Promise<void>,
+ *   loadJSON: () => Promise<object>,
+ *   saveJSON: (data: object) => Promise<void>
+ * }>}
+ */
+declare function fileCache({ dir, file }: {
+    dir: string;
+    file: string;
+}): Promise<{
+    modifiedAt: number;
+    load: () => Promise<Buffer>;
+    save: (data: string | Buffer) => Promise<void>;
+    loadJSON: () => Promise<object>;
+    saveJSON: (data: object) => Promise<void>;
+}>;
+/**
+ * Gets the most recent modification time of files matching the glob pattern
+ * @param {string|string[]} globPath - Glob pattern(s) to match files
+ * @returns {Promise<number>} Timestamp of most recently modified file, or 0 if no files found
+ */
+declare function getLastModifiedTime(globPath: string | string[]): Promise<number>;
+/**
+ * @deprecated Use getLastModifiedTime instead
+ * @param {string|string[]} globPath - Glob pattern(s) to match files
+ * @returns {Promise<number>} Timestamp of most recently modified file, or 0 if no files found
+ */
+declare function getLatestModifiedTime(globPath: string | string[]): Promise<number>;
+/**
+ * Removes leading slash from a path string
+ * @param {string} x - Path string to process
+ * @returns {string} Path without leading slash
+ */
+declare function removeFirstSlash(x: string): string;
+
+export { createCache, fileCache, getLastModifiedTime, getLatestModifiedTime, removeFirstSlash };

package/dist/types/node/file.d.cts

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

package/dist/types/node/hash.d.cts

@@ -0,0 +1,3 @@
+declare function sha256Hash(string: any): string;
+
+export { sha256Hash };

package/dist/types/node/index.d.cts

@@ -0,0 +1,7 @@
+export { __dirname, dirname } from './dirname.cjs';
+export { createCache, fileCache, getLastModifiedTime, getLatestModifiedTime, removeFirstSlash } from './file-cache.cjs';
+export { sha256Hash } from './hash.cjs';
+export { PKCE, getCodeChallenge } from './pkce.cjs';
+export { randomString } from './random-string.cjs';
+export { sanitize } from './sanitize.cjs';
+export { uuid } from './uuid.cjs';

package/dist/types/node/pkce.d.cts

@@ -0,0 +1,14 @@
+declare function PKCE(): Promise<{
+    state: string;
+    code_verifier: string;
+    code_challenge: string;
+    code_challenge_method: string;
+}>;
+/**
+ * Generates code challenge in node
+ * @param {string} verifier
+ * @returns string
+ */
+declare function getCodeChallenge(verifier: string): string;
+
+export { PKCE, getCodeChallenge };

package/dist/types/node/random-string.d.cts

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

package/{src/node/sanitize.js → dist/types/node/sanitize.d.cts}

@@ -1,6 +1,3 @@
-import sanitizeHtml from 'sanitize-html'
-import { sanitize as sanitizeLib } from '../lib/form/sanitize.js'
-
 /**
  * Sanitizes values using sanitize-html
  * @param {*} value - Value to sanitize (string, array, or object)
@@ -8,6 +5,6 @@ import { sanitize as sanitizeLib } from '../lib/form/sanitize.js'
  * @returns {*} Sanitized value
  * @throws {Error} If input is a string but sanitize-html fails
  */
-export function sanitize(value, options = {}) {
-  return sanitizeLib(value, { sanitizer: sanitizeHtml, ...options })
-}
+declare function sanitize(value: any, options?: any): any;
+
+export { sanitize };

package/dist/types/node/uuid.d.cts

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

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "@splendidlabz/utils",
-  "version": "1.11.3",
+  "version": "1.11.5",
   "description": "",
   "type": "module",
   "homepage": "https://splendidlabz.com/docs/utils",
   "sideEffects": false,
+  "files": [
+    "dist"
+  ],
   "main": "./dist/cjs/lib/index.cjs",
   "module": "./dist/esm/lib/index.js",
   "types": "./dist/types/lib/index.d.cts",
@@ -54,23 +57,23 @@
   "author": "Zell Liew <zellwk@gmail.com>",
   "dependencies": {
     "deep-eql": "^5.0.2",
-    "dompurify": "^3.2.4",
-    "glob": "^11.0.0",
-    "markdown-it": "^14.1.0",
+    "dompurify": "^3.4.0",
+    "glob": "^13.0.6",
+    "markdown-it": "^14.1.1",
     "markdown-it-anchor": "^9.2.0",
-    "marked": "^15.0.7",
-    "marked-gfm-heading-id": "^4.1.1",
-    "marked-mangle": "^1.1.10",
+    "marked": "^18.0.2",
+    "marked-gfm-heading-id": "^4.1.4",
+    "marked-mangle": "^1.1.13",
     "pluralize": "^8.0.0",
-    "sanitize-html": "^2.17.0",
-    "statuses": "^2.0.1"
+    "sanitize-html": "^2.17.3",
+    "statuses": "^2.0.2"
   },
   "devDependencies": {
-    "@splendidlabz/eslint-config": "2.1.3",
-    "jsdom": "^26.0.0",
-    "np": "^10.2.0",
-    "tsup": "^8.0.0",
-    "typescript": "^5.4.2",
-    "vitest": "^3.1.1"
+    "@splendidlabz/eslint-config": "2.1.4",
+    "jsdom": "^29.0.2",
+    "np": "^11.1.0",
+    "tsup": "^8.5.1",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.4"
   }
 }

package/CHANGELOG.md

@@ -1,237 +0,0 @@
-# @splendidlabz/utils
-
-## 1.11.3
-
-### Patch Changes
-
-- 7b9b628: Added context utility
-
-## 1.11.2
-
-### Patch Changes
-
-- - Add `updateMasonryLayout` method to `masonry` nodes.
-
-## 1.11.1
-
-### Patch Changes
-
-- Fix auth jwt secret
-
-## 1.11.0
-
-### Minor Changes
-
-- Utils: Add isFunction
-
-## 1.10.7
-
-### Patch Changes
-
-- Allow fileCache to accept absolute urls
-
-## 1.10.6
-
-### Patch Changes
-
-- Bump
-
-## 1.10.5
-
-### Patch Changes
-
-- Fixed `env` in node
-
-## 1.10.4
-
-### Patch Changes
-
-- - Add env to utils/node.
-  - Allow JWT_SECRET to be retrieved from both import.meta.env and process.env
-
-## 1.10.3
-
-### Patch Changes
-
-- Prevent tsup from bundling — allows tree shaking
-
-## 1.10.2
-
-### Patch Changes
-
-- Built
-
-## 1.10.1
-
-### Patch Changes
-
-- Fix circular references and typescript errors
-
-## 1.10.0
-
-### Minor Changes
-
-- 4efacb3: - 6c636877 fix scroll observer
-  - 54effb06 add rlh
-
-## 1.9.1
-
-### Patch Changes
-
-- Replace Markdown with Markdown-it
-
-## 1.9.0
-
-### Minor Changes
-
-- 8f2cb34: - 48406c69 Add JSDocs for events
-  - 304b5310 Utils: Add runCallback
-
-## 1.8.2
-
-### Patch Changes
-
-- - abd0770c Add pipeAsync and composeAsync along with tests
-
-## 1.8.1
-
-### Patch Changes
-
-- Build
-
-## 1.8.0
-
-### Minor Changes
-
-- Several updates
-
-## 1.7.0
-
-### Minor Changes
-
-- 2c149fc: Now supports CJS
-- Many changes! Woo
-
-## 1.6.0
-
-### Minor Changes
-
-- Many many upgrades which I didn't document properly 😅. The details are in Github history, but too many details to talk about now.
-
-## 1.5.1
-
-### Patch Changes
-
-- - Utils: Added getFocusableElements as alias of Focusables
-  - Styles: Adjusted `grid-with-breakout` children classes and CSS properties. Wrote docs for it.
-
-## 1.5.0
-
-### Minor Changes
-
-- 859a2b0: Add utilities for SSE
-- acf9faf: Improve sort function
-- 8b17adc: Ready for next release
-- 5fe7c51: - Just bumping
-  - Fix bug with `mix` erroring when a `null` or `undefined` source is passed to it. `mix` now ignores `null` and `undefined`.
-  - Adds `toDegrees`
-  - Adds `toRadians`
-  - Adds `getCSSValue` and `setCSSValue`. They're aliases for `getCSSVar` and `setCSSVar` but they're more descriptive for standard properties.
-  - Renamed `hasLabel` to `checkForAccessibleName`
-  - Add `getParentElement` to get the parent element of a DOM node. If it encounters an `ASTRO-ISLAND` and `ASTRO-SLOT`, it goes one level up.
-
-### Patch Changes
-
-- df4f2d6: Simplified Markdown — so utils now contain a markdown function
-- Include typescript checks!
-- bb06596: Updates
-
-## 1.5.0-beta.6
-
-### Minor Changes
-
-- Add utilities for SSE
-
-## 1.5.0-beta.5
-
-### Minor Changes
-
-- Ready for next release
-
-## 1.5.0-alpha.4
-
-### Patch Changes
-
-- Updates
-
-## 1.5.0-alpha.3
-
-### Minor Changes
-
-- 5fe7c51: - Just bumping
-  - Fix bug with `mix` erroring when a `null` or `undefined` source is passed to it. `mix` now ignores `null` and `undefined`.
-  - Adds `toDegrees`
-  - Adds `toRadians`
-  - Adds `getCSSValue` and `setCSSValue`. They're aliases for `getCSSVar` and `setCSSVar` but they're more descriptive for standard properties.
-  - Renamed `hasLabel` to `checkForAccessibleName`
-  - Add `getParentElement` to get the parent element of a DOM node. If it encounters an `ASTRO-ISLAND` and `ASTRO-SLOT`, it goes one level up.
-
-## 1.5.0-alpha.2
-
-### Minor Changes
-
-- acf9faf: Improve sort function
-
-## 1.5.0-alpha.1
-
-### Patch Changes
-
-- df4f2d6: Simplified Markdown — so utils now contain a markdown function
-
-## 1.5.0-alpha.0
-
-### Minor Changes
-
-- Just bumping
-
-## 1.4.0
-
-### Minor Changes
-
-- Added a couple of improvements
-
-## 1.3.0
-
-### Minor Changes
-
-- a9128f4: Add Debounce and Throttle functions
-
-## 1.2.0
-
-### Minor Changes
-
-- a9128f4: - Add `uuid` to `utils/node`
-  - Add `uuid` to `utils/dom`
-  - Add `MONTHS` constant to `utils`
-
-### Patch Changes
-
-- a9128f4: - Change `randomString` in `utils/dom` to produce a HTML-usable string
-
-## 1.1.2
-
-### Patch Changes
-
-- Add query params path
-
-## 1.1.1
-
-### Patch Changes
-
-- Fix session store path
-
-## 1.1.0
-
-### Minor Changes
-
-- 2d5789f: New and better cache utility

package/eslint.config.js

@@ -1,2 +0,0 @@
-import config from '@splendidlabz/eslint-config'
-export default config

package/src/dom/accessibility.js

@@ -1,58 +0,0 @@
-// export function stopBodyScroll(element) {
-//   if (!element) element = document.body
-//   const top = document.documentElement.scrollTop
-//   element.style.top = -1 * top + 'px'
-//   element.style.overflow = 'hidden'
-// }
-
-// export function allowBodyScroll() {
-//   const top = parseFloat(document.body.style.top) * -1
-//   document.body.style.top = null
-//   document.body.style.overflow = null
-//   document.documentElement.scrollTop = top
-// }
-
-/**
- * Checks if an element has an accessible name through label or aria-labelledby
- * @param {string} [label] - The label text
- * @param {string} [labelledBy] - The aria-labelledby value
- * @returns {boolean} True if the element has an accessible name
- */
-export function hasAccessibleName(label, labelledBy) {
-  if (label || labelledBy) return true
-  return false
-}
-
-/**
- * Checks if an element has an accessible name and logs a warning/error if it doesn't
- * @param {Object} [options] - Options for checking accessible name
- * @param {string} [options.name] - The name of the element being checked
- * @param {string} [options.ariaLabel] - The aria-label value
- * @param {string} [options.ariaLabelledBy] - The aria-labelledby value
- * @param {'warn'|'error'} [options.severity='warn'] - Severity level for the message
- * @returns {boolean} True if the element has an accessible name
- */
-export function checkForAccessibleName({
-  name,
-  ariaLabel,
-  ariaLabelledBy,
-  severity = 'warn',
-} = {}) {
-  if (ariaLabel || ariaLabelledBy) return true
-
-  const message = `${name} is missing an accessible name. Please provide an accessible name with 'aria-label' or 'aria-labelledby'.`
-  if (severity === 'warn') console.warn(message)
-  if (severity === 'error') console.error(message)
-  return false
-}
-
-/**
- * Checks if an ARIA popup value is valid
- * @param {string} value - The ARIA popup value to check
- * @returns {boolean} True if the value is invalid
- */
-export function isInvalidAriaPopup(value) {
-  const allowedPopoupValues = ['dialog', 'menu', 'listbox', 'grid', 'tree']
-  if (!allowedPopoupValues.includes(value)) return true
-  return false
-}

package/src/dom/actions/index.js

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

package/src/dom/actions/masonry.js

@@ -1,43 +0,0 @@
-import { getChildrenElements } from '../get-element.js'
-import { mediaLoaded } from '../media.js'
-import { resizeObserver } from '../observers/resize-observer.js'
-
-export async function masonry(node) {
-  if (nativeMasonrySupport(node)) return
-
-  const colGap = parseFloat(getComputedStyle(node).columnGap)
-  const items = getChildrenElements(node)
-
-  node.style.setProperty('row-gap', '1px', 'important')
-  node.style.gridAutoRows = '0px'
-  node.updateMasonryLayout = _ => layout({ colGap, items })
-
-  try {
-    await mediaLoaded(node)
-  } catch (e) {}
-
-  layout({ colGap, items })
-
-  const obs = resizeObserver(node, {
-    async callback(opts) {
-      layout({ colGap, items })
-    },
-  })
-
-  async function layout({ colGap, items }) {
-    items.forEach(item => {
-      const ib = item.getBoundingClientRect()
-      item.style.gridRowEnd = `span ${Math.round(ib.height + colGap)}`
-    })
-  }
-
-  return {
-    destroy() {
-      obs.disconnect()
-    },
-  }
-}
-
-function nativeMasonrySupport(node) {
-  return getComputedStyle(node).gridTemplateRows === 'masonry'
-}