sparkling-navigation 2.0.0-rc.2

package/android/src/main/java/com/tiktok/sparkling/method/router/open/RouterOpenMethod.kt

@@ -0,0 +1,157 @@
+// Copyright (c) 2023 TikTok Pte. Ltd.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+
+
+package com.tiktok.sparkling.method.router.open
+
+
+import android.util.Log
+import com.tiktok.sparkling.method.registry.core.IDLBridgeMethod
+import com.tiktok.sparkling.method.registry.core.BridgePlatformType
+import com.tiktok.sparkling.method.registry.core.model.idl.CompletionBlock
+import com.tiktok.sparkling.method.registry.core.utils.createXModel
+import com.tiktok.sparkling.method.router.utils.IHostRouterDepend
+import com.tiktok.sparkling.method.router.utils.RouterProvider
+import java.net.URLDecoder
+
+
+/**
+ * Router open method implementation.
+ * Handles opening new pages/routes with various configuration options.
+ */
+class RouterOpenMethod : AbsRouterOpenMethodIDL() {
+
+    companion object {
+        const val KEY_POST_URL_CONFIG = "__post_url_config"
+        private const val TAG = "RouterOpenMethod"
+    }
+
+    private fun getRouterDependInstance(): IHostRouterDepend? {
+        return RouterProvider.hostRouterDepend
+    }
+
+    override fun handle(
+        params: IDLMethodOpenParamModel,
+        callback: CompletionBlock<IDLMethodOpenResultModel>,
+        type: BridgePlatformType
+    ) {
+        // Validate scheme is not null or empty
+        val scheme = params.scheme
+        if (scheme.isNullOrBlank()) {
+            Log.w(TAG, "Invalid params: scheme is null or empty")
+            callback.onFailure(IDLBridgeMethod.INVALID_PARAM, "Invalid params: scheme must be a non-empty string", null)
+            return
+        }
+
+        // Validate replaceType if provided
+        val replaceType: ReplaceType? = if (!params.replaceType.isNullOrBlank()) {
+            try {
+                ReplaceType.valueOf(params.replaceType!!)
+            } catch (e: IllegalArgumentException) {
+                Log.w(TAG, "Invalid replaceType: ${params.replaceType}")
+                callback.onFailure(
+                    IDLBridgeMethod.INVALID_PARAM,
+                    "Invalid replaceType: ${params.replaceType}. Valid values are: ${ReplaceType.values().joinToString()}",
+                    null
+                )
+                return
+            }
+        } else {
+            ReplaceType.onlyCloseAfterOpenSucceed
+        }
+
+        // Get and validate context
+        val context = getSDKContext()?.context
+        if (context == null) {
+            Log.e(TAG, "Context not provided in host")
+            callback.onFailure(IDLBridgeMethod.FAIL, "Context not provided in host", null)
+            return
+        }
+
+        // Check if router dependency is available
+        val routerDepend = getRouterDependInstance()
+        if (routerDepend == null) {
+            Log.e(TAG, "Router dependency not registered")
+            callback.onFailure(IDLBridgeMethod.FAIL, "Router service not available", null)
+            return
+        }
+
+        val replace = params.replace ?: false
+        val useSysBrowser = params.useSysBrowser ?: false
+        val extra = params.extra
+
+        val extraInfo = mutableMapOf<String, Any>(
+            "useSysBrowser" to useSysBrowser,
+            "extra" to (extra ?: emptyMap<Any, Any>())
+        )
+
+        // Handle POST request configuration
+        if (params.usePost == true) {
+            val decodeBody = try {
+                URLDecoder.decode(params.postBody ?: "", "UTF-8")
+            } catch (e: Exception) {
+                Log.w(TAG, "Failed to decode postBody: ${e.message}")
+                params.postBody ?: ""
+            }
+            extraInfo[KEY_POST_URL_CONFIG] = mutableMapOf<String, String>(
+                "postBody" to decodeBody,
+                "postHeader" to (params.postHeader?.toString() ?: ""),
+            )
+        }
+
+        // Handle non-replace open
+        if (!replace) {
+            val success = try {
+                routerDepend.openScheme(getSDKContext(), scheme, extraInfo, type, context = context)
+            } catch (e: Exception) {
+                Log.e(TAG, "Exception while opening scheme: ${e.message}")
+                false
+            }
+
+            if (success) {
+                callback.onSuccess(IDLMethodOpenResultModel::class.java.createXModel())
+            } else {
+                callback.onFailure(IDLBridgeMethod.FAIL, "Failed to open scheme: $scheme", null)
+            }
+            return
+        }
+
+        // Handle replace open with different replace types
+        val success: Boolean = try {
+            when (replaceType) {
+                ReplaceType.alwaysCloseBeforeOpen -> {
+                    routerDepend.closeView(getSDKContext(), type)
+                    routerDepend.openScheme(getSDKContext(), scheme, extraInfo, type, context = context)
+                }
+                ReplaceType.alwaysCloseAfterOpen -> {
+                    val opened = routerDepend.openScheme(getSDKContext(), scheme, extraInfo, type, context = context)
+                    routerDepend.closeView(getSDKContext(), type)
+                    opened
+                }
+                ReplaceType.onlyCloseAfterOpenSucceed -> {
+                    val opened = routerDepend.openScheme(getSDKContext(), scheme, extraInfo, type, context = context)
+                    if (opened) {
+                        routerDepend.closeView(getSDKContext(), type)
+                    }
+                    opened
+                }
+                null -> false
+            }
+        } catch (e: Exception) {
+            Log.e(TAG, "Exception during replace open: ${e.message}")
+            false
+        }
+
+        if (success) {
+            callback.onSuccess(IDLMethodOpenResultModel::class.java.createXModel())
+        } else {
+            callback.onFailure(IDLBridgeMethod.FAIL, "Failed to open scheme: $scheme", null)
+        }
+    }
+}
+enum class ReplaceType {
+    alwaysCloseAfterOpen,
+    alwaysCloseBeforeOpen,
+    onlyCloseAfterOpenSucceed
+}

package/android/src/main/java/com/tiktok/sparkling/method/router/utils/AbsRouteOpenHandler.kt

@@ -0,0 +1,28 @@
+// Copyright (c) 2022 TikTok Pte. Ltd.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+package com.tiktok.sparkling.method.router.utils
+
+import android.content.Context
+import com.tiktok.sparkling.method.registry.core.BridgePlatformType
+
+/**
+ * Desc:
+ */
+abstract class AbsRouteOpenHandler {
+    var nextHandler: AbsRouteOpenHandler? = null
+        private set
+    var exceptionHandler: AbsRouteOpenHandler? = null
+        private set
+
+    fun setNextHandler(handler: AbsRouteOpenHandler?) {
+        this.nextHandler = handler
+    }
+
+    fun setExceptionHandler(handler: AbsRouteOpenHandler?) {
+        this.exceptionHandler = handler
+    }
+
+    abstract fun openScheme(scheme: String, extraInfo: Map<String, Any>, context: Context?): Boolean
+    abstract fun getSupportPlatformTypeList(): List<BridgePlatformType>
+}

package/android/src/main/java/com/tiktok/sparkling/method/router/utils/IHostRouterDepend.kt

@@ -0,0 +1,54 @@
+// Copyright (c) 2022 TikTok Pte. Ltd.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+package com.tiktok.sparkling.method.router.utils
+
+import android.content.Context
+import com.tiktok.sparkling.method.registry.core.IBridgeContext
+import com.tiktok.sparkling.method.registry.core.BridgePlatformType
+import com.tiktok.sparkling.method.registry.core.model.context.ContextProviderFactory
+
+interface IHostRouterDepend {
+    fun openScheme(bridgeContext: IBridgeContext?, scheme: String, extraParams: Map<String, Any>, platformType: BridgePlatformType, context: Context?): Boolean {
+        var handled = false
+        val contextProviderFactory = ContextProviderFactory()
+        val headHandlerNode = assembleHandlerChain(contextProviderFactory) ?: return false
+        var curHandlerNode: AbsRouteOpenHandler? = headHandlerNode
+        while (!handled && curHandlerNode != null) {
+            if (curHandlerNode.getSupportPlatformTypeList().contains(BridgePlatformType.ALL) || curHandlerNode.getSupportPlatformTypeList().contains(platformType)) {
+                try {
+                    handled = curHandlerNode.openScheme(scheme, extraParams, contextProviderFactory?.provideInstance(Context::class.java))
+                    if (handled) {
+                        break
+                    }
+                    curHandlerNode = curHandlerNode.nextHandler
+                } catch (e: Throwable) {
+                    curHandlerNode = curHandlerNode!!.exceptionHandler
+                }
+            } else {
+                curHandlerNode = curHandlerNode.nextHandler
+            }
+        }
+
+        return  handled
+    }
+    fun closeView(bridgeContext: IBridgeContext?, type: BridgePlatformType, containerID: String? = null, animated: Boolean? = false): Boolean
+    fun provideRouteOpenHandlerList(contextProviderFactory: ContextProviderFactory?): List<AbsRouteOpenHandler> = listOf()
+    fun provideRouteOpenExceptionHandler(contextProviderFactory: ContextProviderFactory?): AbsRouteOpenHandler? = null
+    private fun assembleHandlerChain(contextProviderFactory: ContextProviderFactory?): AbsRouteOpenHandler? {
+        val chainHandlerList = provideRouteOpenHandlerList(contextProviderFactory)
+        val exceptionHandlerNode = provideRouteOpenExceptionHandler(contextProviderFactory)
+        var prevChainNode: AbsRouteOpenHandler? = null
+        var headChainNode: AbsRouteOpenHandler? = null
+        chainHandlerList.forEach {
+            val curChainHandler = it
+            if (prevChainNode == null) {
+                headChainNode = curChainHandler
+            }
+            prevChainNode?.setNextHandler(curChainHandler)
+            curChainHandler.setExceptionHandler(exceptionHandlerNode)
+            prevChainNode = curChainHandler
+        }
+        return headChainNode
+    }
+}

package/android/src/main/java/com/tiktok/sparkling/method/router/utils/RouterProvider.kt

@@ -0,0 +1,9 @@
+// Copyright (c) 2022 TikTok Pte. Ltd.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+package com.tiktok.sparkling.method.router.utils
+
+
+object RouterProvider {
+    var hostRouterDepend: IHostRouterDepend? = null
+}

package/android/src/test/java/com/tiktok/sparkling/method/router/RouterMethodUnitTest.kt

@@ -0,0 +1,20 @@
+// Copyright (c) 2022 TikTok Pte. Ltd.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+package com.tiktok.sparkling.method.router
+
+import org.junit.Test
+
+import org.junit.Assert.*
+
+/**
+ * Example local unit test, which will execute on the development machine (host).
+ *
+ * See [testing documentation](http://d.android.com/tools/testing).
+ */
+class RouterMethodUnitTest {
+    @Test
+    fun addition_isCorrect() {
+        assertEquals(4, 2 + 2)
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export * from './src/open/open';
+export * from './src/close/close';
+export * from './src/navigate/navigate';
+export type { OpenRequest, OpenResponse, OpenOptions } from './src/open/open.d';
+export type { CloseRequest, CloseResponse } from './src/close/close.d';
+export type { NavigateRequest, NavigateResponse, NavigateOptions } from './src/navigate/navigate.d';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAGA,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,YAAY,EAAE,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChF,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACvE,YAAY,EAAE,eAAe,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC"}

package/dist/index.js

@@ -0,0 +1,7 @@
+// Copyright (c) 2022 TikTok Pte. Ltd.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+export * from './src/open/open';
+export * from './src/close/close';
+export * from './src/navigate/navigate';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,yEAAyE;AACzE,0DAA0D;AAC1D,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC"}

package/dist/src/__tests__/test-utils.d.ts

@@ -0,0 +1,25 @@
+import { createMockPipe, validateContract } from '../../../../common/test-utils';
+export { createMockPipe, validateContract };
+export type { MockPipe } from '../../../../common/test-utils';
+/**
+ * Create a mock pipe response for successful operations
+ */
+export declare const createSuccessResponse: (extra?: any) => any;
+/**
+ * Create a mock pipe response for failed operations
+ */
+export declare const createErrorResponse: (code?: number, msg?: string) => any;
+/**
+ * Helper to validate method contract responses
+ */
+export declare const validateMethodContract: <T>(response: any, requiredFields: (keyof T)[]) => response is T;
+/**
+ * Test constants for consistent testing
+ */
+export declare const TEST_CONSTANTS: {
+    readonly VALID_SCHEME: "https://example.com/page";
+    readonly INVALID_SCHEME_EMPTY: "";
+    readonly INVALID_SCHEME_WHITESPACE: "   ";
+    readonly MOCK_CONTAINER_ID: "test-container-123";
+};
+//# sourceMappingURL=test-utils.d.ts.map

package/dist/src/__tests__/test-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-utils.d.ts","sourceRoot":"","sources":["../../../src/__tests__/test-utils.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,cAAc,EAGd,gBAAgB,EACjB,MAAM,+BAA+B,CAAC;AAGvC,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,CAAC;AAC5C,YAAY,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAE9D;;GAEG;AACH,eAAO,MAAM,qBAAqB,sBAA4B,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,mBAAmB,GAAI,OAAM,MAAW,EAAE,MAAK,MAAgB,QACxC,CAAC;AAErC;;GAEG;AACH,eAAO,MAAM,sBAAsB,kEAAmB,CAAC;AAEvD;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;CAKjB,CAAC"}

package/dist/src/__tests__/test-utils.js

@@ -0,0 +1,28 @@
+// Copyright (c) 2025 TikTok Pte. Ltd.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+import { createMockPipe, createSuccessResponseBase, createErrorResponseBase, validateContract, } from '../../../../common/test-utils';
+// Re-export shared utilities
+export { createMockPipe, validateContract };
+/**
+ * Create a mock pipe response for successful operations
+ */
+export const createSuccessResponse = createSuccessResponseBase;
+/**
+ * Create a mock pipe response for failed operations
+ */
+export const createErrorResponse = (code = -1, msg = 'Error') => createErrorResponseBase(code, msg);
+/**
+ * Helper to validate method contract responses
+ */
+export const validateMethodContract = validateContract;
+/**
+ * Test constants for consistent testing
+ */
+export const TEST_CONSTANTS = {
+    VALID_SCHEME: 'https://example.com/page',
+    INVALID_SCHEME_EMPTY: '',
+    INVALID_SCHEME_WHITESPACE: '   ',
+    MOCK_CONTAINER_ID: 'test-container-123',
+};
+//# sourceMappingURL=test-utils.js.map

package/dist/src/__tests__/test-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-utils.js","sourceRoot":"","sources":["../../../src/__tests__/test-utils.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,yEAAyE;AACzE,0DAA0D;AAE1D,OAAO,EACL,cAAc,EACd,yBAAyB,EACzB,uBAAuB,EACvB,gBAAgB,GACjB,MAAM,+BAA+B,CAAC;AAEvC,6BAA6B;AAC7B,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,CAAC;AAG5C;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,yBAAyB,CAAC;AAE/D;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,OAAe,CAAC,CAAC,EAAE,MAAc,OAAO,EAAE,EAAE,CAC9E,uBAAuB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AAErC;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,gBAAgB,CAAC;AAEvD;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,YAAY,EAAE,0BAA0B;IACxC,oBAAoB,EAAE,EAAE;IACxB,yBAAyB,EAAE,KAAK;IAChC,iBAAiB,EAAE,oBAAoB;CAC/B,CAAC"}

package/dist/src/close/close.d.ts

@@ -0,0 +1,8 @@
+import type { CloseRequest, CloseResponse } from './close.d';
+/**
+ * Close the current page
+ * @param params
+ * @param callback
+ */
+export declare function close(params?: CloseRequest, callback?: (result: CloseResponse) => void): void;
+//# sourceMappingURL=close.d.ts.map

package/dist/src/close/close.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"close.d.ts","sourceRoot":"","sources":["../../../src/close/close.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE7D;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,MAAM,CAAC,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,aAAa,KAAK,IAAI,GAAG,IAAI,CAiB7F"}

package/dist/src/close/close.js

@@ -0,0 +1,26 @@
+// Copyright (c) 2022 TikTok Pte. Ltd.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+import pipe from 'sparkling-method';
+/**
+ * Close the current page
+ * @param params
+ * @param callback
+ */
+export function close(params, callback) {
+    if (callback !== undefined && typeof callback !== 'function') {
+        console.error('[sparkling-navigation] close: callback must be a function');
+        return;
+    }
+    pipe.call('router.close', Object.assign({}, (params !== null && params !== void 0 ? params : {})), (v) => {
+        var _a, _b;
+        if (typeof callback === 'function') {
+            const response = v;
+            callback({
+                code: (_a = response === null || response === void 0 ? void 0 : response.code) !== null && _a !== void 0 ? _a : -1,
+                msg: (_b = response === null || response === void 0 ? void 0 : response.msg) !== null && _b !== void 0 ? _b : 'Unknown error',
+            });
+        }
+    });
+}
+//# sourceMappingURL=close.js.map

package/dist/src/close/close.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"close.js","sourceRoot":"","sources":["../../../src/close/close.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,yEAAyE;AACzE,0DAA0D;AAC1D,OAAO,IAAI,MAAM,kBAAkB,CAAC;AAGpC;;;;GAIG;AACH,MAAM,UAAU,KAAK,CAAC,MAAqB,EAAE,QAA0C;IACnF,IAAI,QAAQ,KAAK,SAAS,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;QAC3D,OAAO,CAAC,KAAK,CAAC,2DAA2D,CAAC,CAAC;QAC3E,OAAO;IACX,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,cAAc,oBACjB,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,GAClB,CAAC,CAAU,EAAE,EAAE;;QACd,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;YACjC,MAAM,QAAQ,GAAG,CAAkB,CAAC;YACpC,QAAQ,CAAC;gBACL,IAAI,EAAE,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,mCAAI,CAAC,CAAC;gBAC1B,GAAG,EAAE,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,GAAG,mCAAI,eAAe;aACxC,CAAC,CAAC;QACP,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC"}

package/dist/src/navigate/navigate.d.ts

@@ -0,0 +1,3 @@
+import type { NavigateRequest, NavigateResponse } from './navigate.d';
+export declare function navigate(params: NavigateRequest, callback: (result: NavigateResponse) => void): void;
+//# sourceMappingURL=navigate.d.ts.map

package/dist/src/navigate/navigate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigate.d.ts","sourceRoot":"","sources":["../../../src/navigate/navigate.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAqC,MAAM,cAAc,CAAC;AA2DzG,wBAAgB,QAAQ,CAAC,MAAM,EAAE,eAAe,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,GAAG,IAAI,CA+CpG"}

package/dist/src/navigate/navigate.js

@@ -0,0 +1,103 @@
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+// Copyright (c) 2022 TikTok Pte. Ltd.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+import { open } from '../open/open';
+const DEFAULT_ROUTER_SCHEME = 'hybrid://lynxview_page';
+const PROTOCOL_REGEX = /^[a-z][a-z0-9+.-]*:\/\//i;
+const ALLOWED_SCHEME_PARAMS = new Set([
+    'bundle',
+    'title',
+    'fallback_url',
+    'title_color',
+    'hide_nav_bar',
+    'nav_bar_color',
+    'screen_orientation',
+    'hide_status_bar',
+    'trans_status_bar',
+    'hide_loading',
+    'loading_bg_color',
+    'container_bg_color',
+    'hide_error',
+    'force_theme_style',
+]);
+function createErrorResponse(msg) {
+    return {
+        code: -1,
+        msg,
+    };
+}
+function normalizePath(path) {
+    let normalized = path.trim();
+    // Remove leading "./" or "/" to keep the bundle path relative
+    normalized = normalized.replace(/^(?:\.\/|\/)+/, '');
+    return normalized;
+}
+function buildScheme(baseScheme, bundlePath, params) {
+    const sanitizedBase = (baseScheme || DEFAULT_ROUTER_SCHEME).trim().replace(/[?&]+$/, '') || DEFAULT_ROUTER_SCHEME;
+    const searchParams = new URLSearchParams();
+    searchParams.set('bundle', bundlePath);
+    if (params && typeof params === 'object') {
+        for (const key of Object.keys(params)) {
+            if (!ALLOWED_SCHEME_PARAMS.has(key)) {
+                continue;
+            }
+            const value = params[key];
+            if (value === undefined || value === null) {
+                continue;
+            }
+            searchParams.append(key, String(value));
+        }
+    }
+    return `${sanitizedBase}?${searchParams.toString()}`;
+}
+export function navigate(params, callback) {
+    var _a, _b;
+    if (!params) {
+        const errorResponse = createErrorResponse('Invalid params: params cannot be null or undefined');
+        if (typeof callback === 'function') {
+            callback(errorResponse);
+        }
+        return;
+    }
+    if (!params.path || typeof params.path !== 'string' || !params.path.trim()) {
+        const errorResponse = createErrorResponse('Invalid params: path must be a non-empty string');
+        if (typeof callback === 'function') {
+            callback(errorResponse);
+        }
+        return;
+    }
+    if (PROTOCOL_REGEX.test(params.path.trim())) {
+        const errorResponse = createErrorResponse('Invalid params: path must be a relative path, not a full scheme');
+        if (typeof callback === 'function') {
+            callback(errorResponse);
+        }
+        return;
+    }
+    if (typeof callback !== 'function') {
+        console.error('[sparkling-navigation] navigate: callback must be a function');
+        return;
+    }
+    const bundlePath = normalizePath(params.path);
+    const _c = (_a = params.options) !== null && _a !== void 0 ? _a : {}, { params: schemeParams } = _c, restOptions = __rest(_c, ["params"]);
+    if (!bundlePath) {
+        callback(createErrorResponse('Invalid params: path must resolve to a bundle name'));
+        return;
+    }
+    const scheme = buildScheme((_b = params.baseScheme) !== null && _b !== void 0 ? _b : DEFAULT_ROUTER_SCHEME, bundlePath, schemeParams);
+    open({
+        scheme,
+        options: Object.keys(restOptions).length ? restOptions : undefined,
+    }, callback);
+}
+//# sourceMappingURL=navigate.js.map

package/dist/src/navigate/navigate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigate.js","sourceRoot":"","sources":["../../../src/navigate/navigate.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,sCAAsC;AACtC,yEAAyE;AACzE,0DAA0D;AAC1D,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAGpC,MAAM,qBAAqB,GAAG,wBAAwB,CAAC;AACvD,MAAM,cAAc,GAAG,0BAA0B,CAAC;AAClD,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAmB;IACpD,QAAQ;IACR,OAAO;IACP,cAAc;IACd,aAAa;IACb,cAAc;IACd,eAAe;IACf,oBAAoB;IACpB,iBAAiB;IACjB,kBAAkB;IAClB,cAAc;IACd,kBAAkB;IAClB,oBAAoB;IACpB,YAAY;IACZ,mBAAmB;CACtB,CAAC,CAAC;AAEH,SAAS,mBAAmB,CAAC,GAAW;IACpC,OAAO;QACH,IAAI,EAAE,CAAC,CAAC;QACR,GAAG;KACN,CAAC;AACN,CAAC;AAED,SAAS,aAAa,CAAC,IAAY;IAC/B,IAAI,UAAU,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC7B,8DAA8D;IAC9D,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;IACrD,OAAO,UAAU,CAAC;AACtB,CAAC;AAED,SAAS,WAAW,CAAC,UAAkB,EAAE,UAAkB,EAAE,MAAkC;IAC3F,MAAM,aAAa,GAAG,CAAC,UAAU,IAAI,qBAAqB,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,qBAAqB,CAAC;IAClH,MAAM,YAAY,GAAG,IAAI,eAAe,EAAE,CAAC;IAC3C,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IAEvC,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QACvC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAuB,EAAE,CAAC;YAC1D,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBAClC,SAAS;YACb,CAAC;YAED,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YAE1B,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBACxC,SAAS;YACb,CAAC;YAED,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5C,CAAC;IACL,CAAC;IAED,OAAO,GAAG,aAAa,IAAI,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC;AACzD,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,MAAuB,EAAE,QAA4C;;IAC1F,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,MAAM,aAAa,GAAG,mBAAmB,CAAC,oDAAoD,CAAC,CAAC;QAChG,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;YACjC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO;IACX,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;QACzE,MAAM,aAAa,GAAG,mBAAmB,CAAC,iDAAiD,CAAC,CAAC;QAC7F,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;YACjC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO;IACX,CAAC;IAED,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QAC1C,MAAM,aAAa,GAAG,mBAAmB,CAAC,iEAAiE,CAAC,CAAC;QAC7G,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;YACjC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO;IACX,CAAC;IAED,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;QACjC,OAAO,CAAC,KAAK,CAAC,8DAA8D,CAAC,CAAC;QAC9E,OAAO;IACX,CAAC;IAED,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC9C,MAAM,KAA2C,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,EAA/D,EAAE,MAAM,EAAE,YAAY,OAAyC,EAApC,WAAW,cAAtC,UAAwC,CAAuB,CAAC;IAEtE,IAAI,CAAC,UAAU,EAAE,CAAC;QACd,QAAQ,CAAC,mBAAmB,CAAC,oDAAoD,CAAC,CAAC,CAAC;QACpF,OAAO;IACX,CAAC;IAED,MAAM,MAAM,GAAG,WAAW,CAAC,MAAA,MAAM,CAAC,UAAU,mCAAI,qBAAqB,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;IAEjG,IAAI,CACA;QACI,MAAM;QACN,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;KACrE,EACD,QAAQ,CACX,CAAC;AACN,CAAC"}

package/dist/src/open/open.d.ts

@@ -0,0 +1,8 @@
+import type { OpenRequest, OpenResponse } from './open.d';
+/**
+ * Open a new page or route
+ * @param params |
+ * @param callback
+ */
+export declare function open(params: OpenRequest, callback: (result: OpenResponse) => void): void;
+//# sourceMappingURL=open.d.ts.map

package/dist/src/open/open.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"open.d.ts","sourceRoot":"","sources":["../../../src/open/open.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAE1D;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,GAAG,IAAI,CAsCxF"}

package/dist/src/open/open.js

@@ -0,0 +1,44 @@
+// Copyright (c) 2022 TikTok Pte. Ltd.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+import pipe from 'sparkling-method';
+/**
+ * Open a new page or route
+ * @param params |
+ * @param callback
+ */
+export function open(params, callback) {
+    if (!params) {
+        const errorResponse = {
+            code: -1,
+            msg: 'Invalid params: params cannot be null or undefined',
+        };
+        if (typeof callback === 'function') {
+            callback(errorResponse);
+        }
+        return;
+    }
+    if (!params.scheme || typeof params.scheme !== 'string' || !params.scheme.trim()) {
+        const errorResponse = {
+            code: -1,
+            msg: 'Invalid params: scheme must be a non-empty string',
+        };
+        if (typeof callback === 'function') {
+            callback(errorResponse);
+        }
+        return;
+    }
+    if (typeof callback !== 'function') {
+        console.error('[sparkling-navigation] open: callback must be a function');
+        return;
+    }
+    pipe.call('router.open', Object.assign({ scheme: params.scheme.trim() }, params.options), (v) => {
+        var _a, _b;
+        const response = v;
+        callback({
+            code: (_a = response === null || response === void 0 ? void 0 : response.code) !== null && _a !== void 0 ? _a : -1,
+            msg: (_b = response === null || response === void 0 ? void 0 : response.msg) !== null && _b !== void 0 ? _b : 'Unknown error',
+        });
+    });
+}
+//# sourceMappingURL=open.js.map

package/dist/src/open/open.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"open.js","sourceRoot":"","sources":["../../../src/open/open.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,yEAAyE;AACzE,0DAA0D;AAC1D,OAAO,IAAI,MAAM,kBAAkB,CAAC;AAGpC;;;;GAIG;AACH,MAAM,UAAU,IAAI,CAAC,MAAmB,EAAE,QAAwC;IAC9E,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,MAAM,aAAa,GAAiB;YAChC,IAAI,EAAE,CAAC,CAAC;YACR,GAAG,EAAE,oDAAoD;SAC5D,CAAC;QACF,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;YACjC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO;IACX,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;QAC/E,MAAM,aAAa,GAAiB;YAChC,IAAI,EAAE,CAAC,CAAC;YACR,GAAG,EAAE,mDAAmD;SAC3D,CAAC;QACF,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;YACjC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO;IACX,CAAC;IAED,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;QACjC,OAAO,CAAC,KAAK,CAAC,0DAA0D,CAAC,CAAC;QAC1E,OAAO;IACX,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,aAAa,kBACnB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IACzB,MAAM,CAAC,OAAO,GAClB,CAAC,CAAU,EAAE,EAAE;;QACd,MAAM,QAAQ,GAAG,CAAiB,CAAC;QACnC,QAAQ,CAAC;YACL,IAAI,EAAE,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,mCAAI,CAAC,CAAC;YAC1B,GAAG,EAAE,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,GAAG,mCAAI,eAAe;SACxC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC"}

package/dist/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"fileNames":["../../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts","../../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.d.ts","../../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts","../../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.core.d.ts","../../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.collection.d.ts","../../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.generator.d.ts","../../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts","../../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.promise.d.ts","../../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.proxy.d.ts","../../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.reflect.d.ts","../../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.symbol.d.ts","../../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts","../../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.decorators.d.ts","../../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.decorators.legacy.d.ts","../../../sparkling-method/dist/types.d.ts","../../../sparkling-method/dist/index.d.ts","../src/close/close.d.ts","../src/close/close.ts","../src/open/open.d.ts","../src/open/open.ts","../src/navigate/navigate.d.ts","../src/navigate/navigate.ts","../index.ts","../../../../node_modules/.pnpm/@jest+expect-utils@29.7.0/node_modules/@jest/expect-utils/build/index.d.ts","../../../../node_modules/.pnpm/chalk@4.1.2/node_modules/chalk/index.d.ts","../../../../node_modules/.pnpm/@sinclair+typebox@0.27.10/node_modules/@sinclair/typebox/typebox.d.ts","../../../../node_modules/.pnpm/@jest+schemas@29.6.3/node_modules/@jest/schemas/build/index.d.ts","../../../../node_modules/.pnpm/pretty-format@29.7.0/node_modules/pretty-format/build/index.d.ts","../../../../node_modules/.pnpm/jest-diff@29.7.0/node_modules/jest-diff/build/index.d.ts","../../../../node_modules/.pnpm/jest-matcher-utils@29.7.0/node_modules/jest-matcher-utils/build/index.d.ts","../../../../node_modules/.pnpm/expect@29.7.0/node_modules/expect/build/index.d.ts","../../../../node_modules/.pnpm/@types+jest@29.5.14/node_modules/@types/jest/index.d.ts"],"fileIdsList":[[26],[28,31],[24,30],[28],[25,29],[27],[17,18,19,20,21,22],[16,17],[19],[20,21],[16,19],[15]],"fileInfos":[{"version":"69684132aeb9b5642cbcd9e22dff7818ff0ee1aa831728af0ecf97d3364d5546","affectsGlobalScope":true,"impliedFormat":1},{"version":"45b7ab580deca34ae9729e97c13cfd999df04416a79116c3bfb483804f85ded4","impliedFormat":1},{"version":"092c2bfe125ce69dbb1223c85d68d4d2397d7d8411867b5cc03cec902c233763","affectsGlobalScope":true,"impliedFormat":1},{"version":"c57796738e7f83dbc4b8e65132f11a377649c00dd3eee333f672b8f0a6bea671","affectsGlobalScope":true,"impliedFormat":1},{"version":"dc2df20b1bcdc8c2d34af4926e2c3ab15ffe1160a63e58b7e09833f616efff44","affectsGlobalScope":true,"impliedFormat":1},{"version":"515d0b7b9bea2e31ea4ec968e9edd2c39d3eebf4a2d5cbd04e88639819ae3b71","affectsGlobalScope":true,"impliedFormat":1},{"version":"0559b1f683ac7505ae451f9a96ce4c3c92bdc71411651ca6ddb0e88baaaad6a3","affectsGlobalScope":true,"impliedFormat":1},{"version":"0dc1e7ceda9b8b9b455c3a2d67b0412feab00bd2f66656cd8850e8831b08b537","affectsGlobalScope":true,"impliedFormat":1},{"version":"ce691fb9e5c64efb9547083e4a34091bcbe5bdb41027e310ebba8f7d96a98671","affectsGlobalScope":true,"impliedFormat":1},{"version":"8d697a2a929a5fcb38b7a65594020fcef05ec1630804a33748829c5ff53640d0","affectsGlobalScope":true,"impliedFormat":1},{"version":"4ff2a353abf8a80ee399af572debb8faab2d33ad38c4b4474cff7f26e7653b8d","affectsGlobalScope":true,"impliedFormat":1},{"version":"936e80ad36a2ee83fc3caf008e7c4c5afe45b3cf3d5c24408f039c1d47bdc1df","affectsGlobalScope":true,"impliedFormat":1},{"version":"8e7f8264d0fb4c5339605a15daadb037bf238c10b654bb3eee14208f860a32ea","affectsGlobalScope":true,"impliedFormat":1},{"version":"782dec38049b92d4e85c1585fbea5474a219c6984a35b004963b00beb1aab538","affectsGlobalScope":true,"impliedFormat":1},"f7633d7fe074d6a4f1d215bbc7a3b27fc0419a5a3bfbbe054ac07f3dbbc68487","bdddec6a06096ab2fc1460e59d0e8c1c954ffe72290bee32bc1ecce28ebe9393","582fe2e974682a46dcee0b08fac869d96c56ec3421ad48633f6289f497acc3fd",{"version":"9b0c2a8e5fd6520272a221f3cb839d2d86ad6007dc100e199ea8954faa0b9178","signature":"f421088758adc5b04e44c1548f2d7ac1cebbdda08458c8e493a490002c8e6f7c"},"b44b08502019a82cfd35f8126a5f4bc2f9384053c6397ad894efb67fbf754f0c",{"version":"70ded95040e639f51662007386a5ea18a258c62cd5071fc5c65bda8b5cf18d2c","signature":"dd1d64b74f46208aecdee3727641eff5c0262826752e37a19ca6b2eb474d45af"},"397fe95fdc9e268e0ca39b0cc9762dd6b6a689c274a8abb60ef68e8484b91bf2",{"version":"514b9ad2ca0453eb6b916a5d6631a8afece0c8cb66d54f57b11b005e4397910c","signature":"e902e6d4f2877e301fa4cf11b50a18c6a1c078bd34edecb15ae62459310004d0"},{"version":"f4ef2dc4d2182f03365773c1c488eb01ebd07186a7d7e3c51eea5eed6c0d5252","signature":"4acdb0a03d91ac0b94410f47337f1dba8f947a74300a305e1e6a14fef3933d07"},{"version":"cdcc132f207d097d7d3aa75615ab9a2e71d6a478162dde8b67f88ea19f3e54de","impliedFormat":1},{"version":"0d14fa22c41fdc7277e6f71473b20ebc07f40f00e38875142335d5b63cdfc9d2","impliedFormat":1},{"version":"e1028394c1cf96d5d057ecc647e31e457b919092f882ed0c7092152b077fed9d","impliedFormat":1},{"version":"f315e1e65a1f80992f0509e84e4ae2df15ecd9ef73df975f7c98813b71e4c8da","impliedFormat":1},{"version":"5b9586e9b0b6322e5bfbd2c29bd3b8e21ab9d871f82346cb71020e3d84bae73e","impliedFormat":1},{"version":"3e70a7e67c2cb16f8cd49097360c0309fe9d1e3210ff9222e9dac1f8df9d4fb6","impliedFormat":1},{"version":"ab68d2a3e3e8767c3fba8f80de099a1cfc18c0de79e42cb02ae66e22dfe14a66","impliedFormat":1},{"version":"d96cc6598148bf1a98fb2e8dcf01c63a4b3558bdaec6ef35e087fd0562eb40ec","impliedFormat":1},{"version":"f8db4fea512ab759b2223b90ecbbe7dae919c02f8ce95ec03f7fb1cf757cfbeb","affectsGlobalScope":true,"impliedFormat":1}],"root":[18,20,22,23],"options":{"composite":true,"declaration":true,"declarationMap":true,"emitDeclarationOnly":false,"esModuleInterop":true,"module":5,"outDir":"./","skipLibCheck":true,"sourceMap":true,"strict":true,"target":2},"referencedMap":[[27,1],[32,2],[31,3],[29,4],[30,5],[28,6],[23,7],[18,8],[21,9],[22,10],[20,11],[16,12]],"latestChangedDtsFile":"../../../common/test-utils/contract.d.ts","version":"5.8.3"}

package/index.ts

@@ -0,0 +1,9 @@
+// Copyright (c) 2022 TikTok Pte. Ltd.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+export * from './src/open/open';
+export * from './src/close/close';
+export * from './src/navigate/navigate';
+export type { OpenRequest, OpenResponse, OpenOptions } from './src/open/open.d';
+export type { CloseRequest, CloseResponse } from './src/close/close.d';
+export type { NavigateRequest, NavigateResponse, NavigateOptions } from './src/navigate/navigate.d';