Merge pull request #2342 from umbraco/v15/feature/tree-folder-workspace

Feature: Folder workspace

Author: nielslyngsoe

src/packages/core/repository/detail/detail-repository-base.ts

@@ -7,9 +7,10 @@ import { UMB_NOTIFICATION_CONTEXT } from '@umbraco-cms/backoffice/notification';
 import type { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
 import type { UmbDetailStore } from '@umbraco-cms/backoffice/store';
 import type { UmbApi } from '@umbraco-cms/backoffice/extension-api';
+import type { UmbEntityModel } from '@umbraco-cms/backoffice/entity';
 
 export abstract class UmbDetailRepositoryBase<
-		DetailModelType extends { unique: string; entityType: string },
+		DetailModelType extends UmbEntityModel,
 		UmbDetailDataSourceType extends UmbDetailDataSource<DetailModelType> = UmbDetailDataSource<DetailModelType>,
 	>
 	extends UmbRepositoryBase
@@ -28,6 +29,9 @@ export abstract class UmbDetailRepositoryBase<
 	) {
 		super(host);
 
+		if (!detailSource) throw new Error('Detail source is missing');
+		if (!detailStoreContextAlias) throw new Error('Detail store context alias is missing');
+
 		this.detailDataSource = new detailSource(host) as UmbDetailDataSourceType;
 
 		this.#init = Promise.all([

src/packages/core/server-file-system/rename/rename-server-file-repository-base.ts

@@ -4,9 +4,10 @@ import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
 import { UMB_NOTIFICATION_CONTEXT } from '@umbraco-cms/backoffice/notification';
 import type { UmbDetailStore } from '@umbraco-cms/backoffice/store';
 import { UmbRepositoryBase } from '@umbraco-cms/backoffice/repository';
+import type { UmbEntityModel } from '@umbraco-cms/backoffice/entity';
 
 export abstract class UmbRenameServerFileRepositoryBase<
-	DetailModelType extends { unique: string },
+	DetailModelType extends UmbEntityModel,
 > extends UmbRepositoryBase {
 	#renameSource: UmbRenameServerFileDataSource<DetailModelType>;
 	#detailStoreContextAlias: string | UmbContextToken<UmbDetailStore<DetailModelType>>;

src/packages/core/server-file-system/rename/types.ts

@@ -1,14 +1,15 @@
 import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import type { UmbEntityModel } from '@umbraco-cms/backoffice/entity';
 import type { UmbDataSourceResponse } from '@umbraco-cms/backoffice/repository';
 
-export interface UmbRenameServerFileRepository<DetailType extends { unique: string }> {
+export interface UmbRenameServerFileRepository<DetailType extends UmbEntityModel> {
 	rename(unique: string, name: string): Promise<UmbDataSourceResponse<DetailType>>;
 }
 
-export interface UmbRenameServerFileDataSourceConstructor<DetailType extends { unique: string }> {
+export interface UmbRenameServerFileDataSourceConstructor<DetailType extends UmbEntityModel> {
 	new (host: UmbControllerHost): UmbRenameServerFileDataSource<DetailType>;
 }
 
-export interface UmbRenameServerFileDataSource<DetailType extends { unique: string }> {
+export interface UmbRenameServerFileDataSource<DetailType extends UmbEntityModel> {
 	rename(unique: string, name: string): Promise<UmbDataSourceResponse<DetailType>>;
 }

src/packages/core/store/detail/detail-store-base.ts

@@ -1,5 +1,6 @@
 import { UmbStoreBase } from '../store-base.js';
 import type { UmbDetailStore } from './detail-store.interface.js';
+import type { UmbEntityModel } from '@umbraco-cms/backoffice/entity';
 import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
 import { UmbArrayState } from '@umbraco-cms/backoffice/observable-api';
 
@@ -9,14 +10,14 @@ import { UmbArrayState } from '@umbraco-cms/backoffice/observable-api';
  * @description - Data Store for Data Type items
  */
 
-export abstract class UmbDetailStoreBase<T extends { unique: string }>
+export abstract class UmbDetailStoreBase<T extends UmbEntityModel>
 	extends UmbStoreBase<T>
 	implements UmbDetailStore<T>
 {
 	/**
 	 * Creates an instance of UmbDetailStoreBase.
 	 * @param {UmbControllerHost} host - The controller host for this controller to be appended to
-	 * @param storeAlias
+	 * @param storeAlias - The alias of the store
 	 * @memberof UmbDetailStoreBase
 	 */
 	constructor(host: UmbControllerHost, storeAlias: string) {
@@ -25,8 +26,9 @@ export abstract class UmbDetailStoreBase<T extends { unique: string }>
 
 	/**
 	 * Retrieve a detail model from the store
-	 * @param {unique} string unique
+	 * @param {unique} string unique identifier
 	 * @param unique
+	 * @returns {Observable<T>}
 	 * @memberof UmbDetailStoreBase
 	 */
 	byUnique(unique: string) {

src/packages/core/store/detail/detail-store.interface.ts

@@ -1,7 +1,8 @@
 import type { UmbStore } from '../store.interface.js';
 import type { Observable } from '@umbraco-cms/backoffice/external/rxjs';
 import type { UmbApi } from '@umbraco-cms/backoffice/extension-api';
+import type { UmbEntityModel } from '@umbraco-cms/backoffice/entity';
 
-export interface UmbDetailStore<T extends { unique: string }> extends UmbStore<T>, UmbApi {
+export interface UmbDetailStore<T extends UmbEntityModel> extends UmbStore<T>, UmbApi {
 	byUnique: (unique: string) => Observable<T | undefined>;
 }

src/packages/core/tree/folder/entity-action/delete-folder/delete-folder.action.ts

@@ -1,4 +1,4 @@
-import type { UmbFolderRepository } from '../../folder-repository.interface.js';
+import type { UmbFolderModel } from '../../types.js';
 import { UMB_ACTION_EVENT_CONTEXT } from '@umbraco-cms/backoffice/action';
 import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
 import type { UmbEntityActionArgs } from '@umbraco-cms/backoffice/entity-action';
@@ -7,10 +7,11 @@ import { UmbExtensionApiInitializer } from '@umbraco-cms/backoffice/extension-ap
 import type { MetaEntityActionFolderKind } from '@umbraco-cms/backoffice/extension-registry';
 import { umbExtensionsRegistry } from '@umbraco-cms/backoffice/extension-registry';
 import { umbConfirmModal } from '@umbraco-cms/backoffice/modal';
+import type { UmbDetailRepository } from '@umbraco-cms/backoffice/repository';
 
 export class UmbDeleteFolderEntityAction extends UmbEntityActionBase<MetaEntityActionFolderKind> {
 	// TODO: make base type for item and detail models
-	#folderRepository?: UmbFolderRepository;
+	#folderRepository?: UmbDetailRepository<UmbFolderModel>;
 	#init: Promise<unknown>;
 
 	constructor(host: UmbControllerHost, args: UmbEntityActionArgs<MetaEntityActionFolderKind>) {
@@ -25,7 +26,7 @@ export class UmbDeleteFolderEntityAction extends UmbEntityActionBase<MetaEntityA
 				this.args.meta.folderRepositoryAlias,
 				[this._host],
 				(permitted, ctrl) => {
-					this.#folderRepository = permitted ? (ctrl.api as UmbFolderRepository) : undefined;
+					this.#folderRepository = permitted ? (ctrl.api as UmbDetailRepository<UmbFolderModel>) : undefined;
 				},
 			).asPromise(),
 		]);
@@ -35,7 +36,7 @@ export class UmbDeleteFolderEntityAction extends UmbEntityActionBase<MetaEntityA
 		if (!this.args.unique) throw new Error('Unique is not available');
 		await this.#init;
 
-		const { data: folder } = await this.#folderRepository!.request(this.args.unique);
+		const { data: folder } = await this.#folderRepository!.requestByUnique(this.args.unique);
 
 		if (folder) {
 			// TODO: maybe we can show something about how many items are part of the folder?

src/packages/core/tree/folder/folder-data-source.interface.ts

@@ -1,7 +1,3 @@
-export { type UmbFolderRepository } from './folder-repository.interface.js';
-export { type UmbFolderDataSource } from './folder-data-source.interface.js';
-export { UmbFolderRepositoryBase } from './folder-repository-base.js';
-
 export * from './types.js';
 export * from './modal/index.js';
 export * from './entity-action/index.js';