@htilssu/wowo/libs/WowoWallet.ts

Module tương tác với ứng dụng e-wallet môn học CNPM-DAPM

import axios, {AxiosInstance} from "axios";
import {isValidUrl} from "./utils";

interface WalletDTO {
    id: string,
    balance: number,
    currency: string,
}

export class WoWoWallet {

    req: AxiosInstance
    private readonly apiKey: string
    private readonly baseUrl: string = "https://api.wowo.htilssu.id.vn"

    /**
     * Tạo mới một instance của WoWoWallet
     * @param apiKey API KEY được cung cấp bởi WowoWallet
     * @param baseUrl URL của WowoWallet, mặc định là {@link https://api.wowo.htilssu.id.vn}
     */
    constructor(apiKey: string, baseUrl?: string) {

        if (!apiKey) {
            throw new Error("API KEY không được để trống")
        }

        this.apiKey = apiKey

        if (baseUrl && !isValidUrl(baseUrl)) {
            throw new Error("Invalid baseUrl")
        }

        this.baseUrl = baseUrl ?? this.baseUrl;
        this.req = axios.create({
            baseURL: this.baseUrl,
            headers: {
                "X-API-KEY": this.apiKey
            }
        })
    }

    /**
     * Tạo một đơn hàng mới
     * @param props Thông tin đơn hàng
     */
    async createOrder(props: CreateOrderProps): Promise<OrderResponse> {

        if (props.items && props.items.length !== 0) {
            const itemHasNegativePriceOrNegativeQuantity = props.items.find(
                value => value.unitPrice < 0 || value.amount <= 0);
            if (itemHasNegativePriceOrNegativeQuantity) {
                throw new Error("Giá của item phải lớn hơn hoặc bằng 0, Số lượng phải lớn hơn 0")
            }
        }

        if (props.money < 0) {
            throw new Error('Số tiền phải lớn hơn hoặc bằng 0')
        }

        if (!isValidUrl(props?.callback?.returnUrl)) {
            throw new Error("Đường dẫn return không hợp lệ")
        }

        if (!isValidUrl(props?.callback?.returnUrl)) {
            throw new Error("Đường dẫn callback không hợp lệ")
        }

        //check url callback
        if (props.callback && !isValidUrl(props?.callback?.successUrl)) {
            throw new Error("Đường dẫn callback không hợp lệ")
        }

        const url = `${this.baseUrl}/v1/orders/create`
        const response = await this.req.post<OrderResponse>(url, {
            ...props,
            ...props.callback
        })

        return response.data
    }

    async createWallet(): Promise<WalletDTO> {
        const url = `${this.baseUrl}/v1/application/wallet`
        return (await this.req.post<WalletDTO>(url)).data
    }

    async deleteWallet(walletId: string): Promise<boolean> {
        const url = `${this.baseUrl}/v1/application/wallet/${walletId}`
        return (await this.req.delete(url)).status === 200
    }

    async getWallet(walletId: string): Promise<WalletDTO> {
        const url = `${this.baseUrl}/v1/application/wallet/${walletId}`
        return (await this.req.get<WalletDTO>(url)).data
    }

    async transferMoney(walletId: string, amount: number): Promise<boolean> {
        const url = `${this.baseUrl}/v1/application/transfer`
        return (await this.req.post<WalletDTO>(url, {walletId, amount})).status === 200
    }

    async getMoneyFromWallet(walletId: string, amount: number): Promise<boolean> {
        const url = `${this.baseUrl}/v1/application/withdraw`
        return (await this.req.post<WalletDTO>(url, {walletId, amount})).status === 200
    }

    /**
     * Hủy đơn hàng của bạn
     *
     * Mã code trả về:
     * - `200` Hủy đơn hàng thành công
     * - `400` Đơn hàng không thể hủy do đơn hàng đã được thanh toán hoặc đã hủy hoặc không thể hủy do bussiness rule
     * - `404` Đơn hàng không tồn tại
     * @remarks Đơn hàng chỉ có thể hủy khi đơn hàng đang ở trạng thái `PENDING`
     * @param orderId Mã đơn hàng cần hủy
     */
    async cancelOrder(orderId: string): Promise<WoWoResponse | OrderResponse> {
        const url = `${this.baseUrl}/v1/orders/${orderId}/cancel`
        return (await this.req.post<WoWoResponse>(url)).data
    }

    /**
     * Lấy thông tin đơn hàng
     *
     * Mã code trả về:
     * - `200` Lấy thông tin đơn hàng thành công
     * - `404` Đơn hàng không tồn tại
     * @param orderId Mã đơn hàng cần lấy thông tin
     */
    async getOrder(orderId: string) {
        const url = `${this.baseUrl}/v1/orders/${orderId}`
        return (await this.req.get<OrderResponse>(url)).data
    }

    /**
     * Refund đơn hàng
     * Mã code trả về:
     * - `200` Refund đơn hàng thành công
     * - `400` Đơn hàng không thể refund do đơn hàng đã hủy hoặc không thể refund do bussiness rule
     * - `404` Đơn hàng không tồn tại
     * @remarks Đơn hàng chỉ có thể refund khi đơn hàng đang ở trạng thái `SUCCESS`
     * @param orderId Mã đơn hàng cần refund
     * @param amount
     */
    async refundOrder(orderId: string, amount: number): Promise<OrderResponse> {
        const url = `${this.baseUrl}/v1/orders/${orderId}/refund`
        return (await this.req.post<OrderResponse>(url, {
            amount
        })).data
    }
}


export type User = {
    id: string
    username: string
    email: string
    phone: string
    fullName: string
    avatar: string
    role: string
    createdAt: string
    updatedAt: string
}

export type WoWoResponse = {
    message: string,
    error?: string,
    errorCode?: number
}

/**
 * Thông tin đơn hàng
 */
export type CreateOrderProps = {
    /**
     * Mã đơn hàng
     */
    orderId?: string
    /**
     * Tổng tiền của hóa đơn
     */
    money: number
    /**
     * Tên dịch vụ
     */
    serviceName: string
    /**
     * Danh sách sản phẩm
     * @example
     * [
     *     {
     *         name: "Product 1",
     *         amount: 1,
     *         price: 1000
     *     },
     *     {
     *         name: "Product 2",
     *         amount: 2,
     *         price: 2000
     *     }
     * ]
     */
    items?: Array<ItemProps>
    /**
     * Thông tin callback
     * @example
     * {
     *     callbackUrl: "https://your-callback-url",
     *     returnUrl: "https://your-return-url"
     * }
     * @see {@link CallbackProps}
     */
    callback: CallbackProps
}


/**
 * Thông tin sản phẩm
 * @see {@link CreateOrderProps}
 */
export type ItemProps = {
    /**
     * Tên sản phẩm
     */
    name: string
    /**
     * Số lượng sản phẩm
     * @remarks Số lượng sản phẩm phải lớn hơn 0
     */
    amount: number
    /**
     * Giá sản phẩm
     * @remarks số tiền phải lớn hơn hoặc bằng 0
     */
    unitPrice: number
}

/**
 * {@link callbackUrl} là URL callback dùng để cập nhật trạng thái đơn hàng của bạn khi người dùng thanh toán thành công
 * `METHOD` bắt buộc là `POST` <br>
 * {@link returnUrl} là url trang bạn muốn người dùng chuyển hướng đến khi người dùng thanh toán xong
 * @see {@link CreateOrderProps}
 */
export type CallbackProps = {
    /**
     * URL callback dùng để cập nhật trạng thái đơn hàng của bạn khi người dùng thanh toán thành công
     */
    successUrl?: string
    /**
     * URL trang bạn muốn người dùng chuyển hướng đến khi người dùng thanh toán xong
     */
    returnUrl?: string
}

/**
 * Response trả về khi tạo đơn hàng
 */
export type OrderResponse =
    {
        /**
         * Thái thái đơn hàng `SUCCESS`, `PENDING`, `REFUND`
         */
        status: 'SUCCESS' | 'PENDING' | 'REFUND',
        /**
         * Thời gian tạo đơn hàng
         */
        createdAt: string,
        /**
         * Số tiền giảm giá
         */
        discountMoney: number
        /**
         * Thời gian cập nhật đơn hàng lân cuối
         */
        updatedAt: string,
        /**
         * Đường dẫn thanh toán
         */
        checkoutUrl: string,
    } & CreateOrderProps