blockbench-types 4.4.0 → 4.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blockbench-types",
-  "version": "4.4.0",
+  "version": "4.5.0",
   "description": "Blockbench typescript types",
   "main": "",
   "types": "types/index.d.ts",

package/types/codec.d.ts

@@ -1,8 +1,8 @@
 interface CodecOptions {
 	name: string
 	load?(model: any, file: object, add?: boolean): void
-	compile?(): void
-	parse?(): void
+	compile?(options?: object): void
+	parse?(data: any, path: string): void
 	export?(): void
 	/**
 	 * Generate a file name to suggest when exporting
@@ -10,6 +10,7 @@ interface CodecOptions {
 	fileName?(): string
 	startPath?(): string
 	write?(content: any, path: string): void
+	overwrite?(content: any, path: string, callback: ((path) => void)): void
 	afterDownload?(path): void
 	afterSave?(path): void
 
@@ -30,8 +31,8 @@ declare class Codec extends Deletable {
 	constructor(id: string, options: CodecOptions)
 
 	load?(model: any, file: object, add?: boolean): void
-	compile?(): any
-	parse?(model): void
+	compile?(options?: object): any
+	parse?(data: any, path: string): void
 	export?(): void
 	/**
 	 * Generate a file name to suggest when exporting
@@ -39,6 +40,7 @@ declare class Codec extends Deletable {
 	fileName?(): string
 	startPath?(): string
 	write?(content: any, path: string): void
+	overwrite?(content: any, path: string, callback: ((path) => void)): void
 	afterDownload?(path): void
 	afterSave?(path): void
 	on(event_name: string, callback: (data: object) => void): void

package/types/dialog.d.ts

@@ -1,8 +1,9 @@
 interface DialogFormElement {
 	label: string
 	description?: string
-	type: 'text' | 'number' | 'checkbox' | 'select' | 'radio' | 'textarea' | 'vector' | 'color' | 'file' | 'folder' | 'save' | 'info'
+	type: 'text' | 'number' | 'range' | 'checkbox' | 'select' | 'radio' | 'textarea' | 'vector' | 'color' | 'file' | 'folder' | 'save' | 'info'
 	nocolon?: boolean
+	full_width?: boolean
 	readonly?: boolean
 	value?: any
 	placeholder?: string
@@ -54,7 +55,7 @@ interface DialogOptions {
 	/**
 	 * Array of HTML object strings for each line of content in the dialog.
 	 */
-	lines?: (string|HTMLElement)[]
+	lines?: (HTMLElement | {label?: string, widget?: Widget|(() => Widget), nocolon?: boolean} | string)[]
 	/**
 	 * Creates a form in the dialog
 	 */
@@ -86,6 +87,10 @@ interface DialogOptions {
 	 * List of buttons
 	 */
 	buttons?: string[]
+	/**
+	 * Unless set to false, clicking on the darkened area outside of the dialog will cancel the dialog.
+	 */
+	cancel_on_click_outside?: boolean
 }
 
 interface DialogSidebarOptions {

package/types/file_system.d.ts

@@ -25,6 +25,10 @@ declare namespace Blockbench {
      * Reads the content from the specified files. Desktop app only.
      */
     export function read(files: string[], options?: ReadOptions, callback?: (files: FileResult[]) => void): void
+    /**
+     * Reads the content from the specified files. Desktop app only.
+     */
+    export function readFile(files: string[], options?: ReadOptions, callback?: (files: FileResult[]) => void): void
 
 
 

package/types/format.d.ts

@@ -46,27 +46,28 @@ interface FormatOptions {
 	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
-	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
+	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
+	image_editor?: boolean
 	edit_mode?: boolean
 	paint_mode?: boolean
 	display_mode?: boolean
@@ -118,11 +119,12 @@ declare class ModelFormat extends Deletable {
 	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
+	image_editor: boolean
+	edit_mode: boolean
+	paint_mode: boolean
+	display_mode: boolean
+	animation_mode: boolean
+	pose_mode: boolean
 
 	cube_size_limiter?: CubeSizeLimiter
 	/**

package/types/index.d.ts

@@ -40,7 +40,7 @@ type UUID = string
 declare const isApp: boolean
 
 type EventName = 'remove_animation'
-	| 'display_animation_fram'
+	| 'display_animation_frame'
 	| 'before_closing'
 	| 'create_session'
 	| 'join_session'
@@ -215,7 +215,7 @@ declare namespace Blockbench {
 	function addListener(event_names: EventName, callback: (data: object) => void): void
 	function on(event_names: EventName, callback: (data: object) => void): void
 
-	function removeEventListener(event_names: EventName): void
+	function removeListener(event_names: EventName): void
 }
 
 

package/types/menu.d.ts

@@ -22,10 +22,10 @@ interface MenuOptions {
     keep_open?: boolean
     searchable?: boolean
 }
-/**
- * Creates a new context menu
- */
 declare class Menu extends Deletable {
+    /**
+     * Creates a new context menu
+     */
     constructor(id: string, template: MenuItem[] | ((context?: any) => MenuItem[]), options?: MenuOptions)
     constructor(template: MenuItem[] | ((context?: any) => MenuItem[]), options?: MenuOptions)
 

package/types/undo.d.ts

@@ -40,21 +40,70 @@ type UndoEntry = {
     action: string
     time: number
 }
+interface AmendEditForm {
+    condition?: Condition
+    type?: 'number'
+    label: string
+    interval_type: 'position' | 'rotation'
+    getInterval?: (Event) => number
+    value?: number | string,
+    min?: number,
+    max?: number,
+    step?: number,
+}
 
 declare class UndoSystem {
     constructor();
+    /**
+     * Starts an edit to the current project by saving the state of the provided aspects
+     * @param aspects Aspects to save
+     */
     initEdit(aspects: UndoAspects): any;
+    /**
+     * Finishes an edit by saving the state of the project after it was changed
+     * @param action Description of the edit
+     */
     finishEdit(action: string, aspects?: UndoAspects): {
         before: any;
         post: any;
         action: any;
         time: number;
     };
+    /**
+     * Cancels an event before it was finished and reset the project to the state before
+     */
     cancelEdit(): void;
+    /**
+     * Add keyframes to the current edit that were indirectly removed by moving other keyframes to their position
+     * @param keyframes 
+     */
     addKeyframeCasualties(keyframes: Keyframe[]): void;
+    /**
+     * Undoes the latest edit
+     */
     undo(remote?: boolean): void;
+    /**
+     * Redoes the latest edit
+     */
+    redo(remote?: boolean): void;
+    /**
+     * Redoes the latest edit
+     */
     redo(remote?: boolean): void;
-    remoteEdit(entry: UndoEntry): void;
-    loadSave(save: UndoSave, reference: UndoSave, mode?: string): void;
+    /**
+     * Provides a menu to amend the latest edit with slightly changed values
+     */
+    amendEdit(form: AmendEditForm, callback: (values: {}, form: {}) => void)
+
+    /**
+     * Loads a specific undo save
+     * @param save The undo save to load
+     * @param reference The current undo save for reference
+     * @param mode The load save modes
+     */
+    loadSave(save: UndoSave, reference: UndoSave, mode?: 'session'): void;
 }
+/**
+ * Blockbench's system to register edits to the project and switch between them
+ */
 declare let Undo: UndoSystem;