@widget-js/core 0.11.15 → 0.11.21

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import * as CSS from 'csstype';
 import { Config, CPUUsage, IOCounters, BlinkMemoryInfo, HeapStatistics, ProcessMemoryInfo, SystemMemoryInfo } from 'electron';
 import { FileTypeResult } from 'file-type';
 import { FormatEnum, ColourspaceEnum, Channels, LevelMetadata } from 'sharp';
@@ -219,6 +220,12 @@ declare class Page implements IPage {
     isResizable(): boolean;
 }
 
+type SocialType = 'qq' | 'wechat' | 'qq-group' | 'discord' | 'telegram' | 'tiktok' | 'douyin' | 'youtube' | 'instagram' | 'twitter' | 'facebook' | 'kuaishou' | 'bilibili' | 'github' | 'email' | 'gitee' | 'homepage';
+interface SocialLink {
+    name: SocialType;
+    link: string;
+}
+
 interface IWidgetOptions extends IWindowSize, IPageOptions {
     supportDeployMode?: DeployMode;
     configPagePath?: string;
@@ -228,6 +235,10 @@ interface IWidgetOptions extends IWindowSize, IPageOptions {
     /**
      */
     routes?: WidgetRoute[];
+    /**
+     * 一般用于填写教程链接
+     */
+    socialLinks?: SocialLink[];
 }
 /**
  * @deprecated
@@ -247,6 +258,7 @@ declare class Widget extends Page {
      * @deprecated
      */
     readonly routes: WidgetRoute[];
+    readonly socialLinks?: SocialLink[];
     constructor(options: IWidgetOptions);
     static parseJSON(json: string): Widget;
     static parseObject(obj: any): Widget;
@@ -301,6 +313,10 @@ interface WidgetPackageOptions extends LocalPackageUrlInfo {
     title: LanguageTextMap;
     permissions?: WidgetPermission[];
     description: LanguageTextMap;
+    /**
+     * 远程组件包入口文件
+     * @deprecated 使用 remote.entry 替代
+     */
     remoteEntry?: string;
     remotePackage?: string;
     remote?: RemotePackageUrlInfo;
@@ -340,13 +356,18 @@ declare class WidgetPackage implements RemotePackageUrlInfo {
         [key: LanguageCode | string]: string;
     };
     /**
-     * 组件入口文件，通常为 index.html
+     * 本地组件入口文件，通常为 index.html
      */
     entry: string | 'index.html';
     /**
-     * 组件包的远程入口地址，
+     * 远程组件包入口文件
+     * @deprecated 使用 remote.entry 替代
      */
     remoteEntry?: string;
+    /**
+     * 组件包json文件路径
+     * @example https://rtugeek.gitee.io/hotspot/widget.json
+     */
     readonly remotePackage?: string;
     readonly local?: LocalPackageUrlInfo;
     readonly remote?: RemotePackageUrlInfo;
@@ -478,6 +499,7 @@ interface IWidgetApi {
     getWidgetConfigUrl(widgetName: string, widgetParams: WidgetParams): Promise<string | null>;
     openConfigPage(id: string): Promise<void>;
     openConfigPageByName(name: string): Promise<void>;
+    reload(): Promise<void>;
     getWidgetPackageUrl(packageName: string): Promise<string | null>;
 }
 type WidgetApiMethods = keyof IWidgetApi;
@@ -486,6 +508,7 @@ declare enum WidgetApiEvent {
     EDIT_DESKTOP_WIDGETS = "event::cn.widgetjs.core.widget.desktop.edit"
 }
 declare class WidgetApiImpl extends BaseApi<WidgetApiMethods> implements IWidgetApi {
+    reload(): Promise<void>;
     getChannel(): string;
     registerWidgets(widgets: Widget[]): Promise<any>;
     registerWidgetPackage(widgetPackage: WidgetPackage): Promise<any>;
@@ -523,6 +546,10 @@ interface IAppApi {
     openAddWidgetWindow(): Promise<void>;
     openSettingWindow(): Promise<void>;
     getIconFile(): Promise<string>;
+    /**
+     * 应用是否是从微软商店下载
+     */
+    isWindowsStore(): Promise<boolean>;
 }
 type AppApiMethods = keyof IAppApi;
 declare enum AppApiEvent {
@@ -563,6 +590,30 @@ declare class WebSocketEvent {
     constructor(type: WebSocketEventType, payload: any);
 }
 
+interface WidgetTheme {
+    borderRadius?: CSS.Properties['borderRadius'];
+    backgroundColor?: CSS.Properties['color'];
+    fontSize?: CSS.Properties['fontSize'];
+    dividerColor?: CSS.Properties['color'];
+    /**
+     * 主色调
+     */
+    primaryColor?: CSS.Properties['color'];
+    /**
+     * 文字颜色
+     */
+    color?: CSS.Properties['color'];
+    fontFamily?: CSS.Properties['fontFamily'];
+    shadowColor?: CSS.Properties['color'];
+    padding?: CSS.Properties['padding'];
+    borderColor?: CSS.Properties['borderColor'];
+}
+type WidgetThemeKey = keyof WidgetTheme;
+/**
+ * Widget default theme, this object is immutable. Clone it before use.
+ */
+declare const DefaultWidgetTheme: WidgetTheme;
+
 /**
  * 组件配置数据，用于存储组件自定义页面所设置的数据
  */
@@ -577,26 +628,45 @@ declare class WidgetData {
     name: string;
     /**
      * 背景颜色
+     * @deprecated
      */
     backgroundColor?: string;
     /**
      * 文字颜色
+     * @deprecated
      */
     color?: string;
     /**
      * 字体大小
+     * @deprecated
      */
     fontSize?: number;
     /**
      * 字体
+     * @deprecated
      */
     fontFamily?: string;
     /**
      * 圆角半径
+     * @deprecated
      */
     borderRadius?: number;
+    /**
+     * 组件样式
+     */
+    theme: WidgetTheme;
     constructor(name: string, id?: string);
     parseJSON(json: {}): void;
+    /**
+     * Gets the style properties from the widget's style object.
+     * @returns A record representing CSS custom properties and their values.
+     */
+    getThemeProperties(): Record<string, string>;
+    /**
+     * Injects the style properties as css variable.
+     * @remarks Only works in a browser environment.
+     */
+    injectThemeProperties(): void;
 }
 
 type NotificationType = "countdown" | "advance-countdown" | "error" | "success" | "warning" | "info" | "reminder" | "url" | "call";
@@ -1606,7 +1676,7 @@ interface DownloadUrlOptions {
     overwrite?: boolean;
 }
 interface IFileApi {
-    readDirectory(path: string, options?: ReadDirOptions): Promise<SystemFile[]>;
+    readDirectory(path: string, options?: ReadDirOptions): Promise<SystemFile>;
     isDirectory(filePath: string): Promise<boolean>;
     getMimeType(absoluteFilePath: string): Promise<FileTypeResult>;
     downloadUrl(option: DownloadUrlOptions): Promise<string>;
@@ -1646,4 +1716,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, 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, SystemFile, ThemeMode, WebSocketEvent, WebSocketEventType, Widget, WidgetApi, WidgetApiEvent, WidgetApiMethods, WidgetData, WidgetDataApi, WidgetDataApiMethods, WidgetKeyword, WidgetPackage, WidgetPackageOptions, WidgetParams, WidgetPermission, WidgetRoute, WidgetUrlUtils, getTextByLanguageCode, normalizeUrl, parseQuery, stringifyQuery };
+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, SystemFile, ThemeMode, WebSocketEvent, WebSocketEventType, Widget, WidgetApi, WidgetApiEvent, WidgetApiMethods, WidgetData, WidgetDataApi, WidgetDataApiMethods, WidgetKeyword, WidgetPackage, WidgetPackageOptions, WidgetParams, WidgetPermission, WidgetRoute, WidgetTheme, WidgetThemeKey, WidgetUrlUtils, getTextByLanguageCode, normalizeUrl, parseQuery, stringifyQuery };

package/dist/index.js

@@ -163,10 +163,12 @@ var Widget = class extends Page {
    * @deprecated
    */
   routes;
+  socialLinks;
   constructor(options) {
     super(options);
     this.configPagePath = options.configPagePath;
     this.supportDeployMode = options.supportDeployMode ?? 1 /* NORMAL */ | 16 /* OVERLAP */;
+    this.socialLinks = options.socialLinks;
     this.routes = options.routes ?? [];
   }
   static parseJSON(json) {
@@ -248,6 +250,21 @@ var WebSocketEvent = class {
   }
 };
 
+// src/model/WidgetData.ts
+import kebabCase from "lodash/kebabCase";
+
+// src/model/WidgetTheme.ts
+var DefaultWidgetTheme = {
+  backgroundColor: "rgba(0,0,0,0.2)",
+  color: "#fff",
+  fontSize: "14px",
+  borderColor: "rgba(255,255,255,0.4)",
+  dividerColor: "rgba(255,255,255,0.4)",
+  primaryColor: "rgb(0, 149, 255)",
+  borderRadius: "22px"
+};
+Object.freeze(DefaultWidgetTheme);
+
 // src/model/WidgetData.ts
 var WidgetData = class {
   /**
@@ -260,31 +277,66 @@ var WidgetData = class {
   name;
   /**
    * 背景颜色
+   * @deprecated
    */
   backgroundColor;
   /**
    * 文字颜色
+   * @deprecated
    */
   color;
   /**
    * 字体大小
+   * @deprecated
    */
   fontSize;
   /**
    * 字体
+   * @deprecated
    */
   fontFamily;
   /**
    * 圆角半径
+   * @deprecated
    */
   borderRadius;
+  /**
+   * 组件样式
+   */
+  theme;
   constructor(name, id) {
     this.id = id;
     this.name = name;
+    this.theme = JSON.parse(JSON.stringify(DefaultWidgetTheme));
   }
   parseJSON(json) {
     Object.assign(this, json);
   }
+  /**
+   * Gets the style properties from the widget's style object.
+   * @returns A record representing CSS custom properties and their values.
+   */
+  getThemeProperties() {
+    const properties = {};
+    if (this.theme) {
+      const prefix = "--widget-";
+      let keys = Object.keys(this.theme);
+      keys.filter((key) => this.theme[key] != void 0).map((key) => {
+        properties[`${prefix}${kebabCase(key)}`] = `${this.theme[key]}`;
+      });
+    }
+    return properties;
+  }
+  /**
+   * Injects the style properties as css variable.
+   * @remarks Only works in a browser environment.
+   */
+  injectThemeProperties() {
+    const properties = this.getThemeProperties();
+    Object.keys(properties).forEach((key) => {
+      document.documentElement.style.setProperty(key, properties[key].toString());
+    });
+  }
 };
 
 // src/router/encoding.ts
@@ -367,7 +419,7 @@ function stringifyQuery(query) {
 }
 
 // src/model/WidgetParams.ts
-import { snakeCase } from "change-case";
+import snakeCase from "lodash/snakeCase";
 var _WidgetParams = class {
   //组件id
   id;
@@ -860,13 +912,18 @@ var WidgetPackage = class {
    */
   description;
   /**
-   * 组件入口文件，通常为 index.html
+   * 本地组件入口文件，通常为 index.html
    */
   entry;
   /**
-   * 组件包的远程入口地址，
+   * 远程组件包入口文件
+   * @deprecated 使用 remote.entry 替代
    */
   remoteEntry;
+  /**
+   * 组件包json文件路径
+   * @example https://rtugeek.gitee.io/hotspot/widget.json
+   */
   remotePackage;
   local;
   remote;
@@ -1247,6 +1304,9 @@ var WidgetApiEvent = /* @__PURE__ */ ((WidgetApiEvent2) => {
   return WidgetApiEvent2;
 })(WidgetApiEvent || {});
 var WidgetApiImpl = class extends BaseApi {
+  reload() {
+    return this.invokeMethod("reload");
+  }
   getChannel() {
     return "channel::cn.widgetjs.core.widget" /* WIDGET */;
   }
@@ -1894,6 +1954,9 @@ var AppApiConstants = /* @__PURE__ */ ((AppApiConstants2) => {
   return AppApiConstants2;
 })(AppApiConstants || {});
 var AppApiImpl = class extends BaseApi {
+  isWindowsStore() {
+    return this.invokeMethod("isWindowsStore");
+  }
   getAppPath() {
     return this.invokeMethod("getAppPath");
   }
@@ -2077,6 +2140,7 @@ export {
   Channel,
   ClipboardApi,
   ClipboardApiEvent,
+  DefaultWidgetTheme,
   DeployMode,
   DeployedPage,
   DeployedWidget,