Class StoreService<Provider, TransactionProvider>Abstract

Type Parameters

Constructors

constructor

Properties

appId cache logger namespace serializer storeClient

Methods

activateAppVersion addSymbols addSymbolValues addTaskQueues collate collateLeg2Entry collateSynthetic deleteHookSignal deleteProcessedTaskQueue delistSignalKey expireJob findJobFields findJobs getActiveTaskQueue getActivityInputs? getAllSymbols getApp getChildWorkflowInputs? getDependencies getHookRules getHookSignal getJobByKeyDirect? getJobIds getJobLineage? getJobStats getNextTask getQueryState getRaw getSchema getSchemas getSettings getState getStatus getStreamHistory? getSubscription getSubscriptions getSymbolKeys getSymbols getSymbolValues getThrottleRate getThrottleRates getTransitions init interrupt mintKey processTaskQueue registerTimeHook releaseScoutRole reserveScoutRole reserveSymbolRange scrub setApp setCancel setHookRules setHookSignal setSchemas setSettings setState setStateNX setStats setStatus setStatusAndCollateGuid setSubscriptions setThrottleRate setTransitions transact

Constructors

constructor

Properties

appId

appId: string

cache

cache: Cache

logger

logger: ILogger

namespace

namespace: string

serializer

serializer: SerializerService

storeClient

storeClient: Provider

Methods

AbstractactivateAppVersion

  • activateAppVersion(id, version): Promise<boolean>

  • Parameters

    • id: string
    • version: string

    Returns Promise<boolean>

AbstractaddSymbols

AbstractaddSymbolValues

AbstractaddTaskQueues

Abstractcollate

AbstractcollateLeg2Entry

AbstractcollateSynthetic

AbstractdeleteHookSignal

  • deleteHookSignal(topic, resolved): Promise<number>

  • Parameters

    • topic: string
    • resolved: string

    Returns Promise<number>

AbstractdeleteProcessedTaskQueue

  • deleteProcessedTaskQueue(workItemKey, key, processedKey, scrub?): Promise<void>

  • Parameters

    • workItemKey: string
    • key: string
    • processedKey: string
    • Optionalscrub: boolean

    Returns Promise<void>

AbstractdelistSignalKey

  • delistSignalKey(key, target): Promise<void>

  • Parameters

    • key: string
    • target: string

    Returns Promise<void>

AbstractexpireJob

AbstractfindJobFields

  • findJobFields(jobId, fieldMatchPattern?, limit?, batchSize?, cursor?): Promise<[string, StringStringType]>

  • Parameters

    • jobId: string
    • OptionalfieldMatchPattern: string
    • Optionallimit: number
    • OptionalbatchSize: number
    • Optionalcursor: string

    Returns Promise<[string, StringStringType]>

AbstractfindJobs

  • findJobs(queryString?, limit?, batchSize?, cursor?): Promise<[string, string[]]>

  • Parameters

    • OptionalqueryString: string
    • Optionallimit: number
    • OptionalbatchSize: number
    • Optionalcursor: string

    Returns Promise<[string, string[]]>

AbstractgetActiveTaskQueue

OptionalgetActivityInputs

  • getActivityInputs(workflowId, symbolField): Promise<{
        byJobId: Map<string, any>;
        byNameIndex: Map<string, any>;
    }>

  • Fetch activity inputs for a workflow. Used by the exporter to enrich timeline events with activity arguments.

    Parameters

    • workflowId: string

      The workflow ID

    • symbolField: string

      The compressed symbol field for activity arguments

    Returns Promise<{
        byJobId: Map<string, any>;
        byNameIndex: Map<string, any>;
    }>

    Map of job_id -> parsed input arguments and activityName:index -> parsed inputs

AbstractgetAllSymbols

AbstractgetApp

  • getApp(id, refresh?): Promise<any>

  • Parameters

    • id: string
    • Optionalrefresh: boolean

    Returns Promise<any>

OptionalgetChildWorkflowInputs

  • getChildWorkflowInputs(childJobKeys, symbolField): Promise<Map<string, any>>

  • Fetch child workflow inputs in batch. Used by the exporter to enrich child workflow events with their arguments.

    Parameters

    • childJobKeys: string[]

      Array of child job keys to fetch

    • symbolField: string

      The compressed symbol field for workflow arguments

    Returns Promise<Map<string, any>>

    Map of child_workflow_id -> parsed input arguments

AbstractgetDependencies

AbstractgetHookRules

AbstractgetHookSignal

  • getHookSignal(topic, resolved, pendingData?, pendingExpire?): Promise<string>

  • Leg2: Atomically gets the hook signal OR inserts a pending signal if no hook is registered yet (early signal). Returns the hook signal value, or undefined if we stored a pending signal instead.

    Parameters

    • topic: string
    • resolved: string
    • OptionalpendingData: string
    • OptionalpendingExpire: number

    Returns Promise<string>

OptionalgetJobByKeyDirect

  • getJobByKeyDirect(jobKey): Promise<{
        attributes: Record<string, string>;
        job: {
            created_at: Date;
            expired_at?: Date;
            id: string;
            is_live: boolean;
            key: string;
            status: number;
            updated_at: Date;
        };
    }>

  • Fetch job record and attributes by key. Used by the exporter to reconstruct execution history for expired jobs.

    Parameters

    • jobKey: string

      The job key (e.g., "hmsh:durable:j:workflowId")

    Returns Promise<{
        attributes: Record<string, string>;
        job: {
            created_at: Date;
            expired_at?: Date;
            id: string;
            is_live: boolean;
            key: string;
            status: number;
            updated_at: Date;
        };
    }>

    Job row and all attributes

AbstractgetJobIds

OptionalgetJobLineage

  • getJobLineage(jobKey): Promise<{
        origin_id: string;
        parent_id: string;
    }>

  • Fetch just the lineage columns (parent_id, origin_id) for a job via a single indexed lookup on key. Powers the exporter's opt-in include_lineage pointer — parent_id is the real spawning workflow (never the synthetic collator $C job), origin_id is the root ancestor.

    Parameters

    • jobKey: string

      The job key (e.g., "hmsh:durable:j:workflowId")

    Returns Promise<{
        origin_id: string;
        parent_id: string;
    }>

    parent/origin ids (null when absent — a null parent_id marks a root)

AbstractgetJobStats

AbstractgetNextTask

  • getNextTask(listKey?): Promise<boolean | [listKey: string, jobId: string, gId: string, activityId: string, type: WorkListTaskType]>

  • Parameters

    • OptionallistKey: string

    Returns Promise<boolean | [listKey: string, jobId: string, gId: string, activityId: string, type: WorkListTaskType]>

AbstractgetQueryState

AbstractgetRaw

AbstractgetSchema

AbstractgetSchemas

AbstractgetSettings

AbstractgetState

AbstractgetStatus

  • getStatus(jobId, appId): Promise<number>

  • Parameters

    • jobId: string
    • appId: string

    Returns Promise<number>

OptionalgetStreamHistory

  • getStreamHistory(jobId, options?): Promise<StreamHistoryEntry[]>

  • Fetch stream message history for a job from worker_streams. Returns raw activity input/output data from soft-deleted messages.

    Parameters

    • jobId: string

      The job ID (metadata.jid in stream messages)

    • Optionaloptions: {
          activity?: string;
          types?: string[];
      }

      Optional filters for activity or message types

      • Optionalactivity?: string
      • Optionaltypes?: string[]

    Returns Promise<StreamHistoryEntry[]>

    Array of stream history entries ordered by creation time

AbstractgetSubscription

AbstractgetSubscriptions

AbstractgetSymbolKeys

AbstractgetSymbols

AbstractgetSymbolValues

AbstractgetThrottleRate

AbstractgetThrottleRates

AbstractgetTransitions

Abstractinit

Abstractinterrupt

  • interrupt(topic, jobId, options): Promise<void>

  • Parameters

    • topic: string
    • jobId: string
    • options: {
          [key: string]: any;
      }
      • [key: string]: any

    Returns Promise<void>

AbstractmintKey

AbstractprocessTaskQueue

  • processTaskQueue(sourceKey, destinationKey): Promise<any>

  • Parameters

    • sourceKey: string
    • destinationKey: string

    Returns Promise<any>

AbstractregisterTimeHook

AbstractreleaseScoutRole

AbstractreserveScoutRole

AbstractreserveSymbolRange

  • reserveSymbolRange(target, size, type, tryCount?): Promise<[number, number, Symbols]>

  • Parameters

    • target: string
    • size: number
    • type: "JOB" | "ACTIVITY"
    • OptionaltryCount: number

    Returns Promise<[number, number, Symbols]>

Abstractscrub

AbstractsetApp

AbstractsetCancel

AbstractsetHookRules

AbstractsetHookSignal

  • setHookSignal(hook, transaction?, redelivery?): Promise<{
        pendingData?: string;
        success: boolean;
    }>

  • Leg1: Attempts to set the hook signal. If a pending signal occupies the key (race condition), overwrites it and returns the pending data. When called with a transaction, queues the setnxex (no pending detection).

    When redelivery is provided (the webhook routing for this hook), a consumed pending signal is republished as an engine stream message in the SAME transaction that overwrites the marker — the wake survives a crash at any instant. pendingData is then not returned, since the store already owns the redelivery.

    Parameters

    • hook: HookSignal
    • Optionaltransaction: TransactionProvider
    • Optionalredelivery: {
          aid: string;
          topic: string;
      }
      • aid: string
      • topic: string

    Returns Promise<{
        pendingData?: string;
        success: boolean;
    }>

AbstractsetSchemas

AbstractsetSettings

AbstractsetState

AbstractsetStateNX

  • setStateNX(jobId, appId, status?, entity?, transaction?, originId?, parentId?): Promise<boolean>

  • Parameters

    • jobId: string
    • appId: string
    • Optionalstatus: number
    • Optionalentity: string
    • Optionaltransaction: ProviderTransaction
    • OptionaloriginId: string
    • OptionalparentId: string

    Returns Promise<boolean>

AbstractsetStats

AbstractsetStatus

  • setStatus(collationKeyStatus, jobId, appId, transaction?): Promise<any>

  • Parameters

    Returns Promise<any>

AbstractsetStatusAndCollateGuid

  • setStatusAndCollateGuid(statusDelta, threshold, jobId, appId, guidField, guidWeight, transaction?): Promise<any>

  • Parameters

    • statusDelta: number
    • threshold: number
    • jobId: string
    • appId: string
    • guidField: string
    • guidWeight: number
    • Optionaltransaction: ProviderTransaction

    Returns Promise<any>

AbstractsetSubscriptions

  • setSubscriptions(subscriptions, appVersion): Promise<boolean>

  • Parameters

    • subscriptions: Record<string, any>
    • appVersion: AppVID

    Returns Promise<boolean>

AbstractsetThrottleRate

AbstractsetTransitions

  • setTransitions(transitions, appVersion): Promise<any>

  • Parameters

    • transitions: Record<string, any>
    • appVersion: AppVID

    Returns Promise<any>

Abstracttransact

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
activateAppVersionaddSymbolsaddSymbolValuesaddTaskQueuescollatecollateLeg2EntrycollateSyntheticdeleteHookSignaldeleteProcessedTaskQueuedelistSignalKeyexpireJobfindJobFieldsfindJobsgetActiveTaskQueuegetActivityInputsgetAllSymbolsgetAppgetChildWorkflowInputsgetDependenciesgetHookRulesgetHookSignalgetJobByKeyDirectgetJobIdsgetJobLineagegetJobStatsgetNextTaskgetQueryStategetRawgetSchemagetSchemasgetSettingsgetStategetStatusgetStreamHistorygetSubscriptiongetSubscriptionsgetSymbolKeysgetSymbolsgetSymbolValuesgetThrottleRategetThrottleRatesgetTransitionsinitinterruptmintKeyprocessTaskQueueregisterTimeHookreleaseScoutRolereserveScoutRolereserveSymbolRangescrubsetAppsetCancelsetHookRulessetHookSignalsetSchemassetSettingssetStatesetStateNXsetStatssetStatussetStatusAndCollateGuidsetSubscriptionssetThrottleRatesetTransitionstransact