@imessaging/core 0.8.9 → 0.8.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@imessaging/core",
-  "version": "0.8.9",
+  "version": "0.8.11",
   "description": "Core messaging transport contracts and Telegram peer storage",
   "keywords": [
     "messaging",

package/src/index.ts

@@ -16,6 +16,7 @@ export { createPeerKey } from "./peer-key";
 export {
   canEdit,
   canFindByPhone,
+  canGetPeerInfo,
   canSaveContact,
   canMarkRead,
   canObserveOutgoingRead,
@@ -53,6 +54,8 @@ export type {
   PhoneLookupOptions,
   PhoneLookupTransport,
   PhoneMatch,
+  PeerInfo,
+  PeerInfoTransport,
   EditResult,
   EmailRecipient,
   HeadhunterRecipient,

package/src/types.ts

@@ -84,6 +84,11 @@ export type OutboundMessage = {
   threadId?: number;
   documents?: OutboundDocument[];
   buttons?: OutboundButton[][];
+  /**
+   * Снять постоянную клавиатуру (ReplyKeyboardMarkup) у собеседника. Действует без `buttons`;
+   * канал без такой клавиатуры поле не замечает.
+   */
+  removeKeyboard?: boolean;
   /**
    * Как написан `text`: транспорт сам переводит разметку в формат своего канала — Telegram и MAX
    * получают выделения, почта HTML и простой текст, hh простой текст. Не задан — прежнее поведение
@@ -99,6 +104,8 @@ export type SendResult = {
   transportId: string;
   messageId: string;
   recipientId: string;
+  /** Получатель — взаимный контакт учётки. Нет — канал не прислал пользователя в ответе на отправку. */
+  mutualContact?: boolean;
 };
 
 /**
@@ -283,6 +290,8 @@ export type IncomingMessage = {
   senderUsername?: string;
   /** Как отправитель назван в канале: «Имя Фамилия» человека или название чата. */
   senderName?: string;
+  /** Отправитель — взаимный контакт учётки. Нет — канал не сообщает или отправитель не человек. */
+  senderMutualContact?: boolean;
   /**
    * Как назван САМ ЧАТ: название группы или канала, в личке — имя собеседника. По нему человек
    * выбирает чат из списка; номер `-100…` ему ничего не говорит. Нет — канал имени не прислал.
@@ -441,6 +450,26 @@ export function canFindByPhone(transport: MessageTransport): transport is PhoneL
   return typeof (transport as PhoneLookupTransport).findByPhone === "function";
 }
 
+/** Что учётка знает о собеседнике: есть ли он в её контактах и взаимно ли. */
+export type PeerInfo = {
+  id: string;
+  username?: string;
+  /** Собеседник в адресной книге учётки. */
+  contact: boolean;
+  /** И учётка в его книге: на взаимных не действует спам-лимит PEER_FLOOD. */
+  mutualContact: boolean;
+};
+
+/** Сведения о собеседнике до отправки. Без поиска по телефону: только кэш пиров и @username. */
+export interface PeerInfoTransport extends MessageTransport {
+  /** `null` — пир не известен и разрешить его не по чему, либо это не пользователь. */
+  peerInfo(recipient: MessageRecipient): Promise<PeerInfo | null>;
+}
+
+export function canGetPeerInfo(transport: MessageTransport): transport is PeerInfoTransport {
+  return typeof (transport as PeerInfoTransport).peerInfo === "function";
+}
+
 /** Карточка контакта в адресной книге учётки: имя и заметка о человеке, текст заметки даёт продукт. */
 export type ContactCard = {
   userId: string;