yummies 7.11.0 → 7.13.0

package/html.js

@@ -1,168 +1,257 @@
 import DOMPurify from "dompurify";
 import { blobToUrl } from "yummies/media";
-const getComputedColor = (color) => {
-  if (!color) return null;
-  const d = document.createElement("div");
-  d.style.color = color;
-  document.body.append(d);
-  const rgbcolor = globalThis.getComputedStyle(d).color;
-  const match = /rgba?\((\d+)\s*,\s*(\d+)\s*,\s*(\d+)\s*(,\s*\d+[.d+]*)*\)/g.exec(rgbcolor);
-  d.remove();
-  if (!match) return null;
-  return `${match[1]}, ${match[2]}, ${match[3]}`;
+//#region src/html.ts
+/**
+* ---header-docs-section---
+* # yummies/html
+*
+* ## Description
+*
+* DOM-centric utilities: sanitizing HTML with **DOMPurify**, computed style probes, downloads via
+* temporary anchors, and small string helpers for safe markup. Prefer these over `innerHTML` with
+* raw user input; keep CSP and server-side validation as the real security boundary.
+*
+* ## Usage
+*
+* ```ts
+* import { getComputedColor } from "yummies/html";
+* ```
+*/
+/**
+* Extracts an RGB value from any valid CSS color.
+*
+* Not recommended for frequent use because it triggers a reflow.
+*/
+var getComputedColor = (color) => {
+	if (!color) return null;
+	const d = document.createElement("div");
+	d.style.color = color;
+	document.body.append(d);
+	const rgbcolor = globalThis.getComputedStyle(d).color;
+	const match = /rgba?\((\d+)\s*,\s*(\d+)\s*,\s*(\d+)\s*(,\s*\d+[.d+]*)*\)/g.exec(rgbcolor);
+	d.remove();
+	if (!match) return null;
+	return `${match[1]}, ${match[2]}, ${match[3]}`;
 };
-const downloadUsingAnchor = (urlOrBlob, fileName) => {
-  const url = blobToUrl(urlOrBlob);
-  const a = document.createElement("a");
-  a.href = url;
-  a.download = fileName ?? "file";
-  a.target = "_blank";
-  document.body.append(a);
-  a.click();
-  a.remove();
+/**
+* Triggers a file download by creating and clicking a temporary anchor element.
+*
+* @example
+* ```ts
+* downloadUsingAnchor('/report.pdf', 'report.pdf');
+* ```
+*/
+var downloadUsingAnchor = (urlOrBlob, fileName) => {
+	const url = blobToUrl(urlOrBlob);
+	const a = document.createElement("a");
+	a.href = url;
+	a.download = fileName ?? "file";
+	a.target = "_blank";
+	document.body.append(a);
+	a.click();
+	a.remove();
 };
+/**
+* Surrounds string in an anchor tag
+*/
 function wrapTextToTagLink(link) {
-  const descr = String(link).replace(/^(https?:\/{0,2})?(w{3}\.)?/, "www.");
-  if (!/^https?:\/{2}/.test(link)) link = `http://${link}`;
-  return `<a href=${link} target="_blank">${descr}</a>`;
+	const descr = String(link).replace(/^(https?:\/{0,2})?(w{3}\.)?/, "www.");
+	if (!/^https?:\/{2}/.test(link)) link = `http://${link}`;
+	return `<a href=${link} target="_blank">${descr}</a>`;
 }
-const collectOffsetTop = (element) => {
-  let offsetTop = 0;
-  let node = element;
-  while (node != null) {
-    offsetTop += node.offsetTop;
-    node = node.parentElement;
-  }
-  return offsetTop;
+/**
+* Collects the cumulative `offsetTop` value through the element parent chain.
+*
+* @example
+* ```ts
+* const offsetTop = collectOffsetTop(document.getElementById('section'));
+* ```
+*/
+var collectOffsetTop = (element) => {
+	let offsetTop = 0;
+	let node = element;
+	while (node != null) {
+		offsetTop += node.offsetTop;
+		node = node.parentElement;
+	}
+	return offsetTop;
 };
-const skipEvent = (e) => {
-  e.preventDefault();
-  e.stopPropagation();
-  return false;
+/**
+* Prevents the default browser action and stops event propagation.
+*
+* @example
+* ```ts
+* button.addEventListener('click', (event) => skipEvent(event));
+* ```
+*/
+var skipEvent = (e) => {
+	e.preventDefault();
+	e.stopPropagation();
+	return false;
 };
-const globalScrollIntoViewForY = (node) => {
-  const scrollContainer = document.body;
-  const pageHeight = window.innerHeight;
-  const nodeBounding = node.getBoundingClientRect();
-  const scrollPagesCount = scrollContainer.scrollHeight / pageHeight;
-  const scrollPageNumber = Math.min(
-    Math.max(nodeBounding.top / pageHeight, 1),
-    scrollPagesCount
-  );
-  window.scroll({
-    top: scrollPageNumber * pageHeight,
-    behavior: "smooth"
-  });
+/**
+* Scrolls the page vertically to the viewport section containing the target element.
+*
+* @example
+* ```ts
+* globalScrollIntoViewForY(document.getElementById('footer')!);
+* ```
+*/
+var globalScrollIntoViewForY = (node) => {
+	const scrollContainer = document.body;
+	const pageHeight = window.innerHeight;
+	const nodeBounding = node.getBoundingClientRect();
+	const scrollPagesCount = scrollContainer.scrollHeight / pageHeight;
+	const scrollPageNumber = Math.min(Math.max(nodeBounding.top / pageHeight, 1), scrollPagesCount);
+	window.scroll({
+		top: scrollPageNumber * pageHeight,
+		behavior: "smooth"
+	});
 };
-const sanitizeDefaults = {
-  ALLOWED_TAGS: [
-    "a",
-    "article",
-    "b",
-    "blockquote",
-    "br",
-    "caption",
-    "code",
-    "del",
-    "details",
-    "div",
-    "em",
-    "h1",
-    "h2",
-    "h3",
-    "h4",
-    "h5",
-    "h6",
-    "hr",
-    "i",
-    "img",
-    "ins",
-    "kbd",
-    "li",
-    "main",
-    "ol",
-    "p",
-    "pre",
-    "section",
-    "span",
-    "strong",
-    "sub",
-    "summary",
-    "sup",
-    "table",
-    "tbody",
-    "td",
-    "th",
-    "thead",
-    "tr",
-    "u",
-    "ul"
-  ],
-  ALLOWED_ATTR: ["href", "target", "name", "src", "class"]
+var sanitizeDefaults = {
+	ALLOWED_TAGS: [
+		"a",
+		"article",
+		"b",
+		"blockquote",
+		"br",
+		"caption",
+		"code",
+		"del",
+		"details",
+		"div",
+		"em",
+		"h1",
+		"h2",
+		"h3",
+		"h4",
+		"h5",
+		"h6",
+		"hr",
+		"i",
+		"img",
+		"ins",
+		"kbd",
+		"li",
+		"main",
+		"ol",
+		"p",
+		"pre",
+		"section",
+		"span",
+		"strong",
+		"sub",
+		"summary",
+		"sup",
+		"table",
+		"tbody",
+		"td",
+		"th",
+		"thead",
+		"tr",
+		"u",
+		"ul"
+	],
+	ALLOWED_ATTR: [
+		"href",
+		"target",
+		"name",
+		"src",
+		"class"
+	]
 };
-const sanitizeHtml = (html, config) => {
-  return DOMPurify.sanitize(html || "", {
-    ...sanitizeDefaults,
-    ...config
-  });
+/**
+* Sanitizes HTML using the default allowlist merged with custom DOMPurify config.
+*
+* @example
+* ```ts
+* sanitizeHtml('<img src=x onerror=alert(1) />');
+* ```
+*/
+var sanitizeHtml = (html, config) => {
+	return DOMPurify.sanitize(html || "", {
+		...sanitizeDefaults,
+		...config
+	});
 };
-const checkElementHasParent = (element, parent) => {
-  let node = element;
-  if (!parent) return false;
-  while (node != null) {
-    if (node === parent) {
-      return true;
-    } else {
-      node = node.parentElement;
-    }
-  }
-  return false;
+/**
+* Checks whether the element is nested inside the provided parent element.
+*
+* @example
+* ```ts
+* checkElementHasParent(childElement, modalElement);
+* ```
+*/
+var checkElementHasParent = (element, parent) => {
+	let node = element;
+	if (!parent) return false;
+	while (node != null) if (node === parent) return true;
+	else node = node.parentElement;
+	return false;
 };
-const startViewTransitionSafety = (fn, params) => {
-  if (typeof document !== "undefined" && document.startViewTransition && !params?.disabled) {
-    return document.startViewTransition(fn);
-  }
-  fn();
+/**
+* Executes a function within a view transition if supported by the browser.
+*
+* @param {VoidFunction} fn - The function to be executed.
+* @returns {ViewTransition} - The result of the executed function.
+*
+* @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Document/startViewTransition | MDN: Document.startViewTransition}
+*/
+var startViewTransitionSafety = (fn, params) => {
+	if (typeof document !== "undefined" && document.startViewTransition && !params?.disabled) return document.startViewTransition(fn);
+	fn();
 };
-const calcScrollbarWidth = (elementToAppend = document.body) => {
-  const outer = document.createElement("div");
-  outer.style.visibility = "hidden";
-  outer.style.width = "100px";
-  outer.style.overflow = "scroll";
-  elementToAppend.append(outer);
-  const inner = document.createElement("div");
-  inner.style.width = "100%";
-  outer.append(inner);
-  const scrollbarWidth = outer.offsetWidth - inner.offsetWidth;
-  outer.parentNode?.removeChild(outer);
-  return scrollbarWidth;
+/**
+* Calculates the scrollbar width.
+*/
+var calcScrollbarWidth = (elementToAppend = document.body) => {
+	const outer = document.createElement("div");
+	outer.style.visibility = "hidden";
+	outer.style.width = "100px";
+	outer.style.overflow = "scroll";
+	elementToAppend.append(outer);
+	const inner = document.createElement("div");
+	inner.style.width = "100%";
+	outer.append(inner);
+	const scrollbarWidth = outer.offsetWidth - inner.offsetWidth;
+	outer.parentNode?.removeChild(outer);
+	return scrollbarWidth;
 };
+/**
+* Calculates the inner height of an HTML element, accounting for padding.
+*/
 function getElementInnerHeight(element) {
-  const { clientHeight } = element;
-  const { paddingTop, paddingBottom } = getComputedStyle(element);
-  return clientHeight - Number.parseFloat(paddingTop) - Number.parseFloat(paddingBottom);
+	const { clientHeight } = element;
+	const { paddingTop, paddingBottom } = getComputedStyle(element);
+	return clientHeight - Number.parseFloat(paddingTop) - Number.parseFloat(paddingBottom);
 }
+/**
+* Calculates the inner width of an HTML element, accounting for padding.
+*/
 function getElementInnerWidth(el) {
-  const { clientWidth } = el;
-  const { paddingLeft, paddingRight } = getComputedStyle(el);
-  return clientWidth - Number.parseFloat(paddingLeft) - Number.parseFloat(paddingRight);
+	const { clientWidth } = el;
+	const { paddingLeft, paddingRight } = getComputedStyle(el);
+	return clientWidth - Number.parseFloat(paddingLeft) - Number.parseFloat(paddingRight);
 }
-const isPrefersDarkTheme = () => !!globalThis.matchMedia?.("(prefers-color-scheme: dark)")?.matches;
-const isPrefersLightTheme = () => !!globalThis.matchMedia?.("(prefers-color-scheme: light)")?.matches;
-export {
-  calcScrollbarWidth,
-  checkElementHasParent,
-  collectOffsetTop,
-  downloadUsingAnchor,
-  getComputedColor,
-  getElementInnerHeight,
-  getElementInnerWidth,
-  globalScrollIntoViewForY,
-  isPrefersDarkTheme,
-  isPrefersLightTheme,
-  sanitizeHtml,
-  skipEvent,
-  startViewTransitionSafety,
-  wrapTextToTagLink
-};
-//# sourceMappingURL=html.js.map
+/**
+* Checks whether the user prefers a dark color scheme.
+*
+* @example
+* ```ts
+* const prefersDark = isPrefersDarkTheme();
+* ```
+*/
+var isPrefersDarkTheme = () => !!globalThis.matchMedia?.("(prefers-color-scheme: dark)")?.matches;
+/**
+* Checks whether the user prefers a light color scheme.
+*
+* @example
+* ```ts
+* const prefersLight = isPrefersLightTheme();
+* ```
+*/
+var isPrefersLightTheme = () => !!globalThis.matchMedia?.("(prefers-color-scheme: light)")?.matches;
+//#endregion
+export { calcScrollbarWidth, checkElementHasParent, collectOffsetTop, downloadUsingAnchor, getComputedColor, getElementInnerHeight, getElementInnerWidth, globalScrollIntoViewForY, isPrefersDarkTheme, isPrefersLightTheme, sanitizeHtml, skipEvent, startViewTransitionSafety, wrapTextToTagLink };
+
+//# sourceMappingURL=html.js.map

package/html.js.map

@@ -1 +1 @@
-{"version":3,"file":"html.js","sources":["../src/html.ts"],"sourcesContent":["import DOMPurify, { type Config as DOMPurifyConfig } from 'dompurify';\nimport { blobToUrl } from 'yummies/media';\nimport type { Maybe } from 'yummies/types';\n\n/**\n * Extracts an RGB value from any valid CSS color.\n *\n * Not recommended for frequent use because it triggers a reflow.\n */\nexport const getComputedColor = (color?: string): string | null => {\n  if (!color) return null;\n\n  const d = document.createElement('div');\n  d.style.color = color;\n  document.body.append(d);\n  const rgbcolor = globalThis.getComputedStyle(d).color;\n  const match =\n    /rgba?\\((\\d+)\\s*,\\s*(\\d+)\\s*,\\s*(\\d+)\\s*(,\\s*\\d+[.d+]*)*\\)/g.exec(rgbcolor);\n\n  d.remove();\n\n  if (!match) return null;\n\n  return `${match[1]}, ${match[2]}, ${match[3]}`;\n};\n\nexport const downloadUsingAnchor = (\n  urlOrBlob: string | Blob,\n  fileName?: string,\n) => {\n  const url = blobToUrl(urlOrBlob);\n\n  const a = document.createElement('a');\n  a.href = url;\n\n  a.download = fileName ?? 'file';\n\n  a.target = '_blank';\n\n  document.body.append(a);\n\n  a.click();\n\n  a.remove();\n};\n\n/**\n * Surrounds string in an anchor tag\n */\nexport function wrapTextToTagLink(link: string) {\n  const descr = String(link).replace(/^(https?:\\/{0,2})?(w{3}\\.)?/, 'www.');\n  if (!/^https?:\\/{2}/.test(link)) link = `http://${link}`;\n  return `<a href=${link} target=\"_blank\">${descr}</a>`;\n}\n\nexport const collectOffsetTop = (element: HTMLElement | null) => {\n  let offsetTop = 0;\n  let node = element;\n\n  while (node != null) {\n    offsetTop += node.offsetTop;\n    node = node.parentElement;\n  }\n\n  return offsetTop;\n};\n\nexport const skipEvent = (e: Event) => {\n  e.preventDefault();\n  e.stopPropagation();\n\n  return false;\n};\n\nexport const globalScrollIntoViewForY = (node: HTMLElement) => {\n  const scrollContainer = document.body;\n  const pageHeight = window.innerHeight;\n  const nodeBounding = node.getBoundingClientRect();\n  const scrollPagesCount = scrollContainer.scrollHeight / pageHeight;\n\n  const scrollPageNumber = Math.min(\n    Math.max(nodeBounding.top / pageHeight, 1),\n    scrollPagesCount,\n  );\n\n  window.scroll({\n    top: scrollPageNumber * pageHeight,\n    behavior: 'smooth',\n  });\n};\n\nconst sanitizeDefaults: DOMPurifyConfig = {\n  ALLOWED_TAGS: [\n    'a',\n    'article',\n    'b',\n    'blockquote',\n    'br',\n    'caption',\n    'code',\n    'del',\n    'details',\n    'div',\n    'em',\n    'h1',\n    'h2',\n    'h3',\n    'h4',\n    'h5',\n    'h6',\n    'hr',\n    'i',\n    'img',\n    'ins',\n    'kbd',\n    'li',\n    'main',\n    'ol',\n    'p',\n    'pre',\n    'section',\n    'span',\n    'strong',\n    'sub',\n    'summary',\n    'sup',\n    'table',\n    'tbody',\n    'td',\n    'th',\n    'thead',\n    'tr',\n    'u',\n    'ul',\n  ],\n  ALLOWED_ATTR: ['href', 'target', 'name', 'src', 'class'],\n};\n\nexport const sanitizeHtml = (html: Maybe<string>, config?: DOMPurifyConfig) => {\n  return DOMPurify.sanitize(html || '', {\n    ...sanitizeDefaults,\n    ...config,\n  });\n};\n\nexport const checkElementHasParent = (\n  element: HTMLElement | null,\n  parent: Maybe<HTMLElement>,\n) => {\n  let node = element;\n\n  if (!parent) return false;\n\n  while (node != null) {\n    if (node === parent) {\n      return true;\n    } else {\n      node = node.parentElement;\n    }\n  }\n\n  return false;\n};\n\n/**\n * Executes a function within a view transition if supported by the browser.\n *\n * @param {VoidFunction} fn - The function to be executed.\n * @returns {ViewTransition} - The result of the executed function.\n *\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Document/startViewTransition | MDN: Document.startViewTransition}\n */\nexport const startViewTransitionSafety = (\n  fn: VoidFunction,\n  params?: { disabled?: boolean },\n) => {\n  if (\n    typeof document !== 'undefined' &&\n    document.startViewTransition &&\n    !params?.disabled\n  ) {\n    return document.startViewTransition(fn);\n  }\n  fn();\n};\n\n/**\n * Calculates the scrollbar width.\n */\nexport const calcScrollbarWidth = (elementToAppend = document.body) => {\n  const outer = document.createElement('div');\n\n  outer.style.visibility = 'hidden';\n  outer.style.width = '100px';\n  outer.style.overflow = 'scroll';\n\n  elementToAppend.append(outer);\n\n  const inner = document.createElement('div');\n  inner.style.width = '100%';\n\n  outer.append(inner);\n\n  const scrollbarWidth = outer.offsetWidth - inner.offsetWidth;\n\n  outer.parentNode?.removeChild(outer);\n\n  return scrollbarWidth;\n};\n\n/**\n * Calculates the inner height of an HTML element, accounting for padding.\n */\nexport function getElementInnerHeight(element: HTMLElement) {\n  const { clientHeight } = element;\n  const { paddingTop, paddingBottom } = getComputedStyle(element);\n  return (\n    clientHeight -\n    Number.parseFloat(paddingTop) -\n    Number.parseFloat(paddingBottom)\n  );\n}\n\n/**\n * Calculates the inner width of an HTML element, accounting for padding.\n */\nexport function getElementInnerWidth(el: HTMLElement) {\n  const { clientWidth } = el;\n  const { paddingLeft, paddingRight } = getComputedStyle(el);\n  return (\n    clientWidth -\n    Number.parseFloat(paddingLeft) -\n    Number.parseFloat(paddingRight)\n  );\n}\n\nexport const isPrefersDarkTheme = () =>\n  !!globalThis.matchMedia?.('(prefers-color-scheme: dark)')?.matches;\n\nexport const isPrefersLightTheme = () =>\n  !!globalThis.matchMedia?.('(prefers-color-scheme: light)')?.matches;\n"],"names":[],"mappings":";;AASO,MAAM,mBAAmB,CAAC,UAAkC;AACjE,MAAI,CAAC,MAAO,QAAO;AAEnB,QAAM,IAAI,SAAS,cAAc,KAAK;AACtC,IAAE,MAAM,QAAQ;AAChB,WAAS,KAAK,OAAO,CAAC;AACtB,QAAM,WAAW,WAAW,iBAAiB,CAAC,EAAE;AAChD,QAAM,QACJ,6DAA6D,KAAK,QAAQ;AAE5E,IAAE,OAAA;AAEF,MAAI,CAAC,MAAO,QAAO;AAEnB,SAAO,GAAG,MAAM,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC;AAC9C;AAEO,MAAM,sBAAsB,CACjC,WACA,aACG;AACH,QAAM,MAAM,UAAU,SAAS;AAE/B,QAAM,IAAI,SAAS,cAAc,GAAG;AACpC,IAAE,OAAO;AAET,IAAE,WAAW,YAAY;AAEzB,IAAE,SAAS;AAEX,WAAS,KAAK,OAAO,CAAC;AAEtB,IAAE,MAAA;AAEF,IAAE,OAAA;AACJ;AAKO,SAAS,kBAAkB,MAAc;AAC9C,QAAM,QAAQ,OAAO,IAAI,EAAE,QAAQ,+BAA+B,MAAM;AACxE,MAAI,CAAC,gBAAgB,KAAK,IAAI,EAAG,QAAO,UAAU,IAAI;AACtD,SAAO,WAAW,IAAI,oBAAoB,KAAK;AACjD;AAEO,MAAM,mBAAmB,CAAC,YAAgC;AAC/D,MAAI,YAAY;AAChB,MAAI,OAAO;AAEX,SAAO,QAAQ,MAAM;AACnB,iBAAa,KAAK;AAClB,WAAO,KAAK;AAAA,EACd;AAEA,SAAO;AACT;AAEO,MAAM,YAAY,CAAC,MAAa;AACrC,IAAE,eAAA;AACF,IAAE,gBAAA;AAEF,SAAO;AACT;AAEO,MAAM,2BAA2B,CAAC,SAAsB;AAC7D,QAAM,kBAAkB,SAAS;AACjC,QAAM,aAAa,OAAO;AAC1B,QAAM,eAAe,KAAK,sBAAA;AAC1B,QAAM,mBAAmB,gBAAgB,eAAe;AAExD,QAAM,mBAAmB,KAAK;AAAA,IAC5B,KAAK,IAAI,aAAa,MAAM,YAAY,CAAC;AAAA,IACzC;AAAA,EAAA;AAGF,SAAO,OAAO;AAAA,IACZ,KAAK,mBAAmB;AAAA,IACxB,UAAU;AAAA,EAAA,CACX;AACH;AAEA,MAAM,mBAAoC;AAAA,EACxC,cAAc;AAAA,IACZ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EAAA;AAAA,EAEF,cAAc,CAAC,QAAQ,UAAU,QAAQ,OAAO,OAAO;AACzD;AAEO,MAAM,eAAe,CAAC,MAAqB,WAA6B;AAC7E,SAAO,UAAU,SAAS,QAAQ,IAAI;AAAA,IACpC,GAAG;AAAA,IACH,GAAG;AAAA,EAAA,CACJ;AACH;AAEO,MAAM,wBAAwB,CACnC,SACA,WACG;AACH,MAAI,OAAO;AAEX,MAAI,CAAC,OAAQ,QAAO;AAEpB,SAAO,QAAQ,MAAM;AACnB,QAAI,SAAS,QAAQ;AACnB,aAAO;AAAA,IACT,OAAO;AACL,aAAO,KAAK;AAAA,IACd;AAAA,EACF;AAEA,SAAO;AACT;AAUO,MAAM,4BAA4B,CACvC,IACA,WACG;AACH,MACE,OAAO,aAAa,eACpB,SAAS,uBACT,CAAC,QAAQ,UACT;AACA,WAAO,SAAS,oBAAoB,EAAE;AAAA,EACxC;AACA,KAAA;AACF;AAKO,MAAM,qBAAqB,CAAC,kBAAkB,SAAS,SAAS;AACrE,QAAM,QAAQ,SAAS,cAAc,KAAK;AAE1C,QAAM,MAAM,aAAa;AACzB,QAAM,MAAM,QAAQ;AACpB,QAAM,MAAM,WAAW;AAEvB,kBAAgB,OAAO,KAAK;AAE5B,QAAM,QAAQ,SAAS,cAAc,KAAK;AAC1C,QAAM,MAAM,QAAQ;AAEpB,QAAM,OAAO,KAAK;AAElB,QAAM,iBAAiB,MAAM,cAAc,MAAM;AAEjD,QAAM,YAAY,YAAY,KAAK;AAEnC,SAAO;AACT;AAKO,SAAS,sBAAsB,SAAsB;AAC1D,QAAM,EAAE,iBAAiB;AACzB,QAAM,EAAE,YAAY,kBAAkB,iBAAiB,OAAO;AAC9D,SACE,eACA,OAAO,WAAW,UAAU,IAC5B,OAAO,WAAW,aAAa;AAEnC;AAKO,SAAS,qBAAqB,IAAiB;AACpD,QAAM,EAAE,gBAAgB;AACxB,QAAM,EAAE,aAAa,iBAAiB,iBAAiB,EAAE;AACzD,SACE,cACA,OAAO,WAAW,WAAW,IAC7B,OAAO,WAAW,YAAY;AAElC;AAEO,MAAM,qBAAqB,MAChC,CAAC,CAAC,WAAW,aAAa,8BAA8B,GAAG;AAEtD,MAAM,sBAAsB,MACjC,CAAC,CAAC,WAAW,aAAa,+BAA+B,GAAG;"}
+{"version":3,"file":"html.js","names":[],"sources":["../src/html.ts"],"sourcesContent":["/**\n * ---header-docs-section---\n * # yummies/html\n *\n * ## Description\n *\n * DOM-centric utilities: sanitizing HTML with **DOMPurify**, computed style probes, downloads via\n * temporary anchors, and small string helpers for safe markup. Prefer these over `innerHTML` with\n * raw user input; keep CSP and server-side validation as the real security boundary.\n *\n * ## Usage\n *\n * ```ts\n * import { getComputedColor } from \"yummies/html\";\n * ```\n */\n\nimport DOMPurify, { type Config as DOMPurifyConfig } from 'dompurify';\nimport { blobToUrl } from 'yummies/media';\nimport type { Maybe } from 'yummies/types';\n\n/**\n * Extracts an RGB value from any valid CSS color.\n *\n * Not recommended for frequent use because it triggers a reflow.\n */\nexport const getComputedColor = (color?: string): string | null => {\n  if (!color) return null;\n\n  const d = document.createElement('div');\n  d.style.color = color;\n  document.body.append(d);\n  const rgbcolor = globalThis.getComputedStyle(d).color;\n  const match =\n    /rgba?\\((\\d+)\\s*,\\s*(\\d+)\\s*,\\s*(\\d+)\\s*(,\\s*\\d+[.d+]*)*\\)/g.exec(rgbcolor);\n\n  d.remove();\n\n  if (!match) return null;\n\n  return `${match[1]}, ${match[2]}, ${match[3]}`;\n};\n\n/**\n * Triggers a file download by creating and clicking a temporary anchor element.\n *\n * @example\n * ```ts\n * downloadUsingAnchor('/report.pdf', 'report.pdf');\n * ```\n */\nexport const downloadUsingAnchor = (\n  urlOrBlob: string | Blob,\n  fileName?: string,\n) => {\n  const url = blobToUrl(urlOrBlob);\n\n  const a = document.createElement('a');\n  a.href = url;\n\n  a.download = fileName ?? 'file';\n\n  a.target = '_blank';\n\n  document.body.append(a);\n\n  a.click();\n\n  a.remove();\n};\n\n/**\n * Surrounds string in an anchor tag\n */\nexport function wrapTextToTagLink(link: string) {\n  const descr = String(link).replace(/^(https?:\\/{0,2})?(w{3}\\.)?/, 'www.');\n  if (!/^https?:\\/{2}/.test(link)) link = `http://${link}`;\n  return `<a href=${link} target=\"_blank\">${descr}</a>`;\n}\n\n/**\n * Collects the cumulative `offsetTop` value through the element parent chain.\n *\n * @example\n * ```ts\n * const offsetTop = collectOffsetTop(document.getElementById('section'));\n * ```\n */\nexport const collectOffsetTop = (element: HTMLElement | null) => {\n  let offsetTop = 0;\n  let node = element;\n\n  while (node != null) {\n    offsetTop += node.offsetTop;\n    node = node.parentElement;\n  }\n\n  return offsetTop;\n};\n\n/**\n * Prevents the default browser action and stops event propagation.\n *\n * @example\n * ```ts\n * button.addEventListener('click', (event) => skipEvent(event));\n * ```\n */\nexport const skipEvent = (e: Event) => {\n  e.preventDefault();\n  e.stopPropagation();\n\n  return false;\n};\n\n/**\n * Scrolls the page vertically to the viewport section containing the target element.\n *\n * @example\n * ```ts\n * globalScrollIntoViewForY(document.getElementById('footer')!);\n * ```\n */\nexport const globalScrollIntoViewForY = (node: HTMLElement) => {\n  const scrollContainer = document.body;\n  const pageHeight = window.innerHeight;\n  const nodeBounding = node.getBoundingClientRect();\n  const scrollPagesCount = scrollContainer.scrollHeight / pageHeight;\n\n  const scrollPageNumber = Math.min(\n    Math.max(nodeBounding.top / pageHeight, 1),\n    scrollPagesCount,\n  );\n\n  window.scroll({\n    top: scrollPageNumber * pageHeight,\n    behavior: 'smooth',\n  });\n};\n\nconst sanitizeDefaults: DOMPurifyConfig = {\n  ALLOWED_TAGS: [\n    'a',\n    'article',\n    'b',\n    'blockquote',\n    'br',\n    'caption',\n    'code',\n    'del',\n    'details',\n    'div',\n    'em',\n    'h1',\n    'h2',\n    'h3',\n    'h4',\n    'h5',\n    'h6',\n    'hr',\n    'i',\n    'img',\n    'ins',\n    'kbd',\n    'li',\n    'main',\n    'ol',\n    'p',\n    'pre',\n    'section',\n    'span',\n    'strong',\n    'sub',\n    'summary',\n    'sup',\n    'table',\n    'tbody',\n    'td',\n    'th',\n    'thead',\n    'tr',\n    'u',\n    'ul',\n  ],\n  ALLOWED_ATTR: ['href', 'target', 'name', 'src', 'class'],\n};\n\n/**\n * Sanitizes HTML using the default allowlist merged with custom DOMPurify config.\n *\n * @example\n * ```ts\n * sanitizeHtml('<img src=x onerror=alert(1) />');\n * ```\n */\nexport const sanitizeHtml = (html: Maybe<string>, config?: DOMPurifyConfig) => {\n  return DOMPurify.sanitize(html || '', {\n    ...sanitizeDefaults,\n    ...config,\n  });\n};\n\n/**\n * Checks whether the element is nested inside the provided parent element.\n *\n * @example\n * ```ts\n * checkElementHasParent(childElement, modalElement);\n * ```\n */\nexport const checkElementHasParent = (\n  element: HTMLElement | null,\n  parent: Maybe<HTMLElement>,\n) => {\n  let node = element;\n\n  if (!parent) return false;\n\n  while (node != null) {\n    if (node === parent) {\n      return true;\n    } else {\n      node = node.parentElement;\n    }\n  }\n\n  return false;\n};\n\n/**\n * Executes a function within a view transition if supported by the browser.\n *\n * @param {VoidFunction} fn - The function to be executed.\n * @returns {ViewTransition} - The result of the executed function.\n *\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Document/startViewTransition | MDN: Document.startViewTransition}\n */\nexport const startViewTransitionSafety = (\n  fn: VoidFunction,\n  params?: { disabled?: boolean },\n) => {\n  if (\n    typeof document !== 'undefined' &&\n    document.startViewTransition &&\n    !params?.disabled\n  ) {\n    return document.startViewTransition(fn);\n  }\n  fn();\n};\n\n/**\n * Calculates the scrollbar width.\n */\nexport const calcScrollbarWidth = (elementToAppend = document.body) => {\n  const outer = document.createElement('div');\n\n  outer.style.visibility = 'hidden';\n  outer.style.width = '100px';\n  outer.style.overflow = 'scroll';\n\n  elementToAppend.append(outer);\n\n  const inner = document.createElement('div');\n  inner.style.width = '100%';\n\n  outer.append(inner);\n\n  const scrollbarWidth = outer.offsetWidth - inner.offsetWidth;\n\n  outer.parentNode?.removeChild(outer);\n\n  return scrollbarWidth;\n};\n\n/**\n * Calculates the inner height of an HTML element, accounting for padding.\n */\nexport function getElementInnerHeight(element: HTMLElement) {\n  const { clientHeight } = element;\n  const { paddingTop, paddingBottom } = getComputedStyle(element);\n  return (\n    clientHeight -\n    Number.parseFloat(paddingTop) -\n    Number.parseFloat(paddingBottom)\n  );\n}\n\n/**\n * Calculates the inner width of an HTML element, accounting for padding.\n */\nexport function getElementInnerWidth(el: HTMLElement) {\n  const { clientWidth } = el;\n  const { paddingLeft, paddingRight } = getComputedStyle(el);\n  return (\n    clientWidth -\n    Number.parseFloat(paddingLeft) -\n    Number.parseFloat(paddingRight)\n  );\n}\n\n/**\n * Checks whether the user prefers a dark color scheme.\n *\n * @example\n * ```ts\n * const prefersDark = isPrefersDarkTheme();\n * ```\n */\nexport const isPrefersDarkTheme = () =>\n  !!globalThis.matchMedia?.('(prefers-color-scheme: dark)')?.matches;\n\n/**\n * Checks whether the user prefers a light color scheme.\n *\n * @example\n * ```ts\n * const prefersLight = isPrefersLightTheme();\n * ```\n */\nexport const isPrefersLightTheme = () =>\n  !!globalThis.matchMedia?.('(prefers-color-scheme: light)')?.matches;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AA0BA,IAAa,oBAAoB,UAAkC;AACjE,KAAI,CAAC,MAAO,QAAO;CAEnB,MAAM,IAAI,SAAS,cAAc,MAAM;AACvC,GAAE,MAAM,QAAQ;AAChB,UAAS,KAAK,OAAO,EAAE;CACvB,MAAM,WAAW,WAAW,iBAAiB,EAAE,CAAC;CAChD,MAAM,QACJ,6DAA6D,KAAK,SAAS;AAE7E,GAAE,QAAQ;AAEV,KAAI,CAAC,MAAO,QAAO;AAEnB,QAAO,GAAG,MAAM,GAAG,IAAI,MAAM,GAAG,IAAI,MAAM;;;;;;;;;;AAW5C,IAAa,uBACX,WACA,aACG;CACH,MAAM,MAAM,UAAU,UAAU;CAEhC,MAAM,IAAI,SAAS,cAAc,IAAI;AACrC,GAAE,OAAO;AAET,GAAE,WAAW,YAAY;AAEzB,GAAE,SAAS;AAEX,UAAS,KAAK,OAAO,EAAE;AAEvB,GAAE,OAAO;AAET,GAAE,QAAQ;;;;;AAMZ,SAAgB,kBAAkB,MAAc;CAC9C,MAAM,QAAQ,OAAO,KAAK,CAAC,QAAQ,+BAA+B,OAAO;AACzE,KAAI,CAAC,gBAAgB,KAAK,KAAK,CAAE,QAAO,UAAU;AAClD,QAAO,WAAW,KAAK,mBAAmB,MAAM;;;;;;;;;;AAWlD,IAAa,oBAAoB,YAAgC;CAC/D,IAAI,YAAY;CAChB,IAAI,OAAO;AAEX,QAAO,QAAQ,MAAM;AACnB,eAAa,KAAK;AAClB,SAAO,KAAK;;AAGd,QAAO;;;;;;;;;;AAWT,IAAa,aAAa,MAAa;AACrC,GAAE,gBAAgB;AAClB,GAAE,iBAAiB;AAEnB,QAAO;;;;;;;;;;AAWT,IAAa,4BAA4B,SAAsB;CAC7D,MAAM,kBAAkB,SAAS;CACjC,MAAM,aAAa,OAAO;CAC1B,MAAM,eAAe,KAAK,uBAAuB;CACjD,MAAM,mBAAmB,gBAAgB,eAAe;CAExD,MAAM,mBAAmB,KAAK,IAC5B,KAAK,IAAI,aAAa,MAAM,YAAY,EAAE,EAC1C,iBACD;AAED,QAAO,OAAO;EACZ,KAAK,mBAAmB;EACxB,UAAU;EACX,CAAC;;AAGJ,IAAM,mBAAoC;CACxC,cAAc;EACZ;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACD;CACD,cAAc;EAAC;EAAQ;EAAU;EAAQ;EAAO;EAAQ;CACzD;;;;;;;;;AAUD,IAAa,gBAAgB,MAAqB,WAA6B;AAC7E,QAAO,UAAU,SAAS,QAAQ,IAAI;EACpC,GAAG;EACH,GAAG;EACJ,CAAC;;;;;;;;;;AAWJ,IAAa,yBACX,SACA,WACG;CACH,IAAI,OAAO;AAEX,KAAI,CAAC,OAAQ,QAAO;AAEpB,QAAO,QAAQ,KACb,KAAI,SAAS,OACX,QAAO;KAEP,QAAO,KAAK;AAIhB,QAAO;;;;;;;;;;AAWT,IAAa,6BACX,IACA,WACG;AACH,KACE,OAAO,aAAa,eACpB,SAAS,uBACT,CAAC,QAAQ,SAET,QAAO,SAAS,oBAAoB,GAAG;AAEzC,KAAI;;;;;AAMN,IAAa,sBAAsB,kBAAkB,SAAS,SAAS;CACrE,MAAM,QAAQ,SAAS,cAAc,MAAM;AAE3C,OAAM,MAAM,aAAa;AACzB,OAAM,MAAM,QAAQ;AACpB,OAAM,MAAM,WAAW;AAEvB,iBAAgB,OAAO,MAAM;CAE7B,MAAM,QAAQ,SAAS,cAAc,MAAM;AAC3C,OAAM,MAAM,QAAQ;AAEpB,OAAM,OAAO,MAAM;CAEnB,MAAM,iBAAiB,MAAM,cAAc,MAAM;AAEjD,OAAM,YAAY,YAAY,MAAM;AAEpC,QAAO;;;;;AAMT,SAAgB,sBAAsB,SAAsB;CAC1D,MAAM,EAAE,iBAAiB;CACzB,MAAM,EAAE,YAAY,kBAAkB,iBAAiB,QAAQ;AAC/D,QACE,eACA,OAAO,WAAW,WAAW,GAC7B,OAAO,WAAW,cAAc;;;;;AAOpC,SAAgB,qBAAqB,IAAiB;CACpD,MAAM,EAAE,gBAAgB;CACxB,MAAM,EAAE,aAAa,iBAAiB,iBAAiB,GAAG;AAC1D,QACE,cACA,OAAO,WAAW,YAAY,GAC9B,OAAO,WAAW,aAAa;;;;;;;;;;AAYnC,IAAa,2BACX,CAAC,CAAC,WAAW,aAAa,+BAA+B,EAAE;;;;;;;;;AAU7D,IAAa,4BACX,CAAC,CAAC,WAAW,aAAa,gCAAgC,EAAE"}

package/id.cjs

@@ -1,21 +1,93 @@
-"use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const nanoid = require("nanoid");
-const DIGITS = "0123456789";
-const LATIN_CHARS = "abcdefghijklmnopqrstuvwxyz";
-const ALPHABET = `${LATIN_CHARS}${DIGITS}`;
-const generateId = nanoid.customAlphabet(ALPHABET, 6);
-const generateShortId = nanoid.customAlphabet(ALPHABET, 4);
-const generateNumericId = nanoid.customAlphabet(DIGITS, 6);
-const generateNumericShortId = nanoid.customAlphabet(DIGITS, 4);
-const createLinearNumericIdGenerator = (size = 9) => {
-  let lastCount = 0;
-  return () => {
-    return (lastCount++).toString().padStart(size, "0");
-  };
+require("./chunk-CVq3Gv4J.cjs");
+let nanoid = require("nanoid");
+//#region src/id.ts
+/**
+* ---header-docs-section---
+* # yummies/id
+*
+* ## Description
+*
+* Fast, URL-friendly identifiers based on **nanoid** with curated alphabets and lengths. Use for
+* client-generated keys, trace ids, or UI instance ids where UUID size is unnecessary. Collisions are
+* unlikely at these lengths but still assume server-side uniqueness for persisted entities.
+*
+* ## Usage
+*
+* ```ts
+* import { generateId } from "yummies/id";
+* ```
+*/
+var DIGITS = "0123456789";
+var ALPHABET = `abcdefghijklmnopqrstuvwxyz${DIGITS}`;
+/**
+* Uses the alphabet `abcdefghijklmnopqrstuvwxyz0123456789`.
+* Length: 6.
+*/
+var generateId = (0, nanoid.customAlphabet)(ALPHABET, 6);
+/**
+* Uses the alphabet `abcdefghijklmnopqrstuvwxyz0123456789`.
+* Length: 4.
+*/
+var generateShortId = (0, nanoid.customAlphabet)(ALPHABET, 4);
+/**
+* Uses the alphabet `0123456789`.
+* Length: 6.
+*/
+var generateNumericId = (0, nanoid.customAlphabet)(DIGITS, 6);
+/**
+* Uses the alphabet `0123456789`.
+* Length: 4.
+*/
+var generateNumericShortId = (0, nanoid.customAlphabet)(DIGITS, 4);
+/**
+* Creates a function that generates unique strings based on call order.
+*
+* @example
+* ```ts
+* generateLinearNumericId = createLinearNumericIdGenerator(6);
+* generateLinearNumericId() // '000000'
+* generateLinearNumericId() // '000001'
+* ...
+* generateLinearNumericId() // '999999'
+* generateLinearNumericId() // '1000000'
+* ...
+* generateLinearNumericId() // '9999999'
+* generateLinearNumericId() // '10000000'
+* ```
+*
+* @param size Minimum string length.
+* @returns {()=>string}
+*/
+var createLinearNumericIdGenerator = (size = 9) => {
+	let lastCount = 0;
+	return () => {
+		return (lastCount++).toString().padStart(size, "0");
+	};
 };
-const generateLinearNumericId = createLinearNumericIdGenerator();
-const generateStackBasedId = () => new Error().stack.split("\n").slice(1, 4).join("");
+/**
+*
+* @example
+* ```ts
+* generateLinearNumericId() // '000000000'
+* generateLinearNumericId() // '000000001'
+* ...
+* generateLinearNumericId() // '999999999'
+* generateLinearNumericId() // '1000000000'
+* ...
+* generateLinearNumericId() // '9999999999'
+* generateLinearNumericId() // '10000000000'
+* ```
+*
+*/
+var generateLinearNumericId = createLinearNumericIdGenerator();
+/**
+* Is not recommended to use.
+*
+* Generates execution stack based pseudo-id (just sliced string from error stack)
+*/
+var generateStackBasedId = () => (/* @__PURE__ */ new Error()).stack.split("\n").slice(1, 4).join("");
+//#endregion
 exports.createLinearNumericIdGenerator = createLinearNumericIdGenerator;
 exports.generateId = generateId;
 exports.generateLinearNumericId = generateLinearNumericId;
@@ -23,4 +95,5 @@ exports.generateNumericId = generateNumericId;
 exports.generateNumericShortId = generateNumericShortId;
 exports.generateShortId = generateShortId;
 exports.generateStackBasedId = generateStackBasedId;
-//# sourceMappingURL=id.cjs.map
+
+//# sourceMappingURL=id.cjs.map

package/id.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"id.cjs","sources":["../src/id.ts"],"sourcesContent":["import { customAlphabet } from 'nanoid';\n\nconst DIGITS = '0123456789';\nconst LATIN_CHARS = 'abcdefghijklmnopqrstuvwxyz';\n\nconst ALPHABET = `${LATIN_CHARS}${DIGITS}`;\n\n/**\n * Uses the alphabet `abcdefghijklmnopqrstuvwxyz0123456789`.\n * Length: 6.\n */\nexport const generateId = customAlphabet(ALPHABET, 6);\n\n/**\n * Uses the alphabet `abcdefghijklmnopqrstuvwxyz0123456789`.\n * Length: 4.\n */\nexport const generateShortId = customAlphabet(ALPHABET, 4);\n\n/**\n * Uses the alphabet `0123456789`.\n * Length: 6.\n */\nexport const generateNumericId = customAlphabet(DIGITS, 6);\n\n/**\n * Uses the alphabet `0123456789`.\n * Length: 4.\n */\nexport const generateNumericShortId = customAlphabet(DIGITS, 4);\n\n/**\n * Creates a function that generates unique strings based on call order.\n *\n * @example\n * ```ts\n * generateLinearNumericId = createLinearNumericIdGenerator(6);\n * generateLinearNumericId() // '000000'\n * generateLinearNumericId() // '000001'\n * ...\n * generateLinearNumericId() // '999999'\n * generateLinearNumericId() // '1000000'\n * ...\n * generateLinearNumericId() // '9999999'\n * generateLinearNumericId() // '10000000'\n * ```\n *\n * @param size Minimum string length.\n * @returns {()=>string}\n */\nexport const createLinearNumericIdGenerator = (size: number = 9) => {\n  let lastCount = 0;\n  return () => {\n    return (lastCount++).toString().padStart(size, '0');\n  };\n};\n\n/**\n *\n * @example\n * ```ts\n * generateLinearNumericId() // '000000000'\n * generateLinearNumericId() // '000000001'\n * ...\n * generateLinearNumericId() // '999999999'\n * generateLinearNumericId() // '1000000000'\n * ...\n * generateLinearNumericId() // '9999999999'\n * generateLinearNumericId() // '10000000000'\n * ```\n *\n */\nexport const generateLinearNumericId = createLinearNumericIdGenerator();\n\n/**\n * Is not recommended to use.\n *\n * Generates execution stack based pseudo-id (just sliced string from error stack)\n */\nexport const generateStackBasedId = () =>\n  new Error().stack!.split('\\n').slice(1, 4).join('');\n"],"names":["customAlphabet"],"mappings":";;;AAEA,MAAM,SAAS;AACf,MAAM,cAAc;AAEpB,MAAM,WAAW,GAAG,WAAW,GAAG,MAAM;AAMjC,MAAM,aAAaA,OAAAA,eAAe,UAAU,CAAC;AAM7C,MAAM,kBAAkBA,OAAAA,eAAe,UAAU,CAAC;AAMlD,MAAM,oBAAoBA,OAAAA,eAAe,QAAQ,CAAC;AAMlD,MAAM,yBAAyBA,OAAAA,eAAe,QAAQ,CAAC;AAqBvD,MAAM,iCAAiC,CAAC,OAAe,MAAM;AAClE,MAAI,YAAY;AAChB,SAAO,MAAM;AACX,YAAQ,aAAa,SAAA,EAAW,SAAS,MAAM,GAAG;AAAA,EACpD;AACF;AAiBO,MAAM,0BAA0B,+BAAA;AAOhC,MAAM,uBAAuB,MAClC,IAAI,MAAA,EAAQ,MAAO,MAAM,IAAI,EAAE,MAAM,GAAG,CAAC,EAAE,KAAK,EAAE;;;;;;;;"}
+{"version":3,"file":"id.cjs","names":[],"sources":["../src/id.ts"],"sourcesContent":["/**\n * ---header-docs-section---\n * # yummies/id\n *\n * ## Description\n *\n * Fast, URL-friendly identifiers based on **nanoid** with curated alphabets and lengths. Use for\n * client-generated keys, trace ids, or UI instance ids where UUID size is unnecessary. Collisions are\n * unlikely at these lengths but still assume server-side uniqueness for persisted entities.\n *\n * ## Usage\n *\n * ```ts\n * import { generateId } from \"yummies/id\";\n * ```\n */\n\nimport { customAlphabet } from 'nanoid';\n\nconst DIGITS = '0123456789';\nconst LATIN_CHARS = 'abcdefghijklmnopqrstuvwxyz';\n\nconst ALPHABET = `${LATIN_CHARS}${DIGITS}`;\n\n/**\n * Uses the alphabet `abcdefghijklmnopqrstuvwxyz0123456789`.\n * Length: 6.\n */\nexport const generateId = customAlphabet(ALPHABET, 6);\n\n/**\n * Uses the alphabet `abcdefghijklmnopqrstuvwxyz0123456789`.\n * Length: 4.\n */\nexport const generateShortId = customAlphabet(ALPHABET, 4);\n\n/**\n * Uses the alphabet `0123456789`.\n * Length: 6.\n */\nexport const generateNumericId = customAlphabet(DIGITS, 6);\n\n/**\n * Uses the alphabet `0123456789`.\n * Length: 4.\n */\nexport const generateNumericShortId = customAlphabet(DIGITS, 4);\n\n/**\n * Creates a function that generates unique strings based on call order.\n *\n * @example\n * ```ts\n * generateLinearNumericId = createLinearNumericIdGenerator(6);\n * generateLinearNumericId() // '000000'\n * generateLinearNumericId() // '000001'\n * ...\n * generateLinearNumericId() // '999999'\n * generateLinearNumericId() // '1000000'\n * ...\n * generateLinearNumericId() // '9999999'\n * generateLinearNumericId() // '10000000'\n * ```\n *\n * @param size Minimum string length.\n * @returns {()=>string}\n */\nexport const createLinearNumericIdGenerator = (size: number = 9) => {\n  let lastCount = 0;\n  return () => {\n    return (lastCount++).toString().padStart(size, '0');\n  };\n};\n\n/**\n *\n * @example\n * ```ts\n * generateLinearNumericId() // '000000000'\n * generateLinearNumericId() // '000000001'\n * ...\n * generateLinearNumericId() // '999999999'\n * generateLinearNumericId() // '1000000000'\n * ...\n * generateLinearNumericId() // '9999999999'\n * generateLinearNumericId() // '10000000000'\n * ```\n *\n */\nexport const generateLinearNumericId = createLinearNumericIdGenerator();\n\n/**\n * Is not recommended to use.\n *\n * Generates execution stack based pseudo-id (just sliced string from error stack)\n */\nexport const generateStackBasedId = () =>\n  new Error().stack!.split('\\n').slice(1, 4).join('');\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAmBA,IAAM,SAAS;AAGf,IAAM,WAAW,6BAAiB;;;;;AAMlC,IAAa,cAAA,GAAA,OAAA,gBAA4B,UAAU,EAAE;;;;;AAMrD,IAAa,mBAAA,GAAA,OAAA,gBAAiC,UAAU,EAAE;;;;;AAM1D,IAAa,qBAAA,GAAA,OAAA,gBAAmC,QAAQ,EAAE;;;;;AAM1D,IAAa,0BAAA,GAAA,OAAA,gBAAwC,QAAQ,EAAE;;;;;;;;;;;;;;;;;;;;AAqB/D,IAAa,kCAAkC,OAAe,MAAM;CAClE,IAAI,YAAY;AAChB,cAAa;AACX,UAAQ,aAAa,UAAU,CAAC,SAAS,MAAM,IAAI;;;;;;;;;;;;;;;;;;AAmBvD,IAAa,0BAA0B,gCAAgC;;;;;;AAOvE,IAAa,8CACX,IAAI,OAAO,EAAC,MAAO,MAAM,KAAK,CAAC,MAAM,GAAG,EAAE,CAAC,KAAK,GAAG"}

package/id.d.ts

@@ -1,3 +1,19 @@
+/**
+ * ---header-docs-section---
+ * # yummies/id
+ *
+ * ## Description
+ *
+ * Fast, URL-friendly identifiers based on **nanoid** with curated alphabets and lengths. Use for
+ * client-generated keys, trace ids, or UI instance ids where UUID size is unnecessary. Collisions are
+ * unlikely at these lengths but still assume server-side uniqueness for persisted entities.
+ *
+ * ## Usage
+ *
+ * ```ts
+ * import { generateId } from "yummies/id";
+ * ```
+ */
 /**
  * Uses the alphabet `abcdefghijklmnopqrstuvwxyz0123456789`.
  * Length: 6.