@doubao-dev/framework 0.0.40 → 0.0.42

package/dist/config.d.ts

@@ -27,6 +27,14 @@ declare interface AIAppMetadata {
      * 应用版本
      */
     version?: string;
+    /**
+     * 是否声明小程序已适配深色模式
+     */
+    darkMode?: boolean;
+    /**
+     * 应用级对话框能力配置
+     */
+    chat?: AppletChatConfig;
 }
 
 declare type AIPageMetadata = Omit<PageDefinition, 'entry' | 'renderType' | 'digest' | 'web'>;
@@ -73,6 +81,38 @@ declare type AIWidgetMetadata = {
     titleType?: 'none' | 'normal' | 'float';
 };
 
+declare interface AppletChatConfig {
+    /**
+     * App-level chat feature overrides.
+     */
+    features?: AppletChatFeaturesConfig;
+}
+
+declare interface AppletChatFeatureConfig {
+    /**
+     * Whether the chat feature is enabled.
+     */
+    enabled: boolean;
+}
+
+declare interface AppletChatFeaturesConfig {
+    /**
+     * Camera entry configuration.
+     */
+    camera?: AppletChatFeatureConfig;
+    /**
+     * Extra actions entry configuration.
+     */
+    extraActions?: AppletChatFeatureConfig;
+}
+
+declare interface AppletPageChatConfig {
+    /**
+     * Whether the chat panel is enabled on this page.
+     */
+    enabled: boolean;
+}
+
 declare interface BaseDefinition {
     /**
      * Unique identifier
@@ -169,6 +209,10 @@ export declare interface DoubaoAppsMetaConfig extends AIAppMetadata {
      * Widget entries and widget metadata.
      */
     widgets?: DoubaoAppsWidgetConfig;
+    /**
+     * Client Tool entries relative to `src/`.
+     */
+    tools?: DoubaoAppsToolConfig;
 }
 
 export declare type DoubaoAppsObject = Record<string, unknown>;
@@ -209,6 +253,8 @@ export declare interface DoubaoAppsPlugin {
     setup: (api: any) => void | Promise<void>;
 }
 
+export declare type DoubaoAppsToolConfig = string[];
+
 export declare type DoubaoAppsWidgetConfig = DoubaoAppsWidgetEntryConfig[] | DoubaoAppsLegacyEntryConfig<DoubaoAppsWidgetMetaConfig>;
 
 export declare type DoubaoAppsWidgetEntryConfig = string | ({
@@ -217,7 +263,7 @@ export declare type DoubaoAppsWidgetEntryConfig = string | ({
 
 export declare type DoubaoAppsWidgetMetaConfig = Omit<AIWidgetMetadata, 'id'> & {
     /**
-     * Widget ID. Defaults to the entry directory name.
+     * Globally unique Widget ID. Defaults to the entry directory name.
      */
     id?: string;
     name?: string;
@@ -237,6 +283,12 @@ export declare type DoubaoAppsWidgetMetaConfig = Omit<AIWidgetMetadata, 'id'> &
 export declare type Icons = string | Record<'1x' | '2x' | '3x', string>;
 
 declare interface PageDefinition extends UIModuleDefinition {
+    /**
+     * The legacy page identifier.
+     *
+     * @deprecated Use `path` as the Page identity.
+     */
+    id: string;
     /**
      * The page navbar title
      */
@@ -245,6 +297,10 @@ declare interface PageDefinition extends UIModuleDefinition {
      * The page path
      */
     path: string;
+    /**
+     * Page-level chat panel configuration.
+     */
+    chat?: AppletPageChatConfig;
 }
 
 export declare interface TaroPluginOptions {

package/dist/index.d.ts

@@ -101,52 +101,9 @@ import { useSyncExternalStore } from 'react';
 import { VFC } from 'react';
 import { VoidFunctionComponent } from 'react';
 
-declare interface AgreePrivacyResult {
-    /** Whether the save was successful */
-    result: boolean;
-}
+export declare type AgentEventCallback = (payload: AgentEventPayload) => void;
 
-declare interface AIAppMetadata {
-    /**
-     *
-     *  豆包应用 ID
-     *
-     */
-    appId: string;
-    /**
-     * 应用名称
-     */
-    name?: string;
-    /**
-     * 应用描述
-     */
-    description?: string;
-    /**
-     * 应用图标
-     *
-     * 1x, 2x, 3x 分别对应 1x, 2x, 3x 倍的图标
-     */
-    icons?: Icons;
-    /**
-     * 应用关键词
-     */
-    keywords?: string[];
-    /**
-     * 应用版本
-     */
-    version?: string;
-}
-
-export declare type AIToolContext = MessageMeta & {
-    /**
-     * callback Id
-     */
-    callbackId: string;
-    /**
-     * feature map
-     */
-    featureMap: Record<string, string> | undefined;
-};
+declare type AgentEventPayload = Record<string, unknown>;
 
 export declare type AIViewContext = MessageMeta & {
     /**
@@ -184,18 +141,6 @@ export declare type AIViewContext = MessageMeta & {
     };
 };
 
-export declare type AnyObject = Record<string, any>;
-
-export declare type App<T extends DefineAppOptions = DefineAppOptions> = T & {
-    __APP__: boolean;
-    __UI__: boolean;
-};
-
-declare type AppAIMeta = Omit<AIAppMetadata, 'appId'> & {
-    appId?: string;
-    package?: string;
-};
-
 export { Attributes }
 
 export { CElement }
@@ -262,195 +207,6 @@ export declare interface CurrentPage {
 
 export { CustomComponentPropsWithRef }
 
-export declare function defineApp<T extends DefineAppOptions>(options: T & ThisType<T & {
-    readonly aiMeta: AppAIMeta;
-}>): App<T>;
-
-export declare interface DefineAppOptions {
-    [key: string]: any;
-    /**
-     * @deprecated Configure app metadata in src/app.config.ts instead.
-     *
-     * @example
-     * ```ts
-     * // src/app.config.ts
-     * import { defineAppConfig } from '@doubao-dev/framework/config';
-     *
-     * export default defineAppConfig({
-     *   appId: 'your-app-id',
-     *   name: 'Demo App',
-     *   description: 'Describe what this app can do',
-     *   icons: 'https://example.com/icon.png',
-     *   keywords: ['demo', 'doubao']
-     * });
-     * ```
-     */
-    aiMeta?: AppAIMeta;
-    /**
-     * App launched
-     */
-    onLaunch?: () => void;
-    /**
-     * On page opened
-     */
-    onPageOpened?: (params: {
-        viewId: string;
-    }) => void;
-    /**
-     * On foreground
-     */
-    onForeground?: () => void;
-    /**
-     * On background
-     */
-    onBackground?: () => void;
-    /**
-     * On destroy
-     */
-    onDestroy?: () => void;
-    /**
-     * Handle errors from other lifecycle hooks in this class or from tools in same Applet
-     */
-    onError?: (e: Error) => void;
-}
-
-export declare interface DefineFunctionalToolOptions extends Tool {
-    onApply: (input: string, context: AIToolContext) => string | object | Promise<string | object>;
-}
-
-export declare function defineLoginApi(api: LoginApi): LoginApi;
-
-/**
- * 定义 MCP 登录页面
- * @param options 定义 MCP 登录页面的选项
- * @returns 智能服务 MCP 登录页面
- */
-export declare function defineLoginPage<Data extends AnyObject>(options: Omit<DefinePageToolOptions<Data>, 'aiMeta'> & ThisType<Readonly<PageInstanceMethods<Data>>>): Page<Data>;
-
-export declare function definePage<Data extends AnyObject>(options: DefinePageToolOptions<Data> & ThisType<Readonly<PageInstanceMethods<Data>>>): Page<Data>;
-
-export declare interface DefinePageToolOptions<Data extends AnyObject> extends DefineUIToolOptions<Data, PageToolExtraMetadata> {
-    /**
-     * @deprecated Configure page metadata in src/app.config.ts instead.
-     *
-     * Use `pages` entries in `src/app.config.ts`. For example,
-     * `pages/home/index` maps to `src/pages/home/index.tsx`, and
-     * `pages/account/demo/index` maps to `src/pages/account/demo/index.tsx`.
-     *
-     * @example
-     * ```ts
-     * // src/app.config.ts
-     * import { defineAppConfig } from '@doubao-dev/framework/config';
-     *
-     * export default defineAppConfig({
-     *   appId: 'your-app-id',
-     *   pages: ['pages/home/index']
-     * });
-     * ```
-     */
-    aiMeta?: PageToolMetadata;
-}
-
-export declare function definePrivacyApi(api: PrivacyApi): PrivacyApi;
-
-/**
- * 定义 MCP 同意登录和隐私协议卡片组件
- * @param options 定义 MCP 同意登录和隐私协议卡片组件的选项
- * @returns MCP 同意登录和隐私协议卡片组件
- */
-export declare function definePrivacyLoginWidget<Data extends AnyObject>(options: Omit<DefineWidgetToolOptions<Data>, 'aiMeta'> & ThisType<Readonly<WidgetInstanceMethods<Data>>>): Widget<Data>;
-
-export declare function defineTool(options: DefineFunctionalToolOptions & ThisType<Readonly<FunctionalToolInstanceMethods>>): FunctionalTool;
-
-export declare interface DefineUIToolOptions<Data extends AnyObject, Extra extends AnyObject = AnyObject> extends Tool<Extra> {
-    /**
-     * Initial data
-     */
-    data?: Data;
-    /**
-     * Trigger on view created
-     * @returns
-     */
-    onCreated?: () => void;
-    /**
-     * It is triggered after the view is rendered and will only be called once in the view's life cycle.
-     * @returns
-     */
-    onMounted?: () => void;
-    /**
-     * 1. It is triggered when the view is first displayed.
-     * 2. It is triggered when the view is displayed again after being hidden.
-     * @returns
-     */
-    onShow?: () => void;
-    /**
-     * It is triggered when the view is hidden.
-     * @returns
-     */
-    onHide?: () => void;
-    /**
-     * It is triggered when the view is destroyed.
-     * @returns
-     */
-    onDestroy?: () => void;
-    /**
-     * It is triggered when an error occurs.
-     * @param e
-     * @returns
-     */
-    onError?: (e: Error) => void;
-    /**
-     * Render function
-     * Use getViewData() and getViewContext() to access data and context
-     * @returns
-     */
-    render: () => ReactNode;
-}
-
-export declare function defineWidget<Data extends AnyObject>(options: DefineWidgetToolOptions<Data> & ThisType<Readonly<WidgetInstanceMethods<Data>>>): Widget<Data>;
-
-export declare interface DefineWidgetToolOptions<Data extends AnyObject> extends DefineUIToolOptions<Data, WidgetToolExtraMetadata> {
-    /**
-     * @deprecated Configure widget metadata in src/app.config.ts instead.
-     *
-     * Use `widgets` entries in `src/app.config.ts`. For example,
-     * `widgets/card/index` maps to `src/widgets/card/index.tsx`, and
-     * `widgets/api/demo/index` maps to `src/widgets/api/demo/index.tsx`.
-     *
-     * @example
-     * ```ts
-     * // src/app.config.ts
-     * import { defineAppConfig } from '@doubao-dev/framework/config';
-     *
-     * export default defineAppConfig({
-     *   appId: 'your-app-id',
-     *   widgets: [
-     *     {
-     *       entry: 'widgets/card/index',
-     *       id: 'card-widget',
-     *       name: 'Card Widget',
-     *       description: 'Show card content',
-     *       border: true
-     *     }
-     *   ]
-     * });
-     * ```
-     */
-    aiMeta?: WidgetToolMetadata;
-    /**
-     * 1. It is triggered when the app returns to the foreground from the background.
-     * 2. It is triggered when phone is unlocked.
-     * @returns
-     */
-    onForeground?: () => void;
-    /**
-     * 1. It is triggered when the app is moved to the background.
-     * 2. It is triggered when phone is locked.
-     * @returns
-     */
-    onBackground?: () => void;
-}
-
 export { DependencyList }
 
 export { DeprecatedLifecycle }
@@ -485,46 +241,24 @@ export { ForwardRefRenderFunction }
 
 export { Fragment }
 
-export declare interface FunctionalTool extends DefineFunctionalToolOptions {
-    __FUNCTIONAL__: boolean;
-}
-
-declare type FunctionalToolInstanceMethods = Tool<ToolMetadata>;
-
 export { FunctionComponent }
 
 export { FunctionComponentElement }
 
 export { FunctionComponentFactory }
 
-declare function getApp_2<T extends App = App>(): T;
-export { getApp_2 as getApp }
-
 export declare function getCurrentPages(): CurrentPage[];
 
 export { GetDerivedStateFromError }
 
 export { GetDerivedStateFromProps }
 
-declare interface GetPhoneNumberResult {
-    /**
-     * 获取手机号结果码。
-     */
-    code?: string;
-    /**
-     * 获取手机号结果信息。
-     */
-    message?: string;
-}
-
 export declare function getViewContext(): any;
 
 export declare function getViewData<T extends Record<string, any>>(): T;
 
 export declare function getWidgetInstanceId(): string | undefined;
 
-declare type Icons = string | Record<'1x' | '2x' | '3x', string>;
-
 export { isValidElement }
 
 export { JSXElementConstructor }
@@ -541,13 +275,6 @@ declare type LifecycleCallback = () => void;
 
 declare type LifecycleErrorCallback = (error: Error) => void;
 
-export declare interface LoginApi {
-    onLogin: (res: LoginResult) => Promise<void> | void;
-    onRefuseLogin: () => Promise<void> | void;
-}
-
-export declare type LoginResult = GetPhoneNumberResult;
-
 export { memo }
 
 export { MemoExoticComponent }
@@ -577,41 +304,23 @@ export declare interface MessageMeta {
 
 export { Mixin }
 
-export { MutableRefObject }
-
-export { NamedExoticComponent }
-
-export { NewLifecycle }
-
 /**
- * Register the runtime error handler.
- *
- * Calling this again replaces the previously registered handler.
+ * 页面模型上下文控制器。
  */
-export declare function onError(callback: (error: Error) => void): void;
-
-export declare interface Page<Data extends AnyObject = AnyObject> extends DefineUIToolOptions<Data> {
-    __UI__: boolean;
-    __PAGE__: boolean;
-}
-
-declare type PageInstanceMethods<Data extends AnyObject> = UIInstanceMethods<Data, PageToolExtraMetadata>;
-
-declare type PageToolExtraMetadata = {
+export declare interface ModelContext {
     /**
-     * The page navbar title
+     * 设置当前页面的完整上下文。
+     *
+     * 同一页面内重复调用会更新已有上下文，请传入当前页面的完整信息。
      */
-    title?: string;
-};
+    setPageContext: (params: SetPageContextParams) => ReturnType<typeof setPageModelContext>;
+}
 
-export declare type PageToolMetadata = ToolMeta & PageToolExtraMetadata;
+export { MutableRefObject }
 
-export declare type PrivacyAgreeResult = AgreePrivacyResult;
+export { NamedExoticComponent }
 
-export declare interface PrivacyApi {
-    onAgreePrivacy: (res: PrivacyAgreeResult) => Promise<void> | void;
-    onRefusePrivacy: () => Promise<void> | void;
-}
+export { NewLifecycle }
 
 export { PropsWithChildren }
 
@@ -653,6 +362,16 @@ export { RefCallback }
 
 export { RefObject }
 
+/**
+ * 设置页面模型上下文的参数。
+ */
+export declare interface SetPageContextParams {
+    taskId: string;
+    pageInfo: Record<string, unknown>;
+}
+
+declare const setPageModelContext: (params: SetPageContextParams) => Promise<object>;
+
 export { SetStateAction }
 
 export { SFCFactory }
@@ -663,56 +382,11 @@ export { Suspense }
 
 export { SVGFactory }
 
-export declare interface Tool<Extra extends AnyObject = AnyObject> {
-    aiMeta?: ToolMeta & Extra;
-}
-
-export declare interface ToolMeta {
-    /**
-     * unique identifier
-     */
-    id: string;
-    /**
-     * name of the tool
-     */
-    name?: string;
-    /**
-     * description of the tool
-     */
-    description?: string;
-    /**
-     * Widget title type
-     * - none: 默认，无标题
-     * - normal: 常规标题
-     * - float: 浮动标题
-     */
-    titleType?: 'none' | 'normal' | 'float';
-}
-
-export declare type ToolMetadata = {
-    /**
-     * specifies when a call to a tool will time out, in ms.
-     */
-    timeout?: number;
-};
-
 export { TransitionFunction }
 
 export { TransitionStartFunction }
 
-export declare interface UIInstanceMethods<Data extends AnyObject, Extra extends AnyObject = AnyObject> extends Tool<Extra> {
-    /**
-     * Instance data
-     */
-    data: Data;
-    /**
-     * Set data asynchronously and trigger view re-rendering
-     * @param data
-     * @param callback
-     * @returns
-     */
-    setData: (data: Partial<Data> & AnyObject, callback?: () => void) => Promise<void>;
-}
+export declare function useAgentEvent(eventName: string, callback: AgentEventCallback): void;
 
 export declare function useBackground(callback: LifecycleCallback): void;
 
@@ -738,6 +412,29 @@ export { useImperativeHandle }
 
 export { useMemo }
 
+/**
+ * 获取页面模型上下文控制器。
+ *
+ * @example
+ * ```typescript
+ * import { useEffect, useModelContext } from '@doubao-dev/framework';
+ *
+ * function Page() {
+ *   const modelContext = useModelContext();
+ *
+ *   useEffect(() => {
+ *     modelContext.setPageContext({
+ *       taskId: 'page-session-001',
+ *       pageInfo: { route: ['route-1'] }
+ *     });
+ *   }, [modelContext]);
+ *
+ *   return <view />;
+ * }
+ * ```
+ */
+export declare function useModelContext(): ModelContext;
+
 export declare function useMounted(callback: LifecycleCallback): void;
 
 export { useReducer }
@@ -756,37 +453,4 @@ export { VFC }
 
 export { VoidFunctionComponent }
 
-export declare interface Widget<Data extends AnyObject = AnyObject> extends DefineWidgetToolOptions<Data> {
-    __UI__: boolean;
-    __WIDGET__: boolean;
-    setData: (data: Partial<Data>, callback?: () => void) => void;
-}
-
-declare type WidgetInstanceMethods<Data extends AnyObject> = UIInstanceMethods<Data, WidgetToolExtraMetadata>;
-
-declare type WidgetToolExtraMetadata = {
-    /**
-     * Widget box type in Chat UI
-     */
-    boxType?: 'inbox' | 'full_box';
-    /**
-     * Whether add widget border
-     */
-    border?: boolean;
-    /**
-     * Keywords of things
-     */
-    keywords?: string[];
-    /**
-     * Icons
-     */
-    icons?: Icons;
-    /**
-     * Set extra widget properties
-     */
-    prop?: string;
-};
-
-export declare type WidgetToolMetadata = ToolMeta & WidgetToolExtraMetadata;
-
 export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doubao-dev/framework",
-  "version": "0.0.40",
+  "version": "0.0.42",
   "type": "module",
   "types": "./dist/index.d.ts",
   "exports": {