@vindhq/sloud-payment-sdk 1.0.0

package/dist/src/components/modals/state/constants/index.d.ts

@@ -0,0 +1,2 @@
+export * from './actionTypes';
+export * from './initialState';

package/dist/src/components/modals/state/constants/initialState.d.ts

@@ -0,0 +1,36 @@
+import { PaymentStatus } from "../../../../hooks/types";
+export declare const initialPaymentState: {
+    paymentStatus: PaymentStatus;
+    additionalAmount: number;
+    paymentDetails: {
+        reference: string;
+        account_name: string;
+        account_number: string;
+        bank: string;
+        expiry: string;
+        amount: number;
+        currency: string;
+    };
+};
+export declare const initialModalState: {
+    open: boolean;
+    currentIndex: number;
+    isOpenAboutModal: boolean;
+};
+export declare const initialDataState: {
+    data: import("../../../../hooks/types").ProductItem[];
+    store: undefined;
+    isLoading: boolean;
+    deliveryDetails: {
+        channel: "pickup";
+        first_name: string;
+        last_name: string;
+        email: string;
+        phone_number: string;
+        street: string;
+        country: string;
+        state: string;
+        city: string;
+        note: string;
+    };
+};

package/dist/src/components/modals/state/reducers/data.d.ts

@@ -0,0 +1,2 @@
+import { DataState, RootAction } from '../types';
+export declare const dataReducer: (state: DataState | undefined, action: RootAction) => DataState;

package/dist/src/components/modals/state/reducers/index.d.ts

@@ -0,0 +1,2 @@
+import { RootAction, RootState } from '../types';
+export declare const rootReducer: (state: RootState, action: RootAction) => RootState;

package/dist/src/components/modals/state/reducers/modal.d.ts

@@ -0,0 +1,2 @@
+import { ModalState, RootAction } from '../types';
+export declare const modalReducer: (state: ModalState | undefined, action: RootAction) => ModalState;

package/dist/src/components/modals/state/reducers/payment.d.ts

@@ -0,0 +1,2 @@
+import { PaymentState, RootAction } from "../types";
+export declare const paymentReducer: (state: PaymentState | undefined, action: RootAction) => PaymentState;

package/dist/src/components/modals/state/types/common.d.ts

@@ -0,0 +1,12 @@
+import { DataState } from './data';
+import { ModalState } from './modal';
+import { PaymentState } from './payment';
+export interface ActionType<Type, Payload = unknown> {
+    type: Type;
+    payload: Payload;
+}
+export interface RootState {
+    payment: PaymentState;
+    modal: ModalState;
+    data: DataState;
+}

package/dist/src/components/modals/state/types/data.d.ts

@@ -0,0 +1,34 @@
+import { ProductItem } from '../../../../hooks/types';
+import { IGetStoreData } from '../../../../services';
+import { DATA_ACTIONS } from '../constants/actionTypes';
+import { ActionType } from './common';
+export interface DeliveryDetails {
+    channel: 'pickup' | 'delivery';
+    first_name: string;
+    last_name: string;
+    email: string;
+    phone_number: string;
+    street: string;
+    country: string;
+    state: string;
+    city: string;
+    note: string;
+}
+export interface EditItemPayload {
+    index: number;
+    quantity?: number;
+}
+export interface DataState {
+    data: ProductItem[];
+    store?: IGetStoreData;
+    isLoading: boolean;
+    deliveryDetails: DeliveryDetails;
+}
+export type SetDataAction = ActionType<typeof DATA_ACTIONS.SET_DATA, ProductItem[]>;
+export type SetStoreAction = ActionType<typeof DATA_ACTIONS.SET_STORE, IGetStoreData>;
+export type SetLoadingAction = ActionType<typeof DATA_ACTIONS.SET_LOADING, boolean>;
+export type SetDeliveryDetailsAction = ActionType<typeof DATA_ACTIONS.SET_DELIVERY_DETAILS, Partial<DeliveryDetails>>;
+export type EditItemAction = ActionType<typeof DATA_ACTIONS.EDIT_ITEM, EditItemPayload>;
+export type RemoveItemAction = ActionType<typeof DATA_ACTIONS.REMOVE_ITEM, number>;
+export type ResetDataAction = ActionType<typeof DATA_ACTIONS.RESET_DATA>;
+export type DataAction = SetDataAction | SetStoreAction | SetLoadingAction | SetDeliveryDetailsAction | EditItemAction | RemoveItemAction | ResetDataAction;

package/dist/src/components/modals/state/types/index.d.ts

@@ -0,0 +1,8 @@
+export * from './common';
+export * from './data';
+export * from './modal';
+export * from './payment';
+import { GLOBAL_ACTIONS } from '../constants/actionTypes';
+import { ActionType } from './common';
+export type ResetAllAction = ActionType<typeof GLOBAL_ACTIONS.RESET_ALL>;
+export type RootAction = import('./payment').PaymentAction | import('./modal').ModalAction | import('./data').DataAction | ResetAllAction;

package/dist/src/components/modals/state/types/modal.d.ts

@@ -0,0 +1,12 @@
+import { MODAL_ACTIONS } from '../constants';
+import { ActionType } from './common';
+export interface ModalState {
+    open: boolean;
+    currentIndex: number;
+    isOpenAboutModal: boolean;
+}
+export type SetOpenAction = ActionType<typeof MODAL_ACTIONS.SET_OPEN, boolean>;
+export type SetCurrentIndexAction = ActionType<typeof MODAL_ACTIONS.SET_CURRENT_INDEX, number>;
+export type SetAboutModalAction = ActionType<typeof MODAL_ACTIONS.SET_ABOUT_MODAL, boolean>;
+export type ResetModalAction = ActionType<typeof MODAL_ACTIONS.RESET_MODAL>;
+export type ModalAction = SetOpenAction | SetCurrentIndexAction | SetAboutModalAction | ResetModalAction;

package/dist/src/components/modals/state/types/payment.d.ts

@@ -0,0 +1,14 @@
+import { PaymentStatus } from '../../../../hooks/types';
+import { IPaymentDetails } from '../../../../services/products/types';
+import { PAYMENT_ACTIONS } from '../constants/actionTypes';
+import { ActionType } from './common';
+export interface PaymentState {
+    paymentStatus: PaymentStatus;
+    additionalAmount: number;
+    paymentDetails: IPaymentDetails;
+}
+export type SetPaymentStatusAction = ActionType<typeof PAYMENT_ACTIONS.SET_PAYMENT_STATUS, PaymentStatus>;
+export type SetPaymentDetailsAction = ActionType<typeof PAYMENT_ACTIONS.SET_PAYMENT_DETAILS, IPaymentDetails>;
+export type SetAdditionalAmountAction = ActionType<typeof PAYMENT_ACTIONS.SET_ADDITIONAL_AMOUNT, number>;
+export type ResetPaymentAction = ActionType<typeof PAYMENT_ACTIONS.RESET_PAYMENT>;
+export type PaymentAction = SetPaymentStatusAction | SetPaymentDetailsAction | SetAdditionalAmountAction | ResetPaymentAction;

package/dist/src/components/modals/state/utils/index.d.ts

@@ -0,0 +1,37 @@
+import { DeliveryDetails } from "../types";
+import { ProductItem } from "../../../../hooks/types";
+export declare const calculateTotalPrice: (data: ProductItem[]) => number;
+export declare const formatItemsForOrder: (data: ProductItem[]) => {
+    product_id: string;
+    discount: number;
+    quantity: number;
+    variation: string[];
+}[];
+export declare const createOrderPayload: (data: ProductItem[], deliveryDetails: DeliveryDetails, additionalAmount: number) => {
+    additional_amount: number;
+    discount: number;
+    payment_method: string;
+    buyer_details: DeliveryDetails;
+    channel: "pickup" | "delivery";
+    delivery_details: {
+        channel: "pickup" | "delivery";
+        first_name: string;
+        last_name: string;
+        email: string;
+        phone_number: string;
+        street: string;
+        country: string;
+        state: string;
+        city: string;
+        note: string;
+    };
+    items: {
+        product_id: string;
+        discount: number;
+        quantity: number;
+        variation: string[];
+    }[];
+};
+export declare const loadCartFromStorage: () => ProductItem[];
+export declare const saveCartToStorage: (data: ProductItem[]) => void;
+export declare const clearCartFromStorage: () => void;

package/dist/src/context/ModalProvider.d.ts

@@ -0,0 +1,4 @@
+declare const ModalProvider: ({ children }: {
+    children: React.JSX.Element;
+}) => import("react/jsx-runtime").JSX.Element;
+export default ModalProvider;

package/dist/src/context/PaymentInfoContext.d.ts

@@ -0,0 +1,26 @@
+import React, { ReactNode } from "react";
+interface BankAccount {
+    accountName: string;
+    accountNumber: string;
+    bank: string;
+}
+interface TransactionDetails {
+    reference: string;
+    amount: number;
+    charge: number;
+    currency: string;
+    expiry: string;
+}
+interface PaymentInfoContextProp {
+    collectionAccount: BankAccount;
+    transactionDetails: TransactionDetails;
+    updateCollectionAccount: (bankAccount: BankAccount) => void;
+    updateTransactionDetails: (transactionDetails: TransactionDetails) => void;
+}
+declare const PaymentInfoContext: React.Context<PaymentInfoContextProp | undefined>;
+interface PaymentWidgetProviderProps {
+    children: ReactNode;
+}
+export declare const PaymentInfoProvider: React.FC<PaymentWidgetProviderProps>;
+export default PaymentInfoContext;
+export declare const usePaymentInfoContext: () => PaymentInfoContextProp;

package/dist/src/context/PaymentWidgetContext.d.ts

@@ -0,0 +1,13 @@
+import React, { ReactNode } from "react";
+import { PaymentWidgetOptions } from "../widget";
+interface PaymentWidgetContextType {
+    options: PaymentWidgetOptions;
+}
+declare const PaymentWidgetContext: React.Context<PaymentWidgetContextType | undefined>;
+export declare const usePaymentWidgetContext: () => PaymentWidgetContextType;
+interface PaymentWidgetProviderProps {
+    children: ReactNode;
+    options: PaymentWidgetOptions;
+}
+export declare const PaymentWidgetProvider: React.FC<PaymentWidgetProviderProps>;
+export default PaymentWidgetContext;

package/dist/src/context/modal.d.ts

@@ -0,0 +1,4 @@
+import { ModalContextTypes } from "./types";
+declare const ModalContext: import("react").Context<ModalContextTypes | undefined>;
+export declare const useModalContext: () => ModalContextTypes;
+export default ModalContext;

package/dist/src/context/types.d.ts

@@ -0,0 +1,28 @@
+import { DeliveryDetails, PaymentStatus, ProductItem } from "../hooks/types";
+import { IGetStoreData } from "../services";
+import { IPaymentDetails } from "../services/products/types";
+export interface ModalContextTypes {
+    open: boolean;
+    data: ProductItem[];
+    totalPrice: number;
+    currentModal: string;
+    movePrev: () => void;
+    moveNext: () => void;
+    openModal: () => void;
+    closeModal: () => void;
+    store: IGetStoreData | undefined;
+    editItemQuantity: (index: number, quantity?: number) => void;
+    removeItem: (index: number) => void;
+    isLoading: boolean;
+    paymentStatus: PaymentStatus;
+    setPaymentStatus: (status: PaymentStatus) => void;
+    deliveryDetails: DeliveryDetails;
+    paymentDetails: IPaymentDetails;
+    additionalAmount: number;
+    setAdditionalAmount: (amount: number) => void;
+    setDeliveryDetails: (details: DeliveryDetails) => void;
+    setData: (newData: ProductItem[]) => void;
+    orderProducts: () => Promise<void>;
+    isOpenAboutModal: boolean;
+    completeOperation: () => void;
+}

package/dist/src/hooks/types.d.ts

@@ -0,0 +1,34 @@
+export declare enum ModalNames {
+    Payment = "Payment",
+    PaymentDetails = "PaymentDetails",
+    AwaitingPayment = "AwaitingPayment",
+    AwaitingPaymentTimeout = "AwaitingPaymentTimeout",
+    Success = "Success"
+}
+export interface DeliveryDetails {
+    channel: "pickup" | "delivery";
+    first_name: string;
+    last_name: string;
+    email: string;
+    phone_number: string;
+    street: string;
+    country: string;
+    state: string;
+    city: string;
+    note: string;
+}
+export interface ProductItem {
+    id: string;
+    image_url: string;
+    name: string;
+    variations: string[];
+    quantity: number;
+    price: number;
+    in_stock: number;
+}
+export declare enum PaymentStatus {
+    PENDING = "pending",
+    SUCCESS = "success",
+    FAILED = "failed",
+    CANCELLED = "cancelled"
+}

package/dist/src/hooks/useModalControl.d.ts

@@ -0,0 +1,27 @@
+import { DeliveryDetails, ModalNames, PaymentStatus, ProductItem } from "./types";
+declare const useModalControl: () => {
+    open: boolean;
+    data: ProductItem[];
+    store: import("../services").IGetStoreData | undefined;
+    currentModal: ModalNames;
+    totalPrice: number;
+    isLoading: boolean;
+    moveNext: () => void;
+    movePrev: () => void;
+    openModal: () => void;
+    closeModal: () => void;
+    orderProducts: () => Promise<void>;
+    deliveryDetails: import("../components/modals/state/types").DeliveryDetails;
+    setDeliveryDetails: (details: DeliveryDetails) => void;
+    paymentDetails: import("../services/products/types").IPaymentDetails;
+    paymentStatus: PaymentStatus;
+    setPaymentStatus: (status: PaymentStatus) => void;
+    additionalAmount: number;
+    setAdditionalAmount: (amount: number) => void;
+    editItemQuantity: (index: number, quantity?: number) => void;
+    removeItem: (index: number) => void;
+    setData: (newData: ProductItem[]) => void;
+    isOpenAboutModal: boolean;
+    completeOperation: () => void;
+};
+export default useModalControl;

package/dist/src/hooks/usePaymentAPI.d.ts

@@ -0,0 +1,10 @@
+export declare const usePaymentAPI: () => {
+    generatePaymentInstrument: () => Promise<void>;
+    paymentMethods: Record<string, boolean>;
+    publicKey: string;
+    isLocalEnv: boolean | undefined;
+    isFetchingMethods: boolean;
+    isLoading: boolean;
+    isSuccess: boolean;
+};
+export default usePaymentAPI;

package/dist/src/hooks/useShortPolling.d.ts

@@ -0,0 +1,4 @@
+declare const useShortPolling: ({ activate }: {
+    activate: boolean;
+}) => void;
+export default useShortPolling;

package/dist/src/index.d.ts

@@ -0,0 +1,2 @@
+import Widget from "./widget";
+export default Widget;

package/dist/src/services/config/endpoints.d.ts

@@ -0,0 +1,9 @@
+export declare const Endpoints: {
+    getPaymentMethods: (public_key: string) => string;
+    generatePaymentInstrument: (public_key: string) => string;
+    getPaymentStatus: (payment_reference: string) => string;
+};
+export interface BaseAPIResponse {
+    status: string;
+    message: string;
+}

package/dist/src/services/config/error.d.ts

@@ -0,0 +1,5 @@
+import { AxiosError } from "axios";
+export declare function handleError(error: AxiosError<{
+    status: string;
+    message: string;
+}>): void;

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

@@ -0,0 +1,27 @@
+import { AxiosError, InternalAxiosRequestConfig } from "axios";
+export * from "./store/types";
+export interface WidgetOptions {
+    public_key: string;
+    isLocalEnv?: boolean;
+    amount: number;
+    first_name: string;
+    last_name: string;
+    phone_number: string;
+    email: string;
+}
+export declare const setWidgetOptions: (options: WidgetOptions) => void;
+export declare const getWidgetOptions: () => WidgetOptions;
+interface APIError {
+    status: string;
+    message: string;
+}
+export interface IApiResponse<T> {
+    response?: T;
+    error?: AxiosError<APIError>;
+}
+export type ApiRequest = Pick<InternalAxiosRequestConfig<unknown>, "method" | "url" | "params" | "data">;
+export declare const makeApiCall: <T>(request: ApiRequest) => Promise<IApiResponse<T>>;
+export declare const errors: {
+    403: string;
+    404: string;
+};

package/dist/src/services/payments/index.d.ts

@@ -0,0 +1,4 @@
+import { IGeneratePaymentInstrumentPayload, IGetPaymentMethodsResponse, IPaymentInstrumentResponse, IPaymentStatusResponse } from "./types";
+export declare const fetchPaymentMethods: (public_key: string) => Promise<import("..").IApiResponse<IGetPaymentMethodsResponse>>;
+export declare const generatePaymentInstrumentService: (public_key: string, payload: IGeneratePaymentInstrumentPayload) => Promise<import("..").IApiResponse<IPaymentInstrumentResponse>>;
+export declare const fetchPaymentStatusService: (payment_reference: string) => Promise<import("..").IApiResponse<IPaymentStatusResponse>>;

package/dist/src/services/payments/types.d.ts

@@ -0,0 +1,68 @@
+import { PaymentStatus } from "../../hooks/types";
+import { BaseAPIResponse } from "../config/endpoints";
+export interface IGetPaymentMethodsResponse extends BaseAPIResponse {
+    data: {
+        bank_transfer: boolean;
+        sloud_wallet: boolean;
+        card: boolean;
+    };
+}
+export interface IPaymentStatusRequest {
+    path: {
+        id: string;
+        reference: string;
+    };
+}
+export interface IGetProductsResponse {
+    status: string;
+    message: string;
+    data: {
+        status: PaymentStatus;
+    };
+}
+export interface IGeneratePaymentInstrumentPayload {
+    amount: number;
+    customer: {
+        first_name: string;
+        last_name: string;
+        phone_number: string;
+        email: string;
+    };
+}
+export interface IPaymentInstrumentResponse extends BaseAPIResponse {
+    data: {
+        reference: string;
+        account_name: string;
+        account_number: string;
+        bank: string;
+        expiry: string;
+        amount: number;
+        charge: number;
+        currency: string;
+    };
+}
+export interface IPaymentStatusResponse extends BaseAPIResponse {
+    data: {
+        reference: string;
+        status: string;
+        amount: number;
+        currency: string;
+        updatedAt: string;
+    };
+}
+export interface IGetChargePayload {
+    amount: number;
+}
+export interface IGetChargeRequest {
+    path: {
+        slug: string;
+    };
+}
+export interface IGetChargeResponse {
+    status: string;
+    message: string;
+    data: {
+        charge: number;
+        total_amount: number;
+    };
+}

package/dist/src/services/products/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/services/products/types.d.ts

@@ -0,0 +1,124 @@
+export interface IGetProductsResponse {
+    status: string;
+    message: string;
+    data: IProduct[];
+    metadata: IMetadata;
+}
+export interface IProductDetail {
+    id: string;
+    name: string;
+    description: string;
+    price: number;
+    currency: string;
+    image_url: string[];
+    variation: Record<string, string[]>;
+    discount: number;
+    discounted_amount: number;
+    availability: string;
+    in_stock: number;
+}
+export interface IGetProductResponse {
+    status: string;
+    message: string;
+    data: IProductDetail;
+}
+export interface IPaymentDetails {
+    reference?: string;
+    account_name?: string;
+    account_number?: string;
+    bank?: string;
+    expiry?: string;
+    amount?: number;
+    currency?: string;
+}
+export interface IOrderProductResponseData {
+    payment_details: IPaymentDetails;
+}
+export interface IOrderProductResponse {
+    status: string;
+    message: string;
+    data: IOrderProductResponseData;
+}
+export interface IMetadata {
+    cursor: string;
+    beforeCursor: string;
+    totalCount: number;
+    pageSize: number;
+}
+export interface IProduct {
+    id: number;
+    name: string;
+    category: string;
+    amount: number;
+    currency: string;
+    in_stock: number;
+    availability: number;
+    image_url: string[];
+    discounted_amount: number;
+}
+export interface IGetProductsRequest {
+    path: {
+        id: string;
+        collectionId: string | null;
+    };
+    params: {
+        name: string;
+        pageSize: number;
+        pageNumber: number;
+        cursor?: number;
+        beforeCursor?: number;
+    };
+}
+export interface IGetProductRequest {
+    path: {
+        productId: string;
+        storeId: string;
+    };
+}
+export interface IOrderProductRequest {
+    path: {
+        slug: string;
+    };
+}
+export interface IBuyerDetails {
+    first_name: string;
+    last_name: string;
+    email: string;
+    phone_number: string;
+}
+export interface IDeliveryDetails {
+    street: string;
+    country: string;
+    state: string;
+    city: string;
+    note: string;
+}
+export interface IItem {
+    product_id: string;
+    discount: number;
+    variation: string[];
+    quantity: number;
+}
+export interface IOrderProductRequestPayload {
+    discount: number;
+    additional_amount: number;
+    payment_method: string;
+    buyer_details: IBuyerDetails;
+    channel: 'pickup' | 'delivery';
+    delivery_details: IDeliveryDetails;
+    items: IItem[];
+}
+export interface IGetProductAvailabilityRequest {
+    path: {
+        slug: string;
+        productId: string;
+    };
+}
+export interface IGetProductAvailabilityResponse {
+    status: string;
+    message: string;
+    data: {
+        is_available: boolean;
+        quantity: number;
+    };
+}

package/dist/src/services/store/index.d.ts

@@ -0,0 +1,2 @@
+export declare const getSubdomainClient: () => string;
+export declare const getSubDomain: (host: string) => string;

package/dist/src/services/store/types.d.ts

@@ -0,0 +1,57 @@
+export interface IGetStorePath {
+    slug: string;
+}
+export interface IGetStoreResponse {
+    status: string;
+    message: string;
+    data: IGetStoreData;
+}
+export type SocialMediaPlatformTypes = 'Whatsapp' | 'Facebook' | 'Instagram' | 'TikTok' | 'X';
+export interface IGetStoreData {
+    id: string;
+    banner_url: string;
+    avatar_url: string;
+    maintenance_mode: boolean;
+    preferences?: {
+        mode_of_delivery: 'Pickup' | 'Delivery' | 'Delivery/Pickup';
+        mode_of_transaction_charge: 'Customer' | 'Merchant';
+    };
+    social_media: {
+        platform: SocialMediaPlatformTypes;
+        url: string;
+    }[];
+    delivery_areas: {
+        location: string;
+        amount: number;
+    }[];
+    phone_number: string;
+    collections: Collection[];
+    best_sellers: Bestseller[];
+    metadata: Metadata;
+}
+export interface Metadata {
+    description: string;
+    author: string;
+    store_slug: string;
+    address: string;
+    business_name: string;
+}
+export interface Bestseller {
+    id: number;
+    product: string;
+    category: string;
+    amount: number;
+    currency: string;
+    in_stock: number;
+    availability: number;
+    keywords: string[];
+    image_url: string[];
+    name: string;
+    discounted_amount: number;
+}
+export interface Collection {
+    id: string;
+    name: string;
+    description: string;
+    cover_image_url: string[];
+}