@mapwhit/tilerenderer 1.5.0 → 1.6.0

package/build/min/package.json

@@ -1,4 +1,4 @@
 {
-  "version": "1.5.0",
+  "version": "1.6.0",
   "type": "module"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mapwhit/tilerenderer",
   "description": "A WebGL interactive maps library",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "type": "module",
   "exports": {
     ".": "./src/index.js",
@@ -25,7 +25,6 @@
     "@mapwhit/vector-tile": "4.0.0",
     "@pirxpilot/nanoassert": "~1",
     "csscolorparser": "^1.0.3",
-    "dynload": "^1.0.2",
     "earcut": "^3.0.1",
     "geojson-vt": "^4.0.2",
     "grid-index": "^1.1.0",

package/src/index.js

@@ -43,22 +43,27 @@ export default mapwhit;
  */
 
 /**
- * Sets the map's [RTL text plugin](https://www.mapbox.com/mapbox-gl-js/plugins/#mapbox-gl-rtl-text).
+ * Sets the map's [RTL text plugin](https://github.com/mapwhit/rtl-text).
  * Necessary for supporting languages like Arabic and Hebrew that are written right-to-left.
  *
  * @function setRTLTextPlugin
- * @param {string} pluginURL URL pointing to the Mapbox RTL text plugin source.
- * @param {boolean} lazy If set to `true`, mapboxgl will defer loading the plugin until rtl text is encountered,
+ * @param {function} loadPlugin a function that returns a Promise resolving to object
+ *   with RTL text plugin methods `applyArabicShaping`, `processBidirectionalText`,
+ *   and `processStyledBidirectionalText`.
+ * @param {boolean} lazy If set to `true`, loading the plugin will defer until rtl text is encountered,
  *    rtl text will then be rendered only after the plugin finishes loading.
  * @example
- * setRTLTextPlugin('https://unpkg.com/@mapbox/mapbox-gl-rtl-text@0.3.0/dist/mapbox-gl-rtl-text.js', false);
+ * ```javascript
+ * import loadRTLTextPlugin from '@mapwhit/rtl-text';
+ * setRTLTextPlugin(loadRTLTextPlugin, true);
+ * ```
  * @see [Add support for right-to-left scripts](https://maplibre.org/maplibre-gl-js/docs/examples/mapbox-gl-rtl-text/)
  */
-function setRTLTextPlugin(pluginURL, lazy) {
-  return rtlPluginLoader.setRTLTextPlugin(pluginURL, lazy);
+function setRTLTextPlugin(loadPlugin, lazy) {
+  return rtlPluginLoader.setRTLTextPlugin(loadPlugin, lazy);
 }
 /**
- * Gets the map's [RTL text plugin](https://www.mapbox.com/mapbox-gl-js/plugins/#mapbox-gl-rtl-text) status.
+ * Gets the map's [RTL text plugin](https://github.com/mapwhit/rtl-text) status.
  * The status can be `unavailable` (i.e. not requested or removed), `loading`, `loaded` or `error`.
  * If the status is `loaded` and the plugin is requested again, an error will be thrown.
  *

package/src/source/rtl_text_plugin.js

@@ -1,6 +1,4 @@
 import { Event, Evented } from '@mapwhit/events';
-import dynload from 'dynload';
-import browser from '../util/browser.js';
 
 /**
  * The possible option of the plugin's status
@@ -49,14 +47,13 @@ export const rtlPlugin = RTLPlugin();
 
 function RTLPluginLoader() {
   let status = 'unavailable';
-  let url;
+  let load;
 
   const self = {
     getRTLTextPluginStatus,
     setRTLTextPlugin,
     lazyLoad,
-    _clearRTLTextPlugin,
-    _registerRTLTextPlugin
+    _clearRTLTextPlugin
   };
 
   /** This one is exposed to outside */
@@ -66,20 +63,17 @@ function RTLPluginLoader() {
 
   // public for testing
   function _clearRTLTextPlugin() {
-    url = undefined;
     status = 'unavailable';
+    load = undefined;
     _setMethods();
   }
 
-  function setRTLTextPlugin(pluginURL, deferred = false) {
-    if (url) {
+  function setRTLTextPlugin(pluginLoad, deferred = false) {
+    if (load) {
       // error
       return Promise.reject(new Error('setRTLTextPlugin cannot be called multiple times.'));
     }
-    url = browser.resolveURL(pluginURL);
-    if (!url) {
-      return Promise.reject(new Error(`requested url ${pluginURL} is invalid`));
-    }
+    load = pluginLoad;
     if (status === 'requested') {
       return _downloadRTLTextPlugin();
     }
@@ -93,9 +87,13 @@ function RTLPluginLoader() {
   }
 
   async function _downloadRTLTextPlugin() {
+    if (typeof load !== 'function') {
+      return Promise.reject(new Error('RTL text plugin load function is not set.'));
+    }
     status = 'loading';
     try {
-      await rtlPluginLoader._loadScript({ url });
+      _setMethods(await load());
+      status = 'loaded';
     } catch {
       status = 'error';
     }
@@ -126,36 +124,7 @@ function RTLPluginLoader() {
     rtlPlugin.processStyledBidirectionalText = rtlTextPlugin.processStyledBidirectionalText;
   }
 
-  // This is invoked by the RTL text plugin when the download has finished, and the code has been parsed.
-  function _registerRTLTextPlugin(rtlTextPlugin) {
-    if (rtlPlugin.isRTLSupported()) {
-      throw new Error('RTL text plugin already registered.');
-    }
-    status = 'loaded';
-    _setMethods(rtlTextPlugin);
-  }
-
   return self;
 }
 
-// public for testing
-function _loadScript({ url }) {
-  const { promise, resolve, reject } = Promise.withResolvers();
-  const s = dynload(url);
-  s.onload = () => resolve();
-  s.onerror = () => reject(true);
-  return promise;
-}
-
-const { getRTLTextPluginStatus, setRTLTextPlugin, lazyLoad, _clearRTLTextPlugin, _registerRTLTextPlugin } =
-  RTLPluginLoader();
-
-globalThis.registerRTLTextPlugin ??= _registerRTLTextPlugin;
-
-export const rtlPluginLoader = Object.assign(new Evented(), {
-  getRTLTextPluginStatus,
-  setRTLTextPlugin,
-  lazyLoad,
-  _clearRTLTextPlugin,
-  _loadScript
-});
+export const rtlPluginLoader = Object.assign(new Evented(), RTLPluginLoader());