@widget-js/core 24.1.1-beta.1 → 24.1.1-beta.2

package/dist/index.d.ts

@@ -239,6 +239,10 @@ interface IWidgetOptions extends IWindowSize, IPageOptions {
      */
     socialLinks?: SocialLink[];
 }
+interface IBackgroundWidgetOptions extends Omit<IWidgetOptions, 'width' | 'height'> {
+    width?: number;
+    height?: number;
+}
 /**
  * @deprecated
  */
@@ -272,6 +276,9 @@ declare class Widget extends Page {
     isSupportNormal(): boolean;
     isConfigurable(): boolean;
 }
+declare class BackgroundWidget extends Widget {
+    constructor(options: IBackgroundWidgetOptions);
+}
 declare enum WidgetKeyword {
     RECOMMEND = "recommend",
     TOOLS = "tools",
@@ -314,7 +321,6 @@ interface WidgetPackageOptions extends LocalPackageUrlInfo {
     description: LanguageTextMap;
     /**
      * 远程组件包入口文件
-     * @deprecated 使用 remote.entry 替代
      */
     remoteEntry?: string;
     remotePackage?: string;
@@ -322,7 +328,12 @@ interface WidgetPackageOptions extends LocalPackageUrlInfo {
     icon?: string;
     lang?: LanguageCode;
     widgets?: Widget[];
+    /**
+     * 是否处于开发模式
+     */
+    development?: boolean;
     devOptions?: DevOptions;
+    requiredAppVersion?: string;
 }
 declare class WidgetPackage implements RemotePackageUrlInfo {
     /**
@@ -334,10 +345,15 @@ declare class WidgetPackage implements RemotePackageUrlInfo {
      * e.g. 1.0.2
      */
     version?: string;
+    /**
+     * 组件包所需的App版本
+     */
+    requiredAppVersion?: string;
     /**
      * 组件作者署名
      */
     readonly author: string;
+    development?: boolean;
     /**
      * 组件首页
      */
@@ -360,7 +376,6 @@ declare class WidgetPackage implements RemotePackageUrlInfo {
     entry: string | 'index.html';
     /**
      * 远程组件包入口文件
-     * @deprecated 使用 remote.entry 替代
      */
     remoteEntry?: string;
     /**
@@ -401,16 +416,6 @@ declare class WidgetPackage implements RemotePackageUrlInfo {
      * @param lang 语言环境，不传则获取默认标题
      */
     getDescription(lang?: LanguageCode): string | undefined;
-    /**
-     * 获取组件完整路径
-     * 如果url是http链接，直接返回链接
-     * 如果是本地组件：file://链接，则返回 url+entry,
-     * 如果是远程组件：http://链接，则返回 entry,
-     * @example file://C:/users/neo/desktop/index.html#
-     * @example file://C:/users/neo/desktop/index.html#
-     */
-    getIndexUrl(hash?: boolean): string;
-    getUrl(path: string, hash?: boolean): string;
 }
 interface DevOptions {
     folder?: string;
@@ -419,67 +424,6 @@ interface DevOptions {
     remoteEntry?: string;
 }
 
-declare class WidgetParams {
-    static readonly PARAM_PREFIX = "w_";
-    static readonly PARAM_ID = "id";
-    static readonly PARAM_WIDTH = "width";
-    static readonly PARAM_HEIGHT = "height";
-    static readonly PARAM_WIDTH_PX = "width_px";
-    static readonly PARAM_HEIGHT_PX = "height_px";
-    static readonly PARAM_X = "x";
-    static readonly PARAM_Y = "y";
-    static readonly PARAM_LANG = "lang";
-    static readonly PARAM_THEME = "theme";
-    static readonly PARAM_MODE = "mode";
-    static readonly PARAM_RADIUS = "radius";
-    static readonly PARAM_NAME = "name";
-    static readonly PARAM_TITLE = "title";
-    static readonly PARAM_PREVIEW = "preview";
-    static readonly PARAMS: string[];
-    id?: string;
-    width?: number;
-    widthPx?: number;
-    heightPx?: number;
-    height?: number;
-    x?: number;
-    y?: number;
-    preview?: boolean;
-    lang?: string;
-    theme?: ThemeMode;
-    mode?: DeployMode;
-    radius?: number;
-    name?: string;
-    title?: string;
-    /**
-     * 将组件参数转为url参数
-     * @param object
-     * @return URLSearchParams  w_w=2&w_h=2&w_id=21&w_width=156&w_height=156
-     */
-    toUrlParams(): URLSearchParams;
-    getPersistKey(): string;
-    /**
-     * 从当前地址解析组件参数：
-     * http://localhost:8080/#/widget/config/labor_progress?w_w=2&w_h=2&w_width=156&w_height=156
-     * =>
-     *  {width:2,height:2,id:21,width_px:156,height_px:156}
-     */
-    static fromCurrentLocation(): WidgetParams;
-    static fromLocation(url: string): WidgetParams;
-    private static setValue;
-    /**
-     * 从对象键值对中初始化组件参数
-     * {w_width:2,w_height:2,w_id:21,w_width_px:156,w_height_px:156}=>
-     *  {width:2,height:2,id:21,width_px:156,height_px:156}
-     * @param object
-     */
-    static fromObject(object: any): WidgetParams;
-}
-declare enum ThemeMode {
-    AUTO = "auto",
-    LIGHT = "LIGHT",
-    DARK = "DARK"
-}
-
 declare abstract class BaseApi<T extends string> {
     abstract getChannel(): string;
     protected invokeMethod(method: T, ...args: any[]): Promise<any>;
@@ -493,9 +437,6 @@ interface IWidgetApi {
     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>;
     openConfigPage(id: string): Promise<void>;
     openConfigPageByName(name: string): Promise<void>;
     reload(): Promise<void>;
@@ -525,13 +466,6 @@ declare class WidgetApiImpl extends BaseApi<WidgetApiMethods> implements IWidget
      * @param name package name
      */
     getWidgetPackage(name: string): Promise<WidgetPackage>;
-    /**
-     * 获取组件配置地址
-     * @param widgetName
-     */
-    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;
@@ -668,6 +602,67 @@ declare class WidgetData {
     injectThemeProperties(): void;
 }
 
+declare class WidgetParams {
+    static readonly PARAM_PREFIX = "w_";
+    static readonly PARAM_ID = "id";
+    static readonly PARAM_WIDTH = "width";
+    static readonly PARAM_HEIGHT = "height";
+    static readonly PARAM_WIDTH_PX = "width_px";
+    static readonly PARAM_HEIGHT_PX = "height_px";
+    static readonly PARAM_X = "x";
+    static readonly PARAM_Y = "y";
+    static readonly PARAM_LANG = "lang";
+    static readonly PARAM_THEME = "theme";
+    static readonly PARAM_MODE = "mode";
+    static readonly PARAM_RADIUS = "radius";
+    static readonly PARAM_NAME = "name";
+    static readonly PARAM_TITLE = "title";
+    static readonly PARAM_PREVIEW = "preview";
+    static readonly PARAMS: string[];
+    id?: string;
+    width?: number;
+    widthPx?: number;
+    heightPx?: number;
+    height?: number;
+    x?: number;
+    y?: number;
+    preview?: boolean;
+    lang?: string;
+    theme?: ThemeMode;
+    mode?: DeployMode;
+    radius?: number;
+    name?: string;
+    title?: string;
+    /**
+     * 将组件参数转为url参数
+     * @param object
+     * @return URLSearchParams  w_w=2&w_h=2&w_id=21&w_width=156&w_height=156
+     */
+    toUrlParams(): URLSearchParams;
+    getPersistKey(): string;
+    /**
+     * 从当前地址解析组件参数：
+     * http://localhost:8080/#/widget/config/labor_progress?w_w=2&w_h=2&w_width=156&w_height=156
+     * =>
+     *  {width:2,height:2,id:21,width_px:156,height_px:156}
+     */
+    static fromCurrentLocation(): WidgetParams;
+    static fromLocation(url: string): WidgetParams;
+    private static setValue;
+    /**
+     * 从对象键值对中初始化组件参数
+     * {w_width:2,w_height:2,w_id:21,w_width_px:156,w_height_px:156}=>
+     *  {width:2,height:2,id:21,width_px:156,height_px:156}
+     * @param object
+     */
+    static fromObject(object: any): WidgetParams;
+}
+declare enum ThemeMode {
+    AUTO = "auto",
+    LIGHT = "LIGHT",
+    DARK = "DARK"
+}
+
 type NotificationType = 'countdown' | 'advance-countdown' | 'error' | 'success' | 'warning' | 'info' | 'reminder' | 'url' | 'call';
 declare enum NotificationSize {
     SMALL = "small",
@@ -813,11 +808,6 @@ declare class ElectronUtils {
     static invoke(channel: string, ...args: any[]): Promise<any>;
 }
 
-declare class WidgetUrlUtils {
-    static getWidgetUrl(widgetUrl: string, widgetPackage: WidgetPackage, widgetParams: WidgetParams): string;
-    static getWidgetPackageUrl(url: string, entry: string, hash: boolean, path?: string): string;
-}
-
 /**
  * 根据语言环境获取文本
  * @param langMap       对象
@@ -1237,6 +1227,7 @@ declare class ElectronApi {
 interface SaveWidgetOption {
     sendBroadcast?: boolean;
     id?: string;
+    storeName?: string;
 }
 /**
  * 用户处理浏览器数据，只在浏览器环境下有用
@@ -1274,6 +1265,7 @@ interface IBrowserWindowApi {
     restore(): Promise<void>;
     isMinimized(): Promise<boolean>;
     isMaximized(): Promise<boolean>;
+    isVisible(): Promise<boolean>;
     maximize(): Promise<void>;
     stopDraggingWindow(): Promise<void>;
     setAlwaysOnTop(alwaysOnTop: boolean): Promise<void>;
@@ -1302,6 +1294,12 @@ interface IBrowserWindowApi {
     setZoomFactor(factor: number): Promise<void>;
     setProxy(config: Electron.Config): Promise<void>;
     isFocused(): Promise<boolean>;
+    /**
+     * A top-level window created with this style does not become the foreground window when the user clicks it. The system does not bring this window to the foreground when the user minimizes or closes the foreground window.
+     * The window should not be activated through programmatic access or via keyboard navigation by accessible technology, such as Narrator.
+     * @see https://learn.microsoft.com/en-us/windows/win32/winmsg/extended-window-styles
+     */
+    setNoActivate(): Promise<void>;
 }
 type BrowserWindowApiMethods = keyof IBrowserWindowApi;
 type AlignPosition = 'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right';
@@ -1338,6 +1336,8 @@ interface SetupOptions {
     alwaysOnTop?: boolean;
 }
 declare class BrowserWindowApiImpl extends BaseApi<BrowserWindowApiMethods> implements IBrowserWindowApi {
+    setNoActivate(): Promise<void>;
+    isVisible(): Promise<boolean>;
     getChannel(): string;
     setIgnoreMouseEvent(ignore: boolean): Promise<void>;
     show(): Promise<void>;
@@ -1478,6 +1478,7 @@ declare const DeployedWidgetApi: DeployedWidgetApiImpl;
 
 interface IDeviceApi {
     getCursorScreenPoint(): Promise<Point>;
+    sendCtrlV(): Promise<void>;
     isAllKeyReleased(): Promise<boolean>;
 }
 type DeviceApiMethods = keyof IDeviceApi;
@@ -1506,6 +1507,7 @@ declare enum Channel {
 interface IClipboardApi {
     getSelectedText(): Promise<string | undefined>;
     getText(): Promise<string | undefined>;
+    writeText(text: string): Promise<void>;
 }
 type ClipboardApiMethods = keyof IClipboardApi;
 declare enum ClipboardApiEvent {
@@ -1728,4 +1730,4 @@ declare enum SystemApiEvent {
     DATE_CHANGED = "event::cn.widgetjs.core.sys.date.changed"
 }
 
-export { AlignPosition, ApiConstants, AppApi, AppApiConstants, AppApiEvent, AppApiMethods, AppMouseEvent, AppNotification, BaseApi, BroadcastApi, BroadcastApiMethods, BroadcastEvent, BroadcastEventType, BrowserWindowApi, BrowserWindowApiEvent, BrowserWindowApiMethods, Channel, ClipboardApi, ClipboardApiEvent, ClipboardApiMethods, DefaultWidgetTheme, DeployMode, DeployedPage, DeployedWidget, DeployedWidgetApi, DeployedWidgetApiMethods, DevOptions, DeviceApi, DeviceApiMethods, DialogApi, DialogApiMethods, DownloadUrlOptions, ElectronApi, ElectronUtils, FileApi, FileApiMethods, FileInfo, Gravity, GridRect, GridSystem, HostedMode, IGridRect, IPage, IPageOptions, IWidgetDataApi, IWidgetOptions, IWindowSize, LanguageCode, LanguageTextMap, LocalPackageUrlInfo, LocationQuery, LocationQueryRaw, LocationQueryValue, LocationQueryValueRaw, LogApi, LogApiMethods, MetaInfo, Metadata, NativeKeyboardEvent, NormalizeOptions, NotificationApi, NotificationApiEvent, NotificationApiMethods, NotificationOption, NotificationSize, NotificationType, OpenUrlOptions, Page, Point, Position, ProcessApi, ProcessApiMethods, ReadDirOptions, Rectangle, RemotePackageUrlInfo, SaveWidgetOption, SetPositionOptions, ShortcutApi, ShortcutApiEvent, ShortcutApiMethods, StoreApi, StoreApiMethods, SystemApiEvent, SystemFile, ThemeMode, WebSocketEvent, WebSocketEventType, Widget, WidgetApi, WidgetApiEvent, WidgetApiMethods, WidgetData, WidgetDataApi, WidgetDataApiMethods, WidgetKeyword, WidgetPackage, WidgetPackageOptions, WidgetParams, WidgetPermission, WidgetRoute, WidgetTheme, WidgetThemeKey, WidgetUrlUtils, getTextByLanguageCode, normalizeUrl, parseQuery, stringifyQuery };
+export { AlignPosition, ApiConstants, AppApi, AppApiConstants, AppApiEvent, AppApiMethods, AppMouseEvent, AppNotification, BackgroundWidget, BaseApi, BroadcastApi, BroadcastApiMethods, BroadcastEvent, BroadcastEventType, BrowserWindowApi, BrowserWindowApiEvent, BrowserWindowApiMethods, Channel, ClipboardApi, ClipboardApiEvent, ClipboardApiMethods, DefaultWidgetTheme, DeployMode, DeployedPage, DeployedWidget, DeployedWidgetApi, DeployedWidgetApiMethods, DevOptions, DeviceApi, DeviceApiMethods, DialogApi, DialogApiMethods, DownloadUrlOptions, ElectronApi, ElectronUtils, FileApi, FileApiMethods, FileInfo, Gravity, GridRect, GridSystem, HostedMode, IBackgroundWidgetOptions, IGridRect, IPage, IPageOptions, IWidgetDataApi, IWidgetOptions, IWindowSize, LanguageCode, LanguageTextMap, LocalPackageUrlInfo, LocationQuery, LocationQueryRaw, LocationQueryValue, LocationQueryValueRaw, LogApi, LogApiMethods, MetaInfo, Metadata, NativeKeyboardEvent, NormalizeOptions, NotificationApi, NotificationApiEvent, NotificationApiMethods, NotificationOption, NotificationSize, NotificationType, OpenUrlOptions, Page, Point, Position, ProcessApi, ProcessApiMethods, ReadDirOptions, Rectangle, RemotePackageUrlInfo, SaveWidgetOption, SetPositionOptions, ShortcutApi, ShortcutApiEvent, ShortcutApiMethods, StoreApi, StoreApiMethods, SystemApiEvent, SystemFile, ThemeMode, WebSocketEvent, WebSocketEventType, Widget, WidgetApi, WidgetApiEvent, WidgetApiMethods, WidgetData, WidgetDataApi, WidgetDataApiMethods, WidgetKeyword, WidgetPackage, WidgetPackageOptions, WidgetParams, WidgetPermission, WidgetRoute, WidgetTheme, WidgetThemeKey, getTextByLanguageCode, normalizeUrl, parseQuery, stringifyQuery };