@lanaqi/rsr 0.0.1 → 0.0.3

package/README.md

@@ -2,9 +2,17 @@
 
 React 安全路由器
 
+# 如何安装
+
+```bash
+
+npm add @lanaqi/rsr -S
+
+```
+
 # 框架说明
 
-rsr 是 react security router 的简写，一个基于 react router 实现路由级别控制的安全框架。
+rsr 是 react security router 的简写，一个基于 react router 实现纯前端路由级别控制的安全框架。
 
 功能简介：
 
@@ -13,37 +21,53 @@ rsr 是 react security router 的简写，一个基于 react router 实现路由
 - 二次签证（签名：如要求再次输入密码等）
 - 等等
 
+注意: 该框架没有编写相关文档，需要自行看源码（注释）和例子。
+
 # 版本兼容
 
-注意：目前只兼容 react router v6 & v7 版本，其它的版本，暂时不考虑兼容。
+注意：目前 0.0.3 + 版本只支持 react 19 + ，另外只兼容 react router v7 (react-router) 版本 (并非：react-router-dom)，其它的版本，暂时不考虑兼容。
 
 # 简单例子
 
-``` tsx
-
-export default withSecurityBlocker(Root, bundler => {
-    return bundler
-        .context(builder => {
-            return builder
-                // 可选层级权限
-                // .hierarchy('superadmin>admin;admin>users;users>guest')
-                .resource(rb => rb.patterns('/login', '/logout', '/denied', '/signature').anonymous().build())
-                .resource(rb => rb.patterns('/sheet').permissions('admin').signatured().build())
-                .resource(rb => rb.patterns('/*').authenticated().build())
-                .build();
-        })
-        .manager(builder => {
-            return builder
-                .behave({
-                    notAuthenticationPath: '/login',
-                    notSignaturePath: '/signature',
-                    accessDeniedPath: '/denied',
-                })
-                .build();
-        })
-        // .addons()
-        .build()
-
+```tsx
+export default withSecurityBlocker(Root, (bundler) => {
+  return (
+    bundler
+      .context((builder) => {
+        return (
+          builder
+            // 可选层级权限
+            // .hierarchy('superadmin>admin;admin>users;users>guest')
+            .resource((rb) =>
+              rb
+                .patterns("/login", "/logout", "/denied", "/signature")
+                .anonymous()
+                .build(),
+            )
+            .resource((rb) =>
+              rb.patterns("/sheet").permissions("admin").signatured().build(),
+            )
+            .resource((rb) => rb.patterns("/*").authenticated().build())
+            .build()
+        );
+      })
+      .manager((builder) => {
+        return builder
+          .behave({
+            notAuthenticationPath: "/login",
+            notSignaturePath: "/signature",
+            accessDeniedPath: "/denied",
+          })
+          .build();
+      })
+      // .addons()
+      .build()
+  );
 });
-
 ```
+
+# 其它例子
+
+基于 Modern.js 的例子：https://github.com/lanaqi-opensource/rsr-demo
+
+基于 react-router 的例子：https://github.com/lanaqi-opensource/rsr6-demo

package/dist/access/blocker.d.ts

@@ -28,7 +28,7 @@ export interface AccessBlocker {
      * 注销处理器
      * @param handler 处理器
      */
-    unregister(handler: BlockHandler): void;
+    unregister(handler?: BlockHandler): void;
 }
 /**
  * 单一阻断器
@@ -55,7 +55,7 @@ export declare class SingleBlocker implements AccessBlocker {
      * 注销处理器
      * @param handler 处理器
      */
-    unregister(handler: BlockHandler): void;
+    unregister(handler?: BlockHandler): void;
 }
 /**
  * 多个阻断器
@@ -86,7 +86,7 @@ export declare class MultiBlocker implements AccessBlocker {
      * 注销处理器
      * @param handler 处理器
      */
-    unregister(handler: BlockHandler): void;
+    unregister(handler?: BlockHandler): void;
     /**
      * 清理处理器集合
      */

package/dist/access/resource.d.ts

@@ -87,23 +87,23 @@ export declare class SimpleResource implements AccessResource {
     /**
      * 权限：匿名的
      */
-    static readonly PERMISSION_ANONYMOUS = "__anonymous__";
+    static readonly PERMISSION_ANONYMOUS = "__aqi_rsr_anonymous";
     /**
      * 权限：已认证
      */
-    static readonly PERMISSION_AUTHENTICATED = "__authenticated__";
+    static readonly PERMISSION_AUTHENTICATED = "__aqi_rsr_authenticated";
     /**
      * 权限：已授权
      */
-    static readonly PERMISSION_AUTHORIZED = "__authorized__";
+    static readonly PERMISSION_AUTHORIZED = "__aqi_rsr_authorized";
     /**
      * 标签：已签名
      */
-    static readonly LABEL_SIGNATURED = "__signatured__";
+    static readonly LABEL_SIGNATURED = "__aqi_rsr_signatured";
     /**
      * 标签：始终签名
      */
-    static readonly LABEL_ALWAYS_SIGNATURE = "__always_signature__";
+    static readonly LABEL_ALWAYS_SIGNATURE = "__aqi_rsr_always_signature";
     /**
      * 模式集合
      * @private

package/dist/access/storer.d.ts

@@ -81,15 +81,15 @@ export declare class SimpleStorer implements AccessStorer {
     /**
      * 存储健：认证
      */
-    static readonly KEY_AUTHENTICATION = "__authentication__";
+    static readonly KEY_AUTHENTICATION = "__aqi_rsr_authentication";
     /**
      * 存储健：授权
      */
-    static readonly KEY_AUTHORIZATION = "__authorization__";
+    static readonly KEY_AUTHORIZATION = "__aqi_rsr_authorization";
     /**
      * 存储健：签名
      */
-    static readonly KEY_SIGNATURE = "__signature__";
+    static readonly KEY_SIGNATURE = "__aqi_rsr_signature";
     /**
      * 认证与授权存储
      * @private

package/dist/bridge.d.ts

@@ -1,8 +1,8 @@
 /**
  * 桥接引用的函数和钩子
  */
-export { matchPath, useBlocker, useLocation, useNavigate } from 'react-router-dom';
+export { matchPath, useBlocker, useLocation, useNavigate } from 'react-router';
 /**
  * 桥接引用的类型
  */
-export type { PathPattern, NavigateFunction, NavigateOptions, To, Path } from 'react-router-dom';
+export type { PathPattern, NavigateFunction, NavigateOptions, To, Path } from 'react-router';