text-sanctifier 1.0.10 → 1.0.11

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "text-sanctifier",
-    "version": "1.0.10",
+    "version": "1.0.11",
     "type": "module",
     "description": "A brutal text normalizer and invisible trash scrubber for modern web projects.",
     "main": "./src/index.js",

package/src/index.d.ts

@@ -10,8 +10,11 @@ export interface SanctifyOptions {
   /** Nuke hidden control characters (excluding whitespace like \n and \t) */
   nukeControls?: boolean;
 
-  /** Remove emoji characters. */
+  /** Remove emoji characters */
   purgeEmojis?: boolean;
+
+  /** Restrict to printable ASCII (+ emoji if `purgeEmojis` is false) */
+  keyboardOnlyFilter?: boolean;
 }
 
 /** Preconfigured sanitizer function */
@@ -19,39 +22,65 @@ export type Sanctifier = (text: string) => string;
 
 /**
  * Summon a reusable text sanitizer.
- * 
- * If `defaultOptions` is provided, it creates a sanitizer configured with human options.
  */
 export function summonSanctifier(
   defaultOptions?: SanctifyOptions,
 ): Sanctifier;
 
 /**
- * Creates a strict sanitizer:
- * - Collapse multiple spaces
+ * Strict sanitizer preset:
+ * - Collapse spaces
  * - Collapse all newlines
- * - Purge control and invisible characters
- * - Purge emoji characters
+ * - Nuke control characters
+ * - Purge emojis
  */
-export function strict(): Sanctifier;
+export namespace summonSanctifier {
+  const strict: Sanctifier;
+  const loose: Sanctifier;
 
-/**
- * Creates a loose sanitizer:
- * - Preserve paragraph breaks
- * - Collapse spaces
- * - Purge invisible characters (but leave control characters)
-*  - Preserve emoji characters
- */
-export function loose(): Sanctifier;
+  /**
+   * Keeps printable ASCII and emoji.
+   * Leaves spacing soft and preserves emoji.
+   */
+  const keyboardOnlyEmoji: Sanctifier;
+
+  /**
+   * Keeps printable ASCII only.
+   * Collapses whitespace and purges emoji.
+   */
+  const keyboardOnly: Sanctifier;
+}
 
 /**
  * Brutally normalizes and cleans a string of text.
- * 
  */
 export function sanctifyText(
   text: string,
-  preserveParagraphs: boolean,
-  collapseSpaces: boolean,
-  nukeControls: boolean,
-  purgeEmojis: boolean
+  preserveParagraphs?: boolean,
+  collapseSpaces?: boolean,
+  nukeControls?: boolean,
+  purgeEmojis?: boolean,
+  keyboardOnlyFilter?: boolean
 ): string;
+
+/** Style of newline characters detected in a string */
+export type NewlineStyle = 'LF' | 'CRLF' | 'CR' | 'Mixed' | null;
+
+/**
+ * A structural report of anomalies found in text.
+ */
+export interface UnicodeTrashReport {
+  hasControlChars: boolean;
+  hasInvisibleChars: boolean;
+  hasMixedNewlines: boolean;
+  newlineStyle: NewlineStyle;
+  hasEmojis: boolean;
+  hasNonKeyboardChars: boolean;
+  summary: string[];
+}
+
+/**
+ * Analyze a string and return a report of Unicode/control character issues,
+ * invisible characters, newline styles, emojis, and more.
+ */
+export function inspectText(text: string): UnicodeTrashReport;