@basemaps/lambda-tiler 7.0.0 → 7.1.0

package/src/util/validate.ts

@@ -1,14 +1,22 @@
-import { ImageFormat, LatLon, Projection, TileMatrixSet, TileMatrixSets, VectorFormat } from '@basemaps/geo';
+import { ConfigTileSetRaster, ConfigTileSetRasterOutput } from '@basemaps/config';
+import { ImageFormat, LatLon, Projection, TileMatrixSet, TileMatrixSets } from '@basemaps/geo';
 import { Const, isValidApiKey, truncateApiKey } from '@basemaps/shared';
 import { getImageFormat } from '@basemaps/tiler';
 import { LambdaHttpRequest, LambdaHttpResponse } from '@linzjs/lambda';
-import { TileXyzGet } from '../routes/tile.xyz';
+
+import { TileXyzGet } from '../routes/tile.xyz.js';
 
 export interface TileXyz {
+  /** Tile XYZ location */
   tile: { x: number; y: number; z: number };
+  /** Name of the tile set to use */
   tileSet: string;
+  /** TileMatrix that is requested */
   tileMatrix: TileMatrixSet;
-  tileType: VectorFormat | ImageFormat;
+  /** Output tile format */
+  tileType: string;
+  /** Optional processing pipeline to use */
+  pipeline?: string | null;
 }
 
 export interface TileMatrixRequest {
@@ -18,6 +26,7 @@ export interface TileMatrixRequest {
 export const Validate = {
   /**
    * Validate that the api key exists and is valid
+   *
    * @throws if api key is not valid
    */
   apiKey(req: LambdaHttpRequest): string {
@@ -49,13 +58,6 @@ export const Validate = {
     return [...output.values()];
   },
 
-  getTileFormat(tileType: string): ImageFormat | VectorFormat | null {
-    const ext = getImageFormat(tileType);
-    if (ext) return ext;
-    if (tileType === VectorFormat.MapboxVectorTiles) return VectorFormat.MapboxVectorTiles;
-    return null;
-  },
-
   /** Validate that a lat and lon are between -90/90 and -180/180 */
   getLocation(lonIn: string, latIn: string): LatLon | null {
     const lat = parseFloat(latIn);
@@ -89,9 +91,9 @@ export const Validate = {
     req.set('tileMatrix', tileMatrix.identifier);
     req.set('projection', tileMatrix.projection.code);
 
-    const tileType = Validate.getTileFormat(req.params.tileType);
-    if (tileType == null) throw new LambdaHttpResponse(404, 'Tile extension not found');
-    req.set('extension', tileType);
+    if (req.params.tileType == null) throw new LambdaHttpResponse(404, 'Tile extension not found');
+
+    req.set('extension', req.params.tileType);
 
     if (isNaN(z) || z > tileMatrix.maxZoom || z < 0) throw new LambdaHttpResponse(404, `Zoom not found: ${z}`);
 
@@ -99,7 +101,16 @@ export const Validate = {
     if (isNaN(x) || x < 0 || x > zoom.matrixWidth) throw new LambdaHttpResponse(404, `X not found: ${x}`);
     if (isNaN(y) || y < 0 || y > zoom.matrixHeight) throw new LambdaHttpResponse(404, `Y not found: ${y}`);
 
-    const xyzData = { tile: { x, y, z }, tileSet: req.params.tileSet, tileMatrix, tileType };
+    const pipeline = req.query.get('pipeline');
+    if (pipeline) req.set('pipeline', pipeline);
+
+    const xyzData = {
+      tile: { x, y, z },
+      tileSet: req.params.tileSet,
+      tileMatrix,
+      tileType: req.params.tileType,
+      pipeline: req.query.get('pipeline'),
+    };
     req.set('xyz', xyzData.tile);
 
     const latLon = Projection.tileCenterToLatLon(tileMatrix, xyzData.tile);
@@ -107,4 +118,40 @@ export const Validate = {
 
     return xyzData;
   },
+
+  /**
+   * Lookup the raster configuration pipeline for a output tile type
+   *
+   * Defaults to standard image format output if no outputs are defined on the tileset
+   */
+  pipeline(tileSet: ConfigTileSetRaster, tileType: string, pipeline?: string | null): ConfigTileSetRasterOutput | null {
+    if (pipeline != null && pipeline !== 'rgba') {
+      if (tileSet.outputs == null) throw new LambdaHttpResponse(404, 'TileSet has no pipelines');
+      const output = tileSet.outputs.find((f) => f.name === pipeline);
+      if (output == null) throw new LambdaHttpResponse(404, `TileSet has no pipeline named "${pipeline}"`);
+
+      const validFormats = output.format ?? ['webp', 'png', 'jpeg', 'avif'];
+      if (!validFormats.includes(tileType as ImageFormat)) {
+        throw new LambdaHttpResponse(400, `TileSet pipeline "${pipeline}" cannot be output as ${tileType}`);
+      }
+      return output;
+    }
+    // If the tileset has pipelines defined the user MUST specify which one
+    if (tileSet.outputs) {
+      throw new LambdaHttpResponse(404, 'TileSet needs pipeline: ' + tileSet.outputs.map((f) => f.name));
+    }
+
+    // Generate a default RGBA configuration
+    const img = getImageFormat(tileType ?? 'webp');
+    if (img == null) return null;
+    return {
+      title: `RGBA ${tileType}`,
+      name: 'rgba',
+      output: {
+        type: [img],
+        lossless: img === 'png' ? true : false,
+        background: tileSet.background,
+      },
+    } as ConfigTileSetRasterOutput;
+  },
 };

package/src/wmts.capability.ts

@@ -1,8 +1,7 @@
 import { ConfigImagery, ConfigLayer, ConfigTileSet, standardizeLayerName } from '@basemaps/config';
-import { Bounds, GoogleTms, ImageFormat, Projection, TileMatrixSet, WmtsProvider } from '@basemaps/geo';
+import { BoundingBox, Bounds, GoogleTms, ImageFormat, Projection, TileMatrixSet, WmtsProvider } from '@basemaps/geo';
 import { toQueryString, V, VNodeElement } from '@basemaps/shared';
 import { ImageFormatOrder } from '@basemaps/tiler';
-import { BoundingBox } from '@cogeotiff/core';
 import { BBox } from '@linzjs/geojson';
 
 const CapabilitiesAttrs = {
@@ -245,7 +244,7 @@ export class WmtsCapabilities extends WmtsBuilder {
   minZoom = 0;
   maxZoom = 32;
   /** Wmts tileSet layer and imagery layers information */
-  tileSet: ConfigTileSet;
+  tileSet?: ConfigTileSet;
   configLayers?: ConfigLayer[];
 
   /** Wmts Provider information */
@@ -370,6 +369,7 @@ export class WmtsCapabilities extends WmtsBuilder {
   }
 
   toVNode(): VNodeElement {
+    if (this.tileSet == null) throw new Error('No Tileset provided');
     // Prepare provider vNode if exists
     const provider = this.toProviderVNode(this.provider);
 

package/tsconfig.json

@@ -7,6 +7,7 @@
   "include": ["src/**/*"],
   "references": [
     { "path": "../config" },
+    { "path": "../config-loader/" },
     { "path": "../shared" },
     { "path": "../geo" },
     { "path": "../tiler" },