clickgo 4.0.0 → 4.0.1

package/dist/clickgo.d.ts

@@ -0,0 +1,128 @@
+/**
+ * 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.
+ * You may obtain a copy of the License at
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import * as lTool from './lib/tool';
+import * as lControl from './lib/control';
+import * as lCore from './lib/core';
+import * as lDom from './lib/dom';
+import * as lForm from './lib/form';
+import * as lFs from './lib/fs';
+import * as lNative from './lib/native';
+import * as lStorage from './lib/storage';
+import * as lTask from './lib/task';
+import * as lTheme from './lib/theme';
+import * as lZip from './lib/zip';
+import * as clickgo from './clickgo';
+/** --- 原生模块 --- */
+export declare const modules: {
+    'clickgo': typeof clickgo;
+    /** --- 原生 vue --- */
+    'vue': typeof import('vue');
+    /** --- 原生 jszip --- */
+    'jszip': typeof import('jszip');
+    /** --- 原生 tums-player 对象（在 default 里） --- */
+    'tums-player': lCore.ITumsPlayer;
+    /** --- 其他任何模块 --- */
+    [key: string]: any;
+};
+/** --- 获取当前版本 --- */
+export declare function getVersion(): string;
+/** --- 是否是 native 环境 --- */
+export declare function isNative(): boolean;
+/** --- 获取当前 ClickGo 所在的目录，不以 / 结尾 --- */
+export declare function getDirname(): string;
+/** --- 用户定义的全局对象 --- */
+export declare const global: any;
+/** --- 获取当前 cdn 前缀 --- */
+export declare function getCdn(): string;
+/** --- 获取当前平台（web 则只返回 web） --- */
+export declare function getPlatform(): NodeJS.Platform | 'web';
+declare let device: {
+    'type': 'unknown' | 'mobile' | 'desktop';
+    'os': 'unknown' | 'android' | 'ios' | 'windows' | 'macos' | 'linux';
+};
+/** --- 获取当前设备信息（支持 native 和 web） --- */
+export declare function getDevice(): typeof device;
+/**
+ * --- 是否含有窗体外边框 ---
+ */
+export declare function hasFrame(): boolean;
+/** --- 全局类 --- */
+export declare abstract class AbstractBoot {
+    /** --- 当前是否是 debug 模式 --- */
+    private readonly _debug;
+    /** --- 切勿传给 App --- */
+    protected _sysId: string;
+    setSysId(sysId: string): void;
+    /** --- 判断当前是否是 debug 模式 --- */
+    isDebug(): boolean;
+    constructor(opt?: {
+        'debug'?: boolean;
+    });
+    /** --- 入口方法 --- */
+    abstract main(): void | Promise<void>;
+    /** --- 全局错误事件 --- */
+    onError(taskId: string, formId: string, error: Error, info: string): void | Promise<void>;
+    /** --- 屏幕大小改变事件 --- */
+    onScreenResize(): void | Promise<void>;
+    /** --- 系统配置变更事件 --- */
+    onConfigChanged<T extends lCore.IConfig, TK extends keyof T>(n: TK, v: T[TK]): void | Promise<void>;
+    /** --- 窗体创建事件 --- */
+    onFormCreated(taskId: string, formId: string, title: string, icon: string, showInSystemTask: boolean): void | Promise<void>;
+    /** --- 窗体销毁事件 */
+    onFormRemoved(taskId: string, formId: string, title: string, icon: string): void | Promise<void>;
+    /** --- 窗体标题改变事件 */
+    onFormTitleChanged(taskId: string, formId: string, title: string): void | Promise<void>;
+    /** --- 窗体图标改变事件 --- */
+    onFormIconChanged(taskId: string, formId: string, icon: string): void | Promise<void>;
+    /** --- 窗体最小化状态改变事件 --- */
+    onFormStateMinChanged(taskId: string, formId: string, state: boolean): void | Promise<void>;
+    /** --- 窗体最大化状态改变事件 --- */
+    onFormStateMaxChanged(taskId: string, formId: string, state: boolean): void | Promise<void>;
+    /** --- 窗体显示状态改变事件 --- */
+    onFormShowChanged(taskId: string, formId: string, state: boolean): void | Promise<void>;
+    /** --- 窗体获得焦点事件 --- */
+    onFormFocused(taskId: string, formId: string): void | Promise<void>;
+    /** --- 窗体丢失焦点事件 --- */
+    onFormBlurred(taskId: string, formId: string): void | Promise<void>;
+    /** --- 窗体闪烁事件 --- */
+    onFormFlash(taskId: string, formId: string): void | Promise<void>;
+    /** --- 窗体是否显示在任务栏属性改变事件 --- */
+    onFormShowInSystemTaskChange(taskId: string, formId: string, value: boolean): void | Promise<void>;
+    /** --- 窗体的 formHash 改变事件 --- */
+    onFormHashChange(taskId: string, formId: string, value: string, data: Record<string, any>): void | Promise<void>;
+    /** --- 任务开始事件 --- */
+    onTaskStarted(taskId: string): void | Promise<void>;
+    /** --- 任务结束事件 --- */
+    onTaskEnded(taskId: string): void | Promise<void>;
+    /** --- launcher 文件夹名称修改事件 --- */
+    onLauncherFolderNameChanged(id: string, name: string): void | Promise<void>;
+    /** --- location hash 改变事件 --- */
+    onHashChanged(hash: string): void | Promise<void>;
+    /** --- 键盘按下事件 --- */
+    onKeydown(e: KeyboardEvent): void | Promise<void>;
+    /** --- 键盘弹起事件 --- */
+    onKeyup(e: KeyboardEvent): void | Promise<void>;
+    /** --- 环境文件准备加载时的事件 --- */
+    onRuntimeFileLoad(url: string): void | Promise<void>;
+    /** --- 环境文件加载完成的事件 --- */
+    onRuntimeFileLoaded(url: string, state: number): void | Promise<void>;
+}
+/**
+ * --- 启动 ClickGo ---
+ * @param boot 启动类
+ */
+export declare function launcher(boot: AbstractBoot): Promise<void>;
+export { lControl as control, lCore as core, lDom as dom, lForm as form, lFs as fs, lNative as native, lStorage as storage, lTask as task, lTheme as theme, lTool as tool, lZip as zip };