@inkandswitch/patchwork 0.1.0 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,55 @@
 # @inkandswitch/patchwork
 
+## 0.3.0
+
+### Minor Changes
+
+- 9e6e0e0: Add a `createAccount` setup option, create required account subdocuments before exposing a fresh account, and stop exposing the account handle as `window.accountDocHandle`.
+
+### Patch Changes
+
+- Updated dependencies [9e6e0e0]
+  - @inkandswitch/patchwork-plugins@1.1.0
+  - @inkandswitch/patchwork-elements@5.0.0
+  - @inkandswitch/patchwork-bootloader@0.5.3
+
+## 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/createAccount.d.ts

@@ -0,0 +1,2 @@
+import { type AccountCreator, type AccountDoc } from "@inkandswitch/patchwork-plugins";
+export declare const createDefaultAccount: AccountCreator<AccountDoc>;

package/dist/createAccount.js

@@ -0,0 +1,18 @@
+import { createDocOfDatatype2, getRegistry, } from "@inkandswitch/patchwork-plugins";
+export const createDefaultAccount = async (accountHandle, repo) => {
+    const fields = [
+        ["rootFolderUrl", "folder"],
+        ["moduleSettingsUrl", "patchwork:module-settings"],
+        ["contactUrl", "contact"],
+    ];
+    const registry = getRegistry("patchwork:datatype");
+    const subdocs = await Promise.all(fields.map(async ([field, datatypeId]) => {
+        const datatype = await registry.loadWhenReady(datatypeId);
+        const handle = await createDocOfDatatype2(datatype, repo);
+        return [field, handle.url];
+    }));
+    accountHandle.change((doc) => {
+        for (const [field, url] of subdocs)
+            doc[field] = url;
+    });
+};

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";
@@ -30,6 +30,7 @@ import setupServiceWorker, { lifecycleLog, } from "@inkandswitch/patchwork-bootl
 import debug from "debug";
 import { createRepo, firstRepoPort, initWasm, removeAdapterFor, } from "./repo.js";
 import { createRouter } from "./router.js";
+import { createDefaultAccount } from "./createAccount.js";
 const log = debug("patchwork:setup");
 // ── Setup ────────────────────────────────────────────────────────────────
 let setupCalled = false;
@@ -139,11 +140,16 @@ async function doSetup(options) {
     const accountDocHandle = (await resolveAccountHandle(repo, {
         storageKey: options.accountKey ?? "patchworkAccountURL",
         hive,
+        createAccount: options.createAccount ?? createDefaultAccount,
     }));
     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 +157,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 +218,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`)");
     }
@@ -256,8 +247,7 @@ function onModuleLoaded(name, mod) {
     registerPlugins(mod.plugins, name);
 }
 /**
- * The frame lazy-creates `moduleSettingsUrl` on first mount, so watch for it to
- * appear and feed it to the ModuleWatcher.
+ * Feed the account's module settings document to the ModuleWatcher.
  */
 function wireModuleSettings(accountDocHandle, moduleWatcher) {
     const wire = () => {

package/dist/types.d.ts

@@ -1,7 +1,7 @@
 import type { AutomergeUrl, DocHandle, Repo } from "@automerge/vanillajs/slim";
 import type { AutomergeRepoKeyhive } from "@automerge/automerge-repo-keyhive";
 import type { ModuleWatcher, HasPatchworkMetadata } from "@inkandswitch/patchwork-filesystem";
-import type { AccountDoc } from "@inkandswitch/patchwork-plugins";
+import type { AccountCreator, AccountDoc } from "@inkandswitch/patchwork-plugins";
 import type { ServiceWorkerRepoChannelListener, SyncStateDocMessage } from "@inkandswitch/patchwork-bootloader/types";
 import type * as pluginsNS from "@inkandswitch/patchwork-plugins";
 export type PluginsApi = typeof pluginsNS;
@@ -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[];
     /**
@@ -47,6 +45,7 @@ export interface PatchworkOptions {
      * other's accounts.
      */
     accountKey?: string;
+    createAccount?: AccountCreator;
     /**
      * Brand word for this site: appended to the document title as
      * `"<doc> | <name>"` when a document is open (the separator is provided

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.3.0",
   "author": "Ink & Switch",
   "type": "module",
   "license": "MIT",
@@ -37,10 +42,10 @@
     "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-bootloader": "^0.5.3",
+    "@inkandswitch/patchwork-elements": "^5.0.0",
+    "@inkandswitch/patchwork-plugins": "^1.1.0",
+    "@inkandswitch/patchwork-filesystem": "^0.2.5",
     "@inkandswitch/patchwork-providers": "^0.4.2"
   },
   "devDependencies": {

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/createAccount.ts

@@ -0,0 +1,31 @@
+import {
+  type AccountCreator,
+  type AccountDoc,
+  type DatatypeDescription,
+  createDocOfDatatype2,
+  getRegistry,
+} from "@inkandswitch/patchwork-plugins";
+
+export const createDefaultAccount: AccountCreator<AccountDoc> = async (
+  accountHandle,
+  repo
+) => {
+  const fields = [
+    ["rootFolderUrl", "folder"],
+    ["moduleSettingsUrl", "patchwork:module-settings"],
+    ["contactUrl", "contact"],
+  ] as const;
+  const registry = getRegistry<DatatypeDescription>("patchwork:datatype");
+
+  const subdocs = await Promise.all(
+    fields.map(async ([field, datatypeId]) => {
+      const datatype = await registry.loadWhenReady(datatypeId);
+      const handle = await createDocOfDatatype2(datatype, repo);
+      return [field, handle.url] as const;
+    })
+  );
+
+  accountHandle.change((doc) => {
+    for (const [field, url] of subdocs) doc[field] = url;
+  });
+};

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";
@@ -61,6 +60,7 @@ import {
   removeAdapterFor,
 } from "./repo.js";
 import { createRouter, type Router } from "./router.js";
+import { createDefaultAccount } from "./createAccount.js";
 
 const log = debug("patchwork:setup");
 
@@ -222,21 +222,11 @@ async function doSetup(options: PatchworkOptions): Promise<Patchwork> {
   const accountDocHandle = (await resolveAccountHandle(repo, {
     storageKey: options.accountKey ?? "patchworkAccountURL",
     hive,
+    createAccount: options.createAccount ?? createDefaultAccount,
   })) as DocHandle<AccountDoc>;
 
   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`)"
@@ -389,8 +374,7 @@ function onModuleLoaded(name: string, mod: any): void {
 }
 
 /**
- * The frame lazy-creates `moduleSettingsUrl` on first mount, so watch for it to
- * appear and feed it to the ModuleWatcher.
+ * Feed the account's module settings document to the ModuleWatcher.
  */
 function wireModuleSettings(
   accountDocHandle: DocHandle<AccountDoc>,

package/src/types.ts

@@ -1,14 +1,13 @@
-import type {
-  AutomergeUrl,
-  DocHandle,
-  Repo,
-} from "@automerge/vanillajs/slim";
+import type { AutomergeUrl, DocHandle, Repo } from "@automerge/vanillajs/slim";
 import type { AutomergeRepoKeyhive } from "@automerge/automerge-repo-keyhive";
 import type {
   ModuleWatcher,
   HasPatchworkMetadata,
 } from "@inkandswitch/patchwork-filesystem";
-import type { AccountDoc } from "@inkandswitch/patchwork-plugins";
+import type {
+  AccountCreator,
+  AccountDoc,
+} from "@inkandswitch/patchwork-plugins";
 import type {
   ServiceWorkerRepoChannelListener,
   SyncStateDocMessage,
@@ -53,8 +52,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[];
 
@@ -65,6 +62,7 @@ export interface PatchworkOptions {
    * other's accounts.
    */
   accountKey?: string;
+  createAccount?: AccountCreator;
 
   /**
    * Brand word for this site: appended to the document title as