xslt-processor 2.3.1 → 3.0.1

package/README.md

@@ -37,10 +37,18 @@ import { Xslt, XmlParser } from 'xslt-processor'
 // outXmlString: output xml string.
 const xslt = new Xslt();
 const xmlParser = new XmlParser();
-const outXmlString = xslt.xsltProcess(
+// Either
+const outXmlString = await xslt.xsltProcess(
 	xmlParser.xmlParse(xmlString),
 	xmlParser.xmlParse(xsltString)
 );
+// Or
+xslt.xsltProcess(
+	xmlParser.xmlParse(xmlString),
+	xmlParser.xmlParse(xsltString)
+).then(output => {
+  // `output` is equivalent to `outXmlString` (a string with XML).
+});
 ```
 
 To access the XPath parser, you can use the instance present at `Xslt` class:
@@ -88,13 +96,33 @@ const xslt = new Xslt(options);
 You can simply add a tag like this:
 
 ```html
-<script type="application/javascript" src="https://www.unpkg.com/xslt-processor@2.1.0/umd/xslt-processor.js"></script>
+<script type="application/javascript" src="https://www.unpkg.com/xslt-processor@3.0.0/umd/xslt-processor.js"></script>
 ```
 
-All the exports will live under `globalThis.XsltProcessor`. [See a usage example here](https://github.com/DesignLiquido/xslt-processor/blob/main/interactive-tests/xslt.html). 
+All the exports will live under `globalThis.XsltProcessor` and `window.XsltProcessor`. [See a usage example here](https://github.com/DesignLiquido/xslt-processor/blob/main/interactive-tests/xslt.html). 
 
 ### Breaking Changes
 
+#### Version 2
+
+Until version 2.3.1, use like the example below:
+
+```js
+import { Xslt, XmlParser } from 'xslt-processor'
+
+// xmlString: string of xml file contents
+// xsltString: string of xslt file contents
+// outXmlString: output xml string.
+const xslt = new Xslt();
+const xmlParser = new XmlParser();
+const outXmlString = xslt.xsltProcess( // Not async.
+	xmlParser.xmlParse(xmlString),
+	xmlParser.xmlParse(xsltString)
+);
+```
+
+Version 3 received `<xsl:include>` which relies on Fetch API, which is asynchronous. Version 2 doesn't support `<xsl:include>`.
+
 #### Version 1
 
 Until version 1.2.8, use like the example below:

package/dom/util.d.ts

@@ -1,5 +1,5 @@
 export declare function mapExec(array: any[], func: Function): void;
-export declare function mapExpr(array: any, func: any): any[];
+export declare function mapExpr(array: any[], func: Function): any[];
 /**
  * Reverses the given array in place.
  * @param array The array to be reversed.

package/dom/util.js.map

@@ -1 +1 @@
-{"version":3,"file":"util.js","sourceRoot":"","sources":["../../src/dom/util.ts"],"names":[],"mappings":";AAAA,qCAAqC;AACrC,+BAA+B;AAC/B,wBAAwB;AACxB,EAAE;AACF,uDAAuD;AACvD,EAAE;AACF,mDAAmD;AACnD,sEAAsE;AACtE,iCAAiC;;;AAEjC,sEAAsE;AACtE,+BAA+B;AAC/B,SAAgB,OAAO,CAAC,KAAY,EAAE,IAAc;IAChD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;QACnC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;KAChC;AACL,CAAC;AAJD,0BAIC;AAED,+DAA+D;AAC/D,wDAAwD;AACxD,SAAgB,OAAO,CAAC,KAAK,EAAE,IAAI;IAC/B,IAAM,GAAG,GAAG,EAAE,CAAC;IACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;QACnC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAC5B;IACD,OAAO,GAAG,CAAC;AACf,CAAC;AAND,0BAMC;AAED;;;GAGG;AACH,SAAgB,cAAc,CAAC,KAAY;IACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,EAAE,CAAC,EAAE;QACvC,IAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACnB,IAAM,EAAE,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;QACrB,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;KACjB;AACL,CAAC;AAPD,wCAOC"}
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../src/dom/util.ts"],"names":[],"mappings":";AAAA,qCAAqC;AACrC,+BAA+B;AAC/B,wBAAwB;AACxB,EAAE;AACF,uDAAuD;AACvD,EAAE;AACF,mDAAmD;AACnD,sEAAsE;AACtE,iCAAiC;;;AAEjC,sEAAsE;AACtE,+BAA+B;AAC/B,SAAgB,OAAO,CAAC,KAAY,EAAE,IAAc;IAChD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;QACnC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;KAChC;AACL,CAAC;AAJD,0BAIC;AAED,+DAA+D;AAC/D,wDAAwD;AACxD,SAAgB,OAAO,CAAC,KAAY,EAAE,IAAc;IAChD,IAAM,GAAG,GAAG,EAAE,CAAC;IACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;QACnC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAC5B;IACD,OAAO,GAAG,CAAC;AACf,CAAC;AAND,0BAMC;AAED;;;GAGG;AACH,SAAgB,cAAc,CAAC,KAAY;IACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,EAAE,CAAC,EAAE;QACvC,IAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACnB,IAAM,EAAE,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;QACrB,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;KACjB;AACL,CAAC;AAPD,wCAOC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xslt-processor",
-  "version": "2.3.1",
+  "version": "3.0.1",
   "description": "A JavaScript XSLT Processor",
   "main": "index.js",
   "module": "index.js",
@@ -47,18 +47,17 @@
     "@rollup/plugin-terser": "^0.4.3",
     "@rollup/plugin-typescript": "^11.1.1",
     "@types/he": "^1.2.0",
-    "@types/jest": "^29.5.2",
+    "@types/jest": "^29.5.12",
     "@typescript-eslint/eslint-plugin": "^5.60.0",
     "@typescript-eslint/parser": "^5.60.0",
-    "babel-jest": "^29.5.0",
+    "babel-jest": "^29.7.0",
     "copy-files-from-to": "^3.9.0",
+    "copyfiles": "^2.4.1",
     "eslint": "^5.12.1",
     "eslint-plugin-jest": "^27.2.2",
     "eslint-plugin-jsx": "^0.1.0",
-    "isomorphic-jsx": "^0.3.0",
-    "jest": "^29.5.0",
+    "jest": "^29.7.0",
     "npm-check-updates": "^16.10.13",
-    "react": "^18.2.0",
     "release-it": "^15.11.0",
     "rimraf": "^5.0.1",
     "rollup": "^1.1.2",
@@ -66,12 +65,13 @@
     "rollup-plugin-commonjs": "^9.2.0",
     "rollup-plugin-node-resolve": "^4.0.0",
     "rollup-plugin-terser": "^4.0.3",
-    "ts-jest": "^29.1.0",
-    "ts-node": "^10.9.1",
-    "typescript": "4.9.4"
+    "ts-jest": "^29.1.5",
+    "ts-node": "^10.9.2",
+    "typescript": "^4.9.5"
   },
   "dependencies": {
-    "he": "^1.2.0"
+    "he": "^1.2.0",
+    "node-fetch": "cjs"
   },
   "copyFiles": [
     {

package/umd/dom/util.d.ts

@@ -1,5 +1,5 @@
 export declare function mapExec(array: any[], func: Function): void;
-export declare function mapExpr(array: any, func: any): any[];
+export declare function mapExpr(array: any[], func: Function): any[];
 /**
  * Reverses the given array in place.
  * @param array The array to be reversed.

package/umd/xpath/node-tests/node-test-pi.d.ts

@@ -4,5 +4,5 @@ import { NodeTest } from "./node-test";
 export declare class NodeTestPI implements NodeTest {
     target: any;
     constructor(target: any);
-    evaluate(ctx: ExprContext): BooleanValue;
+    evaluate(context: ExprContext): BooleanValue;
 }

package/umd/xpath/tokens.d.ts

@@ -50,13 +50,13 @@ export declare const TOK_NUMBER: XPathTokenRule;
 export declare const TOK_QNAME: XPathTokenRule;
 export declare const TOK_NODEO: XPathTokenRule;
 export declare const xPathTokenRules: XPathTokenRule[];
-export declare const Q_01: {
+export declare const Q_ZERO_OR_ONE: {
     label: string;
 };
-export declare const Q_MM: {
+export declare const Q_ZERO_OR_MULTIPLE: {
     label: string;
 };
-export declare const Q_1M: {
+export declare const Q_ONE_OR_MULTIPLE: {
     label: string;
 };
 export declare const ASSOC_LEFT = true;

package/umd/xpath/xpath.d.ts

@@ -60,15 +60,15 @@ export declare class XPath {
     makeAbbrevStep(abbrev: any): StepExpr;
     makeNodeTestExpr1(): NodeTestElementOrAttribute;
     makeNodeTestExpr2(ncname: any): NodeTestNC;
-    makeNodeTestExpr3(qname: any): NodeTestName;
+    makeNodeTestExpr3(qname: TokenExpr): NodeTestName;
     makeNodeTestExpr4(typeo: any): NodeTestAny | NodeTestComment | NodeTestPI | NodeTestText;
     makeNodeTestExpr5(typeo: any, target: any): NodeTestPI;
-    makePredicateExpr(pareno: any, expr: any): PredicateExpr;
-    makePrimaryExpr(pareno: any, expr: any): any;
+    makePredicateExpr(pareno: any, expression: any): PredicateExpr;
+    makePrimaryExpr(pareno: any, expression: any): any;
     makeFunctionCallExpr1(name: any): FunctionCallExpr;
     makeFunctionCallExpr2(name: any, pareno: any, arg1: any, args: any): FunctionCallExpr;
-    makeArgumentExpr(comma: any, expr: any): any;
-    makeUnionExpr(expr1: any, pipe: any, expr2: any): UnionExpr;
+    makeArgumentExpr(comma: any, expression: any): any;
+    makeUnionExpr(expr1: Expression, pipe: TokenExpr, expr2: Expression): UnionExpr;
     makePathExpr1(filter: any, slash: any, rel: any): PathExpr;
     makePathExpr2(filter: any, dslash: any, rel: any): PathExpr;
     makeFilterExpr(expr: any, predicates: any): any;
@@ -108,7 +108,7 @@ export declare class XPath {
      *                                     performance. This is false by default.
      */
     xPathExtractTagNameFromNodeTest(nodeTest: NodeTest, ignoreNonElementNodesForNTA: any): string;
-    xPathMatchStack(stack: any, pattern: any): any;
+    xPathMatchStack(stack: any[], pattern: any[]): any;
     /**
      * Finds the best rule for the XPath expression provided.
      * @param expression The XPath string expression.
@@ -139,8 +139,8 @@ export declare class XPath {
      * grammatical rules to them, "reducing" them to higher-level
      * tokens. Ultimately, any valid XPath should reduce to exactly one
      * "Expr" token.
-
-     * Reduce too early or too late and you'll have two tokens that can't reduce
+     *
+     * Reduce too early or too late, and you'll have two tokens that can't reduce
      * to single Expr. For example, you may hastily reduce a qname that
      * should name a function, incorrectly treating it as a tag name.
      * Or you may reduce too late, accidentally reducing the last part of the
@@ -155,6 +155,10 @@ export declare class XPath {
      *
      * Some tokens have left associativity, in which case we shift when they
      * have LOWER precedence than the candidate.
+     * @param stack The actual grammar rule stack.
+     * @param ahead The grammar rule ahead.
+     * @return `true` if a grammar rule candidate was applied. `false` otherwise.
+     * @private
      */
     private xPathReduce;
     /**

package/umd/xslt/xslt.d.ts

@@ -1,4 +1,4 @@
-import { XDocument, XNode } from '../dom';
+import { XDocument, XNode, XmlParser } from '../dom';
 import { ExprContext, XPath } from '../xpath';
 import { XsltOptions } from './xslt-options';
 import { XsltDecimalFormatSettings } from './xslt-decimal-format-settings';
@@ -29,6 +29,7 @@ import { MatchResolver } from '../xpath/match-resolver';
  */
 export declare class Xslt {
     xPath: XPath;
+    xmlParser: XmlParser;
     matchResolver: MatchResolver;
     options: XsltOptions;
     decimalFormatSettings: XsltDecimalFormatSettings;
@@ -43,14 +44,30 @@ export declare class Xslt {
      * @param stylesheet The stylesheet document root, as DOM node.
      * @returns the processed document, as XML text in a string.
      */
-    xsltProcess(xmlDoc: XDocument, stylesheet: XDocument): 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): void;
+    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`.
@@ -58,7 +75,7 @@ export declare class Xslt {
      * @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): void;
+    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.
@@ -76,11 +93,18 @@ export declare class Xslt {
     protected xsltCopyOf(destination: XNode, source: XNode): void;
     /**
      * Implements `xsl:for-each`.
-     * @param input The Expression Context.
+     * @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 xsltForEach(context: ExprContext, template: XNode, output: XNode): void;
+    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
@@ -98,7 +122,7 @@ export declare class Xslt {
      * @param context The Expression Context.
      * @param output The output XML.
      */
-    protected xsltTransformOrStylesheet(template: XNode, context: ExprContext, output: XNode): void;
+    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`.
@@ -110,7 +134,7 @@ export declare class Xslt {
      * 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): void;
+    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
@@ -119,13 +143,14 @@ export declare class Xslt {
      * @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): void;
+    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;
     /**
@@ -137,7 +162,7 @@ export declare class Xslt {
      * @param template The XSLT stylesheet or transformation.
      * @param output The output.
      */
-    protected xsltPassThrough(context: ExprContext, template: XNode, output: XNode): void;
+    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.
@@ -148,7 +173,7 @@ export declare class Xslt {
      * currently not implemented.
      */
     protected xsltPassText(template: XNode): boolean;
-    protected xsltAttribute(attributeName: string, context: ExprContext): XNode;
+    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
@@ -177,6 +202,6 @@ export declare class Xslt {
      * @param context The Expression Context.
      * @param template The template node.
      */
-    protected xsltWithParam(context: ExprContext, template: XNode): void;
+    protected xsltWithParam(context: ExprContext, template: XNode): Promise<void>;
     protected isXsltElement(element: any, opt_wantedName?: string): boolean;
 }