@cloudcannon/configuration-types 0.0.28 → 0.0.32

package/src/javascript-api.d.ts

@@ -1,6 +1,6 @@
 import type { Cascade } from './cascade';
 import type { SnippetConfig } from './snippets';
-import type { FileInput, ImageInput, RichTextInput } from './inputs';
+import type { FileInput, UrlInput, RichTextInput } from './inputs';
 
 export interface CloseCustomDataPanelOptions {
 	parentId: string;
@@ -17,12 +17,17 @@ export interface OpenCustomDataPanelOptions extends CloseCustomDataPanelOptions
 
 /**
  * Interface defining the public JavaScript API for interacting with CloudCannon's Visual Editor.
- * This API provides methods for managing content, handling file operations, and controlling the editor's state.
+ * This API provides methods for managing content, handling file operations, and controlling the
+ * editor's state.
  */
 export interface CloudCannonJavaScriptAPI {
-	/** Whether event handling is currently enabled */
+	/**
+	 * Whether event handling is currently enabled
+	 */
 	eventsEnabled: boolean;
-	/** Whether the API should be installed globally */
+	/**
+	 * Whether the API should be installed globally
+	 */
 	installGlobally: boolean;
 
 	/**
@@ -31,8 +36,7 @@ export interface CloudCannonJavaScriptAPI {
 	disableGlobalInstall(): void;
 
 	/**
-	 * Enables event handling for the API
-	 * This will also ensure the commit model is created
+	 * Enables event handling for the API This will also ensure the commit model is created
 	 */
 	enableEvents(): void;
 
@@ -42,19 +46,21 @@ export interface CloudCannonJavaScriptAPI {
 	disableEvents(): void;
 
 	/**
-	 * Refreshes the editor interface
-	 * Note: This has been replaced with a MutationObserver in editor-overlays-view
+	 * Refreshes the editor interface Note: This has been replaced with a MutationObserver in
+	 * editor-overlays-view
 	 */
 	refreshInterface(): void;
 
 	/**
 	 * Triggers an update event for a specific file
+	 *
 	 * @param sourcePath - The path of the file to update
 	 */
 	triggerUpdateEvent(sourcePath: string): void;
 
 	/**
 	 * Sets the loading state of the editor
+	 *
 	 * @param loadingData - Optional loading state message
 	 * @returns Promise that resolves when loading state is updated
 	 */
@@ -62,6 +68,7 @@ export interface CloudCannonJavaScriptAPI {
 
 	/**
 	 * Sets data for a specific field
+	 *
 	 * @param slug - The identifier of the field to set
 	 * @param value - The value to set
 	 * @returns Promise that resolves when the data is set
@@ -70,6 +77,7 @@ export interface CloudCannonJavaScriptAPI {
 
 	/**
 	 * Initiates editing of a specific field
+	 *
 	 * @param slug - The identifier of the field to edit
 	 * @param style - Optional style information
 	 * @param e - The mouse event that triggered the edit
@@ -78,6 +86,7 @@ export interface CloudCannonJavaScriptAPI {
 
 	/**
 	 * Opens a custom data panel for editing
+	 *
 	 * @param options - Configuration options for the panel
 	 * @returns Promise that resolves when the panel is opened
 	 */
@@ -85,6 +94,7 @@ export interface CloudCannonJavaScriptAPI {
 
 	/**
 	 * Closes a custom data panel
+	 *
 	 * @param options - Configuration options for the panel to close
 	 * @returns Promise that resolves when the panel is closed
 	 */
@@ -92,14 +102,19 @@ export interface CloudCannonJavaScriptAPI {
 
 	/**
 	 * Uploads a file to the editor
+	 *
 	 * @param file - The file to upload
 	 * @param inputConfig - Optional configuration for the input
 	 * @returns Promise that resolves with the path of the uploaded file
 	 */
-	uploadFile(file: File, inputConfig: RichTextInput | ImageInput | FileInput | undefined): Promise<string | undefined>;
+	uploadFile(
+		file: File,
+		inputConfig: RichTextInput | UrlInput | FileInput | undefined,
+	): Promise<string | undefined>;
 
 	/**
 	 * Adds an item to an array field
+	 *
 	 * @param slug - The identifier of the array field
 	 * @param index - The position to insert at (null for end)
 	 * @param value - The value to insert
@@ -110,6 +125,7 @@ export interface CloudCannonJavaScriptAPI {
 
 	/**
 	 * Adds an item before a specific index in an array field
+	 *
 	 * @param slug - The identifier of the array field
 	 * @param index - The index to insert before
 	 * @param value - The value to insert
@@ -120,6 +136,7 @@ export interface CloudCannonJavaScriptAPI {
 
 	/**
 	 * Adds an item after a specific index in an array field
+	 *
 	 * @param slug - The identifier of the array field
 	 * @param index - The index to insert after
 	 * @param value - The value to insert
@@ -130,6 +147,7 @@ export interface CloudCannonJavaScriptAPI {
 
 	/**
 	 * Removes an item from an array field
+	 *
 	 * @param slug - The identifier of the array field
 	 * @param index - The index of the item to remove
 	 * @returns Promise that resolves when the item is removed
@@ -138,6 +156,7 @@ export interface CloudCannonJavaScriptAPI {
 
 	/**
 	 * Moves an item within an array field
+	 *
 	 * @param slug - The identifier of the array field
 	 * @param index - The current index of the item
 	 * @param toIndex - The target index for the item
@@ -147,6 +166,7 @@ export interface CloudCannonJavaScriptAPI {
 
 	/**
 	 * Gets the current value of the editor
+	 *
 	 * @param options - Optional configuration for the value retrieval
 	 * @returns Promise that resolves with the current value
 	 */
@@ -154,6 +174,7 @@ export interface CloudCannonJavaScriptAPI {
 
 	/**
 	 * Claims a lock on a file
+	 *
 	 * @param sourcePath - Optional path of the file to lock
 	 * @returns Promise that resolves with the lock status
 	 */
@@ -161,6 +182,7 @@ export interface CloudCannonJavaScriptAPI {
 
 	/**
 	 * Releases a lock on a file
+	 *
 	 * @param sourcePath - Optional path of the file to unlock
 	 * @returns Promise that resolves with the lock status
 	 */
@@ -168,13 +190,15 @@ export interface CloudCannonJavaScriptAPI {
 
 	/**
 	 * Gets prefetched files
+	 *
 	 * @returns Promise that resolves with a record of file blobs
 	 */
 	prefetchedFiles(): Promise<Record<string, Blob>>;
 
 	/**
 	 * Loads legacy Bookshop information
+	 *
 	 * @returns Promise that resolves with the Bookshop data
 	 */
 	loadLegacyBookshopInfo(): Promise<any>;
-}
+}