@umbraco-cms/backoffice 18.1.1 → 18.2.0-rc

package/dist-cms/packages/core/utils/guard-manager/guard.manager.base.js

@@ -22,7 +22,8 @@ export class UmbGuardManagerBase extends UmbControllerBase {
     }
     /**
      * Add a new rule
-     * @param {RuleType} rule
+     * @param {RuleType} rule - The rule to add
+     * @returns {RuleType['unique']} The unique value of the added rule
      */
     addRule(rule) {
         const newRule = { ...rule };
@@ -35,7 +36,7 @@ export class UmbGuardManagerBase extends UmbControllerBase {
     }
     /**
      * Add multiple rules
-     * @param {RuleType[]} rules
+     * @param {RuleType[]} rules - The rules to add
      */
     addRules(rules) {
         this._rules.mute();

package/dist-cms/packages/core/utils/guard-manager/readonly-guard.manager.js

@@ -1,5 +1,5 @@
-import { mergeObservables } from '../../../../libs/observable-api/index.js';
 import { UmbGuardManagerBase } from './guard.manager.base.js';
+import { mergeObservables } from '../../../../libs/observable-api/index.js';
 // TODO: Check the need for this one.
 export class UmbReadOnlyGuardManager extends UmbGuardManagerBase {
     constructor() {

package/dist-cms/packages/core/utils/guard-manager/readonly-variant-guard.manager.d.ts

@@ -7,7 +7,6 @@ export interface UmbVariantGuardRule extends UmbGuardRule {
 }
 /**
  * Read only guard manager for variant rules.
- * @export
  * @class UmbReadOnlyVariantGuardManager
  * @augments {UmbReadOnlyGuardManager<UmbVariantGuardRule>}
  */
@@ -15,13 +14,13 @@ export declare class UmbReadOnlyVariantGuardManager extends UmbReadOnlyGuardMana
     #private;
     /**
      * Observe if the given variantId is permitted to read
-     * @param {UmbVariantId} variantId
+     * @param {UmbVariantId} variantId - The variantId to check
      * @returns {Observable<boolean>} - Observable that emits true if the variantId is permitted to read, false otherwise
      * @memberof UmbReadOnlyVariantGuardManager
      */
     isPermittedForVariant(variantId: UmbVariantId): Observable<boolean>;
     /**
-     * @param {Observable<UmbVariantId | undefined>} variantId
+     * @param {Observable<UmbVariantId | undefined>} variantId - Observable emitting the variantId to evaluate
      * @returns {Observable<boolean | undefined>} - Observable that emits true if the variantId is permitted to read, false otherwise
      * @memberof UmbReadOnlyVariantGuardManager
      */
@@ -38,7 +37,7 @@ export declare class UmbReadOnlyVariantGuardManager extends UmbReadOnlyGuardMana
     }[]>;
     /**
      * Check if the given variantId is permitted to read
-     * @param {UmbVariantId} variantId
+     * @param {UmbVariantId} variantId - The variantId to check
      * @returns {boolean} - true if the variantId is permitted to read, false otherwise
      * @memberof UmbReadOnlyVariantGuardManager
      */

package/dist-cms/packages/core/utils/guard-manager/readonly-variant-guard.manager.js

@@ -1,23 +1,23 @@
 import { UmbReadOnlyGuardManager } from './readonly-guard.manager.js';
 import { mergeObservables } from '../../../../libs/observable-api/index.js';
 /**
- *
- * @param rule
- * @param variantId
+ * Checks if the given rule applies to the given variantId
+ * @param {UmbVariantGuardRule} rule - The rule to check
+ * @param {UmbVariantId} variantId - The variantId to check against
+ * @returns {boolean} True if the rule applies to the variantId
  */
 function findRule(rule, variantId) {
     return rule.variantId?.compare(variantId) || rule.variantId === undefined;
 }
 /**
  * Read only guard manager for variant rules.
- * @export
  * @class UmbReadOnlyVariantGuardManager
  * @augments {UmbReadOnlyGuardManager<UmbVariantGuardRule>}
  */
 export class UmbReadOnlyVariantGuardManager extends UmbReadOnlyGuardManager {
     /**
      * Observe if the given variantId is permitted to read
-     * @param {UmbVariantId} variantId
+     * @param {UmbVariantId} variantId - The variantId to check
      * @returns {Observable<boolean>} - Observable that emits true if the variantId is permitted to read, false otherwise
      * @memberof UmbReadOnlyVariantGuardManager
      */
@@ -30,7 +30,7 @@ export class UmbReadOnlyVariantGuardManager extends UmbReadOnlyGuardManager {
         ], ([permitted, fallback]) => permitted ?? fallback);
     }
     /**
-     * @param {Observable<UmbVariantId | undefined>} variantId
+     * @param {Observable<UmbVariantId | undefined>} variantId - Observable emitting the variantId to evaluate
      * @returns {Observable<boolean | undefined>} - Observable that emits true if the variantId is permitted to read, false otherwise
      * @memberof UmbReadOnlyVariantGuardManager
      */
@@ -58,7 +58,7 @@ export class UmbReadOnlyVariantGuardManager extends UmbReadOnlyGuardManager {
     }
     /**
      * Check if the given variantId is permitted to read
-     * @param {UmbVariantId} variantId
+     * @param {UmbVariantId} variantId - The variantId to check
      * @returns {boolean} - true if the variantId is permitted to read, false otherwise
      * @memberof UmbReadOnlyVariantGuardManager
      */

package/dist-cms/packages/core/utils/math/math.d.ts

@@ -93,14 +93,14 @@ export declare function calculateExtrapolatedValue(initialValue: number, increas
  * Find the index for a target value on an array of individual values.
  * @param {number} target - The target value to interpolate to.
  * @param {Array<number>} weights - An array of values to interpolate between.
- * @returns
+ * @returns {number} The interpolated index
  */
 export declare function getInterpolatedIndexOfPositionInWeightMap(target: number, weights: Array<number>): number;
 /**
  * Combine the values of an array up to a certain index.
  * @param {number} index - The index to accumulate to, everything after this index will not be accumulated.
  * @param {Array<number>} weights - An array of values to accumulate.
- * @returns
+ * @returns {number} The accumulated value
  */
 export declare function getAccumulatedValueOfIndex(index: number, weights: Array<number>): number;
 /**
@@ -109,6 +109,6 @@ export declare function getAccumulatedValueOfIndex(index: number, weights: Array
  * @param {number} y - The y coordinate.
  * @param {DOMRect} rect - The rectangle to check.
  * @param {number} expand - The amount to expand or contract the rectangle.
- * @returns
+ * @returns {boolean} True if the point is within the rectangle
  */
 export declare function isWithinRect(x: number, y: number, rect: DOMRect, expand?: number): boolean;

package/dist-cms/packages/core/utils/math/math.js

@@ -111,7 +111,7 @@ export function calculateExtrapolatedValue(initialValue, increaseFactor) {
  * Find the index for a target value on an array of individual values.
  * @param {number} target - The target value to interpolate to.
  * @param {Array<number>} weights - An array of values to interpolate between.
- * @returns
+ * @returns {number} The interpolated index
  */
 export function getInterpolatedIndexOfPositionInWeightMap(target, weights) {
     const map = [0];
@@ -147,7 +147,7 @@ export function getInterpolatedIndexOfPositionInWeightMap(target, weights) {
  * Combine the values of an array up to a certain index.
  * @param {number} index - The index to accumulate to, everything after this index will not be accumulated.
  * @param {Array<number>} weights - An array of values to accumulate.
- * @returns
+ * @returns {number} The accumulated value
  */
 export function getAccumulatedValueOfIndex(index, weights) {
     const len = Math.min(index, weights.length);
@@ -163,7 +163,7 @@ export function getAccumulatedValueOfIndex(index, weights) {
  * @param {number} y - The y coordinate.
  * @param {DOMRect} rect - The rectangle to check.
  * @param {number} expand - The amount to expand or contract the rectangle.
- * @returns
+ * @returns {boolean} True if the point is within the rectangle
  */
 export function isWithinRect(x, y, rect, expand = 0) {
     return x > rect.left - expand && x < rect.right + expand && y > rect.top - expand && y < rect.bottom + expand;

package/dist-cms/packages/core/utils/object/deep-merge.function.d.ts

@@ -1,10 +1,11 @@
 import type { UmbDeepPartialObject } from '../type/deep-partial-object.type.js';
 /**
  * Deep merge two objects.
- * @param target
- * @param ...sources
- * @param source
- * @param fallback
+ * @template {{ [key: string]: unknown }} T
+ * @template {UmbDeepPartialObject<T>} PartialType
+ * @param {PartialType} source - The partial object to merge into the fallback.
+ * @param {T} fallback - The object providing the default values.
+ * @returns {T} The merged object.
  */
 export declare function umbDeepMerge<T extends {
     [key: string]: any;

package/dist-cms/packages/core/utils/object/deep-merge.function.js

@@ -1,9 +1,10 @@
 /**
  * Deep merge two objects.
- * @param target
- * @param ...sources
- * @param source
- * @param fallback
+ * @template {{ [key: string]: unknown }} T
+ * @template {UmbDeepPartialObject<T>} PartialType
+ * @param {PartialType} source - The partial object to merge into the fallback.
+ * @param {T} fallback - The object providing the default values.
+ * @returns {T} The merged object.
  */
 export function umbDeepMerge(source, fallback) {
     const result = { ...fallback };

package/dist-cms/packages/core/utils/pagination/offset/is-offset-request.guard.d.ts

@@ -2,5 +2,6 @@ import type { UmbOffsetPaginationRequestModel, UmbTargetPaginationRequestModel }
 /**
  * Checks if the provided paging object is an target pagination request.
  * @param {object } paging - The paging object to check.
+ * @returns {boolean} True if the paging object is an offset pagination request.
  */
 export declare function isOffsetPaginationRequest(paging: UmbOffsetPaginationRequestModel | UmbTargetPaginationRequestModel): paging is UmbOffsetPaginationRequestModel;

package/dist-cms/packages/core/utils/pagination/offset/is-offset-request.guard.js

@@ -1,6 +1,7 @@
 /**
  * Checks if the provided paging object is an target pagination request.
  * @param {object } paging - The paging object to check.
+ * @returns {boolean} True if the paging object is an offset pagination request.
  */
 export function isOffsetPaginationRequest(paging) {
     return (paging.skip !== undefined ||

package/dist-cms/packages/core/utils/pagination/target/is-target-request.guard.d.ts

@@ -3,5 +3,6 @@ import type { UmbTargetPaginationRequestModel } from './types.js';
 /**
  * Checks if the provided paging object is an target pagination request.
  * @param {object } paging - The paging object to check.
+ * @returns {boolean} True if the paging object is a target pagination request.
  */
 export declare function isTargetPaginationRequest(paging: UmbOffsetPaginationRequestModel | UmbTargetPaginationRequestModel): paging is UmbTargetPaginationRequestModel;

package/dist-cms/packages/core/utils/pagination/target/is-target-request.guard.js

@@ -1,6 +1,7 @@
 /**
  * Checks if the provided paging object is an target pagination request.
  * @param {object } paging - The paging object to check.
+ * @returns {boolean} True if the paging object is a target pagination request.
  */
 export function isTargetPaginationRequest(paging) {
     return paging.target !== undefined;

package/dist-cms/packages/core/utils/pagination/target/pagination-manager/target-pagination.manager.d.ts

@@ -32,14 +32,14 @@ export declare class UmbTargetPaginationManager<ItemModelType extends UmbEntityM
     hasBaseTargetInCurrentItems(): boolean;
     /**
      * Gets the number of items per page
-     * @returns {number}
-     * @memberof UmbPaginationManager
+     * @returns {number} The number of items per page
+     * @memberof UmbTargetPaginationManager
      */
     getTakeSize(): number;
     /**
      * Sets the number of items per page and recalculates the total number of pages
-     * @param {number} pageSize
-     * @memberof UmbPaginationManager
+     * @param {number} pageSize - The number of items per page
+     * @memberof UmbTargetPaginationManager
      */
     setTakeSize(pageSize: number): void;
     /**
@@ -69,20 +69,20 @@ export declare class UmbTargetPaginationManager<ItemModelType extends UmbEntityM
     appendCurrentItems(items: Array<ItemModelType>): void;
     /**
      * Removes an item from the current items
-     * @param {UmbEntityModel} entity
+     * @param {UmbEntityModel} entity - The entity to remove
      * @memberof UmbTargetPaginationManager
      */
     removeFromCurrentItems(entity: UmbEntityModel): void;
     /**
      * Gets the total number of items
-     * @returns {number}
-     * @memberof UmbPaginationManager
+     * @returns {number} The total number of items
+     * @memberof UmbTargetPaginationManager
      */
     getTotalItems(): number;
     /**
      * Sets the total number of items and recalculates the total number of pages
-     * @param {number} totalItems
-     * @memberof UmbPaginationManager
+     * @param {number} totalItems - The total number of items
+     * @memberof UmbTargetPaginationManager
      */
     setTotalItems(totalItems: number): void;
     /**
@@ -125,7 +125,7 @@ export declare class UmbTargetPaginationManager<ItemModelType extends UmbEntityM
     getNumberOfCurrentItemsAfterBaseTarget(): number;
     /**
      * Clears the pagination manager values and resets them to their default values
-     * @memberof UmbPaginationManager
+     * @memberof UmbTargetPaginationManager
      */
     clear(): void;
 }

package/dist-cms/packages/core/utils/pagination/target/pagination-manager/target-pagination.manager.js

@@ -72,16 +72,16 @@ export class UmbTargetPaginationManager extends UmbControllerBase {
     }
     /**
      * Gets the number of items per page
-     * @returns {number}
-     * @memberof UmbPaginationManager
+     * @returns {number} The number of items per page
+     * @memberof UmbTargetPaginationManager
      */
     getTakeSize() {
         return this.#takeSize.getValue();
     }
     /**
      * Sets the number of items per page and recalculates the total number of pages
-     * @param {number} pageSize
-     * @memberof UmbPaginationManager
+     * @param {number} pageSize - The number of items per page
+     * @memberof UmbTargetPaginationManager
      */
     setTakeSize(pageSize) {
         this.#takeSize.setValue(pageSize);
@@ -121,7 +121,7 @@ export class UmbTargetPaginationManager extends UmbControllerBase {
     }
     /**
      * Removes an item from the current items
-     * @param {UmbEntityModel} entity
+     * @param {UmbEntityModel} entity - The entity to remove
      * @memberof UmbTargetPaginationManager
      */
     removeFromCurrentItems(entity) {
@@ -129,16 +129,16 @@ export class UmbTargetPaginationManager extends UmbControllerBase {
     }
     /**
      * Gets the total number of items
-     * @returns {number}
-     * @memberof UmbPaginationManager
+     * @returns {number} The total number of items
+     * @memberof UmbTargetPaginationManager
      */
     getTotalItems() {
         return this.#totalItems.getValue();
     }
     /**
      * Sets the total number of items and recalculates the total number of pages
-     * @param {number} totalItems
-     * @memberof UmbPaginationManager
+     * @param {number} totalItems - The total number of items
+     * @memberof UmbTargetPaginationManager
      */
     setTotalItems(totalItems) {
         this.#totalItems.setValue(totalItems);
@@ -230,7 +230,7 @@ export class UmbTargetPaginationManager extends UmbControllerBase {
     }
     /**
      * Clears the pagination manager values and resets them to their default values
-     * @memberof UmbPaginationManager
+     * @memberof UmbTargetPaginationManager
      */
     clear() {
         this.#totalItems.setValue(0);

package/dist-cms/packages/core/utils/pagination-manager/pagination.manager.d.ts

@@ -7,49 +7,49 @@ export declare class UmbPaginationManager extends EventTarget {
     readonly skip: import("rxjs").Observable<number>;
     /**
      * Sets the number of items per page and recalculates the total number of pages
-     * @param {number} pageSize
+     * @param {number} pageSize - The number of items per page
      * @memberof UmbPaginationManager
      */
     setPageSize(pageSize: number): void;
     /**
      * Gets the number of items per page
-     * @returns {number}
+     * @returns {number} The number of items per page
      * @memberof UmbPaginationManager
      */
     getPageSize(): number;
     /**
      * Gets the total number of items
-     * @returns {number}
+     * @returns {number} The total number of items
      * @memberof UmbPaginationManager
      */
     getTotalItems(): number;
     /**
      * Sets the total number of items and recalculates the total number of pages
-     * @param {number} totalItems
+     * @param {number} totalItems - The total number of items
      * @memberof UmbPaginationManager
      */
     setTotalItems(totalItems: number): void;
     /**
      * Gets the total number of pages
-     * @returns {number}
+     * @returns {number} The total number of pages
      * @memberof UmbPaginationManager
      */
     getTotalPages(): number;
     /**
      * Gets the current page number
-     * @returns {number}
+     * @returns {number} The current page number
      * @memberof UmbPaginationManager
      */
     getCurrentPageNumber(): number;
     /**
      * Sets the current page number
-     * @param {number} pageNumber
+     * @param {number} pageNumber - The current page number
      * @memberof UmbPaginationManager
      */
     setCurrentPageNumber(pageNumber: number): void;
     /**
      * Gets the number of items to skip
-     * @returns {number}
+     * @returns {number} The number of items to skip
      * @memberof UmbPaginationManager
      */
     getSkip(): number;
@@ -60,13 +60,13 @@ export declare class UmbPaginationManager extends EventTarget {
     clear(): void;
     /**
      * Gets the index of the first item on the current page (for display).
-     * @returns {number}
+     * @returns {number} The index of the first item on the current page
      * @memberof UmbPaginationManager
      */
     getDisplayStart(): number;
     /**
      * Gets the index of the last item on the current page (for display).
-     * @returns {number}
+     * @returns {number} The index of the last item on the current page
      * @memberof UmbPaginationManager
      */
     getDisplayEnd(): number;

package/dist-cms/packages/core/utils/pagination-manager/pagination.manager.js

@@ -27,7 +27,7 @@ export class UmbPaginationManager extends EventTarget {
     #skip;
     /**
      * Sets the number of items per page and recalculates the total number of pages
-     * @param {number} pageSize
+     * @param {number} pageSize - The number of items per page
      * @memberof UmbPaginationManager
      */
     setPageSize(pageSize) {
@@ -36,7 +36,7 @@ export class UmbPaginationManager extends EventTarget {
     }
     /**
      * Gets the number of items per page
-     * @returns {number}
+     * @returns {number} The number of items per page
      * @memberof UmbPaginationManager
      */
     getPageSize() {
@@ -44,7 +44,7 @@ export class UmbPaginationManager extends EventTarget {
     }
     /**
      * Gets the total number of items
-     * @returns {number}
+     * @returns {number} The total number of items
      * @memberof UmbPaginationManager
      */
     getTotalItems() {
@@ -52,7 +52,7 @@ export class UmbPaginationManager extends EventTarget {
     }
     /**
      * Sets the total number of items and recalculates the total number of pages
-     * @param {number} totalItems
+     * @param {number} totalItems - The total number of items
      * @memberof UmbPaginationManager
      */
     setTotalItems(totalItems) {
@@ -61,7 +61,7 @@ export class UmbPaginationManager extends EventTarget {
     }
     /**
      * Gets the total number of pages
-     * @returns {number}
+     * @returns {number} The total number of pages
      * @memberof UmbPaginationManager
      */
     getTotalPages() {
@@ -69,7 +69,7 @@ export class UmbPaginationManager extends EventTarget {
     }
     /**
      * Gets the current page number
-     * @returns {number}
+     * @returns {number} The current page number
      * @memberof UmbPaginationManager
      */
     getCurrentPageNumber() {
@@ -77,7 +77,7 @@ export class UmbPaginationManager extends EventTarget {
     }
     /**
      * Sets the current page number
-     * @param {number} pageNumber
+     * @param {number} pageNumber - The current page number
      * @memberof UmbPaginationManager
      */
     setCurrentPageNumber(pageNumber) {
@@ -93,7 +93,7 @@ export class UmbPaginationManager extends EventTarget {
     }
     /**
      * Gets the number of items to skip
-     * @returns {number}
+     * @returns {number} The number of items to skip
      * @memberof UmbPaginationManager
      */
     getSkip() {
@@ -129,7 +129,7 @@ export class UmbPaginationManager extends EventTarget {
     }
     /**
      * Gets the index of the first item on the current page (for display).
-     * @returns {number}
+     * @returns {number} The index of the first item on the current page
      * @memberof UmbPaginationManager
      */
     getDisplayStart() {
@@ -137,7 +137,7 @@ export class UmbPaginationManager extends EventTarget {
     }
     /**
      * Gets the index of the last item on the current page (for display).
-     * @returns {number}
+     * @returns {number} The index of the last item on the current page
      * @memberof UmbPaginationManager
      */
     getDisplayEnd() {

package/dist-cms/packages/core/utils/path/ensure-local-path.function.d.ts

@@ -1,6 +1,7 @@
 /**
  * Ensure that the path is a local path.
- * @param path
- * @param fallbackPath
+ * @param {URL | string} path - The path to check.
+ * @param {URL | string} [fallbackPath] - The path to use if the given path is not local.
+ * @returns {URL} The local path, or the fallback path if the given path is not local.
  */
 export declare function ensureLocalPath(path: URL | string, fallbackPath?: URL | string): URL;

package/dist-cms/packages/core/utils/path/ensure-local-path.function.js

@@ -1,7 +1,8 @@
 /**
  * Ensure that the path is a local path.
- * @param path
- * @param fallbackPath
+ * @param {URL | string} path - The path to check.
+ * @param {URL | string} [fallbackPath] - The path to use if the given path is not local.
+ * @returns {URL} The local path, or the fallback path if the given path is not local.
  */
 export function ensureLocalPath(path, fallbackPath) {
     const url = new URL(path, window.location.origin);

package/dist-cms/packages/core/utils/path/ensure-path-ends-with-slash.function.d.ts

@@ -1,5 +1,6 @@
 /**
- *
- * @param path
+ * Ensure that the path ends with a slash.
+ * @param {string} path - The path to check.
+ * @returns {string} The path, ending with a slash.
  */
 export declare function ensurePathEndsWithSlash(path: string): string;

package/dist-cms/packages/core/utils/path/ensure-path-ends-with-slash.function.js

@@ -1,6 +1,7 @@
 /**
- *
- * @param path
+ * Ensure that the path ends with a slash.
+ * @param {string} path - The path to check.
+ * @returns {string} The path, ending with a slash.
  */
 export function ensurePathEndsWithSlash(path) {
     return path.endsWith('/') ? path : path + '/';

package/dist-cms/packages/core/utils/path/get-file-extension.function.d.ts

@@ -1,5 +1,7 @@
 /**
  * Extracts the file extension from a filename.
  * Returns undefined when no valid extension can be determined.
+ * @param {string} filename - The filename to extract the extension from.
+ * @returns {string | undefined} The file extension, or undefined if it cannot be determined.
  */
 export declare function getFileExtension(filename: string): string | undefined;

package/dist-cms/packages/core/utils/path/get-file-extension.function.js

@@ -1,6 +1,8 @@
 /**
  * Extracts the file extension from a filename.
  * Returns undefined when no valid extension can be determined.
+ * @param {string} filename - The filename to extract the extension from.
+ * @returns {string | undefined} The file extension, or undefined if it cannot be determined.
  */
 export function getFileExtension(filename) {
     const dotIndex = filename.lastIndexOf('.');

package/dist-cms/packages/core/utils/path/has-own-opener.function.d.ts

@@ -1,11 +1,11 @@
 /**
  * Check if the current window has an opener window with the same origin and optional pathname.
  * This is useful for checking if the current window was opened by another window from within the same application.
- * @remark If the current window was opened by another window, the opener window is accessible via `window.opener`.
- * @remark There could still be an opener if the opener window is closed or navigated away or if the opener window is not from the same origin,
+ * @remarks If the current window was opened by another window, the opener window is accessible via `window.opener`.
+ * There could still be an opener if the opener window is closed or navigated away or if the opener window is not from the same origin,
  * but this function will only return `true` if the opener window is accessible and has the same origin and optional pathname.
- * @param pathname Optional pathname to check if the opener window has the same pathname.
- * @param windowLike The window-like object to use for checking the opener. Default is `window`.
- * @returns `true` if the current window has an opener window with the same origin and optional pathname, otherwise `false`.
+ * @param {string} [pathname] Optional pathname to check if the opener window has the same pathname.
+ * @param {Window} [windowLike] The window-like object to use for checking the opener. Default is `window`.
+ * @returns {boolean} `true` if the current window has an opener window with the same origin and optional pathname, otherwise `false`.
  */
 export declare function hasOwnOpener(pathname?: string, windowLike?: Window): boolean;

package/dist-cms/packages/core/utils/path/has-own-opener.function.js

@@ -1,12 +1,12 @@
 /**
  * Check if the current window has an opener window with the same origin and optional pathname.
  * This is useful for checking if the current window was opened by another window from within the same application.
- * @remark If the current window was opened by another window, the opener window is accessible via `window.opener`.
- * @remark There could still be an opener if the opener window is closed or navigated away or if the opener window is not from the same origin,
+ * @remarks If the current window was opened by another window, the opener window is accessible via `window.opener`.
+ * There could still be an opener if the opener window is closed or navigated away or if the opener window is not from the same origin,
  * but this function will only return `true` if the opener window is accessible and has the same origin and optional pathname.
- * @param pathname Optional pathname to check if the opener window has the same pathname.
- * @param windowLike The window-like object to use for checking the opener. Default is `window`.
- * @returns `true` if the current window has an opener window with the same origin and optional pathname, otherwise `false`.
+ * @param {string} [pathname] Optional pathname to check if the opener window has the same pathname.
+ * @param {Window} [windowLike] The window-like object to use for checking the opener. Default is `window`.
+ * @returns {boolean} `true` if the current window has an opener window with the same origin and optional pathname, otherwise `false`.
  */
 export function hasOwnOpener(pathname, windowLike = globalThis.window) {
     try {

package/dist-cms/packages/core/utils/path/remove-initial-slash-from-path.function.d.ts

@@ -1,5 +1,6 @@
 /**
  * Removes the initial slash from a path, if the first character is a slash.
- * @param path
+ * @param {string} path - The path to remove the initial slash from.
+ * @returns {string} The path without an initial slash.
  */
 export declare function removeInitialSlashFromPath(path: string): string;

package/dist-cms/packages/core/utils/path/remove-initial-slash-from-path.function.js

@@ -1,6 +1,7 @@
 /**
  * Removes the initial slash from a path, if the first character is a slash.
- * @param path
+ * @param {string} path - The path to remove the initial slash from.
+ * @returns {string} The path without an initial slash.
  */
 export function removeInitialSlashFromPath(path) {
     return path.startsWith('/') ? path.slice(1) : path;

package/dist-cms/packages/core/utils/path/remove-last-slash-from-path.function.d.ts

@@ -1,5 +1,6 @@
 /**
  * Remove the last slash from a path, if the last character is a slash.
- * @param path
+ * @param {string} path - The path to remove the last slash from.
+ * @returns {string} The path without a trailing slash.
  */
 export declare function removeLastSlashFromPath(path: string): string;

package/dist-cms/packages/core/utils/path/remove-last-slash-from-path.function.js

@@ -1,6 +1,7 @@
 /**
  * Remove the last slash from a path, if the last character is a slash.
- * @param path
+ * @param {string} path - The path to remove the last slash from.
+ * @returns {string} The path without a trailing slash.
  */
 export function removeLastSlashFromPath(path) {
     return path.endsWith('/') ? path.slice(undefined, -1) : path;