@operato/data-grist 0.2.31 → 0.2.36

package/src/search-form/index.ts

@@ -0,0 +1,7 @@
+export * from './ox-search-form'
+export * from './ox-grist-search-form'
+export * from './ox-basic-field'
+export * from './ox-checkbox-field'
+export * from './ox-number-field'
+export * from './ox-select-field'
+export * from './ox-text-field'

package/src/search-form/ox-basic-field.ts

@@ -0,0 +1,86 @@
+import { css, LitElement } from 'lit-element'
+
+import { OXBasicFieldProps } from '../interfaces/ox-search-field'
+
+export abstract class OXBasicField extends LitElement {
+  static styles = [
+    css`
+      input,
+      select {
+        background-color: transparent;
+        border: none;
+        box-sizing: border-box;
+        outline: none;
+        padding: 4px 9px;
+        font-size: var(--fontsize-default, 14px);
+        color: var(--primary-text-color, #476172);
+        font-weight: bold;
+      }
+    `
+  ]
+
+  field!: OXBasicFieldProps
+
+  private form: HTMLFormElement | null = null
+  value?: any
+
+  abstract setDefaultValue(defaultValue: unknown): void
+
+  get input(): HTMLInputElement | HTMLSelectElement {
+    if (!this.field.name) throw new Error('No name property provided')
+    const input: HTMLInputElement | null = this.renderRoot.querySelector(
+      `input[name=${this.field.name}],select[name=${this.field.name}]`
+    )
+    if (!input) throw new Error('Failed to find input element')
+
+    return input
+  }
+
+  override connectedCallback(): void {
+    super.connectedCallback()
+    this.form = this.findFormElement()
+    this.form?.addEventListener('formdata', this.appendFormData.bind(this))
+  }
+
+  override disconnectedCallback(): void {
+    super.disconnectedCallback()
+    this.form?.removeEventListener('formdata', this.appendFormData.bind(this))
+    this.form = null
+  }
+
+  override firstUpdated(): void {
+    const { handlers } = this.field || {}
+
+    this.registerBasicEventHandlers()
+    if (handlers) this.registerCustomEventHandlers(handlers)
+    if (this.field.defaultValue !== undefined) this.setDefaultValue(this.field.defaultValue)
+  }
+
+  private findFormElement(): HTMLFormElement | null {
+    const rootNode: HTMLElement = this.getRootNode() as HTMLElement
+    const forms: HTMLFormElement[] = Array.from(rootNode.querySelectorAll('form'))
+
+    return forms.find((form: HTMLFormElement) => form.contains(this)) || null
+  }
+
+  private registerCustomEventHandlers(handlers: Record<string, (event: Event) => void>): void {
+    const eventNames: string[] = Object.keys(handlers)
+    if (!eventNames.length) return
+
+    eventNames.forEach((eventName: string) => this.input.addEventListener(eventName, handlers[eventName]))
+  }
+
+  private registerBasicEventHandlers(): void {
+    this.input.onkeydown = (event: KeyboardEvent) => {
+      if (event.key === 'Enter') this.submit()
+    }
+  }
+
+  private appendFormData({ formData }: FormDataEvent): void {
+    formData.append(this.field.name, this.value)
+  }
+
+  private submit(): void {
+    if (this.form) this.dispatchEvent(new CustomEvent('submit-field', { composed: true, bubbles: true }))
+  }
+}

package/src/search-form/ox-checkbox-field.ts

@@ -0,0 +1,57 @@
+import { css, html, TemplateResult } from 'lit'
+import { ifDefined } from 'lit-html/directives/if-defined.js'
+import { customElement, property } from 'lit/decorators.js'
+
+import { OXCheckboxFieldProps } from '..'
+import { OXBasicField } from './ox-basic-field'
+
+@customElement('ox-checkbox-field')
+export class OXCheckboxField extends OXBasicField {
+  @property({ type: Object }) field!: OXCheckboxFieldProps
+  @property({ type: Boolean }) value?: boolean
+
+  static styles = [
+    css`
+      label {
+        font-size: var(--fontsize-default, 14px);
+        color: var(--primary-text-color, #476172);
+      }
+    `
+  ]
+
+  setDefaultValue(defaultValue: boolean): void {
+    this.value = defaultValue
+  }
+
+  render(): TemplateResult {
+    const { name, hidden, placeholder, id } = this.field
+
+    return html`<label ?hidden=${hidden}>
+      <input
+        id=${ifDefined(id)}
+        type="checkbox"
+        name=${name}
+        .checked=${Boolean(this.value)}
+        @click=${this.onClickHandler.bind(this)}
+      />
+      ${placeholder || name}
+    </label>`
+  }
+
+  private onClickHandler(): void {
+    const checkbox: HTMLInputElement = this.input as HTMLInputElement
+
+    if (!this.field.indeterminate) {
+      this.value = !this.value
+    } else {
+      if (this.value === false) {
+        this.value = undefined
+        checkbox.indeterminate = true
+      } else if (this.value === undefined) {
+        this.value = true
+      } else {
+        this.value = false
+      }
+    }
+  }
+}

package/src/search-form/ox-grist-search-form.ts

@@ -0,0 +1,200 @@
+import { ColumnConfig, GristConfig } from '../types'
+import { LitElement, TemplateResult, html } from 'lit'
+import {
+  OXBasicFieldProps,
+  OXCheckboxFieldProps,
+  OXNumberFieldProps,
+  OXSearchFieldProps,
+  OXSearchFieldTypes,
+  OXSearchForm,
+  OXSelectFieldProps,
+  OXTextFieldProps,
+  QueryFilter
+} from '..'
+import { customElement, property } from 'lit/decorators.js'
+
+@customElement('ox-grist-search-form')
+export class OXGristSearchForm extends LitElement {
+  @property({ type: Object }) config!: GristConfig
+  @property({ type: String }) defaultOperator: string = 'eq'
+
+  private timeout?: NodeJS.Timeout
+
+  render(): TemplateResult {
+    const fields: OXSearchFieldProps[] = this.convertToSearchFields(this.config)
+
+    return html` <ox-search-form .fields=${fields}></ox-search-form> `
+  }
+
+  private convertToSearchFields(config: GristConfig): OXSearchFieldProps[] {
+    const supportingTypes: string[] = ['string', 'integer', 'number', 'float', 'select', 'boolean', 'checkbox']
+
+    return config.columns
+      .filter((columnConfig: ColumnConfig) => supportingTypes.indexOf(columnConfig.type) >= 0)
+      .map((columnConfig: ColumnConfig) => {
+        let fieldProps: OXBasicFieldProps = {
+          name: columnConfig.name,
+          hidden: Boolean(columnConfig.hidden),
+          placeholder: typeof columnConfig.label === 'string' ? columnConfig.label : columnConfig.name
+        }
+
+        switch (columnConfig.type) {
+          case 'string':
+            return {
+              ...fieldProps,
+              type: 'text'
+            } as OXTextFieldProps
+
+          case 'integer':
+            return {
+              ...fieldProps,
+              type: 'number',
+              min: columnConfig.record?.options?.min || undefined,
+              max: columnConfig.record?.options?.max || undefined
+            } as OXNumberFieldProps
+
+          case 'number':
+            return {
+              ...fieldProps,
+              type: 'number',
+              min: columnConfig.record?.options?.min || undefined,
+              max: columnConfig.record?.options?.max || undefined
+            } as OXNumberFieldProps
+
+          case 'float':
+            return {
+              ...fieldProps,
+              type: 'number',
+              min: columnConfig.record?.options?.min || undefined,
+              max: columnConfig.record?.options?.max || undefined
+            } as OXNumberFieldProps
+
+          case 'select':
+            return {
+              ...fieldProps,
+              type: 'select',
+              searchEnable: true,
+              options: columnConfig.record?.options.map((option: string | Record<string, any>) => {
+                if (typeof option === 'string') {
+                  return { value: option }
+                } else if (option.display && option.value) {
+                  return {
+                    name: option.display,
+                    value: option.value
+                  }
+                } else {
+                  throw new Error('Unexpected option property')
+                }
+              })
+            } as OXSelectFieldProps
+
+          case 'boolean':
+            return {
+              ...fieldProps,
+              type: 'checkbox',
+              indeterminate: true
+            } as OXCheckboxFieldProps
+
+          case 'checkbox':
+            return {
+              ...fieldProps,
+              type: 'checkbox',
+              indeterminate: true
+            } as OXCheckboxFieldProps
+
+          default:
+            throw new Error('Non-supported type of column config')
+        }
+      })
+
+    // return searchFields
+    //   .filter((searchField: string) => fieldMap.has(searchField))
+    //   .map((searchField: string) => {
+    //     const columnConfig: ColumnConfig | undefined = fieldMap.get(searchField)
+    //     if (!columnConfig) throw new Error('No matched column config')
+
+    //     let fieldProps: OXBasicFieldProps = {
+    //       name: columnConfig.name,
+    //       hidden: Boolean(columnConfig.hidden),
+    //       label: typeof columnConfig.label === 'string' ? columnConfig.label : undefined
+    //     }
+
+    //     switch (columnConfig.type) {
+    //       case 'string':
+    //         return {
+    //           ...fieldProps,
+    //           type: 'text'
+    //         } as OXTextFieldProps
+
+    //       case 'integer':
+    //         return {
+    //           ...fieldProps,
+    //           type: 'number',
+    //           min: columnConfig.record?.options?.min || undefined,
+    //           max: columnConfig.record?.options?.max || undefined
+    //         } as OXNumberFieldProps
+
+    //       case 'number':
+    //         return {
+    //           ...fieldProps,
+    //           type: 'number',
+    //           min: columnConfig.record?.options?.min || undefined,
+    //           max: columnConfig.record?.options?.max || undefined
+    //         } as OXNumberFieldProps
+
+    //       case 'float':
+    //         return {
+    //           ...fieldProps,
+    //           type: 'number',
+    //           min: columnConfig.record?.options?.min || undefined,
+    //           max: columnConfig.record?.options?.max || undefined
+    //         } as OXNumberFieldProps
+
+    //       case 'select':
+    //         return {
+    //           ...fieldProps,
+    //           type: 'select',
+    //           searchEnable: true,
+    //           options: columnConfig.record?.options.map((option: Record<string, any>) => ({
+    //             name: option.display,
+    //             value: option.value
+    //           }))
+    //         } as OXSelectFieldProps
+
+    //       case 'boolean':
+    //         return {
+    //           ...fieldProps,
+    //           type: 'checkbox',
+    //           indeterminate: true
+    //         } as OXCheckboxFieldProps
+
+    //       case 'checkbox':
+    //         return {
+    //           ...fieldProps,
+    //           type: 'checkbox',
+    //           indeterminate: true
+    //         } as OXCheckboxFieldProps
+
+    //       default:
+    //         throw new Error('Non-supported type of column config')
+    //     }
+    //   })
+  }
+
+  get queryFilters(): QueryFilter[] {
+    const searchForm: OXSearchForm | null = this.renderRoot.querySelector<OXSearchForm>('ox-search-form')
+    if (!searchForm) throw new Error('Failed to find search form')
+
+    const searchFields: OXSearchFieldTypes[] = searchForm.searchFields
+
+    return searchFields
+      .filter(({ value }: OXSearchFieldTypes) => value !== null && value !== undefined && value !== '')
+      .map((searchField: OXSearchFieldTypes) => {
+        return {
+          name: searchField.field.name,
+          operator: searchField.field.operator || this.defaultOperator,
+          value: searchField.value
+        }
+      })
+  }
+}

package/src/search-form/ox-number-field.ts

@@ -0,0 +1,113 @@
+import '@material/mwc-icon'
+
+import { css, CSSResult, html, TemplateResult } from 'lit'
+import { ifDefined } from 'lit-html/directives/if-defined.js'
+import { customElement, property } from 'lit/decorators.js'
+
+import { OXNumberFieldProps } from '..'
+import { OXBasicField } from './ox-basic-field'
+
+@customElement('ox-number-field')
+export class OXNumberField extends OXBasicField {
+  @property({ type: Object }) field!: OXNumberFieldProps
+  @property({ type: Number }) value?: number
+
+  setDefaultValue(defaultValue: number): void {
+    this.value = defaultValue
+  }
+
+  static styles: CSSResult[] = [
+    css`
+      :host {
+        display: inline-flex;
+        flex-direction: column;
+      }
+      input::-webkit-outer-spin-button,
+      input::-webkit-inner-spin-button {
+        -webkit-appearance: none;
+        margin: 0;
+      }
+
+      span.input-wrapper {
+        display: inline-flex;
+      }
+
+      button {
+        padding: var(--padding-narrow);
+        height: 24px;
+        background-color: var(--theme-white-color);
+        border: 1px solid rgba(var(--primary-color-rgb), 0.5);
+        border-radius: 50%;
+        opacity: 0.6;
+        cursor: pointer;
+      }
+      button mwc-icon {
+        font-size: var(--fontsize-default, 16px);
+        color: var(--primary-text-color, #476172);
+      }
+      button:hover {
+        opacity: 1;
+      }
+      input {
+        border: none;
+        outline: none;
+        padding: 4px 9px;
+        text-align: center;
+        font-size: var(--fontsize-default, 14px);
+        color: var(--primary-text-color, #476172);
+      }
+    `
+  ]
+
+  render(): TemplateResult {
+    const { name, hidden, id, placeholder, min, max, step } = this.field
+
+    return html`
+      <span class="input-wrapper" ?hidden=${hidden}>
+        <button @click=${this.decrease.bind(this)}>
+          <mwc-icon>add</mwc-icon>
+        </button>
+        <input
+          id=${ifDefined(id)}
+          name=${name}
+          type="number"
+          placeholder=${ifDefined(placeholder)}
+          min=${ifDefined(min)}
+          max=${ifDefined(max)}
+          step=${ifDefined(step)}
+          .value=${String(this.value) || ''}
+          @change=${this.onChangeHandler.bind(this)}
+        />
+        <button @click=${this.increase.bind(this)}>
+          <mwc-icon>remove</mwc-icon>
+        </button>
+      </span>
+    `
+  }
+
+  decrease(): void {
+    let fractionDigits: number = 0
+    if (this.field.step) {
+      fractionDigits = String(this.field.step).split('.')[1].length
+    }
+
+    this.value = Number(((this.value ?? 0) - (this.field.step || 1)).toFixed(fractionDigits))
+  }
+
+  increase(): void {
+    let fractionDigits: number = 0
+    if (this.field.step) {
+      fractionDigits = String(this.field.step).split('.')[1].length
+    }
+
+    this.value = Number(((this.value ?? 0) + (this.field.step || 1)).toFixed(fractionDigits))
+  }
+
+  private onChangeHandler(): void {
+    if (this.input.value) {
+      this.value = Number(this.input.value)
+    } else {
+      this.value = undefined
+    }
+  }
+}

package/src/search-form/ox-search-form.ts

@@ -0,0 +1,71 @@
+import './ox-text-field'
+import './ox-checkbox-field'
+import './ox-select-field'
+import './ox-number-field'
+
+import { LitElement, TemplateResult, html } from 'lit'
+import {
+  OXCheckboxField,
+  OXCheckboxFieldProps,
+  OXNumberField,
+  OXNumberFieldProps,
+  OXSearchFieldProps,
+  OXSelectField,
+  OXSelectFieldProps,
+  OXTextField,
+  OXTextFieldProps
+} from '..'
+import { customElement, property, query, queryAll } from 'lit/decorators.js'
+
+export type OXSearchFieldTypes = OXTextField | OXNumberField | OXSelectField | OXCheckboxField
+
+@customElement('ox-search-form')
+export class OXSearchForm extends LitElement {
+  @property({ type: Array }) fields!: OXSearchFieldProps[]
+
+  @query('form') form!: HTMLFormElement
+
+  render(): TemplateResult {
+    return html`
+      <form @submit-field=${this._submitFieldHandler.bind(this)}>
+        <slot></slot>
+        ${this.fields.map(this.renderField)}
+      </form>
+    `
+  }
+
+  get searchFields(): OXSearchFieldTypes[] {
+    return Array.from(this.form.querySelectorAll('*'))
+  }
+
+  private renderField(field: OXSearchFieldProps): TemplateResult {
+    const { type } = field
+
+    switch (type) {
+      case 'text':
+        return html`<ox-text-field .field=${field as OXTextFieldProps}></ox-text-field>`
+
+      case 'number':
+        return html`<ox-number-field .field=${field as OXNumberFieldProps}></ox-number-field>`
+
+      case 'select':
+        return html`<ox-select-field .field=${field as OXSelectFieldProps}></ox-select-field>`
+
+      case 'checkbox':
+        return html`<ox-checkbox-field .field=${field as OXCheckboxFieldProps}></ox-checkbox-field>`
+
+      default:
+        return html`<ox-text-field .field=${field as OXTextFieldProps}></ox-text-field>`
+    }
+  }
+
+  _submitFieldHandler(): void {
+    this.dispatchEvent(
+      new CustomEvent('submit', {
+        composed: true,
+        bubbles: true,
+        cancelable: true
+      })
+    ) && this.form.submit()
+  }
+}