@gymspace/evolution 1.0.0

package/src/schemas/client.ts

@@ -0,0 +1,23 @@
+// Pure TypeScript interfaces for better IDE support and performance
+
+/**
+ * Configuration options for the Evolution API client
+ */
+export interface ClientOptions {
+	/**
+	 * Your server URL
+	 */
+	serverUrl: string;
+	/**
+	 * Your instance token or global API key
+	 */
+	token: string;
+	/**
+	 * Your instance name
+	 */
+	instance?: string;
+	/**
+	 * Custom headers to include in requests
+	 */
+	headers?: Record<string, string>;
+}

package/src/schemas/common.ts

@@ -0,0 +1,44 @@
+// Pure TypeScript types and utility functions for better IDE support and performance
+import { isValidPhoneNumber, parsePhoneNumber } from "libphonenumber-js";
+import type { GroupInviteCode, GroupJid, Jid } from "@/types/tags";
+
+// Type definitions
+export type PhoneNumber = string;
+export type MessageId = string;
+export type ChatId = PhoneNumber | Jid | GroupJid;
+export type ApiNumber = PhoneNumber | Jid | GroupJid;
+export type Media = string; // URL or base64 string
+
+// Utility functions
+export const validatePhoneNumber = (value: string): boolean => isValidPhoneNumber(value);
+export const parsePhoneNumberUtil = (phoneNumber: string): string => parsePhoneNumber(phoneNumber).number;
+
+export const validateJid = (value: string): boolean => value.endsWith("@s.whatsapp.net");
+export const validateGroupJid = (value: string): boolean => value.endsWith("@g.us");
+export const validateGroupInviteCode = (value: string): boolean => 
+  value.length === 22 && /^[a-zA-Z0-9]{22}$/.test(value);
+
+export const validateMedia = (value: string): boolean => {
+  // Check if it's a URL or base64 string
+  try {
+    new URL(value);
+    return true;
+  } catch {
+    // Check if it's a valid base64 string
+    try {
+      return btoa(atob(value)) === value;
+    } catch {
+      return false;
+    }
+  }
+};
+
+// Backward compatibility - keeping the schema names but as type aliases
+export type PhoneNumberSchema = PhoneNumber;
+export type JidSchema = Jid;
+export type GroupJidSchema = GroupJid;
+export type GroupInviteCodeSchema = GroupInviteCode;
+export type MessageIdSchema = MessageId;
+export type ChatIdSchema = ChatId;
+export type ApiNumberSchema = ApiNumber;
+export type mediaSchema = Media;

package/src/types/api.ts

@@ -0,0 +1,17 @@
+// Internal interface used by the service
+export interface APIRequestInit {
+  method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+  params?: any; // Accept any object type for params
+  body?: any; // Accept any object type for body
+  headers?: Record<string, string>;
+  isInstanceUrl?: boolean;
+  instance?: string;
+}
+
+// Public interface for method options that users can pass
+export interface MethodOptions {
+  /**
+   * Instance name to use for this request (overrides default instance)
+   */
+  instance?: string;
+}

package/src/types/events.ts

@@ -0,0 +1,53 @@
+export enum WebhookEvent {
+  APPLICATION_STARTUP = "application.startup",
+  QRCODE_UPDATED = "qrcode.updated",
+  CONNECTION_UPDATE = "connection.update",
+  MESSAGES_SET = "messages.set",
+  MESSAGES_UPSERT = "messages.upsert",
+  MESSAGES_UPDATE = "messages.update",
+  MESSAGES_DELETE = "messages.delete",
+  SEND_MESSAGE = "send.message",
+  CONTACTS_SET = "contacts.set",
+  CONTACTS_UPSERT = "contacts.upsert",
+  CONTACTS_UPDATE = "contacts.update",
+  PRESENCE_UPDATE = "presence.update",
+  CHATS_SET = "chats.set",
+  CHATS_UPDATE = "chats.update",
+  CHATS_UPSERT = "chats.upsert",
+  CHATS_DELETE = "chats.delete",
+  GROUPS_UPSERT = "groups.upsert",
+  GROUPS_UPDATE = "groups.update",
+  GROUP_PARTICIPANTS_UPDATE = "group.participants.update",
+  NEW_TOKEN = "new.jwt",
+}
+
+export enum WebhookEventSetup {
+  APPLICATION_STARTUP = "APPLICATION_STARTUP",
+  QRCODE_UPDATED = "QRCODE_UPDATED",
+  CONNECTION_UPDATE = "CONNECTION_UPDATE",
+  MESSAGES_SET = "MESSAGES_SET",
+  MESSAGES_UPSERT = "MESSAGES_UPSERT",
+  MESSAGES_UPDATE = "MESSAGES_UPDATE",
+  MESSAGES_DELETE = "MESSAGES_DELETE",
+  SEND_MESSAGE = "SEND_MESSAGE",
+  CONTACTS_SET = "CONTACTS_SET",
+  CONTACTS_UPSERT = "CONTACTS_UPSERT",
+  CONTACTS_UPDATE = "CONTACTS_UPDATE",
+  PRESENCE_UPDATE = "PRESENCE_UPDATE",
+  CHATS_SET = "CHATS_SET",
+  CHATS_UPDATE = "CHATS_UPDATE",
+  CHATS_UPSERT = "CHATS_UPSERT",
+  CHATS_DELETE = "CHATS_DELETE",
+  GROUPS_UPSERT = "GROUPS_UPSERT",
+  GROUPS_UPDATE = "GROUPS_UPDATE",
+  GROUP_PARTICIPANTS_UPDATE = "GROUP_PARTICIPANTS_UPDATE",
+  NEW_TOKEN = "NEW_TOKEN",
+  MESSAGES_EDITED = "MESSAGES_EDITED",
+  LABELS_EDIT = "LABELS_EDIT",
+  LABELS_ASSOCIATION = "LABELS_ASSOCIATION",
+  CALL = "CALL",
+  TYPEBOT_START = "TYPEBOT_START",
+  TYPEBOT_CHANGE_STATUS = "TYPEBOT_CHANGE_STATUS",
+  ERRORS = "ERRORS",
+  ERRORS_WEBHOOK = "ERRORS_WEBHOOK",
+}

package/src/types/messages.ts

@@ -0,0 +1,5 @@
+export enum MessageUpdateStatus {
+  DELIVERY_ACK = "DELIVERY_ACK",
+  READ = "READ",
+  SERVER_ACK = "SERVER_ACK",
+}

package/src/types/tags.ts

@@ -0,0 +1,14 @@
+export type Jid = `${string}@s.whatsapp.net` | string;
+export const Jid = (jid: string) => jid as Jid;
+
+export type GroupJid = `${string}@g.us` | string;
+export const GroupJid = (jid: string) => jid as GroupJid;
+
+export type GroupInviteCode = string & { __tag: "GroupInviteCode" };
+export const GroupInviteCode = (code: string) => code as GroupInviteCode;
+
+export type MessageId = string & { __tag: "MessageId" };
+export const MessageId = (id: string) => id as MessageId;
+
+export type ChatId = string & { __tag: "ChatId" };
+export const ChatId = (id: string) => id as ChatId;

package/src/types/webhooks.ts

@@ -0,0 +1,255 @@
+import { MessageUpdateStatus } from "./messages";
+
+export enum ConnectionState {
+  OPEN = "open",
+  CONNECTING = "connecting",
+  CLOSED = "close",
+  REFUSED = "refused",
+}
+
+export enum MessageType {
+  CONVERSATION = "conversation",
+  TEXT = "textMessage",
+  EPHEMERAL = "ephemeralMessage",
+  AUDIO = "audioMessage",
+  IMAGE = "imageMessage",
+  VIDEO = "videoMessage",
+  DOCUMENT = "documentMessage",
+  STICKER = "stickerMessage",
+  CONTACT = "contactMessage",
+  LOCATION = "locationMessage",
+  REACTION = "reactionMessage",
+  BUTTONS = "buttonsMessage",
+}
+
+export interface DeviceListMetadata {
+  senderKeyHash: string;
+  senderTimestamp: string;
+  recipientKeyHash: string;
+  recipientTimestamp: string;
+}
+
+export interface MessageContextInfo {
+  deviceListMetadata?: DeviceListMetadata | Record<string, unknown>;
+  deviceListMetadataVersion: number;
+  messageSecret: string;
+}
+
+export interface DisappearingMode {
+  initiator: string;
+  trigger: string;
+  initiatedByMe: boolean;
+}
+
+export interface ContextInfo {
+  expiration?: number;
+  ephemeralSettingTimestamp?: string;
+  disappearingMode?: DisappearingMode;
+  stanzaId?: string;
+  participant?: string;
+  quotedMessage?: {
+    conversation?: string;
+  };
+  statusSourceType?: string;
+  forwardingScore?: number;
+  isForwarded?: boolean;
+  pairedMediaType?: string;
+}
+
+export interface ImageMessage {
+  url: string;
+  mimetype: string;
+  fileSha256: string;
+  fileLength: string;
+  height: number;
+  width: number;
+  mediaKey: string;
+  fileEncSha256: string;
+  directPath: string;
+  mediaKeyTimestamp: string;
+  jpegThumbnail: string;
+  contextInfo?: ContextInfo;
+  firstScanSidecar: string;
+  firstScanLength: number;
+  scansSidecar: string;
+  scanLengths: number[];
+  midQualityFileSha256: string;
+  imageSourceType: string;
+}
+
+export interface AudioMessage {
+  url: string;
+  mimetype: string;
+  fileSha256: string;
+  fileLength: string;
+  seconds: number;
+  ptt: boolean;
+  mediaKey: string;
+  fileEncSha256: string;
+  directPath: string;
+  mediaKeyTimestamp: string;
+  waveform: string;
+}
+
+export interface StickerMessage {
+  url: string;
+  width: number;
+  height: number;
+  isAvatar: boolean;
+  isLottie: boolean;
+  mediaKey: string;
+  mimetype: string;
+  directPath: string;
+  fileLength: string;
+  fileSha256: string;
+  isAnimated: boolean;
+  isAiSticker: boolean;
+  fileEncSha256: string;
+  stickerSentTs: string;
+  mediaKeyTimestamp: string;
+}
+
+export interface VideoMessage {
+  url: string;
+  mimetype: string;
+  fileSha256: string;
+  fileLength: string;
+  seconds: number;
+  mediaKey: string;
+  height: number;
+  width: number;
+  fileEncSha256: string;
+  directPath: string;
+  mediaKeyTimestamp: string;
+  jpegThumbnail: string;
+  contextInfo?: ContextInfo;
+  streamingSidecar: string;
+  externalShareFullVideoDurationInSeconds: number;
+}
+
+export interface ReactionMessage {
+  key: {
+    remoteJid: string;
+    fromMe: boolean;
+    id: string;
+  };
+  text: string;
+  senderTimestampMs: string;
+}
+
+export interface DocumentMessage {
+  url: string;
+  mimetype: string;
+  fileSha256: string;
+  fileLength: string;
+  pageCount: number;
+  mediaKey: string;
+  fileName: string;
+  fileEncSha256: string;
+  directPath: string;
+  mediaKeyTimestamp: string;
+  contextInfo: ContextInfo;
+  caption: string;
+}
+
+export interface ContactMessage {
+  displayName: string;
+  vcard: string;
+}
+
+export interface ExtendedTextMessage {
+  text: string;
+  contextInfo?: ContextInfo;
+}
+
+export type MessageContent = {
+  messageContextInfo?: MessageContextInfo;
+  conversation?: string;
+  extendedTextMessage?: ExtendedTextMessage;
+  imageMessage?: ImageMessage;
+  audioMessage?: AudioMessage;
+  stickerMessage?: StickerMessage;
+  ephemeralMessage?: EphemeralMessage;
+  videoMessage?: VideoMessage;
+  documentMessage?: DocumentMessage;
+  contactMessage?: ContactMessage;
+  locationMessage?: any;
+  reactionMessage?: ReactionMessage;
+  buttonsMessage?: any;
+};
+
+export interface MessageUpdate {
+  status: MessageUpdateStatus;
+}
+
+export interface ConnectionUpdatePayload {
+  instance: string;
+  wuid?: string;
+  profileName?: string;
+  profilePictureUrl?: string | null;
+  state: ConnectionState;
+  statusReason: number;
+}
+
+export interface ContactPayload {
+  remoteJid: string;
+  pushName: string;
+  profilePicUrl: string | null;
+  instanceId: string;
+}
+
+export interface EphemeralMessage {
+  message: MessageContent;
+}
+
+export interface MessagePayload {
+  key: {
+    remoteJid: string;
+    fromMe: boolean;
+    id: string;
+    senderLid?: string;
+  };
+  pushName?: string;
+  message?: MessageContent;
+  messageType?: MessageType;
+  messageTimestamp?: number;
+  status?: string;
+  participant?: string;
+  contextInfo?: ContextInfo;
+  instanceId?: string;
+  source?: string;
+}
+
+export interface WebhookData {
+  event: string;
+  instance: string;
+  data:
+    | MessagePayload
+    | ContactPayload
+    | ContactPayload[]
+    | ConnectionUpdatePayload;
+  sender: string;
+  date?: number;
+  instanceName?: string;
+  destination?: string;
+  date_time?: string;
+  server_url?: string;
+  apikey?: string;
+}
+
+export interface Instance {
+  instanceName: string;
+  status: string;
+  qrcode?: string;
+}
+
+export interface Message {
+  key: {
+    remoteJid: string;
+    fromMe: boolean;
+    id: string;
+  };
+  message: Record<string, unknown>;
+  messageTimestamp: number;
+  pushName?: string;
+}

package/src/utils/phone-numer-from-jid.ts

@@ -0,0 +1,9 @@
+import { parsePhoneNumber } from "libphonenumber-js";
+
+/**
+ * Get phone number from JID
+ * @param jid - JID (remote JID)
+ */
+export function phoneNumberFromJid(jid: string) {
+	return parsePhoneNumber(`+${jid.split("@")[0]}`).number;
+}