zalo-toolkit 1.0.0

package/dist/apis/updateQuickMessage.js

@@ -0,0 +1,61 @@
+import { ZaloApiError } from '../Errors/ZaloApiError.js';
+import { apiFactory } from '../utils.js';
+export const updateQuickMessageFactory = apiFactory()((api, _ctx, utils) => {
+    const serviceURL = utils.makeURL(`${api.zpwServiceMap.quick_message[0]}/api/quickmessage/update`);
+    /**
+     * Update quick message
+     *
+     * @param updatePayload - The payload containing data to update the quick message
+     * @param itemId - The id of the quick message to update
+     *
+     * @note Zalo might throw an error with code 212 if the itemId does not exist.
+     *
+     * @throws {ZaloApiError}
+     */
+    return async function updateQuickMessage(updatePayload, itemId) {
+        const isType = !updatePayload.media ? 0 : 1;
+        const params = {
+            itemId: itemId,
+            keyword: updatePayload.keyword,
+            message: {
+                title: updatePayload.title,
+                params: '',
+            },
+            type: isType,
+        };
+        if (isType === 1) {
+            if (!updatePayload.media)
+                throw new ZaloApiError('Media is required');
+            const uploadMedia = await api.uploadProductPhoto({
+                url: updatePayload.media,
+            });
+            const photoId = uploadMedia.photoId;
+            const thumbUrl = uploadMedia.thumbUrl;
+            const normalUrl = uploadMedia.normalUrl;
+            const hdUrl = uploadMedia.hdUrl;
+            params.media = {
+                items: [
+                    {
+                        type: 0,
+                        photoId: photoId,
+                        title: '',
+                        width: '',
+                        height: '',
+                        previewThumb: thumbUrl,
+                        rawUrl: normalUrl || hdUrl,
+                        thumbUrl: thumbUrl,
+                        normalUrl: normalUrl || hdUrl,
+                        hdUrl: hdUrl || normalUrl,
+                    },
+                ],
+            };
+        }
+        const encryptedParams = utils.encodeAES(JSON.stringify(params));
+        if (!encryptedParams)
+            throw new ZaloApiError('Failed to encrypt params');
+        const response = await utils.request(utils.makeURL(serviceURL, { params: encryptedParams }), {
+            method: 'GET',
+        });
+        return utils.resolve(response);
+    };
+});

package/dist/apis/updateSettings.d.ts

@@ -0,0 +1,16 @@
+export type UpdateSettingsResponse = '';
+export declare enum UpdateSettingsType {
+    ViewBirthday = "view_birthday",
+    ShowOnlineStatus = "show_online_status",
+    DisplaySeenStatus = "display_seen_status",
+    ReceiveMessage = "receive_message",
+    AcceptCall = "accept_stranger_call",
+    AddFriendViaPhone = "add_friend_via_phone",
+    AddFriendViaQR = "add_friend_via_qr",
+    AddFriendViaGroup = "add_friend_via_group",
+    AddFriendViaContact = "add_friend_via_contact",
+    DisplayOnRecommendFriend = "display_on_recommend_friend",
+    ArchivedChat = "archivedChatStatus",
+    QuickMessage = "quickMessageStatus"
+}
+export declare const updateSettingsFactory: (ctx: import("../context.js").ContextBase, api: import("../apis.js").ZaloAPI) => (type: UpdateSettingsType, value: number) => Promise<"">;

package/dist/apis/updateSettings.js

@@ -0,0 +1,90 @@
+import { ZaloApiError } from '../Errors/ZaloApiError.js';
+import { apiFactory } from '../utils.js';
+export var UpdateSettingsType;
+(function (UpdateSettingsType) {
+    UpdateSettingsType["ViewBirthday"] = "view_birthday";
+    UpdateSettingsType["ShowOnlineStatus"] = "show_online_status";
+    UpdateSettingsType["DisplaySeenStatus"] = "display_seen_status";
+    UpdateSettingsType["ReceiveMessage"] = "receive_message";
+    UpdateSettingsType["AcceptCall"] = "accept_stranger_call";
+    UpdateSettingsType["AddFriendViaPhone"] = "add_friend_via_phone";
+    UpdateSettingsType["AddFriendViaQR"] = "add_friend_via_qr";
+    UpdateSettingsType["AddFriendViaGroup"] = "add_friend_via_group";
+    UpdateSettingsType["AddFriendViaContact"] = "add_friend_via_contact";
+    UpdateSettingsType["DisplayOnRecommendFriend"] = "display_on_recommend_friend";
+    UpdateSettingsType["ArchivedChat"] = "archivedChatStatus";
+    UpdateSettingsType["QuickMessage"] = "quickMessageStatus";
+})(UpdateSettingsType || (UpdateSettingsType = {}));
+export const updateSettingsFactory = apiFactory()((_api, _ctx, utils) => {
+    const serviceURL = utils.makeURL(`https://wpa.chat.zalo.me/api/setting/update`);
+    /**
+     * Set account settings
+     *
+     * @param type The type of setting to update
+     * @param value
+     *
+     * ViewBirthday
+     * * 0: hide
+     * * 1: show full day/month/year
+     * * 2: show day/month
+     *
+     * ShowOnlineStatus
+     * * 0: hide
+     * * 1: show
+     *
+     * DisplaySeenStatus
+     * * 0: hide
+     * * 1: show
+     *
+     * ReceiveMessage
+     * * 1: everyone
+     * * 2: only friends
+     *
+     * AcceptCall
+     * * 2: only friends
+     * * 3: everyone
+     * * 4: friends and person who contacted
+     *
+     * AddFriendViaPhone
+     * * 0: disable
+     * * 1: enable
+     *
+     * AddFriendViaQR
+     * * 0: disable
+     * * 1: enable
+     *
+     * AddFriendViaGroup
+     * * 0: disable
+     * * 1: enable
+     *
+     * AddFriendViaContact
+     * * 0: disable
+     * * 1: enable
+     *
+     * DisplayOnRecommendFriend
+     * * 0: disable
+     * * 1: enable
+     *
+     * ArchivedChat
+     * * 0: disable
+     * * 1: enable
+     *
+     * QuickMessage
+     * * 0: disable
+     * * 1: enable
+     *
+     * @throws {ZaloApiError}
+     */
+    return async function updateSettings(type, value) {
+        const params = {
+            [type]: value,
+        };
+        const encryptedParams = utils.encodeAES(JSON.stringify(params));
+        if (!encryptedParams)
+            throw new ZaloApiError('Failed to encrypt params');
+        const response = await utils.request(utils.makeURL(serviceURL, { params: encryptedParams }), {
+            method: 'GET',
+        });
+        return utils.resolve(response);
+    };
+});

package/dist/apis/uploadAttachment.d.ts

@@ -0,0 +1,51 @@
+import type { IFileUpload } from '../core/interfaces/common.js';
+import { ThreadType } from '../models/index.js';
+export type UploadAttachmentImageResponse = {
+    normalUrl: string;
+    photoId: string;
+    finished: number | boolean;
+    hdUrl: string;
+    thumbUrl: string;
+    clientFileId: number;
+    chunkId: number;
+    fileType: 'image';
+    width: number;
+    height: number;
+    totalSize: number;
+    hdSize: number;
+};
+export type UploadAttachmentVideoResponse = {
+    finished: number | boolean;
+    clientFileId: number;
+    chunkId: number;
+    fileType: 'video';
+    fileUrl: string;
+    fileId: string;
+    checksum: string;
+    totalSize: number;
+    fileName: string;
+};
+export type UploadAttachmentFileResponse = {
+    finished: number | boolean;
+    clientFileId: number;
+    chunkId: number;
+    fileType: 'others';
+    fileUrl: string;
+    fileId: string;
+    checksum: string;
+    totalSize: number;
+    fileName: string;
+};
+export type ImageData = {
+    fileName: string;
+    totalSize: number | undefined;
+    width: number | undefined;
+    height: number | undefined;
+};
+export type FileData = {
+    fileName: string;
+    totalSize: number;
+};
+export type UploadAttachmentType = UploadAttachmentImageResponse | UploadAttachmentVideoResponse | UploadAttachmentFileResponse;
+export type UploadAttachmentResponse = UploadAttachmentType[];
+export declare const uploadAttachmentFactory: (ctx: import("../context.js").ContextBase, api: import("../apis.js").ZaloAPI) => (attachments: IFileUpload[], threadId: string, type?: ThreadType) => Promise<UploadAttachmentType[]>;

package/dist/apis/uploadAttachment.js

@@ -0,0 +1,195 @@
+import FormData from 'form-data';
+import { CallbacksMap } from '../context.js';
+import { ZaloApiError } from '../Errors/ZaloApiError.js';
+import { ThreadType } from '../models/index.js';
+import { apiFactory, getImageMetaData, getMd5LargeFileObject, resolveResponse } from '../utils.js';
+const urlType = {
+    image: 'photo_original/upload',
+    video: 'asyncfile/upload',
+    others: 'asyncfile/upload',
+};
+export const uploadAttachmentFactory = apiFactory()((api, ctx, utils) => {
+    const serviceURL = `${api.zpwServiceMap.file[0]}/api`;
+    const { sharefile } = ctx.settings.features;
+    function isExceedMaxFile(totalFile) {
+        return totalFile > sharefile.max_file;
+    }
+    function isExceedMaxFileSize(fileSize) {
+        return fileSize > sharefile.max_size_share_file_v3 * 1024 * 1024;
+    }
+    function isExtensionValid(ext) {
+        return sharefile.restricted_ext_file.indexOf(ext) == -1;
+    }
+    /**
+     * Upload an attachment to a thread
+     *
+     * @param attachments List of attachments
+     * @param threadId Group or User ID
+     * @param type Message type (User or Group)
+     *
+     * @throws {ZaloApiError | ZaloApiMissingImageMetadataGetter}
+     */
+    return async function uploadAttachment(attachments, threadId, type = ThreadType.User) {
+        var _a;
+        if (!attachments || attachments.length == 0)
+            throw new ZaloApiError('Missing attachments');
+        if (isExceedMaxFile(attachments.length))
+            throw new ZaloApiError('Exceed maximum file of ' + sharefile.max_file);
+        if (!threadId)
+            throw new ZaloApiError('Missing threadId');
+        const chunkSize = ctx.settings.features.sharefile.chunk_size_file;
+        const isGroupMessage = type == ThreadType.Group;
+        const attachmentsData = [];
+        const url = `${serviceURL}/${isGroupMessage ? 'group' : 'message'}/`;
+        const typeParam = isGroupMessage ? '11' : '2';
+        let clientId = Date.now();
+        for (const attachment of attachments) {
+            const extFile = attachment.mimetype.split('/')[1];
+            const fileName = attachment.originalname;
+            if (isExtensionValid(extFile) == false)
+                throw new ZaloApiError(`File extension "${extFile}" is not allowed`);
+            const data = {
+                attachment: attachment,
+                chunkContent: [],
+                params: {},
+            };
+            if (isGroupMessage)
+                data.params.grid = threadId;
+            else
+                data.params.toid = threadId;
+            switch (extFile) {
+                case 'jpg':
+                case 'jpeg':
+                case 'png':
+                case 'webp': {
+                    const imageData = await getImageMetaData(attachment);
+                    if (isExceedMaxFileSize(imageData.totalSize))
+                        throw new ZaloApiError(`File ${fileName} size exceed maximum size of ${sharefile.max_size_share_file_v3}MB`);
+                    data.fileData = imageData;
+                    data.fileType = 'image';
+                    data.params.totalChunk = Math.ceil(data.fileData.totalSize / chunkSize);
+                    data.params.fileName = fileName;
+                    data.params.clientId = clientId++;
+                    data.params.totalSize = imageData.totalSize;
+                    data.params.imei = ctx.imei;
+                    data.params.isE2EE = 0;
+                    data.params.jxl = 0;
+                    data.params.chunkId = 1;
+                    break;
+                }
+                case 'mp4': {
+                    const videoSize = attachment.size;
+                    if (isExceedMaxFileSize(videoSize))
+                        throw new ZaloApiError(`File ${fileName} size exceed maximum size of ${sharefile.max_size_share_file_v3}MB`);
+                    data.fileType = 'video';
+                    data.fileData = {
+                        fileName,
+                        totalSize: videoSize,
+                    };
+                    data.params.totalChunk = Math.ceil(data.fileData.totalSize / chunkSize);
+                    data.params.fileName = fileName;
+                    data.params.clientId = clientId++;
+                    data.params.totalSize = videoSize;
+                    data.params.imei = ctx.imei;
+                    data.params.isE2EE = 0;
+                    data.params.jxl = 0;
+                    data.params.chunkId = 1;
+                    break;
+                }
+                default: {
+                    const fileSize = attachment.size;
+                    if (isExceedMaxFileSize(fileSize))
+                        throw new ZaloApiError(`File ${fileName} size exceed maximum size of ${sharefile.max_size_share_file_v3}MB`);
+                    data.fileType = 'others';
+                    data.fileData = {
+                        fileName,
+                        totalSize: fileSize,
+                    };
+                    data.params.totalChunk = Math.ceil(data.fileData.totalSize / chunkSize);
+                    data.params.fileName = fileName;
+                    data.params.clientId = clientId++;
+                    data.params.totalSize = fileSize;
+                    data.params.imei = ctx.imei;
+                    data.params.isE2EE = 0;
+                    data.params.jxl = 0;
+                    data.params.chunkId = 1;
+                    break;
+                }
+            }
+            const fileBuffer = attachment.buffer;
+            for (let i = 0; i < data.params.totalChunk; i++) {
+                const formData = new FormData();
+                const slicedBuffer = fileBuffer.subarray(i * chunkSize, (i + 1) * chunkSize);
+                formData.append('chunkContent', slicedBuffer, {
+                    filename: fileName,
+                    contentType: 'application/octet-stream',
+                });
+                data.chunkContent[i] = formData;
+            }
+            attachmentsData.push(data);
+        }
+        const requests = [], results = [];
+        const callbackResolvers = new CallbacksMap();
+        (_a = api.onUploadCompleted) === null || _a === void 0 ? void 0 : _a.call(api, (dataEvent) => {
+            if (!dataEvent || !dataEvent.callbackId)
+                return;
+            const resolver = callbackResolvers.get(dataEvent.callbackId);
+            if (resolver) {
+                resolver(dataEvent.data);
+                callbackResolvers.delete(dataEvent.callbackId);
+            }
+        });
+        for (const data of attachmentsData) {
+            for (let i = 0; i < data.params.totalChunk; i++) {
+                const encryptedParams = utils.encodeAES(JSON.stringify(data.params));
+                if (!encryptedParams)
+                    throw new ZaloApiError('Failed to encrypt message');
+                requests.push(utils
+                    .request(utils.makeURL(url + urlType[data.fileType], { type: typeParam, params: encryptedParams }), {
+                    method: 'POST',
+                    headers: data.chunkContent[i].getHeaders(),
+                    body: data.chunkContent[i].getBuffer(),
+                })
+                    .then(async (response) => {
+                    /**
+                     * @TODO: better type rather than any
+                     */
+                    const resData = await resolveResponse(ctx, response);
+                    if (resData && resData.fileId != '-1' && resData.photoId != '-1')
+                        await new Promise((resolve) => {
+                            if (data.fileType == 'video' || data.fileType == 'others') {
+                                const callbackId = `${ctx.uid}_${resData.fileId}`;
+                                const uploadCallback = async (wsData) => {
+                                    let result = Object.assign(Object.assign(Object.assign({ fileType: data.fileType }, resData), wsData), { totalSize: data.fileData.totalSize, fileName: data.fileData.fileName, checksum: (await getMd5LargeFileObject(data.attachment)).data });
+                                    results.push(result);
+                                    resolve();
+                                };
+                                callbackResolvers.set(callbackId, uploadCallback);
+                            }
+                            if (data.fileType == 'image') {
+                                const result = {
+                                    fileType: 'image',
+                                    width: data.fileData.width,
+                                    height: data.fileData.height,
+                                    totalSize: data.fileData.totalSize,
+                                    hdSize: data.fileData.totalSize,
+                                    finished: resData.finished,
+                                    normalUrl: resData.normalUrl,
+                                    hdUrl: resData.hdUrl,
+                                    thumbUrl: resData.thumbUrl,
+                                    chunkId: resData.chunkId,
+                                    photoId: resData.photoId,
+                                    clientFileId: resData.clientFileId,
+                                };
+                                results.push(result);
+                                resolve();
+                            }
+                        });
+                }));
+                data.params.chunkId++;
+            }
+        }
+        await Promise.all(requests);
+        return results;
+    };
+});

package/dist/apis/uploadProductPhoto.d.ts

@@ -0,0 +1,13 @@
+export type UploadProductPhotoPayload = {
+    url: string;
+};
+export type UploadProductPhotoResponse = {
+    normalUrl: string;
+    photoId: string;
+    finished: number;
+    hdUrl: string;
+    thumbUrl: string;
+    clientFileId: number;
+    chunkId: number;
+};
+export declare const uploadProductPhotoFactory: (ctx: import("../context.js").ContextBase, api: import("../apis.js").ZaloAPI) => (payload: UploadProductPhotoPayload) => Promise<UploadProductPhotoResponse>;

package/dist/apis/uploadProductPhoto.js

@@ -0,0 +1,45 @@
+import FormData from 'form-data';
+import { getFileUpload } from '../core/utils/index.js';
+import { ZaloApiError } from '../Errors/ZaloApiError.js';
+import { apiFactory, getImageMetaData } from '../utils.js';
+export const uploadProductPhotoFactory = apiFactory()((api, ctx, utils) => {
+    const serviceURL = utils.makeURL(`${api.zpwServiceMap.file[0]}/api/product/upload/photo`);
+    /**
+     * Upload product photo for api quick message, product catalog or custom local storage
+     *
+     * @param payload file path or attachment source
+     *
+     * @throws {ZaloApiError | ZaloApiMissingImageMetadataGetter}
+     */
+    return async function uploadProductPhoto(payload) {
+        const file = await getFileUpload(payload.url);
+        const fileMetaData = await getImageMetaData(file);
+        const fileSize = fileMetaData.totalSize || 0;
+        const formData = new FormData();
+        formData.append('chunkContent', file.buffer, {
+            filename: 'undefined',
+            contentType: 'application/octet-stream',
+        });
+        const params = {
+            totalChunk: 1,
+            fileName: `Base64_Img_Picker_${Date.now()}.jpg`,
+            clientId: Date.now(),
+            totalSize: fileSize,
+            imei: ctx.imei,
+            chunkId: 1,
+            toid: ctx.loginInfo.send2me_id,
+            featureId: 1,
+        };
+        const encryptedParams = utils.encodeAES(JSON.stringify(params));
+        if (!encryptedParams)
+            throw new ZaloApiError('Failed to encrypt params');
+        const response = await utils.request(utils.makeURL(serviceURL, {
+            params: encryptedParams,
+        }), {
+            method: 'POST',
+            headers: formData.getHeaders(),
+            body: formData.getBuffer(),
+        });
+        return utils.resolve(response);
+    };
+});

package/dist/apis/votePoll.d.ts

@@ -0,0 +1,5 @@
+import type { PollOptions } from '../models/index.js';
+export type VotePollResponse = {
+    options: PollOptions[];
+};
+export declare const votePollFactory: (ctx: import("../context.js").ContextBase, api: import("../apis.js").ZaloAPI) => (pollId: number, optionId: number | number[]) => Promise<VotePollResponse>;

package/dist/apis/votePoll.js

@@ -0,0 +1,29 @@
+import { ZaloApiError } from '../Errors/ZaloApiError.js';
+import { apiFactory } from '../utils.js';
+export const votePollFactory = apiFactory()((api, ctx, utils) => {
+    const serviceURL = utils.makeURL(`${api.zpwServiceMap.group[0]}/api/poll/vote`);
+    /**
+     * Vote on a poll
+     *
+     * @param pollId The ID of the poll to vote on
+     * @param optionId The ID(s) of the option to vote on
+     *
+     * @throws ZaloApiError
+     */
+    return async function votePoll(pollId, optionId) {
+        if (!Array.isArray(optionId))
+            optionId = [optionId];
+        const params = {
+            poll_id: pollId,
+            option_ids: optionId, // unvote = empty array
+            imei: ctx.imei,
+        };
+        const encryptedParams = utils.encodeAES(JSON.stringify(params));
+        if (!encryptedParams)
+            throw new ZaloApiError('Failed to encrypt params');
+        const response = await utils.request(utils.makeURL(serviceURL, { params: encryptedParams }), {
+            method: 'GET',
+        });
+        return utils.resolve(response);
+    };
+});