@coveo/quantic 3.30.3-pre.465ecd4358 → 3.30.3-pre.47e6fff72f

package/force-app/main/default/lwc/quanticUtils/facetDependenciesUtils.js

@@ -79,6 +79,7 @@ export function generateFacetDependencyConditions(dependsOn) {
 
 /**
  * Type guard to check if the provided value is a CategoryFacetValue.
+ * @param {CategoryFacetValue} value - The value to check.
  * @returns {boolean} True if the value is a CategoryFacetValue.
  */
 function isCategoryFacetValue(value) {
@@ -112,6 +113,7 @@ function getSelectedCategoryFacetValueRequest(value) {
 
 /**
  * Type guard to check if the provided value is a SimpleFacetValue.
+ * @param {SimpleFacetValue} facetValue - The value to check.
  * @returns {boolean} True if the value is a SimpleFacetValue.
  */
 function isSimpleFacetValue(facetValue) {

package/force-app/main/default/lwc/quanticUtils/markdownUtils.js

@@ -24,7 +24,7 @@ const unclosedElement = /(\*{1,3}|`)($|\w[\w\s]*$)/;
 /**
  * Complete unclosed elements such as bold, italic, and code.
  * @param {string} text
- * @returns {string} The original content with closed tags.
+ * @returns {string} The corrected text content.
  */
 const completeUnclosedElement = (text) => {
   const match = unclosedElement.exec(text);
@@ -46,7 +46,7 @@ const completeUnclosedElement = (text) => {
 
 /**
  * Escape HTML special characters in a string.
- * @param {String} text
+ * @param {*} text
  * @returns {string} The escaped HTML string.
  */
 const escapeHtml = (text) => {
@@ -60,7 +60,9 @@ const escapeHtml = (text) => {
 
 /**
  * Custom Marked renderer to override the default rendering of certain elements.
- * See: https://marked.js.org/using_pro
+ * @type {object}
+ * @property {Function} code
+ * @returns {string} The code block element to render.
  */
 const customRenderer = {
   code(code) {

package/force-app/main/default/lwc/quanticUtils/quanticUtils.js

@@ -194,7 +194,7 @@ export class I18nUtils {
   /**
    * Gets the label name with count.
    * @param {string} labelName
-   * @param {string|number} count
+   * @param {number} count
    * @returns {string} The label name with count.
    * @example `labelName_zero`, `labelName_plural` or `labelName`
    */
@@ -209,7 +209,7 @@ export class I18nUtils {
 
   /**
    * Formats a string with the given arguments.
-   * @param {String} stringToFormat
+   * @param {*} stringToFormat
    * @param  {...any} formattingArguments
    * @returns {string} The formatted string.
    * @throws {Error} If string format is not a string.
@@ -646,6 +646,7 @@ export class Store {
    * @param {Record<String, unknown>} store
    * @param {string} facetType
    * @param {{ label?: string; facetId: any; format?: Function;}} data
+   * @return {void}
    */
   static registerFacetToStore(store, facetType, data) {
     if (store?.state[facetType][data.facetId]) {
@@ -658,6 +659,7 @@ export class Store {
    * Registers sort option data to the store.
    * @param {Record<String, any>} store
    * @param {Array<{label: string; value: string; criterion: SortCriterion;}>} data
+   * @return {void}
    */
   static registerSortOptionDataToStore(store, data) {
     store.state.sort = data;
@@ -926,6 +928,7 @@ export async function copyToClipboard(text) {
 /**
  * Copies text to clipboard using the DOM.
  * @param {string} text
+ * @return {void}
  */
 export function copyToClipboardFallback(text) {
   const el = document.createElement('textarea');