window-manager

Import

Import

import * as api from "@fungi.computer/nacre/window-manager";

Exports

Kind	Export	Description
Ttype alias	WindowLaunch	Minimum identity required to own a window across mount generations.
Ttype alias	WindowStatus	Current presentation state of a managed window.
Ttype alias	WindowHost	Mount operations supplied by the embedding host; selection and authority stay with it.
Ttype alias	WindowEvents	What a mounted App tells its window while it lives.
Ttype alias	WindowProjection	Immutable snapshot of one window and its mount generation.
Ttype alias	WindowsProjection	Current ordered collection of managed window snapshots.
Ttype alias	WindowMount	Create a host-owned mount in a container, observing cancellation and navigation.
Ttype alias	WindowManager	Own window lifetimes, visibility and serialized host mutations.
Ttype alias	WindowManagerOptions	Host adapters used to create, attach and validate window mounts.
fnfunction	hasVisibleWindows()	Whether any projected App window is still visible in the workspace.
fnfunction	createWindowManager()	Owns App-window generations while leaving selection and App authority to the caller. A stale mount is always disposed when it eventually resolves.

WindowLaunchTtype alias

Signature

type WindowLaunch = Readonly<{
  windowId: string;
}>;

Minimum identity required to own a window across mount generations.

---

WindowStatusTtype alias

Signature

type WindowStatus = "loading" | "ready" | "minimized" | "error";

Current presentation state of a managed window.

---

WindowHostTtype alias

Signature

type WindowHost<Launch> = Readonly<{
  setVisibility: (visibility) => void | Promise<void>;
  reconfigure: (launch, signal?) => void | Promise<void>;
  requestClose?: () => boolean | Promise<boolean>;
  requestBack?: () => boolean | Promise<boolean>;
  activateNavigation?: (activation) => boolean | Promise<boolean>;
  activateStatus?: (action) => boolean | Promise<boolean>;
  dispose: () => void | Promise<void>;
}>;

Mount operations supplied by the embedding host; selection and authority stay with it.

Type Parameters

Type Parameter
Launch extends WindowLaunch

---

WindowEventsTtype alias

Signature

type WindowEvents = Readonly<{
  onComputerChoice: () => Promise<void>;
  onNavigationState: (state) => void;
  onStatusItems: (items) => void;
}>;

What a mounted App tells its window while it lives.

---

WindowProjectionTtype alias

Signature

type WindowProjection<Launch, Container> = Readonly<{
  windowId: string;
  launch: Launch;
  container: Container;
  status: WindowStatus;
  generation: number;
  error?: unknown;
  cleanupError?: unknown;
  navigation: AppNavigationState | null;
  statusItems: readonly AppStatusItem[];
}>;

Immutable snapshot of one window and its mount generation.

Type Parameters

Type Parameter
Launch extends WindowLaunch
Container

---

WindowsProjectionTtype alias

Signature

type WindowsProjection<Launch, Container> = Readonly<{
  windows: readonly WindowProjection<Launch, Container>[];
}>;

Current ordered collection of managed window snapshots.

Type Parameters

Type Parameter
Launch extends WindowLaunch
Container

---

WindowMountTtype alias

Signature

type WindowMount<Launch, Container> = (
  container,
  launch,
  signal,
  events,
) => WindowHost<Launch> | Promise<WindowHost<Launch>>;

Create a host-owned mount in a container, observing cancellation and navigation.

Type Parameters

Type Parameter
Launch extends WindowLaunch
Container

Parameters

Parameter	Type
container	Container
launch	Launch
signal	AbortSignal
events	WindowEvents

Returns

| WindowHost<Launch> | Promise<WindowHost<Launch>>

---

WindowManagerTtype alias

Signature

type WindowManager<Launch, Container> = Readonly<{
  open: (launch) => Promise<void>;
  attach: (windowId) => void;
  minimize: (windowId) => Promise<void>;
  restore: (windowId) => Promise<void>;
  hideAll: () => Promise<void>;
  restoreHidden: () => Promise<void>;
  close: (windowId) => Promise<void>;
  reconfigure: (windowId, launch) => Promise<void>;
  update: (windowId, derive) => Promise<void>;
  replace: (windowId, launch) => Promise<void>;
  back: (windowId) => Promise<boolean>;
  activateNavigation: (windowId, activation) => Promise<boolean>;
  activateStatus: (windowId, action) => Promise<boolean>;
  registerComputerChoice: (windowId, handler) => () => void;
  dispose: () => Promise<void>;
  read: () => WindowsProjection<Launch, Container>;
  subscribe: (listener) => () => void;
}>;

Own window lifetimes, visibility and serialized host mutations.

Type Parameters

Type Parameter
Launch extends WindowLaunch
Container

---

WindowManagerOptionsTtype alias

Signature

type WindowManagerOptions<Launch, Container> = Readonly<{
  mount: WindowMount<Launch, Container>;
  createContainer: (launch) => Container;
  waitForAttachment?: boolean;
  onFailure?: (failure) => void;
  isAttached?: (container) => boolean;
  validateReconfiguration?: (current, next) => void;
  isChromeOnlyChange?: (current, next) => boolean;
}>;

Host adapters used to create, attach and validate window mounts.

Type Parameters

Type Parameter
Launch extends WindowLaunch
Container

hasVisibleWindows()fnfunction

Signature

function hasVisibleWindows<Launch, Container>(projection): boolean;

Whether any projected App window is still visible in the workspace.

Type Parameters

Type Parameter
Launch extends Readonly<{ windowId: string; }>
Container

Parameters

Parameter	Type
projection	WindowsProjection<Launch, Container>

Returns

boolean

---

createWindowManager()fnfunction

Signature

function createWindowManager<Launch, Container>(
  options,
): WindowManager<Launch, Container>;

Owns App-window generations while leaving selection and App authority to the caller. A stale mount is always disposed when it eventually resolves.

Type Parameters

Type Parameter
Launch extends Readonly<{ windowId: string; }>
Container

Parameters

Parameter	Type
options	WindowManagerOptions<Launch, Container>

Returns

WindowManager<Launch, Container>