Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

2.4 KB
Raw Blame
import * as Yup from "yup";

import type { FunctionSchema } from "embedding-sdk-bundle/types/schema";

import type { InteractiveQuestionInternalProps } from "./InteractiveQuestion";

const hasEntityProp = (
  props: InteractiveQuestionInternalProps | null | undefined,
) =>
  props != null &&
  (props.questionId !== undefined ||
    props.token !== undefined ||
    props.card !== undefined ||
    props.query !== undefined);

// Typed against the internal shape so runtime validation accepts both the
// public object `query` prop and the internal string `query` prop used by the
// `useMetabot` hook.
const propsSchema: Yup.SchemaOf<InteractiveQuestionInternalProps> = Yup.object({
  children: Yup.mixed().optional(),
  className: Yup.mixed().optional(),
  componentPlugins: Yup.object({
    mapQuestionClickActions: Yup.mixed().optional(),
    dashboard: Yup.mixed().optional(),
  })
    .optional()
    .noUnknown(),
  deserializedCard: Yup.mixed().optional(),
  entityTypes: Yup.mixed().optional(),
  dataPicker: Yup.mixed().optional(),
  height: Yup.mixed().optional(),
  initialSqlParameters: Yup.mixed().optional(),
  sqlParameters: Yup.mixed().optional(),
  onSqlParametersChange: Yup.mixed().optional(),
  hiddenParameters: Yup.mixed().optional(),
  isSaveEnabled: Yup.mixed().optional(),
  onBeforeSave: Yup.mixed().optional(),
  onNavigateBack: Yup.mixed().optional(),
  onRun: Yup.mixed().optional(),
  onSave: Yup.mixed().optional(),
  options: Yup.mixed().optional(),
  plugins: Yup.object({
    mapQuestionClickActions: Yup.mixed().optional(),
    dashboard: Yup.mixed().optional(),
  })
    .optional()
    .noUnknown(),
  questionId: Yup.mixed().optional(),
  token: Yup.mixed().optional(),
  card: Yup.mixed().optional(),
  query: Yup.mixed().optional(),
  style: Yup.mixed().optional(),
  targetCollection: Yup.mixed().optional(),
  initialCollection: Yup.mixed().optional(),
  targetDashboardId: Yup.mixed().optional(),
  title: Yup.mixed().optional(),
  width: Yup.mixed().optional(),
  withChartTypeSelector: Yup.mixed().optional(),
  withEditorButton: Yup.mixed().optional(),
  withDownloads: Yup.mixed().optional(),
  withAlerts: Yup.mixed().optional(),
  onDrillThrough: Yup.mixed().optional(),
  onVisualizationChange: Yup.mixed().optional(),
})
  .test(
    "has-entity-prop",
    "questionId, token, card, or query is required",
    hasEntityProp,
  )
  .noUnknown();

export const interactiveQuestionSchema: FunctionSchema = {
  input: [propsSchema],
};