@spectrum-ts/imessage 9.0.0 → 9.1.0

package/dist/index.d.ts

@@ -327,6 +327,33 @@ declare const imessage: import("@spectrum-ts/core").Platform<import("@spectrum-t
     id: string;
     __platform: string;
   }) => Promise<import("@spectrum-ts/core").AvatarData | undefined>;
+  getDisplayName: ({
+    client
+  }: {
+    client: IMessageClient;
+    config: {
+      local: true;
+    } | {
+      local: false;
+      clients?: {
+        address: string;
+        token: string;
+        phone: string;
+      } | {
+        address: string;
+        token: string;
+        phone: string;
+      }[] | undefined;
+    };
+    store: import("@spectrum-ts/core").Store;
+  }, space: {
+    id: string;
+    type: "dm" | "group";
+    phone: string;
+  } & {
+    id: string;
+    __platform: string;
+  }) => Promise<string | undefined>;
   getAttachment: ({
     client
   }: {

package/dist/index.js

@@ -1248,6 +1248,15 @@ const markRead$1 = async (remote, spaceId) => {
 const setDisplayName$1 = async (remote, spaceId, content) => {
 	await remote.groups.setDisplayName(toChatGuid(spaceId), content.displayName);
 };
+/**
+* Read a remote iMessage group chat's title. The SDK returns an empty
+* `Chat.displayName` for an unnamed group; normalized to `undefined`. The
+* group-only guard lives at the action layer (see `remoteGroupClient`).
+*/
+const getDisplayName$1 = async (remote, spaceId) => {
+	const { displayName } = await remote.chats.get(toChatGuid(spaceId));
+	return displayName || void 0;
+};
 //#endregion
 //#region src/remote/markdown.ts
 const markdownLexer = new Marked();
@@ -2155,6 +2164,7 @@ const messages = (clients, projectConfig) => messages$1(clients, projectConfig);
 const setBackground = async (remote, spaceId, content) => setBackground$1(remote, spaceId, content);
 const sendCustomizedMiniApp = async (remote, spaceId, content) => sendCustomizedMiniApp$1(remote, spaceId, content);
 const setDisplayName = async (remote, spaceId, content) => setDisplayName$1(remote, spaceId, content);
+const getDisplayName = async (remote, spaceId) => getDisplayName$1(remote, spaceId);
 const addParticipants = async (remote, spaceId, content) => addParticipants$1(remote, spaceId, content);
 const removeParticipants = async (remote, spaceId, content) => removeParticipants$1(remote, spaceId, content);
 const leaveGroup = async (remote, spaceId) => leaveGroup$1(remote, spaceId);
@@ -2530,6 +2540,12 @@ const imessage = definePlatform("iMessage", {
 				local: "fetching group avatars requires remote iMessage"
 			}), space.id);
 		},
+		getDisplayName: async ({ client }, space) => {
+			return await getDisplayName(remoteGroupClient(client, space, "getDisplayName", {
+				dm: "only group chats have display names (this space is a DM)",
+				local: "reading chat display names requires remote iMessage"
+			}), space.id);
+		},
 		getAttachment: async ({ client }, guid, phone) => {
 			if (isLocal(client)) throw UnsupportedError.action("getAttachment", "iMessage (local mode)", "fetching attachments by GUID requires remote iMessage");
 			if (client.length === 0) throw new Error("No iMessage clients configured");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spectrum-ts/imessage",
-  "version": "9.0.0",
+  "version": "9.1.0",
   "description": "iMessage provider for spectrum-ts — local and remote (advanced) modes.",
   "repository": {
     "type": "git",