@doubao-dev/framework 0.0.42 → 0.1.1

package/dist/components.d.ts

@@ -29,6 +29,7 @@ import { ListSnapEvent } from '@lynx-js/types';
 import { ListSnapInfo } from '@lynx-js/types';
 import type { LoadEvent } from '@lynx-js/types';
 import type { NodesRef } from '@lynx-js/types';
+import type { OpenAppResult } from '@byted-doubao-apps/bridge-api';
 import type { ReactElement } from '@byted-lynx/react';
 import type { ReactElement as ReactElement_2 } from 'react';
 import type { ReactNode } from 'react';
@@ -88,6 +89,10 @@ export declare interface Arc {
     zIndex?: number;
 }
 
+export declare type AudioProps = Omit<VideoEngineProps, 'as' | 'style' | 'poster' | 'objectfit' | 'fullscreenMode' | 'resolution' | 'onFirstFrame' | 'scene' | 'onAppear' | 'onDisappear'>;
+
+export declare type AudioRef = VideoEngineRef;
+
 declare interface BounceConfig {
     /**
      * 是否启用回弹效果，当 loop 为 true 时忽略此设置
@@ -206,7 +211,11 @@ export declare interface ButtonProps {
     /**
      * 开放能力类型
      */
-    openType?: 'getPhoneNumber' | 'agreePrivacyAuthorization' | 'agreePrivacyAuthorization|getPhoneNumber' | 'openSetting';
+    openType?: 'getPhoneNumber' | 'agreePrivacyAuthorization' | 'agreePrivacyAuthorization|getPhoneNumber' | 'openSetting' | 'launchApp';
+    /**
+     * 跳转外部应用的 deeplink URL，只在 openType="launchApp" 时有效。
+     */
+    launchAppUrl?: string;
     /**
      * 点击回调函数
      * @eventProperty
@@ -247,6 +256,16 @@ export declare interface ButtonProps {
      * @eventProperty
      */
     onOpenSetting?: (event: OpenSettingEvent) => void;
+    /**
+     * 跳转外部应用回调，只在 openType="launchApp" 时有效。
+     *
+     * 仅在跳转成功时返回跳转结果。
+     */
+    onLaunchApp?: (result: LaunchAppResult) => void;
+    /**
+     * 跳转外部应用失败回调，只在 openType="launchApp" 时有效。
+     */
+    onLaunchAppError?: (error: unknown) => void;
 }
 
 declare type ButtonSize = 'default' | 'medium' | 'mini';
@@ -1005,6 +1024,11 @@ export declare type LatLng = {
     longitude: number;
 };
 
+/**
+ * Button 通过 `openType="launchApp"` 跳转外部应用后的回调结果。
+ */
+export declare type LaunchAppResult = OpenAppResult;
+
 export { ListAttachedCell }
 
 export { ListItemInfo }
@@ -1549,7 +1573,7 @@ export declare interface MapMarkerProps {
 
 export declare type MapMarkerRef = {
     /**
-     * 刷新标记点样式。当自定义内容（children）样式变化时调用此方法更新。
+     * @deprecated 豆包 14.9.0 及以上版本已支持 marker 响应式刷新，无需手动调用。
      */
     refreshMarker: () => void;
 };
@@ -1630,6 +1654,8 @@ export declare interface MapProps {
     showScale?: boolean;
     /**
      * 是否显示当前位置标记。开启后会调用定位 API 获取并监听当前位置变化，使用内置 marker 图标展示。
+     * 使用前需在 Manifest 中声明 `scope.userLocation`，并将该权限配置为 JSB 类型。
+     * 未正确声明时不会触发授权弹窗，也不会展示当前位置标记。
      * @defaultValue false
      */
     showLocation?: boolean;
@@ -4290,8 +4316,8 @@ declare enum VideoEngineOption {
 
 declare type VideoEnginePlaybackCallback = (success: boolean, errCode?: number, errMsg?: string) => void;
 
-export declare interface VideoProps {
-    ref?: ForwardedRef<VideoRef>;
+declare interface VideoEngineProps {
+    ref?: ForwardedRef<VideoEngineRef>;
     /**
      * Style for wrapper, especially for border-radius
      * @zh 包装器的样式，特别用于设置圆角
@@ -4681,7 +4707,7 @@ export declare interface VideoProps {
     onDisappear?: () => void;
 }
 
-export declare interface VideoRef {
+declare interface VideoEngineRef {
     /**
      * Start playing. You should start play after resource redirect (after `onRedirected`)
      * @zh 开始播放。你应该在资源重定向后（`onRedirected`）开始播放
@@ -4851,6 +4877,10 @@ export declare interface VideoRef {
     operatePoster: (display: boolean) => void;
 }
 
+export declare type VideoProps = VideoEngineProps;
+
+export declare type VideoRef = VideoEngineRef;
+
 /**
  * 基础布局容器，用于组织和嵌套其他组件，支持 Flexbox 布局。
  */
@@ -5005,7 +5035,42 @@ declare interface WebGLContextAttributes_2 {
  * // 或按需导入：import { postMessage, onMessage } from '@doubao-dev/webview-jssdk';
  * ```
  *
- * 应用侧：`src` 指向 H5 地址，`ref` 用于拿到 `postMessage`，`onMessage` 接收 H5 消息。
+ * ## H5 可用 API
+ *
+ * WebView JSSDK 当前提供以下 API：
+ *
+ * | API | 返回值 | 说明 |
+ * | --- | --- | --- |
+ * | `doubao.navigateTo({ url })` | `Promise<unknown>` | 保留当前页面，跳转到智能服务内页面 |
+ * | `doubao.navigateBack({ delta? })` | `Promise<unknown>` | 返回智能服务内的上一页或多级页面，`delta` 默认为 `1` |
+ * | `doubao.redirectTo({ url })` | `Promise<unknown>` | 关闭当前页面，跳转到智能服务内页面 |
+ * | `doubao.reLaunch({ url })` | `Promise<unknown>` | 关闭所有页面，跳转到智能服务内页面 |
+ * | `doubao.postMessage({ data })` | `Promise<unknown>` | 向应用侧的 `<web-view onMessage>` 发送消息 |
+ * | `doubao.setTitle({ title })` | `Promise<unknown>` | 设置应用侧 WebView 头部标题 |
+ * | `doubao.onMessage(handler)` | `() => void` | 监听应用侧消息，返回注销函数 |
+ *
+ * 路由 API 的 `url` 是智能服务内页面路径，不是 H5 页面地址。
+ *
+ * ## 安全限制
+ *
+ * 1. **URL 协议限制**：`src` 仅支持 `https://` 协议，不支持 `http://`、`file://` 等其他协议。
+ * 2. **JSB 白名单**：白名单外的 JSB 调用会被拦截并返回错误；其他 API 调用需要通过消息通道
+ *    交给智能服务页面中转。
+ * 3. **域名校验**：需要在豆包智能服务开放平台配置域名白名单，非白名单域名的 URL 将被拒绝加载。
+ *
+ * ## 判断是否在豆包智能服务中打开
+ *
+ * H5 可通过 User-Agent 中是否包含 `DoubaoApps` 判断：
+ *
+ * ```js
+ * const isInDoubaoApps = navigator.userAgent.includes('DoubaoApps');
+ * ```
+ *
+ * ## 双向通信示例
+ *
+ * ### 应用侧
+ *
+ * `src` 指向 H5 地址，`ref` 用于拿到 `postMessage`，`onMessage` 接收 H5 消息。
  *
  * ```tsx
  * import { useRef } from '@doubao-dev/framework';
@@ -5033,7 +5098,9 @@ declare interface WebGLContextAttributes_2 {
  * }
  * ```
  *
- * H5 侧：`doubao.onMessage` 接收应用消息并返回注销函数，`doubao.postMessage` 发送消息给应用。
+ * ### H5 侧
+ *
+ * `doubao.onMessage` 接收应用消息并返回注销函数，`doubao.postMessage` 发送消息给应用。
  *
  * ```js
  * const off = doubao.onMessage((raw) => {
@@ -5050,15 +5117,6 @@ declare interface WebGLContextAttributes_2 {
  * // off();
  * ```
  *
- * 三个容易踩的点：
- *
- * - 首条消息放在 `onLoad` 之后发，H5 尚未加载完成时发送的消息会丢失。
- * - 两个方向的数据形态不同：应用 → H5 时非字符串会被 `JSON.stringify`，H5 收到的是 JSON 字符串，
- *   需要自行 `JSON.parse`；H5 → 应用时 `onMessage` 的 `event.data` 保持 H5 传入的原始值。
- * - 如果两侧都写成“收到就回”，务必按消息 `type` 区分，否则会无限互相回声。
- *
- * 除消息通道外，H5 还可以调用 `doubao.setTitle({ title })` 同步应用侧 WebView 头部标题。
- *
  * ## Web 模拟器差异
  *
  * Web 模拟器中的 `<web-view>` 通过本地代理承载 H5 页面，页面脚本读取到的
@@ -5072,7 +5130,7 @@ export declare interface WebViewProps {
      */
     ref?: Ref<WebViewRef>;
     /**
-     * 网页资源地址
+     * 网页资源地址，仅支持 `https://` 协议；需要在豆包智能服务开放平台配置白名单，并通过校验
      */
     src?: string;
     /**

package/dist/config.d.ts

@@ -253,7 +253,18 @@ export declare interface DoubaoAppsPlugin {
     setup: (api: any) => void | Promise<void>;
 }
 
-export declare type DoubaoAppsToolConfig = string[];
+export declare type DoubaoAppsToolConfig = DoubaoAppsToolEntryConfig[];
+
+export declare type DoubaoAppsToolEntryConfig = string | ({
+    entry: string;
+} & DoubaoAppsToolMetaConfig);
+
+export declare type DoubaoAppsToolMetaConfig = {
+    /**
+     * Tool name. Defaults to the entry directory name.
+     */
+    name?: string;
+};
 
 export declare type DoubaoAppsWidgetConfig = DoubaoAppsWidgetEntryConfig[] | DoubaoAppsLegacyEntryConfig<DoubaoAppsWidgetMetaConfig>;