npm - @alfalab/bridge-to-native - Versions diffs - 0.0.7-beta-34caabb → 0.0.7-beta-5df3687 - Mend

@alfalab/bridge-to-native 0.0.7-beta-34caabb → 0.0.7-beta-5df3687

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/constants.d.ts +1 -0
package/constants.js +2 -1
package/index.d.ts +6 -5
package/index.js +4 -2
package/native-navigation-and-title.d.ts +23 -20
package/native-navigation-and-title.js +43 -26
package/package.json +1 -1
package/types.d.ts +2 -0

package/constants.d.ts CHANGED Viewed

@@ -10,3 +10,4 @@ export declare const versionToIosAppId: {
     readonly '12.31.0': "YXdlYXNzaXN0";
 };
 export declare const nativeFeaturesFromVersion: NativeFeaturesFromVersion;
+export declare const DEEP_LINK_PATTERN: RegExp;

package/constants.js CHANGED Viewed

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.nativeFeaturesFromVersion = exports.versionToIosAppId = exports.PREVIOUS_NATIVE_NAVIGATION_AND_TITLE_STATE_STORAGE_KEY = exports.PREVIOUS_B2N_STATE_STORAGE_KEY = exports.CLOSE_WEBVIEW_SEARCH_VALUE = exports.CLOSE_WEBVIEW_SEARCH_KEY = void 0;
+exports.DEEP_LINK_PATTERN = exports.nativeFeaturesFromVersion = exports.versionToIosAppId = exports.PREVIOUS_NATIVE_NAVIGATION_AND_TITLE_STATE_STORAGE_KEY = exports.PREVIOUS_B2N_STATE_STORAGE_KEY = exports.CLOSE_WEBVIEW_SEARCH_VALUE = exports.CLOSE_WEBVIEW_SEARCH_KEY = void 0;
 exports.CLOSE_WEBVIEW_SEARCH_KEY = 'closeWebView';
 exports.CLOSE_WEBVIEW_SEARCH_VALUE = 'true';
 exports.PREVIOUS_B2N_STATE_STORAGE_KEY = 'previousBridgeToNativeState';
@@ -25,3 +25,4 @@ exports.nativeFeaturesFromVersion = {
         geolocation: { fromVersion: '0.0.0' },
     },
 };
+exports.DEEP_LINK_PATTERN = /^(\/|\x61\x6c\x66\x61\x62\x61\x6e\x6b:\/{3}dashboard\/|\x61\x6c\x66\x61\x62\x61\x6e\x6b:\/{3}|\x61\x6c\x66\x61\x62\x61\x6e\x6b:\/{2}|https:\/{2}\x6f\x6e\x6c\x69\x6e\x65\x2e\x61\x6c\x66\x61\x62\x61\x6e\x6b\x2e\x72\x75\/)/;

package/index.d.ts CHANGED Viewed

@@ -1,9 +1,9 @@
 import { NativeFallbacks } from './native-fallbacks';
-import { HandleRedirect, NativeNavigationAndTitle } from './native-navigation-and-title';
-import type { Environment, NativeFeatureKey, NativeParams } from './types';
+import { NativeNavigationAndTitle } from './native-navigation-and-title';
+import type { Environment, HandleRedirect, NativeFeatureKey, NativeParams } from './types';
 declare type Theme = 'light' | 'dark';
 /**
- * Этот класс - абстракция для связи веб приложения с нативом и предназначен ТОЛЬКО
+ * Этот класс — абстракция для связи веб приложения с нативом и предназначен ТОЛЬКО
  * для использования в вебвью окружении.
  */
 export declare class BridgeToNative {
@@ -18,8 +18,9 @@ export declare class BridgeToNative {
     private _appVersion;
     private _iosAppId?;
     private _theme;
-    private _handleRedirect;
-    constructor(handleRedirect: HandleRedirect, nativeParams?: NativeParams);
+    private readonly _blankPagePath;
+    private readonly _handleRedirect;
+    constructor(handleRedirect: HandleRedirect, blankPagePath: string, nativeParams?: NativeParams);
     get theme(): Theme;
     get appVersion(): string;
     get iosAppId(): string | undefined;

package/index.js CHANGED Viewed

@@ -7,11 +7,11 @@ const native_fallbacks_1 = require("./native-fallbacks");
 const native_navigation_and_title_1 = require("./native-navigation-and-title");
 const utils_1 = require("./utils");
 /**
- * Этот класс - абстракция для связи веб приложения с нативом и предназначен ТОЛЬКО
+ * Этот класс — абстракция для связи веб приложения с нативом и предназначен ТОЛЬКО
  * для использования в вебвью окружении.
  */
 class BridgeToNative {
-    constructor(handleRedirect, nativeParams) {
+    constructor(handleRedirect, blankPagePath, nativeParams) {
         // Webview, запущенное в Android окружении имеет объект `Android` в window.
         this.AndroidBridge = window.Android;
         this.environment = this.AndroidBridge ? 'android' : 'ios';
@@ -19,6 +19,7 @@ class BridgeToNative {
         if (previousState) {
             this.restorePreviousState();
             this.nativeFallbacks = new native_fallbacks_1.NativeFallbacks(this);
+            this._blankPagePath = blankPagePath;
             return;
         }
         this._appVersion =
@@ -32,6 +33,7 @@ class BridgeToNative {
         this._handleRedirect = handleRedirect;
         this.nextPageId = nativeParams ? nativeParams.nextPageId : null;
         this.nativeFallbacks = new native_fallbacks_1.NativeFallbacks(this);
+        this._blankPagePath = blankPagePath;
     }
     get theme() {
         return this._theme;

package/native-navigation-and-title.d.ts CHANGED Viewed

@@ -1,15 +1,14 @@
+import { HandleRedirect } from './types';
 import { BridgeToNative } from '.';
-export declare type HandleRedirect = (appName: string, path?: string, params?: Record<string, string>) => void;
 /**
- * Класс, отвечающий за взаимодействие с нативными элементами в приложении – заголовком
- * и нативной кнопкой назад.
+ * Класс, отвечающий за взаимодействие с нативными элементами в приложении – заголовком и нативной кнопкой назад.
  */
 export declare class NativeNavigationAndTitle {
     private b2n;
     private nativeHistoryStack;
     private numOfBackSteps;
     private lastSetPageSettingsParams;
-    private handleWindowRedirect;
+    private readonly _handleWindowRedirect;
     constructor(b2n: BridgeToNative, pageId: number | null, initialNativeTitle: string | undefined, handleWindowRedirect: HandleRedirect);
     /**
      * Метод, вызывающий `history.back()` или закрывающий вебвью, если нет записей
@@ -18,15 +17,15 @@ export declare class NativeNavigationAndTitle {
     goBack(): void;
     /**
      * Метод, вызывающий history.go(-колл. шагов назад) и модифицирует внутреннее
-     * состояние, чтобы в дальнейшем зарегистририровать этот переход в приложении.
+     * состояние, чтобы в дальнейшем зарегистрировать этот переход в приложении.
      *
      * @param stepsNumber Количество шагов назад.
      *  Возможно передача как положительного, так и отрицательного числа.
      *  0 будет проигнорирован.
-     * @param autocloseWebview Флаг – закрывать ли вебвью автоматически,
-     *  если переданное кол-во шагов будет больше, чем записей в истории.
+     * @param autoCloseWebview Флаг – закрывать ли вебвью автоматически,
+     * если переданное кол-во шагов будет больше чем записей в истории.
      */
-    goBackAFewSteps(stepsNumber: number, autocloseWebview?: boolean): void;
+    goBackAFewSteps(stepsNumber: number, autoCloseWebview?: boolean): void;
     /**
      * @param path Путь для перехода на функциональность внутри приложения.
      */
@@ -42,7 +41,7 @@ export declare class NativeNavigationAndTitle {
     handleRedirect(pageTitle: string, appName: string, path?: string, params?: Record<string, string>): void;
     /**
      * Информирует натив, что веб находится на первом экране (сбрасывает историю переходов, не влияя на браузерную
-     * историю), а значит следующее нажатие на кнопку "Назад" в нативне закроет вебвью.
+     * историю), а значит следующее нажатие на кнопку "Назад" в нативе закроет вебвью.
      *
      * @param pageTitle Заголовок, который нужно отрисовать в нативе.
      */
@@ -54,24 +53,28 @@ export declare class NativeNavigationAndTitle {
      */
     setTitle(pageTitle: string): void;
     /**
-     * Метод для открытия второго web приложения в рамках
-     * одной вебвью сессии
-     * сохраняет все текущее состояние текущего экземпляра bridgeToAm и AmNavigationAndTitle в sessionStorage, а
+     * Метод для открытия второго web приложения в рамках одной вебвью сессии.
+     * Сохраняет все текущее состояние текущего экземпляра bridgeToAm и AmNavigationAndTitle в sessionStorage, а
      * так же наполняет url необходимыми query параметрами. Работает только в Android окружении.
      * В IOS окружении будет открыто новое webview поверх текущего.
-     * @param url адрес второго web приложения к которому перед переходом на него будут добавлены
+     *
+     * @param url адрес второго web приложения, к которому перед переходом на него будут добавлены
      * все initial query параметры от натива и параметр nextPageId (Android)
      */
     navigateInsideASharedSession(url: string): void;
     /**
-     * ПОКА НЕ ИСПОЛЬЗОВАТЬ В ПРОДЕ (МЕТОД НЕ РАБОТАЕТ КОРРЕКТНО НА ANDROID)
-     * НА ANDROID ПРИ ПЕРЕЗАГРУЗКЕ СТРАНИЦЫ В ИСТРИЮ ЛОЖИТСЯ + ЕЩЕ ОДИН ЛИШНИЙ ЭЛЕМЕНТ
-     * Данный метод будет дорабатываться отдельной задачей
      * Безопасный способ для перезагрузки страницы.
-     * Производит предварительное сохранение текущего состояния
-     * BridgeToNative и NativeNavigationAndTitle перед вызовом location.reload()
      */
-    reloadPage(): void;
+    pseudoReloadPage(): void;
+    /**
+     * Вызывает обработчик deeplinks в нативе (АМ) и передает туда переданный deeplink.
+     * На Android текущее webview будет закрыто из-за технических особенностей.
+     * На IOS нативная фича открывается в следующем по стеку экране и при выходе из нее пользователь вернется обратно в webview.
+     * На IOS есть возможность закрыть webview перед открытием нативной фичи, передав второй параметр closeIOSWebviewBeforeCallNativeDeeplinkHandler = true
+     * @param deeplink диплинк на нативную АМ фичу в AM
+     * @param [closeIOSWebviewBeforeCallNativeDeeplinkHandler = false] закрыть текущее webview после открытия нативной фичи (применимо только для IOS на Android по техническим причинам webview всегда будет закрываться)
+     */
+    handleNativeDeeplink(deeplink: string, closeIOSWebviewBeforeCallNativeDeeplinkHandler?: boolean): void;
     /**
      * Метод для сохранения текущего состояния NativeNavigationAndTitle в sessionStorage.
      */
@@ -136,7 +139,7 @@ export declare class NativeNavigationAndTitle {
      * рамках одной вебвью сессии
      * @param url - url иного веб приложения
      * @return подготовленная согласно контракту ссылка на иное веб приложение с initial query
-     * параметрами от нативе, а так же nextPageId
+     * параметрами от натива, а так же nextPageId.
      */
     private prepareExternalLinkBeforeOpen;
 }

package/native-navigation-and-title.js CHANGED Viewed

@@ -4,8 +4,7 @@ exports.NativeNavigationAndTitle = void 0;
 const constants_1 = require("./constants");
 const utils_1 = require("./utils");
 /**
- * Класс, отвечающий за взаимодействие с нативными элементами в приложении – заголовком
- * и нативной кнопкой назад.
+ * Класс, отвечающий за взаимодействие с нативными элементами в приложении – заголовком и нативной кнопкой назад.
  */
 class NativeNavigationAndTitle {
     constructor(b2n, pageId, initialNativeTitle = '', handleWindowRedirect) {
@@ -16,7 +15,7 @@ class NativeNavigationAndTitle {
         // Просто, чтобы не слать одинаковые сигналы в приложение.
         this.lastSetPageSettingsParams = '';
         this.handleBack = this.handleBack.bind(this);
-        this.handleWindowRedirect = handleWindowRedirect;
+        this._handleWindowRedirect = handleWindowRedirect;
         const previousState = !!sessionStorage.getItem(constants_1.PREVIOUS_NATIVE_NAVIGATION_AND_TITLE_STATE_STORAGE_KEY);
         if (pageId) {
             this.supportSharedSession(pageId, initialNativeTitle);
@@ -37,22 +36,22 @@ class NativeNavigationAndTitle {
     }
     /**
      * Метод, вызывающий history.go(-колл. шагов назад) и модифицирует внутреннее
-     * состояние, чтобы в дальнейшем зарегистририровать этот переход в приложении.
+     * состояние, чтобы в дальнейшем зарегистрировать этот переход в приложении.
      *
      * @param stepsNumber Количество шагов назад.
      *  Возможно передача как положительного, так и отрицательного числа.
      *  0 будет проигнорирован.
-     * @param autocloseWebview Флаг – закрывать ли вебвью автоматически,
-     *  если переданное кол-во шагов будет больше, чем записей в истории.
+     * @param autoCloseWebview Флаг – закрывать ли вебвью автоматически,
+     * если переданное кол-во шагов будет больше чем записей в истории.
      */
-    goBackAFewSteps(stepsNumber, autocloseWebview = false) {
+    goBackAFewSteps(stepsNumber, autoCloseWebview = false) {
         if (!stepsNumber) {
             return;
         }
         const stepsToBack = Math.abs(stepsNumber);
         const maxStepsToBack = this.nativeHistoryStack.length - 1;
         if (stepsToBack > maxStepsToBack) {
-            if (autocloseWebview) {
+            if (autoCloseWebview) {
                 this.b2n.closeWebview();
                 return;
             }
@@ -70,11 +69,11 @@ class NativeNavigationAndTitle {
      */
     handleRedirect(pageTitleOrPath, appName, path, params) {
         if (appName) {
-            this.handleWindowRedirect(appName, path, params);
+            this._handleWindowRedirect(appName, path, params);
         }
         else {
             const { appName: extractedAppName, path: extractedPath, query: extractedQuery, } = (0, utils_1.extractAppNameRouteAndQuery)(pageTitleOrPath);
-            this.handleWindowRedirect(extractedAppName, extractedPath, extractedQuery);
+            this._handleWindowRedirect(extractedAppName, extractedPath, extractedQuery);
         }
         const title = appName ? pageTitleOrPath : '';
         this.nativeHistoryStack.push(title);
@@ -82,7 +81,7 @@ class NativeNavigationAndTitle {
     }
     /**
      * Информирует натив, что веб находится на первом экране (сбрасывает историю переходов, не влияя на браузерную
-     * историю), а значит следующее нажатие на кнопку "Назад" в нативне закроет вебвью.
+     * историю), а значит следующее нажатие на кнопку "Назад" в нативе закроет вебвью.
      *
      * @param pageTitle Заголовок, который нужно отрисовать в нативе.
      */
@@ -101,17 +100,18 @@ class NativeNavigationAndTitle {
         this.syncHistoryWithNative(pageTitle, 'title-replacing');
     }
     /**
-     * Метод для открытия второго web приложения в рамках
-     * одной вебвью сессии
-     * сохраняет все текущее состояние текущего экземпляра bridgeToAm и AmNavigationAndTitle в sessionStorage, а
+     * Метод для открытия второго web приложения в рамках одной вебвью сессии.
+     * Сохраняет все текущее состояние текущего экземпляра bridgeToAm и AmNavigationAndTitle в sessionStorage, а
      * так же наполняет url необходимыми query параметрами. Работает только в Android окружении.
      * В IOS окружении будет открыто новое webview поверх текущего.
-     * @param url адрес второго web приложения к которому перед переходом на него будут добавлены
+     *
+     * @param url адрес второго web приложения, к которому перед переходом на него будут добавлены
      * все initial query параметры от натива и параметр nextPageId (Android)
      */
     navigateInsideASharedSession(url) {
         if (this.b2n.environment === 'ios') {
-            this.b2n.nativeFallbacks.visitExternalResource(url);
+            const nativeDeeplink = `/webFeature?type=recommendation&url=${encodeURIComponent(url)}`;
+            this.handleNativeDeeplink(nativeDeeplink);
             return;
         }
         // В b2n этот метод отмечен модификатором доступа private, но тут его нужно вызвать
@@ -121,19 +121,36 @@ class NativeNavigationAndTitle {
         window.location.assign(this.prepareExternalLinkBeforeOpen(url));
     }
     /**
-     * ПОКА НЕ ИСПОЛЬЗОВАТЬ В ПРОДЕ (МЕТОД НЕ РАБОТАЕТ КОРРЕКТНО НА ANDROID)
-     * НА ANDROID ПРИ ПЕРЕЗАГРУЗКЕ СТРАНИЦЫ В ИСТРИЮ ЛОЖИТСЯ + ЕЩЕ ОДИН ЛИШНИЙ ЭЛЕМЕНТ
-     * Данный метод будет дорабатываться отдельной задачей
      * Безопасный способ для перезагрузки страницы.
-     * Производит предварительное сохранение текущего состояния
-     * BridgeToNative и NativeNavigationAndTitle перед вызовом location.reload()
      */
-    reloadPage() {
+    pseudoReloadPage() {
         // В b2n этот метод отмечен модификатором доступа private, но тут его нужно вызвать
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-ignore
-        this.b2n.saveCurrentState();
-        window.location.reload();
+        this.handleRedirect(this.b2n._blankPagePath);
+        this.goBack();
+    }
+    /**
+     * Вызывает обработчик deeplinks в нативе (АМ) и передает туда переданный deeplink.
+     * На Android текущее webview будет закрыто из-за технических особенностей.
+     * На IOS нативная фича открывается в следующем по стеку экране и при выходе из нее пользователь вернется обратно в webview.
+     * На IOS есть возможность закрыть webview перед открытием нативной фичи, передав второй параметр closeIOSWebviewBeforeCallNativeDeeplinkHandler = true
+     * @param deeplink диплинк на нативную АМ фичу в AM
+     * @param [closeIOSWebviewBeforeCallNativeDeeplinkHandler = false] закрыть текущее webview после открытия нативной фичи (применимо только для IOS на Android по техническим причинам webview всегда будет закрываться)
+     */
+    handleNativeDeeplink(deeplink, closeIOSWebviewBeforeCallNativeDeeplinkHandler = false) {
+        const clearedDeeplinkPath = deeplink.replace(constants_1.DEEP_LINK_PATTERN, '');
+        if (this.b2n.environment === 'ios') {
+            if (closeIOSWebviewBeforeCallNativeDeeplinkHandler) {
+                this.b2n.closeWebview();
+                setTimeout(() => window.location.replace(`${this.b2n.iosAppId}://${clearedDeeplinkPath}`), 0);
+                return;
+            }
+            window.location.replace(`${this.b2n.iosAppId}://${clearedDeeplinkPath}`);
+        }
+        else {
+            window.location.replace(`alfabank://${clearedDeeplinkPath}`);
+        }
     }
     /**
      * Метод для сохранения текущего состояния NativeNavigationAndTitle в sessionStorage.
@@ -191,7 +208,7 @@ class NativeNavigationAndTitle {
     getNativePageIdForNavigation() {
         const stackSize = this.nativeHistoryStack.length;
         // Нажимая на кнопку назад, можно дойти до "первой" страницы,
-        // в iOS для "первой" страницы не нужно слать `pageId`
+        // в iOS для "первой" страницы не нужно слать `pageId`.
         return this.b2n.environment === 'ios' && stackSize <= 1 ? null : stackSize;
     }
     /**
@@ -297,7 +314,7 @@ class NativeNavigationAndTitle {
      * рамках одной вебвью сессии
      * @param url - url иного веб приложения
      * @return подготовленная согласно контракту ссылка на иное веб приложение с initial query
-     * параметрами от нативе, а так же nextPageId
+     * параметрами от натива, а так же nextPageId.
      */
     prepareExternalLinkBeforeOpen(url) {
         const currentPageId = this.nativeHistoryStack.length;

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
     "license": "UNLICENSED",
     "name": "@alfalab/bridge-to-native",
-    "version": "0.0.7-beta-34caabb",
+    "version": "0.0.7-beta-5df3687",
     "repository": {
         "type": "git",
         "url": "git+https://github.com/core-ds/bridge-to-native.git"

package/types.d.ts CHANGED Viewed

@@ -29,4 +29,6 @@ export declare type PreviousNativeNavigationAndTitleState = {
     nativeHistoryStack: string[];
     title: string;
 };
+export declare type SyncPurpose = 'initialization' | 'navigation' | 'title-replacing';
+export declare type HandleRedirect = (appName: string, path?: string, params?: Record<string, string>) => void;
 export {};