@applicaster/zapp-react-native-utils 13.0.0-rc.12 → 13.0.0-rc.13

package/appUtils/HooksManager/{Hook.js → Hook.ts}

@@ -4,6 +4,7 @@ import { isFunction } from "../../functionUtils";
 import { HOOKS_EVENTS, HOOKS_TRANSITION_TYPE } from "./constants";
 
 import { hooksManagerLogger } from "./logger";
+import type { Hook as HookInterface, HookIniObj } from "./types";
 
 const BASE_HOOK_PROPERTIES = ["screen_id", "identifier", "weight"];
 
@@ -14,7 +15,9 @@ const BASE_HOOK_PROPERTIES = ["screen_id", "identifier", "weight"];
  * @param {string} hookEventName
  * @returns {number} index
  */
-const hookState = R.indexOf(R.__, R.values(HOOKS_EVENTS));
+const hookState: (
+  arg0: typeof HOOKS_EVENTS[keyof typeof HOOKS_EVENTS]
+) => number = R.indexOf(R.__, R.values(HOOKS_EVENTS));
 
 /**
  * assigns property to a given context
@@ -28,17 +31,20 @@ function assignProp(context) {
 }
 
 /**
- * Representation of a hook plugin with full data
+ * Representation of a hook plugin
  */
-export class Hook {
-  /**
-   * constructs the hook
-   * @param {object} Options
-   * @param {object} Options.hook hook object
-   * @param {Array<Object>} Options.hooks array of hooks siblings in the current process
-   * @param {object} manager hook manager to process the hooks
-   */
-  constructor({ hook, hooks, manager }) {
+export class Hook implements HookInterface {
+  public manager: HookInterface["manager"];
+  public lastHook: HookInterface["lastHook"];
+  public state: HookInterface["state"];
+  public screen_id: HookInterface["screen_id"];
+  public identifier: HookInterface["identifier"];
+  public module: HookInterface["module"];
+  public general: HookInterface["general"];
+  public weight: number;
+  public configuration: HookInterface["configuration"];
+
+  constructor({ hook, hooks, manager }: HookIniObj) {
     R.forEachObjIndexed(assignProp(this), hook);
     this.manager = manager;
 
@@ -55,25 +61,28 @@ export class Hook {
    * @param {string} event name
    * @param {Array<Any>} args variadic arguments to invoke the handler with
    */
-  setStateAndNotify(event, ...args) {
+  setStateAndNotify(
+    event: typeof HOOKS_EVENTS[keyof typeof HOOKS_EVENTS],
+    ...args
+  ) {
     this.state = hookState(event);
-    this.manager.invokeHandler(event, ...args);
+    this.manager.subscriber.invokeHandler(event, ...args);
   }
 
   /**
    * returns react component of the the hook modal presenter
    * @returns {React.ComponentType<any>}
    */
-  getModalContainer() {
-    return this.module && this.module.ModalContainer;
+  getModalContainer(): HookInterface["module"]["ModalContainer"] | undefined {
+    return this.module ? this.module.ModalContainer : undefined;
   }
 
   /**
    * tells whether the hook should be presented as a screen
    * @returns {boolean}
    */
-  shouldPresentScreenHook() {
-    return (
+  shouldPresentScreenHook(): boolean {
+    return !!(
       (this.screen_id && this.general?.allow_screen_plugin_presentation) ||
       (this.module && this.module.presentFullScreen) ||
       (!this.module?.presentFullScreen &&
@@ -87,7 +96,7 @@ export class Hook {
    * tells whether the hook should be presented as a modal screen
    * @returns {boolean}
    */
-  isModalHook() {
+  isModalHook(): boolean {
     return (
       this.screen_id &&
       this.general?.transition_type === HOOKS_TRANSITION_TYPE.MODAL
@@ -99,7 +108,7 @@ export class Hook {
    * if it doesn't return success
    * @returns { boolean}
    */
-  isFlowBlocker() {
+  isFlowBlocker(): boolean {
     return (
       (this.general && this.general.is_flow_blocker) ||
       (this.module && this.module.isFlowBlocker && this.module.isFlowBlocker())
@@ -111,7 +120,7 @@ export class Hook {
    * @param {object} payload to pass to the hook
    * @returns { boolean}
    */
-  skipHook(payload) {
+  skipHook(payload: object): boolean {
     const _skipHook = R.compose(
       R.ifElse(isFunction, R.apply(R.__, [payload]), R.F),
       R.path(["module", "skipHook"])
@@ -133,7 +142,10 @@ export class Hook {
    * @param {object} payload to pass to the hook
    * @param {function} next callback to invoke for processing next hook
    */
-  execute(payload, next) {
+  execute<T extends object>(
+    payload: T,
+    next: (arg0: { payload: T; success?: boolean }) => void
+  ): void {
     if (this.skipHook(payload)) {
       next({ payload, success: true });
 
@@ -152,7 +164,7 @@ export class Hook {
 
         this.setStateAndNotify(HOOKS_EVENTS.START_BACKGROUND_HOOK, this);
 
-        this.manager.runInBackground(this, payload, next, (_payload) =>
+        this.manager.runInBackground(this, payload, next, (_payload: any) =>
           this.manager.presentScreenHook(this, _payload || payload, next)
         );
       } else if (this.shouldPresentScreenHook()) {
@@ -175,7 +187,7 @@ export class Hook {
    *  - AND next hook has the same weight as the current one
    * @returns {boolean}
    */
-  shouldStartNextHook(nextHook) {
+  shouldStartNextHook(nextHook: Hook): boolean {
     return (
       nextHook &&
       !this.shouldPresentScreenHook() &&

package/appUtils/HooksManager/__tests__/__snapshots__/hook.test.js.snap

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`Hook Properties has all the hook properties 1`] = `
+exports[`Hook Hook Properties has all the hook properties 1`] = `
 Hook {
   "advertising": Object {},
   "general": Object {
@@ -13,8 +13,10 @@ Hook {
   "lastHook": true,
   "manager": Object {
     "executeHook": [MockFunction],
-    "invokeHandler": [MockFunction],
     "presentScreenHook": [MockFunction],
+    "subscriber": Object {
+      "invokeHandler": [MockFunction],
+    },
   },
   "name": "Hook Screen",
   "navigations": Array [],