maplibre-gl 3.0.1 → 3.2.0-pre.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (399) hide show
  1. package/README.md +7 -7
  2. package/build/generate-doc-images.ts +73 -0
  3. package/build/generate-docs.ts +100 -0
  4. package/build/generate-shaders.ts +39 -6
  5. package/build/generate-struct-arrays.ts +9 -12
  6. package/build/readme.md +0 -5
  7. package/dist/maplibre-gl-csp-worker.js +1 -1
  8. package/dist/maplibre-gl-csp-worker.js.map +1 -1
  9. package/dist/maplibre-gl-csp.js +1 -1
  10. package/dist/maplibre-gl-csp.js.map +1 -1
  11. package/dist/maplibre-gl-dev.js +3368 -3420
  12. package/dist/maplibre-gl-dev.js.map +1 -1
  13. package/dist/maplibre-gl.d.ts +3861 -3489
  14. package/dist/maplibre-gl.js +4 -4
  15. package/dist/maplibre-gl.js.map +1 -1
  16. package/package.json +44 -40
  17. package/src/data/array_types.g.ts +14 -48
  18. package/src/data/bucket/circle_bucket.ts +11 -14
  19. package/src/data/bucket/fill_bucket.test.ts +6 -6
  20. package/src/data/bucket/fill_bucket.ts +10 -12
  21. package/src/data/bucket/fill_extrusion_bucket.ts +11 -13
  22. package/src/data/bucket/heatmap_bucket.ts +3 -6
  23. package/src/data/bucket/line_attributes.ts +1 -2
  24. package/src/data/bucket/line_attributes_ext.ts +1 -2
  25. package/src/data/bucket/line_bucket.test.ts +5 -5
  26. package/src/data/bucket/line_bucket.ts +18 -21
  27. package/src/data/bucket/pattern_attributes.ts +1 -3
  28. package/src/data/bucket/pattern_bucket_features.ts +3 -3
  29. package/src/data/bucket/symbol_bucket.test.ts +5 -5
  30. package/src/data/bucket/symbol_bucket.ts +12 -15
  31. package/src/data/bucket.ts +7 -11
  32. package/src/data/dem_data.test.ts +1 -1
  33. package/src/data/dem_data.ts +1 -1
  34. package/src/data/evaluation_feature.ts +4 -5
  35. package/src/data/extent.ts +1 -4
  36. package/src/data/feature_index.ts +14 -13
  37. package/src/data/feature_position_map.test.ts +4 -4
  38. package/src/data/feature_position_map.ts +1 -1
  39. package/src/data/index_array_type.ts +0 -1
  40. package/src/data/load_geometry.test.ts +1 -1
  41. package/src/data/load_geometry.ts +3 -4
  42. package/src/data/program_configuration.ts +6 -11
  43. package/src/data/segment.ts +9 -6
  44. package/src/geo/edge_insets.test.ts +1 -1
  45. package/src/geo/edge_insets.ts +34 -24
  46. package/src/geo/lng_lat.test.ts +1 -1
  47. package/src/geo/lng_lat.ts +60 -43
  48. package/src/geo/lng_lat_bounds.test.ts +2 -2
  49. package/src/geo/lng_lat_bounds.ts +88 -68
  50. package/src/geo/mercator_coordinate.test.ts +2 -2
  51. package/src/geo/mercator_coordinate.ts +33 -26
  52. package/src/geo/transform.test.ts +3 -3
  53. package/src/geo/transform.ts +58 -79
  54. package/src/gl/color_mode.ts +1 -3
  55. package/src/gl/context.ts +39 -21
  56. package/src/gl/cull_face_mode.ts +1 -3
  57. package/src/gl/depth_mode.ts +1 -3
  58. package/src/gl/framebuffer.ts +5 -4
  59. package/src/gl/index_buffer.ts +5 -4
  60. package/src/gl/render_pool.test.ts +2 -2
  61. package/src/gl/render_pool.ts +5 -5
  62. package/src/gl/state.test.ts +1 -1
  63. package/src/gl/stencil_mode.ts +1 -3
  64. package/src/gl/types.ts +14 -14
  65. package/src/gl/value.ts +12 -4
  66. package/src/gl/vertex_buffer.test.ts +2 -2
  67. package/src/gl/vertex_buffer.ts +10 -16
  68. package/src/gl/webgl2.ts +12 -0
  69. package/src/index.test.ts +2 -2
  70. package/src/index.ts +121 -113
  71. package/src/render/draw_background.ts +7 -9
  72. package/src/render/draw_circle.ts +13 -15
  73. package/src/render/draw_collision_debug.ts +11 -13
  74. package/src/render/draw_custom.ts +6 -8
  75. package/src/render/draw_debug.test.ts +4 -4
  76. package/src/render/draw_debug.ts +8 -10
  77. package/src/render/draw_fill.test.ts +13 -13
  78. package/src/render/draw_fill.ts +9 -11
  79. package/src/render/draw_fill_extrusion.ts +10 -12
  80. package/src/render/draw_heatmap.ts +13 -14
  81. package/src/render/draw_hillshade.ts +10 -12
  82. package/src/render/draw_line.ts +9 -9
  83. package/src/render/draw_raster.ts +9 -11
  84. package/src/render/draw_symbol.test.ts +16 -16
  85. package/src/render/draw_symbol.ts +15 -16
  86. package/src/render/draw_terrain.ts +11 -11
  87. package/src/render/glyph_atlas.ts +10 -1
  88. package/src/render/glyph_manager.test.ts +3 -3
  89. package/src/render/glyph_manager.ts +7 -7
  90. package/src/render/image_atlas.ts +6 -3
  91. package/src/render/image_manager.ts +3 -5
  92. package/src/render/line_atlas.test.ts +1 -1
  93. package/src/render/line_atlas.ts +19 -14
  94. package/src/render/painter.ts +86 -66
  95. package/src/render/program/background_program.ts +2 -2
  96. package/src/render/program/circle_program.ts +5 -5
  97. package/src/render/program/clipping_mask_program.ts +1 -1
  98. package/src/render/program/collision_program.ts +4 -4
  99. package/src/render/program/debug_program.ts +1 -1
  100. package/src/render/program/fill_extrusion_program.ts +3 -3
  101. package/src/render/program/fill_program.ts +3 -3
  102. package/src/render/program/heatmap_program.ts +5 -5
  103. package/src/render/program/hillshade_program.ts +7 -7
  104. package/src/render/program/line_program.ts +6 -6
  105. package/src/render/program/pattern.ts +3 -3
  106. package/src/render/program/raster_program.ts +2 -2
  107. package/src/render/program/symbol_program.ts +2 -2
  108. package/src/render/program/terrain_program.ts +1 -1
  109. package/src/render/program.ts +19 -20
  110. package/src/render/render_to_texture.test.ts +15 -15
  111. package/src/render/render_to_texture.ts +10 -10
  112. package/src/render/terrain.test.ts +38 -7
  113. package/src/render/terrain.ts +103 -67
  114. package/src/render/texture.ts +9 -8
  115. package/src/render/uniform_binding.test.ts +1 -1
  116. package/src/render/uniform_binding.ts +8 -2
  117. package/src/render/update_pattern_positions_in_program.ts +5 -5
  118. package/src/render/vertex_array_object.ts +9 -8
  119. package/src/shaders/README.md +2 -2
  120. package/src/shaders/_prelude.fragment.glsl.g.ts +1 -1
  121. package/src/shaders/_prelude.vertex.glsl.g.ts +1 -1
  122. package/src/shaders/background.fragment.glsl.g.ts +1 -1
  123. package/src/shaders/background.vertex.glsl.g.ts +1 -1
  124. package/src/shaders/background_pattern.fragment.glsl.g.ts +1 -1
  125. package/src/shaders/background_pattern.vertex.glsl.g.ts +1 -1
  126. package/src/shaders/circle.fragment.glsl.g.ts +1 -1
  127. package/src/shaders/circle.vertex.glsl.g.ts +1 -1
  128. package/src/shaders/clipping_mask.fragment.glsl.g.ts +1 -1
  129. package/src/shaders/clipping_mask.vertex.glsl.g.ts +1 -1
  130. package/src/shaders/collision_box.fragment.glsl.g.ts +1 -1
  131. package/src/shaders/collision_box.vertex.glsl.g.ts +1 -1
  132. package/src/shaders/collision_circle.fragment.glsl.g.ts +1 -1
  133. package/src/shaders/collision_circle.vertex.glsl.g.ts +1 -1
  134. package/src/shaders/debug.fragment.glsl.g.ts +1 -1
  135. package/src/shaders/debug.vertex.glsl.g.ts +1 -1
  136. package/src/shaders/encode_attribute.ts +0 -2
  137. package/src/shaders/fill.fragment.glsl.g.ts +1 -1
  138. package/src/shaders/fill.vertex.glsl.g.ts +1 -1
  139. package/src/shaders/fill_extrusion.fragment.glsl.g.ts +1 -1
  140. package/src/shaders/fill_extrusion.vertex.glsl.g.ts +1 -1
  141. package/src/shaders/fill_extrusion_pattern.fragment.glsl.g.ts +1 -1
  142. package/src/shaders/fill_extrusion_pattern.vertex.glsl.g.ts +1 -1
  143. package/src/shaders/fill_outline.fragment.glsl.g.ts +1 -1
  144. package/src/shaders/fill_outline.vertex.glsl.g.ts +1 -1
  145. package/src/shaders/fill_outline_pattern.fragment.glsl.g.ts +1 -1
  146. package/src/shaders/fill_outline_pattern.vertex.glsl.g.ts +1 -1
  147. package/src/shaders/fill_pattern.fragment.glsl.g.ts +1 -1
  148. package/src/shaders/fill_pattern.vertex.glsl.g.ts +1 -1
  149. package/src/shaders/heatmap.fragment.glsl.g.ts +1 -1
  150. package/src/shaders/heatmap.vertex.glsl.g.ts +1 -1
  151. package/src/shaders/heatmap_texture.fragment.glsl.g.ts +1 -1
  152. package/src/shaders/heatmap_texture.vertex.glsl.g.ts +1 -1
  153. package/src/shaders/hillshade.fragment.glsl.g.ts +1 -1
  154. package/src/shaders/hillshade.vertex.glsl.g.ts +1 -1
  155. package/src/shaders/hillshade_prepare.fragment.glsl.g.ts +1 -1
  156. package/src/shaders/hillshade_prepare.vertex.glsl.g.ts +1 -1
  157. package/src/shaders/line.fragment.glsl.g.ts +1 -1
  158. package/src/shaders/line.vertex.glsl.g.ts +1 -1
  159. package/src/shaders/line_gradient.fragment.glsl.g.ts +1 -1
  160. package/src/shaders/line_gradient.vertex.glsl.g.ts +1 -1
  161. package/src/shaders/line_pattern.fragment.glsl.g.ts +1 -1
  162. package/src/shaders/line_pattern.vertex.glsl.g.ts +1 -1
  163. package/src/shaders/line_sdf.fragment.glsl.g.ts +1 -1
  164. package/src/shaders/line_sdf.vertex.glsl.g.ts +1 -1
  165. package/src/shaders/raster.fragment.glsl.g.ts +1 -1
  166. package/src/shaders/raster.vertex.glsl.g.ts +1 -1
  167. package/src/shaders/shaders.ts +6 -8
  168. package/src/shaders/symbol_icon.fragment.glsl.g.ts +1 -1
  169. package/src/shaders/symbol_icon.vertex.glsl.g.ts +1 -1
  170. package/src/shaders/symbol_sdf.fragment.glsl.g.ts +1 -1
  171. package/src/shaders/symbol_sdf.vertex.glsl.g.ts +1 -1
  172. package/src/shaders/symbol_text_and_icon.fragment.glsl.g.ts +1 -1
  173. package/src/shaders/symbol_text_and_icon.vertex.glsl.g.ts +1 -1
  174. package/src/shaders/terrain.fragment.glsl.g.ts +1 -1
  175. package/src/shaders/terrain.vertex.glsl.g.ts +1 -1
  176. package/src/shaders/terrain_coords.fragment.glsl.g.ts +1 -1
  177. package/src/shaders/terrain_depth.fragment.glsl.g.ts +1 -1
  178. package/src/source/canvas_source.test.ts +6 -6
  179. package/src/source/canvas_source.ts +46 -60
  180. package/src/source/geojson_source.test.ts +5 -5
  181. package/src/source/geojson_source.ts +71 -55
  182. package/src/source/geojson_source_diff.ts +39 -2
  183. package/src/source/geojson_worker_source.test.ts +3 -3
  184. package/src/source/geojson_worker_source.ts +20 -26
  185. package/src/source/geojson_wrapper.test.ts +3 -3
  186. package/src/source/geojson_wrapper.ts +2 -4
  187. package/src/source/image_source.test.ts +9 -8
  188. package/src/source/image_source.ts +49 -35
  189. package/src/source/load_tilejson.ts +2 -2
  190. package/src/source/pixels_to_tile_units.ts +2 -3
  191. package/src/source/query_features.test.ts +3 -3
  192. package/src/source/query_features.ts +50 -19
  193. package/src/source/raster_dem_tile_source.test.ts +3 -3
  194. package/src/source/raster_dem_tile_source.ts +28 -14
  195. package/src/source/raster_dem_tile_worker_source.test.ts +2 -2
  196. package/src/source/raster_dem_tile_worker_source.ts +3 -5
  197. package/src/source/raster_tile_source.test.ts +3 -3
  198. package/src/source/raster_tile_source.ts +38 -11
  199. package/src/source/rtl_text_plugin.ts +4 -1
  200. package/src/source/source.ts +67 -59
  201. package/src/source/source_cache.test.ts +7 -7
  202. package/src/source/source_cache.ts +24 -40
  203. package/src/source/source_state.ts +2 -5
  204. package/src/source/terrain_source_cache.test.ts +8 -8
  205. package/src/source/terrain_source_cache.ts +42 -27
  206. package/src/source/tile.test.ts +3 -3
  207. package/src/source/tile.ts +32 -38
  208. package/src/source/tile_bounds.ts +2 -4
  209. package/src/source/tile_cache.test.ts +2 -2
  210. package/src/source/tile_cache.ts +20 -30
  211. package/src/source/tile_id.ts +11 -2
  212. package/src/source/vector_tile_source.test.ts +14 -14
  213. package/src/source/vector_tile_source.ts +32 -22
  214. package/src/source/vector_tile_worker_source.test.ts +4 -4
  215. package/src/source/vector_tile_worker_source.ts +12 -24
  216. package/src/source/video_source.test.ts +5 -5
  217. package/src/source/video_source.ts +20 -27
  218. package/src/source/worker.ts +6 -8
  219. package/src/source/worker_source.ts +6 -8
  220. package/src/source/worker_tile.test.ts +5 -5
  221. package/src/source/worker_tile.ts +13 -16
  222. package/src/style/create_style_layer.ts +31 -26
  223. package/src/style/evaluation_parameters.ts +5 -4
  224. package/src/style/format_section_override.test.ts +2 -2
  225. package/src/style/format_section_override.ts +1 -1
  226. package/src/style/light.test.ts +2 -2
  227. package/src/style/light.ts +3 -5
  228. package/src/style/load_glyph_range.test.ts +1 -1
  229. package/src/style/load_glyph_range.ts +3 -3
  230. package/src/style/load_sprite.test.ts +1 -1
  231. package/src/style/load_sprite.ts +3 -3
  232. package/src/style/parse_glyph_pbf.ts +1 -1
  233. package/src/style/pauseable_placement.ts +7 -9
  234. package/src/style/properties.ts +4 -53
  235. package/src/style/query_utils.ts +3 -3
  236. package/src/style/style.test.ts +22 -19
  237. package/src/style/style.ts +118 -84
  238. package/src/style/style_glyph.ts +6 -0
  239. package/src/style/style_image.ts +38 -32
  240. package/src/style/style_layer/background_style_layer.ts +2 -4
  241. package/src/style/style_layer/circle_style_layer.ts +7 -6
  242. package/src/style/style_layer/custom_style_layer.ts +26 -51
  243. package/src/style/style_layer/fill_extrusion_style_layer.ts +4 -6
  244. package/src/style/style_layer/fill_style_layer.ts +5 -7
  245. package/src/style/style_layer/heatmap_style_layer.ts +8 -7
  246. package/src/style/style_layer/hillshade_style_layer.ts +2 -4
  247. package/src/style/style_layer/line_style_layer.ts +6 -8
  248. package/src/style/style_layer/overlap_mode.test.ts +3 -3
  249. package/src/style/style_layer/overlap_mode.ts +3 -0
  250. package/src/style/style_layer/raster_style_layer.ts +2 -4
  251. package/src/style/style_layer/symbol_style_layer.ts +6 -8
  252. package/src/style/style_layer/typed_style_layer.ts +7 -7
  253. package/src/style/style_layer.test.ts +5 -5
  254. package/src/style/style_layer.ts +7 -6
  255. package/src/style/style_layer_index.test.ts +1 -1
  256. package/src/style/style_layer_index.ts +3 -5
  257. package/src/style/zoom_history.ts +1 -3
  258. package/src/symbol/anchor.test.ts +1 -1
  259. package/src/symbol/anchor.ts +1 -3
  260. package/src/symbol/check_max_angle.test.ts +8 -2
  261. package/src/symbol/check_max_angle.ts +10 -13
  262. package/src/symbol/clip_line.test.ts +1 -1
  263. package/src/symbol/clip_line.ts +6 -9
  264. package/src/symbol/collision_feature.test.ts +2 -2
  265. package/src/symbol/collision_feature.ts +7 -12
  266. package/src/symbol/collision_index.test.ts +2 -2
  267. package/src/symbol/collision_index.ts +5 -11
  268. package/src/symbol/cross_tile_symbol_index.test.ts +2 -2
  269. package/src/symbol/cross_tile_symbol_index.ts +5 -7
  270. package/src/symbol/get_anchors.ts +2 -2
  271. package/src/symbol/grid_index.test.ts +1 -1
  272. package/src/symbol/grid_index.ts +4 -5
  273. package/src/symbol/merge_lines.test.ts +1 -1
  274. package/src/symbol/merge_lines.ts +1 -1
  275. package/src/symbol/opacity_state.ts +1 -3
  276. package/src/symbol/path_interpolator.test.ts +1 -1
  277. package/src/symbol/path_interpolator.ts +1 -3
  278. package/src/symbol/placement.ts +9 -9
  279. package/src/symbol/projection.ts +61 -34
  280. package/src/symbol/quads.ts +7 -11
  281. package/src/symbol/shaping.ts +1 -1
  282. package/src/symbol/symbol_layout.ts +9 -12
  283. package/src/symbol/symbol_size.ts +1 -1
  284. package/src/symbol/symbol_style_layer.test.ts +4 -4
  285. package/src/symbol/transform_text.ts +2 -2
  286. package/src/types/callback.ts +14 -14
  287. package/src/types/cancelable.ts +3 -0
  288. package/src/types/transferable.ts +3 -0
  289. package/src/ui/anchor.ts +4 -0
  290. package/src/ui/camera.test.ts +6 -6
  291. package/src/ui/camera.ts +378 -347
  292. package/src/ui/control/attribution_control.test.ts +1 -1
  293. package/src/ui/control/attribution_control.ts +34 -30
  294. package/src/ui/control/control.ts +14 -20
  295. package/src/ui/control/fullscreen_control.test.ts +1 -1
  296. package/src/ui/control/fullscreen_control.ts +20 -25
  297. package/src/ui/control/geolocate_control.test.ts +5 -5
  298. package/src/ui/control/geolocate_control.ts +180 -193
  299. package/src/ui/control/logo_control.ts +20 -16
  300. package/src/ui/control/navigation_control.test.ts +1 -1
  301. package/src/ui/control/navigation_control.ts +44 -40
  302. package/src/ui/control/scale_control.test.ts +1 -1
  303. package/src/ui/control/scale_control.ts +30 -21
  304. package/src/ui/control/terrain_control.test.ts +1 -1
  305. package/src/ui/control/terrain_control.ts +15 -20
  306. package/src/ui/default_locale.ts +1 -3
  307. package/src/ui/events.ts +544 -1255
  308. package/src/ui/handler/box_zoom.test.ts +2 -2
  309. package/src/ui/handler/box_zoom.ts +16 -11
  310. package/src/ui/handler/click_zoom.ts +11 -3
  311. package/src/ui/handler/cooperative_gestures.test.ts +3 -3
  312. package/src/ui/handler/dblclick_zoom.test.ts +1 -1
  313. package/src/ui/handler/drag_handler.ts +30 -22
  314. package/src/ui/handler/drag_move_state_manager.ts +1 -1
  315. package/src/ui/handler/drag_pan.test.ts +2 -2
  316. package/src/ui/handler/drag_rotate.test.ts +3 -3
  317. package/src/ui/handler/keyboard.test.ts +2 -2
  318. package/src/ui/handler/keyboard.ts +22 -13
  319. package/src/ui/handler/map_event.test.ts +2 -2
  320. package/src/ui/handler/map_event.ts +1 -1
  321. package/src/ui/handler/mouse.ts +1 -1
  322. package/src/ui/handler/mouse_rotate.test.ts +3 -3
  323. package/src/ui/handler/scroll_zoom.test.ts +3 -3
  324. package/src/ui/handler/scroll_zoom.ts +45 -52
  325. package/src/ui/handler/shim/dblclick_zoom.ts +12 -6
  326. package/src/ui/handler/shim/drag_pan.ts +34 -14
  327. package/src/ui/handler/shim/drag_rotate.ts +20 -12
  328. package/src/ui/handler/shim/two_fingers_touch.ts +24 -18
  329. package/src/ui/handler/tap_drag_zoom.test.ts +113 -0
  330. package/src/ui/handler/tap_drag_zoom.ts +18 -10
  331. package/src/ui/handler/tap_recognizer.ts +1 -1
  332. package/src/ui/handler/tap_zoom.ts +4 -3
  333. package/src/ui/handler/touch_pan.ts +3 -2
  334. package/src/ui/handler/transform-provider.ts +4 -6
  335. package/src/ui/handler/two_fingers_touch.test.ts +3 -3
  336. package/src/ui/handler/two_fingers_touch.ts +64 -47
  337. package/src/ui/handler_inertia.ts +4 -4
  338. package/src/ui/handler_manager.ts +86 -52
  339. package/src/ui/hash.test.ts +1 -1
  340. package/src/ui/hash.ts +21 -28
  341. package/src/ui/map/isMoving.test.ts +3 -3
  342. package/src/ui/map/isRotating.test.ts +3 -3
  343. package/src/ui/map/isZooming.test.ts +3 -3
  344. package/src/ui/map.test.ts +107 -7
  345. package/src/ui/map.ts +831 -670
  346. package/src/ui/map_events.test.ts +1 -1
  347. package/src/ui/marker.test.ts +35 -15
  348. package/src/ui/marker.ts +214 -135
  349. package/src/ui/popup.test.ts +2 -2
  350. package/src/ui/popup.ts +167 -135
  351. package/src/util/actor.test.ts +7 -7
  352. package/src/util/actor.ts +25 -22
  353. package/src/util/ajax.ts +37 -17
  354. package/src/util/browser.test.ts +1 -1
  355. package/src/util/browser.ts +4 -8
  356. package/src/util/classify_rings.test.ts +1 -1
  357. package/src/util/classify_rings.ts +1 -1
  358. package/src/util/color_ramp.ts +0 -2
  359. package/src/util/config.ts +8 -3
  360. package/src/util/debug.ts +0 -2
  361. package/src/util/dictionary_coder.ts +1 -4
  362. package/src/util/dispatcher.test.ts +3 -3
  363. package/src/util/dispatcher.ts +4 -9
  364. package/src/util/dom.ts +1 -1
  365. package/src/util/evented.ts +23 -18
  366. package/src/util/find_pole_of_inaccessibility.test.ts +1 -1
  367. package/src/util/find_pole_of_inaccessibility.ts +4 -5
  368. package/src/util/global_worker_pool.ts +2 -3
  369. package/src/util/image.ts +10 -4
  370. package/src/util/image_request.test.ts +3 -3
  371. package/src/util/image_request.ts +15 -14
  372. package/src/util/is_char_in_unicode_block.ts +1 -3
  373. package/src/util/offscreen_canvas_supported.ts +1 -1
  374. package/src/util/performance.ts +1 -2
  375. package/src/util/request_manager.ts +4 -0
  376. package/src/util/resolve_tokens.test.ts +1 -1
  377. package/src/util/resolve_tokens.ts +3 -6
  378. package/src/util/script_detection.ts +1 -4
  379. package/src/util/smart_wrap.ts +3 -5
  380. package/src/util/struct_array.ts +18 -14
  381. package/src/util/style.ts +2 -2
  382. package/src/util/task_queue.test.ts +1 -1
  383. package/src/util/task_queue.ts +1 -3
  384. package/src/util/test/mock_webgl.ts +10 -1
  385. package/src/util/test/util.ts +2 -2
  386. package/src/util/throttle.test.ts +1 -1
  387. package/src/util/throttle.ts +1 -2
  388. package/src/util/throttled_invoker.ts +1 -5
  389. package/src/util/transferable_grid_index.test.ts +1 -1
  390. package/src/util/transferable_grid_index.ts +1 -3
  391. package/src/util/util.test.ts +1 -14
  392. package/src/util/util.ts +44 -107
  393. package/src/util/vectortile_to_geojson.ts +13 -3
  394. package/src/util/verticalize_punctuation.ts +1 -1
  395. package/src/util/web_worker.ts +2 -2
  396. package/src/util/web_worker_transfer.ts +11 -8
  397. package/src/util/webp_supported.ts +5 -7
  398. package/src/util/worker_pool.test.ts +1 -1
  399. package/src/util/worker_pool.ts +4 -5
package/README.md CHANGED
@@ -2,12 +2,12 @@
2
2
 
3
3
  # MapLibre GL JS
4
4
 
5
+ [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg?style=flat)](LICENSE.txt) [![Version](https://img.shields.io/npm/v/maplibre-gl?style=flat)](https://www.npmjs.com/package/maplibre-gl) [![CI](https://github.com/maplibre/maplibre-gl-js/actions/workflows/ci.yml/badge.svg)](https://github.com/maplibre/maplibre-gl-js/actions/workflows/ci.yml) [![PRs](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](https://opensource.org/licenses/BSD-3-Clause) [![codecov](https://codecov.io/gh/maplibre/maplibre-gl-js/branch/main/graph/badge.svg)](https://codecov.io/gh/maplibre/maplibre-gl-js)
6
+
5
7
  **[MapLibre GL JS](https://maplibre.org/maplibre-gl-js-docs/api/)** is an open-source library for publishing maps on your websites or webview based apps. Fast displaying of maps is possible thanks to GPU-accelerated vector tile rendering.
6
8
 
7
9
  It originated as an open-source fork of [mapbox-gl-js](https://github.com/mapbox/mapbox-gl-js), before their switch to a non-OSS license in December 2020. The library's initial versions (1.x) were intended to be a drop-in replacement for the Mapbox’s OSS version (1.x) with additional functionality, but have evolved a lot since then.
8
10
 
9
- [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg?style=flat)](LICENSE.txt)[![Version](https://img.shields.io/npm/v/maplibre-gl?style=flat)](https://www.npmjs.com/package/maplibre-gl)[![CI](https://github.com/maplibre/maplibre-gl-js/actions/workflows/ci.yml/badge.svg)](https://github.com/maplibre/maplibre-gl-js/actions/workflows/ci.yml)[![PRs](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](https://opensource.org/licenses/BSD-3-Clause)
10
-
11
11
  ## Getting Started
12
12
 
13
13
  Include the JavaScript and CSS files in the `<head>` of your HTML file.
@@ -64,11 +64,11 @@ The overall migration happens by uninstalling `mapbox-gl` and installing `maplib
64
64
 
65
65
  #### Compatibility branch
66
66
 
67
- Maplibre v1 is completely backward compatible with Mapbox v1. This compatibility branch (named 1.x) is tagged v1 on npm, and its current version is 1.15.3.
67
+ MapLibre GL JS v1 is completely backward compatible with Mapbox GL JS v1. This compatibility branch (named 1.x) is tagged v1 on npm, and its current version is 1.15.3.
68
68
 
69
69
  #### CDN Links
70
70
 
71
- > MapLibre GL JS is distributed via [unpkg.com](https://unpkg.com). For more information, please see [MapLibre GL is on unpkg.com](./documents_and_diagrams/README-unpkg.md#maplibre-gl-on-unpkgcom).
71
+ > MapLibre GL JS is distributed via [unpkg.com](https://unpkg.com). For more information, please see [MapLibre GL JS is on unpkg.com](./documents_and_diagrams/README-unpkg.md#maplibre-gl-on-unpkgcom).
72
72
 
73
73
  ```diff
74
74
  - <script src="https://api.mapbox.com/mapbox-gl-js/v#.#.#/mapbox-gl.js"></script>
@@ -105,10 +105,10 @@ You can find the official status of the backing community and steering committee
105
105
 
106
106
  ### Avoid Fragmentation
107
107
 
108
- If you depend on a free software alternative to `mapbox-gl-js`, please consider joining our effort! Anyone with a stake in a healthy community-led fork is welcome to help us figure out our next steps. We welcome contributors and leaders! MapLibre GL already represents the combined efforts of a few early fork efforts, and we all benefit from "one project" rather than "our way". If you know of other forks, please reach out to them and direct them here.
108
+ If you depend on a free software alternative to `mapbox-gl-js`, please consider joining our effort! Anyone with a stake in a healthy community-led fork is welcome to help us figure out our next steps. We welcome contributors and leaders! MapLibre GL JS already represents the combined efforts of a few early fork efforts, and we all benefit from "one project" rather than "our way". If you know of other forks, please reach out to them and direct them here.
109
109
 
110
110
 
111
- > **MapLibre GL** is developed following [Semantic Versioning (2.0.0)](https://semver.org/spec/v2.0.0.html).
111
+ > **MapLibre GL JS** is developed following [Semantic Versioning (2.0.0)](https://semver.org/spec/v2.0.0.html).
112
112
 
113
113
  ### Bounties
114
114
 
@@ -187,4 +187,4 @@ Please keep in mind: Unauthorized backports are the biggest threat to the MapLib
187
187
 
188
188
  ## License
189
189
 
190
- **MapLibre GL** is licensed under the [3-Clause BSD license](./LICENSE.txt).
190
+ **MapLibre GL JS** is licensed under the [3-Clause BSD license](./LICENSE.txt).
@@ -0,0 +1,73 @@
1
+ import path from 'path';
2
+ import fs from 'fs';
3
+ import puppeteer from 'puppeteer';
4
+ import packageJson from '../package.json' assert { type: 'json' };
5
+
6
+ const exampleName = process.argv[2];
7
+ const examplePath = path.resolve('test', 'examples');
8
+
9
+ const browser = await puppeteer.launch({headless: exampleName === 'all'});
10
+
11
+ const page = await browser.newPage();
12
+ // set viewport and double deviceScaleFactor to get a closer shot of the map
13
+ await page.setViewport({
14
+ width: 600,
15
+ height: 250,
16
+ deviceScaleFactor: 2
17
+ });
18
+
19
+ async function createImage(exampleName) {
20
+ // get the example contents
21
+ const html = fs.readFileSync(path.resolve(examplePath, `${exampleName}.html`), 'utf-8');
22
+
23
+ await page.setContent(html.replaceAll('../../dist', `https://unpkg.com/maplibre-gl@${packageJson.version}/dist`));
24
+
25
+ // Wait for map to load, then wait two more seconds for images, etc. to load.
26
+ await page
27
+ .waitForFunction('map.loaded()')
28
+ .then(async () => {
29
+ // Wait for 5 seconds on 3d model examples, since this takes longer to load.
30
+ const waitTime = exampleName.includes('3d-model') ? 5000 : 1500;
31
+ await new Promise((resolve) => {
32
+ console.log(`waiting for ${waitTime} ms`);
33
+ setTimeout(resolve, waitTime);
34
+ });
35
+ })
36
+ // map.loaded() does not evaluate to true within 3 seconds, it's probably an animated example.
37
+ // In this case we take the screenshot immediately.
38
+ .catch(() => {
39
+ console.log(`Timed out waiting for map load on ${exampleName}.`);
40
+ });
41
+
42
+ await page
43
+ .screenshot({
44
+ path: `./docs/assets/examples/${exampleName}.png`,
45
+ type: 'png',
46
+ clip: {
47
+ x: 0,
48
+ y: 0,
49
+ width: 600,
50
+ height: 250
51
+ }
52
+ })
53
+ .then(() => console.log(`Created ./docs/assets/examples/${exampleName}.png`))
54
+ .catch((err) => {
55
+ console.log(err);
56
+ });
57
+ }
58
+
59
+ if (exampleName === 'all') {
60
+ const allFiles = fs.readdirSync(examplePath).filter(f => f.endsWith('html'));
61
+ console.log(`Generating ${allFiles.length} images.`);
62
+ for (const file of allFiles) {
63
+ await createImage(file);
64
+ }
65
+ } else if (exampleName) {
66
+ await createImage(exampleName);
67
+ } else {
68
+ throw new Error(
69
+ '\n Usage: npm run generate-images <file-name|all>\nExample: npm run generate-images 3d-buildings'
70
+ );
71
+ }
72
+
73
+ await browser.close();
@@ -0,0 +1,100 @@
1
+ import fs from 'fs';
2
+ import path from 'path';
3
+ import typedocConfig from '../typedoc.json' assert {type: 'json'};
4
+ import packageJson from '../package.json' assert {type: 'json'};
5
+
6
+ type HtmlDoc = {
7
+ title: string;
8
+ description: string;
9
+ mdFileName: string;
10
+ }
11
+
12
+ function generateAPIIntroMarkdown(lines: string[]): string {
13
+ let intro = `# Intro
14
+
15
+ This file is intended as a reference for the important and public classes of this API.
16
+ We reccomend looking at the [expamples](../example/index.md) as they will help you the most to start with MapLibre.
17
+
18
+ Most of the classes wirtten here have an "Options" object for initialization, it is recommended to check which options exist.
19
+
20
+ `;
21
+ intro += lines.map(l => l.replace('../', './')).join('\n');
22
+ return intro;
23
+ }
24
+
25
+ function generateMarkdownForExample(title: string, description: string, file: string, htmlContent: string): string {
26
+ return `
27
+ # ${title}
28
+
29
+ ${description}
30
+
31
+ <iframe src="../${file}" width="100%" style="border:none; height:400px"></iframe>
32
+
33
+ \`\`\`html
34
+ ${htmlContent}
35
+ \`\`\`
36
+ `;
37
+ }
38
+
39
+ function generateMarkdownIndexFileOfAllExamples(indexArray: HtmlDoc[]): string {
40
+ let indexMarkdown = '# Overview \n\n';
41
+ for (const indexArrayItem of indexArray) {
42
+ indexMarkdown += `
43
+ ## [${indexArrayItem.title}](./${indexArrayItem.mdFileName})
44
+
45
+ ![${indexArrayItem.description}](../assets/examples/${indexArrayItem.mdFileName!.replace('.md', '.png')})
46
+
47
+ ${indexArrayItem.description}
48
+ `;
49
+ }
50
+ return indexMarkdown;
51
+ }
52
+
53
+ if (!fs.existsSync(typedocConfig.out)) {
54
+ throw new Error('Please run typedoc generation first!');
55
+ }
56
+
57
+ fs.rmSync(path.join(typedocConfig.out, 'README.md'));
58
+ fs.rmSync(path.join(typedocConfig.out, 'modules.md'));
59
+ // Intro file for the API
60
+ const modulesFolder = path.join(typedocConfig.out, 'modules');
61
+ const content = fs.readFileSync(path.join(modulesFolder, `${typedocConfig.internalModule}.md`), 'utf-8');
62
+ let lines = content.split('\n');
63
+ const classesLineIndex = lines.indexOf(lines.find(l => l.endsWith('Classes')) as string);
64
+ lines = lines.splice(2, classesLineIndex - 2);
65
+ const contentString = generateAPIIntroMarkdown(lines);
66
+ fs.writeFileSync(path.join(typedocConfig.out, 'README.md'), contentString);
67
+
68
+ // Examples manupilation
69
+ const examplesDocsFolder = path.join('docs', 'examples');
70
+ if (fs.existsSync(examplesDocsFolder)) {
71
+ fs.rmSync(examplesDocsFolder, {recursive: true, force: true});
72
+ }
73
+ fs.mkdirSync(examplesDocsFolder);
74
+ const examplesFolder = path.join('test', 'examples');
75
+ const files = fs.readdirSync(examplesFolder).filter(f => f.endsWith('html'));
76
+ const maplibreUnpgk = `https://unpkg.com/maplibre-gl@${packageJson.version}/`;
77
+ const indexArray = [] as HtmlDoc[];
78
+ for (const file of files) {
79
+ const htmlFile = path.join(examplesFolder, file);
80
+ let htmlContent = fs.readFileSync(htmlFile, 'utf-8');
81
+ htmlContent = htmlContent.replace(/\.\.\/\.\.\//g, maplibreUnpgk);
82
+ htmlContent = htmlContent.replace(/-dev.js/g, '.js');
83
+ const htmlContentLines = htmlContent.split('\n');
84
+ const title = htmlContentLines.find(l => l.includes('<title'))?.replace('<title>', '').replace('</title>', '').trim();
85
+ const description = htmlContentLines.find(l => l.includes('og:description'))?.replace(/.*content=\"(.*)\".*/, '$1');
86
+ fs.writeFileSync(path.join(examplesDocsFolder, file), htmlContent);
87
+ const mdFileName = file.replace('.html', '.md');
88
+ indexArray.push({
89
+ title: title!,
90
+ description: description!,
91
+ mdFileName
92
+ });
93
+ const exampleMarkdown = generateMarkdownForExample(title, description, file, htmlContent);
94
+ fs.writeFileSync(path.join(examplesDocsFolder, mdFileName), exampleMarkdown);
95
+ }
96
+
97
+ const indexMarkdown = generateMarkdownIndexFileOfAllExamples(indexArray);
98
+ fs.writeFileSync(path.join(examplesDocsFolder, 'index.md'), indexMarkdown);
99
+
100
+ console.log('Docs generation completed, to see it in action run\n docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material');
@@ -12,18 +12,51 @@ console.log('Generating shaders');
12
12
  * It will also create a simple package.json file to allow importing this package in webpack
13
13
  */
14
14
 
15
- const files = globSync('./src/shaders/*.glsl');
16
- for (const file of files) {
15
+ const vertex = globSync('./src/shaders/*.vertex.glsl');
16
+ for (const file of vertex) {
17
17
  const code = fs.readFileSync(file, 'utf8');
18
- const content = glslToTs(code);
18
+ const content = glslToTs(code, 'vertex');
19
19
  const fileName = path.join('.', 'src', 'shaders', `${file.split(path.sep).splice(-1)}.g.ts`);
20
20
  fs.writeFileSync(fileName, content);
21
21
  }
22
- console.log(`Finished converting ${files.length} glsl files`);
23
22
 
24
- function glslToTs(code: string): string {
23
+ console.log(`Finished converting ${vertex.length} vertex shaders`);
24
+
25
+ const fragment = globSync('./src/shaders/*.fragment.glsl');
26
+ for (const file of fragment) {
27
+ const code = fs.readFileSync(file, 'utf8');
28
+ const content = glslToTs(code, 'fragment');
29
+ const fileName = path.join('.', 'src', 'shaders', `${file.split(path.sep).splice(-1)}.g.ts`);
30
+ fs.writeFileSync(fileName, content);
31
+ }
32
+
33
+ console.log(`Finished converting ${fragment.length} fragment shaders`);
34
+
35
+ function glslToTs(code: string, type: 'fragment'|'vertex'): string {
36
+ code = code
37
+ .trim(); // strip whitespace at the start/end
38
+
39
+ // WebGL1 Compat -- Start
40
+
41
+ if (type === 'fragment') {
42
+ code = code
43
+ .replace(/\bin\s/g, 'varying ') // For fragment shaders, replace "in " with "varying "
44
+ .replace('out highp vec4 fragColor;', '');
45
+ }
46
+
47
+ if (type === 'vertex') {
48
+ code = code
49
+ .replace(/\bin\s/g, 'attribute ') // For vertex shaders, replace "in " with "attribute "
50
+ .replace(/\bout\s/g, 'varying '); // For vertex shaders, replace "out " with "varying "
51
+ }
52
+
53
+ code = code
54
+ .replace(/fragColor/g, 'gl_FragColor')
55
+ .replace(/texture\(/g, 'texture2D(');
56
+
57
+ // WebGL1 Compat -- End
58
+
25
59
  code = code
26
- .trim() // strip whitespace at the start/end
27
60
  .replace(/\s*\/\/[^\n]*\n/g, '\n') // strip double-slash comments
28
61
  .replace(/\n+/g, '\n') // collapse multi line breaks
29
62
  .replace(/\n\s+/g, '\n') // strip indentation
@@ -19,9 +19,9 @@ import rasterBoundsAttributes from '../src/data/raster_bounds_attributes';
19
19
  import circleAttributes from '../src/data/bucket/circle_attributes';
20
20
  import fillAttributes from '../src/data/bucket/fill_attributes';
21
21
  import fillExtrusionAttributes from '../src/data/bucket/fill_extrusion_attributes';
22
- import lineAttributes from '../src/data/bucket/line_attributes';
23
- import lineAttributesExt from '../src/data/bucket/line_attributes_ext';
24
- import patternAttributes from '../src/data/bucket/pattern_attributes';
22
+ import {lineLayoutAttributes} from '../src/data/bucket/line_attributes';
23
+ import {lineLayoutAttributesExt} from '../src/data/bucket/line_attributes_ext';
24
+ import {patternAttributes} from '../src/data/bucket/pattern_attributes';
25
25
  // symbol layer specific arrays
26
26
  import {
27
27
  symbolLayoutAttributes,
@@ -144,8 +144,8 @@ const layoutAttributes = {
144
144
  fill: fillAttributes,
145
145
  'fill-extrusion': fillExtrusionAttributes,
146
146
  heatmap: circleAttributes,
147
- line: lineAttributes,
148
- lineExt: lineAttributesExt,
147
+ line: lineLayoutAttributes,
148
+ lineExt: lineLayoutAttributesExt,
149
149
  pattern: patternAttributes
150
150
  };
151
151
  for (const name in layoutAttributes) {
@@ -236,7 +236,6 @@ function emitStructArrayLayout(locals) {
236
236
 
237
237
  output.push(
238
238
  ` *
239
- * @private
240
239
  */
241
240
  class ${structArrayLayoutClass} extends StructArray {`);
242
241
 
@@ -349,7 +348,8 @@ function emitStructArray(locals) {
349
348
 
350
349
  if (includeStructAccessors && !useComponentGetters) {
351
350
  output.push(
352
- `class ${structTypeClass} extends Struct {
351
+ `/** */
352
+ class ${structTypeClass} extends Struct {
353
353
  _structArray: ${structArrayClass};`);
354
354
 
355
355
  for (const {name, member, component} of components) {
@@ -384,9 +384,7 @@ export type ${structTypeClass.replace('Struct', '')} = ${structTypeClass};
384
384
  } // end 'if (includeStructAccessors)'
385
385
 
386
386
  output.push(
387
- `/**
388
- * @private
389
- */
387
+ `/** */
390
388
  export class ${structArrayClass} extends ${structArrayLayoutClass} {`);
391
389
 
392
390
  if (useComponentGetters) {
@@ -407,8 +405,7 @@ export class ${structArrayClass} extends ${structArrayLayoutClass} {`);
407
405
  output.push(
408
406
  ` /**
409
407
  * Return the ${structTypeClass} at the given location in the array.
410
- * @param {number} index The index of the element.
411
- * @private
408
+ * @param index The index of the element.
412
409
  */
413
410
  get(index: number): ${structTypeClass} {
414
411
  return new ${structTypeClass}(this, index);
package/build/readme.md CHANGED
@@ -29,9 +29,6 @@ Rollup is generating 3 files throughout the process of bundling:
29
29
 
30
30
  These 3 files are then referenced and used by the `bundle_prelude.js` file. It allows loading the web wroker code automatically in web workers without any extra effort from someone who would like to use the library, i.e. it simply works.
31
31
 
32
- ### check-bundle-size.js
33
- This file is used by CI to make sure the bundle size is kept constant
34
-
35
32
  <hr>
36
33
 
37
34
  ### `npm run codegen`
@@ -43,8 +40,6 @@ Generates `data/array_types.ts`, which consists of:
43
40
  - Specific named `StructArray` subclasses, when type-specific struct accessors are needed (e.g., `CollisionBoxArray`)
44
41
  #### generate-style-code.ts
45
42
  Generates the various `style/style_layer/[layer type]_style_layer_properties.ts` code files based on the content of `v8.json`. These files provide the type signatures for the paint and layout properties for each type of style layer.
46
- #### generate-style-spec.ts
47
- Generates `style-spec/types.ts` based on the content of `v8.json`. This provides the type signatures for a style specification (sources, layers, etc.).
48
43
  <hr>
49
44
 
50
45
  ### Generate Release Nodes