@lanaqi/rsr 0.0.1-rc.0

package/dist/access/guarder.d.ts

@@ -0,0 +1,173 @@
+import type { AccessAddons } from './addon';
+import { AccessBehave, AccessDecision, type AccessPath } from './common';
+import type { AccessContext } from './context';
+import type { AccessManager } from './manager';
+/**
+ * 访问守护器
+ */
+export interface AccessGuarder {
+    /**
+     * 守护决策
+     * @param blockPath 阻断路径
+     */
+    guardDecision(blockPath: AccessPath): AccessDecision;
+    /**
+     * 守护处理
+     * @param currentDecision 当前决策
+     * @param beforeDecision 之前决策
+     */
+    guardHandle(currentDecision: AccessDecision, beforeDecision?: AccessDecision): AccessBehave;
+    /**
+     * 守护阻断
+     * @param currentPath 当前路径
+     * @return 是否阻断
+     */
+    guardBlock(currentPath: AccessPath): boolean;
+    /**
+     * 守护之前
+     * @param currentPath 当前路径
+     */
+    guardBefore(currentPath: AccessPath): void;
+    /**
+     * 守护之后
+     * @param currentPath 当前路径
+     * @param currentDecision 当前决策
+     */
+    guardAfter(currentPath: AccessPath, currentDecision: AccessDecision): void;
+    /**
+     * 许可之前
+     * @param stayPath 停留路径
+     * @param blockPath 阻断路径
+     */
+    permitBefore(stayPath: AccessPath, blockPath: AccessPath): void;
+    /**
+     * 许可之前
+     * @param stayPath 停留路径
+     * @param blockPath 阻断路径
+     */
+    permitAfter(stayPath: AccessPath, blockPath: AccessPath): void;
+}
+/**
+ * 简单守护器
+ */
+export declare class SimpleGuarder implements AccessGuarder {
+    /**
+     * 上下文
+     * @private
+     */
+    private readonly context;
+    /**
+     * 管理器
+     * @private
+     */
+    private readonly manager;
+    /**
+     * 插件集合
+     * @private
+     */
+    private readonly addons;
+    /**
+     * 构造函数
+     * @param context 上下文
+     * @param manager 管理器
+     */
+    constructor(context: AccessContext, manager: AccessManager, addons: AccessAddons);
+    /**
+     * 守护决策
+     * @param blockPath 阻断路径
+     */
+    guardDecision(blockPath: AccessPath): AccessDecision;
+    /**
+     * 守护处理
+     * @param currentDecision 当前决策
+     * @param beforeDecision 之前决策
+     */
+    guardHandle(currentDecision: AccessDecision, beforeDecision?: AccessDecision): AccessBehave;
+    /**
+     * 守护阻断
+     * @param currentPath 当前路径
+     * @return 是否阻断
+     */
+    guardBlock(currentPath: AccessPath): boolean;
+    /**
+     * 守护之前
+     * @param currentPath 当前路径
+     */
+    guardBefore(currentPath: AccessPath): void;
+    /**
+     * 守护之后
+     * @param currentPath 当前路径
+     * @param currentDecision 当前决策
+     */
+    guardAfter(currentPath: AccessPath, currentDecision: AccessDecision): void;
+    /**
+     * 许可之前
+     * @param stayPath 停留路径
+     * @param blockPath 阻断路径
+     */
+    permitBefore(stayPath: AccessPath, blockPath: AccessPath): void;
+    /**
+     * 许可之后
+     * @param stayPath 停留路径
+     * @param blockPath 阻断路径
+     */
+    permitAfter(stayPath: AccessPath, blockPath: AccessPath): void;
+    /**
+     * 遍历插件集合
+     * @param fn 执行插件函数
+     */
+    private forAddons;
+    /**
+     * 取得资源
+     * @param path 路径
+     * @private
+     */
+    private obtainResource;
+    /**
+     * 取得认证
+     * @private
+     */
+    private obtainAuthentication;
+    /**
+     * 检查认证
+     * @param authentication 认证
+     * @private
+     */
+    private checkAuthentication;
+    /**
+     * 取得授权
+     * @param authentication 认证 | undefined
+     * @private
+     */
+    private obtainAuthorization;
+    /**
+     * 检查授权
+     * @param resource 资源
+     * @param authorization 授权
+     * @private
+     */
+    private checkPermission;
+    /**
+     * 检查签名
+     * @param path 路径
+     * @param authentication 认证
+     * @param authorization 授权
+     * @private
+     */
+    private checkSignature;
+    /**
+     * 清理签名
+     * @param stayPath 停留路径
+     * @param stayResource 停留资源
+     * @private
+     */
+    private clearSignature;
+}
+/**
+ * 访问提供者
+ */
+export type AccessProvider = {
+    context: AccessContext;
+    manager: AccessManager;
+    guarder: AccessGuarder;
+};

package/dist/access/handler.d.ts

@@ -0,0 +1,183 @@
+import { AccessBehave, AccessDecision, type AccessPath } from './common';
+import type { AccessContext } from './context';
+/**
+ * 访问处理器
+ */
+export interface AccessHandler {
+    /**
+     * 没有资源
+     * @param context 上下文
+     */
+    notResource(context: AccessContext): AccessBehave;
+    /**
+     * 没有认证
+     * @param context 上下文
+     */
+    notAuthentication(context: AccessContext): AccessBehave;
+    /**
+     * 无效认证
+     * @param context 上下文
+     */
+    invalidAuthentication(context: AccessContext): AccessBehave;
+    /**
+     * 没有授权
+     * @param context 上下文
+     */
+    notAuthorization(context: AccessContext): AccessBehave;
+    /**
+     * 没有签名
+     * @param context 上下文
+     */
+    notSignature(context: AccessContext): AccessBehave;
+    /**
+     * 访问拒绝
+     * @param context 上下文
+     */
+    accessDenied(context: AccessContext): AccessBehave;
+    /**
+     * 允许访问
+     * @param context 上下文
+     */
+    allowAccess(context: AccessContext): AccessBehave;
+    /**
+     * 错误决策
+     * @param context 上下文
+     * @param decision 决策
+     */
+    errorDecision(context: AccessContext, decision: AccessDecision): void;
+}
+/**
+ * 行为路径
+ */
+export type BehavePath = string | Partial<AccessPath>;
+/**
+ * 行为配置
+ */
+export type BehaveConfig = {
+    /**
+     * 没有资源路径值
+     */
+    readonly notResourcePath?: BehavePath;
+    /**
+     * 没有资源函数
+     * @param context 上下文
+     */
+    readonly notResourceFunc?: (context: AccessContext) => AccessBehave;
+    /**
+     * 没有认证路径值
+     */
+    readonly notAuthenticationPath?: BehavePath;
+    /**
+     * 没有认证函数
+     * @param context 上下文
+     */
+    readonly notAuthenticationFunc?: (context: AccessContext) => AccessBehave;
+    /**
+     * 无效认证路径值
+     */
+    readonly invalidAuthenticationPath?: BehavePath;
+    /**
+     * 无效认证函数
+     * @param context 上下文
+     */
+    readonly invalidAuthenticationFunc?: (context: AccessContext) => AccessBehave;
+    /**
+     * 没有授权路径值
+     */
+    readonly notAuthorizationPath?: BehavePath;
+    /**
+     * 没有授权函数
+     * @param context 上下文
+     */
+    readonly notAuthorizationFunc?: (context: AccessContext) => AccessBehave;
+    /**
+     * 没有签名路径值
+     */
+    readonly notSignaturePath?: BehavePath;
+    /**
+     * 没有签名函数
+     * @param context 上下文
+     */
+    readonly notSignatureFunc?: (context: AccessContext) => AccessBehave;
+    /**
+     * 拒绝访问路径值
+     */
+    readonly accessDeniedPath?: BehavePath;
+    /**
+     * 拒绝访问函数
+     * @param context 上下文
+     */
+    readonly accessDeniedFunc?: (context: AccessContext) => AccessBehave;
+    /**
+     * 允许访问函数
+     * @param context 上下文
+     */
+    readonly allowAccessFunc?: (context: AccessContext) => void;
+    /**
+     * 错误决策函数
+     * @param context 上下文
+     * @param decision 决策
+     */
+    readonly errorDecisionFunc?: (context: AccessContext, decision: AccessDecision) => void;
+};
+/**
+ * 行为处理器
+ */
+export declare class BehaveHandler implements AccessHandler {
+    /**
+     * 行为配置
+     * @private
+     */
+    private _config;
+    /**
+     * 构造函数
+     * @param config 行为配置
+     */
+    constructor(config: BehaveConfig);
+    /**
+     * 覆盖配置
+     * @param config 行为配置
+     */
+    config(config: BehaveConfig): void;
+    /**
+     * 没有资源
+     * @param context 上下文
+     */
+    notResource(context: AccessContext): AccessBehave;
+    /**
+     * 没有认证
+     * @param context 上下文
+     */
+    notAuthentication(context: AccessContext): AccessBehave;
+    /**
+     * 无效认证
+     * @param context 上下文
+     */
+    invalidAuthentication(context: AccessContext): AccessBehave;
+    /**
+     * 没有授权
+     * @param context 上下文
+     */
+    notAuthorization(context: AccessContext): AccessBehave;
+    /**
+     * 没有签名
+     * @param context 上下文
+     */
+    notSignature(context: AccessContext): AccessBehave;
+    /**
+     * 拒绝访问
+     * @param context 上下文
+     */
+    accessDenied(context: AccessContext): AccessBehave;
+    /**
+     * 允许访问
+     * @param context 上下文
+     */
+    allowAccess(context: AccessContext): AccessBehave;
+    /**
+     * 错误决策
+     * @param context 上下文
+     * @param decision 决策
+     */
+    errorDecision(context: AccessContext, decision: AccessDecision): void;
+}

package/dist/access/index.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 公共
+ */
+export * from './common';
+/**
+ * 认证与授权
+ */
+export * from './aaa';
+/**
+ * 资源
+ */
+export * from './resource';
+/**
+ * 记录器
+ */
+export * from './recorder';
+/**
+ * 投票器
+ */
+export * from './voter';
+/**
+ * 存储器
+ */
+export * from './storer';
+/**
+ * 匹配器
+ */
+export * from './matcher';
+/**
+ * 导航器
+ */
+export * from './navigator';
+/**
+ * 上下文
+ */
+export * from './context';
+/**
+ * 插件
+ */
+export * from './addon';
+/**
+ * 处理器
+ */
+export * from './handler';
+/**
+ * 阻断器
+ */
+export * from './blocker';
+/**
+ * 管理器
+ */
+export * from './manager';
+/**
+ * 守护器
+ */
+export * from './guarder';

package/dist/access/manager.d.ts

@@ -0,0 +1,109 @@
+import type { AccessBlocker } from './blocker';
+import type { AccessHandler } from './handler';
+/**
+ * 访问管理器
+ */
+export interface AccessManager {
+    /**
+     * 是否已禁用
+     */
+    isDisabled(): boolean;
+    /**
+     * 设置已禁用
+     */
+    setDisabled(disabled: boolean): void;
+    /**
+     * 获取处理器
+     */
+    getHandler(): AccessHandler;
+    /**
+     * 设置处理器
+     * @param handler 处理器
+     */
+    setHandler(handler: AccessHandler): void;
+    /**
+     * 获取阻断器
+     */
+    getBlocker(): AccessBlocker;
+    /**
+     * 设置阻断器
+     * @param blocker 阻断器
+     */
+    setBlocker(blocker: AccessBlocker): void;
+    /**
+     * 获取父级
+     */
+    getParent(): AccessManager | undefined;
+    /**
+     * 设置父级
+     * @param parent 父级
+     */
+    setParent(parent: AccessManager): void;
+}
+/**
+ * 简单管理器
+ */
+export declare class SimpleManager implements AccessManager {
+    /**
+     * 已禁用
+     * @private
+     */
+    private disabled;
+    /**
+     * 处理器
+     * @private
+     */
+    private handler;
+    /**
+     * 阻断器
+     * @private
+     */
+    private blocker;
+    /**
+     * 父级
+     * @private
+     */
+    private parent?;
+    /**
+     * 构造函数
+     * @param disabled 已禁用
+     * @param handler 处理器
+     * @param blocker 阻断器
+     */
+    constructor(disabled: boolean, handler: AccessHandler, blocker: AccessBlocker);
+    /**
+     * 获取是否已禁用
+     */
+    isDisabled(): boolean;
+    /**
+     * 设置是否已禁用
+     */
+    setDisabled(disabled: boolean): void;
+    /**
+     * 获取处理器
+     */
+    getHandler(): AccessHandler;
+    /**
+     * 设置处理器
+     * @param handler 处理器
+     */
+    setHandler(handler: AccessHandler): void;
+    /**
+     * 获取阻断器
+     */
+    getBlocker(): AccessBlocker;
+    /**
+     * 设置阻断器
+     * @param blocker 阻断器
+     */
+    setBlocker(blocker: AccessBlocker): void;
+    /**
+     * 获取父级
+     */
+    getParent(): AccessManager | undefined;
+    /**
+     * 设置父级
+     * @param parent 父级
+     */
+    setParent(parent?: AccessManager): void;
+}

package/dist/access/matcher.d.ts

@@ -0,0 +1,70 @@
+import type { AccessPath } from './common';
+import type { AccessResource, AccessResources } from './resource';
+/**
+ * 访问匹配器
+ */
+export interface AccessMatcher {
+    /**
+     * 进行匹配
+     * @param resource 资源
+     * @param path 路径
+     */
+    match(resource: AccessResource, path: AccessPath): boolean;
+    /**
+     * 取得资源
+     * @param path 路径
+     */
+    obtain(path: AccessPath): AccessResource | null;
+    /**
+     * 获取基础路径
+     */
+    getBasename(): string | undefined;
+    /**
+     * 设置基础路径
+     */
+    setBasename(basename: string | undefined): void;
+}
+/**
+ * 简单匹配器
+ */
+export declare class SimpleMatcher implements AccessMatcher {
+    /**
+     * 缓存资源
+     * @private
+     */
+    private readonly cache;
+    /**
+     * 资源集合
+     * @private
+     */
+    private readonly resources;
+    /**
+     * 基础路径
+     * @private
+     */
+    private basename?;
+    /**
+     * 构造函数
+     * @param resources 资源集合
+     */
+    constructor(resources: AccessResources);
+    /**
+     * 进行匹配
+     * @param resource 资源
+     * @param path 路径
+     */
+    match(resource: AccessResource, path: AccessPath): boolean;
+    /**
+     * 取得资源
+     * @param path 路径
+     */
+    obtain(path: AccessPath): AccessResource | null;
+    /**
+     * 获取基础路径
+     */
+    getBasename(): string | undefined;
+    /**
+     * 设置基础路径
+     */
+    setBasename(basename: string | undefined): void;
+}

package/dist/access/navigator.d.ts

@@ -0,0 +1,33 @@
+import type { NavigateFunction, NavigateOptions, To } from '../bridge';
+/**
+ * 访问导航器
+ */
+export interface AccessNavigator {
+    /**
+     * 进行导航
+     * @param to 路径
+     * @param options 可选配置
+     */
+    navigate(to: To, options?: NavigateOptions): void;
+}
+/**
+ * 简单导航器
+ */
+export declare class SimpleNavigator implements AccessNavigator {
+    /**
+     * 导航函数
+     * @private
+     */
+    private readonly _navigate;
+    /**
+     * 构造函数
+     * @param navigate 导航函数
+     */
+    constructor(navigate: NavigateFunction);
+    /**
+     * 进行导航
+     * @param to 路径
+     * @param options 可选配置
+     */
+    navigate(to: To, options?: NavigateOptions): void;
+}