@helia/interface 1.2.0 → 1.2.2

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.
Files changed (5) hide show
  1. package/dist/src/pins.d.ts +3 -2
  2. package/dist/src/pins.d.ts.map +1 -1
  3. package/package.json +2 -6
  4. package/src/pins.ts +3 -2
  5. package/dist/typedoc-urls.json +0 -22
package/dist/src/pins.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ import type { GetBlockProgressEvents } from './blocks';
1
2
  import type { AbortOptions } from '@libp2p/interfaces';
2
3
  import type { CID } from 'multiformats/cid';
3
4
  import type { ProgressEvent, ProgressOptions } from 'progress-events';
@@ -7,8 +8,8 @@ export interface Pin {
7
8
  depth: number;
8
9
  metadata: Record<string, any>;
9
10
  }
10
- export type AddPinEvents = ProgressEvent<'helia:pin:add', unknown>;
11
- export interface AddOptions extends AbortOptions, ProgressOptions<AddPinEvents> {
11
+ export type AddPinEvents = ProgressEvent<'helia:pin:add', CID>;
12
+ export interface AddOptions extends AbortOptions, ProgressOptions<AddPinEvents | GetBlockProgressEvents> {
12
13
  /**
13
14
  * How deeply to pin the DAG, defaults to Infinity
14
15
  */
package/dist/src/pins.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"pins.d.ts","sourceRoot":"","sources":["../../src/pins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE,MAAM,MAAM,OAAO,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAA;AAEzD,MAAM,WAAW,GAAG;IAClB,GAAG,EAAE,GAAG,CAAA;IACR,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B;AAED,MAAM,MAAM,YAAY,GACtB,aAAa,CAAC,eAAe,EAAE,OAAO,CAAC,CAAA;AAEzC,MAAM,WAAW,UAAW,SAAQ,YAAY,EAAE,eAAe,CAAC,YAAY,CAAC;IAC7E;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;CACrD;AAED,MAAM,WAAW,SAAU,SAAQ,YAAY;CAE9C;AAED,MAAM,WAAW,SAAU,SAAQ,YAAY;IAC7C,GAAG,CAAC,EAAE,GAAG,CAAA;CACV;AAED,MAAM,WAAW,eAAgB,SAAQ,YAAY;CAEpD;AAED,MAAM,WAAW,IAAI;IACnB;;;OAGG;IACH,GAAG,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,UAAU,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;IAErD;;;OAGG;IACH,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,SAAS,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;IAEnD;;OAEG;IACH,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,SAAS,KAAK,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;IAEjE;;OAEG;IACH,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,eAAe,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;CACpE"}
1
+ {"version":3,"file":"pins.d.ts","sourceRoot":"","sources":["../../src/pins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE,MAAM,MAAM,OAAO,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAA;AAEzD,MAAM,WAAW,GAAG;IAClB,GAAG,EAAE,GAAG,CAAA;IACR,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B;AAED,MAAM,MAAM,YAAY,GACtB,aAAa,CAAC,eAAe,EAAE,GAAG,CAAC,CAAA;AAErC,MAAM,WAAW,UAAW,SAAQ,YAAY,EAAE,eAAe,CAAC,YAAY,GAAG,sBAAsB,CAAC;IACtG;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;CACrD;AAED,MAAM,WAAW,SAAU,SAAQ,YAAY;CAE9C;AAED,MAAM,WAAW,SAAU,SAAQ,YAAY;IAC7C,GAAG,CAAC,EAAE,GAAG,CAAA;CACV;AAED,MAAM,WAAW,eAAgB,SAAQ,YAAY;CAEpD;AAED,MAAM,WAAW,IAAI;IACnB;;;OAGG;IACH,GAAG,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,UAAU,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;IAErD;;;OAGG;IACH,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,SAAS,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;IAEnD;;OAEG;IACH,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,SAAS,KAAK,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;IAEjE;;OAEG;IACH,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,eAAe,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;CACpE"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@helia/interface",
3
- "version": "1.2.0",
3
+ "version": "1.2.2",
4
4
  "description": "The Helia API",
5
5
  "license": "Apache-2.0 OR MIT",
6
6
  "homepage": "https://github.com/ipfs/helia/tree/master/packages/interface#readme",
@@ -14,10 +14,6 @@
14
14
  "keywords": [
15
15
  "IPFS"
16
16
  ],
17
- "engines": {
18
- "node": ">=16.0.0",
19
- "npm": ">=7.0.0"
20
- },
21
17
  "type": "module",
22
18
  "types": "./dist/src/index.d.ts",
23
19
  "typesVersions": {
@@ -165,7 +161,7 @@
165
161
  "progress-events": "^1.0.0"
166
162
  },
167
163
  "devDependencies": {
168
- "aegir": "^39.0.4"
164
+ "aegir": "^40.0.8"
169
165
  },
170
166
  "typedoc": {
171
167
  "entryPoint": "./src/index.ts"
package/src/pins.ts CHANGED
@@ -1,3 +1,4 @@
1
+ import type { GetBlockProgressEvents } from './blocks'
1
2
  import type { AbortOptions } from '@libp2p/interfaces'
2
3
  import type { CID } from 'multiformats/cid'
3
4
  import type { ProgressEvent, ProgressOptions } from 'progress-events'
@@ -11,9 +12,9 @@ export interface Pin {
11
12
  }
12
13
 
13
14
  export type AddPinEvents =
14
- ProgressEvent<'helia:pin:add', unknown>
15
+ ProgressEvent<'helia:pin:add', CID>
15
16
 
16
- export interface AddOptions extends AbortOptions, ProgressOptions<AddPinEvents> {
17
+ export interface AddOptions extends AbortOptions, ProgressOptions<AddPinEvents | GetBlockProgressEvents> {
17
18
  /**
18
19
  * How deeply to pin the DAG, defaults to Infinity
19
20
  */
package/dist/typedoc-urls.json DELETED
@@ -1,22 +0,0 @@
1
- {
2
- "AddOptions": "https://ipfs.github.io/helia/interfaces/_helia_interface._internal_.AddOptions.html",
3
- "Blocks": "https://ipfs.github.io/helia/interfaces/_helia_interface._internal_.Blocks.html",
4
- "GetOfflineOptions": "https://ipfs.github.io/helia/interfaces/_helia_interface._internal_.GetOfflineOptions.html",
5
- "IsPinnedOptions": "https://ipfs.github.io/helia/interfaces/_helia_interface._internal_.IsPinnedOptions.html",
6
- "LsOptions": "https://ipfs.github.io/helia/interfaces/_helia_interface._internal_.LsOptions.html",
7
- "Pin": "https://ipfs.github.io/helia/interfaces/_helia_interface._internal_.Pin.html",
8
- "Pins": "https://ipfs.github.io/helia/interfaces/_helia_interface._internal_.Pins.html",
9
- "RmOptions": "https://ipfs.github.io/helia/interfaces/_helia_interface._internal_.RmOptions.html",
10
- "AddPinEvents": "https://ipfs.github.io/helia/types/_helia_interface._internal_.AddPinEvents.html",
11
- "DeleteBlockProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface._internal_.DeleteBlockProgressEvents.html",
12
- "DeleteManyBlocksProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface._internal_.DeleteManyBlocksProgressEvents.html",
13
- "GetAllBlocksProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface._internal_.GetAllBlocksProgressEvents.html",
14
- "GetBlockProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface._internal_.GetBlockProgressEvents.html",
15
- "GetManyBlocksProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface._internal_.GetManyBlocksProgressEvents.html",
16
- "HasBlockProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface._internal_.HasBlockProgressEvents.html",
17
- "PutBlockProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface._internal_.PutBlockProgressEvents.html",
18
- "PutManyBlocksProgressEvents": "https://ipfs.github.io/helia/types/_helia_interface._internal_.PutManyBlocksProgressEvents.html",
19
- "GCOptions": "https://ipfs.github.io/helia/interfaces/_helia_interface.GCOptions.html",
20
- "Helia": "https://ipfs.github.io/helia/interfaces/_helia_interface.Helia.html",
21
- "GcEvents": "https://ipfs.github.io/helia/types/_helia_interface.GcEvents.html"
22
- }