@umbraco-cms/backoffice 18.1.0 → 18.2.0-rc

package/dist-cms/packages/core/validation/directives/bind-to-validation.lit-directive.d.ts

@@ -14,18 +14,18 @@ declare class UmbBindToValidationDirective extends AsyncDirective {
  * A Lit directive, which binds the validation state of the element to the Validation Context.
  *
  * The minimal binding can be established by just providing a host element:
- * @example:
+ * @example
  * ```js
  * html`<input ${umbBindToValidation(this)}>`;
  * ```
  * But can be extended with a dataPath, which is the path to the data holding the value. (if no server validation in this context, then this can be fictive and is then just used internal for remembering the validation state despite the element begin removed from the DOM.)
- * @example:
+ * @example
  * ```js
  * html`<input ${umbBindToValidation(this, '$.headline')}>`;
  * ```
  *
  * Additional the value can be provided, which is then used to remove a server validation state, if the value is changed.
- * @example:
+ * @example
  * ```js
  * html`<input ${umbBindToValidation(this, '$.headline', this.headlineValue)}>`;
  * ```

package/dist-cms/packages/core/validation/directives/bind-to-validation.lit-directive.js

@@ -49,18 +49,18 @@ class UmbBindToValidationDirective extends AsyncDirective {
  * A Lit directive, which binds the validation state of the element to the Validation Context.
  *
  * The minimal binding can be established by just providing a host element:
- * @example:
+ * @example
  * ```js
  * html`<input ${umbBindToValidation(this)}>`;
  * ```
  * But can be extended with a dataPath, which is the path to the data holding the value. (if no server validation in this context, then this can be fictive and is then just used internal for remembering the validation state despite the element begin removed from the DOM.)
- * @example:
+ * @example
  * ```js
  * html`<input ${umbBindToValidation(this, '$.headline')}>`;
  * ```
  *
  * Additional the value can be provided, which is then used to remove a server validation state, if the value is changed.
- * @example:
+ * @example
  * ```js
  * html`<input ${umbBindToValidation(this, '$.headline', this.headlineValue)}>`;
  * ```

package/dist-cms/packages/core/validation/mixins/form-control.mixin.js

@@ -152,8 +152,8 @@ export function UmbFormControlMixin(superClass, defaultValue) {
          * );
          * @function addValidator
          * @param {FlagTypes} flagKey the type of validation.
-         * @param {method} getMessageMethod method to retrieve relevant message. Is executed every time the validator is re-executed.
-         * @param {method} checkMethod method to determine if this validator should invalidate this form control. Return true if this should prevent submission.
+         * @param {() => string} getMessageMethod method to retrieve relevant message. Is executed every time the validator is re-executed.
+         * @param {() => boolean} checkMethod method to determine if this validator should invalidate this form control. Return true if this should prevent submission.
          * @returns {UmbFormControlValidatorConfig} - The added validator configuration.
          */
         addValidator(flagKey, getMessageMethod, checkMethod) {

package/dist-cms/packages/core/validation/utils/data-path-variant-query.function.d.ts

@@ -4,7 +4,7 @@ import type { UmbVariantPropertyValueModel } from '../../variant/index.js';
  * Validation Data Path query generator for Variant.
  * write a JSON-Path filter similar to `?(@.culture == 'en-us' && @.segment == 'mySegment')`
  * where segment are optional.
- * @param value
- * @returns
+ * @param {UmbPartialSome<Pick<UmbVariantPropertyValueModel, 'culture' | 'segment'>, 'segment'>} value - The culture/segment to filter by.
+ * @returns {string} The JSON-Path filter query.
  */
 export declare function UmbDataPathVariantQuery(value: UmbPartialSome<Pick<UmbVariantPropertyValueModel, 'culture' | 'segment'>, 'segment'>): string;

package/dist-cms/packages/core/validation/utils/data-path-variant-query.function.js

@@ -2,8 +2,8 @@
  * Validation Data Path query generator for Variant.
  * write a JSON-Path filter similar to `?(@.culture == 'en-us' && @.segment == 'mySegment')`
  * where segment are optional.
- * @param value
- * @returns
+ * @param {UmbPartialSome<Pick<UmbVariantPropertyValueModel, 'culture' | 'segment'>, 'segment'>} value - The culture/segment to filter by.
+ * @returns {string} The JSON-Path filter query.
  */
 export function UmbDataPathVariantQuery(value) {
     // write a array of strings for each property, where culture must be present and segment is optional

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

@@ -98,7 +98,7 @@ function _GetNextArrayEntryFromPath(array, path) {
 }
 /**
  * @param {string} filter - A JSON Query, limited to filtering features. Do not support other JSON PATH Query features.
- * @returns {Array<(queryFilter: any) => boolean>} - An array of methods that returns true if the given items property value matches the value of the query.
+ * @returns {Array<(item: Record<string, unknown>) => boolean>} - An array of methods that returns true if the given items property value matches the value of the query.
  */
 function JsFilterFromJsonPathFilter(filter) {
     // strip ?( and ) from the filter

package/dist-cms/packages/core/validation/utils/query-mapper-json-paths.function.d.ts

@@ -1,12 +1,10 @@
 /**
  * Helper method to replace paths index with queries and additionally map the paths.
- * @param {Array<string>} paths - the JSON paths to map.
- * @param {string} scopePath - the JSON path to scope the mapping to.
- * @param {(Array<string>)} scopedMapper - Map function which receives the paths in the scope and returns the resolved paths.
- * @param scopePaths
- * @param scopeData
- * @param queryConstructor
- * @param mapper
+ * @template T
+ * @param {Array<string>} scopePaths - the JSON paths to map.
+ * @param {Array<T>} scopeData - the data corresponding to each entry, used to construct queries.
+ * @param {(entry: T) => string} queryConstructor - constructs a JSON-Path query for a given data entry.
+ * @param {(scopedPaths: Array<string>, propertyData: T | undefined) => Promise<Array<string>>} mapper - map function which receives the paths in the scope and returns the resolved paths.
  * @returns {string} - the paths, including the once mapped by the scoped mapper. Notice the order is kept.
  */
 export declare function umbQueryMapperForJsonPaths<T>(scopePaths: Array<string>, scopeData: Array<T>, queryConstructor: (entry: T) => string, mapper?: (scopedPaths: Array<string>, propertyData: T | undefined) => Promise<Array<string>>): Promise<Array<string>>;

package/dist-cms/packages/core/validation/utils/query-mapper-json-paths.function.js

@@ -2,13 +2,11 @@ import { GetValueByJsonPath } from './json-path.function.js';
 import { umbScopeMapperForJsonPaths } from './scope-mapper-json-paths.function.js';
 /**
  * Helper method to replace paths index with queries and additionally map the paths.
- * @param {Array<string>} paths - the JSON paths to map.
- * @param {string} scopePath - the JSON path to scope the mapping to.
- * @param {(Array<string>)} scopedMapper - Map function which receives the paths in the scope and returns the resolved paths.
- * @param scopePaths
- * @param scopeData
- * @param queryConstructor
- * @param mapper
+ * @template T
+ * @param {Array<string>} scopePaths - the JSON paths to map.
+ * @param {Array<T>} scopeData - the data corresponding to each entry, used to construct queries.
+ * @param {(entry: T) => string} queryConstructor - constructs a JSON-Path query for a given data entry.
+ * @param {(scopedPaths: Array<string>, propertyData: T | undefined) => Promise<Array<string>>} mapper - map function which receives the paths in the scope and returns the resolved paths.
  * @returns {string} - the paths, including the once mapped by the scoped mapper. Notice the order is kept.
  */
 export async function umbQueryMapperForJsonPaths(scopePaths, scopeData, queryConstructor, mapper) {

package/dist-cms/packages/core/validation/utils/replace-start-of-path.function.d.ts

@@ -1,8 +1,8 @@
 /**
  * Helper method to replace the start of a JSON Path with another JSON Path.
- * @param path {string}
- * @param startFrom {string}
- * @param startTo {string}
- * @returns {string}
+ * @param {string} path - the JSON path to transform.
+ * @param {string} startFrom - the path prefix to match against.
+ * @param {string} startTo - the path prefix to replace it with.
+ * @returns {string} the transformed path, or undefined if `path` does not start with `startFrom`.
  */
 export declare function ReplaceStartOfPath(path: string, startFrom: string, startTo: string): string | undefined;

package/dist-cms/packages/core/validation/utils/replace-start-of-path.function.js

@@ -1,9 +1,9 @@
 /**
  * Helper method to replace the start of a JSON Path with another JSON Path.
- * @param path {string}
- * @param startFrom {string}
- * @param startTo {string}
- * @returns {string}
+ * @param {string} path - the JSON path to transform.
+ * @param {string} startFrom - the path prefix to match against.
+ * @param {string} startTo - the path prefix to replace it with.
+ * @returns {string} the transformed path, or undefined if `path` does not start with `startFrom`.
  */
 export function ReplaceStartOfPath(path, startFrom, startTo) {
     // if the path continues with a . after startFrom, then replace it with startTo, otherwise if identical then it is also a match. [NL]

package/dist-cms/packages/core/value-summary/extensions/load-value-summary-resolver.function.d.ts

@@ -1,6 +1,6 @@
-import type { ClassConstructor } from '../../../../libs/extension-api/index.js';
 import type { UmbValueSummaryResolver } from './value-summary-resolver.interface.js';
 import type { UmbValueSummaryResolverLoaderProperty } from './value-summary.extension.js';
+import type { ClassConstructor } from '../../../../libs/extension-api/index.js';
 /**
  * @internal
  * @param {UmbValueSummaryResolverLoaderProperty} property - The property from which to load the resolver.

package/dist-cms/packages/core/value-summary/global-components/value-summary.element.d.ts

@@ -5,7 +5,7 @@ export declare class UmbValueSummaryExtensionElement extends UmbLitElement {
     set valueType(value: string | undefined);
     get valueType(): string | undefined;
     value?: unknown;
-    render(): typeof nothing | import("lit-html").TemplateResult<1>;
+    render(): import("lit-html").TemplateResult<1> | typeof nothing;
 }
 export { UmbValueSummaryExtensionElement as element };
 declare global {

package/dist-cms/packages/core/value-summary/value-types/boolean/boolean-value-summary.element.d.ts

@@ -1,7 +1,7 @@
 import { UmbValueSummaryElementBase } from '../../base/value-summary-element.base.js';
 import { nothing } from '../../../../../external/lit/index.js';
 export declare class UmbBooleanValueSummaryElement extends UmbValueSummaryElementBase<boolean> {
-    render(): typeof nothing | import("lit-html").TemplateResult<1>;
+    render(): import("lit-html").TemplateResult<1> | typeof nothing;
 }
 export { UmbBooleanValueSummaryElement as element };
 declare global {

package/dist-cms/packages/core/value-summary/value-types/boolean/manifests.js

@@ -1,6 +1,6 @@
 import { UMB_BOOLEAN_VALUE_SUMMARY_ALIAS } from './constants.js';
-import { UMB_BOOLEAN_VALUE_TYPE } from '../../../value-type/index.js';
 import { UmbBooleanValueSummaryElement } from './boolean-value-summary.element.js';
+import { UMB_BOOLEAN_VALUE_TYPE } from '../../../value-type/index.js';
 export const manifests = [
     {
         type: 'valueSummary',

package/dist-cms/packages/core/value-summary/value-types/date-time/manifests.js

@@ -1,6 +1,6 @@
 import { UMB_DATE_TIME_VALUE_SUMMARY_ALIAS } from './constants.js';
-import { UMB_DATE_TIME_VALUE_TYPE } from '../../../value-type/index.js';
 import { UmbDateTimeValueSummaryElement } from './date-time-value-summary.element.js';
+import { UMB_DATE_TIME_VALUE_TYPE } from '../../../value-type/index.js';
 export const manifests = [
     {
         type: 'valueSummary',

package/dist-cms/packages/core/variant/index.d.ts

@@ -3,4 +3,5 @@ export * from './context/index.js';
 export * from './sort-variants.function.js';
 export * from './variant-id.class.js';
 export * from './variant-object-compare.function.js';
+export * from './variant-resolver.js';
 export type * from './types.js';

package/dist-cms/packages/core/variant/index.js

@@ -3,3 +3,4 @@ export * from './context/index.js';
 export * from './sort-variants.function.js';
 export * from './variant-id.class.js';
 export * from './variant-object-compare.function.js';
+export * from './variant-resolver.js';

package/dist-cms/packages/core/variant/variant-object-compare.function.d.ts

@@ -1,7 +1,8 @@
 import type { UmbObjectWithVariantProperties } from './types.js';
 /**
- *
- * @param a
- * @param b
+ * Compares the culture and segment of two variant objects.
+ * @param {UmbObjectWithVariantProperties} a - the first object to compare.
+ * @param {UmbObjectWithVariantProperties} b - the second object to compare.
+ * @returns {boolean} true if both objects share the same culture and segment.
  */
 export declare function umbVariantObjectCompare(a: UmbObjectWithVariantProperties, b: UmbObjectWithVariantProperties): boolean;

package/dist-cms/packages/core/variant/variant-object-compare.function.js

@@ -1,7 +1,8 @@
 /**
- *
- * @param a
- * @param b
+ * Compares the culture and segment of two variant objects.
+ * @param {UmbObjectWithVariantProperties} a - the first object to compare.
+ * @param {UmbObjectWithVariantProperties} b - the second object to compare.
+ * @returns {boolean} true if both objects share the same culture and segment.
  */
 export function umbVariantObjectCompare(a, b) {
     return a.culture === b.culture && a.segment === b.segment;

package/dist-cms/packages/core/variant/variant-resolver.d.ts

@@ -0,0 +1,56 @@
+import { UmbControllerBase } from '../../../libs/class-api/index.js';
+import type { UmbControllerHost } from '../../../libs/controller-api/index.js';
+export interface UmbVariantLike {
+    culture: string | null;
+    segment?: string | null;
+}
+/**
+ * Resolves which variant of a given set matches the ambient variant context.
+ * @exports
+ * @class UmbVariantResolver
+ */
+export declare class UmbVariantResolver<VariantType extends UmbVariantLike = UmbVariantLike> extends UmbControllerBase {
+    #private;
+    readonly displayCulture: import("rxjs").Observable<string | null | undefined>;
+    readonly fallbackCulture: import("rxjs").Observable<string | null | undefined>;
+    readonly variant: import("rxjs").Observable<VariantType | undefined>;
+    readonly culture: import("rxjs").Observable<string | null | undefined>;
+    readonly fallbackVariant: import("rxjs").Observable<VariantType | undefined>;
+    constructor(host: UmbControllerHost);
+    /**
+     * Sets the variants to resolve against the ambient variant context.
+     * @param {Array<VariantType> | undefined} variants - The variants to resolve from.
+     * @memberof UmbVariantResolver
+     */
+    setVariants(variants: Array<VariantType> | undefined): void;
+    /**
+     * Gets the current set of variants.
+     * @returns {Array<VariantType>} The current variants.
+     * @memberof UmbVariantResolver
+     */
+    getVariants(): Array<VariantType>;
+    /**
+     * Gets the current display culture.
+     * @returns {string | null | undefined} The display culture.
+     * @memberof UmbVariantResolver
+     */
+    getDisplayCulture(): string | null | undefined;
+    /**
+     * Gets the current fallback culture.
+     * @returns {string | null | undefined} The fallback culture.
+     * @memberof UmbVariantResolver
+     */
+    getFallbackCulture(): string | null | undefined;
+    /**
+     * Gets the variant matching the display culture (or the invariant variant).
+     * @returns {VariantType | undefined} The resolved variant.
+     * @memberof UmbVariantResolver
+     */
+    getVariant(): VariantType | undefined;
+    /**
+     * Gets the variant matching the fallback culture.
+     * @returns {VariantType | undefined} The resolved fallback variant.
+     * @memberof UmbVariantResolver
+     */
+    getFallbackVariant(): VariantType | undefined;
+}

package/dist-cms/packages/core/variant/variant-resolver.js

@@ -0,0 +1,112 @@
+import { UMB_VARIANT_CONTEXT } from './context/constants.js';
+import { UmbControllerBase } from '../../../libs/class-api/index.js';
+import { UmbArrayState, UmbObjectState, UmbStringState } from '../../../libs/observable-api/index.js';
+/**
+ * Resolves which variant of a given set matches the ambient variant context.
+ * @exports
+ * @class UmbVariantResolver
+ */
+export class UmbVariantResolver extends UmbControllerBase {
+    #variants;
+    #displayCulture;
+    #fallbackCulture;
+    #variant;
+    #fallbackVariant;
+    constructor(host) {
+        super(host);
+        this.#variants = new UmbArrayState([], (variant) => `${variant.culture}:${variant.segment ?? null}`);
+        this.#displayCulture = new UmbStringState(undefined);
+        this.displayCulture = this.#displayCulture.asObservable();
+        this.#fallbackCulture = new UmbStringState(undefined);
+        this.fallbackCulture = this.#fallbackCulture.asObservable();
+        this.#variant = new UmbObjectState(undefined);
+        this.variant = this.#variant.asObservable();
+        this.culture = this.#variant.asObservablePart((variant) => variant?.culture);
+        this.#fallbackVariant = new UmbObjectState(undefined);
+        this.fallbackVariant = this.#fallbackVariant.asObservable();
+        this.consumeContext(UMB_VARIANT_CONTEXT, (context) => {
+            this.#observeContext(context);
+        });
+    }
+    #observeContext(context) {
+        this.observe(context?.displayCulture, (displayCulture) => {
+            if (displayCulture === undefined)
+                return;
+            this.#displayCulture.setValue(displayCulture);
+            this.#process();
+        }, 'umbObserveDisplayCulture');
+        this.observe(context?.fallbackCulture, (fallbackCulture) => {
+            if (fallbackCulture === undefined)
+                return;
+            this.#fallbackCulture.setValue(fallbackCulture);
+            this.#process();
+        }, 'umbObserveFallbackCulture');
+    }
+    /**
+     * Sets the variants to resolve against the ambient variant context.
+     * @param {Array<VariantType> | undefined} variants - The variants to resolve from.
+     * @memberof UmbVariantResolver
+     */
+    setVariants(variants) {
+        this.#variants.setValue(variants ?? []);
+        this.#process();
+    }
+    /**
+     * Gets the current set of variants.
+     * @returns {Array<VariantType>} The current variants.
+     * @memberof UmbVariantResolver
+     */
+    getVariants() {
+        return this.#variants.getValue();
+    }
+    /**
+     * Gets the current display culture.
+     * @returns {string | null | undefined} The display culture.
+     * @memberof UmbVariantResolver
+     */
+    getDisplayCulture() {
+        return this.#displayCulture.getValue();
+    }
+    /**
+     * Gets the current fallback culture.
+     * @returns {string | null | undefined} The fallback culture.
+     * @memberof UmbVariantResolver
+     */
+    getFallbackCulture() {
+        return this.#fallbackCulture.getValue();
+    }
+    /**
+     * Gets the variant matching the display culture (or the invariant variant).
+     * @returns {VariantType | undefined} The resolved variant.
+     * @memberof UmbVariantResolver
+     */
+    getVariant() {
+        return this.#variant.getValue();
+    }
+    /**
+     * Gets the variant matching the fallback culture.
+     * @returns {VariantType | undefined} The resolved fallback variant.
+     * @memberof UmbVariantResolver
+     */
+    getFallbackVariant() {
+        return this.#fallbackVariant.getValue();
+    }
+    #process() {
+        const variants = this.#variants.getValue();
+        if (variants.length === 0) {
+            this.#variant.setValue(undefined);
+            this.#fallbackVariant.setValue(undefined);
+            return;
+        }
+        // Invariant content has a non-segment variant with a null culture; it is always the match.
+        if (variants[0].culture === null) {
+            this.#variant.setValue(variants.find((variant) => variant.culture === null && !variant.segment));
+            this.#fallbackVariant.setValue(undefined);
+            return;
+        }
+        const displayCulture = this.#displayCulture.getValue();
+        const fallbackCulture = this.#fallbackCulture.getValue();
+        this.#variant.setValue(variants.find((variant) => variant.culture === displayCulture && !variant.segment));
+        this.#fallbackVariant.setValue(variants.find((variant) => variant.culture === fallbackCulture && !variant.segment));
+    }
+}

package/dist-cms/packages/core/view/context/view.controller.d.ts

@@ -33,19 +33,20 @@ export declare class UmbViewController extends UmbControllerBase {
     inherit(): void;
     inheritFrom(context?: UmbViewController): void;
     /**
-     * @internal
      * Notify that a view context has been activated.
+     * @internal
+     * @returns {boolean} true if the view is (or becomes) active.
      */
     _internal_requestActivate(): boolean;
     /**
-     * @internal
      * Notify that a view context has been activated.
+     * @internal
      */
     _internal_activate(): void;
     /**
-     * @internal
      * Deactivate the view context.
      * We cannot conclude that this means the parent should be activated, it can be because of a child being activated.
+     * @internal
      */
     _internal_deactivate(): void;
     getComputedTitle(): string | undefined;

package/dist-cms/packages/core/view/context/view.controller.js

@@ -1,6 +1,6 @@
 var _a;
-import { UmbShortcutController } from '../../shortcut/index.js';
 import { UMB_VIEW_CONTEXT } from './view.context-token.js';
+import { UmbShortcutController } from '../../shortcut/index.js';
 import { UmbClassState, UmbStringState, mergeObservables } from '../../../../libs/observable-api/index.js';
 import { UmbControllerBase } from '../../../../libs/class-api/index.js';
 import { UmbHintController } from '../../hint/index.js';
@@ -198,8 +198,9 @@ export class UmbViewController extends UmbControllerBase {
         }
     }
     /**
-     * @internal
      * Notify that a view context has been activated.
+     * @internal
+     * @returns {boolean} true if the view is (or becomes) active.
      */
     // eslint-disable-next-line @typescript-eslint/naming-convention
     _internal_requestActivate() {
@@ -238,8 +239,8 @@ export class UmbViewController extends UmbControllerBase {
         return false;
     }
     /**
-     * @internal
      * Notify that a view context has been activated.
+     * @internal
      */
     // eslint-disable-next-line @typescript-eslint/naming-convention
     _internal_activate() {
@@ -251,9 +252,9 @@ export class UmbViewController extends UmbControllerBase {
         }
     }
     /**
-     * @internal
      * Deactivate the view context.
      * We cannot conclude that this means the parent should be activated, it can be because of a child being activated.
+     * @internal
      */
     // eslint-disable-next-line @typescript-eslint/naming-convention
     _internal_deactivate() {

package/dist-cms/packages/core/workspace/components/workspace-action/workspace-action-base.controller.d.ts

@@ -8,7 +8,7 @@ import type { Observable } from '../../../../../external/rxjs/index.js';
  * @abstract
  * @class UmbWorkspaceActionBase
  * @augments {UmbActionBase}
- * @implements {UmbEntityAction}
+ * @implements {UmbWorkspaceAction}
  * @template RepositoryType
  */
 export declare abstract class UmbWorkspaceActionBase<ArgsMetaType = never> extends UmbActionBase<UmbWorkspaceActionArgs<ArgsMetaType>> implements UmbWorkspaceAction<ArgsMetaType> {
@@ -20,7 +20,7 @@ export declare abstract class UmbWorkspaceActionBase<ArgsMetaType = never> exten
      * By specifying the href, the action will act as a link.
      * The `execute` method will not be called.
      * @abstract
-     * @returns {string | undefined}
+     * @returns {string | undefined} the href to link to.
      */
     getHref(): Promise<string | undefined>;
     /**

package/dist-cms/packages/core/workspace/components/workspace-action/workspace-action-base.controller.js

@@ -5,7 +5,7 @@ import { UmbActionBase } from '../../../action/index.js';
  * @abstract
  * @class UmbWorkspaceActionBase
  * @augments {UmbActionBase}
- * @implements {UmbEntityAction}
+ * @implements {UmbWorkspaceAction}
  * @template RepositoryType
  */
 export class UmbWorkspaceActionBase extends UmbActionBase {
@@ -18,7 +18,7 @@ export class UmbWorkspaceActionBase extends UmbActionBase {
      * By specifying the href, the action will act as a link.
      * The `execute` method will not be called.
      * @abstract
-     * @returns {string | undefined}
+     * @returns {string | undefined} the href to link to.
      */
     getHref() {
         return Promise.resolve(undefined);

package/dist-cms/packages/core/workspace/components/workspace-action-menu/workspace-action-menu.element.d.ts

@@ -11,7 +11,7 @@ export declare class UmbWorkspaceActionMenuElement extends UmbLitElement {
     private _popoverOpen;
     private _popover?;
     private _onPopoverClickCapture;
-    render(): typeof nothing | import("lit-html").TemplateResult<1>;
+    render(): import("lit-html").TemplateResult<1> | typeof nothing;
     static styles: import("lit").CSSResult[];
 }
 declare global {

package/dist-cms/packages/core/workspace/components/workspace-action-menu-item/workspace-action-menu-item-base.controller.d.ts

@@ -14,7 +14,7 @@ export declare abstract class UmbWorkspaceActionMenuItemBase<ArgsMetaType = neve
      * By specifying the href, the action will act as a link.
      * The `execute` method will not be called.
      * @abstract
-     * @returns {string | undefined}
+     * @returns {string | undefined} the href to link to.
      */
     getHref(): Promise<string | undefined>;
     /**

package/dist-cms/packages/core/workspace/components/workspace-action-menu-item/workspace-action-menu-item-base.controller.js

@@ -12,7 +12,7 @@ export class UmbWorkspaceActionMenuItemBase extends UmbActionBase {
      * By specifying the href, the action will act as a link.
      * The `execute` method will not be called.
      * @abstract
-     * @returns {string | undefined}
+     * @returns {string | undefined} the href to link to.
      */
     getHref() {
         return Promise.resolve(undefined);

package/dist-cms/packages/core/workspace/components/workspace-entity-action-menu/workspace-entity-action-menu.element.d.ts

@@ -5,7 +5,7 @@ export declare class UmbWorkspaceEntityActionMenuElement extends UmbLitElement {
     private _unique?;
     private _entityType?;
     constructor();
-    render(): typeof nothing | import("lit-html").TemplateResult<1>;
+    render(): import("lit-html").TemplateResult<1> | typeof nothing;
     static styles: import("lit").CSSResult[];
 }
 declare global {

package/dist-cms/packages/core/workspace/components/workspace-footer/workspace-footer.element.js

@@ -10,9 +10,9 @@ import { css, html, customElement, state } from '../../../../../external/lit/ind
 import { UmbLitElement } from '../../../lit-element/index.js';
 import { UMB_MODAL_CONTEXT } from '../../../modal/index.js';
 /**
- *
- * @param manifest
- * @returns
+ * Builds the args passed to a workspace action's extension API.
+ * @param {ManifestWorkspaceAction<MetaWorkspaceAction>} manifest - the workspace action manifest.
+ * @returns {[UmbWorkspaceActionArgs<MetaWorkspaceAction>]} the args for the workspace action.
  */
 function ExtensionApiArgsMethod(manifest) {
     return [{ meta: manifest.meta }];

package/dist-cms/packages/core/workspace/components/workspace-split-view/workspace-split-view-variant-selector.element.d.ts

@@ -26,7 +26,7 @@ export declare class UmbWorkspaceSplitViewVariantSelectorElement<VariantOptionMo
     protected _variantSorter: (a: VariantOptionModelType, b: VariantOptionModelType) => number;
     constructor();
     private _hintMap;
-    render(): typeof nothing | import("lit-html").TemplateResult<1>;
+    render(): import("lit-html").TemplateResult<1> | typeof nothing;
     protected _renderVariantDetails(variantOption: VariantOptionModelType): import("lit-html").TemplateResult<1>;
     static styles: import("lit").CSSResult[];
 }

package/dist-cms/packages/core/workspace/components/workspace-split-view/workspace-split-view.element.d.ts

@@ -15,6 +15,10 @@ export declare class UmbWorkspaceSplitViewElement extends UmbLitElement {
     displayNavigation: boolean;
     backPath?: string;
     overrides?: Array<UmbDeepPartialObject<ManifestWorkspaceView>>;
+    /**
+     * Set this to true if you provide a custom variant selector in the header slot, do this to avoid the default variant selector being rendered shortly.
+     */
+    hasCustomVariantSelector?: boolean;
     set splitViewIndex(index: number);
     get splitViewIndex(): number;
     private _variantSelectorSlotHasContent;

package/dist-cms/packages/core/workspace/components/workspace-split-view/workspace-split-view.element.js

@@ -54,7 +54,7 @@ let UmbWorkspaceSplitViewElement = class UmbWorkspaceSplitViewElement extends Um
 				.enforceNoFooter=${true}>
 				<slot id="icon" name="icon" slot="header"></slot>
 				<slot id="header" name="variant-selector" slot="header" @slotchange=${this.#onVariantSelectorSlotChanged}>
-					${when(!this._variantSelectorSlotHasContent, () => html `<umb-workspace-split-view-variant-selector></umb-workspace-split-view-variant-selector>`)}
+					${when(!this.hasCustomVariantSelector && !this._variantSelectorSlotHasContent, () => html `<umb-workspace-split-view-variant-selector></umb-workspace-split-view-variant-selector>`)}
 				</slot>
 				${this.#renderEntityActions()}
 				<slot name="action-menu" slot="action-menu"></slot>
@@ -111,6 +111,9 @@ __decorate([
 __decorate([
     property({ attribute: false })
 ], UmbWorkspaceSplitViewElement.prototype, "overrides", void 0);
+__decorate([
+    property({ attribute: false })
+], UmbWorkspaceSplitViewElement.prototype, "hasCustomVariantSelector", void 0);
 __decorate([
     property({ type: Number })
 ], UmbWorkspaceSplitViewElement.prototype, "splitViewIndex", null);

package/dist-cms/packages/core/workspace/contexts/tokens/publishable-workspace-context.interface.d.ts

@@ -1,5 +1,5 @@
-import type { UmbWorkspaceActionExecutionOptions } from './workspace-action-execution-options.interface.js';
 import type { UmbWorkspaceContext } from '../../workspace-context.interface.js';
+import type { UmbWorkspaceActionExecutionOptions } from './workspace-action-execution-options.interface.js';
 export interface UmbPublishableWorkspaceContext extends UmbWorkspaceContext {
     saveAndPublish(options?: UmbWorkspaceActionExecutionOptions): Promise<void>;
     publish(): Promise<void>;

package/dist-cms/packages/core/workspace/contexts/tokens/variant-dataset-workspace-context.interface.d.ts

@@ -1,6 +1,6 @@
 import type { UmbWorkspaceSplitViewManager } from '../../controllers/workspace-split-view-manager.controller.js';
-import type { UmbPropertyDatasetContext } from '../../../property/index.js';
 import type { UmbSubmittableWorkspaceContext } from './submittable-workspace-context.interface.js';
+import type { UmbPropertyDatasetContext } from '../../../property/index.js';
 import type { Observable } from '../../../../../external/rxjs/index.js';
 import type { UmbVariantId, UmbEntityVariantModel, UmbEntityVariantOptionModel } from '../../../variant/index.js';
 import type { UmbControllerHost } from '../../../../../libs/controller-api/index.js';