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).

    author: string = ''

    The publisher's durable templatePath (a stored identity string).

    body: string = ''

    The optional long-form MML body.

    bulletinId: string = ''

    Canonical id; unique-indexed at the collection level.

    createdAt: Date

    Created timestamp (set on construction).

    expiresAt: number = 0

    Expiry time, epoch-ms; 0 = never expires.

    headline: string = ''

    The short MML one-liner.

    kind: BulletinKind = 'notice'

    Editorial classification (default notice).

    pinned: boolean = false

    Whether this sticks to the top of the window.

    publishedAt: number = 0

    Publish time, epoch-ms (set at publish).

    realm: BulletinRealm = 'ooc'

    Which broadcast realm this belongs to (default ooc).

    retracted: boolean = false

    Soft-delete flag: kept in Mongo, excluded from the live window.

    updatedAt: Date

    Last updated timestamp (set on every save).

    collectionName: string = 'bulletins'

    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