@deck.gl/carto 8.8.3 → 8.8.4

package/package.json

@@ -2,7 +2,7 @@
   "name": "@deck.gl/carto",
   "description": "CARTO official integration with Deck.gl. Build geospatial applications using CARTO and Deck.gl.",
   "license": "MIT",
-  "version": "8.8.3",
+  "version": "8.8.4",
   "publishConfig": {
     "access": "public"
   },
@@ -32,12 +32,12 @@
     "prepublishOnly": "npm run build-bundle && npm run build-bundle -- --env.dev"
   },
   "dependencies": {
-    "@loaders.gl/gis": "^3.2.0",
-    "@loaders.gl/loader-utils": "^3.2.0",
-    "@loaders.gl/mvt": "^3.2.0",
-    "@loaders.gl/tiles": "^3.2.0",
-    "@luma.gl/constants": "^8.5.14",
-    "@math.gl/web-mercator": "^3.6.0",
+    "@loaders.gl/gis": "^3.2.5",
+    "@loaders.gl/loader-utils": "^3.2.5",
+    "@loaders.gl/mvt": "^3.2.5",
+    "@loaders.gl/tiles": "^3.2.5",
+    "@luma.gl/constants": "^8.5.16",
+    "@math.gl/web-mercator": "^3.6.2",
     "cartocolor": "^4.0.2",
     "d3-array": "^2.8.0",
     "d3-color": "^2.0.0",
@@ -48,7 +48,7 @@
     "pbf": "^3.2.1"
   },
   "devDependencies": {
-    "@loaders.gl/schema": "^3.2.0",
+    "@loaders.gl/schema": "^3.2.5",
     "@types/d3-array": "^3.0.2",
     "@types/d3-color": "^1.4.2",
     "@types/d3-scale": "^3.0.0"
@@ -61,5 +61,5 @@
     "@deck.gl/layers": "^8.0.0",
     "@loaders.gl/core": "^3.0.0"
   },
-  "gitHead": "e31e8c1885597eed40dcc404a5b3d05265995713"
+  "gitHead": "faab03adb63f2e2470d9c202dd740610be2ebc22"
 }

package/src/style/color-bins-style.ts

@@ -1,18 +1,40 @@
 import {scaleThreshold} from 'd3-scale';
+import {AccessorFunction} from '@deck.gl/core';
+import {Feature} from 'geojson';
 import getPalette, {Color, DEFAULT_PALETTE, NULL_COLOR} from './palette';
 import {assert, AttributeSelector, getAttrValue} from './utils';
 
-export default function colorBins({
+/**
+ * Helper function for quickly creating a color bins style based on `d3` `scaleThreshold`.
+ *
+ * Data values of each attribute are rounded down to the nearest value in the domain and are then
+ * styled with the corresponding color.
+ *
+ * @return accessor that maps objects to `Color` values
+ */
+export default function colorBins<DataT = Feature>({
   attr,
   domain,
   colors = DEFAULT_PALETTE,
   nullColor = NULL_COLOR
 }: {
-  attr: AttributeSelector;
+  /** Attribute or column to symbolize by. */
+  attr: AttributeSelector<DataT, number>;
+
+  /** Category list. Must be a valid list of categories. */
   domain: number[];
+
+  /**
+   * Color assigned to each domain value.
+   *
+   * Either Array of colors in RGBA or valid named CARTOColors palette.
+   * @default `PurpOr`
+   */
   colors?: string | Color[];
+
+  /** Color for null values. @default: [204, 204, 204] */
   nullColor?: Color;
-}): AttributeSelector {
+}): AccessorFunction<DataT, Color> {
   assert(Array.isArray(domain), 'Expected "domain" to be an array of numbers');
 
   const palette = typeof colors === 'string' ? getPalette(colors, domain.length + 1) : colors;

package/src/style/color-categories-style.ts

@@ -1,19 +1,43 @@
+import {AccessorFunction} from '@deck.gl/core';
+import {Feature} from 'geojson';
 import getPalette, {Color, DEFAULT_PALETTE, NULL_COLOR, OTHERS_COLOR} from './palette';
 import {assert, AttributeSelector, getAttrValue} from './utils';
 
-export default function colorCategories({
+/**
+ * Helper function for quickly creating a color category style.
+ *
+ * Data values of each attribute listed in the domain are mapped one to one
+ * with corresponding colors in the range.
+ *
+ * @return accessor that maps objects to `Color` values
+ */
+export default function colorCategories<DataT = Feature>({
   attr,
   domain,
   colors = DEFAULT_PALETTE,
   nullColor = NULL_COLOR,
   othersColor = OTHERS_COLOR
 }: {
-  attr: AttributeSelector;
-  domain: number[];
+  /** Attribute or column to symbolize by */
+  attr: string | AttributeSelector<DataT, number | string>;
+
+  /** Category list. Must be a valid list of categories. */
+  domain: number[] | string[];
+
+  /**
+   * Color assigned to each domain value.
+   *
+   * Either Array of colors in RGBA or valid named CARTOColors palette.
+   * @default `PurpOr`
+   */
   colors: string | Color[];
+
+  /** Color for null values. @default: [204, 204, 204] */
   nullColor?: Color;
+
+  /** Fallback color for a category not correctly assigned. @default: [119, 119, 119] */
   othersColor?: Color;
-}): AttributeSelector {
+}): AccessorFunction<DataT, Color> {
   assert(Array.isArray(domain), 'Expected "domain" to be an array of numbers or strings');
 
   const colorsByCategory = {};

package/src/style/color-continuous-style.ts

@@ -1,18 +1,40 @@
+import {AccessorFunction} from '@deck.gl/core';
 import {scaleLinear} from 'd3-scale';
+import {Feature} from 'geojson';
 import getPalette, {Color, DEFAULT_PALETTE, NULL_COLOR} from './palette';
 import {assert, AttributeSelector, getAttrValue} from './utils';
 
-export default function colorContinuous({
+/**
+ * Helper function for quickly creating a color continuous style.
+ *
+ * Data values of each field are interpolated linearly across values in the domain and
+ * are then styled with a blend of the corresponding color in the range.
+ *
+ * @return accessor that maps objects to `Color` values
+ */
+export default function colorContinuous<DataT = Feature>({
   attr,
   domain,
   colors = DEFAULT_PALETTE,
   nullColor = NULL_COLOR
 }: {
-  attr: AttributeSelector;
+  /** Attribute or column to symbolize by. */
+  attr: AttributeSelector<DataT, number>;
+
+  /** Attribute domain to define the data range. */
   domain: number[];
+
+  /**
+   * Color assigned to each domain value.
+   *
+   * Either Array of colors in RGBA or valid named CARTOColors palette.
+   * @default `PurpOr`
+   */
   colors?: string | Color[];
+
+  /** Color for null values. @default: [204, 204, 204]*/
   nullColor?: Color;
-}): AttributeSelector {
+}): AccessorFunction<DataT, Color> {
   assert(Array.isArray(domain), 'Expected "domain" to be an array of numbers');
 
   const palette = typeof colors === 'string' ? getPalette(colors, domain.length) : colors;

package/src/style/utils.ts

@@ -1,9 +1,13 @@
+import {Feature} from 'geojson';
+
 const ALLOWED_ATTR_TYPES = Object.freeze(['function', 'string']);
 
-type Row = {properties: Record<string, unknown>};
-export type AttributeSelector = string | ((d: Row) => unknown);
+export type AttributeSelector<DataT = Feature, OutT = any> = string | ((d: DataT) => OutT);
 
-export function getAttrValue(attr: AttributeSelector, d: Row): unknown {
+export function getAttrValue<DataT = Feature, OutT = any>(
+  attr: string | AttributeSelector<DataT, OutT>,
+  d: DataT
+): OutT {
   assert(typeof d === 'object', 'Expected "data" to be an object');
   assert(ALLOWED_ATTR_TYPES.includes(typeof attr), 'Expected "attr" to be a function or string');
 
@@ -11,7 +15,7 @@ export function getAttrValue(attr: AttributeSelector, d: Row): unknown {
   if (typeof attr === 'function') {
     return attr(d);
   }
-  return d.properties[attr];
+  return (d as unknown as Feature)?.properties?.[attr] as OutT;
 }
 
 export function assert(condition, message = ''): asserts condition {

package/typed/style/color-bins-style.d.ts

@@ -1,9 +1,28 @@
+import { AccessorFunction } from '@deck.gl/core/typed';
+import { Feature } from 'geojson';
 import { Color } from './palette';
 import { AttributeSelector } from './utils';
-export default function colorBins({ attr, domain, colors, nullColor }: {
-    attr: AttributeSelector;
+/**
+ * Helper function for quickly creating a color bins style based on `d3` `scaleThreshold`.
+ *
+ * Data values of each attribute are rounded down to the nearest value in the domain and are then
+ * styled with the corresponding color.
+ *
+ * @return accessor that maps objects to `Color` values
+ */
+export default function colorBins<DataT = Feature>({ attr, domain, colors, nullColor }: {
+    /** Attribute or column to symbolize by. */
+    attr: AttributeSelector<DataT, number>;
+    /** Category list. Must be a valid list of categories. */
     domain: number[];
+    /**
+     * Color assigned to each domain value.
+     *
+     * Either Array of colors in RGBA or valid named CARTOColors palette.
+     * @default `PurpOr`
+     */
     colors?: string | Color[];
+    /** Color for null values. @default: [204, 204, 204] */
     nullColor?: Color;
-}): AttributeSelector;
+}): AccessorFunction<DataT, Color>;
 //# sourceMappingURL=color-bins-style.d.ts.map

package/typed/style/color-bins-style.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"color-bins-style.d.ts","sourceRoot":"","sources":["../../src/style/color-bins-style.ts"],"names":[],"mappings":"AACA,OAAmB,EAAC,KAAK,EAA8B,MAAM,WAAW,CAAC;AACzE,OAAO,EAAS,iBAAiB,EAAe,MAAM,SAAS,CAAC;AAEhE,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,EAChC,IAAI,EACJ,MAAM,EACN,MAAwB,EACxB,SAAsB,EACvB,EAAE;IACD,IAAI,EAAE,iBAAiB,CAAC;IACxB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,EAAE,CAAC;IAC1B,SAAS,CAAC,EAAE,KAAK,CAAC;CACnB,GAAG,iBAAiB,CAWpB"}
+{"version":3,"file":"color-bins-style.d.ts","sourceRoot":"","sources":["../../src/style/color-bins-style.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,gBAAgB,EAAC,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAC,OAAO,EAAC,MAAM,SAAS,CAAC;AAChC,OAAmB,EAAC,KAAK,EAA8B,MAAM,WAAW,CAAC;AACzE,OAAO,EAAS,iBAAiB,EAAe,MAAM,SAAS,CAAC;AAEhE;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,KAAK,GAAG,OAAO,EAAE,EACjD,IAAI,EACJ,MAAM,EACN,MAAwB,EACxB,SAAsB,EACvB,EAAE;IACD,2CAA2C;IAC3C,IAAI,EAAE,iBAAiB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAEvC,yDAAyD;IACzD,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,EAAE,CAAC;IAE1B,uDAAuD;IACvD,SAAS,CAAC,EAAE,KAAK,CAAC;CACnB,GAAG,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,CAWjC"}

package/typed/style/color-categories-style.d.ts

@@ -1,10 +1,30 @@
+import { AccessorFunction } from '@deck.gl/core/typed';
+import { Feature } from 'geojson';
 import { Color } from './palette';
 import { AttributeSelector } from './utils';
-export default function colorCategories({ attr, domain, colors, nullColor, othersColor }: {
-    attr: AttributeSelector;
-    domain: number[];
+/**
+ * Helper function for quickly creating a color category style.
+ *
+ * Data values of each attribute listed in the domain are mapped one to one
+ * with corresponding colors in the range.
+ *
+ * @return accessor that maps objects to `Color` values
+ */
+export default function colorCategories<DataT = Feature>({ attr, domain, colors, nullColor, othersColor }: {
+    /** Attribute or column to symbolize by */
+    attr: string | AttributeSelector<DataT, number | string>;
+    /** Category list. Must be a valid list of categories. */
+    domain: number[] | string[];
+    /**
+     * Color assigned to each domain value.
+     *
+     * Either Array of colors in RGBA or valid named CARTOColors palette.
+     * @default `PurpOr`
+     */
     colors: string | Color[];
+    /** Color for null values. @default: [204, 204, 204] */
     nullColor?: Color;
+    /** Fallback color for a category not correctly assigned. @default: [119, 119, 119] */
     othersColor?: Color;
-}): AttributeSelector;
+}): AccessorFunction<DataT, Color>;
 //# sourceMappingURL=color-categories-style.d.ts.map

package/typed/style/color-categories-style.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"color-categories-style.d.ts","sourceRoot":"","sources":["../../src/style/color-categories-style.ts"],"names":[],"mappings":"AAAA,OAAmB,EAAC,KAAK,EAA4C,MAAM,WAAW,CAAC;AACvF,OAAO,EAAS,iBAAiB,EAAe,MAAM,SAAS,CAAC;AAEhE,MAAM,CAAC,OAAO,UAAU,eAAe,CAAC,EACtC,IAAI,EACJ,MAAM,EACN,MAAwB,EACxB,SAAsB,EACtB,WAA0B,EAC3B,EAAE;IACD,IAAI,EAAE,iBAAiB,CAAC;IACxB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,MAAM,EAAE,MAAM,GAAG,KAAK,EAAE,CAAC;IACzB,SAAS,CAAC,EAAE,KAAK,CAAC;IAClB,WAAW,CAAC,EAAE,KAAK,CAAC;CACrB,GAAG,iBAAiB,CAgBpB"}
+{"version":3,"file":"color-categories-style.d.ts","sourceRoot":"","sources":["../../src/style/color-categories-style.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,gBAAgB,EAAC,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAC,OAAO,EAAC,MAAM,SAAS,CAAC;AAChC,OAAmB,EAAC,KAAK,EAA4C,MAAM,WAAW,CAAC;AACvF,OAAO,EAAS,iBAAiB,EAAe,MAAM,SAAS,CAAC;AAEhE;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,eAAe,CAAC,KAAK,GAAG,OAAO,EAAE,EACvD,IAAI,EACJ,MAAM,EACN,MAAwB,EACxB,SAAsB,EACtB,WAA0B,EAC3B,EAAE;IACD,0CAA0C;IAC1C,IAAI,EAAE,MAAM,GAAG,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IAEzD,yDAAyD;IACzD,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IAE5B;;;;;OAKG;IACH,MAAM,EAAE,MAAM,GAAG,KAAK,EAAE,CAAC;IAEzB,uDAAuD;IACvD,SAAS,CAAC,EAAE,KAAK,CAAC;IAElB,sFAAsF;IACtF,WAAW,CAAC,EAAE,KAAK,CAAC;CACrB,GAAG,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,CAgBjC"}

package/typed/style/color-continuous-style.d.ts

@@ -1,9 +1,28 @@
+import { AccessorFunction } from '@deck.gl/core/typed';
+import { Feature } from 'geojson';
 import { Color } from './palette';
 import { AttributeSelector } from './utils';
-export default function colorContinuous({ attr, domain, colors, nullColor }: {
-    attr: AttributeSelector;
+/**
+ * Helper function for quickly creating a color continuous style.
+ *
+ * Data values of each field are interpolated linearly across values in the domain and
+ * are then styled with a blend of the corresponding color in the range.
+ *
+ * @return accessor that maps objects to `Color` values
+ */
+export default function colorContinuous<DataT = Feature>({ attr, domain, colors, nullColor }: {
+    /** Attribute or column to symbolize by. */
+    attr: AttributeSelector<DataT, number>;
+    /** Attribute domain to define the data range. */
     domain: number[];
+    /**
+     * Color assigned to each domain value.
+     *
+     * Either Array of colors in RGBA or valid named CARTOColors palette.
+     * @default `PurpOr`
+     */
     colors?: string | Color[];
+    /** Color for null values. @default: [204, 204, 204]*/
     nullColor?: Color;
-}): AttributeSelector;
+}): AccessorFunction<DataT, Color>;
 //# sourceMappingURL=color-continuous-style.d.ts.map

package/typed/style/color-continuous-style.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"color-continuous-style.d.ts","sourceRoot":"","sources":["../../src/style/color-continuous-style.ts"],"names":[],"mappings":"AACA,OAAmB,EAAC,KAAK,EAA8B,MAAM,WAAW,CAAC;AACzE,OAAO,EAAS,iBAAiB,EAAe,MAAM,SAAS,CAAC;AAEhE,MAAM,CAAC,OAAO,UAAU,eAAe,CAAC,EACtC,IAAI,EACJ,MAAM,EACN,MAAwB,EACxB,SAAsB,EACvB,EAAE;IACD,IAAI,EAAE,iBAAiB,CAAC;IACxB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,EAAE,CAAC;IAC1B,SAAS,CAAC,EAAE,KAAK,CAAC;CACnB,GAAG,iBAAiB,CAUpB"}
+{"version":3,"file":"color-continuous-style.d.ts","sourceRoot":"","sources":["../../src/style/color-continuous-style.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,gBAAgB,EAAC,MAAM,eAAe,CAAC;AAE/C,OAAO,EAAC,OAAO,EAAC,MAAM,SAAS,CAAC;AAChC,OAAmB,EAAC,KAAK,EAA8B,MAAM,WAAW,CAAC;AACzE,OAAO,EAAS,iBAAiB,EAAe,MAAM,SAAS,CAAC;AAEhE;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,eAAe,CAAC,KAAK,GAAG,OAAO,EAAE,EACvD,IAAI,EACJ,MAAM,EACN,MAAwB,EACxB,SAAsB,EACvB,EAAE;IACD,2CAA2C;IAC3C,IAAI,EAAE,iBAAiB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAEvC,iDAAiD;IACjD,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,EAAE,CAAC;IAE1B,sDAAsD;IACtD,SAAS,CAAC,EAAE,KAAK,CAAC;CACnB,GAAG,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,CAUjC"}

package/typed/style/utils.d.ts

@@ -1,8 +1,5 @@
-declare type Row = {
-    properties: Record<string, unknown>;
-};
-export declare type AttributeSelector = string | ((d: Row) => unknown);
-export declare function getAttrValue(attr: AttributeSelector, d: Row): unknown;
+import { Feature } from 'geojson';
+export declare type AttributeSelector<DataT = Feature, OutT = any> = string | ((d: DataT) => OutT);
+export declare function getAttrValue<DataT = Feature, OutT = any>(attr: string | AttributeSelector<DataT, OutT>, d: DataT): OutT;
 export declare function assert(condition: any, message?: string): asserts condition;
-export {};
 //# sourceMappingURL=utils.d.ts.map

package/typed/style/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/style/utils.ts"],"names":[],"mappings":"AAEA,aAAK,GAAG,GAAG;IAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAC,CAAC;AACjD,oBAAY,iBAAiB,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC,CAAC;AAE/D,wBAAgB,YAAY,CAAC,IAAI,EAAE,iBAAiB,EAAE,CAAC,EAAE,GAAG,GAAG,OAAO,CASrE;AAED,wBAAgB,MAAM,CAAC,SAAS,KAAA,EAAE,OAAO,SAAK,GAAG,OAAO,CAAC,SAAS,CAIjE"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/style/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAC,MAAM,SAAS,CAAC;AAIhC,oBAAY,iBAAiB,CAAC,KAAK,GAAG,OAAO,EAAE,IAAI,GAAG,GAAG,IAAI,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,IAAI,CAAC,CAAC;AAE3F,wBAAgB,YAAY,CAAC,KAAK,GAAG,OAAO,EAAE,IAAI,GAAG,GAAG,EACtD,IAAI,EAAE,MAAM,GAAG,iBAAiB,CAAC,KAAK,EAAE,IAAI,CAAC,EAC7C,CAAC,EAAE,KAAK,GACP,IAAI,CASN;AAED,wBAAgB,MAAM,CAAC,SAAS,KAAA,EAAE,OAAO,SAAK,GAAG,OAAO,CAAC,SAAS,CAIjE"}