blockbench-types 4.2.0 → 4.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blockbench-types",
-  "version": "4.2.0",
+  "version": "4.4.0",
   "description": "Blockbench typescript types",
   "main": "",
   "types": "types/index.d.ts",
@@ -19,6 +19,7 @@
   "homepage": "https://github.com/JannisX11/blockbench-types#readme",
   "dependencies": {
     "@types/jquery": "^3.5.4",
+    "@types/tinycolor2": "^1.4.3",
     "three": "^0.129.0",
     "vue": "^2.6.14",
     "wintersky": "^1.1.0"

package/types/action.d.ts

@@ -54,20 +54,128 @@ interface ActionOptions extends BarItemOptions {
 }
 declare class Action extends BarItem {
     constructor(id: string, options: ActionOptions);
+    /**
+     * Trigger to run or select the action. This is the equivalent of clicking or using a keybind to trigger it. Also checks if the condition is met.
+     */
     trigger(event: Event): boolean;
     updateKeybindingLabel(): this;
-    setIcon(icon: string): void;
+    /** Change the icon of the action */
+    setIcon(icon: IconString): void;
     toggleLinkedSetting(change: any): void;
     nodes: HTMLElement[]
+    /**
+     * Provide a menu that belongs to the action, and gets displayed as a small arrow next to it in toolbars.
+     */
+    side_menu?: Menu
+}
+
+type RGBAColor = {r: number, g: number, b: number, a: number}
+type ViewMode = 'textured' | 'solid' | 'wireframe' | 'uv' | 'normal'
+type PaintContext = {
+    /**
+     * Brush color, set by the Blockbench color panel
+    */
+    color: string,
+    /**
+     * Opacity, as set by the Opacity slider
+     */
+    opacity: number,
+    /**
+     * 2D Canvas context of the texture that is being edited
+     */
+    ctx: CanvasRenderingContext2D,
+    /**X Coordinate of the position of the brush stroke */
+    x: number,
+    /**Y Coordinate of the position of the brush stroke */
+    y: number,
+    /**
+     * Brush size, as set by the Brush Size slider
+     */
+    size: number,
+    /**
+     * Brush softness, as set by the Brush Softness slider
+     */
+    softness: number,
+    /**
+     * Blockbench texture that is being edited
+     */
+    texture: Texture,
+    /**
+     * Javascript pointer event that the brush stroke originated from
+     */
+    event: PointerEvent
 }
+interface BrushOptions {
+    /**
+     * Enable the input for blend modes when this tool is selected
+     */
+    blend_modes: boolean
+    /**
+     * Enable the input for shapes when this tool is selected
+     */
+    shapes: boolean
+    /**
+     * Enable the input for brush size when this tool is selected
+     */
+    size: boolean
+    /**
+     * Enable the input for softness when this tool is selected
+     */
+    softness: boolean
+    /**
+     * Enable the input for opacity when this tool is selected
+     */
+    opacity: boolean
+    /**
+     * When the brush size is an even number, offset the snapping by half a pixel so that even size brush strokes can be correctly centered
+     */
+    offset_even_radius: boolean
+    /**
+     * Set whether the brush coordinates get floored to snap to the nearest pixel.
+     */
+    floor_coordinates: boolean | (() => boolean)
+    /**
+     * Function that runs per pixel when the brush is used. Mutually exclusive with draw().
+     * @param pixel_x Local X coordinate relative to the brush center
+     * @param pixel_y Local Y coordinate relative to the brush center
+     * @param pixel_color Current color of the pixel on the texture
+     * @param local_opacity Local opacity of the current pixel on the brush, between 0 and 1. Opacity falls of to the sides of the brush if the brush is set to smooth. Opacity from the Opacity slider is not factored in yet.
+     * @param PaintContext Additional context to the paint stroke
+     */
+    changePixel(pixel_x: number, pixel_y, pixel_color: RGBAColor, local_opacity: number, PaintContext: PaintContext): RGBAColor
+    /**
+     * Function that runs when a new brush stroke starts. Return false to cancel the brush stroke
+     * @param context 
+     */
+    onStrokeStart(context: {texture: Texture, x: number, y: number, uv?: object, event: PointerEvent, raycast_data: RaycastResult}): boolean
+    /**
+     * Function that runs when a new brush stroke starts. Return false to cancel the brush stroke
+     * @param context 
+     */
+    onStrokeMove(context: {texture: Texture, x: number, y: number, uv?: object, event: PointerEvent, raycast_data: RaycastResult}): boolean
+    /**
+     * Function that runs when a new brush stroke starts.
+     * @param context 
+     */
+    onStrokeEnd(context: {texture: Texture, x: number, y: number, uv?: object, raycast_data: RaycastResult})
+    /**
+     * Alternative way to create a custom brush, mutually exclusive with the changePixel() function. Draw runs once every time the brush starts or moves, and also along the bath on lines.
+     * @param context 
+     */
+    draw(context: {ctx: CanvasRenderingContext2D, x: number, y: number, size: number, softness: number, texture: Texture, event: PointerEvent})
 
+}
 interface ToolOptions extends ActionOptions {
     selectFace?: boolean
+    selectElements?: boolean
     transformerMode?: 'translate' | ''
     animation_channel?: string
     toolbar?: string
     alt_tool?: string
     modes?: string[]
+    allowed_view_modes?: ViewMode
+    paintTool?: boolean
+    brush?: BrushOptions
 }
 declare class Tool extends Action {
     constructor(id: string, options: ToolOptions);

package/types/canvas.d.ts

@@ -48,18 +48,37 @@ declare const Canvas: {
     bones: {
         [uuid: UUID]: THREE.Object3D
     };
+    /**
+     * Main scene, shared across all tabs
+     */
+    scene: THREE.Scene
+    /**
+     * List of the gizmos (control and UI elements) in the 3D scene
+     */
+    gizmos: []
     /**
      * The material used for all selection outlines
      */
     outlineMaterial: THREE.LineBasicMaterial;
+    meshOutlineMaterial: THREE.LineBasicMaterial;
     /**
      * The material used for the wireframe view
      */
     wireframeMaterial: THREE.MeshBasicMaterial;
+    solidMaterial: THREE.ShaderMaterial;
+    normalHelperMaterial: THREE.ShaderMaterial;
+    uvHelperMaterial: THREE.ShaderMaterial;
+    meshVertexMaterial: THREE.PointsMaterial;
     /**
      * The material used for the grids
      */
     gridMaterial: THREE.LineBasicMaterial;
+
+    pivot_marker: THREE.Object3D
+
+    global_light_color: THREE.Color
+    global_light_side: number
+
     face_order: string[];
 
     /**
@@ -74,6 +93,8 @@ declare const Canvas: {
      * Clear all elements from the scene
      */
     clear(): void;
+    buildGrid(): void;
+    updateShading(): void;
     /**
      * Updates selected aspects of the preview
      * @param options 
@@ -161,6 +182,10 @@ declare const Canvas: {
      * @param animation Whether to display the current animated texture frame
      */
     updateUV(cube: Cube, animation?: boolean): any;
+    /**
+     * Update the materials of marker colors if new colors were added
+     */
+    updateMarkerColorMaterials(): void;
     /**
      * Create an additional outline around the specified cubes
      * @param arr List of cubes to outline

package/types/dialog.d.ts

@@ -0,0 +1,154 @@
+interface DialogFormElement {
+	label: string
+	description?: string
+	type: 'text' | 'number' | 'checkbox' | 'select' | 'radio' | 'textarea' | 'vector' | 'color' | 'file' | 'folder' | 'save' | 'info'
+	nocolon?: boolean
+	readonly?: boolean
+	value?: any
+	placeholder?: string
+	text?: string
+	colorpicker?: any
+	min?: number
+	max?: number
+	step?: number
+	height?: number
+	options?: object
+}
+
+type FormResultValue = string|number|boolean|[]
+
+interface ActionInterface {
+	name: string
+	description?: string
+	icon: string,
+	click: (event: Event) => void
+	condition: Condition
+}
+interface DialogOptions {
+	title: string
+	id: string
+	/**
+	 * Default button to press to confirm the dialog. Defaults to the first button.
+	 */
+	confirmIndex?: number
+	/**
+	 * Default button to press to cancel the dialog. Defaults to the last button.
+	 */
+	cancelIndex?: number
+	/**
+	 *  Function to execute when the user confirms the dialog
+	 */
+	onConfirm?: (formResult: object) => void
+	/**
+	 * Function to execute when the user cancels the dialog
+	 */
+	onCancel?: () => void
+	/**
+	 * Triggered when the user presses a specific button
+	 */
+	onButton?: (button_index: number, event?: Event) => void
+	/**
+	 * Function to run when anything in the form is changed
+	 */
+	onFormChange?: (form_result: {[key: string]: FormResultValue}) => void
+	/**
+	 * Array of HTML object strings for each line of content in the dialog.
+	 */
+	lines?: (string|HTMLElement)[]
+	/**
+	 * Creates a form in the dialog
+	 */
+	form?: {
+		[formElement: string]: '_' | DialogFormElement
+	}
+	/**
+	 * Vue component
+	 */
+	component?: Vue.Component
+	/**
+	 * Order that the different interface types appear in the dialog. Default is 'form', 'lines', 'component'.
+	 */
+	part_order?: string[]
+	form_first?: boolean
+	/**
+	 * Creates a dialog sidebar
+	 */
+	sidebar?: DialogSidebarOptions
+	/**
+	 * Menu in the handle bar
+	 */
+	title_menu?: Menu
+	/**
+	 * If true, the dialog will only have one button to close it
+	 */
+	singleButton?: boolean
+	/**
+	 * List of buttons
+	 */
+	buttons?: string[]
+}
+
+interface DialogSidebarOptions {
+	pages?: {
+		[key: string]: string | {label: string, icon: IconString, color?: string}
+	}
+	page?: string
+	actions?: (Action|ActionInterface|string)[],
+	onPageSwitch?: (page: string) => void
+}
+declare class DialogSidebar {
+	constructor(options: DialogSidebarOptions)
+
+	pages: {
+		[key: string]: string
+	}
+	page: string
+	actions: (Action|string)[]
+	onPageSwitch(page: string): void
+	build(): void
+	toggle(state?: boolean): void
+	setPage(page: string): void
+}
+
+declare class Dialog {
+	constructor (options: DialogOptions)
+
+	id: string
+	component: Vue.Component
+	sidebar: DialogSidebar | null
+
+
+	show: () => Dialog
+	hide: () => Dialog
+	/**
+	 * Triggers the confirm event of the dialog.
+	 */
+	confirm: (event?: Event) => void
+	/**
+	 * Triggers the cancel event of the dialog.
+	 */
+	cancel: (event?: Event) => void
+	/**
+	 * Closes the dialog using the index of the pressed button
+	 */
+	close: (button: number, event?: Event) => void
+	/**
+	 * If the dialog contains a form, return the current values of the form
+	 */
+	getFormResult(): {
+		[key: string]: FormResultValue
+	}
+	/**
+	 * Set the values of the dialog form inputs
+	 */
+	setFormValues(values: {[key: string]: FormResultValue}): void
+	/**
+	 * Delete the dialog object, causing it to be re-build from scratch on next open
+	 */
+	delete(): void
+
+	/**
+	 * Currently opened dialog
+	 */
+	static open: Dialog | null
+}

package/types/file_system.d.ts

@@ -135,7 +135,7 @@ declare namespace Blockbench {
          */
         propagate?: boolean
     }
-    export function addDragHandler(id: string, options: DragHandlerOptions, callback?: () => void): void
+    export function addDragHandler(id: string, options: DragHandlerOptions, callback?: () => void): Deletable
     export function removeDragHandler(id: string): void
 
 }

package/types/format.d.ts

@@ -1,29 +1,79 @@
+interface FormatPage {
+	component?: Vue.Component
+	content?: ({
+		type: 'image' | 'h2' | 'h3' | 'h4' | 'text' | 'label' | 'image' | ''
+		text?: string
+		source?: string
+		width?: number
+		height?: number
+	} | string)[]
+	button_text?: string
+}
+interface CubeSizeLimiter {
+	/**
+	 * Test whether the cube with the optionally provided values violates the size restrictions
+	 */
+	test: (cube: Cube, values?: {from: ArrayVector3, to: ArrayVector3, inflate: number}) => boolean
+	/**
+	 * Move the cube back into the restructions
+	 */
+	move: (cube: Cube, values?: {from: ArrayVector3, to: ArrayVector3, inflate: number}) => void
+	/**
+	 * Clamp the cube to fit into the restrictions. When an axis and direction is provided, clamp the element on that side to prevent wandering.
+	 */
+	clamp: (cube: Cube, values?: {from: ArrayVector3, to: ArrayVector3, inflate: number}, axis?: number, direction?: boolean | null) => void
+	/**
+	 * Set to true to tell Blockbench to check and adjust the cube limit after rotating a cube
+	 */
+	rotation_affected?: boolean,
+	/**
+	 * Optionally set the coordinate limits of cubes in local space
+	 */
+	coordinate_limits?: [number, number]
+}
+
 interface FormatOptions {
 	id: string
 	icon: string
 	name?: string
 	description?: string
+	category?: string
+	target?: string | string[]
+	confidential?: boolean
+	condition?: Condition
 	show_on_start_screen?: boolean
+	format_page?: FormatPage
+	onFormatPage?(): void
+	onStart?(): void
 
-	box_uv?: boolean
-	optional_box_uv?: boolean
-	single_texture?: boolean
-	animated_textures?: boolean
-	bone_rig?: boolean
-	centered_grid?: boolean
-	rotate_cubes?: boolean
-	integer_size?: boolean
-	meshes?: boolean
-	texture_meshes?: boolean
-	locators?: boolean
-	canvas_limit?: boolean
-	rotation_limit?: boolean
-	uv_rotation?: boolean
+	box_uv: boolean
+	optional_box_uv: boolean
+	single_texture: boolean
+	model_identifier: boolean
+	parent_model_id: boolean
+	vertex_color_ambient_occlusion: boolean
+	animated_textures: boolean
+	bone_rig: boolean
+	centered_grid: boolean
+	rotate_cubes: boolean
+	integer_size: boolean
+	meshes: boolean
+	texture_meshes: boolean
+	locators: boolean
+	rotation_limit: boolean
+	uv_rotation: boolean
+	java_face_properties: boolean
+	select_texture_for_particles: boolean
+	bone_binding_expression: boolean
+	animation_files: boolean
+	texture_folder: boolean
+	edit_mode?: boolean
+	paint_mode?: boolean
 	display_mode?: boolean
 	animation_mode?: boolean
-	animation_files?: boolean
 	pose_mode?: boolean
-	texture_folder?: boolean
+
+	cube_size_limiter?: CubeSizeLimiter
 
 	codec?: Codec
 	onActivation?(): void
@@ -31,29 +81,50 @@ interface FormatOptions {
 }
 
 declare class ModelFormat extends Deletable {
+	constructor(id: string, options: FormatOptions)
 	constructor(options: FormatOptions)
 
 	id: string
 	icon: string
-	name?: string
-	description?: string
-	show_on_start_screen?: boolean
+	name: string
+	description: string
+	category: string
+	target: string | string[]
+	confidential: boolean
+	condition?: Condition
+	show_on_start_screen: boolean
+	format_page?: FormatPage
+	onFormatPage?(): void
+	onStart?(): void
 
 	box_uv: boolean
 	optional_box_uv: boolean
 	single_texture: boolean
+	model_identifier: boolean
+	parent_model_id: boolean
+	vertex_color_ambient_occlusion: boolean
 	animated_textures: boolean
 	bone_rig: boolean
 	centered_grid: boolean
 	rotate_cubes: boolean
 	integer_size: boolean
+	meshes: boolean
+	texture_meshes: boolean
 	locators: boolean
-	canvas_limit: boolean
 	rotation_limit: boolean
 	uv_rotation: boolean
-	display_mode: boolean
-	animation_mode: boolean
+	java_face_properties: boolean
+	select_texture_for_particles: boolean
+	bone_binding_expression: boolean
+	animation_files: boolean
+	texture_folder: boolean
+	edit_mode?: boolean
+	paint_mode?: boolean
+	display_mode?: boolean
+	animation_mode?: boolean
+	pose_mode?: boolean
 
+	cube_size_limiter?: CubeSizeLimiter
 	/**
 	 * Selects the format
 	 */
@@ -72,3 +143,36 @@ declare class ModelFormat extends Deletable {
  * The current format
  */
 declare const Format: ModelFormat
+
+
+interface ModelLoaderOptions {
+	id?: string
+	icon: string
+	name?: string
+	description?: string
+	category?: string
+	target?: string | string[]
+	confidential?: boolean
+	condition?: Condition
+	format_page?: FormatPage
+	onFormatPage?(): void
+	onStart?(): void
+}
+
+declare class ModelLoader extends Deletable {
+	constructor(id: string, options: ModelLoaderOptions)
+	constructor(options: ModelLoaderOptions)
+
+	id: string
+	icon: string
+	name: string
+	description: string
+	category: string
+	target: string | string[]
+	confidential: boolean
+	condition?: Condition
+	show_on_start_screen: boolean
+	format_page?: FormatPage
+	onFormatPage?(): void
+	onStart?(): void
+}

package/types/index.d.ts

@@ -1,8 +1,10 @@
 /// <reference types="vue" />
 /// <reference types="three" />
+/// <reference types="@types/tinycolor2" />
 /// <reference types="@types/jquery" />
 /// <reference types="wintersky" />
 
+/// <reference types="./textures" />
 /// <reference types="./action" />
 /// <reference types="./animation" />
 /// <reference types="./canvas" />
@@ -11,6 +13,7 @@
 /// <reference types="./format" />
 /// <reference types="./global" />
 /// <reference types="./interface" />
+/// <reference types="./dialog" />
 /// <reference types="./panel" />
 /// <reference types="./keyframe" />
 /// <reference types="./legacy" />
@@ -20,9 +23,9 @@
 /// <reference types="./preview" />
 /// <reference types="./project" />
 /// <reference types="./settings" />
-/// <reference types="./textures" />
 /// <reference types="./timeline" />
 /// <reference types="./undo" />
+/// <reference types="./validator" />
 /// <reference types="./util" />
 
 
@@ -55,7 +58,10 @@ type EventName = 'remove_animation'
 	| 'reset_project'
 	| 'close_project'
 	| 'add_cube'
+	| 'add_mesh'
 	| 'add_group'
+	| 'add_texture_mesh'
+	| 'group_elements'
 	| 'update_selection'
 	| 'update_keyframe_selection'
 	| 'select_all'
@@ -72,6 +78,29 @@ type EventName = 'remove_animation'
 	| 'load_undo_save'
 	| 'select_mode'
 	| 'unselect_mode'
+	| 'change_active_panel'
+	| 'resize_window'
+	| 'press_key'
+	| 'select_format'
+	| 'convert_format'
+	| 'construct_format'
+	| 'delete_format'
+	| 'select_project'
+	| 'unselect_project'
+	| 'setup_project'
+	| 'update_project_resolution'
+	| 'merge_project'
+	| 'update_view'
+	| 'update_camera_position'
+	| 'render_frame'
+	| 'construct_model_loader'
+	| 'delete_model_loader'
+	| 'update_recent_project_data'
+	| 'update_recent_project_thumbnail'
+	| 'load_from_recent_project_data'
+	| 'edit_animation_properties'
+	| 'select_preview_scene'
+	| 'unselect_preview_scene'
 
 type IconString = string;
 
@@ -90,6 +119,12 @@ interface MessageBoxOptions {
 	message?: string
 	icon?: string
 	width: 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.
+	 */
+	commands?: {
+		[id: string]: string | {text: string}
+	}
 }
 
 declare namespace Blockbench {
@@ -150,7 +185,7 @@ declare namespace Blockbench {
 	/**
 	 * Opens a message box
 	 */
-	function showMessageBox(options: MessageBoxOptions, callback: (buttonID: number) => void): void
+	function showMessageBox(options: MessageBoxOptions, callback: (buttonID: number | string) => void): void
 
 	function textPrompt(title: string, value: string, callback: (value: string) => void): void
 	/**

package/types/interface.d.ts

@@ -1,154 +1,81 @@
-interface DialogFormElement {
-	label: string
-	description?: string
-	type: 'text' | 'number' | 'checkbox' | 'select' | 'radio' | 'textarea' | 'vector' | 'color' | 'file' | 'folder' | 'save' | 'info'
-	nocolon?: boolean
-	readonly?: boolean
-	value?: any
-	placeholder?: string
-	text?: string
-	colorpicker?: any
-	min?: number
-	max?: number
-	step?: number
-	height?: number
-	options?: object
+interface ResizeLineOptions {
+	condition?: Condition
+	horizontal?: boolean
+	position(): void
+	get(): void
+	set(): void
 }
+declare class ResizeLine {
+	constructor(id: string, options: ResizeLineOptions)
 
-type FormResultValue = string|number|boolean|[]
-
-interface ActionInterface {
-	name: string
-	description?: string
-	icon: string,
-	click: (event: Event) => void
-	condition: Condition
-}
-interface DialogOptions {
-	title: string
 	id: string
-	/**
-	 * Default button to press to confirm the dialog. Defaults to the first button.
-	 */
-	confirmIndex?: number
-	/**
-	 * Default button to press to cancel the dialog. Defaults to the last button.
-	 */
-	cancelIndex?: number
-	/**
-	 *  Function to execute when the user confirms the dialog
-	 */
-	onConfirm?: (formResult: object) => void
-	/**
-	 * Function to execute when the user cancels the dialog
-	 */
-	onCancel?: () => void
-	/**
-	 * Triggered when the user presses a specific button
-	 */
-	onButton?: (button_index: number, event?: Event) => void
-	/**
-	 * Function to run when anything in the form is changed
-	 */
-	onFormChange?: (form_result: {[key: string]: FormResultValue}) => void
-	/**
-	 * Array of HTML object strings for each line of content in the dialog.
-	 */
-	lines?: (string|HTMLElement)[]
-	/**
-	 * Creates a form in the dialog
-	 */
-	form?: {
-		[formElement: string]: '_' | DialogFormElement
-	}
-	/**
-	 * Vue component
-	 */
-	component?: Vue.Component
-	/**
-	 * Order that the different interface types appear in the dialog. Default is 'form', 'lines', 'component'.
-	 */
-	part_order?: string[]
-	form_first?: boolean
-	/**
-	 * Creates a dialog sidebar
-	 */
-	sidebar?: DialogSidebarOptions
-	/**
-	 * Menu in the handle bar
-	 */
-	title_menu?: Menu
-	/**
-	 * If true, the dialog will only have one button to close it
-	 */
-	singleButton?: boolean
-	/**
-	 * List of buttons
-	 */
-	buttons?: string[]
+	horizontal: boolean
+	condition?: Condition
+	width: number
+	get(): void
+	set(): void
+	node: HTMLElement
+	update(): void
+	setPosition(data: {top?: number, bottom?: number, left?: number, right?: number}): void
 }
 
-interface DialogSidebarOptions {
-	pages?: {
-		[key: string]: string | {label: string, icon: IconString, color?: string}
-	}
-	page?: string
-	actions?: (Action|ActionInterface|string)[],
-	onPageSwitch?: (page: string) => void
-}
-declare class DialogSidebar {
-	constructor(options: DialogSidebarOptions)
+declare namespace Interface {
+	function createElement(type: keyof HTMLElementTagNameMap, attributes?: {}, content?: string | HTMLElement | HTMLElement[]): HTMLElement
 
-	pages: {
-		[key: string]: string
+	const data: {
+		left_bar_width: number
+		right_bar_width: number
+		quad_view_x: number
+		quad_view_y: number
+		timeline_head: number
+		left_bar: string[]
+		right_bar: string[]
 	}
-	page: string
-	actions: (Action|string)[]
-	onPageSwitch(page: string): void
-	build(): void
-	toggle(state?: boolean): void
-	setPage(page: string): void
-}
+	let left_bar_width: number
+	let right_bar_width: number
+	let top_panel_height: number
+	let bottom_panel_height: number
+	function getTopPanel(): Panel[]
+	function getBottomPanel(): Panel[]
+	function getLeftPanels(): Panel[]
+	function getRightPanels(): Panel[]
+	const Resizers: {
+		left: ResizeLine
+		right: ResizeLine
+		quad_view_x: ResizeLine
+		quad_view_y: ResizeLine
+		top: ResizeLine
+		bottom: ResizeLine
+		timeline_head: ResizeLine
+	}
+	const status_bar: {
+		menu: Menu
+		vue: Vue
+	}
+	const Panels: {
+		(key: string): Panel
+	}
+	function toggleSidebar(side, status): void
 
-declare class Dialog {
-	constructor (options: DialogOptions)
+	const text_edit_menu: Menu
 
-	id: string
-	component: Vue.Component
-	sidebar: DialogSidebar | null
+	function addSuggestedModifierKey(key: 'ctrl' | 'shift' | 'alt', text: string): void
+	function removeSuggestedModifierKey(key: 'ctrl' | 'shift' | 'alt', text: string): void
 
+	const center_screen: HTMLElement
+	const page_wrapper: HTMLElement
+	const preview: HTMLElement
+	const work_screen: HTMLElement
+	const right_bar: HTMLElement
+	const left_bar: HTMLElement
 
-	show: () => Dialog
-	hide: () => Dialog
-	/**
-	 * Triggers the confirm event of the dialog.
-	 */
-	confirm: (event?: Event) => void
-	/**
-	 * Triggers the cancel event of the dialog.
-	 */
-	cancel: (event?: Event) => void
-	/**
-	 * Closes the dialog using the index of the pressed button
-	 */
-	close: (button: number, event?: Event) => void
-	/**
-	 * If the dialog contains a form, return the current values of the form
-	 */
-	getFormResult(): {
-		[key: string]: FormResultValue
+	namespace CustomElements {
+		function SelectInput(id: string, options: {
+			value?: string
+			default?: string
+			options: {key: string, value: string}
+			onChange?(): void
+		}): HTMLElement
+		const ResizeLine;
 	}
-	/**
-	 * Set the values of the dialog form inputs
-	 */
-	setFormValues(values: {[key: string]: FormResultValue}): void
-	/**
-	 * Delete the dialog object, causing it to be re-build from scratch on next open
-	 */
-	delete(): void
-
-	/**
-	 * Currently opened dialog
-	 */
-	static open: Dialog | null
 }

package/types/menu.d.ts

@@ -13,15 +13,21 @@ interface CustomMenuItem {
      */
     searchable?: boolean
     children?: MenuItem[] | (() => MenuItem[])
-    click?: (context?: any, event: Event)
+    click?: (context?: any, event?: Event) => void
 }
 type MenuItem = CustomMenuItem | Action | BarSelect | string;
-
+interface MenuOptions {
+    onOpen?: (position: MouseEvent | HTMLElement, context?: any) => void
+    onClose?: () => void
+    keep_open?: boolean
+    searchable?: boolean
+}
 /**
  * Creates a new context menu
  */
 declare class Menu extends Deletable {
-    constructor(template: MenuItem[])
+    constructor(id: string, template: MenuItem[] | ((context?: any) => MenuItem[]), options?: MenuOptions)
+    constructor(template: MenuItem[] | ((context?: any) => MenuItem[]), options?: MenuOptions)
 
     /**
      * Opens the menu somewhere
@@ -62,9 +68,12 @@ declare namespace MenuBar {
         file: Menu
         edit: Menu
         transform: Menu
-        display: Menu
-        filter: Menu
+        uv: Menu
+        texture: Menu
         animation: Menu
+        keyframe: Menu
+        display: Menu
+        tools: Menu
         view: Menu
         help: Menu
         [id: string]: Menu

package/types/outliner.d.ts

@@ -1,3 +1,4 @@
+type ArrayVector4 = [number, number, number, number]
 type ArrayVector3 = [number, number, number]
 type ArrayVector2 = [number, number]
 

package/types/preview.d.ts

@@ -13,7 +13,17 @@ interface PreviewOptions {
     antialias?: boolean
 }
 
-class Preview extends Deletable {
+type RaycastResult = {
+    type: 'keyframe' | 'vertex' | 'cube'
+    event: Event
+    cube?: Cube
+    intersects?: object[]
+    face?: string
+    vertex: any
+    keyframe: Keyframe
+}
+
+declare class Preview extends Deletable {
     constructor(options: PreviewOptions)
 
     id: string
@@ -45,15 +55,7 @@ class Preview extends Deletable {
     }
     raycaster: THREE.Raycaster
 
-    raycast(event: MouseEvent): false | {
-        type: 'keyframe' | 'vertex' | 'cube'
-        event: Event
-        cube?: Cube
-        intersects?: object[]
-        face?: string
-        vertex: any
-        keyframe: Keyframe
-    }
+    raycast(event: MouseEvent): false | RaycastResult
     render(): void
     setProjectionMode(orthographic: boolean): this
     setFOV(fov: number): void

package/types/preview_scene.d.ts

@@ -0,0 +1,109 @@
+interface PreviewModelCubeTemplate {
+	position: ArrayVector3
+	size: ArrayVector3
+	origin?: ArrayVector3
+	rotation?: ArrayVector3
+	faces: {
+		north?: {uv: ArrayVector4}
+		east?: {uv: ArrayVector4}
+		west?: {uv: ArrayVector4}
+		south?: {uv: ArrayVector4}
+		up?: {uv: ArrayVector4}
+		down?: {uv: ArrayVector4}
+	}
+}
+
+interface PreviewModelOptions {
+	condition?: Condition
+	cubes: PreviewModelCubeTemplate[]
+	/**
+	 * Source of the model's texture
+	 */
+	texture?: string
+	/**
+	 * Model tint color
+	 */
+	color?: string
+	/**
+	 * Enable shading on the material
+	 */
+	shading?: boolean
+	/**
+	 * THREE.JS material render side
+	 */
+	render_side?: number
+	texture_size?: [number, number]
+	onUpdate?(): void
+}
+
+declare class PreviewModel extends Deletable {
+	constructor(id: string, options: PreviewModelOptions)
+	
+	static models: {
+		(id: string): PreviewModel
+	}
+	static getActiveModels(): PreviewModel[]
+	
+	id: string
+	model_3d: THREE.Object3D
+	cubes: PreviewModelCubeTemplate[]
+	texture?: string
+	color?: string
+	shading: boolean
+	render_side: number
+	texture_size: [number, number]
+	onUpdate?:() => void
+	/**
+	 * Enables the model in the preview
+	 */
+	enable(): void
+	/**
+	 * Disables the model in the preview
+	 */
+	disable(): boolean
+	/**
+	 * Update the appearance and visibility of the model
+	 */
+	update(): void
+	buildModel(): void
+}
+
+
+
+interface PreviewSceneOptions {
+	name?: string
+	description?: string
+	light_color?: string
+	light_side?: number
+	condition?: Condition
+	preview_models?: string[]
+}
+
+declare class PreviewScene extends Deletable {
+	constructor(id: string, options: PreviewSceneOptions)
+
+	static scenes: {
+		(id: string): PreviewScene
+	}
+	static active: PreviewScene | null
+	select_options: {
+		(id: string): string
+	}
+	
+	id: string
+	name: string
+	description: string
+	light_color: string
+	light_side: number
+	condition?: Condition
+	preview_models: string[]
+
+	/**
+	 * Selects this preview scene
+	 */
+	select(): void
+	/**
+	 * Unselects this preview scene
+	 */
+	unselect(): void
+}

package/types/project.d.ts

@@ -11,6 +11,7 @@ declare class ModelProject {
 	name: string
 	uuid: UUID
 	selected: boolean
+	model_identifier: string
 	/**
 	 * When set to true, the project tab can no longer be selected or unselected
 	 */

package/types/validator.d.ts

@@ -0,0 +1,60 @@
+declare namespace Validator {
+    const checks: ValidatorCheck[]
+
+	const warnings: []
+	const errors: []
+	/**
+	 * Run the validator
+	 * @param trigger ID of the Blockbench event that triggered the call
+	 */
+	function validate(trigger?: EventName): void
+	/**
+	 * Opens the Validator dialog
+	 */
+	function openDialog(): void
+
+	/**
+	 * Cached trigger IDs
+	 */
+    const triggers: EventName[]
+	/**
+	 * Update the cached triggers list
+	 */
+	function updateCashedTriggers(): void
+}
+
+interface ValidatorCheckOptions {
+	/**
+	 * Function that runs when the validator check runs
+	 */
+	run(): void
+	/**
+	 * Names of events that automatically trigger this check
+	 */
+	update_triggers?: EventName[]
+	condition?: Condition
+}
+interface WarningOrError {
+	message: string
+	buttons?: {
+		name: string
+		icon: IconString
+		click(): void
+	}[]
+}
+declare class ValidatorCheck extends Deletable {
+	constructor(id: string, options: ValidatorCheckOptions)
+
+	/**
+	 * Manually run this check
+	 */
+	update(): void
+	/**
+	 * Throw a warning. This is intended to be used inside the run() method
+	 */
+	warn(...warnings: WarningOrError[]): void
+	/**
+	 * Throw an error. This is intended to be used inside the run() method
+	 */
+	fail(...warnings: WarningOrError[]): void
+}