Make optional options optional in typings and add type tests (#622)

* Make optional options optional in typings and add type tests

* Run type test on pre-publish

* Remove npm lockfile and update Yarn lockfile

* Revert lockfile changes

* final newline

* Use downloaded files from master to prevent whitespace changes

.publishrc

@@ -14,6 +14,6 @@
   "confirm": true,
   "publishCommand": "npm publish",
   "publishTag": "latest",
-  "prePublishScript": "npm test",
+  "prePublishScript": "npm test && npm test-types",
   "postPublishScript": false
 }

package.json

@@ -5,6 +5,7 @@
   "main": "./src/fxp.js",
   "scripts": {
     "test": "nyc --reporter=lcov --reporter=text jasmine spec/*spec.js",
+    "test-types": "tsc --noEmit spec/typings/typings-test.ts",
     "unit": "jasmine",
     "coverage": "nyc report --reporter html --reporter text -t .nyc_output --report-dir .nyc_output/summary",
     "perf": "node ./benchmark/perfTest3.js",
@@ -46,6 +47,7 @@
     "@babel/plugin-transform-runtime": "^7.13.10",
     "@babel/preset-env": "^7.13.10",
     "@babel/register": "^7.13.8",
+    "@types/node": "20",
     "babel-loader": "^8.2.2",
     "cytorus": "^0.2.9",
     "eslint": "^8.3.0",
@@ -54,6 +56,7 @@
     "nyc": "^15.1.0",
     "prettier": "^1.19.1",
     "publish-please": "^5.5.2",
+    "typescript": "5",
     "webpack": "^5.64.4",
     "webpack-cli": "^4.9.1"
   },

spec/typings/typings-test.ts

@@ -0,0 +1,47 @@
+import {
+    XMLParser,
+    XMLBuilder,
+    XMLValidator,
+    type X2jOptions,
+    type XmlBuilderOptions,
+    type validationOptions,
+} from '../../src/fxp';
+
+const parseOpts: X2jOptions = {};
+
+const XML = `
+    <?xml version="1.0"?>
+    <SomeElement name="parent">
+        <SomeNestedElement name="child"></SomeNestedElement>
+    </SomeElement>
+`;
+
+const parser = new XMLParser(parseOpts);
+const parsed = parser.parse(XML);
+
+console.log(!!parsed);
+
+const buildOpts: XmlBuilderOptions = {};
+
+const builder = new XMLBuilder(buildOpts);
+
+const built = builder.build({
+    any_name: {
+        person: {
+            phone: [
+                15555551313,
+                15555551212
+            ]
+        }
+    }
+});
+
+console.log(!!built);
+
+const validateOpts: validationOptions = {};
+
+const isValid = XMLValidator.validate(built, validateOpts);
+
+console.log(!!isValid);
+
+