obsidian-dev-utils 91.0.1 → 92.0.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 92.0.0
+
+- test(modals): click the mock modal backdrop instead of a hand-built one
+- feat(demo-vault): warn that the demo vault is a sandbox and enforce the authoring convention
+- feat(modals): minimize a minimizable modal on a background click
+- chore: update libs
+- docs: describe the three test layers instead of claiming unit tests only
+
 ## 91.0.1
 
 - fix(modals): report prompt validity only once touched

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

@@ -447,6 +447,9 @@ __export(main_exports, {
   default: () => DemoVaultHelperPlugin
 });
 module.exports = __toCommonJS(main_exports);
+var import_obsidian3 = require("obsidian");
+
+// src/obsidian/demo-vault-helper.ts
 var import_obsidian2 = require("obsidian");
 
 // src/path.ts
@@ -457,6 +460,20 @@ 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 ESCAPE_MAP = {
   "\n": String.raw`\n`,
@@ -649,13 +666,19 @@ async function resolveCommunityPluginId(reference) {
 var CODE_SCRIPT_TOOLKIT_PLUGIN_ID = "fix-require-modules";
 var CODE_SCRIPT_TOOLKIT_MODULES_ROOT = "_assets/CodeScriptToolkit";
 var CODE_SCRIPT_TOOLKIT_SETTINGS = {
+  defaultCodeButtonConfig: "---\nsourceVisibility: collapsed\n---",
   invocableScriptsFolder: "Invocables",
   modulesRoot: CODE_SCRIPT_TOOLKIT_MODULES_ROOT,
   shouldHandleProtocolUrls: true,
   startupScriptPath: "startup.ts"
 };
+var DEMO_VAULT_HELPER_PLUGIN_ID = "demo-vault-helper";
+var PLUGINS_FOLDER_NAME = "plugins";
+var OPEN_DEMO_VAULT_COMMAND_NAME = "Open demo vault";
+var SANDBOX_NOTICE_DURATION_IN_MILLISECONDS = 0;
 async function bootstrapDemoVault(params) {
   const { app } = params;
+  const demoedPluginId = await getDemoedPluginId(app);
   await installCommunityPlugin({ app, pluginId: CODE_SCRIPT_TOOLKIT_PLUGIN_ID });
   const result = await configureCommunityPlugin({
     app,
@@ -669,6 +692,26 @@ async function bootstrapDemoVault(params) {
     await disableCommunityPlugin({ app, pluginId: CODE_SCRIPT_TOOLKIT_PLUGIN_ID });
     await enableCommunityPlugin({ app, pluginId: CODE_SCRIPT_TOOLKIT_PLUGIN_ID });
   }
+  showSandboxNotice(app, demoedPluginId);
+}
+function buildSandboxNoticeFragment(pluginName, basePath) {
+  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.");
+  });
 }
 async function ensureInvocableScriptsFolder(app) {
   const invocableScriptsFolderPath = join(CODE_SCRIPT_TOOLKIT_MODULES_ROOT, CODE_SCRIPT_TOOLKIT_SETTINGS.invocableScriptsFolder);
@@ -676,9 +719,29 @@ async function ensureInvocableScriptsFolder(app) {
     await app.vault.adapter.mkdir(invocableScriptsFolderPath);
   }
 }
+async function getDemoedPluginId(app) {
+  const pluginsFolderPath = join(app.vault.configDir, PLUGINS_FOLDER_NAME);
+  if (!await app.vault.adapter.exists(pluginsFolderPath)) {
+    return null;
+  }
+  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";
+}
+function showSandboxNotice(app, demoedPluginId) {
+  const pluginName = demoedPluginId === null ? null : app.plugins.manifests[demoedPluginId]?.name ?? demoedPluginId;
+  const fragment = buildSandboxNoticeFragment(pluginName, getVaultBasePath(app));
+  new import_obsidian2.Notice(fragment, SANDBOX_NOTICE_DURATION_IN_MILLISECONDS);
+}
 
 // demo-vault-helper/main.ts
-var DemoVaultHelperPlugin = class extends import_obsidian2.Plugin {
+var DemoVaultHelperPlugin = class extends import_obsidian3.Plugin {
   onload() {
     this.app.workspace.onLayoutReady(() => {
       void this.bootstrap();
@@ -688,7 +751,7 @@ var DemoVaultHelperPlugin = class extends import_obsidian2.Plugin {
     try {
       await bootstrapDemoVault({ app: this.app });
     } catch (error) {
-      new import_obsidian2.Notice(`Demo Vault Helper failed to bootstrap: ${String(error)}`);
+      new import_obsidian3.Notice(`Demo Vault Helper failed to bootstrap: ${String(error)}`);
       console.error(error);
     }
   }