@inkandswitch/patchwork 0.1.0 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # @inkandswitch/patchwork
 
+## 0.2.1
+
+### Patch Changes
+
+- f00dcb8: Add `repository` metadata pointing at inkandswitch/patchwork-system, so npm links each package to its source directory and can attest provenance when published from CI.
+- Updated dependencies [f00dcb8]
+  - @inkandswitch/patchwork-bootloader@0.5.2
+  - @inkandswitch/patchwork-filesystem@0.2.5
+  - @inkandswitch/patchwork-elements@4.0.4
+  - @inkandswitch/patchwork-plugins@1.0.3
+
+## 0.2.0
+
+### Minor Changes
+
+- 2fffabe: `setup()` now uses `packageListURL` as given instead of letting `localStorage.systemPackageListURL` silently replace it. A site that wants a dev override resolves it itself and passes the result in:
+
+  ```ts
+  const packageListURL =
+    new URLSearchParams(location.search).get("system-package-list") ||
+    localStorage.getItem("systemPackageListURL") ||
+    DEFAULT_PACKAGE_LIST;
+  ```
+
+  This keeps the precedence in one place — the site — so a site can add its own override sources without fighting the library for priority.
+
+### Patch Changes
+
+- 6be3922: Wait for configured modules to load before routing the root view so registered frame tools are available for the initial route.
+- 77bd37c: Expose the account document handle as `window.accountDocHandle` alongside `window.patchwork.account`.
+- 5f70c14: Add `repository` metadata pointing at inkandswitch/patchwork-next, so npm links each package to its source directory and can attest provenance when published from CI.
+- Updated dependencies [5f70c14]
+  - @inkandswitch/patchwork-bootloader@0.5.1
+  - @inkandswitch/patchwork-filesystem@0.2.4
+  - @inkandswitch/patchwork-elements@4.0.3
+  - @inkandswitch/patchwork-plugins@1.0.2
+
 ## 0.1.0
 
 ### Minor Changes

package/dist/client.d.ts

@@ -18,7 +18,7 @@ declare global {
     /**
      * Comma-separated list of default tool-manifest sources the shell boots
      * with. Each entry is an `automerge:` URL or a static `modules.json`
-     * URL. Overridable at runtime via `localStorage.systemPackageListURL`.
+     * URL.
      */
     readonly PATCHWORK_SYSTEM_PACKAGE_LIST_URL?: string;
     /**

package/dist/index.d.ts

@@ -17,12 +17,14 @@
  * `@inkandswitch/patchwork-bootloader` directly, which does SW registration
  * and the automerge-worker handoff and nothing else.
  */
-import { Repo } from "@automerge/vanillajs/slim";
+import { type DocHandle, Repo } from "@automerge/vanillajs/slim";
 import type { AutomergeRepoKeyhive } from "@automerge/automerge-repo-keyhive";
+import { type AccountDoc } from "@inkandswitch/patchwork-plugins";
 import type { Patchwork, PatchworkOptions } from "./types.js";
 declare global {
     interface Window {
         patchwork: Patchwork;
+        accountDocHandle: DocHandle<AccountDoc>;
         repo: Repo;
         Automerge: typeof import("@automerge/automerge");
         AutomergeRepo: typeof import("@automerge/automerge-repo");

package/dist/index.js

@@ -17,7 +17,7 @@
  * `@inkandswitch/patchwork-bootloader` directly, which does SW registration
  * and the automerge-worker handoff and nothing else.
  */
-import { MessageChannelNetworkAdapter, isValidAutomergeUrl, } from "@automerge/vanillajs/slim";
+import { MessageChannelNetworkAdapter, } from "@automerge/vanillajs/slim";
 import * as Automerge from "@automerge/automerge/slim";
 import * as AutomergeRepo from "@automerge/automerge-repo/slim";
 import { ModuleWatcher } from "@inkandswitch/patchwork-filesystem";
@@ -140,10 +140,15 @@ async function doSetup(options) {
         storageKey: options.accountKey ?? "patchworkAccountURL",
         hive,
     }));
+    window.accountDocHandle = accountDocHandle;
     wireModuleSettings(accountDocHandle, moduleWatcher);
+    const toolsLoaded = moduleWatcher.doneLoading.then(() => log("doneLoading, tools registered:", getRegistry("patchwork:tool")
+        .all()
+        .map((t) => t.id)), (err) => console.error("doneLoading rejected:", err));
     let router;
     if (routing !== false) {
         rootElement.style.visibility = "hidden";
+        await toolsLoaded;
         router = createRouter({
             rootElement,
             repo,
@@ -151,9 +156,6 @@ async function doSetup(options) {
             siteName,
         });
     }
-    const toolsLoaded = moduleWatcher.doneLoading.then(() => log("doneLoading, tools registered:", getRegistry("patchwork:tool")
-        .all()
-        .map((t) => t.id)), (err) => console.error("doneLoading rejected:", err));
     installReveal(rootElement, router, toolsLoaded);
     return {
         repo,
@@ -215,25 +217,13 @@ function installReveal(rootElement, router, toolsLoaded) {
     setTimeout(reveal, 12_000);
 }
 // ── Module sources ───────────────────────────────────────────────────────
-function isValidModuleSource(source) {
-    return isValidAutomergeUrl(source) || /^(https?:\/\/|\.?\/)/.test(source);
-}
 /**
- * The site's default module-list sources, honouring the
- * `localStorage.systemPackageListURL` dev override, which replaces the entire
- * built-in bundle.
+ * The site's module-list sources. The site owns any dev overrides and passes
+ * the result in as `packageListURL`.
  */
 function resolveDefaultModules(options) {
     const configured = options.packageListURL ?? [];
     const builtin = (Array.isArray(configured) ? configured : [configured]).filter(Boolean);
-    const override = globalThis.localStorage?.getItem("systemPackageListURL");
-    if (override && isValidModuleSource(override)) {
-        console.info(`using systemPackageListURL from localStorage: ${override}`);
-        return [override];
-    }
-    if (override) {
-        console.warn(`ignoring invalid systemPackageListURL in localStorage: ${override}`);
-    }
     if (builtin.length === 0) {
         throw new Error("patchwork.setup: no default module sources configured (set `packageListURL`)");
     }

package/dist/types.d.ts

@@ -36,8 +36,6 @@ export interface PatchworkOptions {
      * 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.
-     *
-     * Overridable at runtime with `localStorage.systemPackageListURL`.
      */
     packageListURL?: string | string[];
     /**

package/package.json

@@ -1,6 +1,11 @@
 {
   "name": "@inkandswitch/patchwork",
-  "version": "0.1.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/inkandswitch/patchwork-system.git",
+    "directory": "core/patchwork"
+  },
+  "version": "0.2.1",
   "author": "Ink & Switch",
   "type": "module",
   "license": "MIT",
@@ -37,11 +42,11 @@
     "debug": "^4.4.3",
     "sharp": "^0.35.3",
     "vite-plugin-wasm": "^3.6.0",
-    "@inkandswitch/patchwork-bootloader": "^0.5.0",
-    "@inkandswitch/patchwork-elements": "^4.0.2",
-    "@inkandswitch/patchwork-filesystem": "^0.2.3",
-    "@inkandswitch/patchwork-plugins": "^1.0.1",
-    "@inkandswitch/patchwork-providers": "^0.4.2"
+    "@inkandswitch/patchwork-bootloader": "^0.5.2",
+    "@inkandswitch/patchwork-filesystem": "^0.2.5",
+    "@inkandswitch/patchwork-elements": "^4.0.4",
+    "@inkandswitch/patchwork-providers": "^0.4.2",
+    "@inkandswitch/patchwork-plugins": "^1.0.3"
   },
   "devDependencies": {
     "esbuild": "^0.23.1",

package/src/client.d.ts

@@ -18,7 +18,7 @@ declare global {
     /**
      * Comma-separated list of default tool-manifest sources the shell boots
      * with. Each entry is an `automerge:` URL or a static `modules.json`
-     * URL. Overridable at runtime via `localStorage.systemPackageListURL`.
+     * URL.
      */
     readonly PATCHWORK_SYSTEM_PACKAGE_LIST_URL?: string;
     /**

package/src/index.ts

@@ -22,7 +22,6 @@ import {
   type DocHandle,
   MessageChannelNetworkAdapter,
   Repo,
-  isValidAutomergeUrl,
 } from "@automerge/vanillajs/slim";
 import * as Automerge from "@automerge/automerge/slim";
 import * as AutomergeRepo from "@automerge/automerge-repo/slim";
@@ -69,6 +68,7 @@ declare const __SITE_NAME__: string;
 declare global {
   interface Window {
     patchwork: Patchwork;
+    accountDocHandle: DocHandle<AccountDoc>;
     repo: Repo;
     Automerge: typeof import("@automerge/automerge");
     AutomergeRepo: typeof import("@automerge/automerge-repo");
@@ -224,19 +224,9 @@ async function doSetup(options: PatchworkOptions): Promise<Patchwork> {
     hive,
   })) as DocHandle<AccountDoc>;
 
+  window.accountDocHandle = accountDocHandle;
   wireModuleSettings(accountDocHandle, moduleWatcher);
 
-  let router: Router | undefined;
-  if (routing !== false) {
-    rootElement.style.visibility = "hidden";
-    router = createRouter({
-      rootElement,
-      repo,
-      accountDocHandle,
-      siteName,
-    });
-  }
-
   const toolsLoaded = moduleWatcher.doneLoading.then(
     () =>
       log(
@@ -248,6 +238,18 @@ async function doSetup(options: PatchworkOptions): Promise<Patchwork> {
     (err: unknown) => console.error("doneLoading rejected:", err)
   );
 
+  let router: Router | undefined;
+  if (routing !== false) {
+    rootElement.style.visibility = "hidden";
+    await toolsLoaded;
+    router = createRouter({
+      rootElement,
+      repo,
+      accountDocHandle,
+      siteName,
+    });
+  }
+
   installReveal(rootElement, router, toolsLoaded);
 
   return {
@@ -330,14 +332,9 @@ function installReveal(
 
 // ── Module sources ───────────────────────────────────────────────────────
 
-function isValidModuleSource(source: string): boolean {
-  return isValidAutomergeUrl(source) || /^(https?:\/\/|\.?\/)/.test(source);
-}
-
 /**
- * The site's default module-list sources, honouring the
- * `localStorage.systemPackageListURL` dev override, which replaces the entire
- * built-in bundle.
+ * The site's module-list sources. The site owns any dev overrides and passes
+ * the result in as `packageListURL`.
  */
 function resolveDefaultModules(options: PatchworkOptions): string[] {
   const configured = options.packageListURL ?? [];
@@ -345,18 +342,6 @@ function resolveDefaultModules(options: PatchworkOptions): string[] {
     Array.isArray(configured) ? configured : [configured]
   ).filter(Boolean);
 
-  const override = globalThis.localStorage?.getItem("systemPackageListURL");
-
-  if (override && isValidModuleSource(override)) {
-    console.info(`using systemPackageListURL from localStorage: ${override}`);
-    return [override];
-  }
-  if (override) {
-    console.warn(
-      `ignoring invalid systemPackageListURL in localStorage: ${override}`
-    );
-  }
-
   if (builtin.length === 0) {
     throw new Error(
       "patchwork.setup: no default module sources configured (set `packageListURL`)"

package/src/types.ts

@@ -53,8 +53,6 @@ export interface PatchworkOptions {
    * 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.
-   *
-   * Overridable at runtime with `localStorage.systemPackageListURL`.
    */
   packageListURL?: string | string[];