@spectrum-ts/imessage 11.2.0 → 12.1.0

package/README.md

@@ -15,7 +15,7 @@ import { Spectrum } from "spectrum-ts";
 import { imessage } from "@spectrum-ts/imessage";
 
 const spectrum = Spectrum({
-  platforms: [imessage.config()],
+  providers: [imessage.config()],
 });
 ```
 

package/dist/index.d.ts

@@ -64,7 +64,7 @@ declare function background(input: string | Buffer | URL, options?: {
  * enters the universal `Content` discriminated union. The framework recognizes
  * it via two generic content-level contracts:
  *
- * 1. `__platform: "iMessage"` — `findUnsupportedPlatformContent` in
+ * 1. `__platform: "imessage"` — `findUnsupportedPlatformContent` in
  *    `platform/build.ts` reads this tag and warns-and-skips when a different
  *    platform receives it.
  * 2. `__fireAndForget: true` — `dispatchSend`'s fire-and-forget check treats
@@ -76,7 +76,7 @@ declare function background(input: string | Buffer | URL, options?: {
  */
 declare const contactCardSchema: z.ZodObject<{
   type: z.ZodLiteral<"contactCard">;
-  __platform: z.ZodLiteral<"iMessage">;
+  __platform: z.ZodLiteral<"imessage">;
   __fireAndForget: z.ZodLiteral<true>;
 }, z.core.$strip>;
 type ContactCard = z.infer<typeof contactCardSchema>;
@@ -116,7 +116,7 @@ declare const layoutSchema: z.ZodObject<{
  * provider — never enters the universal `Content` discriminated union. The
  * framework recognizes it via the generic content-level platform contract:
  *
- * - `__platform: "iMessage"` — `findUnsupportedPlatformContent` reads this tag
+ * - `__platform: "imessage"` — `findUnsupportedPlatformContent` reads this tag
  *   and warns-and-skips when a different platform receives it.
  *
  * Unlike `background` / `read`, this content is **not** `__fireAndForget`: it
@@ -126,7 +126,7 @@ declare const layoutSchema: z.ZodObject<{
  */
 declare const customizedMiniAppSchema: z.ZodObject<{
   type: z.ZodLiteral<"customized-mini-app">;
-  __platform: z.ZodLiteral<"iMessage">;
+  __platform: z.ZodLiteral<"imessage">;
   appName: z.ZodString;
   appStoreId: z.ZodOptional<z.ZodNumber>;
   extensionBundleId: z.ZodString;
@@ -195,8 +195,8 @@ declare const userSchema: z.ZodObject<{
   address: z.ZodOptional<z.ZodString>;
   country: z.ZodOptional<z.ZodString>;
   service: z.ZodOptional<z.ZodEnum<{
-    iMessage: "iMessage";
     unknown: "unknown";
+    iMessage: "iMessage";
     SMS: "SMS";
     RCS: "RCS";
   }>>;
@@ -233,7 +233,7 @@ type IMessageMessage = SchemaMessage<typeof userSchema, typeof spaceSchema> & {
 };
 //#endregion
 //#region src/index.d.ts
-declare const imessage: import("@spectrum-ts/core").Platform<import("@spectrum-ts/core").PlatformDef<"iMessage", import("zod").ZodObject<{
+declare const imessage: import("@spectrum-ts/core").Platform<import("@spectrum-ts/core").PlatformDef<"imessage", import("zod").ZodObject<{
   clients: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodObject<{
     address: import("zod").ZodString;
     token: import("zod").ZodString;
@@ -247,8 +247,8 @@ declare const imessage: import("@spectrum-ts/core").Platform<import("@spectrum-t
   address: import("zod").ZodOptional<import("zod").ZodString>;
   country: import("zod").ZodOptional<import("zod").ZodString>;
   service: import("zod").ZodOptional<import("zod").ZodEnum<{
-    iMessage: "iMessage";
     unknown: "unknown";
+    iMessage: "iMessage";
     SMS: "SMS";
     RCS: "RCS";
   }>>;

package/dist/index.js

@@ -1,7 +1,7 @@
 import { NotFoundError, ValidationError, createClient } from "@photon-ai/advanced-imessage";
 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, ensureM4a, errorAttrs, groupSchema, leaveSpaceSchema, messageEffectSchema, photoActionSchema, reactionSchema, removeMemberSchema, renameSchema, resumableOrderedStream, sanitizeErrorMessage } from "@spectrum-ts/core/authoring";
+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";
 import z from "zod";
 import { Marked } from "marked";
 import { LRUCache } from "lru-cache";
@@ -11,7 +11,7 @@ import { LRUCache } from "lru-cache";
 * provider — never enters the universal `Content` discriminated union. The
 * framework recognizes it via two generic content-level contracts:
 *
-* 1. `__platform: "iMessage"` — `findUnsupportedPlatformContent` in
+* 1. `__platform: "imessage"` — `findUnsupportedPlatformContent` in
 *    `platform/build.ts` reads this tag and warns-and-skips when a different
 *    platform receives it.
 * 2. `__fireAndForget: true` — `dispatchSend`'s fire-and-forget check
@@ -23,7 +23,7 @@ import { LRUCache } from "lru-cache";
 */
 const backgroundSchema = z.object({
 	type: z.literal("background"),
-	__platform: z.literal("iMessage"),
+	__platform: z.literal("imessage"),
 	__fireAndForget: z.literal(true),
 	action: photoActionSchema
 });
@@ -32,7 +32,7 @@ function background(input, options) {
 	const action = buildPhotoAction(input, options, "background");
 	return { build: async () => backgroundSchema.parse({
 		type: "background",
-		__platform: "iMessage",
+		__platform: "imessage",
 		__fireAndForget: true,
 		action
 	}) };
@@ -53,7 +53,7 @@ function background(input, options) {
 * enters the universal `Content` discriminated union. The framework recognizes
 * it via two generic content-level contracts:
 *
-* 1. `__platform: "iMessage"` — `findUnsupportedPlatformContent` in
+* 1. `__platform: "imessage"` — `findUnsupportedPlatformContent` in
 *    `platform/build.ts` reads this tag and warns-and-skips when a different
 *    platform receives it.
 * 2. `__fireAndForget: true` — `dispatchSend`'s fire-and-forget check treats
@@ -65,7 +65,7 @@ function background(input, options) {
 */
 const contactCardSchema = z.object({
 	type: z.literal("contactCard"),
-	__platform: z.literal("iMessage"),
+	__platform: z.literal("imessage"),
 	__fireAndForget: z.literal(true)
 });
 const isContactCard = (v) => contactCardSchema.safeParse(v).success;
@@ -90,7 +90,7 @@ const isContactCard = (v) => contactCardSchema.safeParse(v).success;
 function nativeContactCard() {
 	return { build: async () => contactCardSchema.parse({
 		type: "contactCard",
-		__platform: "iMessage",
+		__platform: "imessage",
 		__fireAndForget: true
 	}) };
 }
@@ -102,7 +102,7 @@ const layoutSchema = appLayoutSchema;
 * provider — never enters the universal `Content` discriminated union. The
 * framework recognizes it via the generic content-level platform contract:
 *
-* - `__platform: "iMessage"` — `findUnsupportedPlatformContent` reads this tag
+* - `__platform: "imessage"` — `findUnsupportedPlatformContent` reads this tag
 *   and warns-and-skips when a different platform receives it.
 *
 * Unlike `background` / `read`, this content is **not** `__fireAndForget`: it
@@ -112,7 +112,7 @@ const layoutSchema = appLayoutSchema;
 */
 const customizedMiniAppSchema = z.object({
 	type: z.literal("customized-mini-app"),
-	__platform: z.literal("iMessage"),
+	__platform: z.literal("imessage"),
 	appName: z.string().nonempty(),
 	appStoreId: z.number().int().positive().optional(),
 	extensionBundleId: z.string().nonempty(),
@@ -124,7 +124,7 @@ const customizedMiniAppSchema = z.object({
 const isCustomizedMiniApp = (v) => customizedMiniAppSchema.safeParse(v).success;
 const asCustomizedMiniApp = (input) => customizedMiniAppSchema.parse({
 	type: "customized-mini-app",
-	__platform: "iMessage",
+	__platform: "imessage",
 	...input
 });
 /**
@@ -231,10 +231,6 @@ const messageSchema = z.object({
 });
 //#endregion
 //#region src/auth.ts
-const log$4 = createLogger("spectrum.imessage.auth");
-const RENEWAL_RATIO = .8;
-const EXPIRY_BUFFER_MS = 3e4;
-const RETRY_DELAY_MS = 3e4;
 const FORCE_REFRESH_MIN_INTERVAL_MS = 5e3;
 const cloudAuthState = /* @__PURE__ */ new WeakMap();
 const requirePhone = (data, instanceId) => {
@@ -244,81 +240,26 @@ const requirePhone = (data, instanceId) => {
 };
 async function createCloudClients(projectId, projectSecret) {
 	let tokenData = await cloud.issueImessageTokens(projectId, projectSecret);
-	let tokenExpiresAt = Date.now() + tokenData.expiresIn * 1e3;
-	let disposed = false;
-	let renewalTimer;
-	let refreshFailures = 0;
-	let refreshInFlight;
 	let lastRefreshAt = Date.now();
 	const records = [];
 	const syncPhones = (data) => {
 		for (const { entry, instanceId } of records) entry.phone = requirePhone(data, instanceId);
 	};
-	const onRefreshSuccess = () => {
-		if (refreshFailures > 0) {
-			log$4.info("imessage token refresh recovered", { "spectrum.imessage.auth.attempt": refreshFailures });
-			refreshFailures = 0;
+	const renewal = createTokenRenewal({
+		expiresInSeconds: () => tokenData.expiresIn,
+		name: "imessage",
+		refresh: async () => {
+			tokenData = await cloud.issueImessageTokens(projectId, projectSecret);
+			lastRefreshAt = Date.now();
+			if (tokenData.type === "dedicated") syncPhones(tokenData);
 		}
-	};
-	const onRefreshFailure = (error) => {
-		refreshFailures += 1;
-		log$4.warn("imessage token refresh failed; retrying", {
-			"spectrum.imessage.auth.attempt": refreshFailures,
-			"spectrum.imessage.auth.retry_in_ms": RETRY_DELAY_MS,
-			...errorAttrs(error)
-		}, error);
-	};
-	const refreshNow = async () => {
-		tokenData = await cloud.issueImessageTokens(projectId, projectSecret);
-		tokenExpiresAt = Date.now() + tokenData.expiresIn * 1e3;
-		lastRefreshAt = Date.now();
-		if (tokenData.type === "dedicated") syncPhones(tokenData);
-		onRefreshSuccess();
-		scheduleRenewal();
-	};
-	const coalescedRefresh = () => {
-		if (!refreshInFlight) refreshInFlight = refreshNow().finally(() => {
-			refreshInFlight = void 0;
-		});
-		return refreshInFlight;
-	};
-	const scheduleRenewal = () => {
-		if (disposed) return;
-		if (renewalTimer !== void 0) {
-			clearTimeout(renewalTimer);
-			renewalTimer = void 0;
-		}
-		const ttlMs = tokenData.expiresIn * 1e3;
-		const renewInMs = Math.max(ttlMs * RENEWAL_RATIO, 5e3);
-		const runScheduledRefresh = () => {
-			coalescedRefresh().catch((error) => {
-				onRefreshFailure(error);
-				if (disposed) return;
-				renewalTimer = setTimeout(runScheduledRefresh, RETRY_DELAY_MS);
-				renewalTimer?.unref?.();
-			});
-		};
-		renewalTimer = setTimeout(runScheduledRefresh, renewInMs);
-		renewalTimer?.unref?.();
-	};
-	scheduleRenewal();
-	const refreshIfNeeded = async () => {
-		if (Date.now() < tokenExpiresAt - EXPIRY_BUFFER_MS) return;
-		await coalescedRefresh();
-	};
+	});
 	const forceRefresh = async () => {
 		if (Date.now() - lastRefreshAt < FORCE_REFRESH_MIN_INTERVAL_MS) return;
-		await coalescedRefresh();
-	};
-	const dispose = () => {
-		disposed = true;
-		if (renewalTimer !== void 0) {
-			clearTimeout(renewalTimer);
-			renewalTimer = void 0;
-		}
+		await renewal.forceRefresh();
 	};
 	const cloudAuth = {
-		dispose,
+		dispose: renewal.dispose,
 		forceRefresh
 	};
 	if (tokenData.type === "shared") {
@@ -330,7 +271,7 @@ async function createCloudClients(projectId, projectSecret) {
 				retry: true,
 				tls: true,
 				token: async () => {
-					await refreshIfNeeded();
+					await renewal.refreshIfNeeded();
 					return tokenData.token;
 				}
 			})
@@ -348,7 +289,7 @@ async function createCloudClients(projectId, projectSecret) {
 				retry: true,
 				tls: true,
 				token: async () => {
-					await refreshIfNeeded();
+					await renewal.refreshIfNeeded();
 					return tokenData.auth[instanceId] ?? token;
 				}
 			})
@@ -461,6 +402,9 @@ const getPollCache = (owner) => {
 	return cache;
 };
 //#endregion
+//#region src/platform.ts
+const IMESSAGE_PLATFORM = "imessage";
+//#endregion
 //#region src/remote/ids.ts
 const PART_PREFIX = /^p:(\d+)\//;
 const dmChatGuid = (address) => `any;-;${address}`;
@@ -1104,7 +1048,6 @@ const getDisplayName$1 = async (remote, spaceId) => {
 };
 //#endregion
 //#region src/shared/errors.ts
-const IMESSAGE_PLATFORM = "iMessage";
 const unsupportedRemoteContent = (type, detail) => UnsupportedError.content(type, IMESSAGE_PLATFORM, detail);
 //#endregion
 //#region src/remote/markdown.ts
@@ -2135,7 +2078,7 @@ const handleEdit = async (client, space, content) => {
 		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");
+		if (!miniAppCardSession) throw UnsupportedError.content("edit", IMESSAGE_PLATFORM, "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);
@@ -2143,16 +2086,16 @@ const handleEdit = async (client, space, content) => {
 		return;
 	}
 	if (isCustomizedMiniApp(content.content)) {
-		if (!miniAppCardSession) throw UnsupportedError.content("edit", "iMessage", "customized mini app card edits require a miniAppCardSession from the original send");
+		if (!miniAppCardSession) throw UnsupportedError.content("edit", IMESSAGE_PLATFORM, "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}")`);
+	if (content.content.type !== "text") throw UnsupportedError.content("edit", IMESSAGE_PLATFORM, `only text content can be edited (got "${content.content.type}")`);
 	await editMessage(clientForPhone(client, space.phone), space.id, content.target.id, content.content);
 };
 const handleUnsend = async (client, space, content) => {
-	if (isPollContent(content.target.content)) throw UnsupportedError.action("unsend", "iMessage", "iMessage polls cannot be unsent");
+	if (isPollContent(content.target.content)) throw UnsupportedError.action("unsend", IMESSAGE_PLATFORM, "iMessage polls cannot be unsent");
 	const remote = clientForPhone(client, space.phone);
 	const targetContent = content.target.content;
 	if (targetContent.type === "reaction") {
@@ -2195,11 +2138,11 @@ const handleTyping = async (client, space, state) => {
 	else await stopTyping(remote, space.id);
 };
 const handleRename = async (client, space, content) => {
-	if (space.type !== "group") throw UnsupportedError.action("rename", "iMessage", "only group chats can be renamed (this space is a DM)");
+	if (space.type !== "group") throw UnsupportedError.action("rename", IMESSAGE_PLATFORM, "only group chats can be renamed (this space is a DM)");
 	await setDisplayName(clientForPhone(client, space.phone), space.id, content);
 };
 const handleAvatar = async (client, space, content) => {
-	if (space.type !== "group") throw UnsupportedError.action("avatar", "iMessage", "only group chats have avatars (this space is a DM)");
+	if (space.type !== "group") throw UnsupportedError.action("avatar", IMESSAGE_PLATFORM, "only group chats have avatars (this space is a DM)");
 	await setIcon(clientForPhone(client, space.phone), space.id, content);
 };
 /**
@@ -2208,7 +2151,7 @@ const handleAvatar = async (client, space, content) => {
 * guard sequence.
 */
 const remoteGroupClient = (client, space, action, detail) => {
-	if (space.type !== "group") throw UnsupportedError.action(action, "iMessage", detail);
+	if (space.type !== "group") throw UnsupportedError.action(action, IMESSAGE_PLATFORM, detail);
 	return clientForPhone(client, space.phone);
 };
 const handleAddMember = async (client, space, content) => {
@@ -2244,10 +2187,10 @@ const handleProviderControlSignal = async (client, space, content) => {
 * poll-unsupported message.
 */
 const remoteForMessageTarget = (client, space, target, action, pollNoun) => {
-	if (isPollContent(target.content)) throw UnsupportedError.action(action, "iMessage", `iMessage polls do not support ${pollNoun}`);
+	if (isPollContent(target.content)) throw UnsupportedError.action(action, IMESSAGE_PLATFORM, `iMessage polls do not support ${pollNoun}`);
 	return clientForPhone(client, space.phone);
 };
-const imessage = definePlatform("iMessage", {
+const imessage = definePlatform(IMESSAGE_PLATFORM, {
 	config: configSchema,
 	static: { effect: { message: messageEffects } },
 	lifecycle: {
@@ -2262,7 +2205,7 @@ const imessage = definePlatform("iMessage", {
 					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 its imessage.config().");
+			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);
 		},
 		destroyClient: async ({ client }) => {
@@ -2393,7 +2336,7 @@ const imessage = definePlatform("iMessage", {
 			})();
 			const remote = clientForPhone(client, routedPhone);
 			return withSpan("spectrum.imessage.getAttachment", {
-				"spectrum.provider": "iMessage",
+				"spectrum.provider": IMESSAGE_PLATFORM,
 				"spectrum.imessage.attachment.guid": guid,
 				"spectrum.imessage.phone": routedPhone
 			}, () => getRemoteAttachment(remote, guid));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spectrum-ts/imessage",
-  "version": "11.2.0",
+  "version": "12.1.0",
   "description": "iMessage provider for spectrum-ts.",
   "repository": {
     "type": "git",
@@ -28,7 +28,7 @@
   "spectrum": {
     "key": "imessage",
     "import": "imessage",
-    "label": "iMessage"
+    "label": "imessage"
   },
   "dependencies": {
     "@photon-ai/advanced-imessage": "^1.0.0",
@@ -38,7 +38,7 @@
     "zod": "^4.2.1"
   },
   "peerDependencies": {
-    "@spectrum-ts/core": "^11.0.0",
+    "@spectrum-ts/core": "^12.0.0",
     "typescript": "^5 || ^6.0.0"
   },
   "license": "MIT"