@widget-js/core 0.7.6 → 0.7.8

package/dist/index.d.ts

@@ -82,14 +82,26 @@ interface IWindowSize {
     minWidth?: number;
     minHeight?: number;
 }
-interface IWindowOptions extends IWindowSize {
+interface IPageOptions extends IWindowSize {
     name: string;
+    /**
+     * 当showInSearch为true时,此项必填
+     */
     title: LanguageTextMap;
-    description: LanguageTextMap;
-    keywords: WidgetKeyword[];
+    /**
+     * 当showInSearch为true时,此项必填
+     */
+    description?: LanguageTextMap;
+    /**
+     * 当showInSearch为true时,此项必填
+     */
+    keywords?: WidgetKeyword[];
     lang: LanguageCode;
     packageName?: string;
-    previewImage: string;
+    /**
+     * 当showInSearch为true时,此项必填
+     */
+    previewImage?: string;
     /**
      * 是否在搜索中显示
      */
@@ -142,7 +154,7 @@ interface IPage {
     /**
      * 预览图片，可以是GIF
      */
-    readonly previewImage: string;
+    readonly previewImage?: string;
 }
 declare class Page implements IPage {
     readonly name: string;
@@ -178,8 +190,8 @@ declare class Page implements IPage {
     /**
      * 预览图片，可以是GIF
      */
-    readonly previewImage: string;
-    constructor(options: IWindowOptions);
+    readonly previewImage?: string;
+    constructor(options: IPageOptions);
     /**
      * 获取组件标题
      * @param lang 语言环境，不传则获取默认语言
@@ -195,11 +207,15 @@ declare class Page implements IPage {
     isResizable(): boolean;
 }
 
-interface IWidgetOptions extends IWindowSize, IWindowOptions {
+interface IWidgetOptions extends IWindowSize, IPageOptions {
     supportDeployMode?: DeployMode;
     configPagePath?: string;
+    previewImage: string;
+    description: LanguageTextMap;
+    keywords: WidgetKeyword[];
 }
 declare class Widget extends Page {
+    readonly previewImage: string;
     readonly supportDeployMode: number;
     /**
      * 配置页面路径，没有则不能修改
@@ -217,6 +233,7 @@ declare class Widget extends Page {
      * 是否支持普通模式
      */
     isSupportNormal(): boolean;
+    isConfigurable(): boolean;
 }
 declare enum WidgetKeyword {
     RECOMMEND = "recommend",
@@ -434,6 +451,7 @@ interface IWidgetApi {
     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>;
     getWidgetPackageUrl(packageName: string): Promise<string | null>;
 }
 type WidgetApiMethods = keyof IWidgetApi;
@@ -446,6 +464,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>;
     getWidgetPackages(): Promise<WidgetPackage[]>;
     /**
      *
@@ -480,7 +499,8 @@ interface IAppApi {
 type AppApiMethods = keyof IAppApi;
 declare enum AppApiEvent {
     CONFIG_CHANGED = "event::cn.widgetjs.core.app.config.changed",
-    MOVING_GRID_WINDOW = "event::cn.widgetjs.core.app.moving.grid.window"
+    MOVING_GRID_WINDOW = "event::cn.widgetjs.core.app.moving.grid.window",
+    STOP_MOVING_GRID_WINDOW = "event::cn.widgetjs.core.app.moving.grid.window.stop"
 }
 declare enum AppApiConstants {
     CONFIG_GRID_CELL_SIZE = "cn.widgetjs.config.grid.size"
@@ -495,7 +515,7 @@ interface BroadcastEventOptions {
     sender?: string;
     /**
      * 广播事件携带的数据，只支持部分数据类型。
-     * 情见：https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm
      */
     payload?: any;
 }
@@ -1159,6 +1179,18 @@ declare enum BrowserWindowApiEvent {
     RESIZED = "event::cn.widgetjs.core.browser-window.resized",
     CANCEL_SNAP_TO_EDGE = "event::cn.widgetjs.core.browser-window.cancel_snap_to_edge"
 }
+interface SetupOptions {
+    width: number;
+    height: number;
+    minWidth?: number;
+    minHeight?: number;
+    maxWidth?: number;
+    maxHeight?: number;
+    resizable?: boolean;
+    movable?: boolean;
+    center?: boolean;
+    alwaysOnTop?: boolean;
+}
 declare class BrowserWindowApiImpl extends BaseApi<BrowserWindowApiMethods> implements IBrowserWindowApi {
     getChannel(): string;
     setIgnoreMouseEvent(ignore: boolean): Promise<void>;
@@ -1207,6 +1239,7 @@ declare class BrowserWindowApiImpl extends BaseApi<BrowserWindowApiMethods> impl
     getMinimumSize(): Promise<number[]>;
     close(): Promise<void>;
     setZoomFactor(factor: number): Promise<void>;
+    setup(options: SetupOptions): Promise<void>;
 }
 declare const BrowserWindowApi: BrowserWindowApiImpl;
 
@@ -1251,7 +1284,7 @@ interface IDeployedWidgetApi {
     removeDeployedWidgetByName(name: string): Promise<DeployedWidget[]>;
     getDeployedWidgets(): Promise<DeployedWidget[]>;
     openDevTools(id: string): Promise<void>;
-    openConfigRoute(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>;
@@ -1284,7 +1317,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>;
-    openConfigRoute(widgetId: string, params?: WidgetParams): Promise<any>;
+    openConfigPage(widgetId: string, params?: WidgetParams): Promise<any>;
     /**
      * 注册激活、呼出、置顶组件快捷键
      * @param widgetId  组件id
@@ -1397,4 +1430,4 @@ interface IFileApi {
 type FileApiMethods = keyof IFileApi;
 declare const FileApi: IFileApi;
 
-export { AlignPosition, ApiConstants, AppApi, AppApiConstants, AppApiEvent, AppApiMethods, AppMouseEvent, AppNotification, BaseApi, BroadcastApi, BroadcastApiMethods, BroadcastEvent, BroadcastEventType, BrowserWindowApi, BrowserWindowApiEvent, BrowserWindowApiMethods, Channel, ClipboardApi, ClipboardApiEvent, ClipboardApiMethods, DeployMode, DeployedPage, DeployedWidget, DeployedWidgetApi, DeployedWidgetApiMethods, DevOptions, DeviceApi, DeviceApiMethods, DialogApi, DialogApiMethods, ElectronApi, ElectronUtils, FileApi, FileApiMethods, Gravity, GridRect, GridSystem, HostedMode, IGridRect, IPage, IWidgetDataApi, IWidgetOptions, IWindowOptions, IWindowSize, LanguageCode, LanguageTextMap, LocalPackageUrlInfo, LocationQuery, LocationQueryRaw, LocationQueryValue, LocationQueryValueRaw, LogApi, LogApiMethods, MetaInfo, NativeKeyboardEvent, NormalizeOptions, NotificationApi, NotificationApiEvent, NotificationApiMethods, NotificationOption, NotificationSize, NotificationType, OpenUrlOptions, Page, Point, Position, ReadDirOptions, Rectangle, RemotePackageUrlInfo, SaveWidgetOption, SetPositionOptions, ShortcutApi, ShortcutApiEvent, ShortcutApiMethods, StoreApi, StoreApiMethods, ThemeMode, WebSocketEvent, WebSocketEventType, Widget, WidgetApi, WidgetApiEvent, WidgetApiMethods, WidgetData, WidgetDataApi, WidgetDataApiMethods, WidgetKeyword, WidgetPackage, WidgetPackageOptions, WidgetParams, WidgetPermission, WidgetUrlUtils, normalizeUrl, parseQuery, stringifyQuery };
+export { AlignPosition, ApiConstants, AppApi, AppApiConstants, AppApiEvent, AppApiMethods, AppMouseEvent, AppNotification, BaseApi, BroadcastApi, BroadcastApiMethods, BroadcastEvent, BroadcastEventType, BrowserWindowApi, BrowserWindowApiEvent, BrowserWindowApiMethods, Channel, ClipboardApi, ClipboardApiEvent, ClipboardApiMethods, DeployMode, DeployedPage, DeployedWidget, DeployedWidgetApi, DeployedWidgetApiMethods, DevOptions, DeviceApi, DeviceApiMethods, DialogApi, DialogApiMethods, ElectronApi, ElectronUtils, FileApi, FileApiMethods, Gravity, GridRect, GridSystem, HostedMode, IGridRect, IPage, IPageOptions, IWidgetDataApi, IWidgetOptions, IWindowSize, LanguageCode, LanguageTextMap, LocalPackageUrlInfo, LocationQuery, LocationQueryRaw, LocationQueryValue, LocationQueryValueRaw, LogApi, LogApiMethods, MetaInfo, NativeKeyboardEvent, NormalizeOptions, NotificationApi, NotificationApiEvent, NotificationApiMethods, NotificationOption, NotificationSize, NotificationType, OpenUrlOptions, Page, Point, Position, ReadDirOptions, Rectangle, RemotePackageUrlInfo, SaveWidgetOption, SetPositionOptions, ShortcutApi, ShortcutApiEvent, ShortcutApiMethods, StoreApi, StoreApiMethods, ThemeMode, WebSocketEvent, WebSocketEventType, Widget, WidgetApi, WidgetApiEvent, WidgetApiMethods, WidgetData, WidgetDataApi, WidgetDataApiMethods, WidgetKeyword, WidgetPackage, WidgetPackageOptions, WidgetParams, WidgetPermission, WidgetUrlUtils, normalizeUrl, parseQuery, stringifyQuery };

package/dist/index.js

@@ -88,8 +88,8 @@ var Page = class {
   constructor(options) {
     this.name = options.name;
     this.title = options.title;
-    this.description = options.description;
-    this.keywords = options.keywords;
+    this.description = options.description ?? {};
+    this.keywords = options.keywords ?? [];
     this.lang = options.lang;
     this.width = options.width;
     this.height = options.height;
@@ -118,6 +118,8 @@ var Page = class {
    * @param lang 语言环境，不传则获取默认标题
    */
   getDescription(lang) {
+    if (this.description == void 0)
+      return void 0;
     return getTextByLanguageCode(this.description, lang);
   }
   static parseJSON(json) {
@@ -190,6 +192,9 @@ var Widget = class extends Page {
   isSupportNormal() {
     return (this.supportDeployMode & 1 /* NORMAL */) > 0;
   }
+  isConfigurable() {
+    return this.configPagePath != null && this.configPagePath != "";
+  }
 };
 var WidgetKeyword = /* @__PURE__ */ ((WidgetKeyword2) => {
   WidgetKeyword2["RECOMMEND"] = "recommend";
@@ -1197,6 +1202,9 @@ var WidgetApiImpl = class extends BaseApi {
     }
     return widgets;
   }
+  async openConfigPage(widgetId) {
+    return this.invokeMethod("openConfigPage", widgetId);
+  }
   async getWidgetPackages() {
     return await this.invokeMethod("getWidgetPackages");
   }
@@ -1515,6 +1523,25 @@ var BrowserWindowApiImpl = class extends BaseApi {
   setZoomFactor(factor) {
     return this.invokeMethod("setZoomFactor", factor);
   }
+  async setup(options) {
+    if (options.alwaysOnTop) {
+      await this.setAlwaysOnTop(true);
+    }
+    if (options.center) {
+      await this.center();
+    }
+    await this.setResizable(!!options.resizable);
+    await this.setMovable(!!options.movable);
+    if (options.width && options.height) {
+      await this.setSize(options.width, options.height);
+    }
+    if (options.minWidth && options.minHeight) {
+      await this.setMinimumSize(options.minWidth, options.minHeight);
+    }
+    if (options.maxWidth && options.maxHeight) {
+      await this.setMaximumSize(options.maxWidth, options.maxHeight);
+    }
+  }
 };
 var BrowserWindowApi = new BrowserWindowApiImpl();
 
@@ -1629,7 +1656,7 @@ var NotificationApiImpl = class extends BaseApi {
 };
 var NotificationApi = new NotificationApiImpl();
 
-// src/api/HostedWidgetApi.ts
+// src/api/DeployedWidgetApi.ts
 var DeployedWidgetApiImpl = class extends BaseApi {
   getChannel() {
     return "channel::cn.widgetjs.core.hosted_widget" /* HOSTED_WIDGET */;
@@ -1670,8 +1697,8 @@ var DeployedWidgetApiImpl = class extends BaseApi {
   async openDevTools(widgetId) {
     return this.invokeMethod("openDevTools", widgetId);
   }
-  async openConfigRoute(widgetId, params) {
-    return this.invokeMethod("openConfigRoute", widgetId, params);
+  async openConfigPage(widgetId, params) {
+    return this.invokeMethod("openConfigPage", widgetId, params);
   }
   /**
    * 注册激活、呼出、置顶组件快捷键
@@ -1757,6 +1784,7 @@ var ShortcutApi = new ShortcutApiImpl();
 var AppApiEvent = /* @__PURE__ */ ((AppApiEvent2) => {
   AppApiEvent2["CONFIG_CHANGED"] = "event::cn.widgetjs.core.app.config.changed";
   AppApiEvent2["MOVING_GRID_WINDOW"] = "event::cn.widgetjs.core.app.moving.grid.window";
+  AppApiEvent2["STOP_MOVING_GRID_WINDOW"] = "event::cn.widgetjs.core.app.moving.grid.window.stop";
   return AppApiEvent2;
 })(AppApiEvent || {});
 var AppApiConstants = /* @__PURE__ */ ((AppApiConstants2) => {