spectrum-ts 0.4.0 → 0.6.0

package/dist/providers/whatsapp-business/index.js

@@ -1,12 +1,13 @@
 import {
   asAttachment,
+  asContact,
   asCustom,
   stream
-} from "../../chunk-5XW4CAWS.js";
+} from "../../chunk-UZWRB3FZ.js";
 import {
   asText,
   definePlatform
-} from "../../chunk-XEEDIGVK.js";
+} from "../../chunk-XZTTLPHE.js";
 
 // src/providers/whatsapp-business/index.ts
 import {
@@ -14,13 +15,155 @@ import {
 } from "@photon-ai/whatsapp-business";
 
 // src/providers/whatsapp-business/messages.ts
-var toMessage = (client, msg) => ({
-  id: msg.id,
-  content: mapContent(client, msg.content),
-  sender: { id: msg.from },
-  space: { id: msg.from },
-  timestamp: msg.timestamp
+import { extension as mimeExtension } from "mime-types";
+var toSendResult = (result) => ({
+  id: result.messageId
 });
+var mapWaPhoneType = (type) => {
+  if (!type) {
+    return void 0;
+  }
+  const upper = type.toUpperCase();
+  if (upper === "CELL" || upper === "MOBILE" || upper === "IPHONE") {
+    return "mobile";
+  }
+  if (upper === "HOME") {
+    return "home";
+  }
+  if (upper === "WORK" || upper === "BUSINESS") {
+    return "work";
+  }
+  return "other";
+};
+var mapWaSimpleType = (type) => {
+  if (!type) {
+    return void 0;
+  }
+  const upper = type.toUpperCase();
+  if (upper === "HOME") {
+    return "home";
+  }
+  if (upper === "WORK" || upper === "BUSINESS") {
+    return "work";
+  }
+  return "other";
+};
+var waNameToSpectrum = (name) => {
+  const result = { formatted: name.formattedName };
+  if (name.firstName) {
+    result.first = name.firstName;
+  }
+  if (name.lastName) {
+    result.last = name.lastName;
+  }
+  if (name.middleName) {
+    result.middle = name.middleName;
+  }
+  if (name.prefix) {
+    result.prefix = name.prefix;
+  }
+  if (name.suffix) {
+    result.suffix = name.suffix;
+  }
+  return result;
+};
+var waPhoneToSpectrum = (phone) => {
+  const entry = { value: phone.phone };
+  const type = mapWaPhoneType(phone.type);
+  if (type) {
+    entry.type = type;
+  }
+  return entry;
+};
+var waEmailToSpectrum = (email) => {
+  const entry = { value: email.email };
+  const type = mapWaSimpleType(email.type);
+  if (type) {
+    entry.type = type;
+  }
+  return entry;
+};
+var waAddressToSpectrum = (address) => {
+  const entry = {};
+  if (address.street) {
+    entry.street = address.street;
+  }
+  if (address.city) {
+    entry.city = address.city;
+  }
+  if (address.state) {
+    entry.region = address.state;
+  }
+  if (address.zip) {
+    entry.postalCode = address.zip;
+  }
+  if (address.country) {
+    entry.country = address.country;
+  }
+  const type = mapWaSimpleType(address.type);
+  if (type) {
+    entry.type = type;
+  }
+  return entry;
+};
+var waOrgToSpectrum = (org) => {
+  const entry = {};
+  if (org.company) {
+    entry.name = org.company;
+  }
+  if (org.title) {
+    entry.title = org.title;
+  }
+  if (org.department) {
+    entry.department = org.department;
+  }
+  return entry;
+};
+var waContactToSpectrum = (card) => {
+  const input = { raw: card };
+  input.name = waNameToSpectrum(card.name);
+  if (card.phones.length > 0) {
+    input.phones = card.phones.map(waPhoneToSpectrum);
+  }
+  if (card.emails.length > 0) {
+    input.emails = card.emails.map(waEmailToSpectrum);
+  }
+  if (card.addresses.length > 0) {
+    input.addresses = card.addresses.map(waAddressToSpectrum);
+  }
+  if (card.org) {
+    input.org = waOrgToSpectrum(card.org);
+  }
+  if (card.urls.length > 0) {
+    input.urls = card.urls.map((u) => u.url);
+  }
+  if (card.birthday) {
+    input.birthday = card.birthday;
+  }
+  return asContact(input);
+};
+var toMessages = (client, msg) => {
+  const base = {
+    sender: { id: msg.from },
+    space: { id: msg.from },
+    timestamp: msg.timestamp
+  };
+  if (msg.content.type === "contacts") {
+    const multi = msg.content.contacts.length > 1;
+    return msg.content.contacts.map((card, index) => ({
+      ...base,
+      id: multi ? `${msg.id}:${index}` : msg.id,
+      content: waContactToSpectrum(card)
+    }));
+  }
+  return [
+    {
+      ...base,
+      id: msg.id,
+      content: mapContent(client, msg.content)
+    }
+  ];
+};
 var mapContent = (client, content) => {
   switch (content.type) {
     case "text":
@@ -34,11 +177,6 @@ var mapContent = (client, content) => {
       return asCustom({ whatsapp_type: "sticker", ...content.sticker });
     case "location":
       return asCustom({ whatsapp_type: "location", ...content.location });
-    case "contacts":
-      return asCustom({
-        whatsapp_type: "contacts",
-        contacts: content.contacts
-      });
     case "reaction":
       return asCustom({ whatsapp_type: "reaction", ...content.reaction });
     case "interactive":
@@ -85,6 +223,74 @@ var mimeToMediaType = (mimeType) => {
   }
   return "document";
 };
+var voiceFilename = (content) => {
+  if (content.name) {
+    return content.name;
+  }
+  const ext = mimeExtension(content.mimeType);
+  return ext ? `voice.${ext}` : "voice";
+};
+var spectrumPhoneTypeToWa = (type) => {
+  if (type === "mobile") {
+    return "CELL";
+  }
+  if (type === "home" || type === "work" || type === "other") {
+    return type.toUpperCase();
+  }
+  return void 0;
+};
+var spectrumSimpleTypeToWa = (type) => type ? type.toUpperCase() : void 0;
+var spectrumNameToWa = (name) => ({
+  formattedName: name?.formatted ?? ([name?.first, name?.middle, name?.last].filter((p) => Boolean(p)).join(" ") || "Unknown"),
+  firstName: name?.first,
+  lastName: name?.last,
+  middleName: name?.middle,
+  prefix: name?.prefix,
+  suffix: name?.suffix
+});
+var isWhatsAppContactCard = (value) => {
+  if (!value || typeof value !== "object") {
+    return false;
+  }
+  const raw = value;
+  const name = raw.name;
+  if (!name || typeof name !== "object" || typeof name.formattedName !== "string") {
+    return false;
+  }
+  return Array.isArray(raw.phones) && Array.isArray(raw.emails) && Array.isArray(raw.addresses) && Array.isArray(raw.urls);
+};
+var contactToWa = (contact) => {
+  if (isWhatsAppContactCard(contact.raw)) {
+    return contact.raw;
+  }
+  const card = {
+    name: spectrumNameToWa(contact.name),
+    phones: (contact.phones ?? []).map((p) => ({
+      phone: p.value,
+      type: spectrumPhoneTypeToWa(p.type)
+    })),
+    emails: (contact.emails ?? []).map((e) => ({
+      email: e.value,
+      type: spectrumSimpleTypeToWa(e.type)
+    })),
+    addresses: (contact.addresses ?? []).map((a) => ({
+      street: a.street,
+      city: a.city,
+      state: a.region,
+      zip: a.postalCode,
+      country: a.country,
+      type: spectrumSimpleTypeToWa(a.type)
+    })),
+    urls: (contact.urls ?? []).map((url) => ({ url })),
+    org: contact.org?.name || contact.org?.department || contact.org?.title ? {
+      company: contact.org.name,
+      department: contact.org.department,
+      title: contact.org.title
+    } : void 0,
+    birthday: contact.birthday
+  };
+  return card;
+};
 var messages = (client) => {
   const eventStream = client.events.subscribe().filter(
     (e) => e.type === "message"
@@ -93,7 +299,9 @@ var messages = (client) => {
     (async () => {
       try {
         for await (const event of eventStream) {
-          emit(toMessage(client, event.message));
+          for (const m of toMessages(client, event.message)) {
+            emit(m);
+          }
         }
         end();
       } catch (e) {
@@ -106,8 +314,9 @@ var messages = (client) => {
 var send = async (client, spaceId, content) => {
   switch (content.type) {
     case "text":
-      await client.messages.send({ to: spaceId, text: content.text });
-      break;
+      return toSendResult(
+        await client.messages.send({ to: spaceId, text: content.text })
+      );
     case "attachment": {
       const { mediaId } = await client.media.upload({
         file: await content.read(),
@@ -116,14 +325,35 @@ var send = async (client, spaceId, content) => {
       });
       const mediaType = mimeToMediaType(content.mimeType);
       const mediaPayload = mediaType === "document" ? { id: mediaId, filename: content.name } : { id: mediaId };
-      await client.messages.send({
-        to: spaceId,
-        [mediaType]: mediaPayload
+      return toSendResult(
+        await client.messages.send({
+          to: spaceId,
+          [mediaType]: mediaPayload
+        })
+      );
+    }
+    case "contact":
+      return toSendResult(
+        await client.messages.send({
+          to: spaceId,
+          contacts: [contactToWa(content)]
+        })
+      );
+    case "voice": {
+      const { mediaId } = await client.media.upload({
+        file: await content.read(),
+        mimeType: content.mimeType,
+        filename: voiceFilename(content)
       });
-      break;
+      return toSendResult(
+        await client.messages.send({
+          to: spaceId,
+          audio: { id: mediaId }
+        })
+      );
     }
     default:
-      break;
+      throw new Error(`Unsupported WhatsApp content type: ${content.type}`);
   }
 };
 var reactToMessage = async (client, spaceId, messageId, reaction) => {
@@ -135,12 +365,13 @@ var reactToMessage = async (client, spaceId, messageId, reaction) => {
 var replyToMessage = async (client, spaceId, messageId, content) => {
   switch (content.type) {
     case "text":
-      await client.messages.send({
-        to: spaceId,
-        replyTo: messageId,
-        text: content.text
-      });
-      break;
+      return toSendResult(
+        await client.messages.send({
+          to: spaceId,
+          replyTo: messageId,
+          text: content.text
+        })
+      );
     case "attachment": {
       const { mediaId } = await client.media.upload({
         file: await content.read(),
@@ -149,15 +380,38 @@ var replyToMessage = async (client, spaceId, messageId, content) => {
       });
       const mediaType = mimeToMediaType(content.mimeType);
       const mediaPayload = mediaType === "document" ? { id: mediaId, filename: content.name } : { id: mediaId };
-      await client.messages.send({
-        to: spaceId,
-        replyTo: messageId,
-        [mediaType]: mediaPayload
+      return toSendResult(
+        await client.messages.send({
+          to: spaceId,
+          replyTo: messageId,
+          [mediaType]: mediaPayload
+        })
+      );
+    }
+    case "contact":
+      return toSendResult(
+        await client.messages.send({
+          to: spaceId,
+          replyTo: messageId,
+          contacts: [contactToWa(content)]
+        })
+      );
+    case "voice": {
+      const { mediaId } = await client.media.upload({
+        file: await content.read(),
+        mimeType: content.mimeType,
+        filename: voiceFilename(content)
       });
-      break;
+      return toSendResult(
+        await client.messages.send({
+          to: spaceId,
+          replyTo: messageId,
+          audio: { id: mediaId }
+        })
+      );
     }
     default:
-      break;
+      throw new Error(`Unsupported WhatsApp content type: ${content.type}`);
   }
 };
 
@@ -214,7 +468,7 @@ var whatsappBusiness = definePlatform("WhatsApp Business", {
   },
   actions: {
     send: async ({ space, content, client }) => {
-      await send(client, space.id, content);
+      return await send(client, space.id, content);
     },
     reactToMessage: async ({ space, messageId, reaction, client }) => {
       await reactToMessage(
@@ -225,7 +479,7 @@ var whatsappBusiness = definePlatform("WhatsApp Business", {
       );
     },
     replyToMessage: async ({ space, messageId, content, client }) => {
-      await replyToMessage(
+      return await replyToMessage(
         client,
         space.id,
         messageId,

package/dist/{types-BdWMydUJ.d.ts → types-DZMHfgYQ.d.ts}

@@ -14,6 +14,70 @@ declare const contentSchema: z__default.ZodDiscriminatedUnion<[z__default.ZodObj
     size: z__default.ZodOptional<z__default.ZodNumber>;
     read: z__default.ZodFunction<z__default.ZodTuple<readonly [], null>, z__default.ZodPromise<z__default.ZodCustom<Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>>>>;
     stream: z__default.ZodFunction<z__default.ZodTuple<readonly [], null>, z__default.ZodPromise<z__default.ZodCustom<ReadableStream<unknown>, ReadableStream<unknown>>>>;
+}, z__default.core.$strip>, z__default.ZodObject<{
+    type: z__default.ZodLiteral<"contact">;
+    user: z__default.ZodOptional<z__default.ZodObject<{
+        __platform: z__default.ZodString;
+        id: z__default.ZodString;
+    }, z__default.core.$strip>>;
+    name: z__default.ZodOptional<z__default.ZodObject<{
+        formatted: z__default.ZodOptional<z__default.ZodString>;
+        first: z__default.ZodOptional<z__default.ZodString>;
+        last: z__default.ZodOptional<z__default.ZodString>;
+        middle: z__default.ZodOptional<z__default.ZodString>;
+        prefix: z__default.ZodOptional<z__default.ZodString>;
+        suffix: z__default.ZodOptional<z__default.ZodString>;
+    }, z__default.core.$strip>>;
+    phones: z__default.ZodOptional<z__default.ZodArray<z__default.ZodObject<{
+        value: z__default.ZodString;
+        type: z__default.ZodOptional<z__default.ZodEnum<{
+            mobile: "mobile";
+            home: "home";
+            work: "work";
+            other: "other";
+        }>>;
+    }, z__default.core.$strip>>>;
+    emails: z__default.ZodOptional<z__default.ZodArray<z__default.ZodObject<{
+        value: z__default.ZodString;
+        type: z__default.ZodOptional<z__default.ZodEnum<{
+            home: "home";
+            work: "work";
+            other: "other";
+        }>>;
+    }, z__default.core.$strip>>>;
+    addresses: z__default.ZodOptional<z__default.ZodArray<z__default.ZodObject<{
+        street: z__default.ZodOptional<z__default.ZodString>;
+        city: z__default.ZodOptional<z__default.ZodString>;
+        region: z__default.ZodOptional<z__default.ZodString>;
+        postalCode: z__default.ZodOptional<z__default.ZodString>;
+        country: z__default.ZodOptional<z__default.ZodString>;
+        type: z__default.ZodOptional<z__default.ZodEnum<{
+            home: "home";
+            work: "work";
+            other: "other";
+        }>>;
+    }, z__default.core.$strip>>>;
+    org: z__default.ZodOptional<z__default.ZodObject<{
+        name: z__default.ZodOptional<z__default.ZodString>;
+        title: z__default.ZodOptional<z__default.ZodString>;
+        department: z__default.ZodOptional<z__default.ZodString>;
+    }, z__default.core.$strip>>;
+    urls: z__default.ZodOptional<z__default.ZodArray<z__default.ZodString>>;
+    birthday: z__default.ZodOptional<z__default.ZodString>;
+    note: z__default.ZodOptional<z__default.ZodString>;
+    photo: z__default.ZodOptional<z__default.ZodObject<{
+        mimeType: z__default.ZodString;
+        read: z__default.ZodFunction<z__default.ZodTuple<readonly [], null>, z__default.ZodPromise<z__default.ZodCustom<Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>>>>;
+    }, z__default.core.$strip>>;
+    raw: z__default.ZodOptional<z__default.ZodUnknown>;
+}, z__default.core.$strip>, z__default.ZodObject<{
+    type: z__default.ZodLiteral<"voice">;
+    name: z__default.ZodOptional<z__default.ZodString>;
+    mimeType: z__default.ZodString;
+    duration: z__default.ZodOptional<z__default.ZodNumber>;
+    size: z__default.ZodOptional<z__default.ZodNumber>;
+    read: z__default.ZodFunction<z__default.ZodTuple<readonly [], null>, z__default.ZodPromise<z__default.ZodCustom<Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>>>>;
+    stream: z__default.ZodFunction<z__default.ZodTuple<readonly [], null>, z__default.ZodPromise<z__default.ZodCustom<ReadableStream<unknown>, ReadableStream<unknown>>>>;
 }, z__default.core.$strip>], "type">;
 type Content = z__default.infer<typeof contentSchema>;
 interface ContentBuilder {
@@ -21,30 +85,42 @@ interface ContentBuilder {
 }
 type ContentInput = string | ContentBuilder;
 
-interface Space<_Def = unknown> {
+interface User {
     readonly __platform: string;
     readonly id: string;
-    responding<T>(fn: () => T | Promise<T>): Promise<T>;
-    send(...content: [ContentInput, ...ContentInput[]]): Promise<void>;
-    startTyping(): Promise<void>;
-    stopTyping(): Promise<void>;
 }
 
-interface User {
+interface Space<_Def = unknown> {
     readonly __platform: string;
+    edit(message: OutboundMessage, newContent: ContentInput): Promise<void>;
     readonly id: string;
+    responding<T>(fn: () => T | Promise<T>): Promise<T>;
+    send(content: ContentInput): Promise<OutboundMessage>;
+    send(...content: [ContentInput, ContentInput, ...ContentInput[]]): Promise<OutboundMessage[]>;
+    startTyping(): Promise<void>;
+    stopTyping(): Promise<void>;
 }
 
-interface Message<TPlatform extends string = string, TSender extends User = User, TSpace extends Space = Space> {
+interface BaseMessage<TPlatform extends string = string, TSender extends User = User, TSpace extends Space = Space> {
     content: Content;
     readonly id: string;
     platform: TPlatform;
     react(reaction: string): Promise<void>;
-    reply(...content: [ContentInput, ...ContentInput[]]): Promise<void>;
-    sender: TSender;
+    reply(content: ContentInput): Promise<OutboundMessage<TPlatform, TSender, TSpace>>;
+    reply(...content: [ContentInput, ContentInput, ...ContentInput[]]): Promise<OutboundMessage<TPlatform, TSender, TSpace>[]>;
     space: TSpace;
     timestamp: Date;
 }
+interface InboundMessage<TPlatform extends string = string, TSender extends User = User, TSpace extends Space = Space> extends BaseMessage<TPlatform, TSender, TSpace> {
+    direction: "inbound";
+    sender: TSender;
+}
+interface OutboundMessage<TPlatform extends string = string, TSender extends User = User, TSpace extends Space = Space> extends BaseMessage<TPlatform, TSender, TSpace> {
+    direction: "outbound";
+    edit(newContent: ContentInput): Promise<void>;
+    sender: TSender | undefined;
+}
+type Message<TPlatform extends string = string, TSender extends User = User, TSpace extends Space = Space> = InboundMessage<TPlatform, TSender, TSpace> | OutboundMessage<TPlatform, TSender, TSpace>;
 
 type ResolvedSpace = Pick<Space, "id">;
 type SpaceRef = Pick<Space, "id" | "__platform">;
@@ -67,6 +143,11 @@ type ProviderMessage<TSender extends ResolvedUser = ResolvedUser, TSpace extends
     space: TSpace;
     timestamp?: Date;
 } & TExtra;
+interface SendResult<TSender extends ResolvedUser = ResolvedUser> {
+    id: string;
+    sender?: TSender;
+    timestamp?: Date;
+}
 type MergeSchema<TSchema extends z__default.ZodType | undefined, TBase extends object> = TSchema extends z__default.ZodType ? string extends keyof z__default.infer<TSchema> ? TBase : Omit<z__default.infer<TSchema>, keyof TBase> & TBase : TBase;
 type SchemaMessage<TUserSchema extends z__default.ZodType | undefined = undefined, TSpaceSchema extends z__default.ZodType | undefined = undefined> = ProviderMessage<MergeSchema<TUserSchema, ResolvedUser>, MergeSchema<TSpaceSchema, ResolvedSpace>>;
 type InferEventPayload<T> = T extends (ctx: never) => AsyncIterable<infer P> ? P : never;
@@ -82,7 +163,7 @@ interface PlatformDef<_Name extends string = string, _ConfigSchema extends z__de
             content: Content;
             client: _Client;
             config: z__default.infer<_ConfigSchema>;
-        }) => Promise<void>;
+        }) => Promise<SendResult<_ResolvedUser>>;
         startTyping?: (_: {
             space: _ResolvedSpace & SpaceRef;
             client: _Client;
@@ -106,6 +187,13 @@ interface PlatformDef<_Name extends string = string, _ConfigSchema extends z__de
             content: Content;
             client: _Client;
             config: z__default.infer<_ConfigSchema>;
+        }) => Promise<SendResult<_ResolvedUser>>;
+        editMessage?: (_: {
+            space: _ResolvedSpace & SpaceRef;
+            messageId: string;
+            content: Content;
+            client: _Client;
+            config: z__default.infer<_ConfigSchema>;
         }) => Promise<void>;
     };
     config: _ConfigSchema;
@@ -151,11 +239,12 @@ interface PlatformDef<_Name extends string = string, _ConfigSchema extends z__de
 }
 interface AnyPlatformDef {
     actions: {
-        send: (_: any) => Promise<void>;
+        send: (_: any) => Promise<SendResult>;
         startTyping?: (_: any) => Promise<void>;
         stopTyping?: (_: any) => Promise<void>;
         reactToMessage?: (_: any) => Promise<void>;
-        replyToMessage?: (_: any) => Promise<void>;
+        replyToMessage?: (_: any) => Promise<SendResult>;
+        editMessage?: (_: any) => Promise<void>;
     };
     config: z__default.ZodType<object>;
     events: {
@@ -254,4 +343,4 @@ interface Platform<Def extends AnyPlatformDef> {
     (message: Message): PlatformMessage<Def>;
 }
 
-export type { AnyPlatformDef as A, ContentBuilder as C, EventProducer as E, Message as M, ProviderMessage as P, SpectrumLike as S, User as U, ContentInput as a, Content as b, PlatformDef as c, Platform as d, PlatformProviderConfig as e, CustomEventStreams as f, Space as g, PlatformInstance as h, PlatformMessage as i, PlatformSpace as j, PlatformUser as k, SchemaMessage as l };
+export type { AnyPlatformDef as A, ContentBuilder as C, EventProducer as E, InboundMessage as I, Message as M, OutboundMessage as O, ProviderMessage as P, SpectrumLike as S, User as U, ContentInput as a, Content as b, PlatformDef as c, Platform as d, PlatformProviderConfig as e, CustomEventStreams as f, Space as g, PlatformInstance as h, PlatformMessage as i, PlatformSpace as j, PlatformUser as k, SchemaMessage as l };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spectrum-ts",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -20,16 +20,23 @@
   },
   "dependencies": {
     "@photon-ai/advanced-imessage": "^0.4.3",
-    "@photon-ai/whatsapp-business": "^0.1.1",
     "@photon-ai/imessage-kit": "^3.0.0-rc.2",
+    "@photon-ai/whatsapp-business": "^0.1.1",
     "@repeaterjs/repeater": "^3.0.6",
     "better-grpc": "^0.3.2",
     "mime-types": "^3.0.1",
     "type-fest": "^5.4.1",
+    "vcf": "^2.1.2",
     "zod": "^4.2.1"
   },
   "peerDependencies": {
+    "ffmpeg-static": "^5",
     "typescript": "^5"
   },
+  "peerDependenciesMeta": {
+    "ffmpeg-static": {
+      "optional": true
+    }
+  },
   "license": "MIT"
 }