@imessaging/core 0.5.0 → 0.7.0

package/package.json

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

package/src/index.ts

@@ -1,6 +1,13 @@
 export { MemoryPeerStore } from "./memory-peer-store";
 export { createPeerKey } from "./peer-key";
-export { canEdit, canReceive, canShowTyping, hasCommandMenu, isTelegramRecipient } from "./types";
+export {
+  canEdit,
+  canMarkRead,
+  canReceive,
+  canShowTyping,
+  hasCommandMenu,
+  isTelegramRecipient,
+} from "./types";
 export type { ButtonPress, ButtonPressTransport } from "./types";
 export type {
   ChannelCommand,
@@ -8,6 +15,7 @@ export type {
   IncomingAttachment,
   IncomingMessage,
   IncomingMessageTransport,
+  ReadReceiptTransport,
   TypingTransport,
 } from "./types";
 export type {
@@ -15,6 +23,8 @@ export type {
   EditableMessageTransport,
   EditResult,
   EmailRecipient,
+  HeadhunterRecipient,
+  MaxRecipient,
   MessageRecipient,
   MessageTransport,
   OutboundButton,

package/src/types.ts

@@ -25,7 +25,24 @@ export type EmailRecipient = {
   name?: string;
 };
 
-export type MessageRecipient = UsernameRecipient | TelegramIdRecipient | EmailRecipient;
+/** Чат MAX. `chatId` выдаёт API MAX; это не номер телефона пользователя. */
+export type MaxRecipient = {
+  type: "max";
+  chatId: string;
+};
+
+/** Диалог (отклик) HeadHunter, в который работодатель уже может написать. */
+export type HeadhunterRecipient = {
+  type: "headhunter";
+  negotiationId: string;
+};
+
+export type MessageRecipient =
+  | UsernameRecipient
+  | TelegramIdRecipient
+  | EmailRecipient
+  | MaxRecipient
+  | HeadhunterRecipient;
 
 /** Получатель, адресуемый в Telegram. Сужение для транспортов, которые кроме него ничего не умеют. */
 export type TelegramRecipient = UsernameRecipient | TelegramIdRecipient;
@@ -37,7 +54,12 @@ export type TelegramRecipient = UsernameRecipient | TelegramIdRecipient;
  * по местам использования `recipient.id` и в каждом будет своей.
  */
 export function isTelegramRecipient(recipient: MessageRecipient): recipient is TelegramRecipient {
-  return recipient.type !== "email";
+  return (
+    recipient.type === "username" ||
+    recipient.type === "user" ||
+    recipient.type === "group" ||
+    recipient.type === "channel"
+  );
 }
 
 export type OutboundDocument = {
@@ -152,6 +174,14 @@ export interface TelegramPeerStore {
 export type ButtonPress = {
   /** Кто нажал. `null` — отправитель неизвестен каналу. */
   senderId: number | null;
+  /**
+   * В каком чате нажали. `undefined` — канал чата не назвал.
+   *
+   * Нужен затем, что нажатие и сообщение одного чата обязаны исполняться по очереди: карточка
+   * живёт в чате, и ответ на кнопку, обогнавший идущий ответ агента, приходит человеку раньше того,
+   * на что он отвечает. По одному отправителю это не построить — в группе он не равен чату.
+   */
+  chatId?: string;
   data: string;
   /**
    * Подтвердить нажатие, показав человеку текст.
@@ -259,3 +289,18 @@ export interface TypingTransport extends MessageTransport {
 export function canShowTyping(transport: MessageTransport): transport is TypingTransport {
   return typeof (transport as TypingTransport).typing === "function";
 }
+
+/**
+ * Канал, умеющий отметить сообщение прочитанным.
+ *
+ * Не украшение: пока отметки нет, у собеседника горит непрочитанное, а у бота или учётной записи
+ * копится счётчик, по которому потом не отличить обработанное от пропущенного.
+ */
+export interface ReadReceiptTransport extends MessageTransport {
+  /** Отметить прочитанным всё до `messageId` включительно. */
+  markRead(recipient: MessageRecipient, messageId: string): Promise<void>;
+}
+
+export function canMarkRead(transport: MessageTransport): transport is ReadReceiptTransport {
+  return typeof (transport as ReadReceiptTransport).markRead === "function";
+}