@splpi/estore-shared-components 7.0.1 → 7.0.3

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,116 @@ 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;
+/** Saves a fresh OCR result (clears any "applied" flags from a previous scan). */
+declare const saveOcrResult: (value: IOcrValue) => void;
+/** Removes the saved OCR result. */
+declare const clearOcrResult: () => void;
+
+/** The host app's ID scanner, e.g. `OcrService.scanId`. */
+type ScanIdFn = (file: File) => Promise<IOcrValue>;
+/**
+ * Wraps the host app's ID scanner and saves the result so the
+ * Life Plan Application form (Step 1 and Step 2) can autofill from it.
+ */
+declare function useOcr(scanIdFn: ScanIdFn): {
+    data: IOcrValue | null;
+    loading: boolean;
+    error: string | null;
+    scanId: (file: File) => Promise<IOcrValue>;
+};
+
+type GetStartedNotifyType = "info" | "error";
+type GetStartedProps = {
+    /** Host app's ID scanner, e.g. `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. */
+    notify?: (type: GetStartedNotifyType, message: string) => void;
+};
+declare const GetStarted: ({ scanId: scanIdFn, onContinue, notify, }: GetStartedProps) => react_jsx_runtime.JSX.Element;
+
+interface DocumentTypeConfig {
+    /** Unique id for this document slot. */
+    id: string;
+    /** Human-readable label shown in the card header. */
+    label: string;
+    /** Optional supporting description under the label. */
+    description?: string;
+    /** Comma-separated accept string, e.g. "image/png,image/jpeg,.pdf". */
+    accept: string;
+    /** Maximum allowed file size in megabytes. */
+    maxSizeMB: number;
+    /** Whether the document is required for submission. */
+    required?: boolean;
+    /** Short hint shown inside the dropzone. */
+    hint?: string;
+    /** Which AI processor handles this doc — affects completed-state copy. */
+    processor?: "signature" | "extraction" | string;
+    /** Icon component (from react-icons) rendered in the header. */
+    icon: React$1.ElementType;
+}
+type DocumentStatus = "idle" | "uploading" | "processing" | "completed" | "failed";
+declare function DocumentUploadCard({ config, onStatusChange, onProcess, onError, }: {
+    config: DocumentTypeConfig;
+    /** Tells the parent when this slot's upload status changes. */
+    onStatusChange?: (status: DocumentStatus) => void;
+    onProcess?: (file: File) => Promise<unknown>;
+    /** Shows an error message (e.g. the host app's toast). Defaults to console.error. */
+    onError?: (message: string) => void;
+}): react_jsx_runtime.JSX.Element;
 
 type QuickAction = {
     /** React Icons icon component */
@@ -185,20 +311,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, 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 };

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,116 @@ 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;
+/** Saves a fresh OCR result (clears any "applied" flags from a previous scan). */
+declare const saveOcrResult: (value: IOcrValue) => void;
+/** Removes the saved OCR result. */
+declare const clearOcrResult: () => void;
+
+/** The host app's ID scanner, e.g. `OcrService.scanId`. */
+type ScanIdFn = (file: File) => Promise<IOcrValue>;
+/**
+ * Wraps the host app's ID scanner and saves the result so the
+ * Life Plan Application form (Step 1 and Step 2) can autofill from it.
+ */
+declare function useOcr(scanIdFn: ScanIdFn): {
+    data: IOcrValue | null;
+    loading: boolean;
+    error: string | null;
+    scanId: (file: File) => Promise<IOcrValue>;
+};
+
+type GetStartedNotifyType = "info" | "error";
+type GetStartedProps = {
+    /** Host app's ID scanner, e.g. `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. */
+    notify?: (type: GetStartedNotifyType, message: string) => void;
+};
+declare const GetStarted: ({ scanId: scanIdFn, onContinue, notify, }: GetStartedProps) => react_jsx_runtime.JSX.Element;
+
+interface DocumentTypeConfig {
+    /** Unique id for this document slot. */
+    id: string;
+    /** Human-readable label shown in the card header. */
+    label: string;
+    /** Optional supporting description under the label. */
+    description?: string;
+    /** Comma-separated accept string, e.g. "image/png,image/jpeg,.pdf". */
+    accept: string;
+    /** Maximum allowed file size in megabytes. */
+    maxSizeMB: number;
+    /** Whether the document is required for submission. */
+    required?: boolean;
+    /** Short hint shown inside the dropzone. */
+    hint?: string;
+    /** Which AI processor handles this doc — affects completed-state copy. */
+    processor?: "signature" | "extraction" | string;
+    /** Icon component (from react-icons) rendered in the header. */
+    icon: React$1.ElementType;
+}
+type DocumentStatus = "idle" | "uploading" | "processing" | "completed" | "failed";
+declare function DocumentUploadCard({ config, onStatusChange, onProcess, onError, }: {
+    config: DocumentTypeConfig;
+    /** Tells the parent when this slot's upload status changes. */
+    onStatusChange?: (status: DocumentStatus) => void;
+    onProcess?: (file: File) => Promise<unknown>;
+    /** Shows an error message (e.g. the host app's toast). Defaults to console.error. */
+    onError?: (message: string) => void;
+}): react_jsx_runtime.JSX.Element;
 
 type QuickAction = {
     /** React Icons icon component */
@@ -185,20 +311,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, 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 };