xslt-processor 2.3.1 → 3.0.0

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:
@@ -95,6 +103,26 @@ All the exports will live under `globalThis.XsltProcessor`. [See a usage example
 
 ### 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xslt-processor",
-  "version": "2.3.1",
+  "version": "3.0.0",
   "description": "A JavaScript XSLT Processor",
   "main": "index.js",
   "module": "index.js",
@@ -52,13 +52,12 @@
     "@typescript-eslint/parser": "^5.60.0",
     "babel-jest": "^29.5.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",
     "npm-check-updates": "^16.10.13",
-    "react": "^18.2.0",
     "release-it": "^15.11.0",
     "rimraf": "^5.0.1",
     "rollup": "^1.1.2",
@@ -71,7 +70,8 @@
     "typescript": "4.9.4"
   },
   "dependencies": {
-    "he": "^1.2.0"
+    "he": "^1.2.0",
+    "node-fetch": "cjs"
   },
   "copyFiles": [
     {

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,14 @@ 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:choose`, its child nodes `xsl:when`, and
      * `xsl:otherwise`.
@@ -58,7 +59,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.
@@ -80,7 +81,14 @@ export declare class Xslt {
      * @param template The template.
      * @param output The output.
      */
-    protected xsltForEach(context: ExprContext, template: XNode, output: XNode): void;
+    protected xsltForEach(context: ExprContext, template: XNode, output: XNode): Promise<void>;
+    /**
+     * Implements `xsl:include`.
+     * @param input 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
@@ -98,7 +106,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 +118,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,7 +127,7 @@ 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;
@@ -137,7 +145,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.
@@ -177,6 +185,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;
 }