DynamoDbRepository

Defined in: dynamodb/src/lib/dynamodb-repository.ts:30

Type Parameters

T

T extends Record<string, unknown>

D

D = Partial<T>

Implements

Repository<T, D>

Constructors

Constructor

new DynamoDbRepository<T, D>(app): DynamoDbRepository<T, D>

Defined in: dynamodb/src/lib/dynamodb-repository.ts:80

Parameters

app

MantleApplication

Returns

DynamoDbRepository<T, D>

Properties

_txItems?

protected optional _txItems?: TransactWriteItem[]

Defined in: dynamodb/src/lib/dynamodb-repository.ts:78

Buffered write operations when running inside withTransaction().

client

protected readonly client: DynamoDBClient

Defined in: dynamodb/src/lib/dynamodb-repository.ts:33

createdAtField

readonly createdAtField: string = "createdAt"

Defined in: dynamodb/src/lib/dynamodb-repository.ts:59

Attribute written for auto-managed creation timestamps.

Default

"createdAt"

fieldMap

readonly fieldMap: Record<string, string> = {}

Defined in: dynamodb/src/lib/dynamodb-repository.ts:68

Entity-field-to-attribute overrides, for a table whose attribute names don’t match the entity (e.g. a brownfield table using snake_case). Applies to every field, including partitionKey/sortKey — they are ordinary attributes in DynamoDB.

Default

{}

lastKey?

optional lastKey?: Record<string, AttributeValue>

Defined in: dynamodb/src/lib/dynamodb-repository.ts:75

The LastEvaluatedKey from the most recent paginated findAll() call. Use as _startKey on the next call.

partitionKey

readonly partitionKey: string = "id"

Defined in: dynamodb/src/lib/dynamodb-repository.ts:42

The partition key attribute name for the table.

Default

"id"

sortKey?

readonly optional sortKey?: string

Defined in: dynamodb/src/lib/dynamodb-repository.ts:49

Optional sort key attribute name. When set, findById expects a composite key object { pk: partitionValue, sk: sortValue } and Query is used instead of GetItem.

tableName

abstract readonly tableName: string

Defined in: dynamodb/src/lib/dynamodb-repository.ts:36

DynamoDB table name.

timestamps

readonly timestamps: boolean = true

Defined in: dynamodb/src/lib/dynamodb-repository.ts:56

When true, save / saveAll / updateById / patchById automatically write createdAt and updatedAt ISO-8601 timestamps.

Default

true

updatedAtField

readonly updatedAtField: string = "updatedAt"

Defined in: dynamodb/src/lib/dynamodb-repository.ts:61

Attribute written for auto-managed update timestamps.

Default

"updatedAt"

Methods

buildKey()

protected buildKey(id): Record<string, AttributeValue>

Defined in: dynamodb/src/lib/dynamodb-repository.ts:125

Build a consistent key map for GetItem / DeleteItem / UpdateItem.

Parameters

id

Id

Returns

Record<string, AttributeValue>

count()

count(params?): Promise<number>

Defined in: dynamodb/src/lib/dynamodb-repository.ts:663

Parameters

params?

QueryParams

Returns

Promise<number>

Implementation of

Repository.count

deleteById()

deleteById(id): Promise<T>

Defined in: dynamodb/src/lib/dynamodb-repository.ts:624

Parameters

id

Id

Returns

Promise<T>

Implementation of

Repository.deleteById

describe()

describe(): RepositoryCapabilities

Defined in: dynamodb/src/lib/dynamodb-repository.ts:139

Optional capability introspection. All

Returns

RepositoryCapabilities

Mantlejs

adapters implement it; user repositories may omit it.

Implementation of

Repository.describe

findAll()

findAll(params?): Promise<T[]>

Defined in: dynamodb/src/lib/dynamodb-repository.ts:154

Parameters

params?

DynamoQueryParams

Returns

Promise<T[]>

Implementation of

Repository.findAll

findById()

findById(id): Promise<T | null>

Defined in: dynamodb/src/lib/dynamodb-repository.ts:409

Parameters

id

Id

Returns

Promise<T | null>

Implementation of

Repository.findById

findPage()

findPage(params?): Promise<CursorPage<T>>

Defined in: dynamodb/src/lib/dynamodb-repository.ts:181

Fetch one page of results using native DynamoDB cursor pagination. The returned cursor is the LastEvaluatedKey encoded as base64 JSON — pass it back as params.cursor for the next page. Stateless: unlike lastKey, nothing is stored on the repository instance.

Uses Query when a sort key is defined and the where clause pins the partition key, otherwise Scan. skip and sort are rejected — offsets and cross-page ordering don’t compose with cursors.

Parameters

params?

QueryParams & object

Returns

Promise<CursorPage<T>>

Implementation of

Repository.findPage

fromItem()

protected fromItem(item): T

Defined in: dynamodb/src/lib/dynamodb-repository.ts:119

Unmarshall a DynamoDB attribute map to a plain object.

Parameters

item

Record<string, AttributeValue>

Returns

T

patchById()

patchById(id, data): Promise<T>

Defined in: dynamodb/src/lib/dynamodb-repository.ts:553

Parameters

id

Id

data

D

Returns

Promise<T>

Implementation of

Repository.patchById

save()

save(data): Promise<T>

Defined in: dynamodb/src/lib/dynamodb-repository.ts:423

Parameters

data

D

Returns

Promise<T>

Implementation of

Repository.save

saveAll()

saveAll(data): Promise<T[]>

Defined in: dynamodb/src/lib/dynamodb-repository.ts:444

Parameters

data

D[]

Returns

Promise<T[]>

Implementation of

Repository.saveAll

toEntityField()

protected toEntityField(field): string

Defined in: dynamodb/src/lib/dynamodb-repository.ts:103

Translates an attribute name back to its entity field name — the inverse of toField.

Parameters

field

string

Returns

string

toField()

protected toField(field): string

Defined in: dynamodb/src/lib/dynamodb-repository.ts:98

Translates an entity field name to its attribute name (fieldMap override, else identity).

Parameters

field

string

Returns

string

toItem()

protected toItem(data): Record<string, AttributeValue>

Defined in: dynamodb/src/lib/dynamodb-repository.ts:109

Marshall a plain object to DynamoDB attribute values, omitting undefined/null keys.

Parameters

data

Record<string, unknown>

Returns

Record<string, AttributeValue>

updateById()

updateById(id, data): Promise<T>

Defined in: dynamodb/src/lib/dynamodb-repository.ts:483

Parameters

id

Id

data

D

Returns

Promise<T>

Implementation of

Repository.updateById

withTransaction()

withTransaction<R>(callback): Promise<R>

Defined in: dynamodb/src/lib/dynamodb-repository.ts:713

Execute a set of repository write operations atomically via DynamoDB TransactWriteItems. Supports up to 100 write operations per transaction.

Note: in transaction mode, mutation methods (save, updateById, patchById, deleteById) return the input data immediately rather than the persisted item, since TransactWriteItems does not support ReturnValues.

Type Parameters

R

R

Parameters

callback

(repo) => Promise<R>

Returns

Promise<R>

wrapError()

protected wrapError(err): Error

Defined in: dynamodb/src/lib/dynamodb-repository.ts:743

Parameters

err

unknown

Returns

Error