Add types

Closes GH-1.

Reviewed-by: Christian Murphy <[email protected]>
Reviewed-by: Titus Wormer <[email protected]>

Author: stefanprobst

package.json

@@ -26,10 +26,15 @@
     "Titus Wormer <[email protected]> (https://wooorm.com)"
   ],
   "files": [
-    "index.js"
+    "index.js",
+    "types/index.d.ts"
   ],
-  "dependencies": {},
+  "types": "types",
+  "dependencies": {
+    "@types/xast": "^1.0.0"
+  },
   "devDependencies": {
+    "dtslint": "^4.0.0",
     "nyc": "^15.0.0",
     "prettier": "^2.0.0",
     "remark-cli": "^8.0.0",
@@ -41,7 +46,8 @@
     "format": "remark . -qfo && prettier . --write && xo --fix",
     "test-api": "node test",
     "test-coverage": "nyc --reporter lcov tape test.js",
-    "test": "npm run format && npm run test-coverage"
+    "test-types": "dtslint types",
+    "test": "npm run format && npm run test-coverage && npm run test-types"
   },
   "nyc": {
     "check-coverage": true,

types/index.d.ts

@@ -0,0 +1,29 @@
+// TypeScript Version: 3.0
+
+import {Attributes, Element, Node} from 'xast'
+
+/**
+ * Create XML trees in xast.
+ *
+ * @param name Qualified name. Case sensitive and can contain a namespace prefix (such as rdf:RDF).
+ * @param children (Lists of) child nodes. When strings are encountered, they are mapped to Text nodes.
+ */
+declare function xastscript(
+  name: string,
+  children?: string | Node | Array<string | Node>
+): Element
+
+/**
+ * Create XML trees in xast.
+ *
+ * @param name Qualified name. Case sensitive and can contain a namespace prefix (such as rdf:RDF).
+ * @param attributes Map of attributes. Nullish (null or undefined) or NaN values are ignored, other values are turned to strings.
+ * @param children (Lists of) child nodes. When strings are encountered, they are mapped to Text nodes.
+ */
+declare function xastscript(
+  name: string,
+  attributes?: Attributes,
+  children?: string | Node | Array<string | Node>
+): Element
+
+export = xastscript

types/test.ts

@@ -0,0 +1,21 @@
+import x = require('xastscript')
+
+x('urlset') // $ExpectType Element
+x('urlset', 'string') // $ExpectType Element
+x('urlset', ['string', 'string']) // $ExpectType Element
+x('urlset', x('loc')) // $ExpectType Element
+x('urlset', [x('loc'), x('loc')]) // $ExpectType Element
+x('urlset', []) // $ExpectType Element
+
+const xmlns = 'http://www.sitemaps.org/schemas/sitemap/0.9'
+
+x('urlset', {xmlns}) // $ExpectType Element
+x('urlset', {xmlns}, 'string') // $ExpectType Element
+x('urlset', {xmlns}, ['string', 'string']) // $ExpectType Element
+x('urlset', {xmlns}, x('loc')) // $ExpectType Element
+x('urlset', {xmlns}, [x('loc'), x('loc')]) // $ExpectType Element
+x('urlset', {xmlns}, []) // $ExpectType Element
+
+x() // $ExpectError
+x(false) // $ExpectError
+x('urlset', x('loc'), {xmlns}) // $ExpectError

types/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "lib": ["es2015"],
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "noEmit": true,
+    "baseUrl": ".",
+    "paths": {
+      "xastscript": ["."]
+    }
+  }
+}

types/tslint.json

@@ -0,0 +1,7 @@
+{
+  "extends": "dtslint/dtslint.json",
+  "rules": {
+    "semicolon": false,
+    "whitespace": false
+  }
+}