@ai0x0/sdk - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

es/types.d.ts

@@ -11,4 +11,13 @@ export interface CustomPreset {
     accompanyingMode?: 'query' | 'input' | 'none' | 'all';
+    /**
+     * 设置后会变为预设包
+     */
     children?: CustomPreset[];
+    /**
+     * 描述
+     */
     description?: string;
+    /**
+     * 是否禁用
+     */
     disable?: boolean;
@@ -35,3 +44,9 @@ /**
     startText?: string;
+    /**
+     * 表单模式模版
+     */
     template?: string;
+    /**
+     * 输入模式时的输入类型
+     */
     type: 'Text' | 'Doc' | 'Code' | 'Markdown';
@@ -50,2 +65,5 @@ }
     label: string;
+    /**
+     * 点击事件
+     */
     onClick: () => void;
@@ -63,23 +81,81 @@ }
     label: string;
+    /**
+     * 点击事件
+     */
     onClick: () => void;
 }
+/**
+ * 悬浮球配置
+ */
 export type SDKConfig = {
+    /**
+     * 对话界面是否是置顶状态
+     */
     chatIsAlwaysOnTop?: boolean;
+    /**
+     * 对话界面是否是焦点状态
+     */
     chatIsFocused?: boolean;
+    /**
+     * 对话界面是否是显示状态
+     */
     chatIsVisible?: boolean;
+    /**
+     * 当前应用改变
+     * @param app
+     */
     onAppChange?: (app: {
+        /**
+         * 是否全屏
+         */
         isFullScreen: boolean;
+        /**
+         * 名称
+         */
         name: string;
+        /**
+         * 路径
+         */
         path: string;
+        /**
+         * 标题
+         */
         title: string;
     }) => void;
+    /**
+     * 对话窗口隐藏
+     */
     onChatHide?: () => void;
+    /**
+     * 对话窗口显示
+     */
     onChatShow?: () => void;
+    /**
+     * 对话开始
+     * @param message
+     */
     onChatStart?: ({ message }: {
         message: string;
     }) => void;
+    /**
+     * 对话停止
+     */
     onChatStop?: () => void;
+    /**
+     * 打开设置
+     */
     onSettingsOpen?: () => void;
+    /**
+     * 面板操作按钮
+     * @param actions
+     */
     panelActions?: (actions: SDKMenuItem[]) => void;
+    /**
+     * 面板开关按钮
+     * @param actions
+     */
     panelCheckboxs?: (actions: SDKCheckboxItem[]) => void;
+    /**
+     * 功能预设
+     */
     presets?: CustomPreset[];
@@ -86,0 +162,0 @@ };

es/types.js

@@ -1,3 +0,5 @@
-// 悬浮球配置
+/**
+ * 悬浮球配置
+ */
 
 export var _ = function _() {};

lib/types.d.ts

@@ -11,4 +11,13 @@ export interface CustomPreset {
     accompanyingMode?: 'query' | 'input' | 'none' | 'all';
+    /**
+     * 设置后会变为预设包
+     */
     children?: CustomPreset[];
+    /**
+     * 描述
+     */
     description?: string;
+    /**
+     * 是否禁用
+     */
     disable?: boolean;
@@ -35,3 +44,9 @@ /**
     startText?: string;
+    /**
+     * 表单模式模版
+     */
     template?: string;
+    /**
+     * 输入模式时的输入类型
+     */
     type: 'Text' | 'Doc' | 'Code' | 'Markdown';
@@ -50,2 +65,5 @@ }
     label: string;
+    /**
+     * 点击事件
+     */
     onClick: () => void;
@@ -63,23 +81,81 @@ }
     label: string;
+    /**
+     * 点击事件
+     */
     onClick: () => void;
 }
+/**
+ * 悬浮球配置
+ */
 export type SDKConfig = {
+    /**
+     * 对话界面是否是置顶状态
+     */
     chatIsAlwaysOnTop?: boolean;
+    /**
+     * 对话界面是否是焦点状态
+     */
     chatIsFocused?: boolean;
+    /**
+     * 对话界面是否是显示状态
+     */
     chatIsVisible?: boolean;
+    /**
+     * 当前应用改变
+     * @param app
+     */
     onAppChange?: (app: {
+        /**
+         * 是否全屏
+         */
         isFullScreen: boolean;
+        /**
+         * 名称
+         */
         name: string;
+        /**
+         * 路径
+         */
         path: string;
+        /**
+         * 标题
+         */
         title: string;
     }) => void;
+    /**
+     * 对话窗口隐藏
+     */
     onChatHide?: () => void;
+    /**
+     * 对话窗口显示
+     */
     onChatShow?: () => void;
+    /**
+     * 对话开始
+     * @param message
+     */
     onChatStart?: ({ message }: {
         message: string;
     }) => void;
+    /**
+     * 对话停止
+     */
     onChatStop?: () => void;
+    /**
+     * 打开设置
+     */
     onSettingsOpen?: () => void;
+    /**
+     * 面板操作按钮
+     * @param actions
+     */
     panelActions?: (actions: SDKMenuItem[]) => void;
+    /**
+     * 面板开关按钮
+     * @param actions
+     */
     panelCheckboxs?: (actions: SDKCheckboxItem[]) => void;
+    /**
+     * 功能预设
+     */
     presets?: CustomPreset[];
@@ -86,0 +162,0 @@ };

package.json

 {
   "name": "@ai0x0/sdk",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Lobe Chat Plugin SDK, help you to build an amazing chat plugin for Lobe Chat",
@@ -5,0 +5,0 @@ "keywords": [

No alert changes

Improved metrics

Total package byte prevSize

21160

increased by11.59%

Lines of code

609

increased by33.85%

No dependency changes