@umbraco-cms/backoffice 17.6.2 → 17.7.0-rc

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;

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

@@ -1,14 +1,15 @@
 export declare const UMB_STORAGE_REDIRECT_URL = "umb:auth:redirect";
 /**
  * Retrieve the stored path from the session storage.
- * @remark This is used to redirect the user to the correct page after login.
+ * @remarks This is used to redirect the user to the correct page after login.
+ * @returns {URL | null} The stored path, or null if none is stored.
  */
 export declare function retrieveStoredPath(): URL | null;
 /**
  * Store the path in the session storage.
- * @param path
- * @remark This is used to redirect the user to the correct page after login.
- * @remark The path must be a local path, otherwise it is not stored.
+ * @param {string} path - The path to store.
+ * @remarks This is used to redirect the user to the correct page after login.
+ * The path must be a local path, otherwise it is not stored.
  */
 export declare function setStoredPath(path: string): void;
 /**

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

@@ -3,7 +3,8 @@ import { hasOwnOpener } from './has-own-opener.function.js';
 export const UMB_STORAGE_REDIRECT_URL = 'umb:auth:redirect';
 /**
  * Retrieve the stored path from the session storage.
- * @remark This is used to redirect the user to the correct page after login.
+ * @remarks This is used to redirect the user to the correct page after login.
+ * @returns {URL | null} The stored path, or null if none is stored.
  */
 export function retrieveStoredPath() {
     let currentRoute = '';
@@ -16,9 +17,9 @@ export function retrieveStoredPath() {
 }
 /**
  * Store the path in the session storage.
- * @param path
- * @remark This is used to redirect the user to the correct page after login.
- * @remark The path must be a local path, otherwise it is not stored.
+ * @param {string} path - The path to store.
+ * @remarks This is used to redirect the user to the correct page after login.
+ * The path must be a local path, otherwise it is not stored.
  */
 export function setStoredPath(path) {
     const url = new URL(path, window.location.origin);

package/dist-cms/packages/core/utils/path/transform-server-path-to-client-path.function.d.ts

@@ -1,7 +1,9 @@
 type StringMaybeUndefined = string | undefined;
 /**
- *
- * @param path
+ * Transforms a server-side path (e.g. `~/` or `/wwwroot/`) into a client-side path.
+ * @template T
+ * @param {T} path - The server-side path to transform.
+ * @returns {T} The client-side path.
  */
 export declare function transformServerPathToClientPath<T extends StringMaybeUndefined>(path: T): T;
 export {};

package/dist-cms/packages/core/utils/path/transform-server-path-to-client-path.function.js

@@ -1,6 +1,8 @@
 /**
- *
- * @param path
+ * Transforms a server-side path (e.g. `~/` or `/wwwroot/`) into a client-side path.
+ * @template T
+ * @param {T} path - The server-side path to transform.
+ * @returns {T} The client-side path.
  */
 export function transformServerPathToClientPath(path) {
     if (path?.indexOf('~/') === 0) {

package/dist-cms/packages/core/utils/sanitize/escape-html.function.d.ts

@@ -1,7 +1,7 @@
 /**
  * Escapes HTML entities in a string.
  * @example escapeHTML('<script>alert("XSS")</script>'), // "&lt;script&gt;alert(&#34;XSS&#34;)&lt;/script&gt;"
- * @param html The HTML string to escape.
- * @returns The sanitized HTML string.
+ * @param {unknown} html The HTML string to escape.
+ * @returns {string} The sanitized HTML string.
  */
 export declare function escapeHTML(html: unknown): string;

package/dist-cms/packages/core/utils/sanitize/escape-html.function.js

@@ -4,8 +4,8 @@ const NON_ALPHANUMERIC_REGEXP = /([^#-~| |!])/g;
 /**
  * Escapes HTML entities in a string.
  * @example escapeHTML('<script>alert("XSS")</script>'), // "&lt;script&gt;alert(&#34;XSS&#34;)&lt;/script&gt;"
- * @param html The HTML string to escape.
- * @returns The sanitized HTML string.
+ * @param {unknown} html The HTML string to escape.
+ * @returns {string} The sanitized HTML string.
  */
 export function escapeHTML(html) {
     if (typeof html !== 'string' && html instanceof String === false) {

package/dist-cms/packages/core/utils/sanitize/sanitize-html.function.d.ts

@@ -1,6 +1,6 @@
 /**
  * Sanitize a HTML string by removing any potentially harmful content such as scripts.
  * @param {string} html The HTML string to sanitize.
- * @returns The sanitized HTML string.
+ * @returns {string} The sanitized HTML string.
  */
 export declare function sanitizeHTML(html: string): string;

package/dist-cms/packages/core/utils/sanitize/sanitize-html.function.js

@@ -2,7 +2,7 @@ import { DOMPurify } from '../../../../external/dompurify/index.js';
 /**
  * Sanitize a HTML string by removing any potentially harmful content such as scripts.
  * @param {string} html The HTML string to sanitize.
- * @returns The sanitized HTML string.
+ * @returns {string} The sanitized HTML string.
  */
 export function sanitizeHTML(html) {
     return DOMPurify.sanitize(html);

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

@@ -13,62 +13,62 @@ export declare class UmbSelectionManager<ValueType extends string | null = strin
     constructor(host: UmbControllerHost);
     /**
      * Returns whether items can be selected.
-     * @returns {*}
+     * @returns {boolean} Whether items can be selected.
      * @memberof UmbSelectionManager
      */
     getSelectable(): boolean;
     /**
      * Sets whether items can be selected.
-     * @param {boolean} value
+     * @param {boolean} value - Whether items can be selected.
      * @memberof UmbSelectionManager
      */
     setSelectable(value: boolean): void;
     /**
      * Returns the current selection.
-     * @returns {*}
+     * @returns {Array<ValueType>} The current selection.
      * @memberof UmbSelectionManager
      */
     getSelection(): ValueType[];
     /**
      * Sets the current selection.
-     * @param {Array<ValueType>} value
+     * @param {Array<ValueType>} value - The new selection.
      * @memberof UmbSelectionManager
      */
     setSelection(value: Array<ValueType>): void;
     /**
      * Returns whether multiple items can be selected.
-     * @returns {*}
+     * @returns {boolean} Whether multiple items can be selected.
      * @memberof UmbSelectionManager
      */
     getMultiple(): boolean;
     /**
      * Sets whether multiple items can be selected.
-     * @param {boolean} value
+     * @param {boolean} value - Whether multiple items can be selected.
      * @memberof UmbSelectionManager
      */
     setMultiple(value: boolean): void;
     /**
      * Toggles the given unique id in the current selection.
-     * @param {(ValueType)} unique
+     * @param {(ValueType)} unique - The unique id to toggle.
      * @memberof UmbSelectionManager
      */
     toggleSelect(unique: ValueType): void;
     /**
      * Appends the given unique id to the current selection.
-     * @param {(ValueType)} unique
+     * @param {(ValueType)} unique - The unique id to select.
      * @memberof UmbSelectionManager
      */
     select(unique: ValueType): void;
     /**
      * Removes the given unique id from the current selection.
-     * @param {(ValueType)} unique
+     * @param {(ValueType)} unique - The unique id to deselect.
      * @memberof UmbSelectionManager
      */
     deselect(unique: ValueType): void;
     /**
      * Returns true if the given unique id is selected.
-     * @param {(ValueType)} unique
-     * @returns {*}
+     * @param {(ValueType)} unique - The unique id to check.
+     * @returns {boolean} True if the given unique id is selected.
      * @memberof UmbSelectionManager
      */
     isSelected(unique: ValueType): boolean;
@@ -79,13 +79,13 @@ export declare class UmbSelectionManager<ValueType extends string | null = strin
     clearSelection(): void;
     /**
      * Sets a function that determines if an item is selectable or not.
-     * @param compareFn A function that determines if an item is selectable or not.
+     * @param {(unique: ValueType) => boolean} compareFn A function that determines if an item is selectable or not.
      * @memberof UmbSelectionManager
      */
     setAllowLimitation(compareFn: (unique: ValueType) => boolean): void;
     /**
      * Returns the function that determines if an item is selectable or not.
-     * @returns {*}
+     * @returns {(unique: ValueType) => boolean} The function that determines if an item is selectable or not.
      * @memberof UmbSelectionManager
      */
     getAllowLimitation(): (unique: ValueType) => boolean;