@talex-touch/utils 1.0.31 → 1.0.33

package/types/modules/base.ts

@@ -2,13 +2,13 @@
  * Unique key for a module.
  * @public
  */
-export type ModuleKey = symbol;
+export type ModuleKey = symbol
 
 /**
  * Utility type representing a synchronous or asynchronous value.
  * @public
  */
-export type MaybePromise<T> = T | Promise<T>;
+export type MaybePromise<T> = T | Promise<T>
 
 /**
  * Declarative file/directory configuration for a module (input).
@@ -31,21 +31,21 @@ export interface ModuleFileConfig {
    *
    * @defaultValue false
    */
-  create?: boolean;
+  create?: boolean
 
   /**
    * Optional custom directory name (basename only, no slashes).
    *
    * @example "clipboard"
    */
-  dirName?: string;
+  dirName?: string
 
   /**
    * Optional absolute root path under which the module directory will be created.
    *
    * @example "/var/app/modules"
    */
-  root?: string;
+  root?: string
 }
 
 /**
@@ -66,17 +66,17 @@ export interface ResolvedModuleFileConfig {
   /**
    * Final boolean indicating if the module has a dedicated directory.
    */
-  create: boolean;
+  create: boolean
 
   /**
    * Final directory name (basename), if a directory is created.
    */
-  dirName?: string;
+  dirName?: string
 
   /**
    * Final absolute path to the module directory, if a directory is created.
    */
-  dirPath?: string;
+  dirPath?: string
 }
 
 /**
@@ -93,7 +93,7 @@ export interface ModuleDirectory {
   /**
    * Absolute path to the module directory.
    */
-  readonly path: string;
+  readonly path: string
 
   /**
    * Joins one or more path segments to the module directory path. Does not touch the filesystem.
@@ -101,24 +101,24 @@ export interface ModuleDirectory {
    * @param segments - One or more relative path segments.
    * @returns The combined absolute path string.
    */
-  join(...segments: string[]): string;
+  join: (...segments: string[]) => string
 
   /**
    * Ensures the directory exists, creating it if necessary.
    */
-  ensure(): MaybePromise<void>;
+  ensure: () => MaybePromise<void>
 
   /**
    * Checks whether the directory exists.
    */
-  exists(): MaybePromise<boolean>;
+  exists: () => MaybePromise<boolean>
 
   /**
    * Lists entries in the directory (filenames/subdirectory names).
    *
    * @returns An array of entry names (not absolute paths).
    */
-  list(): MaybePromise<string[]>;
+  list: () => MaybePromise<string[]>
 
   /**
    * Reads a file within the module directory.
@@ -126,7 +126,7 @@ export interface ModuleDirectory {
    * @param relativePath - Path relative to the module directory.
    * @returns File contents as a Buffer or string (implementation-dependent).
    */
-  readFile(relativePath: string): MaybePromise<Buffer | string>;
+  readFile: (relativePath: string) => MaybePromise<Buffer | string>
 
   /**
    * Writes a file within the module directory, creating parent folders if needed.
@@ -134,7 +134,7 @@ export interface ModuleDirectory {
    * @param relativePath - Path relative to the module directory.
    * @param data - File content.
    */
-  writeFile(relativePath: string, data: string | Uint8Array): MaybePromise<void>;
+  writeFile: (relativePath: string, data: string | Uint8Array) => MaybePromise<void>
 
   /**
    * Removes a file or subdirectory within the module directory.
@@ -142,5 +142,5 @@ export interface ModuleDirectory {
    * @param relativePath - Path relative to the module directory. If omitted, implementations
    * may remove the entire directory (use with caution).
    */
-  remove(relativePath?: string): MaybePromise<void>;
+  remove: (relativePath?: string) => MaybePromise<void>
 }

package/types/modules/index.ts

@@ -1,4 +1,4 @@
 export * from './base'
-export * from './module-lifecycle'
 export * from './module'
+export * from './module-lifecycle'
 export * from './module-manager'

package/types/modules/module-lifecycle.ts

@@ -1,7 +1,7 @@
-import { ITouchEventBus } from "../../eventbus";
-import { ModuleKey } from ".";
-import { TalexTouch } from "../touch-app-core";
-import { ModuleDirectory, ResolvedModuleFileConfig } from "./base";
+import type { ModuleKey } from '.'
+import type { ITouchEventBus } from '../../eventbus'
+import type { TalexTouch } from '../touch-app-core'
+import type { ModuleDirectory, ResolvedModuleFileConfig } from './base'
 
 /**
  * Base context available to all lifecycle phases.
@@ -13,17 +13,17 @@ export interface ModuleBaseContext<E> {
   /**
    * The application root object (TalexTouch).
    */
-  app: TalexTouch.TouchApp;
+  app: TalexTouch.TouchApp
 
   /**
    * The module manager controlling creation, lifecycle, and lookup.
    */
-  manager: TalexTouch.IModuleManager<E>;
+  manager: TalexTouch.IModuleManager<E>
 
   /**
    * The unique key for the current module (same as the module's `name`).
    */
-  moduleKey: ModuleKey;
+  moduleKey: ModuleKey
 
   /**
    * Optional configuration accessor bound to the application or module.
@@ -31,12 +31,12 @@ export interface ModuleBaseContext<E> {
    * @param key - Configuration key.
    * @returns The typed configuration value.
    */
-  config?<T = unknown>(key: string): T;
+  config?: <T = unknown>(key: string) => T
 
   /**
    * Optional event bus bound to the application or module layer.
    */
-  events?: ITouchEventBus<E>;
+  events?: ITouchEventBus<E>
 
   /**
    * The module's directory instance if a directory was created; otherwise `undefined`.
@@ -44,7 +44,7 @@ export interface ModuleBaseContext<E> {
    * @remarks
    * **Single-directory rule**: Each module can expose at most one `ModuleDirectory` instance here.
    */
-  directory?: ModuleDirectory;
+  directory?: ModuleDirectory
 }
 
 /**
@@ -57,18 +57,18 @@ export interface ModuleCreateContext<E> extends ModuleBaseContext<E> {
   /**
    * Resolved file/directory configuration for the module.
    */
-  file: ResolvedModuleFileConfig;
+  file: ResolvedModuleFileConfig
 
   /**
    * Fully resolved module entry file path if a custom path was provided,
    * or a default path computed by the manager; otherwise `undefined`.
    */
-  resolvedPath?: string;
+  resolvedPath?: string
 
   /**
    * Indicates whether this load is part of a hot-reload/replace cycle.
    */
-  hot?: boolean;
+  hot?: boolean
 }
 
 /**
@@ -81,12 +81,12 @@ export interface ModuleInitContext<E> extends ModuleBaseContext<E> {
   /**
    * Optional hint that dependencies have been verified and are ready.
    */
-  depsReady?: boolean;
+  depsReady?: boolean
 
   /**
    * Resolved file/directory configuration for the module.
    */
-  file: ResolvedModuleFileConfig;
+  file: ResolvedModuleFileConfig
 }
 
 /**
@@ -99,12 +99,12 @@ export interface ModuleStartContext<E> extends ModuleBaseContext<E> {
   /**
    * Optional startup arguments or mode flags.
    */
-  startArgs?: Record<string, unknown>;
+  startArgs?: Record<string, unknown>
 
   /**
    * Resolved file/directory configuration for the module.
    */
-  file: ResolvedModuleFileConfig;
+  file: ResolvedModuleFileConfig
 }
 
 /**
@@ -121,12 +121,12 @@ export interface ModuleStopContext<E> extends ModuleBaseContext<E> {
    * - `"hot-reload"`: Stop as part of a hot reload / replacement cycle.
    * - `string`: Custom reason.
    */
-  reason?: "normal" | "error" | "hot-reload" | string;
+  reason?: 'normal' | 'error' | 'hot-reload' | string
 
   /**
    * Resolved file/directory configuration for the module.
    */
-  file: ResolvedModuleFileConfig;
+  file: ResolvedModuleFileConfig
 }
 
 /**
@@ -139,10 +139,10 @@ export interface ModuleDestroyContext<E> extends ModuleBaseContext<E> {
   /**
    * Indicates the module is being destroyed as part of application shutdown.
    */
-  appClosing?: boolean;
+  appClosing?: boolean
 
   /**
    * Resolved file/directory configuration for the module.
    */
-  file: ResolvedModuleFileConfig;
+  file: ResolvedModuleFileConfig
 }

package/types/modules/module-manager.ts

@@ -1,6 +1,6 @@
-import { MaybePromise, ModuleDirectory, ModuleFileConfig, ModuleKey, ResolvedModuleFileConfig } from "./base";
-import { IBaseModule, ModuleCtor, ModuleRegistrant } from "./module";
-import { ModuleStopContext } from "./module-lifecycle";
+import type { MaybePromise, ModuleDirectory, ModuleFileConfig, ModuleKey, ResolvedModuleFileConfig } from './base'
+import type { IBaseModule, ModuleCtor, ModuleRegistrant } from './module'
+import type { ModuleStopContext } from './module-lifecycle'
 
 /**
  * Interface of the Module Manager.
@@ -32,7 +32,7 @@ export interface IBaseModuleManager<E = any> {
    * - If an instance is provided, step (2) is skipped; the same lifecycle calls apply.
    * - The manager must preserve **singleton semantics** per {@link ModuleKey}.
    */
-  loadModule<T extends IBaseModule<E>>(module: ModuleRegistrant<T, E>): boolean | Promise<boolean>;
+  loadModule: <T extends IBaseModule<E>>(module: ModuleRegistrant<T, E>) => boolean | Promise<boolean>
 
   /**
    * Unloads a module by key.
@@ -45,7 +45,7 @@ export interface IBaseModuleManager<E = any> {
    * The manager should invoke `stop?()` (with a `ModuleStopContext`) followed by `destroy()`
    * (with a `ModuleDestroyContext`), then remove the singleton instance.
    */
-  unloadModule(moduleKey: ModuleKey, reason?: ModuleStopContext<E>["reason"]): boolean | Promise<boolean>;
+  unloadModule: (moduleKey: ModuleKey, reason?: ModuleStopContext<E>['reason']) => boolean | Promise<boolean>
 
   /**
    * Retrieves a module instance by key.
@@ -54,7 +54,7 @@ export interface IBaseModuleManager<E = any> {
    * @param moduleKey - The unique key of the module.
    * @returns The module instance if loaded; otherwise `undefined`.
    */
-  getModule<T extends IBaseModule<E> = IBaseModule<E>>(moduleKey: ModuleKey): T | undefined;
+  getModule: <T extends IBaseModule<E> = IBaseModule<E>>(moduleKey: ModuleKey) => T | undefined
 
   /**
    * Optional class-based getter for stronger typing.
@@ -63,17 +63,17 @@ export interface IBaseModuleManager<E = any> {
    * @param ctor - The module class used at registration time (or a class with the same static `key`).
    * @returns The module instance if loaded; otherwise `undefined`.
    */
-  get<T extends IBaseModule<E>>(ctor: ModuleCtor<T, E>): T | undefined;
+  get: <T extends IBaseModule<E>>(ctor: ModuleCtor<T, E>) => T | undefined
 
   /**
    * Returns whether a module is currently loaded.
    */
-  hasModule(moduleKey: ModuleKey): boolean;
+  hasModule: (moduleKey: ModuleKey) => boolean
 
   /**
    * Lists keys of all currently loaded modules.
    */
-  listModules(): readonly ModuleKey[];
+  listModules: () => readonly ModuleKey[]
 }
 
 /**
@@ -89,11 +89,11 @@ export interface IModuleDirectoryService {
   /**
    * Resolves a {@link ModuleFileConfig} to {@link ResolvedModuleFileConfig} without creating anything.
    */
-  resolve(moduleKey: ModuleKey, input?: ModuleFileConfig): ResolvedModuleFileConfig;
+  resolve: (moduleKey: ModuleKey, input?: ModuleFileConfig) => ResolvedModuleFileConfig
 
   /**
    * Creates (or returns) the single {@link ModuleDirectory} for a module if configured to `create: true`.
    * If `create !== true`, implementations should return `undefined`.
    */
-  ensure(moduleKey: ModuleKey, input?: ModuleFileConfig): MaybePromise<ModuleDirectory | undefined>;
+  ensure: (moduleKey: ModuleKey, input?: ModuleFileConfig) => MaybePromise<ModuleDirectory | undefined>
 }

package/types/modules/module.ts

@@ -1,5 +1,5 @@
-import { MaybePromise, ModuleFileConfig, ModuleKey } from "./base";
-import { ModuleCreateContext, ModuleDestroyContext, ModuleInitContext, ModuleStartContext, ModuleStopContext } from "./module-lifecycle";
+import type { MaybePromise, ModuleFileConfig, ModuleKey } from './base'
+import type { ModuleCreateContext, ModuleDestroyContext, ModuleInitContext, ModuleStartContext, ModuleStopContext } from './module-lifecycle'
 
 /**
  * Contract that every module must implement.
@@ -19,7 +19,7 @@ export interface IBaseModule<E = any> {
   /**
    * Unique module key. Prefer `Symbol.for("your-module")` for global uniqueness.
    */
-  name: ModuleKey;
+  name: ModuleKey
 
   /**
    * Optional custom module entry file path.
@@ -28,7 +28,7 @@ export interface IBaseModule<E = any> {
    * If omitted, the manager can resolve a default location (e.g., inside the module's directory
    * when one exists, or from an app-level modules root).
    */
-  filePath?: string;
+  filePath?: string
 
   /**
    * Declarative directory configuration for this module.
@@ -38,33 +38,33 @@ export interface IBaseModule<E = any> {
    *   expose a `ModuleDirectory` on all lifecycle contexts.
    * - If `file.create !== true`, no directory will be created and `context.directory` will be `undefined`.
    */
-  file?: ModuleFileConfig;
+  file?: ModuleFileConfig
 
   /**
    * Optional hook invoked after construction/registration and before `init`.
    * Use this for last-moment wiring that depends on resolved paths or file config.
    */
-  created?(ctx: ModuleCreateContext<E>): MaybePromise<void>;
+  created?: (ctx: ModuleCreateContext<E>) => MaybePromise<void>
 
   /**
    * Called to perform resource preparation and subscription wiring.
    */
-  init(ctx: ModuleInitContext<E>): MaybePromise<void>;
+  init: (ctx: ModuleInitContext<E>) => MaybePromise<void>
 
   /**
    * Called when the module should start its active work.
    */
-  start?(ctx: ModuleStartContext<E>): MaybePromise<void>;
+  start?: (ctx: ModuleStartContext<E>) => MaybePromise<void>
 
   /**
    * Called when the module should leave the active state but may still keep allocated resources.
    */
-  stop?(ctx: ModuleStopContext<E>): MaybePromise<void>;
+  stop?: (ctx: ModuleStopContext<E>) => MaybePromise<void>
 
   /**
    * Called to perform final teardown and resource release.
    */
-  destroy(ctx: ModuleDestroyContext<E>): MaybePromise<void>;
+  destroy: (ctx: ModuleDestroyContext<E>) => MaybePromise<void>
 }
 
 /**
@@ -81,19 +81,19 @@ export interface IBaseModule<E = any> {
  * @public
  */
 export interface ModuleCtor<T extends IBaseModule<E>, E = any> {
-  new (ctx: ModuleCreateContext<E>): T;
+  new (ctx: ModuleCreateContext<E>): T
 
   /**
    * Optional class-level unique key.
    * If omitted, the instance {@link IModule.name | name} must be used as the key.
    */
-  readonly key?: ModuleKey;
+  readonly key?: ModuleKey
 
   /**
    * Optional declarative dependencies expressed as other module keys.
    * Useful if the manager performs topological ordering.
    */
-  readonly requires?: readonly ModuleKey[];
+  readonly requires?: readonly ModuleKey[]
 }
 
 /**
@@ -107,6 +107,6 @@ export interface ModuleCtor<T extends IBaseModule<E>, E = any> {
  *
  * @public
  */
-export type ModuleRegistrant<T extends IBaseModule<E>, E = any> =
-  | T
-  | ModuleCtor<T, E>;
+export type ModuleRegistrant<T extends IBaseModule<E>, E = any>
+  = | T
+    | ModuleCtor<T, E>

package/types/storage.ts

@@ -53,4 +53,3 @@ export interface FileDetails {
   /** Whether content was truncated due to size */
   truncated?: boolean
 }
-

package/types/touch-app-core.ts

@@ -1,38 +1,38 @@
-import { BrowserWindowConstructorOptions, OpenDevToolsOptions } from "electron";
-import { IBaseModuleManager, IBaseModule } from './modules'
+import type { BrowserWindowConstructorOptions, OpenDevToolsOptions } from 'electron'
+import type { IBaseModule, IBaseModuleManager } from './modules'
 
 export namespace TalexTouch {
   export interface TouchApp {
-    app: Electron.App;
-    window: ITouchWindow;
-    version: AppVersion;
-    moduleManager: IBaseModuleManager;
-    config: IConfiguration;
-    rootPath: string;
+    app: Electron.App
+    window: ITouchWindow
+    version: AppVersion
+    moduleManager: IBaseModuleManager
+    config: IConfiguration
+    rootPath: string
   }
 
   export enum AppVersion {
     // ALPHA = "alpha",
     // BETA = "beta",
-    DEV = "dev",
-    RELEASE = "release",
+    DEV = 'dev',
+    RELEASE = 'release',
   }
 
   export interface ITouchWindow {
-    window: Electron.BrowserWindow;
+    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;
+    close(): void
 
     /**
      * Minimizes the window. On some platforms the minimized window will be shown in
      * the Dock.
      */
-    minimize(): void;
+    minimize(): void
 
     /**
      * Opens the devtools.
@@ -43,29 +43,29 @@ export namespace TalexTouch {
      * On Windows, if Windows Control Overlay is enabled, Devtools will be opened with
      * `mode: 'detach'`.
      */
-    openDevTools(options?: OpenDevToolsOptions): void;
+    openDevTools(options?: OpenDevToolsOptions): void
 
     loadURL(
       url: string,
       options?: LoadURLOptions | undefined,
-    ): Promise<Electron.WebContents>;
+    ): Promise<Electron.WebContents>
     loadFile(
       filePath: string,
       options?: LoadFileOptions | undefined,
-    ): Promise<Electron.WebContents>;
+    ): Promise<Electron.WebContents>
   }
 
-  export type TouchWindowConstructorOptions =
-    BrowserWindowConstructorOptions & {
-      autoShow?: boolean;
-    };
+  export type TouchWindowConstructorOptions
+    = BrowserWindowConstructorOptions & {
+      autoShow?: boolean
+    }
 
   export type LoadFileOptions = Electron.LoadFileOptions & {
-    devtools?: boolean | "detach" | "left" | "right" | "bottom" | "undocked";
-  };
+    devtools?: boolean | 'detach' | 'left' | 'right' | 'bottom' | 'undocked'
+  }
   export type LoadURLOptions = Electron.LoadURLOptions & {
-    devtools?: boolean | "detach" | "left" | "right" | "bottom" | "undocked";
-  };
+    devtools?: boolean | 'detach' | 'left' | 'right' | 'bottom' | 'undocked'
+  }
 
   export interface IModuleManager<E> extends IBaseModuleManager<E> {
 
@@ -74,17 +74,17 @@ export namespace TalexTouch {
   export interface IModule<E> extends IBaseModule<E> {}
 
   export interface IConfiguration {
-    configPath: string;
-    data: TouchAppConfig;
-    triggerSave: Function;
+    configPath: string
+    data: TouchAppConfig
+    triggerSave: Function
   }
 
   export interface TouchAppConfig {
     frame: {
-      width: number;
-      height: number;
-      left?: number;
-      top?: number;
-    };
+      width: number
+      height: number
+      left?: number
+      top?: number
+    }
   }
 }