refactor: rename "getDeletedAttributes" to "getRemovedAttributes"

This keeps the terminology in line with DynamoDB, which uses "remove" to
indicate an attribute should be removed from the document and "delete"
to either delete an item from the database or remove an item from a Set
attribute.

src/events.ts

@@ -68,8 +68,13 @@ export interface BeforeSaveEvent<T extends Table> extends SaveEvent<T> {
 export interface AfterSaveEvent<T extends Table> extends BeforeSaveEvent<T> {
   output: PutItemCommandOutput | UpdateItemCommandOutput
   originalValues: AttributeMap
-  deletedAttributes: string[]
+  removedAttributes: string[]
   updatedAttributes: string[]
+
+  /**
+   * @deprecated
+   */
+  deletedAttributes: string[]
 }
 
 export interface DeleteEvent<T extends Table> extends BaseEvent<T> {

src/query/update-item-input.ts

@@ -70,7 +70,7 @@ export function getUpdateItemInput<T extends Table>(record: T, params?: UpdateIt
     }
   })
 
-  _.each(_.uniq(record.getDeletedAttributes()), (attrName, i) => {
+  _.each(_.uniq(record.getRemovedAttributes()), (attrName, i) => {
     const slug = `#DA${valueCounter}`
     attributeNameMap[slug] = attrName
     removes.push(slug)

src/table.spec.ts

@@ -93,7 +93,7 @@ describe('Table', () => {
     card.testString = ''
     expect(card.testString).to.eq(null, 'cleared strings become null, because DynamoDB does not allow empty string values')
     expect(card.getUpdatedAttributes()).to.deep.eq([])
-    expect(card.getDeletedAttributes()).to.deep.eq(['testString'])
+    expect(card.getRemovedAttributes()).to.deep.eq(['testString'])
     await card.save()
 
     const reloadedCard = await TestableTable.primaryKey.get(10, '100')

src/table.ts

@@ -260,7 +260,7 @@ export class Table {
    * Get the list of attributes pending update.
    *
    * The result includes attributes that have also been deleted. To get just
-   * the list of attributes pending deletion, use {@link Table.getDeletedAttributes}.
+   * the list of attributes pending removal, use {@link Table.getRemovedAttributes}.
    *
    * If you want to easily know if this record has updates pending, use {@link Table.hasChanges}.
    */
@@ -269,16 +269,25 @@ export class Table {
   }
 
   /**
-   * Get the list of attributes pending deletion.
+   * Get the list of attributes pending removal.
    *
    * To get all the attributes that have been updated, use {@link Table.getUpdatedAttributes}.
    *
    * If you want to easily know if this record has updates pending, use {@link Table.hasChanges}.
    */
-  public getDeletedAttributes(): string[] {
+  public getRemovedAttributes(): string[] {
     return [...this.__removedAttributes]
   }
 
+  /**
+   * Use getRemovedAttributes.
+   *
+   * @deprecated
+   */
+  public getDeletedAttributes(): string[] {
+    return this.getRemovedAttributes()
+  }
+
   /**
    * While similar to setAttributes, this method runs the attribute's defined fromJSON
    * methods to help standardize the attribute values as much as possible.
@@ -393,7 +402,7 @@ export class Table {
     // track that this value was updated
     this.__updatedAttributes.add(attributeName)
 
-    // ensure the attribute is not marked for being deleted
+    // ensure the attribute is not marked for removal
     this.__removedAttributes.delete(attributeName)
 
     return this
@@ -560,7 +569,7 @@ export class Table {
       // grab the current changes to pass to the afterSave event
       const originalValues = this.getOriginalValues()
       const updatedAttributes = this.getUpdatedAttributes()
-      const deletedAttributes = this.getDeletedAttributes()
+      const removedAttributes = this.getRemovedAttributes()
 
       // reset internal tracking of changes attributes
       this.__putRequired = false
@@ -575,7 +584,8 @@ export class Table {
         output,
         originalValues,
         updatedAttributes,
-        deletedAttributes,
+        removedAttributes,
+        deletedAttributes: removedAttributes,
       })
 
       if (beforeSaveEvent.returnOutput === true) {