@inkandswitch/patchwork-bootloader 0.4.3 → 0.4.4

package/dist/site.d.ts

@@ -1,15 +1,13 @@
 /**
- * High-level browser-app boot sequence for a Patchwork site.
+ * Browser-app boot sequence for a Patchwork site.
  *
- * Layers on top of {@link setupServiceWorker} (the package default export) to
- * construct the Repo, wire up the automerge-worker port, load plugins via the
- * ModuleWatcher, resolve the user's account document, and hand control to the
- * configured root tool.
+ * Layers on top of {@link setupServiceWorker} to construct the Repo, wire up
+ * the automerge-worker port, load plugins via the ModuleWatcher, resolve the
+ * user's account document, and hand control to the configured root tool.
  *
- * This entry point pulls in DOM- and plugin-layer dependencies (patchwork
- * elements, plugins, filesystem) and is intended for use only from a browser
- * site's `main.ts`. Non-UI consumers should import the package default (which
- * only does SW registration and the automerge-worker handoff).
+ * Pulls in DOM- and plugin-layer dependencies, so it is for a browser site's
+ * `main.ts` only. Non-UI consumers should import the package default, which
+ * does SW registration and the automerge-worker handoff and nothing else.
  */
 import { type DocHandle, Repo, type AutomergeUrl } from "@automerge/vanillajs/slim";
 import { type AutomergeRepoKeyhive } from "@automerge/automerge-repo-keyhive";
@@ -17,6 +15,10 @@ import { ModuleWatcher } from "@inkandswitch/patchwork-filesystem";
 import { type AccountDoc } from "@inkandswitch/patchwork-plugins";
 import * as plugins from "@inkandswitch/patchwork-plugins";
 import type { ServiceWorkerRepoChannelListener, SyncStateDocMessage } from "./types.js";
+type SignerIdentity = {
+    peerId: string;
+    verifyingKey: string;
+};
 declare global {
     interface Window {
         accountDocHandle: DocHandle<AccountDoc>;
@@ -30,10 +32,7 @@ declare global {
             packages: ModuleWatcher;
             plugins: typeof plugins;
             accountDocHandle: DocHandle<AccountDoc>;
-            signer?: {
-                peerId: string;
-                verifyingKey: string;
-            };
+            signer?: SignerIdentity;
             sw: {
                 connectClassicSync: (server?: string) => Promise<void>;
                 subscribeToRepoChannel: (listener: ServiceWorkerRepoChannelListener) => Promise<() => void>;
@@ -61,9 +60,7 @@ export interface SiteConfig {
      * folder docs or plain HTTP(S) bundles, so deployment targets can be freely
      * mixed.
      *
-     * Can be overridden at runtime by setting `localStorage.systemPackageListURL` to
-     * another `automerge:` URL or manifest URL — useful for local development
-     * against an unpublished tool set.
+     * Overridable at runtime with `localStorage.systemPackageListURL`.
      */
     defaultModules?: string | string[];
     /**
@@ -82,15 +79,11 @@ export interface SiteConfig {
      * when a document is open. The separator is provided for you.
      */
     titleSuffix: string;
-    /**
-     * DOM id of the `<patchwork-view>` element that will host the root tool.
-     * Defaults to `"root"`.
-     */
+    /** DOM id of the `<patchwork-view>` hosting the root tool. Defaults to "root". */
     rootElementId?: string;
     /**
-     * When true, initialize keyhive for access control.
-     * The Repo will use keyhive's network adapter, peerId, and idFactory
-     * instead of a sharePolicy.
+     * Initialize keyhive for access control. The Repo then uses keyhive's network
+     * adapter, peerId and idFactory instead of a sharePolicy.
      */
     keyhive?: boolean;
 }
@@ -99,13 +92,5 @@ export interface BootResult {
     moduleWatcher: ModuleWatcher;
     accountDocHandle: DocHandle<AccountDoc>;
 }
-/**
- * Boot a Patchwork browser site.
- *
- * Performs the full application-shell setup: service worker + port, Repo,
- * plugin/module loading, account resolution, URL-hash routing, and dev-console
- * globals (`window.repo`, `window.patchwork`, `window.uncache`). Returns the
- * constructed Repo, ModuleWatcher and account handle for sites that want to
- * do additional wiring after boot.
- */
 export declare function bootPatchworkSite(config: SiteConfig): Promise<BootResult>;
+export {};