Merge pull request #22 from joshua-williams/feat/create-table-if-not-…

…exists

feat(table): create table if not exists

__tests__/table.spec.ts

@@ -1,7 +1,7 @@
 import db from "./fixtures/db";
-import {Table} from "../index";
-import {CookbookTable} from "./fixtures/tables";
-import {DynamoDBClient} from "@aws-sdk/client-dynamodb";
+import {attribute, Entity, Table, table as TableDecorator} from "../index";
+import { CookbookTable } from "./fixtures/tables";
+import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
 
 describe('table', () => {
   const config = {endpoint: 'http://localhost:8000'};
@@ -34,28 +34,49 @@ describe('table', () => {
     })
   })
 
-
-  it('should output CreateCommandInput', () => {
-    const expectedCommandInput = {
-      TableName: 'Cookbooks',
-      AttributeDefinitions: [
-        { AttributeName: 'title', AttributeType: 'S' },
-        { AttributeName: 'author', AttributeType: 'S' }
-      ],
-      KeySchema: [
-        { AttributeName: 'title', KeyType: 'HASH' },
-        { AttributeName: 'author', KeyType: 'RANGE' }
-      ],
-      ProvisionedThroughput: { ReadCapacityUnits: 1, WriteCapacityUnits: 1 }
+  describe('Create Table', () => {
+    class TestEntity extends Entity {
+      @attribute()
+      pk: string;
+      @attribute()
+      sk: string;
     }
-    const createCommandInput = table.toCreateCommandInput();
-    expect(createCommandInput).toMatchObject(expectedCommandInput)
-  })
 
-  it('should create database table', async () => {
-    table = new CookbookTable(client);
-    const result = await table.create();
-    expect(result).toHaveProperty('TableDescription');
+    @TableDecorator({
+      name: 'TestTable',
+      primaryKey: {pk: 'pk', sk: 'sk'},
+      entity: TestEntity
+    })
+    class TestTable extends Table {}
+
+    it('should output CreateCommandInput', () => {
+      const expectedCommandInput = {
+        TableName: 'Cookbooks',
+        AttributeDefinitions: [
+          { AttributeName: 'title', AttributeType: 'S' },
+          { AttributeName: 'author', AttributeType: 'S' }
+        ],
+        KeySchema: [
+          { AttributeName: 'title', KeyType: 'HASH' },
+          { AttributeName: 'author', KeyType: 'RANGE' }
+        ],
+        ProvisionedThroughput: { ReadCapacityUnits: 1, WriteCapacityUnits: 1 }
+      }
+      const createCommandInput = table.toCreateCommandInput();
+      expect(createCommandInput).toMatchObject(expectedCommandInput)
+    })
+
+    it('should create database table', async () => {
+      table = new CookbookTable(client);
+      const result = await table.create();
+      expect(result).toHaveProperty('TableDescription');
+    })
+
+    it('should create database table if not exists', async () => {
+      table = new TestTable(client);
+      const result = await table.create('IF_NOT_EXISTS');
+      expect(result).toHaveProperty('TableDescription');
+    })
   })
 
   it('should getPrimaryKeyDefinition', () => {

src/entity.ts

@@ -5,6 +5,7 @@ class Entity {
   public getAttributeDefinitions(): AttributeDefinitions {
     const properties = Reflect.ownKeys(this);
     const attributes = Reflect.getMetadata('attributes', this);
+    if (!attributes) return;
     const reducer = (attributeDefinitions, name) => {
       if (!attributes.hasOwnProperty(name)) return attributeDefinitions;
       const { type, required } = attributes[name];

src/table.ts

@@ -1,4 +1,4 @@
-import {EntityConstructor, PrimaryKey, PrimaryKeyDefinition} from "./types";
+import {CreateTableOption, EntityConstructor, PrimaryKey, PrimaryKeyDefinition} from "./types";
 import {
   CreateTableCommand,
   CreateTableCommandInput, CreateTableCommandOutput, DescribeTableCommand, DescribeTableCommandOutput,
@@ -147,7 +147,14 @@ export default class Table {
     return Key;
   }
 
-  public async create() {
+  public async createIfNotExists() {
+
+  }
+  public async create(option?: CreateTableOption) {
+    if (option) {
+      const tableDescription = await this.describe();
+      if (option === 'IF_NOT_EXISTS' && tableDescription) return;
+    }
     const commandInput = this.toCreateCommandInput();
     const command = new CreateTableCommand(commandInput);
     let message = `Failed to save table ${this.constructor.name}`;

src/types.ts

@@ -6,7 +6,7 @@ import QueryBuilder from './query';
 
 export type EntityConstructor = {
   name: string,
-  new(): Entity
+  new(): Entity,
 }
 
 export type Entities = Record<string, EntityConstructor>
@@ -64,11 +64,13 @@ export type TableConstructor = {
 
 export type TableOptions = {
   name: string,
-  primaryKey: PrimaryKey
+  primaryKey: PrimaryKey,
+  entity: EntityConstructor,
   autoCreate?: boolean,
-  entity: any
 }
 
+export type CreateTableOption = 'IF_NOT_EXISTS' | 'DROP_IF_EXISTS';
+
 export type ModelConstructor = {
   new(client: DynamoDBClient): Model,
 }