Parameterize auth mixin.

docs/api.md

@@ -44,6 +44,8 @@ associated metadata and schemata.</p>
 <dd><p>The methods for transmitting farmOS data structures, such as assets, logs,
 etc, to a farmOS server.</p>
 </dd>
+<dt><a href="#AuthorizationMixin">AuthorizationMixin</a> ⇒ <code>Object</code></dt>
+<dd></dd>
 <dt><a href="#FarmClient">FarmClient</a> : <code>Object</code></dt>
 <dd><p>A collection of functions for transmitting farmOS data structures to and
 from a farmOS Drupal 9 server using JSON:API.</p>
@@ -257,6 +259,22 @@ etc, to a farmOS server.
 | send | <code>sendEntity</code> | 
 | delete | <code>deleteEntity</code> | 
 
+<a name="AuthorizationMixin"></a>
+
+## AuthorizationMixin ⇒ <code>Object</code>
+**Kind**: global typedef  
+
+| Param | Type |
+| --- | --- |
+| request | <code>module:axios~AxiosInstance</code> | 
+| authOptions | <code>Object</code> | 
+
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| authOptions.host | <code>String</code> | 
+
 <a name="FarmClient"></a>
 
 ## FarmClient : <code>Object</code>
@@ -297,6 +315,7 @@ Create a farm client for interacting with farmOS servers.
 
 | Name | Type |
 | --- | --- |
+| options.auth | [<code>AuthorizationMixin</code>](#AuthorizationMixin) | 
 | options.clientId | <code>String</code> | 
 | options.getToken | <code>function</code> | 
 | options.setToken | <code>function</code> | 

src/client/index.js

@@ -14,12 +14,20 @@ import fetchSchema from './schema.js';
  * @property {import('./delete.js').deleteEntity} delete
  */
 
+/**
+ * @typedef {Function} AuthMixin
+ * @param {import('axios').AxiosInstance} request
+ * @param {Object} authOptions
+ * @property {String} authOptions.host
+ * @returns {Object<string,function>}
+ */
+
 /** A collection of functions for transmitting farmOS data structures to and
  * from a farmOS Drupal 9 server using JSON:API.
  * @typedef {Object} FarmClient
- * @property {Function} authorize
- * @property {Function} getToken
  * @property {import('axios').AxiosInstance} request
+ * @property {Function} [authorize]
+ * @property {Function} [getToken]
  * @property {Function} info
  * @property {Object} schema
  * @property {Function} schema.fetch
@@ -35,17 +43,17 @@ import fetchSchema from './schema.js';
  * Create a farm client for interacting with farmOS servers.
  * @typedef {Function} client
  * @param {String} host
- * @param {Object} options
- * @property {String} options.clientId
- * @property {Function} options.getToken
- * @property {Function} options.setToken
+ * @param {Object} [options]
+ * @property {AuthMixin=OAuthMixin} [options.auth=oauth]
+ * @property {String} [options.clientId]
+ * @property {Function} [options.getToken]
+ * @property {Function} [options.setToken]
  * @returns {FarmClient}
  */
 export default function client(host, options) {
   const {
-    clientId,
-    getToken,
-    setToken,
+    auth = oauth,
+    ...authOptions
   } = options;
 
   // Instantiate axios client.
@@ -58,18 +66,10 @@ export default function client(host, options) {
   };
   const request = axios.create(clientOptions);
 
-  // Create oAuth & request helpers.
-  const oAuthOpts = {
-    host,
-    clientId,
-    getToken,
-    setToken,
-  };
-  const { authorize } = oauth(request, oAuthOpts);
+  const authMethods = auth(request, { ...authOptions }) || {};
 
   const farm = {
-    authorize,
-    getToken,
+    ...authMethods,
     request,
     info() {
       return request('/api');

src/client/oauth.js

@@ -1,13 +1,29 @@
 import axios from 'axios';
 
-export default function oAuth(request, opts) {
+/**
+ * @typedef {Object} OAuthMethods
+ * @property {Function} authorize
+ * @property {Function} getToken
+ */
+
+/**
+ * @typedef {Function} OAuthMixin
+ * @param {import('axios').AxiosInstance} request
+ * @param {Object} authOptions
+ * @property {String} authOptions.host
+ * @property {String} authOptions.clientId
+ * @property {Function} [authOptions.getToken]
+ * @property {Function} [authOptions.setToken]
+ * @returns {Object}
+ */
+export default function oAuth(request, authOptions) {
   let memToken = {};
   const {
     host = '',
     clientId = '',
     getToken = () => memToken,
     setToken = (t) => { memToken = t; },
-  } = opts;
+  } = authOptions;
   const accessTokenUri = `${host}/oauth/token`;
 
   /*
@@ -148,7 +164,7 @@ export default function oAuth(request, opts) {
         Accept: 'json',
       },
       data: `grant_type=password&username=${user}&password=${password}&client_id=${clientId}`,
-    }).then(res => parseToken(res.data))
-      .catch((error) => { throw error; }),
+    }).then(res => parseToken(res.data)).catch((error) => { throw error; }),
+    getToken,
   };
 }

src/index.js

@@ -28,11 +28,11 @@ export { default as model } from './model/index.js';
  * @property {Function} [schema.fetch]
  * @property {Object} meta
  * @property {Function} meta.isUnsynced
- * @property {Object} [remote]
+ * @property {Object} remote
  * @property {import('axios').AxiosInstance} remote.request
- * @property {Function} remote.info
- * @property {Function} remote.authorize
- * @property {Function} remote.getToken
+ * @property {Function} [remote.info]
+ * @property {Function} [remote.authorize]
+ * @property {Function} [remote.getToken]
  * @property {FarmEntityMethods} asset
  * @property {FarmEntityMethods} log
  * @property {FarmEntityMethods} plan
@@ -46,7 +46,7 @@ export { default as model } from './model/index.js';
  * @param {Object} farmConfig
  * @property {import('./model/index.js').EntitySchemata} [config.schemata]
  * @property {Object} [config.remote]
- * @property {import('./client/index.js').FarmClient} [config.remote.adapter]
+ * @property {import('./client/index.js').client} [config.remote.adapter=d9JsonApiAdapter]
  * @property {Array<import('./entities.js').EntityConfig>} [config.entities]
  * @returns {FarmObject}
  */