@lynx-js/lynxtron 0.0.1 → 0.0.3

package/apis/api/power-monitor.d.ts

@@ -0,0 +1,121 @@
+// Copyright 2026 The Lynxtron Authors. All rights reserved.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+
+import { EventEmitter } from 'node:events';
+
+export interface PowerMonitor extends EventEmitter {
+  // Docs: https://electronjs.org/docs/api/power-monitor
+
+  /**
+   * Emitted when the system is about to lock the screen.
+   *
+   * @platform darwin,win32
+   */
+  on(event: 'lock-screen', listener: Function): this;
+  once(event: 'lock-screen', listener: Function): this;
+  addListener(event: 'lock-screen', listener: Function): this;
+  removeListener(event: 'lock-screen', listener: Function): this;
+  /**
+   * Emitted when the system changes to AC power.
+   *
+   * @platform darwin,win32
+   */
+  on(event: 'on-ac', listener: Function): this;
+  once(event: 'on-ac', listener: Function): this;
+  addListener(event: 'on-ac', listener: Function): this;
+  removeListener(event: 'on-ac', listener: Function): this;
+  /**
+   * Emitted when system changes to battery power.
+   *
+   * @platform darwin
+   */
+  on(event: 'on-battery', listener: Function): this;
+  once(event: 'on-battery', listener: Function): this;
+  addListener(event: 'on-battery', listener: Function): this;
+  removeListener(event: 'on-battery', listener: Function): this;
+  /**
+   * Emitted when system is resuming.
+   */
+  on(event: 'resume', listener: Function): this;
+  once(event: 'resume', listener: Function): this;
+  addListener(event: 'resume', listener: Function): this;
+  removeListener(event: 'resume', listener: Function): this;
+  /**
+   * Emitted when the system is about to reboot or shut down. If the event handler
+   * invokes `e.preventDefault()`, Electron will attempt to delay system shutdown in
+   * order for the app to exit cleanly. If `e.preventDefault()` is called, the app
+   * should exit as soon as possible by calling something like `app.quit()`.
+   *
+   * @platform linux,darwin
+   */
+  on(event: 'shutdown', listener: Function): this;
+  once(event: 'shutdown', listener: Function): this;
+  addListener(event: 'shutdown', listener: Function): this;
+  removeListener(event: 'shutdown', listener: Function): this;
+  /**
+   * Emitted when the system is suspending.
+   */
+  on(event: 'suspend', listener: Function): this;
+  once(event: 'suspend', listener: Function): this;
+  addListener(event: 'suspend', listener: Function): this;
+  removeListener(event: 'suspend', listener: Function): this;
+  /**
+   * Emitted as soon as the systems screen is unlocked.
+   *
+   * @platform darwin,win32
+   */
+  on(event: 'unlock-screen', listener: Function): this;
+  once(event: 'unlock-screen', listener: Function): this;
+  addListener(event: 'unlock-screen', listener: Function): this;
+  removeListener(event: 'unlock-screen', listener: Function): this;
+  /**
+   * Emitted when a login session is activated. See documentation for more
+   * information.
+   *
+   * @platform darwin
+   */
+  on(event: 'user-did-become-active', listener: Function): this;
+  once(event: 'user-did-become-active', listener: Function): this;
+  addListener(event: 'user-did-become-active', listener: Function): this;
+  removeListener(event: 'user-did-become-active', listener: Function): this;
+  /**
+   * Emitted when a login session is deactivated. See documentation for more
+   * information.
+   *
+   * @platform darwin
+   */
+  on(event: 'user-did-resign-active', listener: Function): this;
+  once(event: 'user-did-resign-active', listener: Function): this;
+  addListener(event: 'user-did-resign-active', listener: Function): this;
+  removeListener(event: 'user-did-resign-active', listener: Function): this;
+  /**
+   * The system's current state. Can be `active`, `idle`, `locked` or `unknown`.
+   *
+   * Calculate the system idle state. `idleThreshold` is the amount of time (in
+   * seconds) before considered idle.  `locked` is available on supported systems
+   * only.
+   */
+  getSystemIdleState(
+    idleThreshold: number
+  ): 'active' | 'idle' | 'locked' | 'unknown';
+  /**
+   * Idle time in seconds
+   *
+   * Calculate system idle time in seconds.
+   */
+  getSystemIdleTime(): number;
+  /**
+   * Whether the system is on battery power.
+   *
+   * To monitor for changes in this property, use the `on-battery` and `on-ac`
+   * events.
+   */
+  isOnBatteryPower(): boolean;
+  /**
+   * A `boolean` property. True if the system is on battery power.
+   *
+   * See `powerMonitor.isOnBatteryPower()`.
+   */
+  onBatteryPower: boolean;
+}

package/apis/api/process-metric.d.ts

@@ -0,0 +1,93 @@
+// Copyright 2026 The Lynxtron Authors. All rights reserved.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+
+export interface CPUUsage {
+  /**
+   * Total seconds of CPU time used since process startup.
+   */
+  cumulativeCPUUsage?: number;
+  /**
+   * The number of average idle CPU wakeups per second since the last call to
+   * getCPUUsage. First call returns 0. Will always return 0 on Windows.
+   */
+  idleWakeupsPerSecond: number;
+  /**
+   * Percentage of CPU used since the last call to getCPUUsage. First call returns 0.
+   */
+  percentCPUUsage: number;
+}
+
+export interface MemoryInfo {
+  /**
+   * The maximum amount of memory that has ever been pinned to actual physical RAM.
+   */
+  peakWorkingSetSize: number;
+  /**
+   * The amount of memory not shared by other processes, such as script heap or
+   * other private runtime content.
+   *
+   * @platform win32
+   */
+  privateBytes?: number;
+  /**
+   * The amount of memory currently pinned to actual physical RAM.
+   */
+  workingSetSize: number;
+}
+
+export interface ProcessMetric {
+  /**
+   * CPU usage of the process.
+   */
+  cpu: CPUUsage;
+  /**
+   * Creation time for this process. The time is represented as number of
+   * milliseconds since epoch. Since the `pid` can be reused after a process dies, it
+   * is useful to use both the `pid` and the `creationTime` to uniquely identify a
+   * process.
+   */
+  creationTime: number;
+  /**
+   * One of the following values:
+   *
+   * @platform win32
+   */
+  integrityLevel?: 'untrusted' | 'low' | 'medium' | 'high' | 'unknown';
+  /**
+   * Memory information for the process.
+   */
+  memory: MemoryInfo;
+  /**
+   * The name of the process. Examples for utility: `Audio Service`, `Content
+   * Decryption Module Service`, `Network Service`, `Video Capture`, etc.
+   */
+  name?: string;
+  /**
+   * Process id of the process.
+   */
+  pid: number;
+  /**
+   * Whether the process is sandboxed on OS level.
+   *
+   * @platform darwin,win32
+   */
+  sandboxed?: boolean;
+  /**
+   * The non-localized name of the process.
+   */
+  serviceName?: string;
+  /**
+   * Process type. One of the following values:
+   */
+  type:
+    | 'Browser'
+    | 'Tab'
+    | 'Utility'
+    | 'Zygote'
+    | 'Sandbox helper'
+    | 'GPU'
+    | 'Pepper Plugin'
+    | 'Pepper Plugin Broker'
+    | 'Unknown';
+}

package/apis/api/protocol.d.ts

@@ -0,0 +1,54 @@
+// Copyright 2026 The Lynxtron Authors. All rights reserved.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+
+export interface ResourceRequest {
+  resourceType: string;
+  scheme: string;
+  url: string;
+}
+
+export interface ResourceResponse {
+  url: string;
+  statusCode: number;
+  data: Buffer;
+}
+
+export type ProtocolHandler = (
+  request: ResourceRequest
+) => ResourceResponse | Promise<ResourceResponse> | false | undefined;
+
+export interface ProtocolRewriteRequest {
+  scheme: string;
+  url: string;
+}
+
+export type ProtocolRequestRewriter = (
+  request: ProtocolRewriteRequest
+) => string | false | undefined;
+
+export interface Protocol {
+  /**
+   * Register a resource handler for a URL scheme such as `app`.
+   *
+   * Returning `false` or `undefined` falls back to the normal Lynx resource
+   * loading path. Return a Promise when the response data is produced
+   * asynchronously.
+   */
+  handle(scheme: string, handler: ProtocolHandler): void;
+  /**
+   * Whether a handler is registered for `scheme`.
+   */
+  isProtocolHandled(scheme: string): boolean;
+  /**
+   * Remove the handler registered for `scheme`.
+   */
+  unhandle(scheme: string): void;
+  /**
+   * Rewrite a resource request URL before protocol handlers and fallback
+   * loaders run. Pass `null` or `undefined` to clear the current rewriter.
+   */
+  setRequestRewriter(handler: ProtocolRequestRewriter | null | undefined): void;
+}
+
+export declare const protocol: Protocol;

package/apis/api/screen.d.ts

@@ -0,0 +1,222 @@
+// Copyright 2026 The Lynxtron Authors. All rights reserved.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+
+import { Point } from '../structures/point';
+import { Size } from '../structures/size';
+import { Rectangle } from '../structures/rectangle';
+import { BaseWindow } from './base-window';
+import { EventEmitter } from 'node:events';
+
+export interface Display {
+  /**
+   * Can be `available`, `unavailable`, `unknown`.
+   */
+  accelerometerSupport: 'available' | 'unavailable' | 'unknown';
+  /**
+   * the bounds of the display in DIP points.
+   */
+  bounds: Rectangle;
+  /**
+   * The number of bits per pixel.
+   */
+  colorDepth: number;
+  /**
+   *  represent a color space (three-dimensional object which contains all realizable
+   * color combinations) for the purpose of color conversions.
+   */
+  colorSpace: string;
+  /**
+   * The number of bits per color component.
+   */
+  depthPerComponent: number;
+  /**
+   * `true` if the display is detected by the system.
+   */
+  detected: boolean;
+  /**
+   * The display refresh rate.
+   */
+  displayFrequency: number;
+  /**
+   * Unique identifier associated with the display. A value of of -1 means the
+   * display is invalid or the correct `id` is not yet known, and a value of -10
+   * means the display is a virtual display assigned to a unified desktop.
+   */
+  id: number;
+  /**
+   * `true` for an internal display and `false` for an external display.
+   */
+  internal: boolean;
+  /**
+   * User-friendly label, determined by the platform.
+   */
+  label: string;
+  /**
+   * Maximum cursor size in native pixels.
+   */
+  maximumCursorSize: Size;
+  /**
+   * Whether or not the display is a monochrome display.
+   */
+  monochrome: boolean;
+  /**
+   * Returns the display's origin in pixel coordinates. Only available on windowing
+   * systems like X11 that position displays in pixel coordinates.
+   */
+  nativeOrigin: Point;
+  /**
+   * Can be 0, 90, 180, 270, represents screen rotation in clock-wise degrees.
+   */
+  rotation: number;
+  /**
+   * Output device's pixel scale factor.
+   */
+  scaleFactor: number;
+  size: Size;
+  /**
+   * Can be `available`, `unavailable`, `unknown`.
+   */
+  touchSupport: 'available' | 'unavailable' | 'unknown';
+  /**
+   * the work area of the display in DIP points.
+   */
+  workArea: Rectangle;
+  /**
+   * The size of the work area.
+   */
+  workAreaSize: Size;
+}
+
+export interface Screen extends EventEmitter {
+  /**
+   * Emitted when `newDisplay` has been added.
+   */
+  on(
+    event: 'display-added',
+    listener: (event: Event, newDisplay: Display) => void
+  ): this;
+  off(
+    event: 'display-added',
+    listener: (event: Event, newDisplay: Display) => void
+  ): this;
+  once(
+    event: 'display-added',
+    listener: (event: Event, newDisplay: Display) => void
+  ): this;
+  addListener(
+    event: 'display-added',
+    listener: (event: Event, newDisplay: Display) => void
+  ): this;
+  removeListener(
+    event: 'display-added',
+    listener: (event: Event, newDisplay: Display) => void
+  ): this;
+  /**
+   * Emitted when one or more metrics change in a `display`. The `changedMetrics` is
+   * an array of strings that describe the changes. Possible changes are `bounds`,
+   * `workArea`, `scaleFactor` and `rotation`.
+   */
+  on(
+    event: 'display-metrics-changed',
+    listener: (event: Event, display: Display, changedMetrics: string[]) => void
+  ): this;
+  off(
+    event: 'display-metrics-changed',
+    listener: (event: Event, display: Display, changedMetrics: string[]) => void
+  ): this;
+  once(
+    event: 'display-metrics-changed',
+    listener: (event: Event, display: Display, changedMetrics: string[]) => void
+  ): this;
+  addListener(
+    event: 'display-metrics-changed',
+    listener: (event: Event, display: Display, changedMetrics: string[]) => void
+  ): this;
+  removeListener(
+    event: 'display-metrics-changed',
+    listener: (event: Event, display: Display, changedMetrics: string[]) => void
+  ): this;
+  /**
+   * Emitted when `oldDisplay` has been removed.
+   */
+  on(
+    event: 'display-removed',
+    listener: (event: Event, oldDisplay: Display) => void
+  ): this;
+  off(
+    event: 'display-removed',
+    listener: (event: Event, oldDisplay: Display) => void
+  ): this;
+  once(
+    event: 'display-removed',
+    listener: (event: Event, oldDisplay: Display) => void
+  ): this;
+  addListener(
+    event: 'display-removed',
+    listener: (event: Event, oldDisplay: Display) => void
+  ): this;
+  removeListener(
+    event: 'display-removed',
+    listener: (event: Event, oldDisplay: Display) => void
+  ): this;
+  /**
+   * Converts a screen DIP point to a screen physical point. The DPI scale is
+   * performed relative to the display containing the DIP point.
+   *
+   * Not currently supported on Wayland.
+   *
+   * @platform win32,linux
+   */
+  dipToScreenPoint(point: Point): Point;
+  /**
+   * Converts a screen DIP rect to a screen physical rect. The DPI scale is performed
+   * relative to the display nearest to `window`. If `window` is null, scaling will
+   * be performed to the display nearest to `rect`.
+   *
+   * @platform win32
+   */
+  dipToScreenRect(window: BaseWindow | null, rect: Rectangle): Rectangle;
+  /**
+   * An array of displays that are currently available.
+   */
+  getAllDisplays(): Display[];
+  /**
+   * The current absolute position of the mouse pointer.
+   *
+   * > [!NOTE] The return value is a DIP point, not a screen physical point.
+   */
+  getCursorScreenPoint(): Point;
+  /**
+   * The display that most closely intersects the provided bounds.
+   */
+  getDisplayMatching(rect: Rectangle): Display;
+  /**
+   * The display nearest the specified point.
+   */
+  getDisplayNearestPoint(point: Point): Display;
+  /**
+   * The primary display.
+   */
+  getPrimaryDisplay(): Display;
+  /**
+   * Converts a screen physical point to a screen DIP point. The DPI scale is
+   * performed relative to the display containing the physical point.
+   *
+   * Not currently supported on Wayland - if used there it will return the point
+   * passed in with no changes.
+   *
+   * @platform win32,linux
+   */
+  screenToDipPoint(point: Point): Point;
+  /**
+   * Converts a screen physical rect to a screen DIP rect. The DPI scale is performed
+   * relative to the display nearest to `window`. If `window` is null, scaling will
+   * be performed to the display nearest to `rect`.
+   *
+   * @platform win32
+   */
+  screenToDipRect(window: BaseWindow | null, rect: Rectangle): Rectangle;
+}
+
+export declare const screen: Screen;

package/apis/api/shell.d.ts

@@ -0,0 +1,124 @@
+// Copyright 2026 The Lynxtron Authors. All rights reserved.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+
+export interface OpenExternalOptions {
+  /**
+   * `true` to bring the opened application to the foreground. The default is `true`.
+   *
+   * @platform darwin
+   */
+  activate?: boolean;
+  /**
+   * The working directory.
+   *
+   * @platform win32
+   */
+  workingDirectory?: string;
+  /**
+   * Indicates a user initiated launch that enables tracking of frequently used
+   * programs and other behaviors. The default is `false`.
+   *
+   * @platform win32
+   */
+  logUsage?: boolean;
+}
+
+export interface ShortcutDetails {
+  /**
+   * The Application User Model ID. Default is empty.
+   */
+  appUserModelId?: string;
+  /**
+   * The arguments to be applied to `target` when launching from this shortcut.
+   * Default is empty.
+   */
+  args?: string;
+  /**
+   * The working directory. Default is empty.
+   */
+  cwd?: string;
+  /**
+   * The description of the shortcut. Default is empty.
+   */
+  description?: string;
+  /**
+   * The path to the icon, can be a DLL or EXE. `icon` and `iconIndex` have to be set
+   * together. Default is empty, which uses the target's icon.
+   */
+  icon?: string;
+  /**
+   * The resource ID of icon when `icon` is a DLL or EXE. Default is 0.
+   */
+  iconIndex?: number;
+  /**
+   * The target to launch from this shortcut.
+   */
+  target: string;
+  /**
+   * The Application Toast Activator CLSID. Needed for participating in Action
+   * Center.
+   */
+  toastActivatorClsid?: string;
+}
+
+export interface Shell {
+  /**
+   * Play the beep sound.
+   */
+  beep(): void;
+  /**
+   * Open the given external protocol URL in the desktop's default manner. (For
+   * example, mailto: URLs in the user's default mail agent).
+   */
+  openExternal(url: string, options?: OpenExternalOptions): Promise<void>;
+  /**
+   * Resolves with a string containing the error message corresponding to the failure
+   * if a failure occurred, otherwise "".
+   *
+   * Open the given file in the desktop's default manner.
+   */
+  openPath(path: string): Promise<string>;
+  /**
+   * Resolves the shortcut link at `shortcutPath`.
+   *
+   * An exception will be thrown when any error happens.
+   *
+   * @platform win32
+   */
+  readShortcutLink(shortcutPath: string): ShortcutDetails;
+  /**
+   * Show the given file in a file manager. If possible, select the file.
+   */
+  showItemInFolder(fullPath: string): void;
+  /**
+   * Resolves when the operation has been completed. Rejects if there was an error
+   * while deleting the requested item.
+   *
+   * This moves a path to the OS-specific trash location (Trash on macOS, Recycle Bin
+   * on Windows, and a desktop-environment-specific location on Linux).
+   */
+  trashItem(path: string): Promise<void>;
+  /**
+   * Whether the shortcut was created successfully.
+   *
+   * Creates or updates a shortcut link at `shortcutPath`.
+   *
+   * @platform win32
+   */
+  writeShortcutLink(
+    shortcutPath: string,
+    operation: 'create' | 'update' | 'replace',
+    options: ShortcutDetails
+  ): boolean;
+  /**
+   * Whether the shortcut was created successfully.
+   *
+   * Creates or updates a shortcut link at `shortcutPath`.
+   *
+   * @platform win32
+   */
+  writeShortcutLink(shortcutPath: string, options: ShortcutDetails): boolean;
+}
+
+export declare const shell: Shell;

package/apis/api/task.d.ts

@@ -0,0 +1,39 @@
+// Copyright 2026 The Lynxtron Authors. All rights reserved.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+
+export interface Task {
+  /**
+   * The command line arguments when `program` is executed.
+   */
+  arguments: string;
+  /**
+   * Description of this task.
+   */
+  description: string;
+  /**
+   * The icon index in the icon file. If an icon file consists of two or more icons,
+   * set this value to identify the icon. If an icon file consists of one icon, this
+   * value is 0.
+   */
+  iconIndex: number;
+  /**
+   * The absolute path to an icon to be displayed in a JumpList, which can be an
+   * arbitrary resource file that contains an icon. You can usually specify
+   * `process.execPath` to show the icon of the program.
+   */
+  iconPath: string;
+  /**
+   * Path of the program to execute, usually you should specify `process.execPath`
+   * which opens the current program.
+   */
+  program: string;
+  /**
+   * The string to be displayed in a JumpList.
+   */
+  title: string;
+  /**
+   * The working directory. Default is empty.
+   */
+  workingDirectory?: string;
+}