@spectrum-ts/imessage 9.0.0 → 9.3.0

package/dist/index.d.ts

@@ -141,6 +141,7 @@ declare const customizedMiniAppSchema: z.ZodObject<{
     imageSubtitle: z.ZodOptional<z.ZodString>;
     summary: z.ZodOptional<z.ZodString>;
   }, z.core.$strip>;
+  live: z.ZodOptional<z.ZodBoolean>;
   teamId: z.ZodString;
   url: z.ZodURL;
 }, z.core.$strip>;
@@ -155,7 +156,8 @@ type CustomizedMiniAppInput = Omit<CustomizedMiniApp, "type" | "__platform">;
  * the recipient taps the card; the server constructs the matching
  * `MSMessageExtensionBalloonPlugin` plugin id from these values. `appStoreId`
  * is optional and only points recipients without the extension at its App
- * Store entry.
+ * Store entry. `live` is optional; when omitted, the remote server keeps the
+ * static layout preview visible.
  *
  * `space.send(customizedMiniApp(...))` is the canonical form.
  *
@@ -193,8 +195,25 @@ declare const spaceSchema: z.ZodObject<{
   }>;
   phone: z.ZodString;
 }, z.core.$strip>;
+declare const miniAppCardSessionSchema: z.ZodObject<{
+  chatGuid: z.ZodString;
+  messageGuid: z.ZodString;
+  sessionId: z.ZodString;
+  targetMessageGuid: z.ZodString;
+}, z.core.$strip>;
+/**
+ * iMessage-specific per-message metadata surfaced on `IMessageMessage`.
+ * - `partIndex`: ordered part index within a multi-part message. Text and
+ *   attachment parts both consume an index (0 for bare or single-part
+ *   messages; 0..N-1 for a group's sub-items).
+ * - `parentId`: guid of the parent message for a group sub-item. Undefined
+ *   when the message itself is the parent.
+ * - `miniAppCardSession`: stable handle returned by mini-app card sends and
+ *   updates. It is required to update the card in place later.
+ */
 type IMessageMessage = SchemaMessage<typeof userSchema, typeof spaceSchema> & {
   direction?: "inbound" | "outbound";
+  miniAppCardSession?: z.infer<typeof miniAppCardSessionSchema>;
   partIndex?: number;
   parentId?: string;
 };
@@ -238,6 +257,12 @@ declare const imessage: import("@spectrum-ts/core").Platform<import("@spectrum-t
   type: "dm" | "group";
   phone: string;
 }, import("zod").ZodObject<{
+  miniAppCardSession: import("zod").ZodOptional<import("zod").ZodObject<{
+    chatGuid: import("zod").ZodString;
+    messageGuid: import("zod").ZodString;
+    sessionId: import("zod").ZodString;
+    targetMessageGuid: import("zod").ZodString;
+  }, import("zod/v4/core").$strip>>;
   partIndex: import("zod").ZodOptional<import("zod").ZodNumber>;
   parentId: import("zod").ZodOptional<import("zod").ZodString>;
 }, import("zod/v4/core").$strip>, IMessageMessage, undefined, {
@@ -327,6 +352,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

@@ -124,6 +124,7 @@ const customizedMiniAppSchema = z.object({
 	appStoreId: z.number().int().positive().optional(),
 	extensionBundleId: z.string().nonempty(),
 	layout: layoutSchema,
+	live: z.boolean().optional(),
 	teamId: z.string(),
 	url: z.url()
 });
@@ -141,7 +142,8 @@ const asCustomizedMiniApp = (input) => customizedMiniAppSchema.parse({
 * the recipient taps the card; the server constructs the matching
 * `MSMessageExtensionBalloonPlugin` plugin id from these values. `appStoreId`
 * is optional and only points recipients without the extension at its App
-* Store entry.
+* Store entry. `live` is optional; when omitted, the remote server keeps the
+* static layout preview visible.
 *
 * `space.send(customizedMiniApp(...))` is the canonical form.
 *
@@ -202,6 +204,12 @@ const spaceSchema = z.object({
 	phone: z.string()
 });
 const spaceParamsSchema = z.object({ phone: z.string().optional() });
+const miniAppCardSessionSchema = z.object({
+	chatGuid: z.string(),
+	messageGuid: z.string(),
+	sessionId: z.string(),
+	targetMessageGuid: z.string()
+});
 /**
 * iMessage-specific per-message metadata surfaced on `IMessageMessage`.
 * - `partIndex`: ordered part index within a multi-part message. Text and
@@ -209,8 +217,11 @@ const spaceParamsSchema = z.object({ phone: z.string().optional() });
 *   messages; 0..N-1 for a group's sub-items).
 * - `parentId`: guid of the parent message for a group sub-item. Undefined
 *   when the message itself is the parent.
+* - `miniAppCardSession`: stable handle returned by mini-app card sends and
+*   updates. It is required to update the card in place later.
 */
 const messageSchema = z.object({
+	miniAppCardSession: miniAppCardSessionSchema.optional(),
 	partIndex: z.number().int().nonnegative().optional(),
 	parentId: z.string().optional()
 });
@@ -789,6 +800,14 @@ const shareContactCard$1 = async (remote, spaceId) => {
 };
 //#endregion
 //#region src/remote/customized-mini-app.ts
+const toProviderRecord = (result, content, spaceId) => ({
+	id: result.guid,
+	content,
+	direction: "outbound",
+	miniAppCardSession: result.miniAppCardSession,
+	space: { id: spaceId },
+	timestamp: result.dateCreated
+});
 /**
 * Send a `CustomizedMiniApp` card to a remote iMessage chat.
 *
@@ -800,14 +819,10 @@ const shareContactCard$1 = async (remote, spaceId) => {
 */
 const sendCustomizedMiniApp$1 = async (remote, spaceId, content) => {
 	const chat = toChatGuid(spaceId);
-	const message = await remote.messages.sendCustomizedMiniApp(chat, content);
-	return {
-		id: message.guid,
-		content,
-		direction: "outbound",
-		space: { id: spaceId },
-		timestamp: message.dateCreated
-	};
+	return toProviderRecord(await remote.messages.sendCustomizedMiniApp(chat, content), content, spaceId);
+};
+const updateCustomizedMiniApp$1 = async (remote, spaceId, session, content) => {
+	return toProviderRecord(await remote.messages.updateCustomizedMiniApp(session, content), content, spaceId);
 };
 //#endregion
 //#region src/remote/attachments.ts
@@ -1248,6 +1263,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();
@@ -2154,7 +2178,9 @@ const stopTyping$1 = async (remote, spaceId) => {
 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 updateCustomizedMiniApp = async (remote, spaceId, session, content) => updateCustomizedMiniApp$1(remote, spaceId, session, 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);
@@ -2198,13 +2224,14 @@ const SPECTRUM_MINI_APP = {
 };
 /**
 * Build the iMessage mini-app card for an `app` content: Spectrum's fixed
-* identity plus the per-message `url` and the `layout` already derived from the
-* URL's link metadata.
+* identity plus the per-message `url`, optional live-rendering hint, and the
+* `layout` already derived from the URL's link metadata.
 */
-const toSpectrumMiniApp = (url, layout) => asCustomizedMiniApp({
+const toSpectrumMiniApp = (url, layout, live) => asCustomizedMiniApp({
 	...SPECTRUM_MINI_APP,
 	url,
-	layout
+	layout,
+	...live === void 0 ? {} : { live }
 });
 //#endregion
 //#region src/remote/client.ts
@@ -2249,6 +2276,25 @@ const cacheRemoteOutbound = (remote, space, record) => {
 };
 const handleEdit = async (client, space, content) => {
 	if (isLocal(client)) throw UnsupportedError.action("edit", "iMessage (local mode)");
+	const miniAppCardSession = content.target.miniAppCardSession;
+	const updateMiniAppCardSession = (record) => {
+		const nextSession = record?.miniAppCardSession;
+		if (nextSession) content.target.miniAppCardSession = nextSession;
+	};
+	if (content.content.type === "app") {
+		if (!miniAppCardSession) throw UnsupportedError.content("edit", "iMessage", "mini app card edits require a miniAppCardSession from the original send");
+		const url = await content.content.url();
+		const layout = await content.content.layout();
+		const remote = clientForPhone(client, space.phone);
+		updateMiniAppCardSession(cacheRemoteOutbound(remote, space, await updateCustomizedMiniApp(remote, space.id, miniAppCardSession, toSpectrumMiniApp(url, layout, content.content.live))));
+		return;
+	}
+	if (isCustomizedMiniApp(content.content)) {
+		if (!miniAppCardSession) throw UnsupportedError.content("edit", "iMessage", "customized mini app card edits require a miniAppCardSession from the original send");
+		const remote = clientForPhone(client, space.phone);
+		updateMiniAppCardSession(cacheRemoteOutbound(remote, space, await updateCustomizedMiniApp(remote, space.id, miniAppCardSession, content.content)));
+		return;
+	}
 	if (content.content.type !== "text") throw UnsupportedError.content("edit", "iMessage", `only text content can be edited (got "${content.content.type}")`);
 	await editMessage(clientForPhone(client, space.phone), space.id, content.target.id, content.content);
 };
@@ -2288,7 +2334,7 @@ const handleApp = async (client, space, content) => {
 	if (isLocal(client)) return await send$2(client, space.id, await text(url).build());
 	const layout = await content.layout();
 	const remote = clientForPhone(client, space.phone);
-	return cacheRemoteOutbound(remote, space, await sendCustomizedMiniApp(remote, space.id, toSpectrumMiniApp(url, layout)));
+	return cacheRemoteOutbound(remote, space, await sendCustomizedMiniApp(remote, space.id, toSpectrumMiniApp(url, layout, content.live)));
 };
 const handleRead = async (client, space) => {
 	if (isLocal(client)) throw UnsupportedError.action("read", "iMessage (local mode)", "marking chats as read requires remote iMessage");
@@ -2530,6 +2576,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.3.0",
   "description": "iMessage provider for spectrum-ts — local and remote (advanced) modes.",
   "repository": {
     "type": "git",
@@ -31,7 +31,7 @@
     "label": "iMessage"
   },
   "dependencies": {
-    "@photon-ai/advanced-imessage": "^0.12.0",
+    "@photon-ai/advanced-imessage": "^1.0.0",
     "@photon-ai/imessage-kit": "^3.0.0",
     "@photon-ai/otel": "^3.1.0",
     "lru-cache": "^11.0.0",