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

    aliases: string[] = []

    Aliases for true synonyms only — discouraged; usually empty.

    createdAt: Date

    Created timestamp (set on construction).

    echo: EmoteEcho = 'default'

    Future remote-emote echo policy. Reserved; not enforced in v1.

    emoji?: string

    Optional single Layer-2 glyph.

    grammar: EmoteGrammar = ...

    Single Liquid template + per-slot metadata.

    tags: string[] = []

    Free-form classification / reactions hook.

    updatedAt: Date

    Last updated timestamp (set on every save).

    valence: number = 0

    Signed renown valence: how this expressive act reads as a reaction to another's act — positive = esteem, negative = notoriety, 0 = neutral (the default; most emotes don't move standing). This is the polity's declared value for the emote, read by the renown recompute (SoulApi.all()), not a central config map.

    verb: string = ''

    Canonical verb word; unique-indexed at the collection level.

    collectionName: string = 'emotes'

    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