@bhoos/dynamodb

@bhoos/dynamodb

DynamoDB wrapper

Installation

$ yarn add @bhoos/dynamodb

Usage

Environment Variables:

AWS_REGION

DYNAMODB_ENDPOINT [optional]

Example (Single partition key)

import { createCollection } from '@bhoos/dynamodb'

// Create collections as required
// A Simple collection with single key
const User = createCollection('User', ({ key }) => {
  username: key(),
}, ({ self }) => {
  get: async (username) => {
    const u = await self.findOne(username);
    const { password, ...res } = u;
    return u;
  },

  create: async (username, password, name) => self.insert({ 
    username, 
    name,
    password: hash(password),
  }),

  validate: async (username, password) => {
    const u = await self.findOne(user);
    if (!u || hash(password) !== u.password) {
      throw new Error('Invalid username/password');
    }

    // It's not a good idea to send back the password, even if its hashed
    const { password, ...res } = u;
    return res;
  },

  changePassword: async (username, password) => {
    // Will throw if the username doesn't exist
    await self.update({ password: hash(password) }, username);
  },

  deleteUser: async (username) => {
    await self.delete(username);
  },
});

// User can now be used with the extended operations
const email = await User.create('[e-mail]', 'SuperSecret', 'John Doe');
const user = await User.get('[e-mail]'); // Retrieve record
await User.validate('[e-mail]', 'Wrong'); // throws error
await User.validate('[e-mail]', 'SuperSecret'); // Returns user instance
await User.deleteUser('[e-mail]'); // Delete from database

// Also available are generic methods- insert, findOne, update, & delete
await User.insert({ username: '[e-mail]', password: 'not-hashed', name: 'Jane Doe' }); // Direct
await User.findOne('[e-mail]');
await User.update({ password: 'not-hashed-new' }, '[e-mail]');
await User.delete('[e-mail]');

Example (Multiple keys)

const Movie = createCollection('Movie', ({ key }) => ({
  year: key(),
  title: key().sort(),
}), ({ self, db }) => ({
  get: (year, title) => self.findOne(year, title),
  findAnnual: (year) => db.query(.......), // Write your dynamodb query to find something
});