@docupace/ihub-config 1.1.20-alpha.0 → 1.1.21

package/dist/model/graphs/config/fields.graphql

@@ -1,394 +1,382 @@
-interface IField {
-  defaultValue: String
-  hidden: Boolean
-  label: String
-  name: String!
-  path: String!
-  readonly: Boolean
-  required: Boolean
-  requiredCondition: String
-  skipQuery: Boolean
-  excludeFromQueryInput: Boolean
-  visibilityCondition: String
-  disabledCondition: String
-}
-
-interface IDateRangeField {
-  defaultValue: [String] # [startDate, endDate]
-  defaultValueExpressions: [String] # [startDate, endDate]
-  format: String
-  hidden: Boolean
-  label: String
-  name: String!
-  paths: [String!]!
-  readonly: Boolean
-  required: Boolean
-  requiredCondition: String
-  skipQuery: Boolean
-  excludeFromQueryInput: Boolean
-  visibilityCondition: String
-  disabledCondition: String
-  validation: GenericFieldValidation
-
-}
-
-type InputField implements IField & IRowElement & IElement {
-  cols: Int
-  defaultValue: String
-  helperText: String
-  hidden: Boolean
-  label: String
-  masking: FieldMasking
-  maxLength: Int
-  minLength: Int
-  name: String!
-  path: String!
-  placeholder: String
-  readonly: Boolean
-  required: Boolean
-  requiredCondition: String
-  skipQuery: Boolean
-  excludeFromQueryInput: Boolean
-  startAdornment: String
-  type: FieldValueType
-  validation: InputValidation
-  visibilityCondition: String
-  disabledCondition: String
-  skipDirtyCheck: Boolean
-  # Start of text area configuration, see https://mui.com/material-ui/react-text-field/#multiline
-  multiline: Boolean  # optional if at least one other text area parameter is provided
-  rows: Int
-  maxRows: Int
-  minRows: Int
-    # End of text area configuration
-}
-
-type CustomValidator implements  IRowElement & IElement {
-  validationRule: String
-  errorMessage: String
-  paths: [String!]!
-}
-
-union Fields = InputField | PhoneField | DateField | DateRangeField | SelectField | ToggleField | BooleanField | TextElement
-
-type ItemValidation {
-  type: String!
-  fields: [String!]!
-  errorMessage: String
-}
-
-type RepeaterField implements IRowElement & IElement {
-  path: String!
-  title: String
-  label: String
-  buttonLabel: String
-  required: Boolean
-  skipId: Boolean
-  fields: [Fields!]!
-  visibilityCondition: String
-  maxFields: String
-  validateUnique: Boolean
-  duplicateMessage: String
-  itemValidation: ItemValidation
-}
-
-type ControlGroup implements IRowElement & IElement {
-  path: String!
-  title: String
-  skipId: Boolean
-  controlOptions: ISelectOptions!
-  fields: [Fields!]!
-}
-
-type PhoneField implements IField & IRowElement & IElement {
-  cols: Int
-  defaultValue: String
-  hidden: Boolean
-  label: String
-  name: String!
-  path: String!
-  placeholder: String
-  readonly: Boolean
-  required: Boolean
-  requiredCondition: String
-  skipQuery: Boolean
-  excludeFromQueryInput: Boolean
-  visibilityCondition: String
-  disabledCondition: String
-  validation: GenericFieldValidation
-}
-
-type DateField implements IField & IRowElement & IElement {
-  cols: Int
-  defaultValue: String
-  hidden: Boolean
-  label: String
-  name: String!
-  path: String!
-  readonly: Boolean
-  required: Boolean
-  requiredCondition: String
-  skipQuery: Boolean
-  excludeFromQueryInput: Boolean
-  visibilityCondition: String
-  disabledCondition: String
-  minDate: String # e.q. "now" or "2025-03-20"
-  maxDate: String # e.q. "now" or "2025-03-20"
-  validation: GenericFieldValidation
-}
-
-type DateRangeField implements IDateRangeField & IRowElement & IElement {
-  cols: Int
-  defaultValue: [String!] # [startDate, endDate]
-  defaultValueExpressions: [String!] # [startDate, endDate]
-  format: String
-  hidden: Boolean
-  label: String
-  name: String!
-  paths: [String!]!
-  readonly: Boolean
-  required: Boolean
-  requiredCondition: String
-  skipQuery: Boolean
-  excludeFromQueryInput: Boolean
-  visibilityCondition: String
-  disabledCondition: String
-  validation: GenericFieldValidation
-}
-
-type SelectField implements IField & IRowElement & IElement {
-  cols: Int
-  defaultValue: String
-  defaultValuePath: String
-  disableClearable: Boolean
-  hidden: Boolean
-  label: String
-  multiple: Boolean
-  name: String!
-  path: String!
-  placeholder: String
-  readonly: Boolean
-  required: Boolean
-  requiredCondition: String
-  selectOptions: ISelectOptions!
-  skipQuery: Boolean
-  excludeFromQueryInput: Boolean
-  visibilityCondition: String
-  disabledCondition: String
-  excludeId: Boolean
-  helperText: String
-  autoSelectSingleOption: Boolean
-  validation: GenericFieldValidation
-}
-
-type ToggleField implements IField & IRowElement & IElement {
-  cols: Int
-  defaultValue: String
-  disableClearable: Boolean
-  hidden: Boolean
-  label: String
-  multiple: Boolean
-  name: String!
-  path: String!
-  readonly: Boolean
-  required: Boolean
-  requiredCondition: String
-  selectOptions: ISelectOptions!
-  size: String # see https://mui.com/material-ui/react-toggle-button/#size
-  skipQuery: Boolean
-  excludeFromQueryInput: Boolean
-  visibilityCondition: String
-  disabledCondition: String
-  linkedFields: [String!]
-  validation: GenericFieldValidation
-}
-
-type BooleanField implements IField & IRowElement & IElement {
-  cols: Int
-  defaultValue: String
-  hidden: Boolean
-  label: String
-  name: String!
-  path: String!
-  readonly: Boolean
-  required: Boolean
-  requiredCondition: String
-  skipQuery: Boolean
-  excludeFromQueryInput: Boolean
-  visibilityCondition: String
-  disabledCondition: String
-  linkedFields: [String!]
-  validation: GenericFieldValidation
-}
-
-type ChipSelectWithInputField implements IField & IRowElement & IElement {
-  cols: Int
-  defaultValue: String
-  defaultValuePath: String
-  hidden: Boolean
-  input: InputField
-  label: String
-  name: String!
-  path: String!
-  labelPath: String
-  readonly: Boolean
-  multiple: Boolean
-  required: Boolean
-  requiredCondition: String
-  selectOptions: ISelectOptions!
-  skipQuery: Boolean
-  excludeFromQueryInput: Boolean
-  subTitle: String
-  title: String
-  visibilityCondition: String
-  disabledCondition: String
-  linkedFields: [String!]
-  validation: ChipSelectValidation
-}
-
-type CustomField implements IField & IRowElement & IElement {
-  cols: Int
-  component: String!
-  config: JSON
-  defaultValue: String
-  hidden: Boolean
-  label: String
-  name: String!
-  path: String!
-  readonly: Boolean
-  required: Boolean
-  requiredCondition: String
-  skipQuery: Boolean
-  excludeFromQueryInput: Boolean
-  visibilityCondition: String
-  disabledCondition: String
-  validation: GenericFieldValidation
-}
-
-type StatusChipField implements IField & IRowElement & IElement {
-  align: String
-  cols: Int
-  label: String
-  name: String!
-  path: String!
-  validation: GenericFieldValidation
-}
-
-type CheckboxGroupValue {
-  label: String!
-  path: String!
-  skipQuery: Boolean
-  excludeFromQueryInput: Boolean
-  value: JSON!
-}
-
-type CheckboxGroup implements IRowElement & IElement {
-  cols: Int
-  name: String!
-  required: Boolean
-  requiredCondition: String
-  subTitle: String
-  title: String
-  values: [CheckboxGroupValue!]!
-  visibilityCondition: String
-  disabledCondition: String
-}
-
-enum FieldValueType {
-  Int
-  Float
-}
-
-type GenericFieldValidation {
-    custom : CustomFieldValidation
-}
-
-type CustomFieldValidation {
-  expression: String
-  message: String
-  """
-  Paths of other fields this expression reads. When one of these fields changes, this
-  field's validation is re-triggered so its error state stays in sync without requiring
-  the user to re-touch this field directly.
-  """
-  dependentPaths: [String!]
-}
-
-type StringValidationRule {
-  message: String
-  value: String
-}
-
-type IntValidationRule {
-  message: String
-  value: Int
-}
-
-type FloatValidationRule {
-  message: String
-  value: Float
-}
-
-type FormatValidationRule {
-  name: String
-  description: String
-  message: String
-  expression: String
-  condition: String
-}
-
-type InputValidation {
-  email: StringValidationRule
-  length: IntValidationRule
-  format: [FormatValidationRule!]
-  min: FloatValidationRule
-  max: FloatValidationRule
-  custom: CustomFieldValidation
-}
-
-type ChipSelectValidation {
-  compatibleWith: CompatibleWithRule
-  uniqueInList: UniqueInListRule
-  custom : CustomFieldValidation
-}
-
-type CompatibleWithRule {
-  field: String!
-  rules: [CompatibleWithRuleEntry!]!
-}
-
-type CompatibleWithRuleEntry {
-  when: WhenClause!
-  allowed: [String!]!
-  message: String!
-}
-
-type WhenClause {
-  equals: String
-  in: [String!]
-}
-
-type UniqueInListRule {
-  listPaths: [String!]!
-  itemValuePath: String!
-  value: String
-  message: String!
-}
-
-# see more https://s-yadav.github.io/react-number-format/docs/props
-type PatternMasking {
-  dynamic: Boolean
-  format: String!
-  mask: String
-}
-
-# see more https://s-yadav.github.io/react-number-format/docs/props
-type NumericMasking {
-  thousandSeparator: String
-  decimalSeparator: String
-  decimalScale: Number
-  fixedDecimalScale: Boolean
-  allowNegative: Boolean
-}
-
-union FieldMasking =  PatternMasking | NumericMasking
+interface IField {
+  defaultValue: String
+  hidden: Boolean
+  label: String
+  name: String!
+  path: String!
+  readonly: Boolean
+  required: Boolean
+  requiredCondition: String
+  skipQuery: Boolean
+  excludeFromQueryInput: Boolean
+  visibilityCondition: String
+  disabledCondition: String
+  """
+  Always include this field in the mutation input, even if it is hidden or has not been modified by the user.
+  """
+  skipDirtyCheck: Boolean
+}
+
+interface IDateRangeField {
+  defaultValue: [String] # [startDate, endDate]
+  defaultValueExpressions: [String] # [startDate, endDate]
+  format: String
+  hidden: Boolean
+  label: String
+  name: String!
+  paths: [String!]!
+  readonly: Boolean
+  required: Boolean
+  requiredCondition: String
+  skipQuery: Boolean
+  excludeFromQueryInput: Boolean
+  visibilityCondition: String
+  disabledCondition: String
+}
+
+type InputField implements IField & IRowElement & IElement {
+  cols: Int
+  defaultValue: String
+  helperText: String
+  hidden: Boolean
+  label: String
+  masking: FieldMasking
+  maxLength: Int
+  minLength: Int
+  name: String!
+  path: String!
+  placeholder: String
+  readonly: Boolean
+  required: Boolean
+  requiredCondition: String
+  skipQuery: Boolean
+  excludeFromQueryInput: Boolean
+  startAdornment: String
+  type: FieldValueType
+  validation: InputValidation
+  visibilityCondition: String
+  disabledCondition: String
+  # Start of text area configuration, see https://mui.com/material-ui/react-text-field/#multiline
+  multiline: Boolean  # optional if at least one other text area parameter is provided
+  rows: Int
+  maxRows: Int
+  minRows: Int
+    # End of text area configuration
+}
+
+type CustomValidator implements  IRowElement & IElement {
+  validationRule: String
+  errorMessage: String
+  paths: [String!]!
+}
+
+union Fields = InputField | PhoneField | DateField | DateRangeField | SelectField | ToggleField | BooleanField | TextElement
+
+type ItemValidation {
+  type: String!
+  fields: [String!]!
+  errorMessage: String
+}
+
+type RepeaterField implements IRowElement & IElement {
+  path: String!
+  title: String
+  label: String
+  buttonLabel: String
+  required: Boolean
+  skipId: Boolean
+  fields: [Fields!]!
+  visibilityCondition: String
+  maxFields: String
+  validateUnique: Boolean
+  duplicateMessage: String
+  itemValidation: ItemValidation
+}
+
+type ControlGroup implements IRowElement & IElement {
+  path: String!
+  title: String
+  skipId: Boolean
+  controlOptions: ISelectOptions!
+  fields: [Fields!]!
+}
+
+type PhoneField implements IField & IRowElement & IElement {
+  cols: Int
+  defaultValue: String
+  hidden: Boolean
+  label: String
+  name: String!
+  path: String!
+  placeholder: String
+  readonly: Boolean
+  required: Boolean
+  requiredCondition: String
+  skipQuery: Boolean
+  excludeFromQueryInput: Boolean
+  visibilityCondition: String
+  disabledCondition: String
+  validation: FieldValidation
+}
+
+type DateField implements IField & IRowElement & IElement {
+  cols: Int
+  defaultValue: String
+  hidden: Boolean
+  label: String
+  name: String!
+  path: String!
+  readonly: Boolean
+  required: Boolean
+  requiredCondition: String
+  skipQuery: Boolean
+  excludeFromQueryInput: Boolean
+  visibilityCondition: String
+  disabledCondition: String
+  minDate: String # e.q. "now" or "2025-03-20"
+  maxDate: String # e.q. "now" or "2025-03-20"
+  validation: FieldValidation
+}
+
+type DateRangeField implements IDateRangeField & IRowElement & IElement {
+  cols: Int
+  defaultValue: [String!] # [startDate, endDate]
+  defaultValueExpressions: [String!] # [startDate, endDate]
+  format: String
+  hidden: Boolean
+  label: String
+  name: String!
+  paths: [String!]!
+  readonly: Boolean
+  required: Boolean
+  requiredCondition: String
+  skipQuery: Boolean
+  excludeFromQueryInput: Boolean
+  visibilityCondition: String
+  disabledCondition: String
+}
+
+type SelectField implements IField & IRowElement & IElement {
+  cols: Int
+  defaultValue: String
+  defaultValuePath: String
+  disableClearable: Boolean
+  hidden: Boolean
+  label: String
+  multiple: Boolean
+  name: String!
+  path: String!
+  placeholder: String
+  readonly: Boolean
+  required: Boolean
+  requiredCondition: String
+  selectOptions: ISelectOptions!
+  skipQuery: Boolean
+  excludeFromQueryInput: Boolean
+  visibilityCondition: String
+  disabledCondition: String
+  excludeId: Boolean
+  helperText: String
+  autoSelectSingleOption: Boolean
+  validation: FieldValidation
+}
+
+type ToggleField implements IField & IRowElement & IElement {
+  cols: Int
+  defaultValue: String
+  disableClearable: Boolean
+  hidden: Boolean
+  label: String
+  multiple: Boolean
+  name: String!
+  path: String!
+  readonly: Boolean
+  required: Boolean
+  requiredCondition: String
+  selectOptions: ISelectOptions!
+  size: String # see https://mui.com/material-ui/react-toggle-button/#size
+  skipQuery: Boolean
+  excludeFromQueryInput: Boolean
+  visibilityCondition: String
+  disabledCondition: String
+  linkedFields: [String!]
+  validation: FieldValidation
+}
+
+type BooleanField implements IField & IRowElement & IElement {
+  cols: Int
+  defaultValue: String
+  hidden: Boolean
+  label: String
+  name: String!
+  path: String!
+  readonly: Boolean
+  required: Boolean
+  requiredCondition: String
+  skipQuery: Boolean
+  excludeFromQueryInput: Boolean
+  visibilityCondition: String
+  disabledCondition: String
+  linkedFields: [String!]
+  validation: FieldValidation
+}
+
+type ChipSelectWithInputField implements IField & IRowElement & IElement {
+  cols: Int
+  defaultValue: String
+  defaultValuePath: String
+  hidden: Boolean
+  input: InputField
+  label: String
+  name: String!
+  path: String!
+  labelPath: String
+  readonly: Boolean
+  multiple: Boolean
+  required: Boolean
+  requiredCondition: String
+  selectOptions: ISelectOptions!
+  skipQuery: Boolean
+  excludeFromQueryInput: Boolean
+  subTitle: String
+  title: String
+  visibilityCondition: String
+  disabledCondition: String
+  linkedFields: [String!]
+  validation: ChipSelectValidation
+}
+
+type CustomField implements IField & IRowElement & IElement {
+  cols: Int
+  component: String!
+  config: JSON
+  defaultValue: String
+  hidden: Boolean
+  label: String
+  name: String!
+  path: String!
+  readonly: Boolean
+  required: Boolean
+  requiredCondition: String
+  skipQuery: Boolean
+  excludeFromQueryInput: Boolean
+  visibilityCondition: String
+  disabledCondition: String
+  validation: FieldValidation
+}
+
+type StatusChipField implements IField & IRowElement & IElement {
+  align: String
+  cols: Int
+  label: String
+  name: String!
+  path: String!
+  validation: FieldValidation
+}
+
+type CheckboxGroupValue {
+  label: String!
+  path: String!
+  skipQuery: Boolean
+  excludeFromQueryInput: Boolean
+  value: JSON!
+}
+
+type CheckboxGroup implements IRowElement & IElement {
+  cols: Int
+  name: String!
+  required: Boolean
+  requiredCondition: String
+  subTitle: String
+  title: String
+  values: [CheckboxGroupValue!]!
+  visibilityCondition: String
+  disabledCondition: String
+}
+
+enum FieldValueType {
+  Int
+  Float
+}
+
+type FieldValidation {
+  expression: String
+  message: String
+}
+
+type StringValidationRule {
+  message: String
+  value: String
+}
+
+type IntValidationRule {
+  message: String
+  value: Int
+}
+
+type FloatValidationRule {
+  message: String
+  value: Float
+}
+
+type FormatValidationRule {
+  name: String
+  description: String
+  message: String
+  expression: String
+  condition: String
+}
+
+type InputValidation {
+  email: StringValidationRule
+  length: IntValidationRule
+  format: [FormatValidationRule!]
+  min: FloatValidationRule
+  max: FloatValidationRule
+}
+
+type ChipSelectValidation {
+  compatibleWith: CompatibleWithRule
+  uniqueInList: UniqueInListRule
+}
+
+type CompatibleWithRule {
+  field: String!
+  rules: [CompatibleWithRuleEntry!]!
+}
+
+type CompatibleWithRuleEntry {
+  when: WhenClause!
+  allowed: [String!]!
+  message: String!
+}
+
+type WhenClause {
+  equals: String
+  in: [String!]
+}
+
+type UniqueInListRule {
+  listPaths: [String!]!
+  itemValuePath: String!
+  value: String
+  message: String!
+}
+
+# see more https://s-yadav.github.io/react-number-format/docs/props
+type PatternMasking {
+  dynamic: Boolean
+  format: String!
+  mask: String
+}
+
+# see more https://s-yadav.github.io/react-number-format/docs/props
+type NumericMasking {
+  thousandSeparator: String
+  decimalSeparator: String
+  decimalScale: Number
+  fixedDecimalScale: Boolean
+  allowNegative: Boolean
+}
+
+union FieldMasking =  PatternMasking | NumericMasking