Merge pull request #4 from softnetics/v2

feat: v2

Author: peam1146

.changeset/config.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://unpkg.com/@changesets/config@2.3.1/schema.json",
+  "$schema": "https://unpkg.com/@changesets/config@3.0.2/schema.json",
   "changelog": ["@changesets/changelog-github", { "repo": "softnetics/rbac" }],
   "commit": false,
   "fixed": [],

.changeset/lucky-humans-tap.md

@@ -0,0 +1,5 @@
+---
+"@softnetics/rbac": major
+---
+
+Support dynamic fine grain premission

.gitattributes

@@ -24,6 +24,7 @@ jobs:
   release:
     uses: softnetics/workflows/.github/workflows/release-packages.yaml@main
     with:
-      before-publish: yarn build
+      before-publish: bun
+      release-mode: tag
     secrets:
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/release.yaml

@@ -1,5 +1,38 @@
-.yarn/*
-release.sh
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# Dependencies
+node_modules
+.pnp
+.pnp.js
+
+# Local env files
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# Testing
+coverage
+
+# Turbo
+.turbo
+
+# Vercel
+.vercel
+
+# Build Outputs
+.next/
+out/
+build
 dist
 
-node_modules
+
+# Debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Misc
+.DS_Store
+*.pem

.gitignore

@@ -0,0 +1,44 @@
+pnpm-lock.yaml
+.changeset/**.md
+
+
+packages/bff-client/src/openapi.yaml
+# Dependencies
+node_modules
+.pnp
+.pnp.js
+
+# Local env files
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# Testing
+coverage
+
+# Turbo
+.turbo
+.linear
+
+# Vercel
+.vercel
+
+# Build Outputs
+.next/
+out/
+build
+dist
+tmp
+.goreload
+
+
+# Debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Misc
+.DS_Store
+*.pem

.npmrc

@@ -0,0 +1,2 @@
+import config from '@softnetics/project-config/prettier/base.js'
+export default config

.prettierignore

@@ -1,62 +1,81 @@
-# rbac
+# Turborepo starter
 
-O(1) type safe role based access control
+This is an official starter Turborepo.
 
-## Usage
+## Using this example
 
-create a policy
+Run the following command:
 
-```ts
-const policy = createPolicy({
-  name: 'todo',
-  permissions: {
-    todo: ['create', 'read', 'update', 'delete'],
-    comment: ['create', 'read', 'update'],
-  },
-  roles: {
-    viewer: ['todo.read', 'comment.read'],
-    editor: ['todo.create', 'todo.update', 'comment.create', 'comment.update'],
-  },
-})
+```sh
+npx create-turbo@latest
 ```
 
-permissions are defined as a map of resource to actions
-roles are defined as a map of role to permissions
+## What's inside?
 
-you also can use * to match all resources and actions
+This Turborepo includes the following packages/apps:
 
-```ts
-createPolicy({
-  name: 'todo',
-  permissions: {
-    todo: ['create', 'read', 'update', 'delete'],
-    comment: ['create', 'read', 'delete'],
-  },
-  roles: {
-    viewer: ['todo.read', 'comment.read'],
-    editor: ['todo.*', 'comment.delete'],
-    admin: '*',
-  },
-})
+### Apps and Packages
+
+- `docs`: a [Next.js](https://nextjs.org/) app
+- `web`: another [Next.js](https://nextjs.org/) app
+- `@repo/ui`: a stub React component library shared by both `web` and `docs` applications
+- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
+- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo
+
+Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
+
+### Utilities
+
+This Turborepo has some additional tools already setup for you:
+
+- [TypeScript](https://www.typescriptlang.org/) for static type checking
+- [ESLint](https://eslint.org/) for code linting
+- [Prettier](https://prettier.io) for code formatting
+
+### Build
+
+To build all apps and packages, run the following command:
+
+```
+cd my-turborepo
+pnpm build
 ```
 
-create a identity
+### Develop
 
-```ts
-const identity = createIdentity({
-  policies: [policy],
-  identities: {
-    student: ['todo.viewer'],
-    teacher: ['todo.editor', 'todo.viewer'],
-  },
-})
+To develop all apps and packages, run the following command:
+
+```
+cd my-turborepo
+pnpm dev
 ```
 
-identities are defined as a map of identity to roles
+### Remote Caching
 
-enforce a permission
+Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
 
-```ts
-identity.enforce('student', ['todo.todo.read']) // true
-identity.enforce('student', ['todo.todo.create']) // false
+By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup), then enter the following commands:
+
+```
+cd my-turborepo
+npx turbo login
+```
+
+This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
+
+Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:
+
+```
+npx turbo link
 ```
+
+## Useful Links
+
+Learn more about the power of Turborepo:
+
+- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
+- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
+- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
+- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
+- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
+- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)