Skip to content

Enhance event listener to directly match the native implementation #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 22, 2025
Merged

Enhance event listener to directly match the native implementation #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 57 additions & 14 deletions src/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ export interface OpenCustomDataPanelOptions extends CloseCustomDataPanelOptions
allowFullDataCascade?: boolean;
}

type EventListenerParameters = Parameters<EventTarget['addEventListener']>;
type EventListenerOrEventListenerObject = EventListenerParameters[1];
type EventListenerOptions = EventListenerParameters[2];

/**
* 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.
Expand Down Expand Up @@ -294,8 +298,16 @@ export interface CloudCannonJavaScriptV1APIFileContent {
*/
set(options: any): Promise<void>;

addEventListener(event: 'change', callback: (event: any) => void): void;
removeEventListener(event: 'change', callback: (event: any) => void): void;
addEventListener(
event: 'change',
listener: EventListenerOrEventListenerObject | null,
options?: EventListenerOptions | boolean
): void;
removeEventListener(
event: 'change',
listener: EventListenerOrEventListenerObject | null,
options?: EventListenerOptions | boolean
): void;
}

export interface CloudCannonJavaScriptV1APIFileData {
Expand Down Expand Up @@ -395,8 +407,16 @@ export interface CloudCannonJavaScriptV1APIFileData {
*/
moveArrayItem(options: MoveArrayItemOptions): Promise<void>;

addEventListener(event: 'change', callback: (event: any) => void): void;
removeEventListener(event: 'change', callback: (event: any) => void): void;
addEventListener(
event: 'change',
listener: EventListenerOrEventListenerObject | null,
options?: EventListenerOptions | boolean
): void;
removeEventListener(
event: 'change',
listener: EventListenerOrEventListenerObject | null,
options?: EventListenerOptions | boolean
): void;
}

export interface CloudCannonJavaScriptV1APIFile {
Expand Down Expand Up @@ -474,8 +494,16 @@ export interface CloudCannonJavaScriptV1APIFile {
*/
releaseLock(): Promise<{ readOnly: boolean }>;

addEventListener(event: 'change' | 'delete' | 'create', callback: (event: any) => void): void;
removeEventListener(event: 'change' | 'delete' | 'create', callback: (event: any) => void): void;
addEventListener(
event: 'change' | 'delete' | 'create',
listener: EventListenerOrEventListenerObject | null,
options?: EventListenerOptions | boolean
): void;
removeEventListener(
event: 'change' | 'delete' | 'create',
listener: EventListenerOrEventListenerObject | null,
options?: EventListenerOptions | boolean
): void;
}

export interface CloudCannonJavaScriptV1APICollection {
Expand All @@ -499,8 +527,16 @@ export interface CloudCannonJavaScriptV1APICollection {
// */
// add(options: any): Promise<CloudCannonJavaScriptV1APIFile>;

addEventListener(event: 'change' | 'delete' | 'create', callback: (event: any) => void): void;
removeEventListener(event: 'change' | 'delete' | 'create', callback: (event: any) => void): void;
addEventListener(
event: 'change' | 'delete' | 'create',
listener: EventListenerOrEventListenerObject | null,
options?: EventListenerOptions | boolean
): void;
removeEventListener(
event: 'change' | 'delete' | 'create',
listener: EventListenerOrEventListenerObject | null,
options?: EventListenerOptions | boolean
): void;
}

export interface CloudCannonJavaScriptV1API {
Expand Down Expand Up @@ -548,8 +584,16 @@ export interface CloudCannonJavaScriptV1API {
files(): Promise<CloudCannonJavaScriptV1APIFile[]>;
collections(): Promise<CloudCannonJavaScriptV1APICollection[]>;

addEventListener(event: 'change' | 'delete' | 'create', callback: (event: any) => void): void;
removeEventListener(event: 'change' | 'delete' | 'create', callback: (event: any) => void): void;
addEventListener(
event: 'change' | 'delete' | 'create',
listener: EventListenerOrEventListenerObject | null,
options?: EventListenerOptions | boolean
): void;
removeEventListener(
event: 'change' | 'delete' | 'create',
listener: EventListenerOrEventListenerObject | null,
options?: EventListenerOptions | boolean
): void;
}

export type CloudCannonJavaScriptAPIVersions = 'v0' | 'v1';
Expand All @@ -558,11 +602,10 @@ export interface CloudCannonApiEventDetails {
CloudCannonAPI?: CloudCannonJavascriptApiRouter;
CloudCannon?: CloudCannonJavaScriptV0API | CloudCannonJavaScriptV1API;
}

export interface CloudCannonEditorWindow extends Window, CloudCannonApiEventDetails {}

export interface CloudCannonJavascriptApiRouter {
useVersion(
key: CloudCannonJavaScriptAPIVersions,
preventGlobalInstall?: boolean
): CloudCannonJavaScriptV0API | CloudCannonJavaScriptV1API;
useVersion(key: 'v0', preventGlobalInstall?: boolean): CloudCannonJavaScriptV0API;
useVersion(key: 'v1', preventGlobalInstall?: boolean): CloudCannonJavaScriptV1API;
}