@widget-js/core 24.1.1-beta.76 → 24.1.1-beta.78

package/dist/index.d.cts

@@ -1,6 +1,7 @@
 import * as CSS from 'csstype';
 import { FileTypeResult } from 'file-type';
 import { FormatEnum, ColourspaceEnum, Channels, LevelMetadata } from 'sharp';
+import { AuthSession, AuthUser } from '@supabase/supabase-js';
 
 interface Language {
     baseName: string;
@@ -2293,25 +2294,12 @@ declare enum TrayApiEvent {
     CLICK = "channel::cn.widgetjs.core.tray.click"
 }
 
-interface AppUser {
-    /**
-     * User's auth token, commonly JWT token
-     */
-    token: string;
-    nickName?: string;
-    email: string;
-    id: number;
-    avatar: string;
-    createTime: string;
-    updateTime: string;
-}
-
 interface IUserApi {
     /**
      * Login with user info.
      * @param token
      */
-    login: (user: AppUser) => Promise<void>;
+    login: (session: AuthSession) => Promise<void>;
     /**
      * Clear user auth token and user info.
      */
@@ -2319,8 +2307,24 @@ interface IUserApi {
     /**
      * Get current logged in user info. If no user is logged in, return null.
      */
-    getUserInfo: () => Promise<AppUser | null>;
+    getUser: () => Promise<AuthUser | null>;
+    updateSession: (session: AuthSession) => Promise<void>;
+    getSession: () => Promise<AuthSession | null>;
+    updateUser: (user: AuthUser) => Promise<void>;
 }
+/**
+ * ShortcutApiEvent
+ */
+declare enum UserApiEvent {
+    /**
+     * 快捷键触发事件
+     */
+    USER_UPDATED = "channel::cn.widgetjs.core.user.updated",
+    SIGNED_OUT = "channel::cn.widgetjs.core.user.signed.out",
+    SIGNED_IN = "channel::cn.widgetjs.core.user.signed.in",
+    TOKEN_REFRESHED = "channel::cn.widgetjs.core.user.token.refreshed"
+}
+type UserApiMethods = keyof IUserApi;
 
 type DeviceApiMethods = keyof IDeviceApi;
 declare const DeviceApi: IDeviceApi;
@@ -2774,6 +2778,8 @@ interface IWidgetApi {
      */
     getWidgetPackageUrl: (packageName: string) => Promise<string | null>;
     restartWidgets: (mode?: DeployMode) => Promise<void>;
+    updateSyncInfo: () => Promise<void>;
+    getSyncInfo: (widgetName?: string) => Promise<WidgetSyncInfo | null>;
 }
 
 type WidgetApiMethods = keyof IWidgetApi;
@@ -2784,6 +2790,8 @@ declare enum WidgetApiEvent {
     PACKAGE_INSTALLED = "event::cn.widgetjs.core.widget.package.installed"
 }
 declare class WidgetApiImpl extends BaseApi<WidgetApiMethods> implements IWidgetApi {
+    getSyncInfo(widgetName?: string): Promise<WidgetSyncInfo | null>;
+    updateSyncInfo(): Promise<void>;
     reload(id?: string): Promise<void>;
     getChannel(): string;
     registerWidgets(widgets: Widget[]): Promise<any>;
@@ -3197,6 +3205,10 @@ interface IWidgetOptions extends IWindowSize, IPageOptions {
      */
     disabled?: boolean;
     previewImage: string;
+    /**
+     * whether the widget data can be synchronized
+     */
+    synchronizable?: boolean;
     categories?: Category[];
     /**
      * 组件包所需的App版本
@@ -3244,6 +3256,7 @@ declare class Widget extends Page {
      * 如果为true，组件将不会添加到组件包中
      */
     readonly disabled?: boolean;
+    readonly synchronizable?: boolean;
     /**
      * 配置页面路径，没有则不能修改
      */
@@ -3316,6 +3329,11 @@ interface AppMouseEvent {
     location: string;
 }
 
+interface WidgetSyncInfo {
+    widgetName: string;
+    latestSyncTime: Date;
+}
+
 declare class ElectronUtils {
     static hasElectronApi(): boolean;
     /**
@@ -3763,4 +3781,4 @@ declare class GridSystem extends GridRect {
     getHeight(): number;
 }
 
-export { type AddWidgetOption, type AlignPosition, ApiConstants, AppApi, AppApiConstants, AppApiEvent, type AppApiMethods, AppConfig, AppEvent, type AppMouseEvent, AppNotification, AppReminderNotification, type AppRuntimeInfo, BackgroundWidget, BaseApi, type BatteryData, BroadcastApi, type BroadcastApiMethods, BroadcastEvent, type BroadcastEventType, BrowserWindowApi, BrowserWindowApiEvent, type BrowserWindowApiMethods, type BrowserWindowOptions, type CallNotificationOption, type Category, Channel, ClipboardApi, ClipboardApiEvent, type ClipboardApiMethods, type CountdownNotificationOption, type CpuCacheData, type CpuCurrentSpeedData, type CpuData, type CurrentLoadCpuData, type CurrentLoadData, DefaultWidgetTheme, DeployMode, DeployedPage, DeployedWidget, DeployedWidgetApi, type DeployedWidgetApiMethods, type DevOptions, DeviceApi, type DeviceApiMethods, DialogApi, type DialogApiMethods, type DiskLayoutData, type Display, type DownloadUrlOptions, ElectronApi, ElectronUtils, FileApi, type FileApiMethods, type GraphicsControllerData, type GraphicsData, type GraphicsDisplayData, Gravity, GridRect, GridSystem, type Hardware, type HardwareSensor, type HardwareType, HostedMode, HttpApi, type HttpApiMethods, type IAppApi, type IBackgroundWidgetOptions, type IDeviceApi, type IDialogApi, type IFileApi, type IGridRect, type ILogApi, type IMouseApi, type IPage, type IPageOptions, type IProcessApi, type ITrayApi, type IUserApi, type IWidgetDataApi, type IWidgetOptions, type IWidgetPackageApi, type IWidgetTheme, type IWindowSize, type InfoNotificationOption, type Language, type LanguageCode, LanguageMap, type LanguageTextMap, LanguageUtils, type LocalPackageUrlInfo, type LocationQuery, type LocationQueryRaw, type LocationQueryValue, type LocationQueryValueRaw, LogApi, type LogApiMethods, type MemData, type MemLayoutData, MenuApi, MenuApiEvent, type MenuApiMethods, type MetaInfo, type Metadata, MouseApi, MouseApiEvent, type MouseApiMethods, type NativeKeyboardEvent, type Node, type NormalizeOptions, NotificationApi, NotificationApiEvent, type NotificationApiMethods, type NotificationOption, NotificationSize, type NotificationType, type OsData, Page, type Point, type Position, ProcessApi, type ProcessApiMethods, type ProxyConfig, type ReadDirOptions, type Rectangle, type ReminderNotificationOption, type RemotePackageUrlInfo, type SaveWidgetOption, type SensorType, type SetPositionOptions, ShortcutApi, ShortcutApiEvent, type ShortcutApiMethods, type ShortcutDetails, type ShowMenuOption, type Size, type SmartData, SocialInfo, type SocialLink, type SocialType, StorageApi, type StorageApiMethods, StoreApi, type StoreApiMethods, SystemApi, SystemApiEvent, type SystemApiMethods, type SystemFile, ThemeMode, TrayApiEvent, type TrayWidgetOptions, UserApi, type UserData, type VersionData, WebSocketEvent, WebSocketEventType, Widget, WidgetApi, WidgetApiEvent, type WidgetApiMethods, WidgetData, WidgetDataApi, type WidgetDataApiMethods, WidgetKeyword, type WidgetMenuItem, WidgetPackage, WidgetPackageApi, WidgetPackageApiEvent, type WidgetPackageApiMethods, type WidgetPackageOptions, WidgetPackageUtils, WidgetParams, type WidgetPermission, type WidgetRoute, WidgetTheme, type WidgetThemeKey, type WidgetThemeProperty, WidgetUtils, delay, normalizeUrl, parseQuery, stringifyQuery };
+export { type AddWidgetOption, type AlignPosition, ApiConstants, AppApi, AppApiConstants, AppApiEvent, type AppApiMethods, AppConfig, AppEvent, type AppMouseEvent, AppNotification, AppReminderNotification, type AppRuntimeInfo, BackgroundWidget, BaseApi, type BatteryData, BroadcastApi, type BroadcastApiMethods, BroadcastEvent, type BroadcastEventType, BrowserWindowApi, BrowserWindowApiEvent, type BrowserWindowApiMethods, type BrowserWindowOptions, type CallNotificationOption, type Category, Channel, ClipboardApi, ClipboardApiEvent, type ClipboardApiMethods, type CountdownNotificationOption, type CpuCacheData, type CpuCurrentSpeedData, type CpuData, type CurrentLoadCpuData, type CurrentLoadData, DefaultWidgetTheme, DeployMode, DeployedPage, DeployedWidget, DeployedWidgetApi, type DeployedWidgetApiMethods, type DevOptions, DeviceApi, type DeviceApiMethods, DialogApi, type DialogApiMethods, type DiskLayoutData, type Display, type DownloadUrlOptions, ElectronApi, ElectronUtils, FileApi, type FileApiMethods, type GraphicsControllerData, type GraphicsData, type GraphicsDisplayData, Gravity, GridRect, GridSystem, type Hardware, type HardwareSensor, type HardwareType, HostedMode, HttpApi, type HttpApiMethods, type IAppApi, type IBackgroundWidgetOptions, type IDeviceApi, type IDialogApi, type IFileApi, type IGridRect, type ILogApi, type IMouseApi, type IPage, type IPageOptions, type IProcessApi, type ITrayApi, type IUserApi, type IWidgetDataApi, type IWidgetOptions, type IWidgetPackageApi, type IWidgetTheme, type IWindowSize, type InfoNotificationOption, type Language, type LanguageCode, LanguageMap, type LanguageTextMap, LanguageUtils, type LocalPackageUrlInfo, type LocationQuery, type LocationQueryRaw, type LocationQueryValue, type LocationQueryValueRaw, LogApi, type LogApiMethods, type MemData, type MemLayoutData, MenuApi, MenuApiEvent, type MenuApiMethods, type MetaInfo, type Metadata, MouseApi, MouseApiEvent, type MouseApiMethods, type NativeKeyboardEvent, type Node, type NormalizeOptions, NotificationApi, NotificationApiEvent, type NotificationApiMethods, type NotificationOption, NotificationSize, type NotificationType, type OsData, Page, type Point, type Position, ProcessApi, type ProcessApiMethods, type ProxyConfig, type ReadDirOptions, type Rectangle, type ReminderNotificationOption, type RemotePackageUrlInfo, type SaveWidgetOption, type SensorType, type SetPositionOptions, ShortcutApi, ShortcutApiEvent, type ShortcutApiMethods, type ShortcutDetails, type ShowMenuOption, type Size, type SmartData, SocialInfo, type SocialLink, type SocialType, StorageApi, type StorageApiMethods, StoreApi, type StoreApiMethods, SystemApi, SystemApiEvent, type SystemApiMethods, type SystemFile, ThemeMode, TrayApiEvent, type TrayWidgetOptions, UserApi, UserApiEvent, type UserApiMethods, type UserData, type VersionData, WebSocketEvent, WebSocketEventType, Widget, WidgetApi, WidgetApiEvent, type WidgetApiMethods, WidgetData, WidgetDataApi, type WidgetDataApiMethods, WidgetKeyword, type WidgetMenuItem, WidgetPackage, WidgetPackageApi, WidgetPackageApiEvent, type WidgetPackageApiMethods, type WidgetPackageOptions, WidgetPackageUtils, WidgetParams, type WidgetPermission, type WidgetRoute, type WidgetSyncInfo, WidgetTheme, type WidgetThemeKey, type WidgetThemeProperty, WidgetUtils, delay, normalizeUrl, parseQuery, stringifyQuery };

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import * as CSS from 'csstype';
 import { FileTypeResult } from 'file-type';
 import { FormatEnum, ColourspaceEnum, Channels, LevelMetadata } from 'sharp';
+import { AuthSession, AuthUser } from '@supabase/supabase-js';
 
 interface Language {
     baseName: string;
@@ -2293,25 +2294,12 @@ declare enum TrayApiEvent {
     CLICK = "channel::cn.widgetjs.core.tray.click"
 }
 
-interface AppUser {
-    /**
-     * User's auth token, commonly JWT token
-     */
-    token: string;
-    nickName?: string;
-    email: string;
-    id: number;
-    avatar: string;
-    createTime: string;
-    updateTime: string;
-}
-
 interface IUserApi {
     /**
      * Login with user info.
      * @param token
      */
-    login: (user: AppUser) => Promise<void>;
+    login: (session: AuthSession) => Promise<void>;
     /**
      * Clear user auth token and user info.
      */
@@ -2319,8 +2307,24 @@ interface IUserApi {
     /**
      * Get current logged in user info. If no user is logged in, return null.
      */
-    getUserInfo: () => Promise<AppUser | null>;
+    getUser: () => Promise<AuthUser | null>;
+    updateSession: (session: AuthSession) => Promise<void>;
+    getSession: () => Promise<AuthSession | null>;
+    updateUser: (user: AuthUser) => Promise<void>;
 }
+/**
+ * ShortcutApiEvent
+ */
+declare enum UserApiEvent {
+    /**
+     * 快捷键触发事件
+     */
+    USER_UPDATED = "channel::cn.widgetjs.core.user.updated",
+    SIGNED_OUT = "channel::cn.widgetjs.core.user.signed.out",
+    SIGNED_IN = "channel::cn.widgetjs.core.user.signed.in",
+    TOKEN_REFRESHED = "channel::cn.widgetjs.core.user.token.refreshed"
+}
+type UserApiMethods = keyof IUserApi;
 
 type DeviceApiMethods = keyof IDeviceApi;
 declare const DeviceApi: IDeviceApi;
@@ -2774,6 +2778,8 @@ interface IWidgetApi {
      */
     getWidgetPackageUrl: (packageName: string) => Promise<string | null>;
     restartWidgets: (mode?: DeployMode) => Promise<void>;
+    updateSyncInfo: () => Promise<void>;
+    getSyncInfo: (widgetName?: string) => Promise<WidgetSyncInfo | null>;
 }
 
 type WidgetApiMethods = keyof IWidgetApi;
@@ -2784,6 +2790,8 @@ declare enum WidgetApiEvent {
     PACKAGE_INSTALLED = "event::cn.widgetjs.core.widget.package.installed"
 }
 declare class WidgetApiImpl extends BaseApi<WidgetApiMethods> implements IWidgetApi {
+    getSyncInfo(widgetName?: string): Promise<WidgetSyncInfo | null>;
+    updateSyncInfo(): Promise<void>;
     reload(id?: string): Promise<void>;
     getChannel(): string;
     registerWidgets(widgets: Widget[]): Promise<any>;
@@ -3197,6 +3205,10 @@ interface IWidgetOptions extends IWindowSize, IPageOptions {
      */
     disabled?: boolean;
     previewImage: string;
+    /**
+     * whether the widget data can be synchronized
+     */
+    synchronizable?: boolean;
     categories?: Category[];
     /**
      * 组件包所需的App版本
@@ -3244,6 +3256,7 @@ declare class Widget extends Page {
      * 如果为true，组件将不会添加到组件包中
      */
     readonly disabled?: boolean;
+    readonly synchronizable?: boolean;
     /**
      * 配置页面路径，没有则不能修改
      */
@@ -3316,6 +3329,11 @@ interface AppMouseEvent {
     location: string;
 }
 
+interface WidgetSyncInfo {
+    widgetName: string;
+    latestSyncTime: Date;
+}
+
 declare class ElectronUtils {
     static hasElectronApi(): boolean;
     /**
@@ -3763,4 +3781,4 @@ declare class GridSystem extends GridRect {
     getHeight(): number;
 }
 
-export { type AddWidgetOption, type AlignPosition, ApiConstants, AppApi, AppApiConstants, AppApiEvent, type AppApiMethods, AppConfig, AppEvent, type AppMouseEvent, AppNotification, AppReminderNotification, type AppRuntimeInfo, BackgroundWidget, BaseApi, type BatteryData, BroadcastApi, type BroadcastApiMethods, BroadcastEvent, type BroadcastEventType, BrowserWindowApi, BrowserWindowApiEvent, type BrowserWindowApiMethods, type BrowserWindowOptions, type CallNotificationOption, type Category, Channel, ClipboardApi, ClipboardApiEvent, type ClipboardApiMethods, type CountdownNotificationOption, type CpuCacheData, type CpuCurrentSpeedData, type CpuData, type CurrentLoadCpuData, type CurrentLoadData, DefaultWidgetTheme, DeployMode, DeployedPage, DeployedWidget, DeployedWidgetApi, type DeployedWidgetApiMethods, type DevOptions, DeviceApi, type DeviceApiMethods, DialogApi, type DialogApiMethods, type DiskLayoutData, type Display, type DownloadUrlOptions, ElectronApi, ElectronUtils, FileApi, type FileApiMethods, type GraphicsControllerData, type GraphicsData, type GraphicsDisplayData, Gravity, GridRect, GridSystem, type Hardware, type HardwareSensor, type HardwareType, HostedMode, HttpApi, type HttpApiMethods, type IAppApi, type IBackgroundWidgetOptions, type IDeviceApi, type IDialogApi, type IFileApi, type IGridRect, type ILogApi, type IMouseApi, type IPage, type IPageOptions, type IProcessApi, type ITrayApi, type IUserApi, type IWidgetDataApi, type IWidgetOptions, type IWidgetPackageApi, type IWidgetTheme, type IWindowSize, type InfoNotificationOption, type Language, type LanguageCode, LanguageMap, type LanguageTextMap, LanguageUtils, type LocalPackageUrlInfo, type LocationQuery, type LocationQueryRaw, type LocationQueryValue, type LocationQueryValueRaw, LogApi, type LogApiMethods, type MemData, type MemLayoutData, MenuApi, MenuApiEvent, type MenuApiMethods, type MetaInfo, type Metadata, MouseApi, MouseApiEvent, type MouseApiMethods, type NativeKeyboardEvent, type Node, type NormalizeOptions, NotificationApi, NotificationApiEvent, type NotificationApiMethods, type NotificationOption, NotificationSize, type NotificationType, type OsData, Page, type Point, type Position, ProcessApi, type ProcessApiMethods, type ProxyConfig, type ReadDirOptions, type Rectangle, type ReminderNotificationOption, type RemotePackageUrlInfo, type SaveWidgetOption, type SensorType, type SetPositionOptions, ShortcutApi, ShortcutApiEvent, type ShortcutApiMethods, type ShortcutDetails, type ShowMenuOption, type Size, type SmartData, SocialInfo, type SocialLink, type SocialType, StorageApi, type StorageApiMethods, StoreApi, type StoreApiMethods, SystemApi, SystemApiEvent, type SystemApiMethods, type SystemFile, ThemeMode, TrayApiEvent, type TrayWidgetOptions, UserApi, type UserData, type VersionData, WebSocketEvent, WebSocketEventType, Widget, WidgetApi, WidgetApiEvent, type WidgetApiMethods, WidgetData, WidgetDataApi, type WidgetDataApiMethods, WidgetKeyword, type WidgetMenuItem, WidgetPackage, WidgetPackageApi, WidgetPackageApiEvent, type WidgetPackageApiMethods, type WidgetPackageOptions, WidgetPackageUtils, WidgetParams, type WidgetPermission, type WidgetRoute, WidgetTheme, type WidgetThemeKey, type WidgetThemeProperty, WidgetUtils, delay, normalizeUrl, parseQuery, stringifyQuery };
+export { type AddWidgetOption, type AlignPosition, ApiConstants, AppApi, AppApiConstants, AppApiEvent, type AppApiMethods, AppConfig, AppEvent, type AppMouseEvent, AppNotification, AppReminderNotification, type AppRuntimeInfo, BackgroundWidget, BaseApi, type BatteryData, BroadcastApi, type BroadcastApiMethods, BroadcastEvent, type BroadcastEventType, BrowserWindowApi, BrowserWindowApiEvent, type BrowserWindowApiMethods, type BrowserWindowOptions, type CallNotificationOption, type Category, Channel, ClipboardApi, ClipboardApiEvent, type ClipboardApiMethods, type CountdownNotificationOption, type CpuCacheData, type CpuCurrentSpeedData, type CpuData, type CurrentLoadCpuData, type CurrentLoadData, DefaultWidgetTheme, DeployMode, DeployedPage, DeployedWidget, DeployedWidgetApi, type DeployedWidgetApiMethods, type DevOptions, DeviceApi, type DeviceApiMethods, DialogApi, type DialogApiMethods, type DiskLayoutData, type Display, type DownloadUrlOptions, ElectronApi, ElectronUtils, FileApi, type FileApiMethods, type GraphicsControllerData, type GraphicsData, type GraphicsDisplayData, Gravity, GridRect, GridSystem, type Hardware, type HardwareSensor, type HardwareType, HostedMode, HttpApi, type HttpApiMethods, type IAppApi, type IBackgroundWidgetOptions, type IDeviceApi, type IDialogApi, type IFileApi, type IGridRect, type ILogApi, type IMouseApi, type IPage, type IPageOptions, type IProcessApi, type ITrayApi, type IUserApi, type IWidgetDataApi, type IWidgetOptions, type IWidgetPackageApi, type IWidgetTheme, type IWindowSize, type InfoNotificationOption, type Language, type LanguageCode, LanguageMap, type LanguageTextMap, LanguageUtils, type LocalPackageUrlInfo, type LocationQuery, type LocationQueryRaw, type LocationQueryValue, type LocationQueryValueRaw, LogApi, type LogApiMethods, type MemData, type MemLayoutData, MenuApi, MenuApiEvent, type MenuApiMethods, type MetaInfo, type Metadata, MouseApi, MouseApiEvent, type MouseApiMethods, type NativeKeyboardEvent, type Node, type NormalizeOptions, NotificationApi, NotificationApiEvent, type NotificationApiMethods, type NotificationOption, NotificationSize, type NotificationType, type OsData, Page, type Point, type Position, ProcessApi, type ProcessApiMethods, type ProxyConfig, type ReadDirOptions, type Rectangle, type ReminderNotificationOption, type RemotePackageUrlInfo, type SaveWidgetOption, type SensorType, type SetPositionOptions, ShortcutApi, ShortcutApiEvent, type ShortcutApiMethods, type ShortcutDetails, type ShowMenuOption, type Size, type SmartData, SocialInfo, type SocialLink, type SocialType, StorageApi, type StorageApiMethods, StoreApi, type StoreApiMethods, SystemApi, SystemApiEvent, type SystemApiMethods, type SystemFile, ThemeMode, TrayApiEvent, type TrayWidgetOptions, UserApi, UserApiEvent, type UserApiMethods, type UserData, type VersionData, WebSocketEvent, WebSocketEventType, Widget, WidgetApi, WidgetApiEvent, type WidgetApiMethods, WidgetData, WidgetDataApi, type WidgetDataApiMethods, WidgetKeyword, type WidgetMenuItem, WidgetPackage, WidgetPackageApi, WidgetPackageApiEvent, type WidgetPackageApiMethods, type WidgetPackageOptions, WidgetPackageUtils, WidgetParams, type WidgetPermission, type WidgetRoute, type WidgetSyncInfo, WidgetTheme, type WidgetThemeKey, type WidgetThemeProperty, WidgetUtils, delay, normalizeUrl, parseQuery, stringifyQuery };