obsidian-typings 1.0.0

package/.editorconfig

@@ -0,0 +1,15 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = crlf
+charset = utf-8
+trim_trailing_whitespace = false
+insert_final_newline = false
+
+[*.ts]
+quote_type = single

package/LICENSE

@@ -0,0 +1,21 @@
+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.

package/README.md

@@ -0,0 +1,36 @@
+This repository contains TypeScript typings for undocumented [Obsidian](https://obsidian.md/) API functions.
+
+There are three options for installing this package:
+1. **Explicit type importing:** Each typing has to be imported explicitly, e.g. `import {App, MarkdownView} from "@fevol/obsidian-typings"`. <br> _Install via:_ `npm install --save-dev  npm install @fevol/obsidian-typings`
+
+
+
+
+
+You can add the code as a submodule to your project - or as an NPM package via `npm install --save-dev  npm install @fevol/obsidian-typings`.
+
+If you prefer to have automatic types discovery without needing to explicitly `import` current package, use `npm install --save-dev @types/obsidian-typings@npm:@fevol/obsidian-typings`
+
+These typings contain _almost_ all of the undocumented API methods and variables, excluding those that 
+seem to be intended solely for internal use and will not be relevant for plugin development.
+
+Please be aware that there is a good reason why the functions and types defined here are not included with the official
+API definitions:
+- The methods are not fully defined, and will be changed or removed in the near-future
+- There is a high risk of the code behaving unexpectedly if used improperly
+- The function was never meant to be used
+
+So, please use the functions and variables provided with caution. Be prepared to update your code if the API changes,
+and only use the functions if you are confident that you understand what they do. Reference the [official API](https://github.com/obsidianmd/obsidian-api/blob/master/obsidian.d.ts) 
+first to see if your problem may be solved with a documented function, or search
+in the #plugin-dev channel of the Obsidian Discord server.
+
+Furthermore, there is a very high chance that I made a mistake in the typings, despite my best efforts.
+All the types had to be deduced from either context, manually running the function, or the minified app code. 
+You will have to verify if the code behaves as expected, both with regard to the expected types, as well as what 
+the function description says.
+
+With all the scary disclaimers out of the way, hopefully these typings will help in removing 90% of the `@ts-ignore`s
+you have in your codebase, or let you discover solutions that didn't seem possible before.
+
+PR's and issue reports are welcome for missing, deprecated or incorrectly defined typings.

package/dummy.ts

@@ -0,0 +1 @@
+// NOTE: This file is required to make `tsc` build working