Feature: add client runtime cache for all item endpoints

src/Umbraco.Web.UI.Client/src/packages/data-type/entry-point.ts

@@ -1,12 +1,16 @@
 import { UmbManagementApiDataTypeDetailDataCacheInvalidationManager } from './repository/detail/server-data-source/data-type-detail.server.cache-invalidation.manager.js';
+import { UmbManagementApiDataTypeItemDataCacheInvalidationManager } from './repository/item/data-type-item.server.cache-invalidation.manager.js';
 import type { UmbEntryPointOnInit, UmbEntryPointOnUnload } from '@umbraco-cms/backoffice/extension-api';
 
 let detailDataCacheInvalidationManager: UmbManagementApiDataTypeDetailDataCacheInvalidationManager | undefined;
+let itemDataCacheInvalidationManager: UmbManagementApiDataTypeItemDataCacheInvalidationManager | undefined;
 
 export const onInit: UmbEntryPointOnInit = (host) => {
 	detailDataCacheInvalidationManager = new UmbManagementApiDataTypeDetailDataCacheInvalidationManager(host);
+	itemDataCacheInvalidationManager = new UmbManagementApiDataTypeItemDataCacheInvalidationManager(host);
 };
 
 export const onUnload: UmbEntryPointOnUnload = () => {
 	detailDataCacheInvalidationManager?.destroy();
+	itemDataCacheInvalidationManager?.destroy();
 };

src/Umbraco.Web.UI.Client/src/packages/data-type/repository/item/data-type-item.server.cache-invalidation.manager.ts

@@ -0,0 +1,13 @@
+import { dataTypeItemCache } from './data-type-item.server.cache.js';
+import { UmbManagementApiItemDataCacheInvalidationManager } from '@umbraco-cms/backoffice/management-api';
+import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import type { DataTypeItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
+
+export class UmbManagementApiDataTypeItemDataCacheInvalidationManager extends UmbManagementApiItemDataCacheInvalidationManager<DataTypeItemResponseModel> {
+	constructor(host: UmbControllerHost) {
+		super(host, {
+			dataCache: dataTypeItemCache,
+			eventSources: ['Umbraco:CMS:DataType'],
+		});
+	}
+}

src/Umbraco.Web.UI.Client/src/packages/data-type/repository/item/data-type-item.server.cache.ts

@@ -0,0 +1,6 @@
+import type { DataTypeItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
+import { UmbManagementApiItemDataCache } from '@umbraco-cms/backoffice/management-api';
+
+const dataTypeItemCache = new UmbManagementApiItemDataCache<DataTypeItemResponseModel>();
+
+export { dataTypeItemCache };

src/Umbraco.Web.UI.Client/src/packages/data-type/repository/item/data-type-item.server.data-source.ts

@@ -1,12 +1,11 @@
 import { UMB_DATA_TYPE_ENTITY_TYPE } from '../../entity.js';
 import type { UmbDataTypeItemModel } from './types.js';
+import { UmbManagementApiDataTypeItemDataRequestManager } from './data-type-item.server.request-manager.js';
 import { UmbItemServerDataSourceBase } from '@umbraco-cms/backoffice/repository';
 import type { DataTypeItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
-import { DataTypeService } from '@umbraco-cms/backoffice/external/backend-api';
 import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
 import { umbExtensionsRegistry } from '@umbraco-cms/backoffice/extension-registry';
 import type { ManifestPropertyEditorUi } from '@umbraco-cms/backoffice/property-editor';
-import { UmbItemDataApiGetRequestController } from '@umbraco-cms/backoffice/entity-item';
 
 let manifestPropertyEditorUis: Array<ManifestPropertyEditorUi> = [];
 
@@ -19,12 +18,13 @@ export class UmbDataTypeItemServerDataSource extends UmbItemServerDataSourceBase
 	DataTypeItemResponseModel,
 	UmbDataTypeItemModel
 > {
+	#itemRequestManager = new UmbManagementApiDataTypeItemDataRequestManager(this);
+
 	/**
 	 * Creates an instance of UmbDataTypeItemServerDataSource.
 	 * @param {UmbControllerHost} host - The controller host for this controller to be appended to
 	 * @memberof UmbDataTypeItemServerDataSource
 	 */
-
 	constructor(host: UmbControllerHost) {
 		super(host, {
 			mapper,
@@ -41,13 +41,7 @@ export class UmbDataTypeItemServerDataSource extends UmbItemServerDataSourceBase
 	override async getItems(uniques: Array<string>) {
 		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) => DataTypeService.getItemDataType({ query: { id: args.uniques } }),
-			uniques,
-		});
-
-		const { data, error } = await itemRequestManager.request();
+		const { data, error } = await this.#itemRequestManager.getItems(uniques);
 
 		return { data: this._getMappedItems(data), error };
 	}

src/Umbraco.Web.UI.Client/src/packages/data-type/repository/item/data-type-item.server.request-manager.ts

@@ -0,0 +1,15 @@
+/* eslint-disable local-rules/no-direct-api-import */
+import { dataTypeItemCache } from './data-type-item.server.cache.js';
+import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import { DataTypeService, type DataTypeItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
+import { UmbManagementApiItemDataRequestManager } from '@umbraco-cms/backoffice/management-api';
+
+export class UmbManagementApiDataTypeItemDataRequestManager extends UmbManagementApiItemDataRequestManager<DataTypeItemResponseModel> {
+	constructor(host: UmbControllerHost) {
+		super(host, {
+			getItems: (ids: Array<string>) => DataTypeService.getItemDataType({ query: { id: ids } }),
+			dataCache: dataTypeItemCache,
+			getUniqueMethod: (item) => item.id,
+		});
+	}
+}

src/Umbraco.Web.UI.Client/src/packages/dictionary/entry-point.ts

@@ -0,0 +1,12 @@
+import { UmbManagementApiDictionaryItemDataCacheInvalidationManager } from './repository/item/dictionary-item.server.cache-invalidation.manager.js';
+import type { UmbEntryPointOnInit, UmbEntryPointOnUnload } from '@umbraco-cms/backoffice/extension-api';
+
+let itemDataCacheInvalidationManager: UmbManagementApiDictionaryItemDataCacheInvalidationManager | undefined;
+
+export const onInit: UmbEntryPointOnInit = (host) => {
+	itemDataCacheInvalidationManager = new UmbManagementApiDictionaryItemDataCacheInvalidationManager(host);
+};
+
+export const onUnload: UmbEntryPointOnUnload = () => {
+	itemDataCacheInvalidationManager?.destroy();
+};

src/Umbraco.Web.UI.Client/src/packages/dictionary/manifests.ts

@@ -16,4 +16,10 @@ export const manifests: Array<UmbExtensionManifest> = [
 	...searchManifests,
 	...treeManifests,
 	...workspaceManifests,
+	{
+		name: 'Dictionary Backoffice Entry Point',
+		alias: 'Umb.EntryPoint.Dictionary',
+		type: 'backofficeEntryPoint',
+		js: () => import('./entry-point.js'),
+	},
 ];

src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/item/dictionary-item.server.cache-invalidation.manager.ts

@@ -0,0 +1,13 @@
+import { dictionaryItemCache } from './dictionary-item.server.cache.js';
+import { UmbManagementApiItemDataCacheInvalidationManager } from '@umbraco-cms/backoffice/management-api';
+import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import type { DictionaryItemItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
+
+export class UmbManagementApiDictionaryItemDataCacheInvalidationManager extends UmbManagementApiItemDataCacheInvalidationManager<DictionaryItemItemResponseModel> {
+	constructor(host: UmbControllerHost) {
+		super(host, {
+			dataCache: dictionaryItemCache,
+			eventSources: ['Umbraco:CMS:DictionaryItem'],
+		});
+	}
+}

src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/item/dictionary-item.server.cache.ts

@@ -0,0 +1,6 @@
+import type { DictionaryItemItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
+import { UmbManagementApiItemDataCache } from '@umbraco-cms/backoffice/management-api';
+
+const dictionaryItemCache = new UmbManagementApiItemDataCache<DictionaryItemItemResponseModel>();
+
+export { dictionaryItemCache };

src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/item/dictionary-item.server.data-source.ts

@@ -1,10 +1,9 @@
 import { UMB_DICTIONARY_ENTITY_TYPE } from '../../entity.js';
 import type { UmbDictionaryItemModel } from './types.js';
+import { UmbManagementApiDictionaryItemDataRequestManager } from './dictionary-item.server.request-manager.js';
 import { UmbItemServerDataSourceBase } from '@umbraco-cms/backoffice/repository';
 import type { DictionaryItemItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
-import { DictionaryService } from '@umbraco-cms/backoffice/external/backend-api';
 import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
-import { UmbItemDataApiGetRequestController } from '@umbraco-cms/backoffice/entity-item';
 
 /**
  * A server data source for Dictionary items
@@ -15,6 +14,8 @@ export class UmbDictionaryItemServerDataSource extends UmbItemServerDataSourceBa
 	DictionaryItemItemResponseModel,
 	UmbDictionaryItemModel
 > {
+	#itemRequestManager = new UmbManagementApiDictionaryItemDataRequestManager(this);
+
 	/**
 	 * Creates an instance of UmbDictionaryItemServerDataSource.
 	 * @param {UmbControllerHost} host - The controller host for this controller to be appended to
@@ -29,13 +30,7 @@ export class UmbDictionaryItemServerDataSource extends UmbItemServerDataSourceBa
 	override async getItems(uniques: Array<string>) {
 		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) => DictionaryService.getItemDictionary({ query: { id: args.uniques } }),
-			uniques,
-		});
-
-		const { data, error } = await itemRequestManager.request();
+		const { data, error } = await this.#itemRequestManager.getItems(uniques);
 
 		return { data: this._getMappedItems(data), error };
 	}

src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/item/dictionary-item.server.request-manager.ts

@@ -0,0 +1,15 @@
+/* eslint-disable local-rules/no-direct-api-import */
+import { dictionaryItemCache } from './dictionary-item.server.cache.js';
+import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import { DictionaryService, type DictionaryItemItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
+import { UmbManagementApiItemDataRequestManager } from '@umbraco-cms/backoffice/management-api';
+
+export class UmbManagementApiDictionaryItemDataRequestManager extends UmbManagementApiItemDataRequestManager<DictionaryItemItemResponseModel> {
+	constructor(host: UmbControllerHost) {
+		super(host, {
+			getItems: (ids: Array<string>) => DictionaryService.getItemDictionary({ query: { id: ids } }),
+			dataCache: dictionaryItemCache,
+			getUniqueMethod: (item) => item.id,
+		});
+	}
+}

src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/entry-point.ts

@@ -0,0 +1,12 @@
+import { UmbManagementApiDocumentBlueprintItemDataCacheInvalidationManager } from './repository/item/document-blueprint-item.server.cache-invalidation.manager.js';
+import type { UmbEntryPointOnInit, UmbEntryPointOnUnload } from '@umbraco-cms/backoffice/extension-api';
+
+let itemDataCacheInvalidationManager: UmbManagementApiDocumentBlueprintItemDataCacheInvalidationManager | undefined;
+
+export const onInit: UmbEntryPointOnInit = (host) => {
+	itemDataCacheInvalidationManager = new UmbManagementApiDocumentBlueprintItemDataCacheInvalidationManager(host);
+};
+
+export const onUnload: UmbEntryPointOnUnload = () => {
+	itemDataCacheInvalidationManager?.destroy();
+};

src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/manifests.ts

@@ -10,4 +10,10 @@ export const manifests: Array<UmbExtensionManifest> = [
 	...repositoryManifests,
 	...treeManifests,
 	...workspaceManifests,
+	{
+		name: 'Document Blueprint Backoffice Entry Point',
+		alias: 'Umb.BackofficeEntryPoint.DocumentBlueprint',
+		type: 'backofficeEntryPoint',
+		js: () => import('./entry-point.js'),
+	},
 ];

src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/repository/item/document-blueprint-item.server.cache-invalidation.manager.ts

@@ -0,0 +1,43 @@
+import { documentBlueprintItemCache } from './document-blueprint-item.server.cache.js';
+import {
+	UmbManagementApiItemDataCacheInvalidationManager,
+	type UmbManagementApiServerEventModel,
+} from '@umbraco-cms/backoffice/management-api';
+import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import type { DocumentBlueprintItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
+
+export class UmbManagementApiDocumentBlueprintItemDataCacheInvalidationManager extends UmbManagementApiItemDataCacheInvalidationManager<DocumentBlueprintItemResponseModel> {
+	constructor(host: UmbControllerHost) {
+		super(host, {
+			dataCache: documentBlueprintItemCache,
+			/* The Document Blueprint item model includes info about the Document Type. 
+			We need to invalidate the cache for both Document and DocumentType events. */
+			eventSources: ['Umbraco:CMS:DocumentBlueprint', 'Umbraco:CMS:DocumentType'],
+		});
+	}
+
+	protected override _onServerEvent(event: UmbManagementApiServerEventModel) {
+		if (event.eventSource === 'Umbraco:CMS:DocumentType') {
+			this.#onDocumentTypeChange(event);
+		} else {
+			this.#onDocumentChange(event);
+		}
+	}
+
+	#onDocumentChange(event: UmbManagementApiServerEventModel) {
+		// Invalidate the specific document
+		const documentId = event.key;
+		this._dataCache.delete(documentId);
+	}
+
+	#onDocumentTypeChange(event: UmbManagementApiServerEventModel) {
+		// Invalidate all documents of the specified Document Type
+		const documentTypeId = event.key;
+		const documentIds = this._dataCache
+			.getAll()
+			.filter((cachedItem) => cachedItem.documentType.id === documentTypeId)
+			.map((item) => item.id);
+
+		documentIds.forEach((id) => this._dataCache.delete(id));
+	}
+}

src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/repository/item/document-blueprint-item.server.cache.ts

@@ -0,0 +1,6 @@
+import type { DocumentBlueprintItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
+import { UmbManagementApiItemDataCache } from '@umbraco-cms/backoffice/management-api';
+
+const documentBlueprintItemCache = new UmbManagementApiItemDataCache<DocumentBlueprintItemResponseModel>();
+
+export { documentBlueprintItemCache };

src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/repository/item/document-blueprint-item.server.data-source.ts

@@ -1,11 +1,11 @@
 import { UMB_DOCUMENT_BLUEPRINT_ENTITY_TYPE } from '../../entity.js';
 import type { UmbDocumentBlueprintItemBaseModel, UmbDocumentBlueprintItemModel } from './types.js';
-import { DocumentBlueprintService, DocumentTypeService } from '@umbraco-cms/backoffice/external/backend-api';
+import { UmbManagementApiDocumentBlueprintItemDataRequestManager } from './document-blueprint-item.server.request-manager.js';
+import { DocumentTypeService } from '@umbraco-cms/backoffice/external/backend-api';
 import { UmbItemServerDataSourceBase } from '@umbraco-cms/backoffice/repository';
 import type { DocumentBlueprintItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
 import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
 import { tryExecute } from '@umbraco-cms/backoffice/resources';
-import { UmbItemDataApiGetRequestController } from '@umbraco-cms/backoffice/entity-item';
 
 /**
  * A data source for Document Blueprint items that fetches data from the server
@@ -16,6 +16,8 @@ export class UmbDocumentBlueprintItemServerDataSource extends UmbItemServerDataS
 	DocumentBlueprintItemResponseModel,
 	UmbDocumentBlueprintItemModel
 > {
+	#itemRequestManager = new UmbManagementApiDocumentBlueprintItemDataRequestManager(this);
+
 	/**
 	 * Creates an instance of UmbDocumentBlueprintItemServerDataSource.
 	 * @param {UmbControllerHost} host - The controller host for this controller to be appended to
@@ -49,13 +51,7 @@ export class UmbDocumentBlueprintItemServerDataSource extends UmbItemServerDataS
 	override async getItems(uniques: Array<string>) {
 		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) => DocumentBlueprintService.getItemDocumentBlueprint({ query: { id: args.uniques } }),
-			uniques,
-		});
-
-		const { data, error } = await itemRequestManager.request();
+		const { data, error } = await this.#itemRequestManager.getItems(uniques);
 
 		return { data: this._getMappedItems(data), error };
 	}

src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/repository/item/document-blueprint-item.server.request-manager.ts

@@ -0,0 +1,18 @@
+/* eslint-disable local-rules/no-direct-api-import */
+import { documentBlueprintItemCache } from './document-blueprint-item.server.cache.js';
+import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import {
+	DocumentBlueprintService,
+	type DocumentBlueprintItemResponseModel,
+} from '@umbraco-cms/backoffice/external/backend-api';
+import { UmbManagementApiItemDataRequestManager } from '@umbraco-cms/backoffice/management-api';
+
+export class UmbManagementApiDocumentBlueprintItemDataRequestManager extends UmbManagementApiItemDataRequestManager<DocumentBlueprintItemResponseModel> {
+	constructor(host: UmbControllerHost) {
+		super(host, {
+			getItems: (ids: Array<string>) => DocumentBlueprintService.getItemDocumentBlueprint({ query: { id: ids } }),
+			dataCache: documentBlueprintItemCache,
+			getUniqueMethod: (item) => item.id,
+		});
+	}
+}

src/Umbraco.Web.UI.Client/src/packages/documents/document-types/entry-point.ts

@@ -1,12 +1,16 @@
 import { UmbManagementApiDocumentTypeDetailDataCacheInvalidationManager } from './repository/detail/server-data-source/document-type-detail.server.cache-invalidation.manager.js';
+import { UmbManagementApiDocumentTypeItemDataCacheInvalidationManager } from './repository/item/document-type-item.server.cache-invalidation.manager.js';
 import type { UmbEntryPointOnInit, UmbEntryPointOnUnload } from '@umbraco-cms/backoffice/extension-api';
 
 let detailDataCacheInvalidationManager: UmbManagementApiDocumentTypeDetailDataCacheInvalidationManager | undefined;
+let itemDataCacheInvalidationManager: UmbManagementApiDocumentTypeItemDataCacheInvalidationManager | undefined;
 
 export const onInit: UmbEntryPointOnInit = (host) => {
 	detailDataCacheInvalidationManager = new UmbManagementApiDocumentTypeDetailDataCacheInvalidationManager(host);
+	itemDataCacheInvalidationManager = new UmbManagementApiDocumentTypeItemDataCacheInvalidationManager(host);
 };
 
 export const onUnload: UmbEntryPointOnUnload = () => {
 	detailDataCacheInvalidationManager?.destroy();
+	itemDataCacheInvalidationManager?.destroy();
 };

src/Umbraco.Web.UI.Client/src/packages/documents/document-types/repository/item/document-type-item.server.cache-invalidation.manager.ts

@@ -0,0 +1,13 @@
+import { documentTypeItemCache } from './document-type-item.server.cache.js';
+import { UmbManagementApiItemDataCacheInvalidationManager } from '@umbraco-cms/backoffice/management-api';
+import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import type { DocumentTypeItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
+
+export class UmbManagementApiDocumentTypeItemDataCacheInvalidationManager extends UmbManagementApiItemDataCacheInvalidationManager<DocumentTypeItemResponseModel> {
+	constructor(host: UmbControllerHost) {
+		super(host, {
+			dataCache: documentTypeItemCache,
+			eventSources: ['Umbraco:CMS:DocumentType'],
+		});
+	}
+}

src/Umbraco.Web.UI.Client/src/packages/documents/document-types/repository/item/document-type-item.server.cache.ts

@@ -0,0 +1,6 @@
+import type { DocumentTypeItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
+import { UmbManagementApiItemDataCache } from '@umbraco-cms/backoffice/management-api';
+
+const documentTypeItemCache = new UmbManagementApiItemDataCache<DocumentTypeItemResponseModel>();
+
+export { documentTypeItemCache };