@helia/ipns 4.0.0 → 5.0.0-e554493

package/src/routing/index.ts

@@ -1,4 +1,4 @@
-import type { Libp2pContentRoutingProgressEvents } from './libp2p.js'
+import type { HeliaRoutingProgressEvents } from './helia.js'
 import type { DatastoreProgressEvents } from './local-store.js'
 import type { PubSubProgressEvents } from './pubsub.js'
 import type { AbortOptions } from '@libp2p/interface'
@@ -9,7 +9,12 @@ export interface PutOptions extends AbortOptions, ProgressOptions {
 }
 
 export interface GetOptions extends AbortOptions, ProgressOptions {
-
+  /**
+   * Pass false to not perform validation actions
+   *
+   * @default true
+   */
+  validate?: boolean
 }
 
 export interface IPNSRouting {
@@ -19,8 +24,8 @@ export interface IPNSRouting {
 
 export type IPNSRoutingEvents =
   DatastoreProgressEvents |
-  Libp2pContentRoutingProgressEvents |
+  HeliaRoutingProgressEvents |
   PubSubProgressEvents
 
-export { libp2p } from './libp2p.js'
+export { helia } from './helia.js'
 export { pubsub } from './pubsub.js'

package/dist/src/routing/libp2p.d.ts

@@ -1,22 +0,0 @@
-import { type ProgressEvent } from 'progress-events';
-import type { GetOptions, PutOptions } from './index.js';
-import type { IPNSRouting } from '../index.js';
-import type { ContentRouting } from '@libp2p/interface';
-export interface Libp2pContentRoutingComponents {
-    libp2p: {
-        contentRouting: ContentRouting;
-    };
-}
-export type Libp2pContentRoutingProgressEvents = ProgressEvent<'ipns:routing:libp2p:error', Error>;
-export declare class Libp2pContentRouting implements IPNSRouting {
-    private readonly contentRouting;
-    constructor(components: Libp2pContentRoutingComponents);
-    put(routingKey: Uint8Array, marshaledRecord: Uint8Array, options?: PutOptions): Promise<void>;
-    get(routingKey: Uint8Array, options?: GetOptions): Promise<Uint8Array>;
-}
-/**
- * The libp2p routing uses any available Content Routers configured on the
- * passed libp2p node. This could be KadDHT, HTTP API Delegated Routing, etc.
- */
-export declare function libp2p(components: Libp2pContentRoutingComponents): IPNSRouting;
-//# sourceMappingURL=libp2p.d.ts.map

package/dist/src/routing/libp2p.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"libp2p.d.ts","sourceRoot":"","sources":["../../../src/routing/libp2p.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,KAAK,aAAa,EAAE,MAAM,iBAAiB,CAAA;AACzE,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAEvD,MAAM,WAAW,8BAA8B;IAC7C,MAAM,EAAE;QACN,cAAc,EAAE,cAAc,CAAA;KAC/B,CAAA;CACF;AAED,MAAM,MAAM,kCAAkC,GAC5C,aAAa,CAAC,2BAA2B,EAAE,KAAK,CAAC,CAAA;AAEnD,qBAAa,oBAAqB,YAAW,WAAW;IACtD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAgB;gBAElC,UAAU,EAAE,8BAA8B;IAIjD,GAAG,CAAE,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,UAAU,EAAE,OAAO,GAAE,UAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAQlG,GAAG,CAAE,UAAU,EAAE,UAAU,EAAE,OAAO,GAAE,UAAe,GAAG,OAAO,CAAC,UAAU,CAAC;CASlF;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAE,UAAU,EAAE,8BAA8B,GAAG,WAAW,CAE/E"}

package/dist/src/routing/libp2p.js

@@ -1,32 +0,0 @@
-import { CustomProgressEvent } from 'progress-events';
-export class Libp2pContentRouting {
-    contentRouting;
-    constructor(components) {
-        this.contentRouting = components.libp2p.contentRouting;
-    }
-    async put(routingKey, marshaledRecord, options = {}) {
-        try {
-            await this.contentRouting.put(routingKey, marshaledRecord, options);
-        }
-        catch (err) {
-            options.onProgress?.(new CustomProgressEvent('ipns:routing:libp2p:error', err));
-        }
-    }
-    async get(routingKey, options = {}) {
-        try {
-            return await this.contentRouting.get(routingKey, options);
-        }
-        catch (err) {
-            options.onProgress?.(new CustomProgressEvent('ipns:routing:libp2p:error', err));
-        }
-        throw new Error('Not found');
-    }
-}
-/**
- * The libp2p routing uses any available Content Routers configured on the
- * passed libp2p node. This could be KadDHT, HTTP API Delegated Routing, etc.
- */
-export function libp2p(components) {
-    return new Libp2pContentRouting(components);
-}
-//# sourceMappingURL=libp2p.js.map

package/dist/src/routing/libp2p.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"libp2p.js","sourceRoot":"","sources":["../../../src/routing/libp2p.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAsB,MAAM,iBAAiB,CAAA;AAczE,MAAM,OAAO,oBAAoB;IACd,cAAc,CAAgB;IAE/C,YAAa,UAA0C;QACrD,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,cAAc,CAAA;IACxD,CAAC;IAED,KAAK,CAAC,GAAG,CAAE,UAAsB,EAAE,eAA2B,EAAE,UAAsB,EAAE;QACtF,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,EAAE,eAAe,EAAE,OAAO,CAAC,CAAA;QACrE,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,OAAO,CAAC,UAAU,EAAE,CAAC,IAAI,mBAAmB,CAAQ,2BAA2B,EAAE,GAAG,CAAC,CAAC,CAAA;QACxF,CAAC;IACH,CAAC;IAED,KAAK,CAAC,GAAG,CAAE,UAAsB,EAAE,UAAsB,EAAE;QACzD,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;QAC3D,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,OAAO,CAAC,UAAU,EAAE,CAAC,IAAI,mBAAmB,CAAQ,2BAA2B,EAAE,GAAG,CAAC,CAAC,CAAA;QACxF,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,CAAA;IAC9B,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,UAAU,MAAM,CAAE,UAA0C;IAChE,OAAO,IAAI,oBAAoB,CAAC,UAAU,CAAC,CAAA;AAC7C,CAAC"}

package/dist/typedoc-urls.json

@@ -1,42 +0,0 @@
-{
-  "dnsJsonOverHttps": "https://ipfs.github.io/helia-ipns/functions/dns_resolvers.dnsJsonOverHttps.html",
-  "dnsOverHttps": "https://ipfs.github.io/helia-ipns/functions/dns_resolvers.dnsOverHttps.html",
-  "DNSResolver": "https://ipfs.github.io/helia-ipns/interfaces/index.DNSResolver.html",
-  ".:DNSResolver": "https://ipfs.github.io/helia-ipns/interfaces/index.DNSResolver.html",
-  "IPNS": "https://ipfs.github.io/helia-ipns/interfaces/index.IPNS.html",
-  ".:IPNS": "https://ipfs.github.io/helia-ipns/interfaces/index.IPNS.html",
-  "IPNSComponents": "https://ipfs.github.io/helia-ipns/interfaces/index.IPNSComponents.html",
-  ".:IPNSComponents": "https://ipfs.github.io/helia-ipns/interfaces/index.IPNSComponents.html",
-  "IPNSOptions": "https://ipfs.github.io/helia-ipns/interfaces/index.IPNSOptions.html",
-  ".:IPNSOptions": "https://ipfs.github.io/helia-ipns/interfaces/index.IPNSOptions.html",
-  "PublishOptions": "https://ipfs.github.io/helia-ipns/interfaces/index.PublishOptions.html",
-  ".:PublishOptions": "https://ipfs.github.io/helia-ipns/interfaces/index.PublishOptions.html",
-  "RepublishOptions": "https://ipfs.github.io/helia-ipns/interfaces/index.RepublishOptions.html",
-  ".:RepublishOptions": "https://ipfs.github.io/helia-ipns/interfaces/index.RepublishOptions.html",
-  "ResolveDNSOptions": "https://ipfs.github.io/helia-ipns/interfaces/index.ResolveDNSOptions.html",
-  ".:ResolveDNSOptions": "https://ipfs.github.io/helia-ipns/interfaces/index.ResolveDNSOptions.html",
-  "ResolveDnsLinkOptions": "https://ipfs.github.io/helia-ipns/interfaces/index.ResolveDnsLinkOptions.html",
-  ".:ResolveDnsLinkOptions": "https://ipfs.github.io/helia-ipns/interfaces/index.ResolveDnsLinkOptions.html",
-  "ResolveOptions": "https://ipfs.github.io/helia-ipns/interfaces/index.ResolveOptions.html",
-  ".:ResolveOptions": "https://ipfs.github.io/helia-ipns/interfaces/index.ResolveOptions.html",
-  "PublishProgressEvents": "https://ipfs.github.io/helia-ipns/types/index.PublishProgressEvents.html",
-  ".:PublishProgressEvents": "https://ipfs.github.io/helia-ipns/types/index.PublishProgressEvents.html",
-  "RepublishProgressEvents": "https://ipfs.github.io/helia-ipns/types/index.RepublishProgressEvents.html",
-  ".:RepublishProgressEvents": "https://ipfs.github.io/helia-ipns/types/index.RepublishProgressEvents.html",
-  "ResolveDnsLinkProgressEvents": "https://ipfs.github.io/helia-ipns/types/index.ResolveDnsLinkProgressEvents.html",
-  ".:ResolveDnsLinkProgressEvents": "https://ipfs.github.io/helia-ipns/types/index.ResolveDnsLinkProgressEvents.html",
-  "ResolveProgressEvents": "https://ipfs.github.io/helia-ipns/types/index.ResolveProgressEvents.html",
-  ".:ResolveProgressEvents": "https://ipfs.github.io/helia-ipns/types/index.ResolveProgressEvents.html",
-  "ipns": "https://ipfs.github.io/helia-ipns/functions/index.ipns-1.html",
-  ".:ipns": "https://ipfs.github.io/helia-ipns/functions/index.ipns-1.html",
-  "GetOptions": "https://ipfs.github.io/helia-ipns/interfaces/routing.GetOptions.html",
-  "./routing:GetOptions": "https://ipfs.github.io/helia-ipns/interfaces/routing.GetOptions.html",
-  "IPNSRouting": "https://ipfs.github.io/helia-ipns/interfaces/routing.IPNSRouting.html",
-  "./routing:IPNSRouting": "https://ipfs.github.io/helia-ipns/interfaces/routing.IPNSRouting.html",
-  "PutOptions": "https://ipfs.github.io/helia-ipns/interfaces/routing.PutOptions.html",
-  "./routing:PutOptions": "https://ipfs.github.io/helia-ipns/interfaces/routing.PutOptions.html",
-  "IPNSRoutingEvents": "https://ipfs.github.io/helia-ipns/types/routing.IPNSRoutingEvents.html",
-  "./routing:IPNSRoutingEvents": "https://ipfs.github.io/helia-ipns/types/routing.IPNSRoutingEvents.html",
-  "libp2p": "https://ipfs.github.io/helia-ipns/functions/routing.libp2p.html",
-  "pubsub": "https://ipfs.github.io/helia-ipns/functions/routing.pubsub.html"
-}

package/src/routing/libp2p.ts

@@ -1,47 +0,0 @@
-import { CustomProgressEvent, type ProgressEvent } from 'progress-events'
-import type { GetOptions, PutOptions } from './index.js'
-import type { IPNSRouting } from '../index.js'
-import type { ContentRouting } from '@libp2p/interface'
-
-export interface Libp2pContentRoutingComponents {
-  libp2p: {
-    contentRouting: ContentRouting
-  }
-}
-
-export type Libp2pContentRoutingProgressEvents =
-  ProgressEvent<'ipns:routing:libp2p:error', Error>
-
-export class Libp2pContentRouting implements IPNSRouting {
-  private readonly contentRouting: ContentRouting
-
-  constructor (components: Libp2pContentRoutingComponents) {
-    this.contentRouting = components.libp2p.contentRouting
-  }
-
-  async put (routingKey: Uint8Array, marshaledRecord: Uint8Array, options: PutOptions = {}): Promise<void> {
-    try {
-      await this.contentRouting.put(routingKey, marshaledRecord, options)
-    } catch (err: any) {
-      options.onProgress?.(new CustomProgressEvent<Error>('ipns:routing:libp2p:error', err))
-    }
-  }
-
-  async get (routingKey: Uint8Array, options: GetOptions = {}): Promise<Uint8Array> {
-    try {
-      return await this.contentRouting.get(routingKey, options)
-    } catch (err: any) {
-      options.onProgress?.(new CustomProgressEvent<Error>('ipns:routing:libp2p:error', err))
-    }
-
-    throw new Error('Not found')
-  }
-}
-
-/**
- * The libp2p routing uses any available Content Routers configured on the
- * passed libp2p node. This could be KadDHT, HTTP API Delegated Routing, etc.
- */
-export function libp2p (components: Libp2pContentRoutingComponents): IPNSRouting {
-  return new Libp2pContentRouting(components)
-}