ipfs-grpc-client - npm Package Compare versions

Comparing version 0.12.1-a77e40cc.0 to 0.13.0-3bcabe38

dist/src/core-api/add-all.d.ts

@@ -6,3 +6,3 @@ /**
  */
-export function grpcAddAll(grpc: typeof import("@improbable-eng/grpc-web").grpc, service: any, opts: import('../types').Options): (stream: import("ipfs-core-types/src/utils").ImportCandidateStream, options?: (import("ipfs-core-types/src/root").AddAllOptions & import("ipfs-core-types/src/utils").AbortOptions) | undefined) => AsyncIterable<import("ipfs-core-types/src/root").AddResult>;
+export function grpcAddAll(grpc: typeof import("@improbable-eng/grpc-web").grpc, service: any, opts: import('../types').Options): (source: import("ipfs-core-types/src/utils").ImportCandidateStream, options?: (import("ipfs-core-types/src/root").AddAllOptions & import("ipfs-core-types/src/utils").AbortOptions) | undefined) => AsyncIterable<import("ipfs-core-types/src/root").AddResult>;
 //# sourceMappingURL=add-all.d.ts.map

dist/src/core-api/files/ls.d.ts

@@ -6,3 +6,3 @@ /**
  */
-export function grpcMfsLs(grpc: typeof import("@improbable-eng/grpc-web").grpc, service: any, opts: import('../../types').Options): (path: import("ipfs-core-types/src/utils.js").IPFSPath, options?: import("ipfs-core-types/src/utils.js").AbortOptions | undefined) => AsyncIterable<import("ipfs-core-types/src/files").MFSEntry>;
+export function grpcMfsLs(grpc: typeof import("@improbable-eng/grpc-web").grpc, service: any, opts: import('../../types').Options): (ipfsPath: import("ipfs-core-types/src/utils.js").IPFSPath, options?: import("ipfs-core-types/src/utils.js").AbortOptions | undefined) => AsyncIterable<import("ipfs-core-types/src/files").MFSEntry>;
 //# sourceMappingURL=ls.d.ts.map

dist/src/core-api/files/write.d.ts

@@ -6,3 +6,3 @@ /**
  */
-export function grpcMfsWrite(grpc: typeof import("@improbable-eng/grpc-web").grpc, service: any, opts: import('../../types').Options): (path: string, content: string | Uint8Array | AsyncIterable<Uint8Array> | Iterable<Uint8Array> | Blob, options?: import("ipfs-core-types/src/files").WriteOptions | undefined) => Promise<void>;
+export function grpcMfsWrite(grpc: typeof import("@improbable-eng/grpc-web").grpc, service: any, opts: import('../../types').Options): (ipfsPath: string, content: string | Uint8Array | AsyncIterable<Uint8Array> | Iterable<Uint8Array> | Blob, options?: import("ipfs-core-types/src/files").WriteOptions | undefined) => Promise<void>;
 //# sourceMappingURL=write.d.ts.map

dist/src/core-api/pubsub/unsubscribe.d.ts

@@ -6,3 +6,3 @@ /**
  */
-export function grpcPubsubUnsubscribe(grpc: typeof import("@improbable-eng/grpc-web").grpc, service: any, opts: import('../../types').Options): (topic: string, handler: import("@libp2p/interfaces/dist/src/events.js").EventHandler<import("@libp2p/interface-pubsub").Message> | undefined, options?: import("ipfs-core-types/src/utils.js").AbortOptions | undefined) => Promise<void>;
+export function grpcPubsubUnsubscribe(grpc: typeof import("@improbable-eng/grpc-web").grpc, service: any, opts: import('../../types').Options): (topic: string, handler?: import("@libp2p/interfaces/dist/src/events.js").EventHandler<import("@libp2p/interface-pubsub").Message> | undefined, options?: import("ipfs-core-types/src/utils.js").AbortOptions | undefined) => Promise<void>;
 //# sourceMappingURL=unsubscribe.d.ts.map

dist/src/index.d.ts

@@ -5,11 +5,11 @@ /**
 export function create(opts?: import("./types").Options | undefined): {
-    addAll: (stream: import("ipfs-core-types/src/utils.js").ImportCandidateStream, options?: (import("ipfs-core-types/src/root.js").AddAllOptions & import("ipfs-core-types/src/utils.js").AbortOptions) | undefined) => AsyncIterable<import("ipfs-core-types/src/root.js").AddResult>;
+    addAll: (source: import("ipfs-core-types/src/utils.js").ImportCandidateStream, options?: (import("ipfs-core-types/src/root.js").AddAllOptions & import("ipfs-core-types/src/utils.js").AbortOptions) | undefined) => AsyncIterable<import("ipfs-core-types/src/root.js").AddResult>;
     id: (options?: import("ipfs-core-types/src/root.js").IDOptions | undefined) => Promise<import("ipfs-core-types/src/root.js").IDResult>;
     files: {
-        ls: (path: import("ipfs-core-types/src/utils.js").IPFSPath, options?: import("ipfs-core-types/src/utils.js").AbortOptions | undefined) => AsyncIterable<import("ipfs-core-types/src/files/index.js").MFSEntry>;
-        write: (path: string, content: string | Uint8Array | AsyncIterable<Uint8Array> | Iterable<Uint8Array> | Blob, options?: import("ipfs-core-types/src/files/index.js").WriteOptions | undefined) => Promise<void>;
+        ls: (ipfsPath: import("ipfs-core-types/src/utils.js").IPFSPath, options?: import("ipfs-core-types/src/utils.js").AbortOptions | undefined) => AsyncIterable<import("ipfs-core-types/src/files/index.js").MFSEntry>;
+        write: (ipfsPath: string, content: string | Uint8Array | AsyncIterable<Uint8Array> | Iterable<Uint8Array> | Blob, options?: import("ipfs-core-types/src/files/index.js").WriteOptions | undefined) => Promise<void>;
     };
     pubsub: {
         subscribe: (topic: string, handler: import("@libp2p/interfaces/dist/src/events.js").EventHandler<import("@libp2p/interface-pubsub").Message>, options?: import("ipfs-core-types/src/pubsub/index.js").SubscribeOptions | undefined) => Promise<void>;
-        unsubscribe: (topic: string, handler: import("@libp2p/interfaces/dist/src/events.js").EventHandler<import("@libp2p/interface-pubsub").Message> | undefined, options?: import("ipfs-core-types/src/utils.js").AbortOptions | undefined) => Promise<void>;
+        unsubscribe: (topic: string, handler?: import("@libp2p/interfaces/dist/src/events.js").EventHandler<import("@libp2p/interface-pubsub").Message> | undefined, options?: import("ipfs-core-types/src/utils.js").AbortOptions | undefined) => Promise<void>;
     };
@@ -16,0 +16,0 @@ };

package.json

 {
   "name": "ipfs-grpc-client",
-  "version": "0.12.1-a77e40cc.0",
+  "version": "0.13.0-3bcabe38",
   "description": "A client library for the IPFS gRPC API",
@@ -72,14 +72,14 @@ "license": "Apache-2.0 OR MIT",
     "@improbable-eng/grpc-web": "^0.15.0",
-    "@libp2p/logger": "^2.0.0",
-    "@libp2p/peer-id": "^1.1.10",
-    "@multiformats/multiaddr": "^11.0.0",
+    "@libp2p/logger": "^2.0.5",
+    "@libp2p/peer-id": "^2.0.0",
+    "@multiformats/multiaddr": "^11.1.5",
     "change-case": "^4.1.1",
     "err-code": "^3.0.1",
-    "ipfs-core-types": "^0.13.1-a77e40cc.0",
-    "ipfs-core-utils": "^0.17.1-a77e40cc.0",
-    "ipfs-grpc-protocol": "^0.7.1-a77e40cc.0",
-    "ipfs-unixfs": "^8.0.0",
+    "ipfs-core-types": "0.14.0-3bcabe38",
+    "ipfs-core-utils": "0.18.0-3bcabe38",
+    "ipfs-grpc-protocol": "0.8.0-3bcabe38",
+    "ipfs-unixfs": "^9.0.0",
     "it-first": "^2.0.0",
     "it-pushable": "^3.0.0",
-    "multiformats": "^10.0.0",
+    "multiformats": "^11.0.0",
     "p-defer": "^4.0.0",
@@ -92,6 +92,6 @@ "protobufjs": "^7.0.0",
   "devDependencies": {
-    "aegir": "^37.0.11",
+    "aegir": "^37.11.0",
     "it-all": "^2.0.0",
     "protobufjs-cli": "^1.0.0",
-    "sinon": "^14.0.0"
+    "sinon": "^15.0.1"
   },
@@ -101,4 +101,3 @@ "browser": {
     "./src/grpc/transport.node.js": "./src/grpc/transport.browser.js"
-  },
-  "gitHead": "a614528c55b8b22866bbdd2ffcde2e38eb5f578f"
+  }
 }

README.md

 # ipfs-grpc-client <!-- omit in toc -->
 
-[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)
-[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
-[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)
+[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
+[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
 [![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipfs.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs)
-[![CI](https://img.shields.io/github/workflow/status/ipfs/js-ipfs/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-ipfs/actions/workflows/js-test-and-release.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-ipfs/test.yml?branch=master\&style=flat-square)](https://github.com/ipfs/js-ipfs/actions/workflows/test.yml?query=branch%3Amaster)
 
@@ -14,2 +13,3 @@ > A client library for the IPFS gRPC API
 - [Install](#install)
+  - [Browser `<script>` tag](#browser-script-tag)
 - [Why?](#why)
@@ -31,2 +31,10 @@ - [API](#api)
 
+### Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `IpfsGrpcClient` in the global namespace.
+
+```html
+<script src="https://unpkg.com/ipfs-grpc-client/dist/index.min.js"></script>
+```
+
 This module implements part of the [IPFS Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) using      gRPC over websockets to achieve the bidirectional streaming necessary to have full duplex streams running in the browser.
@@ -33,0 +41,0 @@

No alert changes

Improved metrics

Total package byte prevSize

212596

increased by0.02%

Number of lines in readme file

105

increased by8.25%

Worsened metrics

Lines of code

1682

decreased by-0.47%

Dependency changes

• + Added@ipld/dag-pb@4.1.3(transitive)

• + Added@libp2p/interface-keychain@2.0.5(transitive)

• + Added@libp2p/peer-id@2.0.4(transitive)

• + Addedipfs-core-types@0.14.0-3bcabe38(transitive)

• + Addedipfs-core-utils@0.18.0-3bcabe38(transitive)

• + Addedipfs-grpc-protocol@0.8.0-3bcabe38(transitive)

• + Addedipfs-unixfs@9.0.1(transitive)

• - Removed@ipld/dag-pb@3.0.2(transitive)

• - Removed@libp2p/interface-keychain@1.0.8(transitive)

• - Removed@libp2p/interface-peer-id@1.1.2(transitive)

• - Removed@libp2p/peer-id@1.1.18(transitive)

• - Removedipfs-core-types@0.13.1-a77e40cc.0(transitive)

• - Removedipfs-core-utils@0.17.1-a77e40cc.0(transitive)

• - Removedipfs-grpc-protocol@0.7.1-dfc43d4e.0(transitive)

• - Removedipfs-unixfs@8.0.0(transitive)

• - Removedmultiformats@10.0.3(transitive)

• Updated@libp2p/logger@^2.0.5

• Updated@libp2p/peer-id@^2.0.0

• Updated@multiformats/multiaddr@^11.1.5

• Updatedipfs-core-types@0.14.0-3bcabe38

• Updatedipfs-core-utils@0.18.0-3bcabe38

• Updatedipfs-grpc-protocol@0.8.0-3bcabe38

• Updatedipfs-unixfs@^9.0.0

• Updatedmultiformats@^11.0.0