FCP Audit Publisher

A library to validate and/or publish FCP Audit events to the FCP Audit service.

Installation

npm install fcp-audit-publisher

Usage

ESM

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

CommonJS

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

validateAuditEvent(event)

Validates a JSON object against the FCP Audit event schema.

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
})

Return value

On success:

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

On failure:

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

publishAuditEvent(event, config)

Applies defaults, validates the event, then publishes it to an AWS SNS topic.

The caller is responsible for constructing and reusing an 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)

Throws an Error if the config is invalid or if the event is invalid after defaults are applied.

Config reference

Default precedence

For fields that can be defaulted, the order of precedence from lowest to highest is:

library default → config value → event value

eventSchema

The raw Joi schema used internally by validateAuditEvent, exported for the fcp-audit service only.

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

Other consumers should not import or depend on this directly — use validateAuditEvent/publishAuditEvent instead.

Event schema

All events must satisfy the following schema (validated via Joi):

* At least one of audit or security must be present and non-null.

audit object

security object

Licence

THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at: http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3