chore: upgrade to node 18

Open-Attestation · Nov 29, 2023 · 05ab1a5 · 05ab1a5
1 parent b752de3
commit 05ab1a5
Show file tree

Hide file tree

Showing 9 changed files with 21,734 additions and 17,214 deletions.
diff --git a/.github/workflows/linters.yml b/.github/workflows/linters.yml
@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 14.x
+          node-version: 18.x
       - run: npm ci --ignore-scripts
       - run: npm run lint
 

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -27,7 +27,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 14.x
+          node-version: 18.x
       - run: npm ci
       - run: npm run build
       - uses: codfish/semantic-release-action@v2

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 14.x
+          node-version: 18.x
       - run: npm ci
       - run: npm run test -- --runInBand
 
@@ -25,6 +25,6 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 14.x
+          node-version: 18.x
       - run: npm ci
       - run: npm run build
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit ${1}
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+lts/hydrogen
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ Validation is run on all retrieved records to ensure they conform to the expecte
 npm i @govtechsg/dnsprove
 ```
 
----
+***
 
 ## Debug
 
@@ -49,25 +49,25 @@ This library uses [runtypes](https://github.com/pelotom/runtypes) for compile ti
 
 #### Table of Contents
 
-- [OpenAttestationDNSTextRecord](#openattestationdnstextrecord)
-- [OpenAttestationDnsDidRecord](#openattestationdnsdidrecord)
-- [IDNSRecord](#idnsrecord)
-- [IDNSQueryResponse](#idnsqueryresponse)
-- [CustomDnsResolver](#customdnsresolver)
-- [defaultDnsResolvers](#defaultdnsresolvers)
-- [queryDns](#querydns)
-  - [Parameters](#parameters)
-- [parseOpenAttestationRecord](#parseopenattestationrecord)
-  - [Parameters](#parameters-1)
-- [parseDocumentStoreResults](#parsedocumentstoreresults)
-  - [Parameters](#parameters-2)
-- [parseDnsDidResults](#parsednsdidresults)
-  - [Parameters](#parameters-3)
-- [getDocumentStoreRecords](#getdocumentstorerecords)
-  - [Parameters](#parameters-4)
-  - [Examples](#examples)
-- [getDnsDidRecords](#getdnsdidrecords)
-  - [Parameters](#parameters-5)
+*   [OpenAttestationDNSTextRecord](#openattestationdnstextrecord)
+*   [OpenAttestationDnsDidRecord](#openattestationdnsdidrecord)
+*   [IDNSRecord](#idnsrecord)
+*   [IDNSQueryResponse](#idnsqueryresponse)
+*   [CustomDnsResolver](#customdnsresolver)
+*   [defaultDnsResolvers](#defaultdnsresolvers)
+*   [queryDns](#querydns)
+    *   [Parameters](#parameters)
+*   [parseOpenAttestationRecord](#parseopenattestationrecord)
+    *   [Parameters](#parameters-1)
+*   [parseDocumentStoreResults](#parsedocumentstoreresults)
+    *   [Parameters](#parameters-2)
+*   [parseDnsDidResults](#parsednsdidresults)
+    *   [Parameters](#parameters-3)
+*   [getDocumentStoreRecords](#getdocumentstorerecords)
+    *   [Parameters](#parameters-4)
+    *   [Examples](#examples)
+*   [getDnsDidRecords](#getdnsdidrecords)
+    *   [Parameters](#parameters-5)
 
 ### OpenAttestationDNSTextRecord
 
@@ -89,49 +89,49 @@ Type: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global
 
 #### Parameters
 
-- `domain` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
-- `customDnsResolvers` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[CustomDnsResolver](#customdnsresolver)>**
+*   `domain` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+*   `customDnsResolvers` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[CustomDnsResolver](#customdnsresolver)>** 
 
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[IDNSQueryResponse](#idnsqueryresponse)>**
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[IDNSQueryResponse](#idnsqueryresponse)>** 
 
 ### parseOpenAttestationRecord
 
 Parses one openattestation DNS-TXT record and turns it into an OpenAttestationsDNSTextRecord object
 
 #### Parameters
 
-- `record` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** e.g: '"openatts net=ethereum netId=3 addr=0x0c9d5E6C766030cc6f0f49951D275Ad0701F81EC"'
+*   `record` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** e.g: '"openatts net=ethereum netId=3 addr=0x0c9d5E6C766030cc6f0f49951D275Ad0701F81EC"'
 
-Returns **GenericObject**
+Returns **GenericObject** 
 
 ### parseDocumentStoreResults
 
 Takes a DNS-TXT Record set and returns openattestation document store records if any
 
 #### Parameters
 
-- `recordSet` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[IDNSRecord](#idnsrecord)>** Refer to tests for examples (optional, default `[]`)
-- `dnssec` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**
+*   `recordSet` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[IDNSRecord](#idnsrecord)>** Refer to tests for examples (optional, default `[]`)
+*   `dnssec` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
 
-Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[OpenAttestationDNSTextRecord](#openattestationdnstextrecord)>**
+Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[OpenAttestationDNSTextRecord](#openattestationdnstextrecord)>** 
 
 ### parseDnsDidResults
 
 #### Parameters
 
-- `recordSet` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[IDNSRecord](#idnsrecord)>** (optional, default `[]`)
-- `dnssec` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**
+*   `recordSet` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[IDNSRecord](#idnsrecord)>**  (optional, default `[]`)
+*   `dnssec` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
 
-Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[OpenAttestationDnsDidRecord](#openattestationdnsdidrecord)>**
+Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[OpenAttestationDnsDidRecord](#openattestationdnsdidrecord)>** 
 
 ### getDocumentStoreRecords
 
 Queries a given domain and parses the results to retrieve openattestation document store records if any
 
 #### Parameters
 
-- `domain` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** e.g: "example.openattestation.com"
-- `customDnsResolvers` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[CustomDnsResolver](#customdnsresolver)>?**
+*   `domain` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** e.g: "example.openattestation.com"
+*   `customDnsResolvers` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[CustomDnsResolver](#customdnsresolver)>?** 
 
 #### Examples
 
@@ -144,16 +144,16 @@ addr: '0x2f60375e8144e16Adf1979936301D8341D58C36C',
 dnssec: true } ]
 ```
 
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[OpenAttestationDNSTextRecord](#openattestationdnstextrecord)>>**
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[OpenAttestationDNSTextRecord](#openattestationdnstextrecord)>>** 
 
 ### getDnsDidRecords
 
 #### Parameters
 
-- `domain` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
-- `customDnsResolvers` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[CustomDnsResolver](#customdnsresolver)>?**
+*   `domain` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+*   `customDnsResolvers` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[CustomDnsResolver](#customdnsresolver)>?** 
 
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[OpenAttestationDnsDidRecord](#openattestationdnsdidrecord)>>**
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[OpenAttestationDnsDidRecord](#openattestationdnsdidrecord)>>** 
 
 ## License