shell-module

Import

Import

import * as api from "@fungi.computer/nacre/shell-module";

Exports

Kind	Export	Description
Cclass	ShellModuleError	The picked shell’s module could not be loaded or does not fit the contract.
Ttype alias	ShellMountInput	What a host hands the shell a Team picked. The host composes that shell into its own top-level document, so it runs with the host’s escalated permissions: the workbench mounts each child App in its sandboxed frame, and storage/methods are the shell installation’s own desktop data.
Ttype alias	MountShell	Render the shell into root; resolves once it is mounted, with the function that removes it again. The shell loads its own code and styles.
Ttype alias	ShellPlatformControls	Settings a shell renders for a host that has none of its own, such as a standalone Oyster: the shell draws them into root, and the host hands controls to its workbench so Apps and the dashboard can open them.
Ttype alias	RequestShellAppAccess	A host’s App-access flow. The host owns admission, current grants and saving; the shell renders the prompt and navigates its own Settings.
Ttype alias	MountPlatformControls	Render the shell’s own Settings using the embedding host’s access authority.
Ttype alias	ShellModule	What a host gets from a picked shell Release’s module.
fnfunction	importShellModule()	Import the picked shell Release’s module from the host’s own origin and check that it exports mountShell, and mountPlatformControls when it offers its own Settings. The host never bundles a shell.

ShellModuleErrorCclass

The picked shell’s module could not be loaded or does not fit the contract.

Extends

• Error

Constructors

Constructor

Signature

new ShellModuleError(message?): ShellModuleError;

Parameters

Parameter	Type
message?	string

Returns

ShellModuleError

Inherited from

Signature

Error.constructor;

Constructor

Signature

new ShellModuleError(message?, options?): ShellModuleError;

Parameters

Parameter	Type
message?	string
options?	ErrorOptions

Returns

ShellModuleError

Inherited from

Signature

Error.constructor;

Properties

name

Signature

readonly name: "ShellModuleError" = "ShellModuleError";

Always ShellModuleError.

Overrides

Signature

Error.name;

ShellMountInputTtype alias

Signature

type ShellMountInput = Readonly<{
  workbench: TeamWorkbenchHostHandle;
  storage: AppStorage;
  methods: Readonly<{
    call: Promise<WhistleJsonValue>;
  }>;
}>;

What a host hands the shell a Team picked. The host composes that shell into its own top-level document, so it runs with the host’s escalated permissions: the workbench mounts each child App in its sandboxed frame, and storage/methods are the shell installation’s own desktop data.

---

MountShellTtype alias

Signature

type MountShell = (root, input) => Promise<() => void>;

Render the shell into root; resolves once it is mounted, with the function that removes it again. The shell loads its own code and styles.

Parameters

Parameter	Type
root	HTMLElement
input	ShellMountInput

Returns

Promise<() => void>

---

ShellPlatformControlsTtype alias

Signature

type ShellPlatformControls = Readonly<{
  controls: WorkbenchHostControls;
  suggestDesktopSettings: void;
  dispose: void;
}>;

Settings a shell renders for a host that has none of its own, such as a standalone Oyster: the shell draws them into root, and the host hands controls to its workbench so Apps and the dashboard can open them.

---

RequestShellAppAccessTtype alias

Signature

type RequestShellAppAccess = (
  target,
  request,
  dialog,
) => Promise<AppPermissionOutcome>;

A host’s App-access flow. The host owns admission, current grants and saving; the shell renders the prompt and navigates its own Settings.

Parameters

Parameter	Type
target	Parameters<WorkbenchHostControls["requestAppAccess"]>[0]
request	AppPermissionRequest
dialog	Readonly<{ ask: Promise<AppPermissionOutcome>; customize: "customize"; }>

Returns

Promise<AppPermissionOutcome>

---

MountPlatformControlsTtype alias

Signature

type MountPlatformControls = (root, input) => Promise<ShellPlatformControls>;

Render the shell’s own Settings using the embedding host’s access authority.

Parameters

Parameter	Type
root	HTMLElement
input	Readonly<{ teamId: string; keysWire: Pick<KeyWire<string>, "issue" | "revoke" | "summary">; requestAppAccess: RequestShellAppAccess; }>

Returns

Promise<ShellPlatformControls>

---

ShellModuleTtype alias

Signature

type ShellModule = Readonly<{
  mountShell: MountShell;
  mountPlatformControls: MountPlatformControls | null;
}>;

What a host gets from a picked shell Release’s module.

importShellModule()fnfunction

Signature

function importShellModule(
  moduleUrl,
  hostOrigin,
): Promise<
  Readonly<{
    mountShell: MountShell;
    mountPlatformControls: MountPlatformControls | null;
  }>
>;

Import the picked shell Release’s module from the host’s own origin and check that it exports mountShell, and mountPlatformControls when it offers its own Settings. The host never bundles a shell.

Parameters

Parameter	Type
moduleUrl	URL
hostOrigin	string

Returns

Promise<Readonly<{ mountShell: MountShell; mountPlatformControls: MountPlatformControls | null; }>>