@salutejs/types - npm Package Compare versions

Comparing version 0.5.0 to 0.6.0

dist/salute.d.ts

@@ -48,3 +48,4 @@ import { AppInfo, CharacterId, AppState, Message, ErrorCommand, EmotionId, Card, Bubble, Button } from './systemMessage';
     readonly voiceAction: boolean;
-    readonly intent: string;
+    readonly systemIntent: string;
+    readonly variant: Variant;
     readonly inference?: Inference;
@@ -61,2 +62,3 @@ readonly request: NLPRequest;
     i18n: (keyset: KeysetDictionary) => (key: string, options?: I18nOptions) => string;
+    setVariant: (intent: Variant) => void;
 }
@@ -97,3 +99,3 @@ export interface SaluteResponse {
     matchers: Array<{
-        type: 'phrase' | 'pattern';
+        type: string;
         rule: string;
@@ -100,0 +102,0 @@ }>;

dist/systemMessage.d.ts

@@ -11,3 +11,6 @@ /**
 /**
- * Тип смартапа. Обратите внимание, что ассистент перехватывает навигационные команды 'вверх', 'вниз', 'влево' и 'вправо' только в Canvas App (тип приложения WEB_APP). В этом случае команды обрабатываются на уровне фронтенда приложения. В остальных случаях, команды передаются в бекэнд активного приложения.
+ * Тип смартапа. Обратите внимание, что ассистент перехватывает навигационные
+ * команды 'вверх', 'вниз', 'влево' и 'вправо' только в Canvas App (тип приложения WEB_APP).
+ * В этом случае команды обрабатываются на уровне фронтенда приложения.
+ * В остальных случаях, команды передаются в бекэнд активного приложения.
  */
@@ -73,3 +76,4 @@ export declare type AppType = 'DIALOG' | 'WEB_APP' | 'APK' | 'CHAT_APP';
 /**
- * Адрес графического ресурса, может быть задан в пространстве интернет или в локальном пространстве клиента, url имеет больший приоритет чем local
+ * Адрес графического ресурса, может быть задан в пространстве интернет
+ * или в локальном пространстве клиента, url имеет больший приоритет чем local
  */
@@ -243,3 +247,9 @@ export declare type ImageAddress = {
 /**
- * Доступные id контекстов для поиска. Например, если задать для какого-то контекста префиксы ('позвони', 'набери'), то ASR будет искать в этом контексте только, если встретит слова 'позвони' или 'набери'. Если задать пустой набор префиксов, то ASR будет искать в этом контексте в любом случае. Таким образом, если мы хотим, чтобы поиск происходил по всем дефолтным префиксам, для значений идентификаторов контекста context_id (mobile_contacts, vk_contacts, vk.fiends) префиксы указывать необязательно.
+ * Доступные id контекстов для поиска. Например, если задать для какого-то контекста
+ * префиксы ('позвони', 'набери'), то ASR будет искать в этом контексте только,
+ * если встретит слова 'позвони' или 'набери'. Если задать пустой набор префиксов,
+ * то ASR будет искать в этом контексте в любом случае.
+ * Таким образом, если мы хотим, чтобы поиск происходил по всем дефолтным префиксам,
+ * для значений идентификаторов контекста context_id (mobile_contacts, vk_contacts, vk.fiends)
+ * префиксы указывать необязательно.
  */
@@ -249,7 +259,10 @@ export declare type ASRContextsId = 'mobile_contacts' | 'vk_contacts' | 'vk.fiends';
     /**
-     * Идентификатор сессии, который обновляется каждый раз, когда в поле new_session приходит true. При использовании совместно с messageId помогает гарантировать уникальность сообщения. В том числе если пользователь взаимодействует с несколькими поверхностями.
+     * Идентификатор сессии, который обновляется каждый раз, когда в поле new_session приходит true.
+     * При использовании совместно с messageId помогает гарантировать уникальность сообщения.
+     * В том числе если пользователь взаимодействует с несколькими поверхностями.
      */
     sessionId: string;
     /**
-     * Идентификатор запроса, который отправил ассистент. Ответ на запрос должен содержать такой же идентификатор в поле messageId.
+     * Идентификатор запроса, который отправил ассистент.
+     * Ответ на запрос должен содержать такой же идентификатор в поле messageId.
      */
@@ -271,7 +284,11 @@ messageId: number;
     /**
-     * Постоянный идентификатор пользователя созданный на основе SberID. Может отсутствовать, если пользователь не аутентифицирован. Может использовать для хранения контекста диалога пользователя. Контекст диалога можно обновлять по значению поля new_session.
+     * Постоянный идентификатор пользователя созданный на основе SberID.
+     * Может отсутствовать, если пользователь не аутентифицирован.
+     * Может использовать для хранения контекста диалога пользователя.
+     * Контекст диалога можно обновлять по значению поля new_session.
      */
     sub: string;
     /**
-     * Идентификатор, который используется для определения не аутентифицированных пользователей. Идентификатор может изменяться при сбросе настроек или переустановке смартапа.
+     * Идентификатор, который используется для определения не аутентифицированных пользователей.
+     * Идентификатор может изменяться при сбросе настроек или переустановке смартапа.
      */
@@ -309,6 +326,10 @@ userId: string;
     intent_meta: unknown;
-    meta: Meta;
+    meta?: Meta;
     selected_item: SelectedItem;
     /**
-     * Указывает на характер запуска смартапа. Если поле содержит true, сессии присваивается новый идентификатор (поле sessionId). true — приложение запущено впервые или после закрытия приложения, а так же при запуске приложения по истечению тайм-аута (10 минут) или после прерывания работы приложения, например, по запросу 'текущее время'.
+     * Указывает на характер запуска смартапа. Если поле содержит true,
+     * сессии присваивается новый идентификатор (поле sessionId).
+     * true — приложение запущено впервые или после закрытия приложения,
+     * а так же при запуске приложения по истечению тайм-аута (10 минут)
+     * или после прерывания работы приложения, например, по запросу 'текущее время'.
      */
@@ -353,3 +374,7 @@ new_session: boolean;
     /**
-     * Сообщает ассистенту о завершении работы смартапа. В приложениях типа Canvas App необходимо самостоятельно закрывать окно приложения после завершения работы смартапа. Для этого требуется передать ассистенту команду close_app с помощью метода assistant.close() или window.AssistantHost.close(), если вы не используете Assistant Client.
+     * Сообщает ассистенту о завершении работы смартапа.
+     * В приложениях типа Canvas App необходимо самостоятельно закрывать окно приложения
+     * после завершения работы смартапа. Для этого требуется передать ассистенту
+     * команду close_app с помощью метода assistant.close() или window.AssistantHost.close(),
+     * если вы не используете Assistant Client.
      */
@@ -511,3 +536,4 @@ finished?: boolean;
     /**
-     * Передается только в том случае, когда биометрия определила голос Яндекс Алисы. В остальных случаях поле отсутствует.
+     * Передается только в том случае, когда биометрия определила голос Яндекс Алисы.
+     * В остальных случаях поле отсутствует.
      */
@@ -595,3 +621,6 @@ is_alice?: boolean;
 /**
- * Описание элемента экрана, который пользователь назвал при запросе ('включи второй'/'включи второго терминатора'). Для работы этой функциональности нужна отправка во входящем сообщении с фронтенда item_selector со списком элементов. Объект передаётся всегда и может быть либо пустым, либо содержать все указанные поля.
+ * Описание элемента экрана, который пользователь назвал при запросе ('включи второй'/'включи второго терминатора').
+ *  Для работы этой функциональности нужна отправка во входящем сообщении с фронтенда
+ * item_selector со списком элементов. Объект передаётся всегда и может быть либо пустым,
+ * либо содержать все указанные поля.
  */
@@ -657,7 +686,10 @@ export interface SelectedItem {
     /**
-     * Исходное сообщение пользователя: распознанный голос или введенный текст. В случае распознанного голоса предоставляется текст запроса без нормализации числительных и другого, соответственно, все числа, номера телефонов и тд представлены словами.
+     * Исходное сообщение пользователя: распознанный голос или введенный текст.
+     * В случае распознанного голоса предоставляется текст запроса без нормализации числительных и другого,
+     * соответственно, все числа, номера телефонов и тд представлены словами.
      */
     original_text: string;
     /**
-     * Нормализованный текст, который ввел пользователь. Можно использовать для снижения многообразия запросов, например, для аналитики.
+     * Нормализованный текст, который ввел пользователь.
+     * Можно использовать для снижения многообразия запросов, например, для аналитики.
      */
@@ -774,3 +806,4 @@ normalized_text: string;
     /**
-     * true, если сообщение нужно отобразить в чате и отправить в бекэнд, false если сообщение нужно только отобразить в чате, и не отправлять на бекэнд
+     * true, если сообщение нужно отобразить в чате и отправить в бекэнд,
+     * false если сообщение нужно только отобразить в чате, и не отправлять на бекэнд
      */
@@ -807,3 +840,5 @@ should_send_to_backend?: boolean;
     /**
-     * Может содержать подстроку [[placeholder]]. Клиент должен подставить в строку шаблона вместо [[placeholder]] номер телефона контакта имеющий id указаный в send_contact_phone
+     * Может содержать подстроку [[placeholder]].
+     * Клиент должен подставить в строку шаблона вместо [[placeholder]]
+     * номер телефона контакта имеющий id указаный в send_contact_phone
      */
@@ -826,3 +861,5 @@ template?: string;
     /**
-     * Используется для фильтрации данных, явно указывающая на то, что server_action не может повлиять на состояние UI в SDK (фильтруется озвучка, саджесты и возможность открыть новый экран).
+     * Используется для фильтрации данных, явно указывающая на то,
+     * что server_action не может повлиять на состояние UI в SDK
+     * (фильтруется озвучка, саджесты и возможность открыть новый экран).
      */
@@ -1511,3 +1548,5 @@ mode?: 'background' | 'foreground';
 /**
- * Предложения, которые смартап может сделать пользователю в зависимости от контекста диалога. Предложения могут быть представлены в виде кнопок и карточек. Важно! В интерфейсе SberBox предложения носят информационный характер. Оформляйте их в виде подсказок, а не кнопок.
+ * Предложения, которые смартап может сделать пользователю в зависимости от контекста диалога.
+ * Предложения могут быть представлены в виде кнопок и карточек.
+ * Важно! В интерфейсе SberBox предложения носят информационный характер. Оформляйте их в виде подсказок, а не кнопок.
  */
@@ -1554,3 +1593,5 @@ export interface Suggestions {
     /**
-     * Позволяет выбирать модель распознавания речи в запросе. Если передаётся валидная модель (media или general), то в запросе она может быть изменена. Модель media распознаёт русский и английский языки. Модель general использует только русский язык.
+     * Позволяет выбирать модель распознавания речи в запросе.
+     * Если передаётся валидная модель (media или general), то в запросе она может быть изменена.
+     * Модель media распознаёт русский и английский языки. Модель general использует только русский язык.
      */
@@ -1557,0 +1598,0 @@ model?: 'media' | 'general';

dist/systemMessage.js

 "use strict";
+/* eslint-disable no-use-before-define */
 /* tslint:disable */
@@ -3,0 +4,0 @@ /**

package.json

 {
   "name": "@salutejs/types",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Scenario types for Salute family",
@@ -32,3 +32,3 @@ "author": "SberDevices Frontend Team <[e-mail]>",
   },
-  "gitHead": "40cd4fcb637366dc43fad1b9a1447b331e458fac"
+  "gitHead": "6967e37ba23ba2afdc6333afa3bf0b27e8383b59"
 }

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

180863

increased by0.25%

Lines of code

1906

increased by1.49%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes