@arsedizioni/ars-utils 22.6.86 → 22.6.88

package/types/arsedizioni-ars-utils-core.markdown.d.ts

@@ -1,7 +1,6 @@
-import * as i0 from '@angular/core';
-import { PipeTransform } from '@angular/core';
-import { SafeHtml } from '@angular/platform-browser';
-
+import * as i0 from "@angular/core";
+import { PipeTransform } from "@angular/core";
+import { SafeHtml } from "@angular/platform-browser";
 /**
  * Zero-dependency Markdown to HTML converter.
  *
@@ -28,132 +27,135 @@ import { SafeHtml } from '@angular/platform-browser';
  * - Setext headings (=== / ---) are not supported, use # syntax.
  * - Reference-style links [text][ref] are not supported.
  */
-interface MarkdownOptions {
-    /**
-     * Escape raw HTML found in the source as entities (default: false).
-     * When false (default) no &/</>/" entities are ever produced:
-     * the text is emitted as-is. Enable ONLY when rendering untrusted input,
-     * since raw HTML in the source would otherwise reach the DOM (XSS).
-     */
-    escapeHtml?: boolean;
-    /** Render single newlines inside paragraphs as <br> (default: true). */
-    breaks?: boolean;
+export interface MarkdownOptions {
+  /**
+   * Escape raw HTML found in the source as entities (default: false).
+   * When false (default) no &amp;/&lt;/&gt;/&quot; entities are ever produced:
+   * the text is emitted as-is. Enable ONLY when rendering untrusted input,
+   * since raw HTML in the source would otherwise reach the DOM (XSS).
+   */
+  escapeHtml?: boolean;
+  /** Render single newlines inside paragraphs as <br> (default: true). */
+  breaks?: boolean;
 }
-declare class MarkdownUtils {
-    private static readonly cache;
-    private static readonly CACHE_MAX;
-    /** Clears the internal result cache. */
-    static clearCache(): void;
-    /**
-     * Convert markdown to HTML.
-     * @param markdown : the markdown source
-     * @param options  : conversion options
-     * @returns        : the HTML string ('' when input is falsy)
-     */
-    static toHtml(markdown?: string, options?: MarkdownOptions): string;
-    /** Block-level HTML tags that start a raw HTML block (passthrough, no <p>/<br>). */
-    private static readonly htmlBlockTags;
-    /** Void/self-contained tags: a single tag, no closing tag expected. */
-    private static readonly htmlVoidTags;
-    /**
-     * Precompiled: first block-level tag occurrence anywhere in a line.
-     * Anchored on the '<' literal, so scanning is cheap; the lookahead
-     * prevents partial matches ('<td' must not match inside '<tdx').
-     */
-    private static readonly htmlBlockScanRe;
-    /** Result of scanning a line for the start of a raw HTML block. */
-    private static findHtmlBlockStart;
-    /** True when `index` falls inside an inline code span (odd backtick count before it). */
-    private static insideCodeSpan;
-    /**
-     * indexOf-based depth scanner (no regex, no allocations): walks `text`
-     * adjusting `depth` for <tag ...> / </tag> occurrences of the SAME tag.
-     * Self-closing <tag ... /> forms do not alter depth.
-     * @returns [newDepth, endIndex] where endIndex is the position right after
-     *          the '>' that balanced the element, or -1 when still open.
-     */
-    private static scanHtmlDepth;
-    /** A tag token must be followed by whitespace, '/', '>' or end of line. */
-    private static isTagBoundary;
-    /**
-     * Re-injects the remainder of a partially consumed line so the main loop
-     * processes it as markdown. Returns the index the loop should resume from.
-     */
-    private static pushBack;
-    /**
-     * Emits a raw HTML block starting at `hit.index` of lines[i], consuming
-     * following lines until the element is balanced. Text after the block on
-     * the closing line is pushed back for markdown processing.
-     * @returns the index of the last consumed line
-     */
-    private static emitHtmlBlock;
-    private static parseBlocks;
-    /** Matches "- item", "* item", "+ item", "1. item", "1) item" with leading indent. */
-    private static readonly listItemRe;
-    /**
-     * Gathers the contiguous list block starting at `start`, builds it (with
-     * nesting) and returns [html, indexOfLastConsumedLine].
-     */
-    private static parseList;
-    private static buildList;
-    private static tableAligns;
-    private static tableRow;
-    /**
-     * Applies inline markdown to a single text segment.
-     * Generated HTML (code, links, images, autolinks) is stashed behind \u0000
-     * placeholders so later regex passes can never corrupt it.
-     */
-    private static inline;
-    /** Escapes quotes for safe interpolation inside a double-quoted HTML attribute. */
-    private static escapeAttr;
-    /** Escapes &, <, > and " for safe HTML interpolation. */
-    private static escape;
-    /**
-     * Returns a sanitized URL or undefined when the scheme is dangerous.
-     * Blocks javascript:, vbscript: and data: (also when obfuscated with
-     * whitespace/control characters, e.g. "java\tscript:").
-     */
-    private static safeUrl;
-    /**
-     * Copies markdown content to the clipboard in two flavors:
-     * - text/html  : the rendered HTML (rich paste into Word, Outlook, Gmail...)
-     * - text/plain : the original markdown source (paste into editors, IDEs...)
-     * @param markdown : the markdown source
-     * @param options  : conversion options for the HTML flavor
-     * @returns        : true on success
-     */
-    static copyToClipboard(markdown?: string, options?: MarkdownOptions): Promise<boolean>;
-    /**
-     * Copies plain text (e.g. the content of a single code block) to the clipboard.
-     * @param text : the text to copy
-     * @returns    : true on success
-     */
-    static copyText(text?: string): Promise<boolean>;
-    /**
-     * Extracts the visible plain text from a rendered element
-     * (what the user sees, entities already decoded by the browser).
-     * @param element : the element hosting the rendered markdown
-     * @returns       : the plain text
-     */
-    static elementToText(element: HTMLElement): string;
+export declare class MarkdownUtils {
+  private static readonly cache;
+  private static readonly CACHE_MAX;
+  /** Clears the internal result cache. */
+  static clearCache(): void;
+  /**
+   * Convert markdown to HTML.
+   * @param markdown : the markdown source
+   * @param options  : conversion options
+   * @returns        : the HTML string ('' when input is falsy)
+   */
+  static toHtml(markdown?: string, options?: MarkdownOptions): string;
+  /** Block-level HTML tags that start a raw HTML block (passthrough, no <p>/<br>). */
+  private static readonly htmlBlockTags;
+  /** Void/self-contained tags: a single tag, no closing tag expected. */
+  private static readonly htmlVoidTags;
+  /**
+   * Precompiled: first block-level tag occurrence anywhere in a line.
+   * Anchored on the '<' literal, so scanning is cheap; the lookahead
+   * prevents partial matches ('<td' must not match inside '<tdx').
+   */
+  private static readonly htmlBlockScanRe;
+  /** Result of scanning a line for the start of a raw HTML block. */
+  private static findHtmlBlockStart;
+  /** True when `index` falls inside an inline code span (odd backtick count before it). */
+  private static insideCodeSpan;
+  /**
+   * indexOf-based depth scanner (no regex, no allocations): walks `text`
+   * adjusting `depth` for <tag ...> / </tag> occurrences of the SAME tag.
+   * Self-closing <tag ... /> forms do not alter depth.
+   * @returns [newDepth, endIndex] where endIndex is the position right after
+   *          the '>' that balanced the element, or -1 when still open.
+   */
+  private static scanHtmlDepth;
+  /** A tag token must be followed by whitespace, '/', '>' or end of line. */
+  private static isTagBoundary;
+  /**
+   * Re-injects the remainder of a partially consumed line so the main loop
+   * processes it as markdown. Returns the index the loop should resume from.
+   */
+  private static pushBack;
+  /**
+   * Emits a raw HTML block starting at `hit.index` of lines[i], consuming
+   * following lines until the element is balanced. Text after the block on
+   * the closing line is pushed back for markdown processing.
+   * @returns the index of the last consumed line
+   */
+  private static emitHtmlBlock;
+  private static parseBlocks;
+  /** Matches "- item", "* item", "+ item", "1. item", "1) item" with leading indent. */
+  private static readonly listItemRe;
+  /**
+   * Gathers the contiguous list block starting at `start`, builds it (with
+   * nesting) and returns [html, indexOfLastConsumedLine].
+   */
+  private static parseList;
+  private static buildList;
+  private static tableAligns;
+  private static tableRow;
+  /**
+   * Applies inline markdown to a single text segment.
+   * Generated HTML (code, links, images, autolinks) is stashed behind \u0000
+   * placeholders so later regex passes can never corrupt it.
+   */
+  private static inline;
+  /** Escapes quotes for safe interpolation inside a double-quoted HTML attribute. */
+  private static escapeAttr;
+  /** Escapes &, <, > and " for safe HTML interpolation. */
+  private static escape;
+  /**
+   * Returns a sanitized URL or undefined when the scheme is dangerous.
+   * Blocks javascript:, vbscript: and data: (also when obfuscated with
+   * whitespace/control characters, e.g. "java\tscript:").
+   */
+  private static safeUrl;
+  /**
+   * Copies markdown content to the clipboard in two flavors:
+   * - text/html  : the rendered HTML (rich paste into Word, Outlook, Gmail...)
+   * - text/plain : the original markdown source (paste into editors, IDEs...)
+   * @param markdown : the markdown source
+   * @param options  : conversion options for the HTML flavor
+   * @returns        : true on success
+   */
+  static copyToClipboard(markdown?: string, options?: MarkdownOptions): Promise<boolean>;
+  /**
+   * Copies plain text (e.g. the content of a single code block) to the clipboard.
+   * @param text : the text to copy
+   * @returns    : true on success
+   */
+  static copyText(text?: string): Promise<boolean>;
+  /**
+   * Extracts the visible plain text from a rendered element
+   * (what the user sees, entities already decoded by the browser).
+   * @param element : the element hosting the rendered markdown
+   * @returns       : the plain text
+   */
+  static elementToText(element: HTMLElement): string;
 }
-
 /**
  * Pipe that converts a Markdown string to sanitized HTML using `MarkdownUtils.toHtml`.
  *
  * Usage: `{{ text | formatMarkdown }}`
+ *
+ * The Markdown is converted with raw HTML blocks passed through -- a table written as HTML stays a
+ * table -- and the result goes through Angular's HTML sanitizer BEFORE it is marked as trusted:
+ * scripts, event handlers, `javascript:` URLs and inline styles are stripped, the safe elements and
+ * their safe attributes (`class` included) are kept. Without that step the pipe trusted whatever the
+ * Markdown carried, and Markdown is often somebody else's text: the answer of an assistant quoting
+ * a record a user typed, a comment, a description.
  */
-declare class FormatMarkdownPipe implements PipeTransform {
-    private readonly sanitizer;
-    /**
-     * Transforms a Markdown string into sanitized HTML.
-     * @param value - The Markdown input to convert. Treated as an empty string when `undefined`.
-     * @returns A `SafeHtml` value that can be rendered with `[innerHTML]`.
-     */
-    transform(value?: string): SafeHtml;
-    static ɵfac: i0.ɵɵFactoryDeclaration<FormatMarkdownPipe, never>;
-    static ɵpipe: i0.ɵɵPipeDeclaration<FormatMarkdownPipe, "formatMarkdown", true>;
-}
-
-export { FormatMarkdownPipe, MarkdownUtils };
-export type { MarkdownOptions };
+export declare class FormatMarkdownPipe implements PipeTransform {
+  private readonly sanitizer;
+  /**
+   * Transforms a Markdown string into sanitized HTML.
+   * @param value - The Markdown input to convert. Treated as an empty string when `undefined`.
+   * @returns A `SafeHtml` value that can be rendered with `[innerHTML]`.
+   */
+  transform(value?: string): SafeHtml;
+  static ɵfac: i0.ɵɵFactoryDeclaration<FormatMarkdownPipe, never>;
+  static ɵpipe: i0.ɵɵPipeDeclaration<FormatMarkdownPipe, "formatMarkdown", true>;
+}