@xyo-network/xns-record-payload-plugins 3.0.3 → 3.0.5

package/src/DNS/types/ResourceRecord.ts

@@ -0,0 +1,229 @@
+// https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4
+
+export type DNSResourceRecordType =
+  | 'A'
+  | 'NS'
+  | 'MD'
+  | 'MF'
+  | 'CNAME'
+  | 'SOA'
+  | 'MB'
+  | 'MG'
+  | 'MR'
+  | 'NULL'
+  | 'WKS'
+  | 'PTR'
+  | 'HINFO'
+  | 'MINFO'
+  | 'MX'
+  | 'TXT'
+  | 'RP'
+  | 'AFSDB'
+  | 'X25'
+  | 'ISDN'
+  | 'RT'
+  | 'NSAP'
+  | 'NSAP-PTR'
+  | 'SIG'
+  | 'KEY'
+  | 'PX'
+  | 'GPOS'
+  | 'AAAA'
+  | 'LOC'
+  | 'NXT'
+  | 'EID'
+  | 'NIMLOC'
+  | 'SRV'
+  | 'ATMA'
+  | 'NAPTR'
+  | 'KX'
+  | 'CERT'
+  | 'A6'
+  | 'DNAME'
+  | 'SINK'
+  | 'OPT'
+  | 'APL'
+  | 'DS'
+  | 'SSHFP'
+  | 'IPSECKEY'
+  | 'RRSIG'
+  | 'NSEC'
+  | 'DNSKEY'
+  | 'DHCID'
+  | 'NSEC3'
+  | 'NSEC3PARAM'
+  | 'TLSA'
+  | 'SMIMEA'
+  | 'HIP'
+  | 'NINFO'
+  | 'RKEY'
+  | 'TALINK'
+  | 'CDS'
+  | 'CDNSKEY'
+  | 'OPENPGPKEY'
+  | 'CSYNC'
+  | 'ZONEMD'
+  | 'SVCB'
+  | 'HTTPS'
+  | 'SPF'
+  | 'UINFO'
+  | 'UID'
+  | 'GID'
+  | 'UNSPEC'
+  | 'NID'
+  | 'L32'
+  | 'L64'
+  | 'LP'
+  | 'EUI48'
+  | 'EUI64'
+  | 'NXNAME'
+  | 'TKEY'
+  | 'TSIG'
+  | 'IXFR'
+  | 'AXFR'
+  | 'MAILB'
+  | 'MAILA'
+  | '*'
+  | 'URI'
+  | 'CAA'
+  | 'AVC'
+  | 'DOA'
+  | 'AMTRELAY'
+  | 'RESINFO'
+  | 'WALLET'
+  | 'CLA'
+  | 'IPN'
+  | 'TA'
+  | 'DLV'
+  // NOTE: Custom types here
+  | 'XYOA'
+  | 'XYOH'
+
+export const DNSResourceRecordTypes: Readonly<Record<DNSResourceRecordType, number>> = {
+  'A': 1, // a host address
+  'NS': 2, // an authoritative name server
+  'MD': 3, // a mail destination (OBSOLETE - use MX)
+  'MF': 4, // a mail forwarder (OBSOLETE - use MX)
+  'CNAME': 5, // the canonical name for an alias
+  'SOA': 6, // marks the start of a zone of authority
+  'MB': 7, // a mailbox domain name (EXPERIMENTAL)
+  'MG': 8, // a mail group member (EXPERIMENTAL)
+  'MR': 9, // a mail rename domain name (EXPERIMENTAL)
+  'NULL': 10, // a null RR (EXPERIMENTAL)
+  'WKS': 11, // a well known service description
+  'PTR': 12, // a domain name pointer
+  'HINFO': 13, // host information
+  'MINFO': 14, // mailbox or mail list information
+  'MX': 15, // mail exchange
+  'TXT': 16, // text strings
+  'RP': 17, // for Responsible Person
+  'AFSDB': 18, // for AFS Data Base location
+  'X25': 19, // for X.25 PSDN address
+  'ISDN': 20, // for ISDN address
+  'RT': 21, // for Route Through
+  'NSAP': 22, // for NSAP address, NSAP style A record (DEPRECATED)
+  'NSAP-PTR': 23, // for domain name pointer, NSAP style (DEPRECATED)
+  'SIG': 24, // for security signature
+  'KEY': 25, // for security key
+  'PX': 26, // X.400 mail mapping information
+  'GPOS': 27, // Geographical Position
+  'AAAA': 28, // IP6 Address
+  'LOC': 29, // Location Information
+  'NXT': 30, // Next Domain (OBSOLETE)
+  'EID': 31, // Endpoint Identifier
+  'NIMLOC': 32, // Nimrod Locator
+  'SRV': 33, // Server Selection
+  'ATMA': 34, // ATM Address
+  'NAPTR': 35, // Naming Authority Pointer
+  'KX': 36, // Key Exchanger
+  'CERT': 37, // CERT
+  'A6': 38, // A6 (OBSOLETE - use AAAA)
+  'DNAME': 39, // DNAME
+  'SINK': 40, // SINK
+  'OPT': 41, // OPT
+  'APL': 42, // APL
+  'DS': 43, // Delegation Signer
+  'SSHFP': 44, // SSH Key Fingerprint
+  'IPSECKEY': 45, // IPSECKEY
+  'RRSIG': 46, // RRSIG
+  'NSEC': 47, // NSEC
+  'DNSKEY': 48, // DNSKEY
+  'DHCID': 49, // DHCID
+  'NSEC3': 50, // NSEC3
+  'NSEC3PARAM': 51, // NSEC3PARAM
+  'TLSA': 52, // TLSA
+  'SMIMEA': 53, // S/MIME cert association
+  'HIP': 55, // Host Identity Protocol
+  'NINFO': 56, // NINFO
+  'RKEY': 57, // RKEY
+  'TALINK': 58, // Trust Anchor LINK
+  'CDS': 59, // Child DS
+  'CDNSKEY': 60, // DNSKEY(s) the Child wants reflected in DS
+  'OPENPGPKEY': 61, // OpenPGP Key
+  'CSYNC': 62, // Child-To-Parent Synchronization
+  'ZONEMD': 63, // Message Digest Over Zone Data
+  'SVCB': 64, // General-purpose service binding
+  'HTTPS': 65, // SVCB-compatible type for use with HTTP
+  'SPF': 99,
+  'UINFO': 100,
+  'UID': 101,
+  'GID': 102,
+  'UNSPEC': 103,
+  'NID': 104,
+  'L32': 105,
+  'L64': 106,
+  'LP': 107,
+  'EUI48': 108, // an EUI-48 address
+  'EUI64': 109, // an EUI-64 address
+  'NXNAME': 128, // NXDOMAIN indicator for Compact Denial of Existence
+  'TKEY': 249, // Transaction Key
+  'TSIG': 250, // Transaction Signature
+  'IXFR': 251, // incremental transfer
+  'AXFR': 252, // transfer of an entire zone
+  'MAILB': 253, // mailbox-related RRs (MB, MG or MR)
+  'MAILA': 254, // mail agent RRs (OBSOLETE - see MX)
+  '*': 255, // A request for some or all records the server has available
+  'URI': 256, // URI
+  'CAA': 257, // Certification Authority Restriction
+  'AVC': 258, // Application Visibility and Control
+  'DOA': 259, // Digital Object Architecture
+  'AMTRELAY': 260, // Automatic Multicast Tunneling Relay
+  'RESINFO': 261, // Resolver Information as Key/Value Pairs
+  'WALLET': 262, // Public wallet address
+  'CLA': 263, // BP Convergence Layer Adapter
+  'IPN': 264, // BP Node Number
+  'TA': 32_768, // DNSSEC Trust Authorities
+  'DLV': 32_769, // DNSSEC Lookaside Validation (OBSOLETE)
+
+  // NOTE: Custom types here chosen within the Private Use Range
+  // https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4
+  // https://www.rfc-editor.org/rfc/rfc5226
+  // as, per the RFC, the Private Use Range is reserved
+  // "For private or local use only, with the type and
+  // purpose defined by the local site.  No attempt is made to
+  // prevent multiple sites from using the same value in
+  // different (and incompatible) ways.  There is no need for
+  // IANA to review such assignments (since IANA does not record
+  // them) and assignments are not generally useful for broad
+  // interoperability.  It is the responsibility of the sites
+  // making use of the Private Use range to ensure that no
+  // conflicts occur (within the intended scope of use)."
+  // If we want to apply for a custom reserved code later
+  // on, once the usage is proven enough we can absolutely
+  // do that.
+  'XYOA': 65_432, // XYO Address
+  'XYOH': 65_433, // XYO Hash
+}
+
+export type DNSResourceRecordTypeValue = (typeof DNSResourceRecordTypes)[keyof typeof DNSResourceRecordTypes]
+
+export const findDNSResourceRecordTypesByValue = (value: DNSResourceRecordTypeValue): DNSResourceRecordType | undefined => {
+  // Iterate through the keys of the record
+  for (const key in DNSResourceRecordTypes) {
+    const resourceRecordType = key as DNSResourceRecordType
+    if (DNSResourceRecordTypes[resourceRecordType] === value) {
+      return resourceRecordType // Return the key if the value matches
+    }
+  }
+  return undefined // Return undefined if no matching value is found
+}

package/src/DNS/types/Response.ts

@@ -0,0 +1,12 @@
+import type { DNSAnswer } from './Answer.ts'
+import type { DNSResponseHeader } from './Header.ts'
+import type { DNSRecord } from './Record.ts'
+import type { DNSQuestion } from './Request.ts'
+
+/* eslint-disable @typescript-eslint/member-ordering */
+export interface DNSResponseFields extends DNSResponseHeader {
+  Question: DNSQuestion[] // The questions that were asked
+  Answer: DNSAnswer[] // Reusing DNSAnswer for the Answer Section
+  Authority?: DNSRecord[]
+  Additional?: DNSRecord[]
+}

package/src/DNS/types/ResponseCodes.ts

@@ -0,0 +1,34 @@
+export type DNSRcode = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 16 | 17 | 18
+
+export type DNSRcodeName =
+  | 'NOERROR'
+  | 'FORMERR'
+  | 'SERVFAIL'
+  | 'NXDOMAIN'
+  | 'NOTIMP'
+  | 'REFUSED'
+  | 'YXDOMAIN'
+  | 'YXRRSET'
+  | 'NXRRSET'
+  | 'NOTAUTH'
+  | 'NOTZONE'
+  | 'BADSIG'
+  | 'BADKEY'
+  | 'BADTIME'
+
+export const DNSRcodes: Readonly<Record<DNSRcodeName, DNSRcode>> = {
+  NOERROR: 0,
+  FORMERR: 1,
+  SERVFAIL: 2,
+  NXDOMAIN: 3,
+  NOTIMP: 4,
+  REFUSED: 5,
+  YXDOMAIN: 6,
+  YXRRSET: 7,
+  NXRRSET: 8,
+  NOTAUTH: 9,
+  NOTZONE: 10,
+  BADSIG: 16,
+  BADKEY: 17,
+  BADTIME: 18,
+}

package/src/DNS/types/index.ts

@@ -0,0 +1,8 @@
+export * from './Answer.ts'
+export * from './Header.ts'
+export * from './OperationCodes.ts'
+export * from './Record.ts'
+export * from './Request.ts'
+export * from './ResourceRecord.ts'
+export * from './Response.ts'
+export * from './ResponseCodes.ts'

package/src/Domain/Domain.ts

@@ -1,5 +1,7 @@
 import type { Payload } from '@xyo-network/payload-model'
-import { isPayloadOfSchemaType, isPayloadOfSchemaTypeWithMeta, isPayloadOfSchemaTypeWithSources } from '@xyo-network/payload-model'
+import {
+  isPayloadOfSchemaType, isPayloadOfSchemaTypeWithMeta, isPayloadOfSchemaTypeWithSources,
+} from '@xyo-network/payload-model'
 
 export type DomainSchema = 'network.xyo.ns.domain'
 export const DomainSchema: DomainSchema = 'network.xyo.ns.domain'

package/src/Domain/DomainLease.ts

@@ -1,5 +1,7 @@
 import type { Payload } from '@xyo-network/payload-model'
-import { isPayloadOfSchemaType, isPayloadOfSchemaTypeWithMeta, isPayloadOfSchemaTypeWithSources } from '@xyo-network/payload-model'
+import {
+  isPayloadOfSchemaType, isPayloadOfSchemaTypeWithMeta, isPayloadOfSchemaTypeWithSources,
+} from '@xyo-network/payload-model'
 
 import type { DurationFields } from '../Duration/index.ts'
 import type { DomainFields } from './Domain.ts'

package/src/DomainRegistration/DomainRegistration.ts

@@ -1,6 +1,8 @@
 import type { Address } from '@xylabs/hex'
 import type { Payload } from '@xyo-network/payload-model'
-import { isPayloadOfSchemaType, isPayloadOfSchemaTypeWithMeta, isPayloadOfSchemaTypeWithSources } from '@xyo-network/payload-model'
+import {
+  isPayloadOfSchemaType, isPayloadOfSchemaTypeWithMeta, isPayloadOfSchemaTypeWithSources,
+} from '@xyo-network/payload-model'
 
 import type { DomainFields } from '../Domain/index.ts'
 import { DomainSchema } from '../Domain/index.ts'

package/src/DomainRegistration/DomainRegistrationLease.ts

@@ -1,5 +1,7 @@
 import type { Payload } from '@xyo-network/payload-model'
-import { isPayloadOfSchemaType, isPayloadOfSchemaTypeWithMeta, isPayloadOfSchemaTypeWithSources } from '@xyo-network/payload-model'
+import {
+  isPayloadOfSchemaType, isPayloadOfSchemaTypeWithMeta, isPayloadOfSchemaTypeWithSources,
+} from '@xyo-network/payload-model'
 
 import type { DurationFields } from '../Duration/index.ts'
 import type { DomainRegistrationFields } from './DomainRegistration.ts'

package/src/diviner/DomainLeaseEstimateDiviner/ErrorDetails/ErrorCodes.ts

@@ -8,13 +8,31 @@ export const DomainLeaseEstimateDivinerErrorDetailsDictionary: Readonly<
   Readonly<Record<DomainLeaseEstimateDivinerErrorDetailsDictionaryErrorCode, DomainLeaseEstimateDivinerValidationErrorDetails>> &
   ErrorDetailsDictionary
 > = {
-  0: { code: '0', schema: DomainLeaseEstimateDivinerValidationErrorDetailsSchema, title: 'Success' },
-  1: { code: '1', schema: DomainLeaseEstimateDivinerValidationErrorDetailsSchema, title: 'Invalid casing' },
-  2: { code: '2', schema: DomainLeaseEstimateDivinerValidationErrorDetailsSchema, title: 'Invalid coin signature' },
-  3: { code: '3', schema: DomainLeaseEstimateDivinerValidationErrorDetailsSchema, title: 'Invalid length' },
-  4: { code: '4', schema: DomainLeaseEstimateDivinerValidationErrorDetailsSchema, title: 'Invalid name' },
-  5: { code: '5', schema: DomainLeaseEstimateDivinerValidationErrorDetailsSchema, title: 'Reserved fragment' },
-  6: { code: '6', schema: DomainLeaseEstimateDivinerValidationErrorDetailsSchema, title: 'Reserved name' },
-  7: { code: '7', schema: DomainLeaseEstimateDivinerValidationErrorDetailsSchema, title: 'Reserved string' },
-  8: { code: '8', schema: DomainLeaseEstimateDivinerValidationErrorDetailsSchema, title: 'Invalid TLD' },
+  0: {
+    code: '0', schema: DomainLeaseEstimateDivinerValidationErrorDetailsSchema, title: 'Success',
+  },
+  1: {
+    code: '1', schema: DomainLeaseEstimateDivinerValidationErrorDetailsSchema, title: 'Invalid casing',
+  },
+  2: {
+    code: '2', schema: DomainLeaseEstimateDivinerValidationErrorDetailsSchema, title: 'Invalid coin signature',
+  },
+  3: {
+    code: '3', schema: DomainLeaseEstimateDivinerValidationErrorDetailsSchema, title: 'Invalid length',
+  },
+  4: {
+    code: '4', schema: DomainLeaseEstimateDivinerValidationErrorDetailsSchema, title: 'Invalid name',
+  },
+  5: {
+    code: '5', schema: DomainLeaseEstimateDivinerValidationErrorDetailsSchema, title: 'Reserved fragment',
+  },
+  6: {
+    code: '6', schema: DomainLeaseEstimateDivinerValidationErrorDetailsSchema, title: 'Reserved name',
+  },
+  7: {
+    code: '7', schema: DomainLeaseEstimateDivinerValidationErrorDetailsSchema, title: 'Reserved string',
+  },
+  8: {
+    code: '8', schema: DomainLeaseEstimateDivinerValidationErrorDetailsSchema, title: 'Invalid TLD',
+  },
 } as const

package/src/diviner/DomainLeaseEstimateDiviner/ErrorDetails/Payload.ts

@@ -1,5 +1,7 @@
 import type { Payload } from '@xyo-network/payload-model'
-import { isPayloadOfSchemaType, isPayloadOfSchemaTypeWithMeta, isPayloadOfSchemaTypeWithSources } from '@xyo-network/payload-model'
+import {
+  isPayloadOfSchemaType, isPayloadOfSchemaTypeWithMeta, isPayloadOfSchemaTypeWithSources,
+} from '@xyo-network/payload-model'
 
 import { DomainLeaseEstimateDivinerValidationErrorDetailsSchema } from '../Schema.ts'
 

package/src/index.ts

@@ -1,5 +1,6 @@
 export * from './Address/index.ts'
 export * from './diviner/index.ts'
+export * from './DNS/index.ts'
 export * from './Domain/index.ts'
 export * from './DomainRegistration/index.ts'
 export * from './Duration/index.ts'