Merge pull request #1732 from umbraco/feature/trashed-context

Feature: Entity Is trashed condition + filter document/media entity actions

Author: nielslyngsoe

src/packages/core/components/entity-actions-bundle/entity-actions-bundle.element.ts

@@ -31,6 +31,7 @@ export class UmbEntityActionsBundleElement extends UmbLitElement {
 
 	#sectionSidebarContext?: UmbSectionSidebarContext;
 
+	// TODO: provide the entity context on a higher level, like the root element of this entity, tree-item/workspace/... [NL]
 	#entityContext = new UmbEntityContext(this);
 
 	constructor() {

src/packages/core/recycle-bin/conditions/is-not-trashed/constants.ts

@@ -0,0 +1 @@
+export const UMB_ENTITY_IS_NOT_TRASHED_CONDITION_ALIAS = 'Umb.Condition.EntityIsNotTrashed';

src/packages/core/recycle-bin/conditions/is-not-trashed/entity-is-not-trashed.condition.manifest.ts

@@ -0,0 +1,9 @@
+import { UMB_ENTITY_IS_NOT_TRASHED_CONDITION_ALIAS } from './constants.js';
+import type { ManifestCondition } from '@umbraco-cms/backoffice/extension-api';
+
+export const manifest: ManifestCondition = {
+	type: 'condition',
+	name: 'Entity Is not trashed Condition',
+	alias: UMB_ENTITY_IS_NOT_TRASHED_CONDITION_ALIAS,
+	api: () => import('./entity-is-not-trashed.condition.js'),
+};

src/packages/core/recycle-bin/conditions/is-not-trashed/entity-is-not-trashed.condition.ts

@@ -0,0 +1,29 @@
+import { UMB_IS_TRASHED_ENTITY_CONTEXT } from '../../contexts/is-trashed/index.js';
+import { UmbConditionBase } from '@umbraco-cms/backoffice/extension-registry';
+import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import type {
+	UmbConditionConfigBase,
+	UmbConditionControllerArguments,
+	UmbExtensionCondition,
+} from '@umbraco-cms/backoffice/extension-api';
+
+export class UmbEntityIsNotTrashedCondition
+	extends UmbConditionBase<UmbConditionConfigBase>
+	implements UmbExtensionCondition
+{
+	constructor(host: UmbControllerHost, args: UmbConditionControllerArguments<UmbConditionConfigBase>) {
+		super(host, args);
+
+		// this is a "negative/not" condition, so we assume the default value is that the context is not trashed
+		// and therefore the condition is permitted
+		this.permitted = true;
+
+		this.consumeContext(UMB_IS_TRASHED_ENTITY_CONTEXT, (context) => {
+			this.observe(context.isTrashed, (isTrashed) => {
+				this.permitted = isTrashed === false;
+			});
+		});
+	}
+}
+
+export { UmbEntityIsNotTrashedCondition as api };

src/packages/core/recycle-bin/conditions/is-trashed/constants.ts

@@ -0,0 +1 @@
+export const UMB_ENTITY_IS_TRASHED_CONDITION_ALIAS = 'Umb.Condition.EntityIsTrashed';

src/packages/core/recycle-bin/conditions/is-trashed/entity-is-trashed.condition.manifest.ts

@@ -0,0 +1,9 @@
+import { UMB_ENTITY_IS_TRASHED_CONDITION_ALIAS } from './constants.js';
+import type { ManifestCondition } from '@umbraco-cms/backoffice/extension-api';
+
+export const manifest: ManifestCondition = {
+	type: 'condition',
+	name: 'Entity Is trashed Condition',
+	alias: UMB_ENTITY_IS_TRASHED_CONDITION_ALIAS,
+	api: () => import('./entity-is-trashed.condition.js'),
+};

src/packages/core/recycle-bin/conditions/is-trashed/entity-is-trashed.condition.ts

@@ -0,0 +1,22 @@
+import { UMB_IS_TRASHED_ENTITY_CONTEXT } from '../../contexts/is-trashed/index.js';
+import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import type {
+	UmbConditionConfigBase,
+	UmbConditionControllerArguments,
+	UmbExtensionCondition,
+} from '@umbraco-cms/backoffice/extension-api';
+import { UmbConditionBase } from '@umbraco-cms/backoffice/extension-registry';
+
+export class UmbIsTrashedCondition extends UmbConditionBase<UmbConditionConfigBase> implements UmbExtensionCondition {
+	constructor(host: UmbControllerHost, args: UmbConditionControllerArguments<UmbConditionConfigBase>) {
+		super(host, args);
+
+		this.consumeContext(UMB_IS_TRASHED_ENTITY_CONTEXT, (context) => {
+			this.observe(context.isTrashed, (isTrashed) => {
+				this.permitted = isTrashed === true;
+			});
+		});
+	}
+}
+
+export { UmbIsTrashedCondition as api };

src/packages/core/recycle-bin/conditions/manifests.ts

@@ -0,0 +1,4 @@
+import { manifest as isTrashedManifest } from './is-trashed/entity-is-trashed.condition.manifest.js';
+import { manifest as isNotTrashedManifest } from './is-not-trashed/entity-is-not-trashed.condition.manifest.js';
+
+export const manifests = [isTrashedManifest, isNotTrashedManifest];

src/packages/core/recycle-bin/contexts/is-trashed/index.ts

@@ -0,0 +1,2 @@
+export { UmbIsTrashedEntityContext } from './is-trashed.entity-context.js';
+export { UMB_IS_TRASHED_ENTITY_CONTEXT } from './is-trashed.entity-context-token.js';

src/packages/core/recycle-bin/contexts/is-trashed/is-trashed.entity-context-token.ts

@@ -0,0 +1,6 @@
+import type { UmbIsTrashedEntityContext } from './is-trashed.entity-context.js';
+import { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
+
+export const UMB_IS_TRASHED_ENTITY_CONTEXT = new UmbContextToken<UmbIsTrashedEntityContext>(
+	'UmbEntityIsTrashedContext',
+);