feat: add the new method to create and persist entry with default values (#57) (#68)

close #57

Author: cuebit

src/query/Query.ts

@@ -379,6 +379,17 @@ export class Query<M extends Model = Model> {
     return this.model.$getRelation(name)
   }
 
+  /**
+   * Create and persist model with default values.
+   */
+  async new(): Promise<M> {
+    const model = this.model.$newInstance(undefined, { relations: false })
+
+    this.connection.insert(this.compile(model))
+
+    return model
+  }
+
   /**
    * Insert the given record to the store.
    */

src/repository/Repository.ts

@@ -174,6 +174,13 @@ export class Repository<M extends Model = Model> {
     })
   }
 
+  /**
+   * Create and persist model with default values.
+   */
+  new(): Promise<M> {
+    return this.query().new()
+  }
+
   /**
    * Insert the given records to the store.
    */

test/feature/repository/inserts_new.spec.ts

@@ -0,0 +1,40 @@
+import { createStore, assertState, mockUid } from 'test/Helpers'
+import { Model, Str, Num, Bool, Uid, Attr } from '@/index'
+
+describe('feature/repository/inserts_new', () => {
+  it('inserts with a models default values', async () => {
+    class User extends Model {
+      static entity = 'users'
+
+      @Uid() id!: string
+      @Str('John Doe') name!: string
+      @Num(21) age!: number
+      @Bool(true) active!: boolean
+    }
+
+    mockUid(['uid1'])
+
+    const store = createStore()
+
+    await store.$repo(User).new()
+
+    assertState(store, {
+      users: {
+        uid1: { id: 'uid1', name: 'John Doe', age: 21, active: true }
+      }
+    })
+  })
+
+  it('throws if a primary key is not capable of being generated', async () => {
+    class User extends Model {
+      static entity = 'users'
+
+      @Attr() id!: any
+      @Str('John Doe') name!: string
+    }
+
+    const store = createStore()
+
+    await expect(() => store.$repo(User).new()).rejects.toThrow()
+  })
+})