FCP 审计出版商

一个图书馆,用于验证和/或向财务和方案预算审计处公布财务和方案预算审计活动.

安装

npm install fcp-audit-publisher

使用量

无害环境管理

import { validateAuditEvent, publishAuditEvent } from '@defra/fcp-audit-publisher'

常见JS

const { validateAuditEvent, publishAuditEvent } = require('@defra/fcp-audit-publisher')

validateAuditEvent(event)

对照 FCP 审计事件计划验证 JSON 对象.

const result = validateAuditEvent({
  correlationid: 'abc-123',
  datetime: '2025-12-01T12:51:41.381Z',
  environment: 'prod',
  version: '1.0.0',
  application: 'FCP001',
  component: 'my-service',
  ip: '192.168.1.100',
  audit: {
    entities: [{ entity: 'application', action: 'created', entityid: 'APP-001' }]
  },
  security: null
})

返回值

关于成功:

{ valid: true, value: { /* normalised event */ } }

失败时 :

{
  valid: false,
  errors: [
    '"datetime" is required',
    '"application" is required'
  ]
}

publishAuditEvent(event, config)

应用默认,验证事件,再将其发布到AWS SNS话题.

呼叫者负责建造和重用 SNSClient。 。 。 .

import { SNSClient } from '@aws-sdk/client-sns'
import { publishAuditEvent } from '@defra/fcp-audit-publisher'

const snsClient = new SNSClient({ region: 'eu-west-2' })

const result = await publishAuditEvent(
  {
    audit: {
      entities: [{ entity: 'application', action: 'created', entityid: 'APP-001' }]
    },
    security: null
  },
  {
    snsClient,
    sns: { topicArn: 'arn:aws:sns:eu-west-2:123456789012:your-sns' },
    application: 'FCP001',
    component: 'my-service',
    environment: 'prod',
    ip: '192.168.1.100',
    generateCorrelationId: true
  }
)

console.log(result.messageId)

丢出一个 Error 如果配置无效,或默认后事件无效.

配置引用

默认优先

对于可以默认的字段,从最低到最高的顺序是:

库默认 ~ 配置值 ~ 事件值

eventSchema

内部使用的原乔伊计划 validateAuditEvent导出于 fcp-audit 仅服务.

import { eventSchema } from '@defra/fcp-audit-publisher'

其他消费者不应直接进口或依赖这种产品——使用 validateAuditEvent编号 :publishAuditEvent 换句话说.

事件计划

所有事件必须满足以下计划(通过Joi认证): :

* 至少其中一个 audit 或者说 security 必须是在场的,而不是无名的.

audit 对象

security 对象

许可证

本资料系根据下列公开政府规定公布: http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3 互联网档案馆的存檔,存档日期2013-12-21