@alfalab/bridge-to-native 0.0.13-beta-00a10e9 → 0.0.13-beta-024d5c2

package/client/index.d.ts

@@ -0,0 +1,3 @@
+export { BridgeToNative } from './bridge-to-native';
+export { NativeParams, Theme, Environment, NativeFeatureKey, PdfType } from './types';
+export { getNativeParamsFromCookies } from './utils';

package/client/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNativeParamsFromCookies = exports.BridgeToNative = void 0;
+var bridge_to_native_1 = require("./bridge-to-native");
+Object.defineProperty(exports, "BridgeToNative", { enumerable: true, get: function () { return bridge_to_native_1.BridgeToNative; } });
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "getNativeParamsFromCookies", { enumerable: true, get: function () { return utils_1.getNativeParamsFromCookies; } });

package/{types.d.ts → client/types.d.ts}

@@ -1,11 +1,5 @@
-export declare type NativeParams = {
-    appVersion: string;
-    title?: string;
-    iosAppId?: string;
-    theme: string;
-    nextPageId: number | null;
-    originalWebviewParams: string;
-};
+import { NativeParamsType } from "../shared/types";
+export declare type NativeParams = NativeParamsType;
 export declare type NativeFeatureKey = 'geolocation' | 'linksInBrowser';
 declare type NativeFeaturesParams = Readonly<Record<NativeFeatureKey, {
     fromVersion: string;

package/{utils.d.ts → client/utils.d.ts}

@@ -21,3 +21,7 @@ export declare const getUrlInstance: (link: string) => URL;
  */
 export declare const isValidVersionFormat: (version?: string | undefined) => boolean;
 export declare const getAppId: (environment: Environment, iosAppId?: string | undefined) => string | null;
+/**
+ * Возвращает объект с `webview-параметрами` из cookies
+ */
+export declare const getNativeParamsFromCookies: () => Record<string, unknown> | null;

package/{utils.js → client/utils.js}

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAppId = exports.isValidVersionFormat = exports.getUrlInstance = exports.extractAppNameRouteAndQuery = void 0;
+exports.getNativeParamsFromCookies = exports.getAppId = exports.isValidVersionFormat = exports.getUrlInstance = exports.extractAppNameRouteAndQuery = void 0;
 const constants_1 = require("./constants");
+const utils_1 = require("../shared/utils");
 /**
  * Разделяет веб ссылку на компоненты
  * @param route внутренний путь для навигации
@@ -68,3 +69,8 @@ const getAppId = (environment, iosAppId) => {
     return null;
 };
 exports.getAppId = getAppId;
+/**
+ * Возвращает объект с `webview-параметрами` из cookies
+ */
+const getNativeParamsFromCookies = () => (0, utils_1.extractNativeParamsFromCookies)(document.cookie);
+exports.getNativeParamsFromCookies = getNativeParamsFromCookies;

package/index.d.ts

@@ -1,2 +1,2 @@
-export { BridgeToNative } from './bridge-to-native';
-export { NativeParams, Theme, Environment, NativeFeatureKey, PdfType } from './types';
+export * from './client';
+export * from './server';

package/index.js

@@ -1,5 +1,14 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BridgeToNative = void 0;
-var bridge_to_native_1 = require("./bridge-to-native");
-Object.defineProperty(exports, "BridgeToNative", { enumerable: true, get: function () { return bridge_to_native_1.BridgeToNative; } });
+__exportStar(require("./client"), exports);
+__exportStar(require("./server"), exports);

package/package.json

@@ -1,7 +1,7 @@
 {
     "license": "UNLICENSED",
     "name": "@alfalab/bridge-to-native",
-    "version": "0.0.13-beta-00a10e9",
+    "version": "0.0.13-beta-024d5c2",
     "repository": {
         "type": "git",
         "url": "git+https://github.com/core-ds/bridge-to-native.git"
@@ -75,7 +75,7 @@
         ],
         "testPathIgnorePatterns": [
             "/node_modules/",
-            "/test/mock"
+            "/test/.*/mock/"
         ],
         "reporters": [
             "jest-junit",

package/server/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const THEME_QUERY = "theme";
+export declare const TITLE = "title";
+export declare const WEBVIEW_IOS_APP_ID_QUERY = "applicationId";
+export declare const WEBVIEW_IOS_APP_VERSION_QUERY = "device_app_version";
+export declare const WEBVIEW_WITHOUT_LAYOUT_QUERY = "without_layout";
+export declare const WEBVIEW_NEXT_PAGE_ID_QUERY = "nextPageId";
+export declare const NATIVE_PARAMS_COOKIE_NAME = "app_native_params";

package/server/constants.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NATIVE_PARAMS_COOKIE_NAME = exports.WEBVIEW_NEXT_PAGE_ID_QUERY = exports.WEBVIEW_WITHOUT_LAYOUT_QUERY = exports.WEBVIEW_IOS_APP_VERSION_QUERY = exports.WEBVIEW_IOS_APP_ID_QUERY = exports.TITLE = exports.THEME_QUERY = void 0;
+exports.THEME_QUERY = 'theme';
+exports.TITLE = 'title';
+exports.WEBVIEW_IOS_APP_ID_QUERY = 'applicationId';
+exports.WEBVIEW_IOS_APP_VERSION_QUERY = 'device_app_version';
+exports.WEBVIEW_WITHOUT_LAYOUT_QUERY = 'without_layout';
+exports.WEBVIEW_NEXT_PAGE_ID_QUERY = 'nextPageId';
+exports.NATIVE_PARAMS_COOKIE_NAME = 'app_native_params';

package/server/extract-and-join-original-webview-params.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Данная утилита извлекает из запроса все известные
+ * сервисные query параметры которые добавляются к url внутри
+ * webview при первой инициализации и собирает их в query строку.
+ *
+ * @param query - Query в формате объекта
+ * @return строка query параметров в формате: "title=Title&theme=dark..."
+ * */
+export declare const extractAndJoinOriginalWebviewParams: (query: Record<string, string>) => string;

package/server/extract-and-join-original-webview-params.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractAndJoinOriginalWebviewParams = void 0;
+// Словарь всех известных на данный момент сервисных query параметров в webview
+const webviewInitParamsDictionary = [
+    'device_app_version',
+    'device_os_version',
+    'device_boot_time',
+    'device_timezone',
+    'applicationId',
+    'device_app_id',
+    'device_locale',
+    'paySupported',
+    'device_model',
+    'device_uuid',
+    'device_name',
+    'device_id',
+    'client_id',
+    'theme',
+    'scope',
+];
+/**
+ * Данная утилита извлекает из запроса все известные
+ * сервисные query параметры которые добавляются к url внутри
+ * webview при первой инициализации и собирает их в query строку.
+ *
+ * @param query - Query в формате объекта
+ * @return строка query параметров в формате: "title=Title&theme=dark..."
+ * */
+const extractAndJoinOriginalWebviewParams = (query) => {
+    const params = new URLSearchParams();
+    webviewInitParamsDictionary.forEach((key) => {
+        const value = query[key];
+        if (value) {
+            params.set(key, value);
+        }
+    });
+    return params.toString();
+};
+exports.extractAndJoinOriginalWebviewParams = extractAndJoinOriginalWebviewParams;

package/server/extract-native-params.d.ts

@@ -0,0 +1,7 @@
+import { WebViewParams, RequestHeaderType } from "./types";
+/**
+ * Вытаскивает из query и headers все детали для вебвью.
+ *
+ * @returns Примечание по `appVersion`: В вебвью окружении версия всегда имеет формат `x.x.x`.
+ */
+export declare const extractNativeParams: (request: RequestHeaderType) => WebViewParams | null;

package/server/extract-native-params.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractNativeParams = void 0;
+const constants_1 = require("./constants");
+const utils_1 = require("./utils");
+const extract_and_join_original_webview_params_1 = require("./extract-and-join-original-webview-params");
+const reg_exp_patterns_1 = require("./reg-exp-patterns");
+const is_webview_environment_1 = require("./is-webview-environment");
+/**
+ * Вытаскивает из query и headers все детали для вебвью.
+ *
+ * @returns Примечание по `appVersion`: В вебвью окружении версия всегда имеет формат `x.x.x`.
+ */
+const extractNativeParams = (request) => {
+    if (!(0, is_webview_environment_1.isWebviewEnvironment)(request)) {
+        return null;
+    }
+    const { [constants_1.THEME_QUERY]: themeQuery, 
+    // При желании через диплинк на вебвью можно передать желаемый заголовок
+    // По умолчанию нужна именно пустая строка.
+    [constants_1.TITLE]: title = '', 
+    // Говорят, этого может и не быть в урле. Формат `com.xxxxxxxxx.app`.
+    [constants_1.WEBVIEW_IOS_APP_ID_QUERY]: iosAppIdQuery, [constants_1.WEBVIEW_IOS_APP_VERSION_QUERY]: iosAppVersionQuery, [constants_1.WEBVIEW_WITHOUT_LAYOUT_QUERY]: withoutLayoutQuery, [constants_1.WEBVIEW_NEXT_PAGE_ID_QUERY]: nextPageId, } = request.query;
+    const originalWebviewParams = (0, extract_and_join_original_webview_params_1.extractAndJoinOriginalWebviewParams)(request.query);
+    // Пробуем вытащить схему iOS приложения из query, если есть.
+    let iosAppId;
+    if (reg_exp_patterns_1.iosAppIdPattern.test(iosAppIdQuery)) {
+        const [, appIdSubsting] = iosAppIdQuery.match(reg_exp_patterns_1.iosAppIdPattern);
+        iosAppId = appIdSubsting;
+    }
+    // Определяем версию приложения из query или заголовка.
+    let appVersion = '0.0.0';
+    const appVersionFromHeaders = (0, utils_1.extractAppVersion)(request);
+    if (typeof iosAppVersionQuery === 'string' && reg_exp_patterns_1.versionPattern.test(iosAppVersionQuery)) {
+        appVersion = iosAppVersionQuery;
+    }
+    else if (typeof appVersionFromHeaders === 'string' &&
+        reg_exp_patterns_1.versionPattern.test(appVersionFromHeaders)) {
+        const [, versionSubstring] = appVersionFromHeaders.match(reg_exp_patterns_1.versionPattern) || [];
+        appVersion = versionSubstring;
+    }
+    const nativeParams = {
+        appVersion,
+        iosAppId,
+        isWebview: true,
+        theme: themeQuery === 'dark' ? 'dark' : 'light',
+        title,
+        withoutLayout: withoutLayoutQuery === 'true',
+        originalWebviewParams,
+        nextPageId: nextPageId ? Number(nextPageId) : null,
+    };
+    return nativeParams;
+};
+exports.extractNativeParams = extractNativeParams;

package/server/index.d.ts

@@ -0,0 +1,4 @@
+export * from './is-webview-environment';
+export * from './extract-native-params';
+export * from './set-native-params-cookie';
+export * from './types';

package/server/index.js

@@ -0,0 +1,16 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./is-webview-environment"), exports);
+__exportStar(require("./extract-native-params"), exports);
+__exportStar(require("./set-native-params-cookie"), exports);
+__exportStar(require("./types"), exports);

package/server/is-webview-environment.d.ts

@@ -0,0 +1,4 @@
+import { RequestHeaderType } from './types';
+export declare const isWebviewByUserAgent: (userAgent: string, appVersion: string | undefined) => boolean;
+export declare const isWebviewByCookies: (nativeParamsFromCookies: Record<string, any> | null) => boolean;
+export declare const isWebviewEnvironment: (request: RequestHeaderType) => boolean;

package/server/is-webview-environment.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isWebviewEnvironment = exports.isWebviewByCookies = exports.isWebviewByUserAgent = void 0;
+const utils_1 = require("./utils");
+const reg_exp_patterns_1 = require("./reg-exp-patterns");
+const isWebviewByUserAgent = (userAgent, appVersion) => {
+    return ((appVersion && reg_exp_patterns_1.versionPattern.test(appVersion)) || !!(userAgent === null || userAgent === void 0 ? void 0 : userAgent.match(reg_exp_patterns_1.webviewUaIOSPattern)));
+};
+exports.isWebviewByUserAgent = isWebviewByUserAgent;
+const isWebviewByCookies = (nativeParamsFromCookies) => {
+    return !!(nativeParamsFromCookies && nativeParamsFromCookies.isWebview);
+};
+exports.isWebviewByCookies = isWebviewByCookies;
+const isWebviewEnvironment = (request) => {
+    const userAgent = (0, utils_1.extractUserAgent)(request);
+    // `app-version` в заголовках – индикатор вебвью. В iOS есть только в первом запросе от webview
+    const appVersion = (0, utils_1.extractAppVersion)(request);
+    const nativeParams = (0, utils_1.extractNativeParamsFromCookieHeader)(request);
+    return (0, exports.isWebviewByCookies)(nativeParams) || (0, exports.isWebviewByUserAgent)(userAgent, appVersion);
+};
+exports.isWebviewEnvironment = isWebviewEnvironment;

package/server/reg-exp-patterns.d.ts

@@ -0,0 +1,3 @@
+export declare const iosAppIdPattern: RegExp;
+export declare const versionPattern: RegExp;
+export declare const webviewUaIOSPattern: RegExp;

package/server/reg-exp-patterns.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.webviewUaIOSPattern = exports.versionPattern = exports.iosAppIdPattern = void 0;
+exports.iosAppIdPattern = /^com\.([a-z]+)\.app$/;
+// Android приписывает после версии тип билда, например `feature`. Нам эта инфа не нужна.
+exports.versionPattern = /^(\d+\.\d+\.\d+)(\s.+)?$/;
+exports.webviewUaIOSPattern = new RegExp(['WebView', '(iPhone|iPod|iPad)(?!.*Safari)'].join('|'), 'ig');

package/server/set-native-params-cookie.d.ts

@@ -0,0 +1 @@
+export declare const setNativeParamsCookie: (params: Record<string, string>, setCookie: (name: string, value: string) => void) => void;

package/server/set-native-params-cookie.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setNativeParamsCookie = void 0;
+const constants_1 = require("./constants");
+const setNativeParamsCookie = (params, setCookie) => {
+    setCookie(constants_1.NATIVE_PARAMS_COOKIE_NAME, encodeURIComponent(JSON.stringify(params)));
+};
+exports.setNativeParamsCookie = setNativeParamsCookie;

package/server/types.d.ts

@@ -0,0 +1,9 @@
+import type { NativeParamsType } from '../shared/types';
+export declare type RequestHeaderType = Record<string, any>;
+export declare type EmptyWebViewParams = {
+    isWebview: false;
+};
+export declare type WebViewParams = NativeParamsType & {
+    isWebview: true;
+    withoutLayout: boolean;
+};

package/server/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/server/utils.d.ts

@@ -0,0 +1,13 @@
+import { RequestHeaderType } from './types';
+/**
+ * Возвращает `app-version` из заголовков запроса
+ */
+export declare function extractAppVersion(request: RequestHeaderType): string | undefined;
+/**
+ * Возвращает `User-agent` из заголовков запроса
+ */
+export declare function extractUserAgent(request: RequestHeaderType): string;
+/**
+ * Возвращает объект с `webview-параметрами` из cookies
+ */
+export declare function extractNativeParamsFromCookieHeader(request: RequestHeaderType): Record<string, unknown> | null;

package/server/utils.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractNativeParamsFromCookieHeader = exports.extractUserAgent = exports.extractAppVersion = void 0;
+const utils_1 = require("../shared/utils");
+/**
+ * Заголовок с версией приложения, который посылает вебвью из AM Android
+ */
+const AppVersion = 'app-version';
+/**
+ * Возвращает `app-version` из заголовков запроса
+ */
+function extractAppVersion(request) {
+    return request.headers[AppVersion];
+}
+exports.extractAppVersion = extractAppVersion;
+/**
+ * Возвращает `User-agent` из заголовков запроса
+ */
+function extractUserAgent(request) {
+    return request.headers['user-agent'];
+}
+exports.extractUserAgent = extractUserAgent;
+/**
+ * Возвращает объект с `webview-параметрами` из cookies
+ */
+function extractNativeParamsFromCookieHeader(request) {
+    return (0, utils_1.extractNativeParamsFromCookies)(request.headers['cookie']);
+}
+exports.extractNativeParamsFromCookieHeader = extractNativeParamsFromCookieHeader;

package/shared/types.d.ts

@@ -0,0 +1,8 @@
+export declare type NativeParamsType = {
+    appVersion: string;
+    title?: string;
+    iosAppId?: string;
+    theme: string;
+    nextPageId: number | null;
+    originalWebviewParams: string;
+};

package/shared/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/shared/utils.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Возвращает объект с `webview-параметрами` из cookies
+ */
+export declare function extractNativeParamsFromCookies(cookies?: string): Record<string, unknown> | null;

package/shared/utils.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractNativeParamsFromCookies = void 0;
+const constants_1 = require("../server/constants");
+/**
+ * Возвращает объект с `webview-параметрами` из cookies
+ */
+function extractNativeParamsFromCookies(cookies) {
+    if (!cookies) {
+        return null;
+    }
+    const cookiesArray = cookies.split('; ');
+    const cookieString = cookiesArray.find((cookie) => cookie.startsWith(`${constants_1.NATIVE_PARAMS_COOKIE_NAME}=`));
+    if (!cookieString)
+        return null;
+    const [, value] = cookieString.split('=');
+    try {
+        return JSON.parse(decodeURIComponent(value));
+    }
+    catch {
+        return null;
+    }
+}
+exports.extractNativeParamsFromCookies = extractNativeParamsFromCookies;