@cliclack/openfga-type-generator v1.7.0

Openfga typescript type generator

OpenFGA Type Generator to generate TypeScript definitions based on an FGA (Fine-Grained Authorization) model.

Prerequisites

• Node.js
• NPM (Node Package Manager) or yarn

Ensure both are installed on your machine before proceeding.

Installation

To install all the dependencies, run:

npm install @cliclack/openfga-type-generator --save-dev

Configuration

The generation command is defined in the package.json file:

{
  "scripts": {
    "generate": "openfga-type-generator generate -s ./src/model.fga -d ./dist -n AuthModel",
    "generate-config": "openfga-type-generator generate"
  }
}

• -s flag points to the source FGA model file ./src/model.fga.
• -d flag points to the destination directory ./dist.
• -n is used as a prefix to to name files and types.
• -m is used to minify generated source code.

Directory structure

├── src
│   └── model.fga         # The source FGA model
├── dist                  # The directory where the generated types will be stored
└── package.json          # Project configuration and scripts
└── openfga.config.json   # Configuration file (optional)

Example reference of a model file named model.fga

model
  schema 1.1

type organization
  relations
    define member: [user] or owner
    define owner: [user]
    define repo_admin: [user, organization#member]
    define repo_reader: [user, organization#member]
    define repo_writer: [user, organization#member]

type repo
  relations
    define admin: [user, team#member] or repo_admin from owner
    define maintainer: [user, team#member] or admin
    define owner: [organization]
    define reader: [user, team#member] or triager or repo_reader from owner
    define triager: [user, team#member] or writer
    define writer: [user, team#member] or maintainer or repo_writer from owner

type team
  relations
    define member: [user, team#member]

type user

Using configuration file (optional)

Alternatively, you can use the openfga.config.json file in the root directory instead of command-line arguments.

{
  "name": "AuthModel",
  "dist": "./dist",
  "src": "./src/model.fga",
  "generate": {
    "tuples": true,
    "assertions": true,
    "metadata": true,
    "authmodel": true
  },
  "minify": true
}

Usage

Generating Types from FGA Model To generate TypeScript types from the FGA model located at ./src/model.fga, use the following command:

#run with command args
npm run generate
#run with config
npm run generate-config

This will generate the types in the ./dist directory.

License

This project is licensed under the MIT License.

Authors

Marko Ramšak, Matija Ramšak, Biserka Zinreich