fix(base-model): support graph inserts

Allow graph inserts by allowing proxy to set #special properties
Make relation properties settable without being in the schema
Fall back to inserting a model if updating fails which allows setting the ID to a known value.

packages/base-model/src/index.js

@@ -26,7 +26,7 @@ class BaseModel extends Model {
 
     const handler = {
       set: (obj, prop, value) => {
-        if (this.constructor.jsonSchema.properties[prop]) {
+        if (this.isSettable(prop)) {
           obj[prop] = value
           return true
         }
@@ -84,6 +84,16 @@ class BaseModel extends Model {
     return baseSchema
   }
 
+  isSettable(prop) {
+    const special = ['#id', '#ref']
+    return (
+      special.includes(prop) ||
+      this.constructor.jsonSchema.properties[prop] ||
+      (this.constructor.relationMappings &&
+        this.constructor.relationMappings[prop])
+    )
+  }
+
   $beforeInsert() {
     this.id = this.id || uuid.v4()
     this.created = new Date().toISOString()
@@ -99,7 +109,10 @@ class BaseModel extends Model {
       saved = await this.constructor
         .query()
         .patchAndFetchById(this.id, this.toJSON())
-    } else {
+    }
+
+    if (!saved) {
+      // either model has no ID or the ID was not found in the database
       saved = await this.constructor.query().insert(this.toJSON())
     }
     logger.info(`Saved ${this.constructor.name} with UUID ${saved.id}`)
@@ -114,7 +127,7 @@ class BaseModel extends Model {
 
   updateProperties(properties) {
     Object.keys(properties).forEach(prop => {
-      if (this.constructor.jsonSchema.properties[prop]) {
+      if (this.isSettable(prop)) {
         this[prop] = properties[prop]
       } else {
         throw validationError(prop, this.constructor.name)

packages/base-model/test/manuscript_test.js

@@ -65,8 +65,19 @@ describe('Manuscript', () => {
     )
   })
 
+  it('can assign to special properties', () => {
+    const manuscript = new Manuscript()
+    manuscript['#id'] = 'idref'
+  })
+
   it('takes schema specified in config into account', async () => {
     const manuscript = new Manuscript({ configField: 'hello' })
     expect(manuscript.configField).toEqual('hello')
   })
+
+  it('can save new entity with known ID', async () => {
+    const id = '1838d074-fb9d-4ed6-9c63-39e6bc7429ce'
+    const manuscript = await new Manuscript({ id }).save()
+    expect(manuscript.id).toEqual(id)
+  })
 })