shopeasy-sdk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,766 @@
+import { Decimal as Decimal$1 } from 'decimal.js';
+import { Guild as Guild$1, GuildMember } from 'discord.js';
+import { createStaticPix, PixStaticObject } from 'pix-utils';
+
+type GatewayProvider = "atos" | "fluxopay";
+interface WalletBalance {
+    pending: number;
+    available: number;
+    locked: number;
+}
+interface Wallet {
+    id: string;
+    userId: string;
+    apiKey?: string | null;
+    balance?: WalletBalance;
+    gatewayProvider?: GatewayProvider | null;
+    gatewayConfig?: Record<string, unknown> | null;
+    isActive?: boolean | null;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface UpdateWalletArgs {
+    userId: string;
+    data: {
+        apiKey?: string | null;
+        gatewayProvider?: GatewayProvider | null;
+        gatewayConfig?: Record<string, unknown> | null;
+        isActive?: boolean | null;
+    };
+}
+
+interface User {
+    id: string;
+    develop?: boolean;
+}
+
+interface Token {
+    id: string;
+    botId: string;
+    used: boolean;
+    token: string;
+}
+interface TokenUpdateArgs {
+    id: string;
+    data: Partial<Omit<Token, "id" | "botId">>;
+}
+
+type JsonValue<T = unknown> = T | null;
+type Decimal = {
+    valueOf(): string;
+};
+
+interface ConfigDraftGetArgs {
+    userId: string;
+    guildId: string;
+}
+interface ConfigDraftSetArgs {
+    userId: string;
+    guildId: string;
+    data: ConfigUpdateArgs["data"];
+}
+type ActionPermission = "manage_products" | "manage_carts" | "manage_config" | "view_orders" | "process_payments" | "manager_payments" | "manage_roles" | "manager_bot" | "full_access";
+type RolePermissionsMap = Record<string, ActionPermission[]>;
+interface Config {
+    guildId: string;
+    antiFake: boolean | null;
+    antiFakeDays: number | null;
+    notifys: string[];
+    antiFakeRequiredRoleIds: string[] | null;
+    antiFakeVerify: boolean | null;
+    antiFakeVerifyMessage: string | null;
+    colorHex: string;
+    channelPublic: string | null;
+    channelPrivate: string | null;
+    channelCall: string | null;
+    channelFeds: string | null;
+    categoryCarts: string | null;
+    categoryChats: string | null;
+    staffRoles: RolePermissionsMap | null;
+    staffUsers: JsonValue | null;
+    clientRole: string | null;
+    clientRolePremium: string | null;
+    timeCart: number | null;
+    timePayment: number | null;
+    usersBanned: JsonValue<Array<string | null>> | null;
+    terms: string | null;
+    updatedAt: Date;
+    guild?: Guild$1;
+}
+interface ConfigUpdateArgs {
+    guildId: string;
+    data: Omit<Partial<Config>, "id" | "guildId">;
+}
+
+type PlanType = "essential" | "complete" | "desactive";
+interface Plan {
+    guildId: string;
+    type: PlanType;
+    expired: boolean;
+    userId: string;
+    createdAt: Date | null;
+    expireAt: Date | null;
+}
+interface ExpiringPlan extends Plan {
+    daysUntilExpire: number;
+    effectiveExpireAt: Date;
+    shouldAlert: boolean;
+}
+interface PlanNeedingAlert extends Plan {
+    daysUntilExpire: number;
+    effectiveExpireAt: Date;
+}
+interface ExpiredPlansResponse {
+    count: number;
+    plans: Array<{
+        guildId: string;
+        userId: string;
+        type: PlanType;
+        expiredAt: Date | null;
+        createdAt: Date | null;
+    }>;
+}
+interface PlansNeedingAlertResponse {
+    count: number;
+    plans: PlanNeedingAlert[];
+}
+interface CheckExpirationsResponse {
+    expired: {
+        count: number;
+        plans: Array<{
+            guildId: string;
+            userId: string;
+            type: PlanType;
+            expiredAt: Date | null;
+            createdAt: Date | null;
+        }>;
+    };
+    expiring: {
+        count: number;
+        plans: Array<{
+            guildId: string;
+            userId: string;
+            type: PlanType;
+            daysUntilExpire: number;
+            effectiveExpireAt: Date;
+            createdAt: Date | null;
+        }>;
+    };
+}
+interface PlanStatus {
+    active: boolean;
+    expired: boolean;
+    expireAt?: Date;
+    daysUntilExpire?: number;
+}
+interface MarkAlertResponse {
+    success: boolean;
+    message: string;
+}
+interface PlanSubscriptionCreateArgs {
+    guildId: string;
+    userId: string;
+    months: number;
+    plan: "essential" | "complete";
+}
+
+interface ProductStockPushArgs {
+    product: Product;
+    amount: number;
+}
+interface ProductGetByReference {
+    reference: string;
+    guildId: string;
+}
+interface SaleProduct$1 {
+    id: string;
+    saleId: string;
+    productid: string;
+    guildId: string;
+    valueTotal: number;
+    quantiy: number;
+    product?: Product;
+}
+type ProductMode = "TEXT" | "LINES";
+type ProductStatus = "ACTIVED" | "DEACTIVATED" | "BANNED";
+type StockMode = "AUTOMATIC" | "MANUAL";
+interface Product {
+    id: string;
+    reference: string;
+    guildId: string;
+    createdBy: string;
+    status: ProductStatus;
+    title?: string | null;
+    banned: boolean | null;
+    usersNotifyStock: JsonValue<Array<string>> | null;
+    description: string | null;
+    price: Decimal;
+    discount: Decimal | null;
+    banners: JsonValue<Array<string>> | null;
+    messages: JsonValue<Array<string>> | null;
+    stockMode: StockMode;
+    stockItems: JsonValue<Array<string>> | null;
+    stockText: string | null;
+    stockProductMode: ProductMode | null;
+    stockRepeat: number | null;
+    stockCount: number | null;
+    instructions: string | null;
+    stockMin: number;
+    stockMax: number;
+    chat?: boolean | null;
+    private?: boolean | null;
+    deshighlight?: boolean | null;
+    sell?: boolean | null;
+    coupon?: boolean;
+    colorHex?: string | null;
+    guild?: Guild | null;
+    sales?: SaleProduct$1[];
+    catalogs?: string[];
+}
+interface ProduductDraftSetArgs {
+    id: string;
+    userId: string;
+    data: ProductUpdateArgs["data"] & {
+        catalogs?: string[];
+    };
+}
+interface ProduductDraftGetArgs {
+    id: string;
+    userId: string;
+}
+interface ProductCreateArgs {
+    createdBy: string;
+    reference: string;
+    guildId: string;
+}
+interface ProductUpdateArgs {
+    id: string;
+    data: Omit<Partial<Product>, "id" | "reference">;
+}
+
+interface Guild {
+    id: string;
+    banned: boolean;
+    createdAt: Date;
+    configs?: Config | null;
+    products?: Product[];
+    sales?: Sale[];
+    Plan?: Plan | null;
+}
+
+interface Customer {
+    id: string;
+    userId: string;
+    guildId: string;
+    balance: Decimal;
+    notify: boolean;
+    sales?: Sale[];
+    guild?: Guild | null;
+    createdAt?: Date;
+}
+interface CustomerDraftSetArgs {
+    id: string;
+    userId: string;
+    data: CustomerUpdateArgs["data"];
+}
+interface CustomerDraftGetArgs {
+    id: string;
+    userId: string;
+}
+interface CustomerCreateArgs {
+    userId: string;
+    guildId: string;
+    balance?: Decimal;
+    notify?: boolean;
+}
+interface CustomerUpdateArgs {
+    id: string;
+    data: Omit<Partial<Customer>, "id" | "userId" | "guildId">;
+}
+
+interface SaleCreateArgs {
+    userId: string;
+    guildId: string;
+    totalValue: Decimal$1;
+    products: SaleProductCreateArgs[];
+}
+interface SaleProductCreateArgs {
+    productId: string;
+    valueTotal: Decimal$1;
+    quantity: number;
+    deliveryStock?: JsonValue<Array<string>> | null;
+    deliveryPedding?: boolean | null;
+    deliveryPeddingAmount?: number | null;
+}
+interface Sale {
+    id: string;
+    userId: string;
+    guildId: string;
+    totalValue: Decimal$1;
+    createdAt: Date | null;
+    guild?: Guild$1;
+    customer?: Customer;
+    saleProducts?: SaleProduct[];
+}
+interface SaleProduct {
+    id: string;
+    saleId: string;
+    productId: string;
+    valueTotal: Decimal$1;
+    quantity: number;
+    product?: Product;
+    sale?: Sale;
+    deliveryStock?: JsonValue<Array<string>> | null;
+    deliveryPedding?: boolean | null;
+    deliveryPeddingAmount?: number | null;
+}
+
+interface EfiPixCreateResponse {
+    calendario: {
+        criacao: string;
+        expiracao: number;
+    };
+    txid: string;
+    revisao: number;
+    loc: {
+        id: number;
+        location: string;
+        tipoCob: "cob" | "cobv";
+    };
+    location: string;
+    status: "ATIVA" | "CONCLUIDA" | "REMOVIDA_PELO_USUARIO_RECEBEDOR" | "REMOVIDA_PELO_PSP";
+    devedor?: {
+        cpf?: string;
+        cnpj?: string;
+        nome: string;
+    };
+    valor: {
+        original: string;
+    };
+    chave: string;
+    solicitacaoPagador?: string;
+    pixCopiaECola?: string;
+}
+
+type PaymentProvider = "mercadoPago" | "pixsemiauto" | "efibank" | "atos" | "fluxoPay" | "wallet";
+interface PaymentConfig {
+    guildId: string;
+    provider?: PaymentProvider | null;
+    mercadoPagoToken?: string | null;
+    efiBankToken?: string | null;
+    chavePix?: string | null;
+    chavePixType?: "CPF" | "EMAIL" | "ALEATORIA" | "NUMERO";
+    chavePixName?: string;
+    chavePixCity?: string;
+    walletApiKey?: string;
+    chavePixchavePixStaticQrCode: boolean;
+}
+interface UpdatePaymentConfigArgs {
+    guildId: string;
+    data: {
+        provider?: PaymentProvider | null;
+        mercadoPagoToken?: string | null;
+        walletApiKey?: string | null;
+        efiBankToken?: string | null;
+        chavePix?: string | null;
+        chavePixType?: "CPF" | "EMAIL" | "ALEATORIA" | "NUMERO";
+        chavePixName?: string;
+        chavePixCity?: string;
+        chavePixchavePixStaticQrCode?: boolean;
+    };
+}
+
+interface OrderPayment {
+    id: string;
+    aproved: boolean;
+}
+interface Order {
+    id: string;
+    aproved: boolean;
+    released: boolean;
+    cartId?: string;
+    planId?: string;
+    paymentId?: string;
+    guildId: string;
+    customerId?: string;
+    botClient?: string;
+    paymentProvider?: PaymentProvider;
+    automatic?: boolean;
+    pixKey: string;
+    expireAt?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface OrderCustomer {
+    id: string;
+    name: string;
+}
+interface OrderProduct {
+    id: string;
+    name: string;
+    quantity: number;
+}
+interface OrderCreate {
+    guildId: string;
+    amount: number;
+    cartId: string;
+    botClient: string;
+    customer: OrderCustomer;
+    products: OrderProduct[];
+}
+
+interface Image {
+    id: string;
+    guildId: string;
+    url: string;
+    reference: string;
+    name: string;
+    expiresIn: number;
+}
+type imageCreate = Omit<Image, "id">;
+
+type CouponStatus = "ACTIVED" | "DEACTIVATED" | "EXPIRED";
+interface Coupon {
+    id: string;
+    reference: string;
+    guildId: string;
+    createdBy: string;
+    discount: number | null;
+    valorMin: number | null;
+    valorMax: number | null;
+    amount: number | null;
+    uses: number | null;
+    status?: CouponStatus;
+    guild?: Guild | null;
+}
+interface CouponDraftSetArgs {
+    id: string;
+    userId: string;
+    data: CouponUpdateArgs["data"];
+}
+interface CouponDraftGetArgs {
+    id: string;
+    userId: string;
+}
+interface CouponCreateArgs {
+    createdBy: string;
+    reference: string;
+    guildId: string;
+    discount?: number;
+    valorMin?: number;
+    valorMax?: number;
+    role?: string;
+    amount?: number;
+    uses?: number;
+}
+interface CouponUpdateArgs {
+    id: string;
+    data: Omit<Partial<Coupon>, "id" | "reference">;
+}
+
+type CatalogStatus = "ACTIVED" | "DEACTIVATED" | "BANNED";
+interface CatalogProduct {
+    catalogId: string;
+    productId: string;
+    product: Product;
+}
+interface Catalog {
+    id: string;
+    guildId: string;
+    reference: string;
+    createBy: string;
+    title: string | null;
+    description: string | null;
+    banners: JsonValue<string[]> | null;
+    color: string | null;
+    placeholder: string | null;
+    status?: CatalogStatus;
+    messages: JsonValue<string[]> | null;
+    products?: CatalogProduct[];
+    guild?: Guild | null;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+interface CatalogCreateArgs {
+    guildId: string;
+    createBy: string;
+    reference: string;
+    title?: string | null;
+    description?: string | null;
+    banners?: JsonValue<Array<string>> | null;
+    color?: string | null;
+    placeholder?: string | null;
+    messages?: JsonValue<string> | null;
+    productId?: string;
+}
+interface CatalogUpdateArgs {
+    id: string;
+    data: Omit<Partial<Catalog>, "id" | "reference" | "guild" | "products">;
+}
+interface CatalogDraftSetArgs {
+    id: string;
+    userId: string;
+    data: CatalogUpdateArgs["data"];
+}
+interface CatalogDraftGetArgs {
+    id: string;
+    userId: string;
+}
+
+type CartStatus = "MAIN" | "COUPON" | "PAYMENT" | "APPROVED" | "PENDING_APPROVAL";
+type ProductId = string;
+interface CartProduct {
+    productId: ProductId;
+    amount: number;
+    amountAvaliable: number;
+    cartId: string;
+    product: Product;
+}
+interface CreateCartProduct {
+    productId: ProductId;
+    amount: number;
+    amountAvaliable: number;
+}
+interface CreateCartArgs {
+    guildId: string;
+    userId: string;
+    expireAt: Date;
+    botClient: string;
+    message: string;
+    status?: CartStatus;
+    products: CreateCartProduct[];
+}
+interface UpdateCartData {
+    status?: CartStatus | null;
+    message?: string | null;
+    expireAt?: Date;
+    orderId?: string;
+    products?: {
+        create?: CreateCartProduct[];
+        createMany?: {
+            data: CreateCartProduct[];
+            skipDuplicates?: boolean;
+        };
+        deleteMany?: {
+            productId: string;
+        }[];
+        set?: {
+            productId: string;
+        }[];
+        updateMany?: {
+            where: {
+                productId: string;
+            };
+            data: Partial<CreateCartProduct>;
+        }[];
+    } | null;
+}
+interface CartUpdateArgs {
+    id: string;
+    data: UpdateCartData;
+}
+interface Cart {
+    id: string;
+    guildId: string;
+    status: CartStatus;
+    userId: string;
+    message: string;
+    products: CartProduct[];
+    createdAt: Date;
+    updatedAt: Date;
+    expireAt?: Date;
+    orderId?: string;
+    botClient: string;
+    guild?: Guild$1 | null;
+}
+interface CartDraft {
+    products: CartDraftProduct[];
+}
+interface CartDraftProduct {
+    productId: string;
+    amount: number;
+}
+interface CartGetArgs {
+    userId: string;
+    guildId: string;
+}
+
+declare function cartWillExpire(cart: Cart): Promise<void>;
+declare function cartAntiFakeVerify(configs: Config, member: GuildMember): boolean;
+declare function cartVerifyPermission(cart: Cart, member: GuildMember, configs: Config): boolean;
+declare function cartCalculeTotal(cart: Cart): Decimal$1;
+declare function cartVerifyAproved(cartId: string): Promise<boolean>;
+
+declare const formatPrice: (value: number | {
+    toString(): string;
+}) => string;
+declare const formatDecimalToNumber: (value: {
+    toString(): string;
+}) => number;
+declare const formatNumberToDecimal: (value: number) => Decimal$1;
+declare function formatRelativeTime(ms: number): string;
+
+declare function hasPermission(member: GuildMember, requiredPerms: ActionPermission[], configs: Config): boolean;
+
+type CreateStaticPixInput = Parameters<typeof createStaticPix>[0];
+interface QRCodeOptions {
+    merchantName?: string;
+    merchantCity?: string;
+    amount?: number;
+    description?: string;
+    logoUrl?: string;
+    logoSize?: number;
+    qrColor?: string;
+    backgroundColor?: string;
+    rounded?: boolean;
+}
+declare class Pix {
+    create(data: CreateStaticPixInput): PixStaticObject | null;
+    private loadImageFromUrl;
+    qrCodeImage(pixKeyOrPayload: string, options?: QRCodeOptions): Promise<Buffer>;
+    private roundRect;
+}
+declare const pixUtils: Pix;
+
+interface ShopEasySDKOptions {
+    baseUrl?: string;
+    secretKey?: string;
+}
+declare class ShopEasySdk {
+    constructor(options: ShopEasySDKOptions);
+    carts: {
+        draft: {
+            get: (cardId: string) => Promise<CartDraft | null>;
+            set: ({ cartId, update, }: {
+                cartId: string;
+                update: CartDraft;
+            }) => Promise<Cart>;
+            delete: (cartId: string) => Promise<void>;
+        };
+        create(args: CreateCartArgs): Promise<Cart>;
+        get(args: CartGetArgs): Promise<Cart | null>;
+        getById(cartId: string): Promise<Cart | null>;
+        getAllByGuild(guildId: string): Promise<Cart[]>;
+        update(args: CartUpdateArgs): Promise<Cart>;
+        expires(botClient: string): Promise<Cart[]>;
+        count(guildId: string): Promise<number>;
+        delete(cartId: string): Promise<void>;
+    };
+    catalogs: {
+        setDraft(args: CatalogDraftSetArgs): Promise<Catalog | null>;
+        getDraft(args: CatalogDraftGetArgs): Promise<Catalog | null>;
+        getByReference(reference: string, guildId: string): Promise<Catalog | null>;
+        getById(id: string): Promise<Catalog | null>;
+        create(args: CatalogCreateArgs): Promise<Catalog>;
+        getByCaching(id: string): Promise<Catalog | null>;
+        getAllByGuild(guildId: string): Promise<Array<Catalog>>;
+        update(args: CatalogUpdateArgs): Promise<Catalog>;
+        count(guildId: string): Promise<number>;
+        delete(id: string): Promise<Catalog>;
+    };
+    configs: {
+        getByGuild(guildId: string): Promise<Config>;
+        setDraft(args: ConfigDraftSetArgs): Promise<Config | null>;
+        delDraft(args: ConfigDraftGetArgs): Promise<Config | null>;
+        getDraft(args: ConfigDraftGetArgs): Promise<Config | null>;
+        update(args: ConfigUpdateArgs): Promise<Config>;
+        getByCaching(_guildId: string): Promise<Config | null>;
+    };
+    coupons: {
+        setDraft(args: CouponDraftSetArgs): Promise<Coupon | null>;
+        getDraft(args: CouponDraftGetArgs): Promise<Coupon | null>;
+        existsByCode(code: string): Promise<boolean>;
+        getById(id: string): Promise<Coupon | null>;
+        create(args: CouponCreateArgs): Promise<Coupon>;
+        getByCaching(id: string): Promise<Coupon | null>;
+        getAllByGuild(guildId: string): Promise<Coupon[]>;
+        update(args: CouponUpdateArgs): Promise<Coupon>;
+        count(guildId: string): Promise<number>;
+        delete(id: string): Promise<Coupon>;
+    };
+    customers: {
+        setDraft(args: CustomerDraftSetArgs): Promise<Customer | null>;
+        getDraft(args: CustomerDraftGetArgs): Promise<Customer | null>;
+        existsByReference(_reference: string): Promise<boolean>;
+        getById(id: string): Promise<Customer | null>;
+        getByReference(_reference: string): Promise<Customer | null>;
+        create(args: CustomerCreateArgs): Promise<Customer>;
+        getByCaching(id: string): Promise<Customer | null>;
+        getAllByGuild(guildId: string): Promise<Customer[]>;
+        update(args: CustomerUpdateArgs): Promise<Customer>;
+        count(guildId: string): Promise<number>;
+        delete(id: string): Promise<Customer>;
+    };
+    images: {
+        getAll(guildId: string): Promise<Image[]>;
+        create(args: imageCreate): Promise<Image>;
+    };
+    orders: {
+        create(args: OrderCreate): Promise<Order>;
+        get(orderId: string): Promise<Order | null>;
+        getPayment(orderId: string): Promise<OrderPayment | null>;
+        getApprovedUnprocessed(botClient: string, guildId?: string): Promise<Order[]>;
+        markAsReleased(id: string): Promise<Order>;
+        aprove(id: string): Promise<Order>;
+    };
+    paymentConfig: {
+        getOrCreate(guildId: string): Promise<PaymentConfig>;
+        update(args: UpdatePaymentConfigArgs): Promise<PaymentConfig>;
+        getByCaching(guildId: string): Promise<PaymentConfig | null>;
+    };
+    plans: {
+        getByGuild(guildId: string): Promise<Plan | null>;
+        havePlan(guildId: string): Promise<PlanType | null>;
+        create(args: Plan): Promise<Plan>;
+        getExpiring(days?: number): Promise<ExpiringPlan[]>;
+        getExpired(): Promise<ExpiredPlansResponse>;
+        getPlansNeedingAlert(days?: number): Promise<PlansNeedingAlertResponse>;
+        markAlertSent(guildId: string, daysUntilExpire: number): Promise<MarkAlertResponse>;
+        checkExpirations(): Promise<CheckExpirationsResponse>;
+        getExpirationStatus(guildId: string): Promise<PlanStatus>;
+        update(guildId: string, updates: Partial<Plan>): Promise<Plan>;
+        delete(guildId: string): Promise<void>;
+        createSubscription(args: PlanSubscriptionCreateArgs): Promise<EfiPixCreateResponse>;
+    };
+    products: {
+        setDraft(args: ProduductDraftSetArgs): Promise<Product | null>;
+        pushStock({ product, amount, }: ProductStockPushArgs): Promise<string[]>;
+        countStock(product: Product): number;
+        getDraft(args: ProduductDraftGetArgs): Promise<Product | null>;
+        existsByReference(args: ProductGetByReference): Promise<Product | null>;
+        getById(id: string): Promise<Product | null>;
+        getByReference({ reference, guildId, }: {
+            reference: string;
+            guildId: string;
+        }): Promise<Product | null>;
+        create(args: ProductCreateArgs): Promise<Product>;
+        getByCaching(id: string): Promise<Product | null>;
+        getAllByGuild(guildId: string): Promise<Array<Product>>;
+        update(args: ProductUpdateArgs): Promise<Product>;
+        count(guildId: string): Promise<number>;
+        delete(id: string): Promise<void>;
+    };
+    sales: {
+        create(args: SaleCreateArgs): Promise<Sale>;
+        getById(id: string): Promise<Sale | null>;
+        getAllByGuild(guildId: string): Promise<Sale[]>;
+        saleProductGet(id: string): Promise<SaleProduct$1 | null>;
+        delete(id: string): Promise<void>;
+    };
+    tokens: {
+        listUnused(): Promise<Token[] | null>;
+        update(args: TokenUpdateArgs): Promise<Token>;
+    };
+    users: {
+        get(userId: string): Promise<User | null>;
+    };
+    wallet: {
+        getOrCreate(userId: string): Promise<Wallet>;
+        getByUserId(userId: string): Promise<Wallet>;
+        getByApiKey(apiKey: string): Promise<Wallet>;
+        update(args: UpdateWalletArgs): Promise<Wallet>;
+        getByCaching(userId: string): Promise<Wallet | null>;
+    };
+}
+
+export { ShopEasySdk, cartAntiFakeVerify, cartCalculeTotal, cartVerifyAproved, cartVerifyPermission, cartWillExpire, formatDecimalToNumber, formatNumberToDecimal, formatPrice, formatRelativeTime, hasPermission, pixUtils };