@imessaging/core 0.8.2 → 0.8.4

package/package.json

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

package/src/index.ts

@@ -18,6 +18,9 @@ export {
   canMarkRead,
   canReact,
   canReceive,
+  canObserveOutgoing,
+  canReceiveEdits,
+  canSaveDraft,
   canShowTyping,
   hasCommandMenu,
   isTelegramRecipient,
@@ -36,6 +39,10 @@ export type {
 export type {
   EditableMessage,
   EditableMessageTransport,
+  DraftTransport,
+  EditedMessageTransport,
+  MessageDraft,
+  OutgoingObserverTransport,
   EditResult,
   EmailRecipient,
   HeadhunterRecipient,

package/src/markup.ts

@@ -13,7 +13,20 @@
 /** Как написан исходный текст сообщения. */
 export type TextFormat = "plain" | "markdown" | "html";
 
-export type TextEntityType = "bold" | "italic" | "underline" | "strike" | "code" | "pre" | "link";
+/**
+ * Общая модель для всех каналов: Telegram и MAX отдают выделения со смещениями, WhatsApp — звёздочки в тексте,
+ * почта — HTML; транспорт переводит своё в эти типы, а для чего пары нет (упоминания, хэштеги) — отбрасывает.
+ */
+export type TextEntityType =
+  | "bold"
+  | "italic"
+  | "underline"
+  | "strike"
+  | "spoiler"
+  | "code"
+  | "pre"
+  | "link"
+  | "quote";
 
 export type TextEntity = {
   type: TextEntityType;
@@ -96,6 +109,14 @@ function parseInline(src: string, out: Builder): void {
     }
 
     const pair = src.slice(i, i + 2);
+    if (pair === "||" && !isSpace(src[i + 2])) {
+      const end = findCloser(src, i + 2, "||", (at) => at > i + 2 && !isSpace(src[at - 1]));
+      if (end !== -1) {
+        wrap(out, "spoiler", () => parseInline(src.slice(i + 2, end), out));
+        i = end + 2;
+        continue;
+      }
+    }
     if (pair === "**" || pair === "__" || pair === "~~") {
       // `__` — жирный только на границе слова: `snake__case` остаётся как есть.
       const bounded = pair === "__";
@@ -166,8 +187,27 @@ export function parseMarkdown(source: string): FormattedText {
 
 function parseLines(block: string, out: Builder): void {
   const lines = block.split("\n");
+  // Подряд идущие строки `> …` — одна цитата, как её показывает любой мессенджер.
+  let quote: { offset: number; at: number } | undefined;
+  const closeQuote = (end: number) => {
+    if (quote && end > quote.offset) {
+      out.entities.splice(quote.at, 0, {
+        type: "quote",
+        offset: quote.offset,
+        length: end - quote.offset,
+      });
+    }
+    quote = undefined;
+  };
   lines.forEach((line, n) => {
+    const quoted = /^>\s?(.*)$/.exec(line);
+    if (!quoted) closeQuote(out.text.length);
     if (n > 0) out.text += "\n";
+    if (quoted) {
+      quote ??= { offset: out.text.length, at: out.entities.length };
+      parseInline(quoted[1]!, out);
+      return;
+    }
     const heading = /^#{1,6}\s+(.*?)\s*#*$/.exec(line);
     if (heading) {
       wrap(out, "bold", () => parseInline(heading[1]!, out));
@@ -175,6 +215,7 @@ function parseLines(block: string, out: Builder): void {
     }
     parseInline(line.replace(/^(\s*)[*•●·]\s+/, "$1- "), out);
   });
+  closeQuote(out.text.length);
 }
 
 const HTML_TAGS: Record<string, TextEntityType> = {
@@ -190,6 +231,8 @@ const HTML_TAGS: Record<string, TextEntityType> = {
   code: "code",
   pre: "pre",
   a: "link",
+  "tg-spoiler": "spoiler",
+  blockquote: "quote",
 };
 
 function decodeHtml(s: string): string {
@@ -310,6 +353,10 @@ function openTag(e: TextEntity): string {
       return e.language ? `<pre><code class="language-${escapeAttribute(e.language)}">` : "<pre>";
     case "link":
       return `<a href="${escapeAttribute(e.url ?? "")}">`;
+    case "spoiler":
+      return "<tg-spoiler>";
+    case "quote":
+      return "<blockquote>";
   }
 }
 
@@ -319,9 +366,11 @@ function closeTag(e: TextEntity): string {
     italic: "i",
     underline: "u",
     strike: "s",
+    spoiler: "tg-spoiler",
     code: "code",
     pre: "pre",
     link: "a",
+    quote: "blockquote",
   }[e.type];
   return e.type === "pre" && e.language ? "</code></pre>" : `</${name}>`;
 }

package/src/types.ts

@@ -1,4 +1,4 @@
-import type { TextFormat } from "./markup";
+import type { TextEntity, TextFormat } from "./markup";
 
 export type UsernameRecipient = {
   type: "username";
@@ -300,6 +300,16 @@ export type IncomingMessage = {
   editedAt?: Date;
   /** В сообщении упомянут аккаунт или это ответ на его сообщение (так Telegram определяет упоминание); нет — канал не сообщает. */
   mentionsMe?: boolean;
+  /**
+   * Только в onOutgoing/onOutgoingEdit: сообщение отправил или поправил сам транспорт (send/edit), а не человек
+   * с другого устройства. Помечается, а не отбрасывается: иначе своя отправка выглядела бы правкой оператора.
+   */
+  sentByTransport?: boolean;
+  /**
+   * Форматирование текста в той же модели, что исходящая разметка, смещения в UTF-16;
+   * undefined = канал не сообщает форматирование, [] = сообщил, форматирования нет.
+   */
+  entities?: TextEntity[];
   attachments: IncomingAttachment[];
   /**
    * Адреса из сообщения, в порядке появления.
@@ -348,6 +358,57 @@ export function canReceive(transport: MessageTransport): transport is IncomingMe
   return typeof (transport as IncomingMessageTransport).onMessage === "function";
 }
 
+/**
+ * Канал, умеющий сообщать о правках сообщений.
+ *
+ * Отдельная подписка, потому что подписчики onMessage не ждут правок и сочтут повторный
+ * messageId за новое сообщение.
+ */
+export interface EditedMessageTransport extends MessageTransport {
+  onEdit(handler: (message: IncomingMessage) => void | Promise<void>): () => void;
+}
+
+export function canReceiveEdits(transport: MessageTransport): transport is EditedMessageTransport {
+  return typeof (transport as EditedMessageTransport).onEdit === "function";
+}
+
+/** Черновик в поле ввода чата: ответ готовит машина, отправляет человек. */
+export type MessageDraft = {
+  recipient: MessageRecipient;
+  /** Текст черновика; пустой — очистить черновик. */
+  text: string;
+  /** Как написан `text`; не задан — простой текст, без разбора разметки. */
+  format?: TextFormat;
+  /** Черновик ответом на это сообщение. */
+  replyToMessageId?: string;
+};
+
+export interface DraftTransport extends MessageTransport {
+  saveDraft(draft: MessageDraft): Promise<void>;
+}
+
+export function canSaveDraft(transport: MessageTransport): transport is DraftTransport {
+  return typeof (transport as DraftTransport).saveDraft === "function";
+}
+
+/**
+ * Свои исходящие учётки — то, что человек отправил или поправил с другого устройства. Отдельной подпиской:
+ * onMessage и onEdit своё не отдают и отдавать не должны — иначе шлюз отвечал бы сам себе.
+ */
+export interface OutgoingObserverTransport extends MessageTransport {
+  onOutgoing(handler: (message: IncomingMessage) => void | Promise<void>): () => void;
+  onOutgoingEdit(handler: (message: IncomingMessage) => void | Promise<void>): () => void;
+}
+
+export function canObserveOutgoing(
+  transport: MessageTransport,
+): transport is OutgoingObserverTransport {
+  const candidate = transport as OutgoingObserverTransport;
+  return (
+    typeof candidate.onOutgoing === "function" && typeof candidate.onOutgoingEdit === "function"
+  );
+}
+
 /** Пункт меню команд канала: `/menu` и подпись рядом с ним. */
 export type ChannelCommand = {
   /** Без ведущей косой черты. */