@lzcontest/native-log

Lossless, versioned LZLog archive parsing, validation, import, and export.

Install

npm install @lzcontest/native-log

Create and serialize an archive

import { defaultMessageBankSet } from '@lzcontest/messages';
import {
  createLogArchive,
  serializeLogArchive,
} from '@lzcontest/native-log';

const archive = createLogArchive(
  events,
  new Date().toISOString(),
  defaultMessageBankSet,
);
const contents = serializeLogArchive(archive);

Parse and import an archive

import {
  importLogArchive,
  parseLogArchive,
} from '@lzcontest/native-log';

const archive = parseLogArchive(contents);
const projection = await importLogArchive(repository, archive);

Core API

| Export | Purpose | | --- | --- | | createLogArchive | Validate and assemble a complete archive | | serializeLogArchive | Serialize the archive as canonical JSON text | | parseLogArchive | Parse and validate untrusted archive text | | exportLog | Export a complete event stream from a log repository | | importLogArchive | Atomically append an imported event stream | | LogArchiveValidationError | Report explicit archive validation failures |

License

AGPL-3.0-only