feat: cli for syntax transformer (#105)

* feat: cli for syntax transformer

Close #40

Author: adriantam

package-lock.json

@@ -9,6 +9,8 @@
     "build:grammar": "npx nearleyc src/parser/openfga.ne > src/parser/grammar.ts",
     "build:ts": "rm -rf dist/ && tsc --outDir dist/",
     "build": "npm run build:grammar; npm run build:ts",
+    "build:npx": "tsc --build tsconfig.json",
+    "clean": "rm -r dist/",
     "prepublishOnly": "npm run build",
     "test": "npm run build:grammar; jest --config ./tests/jest.config.js",
     "typecheck": "npm run build:grammar; tsc  --skipLibCheck",
@@ -17,6 +19,9 @@
     "format:check": "prettier --check {src,tests}/**",
     "format:fix": "prettier --write {src,tests}/**"
   },
+  "bin": {
+    "@openfga/syntax-transformer": "./dist/bin/index.js"
+  },
   "keywords": [
     "openfga",
     "authorization",
@@ -28,6 +33,7 @@
   "author": "OpenFGA",
   "dependencies": {
     "@openfga/sdk": "^0.2.0",
+    "assert-never": "^1.2.1",
     "nearley": "^2.20.1"
   },
   "devDependencies": {

package.json

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+
+import yargs from "yargs";
+import { hideBin } from "yargs/helpers";
+import { commands } from "../cmds";
+
+yargs(hideBin(process.argv))
+  .command(commands as any)
+  .demandCommand()
+  .recommendCommands()
+  .strict()
+  .help()
+  .completion().argv;

src/bin/index.ts

@@ -0,0 +1,5 @@
+/* eslint-disable import/namespace */
+import { CommandModule } from "yargs";
+import * as transform from "./transform";
+
+export const commands: CommandModule[] = [transform as CommandModule];

src/cmds/index.ts

@@ -0,0 +1,59 @@
+import { readFile } from "fs/promises";
+import { Options as YargsOptions } from "yargs";
+
+import checkDSL from "../validator";
+import transformSyntax from "../transformer";
+import { assertNever } from "assert-never";
+
+type fromOption = "dsl" | "json";
+
+interface CommandArgs {
+  from: fromOption;
+  inputFile: string;
+}
+
+exports.command = "transform";
+exports.desc = "Transform ";
+exports.builder = {
+  from: {
+    describe: "whether we want to transform from dsl or json",
+    choices: ["dsl", "json"],
+    required: true,
+  },
+  inputFile: {
+    describe: "Configuration file. It must be in DSL syntax.",
+    type: "string",
+    required: true,
+  },
+} as Record<keyof CommandArgs, YargsOptions>;
+
+async function loadFile(inputFile: string) {
+  return readFile(inputFile, "utf-8");
+}
+
+exports.handler = async (argv: CommandArgs) => {
+  try {
+    const fileContents = await loadFile(argv.inputFile);
+    switch (argv.from) {
+      case "dsl": {
+        const validateResult = checkDSL.checkDSL(fileContents);
+        if (validateResult.length) {
+          throw new Error(`Invalid DSL with error ${JSON.stringify(validateResult)}`);
+        }
+        const transformedResult = transformSyntax.friendlySyntaxToApiSyntax(fileContents);
+        console.log(JSON.stringify(transformedResult, null, 4));
+        break;
+      }
+      case "json": {
+        const transformedResult = transformSyntax.apiSyntaxToFriendlySyntax(JSON.parse(fileContents));
+        console.log(transformedResult);
+        break;
+      }
+      default:
+        assertNever(argv.from);
+    }
+  } catch (err) {
+    console.error(err as Error);
+    process.exitCode = 1;
+  }
+};

src/cmds/transform.ts

@@ -1,3 +1,4 @@
+#!/usr/bin/env node
 import constants, { enums } from "./constants";
 import formatter from "./formatter";
 import transformer from "./transformer";

src/index.ts

@@ -5,14 +5,14 @@ type AuthorizationModel = {
   type_definitions: TypeDefinition[];
 };
 
-const entitlements = import("./entitlements.json") as Promise<AuthorizationModel>;
+const entitlements = import("./entitlements.json") as unknown as Promise<AuthorizationModel>;
 const expenses = import("./expenses.json") as any as Promise<AuthorizationModel>;
-const gdrive = import("./gdrive.json") as Promise<AuthorizationModel>;
-const generic = import("./generic.json") as Promise<AuthorizationModel>;
-const github = import("./github.json") as Promise<AuthorizationModel>;
+const gdrive = import("./gdrive.json") as unknown as Promise<AuthorizationModel>;
+const generic = import("./generic.json") as unknown as Promise<AuthorizationModel>;
+const github = import("./github.json") as unknown as Promise<AuthorizationModel>;
 const iot = import("./iot.json") as Promise<AuthorizationModel>;
-const slack = import("./slack.json") as Promise<AuthorizationModel>;
-const customRoles = import("./custom-roles.json") as Promise<AuthorizationModel>;
+const slack = import("./slack.json") as unknown as Promise<AuthorizationModel>;
+const customRoles = import("./custom-roles.json") as unknown as Promise<AuthorizationModel>;
 
 const sampleAuthorizationModels: Record<string, Promise<Required<Omit<AuthorizationModel, "id">>>> = {
   entitlements,

src/samples/index.ts

@@ -1,6 +1,8 @@
 {
   "compilerOptions": {
     "declaration": true,
+    "moduleResolution": "node",
+    "esModuleInterop": true,
     "target": "es6",
     "module": "commonjs",
     "resolveJsonModule": true,