@alfalab/bridge-to-native 1.4.0 → 1.4.1-beta.4145945

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

@@ -127,6 +127,20 @@ export declare class BridgeToNative {
      *  Применимо для всех версий на iOS и в новых версиях на Android (>=12.30.0), в более старых WV закрывается всегда автоматически.
      */
     handleNativeDeeplink(deeplink: string, closeWebviewBeforeCallNativeDeeplinkHandler?: boolean): void;
+    /**
+     * Открывает dashboard экран NA.
+     *
+     * Полезно для сценария возврата из WV на dashboard экран приложения,
+     * когда обычный deeplink требует специальной обработки.
+     *
+     * ВАЖНО!
+     * В NA на Android до версии `12.30.0` текущее WV закрывается при открытии нового экрана,
+     * поэтому в закрытое WV невозможно вернуться back-навигацией.
+     *
+     * @param closeWebviewBeforeOpen Флаг принудительного закрытия текущего WV перед открытием dashboard экрана.
+     *  Применимо для всех версий на iOS и в новых версиях на Android (>=12.30.0), в более старых WV закрывается всегда автоматически.
+     */
+    openNativeAppDashboard(closeWebviewBeforeOpen?: boolean): void;
     /**
      * Сравнивает текущую версию приложения с переданной.
      *

package/client/bridge-to-native.js

@@ -159,6 +159,22 @@ class BridgeToNative {
     handleNativeDeeplink(deeplink, closeWebviewBeforeCallNativeDeeplinkHandler = false) {
         this.externalLinksService.handleNativeDeeplink(deeplink, closeWebviewBeforeCallNativeDeeplinkHandler);
     }
+    /**
+     * Открывает dashboard экран NA.
+     *
+     * Полезно для сценария возврата из WV на dashboard экран приложения,
+     * когда обычный deeplink требует специальной обработки.
+     *
+     * ВАЖНО!
+     * В NA на Android до версии `12.30.0` текущее WV закрывается при открытии нового экрана,
+     * поэтому в закрытое WV невозможно вернуться back-навигацией.
+     *
+     * @param closeWebviewBeforeOpen Флаг принудительного закрытия текущего WV перед открытием dashboard экрана.
+     *  Применимо для всех версий на iOS и в новых версиях на Android (>=12.30.0), в более старых WV закрывается всегда автоматически.
+     */
+    openNativeAppDashboard(closeWebviewBeforeOpen = false) {
+        this.externalLinksService.openNativeAppDashboard(closeWebviewBeforeOpen);
+    }
     /**
      * Сравнивает текущую версию приложения с переданной.
      *

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

@@ -6,10 +6,13 @@ import { type NativeParamsService } from './native-params-service';
  */
 export declare class ExternalLinksService {
     private nativeParamsService;
+    private navigationByNativeAppInProgress;
     constructor(nativeParamsService: NativeParamsService);
     handleNativeDeeplink(deeplink: string, closeWebviewBeforeCallNativeDeeplinkHandler?: boolean): void;
+    openNativeAppDashboard(closeWebviewBeforeOpen?: boolean): void;
     getHrefToOpenInBrowser(link: string): string;
     openInBrowser(link: string): void;
     openInNewWebview(link: string, nativeTitle?: string, closeCurrentWebview?: boolean): void;
     openPdf(url: string, type?: PdfType, title?: string): void;
+    private navigateByNativeApp;
 }

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

@@ -3,7 +3,8 @@ 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 close_webview_util_1 = require("./close-webview-util");
+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';
 /**
@@ -13,18 +14,42 @@ const QUERY_OPEN_IN_BROWSER_VALUE = 'true';
 class ExternalLinksService {
     constructor(nativeParamsService) {
         this.nativeParamsService = nativeParamsService;
+        this.navigationByNativeAppInProgress = false;
     }
     handleNativeDeeplink(deeplink, closeWebviewBeforeCallNativeDeeplinkHandler = false) {
+        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;
         if (closeWebviewBeforeCallNativeDeeplinkHandler &&
             this.nativeParamsService.canUseNativeFeature('savedBackStack')) {
-            (0, close_webview_util_1.closeWebviewUtil)();
+            (0, utils_1.closeWebviewUtil)();
             // Проверено, ОС получает диплинк и передаёт его NA, не смотря на то,
             // что это происходит в следующей макрозадаче после команды на закрытие WV.
-            setTimeout(() => window.location.replace(`${this.nativeParamsService.appId}://${clearedDeeplinkPath}`), 0);
+            setTimeout(() => window.location.replace(preparedNativeUrl), 0);
+            return;
+        }
+        this.navigateByNativeApp(preparedNativeUrl);
+    }
+    openNativeAppDashboard(closeWebviewBeforeOpen = false) {
+        if (this.navigationByNativeAppInProgress) {
+            return;
+        }
+        const originalNativeUrl = `${this.nativeParamsService.appId}:///`;
+        const preparedNativeUrl = this.nativeParamsService.environment === 'ios'
+            ? (0, utils_1.appendFromCurrentQueryParamForIos)(originalNativeUrl)
+            : originalNativeUrl;
+        if (closeWebviewBeforeOpen &&
+            this.nativeParamsService.canUseNativeFeature('savedBackStack')) {
+            (0, utils_1.closeWebviewUtil)();
+            setTimeout(() => window.location.replace(preparedNativeUrl), 0);
             return;
         }
-        window.location.replace(`${this.nativeParamsService.appId}://${clearedDeeplinkPath}`);
+        this.navigateByNativeApp(preparedNativeUrl);
     }
     getHrefToOpenInBrowser(link) {
         if (!this.nativeParamsService.canUseNativeFeature('linksInBrowser')) {
@@ -35,13 +60,16 @@ class ExternalLinksService {
         return url.href;
     }
     openInBrowser(link) {
+        if (this.navigationByNativeAppInProgress) {
+            return;
+        }
         if (!this.nativeParamsService.canUseNativeFeature('linksInBrowser')) {
             this.openInNewWebview(link);
             return;
         }
         const url = new URL(link);
         url.searchParams.append(QUERY_OPEN_IN_BROWSER_KEY, QUERY_OPEN_IN_BROWSER_VALUE);
-        window.location.replace(url.href);
+        this.navigateByNativeApp(url.href);
     }
     openInNewWebview(link, nativeTitle = '', closeCurrentWebview = false) {
         const url = new URL(link);
@@ -51,6 +79,9 @@ class ExternalLinksService {
         this.handleNativeDeeplink(`/webFeature?type=recommendation&url=${encodeURIComponent(url.toString())}`, closeCurrentWebview);
     }
     openPdf(url, type = 'pdfFile', title) {
+        if (this.navigationByNativeAppInProgress) {
+            return;
+        }
         let replaceUrl = url;
         if (this.nativeParamsService.environment === 'ios') {
             const params = new URLSearchParams();
@@ -62,10 +93,18 @@ class ExternalLinksService {
             const paramsStr = params.toString();
             replaceUrl = `${this.nativeParamsService.appId}:///dashboard/pdf_viewer?${paramsStr}`;
         }
-        const windowObjectReference = window.open(replaceUrl);
-        if (windowObjectReference === null) {
-            window.location.replace(replaceUrl);
-        }
+        replaceUrl =
+            this.nativeParamsService.environment === 'ios'
+                ? (0, utils_1.appendFromCurrentQueryParamForIos)(replaceUrl)
+                : replaceUrl;
+        this.navigateByNativeApp(replaceUrl);
+    }
+    navigateByNativeApp(url) {
+        this.navigationByNativeAppInProgress = true;
+        window.location.replace(url);
+        setTimeout(() => {
+            this.navigationByNativeAppInProgress = false;
+        }, CANCEL_NEW_CALLS_TO_NA_TIME);
     }
 }
 exports.ExternalLinksService = ExternalLinksService;

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

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NativeNavigationAndTitleService = void 0;
 const query_and_headers_keys_1 = require("../../query-and-headers-keys");
-const close_webview_util_1 = require("./close-webview-util");
+const utils_1 = require("./utils");
 const NativeHistoryStackStub = 0;
 /**
  * Сервис, отвечающий за взаимодействие WA с WV компонентами NA —
@@ -39,7 +39,7 @@ class NativeNavigationAndTitleService {
     }
     // eslint-disable-next-line class-methods-use-this -- удобней использовать метод в контексте экземпляра.
     closeWebview() {
-        (0, close_webview_util_1.closeWebviewUtil)();
+        (0, utils_1.closeWebviewUtil)();
     }
     goBack() {
         if (this.isGoBackLocked) {
@@ -57,7 +57,7 @@ class NativeNavigationAndTitleService {
         const maxStepsToBack = this.nativeHistoryStack.length - 1;
         if (stepsToBack > maxStepsToBack) {
             if (autoCloseWebview) {
-                (0, close_webview_util_1.closeWebviewUtil)();
+                (0, utils_1.closeWebviewUtil)();
                 return;
             }
             this.numOfBackSteps = maxStepsToBack;
@@ -154,7 +154,7 @@ class NativeNavigationAndTitleService {
         }
         this.numOfBackSteps = 1;
         if (this.nativeHistoryStack.length < 1) {
-            (0, close_webview_util_1.closeWebviewUtil)();
+            (0, utils_1.closeWebviewUtil)();
             return;
         }
         this.saveNativeHistoryStack();

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

@@ -0,0 +1,2 @@
+export declare function appendFromCurrentQueryParamForIos(nativeUrl: string): string;
+export declare const closeWebviewUtil: () => void;

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

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.closeWebviewUtil = void 0;
+exports.appendFromCurrentQueryParamForIos = appendFromCurrentQueryParamForIos;
+const QUERY_CLOSE_WEBVIEW_KEY = 'closeWebView';
+const QUERY_CLOSE_WEBVIEW_VALUE = 'true';
+const QUERY_FROM_CURRENT_KEY = 'fromCurrent';
+const QUERY_FROM_CURRENT_VALUE = 'true';
+function appendFromCurrentQueryParamForIos(nativeUrl) {
+    const qIndex = nativeUrl.indexOf('?');
+    if (qIndex === -1) {
+        return `${nativeUrl}?${QUERY_FROM_CURRENT_KEY}=${QUERY_FROM_CURRENT_VALUE}`;
+    }
+    const base = nativeUrl.slice(0, qIndex);
+    const query = nativeUrl.slice(qIndex + 1);
+    const params = new URLSearchParams(query);
+    params.set(QUERY_FROM_CURRENT_KEY, QUERY_FROM_CURRENT_VALUE);
+    return `${base}?${params.toString()}`;
+}
+const closeWebviewUtil = () => {
+    const originalPageUrl = new URL(window.location.href);
+    originalPageUrl.searchParams.set(QUERY_CLOSE_WEBVIEW_KEY, QUERY_CLOSE_WEBVIEW_VALUE);
+    window.location.href = originalPageUrl.toString();
+};
+exports.closeWebviewUtil = closeWebviewUtil;

package/package.json

@@ -1,121 +1,121 @@
 {
-    "name": "@alfalab/bridge-to-native",
-    "version": "1.4.0",
-    "license": "MIT",
-    "description": "Утилита для удобной работы веб приложения внутри нативного приложения и коммуникации с ним.",
-    "engines": {
-        "node": ">=20.19.2",
-        "npm": "please-use-yarn"
+  "name": "@alfalab/bridge-to-native",
+  "version": "1.4.1-beta.4145945",
+  "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"
     },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/core-ds/bridge-to-native.git"
+    "./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"
+      ]
     },
-    "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"
-        }
-    },
-    "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"
+    "overrides": [
+      {
+        "files": [
+          "__tests__/**/*"
         ],
-        "coveragePathIgnorePatterns": [
-            "/node_modules/",
-            "/src/(client|server)/index.ts"
-        ],
-        "reporters": [
-            "default",
-            "jest-junit"
+        "rules": {
+          "max-lines": "off"
+        }
+      }
+    ]
+  },
+  "jest": {
+    "projects": [
+      {
+        "displayName": "client-tests",
+        "testEnvironment": "@happy-dom/jest-environment",
+        "testPathIgnorePatterns": [
+          "/__tests__/server/"
         ]
-    },
-    "prettier": "arui-presets-lint/prettier",
-    "stylelint": {
-        "extends": "arui-presets-lint/stylelint",
-        "ignoreFiles": [
-            "coverage/**/*.js",
-            ".yarn/releases/*"
+      },
+      {
+        "displayName": "server-tests",
+        "testEnvironment": "node",
+        "testPathIgnorePatterns": [
+          "/__tests__/client/"
         ]
-    },
-    "publishConfig": {
-        "registry": "https://registry.npmjs.org"
-    },
-    "packageManager": "yarn@4.12.0"
+      }
+    ],
+    "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"
 }

package/client/services-and-utils/close-webview-util.d.ts

@@ -1 +0,0 @@
-export declare const closeWebviewUtil: () => void;

package/client/services-and-utils/close-webview-util.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.closeWebviewUtil = void 0;
-const QUERY_CLOSE_WEBVIEW_KEY = 'closeWebView';
-const QUERY_CLOSE_WEBVIEW_VALUE = 'true';
-const closeWebviewUtil = () => {
-    const originalPageUrl = new URL(window.location.href);
-    originalPageUrl.searchParams.set(QUERY_CLOSE_WEBVIEW_KEY, QUERY_CLOSE_WEBVIEW_VALUE);
-    window.location.href = originalPageUrl.toString();
-};
-exports.closeWebviewUtil = closeWebviewUtil;