create-react-admin-template 0.0.0-stage → 0.1.0

package/template/src/api/query/keys.ts

@@ -0,0 +1,155 @@
+import { fnCreateAppQueryScope } from './scope'
+import type {
+  IAppQueryKeyFactory,
+  IAppQueryScope,
+  TAppQueryDetailKey,
+  TAppQueryDetailsKey,
+  TAppQueryEntityId,
+  TAppQueryFeatureKey,
+  TAppQueryListKey,
+  TAppQueryListsKey,
+  TAppQueryParameters,
+  TAppQueryParameterValue,
+  TAppQueryResourceKey,
+  TAppQueryScopeKey,
+} from './types'
+
+function fnNormalizeKeyName(strValue: string, strFieldName: string) {
+  const strNormalizedValue = strValue.trim()
+  if (!strNormalizedValue) {
+    throw new TypeError(`Query Key 字段 ${strFieldName} 不能为空。`)
+  }
+  return strNormalizedValue
+}
+
+function fnNormalizeEntityId(objEntityId: TAppQueryEntityId) {
+  if (typeof objEntityId === 'number' && !Number.isFinite(objEntityId)) {
+    throw new TypeError('Query 详情实体标识必须是有限数字或非空字符串。')
+  }
+  if (typeof objEntityId === 'string') {
+    return fnNormalizeKeyName(objEntityId, 'objEntityId')
+  }
+  return objEntityId
+}
+
+function fnNormalizeParameters(objParameters: TAppQueryParameters) {
+  const objNormalizedParameters: Record<string, TAppQueryParameterValue> = {}
+  Object.keys(objParameters)
+    .sort()
+    .forEach((strKey) => {
+      objNormalizedParameters[strKey] = fnNormalizeParameterValue(
+        objParameters[strKey],
+        strKey
+      )
+    })
+  return Object.freeze(objNormalizedParameters)
+}
+
+function fnIsParameterArray(
+  objValue: TAppQueryParameterValue
+): objValue is readonly TAppQueryParameterValue[] {
+  return Array.isArray(objValue)
+}
+
+function fnNormalizeParameterValue(
+  objValue: TAppQueryParameterValue,
+  strPath: string
+): TAppQueryParameterValue {
+  if (typeof objValue === 'number') {
+    if (!Number.isFinite(objValue)) {
+      throw new TypeError(
+        `Query 列表参数 ${strPath} 必须是可序列化的有限数字。`
+      )
+    }
+    return objValue
+  }
+  if (objValue === null || typeof objValue !== 'object') {
+    return objValue
+  }
+  if (fnIsParameterArray(objValue)) {
+    return Object.freeze(
+      objValue.map((objItem, nIndex) =>
+        fnNormalizeParameterValue(objItem, `${strPath}[${nIndex}]`)
+      )
+    )
+  }
+
+  const objNormalizedValue: Record<string, TAppQueryParameterValue> = {}
+  Object.keys(objValue)
+    .sort()
+    .forEach((strKey) => {
+      objNormalizedValue[strKey] = fnNormalizeParameterValue(
+        objValue[strKey],
+        `${strPath}.${strKey}`
+      )
+    })
+  return Object.freeze(objNormalizedValue)
+}
+
+/** 创建遵循 Feature、作用域、资源、列表/详情层级的 Query Key 工厂。 */
+export function fnCreateAppQueryKeys(
+  strFeature: string,
+  objScopeInput: IAppQueryScope
+): IAppQueryKeyFactory {
+  const strNormalizedFeature = fnNormalizeKeyName(strFeature, 'strFeature')
+  const objScope = fnCreateAppQueryScope(objScopeInput)
+  const arrAll: TAppQueryFeatureKey = ['appQuery', strNormalizedFeature]
+  const arrScope: TAppQueryScopeKey = [
+    'appQuery',
+    strNormalizedFeature,
+    objScope,
+  ]
+
+  function fnResource(strResource: string): TAppQueryResourceKey {
+    const arrQueryKey: TAppQueryResourceKey = [
+      ...arrScope,
+      fnNormalizeKeyName(strResource, 'strResource'),
+    ]
+    return Object.freeze(arrQueryKey)
+  }
+
+  function fnLists(strResource: string): TAppQueryListsKey {
+    const arrQueryKey: TAppQueryListsKey = [...fnResource(strResource), 'list']
+    return Object.freeze(arrQueryKey)
+  }
+
+  function fnList(
+    strResource: string,
+    objParameters?: TAppQueryParameters
+  ): TAppQueryListKey {
+    const arrLists = fnLists(strResource)
+    const arrQueryKey: TAppQueryListKey = objParameters
+      ? [...arrLists, fnNormalizeParameters(objParameters)]
+      : arrLists
+    return Object.freeze(arrQueryKey)
+  }
+
+  function fnDetails(strResource: string): TAppQueryDetailsKey {
+    const arrQueryKey: TAppQueryDetailsKey = [
+      ...fnResource(strResource),
+      'detail',
+    ]
+    return Object.freeze(arrQueryKey)
+  }
+
+  function fnDetail(
+    strResource: string,
+    objEntityId: TAppQueryEntityId
+  ): TAppQueryDetailKey {
+    const arrQueryKey: TAppQueryDetailKey = [
+      ...fnDetails(strResource),
+      fnNormalizeEntityId(objEntityId),
+    ]
+    return Object.freeze(arrQueryKey)
+  }
+
+  return Object.freeze({
+    arrAll: Object.freeze(arrAll),
+    arrScope: Object.freeze(arrScope),
+    fnDetail,
+    fnDetails,
+    fnList,
+    fnLists,
+    fnResource,
+  })
+}

package/template/src/api/query/mutation.ts

@@ -0,0 +1,48 @@
+import { hashKey, type QueryClient } from '@tanstack/react-query'
+import type {
+  IAppMutationScope,
+  IAppQueryRollbackSnapshot,
+  TAppQueryKey,
+  TAppQueryUpdater,
+} from './types'
+
+/** 将同一资源或实体的 Mutation 放入同一个串行执行队列。 */
+export function fnCreateAppMutationScope(
+  arrQueryKey: TAppQueryKey
+): IAppMutationScope {
+  return Object.freeze({ id: `appMutation:${hashKey(arrQueryKey)}` })
+}
+
+/** 取消精确查询、保存旧值并写入乐观结果。 */
+export async function fnApplyOptimisticQueryUpdate<TData>(
+  objQueryClient: QueryClient,
+  arrQueryKey: TAppQueryKey,
+  fnUpdate: TAppQueryUpdater<TData>
+): Promise<IAppQueryRollbackSnapshot<TData>> {
+  await objQueryClient.cancelQueries({ exact: true, queryKey: arrQueryKey })
+
+  const objPreviousValue = objQueryClient.getQueryData<TData>(arrQueryKey)
+  const objSnapshot: IAppQueryRollbackSnapshot<TData> = {
+    arrQueryKey,
+    bHadData: objPreviousValue !== undefined,
+    value: objPreviousValue,
+  }
+  objQueryClient.setQueryData<TData>(arrQueryKey, fnUpdate(objPreviousValue))
+  return Object.freeze(objSnapshot)
+}
+
+/** Mutation 失败时恢复乐观更新前的数据；原查询不存在时删除临时缓存。 */
+export function fnRollbackOptimisticQueryUpdate<TData>(
+  objQueryClient: QueryClient,
+  objSnapshot: IAppQueryRollbackSnapshot<TData>
+) {
+  if (!objSnapshot.bHadData || objSnapshot.value === undefined) {
+    objQueryClient.removeQueries({
+      exact: true,
+      queryKey: objSnapshot.arrQueryKey,
+    })
+    return
+  }
+
+  objQueryClient.setQueryData<TData>(objSnapshot.arrQueryKey, objSnapshot.value)
+}

package/template/src/api/query/react.ts

@@ -0,0 +1,36 @@
+import { useMemo } from 'react'
+import { useLocale } from '@/locale'
+import { useAuthStore } from '@/stores/authStore'
+import {
+  fnCreateApplicationScope,
+  fnResolveApplicationQueryScope,
+} from '@/context/applicationScope'
+import { fnCreateAppQueryScope } from './scope'
+import type { IUseAppQueryScopeOptions } from './types'
+
+/** 从认证状态和 Locale 唯一来源派生当前 Feature 的查询作用域。 */
+export function useAppQueryScope(objOptions: IUseAppQueryScopeOptions = {}) {
+  const { strLocale } = useLocale()
+  const nSessionGeneration = useAuthStore(
+    (objState) => objState.nSessionGeneration
+  )
+  const strTenantId = useAuthStore((objState) => objState.objUser?.strTenantId)
+  const strUserId = useAuthStore((objState) => objState.objUser?.strId)
+  const { strWorkspaceId } = objOptions
+
+  return useMemo(
+    () =>
+      fnCreateAppQueryScope(
+        fnResolveApplicationQueryScope(
+          fnCreateApplicationScope({
+            nSessionGeneration,
+            strLocale,
+            strTenantId,
+            strUserId,
+            strWorkspaceId,
+          })
+        )
+      ),
+    [nSessionGeneration, strLocale, strTenantId, strUserId, strWorkspaceId]
+  )
+}

package/template/src/api/query/scope.ts

@@ -0,0 +1,38 @@
+import type { IAppQueryScope } from './types'
+
+function fnNormalizeRequiredScopeValue(strValue: string, strFieldName: string) {
+  const strNormalizedValue = strValue.trim()
+  if (!strNormalizedValue) {
+    throw new TypeError(`Query 作用域字段 ${strFieldName} 不能为空。`)
+  }
+  return strNormalizedValue
+}
+
+function fnNormalizeOptionalScopeValue(strValue: string | undefined) {
+  const strNormalizedValue = strValue?.trim()
+  return strNormalizedValue || undefined
+}
+
+/** 创建不含凭据、可安全用于缓存隔离的应用查询作用域。 */
+export function fnCreateAppQueryScope(
+  objInput: IAppQueryScope
+): IAppQueryScope {
+  if (
+    !Number.isInteger(objInput.nSessionGeneration) ||
+    objInput.nSessionGeneration < 0
+  ) {
+    throw new TypeError('Query 作用域的会话版本必须是非负整数。')
+  }
+
+  const strTenantId = fnNormalizeOptionalScopeValue(objInput.strTenantId)
+  const strWorkspaceId = fnNormalizeOptionalScopeValue(objInput.strWorkspaceId)
+  const objScope: IAppQueryScope = {
+    nSessionGeneration: objInput.nSessionGeneration,
+    strLocale: objInput.strLocale,
+    strUserId: fnNormalizeRequiredScopeValue(objInput.strUserId, 'strUserId'),
+    ...(strTenantId ? { strTenantId } : {}),
+    ...(strWorkspaceId ? { strWorkspaceId } : {}),
+  }
+
+  return Object.freeze(objScope)
+}

package/template/src/api/query/types.ts

@@ -0,0 +1,147 @@
+import type { TAppLocale } from '@/locale'
+
+/** 可安全序列化到 Query Key 的标量值。 */
+export type TAppQueryParameterScalar = boolean | number | string | null
+
+/** 可安全序列化到 Query Key 的递归只读值。 */
+export type TAppQueryParameterValue =
+  | TAppQueryParameterScalar
+  | readonly TAppQueryParameterValue[]
+  | { readonly [strKey: string]: TAppQueryParameterValue }
+
+/** 列表筛选、排序和分页参数使用的只读 Query Key 对象。 */
+export type TAppQueryParameters = Readonly<
+  Record<string, TAppQueryParameterValue>
+>
+
+/** 详情资源允许使用的稳定实体标识。 */
+export type TAppQueryEntityId = number | string
+
+/** 已标准化后可直接进入 Query Key 的完整应用查询作用域。 */
+export interface IAppQueryScope {
+  /** 当前认证会话版本；登录、退出或授权上下文变化时递增。 */
+  readonly nSessionGeneration: number
+  /** 当前应用语言，用于隔离包含本地化内容的服务端数据。 */
+  readonly strLocale: TAppLocale
+  /** 当前用户的稳定标识；未登录请求统一使用 `anonymous`。 */
+  readonly strUserId: string
+  /** 当前租户标识；单租户系统可以不提供。 */
+  readonly strTenantId?: string
+  /** 当前组织、项目或工作空间标识；没有二级作用域时不提供。 */
+  readonly strWorkspaceId?: string
+}
+
+/** React Feature 读取当前查询作用域时允许补充的上下文。 */
+export interface IUseAppQueryScopeOptions {
+  /**
+   * 所属 Feature 已校验的工作空间稳定标识；省略时不启用二级作用域。
+   * 用户、租户和语言始终由应用状态提供。
+   */
+  readonly strWorkspaceId?: string
+}
+
+/** 一个 Feature 在所有身份作用域下的查询根 Key。 */
+export type TAppQueryFeatureKey = readonly ['appQuery', string]
+
+/** 一个 Feature 在当前用户、租户、语言和会话下的查询根 Key。 */
+export type TAppQueryScopeKey = readonly ['appQuery', string, IAppQueryScope]
+
+/** 当前作用域下某类服务端资源的查询根 Key。 */
+export type TAppQueryResourceKey = readonly [
+  'appQuery',
+  string,
+  IAppQueryScope,
+  string,
+]
+
+/** 当前资源全部列表查询的 Key。 */
+export type TAppQueryListsKey = readonly [
+  'appQuery',
+  string,
+  IAppQueryScope,
+  string,
+  'list',
+]
+
+/** 当前资源某个列表查询的精确 Key。 */
+export type TAppQueryListKey =
+  | TAppQueryListsKey
+  | readonly [
+      'appQuery',
+      string,
+      IAppQueryScope,
+      string,
+      'list',
+      TAppQueryParameters,
+    ]
+
+/** 当前资源全部详情查询的 Key。 */
+export type TAppQueryDetailsKey = readonly [
+  'appQuery',
+  string,
+  IAppQueryScope,
+  string,
+  'detail',
+]
+
+/** 当前资源某个实体详情的精确 Key。 */
+export type TAppQueryDetailKey = readonly [
+  'appQuery',
+  string,
+  IAppQueryScope,
+  string,
+  'detail',
+  TAppQueryEntityId,
+]
+
+/** Query 基础设施创建的全部合法 Key 形状。 */
+export type TAppQueryKey =
+  | TAppQueryFeatureKey
+  | TAppQueryScopeKey
+  | TAppQueryResourceKey
+  | TAppQueryListKey
+  | TAppQueryDetailsKey
+  | TAppQueryDetailKey
+
+/** 一个 Feature 使用的层级化 Query Key 工厂。 */
+export interface IAppQueryKeyFactory {
+  /** 当前 Feature 的全部查询；只用于跨作用域清理或诊断。 */
+  readonly arrAll: TAppQueryFeatureKey
+  /** 当前身份作用域内该 Feature 的全部查询。 */
+  readonly arrScope: TAppQueryScopeKey
+  /** 创建某类资源的根 Key。 */
+  readonly fnResource: (strResource: string) => TAppQueryResourceKey
+  /** 创建某类资源全部列表查询的 Key。 */
+  readonly fnLists: (strResource: string) => TAppQueryListsKey
+  /** 创建带可序列化筛选、排序或分页参数的列表 Key。 */
+  readonly fnList: (
+    strResource: string,
+    objParameters?: TAppQueryParameters
+  ) => TAppQueryListKey
+  /** 创建某类资源全部详情查询的 Key。 */
+  readonly fnDetails: (strResource: string) => TAppQueryDetailsKey
+  /** 创建某个稳定实体标识对应的详情 Key。 */
+  readonly fnDetail: (
+    strResource: string,
+    objEntityId: TAppQueryEntityId
+  ) => TAppQueryDetailKey
+}
+
+/** TanStack Mutation 的同目标串行执行作用域。 */
+export interface IAppMutationScope {
+  /** 由 Query Key 稳定派生的 Mutation 串行队列标识。 */
+  readonly id: string
+}
+
+/** 一次乐观更新前保存的精确 Query 缓存快照。 */
+export interface IAppQueryRollbackSnapshot<TData> {
+  /** 被乐观更新的精确 Query Key。 */
+  readonly arrQueryKey: TAppQueryKey
+  /** 更新前是否存在可恢复的缓存数据。 */
+  readonly bHadData: boolean
+  /** 更新前的缓存数据；原查询不存在时为 `undefined`。 */
+  readonly value: TData | undefined
+}
+
+/** 根据旧缓存计算乐观结果的纯更新函数。 */
+export type TAppQueryUpdater<TData> = (value: TData | undefined) => TData

package/template/src/api/types.ts

@@ -0,0 +1,144 @@
+import type { AxiosInstance } from 'axios'
+
+/** API 失败所属的稳定类别，用于决定恢复方式而不是展示技术细节。 */
+export type TApiErrorKind =
+  | 'client'
+  | 'http'
+  | 'invalid_response'
+  | 'network'
+  | 'timeout'
+  | 'unknown'
+
+/** 创建标准 API 错误时允许写入的安全字段。 */
+export interface IApiErrorOptions {
+  /** 面向用户和业务代码的错误文案，不能包含原始响应或凭据。 */
+  strMessage: string
+  /** 后端业务码或前端稳定错误码。 */
+  strCode: string
+  /** 失败类别。 */
+  strKind: TApiErrorKind
+  /** HTTP 状态码；网络错误和客户端错误可能不存在。 */
+  nStatus?: number
+  /** 服务端返回或客户端生成的请求关联 ID。 */
+  strRequestId?: string
+  /** 后端明确提供的字段校验明细；全局日志和提示不得默认展开。 */
+  objDetails?: unknown
+  /** 是否适合由用户或调用方再次尝试；不会自动触发重试。 */
+  bRetriable: boolean
+}
+
+// Swagger 响应信封字段由后端契约固定为 data。
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export type TApiEnvelope<T> = { data?: T }
+
+export interface IAuthIdentityResult {
+  /** 后端授予的稳定权限码集合；省略表示刷新时沿用现有值。 */
+  arrPermissions?: string[]
+  /** 后端授予的角色编码集合；省略表示刷新时沿用现有值。 */
+  arrRoleCodes?: string[]
+  /** 当前用户稳定唯一标识。 */
+  strId?: string
+  /** 可安全展示的脱敏登录账号。 */
+  strMaskedPhone?: string
+  /** 当前用户展示名称。 */
+  strNickname?: string
+  /** 当前用户所属组织的展示名称。 */
+  strOrganizationName?: string
+  /** 后端返回的可选身份类型；应用授权应使用权限码而不是硬编码该字段。 */
+  strRole?: string
+  /** 当前租户稳定标识，用于缓存与数据隔离。 */
+  strTenantId?: string
+  /** 当前用户头像地址。 */
+  strAvatarUrl?: string
+}
+
+/** 登录错误读取器使用的本地化回退文案。 */
+export interface IAuthErrorMessages {
+  /** 无法从错误对象读取安全消息时使用。 */
+  strFallbackMessage: string
+  /** 认证服务没有返回 HTTP 响应时使用。 */
+  strNetworkMessage: string
+}
+
+export interface IAuthTokenResult {
+  /** 后端签发的短期访问令牌。 */
+  strAccessToken: string
+  /** 后端签发或滚动更新的刷新令牌。 */
+  strRefreshToken: string
+  /** 访问令牌有效期，单位为秒。 */
+  nExpiresIn?: number
+  /** 刷新会话空闲有效期，单位为秒。 */
+  nRefreshIdleExpiresIn?: number
+  /** 刷新令牌绝对有效期，单位为秒。 */
+  nRefreshExpiresIn?: number
+  /** 登录或刷新时返回的身份与授权快照。 */
+  objUser?: IAuthIdentityResult
+}
+
+export interface IAuthSignInInput {
+  /** 令牌预期使用方。 */
+  strAudience: string
+  /** 浏览器应用的公开 OAuth Client ID。 */
+  strClientId: string
+  /** 用户输入的登录密码，不得记录或持久化。 */
+  strPassword: string
+  /** 用户输入的登录手机号。 */
+  strPhone: string
+  /** 本次登录申请的 OAuth Scope。 */
+  strScope: string
+}
+
+export interface IAuthRefreshInput {
+  /** 浏览器应用的公开 OAuth Client ID。 */
+  strClientId: string
+  /** 当前会话刷新令牌，不得记录到日志。 */
+  strRefreshToken: string
+}
+
+export interface IAuthSignOutInput {
+  /** 需要由后端撤销的刷新令牌。 */
+  strRefreshToken: string
+}
+
+export interface IAuthApiClient {
+  /** 使用第一方凭据建立认证会话。 */
+  fnFirstPartyLogin: (objInput: IAuthSignInInput) => Promise<IAuthTokenResult>
+  /** 在当前会话内刷新令牌和可选的授权快照。 */
+  fnRefreshToken: (
+    objInput: IAuthRefreshInput,
+    objSignal: AbortSignal
+  ) => Promise<IAuthTokenResult>
+  /** 撤销后端刷新会话。 */
+  fnSignOut: (objInput: IAuthSignOutInput) => Promise<void>
+}
+
+export interface IGeneratedApiClient {
+  /** 由 swagger-typescript-api 生成客户端暴露的 Axios 实例。 */
+  instance: AxiosInstance
+}
+
+declare module 'axios' {
+  interface AxiosRequestConfig {
+    /** 成功后交给应用消息层展示的文案。 */
+    strSuccessMessage?: string
+    /** 是否向应用错误处理器报告错误，默认开启。 */
+    bShowError?: boolean
+    /** 当前请求的关联 ID；未提供时由请求 Hook 自动生成。 */
+    strRequestId?: string
+    /** 同一次写操作在首次提交、重试和结果确认间复用的幂等键。 */
+    strIdempotencyKey?: string
+    /** 单个请求的加载状态回调。 */
+    fnProgress?: (bLoading: boolean) => void
+    /** 单个请求覆盖默认请求处理的回调。 */
+    fnBeforeRequest?: (
+      objRequest: import('axios').InternalAxiosRequestConfig
+    ) => void
+    /** 单个请求的响应观察回调。 */
+    fnBeforeResponse?: (objResponse: import('axios').AxiosResponse) => void
+  }
+
+  interface AxiosResponse {
+    /** 服务端响应头中的请求 ID，不存在时回退到客户端请求 ID。 */
+    strRequestId?: string
+  }
+}

package/template/src/application/types.ts

@@ -0,0 +1,52 @@
+import type { TAppLocale, TSharedMessageOverrides } from '@/locale'
+import type { IEnumCatalogScopeContext, IEnumCatalogSource } from '@/api/enums'
+import type {
+  IGlobalParameterScopeContext,
+  IGlobalParameterSource,
+} from '@/api/parameters'
+
+/** 全局枚举能力的应用级配置。 */
+export interface IApplicationEnumCatalogOptions {
+  /** 是否允许加载全局枚举；默认仅在认证完成后启用。 */
+  readonly bIsEnabled?: boolean
+  /** 枚举命名空间或身份作用域覆盖。 */
+  readonly objScope?: IEnumCatalogScopeContext
+  /** 由 Swagger 生成客户端适配的后端数据源。 */
+  readonly objSource?: IEnumCatalogSource
+}
+
+/** 全局参数能力的应用级配置。 */
+export interface IApplicationGlobalParameterOptions {
+  /** 是否允许加载全局参数；默认仅在认证完成后启用。 */
+  readonly bIsEnabled?: boolean
+  /** 参数命名空间或身份作用域覆盖。 */
+  readonly objScope?: IGlobalParameterScopeContext
+  /** 由 Swagger 生成客户端适配的后端数据源。 */
+  readonly objSource?: IGlobalParameterSource
+}
+
+/** 后端元数据能力的应用级配置。 */
+export interface IApplicationMetadataOptions {
+  /** 全局枚举目录配置。 */
+  readonly objEnumCatalog?: IApplicationEnumCatalogOptions
+  /** 全局参数目录配置。 */
+  readonly objGlobalParameters?: IApplicationGlobalParameterOptions
+}
+
+/** 语言、时区和共享文案的应用级配置。 */
+export interface IApplicationLocaleOptions {
+  /** 应用、共享模块和后端元数据共同使用的语言。 */
+  readonly strLocale?: TAppLocale
+  /** 应用统一 IANA 时区。 */
+  readonly strTimeZone?: string
+  /** 项目对共享壳层文案的按语言覆盖。 */
+  readonly objSharedMessages?: TSharedMessageOverrides
+}
+
+/** 应用根组合点的稳定配置。 */
+export interface IApplicationOptions {
+  /** 语言、时区与共享文案。 */
+  readonly objLocale?: IApplicationLocaleOptions
+  /** 全局枚举和参数能力。 */
+  readonly objMetadata?: IApplicationMetadataOptions
+}

package/template/src/auditLogs/errors.ts

@@ -0,0 +1,17 @@
+import type { TAuditLogErrorCode } from './types'
+
+/** 可由审计 Feature、日志和测试稳定分类的边界错误。 */
+export class AuditLogError extends Error {
+  /** 稳定错误码。 */
+  readonly strCode: TAuditLogErrorCode
+
+  constructor(
+    strCode: TAuditLogErrorCode,
+    strMessage: string,
+    objOptions?: ErrorOptions
+  ) {
+    super(strMessage, objOptions)
+    this.name = 'AuditLogError'
+    this.strCode = strCode
+  }
+}