@lark-apaas/auth-sdk 0.1.0-alpha.60 → 0.1.0-alpha.61

package/README.md

@@ -16,7 +16,7 @@ yarn add @lark-apaas/auth-sdk
 
 ```tsx
 import React from 'react';
-import { AuthProvider, CanRole, useAuthAbility } from '@lark-apaas/auth-sdk';
+import { AuthProvider, CanRole, useAuth } from '@lark-apaas/auth-sdk';
 
 export default function App() {
   return (

package/lib/AuthProvider.d.ts

@@ -74,25 +74,6 @@ export declare function getAbility(permissionApiConfig: AuthSdkConfig['permissio
  * ```
  */
 export declare function useAuth(): AuthStateContextValue;
-/**
- * useAuthAbility Hook - 获取 Ability 实例
- *
- * @example
- * ```tsx
- * import { useAuthAbility } from '@lark-apaas/auth-sdk';
- *
- * function MyComponent() {
- *   const ability = useAuthAbility();
- *
- *   return (
- *     <button disabled={ability.cannot('create', 'Task')}>
- *       Create Task
- *     </button>
- *   );
- * }
- * ```
- */
-export declare function useAuthAbility(): MongoAbility;
 /**
  * Can Component - 基于 Ability 实例的条件渲染组件
  *
@@ -110,11 +91,11 @@ export declare function useAuthAbility(): MongoAbility;
  * ```
  */
 export declare const Can: React.FunctionComponent<import("@casl/react").BoundCanProps<MongoAbility<import("@casl/ability").AbilityTuple, import("@casl/ability").MongoQuery>>>;
-export declare const useCanRole: ({ roles }: {
-    roles: string[];
-}) => boolean;
 /**
- * CanRole Component - 基于 Ability 实例的角色条件渲染组件
+ * CanRole Component - 基于角色的条件渲染组件
+ *
+ * 支持 fallback prop，用于在权限加载期间显示自定义内容（如 Loading），
+ * 避免加载期间因 can() 返回 false 而误判为无权限。
  *
  * @example
  * ```tsx
@@ -122,16 +103,17 @@ export declare const useCanRole: ({ roles }: {
  *
  * function MyComponent() {
  *   return (
- *     <CanRole roles={['role_admin', 'role_editor']}>
- *       <TaskList />
+ *     <CanRole roles={['admin']} fallback={<Loading />}>
+ *       <AdminPanel />
  *     </CanRole>
  *   );
  * }
  * ```
  */
-export declare function CanRole({ children, roles, }: {
+export declare function CanRole({ children, roles, fallback, }: {
     children: React.ReactNode;
     roles: string[];
+    fallback?: React.ReactNode;
 }): import("react/jsx-runtime").JSX.Element | null;
 export {};
 //# sourceMappingURL=AuthProvider.d.ts.map

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;;;;;;;;;;;;;;;;;;;;;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"}
+{"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,2CAiEnE;AAED;;;;;GAKG;AACH,wBAAsB,UAAU,CAC9B,mBAAmB,EAAE,aAAa,CAAC,eAAe,CAAC,2GAmBpD;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,OAAO,IAAI,qBAAqB,CAQ/C;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,GAAG,sJAA+C,CAAC;AAoBhE;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,OAAO,CAAC,EACtB,QAAQ,EACR,KAAK,EACL,QAAe,GAChB,EAAE;IACD,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC5B,kDAKA"}

package/lib/AuthProvider.js

@@ -10,9 +10,9 @@ const AbilityContext = /*#__PURE__*/ createContext(createAbility({
 const AuthStateContext = /*#__PURE__*/ createContext(null);
 function AuthProvider({ children, config }) {
     const [ability, setAbility] = useState(()=>createAbility({}));
-    const [isLoading, setIsLoading] = useState(false);
-    const [error, setError] = useState(null);
     const [client] = useState(()=>config?.permissionApi ? new PermissionClient(config.permissionApi) : null);
+    const [isLoading, setIsLoading] = useState(()=>config?.enable !== false && null !== client);
+    const [error, setError] = useState(null);
     const fetchPermissions = useCallback(async ()=>{
         if (!client) return;
         setIsLoading(true);
@@ -74,21 +74,25 @@ function useAuth() {
     if (!context) throw new Error('useAuth must be used within an AuthProvider');
     return context;
 }
-function useAuthAbility() {
-    return useContext(AbilityContext);
-}
 const Can = createContextualCan(AbilityContext.Consumer);
-const useCanRole = function({ roles }) {
+function useCanRole({ roles }) {
     const ability = useContext(AbilityContext);
+    const authState = useContext(AuthStateContext);
     const allowed = !roles || 0 === roles.length || roles.length > 0 && roles.some((role)=>ability.can(role, ROLE_SUBJECT));
-    return !!allowed;
-};
-function CanRole({ children, roles }) {
-    const allowed = useCanRole({
+    return {
+        allowed: !!allowed,
+        isLoading: authState?.isLoading ?? false
+    };
+}
+function CanRole({ children, roles, fallback = null }) {
+    const { allowed, isLoading } = useCanRole({
         roles
     });
+    if (isLoading) return /*#__PURE__*/ jsx(Fragment, {
+        children: fallback
+    });
     return allowed ? /*#__PURE__*/ jsx(Fragment, {
         children: children
     }) : null;
 }
-export { AbilityContext, AuthProvider, Can, CanRole, getAbility, useAuth, useAuthAbility, useCanRole };
+export { AbilityContext, AuthProvider, Can, CanRole, getAbility, useAuth };

package/lib/index.d.ts

@@ -7,6 +7,6 @@
 export type { PermissionApiResponse, PermissionApiConfig, AuthSdkConfig, } from './types';
 export { ROLE_SUBJECT } from './ability-factory';
 export { PermissionClient } from './permission-client';
-export { AuthProvider, useAuth, CanRole, AbilityContext } from './AuthProvider';
+export { AuthProvider, useAuth, CanRole, AbilityContext, } from './AuthProvider';
 export type { AuthProviderProps } from './AuthProvider';
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,YAAY,EACV,qBAAqB,EACrB,mBAAmB,EACnB,aAAa,GACd,MAAM,SAAS,CAAC;AAGjB,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAGvD,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhF,YAAY,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,YAAY,EACV,qBAAqB,EACrB,mBAAmB,EACnB,aAAa,GACd,MAAM,SAAS,CAAC;AAGjB,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAGvD,OAAO,EACL,YAAY,EACZ,OAAO,EACP,OAAO,EACP,cAAc,GACf,MAAM,gBAAgB,CAAC;AAExB,YAAY,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC"}

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;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"}
+{"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;AAG1E;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,MAAM,CAAsB;gBAExB,MAAM,EAAE,mBAAmB;IAIvC;;OAEG;IACG,gBAAgB,IAAI,OAAO,CAAC,qBAAqB,CAAC;IAoDxD;;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,3 +1,4 @@
+import { slardar } from "@lark-apaas/internal-slardar";
 class PermissionClient {
     constructor(config){
         this.config = config;
@@ -27,7 +28,17 @@ class PermissionClient {
             };
         } catch (error) {
             clearTimeout(timeoutId);
-            if (error instanceof Error && 'AbortError' === error.name) throw new Error(`Permission API request timeout after ${timeout}ms`);
+            if (error instanceof Error && 'AbortError' === error.name) {
+                slardar.captureException(error, {
+                    source: 'auth-sdk',
+                    type: 'timeout'
+                });
+                throw new Error(`Permission API request timeout after ${timeout}ms`);
+            }
+            slardar.captureException(error, {
+                source: 'auth-sdk',
+                type: 'fetch'
+            });
             throw error;
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lark-apaas/auth-sdk",
-  "version": "0.1.0-alpha.60",
+  "version": "0.1.0-alpha.61",
   "description": "基于 CASL 的前端鉴权 SDK",
   "types": "./lib/index.d.ts",
   "main": "./lib/index.js",
@@ -20,7 +20,8 @@
   },
   "dependencies": {
     "@casl/ability": "^6.7.5",
-    "@casl/react": "^5.0.0"
+    "@casl/react": "^5.0.0",
+    "@lark-apaas/internal-slardar": "^0.0.3"
   },
   "devDependencies": {
     "@rsbuild/core": "~1.4.13",