blockbench-types 5.2.0-beta.0-next.1 → 5.2.0-beta.0-next.3

package/custom/painter.d.ts

@@ -11,6 +11,7 @@ declare namespace Painter {
 	const lock_alpha: boolean
 	const erase_mode: boolean
 	const default_brush_presets: any[]
+	let screen_space_brush_cursor: HTMLElement
 
 	function edit(
 		texture: Texture,
@@ -30,6 +31,8 @@ declare namespace Painter {
 	function getMirrorElement(element: OutlinerElement, symmetry_axes: number[]): void
 	function updateNslideValues(): void
 	function getBlendModeCompositeOperation(blend_mode?: string): string
+	function getBrushDimensions(size?: number): ArrayVector2
+	function getCanvasToolPixelCoords(uv_point: {x: number, y: number}, texture: Texture): ArrayVector2
 	function getCanvas(texture: Texture): HTMLCanvasElement
 	function copyCanvas(original_canvas: HTMLCanvasElement): HTMLCanvasElement
 	function scanCanvas(
@@ -40,7 +43,7 @@ declare namespace Painter {
 		h: number,
 		cb: ((px: number, py: number, color: [r: number, g: number, b: number, a: number]) => [number, number, number, number] | void)
 	): void
-	function getPixelColor(ctx: CanvasRenderingContext2D, x: number, y: number): void
+	function getPixelColor(ctx: CanvasRenderingContext2D, x: number, y: number): tinycolor
 	function modifyCanvasSection(
 		ctx: CanvasRenderingContext2D,
 		x: number,
@@ -68,3 +71,34 @@ declare namespace Painter {
 	function openBrushOptions(): void
 	function loadBrushPreset(preset: any): void
 }
+
+	declare interface BarItemRegistry {
+		paint_secondary_color: KeybindItem
+		pan_tool: Tool
+		brush_tool: Tool
+		copy_brush: Tool
+		fill_tool: Tool
+		eraser: Tool
+		color_picker: Tool
+		draw_shape_tool: Tool
+		gradient_tool: Tool
+		move_layer_tool: Tool
+		brush_shape: BarSelect
+		draw_shape_type: BarSelect
+		blend_mode: BarSelect
+		fill_mode: BarSelect
+		copy_brush_mode: BarSelect
+		selection_tool_operation_mode: BarSelect
+		expand_texture_selection: Action
+		mirror_painting: Toggle
+		color_erase_mode: Toggle
+		lock_alpha: Toggle
+		painting_grid: Toggle
+		image_tiled_view: Toggle
+		image_onion_skin_view: Toggle
+		slider_brush_size: NumSlider
+		slider_brush_softness: NumSlider
+		slider_brush_opacity: NumSlider
+		pixel_perfect_drawing: Toggle
+		slider_color_select_threshold: NumSlider
+	}

package/custom/screencam.d.ts

@@ -36,7 +36,7 @@ declare namespace Screencam {
 	/**
 	 * Provided preview with anti aliasing disabled that can be used for screenshots
 	 */
-	const NoAAPreview: Preview
+	let NoAAPreview: Preview
 	/**
 	 * Whether a timelapse is currently being recorded
 	 */

package/custom/spline_mesh.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="./blockbench"/>
 
 
-export declare class SplineTubeFace extends MeshFace {
+declare class SplineTubeFace extends MeshFace {
     constructor(mesh: any, spline: any, data: any);
     get element(): SplineMesh;
     getTexture(): Texture;
@@ -14,7 +14,7 @@ interface SplineCurveOptions {
 	start_ctrl: any
 	end_ctrl: any
 }
-export declare class SplineCurve {
+declare class SplineCurve {
     constructor(spline: SplineMesh, data: SplineCurveOptions);
     get element(): SplineMesh;
     extend(data: SplineCurveOptions): this;
@@ -49,7 +49,7 @@ export declare class SplineCurve {
 interface SplineHandle {
 
 }
-export declare class SplineHandle {
+declare class SplineHandle {
     constructor(spline: SplineMesh, data: SplineHandle);
     get element(): SplineMesh;
     extend(data: SplineHandle): this;
@@ -67,7 +67,7 @@ export declare class SplineHandle {
 interface SplineMeshOptions {
 
 }
-export declare class SplineMesh extends OutlinerElement {
+declare class SplineMesh extends OutlinerElement {
     constructor(data: any, uuid: any);
     get vertices(): Record<string, ArrayVector3>;
     get handles(): Record<string, SplineHandle>;
@@ -77,6 +77,7 @@ export declare class SplineMesh extends OutlinerElement {
     set curves(v: Record<string, SplineCurve>);
     get position(): ArrayVector3;
     get vertice_list(): any[];
+    faces: Record<string, SplineTubeFace>
     cyclic: boolean
     export: boolean
     display_space: boolean

package/custom/textures.d.ts

@@ -395,6 +395,7 @@ declare global {
 		static properties: Record<string, Property<any>>
 
 		static file_formats: Record<string, FileFormatOptions>
+		static getAllExtensions(): string[]
 	}
 	/**
 	 * Saves all textures
@@ -520,5 +521,6 @@ declare global {
 		function nextFrame(): void
 		function reset(): void
 		function updateButton(): void
+		function playAnimationFrame(anim_time?: number): void
 	}
 }

package/generated/animations/timeline_animators.d.ts

@@ -69,7 +69,7 @@ declare global {
                 max_data_points: number;
             };
         };
-        menu: Menu;
+        menu: import("../interface/menu").Menu;
     }
     class NullObjectAnimator extends BoneAnimator {
         solver: any;

package/generated/api.d.ts

@@ -1,29 +1,7 @@
 import { ModelFormat } from "./io/format";
 import { Filesystem } from "./file_system";
 import { MessageBoxOptions } from "./interface/dialog";
-interface ToastNotificationOptions {
-    /**
-     * Text message
-     */
-    text: string;
-    /**
-     * Blockbench icon string
-     */
-    icon?: IconString;
-    /**
-     * Expire time in miliseconds
-     */
-    expire?: number;
-    /**
-     * Background color, accepts any CSS color string
-     */
-    color?: string;
-    /**
-     * Method to run on click.
-     * @returns Return `true` to close toast
-     */
-    click?: (event: Event) => boolean;
-}
+import { ToastNotification, ToastNotificationOptions } from "./interface/toast_notification";
 export declare const LastVersion: string;
 export declare const Blockbench: {
     isWeb: boolean;
@@ -53,7 +31,7 @@ export declare const Blockbench: {
     registerEdit(): void;
     getIconNode(icon: IconString | boolean | HTMLElement | (() => (IconString | boolean | HTMLElement)), color?: string): HTMLElement;
     showQuickMessage(message: any, time?: number): void;
-    showToastNotification(options: ToastNotificationOptions): any;
+    showToastNotification(options: ToastNotificationOptions): ToastNotification;
     setCursorTooltip(text?: string): void;
     setProgress(progress: number, time?: number, bar?: string): void;
     showStatusMessage(message: string, time?: number): void;
@@ -105,8 +83,9 @@ export declare const Blockbench: {
     removeDragHandler: typeof Filesystem.removeDragHandler;
 };
 declare global {
-    interface window {
+    interface Window {
         Blockbench: typeof Blockbench;
+        osfs: '/' | '\\';
     }
 }
 declare const global: {
@@ -139,7 +118,7 @@ declare const global: {
         registerEdit(): void;
         getIconNode(icon: IconString | boolean | HTMLElement | (() => (IconString | boolean | HTMLElement)), color?: string): HTMLElement;
         showQuickMessage(message: any, time?: number): void;
-        showToastNotification(options: ToastNotificationOptions): any;
+        showToastNotification(options: ToastNotificationOptions): ToastNotification;
         setCursorTooltip(text?: string): void;
         setProgress(progress: number, time?: number, bar?: string): void;
         showStatusMessage(message: string, time?: number): void;

package/generated/desktop.d.ts

@@ -0,0 +1,48 @@
+export declare const recent_projects: RecentProjectData[];
+export declare function initializeDesktopApp(): void;
+export declare function loadOpenWithBlockbenchFile(): void;
+export type RecentProjectData = {
+    name: string;
+    path: string;
+    icon: string;
+    day: number;
+    favorite: boolean;
+    textures?: string[];
+    animation_files?: string[];
+};
+export declare function updateRecentProjects(): void;
+export declare function addRecentProject(data: Partial<RecentProjectData>): void;
+export declare function updateRecentProjectData(): void;
+export declare function updateRecentProjectThumbnail(): Promise<void>;
+export declare function loadDataFromModelMemory(): void;
+export declare function isImageEditorValid(path: string): boolean;
+export declare function changeImageEditor(texture?: Texture, not_found?: boolean): void;
+export declare function openDefaultTexturePath(): void;
+export declare function findExistingFile(paths: string[]): string;
+export declare function createBackup(init: boolean): void;
+declare const global: {
+    PathModule: import("path").PlatformPath;
+    recent_projects: import("./desktop").RecentProjectData[];
+    nativeImage: typeof Electron.NativeImage;
+    updateRecentProjects: typeof import("./desktop").updateRecentProjects;
+    addRecentProject: typeof import("./desktop").addRecentProject;
+    updateRecentProjectData: typeof import("./desktop").updateRecentProjectData;
+    loadDataFromModelMemory: typeof import("./desktop").loadDataFromModelMemory;
+    changeImageEditor: typeof import("./desktop").changeImageEditor;
+    openDefaultTexturePath: typeof import("./desktop").openDefaultTexturePath;
+    updateRecentProjectThumbnail: typeof import("./desktop").updateRecentProjectThumbnail;
+    createBackup: typeof import("./desktop").createBackup;
+};
+declare global {
+    const recent_projects: RecentProjectData[];
+    type RecentProjectData = import('./desktop').RecentProjectData;
+    const updateRecentProjects: typeof global.updateRecentProjects;
+    const addRecentProject: typeof global.addRecentProject;
+    const updateRecentProjectData: typeof global.updateRecentProjectData;
+    const updateRecentProjectThumbnail: typeof global.updateRecentProjectThumbnail;
+    const loadDataFromModelMemory: typeof global.loadDataFromModelMemory;
+    const changeImageEditor: typeof global.changeImageEditor;
+    const openDefaultTexturePath: typeof global.openDefaultTexturePath;
+    const createBackup: typeof global.createBackup;
+}
+export {};

package/generated/file_system.d.ts

@@ -5,6 +5,7 @@ declare global {
             path: string;
             content?: string | ArrayBuffer;
             browser_file?: File;
+            no_file?: boolean;
         };
         /**
          * The resource identifier group, used to allow the file dialog (open and save) to remember where it was last used

package/generated/find_replace.d.ts

@@ -0,0 +1,6 @@
+import { Action } from './interface/actions';
+declare global {
+    interface BarItemRegistry {
+        find_replace: Action;
+    }
+}

package/generated/interface/actions.d.ts

@@ -1,5 +1,7 @@
 import MolangParser from "molangjs";
 import tinycolor from "tinycolor2";
+import { RaycastResult } from "../preview/preview";
+import { MenuItem } from "./menu";
 export declare const BarItems: any;
 type SubKeybind = {
     name: string;
@@ -8,6 +10,7 @@ type SubKeybind = {
     trigger: (event: Event) => void;
 };
 export interface KeybindItemOptions {
+    id?: string;
     name?: string;
     description?: string;
     category?: string;
@@ -52,7 +55,7 @@ export declare abstract class BarItem extends EventSystem {
     id: string;
     name: string;
     description: string;
-    icon?: IconString | (() => IconString);
+    icon?: IconString | ((context?: any) => IconString);
     category?: string;
     color?: string;
     condition: ConditionResolvable;
@@ -112,9 +115,7 @@ export declare class KeybindItem {
             description?: string;
         };
     };
-    constructor(id: string, data: KeybindItemOptions & {
-        id: string;
-    });
+    constructor(id: string, data: KeybindItemOptions);
     delete(): void;
 }
 export interface ActionOptions extends BarItemOptions {
@@ -243,6 +244,10 @@ export interface BrushOptions {
      * Enable the input for opacity when this tool is selected
      */
     opacity: boolean;
+    /**
+     * Enable the toggle for screen space when this tool is selected
+     */
+    screen_space: 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
      */
@@ -312,7 +317,7 @@ export interface BrushOptions {
 interface ToolSpecificOptions {
     selectFace?: boolean;
     selectElements?: boolean;
-    transformerMode?: 'translate' | 'hidden' | '';
+    transformerMode?: 'translate' | 'scale' | 'rotate' | 'stretch' | 'hidden' | '';
     cursor?: string;
     animation_channel?: string;
     toolbar?: string;
@@ -329,7 +334,7 @@ interface ToolSpecificOptions {
     onCanvasClick?(raycast_data: RaycastResult): void;
     onSelect?(): void;
     onUnselect?(): void;
-    onCanvasMouseMove?(raycast_data: RaycastResult): any;
+    onCanvasMouseMove?(raycast_data: RaycastResult | false): any;
     onCanvasRightClick?(raycast_data: RaycastResult): any;
     onTextureEditorClick?(raycast_data: RaycastResult): any;
 }
@@ -393,13 +398,13 @@ interface WidgetOptions extends BarItemOptions {
 export declare abstract class Widget extends BarItem {
     constructor(id: string, data: WidgetOptions);
 }
-type NumSliderOptions = WidgetOptions & {
+export type NumSliderOptions = WidgetOptions & {
     private?: boolean;
     settings?: {
         default?: number;
         min?: number;
         max?: number;
-        interval?: number;
+        interval?: number | (() => number);
         step?: number;
         show_bar?: boolean;
         limit?: boolean;
@@ -502,7 +507,7 @@ export declare class BarSlider extends Widget {
 type BarSelectPropertyFormat = string | boolean | {
     name: string | true;
     condition?: ConditionResolvable;
-    icon?: string;
+    icon?: IconString;
 };
 interface BarSelectOptions extends WidgetOptions {
     value?: string;

package/generated/interface/dialog.d.ts

@@ -314,7 +314,7 @@ type MessageBoxCommandOptions = string | {
 };
 type MessageBoxCheckbox = string | {
     value?: boolean;
-    condition: ConditionResolvable;
+    condition?: ConditionResolvable;
     text: string;
 };
 export interface MessageBoxOptions {
@@ -359,7 +359,7 @@ interface ConfigDialogOptions extends DialogOptions {
 }
 export declare class ConfigDialog extends Dialog {
     constructor(id: string, options: ConfigDialogOptions);
-    show(anchor: HTMLElement): this;
+    show(anchor?: HTMLElement): this;
     build(): this;
     delete(): void;
 }

package/generated/interface/main_tools.d.ts

@@ -0,0 +1,23 @@
+declare global {
+    interface BarItemRegistry {
+        move_tool: Tool;
+        resize_tool: Tool;
+        rotate_tool: Tool;
+        pivot_tool: Tool;
+        vertex_snap_tool: Tool;
+        stretch_tool: Tool;
+        swap_tools: Action;
+        set_element_marker_color: Action;
+        randomize_marker_colors: Action;
+        new_window: Action;
+        open_model_folder: Action;
+        reload: Action;
+        open_dev_tools: Action;
+        fullscreen: Action;
+        zoom_in: Action;
+        zoom_out: Action;
+        zoom_reset: Action;
+        toggle_sidebars: Action;
+    }
+}
+export {};

package/generated/interface/menu.d.ts

@@ -0,0 +1,144 @@
+/**
+ * The menu class lets you create content menus. Context menus can contain custom menu items, and a number of existing UI elements, including Actions, Tools, etc.
+ *
+ * ## Example
+ * ```
+ * document.addEventListener('contextmenu', event => {
+ *   let items = [
+ *     'open_model',
+ *     {
+ *       name: 'Example',
+ *       icon: 'house',
+ *       click() {
+ *         console.log('Hello World')
+ *       }
+ *     }
+ *   ];
+ *   new Menu(items).open(event);
+ * })
+ * ```
+ * @module
+ */
+export interface CustomMenuItem {
+    name: string;
+    id?: string;
+    icon: IconString | boolean | ((context: any) => (IconString | boolean));
+    color?: string;
+    description?: string;
+    condition?: ConditionResolvable;
+    /**
+     * Keybind or string to display in the menu, won't work as an actual keybinding by default
+     */
+    keybind?: Keybind | string;
+    /**
+     * If true, mark the menu item as the selected one (underlined text in default theme)
+     */
+    marked?: boolean | ((context: any) => boolean);
+    /**
+     * Adds a search bar to the menu or submenu
+     */
+    searchable?: boolean;
+    children?: MenuItem[] | ((context: any) => MenuItem[]);
+    click?(context?: any, event?: Event): void;
+}
+export type MenuItem = CustomMenuItem | Action | BarSelect | MenuSeparator | string | ((context: any) => MenuItem);
+export type MenuOpenPositionAnchor = MouseEvent | HTMLElement | {
+    clientX: number;
+    clientY: number;
+} | 'mouse';
+export interface MenuOptions {
+    onOpen?(position: MenuOpenPositionAnchor, context?: any): void;
+    onClose?(): void;
+    keep_open?: boolean;
+    searchable?: boolean;
+    class?: string | string[];
+}
+export declare class MenuSeparator {
+    id: string;
+    label?: string;
+    menu_node: HTMLLIElement;
+    constructor(id?: string, label?: string);
+}
+/**
+ * Use the Menu class to create a context menu. Menus can contain custom entries and hierarchy, or existing actions and tools.
+ */
+export declare class Menu implements Deletable {
+    id: string;
+    children: [];
+    structure: MenuItem[] | ((context: any) => MenuItem[]);
+    options?: MenuOptions;
+    condition?: ConditionResolvable;
+    onOpen?(position: MenuOpenPositionAnchor, context?: any): void;
+    onClose?(): void;
+    node: HTMLUListElement;
+    highlight_action?: MenuItem;
+    type: string;
+    /**
+     * Creates a new context menu
+     */
+    constructor(template: MenuItem[] | ((context?: any) => MenuItem[]), options?: MenuOptions);
+    constructor(id: string, template: MenuItem[] | ((context?: any) => MenuItem[]), options?: MenuOptions);
+    hover(node: HTMLElement, event?: Event, expand?: boolean): void;
+    /**
+     * Trigger keyboard navigation
+     * @param e Event
+     * @returns True if the input was used for navigation
+     * @private
+     */
+    keyNavigate(e: KeyboardEvent): boolean;
+    /**
+     * Opens the menu somewhere
+     * @param position Position where to open the menu. Can be a mouse event, or a node that the menu is spawned below.
+     * @param context Context for the click events inside the menu
+     */
+    open(position?: MenuOpenPositionAnchor, context?: any): this;
+    /**
+     * Alias for .open()
+     */
+    show(position?: MenuOpenPositionAnchor, context?: any): this;
+    /**
+     * Closes the menu if it's open
+     */
+    hide(): this;
+    /**
+     * @deprecated
+     */
+    conditionMet(): boolean;
+    /**
+     * Adds an action to the menu structure
+     * @param action Action to add
+     * @param path Path pointing to the location. Use the ID of each level of the menu, or index within a level, separated by a point. For example, `export.0` places the action at the top position of the Export submenu.
+     */
+    addAction(action: Action | CustomMenuItem | '_', path?: string | number): void;
+    /**
+     * Remove an action or menu item from the menu
+     * @param path Path pointing to the location. Use the ID of each level of the menu, or index within a level, or item ID, separated by a point. For example, `export.export_special_format` removes the action "Export Special Format" from the Export submenu.
+     */
+    removeAction(path: string | Action): void;
+    /**
+     * @deprecated Use removeAction instead
+     */
+    deleteItem(rm_item: Action): void;
+    delete(): void;
+    static open: Menu | null;
+    static closed_in_this_click?: string;
+}
+export declare function preventContextMenu(): void;
+declare const global: {
+    MenuSeparator: typeof import("./menu").MenuSeparator;
+    Menu: typeof import("./menu").Menu;
+    preventContextMenu: typeof import("./menu").preventContextMenu;
+    open_menu: any;
+};
+declare global {
+    type Menu = import('./menu').Menu;
+    const Menu: typeof global.Menu;
+    type MenuSeparator = import('./menu').MenuSeparator;
+    const MenuSeparator: typeof global.MenuSeparator;
+    function preventContextMenu(): void;
+    let open_menu: Menu | null;
+    interface Window {
+        open_menu: Menu | null;
+    }
+}
+export {};

package/generated/interface/menu_bar.d.ts

@@ -1,7 +1,6 @@
 declare global {
     class BarMenu extends Menu {
         constructor(id: any, structure: any, options?: {});
-        type: string;
         id: any;
         children: any[];
         condition: any;
@@ -9,7 +8,7 @@ declare global {
         name: string;
         label: HTMLElement;
         structure: any;
-        highlight_action: any;
+        highlight_action: import("./menu").MenuItem;
         open(...args: any[]): void;
         hide(): this;
         highlight(action: any): void;
@@ -27,5 +26,5 @@ declare global {
         function removeAction(path: any): void;
     }
 }
-
+import { Menu } from "./menu";
 export {};

package/generated/interface/shared_actions.d.ts

@@ -6,6 +6,7 @@
  * Handlers can be added for existing actions like this:
 
 ### Example:
+* @example
 ```javascript
     // Duplicate layers when using "Duplicate" in the layers panel
     SharedActions.add('duplicate', {
@@ -23,6 +24,10 @@
         }
     })
 ```
+* @module
+ */
+/**
+ * Global Shared Actions namespace to access any functionality related to Shared Actions
  */
 export declare const SharedActions: {
     /**
@@ -121,5 +126,13 @@ declare const global: {
 };
 declare global {
     const SharedActions: typeof global.SharedActions;
+    interface BarItemRegistry {
+        rename: Action;
+        delete: Action;
+        duplicate: Action;
+        select_all: Action;
+        unselect_all: Action;
+        invert_selection: Action;
+    }
 }
 export {};

package/generated/interface/toast_notification.d.ts

@@ -0,0 +1,45 @@
+export interface ToastNotificationOptions {
+    id?: string;
+    /**
+     * Text message
+     */
+    text: string;
+    /**
+     * Blockbench icon string
+     */
+    icon?: IconString;
+    /**
+     * Expire time in miliseconds
+     */
+    expire?: number;
+    /**
+     * Background color, accepts any CSS color string
+     */
+    color?: string;
+    /**
+     * Method to run on click.
+     * @returns Return `true` to close toast
+     */
+    click?: (event: Event) => boolean | void;
+    /**
+     * Method to run on close via the close button.
+     * @returns Return `falce` to cancel the close
+     */
+    onClose?: (event: Event) => boolean | void;
+}
+export declare class ToastNotification {
+    node: HTMLLIElement;
+    id: string;
+    options: ToastNotificationOptions;
+    constructor(id: string, options: ToastNotificationOptions);
+    delete(): void;
+    static notifications: Record<string, ToastNotification>;
+}
+declare const global: {
+    ToastNotification: typeof import("./toast_notification").ToastNotification;
+};
+declare global {
+    type ToastNotification = import('./toast_notification').ToastNotification;
+    const ToastNotification: typeof global.ToastNotification;
+}
+export {};