wuzapi 1.0.1 → 1.1.0

package/dist/client.d.ts

@@ -0,0 +1,16 @@
+import { AxiosInstance } from 'axios';
+import { WuzapiConfig } from './types/common.js';
+export declare class WuzapiError extends Error {
+    code: number;
+    details?: unknown;
+    constructor(code: number, message: string, details?: unknown);
+}
+export declare class BaseClient {
+    protected axios: AxiosInstance;
+    protected config: WuzapiConfig;
+    constructor(config: WuzapiConfig);
+    protected request<T>(method: "GET" | "POST" | "DELETE", endpoint: string, data?: unknown): Promise<T>;
+    protected get<T>(endpoint: string): Promise<T>;
+    protected post<T>(endpoint: string, data?: unknown): Promise<T>;
+    protected delete<T>(endpoint: string): Promise<T>;
+}

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export { WuzapiClient } from './wuzapi-client.js';
+export { WuzapiError } from './client.js';
+export * from './types/index.js';
+export { AdminModule } from './modules/admin.js';
+export { SessionModule } from './modules/session.js';
+export { UserModule } from './modules/user.js';
+export { ChatModule } from './modules/chat.js';
+export { GroupModule } from './modules/group.js';
+export { WebhookModule } from './modules/webhook.js';
+export { WuzapiClient as default } from './wuzapi-client.js';

package/dist/modules/admin.d.ts

@@ -0,0 +1,16 @@
+import { BaseClient } from '../client.js';
+import { User, CreateUserRequest, CreateUserResponse, DeleteUserResponse } from '../types/admin.js';
+export declare class AdminModule extends BaseClient {
+    /**
+     * List all users
+     */
+    listUsers(): Promise<User[]>;
+    /**
+     * Add a new user
+     */
+    addUser(user: CreateUserRequest): Promise<CreateUserResponse>;
+    /**
+     * Delete a user by ID
+     */
+    deleteUser(id: number): Promise<DeleteUserResponse>;
+}

package/dist/modules/chat.d.ts

@@ -0,0 +1,68 @@
+import { BaseClient } from '../client.js';
+import { SendMessageResponse, SendTextRequest, SendTemplateRequest, SendAudioRequest, SendImageRequest, SendDocumentRequest, SendVideoRequest, SendStickerRequest, SendLocationRequest, SendContactRequest, ChatPresenceRequest, MarkReadRequest, ReactRequest, DownloadMediaRequest, DownloadMediaResponse } from '../types/chat.js';
+export declare class ChatModule extends BaseClient {
+    /**
+     * Send a text message
+     */
+    sendText(request: SendTextRequest): Promise<SendMessageResponse>;
+    /**
+     * Send a template message with buttons
+     */
+    sendTemplate(request: SendTemplateRequest): Promise<SendMessageResponse>;
+    /**
+     * Send an audio message
+     */
+    sendAudio(request: SendAudioRequest): Promise<SendMessageResponse>;
+    /**
+     * Send an image message
+     */
+    sendImage(request: SendImageRequest): Promise<SendMessageResponse>;
+    /**
+     * Send a document message
+     */
+    sendDocument(request: SendDocumentRequest): Promise<SendMessageResponse>;
+    /**
+     * Send a video message
+     */
+    sendVideo(request: SendVideoRequest): Promise<SendMessageResponse>;
+    /**
+     * Send a sticker message
+     */
+    sendSticker(request: SendStickerRequest): Promise<SendMessageResponse>;
+    /**
+     * Send a location message
+     */
+    sendLocation(request: SendLocationRequest): Promise<SendMessageResponse>;
+    /**
+     * Send a contact message
+     */
+    sendContact(request: SendContactRequest): Promise<SendMessageResponse>;
+    /**
+     * Send chat presence indication (typing indicator)
+     */
+    sendPresence(request: ChatPresenceRequest): Promise<void>;
+    /**
+     * Mark messages as read
+     */
+    markRead(request: MarkReadRequest): Promise<void>;
+    /**
+     * React to a message
+     */
+    react(request: ReactRequest): Promise<SendMessageResponse>;
+    /**
+     * Download an image from a message
+     */
+    downloadImage(request: DownloadMediaRequest): Promise<DownloadMediaResponse>;
+    /**
+     * Download a video from a message
+     */
+    downloadVideo(request: DownloadMediaRequest): Promise<DownloadMediaResponse>;
+    /**
+     * Download an audio from a message
+     */
+    downloadAudio(request: DownloadMediaRequest): Promise<DownloadMediaResponse>;
+    /**
+     * Download a document from a message
+     */
+    downloadDocument(request: DownloadMediaRequest): Promise<DownloadMediaResponse>;
+}

package/dist/modules/group.d.ts

@@ -0,0 +1,40 @@
+import { BaseClient } from '../client.js';
+import { GroupListResponse, GroupInviteLinkResponse, GroupInfo, GroupPhotoResponse, GroupNameResponse, GroupCreateResponse, GroupLockedResponse, GroupEphemeralResponse, GroupPhotoRemoveResponse } from '../types/group.js';
+export declare class GroupModule extends BaseClient {
+    /**
+     * List all subscribed groups
+     */
+    list(): Promise<GroupListResponse>;
+    /**
+     * Get group invite link
+     */
+    getInviteLink(groupJID: string): Promise<GroupInviteLinkResponse>;
+    /**
+     * Get group information
+     */
+    getInfo(groupJID: string): Promise<GroupInfo>;
+    /**
+     * Change group photo (JPEG only)
+     */
+    setPhoto(groupJID: string, image: string): Promise<GroupPhotoResponse>;
+    /**
+     * Change group name
+     */
+    setName(groupJID: string, name: string): Promise<GroupNameResponse>;
+    /**
+     * Create a new group
+     */
+    create(name: string, participants: string[]): Promise<GroupCreateResponse>;
+    /**
+     * Set group locked status
+     */
+    setLocked(groupJID: string, locked: boolean): Promise<GroupLockedResponse>;
+    /**
+     * Set disappearing messages timer
+     */
+    setEphemeral(groupJID: string, duration: "24h" | "7d" | "90d" | "off"): Promise<GroupEphemeralResponse>;
+    /**
+     * Remove group photo
+     */
+    removePhoto(groupJID: string): Promise<GroupPhotoRemoveResponse>;
+}

package/dist/modules/session.d.ts

@@ -0,0 +1,43 @@
+import { BaseClient } from '../client.js';
+import { ConnectRequest, ConnectResponse, DisconnectResponse, LogoutResponse, StatusResponse, QRCodeResponse, S3ConfigResponse, S3TestResponse } from '../types/session.js';
+import { S3Config } from '../types/common.js';
+export declare class SessionModule extends BaseClient {
+    /**
+     * Connect to WhatsApp servers
+     */
+    connect(options: ConnectRequest): Promise<ConnectResponse>;
+    /**
+     * Disconnect from WhatsApp servers
+     */
+    disconnect(): Promise<DisconnectResponse>;
+    /**
+     * Logout and finish the session
+     */
+    logout(): Promise<LogoutResponse>;
+    /**
+     * Get session status
+     */
+    getStatus(): Promise<StatusResponse>;
+    /**
+     * Get QR code for scanning
+     */
+    getQRCode(): Promise<QRCodeResponse>;
+    /**
+     * Configure S3 storage
+     */
+    configureS3(config: S3Config): Promise<S3ConfigResponse>;
+    /**
+     * Get S3 configuration
+     */
+    getS3Config(): Promise<S3ConfigResponse>;
+    /**
+     * Test S3 connection
+     */
+    testS3(): Promise<S3TestResponse>;
+    /**
+     * Delete S3 configuration
+     */
+    deleteS3Config(): Promise<{
+        Details: string;
+    }>;
+}

package/dist/modules/user.d.ts

@@ -0,0 +1,20 @@
+import { BaseClient } from '../client.js';
+import { UserInfoResponse, UserCheckResponse, UserAvatarResponse, ContactsResponse } from '../types/user.js';
+export declare class UserModule extends BaseClient {
+    /**
+     * Get user details for specified phone numbers
+     */
+    getInfo(phones: string[]): Promise<UserInfoResponse>;
+    /**
+     * Check if phone numbers are registered WhatsApp users
+     */
+    check(phones: string[]): Promise<UserCheckResponse>;
+    /**
+     * Get user avatar/profile picture
+     */
+    getAvatar(phone: string, preview?: boolean): Promise<UserAvatarResponse>;
+    /**
+     * Get all contacts
+     */
+    getContacts(): Promise<ContactsResponse>;
+}

package/dist/modules/webhook.d.ts

@@ -0,0 +1,12 @@
+import { BaseClient } from '../client.js';
+import { SetWebhookResponse, GetWebhookResponse } from '../types/webhook.js';
+export declare class WebhookModule extends BaseClient {
+    /**
+     * Set webhook URL and events to subscribe to
+     */
+    setWebhook(webhookURL: string): Promise<SetWebhookResponse>;
+    /**
+     * Get current webhook configuration
+     */
+    getWebhook(): Promise<GetWebhookResponse>;
+}

package/dist/types/admin.d.ts

@@ -0,0 +1,27 @@
+import { ProxyConfig, S3Config } from './common.js';
+export interface User {
+    id: number;
+    name: string;
+    token: string;
+    webhook: string;
+    jid: string;
+    qrcode: string;
+    connected: boolean;
+    expiration: number;
+    events: string;
+}
+export interface CreateUserRequest {
+    name: string;
+    token: string;
+    webhook?: string;
+    events: string;
+    expiration?: number;
+    proxyConfig?: ProxyConfig;
+    s3Config?: S3Config;
+}
+export interface CreateUserResponse {
+    id: number;
+}
+export interface DeleteUserResponse {
+    Details: string;
+}

package/dist/types/chat.d.ts

@@ -0,0 +1,94 @@
+import { ContextInfo } from './common.js';
+export interface SendMessageResponse {
+    Details: string;
+    Id: string;
+    Timestamp: string;
+}
+export interface SendTextRequest {
+    Phone: string;
+    Body: string;
+    Id?: string;
+    ContextInfo?: ContextInfo;
+}
+export interface TemplateButton {
+    DisplayText: string;
+    Type: "quickreply" | "url" | "call";
+    Url?: string;
+    PhoneNumber?: string;
+}
+export interface SendTemplateRequest {
+    Phone: string;
+    Content: string;
+    Footer?: string;
+    Buttons: TemplateButton[];
+    ContextInfo?: ContextInfo;
+}
+export interface SendAudioRequest {
+    Phone: string;
+    Audio: string;
+    ContextInfo?: ContextInfo;
+}
+export interface SendImageRequest {
+    Phone: string;
+    Image: string;
+    Caption?: string;
+    ContextInfo?: ContextInfo;
+}
+export interface SendDocumentRequest {
+    Phone: string;
+    Document: string;
+    FileName: string;
+    ContextInfo?: ContextInfo;
+}
+export interface SendVideoRequest {
+    Phone: string;
+    Video: string;
+    Caption?: string;
+    JpegThumbnail?: string;
+    ContextInfo?: ContextInfo;
+}
+export interface SendStickerRequest {
+    Phone: string;
+    Sticker: string;
+    PngThumbnail?: string;
+    ContextInfo?: ContextInfo;
+}
+export interface SendLocationRequest {
+    Phone: string;
+    Latitude: number;
+    Longitude: number;
+    Name?: string;
+    ContextInfo?: ContextInfo;
+}
+export interface SendContactRequest {
+    Phone: string;
+    Name: string;
+    Vcard: string;
+    ContextInfo?: ContextInfo;
+}
+export interface ChatPresenceRequest {
+    Phone: string;
+    State: "composing" | "paused";
+    Media?: string;
+}
+export interface MarkReadRequest {
+    Id: string[];
+    Chat: string;
+    Sender?: string;
+}
+export interface ReactRequest {
+    Phone: string;
+    Body: string;
+    Id: string;
+}
+export interface DownloadMediaRequest {
+    Url: string;
+    MediaKey: string;
+    Mimetype: string;
+    FileSHA256: string;
+    FileLength: number;
+    FileEncSHA256?: string;
+}
+export interface DownloadMediaResponse {
+    [key: string]: unknown;
+}

package/dist/types/common.d.ts

@@ -0,0 +1,29 @@
+export interface WuzapiConfig {
+    apiUrl: string;
+    token: string;
+}
+export interface WuzapiResponse<T = unknown> {
+    code: number;
+    data: T;
+    success: boolean;
+}
+export interface ContextInfo {
+    StanzaId: string;
+    Participant: string;
+}
+export interface ProxyConfig {
+    enabled: boolean;
+    proxyURL: string;
+}
+export interface S3Config {
+    enabled: boolean;
+    endpoint: string;
+    region: string;
+    bucket: string;
+    accessKey: string;
+    secretKey: string;
+    pathStyle: boolean;
+    publicURL?: string;
+    mediaDelivery: "base64" | "s3" | "both";
+    retentionDays: number;
+}

package/dist/types/group.d.ts

@@ -0,0 +1,76 @@
+export interface GroupParticipant {
+    IsAdmin: boolean;
+    IsSuperAdmin: boolean;
+    JID: string;
+}
+export interface GroupInfo {
+    AnnounceVersionID: string;
+    DisappearingTimer: number;
+    GroupCreated: string;
+    IsAnnounce: boolean;
+    IsEphemeral: boolean;
+    IsLocked: boolean;
+    JID: string;
+    Name: string;
+    NameSetAt: string;
+    NameSetBy: string;
+    OwnerJID: string;
+    ParticipantVersionID: string;
+    Participants: GroupParticipant[];
+    Topic: string;
+    TopicID: string;
+    TopicSetAt: string;
+    TopicSetBy: string;
+}
+export interface GroupListResponse {
+    Groups: GroupInfo[];
+}
+export interface GroupInviteLinkRequest {
+    GroupJID: string;
+}
+export interface GroupInviteLinkResponse {
+    InviteLink: string;
+}
+export interface GroupInfoRequest {
+    GroupJID: string;
+}
+export interface GroupPhotoRequest {
+    GroupJID: string;
+    Image: string;
+}
+export interface GroupPhotoResponse {
+    Details: string;
+    PictureID: string;
+}
+export interface GroupNameRequest {
+    GroupJID: string;
+    Name: string;
+}
+export interface GroupNameResponse {
+    Details: string;
+}
+export interface GroupCreateRequest {
+    name: string;
+    participants: string[];
+}
+export type GroupCreateResponse = GroupInfo;
+export interface GroupLockedRequest {
+    groupjid: string;
+    locked: boolean;
+}
+export interface GroupLockedResponse {
+    Details: string;
+}
+export interface GroupEphemeralRequest {
+    groupjid: string;
+    duration: "24h" | "7d" | "90d" | "off";
+}
+export interface GroupEphemeralResponse {
+    Details: string;
+}
+export interface GroupPhotoRemoveRequest {
+    groupjid: string;
+}
+export interface GroupPhotoRemoveResponse {
+    Details: string;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,7 @@
+export * from './common.js';
+export * from './admin.js';
+export * from './session.js';
+export * from './user.js';
+export * from './chat.js';
+export * from './group.js';
+export * from './webhook.js';

package/dist/types/session.d.ts

@@ -0,0 +1,32 @@
+import { S3Config } from './common.js';
+export interface ConnectRequest {
+    Subscribe: string[];
+    Immediate?: boolean;
+}
+export interface ConnectResponse {
+    details: string;
+    events: string;
+    jid: string;
+    webhook: string;
+}
+export interface DisconnectResponse {
+    Details: string;
+}
+export interface LogoutResponse {
+    Details: string;
+}
+export interface StatusResponse {
+    Connected: boolean;
+    LoggedIn: boolean;
+}
+export interface QRCodeResponse {
+    QRCode: string;
+}
+export interface S3ConfigResponse extends S3Config {
+    accessKey: string;
+}
+export interface S3TestResponse {
+    Details: string;
+    Bucket: string;
+    Region: string;
+}

package/dist/types/user.d.ts

@@ -0,0 +1,55 @@
+export interface UserInfoRequest {
+    Phone: string[];
+}
+export interface VerifiedName {
+    Certificate: {
+        details: string;
+        signature: string;
+    };
+    Details: {
+        issuer: string;
+        serial: number;
+        verifiedName: string;
+    };
+}
+export interface UserInfo {
+    Devices: string[];
+    PictureID: string;
+    Status: string;
+    VerifiedName: VerifiedName | null;
+}
+export interface UserInfoResponse {
+    Users: Record<string, UserInfo>;
+}
+export interface UserCheckRequest {
+    Phone: string[];
+}
+export interface UserCheck {
+    IsInWhatsapp: boolean;
+    JID: string;
+    Query: string;
+    VerifiedName: string;
+}
+export interface UserCheckResponse {
+    Users: UserCheck[];
+}
+export interface UserAvatarRequest {
+    Phone: string;
+    Preview: boolean;
+}
+export interface UserAvatarResponse {
+    URL: string;
+    ID: string;
+    Type: string;
+    DirectPath: string;
+}
+export interface Contact {
+    BusinessName: string;
+    FirstName: string;
+    Found: boolean;
+    FullName: string;
+    PushName: string;
+}
+export interface ContactsResponse {
+    [jid: string]: Contact;
+}

package/dist/types/webhook.d.ts

@@ -0,0 +1,10 @@
+export interface SetWebhookRequest {
+    webhookURL: string;
+}
+export interface SetWebhookResponse {
+    webhook: string;
+}
+export interface GetWebhookResponse {
+    subscribe: string[];
+    webhook: string;
+}

package/dist/vite-env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />

package/dist/wuzapi-client.d.ts

@@ -0,0 +1,22 @@
+import { WuzapiConfig } from './types/common.js';
+import { AdminModule } from './modules/admin.js';
+import { SessionModule } from './modules/session.js';
+import { UserModule } from './modules/user.js';
+import { ChatModule } from './modules/chat.js';
+import { GroupModule } from './modules/group.js';
+import { WebhookModule } from './modules/webhook.js';
+export declare class WuzapiClient {
+    readonly admin: AdminModule;
+    readonly session: SessionModule;
+    readonly user: UserModule;
+    readonly chat: ChatModule;
+    readonly group: GroupModule;
+    readonly webhook: WebhookModule;
+    readonly users: UserModule;
+    readonly message: ChatModule;
+    constructor(config: WuzapiConfig);
+    /**
+     * Test connection to the API
+     */
+    ping(): Promise<boolean>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wuzapi",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "TypeScript client library for WuzAPI WhatsApp API",
   "type": "module",
   "main": "./dist/index.js",
@@ -17,7 +17,7 @@
   ],
   "scripts": {
     "dev": "vite",
-    "build": "tsc -p tsconfig.build.json && vite build",
+    "build": "vite build",
     "preview": "vite preview",
     "lint": "eslint src --ext .ts,.tsx",
     "lint:fix": "eslint src --ext .ts,.tsx --fix",
@@ -50,7 +50,8 @@
     "@typescript-eslint/parser": "^8.41.0",
     "eslint": "^9.34.0",
     "typescript": "~5.8.3",
-    "vite": "^7.1.2"
+    "vite": "^7.1.2",
+    "vite-plugin-dts": "^4.5.4"
   },
   "dependencies": {
     "axios": "^1.11.0"