obsidian-typings 5.22.0 → 5.24.0

package/README.md

@@ -2,7 +2,7 @@
 
 [![NPM downloads](https://img.shields.io/npm/v/obsidian-typings?color=red&label=Version%3A&logo=npm&logoColor=white&labelColor=red)](https://www.npmjs.com/package/obsidian-typings)
 [![NPM downloads](https://img.shields.io/npm/dw/obsidian-typings?style=flat&label=Downloads)](https://www.npmjs.com/package/obsidian-typings)
-[![GitHub Repo stars](https://img.shields.io/github/stars/fevol/obsidian-typings?color=yellow&label=Stargazers%3A&logo=OpenTelemetry&logoColor=yellow)](https://github.com/Fevol/obsidian-typings/stargazers)
+[![GitHub Repo stars](https://img.shields.io/github/stars/obsidian-typings/obsidian-typings?color=yellow&label=Stargazers%3A&logo=OpenTelemetry&logoColor=yellow)](https://github.com/obsidian-typings/obsidian-typings/stargazers)
 
 **Obsidian Typings** provides **TypeScript definitions** for Obsidian’s **undocumented and internal APIs**.
 
@@ -36,8 +36,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.12.7`](https://github.com/Fevol/obsidian-typings/tree/release/obsidian-public/1.12.7)
-- Latest `catalyst` release: [`release/obsidian-catalyst/1.12.6`](https://github.com/Fevol/obsidian-typings/tree/release/obsidian-catalyst/1.12.6)
+- Latest `public` release: [`release/obsidian-public/1.12.7`](https://github.com/obsidian-typings/obsidian-typings/tree/release/obsidian-public/1.12.7) | [`@obsidian-typings/obsidian-public-1.12.7`](https://www.npmjs.com/package/@obsidian-typings/obsidian-public-1.12.7)
+- Latest `catalyst` release: [`release/obsidian-catalyst/1.12.6`](https://github.com/obsidian-typings/obsidian-typings/tree/release/obsidian-catalyst/1.12.6) | [`@obsidian-typings/obsidian-catalyst-1.12.6`](https://www.npmjs.com/package/@obsidian-typings/obsidian-catalyst-1.12.6)
 
 Older versions of the package are available, but support for them is limited.
 In most cases, we recommend to always use the latest release.
@@ -47,28 +47,14 @@ In most cases, we recommend to always use the latest release.
 ### 1. Install via `npm`
 
 - Latest `public` release (recommended):
+  - `npm install --save-dev @obsidian-typings/obsidian-public-latest`
+- Latest `catalyst` (`beta`) release:
+  - `npm install --save-dev @obsidian-typings/obsidian-catalyst-latest`
+- Specific Obsidian version (should match `minAppVersion` in your plugin's `manifest.json`):
+  - `npm install --save-dev @obsidian-typings/obsidian-public-1.12.7`
+  - `npm install --save-dev @obsidian-typings/obsidian-catalyst-1.12.6`
+- Legacy package name (alias for `@obsidian-typings/obsidian-public-latest`):
   - `npm install --save-dev obsidian-typings`
-- Explicitly install latest `public` release:
-  - `npm pkg set "dependencies.obsidian-typings=obsidian-public-latest" && npm install`
-- Install the latest `catalyst` (`beta`) release:
-  - `npm pkg set "dependencies.obsidian-typings=obsidian-catalyst-latest" && npm install`
-- Install a specific release (should match `minAppVersion` in your plugin's `manifest.json`):
-  - `npm pkg set "dependencies.obsidian-typings=obsidian-public-1.8.10" && npm install`
-  - `npm pkg set "dependencies.obsidian-typings=obsidian-catalyst-1.9.9" && npm install`
-
-> [!IMPORTANT]
->
-> If you installed library using `npm pkg set` approach, you will have to update it using `npm update obsidian-typings` command.
->
-> If you run `npm install obsidian-typings` instead, the most likely, the library will not get updated.
-
- 
-
-> [!WARNING]
->
-> The package installs several libraries that trigger `npm audit` warnings.
->
-> Those packages cannot be updated because they should match the exact versions Obsidian uses internally.
 
 <!-- markdownlint-disable MD033 -->
 
@@ -76,14 +62,14 @@ In most cases, we recommend to always use the latest release.
 
 <!-- markdownlint-enable MD033 -->
 
-Add `obsidian-typings` to the `types` array of your `tsconfig.json` to make all extended typings available globally without explicit importing them:
+Add the package to the `types` array of your `tsconfig.json` to make all extended typings available globally without explicit importing them:
 
 ```json
 {
     "compilerOptions": {
         "...": "...",
         "types": [
-            "obsidian-typings"
+            "@obsidian-typings/obsidian-public-latest"
         ]
     }
 }
@@ -91,14 +77,14 @@ Add `obsidian-typings` to the `types` array of your `tsconfig.json` to make all
 
 > [!WARNING]
 >
-> If other `@types/*` packages stop being recognized after adding `obsidian-typings` to the `types`, you may need to re-add them to the `types` list.
+> If other `@types/*` packages stop being recognized after adding the typings to the `types`, you may need to re-add them to the `types` list.
 >
 > ```json
 > {
 >     "compilerOptions": {
 >         "...": "...",
 >         "types": [
->             "obsidian-typings",
+>             "@obsidian-typings/obsidian-public-latest",
 >             "some-package-name"
 >         ]
 >     }
@@ -106,10 +92,10 @@ Add `obsidian-typings` to the `types` array of your `tsconfig.json` to make all
 
 ### 3. Importing explicitly (alternative)
 
-Instead of adding `obsidian-typings` to your `types`, you can also import the package directly:
+Instead of adding the package to your `types`, you can also import it directly:
 
 ```ts
-import type {} from 'obsidian-typings';
+import type {} from '@obsidian-typings/obsidian-public-latest';
 ```
 
 ## Usage
@@ -126,33 +112,33 @@ function printInternalPlugins(app: App): void {
 }
 ```
 
-### `obsidian-typings` additional interfaces
+### Additional interfaces
 
 Additional interfaces added by this package (which do not exist in the official API), can be imported as:
 
 ```ts
-import type { InternalPlugins } from 'obsidian-typings';
+import type { InternalPlugins } from '@obsidian-typings/obsidian-public-latest';
 
 function getInternalPlugins(app: App): InternalPlugins {
   return app.internalPlugins;
 }
 ```
 
-### `obsidian-typings/implementations`
+### Implementations
 
-Additional helper functions/types/... added by this package can be used by importing from `obsidian-typings/implementations`:
+Additional helper functions/types/... added by this package can be used by importing from the `/implementations` subpath:
 
 ```ts
-import { InternalPluginName } from 'obsidian-typings/implementations';
+import { InternalPluginName } from '@obsidian-typings/obsidian-public-latest/implementations';
 
 // If you forget the `/implementations` part:
-// import { InternalPluginName } from 'obsidian-typings';
+// import { InternalPluginName } from '@obsidian-typings/obsidian-public-latest';
 // You will not be able to use the runtime values and the code below will not compile.
 
 this.app.internalPlugins.getEnabledPluginById(InternalPluginName.FileExplorer);
 ```
 
-The list of all available implementations can be found in the `src/obsidian/implementations` folder in the corresponding release branch ([example for `1.9.10 public`](https://github.com/Fevol/obsidian-typings/tree/release/obsidian-public/1.9.10/src/obsidian/implementations)).
+The list of all available implementations can be found in the `src/obsidian/implementations` folder in the corresponding release branch ([example for `1.9.10 public`](https://github.com/obsidian-typings/obsidian-typings/tree/release/obsidian-public/1.9.10/src/obsidian/implementations)).
 
 ### Extend with your own typings
 
@@ -160,7 +146,7 @@ If you need to extend the typings provided by this package, add the following to
 
 ```ts
 export {}; // This line is required. If there are no top-level `import/export` statements, your typings will work not as expected.
-declare module 'obsidian-typings' {
+declare module '@obsidian-typings/obsidian-public-latest' {
     interface PluginsPluginsRecord {
         ['my-plugin-id']: MyPlugin;
     }
@@ -198,7 +184,7 @@ Always verify that your code behaves as expected, both in terms of types and run
 
 > [!TIP]
 >
-> If you find any issues with the typings or documentation, please feel free to [open an issue](https://github.com/Fevol/obsidian-typings/issues) or submit a pull request.
+> If you find any issues with the typings or documentation, please feel free to [open an issue](https://github.com/obsidian-typings/obsidian-typings/issues) or submit a pull request.
 
 With these scary disclaimers out of the way, hopefully these typings will help you in removing 90% of the `@ts-ignore`/`@ts-expect-error` you have in your codebase, or discover solutions that didn't seem possible before.
 
@@ -211,10 +197,10 @@ With these scary disclaimers out of the way, hopefully these typings will help y
 
 ## Migration
 
-If you were using a `1.x.x` version of this package, see the [Migration guide](https://github.com/Fevol/obsidian-typings/blob/main/MIGRATION.md) for upgrading to `2.0.0` or newer.
+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.
 
 ## 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.
 
-A brief tutorial is available on how you can get started with adding new typings, or fixing existing ones, see: [CONTRIBUTING.md](https://github.com/Fevol/obsidian-typings/blob/main/CONTRIBUTING.md).
+A brief tutorial is available on how you can get started with adding new typings, or fixing existing ones, see: [CONTRIBUTING.md](https://github.com/obsidian-typings/obsidian-typings/blob/main/CONTRIBUTING.md).

package/implementations.cjs

@@ -0,0 +1 @@
+module.exports = require("@obsidian-typings/obsidian-public-latest/implementations");

package/implementations.d.cts

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

package/implementations.d.mts

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

package/implementations.mjs

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

package/package.json

@@ -1,135 +1,32 @@
 {
-  "name": "obsidian-typings",
-  "version": "5.22.0",
-  "description": "Extended type definitions for the Obsidian API (https://obsidian.md)",
-  "keywords": [
-    "obsdmd",
-    "obsidian",
-    "typings",
-    "API"
-  ],
-  "homepage": "https://github.com/obsidian-typings/obsidian-typings#readme",
-  "bugs": {
-    "url": "https://github.com/obsidian-typings/obsidian-typings/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/obsidian-typings/obsidian-typings.git"
+  "dependencies": {
+    "@obsidian-typings/obsidian-public-latest": "^5.24.0"
   },
-  "license": "MIT",
-  "author": {
-    "name": "Fevol",
-    "email": "fevolmail@gmail.com",
-    "url": "https://github.com/fevol"
-  },
-  "contributors": [
-    {
-      "name": "Michael Naumov",
-      "email": "mnaoumov@gmail.com",
-      "url": "https://github.com/mnaoumov"
-    }
-  ],
-  "type": "module",
+  "description": "TypeScript type definitions for Obsidian's internal/unofficial APIs. Wrapper for @obsidian-typings/obsidian-public-latest.",
   "exports": {
     ".": {
-      "require": {
-        "types": "./dist/cjs/types.d.cts"
-      },
       "import": {
-        "types": "./dist/esm/types.d.mts"
+        "types": "./types.d.mts"
+      },
+      "require": {
+        "types": "./types.d.cts"
       }
     },
     "./implementations": {
-      "require": {
-        "types": "./dist/cjs/implementations.d.cts",
-        "default": "./dist/cjs/implementations.cjs"
-      },
       "import": {
-        "types": "./dist/esm/implementations.d.mts",
-        "default": "./dist/esm/implementations.mjs"
+        "default": "./implementations.mjs",
+        "types": "./implementations.d.mts"
+      },
+      "require": {
+        "default": "./implementations.cjs",
+        "types": "./implementations.d.cts"
       }
     }
   },
+  "license": "MIT",
   "main": "",
-  "module": "",
-  "types": "./dist/cjs/types.d.cts",
-  "files": [
-    "dist/",
-    "implementations/",
-    "CHANGELOG.md",
-    "LICENSE",
-    "README.md",
-    "package.json"
-  ],
-  "scripts": {
-    "build": "jiti scripts/build.ts",
-    "build:bundle-types": "jiti scripts/build-bundle-types.ts",
-    "build:clean": "jiti scripts/build-clean.ts",
-    "build:compile": "jiti scripts/build-compile.ts",
-    "build:extract-api": "jiti scripts/build-extract-api.ts",
-    "build:fix-bundle-types": "jiti scripts/build-fix-bundle-types.ts",
-    "build:fix-implementations-bundle-types": "jiti scripts/build-fix-implementations-bundle-types.ts",
-    "build:generate-index": "jiti scripts/build-generate-index.ts",
-    "build:implementations": "jiti scripts/build-implementations.ts",
-    "build:implementations:bundle-types": "jiti scripts/build-implementations-bundle-types.ts",
-    "build:implementations:generate-types": "jiti scripts/build-implementations-generate-types.ts",
-    "build:static": "jiti scripts/build-static.ts",
-    "commit": "jiti scripts/commit.ts",
-    "format": "jiti scripts/format.ts",
-    "format:check": "jiti scripts/format-check.ts",
-    "lint": "jiti scripts/lint.ts",
-    "lint:fix": "jiti scripts/lint-fix.ts",
-    "lint:md": "jiti scripts/lint-md.ts",
-    "lint:md:fix": "jiti scripts/lint-md-fix.ts",
-    "prepare": "jiti scripts/prepare.ts",
-    "release": "jiti scripts/release.ts",
-    "release:beta": "jiti scripts/release-beta.ts",
-    "spellcheck": "jiti scripts/spellcheck.ts"
-  },
-  "overrides": {
-    "eslint-plugin-import": "$eslint-plugin-import-x",
-    "typescript": "$typescript"
-  },
-  "devDependencies": {
-    "@commitlint/cli": "^21.0.1",
-    "@commitlint/config-conventional": "^21.0.1",
-    "@commitlint/types": "^21.0.1",
-    "@eslint-community/eslint-plugin-eslint-comments": "^4.7.1",
-    "@eslint/compat": "^2.1.0",
-    "@eslint/config-helpers": "^0.6.0",
-    "@eslint/js": "^10.0.1",
-    "@microsoft/api-extractor": "^7.58.7",
-    "@stylistic/eslint-plugin": "^5.10.0",
-    "@total-typescript/ts-reset": "^0.6.1",
-    "@tsconfig/strictest": "^2.0.8",
-    "@types/markdown-it": "^14.1.2",
-    "@types/node": "^25.8.0",
-    "@typescript-eslint/utils": "^8.59.3",
-    "better-typescript-lib": "^2.12.0",
-    "builtin-modules": "^5.2.0",
-    "bun": "^1.3.14",
-    "cspell": "^10.0.0",
-    "czg": "^1.13.1",
-    "dprint": "^0.54.0",
-    "dts-bundle-generator": "^9.5.1",
-    "esbuild": "^0.28.0",
-    "eslint": "^10.4.0",
-    "eslint-import-resolver-typescript": "^4.4.4",
-    "eslint-plugin-import-x": "^4.16.2",
-    "eslint-plugin-jsdoc": "^62.9.0",
-    "eslint-plugin-perfectionist": "^5.9.0",
-    "eslint-plugin-tsdoc": "^0.5.2",
-    "husky": "^9.1.7",
-    "jiti": "^2.7.0",
-    "markdownlint": "^0.40.0",
-    "markdownlint-cli2": "^0.22.1",
-    "markdownlint-rule-relative-links": "^5.1.0",
-    "nano-staged": "^1.0.2",
-    "obsidian": "1.12.3",
-    "semver": "^7.8.0",
-    "ts-morph": "^28.0.0",
-    "type-fest": "^5.6.0",
-    "typescript": "^6.0.3",
-    "typescript-eslint": "^8.59.3"
-  }
+  "name": "obsidian-typings",
+  "type": "module",
+  "types": "./types.d.cts",
+  "version": "5.24.0"
 }

package/types.d.cts

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

package/types.d.mts

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

package/CHANGELOG.md

@@ -1,3 +0,0 @@
-# CHANGELOG
-
-See <https://github.com/obsidian-typings/obsidian-typings/blob/main/CHANGELOG.md>

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 Fevol
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.