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

package/dist/index.d.ts

@@ -1,39 +1,7 @@
 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';
 
-/**
- * @deprecated use DeployedMode instead
- */
-declare enum HostedMode {
-    NORMAL = 1,
-    /**
-     * 悬浮窗
-     */
-    OVERLAP = 16,
-    WALLPAPER = 256,
-    SCREEN = 4096,
-    /**
-     * 后台组件，没有界面，一般在后台执行定时任务
-     */
-    BACKGROUND = 65536,
-    /**
-     * 页面
-     */
-    PAGE = 1048576,
-    ALL = 1118481
-}
-declare enum DeployMode {
-    NORMAL = 1,
-    /**
-     * 悬浮窗
-     */
-    OVERLAP = 16,
-    BACKGROUND = 65536,
-    ALL = 1118481
-}
-
 interface Language {
     locale: string;
     language: string;
@@ -74,11 +42,42 @@ type LanguageTextMap = {
     [key in LanguageCode]?: string;
 };
 
+/**
+ * @deprecated use DeployedMode instead
+ */
+declare enum HostedMode {
+    NORMAL = 1,
+    /**
+     * 悬浮窗
+     */
+    OVERLAP = 16,
+    WALLPAPER = 256,
+    SCREEN = 4096,
+    /**
+     * 后台组件，没有界面，一般在后台执行定时任务
+     */
+    BACKGROUND = 65536,
+    /**
+     * 页面
+     */
+    PAGE = 1048576,
+    ALL = 1118481
+}
+declare enum DeployMode {
+    NORMAL = 1,
+    /**
+     * 悬浮窗
+     */
+    OVERLAP = 16,
+    BACKGROUND = 65536,
+    ALL = 1118481
+}
+
 type WidgetPermission = 'keyboard' | 'mouse' | 'clipboard' | 'notification' | 'storage' | 'network' | 'cpu' | 'system-info';
 
-type MetaInfo = {
+interface MetaInfo {
     [key: string]: string | number | boolean;
-};
+}
 interface IWindowSize {
     width: number;
     height: number;
@@ -413,12 +412,12 @@ declare class WidgetPackage implements RemotePackageUrlInfo {
     getIndexUrl(hash?: boolean): string;
     getUrl(path: string, hash?: boolean): string;
 }
-type DevOptions = {
+interface DevOptions {
     folder?: string;
     route?: boolean;
     devUrl?: string;
     remoteEntry?: string;
-};
+}
 
 declare class WidgetParams {
     static readonly PARAM_PREFIX = "w_";
@@ -540,7 +539,7 @@ declare const WidgetApi: WidgetApiImpl;
 interface IAppApi {
     setConfig(key: string, value: string | number | boolean): Promise<any>;
     getConfig(key: string, defaultValue: string | number | boolean): Promise<string | number | boolean>;
-    getVersion(): Promise<string>;
+    getVersion(type?: 'app' | 'electron' | 'chrome' | 'node' | 'v8'): Promise<string>;
     getPreloadPath(): Promise<string>;
     getAppPath(): Promise<string>;
     openAddWidgetWindow(): Promise<void>;
@@ -669,7 +668,7 @@ declare class WidgetData {
     injectThemeProperties(): void;
 }
 
-type NotificationType = "countdown" | "advance-countdown" | "error" | "success" | "warning" | "info" | "reminder" | "url" | "call";
+type NotificationType = 'countdown' | 'advance-countdown' | 'error' | 'success' | 'warning' | 'info' | 'reminder' | 'url' | 'call';
 declare enum NotificationSize {
     SMALL = "small",
     NORMAL = "normal",
@@ -770,10 +769,10 @@ interface Point {
     x: number;
     y: number;
 }
-type Position = {
+interface Position {
     x: number;
     y: number;
-};
+}
 declare enum Gravity {
     TOP = "TOP",
     LEFT = "LEFT",
@@ -881,21 +880,21 @@ declare function parseQuery(search: string): LocationQuery;
  */
 declare function stringifyQuery(query: LocationQueryRaw): string;
 
-type NormalizeOptions = {
+interface NormalizeOptions {
     /**
      @default 'http'
      */
     defaultProtocol?: string | 'http' | 'https';
     /**
      Prepends `defaultProtocol` to the URL if it's protocol-relative.
-  
+     
      @default true
-  
+     
      @example
      ```
      normalizeUrl('//sindresorhus.com');
      //=> 'http://sindresorhus.com'
-  
+     
      normalizeUrl('//sindresorhus.com', {normalizeProtocol: false});
      //=> '//sindresorhus.com'
      ```
@@ -903,14 +902,14 @@ type NormalizeOptions = {
     readonly normalizeProtocol?: boolean;
     /**
      Normalizes HTTPS URLs to HTTP.
-  
+     
      @default false
-  
+     
      @example
      ```
      normalizeUrl('https://sindresorhus.com');
      //=> 'https://sindresorhus.com'
-  
+     
      normalizeUrl('https://sindresorhus.com', {forceHttp: true});
      //=> 'http://sindresorhus.com'
      ```
@@ -918,16 +917,16 @@ type NormalizeOptions = {
     readonly forceHttp?: boolean;
     /**
      Normalizes HTTP URLs to HTTPS.
-  
+     
      This option cannot be used with the `forceHttp` option at the same time.
-  
+     
      @default false
-  
+     
      @example
      ```
      normalizeUrl('http://sindresorhus.com');
      //=> 'http://sindresorhus.com'
-  
+     
      normalizeUrl('http://sindresorhus.com', {forceHttps: true});
      //=> 'https://sindresorhus.com'
      ```
@@ -935,14 +934,14 @@ type NormalizeOptions = {
     readonly forceHttps?: boolean;
     /**
      Strip the [authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) part of a URL.
-  
+     
      @default true
-  
+     
      @example
      ```
      normalizeUrl('https://user:password@sindresorhus.com');
      //=> 'https://sindresorhus.com'
-  
+     
      normalizeUrl('https://user:password@sindresorhus.com', {stripAuthentication: false});
      //=> 'https://user:password@sindresorhus.com'
      ```
@@ -950,14 +949,14 @@ type NormalizeOptions = {
     readonly stripAuthentication?: boolean;
     /**
      Removes hash from the URL.
-  
+     
      @default false
-  
+     
      @example
      ```
      normalizeUrl('sindresorhus.com/about.html#contact');
      //=> 'http://sindresorhus.com/about.html#contact'
-  
+     
      normalizeUrl('sindresorhus.com/about.html#contact', {stripHash: true});
      //=> 'http://sindresorhus.com/about.html'
      ```
@@ -965,16 +964,16 @@ type NormalizeOptions = {
     readonly stripHash?: boolean;
     /**
      Remove the protocol from the URL: `http://sindresorhus.com` → `sindresorhus.com`.
-  
+     
      It will only remove `https://` and `http://` protocols.
-  
+     
      @default false
-  
+     
      @example
      ```
      normalizeUrl('https://sindresorhus.com');
      //=> 'https://sindresorhus.com'
-  
+     
      normalizeUrl('sindresorhus.com', {stripProtocol: true});
      //=> 'sindresorhus.com'
      ```
@@ -982,22 +981,22 @@ type NormalizeOptions = {
     readonly stripProtocol?: boolean;
     /**
      Strip the [text fragment](https://web.dev/text-fragments/) part of the URL
-  
+     
      __Note:__ The text fragment will always be removed if the `stripHash` option is set to `true`, as the hash contains the text fragment.
-  
+     
      @default true
-  
+     
      @example
      ```
      normalizeUrl('http://sindresorhus.com/about.html#:~:text=hello');
      //=> 'http://sindresorhus.com/about.html#'
-  
+     
      normalizeUrl('http://sindresorhus.com/about.html#section:~:text=hello');
      //=> 'http://sindresorhus.com/about.html#section'
-  
+     
      normalizeUrl('http://sindresorhus.com/about.html#:~:text=hello', {stripTextFragment: false});
      //=> 'http://sindresorhus.com/about.html#:~:text=hello'
-  
+     
      normalizeUrl('http://sindresorhus.com/about.html#section:~:text=hello', {stripTextFragment: false});
      //=> 'http://sindresorhus.com/about.html#section:~:text=hello'
      ```
@@ -1005,14 +1004,14 @@ type NormalizeOptions = {
     readonly stripTextFragment?: boolean;
     /**
      Removes `www.` from the URL.
-  
+     
      @default true
-  
+     
      @example
      ```
      normalizeUrl('http://www.sindresorhus.com');
      //=> 'http://sindresorhus.com'
-  
+     
      normalizeUrl('http://www.sindresorhus.com', {stripWWW: false});
      //=> 'http://www.sindresorhus.com'
      ```
@@ -1020,9 +1019,9 @@ type NormalizeOptions = {
     readonly stripWWW?: boolean;
     /**
      Removes query parameters that matches any of the provided strings or regexes.
-  
+     
      @default [/^utm_\w+/i]
-  
+     
      @example
      ```
      normalizeUrl('www.sindresorhus.com?foo=bar&ref=test_ref', {
@@ -1030,18 +1029,18 @@ type NormalizeOptions = {
       });
      //=> 'http://sindresorhus.com/?foo=bar'
      ```
-  
+     
      If a boolean is provided, `true` will remove all the query parameters.
-  
+     
      ```
      normalizeUrl('www.sindresorhus.com?foo=bar', {
           removeQueryParameters: true
       });
      //=> 'http://sindresorhus.com'
      ```
-  
+     
      `false` will not remove any query parameter.
-  
+     
      ```
      normalizeUrl('www.sindresorhus.com?foo=bar&utm_medium=test&ref=test_ref', {
           removeQueryParameters: false
@@ -1052,11 +1051,11 @@ type NormalizeOptions = {
     readonly removeQueryParameters?: ReadonlyArray<RegExp | string> | boolean;
     /**
      Keeps only query parameters that matches any of the provided strings or regexes.
-  
+     
      __Note__: It overrides the `removeQueryParameters` option.
-  
+     
      @default undefined
-  
+     
      @example
      ```
      normalizeUrl('https://sindresorhus.com?foo=bar&ref=unicorn', {
@@ -1068,19 +1067,19 @@ type NormalizeOptions = {
     readonly keepQueryParameters?: ReadonlyArray<RegExp | string>;
     /**
      Removes trailing slash.
-  
+     
      __Note__: Trailing slash is always removed if the URL doesn't have a pathname unless the `removeSingleSlash` option is set to `false`.
-  
+     
      @default true
-  
+     
      @example
      ```
      normalizeUrl('http://sindresorhus.com/redirect/');
      //=> 'http://sindresorhus.com/redirect'
-  
+     
      normalizeUrl('http://sindresorhus.com/redirect/', {removeTrailingSlash: false});
      //=> 'http://sindresorhus.com/redirect/'
-  
+     
      normalizeUrl('http://sindresorhus.com/', {removeTrailingSlash: false});
      //=> 'http://sindresorhus.com'
      ```
@@ -1088,14 +1087,14 @@ type NormalizeOptions = {
     readonly removeTrailingSlash?: boolean;
     /**
      Remove a sole `/` pathname in the output. This option is independent of `removeTrailingSlash`.
-  
+     
      @default true
-  
+     
      @example
      ```
      normalizeUrl('https://sindresorhus.com/');
      //=> 'https://sindresorhus.com'
-  
+     
      normalizeUrl('https://sindresorhus.com/', {removeSingleSlash: false});
      //=> 'https://sindresorhus.com/'
      ```
@@ -1104,9 +1103,9 @@ type NormalizeOptions = {
     /**
      Removes the default directory index file from path that matches any of the provided strings or regexes.
      When `true`, the regex `/^index\.[a-z]+$/` is used.
-  
+     
      @default false
-  
+     
      @example
      ```
      normalizeUrl('www.sindresorhus.com/foo/default.php', {
@@ -1118,11 +1117,11 @@ type NormalizeOptions = {
     removeDirectoryIndex?: boolean | ReadonlyArray<RegExp | string>;
     /**
      Removes an explicit port number from the URL.
-  
+     
      Port 443 is always removed from HTTPS URLs and 80 is always removed from HTTP URLs regardless of this option.
-  
+     
      @default false
-  
+     
      @example
      ```
      normalizeUrl('sindresorhus.com:123', {
@@ -1134,9 +1133,9 @@ type NormalizeOptions = {
     readonly removeExplicitPort?: boolean;
     /**
      Sorts the query parameters alphabetically by key.
-  
+     
      @default true
-  
+     
      @example
      ```
      normalizeUrl('www.sindresorhus.com?b=two&a=one&c=three', {
@@ -1146,7 +1145,7 @@ type NormalizeOptions = {
      ```
      */
     readonly sortQueryParameters?: boolean;
-};
+}
 declare function normalizeUrl(urlString: string, options?: NormalizeOptions): string;
 
 interface IGridRect {
@@ -1231,8 +1230,8 @@ declare class GridSystem extends GridRect {
 }
 
 declare class ElectronApi {
-    static addIpcListener(key: String, f: Function): Promise<void>;
-    static removeIpcListener(key: String): Promise<void>;
+    static addIpcListener(key: string, f: Function): Promise<void>;
+    static removeIpcListener(key: string): Promise<void>;
 }
 
 interface SaveWidgetOption {
@@ -1301,7 +1300,7 @@ interface IBrowserWindowApi {
     setMinimumSize(width: number, height: number): Promise<void>;
     setZoomLevel(level: number): Promise<void>;
     setZoomFactor(factor: number): Promise<void>;
-    setProxy(config: Config): Promise<void>;
+    setProxy(config: Electron.Config): Promise<void>;
     isFocused(): Promise<boolean>;
 }
 type BrowserWindowApiMethods = keyof IBrowserWindowApi;
@@ -1387,7 +1386,7 @@ declare class BrowserWindowApiImpl extends BaseApi<BrowserWindowApiMethods> impl
     close(): Promise<void>;
     setZoomFactor(factor: number): Promise<void>;
     setup(options: SetupOptions): Promise<void>;
-    setProxy(config: Config): Promise<void>;
+    setProxy(config: Electron.Config): Promise<void>;
 }
 declare const BrowserWindowApi: BrowserWindowApiImpl;
 
@@ -1549,18 +1548,18 @@ type BroadcastApiMethods = keyof IBroadcastApi;
 declare const BroadcastApi: IBroadcastApi;
 
 interface IProcessApi {
-    getCPUUsage(): Promise<CPUUsage>;
-    getIOCounters(): Promise<IOCounters>;
-    getBlinkMemoryInfo(): Promise<BlinkMemoryInfo>;
-    getHeapStatistics(): Promise<HeapStatistics>;
+    getCPUUsage(): Promise<Electron.CPUUsage>;
+    getIOCounters(): Promise<Electron.IOCounters>;
+    getBlinkMemoryInfo(): Promise<Electron.BlinkMemoryInfo>;
+    getHeapStatistics(): Promise<Electron.HeapStatistics>;
     /**
      * // On macOS -> '10.13.6'
      * // On Windows -> '10.0.17763'
      * // On Linux -> '4.15.0-45-generic'
      */
     getSystemVersion(): Promise<string>;
-    getProcessMemoryInfo(): Promise<ProcessMemoryInfo>;
-    getSystemMemoryInfo(): Promise<SystemMemoryInfo>;
+    getProcessMemoryInfo(): Promise<Electron.ProcessMemoryInfo>;
+    getSystemMemoryInfo(): Promise<Electron.SystemMemoryInfo>;
 }
 type ProcessApiMethods = keyof IProcessApi;
 declare const ProcessApi: IProcessApi;
@@ -1725,4 +1724,8 @@ 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, 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 };
+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 };