feat!: add transform to proto and must transform (#89)

Author: rhamzeh

pkg/go/transformer/dsltojson.go

@@ -8,6 +8,7 @@ import (
 	"github.com/hashicorp/go-multierror"
 	pb "github.com/openfga/api/proto/openfga/v1"
 	parser "github.com/openfga/language/pkg/go/gen"
+	"google.golang.org/protobuf/encoding/protojson"
 )
 
 type RelationDefinitionOperator string
@@ -308,8 +309,8 @@ func ParseDSL(data string) (*OpenFgaDslListener, *OpenFgaDslErrorListener) {
 	return listener, errorListener
 }
 
-// TransformDSLToJSON - Converts models authored in FGA DSL syntax to the json syntax accepted by the OpenFGA API
-func TransformDSLToJSON(data string) (*pb.AuthorizationModel, error) {
+// TransformDSLToProto - Converts models authored in FGA DSL syntax to the OpenFGA Authorization Model Protobuf format
+func TransformDSLToProto(data string) (*pb.AuthorizationModel, error) {
 	listener, errorListener := ParseDSL(data)
 
 	if errorListener.Errors != nil {
@@ -318,3 +319,39 @@ func TransformDSLToJSON(data string) (*pb.AuthorizationModel, error) {
 
 	return &listener.authorizationModel, nil
 }
+
+// MustTransformDSLToProto - Calls TransformDSLToProto - panics if the error fails
+func MustTransformDSLToProto(data string) *pb.AuthorizationModel {
+	model, err := TransformDSLToProto(data)
+	if err != nil {
+		panic(err)
+	}
+
+	return model
+}
+
+// TransformDSLToJSON - Converts models authored in FGA DSL syntax to the json syntax accepted by the OpenFGA API
+func TransformDSLToJSON(data string) (string, error) {
+	model, err := TransformDSLToProto(data)
+
+	if err != nil {
+		return "", err
+	}
+
+	bytes, err := protojson.Marshal(model)
+	if err != nil {
+		return "", fmt.Errorf("failed to marshal due to %w", err)
+	}
+
+	return string(bytes), nil
+}
+
+// MustTransformDSLToJSON - Calls TransformDSLToJSON - panics if the error fails
+func MustTransformDSLToJSON(data string) string {
+	jsonString, err := TransformDSLToJSON(data)
+	if err != nil {
+		panic(err)
+	}
+
+	return jsonString
+}

pkg/go/transformer/dsltojson_test.go

@@ -21,21 +21,18 @@ func TestDSLToJSONTransformerForValidCases(t *testing.T) {
 				t.Skip()
 			}
 
-			model, err := transformer.TransformDSLToJSON(testCase.DSL)
+			jsonString, err := transformer.TransformDSLToJSON(testCase.DSL)
 
 			require.NoError(t, err)
 
-			bytes, err := protojson.Marshal(model)
-			require.NoError(t, err)
-
 			expectedAuthModel := &pb.AuthorizationModel{}
 			err = protojson.Unmarshal([]byte(testCase.JSON), expectedAuthModel)
 			require.NoError(t, err)
 
 			jsonBytes, err := protojson.Marshal(expectedAuthModel)
 			require.NoError(t, err)
 
-			require.JSONEq(t, string(jsonBytes), string(bytes))
+			require.JSONEq(t, string(jsonBytes), jsonString)
 		})
 	}
 }

pkg/js/tests/dsltojson.test.ts

@@ -1,5 +1,5 @@
 import { loadDSLSyntaxErrorTestCases, loadValidTransformerTestCases } from "./_testcases";
-import { transformDSLToJSON } from "../transformer";
+import { transformDSLToJSON, transformDSLToJSONObject } from "../transformer";
 
 describe("dslToJSON", () => {
   const validTestCases = loadValidTransformerTestCases();
@@ -8,7 +8,7 @@ describe("dslToJSON", () => {
     const testFn = testCase.skip ? it.skip : it;
 
     testFn(`should transform ${testCase.name} from DSL to JSON`, () => {
-      const jsonSyntax = transformDSLToJSON(testCase.dsl);
+      const jsonSyntax = transformDSLToJSONObject(testCase.dsl);
       expect(jsonSyntax).toEqual(JSON.parse(testCase.json));
     });
   });

pkg/js/transformer/dsltojson.ts

@@ -141,7 +141,7 @@ class OpenFgaDslListener extends OpenFGAListener {
         ctx.parser?.notifyErrorListeners(
           `'${relationName}' is already defined in '${this.currentTypeDef?.type}'`,
           ctx.relationName().start,
-          undefined
+          undefined,
         );
       }
 
@@ -296,11 +296,11 @@ export function parseDSL(data: string): {
 }
 
 /**
- * transformDSLToJSON - Converts models authored in FGA DSL syntax to the json syntax accepted by the OpenFGA API
+ * transformDSLToJSONObject - Converts models authored in FGA DSL syntax to the json syntax accepted by the OpenFGA API
  * @param {string} data
  * @returns {AuthorizationModel}
  */
-export function transformDSLToJSON(data: string): AuthorizationModel {
+export function transformDSLToJSONObject(data: string): AuthorizationModel {
   const { listener, errorListener } = parseDSL(data);
 
   if (errorListener.errors.length) {
@@ -309,3 +309,12 @@ export function transformDSLToJSON(data: string): AuthorizationModel {
 
   return listener.authorizationModel as AuthorizationModel;
 }
+
+/**
+ * transformDSLToJSONObject - Converts models authored in FGA DSL syntax to a stringified json representation
+ * @param {string} data
+ * @returns {string}
+ */
+export function transformDSLToJSON(data: string): string {
+  return JSON.stringify(transformDSLToJSONObject(data));
+}