Feature: Published Document Pending Changes (#17812)

* implement validation for media and prepare for member

* remove import

* port code from backoffice repo

* move repo into publishing module

* port get published methods

* cleanup

* wip render state

* align state UI

* post merge clean up

* move publish modal

* move schedule modal

* move unpublish modal

* move publish action and bulk action

* move unpublish action + bulk action

* lint fix

* Update document-workspace.context.ts

* wip move publishing methods to publishing context

* move publish with descendants

* fix more references

* Update document-publishing.workspace-context.ts

* export entity action

* add return type

* temp internal methods

* use repository response type

* expose methods for other contexts to use

* use public methods

* call publishing context methods

* fix import

* move manager into folder

* organise in folders

* add get method to get variants with changes

* preselect variants with pending changes

* observe data changes

* render pending changes client state

* observe unique

* Update document-publishing.server.data-source.ts

* use correct key

* clean up

* expose persisted data

* rename arg

* use persisted data instead of current

* add reload method

* reload data after publish

* remove headline

* handle all publish actions the same

* reset state as the first thing when creating + loading

* add method to get variants

* only load published if document has a published variant

* remove variants from observer

* add public method to get the changed variants

* align preselection with current logic

* add deprecation util

* add method deprecation warnings

* remove unused publish method

* move publishing workspace actions into publishing module

* use publishing context

* clean up

* add tests for published pending changes manager

* handle server the same way

* process pending changes when persisted data changes

* remove buggy updateDate

* remove unused

* lint fix

* add publish method back to avoid a breaking change

---------

Co-authored-by: Niels Lyngsø <[email protected]>
Co-authored-by: Niels Lyngsø <[email protected]>

Author: madsrasmussen

src/Umbraco.Web.UI.Client/src/apps/installer/consent/installer-content.test.ts

@@ -654,7 +654,7 @@ export default {
 		indexCannotRebuild: 'This index cannot be rebuilt because it has no assigned',
 		iIndexPopulator: 'IIndexPopulator',
 		corruptStatus: 'Possible corrupt index detected',
-		corruptErrorDescription: 'Error received when evaluating the index:'
+		corruptErrorDescription: 'Error received when evaluating the index:',
 	},
 	placeholders: {
 		username: 'Enter your username',

src/Umbraco.Web.UI.Client/src/apps/installer/database/installer-database.test.ts

@@ -63,6 +63,20 @@ export interface UmbContentDetailWorkspaceContextArgs<
 	saveModalToken?: UmbModalToken<UmbContentVariantPickerData<VariantOptionModelType>, UmbContentVariantPickerValue>;
 }
 
+/**
+ * The base class for a content detail workspace context.
+ * @exports
+ * @abstract
+ * @class UmbContentDetailWorkspaceContextBase
+ * @augments {UmbEntityDetailWorkspaceContextBase<DetailModelType, DetailRepositoryType, CreateArgsType>}
+ * @implements {UmbContentWorkspaceContext<DetailModelType, ContentTypeDetailModelType, VariantModelType>}
+ * @template DetailModelType
+ * @template DetailRepositoryType
+ * @template ContentTypeDetailModelType
+ * @template VariantModelType
+ * @template VariantOptionModelType
+ * @template CreateArgsType
+ */
 export abstract class UmbContentDetailWorkspaceContextBase<
 		DetailModelType extends UmbContentDetailModel<VariantModelType>,
 		DetailRepositoryType extends UmbDetailRepository<DetailModelType> = UmbDetailRepository<DetailModelType>,
@@ -83,8 +97,11 @@ export abstract class UmbContentDetailWorkspaceContextBase<
 
 	/* Content Data */
 	protected override readonly _data = new UmbContentWorkspaceDataManager<DetailModelType, VariantModelType>(this);
+
+	public override readonly data = this._data.current;
 	public readonly values = this._data.createObservablePartOfCurrent((data) => data?.values);
 	public readonly variants = this._data.createObservablePartOfCurrent((data) => data?.variants ?? []);
+	public override readonly persistedData = this._data.persisted;
 
 	/* Content Type (Structure) Data */
 	public readonly structure;
@@ -332,6 +349,10 @@ export abstract class UmbContentDetailWorkspaceContextBase<
 		return this._data.getCurrent()?.variants?.find((x) => variantId.compare(x));
 	}
 
+	public getVariants(): Array<VariantModelType> | undefined {
+		return this._data.getCurrent()?.variants;
+	}
+
 	/**
 	 * Observe the property type
 	 * @param {string} propertyId - The id of the property
@@ -440,7 +461,19 @@ export abstract class UmbContentDetailWorkspaceContextBase<
 		this._data.finishPropertyValueChange();
 	};
 
-	protected async _determineVariantOptions() {
+	/**
+	 * Gets the changed variant ids
+	 * @returns {Array<UmbVariantId>} - The changed variant ids
+	 * @memberof UmbContentDetailWorkspaceContextBase
+	 */
+	public getChangedVariants(): Array<UmbVariantId> {
+		return this._data.getChangedVariants();
+	}
+
+	protected async _determineVariantOptions(): Promise<{
+		options: VariantOptionModelType[];
+		selected: string[];
+	}> {
 		const options = await firstValueFrom(this.variantOptions);
 
 		const activeVariants = this.splitView.getActiveVariants();
@@ -465,7 +498,23 @@ export abstract class UmbContentDetailWorkspaceContextBase<
 	};
 
 	/* validation */
+	/**
+	 * Run the mandatory validation for the save data
+	 * @deprecated Use the public runMandatoryValidationForSaveData instead. Will be removed in v. 17.
+	 * @protected
+	 * @param {DetailModelType} saveData - The data to validate
+	 * @memberof UmbContentDetailWorkspaceContextBase
+	 */
 	protected async _runMandatoryValidationForSaveData(saveData: DetailModelType) {
+		this.runMandatoryValidationForSaveData(saveData);
+	}
+
+	/**
+	 * Run the mandatory validation for the save data
+	 * @param {DetailModelType} saveData - The data to validate
+	 * @memberof UmbContentDetailWorkspaceContextBase
+	 */
+	public async runMandatoryValidationForSaveData(saveData: DetailModelType) {
 		// Check that the data is valid before we save it.
 		// Check variants have a name:
 		const variantsWithoutAName = saveData.variants.filter((x) => !x.name);
@@ -482,7 +531,13 @@ export abstract class UmbContentDetailWorkspaceContextBase<
 		}
 	}
 
-	protected async _askServerToValidate(saveData: DetailModelType, variantIds: Array<UmbVariantId>) {
+	/**
+	 * Ask the server to validate the save data
+	 * @param {DetailModelType} saveData - The data to validate
+	 * @param {Array<UmbVariantId>} variantIds - The variant ids to validate
+	 * @memberof UmbContentDetailWorkspaceContextBase
+	 */
+	public async askServerToValidate(saveData: DetailModelType, variantIds: Array<UmbVariantId>) {
 		if (this.#validationRepositoryClass) {
 			// Create the validation repository if it does not exist. (we first create this here when we need it) [NL]
 			this.#validationRepository ??= new this.#validationRepositoryClass(this);
@@ -516,6 +571,16 @@ export abstract class UmbContentDetailWorkspaceContextBase<
 		return this._handleSubmit();
 	}
 
+	/**
+	 * Get the data to save
+	 * @param {Array<UmbVariantId>} variantIds - The variant ids to save
+	 * @returns {Promise<DetailModelType>}  {Promise<DetailModelType>}
+	 * @memberof UmbContentDetailWorkspaceContextBase
+	 */
+	public constructSaveData(variantIds: Array<UmbVariantId>): Promise<DetailModelType> {
+		return this._data.constructData(variantIds);
+	}
+
 	protected async _handleSubmit() {
 		const data = this.getData();
 		if (!data) {
@@ -553,24 +618,42 @@ export abstract class UmbContentDetailWorkspaceContextBase<
 			throw new Error('No variant picker modal token is set. There are multiple variants to save. Cannot proceed.');
 		}
 
-		const saveData = await this._data.constructData(variantIds);
-		await this._runMandatoryValidationForSaveData(saveData);
+		const saveData = await this.constructSaveData(variantIds);
+		await this.runMandatoryValidationForSaveData(saveData);
 		if (this.#validateOnSubmit) {
-			await this._askServerToValidate(saveData, variantIds);
+			await this.askServerToValidate(saveData, variantIds);
 			return this.validateAndSubmit(
 				async () => {
-					return this._performCreateOrUpdate(variantIds, saveData);
+					return this.performCreateOrUpdate(variantIds, saveData);
 				},
 				async () => {
 					return this.invalidSubmit();
 				},
 			);
 		} else {
-			await this._performCreateOrUpdate(variantIds, saveData);
+			await this.performCreateOrUpdate(variantIds, saveData);
 		}
 	}
 
+	/**
+	 * Perform the create or update of the content
+	 * @deprecated Use the public performCreateOrUpdate instead. Will be removed in v. 17.
+	 * @protected
+	 * @param {Array<UmbVariantId>} variantIds
+	 * @param {DetailModelType} saveData
+	 * @memberof UmbContentDetailWorkspaceContextBase
+	 */
 	protected async _performCreateOrUpdate(variantIds: Array<UmbVariantId>, saveData: DetailModelType) {
+		await this.performCreateOrUpdate(variantIds, saveData);
+	}
+
+	/**
+	 * Perform the create or update of the content
+	 * @param {Array<UmbVariantId>} variantIds - The variant ids to save
+	 * @param {DetailModelType} saveData - The data to save
+	 * @memberof UmbContentDetailWorkspaceContextBase
+	 */
+	public async performCreateOrUpdate(variantIds: Array<UmbVariantId>, saveData: DetailModelType) {
 		if (this.getIsNew()) {
 			await this.#create(variantIds, saveData);
 		} else {

src/Umbraco.Web.UI.Client/src/apps/installer/error/installer-error.test.ts

@@ -0,0 +1,29 @@
+import type { UmbDeprecationArgs } from './types.js';
+
+/**
+ * Helper class for deprecation warnings.
+ * @exports
+ * @class UmbDeprecation
+ */
+export class UmbDeprecation {
+	#messagePrefix: string = 'Umbraco Backoffice:';
+	#deprecated: string;
+	#removeInVersion: string;
+	#solution: string;
+
+	constructor(args: UmbDeprecationArgs) {
+		this.#deprecated = args.deprecated;
+		this.#removeInVersion = args.removeInVersion;
+		this.#solution = args.solution;
+	}
+
+	/**
+	 * Logs a warning message to the console.
+	 * @memberof UmbDeprecation
+	 */
+	warn() {
+		console.warn(
+			`${this.#messagePrefix} ${this.#deprecated} The feature will be removed in version ${this.#removeInVersion}. ${this.#solution}`,
+		);
+	}
+}

src/Umbraco.Web.UI.Client/src/apps/installer/installing/installer-installing.test.ts

@@ -0,0 +1,3 @@
+export * from './deprecation.js';
+
+export type * from './types.js';