Feature/3.0.0

.eslintrc.js

@@ -1,6 +1,6 @@
 module.exports = {
-  parser: 'babel-eslint',
-  plugins: [ 'flowtype' ],
+  parser: '@typescript-eslint/parser',
+  plugins: [ '@typescript-eslint' ],
 
   env: {
     browser: true,
@@ -18,20 +18,10 @@ module.exports = {
     }
   },
 
-  extends: [
-    'plugin:flowtype/recommended',
-    'standard'
-  ],
-
   rules: {
     'object-curly-spacing': ['warn', 'always'],
     'prefer-promise-reject-errors': 'off',
-    'no-duplicate-imports': 'off',
-    'flowtype/no-weak-types': [0, {
-      'any': false,
-      'Object': false,
-      'Function': false
-    }]
+    'no-duplicate-imports': 'off'
   }
 };
 

.gitignore

@@ -3,3 +3,6 @@ coverage/
 node_modules/
 flow-typed/
 .eslintcache
+*.log
+*.swp
+*.rpt2*

.npmignore

@@ -1,2 +1,28 @@
-src/
-.babelrc
+*.log
+npm-debug.log*
+
+# Coverage directory used by tools like istanbul
+coverage
+.nyc_output
+
+# Dependency directories
+node_modules
+
+# npm package lock
+package-lock.json
+yarn.lock
+
+# project files
+src
+__tests__
+.rpt2_cache
+CHANGELOG.md
+.editorconfig
+.eslintcache
+.eslintignore
+.eslintrc.js
+.gitignore
+.travis.yml
+rollup.config.js
+tsconfig.json
+

.travis.yml

@@ -1,3 +1,7 @@
 language: node_js
+cache:
+  yarn: true
+  directories:
+    - node_modules
 node_js:
-  - "6.3.0"
+  - "10.15.3"

CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## `3.0.0`
+New features 🎩:
+  - Reimplemented `mustFind` and `mustGet` methods in Collection.
+  - Brought back the `request` attribute in Model. The attribute tracks the last issued request.
+  - Brought back `onProgress` hook in `save` method.
+
+Solved bugs 🐛:
+  - Fix https://github.com/masylum/mobx-rest/issues/47
+  - Fix https://github.com/masylum/mobx-rest/issues/41
+
+What's changed 💅:
+  - Migrated to Typescript
+  - Made RPC label optional with a default `fetching` value
+
+Breaking changes ☢️:
+  - Migrated to Mobx 5+
+  - Rollback default `keepChanges` flag value to `false`.
+
+## `3.0.0.alpha`
+
+:sparkles:
+
+Full description here: https://github.com/masylum/mobx-rest/pull/39
+Kudos to @rdiazv
+
 ## `2.2.5`
 
 :nail_care:

README.md

@@ -84,6 +84,10 @@ class User extends Model {
 }
 ```
 
+#### `defaultAttributes: Object`
+
+An object literal that holds the default attributes of the model. {} by default.
+
 #### `attributes: ObservableMap`
 
 An `ObservableMap` that holds the attributes of the model.
@@ -134,6 +138,71 @@ request with the given label.
 
 Example: `file.isRequest('saving')`
 
+#### changedAttributes: Array<string>
+
+Get an array with the attributes names that have changed.
+
+Example:
+```js
+model.set({ name: 'Pau'})
+
+model.changedAttributes // => ['name']
+```
+
+#### changes: { [string]: any }
+
+Gets the current changes.
+
+Example:
+```js
+model.set({ name: 'Pau'})
+
+model.changes // => { name: 'Pau' }
+```
+
+#### hasChanges(attribute?: string): boolean
+
+If an attribute is specified, returns true if it has changes.
+If no attribute is specified, returns true if any attribute has changes.
+
+Example:
+```js
+model.set({ name: 'Pau'})
+
+// with attribute
+model.hasChanges('name') // => true
+
+// without attribute
+model.hasChanges() // => true
+```
+
+#### commitChanges(): void
+
+Commit attributes to model.
+
+Example:
+```js
+model.set({ name: 'Pau' })
+model.hasChanges // => true
+
+model.commitChanges()
+model.hasChanges // => false
+```
+
+#### discardChanges(): void
+
+This will reset the model attributes to the last committed ones.
+
+Example:
+```js
+const model = new Model({ name: 'Foo' })
+model.set({ name: 'Pau' })
+model.get('name') // => Pau
+
+model.discardChanges()
+model.get('name') // => 'Foo'
+```
+
 #### `isNew: boolean`
 
 Return whether that model has been synchronized with the server or not.
@@ -234,7 +303,7 @@ Options:
   - `optimistic = true` Whether we want to delete the resource in the client
   first or wait for the server's response.
 
-#### `rpc(method: 'string', body: {}): Promise`
+#### `rpc(method: 'string', body?: {},  label?: 'fetching'): Promise`
 
 When dealing with REST there are always cases when we have some actions beyond
 the conventions. Those are represented as `rpc` calls and are not opinionated.
@@ -301,7 +370,7 @@ Example:
 filesCollection.isRequest('saving')
 ```
 
-#### `isEmpty(): boolean`
+#### `isEmpty: boolean`
 
 Helper method that asks the collection whether there is any
 model in it.
@@ -320,11 +389,15 @@ usersCollection.models.length // => 10
 
 Find a model at the given position.
 
-#### `get(id: number): ?Model`
+#### `get(id: number, { required?: boolean = false }): ?Model`
+
+Find a model (or not) with the given id. If `required` it will raise an error if not found.
 
-Find a model (or not) with the given id.
+#### `mustGet(id: number): Model`
 
-#### `filter(query: Object): Array<Model>`
+Find a model with the given id or raise an Error.
+
+#### `filter(query: Object | Function): Array<Model>`
 
 Helper method that filters the collection by the given conditions represented
 as a key value.
@@ -336,35 +409,48 @@ const resolvedTasks = tasksCollection.filter({ resolved: true })
 resolvedTasks.length // => 3
 ```
 
-#### `find(query: Object): ?Model`
+#### `find(query: Object, { required?: boolean = false }): ?Model`
 
 Same as `filter` but it will halt and return when the first model matches
-the conditions.
+the conditions. If `required` it will raise an error if not found.
 
 Example:
 
 ```js
 const pau = usersCollection.find({ name: 'pau' })
 pau.get('name') // => 'pau'
+
+usersCollection.find({ name: 'foo'}) // => Error(`Invariant: Model must be found`)
+```
+
+#### `mustFind(query: Object): Model`
+
+Same as `find` but it will raise an Error if the model is not found.
+
+Example:
+
+```js
+const pau = usersCollection.mustFind({ name: 'pau' })
+pau.get('name') // => 'pau'
 ```
 
-#### `add(data: Array<Object>): Array<Model>`
+#### `add(data: Array<Object|T>|T|Object): Array<Model>`
 
 Adds models with the given array of attributes.
 
 ```js
 usersCollection.add([{id: 1, name: 'foo'}])
 ```
 
-#### `reset(data: Array<Object>): Array<Model>`
+#### `reset(data: Array<Object|T>): Array<Model>`
 
 Resets the collection with the given models.
 
 ```js
 usersCollection.reset([{id: 1, name: 'foo'}])
 ```
 
-#### `remove(ids: Array<number>): void`
+#### `remove(ids: Array<number|T>|number|T): void`
 
 Remove any model with the given ids.
 
@@ -399,7 +485,7 @@ companiesCollection.get(2).get('name') // => 'Factorial'
 companiesCollection.get(3) // => null
 ```
 
-#### `build(attributes: Object): Model`
+#### `build(attributes: Object|T): Model`
 
 Instantiates and links a model to the current collection.
 
@@ -444,6 +530,26 @@ tasksCollection.isEmpty() // => false
 
 Exactly the same as the model one, but at the collection level.
 
+### forEach (callback: (model: T) => void): void
+
+Alias for models.forEach
+
+Example: `collection.forEach(model => console.log(model.get('id')))`
+
+### map<P> (callback: (model: T) => P): Array<P>
+
+Alias for models.map
+
+Example: `collection.map(model => model.get('id')) // => [1,2,3...]`
+
+### peek (): Array<T: Model>
+
+Returns a shallow array representation of the collection
+
+### slice (): Array<T: Model>
+
+Returns a defensive shallow array representation of the collection
+
 ### `apiClient`
 
 This is the object that is going to make the `xhr` requests to interact with your API.