@lark-apaas/auth-sdk 0.1.0-alpha.9 → 0.1.0-beta.1

package/README.md

@@ -16,7 +16,7 @@ yarn add @lark-apaas/auth-sdk
 
 ```tsx
 import React from 'react';
-import { AuthProvider, Can, useAuthAbility } from '@lark-apaas/auth-sdk';
+import { AuthProvider, CanRole, useAuthAbility } from '@lark-apaas/auth-sdk';
 
 export default function App() {
   return (
@@ -35,7 +35,8 @@ export default function App() {
 }
 ```
 
-### 开发组件 - 使用 Can 组件
+
+### 开发组件 - 使用 CanRole 组件
 
 ```tsx
 import { CanRole } from '@lark-apaas/auth-sdk';
@@ -72,31 +73,7 @@ function Home() {
 }
 ```
 
-### 开发组件 - 进阶示例
-
-### 菜单按权限过滤
-
-```tsx
-import { useContext } from 'react';
-import { AbilityContext } from '@lark-apaas/auth-sdk';
-
-const menus = [
-  { name: 'Dashboard', path: '/dashboard', p: { action: 'role_admin', subject: '@role' } },
-  { name: 'Users', path: '/users', p: { action: 'role_editor', subject: '@role' } },
-  { name: 'Settings', path: '/settings', p: { action: 'role_admin', subject: '@role' } },
-];
-
-function Nav() {
-  const ability = useContext(AbilityContext);
-  return (
-    <nav>
-      {menus.map(m => ability.can(m.p.action, m.p.subject) && (
-        <a key={m.path} href={m.path}>{m.name}</a>
-      ))}
-    </nav>
-  );
-} 
-```
+### 开发组件 - 见 Client Toolkit
 
 ---
 

package/lib/AuthProvider.d.ts

@@ -33,10 +33,9 @@ export interface AuthProviderProps {
  *
  * function App() {
  *   return (
- *     <AuthProvider userId="user-123" config={{
+ *     <AuthProvider config={{
  *       permissionApi: {
- *         baseUrl: 'http://localhost:3000',
- *         endpoint: '/mock-api/users/:userId/permissions'
+ *         url: '/app/app_xxx/__runtime__/api/v1/permissions/roles',
  *       }
  *     }}>
  *       <YourApp />

package/lib/AuthProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AuthProvider.d.ts","sourceRoot":"","sources":["../src/AuthProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAMN,MAAM,OAAO,CAAC;AACf,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAK7C;;GAEG;AACH,eAAO,MAAM,cAAc,uGAE1B,CAAC;AAEF;;;GAGG;AACH,UAAU,qBAAqB;IAC7B,OAAO,EAAE,YAAY,CAAC;IACtB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,gBAAgB,EAAE,CAAC,MAAM,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACtD;AAOD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,YAAY,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,iBAAiB,2CA2DnE;AAED;;;;;GAKG;AACH,wBAAsB,UAAU,CAC9B,mBAAmB,EAAE,aAAa,CAAC,eAAe,CAAC,2GAiBpD;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,OAAO,IAAI,qBAAqB,CAQ/C;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,cAAc,IAAI,YAAY,CAE7C;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,GAAG,sJAA+C,CAAC;AAEhE,eAAO,MAAM,UAAU,GAAa,WAAW;IAAE,KAAK,EAAE,MAAM,EAAE,CAAA;CAAE,KAAG,OAepE,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,OAAO,CAAC,EACtB,QAAQ,EACR,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB,kDAIA"}
+{"version":3,"file":"AuthProvider.d.ts","sourceRoot":"","sources":["../src/AuthProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAMN,MAAM,OAAO,CAAC;AACf,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAK7C;;GAEG;AACH,eAAO,MAAM,cAAc,uGAE1B,CAAC;AAEF;;;GAGG;AACH,UAAU,qBAAqB;IAC7B,OAAO,EAAE,YAAY,CAAC;IACtB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,gBAAgB,EAAE,CAAC,MAAM,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACtD;AAOD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,YAAY,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,iBAAiB,2CA8DnE;AAED;;;;;GAKG;AACH,wBAAsB,UAAU,CAC9B,mBAAmB,EAAE,aAAa,CAAC,eAAe,CAAC,2GAmBpD;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,OAAO,IAAI,qBAAqB,CAQ/C;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,cAAc,IAAI,YAAY,CAE7C;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,GAAG,sJAA+C,CAAC;AAEhE,eAAO,MAAM,UAAU,GAAa,WAAW;IAAE,KAAK,EAAE,MAAM,EAAE,CAAA;CAAE,KAAG,OASpE,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,OAAO,CAAC,EACtB,QAAQ,EACR,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB,kDAIA"}

package/lib/AuthProvider.js

@@ -1,6 +1,6 @@
 import { Fragment, jsx } from "react/jsx-runtime";
 import { createContext, useCallback, useContext, useEffect, useState } from "react";
-import { ROLE_SUBJECT, createAbility, updateAbility } from "./ability-factory.js";
+import { ROLE_SUBJECT, createAbility } from "./ability-factory.js";
 import { PermissionClient } from "./permission-client.js";
 import { createContextualCan } from "@casl/react";
 const AbilityContext = /*#__PURE__*/ createContext(createAbility({
@@ -9,18 +9,20 @@ const AbilityContext = /*#__PURE__*/ createContext(createAbility({
 }));
 const AuthStateContext = /*#__PURE__*/ createContext(null);
 function AuthProvider({ children, config }) {
-    const [ability] = useState(()=>createAbility({}));
+    const [ability, setAbility] = useState(()=>createAbility({}));
     const [isLoading, setIsLoading] = useState(false);
     const [error, setError] = useState(null);
-    const [client] = useState(()=>new PermissionClient(config?.permissionApi));
+    const [client] = useState(()=>config?.permissionApi ? new PermissionClient(config.permissionApi) : null);
     const fetchPermissions = useCallback(async ()=>{
+        if (!client) return;
         setIsLoading(true);
         setError(null);
         try {
             const data = await client.fetchPermissions();
-            updateAbility(ability, {
+            const newAbility = createAbility({
                 roles: data.roles
             });
+            setAbility(newAbility);
             config?.onSuccess?.(data);
         } catch (err) {
             const error = err instanceof Error ? err : new Error(String(err));
@@ -30,7 +32,6 @@ function AuthProvider({ children, config }) {
             setIsLoading(false);
         }
     }, [
-        ability,
         client,
         config
     ]);
@@ -55,18 +56,18 @@ function AuthProvider({ children, config }) {
     });
 }
 async function getAbility(permissionApiConfig) {
-    const ability = createAbility({});
+    if (!permissionApiConfig) return new Error('permissionApi config is required');
     const client = new PermissionClient(permissionApiConfig);
     try {
         const data = await client.fetchPermissions();
-        updateAbility(ability, {
+        const ability = createAbility({
             roles: data.roles
         });
+        return ability;
     } catch (err) {
         const error = err instanceof Error ? err : new Error(String(err));
         return error;
     }
-    return ability;
 }
 function useAuth() {
     const context = useContext(AuthStateContext);
@@ -78,9 +79,7 @@ function useAuthAbility() {
 }
 const Can = createContextualCan(AbilityContext.Consumer);
 const useCanRole = function({ roles }) {
-    const context = useContext(AuthStateContext);
-    if (!context) return false;
-    const { ability } = context;
+    const ability = useContext(AbilityContext);
     const allowed = !roles || 0 === roles.length || roles.length > 0 && roles.some((role)=>ability.can(role, ROLE_SUBJECT));
     return !!allowed;
 };

package/lib/permission-client.d.ts

@@ -4,7 +4,7 @@ import type { PermissionApiConfig, PermissionApiResponse } from './types';
  */
 export declare class PermissionClient {
     private config;
-    constructor(config?: PermissionApiConfig);
+    constructor(config: PermissionApiConfig);
     /**
      * 获取用户权限数据
      */

package/lib/permission-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"permission-client.d.ts","sourceRoot":"","sources":["../src/permission-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAU1E;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,MAAM,CAAsB;gBAExB,MAAM,CAAC,EAAE,mBAAmB;IAOxC;;OAEG;IACG,gBAAgB,IAAI,OAAO,CAAC,qBAAqB,CAAC;IAyDxD;;OAEG;IACH,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,IAAI;IAOxD;;OAEG;IACH,SAAS,IAAI,mBAAmB;CAGjC"}
+{"version":3,"file":"permission-client.d.ts","sourceRoot":"","sources":["../src/permission-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAE1E;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,MAAM,CAAsB;gBAExB,MAAM,EAAE,mBAAmB;IAIvC;;OAEG;IACG,gBAAgB,IAAI,OAAO,CAAC,qBAAqB,CAAC;IAkDxD;;OAEG;IACH,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,IAAI;IAOxD;;OAEG;IACH,SAAS,IAAI,mBAAmB;CAGjC"}

package/lib/permission-client.js

@@ -1,22 +1,13 @@
-const DEFAULT_CONFIG = {
-    baseUrl: '',
-    timeout: 5000
-};
 class PermissionClient {
     constructor(config){
-        this.config = {
-            ...DEFAULT_CONFIG,
-            ...config
-        };
+        this.config = config;
     }
     async fetchPermissions() {
-        const { timeout = DEFAULT_CONFIG.timeout, headers = {} } = this.config;
-        const { appId } = window;
-        if (!appId) throw new Error('appId is required');
-        const url = `/spark/app/${appId}/runtime/api/v1/permissions/roles`;
+        const { url, timeout = 5000, headers = {} } = this.config;
         const requestHeaders = {
+            ...headers,
             'Content-Type': 'application/json',
-            ...headers
+            'X-Suda-Csrf-Token': window.csrfToken || ''
         };
         const controller = new AbortController();
         const timeoutId = setTimeout(()=>controller.abort(), timeout);

package/lib/types.d.ts

@@ -1,3 +1,10 @@
+declare global {
+    interface Window {
+        appId?: string;
+        csrfToken?: string;
+        userID?: string;
+    }
+}
 /**
  * 权限操作类型
  */
@@ -35,10 +42,9 @@ export interface PermissionApiResponse {
  */
 export interface PermissionApiConfig {
     /**
-     * API 基础 URL
-     * @default ''
+     * 权限接口完整 URL，由上层注入，不在 SDK 内部硬编码
      */
-    baseUrl?: string;
+    url: string;
     /**
      * 请求超时时间（毫秒）
      * @default 5000

package/lib/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,MAAM,GACd,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,MAAM,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,OAAO,CAAC;IACb,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAC;IAEpC;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,qBAAqB,KAAK,IAAI,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC1B,OAAO,EAAE,OAAO,GAAG,OAAO,EAAE,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,GACd,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,MAAM,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,OAAO,CAAC;IACb,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAC;IAEpC;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,qBAAqB,KAAK,IAAI,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC1B,OAAO,EAAE,OAAO,GAAG,OAAO,EAAE,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lark-apaas/auth-sdk",
-  "version": "0.1.0-alpha.9",
+  "version": "0.1.0-beta.1",
   "description": "基于 CASL 的前端鉴权 SDK",
   "types": "./lib/index.d.ts",
   "main": "./lib/index.js",
@@ -15,11 +15,12 @@
   "scripts": {
     "build": "rslib build",
     "dev": "rslib build --watch",
-    "type-check": "tsc --noEmit"
+    "type-check": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@casl/ability": "^6.7.1",
-    "@casl/react": "^4.0.0"
+    "@casl/ability": "^6.7.5",
+    "@casl/react": "^5.0.0"
   },
   "devDependencies": {
     "@rsbuild/core": "~1.4.13",