@libp2p/webrtc 3.2.5-d5ef1c91 → 3.2.6

package/dist/src/index.d.ts

@@ -1,3 +1,33 @@
+/**
+ * @packageDocumentation
+ *
+ * A [libp2p transport](https://docs.libp2p.io/concepts/transports/overview/) based on [WebRTC datachannels](https://webrtc.org/).
+ *
+ * @example
+ *
+ * ```js
+ * import { createLibp2p } from 'libp2p'
+ * import { noise } from '@chainsafe/libp2p-noise'
+ * import { multiaddr } from '@multiformats/multiaddr'
+ * import first from 'it-first'
+ * import { pipe } from 'it-pipe'
+ * import { fromString, toString } from 'uint8arrays'
+ * import { webRTC } from '@libp2p/webrtc'
+ *
+ * const node = await createLibp2p({
+ *   transports: [webRTC()],
+ *   connectionEncryption: [noise()],
+ * })
+ *
+ * await node.start()
+ *
+ * const ma =  multiaddr('/ip4/0.0.0.0/udp/56093/webrtc/certhash/uEiByaEfNSLBexWBNFZy_QB1vAKEj7JAXDizRs4_SnTflsQ')
+ * const stream = await node.dialProtocol(ma, ['/my-protocol/1.0.0'])
+ * const message = `Hello js-libp2p-webrtc\n`
+ * const response = await pipe([fromString(message)], stream, async (source) => await first(source))
+ * const responseDecoded = toString(response.slice(0, response.length))
+ * ```
+ */
 import { type WebRTCTransportDirectInit, type WebRTCDirectTransportComponents } from './private-to-public/transport.js';
 import type { WebRTCTransportComponents, WebRTCTransportInit } from './private-to-private/transport.js';
 import type { Transport } from '@libp2p/interface/transport';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAyB,KAAK,yBAAyB,EAAE,KAAK,+BAA+B,EAAE,MAAM,kCAAkC,CAAA;AAC9I,OAAO,KAAK,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAA;AACvG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAA;AAE5D,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B;;;;OAIG;IACH,6BAA6B,CAAC,EAAE,MAAM,CAAA;IAEtC;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;;;GAOG;AACH,iBAAS,YAAY,CAAE,IAAI,CAAC,EAAE,yBAAyB,GAAG,CAAC,UAAU,EAAE,+BAA+B,KAAK,SAAS,CAEnH;AAED;;;;;;;;GAQG;AACH,iBAAS,MAAM,CAAE,IAAI,CAAC,EAAE,mBAAmB,GAAG,CAAC,UAAU,EAAE,yBAAyB,KAAK,SAAS,CAEjG;AAED,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAGH,OAAO,EAAyB,KAAK,yBAAyB,EAAE,KAAK,+BAA+B,EAAE,MAAM,kCAAkC,CAAA;AAC9I,OAAO,KAAK,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAA;AACvG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAA;AAE5D,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B;;;;OAIG;IACH,6BAA6B,CAAC,EAAE,MAAM,CAAA;IAEtC;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;;;GAOG;AACH,iBAAS,YAAY,CAAE,IAAI,CAAC,EAAE,yBAAyB,GAAG,CAAC,UAAU,EAAE,+BAA+B,KAAK,SAAS,CAEnH;AAED;;;;;;;;GAQG;AACH,iBAAS,MAAM,CAAE,IAAI,CAAC,EAAE,mBAAmB,GAAG,CAAC,UAAU,EAAE,yBAAyB,KAAK,SAAS,CAEjG;AAED,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,CAAA"}

package/dist/src/index.js

@@ -1,3 +1,33 @@
+/**
+ * @packageDocumentation
+ *
+ * A [libp2p transport](https://docs.libp2p.io/concepts/transports/overview/) based on [WebRTC datachannels](https://webrtc.org/).
+ *
+ * @example
+ *
+ * ```js
+ * import { createLibp2p } from 'libp2p'
+ * import { noise } from '@chainsafe/libp2p-noise'
+ * import { multiaddr } from '@multiformats/multiaddr'
+ * import first from 'it-first'
+ * import { pipe } from 'it-pipe'
+ * import { fromString, toString } from 'uint8arrays'
+ * import { webRTC } from '@libp2p/webrtc'
+ *
+ * const node = await createLibp2p({
+ *   transports: [webRTC()],
+ *   connectionEncryption: [noise()],
+ * })
+ *
+ * await node.start()
+ *
+ * const ma =  multiaddr('/ip4/0.0.0.0/udp/56093/webrtc/certhash/uEiByaEfNSLBexWBNFZy_QB1vAKEj7JAXDizRs4_SnTflsQ')
+ * const stream = await node.dialProtocol(ma, ['/my-protocol/1.0.0'])
+ * const message = `Hello js-libp2p-webrtc\n`
+ * const response = await pipe([fromString(message)], stream, async (source) => await first(source))
+ * const responseDecoded = toString(response.slice(0, response.length))
+ * ```
+ */
 import { WebRTCTransport } from './private-to-private/transport.js';
 import { WebRTCDirectTransport } from './private-to-public/transport.js';
 /**

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAA;AACnE,OAAO,EAAE,qBAAqB,EAAwE,MAAM,kCAAkC,CAAA;AAsC9I;;;;;;;GAOG;AACH,SAAS,YAAY,CAAE,IAAgC;IACrD,OAAO,CAAC,UAA2C,EAAE,EAAE,CAAC,IAAI,qBAAqB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;AACrG,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,MAAM,CAAE,IAA0B;IACzC,OAAO,CAAC,UAAqC,EAAE,EAAE,CAAC,IAAI,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;AACzF,CAAC;AAED,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAA;AACnE,OAAO,EAAE,qBAAqB,EAAwE,MAAM,kCAAkC,CAAA;AAsC9I;;;;;;;GAOG;AACH,SAAS,YAAY,CAAE,IAAgC;IACrD,OAAO,CAAC,UAA2C,EAAE,EAAE,CAAC,IAAI,qBAAqB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;AACrG,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,MAAM,CAAE,IAA0B;IACzC,OAAO,CAAC,UAAqC,EAAE,EAAE,CAAC,IAAI,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;AACzF,CAAC;AAED,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,CAAA"}

package/dist/typedoc-urls.json

@@ -0,0 +1,8 @@
+{
+  "DataChannelOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_webrtc.DataChannelOptions.html",
+  ".:DataChannelOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_webrtc.DataChannelOptions.html",
+  "webRTC": "https://libp2p.github.io/js-libp2p/functions/_libp2p_webrtc.webRTC.html",
+  ".:webRTC": "https://libp2p.github.io/js-libp2p/functions/_libp2p_webrtc.webRTC.html",
+  "webRTCDirect": "https://libp2p.github.io/js-libp2p/functions/_libp2p_webrtc.webRTCDirect.html",
+  ".:webRTCDirect": "https://libp2p.github.io/js-libp2p/functions/_libp2p_webrtc.webRTCDirect.html"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/webrtc",
-  "version": "3.2.5-d5ef1c91",
+  "version": "3.2.6",
   "description": "A libp2p transport using WebRTC connections",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p/tree/master/packages/transport-webrtc#readme",
@@ -46,10 +46,10 @@
   },
   "dependencies": {
     "@chainsafe/libp2p-noise": "^13.0.0",
-    "@libp2p/interface": "0.1.4-d5ef1c91",
-    "@libp2p/interface-internal": "0.1.7-d5ef1c91",
-    "@libp2p/logger": "3.0.4-d5ef1c91",
-    "@libp2p/peer-id": "3.0.4-d5ef1c91",
+    "@libp2p/interface": "^0.1.5",
+    "@libp2p/interface-internal": "^0.1.8",
+    "@libp2p/logger": "^3.0.5",
+    "@libp2p/peer-id": "^3.0.5",
     "@multiformats/mafmt": "^12.1.2",
     "@multiformats/multiaddr": "^12.1.5",
     "@multiformats/multiaddr-matcher": "^1.0.1",
@@ -75,9 +75,9 @@
   },
   "devDependencies": {
     "@chainsafe/libp2p-yamux": "^5.0.0",
-    "@libp2p/interface-compliance-tests": "4.1.2-d5ef1c91",
-    "@libp2p/peer-id-factory": "3.0.6-d5ef1c91",
-    "@libp2p/websockets": "7.0.10-d5ef1c91",
+    "@libp2p/interface-compliance-tests": "^4.1.3",
+    "@libp2p/peer-id-factory": "^3.0.7",
+    "@libp2p/websockets": "^7.0.11",
     "@types/sinon": "^10.0.15",
     "aegir": "^41.0.2",
     "delay": "^6.0.0",
@@ -85,11 +85,11 @@
     "it-length": "^3.0.2",
     "it-map": "^3.0.3",
     "it-pair": "^2.0.6",
-    "libp2p": "0.46.16-d5ef1c91",
+    "libp2p": "^0.46.17",
     "p-retry": "^6.1.0",
     "protons": "^7.0.2",
     "sinon": "^17.0.0",
-    "sinon-ts": "^1.0.0"
+    "sinon-ts": "^2.0.0"
   },
   "browser": {
     "./dist/src/webrtc/index.js": "./dist/src/webrtc/index.browser.js"

package/src/index.ts

@@ -1,3 +1,34 @@
+/**
+ * @packageDocumentation
+ *
+ * A [libp2p transport](https://docs.libp2p.io/concepts/transports/overview/) based on [WebRTC datachannels](https://webrtc.org/).
+ *
+ * @example
+ *
+ * ```js
+ * import { createLibp2p } from 'libp2p'
+ * import { noise } from '@chainsafe/libp2p-noise'
+ * import { multiaddr } from '@multiformats/multiaddr'
+ * import first from 'it-first'
+ * import { pipe } from 'it-pipe'
+ * import { fromString, toString } from 'uint8arrays'
+ * import { webRTC } from '@libp2p/webrtc'
+ *
+ * const node = await createLibp2p({
+ *   transports: [webRTC()],
+ *   connectionEncryption: [noise()],
+ * })
+ *
+ * await node.start()
+ *
+ * const ma =  multiaddr('/ip4/0.0.0.0/udp/56093/webrtc/certhash/uEiByaEfNSLBexWBNFZy_QB1vAKEj7JAXDizRs4_SnTflsQ')
+ * const stream = await node.dialProtocol(ma, ['/my-protocol/1.0.0'])
+ * const message = `Hello js-libp2p-webrtc\n`
+ * const response = await pipe([fromString(message)], stream, async (source) => await first(source))
+ * const responseDecoded = toString(response.slice(0, response.length))
+ * ```
+ */
+
 import { WebRTCTransport } from './private-to-private/transport.js'
 import { WebRTCDirectTransport, type WebRTCTransportDirectInit, type WebRTCDirectTransportComponents } from './private-to-public/transport.js'
 import type { WebRTCTransportComponents, WebRTCTransportInit } from './private-to-private/transport.js'