@unicef-polymer/etools-unicef/src/etools-upload/etools-upload.js

eTools UNICEF library of reusable components

import { __decorate } from "tslib";
import { LitElement, html } from 'lit';
import { property, customElement } from 'lit/decorators.js';
import { ifDefined } from 'lit/directives/if-defined.js';
import '../etools-button/etools-button';
import '@shoelace-style/shoelace/dist/components/progress-bar/progress-bar.js';
import '../etools-icons/etools-icon';
import { CommonStyles } from './common-styles';
import { CommonMixin } from './common-mixin';
import { RequestHelperMixin } from './request-helper-mixin.js';
import { abortActiveRequests, getActiveXhrRequests } from '@unicef-polymer/etools-utils/dist/etools-ajax/upload-helper';
import { OfflineMixin } from './offline/offline-mixin';
import { getBlob, getFileUrl } from './offline/file-conversion';
import { storeFileInDexie } from './offline/dexie-operations';
import { getTranslation } from './utils/translate';
import { UploadsMixin } from './uploads-mixin';
let EtoolsUpload = class EtoolsUpload extends UploadsMixin(OfflineMixin(RequestHelperMixin(CommonMixin(LitElement)))) {
    render() {
        // language=HTML
        return html `
      ${CommonStyles}
      <style>
        :host {
          display: block;
          padding: 8px 0;
          --sl-input-required-content-offset: 3px;
          --sl-input-required-content-color: #ea4022;
          --sl-input-label-font-size-medium: var(--etools-font-size-12, 12px);
        }

        .form-control .form-control__label {
          display: none;
          font-size: var(--sl-input-label-font-size-medium);
        }
        /* Label */
        .form-control--has-label .form-control__label {
          display: block;
          color: var(--secondary-text-color);
          line-height: 18px;
          font-size: var(--etools-font-size-12, 12px);
        }

        :host([required]) .form-control--has-label .form-control__label::after {
          content: var(--sl-input-required-content);
          margin-inline-start: var(--sl-input-required-content-offset);
          color: var(--sl-input-required-content-color);
        }

        :host([readonly]) .form-control--has-label .form-control__label::after {
          content: '';
        }

        :host(:not([disabled]):not([readonly])) .invalid-message[visible] {
          font-size: var(--etools-font-size-12, 12px);
          visibility: visible;
          height: 0;
          overflow: visible;
        }

        .invalid-message {
          visibility: hidden;
          height: 0;
          overflow: hidden;
          white-space: nowrap;
        }

        .input::after {
          content: '';
          position: absolute;
          width: 100%;
          display: block;
          bottom: 0;
          border-bottom: 1px solid var(--secondary-text-color);
        }

        :host([invalid]:not([disabled]):not([readonly])) .form-control__label,
        :host([invalid]:not([disabled]):not([readonly])) .invalid-message {
          color: red;
        }
        #input-main-content {
          display: flex;
          flex-direction: row;
          align-items: center;
        }

        .filename-and-actions-container {
          display: flex;
          flex-direction: row;
          max-width: 100%;
        }

        .file-icon {
          padding-inline-end: 8px;
          color: var(--secondary-text-color, rgba(0, 0, 0, 0.54));
        }

        .filename-row {
          display: flex;
          flex-direction: row;
          align-items: center;
          border-bottom: 1px solid var(--secondary-text-color, rgba(0, 0, 0, 0.54));
        }

        .filename {
          overflow: hidden;
          text-overflow: ellipsis;
          white-space: nowrap;
        }

        :host([readonly]) .filename-row {
          border-bottom: none;
        }

        :host([disabled]) .filename-row {
          border-bottom: 1px dashed var(--secondary-text-color, rgba(0, 0, 0, 0.54));
        }

        .download-button::part(base) {
          justify-content: center;
          padding: 0 0;
          margin-inline-start: 8px;
          color: var(--etools-upload-primary-color, var(--primary-color));
        }

        .filename-container {
          display: flex;
          flex-direction: column;
          margin-inline-end: 8px;
          min-width: 145px;
          overflow-wrap: break-word;
          font-size: var(--etools-font-size-16, 16px);
        }

        .progress-container {
          display: flex;
          flex-direction: column;
          flex-wrap: nowrap;
          width: 100%;
        }

        sl-progress-bar {
          --indicator-color: var(--primary-color);
          --height: 4px;
          width: 100%;
        }
        sl-progress-bar::part(base) {
          border-radius: unset;
        }

        .progress-container span {
          font-size: var(--etools-font-size-11, 11px);
          margin: 0 auto;
        }

        .dw-icon {
          margin-inline-end: 8px;
        }

        .change-button::part(base) {
          color: var(--secondary-text-color, rgba(0, 0, 0, 0.54));
        }

        .readonly-placeholder {
          color: var(--secondary-text-color, rgba(0, 0, 0, 0.54));
        }

        .file-actions etools-button {
          vertical-align: middle;
        }

        .upload-button[disabled] {
          justify-content: flex-start;
        }

        etools-button[disabled]::part(base) {
          cursor: default;
          opacity: 1;
        }
      </style>
      <div
        part="form-control"
        class=${this.customClassMap({
            'form-control': true,
            'form-control--has-label': !this.noLabelFloat
        })}
      >
        <label
          id="label"
          part="form-control-label"
          class="form-control__label"
          aria-hidden=${!this._showLabel(this.label) ? 'false' : 'true'}
        >
          ${this.label}
        </label>

        <div slot="input">
          <etools-button
            variant="text"
            size="small"
            class="upload-button"
            @click="${this._openFileChooser}"
            title="${ifDefined(!this.readonly ? this.uploadBtnLabel || getTranslation(this.language, 'UPLOAD_FILE') : undefined)}"
            ?disabled="${this.readonly}"
            ?hidden="${this._thereIsAFileSelectedOrSaved(this._filename)}"
          >
            <span ?hidden="${this.readonly}">
              <etools-icon name="file-upload"></etools-icon>
              ${this.uploadBtnLabel || getTranslation(this.language, 'UPLOAD_FILE')}
            </span>
            <label class="readonly-placeholder" ?hidden="${!this.readonly}">—</label>
          </etools-button>

          <div class="filename-and-actions-container">
            <div class="filename-container" ?hidden="${!this._thereIsAFileSelectedOrSaved(this._filename)}">
              <div class="filename-row">
                <etools-icon class="file-icon" name="attachment"></etools-icon>
                <span class="filename" title="${this._filename}">${this._filename}</span>
              </div>
              ${this.uploadProgressValue
            ? html `
                    <div class="progress-container">
                      <sl-progress-bar .value="${this.uploadProgressValue}"></sl-progress-bar>
                      <span>${this.uploadProgressMsg}</span>
                      <div></div>
                    </div>
                  `
            : ''}
            </div>
            <div class="upload-status">
              <etools-icon
                title="${getTranslation(this.language, 'UPLOADED_SUCCESSFULY')}"
                name="done"
                ?hidden="${!this.success}"
              ></etools-icon>
              <etools-icon name="error-outline" ?hidden="${!this.fail}"></etools-icon>
            </div>

            <!-- File actions -->
            <div class="file-actions">
              <etools-button
                variant="text"
                class="download-button primary-btn"
                size="small"
                @click="${this._downloadFile}"
                ?disabled="${!this._showDownloadBtn(this.fileUrl)}"
                ?hidden="${!this._showDownloadBtn(this.fileUrl)}"
                title="${getTranslation(this.language, 'DOWNLOAD')}"
              >
                <etools-icon name="cloud-download" class="dw-icon"></etools-icon>
                ${getTranslation(this.language, 'DOWNLOAD')}
              </etools-button>

              <etools-button
                variant="text"
                size="small"
                class="change-button"
                @click="${this._changeFile}"
                ?disabled="${!this._showChange(this.readonly, this._filename, this.uploadInProgress)}"
                ?hidden="${!this._showChange(this.readonly, this._filename, this.uploadInProgress)}"
              >
                ${getTranslation(this.language, 'CHANGE')}
              </etools-button>

              <etools-button
                variant="text"
                size="small"
                class="delete-button"
                @click="${this._deleteFile}"
                ?disabled="${this.readonly}"
                ?hidden="${!this._showDeleteBtn(this.readonly, this._filename, this.showDeleteBtn, this.uploadInProgress)}"
              >
                ${getTranslation(this.language, 'DELETE')}
              </etools-button>

              <etools-button
                variant="text"
                size="small"
                class="delete-button"
                @click="${this._cancelUpload}"
                ?disabled="${!this._showCancelBtn(this.uploadInProgress, this.fileUrl, this.fail)}"
                ?hidden="${!this._showCancelBtn(this.uploadInProgress, this.fileUrl, this.fail)}"
              >
                ${getTranslation(this.language, 'CANCEL')}
              </etools-button>
            </div>
            <!-- ------------------ -->
          </div>

          <!-- Props -->
          <input hidden="" type="file" id="fileInput" @change="${this._fileSelected}" .accept="${this.accept}" />

          <a id="downloader" hidden=""></a>
        </div>

        <div part="invalid-message" class="invalid-message" ?visible=${this.invalid && this.errorMessage}>
          ${this.errorMessage}
        </div>
      </div>
    `;
    }
    set fileUrl(url) {
        // previous is unsaved (number or null),
        // incomming is a valid url of an uploaded and SAVED file
        if (!this.isNotNumber(this._fileUrl) && this.isNotNumber(url)) {
            this._savedFileUrl = null;
        }
        this._fileUrl = url;
        this._fileUrlChanged(url);
        this.autoValidateHandler();
    }
    get fileUrl() {
        return this._fileUrl;
    }
    set rawFile(file) {
        this._rawFile = file;
        this.autoValidateHandler();
    }
    get rawFile() {
        return this._rawFile;
    }
    set uploadedFileInfo(info) {
        if (!info) {
            return;
        }
        if (info.url) {
            this._fileUrl = info.url;
        }
        if (info.filename) {
            this._filename = info.filename;
        }
        this.requestUpdate();
    }
    constructor() {
        super();
        if (!this.language) {
            this.language = window.EtoolsLanguage || 'en';
        }
        this.handleLanguageChange = this.handleLanguageChange.bind(this);
        this.initializeProperties();
    }
    initializeProperties() {
        this.alwaysFloatLabel = true;
        this._fileUrl = null;
        this._filename = null;
        this._rawFile = null;
        this._cancelTriggered = null;
        this.showDeleteBtn = true;
        this.success = false;
        this.fail = false;
        this.showChange = true;
        this.allowMultilineFilename = false;
        this.uploadProgressValue = '';
        this.uploadProgressMsg = '';
    }
    connectedCallback() {
        super.connectedCallback();
        document.addEventListener('language-changed', this.handleLanguageChange);
        this.originalErrorMessage = this.errorMessage;
    }
    disconnectedCallback() {
        super.disconnectedCallback();
        document.removeEventListener('language-changed', this.handleLanguageChange);
    }
    handleLanguageChange(e) {
        this.language = e.detail.language;
    }
    _thereIsAFileSelectedOrSaved(_filename) {
        return !!_filename;
    }
    _fileSelected(e) {
        const file = e.target.files ? e.target.files[0] : null;
        if (!file) {
            return;
        }
        this._fireChangeFileEventIfApplicable();
        this.resetStatus();
        this.resetValidations();
        this._filename = file.name;
        this.rawFile = file;
        e.target.value = null;
        if (this.autoUpload) {
            this._handleUpload();
        }
    }
    _fireChangeFileEventIfApplicable() {
        if (this.fileUrl && !this.isNotNumber(this.fileUrl)) {
            // if fileUrl is a number , then the previous upload was not saved
            this.fireEvent('change-unsaved-file', true);
            if (this.trackUploadStatus && !this.readonly) {
                this._onChangeUnsavedFile();
            }
        }
    }
    async _handleUpload() {
        /**
         * Doing the extra validFileType validation because `accept` functionality can be bypassed
         * by selecting All Files from the File selection dialog
         */
        if (this.accept && !this.validFileType(this.rawFile.name)) {
            this.fail = true;
            return;
        }
        this._cancelTriggered = false;
        this.uploadInProgress = true;
        this.fireEvent('upload-started', true);
        if (this.trackUploadStatus && !this.readonly) {
            this._onUploadStarted();
        }
        if (this.activateOffline && navigator.onLine === false) {
            const response = await this.saveFileInIndexedDb(this.rawFile);
            this.uploadInProgress = false;
            this.fireEvent('upload-finished', response);
            if (this.trackUploadStatus && !this.readonly) {
                this._onUploadFinished(false);
            }
            setTimeout(() => {
                this.resetRawFile();
                this.resetUploadProgress();
            }, 10);
            return;
        }
        this.uploadRawFile(this.rawFile, this.rawFile.name, this.setUploadProgress.bind(this))
            .then((response) => {
            this.success = true;
            this.uploadInProgress = false;
            this.fireEvent('upload-finished', { success: response });
            if (this.trackUploadStatus && !this.readonly) {
                this._onUploadFinished(!!response);
            }
            setTimeout(() => {
                this.resetRawFile();
                this.resetUploadProgress();
            }, 10);
        })
            .catch((err) => {
            if (!this._cancelTriggered) {
                this.fail = true;
                const errorMessage = this.prepareErrorMessage(this.language, err);
                this.serverErrorMsg =
                    getTranslation(this.language, 'ERROR_UPLOADING') + (errorMessage ? ': ' + errorMessage : '');
                this.setInvalid(true, this.serverErrorMsg);
            }
            else {
                this.serverErrorMsg = getTranslation(this.language, 'UPLOAD_CANCELED');
                this.setInvalid(false, this.serverErrorMsg);
            }
            this.fireEvent('upload-finished', { error: err });
            if (this.trackUploadStatus && !this.readonly) {
                this._onUploadFinished(false);
            }
            this._cancelTriggered = false;
            this.uploadInProgress = false;
            this.resetUploadProgress();
        });
    }
    async saveFileInIndexedDb(file) {
        const fileInfo = this.getFileInfo(file);
        const blob = await getBlob(getFileUrl(file));
        const fileInfoForDb = JSON.parse(JSON.stringify(fileInfo));
        fileInfoForDb.binaryData = blob;
        try {
            await storeFileInDexie(fileInfoForDb);
            this.success = true;
            return { success: fileInfo };
        }
        catch (err) {
            this.fail = true;
            return { error: err };
        }
    }
    setInvalid(invalid, errMsg) {
        if (typeof errMsg === 'string') {
            this.errorMessage = errMsg;
        }
        this.invalid = invalid;
    }
    resetValidations() {
        this.invalid = false;
        this.errorMessage = '';
    }
    resetStatus() {
        this.success = null;
        this.fail = null;
        this.serverErrorMsg = null;
    }
    setUploadProgress(requestData) {
        if (!requestData) {
            this.uploadProgressValue = '';
        }
        else {
            this.uploadProgressMsg = `${Math.round(requestData.loaded / 1024)} kb of ${Math.round(requestData.total / 1024)} kb`;
            this.uploadProgressValue = `${(requestData.loaded * 100) / requestData.total}`;
        }
    }
    resetUploadProgress() {
        this.uploadProgressValue = '';
        this.uploadProgressMsg = '';
    }
    _fileUrlChanged(fileUrl) {
        if (fileUrl && !isNaN(fileUrl)) {
            // fileUrl is a number after the upload is finished
            // and becomes an url after the number is saved on the object=intervention, agreement etc
            return;
        }
        this.resetStatus();
        this._filename = this.getFilenameFromURL(fileUrl);
    }
    getFilenameFromURL(url) {
        if (!url) {
            return '';
        }
        // after upload, url might be a number, need to convert
        return String(url).split('?')[0].split('/').pop();
    }
    _showDownloadBtn(fileUrl) {
        return !!fileUrl && isNaN(fileUrl);
    }
    _showChange(readonly, _filename, uploadInProgress, showChange) {
        return (!readonly && _filename && !uploadInProgress) || showChange;
    }
    _showDeleteBtn(readonly, _filename, showDeleteBtn, uploadInProgress) {
        return !readonly && _filename && !uploadInProgress && showDeleteBtn;
    }
    _showCancelBtn(uploadInProgress, fileUrl, fail) {
        return uploadInProgress || (fileUrl && fail);
    }
    _cancelUpload() {
        this._resetFilename();
        const activeReqKeys = Object.keys(getActiveXhrRequests());
        this._cancelTriggered = true;
        if (this.uploadInProgress) {
            this.uploadInProgress = false;
            abortActiveRequests(activeReqKeys);
        }
        this.resetRawFile();
        this.resetValidations();
        this.fireEvent('upload-canceled', true);
        if (this.trackUploadStatus && !this.readonly) {
            this._onUploadDelete();
        }
    }
    _deleteFile() {
        this.fileUrl = null;
        this.resetStatus();
        this._resetFilename();
        this.resetRawFile();
        this.resetValidations();
        this.fireEvent('delete-file', { file: this.fileUrl });
        if (this.trackUploadStatus && !this.readonly) {
            this._onUploadDelete();
        }
    }
    _changeFile() {
        this._savedFileUrl = this.isNotNumber(this.fileUrl) ? this.fileUrl : null;
        this._openFileChooser();
    }
    _resetFilename() {
        this._filename = this.fileUrl && this.isNotNumber(this.fileUrl) ? this.getFilenameFromURL(this.fileUrl) : null;
    }
    isNotNumber(value) {
        return isNaN(Number(value));
    }
    resetRawFile() {
        var _a;
        this.rawFile = null;
        const fileInput = (_a = this.shadowRoot) === null || _a === void 0 ? void 0 : _a.querySelector('#fileInput');
        if (fileInput) {
            fileInput.value = '';
        }
    }
    _downloadFile(_e) {
        if (!this.fileUrl || !this.isNotNumber(this.fileUrl)) {
            return;
        }
        this.downloadFile(this._filename, this.fileUrl, this.openInNewTab);
    }
    validate() {
        let valid = true;
        let errMsg = this.originalErrorMessage;
        if (this.required) {
            const uploadRequestFailed = this.rawFile instanceof File && this.fail === true;
            if (!this.rawFile && !this.fileUrl) {
                valid = false;
                errMsg = getTranslation(this.language, 'REQUIRED_FIELD');
            }
            if (uploadRequestFailed) {
                valid = false;
                errMsg = this.serverErrorMsg;
            }
        }
        this.setInvalid(!valid, errMsg);
        return valid;
    }
    autoValidateHandler() {
        if (typeof this.fileUrl === 'undefined') {
            this.resetStatus();
            this.invalid = false;
            return;
        }
        if (this.autoValidate) {
            this.validate();
        }
    }
    _invalidChanged() {
        super._invalidChanged();
        if (!this.invalid) {
            if (this.fail) {
                // clean up after a failed upload
                this._resetFilename();
                this.resetRawFile();
            }
            this.resetStatus();
            this.resetValidations();
        }
    }
    validFileType(fileName) {
        const acceptedExtensions = this.accept.split(',');
        const fileExtension = this._getFileExtension(fileName);
        if (acceptedExtensions.indexOf('.' + fileExtension) > -1) {
            return true;
        }
        this.setInvalid(true, `${getTranslation(this.language, 'PLEASE_CHANGE_FILE')}: ${this.accept}}`);
        return false;
    }
    /* This solution also handles some edge cases
    The return values of lastIndexOf for parameter 'filename' and '.hiddenfile' are -1 and 0 respectively.
    Zero-fill right shift operator(»>) will transform - 1 to 4294967295 and - 2 to 4294967294,
    here is one trick to insure the filename unchanged in those edge cases.
    String.prototype.slice() extracts file extension from the index that was calculated above.
    If the index is more than the length of the filename, the result is "".
    Example of return values:
    '' => ''
    'filename' => ''
    'filename.txt' => 'txt'
    '.hiddenfile' => ''
    'filename.with.many.dots.ext'	=> 'ext'*/
    _getFileExtension(fileName) {
        return fileName.slice(((fileName.lastIndexOf('.') - 1) >>> 0) + 2);
    }
    customClassMap(classes) {
        return Object.keys(classes)
            .filter((className) => classes[className])
            .join(' ');
    }
};
__decorate([
    property({ type: String, reflect: true, attribute: 'upload-btn-label' })
], EtoolsUpload.prototype, "uploadBtnLabel", void 0);
__decorate([
    property({ type: Boolean, attribute: 'no-label-float' })
], EtoolsUpload.prototype, "noLabelFloat", void 0);
__decorate([
    property({ type: Boolean, reflect: true, attribute: 'always-float-label' })
], EtoolsUpload.prototype, "alwaysFloatLabel", void 0);
__decorate([
    property({ type: String, reflect: true, attribute: 'file-url' })
], EtoolsUpload.prototype, "_fileUrl", void 0);
__decorate([
    property({ type: String })
], EtoolsUpload.prototype, "_filename", void 0);
__decorate([
    property({ type: Object, attribute: 'raw-file' })
], EtoolsUpload.prototype, "_rawFile", void 0);
__decorate([
    property({ type: Boolean, reflect: true, attribute: 'show-delete-btn' })
], EtoolsUpload.prototype, "showDeleteBtn", void 0);
__decorate([
    property({ type: String, attribute: 'original-error-message' })
], EtoolsUpload.prototype, "originalErrorMessage", void 0);
__decorate([
    property({ type: String, attribute: 'server-error-msg' })
], EtoolsUpload.prototype, "serverErrorMsg", void 0);
__decorate([
    property({ type: Boolean, reflect: true })
], EtoolsUpload.prototype, "success", void 0);
__decorate([
    property({ type: Boolean, reflect: true })
], EtoolsUpload.prototype, "fail", void 0);
__decorate([
    property({ type: Boolean, reflect: true, attribute: 'show-change' })
], EtoolsUpload.prototype, "showChange", void 0);
__decorate([
    property({ type: Boolean, reflect: true, attribute: 'allow-multiline-filename' })
], EtoolsUpload.prototype, "allowMultilineFilename", void 0);
__decorate([
    property({ type: String, reflect: true, attribute: 'upload-progress-value' })
], EtoolsUpload.prototype, "uploadProgressValue", void 0);
__decorate([
    property({ type: String, reflect: true, attribute: 'upload-progress-msg' })
], EtoolsUpload.prototype, "uploadProgressMsg", void 0);
__decorate([
    property({ type: String })
], EtoolsUpload.prototype, "language", void 0);
__decorate([
    property({ type: Boolean })
], EtoolsUpload.prototype, "_cancelTriggered", void 0);
__decorate([
    property({ type: String })
], EtoolsUpload.prototype, "_savedFileUrl", void 0);
__decorate([
    property({ type: Boolean, attribute: 'track-upload-status' })
], EtoolsUpload.prototype, "trackUploadStatus", void 0);
EtoolsUpload = __decorate([
    customElement('etools-upload')
], EtoolsUpload);
export { EtoolsUpload };