@gudhub/core 1.1.13 → 1.1.16

package/Readme.md

@@ -1,48 +1,50 @@
 # GUDHUB
 
-I't a Library to simplify work with GudHub API. Also this Library cantains utilites for beter aperation with `items`, `fields` and `apps`!
+I't a Library to simplify work with GudHub API. Also this Library contains utilities for better operation with `items`, `fields` and `apps`!
 
-# npm Package
+## npm Package
 
-The package name is `@gudhub/gudhub` It a privet package, that is why `.npmrc` file should be in a root folder to download it from **npm**. It means that If you have `@gudhub/gudhub` in package.json for `GudHubClient` the `.npmrc` file should be in the root folder too. 
+The package name is `@gudhub/core`. This is a private package, so the `.npmrc` file must be in the root folder in order to load it from **npm**. This means that if you have `@gudhub/core` in package.json for `GudHubClient`, the `.npmrc` file should be in the root folder too.
 
-## Publishing gudhub lib to npm 
+## Publishing gudhub lib to npm
 
 In order to publish new version of the GudHub Lib you have to:
 
-1. Change vertsion in `package.json`
-1. Commit your chagnes into repository to the `master` branch
+1. Change version in `package.json`
+1. Commit your changes into repository to the `master` branch
 1. Run `npm publish` command which will publish new version to **npm**
 
-## Development gudhub lib
+### Development gudhub lib
 
-If you'd like to develop **GudHub Lib** in another enviroment, let's say in **GudHubClient** you have to do the falowing things:
+If you want to develop the **GudHub Lib** in another environment, say in **GudHubClient**, you need to do the following:
 
-1. You should go to the `gudhub` folder and run there `npm init @gudhub/gudhub` command, it will install the *@gudhub/gudhub* package in to your global enviroment
-1. Then you have to add `@gudhub/gudhub` to your `package.json` as a dependency.
+1. You should go to the `gudhub` folder and run there `npm init @gudhub/core` command, it will install the *@gudhub/core* package in to your global environment
+1. Then you have to add `@gudhub/core` to your `package.json` as a dependency.
 1. Then package will be downloaded from your local computer after you run `npm run dev` or `npm install` command
 
-# Initialization
+## Initialization
 
-There are several ways to initialize GudHub. The most simple way is initializing gudhub without arguments. It this way will be available utils only
+There are several ways to initialize GudHub. The most simple way is initializing gudhub without arguments. In this case only the utils will be available.
 
 ```js
-import {GudHub} from '@gudhub/gudhub';
+import {GudHub} from '@gudhub/core';
 const gudhub = new GudHub();
 ```
 
-The second way is initialization GudHub with autorization key. It's the most comon way for using GudHub in your project. You just need to pass `auth_key` as argument.
-In this case you will be able to operate with GudHub data and use all mothods those are listed here. 
+The second way is initialization GudHub with authorization key. It's the most common way for using GudHub in your project. You just need to pass `auth_key` as argument.
+In this case you will be able to work with GudHub data and use all the methods listed below.
 
 ```js
-import {GudHub} from '@gudhub/gudhub';
+import {GudHub} from '@gudhub/core';
+const auth_key = 'JLKHKJSKJhkjsclkdjcijIOIoiuSTg';
 const gudhub = new GudHub(auth_key);
 ```
 
-The third way is initialisation GudHub with aditionals parameters. It's usefull for development server app on Node.js and for testin on local server.At the exampe belw you can see how to initialize GudHub ( in the example you can see default params )
+The third way is initialization GudHub with additional parameters. It's useful for development server app on Node.js and for testing on local server. In the example below you can see how to initialize GudHub (in the example you can see default params).
 
 ```js
-import {GudHub} from '@gudhub/gudhub';
+import {GudHub} from '@gudhub/core';
+const auth_key = 'JLKHKJSKJhkjsclkdjcijIOIoiuSTg';
 const gudhub = new GudHub(auth_key,{
     server_url : "https://gudhub.com/GudHub", 
     wss_url : "wss://gudhub.com/GudHub/ws/app/", 
@@ -52,484 +54,464 @@ const gudhub = new GudHub(auth_key,{
 
 Param Name|Description|Default Value
 ------------ | ------------- | -------------
-*server_url* |All request will send to this url |https://gudhub.com/GudHub
-*wss_url*   | url to setup websoket connection |wss://gudhub.com/GudHub/ws/app/
-*initWebsocket*  |here we can turn off websoket connection|false
+*server_url*|All request will send to this url |https://gudhub.com/GudHub
+*wss_url*|url to setup websoket connection |wss://gudhub.com/GudHub/ws/app/
+*initWebsocket*|here we can turn off websoket connection|false
 
-# Utils:
+## Utils
 
-## jsonConstructor(scheme, items)
+### jsonConstructor()
 
 With this method you can get json according to the scheme.
 
 ```js
-import {GudHub} from '@gudhub/gudhub';
-const gudhub = new GudHub();
-gudhub.jsonConstructor(scheme);
-```
-
-**Sheme Example:**
-
-```json
-{
-  "type": "array",
-  "id": 1,
-  "childs": [
-    {
-      "type": "property",
-      "id": 3,
-      "property_name": "name",
-      "property_type": "field_value",
-      "field_id": "254056"
-    },
-    {
-      "type": "property",
-      "id": 4,
-      "property_name": "state",
-      "property_type": "field_value",
-      "field_id": "270607"
-    }
-  ],
-  "property_name": "fishtank",
-  "app_id": "16259",
-  "filter": []
-}
-```
-
-## jsonToItems(json, fieldsMap)
-
-This method converts json to gudhub items. the conversion is made based on `fieldMap`. After items generated You can send them to create new items.
-
-```js
-import {GudHub} from '@gudhub/gudhub';
-const gudhub = new GudHub();
+gudhub.jsonConstructor(scheme, item, variables)
+```
+
+Read more information about [jsonConstructor on GudHub](https://gudhub.com/docs/utils/json-constructor/json-constustor-overview/).
+
+### jsonToItems()
+
+This method converts json to gudhub items. The conversion is made based on `fieldMap`. After generating items, you can send them to create new items.
+
+```js
 gudhub.jsonToItems(json, fieldsMap);
 ```
 
-Argument Name|Type|Description
------------- | ------------- | -------------
-*json* | `object` | json that is going to be converted to gudhub items
-*fieldsMap* | `object` | and object in json format which contains instructions of how to convert to items
+Read more information about [jsonConstructor on GudHub](https://gudhub.com/docs/utils/json-to-item/jsontoitem-overview/).
 
-fieldsMap this map is an object array that contains field_id and jsonPath to get data from. We use jsonPath [jsonpath](https://www.npmjs.com/package/jsonpath) to parse json.
+### populateWithItemRef()
 
-```json
-[
-   {
-        field_id: 431,
-        json_path : "$..item_id"
-   }
-]
+This method updates destination items with item_ref of source items. The connection between sorceItemsRef & srcFieldIdToCompare is checked with srcFieldIdToCompare & destFieldIdToCompare. After connection is detected we save the item_ref into destFieldForRef.
+
+```js
+gudhub.populateWithItemRef(sorceItemsRef, srcFieldIdToCompare, destinationItems, destFieldIdToCompare, destFieldForRef, APPID)
 ```
 
-The method returns items list:
+Read more information about [populateWithItemRef on GudHub](https://gudhub.com/docs/utils/populate-with-item-reference/).
 
-```json
-[
-    {
-        fields:[
-            {
-                field_id: 12356,
-                field_value: "test value"
-             }
-        ]
-    },
-    {
-        fields:[
-            {
-                field_id: 12356,
-                field_value: "test value2"
-             }
-        ]
-    }
-]
+### mergeItems()
+
+The current method replaces all fields with values in destinationItems by values from sorceItems. If destinationItems does not have the fields that sorceItems has, they will be created in destinationItems.
+
+```js
+gudhub.mergeItems(sorceItems, destinationItems, mergeByFieldId);
 ```
 
-## populateWithItemRef()
+Read more information about [mergeItems on GudHub](https://gudhub.com/docs/utils/merge-items/).
 
-We update destination Items  with item_ref of  sorce Items. Connectiontion between sorceItemsRef & srcFieldIdToCompare we are checking with help of srcFieldIdToCompare & destFieldIdToCompare. After connection is detected we save the item_ref into destFieldForRef.
+### compareItems()
+
+This method compare fields of sorceItems with fields of destinationItems. This means that if sorceItems has the same fields with the same values as destinationItems, they will be described as 'same_items' even if destinationItems has additional fields that sorceItems does not have.
 
 ```js
-import {GudHub} from '@gudhub/gudhub';
-const gudhub = new GudHub();
-gudhub.populateWithItemRef(sorceItemsRef, srcFieldIdToCompare, destinationItems, destFieldIdToCompare, destFieldForRef, appId);
+gudhub.compareItems(sorceItems, destinationItems, fieldToCompare);
 ```
 
-Argument Name|Type|Description
------------- | ------------- | -------------
-*sorceItemsRef* | `items` | items which will be used as referense for item_ref
-*srcFieldIdToCompare* | `field_id` | we use value from this field to find the similar items in source and destimation items array
-*destinationItems* | `items` | items those will be used to save item_ref to sorceItemsRef 
-*destFieldIdToCompare* | `field_id` | we use value from this field to find the similar items in source and destimation items array
-*destFieldForRef* | `field_id` | field where we save value of item_ref
-*appId* | `app_id` | we use app_id to generate value for item_ref
+Read more information about [compareItems on GudHub](https://gudhub.com/docs/utils/compare-items/).
 
-## mergeItems()
+### getDate()
 
-We replace all fields with values in destinationItems by values from sorceItems. If destinationItems doesn't have fields that sorceItems then we create them in destinationItems.
+This method will return a date according to specified namespace. The name space should be in string format
 
 ```js
-import {GudHub} from '@gudhub/gudhub';
-const gudhub = new GudHub();
-gudhub.mergeItems(sorceItems, destinationItems);
+gudhub.getDate(date_type);
 ```
 
-## compareItems()
+Read more information about [getDate on GudHub](https://gudhub.com/docs/utils/date-utils/#get-date).
+
+### makeNestedList()
 
-We compare fields of sorceItems with fields of destinationItems. It means that if sorceItems have the same fields with the same values as destinationItems thay will be described as 'same_items' even if destinationItems have additional fields those sorceItems doesn't have.
+This method creates the list of fields with infinite nesting. It takes an array of fields and depends of their IDs makes attachments for each of them.
 
 ```js
-import {GudHub} from '@gudhub/gudhub';
-const gudhub = new GudHub();
-gudhub.compareItems (sorceItems, destinationItems, fieldToCompare) ;
+gudhub.makeNestedList(arr, 'id', 'parent_id', 'children_property', 'priority')
 ```
 
-There to ways how it works:
+Read more information about [makeNestedList on GudHub](https://gudhub.com/docs/utils/nested-list/).
+
+## App Processor
 
-1. Compering items by item_id (if fieldToCompare is undefined)
-1. Compering items by value of specific field_id (if fieldToCompare is defined)
+### getAppInfo()
 
-**compareItems() Return:**
+This is the method that returns application with empty arrays: `field_list`, `items_list`, `file_list`, `views_list`. Such simple data needed to render App Icons, and do some simple updates in App like: updating App name icon permissions etc when full app data is not needed
 
-```json
-{
-    is_items_diff: false,
-    new_src_items:[],
-    diff_src_items:[],
-    same_items:[]
-}
+```js
+gudhub.getAppInfo(app_id);
 ```
 
-Argument Name|Type|Description
------------- | ------------- | -------------
-*sorceItems* | `items` | array of items that is going to be used as a sorce for comperison
-*destinationItems* | `items` | array of items that is gong to be compared with sorceItems
-*srcFieldIdToCompare* | `field_id` | field that we use to compare sorce items with destination items, if this is not specified then we compare items by item_id
+Read more information about [getAppInfo on GudHub](https://gudhub.com/docs/core-api/app-processor/#getappinfo).
 
-## getDate()
+### getApp()
 
-This method will return a date accorting to specified namespace. The name space should be in string format
+This method is called to get an application by its ID specified as an argument.
 
 ```js
-import {GudHub} from '@gudhub/gudhub';
-const gudhub = new GudHub();
-gudhub.mergeItems(sorceItems, destinationItems);
+gudhub.getApp(app_id);
 ```
 
-## getDate()
+Read more information about [getApp on GudHub](https://gudhub.com/docs/core-api/app-processor/#getapp).
 
-This method will return a date accorting to specified namespace. The name space should be in string format
+### getAppsList()
+
+This method is called after logging in to get a list of user`s applications. It has no arguments. *getAppList* return list of applications that are shared to users.
 
 ```js
-import {GudHub} from '@gudhub/gudhub';
-const gudhub = new GudHub();
-gudhub.getDate('this_sunday');
+gudhub.getAppsList();
 ```
 
-The following namespaces are available now:
+Read more information about [getApp on GudHub](https://gudhub.com/docs/core-api/app-processor/#getappslist).
 
-Date Namespaces | Description
------------- | -------------
-`now` | will return current date
-`next_day` | should return current day + 24hours
-`next_week` | it adds one week(7 days) to current date
-`two_days_after` | it adds two days(24hours) to current date
-`three_days_after` | it adds three days(24hours) to current date
-`four_days_after` | it adds four days(24hours) to current date
-`two_weeks_after` | it adds two weeks(7 days) to current date
-`three_weeks_after` | it adds three weeks(7 days) to current date
-`this_sunday` | will return date for sunday, with current utc time if it's a monday then it will return sunday from the next week
-`this_monday` | will return date for monday, with current utc time if it's a saturday then it will return monday from the next week
-`this_tuesday` | will return date for tuesday, with current utc time if it's a saturday then it will return tuesday from the next week
-`this_wednesday` | will return date for wednesday, with current utc time if it's a saturday then it will return wednesday from the next week
-`this_thursday` | will return date for thursday, with current utc time if it's a saturday then it will return thursday from the next week
-`this_friday` | will return date for friday, with current utc time if it's a saturday then it will return friday from the next week
-`this_saturday` | will return date for monday, with current utc time if it's a sunday then it will return saturday from the next week
+## Authentication
 
-`prefilter()`
+### login()
 
-`filter()`
+This method is used for getting access to the account. It can be called with login and password or the authentication key with or without additional parameters.
 
-`group()`
+```js
+gudhub.login(data);
+```
+
+Read more information about [login on GudHub](https://gudhub.com/docs/core-api/auth-core-api/#login-with-username-and-password).
 
-`mergeItems(src, destn)`
+### logout()
 
-`compareItems()`
+This method is used when the user logs out of his/her account.
 
-`populateWithItemRef()`
+```js
+gudhub.logout(token);
+```
 
-`(target, source, optionsArgument)` 
-It deeply merge two objects. We use this method two merge fields models
-0 Value of properties for source object woun't be changed by target object
-0 source of target hase unique properties they are going to be created in resulted object
+Read more information about [logout on GudHub](https://gudhub.com/docs/core-api/auth-core-api/#logout).
 
-## makeNestedList ()
+### signup()
 
-This method will return a new nested array from initial array.
+This method is used to register a user account in GudHub.
 
 ```js
-import {GudHub} from '@gudhub/gudhub';
-const gudhub = new GudHub();
-let nestedList = gudhub.makeNestedList(array, id, parent_id, children_property);
-```
-
-Argument Name | Type | Description
---------------|--------------|--------------
-array | `array` | Array from which nested list will be generated
-id | `string` | Parent property name
-parent_id | `string` | Child property name
-children_property | `string` | `(Optional)` Name of property, in which children items will be stored inside parent item. <br> Default is 'children'
-
-Initial array example:
-
-```js
-let input = [
-    {
-        name: "Article 1",
-        id: 1,
-        parent_id: 0
-    },
-    {
-        name: "Article 2",
-        id: 2,
-        parent_id: 1
-    },
-    {
-        name: "Article 3",
-        id: 3,
-        parent_id: 1
-    },
-    {
-        name: "Article 4",
-        id: 4,
-        parent_id: 0
-    }
-]
-```
-
-Method call example:
-
-```js
-let result = gudhub.makeNestedList(input, 'id', 'parent_id', 'custom_children_property')
-```
-
-Result example:
-
-```js
-[
-  {
-    id: 1,
-    name: "Article 1",
-    parent_id: 0,
-    custom_child_property: [
-      {
-        id: 2,
-        name: "Article 2",
-        parent_id: 1
-      },
-      {
-        id: 3,
-        name: "Article 3",
-        parent_id: 1
-      }
-    ]
-  },
-  {
-    id: 4,
-    name: "Article 4",
-    parent_id: 0
-  }
-]
-```
-
-# App Processor:
-
-## getAppInfo()
-
-it returs App with Empty `field_list:[]`, `items_list:[]`, `file_list:[]`, `views_list:[]`. Such simmple data needed to render App Icons, and do some simple updates in App like: updating App name icon permisions etc when full app data is not needed
-
-```js
-import {GudHub} from '@gudhub/gudhub';
-const gudhub = new GudHub();
-gudhub.getAppInfo(appId);
+gudhub.signup(user);
 ```
 
-Argument Name|Type|Description
------------- | ------------- | -------------
-*appId* | `app_id` | we use app_id to generate value for item_ref
+Read more information about [signup on GudHub](https://gudhub.com/docs/core-api/auth-core-api/#signup).
 
-**getAppInfo() returns folowing object:**
+### getUserById()
 
-```json
-{
-    app_id: 13360,
-    app_name: "Contacts"
-    field_list: [],
-    file_list: [],
-    group_id: 13329,
-    icon: {id: 12762, icon_id: "user", icon_color: "ffffff", gradient_up: "ff758c", gradient_down: "ff7eb3"}
-    items_list: [],
-    keys_list: [],
-    last_update: 1608657765499,
-    permission: 4,
-    priority: 0,
-    privacy: 0,
-    show: true,
-    trash: false,
-    view_init: 281591,
-    views_list: []
-}
+This method gets user from user list who have access to the application.
+
+```js
+gudhub.getUserById(userId);
 ```
 
-`getApp(app_id)` return app;
+Read more information about [getUserById on GudHub](https://gudhub.com/docs/core-api/auth-core-api/#getuserbyid).
 
-`To Be Done` -> `getAppList()` return List of Applications those are shared to users;
+### getUsersList()
 
-# App Processor:
+This method is called during the search for users to share. Namely, when you enter a keyword into the search box, GudHub displays all users whose names match that word.
 
-## getAppInfo()
+```js
+gudhub.getUsersList(keyword);
+```
+
+Read more information about [getUsersList on GudHub](https://gudhub.com/docs/core-api/auth-core-api/#getuserslist).
 
-it returs App with Empty `field_list:[]`, `items_list:[]`, `file_list:[]`, `views_list:[]`. Such simmple data needed to render App Icons, and do some simple updates in App like: updating App name icon permisions etc when full app data is not needed
+### updateUser()
+
+This is the method used to update user account data.
 
 ```js
-import {GudHub} from '@gudhub/gudhub';
-const gudhub = new GudHub();
-gudhub.getAppInfo(appId);
+gudhub.updateUser(userData);
 ```
 
-Argument Name|Type|Description
------------- | ------------- | -------------
-*appId* | `app_id` | we use app_id to generate value for item_ref
+Read more information about [updateUser on GudHub](https://gudhub.com/docs/core-api/auth-core-api/#updateuser).
+
+### getToken()
+
+This method is used to get the current token.
+
+```js
+gudhub.getToken();
+```
+
+Read more information about [getToken on GudHub](https://gudhub.com/docs/core-api/auth-core-api/#gettoken).
+
+### updateToken()
 
-**It returns folowing object:**
+This method is called when the token is updated.
 
-```json
-{
-    app_id: 13360,
-    app_name: "Contacts"
-    field_list: [],
-    file_list: [],
-    group_id: 13329,
-    icon: {id: 12762, icon_id: "user", icon_color: "ffffff", gradient_up: "ff758c", gradient_down: "ff7eb3"}
-    items_list: [],
-    keys_list: [],
-    last_update: 1608657765499,
-    permission: 4,
-    priority: 0,
-    privacy: 0,
-    show: true,
-    trash: false,
-    view_init: 281591,
-    views_list: []
-}
+```js
+gudhub.updateToken(auth_key)
 ```
 
-`getApp(app_id)` return app;
- 
-`To Be Done` -> `getAppList()` return List of Applications those are shared to users;
+Read more information about [updateToken on GudHub](https://gudhub.com/docs/core-api/auth-core-api/#updatetoken).
+
+### updateAvatar()
 
+This method is used when user changes his photo of the account.
 
-# User:
+```js
+gudhub.updateAvatar(imageData);
+```
 
-`login()`;(is not needed)
+Read more information about [updateAvatar on GudHub](https://gudhub.com/docs/core-api/auth-core-api/#updateavatar).
 
-`logout()`;
+### getUserFromStorage()
 
-`signup()`;(is not needed)
+This method is used for getting needed user from the user list during sharing.
 
-`getUser()`;
+```js
+gudhub.getUserFromStorage(id);
+```
 
-`getUsersList()`;
+Read more information about [getUserFromStorage on GudHub](https://gudhub.com/docs/core-api/auth-core-api/#getuserfromstorage).
 
-`updateUser()`;
+### saveUserToStorage()
 
-`avatarUpload()`;
+This method allows you to add new user to the user list.
 
-`getVersion()`;
+```js
+gudhub.saveUserToStorage(saveUser);
+```
 
-## Sharing
+Read more information about [saveUserToStorage on GudHub](https://gudhub.com/docs/core-api/auth-core-api/#saveusertostorage).
 
-`getUsersWithPermision()`;
+### getVersion()
 
-`sharingAdd()`;
+Use this method to to find out the current version of the GudHub.
 
-`sharingUpdate()`;
+```js
+gudhub.getVersion();
+```
 
-`sharingDelete()`;
+Read more information about [getVersion on GudHub](https://gudhub.com/docs/core-api/auth-core-api/#getversion).
 
 ## Items Processor
 
-`itemsGet(app_id, items_id_array)` return items by item_id from the array;
+### getItems()
+
+This method is used to get the items of the current application.
+
+```js
+await gudhub.getItems(app_id, trash);
+```
+
+Read more information about [getItems on GudHub](https://gudhub.com/docs/core-api/item-processor/#getitems).
+
+### addNewItems()
+
+Use this method to add new items to the items list.
+
+```js
+await gudhub.addNewItems(app_id, itemsList);
+```
+
+Read more information about [addNewItems on GudHub](https://gudhub.com/docs/core-api/item-processor/#addnewitems).
+
+### updateItems()
 
-`filteredItemsGet(app_id, filter)` return items according to filter;
+This method is used to update certain items.
 
-`itemGet(app_id, item_id)` return item;
+```js
+await gudhub.updateItems(app_id, itemsList);
+```
+
+Read more information about [updateItems on GudHub](https://gudhub.com/docs/core-api/item-processor/#updateitems).
+
+### deleteItems()
+
+Due to this method you can delete one and more items from thee application.
 
-`itemsAdd(app_id, items)` add items to app;
+```js
+await gudhub.deleteItems(app_id, itemsIds);
+```
 
-`itemsUpdate(app_id, items)` update items in the app;
+Read more information about [deleteItems on GudHub](https://gudhub.com/docs/core-api/item-processor/#deleteitems).
 
 ## Field Processor
 
-`elementGet(element_id)` return element `beta`;
+### getField()
+
+Due to this method you can get field from the relevant application.
+
+```js
+await gudhub.getField(app_id, field_id);
+```
+
+Read more information about [getField on GudHub](https://gudhub.com/docs/core-api/field-processor/#getfield).
   
-`fieldValueGet(app_id, item_id, field_id)` return field value;
+### updateField()
+
+This method allows you to update field model of the current application.
+
+```js
+await gudhub.updateField(app_id, fieldModel);
+```
+
+Read more information about [updateField on GudHub](https://gudhub.com/docs/core-api/field-processor/#updatefield).
+
+### deleteField()
+
+The method is created for deleting field from the application.
+
+```js
+await gudhub.deleteField(app_id, field_id);
+```
+
+Read more information about [deleteField on GudHub](https://gudhub.com/docs/core-api/field-processor/#deletefield).
+
+### getFieldModels()
+
+This method is used for getting a list of field models.
+
+```js
+await gudhub.getFieldModels(app_id);
+```
+
+Read more information about [getFieldModels on GudHub](https://gudhub.com/docs/core-api/field-processor/#getfieldmodels).
+
+### getFieldValue()
 
-`valueUpdate(app_id, item_id, field_id, field_value)` update value in a field;
+This method is responsible for getting the value from the desired field.
 
-`getModel(app_id, field_id)` return data_model of field;
+```js
+await gudhub.getFieldValue(app_id, item_id, field_id);
+```
+
+Read more information about [getFieldValue on GudHub](https://gudhub.com/docs/core-api/field-processor/#getfieldvalue).
+
+### setFieldValue()
+
+This method is called to set value in the desired field.
+
+```js
+await gudhub.setFieldValue(app_id, item_id, field_id, field_value);
+```
+
+Read more information about [setFieldValue on GudHub](https://gudhub.com/docs/core-api/field-processor/#setfieldvalue).
 
 ## File Processor
 
-`uploadFile(fileData, app_id, item_id)` create a file from data;
+### getFile()
+
+This method is called to get file from the application.
+
+```js
+gudhub.getFile(app_id, file_id);
+```
+
+Read more information about [getFile on GudHub](https://gudhub.com/docs/core-api/file-manager/#getfile).
+
+### getFiles()
+
+This method is called for getting a list of files from current application.
+
+```js
+gudhub.getFiles(app_id, filesId);
+```
+
+Read more information about [getFiles on GudHub](https://gudhub.com/docs/core-api/file-manager/#getfiles).
 
-`uploadFileFromString(data, file_name, app_id, item_id, extension, format)` create a file from string;
+### uploadFile()
 
-`updateFileFromString(data, file_id, file_name, extension, format)` update file from string;
+### uploadFileFromString()
 
-`getFile(app_id, file_id)` get file by appId and fileId;
+This is the method that allows to upload different files in base64 format to the application.
 
-`getFiles(app_id, [fileId, fileId])` get files by appId and arrays of filesId;
+```js
+await gudhub.uploadFileFromString(fileObject);
+```
+
+Read more information about [uploadFileFromString on GudHub](https://gudhub.com/docs/core-api/file-manager/#uploadfilefromstring).
+
+### isFileExists()
+
+### updateFile()
+
+### updateFileFromString()
+
+### duplicateFile()
+
+### downloadFileFromString()
+
+### deleteFile()
+
+Due to this method files can be deleted from the application.
 
-`deleteFile(id)` delete file by fileId;
+```js
+gudhub.deleteFile(app_id, file_id);
+```
+
+Read more information about [deleteFile on GudHub](https://gudhub.com/docs/core-api/file-manager/#deletefile).
 
 ## Document Processor
 
-`createDocument({app_id, item_id, element_id, data: Object})` create a document;
+### createDocument()
+
+This method is called for creating a new document in the certain application.
+
+```js
+gudhub.createDocument(documentObject);
+```
 
-`getDocument({app_id, item_id, element_id})` get a document;
+Read more information about [createDocument on GudHub](https://gudhub.com/docs/core-api/document-manager/#createdocument).
 
-`getDocuments([{app_id, item_id, element_id}, {app_id, item_id, element_id}])` get documents;
+### getDocument()
 
-`deleteDocument({app_id, item_id, element_id})` delete a document;
+The method for getting needed document from the applications documents list.
 
-## PipeService
+```js
+gudhub.getDocument(documentAddress);
+```
 
-### Methods
+Read more information about [getDocument on GudHub](https://gudhub.com/docs/core-api/document-manager/#getdocument).
 
-`on(types, destination, fn)`
+### getDocuments()
 
-`emit(types, destination, address, params)`
+This method is called to get array of documents from the application.
 
-`destroy(types, destination, fn)`
+```js
+gudhub.getDocuments(documentsAddresses);
+```
+
+Read more information about [getDocuments on GudHub](https://gudhub.com/docs/core-api/document-manager/#getdocuments).
+
+### deleteDocument()
+
+Due to this method you can delete document from the application.
+
+```js
+gudhub.deleteDocumentApi(documentAddress);
+```
+
+Read more information about [deleteDocument on GudHub](https://gudhub.com/docs/core-api/document-manager/#deletedocument).
+
+## PipeService
+
+### on()
 
-#### _Examples_
+This is the method that is called for getting subscription.
 
 ```js
-on("gh_items_update", {app_id: 1, item_id: 1}, function getItems(event, address, params){})
+gudhub.on(event, address, myFunction);
+```
+
+Read more information about [On on GudHub](https://gudhub.com/docs/core-api/pipe-server/#on).
+
+### emit()
 
-emit("gh_items_update", {app_id: 1, item_id: 1}, items, params)
+This is the method that is used by GudHub itself. It is called for getting existing subscription.
 
-destroy("gh_items_update", {app_id: 1, item_id: 1}, function getItems(event, address, params){})
+```js
+gudhub.on(event, address, myFunction);
 ```
 
-### Events
+Read more information about [Emit on GudHub](https://gudhub.com/docs/core-api/pipe-server/#emit).
+
+### destroy()
+
+This method exists for ruining extra subscriptions and for optimization the process.
 
-Event name|Address example
------------- | -------------
-`gh_items_update` |{app_id: 1, item_id: 1}
-`gh_app_update`   |{app_id: 1}
-`gh_item_update`  |{app_id: 1, item_id: 1}
-`gh_value_update` |{app_id: 1, item_id: 1, field_id: 1}
+```js
+gudhub.destroy('gh_app_views_update', address, myFunction);
+```
 
-________
+Read more information about [Destroy on GudHub](https://gudhub.com/docs/core-api/pipe-server/#destroy).