A plain, serialized document source handed to a migrator. This is the shape of document.toObject() — never a live document — so migrators stay pure and the folder can run in Node without Foundry.

interface MigrationSource {
    _id?: string;
    flags?: Record<string, unknown>;
    name?: string;
    system?: Record<string, unknown>;
    type?: string;
    [key: string]: unknown;
}

Indexable

  • [key: string]: unknown

Properties

_id?: string

The document id, when present.

flags?: Record<string, unknown>

The document flags.

name?: string

The document name, for diagnostics.

system?: Record<string, unknown>

The system (schema) data.

type?: string

The document subtype (e.g. "skill", "being").