Skip to content

A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.

5.7 KB
Raw Blame
/* Copyright 2026 Marimo. All rights reserved. */

import { zodResolver } from "@hookform/resolvers/zod";
import { useAtomValue } from "jotai";
import React from "react";
import { type DefaultValues, type FieldValues, useForm } from "react-hook-form";
import type { z } from "zod";
import { type FormRenderer, ZodForm } from "@/components/forms/form";
import { getDefaults } from "@/components/forms/form-utils";
import { Button } from "@/components/ui/button";
import { FormErrorsBanner } from "@/components/ui/form";
import {
  Select,
  SelectContent,
  SelectGroup,
  SelectItem,
  SelectTrigger,
  SelectValue,
} from "@/components/ui/select";
import { maybeAddMarimoImport } from "@/core/cells/add-missing-import";
import { useCellActions } from "@/core/cells/actions";
import { useLastFocusedCellId } from "@/core/cells/focus";
import { autoInstantiateAtom } from "@/core/config/config";
import type { DetectedDataSource } from "@/core/datasets/data-source-discovery";
import {
  ENV_RENDERER,
  SECRET_TEXTAREA_RENDERER,
  SecretsProvider,
} from "./form-renderers";

const RENDERERS: FormRenderer[] = [ENV_RENDERER, SECRET_TEXTAREA_RENDERER];

/**
 * Grid layout for provider/database selector buttons.
 */
export const SelectorGrid: React.FC<{ children: React.ReactNode }> = ({
  children,
}) => <div className="grid grid-cols-2 md:grid-cols-3 gap-4">{children}</div>;

/**
 * A colored button tile for selecting a provider/database.
 */
export const SelectorButton: React.FC<{
  name: string;
  color: string;
  icon: React.ReactNode;
  onSelect: () => void;
}> = ({ name, color, icon, onSelect }) => (
  <button
    type="button"
    className="py-3 flex flex-col items-center justify-center gap-1 transition-[scale,filter,box-shadow] hover:scale-105 hover:brightness-110 rounded shadow-sm-solid hover:shadow-md-solid"
    style={{ backgroundColor: color }}
    onClick={onSelect}
  >
    {icon}
    <span className="text-white font-medium text-lg">{name}</span>
  </button>
);

/**
 * Footer with Back/Add buttons and a library picker.
 */
export const ConnectionFormFooter = <L extends string>({
  onBack,
  isValid,
  libraries,
  preferredLibrary,
  onLibraryChange,
  displayNames,
  libraryLabel = "Preferred library",
}: {
  onBack: () => void;
  isValid: boolean;
  libraries: L[];
  preferredLibrary: L;
  onLibraryChange: (library: L) => void;
  displayNames: Record<L, string>;
  libraryLabel?: string;
}) => (
  <div className="flex gap-2 justify-between">
    <div className="flex gap-2">
      <Button type="button" variant="outline" onClick={onBack}>
        Back
      </Button>
      <Button type="submit" disabled={!isValid}>
        Add
      </Button>
    </div>
    <div>
      <Select value={preferredLibrary} onValueChange={onLibraryChange}>
        <div className="flex flex-col gap-1 items-end">
          <SelectTrigger>
            <SelectValue placeholder="Select a library" />
          </SelectTrigger>
          <span className="text-xs text-muted-foreground">{libraryLabel}</span>
        </div>
        <SelectContent>
          <SelectGroup>
            {libraries.map((library) => (
              <SelectItem key={library} value={library}>
                {displayNames[library] ?? library}
              </SelectItem>
            ))}
          </SelectGroup>
        </SelectContent>
      </Select>
    </div>
  </div>
);

/**
 * Returns a callback that inserts code into a new cell after the last focused cell.
 */
export function useInsertCode() {
  const { createCell } = useCellActions();
  const lastFocusedCellId = useLastFocusedCellId();
  const autoInstantiate = useAtomValue(autoInstantiateAtom);

  return (code: string) => {
    // Ensure `mo` is importable when the generated code references it
    if (/\bmo\./.test(code)) {
      maybeAddMarimoImport({
        autoInstantiate,
        createCell,
        fromCellId: lastFocusedCellId,
      });
    }

    createCell({ after: lastFocusedCellId, code, skipIfCodeExists: true });
  };
}

/** Insert the configured cell supplied by a detected data source. */
export function useAddDetectedDataSource(onAdd?: () => void) {
  const insertCode = useInsertCode();

  return (source: DetectedDataSource) => {
    insertCode(source.code);
    onAdd?.();
  };
}

/**
 * Generic connection form: Zod-driven form with secrets support, a library
 * picker, and Back/Add buttons. Used by both database and storage forms.
 */
export const ConnectionForm = <T extends FieldValues, L extends string>({
  schema,
  libraries,
  preferredLibrary: initialPreferred,
  displayNames,
  libraryLabel,
  generateCode,
  onSubmit,
  onBack,
}: {
  schema: z.ZodType<T, FieldValues>;
  libraries: L[];
  preferredLibrary: L;
  displayNames: Record<L, string>;
  libraryLabel?: string;
  generateCode: (values: T, library: L) => string;
  onSubmit: () => void;
  onBack: () => void;
}) => {
  const defaults = getDefaults(schema);
  const form = useForm<T>({
    defaultValues: defaults as DefaultValues<T>,
    resolver: zodResolver(schema),
    reValidateMode: "onChange",
  });

  const [preferredLibrary, setPreferredLibrary] =
    React.useState<L>(initialPreferred);
  const insertCode = useInsertCode();

  const handleSubmit = (values: T) => {
    insertCode(generateCode(values, preferredLibrary));
    onSubmit();
  };

  return (
    <form onSubmit={form.handleSubmit(handleSubmit)} className="space-y-4">
      <SecretsProvider>
        <ZodForm schema={schema} form={form} renderers={RENDERERS}>
          <FormErrorsBanner />
        </ZodForm>
      </SecretsProvider>
      <ConnectionFormFooter
        onBack={onBack}
        isValid={form.formState.isValid}
        libraries={libraries}
        preferredLibrary={preferredLibrary}
        onLibraryChange={setPreferredLibrary}
        displayNames={displayNames}
        libraryLabel={libraryLabel}
      />
    </form>
  );
};