spectrum-ts 1.17.1 → 1.18.0

package/dist/{chunk-YJMPSD3S.js → chunk-YN6WOTBF.js}

@@ -60,21 +60,79 @@ function background(input, options) {
   };
 }
 
+// src/providers/imessage/content/customized-mini-app.ts
+import z2 from "zod";
+var layoutSchema = z2.object({
+  caption: z2.string().nonempty().optional(),
+  subcaption: z2.string().nonempty().optional(),
+  trailingCaption: z2.string().nonempty().optional(),
+  trailingSubcaption: z2.string().nonempty().optional(),
+  image: z2.instanceof(Uint8Array).optional(),
+  imageTitle: z2.string().nonempty().optional(),
+  imageSubtitle: z2.string().nonempty().optional(),
+  summary: z2.string().nonempty().optional()
+}).refine(
+  (layout) => layout.caption !== void 0 || layout.subcaption !== void 0 || layout.trailingCaption !== void 0 || layout.trailingSubcaption !== void 0 || layout.image !== void 0,
+  {
+    message: "layout must set at least one of caption, subcaption, trailingCaption, trailingSubcaption, image"
+  }
+).refine(
+  (layout) => layout.image === void 0 === (layout.imageTitle === void 0),
+  {
+    message: "layout.image and layout.imageTitle must be set together",
+    path: ["imageTitle"]
+  }
+).refine(
+  (layout) => layout.imageSubtitle === void 0 || layout.image !== void 0,
+  {
+    message: "layout.imageSubtitle requires layout.image",
+    path: ["imageSubtitle"]
+  }
+);
+var customizedMiniAppSchema = z2.object({
+  type: z2.literal("customized-mini-app"),
+  __platform: z2.literal("iMessage"),
+  // Display name of the owning app, shown by Messages fallback UI.
+  appName: z2.string().nonempty(),
+  // Apple App Store numeric id of the owning app. Positive when set; omit to
+  // send a card whose extension is not published on the App Store.
+  appStoreId: z2.number().int().positive().optional(),
+  // Bundle identifier of the iMessage extension target.
+  extensionBundleId: z2.string().nonempty(),
+  // Visible card layout.
+  layout: layoutSchema,
+  // 10-character uppercase alphanumeric Apple Team ID.
+  teamId: z2.string(),
+  // Absolute URL delivered to the installed extension on tap.
+  url: z2.url()
+});
+var isCustomizedMiniApp = (v) => customizedMiniAppSchema.safeParse(v).success;
+var asCustomizedMiniApp = (input) => customizedMiniAppSchema.parse({
+  type: "customized-mini-app",
+  __platform: "iMessage",
+  ...input
+});
+function customizedMiniApp(input) {
+  return {
+    build: async () => asCustomizedMiniApp(input)
+  };
+}
+
 // src/providers/imessage/content/effect.ts
 import {
   MessageEffect
 } from "@photon-ai/advanced-imessage";
 
 // src/content/effect.ts
-import z2 from "zod";
-var effectInnerSchema = z2.discriminatedUnion("type", [
+import z3 from "zod";
+var effectInnerSchema = z3.discriminatedUnion("type", [
   textSchema,
   attachmentSchema
 ]);
-var messageEffectSchema = z2.object({
-  type: z2.literal("effect"),
+var messageEffectSchema = z3.object({
+  type: z3.literal("effect"),
   content: effectInnerSchema,
-  effect: z2.string().nonempty()
+  effect: z3.string().nonempty()
 });
 
 // src/providers/imessage/content/effect.ts
@@ -104,13 +162,13 @@ function effect(input, messageEffect) {
 }
 
 // src/providers/imessage/content/read.ts
-import z3 from "zod";
+import z4 from "zod";
 var isMessage = (v) => typeof v === "object" && v !== null && "id" in v && "content" in v;
-var readSchema = z3.object({
-  type: z3.literal("read"),
-  __platform: z3.literal("iMessage"),
-  __fireAndForget: z3.literal(true),
-  target: z3.custom(isMessage, {
+var readSchema = z4.object({
+  type: z4.literal("read"),
+  __platform: z4.literal("iMessage"),
+  __fireAndForget: z4.literal(true),
+  target: z4.custom(isMessage, {
     message: "read target must be a Message"
   })
 });
@@ -138,33 +196,33 @@ import { createClient } from "@photon-ai/advanced-imessage";
 
 // src/providers/imessage/types.ts
 import { IMessageSDK } from "@photon-ai/imessage-kit";
-import z4 from "zod";
+import z5 from "zod";
 var SHARED_PHONE = "shared";
 var isLocal = (client) => client instanceof IMessageSDK;
-var clientEntry = z4.object({
-  address: z4.string(),
-  token: z4.string(),
-  phone: z4.string()
+var clientEntry = z5.object({
+  address: z5.string(),
+  token: z5.string(),
+  phone: z5.string()
 });
-var configSchema = z4.union([
-  z4.object({ local: z4.literal(true) }),
-  z4.object({
-    local: z4.literal(false).optional().default(false),
-    clients: clientEntry.or(z4.array(clientEntry)).optional()
+var configSchema = z5.union([
+  z5.object({ local: z5.literal(true) }),
+  z5.object({
+    local: z5.literal(false).optional().default(false),
+    clients: clientEntry.or(z5.array(clientEntry)).optional()
   })
 ]);
-var userSchema = z4.object({});
-var spaceSchema = z4.object({
-  id: z4.string(),
-  type: z4.enum(["dm", "group"]),
-  phone: z4.string()
+var userSchema = z5.object({});
+var spaceSchema = z5.object({
+  id: z5.string(),
+  type: z5.enum(["dm", "group"]),
+  phone: z5.string()
 });
-var spaceParamsSchema = z4.object({
-  phone: z4.string().optional()
+var spaceParamsSchema = z5.object({
+  phone: z5.string().optional()
 });
-var messageSchema = z4.object({
-  partIndex: z4.number().int().nonnegative().optional(),
-  parentId: z4.string().optional()
+var messageSchema = z5.object({
+  partIndex: z5.number().int().nonnegative().optional(),
+  parentId: z5.string().optional()
 });
 
 // src/providers/imessage/auth.ts
@@ -549,6 +607,18 @@ var setBackground = async (remote, spaceId, content) => {
   );
 };
 
+// src/providers/imessage/remote/customized-mini-app.ts
+var sendCustomizedMiniApp = async (remote, spaceId, content) => {
+  const chat = toChatGuid(spaceId);
+  const message = await remote.messages.sendCustomizedMiniApp(chat, content);
+  return {
+    id: message.guid,
+    content,
+    space: { id: spaceId },
+    timestamp: message.dateCreated
+  };
+};
+
 // src/providers/imessage/remote/inbound.ts
 import {
   NotFoundError as NotFoundError2
@@ -910,7 +980,6 @@ var getMessage3 = async (remote, spaceId, msgId, phone) => {
   if (childRef) {
     try {
       const fetched = await remote.messages.get(
-        toChatGuid(spaceId),
         toMessageGuid(childRef.parentGuid)
       );
       const parent = await rebuildFromAppleMessage(
@@ -933,10 +1002,7 @@ var getMessage3 = async (remote, spaceId, msgId, phone) => {
     }
   }
   try {
-    const fetched = await remote.messages.get(
-      toChatGuid(spaceId),
-      toMessageGuid(msgId)
-    );
+    const fetched = await remote.messages.get(toMessageGuid(msgId));
     const rebuilt = await rebuildFromAppleMessage(
       remote,
       fetched,
@@ -975,10 +1041,7 @@ var resolveReactionTarget = async (client, cache, chat, targetGuid, partIndex, p
   let candidate = cache.get(targetGuid);
   if (!candidate) {
     try {
-      const fetched = await client.messages.get(
-        toChatGuid(chat),
-        toMessageGuid(targetGuid)
-      );
+      const fetched = await client.messages.get(toMessageGuid(targetGuid));
       candidate = await rebuildFromAppleMessage(client, fetched, phone, chat);
       cacheMessage(cache, candidate);
     } catch {
@@ -1987,6 +2050,7 @@ var stopTyping = async (remote, spaceId) => {
 // src/providers/imessage/remote/api.ts
 var messages4 = (clients, projectConfig) => messages3(clients, projectConfig);
 var setBackground2 = async (remote, spaceId, content) => setBackground(remote, spaceId, content);
+var sendCustomizedMiniApp2 = async (remote, spaceId, content) => sendCustomizedMiniApp(remote, spaceId, content);
 var setDisplayName2 = async (remote, spaceId, content) => setDisplayName(remote, spaceId, content);
 var setIcon2 = async (remote, spaceId, content) => setIcon(remote, spaceId, content);
 var markRead2 = async (remote, spaceId) => {
@@ -2067,6 +2131,17 @@ var handleBackground = async (client, space, content) => {
   const remote = clientForPhone(client, space.phone);
   await setBackground2(remote, space.id, content);
 };
+var handleCustomizedMiniApp = async (client, space, content) => {
+  if (isLocal(client)) {
+    throw UnsupportedError.action(
+      "customized-mini-app",
+      "iMessage (local mode)",
+      "mini app cards require remote iMessage"
+    );
+  }
+  const remote = clientForPhone(client, space.phone);
+  return await sendCustomizedMiniApp2(remote, space.id, content);
+};
 var handleRead = async (client, space) => {
   if (isLocal(client)) {
     throw UnsupportedError.action(
@@ -2291,6 +2366,9 @@ var imessage = definePlatform("iMessage", {
       await handleRead(client, space);
       return;
     }
+    if (isCustomizedMiniApp(content)) {
+      return await handleCustomizedMiniApp(client, space, content);
+    }
     if (isLocal(client)) {
       return await send2(client, space.id, content);
     }
@@ -2351,6 +2429,7 @@ var imessage = definePlatform("iMessage", {
 
 export {
   background,
+  customizedMiniApp,
   effect,
   read,
   imessage

package/dist/index.d.ts

@@ -373,8 +373,8 @@ declare function rename(displayName: string): ContentBuilder;
  * `message.reply(content)` is sugar that delegates here. Providers see
  * `reply` like any other content type and route to a threaded send.
  *
- * Reply cannot wrap `reply`, `edit`, `reaction`, `group`, `typing`, `rename`,
- * or `avatar` content.
+ * Reply cannot wrap `reply`, `edit`, `reaction`, `group`, `typing`,
+ * `rename`, or `avatar` content.
  */
 declare const replySchema: z__default.ZodObject<{
     type: z__default.ZodLiteral<"reply">;

package/dist/providers/imessage/index.d.ts

@@ -39,6 +39,78 @@ declare function background(input: string | Buffer | URL, options?: {
     mimeType?: string;
 }): ContentBuilder;
 
+/**
+ * Visible layout of a mini-app card. Mirrors Apple's
+ * `MSMessageTemplateLayout`. At least one of `caption`, `subcaption`,
+ * `trailingCaption`, `trailingSubcaption`, or `image` must be set so the
+ * bubble is not empty — `summary` is the fallback text shown on surfaces
+ * that cannot render the card (notifications, lock screen) and is not a
+ * visible slot on its own. `image` and `imageTitle` must be set together;
+ * `imageSubtitle` requires `image`.
+ */
+declare const layoutSchema: z__default.ZodObject<{
+    caption: z__default.ZodOptional<z__default.ZodString>;
+    subcaption: z__default.ZodOptional<z__default.ZodString>;
+    trailingCaption: z__default.ZodOptional<z__default.ZodString>;
+    trailingSubcaption: z__default.ZodOptional<z__default.ZodString>;
+    image: z__default.ZodOptional<z__default.ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>>;
+    imageTitle: z__default.ZodOptional<z__default.ZodString>;
+    imageSubtitle: z__default.ZodOptional<z__default.ZodString>;
+    summary: z__default.ZodOptional<z__default.ZodString>;
+}, z__default.core.$strip>;
+/**
+ * iMessage-only mini-app card content. Lives entirely under the iMessage
+ * 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
+ *   and warns-and-skips when a different platform receives it.
+ *
+ * Unlike `background` / `read`, this content is **not** `__fireAndForget`: it
+ * produces a real outbound message, so the iMessage `send` handler narrows
+ * back to `CustomizedMiniApp` via the `isCustomizedMiniApp` guard and returns
+ * the resulting `ProviderMessageRecord` (rather than `void`).
+ */
+declare const customizedMiniAppSchema: z__default.ZodObject<{
+    type: z__default.ZodLiteral<"customized-mini-app">;
+    __platform: z__default.ZodLiteral<"iMessage">;
+    appName: z__default.ZodString;
+    appStoreId: z__default.ZodOptional<z__default.ZodNumber>;
+    extensionBundleId: z__default.ZodString;
+    layout: z__default.ZodObject<{
+        caption: z__default.ZodOptional<z__default.ZodString>;
+        subcaption: z__default.ZodOptional<z__default.ZodString>;
+        trailingCaption: z__default.ZodOptional<z__default.ZodString>;
+        trailingSubcaption: z__default.ZodOptional<z__default.ZodString>;
+        image: z__default.ZodOptional<z__default.ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>>;
+        imageTitle: z__default.ZodOptional<z__default.ZodString>;
+        imageSubtitle: z__default.ZodOptional<z__default.ZodString>;
+        summary: z__default.ZodOptional<z__default.ZodString>;
+    }, z__default.core.$strip>;
+    teamId: z__default.ZodString;
+    url: z__default.ZodURL;
+}, z__default.core.$strip>;
+type CustomizedMiniApp = z__default.infer<typeof customizedMiniAppSchema>;
+type CustomizedMiniAppLayout = z__default.infer<typeof layoutSchema>;
+type CustomizedMiniAppInput = Omit<CustomizedMiniApp, "type" | "__platform">;
+/**
+ * Construct a `customized-mini-app` content value. iMessage-only, remote-only.
+ *
+ * The layout is what recipients see in the bubble. `teamId` and
+ * `extensionBundleId` identify the iMessage extension that receives `url` when
+ * 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.
+ *
+ * `space.send(customizedMiniApp(...))` is the canonical form.
+ *
+ * `CustomizedMiniApp` is intentionally not a member of the universal `Content`
+ * union — the `as unknown as Content` cast keeps the builder shape compatible
+ * with the framework's `ContentBuilder.build(): Promise<Content>` signature.
+ */
+declare function customizedMiniApp(input: CustomizedMiniAppInput): ContentBuilder;
+
 type IMessageMessageEffect = MessageEffect;
 declare function effect(input: ContentInput, messageEffect: IMessageMessageEffect): ContentBuilder;
 
@@ -176,4 +248,4 @@ declare const imessage: Platform<PlatformDef<"iMessage", z.ZodUnion<readonly [z.
     };
 }>;
 
-export { type BackgroundInput, type IMessageMessageEffect, background, effect, imessage, read };
+export { type BackgroundInput, type CustomizedMiniApp, type CustomizedMiniAppInput, type CustomizedMiniAppLayout, type IMessageMessageEffect, background, customizedMiniApp, effect, imessage, read };

package/dist/providers/imessage/index.js

@@ -1,10 +1,11 @@
 import { createRequire as __spectrumCreateRequire } from "node:module"; const require = __spectrumCreateRequire(import.meta.url);
 import {
   background,
+  customizedMiniApp,
   effect,
   imessage,
   read
-} from "../../chunk-YJMPSD3S.js";
+} from "../../chunk-YN6WOTBF.js";
 import "../../chunk-JQN6CRSC.js";
 import "../../chunk-2D27WW5B.js";
 import "../../chunk-MC6ZKFSG.js";
@@ -13,6 +14,7 @@ import "../../chunk-IPOFBAIM.js";
 import "../../chunk-2ILTJC35.js";
 export {
   background,
+  customizedMiniApp,
   effect,
   imessage,
   read

package/dist/providers/index.js

@@ -1,7 +1,7 @@
 import { createRequire as __spectrumCreateRequire } from "node:module"; const require = __spectrumCreateRequire(import.meta.url);
 import {
   imessage
-} from "../chunk-YJMPSD3S.js";
+} from "../chunk-YN6WOTBF.js";
 import "../chunk-JQN6CRSC.js";
 import {
   slack

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spectrum-ts",
-  "version": "1.17.1",
+  "version": "1.18.0",
   "description": "Bring agents to any interface — unified messaging SDK for TypeScript.",
   "repository": {
     "type": "git",
@@ -38,7 +38,7 @@
     "./manifest.json": "./dist/manifest.json"
   },
   "dependencies": {
-    "@photon-ai/advanced-imessage": "^0.10.0",
+    "@photon-ai/advanced-imessage": "^0.11.0",
     "@photon-ai/imessage-kit": "^3.0.0",
     "@photon-ai/otel": "^0.1.1",
     "@photon-ai/slack": "^0.2.0",