disarm 0.16.0 → 0.17.0

package/README.md

@@ -10,7 +10,7 @@ prebuilt native addons install with no Rust toolchain.
 npm install disarm
 ```
 
-Ships TypeScript types (`.d.ts`) — no `@types/disarm` needed. Requires Node 14+.
+Ships TypeScript types (`.d.ts`) — no `@types/disarm` needed. Requires Node 22+.
 
 ## Quick start
 

package/binding.d.ts

@@ -1,5 +1,14 @@
 /* auto-generated by NAPI-RS */
 /* eslint-disable */
+
+/**
+ * Which binding artifact the generated loader actually loaded: `'native'` for
+ * a native addon, otherwise the `platformArchABI` of the WASI flavor. Every
+ * flavor napi-rs can build is listed, because `NAPI_RS_NATIVE_LIBRARY_PATH`
+ * can point the loader at a WASI artifact this package does not build itself.
+ */
+export declare const __napiBindingTarget: 'native' | 'wasm32-wasi' | 'wasm32-wasip1'
+
 /**
  * A reusable, opaque lexicon handle (HAI-SDLC 6.1).
  *
@@ -131,7 +140,10 @@ export interface ConfusableCoverage {
 
 export declare function confusablesVersion(): string
 
-/** Replace emoji with their plain names; `strip_modifiers` drops skin-tone marks. */
+/**
+ * Replace emoji with their plain names; `strip_modifiers` drops skin-tone marks. An
+ * emoji CLDR cannot name becomes `[?]`, as in every binding.
+ */
 export declare function demojize(text: string, stripModifiers: boolean): string
 
 /**
@@ -315,7 +327,11 @@ export declare function isNormalized(text: string, form: string): boolean
  */
 export declare function isSuspiciousHostname(host: string): boolean
 
-export declare function isZalgo(text: string, threshold: number): boolean
+/**
+ * Whether any base carries more than `threshold` marks; omitted, the core's default
+ * (`api::DEFAULT_ZALGO_THRESHOLD`, 3).
+ */
+export declare function isZalgo(text: string, threshold?: number | undefined | null): boolean
 
 /** One group of distinct inputs that reduce to the same key (#620). */
 export interface KeyCollision {
@@ -363,8 +379,9 @@ export declare function listContextLangs(): Array<string>
 export declare function listScripts(): Array<string>
 
 /**
- * ML/NLP normalization: NFKC → emoji→text → transliterate → strip accents →
- * [case fold] → strip control → strip zero-width → collapse whitespace.
+ * ML/NLP normalization: resolve deletions → NFKC → emoji→text → transliterate →
+ * strip accents → emoji→text → [case fold] → strip control → strip zero-width →
+ * collapse whitespace → NFC.
  *
  * `fold_case` defaults to `true`. Pass `false` in front of a CASED model: the fold is
  * destructive, cannot be undone downstream, and an uncased evaluation harness cannot
@@ -410,8 +427,12 @@ export declare function reverseTransliterate(text: string, lang: string): string
  * A safe **filename**, not a safe URL path segment. `%` is legal in a filename, so one
  * the caller typed is kept — `sanitizeFilename("..%2Fetc")` returns `"%2Fetc"` — and a
  * consumer that percent-decodes the result must validate *after* decoding. What this
- * will not do is manufacture one: `%` never appears in the output unless it appeared in
- * the input (#721).
+ * will not do is manufacture one: every `%` in the output is one the input contained, or
+ * part of the separator (#721).
+ *
+ * `separator` must be printable, non-space ASCII with no character illegal on
+ * `platform` and no path separator (`/`, `\`); anything else throws
+ * `DisarmInvalidArgument`. `""` is allowed.
  */
 export declare function sanitizeFilename(text: string, separator: string, maxLength: number, platform: string, lang: string | undefined | null, preserveExtension: boolean): string
 
@@ -494,7 +515,11 @@ export declare function stripTags(text: string): string
 /** Strip every variation selector (VS1–VS256) (#413). */
 export declare function stripVariationSelectors(text: string): string
 
-export declare function stripZalgo(text: string, maxMarks: number): string
+/**
+ * Cap combining marks per base at `max_marks`; omitted, the core's default
+ * (`api::DEFAULT_ZALGO_MAX_MARKS`, 3), so this binding never restates it (B1).
+ */
+export declare function stripZalgo(text: string, maxMarks?: number | undefined | null): string
 
 export declare function stripZeroWidthChars(text: string): string
 
@@ -505,7 +530,8 @@ export declare function transliterate(text: string): string
 
 /**
  * Transliterate with a scheme (`"default"` | `"strict_iso9"` | `"gost7034"`)
- * and/or a language profile (`lang`), via the core's builder.
+ * and/or a language profile (`lang`), via the core's builder. An unknown `lang`
+ * throws `DisarmInvalidArgument`, as the key builders' always has.
  */
 export declare function transliterateOpts(text: string, scheme: string, lang?: string | undefined | null): string