xslt-processor 4.0.0 → 4.2.0

package/README.md

@@ -219,6 +219,54 @@ HTML per se is not strict XML. Because of that, starting on version 2.0.0, this
 - Tags like `<hr>`, `<link>` and `<meta>` don't need to be closed. The output for these tags doesn't close them (adding a `/` before the tag closes, or a corresponding close tag);
   - This rule doesn't apply for XHTML, which is strict XML.
 
+### Whitespace Handling
+
+This library supports `xsl:strip-space` and `xsl:preserve-space` for controlling whitespace in the input document.
+
+#### `xsl:strip-space`
+
+Use `<xsl:strip-space>` to remove whitespace-only text nodes from specified elements in the input document:
+
+```xml
+<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+    <!-- Strip whitespace from all elements -->
+    <xsl:strip-space elements="*"/>
+
+    <!-- Or strip from specific elements -->
+    <xsl:strip-space elements="book chapter section"/>
+
+    <!-- ... templates ... -->
+</xsl:stylesheet>
+```
+
+The `elements` attribute accepts:
+- `*` - matches all elements
+- `name` - matches elements with the specified local name
+- `prefix:*` - matches all elements in a namespace
+- `prefix:name` - matches a specific element in a namespace
+- Multiple patterns separated by whitespace (e.g., `"book chapter section"`)
+
+#### `xsl:preserve-space`
+
+Use `<xsl:preserve-space>` to preserve whitespace in specific elements, overriding `xsl:strip-space`:
+
+```xml
+<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+    <xsl:strip-space elements="*"/>
+    <!-- Preserve whitespace in pre and code elements -->
+    <xsl:preserve-space elements="pre code"/>
+
+    <!-- ... templates ... -->
+</xsl:stylesheet>
+```
+
+#### Precedence Rules
+
+1. `xml:space="preserve"` attribute on an element takes highest precedence
+2. `xsl:preserve-space` overrides `xsl:strip-space` for matching elements
+3. `xsl:strip-space` applies to remaining matches
+4. By default (no declarations), whitespace is preserved
+
 ## References
 
 - XPath Specification: http://www.w3.org/TR/1999/REC-xpath-19991116

package/index.d.mts

@@ -570,6 +570,22 @@ declare class Xslt {
     outputOmitXmlDeclaration: string;
     version: string;
     firstTemplateRan: boolean;
+    /**
+     * List of element name patterns from xsl:strip-space declarations.
+     * Whitespace-only text nodes inside matching elements will be stripped.
+     */
+    stripSpacePatterns: string[];
+    /**
+     * List of element name patterns from xsl:preserve-space declarations.
+     * Whitespace-only text nodes inside matching elements will be preserved.
+     * preserve-space takes precedence over strip-space for conflicting patterns.
+     */
+    preserveSpacePatterns: string[];
+    /**
+     * Namespace aliases from xsl:namespace-alias declarations.
+     * Maps stylesheet namespace prefixes to result namespace prefixes.
+     */
+    namespaceAliases: Map<string, string>;
     constructor(options?: Partial<XsltOptions>);
     /**
      * The exported entry point of the XSL-T processor.
@@ -694,6 +710,86 @@ declare class Xslt {
      * @param template The template.
      */
     protected xsltKey(context: ExprContext, template: XNode): void;
+    /**
+     * Implements `xsl:message`.
+     * Outputs a message to the console. If terminate="yes", throws an error to stop processing.
+     * @param context The Expression Context.
+     * @param template The `<xsl:message>` node.
+     */
+    protected xsltMessage(context: ExprContext, template: XNode): Promise<void>;
+    /**
+     * Implements `xsl:namespace-alias`.
+     * Declares that a namespace URI in the stylesheet should be replaced by a different
+     * namespace URI in the output.
+     * @param template The `<xsl:namespace-alias>` node.
+     */
+    protected xsltNamespaceAlias(template: XNode): void;
+    /**
+     * Implements `xsl:number`.
+     * Inserts a formatted number into the result tree.
+     * @param context The Expression Context.
+     * @param template The `<xsl:number>` node.
+     * @param output The output node.
+     */
+    protected xsltNumber(context: ExprContext, template: XNode, output?: XNode): void;
+    /**
+     * Counts nodes for xsl:number based on level, count, and from attributes.
+     * @param context The Expression Context.
+     * @param level The counting level: 'single', 'multiple', or 'any'.
+     * @param count Pattern to match nodes to count.
+     * @param from Pattern to start counting from.
+     * @returns The count value.
+     */
+    protected xsltNumberCount(context: ExprContext, level: string, count: string | null, from: string | null): number;
+    /**
+     * Checks if a node matches a simple name pattern.
+     * @param node The node to check.
+     * @param pattern The pattern (node name) to match.
+     * @returns True if the node matches.
+     */
+    protected nodeMatchesPattern(node: XNode, pattern: string): boolean;
+    /**
+     * Gets all nodes preceding the given node in document order.
+     * @param node The reference node.
+     * @returns Array of preceding nodes.
+     */
+    protected getAllPrecedingNodes(node: XNode): XNode[];
+    /**
+     * Collects all descendant nodes of a given node.
+     * @param node The parent node.
+     * @param result The array to collect into.
+     */
+    protected collectDescendants(node: XNode, result: XNode[]): void;
+    /**
+     * Formats a number according to the format string.
+     * @param number The number to format.
+     * @param format The format string (e.g., "1", "01", "a", "A", "i", "I").
+     * @param groupingSeparator Optional grouping separator.
+     * @param groupingSize Optional grouping size.
+     * @returns The formatted number string.
+     */
+    protected xsltFormatNumber(number: number, format: string, groupingSeparator: string | null, groupingSize: string | null): string;
+    /**
+     * Converts a number to alphabetic representation.
+     * @param number The number to convert.
+     * @param uppercase Whether to use uppercase letters.
+     * @returns The alphabetic representation.
+     */
+    protected numberToAlpha(number: number, uppercase: boolean): string;
+    /**
+     * Converts a number to Roman numeral representation.
+     * @param number The number to convert.
+     * @returns The Roman numeral string.
+     */
+    protected numberToRoman(number: number): string;
+    /**
+     * Applies grouping separators to a numeric string.
+     * @param numStr The numeric string.
+     * @param separator The grouping separator.
+     * @param size The grouping size.
+     * @returns The grouped string.
+     */
+    protected applyGrouping(numStr: string, separator: string, size: number): string;
     /**
      * Orders the current node list in the input context according to the
      * sort order specified by xsl:sort child nodes of the current
@@ -704,6 +800,39 @@ declare class Xslt {
      * @todo case-order is not implemented.
      */
     protected xsltSort(context: ExprContext, template: XNode): void;
+    /**
+     * Implements `xsl:strip-space`.
+     * Collects element name patterns for which whitespace-only text nodes should be stripped.
+     * @param template The `<xsl:strip-space>` node.
+     */
+    protected xsltStripSpace(template: XNode): void;
+    /**
+     * Implements `xsl:preserve-space`.
+     * Collects element name patterns for which whitespace-only text nodes should be preserved.
+     * preserve-space takes precedence over strip-space for matching elements.
+     * @param template The `<xsl:preserve-space>` node.
+     */
+    protected xsltPreserveSpace(template: XNode): void;
+    /**
+     * Determines if a text node from the input document should be stripped.
+     * This applies xsl:strip-space and xsl:preserve-space rules to whitespace-only text nodes.
+     * @param textNode The text node to check.
+     * @returns True if the text node should be stripped (not included in output).
+     */
+    protected shouldStripWhitespaceNode(textNode: XNode): boolean;
+    /**
+     * Matches an element name against a strip-space/preserve-space pattern.
+     * Supports:
+     * - "*" matches any element
+     * - "prefix:*" matches any element in a namespace
+     * - "name" matches elements with that local name
+     * - "prefix:name" matches elements with that QName
+     * @param elementName The local name of the element.
+     * @param pattern The pattern to match against.
+     * @param element The element node (for namespace checking).
+     * @returns True if the element matches the pattern.
+     */
+    protected matchesNamePattern(elementName: string, pattern: string, element: XNode): boolean;
     /**
      * Implements `xsl:template`.
      * @param context The Expression Context.

package/index.d.ts

@@ -570,6 +570,22 @@ declare class Xslt {
     outputOmitXmlDeclaration: string;
     version: string;
     firstTemplateRan: boolean;
+    /**
+     * List of element name patterns from xsl:strip-space declarations.
+     * Whitespace-only text nodes inside matching elements will be stripped.
+     */
+    stripSpacePatterns: string[];
+    /**
+     * List of element name patterns from xsl:preserve-space declarations.
+     * Whitespace-only text nodes inside matching elements will be preserved.
+     * preserve-space takes precedence over strip-space for conflicting patterns.
+     */
+    preserveSpacePatterns: string[];
+    /**
+     * Namespace aliases from xsl:namespace-alias declarations.
+     * Maps stylesheet namespace prefixes to result namespace prefixes.
+     */
+    namespaceAliases: Map<string, string>;
     constructor(options?: Partial<XsltOptions>);
     /**
      * The exported entry point of the XSL-T processor.
@@ -694,6 +710,86 @@ declare class Xslt {
      * @param template The template.
      */
     protected xsltKey(context: ExprContext, template: XNode): void;
+    /**
+     * Implements `xsl:message`.
+     * Outputs a message to the console. If terminate="yes", throws an error to stop processing.
+     * @param context The Expression Context.
+     * @param template The `<xsl:message>` node.
+     */
+    protected xsltMessage(context: ExprContext, template: XNode): Promise<void>;
+    /**
+     * Implements `xsl:namespace-alias`.
+     * Declares that a namespace URI in the stylesheet should be replaced by a different
+     * namespace URI in the output.
+     * @param template The `<xsl:namespace-alias>` node.
+     */
+    protected xsltNamespaceAlias(template: XNode): void;
+    /**
+     * Implements `xsl:number`.
+     * Inserts a formatted number into the result tree.
+     * @param context The Expression Context.
+     * @param template The `<xsl:number>` node.
+     * @param output The output node.
+     */
+    protected xsltNumber(context: ExprContext, template: XNode, output?: XNode): void;
+    /**
+     * Counts nodes for xsl:number based on level, count, and from attributes.
+     * @param context The Expression Context.
+     * @param level The counting level: 'single', 'multiple', or 'any'.
+     * @param count Pattern to match nodes to count.
+     * @param from Pattern to start counting from.
+     * @returns The count value.
+     */
+    protected xsltNumberCount(context: ExprContext, level: string, count: string | null, from: string | null): number;
+    /**
+     * Checks if a node matches a simple name pattern.
+     * @param node The node to check.
+     * @param pattern The pattern (node name) to match.
+     * @returns True if the node matches.
+     */
+    protected nodeMatchesPattern(node: XNode, pattern: string): boolean;
+    /**
+     * Gets all nodes preceding the given node in document order.
+     * @param node The reference node.
+     * @returns Array of preceding nodes.
+     */
+    protected getAllPrecedingNodes(node: XNode): XNode[];
+    /**
+     * Collects all descendant nodes of a given node.
+     * @param node The parent node.
+     * @param result The array to collect into.
+     */
+    protected collectDescendants(node: XNode, result: XNode[]): void;
+    /**
+     * Formats a number according to the format string.
+     * @param number The number to format.
+     * @param format The format string (e.g., "1", "01", "a", "A", "i", "I").
+     * @param groupingSeparator Optional grouping separator.
+     * @param groupingSize Optional grouping size.
+     * @returns The formatted number string.
+     */
+    protected xsltFormatNumber(number: number, format: string, groupingSeparator: string | null, groupingSize: string | null): string;
+    /**
+     * Converts a number to alphabetic representation.
+     * @param number The number to convert.
+     * @param uppercase Whether to use uppercase letters.
+     * @returns The alphabetic representation.
+     */
+    protected numberToAlpha(number: number, uppercase: boolean): string;
+    /**
+     * Converts a number to Roman numeral representation.
+     * @param number The number to convert.
+     * @returns The Roman numeral string.
+     */
+    protected numberToRoman(number: number): string;
+    /**
+     * Applies grouping separators to a numeric string.
+     * @param numStr The numeric string.
+     * @param separator The grouping separator.
+     * @param size The grouping size.
+     * @returns The grouped string.
+     */
+    protected applyGrouping(numStr: string, separator: string, size: number): string;
     /**
      * Orders the current node list in the input context according to the
      * sort order specified by xsl:sort child nodes of the current
@@ -704,6 +800,39 @@ declare class Xslt {
      * @todo case-order is not implemented.
      */
     protected xsltSort(context: ExprContext, template: XNode): void;
+    /**
+     * Implements `xsl:strip-space`.
+     * Collects element name patterns for which whitespace-only text nodes should be stripped.
+     * @param template The `<xsl:strip-space>` node.
+     */
+    protected xsltStripSpace(template: XNode): void;
+    /**
+     * Implements `xsl:preserve-space`.
+     * Collects element name patterns for which whitespace-only text nodes should be preserved.
+     * preserve-space takes precedence over strip-space for matching elements.
+     * @param template The `<xsl:preserve-space>` node.
+     */
+    protected xsltPreserveSpace(template: XNode): void;
+    /**
+     * Determines if a text node from the input document should be stripped.
+     * This applies xsl:strip-space and xsl:preserve-space rules to whitespace-only text nodes.
+     * @param textNode The text node to check.
+     * @returns True if the text node should be stripped (not included in output).
+     */
+    protected shouldStripWhitespaceNode(textNode: XNode): boolean;
+    /**
+     * Matches an element name against a strip-space/preserve-space pattern.
+     * Supports:
+     * - "*" matches any element
+     * - "prefix:*" matches any element in a namespace
+     * - "name" matches elements with that local name
+     * - "prefix:name" matches elements with that QName
+     * @param elementName The local name of the element.
+     * @param pattern The pattern to match against.
+     * @param element The element node (for namespace checking).
+     * @returns True if the element matches the pattern.
+     */
+    protected matchesNamePattern(elementName: string, pattern: string, element: XNode): boolean;
     /**
      * Implements `xsl:template`.
      * @param context The Expression Context.