@fungi.computer/oyster 0.1.0 → 0.3.0

package/docs/api/browser/boot.md

@@ -0,0 +1,132 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/oyster**](../README.md)
+
+---
+
+[@fungi.computer/oyster](../modules.md) / browser/boot
+
+# browser/boot
+
+## Type Aliases
+
+### BootPageTarget
+
+```ts
+type BootPageTarget = Readonly<{
+  origin: string;
+  releaseId: string;
+  capability: Readonly<{
+    header: string;
+    token: string;
+  }>;
+  deadlineAt: number;
+}>;
+```
+
+One boot check: the host's capability-route origin, the candidate and its token.
+
+---
+
+### BootPageFailedPredicate
+
+```ts
+type BootPageFailedPredicate =
+  | "unexpected_candidate_request"
+  | "response_status"
+  | "request_failed"
+  | "page_error"
+  | "candidate_not_mounted";
+```
+
+Why a page that loaded did not count as mounted; the first observed wins.
+
+---
+
+### BootPageFailedRequest
+
+```ts
+type BootPageFailedRequest = Readonly<{
+  path: string;
+  status?: number;
+  failureKind:
+    "unexpected_candidate_request" | "response_status" | "request_failed";
+}>;
+```
+
+One failed request, by path only (`out-of-scope` for another origin).
+
+---
+
+### BootPageDiagnostics
+
+```ts
+type BootPageDiagnostics = Readonly<{
+  failedPredicate: BootPageFailedPredicate;
+  finalUrlPath: string;
+  consoleErrors: readonly string[];
+  pageErrors: readonly string[];
+  failedRequests: readonly BootPageFailedRequest[];
+  droppedCount: number;
+}>;
+```
+
+Bounded, page-supplied observations; the host's boot gate sanitizes the text.
+
+---
+
+### BootPageResult
+
+```ts
+type BootPageResult =
+  | Readonly<{
+      kind: "mounted";
+    }>
+  | Readonly<{
+      kind: "refused";
+      code: "ui_mount_failed";
+      diagnostics: BootPageDiagnostics;
+    }>
+  | Readonly<{
+      kind: "refused";
+      code: "boot_timeout" | "boot_cleanup_failed" | "boot_runner_unavailable";
+    }>;
+```
+
+The boot check's closed outcome.
+
+## Variables
+
+### BOOT\_CHECK\_VERSION
+
+```ts
+const BOOT_CHECK_VERSION: "boot-page-v2" = "boot-page-v2";
+```
+
+The version of this check's judgement. A recorded result is reused only for the
+same version; changing what counts as mounted, or what is recordable as a
+verdict, bumps it. v2: a host or transport failure (the parent page not loading,
+a dropped browser) is never a verdict.
+
+## Functions
+
+### checkBootPage()
+
+```ts
+function checkBootPage(sessions, target): Promise<BootPageResult>;
+```
+
+Open one candidate's pinned boot page on a dedicated provider session, wait for
+its UI to mount, and confirm the session closed. Cleanup uncertainty outranks
+every other outcome.
+
+#### Parameters
+
+| Parameter  | Type                                               |
+| ---------- | -------------------------------------------------- |
+| `sessions` | [`BrowserSessions`](../browser.md#browsersessions) |
+| `target`   | [`BootPageTarget`](#bootpagetarget)                |
+
+#### Returns
+
+`Promise`\<[`BootPageResult`](#bootpageresult)\>