Interface ReadModelStoreAdapter

fetch

• fetch<TReadModel extends ReadModelInterface>(
      config: MagekConfig,
      readModelName: string,
      readModelID: UUID,
      sequenceKey?: SequenceKey,
  ): Promise<ReadOnlyNonEmptyArray<TReadModel> | undefined>

  Fetches a read model by its ID

  Type Parameters

  • TReadModel extends ReadModelInterface

  Parameters

  • config: MagekConfig

    The Magek configuration object

  • readModelName: string

    The name of the read model type

  • readModelID: UUID

    The ID of the read model to fetch

  • OptionalsequenceKey: SequenceKey

    The sequence key for sequenced read models (optional)

  Returns Promise<ReadOnlyNonEmptyArray<TReadModel> | undefined>

  A promise that resolves to an array of read models, or undefined if not found

search

• search<TReadModel extends ReadModelInterface>(
      config: MagekConfig,
      readModelName: string,
      filters: FilterFor<unknown>,
      sortBy?: SortFor<unknown>,
      limit?: number,
      afterCursor?: unknown,
      paginatedVersion?: boolean,
      select?: ProjectionFor<TReadModel>,
  ): Promise<TReadModel[] | ReadModelListResult<TReadModel>>

  Searches for read models based on specific parameters This method signature matches the original provider library interface

  Type Parameters

  • TReadModel extends ReadModelInterface

  Parameters

  • config: MagekConfig

    The Magek configuration object

  • readModelName: string

    The name of the read model type

  • filters: FilterFor<unknown>

    The filters to be applied during the search

  • OptionalsortBy: SortFor<unknown>

    An object that specifies how the results should be sorted (optional)

  • Optionallimit: number

    The maximum number of results to return (optional)

  • OptionalafterCursor: unknown

    A cursor that specifies the position after which results should be returned (optional)

  • OptionalpaginatedVersion: boolean

    A boolean value that indicates whether the results should be paginated (optional)

  • Optionalselect: ProjectionFor<TReadModel>

    An object that specifies fields to be returned, including calculated field dependencies (optional)

  Returns Promise<TReadModel[] | ReadModelListResult<TReadModel>>

  A promise that resolves to an array of read models or a ReadModelListResult

store

• store<TReadModel extends ReadModelInterface>(
      config: MagekConfig,
      readModelName: string,
      readModel: ReadModelStoreEnvelope<TReadModel>,
  ): Promise<ReadModelStoreEnvelope<TReadModel>>

  Stores or updates a read model

  Type Parameters

  • TReadModel extends ReadModelInterface

  Parameters

  • config: MagekConfig

    The Magek configuration object

  • readModelName: string

    The name of the read model type

  • readModel: ReadModelStoreEnvelope<TReadModel>

    The read model envelope to store

  Returns Promise<ReadModelStoreEnvelope<TReadModel>>

  A promise that resolves to the stored read model envelope

delete

• delete(
      config: MagekConfig,
      readModelName: string,
      readModelID: UUID,
  ): Promise<void>

  Deletes a read model by its ID

  Parameters

  • config: MagekConfig

    The Magek configuration object

  • readModelName: string

    The name of the read model type

  • readModelID: UUID

    The ID of the read model to delete

  Returns Promise<void>

  A promise that resolves when the read model has been deleted

rawToEnvelopes

• rawToEnvelopes<TReadModel extends ReadModelInterface>(
      config: MagekConfig,
      rawReadModels: unknown,
  ): Promise<ReadModelStoreEnvelope<TReadModel>[]>

  Converts raw read model data into ReadModelStoreEnvelope objects

  Type Parameters

  • TReadModel extends ReadModelInterface

  Parameters

  • config: MagekConfig

    The Magek configuration object

  • rawReadModels: unknown

    The raw read model data to be converted

  Returns Promise<ReadModelStoreEnvelope<TReadModel>[]>

  A promise that resolves to an array of ReadModelStoreEnvelope objects

OptionalhealthCheck