@lynx-js/lynxtron 0.0.1 → 0.0.2

package/apis/api/touch-bar.d.ts

@@ -0,0 +1,206 @@
+// 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 { NativeImage } from './native-image';
+
+export interface ScrubberItem {
+  icon?: NativeImage;
+  label?: string;
+}
+
+export interface SegmentedControlSegment {
+  enabled?: boolean;
+  icon?: NativeImage;
+  label?: string;
+}
+
+export interface TouchBarButtonConstructorOptions {
+  label?: string;
+  accessibilityLabel?: string;
+  backgroundColor?: string;
+  icon?: NativeImage | string;
+  iconPosition?: 'left' | 'right' | 'overlay';
+  click?: () => void;
+  enabled?: boolean;
+}
+
+export interface TouchBarColorPickerConstructorOptions {
+  availableColors?: string[];
+  selectedColor?: string;
+  change?: (color: string) => void;
+}
+
+export interface TouchBarConstructorOptions {
+  items?: Array<
+    | TouchBarButton
+    | TouchBarColorPicker
+    | TouchBarGroup
+    | TouchBarLabel
+    | TouchBarPopover
+    | TouchBarScrubber
+    | TouchBarSegmentedControl
+    | TouchBarSlider
+    | TouchBarSpacer
+  >;
+  escapeItem?:
+    | TouchBarButton
+    | TouchBarColorPicker
+    | TouchBarGroup
+    | TouchBarLabel
+    | TouchBarPopover
+    | TouchBarScrubber
+    | TouchBarSegmentedControl
+    | TouchBarSlider
+    | TouchBarSpacer
+    | null;
+}
+
+export interface TouchBarGroupConstructorOptions {
+  items: TouchBar;
+}
+
+export interface TouchBarLabelConstructorOptions {
+  label?: string;
+  accessibilityLabel?: string;
+  textColor?: string;
+}
+
+export interface TouchBarPopoverConstructorOptions {
+  label?: string;
+  icon?: NativeImage;
+  items: TouchBar;
+  showCloseButton?: boolean;
+}
+
+export interface TouchBarScrubberConstructorOptions {
+  items: ScrubberItem[];
+  select?: (selectedIndex: number) => void;
+  highlight?: (highlightedIndex: number) => void;
+  selectedStyle?: 'background' | 'outline' | 'none';
+  overlayStyle?: 'background' | 'outline' | 'none';
+  showArrowButtons?: boolean;
+  mode?: 'fixed' | 'free';
+  continuous?: boolean;
+}
+
+export interface TouchBarSegmentedControlConstructorOptions {
+  segmentStyle?:
+    | 'automatic'
+    | 'rounded'
+    | 'textured-rounded'
+    | 'round-rect'
+    | 'textured-square'
+    | 'capsule'
+    | 'small-square'
+    | 'separated';
+  mode?: 'single' | 'multiple' | 'buttons';
+  segments: SegmentedControlSegment[];
+  selectedIndex?: number;
+  change?: (selectedIndex: number, isSelected: boolean) => void;
+}
+
+export interface TouchBarSliderConstructorOptions {
+  label?: string;
+  value?: number;
+  minValue?: number;
+  maxValue?: number;
+  change?: (newValue: number) => void;
+}
+
+export interface TouchBarSpacerConstructorOptions {
+  size?: 'small' | 'large' | 'flexible';
+}
+
+export declare class TouchBar {
+  constructor(options: TouchBarConstructorOptions);
+  escapeItem:
+    | TouchBarButton
+    | TouchBarColorPicker
+    | TouchBarGroup
+    | TouchBarLabel
+    | TouchBarPopover
+    | TouchBarScrubber
+    | TouchBarSegmentedControl
+    | TouchBarSlider
+    | TouchBarSpacer
+    | null;
+  static TouchBarButton: typeof TouchBarButton;
+  static TouchBarColorPicker: typeof TouchBarColorPicker;
+  static TouchBarGroup: typeof TouchBarGroup;
+  static TouchBarLabel: typeof TouchBarLabel;
+  static TouchBarOtherItemsProxy: typeof TouchBarOtherItemsProxy;
+  static TouchBarPopover: typeof TouchBarPopover;
+  static TouchBarScrubber: typeof TouchBarScrubber;
+  static TouchBarSegmentedControl: typeof TouchBarSegmentedControl;
+  static TouchBarSlider: typeof TouchBarSlider;
+  static TouchBarSpacer: typeof TouchBarSpacer;
+}
+
+export declare class TouchBarButton {
+  constructor(options: TouchBarButtonConstructorOptions);
+  accessibilityLabel: string;
+  backgroundColor: string;
+  enabled: boolean;
+  icon: NativeImage;
+  iconPosition: 'left' | 'right' | 'overlay';
+  label: string;
+}
+
+export declare class TouchBarColorPicker {
+  constructor(options: TouchBarColorPickerConstructorOptions);
+  availableColors: string[];
+  selectedColor: string;
+}
+
+export declare class TouchBarGroup {
+  constructor(options: TouchBarGroupConstructorOptions);
+}
+
+export declare class TouchBarLabel {
+  constructor(options: TouchBarLabelConstructorOptions);
+  accessibilityLabel: string;
+  label: string;
+  textColor: string;
+}
+
+export declare class TouchBarOtherItemsProxy {
+  constructor();
+}
+
+export declare class TouchBarPopover {
+  constructor(options: TouchBarPopoverConstructorOptions);
+  icon: NativeImage;
+  label: string;
+}
+
+export declare class TouchBarScrubber {
+  constructor(options: TouchBarScrubberConstructorOptions);
+  continuous: boolean;
+  items: ScrubberItem[];
+  mode: 'fixed' | 'free';
+  overlayStyle: 'background' | 'outline' | 'none';
+  selectedStyle: 'background' | 'outline' | 'none';
+  showArrowButtons: boolean;
+}
+
+export declare class TouchBarSegmentedControl {
+  constructor(options: TouchBarSegmentedControlConstructorOptions);
+  mode: 'single' | 'multiple' | 'buttons';
+  segments: SegmentedControlSegment[];
+  segmentStyle: string;
+  selectedIndex: number;
+}
+
+export declare class TouchBarSlider {
+  constructor(options: TouchBarSliderConstructorOptions);
+  label: string;
+  maxValue: number;
+  minValue: number;
+  value: number;
+}
+
+export declare class TouchBarSpacer {
+  constructor(options: TouchBarSpacerConstructorOptions);
+  size: 'small' | 'large' | 'flexible';
+}

package/apis/api/tray.d.ts

@@ -0,0 +1,44 @@
+// 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';
+import { Menu } from './menu';
+import { NativeImage } from './native-image';
+import { Point } from '../structures/point';
+import { Rectangle } from '../structures/rectangle';
+
+export interface DisplayBalloonOptions {
+  icon?: NativeImage | string;
+  iconType?: 'none' | 'info' | 'warning' | 'error' | 'custom';
+  title: string;
+  content: string;
+  largeIcon?: boolean;
+  noSound?: boolean;
+  respectQuietTime?: boolean;
+}
+
+export interface TitleOptions {
+  fontType?: 'monospaced' | 'monospacedDigit';
+}
+
+export declare class Tray extends EventEmitter {
+  constructor(image: NativeImage | string, guid?: string);
+  destroy(): void;
+  isDestroyed(): boolean;
+  setImage(image: NativeImage | string): void;
+  setPressedImage(image: NativeImage | string): void;
+  setToolTip(toolTip: string): void;
+  setTitle(title: string, options?: TitleOptions): void;
+  getTitle(): string;
+  setIgnoreDoubleClickEvents(ignore: boolean): void;
+  getIgnoreDoubleClickEvents(): boolean;
+  setContextMenu(menu: Menu | null): void;
+  popUpContextMenu(menu?: Menu, position?: Point): void;
+  closeContextMenu(): void;
+  displayBalloon(options: DisplayBalloonOptions): void;
+  removeBalloon(): void;
+  focus(): void;
+  getBounds(): Rectangle;
+  getGUID(): string | null;
+}

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

@@ -0,0 +1,73 @@
+// 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 'events';
+import { Readable } from 'stream';
+
+// UtilityProcess API
+
+export class UtilityProcess extends EventEmitter {
+  /**
+   * The `PID` of the process.
+   */
+  readonly pid: number | undefined;
+  /**
+   * A `Readable Stream` that represents the process's stdout.
+   */
+  readonly stdout: Readable | null;
+  /**
+   * A `Readable Stream` that represents the process's stderr.
+   */
+  readonly stderr: Readable | null;
+  /**
+   * Terminates the process gracefully. On some operating systems, the process will be
+   * terminated immediately.
+   */
+  kill(): boolean;
+  /**
+   * Send a message to the child process.
+   */
+  postMessage(message: any, transfer?: any[]): void;
+}
+
+export namespace utilityProcess {
+  /**
+   * Spawns a new process that runs the specified `modulePath`.
+   */
+  function fork(
+    modulePath: string,
+    args?: string[],
+    options?: ForkOptions
+  ): UtilityProcess;
+}
+
+export interface ForkOptions {
+  /**
+   * Environment key-value pairs. Default is `process.env`.
+   */
+  env?: Record<string, string>;
+  /**
+   * List of string arguments passed to the executable.
+   */
+  execArgv?: string[];
+  /**
+   * Current working directory of the child process.
+   */
+  cwd?: string;
+  /**
+   * If `true`, the child's stdin, stdout, and stderr will be piped to the parent,
+   * otherwise they will be inherited from the parent. Default is `false`.
+   */
+  stdio?: 'pipe' | 'ignore' | 'inherit' | ('pipe' | 'ignore' | 'inherit')[];
+  /**
+   * Allows configuring the mode for `stdout` and `stderr` of the child process.
+   * Default is `inherit`. String value can be one of `pipe`, `ignore`, `inherit`.
+   */
+  serviceName?: string;
+  /**
+   * With this flag, the utility process will be launched via the `allow_child_plugin`
+   * mechanism of the `UtilityProcess` API.
+   */
+  allowLoadingUnsignedLibraries?: boolean;
+}

package/apis/lynx.d.ts

@@ -0,0 +1,15 @@
+import '@lynx-js/types/background';
+
+export interface LynxtronNodejsExposed {
+  [key: string]: unknown;
+}
+
+export interface LynxtronNodejs {
+  exposed: LynxtronNodejsExposed;
+}
+
+declare module '@lynx-js/types/background' {
+  interface NativeModules {
+    nodejs: LynxtronNodejs;
+  }
+}

package/apis/lynxtron.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.
+
+// apis
+export * from './api/app';
+export * from './api/context-bridge';
+export * from './api/native-image';
+export * from './api/notification';
+export * from './api/command-line';
+export * from './api/menu';
+export * from './api/tray';
+export * from './api/notification-response';
+export * from './api/process-metric';
+export * from './api/task';
+export * from './api/dock';
+export * from './api/jump-list-item';
+export * from './api/base-window';
+export * from './api/clipboard';
+export * from './api/event';
+export * from './api/lynx-window';
+export * from './api/lynx-library';
+export * from './api/touch-bar';
+export * from './api/screen';
+export * from './api/asar';
+export * from './api/dialog';
+export * from './api/devtool';
+export * from './api/shell';
+export * from './api/protocol';
+export * from './api/environment';
+export * from './api/utility-process';
+export * from './api/lynx-template-bundle';
+export * from './api/lynx-update-meta';
+export * from './api/lynx-template-data';
+
+// structures
+export * from './structures/point';
+export * from './structures/rectangle';
+export * from './structures/size';

package/apis/structures/point.d.ts

@@ -0,0 +1,10 @@
+// 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 Point {
+  // Docs: https://electronjs.org/docs/api/structures/point
+
+  x: number;
+  y: number;
+}

package/apis/structures/rectangle.d.ts

@@ -0,0 +1,22 @@
+// 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 Rectangle {
+  /**
+   * The height of the rectangle (must be an integer).
+   */
+  height: number;
+  /**
+   * The width of the rectangle (must be an integer).
+   */
+  width: number;
+  /**
+   * The x coordinate of the origin of the rectangle (must be an integer).
+   */
+  x: number;
+  /**
+   * The y coordinate of the origin of the rectangle (must be an integer).
+   */
+  y: number;
+}

package/apis/structures/size.d.ts

@@ -0,0 +1,8 @@
+// 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 Size {
+  height: number;
+  width: number;
+}

package/apis/web-host.d.ts

@@ -0,0 +1,24 @@
+// 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 MainThreadBridge {
+  [methodName: string]: (data: any) => Promise<any> | any;
+}
+
+export interface BackgroundServiceConfig {
+  workerURL: string;
+  methods: string[];
+}
+
+export interface HostConfig {
+  bridge?: MainThreadBridge;
+  nodejs?: BackgroundServiceConfig;
+}
+
+/**
+ * Setup Symmetric Host for Web.
+ * @param lynxView The <lynx-view> element.
+ * @param config Configuration for bridge and nodejs.
+ */
+export function setupSymmetricHost(lynxView: any, config?: HostConfig): void;

package/cli.js

@@ -0,0 +1,28 @@
+#!/usr/bin/env node
+
+import proc from 'node:child_process';
+import lynxtron from './lynxtron_bin.js';
+
+const args = process.argv.slice(2);
+console.log('spawning', lynxtron, process.argv[2]);
+console.log("args", args);
+
+const child = proc.spawn(lynxtron, args, { stdio: 'inherit', windowsHide: false });
+child.on('close', function (code, signal) {
+  if (code === null) {
+    console.error(lynxtron, 'exited with signal', signal);
+    process.exit(1);
+  }
+  process.exit(code);
+});
+
+const handleTerminationSignal = function (signal) {
+  process.on(signal, function signalHandler () {
+    if (!child.killed) {
+      child.kill(signal);
+    }
+  });
+};
+
+handleTerminationSignal('SIGINT');
+handleTerminationSignal('SIGTERM');

package/context-bridge.js

@@ -0,0 +1,6 @@
+// @ts-nocheck
+import { createRequire } from 'module';
+const require = createRequire(import.meta.url);
+const lynxtron = require('lynxtron');
+
+export const contextBridge = lynxtron.contextBridge;

package/fuses-cli.js

@@ -0,0 +1,143 @@
+#!/usr/bin/env node
+
+import {
+  flipFuses,
+  FuseV1Options,
+  FuseVersion,
+  getCurrentFuses,
+} from './fuses.js';
+
+function printUsage() {
+  console.log(`Usage:
+  lynxtron-fuses read [--app <path>] [--binary <path>] [--json]
+  lynxtron-fuses write [--app <path>] [--binary <path>] <fuse=on|off>...
+
+--app prefers the macOS framework binary or Windows lynxtron.dll when given an app path.
+
+Supported fuses:
+  ${FuseV1Options.RunAsNode}
+  ${FuseV1Options.EnableNodeOptionsEnvironmentVariable}
+  ${FuseV1Options.EnableNodeCliInspectArguments}
+  ${FuseV1Options.EnableEmbeddedAsarIntegrityValidation}
+  ${FuseV1Options.OnlyLoadAppFromAsar}`);
+}
+
+function parseTargetAndFlags(args) {
+  const target = {};
+  const rest = [];
+  let json = false;
+
+  for (let index = 0; index < args.length; index += 1) {
+    const arg = args[index];
+    if (arg === '--app' || arg === '--binary') {
+      const value = args[index + 1];
+      if (!value) {
+        throw new Error(`Missing value for ${arg}`);
+      }
+      target[arg.slice(2)] = value;
+      index += 1;
+      continue;
+    }
+
+    if (arg === '--json') {
+      json = true;
+      continue;
+    }
+
+    rest.push(arg);
+  }
+
+  return { target, json, rest };
+}
+
+function parseFuseValue(rawValue) {
+  switch (rawValue) {
+    case '1':
+    case 'on':
+    case 'true':
+    case 'enabled':
+      return true;
+    case '0':
+    case 'off':
+    case 'false':
+    case 'disabled':
+      return false;
+    default:
+      throw new Error(`Unsupported fuse value "${rawValue}"`);
+  }
+}
+
+function parseAssignments(args) {
+  const config = { version: FuseVersion.V1 };
+
+  for (const arg of args) {
+    const separatorIndex = arg.indexOf('=');
+    if (separatorIndex === -1) {
+      throw new Error(`Expected <fuse=value>, got "${arg}"`);
+    }
+
+    const key = arg.slice(0, separatorIndex);
+    const rawValue = arg.slice(separatorIndex + 1).toLowerCase();
+    config[key] = parseFuseValue(rawValue);
+  }
+
+  return config;
+}
+
+function formatFuses(fuses) {
+  return [
+    `binaryPath: ${fuses.binaryPath}`,
+    `version: ${fuses.version}`,
+    `${FuseV1Options.RunAsNode}: ${fuses.runAsNode ? 'on' : 'off'}`,
+    `${FuseV1Options.EnableNodeOptionsEnvironmentVariable}: ${fuses.nodeOptions ? 'on' : 'off'}`,
+    `${FuseV1Options.EnableNodeCliInspectArguments}: ${fuses.nodeCliInspect ? 'on' : 'off'}`,
+    `${FuseV1Options.EnableEmbeddedAsarIntegrityValidation}: ${fuses.embeddedAsarIntegrityValidation ? 'on' : 'off'}`,
+    `${FuseV1Options.OnlyLoadAppFromAsar}: ${fuses.onlyLoadAppFromAsar ? 'on' : 'off'}`,
+  ].join('\n');
+}
+
+function getResignHint(binaryPath) {
+  const normalizedBinaryPath = binaryPath.toLowerCase();
+  if (normalizedBinaryPath.endsWith('.exe')) {
+    return 'Fuse bytes were updated. Re-sign the Windows executable before distributing it.';
+  }
+
+  return 'Fuse bytes were updated. Re-sign the app or binary before distributing it.';
+}
+
+async function main() {
+  const [command, ...args] = process.argv.slice(2);
+
+  if (!command || command === '--help' || command === '-h') {
+    printUsage();
+    return;
+  }
+
+  if (command !== 'read' && command !== 'write') {
+    throw new Error(`Unknown command "${command}"`);
+  }
+
+  const { target, json, rest } = parseTargetAndFlags(args);
+
+  if (command === 'read') {
+    const fuses = await getCurrentFuses(target);
+    console.log(json ? JSON.stringify(fuses, null, 2) : formatFuses(fuses));
+    return;
+  }
+
+  if (rest.length === 0) {
+    throw new Error('write requires at least one <fuse=on|off> assignment');
+  }
+
+  const fuses = await flipFuses(target, parseAssignments(rest));
+  console.log(json ? JSON.stringify(fuses, null, 2) : formatFuses(fuses));
+
+  if (process.platform === 'darwin' || fuses.binaryPath.toLowerCase().endsWith('.exe')) {
+    console.error(getResignHint(fuses.binaryPath));
+  }
+}
+
+main().catch((error) => {
+  console.error(error instanceof Error ? error.message : error);
+  process.exit(1);
+});