@elliemae/pui-app-sdk 6.0.0-alpha.2 → 6.0.0-alpha.4

package/dist/types/lib/view/fields/text-box/index.d.ts

@@ -5,4 +5,29 @@ export type TextBoxProps<TFieldValues extends FieldValues = FieldValues, TName e
     rules?: Omit<RegisterOptions<TFieldValues, TName>, 'valueAsNumber' | 'valueAsDate' | 'setValueAs'>;
     [x: string]: any;
 };
+/**
+ * Text input field component with React Hook Form integration.
+ * Wraps the Dimsum TextBox component with form state management and validation.
+ * @template TFieldValues - Type of form field values
+ * @template TName - Field name type
+ * @param props - TextBox component props
+ * @param props.name - Field name for form registration
+ * @param props.defaultValue - Default value for the field
+ * @param props.rules - Validation rules (required, pattern, min, max, etc.)
+ * @param props.rest - Additional props passed to the underlying DSTextBox component
+ * @example
+ * ```tsx
+ * <Form onSubmit={handleSubmit}>
+ *   <TextBox
+ *     name="firstName"
+ *     label="First Name"
+ *     placeholder="Enter your first name"
+ *     rules={{
+ *       required: 'First name is required',
+ *       minLength: { value: 2, message: 'Minimum 2 characters' }
+ *     }}
+ *   />
+ * </Form>
+ * ```
+ */
 export declare const TextBox: ({ name, defaultValue, rules, ...rest }: TextBoxProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/lib/view/form/index.d.ts

@@ -8,4 +8,36 @@ export type FormProps<TFieldValues extends FieldValues, TContext extends object
 export type CustomFormProviderProps = FormProviderProps & {
     formProps: UseFormProps;
 };
+/**
+ * Form component with integrated React Hook Form state management and validation.
+ * Provides form context to all child form fields and handles submission.
+ * @template TFieldValues - Type of form field values
+ * @template TContext - Additional context type
+ * @param props - Form component props
+ * @param props.classname - CSS class name for the form element
+ * @param props.reactHookFormProps - React Hook Form configuration options (defaults to `{ mode: 'onBlur' }`)
+ * @param props.children - Form fields and other child components
+ * @param props.onSubmit - Form submission handler
+ * @example
+ * ```tsx
+ * import { Form, TextBox, FormSubmitButton } from '@elliemae/pui-app-sdk';
+ *
+ * function MyForm() {
+ *   const handleSubmit = (data) => {
+ *     console.log('Form data:', data);
+ *   };
+ *
+ *   return (
+ *     <Form onSubmit={handleSubmit}>
+ *       <TextBox
+ *         name="email"
+ *         label="Email"
+ *         rules={{ required: 'Email is required' }}
+ *       />
+ *       <FormSubmitButton>Submit</FormSubmitButton>
+ *     </Form>
+ *   );
+ * }
+ * ```
+ */
 export declare const Form: <TFieldValues extends FieldValues = FieldValues, TContext extends object = object>({ classname, reactHookFormProps, children, onSubmit, }: FormProps<TFieldValues, TContext>) => import("react/jsx-runtime").JSX.Element;

package/dist/types/lib/view/guest-microapp.d.ts

@@ -0,0 +1,35 @@
+import { OpenAppParams } from '@elliemae/pui-app-bridge';
+import { SSFAppOptions } from '../utils/micro-frontend/types.js';
+export type OnLoadCompleteFn = (instanceId: string) => void;
+export type OnUnloadCompleteFn = () => void;
+/**
+ * Parameters for the GuestMicroApp component.
+ */
+export type GuestMicroAppParams = OpenAppParams & {
+    /**
+     * Callback function to be called when the app is loaded.
+     */
+    onLoadComplete?: OnLoadCompleteFn;
+    /**
+     * Callback function to be called when the app is unloaded.
+     */
+    onUnloadComplete?: OnUnloadCompleteFn;
+    /**
+     * Container ID where the microapp will be rendered.
+     */
+    containerId?: string;
+    /**
+     * Options specific to SSF microapps.
+     */
+    ssfAppOptions?: SSFAppOptions<Record<string, string | number | boolean>>;
+    /**
+     * Disable the wait message overlay during microapp loading.
+     * @default false
+     */
+    disableWaitMessage?: boolean;
+};
+/**
+ * Component to load a guest microapp
+ * @param props - The props for the MicroApp component.
+ */
+export declare const GuestMicroApp: import("react").NamedExoticComponent<Omit<GuestMicroAppParams, "containerId">>;

package/dist/types/lib/view/loadable/index.d.ts

@@ -1,4 +1,26 @@
 import { SuspenseProps, ComponentType } from 'react';
+/**
+ * Creates a lazily-loaded React component for code splitting.
+ * Wraps the component in Suspense with a customizable fallback.
+ * @template T - Component type
+ * @param importFunc - Dynamic import function that returns the component
+ * @param fallback - React element to show while loading (defaults to WaitMessageLauncher)
+ * @returns Lazy-loaded component
+ * @example
+ * ```typescript
+ * // Basic usage
+ * const Dashboard = loadable(() => import('./Dashboard'));
+ *
+ * // Custom loading fallback
+ * const Settings = loadable(
+ *   () => import('./Settings'),
+ *   <div>Loading settings...</div>
+ * );
+ *
+ * // Use in routes
+ * <Route path="/dashboard" component={Dashboard} />
+ * ```
+ */
 export declare const loadable: <T extends ComponentType<any>>(importFunc: () => Promise<{
     default: T;
 }>, fallback?: SuspenseProps["fallback"]) => (props: any) => import("react/jsx-runtime.js").JSX.Element;

package/dist/types/lib/view/login/index.d.ts

@@ -2,7 +2,47 @@ interface LoginParams {
     clientId: string;
     scope: string;
     responseType: string;
+    instanceId?: number;
+    siteId?: number;
+    userId?: string;
+    disableRememberMe?: boolean;
+    useCompactIdpPage?: boolean;
+    isSSO?: boolean;
     children: React.ReactNode;
+    isConsumerUser: boolean;
 }
-export declare const Login: ({ clientId, scope, responseType, children, }: LoginParams) => import("react/jsx-runtime.js").JSX.Element | null;
+/**
+ * Renders the login flow for the application and manages user authorization
+ * state.
+ *
+ * This component triggers a login process using the provided parameters and,
+ * upon successful authorization, renders its children.
+ * @param clientId.clientId
+ * @param clientId - The client identifier for authentication.
+ * @param scope - The scope of authentication request.
+ * @param responseType - The type of response expected.
+ * @param instanceId - (optional) The instance identifier for the login context.
+ * @param siteId - (optional) The site identifier for the login context.
+ * @param userId - (optional) The identifier of the user attempting to log in.
+ * @param disableRememberMe - (optional) If true, disables the "Remember Me"
+ * option.
+ * @param useCompactIdpPage - (optional) Determines whether to use a compact or full IDP
+ * page.
+ * @param isSSO - (optional) Determines whether to use SSO or not.
+ * @param children - React elements to render upon successful authorization.
+ * @param isConsumerUser - (optional) Whether the user is a consumer user.
+ * @param clientId.scope
+ * @param clientId.responseType
+ * @param clientId.instanceId
+ * @param clientId.siteId
+ * @param clientId.userId
+ * @param clientId.disableRememberMe
+ * @param clientId.useCompactIdpPage
+ * @param clientId.isSSO
+ * @param clientId.children
+ * @param clientId.isConsumerUser
+ * @returns The children elements if the user is authorized; otherwise, returns
+ * null.
+ */
+export declare const Login: ({ clientId, scope, responseType, instanceId, siteId, userId, disableRememberMe, useCompactIdpPage, isSSO, children, isConsumerUser, }: LoginParams) => import("react/jsx-runtime.js").JSX.Element | null;
 export {};

package/dist/types/lib/view/login/tests/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/lib/view/micro-app/index.d.ts

@@ -1,2 +1,7 @@
 import { MicroAppProps } from './types.js';
+/**
+ * Component to render a guest microapp
+ * @deprecated This component is deprecated and will be removed in future versions.
+ * Use the `GuestMicroApp` component instead.
+ */
 export declare const MicroApp: import("react").NamedExoticComponent<MicroAppProps>;

package/dist/types/lib/view/micro-app/resources/script.d.ts

@@ -1,6 +1,6 @@
 import { MicroAppConfig } from '../../../utils/micro-frontend/types.js';
 export declare const APP_SCRIPT_ID_PREFIX = "emui-script-";
-export declare const addScriptToDOM: ({ name, hostUrl, documentEle }: MicroAppConfig, fileName: string, index: number) => Promise<string>;
+export declare const addScriptToDOM: ({ name, hostUrl, documentEle }: MicroAppConfig, fileName: string, index: number, isJsModule?: boolean) => Promise<string>;
 export declare const removeScriptFromDOM: (elementId?: string, documentEle?: Document) => Promise<void>;
 export declare const removeDynamicImportedScripts: (hostUrl: string, documentEle: HTMLDocument) => void;
 export declare const removePrefetchLinks: (hostUrl: string, documentEle: HTMLDocument) => void;

package/dist/types/lib/view/micro-iframe-app/index.d.ts

@@ -2,5 +2,10 @@ import { MicroIFrameAppProps } from './types.js';
 type Props = MicroIFrameAppProps & {
     entityId?: string;
 };
+/**
+ * Component to render a guest microapp in an iframe.
+ * @deprecated This component is deprecated and will be removed in future versions.
+ * Use the `GuestMicroApp` component instead.
+ */
 export declare const MicroIFrameApp: import("react").NamedExoticComponent<Props>;
 export {};

package/dist/types/lib/view/require-auth.d.ts

@@ -2,6 +2,47 @@ export interface RequireAuthProps {
     clientId?: string;
     scope?: string;
     responseType?: string;
+    instanceId?: number;
+    siteId?: number;
+    userId?: string;
+    disableRememberMe?: boolean;
+    useCompactIdpPage?: boolean;
+    isSSO?: boolean;
     children: React.ReactNode;
+    isConsumerUser?: boolean;
 }
-export declare const RequireAuth: ({ children, clientId, scope, responseType, }: RequireAuthProps) => import("react/jsx-runtime.js").JSX.Element;
+/**
+ * A React component that ensures authentication for its children.
+ *
+ * If the user is authorized, it renders the children within the AuthManager
+ * context. Otherwise, it renders the Login component to prompt for
+ * authentication, passing relevant props.
+ * @param children.children
+ * @param children - The child components to render, which require
+ *   authentication.
+ * @param clientId - The client identifier for authentication. Defaults to
+ *   `enums.CLIENT_ID`.
+ * @param scope - The scope of authentication. Defaults to `'loc'`.
+ * @param responseType - The response type for authentication. Defaults to
+ *   `'code'`.
+ * @param instanceId - Optional instance identifier.
+ * @param siteId - Optional site identifier.
+ * @param userId - Optional user identifier for authentication.
+ * @param disableRememberMe - Optional flag to disable the "Remember Me"
+ *   feature.
+ * @param useCompactIdpPage - Optional flag. Determines whether to use a compact or full
+ *   IDP page.
+ * @param isSSO - Optional flag. Determines whether to use SSO or not.
+ * @param isConsumerUser - Optional flag. Whether the user is a consumer user.
+ * @param children.clientId
+ * @param children.scope
+ * @param children.responseType
+ * @param children.instanceId
+ * @param children.siteId
+ * @param children.userId
+ * @param children.disableRememberMe
+ * @param children.useCompactIdpPage
+ * @param children.isSSO
+ * @param children.isConsumerUser
+ */
+export declare const RequireAuth: ({ children, clientId, scope, responseType, instanceId, siteId, userId, disableRememberMe, useCompactIdpPage, isSSO, isConsumerUser, }: RequireAuthProps) => import("react/jsx-runtime.js").JSX.Element;

package/dist/types/lib/view/tests/constants.d.ts

@@ -0,0 +1,12 @@
+export declare const LATEST_VERSION = "latest";
+export declare const RELEASE_VERSION = "23.1.0";
+export declare const LOAN_APP_ID = "loanapp";
+export declare const SSF_APP_ID = "ssfapp";
+export declare const TASK_APP_ID = "taskapp";
+export declare const FLIGHTS_APP_ID = "flights";
+export declare const HOTELS_APP_ID = "hotels";
+export declare const APP_CONFIG_JSON_URL = "/latest/app.config.json";
+export declare const LOAN_SAVED_EVENT = "loanSaved";
+export declare const PRE_COMMIT_EVENT = "preCommit";
+export declare const FRAME_CONTAINER_ID_PREFIX = "pui-iframe-container-";
+export declare const FRAME_APP_CONTAINER_ID_PREFIX = "pui-app-container-";

package/dist/types/lib/view/tests/flights/23.1/app.checksum1.d.ts

@@ -0,0 +1,7 @@
+declare const appId: "flights";
+declare const appName: "Flights App";
+declare function getWindow(): WindowProxy;
+declare let host: null;
+declare let parentHistory: null;
+declare let logger: null;
+declare const browserWindow: WindowProxy;

package/dist/types/lib/view/tests/flights/latest/app.checksum.d.ts

@@ -0,0 +1,7 @@
+declare const appId: "flights";
+declare const appName: "Flights App";
+declare function getWindow(): WindowProxy;
+declare let host: null;
+declare let parentHistory: null;
+declare let logger: null;
+declare const browserWindow: WindowProxy;

package/dist/types/lib/view/tests/guest-microapp.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/lib/view/tests/hotels/23.1/app.checksum.d.ts

@@ -0,0 +1,7 @@
+declare const appId: "hotels";
+declare const appName: "Hotels App";
+declare function getWindow(): WindowProxy;
+declare let host: null;
+declare let parentHistory: null;
+declare let logger: null;
+declare const browserWindow: WindowProxy;

package/dist/types/lib/view/tests/hotels/latest/app.checksum.d.ts

@@ -0,0 +1,7 @@
+declare const appId: "hotels";
+declare const appName: "Hotels App";
+declare function getWindow(): WindowProxy;
+declare let host: null;
+declare let parentHistory: null;
+declare let logger: null;
+declare const browserWindow: WindowProxy;

package/dist/types/lib/view/tests/loan/latest/index.d.ts

@@ -0,0 +1,11 @@
+declare const appId: "loanapp";
+declare const appName: "Loan App";
+declare const appElementId: "pui-app-container-flights";
+declare const pipelinePath: "/pipeline";
+declare const pipelineLinkText: "Pipeline";
+declare function getWindow(): Window<Partial<import("@elliemae/pui-scripting-object").ScriptingObjectTypes>, import("@elliemae/pui-scripting-object").Events> & typeof globalThis;
+declare let host: null;
+declare let parentHistory: null;
+declare let logger: null;
+declare const browserWindow: WindowProxy;
+declare function setFrameSize(): void;

package/dist/types/lib/view/tests/micro-iframe-app.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/lib/view/tests/require-auth.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/lib/view/tests/scriptingObjects/appraisalServiceModule.d.ts

@@ -0,0 +1,36 @@
+import { IModule, Listener, Events, LogLevels, LogMessage } from '@elliemae/pui-scripting-object';
+import { ScriptingObject, Event } from '@elliemae/microfe-common';
+export type AppraisalServiceEvents = {
+    'appraisalservice.onprecommit': Listener<AppraisalService, {
+        loanId: string;
+    }, Record<string, unknown>, boolean>;
+    'appraisalservice.onsaved': Listener<AppraisalService, {
+        loanId: string;
+    }, Record<string, unknown>, void>;
+};
+export declare class AppraisalService extends ScriptingObject implements IModule {
+    #private;
+    Close: Event<Events>;
+    Unloading: Event<Events>;
+    onPreCommit: Event<AppraisalServiceEvents>;
+    onSaved: Event<AppraisalServiceEvents>;
+    constructor({ loanId, creditScore, }: {
+        loanId: string;
+        creditScore: number;
+    });
+    getCapabilities: () => Promise<{
+        isAdmin: boolean;
+        los: string;
+    }>;
+    getParameters: () => Promise<{
+        moduleId: string;
+        loanId: string;
+        creditScore: number;
+    }>;
+    setCreditScore: (creditScore: number) => Promise<void>;
+    saveLoan: () => Promise<void>;
+    commit: () => Promise<unknown>;
+    delete: () => never;
+    log: (message: string | LogMessage, level: keyof typeof LogLevels) => Promise<void>;
+    unload: () => Promise<void>;
+}

package/dist/types/lib/view/tests/scriptingObjects/constant.d.ts

@@ -0,0 +1 @@
+export declare const UNLOADING_EVENT_NAME = "Unloading";

package/dist/types/lib/view/tests/scriptingObjects/global.d.ts

@@ -0,0 +1,9 @@
+import { Events, IGlobal } from '@elliemae/pui-scripting-object';
+import { ScriptingObject, Event } from '@elliemae/microfe-common';
+export declare class Global extends ScriptingObject implements IGlobal {
+    #private;
+    constructor();
+    readonly Change: Event<Events>;
+    set: (key: string, value: string) => Promise<void>;
+    get: (key: string) => Promise<string>;
+}

package/dist/types/lib/view/tests/scriptingObjects/loan.d.ts

@@ -0,0 +1,32 @@
+import { ILoan, Events, LoanObject, ActionResponse, LoanLevelActions, LoanCollection, LoanCollectionObject, ApplicationInfo, FieldOptions, FieldOptionsParam, CurrentApplicationOptions, EditModeOptions } from '@elliemae/pui-scripting-object';
+import { ScriptingObject, Event, CAppBridge } from '@elliemae/pui-app-bridge';
+export declare class Loan extends ScriptingObject implements ILoan {
+    #private;
+    constructor(appBridge: CAppBridge);
+    readonly ApplicationSelected: Event<Events>;
+    readonly Close: Event<Events>;
+    readonly Change: Event<Events>;
+    readonly Committed: Event<Events>;
+    readonly EditModeChange: Event<Events>;
+    readonly FieldChangeSync: Event<Events>;
+    readonly MilestoneCompleted: Event<Events>;
+    readonly Open: Event<Events>;
+    readonly PreCommit: Event<Events>;
+    readonly PreMilestoneComplete: Event<Events>;
+    readonly Sync: Event<Events>;
+    all: () => Promise<LoanObject>;
+    applyLock: (fieldId: string, lock: boolean) => Promise<void>;
+    calculate: () => Promise<LoanObject>;
+    commit: () => Promise<string>;
+    execAction: (type: LoanLevelActions, params?: Record<string, unknown>) => Promise<ActionResponse>;
+    getCollection: (name: LoanCollection) => Promise<LoanCollectionObject>;
+    getCurrentApplication: () => Promise<ApplicationInfo>;
+    getField: (id: string) => Promise<string>;
+    getFieldOptions: (param: FieldOptionsParam) => Promise<Record<string, FieldOptions[]>>;
+    getFields: (ids: string[]) => Promise<Record<string, string>>;
+    isReadOnly: () => Promise<boolean>;
+    merge: () => Promise<void>;
+    setCurrentApplication: (options: CurrentApplicationOptions) => Promise<void>;
+    setEditMode: (options: EditModeOptions) => Promise<void>;
+    setFields: (fields: Record<string, string>) => Promise<void>;
+}

package/dist/types/lib/view/tests/server.d.ts

@@ -0,0 +1 @@
+export declare const initServer: () => import("msw/lib/glossary-2792c6da.js").K;

package/dist/types/lib/view/tests/serverHandlers.d.ts

@@ -0,0 +1,5 @@
+import { RestHandler, DefaultBodyType, MockedRequest } from 'msw';
+type Handlers = Array<RestHandler<MockedRequest<DefaultBodyType>>>;
+export declare const getServerHandlers: () => Handlers;
+export declare const serverHandlers: RestHandler<MockedRequest<DefaultBodyType>>[];
+export {};

package/dist/types/lib/view/tests/ssfapp/latest/index.d.ts

@@ -0,0 +1,2 @@
+declare const appId: "ssfapp";
+declare const output: HTMLElement | null;

package/dist/types/lib/view/tests/task/latest/index.d.ts

@@ -0,0 +1,10 @@
+declare const appId: "taskapp";
+declare const appName: "Task App";
+declare const appElementId: "pui-app-container-flights";
+declare const pipelinePath: "/pipeline";
+declare const pipelineLinkText: "Pipeline";
+declare function getWindow(): WindowProxy;
+declare let host: null;
+declare let parentHistory: null;
+declare let logger: null;
+declare const browserWindow: WindowProxy;

package/dist/types/lib/view/tests/task/latest/index.dev.d.ts

@@ -0,0 +1,10 @@
+declare const appId: "taskapp";
+declare const appName: "Task App Dev";
+declare const appElementId: "pui-app-container-flights";
+declare const pipelinePath: "/pipeline";
+declare const pipelineLinkText: "Pipeline";
+declare function getWindow(): WindowProxy;
+declare let host: null;
+declare let parentHistory: null;
+declare let logger: null;
+declare const browserWindow: WindowProxy;

package/dist/types/lib/view/tests/travelhub/23.1/app.checksum.d.ts

@@ -0,0 +1,7 @@
+declare const appId: "travelhub";
+declare const appName: "Travel Hub";
+declare function getWindow(): WindowProxy;
+declare const browserWindow: WindowProxy;
+declare const mainElement: HTMLElement;
+declare const pageHeaderEle: HTMLHeadingElement;
+declare const versionEle: HTMLParagraphElement;

package/dist/types/lib/view/tests/travelhub/23.1/landing.checksum1.d.ts

@@ -0,0 +1,2 @@
+declare const mainElement: HTMLElement | null;
+declare const contentEle: HTMLParagraphElement;

package/dist/types/lib/view/tests/utils.d.ts

@@ -0,0 +1,7 @@
+import { rest } from 'msw';
+export type Params = Parameters<Parameters<typeof rest.get>[1]>;
+export declare const getMajorMinorVersion: (version: string) => string;
+export declare const sendJS: (res: Params[1], ctx: Params[2], filePath: string) => Promise<import("msw").MockedResponse<import("msw").DefaultBodyType>>;
+export declare const sendJSText: (res: Params[1], ctx: Params[2], fileContent: string) => Promise<import("msw").MockedResponse<import("msw").DefaultBodyType>>;
+export declare const releaseJSThread: () => Promise<unknown>;
+export declare const logger: import("@elliemae/pui-diagnostics").Logger;