@spectrum-ts/imessage-local 11.2.0 → 12.1.0

package/README.md

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

package/dist/index.d.ts

@@ -75,7 +75,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
@@ -87,7 +87,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>;
@@ -127,7 +127,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
@@ -137,7 +137,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;
@@ -197,7 +197,7 @@ type IMessageMessageEffect = (typeof messageEffects)[keyof typeof messageEffects
 declare function effect(input: ContentInput, messageEffect: IMessageMessageEffect): ContentBuilder;
 //#endregion
 //#region src/index.d.ts
-declare const imessage: import("@spectrum-ts/core").Platform<import("@spectrum-ts/core").PlatformDef<"iMessage", import("zod").ZodObject<{}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+declare const localIMessage: import("@spectrum-ts/core").Platform<import("@spectrum-ts/core").PlatformDef<"local_imessage", import("zod").ZodObject<{}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
   address: import("zod").ZodOptional<import("zod").ZodString>;
   country: import("zod").ZodOptional<import("zod").ZodString>;
   service: import("zod").ZodOptional<import("zod").ZodEnum<{
@@ -266,4 +266,4 @@ declare const imessage: import("@spectrum-ts/core").Platform<import("@spectrum-t
   };
 }>;
 //#endregion
-export { type BackgroundInput, type ContactCard, type CustomizedMiniApp, type CustomizedMiniAppInput, type CustomizedMiniAppLayout, type IMessageMessageEffect, background, customizedMiniApp, effect, imessage, nativeContactCard, read };
+export { type BackgroundInput, type ContactCard, type CustomizedMiniApp, type CustomizedMiniAppInput, type CustomizedMiniAppLayout, type IMessageMessageEffect, background, customizedMiniApp, effect, localIMessage, nativeContactCard, read };

package/dist/index.js

@@ -14,7 +14,7 @@ import { basename, join } from "node:path";
 * 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
@@ -26,7 +26,7 @@ import { basename, join } from "node:path";
 */
 const backgroundSchema = z.object({
 	type: z.literal("background"),
-	__platform: z.literal("iMessage"),
+	__platform: z.literal("imessage"),
 	__fireAndForget: z.literal(true),
 	action: photoActionSchema
 });
@@ -35,7 +35,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
 	}) };
@@ -56,7 +56,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
@@ -68,7 +68,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;
@@ -93,7 +93,7 @@ const isContactCard = (v) => contactCardSchema.safeParse(v).success;
 function nativeContactCard() {
 	return { build: async () => contactCardSchema.parse({
 		type: "contactCard",
-		__platform: "iMessage",
+		__platform: "imessage",
 		__fireAndForget: true
 	}) };
 }
@@ -105,7 +105,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
@@ -115,7 +115,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(),
@@ -127,7 +127,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
 });
 /**
@@ -412,8 +412,8 @@ const messages$1 = (client) => stream((emit, end) => {
 });
 //#endregion
 //#region ../imessage/src/shared/errors.ts
-const LOCAL_IMESSAGE_PLATFORM = "iMessage (local mode)";
-const unsupportedLocalContent = (type, detail) => UnsupportedError.content(type, LOCAL_IMESSAGE_PLATFORM, detail);
+const LOCAL_IMESSAGE_PLATFORM = "local_imessage";
+const unsupportedLocalContent = (type, detail) => UnsupportedError.content(type, LOCAL_IMESSAGE_PLATFORM, detail ? `local mode: ${detail}` : "local mode");
 //#endregion
 //#region src/local/send.ts
 const synthRecord = (spaceId, content) => ({
@@ -491,9 +491,10 @@ const messageSchema = z.object({
 });
 //#endregion
 //#region src/index.ts
-const LOCAL_PLATFORM = "iMessage (local mode)";
+const PLATFORM_ID = "local_imessage";
 const unsupportedAction = (action, detail) => {
-	throw UnsupportedError.action(action, LOCAL_PLATFORM, detail);
+	const localDetail = detail ? `local mode: ${detail}` : "local mode";
+	throw UnsupportedError.action(action, PLATFORM_ID, localDetail);
 };
 const handleLocalOnlySend = async (client, spaceId, content) => {
 	if (content.type === "typing") return;
@@ -514,7 +515,7 @@ const handleLocalOnlySend = async (client, spaceId, content) => {
 	if (isCustomizedMiniApp(content)) return unsupportedAction("customized-mini-app", "mini app cards require remote iMessage");
 	return await send(client, spaceId, content);
 };
-const imessage = definePlatform("iMessage", {
+const localIMessage = definePlatform(PLATFORM_ID, {
 	config: configSchema,
 	static: { effect: { message: messageEffects } },
 	lifecycle: {
@@ -565,4 +566,4 @@ const imessage = definePlatform("iMessage", {
 	}
 });
 //#endregion
-export { background, customizedMiniApp, effect, imessage, nativeContactCard, read };
+export { background, customizedMiniApp, effect, localIMessage, nativeContactCard, read };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spectrum-ts/imessage-local",
-  "version": "11.2.0",
+  "version": "12.1.0",
   "description": "Local macOS iMessage provider for spectrum-ts.",
   "repository": {
     "type": "git",
@@ -30,7 +30,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"