@instincthub/react-ui 0.0.2 → 0.0.3

package/dist/src/types/components/lib/helpFunction.d.ts

@@ -0,0 +1,233 @@
+export declare const IN_DEV_MODE: boolean;
+export declare const API_HOST_URL: string;
+export declare const FILE_URL: string;
+export declare const VIDEO_URL: string;
+export declare const CODECS_URL_M3U8: string;
+export declare const romansFigure: string[];
+interface Course {
+    credits: string | number;
+}
+interface CourseObj {
+    course: Course;
+}
+interface SubDomainResult {
+    value: string;
+    field: "username" | "domain";
+}
+interface FormItem {
+    [key: string]: string | number | object | Blob | null | undefined | any[];
+}
+interface RequestOptions extends RequestInit {
+    headers: Record<string, string>;
+    body?: BodyInit | FormData | null;
+}
+/**
+ * Adds a subdomain to Vercel project.
+ * @param domain The domain to add as a subdomain
+ * @returns Promise resolving to the fetch Response
+ */
+export declare const addUserDomain: (domain: string) => Promise<Response>;
+/**
+ * Strips HTML tags from a string.
+ * @param str Input string with potential HTML tags
+ * @returns Cleaned string without HTML tags
+ */
+export declare const stripHtmlTags: (str: string) => string;
+/**
+ * Removes commas from a number string and converts to number.
+ * @param str Input string or number
+ * @returns Parsed number or 0 if invalid
+ */
+export declare const stripCommaFromNumber: (str: string | number) => number;
+/**
+ * Calculates total credits from an array of course objects.
+ * @param courses Array of course objects
+ * @returns Total credits as a number
+ */
+export declare const calculateTotalCredits: (courses: CourseObj[]) => number;
+/**
+ * Calculates amount after percentage deduction.
+ * @param amount Base amount
+ * @param percentage Percentage to deduct (0-100)
+ * @returns Object with final amount or error details
+ */
+export declare const calculateAmountAfterDeduction: (amount: number, percentage: number) => {
+    amount: number;
+    detail?: string | undefined;
+};
+/**
+ * Finds keys in an object that are null, undefined, or empty string.
+ * @param namesArray Array of keys to check
+ * @param obj Object to inspect
+ * @returns Array of keys with null/empty values
+ */
+export declare const findNullOrEmptyKeys: <T extends Record<string, any>>(namesArray: string[], obj: T) => string[];
+/**
+ * Extracts subdomain or domain from hostname.
+ * @param hostname Hostname string
+ * @returns Subdomain result or null
+ */
+export declare const extractSubDomain: (hostname: string) => SubDomainResult | null;
+/**
+ * Converts an array of objects to FormData.
+ * @param array Array of items to convert
+ * @returns FormData object
+ */
+export declare const convertArrayToFormData: (array: FormItem[]) => FormData;
+/**
+ * Handles form validation errors.
+ * @param e Event object from form input
+ * @param formError Current error list
+ * @param setFormError Function to update error list
+ * @returns Error message with status code
+ */
+export declare const handleInvalid: (e: React.FormEvent<HTMLInputElement>, formError: string[], setFormError: (errors: string[]) => void) => [string, number];
+/**
+ * Calculates average rating from an array of numbers.
+ * @param ratings Array of ratings
+ * @returns Average rating as a string with 1 decimal place
+ */
+export declare const calculateAverageRating: (ratings: number[]) => string;
+/**
+ * Converts a string to a float, removing commas.
+ * @param value Input string
+ * @returns Parsed float
+ */
+export declare const convertToFloat: (value: string) => number;
+/**
+ * Formats a number with commas.
+ * @param number Input number
+ * @returns Formatted string or error message
+ */
+export declare const formatNumberWithCommas: (number: number) => string;
+export declare const slugifyFileName: (fileName: string) => string;
+/**
+ * Checks if an element is in the viewport.
+ * @param element DOM element
+ * @returns Boolean indicating visibility
+ */
+export declare const TrackViewPort: (element: HTMLElement | null) => boolean;
+/**
+ * Formats duration in minutes to a readable string.
+ * @param durationInMinutes Duration in minutes
+ * @returns Formatted duration string
+ */
+export declare const formatDuration: (durationInMinutes: number) => string;
+/**
+ * Truncates HTML content to a specified length.
+ * @param markdownText HTML string
+ * @param maxLength Maximum length
+ * @returns Truncated string
+ */
+export declare const truncateHtml: (markdownText: string, maxLength: number) => string;
+/**
+ * Formats a date to a readable string.
+ * @param date Date object or string
+ * @param type Format type (default: "iiii do MMMM yyyy")
+ * @returns Formatted date string
+ */
+export declare const formatDateToWord: (date: Date | string, type?: string) => string;
+/**
+ * Encodes the current URL.
+ * @returns Encoded URL string or undefined if not in browser
+ */
+export declare const hostUrlEncode: () => string | undefined;
+/**
+ * Validates if input is alphanumeric and at least 3 characters.
+ * @param input Input string
+ * @returns Boolean indicating validity
+ */
+export declare const isValidAlphanumeric: (input: string) => boolean;
+/**
+ * Validates if input is a valid email.
+ * @param input Input string
+ * @returns Boolean indicating validity
+ */
+export declare const isValidEmail: (input: string) => boolean;
+/**
+ * Converts a string to title case.
+ * @param str Input string
+ * @returns Title case string or original value if not a string
+ */
+export declare const toTitleCase: (str: any) => any;
+/**
+ * Gets a cookie value by name.
+ * @param cname Cookie name
+ * @returns Cookie value or null
+ */
+export declare const getCookie: (cname: string) => string | null;
+/**
+ * Removes a cookie by name.
+ * @param cname Cookie name
+ */
+export declare const removeCookie: (cname: string) => void;
+/**
+ * Sets a cookie with name, value, and expiration days.
+ * @param cname Cookie name
+ * @param cvalue Cookie value
+ * @param exdays Expiration days
+ */
+export declare const setCookie: (cname: string, cvalue: string, exdays: number) => void;
+/**
+ * Prints an error message for a form field.
+ * @param key Field name
+ * @param value Error message
+ * @param index Index for focusing first error
+ */
+export declare const printErr: (key: string, value: string, index: number) => void;
+/**
+ * Handles server response errors for forms.
+ * @param status HTTP status code
+ * @param items Error or success data
+ * @param registerForm Form element
+ * @param r_path Redirect path
+ */
+export declare const handleError: (status: number, items: Record<string, string[]>, registerForm: HTMLFormElement | null, r_path: string | null) => void;
+/**
+ * Creates request options for fetch API.
+ * @param method HTTP method
+ * @param data Request body
+ * @param token Auth token
+ * @param content_type Content type
+ * @param channel Channel ID
+ * @param auth_sk Use auth secret
+ * @returns Request options object
+ */
+export declare const reqOptions: (method: string, data?: BodyInit | FormData | null, token?: string | null, content_type?: "json" | "form-data" | null | false, channel?: string | null, auth_sk?: boolean) => RequestOptions;
+/**
+ * Fetches data from an API with error handling.
+ * @param session Callback or state setter
+ * @param api API endpoint
+ * @param reqOptions Request options
+ * @param isFunctionComponent Is functional component
+ * @param setStatus Status setter
+ * @param setError Error setter
+ * @param flag Handle status errors
+ * @returns Promise with result or error
+ */
+export declare const fetchAPI: <T>(session: {
+    setState: (state: {
+        data?: T | undefined;
+        status?: number | undefined;
+        error?: any;
+    }) => void;
+} | ((data: T) => void), api: string, reqOptions: RequestOptions, isFunctionComponent?: boolean, setStatus?: ((status: number | null) => void) | undefined, setError?: ((error: any) => void) | undefined, flag?: boolean) => Promise<T | Error>;
+/**
+ * Handles HTTP status errors with navigation.
+ * @param status HTTP status code
+ */
+export declare const handleStatusError: (status: number) => void;
+/**
+ * Toggles form button spinner and disabled state.
+ * @param form Form element
+ * @param display Spinner display style
+ * @param status Disabled status
+ */
+export declare const spinBtn: (form: HTMLFormElement | null, display: "none" | "inline-block", status: boolean) => void;
+/**
+ * Resends OTP to an email.
+ * @param email User email
+ * @returns Promise with response data
+ */
+export declare const handleResendOTP: (email: string) => Promise<any>;
+export {};

package/dist/src/types/components/lib/index.d.ts

@@ -0,0 +1,20 @@
+export * from "./auth/actions";
+export * from "./auth/dbRequestst";
+export * from "./json/accounts";
+export * from "./json/countryNigeria";
+export * from "./json/countryObjects";
+export * from "./json/educationLevels";
+export * from "./json/unsplashDefaultObject";
+export * from "./createSubscription";
+export * from "./elementIsVisibleInViewport";
+export * from "./fileToBase64";
+export * from "./format";
+export * from "./formError";
+export * from "./getPriceObjects";
+export * from "./helpFunction";
+export * from "./loadScript";
+export * from "./modals";
+export * from "./oauth_json";
+export * from "./paystack";
+export * from "./permissions";
+export * from "./utils";

package/dist/src/types/components/lib/json/accounts.d.ts

@@ -0,0 +1,42 @@
+export declare const accounts: {
+    id: number;
+    name: string;
+    type: string;
+}[];
+export declare const AllCoursesdataList: {
+    icon: string;
+    title: string;
+}[];
+export declare const DataList: {
+    icon: string;
+    title: string;
+}[];
+export declare const dataList: {
+    title: string;
+    archiveDate: string;
+}[];
+export declare const projectStartHistory: {
+    title: string;
+    date: string;
+    time: string;
+}[];
+export declare const pending: {
+    title: string;
+    stack: string;
+    date: string;
+}[];
+export declare const statesNigeria: string[];
+export declare const COMMENTS_BY: {
+    id: number;
+    content: string;
+    timestamp: Date;
+    user: {
+        first_name: string;
+        last_name: string;
+        email: string;
+        username: string;
+        verified: boolean;
+        is_staff: boolean;
+    };
+    replies: never[];
+}[];

package/dist/src/types/components/lib/json/countryNigeria.d.ts

@@ -0,0 +1,17 @@
+declare const countryNigeria: {
+    name: string;
+    isoCode: string;
+    flag: string;
+    phonecode: string;
+    currency: string;
+    latitude: string;
+    longitude: string;
+    timezones: {
+        zoneName: string;
+        gmtOffset: number;
+        gmtOffsetName: string;
+        abbreviation: string;
+        tzName: string;
+    }[];
+};
+export default countryNigeria;

package/dist/src/types/components/lib/json/countryObjects.d.ts

@@ -0,0 +1,17 @@
+declare const countryObjects: {
+    name: string;
+    isoCode: string;
+    flag: string;
+    phonecode: string;
+    currency: string;
+    latitude: string;
+    longitude: string;
+    timezones: {
+        zoneName: string;
+        gmtOffset: number;
+        gmtOffsetName: string;
+        abbreviation: string;
+        tzName: string;
+    }[];
+}[];
+export default countryObjects;

package/dist/src/types/components/lib/json/educationLevels.d.ts

@@ -0,0 +1,2 @@
+declare const educationLevels: string[];
+export default educationLevels;

package/dist/src/types/components/lib/json/unsplashDefaultObject.d.ts

@@ -0,0 +1,12 @@
+export declare const unsplashDefaultObject: {
+    id: string;
+    urls: {
+        regular: string;
+    };
+    user: {
+        id: string;
+        updated_at: string;
+        username: string;
+        name: string;
+    };
+};

package/dist/src/types/components/lib/loadScript.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Dynamically loads an external JavaScript file
+ * @param scriptSrc - URL of the script to load
+ * @returns The script element or false if no source provided
+ */
+declare const loadScript: (scriptSrc: string) => HTMLScriptElement | false;
+export default loadScript;

package/dist/src/types/components/lib/modals.d.ts

@@ -0,0 +1,14 @@
+type StatusCode = 200 | 201 | 400 | 500 | number;
+declare global {
+    interface Window {
+        handleCancel: () => void;
+        handleConfirm: () => void;
+        cleanupToast: () => void;
+        handleInput: (e: HTMLInputElement) => void;
+        handleCleanUpInput: () => void;
+    }
+}
+export declare const openConfirmModal: (message: string, flag?: boolean) => Promise<boolean>;
+export declare const openToast: (message?: string, status?: StatusCode) => void;
+export declare const getUserEmailInputModal: (title: string) => Promise<string | undefined>;
+export {};

package/dist/src/types/components/lib/oauth_json.d.ts

@@ -0,0 +1,97 @@
+export declare const profile_goggle_provider: {
+    iss: string;
+    azp: string;
+    aud: string;
+    sub: string;
+    email: string;
+    email_verified: boolean;
+    at_hash: string;
+    name: string;
+    picture: string;
+    given_name: string;
+    family_name: string;
+    locale: string;
+    iat: number;
+    exp: number;
+};
+export declare const paystackHook: {
+    data: {
+        id: number;
+        log: null;
+        fees: number;
+        plan: {};
+        split: {};
+        amount: number;
+        domain: string;
+        paidAt: string;
+        source: {
+            type: string;
+            source: string;
+            identifier: null;
+            entry_point: string;
+        };
+        status: string;
+        channel: string;
+        message: null;
+        paid_at: string;
+        currency: string;
+        customer: {
+            id: number;
+            email: string;
+            phone: string;
+            metadata: null;
+            last_name: string;
+            first_name: string;
+            risk_action: string;
+            customer_code: string;
+            international_format_phone: null;
+        };
+        metadata: {
+            user: number;
+            amount: number;
+            channel: string;
+            payload: {
+                payment_date: string;
+                transaction_id: string;
+                additional_info: string;
+            };
+            success: boolean;
+            currency: string;
+            duration: number;
+            referrer: string;
+            reminder: number;
+            object_id: string;
+            reference: string;
+            content_type: number;
+            payment_channel: string;
+        };
+        order_id: null;
+        reference: string;
+        created_at: string;
+        fees_split: null;
+        ip_address: string;
+        subaccount: {};
+        authorization: {
+            bin: string;
+            bank: string;
+            brand: string;
+            last4: string;
+            channel: string;
+            exp_year: string;
+            reusable: boolean;
+            card_type: string;
+            exp_month: string;
+            signature: string;
+            account_name: null;
+            country_code: string;
+            receiver_bank: null;
+            authorization_code: string;
+            receiver_bank_account_number: null;
+        };
+        fees_breakdown: null;
+        gateway_response: string;
+        requested_amount: number;
+        pos_transaction_data: null;
+    };
+    event: string;
+};

package/dist/src/types/components/lib/paystack.d.ts

@@ -0,0 +1,115 @@
+export interface PaystackMetadata {
+    channel_username?: string;
+    custom_fields?: Array<Record<string, any>>;
+    [key: string]: any;
+}
+export interface PaystackConfigObject {
+    authorization_code?: string;
+    email: string;
+    first_name: string;
+    last_name: string;
+    amount: number;
+    user_id?: string | number;
+    channel_id?: string | number;
+    content_type: string;
+    object_id: string | number;
+    metadata?: PaystackMetadata;
+}
+export interface PaystackConfig {
+    authorization_code?: string;
+    reference: string;
+    email: string;
+    first_name: string;
+    last_name: string;
+    amount: number;
+    publicKey: string | undefined;
+    key: string | undefined;
+    callback_url: string;
+    metadata?: PaystackMetadata;
+}
+export interface PaystackResponse {
+    status: string;
+    reference: string;
+    message?: string;
+    transaction?: string;
+    canceled?: boolean;
+    [key: string]: any;
+}
+export interface PaymentMethod {
+    authorization: {
+        authorization_code: string;
+        email: string;
+    };
+    card_type: string;
+    last4: string;
+}
+/**
+ * Context for processing payments
+ * @property {Event | null} [e] - The event object that triggered the payment
+ * @property {Object} objects - Details about the item being purchased
+ * @property {string} objects.title - Title of the item
+ * @property {Object} [objects.object_type] - Type information for the item
+ * @property {string} [objects.object_type.content_type] - Content type identifier
+ * @property {string|number} [objects.object_id] - ID of the object being purchased
+ * @property {PaystackConfigObject} configObj - Configuration for PayStack
+ * @property {PaymentMethod} [paymentMethod] - Saved payment method if available
+ * @property {Function} setStatus - Function to update UI status during payment process
+ * @property {Function} handleDBAction - Callback for processing successful payments
+ * @property {boolean} [defaultConfirm] - Whether to show a confirmation dialog
+ * @property {string} label - Label for the payment (usually item title)
+ * @property {string} [coupon] - Coupon code if applicable
+ * @property {string} [defaultMsg] - Custom confirmation message
+ * @property {number} [gatwayCharges] - Payment gateway charges percentage
+ */
+export interface PaymentContext {
+    e?: Event | null;
+    objects: {
+        title: string;
+        object_type?: {
+            content_type: string;
+        };
+        object_id?: string | number;
+    };
+    configObj: PaystackConfigObject;
+    paymentMethod?: PaymentMethod;
+    setStatus: (status?: number) => void;
+    handleDBAction: (data?: any) => void;
+    defaultConfirm?: boolean;
+    label: string;
+    coupon?: string;
+    defaultMsg?: string;
+    gatwayCharges?: number;
+}
+/**
+ * Configures the Paystack payment data for processing
+ * @param obj - Object containing payment details
+ * @returns PaystackConfig - Configured payment data
+ */
+export declare const paystackDataConfig: (obj: PaystackConfigObject) => PaystackConfig;
+/**
+ * Charges a customer using an existing authorization
+ * @param data - Payment configuration data
+ * @returns Promise with transaction data
+ */
+export declare const chargeAuthorization: (data: PaystackConfig) => Promise<any>;
+/**
+ * Initiates payment with Paystack popup
+ * @param config - Payment configuration
+ * @returns Promise with payment response
+ */
+export declare const payWithPaystack: (config: PaystackConfig) => Promise<PaystackResponse>;
+/**
+ * Handles the complete payment submission process
+ * @param contexts - Payment context information
+ * @context This function orchestrates the entire payment flow from confirmation to processing
+ */
+export declare function handlePaymentSubmit(contexts: PaymentContext): Promise<void>;
+declare global {
+    interface Window {
+        PaystackPop: {
+            setup: (config: any) => {
+                openIframe: () => void;
+            };
+        };
+    }
+}

package/dist/src/types/components/lib/permissions.d.ts

@@ -0,0 +1,22 @@
+import { NextApiRequest } from 'next';
+interface Session {
+    user: {
+        name: {
+            username: string;
+        };
+    };
+}
+/**
+ * Validates if the request has valid username and custom header
+ * @param session - User session from NextAuth
+ * @param req - Next.js API request object
+ * @returns Promise<boolean> - True if the request has valid permissions
+ */
+export declare const headerUsernamePermission: (session: Session | null, req: NextApiRequest) => Promise<boolean>;
+/**
+ * Validates if the request has a valid custom header
+ * @param req - Next.js API request object
+ * @returns Promise<boolean> - True if the request has a valid header
+ */
+export declare const headerKeyPermission: (req: NextApiRequest) => Promise<boolean>;
+export {};