#MoonFGA

#评审入口

#版本对应

# 源码测试
git checkout v0.1.1
moon test --target all

# 安装包调用：在仓库外新建模块，复制 examples/library 的 main.mbt 和 moon.pkg 到 cmd/main
moon new consumer && cd consumer
moon add sundaysebasidian-byte/moonfga@0.1.1
moon run cmd/main

# 线上引擎：打开 Pages；对应的构建见 Actions 中 Pages 工作流的运行记录
gh run list --workflow pages.yml --limit 1

#为什么做这个

• 在 MoonBit 上提供一个能直接嵌入的 Zanzibar / OpenFGA 风格授权引擎。
• 兼容性以 OpenFGA 官方测试为准，而不是实现一个"看起来像"的 API。
• 引擎是内存实现，不依赖网络和数据库，同一套模型与元组可以在服务端和浏览器里运行。

#与 OpenFGA 的一致性

#覆盖矩阵

#Playground

scripts/build-web.sh
node web/smoke.mjs                  # 对内置示例做冒烟断言
python3 -m http.server -d web/dist  # 然后访问 http://localhost:8000

#安装与构建

moon add sundaysebasidian-byte/moonfga@0.1.1

git clone https://github.com/sundaysebasidian-byte/moonfga
cd moonfga
export PATH="$HOME/.moon/bin:$PATH"
moon check --deny-warn
moon test

moon test --target native
moon test --target wasm-gc
moon test --target js

#库 API 快速开始

import {
  "sundaysebasidian-byte/moonfga/fga",
  "sundaysebasidian-byte/moonfga/dsl",
  "sundaysebasidian-byte/moonfga/store",
  "sundaysebasidian-byte/moonfga/engine",
}

let model = @dsl.parse_model(
  "model\n  schema 1.1\n\ntype user\n\ntype group\n  relations\n    define member: [user]\n\ntype document\n  relations\n    define viewer: [user, group#member]\n",
)
let store = @store.MemoryStore::new()
let _ = store.write(
  @fga.Tuple::{ object: "group:eng", relation: "member", user: "user:anne", condition: None },
)
let _ = store.write(
  @fga.Tuple::{ object: "document:roadmap", relation: "viewer", user: "group:eng#member", condition: None },
)
let engine = @engine.Engine::new(model, store as &@fga.TupleReader)
let allowed = engine.check("document:roadmap", "viewer", "user:anne")
println(allowed.to_string()) // true

moon run examples/library

• @dsl.parse_model(dsl) / @model.json_to_model(json) / @model.model_from_source(source)
• @model.model_to_json(model) / @dsl.to_dsl(model)
• @validate.validate_model(model) 返回带位置的 ValidationIssue
• @store.MemoryStore::{ new, write, write_all, delete, read }
• @engine.Engine::{ check, check_with, batch_check, list_objects, list_users, expand_json, explain_check }

#CLI

# 校验 DSL 或 JSON 模型
moon run cmd/main -- validate examples/basic/model.fga

# DSL -> JSON / JSON -> DSL
moon run cmd/main -- transform examples/basic/model.fga --to json
moon run cmd/main -- transform examples/basic/model.fga --to dsl

# Check（--explain 打印解析路径）
moon run cmd/main -- check \
  --model examples/basic/model.fga \
  --store examples/basic/tuples.fga \
  --object document:budget --relation viewer --user user:bob --explain

# ListObjects / ListUsers
moon run cmd/main -- list-objects \
  --model examples/basic/model.fga --store examples/basic/tuples.fga \
  --type document --relation viewer --user user:bob
moon run cmd/main -- list-users \
  --model examples/basic/model.fga --store examples/basic/tuples.fga \
  --object document:budget --relation viewer --filters user

# Expand 关系树
moon run cmd/main -- expand \
  --model examples/basic/model.fga --store examples/basic/tuples.fga \
  --object document:budget --relation viewer

# 条件（ABAC）示例
moon run cmd/main -- check \
  --model examples/abac/model.fga --store examples/abac/tuples.fga \
  --object document:plan --relation viewer --user user:dana \
  --context '{"office":"hq","allowed":["remote"]}'

# 运行 .fga.yaml 测试
moon run cmd/main -- test examples/basic/store.fga.yaml
moon run cmd/main -- test examples/abac/store.fga.yaml

#一致性测试复现

scripts/fetch-upstream.sh          # 首次运行，固定 commit
./scripts/conformance.sh           # 运行两个矩阵并检查 95/90 阈值
moon run cmd/language              # DSL <-> JSON 夹具，29/29

#与 jhshuai/moonpolicykit 的区别

• MoonFGA 直接回放 OpenFGA 官方 Check / ListObjects / ListUsers / ABAC 测试矩阵， 兼容性由上游用例定义，而不是自定义语义。
• 覆盖 OpenFGA schema 1.1 的 DSL、AuthorizationModel JSON、条件关系和 .fga.yaml 测试格式。
• 自带 OpenFGA 语义的 CEL 子集（含 timestamp、duration、ipaddress），不依赖通用策略表达式引擎。
• moonpolicykit 是另一个 MoonBit 策略/授权项目，它的能力与 API 以该项目文档为准； 两者不是替代关系。

#限制与路线图

1. 可插拔持久化存储与变更日志（ReadChanges）。
2. 服务端 API（HTTP/gRPC）与一致性偏好。
3. FGA modules 与模块级校验。
4. 扩展 CEL 标准库，错误定位更细。

#许可证