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

    actor: string = ''

    Durable engaging-player id (A≠P + dedup).

    at: number = 0

    Game-time SECONDS witness — parity / correlation only.

    author: string = ''

    Durable author id (the routing key) — indexed.

    bucket: number = 0

    The real-time bucket key (floor(realAt / bucketMs)) — the dedup key.

    createdAt: Date

    Created timestamp (set on construction).

    kind: "engagement" = 'engagement'

    Signal provenance; engagement is the v1 kind.

    realAt: number = 0

    Real-time epoch MILLISECONDS — the bucket key + decay clock.

    updatedAt: Date

    Last updated timestamp (set on every save).

    weight: number = 1

    Credit weight (default 1) — the team-split seam.

    zonePath: string = ''

    The engaged zone's template path.

    collectionName: Collections = Collections.ProducerEvents

    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