obsidian-dev-utils 92.1.0 → 93.1.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## 93.1.0
+
+- feat(community-plugins)!: apply settings through a running plugin instead of data.json
+
+## 93.0.0
+
+- feat(demo-vault)!: name the demonstrated plugin in the helper settings
+- fix(demo-vault): keep the opener progress notice out of the shared slot
+- feat(notices)!: replace isReusable with a notice mode, adding append
+- feat(workspace): add main-window helpers and scoped window switching
+
 ## 92.1.0
 
 - docs: missing descriptions

package/dist/demo-vault-helper/main.js

@@ -460,21 +460,8 @@ function noop() {
 }
 var noopAsyncSingletonPromise = Promise.resolve();
 
-// src/type-guards.ts
-function assertNonNullable(value, errorOrMessage) {
-  if (value !== null && value !== void 0) {
-    return;
-  }
-  errorOrMessage ??= value === null ? "Value is null" : "Value is undefined";
-  const error = typeof errorOrMessage === "string" ? new Error(errorOrMessage) : errorOrMessage;
-  throw error;
-}
-function ensureNonNullable(value, errorOrMessage) {
-  assertNonNullable(value, errorOrMessage);
-  return value;
-}
-
 // src/string.ts
+var EMPTY = "";
 var ESCAPE_MAP = {
   "\n": String.raw`\n`,
   "\r": String.raw`\r`,
@@ -574,6 +561,13 @@ var DATA_JSON_INDENT = 2;
 async function configureCommunityPlugin(params) {
   const { app, settings } = params;
   const pluginId = await resolveCommunityPluginId(params);
+  const settingsComponent = getSettingsComponent(app.plugins.plugins[pluginId]);
+  if (checkHasEditAndSave(settingsComponent)) {
+    await settingsComponent.editAndSave((pluginSettings) => {
+      Object.assign(pluginSettings, settings);
+    });
+    return "appliedLive" /* AppliedLive */;
+  }
   const dataPath = `${app.vault.configDir}/plugins/${pluginId}/data.json`;
   let data = {};
   if (await app.vault.adapter.exists(dataPath)) {
@@ -632,6 +626,9 @@ async function installCommunityPlugin(params) {
   const manifest = await getPluginManifest(repo, version);
   await app.plugins.installPlugin(repo, version, manifest);
 }
+function checkHasEditAndSave(settingsComponent) {
+  return typeof settingsComponent === "object" && settingsComponent !== null && "editAndSave" in settingsComponent && typeof settingsComponent.editAndSave === "function";
+}
 async function fetchCommunityPluginEntries() {
   const response = await (0, import_obsidian.requestUrl)(COMMUNITY_PLUGINS_URL);
   return response.json;
@@ -650,6 +647,12 @@ async function getPluginManifest(repo, version) {
   const response = await (0, import_obsidian.requestUrl)(`https://github.com/${repo}/releases/download/${version}/manifest.json`);
   return response.json;
 }
+function getSettingsComponent(plugin) {
+  if (typeof plugin !== "object" || plugin === null || !("pluginSettingsComponent" in plugin)) {
+    return null;
+  }
+  return plugin.pluginSettingsComponent;
+}
 async function resolveCommunityPluginId(reference) {
   if ("pluginId" in reference) {
     return reference.pluginId;
@@ -674,6 +677,8 @@ var CODE_SCRIPT_TOOLKIT_SETTINGS = {
 };
 var DEMO_VAULT_HELPER_PLUGIN_ID = "demo-vault-helper";
 var PLUGINS_FOLDER_NAME = "plugins";
+var DATA_JSON_FILE_NAME = "data.json";
+var INVALID_DEMO_VAULT_ERROR_MESSAGE = "Invalid demo vault";
 var OPEN_DEMO_VAULT_COMMAND_NAME = "Open demo vault";
 var SANDBOX_NOTICE_DURATION_IN_MILLISECONDS = 0;
 async function bootstrapDemoVault(params) {
@@ -694,23 +699,17 @@ async function bootstrapDemoVault(params) {
   }
   showSandboxNotice(app, demoedPluginId);
 }
-function buildSandboxNoticeFragment(pluginName, basePath) {
+function buildSandboxNoticeFragment(pluginName) {
   return createFragment((fragment) => {
-    if (pluginName === null) {
-      fragment.appendText("This is a demo vault.");
-    } else {
-      fragment.appendText("This is a demo vault for ");
-      fragment.createEl("b", { text: pluginName });
-      fragment.appendText(".");
-    }
-    fragment.appendText(" It is a temporary sandbox");
-    if (basePath !== null) {
-      fragment.appendText(" at ");
-      fragment.createEl("code", { text: basePath });
-    }
-    fragment.appendText(", cleaned up automatically about a day after you last use it \u2014 copy anything you want to keep into your own vault. Running ");
-    fragment.createEl("b", { text: pluginName === null ? OPEN_DEMO_VAULT_COMMAND_NAME : `${pluginName}: ${OPEN_DEMO_VAULT_COMMAND_NAME}` });
-    fragment.appendText(" again creates a new copy with the latest plugin version, so your notes will not appear in it.");
+    fragment.appendText("This is a demo vault for ");
+    fragment.createEl("b", { text: pluginName });
+    fragment.appendText(".");
+    fragment.createEl("br");
+    fragment.appendText("It is a temporary sandbox, cleaned up automatically about a day after you last use it.");
+    fragment.createEl("br");
+    fragment.appendText("Executing ");
+    fragment.createEl("b", { text: `${pluginName}: ${OPEN_DEMO_VAULT_COMMAND_NAME}` });
+    fragment.appendText(" command again creates a new copy with the latest plugin version, so your notes will not appear in it.");
   });
 }
 async function ensureInvocableScriptsFolder(app) {
@@ -720,23 +719,26 @@ async function ensureInvocableScriptsFolder(app) {
   }
 }
 async function getDemoedPluginId(app) {
-  const pluginsFolderPath = join(app.vault.configDir, PLUGINS_FOLDER_NAME);
-  if (!await app.vault.adapter.exists(pluginsFolderPath)) {
-    return null;
+  const settingsPath = join(app.vault.configDir, PLUGINS_FOLDER_NAME, DEMO_VAULT_HELPER_PLUGIN_ID, DATA_JSON_FILE_NAME);
+  if (!await app.vault.adapter.exists(settingsPath)) {
+    throw new Error(INVALID_DEMO_VAULT_ERROR_MESSAGE);
   }
-  const listedFiles = await app.vault.adapter.list(pluginsFolderPath);
-  const demoedPluginIds = listedFiles.folders.map((folderPath) => basename(folderPath)).filter((pluginId) => pluginId !== DEMO_VAULT_HELPER_PLUGIN_ID);
-  return demoedPluginIds.length === 1 ? ensureNonNullable(demoedPluginIds[0]) : null;
-}
-function getVaultBasePath(app) {
-  return isBasePathAdapter(app.vault.adapter) ? app.vault.adapter.getBasePath() : null;
-}
-function isBasePathAdapter(adapter) {
-  return typeof Reflect.get(adapter, "getBasePath") === "function";
+  let parsed;
+  try {
+    parsed = JSON.parse(await app.vault.adapter.read(settingsPath));
+  } catch (error) {
+    throw new Error(INVALID_DEMO_VAULT_ERROR_MESSAGE, { cause: error });
+  }
+  const demoedPluginId = parsed?.demoedPluginId;
+  if (typeof demoedPluginId !== "string" || demoedPluginId === EMPTY) {
+    throw new Error(INVALID_DEMO_VAULT_ERROR_MESSAGE);
+  }
+  return demoedPluginId;
 }
 function showSandboxNotice(app, demoedPluginId) {
-  const pluginName = demoedPluginId === null ? null : app.plugins.manifests[demoedPluginId]?.name ?? demoedPluginId;
-  const fragment = buildSandboxNoticeFragment(pluginName, getVaultBasePath(app));
+  const pluginName = app.plugins.manifests[demoedPluginId]?.name ?? demoedPluginId;
+  const fragment = buildSandboxNoticeFragment(pluginName);
+  app.setting.close();
   new import_obsidian2.Notice(fragment, SANDBOX_NOTICE_DURATION_IN_MILLISECONDS);
 }