@things-factory/dataset 5.0.0-alpha.33 → 5.0.0-alpha.36

package/client/bootstrap.js

@@ -1,11 +1,14 @@
-import { OxGristEditorCode } from '@operato/app/grist-editor/ox-grist-editor-code.js'
-import { OxGristEditorPartitionKeys } from '@operato/app/grist-editor/ox-grist-editor-partition-keys.js'
+import '@operato/app/filter-renderer.js' /* register resource-object filter renderer */
+
 import {
   OxGristRendererJson5,
   registerEditor as registerGristEditor,
   registerRenderer as registerGristRenderer
 } from '@operato/data-grist'
+
+import { OxGristEditorCode } from '@operato/app/grist-editor/ox-grist-editor-code.js'
 import { OxGristEditorDataItemSpec } from '@operato/dataset/grist-editor'
+import { OxGristEditorPartitionKeys } from '@operato/app/grist-editor/ox-grist-editor-partition-keys.js'
 
 export default function bootstrap() {
   registerGristEditor('data-item-spec', OxGristEditorDataItemSpec)

package/client/pages/data-entry/data-entry-form.js

@@ -1,10 +1,11 @@
 import '@operato/dataset/ox-data-entry-form.js'
 
-import { LitElement, css, html } from 'lit'
-import { i18next, localize } from '@operato/i18n'
+import gql from 'graphql-tag'
+import { css, html, LitElement } from 'lit'
 
 import { client } from '@operato/graphql'
-import gql from 'graphql-tag'
+import { i18next, localize } from '@operato/i18n'
+import { ScrollbarStyles } from '@operato/styles'
 
 class DataEntryForm extends localize(i18next)(LitElement) {
   static get properties() {
@@ -15,18 +16,19 @@ class DataEntryForm extends localize(i18next)(LitElement) {
 
   static get styles() {
     return [
+      ScrollbarStyles,
       css`
         :host {
           display: flex;
           flex-direction: column;
 
           background-color: #fff;
-          overflow: auto;
         }
 
         ox-data-entry-form {
           flex: 1;
-          margin: 10px;
+          padding: 10px;
+          overflow: auto;
         }
 
         .button-container {

package/client/pages/data-entry/data-entry-list-page.js

@@ -74,90 +74,6 @@ const showEntryView = async (columns, data, column, record, rowIndex) => {
   }
 }
 
-const showMonitorView = (columns, data, column, record, rowIndex) => {
-  const { name, monitorType, monitorView } = record
-  const title = `${name} - ${i18next.t('title.data-monitor-view')}`
-
-  switch (monitorType) {
-    case 'generated':
-      openPopup(html` <div style="background-color: white;">Under construction</div> `, {
-        backdrop: true,
-        size: 'large',
-        title
-      })
-      break
-
-    case 'board':
-      const board = {
-        id: monitorView
-      }
-      openPopup(
-        html`
-          <ox-board-viewer
-            style="background-color: white;"
-            .board=${board}
-            .provider=${provider}
-            hide-fullscreen
-            hide-navigation
-          ></ox-board-viewer>
-        `,
-        {
-          closable: true,
-          backdrop: true,
-          size: 'large',
-          title
-        }
-      )
-
-      // navigate(`board-viewer/${monitorView}?interactive=true&title=${title}`)
-      break
-
-    case 'page':
-      navigate(monitorView)
-      break
-
-    case 'external':
-      window.open(monitorView, '_blank')
-      break
-  }
-}
-
-const showReportView = (columns, data, column, record, rowIndex) => {
-  const { name, reportType, reportView } = record
-  const title = `${name} - ${i18next.t('title.data-report-view')}`
-
-  switch (reportType) {
-    case 'generated':
-      openPopup(html` <div style="background-color: white;">Under construction</div> `, {
-        backdrop: true,
-        size: 'large',
-        title
-      })
-      break
-
-    case 'custom':
-      const board = {
-        id: reportView
-      }
-      openPopup(html` <div style="background-color: white;">Under construction</div> `, {
-        closable: true,
-        backdrop: true,
-        size: 'large',
-        title
-      })
-
-      break
-
-    case 'page':
-      navigate(reportView)
-      break
-
-    case 'external':
-      window.open(reportView, '_blank')
-      break
-  }
-}
-
 export class DataEntryListPage extends connect(store)(localize(i18next)(PageView)) {
   static get properties() {
     return {
@@ -250,22 +166,6 @@ export class DataEntryListPage extends connect(store)(localize(i18next)(PageView
             click: showEntryView
           }
         },
-        {
-          type: 'gutter',
-          gutterName: 'button',
-          icon: 'analytics',
-          handlers: {
-            click: showMonitorView
-          }
-        },
-        {
-          type: 'gutter',
-          gutterName: 'button',
-          icon: 'newspaper',
-          handlers: {
-            click: showReportView
-          }
-        },
         {
           type: 'string',
           name: 'name',
@@ -297,11 +197,11 @@ export class DataEntryListPage extends connect(store)(localize(i18next)(PageView
             options: [
               {},
               {
-                display: 'Manually Collected',
+                display: i18next.t('text.manually collected'),
                 value: 'manual'
               },
               {
-                display: 'Automatically Collected',
+                display: i18next.t('text.automatically collected'),
                 value: 'automatic'
               }
             ]

package/client/pages/data-ooc/data-ooc-list-page.js

@@ -280,7 +280,7 @@ export class DataOocListPage extends connect(store)(localize(i18next)(PageView))
         {
           type: 'datetime',
           name: 'collectedAt',
-          header: i18next.t('field.collected_at'),
+          header: i18next.t('field.collected-at'),
           sortable: true,
           width: 180,
           imex: true

package/client/pages/data-report/data-report-list-page.js

@@ -0,0 +1,462 @@
+import '@operato/data-grist'
+import '@operato/board/ox-board-viewer.js'
+
+import { CommonGristStyles, ScrollbarStyles } from '@operato/styles'
+import { PageView, navigate, store } from '@operato/shell'
+import { css, html } from 'lit'
+import { i18next, localize } from '@operato/i18n'
+
+import JSON5 from 'json5'
+import { OxDataUseCase } from '@operato/dataset'
+import { client } from '@operato/graphql'
+import { connect } from 'pwa-helpers/connect-mixin'
+import gql from 'graphql-tag'
+import { openPopup } from '@operato/layout'
+import { provider } from '@things-factory/board-ui'
+
+const USECASE_OPTIONS = () => {
+  return ['', ...OxDataUseCase.getUseCaseNames()].map(name => {
+    return {
+      display: name,
+      value: name
+    }
+  })
+}
+
+const showMonitorView = (columns, data, column, record, rowIndex) => {
+  const { name, monitorType, monitorView } = record
+  const title = `${name} - ${i18next.t('title.data-monitor-view')}`
+
+  switch (monitorType) {
+    case 'generated':
+      openPopup(html` <div style="background-color: white;">Under construction</div> `, {
+        backdrop: true,
+        size: 'large',
+        title
+      })
+      break
+
+    case 'board':
+      const board = {
+        id: monitorView
+      }
+      openPopup(
+        html`
+          <ox-board-viewer
+            style="background-color: white;"
+            .board=${board}
+            .provider=${provider}
+            hide-fullscreen
+            hide-navigation
+          ></ox-board-viewer>
+        `,
+        {
+          closable: true,
+          backdrop: true,
+          size: 'large',
+          title
+        }
+      )
+
+      // navigate(`board-viewer/${monitorView}?interactive=true&title=${title}`)
+      break
+
+    case 'page':
+      navigate(monitorView)
+      break
+
+    case 'external':
+      window.open(monitorView, '_blank')
+      break
+  }
+}
+
+const showReportView = (columns, data, column, record, rowIndex) => {
+  const { name, reportType, reportView } = record
+  const title = `${name} - ${i18next.t('title.data-report-view')}`
+
+  switch (reportType) {
+    case 'generated':
+      openPopup(html` <div style="background-color: white;">Under construction</div> `, {
+        backdrop: true,
+        size: 'large',
+        title
+      })
+      break
+
+    case 'custom':
+      const board = {
+        id: reportView
+      }
+      openPopup(html` <div style="background-color: white;">Under construction</div> `, {
+        closable: true,
+        backdrop: true,
+        size: 'large',
+        title
+      })
+
+      break
+
+    case 'page':
+      navigate(reportView)
+      break
+
+    case 'external':
+      window.open(reportView, '_blank')
+      break
+  }
+}
+
+export class DataReportListPage extends connect(store)(localize(i18next)(PageView)) {
+  static get properties() {
+    return {
+      active: String,
+      gristConfig: Object,
+      filters: Object,
+      sorters: Object,
+      mode: String
+    }
+  }
+
+  static get styles() {
+    return [
+      ScrollbarStyles,
+      CommonGristStyles,
+      css`
+        :host {
+          display: flex;
+
+          width: 100%;
+
+          --grid-record-emphasized-background-color: red;
+          --grid-record-emphasized-color: yellow;
+        }
+      `
+    ]
+  }
+
+  get context() {
+    return {
+      title: i18next.t('title.data-entry list'),
+      help: 'dataset/data-entry-list'
+    }
+  }
+
+  render() {
+    const mode = 'CARD'
+
+    return html`
+      <ox-grist
+        .mode=${mode}
+        .config=${this.gristConfig}
+        .filters=${this.filters}
+        .orders=${this.orders}
+        .fetchHandler=${this.fetchHandler.bind(this)}
+      >
+        <div slot="headroom" id="filters">
+          <div id="filters">
+            <ox-filters-form></ox-filters-form>
+          </div>
+
+          <div id="sorters">
+            Sort
+            <mwc-icon
+              @click=${e => {
+                const target = e.currentTarget
+                this.renderRoot.querySelector('#sorter-control').open({
+                  right: 0,
+                  top: target.offsetTop + target.offsetHeight
+                })
+              }}
+              >expand_more</mwc-icon
+            >
+            <ox-popup id="sorter-control">
+              <ox-sorters-control> </ox-sorters-control>
+            </ox-popup>
+          </div>
+        </div>
+      </ox-grist>
+    `
+  }
+
+  get grist() {
+    return this.renderRoot.querySelector('ox-grist')
+  }
+
+  async pageInitialized(lifecycle) {
+    this.gristConfig = {
+      list: {
+        thumbnail: 'monitorView',
+        fields: ['name', 'description'],
+        details: ['schedule', 'type', 'useCase', 'latestCollectedAt', 'prevSchedule', 'nextSchedule']
+      },
+      columns: [
+        {
+          type: 'gutter',
+          gutterName: 'button',
+          icon: 'newspaper',
+          handlers: {
+            click: showReportView
+          }
+        },
+        {
+          type: 'gutter',
+          gutterName: 'button',
+          icon: 'analytics',
+          handlers: {
+            click: showMonitorView
+          }
+        },
+        {
+          type: 'string',
+          name: 'name',
+          header: i18next.t('field.name'),
+          record: {
+            editable: false
+          },
+          filter: 'search',
+          sortable: true,
+          width: 150
+        },
+        {
+          type: 'string',
+          name: 'description',
+          header: i18next.t('field.description'),
+          record: {
+            editable: false
+          },
+          filter: 'search',
+          width: 200
+        },
+        {
+          type: 'select',
+          name: 'type',
+          label: true,
+          header: i18next.t('field.type'),
+          record: {
+            editable: false,
+            options: [
+              {},
+              {
+                display: i18next.t('text.manually collected'),
+                value: 'manual'
+              },
+              {
+                display: i18next.t('text.automatically collected'),
+                value: 'automatic'
+              }
+            ]
+          },
+          sortable: true,
+          filter: true,
+          width: 60
+        },
+        {
+          type: 'select',
+          name: 'useCase',
+          label: true,
+          header: i18next.t('field.use-case'),
+          record: {
+            editable: false,
+            options: USECASE_OPTIONS
+          },
+          sortable: true,
+          filter: {
+            operator: 'eq',
+            options: USECASE_OPTIONS /* in case select options type is a function, filter should have its own options */
+          },
+          width: 80
+        },
+        {
+          type: 'crontab',
+          name: 'schedule',
+          label: true,
+          header: i18next.t('field.schedule'),
+          record: {
+            editable: false
+          },
+          width: 80,
+          label: true
+        },
+        {
+          type: 'resource-object',
+          name: 'entryRole',
+          header: i18next.t('field.entry-role'),
+          record: {
+            editable: false
+          },
+          width: 120
+        },
+        {
+          type: 'resource-object',
+          name: 'supervisoryRole',
+          header: i18next.t('field.supervisory-role'),
+          record: {
+            editable: false
+          },
+          width: 120
+        },
+        {
+          type: 'datetime',
+          name: 'latestCollectedAt',
+          label: true,
+          header: i18next.t('field.latest-collected-at'),
+          record: {
+            editable: false
+          },
+          width: 180
+        },
+        {
+          type: 'datetime',
+          name: 'prevSchedule',
+          label: true,
+          header: i18next.t('field.prev-schedule'),
+          record: {
+            editable: false
+          },
+          width: 180
+        },
+        {
+          type: 'datetime',
+          name: 'nextSchedule',
+          label: true,
+          header: i18next.t('field.next-schedule'),
+          record: {
+            editable: false
+          },
+          width: 180
+        },
+        {
+          type: 'string',
+          name: 'monitorView',
+          hidden: true,
+          record: {
+            editable: false,
+            renderer: function (value, column, record, rowIndex, field) {
+              const type = record.monitorType !== 'board' ? 'string' : 'image'
+              value = record.monitorType !== 'board' ? value : record.monitorBoard?.thumbnail
+
+              return getRenderer(type)(value, column, record, rowIndex, field)
+            }
+          }
+        }
+      ],
+      rows: {
+        selectable: {
+          multiple: false
+        },
+        handlers: {
+          click: showReportView
+        },
+        classifier: function (record, rowIndex) {}
+      },
+      sorters: [
+        {
+          name: 'name'
+        }
+      ]
+    }
+
+    await this.updateComplete
+
+    this.grist.fetch()
+  }
+
+  async pageUpdated(changes, lifecycle) {
+    if (this.active) {
+      await this.updateComplete
+
+      var filters = lifecycle.params?.['filters']
+      if (filters) {
+        try {
+          filters = JSON5.parse(filters)
+          this.filters = filters
+        } catch (e) {
+          console.error(`filters parameter parsing error: ${e}`)
+        }
+      }
+
+      var sorters = lifecycle.params?.['sorters']
+      if (sorters) {
+        try {
+          sorters = JSON5.parse(sorters)
+          this.sorters = sorters
+        } catch (e) {
+          console.error(`sorters parameter parsing error: ${e}`)
+        }
+      }
+
+      this.grist.fetch()
+    }
+  }
+
+  async fetchHandler({ page, limit, sortings = [], filters = [] }) {
+    const response = await client.query({
+      query: gql`
+        query ($filters: [Filter!], $pagination: Pagination, $sortings: [Sorting!]) {
+          responses: dataSetsForReport(filters: $filters, pagination: $pagination, sortings: $sortings) {
+            items {
+              id
+              name
+              description
+              partitionKeys
+              active
+              type
+              useCase
+              schedule
+              timezone
+              entryRole {
+                id
+                name
+              }
+              supervisoryRole {
+                id
+                name
+              }
+              monitorType
+              monitorView
+              monitorBoard {
+                thumbnail
+              }
+              reportType
+              reportView
+              updater {
+                id
+                name
+              }
+              updatedAt
+              dataItems {
+                name
+                description
+                sequence
+                active
+                tag
+                type
+                unit
+                options
+                quota
+                spec
+              }
+              latestCollectedAt
+              nextSchedule
+              prevSchedule
+            }
+            total
+          }
+        }
+      `,
+      variables: {
+        filters,
+        pagination: { page, limit },
+        sortings
+      }
+    })
+
+    return {
+      total: response.data.responses.total || 0,
+      records: response.data.responses.items || []
+    }
+  }
+}
+
+window.customElements.define('data-report-list-page', DataReportListPage)

package/client/pages/data-sample/data-sample-list-page.js

@@ -239,7 +239,7 @@ export class DataSampleListPage extends connect(store)(localize(i18next)(PageVie
         {
           type: 'datetime',
           name: 'collectedAt',
-          header: i18next.t('field.collected_at'),
+          header: i18next.t('field.collected-at'),
           sortable: true,
           width: 180,
           imex: true

package/client/pages/data-sensor/data-sensor-list-page.js

@@ -1,15 +1,15 @@
 import '@operato/data-grist'
 
-import { CommonButtonStyles, ScrollbarStyles } from '@operato/styles'
-import { PageView, store } from '@operato/shell'
+import gql from 'graphql-tag'
 import { css, html } from 'lit'
-import { i18next, localize } from '@operato/i18n'
+import { connect } from 'pwa-helpers/connect-mixin'
 
 import { client } from '@operato/graphql'
-import { connect } from 'pwa-helpers/connect-mixin'
-import gql from 'graphql-tag'
-import { isMobileDevice } from '@operato/utils'
+import { i18next, localize } from '@operato/i18n'
 import { notify } from '@operato/layout'
+import { PageView, store } from '@operato/shell'
+import { CommonButtonStyles, ScrollbarStyles } from '@operato/styles'
+import { isMobileDevice } from '@operato/utils'
 
 export class DataSensorListPage extends connect(store)(localize(i18next)(PageView)) {
   static get properties() {
@@ -274,7 +274,7 @@ export class DataSensorListPage extends connect(store)(localize(i18next)(PageVie
         {
           type: 'datetime',
           name: 'collectedAt',
-          header: i18next.t('field.collected_at'),
+          header: i18next.t('field.collected-at'),
           record: {
             editable: false
           },