fix: move gRPC client module root up (#620)

BREAKING: The npm package `@ory/keto-grpc-client` from now on includes all API versions. Because of that, the import paths changed. For migrating to the new client package, change the import path according to the following example: ```diff - import acl from '@ory/keto-grpc-client/acl_pb.js' + // from the latest version + import { acl } from '@ory/keto-grpc-client' + // or a specific one + import acl from '@ory/keto-grpc-client/ory/keto/acl/v1alpha1/acl_pb.js' ```
ory · Jun 16, 2021 · 3b881f6 · 3b881f6
1 parent 80e0432
commit 3b881f6
Show file tree

Hide file tree

Showing 23 changed files with 91 additions and 517 deletions.
diff --git a/.github/workflows/npm_publish_grpc_client.yml b/.github/workflows/npm_publish_grpc_client.yml
@@ -23,7 +23,7 @@ jobs:
       - run: sudo npm i -g npm@7
       - name: Bump version
         run: |-
-          cd proto/ory/keto/acl/v1alpha1
+          cd proto
           cat <<< $(jq '.version = (env.RELEASE_VERSION | sub("(^refs/tags/v)|(^v)"; ""))' package.json) > package.json
         env:
           RELEASE_VERSION: ${{ github.event.inputs.version || github.ref }}
@@ -32,10 +32,10 @@ jobs:
           add: package.json
           author_name: zepatrik
           author_email: zepatrik@users.noreply.github.com
-          cwd: proto/ory/keto/acl/v1alpha1
+          cwd: proto
           message: 'autogen: bump node gRPC client version'
       - run: |-
-          cd proto/ory/keto/acl/v1alpha1
+          cd proto
           npm publish --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN_AENEASR }}
diff --git a/contrib/docs-code-samples/expand-api-display-access/00-create-tuples/index.js b/contrib/docs-code-samples/expand-api-display-access/00-create-tuples/index.js
@@ -1,18 +1,16 @@
 import grpc from '@ory/keto-grpc-client/node_modules/@grpc/grpc-js/build/src/index.js'
-import acl from '@ory/keto-grpc-client/acl_pb.js'
-import writeService from '@ory/keto-grpc-client/write_service_grpc_pb.js'
-import writeData from '@ory/keto-grpc-client/write_service_pb.js'
+import { acl, write, writeService } from '@ory/keto-grpc-client'
 
 const writeClient = new writeService.WriteServiceClient(
   '127.0.0.1:4467',
   grpc.credentials.createInsecure()
 )
 
-const writeRequest = new writeData.TransactRelationTuplesRequest()
+const writeRequest = new write.TransactRelationTuplesRequest()
 
 const insert = (tuple) => {
-  const tupleDelta = new writeData.RelationTupleDelta()
-  tupleDelta.setAction(writeData.RelationTupleDelta.Action.INSERT)
+  const tupleDelta = new write.RelationTupleDelta()
+  tupleDelta.setAction(write.RelationTupleDelta.Action.INSERT)
   tupleDelta.setRelationTuple(tuple)
 
   writeRequest.addRelationTupleDeltas(tupleDelta)

diff --git a/contrib/docs-code-samples/expand-api-display-access/01-expand-beach/index.js b/contrib/docs-code-samples/expand-api-display-access/01-expand-beach/index.js
@@ -1,7 +1,5 @@
 import grpc from '@ory/keto-grpc-client/node_modules/@grpc/grpc-js/build/src/index.js'
-import expandService from '@ory/keto-grpc-client/expand_service_grpc_pb.js'
-import expandData from '@ory/keto-grpc-client/expand_service_pb.js'
-import acl from '@ory/keto-grpc-client/acl_pb.js'
+import { acl, expand, expandService } from '@ory/keto-grpc-client'
 
 const expandClient = new expandService.ExpandServiceClient(
   '127.0.0.1:4466',
@@ -16,7 +14,7 @@ subjectSet.setObject('/photos/beach.jpg')
 const sub = new acl.Subject()
 sub.setSet(subjectSet)
 
-const expandRequest = new expandData.ExpandRequest()
+const expandRequest = new expand.ExpandRequest()
 expandRequest.setSubject(sub)
 expandRequest.setMaxDepth(3)
 
@@ -37,9 +35,9 @@ const prettyTree = (tree) => {
     tree.getChildrenList()
   ]
   switch (nodeType) {
-    case expandData.NodeType.NODE_TYPE_LEAF:
+    case expand.NodeType.NODE_TYPE_LEAF:
       return { type: 'leaf', subject }
-    case expandData.NodeType.NODE_TYPE_UNION:
+    case expand.NodeType.NODE_TYPE_UNION:
       return { type: 'union', subject, children: children.map(prettyTree) }
   }
 }

diff --git a/contrib/docs-code-samples/expand-api-display-access/99-cleanup/index.js b/contrib/docs-code-samples/expand-api-display-access/99-cleanup/index.js
@@ -1,19 +1,16 @@
 import grpc from '@ory/keto-grpc-client/node_modules/@grpc/grpc-js/build/src/index.js'
-import writeService from '@ory/keto-grpc-client/write_service_grpc_pb.js'
-import writeData from '@ory/keto-grpc-client/write_service_pb.js'
-import readService from '@ory/keto-grpc-client/read_service_grpc_pb.js'
-import readData from '@ory/keto-grpc-client/read_service_pb.js'
+import { write, writeService, read, readService } from '@ory/keto-grpc-client'
 
 const readClient = new readService.ReadServiceClient(
   '127.0.0.1:4466',
   grpc.credentials.createInsecure()
 )
 
 const purgeNamespace = (namespace) => {
-  const query = new readData.ListRelationTuplesRequest.Query()
+  const query = new read.ListRelationTuplesRequest.Query()
   query.setNamespace(namespace)
 
-  const readRequest = new readData.ListRelationTuplesRequest()
+  const readRequest = new read.ListRelationTuplesRequest()
   readRequest.setQuery(query)
 
   readClient.listRelationTuples(readRequest, (err, resp) => {
@@ -22,11 +19,11 @@ const purgeNamespace = (namespace) => {
       grpc.credentials.createInsecure()
     )
 
-    const writeRequest = new writeData.TransactRelationTuplesRequest()
+    const writeRequest = new write.TransactRelationTuplesRequest()
 
     resp.getRelationTuplesList().forEach((tuple) => {
-      const tupleDelta = new writeData.RelationTupleDelta()
-      tupleDelta.setAction(writeData.RelationTupleDelta.Action.DELETE)
+      const tupleDelta = new write.RelationTupleDelta()
+      tupleDelta.setAction(write.RelationTupleDelta.Action.DELETE)
       tupleDelta.setRelationTuple(tuple)
       writeRequest.addRelationTupleDeltas(tupleDelta)
     })

diff --git a/contrib/docs-code-samples/list-api-display-objects/00-create-tuples/index.js b/contrib/docs-code-samples/list-api-display-objects/00-create-tuples/index.js
@@ -1,14 +1,12 @@
 import grpc from '@ory/keto-grpc-client/node_modules/@grpc/grpc-js/build/src/index.js'
-import acl from '@ory/keto-grpc-client/acl_pb.js'
-import writeService from '@ory/keto-grpc-client/write_service_grpc_pb.js'
-import writeData from '@ory/keto-grpc-client/write_service_pb.js'
+import { acl, write, writeService } from '@ory/keto-grpc-client'
 
 const writeClient = new writeService.WriteServiceClient(
   '127.0.0.1:4467',
   grpc.credentials.createInsecure()
 )
 
-const writeRequest = new writeData.TransactRelationTuplesRequest()
+const writeRequest = new write.TransactRelationTuplesRequest()
 
 const addToChat = (chatName) => (user) => {
   const relationTuple = new acl.RelationTuple()
@@ -20,8 +18,8 @@ const addToChat = (chatName) => (user) => {
   sub.setId(user)
   relationTuple.setSubject(sub)
 
-  const tupleDelta = new writeData.RelationTupleDelta()
-  tupleDelta.setAction(writeData.RelationTupleDelta.Action.INSERT)
+  const tupleDelta = new write.RelationTupleDelta()
+  tupleDelta.setAction(write.RelationTupleDelta.Action.INSERT)
   tupleDelta.setRelationTuple(relationTuple)
 
   writeRequest.addRelationTupleDeltas(tupleDelta)

diff --git a/contrib/docs-code-samples/list-api-display-objects/01-list-PM/index.js b/contrib/docs-code-samples/list-api-display-objects/01-list-PM/index.js
@@ -1,15 +1,13 @@
 import grpc from '@ory/keto-grpc-client/node_modules/@grpc/grpc-js/build/src/index.js'
-import acl from '@ory/keto-grpc-client/acl_pb.js'
-import readService from '@ory/keto-grpc-client/read_service_grpc_pb.js'
-import readData from '@ory/keto-grpc-client/read_service_pb.js'
+import { acl, read, readService } from '@ory/keto-grpc-client'
 
 const readClient = new readService.ReadServiceClient(
   '127.0.0.1:4466',
   grpc.credentials.createInsecure()
 )
 
-const readRequest = new readData.ListRelationTuplesRequest()
-const query = new readData.ListRelationTuplesRequest.Query()
+const readRequest = new read.ListRelationTuplesRequest()
+const query = new read.ListRelationTuplesRequest.Query()
 query.setNamespace('chats')
 query.setRelation('member')
 

diff --git a/contrib/docs-code-samples/list-api-display-objects/02-list-coffee-break/index.js b/contrib/docs-code-samples/list-api-display-objects/02-list-coffee-break/index.js
@@ -1,15 +1,13 @@
 import grpc from '@ory/keto-grpc-client/node_modules/@grpc/grpc-js/build/src/index.js'
-import acl from '@ory/keto-grpc-client/acl_pb.js'
-import readService from '@ory/keto-grpc-client/read_service_grpc_pb.js'
-import readData from '@ory/keto-grpc-client/read_service_pb.js'
+import { read, readService } from '@ory/keto-grpc-client'
 
 const readClient = new readService.ReadServiceClient(
   '127.0.0.1:4466',
   grpc.credentials.createInsecure()
 )
 
-const readRequest = new readData.ListRelationTuplesRequest()
-const query = new readData.ListRelationTuplesRequest.Query()
+const readRequest = new read.ListRelationTuplesRequest()
+const query = new read.ListRelationTuplesRequest.Query()
 query.setNamespace('chats')
 query.setObject('coffee-break')
 query.setRelation('member')

diff --git a/contrib/docs-code-samples/list-api-display-objects/99-cleanup/index.js b/contrib/docs-code-samples/list-api-display-objects/99-cleanup/index.js
@@ -1,18 +1,15 @@
 import grpc from '@ory/keto-grpc-client/node_modules/@grpc/grpc-js/build/src/index.js'
-import writeService from '@ory/keto-grpc-client/write_service_grpc_pb.js'
-import writeData from '@ory/keto-grpc-client/write_service_pb.js'
-import readService from '@ory/keto-grpc-client/read_service_grpc_pb.js'
-import readData from '@ory/keto-grpc-client/read_service_pb.js'
+import { write, writeService, read, readService } from '@ory/keto-grpc-client'
 
 const readClient = new readService.ReadServiceClient(
   '127.0.0.1:4466',
   grpc.credentials.createInsecure()
 )
 
-const query = new readData.ListRelationTuplesRequest.Query()
+const query = new read.ListRelationTuplesRequest.Query()
 query.setNamespace('chats')
 
-const readRequest = new readData.ListRelationTuplesRequest()
+const readRequest = new read.ListRelationTuplesRequest()
 readRequest.setQuery(query)
 
 readClient.listRelationTuples(readRequest, (err, resp) => {
@@ -21,11 +18,11 @@ readClient.listRelationTuples(readRequest, (err, resp) => {
     grpc.credentials.createInsecure()
   )
 
-  const writeRequest = new writeData.TransactRelationTuplesRequest()
+  const writeRequest = new write.TransactRelationTuplesRequest()
 
   resp.getRelationTuplesList().forEach((tuple) => {
-    const tupleDelta = new writeData.RelationTupleDelta()
-    tupleDelta.setAction(writeData.RelationTupleDelta.Action.DELETE)
+    const tupleDelta = new write.RelationTupleDelta()
+    tupleDelta.setAction(write.RelationTupleDelta.Action.DELETE)
     tupleDelta.setRelationTuple(tuple)
     writeRequest.addRelationTupleDeltas(tupleDelta)
   })