@h-ai/api-contract 0.1.0-alpha.67 → 0.1.0-alpha.68

package/dist/iam/index.d.ts

@@ -16,7 +16,16 @@ import { HaiResult } from '@h-ai/core';
  * auth.* 入口址前缀为 `/auth`；users/roles/permissions 前缀为 `/iam`。
  * @module iam-contract
  */
-/** IAM 领域 oRPC contract。 */
+/**
+ * IAM 领域 oRPC contract。
+ * @example
+ * ```ts
+ * import { apiContract } from '@h-ai/api-contract'
+ *
+ * const contract = apiContract.iam
+ * void contract
+ * ```
+ */
 declare const iamContract: {
     auth: {
         publicConfig: _orpc_contract.ContractProcedureBuilderWithOutput<_orpc_contract.Schema<unknown, unknown>, zod.ZodDiscriminatedUnion<[zod.ZodObject<{
@@ -179,7 +188,6 @@ declare const iamContract: {
         login: _orpc_contract.ContractProcedureBuilderWithInputOutput<zod.ZodObject<{
             identifier: zod.ZodString;
             password: zod.ZodString;
-            rememberMe: zod.ZodOptional<zod.ZodBoolean>;
         }, zod_v4_core.$strip>, zod.ZodDiscriminatedUnion<[zod.ZodObject<{
             success: zod.ZodLiteral<true>;
             data: zod.ZodObject<{
@@ -941,6 +949,17 @@ declare const iamContract: {
         }, zod_v4_core.$strip>], "success">, Record<never, never>, Record<never, never>>;
     };
 };
+/**
+ * iam 领域公开 procedure 契约的完整类型。
+ * @example
+ * ```ts
+ * import type { IamContract } from '@h-ai/api-contract'
+ * import { apiContract } from '@h-ai/api-contract'
+ *
+ * const contract: IamContract = apiContract.iam
+ * void contract
+ * ```
+ */
 type IamContract = typeof iamContract;
 
 /**
@@ -951,7 +970,22 @@ type IamContract = typeof iamContract;
  * @module iam-schemas
  */
 
-/** 用户基础信息 Schema。 */
+/**
+ * 用户基础信息 Schema。
+ * @example
+ * ```ts
+ * import { IamUserSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamUserSchema.parse({
+ *   id: 'example-1',
+ *   username: 'alice',
+ *   enabled: true,
+ *   createdAt: null,
+ *   updatedAt: null
+ * })
+ * void value
+ * ```
+ */
 declare const IamUserSchema: z.ZodObject<{
     id: z.ZodString;
     username: z.ZodString;
@@ -966,14 +1000,39 @@ declare const IamUserSchema: z.ZodObject<{
     updatedAt: z.ZodCoercedDate<unknown>;
     metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, z.core.$strip>;
-/** Token 对 Schema。 */
+/**
+ * Token 对 Schema。
+ * @example
+ * ```ts
+ * import { IamTokenPairSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamTokenPairSchema.parse({
+ *   accessToken: 'example-only-access',
+ *   expiresIn: 0,
+ *   tokenType: 'Bearer'
+ * })
+ * void value
+ * ```
+ */
 declare const IamTokenPairSchema: z.ZodObject<{
     accessToken: z.ZodString;
     refreshToken: z.ZodOptional<z.ZodString>;
     expiresIn: z.ZodNumber;
     tokenType: z.ZodLiteral<"Bearer">;
 }, z.core.$strip>;
-/** 协议展示 Schema。 */
+/**
+ * 协议展示 Schema。
+ * @example
+ * ```ts
+ * import { IamAgreementDisplaySchema } from '@h-ai/api-contract'
+ *
+ * const value = IamAgreementDisplaySchema.parse({
+ *   showOnRegister: true,
+ *   showOnLogin: true
+ * })
+ * void value
+ * ```
+ */
 declare const IamAgreementDisplaySchema: z.ZodObject<{
     userAgreementMarkdown: z.ZodOptional<z.ZodString>;
     privacyPolicyMarkdown: z.ZodOptional<z.ZodString>;
@@ -982,7 +1041,29 @@ declare const IamAgreementDisplaySchema: z.ZodObject<{
     showOnRegister: z.ZodBoolean;
     showOnLogin: z.ZodBoolean;
 }, z.core.$strip>;
-/** 登录结果业务数据 Schema。 */
+/**
+ * 登录结果业务数据 Schema。
+ * @example
+ * ```ts
+ * import { IamAuthResultSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamAuthResultSchema.parse({
+ *   user: {
+ *     id: 'example-1',
+ *     username: 'alice',
+ *     enabled: true,
+ *     createdAt: null,
+ *     updatedAt: null
+ *   },
+ *   tokens: {
+ *     accessToken: 'example-only-access',
+ *     expiresIn: 0,
+ *     tokenType: 'Bearer'
+ *   }
+ * })
+ * void value
+ * ```
+ */
 declare const IamAuthResultSchema: z.ZodObject<{
     user: z.ZodObject<{
         id: z.ZodString;
@@ -1015,7 +1096,28 @@ declare const IamAuthResultSchema: z.ZodObject<{
         showOnLogin: z.ZodBoolean;
     }, z.core.$strip>>;
 }, z.core.$strip>;
-/** 当前会话用户信息；包含服务端重新校验后的角色与权限快照。 */
+/**
+ * 当前会话用户信息；包含服务端重新校验后的角色与权限快照。
+ * @example
+ * ```ts
+ * import { IamCurrentUserSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamCurrentUserSchema.parse({
+ *   id: 'example-1',
+ *   username: 'alice',
+ *   enabled: true,
+ *   createdAt: null,
+ *   updatedAt: null,
+ *   roles: [
+ *     'example'
+ *   ],
+ *   permissions: [
+ *     'example'
+ *   ]
+ * })
+ * void value
+ * ```
+ */
 declare const IamCurrentUserSchema: z.ZodObject<{
     id: z.ZodString;
     username: z.ZodString;
@@ -1032,25 +1134,120 @@ declare const IamCurrentUserSchema: z.ZodObject<{
     roles: z.ZodArray<z.ZodString>;
     permissions: z.ZodArray<z.ZodString>;
 }, z.core.$strip>;
-/** 密码登录入参 Schema。 */
+/**
+ * 密码登录入参 Schema。
+ * @example
+ * ```ts
+ * import { IamLoginInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamLoginInputSchema.parse({
+ *   identifier: 'alice',
+ *   password: 'example-only-password'
+ * })
+ * void value
+ * ```
+ */
 declare const IamLoginInputSchema: z.ZodObject<{
     identifier: z.ZodString;
     password: z.ZodString;
-    rememberMe: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
-/** LDAP 登录与密码找回入参。 */
+/**
+ * LDAP 登录与密码找回入参。
+ * @example
+ * ```ts
+ * import { IamLdapLoginInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamLdapLoginInputSchema.parse({
+ *   username: 'alice',
+ *   password: 'example-only-password'
+ * })
+ * void value
+ * ```
+ */
 declare const IamLdapLoginInputSchema: z.ZodObject<{
     username: z.ZodString;
     password: z.ZodString;
 }, z.core.$strip>;
+/**
+ * IamRequestPasswordResetInput 数据的运行时 Zod 校验约束。
+ * @example
+ * ```ts
+ * import { IamRequestPasswordResetInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamRequestPasswordResetInputSchema.parse({
+ *   identifier: 'alice'
+ * })
+ * void value
+ * ```
+ */
 declare const IamRequestPasswordResetInputSchema: z.ZodObject<{
     identifier: z.ZodString;
 }, z.core.$strip>;
+/**
+ * IamConfirmPasswordResetInput 数据的运行时 Zod 校验约束。
+ * @example
+ * ```ts
+ * import { IamConfirmPasswordResetInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamConfirmPasswordResetInputSchema.parse({
+ *   token: 'example-only-token',
+ *   newPassword: 'example-only-password'
+ * })
+ * void value
+ * ```
+ */
 declare const IamConfirmPasswordResetInputSchema: z.ZodObject<{
     token: z.ZodString;
     newPassword: z.ZodString;
 }, z.core.$strip>;
-/** 认证页面公开配置白名单，独立于服务端连接/凭据配置。 */
+/**
+ * 认证页面公开配置白名单，独立于服务端连接/凭据配置。
+ * @example
+ * ```ts
+ * import { IamPublicConfigSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamPublicConfigSchema.parse({
+ *   password: {
+ *     minLength: 0,
+ *     maxLength: 0,
+ *     requireUppercase: true,
+ *     requireLowercase: true,
+ *     requireNumber: true,
+ *     requireSpecialChar: true,
+ *     expirationDays: 0
+ *   },
+ *   register: {
+ *     enabled: true
+ *   },
+ *   login: {
+ *     password: true,
+ *     otp: true,
+ *     ldap: true,
+ *     email: true,
+ *     sms: true
+ *   },
+ *   passwordReset: {
+ *     enabled: true,
+ *     mode: 'email'
+ *   },
+ *   otp: {
+ *     length: 0,
+ *     resendInterval: 0
+ *   },
+ *   agreements: {
+ *     showOnRegister: true,
+ *     showOnLogin: true
+ *   },
+ *   ui: {
+ *     variant: 'card'
+ *   },
+ *   session: {
+ *     maxAge: 0
+ *   }
+ * })
+ * void value
+ * ```
+ */
 declare const IamPublicConfigSchema: z.ZodObject<{
     password: z.ZodObject<{
         minLength: z.ZodNumber;
@@ -1106,28 +1303,99 @@ declare const IamPublicConfigSchema: z.ZodObject<{
         maxAge: z.ZodNumber;
     }, z.core.$strip>;
 }, z.core.$strip>;
-/** OTP 登录入参 Schema。 */
+/**
+ * OTP 登录入参 Schema。
+ * @example
+ * ```ts
+ * import { IamOtpLoginInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamOtpLoginInputSchema.parse({
+ *   identifier: 'alice',
+ *   code: 'example-1'
+ * })
+ * void value
+ * ```
+ */
 declare const IamOtpLoginInputSchema: z.ZodObject<{
     identifier: z.ZodString;
     code: z.ZodString;
 }, z.core.$strip>;
-/** 登出入参 Schema。 */
+/**
+ * 登出入参 Schema。
+ * 仅撤销调用方持有的完整 accessToken；省略时使用 Authorization Bearer，二者均无值则失败。
+ * access 已到期仍可撤销关联 refresh；此入口不按 userId 撤销，也不授予任何身份权限。
+ * @example
+ * ```ts
+ * import { IamLogoutInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamLogoutInputSchema.parse({})
+ * void value
+ * ```
+ */
 declare const IamLogoutInputSchema: z.ZodObject<{
     accessToken: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
-/** 发送 OTP 入参 Schema。 */
+/**
+ * 发送 OTP 入参 Schema。
+ * @example
+ * ```ts
+ * import { IamSendOtpInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamSendOtpInputSchema.parse({
+ *   identifier: 'alice'
+ * })
+ * void value
+ * ```
+ */
 declare const IamSendOtpInputSchema: z.ZodObject<{
     identifier: z.ZodString;
 }, z.core.$strip>;
-/** 发送 OTP 业务数据 Schema。 */
+/**
+ * 发送 OTP 业务数据 Schema。
+ * @example
+ * ```ts
+ * import { IamSendOtpDataSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamSendOtpDataSchema.parse({
+ *   expiresAt: null
+ * })
+ * void value
+ * ```
+ */
 declare const IamSendOtpDataSchema: z.ZodObject<{
     expiresAt: z.ZodCoercedDate<unknown>;
 }, z.core.$strip>;
-/** Token 刷新入参 Schema。 */
+/**
+ * Token 刷新入参 Schema。
+ * @example
+ * ```ts
+ * import { IamRefreshTokenInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamRefreshTokenInputSchema.parse({
+ *   refreshToken: 'example-only-refresh'
+ * })
+ * void value
+ * ```
+ */
 declare const IamRefreshTokenInputSchema: z.ZodObject<{
     refreshToken: z.ZodString;
 }, z.core.$strip>;
-/** Token 刷新业务数据 Schema。 */
+/**
+ * Token 刷新业务数据 Schema。
+ * @example
+ * ```ts
+ * import { IamRefreshTokenDataSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamRefreshTokenDataSchema.parse({
+ *   tokens: {
+ *     accessToken: 'example-only-access',
+ *     expiresIn: 0,
+ *     tokenType: 'Bearer'
+ *   }
+ * })
+ * void value
+ * ```
+ */
 declare const IamRefreshTokenDataSchema: z.ZodObject<{
     tokens: z.ZodObject<{
         accessToken: z.ZodString;
@@ -1136,7 +1404,19 @@ declare const IamRefreshTokenDataSchema: z.ZodObject<{
         tokenType: z.ZodLiteral<"Bearer">;
     }, z.core.$strip>;
 }, z.core.$strip>;
-/** 注册入参 Schema。 */
+/**
+ * 注册入参 Schema。
+ * @example
+ * ```ts
+ * import { IamRegisterInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamRegisterInputSchema.parse({
+ *   username: 'alice',
+ *   password: 'example-only-password'
+ * })
+ * void value
+ * ```
+ */
 declare const IamRegisterInputSchema: z.ZodObject<{
     username: z.ZodString;
     password: z.ZodString;
@@ -1145,12 +1425,33 @@ declare const IamRegisterInputSchema: z.ZodObject<{
     displayName: z.ZodOptional<z.ZodString>;
     metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, z.core.$strip>;
-/** 修改密码入参 Schema。 */
+/**
+ * 修改密码入参 Schema。
+ * @example
+ * ```ts
+ * import { IamChangePasswordInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamChangePasswordInputSchema.parse({
+ *   oldPassword: 'example',
+ *   newPassword: 'example-only-password'
+ * })
+ * void value
+ * ```
+ */
 declare const IamChangePasswordInputSchema: z.ZodObject<{
     oldPassword: z.ZodString;
     newPassword: z.ZodString;
 }, z.core.$strip>;
-/** 当前用户更新入参 Schema。 */
+/**
+ * 当前用户更新入参 Schema。
+ * @example
+ * ```ts
+ * import { IamUpdateCurrentUserInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamUpdateCurrentUserInputSchema.parse({})
+ * void value
+ * ```
+ */
 declare const IamUpdateCurrentUserInputSchema: z.ZodObject<{
     username: z.ZodOptional<z.ZodString>;
     email: z.ZodOptional<z.ZodString>;
@@ -1159,7 +1460,16 @@ declare const IamUpdateCurrentUserInputSchema: z.ZodObject<{
     phone: z.ZodOptional<z.ZodString>;
     metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, z.core.$strip>;
-/** 用户列表查询入参 Schema。 */
+/**
+ * 用户列表查询入参 Schema。
+ * @example
+ * ```ts
+ * import { IamListUsersInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamListUsersInputSchema.parse({})
+ * void value
+ * ```
+ */
 declare const IamListUsersInputSchema: z.ZodObject<{
     page: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
     pageSize: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
@@ -1170,7 +1480,19 @@ declare const IamListUsersInputSchema: z.ZodObject<{
         false: "false";
     }>>, z.ZodTransform<boolean | undefined, "true" | "false" | undefined>>;
 }, z.core.$strip>;
-/** Admin 创建用户入参 Schema。 */
+/**
+ * Admin 创建用户入参 Schema。
+ * @example
+ * ```ts
+ * import { IamAdminCreateUserInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamAdminCreateUserInputSchema.parse({
+ *   username: 'alice',
+ *   password: 'example-only-password'
+ * })
+ * void value
+ * ```
+ */
 declare const IamAdminCreateUserInputSchema: z.ZodObject<{
     username: z.ZodString;
     email: z.ZodOptional<z.ZodString>;
@@ -1181,7 +1503,18 @@ declare const IamAdminCreateUserInputSchema: z.ZodObject<{
     roleIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
     enabled: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
-/** Admin 更新用户入参 Schema。 */
+/**
+ * Admin 更新用户入参 Schema。
+ * @example
+ * ```ts
+ * import { IamAdminUpdateUserInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamAdminUpdateUserInputSchema.parse({
+ *   id: 'example-1'
+ * })
+ * void value
+ * ```
+ */
 declare const IamAdminUpdateUserInputSchema: z.ZodObject<{
     id: z.ZodString;
     username: z.ZodOptional<z.ZodString>;
@@ -1193,16 +1526,54 @@ declare const IamAdminUpdateUserInputSchema: z.ZodObject<{
     enabled: z.ZodOptional<z.ZodBoolean>;
     roleIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
 }, z.core.$strip>;
-/** Admin 删除用户入参 Schema。 */
+/**
+ * Admin 删除用户入参 Schema。
+ * @example
+ * ```ts
+ * import { IamUserIdInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamUserIdInputSchema.parse({
+ *   id: 'example-1'
+ * })
+ * void value
+ * ```
+ */
 declare const IamUserIdInputSchema: z.ZodObject<{
     id: z.ZodString;
 }, z.core.$strip>;
-/** Admin 重置密码入参 Schema。 */
+/**
+ * Admin 重置密码入参 Schema。
+ * @example
+ * ```ts
+ * import { IamAdminResetPasswordInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamAdminResetPasswordInputSchema.parse({
+ *   id: 'example-1',
+ *   newPassword: 'example-only-password'
+ * })
+ * void value
+ * ```
+ */
 declare const IamAdminResetPasswordInputSchema: z.ZodObject<{
     id: z.ZodString;
     newPassword: z.ZodString;
 }, z.core.$strip>;
-/** 角色基础信息 Schema。 */
+/**
+ * 角色基础信息 Schema。
+ * @example
+ * ```ts
+ * import { IamRoleSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamRoleSchema.parse({
+ *   id: 'example-1',
+ *   code: 'example-1',
+ *   name: 'Example',
+ *   createdAt: null,
+ *   updatedAt: null
+ * })
+ * void value
+ * ```
+ */
 declare const IamRoleSchema: z.ZodObject<{
     id: z.ZodString;
     code: z.ZodString;
@@ -1212,26 +1583,73 @@ declare const IamRoleSchema: z.ZodObject<{
     createdAt: z.ZodCoercedDate<unknown>;
     updatedAt: z.ZodCoercedDate<unknown>;
 }, z.core.$strip>;
-/** 创建角色入参 Schema。 */
+/**
+ * 创建角色入参 Schema。
+ * @example
+ * ```ts
+ * import { IamCreateRoleInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamCreateRoleInputSchema.parse({
+ *   code: 'example-1',
+ *   name: 'Example'
+ * })
+ * void value
+ * ```
+ */
 declare const IamCreateRoleInputSchema: z.ZodObject<{
     code: z.ZodString;
     name: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
     isSystem: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
-/** 更新角色入参 Schema。 */
+/**
+ * 更新角色入参 Schema。
+ * @example
+ * ```ts
+ * import { IamUpdateRoleInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamUpdateRoleInputSchema.parse({
+ *   id: 'example-1'
+ * })
+ * void value
+ * ```
+ */
 declare const IamUpdateRoleInputSchema: z.ZodObject<{
     id: z.ZodString;
     name: z.ZodOptional<z.ZodString>;
     description: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
-/** 权限类型 Schema。 */
+/**
+ * 权限类型 Schema。
+ * @example
+ * ```ts
+ * import { IamPermissionTypeSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamPermissionTypeSchema.parse('menu')
+ * void value
+ * ```
+ */
 declare const IamPermissionTypeSchema: z.ZodEnum<{
     menu: "menu";
     api: "api";
     button: "button";
 }>;
-/** 权限基础信息 Schema。 */
+/**
+ * 权限基础信息 Schema。
+ * @example
+ * ```ts
+ * import { IamPermissionSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamPermissionSchema.parse({
+ *   id: 'example-1',
+ *   code: 'example-1',
+ *   name: 'Example',
+ *   createdAt: null,
+ *   updatedAt: null
+ * })
+ * void value
+ * ```
+ */
 declare const IamPermissionSchema: z.ZodObject<{
     id: z.ZodString;
     code: z.ZodString;
@@ -1247,7 +1665,16 @@ declare const IamPermissionSchema: z.ZodObject<{
     createdAt: z.ZodCoercedDate<unknown>;
     updatedAt: z.ZodCoercedDate<unknown>;
 }, z.core.$strip>;
-/** 权限列表查询入参 Schema。 */
+/**
+ * 权限列表查询入参 Schema。
+ * @example
+ * ```ts
+ * import { IamListPermissionsInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamListPermissionsInputSchema.parse({})
+ * void value
+ * ```
+ */
 declare const IamListPermissionsInputSchema: z.ZodObject<{
     page: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
     pageSize: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
@@ -1258,7 +1685,19 @@ declare const IamListPermissionsInputSchema: z.ZodObject<{
         button: "button";
     }>>;
 }, z.core.$strip>;
-/** 创建权限入参 Schema。 */
+/**
+ * 创建权限入参 Schema。
+ * @example
+ * ```ts
+ * import { IamCreatePermissionInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = IamCreatePermissionInputSchema.parse({
+ *   code: 'example-1',
+ *   name: 'Example'
+ * })
+ * void value
+ * ```
+ */
 declare const IamCreatePermissionInputSchema: z.ZodObject<{
     code: z.ZodString;
     name: z.ZodString;
@@ -1271,28 +1710,402 @@ declare const IamCreatePermissionInputSchema: z.ZodObject<{
         button: "button";
     }>>;
 }, z.core.$strip>;
+/**
+ * 账号密码登录请求。
+ * @example
+ * ```ts
+ * import type { IamLoginInput } from '@h-ai/api-contract'
+ * import { IamLoginInputSchema } from '@h-ai/api-contract'
+ *
+ * const value: IamLoginInput = IamLoginInputSchema.parse({
+ *   identifier: 'alice',
+ *   password: 'example-only-password'
+ * })
+ * void value
+ * ```
+ */
 type IamLoginInput = z.infer<typeof IamLoginInputSchema>;
+/**
+ * LDAP 登录请求。
+ * @example
+ * ```ts
+ * import type { IamLdapLoginInput } from '@h-ai/api-contract'
+ * import { IamLdapLoginInputSchema } from '@h-ai/api-contract'
+ *
+ * const value: IamLdapLoginInput = IamLdapLoginInputSchema.parse({
+ *   username: 'alice',
+ *   password: 'example-only-password'
+ * })
+ * void value
+ * ```
+ */
 type IamLdapLoginInput = z.infer<typeof IamLdapLoginInputSchema>;
+/**
+ * 允许下发客户端的身份认证配置。
+ * @example
+ * ```ts
+ * import type { IamPublicConfig } from '@h-ai/api-contract'
+ * import { IamPublicConfigSchema } from '@h-ai/api-contract'
+ *
+ * const value: IamPublicConfig = IamPublicConfigSchema.parse({
+ *   password: {
+ *     minLength: 0,
+ *     maxLength: 0,
+ *     requireUppercase: true,
+ *     requireLowercase: true,
+ *     requireNumber: true,
+ *     requireSpecialChar: true,
+ *     expirationDays: 0
+ *   },
+ *   register: {
+ *     enabled: true
+ *   },
+ *   login: {
+ *     password: true,
+ *     otp: true,
+ *     ldap: true,
+ *     email: true,
+ *     sms: true
+ *   },
+ *   passwordReset: {
+ *     enabled: true,
+ *     mode: 'email'
+ *   },
+ *   otp: {
+ *     length: 0,
+ *     resendInterval: 0
+ *   },
+ *   agreements: {
+ *     showOnRegister: true,
+ *     showOnLogin: true
+ *   },
+ *   ui: {
+ *     variant: 'card'
+ *   },
+ *   session: {
+ *     maxAge: 0
+ *   }
+ * })
+ * void value
+ * ```
+ */
 type IamPublicConfig = z.infer<typeof IamPublicConfigSchema>;
+/**
+ * 一次性验证码登录请求。
+ * @example
+ * ```ts
+ * import type { IamOtpLoginInput } from '@h-ai/api-contract'
+ * import { IamOtpLoginInputSchema } from '@h-ai/api-contract'
+ *
+ * const value: IamOtpLoginInput = IamOtpLoginInputSchema.parse({
+ *   identifier: 'alice',
+ *   code: 'example-1'
+ * })
+ * void value
+ * ```
+ */
 type IamOtpLoginInput = z.infer<typeof IamOtpLoginInputSchema>;
+/**
+ * 注销当前会话的请求。
+ * @example
+ * ```ts
+ * import type { IamLogoutInput } from '@h-ai/api-contract'
+ * import { IamLogoutInputSchema } from '@h-ai/api-contract'
+ *
+ * const value: IamLogoutInput = IamLogoutInputSchema.parse({})
+ * void value
+ * ```
+ */
 type IamLogoutInput = z.infer<typeof IamLogoutInputSchema>;
+/**
+ * 发送一次性验证码的请求。
+ * @example
+ * ```ts
+ * import type { IamSendOtpInput } from '@h-ai/api-contract'
+ * import { IamSendOtpInputSchema } from '@h-ai/api-contract'
+ *
+ * const value: IamSendOtpInput = IamSendOtpInputSchema.parse({
+ *   identifier: 'alice'
+ * })
+ * void value
+ * ```
+ */
 type IamSendOtpInput = z.infer<typeof IamSendOtpInputSchema>;
+/**
+ * 以 HaiResult 区分成功业务数据和公共错误的 IamAuthResultOutput 响应。
+ * @example
+ * ```ts
+ * import type { IamAuthResultOutput } from '@h-ai/api-contract'
+ * import { IamAuthResultSchema } from '@h-ai/api-contract'
+ * import { ok } from '@h-ai/core'
+ *
+ * const response: IamAuthResultOutput = ok(IamAuthResultSchema.parse({
+ *   user: {
+ *     id: 'example-1',
+ *     username: 'alice',
+ *     enabled: true,
+ *     createdAt: null,
+ *     updatedAt: null
+ *   },
+ *   tokens: {
+ *     accessToken: 'example-only-access',
+ *     expiresIn: 0,
+ *     tokenType: 'Bearer'
+ *   }
+ * }))
+ * if (response.success) void response.data
+ * ```
+ */
 type IamAuthResultOutput = HaiResult<z.infer<typeof IamAuthResultSchema>>;
+/**
+ * 当前登录用户及其有效权限。
+ * @example
+ * ```ts
+ * import type { IamCurrentUser } from '@h-ai/api-contract'
+ * import { IamCurrentUserSchema } from '@h-ai/api-contract'
+ *
+ * const value: IamCurrentUser = IamCurrentUserSchema.parse({
+ *   id: 'example-1',
+ *   username: 'alice',
+ *   enabled: true,
+ *   createdAt: null,
+ *   updatedAt: null,
+ *   roles: [
+ *     'example'
+ *   ],
+ *   permissions: [
+ *     'example'
+ *   ]
+ * })
+ * void value
+ * ```
+ */
 type IamCurrentUser = z.infer<typeof IamCurrentUserSchema>;
+/**
+ * 以 HaiResult 区分成功业务数据和公共错误的 IamCurrentUserOutput 响应。
+ * @example
+ * ```ts
+ * import type { IamCurrentUserOutput } from '@h-ai/api-contract'
+ * import { IamCurrentUserSchema } from '@h-ai/api-contract'
+ * import { ok } from '@h-ai/core'
+ *
+ * const response: IamCurrentUserOutput = ok(IamCurrentUserSchema.parse({
+ *   id: 'example-1',
+ *   username: 'alice',
+ *   enabled: true,
+ *   createdAt: null,
+ *   updatedAt: null,
+ *   roles: [
+ *     'example'
+ *   ],
+ *   permissions: [
+ *     'example'
+ *   ]
+ * }))
+ * if (response.success) void response.data
+ * ```
+ */
 type IamCurrentUserOutput = HaiResult<IamCurrentUser>;
+/**
+ * 使用刷新凭据换取会话令牌的请求。
+ * @example
+ * ```ts
+ * import type { IamRefreshTokenInput } from '@h-ai/api-contract'
+ * import { IamRefreshTokenInputSchema } from '@h-ai/api-contract'
+ *
+ * const value: IamRefreshTokenInput = IamRefreshTokenInputSchema.parse({
+ *   refreshToken: 'example-only-refresh'
+ * })
+ * void value
+ * ```
+ */
 type IamRefreshTokenInput = z.infer<typeof IamRefreshTokenInputSchema>;
+/**
+ * 以 HaiResult 区分成功业务数据和公共错误的 IamRefreshTokenOutput 响应。
+ * @example
+ * ```ts
+ * import type { IamRefreshTokenOutput } from '@h-ai/api-contract'
+ * import { IamRefreshTokenDataSchema } from '@h-ai/api-contract'
+ * import { ok } from '@h-ai/core'
+ *
+ * const response: IamRefreshTokenOutput = ok(IamRefreshTokenDataSchema.parse({
+ *   tokens: {
+ *     accessToken: 'example-only-access',
+ *     expiresIn: 0,
+ *     tokenType: 'Bearer'
+ *   }
+ * }))
+ * if (response.success) void response.data
+ * ```
+ */
 type IamRefreshTokenOutput = HaiResult<z.infer<typeof IamRefreshTokenDataSchema>>;
+/**
+ * 用户注册请求。
+ * @example
+ * ```ts
+ * import type { IamRegisterInput } from '@h-ai/api-contract'
+ * import { IamRegisterInputSchema } from '@h-ai/api-contract'
+ *
+ * const value: IamRegisterInput = IamRegisterInputSchema.parse({
+ *   username: 'alice',
+ *   password: 'example-only-password'
+ * })
+ * void value
+ * ```
+ */
 type IamRegisterInput = z.infer<typeof IamRegisterInputSchema>;
+/**
+ * 当前用户修改密码的请求。
+ * @example
+ * ```ts
+ * import type { IamChangePasswordInput } from '@h-ai/api-contract'
+ * import { IamChangePasswordInputSchema } from '@h-ai/api-contract'
+ *
+ * const value: IamChangePasswordInput = IamChangePasswordInputSchema.parse({
+ *   oldPassword: 'example',
+ *   newPassword: 'example-only-password'
+ * })
+ * void value
+ * ```
+ */
 type IamChangePasswordInput = z.infer<typeof IamChangePasswordInputSchema>;
+/**
+ * 修改当前用户资料的请求。
+ * @example
+ * ```ts
+ * import type { IamUpdateCurrentUserInput } from '@h-ai/api-contract'
+ * import { IamUpdateCurrentUserInputSchema } from '@h-ai/api-contract'
+ *
+ * const value: IamUpdateCurrentUserInput = IamUpdateCurrentUserInputSchema.parse({})
+ * void value
+ * ```
+ */
 type IamUpdateCurrentUserInput = z.infer<typeof IamUpdateCurrentUserInputSchema>;
+/**
+ * 管理员分页查询用户的请求。
+ * @example
+ * ```ts
+ * import type { IamListUsersInput } from '@h-ai/api-contract'
+ * import { IamListUsersInputSchema } from '@h-ai/api-contract'
+ *
+ * const value: IamListUsersInput = IamListUsersInputSchema.parse({})
+ * void value
+ * ```
+ */
 type IamListUsersInput = z.infer<typeof IamListUsersInputSchema>;
+/**
+ * 管理员创建用户的请求。
+ * @example
+ * ```ts
+ * import type { IamAdminCreateUserInput } from '@h-ai/api-contract'
+ * import { IamAdminCreateUserInputSchema } from '@h-ai/api-contract'
+ *
+ * const value: IamAdminCreateUserInput = IamAdminCreateUserInputSchema.parse({
+ *   username: 'alice',
+ *   password: 'example-only-password'
+ * })
+ * void value
+ * ```
+ */
 type IamAdminCreateUserInput = z.infer<typeof IamAdminCreateUserInputSchema>;
+/**
+ * 管理员修改用户的请求。
+ * @example
+ * ```ts
+ * import type { IamAdminUpdateUserInput } from '@h-ai/api-contract'
+ * import { IamAdminUpdateUserInputSchema } from '@h-ai/api-contract'
+ *
+ * const value: IamAdminUpdateUserInput = IamAdminUpdateUserInputSchema.parse({
+ *   id: 'example-1'
+ * })
+ * void value
+ * ```
+ */
 type IamAdminUpdateUserInput = z.infer<typeof IamAdminUpdateUserInputSchema>;
+/**
+ * 以用户 ID 定位目标的请求。
+ * @example
+ * ```ts
+ * import type { IamUserIdInput } from '@h-ai/api-contract'
+ * import { IamUserIdInputSchema } from '@h-ai/api-contract'
+ *
+ * const value: IamUserIdInput = IamUserIdInputSchema.parse({
+ *   id: 'example-1'
+ * })
+ * void value
+ * ```
+ */
 type IamUserIdInput = z.infer<typeof IamUserIdInputSchema>;
+/**
+ * 管理员重置用户密码的请求。
+ * @example
+ * ```ts
+ * import type { IamAdminResetPasswordInput } from '@h-ai/api-contract'
+ * import { IamAdminResetPasswordInputSchema } from '@h-ai/api-contract'
+ *
+ * const value: IamAdminResetPasswordInput = IamAdminResetPasswordInputSchema.parse({
+ *   id: 'example-1',
+ *   newPassword: 'example-only-password'
+ * })
+ * void value
+ * ```
+ */
 type IamAdminResetPasswordInput = z.infer<typeof IamAdminResetPasswordInputSchema>;
+/**
+ * 创建角色的请求。
+ * @example
+ * ```ts
+ * import type { IamCreateRoleInput } from '@h-ai/api-contract'
+ * import { IamCreateRoleInputSchema } from '@h-ai/api-contract'
+ *
+ * const value: IamCreateRoleInput = IamCreateRoleInputSchema.parse({
+ *   code: 'example-1',
+ *   name: 'Example'
+ * })
+ * void value
+ * ```
+ */
 type IamCreateRoleInput = z.infer<typeof IamCreateRoleInputSchema>;
+/**
+ * 修改角色的请求。
+ * @example
+ * ```ts
+ * import type { IamUpdateRoleInput } from '@h-ai/api-contract'
+ * import { IamUpdateRoleInputSchema } from '@h-ai/api-contract'
+ *
+ * const value: IamUpdateRoleInput = IamUpdateRoleInputSchema.parse({
+ *   id: 'example-1'
+ * })
+ * void value
+ * ```
+ */
 type IamUpdateRoleInput = z.infer<typeof IamUpdateRoleInputSchema>;
+/**
+ * 分页查询权限定义的请求。
+ * @example
+ * ```ts
+ * import type { IamListPermissionsInput } from '@h-ai/api-contract'
+ * import { IamListPermissionsInputSchema } from '@h-ai/api-contract'
+ *
+ * const value: IamListPermissionsInput = IamListPermissionsInputSchema.parse({})
+ * void value
+ * ```
+ */
 type IamListPermissionsInput = z.infer<typeof IamListPermissionsInputSchema>;
+/**
+ * 创建权限定义的请求。
+ * @example
+ * ```ts
+ * import type { IamCreatePermissionInput } from '@h-ai/api-contract'
+ * import { IamCreatePermissionInputSchema } from '@h-ai/api-contract'
+ *
+ * const value: IamCreatePermissionInput = IamCreatePermissionInputSchema.parse({
+ *   code: 'example-1',
+ *   name: 'Example'
+ * })
+ * void value
+ * ```
+ */
 type IamCreatePermissionInput = z.infer<typeof IamCreatePermissionInputSchema>;
 
 export { type IamAdminCreateUserInput, IamAdminCreateUserInputSchema, type IamAdminResetPasswordInput, IamAdminResetPasswordInputSchema, type IamAdminUpdateUserInput, IamAdminUpdateUserInputSchema, IamAgreementDisplaySchema, type IamAuthResultOutput, IamAuthResultSchema, type IamChangePasswordInput, IamChangePasswordInputSchema, IamConfirmPasswordResetInputSchema, type IamContract, type IamCreatePermissionInput, IamCreatePermissionInputSchema, type IamCreateRoleInput, IamCreateRoleInputSchema, type IamCurrentUser, type IamCurrentUserOutput, IamCurrentUserSchema, type IamLdapLoginInput, IamLdapLoginInputSchema, type IamListPermissionsInput, IamListPermissionsInputSchema, type IamListUsersInput, IamListUsersInputSchema, type IamLoginInput, IamLoginInputSchema, type IamLogoutInput, IamLogoutInputSchema, type IamOtpLoginInput, IamOtpLoginInputSchema, IamPermissionSchema, IamPermissionTypeSchema, type IamPublicConfig, IamPublicConfigSchema, IamRefreshTokenDataSchema, type IamRefreshTokenInput, IamRefreshTokenInputSchema, type IamRefreshTokenOutput, type IamRegisterInput, IamRegisterInputSchema, IamRequestPasswordResetInputSchema, IamRoleSchema, IamSendOtpDataSchema, type IamSendOtpInput, IamSendOtpInputSchema, IamTokenPairSchema, type IamUpdateCurrentUserInput, IamUpdateCurrentUserInputSchema, type IamUpdateRoleInput, IamUpdateRoleInputSchema, type IamUserIdInput, IamUserIdInputSchema, IamUserSchema, iamContract };