@sheerid/jslib 1.152.0 → 1.154.0

package/src/lib/installScript/iframe.d.ts

@@ -1,4 +1,4 @@
-import { Options, ViewModel } from "../types/types";
+import { Options, PostMessageAction, ViewModel } from "../types/types";
 declare type IframeOptions = {
     className: string;
     title: string;
@@ -11,13 +11,21 @@ declare class Iframe {
     verificationIframeUid: string;
     hasLoaded: boolean;
     onLoadEvents: Function[];
+    onCleanupEvents: (() => void)[];
     installType: string;
     constructor(containerElement: HTMLElement, url: string);
+    cleanup(): void;
     static createUniqueId(): string;
     static isValidHttpUrl(urlString: string): boolean;
     createIframe(options: IframeOptions): HTMLIFrameElement;
     addOnLoadEvent(callback: Function): void;
     onLoad(): void;
+    /**
+     * Using this to add parent window message listeners gives us
+     * - Event Cleanup for modals
+     * - verification of origin, verificationIframeUid, and message data structure
+     */
+    addWindowMessageListener(actionCb: (action: PostMessageAction) => void): void;
     addVerificationSizeUpdatesListener(): void;
     setViewModel(viewModel: Partial<ViewModel> | ViewModel): void;
     setOptions(options: Options): void;
@@ -25,3 +33,9 @@ declare class Iframe {
     init(): void;
 }
 export default Iframe;
+/**
+ * All post messages from inside our iframes and modals should use this function
+ * to post messages to the parent window. It strongly types the data and makes
+ * sure we're only listening to events that have the iframeUid
+ */
+export declare function postMessageFromIframe(action: PostMessageAction): void;

package/src/lib/types/runtimeTypes.d.ts

@@ -106,7 +106,10 @@ export declare enum SubSegmentEnum {
     SNAP_BENEFITS = "snapBenefits",
     OTHER_GOVERNMENT_ASSISTANCE = "otherGovernmentAssistance",
     CHILD_CARE_WORKER = "childCareWorker",
-    LIBRARIAN = "librarian"
+    LIBRARIAN = "librarian",
+    INTERIOR_DESIGNER = "interiorDesigner",
+    ARCHITECT = "architect",
+    GENERAL_CONTRACTOR = "generalContractor"
 }
 export declare const SubSegments: any;
 export declare const MilitaryStatusDefaultMessagesEnum: {

package/src/lib/types/types.d.ts

@@ -223,6 +223,17 @@ export declare type PostMessagesOptions = {
     origin: VerificationUrl;
     interval: number;
 };
+export declare type PostMessageAction = {
+    type: "updateHeight";
+    height: number;
+} | {
+    type: "focus";
+    focusOn: "firstElement" | "lastElement";
+};
+export declare type PostMessageData = {
+    verificationIframeUid: string;
+    action: PostMessageAction;
+};
 /**
  * @description URLs related to conversion endpoints.
  */
@@ -282,7 +293,7 @@ export declare const FIRST_RESPONDER_STATUS: readonly ["FIREFIGHTER", "EMT", "PO
 export declare type FirstResponderStatus = typeof FIRST_RESPONDER_STATUS[number];
 export declare const MEDICAL_PROFESSIONAL_STATUS: readonly ["NURSE", "DOCTOR", "DENTIST", "PHARMACIST", "OTHER_HEALTH_WORKER"];
 export declare type MedicalProfessionalStatus = typeof MEDICAL_PROFESSIONAL_STATUS[number];
-export declare const LICENSED_PROFESSIONAL_STATUS: readonly ["LICENSED_COSMETOLOGIST", "LICENSED_REAL_ESTATE_AGENT", "VETERINARIAN", "CHILD_CARE_WORKER", "LIBRARIAN"];
+export declare const LICENSED_PROFESSIONAL_STATUS: readonly ["LICENSED_COSMETOLOGIST", "LICENSED_REAL_ESTATE_AGENT", "VETERINARIAN", "CHILD_CARE_WORKER", "LIBRARIAN", "INTERIOR_DESIGNER", "ARCHITECT", "GENERAL_CONTRACTOR"];
 export declare type LicensedProfessionalStatus = typeof LICENSED_PROFESSIONAL_STATUS[number];
 export declare const RECENT_MOVER_STATUS: readonly ["HOME_BUYER", "OTHER_MOVER"];
 export declare type RecentMoverStatus = typeof RECENT_MOVER_STATUS[number];
@@ -1479,6 +1490,9 @@ export declare type DefaultMessages = {
     VETERINARIAN: string;
     CHILD_CARE_WORKER: string;
     LIBRARIAN: string;
+    INTERIOR_DESIGNER: string;
+    ARCHITECT: string;
+    GENERAL_CONTRACTOR: string;
     tryAgain: string;
     footerText: string;
     infoShared1: string;