@alfalab/bridge-to-native 1.4.2 → 1.5.0

package/client/index.d.ts

@@ -1 +1,4 @@
 export { BridgeToNative } from './bridge-to-native';
+export { canUseNativeFeature } from './services-and-utils/native-features';
+export { prepareNativeDeeplinkUrl, prepareOpenInBrowserUrl, prepareOpenInNewWebviewDeeplink, preparePdfUrl, } from './services-and-utils/native-links';
+export type { Environment, NativeAppTarget, NativeFeatureKey, PdfType } from './types';

package/client/index.js

@@ -1,5 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BridgeToNative = void 0;
+exports.preparePdfUrl = exports.prepareOpenInNewWebviewDeeplink = exports.prepareOpenInBrowserUrl = exports.prepareNativeDeeplinkUrl = exports.canUseNativeFeature = 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 native_features_1 = require("./services-and-utils/native-features");
+Object.defineProperty(exports, "canUseNativeFeature", { enumerable: true, get: function () { return native_features_1.canUseNativeFeature; } });
+var native_links_1 = require("./services-and-utils/native-links");
+Object.defineProperty(exports, "prepareNativeDeeplinkUrl", { enumerable: true, get: function () { return native_links_1.prepareNativeDeeplinkUrl; } });
+Object.defineProperty(exports, "prepareOpenInBrowserUrl", { enumerable: true, get: function () { return native_links_1.prepareOpenInBrowserUrl; } });
+Object.defineProperty(exports, "prepareOpenInNewWebviewDeeplink", { enumerable: true, get: function () { return native_links_1.prepareOpenInNewWebviewDeeplink; } });
+Object.defineProperty(exports, "preparePdfUrl", { enumerable: true, get: function () { return native_links_1.preparePdfUrl; } });

package/client/services-and-utils/external-links-service.d.ts

@@ -14,5 +14,11 @@ export declare class ExternalLinksService {
     openInBrowser(link: string): void;
     openInNewWebview(link: string, nativeTitle?: string, closeCurrentWebview?: boolean): void;
     openPdf(url: string, type?: PdfType, title?: string): void;
+    private get nativeAppTarget();
+    /**
+     * Логирует невалидный URL через `logError` и бросает ошибку.
+     * Чистые функции сборки URL бросают ту же ошибку, но без логирования.
+     */
+    private validateUrlOrThrow;
     private navigateByNativeApp;
 }

package/client/services-and-utils/external-links-service.js

@@ -1,12 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExternalLinksService = void 0;
-const query_and_headers_keys_1 = require("../../query-and-headers-keys");
-const constants_1 = require("../constants");
+const native_links_1 = require("./native-links");
 const utils_1 = require("./utils");
 const CANCEL_NEW_CALLS_TO_NA_TIME = 150;
-const QUERY_OPEN_IN_BROWSER_KEY = 'openInBrowser';
-const QUERY_OPEN_IN_BROWSER_VALUE = 'true';
 /**
  * Сервис, предоставляющий методы для открытия внешних для текущего WA экранов
  * и связанных с этим действий.
@@ -21,11 +18,7 @@ class ExternalLinksService {
         if (this.navigationByNativeAppInProgress) {
             return;
         }
-        const clearedDeeplinkPath = deeplink.replace(constants_1.DEEP_LINK_PATTERN, '');
-        const originalNativeUrl = `${this.nativeParamsService.appId}://${clearedDeeplinkPath}`;
-        const preparedNativeUrl = this.nativeParamsService.environment === 'ios'
-            ? (0, utils_1.appendFromCurrentQueryParamForIos)(originalNativeUrl)
-            : originalNativeUrl;
+        const preparedNativeUrl = (0, native_links_1.prepareNativeDeeplinkUrl)(this.nativeAppTarget, deeplink);
         if (closeWebviewBeforeCallNativeDeeplinkHandler &&
             this.nativeParamsService.canUseNativeFeature('savedBackStack')) {
             (0, utils_1.closeWebviewUtil)();
@@ -40,58 +33,40 @@ class ExternalLinksService {
         if (!this.nativeParamsService.canUseNativeFeature('linksInBrowser')) {
             return `${this.nativeParamsService.appId}://webFeature?type=recommendation&url=${encodeURIComponent(link)}`;
         }
-        const url = (0, utils_1.validateUrl)(link, this.logError);
-        if (!url) {
-            throw new Error(`invalid url: ${link}`);
-        }
-        url.searchParams.append(QUERY_OPEN_IN_BROWSER_KEY, QUERY_OPEN_IN_BROWSER_VALUE);
-        return url.href;
+        this.validateUrlOrThrow(link);
+        return (0, native_links_1.prepareOpenInBrowserUrl)(this.nativeAppTarget, link, true);
     }
     openInBrowser(link) {
         if (this.navigationByNativeAppInProgress) {
             return;
         }
-        if (!this.nativeParamsService.canUseNativeFeature('linksInBrowser')) {
-            this.openInNewWebview(link);
-            return;
-        }
-        const url = (0, utils_1.validateUrl)(link, this.logError);
-        if (!url) {
-            throw new Error(`invalid url: ${link}`);
-        }
-        url.searchParams.append(QUERY_OPEN_IN_BROWSER_KEY, QUERY_OPEN_IN_BROWSER_VALUE);
-        this.navigateByNativeApp(url.href);
+        this.validateUrlOrThrow(link);
+        this.navigateByNativeApp((0, native_links_1.prepareOpenInBrowserUrl)(this.nativeAppTarget, link, this.nativeParamsService.canUseNativeFeature('linksInBrowser')));
     }
     openInNewWebview(link, nativeTitle = '', closeCurrentWebview = false) {
-        const url = (0, utils_1.validateUrl)(link, this.logError);
-        if (!url) {
-            throw new Error(`invalid url: ${link}`);
-        }
-        if (nativeTitle) {
-            url.searchParams.set(query_and_headers_keys_1.QUERY_B2N_TITLE, nativeTitle);
-        }
-        this.handleNativeDeeplink(`/webFeature?type=recommendation&url=${encodeURIComponent(url.toString())}`, closeCurrentWebview);
+        this.validateUrlOrThrow(link);
+        this.handleNativeDeeplink((0, native_links_1.prepareOpenInNewWebviewDeeplink)(link, nativeTitle), closeCurrentWebview);
     }
     openPdf(url, type = 'pdfFile', title) {
         if (this.navigationByNativeAppInProgress) {
             return;
         }
-        let replaceUrl = url;
-        if (this.nativeParamsService.environment === 'ios') {
-            const params = new URLSearchParams();
-            params.append('type', type);
-            params.append('url', decodeURIComponent(url));
-            if (title) {
-                params.append('title', title.replace(/\s/g, '_'));
-            }
-            const paramsStr = params.toString();
-            replaceUrl = `${this.nativeParamsService.appId}:///dashboard/pdf_viewer?${paramsStr}`;
+        this.navigateByNativeApp((0, native_links_1.preparePdfUrl)(this.nativeAppTarget, url, type, title));
+    }
+    get nativeAppTarget() {
+        return {
+            platform: this.nativeParamsService.environment,
+            appId: this.nativeParamsService.appId,
+        };
+    }
+    /**
+     * Логирует невалидный URL через `logError` и бросает ошибку.
+     * Чистые функции сборки URL бросают ту же ошибку, но без логирования.
+     */
+    validateUrlOrThrow(link) {
+        if (!(0, utils_1.validateUrl)(link, this.logError)) {
+            throw new Error(`invalid url: ${link}`);
         }
-        replaceUrl =
-            this.nativeParamsService.environment === 'ios'
-                ? (0, utils_1.appendFromCurrentQueryParamForIos)(replaceUrl)
-                : replaceUrl;
-        this.navigateByNativeApp(replaceUrl);
     }
     navigateByNativeApp(url) {
         this.navigationByNativeAppInProgress = true;

package/client/services-and-utils/native-features.d.ts

@@ -0,0 +1,12 @@
+import { type Environment, type NativeFeatureKey } from '../types';
+export declare const isValidVersionFormat: (version?: string) => version is string;
+/**
+ * Сравнивает версии формата `x.y.z` покомпонентно, как числа.
+ * Если хоть одна из версий в другом формате — возвращает `false`.
+ */
+export declare const isVersionHigherOrEqual: (version: string, versionToCompare: string) => boolean;
+/**
+ * Проверяет, поддерживает ли NA указанной платформы и версии нативную фичу.
+ * Версия в неизвестном формате считается `0.0.0`.
+ */
+export declare const canUseNativeFeature: (platform: Environment, appVersion: string, feature: NativeFeatureKey) => boolean;

package/client/services-and-utils/native-features.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.canUseNativeFeature = exports.isVersionHigherOrEqual = exports.isValidVersionFormat = void 0;
+const constants_1 = require("../constants");
+const VERSION_FORMAT_PATTERN = /^\d+\.\d+\.\d+$/;
+const isValidVersionFormat = (version) => Boolean(version) && VERSION_FORMAT_PATTERN.test(version);
+exports.isValidVersionFormat = isValidVersionFormat;
+/**
+ * Сравнивает версии формата `x.y.z` покомпонентно, как числа.
+ * Если хоть одна из версий в другом формате — возвращает `false`.
+ */
+const isVersionHigherOrEqual = (version, versionToCompare) => {
+    if (!(0, exports.isValidVersionFormat)(version) || !(0, exports.isValidVersionFormat)(versionToCompare)) {
+        return false;
+    }
+    const versionComponents = version.split('.').map(Number);
+    const versionToCompareComponents = versionToCompare.split('.').map(Number);
+    for (let i = 0; i < versionComponents.length; i++) {
+        if (versionComponents[i] !== versionToCompareComponents[i]) {
+            return versionComponents[i] > versionToCompareComponents[i];
+        }
+    }
+    return true;
+};
+exports.isVersionHigherOrEqual = isVersionHigherOrEqual;
+/**
+ * Проверяет, поддерживает ли NA указанной платформы и версии нативную фичу.
+ * Версия в неизвестном формате считается `0.0.0`.
+ */
+const canUseNativeFeature = (platform, appVersion, feature) => {
+    const { fromVersion } = constants_1.NATIVE_FEATURES_FROM_VERSION[platform][feature];
+    return (0, exports.isVersionHigherOrEqual)((0, exports.isValidVersionFormat)(appVersion) ? appVersion : '0.0.0', fromVersion);
+};
+exports.canUseNativeFeature = canUseNativeFeature;

package/client/services-and-utils/native-links.d.ts

@@ -0,0 +1,26 @@
+import { type NativeAppTarget, type PdfType } from '../types';
+/**
+ * Собирает URL для открытия диплинка NA: `alfabank:///dashboard/x`, `/x`, `alfabank://x` → `<appId>://x`.
+ * На iOS добавляет `fromCurrent=true`.
+ */
+export declare const prepareNativeDeeplinkUrl: ({ platform, appId }: NativeAppTarget, deeplink: string) => string;
+/**
+ * Собирает диплинк (без схемы) на открытие ссылки в новом WV.
+ * Результат передаётся в `prepareNativeDeeplinkUrl` или `handleNativeDeeplink`.
+ *
+ * @throws Если `link` не абсолютный http(s) URL.
+ */
+export declare const prepareOpenInNewWebviewDeeplink: (link: string, nativeTitle?: string) => string;
+/**
+ * Собирает URL на открытие ссылки в браузере.
+ * Если NA не умеет открывать ссылки в браузере — URL на открытие ссылки в новом WV.
+ *
+ * @param linksInBrowser Результат `canUseNativeFeature(platform, appVersion, 'linksInBrowser')`.
+ * @throws Если `link` не абсолютный http(s) URL.
+ */
+export declare const prepareOpenInBrowserUrl: (target: NativeAppTarget, link: string, linksInBrowser: boolean) => string;
+/**
+ * Собирает URL на открытие PDF. На iOS — диплинк на нативный pdf_viewer,
+ * на Android — исходный URL (его перехватывает NA).
+ */
+export declare const preparePdfUrl: ({ platform, appId }: NativeAppTarget, url: string, type?: PdfType, title?: string) => string;

package/client/services-and-utils/native-links.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.preparePdfUrl = exports.prepareOpenInBrowserUrl = exports.prepareOpenInNewWebviewDeeplink = exports.prepareNativeDeeplinkUrl = void 0;
+const query_and_headers_keys_1 = require("../../query-and-headers-keys");
+const constants_1 = require("../constants");
+const utils_1 = require("./utils");
+const QUERY_OPEN_IN_BROWSER_KEY = 'openInBrowser';
+const QUERY_OPEN_IN_BROWSER_VALUE = 'true';
+/*
+ * Чистые функции сборки URL, по которым NA открывает свои экраны.
+ * Используются `ExternalLinksService` и экспортируются для окружений,
+ * где экземпляр `BridgeToNative` не создаётся (например, миниаппы).
+ */
+const parseUrl = (link) => {
+    const url = (0, utils_1.validateUrl)(link);
+    if (!url) {
+        throw new Error(`invalid url: ${link}`);
+    }
+    return url;
+};
+/**
+ * Собирает URL для открытия диплинка NA: `alfabank:///dashboard/x`, `/x`, `alfabank://x` → `<appId>://x`.
+ * На iOS добавляет `fromCurrent=true`.
+ */
+const prepareNativeDeeplinkUrl = ({ platform, appId }, deeplink) => {
+    const nativeUrl = `${appId}://${deeplink.replace(constants_1.DEEP_LINK_PATTERN, '')}`;
+    return platform === 'ios' ? (0, utils_1.appendFromCurrentQueryParamForIos)(nativeUrl) : nativeUrl;
+};
+exports.prepareNativeDeeplinkUrl = prepareNativeDeeplinkUrl;
+/**
+ * Собирает диплинк (без схемы) на открытие ссылки в новом WV.
+ * Результат передаётся в `prepareNativeDeeplinkUrl` или `handleNativeDeeplink`.
+ *
+ * @throws Если `link` не абсолютный http(s) URL.
+ */
+const prepareOpenInNewWebviewDeeplink = (link, nativeTitle = '') => {
+    const url = parseUrl(link);
+    if (nativeTitle) {
+        url.searchParams.set(query_and_headers_keys_1.QUERY_B2N_TITLE, nativeTitle);
+    }
+    return `webFeature?type=recommendation&url=${encodeURIComponent(url.toString())}`;
+};
+exports.prepareOpenInNewWebviewDeeplink = prepareOpenInNewWebviewDeeplink;
+/**
+ * Собирает URL на открытие ссылки в браузере.
+ * Если NA не умеет открывать ссылки в браузере — URL на открытие ссылки в новом WV.
+ *
+ * @param linksInBrowser Результат `canUseNativeFeature(platform, appVersion, 'linksInBrowser')`.
+ * @throws Если `link` не абсолютный http(s) URL.
+ */
+const prepareOpenInBrowserUrl = (target, link, linksInBrowser) => {
+    if (!linksInBrowser) {
+        return (0, exports.prepareNativeDeeplinkUrl)(target, (0, exports.prepareOpenInNewWebviewDeeplink)(link));
+    }
+    const url = parseUrl(link);
+    url.searchParams.append(QUERY_OPEN_IN_BROWSER_KEY, QUERY_OPEN_IN_BROWSER_VALUE);
+    return url.href;
+};
+exports.prepareOpenInBrowserUrl = prepareOpenInBrowserUrl;
+/**
+ * Собирает URL на открытие PDF. На iOS — диплинк на нативный pdf_viewer,
+ * на Android — исходный URL (его перехватывает NA).
+ */
+const preparePdfUrl = ({ platform, appId }, url, type = 'pdfFile', title) => {
+    if (platform !== 'ios') {
+        return url;
+    }
+    const params = new URLSearchParams();
+    params.append('type', type);
+    params.append('url', decodeURIComponent(url));
+    if (title) {
+        params.append('title', title.replace(/\s/g, '_'));
+    }
+    return (0, utils_1.appendFromCurrentQueryParamForIos)(`${appId}:///dashboard/pdf_viewer?${params.toString()}`);
+};
+exports.preparePdfUrl = preparePdfUrl;

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.NativeParamsService = void 0;
 const query_and_headers_keys_1 = require("../../query-and-headers-keys");
 const constants_1 = require("../constants");
+const native_features_1 = require("./native-features");
 /**
  * Сервис, аккумулирующий детали о NA и предоставляющий методы, связанные с этим.
  */
@@ -24,28 +25,13 @@ class NativeParamsService {
         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];
-        return this.isCurrentVersionHigherOrEqual(fromVersion);
+        return (0, native_features_1.canUseNativeFeature)(this.environment, this.appVersion, feature);
     }
     isCurrentVersionHigherOrEqual(versionToCompare) {
-        if (!NativeParamsService.isValidVersionFormat(versionToCompare)) {
-            return false;
-        }
-        const matchPattern = /(\d+)\.(\d+)\.(\d+)/;
-        const [, ...appVersionComponents] = this.appVersion.match(matchPattern); // Формат версии проверен в конструкторе, можно смело убирать `null` из типа.
-        const [, ...versionToCompareComponents] = versionToCompare.match(matchPattern);
-        for (let i = 0; i < appVersionComponents.length; i++) {
-            if (appVersionComponents[i] !== versionToCompareComponents[i]) {
-                return appVersionComponents[i] >= versionToCompareComponents[i];
-            }
-        }
-        return true;
+        return (0, native_features_1.isVersionHigherOrEqual)(this.appVersion, versionToCompare);
     }
     static isValidVersionFormat(version) {
-        if (!version)
-            return false;
-        const versionPattern = /^\d+\.\d+\.\d+$/;
-        return versionPattern.test(version);
+        return (0, native_features_1.isValidVersionFormat)(version);
     }
     getAppId(knownIosAppId) {
         if (this.environment !== 'ios') {

package/client/services-and-utils/utils.js

@@ -26,7 +26,7 @@ exports.closeWebviewUtil = closeWebviewUtil;
 const validateUrl = (link, logError) => {
     let url;
     try {
-        url = link instanceof URL ? link : new URL(link);
+        url = new URL(link);
     }
     catch (error) {
         logError === null || logError === void 0 ? void 0 : logError('validateUrl: URL parsing error', {
@@ -35,6 +35,16 @@ const validateUrl = (link, logError) => {
         });
         return null;
     }
+    const isAllowedProtocol = url.protocol === 'https:' || url.protocol === 'http:';
+    const hasCredentials = Boolean(url.username || url.password);
+    if (!isAllowedProtocol || !url.hostname || hasCredentials) {
+        logError === null || logError === void 0 ? void 0 : logError('validateUrl: URL validation error', {
+            hostname: url.hostname,
+            link,
+            protocol: url.protocol,
+        });
+        return null;
+    }
     return url;
 };
 exports.validateUrl = validateUrl;

package/client/types.d.ts

@@ -4,6 +4,10 @@ export type BrowserHistoryApiWrappers = {
     replace?: (url: HistoryReplaceStateParams[2], state: HistoryReplaceStateParams[0]) => void;
 };
 export type Environment = 'android' | 'ios';
+export type NativeAppTarget = {
+    platform: Environment;
+    appId: string;
+};
 export type HistoryPushStateParams = Parameters<typeof window.history.pushState>;
 export type HistoryReplaceStateParams = Parameters<typeof window.history.replaceState>;
 export type LocationAssignParam = Parameters<typeof window.location.assign>[0];

package/package.json

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