@applicaster/zapp-react-native-utils 13.0.0-rc.16 → 13.0.0-rc.18

package/appUtils/accessibilityManager/index.ts

@@ -6,6 +6,9 @@ import { AccessibilityRole } from "react-native";
 
 export class AccessibilityManager {
   private static _instance: AccessibilityManager | null = null;
+  private headingTimeout: NodeJS.Timeout | null = null;
+  private WORDS_PER_MINUTE = 160;
+  private MINIMUM_PAUSE = 500;
   private state$ = new BehaviorSubject<AccessibilityState>({
     screenReaderEnabled: false,
     reduceMotionEnabled: false,
@@ -20,6 +23,7 @@ export class AccessibilityManager {
 
   private ttsManager = TTSManager.getInstance();
   private localizations: { [key: string]: string } = {};
+  private headingQueue: string[] = [];
 
   private constructor() {}
 
@@ -52,6 +56,28 @@ export class AccessibilityManager {
     return this.state$.asObservable();
   }
 
+  /** Calculates the reading time for a given text
+   * This method is a bit of a hack because we don't have a callback, or promise from VIZIO API
+   * @param text - The text to calculate the reading time for
+   * @returns The reading time in milliseconds
+   */
+  private calculateReadingTime(text: string): number {
+    const words = text.trim().split(/\s+/).length;
+
+    return Math.max(
+      this.MINIMUM_PAUSE,
+      (words / this.WORDS_PER_MINUTE) * 60 * 1000
+    );
+  }
+
+  /**
+   * Adds a heading to the queue, headings will be read before the next text
+   * Each heading will be read once and removed from the queue
+   */
+  public addHeading(heading: string) {
+    this.headingQueue.push(heading);
+  }
+
   /**
    * text you want to be read, if you want to use localized text pass keyOfLocalizedText instead
    * keyOfLocalizedText is the key to the localized text
@@ -85,7 +111,22 @@ export class AccessibilityManager {
       textToRead = localizedMessage;
     }
 
-    this.ttsManager && this.ttsManager.readText(textToRead);
+    if (this.headingQueue.length > 0) {
+      const heading = this.headingQueue.shift()!;
+      this.ttsManager?.readText(heading);
+
+      if (this.headingTimeout) {
+        clearTimeout(this.headingTimeout);
+      }
+
+      const pauseTime = this.calculateReadingTime(heading);
+
+      this.headingTimeout = setTimeout(() => {
+        this.ttsManager?.readText(textToRead);
+      }, pauseTime);
+    } else {
+      this.ttsManager?.readText(textToRead);
+    }
 
     this.announcements$.next({
       message: textToRead,

package/appUtils/contextKeysManager/contextResolver.ts

@@ -0,0 +1,73 @@
+import { createLogger } from "../../logger";
+import { ContextKeysManager } from "./index";
+import * as R from "ramda";
+
+const { log_error } = createLogger({
+  subsystem: "contextResolver",
+  category: "General",
+});
+
+interface IResolver {
+  resolve: (string) => Promise<string | number | object>;
+}
+
+export class EntryResolver implements IResolver {
+  entry: ZappEntry;
+
+  constructor(entry: ZappEntry) {
+    this.entry = entry;
+  }
+
+  async resolve(key: string) {
+    if (!key || key.length === 0) {
+      return this.entry;
+    }
+
+    return R.view(R.lensPath(key.split(".")), this.entry);
+  }
+}
+
+export class ContextResolver implements IResolver {
+  resolve = async (compositeKey: string) =>
+    ContextKeysManager.instance.getKey(compositeKey);
+}
+
+export const resolveObjectValues = async (
+  data: Record<string, any>,
+  resolvers: Record<string, IResolver> = null
+) => {
+  const entries = Object.entries(data);
+
+  const exResolvers = { ctx: new ContextResolver(), ...resolvers };
+
+  const resolvedEntries = await Promise.all(
+    entries.map(async ([key, value]) => {
+      const regex = /@{([^/]+)\/([^}]*)}/;
+
+      if (typeof value !== "string") {
+        return [key, value];
+      }
+
+      const match = (value as string).match(regex);
+
+      if (match) {
+        const contextResolverName = match[1];
+        const compositeKey = match[2];
+
+        const resolver = exResolvers[contextResolverName] || exResolvers.ctx;
+        const resolvedValue = await resolver.resolve(compositeKey);
+
+        return [key, resolvedValue];
+      }
+
+      log_error("resolveObjectValues: invalid context string", {
+        key,
+        value,
+      });
+
+      return [key, null];
+    })
+  );
+
+  return Object.fromEntries(resolvedEntries);
+};

package/appUtils/focusManager/__tests__/__snapshots__/focusManager.test.js.snap

@@ -1,14 +1,14 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`focusManager should be defined 1`] = `
-Object {
+{
   "blur": [Function],
   "disableFocus": [Function],
   "enableFocus": [Function],
   "focusableTree": Tree {
     "loadingCounter": 0,
-    "root": Object {
-      "children": Array [],
+    "root": {
+      "children": [],
       "component": null,
       "id": "root",
       "lastFocusedItem": null,
@@ -39,12 +39,12 @@ Object {
 `;
 
 exports[`focusManagerIOS should be defined 1`] = `
-Object {
+{
   "focus": [Function],
   "focusableTree": Tree {
     "loadingCounter": 0,
-    "root": Object {
-      "children": Array [],
+    "root": {
+      "children": [],
       "component": null,
       "id": "root",
       "lastFocusedItem": null,

package/appUtils/keyCodes/__tests__/__snapshots__/keyCodes.test.js.snap

@@ -1,11 +1,11 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`keyCodes keyCode returns an object for a given key event 1`] = `
-Object {
+{
   "direction": [Function],
   "matches": [Function],
   "matchesAny": [Function],
-  "value": Object {
+  "value": {
     "code": "Enter",
     "keyCode": 13,
   },

package/appUtils/keyCodes/__tests__/keyCodes.test.js

@@ -1,4 +1,4 @@
-const { Platform } = require("react-native");
+import { Platform } from "react-native";
 
 Platform.OS = "web";
 

package/appUtils/orientationHelper.ts

@@ -2,7 +2,7 @@
 import * as ReactNative from "react-native";
 import { isTV, platformSelect } from "../reactUtils";
 import { usePickFromState } from "@applicaster/zapp-react-native-redux/hooks";
-import { useIsTablet } from "@applicaster/zapp-react-native-utils/reactHooks";
+import { useIsTablet } from "@applicaster/zapp-react-native-utils/reactHooks/device/useIsTablet";
 
 import {
   QUICK_BRICK_EVENTS,

package/appUtils/playerManager/playerNative.ts

@@ -58,7 +58,7 @@ export class PlayerNative extends Player {
     return this.playerState.contentPosition;
   };
 
-  currentPlayerComponent = (): ReactComponent<PlayerProps> =>
+  currentPlayerComponent = (): ReactComponent<PlayerRefProps> =>
     this.playerComponent?.current;
 
   getState = () => this.playerState;

package/arrayUtils/__tests__/__snapshots__/arrayUtils.test.ts.snap

@@ -1,7 +1,7 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`shiftArray shifts the n first items from the head to the tail of the array with a positive offset 1`] = `
-Array [
+[
   "bar",
   "baz",
   42,
@@ -10,7 +10,7 @@ Array [
 `;
 
 exports[`shiftArray shifts the n first items from the head to the tail of the array with a positive offset 2`] = `
-Array [
+[
   "baz",
   42,
   "foo",
@@ -19,7 +19,7 @@ Array [
 `;
 
 exports[`shiftArray shifts the n last items from the tail to the head of the array with a negative offset 1`] = `
-Array [
+[
   42,
   "foo",
   "bar",
@@ -28,7 +28,7 @@ Array [
 `;
 
 exports[`shiftArray shifts the n last items from the tail to the head of the array with a negative offset 2`] = `
-Array [
+[
   "baz",
   42,
   "foo",

package/functionUtils/__tests__/__snapshots__/functionUtils.test.js.snap

@@ -1,8 +1,8 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`functionUtils subscriber can be invoked without args 1`] = `
-Object {
-  "handlers": Object {},
+{
+  "handlers": {},
   "invokeHandler": [Function],
   "on": [Function],
   "removeHandler": [Function],
@@ -10,9 +10,9 @@ Object {
 `;
 
 exports[`functionUtils subscriber returns the original object with additional methods 1`] = `
-Object {
+{
   "foo": "bar",
-  "handlers": Object {},
+  "handlers": {},
   "invokeHandler": [Function],
   "method": [Function],
   "on": [Function],

package/manifestUtils/__tests__/createConfig.test.js

@@ -1,11 +1,9 @@
-import { createConfig } from "../createConfig";
-
-const styles = {
+const mockStyles = {
   fields: [{ key: "field_1", initial_value: 1 }],
   label: "styles",
 };
 
-const stylesWithGroup = {
+const mockStylesWithGroup = {
   fields: [
     {
       group: true,
@@ -15,26 +13,28 @@ const stylesWithGroup = {
   ],
 };
 
-const generators = {
-  styles: jest.fn(() => ({ styles })),
+const mockGenerators = {
+  styles: jest.fn(() => ({ styles: mockStyles })),
   stylesGroup: jest.fn(() => ({
-    styles: stylesWithGroup,
+    styles: mockStylesWithGroup,
   })),
-  customConfiguration: jest.fn(() => ({ custom_configuration: [styles] })),
+  customConfiguration: jest.fn(() => ({ custom_configuration: [mockStyles] })),
   customConfigurationGroup: jest.fn(() => ({
-    custom_configuration: [stylesWithGroup],
+    custom_configuration: [mockStylesWithGroup],
   })),
 };
 
-jest.mock("../defaultManifestConfigurations", () => ({
+jest.doMock("../defaultManifestConfigurations", () => ({
   defaultConfigurations: {
-    styles: generators.styles,
-    stylesGroup: generators.stylesGroup,
-    customConfiguration: generators.customConfiguration,
-    customConfigurationGroup: generators.customConfigurationGroup,
+    styles: mockGenerators.styles,
+    stylesGroup: mockGenerators.stylesGroup,
+    customConfiguration: mockGenerators.customConfiguration,
+    customConfigurationGroup: mockGenerators.customConfigurationGroup,
   },
 }));
 
+const { createConfig } = require("../createConfig");
+
 describe("createConfig", () => {
   it("should return a function", () => {
     const currentResult = createConfig(jest.fn());
@@ -78,7 +78,9 @@ describe("createConfig", () => {
       extend: "styles",
     })(props);
 
-    expect(generators.styles).toBeCalledWith(props);
+    console.log(mockGenerators.styles.mock.calls);
+
+    expect(mockGenerators.styles).toBeCalledWith(props);
   });
 
   it("should return base configuration if manifest is not provided", () => {
@@ -88,7 +90,7 @@ describe("createConfig", () => {
       extend: "styles",
     })({});
 
-    expect(currentResult).toEqual({ styles });
+    expect(currentResult).toEqual({ styles: mockStyles });
   });
 
   describe("Data merging", () => {

package/navigationUtils/__tests__/__snapshots__/navigationUtils.test.js.snap

@@ -1,19 +1,19 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`getNavigationProps returns the props otherwise 1`] = `
-Object {
-  "assets": Object {
+{
+  "assets": {
     "appLogo": "appLogo.png",
   },
   "home": false,
-  "nav_items": Array [
-    Object {
+  "nav_items": [
+    {
       "type": "label",
     },
   ],
-  "rules": Object {},
+  "rules": {},
   "selected": "A1234",
-  "styles": Object {
+  "styles": {
     "style": "foo",
   },
   "title": "testTitle",

package/navigationUtils/__tests__/itemTypes.test.js

@@ -61,8 +61,8 @@ describe("getTypeMatcher", () => {
 
 describe("isItemOfType", () => {
   it("is a curried function", () => {
-    expect(itemIsOfType(river, SCREEN_TYPES.RIVER)).toBeBoolean();
-    expect(itemIsOfType(river)).toBeFunction();
+    expect(itemIsOfType(river, SCREEN_TYPES.RIVER)).toBeTruthy();
+    expect(itemIsOfType(river)).toBeInstanceOf(Function);
   });
 
   it("returns true if the item is of the given type", () => {

package/navigationUtils/__tests__/navigationUtils.test.js

@@ -243,7 +243,7 @@ describe("getTargetRoute", () => {
     it("returns a valid path when initial pathname is /", () => {
       const targetRoute = getTargetRoute(river, "/", { layoutVersion });
       expect(targetRoute).toEqual(`/river/${river.id}`);
-      expect(targetRoute).not.toInclude("//");
+      expect(targetRoute).not.toContainEntry("//");
     });
   });
 
@@ -273,7 +273,7 @@ describe("getTargetRoute", () => {
     it("returns a valid path when initial pathname is /", () => {
       const targetRoute = getTargetRoute(river, "/", { layoutVersion });
       expect(targetRoute).toEqual(`/river/${river.id}`);
-      expect(targetRoute).not.toInclude("//");
+      expect(targetRoute).not.toContainEntry("//");
     });
   });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applicaster/zapp-react-native-utils",
-  "version": "13.0.0-rc.16",
+  "version": "13.0.0-rc.18",
   "description": "Applicaster Zapp React Native utilities package",
   "main": "index.js",
   "types": "index.d.ts",
@@ -28,7 +28,7 @@
   },
   "homepage": "https://github.com/applicaster/quickbrick#readme",
   "dependencies": {
-    "@applicaster/applicaster-types": "13.0.0-rc.16",
+    "@applicaster/applicaster-types": "13.0.0-rc.18",
     "buffer": "^5.2.1",
     "camelize": "^1.0.0",
     "create-react-context": "^0.2.3",
@@ -44,6 +44,7 @@
     "immer": "*",
     "react": "17.0.2",
     "react-native": "0.68.6",
+    "uglify-js": "*",
     "validate-color": "*",
     "zustand": "*"
   },

package/reactHooks/autoscrolling/__tests__/useTrackCurrentAutoScrollingElement.test.ts

@@ -14,7 +14,7 @@ jest.mock(
 
 jest.mock("@applicaster/zapp-react-native-utils/reactHooks/navigation");
 
-jest.useFakeTimers();
+jest.useFakeTimers({ legacyFakeTimers: true });
 
 const {
   useTrackCurrentAutoScrollingElement,

package/reactHooks/autoscrolling/__tests__/useTrackedView.test.tsx

@@ -19,7 +19,7 @@ jest.mock(
   })
 );
 
-jest.useFakeTimers();
+jest.useFakeTimers({ legacyFakeTimers: true });
 
 jest.mock("@applicaster/zapp-react-native-utils/reactHooks/navigation");
 

package/reactHooks/cell-click/__tests__/index.test.js

@@ -5,14 +5,14 @@ import { ActionExecutorContext } from "@applicaster/zapp-react-native-utils/acti
 
 import { waitFor } from "@testing-library/react-native";
 
-const navigator = {
+const mockNavigator = {
   getPathname: () => "pathnameMock",
   push: jest.fn(),
   data: {},
 };
 
 jest.mock("@applicaster/zapp-react-native-utils/reactHooks/navigation", () => ({
-  useNavigation: () => navigator,
+  useNavigation: () => mockNavigator,
   useRoute: () => ({ pathname: "pathnameMock" }),
   useProfilerLogging: () => {
     return jest.fn();
@@ -26,6 +26,9 @@ jest.mock("@applicaster/zapp-react-native-utils/analyticsUtils/", () => ({
 }));
 
 jest.mock("@applicaster/zapp-react-native-ui-components/Contexts", () => ({
+  ...jest.requireActual(
+    "@applicaster/zapp-react-native-ui-components/Contexts"
+  ),
   ZappPipesEntryContext: {
     useZappPipesContext: jest.fn(() => [undefined, jest.fn()]),
   },

package/reactHooks/feed/__tests__/useBuildPipesUrl.test.tsx

@@ -7,12 +7,12 @@ const appData = {
   sdk_version: "2.0.0",
 };
 
-let INFLATED_URL;
+const mockUseInflatedUrl = jest.fn();
 
 jest.mock(
   "@applicaster/zapp-react-native-utils/reactHooks/feed/useInflatedUrl",
   () => ({
-    useInflatedUrl: () => INFLATED_URL,
+    useInflatedUrl: mockUseInflatedUrl,
   })
 );
 
@@ -20,7 +20,7 @@ const { useBuildPipesUrl } = require("../useBuildPipesUrl");
 
 describe("useBuildPipesUrl", () => {
   it("returns the proper url", async () => {
-    INFLATED_URL = "http://foo.com/show/show-1";
+    mockUseInflatedUrl.mockReturnValue("http://foo.com/show/show-1");
     const url = "http://foo.com/show/{{showId}}";
 
     const mapping = {
@@ -65,7 +65,7 @@ describe("useBuildPipesUrl", () => {
   });
 
   it("returns empty object if url is not in endpoints", async () => {
-    INFLATED_URL = "http://foobar.com/show-1";
+    mockUseInflatedUrl.mockReturnValue("http://foobar.com/show-1");
     const url = "http://foobar.com/{{showId}}";
 
     const mapping = {

package/reactHooks/feed/__tests__/useFeedLoader.test.tsx

@@ -6,42 +6,41 @@ import { Provider } from "react-redux";
 import * as React from "react";
 import configureStore from "redux-mock-store";
 import thunk from "redux-thunk";
-import * as navigationHooks from "@applicaster/zapp-react-native-utils/reactHooks/navigation";
+import * as useRouteHook from "@applicaster/zapp-react-native-utils/reactHooks/navigation/useRoute";
 import * as useNavigationHooks from "@applicaster/zapp-react-native-utils/reactHooks/navigation/useNavigation";
+import { useFeedLoader } from "../useFeedLoader";
 
 const mockStore = configureStore([thunk]);
 
-jest.useFakeTimers();
+jest.useFakeTimers({ legacyFakeTimers: true });
 
-const logger = {
+const mockLogger = {
   warning: jest.fn(),
   log: jest.fn(),
   info: jest.fn(),
 };
 
-const navigator = {
+const mockNavigator: any = {
   currentRoute: "/river/A1234",
   getStack: jest.fn(() => []),
 };
 
-const routeData = {
+const mockRouteData: any = {
   screenData: {},
   pathname: "/river/A1234",
 };
 
-jest.mock("../../logger", () => ({
+jest.doMock("../../logger", () => ({
   reactHooksLogger: {
-    addSubsystem: jest.fn(() => logger),
+    addSubsystem: jest.fn(() => mockLogger),
   },
 }));
 
 jest
   .spyOn(useNavigationHooks, "useNavigation")
-  .mockImplementation(() => navigator);
+  .mockImplementation(() => mockNavigator);
 
-jest.spyOn(navigationHooks, "useRoute").mockImplementation(() => routeData);
-
-const { useFeedLoader } = require("../useFeedLoader");
+jest.spyOn(useRouteHook, "useRoute").mockImplementation(() => mockRouteData);
 
 const mockZappPipesData = {
   data: {

package/reactHooks/feed/usePipesCacheReset.ts

@@ -1,12 +1,12 @@
 import React from "react";
 import { useDispatch } from "react-redux";
-import { useRoute } from "@applicaster/zapp-react-native-utils/reactHooks/navigation";
-import {
-  getDatasourceUrl,
-  usePipesContexts,
-} from "@applicaster/zapp-react-native-ui-components/Decorators/RiverFeedLoader/utils";
+
+import { getDatasourceUrl } from "@applicaster/zapp-react-native-ui-components/Decorators/RiverFeedLoader/utils/getDatasourceUrl";
+import { usePipesContexts } from "@applicaster/zapp-react-native-ui-components/Decorators/RiverFeedLoader/utils/usePipesContexts";
 import { clearPipesData } from "@applicaster/zapp-react-native-redux/ZappPipes";
 
+import { useRoute } from "../navigation/useRoute";
+
 /**
  * reset river components cache when screen is unmounted
  * @param {string} riverId screen id