@lanaqi/rsr 0.0.1-rc.0

package/dist/security/blocker.d.ts

@@ -0,0 +1,14 @@
+import { type ComponentType, type PropsWithChildren } from 'react';
+import { type SecurityBundler } from './provider';
+/**
+ * 安全阻断器组件
+ * @param children 子组件
+ * @constructor
+ */
+export declare function SecurityBlocker({ children }: PropsWithChildren): import("react/jsx-runtime").JSX.Element;
+/**
+ * 安全阻断器包装
+ * @param Component 组件
+ * @param bundler 打包器
+ */
+export declare const withSecurityBlocker: (Component: ComponentType, bundler: SecurityBundler) => () => import("react/jsx-runtime").JSX.Element;

package/dist/security/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 提供者
+ */
+export * from './provider';
+/**
+ * 阻断器
+ */
+export * from './blocker';

package/dist/security/provider.d.ts

@@ -0,0 +1,31 @@
+import { type PropsWithChildren } from 'react';
+import type { AccessProvider } from '../access';
+import { AccessGuarderBuilder } from '../builder';
+/**
+ * 安全打包器
+ */
+export type SecurityBundler = (builder: AccessGuarderBuilder) => AccessProvider;
+/**
+ * 安全安装器
+ */
+export type SecurityInstaller = PropsWithChildren<{
+    /**
+     * 打包器
+     */
+    readonly bundler: SecurityBundler;
+}>;
+/**
+ * 安全上下文
+ */
+export declare const SecurityContext: import("react").Context<AccessProvider | null>;
+/**
+ * 安全上下文钩子
+ */
+export declare const useSecurityContext: () => AccessProvider;
+/**
+ * 安全提供者组件
+ * @param children 子组件
+ * @param bundler 打包器
+ * @constructor
+ */
+export declare function SecurityProvider({ children, bundler }: SecurityInstaller): import("react/jsx-runtime").JSX.Element;

package/dist/support/aaa.d.ts

@@ -0,0 +1,29 @@
+import type { AccessAuthentication, AccessAuthorization, AccessDatasheet, AuthenticationDatasheet, AuthorizationDatasheet } from '../access';
+/**
+ * 取得认证钩子
+ */
+export declare const useObtainAuthentication: () => (() => AccessAuthentication | undefined);
+/**
+ * 取得授权钩子
+ */
+export declare const useObtainAuthorization: () => (() => AccessAuthorization | undefined);
+/**
+ * 删除认证钩子
+ */
+export declare const useDeleteAuthentication: () => (() => void);
+/**
+ * 删除授权钩子
+ */
+export declare const useDeleteAuthorization: () => (() => void);
+/**
+ * 保存认证钩子
+ * @param navigate 是否导航
+ * @param redirect 重定向路径（如果不存在原始路径时使用）
+ */
+export declare const useSaveAuthentication: <Datasheet>(navigate?: boolean, redirect?: string) => ((datasheet: AccessDatasheet<AuthenticationDatasheet<Datasheet>>) => void);
+/**
+ * 保存授权钩子
+ * @param navigate 是否导航
+ * @param redirect 重定向路径（如果不存在原始路径时使用）
+ */
+export declare const useSaveAuthorization: <Datasheet>(navigate?: boolean, redirect?: string) => ((datasheet: AccessDatasheet<AuthorizationDatasheet<Datasheet>>) => void);

package/dist/support/blocker.d.ts

@@ -0,0 +1,28 @@
+import type { AccessPath, BlockHandler } from '../access';
+/**
+ * 自定义阻断器钩子
+ * @param handler 处理器
+ */
+export declare const useCustomBlocker: (handler: BlockHandler) => void;
+/**
+ * 安全阻断器钩子
+ * @param recover 是否恢复 blocked = false
+ */
+export declare const useSecurityBlocker: (recover?: boolean) => {
+    /**
+     * 是否已阻断
+     */
+    blocked: boolean;
+    /**
+     * 处理阻断（即继续访问）
+     */
+    proceed: () => void;
+    /**
+     * 重置阻断（即不再访问）
+     */
+    reset: () => void;
+    /**
+     * 阻断路径
+     */
+    path: AccessPath | undefined;
+};

package/dist/support/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 认证与授权
+ */
+export * from './aaa';
+/**
+ * 权限
+ */
+export * from './permission';
+/**
+ * 签名
+ */
+export * from './signature';
+/**
+ * 用户
+ */
+export * from './user';
+/**
+ * 阻断器
+ */
+export * from './blocker';

package/dist/support/permission.d.ts

@@ -0,0 +1,5 @@
+import type { AccessPermission, AccessPermissions } from '../access';
+/**
+ * 拥有权限钩子
+ */
+export declare const useHavePermission: () => ((term: AccessPermission | AccessPermissions) => boolean);

package/dist/support/signature.d.ts

@@ -0,0 +1,21 @@
+import type { AccessPath } from '../access';
+/**
+ * 保存签名钩子
+ * @param navigate 是否导航（默认：true）
+ * @param redirect 重定向路径（如果不存在原始路径时使用）
+ */
+export declare const useSaveSignature: (navigate?: boolean, redirect?: string) => ((path?: AccessPath) => void);
+/**
+ * 删除签名钩子
+ */
+export declare const useDeleteSignature: () => (() => void);
+/**
+ * 移除签名钩子
+ */
+export declare const useRemoveSignature: () => ((path: string | AccessPath) => void);
+/**
+ * 清除签名（当前路径）钩子
+ *
+ * 当触发销毁时执行清除
+ */
+export declare const usePurgeSignature: () => void;

package/dist/support/user.d.ts

@@ -0,0 +1,14 @@
+import type { AccessDatasheet, UserDatasheet } from '../access';
+/**
+ * 登出钩子
+ * @param navigate 是否导航（默认：true）
+ * @param redirect 重定向路径（如果不存在原始路径时使用）
+ */
+export declare const useLogout: (navigate?: boolean, redirect?: string) => (() => void);
+/**
+ * 登入钩子
+ * @param logined 已登录跳转
+ * @param navigate 是否导航（默认：true）
+ * @param redirect 重定向路径（如果不存在原始路径时使用）
+ */
+export declare const useLogin: <Datasheet>(logined?: boolean, navigate?: boolean, redirect?: string) => ((datasheet: AccessDatasheet<UserDatasheet<Datasheet>>) => void);

package/dist/warpper/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * 权限
+ */
+export * from './permission';

package/dist/warpper/permission.d.ts

@@ -0,0 +1,24 @@
+import type { ComponentType, PropsWithChildren } from 'react';
+import type { AccessPermission, AccessPermissions } from '../access';
+/**
+ * 权限条件
+ */
+export type PermissionTerm = PropsWithChildren<{
+    /**
+     * 条件
+     */
+    readonly term: AccessPermission | AccessPermissions;
+}>;
+/**
+ * 拥有权限组件
+ * @param children 子组件
+ * @param term 条件
+ * @constructor
+ */
+export declare function HavePermission({ children, term }: PermissionTerm): import("react/jsx-runtime").JSX.Element;
+/**
+ * 拥有权限包装
+ * @param Component 组件
+ * @param term 条件
+ */
+export declare const withHavePermission: (Component: ComponentType, term: AccessPermission | AccessPermissions) => () => import("react/jsx-runtime").JSX.Element;

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@lanaqi/rsr",
+  "version": "0.0.1-rc.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": ["dist"],
+  "keywords": [
+    "react",
+    "router",
+    "security",
+    "react-security",
+    "router-security",
+    "react-security-router",
+    "react-router-security",
+    "guard",
+    "react-guard",
+    "router-guard",
+    "react-router-guard",
+    "react-router",
+    "react-router-dom",
+    "modern-js",
+    "modernjs",
+    "安全",
+    "鉴权",
+    "守护",
+    "认证",
+    "授权",
+    "权限",
+    "安全框架",
+    "路由安全",
+    "认证授权",
+    "路由守护"
+  ],
+  "description": "React 安全路由器",
+  "scripts": {
+    "build": "rslib build",
+    "lint": "biome lint",
+    "check": "biome check",
+    "format": "biome format --write",
+    "release": "npm run build && npm publish"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^1.9.4",
+    "@rsbuild/plugin-react": "^1.1.1",
+    "@rslib/core": "^0.5.5",
+    "@types/react": "^18.3.19",
+    "@types/react-dom": "^18.3.5",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "react-router-dom": "^6.30.0",
+    "typescript": "^5.8.2"
+  },
+  "peerDependencies": {
+    "react": ">=17.0.0",
+    "react-dom": ">=17.0.0",
+    "react-router-dom": "^6.0.0"
+  },
+  "private": false,
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lanaqi-opensource/react-security-router.git"
+  }
+}