@splpi/estore-shared-components 0.0.6 → 7.0.2

package/dist/index.d.mts

@@ -70,10 +70,40 @@ interface LifePlanApplication1Props {
 }
 declare const LifePlanApplication1: ({ initialData, onUpdate, }: LifePlanApplication1Props) => react_jsx_runtime.JSX.Element;
 
+interface IOcrValue {
+    firstName?: string;
+    middleName?: string;
+    lastName?: string;
+    birthDate?: string;
+    idType?: string;
+    idNumber?: string;
+    addressLine?: string;
+}
+/** Shape returned by the host app's address parser (e.g. GeoApifyService.parseAddress). */
+interface IParsedAddress {
+    lot: string;
+    street: string;
+    barangay: string;
+    district: string;
+    city: string;
+    province: string;
+    zipCode: string;
+    barangayCandidates: string[];
+    districtCandidates: string[];
+    cityCandidates: string[];
+    provinceCandidates: string[];
+    geoapifyUsed: boolean;
+}
+
 interface LifePlanApplication2Props {
     onAddressUpdate?: (address: IAddress) => void;
+    /**
+     * Optional address parser from the host app (e.g. GeoApifyService.parseAddress).
+     * When provided, the scanned ID address (OCR) is split into the form fields.
+     */
+    parseAddress?: (addressLine: string) => Promise<IParsedAddress>;
 }
-declare const LifePlanApplication2: ({ onAddressUpdate, }: LifePlanApplication2Props) => react_jsx_runtime.JSX.Element;
+declare const LifePlanApplication2: ({ onAddressUpdate, parseAddress, }: LifePlanApplication2Props) => react_jsx_runtime.JSX.Element;
 
 interface LifePlanApplication3Props {
     initialData?: IEmployment;
@@ -88,20 +118,58 @@ declare const Beneficiary: ({ onUpdate }: BeneficiaryProps) => react_jsx_runtime
 
 declare const HealthDeclaration: () => react_jsx_runtime.JSX.Element;
 
-declare const LifePlanApplicationFormWrapper: ({ openSection, openSectionKey, onValidChange, }: {
+declare const LifePlanApplicationFormWrapper: ({ openSection, openSectionKey, onValidChange, parseAddress, }: {
     openSection?: string;
     openSectionKey?: number;
     onValidChange?: (valid: boolean) => void;
+    parseAddress?: (addressLine: string) => Promise<IParsedAddress>;
 }) => react_jsx_runtime.JSX.Element;
 
-declare const LifePlanApplicationStepWrapper: () => react_jsx_runtime.JSX.Element;
+interface CartItem {
+    planDesc: string;
+    mode: string;
+    planTerm: string;
+    quantity: number;
+    price: number;
+    total: number;
+    contractPrice: number;
+    ipInstAmt?: number;
+    balance?: number;
+}
 
+type NewSalesCheckoutItem = {
+    planDesc: CartItem["planDesc"];
+    mode: CartItem["mode"];
+    ipInstAmt: number;
+    planTerm: CartItem["planTerm"];
+    quantity: number;
+};
+type NewSalesCheckoutRequest = {
+    items: NewSalesCheckoutItem[];
+    application: IApplicationData;
+};
 type SharedLifePlanApplicationProps = {
     title?: string;
     description?: string;
     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).
+     */
+    onCheckout?: (request: NewSalesCheckoutRequest) => Promise<string | undefined>;
+    /** Optional address parser used to fill the address form from the scanned ID. */
+    parseAddress?: (addressLine: string) => Promise<IParsedAddress>;
 };
-declare const SharedLifePlanApplication: ({ title, description, onPaymentError, }: SharedLifePlanApplicationProps) => react_jsx_runtime.JSX.Element;
+declare const SharedLifePlanApplication: ({ title, description, onPaymentError, onCheckout, parseAddress, }: SharedLifePlanApplicationProps) => react_jsx_runtime.JSX.Element;
+
+declare const LifePlanApplicationStepWrapper: (props: SharedLifePlanApplicationProps) => react_jsx_runtime.JSX.Element;
+
+declare const OCR_STORAGE_KEY = "ocrResult";
+type OcrSection = "personal" | "address";
+/** Returns the saved OCR result if it has not been applied to this section yet. */
+declare const readOcrResult: (section: OcrSection) => IOcrValue | null;
+/** Marks the OCR result as used for this section. Returns true the first time only. */
+declare const markOcrApplied: (section: OcrSection) => boolean;
 
 type QuickAction = {
     /** React Icons icon component */
@@ -185,20 +253,8 @@ 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;
 
-interface CartItem {
-    planDesc: string;
-    mode: string;
-    planTerm: string;
-    quantity: number;
-    price: number;
-    total: number;
-    contractPrice: number;
-    ipInstAmt?: number;
-    balance?: number;
-}
-
 declare const createEmptyApplicationData: () => IApplicationData;
 declare const loadApplicationDataFromLocalStorage: (storageKey?: string) => IApplicationData | null;
 declare const saveApplicationDataToLocalStorage: (data: IApplicationData, storageKey?: string) => void;
 
-export { Beneficiary, type BeneficiaryClass, BottomQuickActions, type CartItem, HealthDeclaration, type IAddress, type IApplicationData, type IBeneficiary, type IEmployment, type IHealthDeclaration, type IPersonalInfo, type ITransactionData, LifePlanApplication1, LifePlanApplication2, LifePlanApplication3, LifePlanApplicationFormWrapper, LifePlanApplicationStepWrapper, type NavOptionDef, NotifyInstall, type ProfileUser, type ReusableProfileProps, SharedLifePlanApplication, ReusableProfile as UserProfile, createEmptyApplicationData, loadApplicationDataFromLocalStorage, saveApplicationDataToLocalStorage };
+export { Beneficiary, type BeneficiaryClass, BottomQuickActions, type CartItem, 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, SharedLifePlanApplication, type SharedLifePlanApplicationProps, ReusableProfile as UserProfile, createEmptyApplicationData, loadApplicationDataFromLocalStorage, markOcrApplied, readOcrResult, saveApplicationDataToLocalStorage };

package/dist/index.d.ts

@@ -70,10 +70,40 @@ interface LifePlanApplication1Props {
 }
 declare const LifePlanApplication1: ({ initialData, onUpdate, }: LifePlanApplication1Props) => react_jsx_runtime.JSX.Element;
 
+interface IOcrValue {
+    firstName?: string;
+    middleName?: string;
+    lastName?: string;
+    birthDate?: string;
+    idType?: string;
+    idNumber?: string;
+    addressLine?: string;
+}
+/** Shape returned by the host app's address parser (e.g. GeoApifyService.parseAddress). */
+interface IParsedAddress {
+    lot: string;
+    street: string;
+    barangay: string;
+    district: string;
+    city: string;
+    province: string;
+    zipCode: string;
+    barangayCandidates: string[];
+    districtCandidates: string[];
+    cityCandidates: string[];
+    provinceCandidates: string[];
+    geoapifyUsed: boolean;
+}
+
 interface LifePlanApplication2Props {
     onAddressUpdate?: (address: IAddress) => void;
+    /**
+     * Optional address parser from the host app (e.g. GeoApifyService.parseAddress).
+     * When provided, the scanned ID address (OCR) is split into the form fields.
+     */
+    parseAddress?: (addressLine: string) => Promise<IParsedAddress>;
 }
-declare const LifePlanApplication2: ({ onAddressUpdate, }: LifePlanApplication2Props) => react_jsx_runtime.JSX.Element;
+declare const LifePlanApplication2: ({ onAddressUpdate, parseAddress, }: LifePlanApplication2Props) => react_jsx_runtime.JSX.Element;
 
 interface LifePlanApplication3Props {
     initialData?: IEmployment;
@@ -88,20 +118,58 @@ declare const Beneficiary: ({ onUpdate }: BeneficiaryProps) => react_jsx_runtime
 
 declare const HealthDeclaration: () => react_jsx_runtime.JSX.Element;
 
-declare const LifePlanApplicationFormWrapper: ({ openSection, openSectionKey, onValidChange, }: {
+declare const LifePlanApplicationFormWrapper: ({ openSection, openSectionKey, onValidChange, parseAddress, }: {
     openSection?: string;
     openSectionKey?: number;
     onValidChange?: (valid: boolean) => void;
+    parseAddress?: (addressLine: string) => Promise<IParsedAddress>;
 }) => react_jsx_runtime.JSX.Element;
 
-declare const LifePlanApplicationStepWrapper: () => react_jsx_runtime.JSX.Element;
+interface CartItem {
+    planDesc: string;
+    mode: string;
+    planTerm: string;
+    quantity: number;
+    price: number;
+    total: number;
+    contractPrice: number;
+    ipInstAmt?: number;
+    balance?: number;
+}
 
+type NewSalesCheckoutItem = {
+    planDesc: CartItem["planDesc"];
+    mode: CartItem["mode"];
+    ipInstAmt: number;
+    planTerm: CartItem["planTerm"];
+    quantity: number;
+};
+type NewSalesCheckoutRequest = {
+    items: NewSalesCheckoutItem[];
+    application: IApplicationData;
+};
 type SharedLifePlanApplicationProps = {
     title?: string;
     description?: string;
     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).
+     */
+    onCheckout?: (request: NewSalesCheckoutRequest) => Promise<string | undefined>;
+    /** Optional address parser used to fill the address form from the scanned ID. */
+    parseAddress?: (addressLine: string) => Promise<IParsedAddress>;
 };
-declare const SharedLifePlanApplication: ({ title, description, onPaymentError, }: SharedLifePlanApplicationProps) => react_jsx_runtime.JSX.Element;
+declare const SharedLifePlanApplication: ({ title, description, onPaymentError, onCheckout, parseAddress, }: SharedLifePlanApplicationProps) => react_jsx_runtime.JSX.Element;
+
+declare const LifePlanApplicationStepWrapper: (props: SharedLifePlanApplicationProps) => react_jsx_runtime.JSX.Element;
+
+declare const OCR_STORAGE_KEY = "ocrResult";
+type OcrSection = "personal" | "address";
+/** Returns the saved OCR result if it has not been applied to this section yet. */
+declare const readOcrResult: (section: OcrSection) => IOcrValue | null;
+/** Marks the OCR result as used for this section. Returns true the first time only. */
+declare const markOcrApplied: (section: OcrSection) => boolean;
 
 type QuickAction = {
     /** React Icons icon component */
@@ -185,20 +253,8 @@ 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;
 
-interface CartItem {
-    planDesc: string;
-    mode: string;
-    planTerm: string;
-    quantity: number;
-    price: number;
-    total: number;
-    contractPrice: number;
-    ipInstAmt?: number;
-    balance?: number;
-}
-
 declare const createEmptyApplicationData: () => IApplicationData;
 declare const loadApplicationDataFromLocalStorage: (storageKey?: string) => IApplicationData | null;
 declare const saveApplicationDataToLocalStorage: (data: IApplicationData, storageKey?: string) => void;
 
-export { Beneficiary, type BeneficiaryClass, BottomQuickActions, type CartItem, HealthDeclaration, type IAddress, type IApplicationData, type IBeneficiary, type IEmployment, type IHealthDeclaration, type IPersonalInfo, type ITransactionData, LifePlanApplication1, LifePlanApplication2, LifePlanApplication3, LifePlanApplicationFormWrapper, LifePlanApplicationStepWrapper, type NavOptionDef, NotifyInstall, type ProfileUser, type ReusableProfileProps, SharedLifePlanApplication, ReusableProfile as UserProfile, createEmptyApplicationData, loadApplicationDataFromLocalStorage, saveApplicationDataToLocalStorage };
+export { Beneficiary, type BeneficiaryClass, BottomQuickActions, type CartItem, 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, SharedLifePlanApplication, type SharedLifePlanApplicationProps, ReusableProfile as UserProfile, createEmptyApplicationData, loadApplicationDataFromLocalStorage, markOcrApplied, readOcrResult, saveApplicationDataToLocalStorage };