sa2kit 3.2.1 → 3.2.3

package/dist/common/auth/server/index.d.ts

@@ -6,7 +6,7 @@ import 'drizzle-orm/pg-core';
 /**
  * sa2kit auth 服务端配置类型（Better Auth 3.0）
  */
-type Sa2kitSmsProvider = {
+type Sa2kitSmsProvider$1 = {
     sendOTP: (phoneNumber: string, code: string) => void | Promise<void>;
 };
 type Sa2kitEmailProvider = {
@@ -18,7 +18,7 @@ type Sa2kitAuthConfig = {
     secret: string;
     trustedOrigins?: string[];
     basePath?: string;
-    sms?: Sa2kitSmsProvider;
+    sms?: Sa2kitSmsProvider$1;
     email?: Sa2kitEmailProvider;
     phoneNumberValidator?: (phoneNumber: string) => boolean;
     logOtpInDev?: boolean;
@@ -40,6 +40,59 @@ type Sa2kitAuth = Sa2kitAuthInstance;
 
 declare function createSa2kitAuth(config: Sa2kitAuthConfig): Sa2kitAuthInstance;
 
+type AuthEnvPlacement = 'env_file' | 'github_secret' | 'runtime_env' | 'database';
+type AuthEnvVarDefinition = {
+    key: string;
+    featureId: string;
+    required: boolean;
+    placement: AuthEnvPlacement[];
+    description: string;
+    example?: string;
+    secret?: boolean;
+};
+type AuthFeatureDefinition = {
+    id: string;
+    name: string;
+    description: string;
+    envKeys: string[];
+};
+declare const AUTH_FEATURES: AuthFeatureDefinition[];
+declare const AUTH_ENV_CATALOG: AuthEnvVarDefinition[];
+declare const AUTH_ENV_ALIASES: Record<string, string[]>;
+
+type ResolveAuthEnvInput = Partial<Sa2kitAuthConfig> & Pick<Sa2kitAuthConfig, 'db'>;
+type ResolvedAuthEnv = {
+    config: Sa2kitAuthConfig;
+    envSnapshot: Record<string, string | undefined>;
+};
+declare function resolveAuthEnv(input: ResolveAuthEnvInput): ResolvedAuthEnv;
+
+type AuthEnvIssueLevel = 'error' | 'warning' | 'info';
+type AuthEnvIssue = {
+    level: AuthEnvIssueLevel;
+    featureId: string;
+    featureName: string;
+    message: string;
+    missingKeys?: string[];
+    hints?: string[];
+};
+type AuthEnvReport = {
+    ok: boolean;
+    issues: AuthEnvIssue[];
+    enabledFeatures: string[];
+    disabledFeatures: string[];
+};
+declare function checkAuthEnv(envSnapshot: Record<string, string | undefined>): AuthEnvReport;
+declare function logAuthEnvReport(report: AuthEnvReport, options?: {
+    force?: boolean;
+}): void;
+declare function formatAuthEnvSetupMarkdown(report?: AuthEnvReport): string;
+declare function checkAuthEnvFromProcessEnv(extraSnapshot?: Record<string, string | undefined>): AuthEnvReport;
+
+declare function createSa2kitAuthFromEnv(input: ResolveAuthEnvInput, options?: {
+    logEnvReport?: boolean;
+}): Sa2kitAuthInstance;
+
 declare function mountNextAuthHandler(auth: Sa2kitAuthInstance): {
     GET: (request: Request) => Promise<Response>;
     POST: (request: Request) => Promise<Response>;
@@ -86,4 +139,34 @@ declare function createSessionValidator(auth: Sa2kitAuthInstance): {
 declare const defaultPhoneValidator: (phoneNumber: string) => boolean;
 declare const defaultTempEmailFromPhone: (phoneNumber: string) => string;
 
-export { type Sa2kitAuth, type Sa2kitAuthConfig, type Sa2kitAuthInstance, type Sa2kitEmailProvider, type Sa2kitSmsProvider, type SessionUser, createAuthRouteHandlers, createSa2kitAuth, createSessionValidator, defaultPhoneValidator, defaultTempEmailFromPhone, getSessionUser, getSessionUserNumeric, mountAuthHandler, mountNextAuthHandler };
+type Sa2kitSmsProvider = {
+    sendOTP: (phoneNumber: string, code: string) => void | Promise<void>;
+};
+type Sa2kitSmsProviderId = 'console' | 'aliyun-pnvs' | 'none';
+type AliyunPnvsSmsConfig = {
+    accessKeyId: string;
+    accessKeySecret: string;
+    signName: string;
+    templateCode: string;
+    countryCode?: string;
+    codeValidMinutes?: number;
+    endpoint?: string;
+};
+
+declare function createConsoleSmsProvider(): Sa2kitSmsProvider;
+
+declare function createAliyunPnvsSmsProvider(config: AliyunPnvsSmsConfig): Sa2kitSmsProvider;
+
+declare function resolveSmsProviderId(explicit?: Sa2kitSmsProviderId): Sa2kitSmsProviderId | undefined;
+declare function createSmsProviderFromEnv(options?: {
+    providerId?: Sa2kitSmsProviderId;
+}): Sa2kitSmsProvider | undefined;
+
+declare function stashPhoneSignupPassword(phoneNumber: string, password: string): void;
+declare function consumePhoneSignupPassword(phoneNumber: string): string | undefined;
+declare function handlePhoneSignupIntentRequest(request: Request): Promise<Response>;
+
+/** 为手机号注册用户写入 credential 密码，供「手机+密码」登录 */
+declare function upsertCredentialPassword(db: unknown, userId: string, plainPassword: string): Promise<void>;
+
+export { AUTH_ENV_ALIASES, AUTH_ENV_CATALOG, AUTH_FEATURES, type AliyunPnvsSmsConfig, type AuthEnvIssue, type AuthEnvReport, type AuthEnvVarDefinition, type AuthFeatureDefinition, type Sa2kitAuth, type Sa2kitAuthConfig, type Sa2kitAuthInstance, type Sa2kitEmailProvider, type Sa2kitSmsProvider$1 as Sa2kitSmsProvider, type Sa2kitSmsProviderId, type SessionUser, checkAuthEnv, checkAuthEnvFromProcessEnv, consumePhoneSignupPassword, createAliyunPnvsSmsProvider, createAuthRouteHandlers, createConsoleSmsProvider, createSa2kitAuth, createSa2kitAuthFromEnv, createSessionValidator, createSmsProviderFromEnv, defaultPhoneValidator, defaultTempEmailFromPhone, formatAuthEnvSetupMarkdown, getSessionUser, getSessionUserNumeric, handlePhoneSignupIntentRequest, logAuthEnvReport, mountAuthHandler, mountNextAuthHandler, resolveAuthEnv, resolveSmsProviderId, stashPhoneSignupPassword, upsertCredentialPassword };