@imessaging/core 0.1.0 → 0.2.0

package/package.json

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

package/src/index.ts

@@ -1,6 +1,10 @@
 export { MemoryPeerStore } from "./memory-peer-store";
 export { createPeerKey } from "./peer-key";
+export { canEdit } from "./types";
 export type {
+  EditableMessage,
+  EditableMessageTransport,
+  EditResult,
   MessageRecipient,
   MessageTransport,
   OutboundButton,

package/src/types.ts

@@ -41,6 +41,29 @@ export type SendResult = {
   recipientId: string;
 };
 
+/**
+ * Правка уже отправленного сообщения.
+ *
+ * Адресуется парой «получатель + идентификатор сообщения»: сам по себе идентификатор в Telegram
+ * не уникален, он нумеруется В ПРЕДЕЛАХ чата, и без получателя правка ушла бы не туда.
+ *
+ * Вложения не правятся: у отправленного сообщения меняется текст и разметка, а документы уже
+ * доставлены отдельными сообщениями. Обещать здесь `documents` значило бы обещать невыполнимое.
+ */
+export type EditableMessage = {
+  recipient: MessageRecipient;
+  messageId: string;
+  text: string;
+  buttons?: OutboundButton[][];
+  parseMode?: "HTML" | "Markdown" | "MarkdownV2";
+};
+
+export type EditResult = {
+  transportId: string;
+  messageId: string;
+  recipientId: string;
+};
+
 export type TransportStatus = {
   connected: boolean;
   transportId: string;
@@ -57,6 +80,21 @@ export interface MessageTransport {
   getStatus(): Promise<TransportStatus>;
 }
 
+/**
+ * Транспорт, умеющий править отправленное.
+ *
+ * Отдельный интерфейс, а не метод в `MessageTransport`: править умеет не всякий канал, и обещать
+ * это всем транспортам значит заставить каждый новый бросать «не поддерживается». Потребитель
+ * спрашивает возможность типом (`canEdit`), а не ловит исключение.
+ */
+export interface EditableMessageTransport extends MessageTransport {
+  edit(message: EditableMessage): Promise<EditResult>;
+}
+
+export function canEdit(transport: MessageTransport): transport is EditableMessageTransport {
+  return typeof (transport as EditableMessageTransport).edit === "function";
+}
+
 export type ResolvedPeer = {
   type: "user" | "group" | "channel";
   id: string;