Add an ADR about the Auditable type and helper fn

[jamesobrooks]

Purpose

We want to document the reason for the creation and proper use of auditable.ts.

Major Changes

Add an ADR.

[jamesobrooks]

This highlights a problem with the current implementation. Because the parameters for createAuditRecord contain two optional parameters, we can actually only provide an override if we also provide a session. This could prove to be problematic if for some reason we need to create a record of a system-initiated change while also overriding the date (e.g. we need to use a date from DXTR or the court that is prior to the current date).

[jamesobrooks]

As written, this example would not work. We should probably convert the function to take a single object for arguments or the item and an object that contains the optional session and optional override.

// option 1
export function createAuditRecord<T extends Auditable>(args: {
  record: Omit<T, 'updatedOn' | 'updatedBy'>,
  session?: CamsSession,
  override?: Partial<Auditable>,
}): T {
  // do stuff
}

// option 2
export function createAuditRecord<T extends Auditable>(
  record: Omit<T, 'updatedOn' | 'updatedBy'>,
  options?: {
    session?: CamsSession,
    override?: Partial<Auditable>,
}): T {
  // do stuff
}

[jamesobrooks]

I think I like option 1 better. Session and override seem fundamentally different so grouping just the two of them doesn't make much sense to me.