@splpi/estore-shared-components 7.0.3 → 7.0.5

package/dist/index.d.mts

@@ -1,5 +1,7 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React$1 from 'react';
+import * as axios from 'axios';
+import { AxiosRequestConfig } from 'axios';
 import { IconType } from 'react-icons';
 
 interface IPersonalInfo {
@@ -96,6 +98,8 @@ interface IParsedAddress {
 }
 
 interface LifePlanApplication2Props {
+    /** Saved address, shown when the user comes back to this form. */
+    initialData?: IAddress;
     onAddressUpdate?: (address: IAddress) => void;
     /**
      * Optional address parser from the host app (e.g. GeoApifyService.parseAddress).
@@ -103,7 +107,7 @@ interface LifePlanApplication2Props {
      */
     parseAddress?: (addressLine: string) => Promise<IParsedAddress>;
 }
-declare const LifePlanApplication2: ({ onAddressUpdate, parseAddress, }: LifePlanApplication2Props) => react_jsx_runtime.JSX.Element;
+declare const LifePlanApplication2: ({ initialData, onAddressUpdate, parseAddress, }: LifePlanApplication2Props) => react_jsx_runtime.JSX.Element;
 
 interface LifePlanApplication3Props {
     initialData?: IEmployment;
@@ -123,7 +127,7 @@ declare const LifePlanApplicationFormWrapper: ({ openSection, openSectionKey, on
     openSectionKey?: number;
     onValidChange?: (valid: boolean) => void;
     parseAddress?: (addressLine: string) => Promise<IParsedAddress>;
-}) => react_jsx_runtime.JSX.Element;
+}) => react_jsx_runtime.JSX.Element | null;
 
 interface CartItem {
     planDesc: string;
@@ -154,10 +158,10 @@ type SharedLifePlanApplicationProps = {
     onPaymentError?: (error: unknown) => void;
     /**
      * Called on the payment step with the cart items and application data.
-     * Must return the checkout URL (e.g. from PayMongoService.createNewSalesCheckout).
+     * Must return the checkout URL. Defaults to the built-in PayMongoService (test account).
      */
     onCheckout?: (request: NewSalesCheckoutRequest) => Promise<string | undefined>;
-    /** Optional address parser used to fill the address form from the scanned ID. */
+    /** Address parser used to fill the address form from the scanned ID. Defaults to GeoApifyService.parseAddress. */
     parseAddress?: (addressLine: string) => Promise<IParsedAddress>;
 };
 declare const SharedLifePlanApplication: ({ title, description, onPaymentError, onCheckout, parseAddress, }: SharedLifePlanApplicationProps) => react_jsx_runtime.JSX.Element;
@@ -190,8 +194,8 @@ declare function useOcr(scanIdFn: ScanIdFn): {
 
 type GetStartedNotifyType = "info" | "error";
 type GetStartedProps = {
-    /** Host app's ID scanner, e.g. `OcrService.scanId`. The result is saved for form autofill. */
-    scanId: ScanIdFn;
+    /** ID scanner. Defaults to the built-in `OcrService.scanId`. The result is saved for form autofill. */
+    scanId?: ScanIdFn;
     /** Called on Skip / Continue in the Referral Agent dialog, e.g. `() => router.push("/lifeplan-application")`. */
     onContinue?: () => void;
     /** Shows a message to the user, e.g. `(type, msg) => toast[type](msg)`. Defaults to console. */
@@ -229,6 +233,81 @@ declare function DocumentUploadCard({ config, onStatusChange, onProcess, onError
     onError?: (message: string) => void;
 }): react_jsx_runtime.JSX.Element;
 
+declare class APIError extends Error {
+    status?: number | undefined;
+    constructor(message: string, status?: number);
+}
+declare const apiClient: axios.AxiosInstance;
+/** Sets the API base URL used by the shared services (OCR, address, PayMongo). */
+declare const configureApi: (options: {
+    baseUrl: string;
+}) => void;
+declare const api: {
+    get: <TResponse>(url: string, params?: Record<string, unknown>, config?: AxiosRequestConfig) => Promise<TResponse>;
+    post: <TResponse, TPayload = unknown>(url: string, payload?: TPayload, config?: AxiosRequestConfig) => Promise<TResponse>;
+    put: <TResponse, TPayload = unknown>(url: string, payload?: TPayload, config?: AxiosRequestConfig) => Promise<TResponse>;
+    delete: <TResponse>(url: string, config?: AxiosRequestConfig) => Promise<TResponse>;
+};
+
+type OcrDocType = "ID" | "LPA";
+type OcrSource = File | string;
+declare const OcrService: {
+    scan(docType: OcrDocType, source: OcrSource): Promise<unknown>;
+    scanId(source: OcrSource): Promise<IOcrValue>;
+    scanLpa(source: OcrSource): Promise<unknown>;
+};
+
+declare const GeoApifyService: {
+    parseAddress(text: string): Promise<IParsedAddress>;
+};
+
+/**
+ * PayMongoService
+ * ---------------
+ * Creates a PayMongo checkout through the C# API (eStoreV2API -> PayMongoAPIController)
+ * and returns the payment page link.
+ *
+ * C# endpoint:  POST /CheckOut
+ * C# expects:   { items: [{ planDesc, productCode, contractPrice, ipInstAmt, planTerm, quantity }] }
+ * C# returns:   { checkoutUrl: "https://checkout.paymongo.com/..." }
+ *
+ * Example:
+ *   const { checkoutUrl } = await PayMongoService.createCheckout([{ planDesc: "ST. ANNE", ipInstAmt: 1500, quantity: 1 }]);
+ *   window.location.href = checkoutUrl;
+ */
+interface ICheckoutItem {
+    planDesc: string;
+    ipInstAmt: number;
+    quantity: number;
+    planTerm?: string | number;
+    productCode?: string;
+    contractPrice?: number;
+}
+interface ICheckoutResult {
+    checkoutUrl?: string | undefined;
+}
+interface INewSalesCheckoutItem {
+    planDesc: string;
+    mode: string;
+    ipInstAmt: number;
+    quantity: number;
+    planTerm?: string | number;
+}
+interface INewSalesCheckoutRequest {
+    items: INewSalesCheckoutItem[];
+    application: ITransactionData;
+    accountNo?: string;
+    empCode?: string;
+}
+interface INewSalesCheckoutResult {
+    checkoutUrl?: string | undefined;
+    requestId?: string | undefined;
+}
+declare const PayMongoService: {
+    createCheckout(items: ICheckoutItem[]): Promise<ICheckoutResult>;
+    createNewSalesCheckout(request: INewSalesCheckoutRequest): Promise<INewSalesCheckoutResult>;
+};
+
 type QuickAction = {
     /** React Icons icon component */
     icon: IconType;
@@ -311,8 +390,27 @@ interface ReusableProfileProps {
 }
 declare function ReusableProfile({ user, colorMode: controlledColorMode, onColorModeChange, initialTwoFactorEnabled, initialQuickNavHrefs, availableNavOptions, maxQuickNavItems, enableLocalStorage, storageKey, onSaveAccount, onChangePassword, onSignOut, onTwoFactorChange, onToast, }: ReusableProfileProps): react_jsx_runtime.JSX.Element;
 
+declare const LIFE_PLAN_APPLICATION_KEY = "LifePlanApplication";
+/** Fired on `window` every time the saved application data changes. */
+declare const APPLICATION_DATA_CHANGE_EVENT = "lifeplan-application:change";
 declare const createEmptyApplicationData: () => IApplicationData;
+/** Reads the saved application data, or null if nothing is saved yet. */
+declare const loadApplicationData: (storageKey?: string) => IApplicationData | null;
+/** Replaces the whole saved application data. */
+declare const saveApplicationData: (data: IApplicationData, storageKey?: string) => void;
+/**
+ * Saves only the given sections and keeps the rest as-is,
+ * so one form step never wipes another step's data.
+ */
+declare const updateApplicationData: (patch: Partial<IApplicationData>, storageKey?: string) => IApplicationData;
+/** Removes the saved application data (e.g. after a successful payment). */
+declare const clearApplicationData: (storageKey?: string) => void;
+/** @deprecated Kept for older code. Data now lives in sessionStorage; use `loadApplicationData`. */
 declare const loadApplicationDataFromLocalStorage: (storageKey?: string) => IApplicationData | null;
+/** @deprecated Kept for older code. Data now lives in sessionStorage; use `saveApplicationData`. */
 declare const saveApplicationDataToLocalStorage: (data: IApplicationData, storageKey?: string) => void;
 
-export { Beneficiary, type BeneficiaryClass, BottomQuickActions, type CartItem, type DocumentStatus, type DocumentTypeConfig, DocumentUploadCard, GetStarted, type GetStartedNotifyType, type GetStartedProps, HealthDeclaration, type IAddress, type IApplicationData, type IBeneficiary, type IEmployment, type IHealthDeclaration, type IOcrValue, type IParsedAddress, type IPersonalInfo, type ITransactionData, LifePlanApplication1, LifePlanApplication2, LifePlanApplication3, LifePlanApplicationFormWrapper, LifePlanApplicationStepWrapper, type NavOptionDef, type NewSalesCheckoutItem, type NewSalesCheckoutRequest, NotifyInstall, OCR_STORAGE_KEY, type OcrSection, type ProfileUser, type ReusableProfileProps, type ScanIdFn, SharedLifePlanApplication, type SharedLifePlanApplicationProps, ReusableProfile as UserProfile, clearOcrResult, createEmptyApplicationData, loadApplicationDataFromLocalStorage, markOcrApplied, readOcrResult, saveApplicationDataToLocalStorage, saveOcrResult, useOcr };
+/** Returns the saved application data and re-renders whenever it changes. */
+declare function useApplicationData(storageKey?: string): IApplicationData | null;
+
+export { APIError, APPLICATION_DATA_CHANGE_EVENT, Beneficiary, type BeneficiaryClass, BottomQuickActions, type CartItem, type DocumentStatus, type DocumentTypeConfig, DocumentUploadCard, GeoApifyService, GetStarted, type GetStartedNotifyType, type GetStartedProps, HealthDeclaration, type IAddress, type IApplicationData, type IBeneficiary, type ICheckoutItem, type ICheckoutResult, type IEmployment, type IHealthDeclaration, type INewSalesCheckoutItem, type INewSalesCheckoutRequest, type INewSalesCheckoutResult, type IOcrValue, type IParsedAddress, type IPersonalInfo, type ITransactionData, LIFE_PLAN_APPLICATION_KEY, LifePlanApplication1, LifePlanApplication2, LifePlanApplication3, LifePlanApplicationFormWrapper, LifePlanApplicationStepWrapper, type NavOptionDef, type NewSalesCheckoutItem, type NewSalesCheckoutRequest, NotifyInstall, OCR_STORAGE_KEY, type OcrDocType, type OcrSection, OcrService, type OcrSource, PayMongoService, type ProfileUser, type ReusableProfileProps, type ScanIdFn, SharedLifePlanApplication, type SharedLifePlanApplicationProps, ReusableProfile as UserProfile, api, apiClient, clearApplicationData, clearOcrResult, configureApi, createEmptyApplicationData, loadApplicationData, loadApplicationDataFromLocalStorage, markOcrApplied, readOcrResult, saveApplicationData, saveApplicationDataToLocalStorage, saveOcrResult, updateApplicationData, useApplicationData, useOcr };

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React$1 from 'react';
+import * as axios from 'axios';
+import { AxiosRequestConfig } from 'axios';
 import { IconType } from 'react-icons';
 
 interface IPersonalInfo {
@@ -96,6 +98,8 @@ interface IParsedAddress {
 }
 
 interface LifePlanApplication2Props {
+    /** Saved address, shown when the user comes back to this form. */
+    initialData?: IAddress;
     onAddressUpdate?: (address: IAddress) => void;
     /**
      * Optional address parser from the host app (e.g. GeoApifyService.parseAddress).
@@ -103,7 +107,7 @@ interface LifePlanApplication2Props {
      */
     parseAddress?: (addressLine: string) => Promise<IParsedAddress>;
 }
-declare const LifePlanApplication2: ({ onAddressUpdate, parseAddress, }: LifePlanApplication2Props) => react_jsx_runtime.JSX.Element;
+declare const LifePlanApplication2: ({ initialData, onAddressUpdate, parseAddress, }: LifePlanApplication2Props) => react_jsx_runtime.JSX.Element;
 
 interface LifePlanApplication3Props {
     initialData?: IEmployment;
@@ -123,7 +127,7 @@ declare const LifePlanApplicationFormWrapper: ({ openSection, openSectionKey, on
     openSectionKey?: number;
     onValidChange?: (valid: boolean) => void;
     parseAddress?: (addressLine: string) => Promise<IParsedAddress>;
-}) => react_jsx_runtime.JSX.Element;
+}) => react_jsx_runtime.JSX.Element | null;
 
 interface CartItem {
     planDesc: string;
@@ -154,10 +158,10 @@ type SharedLifePlanApplicationProps = {
     onPaymentError?: (error: unknown) => void;
     /**
      * Called on the payment step with the cart items and application data.
-     * Must return the checkout URL (e.g. from PayMongoService.createNewSalesCheckout).
+     * Must return the checkout URL. Defaults to the built-in PayMongoService (test account).
      */
     onCheckout?: (request: NewSalesCheckoutRequest) => Promise<string | undefined>;
-    /** Optional address parser used to fill the address form from the scanned ID. */
+    /** Address parser used to fill the address form from the scanned ID. Defaults to GeoApifyService.parseAddress. */
     parseAddress?: (addressLine: string) => Promise<IParsedAddress>;
 };
 declare const SharedLifePlanApplication: ({ title, description, onPaymentError, onCheckout, parseAddress, }: SharedLifePlanApplicationProps) => react_jsx_runtime.JSX.Element;
@@ -190,8 +194,8 @@ declare function useOcr(scanIdFn: ScanIdFn): {
 
 type GetStartedNotifyType = "info" | "error";
 type GetStartedProps = {
-    /** Host app's ID scanner, e.g. `OcrService.scanId`. The result is saved for form autofill. */
-    scanId: ScanIdFn;
+    /** ID scanner. Defaults to the built-in `OcrService.scanId`. The result is saved for form autofill. */
+    scanId?: ScanIdFn;
     /** Called on Skip / Continue in the Referral Agent dialog, e.g. `() => router.push("/lifeplan-application")`. */
     onContinue?: () => void;
     /** Shows a message to the user, e.g. `(type, msg) => toast[type](msg)`. Defaults to console. */
@@ -229,6 +233,81 @@ declare function DocumentUploadCard({ config, onStatusChange, onProcess, onError
     onError?: (message: string) => void;
 }): react_jsx_runtime.JSX.Element;
 
+declare class APIError extends Error {
+    status?: number | undefined;
+    constructor(message: string, status?: number);
+}
+declare const apiClient: axios.AxiosInstance;
+/** Sets the API base URL used by the shared services (OCR, address, PayMongo). */
+declare const configureApi: (options: {
+    baseUrl: string;
+}) => void;
+declare const api: {
+    get: <TResponse>(url: string, params?: Record<string, unknown>, config?: AxiosRequestConfig) => Promise<TResponse>;
+    post: <TResponse, TPayload = unknown>(url: string, payload?: TPayload, config?: AxiosRequestConfig) => Promise<TResponse>;
+    put: <TResponse, TPayload = unknown>(url: string, payload?: TPayload, config?: AxiosRequestConfig) => Promise<TResponse>;
+    delete: <TResponse>(url: string, config?: AxiosRequestConfig) => Promise<TResponse>;
+};
+
+type OcrDocType = "ID" | "LPA";
+type OcrSource = File | string;
+declare const OcrService: {
+    scan(docType: OcrDocType, source: OcrSource): Promise<unknown>;
+    scanId(source: OcrSource): Promise<IOcrValue>;
+    scanLpa(source: OcrSource): Promise<unknown>;
+};
+
+declare const GeoApifyService: {
+    parseAddress(text: string): Promise<IParsedAddress>;
+};
+
+/**
+ * PayMongoService
+ * ---------------
+ * Creates a PayMongo checkout through the C# API (eStoreV2API -> PayMongoAPIController)
+ * and returns the payment page link.
+ *
+ * C# endpoint:  POST /CheckOut
+ * C# expects:   { items: [{ planDesc, productCode, contractPrice, ipInstAmt, planTerm, quantity }] }
+ * C# returns:   { checkoutUrl: "https://checkout.paymongo.com/..." }
+ *
+ * Example:
+ *   const { checkoutUrl } = await PayMongoService.createCheckout([{ planDesc: "ST. ANNE", ipInstAmt: 1500, quantity: 1 }]);
+ *   window.location.href = checkoutUrl;
+ */
+interface ICheckoutItem {
+    planDesc: string;
+    ipInstAmt: number;
+    quantity: number;
+    planTerm?: string | number;
+    productCode?: string;
+    contractPrice?: number;
+}
+interface ICheckoutResult {
+    checkoutUrl?: string | undefined;
+}
+interface INewSalesCheckoutItem {
+    planDesc: string;
+    mode: string;
+    ipInstAmt: number;
+    quantity: number;
+    planTerm?: string | number;
+}
+interface INewSalesCheckoutRequest {
+    items: INewSalesCheckoutItem[];
+    application: ITransactionData;
+    accountNo?: string;
+    empCode?: string;
+}
+interface INewSalesCheckoutResult {
+    checkoutUrl?: string | undefined;
+    requestId?: string | undefined;
+}
+declare const PayMongoService: {
+    createCheckout(items: ICheckoutItem[]): Promise<ICheckoutResult>;
+    createNewSalesCheckout(request: INewSalesCheckoutRequest): Promise<INewSalesCheckoutResult>;
+};
+
 type QuickAction = {
     /** React Icons icon component */
     icon: IconType;
@@ -311,8 +390,27 @@ interface ReusableProfileProps {
 }
 declare function ReusableProfile({ user, colorMode: controlledColorMode, onColorModeChange, initialTwoFactorEnabled, initialQuickNavHrefs, availableNavOptions, maxQuickNavItems, enableLocalStorage, storageKey, onSaveAccount, onChangePassword, onSignOut, onTwoFactorChange, onToast, }: ReusableProfileProps): react_jsx_runtime.JSX.Element;
 
+declare const LIFE_PLAN_APPLICATION_KEY = "LifePlanApplication";
+/** Fired on `window` every time the saved application data changes. */
+declare const APPLICATION_DATA_CHANGE_EVENT = "lifeplan-application:change";
 declare const createEmptyApplicationData: () => IApplicationData;
+/** Reads the saved application data, or null if nothing is saved yet. */
+declare const loadApplicationData: (storageKey?: string) => IApplicationData | null;
+/** Replaces the whole saved application data. */
+declare const saveApplicationData: (data: IApplicationData, storageKey?: string) => void;
+/**
+ * Saves only the given sections and keeps the rest as-is,
+ * so one form step never wipes another step's data.
+ */
+declare const updateApplicationData: (patch: Partial<IApplicationData>, storageKey?: string) => IApplicationData;
+/** Removes the saved application data (e.g. after a successful payment). */
+declare const clearApplicationData: (storageKey?: string) => void;
+/** @deprecated Kept for older code. Data now lives in sessionStorage; use `loadApplicationData`. */
 declare const loadApplicationDataFromLocalStorage: (storageKey?: string) => IApplicationData | null;
+/** @deprecated Kept for older code. Data now lives in sessionStorage; use `saveApplicationData`. */
 declare const saveApplicationDataToLocalStorage: (data: IApplicationData, storageKey?: string) => void;
 
-export { Beneficiary, type BeneficiaryClass, BottomQuickActions, type CartItem, type DocumentStatus, type DocumentTypeConfig, DocumentUploadCard, GetStarted, type GetStartedNotifyType, type GetStartedProps, HealthDeclaration, type IAddress, type IApplicationData, type IBeneficiary, type IEmployment, type IHealthDeclaration, type IOcrValue, type IParsedAddress, type IPersonalInfo, type ITransactionData, LifePlanApplication1, LifePlanApplication2, LifePlanApplication3, LifePlanApplicationFormWrapper, LifePlanApplicationStepWrapper, type NavOptionDef, type NewSalesCheckoutItem, type NewSalesCheckoutRequest, NotifyInstall, OCR_STORAGE_KEY, type OcrSection, type ProfileUser, type ReusableProfileProps, type ScanIdFn, SharedLifePlanApplication, type SharedLifePlanApplicationProps, ReusableProfile as UserProfile, clearOcrResult, createEmptyApplicationData, loadApplicationDataFromLocalStorage, markOcrApplied, readOcrResult, saveApplicationDataToLocalStorage, saveOcrResult, useOcr };
+/** Returns the saved application data and re-renders whenever it changes. */
+declare function useApplicationData(storageKey?: string): IApplicationData | null;
+
+export { APIError, APPLICATION_DATA_CHANGE_EVENT, Beneficiary, type BeneficiaryClass, BottomQuickActions, type CartItem, type DocumentStatus, type DocumentTypeConfig, DocumentUploadCard, GeoApifyService, GetStarted, type GetStartedNotifyType, type GetStartedProps, HealthDeclaration, type IAddress, type IApplicationData, type IBeneficiary, type ICheckoutItem, type ICheckoutResult, type IEmployment, type IHealthDeclaration, type INewSalesCheckoutItem, type INewSalesCheckoutRequest, type INewSalesCheckoutResult, type IOcrValue, type IParsedAddress, type IPersonalInfo, type ITransactionData, LIFE_PLAN_APPLICATION_KEY, LifePlanApplication1, LifePlanApplication2, LifePlanApplication3, LifePlanApplicationFormWrapper, LifePlanApplicationStepWrapper, type NavOptionDef, type NewSalesCheckoutItem, type NewSalesCheckoutRequest, NotifyInstall, OCR_STORAGE_KEY, type OcrDocType, type OcrSection, OcrService, type OcrSource, PayMongoService, type ProfileUser, type ReusableProfileProps, type ScanIdFn, SharedLifePlanApplication, type SharedLifePlanApplicationProps, ReusableProfile as UserProfile, api, apiClient, clearApplicationData, clearOcrResult, configureApi, createEmptyApplicationData, loadApplicationData, loadApplicationDataFromLocalStorage, markOcrApplied, readOcrResult, saveApplicationData, saveApplicationDataToLocalStorage, saveOcrResult, updateApplicationData, useApplicationData, useOcr };