electrodb 1.4.7 → 1.6.1

package/CHANGELOG.md

@@ -98,17 +98,44 @@ All notable changes to this project will be documented in this file. Breaking ch
 ### Patched
 - Updates did not include composite attributes involved in primary index. Though these values cannot be changed, they should be `set` on update method calls in case the update results in an item insert. [[read more]](./README.md#updates-to-composite-attributes)
 
-## [1.4.5] = 2021-10-17
+## [1.4.5] - 2021-10-17
 ### Fixed
 - Improved .npmignore to remove playground oriented files, and created official directory to keep playground in sync with library changes.
 
-## [1.4.6] = 2021-10-20
+## [1.4.6] - 2021-10-20
 ### Added, Fixed
 - Adding Entity identifiers to all update operations. When primary index composite attributes were added in 1.4.4, entities were written properly but did not include the identifiers. This resulted in entities being written but not being readable without the query option `ignoreOwnership` being used.
 
-## [1.4.7] = 2021-10-20
+## [1.4.7] - 2021-10-20
 ### Changed
 - Using `add()` update mutation now resolves to `ADD #prop :prop` update expression instead of a `SET #prop = #prop + :prop`
 
 ### Fixed
-- Fixed param naming conflict during updates, when map attribute shares a name with another (separate) attribute.
+- Fixed param naming conflict during updates, when map attribute shares a name with another (separate) attribute.
+
+## [1.4.8] - 2021-11-01
+### Fixed
+- Addressed issue#90 to flip batchGet's response tuple type definition.
+
+## [1.5.0] - 2021-11-07
+### Changed
+- Queries will now fully paginate all responses. Prior to this change, ElectroDB would only return items from a single ElectroDB query result. Now ElectroDB will paginate through all query results. This will impact both uses of entity queries and service collections. [[read more](./README.md#query-method)]
+- The query option `limit` has an extended meaning with the change to automatically paginate records on query. The option `limit` now represents a target for the number of items to return from DynamoDB. If this option is passed, Queries on entities and through collections will paginate DynamoDB until this limit is reached or all items for that query have been returned. [[read more](./README.md#query-options)]
+
+### Added
+- A new query option `pages` has been added to coincide with the change to automatically paginate all records when queried. The `pages` option sets a max number of pagination iterations ElectroDB will perform on a query. When this option is paired with `limit`, ElectroDB will respect the first condition reached. [[read more](./README.md#query-options)]
+
+## [1.6.0] - 2021-11-21
+### Added
+- Exporting TypeScript interfaces for `ElectroError` and `ElectroValidationError`
+- Errors thrown within an attribute's validate callback are now wrapped and accessible after being thrown. Prior to this change, only the `message` of the error thrown by a validation function was persisted back through to the user, now the error itself is also accessible. Reference the exported interface typedef for `ElectroValidationError` [here](./index.d.ts) to see the new properties available on a thrown validation error.
+
+### Changed
+- As a byproduct of enhancing validation errors, the format of message text on a validation error has changed. This could be breaking if your app had a hardcoded dependency on the exact text of a thrown validation error.
+
+### Fixed
+- For Set attributes, the callback functions `get`, `set`, and `validate` are now consistently given an Array of values. These functions would sometimes (incorrectly) be called with a DynamoDB DocClient Set.
+
+## [1.6.1] - 2021-12-05
+### Fixed
+- In some cases the `find()` and `match()` methods would incorrectly select an index without a complete partition key. This would result in validation exceptions preventing the user from querying if an index definition and provided attribute object aligned improperly. This was fixed and a slightly more robust mechanism for ranking indexes was made.

package/README.md

@@ -107,11 +107,11 @@ tasks
   * [TypeScript Support](#typescript-support)
     + [TypeScript Services](#typescript-services)
   * [Join](#join)
-    - [Independent Models](#independent-models)
-    - [Joining Entity instances to a Service](#joining-entity-instances-to-a-service)
-    - [Joining models to a Service](#joining-models-to-a-service)
-    - [Joining Entities or Models with an alias](#joining-entities-or-models-with-an-alias)
-    - [Joining Entities at Service construction for TypeScript](#joining-entities-at-service-construction-for-typescript)
+      - [Independent Models](#independent-models)
+      - [Joining Entity instances to a Service](#joining-entity-instances-to-a-service)
+      - [Joining models to a Service](#joining-models-to-a-service)
+      - [Joining Entities or Models with an alias](#joining-entities-or-models-with-an-alias)
+      - [Joining Entities at Service construction for TypeScript](#joining-entities-at-service-construction-for-typescript)
   * [Model](#model)
     + [Model Properties](#model-properties)
     + [Service Options](#service-options)
@@ -125,7 +125,7 @@ tasks
       - [Set Attributes](#set-attributes)
       - [Attribute Getters and Setters](#attribute-getters-and-setters)
       - [Attribute Watching](#attribute-watching)
-        * [Attribute Watching: Watch All](#attribute-watching-watch-all)
+        * [Attribute Watching: Watch All](#attribute-watching--watch-all)
         * [Attribute Watching Examples](#attribute-watching-examples)
       - [Calculated Attributes](#calculated-attributes)
       - [Virtual Attributes](#virtual-attributes)
@@ -147,7 +147,7 @@ tasks
     + [Collection Queries vs Entity Queries](#collection-queries-vs-entity-queries)
     + [Collection Response Structure](#collection-response-structure)
   * [Sub-Collections](#sub-collections)
-    - [Sub-Collection Entities](#sub-collection-entities)
+      - [Sub-Collection Entities](#sub-collection-entities)
   * [Index and Collection Naming Conventions](#index-and-collection-naming-conventions)
     + [Index Naming Conventions](#index-naming-conventions)
   * [Collection Naming Conventions](#collection-naming-conventions)
@@ -163,12 +163,13 @@ tasks
     + [Multiple Where Clauses](#multiple-where-clauses)
   * [Parse](#parse)
 - [Building Queries](#building-queries)
-  + [Using composite attributes to make hierarchical keys](#using-composite-attributes-to-make-hierarchical-keys)
-    - [Shopping Mall Stores](#shopping-mall-stores)
-  + [Query App Records](#query-app-records)
-    - [Partition Key Composite Attributes](#partition-key-composite-attributes)
-  + [Sort Key Operations](#sort-key-operations)
+    + [Using composite attributes to make hierarchical keys](#using-composite-attributes-to-make-hierarchical-keys)
+      - [Shopping Mall Stores](#shopping-mall-stores)
+    + [Query App Records](#query-app-records)
+      - [Partition Key Composite Attributes](#partition-key-composite-attributes)
+    + [Sort Key Operations](#sort-key-operations)
   * [Query Chains](#query-chains)
+    + [Query Method](#query-method)
     + [Get Method](#get-method)
     + [Batch Get](#batch-get)
     + [Delete Method](#delete-method)
@@ -177,14 +178,14 @@ tasks
     + [Batch Write Put Records](#batch-write-put-records)
     + [Update Record](#update-record)
       - [Updates to Composite Attributes](#updates-to-composite-attributes)
-      - [Update Method: Set](#update-method-set)
-      - [Update Method: Remove](#update-method-remove)
-      - [Update Method: Add](#update-method-add)
-      - [Update Method: Subtract](#update-method-subtract)
-      - [Update Method: Append](#update-method-append)
-      - [Update Method: Delete](#update-method-delete)
-      - [Update Method: Data](#update-method-data)
-    + [Update Method: Complex Data Types](#update-method-complex-data-types)
+      - [Update Method: Set](#update-method--set)
+      - [Update Method: Remove](#update-method--remove)
+      - [Update Method: Add](#update-method--add)
+      - [Update Method: Subtract](#update-method--subtract)
+      - [Update Method: Append](#update-method--append)
+      - [Update Method: Delete](#update-method--delete)
+      - [Update Method: Data](#update-method--data)
+    + [Update Method: Complex Data Types](#update-method--complex-data-types)
     + [Scan Records](#scan-records)
     + [Remove Method](#remove-method)
     + [Patch Record](#patch-record)
@@ -204,30 +205,33 @@ tasks
         * [Pagination Example](#pagination-example)
   * [Query Examples](#query-examples)
   * [Query Options](#query-options)
-- [Errors:](#errors)
-  + [No Client Defined On Model](#no-client-defined-on-model)
-  + [Invalid Identifier](#invalid-identifier)
-  + [Invalid Key Composite Attribute Template](#invalid-key-composite-attribute-template)
-  + [Duplicate Indexes](#duplicate-indexes)
-  + [Collection Without An SK](#collection-without-an-sk)
-  + [Duplicate Collections](#duplicate-collections)
-  + [Missing Primary Index](#missing-primary-index)
-  + [Invalid Attribute Definition](#invalid-attribute-definition)
-  + [Invalid Model](#invalid-model)
-  + [Invalid Options](#invalid-options)
-  + [Duplicate Index Fields](#duplicate-index-fields)
-  + [Duplicate Index Composite Attributes](#duplicate-index-composite-attributes)
-  + [Incompatible Key Composite Attribute Template](#incompatible-key-composite-attribute-template)
-  + [Invalid Index With Attribute Name](#invalid-index-with-attribute-name)
-  + [Invalid Collection on Index With Attribute Field Names](#invalid-collection-on-index-with-attribute-field-names)
-  + [Missing Composite Attributes](#missing-composite-attributes)
-  + [Missing Table](#missing-table)
-  + [Invalid Concurrency Option](#invalid-concurrency-option)
-  + [aws-error](#aws-error)
-  + [Unknown Errors](#unknown-errors)
-  + [Invalid Last Evaluated Key](#invalid-last-evaluated-key)
-  + [No Owner For Pager](#no-owner-for-pager)
-  + [Pager Not Unique](#pager-not-unique)
+- [Errors:](#errors-)
+    + [No Client Defined On Model](#no-client-defined-on-model)
+    + [Invalid Identifier](#invalid-identifier)
+    + [Invalid Key Composite Attribute Template](#invalid-key-composite-attribute-template)
+    + [Duplicate Indexes](#duplicate-indexes)
+    + [Collection Without An SK](#collection-without-an-sk)
+    + [Duplicate Collections](#duplicate-collections)
+    + [Missing Primary Index](#missing-primary-index)
+    + [Invalid Attribute Definition](#invalid-attribute-definition)
+    + [Invalid Model](#invalid-model)
+    + [Invalid Options](#invalid-options)
+    + [Duplicate Index Fields](#duplicate-index-fields)
+    + [Duplicate Index Composite Attributes](#duplicate-index-composite-attributes)
+    + [Incompatible Key Composite Attribute Template](#incompatible-key-composite-attribute-template)
+    + [Invalid Index With Attribute Name](#invalid-index-with-attribute-name)
+    + [Invalid Collection on Index With Attribute Field Names](#invalid-collection-on-index-with-attribute-field-names)
+    + [Missing Composite Attributes](#missing-composite-attributes)
+    + [Missing Table](#missing-table)
+    + [Invalid Concurrency Option](#invalid-concurrency-option)
+    + [Invalid Pages Option](#invalid-pages-option)
+    + [Invalid Limit Option](#invalid-limit-option)
+    + [Invalid Attribute](#invalid-attribute)
+    + [AWS Error](#aws-error)
+    + [Unknown Errors](#unknown-errors)
+    + [Invalid Last Evaluated Key](#invalid-last-evaluated-key)
+    + [No Owner For Pager](#no-owner-for-pager)
+    + [Pager Not Unique](#pager-not-unique)
 - [Examples](#examples)
   * [Employee App](#employee-app)
     + [Employee App Requirements](#employee-app-requirements)
@@ -565,7 +569,7 @@ const TasksModel = {
 	attributes: {
 		task: {
 			type: "string",
-			default: () => uuidv4(),
+			default: () => uuid(),
 		},
 		project: {
 			type: "string",
@@ -815,11 +819,11 @@ myAttr: {
   watch: ["otherAttr"],
   set: (myAttr, {otherAttr}) => {
     // Whenever "myAttr" or "otherAttr" are updated from an `update` or `patch` operation, this callback will be fired. 
-    // Note: myAttr or otherAttr could be indendently undefined because either attribute could have triggered this callback  
+    // Note: myAttr or otherAttr could be independently undefined because either attribute could have triggered this callback
   },
   get: (myAttr, {otherAttr}) => {
     // Whenever "myAttr" or "otherAttr" are retrieved from a `query` or `get` operation, this callback will be fired. 
-    // Note: myAttr or otherAttr could be indendently undefined because either attribute could have triggered this callback.
+    // Note: myAttr or otherAttr could be independently undefined because either attribute could have triggered this callback.
   } 
 }
 ```
@@ -833,11 +837,11 @@ myAttr: {
   watch: "*", // "watch all"
   set: (myAttr, allAttributes) => {
     // Whenever an `update` or `patch` operation is performed, this callback will be fired. 
-    // Note: myAttr or the attributes under `allAttributes` could be indendently undefined because either attribute could have triggered this callback  
+    // Note: myAttr or the attributes under `allAttributes` could be independently undefined because either attribute could have triggered this callback
   },
   get: (myAttr, allAttributes) => {
     // Whenever a `query` or `get` operation is performed, this callback will be fired. 
-    // Note: myAttr or the attributes under `allAttributes` could be indendently undefined because either attribute could have triggered this callback
+    // Note: myAttr or the attributes under `allAttributes` could be independently undefined because either attribute could have triggered this callback
   } 
 }
 ```
@@ -1417,7 +1421,7 @@ As described in the above two sections ([Composite Attributes](#composite-attrib
 
 It may be the case that an index field is also an attribute. For example, if a table was created with a Primary Index partition key of `accountId`, and that same field is used to store the `accountId` value used by the application. The following are a few examples of how to model that schema with ElectroDB:
 
-> _NOTE: If you have the unique opportunity to use ElectroDB with a new project, it is strongly recommended to use genericly named index fields that are separate from your business attributes._  
+> _NOTE: If you have the unique opportunity to use ElectroDB with a new project, it is strongly recommended to use generically named index fields that are separate from your business attributes._
 
 **Using `composite`**
 
@@ -1564,9 +1568,11 @@ name: "your_item_name"
 ## Collections
 A Collection is a grouping of Entities with the same Partition Key and allows you to make efficient query across multiple entities. If your background is SQL, imagine Partition Keys as Foreign Keys, a Collection represents a View with multiple joined Entities.
 
+> _NOTE: ElectroDB Collections use DynamoDB queries to retrieve results. One query is made to retrieve results for all Entities (the benefits of single table design), however like the [query method](#query-method), ElectroDB will paginate through all results for a given query._
+
 Collections are defined on an Index, and the name of the collection should represent what the query would return as a pseudo `Entity`. Additionally, Collection names must be unique across a `Service`.
 
-> **Note**: A `collection` name should be unique to a single common index across entities.
+> _NOTE: A `collection` name should be unique to a single common index across entities._
 
 ```javascript
 const DynamoDB = require("aws-sdk/clients/dynamodb");
@@ -1756,7 +1762,7 @@ let results = await TaskApp.collections
 
 {
     tasks: [...],    // tasks for employeeId "JExotic" 
-    employees: [...] // employee record(s) with employeeId "JExpotic"
+    employees: [...] // employee record(s) with employeeId "JExotic"
 }
 ```
 
@@ -1771,7 +1777,7 @@ The following is an example of functionally identical collections, implemented a
 **As a string (collection):**
 ```typescript
 {
-  colleciton: "assignments"
+  collection: "assignments"
   pk: {
     field: "pk",
     composite: ["employeeId"]
@@ -1786,7 +1792,7 @@ The following is an example of functionally identical collections, implemented a
 **As a string array (sub-collections):**
 ```typescript
 {
-  colleciton: ["assignments"]
+  collection: ["assignments"]
   pk: {
     field: "pk",
             composite: ["employeeId"]
@@ -2600,6 +2606,10 @@ Option            | Default | Notes
 # Building Queries
 > For hands-on learners: the following example can be followed along with **and** executed on runkit: https://runkit.com/tywalch/electrodb-building-queries
 
+ElectroDB queries use DynamoDB's `query` method to find records based on your table's indexes.
+
+> _NOTE: By default, ElectroDB will paginate through all items that match your query. To limit the number of items ElectroDB will retrieve, read more about the [Query Options](#query-options) `pages` and `limit`, or use the ElectroDB [Pagination API](#page) for fine-grain pagination support._
+
 Forming a composite **Partition Key** and **Sort Key** is a critical step in planning **Access Patterns** in **DynamoDB**. When planning composite keys, it is crucial to consider the order in which they are *composed*.  As of the time of writing this documentation, **DynamoDB**  has the following constraints that should be taken into account when planning your **Access Patterns**:
 1. You must always supply the **Partition Key** in full for all queries to **DynamoDB**.
 2. You currently only have the following operators available on a **Sort Key**: `begins_with`, `between`, `>`, `>=`, `<`, `<=`, and `Equals`.
@@ -2806,6 +2816,12 @@ Queries in ***ElectroDB*** are built around the **Access Patterns** defined in t
 
 The methods: Get (`get`), Create (`put`), Update (`update`), and Delete (`delete`) **require* all composite attributes described in the Entities' primary `PK` and `SK`.
 
+### Query Method
+
+ElectroDB queries use DynamoDB's `query` method to find records based on your table's indexes. To read more about queries checkout the section [Building Queries](#building-queries)
+
+> _NOTE: By default, ElectroDB will paginate through all items that match your query. To limit the number of items ElectroDB will retrieve, read more about the [Query Options](#query-options) `pages` and `limit`, or use the ElectroDB [Pagination API](#page) for fine-grain pagination support._
+
 ### Get Method
 Provide all Table Index composite attributes in an object to the `get` method. In the event no record is found, a value of `null` will be returned.
 
@@ -3704,6 +3720,8 @@ DynamoDB offers three methods to query records: `get`, `query`, and `scan`. In *
 
 > _NOTE: The Find method is similar to the Match method with one exception: The attributes you supply directly to the `.find()` method will only be used to identify and fulfill your index access patterns. Any values supplied that do not contribute to a composite key will not be applied as query filters. Furthermore, if the values you provide do not resolve to an index access pattern, then a table scan will be performed. Use the `where()` chain method to further filter beyond keys, or use [Match](#match-records) for the convenience of automatic filtering based on the values given directly to that method._
 
+The Find method is useful when the index chosen does not matter or is not known. If your secondary indexes do not contain all attributes then this method might not be right for you. The mechanism that picks the best index for a given payload is subject to improvement and change without triggering a breaking change release version.
+
 ```javascript
 await StoreLocations.find({
     mallId: "EastPointe",
@@ -3734,8 +3752,11 @@ await StoreLocations.find({
 
 Match is a convenience method based off of ElectroDB's [find](#find-records) method. Similar to Find, Match does not require you to provide keys, but under the covers it will leverage the attributes provided to choose the best index to query on.
 
+> _NOTE: The Math method is useful when the index chosen does not matter or is not known. If your secondary indexes do not contain all attributes then this method might not be right for you. The mechanism that picks the best index for a given payload is subject to improvement and change without triggering a breaking change release version.
+
 Match differs from [Find](#find-records) in that it will also include all supplied values into a query filter.
 
+
 ```javascript
 await StoreLocations.find({
     mallId: "EastPointe",
@@ -4032,7 +4053,7 @@ let stores = MallStores.query
 
 ### Page
 
-> As of September 29th 2020 the `.page()` now returns the composite attributes that make up the `ExclusiveStartKey` instead of the `ExclusiveStartKey` itself. To get back only the `ExclusiveStartKey`, add the [query option](#query-options) `{pager: "raw"}` to your query options. If you treated this value opaquely no changes are needed, or if you used the `raw` flag.
+> _NOTE: By Default, ElectroDB queries will paginate through all results with the [`go()`](#building-queries) method. ElectroDB's `page()` method can be used to manually iterate through DynamoDB query results._
 
 The `page` method _ends_ a query chain, and asynchronously queries DynamoDB with the `client` provided in the model. Unlike the `.go()`, the `.page()` method returns a tuple.
 
@@ -4093,6 +4114,9 @@ let [pageTwo, moreStores] = await MallStores.query
 ```
 
 #### Service Pagination
+
+> _NOTE: By Default, ElectroDB will paginate through all results with the [`query()`](#building-queries) method. ElectroDB's `page()` method can be used to manually iterate through DynamoDB query results._
+
 Pagination with services is also possible. Similar to [Entity Pagination](#entity-pagination), calling the `.page()` method returns a `[pager, results]` tuple. Also, similar to pagination on Entities, the pager object returned by default is a deconstruction of the returned LastEvaluatedKey.
 
 #### Pager Query Options
@@ -4209,7 +4233,7 @@ await StoreLocations.query.leases({storeId}).gte({leaseEndDate: "2020-03"}).go()
 // Lease Agreements by StoreId before 2021
 await StoreLocations.query.leases({storeId}).lt({leaseEndDate: "2021-01"}).go()
 
-// Lease Agreements by StoreId before Feburary 2021
+// Lease Agreements by StoreId before February 2021
 await StoreLocations.query.leases({storeId}).lte({leaseEndDate: "2021-02"}).go()
 
 // Lease Agreements by StoreId between 2010 and 2020
@@ -4261,6 +4285,7 @@ By default, **ElectroDB** enables you to work with records as the names and prop
   response?: "default" | "none" | "all_old" | "updated_old" | "all_new" | "updated_new";
   ignoreOwnership?: boolean;
   limit?: number;
+  pages?: number;
 };
 ```
 
@@ -4276,7 +4301,8 @@ concurrent      | `1`                  | When performing batch operations, how m
 unprocessed     | `"item"`             | Used in batch processing to override ElectroDBs default behaviour to break apart DynamoDBs `Unprocessed` records into composite attributes. See more detail about this in the sections for [BatchGet](#batch-get), [BatchDelete](#batch-write-delete-records), and [BatchPut](#batch-write-put-records).
 response        | `"default"`          | Used as a convenience for applying the DynamoDB parameter `ReturnValues`. The options here are the same as the parameter values for the DocumentClient except lowercase. The `"none"` option will cause the method to return null and will bypass ElectroDB's response formatting -- useful if formatting performance is a concern.
 ignoreOwnership | `false`              | By default, **ElectroDB** interrogates items returned from a query for the presence of matching entity "identifiers". This helps to ensure other entities, or other versions of an entity, are filtered from your results. If you are using ElectroDB with an existing table/dataset you can turn off this feature by setting this property to `true`.
-limit           | _none_               | A convenience option for the query parameter `Limit`, used to specify the number of records to retrieve while performing a query.
+limit           | _none_               | A target for the number of items to return from DynamoDB. If this option is passed, Queries on entities and through collections will paginate DynamoDB until this limit is reached or all items for that query have been returned.
+pages           | ∞                    | How many DynamoDB pages should a query iterate through before stopping. By default ElectroDB paginate through all results for your query.
 
 # Errors:
 
@@ -4531,12 +4557,77 @@ Tables can be defined on the [Service Options](#service-options) object when you
 *Code: 2004*
 
 *Why this occurred:*
-When performing a bulk operation ([Batch Get](#batch-get), [Batch Delete Records](#batch-write-delete-records), [Batch Put Records](#batch-write-put-records)) you can pass a [Query Options](#query-options) called `concurrent`, which impacts how many batch requests can occur at the same time. Your value pass the test of both, `!isNaN(parseInt(value))` and `parseInt(value) > 0`.
+When performing a bulk operation ([Batch Get](#batch-get), [Batch Delete Records](#batch-write-delete-records), [Batch Put Records](#batch-write-put-records)) you can pass a [Query Options](#query-options) called `concurrent`, which impacts how many batch requests can occur at the same time. Your value should pass the test of both, `!isNaN(parseInt(value))` and `parseInt(value) > 0`.
 
 *What to do about it:*   
-Expect this error only if you're providing a concurrency value. Double-check the value you are providing is the value you expect to be passing, and that the value passes the tests listed above.
+Expect this error only if you're providing a `concurrency` option. Double-check the value you are providing is the value you expect to be passing, and that the value passes the tests listed above.
+
+### Invalid Pages Option
+*Code: 2005*
+
+*Why this occurred:*
+When performing a query [Query](#building-queries) you can pass a [Query Options](#query-options) called `pages`, which impacts how many DynamoDB pages a query should iterate through. Your value should pass the test of both, `!isNaN(parseInt(value))` and `parseInt(value) > 0`.
+
+*What to do about it:*
+Expect this error only if you're providing a `pages` option. Double-check the value you are providing is the value you expect to be passing, and that the value passes the tests listed above.
+
+### Invalid Limit Option
+*Code: 2006*
+
+*Why this occurred:*
+When performing a query [Query](#building-queries) you can pass a [Query Options](#query-options) called `limit`, which impacts how many DynamoDB items a query should return. Your value should pass the test of both, `!isNaN(parseInt(value))` and `parseInt(value) > 0`.
+
+*What to do about it:*
+Expect this error only if you're providing a `limit` option. Double-check the value you are providing is the value you expect to be passing, and that the value passes the tests listed above.
+
+### Invalid Attribute
+*Code: 3001*
+
+*Why this occurred:*
+The value received for a validation either failed type expectations (e.g. a "number" instead of a "string"), or the user provided "validate" callback on an attribute rejected a value.
+
+*What to do about it:*
+Examine the error itself for more precise detail on why the failure occurred. The error object itself should have a property called "fields" which contains an array of every attribute that failed validation, and a reason for each. If the failure originated from a "validate" callback, the originally thrown error will be accessible via the `cause` property the corresponding element within the fields array.1
+
+Below is the type definition for an ElectroValidationError:
+
+```typescript
+ElectroValidationError<T extends Error = Error> extends ElectroError {
+    readonly name: "ElectroValidationError"
+    readonly code: number;
+    readonly date: number;
+    readonly isElectroError: boolean;
+    ref: {
+        readonly code: number;
+        readonly section: string;
+        readonly name: string;
+        readonly sym: unique symbol;
+    }
+    readonly fields: ReadonlyArray<{
+        /**
+         * The json path to the attribute that had a validation error
+         */
+        readonly field: string;
+
+        /**
+         * A description of the validation error for that attribute
+         */
+        readonly reason: string;
+
+        /**
+         * Index of the value passed (present only in List attribute validation errors)
+         */
+        readonly index: number | undefined;
+
+        /**
+         * The error thrown from the attribute's validate callback (if applicable)
+         */
+        readonly cause: T | undefined;
+    }>
+}
+```
 
-### aws-error
+### AWS Error
 *Code: 4001*
 
 *Why this occurred:*
@@ -5462,4 +5553,3 @@ This change stems from the fact the `facets` is already a defined term in the Dy
 
 # Coming Soon
 - Default query options defined on the `model` to give more general control of interactions with the Entity.
-- Complex attributes (list, map, set)

package/index.d.ts

@@ -1,6 +1,45 @@
 declare const WhereSymbol: unique symbol;
 declare const UpdateDataSymbol: unique symbol;
 
+export interface ElectroError extends Error {
+    readonly name: 'ElectroError';
+    readonly code: number;
+    readonly date: number;
+    readonly isElectroError: boolean;
+    ref: {
+        readonly code: number;
+        readonly section: string;
+        readonly name: string;
+        readonly sym: unique symbol;
+    }
+}
+
+interface ElectroValidationErrorFieldReference<T extends Error = Error> {
+    /**
+     * The json path to the attribute that had a validation error
+     */
+    readonly field: string;
+
+    /**
+     * A description of the validation error for that attribute
+     */
+    readonly reason: string;
+
+    /**
+     * Index of the value passed (present only in List attribute validation errors)
+     */
+    readonly index: number | undefined;
+
+    /**
+     * The error thrown from the attribute's validate callback (if applicable)
+     */
+    readonly cause: T | undefined;
+}
+
+export interface ElectroValidationError<T extends Error = Error> extends ElectroError {
+    readonly fields: ReadonlyArray<ElectroValidationErrorFieldReference<T>>;
+}
+
 interface ReadOnlyAttribute {
     readonly readOnly: true;
 }
@@ -933,6 +972,7 @@ interface QueryOptions {
     includeKeys?: boolean;
     originalErr?: boolean;
     ignoreOwnership?: boolean;
+    pages?: number;
 }
 
 // subset of QueryOptions
@@ -1103,7 +1143,7 @@ export class Entity<A extends string, F extends A, C extends string, S extends S
     readonly schema: S;
     constructor(schema: S, config?: EntityConfiguration);
     get(key: AllTableIndexCompositeAttributes<A,F,C,S>): SingleRecordOperationOptions<A,F,C,S, ResponseItem<A,F,C,S> | null>;
-    get(key: AllTableIndexCompositeAttributes<A,F,C,S>[]): BulkRecordOperationOptions<A,F,C,S, [AllTableIndexCompositeAttributes<A,F,C,S>[], ResponseItem<A,F,C,S>[]]>;
+    get(key: AllTableIndexCompositeAttributes<A,F,C,S>[]): BulkRecordOperationOptions<A,F,C,S, [Array<ResponseItem<A,F,C,S>>, Array<AllTableIndexCompositeAttributes<A,F,C,S>>]>;
     delete(key: AllTableIndexCompositeAttributes<A,F,C,S>): DeleteRecordOperationOptions<A,F,C,S, ResponseItem<A,F,C,S>>;
     delete(key: AllTableIndexCompositeAttributes<A,F,C,S>[]): BulkRecordOperationOptions<A,F,C,S, AllTableIndexCompositeAttributes<A,F,C,S>[]>;
     remove(key: AllTableIndexCompositeAttributes<A,F,C,S>): DeleteRecordOperationOptions<A,F,C,S, ResponseItem<A,F,C,S>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electrodb",
-  "version": "1.4.7",
+  "version": "1.6.1",
   "description": "A library to more easily create and interact with multiple entities and heretical relationships in dynamodb",
   "main": "index.js",
   "scripts": {
@@ -25,7 +25,7 @@
   },
   "homepage": "https://github.com/tywalch/electrodb#readme",
   "devDependencies": {
-    "@istanbuljs/nyc-config-typescript": "^1.0.1",
+    "@istanbuljs/nyc-config-typescript": "^1.0.2",
     "@types/chai": "^4.2.12",
     "@types/mocha": "^8.0.3",
     "@types/node": "^15.6.0",
@@ -33,7 +33,7 @@
     "aws-sdk": "2.630.0",
     "browserify": "^17.0.0",
     "chai": "4.2.0",
-    "coveralls": "^3.1.0",
+    "coveralls": "^3.1.1",
     "istanbul": "0.4.5",
     "jest": "25.4.0",
     "mocha": "7.1.1",
@@ -50,6 +50,9 @@
     "electrodb",
     "dynamo",
     "dynamodb",
+    "nosql",
+    "single table design",
+    "typescript",
     "aws"
   ],
   "tsd": {