bx-rest 0.11.1 → 0.11.2

package/fesm2022/bx-rest.mjs

@@ -2673,6 +2673,31 @@ class BXRestMapUser {
     }
 }
 
+/** Персональные настройки текущего пользователя (`user.option.*`). */
+class BXRestNavvyUserOption {
+    constructor() {
+        this.Navvy = new Navvy();
+    }
+    /**
+     * Сохраняет или обновляет настройки текущего пользователя для приложения.
+     *
+     * Метод работает только в контексте приложения. Пустой объект `options`
+     * приводит к ошибке `ArgumentNullException`.
+     */
+    set(param) {
+        return this.Navvy.simple(['user', 'option', 'set'], param);
+    }
+    /**
+     * Возвращает одну пользовательскую настройку или все настройки сразу.
+     *
+     * Если `option` не указан, возвращаются все свойства, сохраненные через
+     * `user.option.set`. Метод работает только в контексте приложения.
+     */
+    get(param = {}) {
+        return this.Navvy.simple(['user', 'option', 'get'], param);
+    }
+}
+
 class BXRestNavvyUser {
     constructor() {
         this.def = {
@@ -2691,8 +2716,16 @@ class BXRestNavvyUser {
             fields: [$user, 'fields'],
         };
         this.userField = new BXRestNavvyUserUserfield();
+        /** Персональные настройки текущего пользователя для приложения. */
+        this.option = new BXRestNavvyUserOption();
         this.Navvy = new Navvy();
     }
+    /**
+     * Проверяет, может ли текущий пользователь управлять настройками приложений.
+     *
+     * Возвращает `true` для пользователя с соответствующими административными
+     * правами и `false` в остальных случаях.
+     */
     admin() {
         return this.Navvy.simple(this.url.admin);
     }
@@ -2735,8 +2768,17 @@ class BXRestNavvyUser {
     search(params) {
         return this.Navvy.pagNav(this.url.search, params, BXRestMapUser.get);
     }
+    /**
+     * Проверяет наличие хотя бы одного из указанных кодов доступа.
+     *
+     * Для обратной совместимости можно передать как объект
+     * `{ ACCESS: ['G2', 'AU'] }`, так и непосредственно массив кодов.
+     */
     access(params) {
-        return this.Navvy.simple(this.url.access, params);
+        const preparedParams = Array.isArray(params)
+            ? { ACCESS: params }
+            : params;
+        return this.Navvy.simple(this.url.access, preparedParams);
     }
     fields() {
         return this.Navvy.simple(this.url.fields);
@@ -5370,6 +5412,13 @@ class BXRestNavvyServer {
         };
         this.Navvy = new Navvy();
     }
+    /**
+     * Возвращает текущее время сервера как объект `Date`.
+     *
+     * Исходный ответ REST API имеет формат ISO 8601
+     * `YYYY-MM-DDThh:mm:ss±hh:mm`; получить его без преобразования можно через
+     * `resVanilla()` у возвращаемого навигатора.
+     */
     time() {
         return this.Navvy.simple(this.url.time, undefined, BXRestMapServer.time);
     }
@@ -5916,12 +5965,44 @@ class BXRestMapApp {
     }
 }
 
+/** Общие настройки текущего приложения (`app.option.*`). */
+class BXRestNavvyAppOption {
+    constructor() {
+        this.Navvy = new Navvy();
+    }
+    /**
+     * Сохраняет или обновляет общие настройки приложения.
+     *
+     * Метод работает только в контексте приложения и требует прав администратора.
+     * Пустой объект `options` приводит к ошибке `ArgumentNullException`.
+     */
+    set(param) {
+        return this.Navvy.simple(['app', 'option', 'set'], param);
+    }
+    /**
+     * Возвращает одну настройку приложения или все настройки сразу.
+     *
+     * Если `option` не указан, возвращаются все свойства, сохраненные через
+     * `app.option.set`. Метод работает только в контексте приложения.
+     */
+    get(param = {}) {
+        return this.Navvy.simple(['app', 'option', 'get'], param);
+    }
+}
+
+/** Информация и общие настройки текущего приложения (`app.*`). */
 class BXRestNavvyApp {
     constructor() {
         this.Navvy = new Navvy();
+        /** Общие настройки приложения. */
+        this.option = new BXRestNavvyAppOption();
     }
     /**
-     * Показ информации о приложении. Метод поддерживает безопасный вызов
+     * Возвращает информацию о текущем приложении и лицензии портала.
+     *
+     * Метод не принимает параметров, работает только в контексте приложения и
+     * доступен любому пользователю. Результат содержит код, версию, статус,
+     * состояние оплаты и сведения о тарифе.
      */
     info() {
         return this.Navvy.simple(['app', 'info'], undefined, BXRestMapApp.info);
@@ -9038,6 +9119,53 @@ class BXRestNavvyEvent {
     }
 }
 
+/** Проверка существования и доступности REST-методов (`method.*`). */
+class BXRestNavvyMethod {
+    constructor() {
+        this.Navvy = new Navvy();
+    }
+    /**
+     * Проверяет, существует ли метод на портале и доступен ли он приложению.
+     *
+     * Передавайте имя метода в нижнем регистре, например `{ name: 'user.get' }`.
+     */
+    get(param) {
+        return this.Navvy.simple(['method', 'get'], param);
+    }
+}
+
+/** Получение сведений о кодах доступа (`access.*`). */
+class BXRestNavvyAccess {
+    constructor() {
+        this.Navvy = new Navvy();
+    }
+    /**
+     * Возвращает человекочитаемые названия переданных кодов доступа.
+     *
+     * Например, `{ ACCESS: ['G2', 'AU'] }` вернет описания прав для всех
+     * посетителей и всех авторизованных пользователей.
+     */
+    name(param) {
+        return this.Navvy.simple(['access', 'name'], param);
+    }
+}
+
+/** Проверка доступности возможностей портала (`feature.*`). */
+class BXRestNavvyFeature {
+    constructor() {
+        this.Navvy = new Navvy();
+    }
+    /**
+     * Проверяет доступность указанной возможности на текущем портале.
+     *
+     * Поддерживаемые коды: `rest_offline_extended` и `rest_auth_connector`.
+     * В поле `value` сервер возвращает `Y` или `N`.
+     */
+    get(param) {
+        return this.Navvy.simple(['feature', 'get'], param);
+    }
+}
+
 class BXRestNavvy {
     constructor() {
         this.user = new BXRestNavvyUser();
@@ -9059,6 +9187,12 @@ class BXRestNavvy {
         this.crm = new BXRestNavvyCrm();
         /** Регистрация обработчиков и работа с онлайн- и офлайн-событиями. */
         this.event = new BXRestNavvyEvent();
+        /** Проверка существования и доступности REST-методов. */
+        this.method = new BXRestNavvyMethod();
+        /** Получение описаний кодов доступа. */
+        this.access = new BXRestNavvyAccess();
+        /** Проверка доступности возможностей портала. */
+        this.feature = new BXRestNavvyFeature();
         this.Navvy = new Navvy();
         // public batch<T, C, M>(param: iBXRestNavvyParamBatch<T, C, M>) {
         //   const modifiedObject = Object.fromEntries(
@@ -9074,9 +9208,24 @@ class BXRestNavvy {
         //   })
         // }
     }
+    /**
+     * Возвращает базовую информацию о текущем пользователе без scope `user`.
+     *
+     * Результат содержит идентификатор, имя, фамилию, признак администратора,
+     * пол, часовой пояс и связанные поля профиля.
+     */
     profile() {
         return this.Navvy.simple(['profile'], undefined, BXRestMap$1.profile);
     }
+    /**
+     * Возвращает разрешения текущего приложения.
+     *
+     * Передайте `{ full: true }`, чтобы запросить полный список разрешений
+     * портала. Без параметров возвращаются разрешения, доступные приложению.
+     */
+    scope(param = {}) {
+        return this.Navvy.simple(['scope'], param);
+    }
 }
 
 class BXRestMapCalendarUser {