@umbraco-cms/backoffice 15.2.3 → 15.3.0-rc2

package/dist-cms/packages/core/tree/tree-item/tree-item-base/tree-item-element-base.js

@@ -4,20 +4,11 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-import { UMB_TREE_ITEM_CONTEXT } from './tree-item-context-base.js';
 import { html, nothing, state, ifDefined, repeat, property } from '../../../../../external/lit/index.js';
 import { UmbLitElement } from '../../../lit-element/index.js';
 export class UmbTreeItemElementBase extends UmbLitElement {
-    get item() {
-        return this._item;
-    }
-    set item(newVal) {
-        this._item = newVal;
-        this.#initTreeItem();
-    }
-    #treeItemContext;
     constructor() {
-        super();
+        super(...arguments);
         this.hideActions = false;
         this._isActive = false;
         this._isLoading = false;
@@ -31,49 +22,59 @@ export class UmbTreeItemElementBase extends UmbLitElement {
         this.#onLoadMoreClick = (event) => {
             event.stopPropagation();
             const next = (this._currentPage = this._currentPage + 1);
-            this.#treeItemContext?.pagination.setCurrentPageNumber(next);
+            this.#api?.pagination.setCurrentPageNumber(next);
         };
         this.#hasNodes = (e) => {
             return e.target.assignedNodes({ flatten: true }).length > 0;
         };
-        // TODO: Notice this can be retrieve via a api property. [NL]
-        this.consumeContext(UMB_TREE_ITEM_CONTEXT, (instance) => {
-            this.#treeItemContext = instance;
-            if (!this.#treeItemContext)
-                return;
+    }
+    get item() {
+        return this._item;
+    }
+    set item(newVal) {
+        this._item = newVal;
+        if (this._item) {
             this.#initTreeItem();
-            // TODO: investigate if we can make an observe decorator
-            this.observe(this.#treeItemContext.treeItem, (value) => (this._item = value));
-            this.observe(this.#treeItemContext.childItems, (value) => (this._childItems = value));
-            this.observe(this.#treeItemContext.hasChildren, (value) => (this._hasChildren = value));
-            this.observe(this.#treeItemContext.isActive, (value) => (this._isActive = value));
-            this.observe(this.#treeItemContext.isLoading, (value) => (this._isLoading = value));
-            this.observe(this.#treeItemContext.isSelectableContext, (value) => (this._isSelectableContext = value));
-            this.observe(this.#treeItemContext.isSelectable, (value) => (this._isSelectable = value));
-            this.observe(this.#treeItemContext.isSelected, (value) => (this._isSelected = value));
-            this.observe(this.#treeItemContext.path, (value) => (this._href = value));
-            this.observe(this.#treeItemContext.pagination.currentPage, (value) => (this._currentPage = value));
-            this.observe(this.#treeItemContext.pagination.totalPages, (value) => (this._totalPages = value));
-        });
+        }
+    }
+    #api;
+    get api() {
+        return this.#api;
+    }
+    set api(value) {
+        this.#api = value;
+        if (this.#api) {
+            this.observe(this.#api.childItems, (value) => (this._childItems = value));
+            this.observe(this.#api.hasChildren, (value) => (this._hasChildren = value));
+            this.observe(this.#api.isActive, (value) => (this._isActive = value));
+            this.observe(this.#api.isLoading, (value) => (this._isLoading = value));
+            this.observe(this.#api.isSelectableContext, (value) => (this._isSelectableContext = value));
+            this.observe(this.#api.isSelectable, (value) => (this._isSelectable = value));
+            this.observe(this.#api.isSelected, (value) => (this._isSelected = value));
+            this.observe(this.#api.path, (value) => (this._href = value));
+            this.observe(this.#api.pagination.currentPage, (value) => (this._currentPage = value));
+            this.observe(this.#api.pagination.totalPages, (value) => (this._totalPages = value));
+            this.#initTreeItem();
+        }
     }
     #initTreeItem() {
-        if (!this.#treeItemContext)
+        if (!this.#api)
             return;
         if (!this._item)
             return;
-        this.#treeItemContext.setTreeItem(this._item);
+        this.#api.setTreeItem(this._item);
     }
     _handleSelectedItem(event) {
         event.stopPropagation();
-        this.#treeItemContext?.select();
+        this.#api?.select();
     }
     _handleDeselectedItem(event) {
         event.stopPropagation();
-        this.#treeItemContext?.deselect();
+        this.#api?.deselect();
     }
     // TODO: do we want to catch and emit a backoffice event here?
     _onShowChildren() {
-        this.#treeItemContext?.loadChildren();
+        this.#api?.loadChildren();
     }
     #onLoadMoreClick;
     // Note: Currently we want to prevent opening when the item is in a selectable context, but this might change in the future.
@@ -130,11 +131,11 @@ export class UmbTreeItemElementBase extends UmbLitElement {
     #renderActions() {
         if (this.hideActions)
             return;
-        return this.#treeItemContext && this._item
+        return this.#api && this._item
             ? html `<umb-entity-actions-bundle
 					slot="actions"
-					.entityType=${this.#treeItemContext.entityType}
-					.unique=${this.#treeItemContext.unique}
+					.entityType=${this.#api.entityType}
+					.unique=${this.#api.unique}
 					.label=${this._item.name}>
 				</umb-entity-actions-bundle>`
             : '';
@@ -158,6 +159,9 @@ export class UmbTreeItemElementBase extends UmbLitElement {
 __decorate([
     property({ type: Object, attribute: false })
 ], UmbTreeItemElementBase.prototype, "item", null);
+__decorate([
+    property({ type: Object, attribute: false })
+], UmbTreeItemElementBase.prototype, "api", null);
 __decorate([
     property({ type: Boolean, attribute: false })
 ], UmbTreeItemElementBase.prototype, "hideActions", void 0);

package/dist-cms/packages/core/tree/tree-item/tree-item-context.interface.d.ts

@@ -16,6 +16,7 @@ export interface UmbTreeItemContext<TreeItemType extends UmbTreeItemModel> exten
     hasActions: Observable<boolean>;
     path: Observable<string>;
     pagination: UmbPaginationManager;
+    getTreeItem(): TreeItemType | undefined;
     setTreeItem(treeItem: TreeItemType | undefined): void;
     loadChildren(): void;
     toggleContextMenu(): void;

package/dist-cms/packages/core/tree/tree-item/tree-item-default/index.d.ts

@@ -1,2 +1,3 @@
 export * from './tree-item-default.context.js';
 export * from './tree-item-default.element.js';
+export { UMB_TREE_ITEM_DEFAULT_KIND_MANIFEST } from './manifests.js';

package/dist-cms/packages/core/tree/tree-item/tree-item-default/index.js

@@ -1,2 +1,3 @@
 export * from './tree-item-default.context.js';
 export * from './tree-item-default.element.js';
+export { UMB_TREE_ITEM_DEFAULT_KIND_MANIFEST } from './manifests.js';

package/dist-cms/packages/core/tree/tree-item/tree-item-default/manifests.d.ts

@@ -1,2 +1,3 @@
 import type { UmbExtensionManifestKind } from '../../../extension-registry/index.js';
-export declare const manifests: Array<UmbExtensionManifestKind>;
+export declare const UMB_TREE_ITEM_DEFAULT_KIND_MANIFEST: UmbExtensionManifestKind;
+export declare const manifests: Array<UmbExtensionManifest | UmbExtensionManifestKind>;

package/dist-cms/packages/core/tree/tree-item/tree-item-default/manifests.js

@@ -1,13 +1,12 @@
-export const manifests = [
-    {
-        type: 'kind',
-        alias: 'Umb.Kind.TreeItem.Default',
-        matchKind: 'default',
-        matchType: 'treeItem',
-        manifest: {
-            type: 'treeItem',
-            api: () => import('./tree-item-default.context.js'),
-            element: () => import('./tree-item-default.element.js'),
-        },
+export const UMB_TREE_ITEM_DEFAULT_KIND_MANIFEST = {
+    type: 'kind',
+    alias: 'Umb.Kind.TreeItem.Default',
+    matchKind: 'default',
+    matchType: 'treeItem',
+    manifest: {
+        type: 'treeItem',
+        api: () => import('./tree-item-default.context.js'),
+        element: () => import('./tree-item-default.element.js'),
     },
-];
+};
+export const manifests = [UMB_TREE_ITEM_DEFAULT_KIND_MANIFEST];

package/dist-cms/packages/core/tree/tree-item/tree-item-default/tree-item-default.context.d.ts

@@ -1,7 +1,7 @@
 import { UmbTreeItemContextBase } from '../tree-item-base/index.js';
-import type { UmbTreeItemModel, UmbTreeRootModel } from '../../types.js';
+import type { ManifestTreeItem, UmbTreeItemModel, UmbTreeRootModel } from '../../types.js';
 import type { UmbControllerHost } from '../../../../../libs/controller-api/index.js';
-export declare class UmbDefaultTreeItemContext<TreeItemType extends UmbTreeItemModel, TreeRootType extends UmbTreeRootModel> extends UmbTreeItemContextBase<TreeItemType, TreeRootType> {
+export declare class UmbDefaultTreeItemContext<TreeItemType extends UmbTreeItemModel, TreeRootType extends UmbTreeRootModel, ManifestTreeItemType extends ManifestTreeItem = ManifestTreeItem> extends UmbTreeItemContextBase<TreeItemType, TreeRootType, ManifestTreeItemType> {
     constructor(host: UmbControllerHost);
 }
 export default UmbDefaultTreeItemContext;

package/dist-cms/packages/core/tree/tree-picker-modal/tree-picker-modal.element.js

@@ -36,7 +36,16 @@ let UmbTreePickerModalElement = class UmbTreePickerModalElement extends UmbModal
         super.updated(_changedProperties);
         if (_changedProperties.has('data')) {
             if (this.data?.search) {
-                this.#pickerContext.search.updateConfig({ ...this.data?.search, searchFrom: this.data?.startNode });
+                this.#pickerContext.search.updateConfig({
+                    ...this.data.search,
+                    searchFrom: this.data.startNode,
+                });
+                const searchQueryParams = this.data.search.queryParams;
+                if (searchQueryParams) {
+                    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                    //@ts-ignore - TODO wire up types
+                    this.#pickerContext.search.setQuery(searchQueryParams);
+                }
             }
             const multiple = this.data?.multiple ?? false;
             this.#pickerContext.selection.setMultiple(multiple);
@@ -110,7 +119,7 @@ let UmbTreePickerModalElement = class UmbTreePickerModalElement extends UmbModal
     }
     render() {
         return html `
-			<umb-body-layout  headline=${this.localize.term('general_choose')}>
+			<umb-body-layout headline=${this.localize.term('general_choose')}>
 				<uui-box> ${this.#renderSearch()} ${this.#renderTree()}</uui-box>
 				${this.#renderActions()}
 			</umb-body-layout>

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

@@ -0,0 +1,24 @@
+export interface IFormatBytesOptions {
+    /**
+     * Number of kilobytes, default is 1024.
+     * @example 1000 (1KB) or 1024 (1KiB)
+     */
+    kilo?: number;
+    /**
+     * Number of decimal places, default is 2.
+     * @example 0, 1, 2, 3, etc.
+     */
+    decimals?: number;
+    /**
+     * The culture to use for formatting the number itself, default is `undefined` which means the browser's default culture.
+     * @example 'en-GB', 'en-US', 'fr-FR', etc.
+     */
+    culture?: string;
+}
+/**
+ * Format bytes as human-readable text.
+ * @param {number} bytes - The number of bytes to format.
+ * @param {IFormatBytesOptions} opts - Optional settings.
+ * @returns {string} - The formatted bytes.
+ */
+export declare function formatBytes(bytes: number, opts?: IFormatBytesOptions): string;

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

@@ -0,0 +1,22 @@
+/* This Source Code has been derived from Lee Kelleher's Contentment.
+ * https://github.com/leekelleher/umbraco-contentment/blob/develop/src/Umbraco.Community.Contentment/DataEditors/Bytes/bytes.js
+ * SPDX-License-Identifier: MPL-2.0
+ * Copyright © 2019 Lee Kelleher.
+ * Modifications are licensed under the MIT License.
+ */
+/**
+ * Format bytes as human-readable text.
+ * @param {number} bytes - The number of bytes to format.
+ * @param {IFormatBytesOptions} opts - Optional settings.
+ * @returns {string} - The formatted bytes.
+ */
+export function formatBytes(bytes, opts) {
+    if (bytes === 0)
+        return '0 Bytes';
+    const k = opts?.kilo ?? 1024;
+    const dm = opts?.decimals ?? 2;
+    const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
+    const i = Math.floor(Math.log(bytes) / Math.log(k));
+    const n = parseFloat((bytes / Math.pow(k, i)).toFixed(dm));
+    return `${n.toLocaleString(opts?.culture)} ${sizes[i]}`;
+}

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

@@ -1,3 +1,4 @@
+export * from './bytes/bytes.function.js';
 export * from './debounce/debounce.function.js';
 export * from './direction/index.js';
 export * from './download/blob-download.function.js';

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

@@ -1,3 +1,4 @@
+export * from './bytes/bytes.function.js';
 export * from './debounce/debounce.function.js';
 export * from './direction/index.js';
 export * from './download/blob-download.function.js';

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

@@ -1,5 +1,7 @@
 /**
- *
- * @param path
+ * Generates a path to an Umbraco API endpoint.
+ * @param {string} path - The path to the Umbraco API endpoint.
+ * @param {string} version - The version of the Umbraco API (default is 'v1').
+ * @returns {string} The path to the Umbraco API endpoint.
  */
-export declare function umbracoPath(path: string): string;
+export declare function umbracoPath(path: string, version?: string): string;

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

@@ -1,8 +1,10 @@
 // TODO: Rename to something more obvious, naming wise this can mean anything. I suggest: umbracoManagementApiPath()
 /**
- *
- * @param path
+ * Generates a path to an Umbraco API endpoint.
+ * @param {string} path - The path to the Umbraco API endpoint.
+ * @param {string} version - The version of the Umbraco API (default is 'v1').
+ * @returns {string} The path to the Umbraco API endpoint.
  */
-export function umbracoPath(path) {
-    return `/umbraco/management/api/v1${path}`;
+export function umbracoPath(path, version = 'v1') {
+    return `/umbraco/management/api/${version}${path}`;
 }

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

@@ -63,4 +63,5 @@ export declare class UmbStateManager<StateType extends UmbState = UmbState> exte
      * @memberof UmbStateManager
      */
     clear(): void;
+    destroy(): void;
 }

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

@@ -77,4 +77,8 @@ export class UmbStateManager extends UmbControllerBase {
     clear() {
         this._states.setValue([]);
     }
+    destroy() {
+        super.destroy();
+        this._states.destroy();
+    }
 }

package/dist-cms/packages/core/validation/const.d.ts

@@ -1 +1,2 @@
 export declare const UMB_VALIDATION_EMPTY_LOCALIZATION_KEY = "#validation_invalidEmpty";
+export declare const UMB_VALIDATION_FALSE_LOCALIZATION_KEY = "#validation_invalidFalse";

package/dist-cms/packages/core/validation/const.js

@@ -1 +1,2 @@
 export const UMB_VALIDATION_EMPTY_LOCALIZATION_KEY = '#validation_invalidEmpty';
+export const UMB_VALIDATION_FALSE_LOCALIZATION_KEY = '#validation_invalidFalse';

package/dist-cms/packages/core/validation/context/server-model-validator.context.js

@@ -6,6 +6,7 @@ import { UmbContextBase } from '../../../../libs/class-api/index.js';
 export class UmbServerModelValidatorContext extends UmbContextBase {
     #validatePromise;
     #validatePromiseResolve;
+    #validatePromiseReject;
     #context;
     #isValid = true;
     #data;
@@ -26,9 +27,10 @@ export class UmbServerModelValidatorContext extends UmbContextBase {
     async askServerForValidation(data, requestPromise) {
         this.#context?.messages.removeMessagesByType('server');
         this.#isValid = false;
-        //this.#validatePromiseReject?.();
-        this.#validatePromise = new Promise((resolve) => {
+        this.#validatePromiseReject?.();
+        this.#validatePromise = new Promise((resolve, reject) => {
             this.#validatePromiseResolve = resolve;
+            this.#validatePromiseReject = reject;
         });
         // Store this state of the data for translator look ups:
         this.#data = data;
@@ -73,6 +75,7 @@ export class UmbServerModelValidatorContext extends UmbContextBase {
         }
         this.#validatePromiseResolve?.();
         this.#validatePromiseResolve = undefined;
+        this.#validatePromiseReject = undefined;
     }
     get isValid() {
         return this.#isValid;
@@ -83,7 +86,12 @@ export class UmbServerModelValidatorContext extends UmbContextBase {
         }
         return this.#isValid ? Promise.resolve() : Promise.reject();
     }
-    reset() { }
+    reset() {
+        this.#isValid = true;
+        this.#validatePromiseReject?.();
+        this.#validatePromiseResolve = undefined;
+        this.#validatePromiseReject = undefined;
+    }
     focusFirstInvalidElement() { }
     hostConnected() {
         super.hostConnected();

package/dist-cms/packages/core/validation/controllers/validation.controller.js

@@ -3,19 +3,7 @@ import { UMB_VALIDATION_CONTEXT } from '../context/validation.context-token.js';
 import { UmbValidationMessagesManager } from '../context/validation-messages.manager.js';
 import { UmbControllerBase } from '../../../../libs/class-api/index.js';
 import { UmbObjectState } from '../../../../libs/observable-api/index.js';
-/**
- * Helper method to replace the start of a string with another string.
- * @param path {string}
- * @param startFrom {string}
- * @param startTo {string}
- * @returns {string}
- */
-function ReplaceStartOfString(path, startFrom, startTo) {
-    if (path.startsWith(startFrom + '.')) {
-        return startTo + path.slice(startFrom.length);
-    }
-    return path;
-}
+import { ReplaceStartOfPath } from '../utils/replace-start-of-path.function.js';
 /**
  * Validation Context is the core of Validation.
  * It hosts Validators that has to validate for the context to be valid.
@@ -126,7 +114,10 @@ export class UmbValidationController extends UmbControllerBase {
                 }
                 this.#parentMessages = msgs;
                 msgs.forEach((msg) => {
-                    const path = ReplaceStartOfString(msg.path, this.#baseDataPath, '$');
+                    const path = ReplaceStartOfPath(msg.path, this.#baseDataPath, '$');
+                    if (path === undefined) {
+                        throw new Error('Path was not transformed correctly and can therefor not be transfered to the local validation context messages.');
+                    }
                     // Notice, the local message uses the same key. [NL]
                     this.messages.addMessage(msg.type, path, msg.body, msg.key);
                 });
@@ -143,7 +134,10 @@ export class UmbValidationController extends UmbControllerBase {
                 this.#localMessages = msgs;
                 msgs.forEach((msg) => {
                     // replace this.#baseDataPath (if it starts with it) with $ in the path, so it becomes relative to the parent context
-                    const path = ReplaceStartOfString(msg.path, '$', this.#baseDataPath);
+                    const path = ReplaceStartOfPath(msg.path, '$', this.#baseDataPath);
+                    if (path === undefined) {
+                        throw new Error('Path was not transformed correctly and can therefor not be synced with parent messages.');
+                    }
                     // Notice, the parent message uses the same key. [NL]
                     this.#parent.messages.addMessage(msg.type, path, msg.body, msg.key);
                 });
@@ -168,6 +162,9 @@ export class UmbValidationController extends UmbControllerBase {
     addValidator(validator) {
         if (this.#validators.includes(validator))
             return;
+        if (validator === this) {
+            throw new Error('Cannot add it self as validator');
+        }
         this.#validators.push(validator);
         //validator.addEventListener('change', this.#onValidatorChange);
         if (this.#validationMode) {
@@ -200,7 +197,7 @@ export class UmbValidationController extends UmbControllerBase {
         const resultsStatus = await Promise.all(this.#validators.map((v) => v.validate())).then(() => true, () => false);
         if (!this.messages) {
             // This Context has been destroyed while is was validating, so we should not continue.
-            return;
+            return Promise.reject();
         }
         // If we have any messages then we are not valid, otherwise lets check the validation results: [NL]
         // This enables us to keep client validations though UI is not present anymore — because the client validations got defined as messages. [NL]
@@ -227,6 +224,7 @@ export class UmbValidationController extends UmbControllerBase {
      */
     reset() {
         this.#validationMode = false;
+        this.messages.clear();
         this.#validators.forEach((v) => v.reset());
     }
     #destroyValidators() {

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

@@ -42,11 +42,11 @@ export function UmbFormControlMixin(superClass, defaultValue) {
          * @default
          */
         get value() {
+            // For some reason we need to keep this as setters and getters for inherited classes for work properly when they override these methods. [NL]
             return this.#value;
         }
         set value(newValue) {
             this.#value = newValue;
-            this._runValidators();
         }
         // Validation
         //private _validityState = new UmbValidityState();
@@ -89,7 +89,6 @@ export function UmbFormControlMixin(superClass, defaultValue) {
                 /*if (e.composedPath().some((x) => x === this)) {
                     return;
                 }*/
-                this.pristine = false;
                 this.checkValidity();
             });
         }

package/dist-cms/packages/core/validation/utils/extract-json-query-properties.function.d.ts

@@ -5,8 +5,8 @@
  * @example
  * ```ts
  * const query = `?(@.culture == 'en-us' && @.segment == 'mySegment')`;
- * const props = ExtractJsonQueryProps(query);
+ * const props = extractJsonQueryProps(query);
  * console.log(props); // { culture: 'en-us', segment: 'mySegment' }
  * ```
  */
-export declare function ExtractJsonQueryProps(query: string): Record<string, string>;
+export declare function extractJsonQueryProps(query: string): Record<string, string>;

package/dist-cms/packages/core/validation/utils/extract-json-query-properties.function.js

@@ -6,11 +6,11 @@ const propValueRegex = /@\.([a-zA-Z_$][\w$]*)\s*==\s*['"]([^'"]*)['"]/g;
  * @example
  * ```ts
  * const query = `?(@.culture == 'en-us' && @.segment == 'mySegment')`;
- * const props = ExtractJsonQueryProps(query);
+ * const props = extractJsonQueryProps(query);
  * console.log(props); // { culture: 'en-us', segment: 'mySegment' }
  * ```
  */
-export function ExtractJsonQueryProps(query) {
+export function extractJsonQueryProps(query) {
     // Object to hold property-value pairs
     const propsMap = {};
     let match;

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

@@ -0,0 +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}
+ */
+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

@@ -0,0 +1,14 @@
+/**
+ * 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}
+ */
+export function ReplaceStartOfPath(path, startFrom, startTo) {
+    // if the path conitnues with a . or [ aftr startFrom, then replace it with startTo, otherwise if identical then it is also a match. [NL]
+    if (path.startsWith(startFrom + '.') || path === startFrom) {
+        return startTo + path.slice(startFrom.length);
+    }
+    return;
+}

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

@@ -1,2 +1,3 @@
 export * from './variant-id.class.js';
+export * from './variant-object-compare.function.js';
 export type * from './types.js';

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

@@ -1 +1,2 @@
 export * from './variant-id.class.js';
+export * from './variant-object-compare.function.js';

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

@@ -2,6 +2,10 @@ import type { UmbVariantId } from './variant-id.class.js';
 import type { UmbLanguageDetailModel } from '../../language/index.js';
 import type { ScheduleRequestModel } from '../../../external/backend-api/index.js';
 import type { UmbPropertyValueData } from '../property/index.js';
+export type UmbObjectWithVariantProperties = {
+    culture: string | null;
+    segment: string | null;
+};
 export interface UmbVariantDataModel {
     culture: string | null;
     segment: string | null;

package/dist-cms/packages/core/variant/variant-id.class.d.ts

@@ -1,10 +1,9 @@
-export type UmbObjectWithVariantProperties = {
-    culture: string | null;
-    segment: string | null;
-};
+import type { UmbObjectWithVariantProperties } from './types.js';
 /**
  *
- * @param variant
+ * @param {UmbObjectWithVariantProperties} variant - An object with variant specifying properties to convert to a string.
+ * @returns {string} A string representation of the variant properties.
+ * @deprecated Use UmbVariantId to make this conversion. Will ve removed in v.17
  */
 export declare function variantPropertiesObjectToString(variant: UmbObjectWithVariantProperties): string;
 export declare const UMB_INVARIANT_CULTURE = "invariant";
@@ -28,9 +27,12 @@ export declare class UmbVariantId {
     isCultureInvariant(): boolean;
     isSegmentInvariant(): boolean;
     isInvariant(): boolean;
+    clone(): UmbVariantId;
     toObject(): UmbObjectWithVariantProperties;
     toSegmentInvariant(): UmbVariantId;
     toCultureInvariant(): UmbVariantId;
+    toCulture(culture: string | null): UmbVariantId;
+    toSegment(segment: string | null): UmbVariantId;
     toVariant(varyByCulture?: boolean, varyBySegment?: boolean): UmbVariantId;
     toDifferencesString(variantId: UmbVariantId, invariantMessage?: string, unsegmentedMessage?: string): string;
 }

package/dist-cms/packages/core/variant/variant-id.class.js

@@ -1,8 +1,16 @@
+import { UmbDeprecation } from '../utils/index.js';
 /**
  *
- * @param variant
+ * @param {UmbObjectWithVariantProperties} variant - An object with variant specifying properties to convert to a string.
+ * @returns {string} A string representation of the variant properties.
+ * @deprecated Use UmbVariantId to make this conversion. Will ve removed in v.17
  */
 export function variantPropertiesObjectToString(variant) {
+    new UmbDeprecation({
+        deprecated: 'Method `variantPropertiesObjectToString` is deprecated',
+        removeInVersion: '17',
+        solution: 'Use UmbVariantId to make this conversion',
+    }).warn();
     // Currently a direct copy of the toString method of variantId.
     return (variant.culture || UMB_INVARIANT_CULTURE) + (variant.segment ? `_${variant.segment}` : '');
 }
@@ -58,6 +66,9 @@ export class UmbVariantId {
     isInvariant() {
         return this.culture === null && this.segment === null;
     }
+    clone() {
+        return new UmbVariantId(null, this.segment);
+    }
     toObject() {
         return { culture: this.culture, segment: this.segment };
     }
@@ -67,6 +78,12 @@ export class UmbVariantId {
     toCultureInvariant() {
         return Object.freeze(new UmbVariantId(null, this.segment));
     }
+    toCulture(culture) {
+        return Object.freeze(new UmbVariantId(culture, this.segment));
+    }
+    toSegment(segment) {
+        return Object.freeze(new UmbVariantId(this.culture, segment));
+    }
     toVariant(varyByCulture, varyBySegment) {
         return Object.freeze(new UmbVariantId(varyByCulture ? this.culture : null, varyBySegment ? this.segment : null));
     }

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

@@ -0,0 +1,2 @@
+import type { UmbObjectWithVariantProperties } from './types.js';
+export declare function umbVariantObjectCompare(a: UmbObjectWithVariantProperties, b: UmbObjectWithVariantProperties): boolean;

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

@@ -0,0 +1,3 @@
+export function umbVariantObjectCompare(a, b) {
+    return a.culture === b.culture && a.segment === b.segment;
+}

package/dist-cms/packages/core/vite.config.js

@@ -23,6 +23,7 @@ export default defineConfig({
             'entity-bulk-action/index': './entity-bulk-action/index.ts',
             'entity-create-option-action/index': './entity-create-option-action/index.ts',
             'entity/index': './entity/index.ts',
+            'entity-item/index': './entity-item/index.ts',
             'entry-point': 'entry-point.ts',
             'event/index': './event/index.ts',
             'extension-registry/index': './extension-registry/index.ts',

package/dist-cms/packages/core/workspace/components/types.d.ts

@@ -0,0 +1,2 @@
+export type * from './workspace-action/types.js';
+export type * from './workspace-action-menu-item/types.js';