electron-screenshots 0.3.2 → 0.4.2

package/README.md

@@ -80,11 +80,32 @@ module.exports = {
 
 ## Methods
 
-- `Lang`类型产考`react-screenshots`中的`Lang`类型
+- `Debugger`类型产考`debug`中的`Debugger`类型
 
 ```ts
-interface ScreenshotsOpts {
-  lang: Partial<Lang>
+export type LoggerFn = (...args: unknown[]) => void
+export type Logger = Debugger | LoggerFn
+
+export interface Lang {
+  magnifier_position_label?: string
+  operation_ok_title?: string
+  operation_cancel_title?: string
+  operation_save_title?: string
+  operation_redo_title?: string
+  operation_undo_title?: string
+  operation_mosaic_title?: string
+  operation_text_title?: string
+  operation_brush_title?: string
+  operation_arrow_title?: string
+  operation_ellipse_title?: string
+  operation_rectangle_title?: string
+}
+
+export interface ScreenshotsOpts {
+  lang?: Lang
+  // 调用日志，默认值为 debug('electron-screenshots')
+  // debug https://www.npmjs.com/package/debug
+  logger?: Logger
 }
 ```
 
@@ -93,7 +114,7 @@ interface ScreenshotsOpts {
 | `constructor(opts: ScreenshotsOpts)` | 调用截图方法截图 | -      |
 | `startCapture()`                     | 调用截图方法截图 | -      |
 | `endCapture() `                      | 手动结束截图     | -      |
-| `setLang(lang: Partial<Lang>)`       | 修改语言         | -      |
+| `setLang(lang: Lang)`                | 修改语言         | -      |
 
 ## Events
 
@@ -161,12 +182,12 @@ const screenshots = new Screenshots({
   }
 })
 
-screenshots.on('save', (e, buffer, bounds) => {
+screenshots.on('save', (e, buffer, data) => {
   // 阻止插件自带的保存功能
   // 用户自己控制保存功能
   e.preventDefault()
   // 用户可在这里自己定义保存功能
-  console.log('capture', buffer, bounds)
+  console.log('capture', buffer, data)
 })
 
 screenshots.startCapture()

package/lib/index.js

@@ -10,6 +10,13 @@ electron_1.app.whenReady().then(function () {
     var screenshots = new screenshots_1.default({
         lang: {
             operation_rectangle_title: '矩形2323'
+        },
+        logger: function () {
+            var args = [];
+            for (var _i = 0; _i < arguments.length; _i++) {
+                args[_i] = arguments[_i];
+            }
+            return console.log(args);
         }
     });
     electron_1.globalShortcut.register('ctrl+shift+a', function () {

package/lib/preload.d.ts

@@ -1,5 +1,10 @@
 import { Display } from './getBoundAndDisplay';
-import { Bounds } from 'react-screenshots';
+export interface Bounds {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
 export interface ScreenshotsData {
     bounds: Bounds;
     display: Display;

package/lib/screenshots.d.ts

@@ -1,14 +1,33 @@
 /// <reference types="node" />
-import { BrowserWindow, BrowserView } from 'electron';
+import { Debugger } from 'debug';
+import { BrowserView, BrowserWindow } from 'electron';
 import Events from 'events';
-import { Bounds, Lang } from 'react-screenshots';
+import { Bounds } from './preload';
+export declare type LoggerFn = (...args: unknown[]) => void;
+export declare type Logger = Debugger | LoggerFn;
+export interface Lang {
+    magnifier_position_label?: string;
+    operation_ok_title?: string;
+    operation_cancel_title?: string;
+    operation_save_title?: string;
+    operation_redo_title?: string;
+    operation_undo_title?: string;
+    operation_mosaic_title?: string;
+    operation_text_title?: string;
+    operation_brush_title?: string;
+    operation_arrow_title?: string;
+    operation_ellipse_title?: string;
+    operation_rectangle_title?: string;
+}
 export interface ScreenshotsOpts {
-    lang: Partial<Lang>;
+    lang?: Lang;
+    logger?: Logger;
 }
-export { Bounds, Lang };
+export { Bounds };
 export default class Screenshots extends Events {
     $win: BrowserWindow | null;
     $view: BrowserView;
+    private logger;
     private isReady;
     constructor(opts?: ScreenshotsOpts);
     /**

package/lib/screenshots.js

@@ -73,13 +73,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+var debug_1 = __importDefault(require("debug"));
 var electron_1 = require("electron");
-var promises_1 = __importDefault(require("fs/promises"));
-var event_1 = __importDefault(require("./event"));
 var events_1 = __importDefault(require("events"));
-var padStart_1 = __importDefault(require("./padStart"));
+var fs_extra_1 = __importDefault(require("fs-extra"));
+var event_1 = __importDefault(require("./event"));
 var getBoundAndDisplay_1 = __importDefault(require("./getBoundAndDisplay"));
-var logger_1 = __importDefault(require("./logger"));
+var padStart_1 = __importDefault(require("./padStart"));
 var Screenshots = /** @class */ (function (_super) {
     __extends(Screenshots, _super);
     function Screenshots(opts) {
@@ -96,10 +96,11 @@ var Screenshots = /** @class */ (function (_super) {
         });
         _this.isReady = new Promise(function (resolve) {
             electron_1.ipcMain.once('SCREENSHOTS:ready', function () {
-                (0, logger_1.default)('SCREENSHOTS:ready');
+                _this.logger('SCREENSHOTS:ready');
                 resolve();
             });
         });
+        _this.logger = (opts === null || opts === void 0 ? void 0 : opts.logger) || (0, debug_1.default)('electron-screenshots');
         _this.listenIpc();
         _this.$view.webContents.loadURL("file://".concat(require.resolve('react-screenshots/electron/electron.html')));
         if (opts === null || opts === void 0 ? void 0 : opts.lang) {
@@ -112,7 +113,7 @@ var Screenshots = /** @class */ (function (_super) {
      */
     Screenshots.prototype.startCapture = function () {
         var _this = this;
-        (0, logger_1.default)('startCapture');
+        this.logger('startCapture');
         this.isReady.then(function () {
             if (_this.$win && !_this.$win.isDestroyed()) {
                 _this.$win.close();
@@ -135,7 +136,7 @@ var Screenshots = /** @class */ (function (_super) {
      * 结束截图
      */
     Screenshots.prototype.endCapture = function () {
-        (0, logger_1.default)('endCapture');
+        this.logger('endCapture');
         if (!this.$win)
             return;
         this.$win.setSimpleFullScreen(false);
@@ -148,7 +149,7 @@ var Screenshots = /** @class */ (function (_super) {
     Screenshots.prototype.setLang = function (lang) {
         var _this = this;
         this.isReady.then(function () {
-            (0, logger_1.default)('setLang', lang);
+            _this.logger('setLang', lang);
             _this.$view.webContents.send('SCREENSHOTS:setLang', lang);
         });
     };
@@ -200,7 +201,7 @@ var Screenshots = /** @class */ (function (_super) {
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
-                        (0, logger_1.default)('SCREENSHOTS:capture');
+                        this.logger('SCREENSHOTS:capture');
                         _b.label = 1;
                     case 1:
                         _b.trys.push([1, 4, , 6]);
@@ -208,7 +209,7 @@ var Screenshots = /** @class */ (function (_super) {
                     case 2:
                         NodeScreenshots = (_b.sent()).Screenshots;
                         capturer = NodeScreenshots.fromDisplay(display.id);
-                        (0, logger_1.default)('SCREENSHOTS:NodeScreenshots.fromDisplay(%d) %o', display.id, capturer);
+                        this.logger('SCREENSHOTS:NodeScreenshots.fromDisplay(%d) %o', display.id, capturer);
                         if (!capturer) {
                             throw new Error("NodeScreenshots.fromDisplay(".concat(display.id, ") get null"));
                         }
@@ -219,7 +220,7 @@ var Screenshots = /** @class */ (function (_super) {
                         return [3 /*break*/, 6];
                     case 4:
                         err_1 = _b.sent();
-                        (0, logger_1.default)('SCREENSHOTS:capturer.capture() error %o', err_1);
+                        this.logger('SCREENSHOTS:capturer.capture() error %o', err_1);
                         return [4 /*yield*/, electron_1.desktopCapturer.getSources({
                                 types: ['screen'],
                                 thumbnailSize: {
@@ -261,10 +262,10 @@ var Screenshots = /** @class */ (function (_super) {
         /**
          * OK事件
          */
-        electron_1.ipcMain.on('SCREENSHOTS:ok', function (e, buffer, bounds) {
-            (0, logger_1.default)('SCREENSHOTS:ok', buffer, bounds);
+        electron_1.ipcMain.on('SCREENSHOTS:ok', function (e, buffer, data) {
+            _this.logger('SCREENSHOTS:ok', buffer, data);
             var event = new event_1.default();
-            _this.emit('ok', event, buffer, bounds);
+            _this.emit('ok', event, buffer, data);
             if (event.defaultPrevented) {
                 return;
             }
@@ -275,7 +276,7 @@ var Screenshots = /** @class */ (function (_super) {
          * CANCEL事件
          */
         electron_1.ipcMain.on('SCREENSHOTS:cancel', function () {
-            (0, logger_1.default)('SCREENSHOTS:cancel');
+            _this.logger('SCREENSHOTS:cancel');
             var event = new event_1.default();
             _this.emit('cancel', event);
             if (event.defaultPrevented) {
@@ -286,14 +287,14 @@ var Screenshots = /** @class */ (function (_super) {
         /**
          * SAVE事件
          */
-        electron_1.ipcMain.on('SCREENSHOTS:save', function (e, buffer, bounds) { return __awaiter(_this, void 0, void 0, function () {
+        electron_1.ipcMain.on('SCREENSHOTS:save', function (e, buffer, data) { return __awaiter(_this, void 0, void 0, function () {
             var event, time, year, month, date, hours, minutes, seconds, milliseconds, _a, canceled, filePath;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
-                        (0, logger_1.default)('SCREENSHOTS:save', buffer, bounds);
+                        this.logger('SCREENSHOTS:save', buffer, data);
                         event = new event_1.default();
-                        this.emit('save', event, buffer, bounds);
+                        this.emit('save', event, buffer, data);
                         if (event.defaultPrevented || !this.$win) {
                             return [2 /*return*/];
                         }
@@ -319,7 +320,7 @@ var Screenshots = /** @class */ (function (_super) {
                         if (canceled || !filePath) {
                             return [2 /*return*/];
                         }
-                        return [4 /*yield*/, promises_1.default.writeFile(filePath, buffer)];
+                        return [4 /*yield*/, fs_extra_1.default.writeFile(filePath, buffer)];
                     case 2:
                         _b.sent();
                         this.endCapture();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electron-screenshots",
-  "version": "0.3.2",
+  "version": "0.4.2",
   "description": "electron 截图插件",
   "types": "lib/screenshots.d.ts",
   "main": "lib/screenshots.js",
@@ -9,7 +9,7 @@
   ],
   "scripts": {
     "prepublishOnly": "npm run build",
-    "start": "cross-env DEBUG=screenshots electron lib/index.js",
+    "start": "cross-env DEBUG=electron-screenshots electron lib/index.js",
     "dev": "tsc --sourceMap --watch",
     "build": "npm run lint && npm run clean && tsc",
     "lint": "eslint . --ext .js,.ts --fix",
@@ -36,14 +36,16 @@
   },
   "dependencies": {
     "debug": "^4.3.3",
-    "node-screenshots": "^0.0.2",
-    "react-screenshots": "^0.3.1"
+    "fs-extra": "^10.1.0",
+    "node-screenshots": "^0.0.3",
+    "react-screenshots": "^0.4.0"
   },
   "peerDependencies": {
     "electron": ">=11"
   },
   "devDependencies": {
     "@types/debug": "^4.1.7",
+    "@types/fs-extra": "^9.0.13",
     "@typescript-eslint/eslint-plugin": "^5.10.0",
     "@typescript-eslint/parser": "^5.10.0",
     "cross-env": "^7.0.3",
@@ -57,5 +59,5 @@
     "rimraf": "^3.0.2",
     "typescript": "^4.5.5"
   },
-  "gitHead": "600c72efd111a7077640611c32f01c06443c7b8c"
+  "gitHead": "a518f3ba2a36ff0e116ebf90d180157b27a39fc3"
 }

package/lib/logger.d.ts

@@ -1,3 +0,0 @@
-import debug from 'debug';
-declare const _default: debug.Debugger;
-export default _default;

package/lib/logger.js

@@ -1,7 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var debug_1 = __importDefault(require("debug"));
-exports.default = (0, debug_1.default)('screenshots');