@comet/admin-generator 8.17.1 → 9.0.0-beta.0

package/dist/index.d.mts

@@ -0,0 +1,344 @@
+import { Command } from "commander";
+import { FormattedMessage, MessageDescriptor } from "react-intl";
+import { ApolloClient } from "@apollo/client";
+import { GridColDef } from "@comet/admin";
+import { IconName } from "@comet/admin-icons";
+import { BlockInterface, ContentScope, FinalFormFileUploadProps } from "@comet/cms-admin";
+import { Breakpoint, IconProps } from "@mui/material";
+import { GridCellParams, GridFilterItem, GridFilterOperator, GridRenderCellParams, GridSortDirection, GridValidRowModel } from "@mui/x-data-grid";
+import { FieldValidator, FormApi } from "final-form";
+import { ComponentType, JSX, ReactElement } from "react";
+
+//#region src/commands/generate/generateGrid/usableFields.d.ts
+type Prev = [never, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9];
+type GqlLeaves<T, FollowArrays extends boolean = false, Depth extends number = 5> = [Depth] extends [never] ? never : T extends any ? T extends Array<infer ArrayType> ? FollowArrays extends true ? GqlLeaves<ArrayType, FollowArrays, Prev[Depth]> : never : "__typename" extends keyof T ? { [K in keyof T as K extends "__typename" ? never : K]-?: GqlLeaves<T[K], FollowArrays, Prev[Depth]> } : never : never;
+type IfExplicitAny<T, Y, N> = T extends never ? Y : N;
+type FieldNames<T> = { [K in keyof T]: `${Exclude<K, symbol>}${FieldNames<T[K]> extends never ? "" : `.${FieldNames<T[K]>}`}` }[keyof T];
+type UsableFields<T, FollowArrays extends boolean = false> = IfExplicitAny<T, any, FieldNames<GqlLeaves<T, FollowArrays>>>;
+type FormFieldNames<T> = { [K in keyof T]: `${Exclude<K, symbol>}` | (FormFieldNames<T[K]> extends never ? never : `${Exclude<K, symbol>}.${FormFieldNames<T[K]>}`) }[keyof T];
+type UsableFormFields<T> = IfExplicitAny<T, any, FormFieldNames<GqlLeaves<T, false>>>;
+//#endregion
+//#region src/commands/generate/utils/columnVisibility.d.ts
+type BreakpointKey = `'${Breakpoint}'` | number;
+type SingleValueBrakpointTypes = "up" | "down" | "only" | "not";
+type MultiValueBrakpointTypes = "between";
+type ColumnVisibleOption = `${SingleValueBrakpointTypes}(${BreakpointKey})` | `${MultiValueBrakpointTypes}(${BreakpointKey}, ${BreakpointKey})` | false;
+//#endregion
+//#region src/commands/generate/generate-command.d.ts
+type FormattedMessageElement = ReactElement<MessageDescriptor, typeof FormattedMessage>;
+type IconObject = Pick<IconProps, "color" | "fontSize"> & {
+  name: IconName;
+};
+type Icon = IconName | IconObject | ComponentType;
+type Adornment = string | {
+  icon: Icon;
+};
+type InputBaseFieldConfig = {
+  startAdornment?: Adornment;
+  endAdornment?: Adornment;
+};
+type ComponentFormFieldConfig = {
+  type: "component";
+  component: ComponentType;
+};
+type StaticSelectValue = {
+  value: string;
+  label: string | FormattedMessageElement;
+} | string;
+type AsyncSelectFilter = {
+  /**
+       * Filter by value of field in current form
+       */
+  type: "field";
+  /**
+       * Name of the field in current form, that will be used to filter the query
+       */
+  formFieldName: string;
+  /**
+       * Name of the graphql argument the prop will be applied to. Defaults to propdName.
+       *
+       * Root Argument or filter argument are supported.
+       */
+  rootQueryArg?: string;
+} | {
+  /**
+       * Filter by a prop passed into the form, this prop will be generated
+       */
+  type: "formProp";
+  /**
+       * Name of the prop generated for this form
+       */
+  propName: string;
+  /**
+       * Name of the graphql argument the prop will be applied to. Defaults to propdName.
+       *
+       * Root Argument or filter argument are supported.
+       */
+  rootQueryArg?: string;
+};
+type FormFieldConfig<T> = (({
+  type: "text";
+  name: UsableFormFields<T>;
+  multiline?: boolean;
+  initialValue?: string;
+} & InputBaseFieldConfig) | ({
+  type: "number";
+  name: UsableFormFields<T>;
+  decimals?: number;
+  initialValue?: number;
+} & InputBaseFieldConfig) | ({
+  type: "numberRange";
+  name: UsableFormFields<T>;
+  minValue: number;
+  maxValue: number;
+  disableSlider?: boolean;
+  initialValue?: {
+    min: number;
+    max: number;
+  };
+} & InputBaseFieldConfig) | {
+  type: "boolean";
+  name: UsableFormFields<T>;
+  initialValue?: boolean;
+  checkboxLabel?: string | FormattedMessageElement;
+} | ({
+  type: "date";
+  name: UsableFormFields<T>;
+  initialValue?: string;
+} & InputBaseFieldConfig) | ({
+  type: "dateTime";
+  name: UsableFormFields<T>;
+  initialValue?: Date;
+} & InputBaseFieldConfig) | ({
+  type: "staticSelect";
+  name: UsableFormFields<T>;
+  values?: StaticSelectValue[];
+  inputType?: "select" | "radio";
+  initialValue?: string;
+} & Omit<InputBaseFieldConfig, "endAdornment">) | ({
+  type: "asyncSelect";
+  name: UsableFormFields<T>;
+  rootQuery: string;
+  labelField?: string;
+  /** Whether Autocomplete or Select should be used.
+       *
+       * defaults to true if rootQuery has a search argument
+       */
+  autocomplete?: boolean;
+  /**
+       * filter for query, passed as variable to graphql query
+       */
+  filter?: AsyncSelectFilter;
+} & Omit<InputBaseFieldConfig, "endAdornment">) | ({
+  type: "asyncSelectFilter";
+  name: string;
+  loadValueQueryField: string;
+  rootQuery: string;
+  labelField?: string;
+  /** Whether Autocomplete or Select should be used.
+       *
+       * defaults to true if rootQuery has a search argument
+       */
+  autocomplete?: boolean;
+  /**
+       * filter for query, passed as variable to graphql query
+       */
+  filter?: AsyncSelectFilter;
+} & Omit<InputBaseFieldConfig, "endAdornment">) | {
+  type: "block";
+  name: UsableFormFields<T>;
+  block: BlockInterface;
+} | ({
+  type: "fileUpload";
+  multiple?: false;
+  name: UsableFormFields<T>;
+  maxFiles?: 1;
+  download?: boolean;
+} & Pick<Partial<FinalFormFileUploadProps<false>>, "maxFileSize" | "readOnly" | "layout" | "accept">) | ({
+  type: "fileUpload";
+  multiple: true;
+  name: UsableFormFields<T>;
+  maxFiles?: number;
+  download?: boolean;
+} & Pick<Partial<FinalFormFileUploadProps<true>>, "maxFileSize" | "readOnly" | "layout" | "accept">)) & {
+  label?: string | FormattedMessageElement;
+  required?: boolean;
+  validate?: FieldValidator<unknown>;
+  helperText?: string | FormattedMessageElement;
+  readOnly?: boolean;
+};
+type OptionalNestedFieldsConfig<T> = {
+  type: "optionalNestedFields";
+  name: UsableFormFields<T>;
+  checkboxLabel?: string | FormattedMessageElement;
+  fields: FormFieldConfig<any>[];
+};
+type FormLayoutConfig<T> = {
+  type: "fieldSet";
+  name: string;
+  title?: string | FormattedMessageElement;
+  supportText?: string;
+  collapsible?: boolean;
+  initiallyExpanded?: boolean;
+  fields: (FormFieldConfig<T> | OptionalNestedFieldsConfig<T> | ComponentFormFieldConfig)[];
+} | OptionalNestedFieldsConfig<T>;
+type FormConfig<T extends {
+  __typename?: string;
+}> = {
+  type: "form";
+  gqlType: T["__typename"];
+  mode?: "edit" | "add" | "all";
+  fragmentName?: string;
+  createMutation?: string;
+  /**
+       * If true, scope will be passed as prop, if false scope will be fetched from ContentScopeContext
+       * @default false
+       */
+  scopeAsProp?: boolean;
+  fields: (FormFieldConfig<T> | FormLayoutConfig<T> | ComponentFormFieldConfig)[];
+  /**
+       * If true, the form will navigate to the edit page using stackSwitchApi.activatePage of the newly created item after a successful creation.
+       * @default true
+       */
+  navigateOnCreate?: boolean;
+  /**
+       * If true, the generated form will have an initialValues prop to set initial form values.
+       * @default false
+       */
+  initialValuesAsProp?: boolean;
+};
+type InjectedFormVariables = {
+  id?: string;
+  mode?: "edit" | "add";
+  client: ApolloClient<object>;
+  formApi: FormApi<unknown, Partial<unknown>>;
+  scope: ContentScope;
+};
+declare function injectFormVariables<T>(fn: (injectedVariables: InjectedFormVariables) => T): T;
+type BaseColumnConfig = Pick<GridColDef, "width" | "minWidth" | "maxWidth" | "flex" | "pinned" | "disableExport"> & {
+  headerName?: string | FormattedMessageElement;
+  headerInfoTooltip?: string | FormattedMessageElement;
+  visible?: ColumnVisibleOption;
+  fieldName?: string;
+};
+type GridColumnStaticSelectLabelCellContent = {
+  primaryText?: string | FormattedMessageElement;
+  secondaryText?: string | FormattedMessageElement;
+  icon?: Icon;
+};
+type GridColumnStaticSelectValue = StaticSelectValue | {
+  value: string | number | boolean;
+  label: string | FormattedMessageElement | GridColumnStaticSelectLabelCellContent;
+} | number | boolean;
+type GridColumnConfig<T extends GridValidRowModel> = ({
+  type: "text";
+  renderCell?: (params: GridRenderCellParams<T, any, any>) => JSX.Element;
+} | {
+  type: "number";
+  currency?: string;
+  decimals?: number;
+  renderCell?: (params: GridRenderCellParams<T, any, any>) => JSX.Element;
+} | {
+  type: "boolean";
+  renderCell?: (params: GridRenderCellParams<T, any, any>) => JSX.Element;
+} | {
+  type: "date";
+  renderCell?: (params: GridRenderCellParams<T, any, any>) => JSX.Element;
+} | {
+  type: "dateTime";
+  renderCell?: (params: GridRenderCellParams<T, any, any>) => JSX.Element;
+} | {
+  type: "staticSelect";
+  values?: GridColumnStaticSelectValue[];
+} | {
+  type: "block";
+  block: BlockInterface;
+} | {
+  type: "id";
+  renderCell?: (params: GridRenderCellParams<T, any, any>) => JSX.Element;
+} | {
+  type: "manyToMany";
+  renderCell?: (params: GridRenderCellParams<T, any, any>) => JSX.Element;
+  queryFields?: UsableFields<T, true>[];
+  /**
+       * The field to use as label for the default renderCell implementation.
+       */
+  labelField?: string;
+} | {
+  type: "oneToMany";
+  renderCell?: (params: GridRenderCellParams<T, any, any>) => JSX.Element;
+  queryFields?: UsableFields<T, true>[];
+  /**
+       * The field to use as label for the default renderCell implementation.
+       */
+  labelField?: string;
+}) & {
+  name: UsableFields<T>;
+  filterOperators?: GridFilterOperator[];
+} & BaseColumnConfig;
+type ActionsGridColumnConfig<T> = {
+  type: "actions";
+  queryFields?: UsableFields<T, true>[];
+  component?: ComponentType<GridCellParams>;
+} & BaseColumnConfig;
+type VirtualGridColumnConfig<T extends GridValidRowModel> = {
+  type: "virtual";
+  name: string;
+  queryFields?: UsableFields<T, true>[];
+  renderCell: (params: GridRenderCellParams<T, any, any>) => JSX.Element;
+} & Pick<GridColDef, "sortBy"> & BaseColumnConfig;
+type InitialFilterConfig = {
+  items: GridFilterItem[];
+  linkOperator?: "and" | "or";
+};
+type GridConfigGridColumnDef<T extends {
+  __typename?: string;
+}> = GridColumnConfig<T> | ActionsGridColumnConfig<T> | VirtualGridColumnConfig<T>;
+type GridConfig<T extends {
+  __typename?: string;
+}> = {
+  type: "grid";
+  gqlType: T["__typename"];
+  fragmentName?: string;
+  query?: string;
+  queryParamsPrefix?: string;
+  columns: Array<GridConfigGridColumnDef<T>>;
+  excelExport?: boolean;
+  add?: boolean;
+  edit?: boolean;
+  delete?: boolean;
+  readOnly?: boolean;
+  initialSort?: Array<{
+    field: string;
+    sort: GridSortDirection;
+  }>;
+  initialFilter?: InitialFilterConfig;
+  filterProp?: boolean;
+  toolbar?: boolean;
+  toolbarActionProp?: boolean;
+  newEntryText?: string | FormattedMessageElement;
+  rowActionProp?: boolean;
+  selectionProps?: "multiSelect" | "singleSelect";
+  rowReordering?: {
+    enabled: boolean;
+    dragPreviewField?: UsableFields<T>;
+  };
+  /**
+       * If true, scope will be passed as prop, if false scope will be fetched from ContentScopeContext
+       * @default false
+       */
+  scopeAsProp?: boolean;
+  density?: "comfortable" | "compact" | "standard";
+  crudContextMenu?: {
+    deleteType?: "delete" | "remove";
+    deleteText?: string;
+  };
+};
+type GeneratorConfig<T extends {
+  __typename?: string;
+}> = FormConfig<T> | GridConfig<T>;
+declare function defineConfig<T extends {
+  __typename?: string;
+}>(config: GeneratorConfig<T>): GeneratorConfig<T>;
+//#endregion
+export { type FormConfig, type FormFieldConfig, type GeneratorConfig, type GridColumnConfig, type GridColumnStaticSelectValue, type GridConfig, type InjectedFormVariables, type StaticSelectValue, defineConfig, injectFormVariables };