@h-ai/audit 0.1.0-alpha5

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2026] [idealworld.group]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,113 @@
+# @h-ai/audit
+
+统一审计日志模块，通过 `audit` 对象提供审计日志的记录、查询、清理与统计功能，基于 `@h-ai/reldb` 实现持久化。
+
+## 依赖
+
+- `@h-ai/reldb` — 数据库（审计日志持久化），**需在 audit.init() 前初始化**
+
+## 适用场景
+
+- 用户操作审计（登录、登出、注册、密码重置等）
+- CRUD 操作审计（创建、读取、更新、删除资源）
+- 安全事件追踪与合规审计
+- 运营数据统计（操作频次、活跃用户等）
+
+## 快速开始
+
+```ts
+import { audit } from '@h-ai/audit'
+import { reldb } from '@h-ai/reldb'
+
+// 1. 初始化依赖
+await reldb.init({ type: 'sqlite', database: './data.db' })
+
+// 2. 初始化审计模块（自动使用已初始化的 reldb 单例）
+const result = await audit.init()
+if (!result.success) {
+  throw new Error(result.error.message)
+}
+
+// 3. 记录审计日志
+await audit.log({
+  userId: 'user_1',
+  action: 'login',
+  resource: 'auth',
+  ipAddress: '127.0.0.1',
+})
+
+// 4. 使用便捷方法
+await audit.helper.login('user_1', '127.0.0.1')
+await audit.helper.crud({ userId: 'user_1', action: 'create', resource: 'users', resourceId: 'user_2', details: { name: '张三' } })
+
+// 5. 查询日志
+const logs = await audit.list({ pageSize: 20, action: 'login' })
+
+// 6. 获取统计
+const stats = await audit.getStats(7) // 最近 7 天
+
+// 7. 清理旧日志
+await audit.cleanup(90) // 清理 90 天前的日志
+
+// 8. 关闭
+await audit.close()
+```
+
+## 初始化配置
+
+```ts
+// 默认配置（无需传参）
+await audit.init()
+
+// 自定义用户表映射
+await audit.init({
+  userTable: 'hai_iam_users', // 用户表名（默认 'hai_iam_users'）
+  userIdColumn: 'id', // 用户表主键列名（默认 'id'）
+  userNameColumn: 'username', // 用户表用户名列名（默认 'username'）
+})
+```
+
+审计日志固定存储在 `hai_audit_logs` 表中，依赖 `@h-ai/reldb` 已初始化。
+
+## API 概览
+
+- `audit.init(config)` - 初始化审计模块
+- `audit.log(input)` - 记录审计日志
+- `audit.list(options)` - 分页查询审计日志（含用户名 JOIN）
+- `audit.getUserRecent(userId, limit)` - 获取用户最近活动
+- `audit.cleanup(days)` - 清理旧日志
+- `audit.getStats(days)` - 获取操作统计
+- `audit.helper.login/logout/register/...` - 便捷记录器
+- `audit.close()` - 关闭模块
+
+### 输入约束
+
+- `audit.log(input)`：`action` / `resource` 必须为非空字符串，且长度不超过 256。
+- `audit.list(options)`：若同时传 `startDate` 与 `endDate`，必须满足 `startDate <= endDate`。
+- `audit.getUserRecent(userId, limit)`：`userId` 必须为非空字符串；`limit`（如传入）必须为正整数。
+- `audit.cleanup(days)`：`days`（如传入）必须为非负整数。
+- `audit.getStats(days)`：`days`（如传入）必须为非负整数。
+
+## 错误码
+
+所有操作返回 `HaiResult<T>`，常用错误码如下：
+
+| 错误码                           | code            | 说明         |
+| -------------------------------- | --------------- | ------------ |
+| `HaiAuditError.LOG_FAILED`       | `hai:audit:001` | 记录失败     |
+| `HaiAuditError.QUERY_FAILED`     | `hai:audit:002` | 查询失败     |
+| `HaiAuditError.CLEANUP_FAILED`   | `hai:audit:003` | 清理失败     |
+| `HaiAuditError.STATS_FAILED`     | `hai:audit:004` | 统计失败     |
+| `HaiAuditError.INIT_IN_PROGRESS` | `hai:audit:005` | 初始化进行中 |
+| `HaiAuditError.NOT_INITIALIZED`  | `hai:audit:010` | 模块未初始化 |
+| `HaiAuditError.CONFIG_ERROR`     | `hai:audit:012` | 配置错误     |
+
+## 测试
+
+```bash
+pnpm --filter @h-ai/audit test
+```
+
+## License
+
+Apache-2.0

package/dist/index.d.ts

@@ -0,0 +1,365 @@
+import { z } from 'zod';
+import * as _h_ai_core from '@h-ai/core';
+import { HaiResult } from '@h-ai/core';
+
+/**
+ * @h-ai/audit — 错误码与配置
+ *
+ * 定义审计模块的错误码常量与初始化配置类型。
+ * @module audit-config
+ */
+
+/**
+ * 审计模块初始化配置 Schema（Zod）
+ *
+ * 所有字段均有默认值，可直接调用 `audit.init()` 无需传参。
+ *
+ * @example
+ * ```ts
+ * import { audit } from '@h-ai/audit'
+ * import { reldb } from '@h-ai/reldb'
+ *
+ * await audit.init()
+ *
+ * // 自定义用户表映射
+ * await audit.init({
+ *   userTable: 'sys_users',
+ *   userIdColumn: 'user_id',
+ *   userNameColumn: 'name',
+ * })
+ * ```
+ */
+declare const AuditInitConfigSchema: z.ZodObject<{
+    userTable: z.ZodDefault<z.ZodString>;
+    userIdColumn: z.ZodDefault<z.ZodString>;
+    userNameColumn: z.ZodDefault<z.ZodString>;
+}, z.core.$strip>;
+/** 审计模块初始化配置（解析后） */
+type AuditInitConfig = z.output<typeof AuditInitConfigSchema>;
+/** 审计模块初始化配置（传入参数） */
+type AuditInitConfigInput = z.input<typeof AuditInitConfigSchema>;
+
+declare const HaiAuditError: {
+    readonly LOG_FAILED: _h_ai_core.HaiErrorDef;
+    readonly QUERY_FAILED: _h_ai_core.HaiErrorDef;
+    readonly CLEANUP_FAILED: _h_ai_core.HaiErrorDef;
+    readonly STATS_FAILED: _h_ai_core.HaiErrorDef;
+    readonly INIT_IN_PROGRESS: _h_ai_core.HaiErrorDef;
+    readonly NOT_INITIALIZED: _h_ai_core.HaiErrorDef;
+    readonly CONFIG_ERROR: _h_ai_core.HaiErrorDef;
+};
+/**
+ * 审计日志记录
+ *
+ * 表示一条已持久化的审计日志条目。
+ */
+interface AuditLog {
+    /** 审计日志 ID，格式为 `audit_` 前缀 + 随机串 */
+    id: string;
+    /** 操作用户 ID；系统操作时为 null */
+    userId: string | null;
+    /** 操作类型（如 login / logout / create / update / delete） */
+    action: string;
+    /** 资源类型（如 auth / users / roles） */
+    resource: string;
+    /** 资源 ID；不涉及特定资源时为 null */
+    resourceId: string | null;
+    /** 操作详情（JSON 字符串）；无详情时为 null */
+    details: string | null;
+    /** 客户端 IP 地址；未知时为 null */
+    ipAddress: string | null;
+    /** 客户端 User-Agent；未知时为 null */
+    userAgent: string | null;
+    /** 创建时间 */
+    createdAt: Date;
+}
+/**
+ * 审计日志记录（含用户名）
+ *
+ * 通过 LEFT JOIN 用户表获取 username 字段，用于列表展示。
+ */
+interface AuditLogWithUser extends AuditLog {
+    /** 操作用户的用户名；用户不存在或系统操作时为 null */
+    username: string | null;
+}
+/**
+ * 创建审计日志输入
+ *
+ * 调用 {@link AuditFunctions.log} 时传入的参数。
+ * 仅 `action` 和 `resource` 为必填。
+ */
+interface CreateAuditLogInput {
+    /** 操作用户 ID；系统操作可省略 */
+    userId?: string | null;
+    /** 操作类型（如 login / create / update / delete） */
+    action: string;
+    /** 资源类型（如 auth / users / roles） */
+    resource: string;
+    /** 资源 ID；不涉及特定资源时可省略 */
+    resourceId?: string | null;
+    /** 操作详情对象，会被 JSON 序列化存储 */
+    details?: Record<string, unknown> | null;
+    /** 客户端 IP 地址 */
+    ipAddress?: string | null;
+    /** 客户端 User-Agent */
+    userAgent?: string | null;
+}
+/**
+ * 审计日志列表查询选项
+ *
+ * 所有字段均为可选，不传则不过滤。
+ */
+interface ListAuditLogsOptions {
+    /** 按用户 ID 过滤 */
+    userId?: string;
+    /** 按操作类型过滤（精确匹配） */
+    action?: string;
+    /** 按资源类型过滤（精确匹配） */
+    resource?: string;
+    /** 起始时间（含），只返回此时间之后的日志 */
+    startDate?: Date;
+    /** 结束时间（含），只返回此时间之前的日志 */
+    endDate?: Date;
+    /** 页码，从 1 开始 */
+    page?: number;
+    /**
+     * 每页条数
+     *
+     * @default 20
+     */
+    pageSize?: number;
+}
+/**
+ * 审计统计结果项
+ *
+ * 按操作类型（action）分组的统计条目。
+ */
+interface AuditStatItem {
+    /** 操作类型 */
+    action: string;
+    /** 该操作在统计时间范围内的次数 */
+    count: number;
+}
+/**
+ * CRUD 审计操作输入
+ *
+ * 调用 {@link AuditHelper.crud} 时传入的参数。
+ */
+interface CrudAuditInput {
+    /** 操作用户 ID（系统操作传 null） */
+    userId?: string | null;
+    /** 操作类型 */
+    action: 'create' | 'read' | 'update' | 'delete';
+    /** 资源类型（如 users / roles） */
+    resource: string;
+    /** 资源 ID（可选） */
+    resourceId?: string;
+    /** 操作详情对象（可选） */
+    details?: Record<string, unknown>;
+    /** 客户端 IP（可选） */
+    ip?: string;
+    /** 客户端 User-Agent（可选） */
+    ua?: string;
+}
+/**
+ * 审计便捷记录器
+ *
+ * 封装常见审计场景（认证、CRUD），简化调用方代码。
+ * 通过 {@link AuditFunctions.helper} 访问。
+ *
+ * @example
+ * ```ts
+ * await audit.helper.login('user_1', '127.0.0.1', 'Mozilla/5.0')
+ * await audit.helper.crud({ userId: 'user_1', action: 'create', resource: 'users', resourceId: 'user_2' })
+ * ```
+ */
+interface AuditHelper {
+    /**
+     * 记录用户登录
+     *
+     * @param userId - 登录用户 ID
+     * @param ip - 客户端 IP（可选）
+     * @param ua - 客户端 User-Agent（可选）
+     */
+    login: (userId: string, ip?: string, ua?: string) => Promise<HaiResult<void>>;
+    /**
+     * 记录用户登出
+     *
+     * @param userId - 登出用户 ID
+     * @param ip - 客户端 IP（可选）
+     * @param ua - 客户端 User-Agent（可选）
+     */
+    logout: (userId: string, ip?: string, ua?: string) => Promise<HaiResult<void>>;
+    /**
+     * 记录用户注册
+     *
+     * @param userId - 注册用户 ID
+     * @param ip - 客户端 IP（可选）
+     * @param ua - 客户端 User-Agent（可选）
+     */
+    register: (userId: string, ip?: string, ua?: string) => Promise<HaiResult<void>>;
+    /**
+     * 记录密码重置请求
+     *
+     * @param email - 请求重置的邮箱地址
+     * @param ip - 客户端 IP（可选）
+     * @param ua - 客户端 User-Agent（可选）
+     */
+    passwordResetRequest: (email: string, ip?: string, ua?: string) => Promise<HaiResult<void>>;
+    /**
+     * 记录密码重置完成
+     *
+     * @param userId - 重置密码的用户 ID（匿名重置场景传 null）
+     * @param ip - 客户端 IP（可选）
+     * @param ua - 客户端 User-Agent（可选）
+     */
+    passwordResetComplete: (userId: string | null, ip?: string, ua?: string) => Promise<HaiResult<void>>;
+    /**
+     * 记录 CRUD 操作
+     *
+     * @param input - CRUD 审计输入（action 和 resource 为必填）
+     *
+     * @example
+     * ```ts
+     * await audit.helper.crud({ userId: 'user_1', action: 'create', resource: 'users', resourceId: 'user_2' })
+     * ```
+     */
+    crud: (input: CrudAuditInput) => Promise<HaiResult<void>>;
+}
+/**
+ * 审计模块函数接口
+ *
+ * 统一的审计日志访问入口。
+ *
+ * @example
+ * ```ts
+ * import { audit } from '@h-ai/audit'
+ * import { reldb } from '@h-ai/reldb'
+ *
+ * await reldb.init({ type: 'sqlite', database: './data.db' })
+ * await audit.init()
+ *
+ * await audit.log({ userId: 'user_1', action: 'login', resource: 'auth' })
+ * const logs = await audit.list({ pageSize: 10 })
+ * await audit.close()
+ * ```
+ */
+interface AuditFunctions {
+    /**
+     * 初始化审计模块
+     *
+     * @param config - 初始化配置（可选，所有字段均有默认值）
+     * @returns 成功时返回 ok(undefined)；失败时返回 CONFIG_ERROR
+     */
+    init: (config?: AuditInitConfigInput) => Promise<HaiResult<void>>;
+    /**
+     * 关闭审计模块，释放内部状态
+     */
+    close: () => Promise<void>;
+    /** 当前是否已初始化 */
+    readonly isInitialized: boolean;
+    /**
+     * 记录一条审计日志
+     *
+     * @param input - 日志内容（action 和 resource 为必填）
+     * @returns 成功时返回创建的 AuditLog；失败时返回 LOG_FAILED
+     */
+    log: (input: CreateAuditLogInput) => Promise<HaiResult<AuditLog>>;
+    /**
+     * 分页查询审计日志列表（含用户名 LEFT JOIN）
+     *
+     * @param options - 查询过滤与分页选项
+     * @returns 成功时返回 { items, total }；失败时返回 QUERY_FAILED
+     */
+    list: (options?: ListAuditLogsOptions) => Promise<HaiResult<{
+        items: AuditLogWithUser[];
+        total: number;
+    }>>;
+    /**
+     * 获取指定用户的最近活动记录
+     *
+     * @param userId - 用户 ID
+     * @param limit - 最大返回条数，默认 10
+     * @returns 成功时返回 AuditLog 数组；失败时返回 QUERY_FAILED
+     */
+    getUserRecent: (userId: string, limit?: number) => Promise<HaiResult<AuditLog[]>>;
+    /**
+     * 清理指定天数之前的旧日志
+     *
+     * @param olderThanDays - 保留天数，默认 90；清理此天数之前的日志
+     * @returns 成功时返回删除的记录数；失败时返回 CLEANUP_FAILED
+     */
+    cleanup: (olderThanDays?: number) => Promise<HaiResult<number>>;
+    /**
+     * 获取指定天数内的操作统计（按 action 分组计数）
+     *
+     * @param days - 统计天数，默认 7
+     * @returns 成功时返回 AuditStatItem 数组；失败时返回 STATS_FAILED
+     */
+    getStats: (days?: number) => Promise<HaiResult<AuditStatItem[]>>;
+    /**
+     * 便捷记录器，封装常见审计场景
+     *
+     * 未初始化时调用任意方法均返回 NOT_INITIALIZED 错误。
+     */
+    readonly helper: AuditHelper;
+}
+
+/**
+ * @h-ai/audit — 审计便捷记录器
+ *
+ * 封装常见审计操作（登录、登出、注册、密码重置、CRUD），简化调用方代码。
+ * @module audit-helper
+ */
+
+/**
+ * 创建便捷记录器
+ *
+ * 封装常见审计操作（登录、登出、注册、密码重置、CRUD），
+ * 简化调用方代码。每个方法内部调用 logFn 并将 AuditLog 结果映射为 void。
+ *
+ * @param logFn - 底层日志记录函数（通常为 currentRepo.log）
+ * @returns 便捷记录器接口
+ */
+declare function createHelper(logFn: (input: CreateAuditLogInput) => Promise<HaiResult<AuditLog>>): AuditHelper;
+
+/**
+ * @h-ai/audit — 审计日志服务主入口
+ *
+ * 本文件提供统一的 `audit` 对象，聚合所有审计日志操作功能。
+ * @module audit-main
+ */
+
+/**
+ * 审计日志服务对象
+ *
+ * 统一的审计日志访问入口，提供以下功能：
+ * - `audit.init()` — 初始化审计模块
+ * - `audit.close()` — 关闭模块
+ * - `audit.log()` — 记录审计日志
+ * - `audit.list()` — 查询审计日志列表
+ * - `audit.getUserRecent()` — 获取用户最近活动
+ * - `audit.cleanup()` — 清理旧日志
+ * - `audit.getStats()` — 获取统计数据
+ * - `audit.helper` — 便捷记录器
+ * - `audit.isInitialized` — 初始化状态
+ *
+ * @example
+ * ```ts
+ * import { audit } from '@h-ai/audit'
+ * import { reldb } from '@h-ai/reldb'
+ *
+ * await reldb.init({ type: 'sqlite', database: ':memory:' })
+ * const result = await audit.init()
+ * if (!result.success) {
+ *   // 处理初始化错误
+ * }
+ *
+ * await audit.helper.login('user_1', '127.0.0.1')
+ * const logs = await audit.list({ pageSize: 10 })
+ * await audit.close()
+ * ```
+ */
+declare const audit: AuditFunctions;
+
+export { type AuditFunctions, type AuditHelper, type AuditInitConfig, type AuditInitConfigInput, AuditInitConfigSchema, type AuditLog, type AuditLogWithUser, type AuditStatItem, type CreateAuditLogInput, type CrudAuditInput, HaiAuditError, type ListAuditLogsOptions, audit, createHelper };