obsidian-typings 6.59.0 → 6.60.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 6.60.0
+
+- Now resolves to `@obsidian-typings/obsidian-public-latest` `^6.60.0`, which resolves to `@obsidian-typings/obsidian-public-1.15.1` `^1.1.0`. See [its release notes](https://github.com/obsidian-typings/obsidian-typings/releases/tag/obsidian-public-1.15.1-v1.1.0).
+
+### Breaking changes in that release
+
+- fix!: move the Lezer and CodeMirror language/search boundaries behind an opt-in /lezer subpath
+- fix(hotkey-manager)!: type save and load as returning Promise<void>
+- feat(runtime)!: model the Obsidian catalyst 1.15.1 runtime changes
+- fix(pdfjs)!: match the vendored PDF.js page and render task
+- fix(bases)!: type the Bases file view controller as QueryController
+
 ## 6.59.0
 
 - Now resolves to `@obsidian-typings/obsidian-public-latest` `^6.59.0`, which resolves to `@obsidian-typings/obsidian-public-1.15.0` `^1.1.0`. See [its release notes](https://github.com/obsidian-typings/obsidian-typings/releases/tag/obsidian-public-1.15.0-v1.1.0).

package/README.md

@@ -47,8 +47,8 @@ To make it easier to adapt to these differences, this package provides typings f
 
 Typings for each `Obsidian` version can be found in their own git branches: namely `release/obsidian-public/*` and `release/obsidian-catalyst/*`:
 
-- Latest `public` release: [`release/obsidian-public/1.15.0`](https://github.com/obsidian-typings/obsidian-typings/tree/release/obsidian-public/1.15.0) | not published to npm yet | [![npm](https://img.shields.io/npm/v/@obsidian-typings/obsidian-public-latest?logo=npm&logoColor=white&label=%40obsidian-typings%2Fobsidian-public-latest)](https://www.npmjs.com/package/@obsidian-typings/obsidian-public-latest)
-- Latest `catalyst` release: [`release/obsidian-catalyst/1.15.0`](https://github.com/obsidian-typings/obsidian-typings/tree/release/obsidian-catalyst/1.15.0) | [![npm](https://img.shields.io/npm/v/@obsidian-typings/obsidian-catalyst-1.15.0?logo=npm&logoColor=white&label=%40obsidian-typings%2Fobsidian-catalyst-1.15.0)](https://www.npmjs.com/package/@obsidian-typings/obsidian-catalyst-1.15.0) | [![npm](https://img.shields.io/npm/v/@obsidian-typings/obsidian-catalyst-latest?logo=npm&logoColor=white&label=%40obsidian-typings%2Fobsidian-catalyst-latest)](https://www.npmjs.com/package/@obsidian-typings/obsidian-catalyst-latest)
+- Latest `public` release: [`release/obsidian-public/1.15.1`](https://github.com/obsidian-typings/obsidian-typings/tree/release/obsidian-public/1.15.1) | not published to npm yet | [![npm](https://img.shields.io/npm/v/@obsidian-typings/obsidian-public-latest?logo=npm&logoColor=white&label=%40obsidian-typings%2Fobsidian-public-latest)](https://www.npmjs.com/package/@obsidian-typings/obsidian-public-latest)
+- Latest `catalyst` release: [`release/obsidian-catalyst/1.15.1`](https://github.com/obsidian-typings/obsidian-typings/tree/release/obsidian-catalyst/1.15.1) | [![npm](https://img.shields.io/npm/v/@obsidian-typings/obsidian-catalyst-1.15.1?logo=npm&logoColor=white&label=%40obsidian-typings%2Fobsidian-catalyst-1.15.1)](https://www.npmjs.com/package/@obsidian-typings/obsidian-catalyst-1.15.1) | [![npm](https://img.shields.io/npm/v/@obsidian-typings/obsidian-catalyst-latest?logo=npm&logoColor=white&label=%40obsidian-typings%2Fobsidian-catalyst-latest)](https://www.npmjs.com/package/@obsidian-typings/obsidian-catalyst-latest)
 
 Older versions of the package are available, but support for them is limited.
 In most cases, we recommend to always use the latest release.
@@ -236,10 +236,26 @@ With these scary disclaimers out of the way, hopefully these typings will help y
 - `@official` comes from the [official API](https://github.com/obsidianmd/obsidian-api/blob/master/obsidian.d.ts).
 - `@unofficial` based on reverse engineering.
 
+## See also
+
+[My other Obsidian resources](https://mnaoumov.dev/obsidian/)
+
+| Library | Features | How `Obsidian Typings` differs |
+| --- | --- | --- |
+| [`obsidian`](https://github.com/obsidianmd/obsidian-api) | Official type definitions for the documented Obsidian API; supported by the Obsidian team | Extends `obsidian`: augments its module with undocumented and internal members; adds interfaces it does not declare; adds runtime helpers under `/implementations`; unsupported by the Obsidian team |
+| [`obsidian-extra`](https://github.com/eth-p/obsidian-extra) | Runtime helper functions over the undocumented API; version-agnostic; safe and `/unsafe` entry points; last published in 2023 for Obsidian 1.1.x | Different approach from `obsidian-extra`: types the internal members directly instead of wrapping them in functions; adds a package per Obsidian version; omits its version-agnostic wrappers |
+| [`obsidian-undocumented`](https://github.com/eth-p/obsidian-undocumented) | Type definitions for undocumented and internal APIs, used by casting to its own `App`; safe and `/unsafe` flavors; last published in 2023 for Obsidian 1.1.x | Same goal as `obsidian-undocumented`: augments the `obsidian` module instead of requiring casts; adds packages for current `public` and `catalyst` releases; omits the safe/unsafe split |
+
+Last searched for similar libraries on 2026-11-12.
+
 ## Migration
 
 If you were using a `1.x.x` version of this package, see the [Migration guide](https://github.com/obsidian-typings/obsidian-typings/blob/main/MIGRATION.md) for upgrading to `2.0.0` or newer.
 
+## Changelog
+
+All notable changes to this project will be documented in the [CHANGELOG](./CHANGELOG.md).
+
 ## Contributing
 
 Feel free to start typing any part of the Obsidian API that is not yet typed, or fixing/adding additional descriptions to existing typings. If you are unsure about anything, don't hesitate to open an issue.
@@ -251,3 +267,53 @@ A brief tutorial is available on how you can get started with adding new typings
 Open issues through the [issue forms](https://github.com/obsidian-typings/obsidian-typings/issues/new/choose), not as blank issues.
 
 Filing from the CLI or the API (`gh issue create --body`, or an AI agent filing for you) skips the form, and `gh issue create --template` cannot load an issue form. In that case, open the matching form in [`.github/ISSUE_TEMPLATE/`](https://github.com/obsidian-typings/obsidian-typings/tree/HEAD/.github/ISSUE_TEMPLATE), copy every field as a `### <label>` heading in the form's order, and fill in each one. Always state the version you used and your operating system.
+
+## Optional Electron interoperability
+
+The default entry point keeps standalone Electron mirrors and needs no `electron` package. To use installed Electron declarations at Obsidian's window and renderer-module boundaries, install the version matching `process.versions.electron` in your launcher and load the type-only integration:
+
+```ts
+import type {} from 'obsidian-typings/electron';
+```
+
+The same `/electron` subpath is available on scoped per-version and latest packages. The import is erased from JavaScript and loads no Electron runtime. `FrameDom.eWin`, `electronWindow`, `window.electronWindow`, and the public fields of `electron` and `window.electron` then use installed declarations. Obsidian's IPC channel overloads and `ElectronWindow` extensions remain available. The `webContents.noContextMenu` vendor flag is optional so ordinary upstream windows and web contents remain assignable. Other mirror exports, including `ElectronBrowserWindow` and `ElectronNativeImage`, retain their standalone contracts; import full upstream types from `electron` when using that library.
+
+Selection applies to the whole TypeScript program through the reserved `ObsidianElectronTypes` registry, including mixed CommonJS and ESM entry points. The integration does not imply that newer methods exist on an older launcher. Feature-detect APIs and use Electron declarations matching the runtime. The updater currently accepts installers from 1.1.9 (Electron 21); installer 1.14.5 ships Electron 43.8.3. See the [launcher matrix](https://github.com/obsidian-typings/obsidian-typings/blob/main/reports/library-mirror-audit-2026-11-03.md#launcher-matrix-and-interoperability-follow-up) for evidence and compiler pins. In particular, older Electron declarations conflict with recent Node declarations over `Process.noDeprecation`: the consumer checks pin Node declarations 20.17.30 for Electron 21.3.1 and 24.9.0 for Electron 43.8.3, with full declaration checking enabled. These type pins do not change the runtime.
+
+## Optional PDF.js interoperability
+
+The default declarations keep standalone PDF.js mirrors and require no `pdfjs-dist` package. To use installed public PDF.js declarations, install `pdfjs-dist@5.3.31` as a development dependency and load the type-only integration:
+
+```ts
+import type {} from 'obsidian-typings/pdfjs';
+```
+
+The same `/pdfjs` subpath is available on scoped per-version and latest packages. It selects installed declarations for `loadPdfJs()` from `obsidian-typings/implementations`, `window.pdfjsLib` and global `pdfjsLib`, across the whole TypeScript program including mixed CommonJS and ESM imports. It loads no JavaScript; continue using Obsidian's PDF.js instance.
+
+The exported `InteropPDFDocumentLoadingTask`, `InteropPDFDocumentProxy`, `InteropPDFPageProxy`, `InteropPDFWorker` and `InteropRenderTask` aliases name the selected contracts. Without the integration they select standalone mirrors; with it they retain upstream private-member identity. The original mirror exports and the separate `PdfJsTestingUtils`, `HighlightOutline`, `HighlightOutliner` and testing globals remain available.
+
+The verified Obsidian 1.14.4 and 1.15.0 builds vendor PDF.js 5.3.34, build `cc1e2a3e0`, which was never published to npm. Version 5.3.31 is the tested published comparison, not an exact vendor match or a promise about other versions. Selecting the package's public signatures does not establish that every upstream export exists in every Obsidian build. See the [library mirror audit](reports/library-mirror-audit-2026-11-03.md) for the source evidence and limits.
+
+## Optional Lezer and CodeMirror language/search interoperability
+
+Obsidian exposes three CodeMirror libraries beyond the `@codemirror/state` and `@codemirror/view` that `obsidian` itself requires: `@lezer/common` (the `tokenClassNodeProp` and `lineClassNodeProp` props and `LanguageState.tree`), `@codemirror/language` (`LanguageState.context`) and `@codemirror/search` (`CodeMirrorEditor.addOverlay` and `removeOverlay`). The default entry point needs none of them: those boundaries use standalone mirrors, exported as `NodeProp`, `LezerTree`, `ParseContext` and `SearchQuery`. To use the installed declarations instead, install the three packages and load the type-only integration:
+
+```ts
+import type {} from 'obsidian-typings/lezer';
+```
+
+The same `/lezer` subpath is available on scoped per-version and latest packages. The import is erased from JavaScript and loads no runtime. It selects the upstream types at every boundary above, across the whole TypeScript program through the reserved `ObsidianLezerTypes` registry, so `node.type.prop(tokenClassNodeProp)` on a real syntax node compiles without a cast. A locally copied `NodeProp` can never do that, because `NodeProp.add` reaches `NodeType`'s private members. The exported `InteropStringNodeProp`, `InteropLezerTree`, `InteropParseContext` and `InteropSearchQuery` aliases name the selected contracts.
+
+## Optional Pixi interoperability
+
+The default entry point keeps standalone library mirrors: it does not require `pixi.js-legacy`. For plugins that use the real Pixi declarations, install the exact version Obsidian vendors (currently `pixi.js-legacy@7.2.4`) and explicitly load the type-only integration:
+
+```ts
+import type {} from 'obsidian-typings/pixi';
+```
+
+Use the same `/pixi` subpath on a scoped per-version or latest package. This import is erased from JavaScript; it does not load another Pixi runtime. Continue using Obsidian's `loadPixi()` or the graph iframe's Pixi instance.
+
+The integration selects upstream types for `loadPixi()`, `Window.PIXI`, global `PIXI`, and the Pixi fields and methods on graph renderers, nodes, links and power tags. Graph records and vendor members remain available. The exported mirror classes, such as `Container`, remain standalone contracts; import full upstream class types from `pixi.js-legacy` when using that library. Opting in affects the whole TypeScript program through the reserved `ObsidianPixiTypes` registry, including CommonJS and ESM declarations loaded together.
+
+Pixi 7.2.4's own declarations have known errors against modern DOM libraries and Node16 package resolution. The consumer checks report those upstream diagnostics separately from errors in our declarations and consumer assignments; `skipLibCheck` stays disabled. The integration preserves class identity but does not repair the upstream declaration baseline. Do not assume compatibility with another Pixi major or version merely because it installs.

package/electron.d.cts

@@ -0,0 +1 @@
+export type * from "@obsidian-typings/obsidian-public-latest/electron";

package/electron.d.mts

@@ -0,0 +1 @@
+export type * from "@obsidian-typings/obsidian-public-latest/electron";

package/lezer.d.cts

@@ -0,0 +1 @@
+export type * from "@obsidian-typings/obsidian-public-latest/lezer";

package/lezer.d.mts

@@ -0,0 +1 @@
+export type * from "@obsidian-typings/obsidian-public-latest/lezer";

package/package.json

@@ -1,6 +1,6 @@
 {
   "dependencies": {
-    "@obsidian-typings/obsidian-public-latest": "^6.59.0"
+    "@obsidian-typings/obsidian-public-latest": "^6.60.0"
   },
   "description": "TypeScript type definitions for Obsidian's internal/unofficial APIs. Wrapper for @obsidian-typings/obsidian-public-latest.",
   "exports": {
@@ -12,6 +12,14 @@
         "types": "./types.d.cts"
       }
     },
+    "./electron": {
+      "import": {
+        "types": "./electron.d.mts"
+      },
+      "require": {
+        "types": "./electron.d.cts"
+      }
+    },
     "./implementations": {
       "import": {
         "default": "./implementations.mjs",
@@ -21,6 +29,30 @@
         "default": "./implementations.cjs",
         "types": "./implementations.d.cts"
       }
+    },
+    "./lezer": {
+      "import": {
+        "types": "./lezer.d.mts"
+      },
+      "require": {
+        "types": "./lezer.d.cts"
+      }
+    },
+    "./pdfjs": {
+      "import": {
+        "types": "./pdfjs.d.mts"
+      },
+      "require": {
+        "types": "./pdfjs.d.cts"
+      }
+    },
+    "./pixi": {
+      "import": {
+        "types": "./pixi.d.mts"
+      },
+      "require": {
+        "types": "./pixi.d.cts"
+      }
     }
   },
   "license": "MIT",
@@ -32,5 +64,5 @@
   },
   "type": "module",
   "types": "./types.d.cts",
-  "version": "6.59.0"
+  "version": "6.60.0"
 }

package/pdfjs.d.cts

@@ -0,0 +1 @@
+export type * from "@obsidian-typings/obsidian-public-latest/pdfjs";

package/pdfjs.d.mts

@@ -0,0 +1 @@
+export type * from "@obsidian-typings/obsidian-public-latest/pdfjs";

package/pixi.d.cts

@@ -0,0 +1 @@
+export type * from "@obsidian-typings/obsidian-public-latest/pixi";

package/pixi.d.mts

@@ -0,0 +1 @@
+export type * from "@obsidian-typings/obsidian-public-latest/pixi";