Feature: Client Cache for Document Item Models

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

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

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

@@ -21,4 +21,10 @@ export const manifests: Array<UmbExtensionManifest | UmbExtensionManifestKind> =
 	...searchProviderManifests,
 	...treeManifests,
 	...workspaceManifests,
+	{
+		name: 'Data Type Backoffice Entry Point',
+		alias: 'Umb.EntryPoint.DataType',
+		type: 'backofficeEntryPoint',
+		js: () => import('./entry-point.js'),
+	},
 ];

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

@@ -0,0 +1,13 @@
+import { dataTypeDetailCache } from './data-type-detail.server.cache.js';
+import { UmbManagementApiDetailDataCacheInvalidationManager } from '@umbraco-cms/backoffice/management-api';
+import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import type { DataTypeResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
+
+export class UmbManagementApiDataTypeDetailDataCacheInvalidationManager extends UmbManagementApiDetailDataCacheInvalidationManager<DataTypeResponseModel> {
+	constructor(host: UmbControllerHost) {
+		super(host, {
+			dataCache: dataTypeDetailCache,
+			serverEventSources: ['Umbraco:CMS:DataType'],
+		});
+	}
+}

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

@@ -21,7 +21,6 @@ export class UmbManagementApiDataTypeDetailDataRequestManager extends UmbManagem
 			update: (id: string, body: UpdateDataTypeRequestModel) => DataTypeService.putDataTypeById({ path: { id }, body }),
 			delete: (id: string) => DataTypeService.deleteDataTypeById({ path: { id } }),
 			dataCache: dataTypeDetailCache,
-			serverEventSource: 'Umbraco:CMS:DataType',
 		});
 	}
 }

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

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

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

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

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

@@ -0,0 +1,13 @@
+import { documentTypeDetailCache } from './document-type-detail.server.cache.js';
+import { UmbManagementApiDetailDataCacheInvalidationManager } from '@umbraco-cms/backoffice/management-api';
+import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import type { DocumentTypeResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
+
+export class UmbManagementApiDocumentTypeDetailDataCacheInvalidationManager extends UmbManagementApiDetailDataCacheInvalidationManager<DocumentTypeResponseModel> {
+	constructor(host: UmbControllerHost) {
+		super(host, {
+			dataCache: documentTypeDetailCache,
+			serverEventSources: ['Umbraco:CMS:DocumentType'],
+		});
+	}
+}

src/Umbraco.Web.UI.Client/src/packages/documents/document-types/repository/detail/server-data-source/document-type-detail.server.request-manager.ts

@@ -22,7 +22,6 @@ export class UmbManagementApiDocumentTypeDetailDataRequestManager extends UmbMan
 				DocumentTypeService.putDocumentTypeById({ path: { id }, body }),
 			delete: (id: string) => DocumentTypeService.deleteDocumentTypeById({ path: { id } }),
 			dataCache: documentTypeDetailCache,
-			serverEventSource: 'Umbraco:CMS:DocumentType',
 		});
 	}
 }

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

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

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

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

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

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

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

@@ -1,10 +1,9 @@
 import { UMB_DOCUMENT_ENTITY_TYPE } from '../../entity.js';
 import type { UmbDocumentItemModel } from './types.js';
+import { UmbManagementApiDocumentItemDataRequestManager } from './document-item.server.request-manager.js';
 import type { DocumentItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
-import { DocumentService } from '@umbraco-cms/backoffice/external/backend-api';
 import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
 import { UmbItemServerDataSourceBase } from '@umbraco-cms/backoffice/repository';
-import { UmbItemDataApiGetRequestController } from '@umbraco-cms/backoffice/entity-item';
 
 /**
  * A data source for Document items that fetches data from the server
@@ -15,6 +14,8 @@ export class UmbDocumentItemServerDataSource extends UmbItemServerDataSourceBase
 	DocumentItemResponseModel,
 	UmbDocumentItemModel
 > {
+	#itemRequestManager = new UmbManagementApiDocumentItemDataRequestManager(this);
+
 	/**
 	 * Creates an instance of UmbDocumentItemServerDataSource.
 	 * @param {UmbControllerHost} host - The controller host for this controller to be appended to
@@ -29,13 +30,7 @@ export class UmbDocumentItemServerDataSource 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) => DocumentService.getItemDocument({ 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/documents/item/repository/document-item.server.request-manager.ts

@@ -0,0 +1,15 @@
+/* eslint-disable local-rules/no-direct-api-import */
+import { documentItemCache } from './document-item.server.cache.js';
+import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import { DocumentService, type DocumentItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
+import { UmbManagementApiItemDataRequestManager } from '@umbraco-cms/backoffice/management-api';
+
+export class UmbManagementApiDocumentItemDataRequestManager extends UmbManagementApiItemDataRequestManager<DocumentItemResponseModel> {
+	constructor(host: UmbControllerHost) {
+		super(host, {
+			getItems: (ids: Array<string>) => DocumentService.getItemDocument({ query: { id: ids } }),
+			dataCache: documentItemCache,
+			serverEventSource: 'Umbraco:CMS:Document',
+		});
+	}
+}

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

@@ -42,4 +42,10 @@ export const manifests: Array<UmbExtensionManifest | UmbExtensionManifestKind> =
 	...urlManifests,
 	...userPermissionManifests,
 	...workspaceManifests,
+	{
+		name: 'Document Backoffice Entry Point',
+		alias: 'Umb.BackofficeEntryPoint.Document',
+		type: 'backofficeEntryPoint',
+		js: () => import('./entry-point.js'),
+	},
 ];

src/Umbraco.Web.UI.Client/src/packages/management-api/detail/cache-invalidation.manager.ts

@@ -0,0 +1,46 @@
+import { UMB_MANAGEMENT_API_SERVER_EVENT_CONTEXT } from '../server-event/constants.js';
+import type { UmbManagementApiDetailDataCache } from './cache.js';
+import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import { UmbControllerBase } from '@umbraco-cms/backoffice/class-api';
+
+export interface UmbManagementApiDetailDataInvalidationManagerArgs<DetailResponseModelType> {
+	dataCache: UmbManagementApiDetailDataCache<DetailResponseModelType>;
+	serverEventSources: Array<string>;
+}
+
+export class UmbManagementApiDetailDataCacheInvalidationManager<DetailResponseModelType> extends UmbControllerBase {
+	#dataCache: UmbManagementApiDetailDataCache<DetailResponseModelType>;
+	#serverEventSources: Array<string>;
+	#serverEventContext?: typeof UMB_MANAGEMENT_API_SERVER_EVENT_CONTEXT.TYPE;
+
+	constructor(
+		host: UmbControllerHost,
+		args: UmbManagementApiDetailDataInvalidationManagerArgs<DetailResponseModelType>,
+	) {
+		super(host);
+		{
+			this.#dataCache = args.dataCache;
+			this.#serverEventSources = args.serverEventSources;
+
+			this.consumeContext(UMB_MANAGEMENT_API_SERVER_EVENT_CONTEXT, (context) => {
+				this.#serverEventContext = context;
+				this.#observeServerEvents();
+			});
+		}
+	}
+
+	#observeServerEvents() {
+		this.observe(
+			this.#serverEventContext?.byEventSourcesAndTypes(this.#serverEventSources, ['Updated', 'Deleted']),
+			(event) => {
+				if (!event) return;
+				this.#dataCache.delete(event.key);
+			},
+			'umbObserveServerEvents',
+		);
+	}
+
+	override destroy(): void {
+		this.#dataCache.clear();
+	}
+}

src/Umbraco.Web.UI.Client/src/packages/management-api/detail/detail-data.request-manager.ts

@@ -20,7 +20,6 @@ export interface UmbManagementApiDetailDataRequestManagerArgs<
 	update: (id: string, data: UpdateRequestModelType) => Promise<UmbApiResponse<{ data: unknown }>>;
 	delete: (id: string) => Promise<UmbApiResponse<{ data: unknown }>>;
 	dataCache: UmbManagementApiDetailDataCache<DetailResponseModelType>;
-	serverEventSource: string;
 }
 
 export class UmbManagementApiDetailDataRequestManager<
@@ -29,13 +28,12 @@ export class UmbManagementApiDetailDataRequestManager<
 	UpdateRequestModelType,
 > extends UmbControllerBase {
 	#dataCache: UmbManagementApiDetailDataCache<DetailResponseModelType>;
-	#serverEventSource: string;
-	#serverEventContext?: typeof UMB_MANAGEMENT_API_SERVER_EVENT_CONTEXT.TYPE;
 
 	#create;
 	#read;
 	#update;
 	#delete;
+	#serverEventContext?: typeof UMB_MANAGEMENT_API_SERVER_EVENT_CONTEXT.TYPE;
 	#isConnectedToServerEvents = false;
 
 	constructor(
@@ -54,7 +52,6 @@ export class UmbManagementApiDetailDataRequestManager<
 		this.#delete = args.delete;
 
 		this.#dataCache = args.dataCache;
-		this.#serverEventSource = args.serverEventSource;
 
 		this.consumeContext(UMB_MANAGEMENT_API_SERVER_EVENT_CONTEXT, (context) => {
 			this.#serverEventContext = context;
@@ -130,15 +127,5 @@ export class UmbManagementApiDetailDataRequestManager<
 			},
 			'umbObserveServerEventsConnection',
 		);
-
-		// Invalidate cache entries when entities are updated or deleted
-		this.observe(
-			this.#serverEventContext?.byEventSourceAndTypes(this.#serverEventSource, ['Updated', 'Deleted']),
-			(event) => {
-				if (!event) return;
-				this.#dataCache.delete(event.key);
-			},
-			'umbObserveServerEvents',
-		);
 	}
 }

src/Umbraco.Web.UI.Client/src/packages/management-api/detail/index.ts

@@ -1,2 +1,3 @@
 export * from './detail-data.request-manager.js';
 export * from './cache.js';
+export * from './cache-invalidation.manager.js';

src/Umbraco.Web.UI.Client/src/packages/management-api/index.ts

@@ -1,2 +1,3 @@
 export * from './detail/index.js';
+export * from './item/index.js';
 export * from './server-event/constants.js';

src/Umbraco.Web.UI.Client/src/packages/management-api/item/cache-invalidation.manager.ts

@@ -0,0 +1,44 @@
+import { UMB_MANAGEMENT_API_SERVER_EVENT_CONTEXT } from '../server-event/constants.js';
+import type { UmbManagementApiItemDataCache } from './cache.js';
+import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import { UmbControllerBase } from '@umbraco-cms/backoffice/class-api';
+
+export interface UmbManagementApiItemDataInvalidationManagerArgs<ItemResponseModelType> {
+	dataCache: UmbManagementApiItemDataCache<ItemResponseModelType>;
+	serverEventSources: Array<string>;
+}
+
+export class UmbManagementApiItemDataCacheInvalidationManager<ItemResponseModelType> extends UmbControllerBase {
+	#dataCache: UmbManagementApiItemDataCache<ItemResponseModelType>;
+	#serverEventSources: Array<string>;
+	#serverEventContext?: typeof UMB_MANAGEMENT_API_SERVER_EVENT_CONTEXT.TYPE;
+
+	constructor(host: UmbControllerHost, args: UmbManagementApiItemDataInvalidationManagerArgs<ItemResponseModelType>) {
+		super(host);
+		{
+			this.#dataCache = args.dataCache;
+			this.#serverEventSources = args.serverEventSources;
+
+			this.consumeContext(UMB_MANAGEMENT_API_SERVER_EVENT_CONTEXT, (context) => {
+				this.#serverEventContext = context;
+				this.#observeServerEvents();
+			});
+		}
+	}
+
+	#observeServerEvents() {
+		// Invalidate cache entries when entities are updated or deleted
+		this.observe(
+			this.#serverEventContext?.byEventSourcesAndTypes(this.#serverEventSources, ['Updated', 'Deleted']),
+			(event) => {
+				if (!event) return;
+				this.#dataCache.delete(event.key);
+			},
+			'umbObserveServerEvents',
+		);
+	}
+
+	override destroy(): void {
+		this.#dataCache.clear();
+	}
+}