update deps; clean up code

Author: mProjectsCode

CHANGELOG.md

@@ -48,16 +48,16 @@ You are more than welcome to open an issue on [GitHub](https://github.com/mProje
 
 I want to thank the following people:
 
--   blacksmithgu for the Dataview type definitions
--   Daniel (dbarenholz) for his contributions to the plugin and the docs
--   koala (kometenstaub) for help with CodeMirror
--   sailKite for help with CSS
--   Sigrunixia for enabling me to work on the Obsidian Publish version of the plugin
--   Zachatoo and SilentVoid13 for the Templater type definitions
+- blacksmithgu for the Dataview type definitions
+- Daniel (dbarenholz) for his contributions to the plugin and the docs
+- koala (kometenstaub) for help with CodeMirror
+- sailKite for help with CSS
+- Sigrunixia for enabling me to work on the Obsidian Publish version of the plugin
+- Zachatoo and SilentVoid13 for the Templater type definitions
 
--   All the contributors to the plugin and the docs
--   All the authors of the libraries used in the plugin
--   Everyone who has given feedback and suggestions
+- All the contributors to the plugin and the docs
+- All the authors of the libraries used in the plugin
+- Everyone who has given feedback and suggestions
 
 ## Contributions
 
@@ -70,10 +70,10 @@ Contributions are always welcome. If you have an idea, feel free to open a featu
 The plugin uses [Bun](https://bun.sh/) instead of Node.js/NPM to manage dependencies.
 To install the dependencies, run `bun install` and `bun run pack:i` in the root directory of the project.
 
--   `bun run dev` will build the plugin in dev mode and watch for changes. The plugin builds directly into the example vault inside of this repo.
--   `bun run build` will build the plugin in production mode. The plugin builds into the root of this repo.
--   `bun run test` will run the tests.
--   `bun run check` will check for formatting, linting, type errors and run the tests.
--   `bun run check:fix` will fix formatting and linting errors, check for type errors and run the tests.
+- `bun run dev` will build the plugin in dev mode and watch for changes. The plugin builds directly into the example vault inside of this repo.
+- `bun run build` will build the plugin in production mode. The plugin builds into the root of this repo.
+- `bun run test` will run the tests.
+- `bun run check` will check for formatting, linting, type errors and run the tests.
+- `bun run check:fix` will fix formatting and linting errors, check for type errors and run the tests.
 
 `bun run check` should run successfully before creating a pull request.

README.md

@@ -1,5 +1,5 @@
 ---
-slider1: 3
+slider1: 5
 suggest: test
 toggle1: false
 Domestic_tasks:
@@ -13,7 +13,7 @@ inlineSelect: 1
 nested:
   object: test
 number1: 2
-number2: 4
+number2: 18
 time: 
 ---
 

bun.lockb

@@ -32,35 +32,35 @@
 		"@elysiajs/cors": "^1.1.1",
 		"@happy-dom/global-registrator": "^14.12.3",
 		"@tsconfig/svelte": "^5.0.4",
-		"@types/bun": "^1.1.13",
+		"@types/bun": "^1.1.14",
 		"builtin-modules": "^4.0.0",
-		"elysia": "^1.1.24",
+		"elysia": "^1.1.25",
 		"esbuild": "^0.24.0",
 		"esbuild-plugin-copy-watch": "^2.3.1",
 		"esbuild-svelte": "^0.8.2",
-		"eslint": "^9.14.0",
+		"eslint": "^9.15.0",
 		"eslint-plugin-import": "^2.31.0",
 		"eslint-plugin-isaacscript": "^4.0.0",
 		"eslint-plugin-no-relative-import-paths": "^1.5.5",
 		"eslint-plugin-only-warn": "^1.1.0",
 		"eslint-plugin-svelte": "^2.46.0",
-		"prettier": "^3.3.3",
-		"prettier-plugin-svelte": "^3.2.7",
+		"prettier": "^3.4.0",
+		"prettier-plugin-svelte": "^3.3.2",
 		"string-argv": "^0.3.2",
-		"svelte-check": "^4.0.5",
+		"svelte-check": "^4.1.0",
 		"svelte-preprocess": "^6.0.3",
 		"tslib": "^2.8.1",
-		"typescript": "^5.6.3",
-		"typescript-eslint": "^8.13.0",
-		"yaml": "^2.6.0"
+		"typescript": "^5.7.2",
+		"typescript-eslint": "^8.16.0",
+		"yaml": "^2.6.1"
 	},
 	"dependencies": {
 		"@codemirror/legacy-modes": "^6.4.2",
 		"@lemons_dev/parsinom": "^0.0.12",
 		"itertools-ts": "^1.27.1",
-		"mathjs": "^13.2.0",
+		"mathjs": "^14.0.0",
 		"moment": "^2.30.1",
-		"svelte": "^5.1.9",
+		"svelte": "^5.2.8",
 		"zod": "^3.23.8",
 		"zod-validation-error": "^3.4.0"
 	},

exampleVault/Examples.md

@@ -1,18 +1,4 @@
 import { SyntaxHighlightingAPI } from 'packages/core/src/api/SyntaxHighlightingAPI';
-import {
-	V_BindTargetDeclaration,
-	V_BindTargetScope,
-	V_ButtonOptions,
-	V_EmbedOptions,
-	V_FieldType,
-	V_FilePath,
-	V_InlineButtonOptions,
-	V_InputFieldOptions,
-	V_JsViewFieldOptions,
-	V_RenderChildType,
-	V_TableFieldOptions,
-	V_ViewFieldOptions,
-} from 'packages/core/src/api/Validators';
 import type {
 	ButtonGroupOptions,
 	ButtonOptions,
@@ -30,6 +16,20 @@ import {
 	NotePosition,
 	RenderChildType,
 } from 'packages/core/src/config/APIConfigs';
+import {
+	V_BindTargetDeclaration,
+	V_BindTargetScope,
+	V_ButtonOptions,
+	V_EmbedOptions,
+	V_FieldType,
+	V_FilePath,
+	V_InlineButtonOptions,
+	V_InputFieldOptions,
+	V_JsViewFieldOptions,
+	V_RenderChildType,
+	V_TableFieldOptions,
+	V_ViewFieldOptions,
+} from 'packages/core/src/config/validators/Validators';
 import { ButtonActionRunner } from 'packages/core/src/fields/button/ButtonActionRunner';
 import { ButtonGroupMountable } from 'packages/core/src/fields/button/ButtonGroupMountable';
 import { ButtonManager } from 'packages/core/src/fields/button/ButtonManager';

package.json

@@ -1,9 +1,21 @@
 import type { LinePosition } from 'packages/core/src/config/APIConfigs';
 
 export enum ButtonStyleType {
+	/**
+	 * Default grey button
+	 */
 	DEFAULT = 'default',
+	/**
+	 * Primary button in the accent color
+	 */
 	PRIMARY = 'primary',
+	/**
+	 * Red button for destructive actions
+	 */
 	DESTRUCTIVE = 'destructive',
+	/**
+	 * Plain button with no background
+	 */
 	PLAIN = 'plain',
 }
 
@@ -123,14 +135,52 @@ export type ButtonAction =
 	| InlineJSButtonAction;
 
 export interface ButtonConfig {
+	/**
+	 * The text displayed on the button
+	 */
 	label: string;
+	/**
+	 * Optional icon to display in front of the label
+	 */
 	icon?: string;
+	/**
+	 * The style of the button
+	 */
 	style: ButtonStyleType;
+	/**
+	 * Optional CSS class to add to the button
+	 */
 	class?: string;
+	/**
+	 * Optional CSS styles to add to the button
+	 */
+	cssStyle?: string;
+	/**
+	 * Optional background image to add to the button,
+	 * needed since you can't load images from the vault via pure CSS
+	 */
+	backgroundImage?: string;
+	/**
+	 * Optional tooltip to display when hovering over the button
+	 */
 	tooltip?: string;
+	/**
+	 * Optional ID for use in inline buttons
+	 */
 	id?: string;
+	/**
+	 * Whether the button is hidden
+	 */
 	hidden?: boolean;
+	/**
+	 * A single action to run when the button is clicked
+	 * Mutually exclusive with `actions`
+	 */
 	action?: ButtonAction;
+	/**
+	 * Multiple actions to run when the button is clicked
+	 * Mutually exclusive with `action`
+	 */
 	actions?: ButtonAction[];
 }
 
@@ -140,6 +190,9 @@ export interface ButtonContext {
 	isInline: boolean;
 }
 
+/**
+ * Provides information about the button click event.
+ */
 export interface ButtonClickContext {
 	type: ButtonClickType;
 	shiftKey: boolean;
@@ -148,10 +201,19 @@ export interface ButtonClickContext {
 }
 
 export enum ButtonClickType {
+	/**
+	 * The user used the left mouse button to click the button
+	 */
 	LEFT = 'left',
+	/**
+	 * The user used the middle mouse button (also known as scroll wheel click) to click the button
+	 */
 	MIDDLE = 'middle',
 }
 
+/**
+ * Maps action types to their respective action interfaces.
+ */
 export interface ButtonActionMap {
 	[ButtonActionType.COMMAND]: CommandButtonAction;
 	[ButtonActionType.JS]: JSButtonAction;