memnex-spec

Reference JavaScript/TypeScript implementation of the memnex specification — an open standard for portable meeting outputs.

This package provides:

• A runtime validator built on ajv (JSON Schema Draft 2020-12)
• TypeScript types generated directly from the schema
• The raw schema document, for downstream tools

Install

npm install memnex-spec

Usage

import { validate, isValid, schema, type MeetingOutput } from "memnex-spec";

// Detailed validation with error reporting
const result = validate(JSON.parse(text));
if (result.valid) {
    const meeting: MeetingOutput = result.data;
    console.log(meeting.meeting_id);
} else {
    for (const err of result.errors) {
        console.error(`${err.path}: ${err.message}`);
    }
}

// Type guard variant
if (isValid(data)) {
    // data is narrowed to MeetingOutput
}

Accessing the raw schema and examples

The validator and types are the primary API. If you need direct access to the raw JSON Schema document or the example payloads (e.g. for code generation, schema browsers, or custom validators), use:

import { schema } from "memnex-spec";
// schema is the JSON Schema 2020-12 document

The package also exposes JSON files as subpath exports for tooling that understands JSON modules (bundlers, schema browsers):

• memnex-spec/schema — raw JSON Schema document
• memnex-spec/examples/minimal — minimal valid example
• memnex-spec/examples/full — full example with all optional fields
• memnex-spec/types — TypeScript types only (no runtime)

Direct ESM imports of JSON subpaths require Node's import attributes syntax: import x from "memnex-spec/schema" with { type: "json" }. Most consumers will not need this; use import { schema } from "memnex-spec" instead.

What is memnex?

memnex is an open specification for storing meeting recordings as structured data: a single JSON document that combines transcript, summary, action items, decisions, and provenance metadata, in a format any tool can read and write.

The full specification lives at github.com/UladzKha/memnex.

Version compatibility

License

MIT. See LICENSE-CODE at the repository root.