add detail repo base

src/Umbraco.Web.UI.Client/src/packages/core/repository/detail/detail-repository-base.ts

@@ -0,0 +1,146 @@
+import { UmbRepositoryBase } from '../repository-base.js';
+import { UmbDetailDataSource, UmbDetailDataSourceConstructor } from './detail-data-source.interface.js';
+import { type UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import { UMB_NOTIFICATION_CONTEXT_TOKEN, UmbNotificationContext } from '@umbraco-cms/backoffice/notification';
+import { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
+
+export abstract class UmbDetailRepositoryBase<DetailModelType extends { unique: string }> extends UmbRepositoryBase {
+	#init: Promise<unknown>;
+
+	#detailStore?: UmbDetailStore;
+	#detailSource: UmbDetailDataSource<DetailModelType>;
+	#notificationContext?: UmbNotificationContext;
+
+	constructor(
+		host: UmbControllerHost,
+		detailSource: UmbDetailDataSourceConstructor<DetailModelType>,
+		itemStoreContextAlias: string | UmbContextToken<any, any>,
+	) {
+		super(host);
+
+		this.#detailSource = new detailSource(host);
+
+		this.#init = Promise.all([
+			this.consumeContext(itemStoreContextAlias, (instance) => {
+				this.#detailStore = instance;
+			}).asPromise(),
+
+			this.consumeContext(UMB_NOTIFICATION_CONTEXT_TOKEN, (instance) => {
+				this.#notificationContext = instance;
+			}).asPromise(),
+		]);
+	}
+
+	/**
+	 * Creates a scaffold
+	 * @param {(string | null)} parentUnique
+	 * @return {*}
+	 * @memberof UmbDetailRepositoryBase
+	 */
+	async createScaffold(parentUnique: string | null) {
+		if (parentUnique === undefined) throw new Error('Parent unique is missing');
+		return this.#detailSource.createScaffold(parentUnique);
+	}
+
+	/**
+	 * Requests the detail for the given unique
+	 * @param {string} unique
+	 * @return {*}
+	 * @memberof UmbDetailRepositoryBase
+	 */
+	async requestByUnique(unique: string) {
+		if (!unique) throw new Error('Key is missing');
+		await this.#init;
+
+		const { data, error } = await this.#detailSource.read(unique);
+
+		if (data) {
+			this.#detailStore!.append(data);
+		}
+
+		return { data, error, asObservable: () => this.#detailStore!.byUnique(unique) };
+	}
+
+	/**
+	 * Returns a promise with an observable of the detail for the given unique
+	 * @param {string} unique
+	 * @return {*}
+	 * @memberof UmbDetailRepositoryBase
+	 */
+	async create(data: DetailModelType) {
+		if (!data) throw new Error('Data is missing');
+		if (!data.unique) throw new Error('Unique is missing');
+		await this.#init;
+
+		const { data: createdData, error } = await this.#detailSource.create(data);
+
+		if (!error) {
+			this.#detailStore?.append(createdData);
+
+			// TODO: how do we handle generic notifications? Is this the correct place to do it?
+			const notification = { data: { message: `Created` } };
+			this.#notificationContext!.peek('positive', notification);
+		}
+
+		return { error };
+	}
+
+	/**
+	 * Saves the given data
+	 * @param {DetailModelType} data
+	 * @return {*}
+	 * @memberof UmbDetailRepositoryBase
+	 */
+	async save(data: DetailModelType) {
+		if (!data) throw new Error('Data is missing');
+		if (!data.unique) throw new Error('Unique is missing');
+		await this.#init;
+
+		const { data: updatedData, error } = await this.#detailSource.update(data);
+
+		if (updatedData) {
+			this.#detailStore!.updateItem(data.unique, updatedData);
+
+			// TODO: how do we handle generic notifications? Is this the correct place to do it?
+			const notification = { data: { message: `Saved` } };
+			this.#notificationContext!.peek('positive', notification);
+		}
+
+		return { data, error };
+	}
+
+	/**
+	 * Deletes the detail for the given unique
+	 * @param {string} unique
+	 * @return {*}
+	 * @memberof UmbDetailRepositoryBase
+	 */
+	async delete(unique: string) {
+		if (!unique) throw new Error('Unique is missing');
+		await this.#init;
+
+		const { error } = await this.#detailSource.delete(unique);
+
+		if (!error) {
+			this.#detailStore!.removeItem(unique);
+
+			// TODO: how do we handle generic notifications? Is this the correct place to do it?
+			const notification = { data: { message: `Deleted` } };
+			this.#notificationContext!.peek('positive', notification);
+		}
+
+		return { error };
+	}
+
+	/**
+	 * Returns a promise with an observable of the detail for the given unique
+	 * @param {string} unique
+	 * @return {*}
+	 * @memberof UmbDetailRepositoryBase
+	 */
+	async byUnique(unique: string) {
+		if (!unique) throw new Error('Unique is missing');
+		await this.#init;
+		return this.#detailStore!.byUnique(unique);
+	}
+}