clickgo-native 0.0.19 → 1.0.1

package/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2025 MAIYUN.NET
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -1,13 +1,20 @@
 # ClickGo Native
 
-<p align="center"><img src="dist/icon.png" width="100" height="100" alt="ClickGo Native"></p>
-
-[![npm version](https://img.shields.io/npm/v/clickgo-native.svg?colorB=brightgreen)](https://www.npmjs.com/package/clickgo-native "Stable Version")
-[![npm version](https://img.shields.io/npm/v/clickgo-native/dev.svg)](https://www.npmjs.com/package/clickgo-native "Development Version")
-[![License](https://img.shields.io/github/license/maiyun/clickgo-native.svg)](https://github.com/maiyun/clickgo-native/blob/master/LICENSE)
-[![GitHub issues](https://img.shields.io/github/issues/maiyun/clickgo-native.svg)](https://github.com/maiyun/clickgo-native/issues)
-[![GitHub Releases](https://img.shields.io/github/release/maiyun/clickgo-native.svg)](https://github.com/maiyun/clickgo-native/releases "Stable Release")
-[![GitHub Pre-Releases](https://img.shields.io/github/release/maiyun/clickgo-native/all.svg)](https://github.com/maiyun/clickgo-native/releases "Pre-Release")
+<p align="center"><img src="./dist/icon.png" width="100" height="100" alt="ClickGo Native"></p>
+<p align="center">
+    <a href="https://github.com/maiyun/clickgo-native/blob/master/LICENSE">
+        <img alt="License" src="https://img.shields.io/github/license/maiyun/clickgo-native?color=blue" />
+    </a>
+    <a href="https://www.npmjs.com/package/clickgo-native">
+        <img alt="NPM stable version" src="https://img.shields.io/npm/v/clickgo-native?color=brightgreen&logo=npm" />
+    </a>
+    <a href="https://github.com/maiyun/clickgo-native/releases">
+        <img alt="GitHub releases" src="https://img.shields.io/github/v/release/maiyun/clickgo-native?color=brightgreen&logo=github" />
+    </a>
+    <a href="https://github.com/maiyun/clickgo-native/issues">
+        <img alt="GitHub issues" src="https://img.shields.io/github/issues/maiyun/clickgo-native?color=blue&logo=github" />
+    </a>
+</p>
 
 The software developed with ClickGo will run in Windows, Mac OS, Linux.
 
@@ -19,12 +26,6 @@ You can install directly using NPM:
 $ npm i clickgo-native --save
 ```
 
-Or install the developing (unstable) version for newest features:
-
-```sh
-$ npm i clickgo-native@dev --save
-```
-
 **Node**
 
 ```typescript
@@ -41,10 +42,6 @@ native.launcher(new Boot());
 
 Clone and `npm run native`.
 
-## Changelog
-
-[Changelog](doc/CHANGELOG.md)
-
 ## License
 
 This library is published under [Apache-2.0](./LICENSE) license.

package/dist/index.d.ts

@@ -1,22 +1,68 @@
-import * as libFs from './lib/fs';
-export declare const fs: typeof libFs;
-import * as libTool from './lib/tool';
-export declare const tool: typeof libTool;
+/** --- 全局类 --- */
 export declare abstract class AbstractBoot {
-    get isImmersion(): boolean;
+    /**
+     * --- 是否含有实体窗体边框和标题 ---
+     */
     get hasFrame(): boolean;
+    /**
+     * --- 没有实体窗体时整个实体进程是不是会被结束 ---
+     */
     get isNoFormQuit(): boolean;
+    /**
+     * --- 当前系统代号 ---
+     */
     get platform(): NodeJS.Platform;
+    /**
+     * --- 当前的通讯 token ---
+     */
     get token(): string;
+    /** --- 入口方法 --- */
     abstract main(): void | Promise<void>;
+    /**
+     * --- 开始运行起来一个主实体窗体，整个进程本方法只能执行一次 ---
+     * @param path 实体窗体网页路径
+     * @param opt 参数
+     */
     run(path: string, opt?: {
+        /** --- 是否显示实体窗体边框和标题，默认 true --- */
         'frame'?: boolean;
+        /** --- 没有实体窗体时整个实体进程是不是会被结束，默认 true --- */
         'quit'?: boolean;
+        /** --- 是否是开发模式，默认 false --- */
         'dev'?: boolean;
+        /** --- 自定义宽度 --- */
+        'width'?: number;
+        /** --- 自定义高度 --- */
+        'height'?: number;
+        /** --- 是否有最大化按钮，默认 true --- */
+        'max'?: boolean;
+        /** --- 最大化状态，默认 false --- */
+        'stateMax'?: boolean;
+        /** --- 应用启动后、网页加载成功前显示的底色 --- */
+        'background'?: string;
     }): void;
+    /**
+     * --- 绑定监听网页调用方法的方法 ---
+     * @param name 方法名
+     * @param handler 要执行的函数
+     * @param once 是否只执行一次
+     */
     on(name: string, handler: (...param: any[]) => any | Promise<any>, once?: boolean): void;
+    /**
+     * --- 绑定监听网页调用方法的方法但只会执行一次 ---
+     * @param name 方法名
+     * @param handler 要执行的函数
+     */
     once(name: string, handler: (...param: any[]) => any | Promise<any>): void;
+    /**
+     * --- 解绑监听的方法 ---
+     * @param name 方法名
+     */
     off(name: string): void;
+    /**
+     * --- 显示一个 dialog ---
+     * @param opt 选项或者一段文字
+     */
     dialog(options?: string | {
         'type'?: 'info' | 'error' | 'question' | 'warning';
         'title'?: string;
@@ -25,5 +71,30 @@ export declare abstract class AbstractBoot {
         'buttons'?: string[];
     }): number;
 }
+/**
+ * --- 加载本地路径需要使用本函数加载 ---
+ * @param importUrl 传入 import.meta.url
+ * @param p 要加载的相对路径，如 ./index.html
+ */
+export declare function path(importUrl: string, p: string): string;
+export declare function showMainForm(path: string, opt?: {
+    /** --- 是否是开发模式，默认 false --- */
+    'dev'?: boolean;
+    /** --- 自定义宽度 --- */
+    'width'?: number;
+    /** --- 自定义高度 --- */
+    'height'?: number;
+    /** --- 是否有最大化按钮，默认 true --- */
+    'max'?: boolean;
+    /** --- 最大化状态，默认 false --- */
+    'stateMax'?: boolean;
+    /** --- 应用启动后、网页加载成功前显示的底色 --- */
+    'background'?: string;
+}): void;
+/** --- 用户调用运行 boot 类 --- */
 export declare function launcher(boot: AbstractBoot): void;
+/**
+ * --- 验证 token 是否正确 ---
+ * @param t 要验证的 token
+ */
 export declare function verifyToken(t: string): boolean;