@docupace/ihub-config 1.0.0

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

@@ -0,0 +1,338 @@
+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
+}
+
+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
+}
+
+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"
+}
+
+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
+}
+
+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!]
+}
+
+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!]
+}
+
+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!]
+}
+
+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
+}
+
+type StatusChipField implements IField & IRowElement & IElement {
+  align: String
+  cols: Int
+  label: String
+  name: String!
+  path: String!
+}
+
+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 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
+}
+
+# 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

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

@@ -0,0 +1,40 @@
+interface IMenuItem {
+    name: String!
+    label: String!
+    icon: String
+    url: String
+    color: String
+    action: String
+    component: String
+    description: String
+    visibilityCondition: String
+    config: JSON
+}
+
+type MenuItem implements IMenuItem {
+    name: String!
+    label: String!
+    icon: String
+    url: String
+    color: String
+    action: String
+    component: String
+    tooltip: String
+    description: String
+    visibilityCondition: String
+    config: JSON
+}
+
+type ActionButton implements IMenuItem {
+    name: String!
+    label: String!
+    icon: String
+    url: String
+    color: String
+    component: String
+    action: String
+    disabled: Boolean
+    menuItems: [MenuItem!]
+    visibilityCondition: String
+    description: String
+}

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

@@ -0,0 +1,30 @@
+
+input WidgetInput {
+    name : String
+}
+
+input DashboardRowInput {
+    title : String
+    name: String
+    hidden: Boolean
+    layout: Number
+    elements : [WidgetInput!]
+}
+
+input DashboardPanelInput {
+    rows : [DashboardRowInput]
+}
+
+input DashboardPageInput {
+    title: String
+    panel : DashboardPanelInput
+}
+
+type PageMutation {
+    updateDashboard(input: DashboardPageInput) : DashboardPage
+}
+
+type ConfigMutation {
+    refresh: Boolean
+    pages: PageMutation
+}

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

@@ -0,0 +1,227 @@
+interface Page {
+  title: String
+  description: String
+  config: JSON
+}
+
+type OverviewPage implements Page {
+  title: String
+  description: String
+  domain: String
+  cards: [Card]
+  menuItems: [MenuItem]
+  config: JSON
+  tables: [Table]
+}
+
+type TablePage implements Page {
+  title: String
+  component: String
+  description: String
+  actionButton: ActionButton
+  table: AnyTable!
+  panel: Panel
+  config: JSON
+}
+
+type ComponentPage implements Page {
+  title: String
+  description: String
+  component: String
+  panel: Panel
+  config: JSON
+}
+
+type TabbedPage implements Page {
+  title: String
+  description: String
+  tabs: [Tab!]!
+  config: JSON
+  gqlQuery: GQLQuery
+  # TODO: Replace `mutations` (currently a JSON object used as { [mutationName: String]: GQLQuery }) with a properly typed map.
+  mutations: JSON
+}
+
+type DetailsPage implements Page {
+  title: String
+  description: String
+  panel: Panel
+  config: JSON
+}
+
+type DomainRecordTemplate implements Page {
+  title: String
+  description: String
+  sideMenu: SideMenu
+  viewer: Viewer
+  config: JSON
+}
+
+type PageLayout implements Page {
+  title: String
+  description: String
+  sideMenu: SideMenu
+  widgets: [ExternalWidget]
+  config: JSON
+}
+
+type DashboardPage implements Page {
+  panel: DashboardPanel
+  title: String
+  description: String
+  config: JSON
+}
+
+type ReportPage implements Page {
+  title: String
+  description: String
+  controlPanel: Panel
+  dashboardPanel: DashboardPanel
+  config: JSON
+}
+
+type AnyPage implements Page {
+  title: String
+  description: String
+  tables: [NamedTable!]
+  panels: [Panel!]
+  tabbedPages: [TabbedPage!]
+  config: JSON
+}
+
+type WizardPage implements Page {
+  description: String
+  title : String
+  dataSource: String
+  steps: [Step!]!
+  loadWizardByCustodian: [LoadWizardByCustodian]
+  defaultWizard: String
+  # TODO: Replace `mutations` (currently a JSON object used as { [mutationName: String]: GQLQuery }) with a properly typed map.
+  mutations: JSON
+  config: JSON
+}
+
+type LoadWizardByCustodian {
+  custodian: String
+  wizard: String
+}
+
+type Step {
+  id : String!
+  label : String!
+  icon: String
+  page : Page
+  visibilityCondition: String
+  pathUrl: String
+}
+
+type SideMenu {
+  headerCard: Card
+  menuItems: [MenuItem!]
+  dataCard: Card
+}
+
+type CardView {
+  queryName: String
+  card: Card!
+  groups: CardGroups
+}
+
+type CardGroups {
+  queryName: String!
+  titlePath: String!
+  configKeyPath: String!
+  dataKeyPath: String!
+}
+
+type Tab {
+  name: String!
+  label: String!
+  page: Page!
+  visibilityCondition: String
+}
+
+type DashboardPanel implements IPanel {
+  name: String
+  rows: [DashboardPanelRow!]
+}
+
+type DashboardPanelRow implements IPanelRow {
+  name: String!
+  title: String
+  titleVariant: String
+  layout: Number
+  hidden: Boolean
+  visibilityCondition: String
+  elements: [Widget!]
+}
+
+type Preview {
+  headerCard: Card
+  panel: Panel
+}
+
+interface ICard implements IElement {
+  name: String
+  component: String
+  config: JSON
+}
+
+interface QuickApp {
+  url: String
+  appPreference: String
+  target: Boolean
+}
+
+type CardRow {
+  name: String
+  paths: [String!]
+  expression: String
+  icon: String
+  component: String
+}
+
+type Card implements ICard & IRowElement & IElement {
+  name: String
+  component: String!
+  config: JSON
+  cols: Int
+  title: String
+  rows: [CardRow]
+}
+
+type Widget implements ICard & IRowElement & IElement & QuickApp {
+  id: String!
+  name: String
+  title: String
+  description: String
+  component: String
+  config: JSON
+  cols: Int
+  table: AnyTable
+}
+
+type ExternalWidget {
+  id: String
+  name: String
+  description: String
+  visibilityCondition: String
+  config: JSON
+}
+
+type ViewerOptions {
+  thumbnails: Boolean
+  pageNavigation: Boolean
+  lazyLoading: Boolean
+}
+
+type ViewerToolbar {
+  menuItems: [MenuItem!]!
+  actionButton: ActionButton
+}
+
+type Viewer {
+  documentActions: [MenuItem!]
+  options: ViewerOptions
+  toolbar: ViewerToolbar
+}

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

@@ -0,0 +1,30 @@
+interface IPanel {
+    name: String
+    rows: [IPanelRow!]
+    dataType: String
+}
+
+interface IPanelRow {
+    elements: [IRowElement!]
+    name: String
+    title: String
+    titleVariant: String
+    visibilityCondition: String
+}
+
+type Panel implements IPanel {
+    columns: Int
+    isGrouped: Boolean
+    name: String
+    rows: [PanelRow!]!
+    dataType: String
+}
+
+type PanelRow implements IPanelRow {
+    elements: [IRowElement!]
+    hasDivider: Boolean
+    name: String
+    title: String
+    titleVariant: String
+    visibilityCondition: String
+}

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

@@ -0,0 +1,55 @@
+
+type PageQuery {
+    getPageConfig(path : String) : Page
+}
+
+type WidgetQuery {
+    list(search: String) : [Widget!]
+    get(path : String) : Widget
+}
+
+type ThemeQuery {
+    get(path: String): Theme
+}
+
+type ConfigQuery {
+    pages : PageQuery
+    widgets : WidgetQuery
+    tests: TestQuery
+    themes: ThemeQuery
+    data : DataQuery
+}
+
+type DataQuery {
+    get(path : String) : [DataResult!]
+    list(path : String) : [String]
+    getSeedConfig(path: String): SeedConfigResult
+}
+
+type DataResult {
+  config: DataConfig
+  data: JSON!
+}
+
+type DataConfig {
+  severity: String
+}
+
+type SeedConfigResult {
+  typeName: String!
+  updateMethod: String
+  updateInputType: String
+  createMethod: String
+  createInputType: String
+  referenceByIdPaths: [String]
+  referencePaths: [String]
+  doNotUpdate: Boolean
+  doNotDelete: Boolean
+  uniqueColumns: [String]
+}
+
+type GQLQuery {
+  queryName: String
+  operationName: String
+  variableDefinitions: JSON
+}