@operato/dataset 1.0.0-alpha.9 → 1.0.0-beta.2

package/package.json

@@ -3,12 +3,19 @@
   "description": "WebApplication dataset supporting components following open-wc recommendations",
   "license": "MIT",
   "author": "heartyoh",
-  "version": "1.0.0-alpha.9",
+  "version": "1.0.0-beta.2",
   "main": "dist/src/index.js",
   "module": "dist/src/index.js",
   "exports": {
     ".": "./dist/src/index.js",
-    "./ox-data-entry-form.js": "./dist/src/ox-data-entry-form.js"
+    "./grist-editor": "./dist/src/grist-editor/index.js",
+    "./grist-editor/ox-grist-editor-data-item-spec.js": "./dist/src/grist-editor/ox-grist-editor-data-item-spec.js",
+    "./ox-data-entry-form.js": "./dist/src/ox-data-entry-form.js",
+    "./ox-data-item-spec.js": "./dist/src/ox-data-item-spec.js",
+    "./ox-data-ooc-view.js": "./dist/src/ox-data-ooc-view.js",
+    "./ox-data-sample-view.js": "./dist/src/ox-data-sample-view.js",
+    "./ox-data-use-case.js": "./dist/src/ox-data-use-case.js",
+    "./types.js": "./dist/src/types.js"
   },
   "publishConfig": {
     "access": "public",
@@ -35,15 +42,16 @@
     "@material/mwc-button": "^0.25.3",
     "@material/mwc-icon": "^0.25.3",
     "@material/mwc-icon-button": "^0.25.3",
-    "@operato/graphql": "^1.0.0-alpha.9",
-    "@operato/i18n": "^1.0.0-alpha.9",
-    "@operato/input": "^1.0.0-alpha.9",
-    "@operato/layout": "^1.0.0-alpha.9",
-    "@operato/property-editor": "^1.0.0-alpha.9",
-    "@operato/shell": "^1.0.0-alpha.9",
-    "@operato/styles": "^1.0.0-alpha.9",
-    "@operato/utils": "^1.0.0-alpha.9",
-    "lit": "^2.2.0"
+    "@operato/data-grist": "^1.0.0-beta.2",
+    "@operato/graphql": "^1.0.0-beta.2",
+    "@operato/i18n": "^1.0.0-beta.2",
+    "@operato/input": "^1.0.0-beta.2",
+    "@operato/layout": "^1.0.0-beta.2",
+    "@operato/property-editor": "^1.0.0-beta.2",
+    "@operato/shell": "^1.0.0-beta.2",
+    "@operato/styles": "^1.0.0-beta.2",
+    "@operato/utils": "^1.0.0-beta.2",
+    "lit": "^2.2.1"
   },
   "devDependencies": {
     "@custom-elements-manifest/analyzer": "^0.4.17",
@@ -77,5 +85,5 @@
       "prettier --write"
     ]
   },
-  "gitHead": "fb82c87ab8b869139076c4e74c46309460b67d35"
+  "gitHead": "514a836d3f5e959695701ba41913aee18a1efe66"
 }

package/src/grist-editor/index.ts

@@ -0,0 +1,10 @@
+import { OxGristRendererJson5, registerEditor, registerRenderer } from '@operato/data-grist'
+
+import { OxGristEditorDataItemSpec } from './ox-grist-editor-data-item-spec'
+
+/* register grist renderer/editor for id */
+registerEditor('data-item-spec', OxGristEditorDataItemSpec)
+
+registerRenderer('data-item-spec', OxGristRendererJson5)
+
+export * from './ox-grist-editor-data-item-spec'

package/src/grist-editor/ox-grist-editor-data-item-spec.ts

@@ -0,0 +1,92 @@
+/**
+ * @license Copyright © HatioLab Inc. All rights reserved.
+ */
+
+import './ox-popup-data-item-spec.js'
+
+import { html } from 'lit'
+import { customElement } from 'lit/decorators.js'
+import { cloneDeep } from 'lodash-es'
+
+import { OxGristEditor } from '@operato/data-grist'
+import { i18next } from '@operato/i18n'
+import { openPopup, PopupHandle } from '@operato/layout'
+
+@customElement('ox-grist-editor-data-item-spec')
+export class OxGristEditorDataItemSpec extends OxGristEditor {
+  private popup?: PopupHandle
+
+  get editorTemplate() {
+    const value = typeof this.value === 'object' ? JSON.stringify(this.value) : this.value
+    return html` ${value || ''} `
+  }
+
+  async firstUpdated() {
+    await this.updateComplete
+
+    this.renderRoot.addEventListener('click', (e: Event) => {
+      e.stopPropagation()
+
+      this.openSelector()
+    })
+
+    this.openSelector()
+  }
+
+  async openSelector() {
+    if (this.popup) {
+      delete this.popup
+    }
+
+    var { options } = this.column.record
+
+    if (typeof options === 'function') {
+      options = await options.call(this, this.value, this.column, this.record, this.row, this.field)
+    }
+
+    const { name, help, objectified = false } = options
+
+    const confirmCallback = (newval: any) => {
+      this.dispatchEvent(
+        new CustomEvent('field-change', {
+          bubbles: true,
+          composed: true,
+          detail: {
+            before: this.value,
+            after: !objectified ? JSON.stringify(newval) : newval,
+            record: this.record,
+            column: this.column,
+            row: this.row
+          }
+        })
+      )
+    }
+
+    try {
+      var value: any =
+        !objectified && typeof this.value === 'string' ? JSON.parse(this.value) : cloneDeep(this.value || {})
+    } catch (e) {
+      var value: any = {}
+    }
+
+    /* 
+      주의 : 이 팝업 템플릿은 layout 모듈에 의해서 render 되므로, 
+      layout의 구성에 변화가 발생하면, 다시 render된다.
+      이 팝업이 떠 있는 상태에서, 또 다른 팝업이 뜨는 경우도 layout 구성의 변화를 야기한다. (overlay의 갯수의 증가)
+      이 경우 value, options, confirmCallback 등 클로져를 사용한 것들이 초기 바인딩된 값으로 다시 바인딩되게 되는데,
+      만약, 템플릿 내부에서 이들 속성의 레퍼런스가 변화했다면, 원래 상태로 되돌아가는 현상이 발생하게 된다.
+      따라서, 가급적 이들 속성의 레퍼런스를 변화시키지 않는 것이 좋다.
+    */
+    var template = html`
+      <ox-popup-data-item-spec .value=${value} .dataItem=${this.record} .confirmCallback=${confirmCallback}>
+      </ox-popup-data-item-spec>
+    `
+
+    this.popup = openPopup(template, {
+      backdrop: true,
+      size: 'large',
+      title: `${name?.toUpperCase() || ''} ${i18next.t('field.spec')}`,
+      help
+    })
+  }
+}

package/src/grist-editor/ox-popup-data-item-spec.ts

@@ -0,0 +1,90 @@
+import '../ox-data-item-spec.js'
+
+import { LitElement, css, html } from 'lit'
+import { customElement, property } from 'lit/decorators.js'
+
+import { DataItem } from '../types.js'
+import { ScrollbarStyles } from '@operato/styles'
+import { i18next } from '@operato/i18n'
+
+@customElement('ox-popup-data-item-spec')
+export class OxPopupDataItemSpec extends LitElement {
+  static styles = [
+    ScrollbarStyles,
+    css`
+      :host {
+        display: flex;
+        flex-direction: column;
+
+        background-color: #fff;
+
+        width: var(--overlay-center-normal-width, 50%);
+        height: var(--overlay-center-normal-height, 50%);
+      }
+
+      ox-data-item-spec {
+        flex: 1;
+        overflow-y: auto;
+      }
+
+      span {
+        flex: 1;
+
+        display: flex;
+        align-items: center;
+        justify-content: center;
+
+        color: var(--primary-color);
+      }
+
+      .button-container {
+        display: flex;
+        margin-left: auto;
+      }
+    `
+  ]
+
+  @property({ type: Object }) value: any
+  @property({ type: Object }) dataItem?: DataItem
+  @property({ type: Object }) confirmCallback!: (newval: any) => void
+
+  render() {
+    var dataItem = this.dataItem || {}
+
+    return html`
+      <ox-data-item-spec .value=${this.value} .dataItem=${dataItem} @change=${this.onChange.bind(this)}>
+      </ox-data-item-spec>
+
+      <div class="button-container">
+        <mwc-button @click=${this.onCancel.bind(this)}>${i18next.t('button.cancel')}</mwc-button>
+        <mwc-button @click=${this.onConfirm.bind(this)}>${i18next.t('button.confirm')}</mwc-button>
+      </div>
+    `
+  }
+
+  private onChange(e: CustomEvent) {
+    e.stopPropagation()
+
+    /* 
+      주의 : 이 팝업 템플릿은 layout 모듈에 의해서 render 되므로, 
+      layout의 구성에 변화가 발생하면, 다시 render된다.
+      이 팝업이 떠 있는 상태에서, 또 다른 팝업이 뜨는 경우도 layout 구성의 변화를 야기한다. (overlay의 갯수의 증가)
+      이 경우 value, options, confirmCallback 등 클로져를 사용한 것들이 초기 바인딩된 값으로 다시 바인딩되게 되는데,
+      만약, 템플릿 내부에서 이들 속성의 레퍼런스가 변화했다면, 원래 상태로 되돌아가는 현상이 발생하게 된다.
+      따라서, 가급적 이들 속성의 레퍼런스를 변화시키지 않는 것이 좋다.
+      (이 팝업 클래스를 템플릿으로 사용한 곳의 코드를 참조하세요.)
+      => 
+      이런 이유로, Object.assign(...)을 사용하였다.
+    */
+    this.value = e.detail
+  }
+
+  private onCancel(e: Event) {
+    history.back()
+  }
+
+  private onConfirm(e: Event) {
+    this.confirmCallback && this.confirmCallback(this.value)
+    history.back()
+  }
+}

package/src/index.ts

@@ -1 +1,6 @@
-export * from './ox-data-entry-form'
+export * from './ox-data-entry-form.js'
+export * from './ox-data-sample-view.js'
+export * from './ox-data-ooc-view.js'
+export * from './ox-data-item-spec.js'
+export * from './ox-data-use-case'
+export * from './types.js'

package/src/ox-data-entry-form.ts

@@ -1,30 +1,9 @@
 import '@operato/input/ox-input-file.js'
 
-import { LitElement, css, html } from 'lit'
+import { css, html, LitElement } from 'lit'
 import { customElement, property } from 'lit/decorators.js'
 
-type SelectOption = { text: string; value: string }
-type SelectOptions = SelectOption[]
-type TypeOptions = {
-  options?: SelectOptions
-  [prop: string]: any
-}
-
-export type DataItem = {
-  name: string
-  description: string
-  sequence: number
-  tag: string
-  type: string
-  options: TypeOptions
-  quota: number
-}
-
-export type DataSet = {
-  name: string
-  description: string
-  dataItems: DataItem[]
-}
+import { DataSet } from './types.js'
 
 @customElement('ox-data-entry-form')
 export class OxDataEntryForm extends LitElement {
@@ -51,6 +30,7 @@ export class OxDataEntryForm extends LitElement {
       background-color: var(--main-section-background-color);
       padding: var(--padding-default) 0;
     }
+
     div[name] {
       grid-column: span 2 / auto;
       font: var(--label-font);
@@ -75,6 +55,7 @@ export class OxDataEntryForm extends LitElement {
       padding: var(--input-field-padding);
       font: var(--input-field-font);
     }
+
     @media only screen and (max-width: 460px) {
       div[name] {
         grid-column: span 3 / auto;
@@ -93,28 +74,28 @@ export class OxDataEntryForm extends LitElement {
   }
 
   private onChange(e: Event) {
-    const value = this.buildValue()
+    this.value = this.buildValue()
 
     this.dispatchEvent(
       new CustomEvent('change', {
         bubbles: true,
         composed: true,
-        detail: value
+        detail: this.value
       })
     )
   }
 
   private buildInputs() {
-    const dataItems = this.dataSet!.dataItems
+    const dataItems = this.dataSet!.dataItems.filter(item => item.active)
 
     return (dataItems || []).map(dataItem => {
-      const { name, description, tag, type, quota = 1, options = {} } = dataItem
+      const { name, description, tag, type, quota = 1, options = {}, unit } = dataItem
 
       const samples = new Array(quota).fill(0)
-      const value = this.value?.[tag]
+      const value = this.value && this.value[tag]
 
       const elements = samples.map((_, idx) => {
-        const v = quota <= 1 ? value : value instanceof Array && value[idx]
+        const v = value instanceof Array ? value[idx] : idx === 0 ? value : undefined
 
         switch (type) {
           case 'select':
@@ -150,7 +131,7 @@ export class OxDataEntryForm extends LitElement {
       })
 
       return html` <label .title=${description}>
-        <div name>${name}</div>
+        <div name>${name}${unit ? `(${unit})` : ''}</div>
         <div elements>${elements}</div>
       </label>`
     })
@@ -160,19 +141,14 @@ export class OxDataEntryForm extends LitElement {
     const dataItems = this.dataSet!.dataItems
 
     return (dataItems || []).reduce((sum, dataItem) => {
-      const { tag, quota, type } = dataItem
+      const { tag, type } = dataItem
 
       const editors = Array.prototype.slice.call(
         this.renderRoot.querySelectorAll(`[name=${tag}]`) as NodeListOf<HTMLInputElement>
       ) as HTMLInputElement[]
 
       if (editors.length > 0) {
-        sum[tag] =
-          editors.length > 1
-            ? editors.map(editor => (type === 'boolean' ? editor.checked : editor.value))
-            : type === 'boolean'
-            ? editors[0].checked
-            : editors[0].value
+        sum[tag] = editors.map(editor => (type === 'boolean' ? editor.checked : editor.value))
       }
 
       return sum

package/src/ox-data-item-spec.ts

@@ -0,0 +1,74 @@
+import '@operato/property-editor/ox-properties-dynamic-view.js'
+
+import { css, html, LitElement, PropertyValues } from 'lit'
+import { customElement, property, queryAll, state } from 'lit/decorators.js'
+
+import { OxDataUseCase } from './ox-data-use-case.js'
+import { DataItem, DataItemSpecSet } from './types.js'
+
+@customElement('ox-data-item-spec')
+export class OxDataItemSpec extends LitElement {
+  static styles = css`
+    :host {
+      display: flex;
+      flex-direction: row;
+      border-bottom: var(--border-dark-color);
+      padding: var(--margin-default) 0;
+    }
+    [specName] {
+      font: var(--legend-font);
+      color: var(--legend-text-color);
+    }
+    [description] {
+      font: var(--form-sublabel-font);
+      opacity: 0.8;
+    }
+
+    form {
+      flex: 1;
+    }
+  `
+
+  @property({ type: Object }) value?: { [specSetName: string]: any }
+  @property({ type: Object }) dataItem?: DataItem
+
+  @state() dataItemSpecSets: DataItemSpecSet[] = []
+
+  @queryAll('ox-properties-dynamic-view') specSetViews!: NodeListOf<HTMLElement & { value: any }>
+
+  render() {
+    return html`<form @property-change=${(e: Event) => this.onChange(e)}>
+      ${this.dataItemSpecSets.map(
+        ({ name, description, specs }) => html` <div specName>${name}</div>
+          <div description>${description}</div>
+          <ox-properties-dynamic-view data-name=${name} .props=${specs} .value=${this.value?.[name]}>
+          </ox-properties-dynamic-view>`
+      )}
+    </form>`
+  }
+
+  updated(changes: PropertyValues<this>) {
+    if (changes.has('dataItem')) {
+      this.dataItemSpecSets = OxDataUseCase.getUseCases().map(useCase => useCase.getSpecification(this.dataItem!))
+    }
+  }
+
+  private onChange(e: Event) {
+    this.value = this.buildValue()
+
+    this.dispatchEvent(
+      new CustomEvent('change', {
+        bubbles: true,
+        composed: true,
+        detail: { ...this.value }
+      })
+    )
+  }
+
+  private buildValue() {
+    var value = {} as any
+    this.specSetViews.forEach(view => (value[view.getAttribute('data-name')!] = view.value))
+
+    return value
+  }
+}

package/src/ox-data-ooc-view.ts

@@ -0,0 +1,67 @@
+import '@operato/input/ox-input-file.js'
+import './ox-data-sample-view'
+
+import { DataOoc, DataSet } from './types.js'
+import { LitElement, css, html } from 'lit'
+import { customElement, property } from 'lit/decorators.js'
+
+@customElement('ox-data-ooc-view')
+export class OxDataOocView extends LitElement {
+  static styles = css`
+    :host {
+      display: flex;
+      flex-direction: column;
+      background-color: var(--main-section-background-color);
+      padding: var(--padding-wide);
+
+      position: relative;
+    }
+
+    h3 {
+      margin: var(--title-margin);
+      padding-top: 12px;
+      font: var(--title-font);
+      color: var(--title-text-color);
+    }
+
+    h3[state] {
+      position: absolute;
+
+      right: 20px;
+      top: 25px;
+    }
+
+    [page-description] {
+      margin: var(--page-description-margin);
+      font: var(--page-description-font);
+      color: var(--page-description-color);
+    }
+  `
+
+  @property({ type: Object }) dataSet?: DataSet
+  @property({ type: Object }) dataOoc?: DataOoc
+
+  render() {
+    const history = this.dataOoc?.history || []
+    const formatter = new Intl.DateTimeFormat(navigator.language, { dateStyle: 'full', timeStyle: 'short' })
+
+    return html`
+      <ox-data-sample-view .dataSample=${this.dataOoc} .dataSet=${this.dataSet}></ox-data-sample-view>
+
+      <h3 state>${this.dataOoc?.state || ''}</h3>
+
+      <h3>history</h3>
+      ${history.map(
+        ({ user, state, comment, timestamp }) => html`
+          <p page-description>
+            ${formatter.format(new Date(timestamp))}
+            <br />
+            ${state} by ${user.name}
+            <br />
+            ${comment}
+          </p>
+        `
+      )}
+    `
+  }
+}

package/src/ox-data-sample-view.ts

@@ -0,0 +1,175 @@
+import '@operato/input/ox-input-file.js'
+
+import { css, html, LitElement } from 'lit'
+import { customElement, property } from 'lit/decorators.js'
+
+import { OxDataUseCase } from './ox-data-use-case.js'
+import { DataItem, DataSample, DataSet } from './types.js'
+
+@customElement('ox-data-sample-view')
+export class OxDataSampleView extends LitElement {
+  static styles = css`
+    :host {
+      display: flex;
+      flex-direction: column;
+      background-color: var(--main-section-background-color);
+    }
+
+    form {
+      flex: 1;
+
+      display: flex;
+      flex-direction: column;
+    }
+
+    h2 {
+      margin: var(--title-margin);
+      padding-top: 25px;
+      font: var(--title-font);
+      color: var(--title-text-color);
+    }
+    [page-description] {
+      margin: var(--page-description-margin);
+      font: var(--page-description-font);
+      color: var(--page-description-color);
+    }
+
+    table {
+      border-collapse: collapse;
+      margin-bottom: var(--margin-default);
+    }
+    th {
+      padding: var(--th-padding);
+      border-top: var(--th-border-top);
+      border-bottom: var(--td-border-bottom);
+      text-transform: var(--th-text-transform);
+      font: var(--th-font);
+      color: var(--th-color);
+      text-align: left;
+    }
+    th[item] {
+      min-width: 100px;
+    }
+    th[value] {
+      min-width: 100px;
+    }
+    tr {
+      background-color: var(--tr-background-color);
+    }
+    tr:nth-child(odd) {
+      background-color: var(--tr-background-odd-color);
+    }
+    tr:hover {
+      background-color: var(--tr-background-hover-color);
+    }
+    tr[ooc],
+    tr[oos] {
+      background-color: #fefbdf;
+    }
+    td {
+      border-bottom: var(--td-border-bottom);
+      padding: var(--td-padding);
+      font: var(--td-font);
+      color: var(--td-color);
+    }
+    td[name] {
+      font-weight: bold;
+    }
+    td mwc-icon {
+      color: var(--status-danger-color);
+    }
+
+    pre {
+      tab-size: 2;
+    }
+  `
+
+  @property({ type: Object }) dataSet?: DataSet
+  @property({ type: Object }) dataSample?: DataSample
+
+  render() {
+    const dataItems = this.dataSet?.dataItems.filter(item => item.active) || []
+    const data = this.dataSample?.data || {}
+    const formatter = new Intl.DateTimeFormat(navigator.language, { dateStyle: 'full', timeStyle: 'short' })
+
+    const { name, description, collectedAt, workDate, workShift } = this.dataSample || {}
+
+    return html` <h2>${name}</h2>
+      <p page-description>
+        ${description}<br /><br />
+        work date: ${workDate} ${workShift}<br />
+        collected at: ${formatter.format(new Date(collectedAt!))}
+      </p>
+
+      <form @change=${(e: Event) => this.onChange(e)}>
+        <table>
+          <tr>
+            <th item>item</th>
+            <th>description</th>
+            <th>unit</th>
+            <th value>value</th>
+            <th>specification</th>
+            <th>OOC</th>
+            <th>OOS</th>
+          </tr>
+          ${dataItems.map(dataItem => {
+            const { ooc, oos } = this.evaluateOOC(dataItem, data?.[dataItem.tag]) || {}
+            const { name, description, unit } = dataItem
+            return html`
+              <tr ?ooc=${ooc} ?oos=${oos}>
+                <td name>${name}</td>
+                <td>${description}</td>
+                <td>${unit}</td>
+                <td>${this.buildValue(dataItem)}</td>
+                <td><pre>${this.buildSpec(dataItem)}</pre></td>
+                <td>${ooc ? html`<mwc-icon>done</mwc-icon>` : ''}</td>
+                <td>${oos ? html`<mwc-icon>done</mwc-icon>` : ''}</td>
+              </tr>
+            `
+          })}
+        </table>
+      </form>`
+  }
+
+  private onChange(e: Event) {}
+
+  private buildSpec(dataItem: DataItem) {
+    return OxDataUseCase.elaborateDataItemSpec(this.dataSet!, dataItem)
+  }
+
+  private buildValue(dataItem: DataItem) {
+    const { tag, type } = dataItem
+
+    if (!this.dataSample) {
+      return ''
+    }
+
+    const value = this.dataSample?.data[dataItem.tag]
+    if (value === undefined) {
+      return ''
+    }
+    const values = value instanceof Array ? value : [value]
+
+    const elements = values.map((_: any, idx) => {
+      const v = value[idx]
+
+      switch (type) {
+        case 'boolean':
+          return html` <input type="checkbox" name=${tag} .checked=${v} disabled />`
+          break
+
+        case 'select':
+        case 'number':
+        case 'string':
+        default:
+          return String(v === undefined ? '' : v)
+      }
+    })
+
+    return type === 'boolean' ? elements : elements.join(', ')
+  }
+
+  private evaluateOOC(dataItem: DataItem, value: any) {
+    return OxDataUseCase.evaluateItem(this.dataSet!, dataItem, value)
+  }
+}