@billgangcom/theme-lib 1.110.4 → 1.110.5

package/dist/src/storefront/hooks/useCart.d.ts

@@ -0,0 +1,186 @@
+import { PaymentMethod, type PartOrder } from '@storefront/models';
+import { Cart, ValidateCouponApiData } from '@storefront/store';
+import { Product } from '../../abstractions';
+export type Image = {
+    id: number;
+    cfId: string;
+};
+type Price = {
+    amount: number;
+    currency: string;
+};
+type Gateway = {
+    name: string;
+};
+type Quantity = {
+    available?: number;
+    restrictions?: Record<string, unknown>;
+};
+export type DiscordSettings = {
+    isEnabled: boolean;
+    isRequired: boolean;
+};
+type BaseProductVariantExtraField = {
+    id: string;
+    name: string;
+    required: boolean;
+    regex?: string;
+    placeholder: string;
+    value: string;
+};
+export declare const PRODUCT_VARIANT_EXTRA_FIELD_TYPE: {
+    readonly Number: "NUMBER";
+    readonly Text: "TEXT";
+    readonly Textarea: "LARGE_TEXT";
+    readonly Checkbox: "CHECK_BOX";
+    readonly Hidden: "HIDDEN";
+    readonly Select: "SELECT";
+};
+export type PRODUCT_VARIANT_EXTRA_FIELD_TYPE = typeof PRODUCT_VARIANT_EXTRA_FIELD_TYPE;
+export type ProductVariantTextExtraField = BaseProductVariantExtraField & {
+    type: PRODUCT_VARIANT_EXTRA_FIELD_TYPE['Text'];
+    placeholder?: string;
+    defaultValue?: string;
+};
+export type ProductVariantNumberExtraField = BaseProductVariantExtraField & {
+    type: PRODUCT_VARIANT_EXTRA_FIELD_TYPE['Number'];
+    placeholder?: string;
+    defaultValue?: number;
+};
+export type ProductVariantCheckboxExtraField = BaseProductVariantExtraField & {
+    type: PRODUCT_VARIANT_EXTRA_FIELD_TYPE['Checkbox'];
+    placeholder?: string;
+    defaultValue?: boolean;
+};
+export type ProductVariantTextareaExtraField = BaseProductVariantExtraField & {
+    type: PRODUCT_VARIANT_EXTRA_FIELD_TYPE['Textarea'];
+    placeholder?: string;
+    defaultValue?: string;
+};
+export type ProductVariantExtraField = ProductVariantTextExtraField | ProductVariantNumberExtraField | ProductVariantCheckboxExtraField | ProductVariantTextareaExtraField;
+export declare enum ChargeType {
+    ONE_TIME = "ONE_TIME",
+    RECURRING = "RECURRING"
+}
+export type Variant = {
+    id: number;
+    name: string;
+    price: Price;
+    quantity: Quantity;
+    deliveryTime?: number;
+    gateways: Gateway[];
+    customFields?: ProductVariantExtraField[] | undefined;
+    discordSettings: DiscordSettings;
+    description?: string;
+    compareAtPrice?: Price;
+    chargeTypes?: ChargeType[];
+    subscriptionSettings?: {
+        price: Price;
+        compareAtPrice?: Price;
+        recurringIntervalDays?: number;
+        entryFee?: Price;
+    };
+};
+export type Listing = {
+    id: number;
+    link: {
+        to: string;
+    };
+    to: string;
+    productData: {
+        name: string;
+        uniquePath: string;
+        shortDescription: string;
+        images: Image[];
+    };
+    images: Image[];
+    isInStock: true;
+    minPrice: Price;
+    name: string;
+    shortDescription: string;
+    stats: {
+        averageRating: number;
+        totalReviews: number;
+        totalSold: number;
+    };
+    uniquePath: string;
+    type: string;
+};
+export type CreateOrderResponseBody = {
+    id: string;
+    fullAccessToken: string;
+};
+export type CreateSubscriptionOrderResponseBody = {
+    id: string;
+    order: {
+        id: string;
+        fullAccessToken: string;
+    };
+};
+export declare const getCommonCustomFields: (cartItems: PartOrder[], products: Product[]) => ({
+    value: string;
+    id: string;
+    name: string;
+    required: boolean;
+    regex?: string;
+    placeholder: string;
+    type: PRODUCT_VARIANT_EXTRA_FIELD_TYPE["Text"];
+    defaultValue?: string;
+} | {
+    value: string;
+    id: string;
+    name: string;
+    required: boolean;
+    regex?: string;
+    placeholder: string;
+    type: PRODUCT_VARIANT_EXTRA_FIELD_TYPE["Number"];
+    defaultValue?: number;
+} | {
+    value: string;
+    id: string;
+    name: string;
+    required: boolean;
+    regex?: string;
+    placeholder: string;
+    type: PRODUCT_VARIANT_EXTRA_FIELD_TYPE["Checkbox"];
+    defaultValue?: boolean;
+} | {
+    value: string;
+    id: string;
+    name: string;
+    required: boolean;
+    regex?: string;
+    placeholder: string;
+    type: PRODUCT_VARIANT_EXTRA_FIELD_TYPE["Textarea"];
+    defaultValue?: string;
+})[];
+export declare const useCart: () => {
+    reset(): void;
+    addProducts: (newProducts: Product[]) => void;
+    addProductToCart: (cartItem: PartOrder) => void;
+    removeProduct({ productId, productVariantId }: PartOrder): void;
+    getPossibleGateways(): {
+        availableGateways: string[];
+        requiresSignInGateways: string[];
+    };
+    removeCoupon(): void;
+    getDiscordSettings(): DiscordSettings;
+    updateQuantityOfProduct(cartItem: PartOrder): void;
+    getTotalAndDiscount(): {
+        total: number;
+        totalWithVolumeDiscounts: number | undefined;
+        totalWithDiscount: number | undefined;
+    };
+    setGateway(gateway: string): void;
+    setPaymentMethod(paymentMethod: PaymentMethod): void;
+    submitCart(recaptcha: string): Promise<CreateOrderResponseBody | CreateSubscriptionOrderResponseBody>;
+    setDiscordSocialConnectId(discordSocialConnectId: string): void;
+    setCustomFields(customFields: Record<string, string>): void;
+    cart: Cart;
+    products: Product[];
+    coupon: ValidateCouponApiData | null;
+    pending: boolean;
+    applyCouponPending: boolean;
+    applyCoupon: (couponName: string) => Promise<ValidateCouponApiData | null>;
+};
+export {};

package/dist/src/storefront/hooks/useCopy.d.ts

@@ -0,0 +1 @@
+export declare const useCopy: () => (value: string) => void;

package/dist/src/storefront/index.d.ts

@@ -0,0 +1,11 @@
+import { type ReactNode } from 'react';
+import React from 'react';
+type CustomerDashboardType = {
+    shopDomain: string;
+    shopId: string;
+    shopPassword?: string;
+    shopLogo?: React.ReactElement;
+    children: ReactNode;
+};
+export declare const BillgangProvider: ({ children, shopDomain, shopId, shopPassword, shopLogo, }: CustomerDashboardType) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/src/storefront/models/balance.d.ts

@@ -0,0 +1,56 @@
+import { PaymentMethod } from './payment';
+export interface GatewayDetail {
+    name: string;
+    displayName: string;
+    logoCfImageId: string;
+    poweredByImageCfImageId?: string;
+    paymentMethods: PaymentMethod[];
+    priceAdjustment?: {
+        fixedAmount: number;
+        isDiscount: boolean;
+        percentage: number;
+    };
+    serviceFee?: {
+        fixedAmount: number;
+        isDiscount: boolean;
+        percentage: number;
+    };
+}
+export declare const getGatewaysDetail: (gateways: string[]) => Promise<GatewayDetail[]>;
+interface BaseTopUpSettings {
+    gateways: string[];
+    currency: string;
+}
+interface TopUpBonusEnabled {
+    topUpBonusEnabled: true;
+    minimumTopUpForBonus: number;
+    bonusPercent: number;
+}
+interface TopUpBonusDisabled {
+    topUpBonusEnabled: false;
+    minimumTopUpForBonus?: number;
+    bonusPercent?: number;
+}
+interface CashbackEnabled {
+    cashbackEnabled: true;
+    cashbackPercent: number;
+}
+interface CashbackDisabled {
+    cashbackEnabled: false;
+    cashbackPercent?: number;
+}
+type TopUpSettings = BaseTopUpSettings & (TopUpBonusEnabled | TopUpBonusDisabled) & (CashbackEnabled | CashbackDisabled);
+interface BalanceTopUpSettingsDisabled {
+    isEnabled: false;
+}
+interface BalanceTopUpSettingsEnabled {
+    isEnabled: true;
+    topUpSettings: TopUpSettings;
+}
+export type BalanceTopUpSettings = BalanceTopUpSettingsEnabled | BalanceTopUpSettingsDisabled;
+export declare const getBalanceSettings: () => Promise<BalanceTopUpSettings>;
+export declare const getBalance: () => Promise<{
+    amount: number;
+    currency: string;
+}>;
+export {};

package/dist/src/storefront/models/charge.d.ts

@@ -0,0 +1,76 @@
+import { PublicOrderPart } from './order';
+import { Price } from './price';
+export type Children = Block[];
+export type Section = {
+    type: 'Section';
+    props: {
+        title: string;
+        subTitle: string;
+        children?: Children;
+    };
+};
+export type ImageCharge = {
+    type: 'Image';
+    props: {
+        src: string;
+    };
+};
+export type ReadOnlyTextInput = {
+    type: 'ReadOnlyTextInput';
+    props: {
+        text: string;
+        shownCopyButton?: boolean;
+    };
+};
+export type Notify = {
+    type: 'Notify';
+    props: {
+        heading: string;
+        content: string;
+    };
+};
+export type Btn = {
+    type: 'Button';
+    props: {
+        text: string;
+        url: string;
+    };
+};
+export type Block = Section | ReadOnlyTextInput | Notify | Btn | ImageCharge;
+export type GetChargeApiData = {
+    id: string;
+    customerForCharge: {
+        id: number;
+        email: string;
+    };
+    name?: string;
+    description?: string;
+    gateway: string;
+    customCharge?: {
+        id: number;
+        lifetimeStorage: {};
+        updatedAt?: Date;
+    };
+    redirectUrl?: string;
+    price: Price;
+    status: ChargeStatus;
+    timeline: Partial<Record<ChargeStatus, Date>>;
+    expiresAt: Date;
+    displayPaymentInfo: Block[];
+    order?: {
+        id: string;
+        endPrice: Price;
+        endPriceUSD: number;
+        partOrders: PublicOrderPart[];
+        rawPrice: Price;
+        subscriptionOrderId?: string;
+    };
+};
+export declare const enum ChargeStatus {
+    NotPaid = "NOT_PAID",
+    Pending = "PENDING",
+    Paid = "PAID",
+    Expired = "EXPIRED",
+    Cancelled = "CANCELLED",
+    Refunded = "REFUNDED"
+}

package/dist/src/storefront/models/checkout.d.ts

@@ -0,0 +1,21 @@
+import { DeliveryConfiguration, Image, Price } from '@storefront/models';
+export interface CheckoutProductT {
+    id: number;
+    name: string;
+    description: string;
+    image?: Image;
+    price: Price;
+    deliveryCategories?: DeliveryConfiguration[];
+    customerNote?: string;
+    subscriptionSettings?: {
+        price: Price;
+        compareAtPrice?: Price;
+        recurringIntervalDays?: number;
+        entryFee?: Price;
+    } | null;
+    chargeType?: 'ONE_TIME' | 'RECURRING';
+    variantsGateways?: {
+        name: string;
+        overrodePrice?: Price;
+    }[];
+}

package/dist/src/storefront/models/coupon.d.ts

@@ -0,0 +1,5 @@
+export interface Coupon {
+    productIds: number[];
+    couponName: string;
+    gateway: string;
+}

package/dist/src/storefront/models/discord.d.ts

@@ -0,0 +1,18 @@
+export type PostDiscordAuthorization = {
+    customerEmail: string;
+};
+export type GetDiscordAuthorizationStatus = {
+    id: string;
+    customerEmail: string;
+};
+type UnauthorizedDiscordUser = {
+    authorized: false;
+};
+type AuthorizedDiscordUser = {
+    authorized: true;
+    id: string;
+    username: string;
+    avatar?: string | undefined;
+};
+export type DiscordUser = UnauthorizedDiscordUser | AuthorizedDiscordUser;
+export {};

package/dist/src/storefront/models/gateway.d.ts

@@ -0,0 +1,8 @@
+import { PaymentMethod } from './payment';
+export type GatewayInfo = {
+    name: string;
+    displayName: string;
+    logoCfImageId: string;
+    poweredByImageCfImageId?: string;
+    paymentMethods: PaymentMethod[];
+};

package/dist/src/storefront/models/index.d.ts

@@ -0,0 +1,16 @@
+export * from './shop';
+export * from './post';
+export * from './price';
+export * from './referralCode';
+export * from './payment';
+export * from './coupon';
+export * from './order';
+export * from './subscription';
+export * from './balance';
+export * from './gateway';
+export * from './referral';
+export * from './transaction';
+export * from './discord';
+export * from './charge';
+export * from './checkout';
+export * from './rewards';

package/dist/src/storefront/models/order.d.ts

@@ -0,0 +1,139 @@
+import { Price } from './price';
+import { Image } from './shop';
+import { GetChargeApiData } from './charge';
+export type PartOrder = {
+    productId: number;
+    productVariantId: number;
+    quantity: number;
+    chargeType: 'ONE_TIME' | 'RECURRING';
+};
+export type OrderRequest = {
+    customerEmail: string;
+    gateway: string;
+    parts: PartOrder[];
+    recaptcha: string;
+    coupon?: string | null;
+    customFields: Record<string, string>;
+    discordSocialConnectId?: string | null;
+    referralCode?: string | null;
+    tsId: string | null;
+};
+export declare enum OrderStatus {
+    New = "NEW",
+    Pending = "PENDING",
+    Completed = "COMPLETED",
+    Cancelled = "CANCELLED",
+    Expired = "EXPIRED",
+    FullDeliveryFailure = "FULL_DELIVERY_FAILURE",
+    PartiallyDelivered = "PARTIALLY_DELIVERED",
+    Refunded = "REFUNDED",
+    Failed = "FAILED"
+}
+export interface OrderItem {
+    id: string;
+    status: OrderStatus;
+    price: Price;
+    gatewayName: string;
+    time: string;
+    accessToken: string;
+    review?: {
+        rating: number;
+    };
+}
+export type PublicOrderPart = {
+    id: number;
+    productWithVariant: {
+        id: string;
+        name: string;
+        shortDescription?: string;
+        description?: string;
+        image?: Image;
+        variantId: string;
+        variantName: string;
+        price: Price;
+        subscriptionSettings?: {
+            compareAtPrice: Price;
+            price: Price;
+            recurringIntervalDays: number;
+        };
+    };
+    quantity: number;
+    endPrice: Price;
+    endPriceUSD: Price['amount'];
+    customerNote?: string;
+    chargeType: 'ONE_TIME' | 'RECURRING';
+};
+type BaseOrder = {
+    id: string;
+    status: OrderStatus;
+    rawPrice: Price;
+    endPrice: Price;
+    endPriceUSD: Price['amount'];
+    createdAt: Date;
+    expiresAt: Date;
+    charge: GetChargeApiData | null;
+    timeline: Partial<Record<OrderStatus, Date>>;
+    customer: {
+        id: number;
+        email: string;
+    };
+};
+export type PublicOrderReview = {
+    rating?: number;
+    comment?: string;
+    sellerReply?: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+};
+export type AuthenticatedOrderReview = PublicOrderReview & {
+    accessToken: string;
+};
+export type PublicOrder = BaseOrder & {
+    partOrders: PublicOrderPart[];
+    review: PublicOrderReview;
+};
+export type AuthenticatedOrder = BaseOrder & {
+    partOrders: AuthenticatedOrderPart[];
+    review: AuthenticatedOrderReview;
+};
+export type AuthenticatedOrderPart = PublicOrderPart & {
+    deliveryCategories: DeliveryConfiguration[];
+};
+type BaseDeliveryConfiguration = {
+    id: number;
+    customName?: string;
+};
+export type ExternalDeliveryConfiguration = BaseDeliveryConfiguration & {
+    type: DeliveryConfigurationType.Ebook | DeliveryConfigurationType.Link | DeliveryConfigurationType.Download | DeliveryConfigurationType.Telegram;
+    deliveryItems: [TextDeliveryItem];
+};
+export type InternalDeliveryConfiguration = BaseDeliveryConfiguration & ({
+    type: DeliveryConfigurationType.Custom | DeliveryConfigurationType.Text | DeliveryConfigurationType.Discord;
+    deliveryItems: [TextDeliveryItem];
+} | {
+    type: DeliveryConfigurationType.Serial;
+    deliveryItems: SerialDeliveryItem[];
+});
+export type DeliveryConfiguration = ExternalDeliveryConfiguration | InternalDeliveryConfiguration;
+export declare const enum DeliveryConfigurationType {
+    Text = "TEXT",
+    Serial = "SERIALS",
+    Ebook = "EBOOK",
+    Link = "LINK",
+    Download = "DOWNLOAD",
+    Discord = "DISCORD",
+    Telegram = "TELEGRAM",
+    Custom = "CUSTOM"
+}
+export type BaseDeliveryItem = {
+    id: string;
+    deliveredAt: Date;
+};
+export type TextDeliveryItem = BaseDeliveryItem & {
+    textData: string;
+};
+export type SerialDeliveryItem = BaseDeliveryItem & {
+    serialKey: string;
+};
+export type GetOrderApiData = PublicOrder | AuthenticatedOrder;
+export {};

package/dist/src/storefront/models/payment.d.ts

@@ -0,0 +1,16 @@
+import { Price } from './price';
+export type Payment = {
+    customerEmail: string;
+    price: Price;
+    gateway: string;
+    tsId: string | null;
+};
+export declare enum PaymentMethod {
+    BankCard = "BANK_CARD",
+    BankTransfer = "BANK_TRANSFER",
+    PayPal = "PAYPAL",
+    CashApp = "CASHAPP",
+    Crypto = "CRYPTO",
+    AppleGooglePay = "APPLE_AND_GOOGLE_PAY",
+    Custom = "CUSTOM"
+}

package/dist/src/storefront/models/post.d.ts

@@ -0,0 +1,5 @@
+export interface PostReview {
+    rating: number;
+    comment: string;
+    tsId: string | null;
+}

package/dist/src/storefront/models/price.d.ts

@@ -0,0 +1,5 @@
+export interface Price {
+    amount: number;
+    currency?: string;
+    quantity?: number;
+}

package/dist/src/storefront/models/referral.d.ts

@@ -0,0 +1,12 @@
+export interface Referral {
+    data: {
+        isAvailable: boolean;
+        isActivated: boolean;
+        earnPercent?: number;
+        info?: {
+            referralCode: string;
+            totalReferrals: number;
+            totalRevenueUsd: number;
+        };
+    };
+}

package/dist/src/storefront/models/referralCode.d.ts

@@ -0,0 +1,3 @@
+export interface ReferralCode {
+    referralCode: string;
+}

package/dist/src/storefront/models/rewards.d.ts

@@ -0,0 +1,72 @@
+import { Price } from '@storefront/models';
+export declare enum RewardType {
+    Balance = "BALANCE",
+    Product = "PRODUCT"
+}
+export declare enum AchievementType {
+    Spend = "SPEND_AMOUNT",
+    Order = "ORDER_COUNT",
+    Referral = "REFER_FRIEND",
+    Review = "LEAVE_REVIEW"
+}
+interface ProductVariants {
+    id: number;
+    variantId: number;
+    productName: string;
+    variantName: string;
+    quantity: number;
+}
+interface BalanceRewardOptions {
+    balance: Price;
+}
+interface ProductRewardsOptions {
+    productsWithVariants: ProductVariants[];
+}
+interface BaseRewardRule {
+    id: number;
+}
+interface SpendRewardRule extends BaseRewardRule {
+    rewardType: RewardType;
+    rewardOptions: BalanceRewardOptions & ProductRewardsOptions;
+    ruleType: AchievementType.Spend;
+    ruleOptions: {
+        forEach: number;
+    };
+}
+interface OrderRewardRule extends BaseRewardRule {
+    rewardType: RewardType;
+    rewardOptions: BalanceRewardOptions & ProductRewardsOptions;
+    ruleType: AchievementType.Order;
+    ruleOptions: {
+        ordersCount: number;
+    };
+}
+interface ReferralRewardRule extends BaseRewardRule {
+    rewardType: RewardType;
+    rewardOptions: BalanceRewardOptions & ProductRewardsOptions;
+    ruleType: AchievementType.Referral;
+    ruleOptions: {
+        minReferrals: number;
+        minCompletedOrders: number;
+    };
+}
+interface ReviewRewardRule extends BaseRewardRule {
+    rewardType: RewardType;
+    rewardOptions: BalanceRewardOptions & ProductRewardsOptions;
+    ruleType: AchievementType.Review;
+    ruleOptions: {
+        minReviews: number;
+        minStars: number;
+    };
+}
+type RewardRule = SpendRewardRule | OrderRewardRule | ReferralRewardRule | ReviewRewardRule;
+export interface CustomerReward {
+    id: number;
+    progress: number;
+    createdAt: string;
+    completedAt?: string;
+    rewardRule: RewardRule;
+    isClaimed: boolean;
+}
+export declare const getRewards: () => Promise<Omit<CustomerReward, 'isClaimed'>[]>;
+export {};