@livenetworks/ashlar 1.6.1 → 2.0.0

package/components/ln-upload/src/ln-upload.js

@@ -0,0 +1,652 @@
+import { buildDict, cloneTemplateScoped, dispatch, dispatchCancelable, fill, getLocale, registerComponent, defineAttrs, attrSpec, attrStr, attrInt } from '../../ln-core';
+import { formatFileSize, getFileExtension, isFileTypeAllowed, parseAcceptExtensions } from './upload-model.js';
+
+(function () {
+	const DOM_SELECTOR = 'data-ln-upload';
+	const DOM_ATTRIBUTE = 'lnUpload';
+	const DEFAULT_FILE_FIELD = 'file';
+	const DEFAULT_IDS_FIELD = 'file_ids[]';
+
+	if (window[DOM_ATTRIBUTE] !== undefined) return;
+
+	// ─── Attribute Contract (SSOT) ──────────────────────────
+	const ATTRIBUTES = {
+		'data-ln-upload':            { prop: 'uploadUrl', read: attrStr, type: 'string', fallback: '', description: 'Endpoint URL for file uploads' },
+		'data-ln-upload-accept':     { type: 'string', description: 'Comma-separated list of allowed file extensions or MIME types' },
+		'data-ln-upload-delete':     { prop: 'deleteUrlPattern', read: attrStr, type: 'string', fallback: '', description: 'Endpoint URL pattern for deleting uploaded files' },
+		'data-ln-upload-max-size':   { prop: 'maxSize', read: attrInt, type: 'integer', fallback: 0, min: 0, description: 'Maximum allowed file size in bytes (0 for unlimited)' },
+		'data-ln-upload-max-files':  { prop: 'maxFiles', read: attrInt, type: 'integer', fallback: 0, min: 0, description: 'Maximum number of files allowed in upload queue (0 for unlimited)' },
+		'data-ln-upload-file-field': { prop: 'fileFieldName', read: attrStr, type: 'string', fallback: DEFAULT_FILE_FIELD, description: 'Form data field name used for file payloads' },
+		'data-ln-upload-ids-field':  { prop: 'idsFieldName', read: attrStr, type: 'string', fallback: DEFAULT_IDS_FIELD, description: 'Form field name for submitting uploaded file IDs' },
+		'data-ln-upload-dict':       { type: 'string', description: 'Dictionary key prefix mapping for translatable upload messages' },
+		'data-ln-upload-zone':       { type: 'marker', description: 'Designates container as dropzone for drag-and-drop file uploads' },
+		'data-ln-upload-list':       { type: 'marker', description: 'Container element holding rendered upload items' },
+		'data-ln-upload-item':       { type: 'marker', description: 'Container element for an individual file upload item' },
+		'data-ln-upload-action':     { type: 'enum', values: ['remove', 'retry'], description: 'Action button within upload item' },
+		'data-ln-upload-state':      { type: 'enum', values: ['ready', 'dragover', 'pending', 'uploading', 'success', 'error'], description: 'Runtime status of dropzone or individual upload item' },
+		'data-ln-upload-id':         { type: 'string', description: 'Server-assigned file identifier for completed upload' },
+		'data-ln-upload-local-id':   { type: 'string', description: 'Client-generated unique ID for tracking file item in DOM' },
+		'data-ln-upload-size':       { type: 'integer', min: 0, description: 'File size in bytes' },
+		'data-ln-upload-ext':        { type: 'string', description: 'Normalized file extension' }
+	};
+	const ATTR_SPEC = attrSpec(ATTRIBUTES);
+
+	function _formatSize(bytes, locale, dict) {
+		return formatFileSize(bytes, locale, dict);
+	}
+
+	function _getCsrfToken() {
+		const meta = document.querySelector('meta[name="csrf-token"]');
+		return meta ? meta.getAttribute('content') : '';
+	}
+
+	// ─── Component Constructor ─────────────────────────────
+
+	function _component(dom) {
+		this.dom = dom;
+		defineAttrs(this, dom, ATTR_SPEC);
+		this.dict = buildDict(dom, 'data-ln-upload-dict');
+		this.locale = getLocale(dom);
+
+		this.zone = dom.querySelector('[data-ln-upload-zone]') || dom;
+		this.list = dom.querySelector('[data-ln-upload-list]');
+		this.input = dom.querySelector('input[type="file"]');
+
+		if (!this.input) {
+			console.warn('[ln-upload] Missing <input type="file"> in container:', dom);
+		}
+
+		const acceptStr = dom.getAttribute('data-ln-upload-accept') || (this.input ? this.input.getAttribute('accept') : '');
+		this.allowedExts = parseAcceptExtensions(acceptStr);
+
+		this.uploadedFiles = new Map();
+		this.fileIdCounter = 0;
+		this._dragDepth = 0;
+
+		this._hydrate();
+		this._bindEvents();
+
+		return this;
+	}
+
+	// ─── Hydration of Pre-rendered SSR Files ────────────────
+
+	_component.prototype._hydrate = function () {
+		const self = this;
+		if (!this.list) return;
+
+		const items = this.list.querySelectorAll('[data-ln-upload-item]');
+		for (let i = 0; i < items.length; i++) {
+			const item = items[i];
+			const serverId = item.getAttribute('data-ln-upload-id');
+			const localId = 'file-' + (++self.fileIdCounter);
+
+			item.setAttribute('data-ln-upload-local-id', localId);
+
+			const nameEl = item.querySelector('[data-ln-field="name"]');
+			const sizeEl = item.querySelector('[data-ln-field="sizeText"]');
+			const rawSize = item.getAttribute('data-ln-upload-size');
+			const parsedSize = rawSize ? parseInt(rawSize, 10) : null;
+
+			self.uploadedFiles.set(localId, {
+				serverId: serverId || null,
+				name: nameEl ? nameEl.textContent.trim() : '',
+				size: (parsedSize !== null && !isNaN(parsedSize)) ? parsedSize : (sizeEl ? sizeEl.textContent.trim() : '')
+			});
+		}
+
+		// Also discover any pre-existing hidden inputs that might not have matching list items
+		const hiddenInputs = this.dom.querySelectorAll('input[type="hidden"]');
+		for (let i = 0; i < hiddenInputs.length; i++) {
+			const input = hiddenInputs[i];
+			if (input.name === self.idsFieldName && input.value) {
+				const existing = Array.from(self.uploadedFiles.values()).some(function (f) {
+					return String(f.serverId) === String(input.value);
+				});
+				if (!existing) {
+					const localId = 'file-' + (++self.fileIdCounter);
+					self.uploadedFiles.set(localId, {
+						serverId: input.value,
+						name: '',
+						size: ''
+					});
+				}
+			}
+		}
+
+		this._syncHiddenInputs();
+	};
+
+	// ─── Hidden Inputs Sync ────────────────────────────────
+
+	_component.prototype._syncHiddenInputs = function () {
+		const self = this;
+		const currentHidden = this.dom.querySelectorAll('input[type="hidden"]');
+		for (let i = 0; i < currentHidden.length; i++) {
+			if (currentHidden[i].name === self.idsFieldName) {
+				currentHidden[i].remove();
+			}
+		}
+
+		for (const [, fileData] of this.uploadedFiles) {
+			if (fileData.serverId) {
+				const input = document.createElement('input');
+				input.type = 'hidden';
+				input.name = self.idsFieldName;
+				input.value = fileData.serverId;
+				self.dom.appendChild(input);
+			}
+		}
+	};
+
+	// ─── Event Binding ─────────────────────────────────────
+
+	_component.prototype._bindEvents = function () {
+		const self = this;
+
+		this._onZoneClick = function (e) {
+			if (self.zone === self.dom) {
+				if (e.target.closest('[data-ln-upload-list], [data-ln-upload-action], input, button, a')) return;
+			}
+			if (self.input && e.target !== self.input) {
+				self.input.click();
+			}
+		};
+
+		this._onInputChange = function () {
+			if (self.input && self.input.files) {
+				self.upload(self.input.files);
+				self.input.value = '';
+			}
+		};
+
+		this._onDragEnter = function (e) {
+			e.preventDefault();
+			e.stopPropagation();
+			self._dragDepth++;
+			self.zone.setAttribute('data-ln-upload-state', 'dragover');
+		};
+
+		this._onDragOver = function (e) {
+			e.preventDefault();
+			e.stopPropagation();
+			self.zone.setAttribute('data-ln-upload-state', 'dragover');
+		};
+
+		this._onDragLeave = function (e) {
+			e.preventDefault();
+			e.stopPropagation();
+			self._dragDepth--;
+			if (self._dragDepth <= 0) {
+				self._dragDepth = 0;
+				self.zone.removeAttribute('data-ln-upload-state');
+			}
+		};
+
+		this._onDrop = function (e) {
+			e.preventDefault();
+			e.stopPropagation();
+			self._dragDepth = 0;
+			self.zone.removeAttribute('data-ln-upload-state');
+			if (e.dataTransfer && e.dataTransfer.files) {
+				self.upload(e.dataTransfer.files);
+			}
+		};
+
+		this._onListClick = function (e) {
+			const removeBtn = e.target.closest('[data-ln-upload-action="remove"]');
+			if (!removeBtn || !self.list || !self.list.contains(removeBtn)) return;
+			if (removeBtn.disabled) return;
+			const item = removeBtn.closest('[data-ln-upload-item]');
+			if (item) {
+				const localId = item.getAttribute('data-ln-upload-local-id');
+				if (localId) self.remove(localId);
+			}
+		};
+
+		// Inbound Request Command listeners (CQS)
+		this._onRequestUpload = function (e) {
+			if (e.detail && e.detail.files) {
+				self.upload(e.detail.files);
+			}
+		};
+
+		this._onRequestRemove = function (e) {
+			if (e.detail) {
+				const id = e.detail.localId !== undefined ? e.detail.localId : e.detail.serverId;
+				if (id !== undefined) self.remove(id);
+			}
+		};
+
+		this._onRequestClear = function () {
+			self.clear();
+		};
+
+		this.zone.addEventListener('click', this._onZoneClick);
+		if (this.input) {
+			this.input.addEventListener('change', this._onInputChange);
+		}
+		this.zone.addEventListener('dragenter', this._onDragEnter);
+		this.zone.addEventListener('dragover', this._onDragOver);
+		this.zone.addEventListener('dragleave', this._onDragLeave);
+		this.zone.addEventListener('drop', this._onDrop);
+
+		if (this.list) {
+			this.list.addEventListener('click', this._onListClick);
+		}
+
+		this.dom.addEventListener('ln-upload:request-upload', this._onRequestUpload);
+		this.dom.addEventListener('ln-upload:request-remove', this._onRequestRemove);
+		this.dom.addEventListener('ln-upload:request-clear', this._onRequestClear);
+	};
+
+	// ─── File Upload Mechanics ─────────────────────────────
+
+	_component.prototype.upload = function (files) {
+		const self = this;
+		const fileList = Array.from(files);
+
+		for (let i = 0; i < fileList.length; i++) {
+			const file = fileList[i];
+
+			// Validate maximum files constraint
+			if (self.maxFiles > 0 && self.uploadedFiles.size >= self.maxFiles) {
+				dispatch(self.dom, 'ln-upload:invalid', {
+					file: file,
+					reason: 'max-files'
+				});
+				continue;
+			}
+
+			// Validate file extension / MIME type
+			if (!isFileTypeAllowed(file, self.allowedExts)) {
+				dispatch(self.dom, 'ln-upload:invalid', {
+					file: file,
+					reason: 'accept'
+				});
+				continue;
+			}
+
+			// Validate file max size in bytes
+			if (self.maxSize > 0 && file.size > self.maxSize) {
+				dispatch(self.dom, 'ln-upload:invalid', {
+					file: file,
+					reason: 'max-size'
+				});
+				continue;
+			}
+
+			// Cancelable before event
+			const before = dispatchCancelable(self.dom, 'ln-upload:before-upload', { file: file });
+			if (before.defaultPrevented) continue;
+
+			self._uploadSingleFile(file);
+		}
+	};
+
+	_component.prototype._uploadSingleFile = function (file) {
+		const self = this;
+		const localId = 'file-' + (++self.fileIdCounter);
+		const ext = getFileExtension(file.name);
+
+		let item = null;
+		if (this.list) {
+			const fragment = cloneTemplateScoped(this.dom, 'ln-upload-item', 'ln-upload');
+			if (fragment) {
+				item = fragment.firstElementChild;
+				if (item) {
+					item.setAttribute('data-ln-upload-item', '');
+					item.setAttribute('data-ln-upload-local-id', localId);
+					item.setAttribute('data-ln-upload-ext', ext);
+					item.setAttribute('data-ln-upload-state', 'uploading');
+
+					fill(item, {
+						name: file.name,
+						sizeText: '0%',
+						removeLabel: self.dict['remove'] || 'Remove',
+						uploading: true,
+						error: false,
+						deleting: false
+					});
+
+					const removeBtn = item.querySelector('[data-ln-upload-action="remove"]');
+					if (removeBtn) removeBtn.disabled = true;
+
+					const progressEl = item.querySelector('[data-ln-progress]');
+					if (progressEl) progressEl.setAttribute('data-ln-progress', '0');
+
+					self.list.appendChild(item);
+				}
+			}
+		}
+
+		// Prepare multipart FormData
+		const formData = new FormData();
+		formData.append(self.fileFieldName, file);
+
+		// Gather nested inputs, excluding file fields, unchecked inputs, and the hidden idsField
+		const nestedInputs = this.dom.querySelectorAll('input, select, textarea');
+		for (let i = 0; i < nestedInputs.length; i++) {
+			const el = nestedInputs[i];
+			if (!el.name || el.name === self.idsFieldName || el.type === 'file') continue;
+			if ((el.type === 'checkbox' || el.type === 'radio') && !el.checked) continue;
+			formData.append(el.name, el.value);
+		}
+
+		const xhr = new XMLHttpRequest();
+		self.uploadedFiles.set(localId, {
+			serverId: null,
+			name: file.name,
+			size: file.size,
+			xhr: xhr
+		});
+
+		xhr.upload.addEventListener('progress', function (e) {
+			if (e.lengthComputable) {
+				const percent = Math.round((e.loaded / e.total) * 100);
+				if (item) {
+					const progressEl = item.querySelector('[data-ln-progress]');
+					if (progressEl) progressEl.setAttribute('data-ln-progress', String(percent));
+					fill(item, { sizeText: percent + '%' });
+				}
+				dispatch(self.dom, 'ln-upload:progress', {
+					localId: localId,
+					file: file,
+					percent: percent,
+					loaded: e.loaded,
+					total: e.total
+				});
+			}
+		});
+
+		xhr.addEventListener('load', function () {
+			const entry = self.uploadedFiles.get(localId);
+			if (entry) delete entry.xhr;
+
+			if (xhr.status >= 200 && xhr.status < 300) {
+				let data;
+				try {
+					data = JSON.parse(xhr.responseText);
+				} catch (e) {
+					handleError(self.dict['error'] || 'Error', xhr.status, e);
+					return;
+				}
+
+				const serverId = data.id || data.serverId;
+				if (item) {
+					item.removeAttribute('data-ln-upload-state');
+					if (serverId) item.setAttribute('data-ln-upload-id', String(serverId));
+					fill(item, {
+						sizeText: _formatSize(data.size || file.size, self.locale, self.dict),
+						uploading: false
+					});
+					const removeBtn = item.querySelector('[data-ln-upload-action="remove"]');
+					if (removeBtn) removeBtn.disabled = false;
+				}
+
+				if (entry) {
+					entry.serverId = serverId;
+					entry.size = data.size || file.size;
+					entry.name = data.name || file.name;
+				}
+
+				self._syncHiddenInputs();
+
+				dispatch(self.dom, 'ln-upload:uploaded', {
+					localId: localId,
+					serverId: serverId,
+					name: data.name || file.name,
+					size: data.size || file.size,
+					response: data
+				});
+			} else {
+				let message = '';
+				try {
+					const errData = JSON.parse(xhr.responseText);
+					message = errData.message || '';
+				} catch (e) {}
+				handleError(message, xhr.status, null);
+			}
+		});
+
+		xhr.addEventListener('error', function () {
+			const entry = self.uploadedFiles.get(localId);
+			if (entry) delete entry.xhr;
+			handleError('', 0, null);
+		});
+
+		function handleError(message, status, err) {
+			if (item) {
+				item.setAttribute('data-ln-upload-state', 'error');
+				fill(item, {
+					sizeText: self.dict['error'] || 'Error',
+					uploading: false,
+					error: true
+				});
+				const removeBtn = item.querySelector('[data-ln-upload-action="remove"]');
+				if (removeBtn) removeBtn.disabled = false;
+			}
+
+			dispatch(self.dom, 'ln-upload:error', {
+				file: file,
+				message: message,
+				status: status,
+				error: err
+			});
+		}
+
+		if (self.uploadUrl) {
+			xhr.open('POST', self.uploadUrl);
+			xhr.setRequestHeader('X-CSRF-TOKEN', _getCsrfToken());
+			xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
+			xhr.setRequestHeader('Accept', 'application/json');
+			xhr.send(formData);
+		} else {
+			console.warn('[ln-upload] No upload URL configured (missing data-ln-upload)');
+		}
+	};
+
+	// ─── File Removal & Deletion Mechanics ─────────────────
+
+	_component.prototype.remove = function (id) {
+		const self = this;
+
+		// Resolve by localId or serverId
+		let targetLocalId = null;
+		let fileData = null;
+
+		if (self.uploadedFiles.has(id)) {
+			targetLocalId = id;
+			fileData = self.uploadedFiles.get(id);
+		} else {
+			for (const [locId, data] of self.uploadedFiles) {
+				if (String(data.serverId) === String(id)) {
+					targetLocalId = locId;
+					fileData = data;
+					break;
+				}
+			}
+		}
+
+		if (!targetLocalId || !fileData) return;
+
+		// Cancelable before event
+		const before = dispatchCancelable(self.dom, 'ln-upload:before-remove', {
+			localId: targetLocalId,
+			serverId: fileData.serverId
+		});
+		if (before.defaultPrevented) return;
+
+		const item = self.list ? self.list.querySelector('[data-ln-upload-local-id="' + targetLocalId + '"]') : null;
+
+		// If upload was active and in-flight, abort it
+		if (fileData.xhr && typeof fileData.xhr.abort === 'function') {
+			fileData.xhr.abort();
+		}
+
+		// If the file has no serverId, simply remove from DOM and state
+		if (!fileData.serverId) {
+			if (item) item.remove();
+			self.uploadedFiles.delete(targetLocalId);
+			self._syncHiddenInputs();
+			dispatch(self.dom, 'ln-upload:removed', { localId: targetLocalId, serverId: null });
+			return;
+		}
+
+		// Resolve delete URL
+		let deleteUrl = null;
+		if (self.deleteUrlPattern) {
+			deleteUrl = self.deleteUrlPattern.replace('{id}', encodeURIComponent(fileData.serverId));
+		} else if (self.uploadUrl && self.uploadUrl.includes('{id}')) {
+			deleteUrl = self.uploadUrl.replace('{id}', encodeURIComponent(fileData.serverId));
+		}
+
+		if (!deleteUrl) {
+			// No delete endpoint configured — clean up locally and emit removed event
+			if (item) item.remove();
+			self.uploadedFiles.delete(targetLocalId);
+			self._syncHiddenInputs();
+			dispatch(self.dom, 'ln-upload:removed', { localId: targetLocalId, serverId: fileData.serverId });
+			return;
+		}
+
+		if (item) {
+			item.setAttribute('data-ln-upload-state', 'deleting');
+			fill(item, { deleting: true });
+		}
+
+		fetch(deleteUrl, {
+			method: 'DELETE',
+			headers: {
+				'X-CSRF-TOKEN': _getCsrfToken(),
+				'X-Requested-With': 'XMLHttpRequest',
+				'Accept': 'application/json'
+			}
+		})
+			.then(function (response) {
+				if (response.ok) {
+					if (item) item.remove();
+					self.uploadedFiles.delete(targetLocalId);
+					self._syncHiddenInputs();
+					dispatch(self.dom, 'ln-upload:removed', {
+						localId: targetLocalId,
+						serverId: fileData.serverId
+					});
+				} else {
+					if (item) {
+						item.removeAttribute('data-ln-upload-state');
+						fill(item, { deleting: false });
+					}
+					dispatch(self.dom, 'ln-upload:error', {
+						file: fileData,
+						message: '',
+						status: response.status
+					});
+				}
+			})
+			.catch(function (error) {
+				if (item) {
+					item.removeAttribute('data-ln-upload-state');
+					fill(item, { deleting: false });
+				}
+				dispatch(self.dom, 'ln-upload:error', {
+					file: fileData,
+					message: '',
+					status: 0,
+					error: error
+				});
+			});
+	};
+
+	_component.prototype.clear = function () {
+		const self = this;
+		const before = dispatchCancelable(self.dom, 'ln-upload:before-clear', {});
+		if (before.defaultPrevented) return;
+
+		for (const [, fileData] of this.uploadedFiles) {
+			if (fileData.xhr && typeof fileData.xhr.abort === 'function') {
+				fileData.xhr.abort();
+			}
+			if (fileData.serverId) {
+				let deleteUrl = null;
+				if (self.deleteUrlPattern) {
+					deleteUrl = self.deleteUrlPattern.replace('{id}', encodeURIComponent(fileData.serverId));
+				} else if (self.uploadUrl && self.uploadUrl.includes('{id}')) {
+					deleteUrl = self.uploadUrl.replace('{id}', encodeURIComponent(fileData.serverId));
+				}
+				if (deleteUrl) {
+					fetch(deleteUrl, {
+						method: 'DELETE',
+						headers: {
+							'X-CSRF-TOKEN': _getCsrfToken(),
+							'X-Requested-With': 'XMLHttpRequest',
+							'Accept': 'application/json'
+						}
+					}).catch(function () {});
+				}
+			}
+		}
+
+		self.uploadedFiles.clear();
+		if (self.list) self.list.innerHTML = '';
+		self._syncHiddenInputs();
+		dispatch(self.dom, 'ln-upload:cleared', {});
+	};
+
+	_component.prototype.getFileIds = function () {
+		return Array.from(this.uploadedFiles.values())
+			.map(function (f) { return f.serverId; })
+			.filter(Boolean);
+	};
+
+	_component.prototype.getFiles = function () {
+		return Array.from(this.uploadedFiles.values()).map(function (f) {
+			return {
+				serverId: f.serverId,
+				name: f.name,
+				size: f.size
+			};
+		});
+	};
+
+	// ─── Destroy Lifecycle ─────────────────────────────────
+
+	_component.prototype.destroy = function () {
+		if (!this.dom[DOM_ATTRIBUTE]) return;
+
+		// Abort in-flight XHRs
+		for (const [, fileData] of this.uploadedFiles) {
+			if (fileData.xhr && typeof fileData.xhr.abort === 'function') {
+				fileData.xhr.abort();
+			}
+		}
+
+		this.zone.removeEventListener('click', this._onZoneClick);
+		if (this.input) {
+			this.input.removeEventListener('change', this._onInputChange);
+		}
+		this.zone.removeEventListener('dragenter', this._onDragEnter);
+		this.zone.removeEventListener('dragover', this._onDragOver);
+		this.zone.removeEventListener('dragleave', this._onDragLeave);
+		this.zone.removeEventListener('drop', this._onDrop);
+
+		if (this.list) {
+			this.list.removeEventListener('click', this._onListClick);
+		}
+
+		this.dom.removeEventListener('ln-upload:request-upload', this._onRequestUpload);
+		this.dom.removeEventListener('ln-upload:request-remove', this._onRequestRemove);
+		this.dom.removeEventListener('ln-upload:request-clear', this._onRequestClear);
+
+		this.uploadedFiles.clear();
+		this.dict = {};
+
+		delete this.dom[DOM_ATTRIBUTE];
+	};
+
+	// ─── Registration ──────────────────────────────────────
+
+	registerComponent(DOM_SELECTOR, DOM_ATTRIBUTE, _component, 'ln-upload', {
+		attributes: ATTRIBUTES
+	});
+})();