forked from symfony/ux
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathlive_controller.d.ts
More file actions
254 lines (254 loc) · 7.79 KB
/
Copy pathlive_controller.d.ts
File metadata and controls
254 lines (254 loc) · 7.79 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
import { Controller } from "@hotwired/stimulus";
interface Download {
filename: string;
blob: Blob;
}
declare class export_default$2 {
response: Response;
private body;
private liveUrl;
private download;
private parsePromise;
constructor(response: Response);
getBody(): Promise<string>;
getDownload(): Download | null;
getLiveUrl(): string | null;
getDownloadUrl(): string | null;
isRemoved(): boolean;
private parse;
}
declare class export_default$1 {
promise: Promise<Response>;
actions: string[];
updatedModels: string[];
isResolved: boolean;
constructor(promise: Promise<Response>, actions: string[], updateModels: string[]);
containsOneOfActions(targetedActions: string[]): boolean;
areAnyModelsUpdated(targetedModels: string[]): boolean;
}
interface ChildrenFingerprints {
[key: string]: {
fingerprint: string;
tag: string;
};
}
interface BackendInterface {
makeRequest(props: any, actions: BackendAction[], updated: {
[key: string]: any;
}, children: ChildrenFingerprints, updatedPropsFromParent: {
[key: string]: any;
}, files: {
[key: string]: FileList;
}): export_default$1;
}
interface BackendAction {
name: string;
args: Record<string, string>;
}
interface ElementDriver {
getModelName(element: HTMLElement): string | null;
getComponentProps(): any;
getEventsToEmit(): Array<{
event: string;
data: any;
target: string | null;
componentName: string | null;
}>;
getBrowserEventsToDispatch(): Array<{
event: string;
payload: any;
}>;
}
interface PluginInterface {
attachToComponent(component: Component): void;
}
declare class export_default {
private props;
private dirtyProps;
private pendingProps;
private updatedPropsFromParent;
constructor(props: any);
get(name: string): any;
has(name: string): boolean;
set(name: string, value: any): boolean;
getOriginalProps(): any;
getDirtyProps(): any;
getUpdatedPropsFromParent(): any;
flushDirtyPropsToPending(): void;
reinitializeAllProps(props: any): void;
pushPendingPropsBackToDirty(): void;
storeNewPropsFromParent(props: any): boolean;
}
type MaybePromise<T = void> = T | Promise<T>;
type ComponentHooks = {
connect: (component: Component) => MaybePromise;
disconnect: (component: Component) => MaybePromise;
'request:started': (requestConfig: any) => MaybePromise;
'render:finished': (component: Component) => MaybePromise;
'response:error': (backendResponse: export_default$2, controls: {
displayError: boolean;
}) => MaybePromise;
'loading.state:started': (element: HTMLElement, request: export_default$1) => MaybePromise;
'loading.state:finished': (element: HTMLElement) => MaybePromise;
'model:set': (model: string, value: any, component: Component) => MaybePromise;
};
type ComponentHookName = keyof ComponentHooks;
type ComponentHookCallback<T extends string = ComponentHookName> = T extends ComponentHookName ? ComponentHooks[T] : (...args: any[]) => MaybePromise;
declare class Component {
readonly element: HTMLElement;
readonly name: string;
readonly listeners: Map<string, string[]>;
private backend;
readonly elementDriver: ElementDriver;
id: string | null;
fingerprint: string;
readonly valueStore: export_default;
private readonly unsyncedInputsTracker;
private hooks;
defaultDebounce: number;
private backendRequest;
private pendingActions;
private pendingFiles;
private isRequestPending;
private isRemoved;
private requestDebounceTimeout;
private nextRequestPromise;
private nextRequestPromiseResolve;
private externalMutationTracker;
constructor(element: HTMLElement, name: string, props: any, listeners: Array<{
event: string;
action: string;
}>, id: string | null, backend: BackendInterface, elementDriver: ElementDriver);
addPlugin(plugin: PluginInterface): void;
connect(): void;
disconnect(): void;
on<T extends string | ComponentHookName = ComponentHookName>(hookName: T, callback: ComponentHookCallback<T>): void;
off<T extends string | ComponentHookName = ComponentHookName>(hookName: T, callback: ComponentHookCallback<T>): void;
set(model: string, value: any, reRender?: boolean, debounce?: number | boolean): Promise<export_default$2>;
getData(model: string): any;
action(name: string, args?: any, debounce?: number | boolean): Promise<export_default$2>;
files(key: string, input: HTMLInputElement): void;
render(): Promise<export_default$2>;
getUnsyncedModels(): string[];
emit(name: string, data: any, onlyMatchingComponentsNamed?: string | null): void;
emitUp(name: string, data: any, onlyMatchingComponentsNamed?: string | null): void;
emitSelf(name: string, data: any): void;
private performEmit;
private doEmit;
private isTurboEnabled;
private removeFromPage;
private tryStartingRequest;
private performRequest;
private processRerender;
private calculateDebounce;
private clearRequestDebounceTimeout;
private debouncedStartRequest;
private renderError;
private resetPromise;
_updateFromParentProps(props: any): void;
}
declare const getComponent: (element: HTMLElement) => Promise<Component>;
interface LiveEvent extends CustomEvent {
detail: {
controller: LiveController;
component: Component;
};
}
interface LiveController {
element: HTMLElement;
component: Component;
}
declare class LiveControllerDefault extends Controller<HTMLElement> implements LiveController {
static values: {
name: StringConstructor;
url: StringConstructor;
props: {
type: ObjectConstructor;
default: {};
};
propsUpdatedFromParent: {
type: ObjectConstructor;
default: {};
};
listeners: {
type: ArrayConstructor;
default: never[];
};
eventsToEmit: {
type: ArrayConstructor;
default: never[];
};
eventsToDispatch: {
type: ArrayConstructor;
default: never[];
};
debounce: {
type: NumberConstructor;
default: number;
};
fingerprint: {
type: StringConstructor;
default: string;
};
requestMethod: {
type: StringConstructor;
default: string;
};
fetchCredentials: {
type: StringConstructor;
default: string;
};
};
readonly nameValue: string;
readonly urlValue: string;
readonly propsValue: any;
propsUpdatedFromParentValue: any;
readonly listenersValue: Array<{
event: string;
action: string;
}>;
readonly eventsToEmitValue: Array<{
event: string;
data: any;
target: string | null;
componentName: string | null;
}>;
readonly eventsToDispatchValue: Array<{
event: string;
payload: any;
}>;
readonly hasDebounceValue: boolean;
readonly debounceValue: number;
readonly fingerprintValue: string;
readonly requestMethodValue: 'get' | 'post';
readonly fetchCredentialsValue: RequestCredentials;
private proxiedComponent;
private mutationObserver;
component: Component;
pendingActionTriggerModelElement: HTMLElement | null;
private elementEventListeners;
private pendingFiles;
static backendFactory: (controller: LiveControllerDefault) => BackendInterface;
initialize(): void;
connect(): void;
disconnect(): void;
update(event: any): void;
action(event: any): void;
$render(): Promise<export_default$2>;
emit(event: any): void;
emitUp(event: any): void;
emitSelf(event: any): void;
$updateModel(model: string, value: any, shouldRender?: boolean, debounce?: number | boolean): Promise<export_default$2>;
propsUpdatedFromParentValueChanged(): void;
fingerprintValueChanged(): void;
private getEmitDirectives;
private createComponent;
private connectComponent;
private disconnectComponent;
private handleInputEvent;
private handleChangeEvent;
private updateModelFromElementEvent;
private dispatchEvent;
private onMutations;
}
export { Component, LiveController, LiveEvent, LiveControllerDefault as default, getComponent };