update for 1.1.0

Author: Mr-Sergey-K

.swiftpm/xcode/package.xcworkspace/xcuserdata/sergey.xcuserdatad/UserInterfaceState.xcuserstate

@@ -1,107 +1,104 @@
 # UseDesk
 [![Swift Package Manager](https://img.shields.io/badge/Swift_Package_Manager-compatible-orange?style=flat-square)](https://img.shields.io/badge/Swift_Package_Manager-compatible-orange?style=flat-square)
 
-
-- [Добавление библиотеки в проект](#добавление-библиотеки-в-проект)
-- [Классы базы знаний](#классы-базы-знаний)
-- [Документация](#Документация)
-
-
 # Добавление библиотеки в проект:
 
 ### Swift Package Manager
 
 ```swift
-.package(url: "https://github.com/usedesk/UseDeskSPM.git", from: "1.0.0")
+.package(url: "https://github.com/usedesk/UseDeskSPM.git", from: "1.1.0")
 ```
 
-## Подключение SDK 
-
-- Выполняем операцию инициализации чата параметрами без GUI:
-
-| Переменная  | Тип | Описание |
-| -------------| ------------- | ------------- |
-| CompanyID\* | String | Идентификатор компании. Как найти описано в [документации](https://docs.usedesk.ru/article/61) |
-| ChanelId\* | String | Идентификатор канала (добавлен  в v1.1.5). Как найти описано в [документации](https://docs.usedesk.ru/article/10167) |
-| UrlAPI\* | String | Адрес API. Стандартное значение `secure.usedesk.ru/uapi` |
-| API Token\* | String | Личный API ключ |
-| Url\* | String | Адрес сервера в формате - pubsubsec.usedesk.ru |
-| Knowledge Base ID | String | Идентификатор базы знаний. Если не указан, база знаний не используется |
-| Email | String | Почта клиента |
-| Phone | String | Телефон клиента |
-| UrlToSendFile | String | Адрес для отправки файлов. Стандартное значение `https://secure.usedesk.ru/uapi/v1/send_file` |
-| Port | String | Порт сервера |
-| Name | String | Имя клиента |
-| NameOperator | String | Имя оператора |
-| FirstMessage | String | Автоматическое сообщение. Отправиться сразу после иницилизации от имени клиента |
-| Note | String | Текст заметки |
-| AdditionalFields | [Int : String] | Массив дополнительный полей в формате - id : "значение". Для текстовых полей значение - строка, для списка - строка с точно совпадающим значением списка, для флага - строка "false" или "true" |
-| AdditionalNestedFields | [[Int : String]] | Массив допл полей типа вложенный список. Каждый подмассив представляет один вложенный список. Формат фложенного списка - [id1: "значение", id2 : "значение", id3 : "значение"], где id1, id2, id3 идентификаторы значений по уровням вложенности |
-| AdditionalId | String | Дополнительный идентификатор клиента |
-| Token | String | Подпись, однозначно идентифицирующая пользователя и его чат на любых устройствах для сохранения истории переписки. (генерирует наша система,  ограничение не меньше 64 символа) |
-| isSaveTokensInUserDefaults | Bool | Сохранять ли токен юзера ("Token", смотреть выше) в UserDefaults приложения. При занчении "True" позволяет не хранить токены в ваших системах, но он будет храниться только в текущем устройстве. Для доступа к переписке клиента с других устройств и платформ необходимо хранить токен в вашей системе и передавать его при инициализации. В этом случае значение параметра должно быть "False" |
-
-\* - обязательный параметр
-
-#### Пример:
+## Инициализация SDK 
+
+### Параметры, используемые в конфигурации SDK
+
+Где * — обязательный параметр
+
+| **Переменная** | **Тип** | **Описание** |
+| --- | --- | --- |
+| **CompanyID*** | String | **Идентификатор компании в Юздеске**<br/>[Как найти ID компании](https://docs.usedesk.ru/article/61) |
+| **ChannelID*** | String | **Идентификатор канала чата, через который в Юздеск будут поступать обращения из приложения**<br/>[Как создать и настроить канал](https://docs.usedesk.ru/article/858) |
+| **Url*** | String | **Адрес сервера для работы с чатами SDK**<br/>Стандартное значение: `pubsubsec.usedesk.ru`<br/>Если вы используете коробочную версию Юздеска на собственном сервере, то этот параметр у вас может отличаться. Уточните актуальный адрес у поддержки — support@usedesk.ru |
+| **Port** | String | **Порт сервера для работы с чатами SDK**<br/>Стандартное значение: `443` |
+| **UrlAPI*** | String | **URL для работы с API**<br/>Стандартное значение: `secure.usedesk.ru/uapi`<br/>Если вы используете коробочную версию Юздеска на собственном сервере, то этот параметр у вас будет отличаться. Уточните актуальный адрес у поддержки — support@usedesk.ru |
+| **API_token** | String | **Ключ для доступа к API Юздеска**<br/>[Как получить API ключ](https://docs.usedesk.ru/article/10167) |
+| **KnowledgeBaseID** | String | **Идентификатор базы знаний**<br/>[Как создать Базу знаний](https://docs.usedesk.ru/article/1678)<br/>**Если ID не указан, база знаний не используется** |
+| **UrlToSendFile** | String | **Адрес для отправки файлов**<br/>Стандартное значение: `https://secure.usedesk.ru/uapi/v1/send_file` |
+| **Name** | String | **Имя клиента** |
+| **Email** | String | **Почта клиента** |
+| **Phone** | String | **Телефон клиента** |
+| **Avatar** | Data? | **Изображение аватара клиента** |
+| **Token** | String | **Подпись, однозначно идентифицирующая пользователя и его чат**<br/>Токен выдается в коллбэке после инициализации чата и привязывается к связке почта-телефон-имя пользователя.<br/>Для идентификации различных пользователей на одном устройстве вы должны хранить и передавать полученный токен в метод инициализации |
+| **AdditionalId** | String | **Дополнительный идентификатор клиента** |
+| **Note** | String | **Текст заметки** |
+| **AdditionalFields** | [Int : String] | **Массив дополнительный полей запроса**<br/>Формат: `id : "значение"`<br/>Для текстовых полей значение - строка, для списка - строка с точно совпадающим значением списка, для флага - строка `false` или `true` |
+| **AdditionalNestedFields** | [[Int : String]] | **Массив дополнительных полей типа вложенный список**<br/>Каждый подмассив представляет один вложенный список. <br/>Формат вложенного списка: `[id1: "значение", id2 : "значение", id3 : "значение"]`, где `id1`, `id2`, `id3` — идентификаторы значений по уровням вложенности |
+| **FirstMessage** | String | **Автоматическое сообщение**<br/>Отправится сразу после инициализации от имени клиента |
+| **LocaleIdentifier** | String | **Идентификатор языка**<br/>Доступные языки: русский (`ru`), английский (`en`), португальский (`pt`), испанский (`es`). <br/>Если переданный идентификатор не поддерживается, будет использоваться русский язык |
+| **CustomLocale** | [String : String] | **Свой словарь переводов**<br/>Если SDK нужно показывать на языке, который мы не поддерживаем, можно самостоятельно создать словарь переводов и использовать его |
+| **isSaveTokensInUserDefaults** | Bool | **Флаг сохранения токена пользователя в UserDefaults приложения**<br/>Стандартное значение: `true`<br/>Если указан `true`, то токен будет храниться в текущем устройстве. Недостатки такого подхода — при переустановке приложения, смене устройства или платформы доступ к переписке будет утрачен. <br/>Для сохранения доступа к переписке клиента с других устройств и платформ,  токен необходимо хранить в вашей системе и передавать его при инициализации. В этом случае нужно использовать значение параметра `false` |
+
+
+### Инициализация SDK 
+
 ```swift
-class ViewController: UIViewController {
-    
-    let usedesk = UseDeskSDK()
-
-    override func viewDidLoad() {
-        super.viewDidLoad()
-        usedesk.startWithoutGUI(companyID: "companyID",
-            chanelId: "chanelId",
-            urlAPI: "secure.usedesk.ru",
-            knowledgeBaseID: "knowledgeBaseID",
-            api_token: "api_token",
-            email: "test@gmail.com",
-            url: "pubsubsec.usedesk.ru",
-            urlToSendFile: "https://secure.usedesk.ru/uapi/v1/send_file",
-            port: "port number",
-            name: "Name",
-            operatorName: "NameOperator",
-            firstMessage: "message",
-            note: "Note text",
-            additionalFields: [1 : "value"],
-            additionalNestedFields: [[1 : "value1", 2 : "value2", 3 : "value3"]],
-            additional_id: "additional_id",
-            token: "Token",
-            connectionStatus: { success, feedbackStatus, token in
-            print(self.usedesk.historyMess)
-        }, errorStatus: {  _, _ in})
+let usedesk = UseDeskSDK()
+usedesk.start(
+    companyID: "1234567",
+    chanelId: "1234", 
+    url: "pubsubsec.usedesk.ru", 
+    port: "443",
+    urlAPI: "pubsubsec.usedesk.ru", 
+    api_token: "143ed59g90ef093s",
+    urlToSendFile: "https://secure.usedesk.ru/uapi/v1/send_file", 
+    knowledgeBaseID: "12",
+    name: "Name", 
+    email: "lolo@yandex.ru", 
+    phone: "89000000000", 
+    avatar: avatarData,
+    token: "Token", 
+    additional_id: "additional_id",
+    note: "Note text", 
+    additionalFields: [1 : "value"], 
+    additionalNestedFields: [[1 : "value1", 2 : "value2", 3 : "value3"]], 
+    firstMessage: "message",
+    localeIdentifier: "en", 
+    customLocale: customLocaleDictionary,
+    isSaveTokensInUserDefaults: true,
+    connectionStatus: { 
+        success, error in
     }
-}
+)
 ```
 
-### Блок возвращает следующие параметры:
+### Параметры, которые возвращает блок
 
-#### СonnectionStatus:
+****СonnectionStatus****
 
 | Тип | Описание |
-| ------------- | ------------- |
+| --- | --- |
 | Bool | Успешность подключения к чату |
 | UDFeedbackStatus | Статус показа формы обратной связи |
 | String | Токен пользователя |
 
-#### ErrorStatus:
+****ErrorStatus****
 
 | Тип | Описание |
-| ------------- | ------------- |
+| --- | --- |
 | UDError | Задокументированый тип ошибки |
-| UDFeedbackStatus | Описание ошибки |
+| String? | Описание ошибки |
 
 
-# Документация:
+## Документация:
 
-Документация находится по адресу - http://sdk.usedocs.ru/
+Методы для работы с SDK и ошибки описаны в нашей документации: [http://sdk.usedocs.ru](http://sdk.usedocs.ru/)
 
-## Author
+## Автор
 
 Сергей, kon.sergius@gmail.com
 
-## License
+## ****License****
 
-UseDesk_SDK_Swift is available under the MIT license. See the LICENSE file for more info.
+UseDesk_SDK_Swift is available under the MIT license. See the LICENSE file for more info
 

README.md

@@ -19,7 +19,7 @@ import Foundation
 
 @objc public enum OrderArticle: Int {
     case asc
-    case desc 
+    case desc
 }
 
 @objc public class UDArticle: NSObject {
@@ -35,7 +35,6 @@ import Foundation
     public var created_at: String = ""
 
     init?(json: [String: Any]) {
-        
         guard
             let id = json["id"] as? Int,
             let title = json["title"] as? String,
@@ -50,8 +49,8 @@ import Foundation
             else { return nil }
 
         self.id = id
-        self.title = title
-        self.text = text
+        self.title = title.udRemoveSubstrings(with: ["<b>", "</b>"])
+        self.text = text.udRemoveSubstrings(with: ["<b>", "</b>"])
         self.category_id = category_id
         self.collection_id = collection_id
         self.category_title = category_title
@@ -65,6 +64,11 @@ import Foundation
         }
     }
 
+    init(id: Int, title: String) {
+        self.id = id
+        self.title = title
+    }
+    
     static func get(from jsonObject: Any) -> UDArticle? {
         guard let jsonObject = jsonObject as? [String: Any] else { return nil }
         if let article = UDArticle(json: jsonObject) {

Sources/UseDesk/UDBaseArticle.swift

@@ -58,7 +58,7 @@ import UIKit
     public var id: Int = 0
     public var imageUrl: String = ""
     public var image: UIImage? = nil
-    public var сategories: [UDBaseCategory] = []
+    public var categories: [UDBaseCategory] = []
     public var open: Bool = true
 
     init?(json: [String: Any]) {
@@ -80,7 +80,7 @@ import UIKit
         }
         for categoryObject in categoriesArray {
             if let category = UDBaseCategory(json: categoryObject) {
-                self.сategories.append(category)
+                self.categories.append(category)
             }
         }
     }
@@ -98,5 +98,3 @@ import UIKit
         return collections
     }
 }
-
-

Sources/UseDesk/UDBaseCollection.swift

@@ -25,18 +25,19 @@ let UD_STATUS_SEND_SUCCEED = 3
 let UD_AUDIOSTATUS_STOPPED = 1
 let UD_AUDIOSTATUS_PLAYING = 2
 
-public typealias UDSStartBlock = (Bool, UDFeedbackStatus, String) -> Void
-public typealias UDSBaseBlock = (Bool, [UDBaseCollection]?) -> Void
-public typealias UDSArticleBlock = (Bool, UDArticle?) -> Void
-public typealias UDSArticleSearchBlock = (Bool, UDSearchArticle?) -> Void
-public typealias UDSConnectBlock = (Bool) -> Void
-public typealias UDSNewMessageBlock = (UDMessage?) -> Void
-public typealias UDSErrorSocketBlock = ([Any]?) -> Void
-public typealias UDSErrorBlock = (UDError, String?) -> Void
-public typealias UDSFeedbackMessageBlock = (UDMessage?) -> Void
-public typealias UDSFeedbackAnswerMessageBlock = (Bool) -> Void
-public typealias UDSVoidBlock = () -> Void
-public typealias UDSProgressUploadBlock = (Progress) -> Void
+public typealias UDStartBlock = (Bool, UDFeedbackStatus, String) -> Void
+public typealias UDBaseBlock = (Bool, [UDBaseCollection]?) -> Void
+public typealias UDArticleBlock = (Bool, UDArticle?) -> Void
+public typealias UDArticleSearchBlock = (Bool, UDSearchArticle?) -> Void
+public typealias UDConnectBlock = (Bool) -> Void
+public typealias UDNewMessageBlock = (UDMessage?) -> Void
+public typealias UDNewMessagesBlock = ([UDMessage]) -> Void
+public typealias UDErrorBlock = (UDError, String?) -> Void
+public typealias UDFeedbackMessageBlock = (UDMessage?) -> Void
+public typealias UDFeedbackAnswerMessageBlock = (Bool) -> Void
+public typealias UDVoidBlock = () -> Void
+public typealias UDProgressUploadBlock = (Progress) -> Void
+public typealias UDValidModelBlock = (UseDeskModel) -> Void
 
 @objc public enum UDFeedbackStatus: Int {
     case null
@@ -53,10 +54,6 @@ public typealias UDSProgressUploadBlock = (Progress) -> Void
     }
 }
 
-protocol UDUISetupable {
-    func setupUI()
-}
-
 @objc public protocol UDStorage {
     func getMessages() -> [UDMessage]
     func saveMessages(_ messages: [UDMessage])
@@ -72,21 +69,29 @@ public struct UseDeskModel {
     var urlWithoutPort = ""
     var urlAPI = ""
     var knowledgeBaseID = ""
+    var knowledgeBaseSectionId: Int = 0
+    var knowledgeBaseCategoryId: Int = 0
+    var knowledgeBaseArticleId: Int = 0
+    var baseSections: [UDBaseCollection] = []
     var api_token = ""
     var port = ""
     var name = ""
-    var operatorName = ""
+    var avatar: Data? = nil
+    var nameOperator = ""
+    var nameChat = ""
     var firstMessage = ""
     var note = ""
     var token = ""
     var additional_id = ""
+    var localeIdentifier = ""
     var additionalFields: [Int : String] = [:]
     var additionalNestedFields: [[Int : String]] = []
     var idLoadingMessages: [String] = []
     var isSaveTokensInUserDefaults = true
+    var isOnlyKnowledgeBase = false
     // Lolace
     var locale: [String:String] = [:]
-
+    
     func stringFor(_ key: String) -> String {
         if let word = locale[key] {
             return word