@vonage/vivid 5.18.0 → 5.19.0

package/unbundled/definition34.cjs

@@ -173,12 +173,33 @@ function makeSerializationNoop(type) {
 	type.prototype.toJSON = noop;
 }
 Object.freeze({
+	/**
+	* Not aspected.
+	*/
 	none: 0,
+	/**
+	* An attribute.
+	*/
 	attribute: 1,
+	/**
+	* A boolean attribute.
+	*/
 	booleanAttribute: 2,
+	/**
+	* A property.
+	*/
 	property: 3,
+	/**
+	* Content
+	*/
 	content: 4,
+	/**
+	* A token list.
+	*/
 	tokenList: 5,
+	/**
+	* An event.
+	*/
 	event: 6
 });
 var createHTML = (html) => html;
@@ -197,16 +218,43 @@ var fastPolicy = defaultPolicy;
 * @public
 */
 var DOM = Object.freeze({
+	/**
+	* Gets the dom policy used by the templating system.
+	*/
 	get policy() {
 		return defaultPolicy;
 	},
+	/**
+	* Sets the dom policy used by the templating system.
+	* @param policy - The policy to set.
+	* @remarks
+	* This API can only be called once, for security reasons. It should be
+	* called by the application developer at the start of their program.
+	*/
 	setPolicy(value) {
 		if (defaultPolicy !== fastPolicy) throw FAST.error(1201);
 		defaultPolicy = value;
 	},
+	/**
+	* Sets an attribute value on an element.
+	* @param element - The element to set the attribute value on.
+	* @param attributeName - The attribute name to set.
+	* @param value - The value of the attribute to set.
+	* @remarks
+	* If the value is `null` or `undefined`, the attribute is removed, otherwise
+	* it is set to the provided value using the standard `setAttribute` API.
+	*/
 	setAttribute(element, attributeName, value) {
 		value === null || value === void 0 ? element.removeAttribute(attributeName) : element.setAttribute(attributeName, value);
 	},
+	/**
+	* Sets a boolean attribute value.
+	* @param element - The element to set the boolean attribute value on.
+	* @param attributeName - The attribute name to set.
+	* @param value - The value of the attribute to set.
+	* @remarks
+	* If the value is true, the attribute is added; otherwise it is removed.
+	*/
 	setBooleanAttribute(element, attributeName, value) {
 		value ? element.setAttribute(attributeName, "") : element.removeAttribute(attributeName);
 	}
@@ -404,7 +452,14 @@ var PropertyChangeNotifier = class {
 * @public
 */
 var SourceLifetime = Object.freeze({
+	/**
+	* The source to controller lifetime relationship is unknown.
+	*/
 	unknown: void 0,
+	/**
+	* The source and controller lifetimes are coupled to one another.
+	* They can/will be GC'd together.
+	*/
 	coupled: 1
 });
 FAST.getById(KernelServiceId.observable, () => {
@@ -542,19 +597,47 @@ FAST.getById(KernelServiceId.observable, () => {
 	}
 	makeSerializationNoop(ExpressionNotifierImplementation);
 	return Object.freeze({
+		/**
+		* @internal
+		* @param factory - The factory used to create array observers.
+		*/
 		setArrayObserverFactory(factory) {
 			createArrayObserver = factory;
 		},
+		/**
+		* Gets a notifier for an object or Array.
+		* @param source - The object or Array to get the notifier for.
+		*/
 		getNotifier,
+		/**
+		* Records a property change for a source object.
+		* @param source - The object to record the change against.
+		* @param propertyName - The property to track as changed.
+		*/
 		track(source, propertyName) {
 			watcher && watcher.watch(source, propertyName);
 		},
+		/**
+		* Notifies watchers that the currently executing property getter or function is volatile
+		* with respect to its observable dependencies.
+		*/
 		trackVolatile() {
 			watcher && (watcher.needsRefresh = true);
 		},
+		/**
+		* Notifies subscribers of a source object of changes.
+		* @param source - the object to notify of changes.
+		* @param args - The change args to pass to subscribers.
+		*/
 		notify(source, args) {
 			getNotifier(source).notify(args);
 		},
+		/**
+		* Defines an observable property on an object or prototype.
+		* @param target - The target object to define the observable on.
+		* @param nameOrAccessor - The name of the property to define as observable;
+		* or a custom accessor that specifies the property name and accessor implementation.
+		*/
 		defineProperty(target, nameOrAccessor) {
 			if (isString(nameOrAccessor)) nameOrAccessor = new DefaultObservableAccessor(nameOrAccessor);
 			getAccessors(target).push(nameOrAccessor);
@@ -568,10 +651,27 @@ FAST.getById(KernelServiceId.observable, () => {
 				}
 			});
 		},
+		/**
+		* Finds all the observable accessors defined on the target,
+		* including its prototype chain.
+		* @param target - The target object to search for accessor on.
+		*/
 		getAccessors,
+		/**
+		* Creates a {@link ExpressionNotifier} that can watch the
+		* provided {@link Expression} for changes.
+		* @param expression - The binding to observe.
+		* @param initialSubscriber - An initial subscriber to changes in the binding value.
+		* @param isVolatileBinding - Indicates whether the binding's dependency list must be re-evaluated on every value evaluation.
+		*/
 		binding(expression, initialSubscriber, isVolatileBinding = this.isVolatileBinding(expression)) {
 			return new ExpressionNotifierImplementation(expression, initialSubscriber, isVolatileBinding);
 		},
+		/**
+		* Determines whether a binding expression is volatile and needs to have its dependency list re-evaluated
+		* on every evaluation of the value.
+		* @param expression - The binding to inspect.
+		*/
 		isVolatileBinding(expression) {
 			return volatileRegex.test(expression.toString());
 		}
@@ -593,6 +693,9 @@ var contextEvent = FAST.getById(KernelServiceId.contextEvent, () => {
 * @public
 */
 var ExecutionContext = Object.freeze({
+	/**
+	* A default execution context.
+	*/
 	default: {
 		index: 0,
 		length: 0,
@@ -606,9 +709,17 @@ var ExecutionContext = Object.freeze({
 			return this.event.target;
 		}
 	},
+	/**
+	* Gets the current event.
+	* @returns An event object.
+	*/
 	getEvent() {
 		return contextEvent.get();
 	},
+	/**
+	* Sets the current event.
+	* @param event - An event object.
+	*/
 	setEvent(event) {
 		contextEvent.set(event);
 	}
@@ -623,11 +734,41 @@ var id = 0;
 /** @internal */
 var nextId = () => `${marker}-${++id}`;
 Object.freeze({
+	/**
+	* Creates a placeholder string suitable for marking out a location *within*
+	* an attribute value or HTML content.
+	* @param index - The directive index to create the placeholder for.
+	* @remarks
+	* Used internally by binding directives.
+	*/
 	interpolation: (id) => `${interpolationStart}${id}${interpolationEnd}`,
+	/**
+	* Creates a placeholder that manifests itself as an attribute on an
+	* element.
+	* @param attributeName - The name of the custom attribute.
+	* @param index - The directive index to create the placeholder for.
+	* @remarks
+	* Used internally by attribute directives such as `ref`, `slotted`, and `children`.
+	*/
 	attribute: (id) => `${nextId()}="${interpolationStart}${id}${interpolationEnd}"`,
+	/**
+	* Creates a placeholder that manifests itself as a marker within the DOM structure.
+	* @param index - The directive index to create the placeholder for.
+	* @remarks
+	* Used internally by structural directives such as `repeat`.
+	*/
 	comment: (id) => `<!--${interpolationStart}${id}${interpolationEnd}-->`
 });
-Object.freeze({ parse(value, factories) {
+Object.freeze({ 
+/**
+* Parses text content or HTML attribute content, separating out the static strings
+* from the directives.
+* @param value - The content or attribute string to parse.
+* @param factories - A list of directives to search for in the string.
+* @returns A heterogeneous array of static strings interspersed with
+* directives or null if no directives are found in the string.
+*/
+parse(value, factories) {
 	const parts = value.split(interpolationStart);
 	if (parts.length === 1) return null;
 	const result = [];
@@ -652,7 +793,13 @@ Object.freeze({ parse(value, factories) {
 * control ViewBehaviors.
 * @public
 */
-var ViewBehaviorOrchestrator = Object.freeze({ create(source) {
+var ViewBehaviorOrchestrator = Object.freeze({ 
+/**
+* Creates a ViewBehaviorOrchestrator.
+* @param source - The source to to associate behaviors with.
+* @returns A ViewBehaviorOrchestrator.
+*/
+create(source) {
 	const behaviors = [];
 	const targets = {};
 	let unbindables = null;
@@ -1013,45 +1160,10 @@ var DataGrid = class DataGrid extends require_vivid_element.VividElement {
 		}
 		this._resetSelection(true);
 	}
-	#handleKeypress = (e) => {
-		if (e.key === "Enter" || e.key === " ") this.#handleClick(e);
-	};
-	#handleClick = ({ target, ctrlKey, shiftKey, metaKey }) => {
-		if (target.getAttribute("role") !== "gridcell" || target.getAttribute("cell-type") !== "default") return;
-		if (this.selectionMode === DataGridSelectionMode.singleCell || this.selectionMode === DataGridSelectionMode.multiCell) {
-			this.#handleCellSelection({
-				target,
-				ctrlKey,
-				shiftKey,
-				metaKey
-			});
-			return;
-		}
-		if (this.selectionMode === DataGridSelectionMode.singleRow || this.selectionMode === DataGridSelectionMode.multiRow) this.#handleRowSelection({
-			target,
-			ctrlKey,
-			shiftKey,
-			metaKey
-		});
-	};
-	#handleCellSelection = ({ target, ctrlKey, shiftKey, metaKey }) => {
-		const cell = target;
-		if (this.selectionMode === DataGridSelectionMode.multiCell && (ctrlKey || shiftKey || metaKey)) cell.selected = !this.#selectedCells.includes(cell);
-		else {
-			const cacheTargetSelection = cell.selected;
-			this._resetSelection(true);
-			cell.selected = !cacheTargetSelection;
-		}
-	};
-	#handleRowSelection = ({ target, ctrlKey, shiftKey, metaKey }) => {
-		const row = target.parentNode;
-		if (this.selectionMode === DataGridSelectionMode.multiRow && (ctrlKey || shiftKey || metaKey)) row.selected = !this.#selectedRows.includes(row);
-		else {
-			const cacheTargetSelection = row.selected;
-			this._resetSelection(true);
-			row.selected = !cacheTargetSelection;
-		}
-	};
+	#handleKeypress;
+	#handleClick;
+	#handleCellSelection;
+	#handleRowSelection;
 	constructor() {
 		super();
 		this.noTabbing = false;
@@ -1118,6 +1230,52 @@ var DataGrid = class DataGrid extends require_vivid_element.VividElement {
 			this.rowindexUpdateQueued = false;
 			this.columnDefinitionsStale = false;
 		};
+		this.#handleKeypress = (e) => {
+			if (e.key === "Enter" || e.key === " ") this.#handleClick(e);
+		};
+		this.#handleClick = ({ target, ctrlKey, shiftKey, metaKey }) => {
+			if (target.getAttribute("role") !== "gridcell" || target.getAttribute("cell-type") !== "default") return;
+			if (this.selectionMode === DataGridSelectionMode.singleCell || this.selectionMode === DataGridSelectionMode.multiCell) {
+				this.#handleCellSelection({
+					target,
+					ctrlKey,
+					shiftKey,
+					metaKey
+				});
+				return;
+			}
+			if (this.selectionMode === DataGridSelectionMode.singleRow || this.selectionMode === DataGridSelectionMode.multiRow) this.#handleRowSelection({
+				target,
+				ctrlKey,
+				shiftKey,
+				metaKey
+			});
+		};
+		this.#handleCellSelection = ({ target, ctrlKey, shiftKey, metaKey }) => {
+			const cell = target;
+			if (this.selectionMode === DataGridSelectionMode.multiCell && (ctrlKey || shiftKey || metaKey)) cell.selected = !this.#selectedCells.includes(cell);
+			else {
+				const cacheTargetSelection = cell.selected;
+				this._resetSelection(true);
+				cell.selected = !cacheTargetSelection;
+			}
+		};
+		this.#handleRowSelection = ({ target, ctrlKey, shiftKey, metaKey }) => {
+			const row = target.parentNode;
+			if (this.selectionMode === DataGridSelectionMode.multiRow && (ctrlKey || shiftKey || metaKey)) row.selected = !this.#selectedRows.includes(row);
+			else {
+				const cacheTargetSelection = row.selected;
+				this._resetSelection(true);
+				row.selected = !cacheTargetSelection;
+			}
+		};
+		this.#changeHandler = { handleChange(dataGrid, propertyName) {
+			/* v8 ignore else -- @preserve */
+			if (propertyName === "columnDefinitions") {
+				/* v8 ignore else -- @preserve */
+				if (dataGrid.$fastController.isConnected) dataGrid.toggleGeneratedHeader();
+			}
+		} };
 		this._resetSelection = (clear = false) => {
 			const cells = Array.from(this.querySelectorAll("[role=\"gridcell\"], [cell-type=\"default\"]"));
 			const rows = Array.from(this.querySelectorAll("[role=\"row\"], [row-type=\"default\"]"));
@@ -1149,13 +1307,7 @@ var DataGrid = class DataGrid extends require_vivid_element.VividElement {
 		this.addEventListener("click", this.#handleClick);
 		this.addEventListener("keydown", this.#handleKeypress);
 	}
-	#changeHandler = { handleChange(dataGrid, propertyName) {
-		/* v8 ignore else -- @preserve */
-		if (propertyName === "columnDefinitions") {
-			/* v8 ignore else -- @preserve */
-			if (dataGrid.$fastController.isConnected) dataGrid.toggleGeneratedHeader();
-		}
-	} };
+	#changeHandler;
 	static generateColumns(rowData) {
 		return Object.keys(rowData).map((property, index) => {
 			return {