npm - @nictool/dns-resource-record - Versions diffs - 1.1.7 → 1.2.0 - Mend

@nictool/dns-resource-record 1.1.7 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (74) hide show

package/.prettierrc.yml ADDED Viewed

@@ -0,0 +1,3 @@
+trailingComma: 'all'
+semi: false
+singleQuote: true

package/CHANGELOG.md CHANGED Viewed

@@ -2,45 +2,45 @@
 Notable changes to this project are documented in this file.
 #### Unreleased
+### [1.2.0] - 2024-03-07
+- feat(index): export typeMap (lookup table for type to id)
+- feat(NXT): added bind support
+- feat(TSIG, WKS): added stub class
+- doc(README): move synopsis section into table (#38)
+- chore(style): set up prettier
 ### [1.1.6] - 2022-06-21
 - doc(sshfp): added RFC 7479, 8709
 ### [1.1.5] - 2022-06-03
 - ci: auto-populate node LTS versions to run CI tests with
 ### [1.1.4] - 2022-05-29
 - doc(README): improved develop notes
 - doc(CHANGELOG): make version numbers links
 ### [1.1.3] - 2022-05-29
 - chore: publish npm package in @nictool namespace
 ### [1.1.2] - 2022-05-28
 - chore(ci): replace .release with submodule
 - chore(ci): use GHA with shared workflows
 ### [1.1.1] - 2022-04-28
 - feat(DNSKEY): expanded algo from 1-5 to 1-16 (RFC 8624)
-    - warn if outside that range, not error
+  - warn if outside that range, not error
 - feat(HINFO): added to/from tinydns
 - test(dnskey): update fail test
 ### [1.1.0] - 2022-04-22
 - feat(tinydns): add ipv4toOctal, octalToIPv4, base64toOctal, octalToBase64
@@ -54,7 +54,6 @@ Notable changes to this project are documented in this file.
 - test(IPSECKEY): expand test coverage
 - tinydns.unpackdomain: return fqdn + length, for RRs where the FQDN is part of the byte stream
 ### [1.0.1] - 2022-04-19
 - feat(IPSECKEY): added basic support
@@ -65,7 +64,6 @@ Notable changes to this project are documented in this file.
 - test(CERT): added two test cases
 - test(KEY): added valid test
 ### [1.0.0] - 2022-04-18
 - style: move rr/index to ./rr
@@ -73,7 +71,6 @@ Notable changes to this project are documented in this file.
 - style(esm): convert from CJS to ESM (ES6 module)
 - test: add base.getRdataFields
 ### [0.9.9] - 2022-04-14
 - feat: parser improvements (DNSKEY, HINFO, NAPTR, SOA, TLSA, TXT)
@@ -83,7 +80,6 @@ Notable changes to this project are documented in this file.
 - test/rr: update tests with expected error messages
 - README: move some content to web links
 ### [0.9.8] - 2022-04-07
 - url updates
@@ -91,19 +87,17 @@ Notable changes to this project are documented in this file.
 - feat: add index.citeRFC
 - docs: updates
 ### [0.9.7] - 2022-03-29
 - index
-    - previousName -> previousOwner
-    - export a TYPE_MAP (id => name)
+  - previousName -> previousOwner
+  - export a TYPE_MAP (id => name)
 - isValidHostname: allow \ char
 - add the word 'RFC' in error messages citing RFCs
 - when rejecting hostname, show the rejected character
 - maradns: add export support
 - add index.citeRFC
 ### [0.9.6] - 2022-03-27
 - rr\*: rename name -> owner (not overloaded)
@@ -113,7 +107,6 @@ Notable changes to this project are documented in this file.
 - add macos testing
 - add CERT, KEY, NSEC, NSEC3, NSEC3PARAM, OPENPGPKEY, SIG
 ### [0.9.5] - 2022-03-26
 - README: add docs for getRFCs()
@@ -123,7 +116,6 @@ Notable changes to this project are documented in this file.
 - master: NODE_ENV=cov when running coverage
 - TXT: pass along zone_opts
 ### [0.9.4] - 2022-03-24
 - add: getComment
@@ -131,15 +123,14 @@ Notable changes to this project are documented in this file.
 - normalize hostnames to lower case
 - add tests: fullyQualify, getFQDN
 - AAAA
-    - compress: rewrote per RFC 5952, added tests
-    - internally store address in expanded notation
+  - compress: rewrote per RFC 5952, added tests
+  - internally store address in expanded notation
 - fromTinydns: apply correct semantics for 'x' handling
 - fullyQualify
-    - special handling for @
-    - consider $ORIGIN
+  - special handling for @
+  - consider $ORIGIN
 - add uc hex chars to ip6 compress
 ### [0.9.3] - 2022-03-22
 - hasValidLabels: remove trailing dot, else split returns empty string
@@ -155,7 +146,6 @@ Notable changes to this project are documented in this file.
 - TXT: import BIND format w/o mangling WS
 - SPF inherits from TXT
 ### [0.9.2] - 2022-03-18
 - mx: weight -> preference
@@ -168,12 +158,10 @@ Notable changes to this project are documented in this file.
 - validHostname: allow / char
 - use \_\_dirname to find RR mods
 ### [0.9.1] - 2022-03-14
 - TLSA, SMIMEA: add BIND support #13
 ### [0.9.0] - 2022-03-10
 - added null object instantiation
@@ -187,19 +175,16 @@ Notable changes to this project are documented in this file.
 - tests: more signal, less noise
 - tests: import tests from nictool 2
 ### [0.8.1] - 2022-03-08
 - use RFC example IPs and zone names
 ### [0.8.0] - 2022-02-01
 - fromBind for: A, AAAA, CNAME, TXT, CNAME, TXT, LOC, MX, NS, SOA, PTR, SPF, SSHFP, URI, CAA, DNAME, NAPTR
 - add fromTinydns: LOC
 - rr/\*: add getFields
 ### [0.7.0] - 2021-10-26
 - tinydns: added octalToHex, octalToUInt16, unpackDomainName, octalToInt8
@@ -207,38 +192,32 @@ Notable changes to this project are documented in this file.
 - CAA, CNAME, DNAME, SPF, SSHFP, SRV, URI: added fromTinydns
 - add tests for getRFCs
 ### [0.6.0] - 2021-10-25
 - tinydns: added octalToChar
 - A, MX, NS, PTR, SOA, TXT: added fromTinydns
 ### [0.5.1] - 2021-10-25
 - LOC: added toTinydns
 - tinydns: add UInt32toOctal
 - SRV: added support
 ### [0.5.0] - 2021-10-24
 - NAPTR: add toTinydns
 - tinydns: remove sprintf-js dependency
 ### [0.4.0] - 2021-10-22
 - CAA, DNAME, SSHFP, URI: add toTinydns
 - lib/tinydns: added packHex and UInt16AsOctal
 ### [0.3.1] - 2021-10-21
 - update index.js to also export RR sub classes
 - update README examples
 ### [0.3.0] - 2021-10-21
 - add getRFCs to all RR types
@@ -246,7 +225,6 @@ Notable changes to this project are documented in this file.
 - toBind: use tabs for exported WS
 - CAA, DNAME, NAPTR, SSHFP, URI: add toBind, tests
 ### [0.2.3] - 2021-10-21
 - refactored classes into separate files
@@ -255,30 +233,25 @@ Notable changes to this project are documented in this file.
 - lib/tinydns: added escapeOct & packDomainName
 - PTR, SRV: added tests
 ### [0.2.2] - 2021-10-20
-- add tests/*
+- add tests/\*
 - A, AAAA, add toBind and toTinydns()
 - add .release
 ### [0.2.1] - 2021-10-16
 - additional RR formats started, weakly validated
 ### [0.2.0] - 2021-10-16
 - initial release & name grab
 # References
 - [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
-  + fix, feature, BREAKING CHANGE, build, chore, ci, docs, style, test
+  - fix, feature, BREAKING CHANGE, build, chore, ci, docs, style, test
 [1.1.3]: https://github.com/NicTool/dns-resource-record/releases/tag/1.1.3
 [1.1.2]: https://github.com/NicTool/dns-resource-record/releases/tag/1.1.2
@@ -312,3 +285,4 @@ Notable changes to this project are documented in this file.
 [1.1.4]: https://github.com/NicTool/dns-resource-record/releases/tag/1.1.4
 [1.1.5]: https://github.com/NicTool/dns-resource-record/releases/tag/1.1.5
 [1.1.6]: https://github.com/NicTool/dns-resource-record/releases/tag/1.1.6
+[1.1.8]: https://github.com/NicTool/dns-resource-record/releases/tag/1.1.8

package/README.md CHANGED Viewed

@@ -29,7 +29,7 @@ This package is for working with _individual_ Resource Records. For working with
 Load the index for access to all RR types:
 ```js
-import * as RR from 'dns-resource-record'
+import * as RR from '@nictool/dns-resource-record'
 ```
 ### EXAMPLES
@@ -179,66 +179,65 @@ A(5) [Map] {
 Consider this a "running with scissors" mode.
 ## Supported Records
 This module intends to include support for all current (ie, not officially deprecated) DNS RRs **and** all RRs that are in active use on the internet.
 PRs are welcome, especially PRs with tests.
-| **RR**     | **toBind**       | **toTinydns**    | **fromBind**     |  **fromTinydns** |
-|:---------: |:----------------:|:----------------:|:----------------:|:----------------:|
-| **A**      |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
-| **AAAA**   |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
-| **CAA**    |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
-| **CERT**   |:white_check_mark:|                  |:white_check_mark:|                  |
-| **CNAME**  |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
-| **DNAME**  |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
-| **DNSKEY** |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
-| **DS**     |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
-| **HINFO**  |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
-|**IPSECKEY**|:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
-| **KEY**    |                  |                  |                  |                  |
-| **LOC**    |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
-| **MX**     |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
-| **NAPTR**  |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
-| **NS**     |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
-| **NSEC**   |:white_check_mark:|                  |:white_check_mark:|                  |
-| **NSEC3**  |:white_check_mark:|:white_check_mark:|:white_check_mark:|                  |
-| **NSEC3PARAM**|               |                  |                  |                  |
-| **OPENPGPKEY**|               |                  |                  |                  |
-| **PTR**    |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
-| **RRSIG**  |                  |                  |                  |                  |
-| **SIG**    |                  |                  |                  |                  |
-| **SMIMEA** |:white_check_mark:|                  |:white_check_mark:|                  |
-| **SOA**    |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
-| **SPF**    |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
-| **SRV**    |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
-| **SSHFP**  |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
-| **TLSA**   |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
-| **TXT**    |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
-| **URI**    |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+|     **RR**     |     **toBind**     |   **toTinydns**    |    **fromBind**    |  **fromTinydns**   |
+| :------------: | :----------------: | :----------------: | :----------------: | :----------------: |
+|     **A**      | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|    **AAAA**    | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|    **CAA**     | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|    **CERT**    | :white_check_mark: |                    | :white_check_mark: |                    |
+|   **CNAME**    | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|   **DNAME**    | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|   **DNSKEY**   | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|     **DS**     | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|   **HINFO**    | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|  **IPSECKEY**  | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|    **KEY**     |                    |                    |                    |                    |
+|    **LOC**     | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|     **MX**     | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|   **NAPTR**    | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|     **NS**     | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|    **NSEC**    | :white_check_mark: |                    | :white_check_mark: |                    |
+|   **NSEC3**    | :white_check_mark: | :white_check_mark: | :white_check_mark: |                    |
+| **NSEC3PARAM** |                    |                    |                    |                    |
+|    **NXT**     |                    |                    |                    |                    |
+| **OPENPGPKEY** |                    |                    |                    |                    |
+|    **PTR**     | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|   **RRSIG**    |                    |                    |                    |                    |
+|    **SIG**     |                    |                    |                    |                    |
+|   **SMIMEA**   | :white_check_mark: |                    | :white_check_mark: |                    |
+|    **SOA**     | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|    **SPF**     | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|    **SRV**     | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|   **SSHFP**    | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|    **TLSA**    | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|    **TSIG**    |                    |                    |                    |                    |
+|    **TXT**     | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|    **URI**     | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|    **WKS**     |                    |                    |                    |                    |
 ## TIPS
 - Domain owner names are:
-    - stored fully qualified, aka absolute.
-    - normalized to lower case, because:
-        - DNS is case insensitive (see RFCs 4343, 1035, 1034)
-        - this library enforces duplicate suppression
-        - DNSSEC canonicalization (see RFC 4034)
-        - wire format for most RRs require it
-    - Master Zone File expansions exist in [dns-zone](https://github.com/NicTool/dns-zone)
+  - stored fully qualified, aka absolute.
+  - normalized to lower case, because:
+    - DNS is case insensitive (see RFCs 4343, 1035, 1034)
+    - this library enforces duplicate suppression
+    - DNSSEC canonicalization (see RFC 4034)
+    - wire format for most RRs require it
+  - Master Zone File expansions exist in [dns-zone](https://github.com/NicTool/dns-zone)
 - to{Bind|MaraDNS} output can be influenced (suppress TTL, class, relative domain names) with an options object. See it in `bin/dns-zone` in the [dns-zone](https://github.com/NicTool/dns-zone) package.
 ## SEE ALSO
 - [Dictionary of DNS terms](https://nictool.github.io/web/Dictionary)
 - [Wikipedia, List of DNS Record Types](https://en.wikipedia.org/wiki/List_of_DNS_record_types)
 ## TODO
 - [x] Change all IPs to use [RFC example/doc](https://en.wikipedia.org/wiki/Reserved_IP_addresses) address space
@@ -249,15 +248,14 @@ PRs are welcome, especially PRs with tests.
 - [x] CERT RRs: CERT, KEY, SIG, OPENPGPKEY
 - [x] RFC 4034: if the type of RR is NS, MD, MF, CNAME, SOA, MB,
       MG, MR, PTR, HINFO, MINFO, MX, RP, AFSDB, RT, SIG, PX, NXT,
-      NAPTR, KX, SRV, DNAME, A6, RRSIG, or NSEC, all uppercase
+      NAPTR, KX, SRV, DNAME, A6, RRSIG, or NSEC, all uppercase
       letters in the DNS names contained within the RDATA are replaced by the lowercase letters;
 - [x] LOC record ingest/out isn't consistent with API
 - [ ] export a web page for each RR type
 ## DEVELOP
 - There are no dependencies. That's no accident.
 - ES modules for use by node.js and browser
 - Platform independence is a goal
-    - [x] CI tests are on linux, windows, and macos
+  - [x] CI tests are on linux, windows, and macos

package/index.js CHANGED Viewed

@@ -1,35 +1,39 @@
+const typeMap = {}
-import RR      from './rr.js'
-import A       from './rr/a.js'
-import AAAA    from './rr/aaaa.js'
-import CAA     from './rr/caa.js'
-import CERT    from './rr/cert.js'
-import CNAME   from './rr/cname.js'
-import DNAME   from './rr/dname.js'
-import DNSKEY  from './rr/dnskey.js'
-import DS      from './rr/ds.js'
-import HINFO   from './rr/hinfo.js'
+import RR from './rr.js'
+import A from './rr/a.js'
+import AAAA from './rr/aaaa.js'
+import CAA from './rr/caa.js'
+import CERT from './rr/cert.js'
+import CNAME from './rr/cname.js'
+import DNAME from './rr/dname.js'
+import DNSKEY from './rr/dnskey.js'
+import DS from './rr/ds.js'
+import HINFO from './rr/hinfo.js'
 import IPSECKEY from './rr/ipseckey.js'
-import KEY     from './rr/key.js'
-import LOC     from './rr/loc.js'
-import MX      from './rr/mx.js'
-import NAPTR   from './rr/naptr.js'
-import NS      from './rr/ns.js'
-import NSEC    from './rr/nsec.js'
-import NSEC3   from './rr/nsec3.js'
+import KEY from './rr/key.js'
+import LOC from './rr/loc.js'
+import MX from './rr/mx.js'
+import NAPTR from './rr/naptr.js'
+import NS from './rr/ns.js'
+import NSEC from './rr/nsec.js'
+import NSEC3 from './rr/nsec3.js'
 import NSEC3PARAM from './rr/nsec3param.js'
+import NXT from './rr/nxt.js'
 import OPENPGPKEY from './rr/openpgpkey.js'
-import PTR     from './rr/ptr.js'
-import RRSIG   from './rr/rrsig.js'
-import SIG     from './rr/sig.js'
-import SMIMEA  from './rr/smimea.js'
-import SOA     from './rr/soa.js'
-import SPF     from './rr/spf.js'
-import SRV     from './rr/srv.js'
-import SSHFP   from './rr/sshfp.js'
-import TLSA    from './rr/tlsa.js'
-import TXT     from './rr/txt.js'
-import URI     from './rr/uri.js'
+import PTR from './rr/ptr.js'
+import RRSIG from './rr/rrsig.js'
+import SIG from './rr/sig.js'
+import SMIMEA from './rr/smimea.js'
+import SOA from './rr/soa.js'
+import SPF from './rr/spf.js'
+import SRV from './rr/srv.js'
+import SSHFP from './rr/sshfp.js'
+import TLSA from './rr/tlsa.js'
+import TSIG from './rr/tsig.js'
+import TXT from './rr/txt.js'
+import URI from './rr/uri.js'
+import WKS from './rr/wks.js'
 export default RR
@@ -52,6 +56,7 @@ export {
   NSEC,
   NSEC3,
   NSEC3PARAM,
+  NXT,
   OPENPGPKEY,
   PTR,
   RRSIG,
@@ -62,6 +67,49 @@ export {
   SPF,
   SRV,
   TLSA,
+  TSIG,
   TXT,
-  URI
+  URI,
+  WKS,
+  typeMap,
+}
+for (const c of [
+  A,
+  AAAA,
+  CAA,
+  CERT,
+  CNAME,
+  DNAME,
+  DNSKEY,
+  DS,
+  HINFO,
+  IPSECKEY,
+  KEY,
+  LOC,
+  MX,
+  NAPTR,
+  NS,
+  NSEC,
+  NSEC3,
+  NSEC3PARAM,
+  NXT,
+  OPENPGPKEY,
+  PTR,
+  RRSIG,
+  SIG,
+  SMIMEA,
+  SSHFP,
+  SOA,
+  SPF,
+  SRV,
+  TLSA,
+  TSIG,
+  TXT,
+  URI,
+  WKS,
+]) {
+  const id = new c(null).getTypeId()
+  typeMap[id] = c.name
+  typeMap[c.name] = id
 }