Feature: Published Document Pending Changes

src/Umbraco.Web.UI.Client/src/assets/lang/en-us.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/packages/core/content/workspace/content-detail-workspace-base.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/packages/core/utils/deprecation/deprecation.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/packages/core/utils/deprecation/index.ts

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

src/Umbraco.Web.UI.Client/src/packages/core/utils/deprecation/types.ts

@@ -0,0 +1,5 @@
+export interface UmbDeprecationArgs {
+	deprecated: string;
+	removeInVersion: string;
+	solution: string;
+}

src/Umbraco.Web.UI.Client/src/packages/core/utils/index.ts

@@ -23,4 +23,5 @@ export * from './sanitize/sanitize-html.function.js';
 export * from './selection-manager/selection.manager.js';
 export * from './state-manager/index.js';
 export * from './string/index.js';
+export * from './deprecation/index.js';
 export type * from './type/index.js';

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

@@ -38,6 +38,7 @@ export abstract class UmbEntityDetailWorkspaceContextBase<
 	public readonly unique = this.#entityContext.unique;
 
 	public readonly data = this._data.current;
+	public readonly persistedData = this._data.persisted;
 	public readonly loading = new UmbStateManager(this);
 
 	protected _getDataPromise?: Promise<any>;
@@ -85,6 +86,14 @@ export abstract class UmbEntityDetailWorkspaceContextBase<
 		return this._data.getCurrent();
 	}
 
+	/**
+	 * Get the persisted data
+	 * @returns { DetailModelType | undefined } The persisted data
+	 */
+	public getPersistedData(): DetailModelType | undefined {
+		return this._data.getPersisted();
+	}
+
 	/**
 	 * Get the unique
 	 * @returns { string | undefined } The unique identifier
@@ -122,10 +131,10 @@ export abstract class UmbEntityDetailWorkspaceContextBase<
 	}
 
 	async load(unique: string) {
+		this.resetState();
 		this.#entityContext.setUnique(unique);
 		this.loading.addState({ unique: LOADING_STATE_UNIQUE, message: `Loading ${this.getEntityType()} Details` });
 		await this.#init;
-		this.resetState();
 		this._getDataPromise = this._detailRepository!.requestByUnique(unique);
 		type GetDataType = Awaited<ReturnType<UmbDetailRepository<DetailModelType>['requestByUnique']>>;
 		const response = (await this._getDataPromise) as GetDataType;
@@ -147,6 +156,21 @@ export abstract class UmbEntityDetailWorkspaceContextBase<
 		return response;
 	}
 
+	/**
+	 * Reload the workspace data
+	 * @returns { Promise<void> } The promise of the reload
+	 */
+	public async reload(): Promise<void> {
+		const unique = this.getUnique();
+		if (!unique) throw new Error('Unique is not set');
+		const { data } = await this._detailRepository!.requestByUnique(unique);
+
+		if (data) {
+			this._data.setPersisted(data);
+			this._data.setCurrent(data);
+		}
+	}
+
 	/**
 	 * Method to check if the workspace data is loaded.
 	 * @returns { Promise<any> | undefined } true if the workspace data is loaded.
@@ -166,9 +190,9 @@ export abstract class UmbEntityDetailWorkspaceContextBase<
 	 * @returns { Promise<any> | undefined } The data of the scaffold.
 	 */
 	public async createScaffold(args: CreateArgsType) {
+		this.resetState();
 		this.loading.addState({ unique: LOADING_STATE_UNIQUE, message: `Creating ${this.getEntityType()} scaffold` });
 		await this.#init;
-		this.resetState();
 		this.setParent(args.parent);
 
 		const request = this._detailRepository!.createScaffold(args.preset);

src/Umbraco.Web.UI.Client/src/packages/core/workspace/submittable/submittable-workspace-context-base.ts

@@ -63,7 +63,7 @@ export abstract class UmbSubmittableWorkspaceContextBase<WorkspaceDataModelType>
 		this.#isNew.setValue(undefined);
 	}
 
-	getIsNew() {
+	public getIsNew() {
 		return this.#isNew.getValue();
 	}
 
@@ -75,19 +75,19 @@ export abstract class UmbSubmittableWorkspaceContextBase<WorkspaceDataModelType>
 	 * If a Workspace has multiple validation contexts, then this method can be overwritten to return the correct one.
 	 * @returns Promise that resolves to void when the validation is complete.
 	 */
-	async validate(): Promise<Array<void>> {
+	public async validate(): Promise<Array<void>> {
 		//return this.validation.validate();
 		return Promise.all(this.#validationContexts.map((context) => context.validate()));
 	}
 
-	async requestSubmit(): Promise<void> {
+	public async requestSubmit(): Promise<void> {
 		return this.validateAndSubmit(
 			() => this.submit(),
 			() => this.invalidSubmit(),
 		);
 	}
 
-	protected async validateAndSubmit(onValid: () => Promise<void>, onInvalid: () => Promise<void>): Promise<void> {
+	public async validateAndSubmit(onValid: () => Promise<void>, onInvalid: () => Promise<void>): Promise<void> {
 		if (this.#submitPromise) {
 			return this.#submitPromise;
 		}

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

@@ -1,15 +1,16 @@
 export { UMB_DOCUMENT_ENTITY_TYPE, UMB_DOCUMENT_ROOT_ENTITY_TYPE } from './entity.js';
 
-export * from './paths.js';
 export * from './collection/constants.js';
 export * from './entity-actions/constants.js';
 export * from './entity-bulk-actions/constants.js';
-export * from './property-dataset-context/constants.js';
 export * from './modals/constants.js';
+export * from './paths.js';
+export * from './property-dataset-context/constants.js';
+export * from './publishing/constants.js';
 export * from './recycle-bin/constants.js';
 export * from './reference/constants.js';
 export * from './repository/constants.js';
 export * from './rollback/constants.js';
 export * from './search/constants.js';
-export * from './workspace/constants.js';
 export * from './user-permissions/constants.js';
+export * from './workspace/constants.js';