Denys Vuika 65d70bffb2
[ACS-6071] fix JSDoc issues for Core lib (#8942)
* fix jsdoc issues

* docs fixes

* doc fixes

* doc fixes

* fix docs

* fix bugs
2023-09-28 14:00:30 +01:00

272 lines
8.8 KiB
TypeScript

/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* eslint-disable @angular-eslint/no-input-rename */
import { Directive, ElementRef, HostListener, Input, NgZone, OnDestroy, OnInit, Renderer2 } from '@angular/core';
import { FileInfo, FileUtils } from '../common/utils/file-utils';
@Directive({
selector: '[adf-upload]'
})
export class UploadDirective implements OnInit, OnDestroy {
/** Enables/disables uploading. */
@Input('adf-upload')
enabled: boolean = true;
/** Data to upload. */
@Input('adf-upload-data')
data: any;
/**
* Upload mode. Can be "drop" (receives dropped files) or "click"
* (clicking opens a file dialog). Both modes can be active at once.
*/
@Input()
mode: string[] = ['drop']; // click|drop
/** Toggles multiple file uploads. */
@Input()
multiple: boolean;
/** (Click mode only) MIME type filter for files to accept. */
@Input()
accept: string;
/** (Click mode only) Toggles uploading of directories. */
@Input()
directory: boolean;
isDragging: boolean = false;
private cssClassName: string = 'adf-upload__dragging';
private upload: HTMLInputElement;
private element: HTMLElement;
constructor(private el: ElementRef, private renderer: Renderer2, private ngZone: NgZone) {
this.element = el.nativeElement;
}
ngOnInit() {
if (this.isClickMode() && this.renderer) {
const inputUpload = this.renderer.createElement('input');
this.upload = this.el.nativeElement.parentElement.appendChild(inputUpload);
this.upload.type = 'file';
this.upload.style.display = 'none';
this.upload.addEventListener('change', (event) => this.onSelectFiles(event));
if (this.multiple) {
this.upload.setAttribute('multiple', '');
}
if (this.accept) {
this.upload.setAttribute('accept', this.accept);
}
if (this.directory) {
this.upload.setAttribute('webkitdirectory', '');
}
}
if (this.isDropMode()) {
this.ngZone.runOutsideAngular(() => {
this.element.addEventListener('dragenter', this.onDragEnter.bind(this));
this.element.addEventListener('dragover', this.onDragOver.bind(this));
this.element.addEventListener('dragleave', this.onDragLeave.bind(this));
this.element.addEventListener('drop', this.onDrop.bind(this));
});
}
}
ngOnDestroy() {
this.element.removeEventListener('dragenter', this.onDragEnter);
this.element.removeEventListener('dragover', this.onDragOver);
this.element.removeEventListener('dragleave', this.onDragLeave);
this.element.removeEventListener('drop', this.onDrop);
}
@HostListener('click', ['$event'])
onClick(event: Event) {
if (this.isClickMode() && this.upload) {
event.preventDefault();
this.upload.click();
}
}
onDragEnter(event: DragEvent) {
if (this.isDropMode()) {
event.dataTransfer.dropEffect = 'copy';
this.element.classList.add(this.cssClassName);
this.isDragging = true;
}
}
onDragOver(event: DragEvent) {
event.preventDefault();
if (this.isDropMode()) {
event.dataTransfer.dropEffect = 'copy';
this.element.classList.add(this.cssClassName);
this.isDragging = true;
}
return false;
}
onDragLeave() {
if (this.isDropMode()) {
this.element.classList.remove(this.cssClassName);
this.isDragging = false;
}
}
onDrop(event: Event) {
if (this.isDropMode()) {
event.stopPropagation();
event.preventDefault();
this.element.classList.remove(this.cssClassName);
this.isDragging = false;
const dataTransfer = this.getDataTransfer(event);
if (dataTransfer) {
this.getFilesDropped(dataTransfer).then((files) => {
this.onUploadFiles(files);
});
}
}
return false;
}
onUploadFiles(files: FileInfo[]) {
if (this.enabled && files.length > 0) {
const customEvent = new CustomEvent('upload-files', {
detail: {
sender: this,
data: this.data,
files
},
bubbles: true
});
this.el.nativeElement.dispatchEvent(customEvent);
}
}
protected hasMode(mode: string): boolean {
return this.enabled && mode && this.mode && this.mode.indexOf(mode) > -1;
}
protected isDropMode(): boolean {
return this.hasMode('drop');
}
protected isClickMode(): boolean {
return this.hasMode('click');
}
getDataTransfer(event: Event | any): DataTransfer {
if (event?.dataTransfer) {
return event.dataTransfer;
}
if (event?.originalEvent?.dataTransfer) {
return event.originalEvent.dataTransfer;
}
return null;
}
/**
* Extract files from the DataTransfer object used to hold the data that is being dragged during a drag and drop operation.
*
* @param dataTransfer DataTransfer object
* @returns a list of file info objects
*/
getFilesDropped(dataTransfer: DataTransfer): Promise<FileInfo[]> {
return new Promise((resolve) => {
const iterations = [];
if (dataTransfer) {
const items = dataTransfer.items;
if (items) {
for (let i = 0; i < items.length; i++) {
if (typeof items[i].webkitGetAsEntry !== 'undefined') {
const item = items[i].webkitGetAsEntry();
if (item) {
if (item.isFile) {
iterations.push(
Promise.resolve({
entry: item,
file: items[i].getAsFile(),
relativeFolder: '/'
})
);
} else if (item.isDirectory) {
iterations.push(
new Promise((resolveFolder) => {
FileUtils.flatten(item).then((files) => resolveFolder(files));
})
);
}
}
} else {
iterations.push(
Promise.resolve({
entry: null,
file: items[i].getAsFile(),
relativeFolder: '/'
})
);
}
}
} else {
// safari or FF
const files = FileUtils.toFileArray(dataTransfer.files).map((file) => ({
entry: null,
file,
relativeFolder: '/'
}));
iterations.push(Promise.resolve(files));
}
}
Promise.all(iterations).then((result) => {
resolve(result.reduce((a, b) => a.concat(b), []));
});
});
}
/**
* Invoked when user selects files or folders by means of File Dialog
*
* @param event DOM event
*/
onSelectFiles(event: any): void {
if (this.isClickMode()) {
const input = event.currentTarget;
const files = FileUtils.toFileArray(input.files);
this.onUploadFiles(
files.map((file) => ({
entry: null,
file,
relativeFolder: '/'
}))
);
event.target.value = '';
}
}
}