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

package/dist/index.d.ts

@@ -302,7 +302,7 @@ interface LocalPackageUrlInfo {
     /**
      * 是否使用hash路由
      */
-    hash: boolean;
+    hash?: boolean;
 }
 interface RemotePackageUrlInfo extends LocalPackageUrlInfo {
     /**
@@ -431,21 +431,28 @@ declare abstract class BaseApi<T extends string> {
 }
 
 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[]>;
-    openConfigPage(id: string): Promise<void>;
-    openConfigPageByName(name: string): Promise<void>;
-    reload(): Promise<void>;
-    getWidgetPackageUrl(packageName: string): Promise<string | null>;
+    registerWidgets: (widgets: Widget[]) => Promise<void>;
+    registerWidgetPackage: (widgetPackage: WidgetPackage) => Promise<void>;
+    /**
+     * 升级组件包
+     * @param packageName 组件包名称
+     */
+    upgradePackage: (packageName: string) => Promise<void>;
+    getWidgets: () => Promise<Widget[]>;
+    getWidget: (name: string) => Promise<Widget>;
+    getWidgetPackage: (name: string) => Promise<WidgetPackage | undefined>;
+    getWidgetPackages: () => Promise<WidgetPackage[]>;
+    openConfigPage: (id?: string) => Promise<void>;
+    openConfigPageByName: (name: string) => Promise<void>;
+    reload: () => Promise<void>;
+    getWidgetPackageUrl: (packageName: string) => Promise<string | null>;
 }
 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"
+    EDIT_DESKTOP_WIDGETS = "event::cn.widgetjs.core.widget.desktop.edit",
+    PACKAGE_UPGRADE = "event::cn.widgetjs.core.widget.package.upgraded",
+    PACKAGE_INSTALLED = "event::cn.widgetjs.core.widget.package.installed"
 }
 declare class WidgetApiImpl extends BaseApi<WidgetApiMethods> implements IWidgetApi {
     reload(): Promise<void>;
@@ -453,7 +460,7 @@ declare class WidgetApiImpl extends BaseApi<WidgetApiMethods> implements IWidget
     registerWidgets(widgets: Widget[]): Promise<any>;
     registerWidgetPackage(widgetPackage: WidgetPackage): Promise<any>;
     getWidgets(): Promise<Widget[]>;
-    openConfigPage(widgetId: string): Promise<any>;
+    openConfigPage(widgetId?: string): Promise<any>;
     openConfigPageByName(widgetName: string): Promise<any>;
     getWidgetPackages(): Promise<WidgetPackage[]>;
     /**
@@ -465,8 +472,9 @@ declare class WidgetApiImpl extends BaseApi<WidgetApiMethods> implements IWidget
      *
      * @param name package name
      */
-    getWidgetPackage(name: string): Promise<WidgetPackage>;
+    getWidgetPackage(name: string): Promise<WidgetPackage | undefined>;
     getWidgetPackageUrl(packageName: string): Promise<string | null>;
+    upgradePackage(packageName: string): Promise<void>;
 }
 declare const WidgetApi: WidgetApiImpl;
 
@@ -1426,16 +1434,25 @@ declare class NotificationApiImpl extends BaseApi<NotificationApiMethods> implem
 }
 declare const NotificationApi: NotificationApiImpl;
 
+interface AddWidgetOption {
+    widgetName: string;
+    deployMode: DeployMode;
+    packageJsonUrl?: string;
+}
 interface IDeployedWidgetApi {
-    removeDeployedWidget(id: string): Promise<void>;
-    removeDeployedWidgetByName(name: string): Promise<DeployedWidget[]>;
-    getDeployedWidgets(): Promise<DeployedWidget[]>;
-    openDevTools(id: string): Promise<void>;
-    openConfigPage(id: string): Promise<void>;
-    registerActiveShortcut(id: string, shortcut: string): Promise<boolean>;
-    setProxy(id: string, proxy: string): Promise<boolean>;
-    getDeployedWidget(id: string): Promise<DeployedWidget>;
-    addWidget(widgetName: string, hostMode: DeployMode): Promise<Widget[]>;
+    removeDeployedWidget: (id: string) => Promise<void>;
+    removeDeployedWidgetByName: (name: string) => Promise<DeployedWidget[]>;
+    getDeployedWidgets: () => Promise<DeployedWidget[]>;
+    openDevTools: (id: string) => Promise<void>;
+    /**
+     * @deprecated 使用WidgetApi.openConfigPage代替
+     * @param id
+     */
+    openConfigPage: (id?: string, params?: WidgetParams) => Promise<void>;
+    registerActiveShortcut: (id: string, shortcut: string) => Promise<boolean>;
+    setProxy: (id: string, proxy: string) => Promise<boolean>;
+    getDeployedWidget: (id: string) => Promise<DeployedWidget>;
+    addWidget: (options: AddWidgetOption) => Promise<Widget[]>;
 }
 type DeployedWidgetApiMethods = keyof IDeployedWidgetApi;
 declare class DeployedWidgetApiImpl extends BaseApi<DeployedWidgetApiMethods> implements IDeployedWidgetApi {
@@ -1445,7 +1462,7 @@ declare class DeployedWidgetApiImpl extends BaseApi<DeployedWidgetApiMethods> im
      * @param id
      */
     removeDeployedWidget(id: string): Promise<any>;
-    addWidget(widgetName: string, hostMode: DeployMode): Promise<Widget[]>;
+    addWidget(options: AddWidgetOption): Promise<Widget[]>;
     /**
      * 通过组件名移除已添加的组件
      * @param name  组件名
@@ -1464,7 +1481,7 @@ declare class DeployedWidgetApiImpl extends BaseApi<DeployedWidgetApiMethods> im
      * @return {Promise} A Promise that resolves when the dev tools are opened.
      */
     openDevTools(widgetId: string): Promise<any>;
-    openConfigPage(widgetId: string, params?: WidgetParams): Promise<any>;
+    openConfigPage(widgetId?: string, params?: WidgetParams): Promise<any>;
     /**
      * 注册激活、呼出、置顶组件快捷键
      * @param widgetId  组件id
@@ -1489,6 +1506,7 @@ declare enum Channel {
     BROWSER_WINDOW = "channel::cn.widgetjs.core.browser_window",
     BROADCAST = "channel::cn.widgetjs.core.broadcast",
     WIDGET = "channel::cn.widgetjs.core.widget",
+    WIDGET_PACKAGE = "channel::cn.widgetjs.core.widget.package",
     DEPLOYED_WIDGET = "channel::cn.widgetjs.core.deployed_widget",
     APP = "channel::cn.widgetjs.core.app",
     DIALOG = "channel::cn.widgetjs.core.dialog",
@@ -1730,4 +1748,21 @@ declare enum SystemApiEvent {
     DATE_CHANGED = "event::cn.widgetjs.core.sys.date.changed"
 }
 
-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 };
+interface IWidgetPackageApi {
+    /**
+     * 升级组件包
+     * @param packageName 组件包名称
+     */
+    upgrade: (packageName: string) => Promise<void>;
+}
+type WidgetPackageApiMethods = keyof IWidgetPackageApi;
+declare enum WidgetPackageApiEvent {
+    PACKAGE_UPGRADE = "event::cn.widgetjs.core.widget.package.upgraded"
+}
+declare class WidgetPackageApiImpl extends BaseApi<WidgetPackageApiMethods> implements IWidgetPackageApi {
+    getChannel(): string;
+    upgrade(packageName: string): Promise<void>;
+}
+declare const WidgetPackageApi: WidgetPackageApiImpl;
+
+export { AddWidgetOption, 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, WidgetPackageApi, WidgetPackageApiEvent, WidgetPackageApiMethods, WidgetPackageOptions, WidgetParams, WidgetPermission, WidgetRoute, WidgetTheme, WidgetThemeKey, getTextByLanguageCode, normalizeUrl, parseQuery, stringifyQuery };

package/dist/index.js

@@ -1329,7 +1329,7 @@ var WidgetPackage = class {
     this.remoteEntry = options.remoteEntry;
     this.requiredAppVersion = options.requiredAppVersion;
     this.remotePackage = options.remotePackage;
-    this.hash = options.hash;
+    this.hash = options.hash ?? false;
     this.url = "";
     this.icon = options.icon;
     this.devOptions = options.devOptions;
@@ -1809,6 +1809,7 @@ var Channel = /* @__PURE__ */ ((Channel2) => {
   Channel2["BROWSER_WINDOW"] = "channel::cn.widgetjs.core.browser_window";
   Channel2["BROADCAST"] = "channel::cn.widgetjs.core.broadcast";
   Channel2["WIDGET"] = "channel::cn.widgetjs.core.widget";
+  Channel2["WIDGET_PACKAGE"] = "channel::cn.widgetjs.core.widget.package";
   Channel2["DEPLOYED_WIDGET"] = "channel::cn.widgetjs.core.deployed_widget";
   Channel2["APP"] = "channel::cn.widgetjs.core.app";
   Channel2["DIALOG"] = "channel::cn.widgetjs.core.dialog";
@@ -1856,6 +1857,8 @@ var BroadcastApi = new BroadcastApiImpl();
 var WidgetApiEvent = /* @__PURE__ */ ((WidgetApiEvent2) => {
   WidgetApiEvent2["DATA_CHANGED"] = "event::cn.widgetjs.core.widget.data-changed";
   WidgetApiEvent2["EDIT_DESKTOP_WIDGETS"] = "event::cn.widgetjs.core.widget.desktop.edit";
+  WidgetApiEvent2["PACKAGE_UPGRADE"] = "event::cn.widgetjs.core.widget.package.upgraded";
+  WidgetApiEvent2["PACKAGE_INSTALLED"] = "event::cn.widgetjs.core.widget.package.installed";
   return WidgetApiEvent2;
 })(WidgetApiEvent || {});
 var WidgetApiImpl = class extends BaseApi {
@@ -1902,7 +1905,11 @@ var WidgetApiImpl = class extends BaseApi {
    * @param name package name
    */
   async getWidgetPackage(name) {
-    return WidgetPackage.parseObject(await this.invokeMethod("getWidgetPackage", name));
+    const result = await this.invokeMethod("getWidgetPackage", name);
+    if (result) {
+      return WidgetPackage.parseObject(result);
+    }
+    return void 0;
   }
   async getWidgetPackageUrl(packageName) {
     const widgetPackage = await this.getWidgetPackage(packageName);
@@ -1911,6 +1918,9 @@ var WidgetApiImpl = class extends BaseApi {
     }
     return widgetPackage.url;
   }
+  async upgradePackage(packageName) {
+    return await this.invokeMethod("upgradePackage", packageName);
+  }
   // /**
   //  * 通过组件名保存组件信息，通常用于存储可以在同类组件中共用的数据
   //  * @param data
@@ -2004,8 +2014,8 @@ var WidgetDataApiImpl = class {
     let data;
     if (args.length === 2) {
       name = args[0];
-      const type = args[1];
-      data = new type(name);
+      const Type = args[1];
+      data = new Type(name);
     } else {
       data = args[0];
       name = data.name;
@@ -2018,11 +2028,11 @@ var WidgetDataApiImpl = class {
     }
     return void 0;
   }
-  async find(name, id, type) {
+  async find(name, id, Type) {
     const store = this.getStore(name);
     const result = await store.getItem(this.getKey(name, id));
     if (result) {
-      const widgetData = new type(name, id);
+      const widgetData = new Type(name, id);
       widgetData.parseJSON(JSON.parse(result));
       return widgetData;
     }
@@ -2328,8 +2338,8 @@ var DeployedWidgetApiImpl = class extends BaseApi {
   async removeDeployedWidget(id) {
     return this.invokeMethod("removeDeployedWidget", id);
   }
-  addWidget(widgetName, hostMode) {
-    return this.invokeMethod("addWidget", widgetName, hostMode);
+  addWidget(options) {
+    return this.invokeMethod("addWidget", options);
   }
   /**
    * 通过组件名移除已添加的组件
@@ -2665,6 +2675,21 @@ var SystemApiEvent = /* @__PURE__ */ ((SystemApiEvent2) => {
   SystemApiEvent2["DATE_CHANGED"] = "event::cn.widgetjs.core.sys.date.changed";
   return SystemApiEvent2;
 })(SystemApiEvent || {});
+
+// src/api/WidgetPackageApi.ts
+var WidgetPackageApiEvent = /* @__PURE__ */ ((WidgetPackageApiEvent2) => {
+  WidgetPackageApiEvent2["PACKAGE_UPGRADE"] = "event::cn.widgetjs.core.widget.package.upgraded";
+  return WidgetPackageApiEvent2;
+})(WidgetPackageApiEvent || {});
+var WidgetPackageApiImpl = class extends BaseApi {
+  getChannel() {
+    return "channel::cn.widgetjs.core.widget.package" /* WIDGET_PACKAGE */;
+  }
+  upgrade(packageName) {
+    return this.invokeMethod("upgrade", packageName);
+  }
+};
+var WidgetPackageApi = new WidgetPackageApiImpl();
 export {
   ApiConstants,
   AppApi,
@@ -2714,6 +2739,8 @@ export {
   WidgetDataApi,
   WidgetKeyword,
   WidgetPackage,
+  WidgetPackageApi,
+  WidgetPackageApiEvent,
   WidgetParams,
   getTextByLanguageCode,
   normalizeUrl,