@umbraco-cms/backoffice 17.5.3 → 17.6.0-rc

package/dist-cms/packages/documents/documents/tree/tree-item/document-tree-item.element.js

@@ -19,7 +19,9 @@ let UmbDocumentTreeItemElement = class UmbDocumentTreeItemElement extends UmbTre
         this._renderExpandSymbol = () => {
             // If this in the menu and it is a collection, then we will enforce the user to the Collection view instead of expanding.
             // `this._forceShowExpand` is equivalent to hasCollection for this element.
-            if (this._isMenu && this._forceShowExpand) {
+            // Exception: a "no access" collection is an ancestor of the user's start node, so it must stay
+            // expandable in the tree (render the normal caret) to let the user browse down to it.
+            if (this._isMenu && this._forceShowExpand && !this._noAccess) {
                 return html `<umb-icon data-mark="open-collection" name="icon-list" style="font-size: 8px;"></umb-icon>`;
             }
             else {
@@ -39,10 +41,7 @@ let UmbDocumentTreeItemElement = class UmbDocumentTreeItemElement extends UmbTre
                 this.requestUpdate('_forceShowExpand', oldValue);
             });
             this.observe(this.#api.icon, (icon) => (this.#icon = icon || ''));
-            this.observe(this.#api.flags, (flags) => (this._flags = flags || ''));
-            // Observe noAccess from context and update base class property (_noAccess).
-            // This enables access restriction behavior (click prevention) and styling from the base class.
-            this.observe(this.#api.noAccess, (noAccess) => (this._noAccess = noAccess));
+            this.observe(this.#api.flags, (flags) => (this._flags = flags || []));
         }
         super.api = value;
     }

package/dist-cms/packages/documents/documents/tree/types.d.ts

@@ -1,6 +1,6 @@
 import type { UmbDocumentEntityType, UmbDocumentRootEntityType } from '../entity.js';
+import type { UmbDocumentVariantState } from '../variant-state.js';
 import type { UmbTreeChildrenOfRequestArgs, UmbTreeItemModel, UmbTreeRootItemsRequestArgs, UmbTreeRootModel } from '../../../core/tree/index.js';
-import type { DocumentVariantStateModel } from '../../../core/backend-api/index.js';
 import type { UmbReferenceByUnique } from '../../../core/models/index.js';
 import type { UmbEntityModel } from '../../../core/entity/index.js';
 import type { UmbEntityFlag, UmbEntityWithFlags } from '../../../core/entity-flag/index.js';
@@ -25,7 +25,7 @@ export interface UmbDocumentTreeItemVariantModel {
     name: string;
     culture: string | null;
     segment: string | null;
-    state: DocumentVariantStateModel | null;
+    state: UmbDocumentVariantState | null;
     flags: Array<UmbEntityFlag>;
 }
 export interface UmbDocumentTreeRootItemsRequestArgs extends UmbTreeRootItemsRequestArgs {

package/dist-cms/packages/documents/documents/types.d.ts

@@ -1,9 +1,8 @@
 import type { UmbDocumentEntityType } from './entity.js';
+import type { UmbDocumentVariantState } from './variant-state.js';
 import type { UmbEntityVariantModel, UmbEntityVariantOptionModel, UmbEntityVariantPublishModel } from '../../core/variant/index.js';
 import type { UmbReferenceByUnique } from '../../core/models/index.js';
-import { DocumentVariantStateModel as UmbDocumentVariantState } from '../../core/backend-api/index.js';
 import type { UmbContentDetailModel, UmbElementValueModel } from '../../content/content/index.js';
-export { UmbDocumentVariantState };
 export type * from './audit-log/types.js';
 export type * from './collection/types.js';
 export type * from './entity.js';

package/dist-cms/packages/documents/documents/types.js

@@ -1,2 +1 @@
-import { DocumentVariantStateModel as UmbDocumentVariantState } from '../../core/backend-api/index.js';
-export { UmbDocumentVariantState };
+export {};

package/dist-cms/packages/documents/documents/url/document-urls-data-resolver.d.ts

@@ -15,6 +15,13 @@ export declare class UmbDocumentUrlsDataResolver extends UmbControllerBase {
      * @memberof UmbDocumentUrlsDataResolver
      */
     readonly urls: import("rxjs").Observable<UmbDocumentUrlModel[]>;
+    /**
+     * The culture to request urls for from the server. Emits whenever the displayed culture changes.
+     * Resolves to undefined for invariant documents (meaning all cultures).
+     * @returns {Observable<string | undefined>} The culture to request urls for
+     * @memberof UmbDocumentUrlsDataResolver
+     */
+    readonly requestCulture: import("rxjs").Observable<string | undefined>;
     constructor(host: UmbControllerHost);
     /**
      * Get the current data
@@ -34,4 +41,12 @@ export declare class UmbDocumentUrlsDataResolver extends UmbControllerBase {
      * @memberof UmbDocumentUrlsDataResolver
      */
     getUrls(): Promise<Array<UmbDocumentUrlModel> | []>;
+    /**
+     * Gets the culture to request urls for from the server.
+     * Returns the current culture for variant documents, or undefined for invariant documents
+     * (which must return all of their domain urls).
+     * @returns {Promise<string | undefined>} The culture to request, or undefined for all cultures
+     * @memberof UmbDocumentUrlsDataResolver
+     */
+    getRequestCulture(): Promise<string | undefined>;
 }

package/dist-cms/packages/documents/documents/url/document-urls-data-resolver.js

@@ -1,5 +1,5 @@
 import { UmbControllerBase } from '../../../../libs/class-api/index.js';
-import { UmbArrayState } from '../../../../libs/observable-api/index.js';
+import { UmbArrayState, UmbStringState } from '../../../../libs/observable-api/index.js';
 import { UMB_VARIANT_CONTEXT } from '../../../core/variant/index.js';
 /**
  * A controller for resolving data for document urls
@@ -8,12 +8,12 @@ import { UMB_VARIANT_CONTEXT } from '../../../core/variant/index.js';
  * @augments {UmbControllerBase}
  */
 export class UmbDocumentUrlsDataResolver extends UmbControllerBase {
-    #appCulture;
     #variantId;
     #displayVariantId;
     #data;
     #init;
     #urls;
+    #requestCulture;
     constructor(host) {
         super(host);
         this.#urls = new UmbArrayState([], (url) => url.url);
@@ -23,10 +23,25 @@ export class UmbDocumentUrlsDataResolver extends UmbControllerBase {
          * @memberof UmbDocumentUrlsDataResolver
          */
         this.urls = this.#urls.asObservable();
+        this.#requestCulture = new UmbStringState(undefined);
+        /**
+         * The culture to request urls for from the server. Emits whenever the displayed culture changes.
+         * Resolves to undefined for invariant documents (meaning all cultures).
+         * @returns {Observable<string | undefined>} The culture to request urls for
+         * @memberof UmbDocumentUrlsDataResolver
+         */
+        this.requestCulture = this.#requestCulture.asObservable();
         this.#init = Promise.all([
             this.consumeContext(UMB_VARIANT_CONTEXT, async (context) => {
                 this.#variantId = await context?.getVariantId();
-                this.#displayVariantId = await this.observe(context?.displayVariantId)?.asPromise();
+                // Observe the display variant id so the resolver reacts to culture switches, rather than
+                // capturing the culture only once.
+                if (context) {
+                    this.observe(context.displayVariantId, (displayVariantId) => {
+                        this.#displayVariantId = displayVariantId;
+                        this.#setCultureAwareValues();
+                    }, 'observeDisplayVariantId');
+                }
                 this.#setCultureAwareValues();
             }).asPromise(),
         ]);
@@ -61,15 +76,31 @@ export class UmbDocumentUrlsDataResolver extends UmbControllerBase {
         await this.#init;
         return this.#urls.getValue();
     }
+    /**
+     * Gets the culture to request urls for from the server.
+     * Returns the current culture for variant documents, or undefined for invariant documents
+     * (which must return all of their domain urls).
+     * @returns {Promise<string | undefined>} The culture to request, or undefined for all cultures
+     * @memberof UmbDocumentUrlsDataResolver
+     */
+    async getRequestCulture() {
+        await this.#init;
+        return this.#requestCulture.getValue();
+    }
     #setCultureAwareValues() {
         this.#setUrls();
+        // TODO: when the variant context gains a dedicated "request/effective culture" accessor, resolve the
+        // invariant->all-cultures decision through it instead of here.
+        this.#requestCulture.setValue(this.#variantId?.isCultureInvariant() ? undefined : this.#getCurrentCulture());
     }
     #setUrls() {
         const data = this.#getDataForCurrentCulture();
         this.#urls.setValue(data ?? []);
     }
     #getCurrentCulture() {
-        return this.#variantId?.culture || this.#displayVariantId?.culture || this.#appCulture;
+        // Culture resolution (incl. inheritance/fallback) is owned by the variant context; we read its
+        // already-resolved display variant rather than re-deriving it here.
+        return this.#displayVariantId?.culture ?? undefined;
     }
     #getDataForCurrentCulture() {
         // Invariant document: return all URLs. The server tags each URL with the

package/dist-cms/packages/documents/documents/url/info-app/document-links-workspace-info-app.element.js

@@ -12,7 +12,7 @@ import { UmbLitElement } from '../../../../core/lit-element/index.js';
 import { UmbRequestReloadStructureForEntityEvent } from '../../../../core/entity-action/index.js';
 import { UMB_ACTION_EVENT_CONTEXT } from '../../../../core/action/index.js';
 import { observeMultiple } from '../../../../../libs/observable-api/index.js';
-import { DocumentVariantStateModel } from '../../../../core/backend-api/index.js';
+import { UmbDocumentVariantState } from '../../variant-state.js';
 import { debounce } from '../../../../core/utils/index.js';
 import { UMB_PROPERTY_DATASET_CONTEXT } from '../../../../core/property/index.js';
 let UmbDocumentLinksWorkspaceInfoAppElement = class UmbDocumentLinksWorkspaceInfoAppElement extends UmbLitElement {
@@ -37,7 +37,7 @@ let UmbDocumentLinksWorkspaceInfoAppElement = class UmbDocumentLinksWorkspaceInf
                 return;
             if (event.getEntityType() !== this.#documentWorkspaceContext.getEntityType())
                 return;
-            this.#debounceRequestUrls();
+            this.#scheduleRequestUrls();
         };
         this.consumeContext(UMB_ACTION_EVENT_CONTEXT, (context) => {
             this.#eventContext = context;
@@ -53,7 +53,7 @@ let UmbDocumentLinksWorkspaceInfoAppElement = class UmbDocumentLinksWorkspaceInf
                     this._isNew = isNew === true;
                     if (unique !== this._unique) {
                         this._unique = unique;
-                        this.#requestUrls();
+                        this.#scheduleRequestUrls();
                     }
                 }, 'observeWorkspaceState');
             }
@@ -65,6 +65,8 @@ let UmbDocumentLinksWorkspaceInfoAppElement = class UmbDocumentLinksWorkspaceInf
                 this.#setLinks();
             });
         });
+        // Re-request when the displayed culture changes, so switching language fetches that culture.
+        this.observe(this.#documentUrlsDataResolver?.requestCulture, () => this.#scheduleRequestUrls(), 'observeRequestCulture');
         this.consumeContext(UMB_PROPERTY_DATASET_CONTEXT, (context) => {
             this.#propertyDataSetVariantId = context?.getVariantId();
             this.#setLinks();
@@ -95,28 +97,41 @@ let UmbDocumentLinksWorkspaceInfoAppElement = class UmbDocumentLinksWorkspaceInf
         }
         return url;
     }
-    async #requestUrls() {
-        if (this._isNew)
+    // Show the loading indicator immediately (synchronously), before the debounced request runs, so no
+    // stale "no URL" message is shown while the URL is (re)resolved - e.g. on load or when switching culture.
+    #scheduleRequestUrls() {
+        if (this._isNew || !this._unique)
             return;
-        if (!this._unique)
+        this._loading = true;
+        this.#debounceRequestUrls();
+    }
+    async #requestUrls() {
+        if (this._isNew || !this._unique)
             return;
         this._loading = true;
         this.#documentUrlsDataResolver?.setData([]);
-        const { data } = await this.#documentUrlRepository.requestItems([this._unique]);
-        if (data?.length) {
-            this.#documentUrlsDataResolver?.setData(data[0].urls);
+        try {
+            // Only request the culture currently being displayed for variant documents. Invariant documents
+            // return all of their domain urls, so no culture is passed (getRequestCulture resolves undefined).
+            const culture = await this.#documentUrlsDataResolver?.getRequestCulture();
+            const { data } = await this.#documentUrlRepository.requestUrls([this._unique], culture);
+            if (data?.length) {
+                this.#documentUrlsDataResolver?.setData(data[0].urls);
+            }
+        }
+        finally {
+            this._loading = false;
         }
-        this._loading = false;
     }
     #getStateLocalizationKey(state) {
         switch (state) {
             case null:
             case undefined:
-            case DocumentVariantStateModel.NOT_CREATED:
+            case UmbDocumentVariantState.NOT_CREATED:
                 return 'content_notCreated';
-            case DocumentVariantStateModel.DRAFT:
+            case UmbDocumentVariantState.DRAFT:
                 return 'content_itemNotPublished';
-            case DocumentVariantStateModel.PUBLISHED:
+            case UmbDocumentVariantState.PUBLISHED:
                 return 'content_routeErrorCannotRoute';
             default:
                 return 'content_parentNotPublishedAnomaly';

package/dist-cms/packages/documents/documents/url/repository/document-url.repository.d.ts

@@ -2,6 +2,19 @@ import type { UmbDocumentUrlsModel } from './types.js';
 import { UmbItemRepositoryBase } from '../../../../core/repository/index.js';
 import type { UmbControllerHost } from '../../../../../libs/controller-api/index.js';
 export declare class UmbDocumentUrlRepository extends UmbItemRepositoryBase<UmbDocumentUrlsModel> {
+    #private;
     constructor(host: UmbControllerHost);
+    /**
+     * Requests the urls for the given uniques, optionally restricted to a single culture.
+     * @param {Array<string>} uniques The document uniques to request urls for.
+     * @param {string} [culture] The culture to restrict variant document urls to, or undefined for all cultures.
+     * @returns {*} The requested url data.
+     * @memberof UmbDocumentUrlRepository
+     */
+    requestUrls(uniques: Array<string>, culture?: string): Promise<{
+        data: UmbDocumentUrlsModel[] | undefined;
+        error: Error | import("../../../../core/resources/index.js").UmbError | import("../../../../core/resources/index.js").UmbCancelError | import("../../../../core/resources/index.js").UmbApiError | undefined;
+        asObservable: () => import("rxjs").Observable<UmbDocumentUrlsModel[]> | undefined;
+    }>;
 }
 export { UmbDocumentUrlRepository as api };

package/dist-cms/packages/documents/documents/url/repository/document-url.repository.js

@@ -2,8 +2,30 @@ import { UMB_DOCUMENT_URL_STORE_CONTEXT } from './document-url.store.context-tok
 import { UmbDocumentUrlServerDataSource } from './document-url.server.data-source.js';
 import { UmbItemRepositoryBase } from '../../../../core/repository/index.js';
 export class UmbDocumentUrlRepository extends UmbItemRepositoryBase {
+    // The culture-aware request needs its own data source instance: `UmbItemRepositoryBase` keeps its
+    // data source private and the inherited `requestItems` signature cannot carry a culture. Extending
+    // the item base keeps this consistent with `UmbMediaUrlRepository`; `requestUrls` otherwise mirrors
+    // the base flow, including store population.
+    #urlSource = new UmbDocumentUrlServerDataSource(this);
     constructor(host) {
         super(host, UmbDocumentUrlServerDataSource, UMB_DOCUMENT_URL_STORE_CONTEXT);
     }
+    /**
+     * Requests the urls for the given uniques, optionally restricted to a single culture.
+     * @param {Array<string>} uniques The document uniques to request urls for.
+     * @param {string} [culture] The culture to restrict variant document urls to, or undefined for all cultures.
+     * @returns {*} The requested url data.
+     * @memberof UmbDocumentUrlRepository
+     */
+    async requestUrls(uniques, culture) {
+        if (!uniques)
+            throw new Error('Uniques are missing');
+        await this._init;
+        const { data, error } = await this.#urlSource.getItems(uniques, culture);
+        if (data) {
+            this._itemStore?.appendItems(data);
+        }
+        return { data, error, asObservable: () => this._itemStore?.items(uniques) };
+    }
 }
 export { UmbDocumentUrlRepository as api };

package/dist-cms/packages/documents/documents/url/repository/document-url.server.data-source.d.ts

@@ -14,7 +14,7 @@ export declare class UmbDocumentUrlServerDataSource extends UmbItemServerDataSou
      * @memberof UmbDocumentUrlServerDataSource
      */
     constructor(host: UmbControllerHost);
-    getItems(uniques: Array<string>): Promise<{
+    getItems(uniques: Array<string>, culture?: string): Promise<{
         data: UmbDocumentUrlsModel[] | undefined;
         error: Error | import("../../../../core/resources/index.js").UmbError | import("../../../../core/resources/index.js").UmbCancelError | import("../../../../core/resources/index.js").UmbApiError | undefined;
     }>;

package/dist-cms/packages/documents/documents/url/repository/document-url.server.data-source.js

@@ -15,12 +15,12 @@ export class UmbDocumentUrlServerDataSource extends UmbItemServerDataSourceBase
     constructor(host) {
         super(host, { mapper });
     }
-    async getItems(uniques) {
+    async getItems(uniques, culture) {
         if (!uniques)
             throw new Error('Uniques are missing');
         const itemRequestManager = new UmbItemDataApiGetRequestController(this, {
             // eslint-disable-next-line local-rules/no-direct-api-import
-            api: (args) => DocumentService.getDocumentUrls({ query: { id: args.uniques } }),
+            api: (args) => DocumentService.getDocumentUrls({ query: { id: args.uniques, culture } }),
             uniques,
         });
         const { data, error } = await itemRequestManager.request();

package/dist-cms/packages/documents/documents/user-permissions/document/conditions/document-user-permission.condition.js

@@ -6,15 +6,21 @@ import { UmbConditionBase } from '../../../../../core/extension-registry/index.j
 export class UmbDocumentUserPermissionCondition extends UmbConditionBase {
     #entityType;
     #unique;
+    #hasUser;
     #documentPermissions = [];
     #fallbackPermissions = [];
     #ancestors = [];
+    #documentStartNodeUniques = [];
+    #hasDocumentRootAccess = false;
     constructor(host, args) {
         super(host, args);
         this.consumeContext(UMB_CURRENT_USER_CONTEXT, (context) => {
             this.observe(context?.currentUser, (currentUser) => {
+                this.#hasUser = currentUser !== undefined;
                 this.#documentPermissions = currentUser?.permissions?.filter(isDocumentUserPermission) || [];
                 this.#fallbackPermissions = currentUser?.fallbackPermissions || [];
+                this.#documentStartNodeUniques = currentUser?.documentStartNodeUniques?.map((x) => x.unique) ?? [];
+                this.#hasDocumentRootAccess = currentUser?.hasDocumentRootAccess ?? false;
                 this.#checkPermissions();
             }, 'umbUserPermissionConditionObserver');
         });
@@ -41,6 +47,17 @@ export class UmbDocumentUserPermissionCondition extends UmbConditionBase {
             return;
         if (this.#unique === undefined)
             return;
+        if (!this.#hasUser) {
+            this.permitted = false;
+            return;
+        }
+        // Path based on all ancestors and the current document:
+        const path = [...this.#ancestors, this.#unique].filter((unique) => unique !== null);
+        // Check if the user has 'start-node' access to this document:
+        if (this.config.ignorerUserStartNodes !== true && !this.#hasStartNodeAccess(path)) {
+            this.permitted = false;
+            return;
+        }
         const hasDocumentPermissions = this.#documentPermissions.length > 0;
         // if there is no permissions for any documents we use the fallback permissions
         if (!hasDocumentPermissions) {
@@ -50,8 +67,6 @@ export class UmbDocumentUserPermissionCondition extends UmbConditionBase {
         // If there are document permissions, we need to check the full path to see if any permissions are defined for the current document
         // If we find multiple permissions in the same path, we will apply the closest one
         if (hasDocumentPermissions) {
-            // Path including the current document and all ancestors
-            const path = [...this.#ancestors, this.#unique].filter((unique) => unique !== null);
             // Reverse the path to find the closest document permission quickly
             const reversedPath = [...path].reverse();
             const documentPermissionsMap = new Map(this.#documentPermissions.map((p) => [p.document.id, p]));
@@ -68,6 +83,13 @@ export class UmbDocumentUserPermissionCondition extends UmbConditionBase {
             this.#check(match.verbs);
         }
     }
+    #hasStartNodeAccess(path) {
+        if (this.#hasDocumentRootAccess)
+            return true;
+        if (this.#documentStartNodeUniques.length === 0)
+            return false;
+        return path.some((unique) => this.#documentStartNodeUniques.includes(unique));
+    }
     #check(verbs) {
         /* we default to true se we don't require both allOf and oneOf to be defined
          but they can be combined for more complex scenarios */

package/dist-cms/packages/documents/documents/user-permissions/document/conditions/types.d.ts

@@ -12,6 +12,12 @@ export type UmbDocumentUserPermissionConditionConfig = UmbConditionConfigBase<'U
      * ["Umb.Document.Save", "Umb.Document.Publish"]
      */
     oneOf?: Array<string>;
+    /**
+     * If true, the condition will ignorer the user start-node check and only check the permissions.
+     * Use this carefully, as this will permit access for Documents that are outside the user's start-node scope.
+     * @default false
+     */
+    ignorerUserStartNodes?: boolean;
 };
 declare global {
     interface UmbExtensionConditionConfigMap {

package/dist-cms/packages/documents/documents/user-permissions/document/input-document-granular-user-permission/input-document-granular-user-permission.element.d.ts

@@ -1,6 +1,6 @@
 import type { UmbDocumentUserPermissionModel } from '../types.js';
 import { UmbLitElement } from '../../../../../core/lit-element/index.js';
-declare const UmbInputDocumentGranularUserPermissionElement_base: (new (...args: any[]) => import("@umbraco-ui/uui-base").UUIFormControlMixinElement<FormData | FormDataEntryValue>) & typeof UmbLitElement;
+declare const UmbInputDocumentGranularUserPermissionElement_base: (new (...args: any[]) => import("@umbraco-ui/uui").UUIFormControlWithBasicsMixinElement<FormData | FormDataEntryValue>) & typeof UmbLitElement;
 export declare class UmbInputDocumentGranularUserPermissionElement extends UmbInputDocumentGranularUserPermissionElement_base {
     #private;
     get permissions(): Array<UmbDocumentUserPermissionModel>;

package/dist-cms/packages/documents/documents/user-permissions/document-property-value/input-document-property-value-user-permission/input-document-property-value-user-permission.element.d.ts

@@ -1,6 +1,6 @@
 import type { UmbDocumentPropertyValueUserPermissionModel as UmbDocumentPropertyValueUserPermissionModel } from '../types.js';
 import { UmbLitElement } from '../../../../../core/lit-element/index.js';
-declare const UmbInputDocumentPropertyValueUserPermissionElement_base: (new (...args: any[]) => import("@umbraco-ui/uui-base").UUIFormControlMixinElement<FormData | FormDataEntryValue>) & typeof UmbLitElement;
+declare const UmbInputDocumentPropertyValueUserPermissionElement_base: (new (...args: any[]) => import("@umbraco-ui/uui").UUIFormControlWithBasicsMixinElement<FormData | FormDataEntryValue>) & typeof UmbLitElement;
 export declare class UmbInputDocumentPropertyValueUserPermissionElement extends UmbInputDocumentPropertyValueUserPermissionElement_base {
     #private;
     get permissions(): Array<UmbDocumentPropertyValueUserPermissionModel>;

package/dist-cms/packages/documents/documents/utils.d.ts

@@ -5,6 +5,7 @@ type VariantType = UmbDocumentVariantOptionModel;
  * @param {VariantType} a - First variant to compare
  * @param {VariantType} b - Second variant to compare
  * @returns {number} - Sorting value
+ * @deprecated Deprecated since v17.6. Import `sortVariants` from `@umbraco-cms/backoffice/variant` instead. Scheduled for removal in Umbraco 19. [LK]
  */
 export declare function sortVariants(a: VariantType, b: VariantType): number;
 export {};

package/dist-cms/packages/documents/documents/utils.js

@@ -1,54 +1,18 @@
-import { DocumentVariantStateModel } from '../../core/backend-api/index.js';
-const variantStatesOrder = {
-    [DocumentVariantStateModel.PUBLISHED_PENDING_CHANGES]: 1,
-    [DocumentVariantStateModel.PUBLISHED]: 1,
-    [DocumentVariantStateModel.DRAFT]: 2,
-    [DocumentVariantStateModel.NOT_CREATED]: 3,
-    [DocumentVariantStateModel.TRASHED]: 4,
-};
-const getVariantStateOrderValue = (variant) => {
-    const fallbackOrder = 99;
-    if (!variant || !variant.state) {
-        return fallbackOrder;
-    }
-    return variantStatesOrder[variant.state] || fallbackOrder;
-};
-// eslint-disable-next-line jsdoc/require-jsdoc
-function compareDefault(a, b) {
-    return (a.language?.isDefault ? -1 : 1) - (b.language?.isDefault ? -1 : 1);
-}
-// Make sure mandatory variants goes on top, unless they are published, cause then they already goes to the top and then we want to mix them with other published variants.
-// eslint-disable-next-line jsdoc/require-jsdoc
-function compareMandatory(a, b) {
-    return a.variant?.state === DocumentVariantStateModel.PUBLISHED_PENDING_CHANGES ||
-        a.variant?.state === DocumentVariantStateModel.PUBLISHED
-        ? 0
-        : (a.language?.isMandatory ? -1 : 1) - (b.language?.isMandatory ? -1 : 1);
-}
-// eslint-disable-next-line jsdoc/require-jsdoc
-function compareState(a, b) {
-    return getVariantStateOrderValue(a.variant) - getVariantStateOrderValue(b.variant);
-}
-// eslint-disable-next-line jsdoc/require-jsdoc
-function compareName(a, b) {
-    const nameA = a.language?.name;
-    const nameB = b.language?.name;
-    // If both names are missing, consider them equal.
-    if (!nameA && !nameB)
-        return 0;
-    // If only one name is missing, sort the defined name first.
-    if (!nameA)
-        return 1;
-    if (!nameB)
-        return -1;
-    return nameA.localeCompare(nameB);
-}
+import { sortVariants as _sortVariants } from '../../core/variant/index.js';
+import { UmbDeprecation } from '../../core/utils/index.js';
+const _deprecation = new UmbDeprecation({
+    deprecated: 'sortVariants from @umbraco-cms/backoffice/documents',
+    removeInVersion: '19.0.0',
+    solution: 'Import `sortVariants` from `@umbraco-cms/backoffice/variant` instead.',
+});
 /**
  * Sorts document variants based on multiple criteria:
  * @param {VariantType} a - First variant to compare
  * @param {VariantType} b - Second variant to compare
  * @returns {number} - Sorting value
+ * @deprecated Deprecated since v17.6. Import `sortVariants` from `@umbraco-cms/backoffice/variant` instead. Scheduled for removal in Umbraco 19. [LK]
  */
 export function sortVariants(a, b) {
-    return compareDefault(a, b) || compareMandatory(a, b) || compareState(a, b) || compareName(a, b);
+    _deprecation.warn();
+    return _sortVariants(a, b);
 }

package/dist-cms/packages/documents/documents/variant-state.d.ts

@@ -0,0 +1 @@
+export { UmbPublishableVariantState as UmbDocumentVariantState } from '../../core/variant/index.js';

package/dist-cms/packages/documents/documents/variant-state.js

@@ -0,0 +1 @@
+export { UmbPublishableVariantState as UmbDocumentVariantState } from '../../core/variant/index.js';

package/dist-cms/packages/documents/documents/workspace/context/document-workspace.context.js

@@ -6,26 +6,22 @@ import { UmbDocumentValidationRepository } from '../../repository/validation/ind
 import { UMB_DOCUMENT_CONFIGURATION_CONTEXT } from '../../index.js';
 import { UMB_DOCUMENT_DETAIL_MODEL_VARIANT_SCAFFOLD, UMB_DOCUMENT_WORKSPACE_ALIAS } from '../constants.js';
 import { createExtensionApiByAlias } from '../../../../core/extension-registry/index.js';
-import { umbPeekError } from '../../../../core/notification/index.js';
 import { UmbContentDetailWorkspaceContextBase } from '../../../../content/content/index.js';
 import { UmbDeprecation } from '../../../../core/utils/index.js';
 import { UmbDocumentBlueprintDetailRepository } from '../../../document-blueprints/index.js';
 import { UmbEntityContentTypeEntityContext } from '../../../../content/content-type/index.js';
-import { UMB_DOCUMENT_TYPE_ENTITY_TYPE } from '../../../document-types/index.js';
 import { UmbEntityRestoredFromRecycleBinEvent, UmbEntityTrashedEvent, UmbIsTrashedEntityContext, } from '../../../../core/recycle-bin/index.js';
+import { UmbPreviewController } from '../../../../preview/index.js';
 import { UmbVariantId } from '../../../../core/variant/index.js';
 import { UmbWorkspaceIsNewRedirectController, UmbWorkspaceIsNewRedirectControllerAlias, } from '../../../../core/workspace/index.js';
 import { UMB_ACTION_EVENT_CONTEXT } from '../../../../core/action/index.js';
-import { UmbLocalizationController } from '../../../../../libs/localization-api/index.js';
-import { UmbPreviewRepository } from '../../../../preview/index.js';
+import { UMB_DOCUMENT_TYPE_ENTITY_TYPE } from '../../../document-types/index.js';
 export class UmbDocumentWorkspaceContext extends UmbContentDetailWorkspaceContextBase {
     #isTrashedContext;
     #entityContentTypeContext;
     #documentSegmentRepository;
+    #previewController;
     #actionEventContext;
-    #localize;
-    #previewWindow;
-    #previewWindowDocumentId;
     constructor(host) {
         super(host, {
             entityType: UMB_DOCUMENT_ENTITY_TYPE,
@@ -51,9 +47,7 @@ export class UmbDocumentWorkspaceContext extends UmbContentDetailWorkspaceContex
         this.#isTrashedContext = new UmbIsTrashedEntityContext(this);
         this.#entityContentTypeContext = new UmbEntityContentTypeEntityContext(this);
         this.#documentSegmentRepository = new UmbDocumentSegmentRepository(this);
-        this.#localize = new UmbLocalizationController(this);
-        this.#previewWindow = null;
-        this.#previewWindowDocumentId = null;
+        this.#previewController = new UmbPreviewController(this);
         this.#onRecycleBinEvent = (event) => {
             const unique = this.getUnique();
             const entityType = this.getEntityType();
@@ -257,39 +251,12 @@ export class UmbDocumentWorkspaceContext extends UmbContentDetailWorkspaceContex
             // Perform save
             await this.performCreateOrUpdate(variantIds, saveData);
         }
-        // Check if preview window is still open and showing the same document
-        // If so, just focus it and let SignalR handle the refresh
-        try {
-            if (this.#previewWindow && !this.#previewWindow.closed && this.#previewWindowDocumentId === unique) {
-                this.#previewWindow.focus();
-                return;
-            }
-        }
-        catch {
-            // Window reference is stale, continue to create new preview session
-            this.#previewWindow = null;
-            this.#previewWindowDocumentId = null;
-        }
-        // Preview not open, create new preview session and open window
-        const previewRepository = new UmbPreviewRepository(this);
-        const previewUrlData = await previewRepository.getPreviewUrl(unique, urlProviderAlias, firstVariantId.culture ?? undefined, firstVariantId.segment ?? undefined);
-        if (previewUrlData.url) {
-            // Add cache-busting parameter to ensure the preview tab reloads with the new preview session
-            const previewUrl = new URL(previewUrlData.url, window.document.baseURI);
-            previewUrl.searchParams.set('rnd', Date.now().toString());
-            this.#previewWindow = window.open(previewUrl.toString(), `umbpreview-${unique}`);
-            this.#previewWindowDocumentId = unique;
-            this.#previewWindow?.focus();
-            return;
-        }
-        if (previewUrlData.message) {
-            umbPeekError(this._host, {
-                color: 'danger',
-                headline: this.#localize.term('general_preview'),
-                message: previewUrlData.message,
-            });
-            throw new Error(previewUrlData.message);
-        }
+        await this.#previewController.preview({
+            unique,
+            urlProviderAlias,
+            culture: firstVariantId.culture,
+            segment: firstVariantId.segment,
+        });
     }
     createPropertyDatasetContext(host, variantId) {
         return new UmbDocumentPropertyDatasetContext(host, this, variantId);