@alfalab/bridge-to-native 1.1.0 → 1.2.1

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

@@ -46,6 +46,10 @@ export declare class BridgeToNative {
      * Тема (светлая/тёмная), в котором работает NA.
      */
     get theme(): import("./types").Theme;
+    /**
+     * Время старта открытия WV экрана в формате timestamp. Значение никак не меняется в процессе всей жизни WV экрана.
+     */
+    get webviewLaunchTime(): number | null;
     /**
      * Метод, проверяющий, можно ли использовать ли указанную функциональность
      * в текущей версии NA.

package/client/bridge-to-native.js

@@ -62,6 +62,12 @@ class BridgeToNative {
     get theme() {
         return this.nativeParamsService.theme;
     }
+    /**
+     * Время старта открытия WV экрана в формате timestamp. Значение никак не меняется в процессе всей жизни WV экрана.
+     */
+    get webviewLaunchTime() {
+        return this.nativeParamsService.webviewLaunchTime;
+    }
     /**
      * Метод, проверяющий, можно ли использовать ли указанную функциональность
      * в текущей версии NA.

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

@@ -15,6 +15,7 @@ export declare class NativeParamsService {
     originalWebviewParams: string | null;
     theme: Theme;
     title: string;
+    webviewLaunchTime: number | null;
     constructor(logError?: LogError | undefined);
     canUseNativeFeature(feature: NativeFeatureKey): boolean;
     isCurrentVersionHigherOrEqual(versionToCompare: string): boolean;

package/client/services-and-utils/native-params-service.js

@@ -21,6 +21,7 @@ class NativeParamsService {
         this.originalWebviewParams = (nativeParams === null || nativeParams === void 0 ? void 0 : nativeParams.originalWebviewParams) || null;
         this.theme = (nativeParams === null || nativeParams === void 0 ? void 0 : nativeParams.theme) === 'dark' ? 'dark' : 'light';
         this.title = (nativeParams === null || nativeParams === void 0 ? void 0 : nativeParams.title) || '';
+        this.webviewLaunchTime = (nativeParams === null || nativeParams === void 0 ? void 0 : nativeParams.webviewLaunchTime) || null;
     }
     canUseNativeFeature(feature) {
         const { fromVersion } = constants_1.NATIVE_FEATURES_FROM_VERSION[this.environment][feature];

package/package.json

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

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

@@ -3,6 +3,7 @@ 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 QUERY_B2N_NEXT_PAGEID = "b2n-next-page-id";
 export declare const QUERY_B2N_TITLE = "b2n-title";
 export declare const QUERY_B2N_TITLE_DEPRECATED = "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_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.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.HEADER_KEY_COOKIE = 'cookie';
 exports.HEADER_KEY_USER_AGENT = 'user-agent';
 /*
@@ -21,6 +21,8 @@ exports.COOKIE_KEY_BRIDGE_TO_NATIVE_RELOAD = 'bridgeToNativeReload';
 // * Есть подозрение на некоторую нестабильность — возможно делает это
 //  только для первого документа в вебвью-сессии. Исследовать.
 exports.HEADER_KEY_NATIVE_APPVERSION = 'app-version';
+// Ключ заголовка, в котором передается время старта открытия WV экрана в формате timestamp
+exports.HEADER_KEY_WV_LAUNCH_TIME = 'webview-launch-time';
 // Флаг, предписывающий клиентскому коду B2N начать связь
 // с нативным приложением с указанного в этом параметре id, а не с 1.
 // Необходимо для server-side навигации.

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

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

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

@@ -17,26 +17,30 @@ const utils_1 = require("./utils");
  *  b2native с её помощью добавит `Set-Cookie` заголовок с некоторыми данными для своего клиентского кода.
  */
 function prepareNativeAppDetailsForClient(request, setResponseHeader) {
-    // Проверяем наличие куки bridgeToNativeData в запросе. Если куки нет — устанавливаем её.
-    // Также сверяем тему из query-параметров с темой, сохранённой в куке, потому что
-    // при повторном открытии WebView сессионная кука может сохраниться, и если тема приложения
-    // изменилась между сессиями, WebView и нативное приложение будут не синхронизированы.
-    // В таком случае обновляем куку актуальными данными из query-параметров
-    // Для случая когда передан флаг `reload` куку перезаписывать не нужно, потому что:
+    // Поскольку вебвью модули имеют особенность сохранять сессионную куку подолгу,
+    // даже после перезагрузки устройства или обновления приложения/ОС, ее значение
+    // актуализируется при каждом запросе на сервер. Исключением является вызов `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 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=/`);
+        const cookieData = (0, utils_1.getBridgeToNativeDataCookie)(cookieHeader);
+        if (cookieData) {
+            try {
+                return JSON.parse(decodeURIComponent(cookieData));
+            }
+            catch {
+                return parseRequest(request);
+            }
+        }
     }
+    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}; Path=/`);
     return nativeParams;
 }
 function parseRequest(request) {
@@ -54,6 +58,7 @@ function parseRequest(request) {
         query_and_headers_keys_1.QUERY_B2N_TITLE_DEPRECATED,
     ]);
     const appVersionFromHeaders = (0, utils_1.getHeaderValue)(request, query_and_headers_keys_1.HEADER_KEY_NATIVE_APPVERSION);
+    const webviewLaunchTime = (0, utils_1.parseHeaderTimestamp)((0, utils_1.getHeaderValue)(request, query_and_headers_keys_1.HEADER_KEY_WV_LAUNCH_TIME));
     const nativeParams = {
         originalWebviewParams,
         theme: theme || 'light',
@@ -84,20 +89,8 @@ function parseRequest(request) {
     else if (typeof deprecatedTitle === 'string') {
         nativeParams.title = deprecatedTitle;
     }
-    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;
+    if (webviewLaunchTime) {
+        nativeParams.webviewLaunchTime = webviewLaunchTime;
     }
+    return nativeParams;
 }

package/server/utils.d.ts

@@ -22,4 +22,15 @@ export declare function getQueryValues(request: UniversalRequest, queryKeys: str
  * @param request Объект запроса (Request или IncomingMessage).
  */
 export declare function hasBridgeToNativeDataCookie(cookieHeader: string | null): boolean;
-export declare function parseCookies(cookieHeader: string): Record<string, string>;
+/**
+ * Преобразует значение из заголовка в timestamp
+ *
+ * @param headerValue Значение заголовка
+ */
+export declare function parseHeaderTimestamp(headerValue: string | number | null): number | null;
+/**
+ * Возвращает значение для нужной куки
+ *
+ * @param cookieName Имя куки
+ */
+export declare const getBridgeToNativeDataCookie: (cookieName: string | null) => string | undefined;

package/server/utils.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBridgeToNativeDataCookie = void 0;
 exports.getHeaderValue = getHeaderValue;
 exports.getQueryValues = getQueryValues;
 exports.hasBridgeToNativeDataCookie = hasBridgeToNativeDataCookie;
-exports.parseCookies = parseCookies;
+exports.parseHeaderTimestamp = parseHeaderTimestamp;
+const query_and_headers_keys_1 = require("../query-and-headers-keys");
 const regexp_patterns_1 = require("./regexp-patterns");
 /**
  * На основе объекта запроса любого типа возвращает
@@ -41,13 +43,33 @@ function getQueryValues(request, queryKeys) {
 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;
-    }, {});
+/**
+ * Преобразует значение из заголовка в timestamp
+ *
+ * @param headerValue Значение заголовка
+ */
+function parseHeaderTimestamp(headerValue) {
+    if (!headerValue || (typeof headerValue === 'string' && !headerValue?.trim()))
+        return null;
+    const timestamp = Number(headerValue);
+    return Number.isFinite(timestamp) ? timestamp : null;
 }
+/**
+ * Возвращает значение для нужной куки
+ *
+ * @param cookieName Имя куки
+ */
+const getBridgeToNativeDataCookie = (cookieName) => {
+    if (!cookieName) {
+        return undefined;
+    }
+    const cookies = cookieName.split(';');
+    for (const cookie of cookies) {
+        const [key, value] = cookie.trim().split('=');
+        if (key === query_and_headers_keys_1.COOKIE_KEY_BRIDGE_TO_NATIVE_DATA) {
+            return value;
+        }
+    }
+    return undefined;
+};
+exports.getBridgeToNativeDataCookie = getBridgeToNativeDataCookie;

package/types.d.ts

@@ -5,4 +5,5 @@ export type NativeParams = {
     theme: string;
     nextPageId: number | null;
     originalWebviewParams: string;
+    webviewLaunchTime?: number;
 };