@kepler.gl/types - npm Package Compare versions

Comparing version 3.0.0 to 3.1.0-alpha.0

actions.d.ts

@@ -34,2 +34,11 @@ // SPDX-License-Identifier: MIT
  */
+export type ProtoDatasetField = {
+  name: string;
+  type: string;
+  format?: string;
+  displayName?: string;
+  analyzerType?: string;
+  id?: string;
+  metadata?: Record<string, any>;
+};
 export type ProtoDataset = {
@@ -42,12 +51,6 @@ info: {
     type?: string;
+    hidden?: boolean;
   };
   data: {
-    fields: {
-      name: string;
-      type?: string;
-      format?: string;
-      displayName?: string;
-      analyzerType?: string;
-      id?: string;
-    }[];
+    fields: ProtoDatasetField[];
     rows: any[][];
@@ -54,0 +57,0 @@ cols?: any[];

layers.d.ts

@@ -24,6 +24,43 @@ // SPDX-License-Identifier: MIT
     enabled: boolean;
-    domain?: null;
+    domain?: [number, number] | null;
   };
+
+  columnMode?: string;
 };
 
+/**
+ * Used to configure geospatial data source columns like Longitude, Latitude, Geojson.
+ */
+export type LayerColumn = {value: string | null; fieldIdx: number; optional?: boolean};
+export type LayerConfigColumn = LayerColumn;
+
+export type LayerColumns = {
+  [key: string]: LayerConfigColumn;
+};
+
+export type ColumnPair = {
+  pair: string | string[];
+  fieldPairKey: string | string[];
+};
+
+export type ColumnPairs = {[key: string]: ColumnPair};
+
+export type ColumnLabels = {
+  [key: string]: string;
+};
+
+export type EnhancedFieldPair = {
+  name: string;
+  type: 'point';
+  pair: FieldPair['pair'];
+};
+
+export type SupportedColumnMode = {
+  key: string;
+  label: string;
+  requiredColumns: string[];
+  optionalColumns?: string[];
+  hasHelp?: boolean;
+};
+
 export type LayerColorConfig = {
@@ -65,12 +102,12 @@ colorField: VisualChannelField;
 export type Field = {
-  analyzerType: string;
-  id?: string;
   name: string;
   displayName: string;
-  format: string;
   type: string;
   fieldIdx: number;
   valueAccessor(v: {index: number}): any;
-  filterProps?: any;
-  metadata?: any;
+  analyzerType?: string;
+  id?: string;
+  format: string;
+  filterProps?: FilterProps;
+  metadata?: Record<string, any>;
   displayFormat?: string;
@@ -82,6 +119,14 @@ };
   pair: {
-    [key: string]: {
+    lat: {
       fieldIdx: number;
       value: string;
     };
+    lng: {
+      fieldIdx: number;
+      value: string;
+    };
+    altitude?: {
+      fieldIdx: number;
+      value: string;
+    };
   };
@@ -91,2 +136,4 @@ suffix: string[];
 
+export type SizeRange = [number, number];
+
 export type LayerTextLabel = {
@@ -112,2 +159,4 @@ field: Field | null;
   showDropdown: boolean | number;
+  // show color scale chart
+  showColorChart: boolean;
   // color range selector config
@@ -119,2 +168,3 @@ colorRangeConfig: {
     custom: boolean;
+    customBreaks: boolean;
   };
@@ -151,3 +201,3 @@ };
   defaultValue: number;
-  range: [number, number];
+  range: SizeRange;
   step: number;
@@ -170,4 +220,4 @@ };
   isRanged: boolean;
-  range: [number, number];
-  defaultValue: [number, number];
+  range: SizeRange;
+  defaultValue: SizeRange;
   step: number;
@@ -190,2 +240,4 @@ };
   trailLength: VisConfigNumber;
+  fadeTrail: VisConfigBoolean;
+  billboard: VisConfigBoolean;
   radius: VisConfigNumber;
@@ -225,2 +277,6 @@ fixedRadius: VisConfigBoolean;
   darkBaseMapEnabled: VisConfigBoolean;
+  fixedHeight: VisConfigBoolean;
+  allowHover: VisConfigBoolean;
+  showNeighborOnHover: VisConfigBoolean;
+  showHighlightColor: VisConfigBoolean;
 };
@@ -275,2 +331,3 @@
 };
+
 export type TextConfigNumber = {
@@ -285,2 +342,3 @@ type: 'number';
 };
+
 export type LayerTextConfig = {
@@ -287,0 +345,0 @@ fontSize: TextConfigNumber;

package.json

 {
   "name": "@kepler.gl/types",
   "author": "Shan He <[e-mail]>",
-  "version": "3.0.0",
+  "version": "3.1.0-alpha.0",
   "description": "kepler.gl types used by kepler.gl components, actions and reducers",
@@ -28,5 +28,2 @@ "license": "MIT",
   },
-  "engines": {
-    "node": ">=18.18.2"
-  },
   "maintainers": [
@@ -36,6 +33,10 @@ "Shan He <[e-mail]>",
   ],
+  "engines": {
+    "node": ">=18"
+  },
   "volta": {
     "node": "18.18.2",
-    "yarn": "1.22.17"
-  }
+    "yarn": "4.4.0"
+  },
+  "packageManager": "yarn@4.4.0"
 }

reducers.d.ts

@@ -5,2 +5,3 @@ // SPDX-License-Identifier: MIT
 import {Field, Millisecond} from './types';
+import type {MapViewState} from '@deck.gl/core/typed';
 
@@ -35,17 +36,10 @@ export type MapState = {
 
-export type HistogramBin = {
-  x0: number | undefined;
-  x1: number | undefined;
-  count: number;
-};
-
 export type RangeFieldDomain = {
-  domain: [number, number];
+  domain: number[];
   step: number;
-  histogram: HistogramBin[];
-  enlargedHistogram: HistogramBin[];
+  bins?: Bins;
 };
 
 export type SelectFieldDomain = {
-  domain: [true, false];
+  domain: boolean[];
 };
@@ -59,4 +53,3 @@ export type MultiSelectFieldDomain = {
   step: number;
-  histogram: HistogramBin[];
-  enlargedHistogram: HistogramBin[];
+  timeBins?: TimeBins;
   mappedValue: (Millisecond | null)[];
@@ -76,6 +69,18 @@ // auto generated based on time domain
 
+export interface LineDatum {
+  x: number;
+  y: number;
+  delta: string;
+  pct: number | null;
+}
+
 export type LineChart = {
   series: {x: number; y: number}[];
-  yDomain: [number, number];
-  xDomain: [number, number];
+  yDomain: number[] | undefined[];
+  xDomain: number[];
+
+  // Is this a valid part of LineChart?
+  aggregation: string;
+  interval: string;
+  yAxis: string;
 };
@@ -90,4 +95,2 @@
 
-  freeze: boolean;
-
   // time range filter specific
@@ -110,3 +113,5 @@ fixedDomain: boolean;
   yAxis: Field | null;
-  plotType: string;
+  plotType: {
+    [key: string]: any;
+  };
   lineChart?: L;
@@ -129,2 +134,5 @@ // gpu filter
     typeOptions: ['range'];
+    plotType: {
+      [key: string]: any;
+    };
   };
@@ -146,2 +154,4 @@
 
+export type SyncTimelineMode = 0 | 1;
+
 export type TimeRangeFilter = FilterBase<LineChart> &
@@ -151,9 +161,11 @@ TimeRangeFieldDomain & {
     fieldType: 'timestamp';
-    fixedDomain: true;
+    fixedDomain: boolean;
     value: [number, number];
-    bins?: Object;
     plotType: {
       [key: string]: any;
     };
+    syncedWithLayerTimeline: boolean;
+    syncTimelineMode: SyncTimelineMode;
     animationWindow: string;
+    invertTrendColor: boolean;
   };
@@ -176,2 +188,27 @@
 
+export interface Bin {
+  count: number;
+  indexes: number[];
+  x0: number;
+  x1: number;
+}
+
+export interface Bins {
+  [dataId: string]: Bin[];
+}
+
+export interface TimeBins {
+  [dataId: string]: {
+    [interval: string]: Bin[];
+  };
+}
+
+export interface PlotType {
+  interval: ValueOf<Interval>;
+  type: ValueOf<PlotTypes>;
+  aggregation: ValueOf<AggregationTypes>;
+  defaultTimeFormat: string;
+  colorsByDataId?: {[dataId: string]: string};
+}
+
 export type Feature = {
@@ -219,3 +256,3 @@ id: string;
 export type AnimationConfig = {
-  domain: number[] | null;
+  domain: [number, number] | null;
   currentTime: number | null;
@@ -225,3 +262,3 @@ speed: number;
   isAnimating?: boolean;
-  timeSteps?: null | number[];
+  timeSteps: number[] | null;
   // auto generated based on time domain
@@ -325,3 +362,3 @@ defaultTimeFormat: AnimationTimeFormat | null;
   icon: string;
-  style?: Object;
+  style?: object;
   layerGroups: LayerGroup[];
@@ -379,5 +416,8 @@ accessToken?: string;
 };
+export type MapControlMapLegend = MapControlItem & {
+  disableEdit?: boolean;
+};
 export type MapControls = {
   visibleLayers?: MapControlItem;
-  mapLegend?: MapControlItem;
+  mapLegend?: MapControlMapLegend;
   toggle3d?: MapControlItem;
@@ -388,2 +428,3 @@ splitMap?: MapControlItem;
   effect?: MapControlItem;
+  aiAssistant?: MapControlItem;
 };
@@ -460,2 +501,6 @@
   maxBounds?: Bounds;
+  /** viewport transition duration use by geocoder panel **/
+  transitionDuration?: MapViewState['transitionDuration'];
+  /** viewport transition duration use by geocoder panel **/
+  transitionInterpolator?: MapViewState['transitionInterpolator'];
 };
@@ -531,3 +576,2 @@
     value: [number, number];
-    bins?: Object;
     plotType: {
@@ -537,2 +581,3 @@ [key: string]: any;
     animationWindow: string;
+    invertTrendColor: boolean;
   };
@@ -539,0 +584,0 @@

schemas.d.ts

 // SPDX-License-Identifier: MIT
 // Copyright contributors to the kepler.gl project
 
-import {RGBColor, Merge, RGBAColor, RequireFrom} from './types';
+import {RGBColor, Merge, RequireFrom} from './types';
 
-import {
-  Filter,
-  TooltipInfo,
-  InteractionConfig,
-  AnimationConfig,
-  SplitMap,
-  Feature
-} from './reducers';
+import {Filter, TooltipInfo, AnimationConfig, SplitMap, Feature} from './reducers';
 
@@ -33,2 +26,4 @@ import {LayerTextLabel} from './layers';
   layerId: Filter['layerId'];
+  syncedWithLayerTimeline: Filter['syncedWithLayerTimeline'];
+  syncTimelineMode: Filter['syncTimelineMode'];
 };
@@ -73,2 +68,3 @@ export type MinSavedFilter = RequireFrom<SavedFilter, 'dataId' | 'id' | 'name' | 'type' | 'value'>;
     textLabel: Merge<LayerTextLabel, {field: {name: string; type: string} | null}>;
+    columnMode: string;
   };
@@ -75,0 +71,0 @@ visualChannels: SavedVisualChannels;

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

32625

increased by8.36%

Lines of code

1227

increased by7.54%

Worsened metrics

Number of low quality alerts

2

increased by100%

No dependency changes