@spectrum-ts/imessage 12.2.0 → 12.4.0

package/dist/index.js

@@ -1,4 +1,4 @@
-import { NotFoundError, ValidationError, createGrpcClient } from "@photon-ai/advanced-imessage/grpc";
+import { ErrorCode, NotFoundError, ValidationError, createGrpcClient } from "@photon-ai/advanced-imessage/grpc";
 import { sanitizePhone, withSpan } from "@photon-ai/otel";
 import { UnsupportedError, appLayoutSchema, cloud, definePlatform, fromVCard, mergeStreams, read, text, toVCard } from "@spectrum-ts/core";
 import { addMemberSchema, asAttachment, asContact, asCustom, asGroup, asPoll, asPollOption, asReply, asText, asVoice, avatarSchema, buildPhotoAction, createLogger, createTokenRenewal, ensureM4a, errorAttrs, groupSchema, leaveSpaceSchema, messageEffectSchema, photoActionSchema, reactionSchema, removeMemberSchema, renameSchema, resumableOrderedStream, sanitizeErrorMessage } from "@spectrum-ts/core/authoring";
@@ -671,7 +671,7 @@ const getRemoteAttachment = async (client, guid) => {
 };
 //#endregion
 //#region src/remote/inbound.ts
-const log$3 = createLogger("spectrum.imessage.inbound");
+const log$4 = createLogger("spectrum.imessage.inbound");
 const messageAttachments = (message) => message.content.attachments;
 const resolveChatGuid = (message, hint) => {
 	if (hint) return hint;
@@ -735,7 +735,7 @@ const toVCardContent = async (client, info) => {
 	try {
 		return asContact(fromVCard((await downloadPrimaryAttachment(client, info.guid)).toString("utf8")));
 	} catch (err) {
-		log$3.warn("failed to parse vCard attachment; falling back to attachment content", {
+		log$4.warn("failed to parse vCard attachment; falling back to attachment content", {
 			"spectrum.imessage.attachment.guid": info.guid,
 			...errorAttrs(err)
 		}, err);
@@ -823,7 +823,7 @@ const resolveReplyTarget = async (client, base, targetGuid, currentGuid, options
 		if (options.cache) cacheMessage(options.cache, rebuilt);
 		return rebuilt;
 	} catch (err) {
-		if (!(err instanceof NotFoundError)) log$3.warn("failed to resolve iMessage reply target; falling back to stub target", {
+		if (!(err instanceof NotFoundError)) log$4.warn("failed to resolve iMessage reply target; falling back to stub target", {
 			"spectrum.imessage.message.guid": currentGuid,
 			"spectrum.imessage.reply.target_guid": targetGuid,
 			...errorAttrs(err)
@@ -1503,9 +1503,10 @@ const randomPhone = (clients) => {
 };
 //#endregion
 //#region src/remote/contact-share.ts
-const log$2 = createLogger("spectrum.imessage.contact");
+const log$3 = createLogger("spectrum.imessage.contact");
 const SHARE_TTL_MS = 1440 * 60 * 1e3;
 const MAX_TRACKED_CHATS = 1e4;
+const isPreconditionFailure = (error) => typeof error === "object" && error !== null && "code" in error && error.code === ErrorCode.preconditionFailed;
 /**
 * Tracks which chats this bot's line has already proactively pushed its contact
 * card to, so `im.chats.shareContactInfo` is fired at most once per chat per
@@ -1529,21 +1530,31 @@ var ContactShareTracker = class {
 		this.client = client;
 	}
 	/**
+	* Whether this line has already attempted to share with the chat during the
+	* 24-hour dedupe window. Callers use this before consulting any remote gate,
+	* so repeat inbound messages stay entirely local.
+	*/
+	hasRecentlyShared(chatGuid) {
+		return this.cache.has(chatGuid);
+	}
+	/**
 	* Best-effort share. The cache is set eagerly so that a burst of inbound
-	* messages for the same chat coalesces to a single API call. On failure the
-	* entry is evicted so the next inbound retries — transient errors don't
-	* permanently mute the feature for a chat. Never awaits and never throws:
-	* the receive stream must not crash on share failures.
+	* messages for the same chat coalesces to a single API call. A
+	* `preconditionFailed` response remains cached for the normal 24-hour TTL,
+	* avoiding repeated attempts when the account cannot currently share its
+	* profile. Other failures evict the entry so the next inbound retries.
+	* Never awaits and never throws: the receive stream must not crash on share
+	* failures.
 	*/
 	maybeShare(chatGuid) {
 		if (this.cache.has(chatGuid)) return;
 		this.cache.set(chatGuid, true);
 		const safeChatGuid = sanitizeErrorMessage(chatGuid);
 		this.client.chats.shareContactInfo(chatGuid).then(() => {
-			log$2.info("shared contact card", { "spectrum.imessage.contact.chat": safeChatGuid });
+			log$3.info("shared contact card", { "spectrum.imessage.contact.chat": safeChatGuid });
 		}).catch((error) => {
-			this.cache.delete(chatGuid);
-			log$2.warn("failed to share contact card", {
+			if (!isPreconditionFailure(error)) this.cache.delete(chatGuid);
+			log$3.warn("failed to share contact card", {
 				"spectrum.imessage.contact.chat": safeChatGuid,
 				...errorAttrs(error)
 			}, error);
@@ -1569,7 +1580,7 @@ const getContactShareTracker = (client) => {
 };
 //#endregion
 //#region src/remote/group-events.ts
-const log$1 = createLogger("spectrum.imessage.group");
+const log$2 = createLogger("spectrum.imessage.group");
 /**
 * Synthetic id for a `group.changed` event — shared between the stream item
 * (the dedup key across live/catch-up) and the surfaced message. `sequence`
@@ -1599,7 +1610,7 @@ const fetchIconContent = async (client, event) => {
 			}
 		});
 	} catch (e) {
-		log$1.error("failed to fetch changed group icon", {
+		log$2.error("failed to fetch changed group icon", {
 			"spectrum.imessage.group.chat": event.chatGuid,
 			...errorAttrs(e)
 		}, e);
@@ -1654,7 +1665,7 @@ const toGroupEventMessages = async (client, event, phone) => {
 };
 //#endregion
 //#region src/remote/polls.ts
-const log = createLogger("spectrum.imessage.poll");
+const log$1 = createLogger("spectrum.imessage.poll");
 const isVotedPollEvent = (event) => event.delta.type === "voted";
 const isUnvotedPollEvent = (event) => event.delta.type === "unvoted";
 const toCachedPoll = (input) => {
@@ -1686,7 +1697,7 @@ const cachePollEvent = (cache, event) => {
 		cache.set(event.pollMessageGuid, cached);
 		return cached;
 	} catch (e) {
-		log.error("failed to cache poll", {
+		log$1.error("failed to cache poll", {
 			"spectrum.imessage.poll.guid": event.pollMessageGuid,
 			...errorAttrs(e)
 		}, e);
@@ -1698,7 +1709,7 @@ const fetchPollInfo = async (client, cache, event) => {
 		cachePollInfo(cache, info);
 		return info;
 	} catch (e) {
-		log.error("failed to fetch poll", {
+		log$1.error("failed to fetch poll", {
 			"spectrum.imessage.poll.guid": event.pollMessageGuid,
 			...errorAttrs(e)
 		}, e);
@@ -1711,7 +1722,7 @@ const resolvePoll = async (client, cache, event) => {
 	try {
 		return cachePollInfo(cache, await client.polls.get(event.pollMessageGuid));
 	} catch (e) {
-		log.error("failed to resolve poll", {
+		log$1.error("failed to resolve poll", {
 			"spectrum.imessage.poll.guid": event.pollMessageGuid,
 			...errorAttrs(e)
 		}, e);
@@ -1928,14 +1939,23 @@ const clientStream = (client, pollCache, phone, includeGroupEvents, onInbound, r
 	if (includeGroupEvents) streams.push(groupStream(client, phone, recover));
 	return mergeStreams(streams);
 };
-const messages$1 = (clients, projectConfig) => {
+const shareWhenProfileSynced = (tracker, gate, chatGuid) => {
+	if (tracker.hasRecentlyShared(chatGuid)) return;
+	gate.isEnabled().then((enabled) => {
+		if (enabled) tracker.maybeShare(chatGuid);
+	}).catch((error) => {
+		streamLog.warn("profile sync gate failed; skipping automatic contact sharing", errorAttrs(error), error instanceof Error ? error : void 0);
+	});
+};
+const contactShareHandler = (tracker, profileSyncGate) => profileSyncGate ? (chatGuid) => shareWhenProfileSynced(tracker, profileSyncGate, chatGuid) : (chatGuid) => tracker.maybeShare(chatGuid);
+const messages$1 = (clients, projectConfig, profileSyncGate) => {
 	const pollCache = getPollCache(clients);
-	const shareEnabled = projectConfig?.profile?.imessageSynced === true;
+	const staticShareEnabled = projectConfig?.profile?.imessageSynced === true;
 	const recover = getCloudRecover(clients);
 	const includeGroupEvents = !isSharedMode(clients);
 	return mergeStreams(clients.map((entry) => {
-		const tracker = shareEnabled ? getContactShareTracker(entry.client) : void 0;
-		return clientStream(entry.client, pollCache, entry.phone, includeGroupEvents, tracker ? (chatGuid) => tracker.maybeShare(chatGuid) : void 0, recover);
+		const tracker = staticShareEnabled || profileSyncGate ? getContactShareTracker(entry.client) : void 0;
+		return clientStream(entry.client, pollCache, entry.phone, includeGroupEvents, tracker ? contactShareHandler(tracker, profileSyncGate) : void 0, recover);
 	}));
 };
 //#endregion
@@ -1996,7 +2016,7 @@ const stopTyping$1 = async (remote, spaceId) => {
 };
 //#endregion
 //#region src/remote/api.ts
-const messages = (clients, projectConfig) => messages$1(clients, projectConfig);
+const messages = (clients, projectConfig, profileSyncGate) => messages$1(clients, projectConfig, profileSyncGate);
 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);
@@ -2055,6 +2075,73 @@ const toSpectrumMiniApp = (url, layout, live) => asCustomizedMiniApp({
 	...live === void 0 ? {} : { live }
 });
 //#endregion
+//#region src/remote/profile-sync-gate.ts
+const PROFILE_SYNC_CACHE_TTL_MS = 6e4;
+const PROFILE_SYNC_RETRY_DELAY_MS = 3e4;
+const log = createLogger("spectrum.imessage.profile-sync");
+const createProfileSyncGate = (options) => {
+	const cacheTtlMs = options.cacheTtlMs ?? PROFILE_SYNC_CACHE_TTL_MS;
+	const retryDelayMs = options.retryDelayMs ?? PROFILE_SYNC_RETRY_DELAY_MS;
+	let cachedEnabled = options.initialEnabled;
+	let disposed = false;
+	let refreshInFlight;
+	let retryAfter = 0;
+	let validUntil = Date.now() + cacheTtlMs;
+	const refreshNow = async () => {
+		try {
+			const enabled = await options.refresh();
+			if (disposed) return false;
+			cachedEnabled = enabled;
+			retryAfter = 0;
+			validUntil = Date.now() + cacheTtlMs;
+			return enabled;
+		} catch (error) {
+			cachedEnabled = false;
+			retryAfter = Date.now() + retryDelayMs;
+			validUntil = 0;
+			log.warn("failed to refresh profile sync state; automatic contact sharing remains disabled", {
+				"spectrum.imessage.profile_sync.retry_in_ms": retryDelayMs,
+				...errorAttrs(error)
+			}, error);
+			return false;
+		}
+	};
+	const coalescedRefresh = () => {
+		if (!refreshInFlight) refreshInFlight = refreshNow().finally(() => {
+			refreshInFlight = void 0;
+		});
+		return refreshInFlight;
+	};
+	return {
+		dispose() {
+			disposed = true;
+			cachedEnabled = false;
+			validUntil = 0;
+		},
+		async isEnabled() {
+			if (disposed) return false;
+			const now = Date.now();
+			if (now < validUntil) return cachedEnabled;
+			if (now < retryAfter) return false;
+			return await coalescedRefresh();
+		}
+	};
+};
+const gates = /* @__PURE__ */ new WeakMap();
+const isProfileSynced = (projectConfig) => projectConfig.profile?.imessageSynced === true;
+const registerProfileSyncGate = (clients, projectId, projectSecret, projectConfig) => {
+	gates.get(clients)?.dispose();
+	gates.set(clients, createProfileSyncGate({
+		initialEnabled: isProfileSynced(projectConfig),
+		refresh: async () => isProfileSynced(await cloud.getProject(projectId, projectSecret))
+	}));
+};
+const getProfileSyncGate = (clients) => gates.get(clients);
+const disposeProfileSyncGate = (clients) => {
+	gates.get(clients)?.dispose();
+	gates.delete(clients);
+};
+//#endregion
 //#region src/index.ts
 const isPollContent = (content) => content.type === "poll" || content.type === "poll_option";
 const cacheRemoteOutbound = (remote, space, record) => {
@@ -2194,8 +2281,9 @@ const imessage = definePlatform(IMESSAGE_PLATFORM, {
 	config: configSchema,
 	static: { effect: { message: messageEffects } },
 	lifecycle: {
-		createClient: async ({ config, projectId, projectSecret }) => {
-			if (config.clients) return (Array.isArray(config.clients) ? config.clients : [config.clients]).map((e) => ({
+		createClient: async ({ config, projectConfig, projectId, projectSecret }) => {
+			let clients;
+			if (config.clients) clients = (Array.isArray(config.clients) ? config.clients : [config.clients]).map((e) => ({
 				phone: e.phone,
 				client: createGrpcClient({
 					address: e.address,
@@ -2205,10 +2293,13 @@ const imessage = definePlatform(IMESSAGE_PLATFORM, {
 					token: e.token
 				})
 			}));
-			if (!(projectId && projectSecret)) throw new Error("Cloud iMessage requires projectId and projectSecret. Pass credentials to Spectrum() or provide explicit clients with imessage.config({ clients: [...] }). For local Messages access, install @spectrum-ts/imessage-local and use localIMessage.config().");
-			return await createCloudClients(projectId, projectSecret);
+			else if (projectId && projectSecret) clients = await createCloudClients(projectId, projectSecret);
+			else throw new Error("Cloud iMessage requires projectId and projectSecret. Pass credentials to Spectrum() or provide explicit clients with imessage.config({ clients: [...] }). For local Messages access, install @spectrum-ts/imessage-local and use localIMessage.config().");
+			if (projectId && projectSecret && projectConfig) registerProfileSyncGate(clients, projectId, projectSecret, projectConfig);
+			return clients;
 		},
 		destroyClient: async ({ client }) => {
+			disposeProfileSyncGate(client);
 			await disposeCloudAuth(client);
 			await Promise.all(client.map((entry) => entry.client.close()));
 		}
@@ -2260,7 +2351,7 @@ const imessage = definePlatform(IMESSAGE_PLATFORM, {
 		}
 	},
 	message: { schema: messageSchema },
-	messages: ({ client, projectConfig }) => messages(client, projectConfig),
+	messages: ({ client, projectConfig }) => messages(client, projectConfig, getProfileSyncGate(client)),
 	send: async ({ space, content, client }) => {
 		if (content.type === "reply") {
 			const remote = remoteForMessageTarget(client, space, content.target, "reply", "replies");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spectrum-ts/imessage",
-  "version": "12.2.0",
+  "version": "12.4.0",
   "description": "iMessage provider for spectrum-ts.",
   "repository": {
     "type": "git",
@@ -33,7 +33,7 @@
   "dependencies": {
     "@grpc/grpc-js": "^1.14.4",
     "@photon-ai/advanced-imessage": "^2.0.2",
-    "@photon-ai/otel": "^3.1.0",
+    "@photon-ai/otel": "^3.3.0",
     "lru-cache": "^11.0.0",
     "marked": "^18.0.5",
     "nice-grpc": "^2.1.16",