@imessaging/core 0.3.0 → 0.4.0

package/package.json

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

package/src/index.ts

@@ -1,6 +1,7 @@
 export { MemoryPeerStore } from "./memory-peer-store";
 export { createPeerKey } from "./peer-key";
 export { canEdit, isTelegramRecipient } from "./types";
+export type { ButtonPress, ButtonPressTransport } from "./types";
 export type {
   EditableMessage,
   EditableMessageTransport,

package/src/types.ts

@@ -142,3 +142,33 @@ export interface TelegramPeerStore {
   ): Promise<void>;
   delete(accountId: string, recipient: MessageRecipient): Promise<void>;
 }
+
+/**
+ * Нажатие на кнопку под сообщением.
+ *
+ * `data` — то, что положили в `OutboundButton.callbackData`. Транспорт не пытается его понимать:
+ * смысл строки принадлежит продукту, а не каналу связи.
+ */
+export type ButtonPress = {
+  /** Кто нажал. `null` — отправитель неизвестен каналу. */
+  senderId: number | null;
+  data: string;
+  /**
+   * Подтвердить нажатие, показав человеку текст.
+   *
+   * Вызывать ОБЯЗАТЕЛЬНО: Telegram крутит на кнопке часы, пока не получит ответ, и человек видит
+   * зависшую кнопку даже при успешно выполненном действии.
+   */
+  answer(text: string): Promise<void>;
+};
+
+/**
+ * Канал, умеющий не только слать, но и ПРИНИМАТЬ нажатия.
+ *
+ * Отдельно от `MessageTransport`, потому что умеют не все: почта кнопок не имеет вовсе, а
+ * реализация, которая только шлёт, не должна объяснять, почему у неё пустой приём.
+ */
+export interface ButtonPressTransport {
+  /** Подписаться на нажатия. Возврат — функция отписки. */
+  onButtonPress(handler: (press: ButtonPress) => void | Promise<void>): () => void;
+}