Merge pull request #106 from aserto-dev/protobuf_helpers

Facilitate json serialization, export bufbuild helpers

Author: gimmyxd

MIGRATING.md

@@ -106,8 +106,7 @@ m
 Response Messages no longer implement the magic toJSON method, which serializes a message with the Protobuf JSON format when it's passed to `JSON.stringify`. Make sure to always serializes to JSON with the toJson or toJsonString function.
 
 ```ts
-import { GetObjectsResponseSchema } from '@aserto/aserto-node'
-import { toJson } from "@bufbuild/protobuf";
+import { GetObjectsResponseSchema, toJson } from '@aserto/aserto-node'
 
 const response = await directoryClient.objects({
   objectType: "user",
@@ -150,8 +149,7 @@ TypeError: Do not know how to serialize a BigInt
 This requires [data serialization](#serialization-and-deserialization-of-data):
 
 ```ts
-import { GetObjectsResponseSchema } from '@aserto/aserto-node'
-import { toJson } from "@bufbuild/protobuf";
+import { GetObjectsResponseSchema, toJson } from '@aserto/aserto-node'
 
 app.get("/api/users/:id", async (req, res) => {
   const id = req.params.id;

README.md

@@ -811,8 +811,7 @@ Use [Protocol Buffers](https://github.com/bufbuild/protobuf-es) to serialize dat
 
 
 ```ts
-import { GetObjectsResponseSchema } from "@aserto/aserto-node";
-import { toJson } from "@bufbuild/protobuf";
+import { GetObjectsResponseSchema, toJson } from "@aserto/aserto-node";
 
 const objects = await directoryClient.objects({objectType: "user"});
 const json = toJson(GetObjectsResponseSchema, objects)

__tests__/authorizer/index.test.ts

@@ -1,7 +1,7 @@
-import { create } from "@bufbuild/protobuf";
 import { Code, ConnectError } from "@connectrpc/connect";
 
 import {
+  create,
   decisionTreeOptions,
   DecisionTreeResponseSchema,
   IsResponseSchema,
@@ -391,7 +391,6 @@ describe("ListPolicies", () => {
     const result = await authorizer.ListPolicies({});
     expect(result).toEqual([
       {
-        $typeName: "aserto.authorizer.v2.api.Module",
         id: "1",
         packagePath: "a.b.c",
       },

__tests__/directory/v3/index.test.ts

@@ -1,13 +1,13 @@
 import * as fs from "fs";
 import { describe } from "node:test";
-import { create } from "@bufbuild/protobuf";
 import { Code, ConnectError } from "@connectrpc/connect";
 import { createAsyncIterable } from "@connectrpc/connect/protocol";
 import * as connectNode from "@connectrpc/connect-node";
 
 import {
   CheckResponseSchema,
   ConfigError,
+  create,
   createImportRequest,
   DeleteManifestResponseSchema,
   DeleteObjectResponseSchema,
@@ -29,7 +29,7 @@ import {
   SetManifestResponseSchema,
   SetObjectResponseSchema,
   SetRelationResponseSchema,
-} from "../../../lib/index";
+} from "../../../lib";
 jest.mock("fs");
 
 describe("DirectoryV3", () => {
@@ -466,6 +466,7 @@ describe("DirectoryV3", () => {
         $typeName: "aserto.directory.reader.v3.CheckResponse",
         check: true,
         trace: [],
+        toJSON: expect.any(Function),
       });
 
       mockCheck.mockReset();
@@ -516,6 +517,7 @@ describe("DirectoryV3", () => {
           id: "123",
           type: "",
         },
+        toJSON: expect.any(Function),
       });
 
       mockGetObject.mockReset();
@@ -576,6 +578,7 @@ describe("DirectoryV3", () => {
       expect(result).toEqual({
         $typeName: "aserto.directory.reader.v3.GetObjectsResponse",
         results: [],
+        toJSON: expect.any(Function),
       });
 
       mockGetObjects.mockReset();
@@ -612,6 +615,7 @@ describe("DirectoryV3", () => {
       expect(result).toEqual({
         $typeName: "aserto.directory.reader.v3.GetObjectsResponse",
         results: [],
+        toJSON: expect.any(Function),
       });
 
       mockGetObjects.mockReset();
@@ -648,6 +652,7 @@ describe("DirectoryV3", () => {
       expect(result).toEqual({
         $typeName: "aserto.directory.reader.v3.GetObjectsResponse",
         results: [],
+        toJSON: expect.any(Function),
       });
 
       mockGetObjects.mockReset();
@@ -685,6 +690,7 @@ describe("DirectoryV3", () => {
       expect(result).toEqual({
         $typeName: "aserto.directory.reader.v3.GetObjectsResponse",
         results: [],
+        toJSON: expect.any(Function),
       });
 
       mockGetObjects.mockReset();
@@ -833,6 +839,7 @@ describe("DirectoryV3", () => {
       expect(result).toEqual({
         $typeName: "aserto.directory.reader.v3.GetObjectManyResponse",
         results: [],
+        toJSON: expect.any(Function),
       });
 
       mockGetObjectMany.mockReset();
@@ -881,6 +888,7 @@ describe("DirectoryV3", () => {
         $typeName: "aserto.directory.reader.v3.GetGraphResponse",
         results: [],
         trace: [],
+        toJSON: expect.any(Function),
       });
 
       mockGetGraph.mockReset();
@@ -977,6 +985,7 @@ describe("DirectoryV3", () => {
           etag: "",
         },
         objects: {},
+        toJSON: expect.any(Function),
       });
 
       mockGetRelation.mockReset();
@@ -1033,6 +1042,7 @@ describe("DirectoryV3", () => {
         $typeName: "aserto.directory.reader.v3.GetRelationsResponse",
         results: [],
         objects: {},
+        toJSON: expect.any(Function),
       });
 
       mockGetRelations.mockReset();
@@ -1145,6 +1155,7 @@ describe("DirectoryV3", () => {
       expect(result).toEqual({
         $typeName: "aserto.directory.writer.v3.DeleteRelationResponse",
         result: { $typeName: "google.protobuf.Empty" },
+        toJSON: expect.any(Function),
       });
 
       mockDeleteRelation.mockReset();
@@ -1198,6 +1209,7 @@ describe("DirectoryV3", () => {
         body: "test",
         etag: "",
         updatedAt: undefined,
+        toJSON: expect.any(Function),
       });
 
       getManifestMock.mockReset();
@@ -1228,6 +1240,7 @@ describe("DirectoryV3", () => {
       expect(result).toEqual({
         $typeName: "aserto.directory.model.v3.SetManifestResponse",
         result: { $typeName: "google.protobuf.Empty" },
+        toJSON: expect.any(Function),
       });
 
       mockSetManifest.mockReset();
@@ -1255,6 +1268,7 @@ describe("DirectoryV3", () => {
       const result = await directory.deleteManifest();
       expect(result).toEqual({
         $typeName: "aserto.directory.model.v3.DeleteManifestResponse",
+        toJSON: expect.any(Function),
       });
 
       mockDeleteManifest.mockReset();