V15: Current User Group Id Condition (#18011)

* feat: adds userGroupIds to the current user model

* feat: generate new types

* feat: adds function to check for two array intersections

* feat: maps up userGroupIds

* feat: adds new condition to verify user's groups

* chore: add mocked data

* chore: add generated consts

* change structure of config to match other conditions

match, oneOf, allOf, noneOf

* rename condition from "group" to "groupId"

* feat: inherit from base `UserPresentationBase` to have a shared foundation across user models

Author: iOvergaard

src/Umbraco.Cms.Api.Management/Factories/UserPresentationFactory.cs

@@ -216,7 +216,8 @@ public async Task<CurrentUserResponseModel> CreateCurrentUserResponseModelAsync(
             HasAccessToAllLanguages = hasAccessToAllLanguages,
             HasAccessToSensitiveData = user.HasAccessToSensitiveData(),
             AllowedSections = allowedSections,
-            IsAdmin = user.IsAdmin()
+            IsAdmin = user.IsAdmin(),
+            UserGroupIds = presentationUser.UserGroupIds,
         });
     }
 

src/Umbraco.Cms.Api.Management/ViewModels/User/Current/CurrentUserResponseModel.cs

@@ -2,16 +2,10 @@
 
 namespace Umbraco.Cms.Api.Management.ViewModels.User.Current;
 
-public class CurrentUserResponseModel
+public class CurrentUserResponseModel : UserPresentationBase
 {
     public required Guid Id { get; init; }
 
-    public required string Email { get; init; } = string.Empty;
-
-    public required string UserName { get; init; } = string.Empty;
-
-    public required string Name { get; init; } = string.Empty;
-
     public required string? LanguageIsoCode { get; init; }
 
     public required ISet<ReferenceByIdModel> DocumentStartNodeIds { get; init; } = new HashSet<ReferenceByIdModel>();
@@ -35,5 +29,6 @@ public class CurrentUserResponseModel
     public required ISet<IPermissionPresentationModel> Permissions { get; init; }
 
     public required ISet<string> AllowedSections { get; init; }
+
     public bool IsAdmin { get; set; }
 }

src/Umbraco.Web.UI.Client/src/external/backend-api/src/types.gen.ts

@@ -443,10 +443,11 @@ export type CultureReponseModel = {
 };
 
 export type CurrentUserResponseModel = {
-    id: string;
     email: string;
     userName: string;
     name: string;
+    userGroupIds: Array<(ReferenceByIdModel)>;
+    id: string;
     languageIsoCode: (string) | null;
     documentStartNodeIds: Array<(ReferenceByIdModel)>;
     hasDocumentRootAccess: boolean;
@@ -867,6 +868,8 @@ export type DocumentVariantResponseModel = {
     updateDate: string;
     state: DocumentVariantStateModel;
     publishDate?: (string) | null;
+    scheduledPublishDate?: (string) | null;
+    scheduledUnpublishDate?: (string) | null;
 };
 
 export enum DocumentVariantStateModel {

src/Umbraco.Web.UI.Client/src/mocks/data/user/user.db.ts

@@ -86,6 +86,7 @@ class UmbUserMockDB extends UmbEntityMockDbBase<UmbMockUserModel> {
 			permissions,
 			allowedSections,
 			isAdmin: firstUser.isAdmin,
+			userGroupIds: firstUser.userGroupIds,
 		};
 	}
 

src/Umbraco.Web.UI.Client/src/packages/core/utils/string/string-or-string-array-contains/string-or-string-array-contains.function.ts

@@ -7,3 +7,17 @@
 export function stringOrStringArrayContains(value: string | Array<string>, search: string): boolean {
 	return Array.isArray(value) ? value.indexOf(search) !== -1 : value === search;
 }
+
+/**
+ * Check if a string or array of strings intersects with another array of strings
+ * @param value The string or array of strings to search in
+ * @param search The array of strings to search for
+ * @returns {boolean} Whether the string or array of strings intersects with the search array
+ */
+export function stringOrStringArrayIntersects(value: string | Array<string>, search: Array<string>): boolean {
+	if (Array.isArray(value)) {
+		return value.some((v) => search.indexOf(v) !== -1);
+	} else {
+		return search.indexOf(value) !== -1;
+	}
+}

src/Umbraco.Web.UI.Client/src/packages/user/current-user/conditions/constants.ts

@@ -1 +1,2 @@
+export * from './group-id/constants.js';
 export * from './is-admin/constants.js';

src/Umbraco.Web.UI.Client/src/packages/user/current-user/conditions/group-id/constants.ts

@@ -0,0 +1 @@
+export const UMB_CURRENT_USER_GROUP_ID_CONDITION_ALIAS = 'Umb.Condition.CurrentUser.GroupId';

src/Umbraco.Web.UI.Client/src/packages/user/current-user/conditions/group-id/group-id.condition-config.ts

@@ -0,0 +1,35 @@
+import type { UMB_CURRENT_USER_GROUP_ID_CONDITION_ALIAS } from './constants.js';
+import type { UmbConditionConfigBase } from '@umbraco-cms/backoffice/extension-api';
+
+export interface UmbCurrentUserGroupIdConditionConfig
+	extends UmbConditionConfigBase<typeof UMB_CURRENT_USER_GROUP_ID_CONDITION_ALIAS> {
+	/**
+	 * The user group that the current user must be a member of to pass the condition.
+	 * @examples ['guid1']
+	 */
+	match?: string;
+
+	/**
+	 * The user group(s) that the current user must be a member of to pass the condition.
+	 * @examples [['guid1', 'guid2']]
+	 */
+	oneOf?: Array<string>;
+
+	/**
+	 * The user groups that the current user must be a member of to pass the condition.
+	 * @examples [['guid1', 'guid2']]
+	 */
+	allOf?: Array<string>;
+
+	/**
+	 * The user group(s) that the current user must not be a member of to pass the condition.
+	 * @examples [['guid1', 'guid2']]
+	 */
+	noneOf?: Array<string>;
+}
+
+declare global {
+	interface UmbExtensionConditionConfigMap {
+		UmbCurrentUserGroupIdConditionConfig: UmbCurrentUserGroupIdConditionConfig;
+	}
+}

src/Umbraco.Web.UI.Client/src/packages/user/current-user/conditions/group-id/group-id.condition.manifest.ts

@@ -0,0 +1,9 @@
+import { UMB_CURRENT_USER_GROUP_ID_CONDITION_ALIAS } from './constants.js';
+import type { ManifestCondition } from '@umbraco-cms/backoffice/extension-api';
+
+export const manifest: ManifestCondition = {
+	type: 'condition',
+	name: 'Current user group id Condition',
+	alias: UMB_CURRENT_USER_GROUP_ID_CONDITION_ALIAS,
+	api: () => import('./group-id.condition.js'),
+};

src/Umbraco.Web.UI.Client/src/packages/user/current-user/conditions/group-id/group-id.condition.ts

@@ -0,0 +1,51 @@
+import { UMB_CURRENT_USER_CONTEXT } from '../../current-user.context.token.js';
+import type { UmbCurrentUserModel } from '../../types.js';
+import type { UmbCurrentUserGroupIdConditionConfig } from './types.js';
+import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import type { UmbConditionControllerArguments, UmbExtensionCondition } from '@umbraco-cms/backoffice/extension-api';
+import { UmbConditionBase } from '@umbraco-cms/backoffice/extension-registry';
+
+export class UmbCurrentUserGroupCondition
+	extends UmbConditionBase<UmbCurrentUserGroupIdConditionConfig>
+	implements UmbExtensionCondition
+{
+	constructor(host: UmbControllerHost, args: UmbConditionControllerArguments<UmbCurrentUserGroupIdConditionConfig>) {
+		super(host, args);
+
+		this.consumeContext(UMB_CURRENT_USER_CONTEXT, (context) => {
+			this.observe(context.currentUser, this.observeCurrentUser, 'umbCurrentUserGroupConditionObserver');
+		});
+	}
+
+	private observeCurrentUser = async (currentUser: UmbCurrentUserModel) => {
+		// Idea: This part could be refactored to become a shared util, to align these matching feature across conditions. [NL]
+		// Notice doing so it would be interesting to invistigate if it makes sense to combine some of these properties, to enable more specific matching. (But maybe it is only relevant for the combination of match + oneOf) [NL]
+		const { match, oneOf, allOf, noneOf } = this.config;
+
+		if (match) {
+			this.permitted = currentUser.userGroupUniques.includes(match);
+			return;
+		}
+
+		if (oneOf) {
+			this.permitted = oneOf.some((v) => currentUser.userGroupUniques.includes(v));
+			return;
+		}
+
+		if (allOf) {
+			this.permitted = allOf.every((v) => currentUser.userGroupUniques.includes(v));
+			return;
+		}
+
+		if (noneOf) {
+			if (noneOf.some((v) => currentUser.userGroupUniques.includes(v))) {
+				this.permitted = false;
+				return;
+			}
+		}
+
+		this.permitted = true;
+	};
+}
+
+export { UmbCurrentUserGroupCondition as api };