-
-
Notifications
You must be signed in to change notification settings - Fork 643
/
actor_messages.ts
149 lines (137 loc) · 4.64 KB
/
actor_messages.ts
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
import type {LoadGeoJSONParameters} from '../source/geojson_worker_source';
import type {TileParameters, WorkerDEMTileParameters, WorkerTileParameters, WorkerTileResult} from '../source/worker_source';
import type {DEMData} from '../data/dem_data';
import type {StyleImage} from '../style/style_image';
import type {StyleGlyph} from '../style/style_glyph';
import type {PluginState} from '../source/rtl_text_plugin_status';
import type {LayerSpecification} from '@maplibre/maplibre-gl-style-spec';
import type {OverscaledTileID} from '../source/tile_id';
import type {GetResourceResponse, RequestParameters} from './ajax';
/**
* The parameters needed in order to get information about the cluster
*/
export type ClusterIDAndSource = {
type: 'geojson';
clusterId: number;
source: string;
};
/**
* Parameters needed to get the leaves of a cluster
*/
export type GetClusterLeavesParams = ClusterIDAndSource & { limit: number; offset: number };
/**
* The result of the call to load a geojson source
*/
export type GeoJSONWorkerSourceLoadDataResult = {
resourceTiming?: {[_: string]: Array<PerformanceResourceTiming>};
abandoned?: boolean;
};
/**
* Parameters needed to remove a source
*/
export type RemoveSourceParams = {
source: string;
type: string;
}
/**
* Parameters needed to update the layers
*/
export type UpdateLayersParamaeters = {
layers: Array<LayerSpecification>;
removedIds: Array<string>;
}
/**
* Parameters needed to get the images
*/
export type GetImagesParamerters = {
icons: Array<string>;
source: string;
tileID: OverscaledTileID;
type: string;
}
/**
* Parameters needed to get the glyphs
*/
export type GetGlyphsParamerters = {
type: string;
stacks: {[_: string]: Array<number>};
source: string;
tileID: OverscaledTileID;
}
/**
* A response object returned when requesting glyphs
*/
export type GetGlyphsResponse = {
[stack: string]: {
[id: number]: StyleGlyph;
};
}
/**
* A response object returned when requesting images
*/
export type GetImagesResponse = {[_: string]: StyleImage}
/**
* All the possible message types that can be sent to and from the worker
*/
export const enum MessageType {
loadDEMTile = 'LDT',
getClusterExpansionZoom = 'GCEZ',
getClusterChildren = 'GCC',
getClusterLeaves = 'GCL',
loadData = 'LD',
getData = 'GD',
loadTile = 'LT',
reloadTile = 'RT',
getGlyphs = 'GG',
getImages = 'GI',
setImages = 'SI',
setLayers = 'SL',
updateLayers = 'UL',
syncRTLPluginState = 'SRPS',
setReferrer = 'SR',
removeSource = 'RS',
removeMap = 'RM',
importScript = 'IS',
removeTile = 'RMT',
abortTile = 'AT',
removeDEMTile = 'RDT',
getResource = 'GR',
}
/**
* This is basically a mapping between all the calls that are made to and from the workers.
* The key is the event name, the first parameter is the event input type, and the last parameter is the output type.
*/
export type RequestResponseMessageMap = {
[MessageType.loadDEMTile]: [WorkerDEMTileParameters, DEMData];
[MessageType.getClusterExpansionZoom]: [ClusterIDAndSource, number];
[MessageType.getClusterChildren]: [ClusterIDAndSource, Array<GeoJSON.Feature>];
[MessageType.getClusterLeaves]: [GetClusterLeavesParams, Array<GeoJSON.Feature>];
[MessageType.loadData]: [LoadGeoJSONParameters, GeoJSONWorkerSourceLoadDataResult];
[MessageType.getData]: [LoadGeoJSONParameters, GeoJSON.GeoJSON];
[MessageType.loadTile]: [WorkerTileParameters, WorkerTileResult];
[MessageType.reloadTile]: [WorkerTileParameters, WorkerTileResult];
[MessageType.getGlyphs]: [GetGlyphsParamerters, GetGlyphsResponse];
[MessageType.getImages]: [GetImagesParamerters, GetImagesResponse];
[MessageType.setImages]: [string[], void];
[MessageType.setLayers]: [Array<LayerSpecification>, void];
[MessageType.updateLayers]: [UpdateLayersParamaeters, void];
[MessageType.syncRTLPluginState]: [PluginState, PluginState];
[MessageType.setReferrer]: [string, void];
[MessageType.removeSource]: [RemoveSourceParams, void];
[MessageType.removeMap]: [undefined, void];
[MessageType.importScript]: [string, void];
[MessageType.removeTile]: [TileParameters, void];
[MessageType.abortTile]: [TileParameters, void];
[MessageType.removeDEMTile]: [TileParameters, void];
[MessageType.getResource]: [RequestParameters, GetResourceResponse<any>];
}
/**
* The message to be sent by the actor
*/
export type ActorMessage<T extends MessageType> = {
type: T;
data: RequestResponseMessageMap[T][0];
targetMapId?: string | number | null;
mustQueue?: boolean;
sourceMapId?: string | number | null;
};