@nictool/dns-resource-record 1.1.7 → 1.2.1

package/rr.js

@@ -1,6 +1,7 @@
+import util from 'node:util'
 
 export default class RR extends Map {
-  constructor (opts) {
+  constructor(opts) {
     super()
 
     if (opts === null) return
@@ -15,44 +16,48 @@ export default class RR extends Map {
     this.setTimestamp(opts?.timestamp)
 
     this.setOwner(opts?.owner)
-    this.setType (opts?.type)
-    this.setTtl  (opts?.ttl)
+    this.setType(opts?.type)
+    this.setTtl(opts?.ttl)
     this.setClass(opts?.class)
 
     for (const f of this.getFields('rdata')) {
       const fnName = `set${this.ucfirst(f)}`
-      if (this[fnName] === undefined) throw new Error(`Missing ${fnName} in class ${this.get('type')}`)
+      if (this[fnName] === undefined)
+        this.throwHelp(`Missing ${fnName} in class ${this.get('type')}`)
       this[fnName](opts[f])
     }
 
     if (opts.comment) this.set('comment', opts.comment)
   }
 
-  ucfirst (str) {
-    return str.split(/\s/).map(w => w.charAt(0).toUpperCase() + w.slice(1)).join('')
+  ucfirst(str) {
+    return str
+      .split(/\s/)
+      .map((w) => w.charAt(0).toUpperCase() + w.slice(1))
+      .join('')
   }
 
-  setClass (c) {
+  setClass(c) {
     switch (c) {
-      case 'IN':    // 1
+      case 'IN': // 1
       case undefined:
       case null:
       case '':
         this.set('class', 'IN')
         break
-      case 'CS':    // 2
-      case 'CH':    // 3
-      case 'HS':    // 4
-      case 'NONE':  // 254
-      case 'ANY':   // 255
+      case 'CS': // 2
+      case 'CH': // 3
+      case 'HS': // 4
+      case 'NONE': // 254
+      case 'ANY': // 255
         this.set('class', c)
         break
       default:
-        throw new Error(`invalid class ${c}`)
+        this.throwHelp(`invalid class ${c}`)
     }
   }
 
-  setLocation (l) {
+  setLocation(l) {
     switch (l) {
       case undefined:
         return
@@ -61,7 +66,7 @@ export default class RR extends Map {
     }
   }
 
-  setTimestamp (l) {
+  setTimestamp(l) {
     switch (l) {
       case undefined:
         return
@@ -70,32 +75,35 @@ export default class RR extends Map {
     }
   }
 
-  setOwner (n) {
-    if (n === undefined) throw new Error(`owner is required`)
+  setOwner(n) {
+    if (n === undefined) this.throwHelp(`owner is required`)
 
     if (n.length < 1 || n.length > 255)
-      throw new Error('Domain names must have 1-255 octets (characters): RFC 2181')
+      this.throwHelp(
+        'Domain names must have 1-255 octets (characters): RFC 2181',
+      )
 
-    this.isFullyQualified('', 'owner', n)
+    this.isFullyQualified(this.constructor.name, 'owner', n)
     this.hasValidLabels(n)
 
     // wildcard records: RFC 1034, 4592
     if (/\*/.test(n)) {
-      if (!/^\*\./.test(n) && !/\.\*\./.test(n)) throw new Error('only *.something or * (by itself) is a valid wildcard')
+      if (!/^\*\./.test(n) && !/\.\*\./.test(n))
+        this.throwHelp('only *.something or * (by itself) is a valid wildcard')
     }
 
     this.set('owner', n.toLowerCase())
   }
 
-  setTtl (t) {
-
+  setTtl(t) {
     if (t === undefined) t = this?.default?.ttl
     if (t === undefined) {
-      if ([ 'SOA', 'SSHPF' ].includes(this.get('type'))) return
-      throw new Error('TTL is required, no default available')
+      if (['SOA', 'SSHPF'].includes(this.get('type'))) return
+      this.throwHelp('TTL is required, no default available')
     }
 
-    if (typeof t !== 'number') throw new Error(`TTL must be numeric (${typeof t})`)
+    if (typeof t !== 'number')
+      this.throwHelp(`TTL must be numeric (${typeof t})`)
 
     // RFC 1035, 2181
     this.is32bitInt(this.owner, 'TTL', t)
@@ -103,24 +111,34 @@ export default class RR extends Map {
     this.set('ttl', t)
   }
 
-  setType (t) {
+  setType(t) {
     switch (t) {
       case '':
       case undefined:
-        throw new Error(`type is required`)
+        this.throwHelp(`type is required`)
     }
 
     if (t.toUpperCase() !== this.constructor.name)
-      throw new Error(`type ${t} doesn't match ${this.constructor.name}`)
+      this.throwHelp(`type ${t} doesn't match ${this.constructor.name}`)
 
     this.set('type', t.toUpperCase())
   }
 
-  citeRFC () {
-    return `see RFC ${this.getRFCs()}`
+  throwHelp(e) {
+    if (this.constructor.name === 'RR') throw new Error(e)
+
+    const example = this.getCanonical
+      ? `Example ${this.constructor.name}:\n${util.inspect(this.getCanonical(), { depth: null })}\n\n`
+      : `${this.constructor.name} records have the fields: ${this.getFields().join(', ')}\n\n`
+
+    throw new Error(`${e}\n\n${example}${this.citeRFC()}\n`)
+  }
+
+  citeRFC() {
+    return `see RFC${this.getRFCs().length > 1 ? 's' : ''} ${this.getRFCs()}`
   }
 
-  fullyQualify (hostname, origin) {
+  fullyQualify(hostname, origin) {
     if (!hostname) return hostname
     if (hostname === '@' && origin) hostname = origin
     if (hostname.endsWith('.')) return hostname.toLowerCase()
@@ -128,7 +146,7 @@ export default class RR extends Map {
     return `${hostname}.`
   }
 
-  getPrefix (zone_opts = {}) {
+  getPrefix(zone_opts = {}) {
     const classVal = zone_opts.hide?.class ? '' : this.get('class')
 
     let rrTTL = this.get('ttl')
@@ -137,25 +155,24 @@ export default class RR extends Map {
     let owner = this.get('owner')
     if (zone_opts.hide?.sameOwner && zone_opts.previousOwner === owner) {
       owner = ''
-    }
-    else {
+    } else {
       owner = this.getFQDN('owner', zone_opts)
     }
 
     return `${owner}\t${rrTTL}\t${classVal}\t${this.get('type')}`
   }
 
-  getEmpty (prop) {
+  getEmpty(prop) {
     return this.get(prop) === undefined ? '' : this.get(prop)
   }
 
-  getComment (prop) {
+  getComment(prop) {
     const c = this.get('comment')
     if (!c || !c[prop]) return ''
     return c[prop]
   }
 
-  getQuoted (prop) {
+  getQuoted(prop) {
     // if prop is not in quoted list, return bare
     if (!this.getQuotedFields().includes(prop)) return this.get(prop)
 
@@ -165,16 +182,16 @@ export default class RR extends Map {
     return `"${this.get(prop)}"` // add double quotes
   }
 
-  getQuotedFields () {
+  getQuotedFields() {
     return []
   }
 
-  getRdataFields () {
+  getRdataFields() {
     return []
   }
 
-  getFields (arg) {
-    const commonFields = [ 'owner', 'ttl', 'class', 'type' ]
+  getFields(arg) {
+    const commonFields = ['owner', 'ttl', 'class', 'type']
     Object.freeze(commonFields)
 
     switch (arg) {
@@ -187,23 +204,24 @@ export default class RR extends Map {
     }
   }
 
-  getFQDN (field, zone_opts = {}) {
+  getFQDN(field, zone_opts = {}) {
     let fqdn = this.get(field)
-    if (!fqdn) throw new Error(`empty value for field ${field}`)
+    if (!fqdn) this.throwHelp(`empty value for field ${field}`)
     if (!fqdn.endsWith('.')) fqdn += '.'
 
     if (zone_opts.hide?.origin && zone_opts.origin) {
       if (fqdn === zone_opts.origin) return '@'
-      if (fqdn.endsWith(zone_opts.origin)) return fqdn.slice(0, fqdn.length - zone_opts.origin.length - 1)
+      if (fqdn.endsWith(zone_opts.origin))
+        return fqdn.slice(0, fqdn.length - zone_opts.origin.length - 1)
     }
 
     return fqdn
   }
 
-  getTinyFQDN (field) {
+  getTinyFQDN(field) {
     const val = this.get(field)
-    if (val === '') return val   // empty
-    if (val === '.') return val  // null MX
+    if (val === '') return val // empty
+    if (val === '.') return val // null MX
 
     // strip off trailing ., tinydns doesn't require it for FQDN
     if (val.endsWith('.')) return val.slice(0, -1)
@@ -211,15 +229,17 @@ export default class RR extends Map {
     return val
   }
 
-  getTinydnsGeneric (rdata) {
+  getTinydnsGeneric(rdata) {
     return `:${this.getTinyFQDN('owner')}:${this.getTypeId()}:${rdata}:${this.getTinydnsPostamble()}\n`
   }
 
-  getTinydnsPostamble () {
-    return [ 'ttl', 'timestamp', 'location' ].map(f => this.getEmpty(f)).join(':')
+  getTinydnsPostamble() {
+    return ['ttl', 'timestamp', 'location']
+      .map((f) => this.getEmpty(f))
+      .join(':')
   }
 
-  hasValidLabels (hostname) {
+  hasValidLabels(hostname) {
     // RFC  952 defined valid hostnames
     // RFC 1035 limited domain label chars to letters, digits, and hyphen
     // RFC 1123 allowed hostnames to start with a digit
@@ -227,68 +247,94 @@ export default class RR extends Map {
     const fq = hostname.endsWith('.') ? hostname.slice(0, -1) : hostname
     for (const label of fq.split('.')) {
       if (label.length < 1 || label.length > 63)
-        throw new Error('Labels must have 1-63 octets (characters), RFC 2181')
+        this.throwHelp('Labels must have 1-63 octets (characters), RFC 2181')
     }
   }
 
-  is8bitInt (type, field, value) {
-    if (typeof value === 'number'
-      && parseInt(value, 10) === value  // assure integer
-      && value >= 0
-      && value <= 255) return true
-
-    throw new Error(`${type} ${field} must be a 8-bit integer (in the range 0-255)`)
+  is8bitInt(type, field, value) {
+    if (
+      typeof value === 'number' &&
+      parseInt(value, 10) === value && // assure integer
+      value >= 0 &&
+      value <= 255
+    )
+      return true
+
+    this.throwHelp(
+      `${type} ${field} must be a 8-bit integer (in the range 0-255)`,
+    )
   }
 
-  is16bitInt (type, field, value) {
-    if (typeof value === 'number'
-      && parseInt(value, 10) === value  // assure integer
-      && value >= 0
-      && value <= 65535) return true
-
-    throw new Error(`${type} ${field} must be a 16-bit integer (in the range 0-65535)`)
+  is16bitInt(type, field, value) {
+    if (
+      typeof value === 'number' &&
+      parseInt(value, 10) === value && // assure integer
+      value >= 0 &&
+      value <= 65535
+    )
+      return true
+
+    this.throwHelp(
+      `${type} ${field} must be a 16-bit integer (in the range 0-65535)`,
+    )
   }
 
-  is32bitInt (type, field, value) {
-    if (typeof value === 'number'
-      && parseInt(value, 10) === value  // assure integer
-      && value >= 0
-      && value <= 2147483647) return true
-
-    throw new Error(`${type} ${field} must be a 32-bit integer (in the range 0-2147483647)`)
+  is32bitInt(type, field, value) {
+    if (
+      typeof value === 'number' &&
+      parseInt(value, 10) === value && // assure integer
+      value >= 0 &&
+      value <= 2147483647
+    )
+      return true
+
+    this.throwHelp(
+      `${type} ${field} must be a 32-bit integer (in the range 0-2147483647)`,
+    )
   }
 
-  isQuoted (val) {
+  isQuoted(val) {
     return /^["']/.test(val) && /["']$/.test(val)
   }
 
-  isFullyQualified (type, blah, hostname) {
+  isFullyQualified(type, field, hostname) {
     if (hostname.endsWith('.')) return true
 
-    throw new Error(`${type}: ${blah} must be fully qualified`)
+    this.throwHelp(`${type}: ${field} must be fully qualified`)
   }
 
-  isValidHostname (type, field, hostname) {
+  isValidHostname(type, field, hostname) {
     const allowed = new RegExp(/[^a-zA-Z0-9\-._/\\]/)
     if (!allowed.test(hostname)) return true
 
     const matches = allowed.exec(hostname)
-    throw new Error(`${type}, ${field} has invalid hostname character (${matches[0]})`)
+    this.throwHelp(
+      `${type}, ${field} has invalid hostname character (${matches[0]})`,
+    )
   }
 
-  toBind (zone_opts) {
-    return `${this.getPrefix(zone_opts)}\t${this.getRdataFields().map(f => this.getQuoted(f)).join('\t')}\n`
+  toBind(zone_opts) {
+    return `${this.getPrefix(zone_opts)}\t${this.getRdataFields()
+      .map((f) => this.getQuoted(f))
+      .join('\t')}\n`
   }
 
-  toMaraDNS () {
+  toMaraDNS() {
     const type = this.get('type')
-    const supportedTypes = 'A PTR MX AAAA SRV NAPTR NS SOA TXT SPF RAW FQDN4 FQDN6 CNAME HINFO WKS LOC'.split(/\s+/g)
+    const supportedTypes =
+      'A PTR MX AAAA SRV NAPTR NS SOA TXT SPF RAW FQDN4 FQDN6 CNAME HINFO WKS LOC'.split(
+        /\s+/g,
+      )
     if (!supportedTypes.includes(type)) return this.toMaraGeneric()
-    return `${this.get('owner')}\t+${this.get('ttl')}\t${type}\t${this.getRdataFields().map(f => this.getQuoted(f)).join('\t')} ~\n`
+    return `${this.get('owner')}\t+${this.get('ttl')}\t${type}\t${this.getRdataFields()
+      .map((f) => this.getQuoted(f))
+      .join('\t')} ~\n`
   }
 
-  toMaraGeneric () {
-    // throw new Error(`\nMaraDNS does not support ${type} records yet and this package does not support MaraDNS generic records. Yet.\n`)
-    return `${this.get('owner')}\t+${this.get('ttl')}\tRAW ${this.getTypeId()}\t'${this.getRdataFields().map(f => this.getQuoted(f)).join(' ')}' ~\n`
+  toMaraGeneric() {
+    // this.throwHelp(`\nMaraDNS does not support ${type} records yet and this package does not support MaraDNS generic records. Yet.\n`)
+    return `${this.get('owner')}\t+${this.get('ttl')}\tRAW ${this.getTypeId()}\t'${this.getRdataFields()
+      .map((f) => this.getQuoted(f))
+      .join(' ')}' ~\n`
   }
 }

package/.codeclimate.yml

@@ -1,25 +0,0 @@
-checks:
-  return-statements:
-    enabled: false
-  similar-code:
-    enabled: false
-  file-lines:
-    config:
-      threshold: 500
-  method-lines:
-    config:
-      threshold: 50
-  method-complexity:
-    config:
-      threshold: 10
-
-plugins:
-  eslint:
-    enabled: true
-    channel: "eslint-8"
-    config:
-      config: ".eslintrc.yaml"
-
-ratings:
-   paths:
-   - "**.js"

package/DEVELOP.md

@@ -1,23 +0,0 @@
-
-# Release process
-
-In your local repo:
-
-- make your changes
-- git add .
-- `.release/do.sh` {major|minor|patch}
-- fill in the blanks in CHANGELOG.md
-- `.release/push.sh`
-
-Upon merge to `master`:
-
-- the new version will be published to NPM.
-- a GitHub release will be published.
-- a release tag will be committed to the repo.
-
-## Clean
-
-`.release/cleanup.sh`
-
-- will switch to the master branch
-- delete the release branch

package/test/a.js

@@ -1,76 +0,0 @@
-
-import A    from '../rr/a.js'
-import * as base from './base.js'
-
-const defaults = { class: 'IN', ttl: 3600, type: 'A', address: '192.0.2.127' }
-
-const validRecords = [
-  {
-    ...defaults,
-    owner: 'test.example.com.',
-    testB: 'test.example.com.\t3600\tIN\tA\t192.0.2.127\n',
-    testT: '+test.example.com:192.0.2.127:3600::\n',
-  },
-  {
-    ...defaults,
-    owner: 'test.example.com.',
-    ttl  : 2147483647,
-    testB: 'test.example.com.\t2147483647\tIN\tA\t192.0.2.127\n',
-    testT: '+test.example.com:192.0.2.127:2147483647::\n',
-  },
-  {
-    ...defaults,
-    owner: 'a.',
-    ttl  : 86400,
-    testB: 'a.\t86400\tIN\tA\t192.0.2.127\n',
-    testT: '+a:192.0.2.127:86400::\n',
-  },
-  {
-    ...defaults,
-    owner: '*.example.com.',
-    testB: '*.example.com.\t3600\tIN\tA\t192.0.2.127\n',
-    testT: '+*.example.com:192.0.2.127:3600::\n',
-  },
-]
-
-const invalidRecords = [
-  { ...defaults, owner: '', msg: /RFC/ },
-  { ...defaults, owner: 'something*', msg: /fully/ },
-  { ...defaults, owner: 'some*thing', msg: /fully/ },
-  { ...defaults, owner: '*something', msg: /fully/ },
-  { ...defaults, owner: 'something.*', msg: /fully/ },
-  { ...defaults, address: 'hosts.not.valid.here', msg: /address must be IPv4/ },
-  { ...defaults, address: '', msg: /address is required/ },
-  { ...defaults, address: undefined, msg: /address is required/ },
-  { ...defaults, address: '1.x.2.3', msg: /address must be IPv4/ },
-  { ...defaults, address: '.1.2.3', msg: /address must be IPv4/ },
-  { ...defaults, type: '', msg: /type is required/ },
-  { ...defaults, type: undefined, msg: /type is required/ },
-  { ...defaults, ttl: '', msg: /TTL must be numeric/ },
-  { ...defaults, ttl: -299, msg: /TTL must be a 32-bit integer/ },
-  { ...defaults, ttl: 2147483648, msg: /TTL must be a 32-bit integer/ },
-]
-
-// copy invalid properties to a valid object
-for (let i = 0; i < invalidRecords.length; i++) {
-  const temp = JSON.parse(JSON.stringify(validRecords[0]))
-  Object.assign(temp, invalidRecords[i])
-  invalidRecords[i] = temp
-}
-
-describe('A record', function () {
-  base.valid(A, validRecords)
-  base.invalid(A, invalidRecords)
-
-  base.getDescription(A)
-  base.getRFCs(A, validRecords[0])
-  base.getRdataFields(A, [ 'address' ])
-  base.getFields(A, [ 'address' ])
-  base.getTypeId(A, 1)
-
-  base.toBind(A, validRecords)
-  base.toTinydns(A, validRecords)
-
-  base.fromBind(A, validRecords)
-  base.fromTinydns(A, validRecords)
-})

package/test/aaaa.js

@@ -1,79 +0,0 @@
-
-import assert from 'assert'
-
-import * as base from './base.js'
-import AAAA from '../rr/aaaa.js'
-
-const defaults = { class: 'IN', ttl: 3600, type: 'AAAA' }
-
-const validRecords = [
-  {
-    ...defaults,
-    owner  : 'test.example.com.',
-    address: '2001:0db8:0020:000a:0000:0000:0000:0004',
-    testB  : 'test.example.com.\t3600\tIN\tAAAA\t2001:db8:20:a::4\n',
-    testT  : ':test.example.com:28:\\040\\001\\015\\270\\000\\040\\000\\012\\000\\000\\000\\000\\000\\000\\000\\004:3600::\n',
-  },
-]
-
-const invalidRecords = [
-  {
-    ...defaults,
-    owner  : 'test.example.com.',
-    address: '192.0.2.204',
-    msg    : /address must be IPv6/,
-  },
-]
-
-describe('AAAA record', function () {
-  base.valid(AAAA, validRecords)
-  base.invalid(AAAA, invalidRecords)
-
-  base.getDescription(AAAA)
-  base.getRFCs(AAAA, validRecords[0])
-  base.getFields(AAAA, [ 'address' ])
-  base.getTypeId(AAAA, 28)
-
-  base.toBind(AAAA, validRecords)
-  base.toTinydns(AAAA, validRecords)
-
-  base.fromBind(AAAA, validRecords)
-  base.fromTinydns(AAAA, validRecords)
-
-  for (const val of validRecords) {
-    it(`imports tinydns AAAA (generic) record (${val.owner})`, async function () {
-      const r = new AAAA({ tinyline: val.testT })
-      if (process.env.DEBUG) console.dir(r)
-      for (const f of [ 'owner', 'address', 'ttl' ]) {
-        assert.deepStrictEqual(r.get(f), val[f], `${f}: ${r.get(f)} !== ${val[f]}`)
-      }
-    })
-  }
-
-  const tests = [
-    { e: '2001:0db8:0020:000a:0000:0000:0000:0004', c: '2001:db8:20:a::4' },
-    { e: '0000:0000:0000:0000:0000:0000:0000:0000', c: '::' },
-    { e: '0000:0000:0000:0000:0000:0000:0000:0001', c: '::1' },
-    { e: '2001:0db8:0000:0000:0000:0000:0002:0001', c: '2001:db8::2:1' },
-    { e: '2001:0db8:0000:0001:0001:0001:0001:0001', c: '2001:db8:0:1:1:1:1:1' },
-    { e: '2001:0DB8:0000:0000:0008:0800:200C:417A', c: '2001:DB8::8:800:200C:417A' },
-  ]
-
-  describe('compress', function () {
-    const r = new AAAA(null)
-    for (const t of tests) {
-      it(`compresses IPv6 address (${t.e})`, function () {
-        assert.equal(r.compress(t.e), t.c)
-      })
-    }
-  })
-
-  describe('expand', function () {
-    const r = new AAAA(null)
-    for (const t of tests) {
-      it(`expands IPv6 address (${t.c})`, function () {
-        assert.equal(r.expand(t.c), t.e)
-      })
-    }
-  })
-})