@lafken/dynamo

This package simplifies the creation and management of DynamoDB tables. It provides decorators that allow you to define the table’s configuration declaratively, as well as to enable a direct service that can be consumed within Lambda functions for performing DynamoDB operations.

Installation

``bash
npm install @lafken/dynamo
`

Configuration

To get started, you must add the DynamoResolver to your application. Import the resolver and instantiate it, passing the classes that will define the DynamoDB tables. Each class must be decorated with the @Model decorator, which receives the configuration applied to the table, along with the properties that compose the data model.

`typescript
import { ApiResolver } from '@lafken/bucket/resolver';

//...
@Model({
name: 'clients',
indexes: [
{
type: 'local',
name: 'email_age_index',
sortKey: 'age',
},
],
ttl: 'expireAt',
})
export class Client {
@PartitionKey(String)
email: PrimaryPartition;

@SortKey(String)
name: PrimaryPartition;

@Field()
age: number;

@Field()
expireAt: number;
}

// ...
createApp({
name: 'awesome-app',
resolvers: [
new DynamoResolver([Client]),
],
...
});
`

Features

$3

`typescript
@Model({
name: 'clients',
})
class Client {
@PartitionKey(String)
email: PrimaryPartition;
}
`

$3

`typescript
@Model({
name: 'clients',
ttl: 'expireAt',
stream: {
enabled: true,
type: 'NEW_IMAGE',
filters: {
keys: {
email: [{ suffix: 'lafken.com' }],
},
newImage: {
name: ['foo'],
},
},
},
})
export class Client {
// ...
}
`


$3

`typescript
export const clientRepository = createRepository(Client);
// ...
await clientRepository
.create({
name: 'lafken',
age: 1,
email: 'awesome@lafken.com',
expireAt: 1000000000,
})
.exec();
// ...
await clientRepository.findAll({
keyCondition: {
partition: {
email: 'awesome@lafken.com'
}
}
}).exec();
`

$3

`typescript
await transaction([
clientRepository.create({
name: 'lafken',
age: 1,
email: 'awesome@lafken.com',
expireAt: 1000000000,
}),
documentRepository.create({
// ...
}),
]);
``