@inkandswitch/patchwork 0.3.3 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @inkandswitch/patchwork
 
+## 0.4.0
+
+### Minor Changes
+
+- 776b9bb: Boot no longer waits on datatypes it doesn't own. `resolveAccountHandle` writes
+  the account doc directly instead of blocking on `loadWhenReady("account")`, and
+  `createDefaultAccount` builds the root folder, module-settings and anonymous
+  contact subdocs itself rather than waiting for the `folder`,
+  `patchwork:module-settings` and `contact` datatypes. A package bundle that never
+  registers those no longer hangs setup until its timeout.
+
+  `AccountDoc.frameToolId` is now optional. `createDefaultAccount` still writes
+  `"threepane"`, and the router falls back to the first registered `frame-tool`
+  when an account has none.
+
+### Patch Changes
+
+- Updated dependencies [776b9bb]
+  - @inkandswitch/patchwork-plugins@1.2.0
+
 ## 0.3.3
 
 ### Patch Changes

package/dist/createAccount.d.ts

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

package/dist/createAccount.js

@@ -1,18 +1,28 @@
-import { createDocOfDatatype2, getRegistry, } from "@inkandswitch/patchwork-plugins";
+async function createSubdoc(repo, type, init) {
+    const handle = await repo.create2();
+    handle.change((doc) => {
+        doc["@patchwork"] = { type };
+        init(doc);
+    });
+    return handle;
+}
 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];
-    }));
+    const [rootFolder, moduleSettings, contact] = await Promise.all([
+        createSubdoc(repo, "folder", (doc) => {
+            doc.title = "New Folder";
+            doc.docs = [];
+        }),
+        createSubdoc(repo, "patchwork:module-settings", (doc) => {
+            doc.modules = [];
+        }),
+        createSubdoc(repo, "contact", (doc) => {
+            doc.type = "anonymous";
+        }),
+    ]);
     accountHandle.change((doc) => {
-        for (const [field, url] of subdocs)
-            doc[field] = url;
+        doc.frameToolId = "threepane";
+        doc.rootFolderUrl = rootFolder.url;
+        doc.moduleSettingsUrl = moduleSettings.url;
+        doc.contactUrl = contact.url;
     });
 };

package/dist/router.js

@@ -42,6 +42,11 @@ export function docParamToUrl(docParam) {
         return undefined;
     return stringifyAutomergeUrl({ documentId: documentId });
 }
+function registeredFrameToolId() {
+    return getRegistry("patchwork:tool")
+        .filter((tool) => !!tool.tags?.includes("frame-tool") && !tool.unlisted)
+        .at(0)?.id;
+}
 export function createRouter({ rootElement, repo, accountDocHandle, siteName, }) {
     const route = async () => {
         // The first call seeds the root view's tool/doc so it can mount; later
@@ -49,7 +54,12 @@ export function createRouter({ rootElement, repo, accountDocHandle, siteName, })
         if (!rootElement.hasAttribute("tool-id")) {
             const params = new URLSearchParams(location.hash.slice(1));
             const frame = params.get("frame");
-            rootElement.setAttribute("tool-id", frame ?? accountDocHandle.doc().frameToolId);
+            const toolId = frame ?? accountDocHandle.doc().frameToolId ?? registeredFrameToolId();
+            if (!toolId) {
+                console.error("patchwork: no frame tool registered, nothing to mount");
+                return;
+            }
+            rootElement.setAttribute("tool-id", toolId);
             rootElement.setAttribute("doc-url", (frame && docParamToUrl(params.get("doc"))) || accountDocHandle.url);
             return;
         }

package/package.json

@@ -5,7 +5,7 @@
     "url": "git+https://github.com/inkandswitch/patchwork-system.git",
     "directory": "core/patchwork"
   },
-  "version": "0.3.3",
+  "version": "0.4.0",
   "author": "Ink & Switch",
   "type": "module",
   "license": "MIT",
@@ -42,11 +42,11 @@
     "debug": "^4.4.3",
     "sharp": "^0.35.3",
     "vite-plugin-wasm": "^3.6.0",
-    "@inkandswitch/patchwork-bootloader": "^0.5.4",
+    "@inkandswitch/patchwork-plugins": "^1.2.0",
+    "@inkandswitch/patchwork-providers": "^0.5.0",
     "@inkandswitch/patchwork-elements": "^6.0.0",
     "@inkandswitch/patchwork-filesystem": "^0.2.5",
-    "@inkandswitch/patchwork-plugins": "^1.1.0",
-    "@inkandswitch/patchwork-providers": "^0.5.0"
+    "@inkandswitch/patchwork-bootloader": "^0.5.4"
   },
   "devDependencies": {
     "esbuild": "^0.23.1",

package/src/createAccount.ts

@@ -1,31 +1,48 @@
-import {
-  type AccountCreator,
-  type AccountDoc,
-  type DatatypeDescription,
-  createDocOfDatatype2,
-  getRegistry,
+import type { Repo } from "@automerge/automerge-repo/slim";
+import type {
+  AccountCreator,
+  AccountDoc,
 } from "@inkandswitch/patchwork-plugins";
+import type { HasPatchworkMetadata } from "@inkandswitch/patchwork-filesystem";
+
+async function createSubdoc<D>(
+  repo: Repo,
+  type: string,
+  init: (doc: D) => void
+) {
+  const handle = await repo.create2<D & HasPatchworkMetadata>();
+  handle.change((doc: D & HasPatchworkMetadata) => {
+    doc["@patchwork"] = { type };
+    init(doc);
+  });
+  return handle;
+}
 
 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;
-    })
-  );
+  const [rootFolder, moduleSettings, contact] = await Promise.all([
+    createSubdoc<{ title: string; docs: unknown[] }>(repo, "folder", (doc) => {
+      doc.title = "New Folder";
+      doc.docs = [];
+    }),
+    createSubdoc<{ modules: string[] }>(
+      repo,
+      "patchwork:module-settings",
+      (doc) => {
+        doc.modules = [];
+      }
+    ),
+    createSubdoc<{ type: string }>(repo, "contact", (doc) => {
+      doc.type = "anonymous";
+    }),
+  ]);
 
   accountHandle.change((doc) => {
-    for (const [field, url] of subdocs) doc[field] = url;
+    doc.frameToolId = "threepane";
+    doc.rootFolderUrl = rootFolder.url;
+    doc.moduleSettingsUrl = moduleSettings.url;
+    doc.contactUrl = contact.url;
   });
 };

package/src/router.ts

@@ -12,6 +12,7 @@ import {
   type AccountDoc,
   type DatatypeDescription,
   type DatatypeImplementation,
+  type ToolDescription,
   getRegistry,
 } from "@inkandswitch/patchwork-plugins";
 
@@ -71,6 +72,12 @@ export interface Router {
   route(): Promise<void>;
 }
 
+function registeredFrameToolId(): string | undefined {
+  return getRegistry<ToolDescription>("patchwork:tool")
+    .filter((tool) => !!tool.tags?.includes("frame-tool") && !tool.unlisted)
+    .at(0)?.id;
+}
+
 export function createRouter({
   rootElement,
   repo,
@@ -83,10 +90,13 @@ export function createRouter({
     if (!rootElement.hasAttribute("tool-id")) {
       const params = new URLSearchParams(location.hash.slice(1));
       const frame = params.get("frame");
-      rootElement.setAttribute(
-        "tool-id",
-        frame ?? accountDocHandle.doc().frameToolId
-      );
+      const toolId =
+        frame ?? accountDocHandle.doc().frameToolId ?? registeredFrameToolId();
+      if (!toolId) {
+        console.error("patchwork: no frame tool registered, nothing to mount");
+        return;
+      }
+      rootElement.setAttribute("tool-id", toolId);
       rootElement.setAttribute(
         "doc-url",
         (frame && docParamToUrl(params.get("doc"))) || accountDocHandle.url