@widget-js/core 0.1.31 → 0.5.12

package/dist/types/api/BroadcastApi.d.ts

@@ -1,6 +1,21 @@
 import { BroadcastEvent } from "../model/event/BroadcastEvent";
-export declare class BroadcastApi {
-    static sendBroadcastEvent(event: BroadcastEvent): Promise<void>;
-    static registerBroadcast(callback: (event: BroadcastEvent) => void): Promise<void>;
-    static unregisterBroadcast(): Promise<void>;
+import { BaseApi } from "./BaseApi";
+import { WidgetApiEvent } from "./WidgetApi";
+import { ShortcutApiEvent } from "./ShortcutApi";
+import { ClipboardApiEvent } from "./ClipboardApi";
+import { BrowserWindowApiEvent } from "./BrowserWindowApi";
+type BroadcastEventType = WidgetApiEvent | BrowserWindowApiEvent | ShortcutApiEvent | ClipboardApiEvent | string;
+interface IBroadcastApi {
+    send(event: BroadcastEvent): Promise<void>;
+    register(...event: BroadcastEventType[]): Promise<void>;
+    unregister(...event: BroadcastEventType[]): Promise<void>;
 }
+type BroadcastApiMethods = keyof IBroadcastApi;
+export declare class BroadcastApiImpl extends BaseApi<BroadcastApiMethods> implements IBroadcastApi {
+    send(event: BroadcastEvent): Promise<void>;
+    register(...event: BroadcastEventType[]): Promise<void>;
+    unregister(...event: BroadcastEventType[]): Promise<void>;
+    getChannel(): string;
+}
+declare const BroadcastApi: IBroadcastApi;
+export { BroadcastApi, BroadcastApiMethods, BroadcastEventType };

package/dist/types/api/BrowserWindowApi.d.ts

@@ -1,68 +1,72 @@
 import { Rectangle } from "../model/interface/Rectangle";
-export type Position = {
-    x: number;
-    y: number;
-};
-export declare class BrowserWindowApi {
-    static readonly IGNORE_MOUSE_EVENT = "ignore-mouse-event";
-    static readonly WINDOW_VISIBILITY = "window-visibility";
-    static readonly CENTER = "center";
-    static readonly ALWAYS_ON_TOP = "always-on-top";
-    static readonly IS_ALWAYS_ON_TOP = "is-always-on-top";
-    static readonly OPEN_URL = "open-url";
-    static readonly MOVE_TOP = "move-top";
-    static readonly OPEN_DEV_TOOLS = "open-dev-tools";
-    static readonly SET_POSITION = "set-position";
-    static readonly GET_POSITION = "get-position";
-    static readonly BLUR = "blur";
-    static readonly FOCUS = "focus";
-    static readonly SET_RESIZABLE = "set-resizable";
-    static readonly GET_BOUNDS = "get-bounds";
-    static readonly SET_BOUNDS = "set-bounds";
-    static readonly ALIGN_TO_SCREEN = "align-to-screen";
-    static readonly START_DRAGGING_WINDOW = "start-dragging-window";
-    static readonly STOP_DRAGGING_WINDOW = "stop-dragging-window";
-    static readonly EXISTS_BY_URL = "exists-by-url";
-    static readonly SHOW_INACTIVE = "show-inactive";
-    static readonly SHOW = "show";
-    static setIgnoreMouseEvent(ignore: boolean): Promise<void>;
-    static show(): Promise<void>;
-    static showInactive(): Promise<void>;
-    static hide(): Promise<void>;
-    static center(): Promise<void>;
-    /**
-     * @deprecated
-     * @param show
-     */
-    static setWindowVisibility(show: boolean): Promise<void>;
-    static setAlwaysOnTop(alwaysOnTop: boolean): Promise<void>;
-    static isAlwaysOnTop(): Promise<boolean>;
-    static openUrl(url: string): Promise<void>;
-    static moveTop(): Promise<void>;
-    static openDevTools(): Promise<void>;
+import { Position } from "../model/msic/graphics";
+import { BaseApi } from "./BaseApi";
+interface IBrowserWindowApi {
+    setIgnoreMouseEvent(ignore: boolean): Promise<void>;
+    show(): Promise<void>;
+    hide(): Promise<void>;
+    showInactive(): Promise<void>;
+    center(): Promise<void>;
+    startDraggingWindow(): Promise<void>;
+    stopDraggingWindow(): Promise<void>;
+    setAlwaysOnTop(alwaysOnTop: boolean): Promise<void>;
+    isAlwaysOnTop(): Promise<boolean>;
+    openUrl(url: string): Promise<void>;
+    moveTop(): Promise<void>;
+    openDevTools(): Promise<void>;
+    setPosition(x: number, y: number, animation: boolean): Promise<void>;
+    getPosition(): Promise<Position>;
+    blur(): Promise<void>;
+    focus(): Promise<void>;
+    setResizable(resizable: boolean): Promise<void>;
+    getBounds(): Promise<Rectangle>;
+    setBounds(bounds: Partial<Rectangle>, animate: boolean): Promise<void>;
+    alignToScreen(align: AlignPosition): Promise<void>;
+    existsByUrl(url: string): Promise<boolean>;
+}
+type BrowserWindowApiMethods = keyof IBrowserWindowApi;
+type AlignPosition = 'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right';
+declare enum BrowserWindowApiEvent {
+    BLUR = "event::cn.widgetjs.core.browser-window.blur",
+    FOCUS = "event::cn.widgetjs.core.browser-window.focus"
+}
+export declare class BrowserWindowApiImpl extends BaseApi<BrowserWindowApiMethods> implements IBrowserWindowApi {
+    getChannel(): string;
+    setIgnoreMouseEvent(ignore: boolean): Promise<void>;
+    show(): Promise<void>;
+    showInactive(): Promise<void>;
+    hide(): Promise<void>;
+    center(): Promise<void>;
+    setAlwaysOnTop(alwaysOnTop: boolean): Promise<void>;
+    isAlwaysOnTop(): Promise<boolean>;
+    openUrl(url: string): Promise<void>;
+    moveTop(): Promise<void>;
+    openDevTools(): Promise<void>;
     /**
      * 设置窗口位置
      * @param x
      * @param y
      * @param animation 动画只在mac系统有效
      */
-    static setPosition(x: number, y: number, animation: boolean): Promise<void>;
-    static getPosition(): Promise<Position>;
-    static blur(): Promise<any>;
-    static focus(): Promise<any>;
+    setPosition(x: number, y: number, animation: boolean): Promise<void>;
+    getPosition(): Promise<Position>;
+    blur(): Promise<any>;
+    focus(): Promise<any>;
     /**
      * 设置窗口是否可以拉伸
      * @param resizable
      */
-    static setResizable(resizable: boolean): Promise<any>;
-    static getBounds(): Promise<Rectangle>;
-    static setBounds(bounds: Partial<Rectangle>, animate?: boolean): Promise<Rectangle>;
-    static alignToScreen(align: "top" | "bottom"): Promise<any>;
-    static startDraggingWindow(): Promise<any>;
-    static stopDraggingWindow(): Promise<any>;
+    setResizable(resizable: boolean): Promise<any>;
+    getBounds(): Promise<Rectangle>;
+    setBounds(bounds: Partial<Rectangle>, animate?: boolean): Promise<void>;
+    alignToScreen(align: AlignPosition): Promise<any>;
+    startDraggingWindow(): Promise<any>;
+    stopDraggingWindow(): Promise<any>;
     /**
      * 通过url检测窗口是否存在
      * @param url
      */
-    static existsByUrl(url: string): Promise<boolean>;
+    existsByUrl(url: string): Promise<boolean>;
 }
+declare const BrowserWindowApi: BrowserWindowApiImpl;
+export { BrowserWindowApi, BrowserWindowApiMethods, BrowserWindowApiEvent, AlignPosition };

package/dist/types/api/Channel.d.ts

@@ -11,6 +11,6 @@ export declare enum Channel {
     SHORTCUT = "channel::cn.widgetjs.core.shortcut",
     LOG = "channel::cn.widgetjs.core.log",
     DEVICE = "channel::cn.widgetjs.core.device",
-    MOUSE_EVENT = "channel::cn.widgetjs.core.mouse_event",
+    MOUSE = "channel::cn.widgetjs.core.mouse",
     KEYBOARD = "channel::cn.widgetjs.core.keyboard"
 }

package/dist/types/api/ClipboardApi.d.ts

@@ -1,6 +1,10 @@
-export declare class ClipboardApi {
-    static readonly GET_SELECTED_TEXT = "get-selected-text";
-    static readonly GET_TEXT = "get-text";
-    static getSelectedText(): Promise<string | undefined>;
-    static getText(): Promise<string | undefined>;
+interface IClipboardApi {
+    getSelectedText(): Promise<string | undefined>;
+    getText(): Promise<string | undefined>;
 }
+type ClipboardApiMethods = keyof IClipboardApi;
+declare enum ClipboardApiEvent {
+    CHANGED = "clipboard-changed"
+}
+declare const ClipboardApi: IClipboardApi;
+export { ClipboardApi, ClipboardApiMethods, ClipboardApiEvent };

package/dist/types/api/DeviceApi.d.ts

@@ -1,16 +1,20 @@
-export declare class DeviceApi {
-    static readonly GET_CURSOR_SCREEN_POINT = "get-cursor-screen-point";
-    static readonly IS_ALL_KEY_RELEASED = "is-all-key-released";
+import { BaseApi } from "./BaseApi";
+import { Point } from "../model/msic/graphics";
+interface IDeviceApi {
+    getCursorScreenPoint(): Promise<Point>;
+    isAllKeyReleased(): Promise<boolean>;
+}
+type DeviceApiMethods = keyof IDeviceApi;
+export declare class DeviceApiImpl extends BaseApi<DeviceApiMethods> implements IDeviceApi {
     /**
      * 获取当前鼠标位置
      */
-    static getCursorScreenPoint(): Promise<Point>;
+    getCursorScreenPoint(): Promise<Point>;
     /**
      * 判断是否所有按键都已经释放
      */
-    static isAllKeyReleased(): Promise<boolean>;
-}
-export interface Point {
-    x: number;
-    y: number;
+    isAllKeyReleased(): Promise<boolean>;
+    getChannel(): string;
 }
+declare const DeviceApi: IDeviceApi;
+export { DeviceApi, DeviceApiMethods };

package/dist/types/api/DialogApi.d.ts

@@ -1,8 +1,6 @@
-export declare class DialogApi {
-    static readonly PICK_FILE = "pick-file";
-    /**
-     * 选取单个文件
-     * @param extensions 允许的文件后缀格式，如：["txt","docx","gif"]
-     */
-    static pickFile(extensions?: string[]): Promise<string | undefined>;
+interface IDialogApi {
+    pickFile(extensions?: string[]): Promise<string | undefined>;
 }
+type DialogApiMethods = keyof IDialogApi;
+declare const DialogApi: IDialogApi;
+export { DialogApiMethods, DialogApi, };

package/dist/types/api/HostedWidgetApi.d.ts

@@ -1,45 +1,55 @@
 import { HostedWidget } from "../model/HostedWidget";
 import { WidgetParams } from "../model/WidgetParams";
-export declare class HostedWidgetApi {
-    static readonly REMOVE_HOSTED_WIDGET = "remove-hosted-widget";
-    static readonly REMOVE_HOSTED_WIDGET_BY_NAME = "remove-hosted-widget-by-name";
-    static readonly GET_HOSTED_WIDGETS = "get-hosted-widgets";
-    static readonly GET_HOSTED_WIDGET = "get-hosted-widget";
-    static readonly OPEN_DEV_TOOLS = "open-dev-tools";
-    static readonly REGISTER_ACTIVE_SHORTCUT = "register-active-shortcut";
-    static readonly SET_PROXY = "SET_PROXY";
-    static readonly UPDATE = "UPDATE";
-    static readonly OPEN_CONFIG_ROUTE = "open-config-route";
+import { BaseApi } from "./BaseApi";
+import { HostedMode } from '../model/HostedMode';
+import { Widget } from '../model/Widget';
+interface IHostedWidgetApi {
+    removeHostedWidget(id: string): Promise<void>;
+    removeHostedWidgetByName(name: string): Promise<HostedWidget[]>;
+    getHostedWidgets(): Promise<HostedWidget[]>;
+    openDevTools(id: string): Promise<void>;
+    openConfigRoute(id: string): Promise<void>;
+    registerActiveShortcut(id: string, shortcut: string): Promise<boolean>;
+    setProxy(id: string, proxy: string): Promise<boolean>;
+    getHostedWidget(id: string): Promise<HostedWidget>;
+    addWidget(widgetName: string, hostMode: HostedMode): Promise<Widget[]>;
+}
+type HostedWidgetApiMethods = keyof IHostedWidgetApi;
+export declare class HostedWidgetApiImpl extends BaseApi<HostedWidgetApiMethods> implements IHostedWidgetApi {
+    getChannel(): string;
     /**
      * 移除组件
      * @param id
      */
-    static removeHostedWidget(id: string): Promise<any>;
+    removeHostedWidget(id: string): Promise<any>;
+    addWidget(widgetName: string, hostMode: HostedMode): Promise<Widget[]>;
     /**
      * 通过组件名移除已添加的组件
      * @param name  组件名
      */
-    static removeHostedWidgetByName(name: string): Promise<HostedWidget[]>;
+    removeHostedWidgetByName(name: string): Promise<HostedWidget[]>;
     /**
      * 获取已添加的组件
      * @param name  组件名，可以不传
      */
-    static getHostedWidgets(name?: string): Promise<HostedWidget[]>;
-    static getHostedWidget(id: string): Promise<HostedWidget>;
+    getHostedWidgets(name?: string): Promise<HostedWidget[]>;
+    getHostedWidget(id: string): Promise<HostedWidget>;
     /**
      * Opens the dev tools for a widget with the specified ID.
      *
      * @param {string} widgetId - The ID of the widget to open the dev tools for.
      * @return {Promise} A Promise that resolves when the dev tools are opened.
      */
-    static openDevTools(widgetId: string): Promise<any>;
-    static openConfigRoute(widgetId: string, params?: WidgetParams): Promise<any>;
+    openDevTools(widgetId: string): Promise<any>;
+    openConfigRoute(widgetId: string, params?: WidgetParams): Promise<any>;
     /**
      * 注册激活、呼出、置顶组件快捷键
      * @param widgetId  组件id
      * @param shortcut  如果传空或者不传，则会取消快捷键。更多快捷键配置，请查看Accelerator用法
      *                  https://www.electronjs.org/docs/latest/api/accelerator
      */
-    static registerActiveShortcut(widgetId: string, shortcut?: string): Promise<boolean>;
-    static setProxy(widgetId: string, proxy: string): Promise<boolean>;
+    registerActiveShortcut(widgetId: string, shortcut?: string): Promise<boolean>;
+    setProxy(widgetId: string, proxy: string): Promise<boolean>;
 }
+declare const HostedWidgetApi: HostedWidgetApiImpl;
+export { HostedWidgetApi, HostedWidgetApiMethods };

package/dist/types/api/LogApi.d.ts

@@ -1,6 +1,9 @@
-export declare class LogApi {
-    static info(name: string, ...data: any[]): void;
-    static error(name: string, ...data: any[]): void;
-    static warn(name: string, ...data: any[]): void;
-    static log(name: string, ...data: any[]): void;
+interface ILogApi {
+    info(...data: any[]): void;
+    error(...data: any[]): void;
+    warn(...data: any[]): void;
+    log(...data: any[]): void;
 }
+type LogApiMethods = keyof ILogApi;
+declare const LogApi: ILogApi;
+export { LogApi, LogApiMethods };

package/dist/types/api/NotificationApi.d.ts

@@ -1,6 +1,16 @@
-import { AppNotification, NotificationType } from "../model/AppNotification";
-type NotificationCallback = (type: NotificationType, message: string, duration: number) => void;
-export declare class NotificationApi {
+import { AppNotification } from "../model/AppNotification";
+import { BaseApi } from "./BaseApi";
+interface INotificationApi {
+    send(notification: AppNotification): Promise<void>;
+    hide(): Promise<void>;
+}
+type NotificationApiMethods = keyof INotificationApi;
+declare enum NotificationApiEvent {
+    CONFIRM = "event::cn.widgetjs.core.notification.confirm",
+    CANCEL = "event::cn.widgetjs.core.notification.cancel",
+    HIDE = "event::cn.widgetjs.core.notification.hide"
+}
+declare class NotificationApiImpl extends BaseApi<NotificationApiMethods> implements INotificationApi {
     /**
      * 来电
      * @param avatar    头像地址
@@ -9,20 +19,20 @@ export declare class NotificationApi {
      * @param message   初始消息
      * @param lyric     歌词字符串
      */
-    static call(avatar: string, audio: string, title: string, message: string, lyric: string): Promise<void>;
-    static send(notification: AppNotification): Promise<any>;
-    static reminder(title: string, message: string, icon: string, cancelButtonText: string, confirmButtonText: string, cancelBroadcast: string, confirmBroadcast: string, duration?: number): Promise<any>;
-    static advanceCountdown(message: string, targetTime: string, title?: string): Promise<any>;
-    static countdown(message: string, targetTime: string): Promise<void>;
-    static success(message: string, duration?: number): Promise<void>;
-    static error(message: string, duration?: number): Promise<void>;
-    static warning(message: string, duration?: number): Promise<void>;
-    static info(message: string, duration?: number): Promise<void>;
+    call(avatar: string, audio: string, title: string, message: string, lyric: string): Promise<void>;
+    send(notification: AppNotification): Promise<any>;
+    reminder(title: string, message: string, icon: string, cancelButtonText: string, confirmButtonText: string, cancelBroadcast: string, confirmBroadcast: string, duration?: number): Promise<any>;
+    advanceCountdown(message: string, targetTime: string, title?: string): Promise<any>;
+    countdown(message: string, targetTime: string): Promise<void>;
+    success(message: string, duration?: number): Promise<void>;
+    error(message: string, duration?: number): Promise<void>;
+    warning(message: string, duration?: number): Promise<void>;
+    info(message: string, duration?: number): Promise<void>;
     /**
      * 隐藏通知
      */
-    static hide(): Promise<void>;
-    private static callback;
-    static setDebugNotification(callback: NotificationCallback): void;
+    hide(): Promise<void>;
+    getChannel(): string;
 }
-export {};
+declare const NotificationApi: NotificationApiImpl;
+export { NotificationApi, NotificationApiMethods, NotificationApiEvent };

package/dist/types/api/ShortcutApi.d.ts

@@ -0,0 +1,10 @@
+interface IShortcutApi {
+    register(shortcut: string): void;
+    unregister(shortcut: string): void;
+}
+type ShortcutApiMethods = keyof IShortcutApi;
+declare enum ShortcutApiEvent {
+    TRIGGERED = "channel::cn.widgetjs.core.shortcut.triggered"
+}
+declare const ShortcutApi: IShortcutApi;
+export { ShortcutApi, ShortcutApiMethods, ShortcutApiEvent };

package/dist/types/api/WidgetApi.d.ts

@@ -1,50 +1,48 @@
 import { Widget } from "../model/Widget";
 import { WidgetPackage } from "../model/WidgetPackage";
 import { WidgetParams } from "../model/WidgetParams";
-import { WidgetData } from "../model/WidgetData";
-export interface SaveWidgetOption {
-    sendBroadcast?: boolean;
-    id?: string;
+import { BaseApi } from "./BaseApi";
+interface IWidgetApi {
+    registerWidgets(widgets: Widget[]): Promise<void>;
+    registerWidgetPackage(widgetPackage: WidgetPackage): Promise<void>;
+    getWidgets(): Promise<Widget[]>;
+    getWidget(name: string): Promise<Widget>;
+    getWidgetPackage(name: string): Promise<WidgetPackage>;
+    getWidgetPackages(): Promise<WidgetPackage[]>;
+    getWidgetUrl(widgetName: string, widgetParams: WidgetParams): Promise<string | null>;
+    getWidgetPackageIndexUrl(packageName: string, hash?: boolean): Promise<string | null>;
+    getWidgetConfigUrl(widgetName: string, widgetParams: WidgetParams): Promise<string | null>;
+    getWidgetPackageUrl(packageName: string): Promise<string | null>;
 }
-export declare class WidgetApi {
-    static readonly REGISTER_WIDGETS = "register-widgets";
-    static readonly REGISTER_WIDGET_PACKAGE = "register-widget-package";
-    static readonly GET_WIDGETS = "get-widgets";
-    static readonly GET_WIDGET = "get-widget";
-    static readonly GET_WIDGET_PACKAGE = "get-widget-package";
-    static readonly GET_WIDGET_PACKAGES = "get-widget-packages";
-    static registerWidgets(widgets: Widget[]): Promise<void>;
-    static registerWidgetPackage(widgetPackage: WidgetPackage): Promise<void>;
-    static getWidgets(): Promise<Widget[]>;
-    static getWidgetPackages(): Promise<WidgetPackage>;
+type WidgetApiMethods = keyof IWidgetApi;
+declare enum WidgetApiEvent {
+    DATA_CHANGED = "event::cn.widgetjs.core.widget.data-changed",
+    EDIT_DESKTOP_WIDGETS = "event::cn.widgetjs.core.widget.desktop.edit"
+}
+declare class WidgetApiImpl extends BaseApi<WidgetApiMethods> implements IWidgetApi {
+    getChannel(): string;
+    registerWidgets(widgets: Widget[]): Promise<any>;
+    registerWidgetPackage(widgetPackage: WidgetPackage): Promise<any>;
+    getWidgets(): Promise<Widget[]>;
+    getWidgetPackages(): Promise<WidgetPackage[]>;
     /**
      *
      * @param name package name
      */
-    static getWidget(name: string): Promise<Widget>;
+    getWidget(name: string): Promise<Widget>;
     /**
      *
      * @param name package name
      */
-    static getWidgetPackage(name: string): Promise<WidgetPackage>;
+    getWidgetPackage(name: string): Promise<WidgetPackage>;
     /**
      * 获取组件配置地址
      * @param widgetName
      */
-    static getWidgetConfigUrl(widgetName: string, widgetParams: WidgetParams): Promise<string | null>;
-    static getWidgetUrl(widgetName: string, widgetParams: WidgetParams): Promise<string | null>;
-    static getWidgetPackageIndexUrl(packageName: string, hash?: boolean): Promise<string | null>;
-    static getWidgetPackageUrl(packageName: string): Promise<string | null>;
-    /**
-     * 通过组件名保存组件信息，通常用于存储可以在同类组件中共用的数据
-     * @param data
-     * @param options
-     */
-    static saveDataByName<T extends WidgetData>(data: T, options?: SaveWidgetOption): Promise<string>;
-    private static stores;
-    /**
-     * 获取组件 LocalForage 存储实例
-     * @param name
-     */
-    static getStore(name: string): LocalForage;
+    getWidgetConfigUrl(widgetName: string, widgetParams: WidgetParams): Promise<string | null>;
+    getWidgetUrl(widgetName: string, widgetParams: WidgetParams): Promise<string | null>;
+    getWidgetPackageIndexUrl(packageName: string, hash?: boolean): Promise<string | null>;
+    getWidgetPackageUrl(packageName: string): Promise<string | null>;
 }
+declare const WidgetApi: WidgetApiImpl;
+export { WidgetApi, WidgetApiEvent, WidgetApiMethods };

package/dist/types/{repository/WidgetDataRepository.d.ts → api/WidgetDataApi.d.ts}

@@ -1,5 +1,9 @@
 import { WidgetData } from "../model/WidgetData";
-export declare class WidgetDataRepository {
+export interface SaveWidgetOption {
+    sendBroadcast?: boolean;
+    id?: string;
+}
+export declare class WidgetDataApi {
     private static stores;
     /**
      * 保存组件数据
@@ -14,8 +18,9 @@ export declare class WidgetDataRepository {
     /**
      * 通过组件名保存组件信息，通常用于存储可以在同类组件中共用的数据
      * @param data
+     * @param options
      */
-    static saveByName<T extends WidgetData>(data: T): Promise<string>;
+    static saveByName<T extends WidgetData>(data: T, options?: SaveWidgetOption): Promise<string>;
     static findByName<T extends WidgetData>(name: string, type: {
         new (name: string, id?: string): T;
     }): Promise<T | undefined>;

package/dist/types/index.d.ts

@@ -11,9 +11,9 @@ export * from "./model/event/NativeKeyboardEvent";
 export * from "./model/event/AppMouseEvent";
 export * from "./model/WidgetPackage";
 export * from "./api/ElectronApi";
-export * from "./repository/WidgetDataRepository";
+export * from "./api/WidgetDataApi";
 export * from "./api/BrowserWindowApi";
-export * from "./api/GlobalShortcutApi";
+export * from "./lang/LanguageCode";
 export * from "./api/NotificationApi";
 export * from "./api/HostedWidgetApi";
 export * from "./api/DeviceApi";
@@ -21,6 +21,7 @@ export * from "./api/Channel";
 export * from "./api/ClipboardApi";
 export * from "./api/WidgetApi";
 export * from "./api/ApiConstants";
+export * from "./api/ShortcutApi";
 export * from "./api/BroadcastApi";
 export * from "./api/AppApi";
 export * from "./api/DialogApi";

package/dist/types/lang/LanguageCode.d.ts

@@ -0,0 +1,40 @@
+interface Language {
+    locale: string;
+    language: string;
+    code: string;
+}
+interface ILanguageMap {
+    'ar-SA': Language;
+    'bn-BD': Language;
+    'en-US': Language;
+    'de-DE': Language;
+    'el-GR': Language;
+    'es-ES': Language;
+    'fi-FI': Language;
+    'fil-PH': Language;
+    'fr-FR': Language;
+    'hi-IN': Language;
+    'hu-HU': Language;
+    'id-ID': Language;
+    'it-IT': Language;
+    'ja-JP': Language;
+    'ko-KR': Language;
+    'nl-NL': Language;
+    'pl-PL': Language;
+    'pt-BR': Language;
+    'pt-PT': Language;
+    'ro-RO': Language;
+    'ru-RU': Language;
+    'sv-SE': Language;
+    'ta-IN': Language;
+    'tr-TR': Language;
+    'uk-UA': Language;
+    'vi-VN': Language;
+    'zh-CN': Language;
+    'zh-TW': Language;
+}
+export type LanguageCode = keyof ILanguageMap;
+export type LanguageTextMap = {
+    [key in LanguageCode]?: string;
+};
+export {};

package/dist/types/model/Widget.d.ts

@@ -1,5 +1,6 @@
 import { HostedMode } from "./HostedMode";
 import { WidgetPermission } from "../permission/permission";
+import { LanguageCode, LanguageTextMap } from "../lang/LanguageCode";
 type WidgetOptions = {
     name: string;
     title: {
@@ -32,6 +33,7 @@ type WidgetOptions = {
     hideWhenBlur?: boolean;
     routes: WidgetRoute[];
     permissions?: WidgetPermission[];
+    broadcastChannels?: string[];
 };
 export declare class Widget {
     readonly name: string;
@@ -39,15 +41,11 @@ export declare class Widget {
      * 组件标题，显示在界面上的，
      * https://zh.m.wikipedia.org/zh-hans/ISO_639-1
      */
-    readonly title: {
-        [key: string]: string;
-    };
+    readonly title: LanguageTextMap;
     /**
      * 组件介绍
      */
-    readonly description: {
-        [key: string]: string;
-    };
+    readonly description: LanguageTextMap;
     readonly keywords: WidgetKeyword[];
     /**
      * 组件默认语言
@@ -86,12 +84,12 @@ export declare class Widget {
      * 获取组件标题
      * @param lang 语言环境，不传则获取默认语言
      */
-    getTitle(lang?: string): string | undefined;
+    getTitle(lang?: LanguageCode): string | undefined;
     /**
-     * 获取组件标描述
+     * 获取组件描述
      * @param lang 语言环境，不传则获取默认标题
      */
-    getDescription(lang?: string): string | undefined;
+    getDescription(lang?: LanguageCode): string | undefined;
     static parseJSON(json: string): Widget;
     static parseObject(obj: any): Widget;
     /**