@trullock/firebase-common 1.3.0 → 2.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trullock/firebase-common",
-  "version": "1.3.0",
+  "version": "2.0.0",
   "description": "Collection of common firebase helpers",
   "homepage": "https://github.com/trullock/firebase#readme",
   "bugs": {

package/src/automapper.js

@@ -4,7 +4,7 @@ let mappings = [];
 /**
  * 
  * @param {function} toFirestore A function of the form (key: string, value: object/primitive) => object/primitive. Return a mapped value or undefined to fallback to default mapping
- * @param {function} fromFirestore A function of the form (key: string, value: object/primitive, dest: object) => object/primitive. Return a mapped value or undefined to fallback to default mapping
+ * @param {function} fromFirestore A function of the form (key: string, value: object/primitive) => object/primitive. Return a mapped value or undefined to fallback to default mapping
  */
 export function registerMapping(toFirestore, fromFirestore)
 {
@@ -17,8 +17,8 @@ export function registerMapping(toFirestore, fromFirestore)
 let migrations = []
 /**
  * 
- * @param {function} shouldApply A function of the form (key: string, parent: object, value: object/primitive) => true/false. Return if the migration should apply or not
- * @param {function} apply A function of the form key: string, parent: object, value: object/primitive) => object/primitive. Migrate the value. Return undefined to disregard the value.
+ * @param {function} shouldApply A function of the form ({ key: string, parent: object, value: object/primitive, destination: object, type: class }) => true/false. Return if the migration should apply or not
+ * @param {function} apply A function of the form ({ key: string, parent: object, value: object/primitive, destination: object, type: class }) => object/primitive. Migrate the value. Return undefined to disregard the value.
  */
 export function registerMigration(shouldApply, apply)
 {
@@ -212,6 +212,7 @@ export function autoMapFromFirestore(obj)
 		let dest = {};
 		let mapping = null;
 
+		// does this living here mean it cant be migrated?
 		if(obj._type)
 		{
 			mapping = getClassMappingByName(obj._type)
@@ -219,28 +220,38 @@ export function autoMapFromFirestore(obj)
 		}
 
 		for(let [key, value] of Object.entries(obj))
-		{
-			if(key == '_type')
-				continue;
-			
-			if(mapping?.getters?.indexOf(key) > -1)
-				continue;
+		{	
+			let prop = {
+				key,
+				value,
+				parent: obj,
+				destination: dest, 
+				type: mapping?.type
+			}
 
 			for(let migration of migrations)
 			{
-				if(!migration.shouldApply(key, obj, value, dest, mapping?.type))
+				// shouldApply should not mutate prop object
+				if(!migration.shouldApply(prop))
 					continue;
 
-				value = migration.apply(key, obj, value, dest, mapping?.type);
+				// the intention is for the migration to mutate the prop object
+				migration.apply(prop);
 			}
 
+			if(prop.key == "_type")
+				continue;
+
+			if(mapping?.getters?.indexOf(prop.key) > -1)
+				continue;
+
 			let handled = false;
 			for(let mapping of mappings)
 			{
-				let result = mapping.fromFirestore(key, value, dest)
+				let result = mapping.fromFirestore(prop.key, prop.value)
 				if(result !== undefined)
 				{
-					dest[key] = result;
+					prop.destination[prop.key] = result;
 					handled = true;
 					break;
 				}
@@ -248,9 +259,9 @@ export function autoMapFromFirestore(obj)
 
 			if(!handled)
 			{
-				let result = autoMapFromFirestore(value);
+				let result = autoMapFromFirestore(prop.value);
 				if(result != undefined)
-					dest[key] = result;
+					prop.destination[prop.key] = result;
 			}
 		}
 

package/tests/automapper.test.js

@@ -1,6 +1,6 @@
 import test from "node:test";
 import assert from "node:assert";
-import { autoMapFromFirestore, autoMapToFirestore, registerClassForPersistence, registerMapping } from "../src/automapper.js";
+import { autoMapFromFirestore, autoMapToFirestore, registerClassForPersistence, registerMigration } from "../src/automapper.js";
 import { Mixins } from "../src/utils.js";
 
 class AggregateRoot
@@ -70,10 +70,6 @@ class Baz extends Foo {
 
 class Academy extends Mixins([Baz, AggregateRoot])
 {
-	static Test = class {}
-
-	uniqueList = new Set();
-
 	changeName(name)
 	{
 		this.apply('academyNameChanged', {
@@ -90,11 +86,9 @@ class Academy extends Mixins([Baz, AggregateRoot])
 	{
 		super();
 		this.bar = new Baz.Bar();
-		this.uniqueList.add('a')
-		this.uniqueList.add('b')
-		this.uniqueList.add('b')
 	}
 
+	static Test = class {}
 }
 
 test('test', t => {
@@ -113,17 +107,6 @@ test('test', t => {
 test('automapping', t => {
 	registerClassForPersistence(Academy);
 
-	registerMapping((key, value) => {
-		if(value instanceof Set)
-			return Array.from(value)
-		return undefined;
-	}, (key, value, dest) => {
-		if(dest[key] instanceof Set)
-			return new Set(value);
-		return undefined;
-	})
-
-
 	let a = new Academy();
 	let mapped = autoMapToFirestore(a);
 	let unmapped = autoMapFromFirestore(mapped);
@@ -137,14 +120,41 @@ test('automapping', t => {
 	assert.equal(unmapped.bar.a, 1)
 
 	assert.equal(a.bar.barzy(), "barzy")
-	assert.equal(unmapped.bar.barzy(), "barzy");
+	assert.equal(unmapped.bar.barzy(), "barzy")
 
 	assert.equal(a.foozzy(), "foozzy")
 	assert.equal(unmapped.foozzy(), "foozzy")
 
 	assert.equal(a.bazzy(), "bazzy")
 	assert.equal(unmapped.bazzy(), "bazzy")
+})
+
+
+test('migrations', t => {
+	registerClassForPersistence(Academy);
+	
+	// rename oldName to name
+	registerMigration(prop => prop.type == Academy && prop.key == "oldName", prop => prop.key = "name" )
+
+	registerMigration(prop => prop.type == Academy && prop.key == "oldBar", prop => {
+		prop.key = "bar"
+		prop.value._type = "Academy.Bar";
+	})
+
+	// rename bar.oldA to bar.a
+	registerMigration(prop => prop.type == Baz.Bar && prop.key == "oldA", prop => prop.key = "a" )
 
-	assert(a.uniqueList instanceof Set)
-	assert.equal(unmapped.uniqueList.size, 2)
+	let mapped = {
+		_type: "Academy",
+		oldName: "the name",
+		oldBar: {
+			_type: "Academy.OldBar",
+			oldA: 1337
+		}
+	}
+	let unmapped = autoMapFromFirestore(mapped);
+
+	assert.equal(unmapped.d, 4)
+	assert(unmapped.bar instanceof Baz.Bar)
+	assert.equal(unmapped.bar.a, 1337)
 })