Merge pull request #47 from mgagliardo91/feat-support-promises

feat: Add promise support

README.md

@@ -111,6 +111,33 @@ client.checkPermission(checkPermissionRequest, (err, response) => {
 });
 ```
 
+### Promises (async/await) support
+
+Each method available in the client has an associated promise-style method in place of callbacks, that can be accessed at the `.promises` property on the client.
+
+```js
+import { v1 } from '@authzed/authzed-node';
+
+const client = v1.NewClient('token');
+const { promises: promiseClient } = client; // access client.promises
+
+const checkPermissionRequest = /** from above **/;
+
+const result = await promiseClient.checkPermission(checkPermissionRequest);
+```
+
+For stream-returning methods, including `client.readRelationships()`, `client.lookupResources()` and `client.lookupSubjects()`, the promise-style method will result in an array of response objects once the stream has been closed.
+
+```js
+import { v1 } from '@authzed/authzed-node';
+
+const client = v1.NewClient('token');
+const { promises: promiseClient } = client; // access client.promises
+
+const results = await promiseClient.readRelationships(/** req **/);
+console.log(results[0]); // first ReadRelationship result
+```
+
 ## Requirements
 
 Supported Node.js versions: 14, 16, 17

buf.gen.yaml

@@ -1,4 +1,4 @@
-#!/usr/bin/env -S buf generate buf.build/authzed/api:418c57bfce56bc4fb44870bbbc84217d14cc0c9f --template
+#!/usr/bin/env -S buf generate buf.build/authzed/api:97e6f8e5f9669b673a53a40658241609fb1a94e3 --template
 # To regenerate:
 #   npm install -g grpc-tools
 #   ./buf.gen.yaml

docker-compose.yaml

@@ -0,0 +1,10 @@
+services:
+  spicedb-servetesting:
+    image: quay.io/authzed/spicedb:latest
+    ports: ['50051:50051']
+    command: serve-testing
+    healthcheck:
+      test: ["CMD", "/usr/local/bin/grpc_health_probe", "-addr=:50051"]
+      interval: 30s
+      timeout: 30s
+      retries: 3

js-dist/jasmine.json

@@ -2,4 +2,4 @@
   "spec_dir": "src",
   "spec_files": ["*.test.js"],
   "helpers": []
-}
+}