@docupace/ihub-config 1.0.0

package/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/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/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
+}

package/model/graphs/config/selectOptions.graphql

@@ -0,0 +1,47 @@
+interface ISelectOptions {
+    type: String
+}
+
+type SelectOptionsFilter {
+    path: String
+}
+
+type QuerySelectOptions implements ISelectOptions {
+    type: String
+    labelProp: String # defaults to "name" in ui
+    valueProp: String # defaults to "id" in ui
+    queryName: String!
+    variableDefinitions: JSON
+    variables: JSON
+    paths: [String!]!
+    operationName: String
+    expression: String
+    maxRows: Int
+    variablesExpressions: JSON
+    responsePathPrefix: String
+    where: WhereFilterConfig
+    filter: SelectOptionsFilter
+    excludeId: Boolean
+    queryOnTyping: Boolean  # if true, query will be triggered on typing
+    minLength: Int # minimum length of input to trigger query
+}
+
+type ValueSelectOptions implements ISelectOptions {
+    type: String
+    values: [SelectValue!]!
+}
+
+type SelectValue {
+    label: String!
+    value: JSON!
+}
+
+type DropdownSelectOptions implements ISelectOptions {
+    type: String
+    dropdownName: String!
+}
+
+type WhereFilterConfig {
+  type: String!
+  value: JSON
+}

package/model/graphs/config/table.graphql

@@ -0,0 +1,97 @@
+
+interface ITable  {
+    dataType: String
+    selection: TableSelection
+    disableColumnSorting: Boolean
+    disableRowClick: Boolean
+    queryName: String!
+    operationName: String
+    variableDefinitions: JSON
+    variablesExpressions: JSON
+    filter: TableFilter
+    search: SimpleSearch
+    menuItems: [MenuItem!]
+    columns: [Column!]!
+    rowMenuItems: [MenuItem!]
+    preview: Preview
+    cardView: CardView
+    orderBy: [OrderBy!]
+    flattenDataKey: String
+    actionButton: ActionButton
+    pagingMode: String
+    maxRows: Int
+    pageSizeOptions: [Int!]
+    defaultPageSize: Int
+    useCardView: Boolean
+    whereFilter: WhereFilter
+    whereFilterName: String
+    emptyStateMessage: String
+    unstructuredData: Boolean
+}
+
+type OrderBy {
+    path: String!
+    orderType: OrderType!
+}
+
+type TableSelection {
+  enabled: Boolean
+  label: String
+  action: String
+  visibilityCondition: String
+}
+
+type Table implements ITable
+
+type NamedTable implements ITable {
+    name: String
+}
+
+type TabbedTable {
+  tabs: [TableTab!]!
+}
+
+union AnyTable = Table | TabbedTable
+
+type TableTab {
+  name : String!
+  label: String!
+  table: Table!
+  visibilityCondition: String
+}
+
+type TableFilter {
+    criteria: [TableCriteria!]!
+}
+
+type TableCriteria {
+    name: String!
+    label: String!
+    labelProp: String
+    path: String!
+    dataType: String
+    selectOptions: QuerySelectOptions
+}
+
+type Column {
+    name: String!
+    label: String!
+    visible: Boolean
+    paths: [String!]
+    expression: String
+    component: String
+    sortable: Boolean
+    flex: Float
+}
+
+type SimpleSearch {
+    filterType: String
+    searchBy: String
+    placeholder: String
+    selectOptions: QuerySelectOptions!
+}
+
+type WhereFilter {
+    type: String!
+    value: JSON!
+}

package/model/graphs/config/tests.graphql

@@ -0,0 +1,16 @@
+
+type Test {
+    name : String!
+    description: String
+    configPath : String!
+}
+
+type TestResults {
+    items : [Test!]!
+}
+
+type TestQuery {
+    list(path : String!, search: String) : TestResults
+    getConfig(path : String) : JSON!
+}
+

package/model/graphs/config/theme.graphql

@@ -0,0 +1,41 @@
+type Base64Image {
+  "Base64 encoded image data"
+  data: String!
+  "MIME type of the image (e.g. 'image/png', 'image/jpeg')"
+  mimeType: String!
+  "Unique hash of the image data for caching purposes"
+  hash: String!
+}
+
+type Theme {
+    name: String
+    "Base64 encoded logo image data"
+    logoImage: Base64Image
+    """
+    @deprecated Use logoImage instead
+    SVG logo image data in string format
+    """
+    logoSvg: String
+    "Base64 encoded sidebar logo image data"
+    sidebarLogoImage: Base64Image
+    """
+    @deprecated Use sidebarLogoImage instead
+    SVG sidebar logo image data in string format
+    """
+    sidebarLogoSvg: String
+    "Base64 encoded login logo image data"
+    loginLogoImage: Base64Image
+    """
+    @deprecated Use loginLogoImage instead
+    SVG login logo image data in string format
+    """
+    loginLogoSvg: String
+    "Base64 encoded login background image data"
+    loginBackgroundImage: Base64Image
+    """
+    @deprecated Use loginBackgroundImage instead
+    SVG login background image data in string format
+    """
+    loginBackgroundSvg: String
+    colors: JSON
+}

package/model/graphs/config/ui-components.graphql

@@ -0,0 +1,11 @@
+type TextElement implements IRowElement & IElement {
+    color: String
+    cols: Int
+    fontSize: String
+    name: String
+    sx: JSON
+    value: String
+    valueExpression: String
+    variant: String
+    visibilityCondition: String
+}

package/model/graphs/domains/scalars.graphql

@@ -0,0 +1,3 @@
+scalar Number
+
+scalar JSON

package/model/graphs/filter.graphql

@@ -0,0 +1,5 @@
+
+enum OrderType {
+    ASC
+    DESC
+}

package/model/graphs/schema.graphql

@@ -0,0 +1,7 @@
+type Query {
+  config: ConfigQuery
+}
+
+type Mutation {
+  config: ConfigMutation
+}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@docupace/ihub-config",
+  "version": "1.0.0",
+  "description": "Reusable config GraphQL extension and standalone server",
+  "main": "dist/index.js",
+  "type": "module",
+  "keywords": [
+    "graphql",
+    "config",
+    "extension"
+  ],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@docupace/ihub-cache": "1.0.1",
+    "@docupace/ihub-core": "0.0.114-alpha.1",
+    "axios": "^1.13.5",
+    "cross-env": "^7.0.3",
+    "dotenv": "^16.4.1",
+    "graphql": "^16.8.1",
+    "js-yaml": "^4.1.0",
+    "lodash": "^4.17.21",
+    "pino": "^10.3.1",
+    "simple-git": "^3.22.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/lodash": "^4.17.7",
+    "@types/node": "^20.10.6",
+    "cpx": "^1.5.0",
+    "eslint": "8",
+    "jest": "^29.7.0",
+    "nock": "^13.5.6",
+    "pino-pretty": "^13.1.2",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.1",
+    "tsx": "^4.11.2",
+    "typescript": "^5.3.3"
+  },
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "model",
+    "README.md",
+    ".env.example"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "test": "NODE_OPTIONS='--experimental-vm-modules' jest",
+    "test:coverage": "NODE_OPTIONS='--experimental-vm-modules' jest --coverage",
+    "start:dev": "cross-env NODE_ENV=development tsx watch --clear-screen --no-cache src/server.ts --log-level debug | pino-pretty",
+    "start": "node dist/server.js",
+    "build": "rm -rf dist && tsc && cpx \"model/**/*.yaml\" ./dist/model && cpx \"model/**/*.graphql\" ./dist/model",
+    "start:build": "rm -rf dist && tsc && cpx \"model/**/*.yaml\" ./dist/model && cpx \"model/**/*.graphql\" ./dist/model && node dist/server.js",
+    "lint": "eslint \"src/**/*.{js,jsx,ts,tsx}\" \"tests/**/*.{js,jsx,ts,tsx}\" \"model/**/*.{js,jsx,ts,tsx}\"",
+    "lint:fix": "eslint --fix \"src/**/*.{js,jsx,ts,tsx}\" \"tests/**/*.{js,jsx,ts,tsx}\" \"model/**/*.{js,jsx,ts,tsx}\""
+  }
+}