@fungi.computer/oyster 0.0.0-stage → 0.0.1

package/docs/api/shell/window-manager.md

@@ -0,0 +1,267 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/oyster**](../README.md)
+
+---
+
+[@fungi.computer/oyster](../modules.md) / shell/window-manager
+
+# shell/window-manager
+
+## Type Aliases
+
+### WindowLaunch
+
+```ts
+type WindowLaunch = Readonly<{
+  windowId: string;
+}>;
+```
+
+Minimum identity required to own a window across mount generations.
+
+---
+
+### WindowStatus
+
+```ts
+type WindowStatus = "loading" | "ready" | "minimized" | "error";
+```
+
+Current presentation state of a managed window.
+
+---
+
+### WindowHost
+
+```ts
+type WindowHost<Launch> = Readonly<{
+  setVisibility: (visibility) => void | Promise<void>;
+  reconfigure: (launch, signal?) => void | Promise<void>;
+  requestClose?: () => boolean | Promise<boolean>;
+  requestBack?: () => 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`](#windowlaunch) |
+
+---
+
+### WindowEvents
+
+```ts
+type WindowEvents = Readonly<{
+  onComputerChoice: () => Promise<void>;
+  onNavigationState: (state) => void;
+  onStatusItems: (items) => void;
+}>;
+```
+
+What a mounted App tells its window while it lives.
+
+---
+
+### WindowProjection
+
+```ts
+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`](#windowlaunch) |
+| `Container`                                        |
+
+---
+
+### WindowsProjection
+
+```ts
+type WindowsProjection<Launch, Container> = Readonly<{
+  windows: readonly WindowProjection<Launch, Container>[];
+}>;
+```
+
+Current ordered collection of managed window snapshots.
+
+#### Type Parameters
+
+| Type Parameter                                     |
+| -------------------------------------------------- |
+| `Launch` _extends_ [`WindowLaunch`](#windowlaunch) |
+| `Container`                                        |
+
+---
+
+### WindowMount
+
+```ts
+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`](#windowlaunch) |
+| `Container`                                        |
+
+#### Parameters
+
+| Parameter   | Type                            |
+| ----------- | ------------------------------- |
+| `container` | `Container`                     |
+| `launch`    | `Launch`                        |
+| `signal`    | `AbortSignal`                   |
+| `events`    | [`WindowEvents`](#windowevents) |
+
+#### Returns
+
+\| [`WindowHost`](#windowhost)\<`Launch`\> \|
+`Promise`\<[`WindowHost`](#windowhost)\<`Launch`\>\>
+
+---
+
+### WindowManager
+
+```ts
+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>;
+  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`](#windowlaunch) |
+| `Container`                                        |
+
+---
+
+### WindowManagerOptions
+
+```ts
+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`](#windowlaunch) |
+| `Container`                                        |
+
+## Functions
+
+### hasVisibleWindows()
+
+```ts
+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`](#windowsprojection)\<`Launch`, `Container`\> |
+
+#### Returns
+
+`boolean`
+
+---
+
+### createWindowManager()
+
+```ts
+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`](#windowmanageroptions)\<`Launch`, `Container`\> |
+
+#### Returns
+
+[`WindowManager`](#windowmanager)\<`Launch`, `Container`\>

package/docs/api/shell/workbench.md

@@ -0,0 +1,186 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/oyster**](../README.md)
+
+---
+
+[@fungi.computer/oyster](../modules.md) / shell/workbench
+
+# shell/workbench
+
+## References
+
+### WorkbenchResolvedChild
+
+Re-exports [WorkbenchResolvedChild](../shell.md#workbenchresolvedchild)
+
+---
+
+### WorkbenchChildSurface
+
+Re-exports [WorkbenchChildSurface](../shell.md#workbenchchildsurface)
+
+---
+
+### WorkbenchChildMountOptions
+
+Re-exports [WorkbenchChildMountOptions](../shell.md#workbenchchildmountoptions)
+
+---
+
+### WorkbenchPreparedChild
+
+Re-exports [WorkbenchPreparedChild](../shell.md#workbenchpreparedchild)
+
+---
+
+### WorkbenchHostServices
+
+Re-exports [WorkbenchHostServices](../shell.md#workbenchhostservices)
+
+---
+
+### WorkbenchHostControls
+
+Re-exports [WorkbenchHostControls](../shell.md#workbenchhostcontrols)
+
+---
+
+### WorkbenchWarningEvent
+
+Re-exports [WorkbenchWarningEvent](../shell.md#workbenchwarningevent)
+
+---
+
+### WorkbenchWarningFields
+
+Re-exports [WorkbenchWarningFields](../shell.md#workbenchwarningfields)
+
+---
+
+### WorkbenchHostOptions
+
+Re-exports [WorkbenchHostOptions](../shell.md#workbenchhostoptions)
+
+---
+
+### WorkbenchChildLaunch
+
+Re-exports [WorkbenchChildLaunch](../shell.md#workbenchchildlaunch)
+
+---
+
+### WorkbenchCommandInvocation
+
+Re-exports [WorkbenchCommandInvocation](../shell.md#workbenchcommandinvocation)
+
+---
+
+### WorkbenchChildEvents
+
+Re-exports [WorkbenchChildEvents](../shell.md#workbenchchildevents)
+
+---
+
+### WorkbenchChildHandle
+
+Re-exports [WorkbenchChildHandle](../shell.md#workbenchchildhandle)
+
+---
+
+### WorkbenchPlatformDestination
+
+Re-exports
+[WorkbenchPlatformDestination](../shell.md#workbenchplatformdestination)
+
+---
+
+### workbenchGillRequestSchema
+
+Re-exports [workbenchGillRequestSchema](../shell.md#workbenchgillrequestschema)
+
+---
+
+### WorkbenchGillRequest
+
+Re-exports [WorkbenchGillRequest](../shell.md#workbenchgillrequest)
+
+---
+
+### desktopGillSelectionSchema
+
+Re-exports [desktopGillSelectionSchema](../shell.md#desktopgillselectionschema)
+
+---
+
+### DesktopGillSelection
+
+Re-exports [DesktopGillSelection](../shell.md#desktopgillselection)
+
+---
+
+### desktopGillSizesSchema
+
+Re-exports [desktopGillSizesSchema](../shell.md#desktopgillsizesschema)
+
+---
+
+### desktopGillAdditionSchema
+
+Re-exports [desktopGillAdditionSchema](../shell.md#desktopgilladditionschema)
+
+---
+
+### DesktopGillAddition
+
+Re-exports [DesktopGillAddition](../shell.md#desktopgilladdition)
+
+---
+
+### WorkbenchDesktopSettings
+
+Re-exports [WorkbenchDesktopSettings](../shell.md#workbenchdesktopsettings)
+
+---
+
+### desktopSettingsHandlerSchema
+
+Re-exports
+[desktopSettingsHandlerSchema](../shell.md#desktopsettingshandlerschema)
+
+---
+
+### WorkbenchDesktopRegistration
+
+Re-exports
+[WorkbenchDesktopRegistration](../shell.md#workbenchdesktopregistration)
+
+---
+
+### WorkbenchGillWatch
+
+Re-exports [WorkbenchGillWatch](../shell.md#workbenchgillwatch)
+
+---
+
+### appOpenRequestSchema
+
+Re-exports [appOpenRequestSchema](../shell.md#appopenrequestschema)
+
+---
+
+### TeamWorkbenchHostHandle
+
+Re-exports [TeamWorkbenchHostHandle](../shell.md#teamworkbenchhosthandle)
+
+---
+
+### TeamWorkbenchChildEvents
+
+Re-exports [TeamWorkbenchChildEvents](../shell.md#teamworkbenchchildevents)
+
+---
+
+### WorkbenchHost
+
+Re-exports [WorkbenchHost](../shell.md#workbenchhost)