blockbench-types 4.12.1 → 5.0.0-beta.0

package/README.md

@@ -1,3 +1,30 @@
-# Blockbench Types [![npm version](https://img.shields.io/npm/v/blockbench-types)](https://www.npmjs.com/package/blockbench-types)
+# Blockbench Typescript Types!
+
+## Generated types
+All type definitions in the folder /generated/ are auto-generated from the Blockbench source.
+All exports are converted to global declarations.
+To exclude source files from generating types, add them to the "exclude" list in type_config.json.
+To exclude individual exports, use the typescript @private flag.
+
+## Custom types
+All type definitions in the /custom/ folder are manually written and are intended to provide types for old files that are still in Javascript.
+
+
+## Generating types
+Run `npm run generate-types` from the main repo. Ensure typescript throws no errors, otherwise files won't export correctly.
+
+## Locally testing and using types
+To use these types in other projects on your local PC before they are published, run this command in your other project:
+
+`npm install "C:/path/to/blockbench/types"`
+
+Where the path leads to this /types/ folder in the Blockbench repository.
+
+## Publishing types
+
+`npm run publish-types --dry-run`
+
+`npm run publish-types --tag beta`
+
+`npm run publish-types`
 
-Blockbench typescript types!

package/{types → custom}/action.d.ts

@@ -51,6 +51,7 @@ declare global {
 		variations?: {
 			[key: string]: { name: string; description?: string }
 		}
+		readonly label: string
 		set(keys: KeybindKeys): this
 		/**
 		 * Unassign the assigned key
@@ -128,6 +129,7 @@ declare global {
 	class KeybindItem extends Deletable {
 		constructor(id: string, options: KeybindItemOptions)
 		keybind: Keybind
+		condition?: ConditionResolvable
 		variations?: {
 			[key: string]: { name: string; description?: string }
 		}
@@ -147,6 +149,7 @@ declare global {
 		| 'changed'
 		| 'update'
 		| 'open'
+		| 'modify_color'
 	interface BarItemOptions extends KeybindItemOptions {
 		name?: string
 		description?: string
@@ -161,6 +164,11 @@ declare global {
 	class BarItem extends KeybindItem {
 		constructor(id: string, options: BarItemOptions)
 		id: string
+		name: string
+		description: string
+		icon?: string
+		category?: string
+
 		node: HTMLElement
 		nodes: HTMLElement[]
 		conditionMet(): boolean
@@ -177,7 +185,7 @@ declare global {
 		/**
 		 * Appends the bar item to a HTML element
 		 */
-		toElement(destination: HTMLElement): this
+		toElement(destination: HTMLElement | string): this
 		pushToolbar(bar: any): void
 
 		/**
@@ -185,19 +193,19 @@ declare global {
 		 * @param event_name The event type to listen for
 		 * @param callback
 		 */
-		on(event_name: ActionEventName, callback: (data: object) => void): void
+		on(event_name: ActionEventName, callback: (data: Record<string, any>) => void): void
 		/**
 		 * Adds a single-use event listener to the item
 		 * @param event_name The event type to listen for
 		 * @param callback
 		 */
-		once(event_name: ActionEventName, callback: (data: object) => void): void
+		once(event_name: ActionEventName, callback: (data: Record<string, any>) => void): void
 		/**
 		 * Removes an event listener from the item
 		 * @param event_name
 		 * @param callback
 		 */
-		removeListener(event_name: ActionEventName, callback: (data: object) => void): void
+		removeListener(event_name: ActionEventName, callback: (data: Record<string, any>) => void): void
 		constructor(id: string, options: BarItemOptions)
 		conditionMet(): boolean
 		/**
@@ -228,11 +236,7 @@ declare global {
 		 * Icon color. Can be a CSS color string, or an axis letter to use an axis color.
 		 */
 		color?: string
-		/**
-		 * ID of a setting that the action is slinked to
-		 */
-		linked_setting?: string
-		children?: any[]
+		children?: any[] | (() => any[])
 		/**
 		 * Show the full label in toolbars
 		 */
@@ -251,6 +255,7 @@ declare global {
 	 */
 	class Action extends BarItem {
 		constructor(id: string, options: ActionOptions)
+		icon: string
 		nodes: HTMLElement[]
 		/**
 		 * Provide a menu that belongs to the action, and gets displayed as a small arrow next to it in toolbars.
@@ -276,15 +281,20 @@ declare global {
 		setIcon(icon: IconString): void
 		toggleLinkedSetting(change: any): void
 	}
-	interface ToggleOptions extends ActionOptions {
+	interface ToggleOptions extends Omit<ActionOptions, 'click'> {
 		/**
 		 * Default value of the toggle
 		 */
 		default?: boolean
+		/**
+		 * ID of a setting that the toggle is linked to
+		 */
+		linked_setting?: string
 		/**
 		 * Method that gets called when the user changes the value of the toggle
 		 */
 		onChange?(value: boolean): void
+		icon: IconString | (() => selected_layer)
 	}
 	/**
 	 * A toggle is a type of action that can be on or off. The state is not persistent between restarts by default.
@@ -296,8 +306,13 @@ declare global {
 		 * Updates the state of the toggle in the UI
 		 */
 		updateEnabledState(): void
+		/**
+		 * ID of a setting that the toggle is linked to
+		 */
+		linked_setting?: string
 		set(value: boolean): this
 		setIcon(icon: IconString): void
+		icon: IconString | (() => selected_layer)
 	}
 
 	type RGBAColor = { r: number; g: number; b: number; a: number }
@@ -457,6 +472,7 @@ declare global {
 		constructor(id: string, options: WidgetOptions)
 	}
 	type NumSliderOptions = WidgetOptions & {
+		private?: boolean
 		settings?: {
 			default?: number
 			min?: number
@@ -530,7 +546,7 @@ declare global {
 		get(): tinycolor.Instance
 	}
 	interface ToolbarOptions {
-		id: string
+		id?: string
 		name?: string
 		/**
 		 * If true, the toolbar will display a label abovee
@@ -548,6 +564,22 @@ declare global {
 		children: ('_' | '+' | '#' | string | BarItem)[]
 	}
 	class Toolbar {
+		id: string
+		name: string
+		label: boolean
+		label_node: HTMLElement
+		condition: ConditionResolvable
+		children: (BarItem | string)[]
+		no_wrap: boolean
+		narrow: boolean
+		vertical: boolean
+		default_children: (BarItem | string)[]
+		/*private*/ positionLookup: any
+		/*private*/ condition_cache: any
+		/*private*/ previously_enabled: any
+		/*private*/ postload: any
+		/*private*/ menu: any
+		node: HTMLElement
 		constructor(id: string, data: ToolbarOptions)
 		constructor(data: ToolbarOptions)
 		build(data: any, force: any): this
@@ -580,7 +612,8 @@ declare global {
 		const open: boolean
 		const type: string
 		const max_length: number
-		function select(): void
+		function select(input?: string): void
+		function show(input?: string): void
 		function hide(): void
 		function confirm(event: Event): void
 		function cancel(): void

package/{types → custom}/animation.d.ts

@@ -131,6 +131,8 @@ declare namespace Animator {
 	const particle_effects: any
 	const animations: _Animation[]
 	const selected: _Animation | undefined
+	function join(): void
+	function leave(): void
 	function showDefaultPose(no_matrix_update?: boolean): void
 	function resetParticles(): void
 	function showMotionTrail(target?: Group): void

package/custom/blockbench.d.ts

@@ -0,0 +1,71 @@
+/// <reference types="vue" />
+/// <reference types="./three" />
+/// <reference types="@types/prismjs" />
+/// <reference types="@types/jquery" />
+/// <reference types="wintersky" />
+
+/// <reference types="./texture_layers" />
+/// <reference types="./texture_group" />
+/// <reference types="./action" />
+/// <reference types="./animation" />
+/// <reference types="./animation_controller" />
+/// <reference types="./canvas_frame" />
+/// <reference types="./canvas" />
+/// <reference types="./codec" />
+/// <reference types="./cube" />
+/// <reference types="./desktop" />
+/// <reference types="./dialog" />
+/// <reference types="./display_mode" />
+/// <reference types="./format" />
+/// <reference types="./global" />
+/// <reference types="./group" />
+/// <reference types="./interface" />
+/// <reference types="./keyframe" />
+/// <reference types="./menu" />
+/// <reference types="./mesh" />
+/// <reference types="./misc" />
+/// <reference types="./molang" />
+/// <reference types="./outliner" />
+/// <reference types="./painter" />
+/// <reference types="./preview" />
+/// <reference types="./preview_scene" />
+/// <reference types="./project" />
+/// <reference types="./screencam" />
+/// <reference types="./textures" />
+/// <reference types="./timeline" />
+/// <reference types="./undo" />
+/// <reference types="./util" />
+/// <reference types="./uveditor" />
+/// <reference types="./validator" />
+/// <reference types="./shared_actions" />
+/// <reference types="./display_mode" />
+/// <reference types="./misc" />
+/// <reference types="./util" />
+/// <reference types="./math_util" />
+/// <reference types="./canvas_frame" />
+/// <reference types="./io" />
+
+/**
+ * Provides access to global Javascript/DOM variables that are overwritten by Blockbench's own variables
+ */
+declare const NativeGlobals: {
+	Animation: {
+		new (
+			effect?: AnimationEffect | null | undefined,
+			timeline?: AnimationTimeline | null | undefined
+		): Animation
+		prototype: Animation
+	}
+}
+
+/**
+ * Shader support
+ */
+declare module "*.glsl" {
+	const value: string;
+	export default value;
+}
+declare module "*.bbtheme" {
+	const value: string | any;
+	export default value;
+}

package/{types → custom}/canvas.d.ts

@@ -37,6 +37,19 @@ interface UpdateViewOptions {
 	 * Groups to update
 	 */
 	groups?: Group[]
+	/**
+	 * Which aspects of the groups to update
+	 */
+	group_aspects?: {
+		/**
+		 * Update the transform of elements
+		 */
+		transform?: boolean
+		/**
+		 * Update visibility of elements
+		 */
+		visibility?: boolean
+	}
 	/**
 	 * Whether to update the selection (updates the selection outlines and interface)
 	 */
@@ -47,6 +60,7 @@ interface UpdateViewOptions {
  * A global namespace handling miscellaneous functionality related to the 3D preview
  */
 declare namespace Canvas {
+	const gizmo_colors: Record<string, THREE.Color>
 	const materials: {
 		[uuid: UUID]: THREE.Material
 	}
@@ -90,6 +104,9 @@ declare namespace Canvas {
 
 	const pivot_marker: THREE.Object3D
 
+	const ground_plane: THREE.Mesh
+	const brush_outline: THREE.Mesh
+
 	const global_light_color: THREE.Color
 	const global_light_side: number
 
@@ -215,6 +232,7 @@ declare namespace Canvas {
  * Marks a specific aspect of the interface to be updated in the next tick. Useful to avoid an update function getting called multiple times in the same task.
  */
 declare namespace TickUpdates {
+	let interface: undefined | true
 	let outliner: undefined | true
 	let selection: undefined | true
 	let main_uv: undefined | true

package/{types → custom}/codec.d.ts

@@ -45,6 +45,7 @@ interface CodecOptions {
  * A codec represents a specific file format that can be imported into and exported from Blockbench. The codec handles the compilation and parsing, as well as the loading and exporting logic
  */
 declare class Codec extends Deletable {
+	plugin?: string
 	/**
 	 * Creates a new codec
 	 * @param id Codec ID
@@ -58,7 +59,7 @@ declare class Codec extends Deletable {
 	 * @param file
 	 * @param add
 	 */
-	load(model: any, file: any, add?: boolean): void
+	load(model: any, file?: any, add?: boolean): void
 	/**
 	 * Compiles the file content
 	 * @param options
@@ -147,6 +148,11 @@ declare class Codec extends Deletable {
 		[key: string]: FormElement
 	}
 
+	/**
+	 * Additional properties
+	 */
+	[key: string]: any
+
 	format: ModelFormat
 
 	/**

package/{types → custom}/cube.d.ts

@@ -38,6 +38,10 @@ declare class Cube extends OutlinerElement {
 	 * UV mirror across the X axis when using Box UV
 	 */
 	mirror_uv: boolean
+	/**
+	 * If the cube is using Box UV
+	 */
+	box_uv: boolean
 	/**
 	 * Inflate adds an inflation value to all sides equally
 	 */

package/{types → custom}/desktop.d.ts

@@ -12,3 +12,4 @@ declare function openDefaultTexturePath(): void
 declare function findExistingFile(paths: string[]): any
 declare function createBackup(init: any): void
 declare function closeBlockbenchWindow(): any
+declare const currentwindow: any

package/{types → custom}/dialog.d.ts

@@ -1,115 +1,5 @@
-interface FormElement {
-	label?: string
-	/**
-	 * Detailed description of the field, available behind the questionmark icon or on mouse hover
-	 */
-	description?: string
-	type:
-		| 'text'
-		| 'number'
-		| 'range'
-		| 'checkbox'
-		| 'select'
-		| 'radio'
-		| 'textarea'
-		| 'vector'
-		| 'color'
-		| 'file'
-		| 'folder'
-		| 'save'
-		| 'inline_select'
-		| 'inline_multi_select'
-		| 'info'
-		| 'num_slider'
-		| 'buttons'
-	/**
-	 * If true, the label will be displayed without colon at the end
-	 */
-	nocolon?: boolean
-	/**
-	 * Stretch the input field across the whole width of the form
-	 */
-	full_width?: boolean
-	/** Set the input to read-only */
-	readonly?: boolean
-	/** Add buttons to allow copying and sharing the text or link */
-	share_text?: boolean
-	/**
-	 * The default value
-	 */
-	value?: any
-	/**
-	 * The default selected option for 'select', 'inline_select' and 'radio' types. Alias for 'value'
-	 */
-	default?: any
-	placeholder?: string
-	/**
-	 * When using 'text' type, the text to display. Markdown is supported
-	 */
-	text?: string
-	/**
-	 * When using 'range' type, allow users to modify the numeric input
-	 */
-	editable_range_label?: boolean
-	colorpicker?: any
-	/**
-	 * On numeric inputs, the minimum possible value
-	 */
-	min?: number
-	/**
-	 * On numeric inputs, the maximum possible value
-	 */
-	max?: number
-	/**
-	 * The step in which the value can be increased / decreased
-	 */
-	step?: number
-	/**
-	 * If enabled, the value is forced to multiples of the "step" value. This can be used to create integer-only inputs etc.
-	 */
-	force_step?: boolean
-	/**
-	 * The height of the input on textareas, in pixels
-	 */
-	height?: number
-	/**
-	 * Available options on select or inline_select inputs
-	 */
-	options?: { [key: string]: string | { name: string } }
-	/**
-	 * List of buttons for the button type
-	 */
-	buttons?: string[]
-
-	/**
-	 * Function to get the interval value for a num_slider based on the input event
-	 * @returns Interval value
-	 */
-	getInterval?: (event: Event) => number
-	/**
-	 * For num_sliders, the sliding interval mode
-	 */
-	interval_type?: 'position' | 'rotation'
-	/**
-	 * Allow users to toggle the entire option on or off
-	 */
-	toggle_enabled?: boolean
-	/**
-	 * Set whether the setting is toggled on or off by default. Requires 'toggle_enabled' field to be set to true
-	 */
-	toggle_default?: boolean
-	/**
-	 * Runs when any of the buttons is pressed
-	 * @param button_index Index of the clicked button in the buttons list
-	 */
-	click?: (button_index: number) => void
-}
-
 type FormResultValue = string | number | boolean | []
 
-type InputFormConfig = {
-	[formElement: string]: '_' | FormElement
-}
 
 declare class InputForm {
 	constructor(form_config: InputFormConfig)

package/{types → custom}/format.d.ts

@@ -4,7 +4,7 @@ interface FormatPage {
 	component?: Vue.Component
 	content?: (
 		| {
-				type: 'image' | 'h2' | 'h3' | 'h4' | 'text' | 'label' | 'image' | ''
+				type?: 'image' | 'h2' | 'h3' | 'h4' | 'text' | 'label' | 'image' | ''
 				text?: string
 				source?: string
 				width?: number
@@ -55,6 +55,7 @@ interface FormatOptions {
 	confidential?: boolean
 	condition?: ConditionResolvable
 	show_on_start_screen?: boolean
+	can_convert_to?: boolean
 	format_page?: FormatPage
 	onFormatPage?(): void
 	onStart?(): void
@@ -129,6 +130,10 @@ interface FormatOptions {
 	 * Enable mesh elements
 	 */
 	meshes: boolean
+	/**
+	 * Enable spline elements
+	 */
+	splines: boolean
 	/**
 	 * Enable texture meshes
 	 */
@@ -246,11 +251,14 @@ declare class ModelFormat extends Deletable implements FormatOptions {
 	confidential: boolean
 	condition?: ConditionResolvable
 	show_on_start_screen: boolean
+	can_convert_to: boolean
 	format_page?: FormatPage
 	onFormatPage?(): void
 	onStart?(): void
 	onSetup?(): void
 
+	setup_dialog?: Dialog
+
 	codec?: Codec
 
 	cube_size_limiter?: CubeSizeLimiter

package/{types → custom}/global.d.ts

@@ -21,6 +21,9 @@ declare global {
 	function rotateOnAxis(modify: OutlinerNode, axis: number, slider?: boolean): void
 	function afterRotateOnAxis(): void
 
+	function showItemInFolder(path: string): void
+	const app: Electron.App
+
 	// const Transformer: THREE.TransformControls
 	interface HTMLImageElement {
 		src: string

package/{types → custom}/group.d.ts

@@ -17,6 +17,8 @@ interface GroupOptions {
 	export: boolean
 	/**Auto UV setting for the children. Can be 0, 1 or 2. */
 	autouv: 0 | 1 | 2
+	mirror_uv: boolean
+	color: number
 }
 
 declare class Group extends OutlinerNode {
@@ -53,6 +55,8 @@ declare class Group extends OutlinerNode {
 	selected: boolean
 	visibility: boolean
 	autouv: 0 | 1 | 2
+	mirror_uv: boolean
+	color: number
 	isOpen: boolean
 	ik_enabled: boolean
 	ik_chain_length: number
@@ -64,6 +68,8 @@ declare class Group extends OutlinerNode {
 	cem_scale?: number
 	mesh: THREE.Mesh
 
+	[key: string]: any
+
 	static preview_controller: NodePreviewController
 
 	extend(options: Partial<GroupOptions>): this

package/{types → custom}/misc.d.ts

@@ -1,10 +1,19 @@
 /// <reference path="./blockbench.d.ts"/>
 
 declare class Deletable {
+	/**
+	 * The ID of the plugin that created the object
+	 */
+	plugin?: string
 	delete(): void
 }
 type UUID = string
 
+
+declare global {
+	const settings: typeof settings
+}
+
 /**
  * True if Blockbench runs as a native app
  */
@@ -109,6 +118,8 @@ type EventName =
 	| 'edit_layer_properties'
 	| 'select_texture'
 	| 'compile_texture_mcmeta'
+	| 'register_element_type'
+	| 'edit_collection_properties'
 
 type IconString = string
 
@@ -127,6 +138,8 @@ interface MessageBoxOptions {
 	message?: string
 	icon?: string
 	width?: number
+	cancelIndex?: number
+	confirmIndex?: number
 	/**
 	 * Display a list of actions to do in the dialog. When clicked, the message box closes with the string ID of the command as first argument.
 	 */
@@ -210,6 +223,7 @@ declare class Property<T extends keyof IPropertyType> extends Deletable {
 	condition: ConditionResolvable
 	exposed: boolean
 	label: any
+	inputs?: any
 	merge(instance: IPropertyType[T], data: IPropertyType[T]): void
 	reset(instance: IPropertyType[T]): void
 	getDefault(instance: IPropertyType[T]): IPropertyType[T]
@@ -233,7 +247,7 @@ declare namespace Language {
 		[key: string]: string
 	}
 	/**
-	 * Two letter code indicating the currently selected language
+	 * Language code indicating the currently selected language
 	 */
 	const code: string
 	/**
@@ -250,17 +264,6 @@ interface Object {
 
 declare var LZUTF8: any
 
-interface ToastNotificationOptions {
-	text: string
-	icon?: string
-	expire?: number
-	color?: string
-	click?: () => boolean
-}
-declare namespace Blockbench {
-	function showToastNotification(options: ToastNotificationOptions): Deletable
-}
-
 declare function unselectAllElements(): void
 declare function updateCubeHighlights(hover_cube: Cube, force_off: boolean): void
 declare function getRescalingFactor(angle: number): number

package/{types → custom}/outliner.d.ts

@@ -10,6 +10,7 @@ declare const elements: OutlinerNode[]
 declare class OutlinerNode {
 	static properties: Record<string, Property<any>>
 	constructor(uuid: UUID)
+	type: string
 	name: string
 	uuid: UUID
 	export: boolean
@@ -21,8 +22,9 @@ declare class OutlinerNode {
 	 * Initializes the node. This should always be called when creating nodes that will be used in the outliner.
 	 */
 	init(): this
-	addTo(target?: OutlinerNode): this
+	addTo(target?: OutlinerNode | 'root'): this
 	sortInBefore(target?: OutlinerNode, index_modifier?: number): this
+	select(event?: any, isOutlinerClick?: boolean): this | void
 	getParentArray(): OutlinerNode[]
 	/**
 	 * Unfolds the outliner and scrolls up or down if necessary to show the group or element.
@@ -57,7 +59,7 @@ declare class OutlinerNode {
 	 * Displays the context menu of the element
 	 * @param event Mouse event, determines where the context menu spawns.
 	 */
-	showContexnu(event: Event | HTMLElement): this
+	showContexMenu(event: Event | HTMLElement): this
 	getSaveCopy?(...args: any[]): Record<string, any>
 	sanitizeName(): string
 
@@ -195,7 +197,8 @@ declare namespace Outliner {
 declare const markerColors: {
 	pastel: string
 	standard: string
-	name: string
+	id: string
+	name?: string
 }[]
 
 declare function compileGroups(undo: boolean, lut?: { [index: number]: number }): any[]