@helia/dag-json 4.0.7 → 4.1.0-172345df

package/dist/src/dag-json.d.ts

@@ -0,0 +1,9 @@
+import { CID } from 'multiformats/cid';
+import type { AddOptions, DAGJSONComponents, DAGJSON as DAGJSONInterface, GetOptions } from './index.js';
+export declare class DAGJSON implements DAGJSONInterface {
+    private readonly components;
+    constructor(components: DAGJSONComponents);
+    add(obj: any, options?: AddOptions): Promise<CID>;
+    get<T>(cid: CID, options?: GetOptions): Promise<T>;
+}
+//# sourceMappingURL=dag-json.d.ts.map

package/dist/src/dag-json.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dag-json.d.ts","sourceRoot":"","sources":["../../src/dag-json.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAEtC,OAAO,KAAK,EAAE,UAAU,EAAE,iBAAiB,EAAE,OAAO,IAAI,gBAAgB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAExG,qBAAa,OAAQ,YAAW,gBAAgB;IAC9C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAmB;gBAEjC,UAAU,EAAE,iBAAiB;IAIpC,GAAG,CAAE,GAAG,EAAE,GAAG,EAAE,OAAO,GAAE,UAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IAUtD,GAAG,CAAE,CAAC,EAAG,GAAG,EAAE,GAAG,EAAE,OAAO,GAAE,UAAe,GAAG,OAAO,CAAC,CAAC,CAAC;CAS/D"}

package/dist/src/dag-json.js

@@ -0,0 +1,26 @@
+import { InvalidCodecError } from '@helia/interface';
+import * as codec from '@ipld/dag-json';
+import toBuffer from 'it-to-buffer';
+import { CID } from 'multiformats/cid';
+import { sha256 } from 'multiformats/hashes/sha2';
+export class DAGJSON {
+    components;
+    constructor(components) {
+        this.components = components;
+    }
+    async add(obj, options = {}) {
+        const buf = codec.encode(obj);
+        const hash = await (options.hasher ?? sha256).digest(buf);
+        const cid = CID.createV1(codec.code, hash);
+        await this.components.blockstore.put(cid, buf, options);
+        return cid;
+    }
+    async get(cid, options = {}) {
+        if (cid.code !== codec.code) {
+            throw new InvalidCodecError('The passed CID had an incorrect codec, it may correspond to a non-DAG-JSON block');
+        }
+        const buf = await toBuffer(this.components.blockstore.get(cid, options));
+        return codec.decode(buf);
+    }
+}
+//# sourceMappingURL=dag-json.js.map

package/dist/src/dag-json.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dag-json.js","sourceRoot":"","sources":["../../src/dag-json.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AACpD,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AACvC,OAAO,QAAQ,MAAM,cAAc,CAAA;AACnC,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAA;AAGjD,MAAM,OAAO,OAAO;IACD,UAAU,CAAmB;IAE9C,YAAa,UAA6B;QACxC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;IAC9B,CAAC;IAED,KAAK,CAAC,GAAG,CAAE,GAAQ,EAAE,UAAsB,EAAE;QAC3C,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAC7B,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACzD,MAAM,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAE1C,MAAM,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;QAEvD,OAAO,GAAG,CAAA;IACZ,CAAC;IAED,KAAK,CAAC,GAAG,CAAM,GAAQ,EAAE,UAAsB,EAAE;QAC/C,IAAI,GAAG,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,EAAE,CAAC;YAC5B,MAAM,IAAI,iBAAiB,CAAC,kFAAkF,CAAC,CAAA;QACjH,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAA;QAExE,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IAC1B,CAAC;CACF"}

package/dist/src/index.d.ts

@@ -24,21 +24,19 @@
  * // { hello: 'world' }
  * ```
  */
-import { CID } from 'multiformats/cid';
-import type { GetBlockProgressEvents, PutBlockProgressEvents } from '@helia/interface/blocks';
+import type { GetBlockProgressEvents, ProviderOptions, PutBlockProgressEvents } from '@helia/interface/blocks';
 import type { AbortOptions } from '@libp2p/interface';
 import type { Blockstore } from 'interface-blockstore';
-import type { BlockCodec } from 'multiformats/codecs/interface';
+import type { CID } from 'multiformats/cid';
 import type { MultihashHasher } from 'multiformats/hashes/interface';
 import type { ProgressOptions } from 'progress-events';
 export interface DAGJSONComponents {
     blockstore: Blockstore;
 }
 export interface AddOptions extends AbortOptions, ProgressOptions<PutBlockProgressEvents> {
-    hasher: MultihashHasher;
+    hasher?: MultihashHasher;
 }
-export interface GetOptions extends AbortOptions, ProgressOptions<GetBlockProgressEvents> {
-    codec: BlockCodec<any, unknown>;
+export interface GetOptions extends AbortOptions, ProgressOptions<GetBlockProgressEvents>, ProviderOptions {
 }
 /**
  * The JSON interface provides a simple and intuitive way to add/get objects

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAGH,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAEtC,OAAO,KAAK,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAA;AAC7F,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAA;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AACpE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEtD,MAAM,WAAW,iBAAiB;IAChC,UAAU,EAAE,UAAU,CAAA;CACvB;AAED,MAAM,WAAW,UAAW,SAAQ,YAAY,EAAE,eAAe,CAAC,sBAAsB,CAAC;IACvF,MAAM,EAAE,eAAe,CAAA;CACxB;AAED,MAAM,WAAW,UAAW,SAAQ,YAAY,EAAE,eAAe,CAAC,sBAAsB,CAAC;IACvF,KAAK,EAAE,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB;;;;;;;;;;;;;;;;;;OAkBG;IACH,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IAE9D;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;CAC5D;AA0BD;;GAEG;AACH,wBAAgB,OAAO,CAAE,KAAK,EAAE;IAAE,UAAU,EAAE,UAAU,CAAA;CAAE,GAAG,OAAO,CAEnE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAGH,OAAO,KAAK,EAAE,sBAAsB,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAA;AAC9G,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AACpE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEtD,MAAM,WAAW,iBAAiB;IAChC,UAAU,EAAE,UAAU,CAAA;CACvB;AAED,MAAM,WAAW,UAAW,SAAQ,YAAY,EAAE,eAAe,CAAC,sBAAsB,CAAC;IACvF,MAAM,CAAC,EAAE,eAAe,CAAA;CACzB;AAED,MAAM,WAAW,UAAW,SAAQ,YAAY,EAAE,eAAe,CAAC,sBAAsB,CAAC,EAAE,eAAe;CAEzG;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB;;;;;;;;;;;;;;;;;;OAkBG;IACH,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IAE9D;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;CAC5D;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAE,KAAK,EAAE;IAAE,UAAU,EAAE,UAAU,CAAA;CAAE,GAAG,OAAO,CAEnE"}

package/dist/src/index.js

@@ -24,30 +24,11 @@
  * // { hello: 'world' }
  * ```
  */
-import * as codec from '@ipld/dag-json';
-import { CID } from 'multiformats/cid';
-import { sha256 } from 'multiformats/hashes/sha2';
-class DefaultDAGJSON {
-    components;
-    constructor(components) {
-        this.components = components;
-    }
-    async add(obj, options = {}) {
-        const buf = codec.encode(obj);
-        const hash = await (options.hasher ?? sha256).digest(buf);
-        const cid = CID.createV1(codec.code, hash);
-        await this.components.blockstore.put(cid, buf, options);
-        return cid;
-    }
-    async get(cid, options = {}) {
-        const buf = await this.components.blockstore.get(cid, options);
-        return codec.decode(buf);
-    }
-}
+import { DAGJSON as DAGJSONClass } from "./dag-json.js";
 /**
  * Create a {@link DAGJSON} instance for use with {@link https://github.com/ipfs/helia Helia}
  */
 export function dagJson(helia) {
-    return new DefaultDAGJSON(helia);
+    return new DAGJSONClass(helia);
 }
 //# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AACvC,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAA;AAsEjD,MAAM,cAAc;IACD,UAAU,CAAmB;IAE9C,YAAa,UAA6B;QACxC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;IAC9B,CAAC;IAED,KAAK,CAAC,GAAG,CAAE,GAAQ,EAAE,UAA+B,EAAE;QACpD,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAC7B,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACzD,MAAM,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAE1C,MAAM,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;QAEvD,OAAO,GAAG,CAAA;IACZ,CAAC;IAED,KAAK,CAAC,GAAG,CAAM,GAAQ,EAAE,UAA+B,EAAE;QACxD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAE9D,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IAC1B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,UAAU,OAAO,CAAE,KAAiC;IACxD,OAAO,IAAI,cAAc,CAAC,KAAK,CAAC,CAAA;AAClC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,eAAe,CAAA;AAsEvD;;GAEG;AACH,MAAM,UAAU,OAAO,CAAE,KAAiC;IACxD,OAAO,IAAI,YAAY,CAAC,KAAK,CAAC,CAAA;AAChC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helia/dag-json",
-  "version": "4.0.7",
+  "version": "4.1.0-172345df",
   "description": "Add/get IPLD blocks containing dag-json with your Helia node",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/ipfs/helia/tree/main/packages/dag-json#readme",
@@ -32,13 +32,6 @@
       "import": "./dist/src/index.js"
     }
   },
-  "eslintConfig": {
-    "extends": "ipfs",
-    "parserOptions": {
-      "project": true,
-      "sourceType": "module"
-    }
-  },
   "scripts": {
     "clean": "aegir clean",
     "lint": "aegir lint",
@@ -54,16 +47,17 @@
     "test:electron-main": "aegir test -t electron-main"
   },
   "dependencies": {
-    "@helia/interface": "^5.4.0",
-    "@ipld/dag-json": "^10.2.3",
-    "@libp2p/interface": "^2.2.1",
-    "interface-blockstore": "^5.3.1",
-    "multiformats": "^13.3.1",
+    "@helia/interface": "5.4.0-172345df",
+    "@ipld/dag-json": "^10.2.5",
+    "@libp2p/interface": "^3.0.2",
+    "interface-blockstore": "^6.0.1",
+    "it-to-buffer": "^4.0.10",
+    "multiformats": "^13.4.1",
     "progress-events": "^1.0.1"
   },
   "devDependencies": {
-    "aegir": "^47.0.7",
-    "blockstore-core": "^5.0.2"
+    "aegir": "^47.0.22",
+    "blockstore-core": "^6.0.2"
   },
   "sideEffects": false
 }

package/src/dag-json.ts

@@ -0,0 +1,34 @@
+import { InvalidCodecError } from '@helia/interface'
+import * as codec from '@ipld/dag-json'
+import toBuffer from 'it-to-buffer'
+import { CID } from 'multiformats/cid'
+import { sha256 } from 'multiformats/hashes/sha2'
+import type { AddOptions, DAGJSONComponents, DAGJSON as DAGJSONInterface, GetOptions } from './index.js'
+
+export class DAGJSON implements DAGJSONInterface {
+  private readonly components: DAGJSONComponents
+
+  constructor (components: DAGJSONComponents) {
+    this.components = components
+  }
+
+  async add (obj: any, options: AddOptions = {}): Promise<CID> {
+    const buf = codec.encode(obj)
+    const hash = await (options.hasher ?? sha256).digest(buf)
+    const cid = CID.createV1(codec.code, hash)
+
+    await this.components.blockstore.put(cid, buf, options)
+
+    return cid
+  }
+
+  async get <T> (cid: CID, options: GetOptions = {}): Promise<T> {
+    if (cid.code !== codec.code) {
+      throw new InvalidCodecError('The passed CID had an incorrect codec, it may correspond to a non-DAG-JSON block')
+    }
+
+    const buf = await toBuffer(this.components.blockstore.get(cid, options))
+
+    return codec.decode(buf)
+  }
+}

package/src/index.ts

@@ -25,13 +25,11 @@
  * ```
  */
 
-import * as codec from '@ipld/dag-json'
-import { CID } from 'multiformats/cid'
-import { sha256 } from 'multiformats/hashes/sha2'
-import type { GetBlockProgressEvents, PutBlockProgressEvents } from '@helia/interface/blocks'
+import { DAGJSON as DAGJSONClass } from './dag-json.ts'
+import type { GetBlockProgressEvents, ProviderOptions, PutBlockProgressEvents } from '@helia/interface/blocks'
 import type { AbortOptions } from '@libp2p/interface'
 import type { Blockstore } from 'interface-blockstore'
-import type { BlockCodec } from 'multiformats/codecs/interface'
+import type { CID } from 'multiformats/cid'
 import type { MultihashHasher } from 'multiformats/hashes/interface'
 import type { ProgressOptions } from 'progress-events'
 
@@ -40,11 +38,11 @@ export interface DAGJSONComponents {
 }
 
 export interface AddOptions extends AbortOptions, ProgressOptions<PutBlockProgressEvents> {
-  hasher: MultihashHasher
+  hasher?: MultihashHasher
 }
 
-export interface GetOptions extends AbortOptions, ProgressOptions<GetBlockProgressEvents> {
-  codec: BlockCodec<any, unknown>
+export interface GetOptions extends AbortOptions, ProgressOptions<GetBlockProgressEvents>, ProviderOptions {
+
 }
 
 /**
@@ -97,33 +95,9 @@ export interface DAGJSON {
   get<T>(cid: CID, options?: Partial<GetOptions>): Promise<T>
 }
 
-class DefaultDAGJSON implements DAGJSON {
-  private readonly components: DAGJSONComponents
-
-  constructor (components: DAGJSONComponents) {
-    this.components = components
-  }
-
-  async add (obj: any, options: Partial<AddOptions> = {}): Promise<CID> {
-    const buf = codec.encode(obj)
-    const hash = await (options.hasher ?? sha256).digest(buf)
-    const cid = CID.createV1(codec.code, hash)
-
-    await this.components.blockstore.put(cid, buf, options)
-
-    return cid
-  }
-
-  async get <T> (cid: CID, options: Partial<GetOptions> = {}): Promise<T> {
-    const buf = await this.components.blockstore.get(cid, options)
-
-    return codec.decode(buf)
-  }
-}
-
 /**
  * Create a {@link DAGJSON} instance for use with {@link https://github.com/ipfs/helia Helia}
  */
 export function dagJson (helia: { blockstore: Blockstore }): DAGJSON {
-  return new DefaultDAGJSON(helia)
+  return new DAGJSONClass(helia)
 }

package/dist/typedoc-urls.json

@@ -1,12 +0,0 @@
-{
-  "AddOptions": "https://ipfs.github.io/helia/interfaces/_helia_dag-json.AddOptions.html",
-  ".:AddOptions": "https://ipfs.github.io/helia/interfaces/_helia_dag-json.AddOptions.html",
-  "DAGJSON": "https://ipfs.github.io/helia/interfaces/_helia_dag-json.DAGJSON.html",
-  ".:DAGJSON": "https://ipfs.github.io/helia/interfaces/_helia_dag-json.DAGJSON.html",
-  "DAGJSONComponents": "https://ipfs.github.io/helia/interfaces/_helia_dag-json.DAGJSONComponents.html",
-  ".:DAGJSONComponents": "https://ipfs.github.io/helia/interfaces/_helia_dag-json.DAGJSONComponents.html",
-  "GetOptions": "https://ipfs.github.io/helia/interfaces/_helia_dag-json.GetOptions.html",
-  ".:GetOptions": "https://ipfs.github.io/helia/interfaces/_helia_dag-json.GetOptions.html",
-  "dagJson": "https://ipfs.github.io/helia/functions/_helia_dag-json.dagJson.html",
-  ".:dagJson": "https://ipfs.github.io/helia/functions/_helia_dag-json.dagJson.html"
-}