@xiongtao.xt/tau-plugins 0.1.0 → 0.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xiongtao.xt/tau-plugins",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "license": "MIT",
   "repository": {
     "type": "git",

package/types/packages/plugins/src/contract.d.ts

@@ -1,6 +1,7 @@
 import type { PluginPages } from "./pages";
 import type { PluginEditor } from "./editor";
 import type { PluginSettings } from "./settings";
+import type { PluginSidebar } from "./sidebar";
 export type JsonValue = null | boolean | number | string | JsonValue[] | {
     [key: string]: JsonValue;
 };
@@ -29,6 +30,7 @@ export interface PluginContext {
     readonly pages: PluginPages;
     readonly editor: PluginEditor;
     readonly settings: PluginSettings;
+    readonly sidebar: PluginSidebar;
     readonly fetch: typeof globalThis.fetch;
     /** 将订阅等资源交给宿主，在停用或激活失败时逆序回收。 */
     register(resource: Disposable): Disposable;

package/types/packages/plugins/src/index.d.ts

@@ -2,5 +2,6 @@ import type { PluginDefinition } from "./contract";
 export type { JsonValue, Disposable, PluginStorage, PluginCommand, PluginContext, PluginInstance, PluginDefinition, } from "./contract";
 export type { PluginSettings, PluginSettingsDefinition, PluginSettingsProps, PluginSettingsHandle, } from "./settings";
 export * from "./editor";
+export * from "./sidebar";
 export type { PluginPageDefinition, PluginPageHandle, PluginPageParams, PluginPageProps, PluginPages, } from "./pages";
 export declare function definePlugin(definition: Omit<PluginDefinition, "apiVersion">): PluginDefinition;

package/types/packages/plugins/src/sidebar.d.ts

@@ -0,0 +1,29 @@
+import type { Disposable } from "./contract";
+import type { PluginPageHandle, PluginPageParams } from "./pages";
+export declare const SIDEBAR_GROUPS: Readonly<{
+    readonly daily: "daily";
+    readonly knowledge: "knowledge";
+    readonly learning: "learning";
+    readonly ai: "ai";
+    readonly sharing: "sharing";
+    readonly plugins: "plugins";
+}>;
+export interface PluginSidebarGroupDefinition {
+    id: string;
+    title: string;
+}
+export interface PluginSidebarGroupHandle extends Disposable {
+    readonly id: string;
+}
+export interface PluginSidebarItemDefinition {
+    id: string;
+    title: string;
+    /** 缺省或分组不存在时归入默认插件分组。 */
+    group?: string;
+    page: PluginPageHandle;
+    params?: PluginPageParams;
+}
+export interface PluginSidebar {
+    registerGroup(definition: PluginSidebarGroupDefinition): PluginSidebarGroupHandle;
+    registerItem(definition: PluginSidebarItemDefinition): Disposable;
+}