@helia/dag-json 4.1.0-93aa4645 → 4.1.0-e502d45f

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,9 @@
1
+ import { CID } from 'multiformats/cid';
2
+ import type { AddOptions, DAGJSONComponents, DAGJSON as DAGJSONInterface, GetOptions } from './index.js';
3
+ export declare class DAGJSON implements DAGJSONInterface {
4
+ private readonly components;
5
+ constructor(components: DAGJSONComponents);
6
+ add(obj: any, options?: AddOptions): Promise<CID>;
7
+ get<T>(cid: CID, options?: GetOptions): Promise<T>;
8
+ }
9
+ //# sourceMappingURL=dag-json.d.ts.map
@@ -0,0 +1 @@
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"}
@@ -0,0 +1,26 @@
1
+ import { InvalidCodecError } from '@helia/interface';
2
+ import * as codec from '@ipld/dag-json';
3
+ import toBuffer from 'it-to-buffer';
4
+ import { CID } from 'multiformats/cid';
5
+ import { sha256 } from 'multiformats/hashes/sha2';
6
+ export class DAGJSON {
7
+ components;
8
+ constructor(components) {
9
+ this.components = components;
10
+ }
11
+ async add(obj, options = {}) {
12
+ const buf = codec.encode(obj);
13
+ const hash = await (options.hasher ?? sha256).digest(buf);
14
+ const cid = CID.createV1(codec.code, hash);
15
+ await this.components.blockstore.put(cid, buf, options);
16
+ return cid;
17
+ }
18
+ async get(cid, options = {}) {
19
+ if (cid.code !== codec.code) {
20
+ throw new InvalidCodecError('The passed CID had an incorrect codec, it may correspond to a non-DAG-JSON block');
21
+ }
22
+ const buf = await toBuffer(this.components.blockstore.get(cid, options));
23
+ return codec.decode(buf);
24
+ }
25
+ }
26
+ //# sourceMappingURL=dag-json.js.map
@@ -0,0 +1 @@
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"}
@@ -24,10 +24,10 @@
24
24
  * // { hello: 'world' }
25
25
  * ```
26
26
  */
27
- import { CID } from 'multiformats/cid';
28
27
  import type { GetBlockProgressEvents, ProviderOptions, PutBlockProgressEvents } from '@helia/interface/blocks';
29
28
  import type { AbortOptions } from '@libp2p/interface';
30
29
  import type { Blockstore } from 'interface-blockstore';
30
+ import type { CID } from 'multiformats/cid';
31
31
  import type { MultihashHasher } from 'multiformats/hashes/interface';
32
32
  import type { ProgressOptions } from 'progress-events';
33
33
  export interface DAGJSONComponents {
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAKH,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAEtC,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,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;AA8BD;;GAEG;AACH,wBAAgB,OAAO,CAAE,KAAK,EAAE;IAAE,UAAU,EAAE,UAAU,CAAA;CAAE,GAAG,OAAO,CAEnE"}
1
+ {"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 CHANGED
@@ -24,35 +24,11 @@
24
24
  * // { hello: 'world' }
25
25
  * ```
26
26
  */
27
- import { InvalidCodecError } from '@helia/interface';
28
- import * as codec from '@ipld/dag-json';
29
- import toBuffer from 'it-to-buffer';
30
- import { CID } from 'multiformats/cid';
31
- import { sha256 } from 'multiformats/hashes/sha2';
32
- class DefaultDAGJSON {
33
- components;
34
- constructor(components) {
35
- this.components = components;
36
- }
37
- async add(obj, options = {}) {
38
- const buf = codec.encode(obj);
39
- const hash = await (options.hasher ?? sha256).digest(buf);
40
- const cid = CID.createV1(codec.code, hash);
41
- await this.components.blockstore.put(cid, buf, options);
42
- return cid;
43
- }
44
- async get(cid, options = {}) {
45
- if (cid.code !== codec.code) {
46
- throw new InvalidCodecError('The passed CID had an incorrect codec, it may correspond to a non-DAG-JSON block');
47
- }
48
- const buf = await toBuffer(this.components.blockstore.get(cid, options));
49
- return codec.decode(buf);
50
- }
51
- }
27
+ import { DAGJSON as DAGJSONClass } from "./dag-json.js";
52
28
  /**
53
29
  * Create a {@link DAGJSON} instance for use with {@link https://github.com/ipfs/helia Helia}
54
30
  */
55
31
  export function dagJson(helia) {
56
- return new DefaultDAGJSON(helia);
32
+ return new DAGJSONClass(helia);
57
33
  }
58
34
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,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;AAqEjD,MAAM,cAAc;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;AAED;;GAEG;AACH,MAAM,UAAU,OAAO,CAAE,KAAiC;IACxD,OAAO,IAAI,cAAc,CAAC,KAAK,CAAC,CAAA;AAClC,CAAC"}
1
+ {"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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@helia/dag-json",
3
- "version": "4.1.0-93aa4645",
3
+ "version": "4.1.0-e502d45f",
4
4
  "description": "Add/get IPLD blocks containing dag-json with your Helia node",
5
5
  "license": "Apache-2.0 OR MIT",
6
6
  "homepage": "https://github.com/ipfs/helia/tree/main/packages/dag-json#readme",
@@ -47,7 +47,7 @@
47
47
  "test:electron-main": "aegir test -t electron-main"
48
48
  },
49
49
  "dependencies": {
50
- "@helia/interface": "5.4.0-93aa4645",
50
+ "@helia/interface": "5.4.0-e502d45f",
51
51
  "@ipld/dag-json": "^10.2.5",
52
52
  "@libp2p/interface": "^3.0.2",
53
53
  "interface-blockstore": "^6.0.1",
@@ -0,0 +1,34 @@
1
+ import { InvalidCodecError } from '@helia/interface'
2
+ import * as codec from '@ipld/dag-json'
3
+ import toBuffer from 'it-to-buffer'
4
+ import { CID } from 'multiformats/cid'
5
+ import { sha256 } from 'multiformats/hashes/sha2'
6
+ import type { AddOptions, DAGJSONComponents, DAGJSON as DAGJSONInterface, GetOptions } from './index.js'
7
+
8
+ export class DAGJSON implements DAGJSONInterface {
9
+ private readonly components: DAGJSONComponents
10
+
11
+ constructor (components: DAGJSONComponents) {
12
+ this.components = components
13
+ }
14
+
15
+ async add (obj: any, options: AddOptions = {}): Promise<CID> {
16
+ const buf = codec.encode(obj)
17
+ const hash = await (options.hasher ?? sha256).digest(buf)
18
+ const cid = CID.createV1(codec.code, hash)
19
+
20
+ await this.components.blockstore.put(cid, buf, options)
21
+
22
+ return cid
23
+ }
24
+
25
+ async get <T> (cid: CID, options: GetOptions = {}): Promise<T> {
26
+ if (cid.code !== codec.code) {
27
+ throw new InvalidCodecError('The passed CID had an incorrect codec, it may correspond to a non-DAG-JSON block')
28
+ }
29
+
30
+ const buf = await toBuffer(this.components.blockstore.get(cid, options))
31
+
32
+ return codec.decode(buf)
33
+ }
34
+ }
package/src/index.ts CHANGED
@@ -25,14 +25,11 @@
25
25
  * ```
26
26
  */
27
27
 
28
- import { InvalidCodecError } from '@helia/interface'
29
- import * as codec from '@ipld/dag-json'
30
- import toBuffer from 'it-to-buffer'
31
- import { CID } from 'multiformats/cid'
32
- import { sha256 } from 'multiformats/hashes/sha2'
28
+ import { DAGJSON as DAGJSONClass } from './dag-json.ts'
33
29
  import type { GetBlockProgressEvents, ProviderOptions, PutBlockProgressEvents } from '@helia/interface/blocks'
34
30
  import type { AbortOptions } from '@libp2p/interface'
35
31
  import type { Blockstore } from 'interface-blockstore'
32
+ import type { CID } from 'multiformats/cid'
36
33
  import type { MultihashHasher } from 'multiformats/hashes/interface'
37
34
  import type { ProgressOptions } from 'progress-events'
38
35
 
@@ -98,37 +95,9 @@ export interface DAGJSON {
98
95
  get<T>(cid: CID, options?: Partial<GetOptions>): Promise<T>
99
96
  }
100
97
 
101
- class DefaultDAGJSON implements DAGJSON {
102
- private readonly components: DAGJSONComponents
103
-
104
- constructor (components: DAGJSONComponents) {
105
- this.components = components
106
- }
107
-
108
- async add (obj: any, options: AddOptions = {}): Promise<CID> {
109
- const buf = codec.encode(obj)
110
- const hash = await (options.hasher ?? sha256).digest(buf)
111
- const cid = CID.createV1(codec.code, hash)
112
-
113
- await this.components.blockstore.put(cid, buf, options)
114
-
115
- return cid
116
- }
117
-
118
- async get <T> (cid: CID, options: GetOptions = {}): Promise<T> {
119
- if (cid.code !== codec.code) {
120
- throw new InvalidCodecError('The passed CID had an incorrect codec, it may correspond to a non-DAG-JSON block')
121
- }
122
-
123
- const buf = await toBuffer(this.components.blockstore.get(cid, options))
124
-
125
- return codec.decode(buf)
126
- }
127
- }
128
-
129
98
  /**
130
99
  * Create a {@link DAGJSON} instance for use with {@link https://github.com/ipfs/helia Helia}
131
100
  */
132
101
  export function dagJson (helia: { blockstore: Blockstore }): DAGJSON {
133
- return new DefaultDAGJSON(helia)
102
+ return new DAGJSONClass(helia)
134
103
  }