@widget-js/core 0.1.6 → 0.1.9

package/dist/types/api/WidgetApi.d.ts

@@ -1,24 +1,30 @@
-import { Widget } from "../model/Widget";
-import { WidgetPackage } from "../model/WidgetPackage";
-export declare class WidgetApi {
-    static readonly REGISTER_WIDGETS = "register-widgets";
-    static readonly REGISTER_WIDGET_PACKAGE = "register-widget-package";
-    static readonly GET_WIDGETS = "get-widgets";
-    static readonly GET_WIDGET = "get-widget";
-    static readonly GET_WIDGET_PACKAGE = "get-widget-package";
-    static readonly GET_WIDGET_PACKAGES = "get-widget-packages";
-    static registerWidgets(widgets: Widget[]): Promise<void>;
-    static registerWidgetPackage(widgetPackage: WidgetPackage): Promise<void>;
-    static getWidgets(): Promise<Widget[]>;
-    static getWidgetPackages(): Promise<WidgetPackage>;
-    /**
-     *
-     * @param name package name
-     */
-    static getWidget(name: string): Promise<Widget>;
-    /**
-     *
-     * @param name package name
-     */
-    static getWidgetPackage(name: string): Promise<WidgetPackage>;
-}
+import { Widget } from "../model/Widget";
+import { WidgetPackage } from "../model/WidgetPackage";
+export declare class WidgetApi {
+    static readonly REGISTER_WIDGETS = "register-widgets";
+    static readonly REGISTER_WIDGET_PACKAGE = "register-widget-package";
+    static readonly GET_WIDGETS = "get-widgets";
+    static readonly GET_WIDGET = "get-widget";
+    static readonly GET_WIDGET_PACKAGE = "get-widget-package";
+    static readonly GET_WIDGET_PACKAGES = "get-widget-packages";
+    static readonly REMOVE_HOSTED_WIDGET = "remove-hosted-widget";
+    static registerWidgets(widgets: Widget[]): Promise<void>;
+    static registerWidgetPackage(widgetPackage: WidgetPackage): Promise<void>;
+    static getWidgets(): Promise<Widget[]>;
+    static getWidgetPackages(): Promise<WidgetPackage>;
+    /**
+     *
+     * @param name package name
+     */
+    static getWidget(name: string): Promise<Widget>;
+    /**
+     *
+     * @param name package name
+     */
+    static getWidgetPackage(name: string): Promise<WidgetPackage>;
+    /**
+     * 移除组件
+     * @param id
+     */
+    static removeHostedWidget(id: string): Promise<any>;
+}

package/dist/types/index.d.ts

@@ -1,18 +1,19 @@
-export * from "./model/Widget";
-export * from "./model/event/BroadcastEvent";
-export * from "./model/event/WebSocketEvent";
-export * from "./model/WidgetData";
-export * from "./model/WidgetParams";
-export * from "./model/Notification";
-export * from "./model/WidgetPackage";
-export * from "./api/ElectronApi";
-export * from "./repository/WidgetDataRepository";
-export * from "./api/BrowserWindowApi";
-export * from "./api/NotificationApi";
-export * from "./api/Channel";
-export * from "./api/WidgetApi";
-export * from "./api/ApiConstants";
-export * from "./api/BroadcastApi";
-export * from "./api/AppApi";
-export * from "./utils/ElectronUtils";
-export * from "./router/query";
+export * from "./model/Widget";
+export * from "./model/event/BroadcastEvent";
+export * from "./model/event/WebSocketEvent";
+export * from "./model/WidgetData";
+export * from "./model/WidgetParams";
+export * from "./model/Notification";
+export * from "./model/HostedMode";
+export * from "./model/WidgetPackage";
+export * from "./api/ElectronApi";
+export * from "./repository/WidgetDataRepository";
+export * from "./api/BrowserWindowApi";
+export * from "./api/NotificationApi";
+export * from "./api/Channel";
+export * from "./api/WidgetApi";
+export * from "./api/ApiConstants";
+export * from "./api/BroadcastApi";
+export * from "./api/AppApi";
+export * from "./utils/ElectronUtils";
+export * from "./router/query";

package/dist/types/model/HostedMode.d.ts

@@ -0,0 +1,10 @@
+export declare enum HostedMode {
+    NORMAL = 1,
+    /**
+     * 悬浮窗
+     */
+    OVERLAP = 16,
+    WALLPAPER = 256,
+    SCREEN = 4096,
+    ALL = 4369
+}

package/dist/types/model/Notification.d.ts

@@ -1,16 +1,16 @@
-export type NotificationType = "call" | "message" | "countdown" | "advance-countdown" | "error" | "success" | "warning" | "info";
-export type NotificationOption = {
-    type?: NotificationType;
-    title?: string;
-    message: string;
-    targetTime?: string;
-    duration?: number;
-};
-export declare class Notification {
-    type: NotificationType;
-    message: string;
-    title?: string;
-    targetTime?: string;
-    duration: number;
-    constructor(option: NotificationOption);
-}
+export type NotificationType = "call" | "message" | "countdown" | "advance-countdown" | "error" | "success" | "warning" | "info";
+export type NotificationOption = {
+    type?: NotificationType;
+    title?: string;
+    message: string;
+    targetTime?: string;
+    duration?: number;
+};
+export declare class Notification {
+    type: NotificationType;
+    message: string;
+    title?: string;
+    targetTime?: string;
+    duration: number;
+    constructor(option: NotificationOption);
+}

package/dist/types/model/SocialInfo.d.ts

@@ -1,6 +1,6 @@
-export type SocialInfoType = "qq" | "wechat" | "qq-group" | "discord" | "telegram" | "tiktok" | "douyin" | "youtube" | "instagram" | "twitter" | "facebook" | "kuaishou" | "bilibili" | "github" | "email" | "gitee" | "homepage";
-export declare class SocialInfo {
-    name: SocialInfoType;
-    content: string;
-    constructor(name: SocialInfoType, url: string);
-}
+export type SocialInfoType = "qq" | "wechat" | "qq-group" | "discord" | "telegram" | "tiktok" | "douyin" | "youtube" | "instagram" | "twitter" | "facebook" | "kuaishou" | "bilibili" | "github" | "email" | "gitee" | "homepage";
+export declare class SocialInfo {
+    name: SocialInfoType;
+    content: string;
+    constructor(name: SocialInfoType, url: string);
+}

package/dist/types/model/Widget.d.ts

@@ -1,85 +1,96 @@
-type WidgetOptions = {
-    name: string;
-    title: {
-        [key: string]: string;
-    };
-    description: {
-        [key: string]: string;
-    };
-    keywords: WidgetKeyword[];
-    lang: string;
-    width: number;
-    height: number;
-    maxWidth?: number;
-    maxHeight?: number;
-    minWidth?: number;
-    minHeight?: number;
-    url: string;
-    configUrl?: string;
-    packageName?: string;
-    extraUrl?: {
-        [key: string]: string;
-    };
-};
-export declare class Widget {
-    readonly name: string;
-    /**
-     * 组件标题，显示在界面上的，
-     * https://zh.m.wikipedia.org/zh-hans/ISO_639-1
-     */
-    readonly title: {
-        [key: string]: string;
-    };
-    /**
-     * 组件介绍
-     */
-    readonly description: {
-        [key: string]: string;
-    };
-    readonly keywords: WidgetKeyword[];
-    /**
-     * 组件默认语言
-     */
-    readonly lang: string;
-    readonly width: number;
-    packageName?: string | null;
-    readonly height: number;
-    readonly maxWidth: number;
-    readonly maxHeight: number;
-    readonly minWidth: number;
-    readonly minHeight: number;
-    readonly url: string;
-    readonly configUrl?: string | null;
-    /**
-     * 组件其他页面的url在这注册
-     */
-    readonly extraUrl: {
-        [key: string]: string;
-    };
-    constructor(options: WidgetOptions);
-    /**
-     * 获取组件标题
-     * @param lang 语言环境，不传则获取默认语言
-     */
-    getTitle(lang?: string): string | undefined;
-    /**
-     * 获取组件标描述
-     * @param lang 语言环境，不传则获取默认标题
-     */
-    getDescription(lang?: string): string | undefined;
-    static parseJSON(json: string): Widget;
-    static parseObject(obj: any): Widget;
-}
-export declare enum WidgetKeyword {
-    RECOMMEND = "recommend",
-    TOOLS = "tools",
-    EFFICIENCY = "efficiency",
-    PICTURE = "picture",
-    LIFE = "life",
-    SHORTCUT = "shortcut",
-    COUNTDOWN = "countdown",
-    TIMER = "timer",
-    INFO = "info",
-    DASHBOARD = "dashboard"
-}
-export {};
+import { HostedMode } from "./HostedMode";
+type WidgetOptions = {
+    name: string;
+    title: {
+        [key: string]: string;
+    };
+    description: {
+        [key: string]: string;
+    };
+    keywords: WidgetKeyword[];
+    lang: string;
+    width: number;
+    height: number;
+    maxWidth?: number;
+    maxHeight?: number;
+    minWidth?: number;
+    minHeight?: number;
+    url: string;
+    configUrl?: string;
+    packageName?: string;
+    extraUrl?: {
+        [key: string]: string;
+    };
+    supportHostedMode?: HostedMode;
+};
+export declare class Widget {
+    readonly name: string;
+    /**
+     * 组件标题，显示在界面上的，
+     * https://zh.m.wikipedia.org/zh-hans/ISO_639-1
+     */
+    readonly title: {
+        [key: string]: string;
+    };
+    /**
+     * 组件介绍
+     */
+    readonly description: {
+        [key: string]: string;
+    };
+    readonly keywords: WidgetKeyword[];
+    /**
+     * 组件默认语言
+     */
+    readonly lang: string;
+    readonly width: number;
+    packageName?: string | null;
+    readonly height: number;
+    readonly maxWidth: number;
+    readonly maxHeight: number;
+    readonly minWidth: number;
+    readonly minHeight: number;
+    readonly url: string;
+    readonly supportHostedMode: number;
+    readonly configUrl?: string | null;
+    /**
+     * 组件其他页面的url在这注册
+     */
+    readonly extraUrl: {
+        [key: string]: string;
+    };
+    constructor(options: WidgetOptions);
+    /**
+     * 获取组件标题
+     * @param lang 语言环境，不传则获取默认语言
+     */
+    getTitle(lang?: string): string | undefined;
+    /**
+     * 获取组件标描述
+     * @param lang 语言环境，不传则获取默认标题
+     */
+    getDescription(lang?: string): string | undefined;
+    static parseJSON(json: string): Widget;
+    static parseObject(obj: any): Widget;
+    /**
+     * 是否支持悬浮窗
+     */
+    isSupportOverlap(): boolean;
+    /**
+     * 是否支持普通模式
+     */
+    isSupportNormal(): boolean;
+}
+export declare enum WidgetKeyword {
+    RECOMMEND = "recommend",
+    TOOLS = "tools",
+    EFFICIENCY = "efficiency",
+    PICTURE = "picture",
+    LIFE = "life",
+    SHORTCUT = "shortcut",
+    COUNTDOWN = "countdown",
+    TIMER = "timer",
+    INFO = "info",
+    DASHBOARD = "dashboard"
+}
+export {};

package/dist/types/model/WidgetData.d.ts

@@ -1,35 +1,35 @@
-/**
- * 组件配置数据，用于存储组件自定义页面所设置的数据
- */
-export declare class WidgetData {
-    /**
-     * 组件id
-     */
-    id?: string;
-    /**
-     * 组件名
-     */
-    name: string;
-    /**
-     * 背景颜色
-     */
-    backgroundColor?: string;
-    /**
-     * 文字颜色
-     */
-    color?: string;
-    /**
-     * 字体大小
-     */
-    fontSize?: number;
-    /**
-     * 字体
-     */
-    fontFamily?: string;
-    /**
-     * 圆角半径
-     */
-    borderRadius?: number;
-    constructor(name: string, id?: string);
-    parseJSON(json: {}): void;
-}
+/**
+ * 组件配置数据，用于存储组件自定义页面所设置的数据
+ */
+export declare class WidgetData {
+    /**
+     * 组件id
+     */
+    id?: string;
+    /**
+     * 组件名
+     */
+    name: string;
+    /**
+     * 背景颜色
+     */
+    backgroundColor?: string;
+    /**
+     * 文字颜色
+     */
+    color?: string;
+    /**
+     * 字体大小
+     */
+    fontSize?: number;
+    /**
+     * 字体
+     */
+    fontFamily?: string;
+    /**
+     * 圆角半径
+     */
+    borderRadius?: number;
+    constructor(name: string, id?: string);
+    parseJSON(json: {}): void;
+}

package/dist/types/model/WidgetPackage.d.ts

@@ -1,41 +1,43 @@
-import { Widget } from "./Widget";
-export declare class WidgetPackage {
-    /**
-     * 组件名称,名称与包名类似，e.g. com.example.countdown
-     */
-    name: string;
-    /**
-     * 组件包版本
-     */
-    version: string;
-    /**
-     * 组件作者署名
-     */
-    author: string;
-    /**
-     * 组件首页
-     */
-    homepage: string;
-    /**
-     * 组件包介绍
-     */
-    /**
-     * 组件描述
-     */
-    description: {
-        [key: string]: string;
-    };
-    /**
-     * 组件入口文件，通常为 index.html
-     */
-    entry: string;
-    /**
-     * 测试时的url，如：http://127.0.0.1:8080/#/
-     */
-    debugUrl?: string;
-    /**
-     * 解压后的文件夹路径
-     */
-    folder?: string;
-    widgets: Widget[];
-}
+import { Widget } from "./Widget";
+export declare class WidgetPackage {
+    /**
+     * 组件包名,一般为域名倒置，e.g. com.example
+     */
+    name: string;
+    /**
+     * 组件包版本
+     */
+    version: string;
+    /**
+     * 组件作者署名
+     */
+    author: string;
+    /**
+     * 组件首页
+     */
+    homepage: string;
+    /**
+     * 组件包介绍
+     */
+    /**
+     * 组件描述
+     */
+    description: {
+        [key: string]: string;
+    };
+    /**
+     * 组件入口文件，通常为 index.html
+     */
+    entry: string;
+    /**
+     * 可能是网络地址，或者本地路径（解压后的文件夹路径）,
+     * 网络地址：https://www.bilibili.com
+     * 本地地址：file:///C:/Users/neo/Desktop
+     * 在测试时。地址通常为: http://127.0.0.1:8080
+     */
+    url: string;
+    widgets: Widget[];
+    static parseJSON(json: string): WidgetPackage;
+    static parseObject(obj: any): WidgetPackage;
+    getFullUrl(): string;
+}

package/dist/types/model/WidgetParams.d.ts

@@ -1,63 +1,60 @@
-export declare class WidgetParams {
-    static readonly PARAM_PREFIX = "w_";
-    static readonly PARAM_ID = "id";
-    static readonly PARAM_WIDTH = "width";
-    static readonly PARAM_HEIGHT = "height";
-    static readonly PARAM_WIDTH_PX = "width_px";
-    static readonly PARAM_HEIGHT_PX = "height_px";
-    static readonly PARAM_X = "x";
-    static readonly PARAM_Y = "y";
-    static readonly PARAM_LANG = "lang";
-    static readonly PARAM_THEME = "theme";
-    static readonly PARAM_MODE = "mode";
-    static readonly PARAM_RADIUS = "radius";
-    static readonly PARAM_NAME = "name";
-    static readonly PARAM_TITLE = "title";
-    static readonly PARAM_PREVIEW = "preview";
-    static readonly PARAMS: string[];
-    id?: string;
-    width?: number;
-    widthPx?: number;
-    heightPx?: number;
-    height?: number;
-    x?: number;
-    y?: number;
-    preview?: boolean;
-    lang?: string;
-    theme?: ThemeMode;
-    mode?: WidgetHostMode;
-    radius?: number;
-    name?: string;
-    title?: string;
-    /**
-     * 将组件参数转为url参数
-     * @param object
-     * @return URLSearchParams  w_w=2&w_h=2&w_id=21&w_width=156&w_height=156
-     */
-    toUrlParams(): URLSearchParams;
-    getPersistKey(): string;
-    /**
-     * 从当前地址解析组件参数：
-     * http://localhost:8080/#/widget/config/labor_progress?w_w=2&w_h=2&w_width=156&w_height=156
-     * =>
-     *  {width:2,height:2,id:21,width_px:156,height_px:156}
-     */
-    static fromCurrentLocation(): WidgetParams;
-    private static setValue;
-    /**
-     * 从对象键值对中初始化组件参数
-     * {w_width:2,w_height:2,w_id:21,w_width_px:156,w_height_px:156}=>
-     *  {width:2,height:2,id:21,width_px:156,height_px:156}
-     * @param object
-     */
-    static fromObject(object: any): WidgetParams;
-}
-export declare enum ThemeMode {
-    AUTO = "auto",
-    LIGHT = "LIGHT",
-    DARK = "DARK"
-}
-export declare enum WidgetHostMode {
-    DEFAULT = 0,
-    OVERLAP = 1
-}
+import { HostedMode } from "./HostedMode";
+export declare class WidgetParams {
+    static readonly PARAM_PREFIX = "w_";
+    static readonly PARAM_ID = "id";
+    static readonly PARAM_WIDTH = "width";
+    static readonly PARAM_HEIGHT = "height";
+    static readonly PARAM_WIDTH_PX = "width_px";
+    static readonly PARAM_HEIGHT_PX = "height_px";
+    static readonly PARAM_X = "x";
+    static readonly PARAM_Y = "y";
+    static readonly PARAM_LANG = "lang";
+    static readonly PARAM_THEME = "theme";
+    static readonly PARAM_MODE = "mode";
+    static readonly PARAM_RADIUS = "radius";
+    static readonly PARAM_NAME = "name";
+    static readonly PARAM_TITLE = "title";
+    static readonly PARAM_PREVIEW = "preview";
+    static readonly PARAMS: string[];
+    id?: string;
+    width?: number;
+    widthPx?: number;
+    heightPx?: number;
+    height?: number;
+    x?: number;
+    y?: number;
+    preview?: boolean;
+    lang?: string;
+    theme?: ThemeMode;
+    mode?: HostedMode;
+    radius?: number;
+    name?: string;
+    title?: string;
+    /**
+     * 将组件参数转为url参数
+     * @param object
+     * @return URLSearchParams  w_w=2&w_h=2&w_id=21&w_width=156&w_height=156
+     */
+    toUrlParams(): URLSearchParams;
+    getPersistKey(): string;
+    /**
+     * 从当前地址解析组件参数：
+     * http://localhost:8080/#/widget/config/labor_progress?w_w=2&w_h=2&w_width=156&w_height=156
+     * =>
+     *  {width:2,height:2,id:21,width_px:156,height_px:156}
+     */
+    static fromCurrentLocation(): WidgetParams;
+    private static setValue;
+    /**
+     * 从对象键值对中初始化组件参数
+     * {w_width:2,w_height:2,w_id:21,w_width_px:156,w_height_px:156}=>
+     *  {width:2,height:2,id:21,width_px:156,height_px:156}
+     * @param object
+     */
+    static fromObject(object: any): WidgetParams;
+}
+export declare enum ThemeMode {
+    AUTO = "auto",
+    LIGHT = "LIGHT",
+    DARK = "DARK"
+}

package/dist/types/model/event/BroadcastEvent.d.ts

@@ -1,12 +1,12 @@
-export declare class BroadcastEvent {
-    static readonly TYPE_WIDGET_UPDATED = "broadcast::cn.widgetjs.core.widget_updated";
-    static readonly TYPE_APP_CONFIG_UPDATED = "broadcast::cn.widgetjs.core.app_config_updated";
-    static readonly TYPE_THEME_CHANGED = "broadcast::cn.widgetjs.core.theme_changed";
-    type: string;
-    /**
-     * 发送人，一般为组件名，如：com.example.widgets.countdown
-     */
-    from: string;
-    payload: any;
-    constructor(type: string, from: string, payload: any);
-}
+export declare class BroadcastEvent {
+    static readonly TYPE_WIDGET_UPDATED = "broadcast::cn.widgetjs.core.widget_updated";
+    static readonly TYPE_APP_CONFIG_UPDATED = "broadcast::cn.widgetjs.core.app_config_updated";
+    static readonly TYPE_THEME_CHANGED = "broadcast::cn.widgetjs.core.theme_changed";
+    type: string;
+    /**
+     * 发送人，一般为组件名，如：com.example.widgets.countdown
+     */
+    from: string;
+    payload: any;
+    constructor(type: string, from: string, payload: any);
+}