@splpi/estore-shared-components 7.0.2 → 7.0.4

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 {
@@ -154,10 +156,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;
@@ -170,6 +172,139 @@ type OcrSection = "personal" | "address";
 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 = {
+    /** 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. */
+    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;
+
+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 */
@@ -257,4 +392,4 @@ 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 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 };
+export { APIError, 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, 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, clearOcrResult, configureApi, createEmptyApplicationData, loadApplicationDataFromLocalStorage, markOcrApplied, readOcrResult, saveApplicationDataToLocalStorage, saveOcrResult, 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 {
@@ -154,10 +156,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;
@@ -170,6 +172,139 @@ type OcrSection = "personal" | "address";
 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 = {
+    /** 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. */
+    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;
+
+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 */
@@ -257,4 +392,4 @@ 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 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 };
+export { APIError, 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, 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, clearOcrResult, configureApi, createEmptyApplicationData, loadApplicationDataFromLocalStorage, markOcrApplied, readOcrResult, saveApplicationDataToLocalStorage, saveOcrResult, useOcr };