@docupace/ihub-config 1.1.21 → 1.1.22-admin.2

package/model/graphs/config/menu.graphql

@@ -1,54 +1,60 @@
-interface IMenuItem {
-    name: String!
-    label: String!
-    icon: String
-    url: String
-    color: String
-    action: String
-    component: String
-    description: String
-    visibilityCondition: String
-    disabledCondition: 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
-    disabledCondition: String
-    config: JSON
-}
-
-type ActionButton implements IMenuItem {
-    name: String!
-    label: String!
-    icon: String
-    url: String
-    color: String
-    variant: ActionButtonVariant
-    component: String
-    action: String
-    disabled: Boolean
-    menuItems: [MenuItem!]
-    """
-    Reference to a dynamic menu configuration.
-    When set, menuItems will be loaded from the backend instead of static config.
-    """
-    dynamicMenuRef: String
-    visibilityCondition: String
-    description: String
-}
-
-enum ActionButtonVariant {
-    INLINE
-    DROPDOWN
-    INLINE_DROPDOWN
-}
+interface IMenuItem {
+    name: String!
+    label: String!
+    icon: String
+    url: String
+    color: String
+    action: String
+    component: String
+    description: String
+    visibilityCondition: String
+    disabledCondition: 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
+    disabledCondition: String
+    config: JSON
+    """
+    Child menu items. When present, this item acts as a collapsible group
+    header rather than a navigable leaf (consumers should treat a MenuItem
+    with `items` and no `url` as a group).
+    """
+    items: [MenuItem!]
+}
+
+type ActionButton implements IMenuItem {
+    name: String!
+    label: String!
+    icon: String
+    url: String
+    color: String
+    variant: ActionButtonVariant
+    component: String
+    action: String
+    disabled: Boolean
+    menuItems: [MenuItem!]
+    """
+    Reference to a dynamic menu configuration.
+    When set, menuItems will be loaded from the backend instead of static config.
+    """
+    dynamicMenuRef: String
+    visibilityCondition: String
+    description: String
+}
+
+enum ActionButtonVariant {
+    INLINE
+    DROPDOWN
+    INLINE_DROPDOWN
+}

package/model/graphs/config/mutation.graphql

@@ -1,30 +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
-}
+
+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/model/graphs/config/page.graphql

@@ -1,257 +1,264 @@
-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]
-  breadcrumbs: [Breadcrumb!]
-}
-
-type TablePage implements Page {
-  title: String
-  component: String
-  description: String
-  actionButton: ActionButton
-  table: AnyTable!
-  panel: Panel
-  config: JSON
-  breadcrumbs: [Breadcrumb!]
-}
-
-type ComponentPage implements Page {
-  title: String
-  description: String
-  component: String
-  panel: Panel
-  config: JSON
-  mutations: JSON
-  breadcrumbs: [Breadcrumb!]
-}
-
-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
-  breadcrumbs: [Breadcrumb!]
-}
-
-type DetailsPage implements Page {
-  title: String
-  description: String
-  panel: Panel
-  config: JSON
-  breadcrumbs: [Breadcrumb!]
-}
-
-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
-  breadcrumbs: [Breadcrumb!]
-  config: JSON
-}
-
-type AnyPage implements Page {
-  title: String
-  description: String
-  tables: [NamedTable!]
-  panels: [Panel!]
-  tabbedPages: [TabbedPage!]
-  config: JSON
-  breadcrumbs: [Breadcrumb!]
-}
-
-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
-  breadcrumbs: [Breadcrumb!]
-  workItemsQueryParams: BaseWorkItemQueryParams
-}
-
-type BaseWorkItemQueryParams {
-    docIds: [Int!]
-    excludeFields: [String!]
-    excludeInitialData: Boolean
-    format: String
-    includeFields: [String!]
-    oldNames: Boolean
-    onlyInitialData: Boolean
-    sorted: Boolean
-    performMapping: String
-}
-
-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
-  config: JSON
-}
-
-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
-}
-
-type Breadcrumb {
-  label: String!
-  path: String
-  isLabelExpression: Boolean
-  isPathExpression: Boolean
+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]
+  breadcrumbs: [Breadcrumb!]
+}
+
+type TablePage implements Page {
+  title: String
+  component: String
+  description: String
+  actionButton: ActionButton
+  table: AnyTable!
+  panel: Panel
+  config: JSON
+  breadcrumbs: [Breadcrumb!]
+}
+
+type ComponentPage implements Page {
+  title: String
+  description: String
+  component: String
+  panel: Panel
+  config: JSON
+  mutations: JSON
+  breadcrumbs: [Breadcrumb!]
+}
+
+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
+  breadcrumbs: [Breadcrumb!]
+}
+
+type DetailsPage implements Page {
+  title: String
+  description: String
+  panel: Panel
+  config: JSON
+  breadcrumbs: [Breadcrumb!]
+}
+
+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
+  breadcrumbs: [Breadcrumb!]
+  config: JSON
+}
+
+type AnyPage implements Page {
+  title: String
+  description: String
+  tables: [NamedTable!]
+  panels: [Panel!]
+  tabbedPages: [TabbedPage!]
+  config: JSON
+  breadcrumbs: [Breadcrumb!]
+}
+
+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
+  breadcrumbs: [Breadcrumb!]
+  workItemsQueryParams: BaseWorkItemQueryParams
+}
+
+type BaseWorkItemQueryParams {
+    docIds: [Int!]
+    excludeFields: [String!]
+    excludeInitialData: Boolean
+    format: String
+    includeFields: [String!]
+    oldNames: Boolean
+    onlyInitialData: Boolean
+    sorted: Boolean
+    performMapping: String
+}
+
+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
+  config: JSON
+}
+
+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
+}
+
+type Breadcrumb {
+  label: String
+  path: String
+  isLabelExpression: Boolean
+  isPathExpression: Boolean
+  """
+  Dot-notation paths (e.g. "name", "folder.title") to try, in order, against
+  the already-fetched page record to compute the breadcrumb label. Used only
+  when `isLabelExpression` is not set. If none of the paths resolve to a
+  non-empty value, the client falls back to the record's `id`.
+  """
+  valuePaths: [String!]
 }