feat: remove DynamodbWrapper client dependency

index.d.ts

@@ -1,12 +1,10 @@
 import { DynamoDB } from 'aws-sdk';
-import DynamoDBWrapper from 'dynamodb-wrapper';
 
-declare module "@flybondi/flynamo" {
+declare module '@flybondi/flynamo' {
   module Flynamo {
     export type KeyAttributes = { [key: string]: string | number };
     export type Key = string | number | KeyAttributes | { Key: KeyAttributes };
     export type Item = { [key: string]: any };
-
     export interface BatchGetItemInput {
       ConsistentRead?: DynamoDB.ConsistentRead;
       ReturnConsumedCapacity?: DynamoDB.ReturnConsumedCapacity;
@@ -17,29 +15,50 @@ declare module "@flybondi/flynamo" {
     export type BatchWriteItemInput = Omit<DynamoDB.BatchWriteItemInput, 'RequestItems'>;
 
     export interface BatchWriteItemOperations {
-      insert?: Item | Item[],
-      remove?: Key | Key[]
+      insert?: Item | Item[];
+      remove?: Key | Key[];
     }
 
     export type GetItemInput = Omit<DynamoDB.GetItemInput, 'TableName' | 'Key' | 'AttributesToGet'>;
 
-    export type PutItemInput = Omit<DynamoDB.PutItemInput, 'TableName' | 'Item' | 'Expected' | 'ConditionalOperator'>;
+    export type PutItemInput = Omit<
+      DynamoDB.PutItemInput,
+      'TableName' | 'Item' | 'Expected' | 'ConditionalOperator'
+    >;
 
-    export type QueryInput = Omit<DynamoDB.QueryInput, 'TableName' | 'AttributesToGet' | 'KeyConditions' | 'QueryFilter' | 'ConditionalOperator'>;
+    export type QueryInput = Omit<
+      DynamoDB.QueryInput,
+      'TableName' | 'AttributesToGet' | 'KeyConditions' | 'QueryFilter' | 'ConditionalOperator'
+    >;
 
-    export type DeleteItemInput = Omit<DynamoDB.DeleteItemInput, 'TableName' | 'Key' | 'Expected' | 'ConditionalOperator'>;
+    export type DeleteItemInput = Omit<
+      DynamoDB.DeleteItemInput,
+      'TableName' | 'Key' | 'Expected' | 'ConditionalOperator'
+    >;
 
-    export type UpdateItemInput = Omit<DynamoDB.UpdateItemInput, 'TableName' | 'Key' | 'AttributeUpdates' | 'Expected' | 'ConditionalOperator'>;
+    export type UpdateItemInput = Omit<
+      DynamoDB.UpdateItemInput,
+      'TableName' | 'Key' | 'AttributeUpdates' | 'Expected' | 'ConditionalOperator'
+    >;
 
-    export interface QueryOptions extends DynamoDBWrapper.IQueryOptions {
+    export interface OperationOptions {
+      /**
+       * Wheter to return all the DynamoDB response pages or just one page.
+       */
+      autopagination?: boolean;
       /**
        * Whether to return the full `AWS.DynamoDB` response object when `true` or just the `Items` property value.
        */
       raw?: boolean;
     }
 
-    type UpdateExpressionBuilderInput = Pick<DynamoDB.Update, 'UpdateExpression' | 'ExpressionAttributeNames' | 'ExpressionAttributeValues'>;
-    export type UpdateExpressionBuilder = (input: UpdateExpressionBuilderInput) => DynamoDB.ExpressionAttributeValueMap;
+    type UpdateExpressionBuilderInput = Pick<
+      DynamoDB.Update,
+      'UpdateExpression' | 'ExpressionAttributeNames' | 'ExpressionAttributeValues'
+    >;
+    export type UpdateExpressionBuilder = (
+      input: UpdateExpressionBuilderInput
+    ) => DynamoDB.ExpressionAttributeValueMap;
   }
   export interface Flynamo {
     /**
@@ -66,7 +85,10 @@ declare module "@flybondi/flynamo" {
      * @param input - Optional settings supported by `AWS.DynamoDB` for this operation.
      * @returns Resolves to the response from `AWS.DynamoDB` client for a `BatchGetItem` operation.
      */
-    batchGet: (keys: Flynamo.Key | Flynamo.Key[], input?: Flynamo.BatchGetItemInput) => Promise<DynamoDB.BatchGetItemOutput>,
+    batchGet: (
+      keys: Flynamo.Key | Flynamo.Key[],
+      input?: Flynamo.BatchGetItemInput
+    ) => Promise<DynamoDB.BatchGetItemOutput>;
 
     /**
      * Puts (i.e.: inserts) items in a table in a single batch.
@@ -81,7 +103,10 @@ declare module "@flybondi/flynamo" {
      * @param input - Optional settings supported by `AWS.DynamoDB` for this operation.
      * @returns Resolves to the response from `AWS.DynamoDB` client for a `BatchWriteItem` operation.
      */
-    batchInsert: (items: Flynamo.Item | Flynamo.Item[], input?: Flynamo.BatchWriteItemInput) => Promise<DynamoDB.BatchWriteItemOutput>,
+    batchInsert: (
+      items: Flynamo.Item | Flynamo.Item[],
+      input?: Flynamo.BatchWriteItemInput
+    ) => Promise<DynamoDB.BatchWriteItemOutput>;
 
     /**
      * Deletes multiple items from a table in a single batch.
@@ -102,8 +127,10 @@ declare module "@flybondi/flynamo" {
      * @param input - Optional settings supported by `AWS.DynamoDB` for this operation.
      * @returns Resolves to the response from `AWS.DynamoDB` client for a `BatchWriteItem` operation.
      */
-    batchRemove: (keys: Flynamo.Key | Flynamo.Key[], input?: Flynamo.BatchWriteItemInput) => Promise<DynamoDB.BatchWriteItemOutput>,
-
+    batchRemove: (
+      keys: Flynamo.Key | Flynamo.Key[],
+      input?: Flynamo.BatchWriteItemInput
+    ) => Promise<DynamoDB.BatchWriteItemOutput>;
 
     /**
      * Puts (i.e.: inserts) or deletes multiple items in a table in a single operation. It expects an
@@ -124,7 +151,10 @@ declare module "@flybondi/flynamo" {
      * @param operations - An object containing `insert` and/or `remove` properties.
      * @returns - Resolves to the response from `AWS.DynamoDB` client for a `BatchWriteItem` operation.
      */
-    batchWrite: (operations: Flynamo.BatchWriteItemOperations, input?: Flynamo.BatchWriteItemInput) => Promise<DynamoDB.BatchWriteItemOutput>,
+    batchWrite: (
+      operations: Flynamo.BatchWriteItemOperations,
+      input?: Flynamo.BatchWriteItemInput
+    ) => Promise<DynamoDB.BatchWriteItemOutput>;
 
     /**
      * Return the number of elements in a table or a secondary index. This function
@@ -138,7 +168,7 @@ declare module "@flybondi/flynamo" {
      * @param request - Parameters as expected by DynamoDB `Scan` operation.
      * @returns A `Promise` that resolves to the total number of elements
      */
-    count: () => Promise<DynamoDB.Integer>,
+    count: () => Promise<DynamoDB.Integer>;
 
     /**
      * Returns a set of attributes for the item with the given primary key.
@@ -167,7 +197,7 @@ declare module "@flybondi/flynamo" {
      * @returns A `Promise` that resolves to the item returned by `AWS.DynamoDB` response or `undefined` if it
      *  does not exist.
      */
-    get: (key: Flynamo.Key, input?: Flynamo.GetItemInput) => Promise<Flynamo.Item[]>,
+    get: (key: Flynamo.Key, input?: Flynamo.GetItemInput) => Promise<Flynamo.Item[]>;
 
     /**
      * Returns all items in a table or a secondary index. This uses `Scan` internally.
@@ -178,9 +208,13 @@ declare module "@flybondi/flynamo" {
      *  await getAll();
      *
      * @param input - Parameters as expected by `AWS.DynamoDB` `Scan` operation.
+     * @param options - The configuration options parameters.
      * @returns A `Promise` that resolves to an array of `Items` returned by the `AWS.DynamoDB` response.
      */
-    getAll: (input?: DynamoDB.ScanInput) => Promise<Flynamo.Item[]>,
+    getAll: (
+      input?: DynamoDB.ScanInput,
+      options?: Flynamo.OperationOptions
+    ) => Promise<Flynamo.Item[]>;
 
     /**
      * Creates a new item, or replaces an old item with a new item.
@@ -197,7 +231,7 @@ declare module "@flybondi/flynamo" {
      * @param input - Optional parameters as expected by `AWS.DynamoDB` `PutItem` operation.
      * @returns  Resolves to the response from DynamoDB client.
      */
-    insert: (item: Flynamo.Item, input?: Flynamo.PutItemInput) => Promise<DynamoDB.PutItemOutput>,
+    insert: (item: Flynamo.Item, input?: Flynamo.PutItemInput) => Promise<DynamoDB.PutItemOutput>;
 
     /**
      * Finds items based on primary key values.
@@ -218,7 +252,10 @@ declare module "@flybondi/flynamo" {
      * @param options - Configuration options parameters.
      * @returns A `Promise` that resolves to either an array of returned `Items` or the full, raw response from `AWS.DynamoDB`.
      */
-    query: (input: Flynamo.QueryInput, options?: Flynamo.QueryOptions) => Promise<DynamoDB.QueryOutput | Item[]>,
+    query: (
+      input: Flynamo.QueryInput,
+      options?: Flynamo.OperationOptions
+    ) => Promise<DynamoDB.QueryOutput | Item[]>;
 
     /**
      * Deletes a single item in a table by primary key. Returns the recently removed item by default
@@ -235,7 +272,7 @@ declare module "@flybondi/flynamo" {
      * @returns A `Promise` that resolves to the `Attributes` property of the DynamoDB response. Unless, `ReturnValues` has
      *  been explicitly set, this will match all attributes of the recently deleted element.
      */
-    remove: (key: Flynamo.Key, input?: Flynamo.DeleteItemInput) => Promise<Flynamo.Item>,
+    remove: (key: Flynamo.Key, input?: Flynamo.DeleteItemInput) => Promise<Flynamo.Item>;
 
     /**
      * Edits an existing item's attributes, or adds a new item to the table if it does not
@@ -257,7 +294,11 @@ declare module "@flybondi/flynamo" {
      *  will override any value automatically derived from `itemOrBuilder`.
      * @returns A `Promise` that resolves to the `Attributes` property of the `AWS.DynamoDB` response.
      */
-    update: (key: Flynamo.Key, itemOrBuilder: Flynamo.Item | Flynamo.UpdateExpressionBuilder, input?: Flynamo.UpdateItemInput) => Promise<Flynamo.Item>
+    update: (
+      key: Flynamo.Key,
+      itemOrBuilder: Flynamo.Item | Flynamo.UpdateExpressionBuilder,
+      input?: Flynamo.UpdateItemInput
+    ) => Promise<Flynamo.Item>;
   }
 
   export interface FlynamoClient {
@@ -274,7 +315,7 @@ declare module "@flybondi/flynamo" {
      * @param tableName - The value of `TableName`.
      * @returns The entire `Flynamo` scoped to a single table.
      */
-    forTable(tableName: string): Flynamo
+    forTable(tableName: string): Flynamo;
   }
 
   /**
@@ -284,9 +325,8 @@ declare module "@flybondi/flynamo" {
    * @see https://github.com/Shadowblazen/dynamodb-wrapper#setup
    * @see https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html
    * @param client - A `AWS.DynamoDB` client.
-   * @param options - `DynamoDBWrapper` configuration (optional).
-  */
-  export declare function flynamo(dynamodb: DynamoDB, options?: DynamoDBWrapper.IDynamoDBWrapperOptions): FlynamoClient;
+   */
+  export declare function flynamo(dynamodb: DynamoDB): FlynamoClient;
 
   export = flynamo;
 }

package.json

@@ -63,7 +63,6 @@
   "dependencies": {
     "dynamodb-data-types": "^3.0.1",
     "dynamodb-update-expression": "^0.1.21",
-    "dynamodb-wrapper": "^1.4.1",
     "ramda": "^0.27.1"
   },
   "devDependencies": {

src/batch-get-item.js

@@ -36,6 +36,7 @@ const generateKeys = compose(
 
 const createBatchGetFor = curry((batchGetItem, table) =>
   compose(
+    request => request.promise(),
     apply(batchGetItem),
     overFirst(compose(objOf('RequestItems'), objOf(table))),
     mapMergeFirstPairOfArgs(generateKeys)
@@ -46,11 +47,11 @@ const createBatchGetFor = curry((batchGetItem, table) =>
  * Creates a function to allow retrieval of several documents in a single batch.
  *
  * @private
- * @param {Object} dynamoWrapper The AWS DynamoDB client
+ * @param {Object} dynamodb The AWS DynamoDB client
  * @returns {Object}
  */
-function createGetBatcher(dynamoWrapper) {
-  const batchGetItem = bind(dynamoWrapper.batchGetItem, dynamoWrapper);
+function createGetBatcher(dynamodb) {
+  const batchGetItem = bind(dynamodb.batchGetItem, dynamodb);
   return {
     /**
      * Returns the attributes of one or more items from a table. Requested items are identified by primary key.

src/batch-get-item.test.js

@@ -2,7 +2,8 @@
 const createGetBatcher = require('./batch-get-item');
 
 test('should generate valid `RequestItems` with generated keys', async () => {
-  const mockBatchGetItem = jest.fn().mockResolvedValue({});
+  const mockRequest = { promise: jest.fn().mockResolvedValue({}) };
+  const mockBatchGetItem = jest.fn().mockReturnValue(mockRequest);
   const { batchGetFor } = createGetBatcher({ batchGetItem: mockBatchGetItem });
   const batchGet = batchGetFor('some_table');
   await batchGet([42, 33]);
@@ -16,7 +17,8 @@ test('should generate valid `RequestItems` with generated keys', async () => {
 });
 
 test('should support sending a single key as its first argument', async () => {
-  const mockBatchGetItem = jest.fn().mockResolvedValue({});
+  const mockRequest = { promise: jest.fn().mockResolvedValue({}) };
+  const mockBatchGetItem = jest.fn().mockReturnValue(mockRequest);
   const { batchGetFor } = createGetBatcher({ batchGetItem: mockBatchGetItem });
   const batchGet = batchGetFor('some_table');
   await batchGet(42);
@@ -30,7 +32,8 @@ test('should support sending a single key as its first argument', async () => {
 });
 
 test('should support retrieving documents with composite keys', async () => {
-  const mockBatchGetItem = jest.fn().mockResolvedValue({});
+  const mockRequest = { promise: jest.fn().mockResolvedValue({}) };
+  const mockBatchGetItem = jest.fn().mockReturnValue(mockRequest);
   const { batchGetFor } = createGetBatcher({ batchGetItem: mockBatchGetItem });
   const batchGet = batchGetFor('some_table');
   await batchGet([
@@ -50,7 +53,8 @@ test('should support retrieving documents with composite keys', async () => {
 });
 
 test('should allow sending additional request properties as its sencond argument', async () => {
-  const mockBatchGetItem = jest.fn().mockResolvedValue({});
+  const mockRequest = { promise: jest.fn().mockResolvedValue({}) };
+  const mockBatchGetItem = jest.fn().mockReturnValue(mockRequest);
   const { batchGetFor } = createGetBatcher({ batchGetItem: mockBatchGetItem });
   const batchGet = batchGetFor('some_table');
   await batchGet([42, 33], { ProjectionExpression: 'name, messages, views', ConsistentRead: true });
@@ -65,7 +69,8 @@ test('should allow sending additional request properties as its sencond argument
   });
 });
 test('should forward any additional arguments to the original `batchGetItem` function', async () => {
-  const mockBatchGetItem = jest.fn().mockResolvedValue({});
+  const mockRequest = { promise: jest.fn().mockResolvedValue({}) };
+  const mockBatchGetItem = jest.fn().mockReturnValue(mockRequest);
   const { batchGetFor } = createGetBatcher({ batchGetItem: mockBatchGetItem });
   const batchGet = batchGetFor('some_table');
   await batchGet([42, 33], { ProjectionExpression: 'name' }, { extra: true }, 42);

src/batch-write-item.js

@@ -92,11 +92,16 @@ const generateRequestItems = table =>
   );
 
 const createBatchWriteFor = curry((batchWriteItem, table) =>
-  compose(apply(batchWriteItem), mapMergeFirstPairOfArgs(generateRequestItems(table)))
+  compose(
+    request => request.promise(),
+    apply(batchWriteItem),
+    mapMergeFirstPairOfArgs(generateRequestItems(table))
+  )
 );
 
 const createBatchRequestFor = curry((batchWriteItem, requestType, table) =>
   compose(
+    request => request.promise(),
     apply(batchWriteItem),
     mapMergeFirstPairOfArgs(compose(generateRequestItems(table), objOf(requestType)))
   )
@@ -106,11 +111,11 @@ const createBatchRequestFor = curry((batchWriteItem, requestType, table) =>
  * Creates functions to allow removal and insertions of documents in a single batch.
  *
  * @private
- * @param {Object} dynamoWrapper The AWS DynamoDB client
+ * @param {Object} dynamodb The AWS DynamoDB client
  * @returns {Object}
  */
-function createWriteBatcher(dynamoWrapper) {
-  const batchWriteItem = bind(dynamoWrapper.batchWriteItem, dynamoWrapper);
+function createWriteBatcher(dynamodb) {
+  const batchWriteItem = bind(dynamodb.batchWriteItem, dynamodb);
   return {
     /**
      * Returns a function that puts or deletes multiple items in a table. It expects a single

src/batch-write-item.test.js

@@ -3,7 +3,8 @@ const createWriteBatcher = require('./batch-write-item');
 
 describe('the `batchWriteFor` function', () => {
   test('should generate valid `RequestItems` with mixed `PutRequest` and `DeleteRequest` from given input', async () => {
-    const mockBatchWriteItem = jest.fn().mockResolvedValue({});
+    const mockRequest = { promise: jest.fn().mockResolvedValue({}) };
+    const mockBatchWriteItem = jest.fn().mockReturnValue(mockRequest);
     const { batchWriteFor } = createWriteBatcher({ batchWriteItem: mockBatchWriteItem });
     const batchWrite = batchWriteFor('some_table');
     await batchWrite({
@@ -24,7 +25,8 @@ describe('the `batchWriteFor` function', () => {
 
 describe('the `batchRemoveFor` function', () => {
   test('should generate valid `RequestItems` with `DeleteRequest` exclusively from given input', async () => {
-    const mockBatchWriteItem = jest.fn().mockResolvedValue({});
+    const mockRequest = { promise: jest.fn().mockResolvedValue({}) };
+    const mockBatchWriteItem = jest.fn().mockReturnValue(mockRequest);
     const { batchRemoveFor } = createWriteBatcher({ batchWriteItem: mockBatchWriteItem });
     const batchRemove = batchRemoveFor('some_table');
     await batchRemove([1, 2]);
@@ -39,7 +41,8 @@ describe('the `batchRemoveFor` function', () => {
   });
 
   test('should support removing using composite keys as input', async () => {
-    const mockBatchWriteItem = jest.fn().mockResolvedValue({});
+    const mockRequest = { promise: jest.fn().mockResolvedValue({}) };
+    const mockBatchWriteItem = jest.fn().mockReturnValue(mockRequest);
     const { batchRemoveFor } = createWriteBatcher({ batchWriteItem: mockBatchWriteItem });
     const batchRemove = batchRemoveFor('some_table');
     await batchRemove([