Add culture awareness to the backoffice search APIs (#19322)

* Added culture parameter to search APIs and propagated it to the indexed entity search service

* Variant Culture aware search in Document and Media Pickers (#19336)

* generate types

* enable selection of entity-item-ref elements

* Update input-document.element.ts

* add culture to document search args

* pass culture param to search end point

* get variant context in document picker

* add variant context

* set culture in variant context when changing app language

* set variant context when swithing variant in a workspace

* Update content-detail-workspace-base.ts

* clean up

* remove from split view manager

* Update property-dataset-base-context.ts

* change name to fallbackCulture

* simplify

* get context instead of consuming

* make all methods async

* implement for media

* Update current-user-action.extension.ts

* allow null until we reach the server

* remove log

---------

Co-authored-by: Niels Lyngsø <[email protected]>

* remove console.log

* add display culture

* opt-in inheritance

* set observe alias to observeAppCulture

* stop inheritance if specific cultures are set

* remove unused import

* include culture for document and media global search

* await value for get methods

* include orderCulture for document collections

* Update document-collection.context.ts

* Update document-collection.context.ts

* fix self import

---------

Co-authored-by: Niels Lyngsø <[email protected]>
Co-authored-by: Mads Rasmussen <[email protected]>

Author: 3 people

src/Umbraco.Cms.Api.Management/Controllers/Document/Item/SearchDocumentItemController.cs

@@ -28,12 +28,13 @@ public async Task<IActionResult> SearchWithTrashed(
         CancellationToken cancellationToken,
         string query,
         bool? trashed = null,
+        string? culture = null,
         int skip = 0,
         int take = 100,
         Guid? parentId = null,
         [FromQuery] IEnumerable<Guid>? allowedDocumentTypes = null)
     {
-        PagedModel<IEntitySlim> searchResult = await _indexedEntitySearchService.SearchAsync(UmbracoObjectTypes.Document, query, parentId, allowedDocumentTypes, trashed, skip, take);
+        PagedModel<IEntitySlim> searchResult = await _indexedEntitySearchService.SearchAsync(UmbracoObjectTypes.Document, query, parentId, allowedDocumentTypes, trashed, culture, skip, take);
         var result = new PagedModel<DocumentItemResponseModel>
         {
             Items = searchResult.Items.OfType<IDocumentEntitySlim>().Select(_documentPresentationFactory.CreateItemResponseModel),

src/Umbraco.Cms.Api.Management/Controllers/Media/Item/SearchMediaItemController.cs

@@ -21,17 +21,20 @@ public SearchMediaItemController(IIndexedEntitySearchService indexedEntitySearch
         _mediaPresentationFactory = mediaPresentationFactory;
     }
 
-    [NonAction]
-    [Obsolete("Scheduled to be removed in v16, use the non obsoleted method instead")]
-    public Task<IActionResult> SearchFromParentWithAllowedTypes(CancellationToken cancellationToken, string query, int skip = 0, int take = 100, Guid? parentId = null, [FromQuery]IEnumerable<Guid>? allowedMediaTypes = null)
-        => SearchFromParentWithAllowedTypes(cancellationToken, query, null, skip, take, parentId);
-
     [HttpGet("search")]
     [MapToApiVersion("1.0")]
     [ProducesResponseType(typeof(PagedModel<MediaItemResponseModel>), StatusCodes.Status200OK)]
-    public async Task<IActionResult> SearchFromParentWithAllowedTypes(CancellationToken cancellationToken, string query, bool? trashed = null, int skip = 0, int take = 100, Guid? parentId = null, [FromQuery]IEnumerable<Guid>? allowedMediaTypes = null)
+    public async Task<IActionResult> SearchFromParentWithAllowedTypes(
+        CancellationToken cancellationToken,
+        string query,
+        bool? trashed = null,
+        string? culture = null,
+        int skip = 0,
+        int take = 100,
+        Guid? parentId = null,
+        [FromQuery]IEnumerable<Guid>? allowedMediaTypes = null)
     {
-        PagedModel<IEntitySlim> searchResult = await _indexedEntitySearchService.SearchAsync(UmbracoObjectTypes.Media, query, parentId, allowedMediaTypes, trashed, skip, take);
+        PagedModel<IEntitySlim> searchResult = await _indexedEntitySearchService.SearchAsync(UmbracoObjectTypes.Media, query, parentId, allowedMediaTypes, trashed, culture, skip, take);
         var result = new PagedModel<MediaItemResponseModel>
         {
             Items = searchResult.Items.OfType<IMediaEntitySlim>().Select(_mediaPresentationFactory.CreateItemResponseModel),

src/Umbraco.Cms.Api.Management/OpenApi.json

@@ -10159,6 +10159,13 @@
               "type": "boolean"
             }
           },
+          {
+            "name": "culture",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            }
+          },
           {
             "name": "skip",
             "in": "query",
@@ -15918,6 +15925,13 @@
               "type": "boolean"
             }
           },
+          {
+            "name": "culture",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            }
+          },
           {
             "name": "skip",
             "in": "query",

src/Umbraco.Core/Services/IIndexedEntitySearchService.cs

@@ -35,14 +35,15 @@ PagedModel<IEntitySlim> Search(
         int skip = 0,
         int take = 100,
         bool ignoreUserStartNodes = false)
-        => Search(objectType,query, skip, take, ignoreUserStartNodes);
+        => Search(objectType, query, skip, take, ignoreUserStartNodes);
 
     Task<PagedModel<IEntitySlim>> SearchAsync(
         UmbracoObjectTypes objectType,
         string query,
         Guid? parentId,
         IEnumerable<Guid>? contentTypeIds,
         bool? trashed,
+        string? culture = null,
         int skip = 0,
         int take = 100,
         bool ignoreUserStartNodes = false);

src/Umbraco.Infrastructure/Services/Implement/IndexedEntitySearchService.cs

@@ -73,14 +73,15 @@ public PagedModel<IEntitySlim> Search(
         int skip = 0,
         int take = 100,
         bool ignoreUserStartNodes = false)
-        => SearchAsync(objectType, query, parentId, contentTypeIds, trashed, skip, take, ignoreUserStartNodes).GetAwaiter().GetResult();
+        => SearchAsync(objectType, query, parentId, contentTypeIds, trashed, null, skip, take, ignoreUserStartNodes).GetAwaiter().GetResult();
 
     public Task<PagedModel<IEntitySlim>> SearchAsync(
         UmbracoObjectTypes objectType,
         string query,
         Guid? parentId,
         IEnumerable<Guid>? contentTypeIds,
         bool? trashed,
+        string? culture = null,
         int skip = 0,
         int take = 100,
         bool ignoreUserStartNodes = false)

src/Umbraco.Web.UI.Client/src/packages/content/content/property-dataset-context/element-property-dataset.context.ts

@@ -47,7 +47,7 @@ export abstract class UmbElementPropertyDatasetContext<
 	protected _readOnly = new UmbBooleanState(false);
 	public readOnly = this._readOnly.asObservable();
 
-	#variantContext = new UmbVariantContext(this);
+	#variantContext = new UmbVariantContext(this).inherit();
 
 	getEntityType(): string {
 		return this._dataOwner.getEntityType();

src/Umbraco.Web.UI.Client/src/packages/core/backend-api/types.gen.ts

@@ -6700,6 +6700,7 @@ export type GetItemDocumentSearchData = {
     query?: {
         query?: string;
         trashed?: boolean;
+        culture?: string;
         skip?: number;
         take?: number;
         parentId?: string;
@@ -8991,6 +8992,7 @@ export type GetItemMediaSearchData = {
     query?: {
         query?: string;
         trashed?: boolean;
+        culture?: string;
         skip?: number;
         take?: number;
         parentId?: string;

src/Umbraco.Web.UI.Client/src/packages/core/collection/default/collection-default.context.ts

@@ -283,6 +283,10 @@ export class UmbDefaultCollectionContext<
 		this.requestCollection();
 	}
 
+	public updateFilter(filter: Partial<FilterModelType>) {
+		this._filter.setValue({ ...this._filter.getValue(), ...filter });
+	}
+
 	public getLastSelectedView(unique: string | undefined): string | undefined {
 		if (!unique) return;
 

src/Umbraco.Web.UI.Client/src/packages/core/entity-item/entity-item-ref/entity-item-ref.element.ts

@@ -8,6 +8,7 @@ import { UmbRoutePathAddendumContext } from '@umbraco-cms/backoffice/router';
 import type { UmbEntityModel } from '@umbraco-cms/backoffice/entity';
 
 import './default-item-ref.element.js';
+import { UmbDeselectedEvent, UmbSelectedEvent } from '@umbraco-cms/backoffice/event';
 
 @customElement('umb-entity-item-ref')
 export class UmbEntityItemRefElement extends UmbLitElement {
@@ -41,7 +42,7 @@ export class UmbEntityItemRefElement extends UmbLitElement {
 	}
 
 	#readonly = false;
-	@property({ type: Boolean, attribute: 'readonly' })
+	@property({ type: Boolean, reflect: true })
 	public get readonly() {
 		return this.#readonly;
 	}
@@ -54,7 +55,7 @@ export class UmbEntityItemRefElement extends UmbLitElement {
 	}
 
 	#standalone = false;
-	@property({ type: Boolean, attribute: 'standalone' })
+	@property({ type: Boolean, reflect: true })
 	public get standalone() {
 		return this.#standalone;
 	}
@@ -66,8 +67,74 @@ export class UmbEntityItemRefElement extends UmbLitElement {
 		}
 	}
 
+	#selectOnly = false;
+	@property({ type: Boolean, attribute: 'select-only', reflect: true })
+	public get selectOnly() {
+		return this.#selectOnly;
+	}
+	public set selectOnly(value) {
+		this.#selectOnly = value;
+
+		if (this._component) {
+			this._component.selectOnly = this.#selectOnly;
+		}
+	}
+
+	#selectable = false;
+	@property({ type: Boolean, reflect: true })
+	public get selectable() {
+		return this.#selectable;
+	}
+	public set selectable(value) {
+		this.#selectable = value;
+
+		if (this._component) {
+			this._component.selectable = this.#selectable;
+		}
+	}
+
+	#selected = false;
+	@property({ type: Boolean, reflect: true })
+	public get selected() {
+		return this.#selected;
+	}
+	public set selected(value) {
+		this.#selected = value;
+
+		if (this._component) {
+			this._component.selected = this.#selected;
+		}
+	}
+
+	#disabled = false;
+	@property({ type: Boolean, reflect: true })
+	public get disabled() {
+		return this.#disabled;
+	}
+	public set disabled(value) {
+		this.#disabled = value;
+
+		if (this._component) {
+			this._component.disabled = this.#disabled;
+		}
+	}
+
 	#pathAddendum = new UmbRoutePathAddendumContext(this);
 
+	#onSelected(event: UmbSelectedEvent) {
+		event.stopPropagation();
+		const unique = this.#item?.unique;
+		if (!unique) throw new Error('No unique id found for item');
+		this.dispatchEvent(new UmbSelectedEvent(unique));
+	}
+
+	#onDeselected(event: UmbDeselectedEvent) {
+		event.stopPropagation();
+		const unique = this.#item?.unique;
+		if (!unique) throw new Error('No unique id found for item');
+		this.dispatchEvent(new UmbDeselectedEvent(unique));
+	}
+
 	protected override firstUpdated(_changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>): void {
 		super.firstUpdated(_changedProperties);
 		this.setAttribute(UMB_MARK_ATTRIBUTE_NAME, 'entity-item-ref');
@@ -91,6 +158,13 @@ export class UmbEntityItemRefElement extends UmbLitElement {
 				component.item = this.#item;
 				component.readonly = this.readonly;
 				component.standalone = this.standalone;
+				component.selectOnly = this.selectOnly;
+				component.selectable = this.selectable;
+				component.selected = this.selected;
+				component.disabled = this.disabled;
+
+				component.addEventListener(UmbSelectedEvent.TYPE, this.#onSelected.bind(this));
+				component.addEventListener(UmbDeselectedEvent.TYPE, this.#onDeselected.bind(this));
 
 				// Proxy the actions slot to the component
 				const slotElement = document.createElement('slot');
@@ -110,6 +184,12 @@ export class UmbEntityItemRefElement extends UmbLitElement {
 		return html`${this._component}`;
 	}
 
+	override destroy(): void {
+		this._component?.removeEventListener(UmbSelectedEvent.TYPE, this.#onSelected.bind(this));
+		this._component?.removeEventListener(UmbDeselectedEvent.TYPE, this.#onDeselected.bind(this));
+		super.destroy();
+	}
+
 	static override styles = [
 		css`
 			:host {

src/Umbraco.Web.UI.Client/src/packages/core/picker/search/picker-search-result.element.ts

@@ -68,7 +68,6 @@ export class UmbPickerSearchResultElement extends UmbLitElement {
 	}
 
 	#renderResultItem(item: UmbEntityModel) {
-		console.log('pickableFilter', this.pickableFilter(item));
 		return html`
 			<umb-extension-with-api-slot
 				type="pickerSearchResultItem"