@widget-js/core 0.11.8 → 0.11.10

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { Config, CPUUsage, IOCounters, BlinkMemoryInfo, HeapStatistics, ProcessMemoryInfo, SystemMemoryInfo } from 'electron';
 import { FileTypeResult } from 'file-type';
-import { Metadata as Metadata$1, FormatEnum, ColourspaceEnum, Channels, LevelMetadata } from 'sharp';
+import { FormatEnum, ColourspaceEnum, Channels, LevelMetadata } from 'sharp';
 
 /**
  * @deprecated use DeployedMode instead
@@ -1513,58 +1513,6 @@ interface ILogApi {
 type LogApiMethods = keyof ILogApi;
 declare const LogApi: ILogApi;
 
-interface SystemFile {
-    isDir: boolean;
-    name: string;
-    absolutePath: string;
-    /**
-     * mine type
-     */
-    type: string;
-    children?: SystemFile[];
-    /**
-     * 上传后的ID
-     */
-    uploadId?: string;
-}
-interface ReadDirOptions {
-    ignoreDir?: boolean;
-    traverseDir?: boolean;
-}
-interface IFileApi {
-    readDirectory(path: string, options?: ReadDirOptions): Promise<SystemFile[]>;
-    isDirectory(filePath: string): Promise<boolean>;
-    getFileType(filePath: string): Promise<FileTypeResult>;
-    downloadUrl(url: string, savePath: string, fileName: string): Promise<string>;
-    exists(filePath: string): Promise<boolean>;
-    delete(filePath: string): Promise<boolean>;
-    /**
-     * @param childPath
-     * @example childPath = "/images/" will return "C:/Users/username/Documents/widgets/com/exmaple/widget/images"
-     * @return  folder relative to system user's documents folder
-     */
-    getDocumentFolder(childPath?: string): Promise<string>;
-    /**
-     *
-     * @param filePath
-     */
-    getPictureMetadata(filePath: string): Promise<Metadata$1>;
-    /**
-     * 移动文件
-     * @param form
-     * @param to
-     */
-    move(form: string, to: string): Promise<string>;
-    /**
-     * read file contents
-     * @param filePath
-     * @return base64 encoded string
-     */
-    readFile(filePath: string): Promise<string>;
-}
-type FileApiMethods = keyof IFileApi;
-declare const FileApi: IFileApi;
-
 interface Metadata {
     /** Number value of the EXIF Orientation header, if present */
     orientation?: number | undefined;
@@ -1620,4 +1568,67 @@ interface Metadata {
     formatMagick?: string | undefined;
 }
 
-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, 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 };
+interface SystemFile {
+    isDir: boolean;
+    name: string;
+    absolutePath: string;
+    /**
+     * mine type
+     */
+    type: string;
+    children?: SystemFile[];
+    /**
+     * 上传后的ID
+     */
+    uploadId?: string;
+}
+interface ReadDirOptions {
+    ignoreDir?: boolean;
+    traverseDir?: boolean;
+}
+interface DownloadUrlOptions {
+    url: string;
+    savePath: string;
+    fileName: string;
+    /**
+     * true - overwrite existing
+     * false - ignore
+     */
+    overwrite?: boolean;
+}
+interface IFileApi {
+    readDirectory(path: string, options?: ReadDirOptions): Promise<SystemFile[]>;
+    isDirectory(filePath: string): Promise<boolean>;
+    getFileType(filePath: string): Promise<FileTypeResult>;
+    downloadUrl(option: DownloadUrlOptions): Promise<string>;
+    exists(filePath: string): Promise<boolean>;
+    delete(filePath: string): Promise<boolean>;
+    /**
+     * @param childPath
+     * @example childPath = "/images/" will return "C:/Users/username/Documents/widgets/com/exmaple/widget/images"
+     * @see     https://sharp.pixelplumbing.com/api-input
+     * @return  folder relative to system user's documents folder
+     */
+    getDocumentFolder(childPath?: string): Promise<string>;
+    /**
+     *
+     * @param filePath absolute path
+     */
+    getPictureMetadata(filePath: string): Promise<Metadata>;
+    /**
+     * 移动文件
+     * @param form
+     * @param to
+     */
+    move(form: string, to: string): Promise<string>;
+    /**
+     * read file contents
+     * @param filePath
+     * @return base64 encoded string
+     */
+    readFile(filePath: string): Promise<string>;
+}
+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, 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 };

package/dist/index.js

@@ -2040,8 +2040,8 @@ var FileApiImpl = class extends BaseApi {
   delete(filePath) {
     return this.invokeMethod("delete", filePath);
   }
-  downloadUrl(url, savePath, fileName) {
-    return this.invokeMethod("downloadUrl", url, savePath, fileName);
+  downloadUrl(options) {
+    return this.invokeMethod("downloadUrl", options);
   }
   exists(filePath) {
     return this.invokeMethod("exists", filePath);