@dile/crud 0.0.9

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 EscuelaIT
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,5 @@
+# Dile Crud
+
+Components to create a generic crud system based on Web Components and Lit.
+
+This is a "work in progress"...

package/components/action/crud-actions.js

@@ -0,0 +1,2 @@
+import { DileCrudActions } from "./src/DileCrudActions.js";
+customElements.define('dile-crud-actions', DileCrudActions);

package/components/action/crud-delete-action.js

@@ -0,0 +1,2 @@
+import { DileCrudDeleteAction } from "./src/DileCrudDeleteAction.js";
+customElements.define('dile-crud-delete-action', DileCrudDeleteAction);

package/components/action/crud-single-actions.js

@@ -0,0 +1,2 @@
+import { DileCrudSingleActions } from './src/DileCrudSingleActions.js';
+customElements.define('dile-crud-single-actions', DileCrudSingleActions);

package/components/action/src/DileCrudActions.js

@@ -0,0 +1,181 @@
+import { LitElement, html, css } from 'lit';
+import { moreVertIcon } from '@dile/icons';
+import '@dile/ui/components/confirm/confirm';
+import '@dile/ui/components/select/select';
+import '../../ajax/ajax.js'
+import '../../ui/crud-list-options.js';
+
+export class DileCrudActions extends LitElement {
+  static styles = css`
+        :host {
+            display: block;
+            --dile-modal-border-radius: 2px;
+            --dile-modal-width: 100vw;
+            --dile-modal-height: 100vh;
+            --dile-modal-content-padding: 1.5rem;
+            --dile-modal-background-color: rgba(0, 0, 0, 0.5);
+            --dile-modal-content-shadow-color: rgba(0, 0, 0, 0.5);
+            --dile-confirm-accept-button-color: var(--dile-primary-color, #378dca);
+            --dile-confirm-accept-text-button-color: var(--dile-on-primary-color, #fff);
+            --dile-confirm-cancel-button-color: var(--dile-danger-color, #E31E1B);
+            --dile-confirm-cancel-text-button-color: var(--dile-on-danger-color, #fff);
+        }
+        p {
+          margin: 0 0 0.75rem 0;
+        }
+        .visible {
+            display: block;
+        }
+        .hide {
+            display: none;
+        }
+        .modalcontainer {
+            color: #303030;
+        }
+        @media(min-width: 400px) {
+            :host {
+                --dile-modal-width: 90%;
+                --dile-modal-height: 90%;
+            }
+        }
+        @media(min-width: 500px) {
+            :host {
+                --dile-modal-width: 80%;
+                --dile-modal-height: 80%;
+            }
+        }
+    `;
+
+  static get properties() {
+    return {
+      actionIds: { type: Array },
+      selection: { type: String },
+      endpoint: { type: String },
+      actions: { type: Array },
+      formActionsTemplate: { type: Object },
+    };
+  }
+
+  constructor() {
+    super();
+    this.actionIds = [];
+    this.actions = [];
+    this.selection = 'DeleteAction'
+  }
+
+  firstUpdated() {
+    this.confirmElement = this.shadowRoot.getElementById('elconfirm');
+    this.ajaxAction = this.shadowRoot.getElementById('ajaxaction');
+  }
+
+  render() {
+    return html`
+        ${this.ajaxTemplate}
+        ${this.actionListTemplate}
+        ${this.confirmActionTemplate}
+        `;
+  }
+
+  get ajaxTemplate() {
+    return html`
+        <dile-ajax
+            id="ajaxaction"
+            method="post"
+            url="${this.endpoint}/action"
+            @ajax-success="${this.doSuccessAction}"
+            @ajax-error="${this.doErrorAction}"
+        ></dile-ajax>
+    `;
+  }
+
+  get actionListTemplate() {
+    return html`
+            <dile-crud-list-options .icon="${moreVertIcon}" label="Acciones" class="${this.actionIds.length > 0 ? 'visible' : 'hide'}">
+                <p>${this.actionIds.length} ${this.actionIds.length == 1 ? 'elemento' : 'elementos'}</p>
+                <div @element-changed=${this.selectorChanged}>
+                    ${this.selectActionsTemplate}
+                </div>
+                <dile-button @click=${this.showAction}>Realizar acción</dile-button>
+            </dile-crud-list-options>
+        `;
+  }
+
+  get selectActionsTemplate() {
+    return html`
+      <dile-select>
+          <select slot="select">
+              ${this.actions.map(action => html`<option value="${action.name}">${action.label}</option>`)}
+          </select>
+      </dile-select>
+    `
+  }
+
+  get confirmActionTemplate() {
+    return html`
+            <dile-confirm 
+                id="elconfirm"
+                cancelLabel="Cancelar"
+                acceptLabel="Aceptar"
+                @dile-confirm-accepted=${this.doAction}
+            >
+                <div class="modalcontainer">
+                    ${this.formActionsTemplate(this.selection)}
+                </div>
+            </dile-confirm>
+        `;
+  }
+
+  setActionIds(items) {
+    this.actionIds = items;
+  }
+
+  selectorChanged(e) {
+    this.selection = e.target.value;
+  }
+
+  showAction() {
+    this.confirmElement.open();
+    let listOptions = this.shadowRoot.querySelector('dile-crud-list-options');
+    if (listOptions) {
+      listOptions.close()
+    }
+  }
+
+  get selectedActionForm() {
+    return this.shadowRoot.querySelector(`[action="${this.selection}"]`)
+  }
+
+  doAction() {
+    let actionData = this.selectedActionForm.getData();
+    this.ajaxAction.data = {
+      type: this.selection,
+      relatedIds: this.actionIds,
+      data: actionData,
+    };
+    this.ajaxAction.generateRequest();
+  }
+
+  doSuccessAction(e) {
+    this.selectedActionForm.resetData();
+    this.dispatchEvent(new CustomEvent('crud-action-success', {
+      bubbles: true,
+      composed: true,
+      detail: {
+        msg: e.detail.message,
+        action: e.detail.data.action,
+        data: e.detail.data.data,
+      }
+    }));
+  }
+
+  doErrorAction(e) {
+    this.dispatchEvent(new CustomEvent('crud-action-error', {
+      bubbles: true,
+      composed: true,
+      detail: {
+        msg: e.detail,
+      }
+    }));
+  }
+
+}

package/components/action/src/DileCrudDeleteAction.js

@@ -0,0 +1,18 @@
+import { LitElement, html, css } from 'lit';
+import { DileForm } from '@dile/ui/mixins/form';
+
+export class DileCrudDeleteAction extends DileForm(LitElement) {
+    static styles = [
+        css`
+            :host {
+                display: block;
+            }
+        `
+    ];
+
+    render() {
+        return html`
+            <p>Are you sure you want to delete those items?</p>
+        `;
+    }
+}

package/components/action/src/DileCrudSingleActions.js

@@ -0,0 +1,77 @@
+import { LitElement, html, css } from 'lit';
+import { DileCrudActions } from './DileCrudActions.js';
+import '@dile/ui/components/box-selector/box-selector.js';
+import '@dile/ui/components/box-selector/box-selector-item.js';
+import '@dile/ui/components/card/card.js';
+
+export class DileCrudSingleActions extends DileCrudActions {
+  static styles = [
+    super.styles,
+    css`
+      :host {
+          display: block;
+          --dile-box-selector-item-text-align: center;
+          --dile-box-selector-item-font-weight: bold;
+      }
+      dile-card {
+          --dile-card-border: none;
+          margin-bottom: 1.5rem;
+          --dile-card-background-color: var(--dile-secondary-light-color);
+      }
+      .action-list {
+          display: grid;
+          grid-template-columns: 1fr 1fr;
+          grid-gap: 1rem;
+          align-items: stretch;
+      }
+      dile-box-selector-item:hover {
+          --dile-box-selector-item-background-color: var(--dile-primary-light-color);
+          --dile-box-selector-item-color: var(--dile-on-primary-light-color);
+          --dile-box-selector-item-border: 4px solid var(--dile-primary-color);
+      }
+      
+    `
+  ];
+
+  static get properties() {
+    return {
+      actions: { type: Array },
+    };
+  }
+
+  constructor() {
+    super();
+    this.actions = [];
+  }
+
+  get actionListTemplate() {
+    return html`
+      ${this.actions.length > 0
+        ? html`
+          <dile-card title="Element action">
+              <dile-box-selector 
+                  class="action-list" 
+                  attrForSelected="name"
+                  @dile-selected-changed="${this.onActionSelected}"
+              >
+                  ${this.actions.map(action => html`
+                      <dile-box-selector-item 
+                          label="${action.label}"
+                          name="${action.name}"
+                      ></dile-box-selector-item>
+                  `)}
+              </dile-box-selector>
+          </dile-card>
+        `
+        : ''
+      }
+        `;
+  }
+
+
+
+  onActionSelected(e) {
+    this.selection = e.detail.selected;
+    this.showAction();
+  }
+}

package/components/ajax/ajax.js

@@ -0,0 +1,2 @@
+import { DileAjax } from './src/DileAjax.js'
+customElements.define('dile-ajax', DileAjax);

package/components/ajax/index.js

@@ -0,0 +1 @@
+export { DileAjax } from './src/DileAjax.js';

package/components/ajax/src/DileAjax.js

@@ -0,0 +1,108 @@
+import { LitElement, html } from 'lit';
+import { DileAxios } from '../../../lib/DileAxios.js';
+
+export class DileAjax extends DileAxios(LitElement) {
+  static get properties() {
+    return {
+      data: {  type: Object },
+      method: { type: String },
+      url: { type: String },
+    }
+  }
+
+  constructor() {
+    super();
+    this.data = {};
+    this.method = 'post';
+    this.url = '';
+  }
+
+  generateRequest() {
+    let request;
+    switch(this.method.toLowerCase().trim()) {
+      case 'post':
+        request = this.axiosInstance.post(this.url, this.data);
+        break;
+      case 'get':
+        request = this.axiosInstance.get(this.url, {
+          params: this.data
+        });
+        break;
+      case 'put':
+        request = this.axiosInstance.put(this.url, this.data);
+        break;
+      case 'delete':
+        request = this.axiosInstance.delete(this.url, this.data);
+        break;
+      case 'patch':
+        request = this.axiosInstance.patch(this.url, this.data);
+        break
+    }
+    request.then((response) => {
+      if(response.status == 200) {
+        let res = response.data;
+        if(res.error) {
+          this.dispatchError(res.data);
+        } else if (res.error === false) {
+          this.dispatchEvent(new CustomEvent('ajax-success', {
+            detail: res.data
+          }));
+        } else {
+          this.dispatchEvent(new CustomEvent('ajax-success', {
+            detail: res
+          }));
+        }
+      } else {
+        this.dispatchError('Bad server response');
+      }
+    })
+    .catch(err => {
+      this.describeError(err);
+    }) 
+  }
+
+  describeError(err) {
+    if (err.response) {
+      const status = err.response.status;
+      switch (status) {
+        case 422: 
+        case 400: 
+          this.dispatchError(err.response.data.message, err.response.data.errors);
+          break;
+        case 404:
+          if(err.response.data.message) {
+            this.dispatchError(err.response.data.message);
+          } else {
+            this.dispatchError("Not found error");
+          }
+          break;
+        case 401:
+          this.dispatchError('Unauthorized. Your session may have expired');
+          break;
+        case 419:
+          this.dispatchError('Your session has expired. Please refresh the page');
+          break;
+        case 502:
+          this.dispatchError('Connection error, invalid gateway');
+          break;
+        case 504:
+          this.dispatchError('Connection timeout with the gateway');
+          break;
+        default:
+          this.dispatchError('Action not completed due to a server error');
+      }
+    } else {
+      this.dispatchError('No response received from the server');
+    }
+  }
+
+  dispatchError(message, errors = []) {
+    this.dispatchEvent(new CustomEvent('ajax-error', {
+      detail: {
+        message,
+        errors
+      } 
+    }));
+  }
+}
+

package/components/ajax-form/ajax-form.js

@@ -0,0 +1,2 @@
+import { DileAjaxForm } from './src/DileAjaxForm.js';
+customElements.define('dile-ajax-form', DileAjaxForm);

package/components/ajax-form/index.js

@@ -0,0 +1 @@
+export { DileAjaxForm } from './src/DileAjaxForm.js';

package/components/ajax-form/src/DileAjaxForm.js

@@ -0,0 +1,216 @@
+import { LitElement, html, css } from 'lit';
+import '../../ajax/ajax.js';
+import '@dile/ui/components/button/button.js';
+import '@dile/ui/components/inline-feedback/inline-feedback.js';
+import {capitalizeFirstLetter} from '../../../lib/capitalizeString.js';
+import { ResponseApiAdapter } from '../../../lib/ResponseApiAdapter.js';
+
+export class DileAjaxForm extends LitElement {
+    static styles = [
+        css`
+            :host {
+                display: block;
+            }
+            :host([small]) {
+                --dile-button-padding-y: 0.25rem;
+                --dile-button-padding-x: 0.5rem;
+                --dile-button-font-size: 0.875rem;
+            }
+            .actions {
+                margin-top: var(--dile-ajax-form-actions-margin-top, 1.2rem);
+                padding-left: 3px;
+            }
+        `
+    ];
+
+    static get properties() {
+      return {
+        operation: { type: String },
+        endpoint: { type: String },
+        actionLabel: { type: String },
+        data: { type: Object },
+        relatedId: { type: String },
+        loadOnInit: { type: Boolean },
+        buttonSmall: { type: Boolean, reflect: true },
+        formIdentifier: { type: String, },
+        setDataOnInit: { type: Boolean },
+        responseAdapter: { type: Object },
+      };
+    }
+
+    constructor() {
+        super();
+        this.responseAdapter = new ResponseApiAdapter();
+        this.formIdentifier = 'form';
+        this.operation = '';
+    }
+
+    updated(changedProperties) {
+        if (changedProperties.has('relatedId') || changedProperties.has('endpoint')) {
+            if(this.loadOnInit) {
+                this.loadData();
+            }
+        }
+    }
+
+    firstUpdated() {
+        this.feedback = this.shadowRoot.getElementById('feedback');
+        this.ajaxsave = this.shadowRoot.getElementById('ajaxsave');
+        this.ajaxget = this.shadowRoot.getElementById('ajaxget');
+        if(this.setDataOnInit) {
+            this.initData();
+        }
+        if(!this.actionLabel) {
+            this.actionLabel = capitalizeFirstLetter(this.operation);
+        }
+    }
+
+    get form() {
+        return this.querySelector('#' + this.formIdentifier);
+    }
+
+    render() {
+        return html`
+            ${this.ajaxComponents}
+            <slot></slot>
+            <dile-inline-feedback id="feedback"></dile-inline-feedback>
+            <div class="actions">
+                <dile-button @click=${this.doAction}>${this.actionLabel}</dile-button>
+            </div> 
+        `;
+    }
+
+    get ajaxComponents() {
+        return html`
+            <dile-ajax
+                id="ajaxget"
+                method="get"
+                url="${this.endpoint}/${this.relatedId}"
+                @ajax-success="${this.doSuccessGet}"
+                @ajax-error="${this.doErrorGet}"
+            ></dile-ajax>
+            <dile-ajax
+                id="ajaxsave"
+                method="${this.saveMethod(this.operation)}"
+                url="${this.endpoint}${this.operation == 'insert' ? '' : `/${this.relatedId}`}"
+                @ajax-success="${this.doSuccessSave}"
+                @ajax-error="${this.doErrorSave}"
+            ></dile-ajax>
+        `
+    }
+
+    loadData() {
+        this.ajaxget.generateRequest();
+    }
+
+    doAction() {
+        this.feedback.clear();
+        this.ajaxsave.data = this.form.getData();
+        this.ajaxsave.generateRequest();
+    }
+
+    doErrorGet(e) {
+        this.responseAdapter.setResponse(e.detail);
+        let msg = this.customMessage(false);
+        this.feedback.negativeFeedback(msg);
+        this.dispatchEvent(new CustomEvent('dile-ajax-form-get-error', { 
+            bubbles: true,
+            composed: true,
+            detail: {
+                msg: msg,
+                previousDetail: e.detail
+            }
+        }));
+    }
+
+    doSuccessGet(e) {
+        this.responseAdapter.setResponse(e.detail);
+        let data = this.responseAdapter.getData()
+        this.form.setData(data);
+        this.form.clearErrors();
+        this.feedback.clear();
+        this.dispatchEvent(new CustomEvent('dile-ajax-form-loaded', {
+            bubbles: true,
+            composed: true,
+            detail: {
+                data,
+                previousDetail: e.detail
+            }
+        }));
+    }
+    
+    doErrorSave(e) {
+        this.responseAdapter.setResponse(e.detail);
+        let msg = this.customMessage(true);
+        this.feedback.negativeFeedbackWithDelay(msg, 5000);
+        let validationErrors = this.responseAdapter.getValidationErrors();
+        this.form.showErrors(validationErrors);
+        this.dispatchEvent(new CustomEvent('save-error', { 
+            bubbles: true,
+            composed: true,
+            detail: {
+                msg, 
+                validationErrors,
+                previousDetail: e.detail
+            }
+        }));
+    }
+
+    doSuccessSave(e) {
+        this.responseAdapter.setResponse(e.detail);
+        let data = this.responseAdapter.getData();
+        let msg = this.customMessage(true);
+        this.feedback.positiveFeedbackWithDelay(msg, 5000);
+        this.dispatchEvent(new CustomEvent('save-success', { 
+            bubbles: true,
+            composed: true,
+            detail: {
+                data,
+                msg,
+                previousDetail: e.detail
+            }
+        }));
+        if(this.operation == 'insert') {
+            this.form.clearData();
+        }
+    }
+
+    saveMethod(operation) {
+        switch(operation) {
+            case 'insert':
+                return 'post';
+            case 'update':
+                return 'put';
+        }
+        throw "Operation not supported in fct-ajax-form use 'insert' or 'update'";
+    }
+
+    clearErrors() {
+        this.form.clearErrors();
+        this.feedback.clear();
+    }
+
+    clearFeedback() {
+        this.feedback.clear();
+    }
+
+    initData() {
+        if(this.form && this.form.setData) {
+            setTimeout(() => this.form.setData(this.data), 300);
+        } else {
+            setTimeout(this.initData.bind(this), 100);
+        }
+    }
+
+    customMessage(success) {
+        let message = this.responseAdapter.getMessage();
+        if(message) {
+            return message;
+        }
+        if(success) {
+            return `Success ${this.operation}`;
+        } 
+        return `Error ${this.operation}`;
+    }
+}
+

package/components/ajax-select-crud/ajax-select-crud.js

@@ -0,0 +1,3 @@
+import { DileAjaxSelectCrud } from './src/DileAjaxSelectCrud.js';
+
+customElements.define('dile-ajax-select-crud', DileAjaxSelectCrud);

package/components/ajax-select-crud/index.js

@@ -0,0 +1 @@
+export { DileAjaxSelectCrud } from './src/DileAjaxSelectCrud.js';