@inkandswitch/patchwork 0.2.1 → 0.3.1

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @inkandswitch/patchwork
 
+## 0.3.1
+
+### Patch Changes
+
+- 896fa22: Resolve built-in import-map packages through Vite during development so the site and dynamically loaded tools share module singletons.
+
+## 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

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.d.ts

@@ -17,14 +17,12 @@
  * `@inkandswitch/patchwork-bootloader` directly, which does SW registration
  * and the automerge-worker handoff and nothing else.
  */
-import { type DocHandle, Repo } from "@automerge/vanillajs/slim";
+import { 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

@@ -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,8 +140,8 @@ async function doSetup(options) {
     const accountDocHandle = (await resolveAccountHandle(repo, {
         storageKey: options.accountKey ?? "patchworkAccountURL",
         hive,
+        createAccount: options.createAccount ?? createDefaultAccount,
     }));
-    window.accountDocHandle = accountDocHandle;
     wireModuleSettings(accountDocHandle, moduleWatcher);
     const toolsLoaded = moduleWatcher.doneLoading.then(() => log("doneLoading, tools registered:", getRegistry("patchwork:tool")
         .all()
@@ -246,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;
@@ -45,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/dist/vite/importmap-plugin.js

@@ -66,14 +66,20 @@ export function importmap(options) {
         },
         transformIndexHtml: {
             order: "pre",
-            handler(html) {
+            handler(html, context) {
+                const activeImportmap = structuredClone(importmap);
+                if (context.server) {
+                    for (const id of Object.keys(builtins)) {
+                        activeImportmap.imports[id] = `/@id/${id}`;
+                    }
+                }
                 return {
                     html,
                     tags: [
                         {
                             tag: "script",
                             attrs: { type: "importmap" },
-                            children: JSON.stringify(importmap, null, 2),
+                            children: JSON.stringify(activeImportmap, null, 2),
                         },
                     ],
                 };

package/package.json

@@ -5,7 +5,7 @@
     "url": "git+https://github.com/inkandswitch/patchwork-system.git",
     "directory": "core/patchwork"
   },
-  "version": "0.2.1",
+  "version": "0.3.1",
   "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.2",
     "@inkandswitch/patchwork-filesystem": "^0.2.5",
-    "@inkandswitch/patchwork-elements": "^4.0.4",
+    "@inkandswitch/patchwork-elements": "^5.0.0",
+    "@inkandswitch/patchwork-plugins": "^1.1.0",
     "@inkandswitch/patchwork-providers": "^0.4.2",
-    "@inkandswitch/patchwork-plugins": "^1.0.3"
+    "@inkandswitch/patchwork-bootloader": "^0.5.3"
   },
   "devDependencies": {
     "esbuild": "^0.23.1",

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

@@ -60,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");
 
@@ -68,7 +69,6 @@ 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");
@@ -222,9 +222,9 @@ async function doSetup(options: PatchworkOptions): Promise<Patchwork> {
   const accountDocHandle = (await resolveAccountHandle(repo, {
     storageKey: options.accountKey ?? "patchworkAccountURL",
     hive,
+    createAccount: options.createAccount ?? createDefaultAccount,
   })) as DocHandle<AccountDoc>;
 
-  window.accountDocHandle = accountDocHandle;
   wireModuleSettings(accountDocHandle, moduleWatcher);
 
   const toolsLoaded = moduleWatcher.doneLoading.then(
@@ -374,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,
@@ -63,6 +62,7 @@ export interface PatchworkOptions {
    * other's accounts.
    */
   accountKey?: string;
+  createAccount?: AccountCreator;
 
   /**
    * Brand word for this site: appended to the document title as

package/src/vite/importmap-plugin.ts

@@ -95,14 +95,20 @@ export function importmap(options?: PatchworkVitePluginOptions): Plugin {
     },
     transformIndexHtml: {
       order: "pre",
-      handler(html) {
+      handler(html, context) {
+        const activeImportmap = structuredClone(importmap);
+        if (context.server) {
+          for (const id of Object.keys(builtins)) {
+            activeImportmap.imports[id] = `/@id/${id}`;
+          }
+        }
         return {
           html,
           tags: [
             {
               tag: "script",
               attrs: { type: "importmap" },
-              children: JSON.stringify(importmap, null, 2),
+              children: JSON.stringify(activeImportmap, null, 2),
             },
           ],
         };