@operato/grist-editor 1.0.0-alpha.10

package/src/parameters/index.ts

@@ -0,0 +1,8 @@
+import { registerEditor, registerRenderer } from '@operato/data-grist'
+
+import { ParametersEditor } from './parameters-editor.js'
+
+/* register grist renderer/editor for id */
+registerEditor('parameters', ParametersEditor)
+
+// registerRenderer('id', IdRenderer)

package/src/parameters/parameters-editor-builder.ts

@@ -0,0 +1,130 @@
+/**
+ * @license Copyright © HatioLab Inc. All rights reserved.
+ */
+
+import '@things-factory/modeller-ui'
+
+import { LitElement, PropertyValues, html } from 'lit'
+import { OxPropertyEditor, PropertySpec } from '@operato/property-editor'
+import { customElement, property } from 'lit/decorators.js'
+
+import { connect } from 'pwa-helpers/connect-mixin'
+import { store } from '@operato/shell'
+
+/**
+모든 에디터들은 change 이벤트를 지원해야 한다. 또한, 모든 에디터들은 value속성에 값을 가져야 한다.
+
+Example:
+
+    <ox-parameters-editor-builder value="{{value}}">
+      <label>Center X</label>
+      <input type="number" .value="${value.cx}">
+      <label>Width</label>
+      <input type="number" .value="${value.width}">
+    </ox-parameters-editor-builder>
+*/
+
+const DEFAULT_VALUE = {
+  legend: '',
+  number: 0,
+  angle: 0,
+  string: '',
+  text: '',
+  textarea: '',
+  checkbox: false,
+  select: '',
+  color: '#000000',
+  'solidcolor-stops': null,
+  'gradientcolor-stops': null,
+  'gltf-selector': '',
+  'image-selector': '',
+  multiplecolor: null,
+  editortable: null,
+  imageselector: '',
+  options: null,
+  date: null
+} as any
+
+@customElement('ox-parameters-editor-builder')
+class ParametersEditorBuilder extends connect(store)(LitElement) {
+  @property({ type: Object }) value: any
+  @property({ type: Array }) props?: PropertySpec[]
+  @property({ type: Object }) host: any
+
+  render() {
+    return html`<slot></slot>`
+  }
+
+  firstUpdated() {
+    this.addEventListener('change', this._onValueChanged.bind(this))
+  }
+
+  updated(changes: PropertyValues<this>) {
+    changes.has('props') && this._onPropsChanged(this.props)
+    changes.has('value') && this._setValues()
+  }
+
+  _onPropsChanged(props: PropertySpec[] | undefined) {
+    this.textContent = ''
+    ;(props || []).forEach(prop => {
+      let elementType = OxPropertyEditor.getEditor(prop.type)
+      if (!elementType) {
+        console.warn('Property Editor not defined', prop.type)
+        return
+      }
+      let element = document.createElement(elementType) as OxPropertyEditor
+
+      element.label = prop.label
+      element.type = prop.type
+      element.placeholder = prop.placeholder
+      element.host = this.host
+      // element.context = this.context
+      element.setAttribute('name', prop.name)
+
+      if (prop.observe) {
+        element.observe = prop.observe
+      }
+      element.property = prop.property
+      element.setAttribute('property-editor', '')
+
+      this.appendChild(element)
+    })
+  }
+
+  _setValues() {
+    var value = this.value || {}
+    Array.from(this.querySelectorAll('[name]')).forEach(propertyEditor => {
+      const editor = propertyEditor as OxPropertyEditor
+      let name = editor.getAttribute('name')
+      editor.value = value[name!] === undefined ? DEFAULT_VALUE[editor.type] : value[name!]
+    })
+  }
+
+  _getValues() {
+    var value = {} as any
+    Array.from(this.querySelectorAll('[name]')).forEach(propertyEditor => {
+      const editor = propertyEditor as OxPropertyEditor
+      let name = editor.getAttribute('name')
+      value[name!] = editor.value === undefined ? DEFAULT_VALUE[editor.type] : editor.value
+    })
+
+    return value
+  }
+
+  _onValueChanged(e: Event) {
+    e.stopPropagation()
+    var prop = e.target as HTMLElement
+
+    if (!prop || !prop.hasAttribute('property-editor')) {
+      return
+    }
+
+    this.dispatchEvent(
+      new CustomEvent('property-change', {
+        bubbles: true,
+        composed: true,
+        detail: this._getValues()
+      })
+    )
+  }
+}

package/src/parameters/parameters-editor-popup.ts

@@ -0,0 +1,106 @@
+import { LitElement, css, html } from 'lit'
+import { customElement, property } from 'lit/decorators.js'
+
+import { ScrollbarStyles } from '@operato/styles'
+import { i18next } from '@operato/i18n'
+
+@customElement('ox-parameters-editor-popup')
+export class ParametersEditorPopup 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-parameters-editor-builder {
+        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 }) props: any
+  @property({ type: Object }) host: any
+  @property({ type: Object }) context: any
+  @property({ type: Object }) confirmCallback!: (newval: any) => void
+
+  render() {
+    var props = this.props instanceof Array ? this.props : []
+
+    return html`
+      ${props.length > 0
+        ? html`
+            <ox-parameters-editor-builder
+              .value=${this.value}
+              .props=${props}
+              .host=${this.host}
+              .context=${this.context}
+              @property-change=${this.onChange.bind(this)}
+            >
+            </ox-parameters-editor-builder>
+          `
+        : html` <span><i18n-msg msgid="text.no properties to set"></i18n-msg></span> `}
+
+      <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(...)을 사용하였다.
+    */
+    if (!this.value) {
+      this.value = {}
+    }
+
+    for (let key in this.value) {
+      delete this.value[key]
+    }
+    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/parameters/parameters-editor.ts

@@ -0,0 +1,112 @@
+/**
+ * @license Copyright © HatioLab Inc. All rights reserved.
+ */
+
+import './parameters-editor-builder.js'
+import './parameters-editor-popup.js'
+
+import { ColumnConfig, GristRecord, InputEditor } from '@operato/data-grist'
+import { LitElement, css, html } from 'lit'
+import { PopupHandle, openPopup } from '@operato/layout'
+import { customElement, property } from 'lit/decorators.js'
+
+import { i18next } from '@operato/i18n'
+
+@customElement('ox-parameters-editor')
+export class ParametersEditor extends InputEditor {
+  static styles = css`
+    :host {
+      color: black;
+
+      overflow: hidden;
+      text-overflow: ellipsis;
+    }
+  `
+
+  @property({ type: Object }) value: any
+  @property({ type: Object }) column!: ColumnConfig
+  @property({ type: Object }) record!: GristRecord
+  @property({ type: Number }) row!: number
+  @property({ type: Object }) field!: any
+
+  private popup?: PopupHandle
+
+  render() {
+    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 => {
+      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, spec, context, 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) : this.value
+    } catch (e) {
+      var value: any = {}
+    }
+
+    /* 
+      주의 : 이 팝업 템플릿은 layout 모듈에 의해서 render 되므로, 
+      layout의 구성에 변화가 발생하면, 다시 render된다.
+      이 팝업이 떠 있는 상태에서, 또 다른 팝업이 뜨는 경우도 layout 구성의 변화를 야기한다. (overlay의 갯수의 증가)
+      이 경우 value, options, confirmCallback 등 클로져를 사용한 것들이 초기 바인딩된 값으로 다시 바인딩되게 되는데,
+      만약, 템플릿 내부에서 이들 속성의 레퍼런스가 변화했다면, 원래 상태로 되돌아가는 현상이 발생하게 된다.
+      따라서, 가급적 이들 속성의 레퍼런스를 변화시키지 않는 것이 좋다.
+    */
+    var template = html`
+      <ox-parameters-editor-popup
+        .value=${value}
+        .props=${spec}
+        .host=${this.record}
+        .context=${context}
+        .confirmCallback=${confirmCallback}
+      >
+      </ox-parameters-editor-popup>
+    `
+
+    this.popup = openPopup(template, {
+      backdrop: true,
+      size: 'large',
+      title: `${name?.toUpperCase() || ''} ${i18next.t('field.params')}`,
+      help
+    })
+  }
+}

package/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "target": "es2018",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "noEmitOnError": true,
+    "lib": ["es2017", "dom"],
+    "strict": true,
+    "esModuleInterop": false,
+    "allowSyntheticDefaultImports": true,
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "importHelpers": true,
+    "outDir": "dist",
+    "sourceMap": true,
+    "inlineSources": true,
+    "rootDir": "./",
+    "declaration": true,
+    "incremental": true,
+    "types": ["node", "mocha"]
+  },
+  "include": ["**/*.ts"]
+}

package/web-dev-server.config.mjs

@@ -0,0 +1,27 @@
+// import { hmrPlugin, presets } from '@open-wc/dev-server-hmr';
+
+/** Use Hot Module replacement by adding --hmr to the start command */
+const hmr = process.argv.includes('--hmr');
+
+export default /** @type {import('@web/dev-server').DevServerConfig} */ ({
+  open: '/demo/',
+  /** Use regular watch mode if HMR is not enabled. */
+  watch: !hmr,
+  /** Resolve bare module imports */
+  nodeResolve: {
+    exportConditions: ['browser', 'development'],
+  },
+
+  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
+  // esbuildTarget: 'auto'
+
+  /** Set appIndex to enable SPA routing */
+  // appIndex: 'demo/index.html',
+
+  plugins: [
+    /** Use Hot Module Replacement by uncommenting. Requires @open-wc/dev-server-hmr plugin */
+    // hmr && hmrPlugin({ exclude: ['**/*/node_modules/**/*'], presets: [presets.litElement] }),
+  ],
+
+  // See documentation for all available options
+});

package/web-test-runner.config.mjs

@@ -0,0 +1,41 @@
+// import { playwrightLauncher } from '@web/test-runner-playwright';
+
+const filteredLogs = ['Running in dev mode', 'lit-html is in dev mode'];
+
+export default /** @type {import("@web/test-runner").TestRunnerConfig} */ ({
+  /** Test files to run */
+  files: 'dist/test/**/*.test.js',
+
+  /** Resolve bare module imports */
+  nodeResolve: {
+    exportConditions: ['browser', 'development'],
+  },
+
+  /** Filter out lit dev mode logs */
+  filterBrowserLogs(log) {
+    for (const arg of log.args) {
+      if (typeof arg === 'string' && filteredLogs.some(l => arg.includes(l))) {
+        return false;
+      }
+    }
+    return true;
+  },
+
+  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
+  // esbuildTarget: 'auto',
+
+  /** Amount of browsers to run concurrently */
+  // concurrentBrowsers: 2,
+
+  /** Amount of test files per browser to test concurrently */
+  // concurrency: 1,
+
+  /** Browsers to run tests on */
+  // browsers: [
+  //   playwrightLauncher({ product: 'chromium' }),
+  //   playwrightLauncher({ product: 'firefox' }),
+  //   playwrightLauncher({ product: 'webkit' }),
+  // ],
+
+  // See documentation for all available options
+});