@kepler.gl/types - npm Package Compare versions

Comparing version 3.0.0-alpha.1 to 3.0.0-alpha.2

actions.d.ts

@@ -0,1 +1,4 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
 import {SavedMap, ParsedConfig, SavedConfigV1, MinSavedConfigV1} from './schemas';
@@ -45,5 +48,7 @@
       displayName?: string;
+      analyzerType?: string;
       id?: string;
     }[];
     rows: any[][];
+    cols?: any[];
   };
@@ -50,0 +55,0 @@

components.d.ts

@@ -0,1 +1,4 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
 export type TimeLabelFormat = {
@@ -2,0 +5,0 @@ id: string;

effects.d.ts

@@ -1,29 +0,49 @@
-export type EffectConfig = {
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+type EffectParameterDescription = {
+  name: string;
+  type?: 'number' | 'array' | 'color';
+  label?: string | false | (string | false)[];
+  min: number;
+  max: number;
+  defaultValue?: number | number[];
+};
+
+export type EffectDescription = {
   type: string;
   name: string;
+  parameters: EffectParameterDescription[];
+};
+
+export type EffectUpdateProps = {
   isEnabled: boolean;
   isConfigActive: boolean;
-  // effect specific params for a deck.gl effect (uniforms)
-  params: {[key: string]: any};
+  isJsonEditorActive: boolean;
+  // effect specific parameters for a deck.gl effect (uniforms)
+  parameters: {[key: string]: any};
 };
 
-export type EffectParams = {
+export type EffectProps = EffectUpdateProps & {
   id: string;
-  config: EffectConfig;
+  type: string;
 };
 
-export type EffectParamsPartial = {
-  id?: string;
-  config?: Partial<EffectConfig>
-};
+export type EffectPropsPartial = Partial<EffectProps>;
 
 export interface Effect {
   id: string;
-  config: EffectConfig;
+  type: string;
+  isEnabled: boolean;
+  isConfigActive: boolean;
+  isJsonEditorActive: boolean;
+  // effect specific parameters for a deck.gl effect (uniforms)
+  parameters: {[key: string]: any};
   deckEffect: any;
+  _uiConfig: EffectParameterDescription[];
 
-  getDefaultEffectConfig(config: Partial<EffectConfig>): EffectConfig;
-  updateConfig(config: Partial<EffectConfig>): void;
+  getDefaultProps(props: Partial<EffectProps>): EffectProps;
+  setProps(props: Partial<EffectProps>): void;
   isValidToSave(): boolean;
-  get type(): string;
+  getParameterDescriptions(): EffectParameterDescription[];
 }

index.d.ts

@@ -0,1 +1,4 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
 export * from './layers';
@@ -2,0 +5,0 @@ export * from './reducers';

layers.d.ts

@@ -0,1 +1,4 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
 export type LayerBaseConfig = {
@@ -2,0 +5,0 @@ dataId: string | null;

package.json

 {
   "name": "@kepler.gl/types",
   "author": "Shan He <[e-mail]>",
-  "version": "3.0.0-alpha.1",
+  "version": "3.0.0-alpha.2",
   "description": "kepler.gl types used by kepler.gl components, actions and reducers",
@@ -29,3 +29,3 @@ "license": "MIT",
   "engines": {
-    "node": ">=14.21.1"
+    "node": ">=18.18.2"
   },
@@ -37,5 +37,5 @@ "maintainers": [
   "volta": {
-    "node": "14.21.1",
+    "node": "18.18.2",
     "yarn": "1.22.17"
   }
 }

reducers.d.ts

@@ -0,1 +1,4 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
 import {Field, Millisecond} from './types';
@@ -198,2 +201,3 @@
 export type SplitMap = {
+  id?: string;
   layers: SplitMapLayers;
@@ -200,0 +204,0 @@ };

schemas.d.ts

@@ -0,1 +1,4 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
 import {RGBColor, Merge, RGBAColor, RequireFrom} from './types';
@@ -14,4 +17,2 @@
 
-import {EffectConfig} from './effects';
-
 export type SavedFilter = {
@@ -86,5 +87,9 @@ dataId: Filter['dataId'];
   id: string;
-  config: EffectConfig;
+  type: string;
+  isEnabled: boolean;
+  parameters: Record<string, number | [number, number] | {value: number}>;
 };
 
+export type SavedEffect = ParsedEffect;
+
 export type SavedAnimationConfig = {
@@ -103,2 +108,3 @@ currentTime: AnimationConfig['currentTime'];
   layers: SavedLayer[];
+  effects: SavedEffect[];
   interactionConfig: SavedInteractionConfig;
@@ -116,2 +122,3 @@ layerBlending: string;
   layers?: MinSavedLayer[];
+  effects?: SavedEffect[];
   interactionConfig?: Partial<SavedInteractionConfig>;
@@ -129,2 +136,3 @@ layerBlending?: string;
   filters?: ParsedFilter[];
+  effects?: ParsedEffect[];
   interactionConfig?: Partial<SavedInteractionConfig>;
@@ -131,0 +139,0 @@ layerBlending?: string;

types.d.ts

@@ -0,1 +1,4 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
 export type RGBColor = [number, number, number];
@@ -26,2 +29,8 @@ export type RGBAColor = [number, number, number, number];
 
-export type ProcessorResult = {fields: Field[]; rows: any[][]} | null;
+export type ProcessorResult = {
+  info?: any;
+  fields: Field[];
+  rows: any[][];
+  cols?: any[];
+  metadata?: any;
+} | null;

No alert changes

Improved metrics

Total package byte prevSize

30116

increased by5.27%

Lines of code

1141

increased by4.11%

No dependency changes