@umbraco-cms/backoffice 17.6.2 → 17.7.0-rc

package/dist-cms/packages/core/tree/view/table/table-tree-view.element.js

@@ -20,6 +20,7 @@ let UmbTableTreeViewElement = class UmbTableTreeViewElement extends UmbTreeViewE
         this.#tableConfig = { allowSelection: false, allowSelectAll: false, selectOnly: false };
         this.#itemMap = new Map();
         this.#rows = new Map();
+        this.#resolverContexts = new Map();
         this.#onRowRendered = (element, item) => {
             if (!element) {
                 this.#rows.get(item.id)?.destroy();
@@ -59,7 +60,51 @@ let UmbTableTreeViewElement = class UmbTableTreeViewElement extends UmbTreeViewE
     }
     #itemMap;
     #rows;
+    #resolverContexts;
     #onRowRendered;
+    // Creates/refreshes the per-item resolvers (when the repository provides them) before the rows are
+    // built, and disposes resolvers for items that are no longer shown.
+    #syncResolverContexts() {
+        const repository = this._treeContext?.getRepository();
+        for (const item of this._items) {
+            const existing = this.#resolverContexts.get(item.unique);
+            if (existing) {
+                existing.resolver.setData(item);
+                continue;
+            }
+            const resolver = repository?.createTreeItemDataResolver?.(this, { entityType: item.entityType });
+            if (!resolver)
+                continue;
+            const ctx = {
+                resolver,
+                nameObserver: undefined,
+                iconObserver: undefined,
+            };
+            // Register before observers so synchronous emissions see the context.
+            this.#resolverContexts.set(item.unique, ctx);
+            resolver.setData(item);
+            ctx.nameObserver = this.observe(resolver.name, (name) => {
+                ctx.currentName = name;
+                this.#updateRowName(item.unique);
+            }, `_observeName_${item.unique}`);
+            ctx.iconObserver = this.observe(resolver.icon, (icon) => {
+                ctx.currentIcon = icon;
+                this.#updateRowIcon(item.unique);
+            }, `_observeIcon_${item.unique}`);
+        }
+        const currentIds = new Set(this._items.map((item) => item.unique));
+        for (const [id, ctx] of this.#resolverContexts) {
+            if (!currentIds.has(id)) {
+                this.#destroyResolverContext(ctx);
+                this.#resolverContexts.delete(id);
+            }
+        }
+    }
+    #destroyResolverContext(ctx) {
+        ctx.nameObserver.destroy();
+        ctx.iconObserver.destroy();
+        ctx.resolver.destroy();
+    }
     #updateRowSelectable(id) {
         const idx = this._tableRows.findIndex((r) => r.id === id);
         if (idx === -1)
@@ -111,6 +156,44 @@ let UmbTableTreeViewElement = class UmbTableTreeViewElement extends UmbTreeViewE
             ...this._tableRows.slice(idx + 1),
         ];
     }
+    #updateRowName(id) {
+        const idx = this._tableRows.findIndex((r) => r.id === id);
+        if (idx === -1)
+            return;
+        const name = this.#resolveName(id);
+        const nameData = this._tableRows[idx].data.find((d) => d.columnAlias === 'name');
+        if (nameData?.value?.name === name)
+            return;
+        this._tableRows = [
+            ...this._tableRows.slice(0, idx),
+            {
+                ...this._tableRows[idx],
+                data: this._tableRows[idx].data.map((d) => d.columnAlias === 'name' ? { ...d, value: { ...d.value, name } } : d),
+            },
+            ...this._tableRows.slice(idx + 1),
+        ];
+    }
+    #updateRowIcon(id) {
+        const idx = this._tableRows.findIndex((r) => r.id === id);
+        if (idx === -1)
+            return;
+        const icon = this.#resolveIcon(id);
+        if (this._tableRows[idx].icon === icon)
+            return;
+        this._tableRows = [
+            ...this._tableRows.slice(0, idx),
+            { ...this._tableRows[idx], icon },
+            ...this._tableRows.slice(idx + 1),
+        ];
+    }
+    #resolveName(id) {
+        return this.#resolverContexts.get(id)?.currentName ?? this.#itemMap.get(id)?.name ?? '';
+    }
+    #resolveIcon(id) {
+        const item = this.#itemMap.get(id);
+        const fallback = item?.isFolder ? 'icon-folder' : (item?.icon ?? getItemFallbackIcon());
+        return this.#resolverContexts.get(id)?.currentIcon ?? fallback;
+    }
     _gotTreeContext() {
         super._gotTreeContext();
         this.observe(this._treeContext?.currentPageItems, (items) => {
@@ -139,12 +222,12 @@ let UmbTableTreeViewElement = class UmbTableTreeViewElement extends UmbTreeViewE
     }
     #toTableRow(item) {
         const id = item.unique;
-        const icon = item.isFolder ? 'icon-folder' : (item.icon ?? getItemFallbackIcon());
         const row = this.#rows.get(id);
         const noAccess = row?.currentNoAccess ?? false;
         const href = this._selectable ? undefined : row?.currentPath || undefined;
         const isActive = row?.currentIsActive ?? false;
-        const name = item.name;
+        const name = this.#resolveName(id);
+        const icon = this.#resolveIcon(id);
         const manifestColumnData = this.#manifestColumns.map((col) => {
             const rawValue = item[col.field];
             if (col.valueType) {
@@ -164,6 +247,9 @@ let UmbTableTreeViewElement = class UmbTableTreeViewElement extends UmbTreeViewE
             entityType: item.entityType,
             childrenIndicator: item.hasChildren ? { href, onOpen } : undefined,
             selectable: !noAccess && this._isSelectableItem(item),
+            // select-only disables all row interaction, which would leave no way to drill into an item with
+            // children while a selection is in progress.
+            selectOnly: item.hasChildren ? false : undefined,
             active: isActive,
             data: [
                 {
@@ -185,6 +271,8 @@ let UmbTableTreeViewElement = class UmbTableTreeViewElement extends UmbTreeViewE
         for (const item of items) {
             this.#itemMap.set(item.unique, item);
         }
+        // Resolve name/icon before building rows so they are present on first render.
+        this.#syncResolverContexts();
         this._tableRows = items.map((item) => this.#toTableRow(item));
         const currentIds = new Set(this._tableRows.map((row) => row.id));
         for (const [id, row] of this.#rows) {
@@ -233,6 +321,10 @@ let UmbTableTreeViewElement = class UmbTableTreeViewElement extends UmbTreeViewE
             row.destroy();
         }
         this.#rows.clear();
+        for (const ctx of this.#resolverContexts.values()) {
+            this.#destroyResolverContext(ctx);
+        }
+        this.#resolverContexts.clear();
         this.#itemMap.clear();
     }
     render() {

package/dist-cms/packages/core/tree/view/tree-view.extension.d.ts

@@ -14,10 +14,7 @@ export interface MetaTreeView {
     label: string;
     /**
      * An icon to represent the tree view
-     * @examples [
-     *   "icon-list",
-     *   "icon-grid"
-     * ]
+     * @examples ["icon-list", "icon-grid"]
      */
     icon: string;
 }

package/dist-cms/packages/core/utils/array/batch-array.d.ts

@@ -1,7 +1,8 @@
 /**
  * Splits an array into chunks of a specified size
+ * @template BatchEntryType
  * @param { Array<BatchEntryType> } array - The array to split
  * @param {number }batchSize - The size of each chunk
- * @returns {Array<Array<T>>} - An array of chunks
+ * @returns {Array<Array<BatchEntryType>>} - An array of chunks
  */
 export declare function batchArray<BatchEntryType>(array: Array<BatchEntryType>, batchSize: number): Array<Array<BatchEntryType>>;

package/dist-cms/packages/core/utils/array/batch-array.js

@@ -1,8 +1,9 @@
 /**
  * Splits an array into chunks of a specified size
+ * @template BatchEntryType
  * @param { Array<BatchEntryType> } array - The array to split
  * @param {number }batchSize - The size of each chunk
- * @returns {Array<Array<T>>} - An array of chunks
+ * @returns {Array<Array<BatchEntryType>>} - An array of chunks
  */
 export function batchArray(array, batchSize) {
     const chunks = [];

package/dist-cms/packages/core/utils/config-collection/index.d.ts

@@ -1,9 +1,11 @@
 import type { UmbConfigCollectionEntryModel } from './types.js';
 /**
  * Get a value from a config collection by its alias.
- * @param config - The config collection to get the value from.
- * @param alias - The alias of the config entry to get the value for.
- * @returns The value of the config entry with the specified alias, or undefined if not found.
+ * @template {UmbConfigCollectionEntryModel} T
+ * @template {T['alias']} K
+ * @param {T[] | undefined} config - The config collection to get the value from.
+ * @param {K} alias - The alias of the config entry to get the value for.
+ * @returns {Extract<T, { alias: K }>['value'] | undefined} The value of the config entry with the specified alias, or undefined if not found.
  */
 export declare function getConfigValue<T extends UmbConfigCollectionEntryModel, K extends T['alias']>(config: T[] | undefined, alias: K): Extract<T, {
     alias: K;

package/dist-cms/packages/core/utils/config-collection/index.js

@@ -1,8 +1,10 @@
 /**
  * Get a value from a config collection by its alias.
- * @param config - The config collection to get the value from.
- * @param alias - The alias of the config entry to get the value for.
- * @returns The value of the config entry with the specified alias, or undefined if not found.
+ * @template {UmbConfigCollectionEntryModel} T
+ * @template {T['alias']} K
+ * @param {T[] | undefined} config - The config collection to get the value from.
+ * @param {K} alias - The alias of the config entry to get the value for.
+ * @returns {Extract<T, { alias: K }>['value'] | undefined} The value of the config entry with the specified alias, or undefined if not found.
  */
 export function getConfigValue(config, alias) {
     return config?.find((entry) => entry.alias === alias)?.value;

package/dist-cms/packages/core/utils/date/date.timezone.d.ts

@@ -11,14 +11,13 @@ export interface UmbTimeZone {
 export declare function getTimeZoneList(filter?: Array<string> | undefined): Array<UmbTimeZone>;
 /**
  * Retrieves the client's time zone information.
- * @param {DateTime} [selectedDate] - An optional Luxon DateTime object to format the offset of the time zone.
  * @returns {UmbTimeZone} An object containing the client's time zone name and value.
  */
 export declare function getClientTimeZone(): UmbTimeZone;
 /**
  * Returns the time zone offset for a given time zone ID and date.
- * @param timeZoneId - The time zone identifier (e.g., 'America/New_York').
- * @param date - The Luxon DateTime object for which to get the offset.
+ * @param {string} timeZoneId - The time zone identifier (e.g., 'America/New_York').
+ * @param {DateTime} date - The Luxon DateTime object for which to get the offset.
  * @returns {string} The time zone offset
  */
 export declare function getTimeZoneOffset(timeZoneId: string, date: DateTime): string;

package/dist-cms/packages/core/utils/date/date.timezone.js

@@ -22,7 +22,6 @@ export function getTimeZoneList(filter = undefined) {
 }
 /**
  * Retrieves the client's time zone information.
- * @param {DateTime} [selectedDate] - An optional Luxon DateTime object to format the offset of the time zone.
  * @returns {UmbTimeZone} An object containing the client's time zone name and value.
  */
 export function getClientTimeZone() {
@@ -34,8 +33,8 @@ export function getClientTimeZone() {
 }
 /**
  * Returns the time zone offset for a given time zone ID and date.
- * @param timeZoneId - The time zone identifier (e.g., 'America/New_York').
- * @param date - The Luxon DateTime object for which to get the offset.
+ * @param {string} timeZoneId - The time zone identifier (e.g., 'America/New_York').
+ * @param {DateTime} date - The Luxon DateTime object for which to get the offset.
  * @returns {string} The time zone offset
  */
 export function getTimeZoneOffset(timeZoneId, date) {

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

@@ -5,6 +5,7 @@ export interface UmbDebouncedFunction<T extends (...args: Array<any>) => any> {
 /**
  * Creates a debounced version of the provided function that delays execution
  * until after the specified wait time has elapsed since the last invocation.
+ * @template T
  * @param {T} fn - The function to debounce
  * @param {number} ms - Delay in milliseconds (default: 0)
  * @returns {UmbDebouncedFunction<T>} A debounced function with a cancel method

package/dist-cms/packages/core/utils/debounce/debounce.function.js

@@ -1,6 +1,7 @@
 /**
  * Creates a debounced version of the provided function that delays execution
  * until after the specified wait time has elapsed since the last invocation.
+ * @template T
  * @param {T} fn - The function to debounce
  * @param {number} ms - Delay in milliseconds (default: 0)
  * @returns {UmbDebouncedFunction<T>} A debounced function with a cancel method

package/dist-cms/packages/core/utils/download/blob-download.function.d.ts

@@ -2,7 +2,7 @@
  * Triggers a client-side download of a file, using a `Blob` object.
  * To do this, a temporary anchor element is created, appended to the document body,
  * immediate triggered to download, then removed from the document body.
- * @param {any} data - The data to be downloaded.
+ * @param {BlobPart} data - The data to be downloaded.
  * @param {string} filename - The name of the file to be downloaded.
  * @param {string} mimeType - The MIME type of the file to be downloaded.
  * @returns {void}

package/dist-cms/packages/core/utils/download/blob-download.function.js

@@ -2,7 +2,7 @@
  * Triggers a client-side download of a file, using a `Blob` object.
  * To do this, a temporary anchor element is created, appended to the document body,
  * immediate triggered to download, then removed from the document body.
- * @param {any} data - The data to be downloaded.
+ * @param {BlobPart} data - The data to be downloaded.
  * @param {string} filename - The name of the file to be downloaded.
  * @param {string} mimeType - The MIME type of the file to be downloaded.
  * @returns {void}

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

@@ -8,7 +8,7 @@ import { UmbArrayState, type Observable } from '../../../../libs/observable-api/
  * @augments {UmbControllerBase}
  */
 export declare class UmbEntityExpansionManager<EntryModelType extends UmbEntityExpansionEntryModel = UmbEntityExpansionEntryModel> extends UmbControllerBase {
-    protected _expansion: UmbArrayState<EntryModelType, unknown>;
+    protected _expansion: UmbArrayState<EntryModelType, unknown, EntryModelType[]>;
     expansion: Observable<EntryModelType[]>;
     /**
      * Checks if an entity is expanded
@@ -74,7 +74,7 @@ export declare class UmbEntityExpansionManager<EntryModelType extends UmbEntityE
     /**
      * Gets an item from the expansion state
      * @param {EntryModelType} entity The entity to get
-     * @returns {*}  {(Promise<UmbEntityExpansionEntryModel | undefined>)}
+     * @returns {Promise<EntryModelType | undefined>} The expansion entry for the entity, if it exists.
      * @memberof UmbEntityExpansionManager
      */
     getItem(entity: EntryModelType): Promise<EntryModelType | undefined>;

package/dist-cms/packages/core/utils/expansion/entity-expansion.manager.js

@@ -113,7 +113,7 @@ export class UmbEntityExpansionManager extends UmbControllerBase {
     /**
      * Gets an item from the expansion state
      * @param {EntryModelType} entity The entity to get
-     * @returns {*}  {(Promise<UmbEntityExpansionEntryModel | undefined>)}
+     * @returns {Promise<EntryModelType | undefined>} The expansion entry for the entity, if it exists.
      * @memberof UmbEntityExpansionManager
      */
     async getItem(entity) {

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

@@ -12,7 +12,7 @@ export interface UmbGuardRule extends UmbGuardIncomingRuleBase {
 }
 export declare abstract class UmbGuardManagerBase<RuleType extends UmbGuardRule = UmbGuardRule, IncomingRuleType extends UmbGuardIncomingRuleBase = UmbPartialSome<RuleType, 'unique' | 'permitted'>> extends UmbControllerBase {
     #private;
-    protected readonly _rules: UmbArrayState<RuleType, unknown>;
+    protected readonly _rules: UmbArrayState<RuleType, unknown, RuleType[]>;
     readonly rules: import("rxjs").Observable<RuleType[]>;
     readonly hasRules: import("rxjs").Observable<boolean>;
     protected _fallback: import("rxjs").Observable<boolean>;
@@ -21,12 +21,13 @@ export declare abstract class UmbGuardManagerBase<RuleType extends UmbGuardRule
     fallbackToPermitted(): void;
     /**
      * 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: IncomingRuleType): RuleType['unique'];
     /**
      * Add multiple rules
-     * @param {RuleType[]} rules
+     * @param {RuleType[]} rules - The rules to add
      */
     addRules(rules: IncomingRuleType[]): void;
     /**

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;
 }