@imessaging/core 0.8.5 → 0.8.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@imessaging/core",
-  "version": "0.8.5",
+  "version": "0.8.7",
   "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,
+  canSaveContact,
   canMarkRead,
   canReact,
   canReceive,
@@ -40,10 +41,13 @@ export type {
 export type {
   EditableMessage,
   EditableMessageTransport,
+  ContactCard,
+  ContactTransport,
   DraftTransport,
   EditedMessageTransport,
   MessageDraft,
   OutgoingObserverTransport,
+  PhoneLookupOptions,
   PhoneLookupTransport,
   PhoneMatch,
   EditResult,

package/src/types.ts

@@ -412,19 +412,49 @@ export function canObserveOutgoing(
 /** Учётка, найденная по номеру телефона. */
 export type PhoneMatch = { userId: string; username?: string; firstName?: string };
 
+export type PhoneLookupOptions = {
+  /**
+   * Контакт, заведённый ради поиска, остаётся в адресной книге (по умолчанию): с человеком будут работать, и
+   * оператор на телефоне видит его имя, а не номер. `false` — удалить сразу, для массового перебора номеров.
+   */
+  keepContact?: boolean;
+  /** Имя контакта; без него — сам номер. */
+  firstName?: string;
+  lastName?: string;
+};
+
 /**
  * Поиск учётки по номеру телефона — когда о человеке известен только номер. Найденный пир транспорт
  * запоминает: следующий send по `{ type: "user", id: userId }` уходит без повторного поиска.
  */
 export interface PhoneLookupTransport extends MessageTransport {
   /** Номер — E.164 (`+79991234567`). Не найден — `null`; прочие отказы канала — исключением с его текстом. */
-  findByPhone(phone: string): Promise<PhoneMatch | null>;
+  findByPhone(phone: string, options?: PhoneLookupOptions): Promise<PhoneMatch | null>;
 }
 
 export function canFindByPhone(transport: MessageTransport): transport is PhoneLookupTransport {
   return typeof (transport as PhoneLookupTransport).findByPhone === "function";
 }
 
+/** Карточка контакта в адресной книге учётки: имя и заметка о человеке, текст заметки даёт продукт. */
+export type ContactCard = {
+  userId: string;
+  /** E.164; нужен, только если номер ещё не известен учётке. */
+  phone?: string;
+  firstName: string;
+  lastName?: string;
+  note?: string;
+};
+
+/** Сохранить или обновить контакт — тем же вызовом: есть контакт — имя и заметка перезаписываются. */
+export interface ContactTransport extends MessageTransport {
+  saveContact(contact: ContactCard): Promise<void>;
+}
+
+export function canSaveContact(transport: MessageTransport): transport is ContactTransport {
+  return typeof (transport as ContactTransport).saveContact === "function";
+}
+
 /** Пункт меню команд канала: `/menu` и подпись рядом с ним. */
 export type ChannelCommand = {
   /** Без ведущей косой черты. */