@mnaoumov/obsidian-lib 10.10.0 → 10.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -0
- package/components/all-windows-status-bar-item-component/package.json +6 -0
- package/components/shared-component-pool-component/package.json +6 -0
- package/components/workspace-layout-state-component/package.json +6 -0
- package/dist/lib/cjs/__merged.cjs +90 -1
- package/dist/lib/cjs/__merged.d.cts +13 -4
- package/dist/lib/cjs/bug-report-diagnostics.cjs +222 -0
- package/dist/lib/cjs/bug-report-diagnostics.d.cts +186 -0
- package/dist/lib/cjs/bug-report.cjs +36 -10
- package/dist/lib/cjs/bug-report.d.cts +65 -0
- package/dist/lib/cjs/command-handlers/open-bug-report-command-handler.cjs +93 -2
- package/dist/lib/cjs/command-handlers/open-bug-report-command-handler.d.cts +34 -2
- package/dist/lib/cjs/components/all-windows-status-bar-item-component.cjs +245 -0
- package/dist/lib/cjs/components/all-windows-status-bar-item-component.d.cts +146 -0
- package/dist/lib/cjs/components/embed-extensions-component.cjs +20 -3
- package/dist/lib/cjs/components/embed-extensions-component.d.cts +8 -0
- package/dist/lib/cjs/components/embeddable-markdown-editor-component.cjs +16 -2
- package/dist/lib/cjs/components/embeddable-markdown-editor-component.d.cts +9 -0
- package/dist/lib/cjs/components/index.cjs +12 -3
- package/dist/lib/cjs/components/index.d.cts +3 -0
- package/dist/lib/cjs/components/plugin-gate-component.cjs +2 -9
- package/dist/lib/cjs/components/plugin-settings-component.cjs +7 -2
- package/dist/lib/cjs/components/shared-component-pool-component.cjs +368 -0
- package/dist/lib/cjs/components/shared-component-pool-component.d.cts +129 -0
- package/dist/lib/cjs/components/workspace-layout-state-component.cjs +495 -0
- package/dist/lib/cjs/components/workspace-layout-state-component.d.cts +239 -0
- package/dist/lib/cjs/css-class.cjs +5 -1
- package/dist/lib/cjs/css-class.d.cts +16 -0
- package/dist/lib/cjs/data-handler.cjs +156 -5
- package/dist/lib/cjs/data-handler.d.cts +128 -2
- package/dist/lib/cjs/desktop-git-runner.cjs +4 -14
- package/dist/lib/cjs/desktop-git-runner.d.cts +8 -2
- package/dist/lib/cjs/generated-during-build.cjs +2 -2
- package/dist/lib/cjs/git-rename-history.cjs +1 -1
- package/dist/lib/cjs/git-rename-history.d.cts +2 -2
- package/dist/lib/cjs/i18n/locales/en.cjs +29 -1
- package/dist/lib/cjs/i18n/locales/en.d.cts +28 -0
- package/dist/lib/cjs/i18n/locales/translations-map.d.cts +28 -0
- package/dist/lib/cjs/index.cjs +10 -1
- package/dist/lib/cjs/index.d.cts +3 -0
- package/dist/lib/cjs/link.cjs +40 -1
- package/dist/lib/cjs/link.d.cts +37 -1
- package/dist/lib/cjs/markdown-view.cjs +191 -3
- package/dist/lib/cjs/markdown-view.d.cts +48 -1
- package/dist/lib/cjs/modals/copy-text-manually.cjs +181 -0
- package/dist/lib/cjs/modals/copy-text-manually.d.cts +38 -0
- package/dist/lib/cjs/modals/index.cjs +7 -1
- package/dist/lib/cjs/modals/index.d.cts +2 -0
- package/dist/lib/cjs/modals/review-bug-report-diagnostics.cjs +202 -0
- package/dist/lib/cjs/modals/review-bug-report-diagnostics.d.cts +30 -0
- package/dist/lib/cjs/plugin/index.cjs +4 -1
- package/dist/lib/cjs/plugin/index.d.cts +1 -0
- package/dist/lib/cjs/plugin/plugin-api.cjs +13 -4
- package/dist/lib/cjs/plugin/plugin-api.d.cts +5 -1
- package/dist/lib/cjs/plugin/plugin-install-state.cjs +46 -1
- package/dist/lib/cjs/plugin/plugin-install-state.d.cts +30 -0
- package/dist/lib/cjs/plugin/plugin-instance.cjs +448 -0
- package/dist/lib/cjs/plugin/plugin-instance.d.cts +251 -0
- package/dist/lib/cjs/plugin/plugin.cjs +16 -1
- package/dist/lib/cjs/plugin/plugin.d.cts +7 -0
- package/dist/lib/cjs/reference-definition.cjs +234 -0
- package/dist/lib/cjs/reference-definition.d.cts +47 -0
- package/dist/lib/cjs/release-asset.cjs +279 -0
- package/dist/lib/cjs/release-asset.d.cts +190 -0
- package/dist/lib/cjs/workspace.cjs +3 -2
- package/dist/lib/cjs/workspace.d.cts +6 -0
- package/dist/lib/esm/__merged.d.mts +13 -4
- package/dist/lib/esm/__merged.mjs +97 -3
- package/dist/lib/esm/bug-report-diagnostics.d.mts +186 -0
- package/dist/lib/esm/bug-report-diagnostics.mjs +127 -0
- package/dist/lib/esm/bug-report.d.mts +65 -0
- package/dist/lib/esm/bug-report.mjs +33 -10
- package/dist/lib/esm/command-handlers/open-bug-report-command-handler.d.mts +34 -2
- package/dist/lib/esm/command-handlers/open-bug-report-command-handler.mjs +99 -3
- package/dist/lib/esm/components/all-windows-status-bar-item-component.d.mts +146 -0
- package/dist/lib/esm/components/all-windows-status-bar-item-component.mjs +154 -0
- package/dist/lib/esm/components/embed-extensions-component.d.mts +8 -0
- package/dist/lib/esm/components/embed-extensions-component.mjs +20 -3
- package/dist/lib/esm/components/embeddable-markdown-editor-component.d.mts +9 -0
- package/dist/lib/esm/components/embeddable-markdown-editor-component.mjs +16 -2
- package/dist/lib/esm/components/index.d.mts +3 -0
- package/dist/lib/esm/components/index.mjs +8 -2
- package/dist/lib/esm/components/plugin-gate-component.mjs +5 -13
- package/dist/lib/esm/components/plugin-settings-component.mjs +7 -2
- package/dist/lib/esm/components/shared-component-pool-component.d.mts +129 -0
- package/dist/lib/esm/components/shared-component-pool-component.mjs +280 -0
- package/dist/lib/esm/components/workspace-layout-state-component.d.mts +239 -0
- package/dist/lib/esm/components/workspace-layout-state-component.mjs +404 -0
- package/dist/lib/esm/css-class.d.mts +16 -0
- package/dist/lib/esm/css-class.mjs +5 -1
- package/dist/lib/esm/data-handler.d.mts +128 -2
- package/dist/lib/esm/data-handler.mjs +152 -4
- package/dist/lib/esm/desktop-git-runner.d.mts +8 -2
- package/dist/lib/esm/desktop-git-runner.mjs +3 -3
- package/dist/lib/esm/generated-during-build.mjs +2 -2
- package/dist/lib/esm/git-rename-history.d.mts +2 -2
- package/dist/lib/esm/git-rename-history.mjs +1 -1
- package/dist/lib/esm/i18n/locales/en.d.mts +28 -0
- package/dist/lib/esm/i18n/locales/en.mjs +29 -1
- package/dist/lib/esm/i18n/locales/translations-map.d.mts +28 -0
- package/dist/lib/esm/index.d.mts +3 -0
- package/dist/lib/esm/index.mjs +7 -1
- package/dist/lib/esm/link.d.mts +37 -1
- package/dist/lib/esm/link.mjs +40 -1
- package/dist/lib/esm/markdown-view.d.mts +48 -1
- package/dist/lib/esm/markdown-view.mjs +192 -2
- package/dist/lib/esm/modals/copy-text-manually.d.mts +38 -0
- package/dist/lib/esm/modals/copy-text-manually.mjs +99 -0
- package/dist/lib/esm/modals/index.d.mts +2 -0
- package/dist/lib/esm/modals/index.mjs +5 -1
- package/dist/lib/esm/modals/review-bug-report-diagnostics.d.mts +30 -0
- package/dist/lib/esm/modals/review-bug-report-diagnostics.mjs +120 -0
- package/dist/lib/esm/plugin/index.d.mts +1 -0
- package/dist/lib/esm/plugin/index.mjs +3 -1
- package/dist/lib/esm/plugin/plugin-api.d.mts +5 -1
- package/dist/lib/esm/plugin/plugin-api.mjs +13 -4
- package/dist/lib/esm/plugin/plugin-install-state.d.mts +30 -0
- package/dist/lib/esm/plugin/plugin-install-state.mjs +44 -1
- package/dist/lib/esm/plugin/plugin-instance.d.mts +251 -0
- package/dist/lib/esm/plugin/plugin-instance.mjs +366 -0
- package/dist/lib/esm/plugin/plugin.d.mts +7 -0
- package/dist/lib/esm/plugin/plugin.mjs +16 -1
- package/dist/lib/esm/reference-definition.d.mts +47 -0
- package/dist/lib/esm/reference-definition.mjs +146 -0
- package/dist/lib/esm/release-asset.d.mts +190 -0
- package/dist/lib/esm/release-asset.mjs +187 -0
- package/dist/lib/esm/workspace.d.mts +6 -0
- package/dist/lib/esm/workspace.mjs +3 -2
- package/dist/styles.css +16 -1
- package/modals/copy-text-manually/package.json +6 -0
- package/modals/review-bug-report-diagnostics/package.json +6 -0
- package/package.json +2 -1
- package/plugin/plugin-instance/package.json +6 -0
package/README.md
CHANGED
|
@@ -18,10 +18,36 @@ Register custom global and instance functions for Bases with the [formula-functi
|
|
|
18
18
|
|
|
19
19
|
Apply behavior and body classes to the main window and existing or future popouts with the [window helpers](./docs/src/content/docs/guides/windows.md), with cleanup when the window closes or the owner unloads.
|
|
20
20
|
|
|
21
|
+
Keep plugin state with the workspace layout, so each saved workspace restores its own values, with [workspace layout state](./docs/src/content/docs/guides/workspace-layout-state.md).
|
|
22
|
+
|
|
23
|
+
Share one loaded component per key among several panels, and unload it after the last one closes, with [shared component pools](./docs/src/content/docs/guides/shared-component-pools.md).
|
|
24
|
+
|
|
21
25
|
## Where it fits
|
|
22
26
|
|
|
23
27
|
It is one of five packages that replace [`obsidian-dev-utils`](https://github.com/mnaoumov/obsidian-dev-utils): [`@mnaoumov/typescript-lib`](https://github.com/mnaoumov/typescript-lib), [`@mnaoumov/typescript-test-toolkit`](https://github.com/mnaoumov/typescript-test-toolkit), [`@mnaoumov/typescript-dev-toolkit`](https://github.com/mnaoumov/typescript-dev-toolkit), [`@mnaoumov/obsidian-lib`](https://github.com/mnaoumov/obsidian-lib) and [`@mnaoumov/obsidian-dev-toolkit`](https://github.com/mnaoumov/obsidian-dev-toolkit). It depends on [`@mnaoumov/typescript-lib`](https://github.com/mnaoumov/typescript-lib). It moved here from that repository with its history.
|
|
24
28
|
|
|
29
|
+
## See also
|
|
30
|
+
|
|
31
|
+
<!-- cspell:words insurgently ophidian polyipseity vrtmrz Fevol -->
|
|
32
|
+
|
|
33
|
+
[My other Obsidian resources](https://mnaoumov.dev/obsidian/)
|
|
34
|
+
|
|
35
|
+
| Library | Features | How `@mnaoumov/obsidian-lib` differs |
|
|
36
|
+
| --- | --- | --- |
|
|
37
|
+
| [`@insurgently/obsidian-ui`](https://www.npmjs.com/package/@insurgently/obsidian-ui) | Command catalog; side panels; dialogs; notices with undo; background jobs; design tokens and layout classes; control gallery; automation surface for tests | Overlaps with `@insurgently/obsidian-ui` in dialogs, notices and command registration; adds plugin base classes, settings, data stores and vault, metadata-cache and link helpers; omits its design tokens, control set and automation surface |
|
|
38
|
+
| [`@ophidian/core`](https://github.com/ophidian-lib/core) | Service container; per-window components; settings with subscriptions; workspace layout settings; shared resources; per-window status-bar items; promise dialogs; metadata indexing | Same goal as `@ophidian/core`, a component framework for plugins; covers its layout settings, shared resources and per-window status-bar items with explicit component ownership instead of a service container; keeps `obsidian` a peer dependency; omits its service container and reactive jobs |
|
|
39
|
+
| [`@polyipseity/obsidian-plugin-library`](https://github.com/polyipseity/obsidian-plugin-library) | Settings with immutable updates and change notifications; patches reapplied across plugin reloads; translations; source maps for dynamically built functions; `Svelte` UI parts | Same goal as `@polyipseity/obsidian-plugin-library`, a general plugin library; keeps `obsidian` a peer dependency; adds data stores and vault, metadata-cache and link helpers; omits `Svelte` components and dynamic source maps |
|
|
40
|
+
| [`@vrtmrz/obsidian-plugin-kit`](https://github.com/vrtmrz/fancy-kit) | Prompt, selection and confirmation dialogs; keyed notices; progress notices; vault text and front matter capabilities; `SecretStorage` and local-storage adapters; app-free UI and vault test harnesses | Overlaps with `@vrtmrz/obsidian-plugin-kit` in dialogs, notices and front matter helpers; adds plugin base classes, settings tabs, data stores and link helpers; omits its `SecretStorage` and local-storage adapters and app-free test harnesses |
|
|
41
|
+
| [`monkey-around`](https://github.com/pjeby/monkey-around) | Removable, cooperative method wrappers; serialized execution | Extends `monkey-around`: wraps its patches in components that remove them when their owner unloads |
|
|
42
|
+
| [`obsidian-database-library`](https://github.com/Fevol/obsidian-database-library) | `IndexedDB` database kept in step with vault events; schema rebuilds; optional worker parsing | Overlaps with `obsidian-database-library` in persistent per-file caches; stores data through its own local and synced data stores and incremental file indexes; omits worker parsing |
|
|
43
|
+
| [`obsidian-dev-utils`](https://github.com/mnaoumov/obsidian-dev-utils) (my library) | Runtime helpers for plugins; `esbuild` builder; shared lint configurations; release script | Supersedes the runtime half of `obsidian-dev-utils`, which is retired; its tooling half moved to `@mnaoumov/obsidian-dev-toolkit` |
|
|
44
|
+
|
|
45
|
+
Last searched for similar libraries on 2026-11-11.
|
|
46
|
+
|
|
47
|
+
## Changelog
|
|
48
|
+
|
|
49
|
+
All notable changes to this project will be documented in the [CHANGELOG](./CHANGELOG.md).
|
|
50
|
+
|
|
25
51
|
## Filing an issue (for AI agents and humans)
|
|
26
52
|
|
|
27
53
|
Open issues through the [issue forms](https://github.com/mnaoumov/obsidian-lib/issues/new/choose), not as blank issues.
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
{
|
|
2
|
+
"main": "../../dist/lib/cjs/components/all-windows-status-bar-item-component.cjs",
|
|
3
|
+
"module": "../../dist/lib/esm/components/all-windows-status-bar-item-component.mjs",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"types": "../../dist/lib/cjs/components/all-windows-status-bar-item-component.d.cts"
|
|
6
|
+
}
|