Saxonberg Server API
    Preparing search index...

    Base for MongoDB-backed records. NOT in the Stuff hierarchy.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _id?: string

    MongoDB ObjectId (undefined until saved).

    createdAt: Date

    Created timestamp (set on construction).

    key: string | null = null

    recordOnce category-first dedup key, or null.

    kind: "claim" | "deed" = 'deed'

    Provenance: a witnessed deed or an authored prologue claim.

    order: number | null = null

    Authored prologue order (claims only); null for deeds.

    owner: string = ''

    Durable owner key (the character's templatePath) — indexed.

    tags: string[] = []

    Open vocabulary — persisted but inert in v1.

    text: string = ""

    Rendered line (deed: ProseApi; claim: authored seed).

    updatedAt: Date

    Last updated timestamp (set on every save).

    when: number | null = null

    Game-time SECONDS magnitude (deeds only); null for claims.

    where: string | null = null

    Place templatePath ref, or null.

    who: string[] = []

    Entity templatePath refs — persisted but inert in v1.

    collectionName: Collections = Collections.Chronicles

    Collection name (must be overridden in subclass).

    persistentFields: string[] = ...

    Methods

    • Load data from a MongoDB document into this object.

      Symmetric to toDocument: marshallers transform their assigned fields' raw values via fromStored before bracket-assign hits the runtime setter.

      Parameters

      • doc: Record<string, unknown>

      Returns void

    • Save this object to MongoDB. Updates updatedAt automatically.

      Pre-resolves any registered field marshallers via the async resolver before the sync toDocument walk; the sync resolver lookup inside toDocument then always hits a populated cache.

      Returns Promise<void>

    • Convert this object to a plain document for MongoDB.

      Marshallers (declared via static fieldMarshallers on a mixin or class) intercept their assigned fields: the runtime value-object value is passed through marshaller.toStored before being written into the doc. Fields without a marshaller pass through bracket-read unchanged.

      Returns Record<string, unknown>

    • Wire the marshaller-resolution seam once at boot (and in tests). Keeps Document free of a StuffApi import while still reaching the Idea-rooted marshaller instances. sync mirrors StuffApi.findByTemplatePath (returns the registered instance or undefined); async mirrors StuffApi.singleton (resolves / lazy-clones the instance, warming the cache sync then hits).

      Parameters

      • sync: SyncMarshallerResolver
      • async: AsyncMarshallerResolver

      Returns void