import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
import { Module } from '@nestjs/common';
import { ConfigService } from '@nestjs/config';
import { OnetableModule } from 'nest-onetable';

@Module({
  imports: [
    OnetableModule.register({
      // here you can pass either the configuration object you would pass to the new Table() constructor directly or 
      // a factory provider that returns the configuration object but with the benefits of dependency injection
      useFactory(config: ConfigService, client: DynamoDBClient) {
        return {
          client,
          global: false, // optional, defaults to true
          name: config.get('ONETABLE_NAME'),
          partial: true,
          schema: {
            format: 'onetable:1.1.0',
            version: '0.0.1',
            indexes: {
              primary: { hash: 'pk', sort: 'sk' }
            },
            models: {}
          }
        };
      },
      inject: [ConfigService, DynamoDBClient]
    })
  ]
})
export class AppModule {}

import { Injectable } from '@nestjs/common';
import { Table } from 'dynamodb-onetable';
import { OneTable } from 'nest-onetable';

@Injectable()
class UsersService {
  constructor(@OneTable() public readonly table: Table) {
  }
}

import { Injectable } from '@nestjs/common';
import { OneModel } from 'nest-onetable';

@Injectable()
export class UsersModel extends OneModel('Users', {
  pk: { type: String, value: 'Users#', hidden: true },
  sk: { type: String, value: 'Users#${id}', hidden: true },
  id: { type: String, generate: 'ulid', required: true },
  name: { type: String, required: true }
}) {}

@Injectable()
class UsersService {
  constructor(public readonly model: UsersModel) {
  }

  getUsers() {
    return this.model.query(); // thanks to OneTable type inferences from the schema you get a typed object here
  }
}