@jobber/components-native 0.88.0 → 0.88.1-JOB-139048-04134dd.0

package/dist/types/src/ContentOverlay/ContentOverlay.d.ts

@@ -1,5 +1,5 @@
 import React from "react";
-import { Modalize } from "react-native-modalize";
+import type { Modalize } from "react-native-modalize";
 import type { ContentOverlayProps } from "./types";
 export declare const ContentOverlay: React.ForwardRefExoticComponent<ContentOverlayProps & React.RefAttributes<{
     open?: Modalize["open"];

package/dist/types/src/ContentOverlay/UNSAFE_WrappedModalize.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import type { IHandles } from "react-native-modalize/lib/options";
+export declare const UNSAFE_WrappedModalize: React.ForwardRefExoticComponent<Omit<import("react-native-modalize/lib/options").IProps<any> & React.RefAttributes<string | number | boolean | {} | React.ReactPortal | React.ReactElement<any, string | ((props: any) => React.ReactElement<any, any> | null) | (new (props: any) => React.Component<any, any, any>)> | React.ReactNodeArray | undefined>, "ref"> & React.RefAttributes<IHandles>>;

package/dist/types/src/ContentOverlay/index.d.ts

@@ -1,2 +1,3 @@
 export { ContentOverlay } from "./ContentOverlay";
+export { UNSAFE_WrappedModalize } from "./UNSAFE_WrappedModalize";
 export type { ContentOverlayRef, ModalBackgroundColor } from "./types";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jobber/components-native",
-  "version": "0.88.0",
+  "version": "0.88.1-JOB-139048-04134dd.0+04134dd81",
   "license": "MIT",
   "description": "React Native implementation of Atlantis",
   "repository": {
@@ -94,5 +94,5 @@
     "react-native-safe-area-context": "^5.4.0",
     "react-native-svg": ">=12.0.0"
   },
-  "gitHead": "a7bcbd7560c4e86f8db10dfd71b2e3ce5a4f8717"
+  "gitHead": "04134dd81a80801cb9749c94d92f80b0e1d7c7dc"
 }

package/src/ContentOverlay/ContentOverlay.test.tsx

@@ -4,7 +4,7 @@ import { AccessibilityInfo, View } from "react-native";
 import { Host } from "react-native-portalize";
 import type { ReactTestInstance } from "react-test-renderer";
 import { act } from "react-test-renderer";
-import type { ContentOverlayRef, ModalBackgroundColor } from "./ContentOverlay";
+import type { ContentOverlayRef, ModalBackgroundColor } from "./types";
 import { ContentOverlay } from "./ContentOverlay";
 import { tokens } from "../utils/design";
 import { Button } from "../Button";
@@ -106,23 +106,30 @@ function renderContentOverlay(
   return renderResult;
 }
 
-function renderAndOpenContentOverlay(defaultOptions = getDefaultOptions()) {
+async function renderAndOpenContentOverlay(
+  defaultOptions = getDefaultOptions(),
+) {
   const rendered = renderContentOverlay(defaultOptions);
 
   act(() => {
     fireEvent.press(rendered.getByLabelText(defaultOptions.buttonLabel));
   });
 
+  // Wait for the modal to open asynchronously (due to requestAnimationFrame)
+  await waitFor(() => {
+    expect(rendered.getByTestId("ATL-Overlay-Header")).toBeDefined();
+  });
+
   return rendered;
 }
 
 describe("when open is called on the content overlay ref", () => {
-  it("should open the content overlay, exposing the content to the user", () => {
+  it("should open the content overlay, exposing the content to the user", async () => {
     const options: testRendererOptions = {
       ...getDefaultOptions(),
       text: "I am text within the content overlay",
     };
-    const contentOverlayScreen = renderAndOpenContentOverlay(options);
+    const contentOverlayScreen = await renderAndOpenContentOverlay(options);
 
     expect(contentOverlayScreen.getByText(options.text)).toBeDefined();
   });
@@ -135,7 +142,7 @@ describe("when the close button is clicked on an open content overlay", () => {
       text: "I am text within the content overlay",
       showDismiss: true,
     };
-    const contentOverlayScreen = renderAndOpenContentOverlay(options);
+    const contentOverlayScreen = await renderAndOpenContentOverlay(options);
 
     act(() => {
       fireEvent.press(
@@ -156,7 +163,7 @@ describe("when the close button is clicked on an open content overlay with a def
       onCloseCallback: jest.fn(),
       showDismiss: true,
     };
-    const contentOverlayScreen = renderAndOpenContentOverlay(options);
+    const contentOverlayScreen = await renderAndOpenContentOverlay(options);
 
     act(() => {
       fireEvent.press(
@@ -191,7 +198,7 @@ describe("when the content overlay is created with a defined onOpen prop", () =>
         ...getDefaultOptions(),
         onOpenCallback: jest.fn(),
       };
-      renderAndOpenContentOverlay(options);
+      await renderAndOpenContentOverlay(options);
 
       await waitFor(() => {
         expect(options.onOpenCallback).toHaveBeenCalled();
@@ -201,25 +208,25 @@ describe("when the content overlay is created with a defined onOpen prop", () =>
 });
 
 describe("when title prop passed to content overlay", () => {
-  it("should set the header title", () => {
+  it("should set the header title", async () => {
     const options: testRendererOptions = {
       ...getDefaultOptions(),
       title: "Awesome Title",
     };
-    const contentOverlayScreen = renderAndOpenContentOverlay(options);
+    const contentOverlayScreen = await renderAndOpenContentOverlay(options);
 
     expect(contentOverlayScreen.getByText(options.title)).toBeDefined();
   });
 });
 
 describe("when accessibilityLabel prop passed to content overlay", () => {
-  it("should set the header accessibilityLabel", () => {
+  it("should set the header accessibilityLabel", async () => {
     const options: testRendererOptions = {
       ...getDefaultOptions(),
       a11yLabel: "Awesome a11y Label",
       showDismiss: true,
     };
-    const contentOverlayScreen = renderAndOpenContentOverlay(options);
+    const contentOverlayScreen = await renderAndOpenContentOverlay(options);
 
     expect(
       contentOverlayScreen.getByLabelText(options.a11yLabel || "ohno"),
@@ -228,13 +235,13 @@ describe("when accessibilityLabel prop passed to content overlay", () => {
 });
 
 describe("when accessibilityLabel prop NOT passed to content overlay", () => {
-  it("should use default accessibilityLabel", () => {
+  it("should use default accessibilityLabel", async () => {
     const options: testRendererOptions = {
       ...getDefaultOptions(),
       title: "Awesome Title",
       showDismiss: true,
     };
-    const contentOverlayScreen = renderAndOpenContentOverlay(options);
+    const contentOverlayScreen = await renderAndOpenContentOverlay(options);
 
     expect(
       contentOverlayScreen.getAllByLabelText(`Close ${options.title} modal`),
@@ -251,7 +258,7 @@ describe("when there is a screen reader enabled", () => {
     const options: testRendererOptions = {
       ...getDefaultOptions(),
     };
-    const contentOverlayScreen = renderAndOpenContentOverlay(options);
+    const contentOverlayScreen = await renderAndOpenContentOverlay(options);
 
     expect(
       await contentOverlayScreen.findByTestId("ATL-Overlay-CloseButton"),
@@ -260,12 +267,12 @@ describe("when there is a screen reader enabled", () => {
 });
 
 describe("when fullScreen is set to true", () => {
-  it("should show the dismiss button", () => {
+  it("should show the dismiss button", async () => {
     const options: testRendererOptions = {
       ...getDefaultOptions(),
       fullScreen: true,
     };
-    const contentOverlayScreen = renderAndOpenContentOverlay(options);
+    const contentOverlayScreen = await renderAndOpenContentOverlay(options);
     expect(
       contentOverlayScreen.getByTestId("ATL-Overlay-CloseButton"),
     ).toBeDefined();
@@ -273,12 +280,12 @@ describe("when fullScreen is set to true", () => {
 });
 
 describe("when showDismiss is set to true", () => {
-  it("should show the dismiss button", () => {
+  it("should show the dismiss button", async () => {
     const options: testRendererOptions = {
       ...getDefaultOptions(),
       showDismiss: true,
     };
-    const contentOverlayScreen = renderAndOpenContentOverlay(options);
+    const contentOverlayScreen = await renderAndOpenContentOverlay(options);
     expect(
       contentOverlayScreen.getByTestId("ATL-Overlay-CloseButton"),
     ).toBeDefined();
@@ -292,7 +299,7 @@ describe("when the close button is clicked on an open content overlay with a def
       onBeforeExitCallback: jest.fn(),
       showDismiss: true,
     };
-    const contentOverlayScreen = renderAndOpenContentOverlay(options);
+    const contentOverlayScreen = await renderAndOpenContentOverlay(options);
 
     act(() => {
       fireEvent.press(
@@ -308,11 +315,11 @@ describe("when the close button is clicked on an open content overlay with a def
 
 describe("modalBackgroundColor prop", () => {
   describe("when using the default surface value", () => {
-    it("renders the component with the color-surface color", () => {
+    it("renders the component with the color-surface color", async () => {
       const options: testRendererOptions = {
         ...getDefaultOptions(),
       };
-      const contentOverlayScreen = renderAndOpenContentOverlay(options);
+      const contentOverlayScreen = await renderAndOpenContentOverlay(options);
       const OverlayHeader = contentOverlayScreen.getByTestId(
         "ATL-Overlay-Header",
       ).children[0] as ReactTestInstance;
@@ -337,12 +344,12 @@ describe("modalBackgroundColor prop", () => {
   });
 
   describe("when set to background", () => {
-    it("changes the backround color of the modal to color-surface--background", () => {
+    it("changes the backround color of the modal to color-surface--background", async () => {
       const options: testRendererOptions = {
         ...getDefaultOptions(),
         modalBackgroundColor: "background",
       };
-      const contentOverlayScreen = renderAndOpenContentOverlay(options);
+      const contentOverlayScreen = await renderAndOpenContentOverlay(options);
       const OverlayHeader = contentOverlayScreen.getByTestId(
         "ATL-Overlay-Header",
       ).children[0] as ReactTestInstance;

package/src/ContentOverlay/ContentOverlay.tsx

@@ -7,7 +7,7 @@ import React, {
   useRef,
   useState,
 } from "react";
-import { Modalize } from "react-native-modalize";
+import type { Modalize } from "react-native-modalize";
 import { useSafeAreaInsets } from "react-native-safe-area-context";
 import type { NativeScrollEvent, NativeSyntheticEvent } from "react-native";
 import {
@@ -26,6 +26,7 @@ import type {
   ContentOverlayRef,
   ModalBackgroundColor,
 } from "./types";
+import { UNSAFE_WrappedModalize } from "./UNSAFE_WrappedModalize";
 import { useIsScreenReaderEnabled } from "../hooks";
 import { IconButton } from "../IconButton";
 import { Heading } from "../Heading";
@@ -153,7 +154,7 @@ function ContentOverlayInternal(
   return (
     <>
       {headerHeightKnown && childrenHeightKnown && (
-        <Modalize
+        <UNSAFE_WrappedModalize
           ref={callbackInternalRef}
           overlayStyle={styles.overlay}
           handleStyle={styles.handle}
@@ -196,7 +197,7 @@ function ContentOverlayInternal(
         >
           {Platform.OS === "android" ? renderedHeader : undefined}
           {renderedChildren}
-        </Modalize>
+        </UNSAFE_WrappedModalize>
       )}
       {!childrenHeightKnown && (
         <View style={[styles.hiddenContent, modalStyle]}>

package/src/ContentOverlay/UNSAFE_WrappedModalize.tsx

@@ -0,0 +1,45 @@
+import React, {
+  forwardRef,
+  useImperativeHandle,
+  useRef,
+  useState,
+} from "react";
+import { Modalize } from "react-native-modalize";
+import type { IHandles } from "react-native-modalize/lib/options";
+
+type Props = React.ComponentProps<typeof Modalize>;
+
+// DON'T USE THIS COMPONENT DIRECTLY.
+// It is exposed only so that the deprecated ContentOverlay component can use this along with the
+// newer one contained in this lib.
+// This is a temporary solution for new architecture. JOB-137549 plans to replace modalize entirely.
+export const UNSAFE_WrappedModalize = forwardRef<IHandles, Props>(
+  (props, ref) => {
+    const innerRef = useRef<IHandles | null>(null);
+    const [openRenderId, setOpenRenderId] = useState(0);
+
+    useImperativeHandle(
+      ref,
+      () => ({
+        open(dest) {
+          setOpenRenderId(id => id + 1);
+          // Open on a fresh tick for additional safety
+          requestAnimationFrame(() => {
+            innerRef.current?.open(dest);
+          });
+        },
+        close(dest) {
+          innerRef.current?.close(dest);
+        },
+      }),
+      [],
+    );
+
+    // Use a unique key to force a remount, ensuring we get fresh gesture handler nodes within modalize
+    return (
+      <Modalize key={`modalize-${openRenderId}`} ref={innerRef} {...props} />
+    );
+  },
+);
+
+UNSAFE_WrappedModalize.displayName = "UNSAFE_WrappedModalize";

package/src/ContentOverlay/index.ts

@@ -1,2 +1,3 @@
 export { ContentOverlay } from "./ContentOverlay";
+export { UNSAFE_WrappedModalize } from "./UNSAFE_WrappedModalize";
 export type { ContentOverlayRef, ModalBackgroundColor } from "./types";

package/src/utils/meta/meta.json

@@ -64,6 +64,7 @@
     "ThumbnailList",
     "Toast",
     "Typography",
-    "TypographyGestureDetector"
+    "TypographyGestureDetector",
+    "UNSAFE_WrappedModalize"
   ]
 }