@alfalab/bridge-to-native 1.0.0 → 1.0.1

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

@@ -79,6 +79,8 @@ class NativeNavigationAndTitleService {
     reload() {
         this.nativeHistoryStack.push(1 /* NativeHistoryStackSpecialValues.TemporaryReloadStub */); // небольшой костыль, чтобы переиспользовать server-side сценарий
         this.saveNativeHistoryStack();
+        // информация для серверной стороны B2N, что происходит `reload` и парсить запрос на предмет NA параметров не нужно (в нем их скорее всего не будет)
+        document.cookie = `${query_and_headers_keys_1.COOKIE_KEY_BRIDGE_TO_NATIVE_RELOAD}=true; Path=/`;
     }
     setInitialView(nativeTitle = '') {
         this.nativeHistoryStack = [nativeTitle];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@alfalab/bridge-to-native",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "license": "MIT",
     "description": "Утилита для удобной работы веб приложения внутри нативного приложения и коммуникации с ним.",
     "engines": {

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

@@ -1,6 +1,7 @@
 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 QUERY_B2N_NEXT_PAGEID = "b2n-next-page-id";
 export declare const QUERY_B2N_TITLE = "b2n-title";

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.HEADER_KEY_NATIVE_APPVERSION = 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.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.HEADER_KEY_COOKIE = 'cookie';
 exports.HEADER_KEY_USER_AGENT = 'user-agent';
 /*
@@ -11,6 +11,10 @@ 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.
 // TODO:
 // * Исследовать, делает ли оно это при запросах к прочим ресурсам;

package/server/is-webview-env.js

@@ -11,7 +11,8 @@ const utils_1 = require("./utils");
  */
 function isWebviewEnv(request) {
     // Выставленная ранее кука — однозначный индикатор вебвью окружения.
-    if ((0, utils_1.hasBridgeToNativeDataCookie)(request)) {
+    const cookieHeader = (0, utils_1.getHeaderValue)(request, query_and_headers_keys_1.HEADER_KEY_COOKIE);
+    if ((0, utils_1.hasBridgeToNativeDataCookie)(cookieHeader)) {
         return true;
     }
     const appVersion = (0, utils_1.getHeaderValue)(request, query_and_headers_keys_1.HEADER_KEY_NATIVE_APPVERSION);

package/server/prepare-native-app-details-for-client.d.ts

@@ -1,3 +1,4 @@
+import { type NativeParams } from '../types';
 import { type UniversalRequest } from './types';
 /**
  * Парсит запрос, доставая из него данные о нативном приложении,
@@ -10,4 +11,4 @@ import { type UniversalRequest } from './types';
  *  Нужно передать функцию, которая средствами используемого веб-сервера добавит заголовок в ответ.
  *  b2native с её помощью добавит `Set-Cookie` заголовок с некоторыми данными для своего клиентского кода.
  */
-export declare function prepareNativeAppDetailsForClient(request: UniversalRequest, setResponseHeader: (headerKey: string, headerValue: string) => void): void;
+export declare function prepareNativeAppDetailsForClient(request: UniversalRequest, setResponseHeader: (headerKey: string, headerValue: string) => void): Partial<NativeParams>;

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

@@ -17,17 +17,27 @@ const utils_1 = require("./utils");
  *  b2native с её помощью добавит `Set-Cookie` заголовок с некоторыми данными для своего клиентского кода.
  */
 function prepareNativeAppDetailsForClient(request, setResponseHeader) {
-    // Если кука с данными о нативном приложении уже есть, информация уже собрана,
-    // делать больше ничего не нужно.
-    // Возможна смена темы нативного приложения (светлая/тёмная) во время вебвью-сессии.
-    // Но веб об этом не узнает, т.к. нативное приложение сообщает об этом
-    // только при старте нового вебвью.
-    if ((0, utils_1.hasBridgeToNativeDataCookie)(request)) {
-        return;
-    }
+    // Проверяем наличие куки bridgeToNativeData в запросе. Если куки нет — устанавливаем её.
+    // Также сверяем тему из query-параметров с темой, сохранённой в куке, потому что
+    // при повторном открытии WebView сессионная кука может сохраниться, и если тема приложения
+    // изменилась между сессиями, WebView и нативное приложение будут не синхронизированы.
+    // В таком случае обновляем куку актуальными данными из query-параметров
+    // Для случая когда передан флаг `reload` куку перезаписывать не нужно, потому что:
+    // 1) Данных NA в запросе с большой вероятностью не будет;
+    // 2) клиентская сторона сохранит всё, что нужно в SessionStorage
+    const cookieHeader = (0, utils_1.getHeaderValue)(request, query_and_headers_keys_1.HEADER_KEY_COOKIE);
     const nativeParams = parseRequest(request);
-    const serializedNativeParams = encodeURIComponent(JSON.stringify(nativeParams));
-    setResponseHeader('Set-Cookie', `${query_and_headers_keys_1.COOKIE_KEY_BRIDGE_TO_NATIVE_DATA}=${serializedNativeParams}`);
+    const hasReloadFlag = cookieHeader?.includes(`${query_and_headers_keys_1.COOKIE_KEY_BRIDGE_TO_NATIVE_RELOAD}=true`);
+    const shouldUpdateCookie = !(0, utils_1.hasBridgeToNativeDataCookie)(cookieHeader) || !isSameTheme(request, cookieHeader);
+    if (!hasReloadFlag && shouldUpdateCookie) {
+        const serializedNativeParams = encodeURIComponent(JSON.stringify(nativeParams));
+        setResponseHeader('Set-Cookie', `${query_and_headers_keys_1.COOKIE_KEY_BRIDGE_TO_NATIVE_DATA}=${serializedNativeParams}; Path=/`);
+        return nativeParams;
+    }
+    if (hasReloadFlag) {
+        setResponseHeader('Set-Cookie', `${query_and_headers_keys_1.COOKIE_KEY_BRIDGE_TO_NATIVE_RELOAD}=false; Max-Age=0; Path=/`);
+    }
+    return nativeParams;
 }
 function parseRequest(request) {
     // Прихраним «сервисные» query-параметры от нативного приложения,
@@ -76,3 +86,18 @@ function parseRequest(request) {
     }
     return nativeParams;
 }
+// Возвращает результат сравнения темы полученной, из query-параметров
+// с темой, полученной из cookie
+function isSameTheme(request, cookies) {
+    if (!cookies)
+        return false;
+    const [themeFromQuery] = (0, utils_1.getQueryValues)(request, [query_and_headers_keys_1.QUERY_NATIVE_THEME]);
+    const parsedCookies = (0, utils_1.parseCookies)(cookies);
+    const bridgeCookie = parsedCookies[query_and_headers_keys_1.COOKIE_KEY_BRIDGE_TO_NATIVE_DATA];
+    try {
+        return JSON.parse(bridgeCookie || '{}').theme === themeFromQuery;
+    }
+    catch (_) {
+        return false;
+    }
+}

package/server/utils.d.ts

@@ -21,4 +21,5 @@ export declare function getQueryValues(request: UniversalRequest, queryKeys: str
  *
  * @param request Объект запроса (Request или IncomingMessage).
  */
-export declare function hasBridgeToNativeDataCookie(request: UniversalRequest): boolean;
+export declare function hasBridgeToNativeDataCookie(cookieHeader: string | null): boolean;
+export declare function parseCookies(cookieHeader: string): Record<string, string>;

package/server/utils.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getHeaderValue = getHeaderValue;
 exports.getQueryValues = getQueryValues;
 exports.hasBridgeToNativeDataCookie = hasBridgeToNativeDataCookie;
-const query_and_headers_keys_1 = require("../query-and-headers-keys");
+exports.parseCookies = parseCookies;
 const regexp_patterns_1 = require("./regexp-patterns");
 /**
  * На основе объекта запроса любого типа возвращает
@@ -38,7 +38,16 @@ function getQueryValues(request, queryKeys) {
  *
  * @param request Объект запроса (Request или IncomingMessage).
  */
-function hasBridgeToNativeDataCookie(request) {
-    const cookies = getHeaderValue(request, query_and_headers_keys_1.HEADER_KEY_COOKIE);
-    return Boolean(cookies && regexp_patterns_1.bridgeToNativeDataCookieExistencePattern.test(cookies));
+function hasBridgeToNativeDataCookie(cookieHeader) {
+    return Boolean(cookieHeader && regexp_patterns_1.bridgeToNativeDataCookieExistencePattern.test(cookieHeader));
+}
+function parseCookies(cookieHeader) {
+    return cookieHeader.split(';').reduce((acc, part) => {
+        const [key, ...rest] = part.split('=');
+        const trimmedKey = key.trim();
+        if (!trimmedKey)
+            return acc;
+        acc[trimmedKey] = decodeURIComponent(rest.join('=').trim());
+        return acc;
+    }, {});
 }