feat(model): add support to configuration at query builder (#142)

Add a new method `config` to `Model.js`. It can be used to override the http instance (e.g. axios) configuration at query builder.
It can be used to change the method of update request to `PATCH`, to add additional data to the request, to add headers, and so on.

Author: JoaoPedroAS51

docs/content/en/api/crud-operations.md

@@ -65,6 +65,37 @@ Save or update a model in the database, then return the instance.
   </code-block>
 </code-group>
 
+## `patch`
+- Returns: `Model | { data: Model }`
+
+Make a `PATCH` request to update a model in the database, then return the instance.
+
+<code-group>
+  <code-block Label="Query" active>
+
+  ```js
+  const model = await Model.find(1)
+  
+  model.foo = 'bar'
+  
+  model.patch()
+  ```
+
+  </code-block>
+  <code-block Label="Request">
+
+  ```http request
+  PATCH /resource/1
+  ```
+
+  </code-block>
+</code-group>
+
+Alias for:
+```js
+model.config({ method: 'PATCH' }).save()
+```
+
 
 ## `delete`
 

docs/content/en/api/query-builder-methods.md

@@ -180,6 +180,22 @@ Build custom endpoints.
   </code-block>
 </code-group>
 
+## `config`
+<alert type="success">Available in version >= v1.8.0</alert>
+
+- Arguments: `(config)`
+- Returns: `self`
+
+Configuration of HTTP Instance.
+
+```js
+await Model.config({
+  method: 'PATCH',
+  header: { /* ... */ },
+  data: { foo: 'bar' }
+}).save()
+```
+
 ## `get`
 - Returns: `Collection | { data: Collection }`
 

docs/content/en/building-the-query.md

@@ -614,6 +614,21 @@ We can build a resource to get the latest `Posts` that belongs to a **User**:
   </code-block>
 </code-group>
 
+## Configuring the Request
+
+<alert type="success">Available in version >= v1.8.0</alert>
+
+See the [API reference](/api/query-builder-methods#config)
+
+The `config` method can be used to configure the current request at query builder. We can pass any config available 
+from the HTTP Instance. If we are using [Axios](https://github.com/axios/axios), 
+we should pass an [AxiosRequestConfig](https://github.com/axios/axios#request-config).
+
+We can add headers, change the method, anything we want:
+
+```js
+await Post.config({ headers: { /*...*/ } }).get()
+```
 
 ## Needless Parent Request
 
@@ -640,8 +655,10 @@ We can get a list of **Posts** that belongs to an **User**:
   </code-block>
 </code-group>
 
-And the same thing using for the example above, if we want to define a dynamic resource, 
-we can create a new **User** instance with the ID:
+And the same thing can be done if we want to define a 
+[dynamic resource](/building-the-query#defining-a-dynamic-resource).
+
+We can create a new **User** instance with the ID:
 
 <code-group>
   <code-block label="Query" active>

docs/content/en/performing-operations.md

@@ -91,6 +91,38 @@ Then we can update our newly created **Post**:
   </code-block>
 </code-group>
 
+And if we want to use `PATCH`, we can easily do that using [patch](/api/crud-operations#patch).
+
+<code-group>
+  <code-block Label="Query" active>
+
+  ```js
+  const post = await Post.find(1)
+  
+  post.text = 'An updated text for our Post!'
+  
+  await post.patch()
+  ```
+
+  </code-block>
+  <code-block Label="Find Request">
+
+  ```http request
+  GET /posts/1
+  ```
+
+  </code-block>
+  <code-block Label="Save Request">
+
+  ```http request
+  PATCH /posts/1
+  ```
+
+  </code-block>
+</code-group>
+
+<alert type="info">You can safely use `PATCH` with `save()`. The `POST` method will not be overridden, only `PUT`.</alert>
+
 ### Deleting a Model
 
 See the [API reference](/api/crud-operations#delete).

docs/static/sw.js

@@ -1,91 +1,17 @@
-const options = {"workboxURL":"https://cdn.jsdelivr.net/npm/[email protected]/workbox/workbox-sw.js","importScripts":[],"config":{"debug":false},"clientsClaim":true,"skipWaiting":true,"cleanupOutdatedCaches":true,"offlineAnalytics":false,"preCaching":["/vue-api-query/?standalone=true"],"runtimeCaching":[{"urlPattern":"/vue-api-query/_nuxt/","handler":"CacheFirst","method":"GET","strategyPlugins":[]},{"urlPattern":"/vue-api-query/","handler":"NetworkFirst","method":"GET","strategyPlugins":[]}],"offlinePage":null,"pagesURLPattern":"/vue-api-query/","offlineStrategy":"NetworkFirst"}
+// THIS FILE SHOULD NOT BE VERSION CONTROLLED
 
-importScripts(...[options.workboxURL, ...options.importScripts])
+// https://github.com/NekR/self-destroying-sw
 
-initWorkbox(workbox, options)
-workboxExtensions(workbox, options)
-precacheAssets(workbox, options)
-cachingExtensions(workbox, options)
-runtimeCaching(workbox, options)
-offlinePage(workbox, options)
-routingExtensions(workbox, options)
+self.addEventListener('install', function (e) {
+  self.skipWaiting()
+})
 
-function getProp(obj, prop) {
-  return prop.split('.').reduce((p, c) => p[c], obj)
-}
-
-function initWorkbox(workbox, options) {
-  if (options.config) {
-    // Set workbox config
-    workbox.setConfig(options.config)
-  }
-
-  if (options.cacheNames) {
-    // Set workbox cache names
-    workbox.core.setCacheNameDetails(options.cacheNames)
-  }
-
-  if (options.clientsClaim) {
-    // Start controlling any existing clients as soon as it activates
-    workbox.core.clientsClaim()
-  }
-
-  if (options.skipWaiting) {
-    workbox.core.skipWaiting()
-  }
-
-  if (options.cleanupOutdatedCaches) {
-    workbox.precaching.cleanupOutdatedCaches()
-  }
-
-  if (options.offlineAnalytics) {
-    // Enable offline Google Analytics tracking
-    workbox.googleAnalytics.initialize()
-  }
-}
-
-function precacheAssets(workbox, options) {
-  if (options.preCaching.length) {
-    workbox.precaching.precacheAndRoute(options.preCaching, options.cacheOptions)
-  }
-}
-
-function runtimeCaching(workbox, options) {
-  for (const entry of options.runtimeCaching) {
-    const urlPattern = new RegExp(entry.urlPattern)
-    const method = entry.method || 'GET'
-
-    const plugins = (entry.strategyPlugins || [])
-      .map(p => new (getProp(workbox, p.use))(...p.config))
-
-    const strategyOptions = { ...entry.strategyOptions, plugins }
-
-    const strategy = new workbox.strategies[entry.handler](strategyOptions)
-
-    workbox.routing.registerRoute(urlPattern, strategy, method)
-  }
-}
-
-function offlinePage(workbox, options) {
-  if (options.offlinePage) {
-    // Register router handler for offlinePage
-    workbox.routing.registerRoute(new RegExp(options.pagesURLPattern), ({ request, event }) => {
-      const strategy = new workbox.strategies[options.offlineStrategy]
-      return strategy
-        .handle({ request, event })
-        .catch(() => caches.match(options.offlinePage))
+self.addEventListener('activate', function (e) {
+  self.registration.unregister()
+    .then(function () {
+      return self.clients.matchAll()
     })
-  }
-}
-
-function workboxExtensions(workbox, options) {
-  
-}
-
-function cachingExtensions(workbox, options) {
-  
-}
-
-function routingExtensions(workbox, options) {
-  
-}
+    .then(function (clients) {
+      clients.forEach(client => client.navigate(client.url))
+    })
+})