types/protocols/reverse-etl-editor.d.ts

Rama newjitsu · réplica de lectura del repositorio original.

import type { ZodType } from "zod";

/** Browser-safe, provider-owned form descriptions. Values remain user intent until runtime resolution. */
export interface ReverseEditorOptions {
  mode: "upsert" | "mirror";
  mapping: Record<string, string>;
  /** Object field -> literal property name -> model column. Mutually exclusive with a whole-column mapping. */
  objectMappings?: Record<string, Record<string, string>>;
  streamOptions: Record<string, any>;
  /** UI-only, non-secret destination context. Never persisted with sync settings. */
  destination?: { protocol?: string };
}
export type ReverseEditorPatch = Partial<ReverseEditorOptions>;
interface FieldBase {
  key?: string;
  name?: string;
  documentation?: string;
  group?: string;
  /** Evaluated against editor configuration, not a model row. */
  required?: boolean | ((obj: ReverseEditorOptions) => boolean);
  hidden?: (obj: ReverseEditorOptions) => boolean;
  /** Explains a row-level requirement which cannot be inferred from column mappings. */
  requirement?: string;
}
export interface ReverseEditorAlternative {
  key: string;
  title: string;
  description?: string;
  /** Selector/default alternatives that determine other requirements belong before the required-fields card. */
  beforeRequired?: boolean;
  /** OR between options; AND between the field keys inside each option. */
  options: { label: string; fields: string[] }[];
  when?: (obj: ReverseEditorOptions) => boolean;
  /** If set, the requirement applies only to rows matching this condition. */
  condition?: string;
}
export type ReverseEditorField<Key extends string = string> = FieldBase &
  (
    | { editor: "text"; value: string; change(value: string): ReverseEditorPatch }
    | {
        editor: "target";
        value: string;
        targetKind: string;
        lookupParams?: Record<string, string>;
        change(value: string): ReverseEditorPatch;
      }
    | {
        editor: "select";
        value?: string;
        choices: { value: string; label: string }[];
        change(value: string): ReverseEditorPatch;
      }
    | { editor: "number"; value: number; min?: number; max?: number; change(value: number | null): ReverseEditorPatch }
    | { editor: "checkbox"; value: boolean; label: string; change(value: boolean): ReverseEditorPatch }
    | {
        editor: "notice";
        title: string;
        description?: string;
        showIcon?: boolean;
        presentation?: "description" | "warning";
      }
    | {
        editor: "mapping";
        field: Key;
        object?: {
          properties?: { key: string; name: string; required?: boolean; documentation?: string }[];
          additionalProperties?: boolean;
        };
      }
    | { editor: "identifier"; raw: Key; hashed: Key }
    /** Read-only list of the model's columns with a payload preview; writes the identity mapping (each column to itself). */
    | { editor: "columns" }
  );
export interface ReverseStreamEditor {
  id: string;
  label: string;
  settings: ZodType<any>;
  /** Default for the sync's `checkpointEvery` when this stream is chosen; omitted means the platform default. */
  checkpointEvery?: number;
  defaults(): ReverseEditorOptions;
  fields(options: ReverseEditorOptions): ReverseEditorField[];
  alternatives?(options: ReverseEditorOptions): ReverseEditorAlternative[];
}