@widget-js/core 0.11.7 → 0.11.9

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 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
@@ -1512,6 +1513,61 @@ interface ILogApi {
 type LogApiMethods = keyof ILogApi;
 declare const LogApi: ILogApi;
 
+interface Metadata {
+    /** Number value of the EXIF Orientation header, if present */
+    orientation?: number | undefined;
+    /** Name of decoder used to decompress image data e.g. jpeg, png, webp, gif, svg */
+    format?: keyof FormatEnum | undefined;
+    /** Total size of image in bytes, for Stream and Buffer input only */
+    size?: number | undefined;
+    /** Number of pixels wide (EXIF orientation is not taken into consideration) */
+    width?: number | undefined;
+    /** Number of pixels high (EXIF orientation is not taken into consideration) */
+    height?: number | undefined;
+    /** Name of colour space interpretation */
+    space?: keyof ColourspaceEnum | undefined;
+    /** Number of bands e.g. 3 for sRGB, 4 for CMYK */
+    channels?: Channels | undefined;
+    /** Name of pixel depth format e.g. uchar, char, ushort, float ... */
+    depth?: string | undefined;
+    /** Number of pixels per inch (DPI), if present */
+    density?: number | undefined;
+    /** String containing JPEG chroma subsampling, 4:2:0 or 4:4:4 for RGB, 4:2:0:4 or 4:4:4:4 for CMYK */
+    chromaSubsampling: string;
+    /** Boolean indicating whether the image is interlaced using a progressive scan */
+    isProgressive?: boolean | undefined;
+    /** Number of pages/frames contained within the image, with support for TIFF, HEIF, PDF, animated GIF and animated WebP */
+    pages?: number | undefined;
+    /** Number of pixels high each page in a multi-page image will be. */
+    pageHeight?: number | undefined;
+    /** Number of times to loop an animated image, zero refers to a continuous loop. */
+    loop?: number | undefined;
+    /** Delay in ms between each page in an animated image, provided as an array of integers. */
+    delay?: number[] | undefined;
+    /**  Number of the primary page in a HEIF image */
+    pagePrimary?: number | undefined;
+    /** Boolean indicating the presence of an embedded ICC profile */
+    hasProfile?: boolean | undefined;
+    /** Boolean indicating the presence of an alpha transparency channel */
+    hasAlpha?: boolean | undefined;
+    /** The encoder used to compress an HEIF file, `av1` (AVIF) or `hevc` (HEIC) */
+    compression?: 'av1' | 'hevc';
+    /** Default background colour, if present, for PNG (bKGD) and GIF images, either an RGB Object or a single greyscale value */
+    background?: {
+        r: number;
+        g: number;
+        b: number;
+    } | number;
+    /** Details of each level in a multi-level image provided as an array of objects, requires libvips compiled with support for OpenSlide */
+    levels?: LevelMetadata[] | undefined;
+    /** Number of Sub Image File Directories in an OME-TIFF image */
+    subifds?: number | undefined;
+    /** The unit of resolution (density) */
+    resolutionUnit?: 'inch' | 'cm' | undefined;
+    /** String containing format for images loaded via *magick */
+    formatMagick?: string | undefined;
+}
+
 interface SystemFile {
     isDir: boolean;
     name: string;
@@ -1537,7 +1593,24 @@ interface IFileApi {
     downloadUrl(url: string, savePath: string, fileName: string): Promise<string>;
     exists(filePath: string): Promise<boolean>;
     delete(filePath: string): Promise<boolean>;
-    getDocumentFolder(filePath?: string): Promise<string>;
+    /**
+     * @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
@@ -1548,4 +1621,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, ElectronApi, ElectronUtils, FileApi, FileApiMethods, Gravity, GridRect, GridSystem, HostedMode, IGridRect, IPage, IPageOptions, IWidgetDataApi, IWidgetOptions, IWindowSize, LanguageCode, LanguageTextMap, LocalPackageUrlInfo, LocationQuery, LocationQueryRaw, LocationQueryValue, LocationQueryValueRaw, LogApi, LogApiMethods, MetaInfo, 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, 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 };

package/dist/index.js

@@ -2019,6 +2019,12 @@ var LogApi = new LogApiImpl();
 
 // src/api/FileApi.ts
 var FileApiImpl = class extends BaseApi {
+  getPictureMetadata(filePath) {
+    return this.invokeMethod("getPictureMetadata", filePath);
+  }
+  move(form, to) {
+    return this.invokeMethod("move", form, to);
+  }
   getFileType(filePath) {
     return this.invokeMethod("getFileType", filePath);
   }