blockbench-types 5.1.0 → 5.2.0-beta.0-next.2

package/custom/codec.d.ts

@@ -1,182 +1,182 @@
-/// <reference types="./blockbench"/>
-
-interface LoadOptions {
-	import_to_current_project?: boolean
-	externalDataLoader?: (path: string) => any
-	[key: string]: unknown
-}
-interface CodecOptions {
-	name: string
-	load?(model: any, file: FileResult, args?: LoadOptions): void
-	compile?(options?: any): string | ArrayBuffer | any
-	parse?(data: any, path: string, args?: LoadOptions): void
-	export?(): void
-	/**
-	 * Generate a file name to suggest when exporting
-	 */
-	fileName?(): string
-	startPath?(): string
-	write?(content: any, path: string): void
-	overwrite?(content: any, path: string, callback: (path: any) => void): void
-	afterDownload?(path: any): void
-	afterSave?(path: any): void
-	exportCollection?(collection: Collection): void
-	writeCollection?(collection: Collection): void
-
-	dispatchEvent?(event_name: string, data: any): void
-
-	extension?: string
-	/**
-	 * Whether to remember the models exported using this codec
-	 */
-	remember?: boolean
-	/**
-	 * Whether the codec can be used to export a part of the model via a collection
-	 */
-	support_partial_export?: boolean
-	support_offset?: boolean
-	load_filter?: {
-		extensions: string[]
-		type: 'json' | 'text'
-		condition?: ConditionResolvable
-	}
-	/**
-	 * List of export option inputs, based on the Dialog form API
-	 */
-	export_options?: {
-		[key: string]: FormElementOptions
-	}
-	/**
-	 * Default action that is used to export to the codec
-	 */
-	export_action?: Action
-}
-
-/**
- * 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
-	 * @param options Codec options
-	 */
-	constructor(id: string, options: CodecOptions)
-
-	/**
-	 * Load a file into the program
-	 * @param model
-	 * @param file
-	 * @param args Load options
-	 */
-	load(model: any, file?: FileSystem.FileResult, args?: LoadOptions): void
-	/**
-	 * Compiles the file content
-	 * @param options
-	 */
-	compile(options?: any): any
-	/**
-	 * Takes the content of a file, and loads the model into the current Blockbench project
-	 * @param data File content
-	 * @param path File path
-	 */
-	parse?(data: any, path: string, args?: LoadOptions): void
-	/**
-	 * Opens the file browser to export a file of this type
-	 */
-	export(): void
-	/**
-	 * Generate a file name to suggest when exporting
-	 */
-	fileName(): string
-	/**
-	 * Generates the suggested file path. This is the path that the explorer opens in when exporting this type
-	 */
-	startPath(): string
-	/**
-	 * Write the content of this file to the selected location. The default method can be overwritten to achieve custom behavior
-	 * @param content File content, as generated by compile()
-	 * @param path The file export path
-	 */
-	write(content: any, path: string): void
-	overwrite(content: any, path: string, callback: (path: string) => void): void
-	afterDownload(path: string): void
-	afterSave(path: string): void
-	exportCollection(collection: Collection): void
-	writeCollection(collection: Collection): void
-
-	/**
-	 * Return the stored export option values of the current project
-	 */
-	getExportOptions(): { [key: string]: any }
-	/**
-	 * Prompt the user to enter their preferred export settings into the dialog
-	 */
-	promptExportOptions(): Promise<{ [key: string]: any } | null>
-
-	/**
-	 * Adds an event listener to the codec
-	 * @param event_name The event type to listen for
-	 * @param callback
-	 */
-	on(event_name: string, callback: (data: any) => void): void
-	/**
-	 * Adds a single-use event listener to the codec
-	 * @param event_name The event type to listen for
-	 * @param callback
-	 */
-	once(event_name: string, callback: (data: any) => void): void
-	/**
-	 * Removes an event listener from the codec
-	 * @param event_name
-	 * @param callback
-	 */
-	removeListener(event_name: string, callback: (data: any) => void): void
-	dispatchEvent(event_name: string, data: any): void
-
-	/**
-	 * The display name of the codec
-	 */
-	name: string
-	/**
-	 * The default file extension that the codec uses
-	 */
-	extension: string
-	/**
-	 * Whether to remember files that use this codec in the recent models list
-	 */
-	remember: boolean
-	/**
-	 * Whether the codec can be used to export a part of the model via a collection
-	 */
-	support_partial_export: boolean
-	support_offset: boolean
-	/**
-	 * If available, the action that is used to export files using this codec
-	 */
-	export_action?: Action
-
-	/**
-	 * List of export option inputs
-	 */
-	export_options: {
-		[key: string]: FormElement
-	}
-
-	/**
-	 * Additional properties
-	 */
-	[key: string]: any
-
-	format: ModelFormat
-
-	/**
-	 * Get a list of all possible extensions of all codecs
-	 */
-	static getAllExtensions(): string[]
-}
-
-declare const Codecs: {
-	[id: string]: Codec
-}
+/// <reference types="./blockbench"/>
+
+interface LoadOptions {
+	import_to_current_project?: boolean
+	externalDataLoader?: (path: string) => any
+	[key: string]: unknown
+}
+interface CodecOptions {
+	name: string
+	load?(model: any, file: FileResult, args?: LoadOptions): void
+	compile?(options?: any): string | ArrayBuffer | any
+	parse?(data: any, path: string, args?: LoadOptions): void
+	export?(): void
+	/**
+	 * Generate a file name to suggest when exporting
+	 */
+	fileName?(): string
+	startPath?(): string
+	write?(content: any, path: string): void
+	overwrite?(content: any, path: string, callback: (path: any) => void): void
+	afterDownload?(path: any): void
+	afterSave?(path: any): void
+	exportCollection?(collection: Collection): void
+	writeCollection?(collection: Collection): void
+
+	dispatchEvent?(event_name: string, data: any): void
+
+	extension?: string
+	/**
+	 * Whether to remember the models exported using this codec
+	 */
+	remember?: boolean
+	/**
+	 * Whether the codec can be used to export a part of the model via a collection
+	 */
+	support_partial_export?: boolean
+	support_offset?: boolean
+	load_filter?: {
+		extensions: string[] | (() => string[])
+		type: 'json' | 'text' | 'image'
+		condition?: ConditionResolvable
+	}
+	/**
+	 * List of export option inputs, based on the Dialog form API
+	 */
+	export_options?: {
+		[key: string]: FormElementOptions
+	}
+	/**
+	 * Default action that is used to export to the codec
+	 */
+	export_action?: Action
+}
+
+/**
+ * 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
+	 * @param options Codec options
+	 */
+	constructor(id: string, options: CodecOptions)
+
+	/**
+	 * Load a file into the program
+	 * @param model
+	 * @param file
+	 * @param args Load options
+	 */
+	load(model: any, file?: FileSystem.FileResult, args?: LoadOptions): void
+	/**
+	 * Compiles the file content
+	 * @param options
+	 */
+	compile(options?: any): any
+	/**
+	 * Takes the content of a file, and loads the model into the current Blockbench project
+	 * @param data File content
+	 * @param path File path
+	 */
+	parse?(data: any, path: string, args?: LoadOptions): void
+	/**
+	 * Opens the file browser to export a file of this type
+	 */
+	export(): void
+	/**
+	 * Generate a file name to suggest when exporting
+	 */
+	fileName(): string
+	/**
+	 * Generates the suggested file path. This is the path that the explorer opens in when exporting this type
+	 */
+	startPath(): string
+	/**
+	 * Write the content of this file to the selected location. The default method can be overwritten to achieve custom behavior
+	 * @param content File content, as generated by compile()
+	 * @param path The file export path
+	 */
+	write(content: any, path: string): void
+	overwrite(content: any, path: string, callback: (path: string) => void): void
+	afterDownload(path: string): void
+	afterSave(path: string): void
+	exportCollection(collection: Collection): void
+	writeCollection(collection: Collection): void
+
+	/**
+	 * Return the stored export option values of the current project
+	 */
+	getExportOptions(): { [key: string]: any }
+	/**
+	 * Prompt the user to enter their preferred export settings into the dialog
+	 */
+	promptExportOptions(): Promise<{ [key: string]: any } | null>
+
+	/**
+	 * Adds an event listener to the codec
+	 * @param event_name The event type to listen for
+	 * @param callback
+	 */
+	on(event_name: string, callback: (data: any) => void): void
+	/**
+	 * Adds a single-use event listener to the codec
+	 * @param event_name The event type to listen for
+	 * @param callback
+	 */
+	once(event_name: string, callback: (data: any) => void): void
+	/**
+	 * Removes an event listener from the codec
+	 * @param event_name
+	 * @param callback
+	 */
+	removeListener(event_name: string, callback: (data: any) => void): void
+	dispatchEvent(event_name: string, data: any): void
+
+	/**
+	 * The display name of the codec
+	 */
+	name: string
+	/**
+	 * The default file extension that the codec uses
+	 */
+	extension: string
+	/**
+	 * Whether to remember files that use this codec in the recent models list
+	 */
+	remember: boolean
+	/**
+	 * Whether the codec can be used to export a part of the model via a collection
+	 */
+	support_partial_export: boolean
+	support_offset: boolean
+	/**
+	 * If available, the action that is used to export files using this codec
+	 */
+	export_action?: Action
+
+	/**
+	 * List of export option inputs
+	 */
+	export_options: {
+		[key: string]: FormElement
+	}
+
+	/**
+	 * Additional properties
+	 */
+	[key: string]: any
+
+	format: ModelFormat
+
+	/**
+	 * Get a list of all possible extensions of all codecs
+	 */
+	static getAllExtensions(): string[]
+}
+
+declare const Codecs: {
+	[id: string]: Codec
+}

package/custom/copy_paste.d.ts

@@ -1,42 +1,43 @@
-declare global {
-    namespace Clipbench {
-        let elements: any[];
-        enum types {
-            text = 'text',
-            display_slot = 'display_slot',
-            keyframe = 'keyframe',
-            animation = 'animation',
-            face = 'face',
-            mesh_selection = 'mesh_selection',
-            texture = 'texture',
-            layer = 'layer',
-            outliner = 'outliner',
-            texture_selection = 'texture_selection',
-            image = 'image',
-        }
-        let image: undefined | {
-            x: number,
-            y: number,
-            frame?: number
-            data: string
-        }
-        namespace type_icons {
-            let face = 'aspect_ratio';
-            let mesh_selection = 'fa-gem';
-            let outliner = 'fas.fa-cube';
-        }
-        function getCopyType(mode: any, check: any): Clipbench.types;
-        function getPasteType(): Promise<Clipbench.types>;
-        function copy(event: Event, cut: any): void;
-        function paste(event: Event): Promise<void>;
-        function setGroups(groups: Group[]): void;
-        function setElements(arr: OutlinerElement[]): void;
-        function setText(text: string): void;
-        function setMeshSelection(mesh: Mesh): void;
-        function pasteMeshSelection(): void;
-        function pasteOutliner(event: Event): void;
-        function pasteImage(): void;
-    }
-}
-
-export {};
+declare global {
+    namespace Clipbench {
+        let elements: any[];
+        let layer: any;
+        enum types {
+            text = 'text',
+            display_slot = 'display_slot',
+            keyframe = 'keyframe',
+            animation = 'animation',
+            face = 'face',
+            mesh_selection = 'mesh_selection',
+            texture = 'texture',
+            layer = 'layer',
+            outliner = 'outliner',
+            texture_selection = 'texture_selection',
+            image = 'image',
+        }
+        let image: undefined | {
+            x: number,
+            y: number,
+            frame?: number
+            data: string
+        }
+        namespace type_icons {
+            let face = 'aspect_ratio';
+            let mesh_selection = 'fa-gem';
+            let outliner = 'fas.fa-cube';
+        }
+        function getCopyType(mode: any, check: any): Clipbench.types;
+        function getPasteType(): Promise<Clipbench.types>;
+        function copy(event: Event, cut: any): void;
+        function paste(event: Event): Promise<void>;
+        function setGroups(groups: Group[]): void;
+        function setElements(arr: OutlinerElement[]): void;
+        function setText(text: string): void;
+        function setMeshSelection(mesh: Mesh): void;
+        function pasteMeshSelection(): void;
+        function pasteOutliner(event: Event): void;
+        function pasteImage(): void;
+    }
+}
+
+export {};