@inkandswitch/patchwork-bootloader 0.4.3 → 0.5.0

package/src/sync-config.ts

@@ -1,7 +1,12 @@
 /** localStorage key: optional override for the classic sync WebSocket URL. */
 export const CLASSIC_SYNC_SERVER_KEY = "patchworkClassicSyncServer";
 
-export const DEFAULT_CLASSIC_SYNC_SERVER = "wss://sync3.automerge.org";
+declare const __CLASSIC_SYNC_SERVER__: string;
+
+export const DEFAULT_CLASSIC_SYNC_SERVER =
+  typeof __CLASSIC_SYNC_SERVER__ !== "undefined"
+    ? __CLASSIC_SYNC_SERVER__
+    : "wss://sync3.automerge.org";
 
 export function readClassicSyncServer(
   storage: Pick<Storage, "getItem"> = globalThis.localStorage

package/dist/site.d.ts

@@ -1,111 +0,0 @@
-/**
- * High-level 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.
- *
- * 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).
- */
-import { type DocHandle, Repo, type AutomergeUrl } from "@automerge/vanillajs/slim";
-import { type AutomergeRepoKeyhive } from "@automerge/automerge-repo-keyhive";
-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";
-declare global {
-    interface Window {
-        accountDocHandle: DocHandle<AccountDoc>;
-        Automerge: typeof import("@automerge/automerge");
-        AutomergeRepo: typeof import("@automerge/automerge-repo");
-        repo: Repo;
-        hive?: AutomergeRepoKeyhive;
-        getRepoChannel: () => MessagePort;
-        patchwork: {
-            repo: Repo;
-            packages: ModuleWatcher;
-            plugins: typeof plugins;
-            accountDocHandle: DocHandle<AccountDoc>;
-            signer?: {
-                peerId: string;
-                verifyingKey: string;
-            };
-            sw: {
-                connectClassicSync: (server?: string) => Promise<void>;
-                subscribeToRepoChannel: (listener: ServiceWorkerRepoChannelListener) => Promise<() => void>;
-                subscribeSyncState: (documentId: string, listener: (update: SyncStateDocMessage) => void) => () => void;
-            };
-        };
-        uncache: (match: string) => Promise<void>;
-    }
-}
-export interface SiteConfig {
-    /**
-     * The site's default tool bundle — the tools every user of this site gets
-     * out of the box. Must collectively contribute at least a
-     * `patchwork:datatype` registration for `"account"` (typically the one
-     * supplied by `@inkandswitch/patchwork-frame`).
-     *
-     * Each entry is a *module-list source* and may be either:
-     *  - an Automerge module-settings doc URL (`automerge:...`), which is
-     *    live-reloaded, or
-     *  - an HTTP(S) URL (absolute or site-relative, e.g. `/modules.json`) to a
-     *    static JSON manifest of the shape `{ modules: string[], branches? }`,
-     *    fetched once at boot.
-     *
-     * The module URLs *inside* either kind of source may themselves be Automerge
-     * 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.
-     */
-    defaultModules?: string | string[];
-    /**
-     * @deprecated Use {@link SiteConfig.defaultModules}. Retained for backwards
-     * compatibility with existing sites.
-     */
-    defaultModulesUrl?: AutomergeUrl;
-    /**
-     * `localStorage` key under which this site remembers which account document
-     * belongs to the current user. Sites sharing an origin MUST use distinct
-     * keys so they do not clobber each other's accounts.
-     */
-    accountStorageKey: string;
-    /**
-     * Brand word appended to the document title as `"<doc> | <titleSuffix>"`
-     * 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"`.
-     */
-    rootElementId?: string;
-    /**
-     * When true, initialize keyhive for access control.
-     * The Repo will use keyhive's network adapter, peerId, and idFactory
-     * instead of a sharePolicy.
-     */
-    keyhive?: boolean;
-}
-export interface BootResult {
-    repo: Repo;
-    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>;