@inkandswitch/patchwork-bootloader 0.4.0 → 0.4.2

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @inkandswitch/patchwork-bootloader
 
+## 0.4.2
+
+### Patch Changes
+
+- 82bee46: A doc's `suggestedImportUrl` may now be an `automerge:` folder-doc URL as well
+  as an `http(s):` module bundle. When a view finds no built-in tool for a doc, it
+  loads the suggested module either way. Adds `importPackage` (which dispatches on
+  the URL scheme) and `isImportableSuggestedUrl` to `patchwork-filesystem`, and
+  `getSuggestedImportUrl` now honors automerge URLs.
+
+  The package-importing helpers are renamed from `module` to `package`, since they
+  resolve a `package.json` entry point: `importModuleFromFolderDocUrl` →
+  `importPackageFromFolderDocUrl`, `importModuleFromHttpUrl` →
+  `importPackageFromHttpUrl`, and the `ModuleWatcher` `importAutomergeModule` hook
+  (with bootloader's `importAutomergeModuleViaWorker`) → `importAutomergePackage`.
+
+- Updated dependencies [82bee46]
+  - @inkandswitch/patchwork-filesystem@0.2.0
+  - @inkandswitch/patchwork-elements@4.0.0
+  - @inkandswitch/patchwork-plugins@1.0.0
+
+## 0.4.1
+
+### Patch Changes
+
+- Updated dependencies [2d39c84]
+  - @inkandswitch/patchwork-providers@0.4.0
+  - @inkandswitch/patchwork-elements@3.0.0
+
 ## 0.4.0
 
 ### Minor Changes

package/dist/externals.js

@@ -28,6 +28,7 @@ const externals = [
     "@codemirror/state",
     "@codemirror/view",
     "@codemirror/language",
+    "@codemirror/commands",
     // rip
     "solid-js",
     "solid-js/html",

package/dist/module-loader-worker.js

@@ -10,7 +10,7 @@
 //
 // Created with type:"module"; its dynamic `import()` of `/<automergeUrl>/…`
 // entry points is served by the service worker that controls this worker.
-import { importModuleFromFolderDocUrl } from "@inkandswitch/patchwork-filesystem";
+import { importPackageFromFolderDocUrl } from "@inkandswitch/patchwork-filesystem";
 // Keep only the structured-cloneable description fields. `load` is a closure
 // and `module` is the (possibly already-loaded) implementation — neither can
 // cross the worker boundary. `import` is droppable too: the main thread
@@ -33,7 +33,7 @@ self.addEventListener("message", (event) => {
     if (!isDiscoverRequest(data))
         return;
     const { id, url } = data;
-    importModuleFromFolderDocUrl(url)
+    importPackageFromFolderDocUrl(url)
         .then((mod) => {
         const plugins = Array.isArray(mod?.plugins) ? mod.plugins : [];
         const descriptors = plugins.map(toDescriptor);

package/dist/module-loader.d.ts

@@ -3,11 +3,11 @@ type Descriptor = Record<string, unknown> & {
     type?: string;
 };
 /**
- * ModuleWatcher `importAutomergeModule` hook: discover descriptors in the
+ * ModuleWatcher `importAutomergePackage` hook: discover descriptors in the
  * worker, then return the `{ plugins }` shape with a main-thread `load()` per
  * plugin that imports the package at heads and calls its real loader.
  */
-export declare function importAutomergeModuleViaWorker(urlAtHeads: string): Promise<{
+export declare function importAutomergePackageViaWorker(urlAtHeads: string): Promise<{
     plugins: Descriptor[];
 }>;
 export {};

package/dist/module-loader.js

@@ -1,6 +1,6 @@
 // Main-thread client for the module-loader worker (see module-loader-worker.ts).
 //
-// `importAutomergeModuleViaWorker` is wired into the ModuleWatcher in place of
+// `importAutomergePackageViaWorker` is wired into the ModuleWatcher in place of
 // its default (direct, main-thread) package import. It asks the worker to
 // import the package entry point and report which plugins it exports, then
 // returns the same `{ plugins }` shape the watcher already feeds to
@@ -50,11 +50,11 @@ function discoverDescriptors(urlAtHeads) {
     });
 }
 /**
- * ModuleWatcher `importAutomergeModule` hook: discover descriptors in the
+ * ModuleWatcher `importAutomergePackage` hook: discover descriptors in the
  * worker, then return the `{ plugins }` shape with a main-thread `load()` per
  * plugin that imports the package at heads and calls its real loader.
  */
-export async function importAutomergeModuleViaWorker(urlAtHeads) {
+export async function importAutomergePackageViaWorker(urlAtHeads) {
     const url = urlAtHeads;
     const descriptors = await discoverDescriptors(url);
     const plugins = descriptors.map((descriptor) => {

package/dist/site.d.ts

@@ -61,7 +61,7 @@ export interface SiteConfig {
      * folder docs or plain HTTP(S) bundles, so deployment targets can be freely
      * mixed.
      *
-     * Can be overridden at runtime by setting `localStorage.defaultToolsUrl` to
+     * 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.
      */

package/dist/site.js

@@ -23,7 +23,7 @@ import { MemorySigner } from "@automerge/automerge-subduction/slim";
 const siteName = typeof __SITE_NAME__ !== "undefined" ? __SITE_NAME__ : "tiny-patchwork";
 const useKeyhiveSyncServer = typeof __KEYHIVE_SYNC_SERVER__ !== "undefined" && __KEYHIVE_SYNC_SERVER__;
 import { ModuleWatcher } from "@inkandswitch/patchwork-filesystem";
-import { importAutomergeModuleViaWorker } from "./module-loader.js";
+import { importAutomergePackageViaWorker } from "./module-loader.js";
 import { openDocument, registerPatchworkViewElement, } from "@inkandswitch/patchwork-elements";
 import { registerRepoProviderElement } from "@inkandswitch/patchwork-providers";
 import { getRegistry, registerPlugins, resolveAccountHandle, unregisterPlugins, } from "@inkandswitch/patchwork-plugins";
@@ -157,7 +157,7 @@ export async function bootPatchworkSite(config) {
     const moduleWatcher = new ModuleWatcher(repo, buildSystemSources(defaultModuleSources), onModuleLoaded, unregisterPlugins, 
     // Discover an Automerge package's plugin descriptors off the main thread;
     // each plugin's load() re-imports the package (at heads) on this thread.
-    importAutomergeModuleViaWorker);
+    importAutomergePackageViaWorker);
     const accountDocHandle = (await resolveAccountHandle(repo, {
         storageKey: config.accountStorageKey,
         hive,
@@ -204,21 +204,24 @@ function isValidModuleSource(source) {
 }
 /**
  * Resolve the site's default module-list sources, honouring the
- * `localStorage.defaultToolsUrl` dev override (which replaces the entire
+ * `localStorage.systemPackageListURL` dev override (which replaces the entire
  * built-in default bundle).
  */
 function resolveDefaultModules(config) {
     const builtin = config.defaultModules ?? config.defaultModulesUrl ?? [];
     const builtinList = (Array.isArray(builtin) ? builtin : [builtin]).filter(Boolean);
-    const override = globalThis.localStorage?.getItem("defaultToolsUrl");
+    const storage = globalThis.localStorage;
+    // `defaultToolsUrl` is the pre-rename key, still honoured for existing browsers.
+    const override = storage?.getItem("systemPackageListURL") ??
+        storage?.getItem("defaultToolsUrl");
     if (override) {
         if (isValidModuleSource(override)) {
             if (!builtinList.includes(override)) {
-                console.info(`using defaultToolsUrl override from localStorage: ${override}`);
+                console.info(`using systemPackageListURL override from localStorage: ${override}`);
             }
             return [override];
         }
-        console.warn(`ignoring invalid defaultToolsUrl in localStorage: ${override}; using built-in default`);
+        console.warn(`ignoring invalid systemPackageListURL in localStorage: ${override}; using built-in default`);
     }
     if (builtinList.length === 0) {
         throw new Error("bootPatchworkSite: no default module sources configured (set `defaultModules`)");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inkandswitch/patchwork-bootloader",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "author": "chee",
   "type": "module",
   "license": "MIT",
@@ -44,29 +44,29 @@
     }
   },
   "dependencies": {
-    "@automerge/automerge": "3.3.0-fragments.2",
-    "@automerge/automerge-repo": "2.6.0-subduction.44",
-    "@automerge/automerge-repo-network-messagechannel": "2.6.0-subduction.44",
-    "@automerge/automerge-repo-network-websocket": "2.6.0-subduction.44",
-    "@automerge/automerge-repo-storage-indexeddb": "2.6.0-subduction.44",
+    "@automerge/automerge": "3.3.2",
+    "@automerge/automerge-repo": "2.6.0-subduction.46",
+    "@automerge/automerge-repo-network-messagechannel": "2.6.0-subduction.45",
+    "@automerge/automerge-repo-network-websocket": "2.6.0-subduction.45",
+    "@automerge/automerge-repo-storage-indexeddb": "2.6.0-subduction.45",
     "@automerge/automerge-subduction": "0.16.0",
-    "@automerge/vanillajs": "2.6.0-subduction.44",
+    "@automerge/vanillajs": "2.6.0-subduction.45",
     "@keyhive/keyhive": "0.1.0-alpha.5",
     "@types/debug": "^4.1.13",
     "debug": "^4.4.3",
     "resolve.exports": "^2.0.3",
     "service-worker-types": "npm:@types/serviceworker@^0.0.153",
     "tinyargs": "^0.1.4",
-    "@inkandswitch/patchwork-elements": "^2.0.0",
-    "@inkandswitch/patchwork-filesystem": "^0.1.3",
-    "@inkandswitch/patchwork-plugins": "^0.0.11",
-    "@inkandswitch/patchwork-providers": "^0.3.0"
+    "@inkandswitch/patchwork-elements": "^4.0.0",
+    "@inkandswitch/patchwork-filesystem": "^0.2.0",
+    "@inkandswitch/patchwork-plugins": "^1.0.0",
+    "@inkandswitch/patchwork-providers": "^0.4.0"
   },
   "peerDependencies": {
-    "@automerge/automerge": "3.3.0-fragments.2",
-    "@automerge/automerge-repo": "2.6.0-subduction.44",
+    "@automerge/automerge": "3.3.2",
+    "@automerge/automerge-repo": "2.6.0-subduction.46",
     "@automerge/automerge-repo-keyhive": "0.3.0-alpha.sub.8b",
-    "@automerge/vanillajs": "2.6.0-subduction.44"
+    "@automerge/vanillajs": "2.6.0-subduction.45"
   },
   "scripts": {
     "build": "tsc",

package/src/externals.ts

@@ -29,6 +29,7 @@ const externals = [
   "@codemirror/state",
   "@codemirror/view",
   "@codemirror/language",
+  "@codemirror/commands",
 
   // rip
   "solid-js",

package/src/module-loader-worker.ts

@@ -11,7 +11,7 @@
 // Created with type:"module"; its dynamic `import()` of `/<automergeUrl>/…`
 // entry points is served by the service worker that controls this worker.
 
-import { importModuleFromFolderDocUrl } from "@inkandswitch/patchwork-filesystem";
+import { importPackageFromFolderDocUrl } from "@inkandswitch/patchwork-filesystem";
 import type { AutomergeUrl } from "@automerge/automerge-repo/slim";
 
 type DiscoverRequest = {
@@ -45,7 +45,7 @@ self.addEventListener("message", (event: MessageEvent) => {
   if (!isDiscoverRequest(data)) return;
   const { id, url } = data;
 
-  importModuleFromFolderDocUrl(url)
+  importPackageFromFolderDocUrl(url)
     .then((mod) => {
       const plugins: any[] = Array.isArray(mod?.plugins) ? mod.plugins : [];
       const descriptors = plugins.map(toDescriptor);

package/src/module-loader.ts

@@ -1,6 +1,6 @@
 // Main-thread client for the module-loader worker (see module-loader-worker.ts).
 //
-// `importAutomergeModuleViaWorker` is wired into the ModuleWatcher in place of
+// `importAutomergePackageViaWorker` is wired into the ModuleWatcher in place of
 // its default (direct, main-thread) package import. It asks the worker to
 // import the package entry point and report which plugins it exports, then
 // returns the same `{ plugins }` shape the watcher already feeds to
@@ -62,11 +62,11 @@ function discoverDescriptors(urlAtHeads: AutomergeUrl): Promise<Descriptor[]> {
 }
 
 /**
- * ModuleWatcher `importAutomergeModule` hook: discover descriptors in the
+ * ModuleWatcher `importAutomergePackage` hook: discover descriptors in the
  * worker, then return the `{ plugins }` shape with a main-thread `load()` per
  * plugin that imports the package at heads and calls its real loader.
  */
-export async function importAutomergeModuleViaWorker(
+export async function importAutomergePackageViaWorker(
   urlAtHeads: string
 ): Promise<{ plugins: Descriptor[] }> {
   const url = urlAtHeads as AutomergeUrl;

package/src/site.ts

@@ -48,7 +48,7 @@ const useKeyhiveSyncServer =
   typeof __KEYHIVE_SYNC_SERVER__ !== "undefined" && __KEYHIVE_SYNC_SERVER__;
 
 import { ModuleWatcher } from "@inkandswitch/patchwork-filesystem";
-import { importAutomergeModuleViaWorker } from "./module-loader.js";
+import { importAutomergePackageViaWorker } from "./module-loader.js";
 import {
   openDocument,
   registerPatchworkViewElement,
@@ -126,7 +126,7 @@ export interface SiteConfig {
    * folder docs or plain HTTP(S) bundles, so deployment targets can be freely
    * mixed.
    *
-   * Can be overridden at runtime by setting `localStorage.defaultToolsUrl` to
+   * 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.
    */
@@ -322,7 +322,7 @@ export async function bootPatchworkSite(
     unregisterPlugins,
     // Discover an Automerge package's plugin descriptors off the main thread;
     // each plugin's load() re-imports the package (at heads) on this thread.
-    importAutomergeModuleViaWorker
+    importAutomergePackageViaWorker
   );
 
   const accountDocHandle = (await resolveAccountHandle(repo, {
@@ -381,7 +381,7 @@ function isValidModuleSource(source: string): boolean {
 
 /**
  * Resolve the site's default module-list sources, honouring the
- * `localStorage.defaultToolsUrl` dev override (which replaces the entire
+ * `localStorage.systemPackageListURL` dev override (which replaces the entire
  * built-in default bundle).
  */
 function resolveDefaultModules(config: SiteConfig): string[] {
@@ -390,18 +390,22 @@ function resolveDefaultModules(config: SiteConfig): string[] {
     Boolean
   );
 
-  const override = globalThis.localStorage?.getItem("defaultToolsUrl");
+  const storage = globalThis.localStorage;
+  // `defaultToolsUrl` is the pre-rename key, still honoured for existing browsers.
+  const override =
+    storage?.getItem("systemPackageListURL") ??
+    storage?.getItem("defaultToolsUrl");
   if (override) {
     if (isValidModuleSource(override)) {
       if (!builtinList.includes(override)) {
         console.info(
-          `using defaultToolsUrl override from localStorage: ${override}`
+          `using systemPackageListURL override from localStorage: ${override}`
         );
       }
       return [override];
     }
     console.warn(
-      `ignoring invalid defaultToolsUrl in localStorage: ${override}; using built-in default`
+      `ignoring invalid systemPackageListURL in localStorage: ${override}; using built-in default`
     );
   }