clickgo-native 0.0.19 → 1.0.1

package/dist/index.js

@@ -1,73 +1,23 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AbstractBoot = exports.tool = exports.fs = void 0;
-exports.launcher = launcher;
-exports.verifyToken = verifyToken;
-const electron = __importStar(require("electron"));
-const path = __importStar(require("path"));
-const libFs = __importStar(require("./lib/fs"));
-exports.fs = libFs;
-const libTool = __importStar(require("./lib/tool"));
-exports.tool = libTool;
-let isImmersion = false;
-let hasFrame = false;
+import * as electron from 'electron';
+import * as nodePath from 'path';
+import * as lFs from './lib/fs.js';
+import * as lTool from './lib/tool.js';
+// npm publish --tag dev --access public
+// --- sass --watch dist/:dist/ --style compressed --no-source-map ---
+/** --- 窗体是否含有 border 边框，有的话将不是沉浸式，也不会绑定任何窗体的大小的相关事件 --- */
+let hasFrame = true;
+/** --- 是否没有物理窗体时就主动退出软件（进程结束），如果不要窗体只有 node 的话，会用到 false 的情况 --- */
 let isNoFormQuit = true;
+/** --- 主窗体 --- */
 let form;
+/** --- 当前设定的通讯 token --- */
 let token = '';
+/** --- 当前系统平台 --- */
 const platform = process.platform;
+// const platform: NodeJS.Platform = 'darwin';
+/** --- 监听前台的执行的方法，内置的方法，用户可调用方法自行添加 --- */
 const methods = {
-    'cg-init': {
-        'once': true,
-        handler: function (t) {
-            if (!t || !form) {
-                return;
-            }
-            form.resizable = true;
-            token = t;
-        }
-    },
+    // --- 完全退出软件进程 ---
     'cg-quit': {
         'once': false,
         handler: function (t) {
@@ -80,10 +30,11 @@ const methods = {
             electron.app.quit();
         }
     },
+    // --- 设置实体窗体大小 ---
     'cg-set-size': {
         'once': false,
         handler: function (t, width, height) {
-            if (isImmersion || !form || !width || !height) {
+            if (!form || !width || !height) {
                 return;
             }
             if (!verifyToken(t)) {
@@ -93,6 +44,7 @@ const methods = {
             form.center();
         }
     },
+    // --- 设置窗体最大化、最小化、还原（从最大化还原） ---
     'cg-set-state': {
         'once': false,
         handler: function (t, state) {
@@ -111,12 +63,19 @@ const methods = {
                     form.minimize();
                     break;
                 }
-                default: {
+                case 'restore': {
+                    // --- 最小化还原 ---
                     form.restore();
+                    break;
+                }
+                default: {
+                    // --- 从最大化还原 ---
+                    form.unmaximize();
                 }
             }
         }
     },
+    // --- 激活窗体 ---
     'cg-activate': {
         'once': false,
         handler: function (t) {
@@ -135,6 +94,7 @@ const methods = {
             form.setAlwaysOnTop(false);
         },
     },
+    // --- 关闭窗体（可能软件进程不会被退出） ---
     'cg-close': {
         'once': false,
         handler: function (t) {
@@ -147,27 +107,11 @@ const methods = {
             form.close();
         }
     },
-    'cg-mouse-ignore': {
-        'once': false,
-        handler: function (t, val) {
-            if (!isImmersion || !form) {
-                return;
-            }
-            if (!verifyToken(t)) {
-                return;
-            }
-            if (val) {
-                form.setIgnoreMouseEvents(true, { 'forward': true });
-            }
-            else {
-                form.setIgnoreMouseEvents(false);
-            }
-        }
-    },
+    // --- 是否允许最大化 ---
     'cg-maximizable': {
         'once': false,
         handler: function (t, val) {
-            if (isImmersion || !form) {
+            if (!form) {
                 return;
             }
             if (!verifyToken(t)) {
@@ -176,156 +120,132 @@ const methods = {
             form.setMaximizable(val);
         }
     },
+    // --- fs 相关操作 ---
     'cg-fs-getContent': {
         'once': false,
-        handler: function (t, path, options) {
-            return __awaiter(this, void 0, void 0, function* () {
-                if (!verifyToken(t)) {
-                    return null;
-                }
-                return libFs.getContent(path, options);
-            });
+        handler: async function (t, path, options) {
+            if (!verifyToken(t)) {
+                return null;
+            }
+            return lFs.getContent(path, options);
         }
     },
     'cg-fs-putContent': {
         'once': false,
-        handler: function (t, path, data, options) {
-            return __awaiter(this, void 0, void 0, function* () {
-                if (!verifyToken(t)) {
-                    return false;
-                }
-                return exports.fs.putContent(path, data, options);
-            });
+        handler: async function (t, path, data, options) {
+            if (!verifyToken(t)) {
+                return false;
+            }
+            return lFs.putContent(path, data, options);
         }
     },
     'cg-fs-readLink': {
         'once': false,
-        handler: function (t, path, encoding) {
-            return __awaiter(this, void 0, void 0, function* () {
-                if (!verifyToken(t)) {
-                    return null;
-                }
-                return exports.fs.readLink(path, encoding);
-            });
+        handler: async function (t, path, encoding) {
+            if (!verifyToken(t)) {
+                return null;
+            }
+            return lFs.readLink(path, encoding);
         }
     },
     'cg-fs-symlink': {
         'once': false,
-        handler: function (t, filePath, linkPath, type) {
-            return __awaiter(this, void 0, void 0, function* () {
-                if (!verifyToken(t)) {
-                    return false;
-                }
-                return exports.fs.symlink(filePath, linkPath, type);
-            });
+        handler: async function (t, filePath, linkPath, type) {
+            if (!verifyToken(t)) {
+                return false;
+            }
+            return lFs.symlink(filePath, linkPath, type);
         }
     },
     'cg-fs-unlink': {
         'once': false,
-        handler: function (t, path) {
-            return __awaiter(this, void 0, void 0, function* () {
-                if (!verifyToken(t)) {
-                    return false;
-                }
-                return exports.fs.unlink(path);
-            });
+        handler: async function (t, path) {
+            if (!verifyToken(t)) {
+                return false;
+            }
+            return lFs.unlink(path);
         }
     },
     'cg-fs-stats': {
         'once': false,
-        handler: function (t, path) {
-            return __awaiter(this, void 0, void 0, function* () {
-                if (!verifyToken(t)) {
-                    return null;
-                }
-                return exports.fs.stats(path);
-            });
+        handler: async function (t, path) {
+            if (!verifyToken(t)) {
+                return null;
+            }
+            return lFs.stats(path);
         }
     },
     'cg-fs-mkdir': {
         'once': false,
-        handler: function (t, path, mode) {
-            return __awaiter(this, void 0, void 0, function* () {
-                if (!verifyToken(t)) {
-                    return false;
-                }
-                return exports.fs.mkdir(path, mode);
-            });
+        handler: async function (t, path, mode) {
+            if (!verifyToken(t)) {
+                return false;
+            }
+            return lFs.mkdir(path, mode);
         }
     },
     'cg-fs-rmdir': {
         'once': false,
-        handler: function (t, path) {
-            return __awaiter(this, void 0, void 0, function* () {
-                if (!verifyToken(t)) {
-                    return false;
-                }
-                return exports.fs.rmdir(path);
-            });
+        handler: async function (t, path) {
+            if (!verifyToken(t)) {
+                return false;
+            }
+            return lFs.rmdir(path);
         }
     },
     'cg-fs-chmod': {
         'once': false,
-        handler: function (t, path, mod) {
-            return __awaiter(this, void 0, void 0, function* () {
-                if (!verifyToken(t)) {
-                    return false;
-                }
-                return exports.fs.chmod(path, mod);
-            });
+        handler: async function (t, path, mod) {
+            if (!verifyToken(t)) {
+                return false;
+            }
+            return lFs.chmod(path, mod);
         }
     },
     'cg-fs-rename': {
         'once': false,
-        handler: function (t, oldPath, newPath) {
-            return __awaiter(this, void 0, void 0, function* () {
-                if (!verifyToken(t)) {
-                    return false;
-                }
-                return exports.fs.rename(oldPath, newPath);
-            });
+        handler: async function (t, oldPath, newPath) {
+            if (!verifyToken(t)) {
+                return false;
+            }
+            return lFs.rename(oldPath, newPath);
         }
     },
     'cg-fs-readDir': {
         'once': false,
-        handler: function (t, path, encoding) {
-            return __awaiter(this, void 0, void 0, function* () {
-                if (!verifyToken(t)) {
-                    return [];
-                }
-                return exports.fs.readDir(path, encoding);
-            });
+        handler: async function (t, path, encoding) {
+            if (!verifyToken(t)) {
+                return [];
+            }
+            return lFs.readDir(path, encoding);
         }
     },
     'cg-fs-copyFile': {
         'once': false,
-        handler: function (t, src, dest) {
-            return __awaiter(this, void 0, void 0, function* () {
-                if (!verifyToken(t)) {
-                    return false;
-                }
-                return exports.fs.copyFile(src, dest);
-            });
+        handler: async function (t, src, dest) {
+            if (!verifyToken(t)) {
+                return false;
+            }
+            return lFs.copyFile(src, dest);
         }
     },
+    // --- form ---
     'cg-form-open': {
         'once': false,
         handler: function (t, options = {}) {
-            var _a, _b, _c, _d, _e;
-            var _f, _g, _h;
             if (!t || !form) {
                 return null;
             }
             if (!verifyToken(t)) {
                 return null;
             }
-            (_a = options.filters) !== null && _a !== void 0 ? _a : (options.filters = []);
-            (_b = options.props) !== null && _b !== void 0 ? _b : (options.props = {});
-            (_c = (_f = options.props).file) !== null && _c !== void 0 ? _c : (_f.file = true);
-            (_d = (_g = options.props).directory) !== null && _d !== void 0 ? _d : (_g.directory = false);
-            (_e = (_h = options.props).multi) !== null && _e !== void 0 ? _e : (_h.multi = false);
+            options.filters ??= [];
+            options.props ??= {};
+            options.props.file ??= true;
+            options.props.directory ??= false;
+            options.props.multi ??= false;
             const paths = electron.dialog.showOpenDialogSync(form, {
-                'defaultPath': options.path ? exports.tool.formatPath(options.path) : undefined,
+                'defaultPath': options.path ? lTool.formatPath(options.path) : undefined,
                 'filters': options.filters.map((item) => {
                     return {
                         'name': item.name,
@@ -341,22 +261,21 @@ const methods = {
             if (!paths) {
                 return null;
             }
-            return paths.map(item => exports.tool.parsePath(item));
+            return paths.map(item => lTool.parsePath(item));
         }
     },
     'cg-form-save': {
         'once': false,
         handler: function (t, options = {}) {
-            var _a;
             if (!t || !form) {
                 return null;
             }
             if (!verifyToken(t)) {
                 return null;
             }
-            (_a = options.filters) !== null && _a !== void 0 ? _a : (options.filters = []);
+            options.filters ??= [];
             const path = electron.dialog.showSaveDialogSync(form, {
-                'defaultPath': options.path ? exports.tool.formatPath(options.path) : undefined,
+                'defaultPath': options.path ? lTool.formatPath(options.path) : undefined,
                 'filters': options.filters.map((item) => {
                     return {
                         'name': item.name,
@@ -367,13 +286,12 @@ const methods = {
             if (!path) {
                 return null;
             }
-            return exports.tool.parsePath(path);
+            return lTool.parsePath(path);
         }
     },
     'cg-form-dialog': {
         'once': false,
         handler: function (t, options = {}) {
-            var _a, _b;
             if (!t || !form) {
                 return -1;
             }
@@ -385,8 +303,8 @@ const methods = {
                     'message': options
                 };
             }
-            (_a = options.title) !== null && _a !== void 0 ? _a : (options.title = 'ClickGo');
-            (_b = options.message) !== null && _b !== void 0 ? _b : (options.message = '');
+            options.title ??= 'ClickGo';
+            options.message ??= '';
             return electron.dialog.showMessageBoxSync(form, {
                 'type': options.type,
                 'title': options.title,
@@ -396,93 +314,130 @@ const methods = {
             });
         }
     },
+    // --- 无需校验码 ---
+    // --- 测试与 native 的连通性 ---
     'cg-ping': {
         'once': false,
         handler: function (t) {
+            // --- t 不是 token，传过来什么就会传回去 ---
             return 'pong: ' + t;
         }
     },
+    // --- 判断窗体是否是最大化状态 ---
     'cg-is-max': {
         'once': false,
         handler: function () {
-            return (form === null || form === void 0 ? void 0 : form.isMaximized) ? true : false;
+            return form?.isMaximized() ? true : false;
         }
-    }
+    },
 };
-class AbstractBoot {
-    get isImmersion() {
-        return isImmersion;
-    }
+/** --- 全局类 --- */
+export class AbstractBoot {
+    /**
+     * --- 是否含有实体窗体边框和标题 ---
+     */
     get hasFrame() {
         return hasFrame;
     }
+    /**
+     * --- 没有实体窗体时整个实体进程是不是会被结束 ---
+     */
     get isNoFormQuit() {
         return isNoFormQuit;
     }
+    /**
+     * --- 当前系统代号 ---
+     */
     get platform() {
         return platform;
     }
+    /**
+     * --- 当前的通讯 token ---
+     */
     get token() {
         return token;
     }
+    /**
+     * --- 开始运行起来一个主实体窗体，整个进程本方法只能执行一次 ---
+     * @param path 实体窗体网页路径
+     * @param opt 参数
+     */
     run(path, opt = {}) {
         if (opt.frame !== undefined) {
+            // --- 默认 true ---
             hasFrame = opt.frame;
         }
         if (opt.quit !== undefined) {
+            // --- 默认 true ---
             isNoFormQuit = opt.quit;
         }
-        if (platform === 'win32') {
-            if (!hasFrame) {
-                isImmersion = true;
-            }
-        }
-        createForm(path);
-        if (form && opt.dev) {
-            form.webContents.openDevTools();
-        }
+        // --- 创建实体窗体 ---
+        showMainForm(path, {
+            'dev': opt.dev,
+            'width': opt.width,
+            'height': opt.height,
+            'max': opt.max,
+            'stateMax': opt.stateMax,
+            'background': opt.background,
+        });
+        // --- 监听所有实体窗体关闭事件 ---
         electron.app.on('window-all-closed', function () {
             if (isNoFormQuit) {
                 electron.app.quit();
+                return;
             }
+            form = undefined;
         });
+        // --- 软件被活动性激活的事件 ---
         electron.app.on('activate', function () {
             if (electron.BrowserWindow.getAllWindows().length > 0) {
                 return;
             }
-            createForm(path);
-            if (form && opt.dev) {
-                form.webContents.openDevTools();
-            }
-            methods['cg-init'] = {
-                'once': true,
-                handler: function (t) {
-                    if (!t || !form) {
-                        return;
-                    }
-                    form.resizable = true;
-                    token = t;
-                }
-            };
+            showMainForm(path, {
+                'dev': opt.dev,
+                'width': opt.width,
+                'height': opt.height,
+                'max': opt.max,
+                'stateMax': opt.stateMax,
+                'background': opt.background,
+            });
         });
     }
+    /**
+     * --- 绑定监听网页调用方法的方法 ---
+     * @param name 方法名
+     * @param handler 要执行的函数
+     * @param once 是否只执行一次
+     */
     on(name, handler, once = false) {
         methods[name] = {
             'once': once,
             'handler': handler
         };
     }
+    /**
+     * --- 绑定监听网页调用方法的方法但只会执行一次 ---
+     * @param name 方法名
+     * @param handler 要执行的函数
+     */
     once(name, handler) {
         this.on(name, handler, true);
     }
+    /**
+     * --- 解绑监听的方法 ---
+     * @param name 方法名
+     */
     off(name) {
         if (!methods[name]) {
             return;
         }
         delete methods[name];
     }
+    /**
+     * --- 显示一个 dialog ---
+     * @param opt 选项或者一段文字
+     */
     dialog(options = {}) {
-        var _a, _b;
         if (!form) {
             return -1;
         }
@@ -491,8 +446,8 @@ class AbstractBoot {
                 'message': options
             };
         }
-        (_a = options.title) !== null && _a !== void 0 ? _a : (options.title = 'ClickGo');
-        (_b = options.message) !== null && _b !== void 0 ? _b : (options.message = '');
+        options.title ??= 'ClickGo';
+        options.message ??= '';
         return electron.dialog.showMessageBoxSync(form, {
             'type': options.type,
             'title': options.title,
@@ -502,19 +457,61 @@ class AbstractBoot {
         });
     }
 }
-exports.AbstractBoot = AbstractBoot;
-function launcher(boot) {
-    (function () {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield electron.app.whenReady();
-            yield exports.fs.refreshDrives();
-            yield boot.main();
-        });
+/**
+ * --- 加载本地路径需要使用本函数加载 ---
+ * @param importUrl 传入 import.meta.url
+ * @param p 要加载的相对路径，如 ./index.html
+ */
+export function path(importUrl, p) {
+    let url = importUrl.replace('file:///', '');
+    const lio = url.lastIndexOf('/');
+    url = url.slice(0, lio + 1);
+    return nodePath.join(url, p);
+}
+export function showMainForm(path, opt = {}) {
+    if (form) {
+        // --- 有主窗体了就不能创建了 ---
+        return;
+    }
+    // --- 成功运行一个 task 后再次添加 init ---
+    methods['cg-init'] = {
+        'once': true,
+        handler: function (t) {
+            // --- t 是网页传来的 token ---
+            if (!t || !form) {
+                return;
+            }
+            form.resizable = true;
+            token = t;
+        },
+    };
+    const frm = createForm(path, {
+        'width': opt.width,
+        'height': opt.height,
+        'max': opt.max,
+        'stateMax': opt.stateMax,
+        'background': opt.background,
+    });
+    if (opt.dev) {
+        // --- 开发模式 ---
+        frm.webContents.openDevTools();
+    }
+}
+/** --- 用户调用运行 boot 类 --- */
+export function launcher(boot) {
+    (async function () {
+        // --- 等到 native 环境装载完毕 ---
+        await electron.app.whenReady();
+        await lFs.refreshDrives();
+        // --- 执行回调 ---
+        await boot.main();
     })().catch(function () {
         return;
     });
 }
+// --- 系统启动 ---
 electron.Menu.setApplicationMenu(null);
+// --- 实际用来监听网页传输过来的数据 ---
 electron.ipcMain.handle('pre', function (e, name, ...param) {
     if (!methods[name]) {
         return;
@@ -525,47 +522,60 @@ electron.ipcMain.handle('pre', function (e, name, ...param) {
     }
     return r;
 });
-function verifyToken(t) {
+/**
+ * --- 验证 token 是否正确 ---
+ * @param t 要验证的 token
+ */
+export function verifyToken(t) {
     if (t !== token) {
         return false;
     }
     return true;
 }
-function createForm(p) {
+/**
+ * --- 内部调用用来创建实体窗体的函数 ---
+ * @param p 窗体网页路径
+ */
+function createForm(p, opt = {}) {
+    let pre = new URL('./pre.js', import.meta.url).pathname.replace(/^\/(\w:)/, '$1');
     const op = {
         'webPreferences': {
             'nodeIntegration': false,
             'contextIsolation': true,
-            'preload': path.join(__dirname, '/pre.js'),
+            'preload': pre,
         },
-        'width': hasFrame ? 800 : 500,
-        'height': hasFrame ? 700 : 300,
+        'width': opt.width ?? (hasFrame ? 800 : 600),
+        'height': opt.height ?? (hasFrame ? 700 : 350),
         'frame': hasFrame,
         'resizable': false,
         'show': false,
         'center': true,
-        'transparent': isImmersion ? true : false,
+        'maximizable': opt.max ?? true,
+        'backgroundColor': opt.background ?? 'rgba(0, 0, 0, 1)',
+        'transparent': opt.transparent,
     };
     form = new electron.BrowserWindow(op);
-    form.webContents.userAgent = 'electron/' + electron.app.getVersion() + ' ' + platform + '/' + process.arch + ' immersion/' + (isImmersion ? '1' : '0') + ' frame/' + (hasFrame ? '1' : '0') + ' chrome/' + process.versions.chrome;
+    form.webContents.userAgent = 'electron/' + electron.app.getVersion() + ' ' + platform + '/' + process.arch + ' frame/' + (hasFrame ? '1' : '0') + ' chrome/' + process.versions.chrome;
     form.once('ready-to-show', function () {
         if (!form) {
             return;
         }
-        if (isImmersion) {
-            form.maximize();
-            form.setIgnoreMouseEvents(true, { 'forward': true });
-        }
-        else {
+        if (opt.background) {
+            form.setBackgroundColor(opt.transparent ? 'rgba(0, 0, 0, 0)' : 'rgba(0, 0, 0, 1)');
         }
         form.show();
+        if (opt.stateMax) {
+            form.maximize();
+        }
     });
     if (p.startsWith('https://') || p.startsWith('http://')) {
+        // --- 加载网页 ---
         form.loadURL(p).catch(function (e) {
             throw e;
         });
     }
     else {
+        // --- 加载本地文件 ---
         const lio = p.indexOf('?');
         const search = lio === -1 ? '' : p.slice(lio + 1);
         if (lio !== -1) {
@@ -580,10 +590,13 @@ function createForm(p) {
     form.on('close', function () {
         form = undefined;
     });
+    // --- 最大化事件 ---
     form.on('maximize', function () {
-        form === null || form === void 0 ? void 0 : form.webContents.executeJavaScript('if(window.clickgoNativeWeb){clickgoNativeWeb.invoke("maximize")}');
+        form?.webContents.executeJavaScript('if(window.clickgoNativeWeb){clickgoNativeWeb.invoke("maximize")}');
     });
+    // --- 最大化还原 ---
     form.on('unmaximize', function () {
-        form === null || form === void 0 ? void 0 : form.webContents.executeJavaScript('if(window.clickgoNativeWeb){clickgoNativeWeb.invoke("unmaximize")}');
+        form?.webContents.executeJavaScript('if(window.clickgoNativeWeb){clickgoNativeWeb.invoke("unmaximize")}');
     });
+    return form;
 }