@longzai-intelligence-auth/elysia 0.0.4 → 0.0.5

package/dist/index.d.ts

@@ -1,25 +1,648 @@
-export { createAuthPlugin } from "./plugin";
-export type { AuthPluginConfig, AuthPluginOptions, JwtStrategyConfig, StandaloneStrategyConfig, EnvBasicStrategyConfig, StrategyName, StrategyContext, } from "./types/auth-plugin-config";
-export { createAuthStrategy, extractJwtConfig, extractDefaultTenantId, extractRegisterRoutes } from "./core/auth-strategy";
-export type { AuthStrategy } from "./core/auth-strategy";
-export { mapDomainErrorToStatus } from "./core/error-mapper";
-export { createJwtVerifyPlugin } from "./plugins/jwt-verify.plugin";
-export type { JwtVerifyPluginOptions } from "./plugins/jwt-verify.plugin";
-export { createRbacPlugin } from "./plugins/rbac.plugin";
-export type { RbacPluginOptions } from "./plugins/rbac.plugin";
-export { createTenantPlugin } from "./plugins/tenant.plugin";
-export type { TenantPluginOptions } from "./plugins/tenant.plugin";
-export { createRateLimitPlugin } from "./plugins/rate-limit.plugin";
-export type { RateLimitPluginOptions } from "./plugins/rate-limit.plugin";
-export { createAuditPlugin } from "./plugins/audit.plugin";
-export type { AuditPluginOptions } from "./plugins/audit.plugin";
-export { createErrorHandlerPlugin } from "./plugins/error-handler.plugin";
-export type { ErrorHandlerPluginOptions } from "./plugins/error-handler.plugin";
-export { createLoggerPlugin } from "./plugins/logger.plugin";
-export type { LoggerPluginOptions } from "./plugins/logger.plugin";
-export { createBasicPreset } from "./presets/basic-preset";
-export type { BasicPresetOptions } from "./presets/basic-preset";
-export { createStandardPreset } from "./presets/standard-preset";
-export type { StandardPresetOptions } from "./presets/standard-preset";
-export { extractClientIp } from "./utils/extract-client-ip";
-export { extractUserAgent } from "./utils/extract-user-agent";
+import { DomainError } from "@longzai-intelligence/error";
+import { JwtConfig, LoggerService, RateLimiterPort, ResourceAction, TenantValidateFn, TokenVerifierPort, UnifiedAuthContext, UnifiedAuthContext as UnifiedAuthContext$1 } from "@longzai-intelligence-auth/core";
+import { Elysia } from "elysia";
+import { z } from "zod";
+
+//#region src/core/error-mapper.d.ts
+/** 根据 DomainError 类型映射 HTTP 状态码 */
+declare function mapDomainErrorToStatus(error: DomainError): number;
+//#endregion
+//#region src/plugins/jwt-verify.plugin.d.ts
+/** JWT 验证插件解析后的认证上下文 */
+type VerifiedAuthContext = {
+  /** 用户 ID（来自 payload.sub） */userId: string; /** 租户 ID（来自 payload.tenantId，默认使用 defaultTenantId） */
+  tenantId: string; /** 角色列表 */
+  roles: string[]; /** 权限列表 */
+  permissions: string[]; /** JWT ID（用于 token 黑名单检查） */
+  jti?: string;
+};
+type JwtVerifyPluginOptions<T extends z.ZodTypeAny = z.ZodUndefined> = {
+  /** 令牌验证器端口（用户注入，与 jwt 二选一） */verifier?: TokenVerifierPort; /** JWT 配置（与 verifier 二选一，未提供时使用默认配置） */
+  jwt?: JwtConfig; /** 默认租户 ID */
+  defaultTenantId?: string; /** 跳过认证的路径列表（精确匹配或前缀匹配，如 "/api/public/*"） */
+  publicPaths?: string[]; /** 扩展 schema，用于从 payload 中解析自定义业务字段 */
+  extendSchema?: T;
+};
+/** 从 extendSchema 提取额外字段类型 */
+type ExtractExtra<T extends z.ZodTypeAny> = T extends z.ZodUndefined ? Record<string, never> : z.infer<T>;
+/** 完整的认证上下文类型（基础字段 + 扩展字段） */
+type AuthContextWithExtra<T extends z.ZodTypeAny = z.ZodUndefined> = VerifiedAuthContext & ExtractExtra<T>;
+declare function createJwtVerifyPlugin<T extends z.ZodTypeAny = z.ZodUndefined>(options: JwtVerifyPluginOptions<T>): Elysia<"", {
+  decorator: {};
+  store: {};
+  derive: {};
+  resolve: {};
+}, {
+  typebox: {};
+  error: {};
+}, {
+  schema: {};
+  standaloneSchema: {};
+  macro: {};
+  macroFn: {};
+  parser: {};
+  response: {};
+}, {}, {
+  derive: {
+    readonly auth: any;
+  };
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: import("elysia").ExtractErrorFromHandle<{
+    readonly auth: any;
+  }>;
+}, {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+}>;
+//#endregion
+//#region src/plugins/optional-jwt.plugin.d.ts
+type OptionalJwtPluginOptions<T extends z.ZodTypeAny = z.ZodUndefined> = {
+  /** 令牌验证器端口（用户注入，与 jwt 二选一） */verifier?: TokenVerifierPort; /** JWT 配置（与 verifier 二选一，未提供时使用默认配置） */
+  jwt?: JwtConfig; /** 默认租户 ID */
+  defaultTenantId?: string; /** 扩展 schema，用于从 payload 中解析自定义业务字段 */
+  extendSchema?: T;
+};
+/** 可选认证上下文，auth 为 null 表示未认证 */
+type OptionalAuthContext<T extends z.ZodTypeAny = z.ZodUndefined> = {
+  auth: (UnifiedAuthContext$1 & (T extends z.ZodUndefined ? Record<string, never> : z.infer<T>)) | null;
+};
+declare function createOptionalJwtPlugin<T extends z.ZodTypeAny = z.ZodUndefined>(options: OptionalJwtPluginOptions<T>): Elysia<"", {
+  decorator: {};
+  store: {};
+  derive: {};
+  resolve: {};
+}, {
+  typebox: {};
+  error: {};
+}, {
+  schema: {};
+  standaloneSchema: {};
+  macro: {};
+  macroFn: {};
+  parser: {};
+  response: {};
+}, {}, {
+  derive: {
+    readonly auth: any;
+  };
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: import("elysia").ExtractErrorFromHandle<{
+    readonly auth: any;
+  }>;
+}, {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+}>;
+//#endregion
+//#region src/plugins/rbac.plugin.d.ts
+/** 用户角色策略接口，用于数据库查询权限 */
+type UserRoleStrategy = {
+  /** 查询用户在指定租户下的所有权限 */findPermissionsByUserId(userId: string, tenantId: string): Promise<ResourceAction[]>;
+};
+type RbacPluginOptions = {
+  /** 用户角色策略（用于数据库查询权限，优先于上下文权限） */userRole?: UserRoleStrategy;
+};
+declare function createRbacPlugin(options?: RbacPluginOptions): Elysia<"", {
+  decorator: {};
+  store: {};
+  derive: {
+    readonly requirePermission: (resource: string, action: string) => Promise<void>;
+  };
+  resolve: {};
+}, {
+  typebox: {};
+  error: {};
+}, {
+  schema: {};
+  standaloneSchema: {};
+  macro: {};
+  macroFn: {};
+  parser: {};
+  response: import("elysia").ExtractErrorFromHandle<{
+    readonly requirePermission: (resource: string, action: string) => Promise<void>;
+  }>;
+}, {}, {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+}, {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+}>;
+//#endregion
+//#region src/plugins/api-key.plugin.d.ts
+/** API Key 认证的主体信息 */
+type ApiKeyPrincipal = {
+  /** 主体标识 */principalId: string; /** 租户 ID */
+  tenantId?: string; /** 角色列表 */
+  roles: string[]; /** 权限列表 */
+  permissions: string[];
+};
+type ApiKeyPluginOptions = {
+  /** API Key 所在的请求头名称（默认 "x-api-key"） */header?: string; /** API Key 验证器，返回 null 表示无效 */
+  validator: (key: string) => Promise<ApiKeyPrincipal | null>;
+};
+declare function createApiKeyPlugin(options: ApiKeyPluginOptions): Elysia<"", {
+  decorator: {};
+  store: {};
+  derive: {};
+  resolve: {};
+}, {
+  typebox: {};
+  error: {};
+}, {
+  schema: {};
+  standaloneSchema: {};
+  macro: {};
+  macroFn: {};
+  parser: {};
+  response: {};
+}, {}, {
+  derive: {
+    auth: UnifiedAuthContext$1;
+  };
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: import("elysia").ExtractErrorFromHandle<{
+    auth: UnifiedAuthContext$1;
+  }>;
+}, {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+}>;
+//#endregion
+//#region src/plugins/in-memory-api-key-validator.d.ts
+/** 内存 API Key 映射条目 */
+type InMemoryApiKeyEntry = {
+  /** 主体标识 */principalId: string; /** 租户ID（可选） */
+  tenantId?: string; /** 角色列表 */
+  roles: string[]; /** 权限列表 */
+  permissions: string[];
+};
+/** 内存 API Key 映射表 */
+type InMemoryApiKeyMap = Record<string, InMemoryApiKeyEntry>;
+/**
+ * 创建内存 API Key 验证器
+ * 接受静态 API Key 映射，返回符合 createApiKeyPlugin 的 validator 函数
+ * @param keyMap - API Key 到主体信息的映射
+ * @returns validator 函数
+ */
+declare function createInMemoryApiKeyValidator(keyMap: InMemoryApiKeyMap): (key: string) => Promise<ApiKeyPrincipal | null>;
+//#endregion
+//#region src/plugins/composite-auth.plugin.d.ts
+type CompositeAuthPluginOptions = {
+  /** 令牌验证器端口（用户注入，与 jwt 二选一） */verifier?: TokenVerifierPort; /** JWT 配置（与 verifier 二选一，未提供时使用默认配置） */
+  jwt?: JwtConfig; /** 默认租户 ID */
+  defaultTenantId?: string; /** API Key 验证器 */
+  apiKeyValidator?: (key: string) => Promise<ApiKeyPrincipal | null>; /** API Key 所在的请求头名称（默认 "x-api-key"） */
+  apiKeyHeader?: string; /** 跳过认证的路径列表（精确匹配或前缀匹配，如 "/api/public/*"） */
+  publicPaths?: string[];
+};
+/** 组合认证上下文（向后兼容，内部使用 UnifiedAuthContext） */
+type CompositeAuthContext = UnifiedAuthContext$1;
+declare function createCompositeAuthPlugin(options: CompositeAuthPluginOptions): Elysia<"", {
+  decorator: {};
+  store: {};
+  derive: {};
+  resolve: {};
+}, {
+  typebox: {};
+  error: {};
+}, {
+  schema: {};
+  standaloneSchema: {};
+  macro: {};
+  macroFn: {};
+  parser: {};
+  response: {};
+}, {}, {
+  derive: {
+    auth: UnifiedAuthContext$1 | null;
+  };
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: import("elysia").ExtractErrorFromHandle<{
+    auth: UnifiedAuthContext$1 | null;
+  }>;
+}, {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+}>;
+/** 创建要求认证的组合认证插件（未认证时抛出异常） */
+declare function createRequiredCompositeAuthPlugin(options: CompositeAuthPluginOptions): Elysia<"", {
+  decorator: {};
+  store: {};
+  derive: {};
+  resolve: {};
+}, {
+  typebox: {};
+  error: {};
+}, {
+  schema: {};
+  standaloneSchema: {};
+  macro: {};
+  macroFn: {};
+  parser: {};
+  response: {};
+}, {}, {
+  derive: {
+    auth: UnifiedAuthContext$1;
+  };
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: import("elysia").ExtractErrorFromHandle<{
+    auth: UnifiedAuthContext$1;
+  }>;
+}, {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+}>;
+//#endregion
+//#region src/plugins/tenant.plugin.d.ts
+type TenantPluginOptions = {
+  /** 默认租户 ID */defaultTenantId?: string; /** 租户验证函数 */
+  validateFn?: TenantValidateFn;
+};
+declare function createTenantPlugin(options?: TenantPluginOptions): Elysia<"", {
+  decorator: {};
+  store: {};
+  derive: {
+    tenantId: string;
+  };
+  resolve: {};
+}, {
+  typebox: {};
+  error: {};
+}, {
+  schema: {};
+  standaloneSchema: {};
+  macro: {};
+  macroFn: {};
+  parser: {};
+  response: import("elysia").ExtractErrorFromHandle<{
+    tenantId: string;
+  }> & {};
+}, {}, {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+}, {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+}>;
+//#endregion
+//#region src/plugins/rate-limit.plugin.d.ts
+type RateLimitPluginOptions = {
+  /** 速率限制器端口（用户注入） */limiter: RateLimiterPort; /** 日志服务 */
+  logger?: LoggerService; /** 键生成器（用于从请求中提取限制键） */
+  keyGenerator?: (request: Request) => string;
+};
+declare function createRateLimitPlugin(options: RateLimitPluginOptions): Elysia<"", {
+  decorator: {};
+  store: {};
+  derive: {
+    readonly clientIp: string;
+  } & {
+    readonly rateLimitRemaining: number;
+  };
+  resolve: {};
+}, {
+  typebox: {};
+  error: {};
+}, {
+  schema: {};
+  standaloneSchema: {};
+  macro: {};
+  macroFn: {};
+  parser: {};
+  response: import("elysia").ExtractErrorFromHandle<{
+    readonly rateLimitRemaining: number;
+  }>;
+}, {}, {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+}, {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+}>;
+//#endregion
+//#region src/plugins/error-handler.plugin.d.ts
+type ErrorHandlerPluginOptions = {
+  logger?: LoggerService;
+};
+declare function createErrorHandlerPlugin(options?: ErrorHandlerPluginOptions): Elysia<"", {
+  decorator: {};
+  store: {};
+  derive: {};
+  resolve: {};
+}, {
+  typebox: {};
+  error: {};
+}, {
+  schema: {};
+  standaloneSchema: {};
+  macro: {};
+  macroFn: {};
+  parser: {};
+  response: {
+    200: {
+      details?: Record<string, unknown> | undefined;
+      code: string;
+      message: string;
+    } | {
+      code: string;
+      message: string;
+      details: {
+        path: string;
+        message: string | undefined;
+      }[];
+    };
+  };
+}, {}, {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+}, {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+}>;
+//#endregion
+//#region src/plugins/logger.plugin.d.ts
+type LoggerPluginOptions = {
+  logger: LoggerService;
+};
+declare function createLoggerPlugin(options: LoggerPluginOptions): Elysia<"", {
+  decorator: {};
+  store: {};
+  derive: {};
+  resolve: {};
+}, {
+  typebox: {};
+  error: {};
+}, {
+  schema: {};
+  standaloneSchema: {};
+  macro: {};
+  macroFn: {};
+  parser: {};
+  response: {};
+}, {}, {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+}, {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+}>;
+//#endregion
+//#region src/presets/basic-preset.d.ts
+type BasicPresetOptions<T extends z.ZodTypeAny = z.ZodUndefined> = {
+  /** 令牌验证器端口（用户注入） */tokenVerifier: TokenVerifierPort; /** 默认租户 ID */
+  defaultTenantId?: string; /** 日志服务 */
+  logger?: LoggerService; /** 跳过认证的路径列表（精确匹配或前缀匹配，如 "/api/public/*"） */
+  publicPaths?: string[]; /** 扩展 schema，用于从 payload 中解析自定义业务字段 */
+  extendSchema?: T;
+};
+declare function createBasicPreset<T extends z.ZodTypeAny = z.ZodUndefined>(options: BasicPresetOptions<T>): Elysia<"", {
+  decorator: {};
+  store: {};
+  derive: {};
+  resolve: {};
+}, {
+  typebox: {};
+  error: {};
+}, {
+  schema: {};
+  standaloneSchema: {};
+  macro: {};
+  macroFn: {};
+  parser: {};
+  response: {};
+} & {
+  schema: {};
+  standaloneSchema: {};
+  macro: {};
+  macroFn: {};
+  parser: {};
+  response: {
+    200: {
+      details?: Record<string, unknown> | undefined;
+      code: string;
+      message: string;
+    } | {
+      code: string;
+      message: string;
+      details: {
+        path: string;
+        message: string | undefined;
+      }[];
+    };
+  };
+}, {}, {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+}, {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+} & {
+  derive: {
+    readonly auth: any;
+  };
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: import("elysia").ExtractErrorFromHandle<{
+    readonly auth: any;
+  }>;
+} & {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+}>;
+//#endregion
+//#region src/presets/standard-preset.d.ts
+type StandardPresetOptions<T extends z.ZodTypeAny = z.ZodUndefined> = {
+  /** 令牌验证器端口（用户注入） */tokenVerifier: TokenVerifierPort; /** 速率限制器端口（可选，用户注入） */
+  rateLimiter?: RateLimiterPort; /** 默认租户 ID */
+  defaultTenantId?: string; /** 租户验证函数 */
+  validateFn?: TenantValidateFn; /** 用户角色策略 */
+  userRole?: UserRoleStrategy; /** 日志服务 */
+  logger?: LoggerService; /** 跳过认证的路径列表（精确匹配或前缀匹配，如 "/api/public/*"） */
+  publicPaths?: string[]; /** 扩展 schema，用于从 payload 中解析自定义业务字段（仅在未使用 apiKeyValidator 时生效） */
+  extendSchema?: T; /** API Key 验证器（提供后使用组合认证插件替代 JWT 验证插件） */
+  apiKeyValidator?: (key: string) => Promise<ApiKeyPrincipal | null>;
+};
+declare function createStandardPreset<T extends z.ZodTypeAny = z.ZodUndefined>(options: StandardPresetOptions<T>): Elysia<"", {
+  decorator: {};
+  store: {};
+  derive: {
+    readonly requirePermission: (resource: string, action: string) => Promise<void>;
+  } & {
+    tenantId: string;
+  };
+  resolve: {};
+}, {
+  typebox: {};
+  error: {};
+}, {
+  schema: {};
+  standaloneSchema: {};
+  macro: {};
+  macroFn: {};
+  parser: {};
+  response: {};
+} & {
+  schema: {};
+  standaloneSchema: {};
+  macro: {};
+  macroFn: {};
+  parser: {};
+  response: import("elysia").ExtractErrorFromHandle<{
+    readonly requirePermission: (resource: string, action: string) => Promise<void>;
+  }>;
+} & {
+  schema: {};
+  standaloneSchema: {};
+  macro: {};
+  macroFn: {};
+  parser: {};
+  response: import("elysia").ExtractErrorFromHandle<{
+    tenantId: string;
+  }> & {};
+} & {
+  schema: {};
+  standaloneSchema: {};
+  macro: {};
+  macroFn: {};
+  parser: {};
+  response: {
+    200: {
+      details?: Record<string, unknown> | undefined;
+      code: string;
+      message: string;
+    } | {
+      code: string;
+      message: string;
+      details: {
+        path: string;
+        message: string | undefined;
+      }[];
+    };
+  };
+}, {}, {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+}, ({
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+} & {
+  derive: {
+    auth: import("@longzai-intelligence-auth/core").UnifiedAuthContext;
+  };
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: import("elysia").ExtractErrorFromHandle<{
+    auth: import("@longzai-intelligence-auth/core").UnifiedAuthContext;
+  }>;
+} & {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+}) | ({
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+} & {
+  derive: {
+    readonly auth: any;
+  };
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: import("elysia").ExtractErrorFromHandle<{
+    readonly auth: any;
+  }>;
+} & {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+})>;
+//#endregion
+//#region src/utils/extract-client-ip.d.ts
+/** 从请求中提取客户端 IP 地址 */
+declare function extractClientIp(request: Request): string | undefined;
+//#endregion
+//#region src/utils/extract-user-agent.d.ts
+/** 从请求中提取用户代理 */
+declare function extractUserAgent(request: Request): string | undefined;
+//#endregion
+export { type ApiKeyPluginOptions, type ApiKeyPrincipal, type AuthContextWithExtra, type BasicPresetOptions, type CompositeAuthContext, type CompositeAuthPluginOptions, type ErrorHandlerPluginOptions, type ExtractExtra, type InMemoryApiKeyEntry, type InMemoryApiKeyMap, type JwtVerifyPluginOptions, type LoggerPluginOptions, type OptionalAuthContext, type OptionalJwtPluginOptions, type RateLimitPluginOptions, type RbacPluginOptions, type StandardPresetOptions, type TenantPluginOptions, type UnifiedAuthContext, type UserRoleStrategy, type VerifiedAuthContext, createApiKeyPlugin, createBasicPreset, createCompositeAuthPlugin, createErrorHandlerPlugin, createInMemoryApiKeyValidator, createJwtVerifyPlugin, createLoggerPlugin, createOptionalJwtPlugin, createRateLimitPlugin, createRbacPlugin, createRequiredCompositeAuthPlugin, createStandardPreset, createTenantPlugin, extractClientIp, extractUserAgent, mapDomainErrorToStatus };