yao-app-ts-types/src/types/xgen/form.d.ts

typescript types for yao application

import type {
  XgenAction as Action,
  XgenCommon as Common,
  XgenGlobal as Global,
} from "@/types/xgen";

export declare namespace XgenForm {
  interface Frame {
    url: string;
    params?: Record<string, string>;
  }

  interface Section {
    title?: string;
    desc?: string;
    columns: Array<Column>;
  }

  interface SectionResult {
    title?: string;
    desc?: string;
    columns: Array<ColumnResult>;
  }

  interface RawTab {
    width?: number;
    tabs: Array<Section>;
  }

  interface TargetTab {
    width?: number;
    tabs: Array<SectionResult>;
  }

  type Column = Common.BaseColumn | RawTab;

  type ColumnResult = Common.EditColumn | TargetTab;

  type HookArgs = { api: string; params: Global.AnyObject };
  type HookType = { [key: string]: HookArgs };

  type HookKeys = "onChange";

  interface OpenRef {
    Form?: {
      type: "view" | "edit";
      model: string;
      id: string;
    };
    Page?: {
      type: "chart";
      model: string;
      id: string;
    };
  }

  interface FloatContentItem {
    name: string;
    payload: OpenRef;
  }

  interface Reference {
    flatContent?: {
      name: string;
      defaultOpen?: boolean;
      payload: OpenRef & { width?: number | string };
    };
    floatContents?: Array<FloatContentItem>;
  }

  interface Setting {
    name: string;
    primary: string;
    hooks?: {
      [key in HookKeys]: HookType;
    };
    actions?: Array<Action.Props>;
    form: {
      props: {
        onLoadSync?: boolean;
        reference?: Reference;
        showSectionDivideLine?: boolean;
      };
      sections: Array<Section>;
      frame?: Frame;
    };
    fields: {
      form: Common.EditFields;
    };
    config?: Common.Config & {
      showAnchor?: boolean;
      showBreadcrumb?: boolean;
      viewTitle?: string;
      editTitle?: string;
    };
  }
}