purifai 2.0.3 → 3.0.0

package/dist/index.d.cts

@@ -1,189 +1,2 @@
-/**
- * PURIFAI - bounded strip-to-text sanitizer and contextual encoders.
- *
- * `sanitize()` removes markup; it does not preserve safe HTML. Use `escape()`,
- * `escapeAttribute()`, or `escapeUrl()` when the destination context is known.
- *
- * @version 2.0.3
- * @license MIT
- */
-/**
- * Purifai Configuration Options
- */
-export interface PurifaiOptions {
-    /** Maximum input length (default: 1MB) */
-    maxLength?: number;
-    /** Subset of the built-in safe URL protocols (default: http, https, mailto) */
-    allowedProtocols?: string[];
-    /** @deprecated Retained for source compatibility; strip-to-text is always used. */
-    aggressiveMode?: boolean;
-}
-/**
- * Purifai Sanitization Result
- */
-export interface PurifaiResult {
-    /** Sanitized content */
-    content: string;
-    /** Advisory: whether a known dangerous pattern was detected */
-    hadThreats: boolean;
-    /** Processing time in milliseconds */
-    processingTime: number;
-    /** Threat level: 'none' | 'low' | 'medium' | 'high' | 'critical' */
-    threatLevel: 'none' | 'low' | 'medium' | 'high' | 'critical';
-}
-/**
- * Check if input contains dangerous patterns
- */
-declare function isDangerous(input: string): boolean;
-/**
- * Convert HTML-like input to inert plain text using a bounded forward scanner.
- */
-declare function sanitize(input: unknown, options?: PurifaiOptions): string;
-/**
- * Sanitize input and return detailed analysis
- */
-declare function analyze(input: unknown, options?: PurifaiOptions): PurifaiResult;
-/**
- * Batch sanitize multiple inputs for optimal performance
- */
-declare function sanitizeBatch(inputs: unknown[], options?: PurifaiOptions): string[];
-/**
- * Escape text for insertion into an HTML body context.
- *
- * Lossless apart from control characters: this is the correct choice when the
- * input is plain text rather than markup and exact text fidelity matters.
- */
-declare function escape(input: unknown): string;
-/**
- * Escape text for insertion into an HTML attribute value.
- *
- * Stricter than `escape()`: every character outside `[a-zA-Z0-9]` is
- * hex-encoded, which stays safe even in an unquoted attribute — the case that
- * breaks naive escaping, since a bare space or backtick can end the value and
- * start a new attribute such as `onerror=`.
- */
-declare function escapeAttribute(input: unknown): string;
-/**
- * Escape and validate a value used as a URL.
- *
- * Returns '' when the protocol is not in the caller-selected subset of the
- * built-in safe protocols. Script-bearing schemes and protocol-relative URLs
- * cannot be enabled through options.
- */
-declare function escapeUrl(input: unknown, options?: PurifaiOptions): string;
-/**
- * Purifai - bounded strip-to-text sanitizer
- *
- * Converts HTML-like input to plain text and exposes separate contextual
- * encoders for HTML text, attributes, and URLs.
- *
- * Every method delegates to a module-level function and reads no instance or
- * class state, so `Purifai.sanitize` and the standalone `sanitize` export are
- * interchangeable and neither depends on its call-site receiver.
- */
-export declare class Purifai {
-    /**
-     * Convert HTML-like input to plain text
-     *
-     * @param input - Content to sanitize (string, object, or any type)
-     * @param options - Optional configuration
-     * @returns Plain-text string; render it through normal text interpolation
-     *
-     * @example
-     * ```typescript
-     * import { Purifai } from 'purifai';
-     *
-     * const clean = Purifai.sanitize('<script>alert("xss")</script>Hello World');
-     * console.log(clean); // "Hello World"
-     * ```
-     */
-    static sanitize(input: unknown, options?: PurifaiOptions): string;
-    /**
-     * Sanitize input and return detailed analysis
-     *
-     * @param input - Content to sanitize
-     * @param options - Optional configuration
-     * @returns Detailed sanitization result with threat analysis
-     *
-     * @example
-     * ```typescript
-     * const result = Purifai.analyze('<script>alert("xss")</script>Hello');
-     * console.log(result.content); // "Hello"
-     * console.log(result.hadThreats); // true
-     * console.log(result.threatLevel); // "critical"
-     * ```
-     */
-    static analyze(input: unknown, options?: PurifaiOptions): PurifaiResult;
-    /**
-     * Check if input contains dangerous patterns
-     *
-     * @param input - Content to check
-     * @returns true if dangerous content detected
-     *
-     * @example
-     * ```typescript
-     * const isDangerous = Purifai.isDangerous('<script>alert("xss")</script>');
-     * console.log(isDangerous); // true
-     * ```
-     */
-    static isDangerous(input: string): boolean;
-    /**
-     * Batch sanitize multiple inputs for optimal performance
-     *
-     * @param inputs - Array of inputs to sanitize
-     * @param options - Optional configuration
-     * @returns Array of sanitized strings
-     *
-     * @example
-     * ```typescript
-     * const cleaned = Purifai.sanitizeBatch([
-     *   '<script>alert("xss")</script>Hello',
-     *   '<img src=x onerror=alert(1)>World'
-     * ]);
-     * console.log(cleaned); // ["Hello", "World"]
-     * ```
-     */
-    static sanitizeBatch(inputs: unknown[], options?: PurifaiOptions): string[];
-    /**
-     * Escape text for an HTML body context (lossless — nothing is removed)
-     *
-     * @example
-     * ```typescript
-     * Purifai.escape('if (a<b && c>d)'); // "if (a&lt;b &amp;&amp; c&gt;d)"
-     * ```
-     */
-    static escape(input: unknown): string;
-    /**
-     * Escape text for an HTML attribute value, safe even when unquoted
-     *
-     * @example
-     * ```typescript
-     * `<div title="${Purifai.escapeAttribute(userInput)}">`
-     * ```
-     */
-    static escapeAttribute(input: unknown): string;
-    /**
-     * Escape a URL, returning '' if its protocol is not allowed
-     *
-     * @example
-     * ```typescript
-     * Purifai.escapeUrl('javascript:alert(1)'); // ""
-     * Purifai.escapeUrl('https://example.com'); // escaped, safe for href
-     * ```
-     */
-    static escapeUrl(input: unknown, options?: PurifaiOptions): string;
-    /**
-     * Get version information
-     */
-    static getVersion(): string;
-    /**
-     * Get performance and security statistics
-     */
-    static getStats(): {
-        version: string;
-        securityLevel: string;
-        performance: string;
-    };
-}
-export { sanitize, analyze, isDangerous, sanitizeBatch, escape, escapeAttribute, escapeUrl };
-export default Purifai;
+export { PurifaiLimitError, convert, createTextTransform, escapeHtmlText, toText, } from './src/api.js';
+export type { ConversionLimits, ConversionReport, ConversionResult, ConvertOptions, ImageMode, LayoutMode, LimitKind, LinkMode, OverflowMode, PurifaiTextTransform, ToTextOptions, } from './src/api.js';

package/dist/index.d.ts

@@ -1,189 +1,2 @@
-/**
- * PURIFAI - bounded strip-to-text sanitizer and contextual encoders.
- *
- * `sanitize()` removes markup; it does not preserve safe HTML. Use `escape()`,
- * `escapeAttribute()`, or `escapeUrl()` when the destination context is known.
- *
- * @version 2.0.3
- * @license MIT
- */
-/**
- * Purifai Configuration Options
- */
-export interface PurifaiOptions {
-    /** Maximum input length (default: 1MB) */
-    maxLength?: number;
-    /** Subset of the built-in safe URL protocols (default: http, https, mailto) */
-    allowedProtocols?: string[];
-    /** @deprecated Retained for source compatibility; strip-to-text is always used. */
-    aggressiveMode?: boolean;
-}
-/**
- * Purifai Sanitization Result
- */
-export interface PurifaiResult {
-    /** Sanitized content */
-    content: string;
-    /** Advisory: whether a known dangerous pattern was detected */
-    hadThreats: boolean;
-    /** Processing time in milliseconds */
-    processingTime: number;
-    /** Threat level: 'none' | 'low' | 'medium' | 'high' | 'critical' */
-    threatLevel: 'none' | 'low' | 'medium' | 'high' | 'critical';
-}
-/**
- * Check if input contains dangerous patterns
- */
-declare function isDangerous(input: string): boolean;
-/**
- * Convert HTML-like input to inert plain text using a bounded forward scanner.
- */
-declare function sanitize(input: unknown, options?: PurifaiOptions): string;
-/**
- * Sanitize input and return detailed analysis
- */
-declare function analyze(input: unknown, options?: PurifaiOptions): PurifaiResult;
-/**
- * Batch sanitize multiple inputs for optimal performance
- */
-declare function sanitizeBatch(inputs: unknown[], options?: PurifaiOptions): string[];
-/**
- * Escape text for insertion into an HTML body context.
- *
- * Lossless apart from control characters: this is the correct choice when the
- * input is plain text rather than markup and exact text fidelity matters.
- */
-declare function escape(input: unknown): string;
-/**
- * Escape text for insertion into an HTML attribute value.
- *
- * Stricter than `escape()`: every character outside `[a-zA-Z0-9]` is
- * hex-encoded, which stays safe even in an unquoted attribute — the case that
- * breaks naive escaping, since a bare space or backtick can end the value and
- * start a new attribute such as `onerror=`.
- */
-declare function escapeAttribute(input: unknown): string;
-/**
- * Escape and validate a value used as a URL.
- *
- * Returns '' when the protocol is not in the caller-selected subset of the
- * built-in safe protocols. Script-bearing schemes and protocol-relative URLs
- * cannot be enabled through options.
- */
-declare function escapeUrl(input: unknown, options?: PurifaiOptions): string;
-/**
- * Purifai - bounded strip-to-text sanitizer
- *
- * Converts HTML-like input to plain text and exposes separate contextual
- * encoders for HTML text, attributes, and URLs.
- *
- * Every method delegates to a module-level function and reads no instance or
- * class state, so `Purifai.sanitize` and the standalone `sanitize` export are
- * interchangeable and neither depends on its call-site receiver.
- */
-export declare class Purifai {
-    /**
-     * Convert HTML-like input to plain text
-     *
-     * @param input - Content to sanitize (string, object, or any type)
-     * @param options - Optional configuration
-     * @returns Plain-text string; render it through normal text interpolation
-     *
-     * @example
-     * ```typescript
-     * import { Purifai } from 'purifai';
-     *
-     * const clean = Purifai.sanitize('<script>alert("xss")</script>Hello World');
-     * console.log(clean); // "Hello World"
-     * ```
-     */
-    static sanitize(input: unknown, options?: PurifaiOptions): string;
-    /**
-     * Sanitize input and return detailed analysis
-     *
-     * @param input - Content to sanitize
-     * @param options - Optional configuration
-     * @returns Detailed sanitization result with threat analysis
-     *
-     * @example
-     * ```typescript
-     * const result = Purifai.analyze('<script>alert("xss")</script>Hello');
-     * console.log(result.content); // "Hello"
-     * console.log(result.hadThreats); // true
-     * console.log(result.threatLevel); // "critical"
-     * ```
-     */
-    static analyze(input: unknown, options?: PurifaiOptions): PurifaiResult;
-    /**
-     * Check if input contains dangerous patterns
-     *
-     * @param input - Content to check
-     * @returns true if dangerous content detected
-     *
-     * @example
-     * ```typescript
-     * const isDangerous = Purifai.isDangerous('<script>alert("xss")</script>');
-     * console.log(isDangerous); // true
-     * ```
-     */
-    static isDangerous(input: string): boolean;
-    /**
-     * Batch sanitize multiple inputs for optimal performance
-     *
-     * @param inputs - Array of inputs to sanitize
-     * @param options - Optional configuration
-     * @returns Array of sanitized strings
-     *
-     * @example
-     * ```typescript
-     * const cleaned = Purifai.sanitizeBatch([
-     *   '<script>alert("xss")</script>Hello',
-     *   '<img src=x onerror=alert(1)>World'
-     * ]);
-     * console.log(cleaned); // ["Hello", "World"]
-     * ```
-     */
-    static sanitizeBatch(inputs: unknown[], options?: PurifaiOptions): string[];
-    /**
-     * Escape text for an HTML body context (lossless — nothing is removed)
-     *
-     * @example
-     * ```typescript
-     * Purifai.escape('if (a<b && c>d)'); // "if (a&lt;b &amp;&amp; c&gt;d)"
-     * ```
-     */
-    static escape(input: unknown): string;
-    /**
-     * Escape text for an HTML attribute value, safe even when unquoted
-     *
-     * @example
-     * ```typescript
-     * `<div title="${Purifai.escapeAttribute(userInput)}">`
-     * ```
-     */
-    static escapeAttribute(input: unknown): string;
-    /**
-     * Escape a URL, returning '' if its protocol is not allowed
-     *
-     * @example
-     * ```typescript
-     * Purifai.escapeUrl('javascript:alert(1)'); // ""
-     * Purifai.escapeUrl('https://example.com'); // escaped, safe for href
-     * ```
-     */
-    static escapeUrl(input: unknown, options?: PurifaiOptions): string;
-    /**
-     * Get version information
-     */
-    static getVersion(): string;
-    /**
-     * Get performance and security statistics
-     */
-    static getStats(): {
-        version: string;
-        securityLevel: string;
-        performance: string;
-    };
-}
-export { sanitize, analyze, isDangerous, sanitizeBatch, escape, escapeAttribute, escapeUrl };
-export default Purifai;
+export { PurifaiLimitError, convert, createTextTransform, escapeHtmlText, toText, } from './src/api.js';
+export type { ConversionLimits, ConversionReport, ConversionResult, ConvertOptions, ImageMode, LayoutMode, LimitKind, LinkMode, OverflowMode, PurifaiTextTransform, ToTextOptions, } from './src/api.js';