@cap-js/audit-logging

中文文档
1.3.0发布于 2026/09/10Apache-2.0CommonJS零依赖构建来源已验证近 30 天下载 4.7万

CDS插件为SAP审计日志服务提供集成功能,并基于说明进行与个人数据相关的审计记录外.

中文使用文档
文档目录8 节
  1. 初步内容
  2. 设置
  3. 注释个人数据
  4. 本地驱动测试
  5. 在生产
  6. 支持、反馈、贡献
  7. 行为守则
  8. 许可证发放

欢迎使用@cap-js/ 审计- logb

REUSE status

@cap-js/audit-logging 是一个CDS插件,为SAP审计日志服务提供集成,以及基于说明的外框个人数据相关审计日志.

文件可在下列地点找到: 顶点. cloud.sap。 。 。 .

[大 此文件中的信息绝非完整, 而是能够快速启动 。 确保到 顶点. cloud.sap 要得到完整的图片.

初步内容

在这个指南中,我们使用 事件管理参考应用样本 作为添加更改跟踪到中的基础。 清除存储器并应用分步骤指令:

git clone https://github.com/cap-js/incidents-app
cd incidents-app
npm i

设置

为了启用审计记录, 只需在您的工程中添加此自配置插件包 :

npm add @cap-js/audit-logging

注释个人数据

(可能)使用 @PersonalData 说明。 创建一个 db/data-privacy.cds 文件并添加以下内容:

using { sap.capire.incidents as my } from './schema';

annotate my.Customers with @PersonalData : {
  DataSubjectRole : 'Customer',
  EntitySemantics : 'DataSubject'
} {
  ID           @PersonalData.FieldSemantics: 'DataSubjectID';
  firstName    @PersonalData.IsPotentiallyPersonal;
  lastName     @PersonalData.IsPotentiallyPersonal;
  email        @PersonalData.IsPotentiallyPersonal;
  phone        @PersonalData.IsPotentiallyPersonal;
  creditCardNo @PersonalData.IsPotentiallySensitive;
};

annotate my.Addresses with @PersonalData: {
  EntitySemantics : 'DataSubjectDetails'
} {
  customer      @PersonalData.FieldSemantics: 'DataSubjectID';
  city          @PersonalData.IsPotentiallyPersonal;
  postCode      @PersonalData.IsPotentiallyPersonal;
  streetAddress @PersonalData.IsPotentiallyPersonal;
};

annotate my.Incidents with @PersonalData : {
  EntitySemantics : 'Other'
} {
  customer @PersonalData.FieldSemantics: 'DataSubjectID';
};

了解更多关于顶部的注释:

本地驱动测试

你准备了一切记录个人数据事件 让我们看看行动.

如常启动服务器 :

cds watch

发送更改个人数据的更新请求 :

PATCH http://localhost:4004/odata/v4/admin/Customers('1004155')
Authorization: Basic alice:in-wonderland
Content-Type: application/json

{
  "firstName": "Danny",
  "lastName": "Joules"
}

参见服务器控制台输出中的审计日志 :

[audit-log] - PersonalDataModified: {
  data_subject: {
    id: { ID: '1004155' },
    role: 'Customer',
    type: 'AdminService.Customers'
  },
  object: {
   type: 'AdminService.Customers',
   id: { ID: '1004155' }
  },
  attributes: [
    { name: 'firstName', old: 'Daniel', new: 'Danny' },
    { name: 'lastName', old: 'Watts', new: 'Joules' }
  ],
  uuid: '71fa93d9-c993-405f-ba1b-a9ef42668199',
  tenant: 't1',
  user: 'alice',
  time: 2023-02-26T08:13:48.287Z
}

在生产

此插件提供的端到端的外框功能需要付费例如 SAP 客户审计日志服务然而,可以提供一种将审计日志写入自定义商店的自我执行.

更多地了解使用SAP审计日志服务的情况.

学习更多关于定制审计记录.

支持、反馈、贡献

此项目可通过下列方式对特性请求/建议、错误报告等开放: GitHub 问题鼓励并始终欢迎各方作出贡献和反馈。 关于如何作出贡献的更多信息,项目结构以及额外贡献信息见我们 贡献准则。 。 。 .

行为守则

作为成员、贡献者和领导人,我们保证使参加我们的社区成为每个人不受骚扰的经历。 通过参与这个项目,你同意遵守 行为守则 在任何时间.

许可证发放

版权2023 SAP SE或SAP下属公司和贡献者。 请看我们的 自由主义 版权和许可证信息。 详细信息,包括第三方组成部分及其许可证/版权信息 通过REUSE工具。 。 。 .

版本与发布记录

@cap-js/audit-logging 共发布 24 个版本,首次发布于 2023/08/18;过去 12 个月发布了 4 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.3.0latest2026/09/101 个月前
1.2.22026/06/184 个月前
1.2.12026/05/135 个月前
1.2.02026/02/248 个月前
1.1.12025/10/271 年前
1.1.02025/09/091.2 年前

关于 @cap-js/audit-logging 的常见问题

@cap-js/audit-logging 是什么?

CDS插件为SAP审计日志服务提供集成功能,并基于说明进行与个人数据相关的审计记录外.

如何安装 @cap-js/audit-logging?

在项目目录运行 npm install @cap-js/audit-logging,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@sap/cds(>=9)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@cap-js/audit-logging 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/cap-js__audit-logging 是否存在。

@cap-js/audit-logging 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@cap-js/audit-logging 可以商用吗?

@cap-js/audit-logging 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@cap-js/audit-logging 的下载量有多少?

根据 npm 官方下载统计,@cap-js/audit-logging 在 2026/10/09 – 2026/11/07 这 30 天内被下载 46,562 次,日均约 1,552 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@cap-js/audit-logging 还在维护吗?

最新版本 1.3.0 发布于 2026/09/10(1 个月前);至今共发布 24 个版本,其中过去 12 个月发布了 4 个;首次发布于 2023/08/18。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。