@helia/dnslink 0.0.0

package/dist/src/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const MAX_RECURSIVE_DEPTH = 32;
+//# sourceMappingURL=constants.d.ts.map

package/dist/src/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,mBAAmB,KAAK,CAAA"}

package/dist/src/constants.js

@@ -0,0 +1,2 @@
+export const MAX_RECURSIVE_DEPTH = 32;
+//# sourceMappingURL=constants.js.map

package/dist/src/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,CAAA"}

package/dist/src/dnslink.d.ts

@@ -0,0 +1,11 @@
+import type { DNSLink as DNSLinkInterface, ResolveDNSLinkOptions, DNSLinkOptions, DNSLinkComponents, DNSLinkResult } from './index.js';
+export declare class DNSLink implements DNSLinkInterface {
+    private readonly dns;
+    private readonly log;
+    private readonly namespaces;
+    constructor(components: DNSLinkComponents, init?: DNSLinkOptions);
+    resolve(domain: string, options?: ResolveDNSLinkOptions): Promise<DNSLinkResult>;
+    recursiveResolveDomain(domain: string, depth: number, options?: ResolveDNSLinkOptions): Promise<DNSLinkResult>;
+    recursiveResolveDnslink(domain: string, depth: number, options?: ResolveDNSLinkOptions): Promise<DNSLinkResult>;
+}
+//# sourceMappingURL=dnslink.d.ts.map

package/dist/src/dnslink.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dnslink.d.ts","sourceRoot":"","sources":["../../src/dnslink.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,IAAI,gBAAgB,EAAE,qBAAqB,EAAE,cAAc,EAAE,iBAAiB,EAAE,aAAa,EAAoB,MAAM,YAAY,CAAA;AAIxJ,qBAAa,OAAQ,YAAW,gBAAgB;IAC9C,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAK;IACzB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAQ;IAC5B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAkC;gBAEhD,UAAU,EAAE,iBAAiB,EAAE,IAAI,GAAE,cAAmB;IAU/D,OAAO,CAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,qBAA0B,GAAG,OAAO,CAAC,aAAa,CAAC;IAIrF,sBAAsB,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,qBAA0B,GAAG,OAAO,CAAC,aAAa,CAAC;IAkCnH,uBAAuB,CAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,qBAA0B,GAAG,OAAO,CAAC,aAAa,CAAC;CAoF3H"}

package/dist/src/dnslink.js

@@ -0,0 +1,120 @@
+import { MAX_RECURSIVE_DEPTH, RecordType } from '@multiformats/dns';
+import { DNSLinkNotFoundError } from './errors.js';
+import { ipfs } from "./namespaces/ipfs.js";
+import { ipns } from "./namespaces/ipns.js";
+export class DNSLink {
+    dns;
+    log;
+    namespaces;
+    constructor(components, init = {}) {
+        this.dns = components.dns;
+        this.log = components.logger.forComponent('helia:dnslink');
+        this.namespaces = {
+            ipfs,
+            ipns,
+            ...init.namespaces
+        };
+    }
+    async resolve(domain, options = {}) {
+        return this.recursiveResolveDomain(domain, options.maxRecursiveDepth ?? MAX_RECURSIVE_DEPTH, options);
+    }
+    async recursiveResolveDomain(domain, depth, options = {}) {
+        if (depth === 0) {
+            throw new Error('recursion limit exceeded');
+        }
+        // the DNSLink spec says records MUST be stored on the `_dnslink.` subdomain
+        // so start looking for records there, we will fall back to the bare domain
+        // if none are found
+        if (!domain.startsWith('_dnslink.')) {
+            domain = `_dnslink.${domain}`;
+        }
+        try {
+            return await this.recursiveResolveDnslink(domain, depth, options);
+        }
+        catch (err) {
+            // If the code is not ENOTFOUND or ERR_DNSLINK_NOT_FOUND or ENODATA then throw the error
+            if (err.code !== 'ENOTFOUND' && err.code !== 'ENODATA' && err.name !== 'DNSLinkNotFoundError' && err.name !== 'NotFoundError') {
+                throw err;
+            }
+            if (domain.startsWith('_dnslink.')) {
+                // The supplied domain contains a _dnslink component
+                // Check the non-_dnslink domain
+                domain = domain.replace('_dnslink.', '');
+            }
+            else {
+                // Check the _dnslink subdomain
+                domain = `_dnslink.${domain}`;
+            }
+            // If this throws then we propagate the error
+            return this.recursiveResolveDnslink(domain, depth, options);
+        }
+    }
+    async recursiveResolveDnslink(domain, depth, options = {}) {
+        if (depth === 0) {
+            throw new Error('recursion limit exceeded');
+        }
+        this.log('query %s for TXT and CNAME records', domain);
+        const txtRecordsResponse = await this.dns.query(domain, {
+            ...options,
+            types: [
+                RecordType.TXT
+            ]
+        });
+        // sort the TXT records to ensure deterministic processing
+        const txtRecords = (txtRecordsResponse?.Answer ?? [])
+            .sort((a, b) => a.data.localeCompare(b.data));
+        this.log('found %d TXT records for %s', txtRecords.length, domain);
+        for (const answer of txtRecords) {
+            try {
+                let result = answer.data;
+                // strip leading and trailing " characters
+                if (result.startsWith('"') && result.endsWith('"')) {
+                    result = result.substring(1, result.length - 1);
+                }
+                if (!result.startsWith('dnslink=')) {
+                    // invalid record?
+                    continue;
+                }
+                this.log('%s TXT %s', answer.name, result);
+                result = result.replace('dnslink=', '');
+                // result is now a `/ipfs/<cid>` or `/ipns/<cid>` string
+                const [, protocol, domainOrCID] = result.split('/'); // e.g. ["", "ipfs", "<cid>"]
+                if (protocol === 'dnslink') {
+                    // if the result was another DNSLink domain, try to follow it
+                    return await this.recursiveResolveDomain(domainOrCID, depth - 1, options);
+                }
+                const parser = this.namespaces[protocol];
+                if (parser == null) {
+                    this.log('unknown protocol "%s" in DNSLink record for domain: %s', protocol, domain);
+                    continue;
+                }
+                return parser.parse(result, answer);
+            }
+            catch (err) {
+                this.log.error('could not parse DNS link record for domain %s, %s', domain, answer.data, err);
+            }
+        }
+        // no dnslink records found, try CNAMEs
+        this.log('no DNSLink records found for %s, falling back to CNAME', domain);
+        const cnameRecordsResponse = await this.dns.query(domain, {
+            ...options,
+            types: [
+                RecordType.CNAME
+            ]
+        });
+        // sort the CNAME records to ensure deterministic processing
+        const cnameRecords = (cnameRecordsResponse?.Answer ?? [])
+            .sort((a, b) => a.data.localeCompare(b.data));
+        this.log('found %d CNAME records for %s', cnameRecords.length, domain);
+        for (const cname of cnameRecords) {
+            try {
+                return await this.recursiveResolveDomain(cname.data, depth - 1, options);
+            }
+            catch (err) {
+                this.log.error('domain %s cname %s had no DNSLink records - %e', domain, cname.data, err);
+            }
+        }
+        throw new DNSLinkNotFoundError(`No DNSLink records found for domain: ${domain}`);
+    }
+}
+//# sourceMappingURL=dnslink.js.map

package/dist/src/dnslink.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dnslink.js","sourceRoot":"","sources":["../../src/dnslink.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAA;AAC3C,OAAO,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAA;AAK3C,MAAM,OAAO,OAAO;IACD,GAAG,CAAK;IACR,GAAG,CAAQ;IACX,UAAU,CAAkC;IAE7D,YAAa,UAA6B,EAAE,OAAuB,EAAE;QACnE,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,GAAG,CAAA;QACzB,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,eAAe,CAAC,CAAA;QAC1D,IAAI,CAAC,UAAU,GAAG;YAChB,IAAI;YACJ,IAAI;YACJ,GAAG,IAAI,CAAC,UAAU;SACnB,CAAA;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CAAE,MAAc,EAAE,UAAiC,EAAE;QAChE,OAAO,IAAI,CAAC,sBAAsB,CAAC,MAAM,EAAE,OAAO,CAAC,iBAAiB,IAAI,mBAAmB,EAAE,OAAO,CAAC,CAAA;IACvG,CAAC;IAED,KAAK,CAAC,sBAAsB,CAAE,MAAc,EAAE,KAAa,EAAE,UAAiC,EAAE;QAC9F,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;QAC7C,CAAC;QAED,4EAA4E;QAC5E,2EAA2E;QAC3E,oBAAoB;QACpB,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YACpC,MAAM,GAAG,YAAY,MAAM,EAAE,CAAA;QAC/B,CAAC;QAED,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;QACnE,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,wFAAwF;YACxF,IAAI,GAAG,CAAC,IAAI,KAAK,WAAW,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,KAAK,sBAAsB,IAAI,GAAG,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;gBAC9H,MAAM,GAAG,CAAA;YACX,CAAC;YAED,IAAI,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;gBACnC,oDAAoD;gBACpD,gCAAgC;gBAChC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;YAC1C,CAAC;iBAAM,CAAC;gBACN,+BAA+B;gBAC/B,MAAM,GAAG,YAAY,MAAM,EAAE,CAAA;YAC/B,CAAC;YAED,6CAA6C;YAC7C,OAAO,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;QAC7D,CAAC;IACH,CAAC;IAED,KAAK,CAAC,uBAAuB,CAAE,MAAc,EAAE,KAAa,EAAE,UAAiC,EAAE;QAC/F,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;QAC7C,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAA;QACtD,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE;YACtD,GAAG,OAAO;YACV,KAAK,EAAE;gBACL,UAAU,CAAC,GAAG;aACf;SACF,CAAC,CAAA;QAEF,0DAA0D;QAC1D,MAAM,UAAU,GAAG,CAAC,kBAAkB,EAAE,MAAM,IAAI,EAAE,CAAC;aAClD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;QAE/C,IAAI,CAAC,GAAG,CAAC,6BAA6B,EAAE,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAElE,KAAK,MAAM,MAAM,IAAI,UAAU,EAAE,CAAC;YAChC,IAAI,CAAC;gBACH,IAAI,MAAM,GAAG,MAAM,CAAC,IAAI,CAAA;gBAExB,0CAA0C;gBAC1C,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBACnD,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;gBACjD,CAAC;gBAED,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;oBACnC,kBAAkB;oBAClB,SAAQ;gBACV,CAAC;gBAED,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;gBAE1C,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAA;gBAEvC,wDAAwD;gBACxD,MAAM,CAAC,EAAE,QAAQ,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA,CAAC,6BAA6B;gBAEjF,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;oBAC3B,6DAA6D;oBAC7D,OAAO,MAAM,IAAI,CAAC,sBAAsB,CAAC,WAAW,EAAE,KAAK,GAAG,CAAC,EAAE,OAAO,CAAC,CAAA;gBAC3E,CAAC;gBAED,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;gBAExC,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;oBACnB,IAAI,CAAC,GAAG,CAAC,wDAAwD,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAA;oBACpF,SAAQ;gBACV,CAAC;gBAED,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;YACrC,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mDAAmD,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;YAC/F,CAAC;QACH,CAAC;QAED,uCAAuC;QACvC,IAAI,CAAC,GAAG,CAAC,wDAAwD,EAAE,MAAM,CAAC,CAAA;QAE1E,MAAM,oBAAoB,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE;YACxD,GAAG,OAAO;YACV,KAAK,EAAE;gBACL,UAAU,CAAC,KAAK;aACjB;SACF,CAAC,CAAA;QAEF,4DAA4D;QAC5D,MAAM,YAAY,GAAG,CAAC,oBAAoB,EAAE,MAAM,IAAI,EAAE,CAAC;aACtD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;QAE/C,IAAI,CAAC,GAAG,CAAC,+BAA+B,EAAE,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAEtE,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;YACjC,IAAI,CAAC;gBACH,OAAO,MAAM,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,EAAE,OAAO,CAAC,CAAA;YAC1E,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,gDAAgD,EAAE,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;YAC3F,CAAC;QACH,CAAC;QAED,MAAM,IAAI,oBAAoB,CAAC,wCAAwC,MAAM,EAAE,CAAC,CAAA;IAClF,CAAC;CACF"}

package/dist/src/errors.d.ts

@@ -0,0 +1,9 @@
+export declare class DNSLinkNotFoundError extends Error {
+    static name: string;
+    constructor(message?: string);
+}
+export declare class InvalidNamespaceError extends Error {
+    static name: string;
+    constructor(message?: string);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/src/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,qBAAa,oBAAqB,SAAQ,KAAK;IAC7C,MAAM,CAAC,IAAI,SAAyB;gBAEvB,OAAO,SAAsB;CAI3C;AAED,qBAAa,qBAAsB,SAAQ,KAAK;IAC9C,MAAM,CAAC,IAAI,SAA0B;gBAExB,OAAO,SAAsB;CAI3C"}

package/dist/src/errors.js

@@ -0,0 +1,15 @@
+export class DNSLinkNotFoundError extends Error {
+    static name = 'DNSLinkNotFoundError';
+    constructor(message = 'DNSLink not found') {
+        super(message);
+        this.name = 'DNSLinkNotFoundError';
+    }
+}
+export class InvalidNamespaceError extends Error {
+    static name = 'InvalidNamespaceError';
+    constructor(message = 'Invalid namespace') {
+        super(message);
+        this.name = 'InvalidNamespaceError';
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/src/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,oBAAqB,SAAQ,KAAK;IAC7C,MAAM,CAAC,IAAI,GAAG,sBAAsB,CAAA;IAEpC,YAAa,OAAO,GAAG,mBAAmB;QACxC,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAA;IACpC,CAAC;;AAGH,MAAM,OAAO,qBAAsB,SAAQ,KAAK;IAC9C,MAAM,CAAC,IAAI,GAAG,uBAAuB,CAAA;IAErC,YAAa,OAAO,GAAG,mBAAmB;QACxC,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAA;IACrC,CAAC"}

package/dist/src/index.d.ts

@@ -0,0 +1,219 @@
+/**
+ * @packageDocumentation
+ *
+ * [DNSLink](https://dnslink.dev/) operations using a Helia node.
+ *
+ * @example Using custom DNS over HTTPS resolvers
+ *
+ * To use custom resolvers, configure Helia's `dns` option:
+ *
+ * ```TypeScript
+ * import { createHelia } from 'helia'
+ * import { dnsLink } from '@helia/dnslink'
+ * import { dns } from '@multiformats/dns'
+ * import { dnsOverHttps } from '@multiformats/dns/resolvers'
+ * import type { DefaultLibp2pServices } from 'helia'
+ * import type { Libp2p } from '@libp2p/interface'
+ *
+ * const node = await createHelia<Libp2p<DefaultLibp2pServices>>({
+ *   dns: dns({
+ *     resolvers: {
+ *       '.': dnsOverHttps('https://private-dns-server.me/dns-query')
+ *     }
+ *   })
+ * })
+ * const name = dnsLink(node)
+ *
+ * const result = name.resolve('some-domain-with-dnslink-entry.com')
+ * ```
+ *
+ * @example Resolving a domain with a dnslink entry
+ *
+ * Calling `resolve` with the `@helia/dnslink` instance:
+ *
+ * ```TypeScript
+ * // resolve a CID from a TXT record in a DNS zone file, using the default
+ * // resolver for the current platform eg:
+ * // > dig _dnslink.ipfs.tech TXT
+ * // ;; ANSWER SECTION:
+ * // _dnslink.ipfs.tech. 60 IN CNAME _dnslink.ipfs-tech.on.fleek.co.
+ * // _dnslink.ipfs-tech.on.fleek.co. 120 IN TXT "dnslink=/ipfs/bafybe..."
+ *
+ * import { createHelia } from 'helia'
+ * import { dnsLink } from '@helia/dnslink'
+ *
+ * const node = await createHelia()
+ * const name = dnsLink(node)
+ *
+ * const { answer } = await name.resolve('blog.ipfs.tech')
+ *
+ * console.info(answer)
+ * // { data: '/ipfs/bafybe...' }
+ * ```
+ *
+ * @example Using DNS-Over-HTTPS
+ *
+ * This example uses the Mozilla provided RFC 1035 DNS over HTTPS service. This
+ * uses binary DNS records so requires extra dependencies to process the
+ * response which can increase browser bundle sizes.
+ *
+ * If this is a concern, use the DNS-JSON-Over-HTTPS resolver instead.
+ *
+ * ```TypeScript
+ * import { createHelia } from 'helia'
+ * import { dnsLink } from '@helia/dnslink'
+ * import { dns } from '@multiformats/dns'
+ * import { dnsOverHttps } from '@multiformats/dns/resolvers'
+ * import type { DefaultLibp2pServices } from 'helia'
+ * import type { Libp2p } from '@libp2p/interface'
+ *
+ * const node = await createHelia<Libp2p<DefaultLibp2pServices>>({
+ *   dns: dns({
+ *     resolvers: {
+ *       '.': dnsOverHttps('https://mozilla.cloudflare-dns.com/dns-query')
+ *     }
+ *   })
+ * })
+ * const name = dnsLink(node)
+ *
+ * const result = await name.resolve('blog.ipfs.tech')
+ * ```
+ *
+ * @example Using DNS-JSON-Over-HTTPS
+ *
+ * DNS-JSON-Over-HTTPS resolvers use the RFC 8427 `application/dns-json` and can
+ * result in a smaller browser bundle due to the response being plain JSON.
+ *
+ * ```TypeScript
+ * import { createHelia } from 'helia'
+ * import { dnsLink } from '@helia/dnslink'
+ * import { dns } from '@multiformats/dns'
+ * import { dnsJsonOverHttps } from '@multiformats/dns/resolvers'
+ * import type { DefaultLibp2pServices } from 'helia'
+ * import type { Libp2p } from '@libp2p/interface'
+ *
+ * const node = await createHelia<Libp2p<DefaultLibp2pServices>>({
+ *   dns: dns({
+ *     resolvers: {
+ *       '.': dnsJsonOverHttps('https://mozilla.cloudflare-dns.com/dns-query')
+ *     }
+ *   })
+ * })
+ * const name = dnsLink(node)
+ *
+ * const result = await name.resolve('blog.ipfs.tech')
+ * ```
+ */
+import type { AbortOptions, ComponentLogger, PeerId } from '@libp2p/interface';
+import type { Answer, DNS, ResolveDnsProgressEvents } from '@multiformats/dns';
+import type { CID } from 'multiformats/cid';
+import type { ProgressOptions } from 'progress-events';
+export interface ResolveDNSLinkOptions extends AbortOptions, ProgressOptions<ResolveDnsProgressEvents> {
+    /**
+     * Do not query the network for the IPNS record
+     *
+     * @default false
+     */
+    offline?: boolean;
+    /**
+     * Do not use cached DNS entries
+     *
+     * @default false
+     */
+    nocache?: boolean;
+    /**
+     * When resolving DNSLink records that resolve to other DNSLink records, limit
+     * how many times we will recursively resolve them.
+     *
+     * @default 32
+     */
+    maxRecursiveDepth?: number;
+}
+export interface DNSLinkIPFSResult {
+    /**
+     * The resolved record
+     */
+    answer: Answer;
+    /**
+     * The IPFS namespace
+     */
+    namespace: 'ipfs';
+    /**
+     * The resolved value
+     */
+    cid: CID;
+    /**
+     * If the resolved value is an IPFS path, it will be present here
+     */
+    path: string;
+}
+export interface DNSLinkIPNSResult {
+    /**
+     * The resolved record
+     */
+    answer: Answer;
+    /**
+     * The IPFS namespace
+     */
+    namespace: 'ipns';
+    /**
+     * The resolved value
+     */
+    peerId: PeerId;
+    /**
+     * If the resolved value is an IPFS path, it will be present here
+     */
+    path: string;
+}
+export interface DNSLinkOtherResult {
+    /**
+     * The resolved record
+     */
+    answer: Answer;
+    /**
+     * The IPFS namespace
+     */
+    namespace: string;
+}
+export type DNSLinkResult = DNSLinkIPFSResult | DNSLinkIPNSResult | DNSLinkOtherResult;
+export interface DNSLinkNamespace {
+    /**
+     * Return a result parsed from a DNSLink value
+     */
+    parse(value: string, answer: Answer): DNSLinkResult;
+}
+export interface DNSLink {
+    /**
+     * Resolve a CID from a dns-link style IPNS record
+     *
+     * @example
+     *
+     * ```TypeScript
+     * import { createHelia } from 'helia'
+     * import { dnsLink } from '@helia/dnslink'
+     *
+     * const helia = await createHelia()
+     * const name = dnsLink(helia)
+     *
+     * const result = await name.resolve('ipfs.io', {
+     *   signal: AbortSignal.timeout(5_000)
+     * })
+     *
+     * console.info(result) // { answer: ..., value: ... }
+     * ```
+     */
+    resolve(domain: string, options?: ResolveDNSLinkOptions): Promise<DNSLinkResult>;
+}
+export interface DNSLinkComponents {
+    dns: DNS;
+    logger: ComponentLogger;
+}
+export interface DNSLinkOptions {
+    /**
+     * By default `/ipfs/...`, `/ipns/...` and `/dnslink/...` record values are
+     * supported - to support other prefixes pass other value parsers here
+     */
+    namespaces?: Record<string, DNSLinkNamespace>;
+}
+export declare function dnsLink(components: DNSLinkComponents, options?: DNSLinkOptions): DNSLink;
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyGG;AAGH,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAC9E,OAAO,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAA;AAC9E,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEtD,MAAM,WAAW,qBAAsB,SAAQ,YAAY,EAAE,eAAe,CAAC,wBAAwB,CAAC;IACpG;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,GAAG,EAAE,GAAG,CAAA;IAER;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,MAAM,aAAa,GAAG,iBAAiB,GAAG,iBAAiB,GAAG,kBAAkB,CAAA;AAEtF,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,aAAa,CAAA;CACpD;AAED,MAAM,WAAW,OAAO;IACtB;;;;;;;;;;;;;;;;;;OAkBG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAA;CACjF;AAED,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,GAAG,CAAA;IACR,MAAM,EAAE,eAAe,CAAA;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;CAC9C;AAED,wBAAgB,OAAO,CAAE,UAAU,EAAE,iBAAiB,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAE7F"}

package/dist/src/index.js

@@ -0,0 +1,111 @@
+/**
+ * @packageDocumentation
+ *
+ * [DNSLink](https://dnslink.dev/) operations using a Helia node.
+ *
+ * @example Using custom DNS over HTTPS resolvers
+ *
+ * To use custom resolvers, configure Helia's `dns` option:
+ *
+ * ```TypeScript
+ * import { createHelia } from 'helia'
+ * import { dnsLink } from '@helia/dnslink'
+ * import { dns } from '@multiformats/dns'
+ * import { dnsOverHttps } from '@multiformats/dns/resolvers'
+ * import type { DefaultLibp2pServices } from 'helia'
+ * import type { Libp2p } from '@libp2p/interface'
+ *
+ * const node = await createHelia<Libp2p<DefaultLibp2pServices>>({
+ *   dns: dns({
+ *     resolvers: {
+ *       '.': dnsOverHttps('https://private-dns-server.me/dns-query')
+ *     }
+ *   })
+ * })
+ * const name = dnsLink(node)
+ *
+ * const result = name.resolve('some-domain-with-dnslink-entry.com')
+ * ```
+ *
+ * @example Resolving a domain with a dnslink entry
+ *
+ * Calling `resolve` with the `@helia/dnslink` instance:
+ *
+ * ```TypeScript
+ * // resolve a CID from a TXT record in a DNS zone file, using the default
+ * // resolver for the current platform eg:
+ * // > dig _dnslink.ipfs.tech TXT
+ * // ;; ANSWER SECTION:
+ * // _dnslink.ipfs.tech. 60 IN CNAME _dnslink.ipfs-tech.on.fleek.co.
+ * // _dnslink.ipfs-tech.on.fleek.co. 120 IN TXT "dnslink=/ipfs/bafybe..."
+ *
+ * import { createHelia } from 'helia'
+ * import { dnsLink } from '@helia/dnslink'
+ *
+ * const node = await createHelia()
+ * const name = dnsLink(node)
+ *
+ * const { answer } = await name.resolve('blog.ipfs.tech')
+ *
+ * console.info(answer)
+ * // { data: '/ipfs/bafybe...' }
+ * ```
+ *
+ * @example Using DNS-Over-HTTPS
+ *
+ * This example uses the Mozilla provided RFC 1035 DNS over HTTPS service. This
+ * uses binary DNS records so requires extra dependencies to process the
+ * response which can increase browser bundle sizes.
+ *
+ * If this is a concern, use the DNS-JSON-Over-HTTPS resolver instead.
+ *
+ * ```TypeScript
+ * import { createHelia } from 'helia'
+ * import { dnsLink } from '@helia/dnslink'
+ * import { dns } from '@multiformats/dns'
+ * import { dnsOverHttps } from '@multiformats/dns/resolvers'
+ * import type { DefaultLibp2pServices } from 'helia'
+ * import type { Libp2p } from '@libp2p/interface'
+ *
+ * const node = await createHelia<Libp2p<DefaultLibp2pServices>>({
+ *   dns: dns({
+ *     resolvers: {
+ *       '.': dnsOverHttps('https://mozilla.cloudflare-dns.com/dns-query')
+ *     }
+ *   })
+ * })
+ * const name = dnsLink(node)
+ *
+ * const result = await name.resolve('blog.ipfs.tech')
+ * ```
+ *
+ * @example Using DNS-JSON-Over-HTTPS
+ *
+ * DNS-JSON-Over-HTTPS resolvers use the RFC 8427 `application/dns-json` and can
+ * result in a smaller browser bundle due to the response being plain JSON.
+ *
+ * ```TypeScript
+ * import { createHelia } from 'helia'
+ * import { dnsLink } from '@helia/dnslink'
+ * import { dns } from '@multiformats/dns'
+ * import { dnsJsonOverHttps } from '@multiformats/dns/resolvers'
+ * import type { DefaultLibp2pServices } from 'helia'
+ * import type { Libp2p } from '@libp2p/interface'
+ *
+ * const node = await createHelia<Libp2p<DefaultLibp2pServices>>({
+ *   dns: dns({
+ *     resolvers: {
+ *       '.': dnsJsonOverHttps('https://mozilla.cloudflare-dns.com/dns-query')
+ *     }
+ *   })
+ * })
+ * const name = dnsLink(node)
+ *
+ * const result = await name.resolve('blog.ipfs.tech')
+ * ```
+ */
+import { DNSLink as DNSLinkClass } from './dnslink.js';
+export function dnsLink(components, options = {}) {
+    return new DNSLinkClass(components, options);
+}
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyGG;AAEH,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,cAAc,CAAA;AAmItD,MAAM,UAAU,OAAO,CAAE,UAA6B,EAAE,UAA0B,EAAE;IAClF,OAAO,IAAI,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;AAC9C,CAAC"}

package/dist/src/namespaces/ipfs.d.ts

@@ -0,0 +1,3 @@
+import type { DNSLinkNamespace } from '../index.js';
+export declare const ipfs: DNSLinkNamespace;
+//# sourceMappingURL=ipfs.d.ts.map

package/dist/src/namespaces/ipfs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipfs.d.ts","sourceRoot":"","sources":["../../../src/namespaces/ipfs.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAiB,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAGlE,eAAO,MAAM,IAAI,EAAE,gBAgBlB,CAAA"}

package/dist/src/namespaces/ipfs.js

@@ -0,0 +1,18 @@
+import { CID } from 'multiformats/cid';
+import { InvalidNamespaceError } from "../errors.js";
+export const ipfs = {
+    parse: (value, answer) => {
+        const [, protocol, cid, ...rest] = value.split('/');
+        if (protocol !== 'ipfs') {
+            throw new InvalidNamespaceError(`Namespace ${protocol} was not "ipfs"`);
+        }
+        // if the result is a CID, we've reached the end of the recursion
+        return {
+            namespace: 'ipfs',
+            cid: CID.parse(cid),
+            path: rest.length > 0 ? `/${rest.join('/')}` : '',
+            answer
+        };
+    }
+};
+//# sourceMappingURL=ipfs.js.map

package/dist/src/namespaces/ipfs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipfs.js","sourceRoot":"","sources":["../../../src/namespaces/ipfs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAIpD,MAAM,CAAC,MAAM,IAAI,GAAqB;IACpC,KAAK,EAAE,CAAC,KAAa,EAAE,MAAc,EAAiB,EAAE;QACtD,MAAM,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAEnD,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;YACxB,MAAM,IAAI,qBAAqB,CAAC,aAAa,QAAQ,iBAAiB,CAAC,CAAA;QACzE,CAAC;QAED,iEAAiE;QACjE,OAAO;YACL,SAAS,EAAE,MAAM;YACjB,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC;YACnB,IAAI,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;YACjD,MAAM;SACP,CAAA;IACH,CAAC;CACF,CAAA"}

package/dist/src/namespaces/ipns.d.ts

@@ -0,0 +1,3 @@
+import type { DNSLinkNamespace } from '../index.js';
+export declare const ipns: DNSLinkNamespace;
+//# sourceMappingURL=ipns.d.ts.map

package/dist/src/namespaces/ipns.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipns.d.ts","sourceRoot":"","sources":["../../../src/namespaces/ipns.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAiB,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAGlE,eAAO,MAAM,IAAI,EAAE,gBAgBlB,CAAA"}

package/dist/src/namespaces/ipns.js

@@ -0,0 +1,18 @@
+import { peerIdFromString } from '@libp2p/peer-id';
+import { InvalidNamespaceError } from "../errors.js";
+export const ipns = {
+    parse: (value, answer) => {
+        const [, protocol, peerId, ...rest] = value.split('/');
+        if (protocol !== 'ipns') {
+            throw new InvalidNamespaceError(`Namespace ${protocol} was not "ipns"`);
+        }
+        // if the result is a CID, we've reached the end of the recursion
+        return {
+            namespace: 'ipns',
+            peerId: peerIdFromString(peerId),
+            path: rest.length > 0 ? `/${rest.join('/')}` : '',
+            answer
+        };
+    }
+};
+//# sourceMappingURL=ipns.js.map

package/dist/src/namespaces/ipns.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipns.js","sourceRoot":"","sources":["../../../src/namespaces/ipns.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAIpD,MAAM,CAAC,MAAM,IAAI,GAAqB;IACpC,KAAK,EAAE,CAAC,KAAa,EAAE,MAAc,EAAiB,EAAE;QACtD,MAAM,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAEtD,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;YACxB,MAAM,IAAI,qBAAqB,CAAC,aAAa,QAAQ,iBAAiB,CAAC,CAAA;QACzE,CAAC;QAED,iEAAiE;QACjE,OAAO;YACL,SAAS,EAAE,MAAM;YACjB,MAAM,EAAE,gBAAgB,CAAC,MAAM,CAAC;YAChC,IAAI,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;YACjD,MAAM;SACP,CAAA;IACH,CAAC;CACF,CAAA"}

package/dist/typedoc-urls.json

@@ -0,0 +1,22 @@
+{
+  "DNSLink": "https://ipfs.github.io/helia/interfaces/DNSLink.html",
+  ".:DNSLink": "https://ipfs.github.io/helia/interfaces/DNSLink.html",
+  "DNSLinkComponents": "https://ipfs.github.io/helia/interfaces/DNSLinkComponents.html",
+  ".:DNSLinkComponents": "https://ipfs.github.io/helia/interfaces/DNSLinkComponents.html",
+  "DNSLinkIPFSResult": "https://ipfs.github.io/helia/interfaces/DNSLinkIPFSResult.html",
+  ".:DNSLinkIPFSResult": "https://ipfs.github.io/helia/interfaces/DNSLinkIPFSResult.html",
+  "DNSLinkIPNSResult": "https://ipfs.github.io/helia/interfaces/DNSLinkIPNSResult.html",
+  ".:DNSLinkIPNSResult": "https://ipfs.github.io/helia/interfaces/DNSLinkIPNSResult.html",
+  "DNSLinkNamespace": "https://ipfs.github.io/helia/interfaces/DNSLinkNamespace.html",
+  ".:DNSLinkNamespace": "https://ipfs.github.io/helia/interfaces/DNSLinkNamespace.html",
+  "DNSLinkOptions": "https://ipfs.github.io/helia/interfaces/DNSLinkOptions.html",
+  ".:DNSLinkOptions": "https://ipfs.github.io/helia/interfaces/DNSLinkOptions.html",
+  "DNSLinkOtherResult": "https://ipfs.github.io/helia/interfaces/DNSLinkOtherResult.html",
+  ".:DNSLinkOtherResult": "https://ipfs.github.io/helia/interfaces/DNSLinkOtherResult.html",
+  "ResolveDNSLinkOptions": "https://ipfs.github.io/helia/interfaces/ResolveDNSLinkOptions.html",
+  ".:ResolveDNSLinkOptions": "https://ipfs.github.io/helia/interfaces/ResolveDNSLinkOptions.html",
+  "DNSLinkResult": "https://ipfs.github.io/helia/types/DNSLinkResult.html",
+  ".:DNSLinkResult": "https://ipfs.github.io/helia/types/DNSLinkResult.html",
+  "dnsLink": "https://ipfs.github.io/helia/functions/dnsLink.html",
+  ".:dnsLink": "https://ipfs.github.io/helia/functions/dnsLink.html"
+}