@deck.gl/carto 9.0.16 → 9.0.17

package/package.json

@@ -3,7 +3,7 @@
   "description": "CARTO official integration with Deck.gl. Build geospatial applications using CARTO and Deck.gl.",
   "license": "MIT",
   "type": "module",
-  "version": "9.0.16",
+  "version": "9.0.17",
   "publishConfig": {
     "access": "public"
   },
@@ -73,5 +73,5 @@
     "@deck.gl/layers": "^9.0.0",
     "@loaders.gl/core": "^4.2.0"
   },
-  "gitHead": "87e1629767fae5167a43dc9fa04786a16879f7aa"
+  "gitHead": "203d25c47f421a29d607a2a6fd9e1ef50f67b2bf"
 }

package/src/api/carto-api-error.ts

@@ -16,7 +16,15 @@ export class CartoAPIError extends Error {
   /** Response from server */
   response?: Response;
 
-  constructor(error: Error, errorContext: APIErrorContext, response?: Response) {
+  /** JSON Response from server */
+  responseJson?: any;
+
+  constructor(
+    error: Error,
+    errorContext: APIErrorContext,
+    response?: Response,
+    responseJson?: any
+  ) {
     let responseString = 'Failed to connect';
     if (response) {
       responseString = 'Server returned: ';
@@ -46,6 +54,7 @@ export class CartoAPIError extends Error {
 
     this.name = 'CartoAPIError';
     this.response = response;
+    this.responseJson = responseJson;
     this.error = error;
     this.errorContext = errorContext;
   }

package/src/api/common.ts

@@ -1,16 +1,4 @@
-import {VERSION} from '@deck.gl/core';
-
 export const DEFAULT_API_BASE_URL = 'https://gcp-us-east1.api.carto.com';
 export const DEFAULT_CLIENT = 'deck-gl-carto';
 export const V3_MINOR_VERSION = '3.4';
 export const MAX_GET_LENGTH = 8192;
-
-export const DEFAULT_PARAMETERS = {
-  v: V3_MINOR_VERSION,
-  deckglVersion: VERSION
-};
-
-export const DEFAULT_HEADERS = {
-  Accept: 'application/json',
-  'Content-Type': 'application/json'
-};

package/src/api/request-with-parameters.ts

@@ -1,37 +1,45 @@
+import {VERSION} from '@deck.gl/core';
 import {isPureObject} from '../utils';
 import {CartoAPIError} from './carto-api-error';
-import {DEFAULT_HEADERS, DEFAULT_PARAMETERS, MAX_GET_LENGTH} from './common';
+import {MAX_GET_LENGTH, V3_MINOR_VERSION} from './common';
 import type {APIErrorContext} from './types';
 
 /**
- * Simple encode parameter
+ * Parameters added to all requests issued with `requestWithParameters()`.
+ * These parameters override parameters already in the base URL, but not
+ * user-provided parameters.
  */
-function encodeParameter(name: string, value: unknown): string {
-  if (isPureObject(value) || Array.isArray(value)) {
-    return `${name}=${encodeURIComponent(JSON.stringify(value))}`;
-  }
-  return `${name}=${encodeURIComponent(value as string | boolean | number)}`;
-}
+const DEFAULT_PARAMETERS = {
+  v: V3_MINOR_VERSION,
+  deckglVersion: VERSION
+};
+
+const DEFAULT_HEADERS = {
+  Accept: 'application/json',
+  'Content-Type': 'application/json'
+};
 
 const REQUEST_CACHE = new Map<string, Promise<unknown>>();
+
 export async function requestWithParameters<T = any>({
   baseUrl,
-  parameters,
-  headers: customHeaders,
+  parameters = {},
+  headers: customHeaders = {},
   errorContext
 }: {
   baseUrl: string;
   parameters?: Record<string, unknown>;
-  headers: Record<string, string>;
+  headers?: Record<string, string>;
   errorContext: APIErrorContext;
 }): Promise<T> {
   parameters = {...DEFAULT_PARAMETERS, ...parameters};
-  const key = createCacheKey(baseUrl, parameters || {}, customHeaders || {});
+  baseUrl = excludeURLParameters(baseUrl, Object.keys(parameters));
+  const key = createCacheKey(baseUrl, parameters, customHeaders);
   if (REQUEST_CACHE.has(key)) {
     return REQUEST_CACHE.get(key) as Promise<T>;
   }
 
-  const url = parameters ? createURLWithParameters(baseUrl, parameters) : baseUrl;
+  const url = createURLWithParameters(baseUrl, parameters);
   const headers = {...DEFAULT_HEADERS, ...customHeaders};
 
   /* global fetch */
@@ -41,12 +49,14 @@ export async function requestWithParameters<T = any>({
       : fetch(url, {headers});
 
   let response: Response | undefined;
+  let responseJson;
   const jsonPromise: Promise<T> = fetchPromise
     .then((_response: Response) => {
       response = _response;
       return response.json();
     })
     .then((json: any) => {
+      responseJson = json;
       if (!response || !response.ok) {
         throw new Error(json.error);
       }
@@ -54,7 +64,7 @@ export async function requestWithParameters<T = any>({
     })
     .catch((error: Error) => {
       REQUEST_CACHE.delete(key);
-      throw new CartoAPIError(error, errorContext, response);
+      throw new CartoAPIError(error, errorContext, response, responseJson);
     });
 
   REQUEST_CACHE.set(key, jsonPromise);
@@ -71,9 +81,35 @@ function createCacheKey(
   return JSON.stringify({baseUrl, parameters: parameterEntries, headers: headerEntries});
 }
 
-function createURLWithParameters(baseUrl: string, parameters: Record<string, unknown>): string {
-  const encodedParameters = Object.entries(parameters).map(([key, value]) =>
-    encodeParameter(key, value)
-  );
-  return `${baseUrl}?${encodedParameters.join('&')}`;
+/**
+ * Appends query string parameters to a URL. Existing URL parameters are kept,
+ * unless there is a conflict, in which case the new parameters override
+ * those already in the URL.
+ */
+function createURLWithParameters(
+  baseUrlString: string,
+  parameters: Record<string, unknown>
+): string {
+  const baseUrl = new URL(baseUrlString);
+  for (const [key, value] of Object.entries(parameters)) {
+    if (isPureObject(value) || Array.isArray(value)) {
+      baseUrl.searchParams.set(key, JSON.stringify(value));
+    } else {
+      baseUrl.searchParams.set(key, (value as string | boolean | number).toString());
+    }
+  }
+  return baseUrl.toString();
+}
+
+/**
+ * Deletes query string parameters from a URL.
+ */
+function excludeURLParameters(baseUrlString: string, parameters: string[]) {
+  const baseUrl = new URL(baseUrlString);
+  for (const param of parameters) {
+    if (baseUrl.searchParams.has(param)) {
+      baseUrl.searchParams.delete(param);
+    }
+  }
+  return baseUrl.toString();
 }

package/src/api/types.ts

@@ -66,11 +66,11 @@ export interface Filters {
 }
 
 interface Filter {
-  [FilterTypes.In]: number[];
-  [FilterTypes.Between]: number[][];
-  [FilterTypes.ClosedOpen]: number[][];
-  [FilterTypes.Time]: number[][];
-  [FilterTypes.StringSearch]: string[];
+  [FilterTypes.In]?: number[];
+  [FilterTypes.Between]?: number[][];
+  [FilterTypes.ClosedOpen]?: number[][];
+  [FilterTypes.Time]?: number[][];
+  [FilterTypes.StringSearch]?: string[];
 }
 
 export enum FilterTypes {

package/src/layers/quadbin-heatmap-tile-layer.ts

@@ -80,7 +80,16 @@ class QuadbinHeatmapTileLayer<DataT = any, ExtraProps extends {} = {}> extends C
   static defaultProps = defaultProps;
 
   renderLayers(): Layer {
-    const {getWeight, colorDomain, colorRange, radiusPixels, _subLayerProps} = this.props;
+    const {
+      data,
+      getWeight,
+      colorDomain,
+      colorRange,
+      radiusPixels,
+      _subLayerProps,
+      updateTriggers,
+      ...tileLayerProps
+    } = this.props;
 
     // Inject modified polygon layer as sublayer into TileLayer
     const subLayerProps = {
@@ -103,9 +112,10 @@ class QuadbinHeatmapTileLayer<DataT = any, ExtraProps extends {} = {}> extends C
         : encodeWeight(getWeight);
 
     return new PostProcessQuadbinTileLayer(
+      tileLayerProps as Omit<QuadbinTileLayerProps, 'data'>,
       this.getSubLayerProps({
         id: 'heatmap',
-        data: this.props.data,
+        data,
 
         getFillColor,
 
@@ -115,7 +125,7 @@ class QuadbinHeatmapTileLayer<DataT = any, ExtraProps extends {} = {}> extends C
         _subLayerProps: subLayerProps,
 
         updateTriggers: {
-          getPosition: this.props.updateTriggers.getWeight
+          getPosition: updateTriggers.getWeight
         }
       })
     );

package/src/sources/raster-source.ts

@@ -1,12 +1,17 @@
 import {baseSource} from './base-source';
-import type {SourceOptions, TilejsonResult, TilesetSourceOptions} from './types';
+import type {FilterOptions, SourceOptions, TilejsonResult, TilesetSourceOptions} from './types';
 
-export type RasterSourceOptions = SourceOptions & TilesetSourceOptions;
-type UrlParameters = {name: string};
+export type RasterSourceOptions = SourceOptions & TilesetSourceOptions & FilterOptions;
+type UrlParameters = {
+  name: string;
+  filters?: Record<string, unknown>;
+};
 
 export const rasterSource = async function (options: RasterSourceOptions): Promise<TilejsonResult> {
-  const {tableName} = options;
+  const {tableName, filters} = options;
   const urlParameters: UrlParameters = {name: tableName};
-
+  if (filters) {
+    urlParameters.filters = filters;
+  }
   return baseSource<UrlParameters>('raster', options, urlParameters) as Promise<TilejsonResult>;
 };