maplibre-gl 3.1.0 → 3.2.0-pre.2

package/src/util/performance.ts

@@ -77,8 +77,7 @@ export const PerformanceUtils = {
 /**
  * Safe wrapper for the performance resource timing API in web workers with graceful degradation
  *
- * @param {RequestParameters} request
- * @private
+ * @hidden
  */
 export class RequestPerformance {
     _marks: {

package/src/util/request_manager.ts

@@ -14,6 +14,10 @@ export const enum ResourceType {
     Unknown = 'Unknown',
 }
 
+/**
+ * This function is used to tranform a request.
+ * It is used just before executing the relevant request.
+ */
 export type RequestTransformFunction = (url: string, resourceType?: ResourceType) => RequestParameters | undefined;
 
 type UrlObject = {

package/src/util/resolve_tokens.test.ts

@@ -1,4 +1,4 @@
-import resolveTokens from './resolve_tokens';
+import {resolveTokens} from './resolve_tokens';
 
 test('resolveToken', () => {
     expect('3 Fine Fields').toBe(resolveTokens({a: 3, b: 'Fine', c: 'Fields'}, '{a} {b} {c}'));

package/src/util/resolve_tokens.ts

@@ -1,14 +1,11 @@
-export default resolveTokens;
-
 /**
  * Replace tokens in a string template with values in an object
  *
- * @param properties a key/value relationship between tokens and replacements
- * @param text the template string
+ * @param properties - a key/value relationship between tokens and replacements
+ * @param text - the template string
  * @returns the template with tokens replaced
- * @private
  */
-function resolveTokens(
+export function resolveTokens(
     properties: {
         readonly [x: string]: unknown;
     },

package/src/util/script_detection.ts

@@ -1,6 +1,6 @@
 /* eslint-disable new-cap */
 
-import isChar from './is_char_in_unicode_block';
+import {unicodeBlockLookup as isChar} from './is_char_in_unicode_block';
 
 export function allowsIdeographicBreaking(chars: string) {
     for (const char of chars) {
@@ -81,7 +81,6 @@ export function charAllowsIdeographicBreaking(char: number) {
  * adjacent characters can be rotated. For example, a Chinese character is
  * always drawn upright. An uprightly oriented character causes an adjacent
  * “neutral” character to be drawn upright as well.
- * @private
  */
 export function charHasUprightVerticalOrientation(char: number) {
     if (char === 0x02EA /* modifier letter yin departing tone mark */ ||
@@ -169,7 +168,6 @@ export function charHasUprightVerticalOrientation(char: number) {
  * fraction ½ is drawn upright among Chinese characters but rotated among Latin
  * letters. A neutrally oriented character does not influence whether an
  * adjacent character is drawn upright or rotated.
- * @private
  */
 export function charHasNeutralVerticalOrientation(char: number) {
     if (isChar['Latin-1 Supplement'](char)) {
@@ -260,7 +258,6 @@ export function charHasNeutralVerticalOrientation(char: number) {
  * oriented vertically, even if both adjacent characters are upright. For
  * example, a Latin letter is drawn rotated along a vertical line. A rotated
  * character causes an adjacent “neutral” character to be drawn rotated as well.
- * @private
  */
 export function charHasRotatedVerticalOrientation(char: number) {
     return !(charHasUprightVerticalOrientation(char) ||

package/src/util/smart_wrap.ts

@@ -1,7 +1,7 @@
-import LngLat from '../geo/lng_lat';
+import {LngLat} from '../geo/lng_lat';
 
 import type Point from '@mapbox/point-geometry';
-import type Transform from '../geo/transform';
+import type {Transform} from '../geo/transform';
 
 /**
  * Given a LngLat, prior projected position, and a transform, return a new LngLat shifted
@@ -15,10 +15,8 @@ import type Transform from '../geo/transform';
  * possible; they should avoid shifting large distances across the screen, even when the
  * map center changes by ±360° due to automatic wrapping, and when about to go off screen,
  * should wrap just enough to avoid doing so.
- *
- * @private
  */
-export default function smartWrap(lngLat: LngLat, priorPos: Point, transform: Transform): LngLat {
+export function smartWrap(lngLat: LngLat, priorPos: Point, transform: Transform): LngLat {
     lngLat = new LngLat(lngLat.lng, lngLat.lat);
 
     // First, try shifting one world in either direction, and see if either is closer to the

package/src/util/struct_array.ts

@@ -2,6 +2,9 @@
 
 import type {Transferable} from '../types/transferable';
 
+/**
+ * A view type size
+ */
 const viewTypes = {
     'Int8': Int8Array,
     'Uint8': Uint8Array,
@@ -12,11 +15,12 @@ const viewTypes = {
     'Float32': Float32Array
 };
 
-export type ViewType = keyof typeof viewTypes;
-
 /**
- * @private
+ * A view type size
  */
+export type ViewType = keyof typeof viewTypes;
+
+/** */
 class Struct {
     _pos1: number;
     _pos2: number;
@@ -28,9 +32,8 @@ class Struct {
     size: number;
 
     /**
-     * @param {StructArray} structArray The StructArray the struct is stored in
-     * @param {number} index The index of the struct in the StructArray.
-     * @private
+     * @param structArray - The StructArray the struct is stored in
+     * @param index - The index of the struct in the StructArray.
      */
     constructor(structArray: StructArray, index: number) {
         (this as any)._structArray = structArray;
@@ -44,6 +47,9 @@ class Struct {
 const DEFAULT_CAPACITY = 128;
 const RESIZE_MULTIPLIER = 5;
 
+/**
+ * A struct array memeber
+ */
 export type StructArrayMember = {
     name: string;
     type: ViewType;
@@ -57,6 +63,9 @@ export type StructArrayLayout = {
     alignment: number;
 };
 
+/**
+ * An array that can be desialized
+ */
 export type SerializedStructArray = {
     length: number;
     arrayBuffer: ArrayBuffer;
@@ -80,8 +89,6 @@ export type SerializedStructArray = {
  * i-th element.  This affords the convience of working with (seemingly) plain
  * Javascript objects without the overhead of serializing/deserializing them
  * into ArrayBuffers for efficient web worker transfer.
- *
- * @private
  */
 abstract class StructArray {
     capacity: number;
@@ -106,7 +113,6 @@ abstract class StructArray {
      * Serialize a StructArray instance.  Serializes both the raw data and the
      * metadata needed to reconstruct the StructArray base class during
      * deserialization.
-     * @private
      */
     static serialize(array: StructArray, transferables?: Array<Transferable>): SerializedStructArray {
 
@@ -144,7 +150,7 @@ abstract class StructArray {
     }
 
     /**
-     * Resets the the length of the array to 0 without de-allocating capcacity.
+     * Resets the length of the array to 0 without de-allocating capcacity.
      */
     clear() {
         this.length = 0;
@@ -154,7 +160,7 @@ abstract class StructArray {
      * Resize the array.
      * If `n` is greater than the current length then additional elements with undefined values are added.
      * If `n` is less than the current length then the array will be reduced to the first `n` elements.
-     * @param {number} n The new size of the array.
+     * @param n - The new size of the array.
      */
     resize(n: number) {
         this.reserve(n);
@@ -164,7 +170,7 @@ abstract class StructArray {
     /**
      * Indicate a planned increase in size, so that any necessary allocation may
      * be done once, ahead of time.
-     * @param {number} n The expected size of the array.
+     * @param n - The expected size of the array.
      */
     reserve(n: number) {
         if (n > this.capacity) {
@@ -190,8 +196,6 @@ abstract class StructArray {
  * particular calculating the correct byte offset for each field.  This data
  * is used at build time to generate StructArrayLayout_*#emplaceBack() and
  * other accessors, and at runtime for binding vertex buffer attributes.
- *
- * @private
  */
 function createLayout(
     members: Array<{

package/src/util/style.ts

@@ -4,8 +4,8 @@ import {SpriteSpecification} from '@maplibre/maplibre-gl-style-spec';
  * Takes a SpriteSpecification value and returns it in its array form. If `undefined` is passed as an input value, an
  * empty array is returned.
  * duplicated entries with identical id/url will be removed in returned array
- * @param [sprite] {SpriteSpecification} optional sprite to coerce
- * @returns {Array} an empty array in case `undefined` is passed; id-url pairs otherwise
+ * @param sprite - optional sprite to coerce
+ * @returns an empty array in case `undefined` is passed; id-url pairs otherwise
  */
 export function coerceSpriteToArray(sprite?: SpriteSpecification): {id: string; url: string}[] {
     const resultArray: {id: string; url: string}[]  = [];

package/src/util/task_queue.test.ts

@@ -1,4 +1,4 @@
-import TaskQueue from './task_queue';
+import {TaskQueue} from './task_queue';
 
 describe('TaskQueue', () => {
     test('Calls callbacks, in order', () => {

package/src/util/task_queue.ts

@@ -6,7 +6,7 @@ type Task = {
     cancelled: boolean;
 };
 
-class TaskQueue {
+export class TaskQueue {
     _queue: Array<Task>;
     _id: TaskID;
     _cleared: boolean;
@@ -62,5 +62,3 @@ class TaskQueue {
         this._queue = [];
     }
 }
-
-export default TaskQueue;

package/src/util/test/mock_webgl.ts

@@ -30,6 +30,12 @@ export function setupMockWebGLContext(webglContext: any) {
         }
     });
 
+    // Update drawingBufferWidth and drawingBufferHeigth when viewport changes
+    webglContext.viewport = jest.fn((x, y, width, height) => {
+        webglContext.drawingBufferWidth = width;
+        webglContext.drawingBufferHeight = height;
+    });
+
     // Define the properties on the WebGL context
     Object.defineProperty(webglContext, 'bindVertexArray', {
         get() {

package/src/util/test/util.ts

@@ -1,6 +1,6 @@
-import Map from '../../ui/map';
+import {Map} from '../../ui/map';
 import {extend} from '../../util/util';
-import Dispatcher from '../../util/dispatcher';
+import {Dispatcher} from '../../util/dispatcher';
 import {setWebGlContext} from './mock_webgl';
 
 export function createMap(options?, callback?) {

package/src/util/throttle.test.ts

@@ -1,4 +1,4 @@
-import throttle from './throttle';
+import {throttle} from './throttle';
 
 describe('throttle', () => {
 

package/src/util/throttle.ts

@@ -1,8 +1,7 @@
 /**
  * Throttle the given function to run at most every `period` milliseconds.
- * @private
  */
-export default function throttle(fn: () => void, time: number): () => ReturnType<typeof setTimeout> {
+export function throttle(fn: () => void, time: number): () => ReturnType<typeof setTimeout> {
     let pending = false;
     let timerId: ReturnType<typeof setTimeout> = null;
 

package/src/util/throttled_invoker.ts

@@ -1,10 +1,8 @@
 /**
  * Invokes the wrapped function in a non-blocking way when trigger() is called. Invocation requests
  * are ignored until the function was actually invoked.
- *
- * @private
  */
-class ThrottledInvoker {
+export class ThrottledInvoker {
     _channel: MessageChannel;
     _triggered: boolean;
     _callback: Function;
@@ -40,5 +38,3 @@ class ThrottledInvoker {
         this._callback = () => {};
     }
 }
-
-export default ThrottledInvoker;

package/src/util/transferable_grid_index.test.ts

@@ -1,4 +1,4 @@
-import TransferableGridIndex from './transferable_grid_index';
+import {TransferableGridIndex} from './transferable_grid_index';
 
 describe('TransferableGridIndex', () => {
 

package/src/util/transferable_grid_index.ts

@@ -23,7 +23,7 @@ export type SerializedGrid = {
     buffer: ArrayBuffer;
 };
 
-class TransferableGridIndex {
+export class TransferableGridIndex {
     cells: number[][];
     arrayBuffer: ArrayBuffer;
     d: number;
@@ -212,5 +212,3 @@ class TransferableGridIndex {
         return new TransferableGridIndex(serialized.buffer);
     }
 }
-
-export default TransferableGridIndex;

package/src/util/util.test.ts

@@ -1,5 +1,5 @@
 import Point from '@mapbox/point-geometry';
-import {arraysIntersect, asyncAll, bezier, bindAll, clamp, clone, deepEqual, easeCubicInOut, extend, filterObject, findLineIntersection, isClosedPolygon, isCounterClockwise, isPowerOfTwo, keysDifference, mapObject, nextPowerOfTwo, parseCacheControl, pick, uniqueId, wrap} from './util';
+import {arraysIntersect, asyncAll, bezier, clamp, clone, deepEqual, easeCubicInOut, extend, filterObject, findLineIntersection, isClosedPolygon, isCounterClockwise, isPowerOfTwo, keysDifference, mapObject, nextPowerOfTwo, parseCacheControl, pick, uniqueId, wrap} from './util';
 
 describe('util', () => {
     expect(easeCubicInOut(0)).toBe(0);
@@ -13,19 +13,6 @@ describe('util', () => {
     expect(pick({a: 1, b: 2, c: 3}, ['a', 'c', 'd'])).toEqual({a: 1, c: 3});
     expect(typeof uniqueId() === 'number').toBeTruthy();
 
-    test('bindAll', done => {
-        function MyClass() {
-            bindAll(['ontimer'], this);
-            this.name = 'Tom';
-        }
-        MyClass.prototype.ontimer = function() {
-            expect(this.name).toBe('Tom');
-            done();
-        };
-        const my = new MyClass();
-        setTimeout(my.ontimer, 0);
-    });
-
     test('asyncAll - sync', done => {
         expect(asyncAll([0, 1, 2], (data, callback) => {
             callback(null, data);