xslt-processor 3.0.1 → 3.0.2

package/xslt/xslt-decimal-format-settings.d.ts

@@ -1,28 +1,28 @@
-/**
- * According to https://www.w3schools.com/xml/ref_xsl_el_decimal-format.asp:
- *
- * @property {string} name: Optional. Specifies a name for this format.
- * @property {string} decimalSeparator: Optional. Specifies the decimal point character. Default is ".".
- * @property {string} groupingSeparator: Optional. Specifies the thousands separator character. Default is ",".
- * @property {string} infinity: Optional. Specifies the string used to represent infinity. Default is "Infinity".
- * @property {string} minusSign: Optional. Specifies the character to represent negative numbers. Default is "-".
- * @property {string} naN: Optional. Specifies the string used when the value is not a number". Default is "NaN".
- * @property {string} percent: Optional. Specifies the percentage sign character. Default is "%".
- * @property {string} perMille: Optional. Specifies the per thousand sign character. Default is "‰".
- * @property {string} zeroDigit: Optional. Specifies the digit zero character. Default is "0".
- * @property {string} digit: Optional. Specifies the character used to indicate a place where a digit is required. Default is #.
- * @property {string} patternSeparator: Optional. Specifies the character used to separate positive and negative subpatterns in a format pattern. Default is ";".
- */
-export type XsltDecimalFormatSettings = {
-    name?: string;
-    decimalSeparator: string;
-    groupingSeparator: string;
-    infinity: string;
-    minusSign: string;
-    naN: string;
-    percent: string;
-    perMille: string;
-    zeroDigit: string;
-    digit: string;
-    patternSeparator: string;
-};
+/**
+ * According to https://www.w3schools.com/xml/ref_xsl_el_decimal-format.asp:
+ *
+ * @property {string} name: Optional. Specifies a name for this format.
+ * @property {string} decimalSeparator: Optional. Specifies the decimal point character. Default is ".".
+ * @property {string} groupingSeparator: Optional. Specifies the thousands separator character. Default is ",".
+ * @property {string} infinity: Optional. Specifies the string used to represent infinity. Default is "Infinity".
+ * @property {string} minusSign: Optional. Specifies the character to represent negative numbers. Default is "-".
+ * @property {string} naN: Optional. Specifies the string used when the value is not a number". Default is "NaN".
+ * @property {string} percent: Optional. Specifies the percentage sign character. Default is "%".
+ * @property {string} perMille: Optional. Specifies the per thousand sign character. Default is "‰".
+ * @property {string} zeroDigit: Optional. Specifies the digit zero character. Default is "0".
+ * @property {string} digit: Optional. Specifies the character used to indicate a place where a digit is required. Default is #.
+ * @property {string} patternSeparator: Optional. Specifies the character used to separate positive and negative subpatterns in a format pattern. Default is ";".
+ */
+export type XsltDecimalFormatSettings = {
+    name?: string;
+    decimalSeparator: string;
+    groupingSeparator: string;
+    infinity: string;
+    minusSign: string;
+    naN: string;
+    percent: string;
+    perMille: string;
+    zeroDigit: string;
+    digit: string;
+    patternSeparator: string;
+};

package/xslt/xslt-decimal-format-settings.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=xslt-decimal-format-settings.js.map

package/xslt/xslt-options.d.ts

@@ -1,7 +1,7 @@
-import { XsltParameter } from "./xslt-parameter";
-export type XsltOptions = {
-    cData: boolean;
-    escape: boolean;
-    selfClosingTags: boolean;
-    parameters?: XsltParameter[];
-};
+import { XsltParameter } from "./xslt-parameter";
+export type XsltOptions = {
+    cData: boolean;
+    escape: boolean;
+    selfClosingTags: boolean;
+    parameters?: XsltParameter[];
+};

package/xslt/xslt-options.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=xslt-options.js.map

package/xslt/xslt-parameter.d.ts

@@ -1,5 +1,5 @@
-export type XsltParameter = {
-    name: string;
-    namespaceUri?: string;
-    value: any;
-};
+export type XsltParameter = {
+    name: string;
+    namespaceUri?: string;
+    value: any;
+};

package/xslt/xslt-parameter.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=xslt-parameter.js.map

package/xslt/xslt.d.ts

@@ -1,207 +1,207 @@
-import { XDocument, XNode, XmlParser } from '../dom';
-import { ExprContext, XPath } from '../xpath';
-import { XsltOptions } from './xslt-options';
-import { XsltDecimalFormatSettings } from './xslt-decimal-format-settings';
-import { MatchResolver } from '../xpath/match-resolver';
-/**
- * The main class for XSL-T processing. The implementation is NOT
- * complete; some xsl element are left out.
- *
- * References:
- *
- * [XSLT] XSL-T Specification
- * <http://www.w3.org/TR/1999/REC-xslt-19991116>.
- *
- * [ECMA] ECMAScript Language Specification
- * <http://www.ecma-international.org/publications/standards/Ecma-262.htm>.
- *
- * The XSL processor API has one entry point, the function
- * xsltProcessContext(). It receives as arguments the starting point in the
- * input document as an XPath expression context, the DOM root node of
- * the XSL-T stylesheet, and a DOM node that receives the output.
- *
- * NOTE: Actually, XSL-T processing according to the specification is
- * defined as operation on text documents, not as operation on DOM
- * trees. So, strictly speaking, this implementation is not an XSL-T
- * processor, but the processing engine that needs to be complemented
- * by an XML parser and serializer in order to be complete. Those two
- * are found in the `dom` folder.
- */
-export declare class Xslt {
-    xPath: XPath;
-    xmlParser: XmlParser;
-    matchResolver: MatchResolver;
-    options: XsltOptions;
-    decimalFormatSettings: XsltDecimalFormatSettings;
-    outputDocument: XDocument;
-    outputMethod: 'xml' | 'html' | 'text' | 'name';
-    outputOmitXmlDeclaration: string;
-    version: string;
-    constructor(options?: Partial<XsltOptions>);
-    /**
-     * The exported entry point of the XSL-T processor.
-     * @param xmlDoc The input document root, as DOM node.
-     * @param stylesheet The stylesheet document root, as DOM node.
-     * @returns the processed document, as XML text in a string.
-     */
-    xsltProcess(xmlDoc: XDocument, stylesheet: XDocument): Promise<string>;
-    /**
-     * The main entry point of the XSL-T processor, as explained on the top of the file.
-     * @param context The input document root, as XPath `ExprContext`.
-     * @param template The stylesheet document root, as DOM node.
-     * @param output If set, the output where the transformation should occur.
-     */
-    protected xsltProcessContext(context: ExprContext, template: XNode, output?: XNode): Promise<void>;
-    /**
-     * Implements `xsl:apply-templates`.
-     * @param context The Expression Context.
-     * @param template The template.
-     * @param output The output. Only used if there's no corresponding output node already defined.
-     * @protected
-     */
-    protected xsltApplyTemplates(context: ExprContext, template: XNode, output?: XNode): Promise<void>;
-    /**
-     * Implements `xsl:attribute`.
-     * @param context The Expression Context.
-     * @param template The template.
-     * @param output The output. Only used if there's no corresponding output node already defined.
-     * @protected
-     */
-    protected xsltAttribute(context: ExprContext, template: XNode, output?: XNode): Promise<void>;
-    /**
-     * Implements `xsl:choose`, its child nodes `xsl:when`, and
-     * `xsl:otherwise`.
-     * @param context The Expression Context.
-     * @param template The template.
-     * @param output The output. Only used if there's no corresponding output node already defined.
-     */
-    protected xsltChoose(context: ExprContext, template: XNode, output: XNode): Promise<void>;
-    /**
-     * Implements `xsl:copy` for all node types.
-     * @param {XNode} destination the node being copied to, part of output document.
-     * @param {XNode} source the node being copied, part in input document.
-     * @returns {XNode|null} If an element node was created, the element node. Otherwise, null.
-     */
-    protected xsltCopy(destination: XNode, source: XNode): XNode;
-    /**
-     * Implements `xsl:copy-of` for node-set values of the select
-     * expression. Recurses down the source node tree, which is part of
-     * the input document.
-     * @param {XNode} destination the node being copied to, part of output document.
-     * @param {XNode} source the node being copied, part in input document.
-     */
-    protected xsltCopyOf(destination: XNode, source: XNode): void;
-    /**
-     * Implements `xsl:for-each`.
-     * @param context The Expression Context.
-     * @param template The template.
-     * @param output The output.
-     */
-    protected xsltForEach(context: ExprContext, template: XNode, output: XNode): Promise<void>;
-    /**
-     * Implements `xsl:include`.
-     * @param context The Expression Context.
-     * @param template The template.
-     * @param output The output.
-     */
-    protected xsltInclude(context: ExprContext, template: XNode, output: XNode): Promise<void>;
-    /**
-     * Orders the current node list in the input context according to the
-     * sort order specified by xsl:sort child nodes of the current
-     * template node. This happens before the operation specified by the
-     * current template node is executed.
-     * @param context The expression context.
-     * @param template The template node.
-     * @todo case-order is not implemented.
-     */
-    protected xsltSort(context: ExprContext, template: XNode): void;
-    /**
-     * Implements `<xsl:stylesheet>` and `<xsl:transform>`, and its corresponding
-     * validations.
-     * @param template The `<xsl:stylesheet>` or `<xsl:transform>` node.
-     * @param context The Expression Context.
-     * @param output The output XML.
-     */
-    protected xsltTransformOrStylesheet(template: XNode, context: ExprContext, output: XNode): Promise<void>;
-    /**
-     * Evaluates a variable or parameter and set it in the current input
-     * context. Implements `xsl:variable`, `xsl:param`, and `xsl:with-param`.
-     *
-     * @param context The expression context.
-     * @param template The template node.
-     * @param override flag that defines if the value computed here
-     * overrides the one already in the input context if that is the
-     * case. I.e. decides if this is a default value or a local
-     * value. `xsl:variable` and `xsl:with-param` override; `xsl:param` doesn't.
-     */
-    protected xsltVariable(context: ExprContext, template: XNode, override: boolean): Promise<void>;
-    /**
-     * Traverses the template node tree. Calls the main processing
-     * function with the current input context for every child node of the
-     * current template node.
-     * @param context Normally the Expression Context.
-     * @param template The XSL-T definition.
-     * @param output If set, the output where the transformation should occur.
-     */
-    protected xsltChildNodes(context: ExprContext, template: XNode, output?: XNode): Promise<void>;
-    /**
-     * This logic is used in two different places:
-     * - `xsltPassThrough`, if the template asks this library to write a text node;
-     * - `xsltProcessContext`, `apply-templates` operation, when the current node is text.
-     * @param context The Expression Context.
-     * @param template The template, that contains the node value to be written.
-     * @param output The output.
-     */
-    private commonLogicTextNode;
-    /**
-     * Passes template text to the output. The current template node does
-     * not specify an XSL-T operation and therefore is appended to the
-     * output with all its attributes. Then continues traversing the
-     * template node tree.
-     * @param context The Expression Context.
-     * @param template The XSLT stylesheet or transformation.
-     * @param output The output.
-     */
-    protected xsltPassThrough(context: ExprContext, template: XNode, output: XNode): Promise<void>;
-    /**
-     * Determines if a text node in the XSLT template document is to be
-     * stripped according to XSLT whitespace stripping rules.
-     * @see [XSLT], section 3.4.
-     * @param template The XSLT template.
-     * @returns TODO
-     * @todo Whitespace stripping on the input document is
-     * currently not implemented.
-     */
-    protected xsltPassText(template: XNode): boolean;
-    protected findAttributeInContext(attributeName: string, context: ExprContext): XNode;
-    /**
-     * Evaluates an XSL-T attribute value template. Attribute value
-     * templates are attributes on XSL-T elements that contain XPath
-     * expressions in braces {}. The XSL-T expressions are evaluated in
-     * the current input context.
-     * @param value TODO
-     * @param context TODO
-     * @returns TODO
-     */
-    protected xsltAttributeValue(value: any, context: ExprContext): any;
-    /**
-     * Evaluates an XPath expression in the current input context as a
-     * match.
-     * @see [XSLT] section 5.2, paragraph 1
-     * @param match TODO
-     * @param context The Expression Context.
-     * @param axis The XPath axis. Used when the match does not start with the parent.
-     * @returns {XNode[]} A list of the found nodes.
-     */
-    protected xsltMatch(match: string, context: ExprContext, axis?: string): XNode[];
-    /**
-     * Sets parameters defined by xsl:with-param child nodes of the
-     * current template node, in the current input context. This happens
-     * before the operation specified by the current template node is
-     * executed.
-     * @param context The Expression Context.
-     * @param template The template node.
-     */
-    protected xsltWithParam(context: ExprContext, template: XNode): Promise<void>;
-    protected isXsltElement(element: any, opt_wantedName?: string): boolean;
-}
+import { XDocument, XNode, XmlParser } from '../dom';
+import { ExprContext, XPath } from '../xpath';
+import { XsltOptions } from './xslt-options';
+import { XsltDecimalFormatSettings } from './xslt-decimal-format-settings';
+import { MatchResolver } from '../xpath/match-resolver';
+/**
+ * The main class for XSL-T processing. The implementation is NOT
+ * complete; some xsl element are left out.
+ *
+ * References:
+ *
+ * [XSLT] XSL-T Specification
+ * <http://www.w3.org/TR/1999/REC-xslt-19991116>.
+ *
+ * [ECMA] ECMAScript Language Specification
+ * <http://www.ecma-international.org/publications/standards/Ecma-262.htm>.
+ *
+ * The XSL processor API has one entry point, the function
+ * xsltProcessContext(). It receives as arguments the starting point in the
+ * input document as an XPath expression context, the DOM root node of
+ * the XSL-T stylesheet, and a DOM node that receives the output.
+ *
+ * NOTE: Actually, XSL-T processing according to the specification is
+ * defined as operation on text documents, not as operation on DOM
+ * trees. So, strictly speaking, this implementation is not an XSL-T
+ * processor, but the processing engine that needs to be complemented
+ * by an XML parser and serializer in order to be complete. Those two
+ * are found in the `dom` folder.
+ */
+export declare class Xslt {
+    xPath: XPath;
+    xmlParser: XmlParser;
+    matchResolver: MatchResolver;
+    options: XsltOptions;
+    decimalFormatSettings: XsltDecimalFormatSettings;
+    outputDocument: XDocument;
+    outputMethod: 'xml' | 'html' | 'text' | 'name';
+    outputOmitXmlDeclaration: string;
+    version: string;
+    constructor(options?: Partial<XsltOptions>);
+    /**
+     * The exported entry point of the XSL-T processor.
+     * @param xmlDoc The input document root, as DOM node.
+     * @param stylesheet The stylesheet document root, as DOM node.
+     * @returns the processed document, as XML text in a string.
+     */
+    xsltProcess(xmlDoc: XDocument, stylesheet: XDocument): Promise<string>;
+    /**
+     * The main entry point of the XSL-T processor, as explained on the top of the file.
+     * @param context The input document root, as XPath `ExprContext`.
+     * @param template The stylesheet document root, as DOM node.
+     * @param output If set, the output where the transformation should occur.
+     */
+    protected xsltProcessContext(context: ExprContext, template: XNode, output?: XNode): Promise<void>;
+    /**
+     * Implements `xsl:apply-templates`.
+     * @param context The Expression Context.
+     * @param template The template.
+     * @param output The output. Only used if there's no corresponding output node already defined.
+     * @protected
+     */
+    protected xsltApplyTemplates(context: ExprContext, template: XNode, output?: XNode): Promise<void>;
+    /**
+     * Implements `xsl:attribute`.
+     * @param context The Expression Context.
+     * @param template The template.
+     * @param output The output. Only used if there's no corresponding output node already defined.
+     * @protected
+     */
+    protected xsltAttribute(context: ExprContext, template: XNode, output?: XNode): Promise<void>;
+    /**
+     * Implements `xsl:choose`, its child nodes `xsl:when`, and
+     * `xsl:otherwise`.
+     * @param context The Expression Context.
+     * @param template The template.
+     * @param output The output. Only used if there's no corresponding output node already defined.
+     */
+    protected xsltChoose(context: ExprContext, template: XNode, output?: XNode): Promise<void>;
+    /**
+     * Implements `xsl:copy` for all node types.
+     * @param {XNode} destination the node being copied to, part of output document.
+     * @param {XNode} source the node being copied, part in input document.
+     * @returns {XNode|null} If an element node was created, the element node. Otherwise, null.
+     */
+    protected xsltCopy(destination: XNode, source: XNode): XNode;
+    /**
+     * Implements `xsl:copy-of` for node-set values of the select
+     * expression. Recurses down the source node tree, which is part of
+     * the input document.
+     * @param {XNode} destination the node being copied to, part of output document.
+     * @param {XNode} source the node being copied, part in input document.
+     */
+    protected xsltCopyOf(destination: XNode, source: XNode): void;
+    /**
+     * Implements `xsl:for-each`.
+     * @param context The Expression Context.
+     * @param template The template.
+     * @param output The output.
+     */
+    protected xsltForEach(context: ExprContext, template: XNode, output: XNode): Promise<void>;
+    /**
+     * Implements `xsl:include`.
+     * @param context The Expression Context.
+     * @param template The template.
+     * @param output The output.
+     */
+    protected xsltInclude(context: ExprContext, template: XNode, output: XNode): Promise<void>;
+    /**
+     * Orders the current node list in the input context according to the
+     * sort order specified by xsl:sort child nodes of the current
+     * template node. This happens before the operation specified by the
+     * current template node is executed.
+     * @param context The expression context.
+     * @param template The template node.
+     * @todo case-order is not implemented.
+     */
+    protected xsltSort(context: ExprContext, template: XNode): void;
+    /**
+     * Implements `<xsl:stylesheet>` and `<xsl:transform>`, and its corresponding
+     * validations.
+     * @param template The `<xsl:stylesheet>` or `<xsl:transform>` node.
+     * @param context The Expression Context.
+     * @param output The output XML.
+     */
+    protected xsltTransformOrStylesheet(template: XNode, context: ExprContext, output: XNode): Promise<void>;
+    /**
+     * Evaluates a variable or parameter and set it in the current input
+     * context. Implements `xsl:variable`, `xsl:param`, and `xsl:with-param`.
+     *
+     * @param context The expression context.
+     * @param template The template node.
+     * @param override flag that defines if the value computed here
+     * overrides the one already in the input context if that is the
+     * case. I.e. decides if this is a default value or a local
+     * value. `xsl:variable` and `xsl:with-param` override; `xsl:param` doesn't.
+     */
+    protected xsltVariable(context: ExprContext, template: XNode, override: boolean): Promise<void>;
+    /**
+     * Traverses the template node tree. Calls the main processing
+     * function with the current input context for every child node of the
+     * current template node.
+     * @param context Normally the Expression Context.
+     * @param template The XSL-T definition.
+     * @param output If set, the output where the transformation should occur.
+     */
+    protected xsltChildNodes(context: ExprContext, template: XNode, output?: XNode): Promise<void>;
+    /**
+     * This logic is used in two different places:
+     * - `xsltPassThrough`, if the template asks this library to write a text node;
+     * - `xsltProcessContext`, `apply-templates` operation, when the current node is text.
+     * @param context The Expression Context.
+     * @param template The template, that contains the node value to be written.
+     * @param output The output.
+     */
+    private commonLogicTextNode;
+    /**
+     * Passes template text to the output. The current template node does
+     * not specify an XSL-T operation and therefore is appended to the
+     * output with all its attributes. Then continues traversing the
+     * template node tree.
+     * @param context The Expression Context.
+     * @param template The XSLT stylesheet or transformation.
+     * @param output The output.
+     */
+    protected xsltPassThrough(context: ExprContext, template: XNode, output: XNode): Promise<void>;
+    /**
+     * Determines if a text node in the XSLT template document is to be
+     * stripped according to XSLT whitespace stripping rules.
+     * @see [XSLT], section 3.4.
+     * @param template The XSLT template.
+     * @returns TODO
+     * @todo Whitespace stripping on the input document is
+     * currently not implemented.
+     */
+    protected xsltPassText(template: XNode): boolean;
+    protected findAttributeInContext(attributeName: string, context: ExprContext): XNode;
+    /**
+     * Evaluates an XSL-T attribute value template. Attribute value
+     * templates are attributes on XSL-T elements that contain XPath
+     * expressions in braces {}. The XSL-T expressions are evaluated in
+     * the current input context.
+     * @param value TODO
+     * @param context TODO
+     * @returns TODO
+     */
+    protected xsltAttributeValue(value: any, context: ExprContext): any;
+    /**
+     * Evaluates an XPath expression in the current input context as a
+     * match.
+     * @see [XSLT] section 5.2, paragraph 1
+     * @param match TODO
+     * @param context The Expression Context.
+     * @param axis The XPath axis. Used when the match does not start with the parent.
+     * @returns {XNode[]} A list of the found nodes.
+     */
+    protected xsltMatch(match: string, context: ExprContext, axis?: string): XNode[];
+    /**
+     * Sets parameters defined by xsl:with-param child nodes of the
+     * current template node, in the current input context. This happens
+     * before the operation specified by the current template node is
+     * executed.
+     * @param context The Expression Context.
+     * @param template The template node.
+     */
+    protected xsltWithParam(context: ExprContext, template: XNode): Promise<void>;
+    protected isXsltElement(element: any, opt_wantedName?: string): boolean;
+}