@alfalab/bridge-to-native 1.3.2-beta.b39ff6d → 1.4.0

package/client/bridge-to-native.d.ts

@@ -89,11 +89,28 @@ export declare class BridgeToNative {
      * Делает несколько шагов назад по браузерной истории и модифицирует внутреннее состояние,
      * чтобы в дальнейшем зарегистрировать этот переход в NA.
      *
+     * ВАЖНО!
+     * До версии `1.4.0` метод назывался `goBackAFewStepsClientSide` и его можно
+     * было использовать только в рамках SPA истории.
+     *
+     * После переименования этот метод можно использовать без ограничей, НО С УСЛОВИЕМ,
+     * что в потребителях B2N нет прямых вызовов `history.replaceState` (или оберток над ним,
+     * типа `history.replace` из ReactRouter). А вместо прямых вызовов используется
+     * метод B2N `replaceHistoryState`. Который под капотом вызывает `history.replaceState`
+     * или вашу собственную «обертку» над ним (см. `browserHistoryApiWrappers` в конструкторе).
+     *
+     * Если это условие не соблюдается, как и раньше, метод можно использовать
+     * только в рамках истории по SPA WA.
+     *
      * @param stepsNumber Количество шагов назад.
      *  Возможно передача как положительного, так и отрицательного числа. `0` будет проигнорирован.
      * @param autoCloseWebview Флаг — закрывать ли WV автоматически,
      *  если переданное кол-во шагов будет больше, чем записей в истории.
      */
+    goBackAFewSteps(stepsNumber: number, autoCloseWebview?: boolean): void;
+    /**
+     * @deprecated Используйте `goBackAFewSteps`.
+     */
     goBackAFewStepsClientSide(stepsNumber: number, autoCloseWebview?: boolean): void;
     /**
      * Вызывает обработчик диплинков NA для обработки переданного диплинка.
@@ -141,6 +158,15 @@ export declare class BridgeToNative {
      * чтобы корректно передать информацию экземпляру B2N следующего WA или
      * экзепляру B2N следующей страницы текущего WA (в случае multi-page application).
      *
+     * ВАЖНО!
+     * С версии `1.4.0` появилась возможность использовать `goBackAFewSteps`
+     * через границу server-side (hard) навигации (включая переходы на другие origin).
+     * Но с условием, см. описание `goBackAFewSteps`.
+     *
+     * ВАЖНО!
+     * До версии `1.4.0` метод имел ограничения, которые останутся, если переходить на WA,
+     * которое использует B2N версии < `1.4.0`.
+     *
      * @param url URL для перехода внутри WA server-side навигацией.
      * @param nativeTitle Текст заголовка, для «нативной» части WV, пустая строка — отсутствие заголовка.
      */
@@ -188,11 +214,8 @@ export declare class BridgeToNative {
      */
     openPdf(url: string, type?: PdfType, title?: string): void;
     /**
-     * Для перезагрузки страницы необходимо использовать этот метод.
-     * Иначе синхронизация состояния с NA будет потеряна.
-     *
-     * @param skipReload По умолчанию метод сам делает `location.reload`,
-     *  но с помощью аргумента можно отключить этот вызов, если нужно.
+     * @deprecated Используйте `window.location.reload()` напрямую.
+     * B2N больше не требует специального метода для перезагрузки.
      */
     reload(skipReload?: boolean): void;
     /**

package/client/bridge-to-native.js

@@ -115,13 +115,32 @@ class BridgeToNative {
      * Делает несколько шагов назад по браузерной истории и модифицирует внутреннее состояние,
      * чтобы в дальнейшем зарегистрировать этот переход в NA.
      *
+     * ВАЖНО!
+     * До версии `1.4.0` метод назывался `goBackAFewStepsClientSide` и его можно
+     * было использовать только в рамках SPA истории.
+     *
+     * После переименования этот метод можно использовать без ограничей, НО С УСЛОВИЕМ,
+     * что в потребителях B2N нет прямых вызовов `history.replaceState` (или оберток над ним,
+     * типа `history.replace` из ReactRouter). А вместо прямых вызовов используется
+     * метод B2N `replaceHistoryState`. Который под капотом вызывает `history.replaceState`
+     * или вашу собственную «обертку» над ним (см. `browserHistoryApiWrappers` в конструкторе).
+     *
+     * Если это условие не соблюдается, как и раньше, метод можно использовать
+     * только в рамках истории по SPA WA.
+     *
      * @param stepsNumber Количество шагов назад.
      *  Возможно передача как положительного, так и отрицательного числа. `0` будет проигнорирован.
      * @param autoCloseWebview Флаг — закрывать ли WV автоматически,
      *  если переданное кол-во шагов будет больше, чем записей в истории.
      */
+    goBackAFewSteps(stepsNumber, autoCloseWebview = false) {
+        this.nativeNavigationAndTitleService.goBackAFewSteps(stepsNumber, autoCloseWebview);
+    }
+    /**
+     * @deprecated Используйте `goBackAFewSteps`.
+     */
     goBackAFewStepsClientSide(stepsNumber, autoCloseWebview = false) {
-        this.nativeNavigationAndTitleService.goBackAFewStepsClientSide(stepsNumber, autoCloseWebview);
+        this.goBackAFewSteps(stepsNumber, autoCloseWebview);
     }
     /**
      * Вызывает обработчик диплинков NA для обработки переданного диплинка.
@@ -175,6 +194,15 @@ class BridgeToNative {
      * чтобы корректно передать информацию экземпляру B2N следующего WA или
      * экзепляру B2N следующей страницы текущего WA (в случае multi-page application).
      *
+     * ВАЖНО!
+     * С версии `1.4.0` появилась возможность использовать `goBackAFewSteps`
+     * через границу server-side (hard) навигации (включая переходы на другие origin).
+     * Но с условием, см. описание `goBackAFewSteps`.
+     *
+     * ВАЖНО!
+     * До версии `1.4.0` метод имел ограничения, которые останутся, если переходить на WA,
+     * которое использует B2N версии < `1.4.0`.
+     *
      * @param url URL для перехода внутри WA server-side навигацией.
      * @param nativeTitle Текст заголовка, для «нативной» части WV, пустая строка — отсутствие заголовка.
      */
@@ -230,14 +258,14 @@ class BridgeToNative {
         this.externalLinksService.openPdf(url, type, title);
     }
     /**
-     * Для перезагрузки страницы необходимо использовать этот метод.
-     * Иначе синхронизация состояния с NA будет потеряна.
-     *
-     * @param skipReload По умолчанию метод сам делает `location.reload`,
-     *  но с помощью аргумента можно отключить этот вызов, если нужно.
+     * @deprecated Используйте `window.location.reload()` напрямую.
+     * B2N больше не требует специального метода для перезагрузки.
      */
+    // eslint-disable-next-line class-methods-use-this -- метод оставлен для обратной совместимости.
     reload(skipReload) {
-        this.nativeNavigationAndTitleService.reload(skipReload);
+        if (!skipReload) {
+            window.location.reload();
+        }
     }
     /**
      * Позволяет изменить `history.state` и/или URL текущей записи без потери служебного свойства B2N.

package/client/services-and-utils/native-navigation-and-title-service.d.ts

@@ -11,22 +11,20 @@ export declare class NativeNavigationAndTitleService {
     private nativeParamsService;
     private browserHistoryApiWrappers?;
     private logError?;
-    private nativeHistoryStack;
     private lastSetPageSettingsParams;
+    private nativeHistoryStack;
+    private numOfBackSteps;
     private isGoBackLocked;
     private isNavigateServerSideLocked;
     constructor(nativeParamsService: NativeParamsService, browserHistoryApiWrappers?: BrowserHistoryApiWrappers | undefined, logError?: LogError | undefined);
     closeWebview(): void;
     goBack(): void;
-    goBackAFewStepsClientSide(stepsNumber: number, autoCloseWebview?: boolean): void;
+    goBackAFewSteps(stepsNumber: number, autoCloseWebview?: boolean): void;
     navigateClientSide(url: HistoryPushStateParams[2], state?: HistoryPushStateParams[0], nativeTitle?: string): void;
     navigateServerSide(link: LocationAssignParam, nativeTitle?: string): void;
-    reload(skipReload?: boolean): void;
+    replaceHistoryState(url?: HistoryPushStateParams[2], state?: HistoryPushStateParams[0]): void;
     setInitialView(nativeTitle?: string): void;
     setTitle(nativeTitle: string): void;
-    replaceHistoryState(url?: HistoryPushStateParams[2], state?: HistoryPushStateParams[0]): void;
-    private createStateWithPageId;
-    private setHistoryStatePageId;
     /**
      * Метод, вычисляющий `pageId`, который нужно послать в NA
      * для правильной синхронизации с кнопкой "Назад". Также вычисляет `pageTitle`
@@ -41,19 +39,10 @@ export declare class NativeNavigationAndTitleService {
      */
     private handleClientSideNavigationBack;
     private hasSavedHistoryStack;
-    /**
-     * Инициализирует `nativeHistoryStack`.
-     *
-     * Подробное описание каждого сценария см. в {@link ./NAVIGATION_SCENARIOS.md}.
-     */
     private initializeNativeHistoryStack;
+    private initializeForBackward;
     private initializeForNewOrigin;
     private initializeForForward;
-    /**
-     * Читает и парсит `nativeHistoryStack` из SessionStorage.
-     * При ошибке чтения или парсинга логирует через `logError` и пробрасывает исключение.
-     */
-    private readSavedHistoryStack;
     /**
      * Подготавливает ссылку для корректного перехода server-side навигацией.
      *
@@ -63,12 +52,16 @@ export declare class NativeNavigationAndTitleService {
      */
     private prepareExternalLinkBeforeOpen;
     /**
-     * Сохраняет `nativeHistoryStack` в SessionStorage.
+     * Читает и парсит `nativeHistoryStack` из SessionStorage.
+     * При ошибке чтения или парсинга логирует через `logError` и пробрасывает исключение.
      */
+    private readSavedHistoryStack;
     private saveNativeHistoryStack;
     /**
      * Синхронизирует состояние истории переходов и заголовок с NA в соответствии
      * с `nativeHistoryStack`.
      */
     private syncHistoryWithNative;
+    private setHistoryStatePageId;
+    private createStateWithPageId;
 }

package/client/services-and-utils/native-navigation-and-title-service.js

@@ -1,5 +1,5 @@
 "use strict";
-/* eslint max-lines: ["error", {"max": 400, "skipComments": true}] */
+/* eslint max-lines: ["error", {"max": 350, "skipComments": true}] */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NativeNavigationAndTitleService = void 0;
 const query_and_headers_keys_1 = require("../../query-and-headers-keys");
@@ -20,13 +20,18 @@ class NativeNavigationAndTitleService {
         // Здесь сохраняются параметры, которые в последний раз были отправлены
         // в NA. Помогает предотвратить повторную отправку одинаковых параметров.
         this.lastSetPageSettingsParams = '';
+        // Поле для фолбэк сценария, чтобы не ломать обратную совместимость в версии `1.4.0`.
+        // Фолбэк сцерий используется для потребителей B2N, которые используют
+        // прямые вызовы `history.replaceState` (или обертки над ним, типа `history.replace` из ReactRouter)
+        // вместо нового метода B2N `replaceHistoryState`
+        this.numOfBackSteps = 1;
         // Предотвращают повторный вызов навигации, пока текущая не завершена.
         // Без блокировки WV-браузер продолжит показывать исходную страницу,
         // и повторный вызов может инициировать нежелательную навигацию.
         // `isGoBackLocked` снимается в `handleClientSideNavigationBack` (popstate) для soft-навигации;
         // при hard-навигации блокировка снимется автоматически при новой инициализации.
-        // `isNavigateServerSideLocked` не снимается — после server-side навигации всегда новая инициализация.
         this.isGoBackLocked = false;
+        // `isNavigateServerSideLocked` не снимается — после server-side навигации всегда новая инициализация.
         this.isNavigateServerSideLocked = false;
         this.handleClientSideNavigationBack = this.handleClientSideNavigationBack.bind(this);
         window.addEventListener('popstate', this.handleClientSideNavigationBack); // без отписки т.к. Сервис используется в течение всей жизни WA
@@ -41,9 +46,9 @@ class NativeNavigationAndTitleService {
             return;
         }
         this.isGoBackLocked = true;
-        this.goBackAFewStepsClientSide(-1, true);
+        this.goBackAFewSteps(-1, true);
     }
-    goBackAFewStepsClientSide(stepsNumber, autoCloseWebview = false) {
+    goBackAFewSteps(stepsNumber, autoCloseWebview = false) {
         var _a;
         if (!stepsNumber) {
             return;
@@ -55,8 +60,12 @@ class NativeNavigationAndTitleService {
                 (0, close_webview_util_1.closeWebviewUtil)();
                 return;
             }
+            this.numOfBackSteps = maxStepsToBack;
+        }
+        else {
+            this.numOfBackSteps = stepsToBack;
         }
-        const steps = -Math.min(stepsToBack, maxStepsToBack);
+        const steps = -this.numOfBackSteps;
         if ((_a = this.browserHistoryApiWrappers) === null || _a === void 0 ? void 0 : _a.go) {
             this.browserHistoryApiWrappers.go(steps);
         }
@@ -67,14 +76,13 @@ class NativeNavigationAndTitleService {
     }
     navigateClientSide(url, state = null, nativeTitle = '') {
         var _a;
-        const nextPageId = this.nativeHistoryStack.length + 1;
-        const stateWithPageId = this.createStateWithPageId(state, nextPageId);
         if ((_a = this.browserHistoryApiWrappers) === null || _a === void 0 ? void 0 : _a.push) {
-            this.browserHistoryApiWrappers.push(url, stateWithPageId);
+            this.browserHistoryApiWrappers.push(url, state);
         }
         else {
-            window.history.pushState(stateWithPageId, '', url);
+            window.history.pushState(state, '', url);
         }
+        this.setHistoryStatePageId(true);
         this.nativeHistoryStack.push(nativeTitle);
         this.saveNativeHistoryStack();
         this.syncHistoryWithNative();
@@ -92,12 +100,15 @@ class NativeNavigationAndTitleService {
         this.saveNativeHistoryStack();
         window.location.assign(this.prepareExternalLinkBeforeOpen(url));
     }
-    // eslint-disable-next-line class-methods-use-this -- удобней использовать метод в контексте экземпляра.
-    reload(skipReload = false) {
-        document.cookie = `${query_and_headers_keys_1.COOKIE_KEY_BRIDGE_TO_NATIVE_RELOAD}=true; Path=/`;
-        if (!skipReload) {
-            window.location.reload();
+    replaceHistoryState(url, state = null) {
+        var _a;
+        if ((_a = this.browserHistoryApiWrappers) === null || _a === void 0 ? void 0 : _a.replace) {
+            this.browserHistoryApiWrappers.replace(url, state);
         }
+        else {
+            window.history.replaceState(state, '', url);
+        }
+        this.setHistoryStatePageId();
     }
     setInitialView(nativeTitle = '') {
         this.nativeHistoryStack = [nativeTitle];
@@ -109,33 +120,6 @@ class NativeNavigationAndTitleService {
         this.saveNativeHistoryStack();
         this.syncHistoryWithNative();
     }
-    replaceHistoryState(url, state = null) {
-        var _a;
-        const pageId = this.nativeHistoryStack.length;
-        const stateWithPageId = this.createStateWithPageId(state, pageId);
-        if ((_a = this.browserHistoryApiWrappers) === null || _a === void 0 ? void 0 : _a.replace) {
-            this.browserHistoryApiWrappers.replace(url, stateWithPageId);
-        }
-        else {
-            window.history.replaceState(stateWithPageId, '', url);
-        }
-    }
-    // eslint-disable-next-line class-methods-use-this -- удобней использовать метод в контексте экземпляра.
-    createStateWithPageId(state, pageId) {
-        const isPlainObject = (v) => v !== null && v !== undefined && typeof v === 'object' && !Array.isArray(v);
-        return Object.assign(Object.assign({}, (isPlainObject(state) ? state : {})), { [query_and_headers_keys_1.HISTORY_STATE_KEY_B2N_PAGE_ID]: pageId });
-    }
-    setHistoryStatePageId() {
-        var _a;
-        const pageId = this.nativeHistoryStack.length;
-        const newState = this.createStateWithPageId(window.history.state, pageId);
-        if ((_a = this.browserHistoryApiWrappers) === null || _a === void 0 ? void 0 : _a.replace) {
-            this.browserHistoryApiWrappers.replace(undefined, newState);
-        }
-        else {
-            window.history.replaceState(newState, '');
-        }
-    }
     /**
      * Метод, вычисляющий `pageId`, который нужно послать в NA
      * для правильной синхронизации с кнопкой "Назад". Также вычисляет `pageTitle`
@@ -166,8 +150,9 @@ class NativeNavigationAndTitleService {
             this.nativeHistoryStack = this.nativeHistoryStack.slice(0, statePageId);
         }
         else {
-            this.nativeHistoryStack = this.nativeHistoryStack.slice(0, -1);
+            this.nativeHistoryStack = this.nativeHistoryStack.slice(0, -this.numOfBackSteps);
         }
+        this.numOfBackSteps = 1;
         if (this.nativeHistoryStack.length < 1) {
             (0, close_webview_util_1.closeWebviewUtil)();
             return;
@@ -179,11 +164,6 @@ class NativeNavigationAndTitleService {
     hasSavedHistoryStack() {
         return sessionStorage.getItem(query_and_headers_keys_1.SS_KEY_BRIDGE_TO_NATIVE_HISTORY_STACK) !== null;
     }
-    /**
-     * Инициализирует `nativeHistoryStack`.
-     *
-     * Подробное описание каждого сценария см. в {@link ./NAVIGATION_SCENARIOS.md}.
-     */
     initializeNativeHistoryStack() {
         var _a;
         const { nextPageId, title } = this.nativeParamsService;
@@ -191,15 +171,7 @@ class NativeNavigationAndTitleService {
         const statePageId = (_a = window.history.state) === null || _a === void 0 ? void 0 : _a[query_and_headers_keys_1.HISTORY_STATE_KEY_B2N_PAGE_ID];
         try {
             if (typeof statePageId === 'number') {
-                const pageId = statePageId;
-                if (hasSS) {
-                    const savedStack = this.readSavedHistoryStack();
-                    this.nativeHistoryStack = savedStack.slice(0, pageId);
-                    this.nativeHistoryStack[this.nativeHistoryStack.length - 1] = title;
-                }
-                else {
-                    this.nativeHistoryStack = [title];
-                }
+                this.nativeHistoryStack = this.initializeForBackward(statePageId, title);
             }
             else if (nextPageId && !hasSS) {
                 this.nativeHistoryStack = this.initializeForNewOrigin(nextPageId, title);
@@ -218,6 +190,15 @@ class NativeNavigationAndTitleService {
         this.syncHistoryWithNative();
         this.setHistoryStatePageId();
     }
+    initializeForBackward(pageId, title) {
+        if (!this.hasSavedHistoryStack()) {
+            return [title];
+        }
+        const savedStack = this.readSavedHistoryStack();
+        const stack = savedStack.slice(0, pageId);
+        stack[stack.length - 1] = title;
+        return stack;
+    }
     // eslint-disable-next-line class-methods-use-this -- удобней использовать метод в контексте экземпляра.
     initializeForNewOrigin(nextPageId, title) {
         const stack = new Array(nextPageId).fill(NativeHistoryStackStub);
@@ -237,26 +218,6 @@ class NativeNavigationAndTitleService {
         stack[stack.length - 1] = title;
         return stack;
     }
-    /**
-     * Читает и парсит `nativeHistoryStack` из SessionStorage.
-     * При ошибке чтения или парсинга логирует через `logError` и пробрасывает исключение.
-     */
-    readSavedHistoryStack() {
-        const serialized = sessionStorage.getItem(query_and_headers_keys_1.SS_KEY_BRIDGE_TO_NATIVE_HISTORY_STACK);
-        try {
-            if (!serialized) {
-                throw new Error(`${query_and_headers_keys_1.SS_KEY_BRIDGE_TO_NATIVE_HISTORY_STACK} sessionStorage expected not to be null`);
-            }
-            return JSON.parse(serialized);
-        }
-        catch (e) {
-            if (this.logError) {
-                this.logError(`Клиентский код B2N не смог получить ${query_and_headers_keys_1.SS_KEY_BRIDGE_TO_NATIVE_HISTORY_STACK} из sessionStorage
-                    Могут возникнуть проблемы с кнопкой «Назад» в NA.`, e);
-            }
-            throw e;
-        }
-    }
     /**
      * Подготавливает ссылку для корректного перехода server-side навигацией.
      *
@@ -282,8 +243,25 @@ class NativeNavigationAndTitleService {
         return modifiedUrl;
     }
     /**
-     * Сохраняет `nativeHistoryStack` в SessionStorage.
+     * Читает и парсит `nativeHistoryStack` из SessionStorage.
+     * При ошибке чтения или парсинга логирует через `logError` и пробрасывает исключение.
      */
+    readSavedHistoryStack() {
+        const serialized = sessionStorage.getItem(query_and_headers_keys_1.SS_KEY_BRIDGE_TO_NATIVE_HISTORY_STACK);
+        try {
+            if (!serialized) {
+                throw new Error(`${query_and_headers_keys_1.SS_KEY_BRIDGE_TO_NATIVE_HISTORY_STACK} sessionStorage expected not to be null`);
+            }
+            return JSON.parse(serialized);
+        }
+        catch (e) {
+            if (this.logError) {
+                this.logError(`Клиентский код B2N не смог получить ${query_and_headers_keys_1.SS_KEY_BRIDGE_TO_NATIVE_HISTORY_STACK} из sessionStorage
+                    Могут возникнуть проблемы с кнопкой «Назад» в NA.`, e);
+            }
+            throw e;
+        }
+    }
     saveNativeHistoryStack() {
         const serializedNativeHistoryStack = JSON.stringify(this.nativeHistoryStack);
         sessionStorage.setItem(query_and_headers_keys_1.SS_KEY_BRIDGE_TO_NATIVE_HISTORY_STACK, serializedNativeHistoryStack);
@@ -313,5 +291,20 @@ class NativeNavigationAndTitleService {
             }
         }
     }
+    setHistoryStatePageId(useNextPageId = false) {
+        const pageId = useNextPageId
+            ? this.nativeHistoryStack.length + 1
+            : this.nativeHistoryStack.length;
+        const newState = this.createStateWithPageId(window.history.state, pageId);
+        // `b2n-pageId` всегда записывается на верхний уровень через нативный `replaceState`,
+        // а не через wrapper, чтобы wrapper (например, React Router / history) не мог обернуть
+        // его внутрь своего формата и скрыть от B2N при чтении `history.state`.
+        window.history.replaceState(newState, '');
+    }
+    // eslint-disable-next-line class-methods-use-this -- удобней использовать метод в контексте экземпляра.
+    createStateWithPageId(state, pageId) {
+        const isPlainObject = (v) => v !== null && v !== undefined && typeof v === 'object' && !Array.isArray(v);
+        return Object.assign(Object.assign({}, (isPlainObject(state) ? state : {})), { [query_and_headers_keys_1.HISTORY_STATE_KEY_B2N_PAGE_ID]: pageId });
+    }
 }
 exports.NativeNavigationAndTitleService = NativeNavigationAndTitleService;

package/package.json

@@ -1,121 +1,121 @@
 {
-  "name": "@alfalab/bridge-to-native",
-  "version": "1.3.2-beta.b39ff6d",
-  "license": "MIT",
-  "description": "Утилита для удобной работы веб приложения внутри нативного приложения и коммуникации с ним.",
-  "engines": {
-    "node": ">=20.19.2",
-    "npm": "please-use-yarn"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/core-ds/bridge-to-native.git"
-  },
-  "exports": {
-    "./client": {
-      "import": "./client/index.js",
-      "require": "./client/index.js",
-      "types": "./client/index.d.ts"
+    "name": "@alfalab/bridge-to-native",
+    "version": "1.4.0",
+    "license": "MIT",
+    "description": "Утилита для удобной работы веб приложения внутри нативного приложения и коммуникации с ним.",
+    "engines": {
+        "node": ">=20.19.2",
+        "npm": "please-use-yarn"
     },
-    "./server": {
-      "import": "./server/index.js",
-      "require": "./server/index.js",
-      "types": "./server/index.d.ts"
-    }
-  },
-  "sideEffects": false,
-  "bugs": {
-    "url": "https://github.com/core-ds/bridge-to-native/issues"
-  },
-  "scripts": {
-    "build": "yarn build:clean && yarn build:ts",
-    "build:clean": "shx rm -rf .publish",
-    "build:copy-package-json": "shx cp package.json .publish/package.json",
-    "build:ts": "tsc --build",
-    "format": "arui-presets-lint format",
-    "format:check": "arui-presets-lint format:check",
-    "lint": "yarn lint:scripts && yarn format:check",
-    "lint:fix": "yarn lint:scripts --fix && yarn format",
-    "lint:scripts": "arui-presets-lint scripts",
-    "pub": "npm publish .publish --userconfig \"../.npmrc\" --tag \"$TAG\"",
-    "release": "yarn build && yarn build:copy-package-json && yarn pub",
-    "test": "arui-scripts test --silent --collect-coverage"
-  },
-  "devDependencies": {
-    "@happy-dom/jest-environment": "18.0.1",
-    "@types/jest": "29.5.14",
-    "@types/node": "20.19.1",
-    "arui-presets-lint": "8.7.0",
-    "arui-scripts": "19.0.7",
-    "copyfiles": "2.4.1",
-    "jest-junit": "10.0.0",
-    "lint-staged": "^12.5.0",
-    "promisify-child-process": "4.1.1",
-    "shx": "0.3.4",
-    "typescript": "5.5.4"
-  },
-  "commitlint": {
-    "extends": "./node_modules/arui-presets-lint/commitlint"
-  },
-  "eslintConfig": {
-    "extends": "./node_modules/arui-presets-lint/eslint",
-    "parserOptions": {
-      "project": [
-        "./__tests__/tsconfig.json",
-        "./src/client/tsconfig.json",
-        "./src/server/tsconfig.json"
-      ]
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/core-ds/bridge-to-native.git"
     },
-    "overrides": [
-      {
-        "files": [
-          "__tests__/**/*"
-        ],
-        "rules": {
-          "max-lines": "off"
+    "exports": {
+        "./client": {
+            "import": "./client/index.js",
+            "require": "./client/index.js",
+            "types": "./client/index.d.ts"
+        },
+        "./server": {
+            "import": "./server/index.js",
+            "require": "./server/index.js",
+            "types": "./server/index.d.ts"
         }
-      }
-    ]
-  },
-  "jest": {
-    "projects": [
-      {
-        "displayName": "client-tests",
-        "testEnvironment": "@happy-dom/jest-environment",
-        "testPathIgnorePatterns": [
-          "/__tests__/server/"
+    },
+    "sideEffects": false,
+    "bugs": {
+        "url": "https://github.com/core-ds/bridge-to-native/issues"
+    },
+    "scripts": {
+        "build": "yarn build:clean && yarn build:ts",
+        "build:clean": "shx rm -rf .publish",
+        "build:copy-package-json": "shx cp package.json .publish/package.json",
+        "build:ts": "tsc --build",
+        "format": "arui-presets-lint format",
+        "format:check": "arui-presets-lint format:check",
+        "lint": "yarn lint:scripts && yarn format:check",
+        "lint:fix": "yarn lint:scripts --fix && yarn format",
+        "lint:scripts": "arui-presets-lint scripts",
+        "pub": "npm publish .publish --userconfig \"../.npmrc\" --tag \"$TAG\"",
+        "release": "yarn build && yarn build:copy-package-json && yarn pub",
+        "test": "arui-scripts test --silent --collect-coverage"
+    },
+    "devDependencies": {
+        "@happy-dom/jest-environment": "18.0.1",
+        "@types/jest": "29.5.14",
+        "@types/node": "20.19.1",
+        "arui-presets-lint": "8.7.0",
+        "arui-scripts": "19.0.7",
+        "copyfiles": "2.4.1",
+        "jest-junit": "10.0.0",
+        "lint-staged": "^12.5.0",
+        "promisify-child-process": "4.1.1",
+        "shx": "0.3.4",
+        "typescript": "5.5.4"
+    },
+    "commitlint": {
+        "extends": "./node_modules/arui-presets-lint/commitlint"
+    },
+    "eslintConfig": {
+        "extends": "./node_modules/arui-presets-lint/eslint",
+        "parserOptions": {
+            "project": [
+                "./__tests__/tsconfig.json",
+                "./src/client/tsconfig.json",
+                "./src/server/tsconfig.json"
+            ]
+        },
+        "overrides": [
+            {
+                "files": [
+                    "__tests__/**/*"
+                ],
+                "rules": {
+                    "max-lines": "off"
+                }
+            }
+        ]
+    },
+    "jest": {
+        "projects": [
+            {
+                "displayName": "client-tests",
+                "testEnvironment": "@happy-dom/jest-environment",
+                "testPathIgnorePatterns": [
+                    "/__tests__/server/"
+                ]
+            },
+            {
+                "displayName": "server-tests",
+                "testEnvironment": "node",
+                "testPathIgnorePatterns": [
+                    "/__tests__/client/"
+                ]
+            }
+        ],
+        "testRegex": [
+            "__tests__/.*\\.test\\.ts"
+        ],
+        "coveragePathIgnorePatterns": [
+            "/node_modules/",
+            "/src/(client|server)/index.ts"
+        ],
+        "reporters": [
+            "default",
+            "jest-junit"
         ]
-      },
-      {
-        "displayName": "server-tests",
-        "testEnvironment": "node",
-        "testPathIgnorePatterns": [
-          "/__tests__/client/"
+    },
+    "prettier": "arui-presets-lint/prettier",
+    "stylelint": {
+        "extends": "arui-presets-lint/stylelint",
+        "ignoreFiles": [
+            "coverage/**/*.js",
+            ".yarn/releases/*"
         ]
-      }
-    ],
-    "testRegex": [
-      "__tests__/.*\\.test\\.ts"
-    ],
-    "coveragePathIgnorePatterns": [
-      "/node_modules/",
-      "/src/(client|server)/index.ts"
-    ],
-    "reporters": [
-      "default",
-      "jest-junit"
-    ]
-  },
-  "prettier": "arui-presets-lint/prettier",
-  "stylelint": {
-    "extends": "arui-presets-lint/stylelint",
-    "ignoreFiles": [
-      "coverage/**/*.js",
-      ".yarn/releases/*"
-    ]
-  },
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org"
-  },
-  "packageManager": "yarn@4.12.0"
+    },
+    "publishConfig": {
+        "registry": "https://registry.npmjs.org"
+    },
+    "packageManager": "yarn@4.12.0"
 }

package/query-and-headers-keys.d.ts

@@ -1,7 +1,6 @@
 export declare const HEADER_KEY_COOKIE = "cookie";
 export declare const HEADER_KEY_USER_AGENT = "user-agent";
 export declare const COOKIE_KEY_BRIDGE_TO_NATIVE_DATA = "bridgeToNativeData";
-export declare const COOKIE_KEY_BRIDGE_TO_NATIVE_RELOAD = "bridgeToNativeReload";
 export declare const HEADER_KEY_NATIVE_APPVERSION = "app-version";
 export declare const HEADER_KEY_WV_LAUNCH_TIME = "webview-launch-time";
 export declare const HISTORY_STATE_KEY_B2N_PAGE_ID = "b2n-pageId";

package/query-and-headers-keys.js

@@ -3,7 +3,7 @@
  * Ключи стандартных заголовков.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SS_KEY_BRIDGE_TO_NATIVE_HISTORY_STACK = exports.QUERY_NATIVE_THEME = exports.QUERY_NATIVE_IOS_APPVERSION = exports.QUERY_NATIVE_IOS_APPID = exports.QUERY_B2N_TITLE_DEPRECATED = exports.QUERY_B2N_TITLE = exports.QUERY_B2N_NEXT_PAGEID = exports.HISTORY_STATE_KEY_B2N_PAGE_ID = exports.HEADER_KEY_WV_LAUNCH_TIME = exports.HEADER_KEY_NATIVE_APPVERSION = exports.COOKIE_KEY_BRIDGE_TO_NATIVE_RELOAD = exports.COOKIE_KEY_BRIDGE_TO_NATIVE_DATA = exports.HEADER_KEY_USER_AGENT = exports.HEADER_KEY_COOKIE = void 0;
+exports.SS_KEY_BRIDGE_TO_NATIVE_HISTORY_STACK = exports.QUERY_NATIVE_THEME = exports.QUERY_NATIVE_IOS_APPVERSION = exports.QUERY_NATIVE_IOS_APPID = exports.QUERY_B2N_TITLE_DEPRECATED = exports.QUERY_B2N_TITLE = exports.QUERY_B2N_NEXT_PAGEID = exports.HISTORY_STATE_KEY_B2N_PAGE_ID = exports.HEADER_KEY_WV_LAUNCH_TIME = exports.HEADER_KEY_NATIVE_APPVERSION = exports.COOKIE_KEY_BRIDGE_TO_NATIVE_DATA = exports.HEADER_KEY_USER_AGENT = exports.HEADER_KEY_COOKIE = void 0;
 exports.HEADER_KEY_COOKIE = 'cookie';
 exports.HEADER_KEY_USER_AGENT = 'user-agent';
 /*
@@ -11,26 +11,25 @@ exports.HEADER_KEY_USER_AGENT = 'user-agent';
  */
 // Ключ cookie, с помощью которого серверная часть B2N передаст на клиент информацию об NA.
 exports.COOKIE_KEY_BRIDGE_TO_NATIVE_DATA = 'bridgeToNativeData';
-// Ключ cookie, указывающий, что запрос выполнен после вызова `bridgeToNative.reload()`.
-// Используется для предотвращения перезаписи cookie bridgeToNativeData, чтобы сохранить
-// актуальные параметры нативного приложения
-exports.COOKIE_KEY_BRIDGE_TO_NATIVE_RELOAD = 'bridgeToNativeReload';
-// Нативное приложение на обеих платформах подмешивает этот заголовок к запросу за HTML.
+// NA на обеих платформах подмешивает этот заголовок к запросу за HTML.
 // TODO:
 // * Исследовать, делает ли оно это при запросах к прочим ресурсам;
 // * Есть подозрение на некоторую нестабильность — возможно делает это
 //  только для первого документа в вебвью-сессии. Исследовать.
 exports.HEADER_KEY_NATIVE_APPVERSION = 'app-version';
-// Ключ заголовка, в котором передается время старта открытия WV экрана в формате timestamp
+// Ключ заголовка, в котором NA передаёт время старта открытия WV экрана в формате timestamp.
 exports.HEADER_KEY_WV_LAUNCH_TIME = 'webview-launch-time';
-// Ключ в history.state, хранящий текущий pageId для корректной back-навигации.
+// Ключ в history.state, который B2N использует для хранения текущего `pageId`
+// чтобы иметь возможность корректно синхронизироваться с NA после back-навигации.
 exports.HISTORY_STATE_KEY_B2N_PAGE_ID = 'b2n-pageId';
 // Флаг, предписывающий клиентскому коду B2N начать связь
 // с нативным приложением с указанного в этом параметре id, а не с 1.
-// Необходимо для server-side навигации.
+// Необходимо для server-side (hard) навигации.
 exports.QUERY_B2N_NEXT_PAGEID = 'b2n-next-page-id';
-// Query-параметр, с помощью которого можно передать начальное значение
+// Query-параметр, который можно подмешать к URL в диплинке на открытие WV,
+// и с помощью которого можно передать начальное значение
 // для нативного заголовка — в область, которую не рендерит веб.
+// Также некоторые методы навигации B2N используют эту сущность.
 exports.QUERY_B2N_TITLE = 'b2n-title';
 // Deprecated вариант query-параметра 'b2n-title'
 // (т.к. `title` часто может использоваться самим веб-приложением).
@@ -38,18 +37,18 @@ exports.QUERY_B2N_TITLE = 'b2n-title';
 exports.QUERY_B2N_TITLE_DEPRECATED = 'title';
 // NA на iOS передаёт в этом параметре схему,
 // под которым оно зарегистрировано в OS.
-// Известные проблемы:
-// * В старых версиях отсутствует, клиентский код использует хардкод (см. `src/client/constants.ts`);
-// * В тестовых сборках часто нарушена связь!!! Между фактической схемой
-//  и схемой, которая приходит в этом параметре.
-//  Нужно просить iOS разработчика собрать сборку нормально.
+// Некоторые особенности:
+// * В старых версиях отсутствует, клиентский код использует хардкод
+// (см. `VERSION_TO_IOS_APP_ID` в `src/client/constants.ts`);
+// * Тестить WV на iOS надо на группе «B»!!! Иначе NA будет присылать в WA неверную схему,
+//   что приведёт к неработоспособности методов, связанных с передачей диплинков в NA.
+// * В сборках для Симулятора, схема всегда `aweassist`.
 exports.QUERY_NATIVE_IOS_APPID = 'applicationId';
-// Исторически NA на iOS передаёт в этом параметре свою версию.
-// B2N сознательно переиспользует этот query и для server-side переходов в Android,
+// NA на iOS передаёт в этом параметре свою версию.
+// B2N сознательно переиспользует этот query и для server-side (hard) переходов в Android,
 // чтобы не вводить отдельный служебный параметр только для переноса версии между WA.
 exports.QUERY_NATIVE_IOS_APPVERSION = 'device_app_version';
 // NA на обеих платформах в этом параметре передаёт активную тему (светлая/тёмная).
 exports.QUERY_NATIVE_THEME = 'theme';
-// Ключ sesseionStorage, с помощью которого клиентская часть B2N сохраняет своё состояние
-// при server-side навигации.
+// Ключ sessionStorage,в котором клиентская часть B2N сохраняет состояние синхронизации с NA.
 exports.SS_KEY_BRIDGE_TO_NATIVE_HISTORY_STACK = 'bridgeToNativeHistoryStack';

package/server/prepare-native-app-details-for-client.js

@@ -19,21 +19,9 @@ const utils_1 = require("./utils");
 function prepareNativeAppDetailsForClient(request, setResponseHeader) {
     // Поскольку вебвью модули имеют особенность сохранять сессионную куку подолгу,
     // даже после перезагрузки устройства или обновления приложения/ОС, ее значение
-    // актуализируется при каждом запросе на сервер. Исключением является вызов `reload()`.
-    // В этом случае функция возвращает объект с параметрами, полученными из
-    // ранее сохраненной куки, но перезаписываться кука не будет, потому что:
-    // 1) Данных NA в запросе с большой вероятностью не будет;
-    // 2) клиентская сторона сохранит всё, что нужно в SessionStorage
+    // актуализируется при каждом запросе на сервер.
     const cookieHeader = (0, utils_1.getHeaderValue)(request, query_and_headers_keys_1.HEADER_KEY_COOKIE);
     const nativeParamsFromCookie = (0, utils_1.readNativeParamsFromCookie)(cookieHeader);
-    const hasReloadFlag = cookieHeader?.includes(`${query_and_headers_keys_1.COOKIE_KEY_BRIDGE_TO_NATIVE_RELOAD}=true`);
-    if (hasReloadFlag) {
-        setResponseHeader('Set-Cookie', `${query_and_headers_keys_1.COOKIE_KEY_BRIDGE_TO_NATIVE_RELOAD}=false; Max-Age=0; Path=/`);
-        if (nativeParamsFromCookie) {
-            return nativeParamsFromCookie;
-        }
-        return buildNativeParams(request);
-    }
     const nativeParams = buildNativeParams(request, nativeParamsFromCookie);
     const serializedNativeParams = encodeURIComponent(JSON.stringify(nativeParams));
     setResponseHeader('Set-Cookie', `${query_and_headers_keys_1.COOKIE_KEY_BRIDGE_TO_NATIVE_DATA}=${serializedNativeParams}; Path=/`);