@visulima/html 1.0.0-alpha.12 → 1.0.0-alpha.14

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+## @visulima/html [1.0.0-alpha.14](https://github.com/visulima/visulima/compare/@visulima/html@1.0.0-alpha.13...@visulima/html@1.0.0-alpha.14) (2026-05-20)
+
+## @visulima/html [1.0.0-alpha.13](https://github.com/visulima/visulima/compare/@visulima/html@1.0.0-alpha.12...@visulima/html@1.0.0-alpha.13) (2026-05-19)
+
+### Miscellaneous Chores
+
+* **html:** housekeeping cleanup ([2582bc2](https://github.com/visulima/visulima/commit/2582bc220b2eec56acf441dee4654d4b4721381e))
+* **html:** upgrade packem to 2.0.0-alpha.76 ([6de95f0](https://github.com/visulima/visulima/commit/6de95f036c3277d6b65be6728406897b1ffc13ac))
+* re-sort workspace package.json files via vis sort-package-json ([f625696](https://github.com/visulima/visulima/commit/f625696cfac974325774b3243e1a83c3d23acbd7))
+
 ## @visulima/html [1.0.0-alpha.12](https://github.com/visulima/visulima/compare/@visulima/html@1.0.0-alpha.11...@visulima/html@1.0.0-alpha.12) (2026-04-22)
 
 ### Bug Fixes

package/LICENSE.md

@@ -447,40 +447,11 @@ Repository: https://github.com/alexreardon/tiny-invariant.git
 <!-- TYPE_DEPENDENCIES -->
 
 # Licenses of bundled types
-
 The published @visulima/html artifact additionally contains code with the following licenses:
 MIT
 
 # Bundled types:
-
-## @jsr/std\_\_html
-
-> MIT License
->
-> Copyright 2018-2022 the Deno authors.
->
-> Permission is hereby granted, free of charge, to any person obtaining a copy
-> of this software and associated documentation files (the "Software"), to deal
-> in the Software without restriction, including without limitation the rights
-> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-> copies of the Software, and to permit persons to whom the Software is
-> furnished to do so, subject to the following conditions:
->
-> The above copyright notice and this permission notice shall be included in all
-> copies or substantial portions of the Software.
->
-> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-> SOFTWARE.
-
----
-
 ## html-entities
-
 License: MIT
 By: Marat Dulin
 Repository: https://github.com/mdevils/html-entities.git
@@ -505,10 +476,9 @@ Repository: https://github.com/mdevils/html-entities.git
 > OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 > THE SOFTWARE.
 
----
+---------------------------------------
 
 ## html-tags
-
 License: MIT
 By: Sindre Sorhus
 Repository: sindresorhus/html-tags
@@ -523,41 +493,9 @@ Repository: sindresorhus/html-tags
 >
 > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
----
-
-## ranges-push
-
-License: MIT
-By: Roy Revelt
-Repository: git+https://github.com/codsen/codsen.git
-
-> MIT License
->
-> Copyright © 2010-2025 Roy Revelt and other contributors
->
-> Permission is hereby granted, free of charge, to any person obtaining
-> a copy of this software and associated documentation files (the
-> "Software"), to deal in the Software without restriction, including
-> without limitation the rights to use, copy, modify, merge, publish,
-> distribute, sublicense, and/or sell copies of the Software, and to
-> permit persons to whom the Software is furnished to do so, subject to
-> the following conditions:
->
-> The above copyright notice and this permission notice shall be
-> included in all copies or substantial portions of the Software.
->
-> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-> LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-> OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
----
+---------------------------------------
 
 ## string-strip-html
-
 License: MIT
 By: Roy Revelt
 Repository: git+https://github.com/codsen/codsen.git

package/dist/index.d.ts

@@ -3,15 +3,205 @@ export { type Properties as CSSProperties } from 'csstype';
 export { escapeCss } from '@std/html/unstable-escape-css';
 export { escapeJs } from '@std/html/unstable-escape-js';
 export { isValidCustomElementName } from '@std/html/unstable-is-valid-custom-element-name';
-export * from 'html-entities';
-export { default as htmlTags, voidHtmlTags } from 'html-tags';
 export { default as sanitizeHtml } from 'sanitize-html';
-export { type Attribute as StripHtmlAttribute, type CbObj as StripHtmlCbObj, type Opts as StripHtmlOptions, type Res as StripHtmlResult, type Tag as StripHtmlTag, stripHtml, defaults as stripHtmlDefaultOptions } from 'string-strip-html';
+import { Ranges as Ranges$1 } from 'ranges-push';
+/**
+* Flexible CSS properties type that allows autocomplete for property names
+* while accepting string, number, null, or undefined values.
+*/
 type FlexibleCSSProperties$1 = { [K in keyof Properties]?: Properties[K] | string | number | null | undefined };
+/**
+* Template tag function for CSS that returns a minified one-line CSS string.
+* Template strings are used as-is, but interpolated values are escaped by default.
+* All whitespace and newlines are collapsed into single spaces.
+* @param strings Template literal strings
+* @param values Template literal values (escaped by default)
+* @returns A minified one-line CSS string
+* @example
+* css`:where(.UnderlineNav-actions ul) { animation: 1ms rgh-selector-observer; }`
+* // Returns: ":where(.UnderlineNav-actions ul) { animation: 1ms rgh-selector-observer; }"
+*/
 declare function css(strings: TemplateStringsArray, ...values: unknown[]): string;
+/**
+* Function overload for CSS with escaping control.
+* Supports both string and object inputs.
+* @param value The CSS string or object to process
+* @param shouldEscape If true, escapes CSS. If false, returns CSS as-is.
+* @returns The processed CSS string
+* @example
+* css(':where(.UnderlineNav-actions ul) { animation: 1ms rgh-selector-observer; }', true)
+* @example
+* css({ padding: "1px" }, true)
+* @example
+* css({ margin: 20, padding: 10 }, false)
+*/
 declare function css(value: string | FlexibleCSSProperties$1 | Properties, shouldEscape?: boolean): string;
+/**
+* Escapes HTML special characters in a string.
+* Optimized for performance with minimal allocations.
+* @param value The value to escape. Will be converted to string.
+* @param isAttribute If true, also escapes double quotes (for HTML attributes).
+* @returns The escaped string.
+* @example
+* escapeHtml('<script>alert("xss")<\/script>');
+* // => '&lt;script>alert("xss")&lt;/script>'
+* @example
+* escapeHtml('<div>', true);
+* // => '&lt;div>'
+* @example
+* escapeHtml('value="test"', true);
+* // => 'value=&quot;test&quot;'
+*/
 declare const escapeHtml: (value: unknown, isAttribute?: boolean) => string;
+/**
+* Template tag function for HTML that escapes interpolated values to prevent XSS.
+* Template strings are used as-is, but all interpolated values are HTML-escaped.
+* @param strings Template literal strings
+* @param values Template literal values (will be escaped)
+* @returns The HTML string with interpolated values escaped
+* @example
+* html`<div>Hello</div>`
+* // => '<div>Hello</div>'
+* @example
+* html`<div>${'<script>alert("xss")<\/script>'}</div>`
+* // => '<div>&lt;script>alert("xss")&lt;/script></div>'
+*/
 declare function html(strings: TemplateStringsArray, ...values: unknown[]): string;
+/**
+* Function overload for HTML with escaping control.
+* @param value The HTML string to process
+* @param shouldEscape If false/undefined, returns HTML as-is (unsafe for untrusted input). If true, escapes HTML.
+* @returns The processed HTML string
+* @example
+* html('<div></div>', false)
+* // => '<div></div>'
+* @example
+* html('<script>alert("xss")<\/script>', true)
+* // => '&lt;script>alert("xss")&lt;/script>'
+*/
 declare function html(value: string, shouldEscape?: boolean): string;
+type Level = 'xml' | 'html4' | 'html5' | 'all';
+interface CommonOptions {
+  level?: Level;
+}
+type EncodeMode = 'specialChars' | 'nonAscii' | 'nonAsciiPrintable' | 'nonAsciiPrintableOnly' | 'extensive';
+interface EncodeOptions extends CommonOptions {
+  mode?: EncodeMode;
+  numeric?: 'decimal' | 'hexadecimal';
+}
+type DecodeScope = 'strict' | 'body' | 'attribute';
+interface DecodeOptions extends CommonOptions {
+  scope?: DecodeScope;
+}
+/** Encodes all the necessary (specified by `level`) characters in the text */
+declare function encode(text: string | undefined | null, {
+  mode,
+  numeric,
+  level
+}?: EncodeOptions): string;
+/** Decodes a single entity */
+declare function decodeEntity(entity: string | undefined | null, {
+  level
+}?: CommonOptions): string;
+/** Decodes all entities in the text */
+declare function decode(text: string | undefined | null, {
+  level,
+  scope
+}?: DecodeOptions): string;
+type HtmlTags = 'a' | 'abbr' | 'address' | 'area' | 'article' | 'aside' | 'audio' | 'b' | 'base' | 'bdi' | 'bdo' | 'blockquote' | 'body' | 'br' | 'button' | 'canvas' | 'caption' | 'cite' | 'code' | 'col' | 'colgroup' | 'data' | 'datalist' | 'dd' | 'del' | 'details' | 'dfn' | 'dialog' | 'div' | 'dl' | 'dt' | 'em' | 'embed' | 'fieldset' | 'figcaption' | 'figure' | 'footer' | 'form' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'head' | 'header' | 'hgroup' | 'hr' | 'html' | 'i' | 'iframe' | 'img' | 'input' | 'ins' | 'kbd' | 'label' | 'legend' | 'li' | 'link' | 'main' | 'map' | 'mark' | 'math' | 'menu' | 'meta' | 'meter' | 'nav' | 'noscript' | 'object' | 'ol' | 'optgroup' | 'option' | 'output' | 'p' | 'picture' | 'pre' | 'progress' | 'q' | 'rp' | 'rt' | 'ruby' | 's' | 'samp' | 'script' | 'search' | 'section' | 'select' | 'selectedcontent' | 'slot' | 'small' | 'source' | 'span' | 'strong' | 'style' | 'sub' | 'summary' | 'sup' | 'svg' | 'table' | 'tbody' | 'td' | 'template' | 'textarea' | 'tfoot' | 'th' | 'thead' | 'time' | 'title' | 'tr' | 'track' | 'u' | 'ul' | 'var' | 'video' | 'wbr';
+type VoidHtmlTags = 'area' | 'base' | 'br' | 'col' | 'embed' | 'hr' | 'img' | 'input' | 'link' | 'meta' | 'source' | 'track' | 'wbr';
+/**
+List of standard HTML tags.
+
+@example
+```
+import htmlTags from 'html-tags';
+
+console.log(htmlTags);
+//=> ['a', 'abbr', 'acronym', …]
+```
+*/
+declare const htmlTags: readonly HtmlTags[];
+/**
+List of standard, self-closing HTML tags.
+
+@example
+```
+import {voidHtmlTags} from 'html-tags';
+
+console.log(voidHtmlTags);
+//=> ['area', 'base', 'br', …]
+```
+*/
+declare const voidHtmlTags: readonly VoidHtmlTags[];
+type Range = [from: number, to: number] | [from: number, to: number, whatToInsert: string | null | undefined];
+type Ranges = Range[] | null;
+interface Attribute {
+  nameStarts: number;
+  nameEnds: number;
+  equalsAt?: number;
+  name: string;
+  valueStarts?: number;
+  valueEnds?: number;
+  value?: string;
+}
+interface Tag {
+  attributes: Attribute[];
+  lastClosingBracketAt: number;
+  lastOpeningBracketAt: number;
+  slashPresent: number;
+  leftOuterWhitespace: number;
+  onlyPlausible: boolean;
+  nameStarts: number;
+  nameContainsLetters: boolean;
+  nameEnds: number;
+  name: string;
+}
+interface CbObj {
+  tag: Tag;
+  deleteFrom: null | number;
+  deleteTo: null | number;
+  insert: null | undefined | string;
+  rangesArr: Ranges$1;
+  proposedReturn: Range | null;
+}
+interface Opts {
+  ignoreTags: string[];
+  ignoreTagsWithTheirContents: string[];
+  onlyStripTags: string[];
+  stripTogetherWithTheirContents: string[];
+  skipHtmlDecoding: boolean;
+  trimOnlySpaces: boolean;
+  stripRecognisedHTMLOnly: boolean;
+  dumpLinkHrefsNearby: {
+    enabled?: boolean;
+    putOnNewLine?: boolean;
+    wrapHeads?: string;
+    wrapTails?: string;
+  };
+  ignoreIndentations: boolean;
+  cb: null | ((cbObj: CbObj) => void);
+  reportProgressFunc: null | ((percDone: number) => void);
+  reportProgressFuncFrom: number;
+  reportProgressFuncTo: number;
+}
+declare const defaults: Opts;
+interface Res {
+  log: {
+    timeTakenInMilliseconds: number;
+  };
+  result: string;
+  ranges: Ranges;
+  allTagLocations: [number, number][];
+  filteredTagLocations: [number, number][];
+}
+/**
+ * Strips HTML tags from strings. No parser, accepts mixed sources.
+ */
+declare function stripHtml(str: string, opts?: Partial<Opts>): Res;
+/**
+* Flexible CSS properties type that allows autocomplete for property names
+* while accepting string, number, null, or undefined values.
+*/
 type FlexibleCSSProperties = { [K in keyof Properties]?: Properties[K] | string | number | null | undefined };
-export { FlexibleCSSProperties, css, escapeHtml, html };
+export { DecodeOptions, DecodeScope, EncodeMode, EncodeOptions, FlexibleCSSProperties, Level, type Attribute as StripHtmlAttribute, type CbObj as StripHtmlCbObj, type Opts as StripHtmlOptions, type Res as StripHtmlResult, type Tag as StripHtmlTag, css, decode, decodeEntity, encode, escapeHtml, html, htmlTags, stripHtml, defaults as stripHtmlDefaultOptions, voidHtmlTags };

package/package.json

@@ -1,37 +1,42 @@
 {
   "name": "@visulima/html",
-  "version": "1.0.0-alpha.12",
+  "version": "1.0.0-alpha.14",
   "description": "Functions for HTML, such as escaping or unescaping HTML entities",
   "keywords": [
-    "visulima",
-    "html",
+    "css",
+    "custom-element",
+    "entities",
     "escape",
-    "escaping",
-    "escape-html",
     "escape-css",
+    "escape-html",
     "escape-js",
-    "sanitize",
+    "escaping",
+    "html",
+    "html-entities",
+    "javascript",
+    "js",
     "sanitization",
+    "sanitize",
     "sanitize-html",
+    "security",
     "strip",
     "strip-html",
-    "xss",
-    "security",
-    "entities",
-    "html-entities",
-    "css",
-    "javascript",
-    "js",
     "template",
     "template-tag",
+    "typescript",
     "validation",
-    "custom-element",
-    "typescript"
+    "visulima",
+    "xss"
   ],
   "homepage": "https://visulima.com/packages/html",
   "bugs": {
     "url": "https://github.com/visulima/visulima/issues"
   },
+  "license": "MIT",
+  "author": {
+    "name": "Daniel Bannert",
+    "email": "d.bannert@anolilab.de"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/visulima/visulima.git",
@@ -47,13 +52,13 @@
       "url": "https://anolilab.com/support"
     }
   ],
-  "license": "MIT",
-  "author": {
-    "name": "Daniel Bannert",
-    "email": "d.bannert@anolilab.de"
-  },
-  "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
   "type": "module",
+  "sideEffects": false,
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -61,20 +66,15 @@
     },
     "./package.json": "./package.json"
   },
-  "files": [
-    "dist",
-    "README.md",
-    "CHANGELOG.md"
-  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "dependencies": {
     "csstype": "3.2.3",
-    "sanitize-html": "2.17.3"
+    "sanitize-html": "2.17.4"
   },
   "engines": {
     "node": "^22.14.0 || >=24.10.0"
-  },
-  "publishConfig": {
-    "access": "public",
-    "provenance": true
   }
 }