Skip to content

Commit

Permalink
docs: v4.2 release notes (visgl#2963)
Browse files Browse the repository at this point in the history
  • Loading branch information
ibgreen authored Apr 9, 2024
1 parent 0d9f54f commit 3c5f743
Show file tree
Hide file tree
Showing 6 changed files with 395 additions and 392 deletions.
2 changes: 1 addition & 1 deletion docs/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<br />
<br />

This documentation describes loaders.gl **v4.0**. See our [**release notes**](/docs/whats-new) to learn what is new.
This documentation describes loaders.gl **v4**. See our [**release notes**](/docs/whats-new) to learn what is new.

Docs for older versions are available on github:
**[v3.3](https://github.com/visgl/loaders.gl/blob/3.3-release/docs/README.md)**,
Expand Down
4 changes: 4 additions & 0 deletions docs/upgrade-guide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Upgrade Guide

## Upgrading to v4.2

- It is recommended (but not required) to add `dataType` and `batchType` fields to any custom loaders.

## Upgrading to v4.1

**@loaders.gl/wkt**
Expand Down
45 changes: 22 additions & 23 deletions docs/whats-new.mdx
Original file line number Diff line number Diff line change
@@ -1,43 +1,38 @@
# What's New

## v4.2 (In development, alpha releases available)
## v4.2

Target Release Date: April, 2024
Release Date: April 9, 2024

- deck.gl v9: Website and `examples/website/*` updated to deck.gl v9.
- Internal tooling upgrades: ~10x faster builds via esbuild. ~2x faster installs via yarn 4.
A minor release that includes:

- TypeScript: More loader object information is preserved (e.g. when hovering over a loader object in vscod). loaders are now typed using `as const satisfies Loader<...>`.
- TypeScript: Loaders with workers now declare a `workerUrl` field in their LoaderOptions types (removing type errors when overriding the workerUrl field).
- **deck.gl v9**: All [website examples](https://github.com/visgl/loaders.gl/tree/master/examples/website) updated to deck.gl v9.
- **TypeScript**: Loader objects are typed via `as const satisfies`, preserving more type information.
- **TypeScript**: Loaders with workers now declare the `workerUrl` field in their `...LoaderOptions` types.
- **Build tooling**: loaders.gl itself now builds ~10x faster via esbuild, and installs ~2x faster via yarn 4.

**@loaders.gl/core**

- `selectLoader()` - MIME type comparisons are now case insensitive.

**@loaders.gl/tile-converter**

- `tile-converter` - Resume conversion from the last tile processed in case of an interruption.
- `tile-converter` - Quiet mode.
- `tile-converter` - Convert I3S to 3D Tiles from local SLPK file.

**@loaders.gl/pmtiles**

- `PMTilesSource` - now uses [`pmtiles` version 3](https://github.com/protomaps/PMTiles/blob/main/js/CHANGELOG.md).
- `PMTilesSource` - Now refreshes the already loaded index if the underlying PMTiles file being loaded from is changed (rewritten).
- `PMTilesSource` - Now refreshes the already loaded index if the underlying PMTiles file being loaded from is changed.

**@loaders.gl/parquet**

- `ParquetLoader` - Node supports Zstandard (de)compression if the `zstd-codec` library is supplied (or pre-registered).
- `ParquetLoader` - Now supports the Zstandard compression if the `zstd-codec` library is supplied (or pre-registered).
- `ParquetLoader` - Many parquet files that previously failed to load now load correctly.
- `GeoparquetLoader` - Improved support for large `Polygons` and `MultiPolygons`.

**@loaders.gl/i3s**

- `SLPKLoader` - Experimental feature: Render local SLPK in a web browser.
- `SLPKLoader` - Load from a local SLPK archive in the browser (Experimental).

**@loaders.gl/3d-tiles**

- `Tile3DLoader` - Now extracts Draco3D FLOAT64, INT64 and UINT64 attributes from `.PNTS` files. See [LAS to 3D Tiles conversion](https://cesium.com/blog/2024/03/20/preserving-more-metadata-for-point-clouds-using-3dtiles/).
- `Tile3DLoader` - Ignores unknown Draco3D attributes such as FLOAT64, INT64 and UINT64, when loading from e.g. `.PNTS` files. See [LAS to 3D Tiles conversion](https://cesium.com/blog/2024/03/20/preserving-more-metadata-for-point-clouds-using-3dtiles/).

**@loaders.gl/draco**

Expand All @@ -51,7 +46,17 @@ Target Release Date: April, 2024

**@loaders.gl/las**

- `LASLoader`: A big memory leak plugged.
- `LASLoader`: Memory leak plugged.

**@loaders.gl/wms**

- `WMSService`: `getFeatureInfo()` now also supports querying WMS 1.3 services.

**@loaders.gl/tile-converter**

- `tile-converter` - Resume conversion from the last tile processed in case of an interruption.
- `tile-converter` - Quiet mode.
- `tile-converter` - Convert I3S to 3D Tiles from local SLPK file.

## v4.1

Expand Down Expand Up @@ -85,8 +90,6 @@ A major release that brings:
- **File format documentation** - articles describing the [file formats](/docs/formats?README) supported by loaders.gl.
- **Node.js v18 & v20** - Supports the current set of Node.js LTS releases.

### Loader Module Updates

**@loaders.gl/pmtiles** - NEW

- New [`PMTilesSource`](/docs/modules/pmtiles/api-reference/pmtiles-source) supports the [PMTiles](/docs/modules/pmtiles/formats/pmtiles) format.
Expand Down Expand Up @@ -148,8 +151,6 @@ A major release that brings:

- Now uses latest `sql.js` v1.8.0.

### Core Module Updates

**@loaders.gl/core**

- `fetchFile()` now supports fetching from local filesystem in Node.js
Expand Down Expand Up @@ -177,8 +178,6 @@ A major release that brings:
- Polyfills now contains Node dependent code for other modules, minimizing the risk of Node.js-dependency related bundling complications when using other loaders.gl modules in the browser.
- Polyfills no longer installs `fetch`/`Response`/`Headers` polyfills under Node.js, instead leveraging the built-in `fetch()` support in Node.js v18+.

### Tile Converter Updates

**@loaders.gl/tile-converter**

- New command-line tools for working with I3S archive format (SLPK) files
Expand Down
12 changes: 6 additions & 6 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@
"@deck.gl/layers": "^9.0.4",
"@deck.gl/mesh-layers": "^9.0.4",
"@deck.gl/react": "^9.0.4",
"@docusaurus/core": "^3.1.1",
"@docusaurus/preset-classic": "^3.1.1",
"@docusaurus/core": "^3.2.1",
"@docusaurus/preset-classic": "^3.2.1",
"@esri/react-arcgis": "^5.2.0",
"@fortawesome/fontawesome-svg-core": "^1.2.34",
"@fortawesome/free-solid-svg-icons": "^5.15.2",
Expand Down Expand Up @@ -69,10 +69,10 @@
},
"devDependencies": {
"@cmfcmf/docusaurus-search-local": "^1.0.0",
"@docusaurus/module-type-aliases": "^3.1.1",
"@docusaurus/plugin-client-redirects": "^3.1.1",
"@docusaurus/plugin-content-docs": "^3.1.1",
"@docusaurus/tsconfig": "^3.1.1",
"@docusaurus/module-type-aliases": "^3.2.1",
"@docusaurus/plugin-client-redirects": "^3.2.1",
"@docusaurus/plugin-content-docs": "^3.2.1",
"@docusaurus/tsconfig": "^3.2.1",
"babel-plugin-styled-components": "^2.0.0",
"ts-node": "~10.9.1"
},
Expand Down
Loading

0 comments on commit 3c5f743

Please sign in to comment.