V16: Tree Stores should be optional to use (#19858)

* feat: makes tree stores optional and deprecates dependent methods

* allow `Example` as class prefix

* docs: updates example to remove the treeStore

* deprecates the usage of treeStore contexts

* chore: adds deprecation warnings to all existing tree stores

Author: iOvergaard

src/Umbraco.Web.UI.Client/.storybook/preview.js

@@ -128,6 +128,7 @@ class UmbStoryBookElement extends UmbLitElement {
 		super();
 		new UmbExtensionsApiInitializer(this, umbExtensionsRegistry, 'globalContext', [this]);
 		new UmbExtensionsApiInitializer(this, umbExtensionsRegistry, 'store', [this]);
+		// TODO: Remove this in Umbraco 18, use the repository instead
 		new UmbExtensionsApiInitializer(this, umbExtensionsRegistry, 'treeStore', [this]);
 		new UmbExtensionsApiInitializer(this, umbExtensionsRegistry, 'itemStore', [this]);
 

src/Umbraco.Web.UI.Client/examples/tree/tree/data/manifests.ts

@@ -1,4 +1,3 @@
 import { manifests as repositoryManifests } from './repository/manifests.js';
-import { manifests as storeManifests } from './store/manifests.js';
 
-export const manifests: Array<UmbExtensionManifest> = [...repositoryManifests, ...storeManifests];
+export const manifests: Array<UmbExtensionManifest> = [...repositoryManifests];

src/Umbraco.Web.UI.Client/examples/tree/tree/data/repository/tree.repository.ts

@@ -1,6 +1,5 @@
 import type { ExampleTreeItemModel, ExampleTreeRootModel } from '../../types.js';
 import { EXAMPLE_ROOT_ENTITY_TYPE } from '../../../entity.js';
-import { EXAMPLE_TREE_STORE_CONTEXT } from '../store/index.js';
 import { ExampleTreeLocalDataSource } from '../local-data-source/index.js';
 import { UmbTreeRepositoryBase, type UmbTreeRepository } from '@umbraco-cms/backoffice/tree';
 import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
@@ -11,7 +10,7 @@ export class ExampleTreeRepository
 	implements UmbTreeRepository, UmbApi
 {
 	constructor(host: UmbControllerHost) {
-		super(host, ExampleTreeLocalDataSource, EXAMPLE_TREE_STORE_CONTEXT);
+		super(host, ExampleTreeLocalDataSource);
 	}
 
 	async requestTreeRoot() {

src/Umbraco.Web.UI.Client/examples/tree/tree/data/store/constants.ts

@@ -14,6 +14,9 @@ import './entity-item/global-components.js';
 export const onInit: UmbEntryPointOnInit = (host, extensionRegistry) => {
 	new UmbExtensionsApiInitializer(host, extensionRegistry, 'globalContext', [host]);
 	new UmbExtensionsApiInitializer(host, extensionRegistry, 'store', [host]);
+	/**
+	 * TODO: Remove this in Umbraco 18, use the repository instead
+	 */
 	new UmbExtensionsApiInitializer(host, extensionRegistry, 'treeStore', [host]);
 	new UmbExtensionsApiInitializer(host, extensionRegistry, 'itemStore', [host]);
 

src/Umbraco.Web.UI.Client/examples/tree/tree/data/store/index.ts

@@ -5,7 +5,11 @@ import type { UmbTreeStore } from '@umbraco-cms/backoffice/tree';
 export interface ManifestStore extends ManifestApi<any> {
 	type: 'store';
 }
-// TODO: TREE STORE TYPE PROBLEM: Provide a base tree item type?
+
+/**
+ * Manifest for a tree store.
+ * @deprecated - You do not need to register a treeStore manifest anymore, as the tree repository will be queried each time it is needed. This will be removed in Umbraco 18.
+ */
 export interface ManifestTreeStore extends ManifestApi<UmbTreeStore<any>> {
 	type: 'treeStore';
 }