diff --git a/.github/workflows/automerge.yml b/.github/workflows/automerge.yml index 3833fc2..d57c2a0 100644 --- a/.github/workflows/automerge.yml +++ b/.github/workflows/automerge.yml @@ -1,6 +1,3 @@ -# File managed by web3-bot. DO NOT EDIT. -# See https://github.com/protocol/.github/ for details. - name: Automerge on: [ pull_request ] diff --git a/.github/workflows/js-test-and-release.yml b/.github/workflows/js-test-and-release.yml index 614a1d8..a15c379 100644 --- a/.github/workflows/js-test-and-release.yml +++ b/.github/workflows/js-test-and-release.yml @@ -1,6 +1,3 @@ -# File managed by web3-bot. DO NOT EDIT. -# See https://github.com/protocol/.github/ for details. - name: test & maybe release on: push: @@ -20,6 +17,7 @@ jobs: - uses: ipfs/aegir/actions/cache-node-modules@master - run: npm run --if-present lint - run: npm run --if-present dep-check + - run: npm run --if-present doc-check test-node: needs: check diff --git a/README.md b/README.md index 7c8b37e..a8ccd7a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# @libp2p/reframe-content-routing +# @libp2p/http-v1-content-routing [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/) [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io) -[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-reframe-content-routing.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-reframe-content-routing) -[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-reframe-content-routing/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/libp2p/js-reframe-content-routing/actions/workflows/js-test-and-release.yml?query=branch%3Amain) +[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-http-v1-content-routing.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-http-v1-content-routing) +[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-http-v1-content-routing/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/libp2p/js-http-v1-content-routing/actions/workflows/js-test-and-release.yml?query=branch%3Amain) -> Use a Reframe service to discover content providers +> Use a Routing V1 HTTP service to discover content providers ## Table of contents @@ -19,15 +19,15 @@ ## Install ```console -$ npm i @libp2p/reframe-content-routing +$ npm i @libp2p/http-v1-content-routing ``` ### Browser ` + ``` ## Example @@ -51,7 +51,7 @@ for await (const provider of node.contentRouting.findProviders('cid')) { ## API Docs -- +- ## License diff --git a/package.json b/package.json index d52a95a..37c4d90 100644 --- a/package.json +++ b/package.json @@ -1,19 +1,15 @@ { - "name": "@libp2p/reframe-content-routing", - "version": "1.0.2", - "description": "Use a Reframe service to discover content providers", + "name": "@libp2p/http-v1-content-routing", + "version": "0.0.0", + "description": "Use a Routing V1 HTTP service to discover content providers", "license": "Apache-2.0 OR MIT", - "homepage": "https://github.com/libp2p/js-reframe-content-routing#readme", + "homepage": "https://github.com/libp2p/js-http-v1-content-routing#readme", "repository": { "type": "git", - "url": "git+https://github.com/libp2p/js-reframe-content-routing.git" + "url": "git+https://github.com/libp2p/js-http-v1-content-routing.git" }, "bugs": { - "url": "https://github.com/libp2p/js-reframe-content-routing/issues" - }, - "engines": { - "node": ">=16.0.0", - "npm": ">=7.0.0" + "url": "https://github.com/libp2p/js-http-v1-content-routing/issues" }, "type": "module", "types": "./dist/src/index.d.ts", @@ -136,22 +132,20 @@ "docs": "aegir docs" }, "dependencies": { - "@libp2p/interface-content-routing": "^2.0.2", - "@libp2p/interface-peer-info": "^1.0.9", - "@libp2p/interfaces": "^3.3.1", - "@libp2p/logger": "^2.0.7", - "@libp2p/peer-id": "^2.0.3", + "@libp2p/interface": "^0.1.1", + "@libp2p/logger": "^3.0.1", + "@libp2p/peer-id": "^3.0.1", "@multiformats/multiaddr": "^12.1.2", "any-signal": "^4.1.1", "browser-readablestream-to-it": "^2.0.2", "it-to-buffer": "^4.0.1", - "multiformats": "^11.0.2", + "multiformats": "^12.0.1", "p-defer": "^4.0.0", "p-queue": "^7.3.4", "uint8arrays": "^4.0.3" }, "devDependencies": { - "@libp2p/peer-id-factory": "^2.0.3", + "@libp2p/peer-id-factory": "^3.0.2", "aegir": "^40.0.8", "body-parser": "^1.20.2", "it-all": "^3.0.1" diff --git a/src/index.ts b/src/index.ts index 9055846..1b0fa89 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,4 +1,4 @@ -import { CodeError } from '@libp2p/interfaces/errors' +import { CodeError } from '@libp2p/interface/errors' import { logger } from '@libp2p/logger' import { peerIdFromString } from '@libp2p/peer-id' import { multiaddr } from '@multiformats/multiaddr' @@ -8,10 +8,10 @@ import toBuffer from 'it-to-buffer' import defer from 'p-defer' import PQueue from 'p-queue' import { toString as uint8ArrayToString } from 'uint8arrays/to-string' -import type { ContentRouting } from '@libp2p/interface-content-routing' -import type { PeerInfo } from '@libp2p/interface-peer-info' -import type { AbortOptions } from '@libp2p/interfaces' -import type { Startable } from '@libp2p/interfaces/startable' +import type { AbortOptions } from '@libp2p/interface' +import type { ContentRouting } from '@libp2p/interface/content-routing' +import type { PeerInfo } from '@libp2p/interface/peer-info' +import type { Startable } from '@libp2p/interface/startable' import type { Multiaddr } from '@multiformats/multiaddr' import type { CID } from 'multiformats/cid' diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 0000000..f599dc7 --- /dev/null +++ b/typedoc.json @@ -0,0 +1,5 @@ +{ + "entryPoints": [ + "./src/index.ts" + ] +}