Changes for 4.0.0

Author: michaelkourlas

.travis.yml

@@ -1,9 +1,8 @@
 language: node_js
 node_js:
   - node
-  - 6
-  - 5
-  - 4
+  - 8
+  - 10
 install:
   - npm install -g gulp
   - npm install

CHANGES.md

@@ -1,3 +1,14 @@
+## 4.0.0 ##
+
+* Do not indent multi-line strings
+* Use self-closing tags, unless otherwise specified
+* Add option to automatically replace invalid characters with U+FFFD
+* Add option to suppress certain values from output
+* Add support for adding to existing xmlcreate object
+* Remove certain unnecessary validation rules
+* Bug fixes
+* Correct errors in documentation
+
 ## 3.0.0 ##
 
 * Bug fixes

NOTICE.md

@@ -1,9 +1,9 @@
 js2xmlparser  
-Copyright (C) 2016-2017 Michael Kourlas
+Copyright (C) 2016-2019 Michael Kourlas
 
 ## Apache License, version 2.0 ##
 
 The following components are provided under the [Apache License, version 2.0](https://www.apache.org/licenses/LICENSE-2.0):
 
 xmlcreate  
-Copyright (C) 2016-2017 Michael Kourlas  
+Copyright (C) 2016-2019 Michael Kourlas  

README.md

@@ -18,7 +18,7 @@ JavaScript objects such as `Date` and `RegExp`, by taking advantage of each
 object's `toString` function or, if this function does not exist, the `String`
 constructor.
 
-js2xmlparser also has support for the new `Map` and `Set` objects introduced in
+js2xmlparser also has support for the `Map` and `Set` objects introduced in
 ECMAScript 2015, treating them as JSON-type objects and arrays respectively.
 Support for `Map`s is necessary to generate XML with elements in a specific
 order, since JSON-type objects do not guarantee insertion order. `Map` keys are 
@@ -66,7 +66,7 @@ includes source maps.
 
 ## Usage ##
 
-The documentation for the current version is available [here](http://www.kourlas.com/node-js2xmlparser/docs/3.0.0/).
+The documentation for the current version is available [here](http://www.kourlas.com/node-js2xmlparser/docs/4.0.0/).
 
 You can also build the documentation using gulp:
 
@@ -141,7 +141,7 @@ This example produces the following XML:
 </person>
 ```
 
-Additional examples can be found in examples/example.js.
+Additional examples can be found in the examples directory.
 
 ## Tests ##
 

examples/example.js renamed to examples/javascript.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (C) 2016 Michael Kourlas
+ * Copyright (C) 2016-2019 Michael Kourlas
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

examples/typescript.ts

@@ -0,0 +1,186 @@
+/**
+ * Copyright (C) 2016-2019 Michael Kourlas
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* tslint:disable:no-console object-literal-sort-keys */
+
+import {parse} from "../lib/main";
+
+/**
+ * This example demonstrates a very simple usage of js2xmlparser.
+ */
+const example1 = () => {
+    const obj = {
+        "firstName": "John",
+        "lastName": "Smith"
+    };
+    console.log(parse("person", obj));
+    console.log();
+};
+example1();
+
+/**
+ * This example demonstrates a more complex usage of j2xmlparser.
+ */
+const example2 = () => {
+    const obj = {
+        "firstName": "John",
+        "lastName": "Smith",
+        "dateOfBirth": new Date(1964, 7, 26),
+        "address": {
+            "@": {
+                "type": "home"
+            },
+            "streetAddress": "3212 22nd St",
+            "city": "Chicago",
+            "state": "Illinois",
+            "zip": 10000
+        },
+        "phone": [
+            {
+                "@": {
+                    "type": "home"
+                },
+                "#": "123-555-4567"
+            },
+            {
+                "@": {
+                    "type": "cell"
+                },
+                "#": "890-555-1234"
+            },
+            {
+                "@": {
+                    "type": "work"
+                },
+                "#": "567-555-8901"
+            }
+        ],
+        "email": "[email protected]"
+    };
+    console.log(parse("person", obj));
+    console.log();
+};
+example2();
+
+/**
+ * This example demonstrates some of js2xmlparser's options.
+ */
+const example3 = () => {
+    const options = {
+        aliasString: "exAlias",
+        attributeString: "exAttr",
+        cdataKeys: [
+            "exCdata",
+            "exCdata2"
+        ],
+        declaration: {
+            include: true,
+            encoding: "UTF-16",
+            standalone: "yes",
+            version: "1.1"
+        },
+        dtd: {
+            include: true,
+            name: "exName",
+            sysId: "exSysId",
+            pubId: "exPubId"
+        },
+        format: {
+            doubleQuotes: true,
+            indent: "\t",
+            newline: "\r\n",
+            pretty: true
+        },
+        typeHandlers: {
+            "[object Number]": (value: any) => {
+                return value + 17;
+            }
+        },
+        valueString: "exVal",
+        wrapHandlers: {
+            "exArr": () => {
+                return "exArrInner";
+            }
+        }
+    };
+
+    const obj = {
+        "ex1": "ex2",
+        "exVal_1": 123,
+        "ex3": ["ex4", "ex5"],
+        "ex6": {
+            "exAttr_1": {
+                "ex7": "ex8",
+                "ex9": "ex10"
+            },
+            "ex11": "ex12",
+            "ex13": {
+                "ex14": "ex15"
+            },
+            "ex16": [
+                "ex17",
+                {
+                    "ex18": "ex19"
+                }
+            ],
+            "exArr": [
+                "ex20",
+                {
+                    "ex21": "ex22"
+                }
+            ],
+            "exAttr_2": {
+                "ex23": "ex24",
+                "ex25": "ex26"
+            }
+        },
+        "exVal_2": "ex27",
+        "ex28": [
+            "ex29",
+            "ex30"
+        ],
+        "ex31": true,
+        "ex32": undefined,
+        "ex33": null,
+        "ex34": 3.4,
+        "ex35": () => {
+            return "ex36";
+        },
+        "ex37": "i<j&",
+        "exCdata": "i<j&",
+        "exCdata2": "ddd",
+        "ex38": {
+            "exAlias": "ex39",
+            "ex40": "ex41"
+        },
+        "ex42": ["ex43", "ex44", "ex45", ["ex46", "ex47"],
+                 new Set(["ex48", "ex49"])],
+        "ex50": new Map([
+                            ["ex51", "ex52"],
+                            ["exVal_1", "ex53"],
+                            ["ex54", "ex55"],
+                            ["exAttr_1",
+                                {
+                                    "ex56": "ex57",
+                                    "ex58": "ex59"
+                                }
+                            ] as any
+                        ])
+    };
+    console.log(parse("ex0", obj, options));
+    console.log();
+};
+example3();