@docbrasil/api-systemmanager 1.0.62 → 1.0.63

package/doc/api.md

@@ -37,21 +37,12 @@
 <dt><a href="#AdminUser">AdminUser</a></dt>
 <dd><p>Admin Class for user, permission admin</p>
 </dd>
-<dt><a href="#Dispatch">Dispatch</a></dt>
-<dd><p>Api dispatch manager</p>
-</dd>
 <dt><a href="#GeoLocation">GeoLocation</a></dt>
 <dd><p>General Class for user, permission organization</p>
 </dd>
 <dt><a href="#Users">Users</a></dt>
 <dd><p>API request, user permission level</p>
 </dd>
-<dt><a href="#Login">Login</a></dt>
-<dd><p>Login manager</p>
-</dd>
-<dt><a href="#Session">Session</a></dt>
-<dd><p>Session manager of the API</p>
-</dd>
 <dt><a href="#Documents">Documents</a></dt>
 <dd><p>Class for documents, permission user</p>
 </dd>
@@ -1130,52 +1121,6 @@ const payload = {
 };
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 ```
-<a name="Dispatch"></a>
-
-## Dispatch
-Api dispatch manager
-
-**Kind**: global class  
-
-* [Dispatch](#Dispatch)
-    * [.getContext(url, session)](#Dispatch+getContext) ⇒ <code>Promise.&lt;object&gt;</code>
-    * [.getClient()](#Dispatch+getClient) ⇒ <code>promise</code>
-
-<a name="Dispatch+getContext"></a>
-
-### dispatch.getContext(url, session) ⇒ <code>Promise.&lt;object&gt;</code>
-Get the URL context
-
-**Kind**: instance method of [<code>Dispatch</code>](#Dispatch)  
-**Returns**: <code>Promise.&lt;object&gt;</code> - The full data context of the URL  
-**Access**: public  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| url | <code>string</code> |  | Full url |
-| session | <code>session</code> | <code></code> | Session, token JWT |
-
-**Example**  
-```js
-const API = require('@docbrasil/api-systemmanager');
-const api = new API();
-const retContext = await api.dispatch.getContext('http://myndware.io/login/myorg);
-```
-<a name="Dispatch+getClient"></a>
-
-### dispatch.getClient() ⇒ <code>promise</code>
-Get client Axios
-
-**Kind**: instance method of [<code>Dispatch</code>](#Dispatch)  
-**Returns**: <code>promise</code> - return client axios  
-**Access**: public  
-**Author**: CloudBrasil <abernardo.br@gmail.com>  
-**Example**  
-```js
-const API = require('@docbrasil/api-systemmanager');
-const api = new API();
-await api.dispatch.getClient();
-```
 <a name="GeoLocation"></a>
 
 ## GeoLocation
@@ -1237,203 +1182,6 @@ API request, user permission level
 | options | <code>object</code> | Params of the constructor |
 | options.parent | <code>object</code> | This of the pararent |
 
-<a name="Login"></a>
-
-## Login
-Login manager
-
-**Kind**: global class  
-
-* [Login](#Login)
-    * [.facebook(params)](#Login+facebook) ⇒ <code>promise.&lt;object&gt;</code> \| <code>object</code> \| <code>object</code>
-    * [.google(params)](#Login+google) ⇒ <code>promise.&lt;object&gt;</code> \| <code>object</code> \| <code>object</code>
-    * [.apiKey(apikey)](#Login+apiKey) ⇒ <code>promise.&lt;object&gt;</code> \| <code>object</code> \| <code>object</code>
-    * [.userPass(params)](#Login+userPass) ⇒ <code>promise.&lt;object&gt;</code> \| <code>object</code> \| <code>object</code>
-    * [.logout(session)](#Login+logout) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code>
-    * [.recover(username)](#Login+recover) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code>
-
-<a name="Login+facebook"></a>
-
-### login.facebook(params) ⇒ <code>promise.&lt;object&gt;</code> \| <code>object</code> \| <code>object</code>
-Login with social login Facebook
-
-**Kind**: instance method of [<code>Login</code>](#Login)  
-**Returns**: <code>promise.&lt;object&gt;</code> - data<code>object</code> - data.auth true or false if we have the user authenticaited correctly<code>object</code> - data.user the logged user  
-**Access**: public  
-**Author**: CloudBrasil <abernardo.br@gmail.com>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| params | <code>object</code> | Params to login Facebook |
-| params.accessToken | <code>string</code> | Access token of the system manager |
-| params.initialUserData | <code>object</code> | Object with roles default if sigin |
-| params.initialUserData.externalRoles | <code>array</code> | Array with permission of user |
-
-**Example**  
-```js
-const API = require('@docbrasil/api-systemmanager');
-
-// Params of the instance
-const params = {...}
-const api = new API(params);
-const params = { accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cC...' };
-const { auth, user } = await api.login.facebook(params);
-```
-<a name="Login+google"></a>
-
-### login.google(params) ⇒ <code>promise.&lt;object&gt;</code> \| <code>object</code> \| <code>object</code>
-Login with social login Google
-
-**Kind**: instance method of [<code>Login</code>](#Login)  
-**Returns**: <code>promise.&lt;object&gt;</code> - data<code>object</code> - data.auth true or false if we have the user authenticaited correctly<code>object</code> - data.user the logged user  
-**Access**: public  
-**Author**: CloudBrasil <abernardo.br@gmail.com>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| params | <code>object</code> | Params to login Google |
-| params.accessToken | <code>string</code> | Access token of the system manager |
-| params.initialUserData | <code>object</code> | Object with roles default if sigin |
-| params.initialUserData.externalRoles | <code>array</code> | Array with permission of user |
-
-**Example**  
-```js
-const API = require('@docbrasil/api-systemmanager');
-
-// Params of the instance
-const params = {...}
-const api = new API(params);
-const accessToken = 'eyJhbGciOiJIUzI1NiIsInR5cC...';
-const { auth, user } = await api.login.google(accessToken);
-```
-<a name="Login+apiKey"></a>
-
-### login.apiKey(apikey) ⇒ <code>promise.&lt;object&gt;</code> \| <code>object</code> \| <code>object</code>
-Login with apikey
-
-**Kind**: instance method of [<code>Login</code>](#Login)  
-**Returns**: <code>promise.&lt;object&gt;</code> - data<code>object</code> - data.auth true or false if we have the user authenticaited correctly<code>object</code> - data.user the logged user  
-**Access**: public  
-**Author**: CloudBrasil <abernardo.br@gmail.com>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| apikey | <code>string</code> | Access key |
-
-**Example**  
-```js
-const API = require('@docbrasil/api-systemmanager');
-
-// Params of the instance
-const params = {...}
-const api = new API(params);
-const apiKey = '043a0eb2-f5c3-4900-b781-7f229d00d092';
-const { auth, user } = await api.login.apiKey(apiKey);
-```
-<a name="Login+userPass"></a>
-
-### login.userPass(params) ⇒ <code>promise.&lt;object&gt;</code> \| <code>object</code> \| <code>object</code>
-Login with user and password
-
-**Kind**: instance method of [<code>Login</code>](#Login)  
-**Returns**: <code>promise.&lt;object&gt;</code> - data<code>object</code> - data.auth true or false if we have the user authenticaited correctly<code>object</code> - data.user the logged user  
-**Access**: public  
-**Author**: CloudBrasil <abernardo.br@gmail.com>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| params | <code>object</code> | Object with user and password |
-| params.username | <code>string</code> | Username or email of the user |
-| params.password | <code>string</code> | Password of the user |
-| params.orgname | <code>string</code> | The organame of the user |
-
-**Example**  
-```js
-const API = require('@docbrasil/api-systemmanager');
-
-// Params of the instance
-const params = {...}
-const api = new API(params);
-const params = {
-  username: 'ana.silva@gmail.com',
-  password: '123456'
-};
-const { auth, user } = await api.login.userPass(params);
-```
-<a name="Login+logout"></a>
-
-### login.logout(session) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code>
-Logout user system manager
-
-**Kind**: instance method of [<code>Login</code>](#Login)  
-**Returns**: <code>promise.&lt;object&gt;</code> - } data<code>boolean</code> - data.success true|false  
-**Access**: public  
-**Author**: CloudBrasil <abernardo.br@gmail.com>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| session | <code>string</code> | Session, token JWT |
-
-**Example**  
-```js
-const API = require('@docbrasil/api-systemmanager');
-
-// Params of the instance
-const params = {...}
-const api = new API(params);
-const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
-const { success } = await api.login.logout(session);
-```
-<a name="Login+recover"></a>
-
-### login.recover(username) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code>
-Recover the password
-
-**Kind**: instance method of [<code>Login</code>](#Login)  
-**Returns**: <code>promise.&lt;object&gt;</code> - } data<code>boolean</code> - data.success true|false  
-**Access**: public  
-**Author**: CloudBrasil <abernardo.br@gmail.com>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| username | <code>string</code> | The username or email |
-
-**Example**  
-```js
-const API = require('@docbrasil/api-systemmanager');
-
-// Params of the instance
-const params = {...}
-const api = new API(params);
-const { success } = await api.login.recover('myusername');
-```
-<a name="Session"></a>
-
-## Session
-Session manager of the API
-
-**Kind**: global class  
-<a name="Session+information"></a>
-
-### session.information(sessionId, suSessionId) ⇒ <code>Promise</code>
-Show information for session, thus validating the session (Valid token JWT)
-
-**Kind**: instance method of [<code>Session</code>](#Session)  
-**Access**: public  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| sessionId | <code>string</code> |  | The user session (JWT Token) |
-| suSessionId | <code>string</code> | <code>&quot;sessionId&quot;</code> | Given a JWT Token of a SU (SuperAdmin), allow to check session for another user. |
-
-**Example**  
-```js
-const API = require('@docbrasil/api-systemmanager');
-const api = new API();
-const sessionId = 'eyJhbFVBBiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
-const suSessionId = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
-await api.session.information(sessionId, suSessionId);
-```
 <a name="Documents"></a>
 
 ## Documents
@@ -2195,6 +1943,8 @@ Class for user, permission user
 * [User](#User)
     * [.updateAvatar(params, session)](#User+updateAvatar) ⇒ <code>Promise</code>
     * [.removeAvatar(session)](#User+removeAvatar) ⇒ <code>Promise</code>
+    * [.removeSignature(session)](#User+removeSignature) ⇒ <code>Promise</code>
+    * [.saveSignature(data, session)](#User+saveSignature) ⇒ <code>Promise</code>
     * [.findByIdAndUpdate(params, session)](#User+findByIdAndUpdate) ⇒ <code>Promise.&lt;void&gt;</code>
 
 <a name="User+updateAvatar"></a>
@@ -2244,6 +1994,62 @@ const api = new API();
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 await api.user.profile.removeAvatar(session);
 ```
+<a name="User+removeSignature"></a>
+
+### user.removeSignature(session) ⇒ <code>Promise</code>
+Remove the signature of user by session
+
+**Kind**: instance method of [<code>User</code>](#User)  
+**Access**: public  
+**Author**: CloudBrasil <abernardo.br@gmail.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| session | <code>string</code> | Is token JWT of user NOT allow SU |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.profile.removeSignature(session);
+```
+<a name="User+saveSignature"></a>
+
+### user.saveSignature(data, session) ⇒ <code>Promise</code>
+Sava a new signature of user by session
+
+**Kind**: instance method of [<code>User</code>](#User)  
+**Access**: public  
+**Author**: CloudBrasil <abernardo.br@gmail.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| data | <code>object</code> | The signature data to save |
+| data.type | <code>string</code> | CURSIVE or HANDWRITE |
+| data.file | <code>string</code> | CURSIVE the <fontname>:<name used on the signature>                      HANDWRITE the base 64 image (w/o the mime a base prefix) |
+| session | <code>string</code> | Is token JWT of user NOT allow SU |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const data = {
+   type: 'CURSIVE',
+   file: 'allura:Mary John Heart'
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.profile.saveSignature(data, session);
+
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const data = {
+   type: 'HANDWRITE',
+   file: 'iVBORw0KGgoAAAANSUhEUgAAAj...'
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.profile.saveSignature(session);
+```
 <a name="User+findByIdAndUpdate"></a>
 
 ### user.findByIdAndUpdate(params, session) ⇒ <code>Promise.&lt;void&gt;</code>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docbrasil/api-systemmanager",
   "description": "Module API System Manager",
-  "version": "1.0.62",
+  "version": "1.0.63",
   "scripts": {
     "doc": "rm -f  doc/api.md && jsdoc2md api/**/** > doc/api.md",
     "build": "node bundleRollup.js"