Merge pull request #716 from dynamoosejs/documentOriginalItem

document.original

BREAKING_CHANGES.md

@@ -11,3 +11,5 @@
 - `dynamoose.local` has been renamed to `dynamoose.aws.ddb.local`
 - `Model.getTableReq` has been renamed to `Model.table.create.request`
 - `Model.table.create.request` (formerly `Model.getTableReq`) is now an async function
+- `model.originalItem` has been renamed to `model.original` (or `Document.original`)
+- `Document.original` formerly (`model.originalItem`) no longer returns the last item saved, but the item first retrieved from DynamoDB

docs/api/Document.md

@@ -52,3 +52,16 @@ myUser.save((error) => {
 	}
 });
 ```
+
+## document.original()
+
+This function returns the original item that was received from DynamoDB. This function will return a JSON object that represents the original item. In the event no item has been retrieved from DynamoDB `null` will be returned.
+
+```js
+const user = await User.get(1);
+console.log(user); // {"id": 1, "name": "Bob"}
+user.name = "Tim";
+
+console.log(user); // {"id": 1, "name": "Tim"}
+console.log(user.original()); // {"id": 1, "name": "Bob"}
+```

lib/Document.js

@@ -14,6 +14,8 @@ function DocumentCarrier(model) {
 			const documentObject = Document.isDynamoObject(object) ? aws.converter().unmarshall({...object}) : object;
 			Object.keys(documentObject).forEach((key) => this[key] = documentObject[key]);
 			this[internalProperties] = {};
+			this[internalProperties].originalObject = {...object};
+			this[internalProperties].originalSettings = {...settings};
 
 			if (settings.fromDynamo) {
 				this[internalProperties].storedInDynamo = true;
@@ -258,6 +260,10 @@ function DocumentCarrier(model) {
 		return this;
 	};
 
+	Document.prototype.original = function() {
+		return this[internalProperties].originalSettings.type === "fromDynamo" ? this[internalProperties].originalObject : null;
+	};
+
 	Document.Model = model;
 
 	// TODO: figure out if there is a better way to do this below.

test/Document.js

@@ -79,7 +79,7 @@ describe("Document", () => {
 		});
 	});
 
-	describe("save", () => {
+	describe("document.save", () => {
 		let User, user, putParams = [], putItemFunction;
 		beforeEach(() => {
 			Model.defaults = {
@@ -933,6 +933,35 @@ describe("Document", () => {
 		});
 	});
 
+	describe("document.original", () => {
+		let model;
+		beforeEach(() => {
+			model = new Model("User", {"id": Number}, {"create": false, "waitForActive": false});
+		});
+		afterEach(() => {
+			model = null;
+		});
+
+		it("Should be a function", () => {
+			expect(new model({}).original).to.be.a("function");
+		});
+
+		it("Should return null if not retrieving from database", () => {
+			expect(new model({}).original()).to.eql(null);
+		});
+
+		it("Should return original object if retrieving from database", () => {
+			expect(new model({"id": 1}, {"type": "fromDynamo"}).original()).to.eql({"id": 1});
+		});
+
+		it("Should return original object if retrieving from database even after modifying document", () => {
+			const document = new model({"id": 1}, {"type": "fromDynamo"});
+			document.id = 2;
+			expect(document.original()).to.eql({"id": 1});
+			expect({...document}).to.eql({"id": 2});
+		});
+	});
+
 	describe("conformToSchema", () => {
 		beforeEach(() => {
 			Model.defaults = {