0.4.0

* Add `select()` for sparse fields

* Remove `find()` restriction for integers

Author: robsontenorio

README.md

@@ -35,7 +35,7 @@ let posts = await Post
   .where('status', 'ACTIVE')
   .include('user', 'category')
   .append('likes')
-  .orderBy('-created_at', 'category_id')
+  .orderBy('-created_at', 'category_id')  
   .get()
 
 ```
@@ -79,7 +79,6 @@ Let's create a new object and post it:
 
 ```js
 let post = new Post()
-post.title = 'Cool!'
 
 // or
 
@@ -88,6 +87,7 @@ let post = new Post({title: 'Cool!'})
 
 // POST /post
 
+post.title = 'Another one'
 post.save()
 ```
 
@@ -216,8 +216,7 @@ import Model from './Model'
 export default class User extends Model {
 
   // computed properties are reactive -> user.fullname
-  // make sure to use "get" prefix 
-  get fullname()
+  get fullname()
   {
     return `${this.firstname} ${this.lastname}`
   }
@@ -432,33 +431,48 @@ let users = await User
         .orderBy('firstname')
         .page(1) 
         .limit(20)
-        .get()
+        .$get() // sometimes you will prefer $get()
 
 ```
 
-# Nice trick
+# Selecting fields
 
-You can build something like scoped queries.
+Just want only some fields?
 
 ```js
-import Model from './Model'
+// GET posts?fields[posts]=title,content
 
-export default class Post extends Model {
-    
-   // make sure this is a static method
-   static active()  
-   {
-      // here you could chain more methods from vue-query-api
-      return this.where('status', 'active')
-   }
-}
+let post = await Post
+   .select(['title', 'content'])
+   .get() 
 ```
-So, you can do this:
+
+With related entities:
 
 ```js
-let activePosts = await Post
-  .active()
-  .get()
+// GET posts?include=user&fields[posts]=title,content&fields[user]=firstname,age
+
+let post = await Post
+   .select({
+      posts: ['title', 'content'],
+      user: ['age', 'firstname']
+    })
+   .include('user')
+   .get() 
+```
+
+**TIP:** If you are using spatie/laravel-query-builder, when using related entities, you must pass extra fields:
+
+```js
+// GET posts?include=user&fields[posts]=title,content,user_id&fields[user]=id,firstname,age
+
+let post = await Post
+   .select({
+      posts: ['title', 'content', 'user_id'],  //user_id
+      user: ['id', 'age', 'firstname']         //id
+    })
+   .include('user')
+   .get() 
 ```
 
 
@@ -564,7 +578,9 @@ let users  = data
 
 // but you can use the "fetch style request" with "$get()"
 
-let users = await User.$get()
+let users = await User
+  .where('status', 'ACTIVE')
+  .$get() // <---- HERE
 ```
 
 This **WILL NOT** be converted into an array of `User` model.

src/Builder.js

@@ -1,24 +1,37 @@
+/**
+ * Prepare attributes to be parsed
+ */
+
 import Parser from './Parser';
 
 export default class Builder {
 
-  constructor() {
+  constructor(model) {
+    this.model = model
     this.includes = []
     this.appends = []
     this.sorts = []
     this.pageValue = null
     this.limitValue = null
+    this.fields = {
+      fields: {}
+    }
     this.filters = {
       filter: {}
     }
 
     this.parser = new Parser(this)
   }
 
+  // query string parsed 
   query () {
     return this.parser.query()
   }
 
+  /**
+   * Query builder
+   */
+
   include (...args) {
     this.includes = args
 
@@ -31,22 +44,22 @@ export default class Builder {
     return this
   }
 
-  page (value) {
-    if (!Number.isInteger(value)) {
-      throw new Error('The VALUE must be an integer on page() method.')
+  select (...fields) {
+    if (fields.length === 0) {
+      throw new Error('You must specify the fields on select() method.')
     }
 
-    this.pageValue = value
-
-    return this
-  }
-
-  limit (value) {
-    if (!Number.isInteger(value)) {
-      throw new Error('The VALUE must be an integer on limit() method.')
+    // single entity .select(['age', 'firstname'])
+    if (fields[0].constructor === String || fields[0].constructor === Array) {
+      this.fields.fields[this.model.resource()] = fields.join(',')
     }
 
-    this.limitValue = value
+    // related entities .select({ posts: ['title', 'content'], user: ['age', 'firstname']} )
+    if (fields[0].constructor === Object) {
+      Object.entries(fields[0]).forEach(([key, value]) => {
+        this.fields.fields[key] = value.join(',')
+      })
+    }
 
     return this
   }
@@ -77,4 +90,24 @@ export default class Builder {
 
     return this
   }
-}
+
+  page (value) {
+    if (!Number.isInteger(value)) {
+      throw new Error('The VALUE must be an integer on page() method.')
+    }
+
+    this.pageValue = value
+
+    return this
+  }
+
+  limit (value) {
+    if (!Number.isInteger(value)) {
+      throw new Error('The VALUE must be an integer on limit() method.')
+    }
+
+    this.limitValue = value
+
+    return this
+  }
+}

src/Model.js

@@ -6,9 +6,9 @@ export default class Model extends StaticModel {
   constructor(...atributtes) {
     super()
 
-    // Keep clean object if is a manual instance
+    // Keep clean object if it is a manual instance
     if (atributtes.length === 0) {
-      this._builder = new Builder()
+      this._builder = new Builder(this)
       this._fromResource = null
       this._customResource = null
     } else {
@@ -28,6 +28,10 @@ export default class Model extends StaticModel {
     }
   }
 
+  /**
+   *  Setup
+   */
+
   get $http () {
     return Model.$http
   }
@@ -47,7 +51,6 @@ export default class Model extends StaticModel {
   }
 
   hasMany (model) {
-
     let instance = new model
     let url = `${this.baseURL()}/${this.resource()}/${this.id}/${instance.resource()}`
 
@@ -56,12 +59,44 @@ export default class Model extends StaticModel {
     return instance
   }
 
+  /**
+   * Helpers
+   */
+
+  hasId () {
+    return this.id !== undefined && this.id !== 0 && this.id !== ''
+  }
+
+  endpoint () {
+    if (this.hasId()) {
+      return `${this.baseURL()}/${this.resource()}/${this.id}`
+    } else {
+      return `${this.baseURL()}/${this.resource()}`
+    }
+  }
+
+  /**
+   *  Query
+   */
+
   include (...args) {
     this._builder.include(...args)
 
     return this
   }
 
+  append (...args) {
+    this._builder.append(...args)
+
+    return this
+  }
+
+  select (...fields) {
+    this._builder.select(...fields)
+
+    return this
+  }
+
   where (field, value) {
     this._builder.where(field, value)
 
@@ -74,8 +109,8 @@ export default class Model extends StaticModel {
     return this
   }
 
-  append (...args) {
-    this._builder.append(...args)
+  orderBy (...args) {
+    this._builder.orderBy(...args)
 
     return this
   }
@@ -92,11 +127,9 @@ export default class Model extends StaticModel {
     return this
   }
 
-  orderBy (...args) {
-    this._builder.orderBy(...args)
-
-    return this
-  }
+  /** 
+   * Result
+   */
 
   first () {
     return this.get().then(response => {
@@ -112,12 +145,12 @@ export default class Model extends StaticModel {
     })
   }
 
-  find (id) {
-    if (!Number.isInteger(id)) {
-      throw new Error('The ID must be an integer on find() method.')
+  find (identifier) {
+    if (identifier === undefined) {
+      throw new Error('You must specify the param on find() method.')
     }
 
-    let url = `${this.baseURL()}/${this.resource()}/${id}${this._builder.query()}`
+    let url = `${this.baseURL()}/${this.resource()}/${identifier}${this._builder.query()}`
 
     return this.request({
       url,
@@ -133,21 +166,6 @@ export default class Model extends StaticModel {
     })
   }
 
-  delete () {
-    if (!this.hasId()) {
-      throw new Error('This model has a empty ID.')
-    }
-
-    let url = `${this.baseURL()}/${this.resource()}/${this.id}`
-
-    return this.request({
-      url,
-      method: 'DELETE'
-    }).then(response => {
-      return response
-    })
-  }
-
   get () {
     let base = this._fromResource || `${this.baseURL()}/${this.resource()}`
     base = this._customResource || base
@@ -194,16 +212,23 @@ export default class Model extends StaticModel {
     })
   }
 
-  hasId () {
-    return this.id !== undefined && this.id !== 0 && this.id !== ''
-  }
+  /**
+   * CRUD operations
+   */
 
-  endpoint () {
-    if (this.hasId()) {
-      return `${this.baseURL()}/${this.resource()}/${this.id}`
-    } else {
-      return `${this.baseURL()}/${this.resource()}`
+  delete () {
+    if (!this.hasId()) {
+      throw new Error('This model has a empty ID.')
     }
+
+    let url = `${this.baseURL()}/${this.resource()}/${this.id}`
+
+    return this.request({
+      url,
+      method: 'DELETE'
+    }).then(response => {
+      return response
+    })
   }
 
   save () {