@talex-touch/utils 1.0.13 → 1.0.15

package/electron/touch-core.ts

@@ -0,0 +1,167 @@
+import { OpenDevToolsOptions } from "electron";
+
+export namespace TalexTouch {
+  export interface TouchApp {
+    app: Electron.App;
+    window: ITouchWindow;
+    version: AppVersion;
+    moduleManager: IModuleManager;
+    config: IConfiguration;
+    rootPath: string;
+  }
+
+  export enum AppVersion {
+    // ALPHA = "alpha",
+    // BETA = "beta",
+    DEV = "dev",
+    RELEASE = "release",
+  }
+
+  export interface ITouchWindow {
+    window: Electron.BrowserWindow;
+
+    /**
+     * Try to close the window. This has the same effect as a user manually clicking
+     * the close button of the window. The web page may cancel the close though. See
+     * the close event.
+     */
+    close(): void;
+
+    /**
+     * Minimizes the window. On some platforms the minimized window will be shown in
+     * the Dock.
+     */
+    minimize(): void;
+
+    /**
+     * Opens the devtools.
+     *
+     * When `contents` is a `<webview>` tag, the `mode` would be `detach` by default,
+     * explicitly passing an empty `mode` can force using last used dock state.
+     *
+     * On Windows, if Windows Control Overlay is enabled, Devtools will be opened with
+     * `mode: 'detach'`.
+     */
+    openDevTools(options?: OpenDevToolsOptions): void;
+
+    loadURL(
+      url: string,
+      options?: LoadURLOptions | undefined
+    ): Promise<Electron.WebContents>;
+    loadFile(
+      filePath: string,
+      options?: LoadFileOptions | undefined
+    ): Promise<Electron.WebContents>;
+  }
+
+  export type LoadFileOptions = Electron.LoadFileOptions & {
+    devtools?: boolean | "detach" | "left" | "right" | "bottom" | "undocked";
+  };
+  export type LoadURLOptions = Electron.LoadURLOptions & {
+    devtools?: boolean | "detach" | "left" | "right" | "bottom" | "undocked";
+  };
+
+  export interface IModuleManager {
+    /**
+     * Module Loader
+     * @param {TalexTouch.IModule} module
+     * @description This function will load the module with the given name.
+     * @returns {boolean} Returns true if the module is loaded successfully, otherwise returns false.
+     */
+    loadModule(module: IModule): boolean | Promise<boolean>;
+
+    /**
+     * Module Unloader
+     * @param {string}
+     * @description This function will unload the module with the given name.
+     * @description This function will also call the module's destroy function.
+     * @returns {boolean} Returns true if the module is unloaded successfully, otherwise returns false.
+     */
+    unloadModule(moduleName: Symbol): boolean | Promise<boolean>;
+
+    /**
+     * Module Getter
+     * @param {string}
+     * @description This function will return the module with the given name.
+     * @description If the module is not loaded, this function will return undefined.
+     */
+    getModule(moduleName: Symbol): IModule | undefined;
+
+    // TODO Next version preview
+    // /**
+    //  * Module register event listener
+    //  */
+    // registerEvent(moduleName: Symbol, eventName: string, callback: Function): void
+
+    // /**
+    //  * Module unregister event listener
+    //  */
+    // unregisterEvent(moduleName: Symbol, eventName: string, callback: Function): void
+
+    // /**
+    //  * Module emit event
+    //  */
+    // emitEvent(eventName: string, ...args: any[]): void
+  }
+
+  export interface IModule {
+    /**
+     * Module name
+     * @type {string}
+     * @description It's a unique name for each module, and it will be used to identify the module.
+     * @description It's also the name of the module's folder, which will be automatically created by the manager.
+     * @example "example-module"
+     */
+    name: Symbol;
+
+    /**
+     * Custom module file-path
+     * @type {string}
+     * @description If you want to load the module from a custom file-path, you can set this property.
+     * @description If this property is not set, the manager will load the module from the default file-path. (.../modules/{module-name})
+     */
+    filePath?: string | boolean;
+
+    /**
+     * Module Initialization
+     * @param {TalexTouch.TouchApp} app
+     * @param {TalexTouch.IModuleManager} manager
+     * @description This function will be called when the module is loaded.
+     * @description You can use this function to initialize your module.
+     * @description You can also use this function to register your module's event listeners.
+     */
+    init(
+      app: TalexTouch.TouchApp,
+      manager: TalexTouch.IModuleManager
+    ): void;
+
+    /**
+     * Module Destruction
+     * @param {TalexTouch.TouchApp} app
+     * @param {TalexTouch.IModuleManager} manager
+     * @description This function will be called when the module is unloaded.
+     * @description You can use this function to destroy your module.
+     * @description You can also use this function to unregister your module's event listeners.
+     * @description This function will be called when the app is closed.
+     */
+    destroy(
+      app: TalexTouch.TouchApp,
+      manager: TalexTouch.IModuleManager
+    ): void;
+  }
+
+  export interface IConfiguration {
+    configPath: string;
+    data: TouchAppConfig
+    triggerSave: Function
+  }
+
+  export interface TouchAppConfig {
+    frame: {
+      width: number;
+      height: number;
+      left?: number;
+      top?: number;
+    }
+  }
+}

package/electron/window.ts

@@ -0,0 +1,71 @@
+import gsap from 'gsap'
+TalexTouch.
+// 使用类型注释避免直接引用Electron命名空间
+interface ITouchWindow {
+  window: {
+    getSize(): [number, number];
+    getPosition(): [number, number];
+    setSize(width: number, height: number): void;
+    setPosition(x: number, y: number): void;
+  };
+}
+
+// 保存当前动画实例的引用，用于取消上次动画
+let currentTween: gsap.core.Tween | null = null
+
+/**
+ * 使用GSAP动画设置窗口高度的函数
+ * @param window TouchWindow对象
+ * @returns 返回一个可以更新窗口高度的方法
+ */
+export function useWindowHeight(window: ITouchWindow): {
+  updateHeight: (newHeight: number, duration?: number) => void
+} {
+  /**
+   * 更新窗口高度的方法
+   * @param newHeight 新的高度值
+   * @param duration 动画持续时间，默认为0.5秒
+   */
+  const updateHeight = (newHeight: number, duration: number = 0.5): void => {
+    // 如果存在上次的动画，先取消它
+    if (currentTween) {
+      currentTween.kill()
+    }
+
+    // 获取当前窗口的BrowserWindow实例
+    const browserWindow = window.window
+
+    // 获取当前窗口的位置和宽度
+    const [currentWidth, currentHeight] = browserWindow.getSize()
+    const [x, y] = browserWindow.getPosition()
+
+    // 使用GSAP创建动画
+    currentTween = gsap.to(
+      {
+        height: currentHeight
+      },
+      {
+        height: newHeight,
+        duration,
+        ease: 'cubic-bezier(0.785, 0.135, 0.15, 0.86)', // 使用指定的贝塞尔曲线
+        onUpdate: function () {
+          // 在动画更新时调整窗口大小
+          const animatedHeight = Math.round(this.targets()[0].height)
+          browserWindow.setSize(currentWidth, animatedHeight)
+          
+          // 保持窗口的顶部位置不变，只改变高度
+          browserWindow.setPosition(x, y)
+        },
+        onComplete: () => {
+          // 动画完成时，清除引用
+          currentTween = null
+        }
+      }
+    )
+  }
+
+  // 返回更新高度的方法
+  return {
+    updateHeight
+  }
+}

package/eventbus/index.ts

@@ -1,87 +1,86 @@
-export type EventHandler = (event: ITouchEvent) => void;
-
-export interface EventHandlerWrapper {
-  /**
-   * Event handler
-   */
-  handler: EventHandler;
-
-  /**
-   * Event type
-   * @see EventType
-   * @default EventType.PERSIST (must be, if implements)
-   */
-  type?: EventType;
-}
-
-export enum EventType {
-  PERSIST,
-  CONSUME,
-}
-
-export interface ITouchEvent<E = any> {
-  /**
-   * Event name
-   */
-  name: E;
-
-  /**
-   * Event data
-   */
-  data?: any;
-}
-
-export interface ITouchEventBus<E> {
-  map: Map<E, Set<EventHandlerWrapper>>;
-
-  /**
-   * Subscribe touch-app events (any kind of events extends from TouchEvent)
-   * @param event EventName (extends from TouchEvent)
-   * @param handler Event handler (extends from EventHandler)
-   * @returns true if the event was added, otherwise false
-   */
-  on(event: E, handler: EventHandler): boolean | void;
-
-  /**
-   * Subscribe touch-app events (any kind of events extends from TouchEvent)
-   * @param event EventName (extends from TouchEvent)
-   * @param handler Event handler (extends from EventHandler)
-   * @returns true if the event was added, otherwise false
-   */
-  once(event: E, handler: EventHandler): boolean | void;
-
-  /**
-   * UnSubscribe touch-app events (any kind of events extends from TouchEvent)
-   * @param event EventName (extends from TouchEvent)
-   * @param handler Event handler (extends from EventHandler)
-   * @returns true if the event was removed, otherwise false
-   * @example
-   * ```ts
-   * const handler = (event: TouchEvent) => {
-   *    console.log(event)
-   * }
-   */
-  off<T extends ITouchEvent>(event: E, handler: EventHandler): boolean;
-
-  /**
-   * UnSubscribe touch-app events all matched (any kind of events extends from TouchEvent)
-   * @param event EventName (extends from TouchEvent)
-   * @returns true if the event was added, otherwise false
-   */
-  offAll(event: E): boolean;
-
-  /**
-   * UnSubscribe touch-app events all matched (any kind of events extends from TouchEvent)
-   * @param event EventName (extends from TouchEvent)
-   * @param handler Event handler (extends from EventHandler)
-   * @returns true if the event was added, otherwise false
-   */
-  off<T extends ITouchEvent>(event: E, handler: EventHandler): boolean;
-
-  /**
-   * Emit touch-app events (any kind of events extends from TouchEvent)
-   * @param event EventName (extends from TouchEvent)
-   * @param data Event data (extends from TouchEvent)
-   */
-  emit<T extends ITouchEvent<E>>(event: E, data: T): void;
-}
+export type EventHandler = (event: ITouchEvent) => void;
+
+export interface EventHandlerWrapper {
+  /**
+   * Event handler
+   */
+  handler: EventHandler;
+
+  /**
+   * Event type
+   * @see EventType
+   * @default EventType.PERSIST (must be, if implements)
+   */
+  type?: EventType;
+}
+
+export enum EventType {
+  PERSIST,
+  CONSUME,
+}
+
+export interface ITouchEvent<E = any> {
+  /**
+   * Event name
+   */
+  name: E;
+
+  /**
+   * Event data
+   */
+  data?: any;
+}
+
+export interface ITouchEventBus<E> {
+  map: Map<E, Set<EventHandlerWrapper>>;
+
+  /**
+   * Subscribe touch-app events (any kind of events extends from TouchEvent)
+   * @param event EventName (extends from TouchEvent)
+   * @param handler Event handler (extends from EventHandler)
+   * @returns true if the event was added, otherwise false
+   */
+  on(event: E, handler: EventHandler): boolean | void;
+
+  /**
+   * Subscribe touch-app events (any kind of events extends from TouchEvent)
+   * @param event EventName (extends from TouchEvent)
+   * @param handler Event handler (extends from EventHandler)
+   * @returns true if the event was added, otherwise false
+   */
+  once(event: E, handler: EventHandler): boolean | void;
+
+  /**
+   * UnSubscribe touch-app events (any kind of events extends from TouchEvent)
+   * @param event EventName (extends from TouchEvent)
+   * @param handler Event handler (extends from EventHandler)
+   * @returns true if the event was removed, otherwise false
+   * @example
+   * ```ts
+   * const handler = (event: TouchEvent) => {
+   *    console.log(event)
+   * }
+   */
+  off(event: E, handler: EventHandler): boolean;
+
+  /**
+   * UnSubscribe touch-app events all matched (any kind of events extends from TouchEvent)
+   * @param event EventName (extends from TouchEvent)
+   * @returns true if the event was added, otherwise false
+   */
+  offAll(event: E): boolean;
+
+  /**
+   * UnSubscribe touch-app events all matched (any kind of events extends from TouchEvent)
+   * @param event EventName (extends from TouchEvent)
+   * @returns true if the event was added, otherwise false
+   */
+  offAll(event: E): boolean;
+
+  /**
+   * Emit touch-app events (any kind of events extends from TouchEvent)
+   * @param event EventName (extends from TouchEvent)
+   * @param data Event data (extends from TouchEvent)
+   */
+  emit<T extends ITouchEvent<E>>(event: E, data: T): void;
+}

package/index.ts

@@ -0,0 +1,5 @@
+export * from './base'
+export * from './common'
+export * from './plugin'
+export * from './core-box'
+export * from './channel'

package/package.json

@@ -1,30 +1,55 @@
-{
-  "main": "./index.ts",
-  "name": "@talex-touch/utils",
-  "author": "TalexDreamSoul",
-  "module": "./index.ts",
-  "license": "MPL-2.0",
-  "private": false,
-  "version": "1.0.13",
-  "scripts": {
-    "publish": "npm publish --access public"
-  },
-  "keywords": [
-    "vue",
-    "electron",
-    "talex-touch"
-  ],
-  "repository": {
-    "url": "https://github.com/talex-touch/talex-touch.git",
-    "type": "git"
-  },
-  "description": "TalexTouch series utils",
-  "dependencies": {
-    "path-browserify": "^1.0.1",
-    "vue": "^3.4.19"
-  },
-  "peerDependencies": {
-    "electron": "^24.4.0",
-    "vue": "^3.2.47"
-  }
-}
+{
+  "main": "index.ts",
+  "name": "@talex-touch/utils",
+  "author": "TalexDreamSoul",
+  "module": "./index.ts",
+  "license": "MPL-2.0",
+  "private": false,
+  "version": "1.0.15",
+  "exports": {
+    ".": "./index.ts",
+    "./channel": "./channel/index.ts",
+    "./base": "./base/index.ts",
+    "./common": "./common/index.ts",
+    "./common/utils": "./common/utils.ts",
+    "./plugin": "./plugin/index.ts",
+    "./plugin/log/logger-manager": "./plugin/log/logger-manager.ts",
+    "./plugin/log/logger": "./plugin/log/logger.ts",
+    "./plugin/sdk": "./plugin/sdk.ts",
+    "./plugin/sdk/window": "./plugin/sdk/window.ts",
+    "./core-box": "./core-box/index.ts",
+    "./search/types": "./search/types.ts",
+    "./eventbus": "./eventbus/index.ts",
+    "./permission": "./permission/index.ts",
+    "./renderer": "./renderer/index.ts",
+    "./renderer/ref": "./renderer/ref.ts",
+    "./renderer/slots": "./renderer/slots.ts",
+    "./renderer/storage/app-settings": "./renderer/storage/app-settings.ts",
+    "./service": "./service/index.ts",
+    "./service/protocol": "./service/protocol/index.ts",
+    "./electron/env-tool": "./electron/env-tool.ts",
+    "./electron/download-manager": "./electron/download-manager.ts"
+  },
+  "scripts": {
+    "publish": "npm publish --access public"
+  },
+  "keywords": [
+    "vue",
+    "electron",
+    "talex-touch"
+  ],
+  "repository": {
+    "url": "https://github.com/talex-touch/talex-touch.git",
+    "type": "git"
+  },
+  "description": "TalexTouch series utils",
+  "dependencies": {
+    "@vueuse/core": "^13.5.0",
+    "path-browserify": "^1.0.1",
+    "vue": "^3.5.18"
+  },
+  "peerDependencies": {
+    "electron": "^29.4.6",
+    "vue": "^3.5.15"
+  }
+}

package/permission/index.ts

@@ -1,49 +1,49 @@
-export interface Permission {
-  /**
-   * permission id
-   */
-  id: symbol;
-
-  /**
-   * permission name
-   */
-  name: string;
-
-  /**
-   * permission description
-   */
-  description: string;
-}
-
-export interface IPermissionCenter {
-  /**
-   * add a permission
-   * @param pluginScope plugin name
-   * @param permission permission
-   * @throws if permission already exists
-   */
-  addPermission(pluginScope: string, permission: Permission): void;
-
-  /**
-   * remove a permission
-   * @param pluginScope plugin name
-   * @param permission permission
-   * @throws if permission not exists
-   */
-  delPermission(pluginScope: string, permission: Permission): void;
-
-  /**
-   * if pluginScope has permission
-   * @param pluginScope plugin name
-   * @param permission permission
-   */
-  hasPermission(pluginScope: string, permission: Permission): boolean;
-
-  /**
-   * get permission
-   * @param pluginScope plugin name
-   * @param permission permission id
-   * @returns permission
-   */
-  getPermission(pluginScope: string, permission: symbol): Permission;
+export interface Permission {
+  /**
+   * permission id
+   */
+  id: symbol;
+
+  /**
+   * permission name
+   */
+  name: string;
+
+  /**
+   * permission description
+   */
+  description: string;
+}
+
+export interface IPermissionCenter {
+  /**
+   * add a permission
+   * @param pluginScope plugin name
+   * @param permission permission
+   * @throws if permission already exists
+   */
+  addPermission(pluginScope: string, permission: Permission): void;
+
+  /**
+   * remove a permission
+   * @param pluginScope plugin name
+   * @param permission permission
+   * @throws if permission not exists
+   */
+  delPermission(pluginScope: string, permission: Permission): void;
+
+  /**
+   * if pluginScope has permission
+   * @param pluginScope plugin name
+   * @param permission permission
+   */
+  hasPermission(pluginScope: string, permission: Permission): boolean;
+
+  /**
+   * get permission
+   * @param pluginScope plugin name
+   * @param permission permission id
+   * @returns permission
+   */
+  getPermission(pluginScope: string, permission: symbol): Permission;
 }