coze-studio/frontend/packages/common/auth/README.md

1.1 KiB

@coze-common/auth

统一的权限控制逻辑

Overview

This package is part of the Coze Studio monorepo and provides utilities functionality. It includes store.

Getting Started

Installation

Add this package to your package.json:

{
  "dependencies": {
    "@coze-common/auth": "workspace:*"
  }
}

Then run:

rush update

Usage

import { /* exported functions/components */ } from '@coze-common/auth';

// Example usage
// TODO: Add specific usage examples

Features

  • Store

API Reference

Exports

  • useDestorySpace
  • useSpaceAuth
  • ESpacePermisson, SpaceRoleType
  • useSpaceRole
  • useSpaceAuthStore
  • useProjectAuth
  • useDestoryProject
  • EProjectPermission, ProjectRoleType
  • useProjectRole
  • useProjectAuthStore

For detailed API documentation, please refer to the TypeScript definitions.

Development

This package is built with:

  • TypeScript
  • React
  • Vitest for testing
  • ESLint for code quality

Contributing

This package is part of the Coze Studio monorepo. Please follow the monorepo contribution guidelines.

License

Apache-2.0