add zod schemas

Signed-off-by: Shan He <[email protected]>

Author: heshan0131

src/schemas/package.json

@@ -42,7 +42,8 @@
     "apache-arrow": ">=15.0.0",
     "global": "^4.3.0",
     "keymirror": "^0.1.1",
-    "lodash": "4.17.21"
+    "lodash": "4.17.21",
+    "zod": "^3.24.2"
   },
   "nyc": {
     "sourceMap": false,

src/schemas/src/animation.ts

@@ -0,0 +1,77 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import {z} from 'zod';
+
+import {TimeRangeFilterSchema} from './filter';
+
+export const AnimationTimeFormat = z.enum(['L', 'L LT', 'L LTS']);
+export type AnimationTimeFormat = z.infer<typeof AnimationTimeFormat>;
+
+export const AnimationConfigSchema = z.preprocess(
+  (config: any) => {
+    // Remove null values so they are not saved and don't show up in the editors
+    if (config?.timeFormat === null) {
+      config = {...config};
+      delete config.timeFormat;
+    }
+    if (config?.timezone === null) {
+      config = {...config};
+      delete config.timezone;
+    }
+    return config;
+  },
+  z.object({
+    currentTime: z
+      .number()
+      .nullable()
+      .optional()
+      .describe('The current time of the animation in epoch milliseconds'),
+    speed: z
+      .number()
+      .min(0)
+      .max(10)
+      .default(1)
+      .describe('The speed of the animation, a number between 0 and 10'),
+    domain: z
+      .tuple([z.number(), z.number()])
+      .optional()
+      .describe(
+        'Override the time domain of the animation (in epoch milliseconds). ' +
+          'By default the domain is calculated from the data.'
+      ),
+    timeFormat: AnimationTimeFormat.optional().describe(
+      'The format for displaying the animation time ' +
+        'For the syntax check "Locale aware formats" here: https://momentjs.com/docs/#/parsing/string-format/'
+    ),
+    timezone: z
+      .string()
+      .optional()
+      .describe(
+        'The timezone for displaying the animation time e.g. "America/New_York"' +
+          'For the list of timezones check here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones'
+      )
+  })
+);
+export type AnimationConfigSchema = z.infer<typeof AnimationConfigSchema>;
+
+export const SyncTimelineMode = z.enum(['start', 'end']);
+export type SyncTimelineMode = z.infer<typeof SyncTimelineMode>;
+
+/**
+ * Subset of TimeRangeFilterSchema that is used for filter animation config JSON editor
+ */
+export const FilterAnimationSchema = TimeRangeFilterSchema.pick({
+  dataId: true,
+  value: true,
+  animationWindow: true,
+  speed: true,
+  syncedWithLayerTimeline: true,
+  syncTimelineMode: true,
+  timezone: true
+}).required({
+  dataId: true,
+  animationWindow: true
+});
+
+export type FilterAnimationSchema = z.infer<typeof FilterAnimationSchema>;

src/schemas/src/color.ts

@@ -0,0 +1,83 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import {z} from 'zod';
+
+const RGBColorComponent = z.number().min(0).max(255);
+
+export const RGBColorSchema = z.union([
+  z.tuple([RGBColorComponent, RGBColorComponent, RGBColorComponent]),
+  z.tuple([RGBColorComponent, RGBColorComponent, RGBColorComponent, RGBColorComponent])
+]);
+export type RGBColorSchema = z.infer<typeof RGBColorSchema>;
+
+export const HexColorSchema = z.coerce.string();
+export type HexColorSchema = z.infer<typeof HexColorSchema>;
+
+export const ColorMapSchema = z.array(
+  z.tuple([z.union([z.string(), z.number(), z.null(), z.array(z.coerce.string())]), HexColorSchema])
+);
+export type ColorMapSchema = z.infer<typeof ColorMapSchema>;
+
+export const ColorLegendsSchema = z.record(z.string(), z.string());
+export type ColorLegendsSchema = z.infer<typeof ColorLegendsSchema>;
+
+export enum ColorRangeType {
+  sequential = 'sequential',
+  qualitative = 'qualitative',
+  diverging = 'diverging',
+  cyclical = 'cyclical',
+  custom = 'custom',
+  ordinal = 'ordinal',
+  customOrdinal = 'customOrdinal'
+}
+
+export const ColorRangeTypeZod = z.preprocess((type: any) => {
+  if (type === 'singlehue') {
+    type = ColorRangeType.sequential;
+  }
+  return type;
+}, z.nativeEnum(ColorRangeType).default(ColorRangeType.sequential));
+export type ColorRangeTypeZod = z.infer<typeof ColorRangeTypeZod>;
+
+const COLOR_RANGE_TYPES = Object.values(ColorRangeType).join(', ');
+const COLOR_RANGE_TYPE_DESC = `The type of the color range. Must be one of: ${COLOR_RANGE_TYPES}`;
+
+export const ColorRangeSchema = z.preprocess(
+  (colorRange: any) => {
+    let next = colorRange;
+    if (colorRange.colorMap === null) {
+      next = {...next};
+      delete next.colorMap;
+    }
+    return next;
+  },
+  z.object({
+    name: z.string().describe('The name of the color range.').default('Unnamed'),
+    type: ColorRangeTypeZod.describe(COLOR_RANGE_TYPE_DESC),
+    category: z.string().default('Unnamed'),
+    colors: z.array(HexColorSchema),
+    reversed: z.boolean().optional(),
+    colorMap: ColorMapSchema.optional(),
+    colorLegends: ColorLegendsSchema.optional()
+  })
+);
+export type ColorRangeSchema = z.infer<typeof ColorRangeSchema>;
+
+export const DEFAULT_COLOR_RANGE: ColorRangeSchema = {
+  name: 'Uber Viz Qualitative',
+  type: ColorRangeType.qualitative,
+  category: 'Uber',
+  colors: [
+    '#12939A',
+    '#DDB27C',
+    '#88572C',
+    '#FF991F',
+    '#F15C17',
+    '#223F9A',
+    '#DA70BF',
+    '#125C77',
+    '#4DC19C',
+    '#776E57'
+  ]
+};

src/schemas/src/common.ts

@@ -0,0 +1,44 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import {z} from 'zod';
+
+const TIME_INTERVALS_KEYS = [
+  'year',
+  'month',
+  'week',
+  'day',
+  'hour',
+  'minute',
+  'second',
+  'millisecond'
+] as const;
+
+export const TIME_INTERVAL_REGEX = new RegExp(`^([0-9]+)-(${TIME_INTERVALS_KEYS.join('|')})$`);
+
+export const TIME_INTERVAL_DESC =
+  `Should be in the form (number)-(interval), where interval is one of: ` +
+  `${TIME_INTERVALS_KEYS.join(', ')}, e.g 1-day, 2-week, 3-month, 4-year`;
+
+export const TimeIntervalSchema = z.string().regex(TIME_INTERVAL_REGEX);
+
+export enum AggregationKey {
+  COUNT = 'COUNT',
+  SUM = 'SUM',
+  MEAN = 'MEAN',
+  MAX = 'MAX',
+  MIN = 'MIN',
+  DEVIATION = 'DEVIATION',
+  VARIANCE = 'VARIANCE',
+  MEDIAN = 'MEDIAN',
+  P05 = 'P05',
+  P25 = 'P25',
+  P50 = 'P50',
+  P75 = 'P75',
+  P95 = 'P95',
+  MODE = 'MODE',
+  UNIQUE = 'UNIQUE',
+  MERGE = 'MERGE'
+}
+export const AggregationKeySchema = z.nativeEnum(AggregationKey);
+export type AggregationKeySchema = z.infer<typeof AggregationKeySchema>;