maplibre-gl 2.0.0-pre.6 → 2.0.3

package/README.md

@@ -17,6 +17,15 @@ Use
 
 if it is important to you that the behaviour is similar to `mapbox-gl` version 1.x.
 
+If you are OK with changes that integrate non-backward compatible features, install `maplibre-gl` version 2:
+
+```diff
+  "dependencies": {
+-    "mapbox-gl": "^1.13.0"
++    "maplibre-gl": ">=2.0.0"
+  }
+```
+
 And replace `mapboxgl` with `maplibregl` in your JavaScript and optionally in your HTML/CSS code:
 
 > MapLibre GL JS is distributed via [unpkg.com](https://unpkg.com). For more informations please see [MapLibre GL is on unpkg.com](./docs/README-unpkg.md#maplibre-gl-on-unpkgcom).
@@ -66,7 +75,7 @@ If you depend on a free software alternative to `mapbox-gl-js`, please consider
 
 ### Thank you Mapbox 🙏🏽
 
-We'd like to acknowledge the amazing work Mapbox has contributed to open source. The open source community is sad to part ways with them, but we simultaneously feel grateful for everything they already contributed. `mapbox-gl-js` 1.x is an open source achievment which now lives on as `maplibre-gl`. We're proud to develop on the shoulders of giants, thank you Mapbox 🙇🏽‍♀️.
+We'd like to acknowledge the amazing work Mapbox has contributed to open source. The open source community is sad to part ways with them, but we simultaneously feel grateful for everything they already contributed. `mapbox-gl-js` 1.x is an open source achievement which now lives on as `maplibre-gl`. We're proud to develop on the shoulders of giants, thank you Mapbox 🙇🏽‍♀️.
 
 Please keep in mind: Unauthorized backports are the biggest threat to the MapLibre project. It is unacceptable to backport code from mapbox-gl-js, which is not covered by the former BSD-3 license. If you are unsure about this issue, [please ask](https://github.com/maplibre/maplibre-gl-js/discussions)!
 

package/build/generate-struct-arrays.ts

@@ -87,7 +87,7 @@ function createStructArrayType(name: string, layout: StructArrayLayout, includeS
             includeStructAccessors
         });
     } else {
-        arrayTypeEntries.add(`${layoutClass} as ${arrayClass}`);
+        arrayTypeEntries.add(`export class ${arrayClass} extends ${layoutClass} {}`);
     }
 }
 
@@ -428,12 +428,12 @@ fs.writeFileSync('src/data/array_types.ts',
 import assert from 'assert';
 import {Struct, StructArray} from '../util/struct_array';
 import {register} from '../util/web_worker_transfer';
-import Point from '../util/point';
+import Point from '@mapbox/point-geometry';
 
 ${layouts.map(emitStructArrayLayout).join('\n')}
 ${arraysWithStructAccessors.map(emitStructArray).join('\n')}
+${[...arrayTypeEntries].join('\n')}
 export {
-    ${layouts.map(layout => layout.className).join(',\n    ')},
-    ${[...arrayTypeEntries].join(',\n    ')}
+    ${layouts.map(layout => layout.className).join(',\n    ')}
 };
 `);

package/build/generate-style-spec.ts

@@ -125,16 +125,36 @@ export type ResolvedImageSpecification = string;
 
 export type PromoteIdSpecification = {[_: string]: string} | string;
 
+export type FilterSpecificationInputType = string | number | boolean;
 export type FilterSpecification =
-      ['has', string]
-    | ['!has', string]
-    | ['==', string, string | number | boolean]
-    | ['!=', string, string | number | boolean]
-    | ['>', string, string | number | boolean]
-    | ['>=', string, string | number | boolean]
-    | ['<', string, string | number | boolean]
-    | ['<=', string, string | number | boolean]
-    | Array<string | FilterSpecification>; // Can't type in, !in, all, any, none -- https://github.com/facebook/flow/issues/2443
+    // Lookup
+    | ['at', number, (number |string)[]]
+    | ['get', string, Record<string, unknown>?]
+    | ['has', string, Record<string, unknown>?]
+    | ['in', ...FilterSpecificationInputType[], FilterSpecificationInputType | FilterSpecificationInputType[]]
+    | ['index-of', FilterSpecificationInputType, FilterSpecificationInputType | FilterSpecificationInputType[]]
+    | ['length', string | string[]]
+    | ['slice', string | string[], number]
+    // Decision
+    | ['!', FilterSpecification]
+    | ['!=', string | FilterSpecification, FilterSpecificationInputType]
+    | ['<', string | FilterSpecification, FilterSpecificationInputType]
+    | ['<=', string | FilterSpecification, FilterSpecificationInputType]
+    | ['==', string | FilterSpecification, FilterSpecificationInputType]
+    | ['>', string | FilterSpecification, FilterSpecificationInputType]
+    | ['>=', string | FilterSpecification, FilterSpecificationInputType]
+    | ["all", ...FilterSpecification[], FilterSpecificationInputType]
+    | ["any", ...FilterSpecification[], FilterSpecificationInputType]
+    | ["case", ...FilterSpecification[], FilterSpecificationInputType]
+    | ["coalesce", ...FilterSpecification[], FilterSpecificationInputType]
+    | ["match", ...FilterSpecification[], FilterSpecificationInputType]
+    | ["within", ...FilterSpecification[], FilterSpecificationInputType]
+    // Used in convert.ts
+    | ["!in", ...FilterSpecification[], FilterSpecificationInputType]
+    | ["!has", ...FilterSpecification[], FilterSpecificationInputType]
+    | ["none", ...FilterSpecification[], FilterSpecificationInputType]
+    // Fallbak for others
+    | Array<string | FilterSpecification>
 
 export type TransitionSpecification = {
     duration?: number,

package/build/glsl_to_js.js

@@ -0,0 +1,12 @@
+export default function glsl_to_js(code, minify) {
+    if (minify) {
+        code = code.trim() // strip whitespace at the start/end
+            .replace(/\s*\/\/[^\n]*\n/g, '\n') // strip double-slash comments
+            .replace(/\n+/g, '\n') // collapse multi line breaks
+            .replace(/\n\s+/g, '\n') // strip identation
+            .replace(/\s?([+-\/*=,])\s?/g, '$1') // strip whitespace around operators
+            .replace(/([;\(\),\{\}])\n(?=[^#])/g, '$1'); // strip more line breaks
+
+    }
+    return `export default ${JSON.stringify(code)};`;
+}

package/build/post-ts-build.js

@@ -1,6 +1,7 @@
 import fs from 'fs';
 import glob from 'glob';
 import child_process from 'child_process';
+import glsl_to_js from './glsl_to_js.js';
 
 let args = process.argv.slice(2);
 let outputBaseDir = args[0];
@@ -19,17 +20,7 @@ console.log(`Copying glsl files to ${outputBaseDir}, minify: ${minify}`);
 glob("./src/**/*.glsl", null, (err, files) => {
     for (let file of files) {
         let code = fs.readFileSync(file, 'utf8');
-
-        if (minify) {
-            code = code.trim() // strip whitespace at the start/end
-                .replace(/\s*\/\/[^\n]*\n/g, '\n') // strip double-slash comments
-                .replace(/\n+/g, '\n') // collapse multi line breaks
-                .replace(/\n\s+/g, '\n') // strip identation
-                .replace(/\s?([+-\/*=,])\s?/g, '$1') // strip whitespace around operators
-                .replace(/([;\(\),\{\}])\n(?=[^#])/g, '$1'); // strip more line breaks
-
-        }
-        let content = `export default ${JSON.stringify(code)};`
+        let content = glsl_to_js(code, minify);
         let fileName = outputBaseDir + '/' + file.split('/').splice(-1) + ".js";
         fs.writeFileSync(fileName, content);
     }
@@ -44,6 +35,7 @@ console.log(`Starting bundling types`);
 const outputFile = "./dist/maplibre-gl.d.ts";
 child_process.execSync(`dts-bundle-generator --no-check --umd-module-name=maplibregl -o ${outputFile} ./src/index.ts`);
 let types = fs.readFileSync(outputFile, 'utf8');
+// Classes are not exported but should be since this is exported as UMD - fixing...
 types = types.replace(/declare class/g, "export declare class");
 fs.writeFileSync(outputFile, types);
 console.log(`Finished bundling types`);

package/build/release-notes.js

@@ -1,28 +1,12 @@
 #!/usr/bin/env node
 
-const fs = require('fs');
-const execSync = require('child_process').execSync;
-const ejs = require('ejs');
-const _ = require('lodash');
-const semver = require('semver');
+import * as fs from 'fs';
+import * as ejs from 'ejs';
+import semver from 'semver';
 
 const changelogPath = 'CHANGELOG.md';
 const changelog = fs.readFileSync(changelogPath, 'utf8');
 
-let currentVersion = execSync('git describe --tags --match=v*.*.* --abbrev=0')
-    .toString()
-    .trim()
-    .replace('v', '');
-
-let gitTags = execSync('git tag --list v*.*.*')
-    .toString()
-    .split('\n')
-    .map(function(tag) {
-        tag = tag.replace('v', '').trim();
-        return semver.clean(tag);
-    });
-let previousVersion = semver.maxSatisfying(gitTags, "<" + currentVersion, { includePrerelease: false });
-
 /*
   Parse the raw changelog text and split it into individual releases.
 
@@ -33,9 +17,10 @@ let previousVersion = semver.maxSatisfying(gitTags, "<" + currentVersion, { incl
     - Groups the changelog content.
     - Ends when another "## x.x.x" is found.
 */
-const regex = /^## (\d+\.\d+\.\d+).*?\n(.+?)(?=\n^## \d+\.\d+\.\d+.*?\n)/gms;
+const regex = /^## (\d+\.\d+\.\d+.*?)\n(.+?)(?=\n^## \d+\.\d+\.\d+.*?\n)/gms;
 
 let releaseNotes = [];
+let match;
 // eslint-disable-next-line no-cond-assign
 while (match = regex.exec(changelog)) {
     releaseNotes.push({
@@ -44,17 +29,8 @@ while (match = regex.exec(changelog)) {
     });
 }
 
-/*
-  Match the current tag with the most appropriate release notes.
-*/
-const versionsInReleaseNotes = _.map(releaseNotes, 'version');
-const bestReleaseNotesForCurrentVersion = semver.minSatisfying(versionsInReleaseNotes, ">=" + currentVersion);
-const currentReleaseNotes = _.find(releaseNotes, { version: bestReleaseNotesForCurrentVersion });
-
-if (!currentReleaseNotes) {
-    console.error('Could not find a release section satisfying %s in %s — did you forget to rename the "main" section to %s?', currentVersion, changelogPath, currentVersion.split("-")[0]);
-    process.exit(1); // eslint-disable-line no-process-exit
-}
+const latest = releaseNotes[0];
+const previous = releaseNotes[1];
 
 /*
   Fill and print the release notes template.
@@ -62,10 +38,10 @@ if (!currentReleaseNotes) {
 let templatedReleaseNotes;
 
 templatedReleaseNotes = ejs.render(fs.readFileSync('build/release-notes.md.ejs', 'utf8'), {
-    'CURRENTVERSION': currentVersion,
-    'PREVIOUSVERSION': previousVersion,
-    'CHANGELOG': currentReleaseNotes.changelog,
-    'isPrerelease': semver.prerelease(currentVersion)
+    'CURRENTVERSION': latest.version,
+    'PREVIOUSVERSION': previous.version,
+    'CHANGELOG': latest.changelog,
+    'isPrerelease': semver.prerelease(latest.version)
 });
 templatedReleaseNotes = templatedReleaseNotes.trimEnd();
 

package/build/rollup_plugins.js

@@ -1,4 +1,5 @@
 
+import typescript from '@rollup/plugin-typescript';
 import resolve from '@rollup/plugin-node-resolve';
 import replace from '@rollup/plugin-replace';
 import commonjs from '@rollup/plugin-commonjs';
@@ -6,12 +7,14 @@ import unassert from 'rollup-plugin-unassert';
 import json from '@rollup/plugin-json';
 import {terser} from 'rollup-plugin-terser';
 import minifyStyleSpec from './rollup_plugin_minify_style_spec.js';
+import {createFilter} from 'rollup-pluginutils';
 import strip from '@rollup/plugin-strip';
+import glsl_to_js from './glsl_to_js.js';
 
 // Common set of plugins/transformations shared across different rollup
 // builds (main maplibre bundle, style-spec package, benchmarks bundle)
 
-export const plugins = (minified, production) => [
+export const plugins = (minified, production, watch) => [
     minifyStyleSpec(),
     json(),
     // https://github.com/zaach/jison/issues/351
@@ -26,20 +29,39 @@ export const plugins = (minified, production) => [
         sourceMap: true,
         functions: ['PerformanceUtils.*', 'Debug.*']
     }) : false,
+    glsl('**/*.glsl', production),
     minified ? terser({
         compress: {
             pure_getters: true,
             passes: 3
         }
     }) : false,
-    production ? unassert() : false,
+    production ? unassert({
+        include: ['**/*'], // by default, unassert only includes .js files
+    }) : false,
     resolve({
         browser: true,
         preferBuiltins: false
     }),
+    watch ? typescript() : false,
     commonjs({
         // global keyword handling causes Webpack compatibility issues, so we disabled it:
         // https://github.com/mapbox/mapbox-gl-js/pull/6956
         ignoreGlobal: true
     })
 ].filter(Boolean);
+
+// Using this instead of rollup-plugin-string to add minification
+function glsl(include, minify) {
+    const filter = createFilter(include);
+    return {
+        name: 'glsl',
+        transform(code, id) {
+            if (!filter(id)) return;
+            return {
+                code: glsl_to_js(code, minify),
+                map: {mappings: ''}
+            };
+        }
+    };
+}