@doubao-dev/framework 0.2.2 → 0.3.0-canary-5aeb29861-20260915084944

package/dist/api.d.ts

@@ -2361,7 +2361,7 @@ export declare type DeviceOrientation = 'portrait' | 'landscape';
  * 关闭页面返回前提醒。
  *
  * @returns 返回一个 Promise，在当前页面的返回提醒关闭后 resolve。
- * @since 0.0.43
+ * @since 0.2.0
  * @platformSupport Android | supported | 支持关闭当前页面已开启的返回提醒。
  * @platformSupport iOS | supported | 支持关闭当前页面已开启的返回提醒。
  * @platformSupport PC | unsupported | 当前未提供该平台实现。
@@ -2748,7 +2748,7 @@ export declare interface DypayParams {
  * 配合 disableAlertBeforeUnload 使用。
  * @param params 返回提醒参数，字段见 {@link EnableAlertBeforeUnloadParams}。
  * @returns 返回一个 Promise，在当前页面的返回提醒开启或更新后 resolve。
- * @since 0.0.43
+ * @since 0.2.0
  * @platformSupport Android | supported | 支持为当前页面开启返回提醒并更新提示文案。
  * @platformSupport iOS | supported | 支持为当前页面开启返回提醒并更新提示文案。
  * @platformSupport PC | unsupported | 当前未提供该平台实现。
@@ -4130,12 +4130,13 @@ export declare interface GetConnectedWifiResult {
  * @containerSupport Widget | supported
  * @platformSupport Android | supported | 支持获取设备信息
  * @platformSupport iOS | supported | 支持获取设备信息
- * @platformSupport PC | unsupported | 暂不支持
+ * @platformSupport PC | supported | Flow Web 支持获取设备信息
  * @platformSupport HarmonyOS | unsupported | 暂不支持
- * @permission none | - | none | Android,iOS | 无需额外权限
+ * @permission none | - | none | Android,iOS,PC | 无需额外权限
  * @precondition All | 无额外前置条件
  * @platformNote Android | `abi`、`deviceAbi`、`cpuType` 仅 Android 返回
  * @platformNote iOS | 不返回 `abi`、`deviceAbi`、`cpuType`
+ * @platformNote PC | Flow Web 浏览器的 `platform` 返回 `web`；Windows、macOS 桌面客户端分别返回 `windows`、`mac`，不返回 Android 专属字段
  * @resultExample
  * ```json
  * {
@@ -4147,7 +4148,7 @@ export declare interface GetConnectedWifiResult {
  *   "memorySize": "8192"
  * }
  * ```
- * @errorCode none | - | - | Android,iOS | 当前实现未稳定返回顶层 errNo/errMsg | 根据异常信息重试
+ * @errorCode none | - | - | Android,iOS,PC | 当前实现未稳定返回顶层 errNo/errMsg | 根据异常信息重试
  *
  * @public
  */
@@ -7555,7 +7556,7 @@ export declare interface OpenLocationParams {
  * });
  * ```
  *
- * @since 0.0.43
+ * @since 0.2.0
  * @platformSupport Android | supported | 支持 push、replace、navigate 和 pop_to 页面栈操作。
  * @platformSupport iOS | supported | 支持 push、replace、navigate 和 pop_to 页面栈操作。
  * @platformSupport PC | unsupported | 当前未提供该平台实现。
@@ -7585,7 +7586,7 @@ export declare const openPage: (params: OpenPageParams) => Promise<object>;
  * });
  * ```
  *
- * @since 0.0.43
+ * @since 0.2.0
  * @containerSupport Page | supported
  * @containerSupport Widget | supported
  * @platformSupport Android | supported | 支持在当前关联的主对话流中以半屏形式打开应用内页面。

package/dist/components.d.ts

@@ -648,7 +648,7 @@ export { ContentSizeChangedEvent }
  * 自定义地图样式 ID。
  * @since 0.2.1
  */
-export declare type CustomMapStyleId = string;
+export declare type CustomMapStyleId = string & Record<never, never>;
 
 export declare const DoubaoPaymentButton: typeof DoubaoPaymentButton_2;
 
@@ -1453,7 +1453,7 @@ export declare interface LongImageProps {
      */
     scrollEventThrottle?: number;
     /**
-     * 非激活分段占位背景色。
+     * 非激活分段或分段图片加载失败时的占位背景色。
      * @defaultValue 'transparent'
      */
     placeholderColor?: string;
@@ -1540,7 +1540,7 @@ export declare interface LongImageSegmentProps {
      */
     active?: boolean;
     /**
-     * 非激活分段占位背景色。
+     * 非激活分段或分段图片加载失败时的占位背景色。
      * @defaultValue 'transparent'
      */
     placeholderColor?: string;
@@ -1875,6 +1875,10 @@ export declare interface MapProps {
      * 地图加载完成时触发。
      */
     onMapLoaded?: () => void;
+    /**
+     * 地图首个瓦片加载完成时触发。
+     */
+    onMapTileLoaded?: () => void;
     /**
      * 视野开始或结束变化时触发。回调参数包含变化阶段 `type`，以及可选的缩放级别、中心点和可视区域等信息。
      */
@@ -3030,6 +3034,11 @@ export declare interface Polyline {
      * 路线唯一标识。
      */
     id: string;
+    /**
+     * 是否参与 POI 碰撞避让。
+     * @defaultValue false
+     */
+    collideDetection?: boolean;
     /**
      * 路线点数组。
      */
@@ -3511,7 +3520,7 @@ export declare interface RenderLongImageSegmentsOptions {
      */
     mode?: 'view' | 'list';
     /**
-     * 非激活分段占位背景色。
+     * 非激活分段或分段图片加载失败时的占位背景色。
      * @defaultValue 'transparent'
      */
     placeholderColor?: string;

package/dist/config.d.ts

@@ -53,9 +53,9 @@ declare type AIWidgetMetadata = {
      */
     description?: string;
     /**
-     * Widget box type in Chat UI
+     * Widget box type in Chat UI. custom_box leaves background, radius and border to the business UI.
      */
-    boxType?: 'inbox' | 'full_box';
+    boxType?: 'inbox' | 'full_box' | 'custom_box';
     /**
      * Whether add widget border
      */
@@ -86,6 +86,14 @@ declare interface AppletChatConfig {
      * App-level chat feature overrides.
      */
     features?: AppletChatFeaturesConfig;
+    /**
+     * Placeholder text for the chat input in text input mode.
+     */
+    inputHint?: string;
+    /**
+     * Hint text for the chat input in voice input mode.
+     */
+    speakHint?: string;
 }
 
 declare interface AppletChatFeatureConfig {
@@ -279,7 +287,7 @@ export declare type DoubaoAppsWidgetMetaConfig = Omit<AIWidgetMetadata, 'id'> &
     id?: string;
     name?: string;
     description?: string;
-    boxType?: 'inbox' | 'full_box';
+    boxType?: AIWidgetMetadata['boxType'];
     border?: boolean;
     keywords?: string[];
     icons?: Icons;

package/dist/index.d.ts

@@ -200,6 +200,48 @@ export declare type AIViewContext = MessageMeta & {
     };
 };
 
+declare type AIWidgetMetadata = {
+    /**
+     * The widget unique identifier
+     */
+    id: string;
+    /**
+     * widget name
+     */
+    name?: string;
+    /**
+     * Describe the characteristics of widget
+     */
+    description?: string;
+    /**
+     * Widget box type in Chat UI. custom_box leaves background, radius and border to the business UI.
+     */
+    boxType?: 'inbox' | 'full_box' | 'custom_box';
+    /**
+     * Whether add widget border
+     */
+    border?: boolean;
+    /**
+     * Keywords of things
+     */
+    keywords?: string[];
+    /**
+     * Icons
+     */
+    icons?: Icons;
+    /**
+     * Set extra widget properties
+     */
+    prop?: string;
+    /**
+     * Widget title type
+     * - none: 默认，无标题
+     * - normal: 常规标题
+     * - float: 浮动标题
+     */
+    titleType?: 'none' | 'normal' | 'float';
+};
+
 export declare type AnyObject = Record<string, any>;
 
 export declare type App<T extends DefineAppOptions = DefineAppOptions> = T & {
@@ -218,6 +260,14 @@ declare interface AppletChatConfig {
      * App-level chat feature overrides.
      */
     features?: AppletChatFeaturesConfig;
+    /**
+     * Placeholder text for the chat input in text input mode.
+     */
+    inputHint?: string;
+    /**
+     * Hint text for the chat input in voice input mode.
+     */
+    speakHint?: string;
 }
 
 declare interface AppletChatFeatureConfig {
@@ -682,17 +732,6 @@ export declare interface Page<Data extends AnyObject = AnyObject> extends Define
 
 declare type PageInstanceMethods<Data extends AnyObject> = UIInstanceMethods<Data, PageToolExtraMetadata>;
 
-/**
- * 宿主提供的页面运行时元数据。
- *
- * @since 0.1.2
- * @public
- */
-export declare interface PageMeta {
-    /** 是否由 openPageInChat 打开；表示打开来源，不随半屏尺寸变化而改变。 */
-    readonly isInChat: boolean;
-}
-
 declare type PageToolExtraMetadata = {
     /**
      * The page navbar title
@@ -755,6 +794,7 @@ export { RefObject }
 export declare interface SetPageContextParams {
     taskId: string;
     pageInfo: Record<string, unknown>;
+    pageName?: string;
 }
 
 declare const setPageModelContext: (params: SetPageContextParams) => Promise<object>;
@@ -871,41 +911,59 @@ export declare function useModelContext(): ModelContext;
 
 export declare function useMounted(callback: LifecycleCallback): void;
 
+export { useReducer }
+
+export { useRef }
+
+export declare function useShow(callback: LifecycleCallback): void;
+
+export { useState }
+
+export { useSyncExternalStore }
+
+export declare function useViewData<T extends Record<string, any> = Record<string, any>>(): T;
+
 /**
- * 读取当前页面的运行时元数据。
+ * 读取当前视图的运行时元数据。
  *
- * 在 Page / Widget 函数组件顶层调用。宿主未接入或未提供标记时，isInChat 为 false。
+ * 在 Page / Widget（卡片）函数组件顶层调用。宿主未接入或未提供标记时，isOpenedInChat 为 false。
  * 每次调用读取当前值，不订阅宿主更新，也不会主动触发组件渲染。
  *
- * @returns 页面运行时元数据，字段见 {@link PageMeta}。
+ * @returns 视图运行时元数据，字段见 {@link ViewMeta}。
  * @example
  * ```tsx
- * import { usePageMeta } from '@doubao-dev/framework';
+ * import { useViewMeta } from '@doubao-dev/framework';
  *
  * function Page() {
- *   const { isInChat } = usePageMeta();
- *   return <text>{isInChat ? '对话内页面' : '普通页面'}</text>;
+ *   const { isOpenedInChat } = useViewMeta();
+ *   return <text>{isOpenedInChat ? '对话内页面' : '普通页面'}</text>;
  * }
  * ```
- * @since 0.1.2
+ * @since 0.3.0
  * @public
  */
-export declare function usePageMeta(): PageMeta;
-
-export { useReducer }
-
-export { useRef }
-
-export declare function useShow(callback: LifecycleCallback): void;
-
-export { useState }
-
-export { useSyncExternalStore }
-
-export declare function useViewData<T extends Record<string, any> = Record<string, any>>(): T;
+export declare function useViewMeta(): ViewMeta;
 
 export { VFC }
 
+/**
+ * 宿主提供的视图运行时元数据。
+ *
+ * @since 0.3.0
+ * @public
+ */
+export declare interface ViewMeta {
+    /** 当前视图是否为 Page；入口类型标记缺失时为 false。 */
+    readonly isPage: boolean;
+    /** 当前视图是否为 Widget（卡片）；入口类型标记缺失时为 false。 */
+    readonly isWidget: boolean;
+    /**
+     * 页面是否由 openPageInChat 打开；Widget（卡片）为 false，不表示是否展示在聊天中。
+     * 表示打开来源，不随半屏尺寸变化而改变。
+     */
+    readonly isOpenedInChat: boolean;
+}
+
 export { VoidFunctionComponent }
 
 export declare interface Widget<Data extends AnyObject = AnyObject> extends DefineWidgetToolOptions<Data> {
@@ -920,7 +978,7 @@ declare type WidgetToolExtraMetadata = {
     /**
      * Widget box type in Chat UI
      */
-    boxType?: 'inbox' | 'full_box';
+    boxType?: AIWidgetMetadata['boxType'];
     /**
      * Whether add widget border
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doubao-dev/framework",
-  "version": "0.2.2",
+  "version": "0.3.0-canary-5aeb29861-20260915084944",
   "type": "module",
   "types": "./dist/index.d.ts",
   "exports": {
@@ -68,7 +68,7 @@
     "types.d.ts"
   ],
   "dependencies": {
-    "@lynx-js/types": "4.1.0",
+    "@lynx-js/types": "4.2.1",
     "@types/react": "18.3.27"
   },
   "publishConfig": {