svelte-tweakpane-ui 1.2.7 → 1.3.1

package/dist/monitor/Profiler.svelte.d.ts

@@ -1,6 +1,6 @@
 import { SvelteComponent } from 'svelte';
-import type { ProfilerBladeMeasureHandler } from '@kitschpatrol/tweakpane-plugin-profiler';
 import type { Simplify } from '../utils';
+import type { ProfilerBladeMeasureHandler } from '@kitschpatrol/tweakpane-plugin-profiler';
 export type ProfilerCalcMode = 'frame' | 'mean' | 'median';
 export type ProfilerMeasure = (name: string, functionToMeasure: () => void) => void;
 export type ProfilerMeasureAsync = (
@@ -36,13 +36,13 @@ declare const __propDef: {
 		 * @default `undefined`
 		 */
 		measureAsync?: ProfilerMeasureAsync | undefined;
-	} & {
+	} & ({
 		/**
 		 * Number of duration samples from which to calculate the delta value when `calcMode` is
 		 * `'mean'` or `'median'`.
 		 * @default `30`
 		 */
-		bufferSize?: number | undefined;
+		bufferSize?: number;
 		/**
 		 * How to calculate the delta value.
 		 *
@@ -50,7 +50,7 @@ declare const __propDef: {
 		 * calculated from the samples in the buffer.
 		 * @default `'mean'`
 		 */
-		calcMode?: ProfilerCalcMode | undefined;
+		calcMode?: ProfilerCalcMode;
 		/**
 		 * Label suffix for the delta values shown in the control.
 		 *
@@ -58,12 +58,12 @@ declare const __propDef: {
 		 * measuring something other than time.
 		 * @default `'ms'`
 		 * */
-		deltaUnit?: string | undefined;
+		deltaUnit?: string;
 		/**
 		 * Precision of the delta values shown in the control.
 		 * @default `2`
 		 */
-		fractionDigits?: number | undefined;
+		fractionDigits?: number;
 		/**
 		 * Milliseconds between updates to the profiler visualization and delta label text.
 		 *
@@ -71,12 +71,12 @@ declare const __propDef: {
 		 * is determined by your calls to the bound `measure` function.
 		 * @default `500`
 		 */
-		interval?: number | undefined;
+		interval?: number;
 		/**
 		 * Text displayed next to the profiler visualization.
 		 * @default `undefined`
 		 * */
-		label?: string | undefined;
+		label?: string;
 		/**
 		 * Function handle that wraps another function to measure its execution duration.
 		 *
@@ -89,7 +89,7 @@ declare const __propDef: {
 		 * @readonly
 		 * @default `undefined`
 		 */
-		measure?: ProfilerMeasure | undefined;
+		measure?: ProfilerMeasure;
 		/**
 		 * Async variation of function handle that wraps another function to measure its execution
 		 * duration.
@@ -101,7 +101,7 @@ declare const __propDef: {
 		 * @readonly
 		 * @default `undefined`
 		 */
-		measureAsync?: ProfilerMeasureAsync | undefined;
+		measureAsync?: ProfilerMeasureAsync;
 		/**
 		 * Function wrapping the `measure` function.
 		 *
@@ -109,65 +109,61 @@ declare const __propDef: {
 		 * @default [`new
 		 * ProfilerBladeDefaultMeasureHandler()`](https://github.com/kitschpatrol/tweakpane-plugin-profiler/blob/dev/src/ProfilerBladeDefaultMeasureHandler.ts)
 		 */
-		measureHandler?:
-			| {
-					measureStart: () => () => number | Promise<number>;
-			  }
-			| undefined;
+		measureHandler?: ProfilerMeasureHandler;
 		/**
 		 * Determines the horizontal scale and color mapping of the profiler visualization bars.
 		 * @default `16.67`  \
 		 * 60fps.
 		 */
-		targetDelta?: number | undefined;
+		targetDelta?: number;
 	} & Omit<
-			{
-				/**
-				 * Blade configuration exposing Tweakpane's internal
-				 * [`BladeParams`](https://tweakpane.github.io/docs/api/interfaces/BaseBladeParams.html).
-				 *
-				 */
-				options: ProfilerOptions;
-				/**
-				 * Prevent interactivity and gray out the control.
-				 * @default `false`
-				 */
-				disabled?: boolean | undefined;
-				/**
-				 * Custom color scheme.
-				 * @default `undefined`  \
-				 * Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
-				 * set with `setGlobalDefaultTheme()`.
-				 */
-				theme?: import('..').Theme | undefined;
-				/**
-				 * Reference to internal Tweakpane
-				 * [`BladeApi`](https://tweakpane.github.io/docs/api/classes/BladeApi.html) for this blade.
-				 *
-				 * This property is exposed for advanced use cases only, such as when implementing convenience
-				 * components wrapping `<Blade>`'s functionality.
-				 *
-				 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
-				 *
-				 * @bindable
-				 * @readonly
-				 */
-				ref?: ProfilerRef | undefined;
-				/**
-				 * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
-				 * the `<Blade>`'s containing `<Pane>`.
-				 *
-				 * This property is exposed for advanced use cases only, such as when implementing convenience
-				 * components wrapping `<Blade>`'s functionality in combination with a Tweakpane plugin.
-				 *
-				 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
-				 *
-				 * @default `undefined`
-				 */
-				plugin?: import('tweakpane').TpPluginBundle | undefined;
-			},
-			'ref' | 'options' | 'plugin'
-		>;
+		{
+			/**
+			 * Blade configuration exposing Tweakpane's internal
+			 * [`BladeParams`](https://tweakpane.github.io/docs/api/interfaces/BaseBladeParams.html).
+			 *
+			 */
+			options: ProfilerOptions;
+			/**
+			 * Prevent interactivity and gray out the control.
+			 * @default `false`
+			 */
+			disabled?: boolean;
+			/**
+			 * Custom color scheme.
+			 * @default `undefined`  \
+			 * Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
+			 * set with `setGlobalDefaultTheme()`.
+			 */
+			theme?: import('..').Theme | undefined;
+			/**
+			 * Reference to internal Tweakpane
+			 * [`BladeApi`](https://tweakpane.github.io/docs/api/classes/BladeApi.html) for this blade.
+			 *
+			 * This property is exposed for advanced use cases only, such as when implementing convenience
+			 * components wrapping `<Blade>`'s functionality.
+			 *
+			 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
+			 *
+			 * @bindable
+			 * @readonly
+			 */
+			ref?: ProfilerRef | undefined;
+			/**
+			 * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
+			 * the `<Blade>`'s containing `<Pane>`.
+			 *
+			 * This property is exposed for advanced use cases only, such as when implementing convenience
+			 * components wrapping `<Blade>`'s functionality in combination with a Tweakpane plugin.
+			 *
+			 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
+			 *
+			 * @default `undefined`
+			 */
+			plugin?: import('../utils').Plugin | undefined;
+		},
+		'ref' | 'options' | 'plugin'
+	>);
 	slots: {};
 	events: {
 		/**
@@ -189,8 +185,8 @@ export type ProfilerSlots = typeof __propDef.slots;
  * Configured to measure a function's execution duration by default, but can be customized to measure
  * anything.
  *
- * Integrates [kitschpatrol's](https://kitschpatrol.com)
- * [tweakpane-plugin-profiler](https://github.com/kitschpatrol/tweakpane-plugin-profiler).
+ * Integrates [0b5vr's](https://0b5vr.com)
+ * [tweakpane-plugin-profiler](https://github.com/0b5vr/tweakpane-plugin-profiler).
  *
  * See `<FpsGraph>` for a simpler alternative optimized for framerate visualization.
  *

package/dist/monitor/WaveformMonitor.svelte

@@ -1,10 +1,10 @@
 <script context="module"></script>
 
 <script>
-	import * as pluginModule from '@kitschpatrol/tweakpane-plugin-waveform';
 	import ClsPad from '../internal/ClsPad.svelte';
 	import GenericMonitor from '../internal/GenericMonitor.svelte';
 	import { fillWith } from '../utils';
+	import * as pluginModule from '@kitschpatrol/tweakpane-plugin-waveform';
 	import { BROWSER } from 'esm-env';
 	export let value;
 	export let max = void 0;

package/dist/monitor/WaveformMonitor.svelte.d.ts

@@ -1,5 +1,5 @@
 import { SvelteComponent } from 'svelte';
-export type WaveformMonitorValue = Uint8Array | Uint16Array | Uint32Array | number[];
+export type WaveformMonitorValue = number[] | Uint8Array | Uint16Array | Uint32Array;
 import type { WaveformStyles as WaveformMonitorLineStyle } from '@kitschpatrol/tweakpane-plugin-waveform/dist/types/view/waveform.js';
 declare const __propDef: {
 	props: {
@@ -12,17 +12,17 @@ declare const __propDef: {
 		 * Minimum graph bound.
 		 * @default `0`
 		 * */
-		min?: number | undefined;
+		min?: number;
 		/**
 		 * Maximum graph bound.
 		 * @default `100`
 		 * */
-		max?: number | undefined;
+		max?: number;
 		/**
 		 * Line style.
 		 * @default `'linear''`
 		 * */
-		lineStyle?: 'linear' | 'bezier' | undefined;
+		lineStyle?: 'bezier' | 'linear';
 	} & Omit<
 		{
 			/**
@@ -30,14 +30,14 @@ declare const __propDef: {
 			 * @default `1`  \
 			 * Or `64` if value is `number` and `graph` is `true`.
 			 */
-			bufferSize?: number | undefined;
+			bufferSize?: number;
 			/**
 			 * Time between value samples in milliseconds.
 			 *
 			 * Useful when `graph` is true. Defaults to reactive value updates only (`interval={0}`).
 			 * @default `0`
 			 */
-			interval?: number | undefined;
+			interval?: number;
 			/**
 			 * Number of visible rows of state history.
 			 *
@@ -46,7 +46,7 @@ declare const __propDef: {
 			 * @default `1`  \
 			 * Or `3` if value is `string` and `multiline` is `true`.
 			 */
-			rows?: number | undefined;
+			rows?: number;
 		} & {
 			/**
 			 * Waveform values.
@@ -66,7 +66,7 @@ declare const __propDef: {
 					 * Prevent interactivity and gray out the control.
 					 * @default `false`
 					 */
-					disabled?: boolean | undefined;
+					disabled?: boolean;
 					/**
 					 * Text displayed next to control.
 					 * @default `undefined`
@@ -86,9 +86,9 @@ declare const __propDef: {
 					 */
 					options?:
 						| ({
-								min?: number | undefined;
-								max?: number | undefined;
-								lineStyle?: WaveformMonitorLineStyle | undefined;
+								min?: number;
+								max?: number;
+								lineStyle?: WaveformMonitorLineStyle;
 						  } & import('@tweakpane/core').BaseMonitorParams)
 						| undefined;
 					/**
@@ -124,7 +124,7 @@ declare const __propDef: {
 					 *
 					 * @default `undefined`
 					 */
-					plugin?: import('tweakpane').TpPluginBundle | undefined;
+					plugin?: import('../utils').Plugin | undefined;
 				},
 				'object' | 'key'
 			>,
@@ -134,6 +134,8 @@ declare const __propDef: {
 		[evt: string]: CustomEvent<any>;
 	};
 	slots: {};
+	exports?: {} | undefined;
+	bindings?: string | undefined;
 };
 export type WaveformMonitorProps = typeof __propDef.props;
 export type WaveformMonitorEvents = typeof __propDef.events;

package/dist/theme.d.ts

@@ -1,6 +1,6 @@
-import { type RgbColorObject, type RgbaColorObject } from '@tweakpane/core';
 import type { Simplify } from './utils';
-export type ThemeColorValue = Simplify<RgbColorObject | RgbaColorObject | string>;
+import { type RgbaColorObject, type RgbColorObject } from '@tweakpane/core';
+export type ThemeColorValue = Simplify<RgbaColorObject | RgbColorObject | string>;
 export type Theme = CustomThemeKeys & ThemeKeys;
 type ThemeKeys = {
 	baseBackgroundColor?: ThemeColorValue;

package/dist/theme.js

@@ -1,4 +1,4 @@
-import { getWindowDocument, isRgbColorObject, isRgbaColorObject } from '@tweakpane/core';
+import { getWindowDocument, isRgbaColorObject, isRgbColorObject } from '@tweakpane/core';
 // Standard Tweakpane themes from https://tweakpane.github.io/docs/theming/#builder Must be kept in
 // sync with TP...
 const standard = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svelte-tweakpane-ui",
-  "version": "1.2.7",
+  "version": "1.3.1",
   "type": "module",
   "description": "A Svelte component library wrapping UI elements from Tweakpane, plus some additional functionality for convenience and flexibility.",
   "repository": {
@@ -20,7 +20,7 @@
   "license": "MIT",
   "engines": {
     "node": ">=18.0.0",
-    "pnpm": ">=8.0.0"
+    "pnpm": ">=9.0.0"
   },
   "exports": {
     ".": {
@@ -178,57 +178,62 @@
     "svelte-components",
     "ui-components",
     "components-library",
+    "front-end",
     "npm-package"
   ],
   "peerDependencies": {
     "svelte": "^4.0.0"
   },
   "dependencies": {
-    "@kitschpatrol/tweakpane-plugin-camerakit": "^0.3.0",
-    "@kitschpatrol/tweakpane-plugin-essentials": "^0.2.1",
-    "@kitschpatrol/tweakpane-plugin-image": "^2.0.0",
-    "@kitschpatrol/tweakpane-plugin-profiler": "^0.4.1",
-    "@kitschpatrol/tweakpane-plugin-rotation": "^0.2.0",
-    "@kitschpatrol/tweakpane-plugin-textarea": "^2.0.0",
-    "@kitschpatrol/tweakpane-plugin-waveform": "^1.0.3",
-    "@tweakpane/core": "2.0.3",
+    "@kitschpatrol/tweakpane-plugin-camerakit": "0.3.1-beta.2",
+    "@kitschpatrol/tweakpane-plugin-essentials": "0.2.2-beta.2",
+    "@kitschpatrol/tweakpane-plugin-image": "2.0.1-beta.4",
+    "@kitschpatrol/tweakpane-plugin-profiler": "0.4.2-beta.2",
+    "@kitschpatrol/tweakpane-plugin-rotation": "0.2.1-beta.1",
+    "@kitschpatrol/tweakpane-plugin-textarea": "2.0.1-beta.1",
+    "@kitschpatrol/tweakpane-plugin-waveform": "1.0.4-beta.2",
+    "@tweakpane/core": "2.0.4",
     "esm-env": "1.0.0",
-    "fast-copy": "3.0.1",
+    "fast-copy": "3.0.2",
     "fast-equals": "5.0.1",
     "nanoid": "5.0.6",
-    "svelte-local-storage-store": "0.6.4",
-    "tweakpane": "4.0.3"
+    "svelte-persisted-store": "0.11.0",
+    "tweakpane": "4.0.4"
   },
   "devDependencies": {
-    "@kitschpatrol/shared-config": "^4.6.6",
+    "@kitschpatrol/shared-config": "^4.7.10",
     "@phenomnomnominal/tsquery": "^6.1.3",
-    "@playwright/test": "^1.44.0",
+    "@playwright/test": "^1.47.1",
     "@stkb/rewrap": "^0.1.0",
-    "@sveltejs/adapter-static": "^3.0.1",
-    "@sveltejs/kit": "^2.5.9",
-    "@sveltejs/package": "^2.3.1",
-    "@sveltejs/vite-plugin-svelte": "^3.1.0",
-    "@types/eslint": "^8.56.10",
+    "@sveltejs/adapter-static": "^3.0.4",
+    "@sveltejs/kit": "^2.5.27",
+    "@sveltejs/package": "^2.3.5",
+    "@sveltejs/vite-plugin-svelte": "^3.1.2",
+    "@types/eslint": "^8.56.12",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^20.12.12",
-    "bumpp": "^9.4.1",
+    "@types/node": "18.0.0",
+    "bumpp": "^9.5.2",
     "eslint": "^8.57.0",
     "fs-extra": "^11.2.0",
-    "glob": "^10.3.15",
+    "glob": "^11.0.0",
     "npm-run-all": "^4.1.5",
     "postcss-html": "^1.7.0",
-    "publint": "^0.2.8",
+    "publint": "^0.2.10",
     "read-package-up": "^11.0.0",
-    "svelte": "^4.2.17",
-    "svelte-check": "^3.7.1",
-    "svelte-language-server": "^0.16.9",
-    "svelte2tsx": "^0.7.8",
-    "ts-morph": "^22.0.0",
-    "tslib": "^2.6.2",
-    "tsx": "^4.10.5",
-    "typescript": "^5.4.5",
-    "vite": "^5.2.11",
-    "yaml": "^2.4.2"
+    "remark-mdat": "^0.7.3",
+    "svelte": "^4.2.19",
+    "svelte-check": "^4.0.2",
+    "svelte-language-server": "^0.17.0",
+    "svelte2tsx": "^0.7.19",
+    "ts-morph": "^23.0.0",
+    "tslib": "^2.7.0",
+    "tsx": "^4.19.1",
+    "typescript": "^5.6.2",
+    "vite": "^5.4.5",
+    "yaml": "^2.5.1"
+  },
+  "publishConfig": {
+    "access": "public"
   },
   "scripts": {
     "build": "run-s --print-label build:*",
@@ -245,12 +250,13 @@
     "build:11-examples-to-docs": "tsx ./scripts/generate-example-components.ts",
     "build:12-acknowledgments-data": "mkdir -p ./docs/src/content/acknowledgments && pnpm licenses list --json > ./docs/src/content/acknowledgments/acknowledgments-lib.json",
     "build:13-build-docs": "pnpm run docs-build",
-    "check": "svelte-kit sync && svelte-check --ignore ./scratch --tsconfig ./tsconfig.json",
+    "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
     "check-watch": "svelte-kit sync && svelte-check --ignore ./scratch --tsconfig ./tsconfig.json --watch",
-    "clean": "git clean -fdX",
+    "clean": "rm pnpm-lock.yaml ; git clean -fdX",
     "docs-build": "pnpm -C ./docs run build",
     "docs-dev": "pnpm -C ./docs run dev",
     "docs-preview": "pnpm -C ./docs run preview",
+    "fix": "shared-config --fix",
     "format": "run-s --print-label format:*",
     "format:1-shared": "shared-config --fix",
     "format:2-embedded": "tsx ./scripts/format-embedded-code.ts",
@@ -261,7 +267,7 @@
     "lint": "shared-config --check",
     "release": "run-s --print-label release:*",
     "release:1-build": "pnpm run build",
-    "release:2-version": "pnpm bumpp --commit 'Release: %s' --tag 'v%s'",
+    "release:2-version": "bumpp --commit 'Release: %s'",
     "release:3-publish": "pnpm publish --ignore-scripts --otp $(op read 'op://Personal/Npmjs/one-time password?attribute=otp')",
     "rewrap": "rewrap -i --column 100 `find src \\( -name '*.svelte' -o -name '*.ts'  -o -name '*.html' \\) -type f | grep -v src/examples`",
     "test": "run-s --print-label test:*",

package/readme.md

@@ -26,6 +26,7 @@
   }
 } -->
 
+[![NPM Package svelte-tweakpane-ui](https://img.shields.io/npm/v/svelte-tweakpane-ui.svg)](https://npmjs.com/package/svelte-tweakpane-ui)
 [![NPM Package svelte-tweakpane-ui](https://img.shields.io/npm/v/svelte-tweakpane-ui.svg)](https://npmjs.com/package/svelte-tweakpane-ui)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![MadeWithSvelte](https://madewithsvelte.com/storage/repo-shields/4860-shield.svg)](https://madewithsvelte.com/p/svelte-tweakpane-ui/shield-link)
@@ -152,6 +153,12 @@ npm install svelte-tweakpane-ui
 
 [@kitschpatrol](https://github.com/kitschpatrol)
 
+## Acknowledgments
+
+Thank you to [Hiroki Kokubun](https://cocopon.me) for creating the [Tweakpane](https://tweakpane.github.io/docs/) library.
+
+Additional acknowledgments are listed [on the documentation site](https://kitschpatrol.com/svelte-tweakpane-ui/docs/acknowledgments).
+
 <!-- footer -->
 
 ## Contributing