Domain logic for Readied — pure functions, zero framework dependencies, testable in Node.js

Core Package

@readied/core contains all domain logic for Readied.

Principles

Zero dependencies on Electron, React, or Node-specific APIs
Testable in pure Node.js
Pure functions where possible

Structure

packages/core/
├── domain/
│   ├── note.ts          # Note entity
│   ├── metadata.ts      # NoteMetadata
│   ├── types.ts         # NoteId, Timestamp, Tag
│   └── invariants.ts    # Business rules
├── operations/
│   ├── createNote.ts
│   ├── updateNote.ts
│   ├── deleteNote.ts
│   ├── archiveNote.ts
│   └── ...
├── contracts/
│   ├── NoteInput.ts     # Input types
│   ├── NoteSnapshot.ts  # Output types
│   └── CoreResult.ts    # Result wrapper
├── repositories/
│   └── NoteRepository.ts # Interface only
└── validation/
    └── schemas.ts       # Zod schemas

Note Entity

interface Note {
  readonly id: NoteId;
  readonly content: string; // Raw markdown
  readonly metadata: NoteMetadata; // Derived data
}

interface NoteMetadata {
  readonly title: string;
  readonly createdAt: Timestamp;
  readonly updatedAt: Timestamp;
  readonly tags: readonly Tag[];
  readonly wordCount: number;
  readonly archivedAt: Timestamp | null;
}

Operations

Operations are pure functions that take input and a repository:

// createNote.ts
export async function createNoteOperation(
  input: CreateNoteInput,
  repo: NoteRepository
): Promise<Result<NoteSnapshot>> {
  // Validate input
  // Create Note entity
  // Save via repository
  // Return snapshot
}

Repository Interface

Core defines the interface, storage packages implement it:

interface NoteRepository {
  get(id: NoteId): Promise<Note | null>;
  save(note: Note): Promise<void>;
  delete(id: NoteId): Promise<void>;
  list(options?: ListOptions): Promise<Note[]>;
  search(term: string): Promise<Note[]>;
}

Companion Packages

Several packages extend core's markdown parsing capabilities. These are separate packages but work closely with the core domain:

Wikilinks (`@readied/wikilinks`)

Parses [[wikilink]] syntax from markdown content. Extracts link targets and display text, enabling bidirectional linking between notes. The parser identifies wikilinks in raw markdown so the editor and storage layers can resolve them to actual note references.

Tasks (`@readied/tasks`)

Extracts task items (- [ ] and - [x]) from markdown content. Provides structured task data including completion status, enabling task-oriented views and aggregation across notes.

Embeds (`@readied/embeds`)

Resolves URLs to rich embed metadata. Recognizes known URL patterns (YouTube, images, etc.) and provides embed type information so the renderer can display rich previews instead of plain links.

Testing

pnpm --filter @readied/core test

68 tests covering all domain logic.

Core Package

On this page