@mnaoumov/obsidian-lib 0.0.0 → 1.0.1

package/dist/lib/cjs/components/notebook-navigator-menu-event-registrar-component.d.cts

@@ -0,0 +1,150 @@
+/// <reference path="../library.d.cts" />
+/**
+ * @file
+ *
+ * Bridges the file and files context-menu events into Notebook Navigator's own menus.
+ *
+ * Notebook Navigator draws its own file tree and never raises Obsidian's `file-menu` / `files-menu`
+ * workspace events, so a plugin's context-menu items vanish for anyone browsing through it. This
+ * component is a {@link MenuEventRegistrar} backed by Notebook Navigator's extension API instead of
+ * the workspace, so the very same handlers reach both surfaces.
+ */
+import type { DisposableEx } from '@mnaoumov/typescript-lib/disposable' with { 'resolution-mode': 'import' };
+import type { App, IconName } from 'obsidian' with { 'resolution-mode': 'import' };
+import type { EditorMenuEventHandler, FileMenuEventHandler, FilesMenuEventHandler, MarkdownViewportMenuEventHandler, MenuEventRegistrar } from '../menu-event-registrar.cjs';
+import { LayoutReadyComponent } from './layout-ready-component.cjs';
+/**
+ * Parameters for {@link NotebookNavigatorMenuEventRegistrarComponent}.
+ */
+export interface NotebookNavigatorMenuEventRegistrarComponentConstructorParams {
+    /**
+     * The application instance.
+     */
+    readonly app: App;
+    /**
+     * The plugin's display name, which titles the parent entry.
+     */
+    readonly pluginName: string;
+    /**
+     * The icon for the parent entry.
+     *
+     * @default `''` (no icon)
+     */
+    readonly submenuIcon?: IconName | undefined;
+}
+/**
+ * {@link MenuEventRegistrar} backed by Notebook Navigator's menu-extension API.
+ *
+ * Handlers registered here are collected eagerly and bound to Notebook Navigator once the workspace
+ * layout is ready. When Notebook Navigator is not installed the component simply stays dormant.
+ *
+ * Every collected handler writes into a plugin-titled parent entry's submenu, so a handler must NOT
+ * declare a section submenu of its own — `Menu.sort()` would fold that into a second, nested
+ * plugin-titled entry. `CommandHandlerComponent` takes care of this by forcing
+ * `CommandHandlerRegistrationContext.shouldAddCommandToSubmenu` off for the surfaces it feeds here.
+ */
+export declare class NotebookNavigatorMenuEventRegistrarComponent extends LayoutReadyComponent implements MenuEventRegistrar {
+    /**
+     * The plugin's display name, which titles the parent entry.
+     */
+    protected readonly pluginName: string;
+    /**
+     * The icon for the parent entry.
+     */
+    protected readonly submenuIcon: IconName;
+    private fileMenuEventHandlers;
+    private filesMenuEventHandlers;
+    /**
+     * Creates a new Notebook Navigator menu event registrar.
+     *
+     * @param params - The parameters for the component.
+     */
+    constructor(params: NotebookNavigatorMenuEventRegistrarComponentConstructorParams);
+    /**
+     * Accepts an editor-menu registration and does nothing with it.
+     *
+     * Notebook Navigator extends the file tree, not the editor — an editor menu there is Obsidian's
+     * own, which the handlers already reach through the workspace event. The registration is inert
+     * rather than refused so a handler that declares one is not a load-time error.
+     *
+     * @param _handler - The handler, deliberately unused.
+     * @returns A {@link DisposableEx} that has nothing to undo.
+     */
+    registerEditorMenuEventHandler(_handler: EditorMenuEventHandler): DisposableEx;
+    /**
+     * Collects a single-file menu handler.
+     *
+     * @param handler - The handler to collect.
+     * @returns A {@link DisposableEx} that drops the handler again (or on component unload).
+     */
+    registerFileMenuEventHandler(handler: FileMenuEventHandler): DisposableEx;
+    /**
+     * Collects a multi-file menu handler.
+     *
+     * @param handler - The handler to collect.
+     * @returns A {@link DisposableEx} that drops the handler again (or on component unload).
+     */
+    registerFilesMenuEventHandler(handler: FilesMenuEventHandler): DisposableEx;
+    /**
+     * Accepts a markdown-viewport-menu registration and does nothing with it.
+     *
+     * Notebook Navigator extends the file tree, not the editor — the margin beside a note's text is
+     * Obsidian's own viewport, which the handlers already reach through the workspace event. The
+     * registration is inert rather than refused so a handler that declares one is not a load-time error.
+     *
+     * @param _handler - The handler, deliberately unused.
+     * @returns A {@link DisposableEx} that has nothing to undo.
+     */
+    registerMarkdownViewportMenuEventHandler(_handler: MarkdownViewportMenuEventHandler): DisposableEx;
+    /**
+     * Binds to Notebook Navigator once every plugin has loaded.
+     *
+     * Layout-ready rather than `onload`: plugin load order is not ours to choose, and Notebook
+     * Navigator's API only exists once its own plugin is up. When it is not installed the component
+     * stays dormant — enabling it later takes an Obsidian reload, exactly as it does for anything else
+     * that reads another plugin at startup.
+     */
+    protected onLayoutReady(): void;
+    /**
+     * Adds the plugin's entry, unless the handlers had nothing to contribute.
+     *
+     * The menu is populated TWICE, and both runs are needed: Notebook Navigator's `addItem` cannot be
+     * taken back once called, so the only way to keep an unrelated file's menu clean is to ask the
+     * handlers first, against a menu nobody sees. The gates they answer with are metadata reads, so the
+     * second run costs nothing and cannot disagree with the first.
+     *
+     * @param context - The Notebook Navigator menu being built.
+     * @param populate - Runs the collected handlers against a menu.
+     */
+    private contribute;
+    /**
+     * Handles a file menu, single or multi-selection.
+     *
+     * @param context - The Notebook Navigator menu being built.
+     */
+    private handleFileMenu;
+    /**
+     * Handles a folder menu.
+     *
+     * A folder goes through the SINGLE-file handlers, because that is how Obsidian's own `file-menu`
+     * carries one — the event is typed {@link TAbstractFile}, and the folder handlers are the ones that
+     * narrow it.
+     *
+     * @param context - The Notebook Navigator menu being built.
+     */
+    private handleFolderMenu;
+    /**
+     * Runs the single-file handlers against a menu.
+     *
+     * @param menu - The menu to populate.
+     * @param abstractFile - The file or folder the menu was raised on.
+     */
+    private runFileMenuHandlers;
+    /**
+     * Runs the multi-file handlers against a menu.
+     *
+     * @param menu - The menu to populate.
+     * @param abstractFiles - The files the menu was raised on.
+     */
+    private runFilesMenuHandlers;
+}

package/dist/lib/cjs/components/plugin-context-component.cjs

@@ -0,0 +1,180 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+(function () {
+function ensureDisposeSymbols(symbolConstructor = Symbol) {
+  symbolConstructor.asyncDispose ??= symbolConstructor.for("Symbol.asyncDispose");
+  symbolConstructor.dispose ??= symbolConstructor.for("Symbol.dispose");
+}
+
+function ensureBrowserProcess() {
+  const browserProcess = {
+    browser: true,
+    cwd() {
+      return "/";
+    },
+    env: {},
+    platform: "android"
+  };
+  const existingProcess = globalThis.process;
+  if (!existingProcess) {
+    globalThis.process = browserProcess;
+    return;
+  }
+  if (existingProcess.versions?.node) {
+    return;
+  }
+  const existingProcessRecord = existingProcess;
+  for (const [key, value] of Object.entries(browserProcess)) {
+    existingProcessRecord[key] ??= value;
+  }
+  existingProcessRecord["browser"] = true;
+}
+
+function keepName($unknown) {
+  return $unknown;
+}
+
+(function initCjs() {
+  const globalThisRecord = globalThis;
+  ensureDisposeSymbols();
+  globalThisRecord["__name"] ??= keepName;
+  globalThisRecord["__extractDefault"] ??= extractDefault;
+  ensureBrowserProcess();
+  function extractDefault(module) {
+    return module && module.__esModule && "default" in module ? module.default : module;
+  }
+})();
+})();
+(function patchObsidianRequire() {
+  const originalRequire = require;
+  if (!originalRequire || originalRequire.__isPatched) {
+    return;
+  }
+  require = Object.assign(
+    (id) => requirePatched(id),
+    originalRequire,
+    {
+      __isPatched: true
+    }
+  );
+  function extractDefault(module) {
+    return module && module.__esModule && "default" in module ? module.default : module;
+  }
+  const OBSIDIAN_BUILT_IN_MODULE_NAMES = /* @__PURE__ */ new Set([
+    "@codemirror/autocomplete",
+    "@codemirror/collab",
+    "@codemirror/commands",
+    "@codemirror/language",
+    "@codemirror/lint",
+    "@codemirror/search",
+    "@codemirror/state",
+    "@codemirror/text",
+    "@codemirror/view",
+    "@lezer/common",
+    "@lezer/highlight",
+    "@lezer/lr",
+    "obsidian"
+  ]);
+  const DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES = /* @__PURE__ */ new Set([
+    "@codemirror/closebrackets",
+    "@codemirror/comment",
+    "@codemirror/fold",
+    "@codemirror/gutter",
+    "@codemirror/highlight",
+    "@codemirror/history",
+    "@codemirror/matchbrackets",
+    "@codemirror/panel",
+    "@codemirror/rangeset",
+    "@codemirror/rectangular-selection",
+    "@codemirror/stream-parser",
+    "@codemirror/tooltip"
+  ]);
+  function requirePatched(id) {
+    if (OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id) || DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id)) {
+      return originalRequire?.(id);
+    }
+    if (globalThis.app.isMobile) {
+      if (id === "process" || id === "node:process") {
+        console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Fake process object is returned instead.`);
+        return process;
+      }
+    } else {
+      const module = originalRequire?.(id);
+      if (module) {
+        return extractDefault(module);
+      }
+    }
+    console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Empty object is returned instead.`);
+    return {};
+  }
+})();
+
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var plugin_context_component_exports = {};
+__export(plugin_context_component_exports, {
+  PluginContextComponent: () => PluginContextComponent
+});
+module.exports = __toCommonJS(plugin_context_component_exports);
+var import_library = require('@mnaoumov/typescript-lib/library');
+var import_library2 = require('../library.cjs');
+var import_plugin_context = require('../plugin/plugin-context.cjs');
+var import_all_windows_event_component = require('./all-windows-event-component.cjs');
+var import_component_ex = require('./component-ex.cjs');
+class PluginContextComponent extends import_component_ex.ComponentEx {
+  /**
+   * The Obsidian app instance.
+   */
+  app;
+  /**
+   * The plugin ID used to initialize the plugin context and debug controller.
+   */
+  pluginId;
+  /**
+   * Creates a new plugin context component.
+   *
+   * @param params - The constructor parameters.
+   */
+  constructor(params) {
+    super();
+    this.app = params.app;
+    this.pluginId = params.pluginId;
+  }
+  /**
+   * Initializes the plugin context and debug controller.
+   */
+  onload() {
+    (0, import_plugin_context.initPluginContext)(this.pluginId);
+    this.register(() => {
+      import_library.Library.resetToDefault();
+      import_library2.ObsidianLibrary.resetToDefault();
+    });
+    this.addChild(new import_all_windows_event_component.AllWindowsEventComponent(this.app)).registerAllWindowsHandler((win) => {
+      (0, import_plugin_context.initDebugController)(win, this);
+    });
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PluginContextComponent
+});
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL2NvbXBvbmVudHMvcGx1Z2luLWNvbnRleHQtY29tcG9uZW50LnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyIvKipcbiAqIEBmaWxlXG4gKlxuICogQ29tcG9uZW50IHRoYXQgaW5pdGlhbGl6ZXMgdGhlIHBsdWdpbiBjb250ZXh0LCBkZWJ1ZyBjb250cm9sbGVyLCBhbmQgbGlicmFyeSBzdHlsZXMuXG4gKi9cblxuaW1wb3J0IHR5cGUgeyBBcHAgfSBmcm9tICdvYnNpZGlhbic7XG5cbmltcG9ydCB7IExpYnJhcnkgfSBmcm9tICdAbW5hb3Vtb3YvdHlwZXNjcmlwdC1saWIvbGlicmFyeSc7XG5cbmltcG9ydCB7IE9ic2lkaWFuTGlicmFyeSB9IGZyb20gJy4uL2xpYnJhcnkudHMnO1xuaW1wb3J0IHtcbiAgaW5pdERlYnVnQ29udHJvbGxlcixcbiAgaW5pdFBsdWdpbkNvbnRleHRcbn0gZnJvbSAnLi4vcGx1Z2luL3BsdWdpbi1jb250ZXh0LnRzJztcbmltcG9ydCB7IEFsbFdpbmRvd3NFdmVudENvbXBvbmVudCB9IGZyb20gJy4vYWxsLXdpbmRvd3MtZXZlbnQtY29tcG9uZW50LnRzJztcbmltcG9ydCB7IENvbXBvbmVudEV4IH0gZnJvbSAnLi9jb21wb25lbnQtZXgudHMnO1xuXG5pbnRlcmZhY2UgUGx1Z2luQ29udGV4dENvbXBvbmVudENvbnN0cnVjdG9yUGFyYW1zIHtcbiAgcmVhZG9ubHkgYXBwOiBBcHA7XG4gIHJlYWRvbmx5IHBsdWdpbklkOiBzdHJpbmc7XG59XG5cbi8qKlxuICogSW5pdGlhbGl6ZXMgcGx1Z2luIGNvbnRleHQgKHBsdWdpbiBJRCwgZGVidWcgY29udHJvbGxlciwgbGlicmFyeSBzdHlsZXMpIG9uIGxvYWQuXG4gKi9cbmV4cG9ydCBjbGFzcyBQbHVnaW5Db250ZXh0Q29tcG9uZW50IGV4dGVuZHMgQ29tcG9uZW50RXgge1xuICAvKipcbiAgICogVGhlIE9ic2lkaWFuIGFwcCBpbnN0YW5jZS5cbiAgICovXG4gIHByb3RlY3RlZCByZWFkb25seSBhcHA6IEFwcDtcblxuICAvKipcbiAgICogVGhlIHBsdWdpbiBJRCB1c2VkIHRvIGluaXRpYWxpemUgdGhlIHBsdWdpbiBjb250ZXh0IGFuZCBkZWJ1ZyBjb250cm9sbGVyLlxuICAgKi9cbiAgcHJvdGVjdGVkIHJlYWRvbmx5IHBsdWdpbklkOiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIENyZWF0ZXMgYSBuZXcgcGx1Z2luIGNvbnRleHQgY29tcG9uZW50LlxuICAgKlxuICAgKiBAcGFyYW0gcGFyYW1zIC0gVGhlIGNvbnN0cnVjdG9yIHBhcmFtZXRlcnMuXG4gICAqL1xuICBwdWJsaWMgY29uc3RydWN0b3IocGFyYW1zOiBQbHVnaW5Db250ZXh0Q29tcG9uZW50Q29uc3RydWN0b3JQYXJhbXMpIHtcbiAgICBzdXBlcigpO1xuICAgIHRoaXMuYXBwID0gcGFyYW1zLmFwcDtcbiAgICB0aGlzLnBsdWdpbklkID0gcGFyYW1zLnBsdWdpbklkO1xuICB9XG5cbiAgLyoqXG4gICAqIEluaXRpYWxpemVzIHRoZSBwbHVnaW4gY29udGV4dCBhbmQgZGVidWcgY29udHJvbGxlci5cbiAgICovXG4gIHB1YmxpYyBvdmVycmlkZSBvbmxvYWQoKTogdm9pZCB7XG4gICAgaW5pdFBsdWdpbkNvbnRleHQodGhpcy5wbHVnaW5JZCk7XG4gICAgLy8gUmVzZXQgb24gdW5sb2FkIHNvIGEgcGx1Z2luIHJlbG9hZCBjYW4gcmUtaW5pdGlhbGl6ZSB3aXRob3V0IHRyaXBwaW5nIHRoZSBvbmNlLW9ubHkgYGluaXRgIGd1YXJkcy5cbiAgICB0aGlzLnJlZ2lzdGVyKCgpID0+IHtcbiAgICAgIExpYnJhcnkucmVzZXRUb0RlZmF1bHQoKTtcbiAgICAgIE9ic2lkaWFuTGlicmFyeS5yZXNldFRvRGVmYXVsdCgpO1xuICAgIH0pO1xuICAgIHRoaXMuYWRkQ2hpbGQobmV3IEFsbFdpbmRvd3NFdmVudENvbXBvbmVudCh0aGlzLmFwcCkpLnJlZ2lzdGVyQWxsV2luZG93c0hhbmRsZXIoKHdpbikgPT4ge1xuICAgICAgaW5pdERlYnVnQ29udHJvbGxlcih3aW4sIHRoaXMpO1xuICAgIH0pO1xuICB9XG59XG4iXSwKICAibWFwcGluZ3MiOiAiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBUUEscUJBQXdCO0FBRXhCLElBQUFBLGtCQUFnQztBQUNoQyw0QkFHTztBQUNQLHlDQUF5QztBQUN6QywwQkFBNEI7QUFVckIsTUFBTSwrQkFBK0IsZ0NBQVk7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQUluQztBQUFBO0FBQUE7QUFBQTtBQUFBLEVBS0E7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFPWixZQUFZLFFBQWlEO0FBQ2xFLFVBQU07QUFDTixTQUFLLE1BQU0sT0FBTztBQUNsQixTQUFLLFdBQVcsT0FBTztBQUFBLEVBQ3pCO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFLZ0IsU0FBZTtBQUM3QixpREFBa0IsS0FBSyxRQUFRO0FBRS9CLFNBQUssU0FBUyxNQUFNO0FBQ2xCLDZCQUFRLGVBQWU7QUFDdkIsc0NBQWdCLGVBQWU7QUFBQSxJQUNqQyxDQUFDO0FBQ0QsU0FBSyxTQUFTLElBQUksNERBQXlCLEtBQUssR0FBRyxDQUFDLEVBQUUsMEJBQTBCLENBQUMsUUFBUTtBQUN2RixxREFBb0IsS0FBSyxJQUFJO0FBQUEsSUFDL0IsQ0FBQztBQUFBLEVBQ0g7QUFDRjsiLAogICJuYW1lcyI6IFsiaW1wb3J0X2xpYnJhcnkiXQp9Cg==

package/dist/lib/cjs/components/plugin-context-component.d.cts

@@ -0,0 +1,36 @@
+/// <reference path="../library.d.cts" />
+/**
+ * @file
+ *
+ * Component that initializes the plugin context, debug controller, and library styles.
+ */
+import type { App } from 'obsidian' with { 'resolution-mode': 'import' };
+import { ComponentEx } from './component-ex.cjs';
+interface PluginContextComponentConstructorParams {
+    readonly app: App;
+    readonly pluginId: string;
+}
+/**
+ * Initializes plugin context (plugin ID, debug controller, library styles) on load.
+ */
+export declare class PluginContextComponent extends ComponentEx {
+    /**
+     * The Obsidian app instance.
+     */
+    protected readonly app: App;
+    /**
+     * The plugin ID used to initialize the plugin context and debug controller.
+     */
+    protected readonly pluginId: string;
+    /**
+     * Creates a new plugin context component.
+     *
+     * @param params - The constructor parameters.
+     */
+    constructor(params: PluginContextComponentConstructorParams);
+    /**
+     * Initializes the plugin context and debug controller.
+     */
+    onload(): void;
+}
+export {};