From 6c6494c1369d6ef4f247b6309afedabe3257f971 Mon Sep 17 00:00:00 2001 From: Sebastian Date: Fri, 7 Jun 2019 08:57:16 +0200 Subject: [PATCH 01/64] Test --- src/Squidex.Web/Extensions.cs | 8 ++ src/Squidex.Web/PermissionExtensions.cs | 77 +++++++++++++++++++ src/Squidex.Web/Resource.cs | 52 +++++++++++++ src/Squidex.Web/ResourceLink.cs | 23 ++++++ src/Squidex.Web/UrlHelperExtensions.cs | 46 +++++++++++ .../Api/Controllers/Users/Models/UserDto.cs | 53 ++++++++++++- .../Api/Controllers/Users/Models/UsersDto.cs | 34 +++++++- .../Users/UserManagementController.cs | 22 +----- .../Api/Controllers/Users/UsersController.cs | 4 +- .../pages/users/user-page.component.html | 2 +- .../pages/users/user-page.component.ts | 6 +- .../pages/users/users-page.component.html | 30 +++----- .../administration/services/users.service.ts | 31 +++++--- .../administration/state/users.state.spec.ts | 49 +++++------- .../administration/state/users.state.ts | 57 ++++---------- .../framework/angular/http/hateos.pipes.ts | 23 ++++++ src/Squidex/app/framework/declarations.ts | 1 + src/Squidex/app/framework/internal.ts | 1 + src/Squidex/app/framework/module.ts | 6 ++ src/Squidex/app/framework/utils/hateos.ts | 25 ++++++ 20 files changed, 419 insertions(+), 131 deletions(-) create mode 100644 src/Squidex.Web/PermissionExtensions.cs create mode 100644 src/Squidex.Web/Resource.cs create mode 100644 src/Squidex.Web/ResourceLink.cs create mode 100644 src/Squidex.Web/UrlHelperExtensions.cs create mode 100644 src/Squidex/app/framework/angular/http/hateos.pipes.ts create mode 100644 src/Squidex/app/framework/utils/hateos.ts diff --git a/src/Squidex.Web/Extensions.cs b/src/Squidex.Web/Extensions.cs index b7f7594bf..4ab57d830 100644 --- a/src/Squidex.Web/Extensions.cs +++ b/src/Squidex.Web/Extensions.cs @@ -5,6 +5,7 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== +using System; using System.Security.Claims; using Squidex.Infrastructure.Security; @@ -40,5 +41,12 @@ namespace Squidex.Web return (null, null); } + + public static bool IsUser(this ApiController controller, string userId) + { + var subject = controller.User.OpenIdSubject(); + + return string.Equals(subject, userId, StringComparison.OrdinalIgnoreCase); + } } } diff --git a/src/Squidex.Web/PermissionExtensions.cs b/src/Squidex.Web/PermissionExtensions.cs new file mode 100644 index 000000000..6dc7d0610 --- /dev/null +++ b/src/Squidex.Web/PermissionExtensions.cs @@ -0,0 +1,77 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschränkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +using Microsoft.AspNetCore.Http; +using Squidex.Infrastructure.Security; +using Squidex.Shared; +using Squidex.Shared.Identity; + +namespace Squidex.Web +{ + public static class PermissionExtensions + { + private sealed class PermissionFeature + { + public PermissionSet Permissions { get; } + + public PermissionFeature(PermissionSet permissions) + { + Permissions = permissions; + } + } + + public static PermissionSet GetPermissions(this HttpContext httpContext) + { + var feature = httpContext.Features.Get(); + + if (feature == null) + { + feature = new PermissionFeature(httpContext.User.Permissions()); + + httpContext.Features.Set(feature); + } + + return feature.Permissions; + } + + public static bool HasPermission(this HttpContext httpContext, Permission permission) + { + return httpContext.GetPermissions().Includes(permission); + } + + public static bool HasPermission(this HttpContext httpContext, string id, string app = "*", string schema = "*") + { + return httpContext.GetPermissions().Includes(Permissions.ForApp(id, app, schema)); + } + + public static bool HasPermission(this ApiController controller, Permission permission) + { + return controller.HttpContext.GetPermissions().Includes(permission); + } + + public static bool HasPermission(this ApiController controller, string id, string app = "*", string schema = "*") + { + if (app == "*") + { + if (controller.RouteData.Values.TryGetValue("app", out var value) && value is string s) + { + app = s; + } + } + + if (schema == "*") + { + if (controller.RouteData.Values.TryGetValue("name", out var value) && value is string s) + { + schema = s; + } + } + + return controller.HttpContext.GetPermissions().Includes(Permissions.ForApp(id, app, schema)); + } + } +} diff --git a/src/Squidex.Web/Resource.cs b/src/Squidex.Web/Resource.cs new file mode 100644 index 000000000..b62a5f361 --- /dev/null +++ b/src/Squidex.Web/Resource.cs @@ -0,0 +1,52 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschränkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +using Newtonsoft.Json; +using System.Collections.Generic; +using System.ComponentModel.DataAnnotations; +using System.Net.Http; + +namespace Squidex.Web +{ + public abstract class Resource + { + [JsonProperty("_links")] + [Required] + [Display(Description = "The links.")] + public Dictionary Links { get; } = new Dictionary(); + + public void AddSelfLink(string href) + { + AddGetLink("self", href); + } + + public void AddGetLink(string rel, string href) + { + AddLink(rel, HttpMethod.Get, href); + } + + public void AddPostLink(string rel, string href) + { + AddLink(rel, HttpMethod.Post, href); + } + + public void AddPutLink(string rel, string href) + { + AddLink(rel, HttpMethod.Put, href); + } + + public void AddDeleteLink(string rel, string href) + { + AddLink(rel, HttpMethod.Delete, href); + } + + public void AddLink(string rel, HttpMethod method, string href) + { + Links[rel] = new ResourceLink { Href = href, Method = method }; + } + } +} diff --git a/src/Squidex.Web/ResourceLink.cs b/src/Squidex.Web/ResourceLink.cs new file mode 100644 index 000000000..48627ac3a --- /dev/null +++ b/src/Squidex.Web/ResourceLink.cs @@ -0,0 +1,23 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschränkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +using System.ComponentModel.DataAnnotations; +using System.Net.Http; + +namespace Squidex.Web +{ + public class ResourceLink + { + [Required] + [Display(Description = "The link url.")] + public string Href { get; set; } + + [Required] + [Display(Description = "The link method.")] + public HttpMethod Method { get; set; } + } +} diff --git a/src/Squidex.Web/UrlHelperExtensions.cs b/src/Squidex.Web/UrlHelperExtensions.cs new file mode 100644 index 000000000..486d48a76 --- /dev/null +++ b/src/Squidex.Web/UrlHelperExtensions.cs @@ -0,0 +1,46 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschränkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +using Microsoft.AspNetCore.Mvc; +using System; +using System.Linq.Expressions; +using System.Reflection; + +namespace Squidex.Web +{ + public static class UrlHelperExtensions + { + private static class NameOf + { + public static readonly string Controller; + + static NameOf() + { + const string suffix = "Controller"; + + var name = typeof(T).Name; + + if (name.EndsWith(suffix)) + { + name = name.Substring(0, name.Length - suffix.Length); + } + + Controller = name; + } + } + + public static string Url(this IUrlHelper urlHelper, Func action, object values = null) where T : Controller + { + return urlHelper.Action(action(null), NameOf.Controller, values); + } + + public static string Url(this Controller controller, Func action, object values = null) where T : Controller + { + return controller.Url.Url(action, values); + } + } +} diff --git a/src/Squidex/Areas/Api/Controllers/Users/Models/UserDto.cs b/src/Squidex/Areas/Api/Controllers/Users/Models/UserDto.cs index 8a2a5a2d4..2481f73c8 100644 --- a/src/Squidex/Areas/Api/Controllers/Users/Models/UserDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Users/Models/UserDto.cs @@ -8,12 +8,18 @@ using System.Collections.Generic; using System.ComponentModel.DataAnnotations; using Squidex.Infrastructure.Reflection; +using Squidex.Infrastructure.Security; using Squidex.Shared.Users; +using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Users.Models { - public sealed class UserDto + public sealed class UserDto : Resource { + private static readonly Permission LockPermission = new Permission(Shared.Permissions.AdminUsersLock); + private static readonly Permission UnlockPermission = new Permission(Shared.Permissions.AdminUsersUnlock); + private static readonly Permission UpdatePermission = new Permission(Shared.Permissions.AdminUsersUpdate); + /// /// The id of the user. /// @@ -44,11 +50,50 @@ namespace Squidex.Areas.Api.Controllers.Users.Models [Required] public IEnumerable Permissions { get; set; } - public static UserDto FromUser(IUser user) + public static UserDto FromUser(IUser user, ApiController controller) + { + var userPermssions = user.Permissions().ToIds(); + var userName = user.DisplayName(); + + var result = SimpleMapper.Map(user, new UserDto { DisplayName = userName, Permissions = userPermssions }); + + return CreateLinks(result, controller); + } + + private static UserDto CreateLinks(UserDto result, ApiController controller) { - var permissions = user.Permissions().ToIds(); + var values = new { id = result.Id }; + + if (controller is UserManagementController) + { + result.AddSelfLink(controller.Url(c => nameof(c.GetUser), values)); + } + else + { + result.AddSelfLink(controller.Url(c => nameof(c.GetUser), values)); + } + + if (!controller.IsUser(result.Id)) + { + if (controller.HasPermission(LockPermission) && !result.IsLocked) + { + result.AddPutLink("lock", controller.Url(c => nameof(c.LockUser), values)); + } + + if (controller.HasPermission(UnlockPermission) && result.IsLocked) + { + result.AddPutLink("unlock", controller.Url(c => nameof(c.UnlockUser), values)); + } + } + + if (controller.HasPermission(UpdatePermission)) + { + result.AddPutLink("update", controller.Url(c => nameof(c.PutUser), values)); + } + + result.AddGetLink("picture", controller.Url(c => nameof(c.GetUserPicture), values)); - return SimpleMapper.Map(user, new UserDto { DisplayName = user.DisplayName(), Permissions = permissions }); + return result; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Users/Models/UsersDto.cs b/src/Squidex/Areas/Api/Controllers/Users/Models/UsersDto.cs index 2d83ff47d..e866c8af4 100644 --- a/src/Squidex/Areas/Api/Controllers/Users/Models/UsersDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Users/Models/UsersDto.cs @@ -5,10 +5,19 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== +using System.Collections.Generic; +using System.Linq; +using Squidex.Domain.Users; +using Squidex.Infrastructure.Security; +using Squidex.Shared; +using Squidex.Web; + namespace Squidex.Areas.Api.Controllers.Users.Models { - public sealed class UsersDto + public sealed class UsersDto : Resource { + private static readonly Permission CreatePermissions = new Permission(Permissions.AdminUsersCreate); + /// /// The total number of users. /// @@ -18,5 +27,28 @@ namespace Squidex.Areas.Api.Controllers.Users.Models /// The users. /// public UserDto[] Items { get; set; } + + public static UsersDto FromResults(IEnumerable items, long total, ApiController controller) + { + var result = new UsersDto + { + Total = total, + Items = items.Select(x => UserDto.FromUser(x, controller)).ToArray() + }; + + return CreateLinks(result, controller); + } + + private static UsersDto CreateLinks(UsersDto result, ApiController controller) + { + result.AddSelfLink(controller.Url(c => nameof(c.GetUsers))); + + if (controller.HasPermission(CreatePermissions)) + { + result.AddPostLink("create", controller.Url(c => nameof(c.PostUser))); + } + + return result; + } } } diff --git a/src/Squidex/Areas/Api/Controllers/Users/UserManagementController.cs b/src/Squidex/Areas/Api/Controllers/Users/UserManagementController.cs index 7d547be14..16862daab 100644 --- a/src/Squidex/Areas/Api/Controllers/Users/UserManagementController.cs +++ b/src/Squidex/Areas/Api/Controllers/Users/UserManagementController.cs @@ -5,8 +5,6 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== -using System; -using System.Linq; using System.Threading.Tasks; using Microsoft.AspNetCore.Identity; using Microsoft.AspNetCore.Mvc; @@ -14,7 +12,6 @@ using Squidex.Areas.Api.Controllers.Users.Models; using Squidex.Domain.Users; using Squidex.Infrastructure; using Squidex.Infrastructure.Commands; -using Squidex.Infrastructure.Security; using Squidex.Shared; using Squidex.Web; @@ -43,11 +40,7 @@ namespace Squidex.Areas.Api.Controllers.Users await Task.WhenAll(taskForItems, taskForCount); - var response = new UsersDto - { - Total = taskForCount.Result, - Items = taskForItems.Result.Select(UserDto.FromUser).ToArray() - }; + var response = UsersDto.FromResults(taskForItems.Result, taskForCount.Result, this); return Ok(response); } @@ -64,7 +57,7 @@ namespace Squidex.Areas.Api.Controllers.Users return NotFound(); } - var response = UserDto.FromUser(entity); + var response = UserDto.FromUser(entity, this); return Ok(response); } @@ -96,7 +89,7 @@ namespace Squidex.Areas.Api.Controllers.Users [ApiPermission(Permissions.AdminUsersLock)] public async Task LockUser(string id) { - if (IsSelf(id)) + if (this.IsUser(id)) { throw new ValidationException("Locking user failed.", new ValidationError("You cannot lock yourself.")); } @@ -111,7 +104,7 @@ namespace Squidex.Areas.Api.Controllers.Users [ApiPermission(Permissions.AdminUsersUnlock)] public async Task UnlockUser(string id) { - if (IsSelf(id)) + if (this.IsUser(id)) { throw new ValidationException("Unlocking user failed.", new ValidationError("You cannot unlock yourself.")); } @@ -120,12 +113,5 @@ namespace Squidex.Areas.Api.Controllers.Users return NoContent(); } - - private bool IsSelf(string id) - { - var subject = User.OpenIdSubject(); - - return string.Equals(subject, id, StringComparison.OrdinalIgnoreCase); - } } } diff --git a/src/Squidex/Areas/Api/Controllers/Users/UsersController.cs b/src/Squidex/Areas/Api/Controllers/Users/UsersController.cs index 36c556adb..5311ff642 100644 --- a/src/Squidex/Areas/Api/Controllers/Users/UsersController.cs +++ b/src/Squidex/Areas/Api/Controllers/Users/UsersController.cs @@ -76,7 +76,7 @@ namespace Squidex.Areas.Api.Controllers.Users { var entities = await userResolver.QueryByEmailAsync(query); - var models = entities.Where(x => !x.IsHidden()).Select(UserDto.FromUser).ToArray(); + var models = entities.Where(x => !x.IsHidden()).Select(x => UserDto.FromUser(x, this)).ToArray(); return Ok(models); } @@ -110,7 +110,7 @@ namespace Squidex.Areas.Api.Controllers.Users if (entity != null) { - var response = UserDto.FromUser(entity); + var response = UserDto.FromUser(entity, this); return Ok(response); } diff --git a/src/Squidex/app/features/administration/pages/users/user-page.component.html b/src/Squidex/app/features/administration/pages/users/user-page.component.html index b9d1bdb51..d23721240 100644 --- a/src/Squidex/app/features/administration/pages/users/user-page.component.html +++ b/src/Squidex/app/features/administration/pages/users/user-page.component.html @@ -50,7 +50,7 @@ -
+
diff --git a/src/Squidex/app/features/administration/pages/users/user-page.component.ts b/src/Squidex/app/features/administration/pages/users/user-page.component.ts index 0c7e1efc2..9a7e9b71a 100644 --- a/src/Squidex/app/features/administration/pages/users/user-page.component.ts +++ b/src/Squidex/app/features/administration/pages/users/user-page.component.ts @@ -26,7 +26,7 @@ import { export class UserPageComponent extends ResourceOwner implements OnInit { public canUpdate = false; - public user?: { user: UserDto, isCurrentUser: boolean }; + public user?: UserDto; public userForm = new UserForm(this.formBuilder); constructor( @@ -45,7 +45,7 @@ export class UserPageComponent extends ResourceOwner implements OnInit { this.user = selectedUser!; if (selectedUser) { - this.userForm.load(selectedUser.user); + this.userForm.load(selectedUser); } })); } @@ -55,7 +55,7 @@ export class UserPageComponent extends ResourceOwner implements OnInit { if (value) { if (this.user) { - this.usersState.update(this.user.user, value) + this.usersState.update(this.user, value) .subscribe(() => { this.userForm.submitCompleted(); }, error => { diff --git a/src/Squidex/app/features/administration/pages/users/users-page.component.html b/src/Squidex/app/features/administration/pages/users/users-page.component.html index 223f584bf..167ee3eb9 100644 --- a/src/Squidex/app/features/administration/pages/users/users-page.component.html +++ b/src/Squidex/app/features/administration/pages/users/users-page.component.html @@ -48,32 +48,24 @@
- - + + diff --git a/src/Squidex/app/features/administration/services/users.service.ts b/src/Squidex/app/features/administration/services/users.service.ts index a657eee38..b42fe46a2 100644 --- a/src/Squidex/app/features/administration/services/users.service.ts +++ b/src/Squidex/app/features/administration/services/users.service.ts @@ -14,12 +14,19 @@ import { ApiUrlConfig, Model, pretifyError, - ResultSet + Resource, + ResourceLinks, + ResultSet, + withLinks } from '@app/shared'; -export class UsersDto extends ResultSet {} +export class UsersDto extends ResultSet { + public _links: ResourceLinks; +} export class UserDto extends Model { + public _links: ResourceLinks; + constructor( public readonly id: string, public readonly email: string, @@ -60,17 +67,19 @@ export class UsersService { public getUsers(take: number, skip: number, query?: string): Observable { const url = this.apiUrl.buildUrl(`api/user-management?take=${take}&skip=${skip}&query=${query || ''}`); - return this.http.get<{ total: number, items: any[] }>(url).pipe( + return this.http.get<{ total: number, items: any[] } & Resource>(url).pipe( map(body => { const users = body.items.map(item => - new UserDto( - item.id, - item.email, - item.displayName, - item.permissions, - item.isLocked)); - - return new UsersDto(body.total, users); + withLinks( + new UserDto( + item.id, + item.email, + item.displayName, + item.permissions, + item.isLocked), + item)); + + return withLinks(new UsersDto(body.total, users), body); }), pretifyError('Failed to load users. Please reload.')); } diff --git a/src/Squidex/app/features/administration/state/users.state.spec.ts b/src/Squidex/app/features/administration/state/users.state.spec.ts index c2a912ecd..e735870a5 100644 --- a/src/Squidex/app/features/administration/state/users.state.spec.ts +++ b/src/Squidex/app/features/administration/state/users.state.spec.ts @@ -16,7 +16,7 @@ import { UsersService } from '@app/features/administration/internal'; -import { SnapshotUser, UsersState } from './users.state'; +import { UsersState } from './users.state'; describe('UsersState', () => { const oldUsers = [ @@ -26,21 +26,15 @@ describe('UsersState', () => { const newUser = new UserDto('id3', 'mail3@mail.de', 'name3', ['Permission3'], false); - let authService: IMock; let dialogs: IMock; let usersService: IMock; let usersState: UsersState; beforeEach(() => { - authService = Mock.ofType(); - - authService.setup(x => x.user) - .returns(() => { id: 'id2' }); - dialogs = Mock.ofType(); usersService = Mock.ofType(); - usersState = new UsersState(authService.object, dialogs.object, usersService.object); + usersState = new UsersState(dialogs.object, usersService.object); }); afterEach(() => { @@ -54,10 +48,7 @@ describe('UsersState', () => { usersState.load().subscribe(); - expect(usersState.snapshot.users.values).toEqual([ - { isCurrentUser: false, user: oldUsers[0] }, - { isCurrentUser: true, user: oldUsers[1] } - ]); + expect(usersState.snapshot.users.values).toEqual(oldUsers); expect(usersState.snapshot.usersPager.numberOfItems).toEqual(200); expect(usersState.snapshot.isLoaded).toBeTruthy(); @@ -91,7 +82,7 @@ describe('UsersState', () => { usersState.select('id1').subscribe(); usersState.load().subscribe(); - expect(usersState.snapshot.selectedUser).toEqual({ isCurrentUser: false, user: newUsers[0] }); + expect(usersState.snapshot.selectedUser).toEqual(newUsers[0]); }); it('should load next page and prev page when paging', () => { @@ -127,32 +118,32 @@ describe('UsersState', () => { }); it('should return user on select and not load when already loaded', () => { - let selectedUser: SnapshotUser; + let selectedUser: UserDto; usersState.select('id1').subscribe(x => { selectedUser = x!; }); - expect(selectedUser!.user).toEqual(oldUsers[0]); - expect(usersState.snapshot.selectedUser).toEqual({ isCurrentUser: false, user: oldUsers[0] }); + expect(selectedUser!).toEqual(oldUsers[0]); + expect(usersState.snapshot.selectedUser).toEqual(oldUsers[0]); }); it('should return user on select and load when not loaded', () => { usersService.setup(x => x.getUser('id3')) .returns(() => of(newUser)); - let selectedUser: SnapshotUser; + let selectedUser: UserDto; usersState.select('id3').subscribe(x => { selectedUser = x!; }); - expect(selectedUser!.user).toEqual(newUser); - expect(usersState.snapshot.selectedUser).toEqual({ isCurrentUser: false, user: newUser }); + expect(selectedUser!).toEqual(newUser); + expect(usersState.snapshot.selectedUser).toEqual(newUser); }); it('should return null on select when unselecting user', () => { - let selectedUser: SnapshotUser; + let selectedUser: UserDto; usersState.select(null).subscribe(x => { selectedUser = x!; @@ -166,7 +157,7 @@ describe('UsersState', () => { usersService.setup(x => x.getUser('unknown')) .returns(() => throwError({})).verifiable(); - let selectedUser: SnapshotUser; + let selectedUser: UserDto; usersState.select('unknown').subscribe(x => { selectedUser = x!; @@ -185,7 +176,7 @@ describe('UsersState', () => { const user_1 = usersState.snapshot.users.at(0); - expect(user_1.user.isLocked).toBeTruthy(); + expect(user_1.isLocked).toBeTruthy(); expect(user_1).toBe(usersState.snapshot.selectedUser!); }); @@ -198,7 +189,7 @@ describe('UsersState', () => { const user_1 = usersState.snapshot.users.at(1); - expect(user_1.user.isLocked).toBeFalsy(); + expect(user_1.isLocked).toBeFalsy(); expect(user_1).toBe(usersState.snapshot.selectedUser!); }); @@ -213,9 +204,9 @@ describe('UsersState', () => { const user_1 = usersState.snapshot.users.at(0); - expect(user_1.user.email).toEqual(request.email); - expect(user_1.user.displayName).toEqual(request.displayName); - expect(user_1.user.permissions).toEqual(request.permissions); + expect(user_1.email).toEqual(request.email); + expect(user_1.displayName).toEqual(request.displayName); + expect(user_1.permissions).toEqual(request.permissions); expect(user_1).toBe(usersState.snapshot.selectedUser!); }); @@ -227,11 +218,7 @@ describe('UsersState', () => { usersState.create(request).subscribe(); - expect(usersState.snapshot.users.values).toEqual([ - { isCurrentUser: false, user: newUser }, - { isCurrentUser: false, user: oldUsers[0] }, - { isCurrentUser: true, user: oldUsers[1] } - ]); + expect(usersState.snapshot.users.values).toEqual([newUser, ...oldUsers]); expect(usersState.snapshot.usersPager.numberOfItems).toBe(201); }); }); diff --git a/src/Squidex/app/features/administration/state/users.state.ts b/src/Squidex/app/features/administration/state/users.state.ts index 7de907b24..49c5163cc 100644 --- a/src/Squidex/app/features/administration/state/users.state.ts +++ b/src/Squidex/app/features/administration/state/users.state.ts @@ -7,12 +7,11 @@ import { Injectable } from '@angular/core'; import { Observable, of } from 'rxjs'; -import { catchError, distinctUntilChanged, map, tap } from 'rxjs/operators'; +import { catchError, distinctUntilChanged, map, switchMap, tap } from 'rxjs/operators'; import '@app/framework/utils/rxjs-extensions'; import { - AuthService, DialogService, ImmutableArray, Pager, @@ -27,14 +26,6 @@ import { UsersService } from './../services/users.service'; -export interface SnapshotUser { - // The user. - user: UserDto; - - // Indicates if the user is the current user. - isCurrentUser: boolean; -} - interface Snapshot { // The current users. users: UsersList; @@ -49,10 +40,10 @@ interface Snapshot { isLoaded?: boolean; // The selected user. - selectedUser?: SnapshotUser | null; + selectedUser?: UserDto | null; } -export type UsersList = ImmutableArray; +export type UsersList = ImmutableArray; export type UsersResult = { total: number, users: UsersList }; @Injectable() @@ -74,14 +65,13 @@ export class UsersState extends State { distinctUntilChanged()); constructor( - private readonly authState: AuthService, private readonly dialogs: DialogService, private readonly usersService: UsersService ) { super({ users: ImmutableArray.empty(), usersPager: new Pager(0) }); } - public select(id: string | null): Observable { + public select(id: string | null): Observable { return this.loadUser(id).pipe( tap(selectedUser => { this.next(s => ({ ...s, selectedUser })); @@ -94,13 +84,13 @@ export class UsersState extends State { return of(null); } - const found = this.snapshot.users.find(x => x.user.id === id); + const found = this.snapshot.users.find(x => x.id === id); if (found) { return of(found); } - return this.usersService.getUser(id).pipe(map(x => this.createUser(x)), catchError(() => of(null))); + return this.usersService.getUser(id).pipe(catchError(() => of(null))); } public load(isReload = false): Observable { @@ -125,12 +115,12 @@ export class UsersState extends State { this.next(s => { const usersPager = s.usersPager.setCount(total); - const users = ImmutableArray.of(items.map(x => this.createUser(x))); + const users = ImmutableArray.of(items); let selectedUser = s.selectedUser; if (selectedUser) { - selectedUser = users.find(x => x.user.id === selectedUser!.user.id) || selectedUser; + selectedUser = users.find(x => x.id === selectedUser!.id) || selectedUser; } return { ...s, users, usersPager, selectedUser, isLoaded: true }; @@ -143,7 +133,7 @@ export class UsersState extends State { return this.usersService.postUser(request).pipe( tap(created => { this.next(s => { - const users = s.users.pushFront(this.createUser(created)); + const users = s.users.pushFront(created); const usersPager = s.usersPager.incrementCount(); return { ...s, users, usersPager }; @@ -154,7 +144,7 @@ export class UsersState extends State { public update(user: UserDto, request: UpdateUserDto): Observable { return this.usersService.putUser(user.id, request).pipe( - map(() => update(user, request)), + switchMap(() => this.usersService.getUser(user.id)), tap(updated => { this.replaceUser(updated); }), @@ -163,7 +153,7 @@ export class UsersState extends State { public lock(user: UserDto): Observable { return this.usersService.lockUser(user.id).pipe( - map(() => setLocked(user, true)), + switchMap(() => this.usersService.getUser(user.id)), tap(updated => { this.replaceUser(updated); }), @@ -172,7 +162,7 @@ export class UsersState extends State { public unlock(user: UserDto): Observable { return this.usersService.unlockUser(user.id).pipe( - map(() => setLocked(user, false)), + switchMap(() => this.usersService.getUser(user.id)), tap(updated => { this.replaceUser(updated); }), @@ -199,30 +189,15 @@ export class UsersState extends State { private replaceUser(user: UserDto) { return this.next(s => { - const users = s.users.map(u => u.user.id === user.id ? this.createUser(user) : u); + const users = s.users.map(u => u.id === user.id ? user : u); const selectedUser = s.selectedUser && - s.selectedUser.user.id !== user.id ? + s.selectedUser.id !== user.id ? s.selectedUser : - users.find(x => x.user.id === user.id); + users.find(x => x.id === user.id); return { ...s, users, selectedUser }; }); } - - private get userId() { - return this.authState.user!.id; - } - - private createUser(user: UserDto): SnapshotUser { - return { user, isCurrentUser: user.id === this.userId }; - } -} - - -const update = (user: UserDto, request: UpdateUserDto) => - user.with(request); - -const setLocked = (user: UserDto, isLocked: boolean) => - user.with({ isLocked }); \ No newline at end of file +} \ No newline at end of file diff --git a/src/Squidex/app/framework/angular/http/hateos.pipes.ts b/src/Squidex/app/framework/angular/http/hateos.pipes.ts new file mode 100644 index 000000000..979c95205 --- /dev/null +++ b/src/Squidex/app/framework/angular/http/hateos.pipes.ts @@ -0,0 +1,23 @@ +import { Pipe, PipeTransform } from '@angular/core'; + +import { Resource } from '@app/framework/internal'; + +@Pipe({ + name: 'sqxHasLink', + pure: true +}) +export class HasLinkPipe implements PipeTransform { + public transform(value: Resource, rel: string) { + return value._links && !!value._links[rel]; + } +} + +@Pipe({ + name: 'sqxHasNoLink', + pure: true +}) +export class HasNoLinkPipe implements PipeTransform { + public transform(value: Resource, rel: string) { + return !value._links || !value._links[rel]; + } +} \ No newline at end of file diff --git a/src/Squidex/app/framework/declarations.ts b/src/Squidex/app/framework/declarations.ts index 7111dde33..5cf90253c 100644 --- a/src/Squidex/app/framework/declarations.ts +++ b/src/Squidex/app/framework/declarations.ts @@ -31,6 +31,7 @@ export * from './angular/forms/validators'; export * from './angular/http/caching.interceptor'; export * from './angular/http/loading.interceptor'; +export * from './angular/http/hateos.pipes'; export * from './angular/http/http-extensions'; export * from './angular/modals/dialog-renderer.component'; diff --git a/src/Squidex/app/framework/internal.ts b/src/Squidex/app/framework/internal.ts index 776e7df49..73b658619 100644 --- a/src/Squidex/app/framework/internal.ts +++ b/src/Squidex/app/framework/internal.ts @@ -23,6 +23,7 @@ export * from './utils/date-helper'; export * from './utils/date-time'; export * from './utils/duration'; export * from './utils/error'; +export * from './utils/hateos'; export * from './utils/interpolator'; export * from './utils/immutable-array'; export * from './utils/math-helper'; diff --git a/src/Squidex/app/framework/module.ts b/src/Squidex/app/framework/module.ts index 5921bf736..b18aad34b 100644 --- a/src/Squidex/app/framework/module.ts +++ b/src/Squidex/app/framework/module.ts @@ -42,6 +42,8 @@ import { FormHintComponent, FromNowPipe, FullDateTimePipe, + HasLinkPipe, + HasNoLinkPipe, HoverBackgroundDirective, IFrameEditorComponent, IgnoreScrollbarDirective, @@ -122,6 +124,8 @@ import { FormHintComponent, FromNowPipe, FullDateTimePipe, + HasLinkPipe, + HasNoLinkPipe, HoverBackgroundDirective, IFrameEditorComponent, IgnoreScrollbarDirective, @@ -188,6 +192,8 @@ import { FormsModule, FromNowPipe, FullDateTimePipe, + HasLinkPipe, + HasNoLinkPipe, HoverBackgroundDirective, IFrameEditorComponent, IgnoreScrollbarDirective, diff --git a/src/Squidex/app/framework/utils/hateos.ts b/src/Squidex/app/framework/utils/hateos.ts new file mode 100644 index 000000000..14e5357d8 --- /dev/null +++ b/src/Squidex/app/framework/utils/hateos.ts @@ -0,0 +1,25 @@ +/* + * Squidex Headless CMS + * + * @license + * Copyright (c) Squidex UG (haftungsbeschränkt). All rights reserved. + */ + + export interface Resource { + _links?: { [rel: string]: ResourceLink }; + } + + export type ResourceLinks = { [rel: string]: ResourceLink }; + export type ResourceLink = { href: string; method: ResourceMethod; }; + + export function withLinks(value: T, source: Resource) { + value._links = source._links; + + return value; + } + + export type ResourceMethod = + 'get' | + 'post' | + 'put' | + 'delete'; \ No newline at end of file From ca77b20d6ad0029089bf250dad73b91cb89a156b Mon Sep 17 00:00:00 2001 From: Sebastian Date: Fri, 7 Jun 2019 15:56:49 +0200 Subject: [PATCH 02/64] HATEOS for users. --- .../UserManagerExtensions.cs | 16 +- src/Squidex.Web/Resource.cs | 15 +- src/Squidex.Web/ResourceLink.cs | 3 +- .../Contents/ContentsController.cs | 4 +- .../Controllers/Users/Models/CreateUserDto.cs | 8 +- .../Controllers/Users/Models/PublicUserDto.cs | 26 ---- .../Controllers/Users/Models/UpdateUserDto.cs | 8 +- .../Users/Models/UserCreatedDto.cs | 26 ---- .../Users/UserManagementController.cs | 28 +++- .../Api/Controllers/Users/UsersController.cs | 8 +- .../guards/user-must-exist.guard.spec.ts | 4 +- .../pages/users/user-page.component.html | 14 +- .../pages/users/user-page.component.ts | 10 +- .../pages/users/users-page.component.html | 11 +- .../pages/users/users-page.component.ts | 4 +- .../services/users.service.spec.ts | 139 +++++++++++------- .../administration/services/users.service.ts | 84 ++++++----- .../administration/state/users.state.spec.ts | 88 +++++------ .../administration/state/users.state.ts | 25 ++-- .../framework/angular/http/hateos.pipes.ts | 23 ++- src/Squidex/app/framework/utils/hateos.ts | 47 ++++-- 21 files changed, 330 insertions(+), 261 deletions(-) delete mode 100644 src/Squidex/Areas/Api/Controllers/Users/Models/PublicUserDto.cs delete mode 100644 src/Squidex/Areas/Api/Controllers/Users/Models/UserCreatedDto.cs diff --git a/src/Squidex.Domain.Users/UserManagerExtensions.cs b/src/Squidex.Domain.Users/UserManagerExtensions.cs index 8fa0115a5..2db94237f 100644 --- a/src/Squidex.Domain.Users/UserManagerExtensions.cs +++ b/src/Squidex.Domain.Users/UserManagerExtensions.cs @@ -115,7 +115,7 @@ namespace Squidex.Domain.Users return result; } - public static async Task CreateAsync(this UserManager userManager, IUserFactory factory, UserValues values) + public static async Task CreateAsync(this UserManager userManager, IUserFactory factory, UserValues values) { var user = factory.Create(values.Email); @@ -142,10 +142,10 @@ namespace Squidex.Domain.Users throw; } - return user; + return await userManager.ResolveUserAsync(user); } - public static async Task UpdateAsync(this UserManager userManager, string id, UserValues values) + public static async Task UpdateAsync(this UserManager userManager, string id, UserValues values) { var user = await userManager.FindByIdAsync(id); @@ -155,6 +155,8 @@ namespace Squidex.Domain.Users } await UpdateAsync(userManager, user, values); + + return await userManager.ResolveUserAsync(user); } public static async Task UpdateSafeAsync(this UserManager userManager, IdentityUser user, UserValues values) @@ -193,7 +195,7 @@ namespace Squidex.Domain.Users } } - public static async Task LockAsync(this UserManager userManager, string id) + public static async Task LockAsync(this UserManager userManager, string id) { var user = await userManager.FindByIdAsync(id); @@ -203,9 +205,11 @@ namespace Squidex.Domain.Users } await DoChecked(() => userManager.SetLockoutEndDateAsync(user, DateTimeOffset.UtcNow.AddYears(100)), "Cannot lock user."); + + return await userManager.ResolveUserAsync(user); } - public static async Task UnlockAsync(this UserManager userManager, string id) + public static async Task UnlockAsync(this UserManager userManager, string id) { var user = await userManager.FindByIdAsync(id); @@ -215,6 +219,8 @@ namespace Squidex.Domain.Users } await DoChecked(() => userManager.SetLockoutEndDateAsync(user, null), "Cannot unlock user."); + + return await userManager.ResolveUserAsync(user); } private static async Task DoChecked(Func> action, string message) diff --git a/src/Squidex.Web/Resource.cs b/src/Squidex.Web/Resource.cs index b62a5f361..a0e68197c 100644 --- a/src/Squidex.Web/Resource.cs +++ b/src/Squidex.Web/Resource.cs @@ -26,25 +26,30 @@ namespace Squidex.Web public void AddGetLink(string rel, string href) { - AddLink(rel, HttpMethod.Get, href); + AddLink(rel, "GET", href); + } + + public void AddPatchLink(string rel, string href) + { + AddLink(rel, "PATCH", href); } public void AddPostLink(string rel, string href) { - AddLink(rel, HttpMethod.Post, href); + AddLink(rel, "POST", href); } public void AddPutLink(string rel, string href) { - AddLink(rel, HttpMethod.Put, href); + AddLink(rel, "PUT", href); } public void AddDeleteLink(string rel, string href) { - AddLink(rel, HttpMethod.Delete, href); + AddLink(rel, "DELETE", href); } - public void AddLink(string rel, HttpMethod method, string href) + public void AddLink(string rel, string method, string href) { Links[rel] = new ResourceLink { Href = href, Method = method }; } diff --git a/src/Squidex.Web/ResourceLink.cs b/src/Squidex.Web/ResourceLink.cs index 48627ac3a..964610e7d 100644 --- a/src/Squidex.Web/ResourceLink.cs +++ b/src/Squidex.Web/ResourceLink.cs @@ -6,7 +6,6 @@ // ========================================================================== using System.ComponentModel.DataAnnotations; -using System.Net.Http; namespace Squidex.Web { @@ -18,6 +17,6 @@ namespace Squidex.Web [Required] [Display(Description = "The link method.")] - public HttpMethod Method { get; set; } + public string Method { get; set; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs b/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs index fc1e9e63f..bd374a986 100644 --- a/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs @@ -278,9 +278,7 @@ namespace Squidex.Areas.Api.Controllers.Contents { await contentQuery.ThrowIfSchemaNotExistsAsync(Context(), name); - var publishPermission = Permissions.ForApp(Permissions.AppContentsPublish, app, name); - - if (publish && !User.Permissions().Includes(publishPermission)) + if (publish && !this.HasPermission(Permissions.AppContentsPublish, app, name)) { return new StatusCodeResult(123); } diff --git a/src/Squidex/Areas/Api/Controllers/Users/Models/CreateUserDto.cs b/src/Squidex/Areas/Api/Controllers/Users/Models/CreateUserDto.cs index b59f83b53..9dbd2feac 100644 --- a/src/Squidex/Areas/Api/Controllers/Users/Models/CreateUserDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Users/Models/CreateUserDto.cs @@ -40,7 +40,13 @@ namespace Squidex.Areas.Api.Controllers.Users.Models public UserValues ToValues() { - return new UserValues { Email = Email, DisplayName = DisplayName, Password = Password, Permissions = new PermissionSet(Permissions) }; + return new UserValues + { + Email = Email, + DisplayName = DisplayName, + Password = Password, + Permissions = new PermissionSet(Permissions) + }; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Users/Models/PublicUserDto.cs b/src/Squidex/Areas/Api/Controllers/Users/Models/PublicUserDto.cs deleted file mode 100644 index e398c88be..000000000 --- a/src/Squidex/Areas/Api/Controllers/Users/Models/PublicUserDto.cs +++ /dev/null @@ -1,26 +0,0 @@ -// ========================================================================== -// Squidex Headless CMS -// ========================================================================== -// Copyright (c) Squidex UG (haftungsbeschränkt) -// All rights reserved. Licensed under the MIT license. -// ========================================================================== - -using System.ComponentModel.DataAnnotations; - -namespace Squidex.Areas.Api.Controllers.Users.Models -{ - public sealed class PublicUserDto - { - /// - /// The id of the user. - /// - [Required] - public string Id { get; set; } - - /// - /// The display name (usually first name and last name) of the user. - /// - [Required] - public string DisplayName { get; set; } - } -} diff --git a/src/Squidex/Areas/Api/Controllers/Users/Models/UpdateUserDto.cs b/src/Squidex/Areas/Api/Controllers/Users/Models/UpdateUserDto.cs index 77b41f567..d6391da83 100644 --- a/src/Squidex/Areas/Api/Controllers/Users/Models/UpdateUserDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Users/Models/UpdateUserDto.cs @@ -39,7 +39,13 @@ namespace Squidex.Areas.Api.Controllers.Users.Models public UserValues ToValues() { - return new UserValues { Email = Email, DisplayName = DisplayName, Password = Password, Permissions = new PermissionSet(Permissions) }; + return new UserValues + { + Email = Email, + DisplayName = DisplayName, + Password = Password, + Permissions = new PermissionSet(Permissions) + }; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Users/Models/UserCreatedDto.cs b/src/Squidex/Areas/Api/Controllers/Users/Models/UserCreatedDto.cs deleted file mode 100644 index 090d81023..000000000 --- a/src/Squidex/Areas/Api/Controllers/Users/Models/UserCreatedDto.cs +++ /dev/null @@ -1,26 +0,0 @@ -// ========================================================================== -// Squidex Headless CMS -// ========================================================================== -// Copyright (c) Squidex UG (haftungsbeschränkt) -// All rights reserved. Licensed under the MIT license. -// ========================================================================== - -using System.ComponentModel.DataAnnotations; - -namespace Squidex.Areas.Api.Controllers.Users.Models -{ - public sealed class UserCreatedDto - { - /// - /// The id of the user. - /// - [Required] - public string Id { get; set; } - - /// - /// Additional permissions for the user. - /// - [Required] - public string[] Permissions { get; set; } - } -} diff --git a/src/Squidex/Areas/Api/Controllers/Users/UserManagementController.cs b/src/Squidex/Areas/Api/Controllers/Users/UserManagementController.cs index 16862daab..6157b120b 100644 --- a/src/Squidex/Areas/Api/Controllers/Users/UserManagementController.cs +++ b/src/Squidex/Areas/Api/Controllers/Users/UserManagementController.cs @@ -32,6 +32,7 @@ namespace Squidex.Areas.Api.Controllers.Users [HttpGet] [Route("user-management/")] + [ProducesResponseType(typeof(UsersDto), 200)] [ApiPermission(Permissions.AdminUsersRead)] public async Task GetUsers([FromQuery] string query = null, [FromQuery] int skip = 0, [FromQuery] int take = 10) { @@ -47,6 +48,7 @@ namespace Squidex.Areas.Api.Controllers.Users [HttpGet] [Route("user-management/{id}/")] + [ProducesResponseType(typeof(UserDto), 201)] [ApiPermission(Permissions.AdminUsersRead)] public async Task GetUser(string id) { @@ -64,28 +66,33 @@ namespace Squidex.Areas.Api.Controllers.Users [HttpPost] [Route("user-management/")] + [ProducesResponseType(typeof(UserDto), 201)] [ApiPermission(Permissions.AdminUsersCreate)] public async Task PostUser([FromBody] CreateUserDto request) { - var user = await userManager.CreateAsync(userFactory, request.ToValues()); + var entity = await userManager.CreateAsync(userFactory, request.ToValues()); - var response = new UserCreatedDto { Id = user.Id }; + var response = UserDto.FromUser(entity, this); return Ok(response); } [HttpPut] [Route("user-management/{id}/")] + [ProducesResponseType(typeof(UserDto), 201)] [ApiPermission(Permissions.AdminUsersUpdate)] public async Task PutUser(string id, [FromBody] UpdateUserDto request) { - await userManager.UpdateAsync(id, request.ToValues()); + var entity = await userManager.UpdateAsync(id, request.ToValues()); + + var response = UserDto.FromUser(entity, this); - return NoContent(); + return Ok(response); } [HttpPut] [Route("user-management/{id}/lock/")] + [ProducesResponseType(typeof(UserDto), 201)] [ApiPermission(Permissions.AdminUsersLock)] public async Task LockUser(string id) { @@ -94,13 +101,16 @@ namespace Squidex.Areas.Api.Controllers.Users throw new ValidationException("Locking user failed.", new ValidationError("You cannot lock yourself.")); } - await userManager.LockAsync(id); + var entity = await userManager.LockAsync(id); + + var response = UserDto.FromUser(entity, this); - return NoContent(); + return Ok(response); } [HttpPut] [Route("user-management/{id}/unlock/")] + [ProducesResponseType(typeof(UserDto), 201)] [ApiPermission(Permissions.AdminUsersUnlock)] public async Task UnlockUser(string id) { @@ -109,9 +119,11 @@ namespace Squidex.Areas.Api.Controllers.Users throw new ValidationException("Unlocking user failed.", new ValidationError("You cannot unlock yourself.")); } - await userManager.UnlockAsync(id); + var entity = await userManager.UnlockAsync(id); - return NoContent(); + var response = UserDto.FromUser(entity, this); + + return Ok(response); } } } diff --git a/src/Squidex/Areas/Api/Controllers/Users/UsersController.cs b/src/Squidex/Areas/Api/Controllers/Users/UsersController.cs index 5311ff642..a5cf31c74 100644 --- a/src/Squidex/Areas/Api/Controllers/Users/UsersController.cs +++ b/src/Squidex/Areas/Api/Controllers/Users/UsersController.cs @@ -68,7 +68,7 @@ namespace Squidex.Areas.Api.Controllers.Users /// [HttpGet] [Route("users/")] - [ProducesResponseType(typeof(PublicUserDto[]), 200)] + [ProducesResponseType(typeof(UserDto[]), 200)] [ApiPermission] public async Task GetUsers(string query) { @@ -76,9 +76,9 @@ namespace Squidex.Areas.Api.Controllers.Users { var entities = await userResolver.QueryByEmailAsync(query); - var models = entities.Where(x => !x.IsHidden()).Select(x => UserDto.FromUser(x, this)).ToArray(); + var response = entities.Where(x => !x.IsHidden()).Select(x => UserDto.FromUser(x, this)).ToArray(); - return Ok(models); + return Ok(response); } catch (Exception ex) { @@ -100,7 +100,7 @@ namespace Squidex.Areas.Api.Controllers.Users /// [HttpGet] [Route("users/{id}/")] - [ProducesResponseType(typeof(PublicUserDto), 200)] + [ProducesResponseType(typeof(UserDto), 200)] [ApiPermission] public async Task GetUser(string id) { diff --git a/src/Squidex/app/features/administration/guards/user-must-exist.guard.spec.ts b/src/Squidex/app/features/administration/guards/user-must-exist.guard.spec.ts index a5c03338f..a12487077 100644 --- a/src/Squidex/app/features/administration/guards/user-must-exist.guard.spec.ts +++ b/src/Squidex/app/features/administration/guards/user-must-exist.guard.spec.ts @@ -9,7 +9,7 @@ import { Router } from '@angular/router'; import { of } from 'rxjs'; import { IMock, Mock, Times } from 'typemoq'; -import { SnapshotUser, UsersState } from '@app/features/administration/internal'; +import { UserDto, UsersState } from '@app/features/administration/internal'; import { UserMustExistGuard } from './user-must-exist.guard'; @@ -32,7 +32,7 @@ describe('UserMustExistGuard', () => { it('should load user and return true when found', () => { usersState.setup(x => x.select('123')) - .returns(() => of({})); + .returns(() => of({})); let result: boolean; diff --git a/src/Squidex/app/features/administration/pages/users/user-page.component.html b/src/Squidex/app/features/administration/pages/users/user-page.component.html index d23721240..44a638173 100644 --- a/src/Squidex/app/features/administration/pages/users/user-page.component.html +++ b/src/Squidex/app/features/administration/pages/users/user-page.component.html @@ -15,12 +15,14 @@ - - - - + + + + + + diff --git a/src/Squidex/app/features/administration/pages/users/user-page.component.ts b/src/Squidex/app/features/administration/pages/users/user-page.component.ts index 9a7e9b71a..53a9ac15e 100644 --- a/src/Squidex/app/features/administration/pages/users/user-page.component.ts +++ b/src/Squidex/app/features/administration/pages/users/user-page.component.ts @@ -9,7 +9,7 @@ import { Component, OnInit } from '@angular/core'; import { FormBuilder } from '@angular/forms'; import { ActivatedRoute, Router } from '@angular/router'; -import { ResourceOwner } from '@app/shared'; +import { hasLink, ResourceOwner } from '@app/shared'; import { CreateUserDto, @@ -46,11 +46,19 @@ export class UserPageComponent extends ResourceOwner implements OnInit { if (selectedUser) { this.userForm.load(selectedUser); + + if (!hasLink(selectedUser, 'update')) { + this.userForm.form.disable(); + } } })); } public save() { + if (this.userForm.form.disabled) { + return; + } + const value = this.userForm.submit(); if (value) { diff --git a/src/Squidex/app/features/administration/pages/users/users-page.component.html b/src/Squidex/app/features/administration/pages/users/users-page.component.html index 167ee3eb9..f71733085 100644 --- a/src/Squidex/app/features/administration/pages/users/users-page.component.html +++ b/src/Squidex/app/features/administration/pages/users/users-page.component.html @@ -12,15 +12,18 @@ -
- + + + + + diff --git a/src/Squidex/app/features/administration/pages/users/users-page.component.ts b/src/Squidex/app/features/administration/pages/users/users-page.component.ts index 065b20858..f029712b4 100644 --- a/src/Squidex/app/features/administration/pages/users/users-page.component.ts +++ b/src/Squidex/app/features/administration/pages/users/users-page.component.ts @@ -51,8 +51,8 @@ export class UsersPageComponent implements OnInit { this.usersState.unlock(user); } - public trackByUser(index: number, userInfo: { user: UserDto }) { - return userInfo.user.id; + public trackByUser(index: number, user: UserDto) { + return user.id; } } diff --git a/src/Squidex/app/features/administration/services/users.service.spec.ts b/src/Squidex/app/features/administration/services/users.service.spec.ts index ee74d079f..03b9b68fb 100644 --- a/src/Squidex/app/features/administration/services/users.service.spec.ts +++ b/src/Squidex/app/features/administration/services/users.service.spec.ts @@ -8,7 +8,7 @@ import { HttpClientTestingModule, HttpTestingController } from '@angular/common/http/testing'; import { inject, TestBed } from '@angular/core/testing'; -import { ApiUrlConfig } from '@app/framework'; +import { ApiUrlConfig, Resource } from '@app/framework'; import { UserDto, @@ -50,27 +50,15 @@ describe('UsersService', () => { req.flush({ total: 100, items: [ - { - id: '123', - email: 'mail1@domain.com', - displayName: 'User1', - permissions: ['Permission1'], - isLocked: true - }, - { - id: '456', - email: 'mail2@domain.com', - displayName: 'User2', - permissions: ['Permission2'], - isLocked: true - } + userResponse(12), + userResponse(13) ] }); expect(users!).toEqual( new UsersDto(100, [ - new UserDto('123', 'mail1@domain.com', 'User1', ['Permission1'], true), - new UserDto('456', 'mail2@domain.com', 'User2', ['Permission2'], true) + createUser(12), + createUser(13) ])); })); @@ -91,27 +79,15 @@ describe('UsersService', () => { req.flush({ total: 100, items: [ - { - id: '123', - email: 'mail1@domain.com', - displayName: 'User1', - permissions: ['Permission1'], - isLocked: true - }, - { - id: '456', - email: 'mail2@domain.com', - displayName: 'User2', - permissions: ['Permission2'], - isLocked: true - } + userResponse(12), + userResponse(13) ] }); expect(users!).toEqual( new UsersDto(100, [ - new UserDto('123', 'mail1@domain.com', 'User1', ['Permission1'], true), - new UserDto('456', 'mail2@domain.com', 'User2', ['Permission2'], true) + createUser(12), + createUser(13) ])); })); @@ -129,15 +105,9 @@ describe('UsersService', () => { expect(req.request.method).toEqual('GET'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush({ - id: '123', - email: 'mail1@domain.com', - displayName: 'User1', - permissions: ['Permission1'], - isLocked: true - }); + req.flush(userResponse(12)); - expect(user!).toEqual(new UserDto('123', 'mail1@domain.com', 'User1', ['Permission1'], true)); + expect(user!).toEqual(createUser(12)); })); it('should make post request to create user', @@ -156,9 +126,9 @@ describe('UsersService', () => { expect(req.request.method).toEqual('POST'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush({ id: '123', pictureUrl: 'path/to/image1' }); + req.flush(userResponse(12)); - expect(user!).toEqual(new UserDto('123', dto.email, dto.displayName, dto.permissions, false)); + expect(user!).toEqual(createUser(12)); })); it('should make put request to update user', @@ -166,39 +136,108 @@ describe('UsersService', () => { const dto = { email: 'mail@squidex.io', displayName: 'Squidex User', permissions: ['Permission1'], password: 'password' }; - userManagementService.putUser('123', dto).subscribe(); + const resource: Resource = { + _links: { + update: { method: 'PUT', href: 'api/user-management/123' } + } + }; + + let user: UserDto; + + userManagementService.putUser(resource, dto).subscribe(result => { + user = result; + }); const req = httpMock.expectOne('http://service/p/api/user-management/123'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush({}); + req.flush(userResponse(12)); + + expect(user!).toEqual(createUser(12)); })); it('should make put request to lock user', inject([UsersService, HttpTestingController], (userManagementService: UsersService, httpMock: HttpTestingController) => { - userManagementService.lockUser('123').subscribe(); + const resource: Resource = { + _links: { + lock: { method: 'PUT', href: 'api/user-management/123/lock' } + } + }; + + let user: UserDto; + + userManagementService.lockUser(resource).subscribe(result => { + user = result; + }); const req = httpMock.expectOne('http://service/p/api/user-management/123/lock'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush({}); + req.flush(userResponse(12)); + + expect(user!).toEqual(createUser(12)); })); it('should make put request to unlock user', inject([UsersService, HttpTestingController], (userManagementService: UsersService, httpMock: HttpTestingController) => { - userManagementService.unlockUser('123').subscribe(); + const resource: Resource = { + _links: { + unlock: { method: 'PUT', href: 'api/user-management/123/unlock' } + } + }; + + let user: UserDto; + + userManagementService.unlockUser(resource).subscribe(result => { + user = result; + }); const req = httpMock.expectOne('http://service/p/api/user-management/123/unlock'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush({}); + req.flush(userResponse(12)); + + expect(user!).toEqual(createUser(12)); })); -}); \ No newline at end of file + + function userResponse(id: number) { + return { + id: `${id}`, + email: `user${id}@domain.com`, + displayName: `user${id}`, + permissions: [ + `Permission${id}` + ], + isLocked: true, + _links: { + update: { + method: 'PUT', href: `/users/${id}` + } + } + }; + } +}); + +export function createUser(id: number, suffix = '') { + const result = new UserDto(`${id}`, + `user${id}${suffix}@domain.com`, + `user${id}${suffix}`, + [ + `Permission${id}${suffix}` + ], + true); + + result._links['update'] = { + method: 'PUT', href: `/users/${id}` + }; + + return result; +} \ No newline at end of file diff --git a/src/Squidex/app/features/administration/services/users.service.ts b/src/Squidex/app/features/administration/services/users.service.ts index b42fe46a2..a1eb3e9c8 100644 --- a/src/Squidex/app/features/administration/services/users.service.ts +++ b/src/Squidex/app/features/administration/services/users.service.ts @@ -12,7 +12,6 @@ import { map } from 'rxjs/operators'; import { ApiUrlConfig, - Model, pretifyError, Resource, ResourceLinks, @@ -21,11 +20,11 @@ import { } from '@app/shared'; export class UsersDto extends ResultSet { - public _links: ResourceLinks; + public readonly _links: ResourceLinks = {}; } -export class UserDto extends Model { - public _links: ResourceLinks; +export class UserDto { + public readonly _links: ResourceLinks = {}; constructor( public readonly id: string, @@ -34,11 +33,6 @@ export class UserDto extends Model { public readonly permissions: string[] = [], public readonly isLocked?: boolean ) { - super(); - } - - public with(value: Partial): UserDto { - return this.clone(value); } } @@ -69,15 +63,7 @@ export class UsersService { return this.http.get<{ total: number, items: any[] } & Resource>(url).pipe( map(body => { - const users = body.items.map(item => - withLinks( - new UserDto( - item.id, - item.email, - item.displayName, - item.permissions, - item.isLocked), - item)); + const users = body.items.map(item => parseUser(item)); return withLinks(new UsersDto(body.total, users), body); }), @@ -89,14 +75,7 @@ export class UsersService { return this.http.get(url).pipe( map(body => { - const user = new UserDto( - body.id, - body.email, - body.displayName, - body.permissions, - body.isLocked); - - return user; + return parseUser(body); }), pretifyError('Failed to load user. Please reload.')); } @@ -106,36 +85,55 @@ export class UsersService { return this.http.post(url, dto).pipe( map(body => { - const user = new UserDto( - body.id, - dto.email, - dto.displayName, - dto.permissions, - false); - - return user; + return parseUser(body); }), pretifyError('Failed to create user. Please reload.')); } - public putUser(id: string, dto: UpdateUserDto): Observable { - const url = this.apiUrl.buildUrl(`api/user-management/${id}`); + public putUser(user: Resource, dto: UpdateUserDto): Observable { + const link = user._links['update']; + + const url = this.apiUrl.buildUrl(link.href); - return this.http.put(url, dto).pipe( + return this.http.request(link.method, url, { body: dto }).pipe( + map(body => { + return parseUser(body); + }), pretifyError('Failed to update user. Please reload.')); } - public lockUser(id: string): Observable { - const url = this.apiUrl.buildUrl(`api/user-management/${id}/lock`); + public lockUser(user: Resource): Observable { + const link = user._links['lock']; + + const url = this.apiUrl.buildUrl(link.href); - return this.http.put(url, {}).pipe( + return this.http.request(link.method, url).pipe( + map(body => { + return parseUser(body); + }), pretifyError('Failed to load users. Please retry.')); } - public unlockUser(id: string): Observable { - const url = this.apiUrl.buildUrl(`api/user-management/${id}/unlock`); + public unlockUser(user: Resource): Observable { + const link = user._links['unlock']; - return this.http.put(url, {}).pipe( + const url = this.apiUrl.buildUrl(link.href); + + return this.http.request(link.method, url).pipe( + map(body => { + return parseUser(body); + }), pretifyError('Failed to load users. Please retry.')); } +} + +function parseUser(response: any) { + return withLinks( + new UserDto( + response.id, + response.email, + response.displayName, + response.permissions, + response.isLocked), + response); } \ No newline at end of file diff --git a/src/Squidex/app/features/administration/state/users.state.spec.ts b/src/Squidex/app/features/administration/state/users.state.spec.ts index e735870a5..b9e4971db 100644 --- a/src/Squidex/app/features/administration/state/users.state.spec.ts +++ b/src/Squidex/app/features/administration/state/users.state.spec.ts @@ -8,7 +8,7 @@ import { of, throwError } from 'rxjs'; import { IMock, It, Mock, Times } from 'typemoq'; -import { AuthService, DialogService } from '@app/shared'; +import { DialogService } from '@app/shared'; import { UserDto, @@ -16,15 +16,16 @@ import { UsersService } from '@app/features/administration/internal'; + import { UsersState } from './users.state'; +import { createUser } from './../services/users.service.spec'; + describe('UsersState', () => { - const oldUsers = [ - new UserDto('id1', 'mail1@mail.de', 'name1', ['Permission1'], false), - new UserDto('id2', 'mail2@mail.de', 'name2', ['Permission2'], true) - ]; + const user1 = createUser(1); + const user2 = createUser(2); - const newUser = new UserDto('id3', 'mail3@mail.de', 'name3', ['Permission3'], false); + const newUser = createUser(3); let dialogs: IMock; let usersService: IMock; @@ -44,11 +45,11 @@ describe('UsersState', () => { describe('Loading', () => { it('should load users', () => { usersService.setup(x => x.getUsers(10, 0, undefined)) - .returns(() => of(new UsersDto(200, oldUsers))).verifiable(); + .returns(() => of(new UsersDto(200, [user1, user2]))).verifiable(); usersState.load().subscribe(); - expect(usersState.snapshot.users.values).toEqual(oldUsers); + expect(usersState.snapshot.users.values).toEqual([user1, user2]); expect(usersState.snapshot.usersPager.numberOfItems).toEqual(200); expect(usersState.snapshot.isLoaded).toBeTruthy(); @@ -57,7 +58,7 @@ describe('UsersState', () => { it('should show notification on load when reload is true', () => { usersService.setup(x => x.getUsers(10, 0, undefined)) - .returns(() => of(new UsersDto(200, oldUsers))).verifiable(); + .returns(() => of(new UsersDto(200, [user1, user2]))).verifiable(); usersState.load(true).subscribe(); @@ -68,18 +69,18 @@ describe('UsersState', () => { it('should replace selected user when reloading', () => { const newUsers = [ - new UserDto('id1', 'mail1@mail.de_new', 'name1_new', ['Permission1_New'], false), - new UserDto('id2', 'mail2@mail.de_new', 'name2_new', ['Permission2_New'], true) + createUser(1, '_new'), + createUser(2, '_new') ]; usersService.setup(x => x.getUsers(10, 0, undefined)) - .returns(() => of(new UsersDto(200, oldUsers))).verifiable(Times.exactly(2)); + .returns(() => of(new UsersDto(200, [user1, user2]))).verifiable(Times.exactly(2)); usersService.setup(x => x.getUsers(10, 0, undefined)) .returns(() => of(new UsersDto(200, newUsers))); usersState.load().subscribe(); - usersState.select('id1').subscribe(); + usersState.select(user1.id).subscribe(); usersState.load().subscribe(); expect(usersState.snapshot.selectedUser).toEqual(newUsers[0]); @@ -87,7 +88,7 @@ describe('UsersState', () => { it('should load next page and prev page when paging', () => { usersService.setup(x => x.getUsers(10, 0, undefined)) - .returns(() => of(new UsersDto(200, oldUsers))).verifiable(Times.exactly(2)); + .returns(() => of(new UsersDto(200, [user1, user2]))).verifiable(Times.exactly(2)); usersService.setup(x => x.getUsers(10, 10, undefined)) .returns(() => of(new UsersDto(200, []))).verifiable(); @@ -112,7 +113,7 @@ describe('UsersState', () => { describe('Updates', () => { beforeEach(() => { usersService.setup(x => x.getUsers(10, 0, undefined)) - .returns(() => of(new UsersDto(200, oldUsers))).verifiable(); + .returns(() => of(new UsersDto(200, [user1, user2]))).verifiable(); usersState.load().subscribe(); }); @@ -120,12 +121,12 @@ describe('UsersState', () => { it('should return user on select and not load when already loaded', () => { let selectedUser: UserDto; - usersState.select('id1').subscribe(x => { + usersState.select(user1.id).subscribe(x => { selectedUser = x!; }); - expect(selectedUser!).toEqual(oldUsers[0]); - expect(usersState.snapshot.selectedUser).toEqual(oldUsers[0]); + expect(selectedUser!).toEqual(user1); + expect(usersState.snapshot.selectedUser).toEqual(user1); }); it('should return user on select and load when not loaded', () => { @@ -168,46 +169,49 @@ describe('UsersState', () => { }); it('should mark as locked when locked', () => { - usersService.setup(x => x.lockUser('id1')) - .returns(() => of({})).verifiable(); + const updated = createUser(2, '_new'); + + usersService.setup(x => x.lockUser(user2)) + .returns(() => of(updated)).verifiable(); - usersState.select('id1').subscribe(); - usersState.lock(oldUsers[0]).subscribe(); + usersState.select(user2.id).subscribe(); + usersState.lock(user2).subscribe(); - const user_1 = usersState.snapshot.users.at(0); + const userUser2 = usersState.snapshot.users.at(1); - expect(user_1.isLocked).toBeTruthy(); - expect(user_1).toBe(usersState.snapshot.selectedUser!); + expect(userUser2).toBe(usersState.snapshot.selectedUser!); }); it('should unmark as locked when unlocked', () => { - usersService.setup(x => x.unlockUser('id2')) - .returns(() => of({})).verifiable(); + const updated = createUser(2, '_new'); - usersState.select('id2').subscribe(); - usersState.unlock(oldUsers[1]).subscribe(); + usersService.setup(x => x.unlockUser(user2)) + .returns(() => of(updated)).verifiable(); - const user_1 = usersState.snapshot.users.at(1); + usersState.select(user2.id).subscribe(); + usersState.unlock(user2).subscribe(); - expect(user_1.isLocked).toBeFalsy(); - expect(user_1).toBe(usersState.snapshot.selectedUser!); + const newUser2 = usersState.snapshot.users.at(1); + + expect(newUser2).toEqual(updated); + expect(newUser2).toBe(usersState.snapshot.selectedUser!); }); it('should update user properties when updated', () => { const request = { email: 'new@mail.com', displayName: 'New', permissions: ['Permission1'] }; - usersService.setup(x => x.putUser('id1', request)) - .returns(() => of({})).verifiable(); + const updated = createUser(2, '_new'); + + usersService.setup(x => x.putUser(user2, request)) + .returns(() => of(updated)).verifiable(); - usersState.select('id1').subscribe(); - usersState.update(oldUsers[0], request).subscribe(); + usersState.select(user2.id).subscribe(); + usersState.update(user2, request).subscribe(); - const user_1 = usersState.snapshot.users.at(0); + const newUser2 = usersState.snapshot.users.at(1); - expect(user_1.email).toEqual(request.email); - expect(user_1.displayName).toEqual(request.displayName); - expect(user_1.permissions).toEqual(request.permissions); - expect(user_1).toBe(usersState.snapshot.selectedUser!); + expect(newUser2).toEqual(updated); + expect(newUser2).toBe(usersState.snapshot.selectedUser!); }); it('should add user to snapshot when created', () => { @@ -218,7 +222,7 @@ describe('UsersState', () => { usersState.create(request).subscribe(); - expect(usersState.snapshot.users.values).toEqual([newUser, ...oldUsers]); + expect(usersState.snapshot.users.values).toEqual([newUser, user1, user2]); expect(usersState.snapshot.usersPager.numberOfItems).toBe(201); }); }); diff --git a/src/Squidex/app/features/administration/state/users.state.ts b/src/Squidex/app/features/administration/state/users.state.ts index 49c5163cc..04a4bc80a 100644 --- a/src/Squidex/app/features/administration/state/users.state.ts +++ b/src/Squidex/app/features/administration/state/users.state.ts @@ -7,7 +7,7 @@ import { Injectable } from '@angular/core'; import { Observable, of } from 'rxjs'; -import { catchError, distinctUntilChanged, map, switchMap, tap } from 'rxjs/operators'; +import { catchError, distinctUntilChanged, map, tap } from 'rxjs/operators'; import '@app/framework/utils/rxjs-extensions'; @@ -15,6 +15,7 @@ import { DialogService, ImmutableArray, Pager, + ResourceLinks, shareSubscribed, State } from '@app/shared'; @@ -36,6 +37,9 @@ interface Snapshot { // The query to filter users. usersQuery?: string; + // The resource links. + links: ResourceLinks; + // Indicates if the users are loaded. isLoaded?: boolean; @@ -56,6 +60,10 @@ export class UsersState extends State { this.changes.pipe(map(x => x.usersPager), distinctUntilChanged()); + public links = + this.changes.pipe(map(x => x.links), + distinctUntilChanged()); + public selectedUser = this.changes.pipe(map(x => x.selectedUser), distinctUntilChanged()); @@ -68,7 +76,7 @@ export class UsersState extends State { private readonly dialogs: DialogService, private readonly usersService: UsersService ) { - super({ users: ImmutableArray.empty(), usersPager: new Pager(0) }); + super({ users: ImmutableArray.empty(), usersPager: new Pager(0), links: {} }); } public select(id: string | null): Observable { @@ -108,7 +116,7 @@ export class UsersState extends State { this.snapshot.usersPager.pageSize, this.snapshot.usersPager.skip, this.snapshot.usersQuery).pipe( - tap(({ total, items }) => { + tap(({ total, items, _links: links }) => { if (isReload) { this.dialogs.notifyInfo('Users reloaded.'); } @@ -123,7 +131,7 @@ export class UsersState extends State { selectedUser = users.find(x => x.id === selectedUser!.id) || selectedUser; } - return { ...s, users, usersPager, selectedUser, isLoaded: true }; + return { ...s, users, usersPager, links, selectedUser, isLoaded: true }; }); }), shareSubscribed(this.dialogs)); @@ -143,8 +151,7 @@ export class UsersState extends State { } public update(user: UserDto, request: UpdateUserDto): Observable { - return this.usersService.putUser(user.id, request).pipe( - switchMap(() => this.usersService.getUser(user.id)), + return this.usersService.putUser(user, request).pipe( tap(updated => { this.replaceUser(updated); }), @@ -152,8 +159,7 @@ export class UsersState extends State { } public lock(user: UserDto): Observable { - return this.usersService.lockUser(user.id).pipe( - switchMap(() => this.usersService.getUser(user.id)), + return this.usersService.lockUser(user).pipe( tap(updated => { this.replaceUser(updated); }), @@ -161,8 +167,7 @@ export class UsersState extends State { } public unlock(user: UserDto): Observable { - return this.usersService.unlockUser(user.id).pipe( - switchMap(() => this.usersService.getUser(user.id)), + return this.usersService.unlockUser(user).pipe( tap(updated => { this.replaceUser(updated); }), diff --git a/src/Squidex/app/framework/angular/http/hateos.pipes.ts b/src/Squidex/app/framework/angular/http/hateos.pipes.ts index 979c95205..f580b5bb0 100644 --- a/src/Squidex/app/framework/angular/http/hateos.pipes.ts +++ b/src/Squidex/app/framework/angular/http/hateos.pipes.ts @@ -1,14 +1,25 @@ +/* + * Squidex Headless CMS + * + * @license + * Copyright (c) Squidex UG (haftungsbeschränkt). All rights reserved. + */ + import { Pipe, PipeTransform } from '@angular/core'; -import { Resource } from '@app/framework/internal'; +import { + hasLink, + Resource, + ResourceLinks +} from '@app/framework/internal'; @Pipe({ name: 'sqxHasLink', pure: true }) export class HasLinkPipe implements PipeTransform { - public transform(value: Resource, rel: string) { - return value._links && !!value._links[rel]; + public transform(value: Resource | ResourceLinks, rel: string) { + return hasLink(value, rel); } } @@ -17,7 +28,7 @@ export class HasLinkPipe implements PipeTransform { pure: true }) export class HasNoLinkPipe implements PipeTransform { - public transform(value: Resource, rel: string) { - return !value._links || !value._links[rel]; + public transform(value: Resource | ResourceLinks, rel: string) { + return !hasLink(value, rel); } -} \ No newline at end of file +} diff --git a/src/Squidex/app/framework/utils/hateos.ts b/src/Squidex/app/framework/utils/hateos.ts index 14e5357d8..c1c2099c7 100644 --- a/src/Squidex/app/framework/utils/hateos.ts +++ b/src/Squidex/app/framework/utils/hateos.ts @@ -5,21 +5,40 @@ * Copyright (c) Squidex UG (haftungsbeschränkt). All rights reserved. */ - export interface Resource { - _links?: { [rel: string]: ResourceLink }; - } +export interface Resource { + readonly _links: { [rel: string]: ResourceLink }; +} - export type ResourceLinks = { [rel: string]: ResourceLink }; - export type ResourceLink = { href: string; method: ResourceMethod; }; +export type ResourceLinks = { [rel: string]: ResourceLink }; +export type ResourceLink = { href: string; method: ResourceMethod; }; - export function withLinks(value: T, source: Resource) { - value._links = source._links; +export function withLinks(value: T, source: Resource) { + if (value._links && source._links) { + for (let key in source._links) { + if (source._links.hasOwnProperty(key)) { + value._links[key] = source._links[key]; + } + } - return value; - } + Object.freeze(value._links); + } - export type ResourceMethod = - 'get' | - 'post' | - 'put' | - 'delete'; \ No newline at end of file + return value; +} + +export function hasLink(value: Resource | ResourceLinks, rel: string): boolean { + const link = getLink(value, rel); + + return !!(link && link.method && link.href); +} + +export function getLink(value: Resource | ResourceLinks, rel: string): ResourceLink { + return value ? (value._links ? value._links[rel] : value[rel]) : undefined; +} + +export type ResourceMethod = + 'GET' | + 'DELETE' | + 'PATCH' | + 'POST' | + 'PUT'; \ No newline at end of file From 368cfc7b828fe4464c3992abb76b7241fc70b1b7 Mon Sep 17 00:00:00 2001 From: Sebastian Date: Sat, 8 Jun 2019 14:20:34 +0200 Subject: [PATCH 03/64] HATEOS for event consumers. --- .../Grains/EventConsumerGrain.cs | 29 ++-- .../Grains/EventConsumerManagerGrain.cs | 12 +- .../Grains/IEventConsumerGrain.cs | 6 +- .../Grains/IEventConsumerManagerGrain.cs | 10 +- src/Squidex.Web/Resource.cs | 1 - src/Squidex.Web/UrlHelperExtensions.cs | 2 - .../Contents/ContentsController.cs | 1 - .../EventConsumersController.cs | 31 +++-- .../EventConsumers/Models/EventConsumerDto.cs | 37 +++++- .../Models/EventConsumersDto.cs | 39 ++++++ .../event-consumers-page.component.html | 6 +- .../services/event-consumers.service.spec.ts | 124 +++++++++++++----- .../services/event-consumers.service.ts | 82 ++++++++---- .../services/users.service.spec.ts | 3 +- .../state/event-consumers.state.spec.ts | 60 +++++---- .../state/event-consumers.state.ts | 21 +-- .../administration/state/users.state.spec.ts | 10 +- 17 files changed, 323 insertions(+), 151 deletions(-) create mode 100644 src/Squidex/Areas/Api/Controllers/EventConsumers/Models/EventConsumersDto.cs diff --git a/src/Squidex.Infrastructure/EventSourcing/Grains/EventConsumerGrain.cs b/src/Squidex.Infrastructure/EventSourcing/Grains/EventConsumerGrain.cs index f37a9200f..bc5ada68d 100644 --- a/src/Squidex.Infrastructure/EventSourcing/Grains/EventConsumerGrain.cs +++ b/src/Squidex.Infrastructure/EventSourcing/Grains/EventConsumerGrain.cs @@ -58,7 +58,12 @@ namespace Squidex.Infrastructure.EventSourcing.Grains public Task> GetStateAsync() { - return Task.FromResult(State.ToInfo(eventConsumer.Name).AsImmutable()); + return Task.FromResult(CreateInfo()); + } + + private Immutable CreateInfo() + { + return State.ToInfo(eventConsumer.Name).AsImmutable(); } public Task OnEventAsync(Immutable subscription, Immutable storedEvent) @@ -109,39 +114,43 @@ namespace Squidex.Infrastructure.EventSourcing.Grains return TaskHelper.Done; } - public Task StartAsync() + public async Task> StartAsync() { if (!State.IsStopped) { - return TaskHelper.Done; + return CreateInfo(); } - return DoAndUpdateStateAsync(() => + await DoAndUpdateStateAsync(() => { Subscribe(State.Position); State = State.Started(); }); + + return CreateInfo(); } - public Task StopAsync() + public async Task> StopAsync() { if (State.IsStopped) { - return TaskHelper.Done; + return CreateInfo(); } - return DoAndUpdateStateAsync(() => + await DoAndUpdateStateAsync(() => { Unsubscribe(); State = State.Stopped(); }); + + return CreateInfo(); } - public Task ResetAsync() + public async Task> ResetAsync() { - return DoAndUpdateStateAsync(async () => + await DoAndUpdateStateAsync(async () => { Unsubscribe(); @@ -151,6 +160,8 @@ namespace Squidex.Infrastructure.EventSourcing.Grains State = State.Reset(); }); + + return CreateInfo(); } private Task DoAndUpdateStateAsync(Action action, [CallerMemberName] string caller = null) diff --git a/src/Squidex.Infrastructure/EventSourcing/Grains/EventConsumerManagerGrain.cs b/src/Squidex.Infrastructure/EventSourcing/Grains/EventConsumerManagerGrain.cs index ca9097142..4952088c0 100644 --- a/src/Squidex.Infrastructure/EventSourcing/Grains/EventConsumerManagerGrain.cs +++ b/src/Squidex.Infrastructure/EventSourcing/Grains/EventConsumerManagerGrain.cs @@ -74,33 +74,31 @@ namespace Squidex.Infrastructure.EventSourcing.Grains { return Task.WhenAll( eventConsumers - .Select(c => GrainFactory.GetGrain(c.Name)) - .Select(c => c.StartAsync())); + .Select(c => StartAsync(c.Name))); } public Task StopAllAsync() { return Task.WhenAll( eventConsumers - .Select(c => GrainFactory.GetGrain(c.Name)) - .Select(c => c.StopAsync())); + .Select(c => StopAsync(c.Name))); } - public Task ResetAsync(string consumerName) + public Task> ResetAsync(string consumerName) { var eventConsumer = GrainFactory.GetGrain(consumerName); return eventConsumer.ResetAsync(); } - public Task StartAsync(string consumerName) + public Task> StartAsync(string consumerName) { var eventConsumer = GrainFactory.GetGrain(consumerName); return eventConsumer.StartAsync(); } - public Task StopAsync(string consumerName) + public Task> StopAsync(string consumerName) { var eventConsumer = GrainFactory.GetGrain(consumerName); diff --git a/src/Squidex.Infrastructure/EventSourcing/Grains/IEventConsumerGrain.cs b/src/Squidex.Infrastructure/EventSourcing/Grains/IEventConsumerGrain.cs index 58b7bf2fb..fb7d82811 100644 --- a/src/Squidex.Infrastructure/EventSourcing/Grains/IEventConsumerGrain.cs +++ b/src/Squidex.Infrastructure/EventSourcing/Grains/IEventConsumerGrain.cs @@ -16,11 +16,11 @@ namespace Squidex.Infrastructure.EventSourcing.Grains { Task> GetStateAsync(); - Task StopAsync(); + Task> StopAsync(); - Task StartAsync(); + Task> StartAsync(); - Task ResetAsync(); + Task> ResetAsync(); Task OnEventAsync(Immutable subscription, Immutable storedEvent); diff --git a/src/Squidex.Infrastructure/EventSourcing/Grains/IEventConsumerManagerGrain.cs b/src/Squidex.Infrastructure/EventSourcing/Grains/IEventConsumerManagerGrain.cs index c0b53d403..397db21f4 100644 --- a/src/Squidex.Infrastructure/EventSourcing/Grains/IEventConsumerManagerGrain.cs +++ b/src/Squidex.Infrastructure/EventSourcing/Grains/IEventConsumerManagerGrain.cs @@ -16,15 +16,15 @@ namespace Squidex.Infrastructure.EventSourcing.Grains { Task ActivateAsync(string streamName); - Task StopAllAsync(); + Task StartAllAsync(); - Task StopAsync(string consumerName); + Task StopAllAsync(); - Task StartAllAsync(); + Task> StopAsync(string consumerName); - Task StartAsync(string consumerName); + Task> StartAsync(string consumerName); - Task ResetAsync(string consumerName); + Task> ResetAsync(string consumerName); Task>> GetConsumersAsync(); } diff --git a/src/Squidex.Web/Resource.cs b/src/Squidex.Web/Resource.cs index a0e68197c..59c4d10f9 100644 --- a/src/Squidex.Web/Resource.cs +++ b/src/Squidex.Web/Resource.cs @@ -8,7 +8,6 @@ using Newtonsoft.Json; using System.Collections.Generic; using System.ComponentModel.DataAnnotations; -using System.Net.Http; namespace Squidex.Web { diff --git a/src/Squidex.Web/UrlHelperExtensions.cs b/src/Squidex.Web/UrlHelperExtensions.cs index 486d48a76..27f00a1d9 100644 --- a/src/Squidex.Web/UrlHelperExtensions.cs +++ b/src/Squidex.Web/UrlHelperExtensions.cs @@ -7,8 +7,6 @@ using Microsoft.AspNetCore.Mvc; using System; -using System.Linq.Expressions; -using System.Reflection; namespace Squidex.Web { diff --git a/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs b/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs index bd374a986..61c74d203 100644 --- a/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs @@ -21,7 +21,6 @@ using Squidex.Domain.Apps.Entities.Contents.Commands; using Squidex.Domain.Apps.Entities.Contents.GraphQL; using Squidex.Infrastructure.Commands; using Squidex.Shared; -using Squidex.Shared.Identity; using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Contents diff --git a/src/Squidex/Areas/Api/Controllers/EventConsumers/EventConsumersController.cs b/src/Squidex/Areas/Api/Controllers/EventConsumers/EventConsumersController.cs index 1369eb9c7..9e17d5f09 100644 --- a/src/Squidex/Areas/Api/Controllers/EventConsumers/EventConsumersController.cs +++ b/src/Squidex/Areas/Api/Controllers/EventConsumers/EventConsumersController.cs @@ -5,7 +5,6 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== -using System.Linq; using System.Threading.Tasks; using Microsoft.AspNetCore.Mvc; using Orleans; @@ -30,44 +29,54 @@ namespace Squidex.Areas.Api.Controllers.EventConsumers [HttpGet] [Route("event-consumers/")] + [ProducesResponseType(typeof(EventConsumersDto), 200)] [ApiPermission(Permissions.AdminEventsRead)] public async Task GetEventConsumers() { var entities = await GetGrain().GetConsumersAsync(); - var response = entities.Value.OrderBy(x => x.Name).Select(EventConsumerDto.FromEventConsumerInfo).ToArray(); + var response = EventConsumersDto.FromResults(entities.Value, this); return Ok(response); } [HttpPut] [Route("event-consumers/{name}/start/")] + [ProducesResponseType(typeof(EventConsumerDto), 200)] [ApiPermission(Permissions.AdminEventsManage)] - public async Task Start(string name) + public async Task StartEventConsumer(string name) { - await GetGrain().StartAsync(name); + var entity = await GetGrain().StartAsync(name); - return NoContent(); + var response = EventConsumerDto.FromEventConsumerInfo(entity.Value, this); + + return Ok(response); } [HttpPut] [Route("event-consumers/{name}/stop/")] + [ProducesResponseType(typeof(EventConsumerDto), 200)] [ApiPermission(Permissions.AdminEventsManage)] - public async Task Stop(string name) + public async Task StopEventConsumer(string name) { - await GetGrain().StopAsync(name); + var entity = await GetGrain().StopAsync(name); + + var response = EventConsumerDto.FromEventConsumerInfo(entity.Value, this); - return NoContent(); + return Ok(response); } [HttpPut] [Route("event-consumers/{name}/reset/")] + [ProducesResponseType(typeof(EventConsumerDto), 200)] [ApiPermission(Permissions.AdminEventsManage)] - public async Task Reset(string name) + public async Task ResetEventConsumer(string name) { - await GetGrain().ResetAsync(name); + var entity = await GetGrain().ResetAsync(name); + + var response = EventConsumerDto.FromEventConsumerInfo(entity.Value, this); - return NoContent(); + return Ok(response); } private IEventConsumerManagerGrain GetGrain() diff --git a/src/Squidex/Areas/Api/Controllers/EventConsumers/Models/EventConsumerDto.cs b/src/Squidex/Areas/Api/Controllers/EventConsumers/Models/EventConsumerDto.cs index 3ef6535c3..df0846cbf 100644 --- a/src/Squidex/Areas/Api/Controllers/EventConsumers/Models/EventConsumerDto.cs +++ b/src/Squidex/Areas/Api/Controllers/EventConsumers/Models/EventConsumerDto.cs @@ -7,11 +7,16 @@ using Squidex.Infrastructure.EventSourcing; using Squidex.Infrastructure.Reflection; +using Squidex.Infrastructure.Security; +using Squidex.Shared; +using Squidex.Web; namespace Squidex.Areas.Api.Controllers.EventConsumers.Models { - public sealed class EventConsumerDto + public sealed class EventConsumerDto : Resource { + private static readonly Permission EventsManagePermission = new Permission(Permissions.AdminEventsManage); + public bool IsStopped { get; set; } public bool IsResetting { get; set; } @@ -22,9 +27,35 @@ namespace Squidex.Areas.Api.Controllers.EventConsumers.Models public string Position { get; set; } - public static EventConsumerDto FromEventConsumerInfo(EventConsumerInfo eventConsumerInfo) + public static EventConsumerDto FromEventConsumerInfo(EventConsumerInfo eventConsumerInfo, ApiController controller) + { + var result = SimpleMapper.Map(eventConsumerInfo, new EventConsumerDto()); + + return CreateLinks(result, controller); + } + + private static EventConsumerDto CreateLinks(EventConsumerDto result, ApiController controller) { - return SimpleMapper.Map(eventConsumerInfo, new EventConsumerDto()); + if (controller.HasPermission(EventsManagePermission)) + { + var values = new { name = result.Name }; + + if (!result.IsResetting) + { + result.AddPutLink("reset", controller.Url(x => nameof(x.ResetEventConsumer), values)); + } + + if (result.IsStopped) + { + result.AddPutLink("start", controller.Url(x => nameof(x.StartEventConsumer), values)); + } + else + { + result.AddPutLink("stop", controller.Url(x => nameof(x.StopEventConsumer), values)); + } + } + + return result; } } } diff --git a/src/Squidex/Areas/Api/Controllers/EventConsumers/Models/EventConsumersDto.cs b/src/Squidex/Areas/Api/Controllers/EventConsumers/Models/EventConsumersDto.cs new file mode 100644 index 000000000..8f9a20766 --- /dev/null +++ b/src/Squidex/Areas/Api/Controllers/EventConsumers/Models/EventConsumersDto.cs @@ -0,0 +1,39 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschraenkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +using System.Collections.Generic; +using System.Linq; +using Squidex.Infrastructure.EventSourcing; +using Squidex.Web; + +namespace Squidex.Areas.Api.Controllers.EventConsumers.Models +{ + public sealed class EventConsumersDto : Resource + { + /// + /// The event consumers. + /// + public EventConsumerDto[] Items { get; set; } + + public static EventConsumersDto FromResults(IEnumerable items, ApiController controller) + { + var result = new EventConsumersDto + { + Items = items.Select(x => EventConsumerDto.FromEventConsumerInfo(x, controller)).ToArray() + }; + + return CreateLinks(result, controller); + } + + private static EventConsumersDto CreateLinks(EventConsumersDto result, ApiController controller) + { + result.AddSelfLink(controller.Url(c => nameof(c.GetEventConsumers))); + + return result; + } + } +} diff --git a/src/Squidex/app/features/administration/pages/event-consumers/event-consumers-page.component.html b/src/Squidex/app/features/administration/pages/event-consumers/event-consumers-page.component.html index 6664745ac..8c31c3da2 100644 --- a/src/Squidex/app/features/administration/pages/event-consumers/event-consumers-page.component.html +++ b/src/Squidex/app/features/administration/pages/event-consumers/event-consumers-page.component.html @@ -42,13 +42,13 @@ {{eventConsumer.position}} diff --git a/src/Squidex/app/features/administration/services/event-consumers.service.spec.ts b/src/Squidex/app/features/administration/services/event-consumers.service.spec.ts index 5eacb6d62..33bb41306 100644 --- a/src/Squidex/app/features/administration/services/event-consumers.service.spec.ts +++ b/src/Squidex/app/features/administration/services/event-consumers.service.spec.ts @@ -8,9 +8,13 @@ import { HttpClientTestingModule, HttpTestingController } from '@angular/common/http/testing'; import { inject, TestBed } from '@angular/core/testing'; -import { ApiUrlConfig } from '@app/framework'; +import { ApiUrlConfig, Resource } from '@app/framework'; -import { EventConsumerDto, EventConsumersService } from './event-consumers.service'; +import { + EventConsumerDto, + EventConsumersDto, + EventConsumersService +} from './event-consumers.service'; describe('EventConsumersService', () => { beforeEach(() => { @@ -32,7 +36,7 @@ describe('EventConsumersService', () => { it('should make get request to get event consumers', inject([EventConsumersService, HttpTestingController], (eventConsumersService: EventConsumersService, httpMock: HttpTestingController) => { - let eventConsumers: EventConsumerDto[]; + let eventConsumers: EventConsumersDto; eventConsumersService.getEventConsumers().subscribe(result => { eventConsumers = result; @@ -43,66 +47,120 @@ describe('EventConsumersService', () => { expect(req.request.method).toEqual('GET'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush([ - { - name: 'event-consumer1', - position: '13', - isStopped: true, - isResetting: true, - error: 'an error 1' - }, - { - name: 'event-consumer2', - position: '29', - isStopped: true, - isResetting: true, - error: 'an error 2' - } - ]); + req.flush({ + items: [ + eventConsumerResponse(12), + eventConsumerResponse(13) + ] + }); expect(eventConsumers!).toEqual( - [ - new EventConsumerDto('event-consumer1', true, true, 'an error 1', '13'), - new EventConsumerDto('event-consumer2', true, true, 'an error 2', '29') - ]); + new EventConsumersDto([ + createEventConsumer(12), + createEventConsumer(13) + ])); })); it('should make put request to start event consumer', inject([EventConsumersService, HttpTestingController], (eventConsumersService: EventConsumersService, httpMock: HttpTestingController) => { - eventConsumersService.putStart('event-consumer1').subscribe(); + const resource: Resource = { + _links: { + start: { method: 'PUT', href: 'api/event-consumers/event-consumer123/start' } + } + }; + + let eventConsumer: EventConsumerDto; - const req = httpMock.expectOne('http://service/p/api/event-consumers/event-consumer1/start'); + eventConsumersService.putStart(resource).subscribe(response => { + eventConsumer = response; + }); + + const req = httpMock.expectOne('http://service/p/api/event-consumers/event-consumer123/start'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush({}); + req.flush(eventConsumerResponse(123)); + + expect(eventConsumer!).toEqual(createEventConsumer(123)); })); it('should make put request to stop event consumer', inject([EventConsumersService, HttpTestingController], (eventConsumersService: EventConsumersService, httpMock: HttpTestingController) => { - eventConsumersService.putStop('event-consumer1').subscribe(); + const resource: Resource = { + _links: { + stop: { method: 'PUT', href: 'api/event-consumers/event-consumer123/stop' } + } + }; + + let eventConsumer: EventConsumerDto; - const req = httpMock.expectOne('http://service/p/api/event-consumers/event-consumer1/stop'); + eventConsumersService.putStop(resource).subscribe(response => { + eventConsumer = response; + }); + + const req = httpMock.expectOne('http://service/p/api/event-consumers/event-consumer123/stop'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush({}); + req.flush(eventConsumerResponse(12)); + + expect(eventConsumer!).toEqual(createEventConsumer(12)); })); it('should make put request to reset event consumer', inject([EventConsumersService, HttpTestingController], (eventConsumersService: EventConsumersService, httpMock: HttpTestingController) => { - eventConsumersService.putReset('event-consumer1').subscribe(); + const resource: Resource = { + _links: { + reset: { method: 'PUT', href: 'api/event-consumers/event-consumer123/reset' } + } + }; + + let eventConsumer: EventConsumerDto; - const req = httpMock.expectOne('http://service/p/api/event-consumers/event-consumer1/reset'); + eventConsumersService.putReset(resource).subscribe(response => { + eventConsumer = response; + }); + + const req = httpMock.expectOne('http://service/p/api/event-consumers/event-consumer123/reset'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush({}); + req.flush(eventConsumerResponse(12)); + + expect(eventConsumer!).toEqual(createEventConsumer(12)); })); -}); \ No newline at end of file + + function eventConsumerResponse(id: number) { + return { + name: `event-consumer${id}`, + position: `position-${id}`, + isStopped: true, + isResetting: true, + error: `failure-${id}`, + _links: { + reset: { method: 'PUT', href: `/event-consumers/${id}/reset` } + } + }; + } +}); + +export function createEventConsumer(id: number, suffix = '') { + const result = new EventConsumerDto( + `event-consumer${id}`, + true, + true, + `failure-${id}${suffix}`, + `position-${id}${suffix}`); + + result._links['reset'] = { + method: 'PUT', href: `/event-consumers/${id}/reset` + }; + + return result; +} \ No newline at end of file diff --git a/src/Squidex/app/features/administration/services/event-consumers.service.ts b/src/Squidex/app/features/administration/services/event-consumers.service.ts index 05b2cd0fd..5c49b1980 100644 --- a/src/Squidex/app/features/administration/services/event-consumers.service.ts +++ b/src/Squidex/app/features/administration/services/event-consumers.service.ts @@ -12,11 +12,24 @@ import { map } from 'rxjs/operators'; import { ApiUrlConfig, - Model, - pretifyError + pretifyError, + Resource, + ResourceLinks, + withLinks } from '@app/shared'; -export class EventConsumerDto extends Model { +export class EventConsumersDto { + public readonly _links: ResourceLinks = {}; + + constructor( + public readonly items: EventConsumerDto[] + ) { + } +} + +export class EventConsumerDto { + public readonly _links: ResourceLinks = {}; + constructor( public readonly name: string, public readonly isStopped?: boolean, @@ -24,7 +37,6 @@ export class EventConsumerDto extends Model { public readonly error?: string, public readonly position?: string ) { - super(); } } @@ -36,42 +48,62 @@ export class EventConsumersService { ) { } - public getEventConsumers(): Observable { + public getEventConsumers(): Observable { const url = this.apiUrl.buildUrl('/api/event-consumers'); - return this.http.get(url).pipe( + return this.http.get<{ items: any[] } & Resource>(url).pipe( map(body => { - const eventConsumers = body.map(item => - new EventConsumerDto( - item.name, - item.isStopped, - item.isResetting, - item.error, - item.position)); - - return eventConsumers; + const eventConsumers = body.items.map(item => parseEventConsumer(item)); + + return withLinks(new EventConsumersDto(eventConsumers), body); }), pretifyError('Failed to load event consumers. Please reload.')); } - public putStart(name: string): Observable { - const url = this.apiUrl.buildUrl(`api/event-consumers/${name}/start`); + public putStart(eventConsumer: Resource): Observable { + const link = eventConsumer._links['start']; - return this.http.put(url, {}).pipe( + const url = this.apiUrl.buildUrl(link.href); + + return this.http.request(link.method, url).pipe( + map(body => { + return parseEventConsumer(body); + }), pretifyError('Failed to start event consumer. Please reload.')); } - public putStop(name: string): Observable { - const url = this.apiUrl.buildUrl(`api/event-consumers/${name}/stop`); + public putStop(eventConsumer: Resource): Observable { + const link = eventConsumer._links['stop']; + + const url = this.apiUrl.buildUrl(link.href); - return this.http.put(url, {}).pipe( + return this.http.request(link.method, url).pipe( + map(body => { + return parseEventConsumer(body); + }), pretifyError('Failed to stop event consumer. Please reload.')); } - public putReset(name: string): Observable { - const url = this.apiUrl.buildUrl(`api/event-consumers/${name}/reset`); + public putReset(eventConsumer: Resource): Observable { + const link = eventConsumer._links['reset']; + + const url = this.apiUrl.buildUrl(link.href); - return this.http.put(url, {}).pipe( + return this.http.request(link.method, url).pipe( + map(body => { + return parseEventConsumer(body); + }), pretifyError('Failed to reset event consumer. Please reload.')); } -} \ No newline at end of file +} + +function parseEventConsumer(response: any): EventConsumerDto { + return withLinks( + new EventConsumerDto( + response.name, + response.isStopped, + response.isResetting, + response.error, + response.position), + response); +} diff --git a/src/Squidex/app/features/administration/services/users.service.spec.ts b/src/Squidex/app/features/administration/services/users.service.spec.ts index 03b9b68fb..825f962f6 100644 --- a/src/Squidex/app/features/administration/services/users.service.spec.ts +++ b/src/Squidex/app/features/administration/services/users.service.spec.ts @@ -227,7 +227,8 @@ describe('UsersService', () => { }); export function createUser(id: number, suffix = '') { - const result = new UserDto(`${id}`, + const result = new UserDto( + `${id}`, `user${id}${suffix}@domain.com`, `user${id}${suffix}`, [ diff --git a/src/Squidex/app/features/administration/state/event-consumers.state.spec.ts b/src/Squidex/app/features/administration/state/event-consumers.state.spec.ts index 4a69ffbeb..ba384f5d1 100644 --- a/src/Squidex/app/features/administration/state/event-consumers.state.spec.ts +++ b/src/Squidex/app/features/administration/state/event-consumers.state.spec.ts @@ -11,14 +11,14 @@ import { IMock, It, Mock, Times } from 'typemoq'; import { DialogService } from '@app/framework'; -import { EventConsumerDto, EventConsumersService } from '@app/features/administration/internal'; +import { EventConsumersDto, EventConsumersService } from '@app/features/administration/internal'; import { EventConsumersState } from './event-consumers.state'; +import { createEventConsumer } from './../services/event-consumers.service.spec'; + describe('EventConsumersState', () => { - const oldConsumers = [ - new EventConsumerDto('name1', false, false, 'error', '1'), - new EventConsumerDto('name2', true, true, 'error', '2') - ]; + const eventConsumer1 = createEventConsumer(1); + const eventConsumer2 = createEventConsumer(2); let dialogs: IMock; let eventConsumersService: IMock; @@ -38,11 +38,11 @@ describe('EventConsumersState', () => { describe('Loading', () => { it('should load event consumers', () => { eventConsumersService.setup(x => x.getEventConsumers()) - .returns(() => of(oldConsumers)).verifiable(); + .returns(() => of(new EventConsumersDto([eventConsumer1, eventConsumer2]))).verifiable(); eventConsumersState.load().subscribe(); - expect(eventConsumersState.snapshot.eventConsumers.values).toEqual(oldConsumers); + expect(eventConsumersState.snapshot.eventConsumers.values).toEqual([eventConsumer1, eventConsumer2]); expect(eventConsumersState.snapshot.isLoaded).toBeTruthy(); dialogs.verify(x => x.notifyInfo(It.isAnyString()), Times.never()); @@ -50,7 +50,7 @@ describe('EventConsumersState', () => { it('should show notification on load when reload is true', () => { eventConsumersService.setup(x => x.getEventConsumers()) - .returns(() => of(oldConsumers)).verifiable(); + .returns(() => of(new EventConsumersDto([eventConsumer1, eventConsumer2]))).verifiable(); eventConsumersState.load(true).subscribe(); @@ -74,42 +74,48 @@ describe('EventConsumersState', () => { describe('Updates', () => { beforeEach(() => { eventConsumersService.setup(x => x.getEventConsumers()) - .returns(() => of(oldConsumers)).verifiable(); + .returns(() => of(new EventConsumersDto([eventConsumer1, eventConsumer2]))).verifiable(); eventConsumersState.load().subscribe(); }); - it('should unmark as stopped when started', () => { - eventConsumersService.setup(x => x.putStart(oldConsumers[1].name)) - .returns(() => of({})).verifiable(); + it('should update evnet consumer when started', () => { + const updated = createEventConsumer(2, '_new'); + + eventConsumersService.setup(x => x.putStart(eventConsumer2)) + .returns(() => of(updated)).verifiable(); - eventConsumersState.start(oldConsumers[1]).subscribe(); + eventConsumersState.start(eventConsumer2).subscribe(); - const es_1 = eventConsumersState.snapshot.eventConsumers.at(1); + const newConsumer2 = eventConsumersState.snapshot.eventConsumers.at(1); - expect(es_1.isStopped).toBeFalsy(); + expect(newConsumer2).toEqual(updated); }); - it('should mark as stopped when stopped', () => { - eventConsumersService.setup(x => x.putStop(oldConsumers[0].name)) - .returns(() => of({})).verifiable(); + it('should update event consumer when stopped', () => { + const updated = createEventConsumer(2, '_new'); - eventConsumersState.stop(oldConsumers[0]).subscribe(); + eventConsumersService.setup(x => x.putStop(eventConsumer2)) + .returns(() => of(updated)).verifiable(); - const es_1 = eventConsumersState.snapshot.eventConsumers.at(0); + eventConsumersState.stop(eventConsumer2).subscribe(); - expect(es_1.isStopped).toBeTruthy(); + const newConsumer2 = eventConsumersState.snapshot.eventConsumers.at(1); + + expect(newConsumer2).toEqual(updated); }); - it('should mark as resetting when reset', () => { - eventConsumersService.setup(x => x.putReset(oldConsumers[0].name)) - .returns(() => of({})).verifiable(); + it('should update event consumer when reset', () => { + const updated = createEventConsumer(2, '_new'); + + eventConsumersService.setup(x => x.putReset(eventConsumer2)) + .returns(() => of(updated)).verifiable(); - eventConsumersState.reset(oldConsumers[0]).subscribe(); + eventConsumersState.reset(eventConsumer2).subscribe(); - const es_1 = eventConsumersState.snapshot.eventConsumers.at(0); + const newConsumer2 = eventConsumersState.snapshot.eventConsumers.at(1); - expect(es_1.isResetting).toBeTruthy(); + expect(newConsumer2).toEqual(updated); }); }); }); \ No newline at end of file diff --git a/src/Squidex/app/features/administration/state/event-consumers.state.ts b/src/Squidex/app/features/administration/state/event-consumers.state.ts index f5c5a0d1d..278578beb 100644 --- a/src/Squidex/app/features/administration/state/event-consumers.state.ts +++ b/src/Squidex/app/features/administration/state/event-consumers.state.ts @@ -51,12 +51,12 @@ export class EventConsumersState extends State { } return this.eventConsumersService.getEventConsumers().pipe( - tap(payload => { + tap(({ items }) => { if (isReload && !silent) { this.dialogs.notifyInfo('Event Consumers reloaded.'); } - const eventConsumers = ImmutableArray.of(payload); + const eventConsumers = ImmutableArray.of(items); this.next(s => { return { ...s, eventConsumers, isLoaded: true }; @@ -66,8 +66,7 @@ export class EventConsumersState extends State { } public start(eventConsumer: EventConsumerDto): Observable { - return this.eventConsumersService.putStart(eventConsumer.name).pipe( - map(() => setStopped(eventConsumer, false)), + return this.eventConsumersService.putStart(eventConsumer).pipe( tap(updated => { this.replaceEventConsumer(updated); }), @@ -75,8 +74,7 @@ export class EventConsumersState extends State { } public stop(eventConsumer: EventConsumerDto): Observable { - return this.eventConsumersService.putStop(eventConsumer.name).pipe( - map(() => setStopped(eventConsumer, true)), + return this.eventConsumersService.putStop(eventConsumer).pipe( tap(updated => { this.replaceEventConsumer(updated); }), @@ -84,8 +82,7 @@ export class EventConsumersState extends State { } public reset(eventConsumer: EventConsumerDto): Observable { - return this.eventConsumersService.putReset(eventConsumer.name).pipe( - map(() => reset(eventConsumer)), + return this.eventConsumersService.putReset(eventConsumer).pipe( tap(updated => { this.replaceEventConsumer(updated); }), @@ -99,10 +96,4 @@ export class EventConsumersState extends State { return { ...s, eventConsumers }; }); } -} - -const setStopped = (eventConsumer: EventConsumerDto, isStopped: boolean) => - eventConsumer.with({ isStopped }); - -const reset = (eventConsumer: EventConsumerDto) => - eventConsumer.with({ isResetting: true }); \ No newline at end of file +} \ No newline at end of file diff --git a/src/Squidex/app/features/administration/state/users.state.spec.ts b/src/Squidex/app/features/administration/state/users.state.spec.ts index b9e4971db..3000bf6f6 100644 --- a/src/Squidex/app/features/administration/state/users.state.spec.ts +++ b/src/Squidex/app/features/administration/state/users.state.spec.ts @@ -168,7 +168,7 @@ describe('UsersState', () => { expect(usersState.snapshot.selectedUser).toBeNull(); }); - it('should mark as locked when locked', () => { + it('should update user selected user when locked', () => { const updated = createUser(2, '_new'); usersService.setup(x => x.lockUser(user2)) @@ -177,12 +177,12 @@ describe('UsersState', () => { usersState.select(user2.id).subscribe(); usersState.lock(user2).subscribe(); - const userUser2 = usersState.snapshot.users.at(1); + const newUser2 = usersState.snapshot.users.at(1); - expect(userUser2).toBe(usersState.snapshot.selectedUser!); + expect(newUser2).toBe(usersState.snapshot.selectedUser!); }); - it('should unmark as locked when unlocked', () => { + it('should update user and selected user when unlocked', () => { const updated = createUser(2, '_new'); usersService.setup(x => x.unlockUser(user2)) @@ -197,7 +197,7 @@ describe('UsersState', () => { expect(newUser2).toBe(usersState.snapshot.selectedUser!); }); - it('should update user properties when updated', () => { + it('should update user and selected user when updated', () => { const request = { email: 'new@mail.com', displayName: 'New', permissions: ['Permission1'] }; const updated = createUser(2, '_new'); From 242df48c18e66466980b5a0ba6ba0de03ccb9e37 Mon Sep 17 00:00:00 2001 From: Sebastian Date: Sat, 8 Jun 2019 21:10:30 +0200 Subject: [PATCH 04/64] Some progress. --- src/Squidex.Shared/Permissions.cs | 2 - src/Squidex.Web/PermissionExtensions.cs | 18 +-- .../Controllers/Apps/AppPatternsController.cs | 2 +- .../Api/Controllers/Apps/AppsController.cs | 4 +- .../Api/Controllers/Apps/Models/AppDto.cs | 91 ++++++++++- .../Controllers/Plans/AppPlansController.cs | 2 +- .../Schemas/Models/SchemaDetailsDto.cs | 70 +-------- .../Controllers/Schemas/Models/SchemaDto.cs | 20 ++- .../Controllers/Schemas/SchemasController.cs | 4 +- .../Controllers/Users/Models/ResourcesDto.cs | 39 +++++ .../Api/Controllers/Users/UsersController.cs | 17 ++ .../administration-area.component.html | 8 +- .../administration-area.component.ts | 6 + .../pages/dashboard-page.component.html | 2 +- .../pages/dashboard-page.component.ts | 5 +- .../settings/settings-area.component.html | 18 +-- .../framework/angular/http/hateos.pipes.ts | 20 +-- src/Squidex/app/framework/internal.ts | 1 - src/Squidex/app/framework/module.ts | 3 - .../app/framework/utils/permission.spec.ts | 145 ------------------ src/Squidex/app/framework/utils/permission.ts | 116 -------------- .../components/asset-uploader.component.html | 2 +- .../shared/components/permission.directive.ts | 133 ---------------- .../components/schema-category.component.html | 2 +- src/Squidex/app/shared/declarations.ts | 1 - src/Squidex/app/shared/module.ts | 3 - .../app/shared/services/apps.service.spec.ts | 7 +- .../app/shared/services/apps.service.ts | 37 +++-- .../app/shared/services/auth.service.ts | 21 +-- .../app/shared/services/users.service.spec.ts | 28 ++++ .../app/shared/services/users.service.ts | 21 ++- .../app/shared/state/apps.state.spec.ts | 9 +- src/Squidex/app/shared/state/apps.state.ts | 9 +- src/Squidex/app/shared/state/ui.state.spec.ts | 23 ++- src/Squidex/app/shared/state/ui.state.ts | 37 +++-- .../shell/pages/app/left-menu.component.html | 14 +- .../shell/pages/app/left-menu.component.ts | 3 +- .../pages/internal/apps-menu.component.html | 24 ++- .../internal/profile-menu.component.html | 8 +- .../pages/internal/profile-menu.component.ts | 4 +- 40 files changed, 369 insertions(+), 610 deletions(-) create mode 100644 src/Squidex/Areas/Api/Controllers/Users/Models/ResourcesDto.cs delete mode 100644 src/Squidex/app/framework/utils/permission.spec.ts delete mode 100644 src/Squidex/app/framework/utils/permission.ts delete mode 100644 src/Squidex/app/shared/components/permission.directive.ts diff --git a/src/Squidex.Shared/Permissions.cs b/src/Squidex.Shared/Permissions.cs index 964925efb..ee1e20cf4 100644 --- a/src/Squidex.Shared/Permissions.cs +++ b/src/Squidex.Shared/Permissions.cs @@ -79,7 +79,6 @@ namespace Squidex.Shared public const string AppRolesDelete = "squidex.apps.{app}.roles.delete"; public const string AppPatterns = "squidex.apps.{app}.patterns"; - public const string AppPatternsRead = "squidex.apps.{app}.patterns.read"; public const string AppPatternsCreate = "squidex.apps.{app}.patterns.create"; public const string AppPatternsUpdate = "squidex.apps.{app}.patterns.update"; public const string AppPatternsDelete = "squidex.apps.{app}.patterns.delete"; @@ -117,7 +116,6 @@ namespace Squidex.Shared public const string AppContents = "squidex.apps.{app}.contents.{name}"; public const string AppContentsRead = "squidex.apps.{app}.contents.{name}.read"; - public const string AppContentsGraphQL = "squidex.apps.{app}.contents.{name}.graphql"; public const string AppContentsCreate = "squidex.apps.{app}.contents.{name}.create"; public const string AppContentsUpdate = "squidex.apps.{app}.contents.{name}.update"; public const string AppContentsDiscard = "squidex.apps.{app}.contents.{name}.discard"; diff --git a/src/Squidex.Web/PermissionExtensions.cs b/src/Squidex.Web/PermissionExtensions.cs index 6dc7d0610..a6751e9e9 100644 --- a/src/Squidex.Web/PermissionExtensions.cs +++ b/src/Squidex.Web/PermissionExtensions.cs @@ -24,7 +24,7 @@ namespace Squidex.Web } } - public static PermissionSet GetPermissions(this HttpContext httpContext) + public static PermissionSet Permissions(this HttpContext httpContext) { var feature = httpContext.Features.Get(); @@ -38,22 +38,22 @@ namespace Squidex.Web return feature.Permissions; } - public static bool HasPermission(this HttpContext httpContext, Permission permission) + public static bool HasPermission(this HttpContext httpContext, Permission permission, PermissionSet permissions = null) { - return httpContext.GetPermissions().Includes(permission); + return httpContext.Permissions().Includes(permission) || permission?.Includes(permission) == true; } - public static bool HasPermission(this HttpContext httpContext, string id, string app = "*", string schema = "*") + public static bool HasPermission(this HttpContext httpContext, string id, string app = "*", string schema = "*", PermissionSet permissions = null) { - return httpContext.GetPermissions().Includes(Permissions.ForApp(id, app, schema)); + return httpContext.HasPermission(Shared.Permissions.ForApp(id, app, schema), permissions); } - public static bool HasPermission(this ApiController controller, Permission permission) + public static bool HasPermission(this ApiController controller, Permission permission, PermissionSet permissions = null) { - return controller.HttpContext.GetPermissions().Includes(permission); + return controller.HttpContext.HasPermission(permission, permissions); } - public static bool HasPermission(this ApiController controller, string id, string app = "*", string schema = "*") + public static bool HasPermission(this ApiController controller, string id, string app = "*", string schema = "*", PermissionSet permissions = null) { if (app == "*") { @@ -71,7 +71,7 @@ namespace Squidex.Web } } - return controller.HttpContext.GetPermissions().Includes(Permissions.ForApp(id, app, schema)); + return controller.HasPermission(Shared.Permissions.ForApp(id, app, schema), permissions); } } } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/AppPatternsController.cs b/src/Squidex/Areas/Api/Controllers/Apps/AppPatternsController.cs index fd4fac1c5..fef02c374 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/AppPatternsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/AppPatternsController.cs @@ -43,7 +43,7 @@ namespace Squidex.Areas.Api.Controllers.Apps [HttpGet] [Route("apps/{app}/patterns/")] [ProducesResponseType(typeof(AppPatternDto[]), 200)] - [ApiPermission(Permissions.AppPatternsRead)] + [ApiPermission(Permissions.AppCommon)] [ApiCosts(0)] public IActionResult GetPatterns(string app) { diff --git a/src/Squidex/Areas/Api/Controllers/Apps/AppsController.cs b/src/Squidex/Areas/Api/Controllers/Apps/AppsController.cs index 4219f42dd..36f336ced 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/AppsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/AppsController.cs @@ -58,11 +58,11 @@ namespace Squidex.Areas.Api.Controllers.Apps public async Task GetApps() { var userOrClientId = HttpContext.User.UserOrClientId(); - var userPermissions = HttpContext.User.Permissions(); + var userPermissions = HttpContext.Permissions(); var entities = await appProvider.GetUserApps(userOrClientId, userPermissions); - var response = entities.ToArray(a => AppDto.FromApp(a, userOrClientId, userPermissions, appPlansProvider)); + var response = entities.ToArray(a => AppDto.FromApp(a, userOrClientId, userPermissions, appPlansProvider, this)); Response.Headers[HeaderNames.ETag] = response.ToManyEtag(); diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/AppDto.cs index 7fe96d7bc..dbb2f4ded 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/AppDto.cs @@ -9,6 +9,11 @@ using System; using System.Collections.Generic; using System.ComponentModel.DataAnnotations; using NodaTime; +using Squidex.Areas.Api.Controllers.Assets; +using Squidex.Areas.Api.Controllers.Backups; +using Squidex.Areas.Api.Controllers.Plans; +using Squidex.Areas.Api.Controllers.Rules; +using Squidex.Areas.Api.Controllers.Schemas; using Squidex.Domain.Apps.Entities.Apps; using Squidex.Domain.Apps.Entities.Apps.Services; using Squidex.Infrastructure; @@ -16,10 +21,11 @@ using Squidex.Infrastructure.Reflection; using Squidex.Infrastructure.Security; using Squidex.Shared; using Squidex.Web; +using AllPermissions = Squidex.Shared.Permissions; namespace Squidex.Areas.Api.Controllers.Apps.Models { - public sealed class AppDto : IGenerateETag + public sealed class AppDto : Resource, IGenerateETag { /// /// The name of the app. @@ -63,7 +69,7 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models /// public string PlanUpgrade { get; set; } - public static AppDto FromApp(IAppEntity app, string userId, PermissionSet userPermissions, IAppPlansProvider plans) + public static AppDto FromApp(IAppEntity app, string userId, PermissionSet userPermissions, IAppPlansProvider plans, ApiController controller) { var permissions = new List(); @@ -77,13 +83,84 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models permissions.AddRange(userPermissions.ToAppPermissions(app.Name)); } - var response = SimpleMapper.Map(app, new AppDto()); + var result = SimpleMapper.Map(app, new AppDto()); - response.Permissions = permissions.ToArray(x => x.Id); - response.PlanName = plans.GetPlanForApp(app)?.Name; - response.PlanUpgrade = plans.GetPlanUpgradeForApp(app)?.Name; + result.Permissions = permissions.ToArray(x => x.Id); + result.PlanName = plans.GetPlanForApp(app)?.Name; - return response; + if (controller.HasPermission(AllPermissions.AppPlansChange, app.Name)) + { + result.PlanUpgrade = plans.GetPlanUpgradeForApp(app)?.Name; + } + + return CreateLinks(result, controller, new PermissionSet(permissions)); + } + + private static AppDto CreateLinks(AppDto result, ApiController controller, PermissionSet permissions) + { + var values = new { app = result.Name }; + + if (controller.HasPermission(AllPermissions.AppDelete, result.Name, permissions: permissions)) + { + result.AddDeleteLink("delete", controller.Url(x => nameof(x.DeleteApp), values)); + } + + if (controller.HasPermission(AllPermissions.AppAssetsRead, result.Name, permissions: permissions)) + { + result.AddGetLink("assets", controller.Url(x => nameof(x.GetAssets), values)); + } + + if (controller.HasPermission(AllPermissions.AppBackupsRead, result.Name, permissions: permissions)) + { + result.AddGetLink("backups", controller.Url(x => nameof(x.GetJobs), values)); + } + + if (controller.HasPermission(AllPermissions.AppClientsRead, result.Name, permissions: permissions)) + { + result.AddGetLink("clients", controller.Url(x => nameof(x.GetClients), values)); + } + + if (controller.HasPermission(AllPermissions.AppContributorsRead, result.Name, permissions: permissions)) + { + result.AddGetLink("contributors", controller.Url(x => nameof(x.GetContributors), values)); + } + + if (controller.HasPermission(AllPermissions.AppCommon, result.Name, permissions: permissions)) + { + result.AddGetLink("languages", controller.Url(x => nameof(x.GetLanguages), values)); + } + + if (controller.HasPermission(AllPermissions.AppCommon, result.Name, permissions: permissions)) + { + result.AddGetLink("patterns", controller.Url(x => nameof(x.GetPatterns), values)); + } + + if (controller.HasPermission(AllPermissions.AppPlansRead, result.Name, permissions: permissions)) + { + result.AddGetLink("plans", controller.Url(x => nameof(x.GetPlans), values)); + } + + if (controller.HasPermission(AllPermissions.AppRolesRead, result.Name, permissions: permissions)) + { + result.AddGetLink("roles", controller.Url(x => nameof(x.GetRoles), values)); + } + + if (controller.HasPermission(AllPermissions.AppRulesRead, result.Name, permissions: permissions)) + { + result.AddGetLink("rules", controller.Url(x => nameof(x.GetRules), values)); + } + + if (controller.HasPermission(AllPermissions.AppCommon, result.Name, permissions: permissions)) + { + result.AddGetLink("schemas", controller.Url(x => nameof(x.GetSchemas), values)); + } + + if (controller.HasPermission(AllPermissions.AppSchemasCreate, result.Name, permissions: permissions)) + { + result.AddPostLink("schemas/create", controller.Url(x => nameof(x.PostSchema), values)); + } + + return result; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Plans/AppPlansController.cs b/src/Squidex/Areas/Api/Controllers/Plans/AppPlansController.cs index 9490a4f48..5611ac7ac 100644 --- a/src/Squidex/Areas/Api/Controllers/Plans/AppPlansController.cs +++ b/src/Squidex/Areas/Api/Controllers/Plans/AppPlansController.cs @@ -74,7 +74,7 @@ namespace Squidex.Areas.Api.Controllers.Plans [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppPlansChange)] [ApiCosts(0)] - public async Task ChangePlanAsync(string app, [FromBody] ChangePlanDto request) + public async Task PutPlan(string app, [FromBody] ChangePlanDto request) { var context = await CommandBus.PublishAsync(request.ToCommand()); diff --git a/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDetailsDto.cs b/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDetailsDto.cs index a6ed2b46b..41494e0c1 100644 --- a/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDetailsDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDetailsDto.cs @@ -5,49 +5,20 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== -using System; using System.Collections.Generic; using System.ComponentModel.DataAnnotations; -using NodaTime; using Squidex.Areas.Api.Controllers.Schemas.Models.Converters; using Squidex.Domain.Apps.Core.Schemas; using Squidex.Domain.Apps.Entities.Schemas; -using Squidex.Infrastructure; using Squidex.Infrastructure.Reflection; +using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Schemas.Models { - public sealed class SchemaDetailsDto + public sealed class SchemaDetailsDto : SchemaDto { private static readonly Dictionary EmptyPreviewUrls = new Dictionary(); - /// - /// The id of the schema. - /// - public Guid Id { get; set; } - - /// - /// The name of the schema. Unique within the app. - /// - [Required] - [RegularExpression("^[a-z0-9]+(\\-[a-z0-9]+)*$")] - public string Name { get; set; } - - /// - /// The name of the category. - /// - public string Category { get; set; } - - /// - /// Indicates if the schema is a singleton. - /// - public bool IsSingleton { get; set; } - - /// - /// Indicates if the schema is published. - /// - public bool IsPublished { get; set; } - /// /// The scripts. /// @@ -64,40 +35,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas.Models [Required] public List Fields { get; set; } - /// - /// The schema properties. - /// - [Required] - public SchemaPropertiesDto Properties { get; set; } = new SchemaPropertiesDto(); - - /// - /// The user that has created the schema. - /// - [Required] - public RefToken CreatedBy { get; set; } - - /// - /// The user that has updated the schema. - /// - [Required] - public RefToken LastModifiedBy { get; set; } - - /// - /// The date and time when the schema has been created. - /// - public Instant Created { get; set; } - - /// - /// The date and time when the schema has been modified last. - /// - public Instant LastModified { get; set; } - - /// - /// The version of the schema. - /// - public long Version { get; set; } - - public static SchemaDetailsDto FromSchema(ISchemaEntity schema) + public static SchemaDetailsDto FromSchemaWithDetails(ISchemaEntity schema, ApiController controller, string app) { var response = new SchemaDetailsDto(); @@ -147,7 +85,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas.Models response.Fields.Add(fieldDto); } - return response; + return CreateLinks(response, controller, app); } } } diff --git a/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDto.cs b/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDto.cs index f66d64d23..4bb86680f 100644 --- a/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDto.cs @@ -8,14 +8,16 @@ using System; using System.ComponentModel.DataAnnotations; using NodaTime; +using Squidex.Areas.Api.Controllers.Contents; using Squidex.Domain.Apps.Entities.Schemas; using Squidex.Infrastructure; using Squidex.Infrastructure.Reflection; +using Squidex.Shared; using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Schemas.Models { - public sealed class SchemaDto : IGenerateETag + public class SchemaDto : Resource, IGenerateETag { /// /// The id of the schema. @@ -77,7 +79,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas.Models /// public long Version { get; set; } - public static SchemaDto FromSchema(ISchemaEntity schema) + public static SchemaDto FromSchema(ISchemaEntity schema, ApiController controller, string app) { var response = new SchemaDto { Properties = new SchemaPropertiesDto() }; @@ -85,6 +87,20 @@ namespace Squidex.Areas.Api.Controllers.Schemas.Models SimpleMapper.Map(schema.SchemaDef, response); SimpleMapper.Map(schema.SchemaDef.Properties, response.Properties); + return CreateLinks(response, controller, app); + } + + protected static T CreateLinks(T response, ApiController controller, string app) where T : SchemaDto + { + var values = new { app, name = response.Name }; + + response.AddSelfLink(controller.Url(x => nameof(x.GetSchema), values)); + + if (controller.HasPermission(Permissions.AppContentsRead, app, response.Name)) + { + response.AddGetLink("contents", controller.Url(x => nameof(x.GetContents), values)); + } + return response; } } diff --git a/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs b/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs index 1fb64ec83..7320e4484 100644 --- a/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs +++ b/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs @@ -51,7 +51,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas { var schemas = await appProvider.GetSchemasAsync(AppId); - var response = schemas.ToArray(SchemaDto.FromSchema); + var response = schemas.ToArray(x => SchemaDto.FromSchema(x, this, app)); Response.Headers[HeaderNames.ETag] = response.ToManyEtag(); @@ -90,7 +90,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas return NotFound(); } - var response = SchemaDetailsDto.FromSchema(entity); + var response = SchemaDetailsDto.FromSchemaWithDetails(entity, this, app); Response.Headers[HeaderNames.ETag] = entity.Version.ToString(); diff --git a/src/Squidex/Areas/Api/Controllers/Users/Models/ResourcesDto.cs b/src/Squidex/Areas/Api/Controllers/Users/Models/ResourcesDto.cs new file mode 100644 index 000000000..13570a1bf --- /dev/null +++ b/src/Squidex/Areas/Api/Controllers/Users/Models/ResourcesDto.cs @@ -0,0 +1,39 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschraenkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +using Squidex.Areas.Api.Controllers.Backups; +using Squidex.Areas.Api.Controllers.EventConsumers; +using Squidex.Shared; +using Squidex.Web; + +namespace Squidex.Areas.Api.Controllers.Users.Models +{ + public sealed class ResourcesDto : Resource + { + public static ResourcesDto FromController(ApiController controller) + { + var result = new ResourcesDto(); + + if (controller.HasPermission(Permissions.AdminEventsRead)) + { + result.AddGetLink("admin/eventConsumers", controller.Url(x => nameof(x.GetEventConsumers))); + } + + if (controller.HasPermission(Permissions.AdminRestoreRead)) + { + result.AddGetLink("admin/restore", controller.Url(x => nameof(x.GetJob))); + } + + if (controller.HasPermission(Permissions.AdminUsersRead)) + { + result.AddGetLink("admin/users", controller.Url(x => nameof(x.GetUsers))); + } + + return result; + } + } +} diff --git a/src/Squidex/Areas/Api/Controllers/Users/UsersController.cs b/src/Squidex/Areas/Api/Controllers/Users/UsersController.cs index a5cf31c74..0ab2944c5 100644 --- a/src/Squidex/Areas/Api/Controllers/Users/UsersController.cs +++ b/src/Squidex/Areas/Api/Controllers/Users/UsersController.cs @@ -56,6 +56,23 @@ namespace Squidex.Areas.Api.Controllers.Users this.log = log; } + /// + /// Get the user resources. + /// + /// + /// 200 => User resources returned. + /// + [HttpGet] + [Route("user/resources/")] + [ProducesResponseType(typeof(ResourcesDto), 200)] + [ApiPermission] + public IActionResult GetUserResources() + { + var response = ResourcesDto.FromController(this); + + return Ok(response); + } + /// /// Get users by query. /// diff --git a/src/Squidex/app/features/administration/administration-area.component.html b/src/Squidex/app/features/administration/administration-area.component.html index c3b623cdb..3f2e2c3d0 100644 --- a/src/Squidex/app/features/administration/administration-area.component.html +++ b/src/Squidex/app/features/administration/administration-area.component.html @@ -1,18 +1,18 @@ -
+
    -
  • +
  • Consumers
    • -
  • +
  • Users
    • -
  • +
  • Restore
     diff --git a/src/Squidex/app/features/administration/administration-area.component.ts b/src/Squidex/app/features/administration/administration-area.component.ts index c4f25fd2c..c74360ff7 100644 --- a/src/Squidex/app/features/administration/administration-area.component.ts +++ b/src/Squidex/app/features/administration/administration-area.component.ts @@ -7,10 +7,16 @@ import { Component } from '@angular/core'; +import { UIState } from '@app/shared'; + @Component({ selector: 'sqx-administration-area', styleUrls: ['./administration-area.component.scss'], templateUrl: './administration-area.component.html' }) export class AdministrationAreaComponent { + constructor( + public readonly uiState: UIState + ) { + } } \ No newline at end of file diff --git a/src/Squidex/app/features/dashboard/pages/dashboard-page.component.html b/src/Squidex/app/features/dashboard/pages/dashboard-page.component.html index 78b0002c0..0776d347c 100644 --- a/src/Squidex/app/features/dashboard/pages/dashboard-page.component.html +++ b/src/Squidex/app/features/dashboard/pages/dashboard-page.component.html @@ -12,7 +12,7 @@
- +
diff --git a/src/Squidex/app/features/dashboard/pages/dashboard-page.component.ts b/src/Squidex/app/features/dashboard/pages/dashboard-page.component.ts index 031d5d1b7..59f67b101 100644 --- a/src/Squidex/app/features/dashboard/pages/dashboard-page.component.ts +++ b/src/Squidex/app/features/dashboard/pages/dashboard-page.component.ts @@ -6,10 +6,9 @@ */ import { Component, OnInit } from '@angular/core'; -import { filter, map, switchMap } from 'rxjs/operators'; +import { switchMap } from 'rxjs/operators'; import { - AppDto, AppsState, AuthService, DateTime, @@ -52,7 +51,7 @@ export class DashboardPageComponent extends ResourceOwner implements OnInit { public isPerformanceStacked = false; - public app = this.appsState.selectedApp.pipe(filter(x => !!x), map(x => x)); + public app = this.appsState.selectedValidApp; public chartOptions = { responsive: true, diff --git a/src/Squidex/app/features/settings/settings-area.component.html b/src/Squidex/app/features/settings/settings-area.component.html index 94034eba8..4f4caaa81 100644 --- a/src/Squidex/app/features/settings/settings-area.component.html +++ b/src/Squidex/app/features/settings/settings-area.component.html @@ -6,50 +6,50 @@ -
@@ -37,12 +38,12 @@
-
- +
diff --git a/src/Squidex/app/features/rules/pages/rules/triggers/content-changed-trigger.component.ts b/src/Squidex/app/features/rules/pages/rules/triggers/content-changed-trigger.component.ts index a3e1f140b..0e18f523f 100644 --- a/src/Squidex/app/features/rules/pages/rules/triggers/content-changed-trigger.component.ts +++ b/src/Squidex/app/features/rules/pages/rules/triggers/content-changed-trigger.component.ts @@ -29,6 +29,9 @@ export class ContentChangedTriggerComponent implements OnInit { @Input() public schemas: ImmutableArray; + @Input() + public canUpdate: boolean; + @Input() public trigger: any; diff --git a/src/Squidex/app/framework/angular/forms/toggle.component.ts b/src/Squidex/app/framework/angular/forms/toggle.component.ts index 7105ada32..33e53d9bf 100644 --- a/src/Squidex/app/framework/angular/forms/toggle.component.ts +++ b/src/Squidex/app/framework/angular/forms/toggle.component.ts @@ -28,6 +28,10 @@ export class ToggleComponent extends StatefulControlComponent { const version = new Version('1'); @@ -107,7 +107,7 @@ describe('RulesService', () => { it('should make get request to get app rules', inject([RulesService, HttpTestingController], (rulesService: RulesService, httpMock: HttpTestingController) => { - let rules: RuleDto[]; + let rules: RulesDto; rulesService.getRules('my-app').subscribe(result => { rules = result; @@ -118,49 +118,18 @@ describe('RulesService', () => { expect(req.request.method).toEqual('GET'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush([ - { - id: 'id1', - created: '2016-12-12T10:10', - createdBy: 'CreatedBy1', - lastModified: '2017-12-12T10:10', - lastModifiedBy: 'LastModifiedBy1', - url: 'http://squidex.io/hook', - version: '1', - trigger: { - param1: 1, - param2: 2, - triggerType: 'ContentChanged' - }, - action: { - param3: 3, - param4: 4, - actionType: 'Webhook' - }, - isEnabled: true - } - ]); + req.flush({ + items: [ + ruleResponse(12), + ruleResponse(13) + ] + }); expect(rules!).toEqual( - [ - new RuleDto('id1', 'CreatedBy1', 'LastModifiedBy1', - DateTime.parseISO_UTC('2016-12-12T10:10'), - DateTime.parseISO_UTC('2017-12-12T10:10'), - version, - true, - { - param1: 1, - param2: 2, - triggerType: 'ContentChanged' - }, - 'ContentChanged', - { - param3: 3, - param4: 4, - actionType: 'Webhook' - }, - 'Webhook') - ]); + new RulesDto(2, [ + createRule(12), + createRule(13) + ])); })); it('should make post request to create rule', @@ -179,7 +148,7 @@ describe('RulesService', () => { } }; - let rule: Versioned; + let rule: RuleDto; rulesService.postRule('my-app', dto).subscribe(result => { rule = result; @@ -190,18 +159,13 @@ describe('RulesService', () => { expect(req.request.method).toEqual('POST'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush({ id: 'id1' }, { + req.flush(ruleResponse(12), { headers: { etag: '1' } }); - expect(rule!).toEqual({ - payload: { - id: 'id1' - }, - version - }); + expect(rule!).toEqual(createRule(12)); })); it('should make put request to update rule', @@ -216,46 +180,88 @@ describe('RulesService', () => { } }; - rulesService.putRule('my-app', '123', dto, version).subscribe(); + const resource: Resource = { + _links: { + update: { method: 'PUT', href: '/api/apps/my-app/rules/123' } + } + }; + + let rule: RuleDto; + + rulesService.putRule('my-app', resource, dto, version).subscribe(result => { + rule = result; + }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/rules/123'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({}); + req.flush(ruleResponse(123)); + + expect(rule!).toEqual(createRule(123)); })); it('should make put request to enable rule', inject([RulesService, HttpTestingController], (rulesService: RulesService, httpMock: HttpTestingController) => { - rulesService.enableRule('my-app', '123', version).subscribe(); + const resource: Resource = { + _links: { + enable: { method: 'PUT', href: '/api/apps/my-app/rules/123/enable' } + } + }; + + let rule: RuleDto; + + rulesService.enableRule('my-app', resource, version).subscribe(result => { + rule = result; + }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/rules/123/enable'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({}); + req.flush(ruleResponse(123)); + + expect(rule!).toEqual(createRule(123)); })); it('should make put request to disable rule', inject([RulesService, HttpTestingController], (rulesService: RulesService, httpMock: HttpTestingController) => { - rulesService.disableRule('my-app', '123', version).subscribe(); + const resource: Resource = { + _links: { + disable: { method: 'PUT', href: '/api/apps/my-app/rules/123/disable' } + } + }; + + let rule: RuleDto; + + rulesService.disableRule('my-app', resource, version).subscribe(result => { + rule = result; + }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/rules/123/disable'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({}); + req.flush(ruleResponse(123)); + + expect(rule!).toEqual(createRule(123)); })); it('should make delete request to delete rule', inject([RulesService, HttpTestingController], (rulesService: RulesService, httpMock: HttpTestingController) => { - rulesService.deleteRule('my-app', '123', version).subscribe(); + const resource: Resource = { + _links: { + delete: { method: 'DELETE', href: '/api/apps/my-app/rules/123' } + } + }; + + rulesService.deleteRule('my-app', resource, version).subscribe(); const req = httpMock.expectOne('http://service/p/api/apps/my-app/rules/123'); @@ -322,7 +328,13 @@ describe('RulesService', () => { it('should make put request to enqueue rule event', inject([RulesService, HttpTestingController], (rulesService: RulesService, httpMock: HttpTestingController) => { - rulesService.enqueueEvent('my-app', '123').subscribe(); + const resource: Resource = { + _links: { + update: { method: 'PUT', href: '/api/apps/my-app/rules/events/123' } + } + }; + + rulesService.enqueueEvent('my-app', resource).subscribe(); const req = httpMock.expectOne('http://service/p/api/apps/my-app/rules/events/123'); @@ -335,7 +347,13 @@ describe('RulesService', () => { it('should make delete request to cancel rule event', inject([RulesService, HttpTestingController], (rulesService: RulesService, httpMock: HttpTestingController) => { - rulesService.cancelEvent('my-app', '123').subscribe(); + const resource: Resource = { + _links: { + delete: { method: 'DELETE', href: '/api/apps/my-app/rules/events/123' } + } + }; + + rulesService.cancelEvent('my-app', resource).subscribe(); const req = httpMock.expectOne('http://service/p/api/apps/my-app/rules/events/123'); @@ -344,4 +362,58 @@ describe('RulesService', () => { req.flush({}); })); -}); \ No newline at end of file + + function ruleResponse(id: number, suffix = '') { + return { + id: `id${id}`, + created: `${id % 1000 + 2000}-12-12T10:10`, + createdBy: `creator-${id}`, + lastModified: `${id % 1000 + 2000}-11-11T10:10`, + lastModifiedBy: `modifier-${id}`, + isEnabled: id % 2 === 0, + trigger: { + param1: 1, + param2: 2, + triggerType: `ContentChanged${id}${suffix}` + }, + action: { + param3: 3, + param4: 4, + actionType: `Webhook${id}${suffix}` + }, + version: id, + _links: { + update: { method: 'PUT', href: `/rules/${id}` } + } + }; + } +}); + +export function createRule(id: number, suffix = '') { + const result = new RuleDto( + `id${id}`, + `creator-${id}`, + `modifier-${id}`, + DateTime.parseISO_UTC(`${id % 1000 + 2000}-12-12T10:10`), + DateTime.parseISO_UTC(`${id % 1000 + 2000}-11-11T10:10`), + new Version(`${id}`), + id % 2 === 0, + { + param1: 1, + param2: 2, + triggerType: `ContentChanged${id}${suffix}` + }, + `ContentChanged${id}${suffix}`, + { + param3: 3, + param4: 4, + actionType: `Webhook${id}${suffix}` + }, + `Webhook${id}${suffix}`); + + result._links['update'] = { + method: 'PUT', href: `/rules/${id}` + }; + + return result; +} \ No newline at end of file diff --git a/src/Squidex/app/shared/services/rules.service.ts b/src/Squidex/app/shared/services/rules.service.ts index 7af1acfb7..c0a7030de 100644 --- a/src/Squidex/app/shared/services/rules.service.ts +++ b/src/Squidex/app/shared/services/rules.service.ts @@ -15,12 +15,13 @@ import { ApiUrlConfig, DateTime, HTTP, - mapVersioned, Model, pretifyError, + Resource, + ResourceLinks, ResultSet, Version, - Versioned + withLinks } from '@app/framework'; export const ALL_TRIGGERS = { @@ -74,7 +75,13 @@ export class RuleElementPropertyDto { } } +export class RulesDto extends ResultSet { + public readonly _links: ResourceLinks = {}; +} + export class RuleDto extends Model { + public readonly _links: ResourceLinks = {}; + constructor( public readonly id: string, public readonly createdBy: string, @@ -92,9 +99,13 @@ export class RuleDto extends Model { } } -export class RuleEventsDto extends ResultSet { } +export class RuleEventsDto extends ResultSet { + public readonly _links: ResourceLinks = {}; +} export class RuleEventDto extends Model { + public readonly _links: ResourceLinks = {}; + constructor( public readonly id: string, public readonly created: DateTime, @@ -115,10 +126,6 @@ export interface UpsertRuleDto { readonly action: RuleAction; } -export interface RuleCreatedDto { - readonly id: string; -} - export type RuleAction = { actionType: string } & any; export type RuleTrigger = { triggerType: string } & any; @@ -167,77 +174,87 @@ export class RulesService { pretifyError('Failed to load Rules. Please reload.')); } - public getRules(appName: string): Observable { + public getRules(appName: string): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/rules`); return HTTP.getVersioned(this.http, url).pipe( map(({ payload }) => { - const items: any[] = payload.body; + const items: any[] = payload.body.items; - const rules = items.map(item => - new RuleDto( - item.id, - item.createdBy, - item.lastModifiedBy, - DateTime.parseISO_UTC(item.created), - DateTime.parseISO_UTC(item.lastModified), - new Version(item.version.toString()), - item.isEnabled, - item.trigger, - item.trigger.triggerType, - item.action, - item.action.actionType)); - - return rules; + const rules = items.map(item => parseRule(item)); + + return withLinks(new RulesDto(rules.length, rules), payload.body); }), pretifyError('Failed to load Rules. Please reload.')); } - public postRule(appName: string, dto: UpsertRuleDto): Observable> { + public postRule(appName: string, dto: UpsertRuleDto): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/rules`); - return HTTP.postVersioned(this.http, url, dto).pipe( - mapVersioned(({ body }) => body!), + return HTTP.postVersioned(this.http, url, dto).pipe( + map(({ payload }) => { + return parseRule(payload.body); + }), tap(() => { this.analytics.trackEvent('Rule', 'Created', appName); }), pretifyError('Failed to create rule. Please reload.')); } - public putRule(appName: string, id: string, dto: Partial, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/rules/${id}`); + public putRule(appName: string, resource: Resource, dto: Partial, version: Version): Observable { + const link = resource._links['update']; - return HTTP.putVersioned(this.http, url, dto, version).pipe( + const url = this.apiUrl.buildUrl(link.href); + + return HTTP.requestVersioned(this.http, link.method, url, version, dto).pipe( + map(({ payload }) => { + return parseRule(payload.body); + }), tap(() => { this.analytics.trackEvent('Rule', 'Updated', appName); }), pretifyError('Failed to update rule. Please reload.')); } - public enableRule(appName: string, id: string, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/rules/${id}/enable`); + public enableRule(appName: string, resource: Resource, version: Version): Observable { + const link = resource._links['enable']; - return HTTP.putVersioned(this.http, url, {}, version).pipe( + const url = this.apiUrl.buildUrl(link.href); + + return HTTP.requestVersioned(this.http, link.method, url, version, {}).pipe( + map(({ payload }) => { + return parseRule(payload.body); + }), tap(() => { - this.analytics.trackEvent('Rule', 'Updated', appName); + this.analytics.trackEvent('Rule', 'Enabled', appName); }), pretifyError('Failed to enable rule. Please reload.')); } - public disableRule(appName: string, id: string, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/rules/${id}/disable`); + public disableRule(appName: string, resource: Resource, version: Version): Observable { + const link = resource._links['disable']; - return HTTP.putVersioned(this.http, url, {}, version).pipe( + const url = this.apiUrl.buildUrl(link.href); + + return HTTP.requestVersioned(this.http, link.method, url, version, {}).pipe( + map(({ payload }) => { + return parseRule(payload.body); + }), tap(() => { - this.analytics.trackEvent('Rule', 'Updated', appName); + this.analytics.trackEvent('Rule', 'Disabled', appName); }), pretifyError('Failed to disable rule. Please reload.')); } - public deleteRule(appName: string, id: string, version: Version): Observable { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/rules/${id}`); + public deleteRule(appName: string, resource: Resource, version: Version): Observable { + const link = resource._links['delete']; - return HTTP.deleteVersioned(this.http, url, version).pipe( + const url = this.apiUrl.buildUrl(link.href); + + return HTTP.requestVersioned(this.http, link.method, url, version).pipe( + map(({ payload }) => { + return parseRule(payload.body); + }), tap(() => { this.analytics.trackEvent('Rule', 'Deleted', appName); }), @@ -270,23 +287,44 @@ export class RulesService { pretifyError('Failed to load events. Please reload.')); } - public enqueueEvent(appName: string, id: string): Observable { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/rules/events/${id}`); + public enqueueEvent(appName: string, resource: Resource): Observable { + const link = resource._links['update']; + + const url = this.apiUrl.buildUrl(link.href); - return HTTP.putVersioned(this.http, url, {}).pipe( + return HTTP.requestVersioned(this.http, link.method, url).pipe( tap(() => { this.analytics.trackEvent('Rule', 'EventEnqueued', appName); }), pretifyError('Failed to enqueue rule event. Please reload.')); } - public cancelEvent(appName: string, id: string): Observable { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/rules/events/${id}`); + public cancelEvent(appName: string, resource: Resource): Observable { + const link = resource._links['delete']; - return HTTP.deleteVersioned(this.http, url).pipe( + const url = this.apiUrl.buildUrl(link.href); + + return HTTP.requestVersioned(this.http, link.method, url).pipe( tap(() => { this.analytics.trackEvent('Rule', 'EventDequeued', appName); }), pretifyError('Failed to cancel rule event. Please reload.')); } +} + +function parseRule(resource: any) { + return withLinks( + new RuleDto( + resource.id, + resource.createdBy, + resource.lastModifiedBy, + DateTime.parseISO_UTC(resource.created), + DateTime.parseISO_UTC(resource.lastModified), + new Version(resource.version.toString()), + resource.isEnabled, + resource.trigger, + resource.trigger.triggerType, + resource.action, + resource.action.actionType), + resource); } \ No newline at end of file diff --git a/src/Squidex/app/shared/state/asset-uploader.state.spec.ts b/src/Squidex/app/shared/state/asset-uploader.state.spec.ts index 17413beff..c3a185314 100644 --- a/src/Squidex/app/shared/state/asset-uploader.state.spec.ts +++ b/src/Squidex/app/shared/state/asset-uploader.state.spec.ts @@ -22,7 +22,7 @@ import { createAsset } from './../services/assets.service.spec'; import { TestValues } from './_test-helpers'; -describe('AssetsState', () => { +describe('AssetUploaderState', () => { const { app, appsState @@ -155,7 +155,7 @@ describe('AssetsState', () => { it('should update status when uploading asset completes', () => { const file: File = { name: 'my-file' }; - let updated = createAsset(1, undefined, '-new'); + let updated = createAsset(1, undefined, '_new'); assetsService.setup(x => x.replaceFile(app, asset, file, asset.version)) .returns(() => of(10, 20, updated)).verifiable(); diff --git a/src/Squidex/app/shared/state/assets.state.spec.ts b/src/Squidex/app/shared/state/assets.state.spec.ts index c9f045a02..f8df2c6d7 100644 --- a/src/Squidex/app/shared/state/assets.state.spec.ts +++ b/src/Squidex/app/shared/state/assets.state.spec.ts @@ -41,6 +41,9 @@ describe('AssetsState', () => { dialogs = Mock.ofType(); assetsService = Mock.ofType(); + assetsService.setup(x => x.getTags(app)) + .returns(() => of({ tag1: 1, shared: 2, tag2: 1 })).verifiable(Times.atLeastOnce()); + assetsState = new AssetsState(appsState.object, assetsService.object, dialogs.object); }); @@ -50,12 +53,9 @@ describe('AssetsState', () => { describe('Loading', () => { it('should load assets', () => { - assetsService.setup(x => x.getAssets(app, 30, 0, undefined, [])) + assetsService.setup(x => x.getAssets(app, 30, 0, undefined, It.isValue([]))) .returns(() => of(new AssetsDto(200, [asset1, asset2]))).verifiable(); - assetsService.setup(x => x.getTags(app)) - .returns(() => of({ tag1: 1, shared: 2, tag2: 1 })).verifiable(); - assetsState.load().subscribe(); expect(assetsState.snapshot.assets.values).toEqual([asset1, asset2]); @@ -66,11 +66,8 @@ describe('AssetsState', () => { }); it('should show notification on load when reload is true', () => { - assetsService.setup(x => x.getAssets(app, 30, 0, undefined, [])) - .returns(() => of(new AssetsDto(200, [asset1, asset2]))); - - assetsService.setup(x => x.getTags(app)) - .returns(() => of({ tag1: 1, shared: 2, tag2: 1 })).verifiable(); + assetsService.setup(x => x.getAssets(app, 30, 0, undefined, It.isValue([]))) + .returns(() => of(new AssetsDto(200, [asset1, asset2]))).verifiable(); assetsState.load(true).subscribe(); @@ -80,20 +77,20 @@ describe('AssetsState', () => { }); it('should load with tags when tag toggled', () => { - assetsService.setup(x => x.getAssets(app, 30, 0, undefined, ['tag1'])) - .returns(() => of(new AssetsDto(0, []))); + assetsService.setup(x => x.getAssets(app, 30, 0, undefined, It.isValue(['tag1']))) + .returns(() => of(new AssetsDto(0, []))).verifiable(); assetsState.toggleTag('tag1').subscribe(); expect(assetsState.isTagSelected('tag1')).toBeTruthy(); }); - it('should load without tags when tag toggled', () => { - assetsService.setup(x => x.getAssets(app, 30, 0, undefined, ['tag1'])) - .returns(() => of(new AssetsDto(0, []))); + it('should load without tags when tag untoggled', () => { + assetsService.setup(x => x.getAssets(app, 30, 0, undefined, It.isValue(['tag1']))) + .returns(() => of(new AssetsDto(0, []))).verifiable(); - assetsService.setup(x => x.getAssets(app, 30, 0, undefined, [])) - .returns(() => of(new AssetsDto(0, []))); + assetsService.setup(x => x.getAssets(app, 30, 0, undefined, It.isValue([]))) + .returns(() => of(new AssetsDto(0, []))).verifiable(); assetsState.toggleTag('tag1').subscribe(); assetsState.toggleTag('tag1').subscribe(); @@ -102,8 +99,8 @@ describe('AssetsState', () => { }); it('should load with tags when tags selected', () => { - assetsService.setup(x => x.getAssets(app, 30, 0, undefined, ['tag1', 'tag2'])) - .returns(() => of(new AssetsDto(0, []))); + assetsService.setup(x => x.getAssets(app, 30, 0, undefined, It.isValue(['tag1', 'tag2']))) + .returns(() => of(new AssetsDto(0, []))).verifiable(); assetsState.selectTags(['tag1', 'tag2']).subscribe(); @@ -111,8 +108,8 @@ describe('AssetsState', () => { }); it('should load without tags when tags reset', () => { - assetsService.setup(x => x.getAssets(app, 30, 0, undefined, [])) - .returns(() => of(new AssetsDto(0, []))); + assetsService.setup(x => x.getAssets(app, 30, 0, undefined, It.isValue([]))) + .returns(() => of(new AssetsDto(0, []))).verifiable(); assetsState.resetTags().subscribe(); @@ -120,9 +117,13 @@ describe('AssetsState', () => { }); it('should load next page and prev page when paging', () => { - assetsService.setup(x => x.getAssets(app, 30, 30, undefined, [])) - .returns(() => of(new AssetsDto(200, []))); + assetsService.setup(x => x.getAssets(app, 30, 0, undefined, It.isValue([]))) + .returns(() => of(new AssetsDto(200, []))).verifiable(Times.exactly(2)); + assetsService.setup(x => x.getAssets(app, 30, 30, undefined, It.isValue([]))) + .returns(() => of(new AssetsDto(200, []))).verifiable(); + + assetsState.load().subscribe(); assetsState.goNext().subscribe(); assetsState.goPrev().subscribe(); @@ -130,8 +131,8 @@ describe('AssetsState', () => { }); it('should load with query when searching', () => { - assetsService.setup(x => x.getAssets(app, 30, 0, 'my-query', [])) - .returns(() => of(new AssetsDto(0, []))); + assetsService.setup(x => x.getAssets(app, 30, 0, 'my-query', It.isValue([]))) + .returns(() => of(new AssetsDto(0, []))).verifiable(); assetsState.search('my-query').subscribe(); @@ -141,12 +142,9 @@ describe('AssetsState', () => { describe('Updates', () => { beforeEach(() => { - assetsService.setup(x => x.getAssets(app, 30, 0, undefined, [])) + assetsService.setup(x => x.getAssets(app, 30, 0, undefined, It.isValue([]))) .returns(() => of(new AssetsDto(200, [asset1, asset2]))).verifiable(); - assetsService.setup(x => x.getTags(app)) - .returns(() => of({ tag1: 1, shared: 2, tag2: 1 })).verifiable(); - assetsState.load(true).subscribe(); }); @@ -165,7 +163,7 @@ describe('AssetsState', () => { }); it('should update asset when updated', () => { - const update = createAsset(1, ['new'], '-new'); + const update = createAsset(1, ['new'], '_new'); assetsState.update(update); diff --git a/src/Squidex/app/shared/state/rule-events.state.spec.ts b/src/Squidex/app/shared/state/rule-events.state.spec.ts index 764654588..5adcd6f4a 100644 --- a/src/Squidex/app/shared/state/rule-events.state.spec.ts +++ b/src/Squidex/app/shared/state/rule-events.state.spec.ts @@ -76,24 +76,24 @@ describe('RuleEventsState', () => { }); it('should call service when enqueuing event', () => { - rulesService.setup(x => x.enqueueEvent(app, oldRuleEvents[0].id)) + rulesService.setup(x => x.enqueueEvent(app, oldRuleEvents[0])) .returns(() => of({})); ruleEventsState.enqueue(oldRuleEvents[0]).subscribe(); expect().nothing(); - rulesService.verify(x => x.enqueueEvent(app, oldRuleEvents[0].id), Times.once()); + rulesService.verify(x => x.enqueueEvent(app, oldRuleEvents[0]), Times.once()); }); it('should call service when cancelling event', () => { - rulesService.setup(x => x.cancelEvent(app, oldRuleEvents[0].id)) + rulesService.setup(x => x.cancelEvent(app, oldRuleEvents[0])) .returns(() => of({})); ruleEventsState.cancel(oldRuleEvents[0]).subscribe(); expect().nothing(); - rulesService.verify(x => x.cancelEvent(app, oldRuleEvents[0].id), Times.once()); + rulesService.verify(x => x.cancelEvent(app, oldRuleEvents[0]), Times.once()); }); }); \ No newline at end of file diff --git a/src/Squidex/app/shared/state/rule-events.state.ts b/src/Squidex/app/shared/state/rule-events.state.ts index b9bf61996..8f777b4d5 100644 --- a/src/Squidex/app/shared/state/rule-events.state.ts +++ b/src/Squidex/app/shared/state/rule-events.state.ts @@ -82,7 +82,7 @@ export class RuleEventsState extends State { } public enqueue(event: RuleEventDto): Observable { - return this.rulesService.enqueueEvent(this.appsState.appName, event.id).pipe( + return this.rulesService.enqueueEvent(this.appsState.appName, event).pipe( tap(() => { this.dialogs.notifyInfo('Events enqueued. Will be resend in a few seconds.'); }), @@ -90,7 +90,7 @@ export class RuleEventsState extends State { } public cancel(event: RuleEventDto): Observable { - return this.rulesService.cancelEvent(this.appsState.appName, event.id).pipe( + return this.rulesService.cancelEvent(this.appsState.appName, event).pipe( tap(() => { return this.next(s => { const ruleEvents = s.ruleEvents.replaceBy('id', setCancelled(event)); diff --git a/src/Squidex/app/shared/state/rules.state.spec.ts b/src/Squidex/app/shared/state/rules.state.spec.ts index 6b8a8cdd5..90ed19ada 100644 --- a/src/Squidex/app/shared/state/rules.state.spec.ts +++ b/src/Squidex/app/shared/state/rules.state.spec.ts @@ -12,30 +12,27 @@ import { RulesState } from './rules.state'; import { DialogService, - RuleDto, + RulesDto, RulesService, versioned } from '@app/shared/internal'; +import { createRule } from '../services/rules.service.spec'; + import { TestValues } from './_test-helpers'; describe('RulesState', () => { const { app, appsState, - authService, - creation, - creator, - modified, - modifier, newVersion, version } = TestValues; - const oldRules = [ - new RuleDto('id1', creator, creator, creation, creation, version, false, {}, 'trigger1', {}, 'action1'), - new RuleDto('id2', creator, creator, creation, creation, version, true, {}, 'trigger2', {}, 'action2') - ]; + const rule1 = createRule(1); + const rule2 = createRule(2); + + const newRule = createRule(3); let dialogs: IMock; let rulesService: IMock; @@ -45,7 +42,7 @@ describe('RulesState', () => { dialogs = Mock.ofType(); rulesService = Mock.ofType(); - rulesState = new RulesState(appsState.object, authService.object, dialogs.object, rulesService.object); + rulesState = new RulesState(appsState.object, dialogs.object, rulesService.object); }); afterEach(() => { @@ -55,11 +52,11 @@ describe('RulesState', () => { describe('Loading', () => { it('should load rules', () => { rulesService.setup(x => x.getRules(app)) - .returns(() => of(oldRules)).verifiable(); + .returns(() => of(new RulesDto(2, [rule1, rule2]))).verifiable(); rulesState.load().subscribe(); - expect(rulesState.snapshot.rules.values).toEqual(oldRules); + expect(rulesState.snapshot.rules.values).toEqual([rule1, rule2]); expect(rulesState.snapshot.isLoaded).toBeTruthy(); dialogs.verify(x => x.notifyInfo(It.isAnyString()), Times.never()); @@ -67,7 +64,7 @@ describe('RulesState', () => { it('should show notification on load when reload is true', () => { rulesService.setup(x => x.getRules(app)) - .returns(() => of(oldRules)).verifiable(); + .returns(() => of(new RulesDto(2, [rule1, rule2]))).verifiable(); rulesState.load(true).subscribe(); @@ -81,89 +78,85 @@ describe('RulesState', () => { describe('Updates', () => { beforeEach(() => { rulesService.setup(x => x.getRules(app)) - .returns(() => of(oldRules)).verifiable(); + .returns(() => of(new RulesDto(2, [rule1, rule2]))).verifiable(); rulesState.load().subscribe(); }); it('should add rule to snapshot when created', () => { - const newRule = new RuleDto('id3', modifier, modifier, modified, modified, version, true, { value: 3 }, 'trigger3', { value: 1 }, 'action3'); - const request = { trigger: { triggerType: 'trigger3', value: 3 }, action: { actionType: 'action3', value: 1 } }; rulesService.setup(x => x.postRule(app, request)) - .returns(() => of(versioned(version, { id: 'id3' }))); + .returns(() => of(newRule)); - rulesState.create(request, modified).subscribe(); + rulesState.create(request).subscribe(); - expect(rulesState.snapshot.rules.values).toEqual([...oldRules, newRule]); + expect(rulesState.snapshot.rules.values).toEqual([rule1, rule2, newRule]); }); - it('should update action and update and user info when updated action', () => { + it('should update rule when updated action', () => { const newAction = {}; - rulesService.setup(x => x.putRule(app, oldRules[0].id, It.isAny(), version)) - .returns(() => of(versioned(newVersion))).verifiable(); + const updated = createRule(1, 'new'); + + rulesService.setup(x => x.putRule(app, rule1, It.isAny(), version)) + .returns(() => of(updated)).verifiable(); - rulesState.updateAction(oldRules[0], newAction, modified).subscribe(); + rulesState.updateAction(rule1, newAction).subscribe(); - const rule_1 = rulesState.snapshot.rules.at(0); + const newRule1 = rulesState.snapshot.rules.at(0); - expect(rule_1.action).toBe(newAction); - expectToBeModified(rule_1); + expect(newRule1).toEqual(updated); }); - it('should update trigger and update and user info when updated trigger', () => { + it('should update rule when updated trigger', () => { const newTrigger = {}; - rulesService.setup(x => x.putRule(app, oldRules[0].id, It.isAny(), version)) - .returns(() => of(versioned(newVersion))).verifiable(); + const updated = createRule(1, 'new'); - rulesState.updateTrigger(oldRules[0], newTrigger, modified).subscribe(); + rulesService.setup(x => x.putRule(app, rule1, It.isAny(), version)) + .returns(() => of(updated)).verifiable(); - const rule_1 = rulesState.snapshot.rules.at(0); + rulesState.updateTrigger(rule1, newTrigger).subscribe(); - expect(rule_1.trigger).toBe(newTrigger); - expectToBeModified(rule_1); + const rule1New = rulesState.snapshot.rules.at(0); + + expect(rule1New).toEqual(updated); }); - it('should mark as enabled and update and user info when enabled', () => { - rulesService.setup(x => x.enableRule(app, oldRules[0].id, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + it('should update rule when enabled', () => { + const updated = createRule(1, 'new'); + + rulesService.setup(x => x.enableRule(app, rule1, version)) + .returns(() => of(updated)).verifiable(); - rulesState.enable(oldRules[0], modified).subscribe(); + rulesState.enable(rule1).subscribe(); - const rule_1 = rulesState.snapshot.rules.at(0); + const rule1New = rulesState.snapshot.rules.at(0); - expect(rule_1.isEnabled).toBeTruthy(); - expectToBeModified(rule_1); + expect(rule1New).toEqual(updated); }); - it('should mark as disabled and update and user info when disabled', () => { - rulesService.setup(x => x.disableRule(app, oldRules[1].id, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + it('should update rule when disabled', () => { + const updated = createRule(1, 'new'); + + rulesService.setup(x => x.disableRule(app, rule1, version)) + .returns(() => of(updated)).verifiable(); - rulesState.disable(oldRules[1], modified).subscribe(); + rulesState.disable(rule1).subscribe(); - const rule_1 = rulesState.snapshot.rules.at(1); + const rule1New = rulesState.snapshot.rules.at(0); - expect(rule_1.isEnabled).toBeFalsy(); - expectToBeModified(rule_1); + expect(rule1New).toEqual(updated); }); it('should remove rule from snapshot when deleted', () => { - rulesService.setup(x => x.deleteRule(app, oldRules[0].id, version)) + rulesService.setup(x => x.deleteRule(app, rule1, version)) .returns(() => of(versioned(newVersion))).verifiable(); - rulesState.delete(oldRules[0]).subscribe(); + rulesState.delete(rule1).subscribe(); - expect(rulesState.snapshot.rules.values).toEqual([oldRules[1]]); + expect(rulesState.snapshot.rules.values).toEqual([rule2]); }); - - function expectToBeModified(rule_1: RuleDto) { - expect(rule_1.lastModified).toEqual(modified); - expect(rule_1.lastModifiedBy).toEqual(modifier); - expect(rule_1.version).toEqual(newVersion); - } }); }); \ No newline at end of file diff --git a/src/Squidex/app/shared/state/rules.state.ts b/src/Squidex/app/shared/state/rules.state.ts index 1a0bcac0f..2412433df 100644 --- a/src/Squidex/app/shared/state/rules.state.ts +++ b/src/Squidex/app/shared/state/rules.state.ts @@ -10,20 +10,16 @@ import { Observable } from 'rxjs'; import { distinctUntilChanged, map, tap } from 'rxjs/operators'; import { - DateTime, DialogService, ImmutableArray, + ResourceLinks, shareSubscribed, - State, - Version, - Versioned + State } from '@app/framework'; -import { AuthService} from './../services/auth.service'; import { AppsState } from './apps.state'; import { - RuleCreatedDto, RuleDto, RulesService, UpsertRuleDto @@ -33,6 +29,9 @@ interface Snapshot { // The current rules. rules: RulesList; + // The resource links. + links: ResourceLinks; + // Indicates if the rules are loaded. isLoaded?: boolean; } @@ -49,13 +48,16 @@ export class RulesState extends State { this.changes.pipe(map(x => !!x.isLoaded), distinctUntilChanged()); + public links = + this.changes.pipe(map(x => x.links), + distinctUntilChanged()); + constructor( private readonly appsState: AppsState, - private readonly authState: AuthService, private readonly dialogs: DialogService, private readonly rulesService: RulesService ) { - super({ rules: ImmutableArray.empty() }); + super({ rules: ImmutableArray.empty(), links: {} }); } public load(isReload = false): Observable { @@ -64,23 +66,22 @@ export class RulesState extends State { } return this.rulesService.getRules(this.appName).pipe( - tap(payload => { + tap(({ items, _links: links }) => { if (isReload) { this.dialogs.notifyInfo('Rules reloaded.'); } this.next(s => { - const rules = ImmutableArray.of(payload); + const rules = ImmutableArray.of(items); - return { ...s, rules, isLoaded: true }; + return { ...s, rules, isLoaded: true, links }; }); }), shareSubscribed(this.dialogs)); } - public create(request: UpsertRuleDto, now?: DateTime): Observable { + public create(request: UpsertRuleDto): Observable { return this.rulesService.postRule(this.appName, request).pipe( - map(payload => createRule(request, payload, this.user, now)), tap(created => { this.next(s => { const rules = s.rules.push(created); @@ -92,7 +93,7 @@ export class RulesState extends State { } public delete(rule: RuleDto): Observable { - return this.rulesService.deleteRule(this.appName, rule.id, rule.version).pipe( + return this.rulesService.deleteRule(this.appName, rule, rule.version).pipe( tap(() => { this.next(s => { const rules = s.rules.removeAll(x => x.id === rule.id); @@ -103,36 +104,32 @@ export class RulesState extends State { shareSubscribed(this.dialogs)); } - public updateAction(rule: RuleDto, action: any, now?: DateTime): Observable { - return this.rulesService.putRule(this.appName, rule.id, { action }, rule.version).pipe( - map(({ version }) => updateAction(rule, action, this.user, version, now)), + public updateAction(rule: RuleDto, action: any): Observable { + return this.rulesService.putRule(this.appName, rule, { action }, rule.version).pipe( tap(updated => { this.replaceRule(updated); }), shareSubscribed(this.dialogs)); } - public updateTrigger(rule: RuleDto, trigger: any, now?: DateTime): Observable { - return this.rulesService.putRule(this.appName, rule.id, { trigger }, rule.version).pipe( - map(({ version }) => updateTrigger(rule, trigger, this.user, version, now)), + public updateTrigger(rule: RuleDto, trigger: any): Observable { + return this.rulesService.putRule(this.appName, rule, { trigger }, rule.version).pipe( tap(updated => { this.replaceRule(updated); }), shareSubscribed(this.dialogs)); } - public enable(rule: RuleDto, now?: DateTime): Observable { - return this.rulesService.enableRule(this.appName, rule.id, rule.version).pipe( - map(({ version }) => setEnabled(rule, true, this.user, version, now)), + public enable(rule: RuleDto): Observable { + return this.rulesService.enableRule(this.appName, rule, rule.version).pipe( tap(updated => { this.replaceRule(updated); }), shareSubscribed(this.dialogs)); } - public disable(rule: RuleDto, now?: DateTime): Observable { - return this.rulesService.disableRule(this.appName, rule.id, rule.version).pipe( - map(({ version }) => setEnabled(rule, false, this.user, version, now)), + public disable(rule: RuleDto): Observable { + return this.rulesService.disableRule(this.appName, rule, rule.version).pipe( tap(updated => { this.replaceRule(updated); }), @@ -150,57 +147,4 @@ export class RulesState extends State { private get appName() { return this.appsState.appName; } - - private get user() { - return this.authState.user!.token; - } -} - -const updateTrigger = (rule: RuleDto, trigger: any, user: string, version: Version, now?: DateTime) => - rule.with({ - trigger, - triggerType: trigger.triggerType, - lastModified: now || DateTime.now(), - lastModifiedBy: user, - version - }); - -const updateAction = (rule: RuleDto, action: any, user: string, version: Version, now?: DateTime) => - rule.with({ - action, - actionType: action.actionType, - lastModified: now || DateTime.now(), - lastModifiedBy: user, - version - }); - -const setEnabled = (rule: RuleDto, isEnabled: boolean, user: string, version: Version, now?: DateTime) => - rule.with({ - isEnabled, - lastModified: now || DateTime.now(), - lastModifiedBy: user, - version - }); - -function createRule(request: UpsertRuleDto, { payload, version }: Versioned, user: string, now?: DateTime) { - now = now || DateTime.now(); - - const { triggerType, ...trigger } = request.trigger; - - const { actionType, ...action } = request.action; - - const rule = new RuleDto( - payload.id, - user, - user, - now, - now, - version, - true, - trigger, - triggerType, - action, - actionType); - - return rule; } \ No newline at end of file diff --git a/tests/Squidex.Domain.Apps.Entities.Tests/Assets/AssetCommandMiddlewareTests.cs b/tests/Squidex.Domain.Apps.Entities.Tests/Assets/AssetCommandMiddlewareTests.cs index d26a8335c..ee40fbd6e 100644 --- a/tests/Squidex.Domain.Apps.Entities.Tests/Assets/AssetCommandMiddlewareTests.cs +++ b/tests/Squidex.Domain.Apps.Entities.Tests/Assets/AssetCommandMiddlewareTests.cs @@ -76,9 +76,9 @@ namespace Squidex.Domain.Apps.Entities.Assets var result = context.Result(); - Assert.Equal(assetId, result.IdOrValue); - Assert.Contains("tag1", result.Tags); - Assert.Contains("tag2", result.Tags); + Assert.Equal(assetId, result.Asset.Id); + Assert.Contains("tag1", result.Asset.Tags); + Assert.Contains("tag2", result.Asset.Tags); AssertAssetHasBeenUploaded(0, context.ContextId); AssertAssetImageChecked(); diff --git a/tests/Squidex.Domain.Apps.Entities.Tests/Rules/RuleGrainTests.cs b/tests/Squidex.Domain.Apps.Entities.Tests/Rules/RuleGrainTests.cs index eb2c0ac26..4f3773f9b 100644 --- a/tests/Squidex.Domain.Apps.Entities.Tests/Rules/RuleGrainTests.cs +++ b/tests/Squidex.Domain.Apps.Entities.Tests/Rules/RuleGrainTests.cs @@ -60,7 +60,7 @@ namespace Squidex.Domain.Apps.Entities.Rules var result = await sut.ExecuteAsync(CreateRuleCommand(command)); - result.ShouldBeEquivalent(EntityCreatedResult.Create(Id, 0)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(AppId, sut.Snapshot.AppId.Id); @@ -110,7 +110,7 @@ namespace Squidex.Domain.Apps.Entities.Rules var result = await sut.ExecuteAsync(CreateRuleCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(2)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.True(sut.Snapshot.RuleDef.IsEnabled); @@ -129,7 +129,7 @@ namespace Squidex.Domain.Apps.Entities.Rules var result = await sut.ExecuteAsync(CreateRuleCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(1)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.False(sut.Snapshot.RuleDef.IsEnabled); From 7a641431ca050f34f1c50a8d410b715b2a3e65bf Mon Sep 17 00:00:00 2001 From: Sebastian Date: Thu, 13 Jun 2019 12:40:41 +0100 Subject: [PATCH 07/64] Hateos for Backups. --- src/Squidex.Web/PermissionExtensions.cs | 1 - .../Api/Controllers/Apps/Models/AppDto.cs | 2 +- .../Controllers/Backups/BackupsController.cs | 7 +- .../Backups/Models/BackupJobDto.cs | 22 ++++++- .../Backups/Models/BackupJobsDto.cs | 49 ++++++++++++++ .../Controllers/Rules/Models/RuleEventsDto.cs | 1 - .../pages/backups/backups-page.component.html | 5 +- .../shared/services/backups.service.spec.ts | 31 ++++++--- .../app/shared/services/backups.service.ts | 65 ++++++++++++------- .../app/shared/state/backups.state.spec.ts | 19 +++--- src/Squidex/app/shared/state/backups.state.ts | 16 +++-- 11 files changed, 160 insertions(+), 58 deletions(-) create mode 100644 src/Squidex/Areas/Api/Controllers/Backups/Models/BackupJobsDto.cs diff --git a/src/Squidex.Web/PermissionExtensions.cs b/src/Squidex.Web/PermissionExtensions.cs index a6751e9e9..4bda25b58 100644 --- a/src/Squidex.Web/PermissionExtensions.cs +++ b/src/Squidex.Web/PermissionExtensions.cs @@ -7,7 +7,6 @@ using Microsoft.AspNetCore.Http; using Squidex.Infrastructure.Security; -using Squidex.Shared; using Squidex.Shared.Identity; namespace Squidex.Web diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/AppDto.cs index dbb2f4ded..a41ad2dd0 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/AppDto.cs @@ -112,7 +112,7 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models if (controller.HasPermission(AllPermissions.AppBackupsRead, result.Name, permissions: permissions)) { - result.AddGetLink("backups", controller.Url(x => nameof(x.GetJobs), values)); + result.AddGetLink("backups", controller.Url(x => nameof(x.GetBackups), values)); } if (controller.HasPermission(AllPermissions.AppClientsRead, result.Name, permissions: permissions)) diff --git a/src/Squidex/Areas/Api/Controllers/Backups/BackupsController.cs b/src/Squidex/Areas/Api/Controllers/Backups/BackupsController.cs index 0198fa186..e692bcfba 100644 --- a/src/Squidex/Areas/Api/Controllers/Backups/BackupsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Backups/BackupsController.cs @@ -12,7 +12,6 @@ using Microsoft.AspNetCore.Mvc; using Orleans; using Squidex.Areas.Api.Controllers.Backups.Models; using Squidex.Domain.Apps.Entities.Backup; -using Squidex.Infrastructure; using Squidex.Infrastructure.Commands; using Squidex.Infrastructure.Tasks; using Squidex.Shared; @@ -44,16 +43,16 @@ namespace Squidex.Areas.Api.Controllers.Backups /// [HttpGet] [Route("apps/{app}/backups/")] - [ProducesResponseType(typeof(List), 200)] + [ProducesResponseType(typeof(BackupJobsDto), 200)] [ApiPermission(Permissions.AppBackupsRead)] [ApiCosts(0)] - public async Task GetJobs(string app) + public async Task GetBackups(string app) { var backupGrain = grainFactory.GetGrain(AppId); var jobs = await backupGrain.GetStateAsync(); - var response = jobs.Value.ToArray(BackupJobDto.FromBackup); + var response = BackupJobsDto.FromBackups(jobs.Value, this, app); return Ok(response); } diff --git a/src/Squidex/Areas/Api/Controllers/Backups/Models/BackupJobDto.cs b/src/Squidex/Areas/Api/Controllers/Backups/Models/BackupJobDto.cs index 475f4b059..8cc2fd455 100644 --- a/src/Squidex/Areas/Api/Controllers/Backups/Models/BackupJobDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Backups/Models/BackupJobDto.cs @@ -9,10 +9,12 @@ using System; using NodaTime; using Squidex.Domain.Apps.Entities.Backup; using Squidex.Infrastructure.Reflection; +using Squidex.Shared; +using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Backups.Models { - public sealed class BackupJobDto + public sealed class BackupJobDto : Resource { /// /// The id of the backup job. @@ -44,9 +46,23 @@ namespace Squidex.Areas.Api.Controllers.Backups.Models /// public JobStatus Status { get; set; } - public static BackupJobDto FromBackup(IBackupJob backup) + public static BackupJobDto FromBackup(IBackupJob backup, ApiController controller, string app) { - return SimpleMapper.Map(backup, new BackupJobDto()); + var result = SimpleMapper.Map(backup, new BackupJobDto()); + + return CreateLinks(result, controller, app); + } + + private static BackupJobDto CreateLinks(BackupJobDto result, ApiController controller, string app) + { + var values = new { app, id = result.Id }; + + if (controller.HasPermission(Permissions.AppBackupsDelete, app)) + { + result.AddDeleteLink("delete", controller.Url(x => nameof(x.DeleteBackup), values)); + } + + return result; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Backups/Models/BackupJobsDto.cs b/src/Squidex/Areas/Api/Controllers/Backups/Models/BackupJobsDto.cs new file mode 100644 index 000000000..33c88bc25 --- /dev/null +++ b/src/Squidex/Areas/Api/Controllers/Backups/Models/BackupJobsDto.cs @@ -0,0 +1,49 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschraenkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +using System.Collections.Generic; +using System.ComponentModel.DataAnnotations; +using System.Linq; +using Squidex.Domain.Apps.Entities.Backup; +using Squidex.Shared; +using Squidex.Web; + +namespace Squidex.Areas.Api.Controllers.Backups.Models +{ + public sealed class BackupJobsDto : Resource + { + /// + /// The backups. + /// + [Required] + public BackupJobDto[] Items { get; set; } + + public static BackupJobsDto FromBackups(IEnumerable backups, ApiController controller, string app) + { + var result = new BackupJobsDto + { + Items = backups.Select(x => BackupJobDto.FromBackup(x, controller, app)).ToArray() + }; + + return CreateLinks(result, controller, app); + } + + private static BackupJobsDto CreateLinks(BackupJobsDto result, ApiController controller, string app) + { + var values = new { app }; + + result.AddSelfLink(controller.Url(x => nameof(x.GetBackups), values)); + + if (controller.HasPermission(Permissions.AppBackupsCreate, app)) + { + result.AddPostLink("create", controller.Url(x => nameof(x.PostBackup), values)); + } + + return result; + } + } +} diff --git a/src/Squidex/Areas/Api/Controllers/Rules/Models/RuleEventsDto.cs b/src/Squidex/Areas/Api/Controllers/Rules/Models/RuleEventsDto.cs index add2af47f..83b6d4c6b 100644 --- a/src/Squidex/Areas/Api/Controllers/Rules/Models/RuleEventsDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Rules/Models/RuleEventsDto.cs @@ -5,7 +5,6 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== -using System; using System.Collections.Generic; using System.ComponentModel.DataAnnotations; using System.Linq; diff --git a/src/Squidex/app/features/settings/pages/backups/backups-page.component.html b/src/Squidex/app/features/settings/pages/backups/backups-page.component.html index dddcf8cf6..ca99931ff 100644 --- a/src/Squidex/app/features/settings/pages/backups/backups-page.component.html +++ b/src/Squidex/app/features/settings/pages/backups/backups-page.component.html @@ -12,7 +12,7 @@ - @@ -78,7 +78,8 @@
-
- + - {{userInfo.user.displayName}} + {{user.displayName}} - {{userInfo.user.email}} + {{user.email}} - - - - - - - - + +
- - - - diff --git a/src/Squidex/app/features/administration/pages/users/user-page.component.ts b/src/Squidex/app/features/administration/pages/users/user-page.component.ts index 0abdd7eed..ee7498713 100644 --- a/src/Squidex/app/features/administration/pages/users/user-page.component.ts +++ b/src/Squidex/app/features/administration/pages/users/user-page.component.ts @@ -29,8 +29,6 @@ export class UserPageComponent extends ResourceOwner implements OnInit { public user?: UserDto; public userForm = new UserForm(this.formBuilder); - public isReadOnly = false; - constructor( public readonly usersState: UsersState, private readonly formBuilder: FormBuilder, @@ -49,9 +47,9 @@ export class UserPageComponent extends ResourceOwner implements OnInit { if (selectedUser) { this.userForm.load(selectedUser); - this.isReadOnly = !hasLink(this.user, 'update'); + this.canUpdate = hasLink(this.user, 'update'); - if (this.isReadOnly) { + if (!this.canUpdate) { this.userForm.form.disable(); } } @@ -59,7 +57,7 @@ export class UserPageComponent extends ResourceOwner implements OnInit { } public save() { - if (this.isReadOnly) { + if (!this.canUpdate) { return; } diff --git a/src/Squidex/app/features/administration/state/event-consumers.state.spec.ts b/src/Squidex/app/features/administration/state/event-consumers.state.spec.ts index ba384f5d1..2a4c32c14 100644 --- a/src/Squidex/app/features/administration/state/event-consumers.state.spec.ts +++ b/src/Squidex/app/features/administration/state/event-consumers.state.spec.ts @@ -79,7 +79,7 @@ describe('EventConsumersState', () => { eventConsumersState.load().subscribe(); }); - it('should update evnet consumer when started', () => { + it('should update event consumer when started', () => { const updated = createEventConsumer(2, '_new'); eventConsumersService.setup(x => x.putStart(eventConsumer2)) diff --git a/src/Squidex/app/features/administration/state/users.state.spec.ts b/src/Squidex/app/features/administration/state/users.state.spec.ts index 3000bf6f6..279ff67c2 100644 --- a/src/Squidex/app/features/administration/state/users.state.spec.ts +++ b/src/Squidex/app/features/administration/state/users.state.spec.ts @@ -168,7 +168,7 @@ describe('UsersState', () => { expect(usersState.snapshot.selectedUser).toBeNull(); }); - it('should update user selected user when locked', () => { + it('should update user and selected user when locked', () => { const updated = createUser(2, '_new'); usersService.setup(x => x.lockUser(user2)) @@ -177,9 +177,9 @@ describe('UsersState', () => { usersState.select(user2.id).subscribe(); usersState.lock(user2).subscribe(); - const newUser2 = usersState.snapshot.users.at(1); + const user2New = usersState.snapshot.users.at(1); - expect(newUser2).toBe(usersState.snapshot.selectedUser!); + expect(user2New).toBe(usersState.snapshot.selectedUser!); }); it('should update user and selected user when unlocked', () => { @@ -191,10 +191,10 @@ describe('UsersState', () => { usersState.select(user2.id).subscribe(); usersState.unlock(user2).subscribe(); - const newUser2 = usersState.snapshot.users.at(1); + const user2New = usersState.snapshot.users.at(1); - expect(newUser2).toEqual(updated); - expect(newUser2).toBe(usersState.snapshot.selectedUser!); + expect(user2New).toEqual(updated); + expect(user2New).toBe(usersState.snapshot.selectedUser!); }); it('should update user and selected user when updated', () => { @@ -208,10 +208,10 @@ describe('UsersState', () => { usersState.select(user2.id).subscribe(); usersState.update(user2, request).subscribe(); - const newUser2 = usersState.snapshot.users.at(1); + const user2New = usersState.snapshot.users.at(1); - expect(newUser2).toEqual(updated); - expect(newUser2).toBe(usersState.snapshot.selectedUser!); + expect(user2New).toEqual(updated); + expect(user2New).toBe(usersState.snapshot.selectedUser!); }); it('should add user to snapshot when created', () => { diff --git a/src/Squidex/app/features/administration/state/users.state.ts b/src/Squidex/app/features/administration/state/users.state.ts index 04a4bc80a..d638c5e0c 100644 --- a/src/Squidex/app/features/administration/state/users.state.ts +++ b/src/Squidex/app/features/administration/state/users.state.ts @@ -60,10 +60,6 @@ export class UsersState extends State { this.changes.pipe(map(x => x.usersPager), distinctUntilChanged()); - public links = - this.changes.pipe(map(x => x.links), - distinctUntilChanged()); - public selectedUser = this.changes.pipe(map(x => x.selectedUser), distinctUntilChanged()); @@ -72,6 +68,10 @@ export class UsersState extends State { this.changes.pipe(map(x => !!x.isLoaded), distinctUntilChanged()); + public links = + this.changes.pipe(map(x => x.links), + distinctUntilChanged()); + constructor( private readonly dialogs: DialogService, private readonly usersService: UsersService @@ -131,7 +131,7 @@ export class UsersState extends State { selectedUser = users.find(x => x.id === selectedUser!.id) || selectedUser; } - return { ...s, users, usersPager, links, selectedUser, isLoaded: true }; + return { ...s, users, usersPager, selectedUser, isLoaded: true, links }; }); }), shareSubscribed(this.dialogs)); diff --git a/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.html b/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.html index 422b0a98f..ecb11c85b 100644 --- a/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.html +++ b/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.html @@ -106,12 +106,12 @@ - + - + diff --git a/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.ts b/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.ts index c9b1a77a2..fd7dcd668 100644 --- a/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.ts +++ b/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.ts @@ -5,11 +5,12 @@ * Copyright (c) Squidex UG (haftungsbeschränkt). All rights reserved. */ -import { Component, EventEmitter, Input, OnInit, Output } from '@angular/core'; +import { AfterViewInit, Component, EventEmitter, Input, OnInit, Output } from '@angular/core'; import { FormGroup } from '@angular/forms'; import { Form, + hasLink, ImmutableArray, RuleDto, RuleElementDto, @@ -26,7 +27,7 @@ export const MODE_EDIT_ACTION = 'EditAction'; styleUrls: ['./rule-wizard.component.scss'], templateUrl: './rule-wizard.component.html' }) -export class RuleWizardComponent implements OnInit { +export class RuleWizardComponent implements AfterViewInit, OnInit { public actionForm = new Form(new FormGroup({})); public actionType: string; public action: any = {}; @@ -35,6 +36,8 @@ export class RuleWizardComponent implements OnInit { public triggerType: string; public trigger: any = {}; + public canUpdate: boolean; + public step = 1; @Output() @@ -61,6 +64,8 @@ export class RuleWizardComponent implements OnInit { } public ngOnInit() { + this.canUpdate = !this.rule || hasLink(this.rule, 'update'); + if (this.mode === MODE_EDIT_ACTION) { this.step = 4; @@ -74,6 +79,14 @@ export class RuleWizardComponent implements OnInit { } } + public ngAfterViewInit() { + if (!this.canUpdate) { + this.actionForm.form.disable(); + + this.triggerForm.form.disable(); + } + } + public emitComplete() { this.complete.emit(); } @@ -132,6 +145,10 @@ export class RuleWizardComponent implements OnInit { } private updateTrigger() { + if (!this.canUpdate) { + return; + } + this.rulesState.updateTrigger(this.rule, this.trigger) .subscribe(() => { this.emitComplete(); @@ -143,6 +160,10 @@ export class RuleWizardComponent implements OnInit { } private updateAction() { + if (!this.canUpdate) { + return; + } + this.rulesState.updateAction(this.rule, this.action) .subscribe(() => { this.emitComplete(); diff --git a/src/Squidex/app/features/rules/pages/rules/rules-page.component.html b/src/Squidex/app/features/rules/pages/rules/rules-page.component.html index d6102c1be..0e97c61f2 100644 --- a/src/Squidex/app/features/rules/pages/rules/rules-page.component.html +++ b/src/Squidex/app/features/rules/pages/rules/rules-page.component.html @@ -6,16 +6,19 @@ - - - + + + + + @@ -23,7 +26,7 @@
No rule created yet. -
@@ -48,10 +51,11 @@ 		- + -
- + @@ -47,7 +50,7 @@
- + - {{contributorInfo.contributor.contributorId | sqxUserName}} + {{contributor.contributorId | sqxUserName}} - -
-
+
diff --git a/src/Squidex/app/features/settings/pages/contributors/contributors-page.component.ts b/src/Squidex/app/features/settings/pages/contributors/contributors-page.component.ts index 79105759c..0d5e85e6b 100644 --- a/src/Squidex/app/features/settings/pages/contributors/contributors-page.component.ts +++ b/src/Squidex/app/features/settings/pages/contributors/contributors-page.component.ts @@ -37,7 +37,7 @@ export class UsersDataSource implements AutocompleteSource { const results: any[] = []; for (let user of users) { - if (!contributors!.find(t => t.contributor.contributorId === user.id)) { + if (!contributors!.find(t => t.contributorId === user.id)) { results.push(user); } } @@ -110,7 +110,7 @@ export class ContributorsPageComponent implements OnInit { } } - public trackByContributor(index: number, contributorInfo: { contributor: ContributorDto }) { - return contributorInfo.contributor.contributorId; + public trackByContributor(index: number, contributor: ContributorDto) { + return contributor.contributorId; } } diff --git a/src/Squidex/app/shared/services/contributors.service.spec.ts b/src/Squidex/app/shared/services/contributors.service.spec.ts index 930f1b9c0..f069d2551 100644 --- a/src/Squidex/app/shared/services/contributors.service.spec.ts +++ b/src/Squidex/app/shared/services/contributors.service.spec.ts @@ -11,11 +11,13 @@ import { inject, TestBed } from '@angular/core/testing'; import { AnalyticsService, ApiUrlConfig, - ContributorAssignedDto, ContributorDto, ContributorsDto, + ContributorsPayload, ContributorsService, - Version + Resource, + Version, + withLinks } from '@app/shared/internal'; describe('ContributorsService', () => { @@ -52,34 +54,13 @@ describe('ContributorsService', () => { expect(req.request.method).toEqual('GET'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush({ - contributors: [ - { - contributorId: '123', - role: 'Owner' - }, - { - contributorId: '456', - role: 'Owner' - } - ], - maxContributors: 100 - }, { + req.flush(contributorsResponse(1, 2, 3), { headers: { etag: '2' } }); - expect(contributors!).toEqual({ - payload: { - contributors: [ - new ContributorDto('123', 'Owner'), - new ContributorDto('456', 'Owner') - ], - maxContributors: 100 - }, - version: new Version('2') - }); + expect(contributors!).toEqual({ payload: createContributors(1, 2, 3), version: new Version('2') }); })); it('should make post request to assign contributor', @@ -87,10 +68,10 @@ describe('ContributorsService', () => { const dto = { contributorId: '123', role: 'Owner' }; - let contributorAssignedDto: ContributorAssignedDto; + let contributors: ContributorsDto; contributorsService.postContributor('my-app', dto, version).subscribe(result => { - contributorAssignedDto = result.payload; + contributors = result; }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/contributors'); @@ -98,21 +79,77 @@ describe('ContributorsService', () => { expect(req.request.method).toEqual('POST'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({ contributorId: '123', isCreated: true }); + req.flush(contributorsResponse(1, 2, 3), { + headers: { + etag: '2' + } + }); - expect(contributorAssignedDto!.contributorId).toEqual('123'); + expect(contributors!).toEqual({ payload: createContributors(1, 2, 3), version: new Version('2') }); })); it('should make delete request to remove contributor', inject([ContributorsService, HttpTestingController], (contributorsService: ContributorsService, httpMock: HttpTestingController) => { - contributorsService.deleteContributor('my-app', '123', version).subscribe(); + const resource: Resource = { + _links: { + 'delete': { method: 'DELETE', href: '/api/apps/my-app/contributors/123' } + } + }; + + let contributors: ContributorsDto; + + contributorsService.deleteContributor('my-app', resource, version).subscribe(result => { + contributors = result; + }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/contributors/123'); expect(req.request.method).toEqual('DELETE'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({}); + req.flush(contributorsResponse(1, 2, 3), { + headers: { + etag: '2' + } + }); + + expect(contributors!).toEqual({ payload: createContributors(1, 2, 3), version: new Version('2') }); })); -}); \ No newline at end of file + + function contributorsResponse(...ids: number[]) { + return { + contributors: ids.map(id => ({ + contributorId: `id${id}`, role: id % 2 === 0 ? 'Owner' : 'Developer', + _links: { + update: { method: 'PUT', href: `/contributors/id${id}` } + } + })), + maxContributors: ids.length * 13, + _links: { + create: { method: 'POST', href: '/contributors' } + }, + _meta: { + isInvited: 'true' + } + }; + } +}); + +export function createContributors(...ids: number[]): ContributorsPayload { + return { + contributors: ids.map(id => + withLinks(new ContributorDto(`id${id}`, id % 2 === 0 ? 'Owner' : 'Developer'), { + _links: { + update: { method: 'PUT', href: `/contributors/id${id}` } + } + })), + maxContributors: ids.length * 13, + _links: { + create: { method: 'POST', href: '/contributors' } + }, + _meta: { + isInvited: 'true' + } + }; +} \ No newline at end of file diff --git a/src/Squidex/app/shared/services/contributors.service.ts b/src/Squidex/app/shared/services/contributors.service.ts index 690d10818..73b56bb0b 100644 --- a/src/Squidex/app/shared/services/contributors.service.ts +++ b/src/Squidex/app/shared/services/contributors.service.ts @@ -15,18 +15,27 @@ import { ApiUrlConfig, HTTP, mapVersioned, + Metadata, Model, pretifyError, + Resource, + ResourceLinks, Version, - Versioned + Versioned, + withLinks } from '@app/framework'; -export type ContributorsDto = Versioned<{ +export type ContributorsDto = Versioned; +export type ContributorsPayload = { + readonly _links?: ResourceLinks, + readonly _meta?: Metadata readonly contributors: ContributorDto[], readonly maxContributors: number -}>; +}; export class ContributorDto extends Model { + public readonly _links: ResourceLinks = {}; + constructor( public readonly contributorId: string, public readonly role: string @@ -35,11 +44,6 @@ export class ContributorDto extends Model { } } -export interface ContributorAssignedDto { - readonly contributorId: string; - readonly isCreated?: boolean; -} - export interface AssignContributorDto { readonly contributorId: string; readonly role: string; @@ -62,25 +66,19 @@ export class ContributorsService { mapVersioned(payload => { const body = payload.body; - const items: any[] = body.contributors; - - const contributors = - items.map(item => - new ContributorDto( - item.contributorId, - item.role)); - - return { contributors, maxContributors: body.maxContributors }; + return parseContributors(body); }), pretifyError('Failed to load contributors. Please reload.')); } - public postContributor(appName: string, dto: AssignContributorDto, version: Version): Observable> { + public postContributor(appName: string, dto: AssignContributorDto, version: Version): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/contributors`); return HTTP.postVersioned(this.http, url, dto, version).pipe( mapVersioned(payload => { - return payload.body; + const body = payload.body; + + return parseContributors(body); }), tap(() => { this.analytics.trackEvent('Contributor', 'Configured', appName); @@ -88,13 +86,34 @@ export class ContributorsService { pretifyError('Failed to add contributors. Please reload.')); } - public deleteContributor(appName: string, contributorId: string, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/contributors/${contributorId}`); + public deleteContributor(appName: string, resource: Resource, version: Version): Observable { + const link = resource._links['delete']; + + const url = this.apiUrl.buildUrl(link.href); - return HTTP.deleteVersioned(this.http, url, version).pipe( + return HTTP.requestVersioned(this.http, link.method, url, version).pipe( + mapVersioned(payload => { + const body = payload.body; + + return parseContributors(body); + }), tap(() => { this.analytics.trackEvent('Contributor', 'Deleted', appName); }), pretifyError('Failed to delete contributors. Please reload.')); } +} + +function parseContributors(body: any) { + const items: any[] = body.contributors; + + const contributors = + items.map(item => + withLinks( + new ContributorDto( + item.contributorId, + item.role), + item)); + + return withLinks({ contributors, maxContributors: body.maxContributors, _links: {} }, body); } \ No newline at end of file diff --git a/src/Squidex/app/shared/state/contributors.state.spec.ts b/src/Squidex/app/shared/state/contributors.state.spec.ts index f103f4bad..f529d80fb 100644 --- a/src/Squidex/app/shared/state/contributors.state.spec.ts +++ b/src/Squidex/app/shared/state/contributors.state.spec.ts @@ -9,29 +9,25 @@ import { of } from 'rxjs'; import { IMock, It, Mock, Times } from 'typemoq'; import { - ContributorDto, ContributorsService, ContributorsState, DialogService, versioned } from '@app/shared/internal'; +import { createContributors } from '../services/contributors.service.spec'; + import { TestValues } from './_test-helpers'; describe('ContributorsState', () => { const { app, appsState, - authService, - modifier, newVersion, version } = TestValues; - const oldContributors = [ - new ContributorDto('id1', 'Developer'), - new ContributorDto(modifier, 'Developer') - ]; + const oldContributors = createContributors(1, 2, 3); let dialogs: IMock; let contributorsService: IMock; @@ -41,7 +37,7 @@ describe('ContributorsState', () => { dialogs = Mock.ofType(); contributorsService = Mock.ofType(); - contributorsState = new ContributorsState(contributorsService.object, appsState.object, authService.object, dialogs.object); + contributorsState = new ContributorsState(contributorsService.object, appsState.object, dialogs.object); }); afterEach(() => { @@ -51,17 +47,14 @@ describe('ContributorsState', () => { describe('Loading', () => { it('should load contributors', () => { contributorsService.setup(x => x.getContributors(app)) - .returns(() => of(versioned(version, { contributors: oldContributors, maxContributors: 3 }))).verifiable(); + .returns(() => of(versioned(version, oldContributors))).verifiable(); contributorsState.load().subscribe(); - expect(contributorsState.snapshot.contributors.values).toEqual([ - { isCurrentUser: false, contributor: oldContributors[0] }, - { isCurrentUser: true, contributor: oldContributors[1] } - ]); + expect(contributorsState.snapshot.contributors.values).toEqual(oldContributors.contributors); expect(contributorsState.snapshot.isMaxReached).toBeFalsy(); expect(contributorsState.snapshot.isLoaded).toBeTruthy(); - expect(contributorsState.snapshot.maxContributors).toBe(3); + expect(contributorsState.snapshot.maxContributors).toBe(oldContributors.maxContributors); expect(contributorsState.snapshot.version).toEqual(version); dialogs.verify(x => x.notifyInfo(It.isAnyString()), Times.never()); @@ -69,7 +62,7 @@ describe('ContributorsState', () => { it('should show notification on load when reload is true', () => { contributorsService.setup(x => x.getContributors(app)) - .returns(() => of(versioned(version, { contributors: oldContributors, maxContributors: 3 }))).verifiable(); + .returns(() => of(versioned(version, oldContributors))).verifiable(); contributorsState.load(true).subscribe(); @@ -82,61 +75,36 @@ describe('ContributorsState', () => { describe('Updates', () => { beforeEach(() => { contributorsService.setup(x => x.getContributors(app)) - .returns(() => of(versioned(version, { contributors: oldContributors, maxContributors: 3 }))).verifiable(); + .returns(() => of(versioned(version, oldContributors))).verifiable(); contributorsState.load().subscribe(); }); - it('should add contributor to snapshot when assigned', () => { - const newContributor = new ContributorDto('id3', 'Developer'); + it('should update contributors when user assigned', () => { + const updated = createContributors(1, 2, 3); - const request = { contributorId: 'mail2stehle@gmail.com', role: newContributor.role }; - const response = { contributorId: newContributor.contributorId, isCreated: true }; + const request = { contributorId: 'mail2stehle@gmail.com', role: 'Developer' }; contributorsService.setup(x => x.postContributor(app, request, version)) - .returns(() => of(versioned(newVersion, response))).verifiable(); + .returns(() => of(versioned(newVersion, updated))).verifiable(); contributorsState.assign(request).subscribe(); - expect(contributorsState.snapshot.contributors.values).toEqual([ - { isCurrentUser: false, contributor: oldContributors[0] }, - { isCurrentUser: true, contributor: oldContributors[1] }, - { isCurrentUser: false, contributor: newContributor } - ]); - expect(contributorsState.snapshot.isMaxReached).toBeTruthy(); - expect(contributorsState.snapshot.maxContributors).toBe(3); + expect(contributorsState.snapshot.contributors.values).toEqual(oldContributors.contributors); + expect(contributorsState.snapshot.maxContributors).toBe(oldContributors.maxContributors); expect(contributorsState.snapshot.version).toEqual(newVersion); }); - it('should update contributor in snapshot when assigned and already added', () => { - const newContributor = new ContributorDto(modifier, 'Owner'); - - const request = { ...newContributor }; - const response = { contributorId: newContributor.contributorId, isCreated: true }; - - contributorsService.setup(x => x.postContributor(app, request, version)) - .returns(() => of(versioned(newVersion, response))).verifiable(); - - contributorsState.assign(request).subscribe(); - - expect(contributorsState.snapshot.contributors.values).toEqual([ - { isCurrentUser: false, contributor: oldContributors[0] }, - { isCurrentUser: true, contributor: newContributor } - ]); - expect(contributorsState.snapshot.isMaxReached).toBeFalsy(); - expect(contributorsState.snapshot.maxContributors).toBe(3); - expect(contributorsState.snapshot.version).toEqual(newVersion); - }); + it('should update contributors when contribution revoked', () => { + const updated = createContributors(1, 2, 3); - it('should remove contributor from snapshot when revoked', () => { - contributorsService.setup(x => x.deleteContributor(app, oldContributors[0].contributorId, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + contributorsService.setup(x => x.deleteContributor(app, oldContributors.contributors[0], version)) + .returns(() => of(versioned(newVersion, updated))).verifiable(); - contributorsState.revoke(oldContributors[0]).subscribe(); + contributorsState.revoke(oldContributors.contributors[0]).subscribe(); - expect(contributorsState.snapshot.contributors.values).toEqual([ - { isCurrentUser: true, contributor: oldContributors[1] } - ]); + expect(contributorsState.snapshot.contributors.values).toEqual(oldContributors.contributors); + expect(contributorsState.snapshot.maxContributors).toBe(oldContributors.maxContributors); expect(contributorsState.snapshot.version).toEqual(newVersion); }); }); diff --git a/src/Squidex/app/shared/state/contributors.state.ts b/src/Squidex/app/shared/state/contributors.state.ts index be7a8c83b..70f2eee03 100644 --- a/src/Squidex/app/shared/state/contributors.state.ts +++ b/src/Squidex/app/shared/state/contributors.state.ts @@ -13,6 +13,7 @@ import { DialogService, ErrorDto, ImmutableArray, + ResourceLinks, shareMapSubscribed, shareSubscribed, State, @@ -23,20 +24,12 @@ import { import { AssignContributorDto, ContributorDto, + ContributorsPayload, ContributorsService } from './../services/contributors.service'; -import { AuthService } from './../services/auth.service'; import { AppsState } from './apps.state'; -interface SnapshotContributor { - // The contributor. - contributor: ContributorDto; - - // Indicates if the contributor is the ucrrent user. - isCurrentUser: boolean; -} - interface Snapshot { // All loaded contributors. contributors: ContributorsList; @@ -52,9 +45,12 @@ interface Snapshot { // The app version. version: Version; + + // The links. + links: ResourceLinks; } -type ContributorsList = ImmutableArray; +type ContributorsList = ImmutableArray; @Injectable() export class ContributorsState extends State { @@ -74,13 +70,16 @@ export class ContributorsState extends State { this.changes.pipe(map(x => x.maxContributors), distinctUntilChanged()); + public links = + this.changes.pipe(map(x => x.links), + distinctUntilChanged()); + constructor( private readonly contributorsService: ContributorsService, private readonly appsState: AppsState, - private readonly authState: AuthService, private readonly dialogs: DialogService ) { - super({ contributors: ImmutableArray.empty(), version: new Version(''), maxContributors: -1 }); + super({ contributors: ImmutableArray.empty(), version: new Version(''), maxContributors: -1, links: {} }); } public load(isReload = false): Observable { @@ -94,19 +93,15 @@ export class ContributorsState extends State { this.dialogs.notifyInfo('Contributors reloaded.'); } - const contributors = ImmutableArray.of(payload.contributors.map(x => this.createContributor(x))); - - this.replaceContributors(contributors, version, payload.maxContributors); + this.replaceContributors(version, payload); }), shareSubscribed(this.dialogs)); } public revoke(contributor: ContributorDto): Observable { - return this.contributorsService.deleteContributor(this.appName, contributor.contributorId, this.version).pipe( - tap(({ version }) => { - const contributors = this.snapshot.contributors.filter(x => x.contributor.contributorId !== contributor.contributorId); - - this.replaceContributors(contributors, version); + return this.contributorsService.deleteContributor(this.appName, contributor, this.version).pipe( + tap(({ version, payload }) => { + this.replaceContributors(version, payload); }), shareSubscribed(this.dialogs)); } @@ -121,32 +116,21 @@ export class ContributorsState extends State { } }), tap(({ version, payload }) => { - const contributors = this.updateContributors(payload.contributorId, request.role); - - this.replaceContributors(contributors, version); + this.replaceContributors(version, payload); }), - shareMapSubscribed(this.dialogs, x => x.payload.isCreated)); + shareMapSubscribed(this.dialogs, x => x.payload._meta && x.payload._meta['isInvited'] === '1')); } - private updateContributors(id: string, role: string) { - const contributor = new ContributorDto(id, role); - const contributors = this.snapshot.contributors; - - if (contributors.find(x => x.contributor.contributorId === id)) { - return contributors.map(x => x.contributor.contributorId === id ? this.createContributor(contributor) : x); - } else { - return contributors.push(this.createContributor(contributor)); - } - } - - private replaceContributors(contributors: ImmutableArray, version: Version, maxContributors?: number) { + private replaceContributors(version: Version, payload: ContributorsPayload) { this.next(s => { - maxContributors = maxContributors || s.maxContributors; + const maxContributors = payload.maxContributors || s.maxContributors; const isLoaded = true; - const isMaxReached = maxContributors > 0 && maxContributors <= contributors.length; + const isMaxReached = maxContributors > 0 && maxContributors <= payload.contributors.length; + + const contributors = ImmutableArray.of(payload.contributors); - return { ...s, contributors, maxContributors, isLoaded, isMaxReached, version }; + return { ...s, contributors, maxContributors, isLoaded, isMaxReached, version: version, links: payload._links }; }); } @@ -154,15 +138,7 @@ export class ContributorsState extends State { return this.appsState.appName; } - private get userId() { - return this.authState.user!.id; - } - private get version() { return this.snapshot.version; } - - private createContributor(contributor: ContributorDto): SnapshotContributor { - return { contributor, isCurrentUser: contributor.contributorId === this.userId }; - } } \ No newline at end of file diff --git a/tests/Squidex.Domain.Apps.Entities.Tests/Apps/AppGrainTests.cs b/tests/Squidex.Domain.Apps.Entities.Tests/Apps/AppGrainTests.cs index cf6a405df..b5d79dee6 100644 --- a/tests/Squidex.Domain.Apps.Entities.Tests/Apps/AppGrainTests.cs +++ b/tests/Squidex.Domain.Apps.Entities.Tests/Apps/AppGrainTests.cs @@ -84,7 +84,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(EntityCreatedResult.Create(Id, 4)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(AppName, sut.Snapshot.Name); @@ -187,7 +187,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(EntityCreatedResult.Create(contributorId, 5)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(Role.Editor, sut.Snapshot.Contributors[contributorId]); @@ -207,7 +207,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(EntityCreatedResult.Create(contributorId, 6)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(Role.Owner, sut.Snapshot.Contributors[contributorId]); @@ -227,7 +227,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(6)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.False(sut.Snapshot.Contributors.ContainsKey(contributorId)); @@ -246,7 +246,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(5)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.True(sut.Snapshot.Clients.ContainsKey(clientId)); @@ -266,7 +266,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(6)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.False(sut.Snapshot.Clients.ContainsKey(clientId)); @@ -286,7 +286,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(7)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(clientNewName, sut.Snapshot.Clients[clientId].Name); @@ -306,7 +306,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(5)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.True(sut.Snapshot.LanguagesConfig.Contains(Language.DE)); @@ -326,7 +326,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(6)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.False(sut.Snapshot.LanguagesConfig.Contains(Language.DE)); @@ -346,7 +346,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(6)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.True(sut.Snapshot.LanguagesConfig.Contains(Language.DE)); @@ -365,7 +365,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(5)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(5, sut.Snapshot.Roles.Count); @@ -385,7 +385,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(6)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(4, sut.Snapshot.Roles.Count); @@ -405,7 +405,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(6)); + result.ShouldBeEquivalent(sut.Snapshot); LastEvents .ShouldHaveSameEvents( @@ -422,7 +422,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(5)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(initialPatterns.Count + 1, sut.Snapshot.Patterns.Count); @@ -442,7 +442,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(6)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(initialPatterns.Count, sut.Snapshot.Patterns.Count); @@ -462,7 +462,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(6)); + result.ShouldBeEquivalent(sut.Snapshot); LastEvents .ShouldHaveSameEvents( diff --git a/tests/Squidex.Domain.Apps.Entities.Tests/Apps/Invitation/InviteUserCommandMiddlewareTests.cs b/tests/Squidex.Domain.Apps.Entities.Tests/Apps/Invitation/InviteUserCommandMiddlewareTests.cs index 24e01634a..32a17a952 100644 --- a/tests/Squidex.Domain.Apps.Entities.Tests/Apps/Invitation/InviteUserCommandMiddlewareTests.cs +++ b/tests/Squidex.Domain.Apps.Entities.Tests/Apps/Invitation/InviteUserCommandMiddlewareTests.cs @@ -34,13 +34,13 @@ namespace Squidex.Domain.Apps.Entities.Apps.Invitation A.CallTo(() => userResolver.CreateUserIfNotExists("me@email.com", true)) .Returns(true); - var result = EntityCreatedResult.Create("13", 13L); + var result = A.Fake(); context.Complete(result); await sut.HandleAsync(context); - Assert.Same(context.Result().Id, result); + Assert.Same(context.Result().App, result); A.CallTo(() => userResolver.CreateUserIfNotExists("me@email.com", true)) .MustHaveHappened(); @@ -55,13 +55,13 @@ namespace Squidex.Domain.Apps.Entities.Apps.Invitation A.CallTo(() => userResolver.CreateUserIfNotExists("me@email.com", true)) .Returns(false); - var result = EntityCreatedResult.Create("13", 13L); + var result = A.Fake(); context.Complete(result); await sut.HandleAsync(context); - Assert.Same(context.Result>(), result); + Assert.Same(context.Result(), result); A.CallTo(() => userResolver.CreateUserIfNotExists("me@email.com", true)) .MustHaveHappened(); From 4a7f9765800f48051719f319c62ca8267755ef15 Mon Sep 17 00:00:00 2001 From: Sebastian Date: Thu, 13 Jun 2019 21:35:57 +0100 Subject: [PATCH 09/64] Languages and rules. --- .../AppsByUserIndexCommandMiddleware.cs | 14 +- src/Squidex.Web/PermissionExtensions.cs | 2 +- .../Apps/AppContributorsController.cs | 4 +- .../Apps/AppLanguagesController.cs | 42 ++++-- .../Controllers/Apps/Models/AppLanguageDto.cs | 44 ++++--- .../Apps/Models/AppLanguagesDto.cs | 54 ++++++++ .../Controllers/Apps/Models/ContributorDto.cs | 14 ++ .../Apps/Models/ContributorsDto.cs | 10 ++ .../Apps/Models/UpdateLanguageDto.cs | 3 +- .../Controllers/Assets/AssetsController.cs | 8 +- src/Squidex/app/declarations.d.ts | 2 + .../pages/users/user-page.component.html | 2 +- .../pages/users/user-page.component.ts | 8 +- .../pages/rules/rule-wizard.component.html | 4 +- .../pages/rules/rule-wizard.component.ts | 10 +- .../content-changed-trigger.component.html | 8 +- .../content-changed-trigger.component.ts | 2 +- .../pages/languages/language.component.html | 15 ++- .../pages/languages/language.component.ts | 16 ++- .../languages/languages-page.component.html | 2 +- .../languages/languages-page.component.ts | 4 +- .../app/framework/angular/sorted.directive.ts | 12 ++ .../services/app-languages.service.spec.ts | 121 ++++++++++++------ .../shared/services/app-languages.service.ts | 88 ++++++------- .../app/shared/services/apps.service.ts | 4 +- .../app/shared/services/assets.service.ts | 4 +- .../app/shared/services/backups.service.ts | 3 +- .../services/contributors.service.spec.ts | 11 +- .../shared/services/contributors.service.ts | 30 ++--- .../app/shared/services/rules.service.ts | 3 +- .../app/shared/state/languages.state.spec.ts | 59 ++++----- .../app/shared/state/languages.state.ts | 66 ++++------ 32 files changed, 408 insertions(+), 261 deletions(-) create mode 100644 src/Squidex/Areas/Api/Controllers/Apps/Models/AppLanguagesDto.cs diff --git a/src/Squidex.Domain.Apps.Entities/Apps/Indexes/AppsByUserIndexCommandMiddleware.cs b/src/Squidex.Domain.Apps.Entities/Apps/Indexes/AppsByUserIndexCommandMiddleware.cs index 3327fc914..5e2454fab 100644 --- a/src/Squidex.Domain.Apps.Entities/Apps/Indexes/AppsByUserIndexCommandMiddleware.cs +++ b/src/Squidex.Domain.Apps.Entities/Apps/Indexes/AppsByUserIndexCommandMiddleware.cs @@ -35,7 +35,7 @@ namespace Squidex.Domain.Apps.Entities.Apps.Indexes await Index(GetUserId(createApp)).AddAppAsync(createApp.AppId); break; case AssignContributor assignContributor: - await Index(GetUserId(context)).AddAppAsync(assignContributor.AppId); + await Index(GetUserId(assignContributor)).AddAppAsync(assignContributor.AppId); break; case RemoveContributor removeContributor: await Index(GetUserId(removeContributor)).RemoveAppAsync(removeContributor.AppId); @@ -57,19 +57,19 @@ namespace Squidex.Domain.Apps.Entities.Apps.Indexes await next(); } - private static string GetUserId(RemoveContributor removeContributor) + private static string GetUserId(CreateApp createApp) { - return removeContributor.ContributorId; + return createApp.Actor.Identifier; } - private static string GetUserId(CreateApp createApp) + private static string GetUserId(AssignContributor assignContributor) { - return createApp.Actor.Identifier; + return assignContributor.ContributorId; } - private static string GetUserId(CommandContext context) + private static string GetUserId(RemoveContributor removeContributor) { - return context.Result>().IdOrValue; + return removeContributor.ContributorId; } private IAppsByUserIndex Index(string id) diff --git a/src/Squidex.Web/PermissionExtensions.cs b/src/Squidex.Web/PermissionExtensions.cs index 4bda25b58..ab63f14f8 100644 --- a/src/Squidex.Web/PermissionExtensions.cs +++ b/src/Squidex.Web/PermissionExtensions.cs @@ -39,7 +39,7 @@ namespace Squidex.Web public static bool HasPermission(this HttpContext httpContext, Permission permission, PermissionSet permissions = null) { - return httpContext.Permissions().Includes(permission) || permission?.Includes(permission) == true; + return httpContext.Permissions().Includes(permission) || permissions?.Includes(permission) == true; } public static bool HasPermission(this HttpContext httpContext, string id, string app = "*", string schema = "*", PermissionSet permissions = null) diff --git a/src/Squidex/Areas/Api/Controllers/Apps/AppContributorsController.cs b/src/Squidex/Areas/Api/Controllers/Apps/AppContributorsController.cs index acc83e266..79769db43 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/AppContributorsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/AppContributorsController.cs @@ -61,7 +61,7 @@ namespace Squidex.Areas.Api.Controllers.Apps /// The name of the app. /// Contributor object that needs to be added to the app. /// - /// 200 => User assigned to app. + /// 201 => User assigned to app. /// 400 => User is already assigned to the app or not found. /// 404 => App not found. /// @@ -87,7 +87,7 @@ namespace Squidex.Areas.Api.Controllers.Apps response = ContributorsDto.FromApp(invited.App, appPlansProvider, this, true); } - return Ok(response); + return CreatedAtAction(nameof(GetContributors), new { app }, response); } /// diff --git a/src/Squidex/Areas/Api/Controllers/Apps/AppLanguagesController.cs b/src/Squidex/Areas/Api/Controllers/Apps/AppLanguagesController.cs index 17ce8c320..ba55d5485 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/AppLanguagesController.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/AppLanguagesController.cs @@ -10,6 +10,7 @@ using System.Threading.Tasks; using Microsoft.AspNetCore.Mvc; using Microsoft.Net.Http.Headers; using Squidex.Areas.Api.Controllers.Apps.Models; +using Squidex.Domain.Apps.Entities.Apps; using Squidex.Domain.Apps.Entities.Apps.Commands; using Squidex.Infrastructure; using Squidex.Infrastructure.Commands; @@ -39,12 +40,12 @@ namespace Squidex.Areas.Api.Controllers.Apps /// [HttpGet] [Route("apps/{app}/languages/")] - [ProducesResponseType(typeof(AppLanguageDto[]), 200)] + [ProducesResponseType(typeof(AppLanguagesDto), 200)] [ApiPermission(Permissions.AppCommon)] [ApiCosts(0)] public IActionResult GetLanguages(string app) { - var response = AppLanguageDto.FromApp(App); + var response = AppLanguagesDto.FromApp(App, this); Response.Headers[HeaderNames.ETag] = App.Version.ToString(); @@ -63,7 +64,7 @@ namespace Squidex.Areas.Api.Controllers.Apps /// [HttpPost] [Route("apps/{app}/languages/")] - [ProducesResponseType(typeof(AppLanguageDto), 201)] + [ProducesResponseType(typeof(AppLanguagesDto), 201)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppLanguagesCreate)] [ApiCosts(1)] @@ -71,9 +72,7 @@ namespace Squidex.Areas.Api.Controllers.Apps { var command = request.ToCommand(); - await CommandBus.PublishAsync(command); - - var response = AppLanguageDto.FromCommand(command); + var response = await InvokeCommandAsync(app, command); return CreatedAtAction(nameof(GetLanguages), new { app }, response); } @@ -85,19 +84,23 @@ namespace Squidex.Areas.Api.Controllers.Apps /// The language to update. /// The language object. /// - /// 204 => Language updated. + /// 200 => Language updated. /// 400 => Language request not valid. /// 404 => Language or app not found. /// [HttpPut] [Route("apps/{app}/languages/{language}/")] + [ProducesResponseType(typeof(AppLanguagesDto), 200)] + [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppLanguagesUpdate)] [ApiCosts(1)] - public async Task Update(string app, string language, [FromBody] UpdateLanguageDto request) + public async Task PutLanguage(string app, string language, [FromBody] UpdateLanguageDto request) { - await CommandBus.PublishAsync(request.ToCommand(ParseLanguage(language))); + var command = request.ToCommand(ParseLanguage(language)); + + var response = await InvokeCommandAsync(app, command); - return NoContent(); + return Ok(response); } /// @@ -106,18 +109,31 @@ namespace Squidex.Areas.Api.Controllers.Apps /// The name of the app. /// The language to delete from the app. /// - /// 204 => Language deleted. + /// 200 => Language deleted. /// 404 => Language or app not found. /// [HttpDelete] [Route("apps/{app}/languages/{language}/")] + [ProducesResponseType(typeof(AppLanguagesDto), 200)] [ApiPermission(Permissions.AppLanguagesDelete)] [ApiCosts(1)] public async Task DeleteLanguage(string app, string language) { - await CommandBus.PublishAsync(new RemoveLanguage { Language = ParseLanguage(language) }); + var command = new RemoveLanguage { Language = ParseLanguage(language) }; + + var response = await InvokeCommandAsync(app, command); + + return Ok(response); + } + + private async Task InvokeCommandAsync(string app, ICommand command) + { + var context = await CommandBus.PublishAsync(command); + + var result = context.Result(); + var response = AppLanguagesDto.FromApp(result, this); - return NoContent(); + return response; } private static Language ParseLanguage(string language) diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppLanguageDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/AppLanguageDto.cs index 62501e4c2..4ac3d8ad7 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppLanguageDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/AppLanguageDto.cs @@ -5,18 +5,18 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== -using System; using System.ComponentModel.DataAnnotations; using System.Linq; using Squidex.Domain.Apps.Core.Apps; using Squidex.Domain.Apps.Entities.Apps; -using Squidex.Domain.Apps.Entities.Apps.Commands; using Squidex.Infrastructure; using Squidex.Infrastructure.Reflection; +using Squidex.Shared; +using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Apps.Models { - public sealed class AppLanguageDto + public sealed class AppLanguageDto : Resource { /// /// The iso code of the language. @@ -46,25 +46,37 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models /// public bool IsOptional { get; set; } - public static AppLanguageDto FromCommand(AddLanguage command) + public static AppLanguageDto FromLanguage(LanguageConfig language, IAppEntity app, ApiController controller) { - return SimpleMapper.Map(command.Language, new AppLanguageDto { Fallback = Array.Empty() }); - } + var result = SimpleMapper.Map(language.Language, + new AppLanguageDto + { + IsMaster = language == app.LanguagesConfig.Master, + IsOptional = language.IsOptional, + Fallback = language.LanguageFallbacks.ToArray() + }); - public static AppLanguageDto[] FromApp(IAppEntity app) - { - return app.LanguagesConfig.OfType().Select(x => FromLanguage(x, app)).OrderByDescending(x => x.IsMaster).ThenBy(x => x.Iso2Code).ToArray(); + return CreateLinks(result, controller, app); } - private static AppLanguageDto FromLanguage(LanguageConfig x, IAppEntity app) + private static AppLanguageDto CreateLinks(AppLanguageDto result, ApiController controller, IAppEntity app) { - return SimpleMapper.Map(x.Language, - new AppLanguageDto + var values = new { app = app.Name, language = result.Iso2Code }; + + if (!result.IsMaster) + { + if (controller.HasPermission(Permissions.AppLanguagesUpdate, app.Name)) { - IsMaster = x == app.LanguagesConfig.Master, - IsOptional = x.IsOptional, - Fallback = x.LanguageFallbacks.ToArray() - }); + result.AddPutLink("update", controller.Url(x => nameof(x.PutLanguage), values)); + } + + if (controller.HasPermission(Permissions.AppLanguagesDelete, app.Name) && app.LanguagesConfig.Count > 1) + { + result.AddDeleteLink("delete", controller.Url(x => nameof(x.DeleteLanguage), values)); + } + } + + return result; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppLanguagesDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/AppLanguagesDto.cs new file mode 100644 index 000000000..250408598 --- /dev/null +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/AppLanguagesDto.cs @@ -0,0 +1,54 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschraenkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +using System; +using System.ComponentModel.DataAnnotations; +using System.Linq; +using Squidex.Domain.Apps.Core.Apps; +using Squidex.Domain.Apps.Entities.Apps; +using Squidex.Shared; +using Squidex.Web; + +namespace Squidex.Areas.Api.Controllers.Apps.Models +{ + public sealed class AppLanguagesDto : Resource + { + /// + /// The languages. + /// + [Required] + public AppLanguageDto[] Items { get; set; } + + public static AppLanguagesDto FromApp(IAppEntity app, ApiController controller) + { + var result = new AppLanguagesDto + { + Items = app.LanguagesConfig.OfType() + .Select(x => AppLanguageDto.FromLanguage(x, app, controller)) + .OrderByDescending(x => x.IsMaster) + .ThenBy(x => x.Iso2Code) + .ToArray() + }; + + return CreateLinks(result, controller, app.Name); + } + + private static AppLanguagesDto CreateLinks(AppLanguagesDto result, ApiController controller, string app) + { + var values = new { app }; + + result.AddSelfLink(controller.Url(x => nameof(x.GetLanguages), values)); + + if (controller.HasPermission(Permissions.AppLanguagesCreate, app)) + { + result.AddPostLink("create", controller.Url(x => nameof(x.PostLanguage), values)); + } + + return result; + } + } +} diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorDto.cs index 30814f92d..bdd9e8947 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorDto.cs @@ -7,6 +7,7 @@ using System; using System.ComponentModel.DataAnnotations; +using Squidex.Shared; using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Apps.Models @@ -33,6 +34,19 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models private static ContributorDto CreateLinks(ContributorDto result, ApiController controller, string app) { + if (!controller.IsUser(result.ContributorId)) + { + if (controller.HasPermission(Permissions.AppContributorsAssign, app)) + { + result.AddPostLink("update", controller.Url(x => nameof(x.PostContributor), new { app })); + } + + if (controller.HasPermission(Permissions.AppContributorsRevoke, app)) + { + result.AddDeleteLink("delete", controller.Url(x => nameof(x.DeleteContributor), new { app, id = result.ContributorId })); + } + } + return result; } } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorsDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorsDto.cs index cbeaab92c..310efbea9 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorsDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorsDto.cs @@ -10,6 +10,7 @@ using Newtonsoft.Json; using Squidex.Domain.Apps.Entities.Apps; using Squidex.Domain.Apps.Entities.Apps.Services; using Squidex.Infrastructure; +using Squidex.Shared; using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Apps.Models @@ -57,6 +58,15 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models private static ContributorsDto CreateLinks(ContributorsDto result, ApiController controller, string app) { + var values = new { app }; + + result.AddSelfLink(controller.Url(x => nameof(x.GetContributors), values)); + + if (controller.HasPermission(Permissions.AppContributorsAssign, app)) + { + result.AddPostLink("create", controller.Url(x => nameof(x.PostContributor), values)); + } + return result; } } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/UpdateLanguageDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/UpdateLanguageDto.cs index 0a470ff6c..8c6d2e707 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/UpdateLanguageDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/UpdateLanguageDto.cs @@ -5,6 +5,7 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== +using System.Collections.Generic; using Squidex.Domain.Apps.Entities.Apps.Commands; using Squidex.Infrastructure; using Squidex.Infrastructure.Reflection; @@ -26,7 +27,7 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models /// /// Optional fallback languages. /// - public Language[] Fallback { get; set; } + public List Fallback { get; set; } public UpdateLanguage ToCommand(Language language) { diff --git a/src/Squidex/Areas/Api/Controllers/Assets/AssetsController.cs b/src/Squidex/Areas/Api/Controllers/Assets/AssetsController.cs index 9987e0e89..08763e341 100644 --- a/src/Squidex/Areas/Api/Controllers/Assets/AssetsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Assets/AssetsController.cs @@ -179,7 +179,7 @@ namespace Squidex.Areas.Api.Controllers.Assets var command = new CreateAsset { File = assetFile }; - var response = await InvokeCommand(app, command); + var response = await InvokeCommandAsync(app, command); return CreatedAtAction(nameof(GetAsset), new { app, id = response.Id }, response); } @@ -210,7 +210,7 @@ namespace Squidex.Areas.Api.Controllers.Assets var command = new UpdateAsset { File = assetFile, AssetId = id }; - var response = await InvokeCommand(app, command); + var response = await InvokeCommandAsync(app, command); return Ok(response); } @@ -237,7 +237,7 @@ namespace Squidex.Areas.Api.Controllers.Assets { var command = request.ToCommand(id); - var response = await InvokeCommand(app, command); + var response = await InvokeCommandAsync(app, command); return Ok(response); } @@ -262,7 +262,7 @@ namespace Squidex.Areas.Api.Controllers.Assets return NoContent(); } - private async Task InvokeCommand(string app, AssetCommand command) + private async Task InvokeCommandAsync(string app, ICommand command) { var context = await CommandBus.PublishAsync(command); diff --git a/src/Squidex/app/declarations.d.ts b/src/Squidex/app/declarations.d.ts index d40cdbd10..43716dcf2 100644 --- a/src/Squidex/app/declarations.d.ts +++ b/src/Squidex/app/declarations.d.ts @@ -12,6 +12,8 @@ declare module 'progressbar.js'; declare module 'sortablejs' { export class Ref { public destroy(): any; + + public option(property: string, value: any): any; } export function create(element: any, options: any): Ref; diff --git a/src/Squidex/app/features/administration/pages/users/user-page.component.html b/src/Squidex/app/features/administration/pages/users/user-page.component.html index bec006082..2666ee37c 100644 --- a/src/Squidex/app/features/administration/pages/users/user-page.component.html +++ b/src/Squidex/app/features/administration/pages/users/user-page.component.html @@ -16,7 +16,7 @@ - + diff --git a/src/Squidex/app/features/administration/pages/users/user-page.component.ts b/src/Squidex/app/features/administration/pages/users/user-page.component.ts index ee7498713..069c71789 100644 --- a/src/Squidex/app/features/administration/pages/users/user-page.component.ts +++ b/src/Squidex/app/features/administration/pages/users/user-page.component.ts @@ -24,7 +24,7 @@ import { templateUrl: './user-page.component.html' }) export class UserPageComponent extends ResourceOwner implements OnInit { - public canUpdate = false; + public isEditable = false; public user?: UserDto; public userForm = new UserForm(this.formBuilder); @@ -47,9 +47,9 @@ export class UserPageComponent extends ResourceOwner implements OnInit { if (selectedUser) { this.userForm.load(selectedUser); - this.canUpdate = hasLink(this.user, 'update'); + this.isEditable = hasLink(this.user, 'update'); - if (!this.canUpdate) { + if (!this.isEditable) { this.userForm.form.disable(); } } @@ -57,7 +57,7 @@ export class UserPageComponent extends ResourceOwner implements OnInit { } public save() { - if (!this.canUpdate) { + if (!this.isEditable) { return; } diff --git a/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.html b/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.html index ecb11c85b..9f0fde00f 100644 --- a/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.html +++ b/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.html @@ -106,12 +106,12 @@ - + - +
diff --git a/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.ts b/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.ts index fd7dcd668..a7e1e14a4 100644 --- a/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.ts +++ b/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.ts @@ -36,7 +36,7 @@ export class RuleWizardComponent implements AfterViewInit, OnInit { public triggerType: string; public trigger: any = {}; - public canUpdate: boolean; + public isEditable: boolean; public step = 1; @@ -64,7 +64,7 @@ export class RuleWizardComponent implements AfterViewInit, OnInit { } public ngOnInit() { - this.canUpdate = !this.rule || hasLink(this.rule, 'update'); + this.isEditable = !this.rule || hasLink(this.rule, 'update'); if (this.mode === MODE_EDIT_ACTION) { this.step = 4; @@ -80,7 +80,7 @@ export class RuleWizardComponent implements AfterViewInit, OnInit { } public ngAfterViewInit() { - if (!this.canUpdate) { + if (!this.isEditable) { this.actionForm.form.disable(); this.triggerForm.form.disable(); @@ -145,7 +145,7 @@ export class RuleWizardComponent implements AfterViewInit, OnInit { } private updateTrigger() { - if (!this.canUpdate) { + if (!this.isEditable) { return; } @@ -160,7 +160,7 @@ export class RuleWizardComponent implements AfterViewInit, OnInit { } private updateAction() { - if (!this.canUpdate) { + if (!this.isEditable) { return; } diff --git a/src/Squidex/app/features/rules/pages/rules/triggers/content-changed-trigger.component.html b/src/Squidex/app/features/rules/pages/rules/triggers/content-changed-trigger.component.html index d7c5bdc48..f1ae6a0f7 100644 --- a/src/Squidex/app/features/rules/pages/rules/triggers/content-changed-trigger.component.html +++ b/src/Squidex/app/features/rules/pages/rules/triggers/content-changed-trigger.component.html @@ -22,13 +22,13 @@ - @@ -38,12 +38,12 @@
-
- +
diff --git a/src/Squidex/app/features/rules/pages/rules/triggers/content-changed-trigger.component.ts b/src/Squidex/app/features/rules/pages/rules/triggers/content-changed-trigger.component.ts index 0e18f523f..f169a8ff6 100644 --- a/src/Squidex/app/features/rules/pages/rules/triggers/content-changed-trigger.component.ts +++ b/src/Squidex/app/features/rules/pages/rules/triggers/content-changed-trigger.component.ts @@ -30,7 +30,7 @@ export class ContentChangedTriggerComponent implements OnInit { public schemas: ImmutableArray; @Input() - public canUpdate: boolean; + public isEditable: boolean; @Input() public trigger: any; diff --git a/src/Squidex/app/features/settings/pages/languages/language.component.html b/src/Squidex/app/features/settings/pages/languages/language.component.html index d8dc7dccd..b8deb6e3c 100644 --- a/src/Squidex/app/features/settings/pages/languages/language.component.html +++ b/src/Squidex/app/features/settings/pages/languages/language.component.html @@ -13,7 +13,8 @@ - - +
-
+
-
+
-
+
{{language.englishName}}
-
+
@@ -56,7 +57,7 @@
-
+
+
diff --git a/src/Squidex/app/features/settings/pages/clients/client.component.ts b/src/Squidex/app/features/settings/pages/clients/client.component.ts index 423e3b5b3..eb1d53aa1 100644 --- a/src/Squidex/app/features/settings/pages/clients/client.component.ts +++ b/src/Squidex/app/features/settings/pages/clients/client.component.ts @@ -17,6 +17,7 @@ import { ClientsState, DialogModel, DialogService, + hasAnyLink, RenameClientForm, RoleDto } from '@app/shared'; @@ -36,6 +37,7 @@ export class ClientComponent implements OnChanges { public clientRoles: RoleDto[]; public isRenaming = false; + public isEditable = false; public connectToken: AccessTokenDto; public connectDialog = new DialogModel(); @@ -59,6 +61,8 @@ export class ClientComponent implements OnChanges { } public ngOnChanges() { + this.isEditable = hasAnyLink(this.client, 'update'); + this.renameForm.load(this.client); const app = this.appsState.appName; @@ -79,16 +83,18 @@ export class ClientComponent implements OnChanges { } public toggleRename() { + if (!this.isEditable) { + return; + } + this.isRenaming = !this.isRenaming; } - public onKeyDown(keyCode: number) { - if (keyCode === ESCAPE_KEY) { - this.toggleRename(); + public rename() { + if (!this.isEditable) { + return; } - } - public rename() { const value = this.renameForm.submit(); if (value) { @@ -117,6 +123,12 @@ export class ClientComponent implements OnChanges { public trackByRole(index: number, role: RoleDto) { return role.name; } + + public onKeyDown(keyCode: number) { + if (keyCode === ESCAPE_KEY) { + this.toggleRename(); + } + } } function connectHttpText(apiUrl: ApiUrlConfig, app: string, client: { id: string, secret: string }) { diff --git a/src/Squidex/app/features/settings/pages/clients/clients-page.component.html b/src/Squidex/app/features/settings/pages/clients/clients-page.component.html index 5ef4d921b..24b325d50 100644 --- a/src/Squidex/app/features/settings/pages/clients/clients-page.component.html +++ b/src/Squidex/app/features/settings/pages/clients/clients-page.component.html @@ -26,7 +26,7 @@ -
+
diff --git a/src/Squidex/app/framework/angular/http/http-extensions.ts b/src/Squidex/app/framework/angular/http/http-extensions.ts index befea290b..e5607c58d 100644 --- a/src/Squidex/app/framework/angular/http/http-extensions.ts +++ b/src/Squidex/app/framework/angular/http/http-extensions.ts @@ -17,37 +17,37 @@ import { } from '@app/framework/internal'; export module HTTP { - export function getVersioned(http: HttpClient, url: string, version?: Version): Observable>> { + export function getVersioned(http: HttpClient, url: string, version?: Version): Observable>> { const headers = createHeaders(version); return handleVersion(http.get(url, { observe: 'response', headers })); } - export function postVersioned(http: HttpClient, url: string, body: any, version?: Version): Observable>> { + export function postVersioned(http: HttpClient, url: string, body: any, version?: Version): Observable>> { const headers = createHeaders(version); return handleVersion(http.post(url, body, { observe: 'response', headers })); } - export function putVersioned(http: HttpClient, url: string, body: any, version?: Version): Observable>> { + export function putVersioned(http: HttpClient, url: string, body: any, version?: Version): Observable>> { const headers = createHeaders(version); return handleVersion(http.put(url, body, { observe: 'response', headers })); } - export function patchVersioned(http: HttpClient, url: string, body: any, version?: Version): Observable>> { + export function patchVersioned(http: HttpClient, url: string, body: any, version?: Version): Observable>> { const headers = createHeaders(version); return handleVersion(http.request('PATCH', url, { body, observe: 'response', headers })); } - export function deleteVersioned(http: HttpClient, url: string, version?: Version): Observable>> { + export function deleteVersioned(http: HttpClient, url: string, version?: Version): Observable>> { const headers = createHeaders(version); return handleVersion(http.delete(url, { observe: 'response', headers })); } - export function requestVersioned(http: HttpClient, method: string, url: string, version?: Version, body?: any): Observable>> { + export function requestVersioned(http: HttpClient, method: string, url: string, version?: Version, body?: any): Observable>> { const headers = createHeaders(version); return handleVersion(http.request(method, url, { observe: 'response', headers, body })); diff --git a/src/Squidex/app/shared/services/app-languages.service.ts b/src/Squidex/app/shared/services/app-languages.service.ts index 6296e3a2f..a7554dc02 100644 --- a/src/Squidex/app/shared/services/app-languages.service.ts +++ b/src/Squidex/app/shared/services/app-languages.service.ts @@ -24,7 +24,9 @@ import { } from '@app/framework'; export type AppLanguagesDto = Versioned; -export type AppLanguagesPayload = { items: AppLanguageDto[] } & Resource; +export type AppLanguagesPayload = { + readonly items: AppLanguageDto[] +} & Resource; export class AppLanguageDto { public readonly _links: ResourceLinks = {}; diff --git a/src/Squidex/app/shared/services/apps.service.ts b/src/Squidex/app/shared/services/apps.service.ts index 44c3dda9f..0e1975183 100644 --- a/src/Squidex/app/shared/services/apps.service.ts +++ b/src/Squidex/app/shared/services/apps.service.ts @@ -66,7 +66,7 @@ export class AppsService { public postApp(dto: CreateAppDto): Observable { const url = this.apiUrl.buildUrl('api/apps'); - return this.http.post(url, dto).pipe( + return this.http.post(url, dto).pipe( map(body => { return parseApp(body); }), diff --git a/src/Squidex/app/shared/services/assets.service.ts b/src/Squidex/app/shared/services/assets.service.ts index f2936a4c1..c74866c18 100644 --- a/src/Squidex/app/shared/services/assets.service.ts +++ b/src/Squidex/app/shared/services/assets.service.ts @@ -117,7 +117,7 @@ export class AssetsService { const url = this.apiUrl.buildUrl(`api/apps/${appName}/assets?${fullQuery}`); - return HTTP.getVersioned(this.http, url).pipe( + return HTTP.getVersioned(this.http, url).pipe( map(({ payload }) => { const { total, items } = <{ total: number, items: any[] }>payload.body; @@ -133,7 +133,7 @@ export class AssetsService { const req = new HttpRequest('POST', url, getFormData(file), { reportProgress: true }); - return this.http.request(req).pipe( + return this.http.request(req).pipe( filter(event => event.type === HttpEventType.UploadProgress || event.type === HttpEventType.Response), @@ -166,7 +166,7 @@ export class AssetsService { public getAsset(appName: string, id: string): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/assets/${id}`); - return HTTP.getVersioned(this.http, url).pipe( + return HTTP.getVersioned(this.http, url).pipe( map(({ payload }) => { const body = payload.body; diff --git a/src/Squidex/app/shared/services/backups.service.ts b/src/Squidex/app/shared/services/backups.service.ts index 4fa3146bd..8cd9286aa 100644 --- a/src/Squidex/app/shared/services/backups.service.ts +++ b/src/Squidex/app/shared/services/backups.service.ts @@ -82,7 +82,7 @@ export class BackupsService { public getRestore(): Observable { const url = this.apiUrl.buildUrl(`api/apps/restore`); - return this.http.get(url).pipe( + return this.http.get(url).pipe( map(body => { const restore = parseRestore(body); diff --git a/src/Squidex/app/shared/services/clients.service.spec.ts b/src/Squidex/app/shared/services/clients.service.spec.ts index 02afa3486..17146a941 100644 --- a/src/Squidex/app/shared/services/clients.service.spec.ts +++ b/src/Squidex/app/shared/services/clients.service.spec.ts @@ -14,8 +14,11 @@ import { ApiUrlConfig, ClientDto, ClientsDto, + ClientsPayload, ClientsService, - Version + Resource, + Version, + withLinks } from '@app/shared/internal'; describe('ClientsService', () => { @@ -52,32 +55,13 @@ describe('ClientsService', () => { expect(req.request.method).toEqual('GET'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush([ - { - id: 'client1', - name: 'Client 1', - secret: 'secret1', - role: 'Editor' - }, - { - id: 'client2', - name: 'Client 2', - secret: 'secret2', - role: 'Developer' - } - ], { + req.flush(clientsResponse(1, 2), { headers: { etag: '2' } }); - expect(clients!).toEqual({ - payload: [ - new ClientDto('client1', 'Client 1', 'secret1', 'Editor'), - new ClientDto('client2', 'Client 2', 'secret2', 'Developer') - ], - version: new Version('2') - }); + expect(clients!).toEqual({ payload: createClients(1, 2), version: new Version('2') }); })); it('should make post request to create client', @@ -85,10 +69,10 @@ describe('ClientsService', () => { const dto = { id: 'client1' }; - let client: ClientDto; + let clients: ClientsDto; clientsService.postClient('my-app', dto, version).subscribe(result => { - client = result.payload; + clients = result; }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/clients'); @@ -96,9 +80,13 @@ describe('ClientsService', () => { expect(req.request.method).toEqual('POST'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({ id: 'client1', name: 'Client 1', secret: 'secret1', role: 'Developer' }); + req.flush(clientsResponse(1, 2), { + headers: { + etag: '2' + } + }); - expect(client!).toEqual(new ClientDto('client1', 'Client 1', 'secret1', 'Developer')); + expect(clients!).toEqual({ payload: createClients(1, 2), version: new Version('2') }); })); it('should make put request to rename client', @@ -106,27 +94,59 @@ describe('ClientsService', () => { const dto = { name: 'New Name' }; - clientsService.putClient('my-app', 'client1', dto, version).subscribe(); + const resource: Resource = { + _links: { + 'update': { method: 'PUT', href: '/api/apps/my-app/clients/client1' } + } + }; + + let clients: ClientsDto; + + clientsService.putClient('my-app', resource, dto, version).subscribe(result => { + clients = result; + }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/clients/client1'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({}); + req.flush(clientsResponse(1, 2), { + headers: { + etag: '2' + } + }); + + expect(clients!).toEqual({ payload: createClients(1, 2), version: new Version('2') }); })); it('should make delete request to remove client', inject([ClientsService, HttpTestingController], (clientsService: ClientsService, httpMock: HttpTestingController) => { - clientsService.deleteClient('my-app', 'client1', version).subscribe(); + const resource: Resource = { + _links: { + 'delete': { method: 'DELETE', href: '/api/apps/my-app/clients/client1' } + } + }; + + let clients: ClientsDto; + + clientsService.deleteClient('my-app', resource, version).subscribe(result => { + clients = result; + }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/clients/client1'); expect(req.request.method).toEqual('DELETE'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({}); + req.flush(clientsResponse(1, 2), { + headers: { + etag: '2' + } + }); + + expect(clients!).toEqual({ payload: createClients(1, 2), version: new Version('2') }); })); it('should make form request to create token', @@ -149,4 +169,45 @@ describe('ClientsService', () => { expect(accessTokenDto!).toEqual(new AccessTokenDto('token1', 'type1')); })); -}); \ No newline at end of file + + function clientsResponse(...ids: number[]) { + return { + contributors: ids.map(id => ({ + id: `id${id}`, + name: `Client ${id}`, + role: `Role${id}`, + secret: `secret${id}`, + _links: { + update: { method: 'PUT', href: `/clients/id${id}` } + } + })), + maxContributors: ids.length * 13, + _links: { + create: { method: 'POST', href: '/contributors' } + }, + _meta: { + isInvited: 'true' + } + }; + } +}); + +export function createClients(...ids: number[]): ClientsPayload { + return { + items: ids.map(id => + withLinks( + new ClientDto(`id${id}`, `Client ${id}`, `secret${id}`, `Role${id}`), + { + _links: { + update: { method: 'PUT', href: `/clients/id${id}` } + } + } + )), + _links: { + create: { method: 'POST', href: '/clients' } + }, + _meta: { + isInvited: 'true' + } + }; +} \ No newline at end of file diff --git a/src/Squidex/app/shared/services/clients.service.ts b/src/Squidex/app/shared/services/clients.service.ts index ee1e9a72d..050fa8a18 100644 --- a/src/Squidex/app/shared/services/clients.service.ts +++ b/src/Squidex/app/shared/services/clients.service.ts @@ -15,22 +15,28 @@ import { ApiUrlConfig, HTTP, mapVersioned, - Model, pretifyError, + Resource, + ResourceLinks, Version, - Versioned + Versioned, + withLinks } from '@app/framework'; -export type ClientsDto = Versioned; +export type ClientsDto = Versioned; +export type ClientsPayload = { + readonly items: ClientDto[] +} & Resource; + +export class ClientDto { + public readonly _links: ResourceLinks = {}; -export class ClientDto extends Model { constructor( public readonly id: string, public readonly name: string, public readonly secret: string, - public readonly role = 'Developer' + public readonly role: string ) { - super(); } } @@ -63,34 +69,19 @@ export class ClientsService { public getClients(appName: string): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/clients`); - return HTTP.getVersioned(this.http, url).pipe( + return HTTP.getVersioned(this.http, url).pipe( mapVersioned(({ body }) => { - const items: any[] = body; - - const clients = items.map(item => - new ClientDto( - item.id, - item.name || item.id, - item.secret, - item.role)); - - return clients; + return parseClients(body); }), pretifyError('Failed to load clients. Please reload.')); } - public postClient(appName: string, dto: CreateClientDto, version: Version): Observable> { + public postClient(appName: string, dto: CreateClientDto, version: Version): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/clients`); - return HTTP.postVersioned(this.http, url, dto, version).pipe( + return HTTP.postVersioned(this.http, url, dto, version).pipe( mapVersioned(({ body }) => { - const client = new ClientDto( - body.id, - body.name || body.id, - body.secret, - body.role); - - return client; + return parseClients(body); }), tap(() => { this.analytics.trackEvent('Client', 'Created', appName); @@ -98,20 +89,30 @@ export class ClientsService { pretifyError('Failed to add client. Please reload.')); } - public putClient(appName: string, id: string, dto: UpdateClientDto, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/clients/${id}`); + public putClient(appName: string, resource: Resource, dto: UpdateClientDto, version: Version): Observable { + const link = resource._links['update']; - return HTTP.putVersioned(this.http, url, dto, version).pipe( + const url = this.apiUrl.buildUrl(link.href); + + return HTTP.requestVersioned(this.http, link.method, url, version, dto).pipe( + mapVersioned(({ body }) => { + return parseClients(body); + }), tap(() => { this.analytics.trackEvent('Client', 'Updated', appName); }), pretifyError('Failed to revoke client. Please reload.')); } - public deleteClient(appName: string, id: string, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/clients/${id}`); + public deleteClient(appName: string, resource: Resource, version: Version): Observable { + const link = resource._links['delete']; - return HTTP.deleteVersioned(this.http, url, version).pipe( + const url = this.apiUrl.buildUrl(link.href); + + return HTTP.requestVersioned(this.http, link.method, url, version).pipe( + mapVersioned(({ body }) => { + return parseClients(body); + }), tap(() => { this.analytics.trackEvent('Client', 'Deleted', appName); }), @@ -135,4 +136,19 @@ export class ClientsService { }), pretifyError('Failed to create token. Please retry.')); } +} + +function parseClients(response: any): ClientsPayload { + const items: any[] = response; + + const clients = items.map(item => + withLinks( + new ClientDto( + item.id, + item.name || item.id, + item.secret, + item.role), + item)); + + return withLinks({ items: clients, _links: {} }, response); } \ No newline at end of file diff --git a/src/Squidex/app/shared/services/contents.service.ts b/src/Squidex/app/shared/services/contents.service.ts index bba68fe68..463f1a84e 100644 --- a/src/Squidex/app/shared/services/contents.service.ts +++ b/src/Squidex/app/shared/services/contents.service.ts @@ -101,7 +101,7 @@ export class ContentsService { const url = this.apiUrl.buildUrl(`/api/content/${appName}/${schemaName}?${fullQuery}`); - return HTTP.getVersioned(this.http, url).pipe( + return HTTP.getVersioned(this.http, url).pipe( map(({ payload }) => { const body = payload.body; @@ -132,7 +132,7 @@ export class ContentsService { public getContent(appName: string, schemaName: string, id: string): Observable { const url = this.apiUrl.buildUrl(`/api/content/${appName}/${schemaName}/${id}`); - return HTTP.getVersioned(this.http, url).pipe( + return HTTP.getVersioned(this.http, url).pipe( map(({ version, payload }) => { const body = payload.body; @@ -160,7 +160,7 @@ export class ContentsService { public getVersionData(appName: string, schemaName: string, id: string, version: Version): Observable> { const url = this.apiUrl.buildUrl(`/api/content/${appName}/${schemaName}/${id}/${version.value}`); - return HTTP.getVersioned(this.http, url).pipe( + return HTTP.getVersioned(this.http, url).pipe( mapVersioned(({ body }) => { return body; }), @@ -170,7 +170,7 @@ export class ContentsService { public postContent(appName: string, schemaName: string, dto: any, publish: boolean): Observable { const url = this.apiUrl.buildUrl(`/api/content/${appName}/${schemaName}?publish=${publish}`); - return HTTP.postVersioned(this.http, url, dto).pipe( + return HTTP.postVersioned(this.http, url, dto).pipe( map(({ version, payload }) => { const body = payload.body; diff --git a/src/Squidex/app/shared/services/contributors.service.spec.ts b/src/Squidex/app/shared/services/contributors.service.spec.ts index 951fc4732..4f0473a38 100644 --- a/src/Squidex/app/shared/services/contributors.service.spec.ts +++ b/src/Squidex/app/shared/services/contributors.service.spec.ts @@ -138,7 +138,7 @@ describe('ContributorsService', () => { export function createContributors(...ids: number[]): ContributorsPayload { return { - contributors: ids.map(id => + items: ids.map(id => withLinks( new ContributorDto(`id${id}`, id % 2 === 0 ? 'Owner' : 'Developer'), { diff --git a/src/Squidex/app/shared/services/contributors.service.ts b/src/Squidex/app/shared/services/contributors.service.ts index 5164cba6d..5fb0db81c 100644 --- a/src/Squidex/app/shared/services/contributors.service.ts +++ b/src/Squidex/app/shared/services/contributors.service.ts @@ -25,7 +25,7 @@ import { export type ContributorsDto = Versioned; export type ContributorsPayload = { - readonly contributors: ContributorDto[], + readonly items: ContributorDto[], readonly maxContributors: number } & Resource; @@ -57,7 +57,7 @@ export class ContributorsService { public getContributors(appName: string): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/contributors`); - return HTTP.getVersioned(this.http, url).pipe( + return HTTP.getVersioned(this.http, url).pipe( mapVersioned(({ body }) => { return parseContributors(body); }), @@ -95,8 +95,8 @@ export class ContributorsService { } } -function parseContributors(body: any) { - const items: any[] = body.contributors; +function parseContributors(response: any) { + const items: any[] = response.contributors; const contributors = items.map(item => withLinks( @@ -105,5 +105,5 @@ function parseContributors(body: any) { item.role), item)); - return withLinks({ contributors, maxContributors: body.maxContributors, _links: {} }, body); + return withLinks({ items: contributors, maxContributors: response.maxContributors, _links: {} }, response); } \ No newline at end of file diff --git a/src/Squidex/app/shared/services/patterns.service.ts b/src/Squidex/app/shared/services/patterns.service.ts index 694999bf3..6bd176d9c 100644 --- a/src/Squidex/app/shared/services/patterns.service.ts +++ b/src/Squidex/app/shared/services/patterns.service.ts @@ -52,7 +52,7 @@ export class PatternsService { public getPatterns(appName: string): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/patterns`); - return HTTP.getVersioned(this.http, url).pipe( + return HTTP.getVersioned(this.http, url).pipe( mapVersioned(({ body }) => { const items: any[] = body; @@ -72,7 +72,7 @@ export class PatternsService { public postPattern(appName: string, dto: EditPatternDto, version: Version): Observable> { const url = this.apiUrl.buildUrl(`api/apps/${appName}/patterns`); - return HTTP.postVersioned(this.http, url, dto, version).pipe( + return HTTP.postVersioned(this.http, url, dto, version).pipe( mapVersioned(({ body }) => { const pattern = new PatternDto( body.patternId, diff --git a/src/Squidex/app/shared/services/plans.service.ts b/src/Squidex/app/shared/services/plans.service.ts index 1d295fc6c..4c34a7110 100644 --- a/src/Squidex/app/shared/services/plans.service.ts +++ b/src/Squidex/app/shared/services/plans.service.ts @@ -63,7 +63,7 @@ export class PlansService { public getPlans(appName: string): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/plans`); - return HTTP.getVersioned(this.http, url).pipe( + return HTTP.getVersioned(this.http, url).pipe( mapVersioned(({ body }) => { const items: any[] = body.plans; @@ -93,7 +93,7 @@ export class PlansService { public putPlan(appName: string, dto: ChangePlanDto, version: Version): Observable> { const url = this.apiUrl.buildUrl(`api/apps/${appName}/plan`); - return HTTP.putVersioned(this.http, url, dto, version).pipe( + return HTTP.putVersioned(this.http, url, dto, version).pipe( mapVersioned(payload => { return payload.body; }), diff --git a/src/Squidex/app/shared/services/roles.service.ts b/src/Squidex/app/shared/services/roles.service.ts index ac1c27a39..5c1541897 100644 --- a/src/Squidex/app/shared/services/roles.service.ts +++ b/src/Squidex/app/shared/services/roles.service.ts @@ -54,7 +54,7 @@ export class RolesService { public getRoles(appName: string): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/roles`); - return HTTP.getVersioned(this.http, url).pipe( + return HTTP.getVersioned(this.http, url).pipe( mapVersioned(({ body }) => { const items: any[] = body.roles; @@ -73,7 +73,7 @@ export class RolesService { public postRole(appName: string, dto: CreateRoleDto, version: Version): Observable> { const url = this.apiUrl.buildUrl(`api/apps/${appName}/roles`); - return HTTP.postVersioned(this.http, url, dto, version).pipe( + return HTTP.postVersioned(this.http, url, dto, version).pipe( mapVersioned(() => { const role = new RoleDto(dto.name, 0, 0, []); diff --git a/src/Squidex/app/shared/services/rules.service.ts b/src/Squidex/app/shared/services/rules.service.ts index 529cdf948..14d48bc91 100644 --- a/src/Squidex/app/shared/services/rules.service.ts +++ b/src/Squidex/app/shared/services/rules.service.ts @@ -140,7 +140,7 @@ export class RulesService { public getActions(): Observable<{ [name: string]: RuleElementDto }> { const url = this.apiUrl.buildUrl('api/rules/actions'); - return HTTP.getVersioned(this.http, url).pipe( + return HTTP.getVersioned(this.http, url).pipe( map(({ payload }) => { const items: { [name: string]: any } = payload.body; @@ -176,7 +176,7 @@ export class RulesService { public getRules(appName: string): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/rules`); - return HTTP.getVersioned(this.http, url).pipe( + return HTTP.getVersioned(this.http, url).pipe( map(({ payload }) => { const items: any[] = payload.body.items; @@ -190,7 +190,7 @@ export class RulesService { public postRule(appName: string, dto: UpsertRuleDto): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/rules`); - return HTTP.postVersioned(this.http, url, dto).pipe( + return HTTP.postVersioned(this.http, url, dto).pipe( map(({ payload }) => { return parseRule(payload.body); }), @@ -263,7 +263,7 @@ export class RulesService { public getEvents(appName: string, take: number, skip: number): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/rules/events?take=${take}&skip=${skip}`); - return HTTP.getVersioned(this.http, url).pipe( + return HTTP.getVersioned(this.http, url).pipe( map(({ payload }) => { const body = payload.body; diff --git a/src/Squidex/app/shared/services/schemas.service.ts b/src/Squidex/app/shared/services/schemas.service.ts index 11172cf8b..dcefef6bc 100644 --- a/src/Squidex/app/shared/services/schemas.service.ts +++ b/src/Squidex/app/shared/services/schemas.service.ts @@ -216,7 +216,7 @@ export class SchemasService { public getSchemas(appName: string): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/schemas`); - return HTTP.getVersioned(this.http, url).pipe( + return HTTP.getVersioned(this.http, url).pipe( map(({ payload }) => { const body = payload.body; @@ -244,7 +244,7 @@ export class SchemasService { public getSchema(appName: string, id: string): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/schemas/${id}`); - return HTTP.getVersioned(this.http, url).pipe( + return HTTP.getVersioned(this.http, url).pipe( map(({ version, payload }) => { const body = payload.body; @@ -307,7 +307,7 @@ export class SchemasService { public postSchema(appName: string, dto: CreateSchemaDto): Observable> { const url = this.apiUrl.buildUrl(`api/apps/${appName}/schemas`); - return HTTP.postVersioned(this.http, url, dto).pipe( + return HTTP.postVersioned(this.http, url, dto).pipe( mapVersioned(({ body }) => body!), tap(() => { this.analytics.trackEvent('Schema', 'Created', appName); @@ -388,7 +388,7 @@ export class SchemasService { public postField(appName: string, schemaName: string, dto: AddFieldDto, parentId: number | undefined, version: Version): Observable> { const url = this.buildUrl(appName, schemaName, parentId, ''); - return HTTP.postVersioned(this.http, url, dto, version).pipe( + return HTTP.postVersioned(this.http, url, dto, version).pipe( mapVersioned(({ body }) => { if (parentId) { const field = new NestedFieldDto(body.id, dto.name, dto.properties, parentId); diff --git a/src/Squidex/app/shared/state/clients.state.spec.ts b/src/Squidex/app/shared/state/clients.state.spec.ts index 3199673cb..97f278375 100644 --- a/src/Squidex/app/shared/state/clients.state.spec.ts +++ b/src/Squidex/app/shared/state/clients.state.spec.ts @@ -9,13 +9,14 @@ import { of } from 'rxjs'; import { IMock, It, Mock, Times } from 'typemoq'; import { - ClientDto, ClientsService, ClientsState, DialogService, versioned } from '@app/shared/internal'; +import { createClients } from '../services/clients.service.spec'; + import { TestValues } from './_test-helpers'; describe('ClientsState', () => { @@ -26,10 +27,7 @@ describe('ClientsState', () => { version } = TestValues; - const oldClients = [ - new ClientDto('id1', 'name1', 'secret1'), - new ClientDto('id2', 'name2', 'secret2') - ]; + const oldClients = createClients(1, 2); let dialogs: IMock; let clientsService: IMock; @@ -53,7 +51,7 @@ describe('ClientsState', () => { clientsState.load().subscribe(); - expect(clientsState.snapshot.clients.values).toEqual(oldClients); + expect(clientsState.snapshot.clients.values).toEqual(oldClients.items); expect(clientsState.snapshot.version).toEqual(version); expect(clientsState.isLoaded).toBeTruthy(); @@ -80,21 +78,23 @@ describe('ClientsState', () => { clientsState.load().subscribe(); }); - it('should add client to snapshot when created', () => { - const newClient = new ClientDto('id3', 'name3', 'secret3'); + it('should update clients when client added', () => { + const updated = createClients(1, 2, 3); const request = { id: 'id3' }; clientsService.setup(x => x.postClient(app, request, version)) - .returns(() => of(versioned(newVersion, newClient))).verifiable(); + .returns(() => of(versioned(newVersion, updated))).verifiable(); clientsState.attach(request).subscribe(); - expect(clientsState.snapshot.clients.values).toEqual([...oldClients, newClient]); + expect(clientsState.snapshot.clients.values).toEqual(updated.items); expect(clientsState.snapshot.version).toEqual(newVersion); }); - it('should update properties when role updated', () => { + it('should update clients when role updated', () => { + const updated = createClients(1, 2, 3); + const request = { role: 'Owner' }; clientsService.setup(x => x.putClient(app, oldClients[0].id, request, version)) @@ -102,35 +102,33 @@ describe('ClientsState', () => { clientsState.update(oldClients[0], request).subscribe(); - const client_1 = clientsState.snapshot.clients.at(0); - - expect(client_1.name).toBe('name1'); - expect(client_1.role).toBe('Owner'); + expect(clientsState.snapshot.clients.values).toEqual(updated.items); expect(clientsState.snapshot.version).toEqual(newVersion); }); - it('should update properties when name updated', () => { + it('should update clients when name updated', () => { + const updated = createClients(1, 2, 3); + const request = { name: 'NewName' }; - clientsService.setup(x => x.putClient(app, oldClients[0].id, request, version)) + clientsService.setup(x => x.putClient(app, oldClients.items[0], request, version)) .returns(() => of(versioned(newVersion))).verifiable(); clientsState.update(oldClients[0], request).subscribe(); - const client_1 = clientsState.snapshot.clients.at(0); - - expect(client_1.name).toBe('NewName'); - expect(client_1.role).toBe('Developer'); + expect(clientsState.snapshot.clients.values).toEqual(updated.items); expect(clientsState.snapshot.version).toEqual(newVersion); }); - it('should remove client from snapshot when revoked', () => { - clientsService.setup(x => x.deleteClient(app, oldClients[0].id, version)) + it('should update clients when client revoked', () => { + const updated = createClients(1, 2, 3); + + clientsService.setup(x => x.deleteClient(app, oldClients.items[0], version)) .returns(() => of(versioned(newVersion))).verifiable(); clientsState.revoke(oldClients[0]).subscribe(); - expect(clientsState.snapshot.clients.values).toEqual([oldClients[1]]); + expect(clientsState.snapshot.clients.values).toEqual(updated.items); expect(clientsState.snapshot.version).toEqual(newVersion); }); }); diff --git a/src/Squidex/app/shared/state/clients.state.ts b/src/Squidex/app/shared/state/clients.state.ts index 9eeb90603..b7f6706d4 100644 --- a/src/Squidex/app/shared/state/clients.state.ts +++ b/src/Squidex/app/shared/state/clients.state.ts @@ -14,8 +14,7 @@ import { distinctUntilChanged, map, tap } from 'rxjs/operators'; import { DialogService, ImmutableArray, - mapVersioned, - shareMapSubscribed, + ResourceLinks, shareSubscribed, State, Version @@ -25,6 +24,7 @@ import { AppsState } from './apps.state'; import { ClientDto, + ClientsPayload, ClientsService, CreateClientDto, UpdateClientDto @@ -39,6 +39,9 @@ interface Snapshot { // Indicates if the clients are loaded. isLoaded?: boolean; + + // The links. + links: ResourceLinks; } type ClientsList = ImmutableArray; @@ -53,12 +56,16 @@ export class ClientsState extends State { this.changes.pipe(map(x => !!x.isLoaded), distinctUntilChanged()); + public links = + this.changes.pipe(map(x => x.links), + distinctUntilChanged()); + constructor( private readonly clientsService: ClientsService, private readonly appsState: AppsState, private readonly dialogs: DialogService ) { - super({ clients: ImmutableArray.empty(), version: new Version('') }); + super({ clients: ImmutableArray.empty(), version: new Version(''), links: {} }); } public load(isReload = false): Observable { @@ -72,50 +79,41 @@ export class ClientsState extends State { this.dialogs.notifyInfo('Clients reloaded.'); } - const clients = ImmutableArray.of(payload); - - this.next(s => { - return { ...s, clients, isLoaded: true, version }; - }); + this.replaceClients(payload, version); }), shareSubscribed(this.dialogs)); } - public attach(request: CreateClientDto): Observable { + public attach(request: CreateClientDto): Observable { return this.clientsService.postClient(this.appName, request, this.version).pipe( tap(({ version, payload }) => { - this.next(s => { - const clients = s.clients.push(payload); - - return { ...s, clients, version: version }; - }); + this.replaceClients(payload, version); }), - shareMapSubscribed(this.dialogs, x => x.payload)); + shareSubscribed(this.dialogs)); } public revoke(client: ClientDto): Observable { - return this.clientsService.deleteClient(this.appName, client.id, this.version).pipe( - tap(({ version }) => { - this.next(s => { - const clients = s.clients.filter(c => c.id !== client.id); - - return { ...s, clients, version }; - }); + return this.clientsService.deleteClient(this.appName, client, this.version).pipe( + tap(({ version, payload }) => { + this.replaceClients(payload, version); }), shareSubscribed(this.dialogs)); } - public update(client: ClientDto, request: UpdateClientDto): Observable { - return this.clientsService.putClient(this.appName, client.id, request, this.version).pipe( - mapVersioned(() => update(client, request)), + public update(client: ClientDto, request: UpdateClientDto): Observable { + return this.clientsService.putClient(this.appName, client, request, this.version).pipe( tap(({ version, payload }) => { - this.next(s => { - const clients = s.clients.replaceBy('id', payload); - - return { ...s, clients, version }; - }); + this.replaceClients(payload, version); }), - shareMapSubscribed(this.dialogs, x => x.payload)); + shareSubscribed(this.dialogs)); + } + + private replaceClients(payload: ClientsPayload, version: Version) { + const clients = ImmutableArray.of(payload.items); + + this.next(s => { + return { ...s, clients, isLoaded: true, version, links: payload._links }; + }); } private get appName() { @@ -125,7 +123,4 @@ export class ClientsState extends State { private get version() { return this.snapshot.version; } -} - -const update = (client: ClientDto, request: UpdateClientDto) => - client.with({ name: request.name || client.name, role: request.role || client.role }); \ No newline at end of file +} \ No newline at end of file diff --git a/src/Squidex/app/shared/state/contributors.state.spec.ts b/src/Squidex/app/shared/state/contributors.state.spec.ts index f529d80fb..bc693c358 100644 --- a/src/Squidex/app/shared/state/contributors.state.spec.ts +++ b/src/Squidex/app/shared/state/contributors.state.spec.ts @@ -51,7 +51,7 @@ describe('ContributorsState', () => { contributorsState.load().subscribe(); - expect(contributorsState.snapshot.contributors.values).toEqual(oldContributors.contributors); + expect(contributorsState.snapshot.contributors.values).toEqual(oldContributors.items); expect(contributorsState.snapshot.isMaxReached).toBeFalsy(); expect(contributorsState.snapshot.isLoaded).toBeTruthy(); expect(contributorsState.snapshot.maxContributors).toBe(oldContributors.maxContributors); @@ -90,7 +90,7 @@ describe('ContributorsState', () => { contributorsState.assign(request).subscribe(); - expect(contributorsState.snapshot.contributors.values).toEqual(oldContributors.contributors); + expect(contributorsState.snapshot.contributors.values).toEqual(oldContributors.items); expect(contributorsState.snapshot.maxContributors).toBe(oldContributors.maxContributors); expect(contributorsState.snapshot.version).toEqual(newVersion); }); @@ -98,12 +98,12 @@ describe('ContributorsState', () => { it('should update contributors when contribution revoked', () => { const updated = createContributors(1, 2, 3); - contributorsService.setup(x => x.deleteContributor(app, oldContributors.contributors[0], version)) + contributorsService.setup(x => x.deleteContributor(app, oldContributors.items[0], version)) .returns(() => of(versioned(newVersion, updated))).verifiable(); - contributorsState.revoke(oldContributors.contributors[0]).subscribe(); + contributorsState.revoke(oldContributors.items[0]).subscribe(); - expect(contributorsState.snapshot.contributors.values).toEqual(oldContributors.contributors); + expect(contributorsState.snapshot.contributors.values).toEqual(oldContributors.items); expect(contributorsState.snapshot.maxContributors).toBe(oldContributors.maxContributors); expect(contributorsState.snapshot.version).toEqual(newVersion); }); diff --git a/src/Squidex/app/shared/state/contributors.state.ts b/src/Squidex/app/shared/state/contributors.state.ts index 70f2eee03..6af56fff8 100644 --- a/src/Squidex/app/shared/state/contributors.state.ts +++ b/src/Squidex/app/shared/state/contributors.state.ts @@ -126,9 +126,9 @@ export class ContributorsState extends State { const maxContributors = payload.maxContributors || s.maxContributors; const isLoaded = true; - const isMaxReached = maxContributors > 0 && maxContributors <= payload.contributors.length; + const isMaxReached = maxContributors > 0 && maxContributors <= payload.items.length; - const contributors = ImmutableArray.of(payload.contributors); + const contributors = ImmutableArray.of(payload.items); return { ...s, contributors, maxContributors, isLoaded, isMaxReached, version: version, links: payload._links }; }); diff --git a/src/Squidex/app/shared/state/languages.state.spec.ts b/src/Squidex/app/shared/state/languages.state.spec.ts index 04769a297..96d451015 100644 --- a/src/Squidex/app/shared/state/languages.state.spec.ts +++ b/src/Squidex/app/shared/state/languages.state.spec.ts @@ -101,7 +101,7 @@ describe('LanguagesState', () => { languagesState.load().subscribe(); }); - it('should add language to snapshot when assigned', () => { + it('should update languages when language added', () => { const updated = createLanguages('de'); languagesService.setup(x => x.postLanguage(app, It.isAny(), version)) @@ -112,7 +112,7 @@ describe('LanguagesState', () => { expectUpdated(updated); }); - it('should update language in snapshot when updated', () => { + it('should update languages when language updated', () => { const updated = createLanguages('de'); const request = { isMaster: true, isOptional: false, fallback: [] }; @@ -125,7 +125,7 @@ describe('LanguagesState', () => { expectUpdated(updated); }); - it('should remove language from snapshot when deleted', () => { + it('should update languages when language deleted', () => { const updated = createLanguages('de'); languagesService.setup(x => x.deleteLanguage(app, oldLanguages.items[1], version)) From 48beff2420a3a5410de36e782acdc0bb20a7c349 Mon Sep 17 00:00:00 2001 From: Sebastian Date: Fri, 14 Jun 2019 12:50:55 +0100 Subject: [PATCH 12/64] A lot of settings migrated. --- .../Controllers/Apps/AppPatternsController.cs | 41 ++++-- .../Controllers/Apps/Models/AppPatternDto.cs | 15 +-- .../Controllers/Apps/Models/AppPatternsDto.cs | 38 ++++++ .../Apps/Models/ContributorsDto.cs | 4 +- src/Squidex/app/framework/utils/version.ts | 2 + .../shared/services/clients.service.spec.ts | 11 +- .../app/shared/services/clients.service.ts | 2 +- .../services/contributors.service.spec.ts | 2 +- .../shared/services/contributors.service.ts | 2 +- .../shared/services/patterns.service.spec.ts | 118 +++++++++++++----- .../app/shared/services/patterns.service.ts | 75 ++++++----- .../app/shared/services/roles.service.spec.ts | 115 ++++++++++++----- .../app/shared/services/roles.service.ts | 72 +++++++---- .../app/shared/state/clients.state.spec.ts | 31 ++--- src/Squidex/app/shared/state/clients.state.ts | 2 +- .../shared/state/contributors.state.spec.ts | 19 +-- .../app/shared/state/contributors.state.ts | 2 +- .../app/shared/state/languages.state.spec.ts | 8 +- .../app/shared/state/languages.state.ts | 2 +- .../app/shared/state/patterns.state.spec.ts | 57 ++++----- .../app/shared/state/patterns.state.ts | 60 ++++----- src/Squidex/app/shared/state/plans.state.ts | 2 +- .../app/shared/state/roles.state.spec.ts | 59 ++++----- src/Squidex/app/shared/state/roles.state.ts | 61 ++++----- 24 files changed, 491 insertions(+), 309 deletions(-) create mode 100644 src/Squidex/Areas/Api/Controllers/Apps/Models/AppPatternsDto.cs diff --git a/src/Squidex/Areas/Api/Controllers/Apps/AppPatternsController.cs b/src/Squidex/Areas/Api/Controllers/Apps/AppPatternsController.cs index fef02c374..b2d924b77 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/AppPatternsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/AppPatternsController.cs @@ -6,11 +6,11 @@ // ========================================================================== using System; -using System.Linq; using System.Threading.Tasks; using Microsoft.AspNetCore.Mvc; using Microsoft.Net.Http.Headers; using Squidex.Areas.Api.Controllers.Apps.Models; +using Squidex.Domain.Apps.Entities.Apps; using Squidex.Domain.Apps.Entities.Apps.Commands; using Squidex.Infrastructure.Commands; using Squidex.Shared; @@ -42,12 +42,12 @@ namespace Squidex.Areas.Api.Controllers.Apps /// [HttpGet] [Route("apps/{app}/patterns/")] - [ProducesResponseType(typeof(AppPatternDto[]), 200)] + [ProducesResponseType(typeof(AppPatternsDto), 200)] [ApiPermission(Permissions.AppCommon)] [ApiCosts(0)] public IActionResult GetPatterns(string app) { - var response = App.Patterns.Select(AppPatternDto.FromKvp).OrderBy(x => x.Name).ToArray(); + var response = AppPatternsDto.FromApp(App, this); Response.Headers[HeaderNames.ETag] = App.Version.ToString(); @@ -66,16 +66,15 @@ namespace Squidex.Areas.Api.Controllers.Apps /// [HttpPost] [Route("apps/{app}/patterns/")] - [ProducesResponseType(typeof(AppPatternDto), 201)] + [ProducesResponseType(typeof(AppPatternsDto), 200)] + [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppPatternsCreate)] [ApiCosts(1)] public async Task PostPattern(string app, [FromBody] UpdatePatternDto request) { var command = request.ToAddCommand(); - await CommandBus.PublishAsync(command); - - var response = AppPatternDto.FromCommand(command); + var response = await InvokeCommandAsync(command); return CreatedAtAction(nameof(GetPatterns), new { app }, response); } @@ -93,14 +92,17 @@ namespace Squidex.Areas.Api.Controllers.Apps /// [HttpPut] [Route("apps/{app}/patterns/{id}/")] - [ProducesResponseType(typeof(AppPatternDto), 201)] + [ProducesResponseType(typeof(AppPatternsDto), 200)] + [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppPatternsUpdate)] [ApiCosts(1)] public async Task UpdatePattern(string app, Guid id, [FromBody] UpdatePatternDto request) { - await CommandBus.PublishAsync(request.ToUpdateCommand(id)); + var command = request.ToUpdateCommand(id); + + var response = await InvokeCommandAsync(command); - return NoContent(); + return Ok(response); } /// @@ -109,7 +111,7 @@ namespace Squidex.Areas.Api.Controllers.Apps /// The name of the app. /// The id of the pattern to be deleted. /// - /// 204 => Pattern removed. + /// 200 => Pattern removed. /// 404 => Pattern or app not found. /// /// @@ -117,13 +119,26 @@ namespace Squidex.Areas.Api.Controllers.Apps /// [HttpDelete] [Route("apps/{app}/patterns/{id}/")] + [ProducesResponseType(typeof(AppPatternsDto), 200)] [ApiPermission(Permissions.AppPatternsDelete)] [ApiCosts(1)] public async Task DeletePattern(string app, Guid id) { - await CommandBus.PublishAsync(new DeletePattern { PatternId = id }); + var command = new DeletePattern { PatternId = id }; + + var response = await InvokeCommandAsync(command); + + return Ok(response); + } + + private async Task InvokeCommandAsync(ICommand command) + { + var context = await CommandBus.PublishAsync(command); + + var result = context.Result(); + var response = AppPatternsDto.FromApp(result, this); - return NoContent(); + return response; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppPatternDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/AppPatternDto.cs index ad8efa50f..335c29a8d 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppPatternDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/AppPatternDto.cs @@ -6,15 +6,14 @@ // ========================================================================== using System; -using System.Collections.Generic; using System.ComponentModel.DataAnnotations; using Squidex.Domain.Apps.Core.Apps; -using Squidex.Domain.Apps.Entities.Apps.Commands; using Squidex.Infrastructure.Reflection; +using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Apps.Models { - public sealed class AppPatternDto + public sealed class AppPatternDto : Resource { /// /// Unique id of the pattern. @@ -38,14 +37,16 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models /// public string Message { get; set; } - public static AppPatternDto FromKvp(KeyValuePair kvp) + public static AppPatternDto FromPattern(Guid id, AppPattern pattern, ApiController controller, string app) { - return SimpleMapper.Map(kvp.Value, new AppPatternDto { PatternId = kvp.Key }); + var result = SimpleMapper.Map(pattern, new AppPatternDto { PatternId = id }); + + return result.CreateLinks(controller, app); } - public static AppPatternDto FromCommand(AddPattern command) + private AppPatternDto CreateLinks(ApiController controller, string app) { - return SimpleMapper.Map(command, new AppPatternDto()); + return this; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppPatternsDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/AppPatternsDto.cs new file mode 100644 index 000000000..b0e03a577 --- /dev/null +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/AppPatternsDto.cs @@ -0,0 +1,38 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschraenkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +using System.ComponentModel.DataAnnotations; +using System.Linq; +using Squidex.Domain.Apps.Entities.Apps; +using Squidex.Web; + +namespace Squidex.Areas.Api.Controllers.Apps.Models +{ + public sealed class AppPatternsDto : Resource + { + /// + /// The patterns. + /// + [Required] + public AppPatternDto[] Items { get; set; } + + public static AppPatternsDto FromApp(IAppEntity app, ApiController controller) + { + var result = new AppPatternsDto + { + Items = app.Patterns.Select(x => AppPatternDto.FromPattern(x.Key, x.Value, controller, app.Name)).ToArray() + }; + + return result.CreateLinks(controller, app.Name); + } + + private AppPatternsDto CreateLinks(ApiController controller, string app) + { + return this; + } + } +} diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorsDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorsDto.cs index 5f7c330fe..28b91c6ad 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorsDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorsDto.cs @@ -21,7 +21,7 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models /// The contributors. /// [Required] - public ContributorDto[] Contributors { get; set; } + public ContributorDto[] Items { get; set; } /// /// The maximum number of allowed contributors. @@ -40,7 +40,7 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models var result = new ContributorsDto { - Contributors = contributors, + Items = contributors, }; if (isInvited) diff --git a/src/Squidex/app/framework/utils/version.ts b/src/Squidex/app/framework/utils/version.ts index 1f4888e28..e01ff9bb1 100644 --- a/src/Squidex/app/framework/utils/version.ts +++ b/src/Squidex/app/framework/utils/version.ts @@ -6,6 +6,8 @@ */ export class Version { + public static readonly EMPTY = new Version(''); + constructor( public readonly value: string ) { diff --git a/src/Squidex/app/shared/services/clients.service.spec.ts b/src/Squidex/app/shared/services/clients.service.spec.ts index 17146a941..cfa04bf3f 100644 --- a/src/Squidex/app/shared/services/clients.service.spec.ts +++ b/src/Squidex/app/shared/services/clients.service.spec.ts @@ -172,7 +172,7 @@ describe('ClientsService', () => { function clientsResponse(...ids: number[]) { return { - contributors: ids.map(id => ({ + items: ids.map(id => ({ id: `id${id}`, name: `Client ${id}`, role: `Role${id}`, @@ -181,12 +181,8 @@ describe('ClientsService', () => { update: { method: 'PUT', href: `/clients/id${id}` } } })), - maxContributors: ids.length * 13, _links: { - create: { method: 'POST', href: '/contributors' } - }, - _meta: { - isInvited: 'true' + create: { method: 'POST', href: '/clients' } } }; } @@ -205,9 +201,6 @@ export function createClients(...ids: number[]): ClientsPayload { )), _links: { create: { method: 'POST', href: '/clients' } - }, - _meta: { - isInvited: 'true' } }; } \ No newline at end of file diff --git a/src/Squidex/app/shared/services/clients.service.ts b/src/Squidex/app/shared/services/clients.service.ts index 050fa8a18..81c3c89be 100644 --- a/src/Squidex/app/shared/services/clients.service.ts +++ b/src/Squidex/app/shared/services/clients.service.ts @@ -139,7 +139,7 @@ export class ClientsService { } function parseClients(response: any): ClientsPayload { - const items: any[] = response; + const items: any[] = response.items; const clients = items.map(item => withLinks( diff --git a/src/Squidex/app/shared/services/contributors.service.spec.ts b/src/Squidex/app/shared/services/contributors.service.spec.ts index 4f0473a38..5363739cd 100644 --- a/src/Squidex/app/shared/services/contributors.service.spec.ts +++ b/src/Squidex/app/shared/services/contributors.service.spec.ts @@ -119,7 +119,7 @@ describe('ContributorsService', () => { function contributorsResponse(...ids: number[]) { return { - contributors: ids.map(id => ({ + items: ids.map(id => ({ contributorId: `id${id}`, role: id % 2 === 0 ? 'Owner' : 'Developer', _links: { update: { method: 'PUT', href: `/contributors/id${id}` } diff --git a/src/Squidex/app/shared/services/contributors.service.ts b/src/Squidex/app/shared/services/contributors.service.ts index 5fb0db81c..6bb1a98d4 100644 --- a/src/Squidex/app/shared/services/contributors.service.ts +++ b/src/Squidex/app/shared/services/contributors.service.ts @@ -96,7 +96,7 @@ export class ContributorsService { } function parseContributors(response: any) { - const items: any[] = response.contributors; + const items: any[] = response.items; const contributors = items.map(item => withLinks( diff --git a/src/Squidex/app/shared/services/patterns.service.spec.ts b/src/Squidex/app/shared/services/patterns.service.spec.ts index 8454db9da..2753fc6bb 100644 --- a/src/Squidex/app/shared/services/patterns.service.spec.ts +++ b/src/Squidex/app/shared/services/patterns.service.spec.ts @@ -13,8 +13,11 @@ import { ApiUrlConfig, PatternDto, PatternsDto, + PatternsPayload, PatternsService, - Version + Resource, + Version, + withLinks } from '@app/shared/internal'; describe('PatternsService', () => { @@ -51,31 +54,13 @@ describe('PatternsService', () => { expect(req.request.method).toEqual('GET'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush([ - { - patternId: '1', - pattern: '[0-9]', - name: 'Number', - message: 'Message1' - }, { - patternId: '2', - pattern: '[0-9]*', - name: 'Numbers', - message: 'Message2' - } - ], { + req.flush(patternsResponse(1, 2, 3), { headers: { etag: '2' } }); - expect(patterns!).toEqual({ - payload: [ - new PatternDto('1', 'Number', '[0-9]', 'Message1'), - new PatternDto('2', 'Numbers', '[0-9]*', 'Message2') - ], - version: new Version('2') - }); + expect(patterns!).toEqual({payload: createPatterns(1, 2, 3), version: new Version('2') }); })); it('should make post request to add pattern', @@ -83,10 +68,10 @@ describe('PatternsService', () => { const dto = { name: 'Number', pattern: '[0-9]' }; - let pattern: PatternDto; + let patterns: PatternsDto; patternService.postPattern('my-app', dto, version).subscribe(result => { - pattern = result.payload; + patterns = result; }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/patterns'); @@ -94,14 +79,13 @@ describe('PatternsService', () => { expect(req.request.method).toEqual('POST'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({ - name: 'Number', - patternId: '1', - pattern: '[0-9]', - message: 'Message1' + req.flush(patternsResponse(1, 2, 3), { + headers: { + etag: '2' + } }); - expect(pattern!).toEqual(new PatternDto('1', 'Number', '[0-9]', 'Message1')); + expect(patterns!).toEqual({payload: createPatterns(1, 2, 3), version: new Version('2') }); })); it('should make put request to update pattern', @@ -109,26 +93,92 @@ describe('PatternsService', () => { const dto = { name: 'Number', pattern: '[0-9]' }; - patternService.putPattern('my-app', '1', dto, version).subscribe(); + const resource: Resource = { + _links: { + update: { method: 'PUT', href: '/api/apps/my-app/patterns/1' } + } + }; + + let patterns: PatternsDto; + + patternService.putPattern('my-app', resource, dto, version).subscribe(result => { + patterns = result; + }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/patterns/1'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({}); + req.flush(patternsResponse(1, 2, 3), { + headers: { + etag: '2' + } + }); + + expect(patterns!).toEqual({payload: createPatterns(1, 2, 3), version: new Version('2') }); })); it('should make delete request to remove pattern', inject([PatternsService, HttpTestingController], (patternService: PatternsService, httpMock: HttpTestingController) => { - patternService.deletePattern('my-app', '1', version).subscribe(); + const resource: Resource = { + _links: { + delete: { method: 'DELETE', href: '/api/apps/my-app/patterns/1' } + } + }; + + let patterns: PatternsDto; + + patternService.deletePattern('my-app', resource, version).subscribe(result => { + patterns = result; + }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/patterns/1'); expect(req.request.method).toEqual('DELETE'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({}); + req.flush(patternsResponse(1, 2, 3), { + headers: { + etag: '2' + } + }); + + expect(patterns!).toEqual({payload: createPatterns(1, 2, 3), version: new Version('2') }); })); -}); \ No newline at end of file + + function patternsResponse(...ids: number[]) { + return { + items: ids.map(id => ({ + name: `Name${id}`, + patternId: `id${id}`, + pattern: `Pattern${id}`, + message: `Message${id}`, + _links: { + update: { method: 'PUT', href: `/patterns/id${id}` } + } + })), + _links: { + create: { method: 'POST', href: '/patterns' } + } + }; + } +}); + +export function createPatterns(...ids: number[]): PatternsPayload { + return { + items: ids.map(id => + withLinks( + new PatternDto(`id${id}`, `Name${id}`, `Pattern${id}`, `Message${id}`), + { + _links: { + update: { method: 'PUT', href: `/patterns/id${id}` } + } + } + )), + _links: { + create: { method: 'POST', href: '/patterns' } + } + }; +} \ No newline at end of file diff --git a/src/Squidex/app/shared/services/patterns.service.ts b/src/Squidex/app/shared/services/patterns.service.ts index 6bd176d9c..0a81a7b76 100644 --- a/src/Squidex/app/shared/services/patterns.service.ts +++ b/src/Squidex/app/shared/services/patterns.service.ts @@ -15,22 +15,28 @@ import { ApiUrlConfig, HTTP, mapVersioned, - Model, pretifyError, + Resource, + ResourceLinks, Version, - Versioned + Versioned, + withLinks } from '@app/framework'; -export type PatternsDto = Versioned; +export type PatternsDto = Versioned; +export type PatternsPayload = { + items: PatternDto[] +} & Resource; + +export class PatternDto { + public readonly _links: ResourceLinks = {}; -export class PatternDto extends Model { constructor( public readonly id: string, public readonly name: string, public readonly pattern: string, public readonly message?: string ) { - super(); } } @@ -54,33 +60,17 @@ export class PatternsService { return HTTP.getVersioned(this.http, url).pipe( mapVersioned(({ body }) => { - const items: any[] = body; - - const patterns = - items.map(item => - new PatternDto( - item.patternId, - item.name, - item.pattern, - item.message)); - - return patterns; + return parsePatterns(body); }), pretifyError('Failed to add pattern. Please reload.')); } - public postPattern(appName: string, dto: EditPatternDto, version: Version): Observable> { + public postPattern(appName: string, dto: EditPatternDto, version: Version): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/patterns`); return HTTP.postVersioned(this.http, url, dto, version).pipe( mapVersioned(({ body }) => { - const pattern = new PatternDto( - body.patternId, - body.name, - body.pattern, - body.message); - - return pattern; + return parsePatterns(body); }), tap(() => { this.analytics.trackEvent('Patterns', 'Created', appName); @@ -88,23 +78,48 @@ export class PatternsService { pretifyError('Failed to add pattern. Please reload.')); } - public putPattern(appName: string, id: string, dto: EditPatternDto, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/patterns/${id}`); + public putPattern(appName: string, resource: Resource, dto: EditPatternDto, version: Version): Observable { + const link = resource._links['update']; - return HTTP.putVersioned(this.http, url, dto, version).pipe( + const url = this.apiUrl.buildUrl(link.href); + + return HTTP.requestVersioned(this.http, link.method, url, version, dto).pipe( + mapVersioned(({ body }) => { + return parsePatterns(body); + }), tap(() => { this.analytics.trackEvent('Patterns', 'Updated', appName); }), pretifyError('Failed to update pattern. Please reload.')); } - public deletePattern(appName: string, id: string, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/patterns/${id}`); + public deletePattern(appName: string, resource: Resource, version: Version): Observable { + const link = resource._links['delete']; - return HTTP.deleteVersioned(this.http, url, version).pipe( + const url = this.apiUrl.buildUrl(link.href); + + return HTTP.requestVersioned(this.http, link.method, url, version).pipe( + mapVersioned(({ body }) => { + return parsePatterns(body); + }), tap(() => { this.analytics.trackEvent('Patterns', 'Configured', appName); }), pretifyError('Failed to remove pattern. Please reload.')); } +} + +function parsePatterns(response: any) { + const items: any[] = response.items; + + const patterns = items.map(item => + withLinks( + new PatternDto( + item.patternId, + item.name, + item.pattern, + item.message), + item)); + + return withLinks({ items: patterns, _links: {} }, response); } \ No newline at end of file diff --git a/src/Squidex/app/shared/services/roles.service.spec.ts b/src/Squidex/app/shared/services/roles.service.spec.ts index 687e9e305..1f69b6808 100644 --- a/src/Squidex/app/shared/services/roles.service.spec.ts +++ b/src/Squidex/app/shared/services/roles.service.spec.ts @@ -11,10 +11,13 @@ import { inject, TestBed } from '@angular/core/testing'; import { AnalyticsService, ApiUrlConfig, + Resource, RoleDto, RolesDto, + RolesPayload, RolesService, - Version + Version, + withLinks } from '@app/shared/internal'; describe('RolesService', () => { @@ -70,31 +73,13 @@ describe('RolesService', () => { expect(req.request.method).toEqual('GET'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush({ - roles: [{ - name: 'Role1', - numClients: 3, - numContributors: 5, - permissions: ['P1'] - }, { - name: 'Role2', - numClients: 7, - numContributors: 9, - permissions: ['P2'] - }] - }, { + req.flush(rolesResponse(2, 4), { headers: { etag: '2' } }); - expect(roles!).toEqual({ - payload: [ - new RoleDto('Role1', 3, 5, ['P1']), - new RoleDto('Role2', 7, 9, ['P2']) - ], - version: new Version('2') - }); + expect(roles!).toEqual({ payload: createRoles(2, 4), version: new Version('2') }); })); it('should make post request to add role', @@ -102,10 +87,10 @@ describe('RolesService', () => { const dto = { name: 'Role3' }; - let role: RoleDto; + let roles: RolesDto; roleService.postRole('my-app', dto, version).subscribe(result => { - role = result.payload; + roles = result; }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/roles'); @@ -113,9 +98,13 @@ describe('RolesService', () => { expect(req.request.method).toEqual('POST'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({}); + req.flush(rolesResponse(2, 4), { + headers: { + etag: '2' + } + }); - expect(role!).toEqual(new RoleDto('Role3', 0, 0, [])); + expect(roles!).toEqual({ payload: createRoles(2, 4), version: new Version('2') }); })); it('should make put request to update role', @@ -123,26 +112,92 @@ describe('RolesService', () => { const dto = { permissions: ['P4', 'P5'] }; - roleService.putRole('my-app', 'role1', dto, version).subscribe(); + const resource: Resource = { + _links: { + update: { method: 'PUT', href: '/api/apps/my-app/roles/role1' } + } + }; + + let roles: RolesDto; + + roleService.putRole('my-app', resource, dto, version).subscribe(result => { + roles = result; + }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/roles/role1'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({}); + req.flush(rolesResponse(2, 4), { + headers: { + etag: '2' + } + }); + + expect(roles!).toEqual({ payload: createRoles(2, 4), version: new Version('2') }); })); it('should make delete request to remove role', inject([RolesService, HttpTestingController], (roleService: RolesService, httpMock: HttpTestingController) => { - roleService.deleteRole('my-app', 'role1', version).subscribe(); + const resource: Resource = { + _links: { + delete: { method: 'DELETE', href: '/api/apps/my-app/roles/role1' } + } + }; + + let roles: RolesDto; + + roleService.deleteRole('my-app', resource, version).subscribe(result => { + roles = result; + }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/roles/role1'); expect(req.request.method).toEqual('DELETE'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({}); + req.flush(rolesResponse(2, 4), { + headers: { + etag: '2' + } + }); + + expect(roles!).toEqual({ payload: createRoles(2, 4), version: new Version('2') }); })); -}); \ No newline at end of file + + function rolesResponse(...ids: number[]) { + return { + items: ids.map(id => ({ + name: `name${id}`, + numClients: id * 2, + numContributors: id * 3, + permissions: [`permission${id}`], + _links: { + update: { method: 'PUT', href: `/roles/id${id}` } + } + })), + _links: { + create: { method: 'POST', href: '/roles' } + } + }; + } +}); + +export function createRoles(...ids: number[]): RolesPayload { + return { + items: ids.map(id => + withLinks( + new RoleDto(`name${id}`, id * 2, id * 3, [`permission${id}`]), + { + _links: { + update: { method: 'PUT', href: `/roles/id${id}` } + } + } + )), + _links: { + create: { method: 'POST', href: '/roles' } + } + }; +} \ No newline at end of file diff --git a/src/Squidex/app/shared/services/roles.service.ts b/src/Squidex/app/shared/services/roles.service.ts index 5c1541897..08c4cd942 100644 --- a/src/Squidex/app/shared/services/roles.service.ts +++ b/src/Squidex/app/shared/services/roles.service.ts @@ -15,22 +15,28 @@ import { ApiUrlConfig, HTTP, mapVersioned, - Model, pretifyError, + Resource, + ResourceLinks, Version, - Versioned + Versioned, + withLinks } from '@app/framework'; -export type RolesDto = Versioned; +export type RolesDto = Versioned; +export type RolesPayload = { + items: RoleDto[] +} & Resource; + +export class RoleDto { + public readonly _links: ResourceLinks = {}; -export class RoleDto extends Model { constructor( public readonly name: string, public readonly numClients: number, public readonly numContributors: number, public readonly permissions: string[] ) { - super(); } } @@ -56,28 +62,17 @@ export class RolesService { return HTTP.getVersioned(this.http, url).pipe( mapVersioned(({ body }) => { - const items: any[] = body.roles; - - const roles = items.map(item => - new RoleDto( - item.name, - item.numClients, - item.numContributors, - item.permissions)); - - return roles; + return parseRoles(body); }), pretifyError('Failed to load roles. Please reload.')); } - public postRole(appName: string, dto: CreateRoleDto, version: Version): Observable> { + public postRole(appName: string, dto: CreateRoleDto, version: Version): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/roles`); return HTTP.postVersioned(this.http, url, dto, version).pipe( - mapVersioned(() => { - const role = new RoleDto(dto.name, 0, 0, []); - - return role; + mapVersioned(({ body }) => { + return parseRoles(body); }), tap(() => { this.analytics.trackEvent('Role', 'Created', appName); @@ -85,20 +80,30 @@ export class RolesService { pretifyError('Failed to add role. Please reload.')); } - public putRole(appName: string, name: string, dto: UpdateRoleDto, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/roles/${name}`); + public putRole(appName: string, resource: Resource, dto: UpdateRoleDto, version: Version): Observable { + const link = resource._links['update']; + + const url = this.apiUrl.buildUrl(link.href); - return HTTP.putVersioned(this.http, url, dto, version).pipe( + return HTTP.requestVersioned(this.http, link.method, url, version, dto).pipe( + mapVersioned(({ body }) => { + return parseRoles(body); + }), tap(() => { this.analytics.trackEvent('Role', 'Updated', appName); }), pretifyError('Failed to revoke role. Please reload.')); } - public deleteRole(appName: string, name: string, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/roles/${name}`); + public deleteRole(appName: string, resource: Resource, version: Version): Observable { + const link = resource._links['delete']; - return HTTP.deleteVersioned(this.http, url, version).pipe( + const url = this.apiUrl.buildUrl(link.href); + + return HTTP.requestVersioned(this.http, link.method, url, version).pipe( + mapVersioned(({ body }) => { + return parseRoles(body); + }), tap(() => { this.analytics.trackEvent('Role', 'Deleted', appName); }), @@ -111,4 +116,19 @@ export class RolesService { return this.http.get(url).pipe( pretifyError('Failed to load permissions. Please reload.')); } +} + +export function parseRoles(response: any) { + const items: any[] = response.items; + + const roles = items.map(item => + withLinks( + new RoleDto( + item.name, + item.numClients, + item.numContributors, + item.permissions), + item)); + + return withLinks({ items: roles, _links: {} }, response); } \ No newline at end of file diff --git a/src/Squidex/app/shared/state/clients.state.spec.ts b/src/Squidex/app/shared/state/clients.state.spec.ts index 97f278375..ef3b902d2 100644 --- a/src/Squidex/app/shared/state/clients.state.spec.ts +++ b/src/Squidex/app/shared/state/clients.state.spec.ts @@ -9,6 +9,7 @@ import { of } from 'rxjs'; import { IMock, It, Mock, Times } from 'typemoq'; import { + ClientsPayload, ClientsService, ClientsState, DialogService, @@ -88,8 +89,7 @@ describe('ClientsState', () => { clientsState.attach(request).subscribe(); - expect(clientsState.snapshot.clients.values).toEqual(updated.items); - expect(clientsState.snapshot.version).toEqual(newVersion); + expectNewClients(updated); }); it('should update clients when role updated', () => { @@ -97,13 +97,12 @@ describe('ClientsState', () => { const request = { role: 'Owner' }; - clientsService.setup(x => x.putClient(app, oldClients[0].id, request, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + clientsService.setup(x => x.putClient(app, oldClients.items[0], request, version)) + .returns(() => of(versioned(newVersion, updated))).verifiable(); - clientsState.update(oldClients[0], request).subscribe(); + clientsState.update(oldClients.items[0], request).subscribe(); - expect(clientsState.snapshot.clients.values).toEqual(updated.items); - expect(clientsState.snapshot.version).toEqual(newVersion); + expectNewClients(updated); }); it('should update clients when name updated', () => { @@ -112,24 +111,28 @@ describe('ClientsState', () => { const request = { name: 'NewName' }; clientsService.setup(x => x.putClient(app, oldClients.items[0], request, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + .returns(() => of(versioned(newVersion, updated))).verifiable(); - clientsState.update(oldClients[0], request).subscribe(); + clientsState.update(oldClients.items[0], request).subscribe(); - expect(clientsState.snapshot.clients.values).toEqual(updated.items); - expect(clientsState.snapshot.version).toEqual(newVersion); + expectNewClients(updated); }); it('should update clients when client revoked', () => { const updated = createClients(1, 2, 3); clientsService.setup(x => x.deleteClient(app, oldClients.items[0], version)) - .returns(() => of(versioned(newVersion))).verifiable(); + .returns(() => of(versioned(newVersion, updated))).verifiable(); - clientsState.revoke(oldClients[0]).subscribe(); + clientsState.revoke(oldClients.items[0]).subscribe(); + expectNewClients(updated); + }); + + function expectNewClients(updated: ClientsPayload) { expect(clientsState.snapshot.clients.values).toEqual(updated.items); expect(clientsState.snapshot.version).toEqual(newVersion); - }); + + } }); }); \ No newline at end of file diff --git a/src/Squidex/app/shared/state/clients.state.ts b/src/Squidex/app/shared/state/clients.state.ts index b7f6706d4..c7c034db5 100644 --- a/src/Squidex/app/shared/state/clients.state.ts +++ b/src/Squidex/app/shared/state/clients.state.ts @@ -65,7 +65,7 @@ export class ClientsState extends State { private readonly appsState: AppsState, private readonly dialogs: DialogService ) { - super({ clients: ImmutableArray.empty(), version: new Version(''), links: {} }); + super({ clients: ImmutableArray.empty(), version: Version.EMPTY, links: {} }); } public load(isReload = false): Observable { diff --git a/src/Squidex/app/shared/state/contributors.state.spec.ts b/src/Squidex/app/shared/state/contributors.state.spec.ts index bc693c358..03e528aa2 100644 --- a/src/Squidex/app/shared/state/contributors.state.spec.ts +++ b/src/Squidex/app/shared/state/contributors.state.spec.ts @@ -9,6 +9,7 @@ import { of } from 'rxjs'; import { IMock, It, Mock, Times } from 'typemoq'; import { + ContributorsPayload, ContributorsService, ContributorsState, DialogService, @@ -81,7 +82,7 @@ describe('ContributorsState', () => { }); it('should update contributors when user assigned', () => { - const updated = createContributors(1, 2, 3); + const updated = createContributors(5, 6); const request = { contributorId: 'mail2stehle@gmail.com', role: 'Developer' }; @@ -90,22 +91,24 @@ describe('ContributorsState', () => { contributorsState.assign(request).subscribe(); - expect(contributorsState.snapshot.contributors.values).toEqual(oldContributors.items); - expect(contributorsState.snapshot.maxContributors).toBe(oldContributors.maxContributors); - expect(contributorsState.snapshot.version).toEqual(newVersion); + expectNewContributors(updated); }); it('should update contributors when contribution revoked', () => { - const updated = createContributors(1, 2, 3); + const updated = createContributors(5, 6); contributorsService.setup(x => x.deleteContributor(app, oldContributors.items[0], version)) .returns(() => of(versioned(newVersion, updated))).verifiable(); contributorsState.revoke(oldContributors.items[0]).subscribe(); - expect(contributorsState.snapshot.contributors.values).toEqual(oldContributors.items); - expect(contributorsState.snapshot.maxContributors).toBe(oldContributors.maxContributors); - expect(contributorsState.snapshot.version).toEqual(newVersion); + expectNewContributors(updated); }); + + function expectNewContributors(updated: ContributorsPayload) { + expect(contributorsState.snapshot.contributors.values).toEqual(updated.items); + expect(contributorsState.snapshot.maxContributors).toBe(updated.maxContributors); + expect(contributorsState.snapshot.version).toEqual(newVersion); + } }); }); \ No newline at end of file diff --git a/src/Squidex/app/shared/state/contributors.state.ts b/src/Squidex/app/shared/state/contributors.state.ts index 6af56fff8..e50d341e6 100644 --- a/src/Squidex/app/shared/state/contributors.state.ts +++ b/src/Squidex/app/shared/state/contributors.state.ts @@ -79,7 +79,7 @@ export class ContributorsState extends State { private readonly appsState: AppsState, private readonly dialogs: DialogService ) { - super({ contributors: ImmutableArray.empty(), version: new Version(''), maxContributors: -1, links: {} }); + super({ contributors: ImmutableArray.empty(), version: Version.EMPTY, maxContributors: -1, links: {} }); } public load(isReload = false): Observable { diff --git a/src/Squidex/app/shared/state/languages.state.spec.ts b/src/Squidex/app/shared/state/languages.state.spec.ts index 96d451015..cdbf7662d 100644 --- a/src/Squidex/app/shared/state/languages.state.spec.ts +++ b/src/Squidex/app/shared/state/languages.state.spec.ts @@ -109,7 +109,7 @@ describe('LanguagesState', () => { languagesState.add(languageIT).subscribe(); - expectUpdated(updated); + expectNewLanguages(updated); }); it('should update languages when language updated', () => { @@ -122,7 +122,7 @@ describe('LanguagesState', () => { languagesState.update(oldLanguages.items[1], request).subscribe(); - expectUpdated(updated); + expectNewLanguages(updated); }); it('should update languages when language deleted', () => { @@ -133,10 +133,10 @@ describe('LanguagesState', () => { languagesState.remove(oldLanguages.items[1]).subscribe(); - expectUpdated(updated); + expectNewLanguages(updated); }); - function expectUpdated(updated: AppLanguagesPayload) { + function expectNewLanguages(updated: AppLanguagesPayload) { expect(languagesState.snapshot.languages.values).toEqual([ { language: updated.items[0], diff --git a/src/Squidex/app/shared/state/languages.state.ts b/src/Squidex/app/shared/state/languages.state.ts index 00ff0806b..5c7d41686 100644 --- a/src/Squidex/app/shared/state/languages.state.ts +++ b/src/Squidex/app/shared/state/languages.state.ts @@ -96,7 +96,7 @@ export class LanguagesState extends State { allLanguages: ImmutableArray.empty(), allLanguagesNew: ImmutableArray.empty(), languages: ImmutableArray.empty(), - version: new Version(''), + version: Version.EMPTY, links: {} }); } diff --git a/src/Squidex/app/shared/state/patterns.state.spec.ts b/src/Squidex/app/shared/state/patterns.state.spec.ts index b0de52e42..5b6eb2016 100644 --- a/src/Squidex/app/shared/state/patterns.state.spec.ts +++ b/src/Squidex/app/shared/state/patterns.state.spec.ts @@ -10,12 +10,14 @@ import { IMock, It, Mock, Times } from 'typemoq'; import { DialogService, - PatternDto, + PatternsPayload, PatternsService, PatternsState, versioned } from '@app/shared/internal'; +import { createPatterns } from '../services/patterns.service.spec'; + import { TestValues } from './_test-helpers'; describe('PatternsState', () => { @@ -26,10 +28,7 @@ describe('PatternsState', () => { version } = TestValues; - const oldPatterns = [ - new PatternDto('id1', 'name1', 'pattern1', ''), - new PatternDto('id2', 'name2', 'pattern2', '') - ]; + const oldPatterns = createPatterns(1, 2, 3); let dialogs: IMock; let patternsService: IMock; @@ -49,11 +48,11 @@ describe('PatternsState', () => { describe('Loading', () => { it('should load patterns', () => { patternsService.setup(x => x.getPatterns(app)) - .returns(() => of({ payload: oldPatterns, version })).verifiable(); + .returns(() => of(versioned(version, oldPatterns))).verifiable(); patternsState.load().subscribe(); - expect(patternsState.snapshot.patterns.values).toEqual(oldPatterns); + expect(patternsState.snapshot.patterns.values).toEqual(oldPatterns.items); expect(patternsState.snapshot.version).toEqual(version); dialogs.verify(x => x.notifyInfo(It.isAnyString()), Times.never()); @@ -61,7 +60,7 @@ describe('PatternsState', () => { it('should show notification on load when reload is true', () => { patternsService.setup(x => x.getPatterns(app)) - .returns(() => of({ payload: oldPatterns, version })).verifiable(); + .returns(() => of(versioned(version, oldPatterns))).verifiable(); patternsState.load(true).subscribe(); @@ -74,49 +73,51 @@ describe('PatternsState', () => { describe('Updates', () => { beforeEach(() => { patternsService.setup(x => x.getPatterns(app)) - .returns(() => of({ payload: oldPatterns, version })).verifiable(); + .returns(() => of(versioned(version, oldPatterns))).verifiable(); patternsState.load().subscribe(); }); it('should add pattern to snapshot when created', () => { - const newPattern = new PatternDto('id3', 'name3', 'pattern3', ''); + const updated = createPatterns(4, 5); - const request = { ...newPattern }; + const request = { name: 'new', pattern: 'a-z' }; patternsService.setup(x => x.postPattern(app, request, version)) - .returns(() => of(versioned(newVersion, newPattern))).verifiable(); + .returns(() => of(versioned(newVersion, updated))).verifiable(); patternsState.create(request).subscribe(); - expect(patternsState.snapshot.patterns.values).toEqual([...oldPatterns, newPattern]); - expect(patternsState.snapshot.version).toEqual(newVersion); + expectNewPatterns(updated); }); it('should update properties when updated', () => { - const request = { name: 'name2_1', pattern: 'pattern2_1', message: 'message2_1' }; + const updated = createPatterns(4, 5); - patternsService.setup(x => x.putPattern(app, oldPatterns[1].id, request, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + const request = { name: 'name2_1', pattern: 'pattern2_1', message: 'message2_1' }; - patternsState.update(oldPatterns[1], request).subscribe(); + patternsService.setup(x => x.putPattern(app, oldPatterns.items[1], request, version)) + .returns(() => of(versioned(newVersion, updated))).verifiable(); - const pattern_1 = patternsState.snapshot.patterns.at(1); + patternsState.update(oldPatterns.items[1], request).subscribe(); - expect(pattern_1.name).toBe(request.name); - expect(pattern_1.pattern).toBe(request.pattern); - expect(pattern_1.message).toBe(request.message); - expect(patternsState.snapshot.version).toEqual(newVersion); + expectNewPatterns(updated); }); it('should remove pattern from snapshot when deleted', () => { - patternsService.setup(x => x.deletePattern(app, oldPatterns[0].id, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + const updated = createPatterns(4, 5); - patternsState.delete(oldPatterns[0]).subscribe(); + patternsService.setup(x => x.deletePattern(app, oldPatterns.items[0], version)) + .returns(() => of(versioned(newVersion, updated))).verifiable(); - expect(patternsState.snapshot.patterns.values).toEqual([oldPatterns[1]]); - expect(patternsState.snapshot.version).toEqual(newVersion); + patternsState.delete(oldPatterns.items[0]).subscribe(); + + expectNewPatterns(updated); }); + + function expectNewPatterns(updated: PatternsPayload) { + expect(patternsState.snapshot.patterns.values).toEqual(updated.items); + expect(patternsState.snapshot.version).toEqual(newVersion); + } }); }); \ No newline at end of file diff --git a/src/Squidex/app/shared/state/patterns.state.ts b/src/Squidex/app/shared/state/patterns.state.ts index d1c5afbd8..5e9b067ba 100644 --- a/src/Squidex/app/shared/state/patterns.state.ts +++ b/src/Squidex/app/shared/state/patterns.state.ts @@ -12,7 +12,7 @@ import { distinctUntilChanged, map, tap } from 'rxjs/operators'; import { DialogService, ImmutableArray, - mapVersioned, + ResourceLinks, shareMapSubscribed, shareSubscribed, State, @@ -24,6 +24,7 @@ import { AppsState } from './apps.state'; import { EditPatternDto, PatternDto, + PatternsPayload, PatternsService } from './../services/patterns.service'; @@ -36,6 +37,9 @@ interface Snapshot { // Indicates if the patterns are loaded. isLoaded?: boolean; + + // The links. + links: ResourceLinks; } type PatternsList = ImmutableArray; @@ -55,7 +59,7 @@ export class PatternsState extends State { private readonly appsState: AppsState, private readonly dialogs: DialogService ) { - super({ patterns: ImmutableArray.empty(), version: new Version('') }); + super({ patterns: ImmutableArray.empty(), version: Version.EMPTY, links: {} }); } public load(isReload = false): Observable { @@ -69,52 +73,43 @@ export class PatternsState extends State { this.dialogs.notifyInfo('Patterns reloaded.'); } - this.next(s => { - const patterns = ImmutableArray.of(payload).sortByStringAsc(x => x.name); - - return { ...s, patterns, isLoaded: true, version: version }; - }); + this.replacePatterns(payload, version); }), shareMapSubscribed(this.dialogs, x => x.payload)); } - public create(request: EditPatternDto): Observable { + public create(request: EditPatternDto): Observable { return this.patternsService.postPattern(this.appName, request, this.version).pipe( tap(({ version, payload }) => { - this.next(s => { - const patterns = s.patterns.push(payload).sortByStringAsc(x => x.name); - - return { ...s, patterns, version: version }; - }); + this.replacePatterns(payload, version); }), - shareMapSubscribed(this.dialogs, x => x.payload)); + shareSubscribed(this.dialogs)); } - public update(pattern: PatternDto, request: EditPatternDto): Observable { - return this.patternsService.putPattern(this.appName, pattern.id, request, this.version).pipe( - mapVersioned(() => update(pattern, request)), + public update(pattern: PatternDto, request: EditPatternDto): Observable { + return this.patternsService.putPattern(this.appName, pattern, request, this.version).pipe( tap(({ version, payload }) => { - this.next(s => { - const patterns = s.patterns.replaceBy('id', payload).sortByStringAsc(x => x.name); - - return { ...s, patterns, version: version }; - }); + this.replacePatterns(payload, version); }), - shareMapSubscribed(this.dialogs, x => x.payload)); + shareSubscribed(this.dialogs)); } public delete(pattern: PatternDto): Observable { - return this.patternsService.deletePattern(this.appName, pattern.id, this.version).pipe( - tap(({ version }) => { - this.next(s => { - const patterns = s.patterns.filter(c => c.id !== pattern.id); - - return { ...s, patterns, version: version }; - }); + return this.patternsService.deletePattern(this.appName, pattern, this.version).pipe( + tap(({ version, payload }) => { + this.replacePatterns(payload, version); }), shareSubscribed(this.dialogs)); } + private replacePatterns(payload: PatternsPayload, version: Version) { + const patterns = ImmutableArray.of(payload.items); + + this.next(s => { + return { ...s, patterns, isLoaded: true, version, links: payload._links }; + }); + } + private get appName() { return this.appsState.appName; } @@ -122,7 +117,4 @@ export class PatternsState extends State { private get version() { return this.snapshot.version; } -} - -const update = (pattern: PatternDto, request: EditPatternDto) => - pattern.with(request); \ No newline at end of file +} \ No newline at end of file diff --git a/src/Squidex/app/shared/state/plans.state.ts b/src/Squidex/app/shared/state/plans.state.ts index d1fcb0ba9..f6857342e 100644 --- a/src/Squidex/app/shared/state/plans.state.ts +++ b/src/Squidex/app/shared/state/plans.state.ts @@ -79,7 +79,7 @@ export class PlansState extends State { private readonly dialogs: DialogService, private readonly plansService: PlansService ) { - super({ plans: ImmutableArray.empty(), version: new Version('') }); + super({ plans: ImmutableArray.empty(), version: Version.EMPTY }); } public load(isReload = false, overridePlanId?: string): Observable { diff --git a/src/Squidex/app/shared/state/roles.state.spec.ts b/src/Squidex/app/shared/state/roles.state.spec.ts index d3326a6f5..6cf0a6345 100644 --- a/src/Squidex/app/shared/state/roles.state.spec.ts +++ b/src/Squidex/app/shared/state/roles.state.spec.ts @@ -10,12 +10,14 @@ import { IMock, It, Mock, Times } from 'typemoq'; import { DialogService, - RoleDto, + RolesPayload, RolesService, RolesState, versioned } from '@app/shared/internal'; +import { createRoles } from '../services/roles.service.spec'; + import { TestValues } from './_test-helpers'; describe('RolesState', () => { @@ -26,10 +28,7 @@ describe('RolesState', () => { version } = TestValues; - const oldRoles = [ - new RoleDto('Role1', 3, 5, ['P1']), - new RoleDto('Role2', 7, 9, ['P2']) - ]; + const oldRoles = createRoles(1, 2); let dialogs: IMock; let rolesService: IMock; @@ -45,11 +44,11 @@ describe('RolesState', () => { describe('Loading', () => { it('should load roles', () => { rolesService.setup(x => x.getRoles(app)) - .returns(() => of({ payload: oldRoles, version })).verifiable(); + .returns(() => of(versioned(version, oldRoles))).verifiable(); rolesState.load().subscribe(); - expect(rolesState.snapshot.roles.values).toEqual(oldRoles); + expect(rolesState.snapshot.roles.values).toEqual(oldRoles.items); expect(rolesState.snapshot.isLoaded).toBeTruthy(); expect(rolesState.snapshot.version).toEqual(version); @@ -76,42 +75,46 @@ describe('RolesState', () => { rolesState.load().subscribe(); }); - it('should add role to snapshot when added', () => { - const newRole = new RoleDto('Role3', 0, 0, ['P3']); + it('should update roles when role added', () => { + const updated = createRoles(4, 5); - const request = { name: newRole.name }; + const request = { name: 'newRole' }; rolesService.setup(x => x.postRole(app, request, version)) - .returns(() => of(versioned(newVersion, newRole))); + .returns(() => of(versioned(newVersion, updated))); rolesState.add(request).subscribe(); - expect(rolesState.snapshot.roles.values).toEqual([oldRoles[0], oldRoles[1], newRole]); - expect(rolesState.snapshot.version).toEqual(newVersion); + expectNewRoles(updated); }); - it('should update permissions when updated', () => { - const request = { permissions: ['P4', 'P5'] }; + it('should update roles when role updated', () => { + const updated = createRoles(4, 5); - rolesService.setup(x => x.putRole(app, oldRoles[1].name, request, version)) - .returns(() => of(versioned(newVersion))); + const request = { permissions: ['P4', 'P5'] }; - rolesState.update(oldRoles[1], request).subscribe(); + rolesService.setup(x => x.putRole(app, oldRoles.items[1], request, version)) + .returns(() => of(versioned(newVersion, updated))); - const role_1 = rolesState.snapshot.roles.at(1); + rolesState.update(oldRoles.items[1], request).subscribe(); - expect(role_1.permissions).toEqual(request.permissions); - expect(rolesState.snapshot.version).toEqual(newVersion); + expectNewRoles(updated); }); - it('should remove role from snapshot when deleted', () => { - rolesService.setup(x => x.deleteRole(app, oldRoles[0].name, version)) - .returns(() => of(versioned(newVersion))); + it('should update roles when role deleted', () => { + const updated = createRoles(4, 5); - rolesState.delete(oldRoles[0]).subscribe(); + rolesService.setup(x => x.deleteRole(app, oldRoles.items[1], version)) + .returns(() => of(versioned(newVersion, updated))); - expect(rolesState.snapshot.roles.values).toEqual([oldRoles[1]]); - expect(rolesState.snapshot.version).toEqual(newVersion); + rolesState.delete(oldRoles.items[1]).subscribe(); + + expectNewRoles(updated); }); + + function expectNewRoles(updated: RolesPayload) { + expect(rolesState.snapshot.roles.values).toEqual(updated.items); + expect(rolesState.snapshot.version).toEqual(newVersion); + } }); -}); \ No newline at end of file +}); diff --git a/src/Squidex/app/shared/state/roles.state.ts b/src/Squidex/app/shared/state/roles.state.ts index d4b924e01..b5f15d347 100644 --- a/src/Squidex/app/shared/state/roles.state.ts +++ b/src/Squidex/app/shared/state/roles.state.ts @@ -12,8 +12,7 @@ import { distinctUntilChanged, map, tap } from 'rxjs/operators'; import { DialogService, ImmutableArray, - mapVersioned, - shareMapSubscribed, + ResourceLinks, shareSubscribed, State, Version @@ -24,6 +23,7 @@ import { AppsState } from './apps.state'; import { CreateRoleDto, RoleDto, + RolesPayload, RolesService, UpdateRoleDto } from './../services/roles.service'; @@ -37,6 +37,9 @@ interface Snapshot { // Indicates if the roles are loaded. isLoaded?: boolean; + + // The links. + links: ResourceLinks; } type RolesList = ImmutableArray; @@ -56,7 +59,7 @@ export class RolesState extends State { private readonly appsState: AppsState, private readonly dialogs: DialogService ) { - super({ roles: ImmutableArray.empty(), version: new Version('') }); + super({ roles: ImmutableArray.empty(), version: Version.EMPTY, links: {} }); } public load(isReload = false): Observable { @@ -70,50 +73,41 @@ export class RolesState extends State { this.dialogs.notifyInfo('Roles reloaded.'); } - this.next(s => { - const roles = ImmutableArray.of(payload).sortByStringAsc(x => x.name); - - return { ...s, roles, isLoaded: true, version }; - }); + this.replaceRoles(payload, version); }), shareSubscribed(this.dialogs)); } - public add(request: CreateRoleDto): Observable { + public add(request: CreateRoleDto): Observable { return this.rolesService.postRole(this.appName, request, this.version).pipe( tap(({ version, payload }) => { - this.next(s => { - const roles = s.roles.push(payload).sortByStringAsc(x => x.name); + this.replaceRoles(payload, version); + }), + shareSubscribed(this.dialogs)); + } - return { ...s, roles, version }; - }); + public update(role: RoleDto, request: UpdateRoleDto): Observable { + return this.rolesService.putRole(this.appName, role, request, this.version).pipe( + tap(({ version, payload }) => { + this.replaceRoles(payload, version); }), - shareMapSubscribed(this.dialogs, x => x.payload)); + shareSubscribed(this.dialogs)); } public delete(role: RoleDto): Observable { - return this.rolesService.deleteRole(this.appName, role.name, this.version).pipe( - tap(({ version }) => { - this.next(s => { - const roles = s.roles.removeBy('name', role); - - return { ...s, roles, version }; - }); + return this.rolesService.deleteRole(this.appName, role, this.version).pipe( + tap(({ version, payload }) => { + this.replaceRoles(payload, version); }), shareSubscribed(this.dialogs)); } - public update(role: RoleDto, request: UpdateRoleDto): Observable { - return this.rolesService.putRole(this.appName, role.name, request, this.version).pipe( - mapVersioned(() => update(role, request)), - tap(({ version, payload }) => { - this.next(s => { - const roles = s.roles.replaceBy('name', payload); + private replaceRoles(payload: RolesPayload, version: Version) { + const roles = ImmutableArray.of(payload.items); - return { ...s, roles, version }; - }); - }), - shareMapSubscribed(this.dialogs, x => x.payload)); + this.next(s => { + return { ...s, roles, isLoaded: true, version, links: payload._links }; + }); } private get appName() { @@ -123,7 +117,4 @@ export class RolesState extends State { private get version() { return this.snapshot.version; } -} - -const update = (role: RoleDto, request: UpdateRoleDto) => - role.with({ permissions: request.permissions }); \ No newline at end of file +} \ No newline at end of file From 6d51a17402551d6f08064d9f59090bd3a087f573 Mon Sep 17 00:00:00 2001 From: Sebastian Stehle Date: Fri, 14 Jun 2019 22:23:52 +0200 Subject: [PATCH 13/64] More Hateos links. --- .../Apps/Role.cs | 8 ++++- src/Squidex.Web/Resource.cs | 5 +++ .../Controllers/Apps/AppPatternsController.cs | 14 ++++---- .../Controllers/Apps/AppRolesController.cs | 16 ++++----- .../Api/Controllers/Apps/Models/AppDto.cs | 6 ++-- .../{AppPatternDto.cs => PatternDto.cs} | 23 ++++++++++--- .../{AppPatternsDto.cs => PatternsDto.cs} | 22 +++++++++---- .../Api/Controllers/Apps/Models/RoleDto.cs | 33 +++++++++++++++---- .../Api/Controllers/Apps/Models/RolesDto.cs | 12 ++++++- .../pages/patterns/pattern.component.html | 3 +- .../pages/patterns/pattern.component.ts | 15 +++++++++ .../patterns/patterns-page.component.html | 2 +- .../settings/pages/roles/role.component.html | 11 ++++--- .../settings/pages/roles/role.component.ts | 14 +++----- .../pages/roles/roles-page.component.html | 2 +- .../shared/services/patterns.service.spec.ts | 2 +- .../app/shared/services/patterns.service.ts | 2 +- .../app/shared/services/roles.service.spec.ts | 3 +- .../app/shared/services/roles.service.ts | 6 ++-- .../app/shared/state/patterns.state.ts | 4 +++ src/Squidex/app/shared/state/roles.state.ts | 4 +++ 21 files changed, 146 insertions(+), 61 deletions(-) rename src/Squidex/Areas/Api/Controllers/Apps/Models/{AppPatternDto.cs => PatternDto.cs} (58%) rename src/Squidex/Areas/Api/Controllers/Apps/Models/{AppPatternsDto.cs => PatternsDto.cs} (50%) diff --git a/src/Squidex.Domain.Apps.Core.Model/Apps/Role.cs b/src/Squidex.Domain.Apps.Core.Model/Apps/Role.cs index 700fb4246..0e2770682 100644 --- a/src/Squidex.Domain.Apps.Core.Model/Apps/Role.cs +++ b/src/Squidex.Domain.Apps.Core.Model/Apps/Role.cs @@ -7,6 +7,7 @@ using Squidex.Infrastructure; using Squidex.Infrastructure.Security; +using System; using System.Collections.Generic; using System.Diagnostics.Contracts; using P = Squidex.Shared.Permissions; @@ -20,7 +21,7 @@ namespace Squidex.Domain.Apps.Core.Apps public const string Owner = "Owner"; public const string Reader = "Reader"; - private static readonly HashSet DefaultRolesSet = new HashSet + private static readonly HashSet DefaultRolesSet = new HashSet(StringComparer.OrdinalIgnoreCase) { Editor, Developer, @@ -54,6 +55,11 @@ namespace Squidex.Domain.Apps.Core.Apps return role != null && DefaultRolesSet.Contains(role); } + public static bool IsRole(string name, string expected) + { + return name != null && string.Equals(name, expected, StringComparison.OrdinalIgnoreCase); + } + public static Role CreateOwner(string app) { return new Role(Owner, diff --git a/src/Squidex.Web/Resource.cs b/src/Squidex.Web/Resource.cs index 59c4d10f9..d3eba847d 100644 --- a/src/Squidex.Web/Resource.cs +++ b/src/Squidex.Web/Resource.cs @@ -6,6 +6,7 @@ // ========================================================================== using Newtonsoft.Json; +using Squidex.Infrastructure; using System.Collections.Generic; using System.ComponentModel.DataAnnotations; @@ -50,6 +51,10 @@ namespace Squidex.Web public void AddLink(string rel, string method, string href) { + Guard.NotNullOrEmpty(rel, nameof(rel)); + Guard.NotNullOrEmpty(href, nameof(href)); + Guard.NotNullOrEmpty(method, nameof(method)); + Links[rel] = new ResourceLink { Href = href, Method = method }; } } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/AppPatternsController.cs b/src/Squidex/Areas/Api/Controllers/Apps/AppPatternsController.cs index b2d924b77..15cd8f80a 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/AppPatternsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/AppPatternsController.cs @@ -42,12 +42,12 @@ namespace Squidex.Areas.Api.Controllers.Apps /// [HttpGet] [Route("apps/{app}/patterns/")] - [ProducesResponseType(typeof(AppPatternsDto), 200)] + [ProducesResponseType(typeof(PatternsDto), 200)] [ApiPermission(Permissions.AppCommon)] [ApiCosts(0)] public IActionResult GetPatterns(string app) { - var response = AppPatternsDto.FromApp(App, this); + var response = PatternsDto.FromApp(App, this); Response.Headers[HeaderNames.ETag] = App.Version.ToString(); @@ -66,7 +66,7 @@ namespace Squidex.Areas.Api.Controllers.Apps /// [HttpPost] [Route("apps/{app}/patterns/")] - [ProducesResponseType(typeof(AppPatternsDto), 200)] + [ProducesResponseType(typeof(PatternsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppPatternsCreate)] [ApiCosts(1)] @@ -92,7 +92,7 @@ namespace Squidex.Areas.Api.Controllers.Apps /// [HttpPut] [Route("apps/{app}/patterns/{id}/")] - [ProducesResponseType(typeof(AppPatternsDto), 200)] + [ProducesResponseType(typeof(PatternsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppPatternsUpdate)] [ApiCosts(1)] @@ -119,7 +119,7 @@ namespace Squidex.Areas.Api.Controllers.Apps /// [HttpDelete] [Route("apps/{app}/patterns/{id}/")] - [ProducesResponseType(typeof(AppPatternsDto), 200)] + [ProducesResponseType(typeof(PatternsDto), 200)] [ApiPermission(Permissions.AppPatternsDelete)] [ApiCosts(1)] public async Task DeletePattern(string app, Guid id) @@ -131,12 +131,12 @@ namespace Squidex.Areas.Api.Controllers.Apps return Ok(response); } - private async Task InvokeCommandAsync(ICommand command) + private async Task InvokeCommandAsync(ICommand command) { var context = await CommandBus.PublishAsync(command); var result = context.Result(); - var response = AppPatternsDto.FromApp(result, this); + var response = PatternsDto.FromApp(result, this); return response; } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/AppRolesController.cs b/src/Squidex/Areas/Api/Controllers/Apps/AppRolesController.cs index 2cce25530..3ec75ce9c 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/AppRolesController.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/AppRolesController.cs @@ -105,7 +105,7 @@ namespace Squidex.Areas.Api.Controllers.Apps /// Update an existing app role. /// /// The name of the app. - /// The name of the role to be updated. + /// The name of the role to be updated. /// Role to be updated for the app. /// /// 200 => Role updated. @@ -113,13 +113,13 @@ namespace Squidex.Areas.Api.Controllers.Apps /// 404 => Role or app not found. /// [HttpPut] - [Route("apps/{app}/roles/{role}/")] + [Route("apps/{app}/roles/{name}/")] [ProducesResponseType(typeof(RolesDto), 200)] [ApiPermission(Permissions.AppRolesUpdate)] [ApiCosts(1)] - public async Task UpdateRole(string app, string role, [FromBody] UpdateRoleDto request) + public async Task UpdateRole(string app, string name, [FromBody] UpdateRoleDto request) { - var command = request.ToCommand(role); + var command = request.ToCommand(name); var response = await InvokeCommandAsync(command); @@ -130,21 +130,21 @@ namespace Squidex.Areas.Api.Controllers.Apps /// Remove role from app. /// /// The name of the app. - /// The name of the role. + /// The name of the role. /// /// 200 => Role deleted. /// 400 => Role is in use by contributor or client or default role. /// 404 => Role or app not found. /// [HttpDelete] - [Route("apps/{app}/roles/{role}/")] + [Route("apps/{app}/roles/{name}/")] [ProducesResponseType(typeof(RolesDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppRolesDelete)] [ApiCosts(1)] - public async Task DeleteRole(string app, string role) + public async Task DeleteRole(string app, string name) { - var command = new DeleteRole { Name = role }; + var command = new DeleteRole { Name = name }; var response = await InvokeCommandAsync(command); diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/AppDto.cs index ad7a0d072..1c2c28920 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/AppDto.cs @@ -8,7 +8,6 @@ using System; using System.Collections.Generic; using System.ComponentModel.DataAnnotations; -using System.Linq; using NodaTime; using Squidex.Areas.Api.Controllers.Assets; using Squidex.Areas.Api.Controllers.Backups; @@ -18,7 +17,6 @@ using Squidex.Areas.Api.Controllers.Rules; using Squidex.Areas.Api.Controllers.Schemas; using Squidex.Domain.Apps.Entities.Apps; using Squidex.Domain.Apps.Entities.Apps.Services; -using Squidex.Infrastructure; using Squidex.Infrastructure.Reflection; using Squidex.Infrastructure.Security; using Squidex.Shared; @@ -59,7 +57,7 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models /// /// The permission level of the user. /// - public string[] Permissions { get; set; } + public IEnumerable Permissions { get; set; } /// /// Indicates if the user can access the api. @@ -87,7 +85,7 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models var result = SimpleMapper.Map(app, new AppDto()); - result.Permissions = permissions.ToIds().ToArray(); + result.Permissions = permissions.ToIds(); result.PlanName = plans.GetPlanForApp(app)?.Name; result.CanAccessApi = controller.HasPermission(AllPermissions.AppApi, app.Name, "*", permissions); diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppPatternDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/PatternDto.cs similarity index 58% rename from src/Squidex/Areas/Api/Controllers/Apps/Models/AppPatternDto.cs rename to src/Squidex/Areas/Api/Controllers/Apps/Models/PatternDto.cs index 335c29a8d..1377aee3e 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppPatternDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/PatternDto.cs @@ -9,16 +9,17 @@ using System; using System.ComponentModel.DataAnnotations; using Squidex.Domain.Apps.Core.Apps; using Squidex.Infrastructure.Reflection; +using Squidex.Shared; using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Apps.Models { - public sealed class AppPatternDto : Resource + public sealed class PatternDto : Resource { /// /// Unique id of the pattern. /// - public Guid PatternId { get; set; } + public Guid Id { get; set; } /// /// The name of the suggestion. @@ -37,15 +38,27 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models /// public string Message { get; set; } - public static AppPatternDto FromPattern(Guid id, AppPattern pattern, ApiController controller, string app) + public static PatternDto FromPattern(Guid id, AppPattern pattern, ApiController controller, string app) { - var result = SimpleMapper.Map(pattern, new AppPatternDto { PatternId = id }); + var result = SimpleMapper.Map(pattern, new PatternDto { Id = id }); return result.CreateLinks(controller, app); } - private AppPatternDto CreateLinks(ApiController controller, string app) + private PatternDto CreateLinks(ApiController controller, string app) { + var values = new { app, id = Id }; + + if (controller.HasPermission(Permissions.AppPatternsUpdate, app)) + { + AddPutLink("update", controller.Url(x => nameof(x.UpdatePattern), values)); + } + + if (controller.HasPermission(Permissions.AppPatternsDelete, app)) + { + AddDeleteLink("delete", controller.Url(x => nameof(x.DeletePattern), values)); + } + return this; } } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppPatternsDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/PatternsDto.cs similarity index 50% rename from src/Squidex/Areas/Api/Controllers/Apps/Models/AppPatternsDto.cs rename to src/Squidex/Areas/Api/Controllers/Apps/Models/PatternsDto.cs index b0e03a577..ca9a2605a 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppPatternsDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/PatternsDto.cs @@ -8,30 +8,40 @@ using System.ComponentModel.DataAnnotations; using System.Linq; using Squidex.Domain.Apps.Entities.Apps; +using Squidex.Shared; using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Apps.Models { - public sealed class AppPatternsDto : Resource + public sealed class PatternsDto : Resource { /// /// The patterns. /// [Required] - public AppPatternDto[] Items { get; set; } + public PatternDto[] Items { get; set; } - public static AppPatternsDto FromApp(IAppEntity app, ApiController controller) + public static PatternsDto FromApp(IAppEntity app, ApiController controller) { - var result = new AppPatternsDto + var result = new PatternsDto { - Items = app.Patterns.Select(x => AppPatternDto.FromPattern(x.Key, x.Value, controller, app.Name)).ToArray() + Items = app.Patterns.Select(x => PatternDto.FromPattern(x.Key, x.Value, controller, app.Name)).ToArray() }; return result.CreateLinks(controller, app.Name); } - private AppPatternsDto CreateLinks(ApiController controller, string app) + private PatternsDto CreateLinks(ApiController controller, string app) { + var values = new { app }; + + AddSelfLink(controller.Url(x => nameof(x.GetPatterns), values)); + + if (controller.HasPermission(Permissions.AppPatternsCreate, app)) + { + AddPostLink("create", controller.Url(x => nameof(x.PostPattern), values)); + } + return this; } } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/RoleDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/RoleDto.cs index 856e47ec7..f703c3cf5 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/RoleDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/RoleDto.cs @@ -5,17 +5,17 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== -using System; using System.Collections.Generic; using System.ComponentModel.DataAnnotations; using System.Linq; using Squidex.Domain.Apps.Core.Apps; using Squidex.Domain.Apps.Entities.Apps; using Squidex.Web; +using AllPermissions = Squidex.Shared.Permissions; namespace Squidex.Areas.Api.Controllers.Apps.Models { - public sealed class RoleDto + public sealed class RoleDto : Resource { /// /// The role name. @@ -33,6 +33,11 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models /// public int NumContributors { get; set; } + /// + /// Indicates if the role is an builtin default role. + /// + public bool IsDefaultRole { get; set; } + /// /// Associated list of permissions. /// @@ -46,16 +51,32 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models var result = new RoleDto { Name = role.Name, - NumClients = app.Clients.Count(x => string.Equals(x.Value.Role, role.Name, StringComparison.OrdinalIgnoreCase)), - NumContributors = app.Contributors.Count(x => string.Equals(x.Value, role.Name, StringComparison.OrdinalIgnoreCase)), - Permissions = permissions.ToIds() + NumClients = app.Clients.Count(x => Role.IsRole(x.Value.Role, role.Name)), + NumContributors = app.Contributors.Count(x => Role.IsRole(x.Value, role.Name)), + Permissions = permissions.ToIds(), + IsDefaultRole = Role.IsDefaultRole(role.Name) }; return result.CreateLinks(controller, app.Name); } - private RoleDto CreateLinks(ApiController controller, string name) + private RoleDto CreateLinks(ApiController controller, string app) { + var values = new { app, name = Name }; + + if (!IsDefaultRole) + { + if (controller.HasPermission(AllPermissions.AppRolesUpdate, app) && NumClients == 0 && NumContributors == 0) + { + AddPutLink("update", controller.Url(x => nameof(x.UpdateRole), values)); + } + + if (controller.HasPermission(AllPermissions.AppRolesDelete, app)) + { + AddDeleteLink("delete", controller.Url(x => nameof(x.DeleteRole), values)); + } + } + return this; } } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/RolesDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/RolesDto.cs index 1e1b6b268..b43c32041 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/RolesDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/RolesDto.cs @@ -8,6 +8,7 @@ using System.ComponentModel.DataAnnotations; using System.Linq; using Squidex.Domain.Apps.Entities.Apps; +using Squidex.Shared; using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Apps.Models @@ -24,7 +25,7 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models { var result = new RolesDto { - Items = app.Roles.Values.Select(x => RoleDto.FromRole(x, app, controller)).ToArray() + Items = app.Roles.Values.Select(x => RoleDto.FromRole(x, app, controller)).OrderBy(x => x.Name).ToArray() }; return result.CreateLinks(controller, app.Name); @@ -32,6 +33,15 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models private RolesDto CreateLinks(ApiController controller, string app) { + var values = new { app }; + + AddSelfLink(controller.Url(x => nameof(x.GetRoles), values)); + + if (controller.HasPermission(Permissions.AppRolesCreate, app)) + { + AddPostLink("create", controller.Url(x => nameof(x.PostRole), values)); + } + return this; } } diff --git a/src/Squidex/app/features/settings/pages/patterns/pattern.component.html b/src/Squidex/app/features/settings/pages/patterns/pattern.component.html index 8ba33c1cf..6387d57ca 100644 --- a/src/Squidex/app/features/settings/pages/patterns/pattern.component.html +++ b/src/Squidex/app/features/settings/pages/patterns/pattern.component.html @@ -20,11 +20,12 @@
- - - +
@@ -43,14 +44,14 @@
-
+
- +
diff --git a/src/Squidex/app/features/settings/pages/roles/role.component.ts b/src/Squidex/app/features/settings/pages/roles/role.component.ts index 385fe6cf2..5bff6c267 100644 --- a/src/Squidex/app/features/settings/pages/roles/role.component.ts +++ b/src/Squidex/app/features/settings/pages/roles/role.component.ts @@ -14,17 +14,11 @@ import { AutocompleteSource, EditPermissionsForm, fadeAnimation, + hasAnyLink, RoleDto, RolesState } from '@app/shared'; -const DEFAULT_ROLES = [ - 'Owner', - 'Developer', - 'Editor', - 'Reader' -]; - @Component({ selector: 'sqx-role', styleUrls: ['./role.component.scss'], @@ -44,7 +38,7 @@ export class RoleComponent implements OnChanges { public addPermissionInput: AutocompleteComponent; public isEditing = false; - public isDefaultRole = false; + public isEditable = false; public addPermissionForm = new AddPermissionForm(this.formBuilder); @@ -57,11 +51,11 @@ export class RoleComponent implements OnChanges { } public ngOnChanges() { - this.isDefaultRole = DEFAULT_ROLES.indexOf(this.role.name) >= 0; + this.isEditable = hasAnyLink(this.role, 'update'); this.editForm.load(this.role.permissions); - if (this.isDefaultRole) { + if (!this.isEditable) { this.editForm.form.disable(); } } diff --git a/src/Squidex/app/features/settings/pages/roles/roles-page.component.html b/src/Squidex/app/features/settings/pages/roles/roles-page.component.html index a6fab661b..a6af88be0 100644 --- a/src/Squidex/app/features/settings/pages/roles/roles-page.component.html +++ b/src/Squidex/app/features/settings/pages/roles/roles-page.component.html @@ -17,7 +17,7 @@ -
+
diff --git a/src/Squidex/app/shared/services/patterns.service.spec.ts b/src/Squidex/app/shared/services/patterns.service.spec.ts index 2753fc6bb..ad2869ad9 100644 --- a/src/Squidex/app/shared/services/patterns.service.spec.ts +++ b/src/Squidex/app/shared/services/patterns.service.spec.ts @@ -151,8 +151,8 @@ describe('PatternsService', () => { function patternsResponse(...ids: number[]) { return { items: ids.map(id => ({ + id: `id${id}`, name: `Name${id}`, - patternId: `id${id}`, pattern: `Pattern${id}`, message: `Message${id}`, _links: { diff --git a/src/Squidex/app/shared/services/patterns.service.ts b/src/Squidex/app/shared/services/patterns.service.ts index 0a81a7b76..21c222305 100644 --- a/src/Squidex/app/shared/services/patterns.service.ts +++ b/src/Squidex/app/shared/services/patterns.service.ts @@ -115,7 +115,7 @@ function parsePatterns(response: any) { const patterns = items.map(item => withLinks( new PatternDto( - item.patternId, + item.id, item.name, item.pattern, item.message), diff --git a/src/Squidex/app/shared/services/roles.service.spec.ts b/src/Squidex/app/shared/services/roles.service.spec.ts index 1f69b6808..45d44067f 100644 --- a/src/Squidex/app/shared/services/roles.service.spec.ts +++ b/src/Squidex/app/shared/services/roles.service.spec.ts @@ -174,6 +174,7 @@ describe('RolesService', () => { numClients: id * 2, numContributors: id * 3, permissions: [`permission${id}`], + isDefaultRole: id % 2 === 0, _links: { update: { method: 'PUT', href: `/roles/id${id}` } } @@ -189,7 +190,7 @@ export function createRoles(...ids: number[]): RolesPayload { return { items: ids.map(id => withLinks( - new RoleDto(`name${id}`, id * 2, id * 3, [`permission${id}`]), + new RoleDto(`name${id}`, id * 2, id * 3, [`permission${id}`], id % 2 === 0), { _links: { update: { method: 'PUT', href: `/roles/id${id}` } diff --git a/src/Squidex/app/shared/services/roles.service.ts b/src/Squidex/app/shared/services/roles.service.ts index 08c4cd942..138775f2d 100644 --- a/src/Squidex/app/shared/services/roles.service.ts +++ b/src/Squidex/app/shared/services/roles.service.ts @@ -35,7 +35,8 @@ export class RoleDto { public readonly name: string, public readonly numClients: number, public readonly numContributors: number, - public readonly permissions: string[] + public readonly permissions: string[], + public readonly isDefaultRole: boolean ) { } } @@ -127,7 +128,8 @@ export function parseRoles(response: any) { item.name, item.numClients, item.numContributors, - item.permissions), + item.permissions, + item.isDefaultRole), item)); return withLinks({ items: roles, _links: {} }, response); diff --git a/src/Squidex/app/shared/state/patterns.state.ts b/src/Squidex/app/shared/state/patterns.state.ts index 5e9b067ba..45ce4ba73 100644 --- a/src/Squidex/app/shared/state/patterns.state.ts +++ b/src/Squidex/app/shared/state/patterns.state.ts @@ -54,6 +54,10 @@ export class PatternsState extends State { this.changes.pipe(map(x => !!x.isLoaded), distinctUntilChanged()); + public links = + this.changes.pipe(map(x => x.links), + distinctUntilChanged()); + constructor( private readonly patternsService: PatternsService, private readonly appsState: AppsState, diff --git a/src/Squidex/app/shared/state/roles.state.ts b/src/Squidex/app/shared/state/roles.state.ts index b5f15d347..6f63fa203 100644 --- a/src/Squidex/app/shared/state/roles.state.ts +++ b/src/Squidex/app/shared/state/roles.state.ts @@ -54,6 +54,10 @@ export class RolesState extends State { this.changes.pipe(map(x => !!x.isLoaded), distinctUntilChanged()); + public links = + this.changes.pipe(map(x => x.links), + distinctUntilChanged()); + constructor( private readonly rolesService: RolesService, private readonly appsState: AppsState, From d6c65d99e03031f69ca106a5a695408d9bb0e88f Mon Sep 17 00:00:00 2001 From: Sebastian Stehle Date: Fri, 14 Jun 2019 22:30:32 +0200 Subject: [PATCH 14/64] Preparation for content. --- .../Contents/ContentsController.cs | 16 +++------ .../Controllers/Contents/Models/ContentDto.cs | 11 ++++-- .../Contents/Models/ContentsDto.cs | 36 ++++++++++++++++++- 3 files changed, 47 insertions(+), 16 deletions(-) diff --git a/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs b/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs index 61c74d203..7ba607666 100644 --- a/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs @@ -128,11 +128,7 @@ namespace Squidex.Areas.Api.Controllers.Contents var result = await contentQuery.QueryAsync(context, Q.Empty.WithIds(ids).Ids); - var response = new ContentsDto - { - Total = result.Count, - Items = result.Take(200).Select(x => ContentDto.FromContent(x, context)).ToArray() - }; + var response = ContentsDto.FromContents(result, context, this, app); if (controllerOptions.Value.EnableSurrogateKeys && response.Items.Length <= controllerOptions.Value.MaxItemsForSurrogateKeys) { @@ -168,11 +164,7 @@ namespace Squidex.Areas.Api.Controllers.Contents var result = await contentQuery.QueryAsync(context, name, Q.Empty.WithIds(ids).WithODataQuery(Request.QueryString.ToString())); - var response = new ContentsDto - { - Total = result.Total, - Items = result.Take(200).Select(x => ContentDto.FromContent(x, context)).ToArray() - }; + var response = ContentsDto.FromContents(result, context, this, app); if (controllerOptions.Value.EnableSurrogateKeys && response.Items.Length <= controllerOptions.Value.MaxItemsForSurrogateKeys) { @@ -206,7 +198,7 @@ namespace Squidex.Areas.Api.Controllers.Contents var context = Context(); var content = await contentQuery.FindContentAsync(context, name, id); - var response = ContentDto.FromContent(content, context); + var response = ContentDto.FromContent(content, context, this, app); if (controllerOptions.Value.EnableSurrogateKeys) { @@ -242,7 +234,7 @@ namespace Squidex.Areas.Api.Controllers.Contents var context = Context(); var content = await contentQuery.FindContentAsync(context, name, id, version); - var response = ContentDto.FromContent(content, context); + var response = ContentDto.FromContent(content, context, this, app); if (controllerOptions.Value.EnableSurrogateKeys) { diff --git a/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentDto.cs b/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentDto.cs index 5e896298b..81b605a7d 100644 --- a/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentDto.cs @@ -20,7 +20,7 @@ using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Contents.Models { - public sealed class ContentDto : IGenerateETag + public sealed class ContentDto : Resource, IGenerateETag { /// /// The if of the content item. @@ -99,7 +99,7 @@ namespace Squidex.Areas.Api.Controllers.Contents.Models return response; } - public static ContentDto FromContent(IContentEntity content, QueryContext context) + public static ContentDto FromContent(IContentEntity content, QueryContext context, ApiController controller, string app) { var response = SimpleMapper.Map(content, new ContentDto()); @@ -119,7 +119,12 @@ namespace Squidex.Areas.Api.Controllers.Contents.Models response.ScheduleJob = SimpleMapper.Map(content.ScheduleJob, new ScheduleJobDto()); } - return response; + return response.CreateLinks(controller, app); + } + + private ContentDto CreateLinks(ApiController controller, object app) + { + return this; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentsDto.cs b/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentsDto.cs index 12c19cd9c..ef185416d 100644 --- a/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentsDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentsDto.cs @@ -5,9 +5,16 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== +using System.Collections.Generic; +using System.Linq; +using Squidex.Domain.Apps.Entities; +using Squidex.Domain.Apps.Entities.Contents; +using Squidex.Infrastructure; +using Squidex.Web; + namespace Squidex.Areas.Api.Controllers.Contents.Models { - public sealed class ContentsDto + public sealed class ContentsDto : Resource { /// /// The total number of content items. @@ -18,5 +25,32 @@ namespace Squidex.Areas.Api.Controllers.Contents.Models /// The content items. /// public ContentDto[] Items { get; set; } + + public static ContentsDto FromContents(IList contents, QueryContext context, ApiController controller, string app) + { + var result = new ContentsDto + { + Total = contents.Count, + Items = contents.Select(x => ContentDto.FromContent(x, context, controller, app)).ToArray() + }; + + return result.CreateLinks(controller, app); + } + + public static ContentsDto FromContents(IResultList contents, QueryContext context, ApiController controller, string app) + { + var result = new ContentsDto + { + Total = contents.Total, + Items = contents.Select(x => ContentDto.FromContent(x, context, controller, app)).ToArray() + }; + + return result.CreateLinks(controller, app); + } + + private ContentsDto CreateLinks(ApiController controller, string app) + { + return this; + } } } From dfe840f05a2d8453de03d05757dfe8cfc50679d1 Mon Sep 17 00:00:00 2001 From: Sebastian Stehle Date: Sat, 15 Jun 2019 00:24:20 +0200 Subject: [PATCH 15/64] Schemas updated. --- .../Api/Controllers/Rules/RulesController.cs | 10 +- .../Schemas/SchemaFieldsController.cs | 164 ++- .../Controllers/Schemas/SchemasController.cs | 82 +- .../administration/state/users.state.spec.ts | 12 +- .../app/shared/services/apps.service.spec.ts | 8 +- .../app/shared/services/apps.service.ts | 4 +- .../shared/services/assets.service.spec.ts | 10 +- .../app/shared/services/assets.service.ts | 10 +- .../shared/services/schemas.service.spec.ts | 951 ++++++++++-------- .../app/shared/services/schemas.service.ts | 424 ++++---- .../app/shared/state/schemas.state.spec.ts | 456 ++++----- src/Squidex/app/shared/state/schemas.state.ts | 330 ++---- 12 files changed, 1241 insertions(+), 1220 deletions(-) diff --git a/src/Squidex/Areas/Api/Controllers/Rules/RulesController.cs b/src/Squidex/Areas/Api/Controllers/Rules/RulesController.cs index 23c09c944..3e1ddb232 100644 --- a/src/Squidex/Areas/Api/Controllers/Rules/RulesController.cs +++ b/src/Squidex/Areas/Api/Controllers/Rules/RulesController.cs @@ -111,7 +111,7 @@ namespace Squidex.Areas.Api.Controllers.Rules { var command = request.ToCommand(); - var response = await InvokeCommand(app, command); + var response = await InvokeCommandAsync(app, command); return CreatedAtAction(nameof(GetRules), new { app }, response); } @@ -140,7 +140,7 @@ namespace Squidex.Areas.Api.Controllers.Rules { var command = request.ToCommand(id); - var response = await InvokeCommand(app, command); + var response = await InvokeCommandAsync(app, command); return Ok(response); } @@ -165,7 +165,7 @@ namespace Squidex.Areas.Api.Controllers.Rules { var command = new EnableRule { RuleId = id }; - var response = await InvokeCommand(app, command); + var response = await InvokeCommandAsync(app, command); return Ok(response); } @@ -190,7 +190,7 @@ namespace Squidex.Areas.Api.Controllers.Rules { var command = new DisableRule { RuleId = id }; - var response = await InvokeCommand(app, command); + var response = await InvokeCommandAsync(app, command); return Ok(response); } @@ -296,7 +296,7 @@ namespace Squidex.Areas.Api.Controllers.Rules return NoContent(); } - private async Task InvokeCommand(string app, RuleCommand command) + private async Task InvokeCommandAsync(string app, ICommand command) { var context = await CommandBus.PublishAsync(command); diff --git a/src/Squidex/Areas/Api/Controllers/Schemas/SchemaFieldsController.cs b/src/Squidex/Areas/Api/Controllers/Schemas/SchemaFieldsController.cs index 74a36f916..7a5b1ca80 100644 --- a/src/Squidex/Areas/Api/Controllers/Schemas/SchemaFieldsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Schemas/SchemaFieldsController.cs @@ -8,6 +8,7 @@ using System.Threading.Tasks; using Microsoft.AspNetCore.Mvc; using Squidex.Areas.Api.Controllers.Schemas.Models; +using Squidex.Domain.Apps.Entities.Schemas; using Squidex.Domain.Apps.Entities.Schemas.Commands; using Squidex.Infrastructure.Commands; using Squidex.Shared; @@ -40,17 +41,16 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPost] [Route("apps/{app}/schemas/{name}/fields/")] - [ProducesResponseType(typeof(EntityCreatedDto), 201)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 409)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task PostField(string app, string name, [FromBody] AddFieldDto request) { - var context = await CommandBus.PublishAsync(request.ToCommand()); + var command = request.ToCommand(); - var result = context.Result>(); - var response = EntityCreatedDto.FromResult(result); + var response = await InvokeCommandAsync(app, command); return StatusCode(201, response); } @@ -70,17 +70,16 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPost] [Route("apps/{app}/schemas/{name}/fields/{parentId:long}/nested/")] - [ProducesResponseType(typeof(EntityCreatedDto), 201)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 409)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task PostNestedField(string app, string name, long parentId, [FromBody] AddFieldDto request) { - var context = await CommandBus.PublishAsync(request.ToCommand(parentId)); + var command = request.ToCommand(parentId); - var result = context.Result>(); - var response = EntityCreatedDto.FromResult(result); + var response = await InvokeCommandAsync(app, command); return StatusCode(201, response); } @@ -92,20 +91,23 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The name of the schema. /// The request that contains the field ids. /// - /// 204 => Schema fields reorderd. + /// 200 => Schema fields reorderd. /// 400 => Schema field ids do not cover the fields of the schema. /// 404 => Schema or app not found. /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/ordering/")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task PutSchemaFieldOrdering(string app, string name, [FromBody] ReorderFieldsDto request) { - await CommandBus.PublishAsync(request.ToCommand()); + var command = request.ToCommand(); - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -116,20 +118,23 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The parent field id. /// The request that contains the field ids. /// - /// 204 => Schema fields reorderd. + /// 200 => Schema fields reorderd. /// 400 => Schema field ids do not cover the fields of the schema. /// 404 => Schema, field or app not found. /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{parentId:long}/nested/ordering/")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task PutNestedFieldOrdering(string app, string name, long parentId, [FromBody] ReorderFieldsDto request) { - await CommandBus.PublishAsync(request.ToCommand(parentId)); + var command = request.ToCommand(parentId); - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -140,20 +145,23 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The id of the field to update. /// The field object that needs to be added to the schema. /// - /// 204 => Schema field updated. + /// 200 => Schema field updated. /// 400 => Schema field properties not valid or field is locked. /// 404 => Schema, field or app not found. /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{id:long}/")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task PutField(string app, string name, long id, [FromBody] UpdateFieldDto request) { - await CommandBus.PublishAsync(request.ToCommand(id)); + var command = request.ToCommand(id); - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -165,20 +173,23 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The id of the field to update. /// The field object that needs to be added to the schema. /// - /// 204 => Schema field updated. + /// 200 => Schema field updated. /// 400 => Schema field properties not valid or field is locked. /// 404 => Schema, field or app not found. /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{parentId:long}/nested/{id:long}/")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task PutNestedField(string app, string name, long parentId, long id, [FromBody] UpdateFieldDto request) { - await CommandBus.PublishAsync(request.ToCommand(id, parentId)); + var command = request.ToCommand(id, parentId); - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -188,7 +199,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The name of the schema. /// The id of the field to lock. /// - /// 204 => Schema field shown. + /// 200 => Schema field shown. /// 400 => Schema field already locked. /// 404 => Schema, field or app not found. /// @@ -197,14 +208,17 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{id:long}/lock/")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task LockField(string app, string name, long id) { - await CommandBus.PublishAsync(new LockField { FieldId = id }); + var command = new LockField { FieldId = id }; - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -215,7 +229,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The parent field id. /// The id of the field to lock. /// - /// 204 => Schema field hidden. + /// 200 => Schema field hidden. /// 400 => Schema field already hidden. /// 404 => Field, schema, or app not found. /// @@ -224,14 +238,17 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{parentId:long}/nested/{id:long}/lock/")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task LockNestedField(string app, string name, long parentId, long id) { - await CommandBus.PublishAsync(new LockField { ParentFieldId = parentId, FieldId = id }); + var command = new LockField { ParentFieldId = parentId, FieldId = id }; - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -241,7 +258,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The name of the schema. /// The id of the field to hide. /// - /// 204 => Schema field hidden. + /// 200 => Schema field hidden. /// 400 => Schema field already hidden. /// 404 => Schema, field or app not found. /// @@ -250,14 +267,17 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{id:long}/hide/")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task HideField(string app, string name, long id) { - await CommandBus.PublishAsync(new HideField { FieldId = id }); + var command = new HideField { FieldId = id }; - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -268,7 +288,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The parent field id. /// The id of the field to hide. /// - /// 204 => Schema field hidden. + /// 200 => Schema field hidden. /// 400 => Schema field already hidden. /// 404 => Field, schema, or app not found. /// @@ -277,14 +297,17 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{parentId:long}/nested/{id:long}/hide/")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task HideNestedField(string app, string name, long parentId, long id) { - await CommandBus.PublishAsync(new HideField { ParentFieldId = parentId, FieldId = id }); + var command = new HideField { ParentFieldId = parentId, FieldId = id }; - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -294,7 +317,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The name of the schema. /// The id of the field to show. /// - /// 204 => Schema field shown. + /// 200 => Schema field shown. /// 400 => Schema field already visible. /// 404 => Schema, field or app not found. /// @@ -303,14 +326,17 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{id:long}/show/")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task ShowField(string app, string name, long id) { - await CommandBus.PublishAsync(new ShowField { FieldId = id }); + var command = new ShowField { FieldId = id }; - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -321,7 +347,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The parent field id. /// The id of the field to show. /// - /// 204 => Schema field shown. + /// 200 => Schema field shown. /// 400 => Schema field already visible. /// 404 => Schema, field or app not found. /// @@ -335,9 +361,11 @@ namespace Squidex.Areas.Api.Controllers.Schemas [ApiCosts(1)] public async Task ShowNestedField(string app, string name, long parentId, long id) { - await CommandBus.PublishAsync(new ShowField { ParentFieldId = parentId, FieldId = id }); + var command = new ShowField { ParentFieldId = parentId, FieldId = id }; - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -347,7 +375,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The name of the schema. /// The id of the field to enable. /// - /// 204 => Schema field enabled. + /// 200 => Schema field enabled. /// 400 => Schema field already enabled. /// 404 => Schema, field or app not found. /// @@ -356,14 +384,17 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{id:long}/enable/")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task EnableField(string app, string name, long id) { - await CommandBus.PublishAsync(new EnableField { FieldId = id }); + var command = new EnableField { FieldId = id }; - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -374,7 +405,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The parent field id. /// The id of the field to enable. /// - /// 204 => Schema field enabled. + /// 200 => Schema field enabled. /// 400 => Schema field already enabled. /// 404 => Schema, field or app not found. /// @@ -383,14 +414,17 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{parentId:long}/nested/{id:long}/enable/")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task EnableNestedField(string app, string name, long parentId, long id) { - await CommandBus.PublishAsync(new EnableField { ParentFieldId = parentId, FieldId = id }); + var command = new EnableField { ParentFieldId = parentId, FieldId = id }; - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -400,7 +434,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The name of the schema. /// The id of the field to disable. /// - /// 204 => Schema field disabled. + /// 200 => Schema field disabled. /// 400 => Schema field already disabled. /// 404 => Schema, field or app not found. /// @@ -409,14 +443,17 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{id:long}/disable/")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task DisableField(string app, string name, long id) { - await CommandBus.PublishAsync(new DisableField { FieldId = id }); + var command = new DisableField { FieldId = id }; - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -427,7 +464,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The parent field id. /// The id of the field to disable. /// - /// 204 => Schema field disabled. + /// 200 => Schema field disabled. /// 400 => Schema field already disabled. /// 404 => Schema, field or app not found. /// @@ -436,14 +473,17 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{parentId:long}/nested/{id:long}/disable/")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task DisableNestedField(string app, string name, long parentId, long id) { - await CommandBus.PublishAsync(new DisableField { ParentFieldId = parentId, FieldId = id }); + var command = new DisableField { ParentFieldId = parentId, FieldId = id }; - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -453,19 +493,23 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The name of the schema. /// The id of the field to disable. /// - /// 204 => Schema field deleted. + /// 200 => Schema field deleted. /// 400 => Field is locked. /// 404 => Schema, field or app not found. /// [HttpDelete] [Route("apps/{app}/schemas/{name}/fields/{id:long}/")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] + [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task DeleteField(string app, string name, long id) { - await CommandBus.PublishAsync(new DeleteField { FieldId = id }); + var command = new DeleteField { FieldId = id }; - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -476,12 +520,14 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The parent field id. /// The id of the field to disable. /// - /// 204 => Schema field deleted. + /// 200 => Schema field deleted. /// 400 => Field is locked. /// 404 => Schema, field or app not found. /// [HttpDelete] [Route("apps/{app}/schemas/{name}/fields/{parentId:long}/nested/{id:long}/")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] + [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task DeleteNestedField(string app, string name, long parentId, long id) @@ -490,5 +536,15 @@ namespace Squidex.Areas.Api.Controllers.Schemas return NoContent(); } + + private async Task InvokeCommandAsync(string app, ICommand command) + { + var context = await CommandBus.PublishAsync(command); + + var response = context.Result(); + var response = SchemaDetailsDto.FromSchemaWithDetails(response, this, app); + + return response; + } } } \ No newline at end of file diff --git a/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs b/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs index 7320e4484..e13e82131 100644 --- a/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs +++ b/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs @@ -109,7 +109,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPost] [Route("apps/{app}/schemas/")] - [ProducesResponseType(typeof(EntityCreatedDto), 201)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ProducesResponseType(typeof(ErrorDto), 409)] [ApiPermission(Permissions.AppSchemasCreate)] @@ -117,10 +117,8 @@ namespace Squidex.Areas.Api.Controllers.Schemas public async Task PostSchema(string app, [FromBody] CreateSchemaDto request) { var command = request.ToCommand(); - var context = await CommandBus.PublishAsync(command); - var result = context.Result>(); - var response = new EntityCreatedDto { Id = command.SchemaId.ToString(), Version = result.Version }; + var response = await InvokeCommandAsync(app, command); return CreatedAtAction(nameof(GetSchema), new { name = request.Name }, response); } @@ -138,13 +136,17 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPut] [Route("apps/{app}/schemas/{name}/")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] + [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task PutSchema(string app, string name, [FromBody] UpdateSchemaDto request) { - await CommandBus.PublishAsync(request.ToCommand()); + var command = request.ToCommand(); - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -154,19 +156,23 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The name of the schema. /// The schema object that needs to updated. /// - /// 204 => Schema updated. + /// 200 => Schema updated. /// 400 => Schema properties are not valid. /// 404 => Schema or app not found. /// [HttpPut] [Route("apps/{app}/schemas/{name}/sync")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] + [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task PutSchemaSync(string app, string name, [FromBody] SynchronizeSchemaDto request) { - await CommandBus.PublishAsync(request.ToCommand()); + var command = request.ToCommand(); - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -176,18 +182,22 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The name of the schema. /// The schema object that needs to updated. /// - /// 204 => Schema updated. + /// 200 => Schema updated. /// 404 => Schema or app not found. /// [HttpPut] [Route("apps/{app}/schemas/{name}/category")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] + [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task PutCategory(string app, string name, [FromBody] ChangeCategoryDto request) { - await CommandBus.PublishAsync(request.ToCommand()); + var command = request.ToCommand(); - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -197,18 +207,22 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The name of the schema. /// The preview urls for the schema. /// - /// 204 => Schema updated. + /// 200 => Schema updated. /// 404 => Schema or app not found. /// [HttpPut] [Route("apps/{app}/schemas/{name}/preview-urls")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] + [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task PutPreviewUrls(string app, string name, [FromBody] ConfigurePreviewUrlsDto request) { - await CommandBus.PublishAsync(request.ToCommand()); + var command = request.ToCommand(); - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -218,19 +232,23 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The name of the schema. /// The schema scripts object that needs to updated. /// - /// 204 => Schema updated. + /// 200 => Schema updated. /// 400 => Schema properties are not valid. /// 404 => Schema or app not found. /// [HttpPut] [Route("apps/{app}/schemas/{name}/scripts/")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] + [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasScripts)] [ApiCosts(1)] public async Task PutSchemaScripts(string app, string name, [FromBody] SchemaScriptsDto request) { - await CommandBus.PublishAsync(request.ToCommand()); + var command = request.ToCommand(); - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -239,20 +257,23 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The name of the app. /// The name of the schema to publish. /// - /// 204 => Schema has been published. + /// 200 => Schema has been published. /// 400 => Schema is already published. /// 404 => Schema or app not found. /// [HttpPut] [Route("apps/{app}/schemas/{name}/publish/")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasPublish)] [ApiCosts(1)] public async Task PublishSchema(string app, string name) { - await CommandBus.PublishAsync(new PublishSchema()); + var command = new PublishSchema(); - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -261,20 +282,23 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The name of the app. /// The name of the schema to unpublish. /// - /// 204 => Schema has been unpublished. + /// 200 => Schema has been unpublished. /// 400 => Schema is not published. /// 404 => Schema or app not found. /// [HttpPut] [Route("apps/{app}/schemas/{name}/unpublish/")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasPublish)] [ApiCosts(1)] public async Task UnpublishSchema(string app, string name) { - await CommandBus.PublishAsync(new UnpublishSchema()); + var command = new UnpublishSchema(); - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -296,5 +320,15 @@ namespace Squidex.Areas.Api.Controllers.Schemas return NoContent(); } + + private async Task InvokeCommandAsync(string app, ICommand command) + { + var context = await CommandBus.PublishAsync(command); + + var result = context.Result(); + var response = SchemaDetailsDto.FromSchemaWithDetails(result, this, app); + + return response; + } } } \ No newline at end of file diff --git a/src/Squidex/app/features/administration/state/users.state.spec.ts b/src/Squidex/app/features/administration/state/users.state.spec.ts index 279ff67c2..257bf4c72 100644 --- a/src/Squidex/app/features/administration/state/users.state.spec.ts +++ b/src/Squidex/app/features/administration/state/users.state.spec.ts @@ -25,6 +25,8 @@ describe('UsersState', () => { const user1 = createUser(1); const user2 = createUser(2); + const oldUsers = new UsersDto(200, [user1, user2]); + const newUser = createUser(3); let dialogs: IMock; @@ -45,7 +47,7 @@ describe('UsersState', () => { describe('Loading', () => { it('should load users', () => { usersService.setup(x => x.getUsers(10, 0, undefined)) - .returns(() => of(new UsersDto(200, [user1, user2]))).verifiable(); + .returns(() => of(oldUsers)).verifiable(); usersState.load().subscribe(); @@ -58,7 +60,7 @@ describe('UsersState', () => { it('should show notification on load when reload is true', () => { usersService.setup(x => x.getUsers(10, 0, undefined)) - .returns(() => of(new UsersDto(200, [user1, user2]))).verifiable(); + .returns(() => of(oldUsers)).verifiable(); usersState.load(true).subscribe(); @@ -74,7 +76,7 @@ describe('UsersState', () => { ]; usersService.setup(x => x.getUsers(10, 0, undefined)) - .returns(() => of(new UsersDto(200, [user1, user2]))).verifiable(Times.exactly(2)); + .returns(() => of(oldUsers)).verifiable(Times.exactly(2)); usersService.setup(x => x.getUsers(10, 0, undefined)) .returns(() => of(new UsersDto(200, newUsers))); @@ -88,7 +90,7 @@ describe('UsersState', () => { it('should load next page and prev page when paging', () => { usersService.setup(x => x.getUsers(10, 0, undefined)) - .returns(() => of(new UsersDto(200, [user1, user2]))).verifiable(Times.exactly(2)); + .returns(() => of(oldUsers)).verifiable(Times.exactly(2)); usersService.setup(x => x.getUsers(10, 10, undefined)) .returns(() => of(new UsersDto(200, []))).verifiable(); @@ -113,7 +115,7 @@ describe('UsersState', () => { describe('Updates', () => { beforeEach(() => { usersService.setup(x => x.getUsers(10, 0, undefined)) - .returns(() => of(new UsersDto(200, [user1, user2]))).verifiable(); + .returns(() => of(oldUsers)).verifiable(); usersState.load().subscribe(); }); diff --git a/src/Squidex/app/shared/services/apps.service.spec.ts b/src/Squidex/app/shared/services/apps.service.spec.ts index ef1b4f3bb..cc254694b 100644 --- a/src/Squidex/app/shared/services/apps.service.spec.ts +++ b/src/Squidex/app/shared/services/apps.service.spec.ts @@ -102,8 +102,8 @@ describe('AppsService', () => { id: `id${id}`, name: `name${id}${suffix}`, permissions: ['Owner'], - created: `${id % 1000 + 2000}-12-12T10:10`, - lastModified: `${id % 1000 + 2000}-11-11T10:10`, + created: `${id % 1000 + 2000}-12-12T10:10:00`, + lastModified: `${id % 1000 + 2000}-11-11T10:10:00`, canAccessApi: id % 2 === 0, canAccessContent: id % 2 === 0, planName: 'Free', @@ -120,8 +120,8 @@ export function createApp(id: number, suffix = '') { `id${id}`, `name${id}${suffix}`, ['Owner'], - DateTime.parseISO_UTC(`${id % 1000 + 2000}-12-12T10:10`), - DateTime.parseISO_UTC(`${id % 1000 + 2000}-11-11T10:10`), + DateTime.parseISO_UTC(`${id % 1000 + 2000}-12-12T10:10:00`), + DateTime.parseISO_UTC(`${id % 1000 + 2000}-11-11T10:10:00`), id % 2 === 0, id % 2 === 0, 'Free', diff --git a/src/Squidex/app/shared/services/apps.service.ts b/src/Squidex/app/shared/services/apps.service.ts index 0e1975183..06e9fd41a 100644 --- a/src/Squidex/app/shared/services/apps.service.ts +++ b/src/Squidex/app/shared/services/apps.service.ts @@ -95,8 +95,8 @@ function parseApp(response: any) { response.id, response.name, response.permissions, - DateTime.parseISO(response.created), - DateTime.parseISO(response.lastModified), + DateTime.parseISO_UTC(response.created), + DateTime.parseISO_UTC(response.lastModified), response.canAccessApi, response.canAccessContent, response.planName, diff --git a/src/Squidex/app/shared/services/assets.service.spec.ts b/src/Squidex/app/shared/services/assets.service.spec.ts index f2bb4cfc6..d63540d8a 100644 --- a/src/Squidex/app/shared/services/assets.service.spec.ts +++ b/src/Squidex/app/shared/services/assets.service.spec.ts @@ -305,9 +305,9 @@ describe('AssetsService', () => { function assetResponse(id: number, suffix = '') { return { id: `id${id}`, - created: `${id % 1000 + 2000}-12-12T10:10`, + created: `${id % 1000 + 2000}-12-12T10:10:00`, createdBy: `creator-${id}`, - lastModified: `${id % 1000 + 2000}-11-11T10:10`, + lastModified: `${id % 1000 + 2000}-11-11T10:10:00`, lastModifiedBy: `modifier-${id}`, fileName: `My Name${id}${suffix}.png`, fileHash: `My Hash${id}${suffix}`, @@ -334,10 +334,8 @@ describe('AssetsService', () => { export function createAsset(id: number, tags?: string[], suffix = '') { const result = new AssetDto( `id${id}`, - `creator-${id}`, - `modifier-${id}`, - DateTime.parseISO_UTC(`${id % 1000 + 2000}-12-12T10:10`), - DateTime.parseISO_UTC(`${id % 1000 + 2000}-11-11T10:10`), + DateTime.parseISO_UTC(`${id % 1000 + 2000}-12-12T10:10:00`), `creator-${id}`, + DateTime.parseISO_UTC(`${id % 1000 + 2000}-11-11T10:10:00`), `modifier-${id}`, `My Name${id}${suffix}.png`, `My Hash${id}${suffix}`, 'png', diff --git a/src/Squidex/app/shared/services/assets.service.ts b/src/Squidex/app/shared/services/assets.service.ts index c74866c18..14ffe966a 100644 --- a/src/Squidex/app/shared/services/assets.service.ts +++ b/src/Squidex/app/shared/services/assets.service.ts @@ -42,10 +42,10 @@ export class AssetDto { constructor( public readonly id: string, - public readonly createdBy: string, - public readonly lastModifiedBy: string, public readonly created: DateTime, + public readonly createdBy: string, public readonly lastModified: DateTime, + public readonly lastModifiedBy: string, public readonly fileName: string, public readonly fileHash: string, public readonly fileType: string, @@ -252,10 +252,8 @@ function parseAsset(response: any) { return withLinks( new AssetDto( response.id, - response.createdBy, - response.lastModifiedBy, - DateTime.parseISO_UTC(response.created), - DateTime.parseISO_UTC(response.lastModified), + DateTime.parseISO_UTC(response.created), response.createdBy, + DateTime.parseISO_UTC(response.lastModified), response.lastModifiedBy, response.fileName, response.fileHash, response.fileType, diff --git a/src/Squidex/app/shared/services/schemas.service.spec.ts b/src/Squidex/app/shared/services/schemas.service.spec.ts index 21e69270d..94d094e2f 100644 --- a/src/Squidex/app/shared/services/schemas.service.spec.ts +++ b/src/Squidex/app/shared/services/schemas.service.spec.ts @@ -13,20 +13,20 @@ import { ApiUrlConfig, createProperties, DateTime, - FieldDto, NestedFieldDto, + Resource, RootFieldDto, SchemaDetailsDto, SchemaDto, SchemaPropertiesDto, + SchemasDto, SchemasService, - Version, - Versioned + Version } from '@app/shared/internal'; -import { SchemaCreatedDto } from './schemas.service'; describe('SchemasService', () => { const version = new Version('1'); + const versionNew = new Version('2'); beforeEach(() => { TestBed.configureTestingModule({ @@ -54,7 +54,7 @@ describe('SchemasService', () => { it('should make get request to get schemas', inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { - let schemas: SchemaDto[]; + let schemas: SchemasDto; schemasService.getSchemas('my-app').subscribe(result => { schemas = result; @@ -65,54 +65,20 @@ describe('SchemasService', () => { expect(req.request.method).toEqual('GET'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush([ - { - id: 'id1', - name: 'name1', - category: 'category1', - properties: { - label: 'label1', - hints: 'hints1' - }, - isSingleton: true, - isPublished: true, - created: '2016-12-12T10:10', - createdBy: 'Created1', - lastModified: '2017-12-12T10:10', - lastModifiedBy: 'LastModifiedBy1', - version: 11, - data: {} - }, - { - id: 'id2', - name: 'name2', - category: 'category2', - properties: { - label: 'label2', - hints: 'hints2' - }, - isSingleton: true, - isPublished: true, - created: '2016-10-12T10:10', - createdBy: 'Created2', - lastModified: '2017-10-12T10:10', - lastModifiedBy: 'LastModifiedBy2', - version: 22, - data: {} - } - ]); - - expect(schemas!).toEqual( - [ - new SchemaDto('id1', 'name1', 'category1', new SchemaPropertiesDto('label1', 'hints1'), true, true, - DateTime.parseISO_UTC('2016-12-12T10:10'), 'Created1', - DateTime.parseISO_UTC('2017-12-12T10:10'), 'LastModifiedBy1', - new Version('11')), - new SchemaDto('id2', 'name2', 'category2', new SchemaPropertiesDto('label2', 'hints2'), true, true, - DateTime.parseISO_UTC('2016-10-12T10:10'), 'Created2', - DateTime.parseISO_UTC('2017-10-12T10:10'), 'LastModifiedBy2', - new Version('22')) - ]); + req.flush({ + items: [ + schemaResponse(12), + schemaResponse(13) + ] + }); + + expect(schemas!).toEqual({ + items: [ + createSchema(12), + createSchema(13) + ], + _links: {} + }); })); it('should make get request to get schema', @@ -129,200 +95,13 @@ describe('SchemasService', () => { expect(req.request.method).toEqual('GET'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush({ - id: 'id1', - name: 'name1', - category: 'category1', - isSingleton: true, - isPublished: true, - created: '2016-12-12T10:10', - createdBy: 'Created1', - lastModified: '2017-12-12T10:10', - lastModifiedBy: 'LastModifiedBy1', - properties: { - label: 'label1', - hints: 'hints1' - }, - previewUrls: { - 'Default': 'url' - }, - fields: [ - { - fieldId: 11, - name: 'field11', - isLocked: true, - isHidden: true, - isDisabled: true, - partitioning: 'language', - properties: { - fieldType: 'Array' - }, - nested: [ - { - fieldId: 101, - name: 'field101', - isLocked: true, - isHidden: true, - isDisabled: true, - properties: { - fieldType: 'String' - } - }, - { - fieldId: 102, - name: 'field102', - isLocked: true, - isHidden: true, - isDisabled: true, - properties: { - fieldType: 'Number' - } - } - ] - }, - { - fieldId: 12, - name: 'field12', - isLocked: true, - isHidden: true, - isDisabled: true, - partitioning: 'language', - properties: { - fieldType: 'Assets' - } - }, - { - fieldId: 13, - name: 'field13', - isLocked: true, - isHidden: true, - isDisabled: true, - partitioning: 'language', - properties: { - fieldType: 'Boolean' - } - }, - { - fieldId: 14, - name: 'field14', - isLocked: true, - isHidden: true, - isDisabled: true, - partitioning: 'language', - properties: { - fieldType: 'DateTime' - } - }, - { - fieldId: 15, - name: 'field15', - isLocked: true, - isHidden: true, - isDisabled: true, - partitioning: 'language', - properties: { - fieldType: 'Geolocation' - } - }, - { - fieldId: 16, - name: 'field16', - isLocked: true, - isHidden: true, - isDisabled: true, - partitioning: 'language', - properties: { - fieldType: 'Json' - } - }, - { - fieldId: 17, - name: 'field17', - isLocked: true, - isHidden: true, - isDisabled: true, - partitioning: 'language', - properties: { - fieldType: 'Number' - } - }, - { - fieldId: 18, - name: 'field18', - isLocked: true, - isHidden: true, - isDisabled: true, - partitioning: 'language', - properties: { - fieldType: 'References' - } - }, - { - fieldId: 19, - name: 'field19', - isLocked: true, - isHidden: true, - isDisabled: true, - partitioning: 'language', - properties: { - fieldType: 'String' - } - }, - { - fieldId: 20, - name: 'field20', - isLocked: true, - isHidden: true, - isDisabled: true, - partitioning: 'language', - properties: { - fieldType: 'Tags' - } - } - ], - scripts: { - query: '', - create: '', - change: '', - delete: '', - update: '' - } - }, { + req.flush(schemaDetailsResponse(12), { headers: { etag: '2' } }); - expect(schema!).toEqual( - new SchemaDetailsDto('id1', 'name1', 'category1', new SchemaPropertiesDto('label1', 'hints1'), true, true, - DateTime.parseISO_UTC('2016-12-12T10:10'), 'Created1', - DateTime.parseISO_UTC('2017-12-12T10:10'), 'LastModifiedBy1', - new Version('2'), - [ - new RootFieldDto(11, 'field11', createProperties('Array'), 'language', true, true, true, [ - new NestedFieldDto(101, 'field101', createProperties('String'), 11, true, true, true), - new NestedFieldDto(102, 'field102', createProperties('Number'), 11, true, true, true) - ]), - new RootFieldDto(12, 'field12', createProperties('Assets'), 'language', true, true, true), - new RootFieldDto(13, 'field13', createProperties('Boolean'), 'language', true, true, true), - new RootFieldDto(14, 'field14', createProperties('DateTime'), 'language', true, true, true), - new RootFieldDto(15, 'field15', createProperties('Geolocation'), 'language', true, true, true), - new RootFieldDto(16, 'field16', createProperties('Json'), 'language', true, true, true), - new RootFieldDto(17, 'field17', createProperties('Number'), 'language', true, true, true), - new RootFieldDto(18, 'field18', createProperties('References'), 'language', true, true, true), - new RootFieldDto(19, 'field19', createProperties('String'), 'language', true, true, true), - new RootFieldDto(20, 'field20', createProperties('Tags'), 'language', true, true, true) - ], - { - query: '', - create: '', - change: '', - delete: '', - update: '' - }, - { - 'Default': 'url' - })); + expect(schema!).toEqual(createSchemaDetails(12, versionNew)); })); it('should make post request to create schema', @@ -330,7 +109,7 @@ describe('SchemasService', () => { const dto = { name: 'name' }; - let schema: Versioned; + let schema: SchemaDetailsDto; schemasService.postSchema('my-app', dto).subscribe(result => { schema = result; @@ -341,20 +120,13 @@ describe('SchemasService', () => { expect(req.request.method).toEqual('POST'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush({ - id: '1' - }, { + req.flush(schemaDetailsResponse(12), { headers: { - etag: '1' + etag: '2' } }); - expect(schema!).toEqual({ - payload: { - id: '1' - }, - version - }); + expect(schema!).toEqual(createSchemaDetails(12, versionNew)); })); it('should make put request to update schema', @@ -362,14 +134,30 @@ describe('SchemasService', () => { const dto = { label: 'label1' }; - schemasService.putSchema('my-app', 'my-schema', dto, version).subscribe(); + const resource: Resource = { + _links: { + update: { method: 'PUT', href: '/api/apps/my-app/schemas/my-schema' } + } + }; + + let schema: SchemaDetailsDto; + + schemasService.putSchema('my-app', resource, dto, version).subscribe(result => { + schema = result; + }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toBe(version.value); - req.flush({}); + req.flush(schemaDetailsResponse(12), { + headers: { + etag: '2' + } + }); + + expect(schema!).toEqual(createSchemaDetails(12, versionNew)); })); it('should make put request to update schema scripts', @@ -377,14 +165,30 @@ describe('SchemasService', () => { const dto = {}; - schemasService.putScripts('my-app', 'my-schema', dto, version).subscribe(); + const resource: Resource = { + _links: { + updateScripts: { method: 'PUT', href: '/api/apps/my-app/schemas/my-schema/scripts' } + } + }; + + let schema: SchemaDetailsDto; + + schemasService.putScripts('my-app', resource, dto, version).subscribe(result => { + schema = result; + }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/scripts'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toBe(version.value); - req.flush({}); + req.flush(schemaDetailsResponse(12), { + headers: { + etag: '2' + } + }); + + expect(schema!).toEqual(createSchemaDetails(12, versionNew)); })); it('should make put request to update category', @@ -392,14 +196,30 @@ describe('SchemasService', () => { const dto = {}; - schemasService.putCategory('my-app', 'my-schema', dto, version).subscribe(); + const resource: Resource = { + _links: { + updateCategory: { method: 'PUT', href: '/api/apps/my-app/schemas/my-schema/category' } + } + }; + + let schema: SchemaDetailsDto; + + schemasService.putCategory('my-app', resource, dto, version).subscribe(result => { + schema = result; + }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/category'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toBe(version.value); - req.flush({}); + req.flush(schemaDetailsResponse(12), { + headers: { + etag: '2' + } + }); + + expect(schema!).toEqual(createSchemaDetails(12, versionNew)); })); it('should make put request to update preview urls', @@ -407,14 +227,30 @@ describe('SchemasService', () => { const dto = {}; - schemasService.putPreviewUrls('my-app', 'my-schema', dto, version).subscribe(); + const resource: Resource = { + _links: { + updateUrls: { method: 'PUT', href: '/api/apps/my-app/schemas/my-schema/preview-urls' } + } + }; + + let schema: SchemaDetailsDto; + + schemasService.putPreviewUrls('my-app', resource, dto, version).subscribe(result => { + schema = result; + }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/preview-urls'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toBe(version.value); - req.flush({}); + req.flush(schemaDetailsResponse(12), { + headers: { + etag: '2' + } + }); + + expect(schema!).toEqual(createSchemaDetails(12, versionNew)); })); it('should make post request to add field', @@ -422,10 +258,16 @@ describe('SchemasService', () => { const dto = { name: 'name', partitioning: 'invariant', properties: createProperties('Number') }; - let field: FieldDto; + const resource: Resource = { + _links: { + addField: { method: 'POST', href: '/api/apps/my-app/schemas/my-schema/fields' } + } + }; + + let schema: SchemaDetailsDto; - schemasService.postField('my-app', 'my-schema', dto, undefined, version).subscribe(result => { - field = result.payload; + schemasService.postField('my-app', resource, dto, version).subscribe(result => { + schema = result; }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields'); @@ -433,86 +275,102 @@ describe('SchemasService', () => { expect(req.request.method).toEqual('POST'); expect(req.request.headers.get('If-Match')).toBe(version.value); - req.flush({ id: 123 }); + req.flush(schemaDetailsResponse(12), { + headers: { + etag: '2' + } + }); - expect(field!).toEqual(new RootFieldDto(123, dto.name, dto.properties, dto.partitioning)); + expect(schema!).toEqual(createSchemaDetails(12, versionNew)); })); it('should make put request to publish schema', inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { - schemasService.publishSchema('my-app', 'my-schema', version).subscribe(); + const resource: Resource = { + _links: { + publish: { method: 'PUT', href: '/api/apps/my-app/schemas/my-schema/publish' } + } + }; + + let schema: SchemaDetailsDto; + + schemasService.publishSchema('my-app', resource, version).subscribe(result => { + schema = result; + }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/publish'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toBe(version.value); - req.flush({}); + req.flush(schemaDetailsResponse(12), { + headers: { + etag: '2' + } + }); + + expect(schema!).toEqual(createSchemaDetails(12, versionNew)); })); it('should make put request to unpublish schema', inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { - schemasService.unpublishSchema('my-app', 'my-schema', version).subscribe(); + const resource: Resource = { + _links: { + unpublish: { method: 'PUT', href: '/api/apps/my-app/schemas/my-schema/unpublish' } + } + }; + + let schema: SchemaDetailsDto; + + schemasService.unpublishSchema('my-app', resource, version).subscribe(result => { + schema = result; + }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/unpublish'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toBe(version.value); - req.flush({}); + req.flush(schemaDetailsResponse(12), { + headers: { + etag: '2' + } + }); + + expect(schema!).toEqual(createSchemaDetails(12, versionNew)); })); - it('should make post request to add nested field', + it('should make put request to update field', inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { - const dto = { name: 'name', partitioning: 'invariant', properties: createProperties('Number') }; + const dto = { properties: createProperties('Number') }; + + const resource: Resource = { + _links: { + update: { method: 'PUT', href: '/api/apps/my-app/schemas/my-schema/fields/1' } + } + }; - let field: FieldDto; + let schema: SchemaDetailsDto; - schemasService.postField('my-app', 'my-schema', dto, 13, version).subscribe(result => { - field = result.payload; + schemasService.putField('my-app', resource, dto, version).subscribe(result => { + schema = result; }); - const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/13/nested'); + const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/1'); - expect(req.request.method).toEqual('POST'); + expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toBe(version.value); - req.flush({ id: 123 }); - - expect(field!).toEqual(new NestedFieldDto(123, dto.name, dto.properties, 13)); - })); - - it('should make put request to update field', - inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { - - const dto = { properties: createProperties('Number') }; - - schemasService.putField('my-app', 'my-schema', 1, dto, undefined, version).subscribe(); - - const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/1'); - - expect(req.request.method).toEqual('PUT'); - expect(req.request.headers.get('If-Match')).toBe(version.value); - - req.flush({}); - })); - - it('should make put request to update nested field', - inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { - - const dto = { properties: createProperties('Number') }; - - schemasService.putField('my-app', 'my-schema', 1, dto, 13, version).subscribe(); - - const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/13/nested/1'); - - expect(req.request.method).toEqual('PUT'); - expect(req.request.headers.get('If-Match')).toBe(version.value); + req.flush(schemaDetailsResponse(12), { + headers: { + etag: '2' + } + }); - req.flush({}); + expect(schema!).toEqual(createSchemaDetails(12, versionNew)); })); it('should make put request to update field ordering', @@ -520,191 +378,216 @@ describe('SchemasService', () => { const dto = [1, 2, 3]; - schemasService.putFieldOrdering('my-app', 'my-schema', dto, undefined, version).subscribe(); - - const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/ordering'); - - expect(req.request.method).toEqual('PUT'); - expect(req.request.headers.get('If-Match')).toBe(version.value); - - req.flush({}); - })); - - it('should make put request to update nested field ordering', - inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { + const resource: Resource = { + _links: { + order: { method: 'PUT', href: '/api/apps/my-app/schemas/my-schema/fields/ordering' } + } + }; - const dto = [1, 2, 3]; + let schema: SchemaDetailsDto; - schemasService.putFieldOrdering('my-app', 'my-schema', dto, 13, version).subscribe(); + schemasService.putFieldOrdering('my-app', resource, dto, version).subscribe(result => { + schema = result; + }); - const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/13/nested/ordering'); + const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/ordering'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toBe(version.value); - req.flush({}); + req.flush(schemaDetailsResponse(12), { + headers: { + etag: '2' + } + }); + + expect(schema!).toEqual(createSchemaDetails(12, versionNew)); })); it('should make put request to lock field', inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { - schemasService.lockField('my-app', 'my-schema', 1, undefined, version).subscribe(); - - const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/1/lock'); - - expect(req.request.method).toEqual('PUT'); - expect(req.request.headers.get('If-Match')).toBe(version.value); - - req.flush({}); - })); + const resource: Resource = { + _links: { + lock: { method: 'PUT', href: '/api/apps/my-app/schemas/my-schema/fields/1/lock' } + } + }; - it('should make put request to lock nested field', - inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { + let schema: SchemaDetailsDto; - schemasService.lockField('my-app', 'my-schema', 1, 13, version).subscribe(); + schemasService.lockField('my-app', resource, version).subscribe(result => { + schema = result; + }); - const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/13/nested/1/lock'); + const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/1/lock'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toBe(version.value); - req.flush({}); + req.flush(schemaDetailsResponse(12), { + headers: { + etag: '2' + } + }); + + expect(schema!).toEqual(createSchemaDetails(12, versionNew)); })); it('should make put request to enable field', inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { - schemasService.enableField('my-app', 'my-schema', 1, undefined, version).subscribe(); - - const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/1/enable'); - - expect(req.request.method).toEqual('PUT'); - expect(req.request.headers.get('If-Match')).toBe(version.value); - - req.flush({}); - })); + const resource: Resource = { + _links: { + enable: { method: 'PUT', href: '/api/apps/my-app/schemas/my-schema/fields/1/enable' } + } + }; - it('should make put request to enable nested field', - inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { + let schema: SchemaDetailsDto; - schemasService.enableField('my-app', 'my-schema', 1, 13, version).subscribe(); + schemasService.enableField('my-app', resource, version).subscribe(result => { + schema = result; + }); - const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/13/nested/1/enable'); + const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/1/enable'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toBe(version.value); - req.flush({}); + req.flush(schemaDetailsResponse(12), { + headers: { + etag: '2' + } + }); + + expect(schema!).toEqual(createSchemaDetails(12, versionNew)); })); it('should make put request to disable field', inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { - schemasService.disableField('my-app', 'my-schema', 1, undefined, version).subscribe(); - - const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/1/disable'); - - expect(req.request.method).toEqual('PUT'); - expect(req.request.headers.get('If-Match')).toBe(version.value); - - req.flush({}); - })); + const resource: Resource = { + _links: { + disable: { method: 'PUT', href: '/api/apps/my-app/schemas/my-schema/fields/1/disable' } + } + }; - it('should make put request to disable nested field', - inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { + let schema: SchemaDetailsDto; - schemasService.disableField('my-app', 'my-schema', 1, 13, version).subscribe(); + schemasService.disableField('my-app', resource, version).subscribe(result => { + schema = result; + }); - const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/13/nested/1/disable'); + const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/1/disable'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toBe(version.value); - req.flush({}); + req.flush(schemaDetailsResponse(12), { + headers: { + etag: '2' + } + }); + + expect(schema!).toEqual(createSchemaDetails(12, versionNew)); })); it('should make put request to show field', inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { - schemasService.showField('my-app', 'my-schema', 1, undefined, version).subscribe(); - - const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/1/show'); - - expect(req.request.method).toEqual('PUT'); - expect(req.request.headers.get('If-Match')).toBe(version.value); - - req.flush({}); - })); + const resource: Resource = { + _links: { + show: { method: 'PUT', href: '/api/apps/my-app/schemas/my-schema/fields/1/show' } + } + }; - it('should make put request to show nested field', - inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { + let schema: SchemaDetailsDto; - schemasService.showField('my-app', 'my-schema', 1, 13, version).subscribe(); + schemasService.showField('my-app', resource, version).subscribe(result => { + schema = result; + }); - const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/13/nested/1/show'); + const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/1/show'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toBe(version.value); - req.flush({}); + req.flush(schemaDetailsResponse(12), { + headers: { + etag: '2' + } + }); + + expect(schema!).toEqual(createSchemaDetails(12, versionNew)); })); it('should make put request to hide field', inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { - schemasService.hideField('my-app', 'my-schema', 1, undefined, version).subscribe(); - - const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/1/hide'); - - expect(req.request.method).toEqual('PUT'); - expect(req.request.headers.get('If-Match')).toBe(version.value); - - req.flush({}); - })); + const resource: Resource = { + _links: { + hide: { method: 'PUT', href: '/api/apps/my-app/schemas/my-schema/fields/1/hide' } + } + }; - it('should make put request to hide nested field', - inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { + let schema: SchemaDetailsDto; - schemasService.hideField('my-app', 'my-schema', 1, 13, version).subscribe(); + schemasService.hideField('my-app', resource, version).subscribe(result => { + schema = result; + }); - const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/13/nested/1/hide'); + const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/1/hide'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toBe(version.value); - req.flush({}); + req.flush(schemaDetailsResponse(12), { + headers: { + etag: '2' + } + }); + + expect(schema!).toEqual(createSchemaDetails(12, versionNew)); })); it('should make delete request to delete field', inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { - schemasService.deleteField('my-app', 'my-schema', 1, undefined, version).subscribe(); - - const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/1'); - - expect(req.request.method).toEqual('DELETE'); - expect(req.request.headers.get('If-Match')).toBe(version.value); - - req.flush({}); - })); + const resource: Resource = { + _links: { + delete: { method: 'DELETE', href: '/api/apps/my-app/schemas/my-schema/fields/1' } + } + }; - it('should make delete request to delete nested field', - inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { + let schema: SchemaDetailsDto; - schemasService.deleteField('my-app', 'my-schema', 1, 13, version).subscribe(); + schemasService.deleteField('my-app', resource, version).subscribe(result => { + schema = result; + }); - const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/13/nested/1'); + const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/1'); expect(req.request.method).toEqual('DELETE'); expect(req.request.headers.get('If-Match')).toBe(version.value); - req.flush({}); + req.flush(schemaDetailsResponse(12), { + headers: { + etag: '2' + } + }); + + expect(schema!).toEqual(createSchemaDetails(12, versionNew)); })); it('should make delete request to delete schema', inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { - schemasService.deleteSchema('my-app', 'my-schema', version).subscribe(); + const resource: Resource = { + _links: { + delete: { method: 'DELETE', href: '/api/apps/my-app/schemas/my-schema' } + } + }; + + schemasService.deleteSchema('my-app', resource, version).subscribe(); const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema'); @@ -713,4 +596,250 @@ describe('SchemasService', () => { req.flush({}); })); -}); \ No newline at end of file + + function schemaResponse(id: number, suffix = '') { + return { + id: `schema-id${id}${suffix}`, + name: `schema-name${id}${suffix}`, + category: `category${id}${suffix}`, + isSingleton: id % 2 === 0, + isPublished: id % 3 === 0, + created: `${id % 1000 + 2000}-12-12T10:10:00`, + createdBy: `creator-${id}`, + lastModified: `${id % 1000 + 2000}-11-11T10:10:00`, + lastModifiedBy: `modifier-${id}`, + properties: { + label: `label${id}${suffix}`, + hints: `hints${id}${suffix}` + }, + version: `${id}`, + _links: { + update: { method: 'PUT', href: `/schemas/${id}` } + } + }; + } + + function schemaDetailsResponse(id: number, suffix = '') { + return { + id: `schema-id${id}`, + name: `schema-name${id}${suffix}`, + category: `category${id}${suffix}`, + isSingleton: id % 2 === 0, + isPublished: id % 3 === 0, + created: `${id % 1000 + 2000}-12-12T10:10:00`, + createdBy: `creator-${id}`, + lastModified: `${id % 1000 + 2000}-11-11T10:10:00`, + lastModifiedBy: `modifier-${id}`, + properties: { + label: `label${id}${suffix}`, + hints: `hints${id}${suffix}` + }, + previewUrls: { + 'Default': 'url' + }, + fields: [ + { + fieldId: 11, + name: 'field11', + isLocked: true, + isHidden: true, + isDisabled: true, + partitioning: 'language', + properties: { + fieldType: 'Array' + }, + nested: [ + { + fieldId: 101, + name: 'field101', + isLocked: true, + isHidden: true, + isDisabled: true, + properties: { + fieldType: 'String' + } + }, + { + fieldId: 102, + name: 'field102', + isLocked: true, + isHidden: true, + isDisabled: true, + properties: { + fieldType: 'Number' + } + } + ] + }, + { + fieldId: 12, + name: 'field12', + isLocked: true, + isHidden: true, + isDisabled: true, + partitioning: 'language', + properties: { + fieldType: 'Assets' + } + }, + { + fieldId: 13, + name: 'field13', + isLocked: true, + isHidden: true, + isDisabled: true, + partitioning: 'language', + properties: { + fieldType: 'Boolean' + } + }, + { + fieldId: 14, + name: 'field14', + isLocked: true, + isHidden: true, + isDisabled: true, + partitioning: 'language', + properties: { + fieldType: 'DateTime' + } + }, + { + fieldId: 15, + name: 'field15', + isLocked: true, + isHidden: true, + isDisabled: true, + partitioning: 'language', + properties: { + fieldType: 'Geolocation' + } + }, + { + fieldId: 16, + name: 'field16', + isLocked: true, + isHidden: true, + isDisabled: true, + partitioning: 'language', + properties: { + fieldType: 'Json' + } + }, + { + fieldId: 17, + name: 'field17', + isLocked: true, + isHidden: true, + isDisabled: true, + partitioning: 'language', + properties: { + fieldType: 'Number' + } + }, + { + fieldId: 18, + name: 'field18', + isLocked: true, + isHidden: true, + isDisabled: true, + partitioning: 'language', + properties: { + fieldType: 'References' + } + }, + { + fieldId: 19, + name: 'field19', + isLocked: true, + isHidden: true, + isDisabled: true, + partitioning: 'language', + properties: { + fieldType: 'String' + } + }, + { + fieldId: 20, + name: 'field20', + isLocked: true, + isHidden: true, + isDisabled: true, + partitioning: 'language', + properties: { + fieldType: 'Tags' + } + } + ], + scripts: { + query: '', + create: '', + change: '', + delete: '', + update: '' + }, + _links: { + update: { method: 'PUT', href: `/schemas/${id}` } + } + }; + } +}); + +export function createSchema(id: number, suffix = '') { + const result = new SchemaDto( + `schema-id${id}`, + `schema-name${id}${suffix}`, + `category${id}${suffix}`, + new SchemaPropertiesDto(`label${id}${suffix}`, `hints${id}${suffix}`), + id % 2 === 0, + id % 3 === 0, + DateTime.parseISO_UTC(`${id % 1000 + 2000}-12-12T10:10:00`), `creator-${id}`, + DateTime.parseISO_UTC(`${id % 1000 + 2000}-11-11T10:10:00`), `modifier-${id}`, + new Version(`${id}`)); + + result._links['update'] = { method: 'PUT', href: `/schemas/${id}` }; + + return result; +} + +export function createSchemaDetails(id: number, version: Version, suffix = '') { + const result = new SchemaDetailsDto( + `schema-id${id}`, + `schema-name${id}${suffix}`, + `category${id}${suffix}`, + new SchemaPropertiesDto(`label${id}${suffix}`, `hints${id}${suffix}`), + id % 2 === 0, + id % 3 === 0, + DateTime.parseISO_UTC(`${id % 1000 + 2000}-12-12T10:10:00`), `creator-${id}`, + DateTime.parseISO_UTC(`${id % 1000 + 2000}-11-11T10:10:00`), `modifier-${id}`, + version, + [ + new RootFieldDto(11, 'field11', createProperties('Array'), 'language', true, true, true, [ + new NestedFieldDto(101, 'field101', createProperties('String'), 11, true, true, true), + new NestedFieldDto(102, 'field102', createProperties('Number'), 11, true, true, true) + ]), + new RootFieldDto(12, 'field12', createProperties('Assets'), 'language', true, true, true), + new RootFieldDto(13, 'field13', createProperties('Boolean'), 'language', true, true, true), + new RootFieldDto(14, 'field14', createProperties('DateTime'), 'language', true, true, true), + new RootFieldDto(15, 'field15', createProperties('Geolocation'), 'language', true, true, true), + new RootFieldDto(16, 'field16', createProperties('Json'), 'language', true, true, true), + new RootFieldDto(17, 'field17', createProperties('Number'), 'language', true, true, true), + new RootFieldDto(18, 'field18', createProperties('References'), 'language', true, true, true), + new RootFieldDto(19, 'field19', createProperties('String'), 'language', true, true, true), + new RootFieldDto(20, 'field20', createProperties('Tags'), 'language', true, true, true) + ], + { + query: '', + create: '', + change: '', + delete: '', + update: '' + }, + { + 'Default': 'url' + }); + + result._links['update'] = { method: 'PUT', href: `/schemas/${id}` }; + + return result; +} \ No newline at end of file diff --git a/src/Squidex/app/shared/services/schemas.service.ts b/src/Squidex/app/shared/services/schemas.service.ts index dcefef6bc..4b40c16db 100644 --- a/src/Squidex/app/shared/services/schemas.service.ts +++ b/src/Squidex/app/shared/services/schemas.service.ts @@ -15,17 +15,22 @@ import { ApiUrlConfig, DateTime, HTTP, - mapVersioned, - Model, pretifyError, + Resource, + ResourceLinks, StringHelper, Version, - Versioned + Versioned, + withLinks } from '@app/framework'; import { createProperties, FieldPropertiesDto } from './schemas.types'; -export class SchemaDto extends Model { +export type SchemasDto = { items: SchemaDto[] } & Resource; + +export class SchemaDto { + public readonly _links: ResourceLinks = {}; + public get displayName() { return StringHelper.firstNonEmpty(this.properties.label, this.name); } @@ -43,7 +48,6 @@ export class SchemaDto extends Model { public readonly lastModifiedBy: string, public readonly version: Version ) { - super(); } } @@ -66,32 +70,26 @@ export class SchemaDetailsDto extends SchemaDto { ) { super(id, name, category, properties, isSingleton, isPublished, created, createdBy, lastModified, lastModifiedBy, version); - this.onCloned(); - } + if (fields) { + let listFields = this.fields.filter(x => x.properties.isListField && x.properties.isContentField); - protected onCloned() { - if (this.fields) { - let fields = this.fields.filter(x => x.properties.isListField && x.properties.isContentField); - - if (fields.length === 0 && this.fields.length > 0) { - fields = [this.fields[0]]; + if (listFields.length === 0 && this.fields.length > 0) { + listFields = [this.fields[0]]; } - if (fields.length === 0) { - fields = NONE_FIELDS; + if (listFields.length === 0) { + listFields = NONE_FIELDS; } - this.listFields = fields; - this.listFieldsEditable = fields.filter(x => x.isInlineEditable); + this.listFields = listFields; + this.listFieldsEditable = listFields.filter(x => x.isInlineEditable); } } - - public with(value: Partial): SchemaDetailsDto { - return this.clone(value); - } } -export class FieldDto extends Model { +export class FieldDto { + public readonly _links: ResourceLinks = {}; + public get isInlineEditable(): boolean { return !this.isDisabled && this.properties['inlineEditable'] === true; } @@ -112,7 +110,6 @@ export class FieldDto extends Model { public readonly isHidden: boolean = false, public readonly isDisabled: boolean = false ) { - super(); } } @@ -142,10 +139,6 @@ export class RootFieldDto extends FieldDto { ) { super(fieldId, name, properties, isLocked, isHidden, isDisabled); } - - public with(value: Partial): RootFieldDto { - return this.clone(value); - } } const NONE_FIELD = new RootFieldDto(-1, '', createProperties('String'), 'invariant'); @@ -160,10 +153,6 @@ export class NestedFieldDto extends FieldDto { ) { super(fieldId, name, properties, isLocked, isHidden, isDisabled); } - - public with(value: Partial): NestedFieldDto { - return this.clone(value); - } } export class SchemaPropertiesDto { @@ -187,10 +176,6 @@ export interface CreateSchemaDto { readonly isSingleton?: boolean; } -export interface SchemaCreatedDto { - readonly id: string; -} - export interface UpdateSchemaCategoryDto { readonly name?: string; } @@ -213,192 +198,155 @@ export class SchemasService { ) { } - public getSchemas(appName: string): Observable { + public getSchemas(appName: string): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/schemas`); return HTTP.getVersioned(this.http, url).pipe( map(({ payload }) => { const body = payload.body; - const items: any[] = body; - - const schemas = items.map(item => { - const properties = new SchemaPropertiesDto(item.properties.label, item.properties.hints); - - return new SchemaDto( - item.id, - item.name, - item.category, properties, - item.isSingleton, - item.isPublished, - DateTime.parseISO_UTC(item.created), item.createdBy, - DateTime.parseISO_UTC(item.lastModified), item.lastModifiedBy, - new Version(item.version.toString())); - }); - - return schemas; + const items: any[] = body.items; + + const schemas = items.map(item => + withLinks( + new SchemaDto( + item.id, + item.name, + item.category, + new SchemaPropertiesDto(item.properties.label, item.properties.hints), + item.isSingleton, + item.isPublished, + DateTime.parseISO_UTC(item.created), item.createdBy, + DateTime.parseISO_UTC(item.lastModified), item.lastModifiedBy, + new Version(item.version.toString())), + item)); + + return withLinks({ items: schemas, _links: {} }, body); }), pretifyError('Failed to load schemas. Please reload.')); } - public getSchema(appName: string, id: string): Observable { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/schemas/${id}`); + public getSchema(appName: string, name: string): Observable { + const url = this.apiUrl.buildUrl(`api/apps/${appName}/schemas/${name}`); return HTTP.getVersioned(this.http, url).pipe( map(({ version, payload }) => { - const body = payload.body; - - const fields = body.fields.map((item: any) => { - const propertiesDto = - createProperties( - item.properties.fieldType, - item.properties); - - let nested: NestedFieldDto[] | null = null; - - if (item.nested && item.nested.length > 0) { - nested = item.nested.map((nestedItem: any) => { - const nestedPropertiesDto = - createProperties( - nestedItem.properties.fieldType, - nestedItem.properties); - - return new NestedFieldDto( - nestedItem.fieldId, - nestedItem.name, - nestedPropertiesDto, - item.fieldId, - nestedItem.isLocked, - nestedItem.isHidden, - nestedItem.isDisabled); - }); - } - - return new RootFieldDto( - item.fieldId, - item.name, - propertiesDto, - item.partitioning, - item.isLocked, - item.isHidden, - item.isDisabled, - nested || []); - }); - - const properties = new SchemaPropertiesDto(body.properties.label, body.properties.hints); - - return new SchemaDetailsDto( - body.id, - body.name, - body.category, - properties, - body.isSingleton, - body.isPublished, - DateTime.parseISO_UTC(body.created), body.createdBy, - DateTime.parseISO_UTC(body.lastModified), body.lastModifiedBy, - version, - fields, - body.scripts || {}, - body.previewUrls || {}); + return parseSchemaWithDetails(payload.body, version); }), pretifyError('Failed to load schema. Please reload.')); } - public postSchema(appName: string, dto: CreateSchemaDto): Observable> { + public postSchema(appName: string, dto: CreateSchemaDto): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/schemas`); return HTTP.postVersioned(this.http, url, dto).pipe( - mapVersioned(({ body }) => body!), + map(({ version, payload }) => { + return parseSchemaWithDetails(payload.body, version); + }), tap(() => { this.analytics.trackEvent('Schema', 'Created', appName); }), pretifyError('Failed to create schema. Please reload.')); } - public deleteSchema(appName: string, schemaName: string, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/schemas/${schemaName}`); + public putScripts(appName: string, resource: Resource, dto: {}, version: Version): Observable { + const link = resource._links['updateScripts']; - return HTTP.deleteVersioned(this.http, url, version).pipe( - tap(() => { - this.analytics.trackEvent('Schema', 'Deleted', appName); - }), - pretifyError('Failed to delete schema. Please reload.')); - } + const url = this.apiUrl.buildUrl(link.href); - public putScripts(appName: string, schemaName: string, dto: {}, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/schemas/${schemaName}/scripts`); - - return HTTP.putVersioned(this.http, url, dto, version).pipe( + return HTTP.requestVersioned(this.http, link.method, url, version, dto).pipe( + map(({ version: newVersion, payload }) => { + return parseSchemaWithDetails(payload.body, newVersion); + }), tap(() => { this.analytics.trackEvent('Schema', 'ScriptsConfigured', appName); }), pretifyError('Failed to update schema scripts. Please reload.')); } - public putSchema(appName: string, schemaName: string, dto: UpdateSchemaDto, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/schemas/${schemaName}`); + public putSchema(appName: string, resource: Resource, dto: UpdateSchemaDto, version: Version): Observable { + const link = resource._links['update']; + + const url = this.apiUrl.buildUrl(link.href); - return HTTP.putVersioned(this.http, url, dto, version).pipe( + return HTTP.requestVersioned(this.http, link.method, url, version, dto).pipe( + map(({ version: newVersion, payload }) => { + return parseSchemaWithDetails(payload.body, newVersion); + }), tap(() => { this.analytics.trackEvent('Schema', 'Updated', appName); }), pretifyError('Failed to update schema. Please reload.')); } - public publishSchema(appName: string, schemaName: string, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/schemas/${schemaName}/publish`); + public putCategory(appName: string, resource: Resource, dto: UpdateSchemaCategoryDto, version: Version): Observable { + const link = resource._links['updateCategory']; + + const url = this.apiUrl.buildUrl(link.href); - return HTTP.putVersioned(this.http, url, {}, version).pipe( + return HTTP.requestVersioned(this.http, link.method, url, version, dto).pipe( + map(({ version: newVersion, payload }) => { + return parseSchemaWithDetails(payload.body, newVersion); + }), tap(() => { - this.analytics.trackEvent('Schema', 'Published', appName); + this.analytics.trackEvent('Schema', 'CategoryChanged', appName); }), - pretifyError('Failed to publish schema. Please reload.')); + pretifyError('Failed to change category. Please reload.')); } - public unpublishSchema(appName: string, schemaName: string, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/schemas/${schemaName}/unpublish`); + public putPreviewUrls(appName: string, resource: Resource, dto: {}, version: Version): Observable { + const link = resource._links['updateUrls']; - return HTTP.putVersioned(this.http, url, {}, version).pipe( + const url = this.apiUrl.buildUrl(link.href); + + return HTTP.requestVersioned(this.http, link.method, url, version, dto).pipe( + map(({ version: newVersion, payload }) => { + return parseSchemaWithDetails(payload.body, newVersion); + }), tap(() => { - this.analytics.trackEvent('Schema', 'Unpublished', appName); + this.analytics.trackEvent('Schema', 'PreviewUrlsConfigured', appName); }), - pretifyError('Failed to unpublish schema. Please reload.')); + pretifyError('Failed to configure preview urls. Please reload.')); } - public putCategory(appName: string, schemaName: string, dto: UpdateSchemaCategoryDto, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/schemas/${schemaName}/category`); + public publishSchema(appName: string, resource: Resource, version: Version): Observable { + const link = resource._links['publish']; + + const url = this.apiUrl.buildUrl(link.href); - return HTTP.putVersioned(this.http, url, dto, version).pipe( + return HTTP.requestVersioned(this.http, link.method, url, version, {}).pipe( + map(({ version: newVersion, payload }) => { + return parseSchemaWithDetails(payload.body, newVersion); + }), tap(() => { - this.analytics.trackEvent('Schema', 'CategoryChanged', appName); + this.analytics.trackEvent('Schema', 'Published', appName); }), - pretifyError('Failed to change category. Please reload.')); + pretifyError('Failed to publish schema. Please reload.')); } - public putPreviewUrls(appName: string, schemaName: string, dto: {}, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/schemas/${schemaName}/preview-urls`); + public unpublishSchema(appName: string, resource: Resource, version: Version): Observable { + const link = resource._links['unpublish']; + + const url = this.apiUrl.buildUrl(link.href); - return HTTP.putVersioned(this.http, url, dto, version).pipe( + return HTTP.requestVersioned(this.http, link.method, url, version, {}).pipe( + map(({ version: newVersion, payload }) => { + return parseSchemaWithDetails(payload.body, newVersion); + }), tap(() => { - this.analytics.trackEvent('Schema', 'PreviewUrlsConfigured', appName); + this.analytics.trackEvent('Schema', 'Unpublished', appName); }), - pretifyError('Failed to configure preview urls. Please reload.')); + pretifyError('Failed to unpublish schema. Please reload.')); } - public postField(appName: string, schemaName: string, dto: AddFieldDto, parentId: number | undefined, version: Version): Observable> { - const url = this.buildUrl(appName, schemaName, parentId, ''); + public postField(appName: string, resource: Resource, dto: AddFieldDto, version: Version): Observable { + const link = resource._links['addField']; - return HTTP.postVersioned(this.http, url, dto, version).pipe( - mapVersioned(({ body }) => { - if (parentId) { - const field = new NestedFieldDto(body.id, dto.name, dto.properties, parentId); + const url = this.apiUrl.buildUrl(link.href); - return field; - } else { - const field = new RootFieldDto(body.id, dto.name, dto.properties, dto.partitioning); - - return field; - } + return HTTP.requestVersioned(this.http, link.method, url, version, dto).pipe( + map(({ version: newVersion, payload }) => { + return parseSchemaWithDetails(payload.body, newVersion); }), tap(() => { this.analytics.trackEvent('Schema', 'FieldCreated', appName); @@ -406,92 +354,192 @@ export class SchemasService { pretifyError('Failed to add field. Please reload.')); } - public putFieldOrdering(appName: string, schemaName: string, dto: number[], parentId: number | undefined, version: Version): Observable> { - const url = this.buildUrl(appName, schemaName, parentId, '/ordering'); + public putFieldOrdering(appName: string, resource: Resource, dto: number[], version: Version): Observable { + const link = resource._links['order']; + + const url = this.apiUrl.buildUrl(link.href); - return HTTP.putVersioned(this.http, url, { fieldIds: dto }, version).pipe( + return HTTP.requestVersioned(this.http, link.method, url, version, dto).pipe( + map(({ version: newVersion, payload }) => { + return parseSchemaWithDetails(payload.body, newVersion); + }), tap(() => { this.analytics.trackEvent('Schema', 'FieldsReordered', appName); }), pretifyError('Failed to reorder fields. Please reload.')); } - public putField(appName: string, schemaName: string, fieldId: number, dto: UpdateFieldDto, parentId: number | undefined, version: Version): Observable> { - const url = this.buildUrl(appName, schemaName, parentId, `/${fieldId}`); + public putField(appName: string, resource: Resource, dto: UpdateFieldDto, version: Version): Observable { + const link = resource._links['update']; + + const url = this.apiUrl.buildUrl(link.href); - return HTTP.putVersioned(this.http, url, dto, version).pipe( + return HTTP.requestVersioned(this.http, link.method, url, version, dto).pipe( + map(({ version: newVersion, payload }) => { + return parseSchemaWithDetails(payload.body, newVersion); + }), tap(() => { this.analytics.trackEvent('Schema', 'FieldUpdated', appName); }), pretifyError('Failed to update field. Please reload.')); } - public lockField(appName: string, schemaName: string, fieldId: number, parentId: number | undefined, version: Version): Observable> { - const url = this.buildUrl(appName, schemaName, parentId, `/${fieldId}/lock`); + public lockField(appName: string, resource: Resource, version: Version): Observable { + const link = resource._links['lock']; - return HTTP.putVersioned(this.http, url, {}, version).pipe( + const url = this.apiUrl.buildUrl(link.href); + + return HTTP.requestVersioned(this.http, link.method, url, version, {}).pipe( + map(({ version: newVersion, payload }) => { + return parseSchemaWithDetails(payload.body, newVersion); + }), tap(() => { this.analytics.trackEvent('Schema', 'FieldLocked', appName); }), pretifyError('Failed to lock field. Please reload.')); } - public enableField(appName: string, schemaName: string, fieldId: number, parentId: number | undefined, version: Version): Observable> { - const url = this.buildUrl(appName, schemaName, parentId, `/${fieldId}/enable`); + public enableField(appName: string, resource: Resource, version: Version): Observable { + const link = resource._links['enable']; - return HTTP.putVersioned(this.http, url, {}, version).pipe( + const url = this.apiUrl.buildUrl(link.href); + + return HTTP.requestVersioned(this.http, link.method, url, version, {}).pipe( + map(({ version: newVersion, payload }) => { + return parseSchemaWithDetails(payload.body, newVersion); + }), tap(() => { this.analytics.trackEvent('Schema', 'FieldEnabled', appName); }), pretifyError('Failed to enable field. Please reload.')); } - public disableField(appName: string, schemaName: string, fieldId: number, parentId: number | undefined, version: Version): Observable> { - const url = this.buildUrl(appName, schemaName, parentId, `/${fieldId}/disable`); + public disableField(appName: string, resource: Resource, version: Version): Observable { + const link = resource._links['disable']; + + const url = this.apiUrl.buildUrl(link.href); - return HTTP.putVersioned(this.http, url, {}, version).pipe( + return HTTP.requestVersioned(this.http, link.method, url, version, {}).pipe( + map(({ version: newVersion, payload }) => { + return parseSchemaWithDetails(payload.body, newVersion); + }), tap(() => { this.analytics.trackEvent('Schema', 'FieldDisabled', appName); }), pretifyError('Failed to disable field. Please reload.')); } - public showField(appName: string, schemaName: string, fieldId: number, parentId: number | undefined, version: Version): Observable> { - const url = this.buildUrl(appName, schemaName, parentId, `/${fieldId}/show`); + public showField(appName: string, resource: Resource, version: Version): Observable { + const link = resource._links['show']; + + const url = this.apiUrl.buildUrl(link.href); - return HTTP.putVersioned(this.http, url, {}, version).pipe( + return HTTP.requestVersioned(this.http, link.method, url, version, {}).pipe( + map(({ version: newVersion, payload }) => { + return parseSchemaWithDetails(payload.body, newVersion); + }), tap(() => { this.analytics.trackEvent('Schema', 'FieldShown', appName); }), pretifyError('Failed to show field. Please reload.')); } - public hideField(appName: string, schemaName: string, fieldId: number, parentId: number | undefined, version: Version): Observable> { - const url = this.buildUrl(appName, schemaName, parentId, `/${fieldId}/hide`); + public hideField(appName: string, resource: Resource, version: Version): Observable { + const link = resource._links['hide']; + + const url = this.apiUrl.buildUrl(link.href); - return HTTP.putVersioned(this.http, url, {}, version).pipe( + return HTTP.requestVersioned(this.http, link.method, url, version, {}).pipe( + map(({ version: newVersion, payload }) => { + return parseSchemaWithDetails(payload.body, newVersion); + }), tap(() => { this.analytics.trackEvent('Schema', 'FieldHidden', appName); }), pretifyError('Failed to hide field. Please reload.')); } - public deleteField(appName: string, schemaName: string, fieldId: number, parentId: number | undefined, version: Version): Observable> { - const url = this.buildUrl(appName, schemaName, parentId, `/${fieldId}`); + public deleteField(appName: string, resource: Resource, version: Version): Observable { + const link = resource._links['delete']; - return HTTP.deleteVersioned(this.http, url, version).pipe( + const url = this.apiUrl.buildUrl(link.href); + + return HTTP.requestVersioned(this.http, link.method, url, version, {}).pipe( + map(({ version: newVersion, payload }) => { + return parseSchemaWithDetails(payload.body, newVersion); + }), tap(() => { this.analytics.trackEvent('Schema', 'FieldDeleted', appName); }), pretifyError('Failed to delete field. Please reload.')); } - private buildUrl(appName: string, schemaName: string, parentId: number | undefined, suffix: string) { - const url = - parentId ? - this.apiUrl.buildUrl(`api/apps/${appName}/schemas/${schemaName}/fields/${parentId}/nested${suffix}`) : - this.apiUrl.buildUrl(`api/apps/${appName}/schemas/${schemaName}/fields${suffix}`); + public deleteSchema(appName: string, resource: Resource, version: Version): Observable> { + const link = resource._links['delete']; - return url; + const url = this.apiUrl.buildUrl(link.href); + + return HTTP.requestVersioned(this.http, link.method, url, version).pipe( + tap(() => { + this.analytics.trackEvent('Schema', 'Deleted', appName); + }), + pretifyError('Failed to delete schema. Please reload.')); } +} + +function parseSchemaWithDetails(response: any, version: Version) { + const fields = response.fields.map((item: any) => { + const propertiesDto = + createProperties( + item.properties.fieldType, + item.properties); + + let nested: NestedFieldDto[] | null = null; + + if (item.nested && item.nested.length > 0) { + nested = item.nested.map((nestedItem: any) => { + const nestedPropertiesDto = + createProperties( + nestedItem.properties.fieldType, + nestedItem.properties); + + return new NestedFieldDto( + nestedItem.fieldId, + nestedItem.name, + nestedPropertiesDto, + item.fieldId, + nestedItem.isLocked, + nestedItem.isHidden, + nestedItem.isDisabled); + }); + } + + return new RootFieldDto( + item.fieldId, + item.name, + propertiesDto, + item.partitioning, + item.isLocked, + item.isHidden, + item.isDisabled, + nested || []); + }); + + const properties = new SchemaPropertiesDto(response.properties.label, response.properties.hints); + + return withLinks( + new SchemaDetailsDto( + response.id, + response.name, + response.category, + properties, + response.isSingleton, + response.isPublished, + DateTime.parseISO_UTC(response.created), response.createdBy, + DateTime.parseISO_UTC(response.lastModified), response.lastModifiedBy, + version, + fields, + response.scripts || {}, + response.previewUrls || {}), + response); } \ No newline at end of file diff --git a/src/Squidex/app/shared/state/schemas.state.spec.ts b/src/Squidex/app/shared/state/schemas.state.spec.ts index 5b084eab0..61cbcc3d1 100644 --- a/src/Squidex/app/shared/state/schemas.state.spec.ts +++ b/src/Squidex/app/shared/state/schemas.state.spec.ts @@ -5,56 +5,44 @@ * Copyright (c) Squidex UG (haftungsbeschränkt). All rights reserved. */ + import { of, throwError } from 'rxjs'; import { IMock, It, Mock, Times } from 'typemoq'; import { SchemasState } from './schemas.state'; import { - createProperties, DialogService, - NestedFieldDto, - RootFieldDto, SchemaDetailsDto, - SchemaDto, - SchemaPropertiesDto, SchemasService, UpdateSchemaCategoryDto, versioned } from '@app/shared/internal'; +import { createSchema, createSchemaDetails } from '../services/schemas.service.spec'; + import { TestValues } from './_test-helpers'; describe('SchemasState', () => { const { app, appsState, - authService, - creation, - creator, - modified, - modifier, newVersion, version } = TestValues; - const oldSchemas = [ - new SchemaDto('id1', 'name1', 'category1', {}, false, false, creation, creator, creation, creator, version), - new SchemaDto('id2', 'name2', 'category2', {}, false, true , creation, creator, creation, creator, version) - ]; + const schema1 = createSchema(1); + const schema2 = createSchema(2); - const nested1 = new NestedFieldDto(3, '3', createProperties('Number'), 2); - const nested2 = new NestedFieldDto(4, '4', createProperties('String'), 2, true, true); + const oldSchemas = { + items: [ + schema1, + schema2 + ], + _links: {} + }; - const field1 = new RootFieldDto(1, '1', createProperties('String'), 'invariant'); - const field2 = new RootFieldDto(2, '2', createProperties('Array'), 'invariant', true, true, true, [nested1, nested2]); - - const schema = - new SchemaDetailsDto('id2', 'name2', 'category2', {}, false, true, - creation, creator, - creation, creator, - version, - [field1, field2]); + const schema = createSchemaDetails(1, version); let dialogs: IMock; let schemasService: IMock; @@ -64,7 +52,7 @@ describe('SchemasState', () => { dialogs = Mock.ofType(); schemasService = Mock.ofType(); - schemasState = new SchemasState(appsState.object, authService.object, dialogs.object, schemasService.object); + schemasState = new SchemasState(appsState.object, dialogs.object, schemasService.object); }); afterEach(() => { @@ -78,7 +66,7 @@ describe('SchemasState', () => { schemasState.load().subscribe(); - expect(schemasState.snapshot.schemas.values).toEqual(oldSchemas); + expect(schemasState.snapshot.schemas.values).toEqual(oldSchemas.items); expect(schemasState.snapshot.isLoaded).toBeTruthy(); expect(schemasState.snapshot.categories).toEqual({ 'category1': false, 'category2': false, '': true }); @@ -92,7 +80,7 @@ describe('SchemasState', () => { schemasState.addCategory('category3'); schemasState.load(true).subscribe(); - expect(schemasState.snapshot.schemas.values).toEqual(oldSchemas); + expect(schemasState.snapshot.schemas.values).toEqual(oldSchemas.items); expect(schemasState.snapshot.isLoaded).toBeTruthy(); expect(schemasState.snapshot.categories).toEqual({ 'category1': false, 'category2': false, 'category3': true, '': true }); @@ -132,28 +120,28 @@ describe('SchemasState', () => { }); it('should return schema on select and reload when already loaded', () => { - schemasService.setup(x => x.getSchema(app, schema.name)) + schemasService.setup(x => x.getSchema(app, schema1.name)) .returns(() => of(schema)).verifiable(Times.exactly(2)); - schemasState.select('name2').subscribe(); - schemasState.select('name2').subscribe(); + schemasState.select(schema1.name).subscribe(); + schemasState.select(schema1.name).subscribe(); expect().nothing(); }); it('should return schema on select and load when not loaded', () => { - schemasService.setup(x => x.getSchema(app, schema.name)) + schemasService.setup(x => x.getSchema(app, schema1.name)) .returns(() => of(schema)).verifiable(); let selectedSchema: SchemaDetailsDto; - schemasState.select('name2').subscribe(x => { + schemasState.select(schema1.name).subscribe(x => { selectedSchema = x!; }); expect(selectedSchema!).toBe(schema); expect(schemasState.snapshot.selectedSchema).toBe(schema); - expect(schemasState.snapshot.selectedSchema).toBe(schemasState.snapshot.schemas.at(1)); + expect(schemasState.snapshot.selectedSchema).toBe(schemasState.snapshot.schemas.at(0)); }); it('should return null on select when loading failed', () => { @@ -181,378 +169,316 @@ describe('SchemasState', () => { expect(schemasState.snapshot.selectedSchema).toBeNull(); }); - it('should mark published and update user info when published', () => { - schemasService.setup(x => x.publishSchema(app, oldSchemas[0].name, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + it('should update schema when schema published', () => { + const updated = createSchemaDetails(1, newVersion, '-new'); + + schemasService.setup(x => x.publishSchema(app, schema1, version)) + .returns(() => of(updated)).verifiable(); - schemasState.publish(oldSchemas[0], modified).subscribe(); + schemasState.publish(schema1).subscribe(); - const schema_1 = schemasState.snapshot.schemas.at(0); + const schema1New = schemasState.snapshot.schemas.at(0); - expect(schema_1.isPublished).toBeTruthy(); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); }); - it('should unmark published and update user info when unpublished', () => { - schemasService.setup(x => x.unpublishSchema(app, oldSchemas[1].name, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + it('should update schema when schema unpublished', () => { + const updated = createSchemaDetails(1, newVersion, '-new'); - schemasState.unpublish(oldSchemas[1], modified).subscribe(); + schemasService.setup(x => x.unpublishSchema(app, schema1, version)) + .returns(() => of(updated)).verifiable(); - const schema_1 = schemasState.snapshot.schemas.at(1); + schemasState.unpublish(schema1).subscribe(); - expect(schema_1.isPublished).toBeFalsy(); - expectToBeModified(schema_1); + const schema1New = schemasState.snapshot.schemas.at(0); + + expect(schema1New).toEqual(updated); }); - it('should change category and update user info when category changed', () => { + it('should update schema when schema category changed', () => { const category = 'my-new-category'; - schemasService.setup(x => x.putCategory(app, oldSchemas[0].name, It.is(i => i.name === category), version)) - .returns(() => of(versioned(newVersion))).verifiable(); + const updated = createSchemaDetails(1, newVersion, '-new'); + + schemasService.setup(x => x.putCategory(app, schema1, It.is(i => i.name === category), version)) + .returns(() => of(updated)).verifiable(); - schemasState.changeCategory(oldSchemas[0], category, modified).subscribe(); + schemasState.changeCategory(schema1, category).subscribe(); - const schema_1 = schemasState.snapshot.schemas.at(0); + const schema1New = schemasState.snapshot.schemas.at(0); - expect(schema_1.category).toEqual(category); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); }); describe('with selection', () => { beforeEach(() => { - schemasService.setup(x => x.getSchema(app, schema.name)) + schemasService.setup(x => x.getSchema(app, schema1.name)) .returns(() => of(schema)).verifiable(); - schemasState.select(schema.name).subscribe(); + schemasState.select(schema1.name).subscribe(); }); - it('should nmark published and update user info when published selected schema', () => { - schemasService.setup(x => x.publishSchema(app, schema.name, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + it('should update schema and selected schema when schema published', () => { + const updated = createSchemaDetails(1, newVersion, '-new'); + + schemasService.setup(x => x.publishSchema(app, schema1, version)) + .returns(() => of(updated)).verifiable(); - schemasState.publish(schema, modified).subscribe(); + schemasState.publish(schema1).subscribe(); - const schema_1 = schemasState.snapshot.schemas.at(1); + const schema1New = schemasState.snapshot.schemas.at(0); - expect(schema_1.isPublished).toBeTruthy(); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); }); - it('should change category and update user info when category of selected schema changed', () => { + it('should update schema and selected schema when schema category changed', () => { const category = 'my-new-category'; - schemasService.setup(x => x.putCategory(app, oldSchemas[0].name, It.is(i => i.name === category), version)) - .returns(() => of(versioned(newVersion))).verifiable(); + const updated = createSchemaDetails(1, newVersion, '-new'); + + schemasService.setup(x => x.putCategory(app, schema1, It.is(i => i.name === category), version)) + .returns(() => of(updated)).verifiable(); - schemasState.changeCategory(oldSchemas[0], category, modified).subscribe(); + schemasState.changeCategory(schema1, category).subscribe(); - const schema_1 = schemasState.snapshot.schemas.at(0); + const schema1New = schemasState.snapshot.schemas.at(0); - expect(schema_1.category).toEqual(category); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); }); - it('should update properties and update user info when updated', () => { + it('should update schema and selected schema when schema updated', () => { const request = { label: 'name2_label', hints: 'name2_hints' }; - schemasService.setup(x => x.putSchema(app, schema.name, It.isAny(), version)) - .returns(() => of(versioned(newVersion))).verifiable(); + const updated = createSchemaDetails(1, newVersion, '-new'); + + schemasService.setup(x => x.putSchema(app, schema1, It.isAny(), version)) + .returns(() => of(updated)).verifiable(); - schemasState.update(schema, request, modified).subscribe(); + schemasState.update(schema1, request).subscribe(); - const schema_1 = schemasState.snapshot.schemas.at(1); + const schema1New = schemasState.snapshot.schemas.at(0); - expect(schema_1.properties.label).toEqual(request.label); - expect(schema_1.properties.hints).toEqual(request.hints); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); }); - it('should update script properties and update user info when scripts configured', () => { + it('should update schema and selected schema when scripts configured', () => { const request = { query: '' }; - schemasService.setup(x => x.putScripts(app, schema.name, It.isAny(), version)) - .returns(() => of(versioned(newVersion))).verifiable(); + const updated = createSchemaDetails(1, newVersion, '-new'); + + schemasService.setup(x => x.putScripts(app, schema1, It.isAny(), version)) + .returns(() => of(updated)).verifiable(); - schemasState.configureScripts(schema, request, modified).subscribe(); + schemasState.configureScripts(schema1, request).subscribe(); - const schema_1 = schemasState.snapshot.schemas.at(1); + const schema1New = schemasState.snapshot.schemas.at(0); - expect(schema_1.scripts['query']).toEqual(''); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); }); - it('should update script properties and update user info when preview urls configured', () => { + it('should update schema and selected schema when preview urls configured', () => { const request = { web: 'url' }; - schemasService.setup(x => x.putPreviewUrls(app, schema.name, It.isAny(), version)) - .returns(() => of(versioned(newVersion))).verifiable(); + const updated = createSchemaDetails(1, newVersion, '-new'); + + schemasService.setup(x => x.putPreviewUrls(app, schema1, It.isAny(), version)) + .returns(() => of(updated)).verifiable(); - schemasState.configurePreviewUrls(schema, request, modified).subscribe(); + schemasState.configurePreviewUrls(schema1, request).subscribe(); - const schema_1 = schemasState.snapshot.schemas.at(1); + const schema1New = schemasState.snapshot.schemas.at(0); - expect(schema_1.previewUrls).toEqual(request); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); }); it('should add schema to snapshot when created', () => { const request = { name: 'newName' }; - const result = new SchemaDetailsDto('id4', 'newName', '', new SchemaPropertiesDto(), false, false, modified, modifier, modified, modifier, version); + const updated = createSchemaDetails(3, newVersion, '-new'); schemasService.setup(x => x.postSchema(app, request)) - .returns(() => of(versioned(version, { id: 'id4' }))).verifiable(); + .returns(() => of(updated)).verifiable(); - schemasState.create(request, modified).subscribe(); + schemasState.create(request).subscribe(); expect(schemasState.snapshot.schemas.values.length).toBe(3); - expect(schemasState.snapshot.schemas.at(2)).toEqual(result); + expect(schemasState.snapshot.schemas.at(2)).toEqual(updated); }); it('should remove schema from snapshot when deleted', () => { - schemasService.setup(x => x.deleteSchema(app, schema.name, version)) + schemasService.setup(x => x.deleteSchema(app, schema1, version)) .returns(() => of(versioned(newVersion))).verifiable(); - schemasState.delete(schema).subscribe(); + schemasState.delete(schema1).subscribe(); expect(schemasState.snapshot.schemas.values.length).toBe(1); expect(schemasState.snapshot.selectedSchema).toBeNull(); }); - it('should add field and update user info when field added', () => { - const request = { ...field1 }; + it('should update schema and selected schema when field added', () => { + const request = { ...schema.fields[0] }; - const newField = new RootFieldDto(3, '3', createProperties('String'), 'invariant'); + const updated = createSchemaDetails(1, newVersion, '-new'); - schemasService.setup(x => x.postField(app, schema.name, It.isAny(), undefined, version)) - .returns(() => of(versioned(newVersion, newField))).verifiable(); + schemasService.setup(x => x.postField(app, schema1, It.isAny(), version)) + .returns(() => of(updated)).verifiable(); - schemasState.addField(schema, request, undefined, modified).subscribe(); + schemasState.addField(schema1, request).subscribe(); - const schema_1 = schemasState.snapshot.schemas.at(1); + const schema1New = schemasState.snapshot.schemas.at(0); - expect(schema_1.fields).toEqual([field1, field2, newField]); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); }); - it('should add field and update user info when nested field added', () => { - const request = { ...field1 }; + it('should update schema and selected schema when nested field added', () => { + const request = { ...schema.fields[0] }; - const newField = new NestedFieldDto(3, '3', createProperties('String'), 2); + const updated = createSchemaDetails(1, newVersion, '-new'); - schemasService.setup(x => x.postField(app, schema.name, It.isAny(), 2, version)) - .returns(() => of(versioned(newVersion, newField))).verifiable(); + schemasService.setup(x => x.postField(app, schema.fields[0], It.isAny(), version)) + .returns(() => of(updated)).verifiable(); - schemasState.addField(schema, request, field2, modified).subscribe(); + schemasState.addField(schema1, request, schema.fields[0]).subscribe(); - const schema_1 = schemasState.snapshot.schemas.at(1); + const schema1New = schemasState.snapshot.schemas.at(0); - expect(schema_1.fields[1].nested).toEqual([nested1, nested2, newField]); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); }); - it('should remove field and update user info when field removed', () => { - schemasService.setup(x => x.deleteField(app, schema.name, field1.fieldId, undefined, version)) - .returns(() => of(versioned(newVersion))).verifiable(); - - schemasState.deleteField(schema, field1, modified).subscribe(); - - const schema_1 = schemasState.snapshot.schemas.at(1); - - expect(schema_1.fields).toEqual([field2]); - expectToBeModified(schema_1); - }); + it('should update schema and selected schema when field removed', () => { + const updated = createSchemaDetails(1, newVersion, '-new'); - it('should remove field and update user info when nested field removed', () => { - schemasService.setup(x => x.deleteField(app, schema.name, nested1.fieldId, 2, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + schemasService.setup(x => x.deleteField(app, schema.fields[0], version)) + .returns(() => of(updated)).verifiable(); - schemasState.deleteField(schema, nested1, modified).subscribe(); + schemasState.deleteField(schema1, schema.fields[0]).subscribe(); - const schema_1 = schemasState.snapshot.schemas.at(1); + const schema1New = schemasState.snapshot.schemas.at(0); - expect(schema_1.fields[1].nested).toEqual([nested2]); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); }); - it('should sort fields and update user info when fields sorted', () => { - schemasService.setup(x => x.putFieldOrdering(app, schema.name, [field2.fieldId, field1.fieldId], undefined, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + it('should update schema and selected schema when fields sorted', () => { + const updated = createSchemaDetails(1, newVersion, '-new'); - schemasState.sortFields(schema, [field2, field1], undefined, modified).subscribe(); + schemasService.setup(x => x.putFieldOrdering(app, schema1, [schema.fields[1].fieldId, schema.fields[2].fieldId], version)) + .returns(() => of(updated)).verifiable(); - const schema_1 = schemasState.snapshot.schemas.at(1); + schemasState.sortFields(schema1, [schema.fields[1], schema.fields[2]]).subscribe(); - expect(schema_1.fields).toEqual([field2, field1]); - expectToBeModified(schema_1); - }); + const schema1New = schemasState.snapshot.schemas.at(0); - it('should sort fields and update user info when nested fields sorted', () => { - schemasService.setup(x => x.putFieldOrdering(app, schema.name, [nested2.fieldId, nested1.fieldId], 2, version)) - .returns(() => of(versioned(newVersion))).verifiable(); - - schemasState.sortFields(schema, [nested2, nested1], field2, modified).subscribe(); - - const schema_1 = schemasState.snapshot.schemas.at(1); - - expect(schema_1.fields[1].nested).toEqual([nested2, nested1]); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); }); - it('should update field properties and update user info when field updated', () => { - const request = { properties: createProperties('String') }; + it('should update schema and selected schema when nested fields sorted', () => { + const updated = createSchemaDetails(1, newVersion, '-new'); - schemasService.setup(x => x.putField(app, schema.name, field1.fieldId, request, undefined, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + schemasService.setup(x => x.putFieldOrdering(app, schema.fields[0], [schema.fields[1].fieldId, schema.fields[2].fieldId], version)) + .returns(() => of(updated)).verifiable(); - schemasState.updateField(schema, field1, request, modified).subscribe(); + schemasState.sortFields(schema1, [schema.fields[1], schema.fields[2]], schema.fields[0]).subscribe(); - const schema_1 = schemasState.snapshot.schemas.at(1); + const schema1New = schemasState.snapshot.schemas.at(0); - expect(schema_1.fields[0].properties).toBe(request.properties); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); }); - it('should update field properties and update user info when nested field updated', () => { - const request = { properties: createProperties('String') }; + it('should update schema and selected schema when field updated', () => { + const updated = createSchemaDetails(1, newVersion, '-new'); - schemasService.setup(x => x.putField(app, schema.name, nested1.fieldId, request, 2, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + const request = { ...schema.fields[0] }; - schemasState.updateField(schema, nested1, request, modified).subscribe(); + schemasService.setup(x => x.putField(app, schema.fields[0], request, version)) + .returns(() => of(updated)).verifiable(); - const schema_1 = schemasState.snapshot.schemas.at(1); + schemasState.updateField(schema1, schema.fields[0], request).subscribe(); - expect(schema_1.fields[1].nested[0].properties).toBe(request.properties); - expectToBeModified(schema_1); - }); + const schema1New = schemasState.snapshot.schemas.at(0); - it('should mark field hidden and update user info when field hidden', () => { - schemasService.setup(x => x.hideField(app, schema.name, field1.fieldId, undefined, version)) - .returns(() => of(versioned(newVersion))).verifiable(); - - schemasState.hideField(schema, field1, modified).subscribe(); - - const schema_1 = schemasState.snapshot.schemas.at(1); - - expect(schema_1.fields[0].isHidden).toBeTruthy(); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); }); - it('should mark field hidden and update user info when nested field hidden', () => { - schemasService.setup(x => x.hideField(app, schema.name, nested1.fieldId, 2, version)) - .returns(() => of(versioned(newVersion))).verifiable(); - - schemasState.hideField(schema, nested1, modified).subscribe(); + it('should update schema and selected schema when field hidden', () => { + const updated = createSchemaDetails(1, newVersion, '-new'); - const schema_1 = schemasState.snapshot.schemas.at(1); - - expect(schema_1.fields[1].nested[0].isHidden).toBeTruthy(); - expectToBeModified(schema_1); - }); + schemasService.setup(x => x.hideField(app, schema.fields[0], version)) + .returns(() => of(updated)).verifiable(); - it('should mark field disabled and update user info when field disabled', () => { - schemasService.setup(x => x.disableField(app, schema.name, field1.fieldId, undefined, version)) - .returns(() => of(versioned(newVersion))); + schemasState.hideField(schema1, schema.fields[0]).subscribe(); - schemasState.disableField(schema, field1, modified).subscribe(); + const schema1New = schemasState.snapshot.schemas.at(0); - const schema_1 = schemasState.snapshot.schemas.at(1); - - expect(schema_1.fields[0].isDisabled).toBeTruthy(); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); }); - it('should mark field disabled and update user info when nested disabled', () => { - schemasService.setup(x => x.disableField(app, schema.name, nested1.fieldId, 2, version)) - .returns(() => of(versioned(newVersion))).verifiable(); - - schemasState.disableField(schema, nested1, modified).subscribe(); - - const schema_1 = schemasState.snapshot.schemas.at(1); + it('should update schema and selected schema when field disabled', () => { + const updated = createSchemaDetails(1, newVersion, '-new'); - expect(schema_1.fields[1].nested[0].isDisabled).toBeTruthy(); - expectToBeModified(schema_1); - }); - - it('should mark field locked and update user info when field locked', () => { - schemasService.setup(x => x.lockField(app, schema.name, field1.fieldId, undefined, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + schemasService.setup(x => x.disableField(app, schema.fields[0], version)) + .returns(() => of(updated)); - schemasState.lockField(schema, field1, modified).subscribe(); + schemasState.disableField(schema1, schema.fields[0]).subscribe(); - const schema_1 = schemasState.snapshot.schemas.at(1); + const schema1New = schemasState.snapshot.schemas.at(0); - expect(schema_1.fields[0].isLocked).toBeTruthy(); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); }); - it('should mark field locked and update user info when nested field locked', () => { - schemasService.setup(x => x.lockField(app, schema.name, nested1.fieldId, 2, version)) - .returns(() => of(versioned(newVersion))).verifiable(); - - schemasState.lockField(schema, nested1, modified).subscribe(); - - const schema_1 = schemasState.snapshot.schemas.at(1); - - expect(schema_1.fields[1].nested[0].isLocked).toBeTruthy(); - expectToBeModified(schema_1); - }); + it('should update schema and selected schema when field locked', () => { + const updated = createSchemaDetails(1, newVersion, '-new'); - it('should unmark field hidden and update user info when field shown', () => { - schemasService.setup(x => x.showField(app, schema.name, field2.fieldId, undefined, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + schemasService.setup(x => x.lockField(app, schema.fields[0], version)) + .returns(() => of(updated)).verifiable(); - schemasState.showField(schema, field2, modified).subscribe(); + schemasState.lockField(schema1, schema.fields[0]).subscribe(); - const schema_1 = schemasState.snapshot.schemas.at(1); + const schema1New = schemasState.snapshot.schemas.at(0); - expect(schema_1.fields[1].isHidden).toBeFalsy(); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); }); - it('should unmark field hidden and update user info when nested field shown', () => { - schemasService.setup(x => x.showField(app, schema.name, nested2.fieldId, 2, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + it('should update schema and selected schema when field shown', () => { + const updated = createSchemaDetails(1, newVersion, '-new'); - schemasState.showField(schema, nested2, modified).subscribe(); + schemasService.setup(x => x.showField(app, schema.fields[0], version)) + .returns(() => of(updated)).verifiable(); - const schema_1 = schemasState.snapshot.schemas.at(1); + schemasState.showField(schema1, schema.fields[0]).subscribe(); - expect(schema_1.fields[1].nested[1].isHidden).toBeFalsy(); - expectToBeModified(schema_1); - }); + const schema1New = schemasState.snapshot.schemas.at(0); - it('should unmark field disabled and update user info when field enabled', () => { - schemasService.setup(x => x.enableField(app, schema.name, field2.fieldId, undefined, version)) - .returns(() => of(versioned(newVersion))).verifiable(); - - schemasState.enableField(schema, field2, modified).subscribe(); - - const schema_1 = schemasState.snapshot.schemas.at(1); - - expect(schema_1.fields[1].isDisabled).toBeFalsy(); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); }); - it('should unmark field disabled and update user info when nested field enabled', () => { - schemasService.setup(x => x.enableField(app, schema.name, nested2.fieldId, 2, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + it('should update schema and selected schema when field enabled', () => { + const updated = createSchemaDetails(1, newVersion, '-new'); + + schemasService.setup(x => x.enableField(app, schema.fields[0], version)) + .returns(() => of(updated)).verifiable(); - schemasState.enableField(schema, nested2, modified).subscribe(); + schemasState.enableField(schema1, schema.fields[0]).subscribe(); - const schema_1 = schemasState.snapshot.schemas.at(1); + const schema1New = schemasState.snapshot.schemas.at(0); - expect(schema_1.fields[1].nested[1].isDisabled).toBeFalsy(); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); }); }); - - function expectToBeModified(schema_1: SchemaDto) { - expect(schema_1.lastModified).toEqual(modified); - expect(schema_1.lastModifiedBy).toEqual(modifier); - expect(schema_1.version).toEqual(newVersion); - } }); }); \ No newline at end of file diff --git a/src/Squidex/app/shared/state/schemas.state.ts b/src/Squidex/app/shared/state/schemas.state.ts index bece9616f..49714d64b 100644 --- a/src/Squidex/app/shared/state/schemas.state.ts +++ b/src/Squidex/app/shared/state/schemas.state.ts @@ -10,19 +10,15 @@ import { Observable, of } from 'rxjs'; import { catchError, distinctUntilChanged, map, tap } from 'rxjs/operators'; import { - DateTime, DialogService, ImmutableArray, - mapVersioned, + ResourceLinks, shareMapSubscribed, shareSubscribed, State, - Types, - Version, - Versioned + Types } from '@app/framework'; -import { AuthService } from './../services/auth.service'; import { AppsState } from './apps.state'; import { @@ -31,17 +27,13 @@ import { FieldDto, NestedFieldDto, RootFieldDto, - SchemaCreatedDto, SchemaDetailsDto, SchemaDto, - SchemaPropertiesDto, SchemasService, UpdateFieldDto, UpdateSchemaDto } from './../services/schemas.service'; -import { FieldPropertiesDto } from './../services/schemas.types'; - type AnyFieldDto = NestedFieldDto | RootFieldDto; interface Snapshot { @@ -56,6 +48,9 @@ interface Snapshot { // The selected schema. selectedSchema?: SchemaDetailsDto | null; + + // The links. + links: ResourceLinks; } export type SchemasList = ImmutableArray; @@ -90,13 +85,16 @@ export class SchemasState extends State { this.changes.pipe(map(x => !!x.isLoaded), distinctUntilChanged()); + public links = + this.changes.pipe(map(x => x.links), + distinctUntilChanged()); + constructor( private readonly appsState: AppsState, - private readonly authState: AuthService, private readonly dialogs: DialogService, private readonly schemasService: SchemasService ) { - super({ schemas: ImmutableArray.empty(), categories: buildCategories({}) }); + super({ schemas: ImmutableArray.empty(), categories: buildCategories({}), links: {} }); } public select(idOrName: string | null): Observable { @@ -130,19 +128,18 @@ export class SchemasState extends State { } return this.next(s => { - const schemas = ImmutableArray.of(payload).sortByStringAsc(x => x.displayName); + const schemas = ImmutableArray.of(payload.items).sortByStringAsc(x => x.displayName); const categories = buildCategories(s.categories, schemas); - return { ...s, schemas, isLoaded: true, categories }; + return { ...s, schemas, isLoaded: true, categories, links: payload._links }; }); }), shareSubscribed(this.dialogs)); } - public create(request: CreateSchemaDto, now?: DateTime): Observable { + public create(request: CreateSchemaDto): Observable { return this.schemasService.postSchema(this.appName, request).pipe( - map(payload => createSchema(request, payload, this.user, now)), tap(created => { this.next(s => { const schemas = s.schemas.push(created).sortByStringAsc(x => x.displayName); @@ -154,7 +151,7 @@ export class SchemasState extends State { } public delete(schema: SchemaDto): Observable { - return this.schemasService.deleteSchema(this.appName, schema.name, schema.version).pipe( + return this.schemasService.deleteSchema(this.appName, schema, schema.version).pipe( tap(() => { this.next(s => { const schemas = s.schemas.filter(x => x.id !== schema.id); @@ -182,189 +179,137 @@ export class SchemasState extends State { }); } - public publish(schema: SchemaDto, now?: DateTime): Observable { - return this.schemasService.publishSchema(this.appName, schema.name, schema.version).pipe( - map(({ version }) => setPublished(schema, true, this.user, version, now)), + public publish(schema: SchemaDto): Observable { + return this.schemasService.publishSchema(this.appName, schema, schema.version).pipe( tap(updated => { this.replaceSchema(updated); }), shareSubscribed(this.dialogs)); } - public unpublish(schema: SchemaDto, now?: DateTime): Observable { - return this.schemasService.unpublishSchema(this.appName, schema.name, schema.version).pipe( - map(({ version }) => setPublished(schema, false, this.user, version, now)), + public unpublish(schema: SchemaDto): Observable { + return this.schemasService.unpublishSchema(this.appName, schema, schema.version).pipe( tap(updated => { this.replaceSchema(updated); }), shareSubscribed(this.dialogs)); } - public changeCategory(schema: SchemaDto, name: string, now?: DateTime): Observable { - return this.schemasService.putCategory(this.appName, schema.name, { name }, schema.version).pipe( - map(({ version }) => changeCategory(schema, name, this.user, version, now)), + public changeCategory(schema: SchemaDto, name: string): Observable { + return this.schemasService.putCategory(this.appName, schema, { name }, schema.version).pipe( tap(updated => { this.replaceSchema(updated); }), shareSubscribed(this.dialogs)); } - public configurePreviewUrls(schema: SchemaDetailsDto, request: {}, now?: DateTime): Observable { - return this.schemasService.putPreviewUrls(this.appName, schema.name, request, schema.version).pipe( - map(({ version }) => configurePreviewUrls(schema, request, this.user, version, now)), + public configurePreviewUrls(schema: SchemaDto, request: {}): Observable { + return this.schemasService.putPreviewUrls(this.appName, schema, request, schema.version).pipe( tap(updated => { this.replaceSchema(updated); }), shareSubscribed(this.dialogs)); } - public configureScripts(schema: SchemaDetailsDto, request: {}, now?: DateTime): Observable { - return this.schemasService.putScripts(this.appName, schema.name, request, schema.version).pipe( - map(({ version }) => configureScripts(schema, request, this.user, version, now)), + public configureScripts(schema: SchemaDto, request: {}): Observable { + return this.schemasService.putScripts(this.appName, schema, request, schema.version).pipe( tap(updated => { this.replaceSchema(updated); }), shareSubscribed(this.dialogs)); } - public update(schema: SchemaDetailsDto, request: UpdateSchemaDto, now?: DateTime): Observable { - return this.schemasService.putSchema(this.appName, schema.name, request, schema.version).pipe( - map(({ version }) => updateProperties(schema, request, this.user, version, now)), + public update(schema: SchemaDto, request: UpdateSchemaDto): Observable { + return this.schemasService.putSchema(this.appName, schema, request, schema.version).pipe( tap(updated => { this.replaceSchema(updated); }), shareSubscribed(this.dialogs)); } - public addField(schema: SchemaDetailsDto, request: AddFieldDto, parent?: RootFieldDto, now?: DateTime): Observable { - return this.schemasService.postField(this.appName, schema.name, request, pid(parent), schema.version).pipe( - map(({ version, payload }) => { - let updated: SchemaDto; - - if (Types.is(payload, NestedFieldDto)) { - updated = updateField(schema, addNested(parent!, payload), this.user, version, now); - } else { - updated = addField(schema, payload, this.user, version, now); - } - - return { updated, field: payload }; - }), - tap(({ updated }) => { + public addField(schema: SchemaDto, request: AddFieldDto, parent?: RootFieldDto): Observable { + return this.schemasService.postField(this.appName, parent || schema, request, schema.version).pipe( + tap(updated => { this.replaceSchema(updated); }), - shareMapSubscribed(this.dialogs, x => x.field, { silent: true })); + shareMapSubscribed(this.dialogs, x => getField(x, request, parent), { silent: true })); } - public sortFields(schema: SchemaDetailsDto, fields: any[], parent?: RootFieldDto, now?: DateTime): Observable { - return this.schemasService.putFieldOrdering(this.appName, schema.name, fields.map(t => t.fieldId), pid(parent), schema.version).pipe( - map(({ version }) => { - let updated: SchemaDetailsDto; - - if (!parent) { - updated = replaceFields(schema, fields, this.user, version, now); - } else { - updated = updateField(schema, replaceNested(parent, fields), this.user, version, now); - } - - return updated; - }), + public sortFields(schema: SchemaDto, fields: any[], parent?: RootFieldDto): Observable { + return this.schemasService.putFieldOrdering(this.appName, parent || schema, fields.map(t => t.fieldId), schema.version).pipe( tap(updated => { this.replaceSchema(updated); }), shareSubscribed(this.dialogs)); } - public lockField(schema: SchemaDetailsDto, field: T, now?: DateTime): Observable { - return this.schemasService.lockField(this.appName, schema.name, field.fieldId, pidof(field), schema.version).pipe( - mapVersioned(() => setLocked(field, true)), - tap(({ version, payload }) => { - this.replaceField(schema, payload, version, now); + public lockField(schema: SchemaDto, field: T): Observable { + return this.schemasService.lockField(this.appName, field, schema.version).pipe( + tap(updated => { + this.replaceSchema(updated); }), - shareMapSubscribed(this.dialogs, x => x.payload)); + shareSubscribed(this.dialogs)); } - public enableField(schema: SchemaDetailsDto, field: T, now?: DateTime): Observable { - return this.schemasService.enableField(this.appName, schema.name, field.fieldId, pidof(field), schema.version).pipe( - mapVersioned(() => setDisabled(field, false)), - tap(({ version, payload }) => { - this.replaceField(schema, payload, version, now); + public enableField(schema: SchemaDto, field: T): Observable { + return this.schemasService.enableField(this.appName, field, schema.version).pipe( + tap(updated => { + this.replaceSchema(updated); }), - shareMapSubscribed(this.dialogs, x => x.payload)); + shareSubscribed(this.dialogs)); } - public disableField(schema: SchemaDetailsDto, field: T, now?: DateTime): Observable { - return this.schemasService.disableField(this.appName, schema.name, field.fieldId, pidof(field), schema.version).pipe( - mapVersioned(() => setDisabled(field, true)), - tap(({ version, payload }) => { - this.replaceField(schema, payload, version, now); + public disableField(schema: SchemaDto, field: T): Observable { + return this.schemasService.disableField(this.appName, field, schema.version).pipe( + tap(updated => { + this.replaceSchema(updated); }), - shareMapSubscribed(this.dialogs, x => x.payload)); + shareSubscribed(this.dialogs)); } - public showField(schema: SchemaDetailsDto, field: T, now?: DateTime): Observable { - return this.schemasService.showField(this.appName, schema.name, field.fieldId, pidof(field), schema.version).pipe( - mapVersioned(() => setHidden(field, false)), - tap(({ version, payload }) => { - this.replaceField(schema, payload, version, now); + public showField(schema: SchemaDto, field: T): Observable { + return this.schemasService.showField(this.appName, field, schema.version).pipe( + tap(updated => { + this.replaceSchema(updated); }), - shareMapSubscribed(this.dialogs, x => x.payload)); + shareSubscribed(this.dialogs)); } - public hideField(schema: SchemaDetailsDto, field: T, now?: DateTime): Observable { - return this.schemasService.hideField(this.appName, schema.name, field.fieldId, pidof(field), schema.version).pipe( - mapVersioned(() => setHidden(field, true)), - tap(({ version, payload }) => { - this.replaceField(schema, payload, version, now); + public hideField(schema: SchemaDto, field: T): Observable { + return this.schemasService.hideField(this.appName, field, schema.version).pipe( + tap(updated => { + this.replaceSchema(updated); }), - shareMapSubscribed(this.dialogs, x => x.payload)); + shareSubscribed(this.dialogs)); } - public updateField(schema: SchemaDetailsDto, field: T, request: UpdateFieldDto, now?: DateTime): Observable { - return this.schemasService.putField(this.appName, schema.name, field.fieldId, request, pidof(field), schema.version).pipe( - mapVersioned(() => update(field, request.properties)), - tap(({ version, payload }) => { - this.replaceField(schema, payload, version, now); + public updateField(schema: SchemaDto, field: T, request: UpdateFieldDto): Observable { + return this.schemasService.putField(this.appName, field, request, schema.version).pipe( + tap(updated => { + this.replaceSchema(updated); }), - shareMapSubscribed(this.dialogs, x => x.payload)); + shareSubscribed(this.dialogs)); } - public deleteField(schema: SchemaDetailsDto, field: AnyFieldDto, now?: DateTime): Observable { - return this.schemasService.deleteField(this.appName, schema.name, field.fieldId, pidof(field), schema.version).pipe( - mapVersioned(() => field), - tap(({ version, payload }) => { - this.removeField(schema, payload, version, now); + public deleteField(schema: SchemaDto, field: AnyFieldDto): Observable { + return this.schemasService.deleteField(this.appName, field, schema.version).pipe( + tap(updated => { + this.replaceSchema(updated); }), shareSubscribed(this.dialogs)); } - private replaceField(schema: SchemaDetailsDto, field: T, version: Version, now?: DateTime) { - if (Types.is(field, RootFieldDto)) { - this.replaceSchema(updateField(schema, field, this.user, version, now)); - } else if (Types.is(field, NestedFieldDto)) { - const parent = schema.fields.find(x => x.fieldId === field.parentId); - - if (parent) { - this.replaceSchema(updateField(schema, updatedNested(parent, field), this.user, version, now)); - } - } - } - - private removeField(schema: SchemaDetailsDto, field: AnyFieldDto, version: Version, now?: DateTime) { - if (Types.is(field, RootFieldDto)) { - this.replaceSchema(removeField(schema, field, this.user, version, now)); - } else { - const parent = schema.fields.find(x => x.fieldId === field.parentId); - - if (parent) { - this.replaceSchema(updateField(schema, removeNested(parent, field), this.user, version, now)); - } - } - } - private replaceSchema(schema: SchemaDto) { return this.next(s => { const schemas = s.schemas.replaceBy('id', schema).sortByStringAsc(x => x.displayName); - const selectedSchema = Types.is(schema, SchemaDetailsDto) && s.selectedSchema && s.selectedSchema.id === schema.id ? schema : s.selectedSchema; + + const selectedSchema = + Types.is(schema, SchemaDetailsDto) && + schema && + s.selectedSchema && + s.selectedSchema.id === schema.id ? + schema : + s.selectedSchema; const categories = buildCategories(s.categories, schemas); @@ -375,9 +320,13 @@ export class SchemasState extends State { private get appName() { return this.appsState.appName; } +} - private get user() { - return this.authState.user!.token; +function getField(x: SchemaDetailsDto, request: AddFieldDto, parent?: RootFieldDto): FieldDto { + if (parent) { + return parent.nested.find(f => f.name === request.name)!; + } else { + return x.fields.find(f => f.name === request.name)!; } } @@ -417,123 +366,4 @@ function removeCategory(categories: { [name: string]: boolean }, category: strin delete categories[category]; return categories; -} - -const setPublished = (schema: T, isPublished: boolean, user: string, version: Version, now?: DateTime) => - schema.with({ - isPublished, - lastModified: now || DateTime.now(), - lastModifiedBy: user, - version - }); - -const changeCategory = (schema: T, category: string, user: string, version: Version, now?: DateTime) => - schema.with({ - category, - lastModified: now || DateTime.now(), - lastModifiedBy: user, - version - }); - -const configurePreviewUrls = (schema: SchemaDetailsDto, previewUrls: {}, user: string, version: Version, now?: DateTime) => - schema.with({ - previewUrls, - lastModified: now || DateTime.now(), - lastModifiedBy: user, - version - }); - -const configureScripts = (schema: SchemaDetailsDto, scripts: {}, user: string, version: Version, now?: DateTime) => - schema.with({ - scripts, - lastModified: now || DateTime.now(), - lastModifiedBy: user, - version - }); - -const updateProperties = (schema: SchemaDetailsDto, properties: SchemaPropertiesDto, user: string, version: Version, now?: DateTime) => - schema.with({ - properties, - lastModified: now || DateTime.now(), - lastModifiedBy: user, - version - }); - -const addField = (schema: SchemaDetailsDto, field: RootFieldDto, user: string, version: Version, now?: DateTime) => - schema.with({ - fields: [...schema.fields, field], - lastModified: now || DateTime.now(), - lastModifiedBy: user, - version - }); - -const updateField = (schema: SchemaDetailsDto, field: RootFieldDto, user: string, version: Version, now?: DateTime) => - schema.with({ - fields: schema.fields.map(f => f.fieldId === field.fieldId ? field : f), - lastModified: now || DateTime.now(), - lastModifiedBy: user, - version - }); - -const replaceFields = (schema: SchemaDetailsDto, fields: RootFieldDto[], user: string, version: Version, now?: DateTime) => - schema.with({ - fields, - version, - lastModified: now || DateTime.now(), - lastModifiedBy: user - }); - -const removeField = (schema: SchemaDetailsDto, field: FieldDto, user: string, version: Version, now?: DateTime) => - schema.with({ - fields: schema.fields.filter(f => f.fieldId !== field.fieldId), - version, - lastModified: now || DateTime.now(), - lastModifiedBy: user - }); - -const addNested = (parent: RootFieldDto, nested: NestedFieldDto) => - parent.with({ nested: [...parent.nested, nested] }); - -const updatedNested = (parent: RootFieldDto, nested: NestedFieldDto) => - parent.with({ nested: parent.nested.map(f => f.fieldId === nested.fieldId ? nested : f) }); - -const replaceNested = (parent: RootFieldDto, nested: NestedFieldDto[]) => - parent.with({ nested }); - -const removeNested = (parent: RootFieldDto, nested: NestedFieldDto) => - parent.with({ nested: parent.nested.filter(f => f.fieldId !== nested.fieldId) }); - -const setLocked = (field: T, isLocked: boolean) => - field.with({ isLocked }); - -const setHidden = (field: T, isHidden: boolean) => - field.with({ isHidden }); - -const setDisabled = (field: T, isDisabled: boolean) => - field.with({ isDisabled }); - -const update = (field: T, properties: FieldPropertiesDto) => - field.with({ properties }); - -const pidof = (field: T) => - Types.is(field, NestedFieldDto) ? field.parentId : undefined; - -const pid = (field?: RootFieldDto) => - field ? field.fieldId : undefined; - -function createSchema(request: CreateSchemaDto, { payload, version }: Versioned, user: string, now?: DateTime) { - now = now || DateTime.now(); - - const schema = new SchemaDetailsDto( - payload.id, - request.name, '', - request.properties || new SchemaPropertiesDto(), - request.isSingleton === true, - false, - now, user, - now, user, - version, - request.fields || []); - - return schema; } \ No newline at end of file From 692081ad26984e7f7f0c6ad5ef9b843890c0ca29 Mon Sep 17 00:00:00 2001 From: Sebastian Stehle Date: Sat, 15 Jun 2019 11:11:30 +0200 Subject: [PATCH 16/64] Update schema view. --- .../Schemas/SchemaGrain.cs | 73 ++++++++++++++----- .../Controllers/Assets/AssetsController.cs | 4 +- .../Controllers/Assets/Models/AssetsDto.cs | 10 +++ .../Contents/ContentsController.cs | 9 +-- .../Contents/Models/ContentsDto.cs | 10 +++ .../Schemas/Models/SchemaDetailsDto.cs | 18 ++--- .../Controllers/Schemas/Models/SchemaDto.cs | 24 +++--- .../Controllers/Schemas/Models/SchemasDto.cs | 43 +++++++++++ .../Schemas/SchemaFieldsController.cs | 4 +- .../Controllers/Schemas/SchemasController.cs | 6 +- .../schemas/pages/schema/field.component.html | 21 +++--- .../schemas/pages/schema/field.component.ts | 27 ++++--- .../schema/forms/field-form.component.ts | 15 +++- .../schema/schema-edit-form.component.html | 2 +- .../schema/schema-edit-form.component.ts | 13 ++++ .../pages/schema/schema-page.component.html | 27 ++++--- .../schema-preview-urls-form.component.html | 5 +- .../schema-preview-urls-form.component.ts | 17 +++++ .../schema/schema-scripts-form.component.html | 2 +- .../schema/schema-scripts-form.component.ts | 13 ++++ .../app/shared/services/backups.service.ts | 4 +- .../app/shared/services/plans.service.ts | 4 +- 22 files changed, 255 insertions(+), 96 deletions(-) create mode 100644 src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemasDto.cs diff --git a/src/Squidex.Domain.Apps.Entities/Schemas/SchemaGrain.cs b/src/Squidex.Domain.Apps.Entities/Schemas/SchemaGrain.cs index 44e96fa7f..c32e8d9e7 100644 --- a/src/Squidex.Domain.Apps.Entities/Schemas/SchemaGrain.cs +++ b/src/Squidex.Domain.Apps.Entities/Schemas/SchemaGrain.cs @@ -48,7 +48,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas switch (command) { case AddField addField: - return UpdateAsync(addField, c => + return UpdateReturnAsync(addField, async c => { GuardSchemaField.CanAdd(Snapshot.SchemaDef, c); @@ -65,135 +65,167 @@ namespace Squidex.Domain.Apps.Entities.Schemas id = ((IArrayField)Snapshot.SchemaDef.FieldsById[c.ParentFieldId.Value]).FieldsByName[c.Name].Id; } - return EntityCreatedResult.Create(id, Version); + return await GetRawStateAsync(); }); case CreateSchema createSchema: - return CreateAsync(createSchema, async c => + return CreateReturnAsync(createSchema, async c => { await GuardSchema.CanCreate(c, appProvider); Create(c); + + return await GetRawStateAsync(); }); case SynchronizeSchema synchronizeSchema: - return UpdateAsync(synchronizeSchema, c => + return UpdateReturnAsync(synchronizeSchema, async c => { GuardSchema.CanSynchronize(c); Synchronize(c); + + return await GetRawStateAsync(); }); case DeleteField deleteField: - return UpdateAsync(deleteField, c => + return UpdateReturnAsync(deleteField, async c => { GuardSchemaField.CanDelete(Snapshot.SchemaDef, deleteField); DeleteField(c); + + return await GetRawStateAsync(); }); case LockField lockField: - return UpdateAsync(lockField, c => + return UpdateReturnAsync(lockField, async c => { GuardSchemaField.CanLock(Snapshot.SchemaDef, lockField); LockField(c); + + return await GetRawStateAsync(); }); case HideField hideField: - return UpdateAsync(hideField, c => + return UpdateReturnAsync(hideField, async c => { GuardSchemaField.CanHide(Snapshot.SchemaDef, c); HideField(c); + + return await GetRawStateAsync(); }); case ShowField showField: - return UpdateAsync(showField, c => + return UpdateReturnAsync(showField, async c => { GuardSchemaField.CanShow(Snapshot.SchemaDef, c); ShowField(c); + + return await GetRawStateAsync(); }); case DisableField disableField: - return UpdateAsync(disableField, c => + return UpdateReturnAsync(disableField, async c => { GuardSchemaField.CanDisable(Snapshot.SchemaDef, c); DisableField(c); + + return await GetRawStateAsync(); }); case EnableField enableField: - return UpdateAsync(enableField, c => + return UpdateReturnAsync(enableField, async c => { GuardSchemaField.CanEnable(Snapshot.SchemaDef, c); EnableField(c); + + return await GetRawStateAsync(); }); case UpdateField updateField: - return UpdateAsync(updateField, c => + return UpdateReturnAsync(updateField, async c => { GuardSchemaField.CanUpdate(Snapshot.SchemaDef, c); UpdateField(c); + + return await GetRawStateAsync(); }); case ReorderFields reorderFields: - return UpdateAsync(reorderFields, c => + return UpdateReturnAsync(reorderFields, async c => { GuardSchema.CanReorder(Snapshot.SchemaDef, c); Reorder(c); + + return await GetRawStateAsync(); }); case UpdateSchema updateSchema: - return UpdateAsync(updateSchema, c => + return UpdateReturnAsync(updateSchema, async c => { GuardSchema.CanUpdate(Snapshot.SchemaDef, c); Update(c); + + return await GetRawStateAsync(); }); case PublishSchema publishSchema: - return UpdateAsync(publishSchema, c => + return UpdateReturnAsync(publishSchema, async c => { GuardSchema.CanPublish(Snapshot.SchemaDef, c); Publish(c); + + return await GetRawStateAsync(); }); case UnpublishSchema unpublishSchema: - return UpdateAsync(unpublishSchema, c => + return UpdateReturnAsync(unpublishSchema, async c => { GuardSchema.CanUnpublish(Snapshot.SchemaDef, c); Unpublish(c); + + return await GetRawStateAsync(); }); case ConfigureScripts configureScripts: - return UpdateAsync(configureScripts, c => + return UpdateReturnAsync(configureScripts, async c => { GuardSchema.CanConfigureScripts(Snapshot.SchemaDef, c); ConfigureScripts(c); + + return await GetRawStateAsync(); }); case ChangeCategory changeCategory: - return UpdateAsync(changeCategory, c => + return UpdateReturnAsync(changeCategory, async c => { GuardSchema.CanChangeCategory(Snapshot.SchemaDef, c); ChangeCategory(c); + + return await GetRawStateAsync(); }); case ConfigurePreviewUrls configurePreviewUrls: - return UpdateAsync(configurePreviewUrls, c => + return UpdateReturnAsync(configurePreviewUrls, async c => { GuardSchema.CanConfigurePreviewUrls(c); ConfigurePreviewUrls(c); + + return await GetRawStateAsync(); }); case DeleteSchema deleteSchema: @@ -381,6 +413,11 @@ namespace Squidex.Domain.Apps.Entities.Schemas } } + public Task GetRawStateAsync() + { + return Task.FromResult(Snapshot); + } + public Task> GetStateAsync() { return J.AsTask(Snapshot); diff --git a/src/Squidex/Areas/Api/Controllers/Assets/AssetsController.cs b/src/Squidex/Areas/Api/Controllers/Assets/AssetsController.cs index 08763e341..c88246a85 100644 --- a/src/Squidex/Areas/Api/Controllers/Assets/AssetsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Assets/AssetsController.cs @@ -109,10 +109,10 @@ namespace Squidex.Areas.Api.Controllers.Assets if (controllerOptions.Value.EnableSurrogateKeys && response.Items.Length <= controllerOptions.Value.MaxItemsForSurrogateKeys) { - Response.Headers["Surrogate-Key"] = response.Items.ToSurrogateKeys(); + Response.Headers["Surrogate-Key"] = response.ToSurrogateKeys(); } - Response.Headers[HeaderNames.ETag] = response.Items.ToManyEtag(response.Total); + Response.Headers[HeaderNames.ETag] = response.ToEtag(); return Ok(response); } diff --git a/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetsDto.cs b/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetsDto.cs index 4463dbfd7..b7f9a3b05 100644 --- a/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetsDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetsDto.cs @@ -27,6 +27,16 @@ namespace Squidex.Areas.Api.Controllers.Assets.Models /// public long Total { get; set; } + public string ToEtag() + { + return Items.ToManyEtag(Total); + } + + public string ToSurrogateKeys() + { + return Items.ToSurrogateKeys(); + } + public static AssetsDto FromAssets(IResultList assets, ApiController controller, string app) { var response = new AssetsDto diff --git a/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs b/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs index 7ba607666..66264dcb4 100644 --- a/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs @@ -6,7 +6,6 @@ // ========================================================================== using System; -using System.Linq; using System.Threading.Tasks; using Microsoft.AspNetCore.Mvc; using Microsoft.Extensions.Options; @@ -132,10 +131,10 @@ namespace Squidex.Areas.Api.Controllers.Contents if (controllerOptions.Value.EnableSurrogateKeys && response.Items.Length <= controllerOptions.Value.MaxItemsForSurrogateKeys) { - Response.Headers["Surrogate-Key"] = response.Items.ToSurrogateKeys(); + Response.Headers["Surrogate-Key"] = response.ToSurrogateKeys(); } - Response.Headers[HeaderNames.ETag] = response.Items.ToManyEtag(); + Response.Headers[HeaderNames.ETag] = response.ToEtag(); return Ok(response); } @@ -168,10 +167,10 @@ namespace Squidex.Areas.Api.Controllers.Contents if (controllerOptions.Value.EnableSurrogateKeys && response.Items.Length <= controllerOptions.Value.MaxItemsForSurrogateKeys) { - Response.Headers["Surrogate-Key"] = response.Items.ToSurrogateKeys(); + Response.Headers["Surrogate-Key"] = response.ToSurrogateKeys(); } - Response.Headers[HeaderNames.ETag] = response.Items.ToManyEtag(response.Total); + Response.Headers[HeaderNames.ETag] = response.ToEtag(); return Ok(response); } diff --git a/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentsDto.cs b/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentsDto.cs index ef185416d..edcb6caa8 100644 --- a/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentsDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentsDto.cs @@ -26,6 +26,16 @@ namespace Squidex.Areas.Api.Controllers.Contents.Models /// public ContentDto[] Items { get; set; } + public string ToEtag() + { + return Items.ToManyEtag(Total); + } + + public string ToSurrogateKeys() + { + return Items.ToSurrogateKeys(); + } + public static ContentsDto FromContents(IList contents, QueryContext context, ApiController controller, string app) { var result = new ContentsDto diff --git a/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDetailsDto.cs b/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDetailsDto.cs index 41494e0c1..b71e85280 100644 --- a/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDetailsDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDetailsDto.cs @@ -37,19 +37,19 @@ namespace Squidex.Areas.Api.Controllers.Schemas.Models public static SchemaDetailsDto FromSchemaWithDetails(ISchemaEntity schema, ApiController controller, string app) { - var response = new SchemaDetailsDto(); + var result = new SchemaDetailsDto(); - SimpleMapper.Map(schema, response); - SimpleMapper.Map(schema.SchemaDef, response); - SimpleMapper.Map(schema.SchemaDef.Scripts, response.Scripts); - SimpleMapper.Map(schema.SchemaDef.Properties, response.Properties); + SimpleMapper.Map(schema, result); + SimpleMapper.Map(schema.SchemaDef, result); + SimpleMapper.Map(schema.SchemaDef.Scripts, result.Scripts); + SimpleMapper.Map(schema.SchemaDef.Properties, result.Properties); if (schema.SchemaDef.PreviewUrls.Count > 0) { - response.PreviewUrls = new Dictionary(schema.SchemaDef.PreviewUrls); + result.PreviewUrls = new Dictionary(schema.SchemaDef.PreviewUrls); } - response.Fields = new List(); + result.Fields = new List(); foreach (var field in schema.SchemaDef.Fields) { @@ -82,10 +82,10 @@ namespace Squidex.Areas.Api.Controllers.Schemas.Models } } - response.Fields.Add(fieldDto); + result.Fields.Add(fieldDto); } - return CreateLinks(response, controller, app); + return (SchemaDetailsDto)result.CreateLinks(controller, app); } } } diff --git a/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDto.cs b/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDto.cs index 4bb86680f..7ae0addad 100644 --- a/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDto.cs @@ -40,7 +40,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas.Models /// The schema properties. /// [Required] - public SchemaPropertiesDto Properties { get; set; } + public SchemaPropertiesDto Properties { get; set; } = new SchemaPropertiesDto(); /// /// Indicates if the schema is a singleton. @@ -81,27 +81,27 @@ namespace Squidex.Areas.Api.Controllers.Schemas.Models public static SchemaDto FromSchema(ISchemaEntity schema, ApiController controller, string app) { - var response = new SchemaDto { Properties = new SchemaPropertiesDto() }; + var result = new SchemaDto(); - SimpleMapper.Map(schema, response); - SimpleMapper.Map(schema.SchemaDef, response); - SimpleMapper.Map(schema.SchemaDef.Properties, response.Properties); + SimpleMapper.Map(schema, result); + SimpleMapper.Map(schema.SchemaDef, result); + SimpleMapper.Map(schema.SchemaDef.Properties, result.Properties); - return CreateLinks(response, controller, app); + return result.CreateLinks(controller, app); } - protected static T CreateLinks(T response, ApiController controller, string app) where T : SchemaDto + protected virtual SchemaDto CreateLinks(ApiController controller, string app) { - var values = new { app, name = response.Name }; + var values = new { app, name = Name }; - response.AddSelfLink(controller.Url(x => nameof(x.GetSchema), values)); + AddSelfLink(controller.Url(x => nameof(x.GetSchema), values)); - if (controller.HasPermission(Permissions.AppContentsRead, app, response.Name)) + if (controller.HasPermission(Permissions.AppContentsRead, app, Name)) { - response.AddGetLink("contents", controller.Url(x => nameof(x.GetContents), values)); + AddGetLink("contents", controller.Url(x => nameof(x.GetContents), values)); } - return response; + return this; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemasDto.cs b/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemasDto.cs new file mode 100644 index 000000000..8fb9755fa --- /dev/null +++ b/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemasDto.cs @@ -0,0 +1,43 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschraenkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +using System.Collections.Generic; +using System.Linq; +using Squidex.Domain.Apps.Entities.Schemas; +using Squidex.Infrastructure; +using Squidex.Web; + +namespace Squidex.Areas.Api.Controllers.Schemas.Models +{ + public sealed class SchemasDto : Resource + { + /// + /// The schemas. + /// + public SchemaDto[] Items { get; set; } + + public string ToEtag() + { + return Items.ToManyEtag(); + } + + public static SchemasDto FromSchemas(IList schemas, ApiController controller, string app) + { + var result = new SchemasDto + { + Items = schemas.Select(x => SchemaDto.FromSchema(x, controller, app)).ToArray() + }; + + return result.CreateLinks(controller, app); + } + + private SchemasDto CreateLinks(ApiController controller, string app) + { + return this; + } + } +} diff --git a/src/Squidex/Areas/Api/Controllers/Schemas/SchemaFieldsController.cs b/src/Squidex/Areas/Api/Controllers/Schemas/SchemaFieldsController.cs index 7a5b1ca80..1ccb87745 100644 --- a/src/Squidex/Areas/Api/Controllers/Schemas/SchemaFieldsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Schemas/SchemaFieldsController.cs @@ -541,8 +541,8 @@ namespace Squidex.Areas.Api.Controllers.Schemas { var context = await CommandBus.PublishAsync(command); - var response = context.Result(); - var response = SchemaDetailsDto.FromSchemaWithDetails(response, this, app); + var result = context.Result(); + var response = SchemaDetailsDto.FromSchemaWithDetails(result, this, app); return response; } diff --git a/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs b/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs index e13e82131..854b24f57 100644 --- a/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs +++ b/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs @@ -44,16 +44,16 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpGet] [Route("apps/{app}/schemas/")] - [ProducesResponseType(typeof(SchemaDto[]), 200)] + [ProducesResponseType(typeof(SchemasDto), 200)] [ApiPermission(Permissions.AppCommon)] [ApiCosts(0)] public async Task GetSchemas(string app) { var schemas = await appProvider.GetSchemasAsync(AppId); - var response = schemas.ToArray(x => SchemaDto.FromSchema(x, this, app)); + var response = SchemasDto.FromSchemas(schemas, this, app); - Response.Headers[HeaderNames.ETag] = response.ToManyEtag(); + Response.Headers[HeaderNames.ETag] = response.ToEtag(); return Ok(response); } diff --git a/src/Squidex/app/features/schemas/pages/schema/field.component.html b/src/Squidex/app/features/schemas/pages/schema/field.component.html index 2fee24efa..1858af5e6 100644 --- a/src/Squidex/app/features/schemas/pages/schema/field.component.html +++ b/src/Squidex/app/features/schemas/pages/schema/field.component.html @@ -20,7 +20,7 @@
- @@ -30,21 +30,21 @@
- + Enable in UI - + Disable in UI - + Hide in API - + Show in API - +
Lock and prevent changes - + + +
@@ -70,7 +73,7 @@
-
+
-
+
- +
@@ -49,10 +49,13 @@ import {
` }) -export class FieldFormComponent { +export class FieldFormComponent implements AfterViewInit { @Input() public showButtons: boolean; + @Input() + public isEditable: boolean; + @Input() public editForm: FormGroup; @@ -70,6 +73,12 @@ export class FieldFormComponent { public selectedTab = 0; + public ngAfterViewInit() { + if (!this.isEditable) { + this.editForm.disable(); + } + } + public selectTab(tab: number) { this.selectedTab = tab; } diff --git a/src/Squidex/app/features/schemas/pages/schema/schema-edit-form.component.html b/src/Squidex/app/features/schemas/pages/schema/schema-edit-form.component.html index 4fda1eae7..494aad805 100644 --- a/src/Squidex/app/features/schemas/pages/schema/schema-edit-form.component.html +++ b/src/Squidex/app/features/schemas/pages/schema/schema-edit-form.component.html @@ -30,7 +30,7 @@ - + \ No newline at end of file diff --git a/src/Squidex/app/features/schemas/pages/schema/schema-edit-form.component.ts b/src/Squidex/app/features/schemas/pages/schema/schema-edit-form.component.ts index 15148f23f..596fcc44f 100644 --- a/src/Squidex/app/features/schemas/pages/schema/schema-edit-form.component.ts +++ b/src/Squidex/app/features/schemas/pages/schema/schema-edit-form.component.ts @@ -10,6 +10,7 @@ import { FormBuilder } from '@angular/forms'; import { EditSchemaForm, + hasAnyLink, SchemaDetailsDto, SchemasState } from '@app/shared'; @@ -28,6 +29,8 @@ export class SchemaEditFormComponent implements OnInit { public editForm = new EditSchemaForm(this.formBuilder); + public isEditable = false; + constructor( private readonly formBuilder: FormBuilder, private readonly schemasState: SchemasState @@ -35,7 +38,13 @@ export class SchemaEditFormComponent implements OnInit { } public ngOnInit() { + this.isEditable = hasAnyLink(this.schema, 'update'); + this.editForm.load(this.schema.properties); + + if (!this.isEditable) { + this.editForm.form.disable(); + } } public emitComplete() { @@ -43,6 +52,10 @@ export class SchemaEditFormComponent implements OnInit { } public saveSchema() { + if (!this.isEditable) { + return; + } + const value = this.editForm.submit(); if (value) { diff --git a/src/Squidex/app/features/schemas/pages/schema/schema-page.component.html b/src/Squidex/app/features/schemas/pages/schema/schema-page.component.html index 69ccaa9fc..3fe3ea41b 100644 --- a/src/Squidex/app/features/schemas/pages/schema/schema-page.component.html +++ b/src/Squidex/app/features/schemas/pages/schema/schema-page.component.html @@ -11,10 +11,10 @@
- -
@@ -37,14 +37,16 @@ Clone -
- - - Delete - + +
+ + + Delete + +
@@ -61,13 +63,14 @@
No field created yet. -
@@ -75,7 +78,7 @@
- diff --git a/src/Squidex/app/features/schemas/pages/schema/schema-preview-urls-form.component.html b/src/Squidex/app/features/schemas/pages/schema/schema-preview-urls-form.component.html index cbf504ee0..f73a4c78d 100644 --- a/src/Squidex/app/features/schemas/pages/schema/schema-preview-urls-form.component.html +++ b/src/Squidex/app/features/schemas/pages/schema/schema-preview-urls-form.component.html @@ -29,6 +29,7 @@
-
+
@@ -65,7 +66,7 @@ - + diff --git a/src/Squidex/app/features/schemas/pages/schema/schema-preview-urls-form.component.ts b/src/Squidex/app/features/schemas/pages/schema/schema-preview-urls-form.component.ts index 72a59074e..dea644b4d 100644 --- a/src/Squidex/app/features/schemas/pages/schema/schema-preview-urls-form.component.ts +++ b/src/Squidex/app/features/schemas/pages/schema/schema-preview-urls-form.component.ts @@ -11,6 +11,7 @@ import { FormBuilder } from '@angular/forms'; import { AddPreviewUrlForm, ConfigurePreviewUrlsForm, + hasAnyLink, SchemaDetailsDto, SchemasState } from '@app/shared'; @@ -31,6 +32,8 @@ export class SchemaPreviewUrlsFormComponent implements OnInit { public editForm = new ConfigurePreviewUrlsForm(this.formBuilder); + public isEditable = false; + constructor( private readonly formBuilder: FormBuilder, private readonly schemasState: SchemasState @@ -38,7 +41,13 @@ export class SchemaPreviewUrlsFormComponent implements OnInit { } public ngOnInit() { + this.isEditable = hasAnyLink(this.schema, 'update'); + this.editForm.load(this.schema.previewUrls); + + if (!this.isEditable) { + return; + } } public emitComplete() { @@ -50,6 +59,10 @@ export class SchemaPreviewUrlsFormComponent implements OnInit { } public add() { + if (!this.isEditable) { + return; + } + const value = this.addForm.submit(); if (value) { @@ -60,6 +73,10 @@ export class SchemaPreviewUrlsFormComponent implements OnInit { } public saveSchema() { + if (!this.isEditable) { + return; + } + const value = this.editForm.submit(); if (value) { diff --git a/src/Squidex/app/features/schemas/pages/schema/schema-scripts-form.component.html b/src/Squidex/app/features/schemas/pages/schema/schema-scripts-form.component.html index d148e5ae3..b886f8a7a 100644 --- a/src/Squidex/app/features/schemas/pages/schema/schema-scripts-form.component.html +++ b/src/Squidex/app/features/schemas/pages/schema/schema-scripts-form.component.html @@ -24,7 +24,7 @@ - + diff --git a/src/Squidex/app/features/schemas/pages/schema/schema-scripts-form.component.ts b/src/Squidex/app/features/schemas/pages/schema/schema-scripts-form.component.ts index 25ea72bf5..ceda622ca 100644 --- a/src/Squidex/app/features/schemas/pages/schema/schema-scripts-form.component.ts +++ b/src/Squidex/app/features/schemas/pages/schema/schema-scripts-form.component.ts @@ -10,6 +10,7 @@ import { FormBuilder } from '@angular/forms'; import { EditScriptsForm, + hasAnyLink, SchemaDetailsDto, SchemasState } from '@app/shared'; @@ -30,6 +31,8 @@ export class SchemaScriptsFormComponent implements OnInit { public editForm = new EditScriptsForm(this.formBuilder); + public isEditable = false; + constructor( private readonly formBuilder: FormBuilder, private readonly schemasState: SchemasState @@ -37,7 +40,13 @@ export class SchemaScriptsFormComponent implements OnInit { } public ngOnInit() { + this.isEditable = hasAnyLink(this.schema, 'update'); + this.editForm.load(this.schema.scripts); + + if (!this.isEditable) { + this.editForm.form.disable(); + } } public emitComplete() { @@ -49,6 +58,10 @@ export class SchemaScriptsFormComponent implements OnInit { } public saveSchema() { + if (!this.isEditable) { + return; + } + const value = this.editForm.submit(); if (value) { diff --git a/src/Squidex/app/shared/services/backups.service.ts b/src/Squidex/app/shared/services/backups.service.ts index 8cd9286aa..43bac297d 100644 --- a/src/Squidex/app/shared/services/backups.service.ts +++ b/src/Squidex/app/shared/services/backups.service.ts @@ -14,7 +14,6 @@ import { AnalyticsService, ApiUrlConfig, DateTime, - Model, pretifyError, Resource, ResourceLinks, @@ -41,7 +40,7 @@ export class BackupDto { } } -export class RestoreDto extends Model { +export class RestoreDto { constructor( public readonly url: string, public readonly started: DateTime, @@ -49,7 +48,6 @@ export class RestoreDto extends Model { public readonly status: string, public readonly log: string[] ) { - super(); } } diff --git a/src/Squidex/app/shared/services/plans.service.ts b/src/Squidex/app/shared/services/plans.service.ts index 4c34a7110..31e1ace9a 100644 --- a/src/Squidex/app/shared/services/plans.service.ts +++ b/src/Squidex/app/shared/services/plans.service.ts @@ -15,7 +15,6 @@ import { ApiUrlConfig, HTTP, mapVersioned, - Model, pretifyError, Version, Versioned @@ -28,7 +27,7 @@ export type PlansDto = Versioned<{ readonly plans: PlanDto[] }>; -export class PlanDto extends Model { +export class PlanDto { constructor( public readonly id: string, public readonly name: string, @@ -39,7 +38,6 @@ export class PlanDto extends Model { public readonly maxAssetSize: number, public readonly maxContributors: number ) { - super(); } } From 84474dfb2f0dee4b346c464fca62c2c1bd80d60c Mon Sep 17 00:00:00 2001 From: Sebastian Stehle Date: Sat, 15 Jun 2019 16:13:50 +0200 Subject: [PATCH 17/64] Update for hateos in UI --- .../Schemas/Guards/GuardHelper.cs | 24 +++++++-- .../Schemas/Guards/GuardSchema.cs | 2 +- .../Schemas/Guards/GuardSchemaField.cs | 48 +++++++---------- src/Squidex.Shared/Permissions.cs | 3 -- .../Controllers/Backups/RestoreController.cs | 4 +- .../Controllers/Schemas/Models/FieldDto.cs | 53 ++++++++++++++++++- .../Schemas/Models/NestedFieldDto.cs | 37 ++++++++++++- .../Schemas/Models/SchemaDetailsDto.cs | 20 ++++++- .../Controllers/Schemas/Models/SchemaDto.cs | 42 +++++++++++++-- .../Controllers/Schemas/Models/SchemasDto.cs | 10 ++++ .../Controllers/Schemas/SchemasController.cs | 2 +- .../Controllers/Users/Models/ResourcesDto.cs | 8 +-- .../pages/users/user-page.component.ts | 4 +- .../pages/schemas/schemas-page.component.html | 2 +- .../pages/rules/rule-wizard.component.ts | 4 +- .../schemas/pages/schema/field.component.html | 6 ++- .../pages/schema/schema-page.component.html | 18 ++++--- .../pages/schemas/schemas-page.component.html | 14 +++-- .../pages/languages/language.component.html | 5 +- .../app/framework/angular/sorted.directive.ts | 30 +++++------ src/Squidex/app/framework/utils/hateos.ts | 2 +- .../components/asset-dialog.component.ts | 4 +- .../app/shared/components/asset.component.ts | 4 +- .../components/schema-category.component.html | 44 +++++++-------- .../components/schema-category.component.ts | 9 ++-- .../shared/services/schemas.service.spec.ts | 4 +- .../app/shared/services/schemas.service.ts | 42 ++++++++------- .../ApiPermissionAttributeTests.cs | 8 +-- 28 files changed, 312 insertions(+), 141 deletions(-) diff --git a/src/Squidex.Domain.Apps.Entities/Schemas/Guards/GuardHelper.cs b/src/Squidex.Domain.Apps.Entities/Schemas/Guards/GuardHelper.cs index b0a2b8d5d..760a6086e 100644 --- a/src/Squidex.Domain.Apps.Entities/Schemas/Guards/GuardHelper.cs +++ b/src/Squidex.Domain.Apps.Entities/Schemas/Guards/GuardHelper.cs @@ -12,21 +12,26 @@ namespace Squidex.Domain.Apps.Entities.Schemas.Guards { public static class GuardHelper { - public static IArrayField GetArrayFieldOrThrow(Schema schema, long parentId) + public static IArrayField GetArrayFieldOrThrow(Schema schema, long parentId, bool allowLocked) { if (!schema.FieldsById.TryGetValue(parentId, out var rootField) || !(rootField is IArrayField arrayField)) { throw new DomainObjectNotFoundException(parentId.ToString(), "Fields", typeof(Schema)); } + if (!allowLocked) + { + EnsureNotLocked(arrayField); + } + return arrayField; } - public static IField GetFieldOrThrow(Schema schema, long fieldId, long? parentId) + public static IField GetFieldOrThrow(Schema schema, long fieldId, long? parentId, bool allowLocked) { if (parentId.HasValue) { - var arrayField = GetArrayFieldOrThrow(schema, parentId.Value); + var arrayField = GetArrayFieldOrThrow(schema, parentId.Value, allowLocked); if (!arrayField.FieldsById.TryGetValue(fieldId, out var nestedField)) { @@ -41,7 +46,20 @@ namespace Squidex.Domain.Apps.Entities.Schemas.Guards throw new DomainObjectNotFoundException(fieldId.ToString(), "Fields", typeof(Schema)); } + if (!allowLocked) + { + EnsureNotLocked(field); + } + return field; } + + private static void EnsureNotLocked(IField field) + { + if (field.IsLocked) + { + throw new DomainException("Schema field is locked."); + } + } } } diff --git a/src/Squidex.Domain.Apps.Entities/Schemas/Guards/GuardSchema.cs b/src/Squidex.Domain.Apps.Entities/Schemas/Guards/GuardSchema.cs index 4e937c96e..1a87bdf21 100644 --- a/src/Squidex.Domain.Apps.Entities/Schemas/Guards/GuardSchema.cs +++ b/src/Squidex.Domain.Apps.Entities/Schemas/Guards/GuardSchema.cs @@ -56,7 +56,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas.Guards if (command.ParentFieldId.HasValue) { - arrayField = GuardHelper.GetArrayFieldOrThrow(schema, command.ParentFieldId.Value); + arrayField = GuardHelper.GetArrayFieldOrThrow(schema, command.ParentFieldId.Value, false); } Validate.It(() => "Cannot reorder schema fields.", error => diff --git a/src/Squidex.Domain.Apps.Entities/Schemas/Guards/GuardSchemaField.cs b/src/Squidex.Domain.Apps.Entities/Schemas/Guards/GuardSchemaField.cs index ed93453bc..93b152d8c 100644 --- a/src/Squidex.Domain.Apps.Entities/Schemas/Guards/GuardSchemaField.cs +++ b/src/Squidex.Domain.Apps.Entities/Schemas/Guards/GuardSchemaField.cs @@ -38,7 +38,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas.Guards if (command.ParentFieldId.HasValue) { - var arrayField = GuardHelper.GetArrayFieldOrThrow(schema, command.ParentFieldId.Value); + var arrayField = GuardHelper.GetArrayFieldOrThrow(schema, command.ParentFieldId.Value, false); if (arrayField.FieldsByName.ContainsKey(command.Name)) { @@ -64,12 +64,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas.Guards { Guard.NotNull(command, nameof(command)); - var field = GuardHelper.GetFieldOrThrow(schema, command.FieldId, command.ParentFieldId); - - if (field.IsLocked) - { - throw new DomainException("Schema field is already locked."); - } + var field = GuardHelper.GetFieldOrThrow(schema, command.FieldId, command.ParentFieldId, false); Validate.It(() => "Cannot update field.", e => { @@ -90,12 +85,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas.Guards { Guard.NotNull(command, nameof(command)); - var field = GuardHelper.GetFieldOrThrow(schema, command.FieldId, command.ParentFieldId); - - if (field.IsLocked) - { - throw new DomainException("Schema field is locked."); - } + var field = GuardHelper.GetFieldOrThrow(schema, command.FieldId, command.ParentFieldId, false); if (field.IsHidden) { @@ -108,11 +98,23 @@ namespace Squidex.Domain.Apps.Entities.Schemas.Guards } } + public static void CanShow(Schema schema, ShowField command) + { + Guard.NotNull(command, nameof(command)); + + var field = GuardHelper.GetFieldOrThrow(schema, command.FieldId, command.ParentFieldId, false); + + if (!field.IsHidden) + { + throw new DomainException("Schema field is already visible."); + } + } + public static void CanDisable(Schema schema, DisableField command) { Guard.NotNull(command, nameof(command)); - var field = GuardHelper.GetFieldOrThrow(schema, command.FieldId, command.ParentFieldId); + var field = GuardHelper.GetFieldOrThrow(schema, command.FieldId, command.ParentFieldId, false); if (field.IsDisabled) { @@ -129,7 +131,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas.Guards { Guard.NotNull(command, nameof(command)); - var field = GuardHelper.GetFieldOrThrow(schema, command.FieldId, command.ParentFieldId); + var field = GuardHelper.GetFieldOrThrow(schema, command.FieldId, command.ParentFieldId, false); if (field.IsLocked) { @@ -137,23 +139,11 @@ namespace Squidex.Domain.Apps.Entities.Schemas.Guards } } - public static void CanShow(Schema schema, ShowField command) - { - Guard.NotNull(command, nameof(command)); - - var field = GuardHelper.GetFieldOrThrow(schema, command.FieldId, command.ParentFieldId); - - if (!field.IsHidden) - { - throw new DomainException("Schema field is already visible."); - } - } - public static void CanEnable(Schema schema, EnableField command) { Guard.NotNull(command, nameof(command)); - var field = GuardHelper.GetFieldOrThrow(schema, command.FieldId, command.ParentFieldId); + var field = GuardHelper.GetFieldOrThrow(schema, command.FieldId, command.ParentFieldId, false); if (!field.IsDisabled) { @@ -165,7 +155,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas.Guards { Guard.NotNull(command, nameof(command)); - var field = GuardHelper.GetFieldOrThrow(schema, command.FieldId, command.ParentFieldId); + var field = GuardHelper.GetFieldOrThrow(schema, command.FieldId, command.ParentFieldId, false); if (field.IsLocked) { diff --git a/src/Squidex.Shared/Permissions.cs b/src/Squidex.Shared/Permissions.cs index ee1e20cf4..98cb299c0 100644 --- a/src/Squidex.Shared/Permissions.cs +++ b/src/Squidex.Shared/Permissions.cs @@ -37,8 +37,6 @@ namespace Squidex.Shared public const string AdminAppCreate = "squidex.admin.apps.create"; public const string AdminRestore = "squidex.admin.restore"; - public const string AdminRestoreRead = "squidex.admin.restore.read"; - public const string AdminRestoreCreate = "squidex.admin.restore.create"; public const string AdminEvents = "squidex.admin.events"; public const string AdminEventsRead = "squidex.admin.events.read"; @@ -107,7 +105,6 @@ namespace Squidex.Shared public const string AppRulesDelete = "squidex.apps.{app}.rules.delete"; public const string AppSchemas = "squidex.apps.{app}.schemas.{name}"; - public const string AppSchemasRead = "squidex.apps.{app}.schemas.{name}.read"; public const string AppSchemasCreate = "squidex.apps.{app}.schemas.{name}.create"; public const string AppSchemasUpdate = "squidex.apps.{app}.schemas.{name}.update"; public const string AppSchemasScripts = "squidex.apps.{app}.schemas.{name}.scripts"; diff --git a/src/Squidex/Areas/Api/Controllers/Backups/RestoreController.cs b/src/Squidex/Areas/Api/Controllers/Backups/RestoreController.cs index 6ad1cf1c0..4426330de 100644 --- a/src/Squidex/Areas/Api/Controllers/Backups/RestoreController.cs +++ b/src/Squidex/Areas/Api/Controllers/Backups/RestoreController.cs @@ -41,7 +41,7 @@ namespace Squidex.Areas.Api.Controllers.Backups [HttpGet] [Route("apps/restore/")] [ProducesResponseType(typeof(RestoreJobDto), 200)] - [ApiPermission(Permissions.AdminRestoreRead)] + [ApiPermission(Permissions.AdminRestore)] public async Task GetJob() { var restoreGrain = grainFactory.GetGrain(SingleGrain.Id); @@ -67,7 +67,7 @@ namespace Squidex.Areas.Api.Controllers.Backups /// [HttpPost] [Route("apps/restore/")] - [ApiPermission(Permissions.AdminRestoreCreate)] + [ApiPermission(Permissions.AdminRestore)] public async Task PostRestore([FromBody] RestoreRequest request) { var restoreGrain = grainFactory.GetGrain(SingleGrain.Id); diff --git a/src/Squidex/Areas/Api/Controllers/Schemas/Models/FieldDto.cs b/src/Squidex/Areas/Api/Controllers/Schemas/Models/FieldDto.cs index d9eab980f..97ad65125 100644 --- a/src/Squidex/Areas/Api/Controllers/Schemas/Models/FieldDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Schemas/Models/FieldDto.cs @@ -7,10 +7,12 @@ using System.Collections.Generic; using System.ComponentModel.DataAnnotations; +using Squidex.Areas.Api.Controllers.Schemas.Models.Fields; +using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Schemas.Models { - public sealed class FieldDto + public sealed class FieldDto : Resource { /// /// The id of the field. @@ -55,5 +57,54 @@ namespace Squidex.Areas.Api.Controllers.Schemas.Models /// The nested fields. /// public List Nested { get; set; } + + public void CreateLinks(ApiController controller, string app, string schema, bool allowUpdate) + { + allowUpdate = allowUpdate && !IsLocked; + + if (allowUpdate) + { + var values = new { app, name = schema, id = FieldId }; + + AddPutLink("update", controller.Url(x => nameof(x.PutField), values)); + + if (IsHidden) + { + AddPutLink("show", controller.Url(x => nameof(x.ShowField), values)); + } + else + { + AddPutLink("hide", controller.Url(x => nameof(x.HideField), values)); + } + + if (IsDisabled) + { + AddPutLink("enable", controller.Url(x => nameof(x.EnableField), values)); + } + else + { + AddPutLink("show", controller.Url(x => nameof(x.DisableField), values)); + } + + if (Properties is ArrayFieldPropertiesDto) + { + AddPostLink("fields/add", controller.Url(x => nameof(x.PostNestedField), values)); + + AddPutLink("order", controller.Url(x => nameof(x.PutNestedFieldOrdering), values)); + } + + AddPutLink("lock", controller.Url(x => nameof(x.LockField), values)); + + AddDeleteLink("delete", controller.Url(x => nameof(x.DeleteField), values)); + } + + if (Nested != null) + { + foreach (var nested in Nested) + { + nested.CreateLinks(controller, app, schema, FieldId, allowUpdate); + } + } + } } } diff --git a/src/Squidex/Areas/Api/Controllers/Schemas/Models/NestedFieldDto.cs b/src/Squidex/Areas/Api/Controllers/Schemas/Models/NestedFieldDto.cs index 334c50376..580ea0220 100644 --- a/src/Squidex/Areas/Api/Controllers/Schemas/Models/NestedFieldDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Schemas/Models/NestedFieldDto.cs @@ -6,10 +6,11 @@ // ========================================================================== using System.ComponentModel.DataAnnotations; +using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Schemas.Models { - public sealed class NestedFieldDto + public sealed class NestedFieldDto : Resource { /// /// The id of the field. @@ -43,5 +44,39 @@ namespace Squidex.Areas.Api.Controllers.Schemas.Models /// [Required] public FieldPropertiesDto Properties { get; set; } + + public void CreateLinks(ApiController controller, string app, string schema, long parentId, bool allowUpdate) + { + allowUpdate = allowUpdate && !IsLocked; + + if (allowUpdate) + { + var values = new { app, name = schema, parentId, id = FieldId }; + + AddPutLink("update", controller.Url(x => nameof(x.PutNestedField), values)); + + if (IsHidden) + { + AddPutLink("show", controller.Url(x => nameof(x.ShowNestedField), values)); + } + else + { + AddPutLink("hide", controller.Url(x => nameof(x.HideNestedField), values)); + } + + if (IsDisabled) + { + AddPutLink("enable", controller.Url(x => nameof(x.EnableNestedField), values)); + } + else + { + AddPutLink("show", controller.Url(x => nameof(x.DisableNestedField), values)); + } + + AddPutLink("lock", controller.Url(x => nameof(x.LockNestedField), values)); + + AddDeleteLink("delete", controller.Url(x => nameof(x.DeleteNestedField), values)); + } + } } } diff --git a/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDetailsDto.cs b/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDetailsDto.cs index b71e85280..716dc5ad0 100644 --- a/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDetailsDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDetailsDto.cs @@ -11,6 +11,7 @@ using Squidex.Areas.Api.Controllers.Schemas.Models.Converters; using Squidex.Domain.Apps.Core.Schemas; using Squidex.Domain.Apps.Entities.Schemas; using Squidex.Infrastructure.Reflection; +using Squidex.Shared; using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Schemas.Models @@ -85,7 +86,24 @@ namespace Squidex.Areas.Api.Controllers.Schemas.Models result.Fields.Add(fieldDto); } - return (SchemaDetailsDto)result.CreateLinks(controller, app); + result.CreateLinks(controller, app); + + return result; + } + + protected override void CreateLinks(ApiController controller, string app) + { + base.CreateLinks(controller, app); + + var allowUpdate = controller.HasPermission(Permissions.AppSchemasUpdate, app, Name); + + if (Fields != null) + { + foreach (var nested in Fields) + { + nested.CreateLinks(controller, app, Name, allowUpdate); + } + } } } } diff --git a/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDto.cs b/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDto.cs index 7ae0addad..7a48b73d9 100644 --- a/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDto.cs @@ -87,13 +87,17 @@ namespace Squidex.Areas.Api.Controllers.Schemas.Models SimpleMapper.Map(schema.SchemaDef, result); SimpleMapper.Map(schema.SchemaDef.Properties, result.Properties); - return result.CreateLinks(controller, app); + result.CreateLinks(controller, app); + + return result; } - protected virtual SchemaDto CreateLinks(ApiController controller, string app) + protected virtual void CreateLinks(ApiController controller, string app) { var values = new { app, name = Name }; + var allowUpdate = controller.HasPermission(Permissions.AppSchemasUpdate, app, Name); + AddSelfLink(controller.Url(x => nameof(x.GetSchema), values)); if (controller.HasPermission(Permissions.AppContentsRead, app, Name)) @@ -101,7 +105,39 @@ namespace Squidex.Areas.Api.Controllers.Schemas.Models AddGetLink("contents", controller.Url(x => nameof(x.GetContents), values)); } - return this; + if (controller.HasPermission(Permissions.AppSchemasPublish, app, Name)) + { + if (IsPublished) + { + AddPutLink("unpublish", controller.Url(x => nameof(x.UnpublishSchema), values)); + } + else + { + AddPutLink("publish", controller.Url(x => nameof(x.PublishSchema), values)); + } + } + + if (allowUpdate) + { + AddPutLink("order", controller.Url(x => nameof(x.PutSchemaFieldOrdering), values)); + + AddPutLink("update", controller.Url(x => nameof(x.PutSchema), values)); + AddPutLink("update/category", controller.Url(x => nameof(x.PutCategory), values)); + AddPutLink("update/sync", controller.Url(x => nameof(x.PutSchemaSync), values)); + AddPutLink("update/urls", controller.Url(x => nameof(x.PutPreviewUrls), values)); + + AddPostLink("fields/add", controller.Url(x => nameof(x.PostField), values)); + } + + if (controller.HasPermission(Permissions.AppSchemasScripts, app, Name)) + { + AddPutLink("update/scripts", controller.Url(x => nameof(x.PutScripts), values)); + } + + if (controller.HasPermission(Permissions.AppSchemasDelete, app, Name)) + { + AddDeleteLink("delete", controller.Url(x => nameof(x.DeleteSchema), values)); + } } } } diff --git a/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemasDto.cs b/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemasDto.cs index 8fb9755fa..596c80d07 100644 --- a/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemasDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemasDto.cs @@ -9,6 +9,7 @@ using System.Collections.Generic; using System.Linq; using Squidex.Domain.Apps.Entities.Schemas; using Squidex.Infrastructure; +using Squidex.Shared; using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Schemas.Models @@ -37,6 +38,15 @@ namespace Squidex.Areas.Api.Controllers.Schemas.Models private SchemasDto CreateLinks(ApiController controller, string app) { + var values = new { app }; + + AddSelfLink(controller.Url(x => nameof(x.GetSchemas), values)); + + if (controller.HasPermission(Permissions.AppSchemasCreate, app)) + { + AddPostLink("create", controller.Url(x => nameof(x.PostSchema), values)); + } + return this; } } diff --git a/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs b/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs index 854b24f57..331793b5e 100644 --- a/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs +++ b/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs @@ -242,7 +242,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppSchemasScripts)] [ApiCosts(1)] - public async Task PutSchemaScripts(string app, string name, [FromBody] SchemaScriptsDto request) + public async Task PutScripts(string app, string name, [FromBody] SchemaScriptsDto request) { var command = request.ToCommand(); diff --git a/src/Squidex/Areas/Api/Controllers/Users/Models/ResourcesDto.cs b/src/Squidex/Areas/Api/Controllers/Users/Models/ResourcesDto.cs index 885b4fba4..0b5fa32b2 100644 --- a/src/Squidex/Areas/Api/Controllers/Users/Models/ResourcesDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Users/Models/ResourcesDto.cs @@ -22,14 +22,12 @@ namespace Squidex.Areas.Api.Controllers.Users.Models result.AddGetLink("ping", controller.Url(x => nameof(x.GetPing))); - result.AddGetLink("languages", controller.Url(x => nameof(x.GetLanguages))); - if (controller.HasPermission(Permissions.AdminEventsRead)) { - result.AddGetLink("admin/eventConsumers", controller.Url(x => nameof(x.GetEventConsumers))); + result.AddGetLink("admin/events", controller.Url(x => nameof(x.GetEventConsumers))); } - if (controller.HasPermission(Permissions.AdminRestoreRead)) + if (controller.HasPermission(Permissions.AdminRestore)) { result.AddGetLink("admin/restore", controller.Url(x => nameof(x.GetJob))); } @@ -39,6 +37,8 @@ namespace Squidex.Areas.Api.Controllers.Users.Models result.AddGetLink("admin/users", controller.Url(x => nameof(x.GetUsers))); } + result.AddGetLink("languages", controller.Url(x => nameof(x.GetLanguages))); + return result; } } diff --git a/src/Squidex/app/features/administration/pages/users/user-page.component.ts b/src/Squidex/app/features/administration/pages/users/user-page.component.ts index 069c71789..83b2cef3d 100644 --- a/src/Squidex/app/features/administration/pages/users/user-page.component.ts +++ b/src/Squidex/app/features/administration/pages/users/user-page.component.ts @@ -9,7 +9,7 @@ import { Component, OnInit } from '@angular/core'; import { FormBuilder } from '@angular/forms'; import { ActivatedRoute, Router } from '@angular/router'; -import { hasLink, ResourceOwner } from '@app/shared'; +import { hasAnyLink, ResourceOwner } from '@app/shared'; import { CreateUserDto, @@ -47,7 +47,7 @@ export class UserPageComponent extends ResourceOwner implements OnInit { if (selectedUser) { this.userForm.load(selectedUser); - this.isEditable = hasLink(this.user, 'update'); + this.isEditable = hasAnyLink(this.user, 'update'); if (!this.isEditable) { this.userForm.form.disable(); diff --git a/src/Squidex/app/features/content/pages/schemas/schemas-page.component.html b/src/Squidex/app/features/content/pages/schemas/schemas-page.component.html index a270463cd..ec3ffec5c 100644 --- a/src/Squidex/app/features/content/pages/schemas/schemas-page.component.html +++ b/src/Squidex/app/features/content/pages/schemas/schemas-page.component.html @@ -22,7 +22,7 @@ [schemas]="schemas" [schemasFilter]="schemasFilter.valueChanges | async" [routeSingletonToContent]="true" - [isReadonly]="true"> + [forContent]="true"> diff --git a/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.ts b/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.ts index a7e1e14a4..7b7252549 100644 --- a/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.ts +++ b/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.ts @@ -10,7 +10,7 @@ import { FormGroup } from '@angular/forms'; import { Form, - hasLink, + hasAnyLink, ImmutableArray, RuleDto, RuleElementDto, @@ -64,7 +64,7 @@ export class RuleWizardComponent implements AfterViewInit, OnInit { } public ngOnInit() { - this.isEditable = !this.rule || hasLink(this.rule, 'update'); + this.isEditable = !this.rule || hasAnyLink(this.rule, 'update'); if (this.mode === MODE_EDIT_ACTION) { this.step = 4; diff --git a/src/Squidex/app/features/schemas/pages/schema/field.component.html b/src/Squidex/app/features/schemas/pages/schema/field.component.html index 1858af5e6..b07a71279 100644 --- a/src/Squidex/app/features/schemas/pages/schema/field.component.html +++ b/src/Squidex/app/features/schemas/pages/schema/field.component.html @@ -81,6 +81,7 @@ [patterns]="patterns" [editForm]="editForm.form" [editFormSubmitted]="editForm.submitted | async" + [isEditable]="isEditable" [field]="field"> @@ -90,7 +91,10 @@ -
+
diff --git a/src/Squidex/app/features/schemas/pages/schema/schema-page.component.html b/src/Squidex/app/features/schemas/pages/schema/schema-page.component.html index 3fe3ea41b..8a76a5c1c 100644 --- a/src/Squidex/app/features/schemas/pages/schema/schema-page.component.html +++ b/src/Squidex/app/features/schemas/pages/schema/schema-page.component.html @@ -31,11 +31,13 @@ Edit Preview Urls -
- - - Clone - + +
+ + + Clone + +
@@ -63,14 +65,14 @@
No field created yet. -
@@ -78,7 +80,7 @@
- diff --git a/src/Squidex/app/features/schemas/pages/schemas/schemas-page.component.html b/src/Squidex/app/features/schemas/pages/schemas/schemas-page.component.html index a1b82746f..d3305eeb2 100644 --- a/src/Squidex/app/features/schemas/pages/schemas/schemas-page.component.html +++ b/src/Squidex/app/features/schemas/pages/schemas/schemas-page.component.html @@ -6,12 +6,18 @@ - - + + + + +
diff --git a/src/Squidex/app/features/settings/pages/languages/language.component.html b/src/Squidex/app/features/settings/pages/languages/language.component.html index b8deb6e3c..a446ca2c1 100644 --- a/src/Squidex/app/features/settings/pages/languages/language.component.html +++ b/src/Squidex/app/features/settings/pages/languages/language.component.html @@ -39,7 +39,10 @@
-
+
diff --git a/src/Squidex/app/framework/angular/sorted.directive.ts b/src/Squidex/app/framework/angular/sorted.directive.ts index 3629eb1f7..d02c77797 100644 --- a/src/Squidex/app/framework/angular/sorted.directive.ts +++ b/src/Squidex/app/framework/angular/sorted.directive.ts @@ -5,16 +5,17 @@ * Copyright (c) Squidex UG (haftungsbeschränkt). All rights reserved. */ -import { Directive, ElementRef, EventEmitter, Input, OnDestroy, OnInit, Output } from '@angular/core'; +import { Directive, ElementRef, EventEmitter, Input, OnChanges, OnDestroy, OnInit, Output } from '@angular/core'; import * as Sortable from 'sortablejs'; +const DEFAULT_PROPS = { sort: true, animation: 150 }; + @Directive({ selector: '[sqxSortModel]' }) -export class SortedDirective implements OnDestroy, OnInit { +export class SortedDirective implements OnChanges, OnDestroy, OnInit { private sortable: Sortable.Ref; - private isDisabled: boolean; @Input() public dragHandle = '.drag-handle'; @@ -25,20 +26,20 @@ export class SortedDirective implements OnDestroy, OnInit { @Output('sqxSort') public sort = new EventEmitter(); - @Input('disabled') - public setDisabled(value: boolean) { - this.isDisabled = value; - - if (this.sortable) { - this.sortable.option('disabled', value); - } - } + @Input('sqxSortDisabled') + public isDisabled = false; constructor( private readonly elementRef: ElementRef ) { } + public ngOnChanges() { + if (this.sortable) { + this.sortable.option('disabled', this.isDisabled); + } + } + public ngOnDestroy() { if (this.sortable) { this.sortable.destroy(); @@ -47,8 +48,7 @@ export class SortedDirective implements OnDestroy, OnInit { public ngOnInit() { this.sortable = Sortable.create(this.elementRef.nativeElement, { - sort: true, - animation: 150, + ...DEFAULT_PROPS, onSort: (event: { oldIndex: number, newIndex: number }) => { if (this.sortModel && event.newIndex !== event.oldIndex) { @@ -63,9 +63,9 @@ export class SortedDirective implements OnDestroy, OnInit { } }, - isDisabled: this.isDisabled, - handle: this.dragHandle }); + + this.sortable.option('disabled', this.isDisabled); } } \ No newline at end of file diff --git a/src/Squidex/app/framework/utils/hateos.ts b/src/Squidex/app/framework/utils/hateos.ts index ed1e3f9a0..e459c0dc8 100644 --- a/src/Squidex/app/framework/utils/hateos.ts +++ b/src/Squidex/app/framework/utils/hateos.ts @@ -48,7 +48,7 @@ export function withLinks(value: T, source: Resource) { return value; } -export function hasLink(value: Resource | ResourceLinks, rel: string): boolean { +function hasLink(value: Resource | ResourceLinks, rel: string): boolean { const link = getLink(value, rel); return !!(link && link.method && link.href); diff --git a/src/Squidex/app/shared/components/asset-dialog.component.ts b/src/Squidex/app/shared/components/asset-dialog.component.ts index e5d14c0db..729173dfe 100644 --- a/src/Squidex/app/shared/components/asset-dialog.component.ts +++ b/src/Squidex/app/shared/components/asset-dialog.component.ts @@ -13,7 +13,7 @@ import { AppsState, AssetDto, AssetsService, - hasLink, + hasAnyLink, StatefulComponent } from '@app/shared/internal'; @@ -55,7 +55,7 @@ export class AssetDialogComponent extends StatefulComponent implements OnInit { public ngOnInit() { this.annotateForm.load(this.asset); - this.isReadOnly = !hasLink(this.asset, 'update'); + this.isReadOnly = !hasAnyLink(this.asset, 'update'); if (this.isReadOnly) { this.annotateForm.form.disable(); diff --git a/src/Squidex/app/shared/components/asset.component.ts b/src/Squidex/app/shared/components/asset.component.ts index aab3ee5c5..3c697f38b 100644 --- a/src/Squidex/app/shared/components/asset.component.ts +++ b/src/Squidex/app/shared/components/asset.component.ts @@ -13,7 +13,7 @@ import { DialogModel, DialogService, fadeAnimation, - hasLink, + hasAnyLink, StatefulComponent, Types, UploadCanceled @@ -113,7 +113,7 @@ export class AssetComponent extends StatefulComponent implements OnInit { } public updateFile(files: FileList) { - if (files.length === 1 && hasLink(this.asset, 'upload')) { + if (files.length === 1 && hasAnyLink(this.asset, 'upload')) { this.setProgress(1); this.assetUploader.uploadAsset(this.asset, files[0]) diff --git a/src/Squidex/app/shared/components/schema-category.component.html b/src/Squidex/app/shared/components/schema-category.component.html index 12025b426..67e1fe40d 100644 --- a/src/Squidex/app/shared/components/schema-category.component.html +++ b/src/Squidex/app/shared/components/schema-category.component.html @@ -15,29 +15,29 @@
+ + + {{schema.displayName}} + + +
diff --git a/src/Squidex/app/shared/components/schema-category.component.ts b/src/Squidex/app/shared/components/schema-category.component.ts index 569d37749..67e2ac57d 100644 --- a/src/Squidex/app/shared/components/schema-category.component.ts +++ b/src/Squidex/app/shared/components/schema-category.component.ts @@ -9,6 +9,7 @@ import { ChangeDetectionStrategy, ChangeDetectorRef, Component, EventEmitter, In import { fadeAnimation, + hasAnyLink, ImmutableArray, LocalStoreService, SchemaDetailsDto, @@ -41,7 +42,7 @@ export class SchemaCategoryComponent extends StatefulComponent implements public name: string; @Input() - public isReadonly: boolean; + public forContent: boolean; @Input() public routeSingletonToContent = false; @@ -122,7 +123,7 @@ export class SchemaCategoryComponent extends StatefulComponent implements } private isSameCategory(schema: SchemaDto): boolean { - return (!this.name && !schema.category) || schema.category === this.name; + return ((!this.name && !schema.category) || schema.category === this.name) && (!this.forContent || hasAnyLink(schema, 'contents')); } public changeCategory(schema: SchemaDto) { @@ -137,10 +138,6 @@ export class SchemaCategoryComponent extends StatefulComponent implements return schema.id; } - public schemaPermission(schema: SchemaDto) { - return `?squidex.apps.{app}.schemas.${schema.name}.*;squidex.apps.{app}.contents.${schema.name}.*`; - } - private configKey(): string { return `squidex.schema.category.${this.name}.closed`; } diff --git a/src/Squidex/app/shared/services/schemas.service.spec.ts b/src/Squidex/app/shared/services/schemas.service.spec.ts index 94d094e2f..aecec8329 100644 --- a/src/Squidex/app/shared/services/schemas.service.spec.ts +++ b/src/Squidex/app/shared/services/schemas.service.spec.ts @@ -167,7 +167,7 @@ describe('SchemasService', () => { const resource: Resource = { _links: { - updateScripts: { method: 'PUT', href: '/api/apps/my-app/schemas/my-schema/scripts' } + ['update/scripts']: { method: 'PUT', href: '/api/apps/my-app/schemas/my-schema/scripts' } } }; @@ -260,7 +260,7 @@ describe('SchemasService', () => { const resource: Resource = { _links: { - addField: { method: 'POST', href: '/api/apps/my-app/schemas/my-schema/fields' } + ['fields/add']: { method: 'POST', href: '/api/apps/my-app/schemas/my-schema/fields' } } }; diff --git a/src/Squidex/app/shared/services/schemas.service.ts b/src/Squidex/app/shared/services/schemas.service.ts index 4b40c16db..235171557 100644 --- a/src/Squidex/app/shared/services/schemas.service.ts +++ b/src/Squidex/app/shared/services/schemas.service.ts @@ -250,7 +250,7 @@ export class SchemasService { } public putScripts(appName: string, resource: Resource, dto: {}, version: Version): Observable { - const link = resource._links['updateScripts']; + const link = resource._links['update/scripts']; const url = this.apiUrl.buildUrl(link.href); @@ -340,7 +340,7 @@ export class SchemasService { } public postField(appName: string, resource: Resource, dto: AddFieldDto, version: Version): Observable { - const link = resource._links['addField']; + const link = resource._links['fields/add']; const url = this.apiUrl.buildUrl(link.href); @@ -503,26 +503,30 @@ function parseSchemaWithDetails(response: any, version: Version) { nestedItem.properties.fieldType, nestedItem.properties); - return new NestedFieldDto( - nestedItem.fieldId, - nestedItem.name, - nestedPropertiesDto, - item.fieldId, - nestedItem.isLocked, - nestedItem.isHidden, - nestedItem.isDisabled); + return withLinks( + new NestedFieldDto( + nestedItem.fieldId, + nestedItem.name, + nestedPropertiesDto, + item.fieldId, + nestedItem.isLocked, + nestedItem.isHidden, + nestedItem.isDisabled), + nestedItem); }); } - return new RootFieldDto( - item.fieldId, - item.name, - propertiesDto, - item.partitioning, - item.isLocked, - item.isHidden, - item.isDisabled, - nested || []); + return withLinks( + new RootFieldDto( + item.fieldId, + item.name, + propertiesDto, + item.partitioning, + item.isLocked, + item.isHidden, + item.isDisabled, + nested || []), + item); }); const properties = new SchemaPropertiesDto(response.properties.label, response.properties.hints); diff --git a/tests/Squidex.Web.Tests/ApiPermissionAttributeTests.cs b/tests/Squidex.Web.Tests/ApiPermissionAttributeTests.cs index 07297b7a6..9b95902d9 100644 --- a/tests/Squidex.Web.Tests/ApiPermissionAttributeTests.cs +++ b/tests/Squidex.Web.Tests/ApiPermissionAttributeTests.cs @@ -63,7 +63,7 @@ namespace Squidex.Web user.AddClaim(new Claim(SquidexClaimTypes.Permissions, "squidex.apps.my-app")); - var sut = new ApiPermissionAttribute(Permissions.AppSchemasRead); + var sut = new ApiPermissionAttribute(Permissions.AppSchemasCreate); await sut.OnActionExecutionAsync(actionExecutingContext, next); @@ -78,7 +78,7 @@ namespace Squidex.Web user.AddClaim(new Claim(SquidexClaimTypes.Permissions, "squidex.apps.other-app")); - var sut = new ApiPermissionAttribute(Permissions.AppSchemasRead); + var sut = new ApiPermissionAttribute(Permissions.AppSchemasCreate); await sut.OnActionExecutionAsync(actionExecutingContext, next); @@ -91,7 +91,7 @@ namespace Squidex.Web { user.AddClaim(new Claim(SquidexClaimTypes.Permissions, "squidex.apps.other-app")); - var sut = new ApiPermissionAttribute(Permissions.AppSchemasRead); + var sut = new ApiPermissionAttribute(Permissions.AppSchemasCreate); await sut.OnActionExecutionAsync(actionExecutingContext, next); @@ -102,7 +102,7 @@ namespace Squidex.Web [Fact] public async Task Should_return_forbidden_when_user_has_no_permission() { - var sut = new ApiPermissionAttribute(Permissions.AppSchemasRead); + var sut = new ApiPermissionAttribute(Permissions.AppSchemasCreate); await sut.OnActionExecutionAsync(actionExecutingContext, next); From 11272093cd0b5b6433a488a3b2140ce9f90100ed Mon Sep 17 00:00:00 2001 From: Sebastian Stehle Date: Sat, 15 Jun 2019 16:24:38 +0200 Subject: [PATCH 18/64] Tests fixed. --- .../Controllers/Schemas/SchemasController.cs | 1 - .../AppsByUserIndexCommandMiddlewareTests.cs | 4 +- .../Apps/RolePermissionsProviderTests.cs | 6 +- .../Assets/AssetCommandMiddlewareTests.cs | 4 +- .../Schemas/SchemaGrainTests.cs | 66 ++++++++----------- 5 files changed, 36 insertions(+), 45 deletions(-) diff --git a/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs b/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs index 331793b5e..032a834bf 100644 --- a/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs +++ b/src/Squidex/Areas/Api/Controllers/Schemas/SchemasController.cs @@ -13,7 +13,6 @@ using Squidex.Areas.Api.Controllers.Schemas.Models; using Squidex.Domain.Apps.Entities; using Squidex.Domain.Apps.Entities.Schemas; using Squidex.Domain.Apps.Entities.Schemas.Commands; -using Squidex.Infrastructure; using Squidex.Infrastructure.Commands; using Squidex.Shared; using Squidex.Web; diff --git a/tests/Squidex.Domain.Apps.Entities.Tests/Apps/Indexes/AppsByUserIndexCommandMiddlewareTests.cs b/tests/Squidex.Domain.Apps.Entities.Tests/Apps/Indexes/AppsByUserIndexCommandMiddlewareTests.cs index 7fba44816..6d164d38e 100644 --- a/tests/Squidex.Domain.Apps.Entities.Tests/Apps/Indexes/AppsByUserIndexCommandMiddlewareTests.cs +++ b/tests/Squidex.Domain.Apps.Entities.Tests/Apps/Indexes/AppsByUserIndexCommandMiddlewareTests.cs @@ -52,8 +52,8 @@ namespace Squidex.Domain.Apps.Entities.Apps.Indexes public async Task Should_add_app_to_index_on_assign_of_contributor() { var context = - new CommandContext(new AssignContributor { AppId = appId }, commandBus) - .Complete(EntityCreatedResult.Create(userId, 1)); + new CommandContext(new AssignContributor { AppId = appId, ContributorId = userId }, commandBus) + .Complete(); await sut.HandleAsync(context); diff --git a/tests/Squidex.Domain.Apps.Entities.Tests/Apps/RolePermissionsProviderTests.cs b/tests/Squidex.Domain.Apps.Entities.Tests/Apps/RolePermissionsProviderTests.cs index dbee889b1..fa7fe1d98 100644 --- a/tests/Squidex.Domain.Apps.Entities.Tests/Apps/RolePermissionsProviderTests.cs +++ b/tests/Squidex.Domain.Apps.Entities.Tests/Apps/RolePermissionsProviderTests.cs @@ -44,9 +44,9 @@ namespace Squidex.Domain.Apps.Entities.Apps Assert.True(result.Contains("*")); Assert.True(result.Contains("clients.read")); - Assert.True(result.Contains("schemas.*.read")); - Assert.True(result.Contains("schemas.schema1.read")); - Assert.True(result.Contains("schemas.schema2.read")); + Assert.True(result.Contains("schemas.*.update")); + Assert.True(result.Contains("schemas.schema1.update")); + Assert.True(result.Contains("schemas.schema2.update")); } private static ISchemaEntity CreateSchema(string name) diff --git a/tests/Squidex.Domain.Apps.Entities.Tests/Assets/AssetCommandMiddlewareTests.cs b/tests/Squidex.Domain.Apps.Entities.Tests/Assets/AssetCommandMiddlewareTests.cs index ee40fbd6e..21df10911 100644 --- a/tests/Squidex.Domain.Apps.Entities.Tests/Assets/AssetCommandMiddlewareTests.cs +++ b/tests/Squidex.Domain.Apps.Entities.Tests/Assets/AssetCommandMiddlewareTests.cs @@ -77,8 +77,8 @@ namespace Squidex.Domain.Apps.Entities.Assets var result = context.Result(); Assert.Equal(assetId, result.Asset.Id); - Assert.Contains("tag1", result.Asset.Tags); - Assert.Contains("tag2", result.Asset.Tags); + Assert.Contains("tag1", command.Tags); + Assert.Contains("tag2", command.Tags); AssertAssetHasBeenUploaded(0, context.ContextId); AssertAssetImageChecked(); diff --git a/tests/Squidex.Domain.Apps.Entities.Tests/Schemas/SchemaGrainTests.cs b/tests/Squidex.Domain.Apps.Entities.Tests/Schemas/SchemaGrainTests.cs index f53d726ba..e9f12b52b 100644 --- a/tests/Squidex.Domain.Apps.Entities.Tests/Schemas/SchemaGrainTests.cs +++ b/tests/Squidex.Domain.Apps.Entities.Tests/Schemas/SchemaGrainTests.cs @@ -65,7 +65,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(EntityCreatedResult.Create(Id, 0)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(AppId, sut.Snapshot.AppId.Id); @@ -105,7 +105,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(EntityCreatedResult.Create(Id, 0)); + result.ShouldBeEquivalent(sut.Snapshot); var @event = (SchemaCreated)LastEvents.Single().Payload; @@ -125,7 +125,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(1)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(command.Properties, sut.Snapshot.SchemaDef.Properties); @@ -150,7 +150,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(1)); + result.ShouldBeEquivalent(sut.Snapshot); LastEvents .ShouldHaveSameEvents( @@ -167,7 +167,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(1)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.True(sut.Snapshot.SchemaDef.IsPublished); @@ -187,7 +187,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(2)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.False(sut.Snapshot.SchemaDef.IsPublished); @@ -206,7 +206,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(1)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(command.Name, sut.Snapshot.SchemaDef.Category); @@ -231,7 +231,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(1)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(command.PreviewUrls, sut.Snapshot.SchemaDef.PreviewUrls); @@ -271,7 +271,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(3)); + result.ShouldBeEquivalent(sut.Snapshot); LastEvents .ShouldHaveSameEvents( @@ -291,7 +291,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(4)); + result.ShouldBeEquivalent(sut.Snapshot); LastEvents .ShouldHaveSameEvents( @@ -308,7 +308,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(EntityCreatedResult.Create(1, 1)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(command.Properties, GetField(1).RawProperties); @@ -328,10 +328,9 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(EntityCreatedResult.Create(2, 2)); + result.ShouldBeEquivalent(sut.Snapshot); - Assert.NotEqual(command.Properties, GetField(1).RawProperties); - Assert.Equal(command.Properties, GetNestedField(1, 2).RawProperties); + Assert.Same(command.Properties, GetNestedField(1, 2).RawProperties); LastEvents .ShouldHaveSameEvents( @@ -349,7 +348,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(2)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(command.Properties, GetField(1).RawProperties); @@ -370,10 +369,9 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(3)); + result.ShouldBeEquivalent(sut.Snapshot); - Assert.NotEqual(command.Properties, GetField(1).RawProperties); - Assert.Equal(command.Properties, GetNestedField(1, 2).RawProperties); + Assert.Same(command.Properties, GetNestedField(1, 2).RawProperties); LastEvents .ShouldHaveSameEvents( @@ -391,7 +389,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(2)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.False(GetField(1).IsDisabled); @@ -412,9 +410,8 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(3)); + result.ShouldBeEquivalent(sut.Snapshot); - Assert.False(GetField(1).IsLocked); Assert.True(GetNestedField(1, 2).IsLocked); LastEvents @@ -433,7 +430,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(2)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.True(GetField(1).IsHidden); @@ -454,9 +451,8 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(3)); + result.ShouldBeEquivalent(sut.Snapshot); - Assert.False(GetField(1).IsHidden); Assert.True(GetNestedField(1, 2).IsHidden); LastEvents @@ -476,7 +472,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(3)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.False(GetField(1).IsHidden); @@ -498,9 +494,8 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(4)); + result.ShouldBeEquivalent(sut.Snapshot); - Assert.False(GetField(1).IsHidden); Assert.False(GetNestedField(1, 2).IsHidden); LastEvents @@ -519,7 +514,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(2)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.True(GetField(1).IsDisabled); @@ -540,9 +535,8 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(3)); + result.ShouldBeEquivalent(sut.Snapshot); - Assert.False(GetField(1).IsDisabled); Assert.True(GetNestedField(1, 2).IsDisabled); LastEvents @@ -562,7 +556,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(3)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.False(GetField(1).IsDisabled); @@ -584,9 +578,8 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(4)); + result.ShouldBeEquivalent(sut.Snapshot); - Assert.False(GetField(1).IsDisabled); Assert.False(GetNestedField(1, 2).IsDisabled); LastEvents @@ -605,7 +598,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(2)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Null(GetField(1)); @@ -626,9 +619,8 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(3)); + result.ShouldBeEquivalent(sut.Snapshot); - Assert.NotNull(GetField(1)); Assert.Null(GetNestedField(1, 2)); LastEvents @@ -661,7 +653,7 @@ namespace Squidex.Domain.Apps.Entities.Schemas var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(4)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.NotNull(GetField(1)); Assert.Equal(command.Category, sut.Snapshot.SchemaDef.Category); From 33b59e45b24bdacf9c60aaa9525d02d9744b14fb Mon Sep 17 00:00:00 2001 From: Sebastian Stehle Date: Sun, 16 Jun 2019 13:07:05 +0200 Subject: [PATCH 19/64] Progress with contents. --- .../Contents/StatusFlow.cs | 5 + .../Contents/ContentGrain.cs | 17 +- src/Squidex.Shared/Permissions.cs | 5 +- .../Contents/ContentsController.cs | 164 +++--------- .../Generator/SchemaSwaggerGenerator.cs | 6 - .../Areas/Api/Controllers/Contents/Helper.cs | 23 ++ .../Contents/Models/ChangeStatusDto.cs | 34 +++ .../Controllers/Contents/Models/ContentDto.cs | 77 ++++-- .../Contents/Models/ContentsDto.cs | 33 ++- .../pages/content/content-page.component.html | 57 ++--- .../pages/content/content-page.component.ts | 27 +- .../contents/contents-page.component.html | 27 +- .../pages/contents/contents-page.component.ts | 59 ++--- .../content/shared/content-item.component.ts | 27 +- .../shared/services/contents.service.spec.ts | 234 +++++++++--------- .../app/shared/services/contents.service.ts | 176 +++++++------ .../app/shared/state/contents.state.ts | 127 +++------- 17 files changed, 477 insertions(+), 621 deletions(-) create mode 100644 src/Squidex/Areas/Api/Controllers/Contents/Helper.cs create mode 100644 src/Squidex/Areas/Api/Controllers/Contents/Models/ChangeStatusDto.cs diff --git a/src/Squidex.Domain.Apps.Core.Model/Contents/StatusFlow.cs b/src/Squidex.Domain.Apps.Core.Model/Contents/StatusFlow.cs index 005b2d4b3..7add93c24 100644 --- a/src/Squidex.Domain.Apps.Core.Model/Contents/StatusFlow.cs +++ b/src/Squidex.Domain.Apps.Core.Model/Contents/StatusFlow.cs @@ -28,5 +28,10 @@ namespace Squidex.Domain.Apps.Core.Contents { return Flow.TryGetValue(status, out var state) && state.Contains(toStatus); } + + public static IEnumerable Next(Status status) + { + return Flow.TryGetValue(status, out var result) ? result : Enumerable.Empty(); + } } } diff --git a/src/Squidex.Domain.Apps.Entities/Contents/ContentGrain.cs b/src/Squidex.Domain.Apps.Entities/Contents/ContentGrain.cs index 5adf76236..104e0fa1d 100644 --- a/src/Squidex.Domain.Apps.Entities/Contents/ContentGrain.cs +++ b/src/Squidex.Domain.Apps.Entities/Contents/ContentGrain.cs @@ -81,7 +81,7 @@ namespace Squidex.Domain.Apps.Entities.Contents Create(c); - return EntityCreatedResult.Create(c.Data, Version); + return await GetRawStateAsync(); }); case UpdateContent updateContent: @@ -101,7 +101,7 @@ namespace Squidex.Domain.Apps.Entities.Contents }); case ChangeContentStatus changeContentStatus: - return UpdateAsync(changeContentStatus, async c => + return UpdateReturnAsync(changeContentStatus, async c => { try { @@ -157,6 +157,8 @@ namespace Squidex.Domain.Apps.Entities.Contents throw; } } + + return await GetRawStateAsync(); }); case DeleteContent deleteContent: @@ -172,11 +174,13 @@ namespace Squidex.Domain.Apps.Entities.Contents }); case DiscardChanges discardChanges: - return UpdateAsync(discardChanges, c => + return UpdateReturnAsync(discardChanges, async c => { GuardContent.CanDiscardChanges(Snapshot.IsPending, c); DiscardChanges(c); + + return await GetRawStateAsync(); }); default: @@ -220,7 +224,7 @@ namespace Squidex.Domain.Apps.Entities.Contents } } - return new ContentDataChangedResult(newData, Version); + return Snapshot; } public void Create(CreateContent command) @@ -305,6 +309,11 @@ namespace Squidex.Domain.Apps.Entities.Contents return operationContext; } + public Task GetRawStateAsync() + { + return Task.FromResult(Snapshot); + } + public Task> GetStateAsync(long version = EtagVersion.Any) { return J.AsTask(GetSnapshot(version)); diff --git a/src/Squidex.Shared/Permissions.cs b/src/Squidex.Shared/Permissions.cs index 98cb299c0..7118a0604 100644 --- a/src/Squidex.Shared/Permissions.cs +++ b/src/Squidex.Shared/Permissions.cs @@ -115,11 +115,8 @@ namespace Squidex.Shared public const string AppContentsRead = "squidex.apps.{app}.contents.{name}.read"; public const string AppContentsCreate = "squidex.apps.{app}.contents.{name}.create"; public const string AppContentsUpdate = "squidex.apps.{app}.contents.{name}.update"; + public const string AppContentsStatus = "squidex.apps.{app}.contents.{name}.status.{status}"; public const string AppContentsDiscard = "squidex.apps.{app}.contents.{name}.discard"; - public const string AppContentsArchive = "squidex.apps.{app}.contents.{name}.archive"; - public const string AppContentsRestore = "squidex.apps.{app}.contents.{name}.restore"; - public const string AppContentsPublish = "squidex.apps.{app}.contents.{name}.publish"; - public const string AppContentsUnpublish = "squidex.apps.{app}.contents.{name}.unpublish"; public const string AppContentsDelete = "squidex.apps.{app}.contents.{name}.delete"; public const string AppApi = "squidex.apps.{app}.api"; diff --git a/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs b/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs index 66264dcb4..2a893b573 100644 --- a/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs @@ -10,8 +10,6 @@ using System.Threading.Tasks; using Microsoft.AspNetCore.Mvc; using Microsoft.Extensions.Options; using Microsoft.Net.Http.Headers; -using NodaTime; -using NodaTime.Text; using Squidex.Areas.Api.Controllers.Contents.Models; using Squidex.Domain.Apps.Core.Contents; using Squidex.Domain.Apps.Entities; @@ -127,7 +125,7 @@ namespace Squidex.Areas.Api.Controllers.Contents var result = await contentQuery.QueryAsync(context, Q.Empty.WithIds(ids).Ids); - var response = ContentsDto.FromContents(result, context, this, app); + var response = ContentsDto.FromContents(result, context, this, app, null); if (controllerOptions.Value.EnableSurrogateKeys && response.Items.Length <= controllerOptions.Value.MaxItemsForSurrogateKeys) { @@ -163,9 +161,9 @@ namespace Squidex.Areas.Api.Controllers.Contents var result = await contentQuery.QueryAsync(context, name, Q.Empty.WithIds(ids).WithODataQuery(Request.QueryString.ToString())); - var response = ContentsDto.FromContents(result, context, this, app); + var response = ContentsDto.FromContents(result, context, this, app, name); - if (controllerOptions.Value.EnableSurrogateKeys && response.Items.Length <= controllerOptions.Value.MaxItemsForSurrogateKeys) + if (ShouldProvideSurrogateKeys(response)) { Response.Headers["Surrogate-Key"] = response.ToSurrogateKeys(); } @@ -197,7 +195,7 @@ namespace Squidex.Areas.Api.Controllers.Contents var context = Context(); var content = await contentQuery.FindContentAsync(context, name, id); - var response = ContentDto.FromContent(content, context, this, app); + var response = ContentDto.FromContent(content, context, this, app, name); if (controllerOptions.Value.EnableSurrogateKeys) { @@ -233,7 +231,7 @@ namespace Squidex.Areas.Api.Controllers.Contents var context = Context(); var content = await contentQuery.FindContentAsync(context, name, id, version); - var response = ContentDto.FromContent(content, context, this, app); + var response = ContentDto.FromContent(content, context, this, app, name); if (controllerOptions.Value.EnableSurrogateKeys) { @@ -268,17 +266,14 @@ namespace Squidex.Areas.Api.Controllers.Contents { await contentQuery.ThrowIfSchemaNotExistsAsync(Context(), name); - if (publish && !this.HasPermission(Permissions.AppContentsPublish, app, name)) + if (publish && !this.HasPermission(Helper.StatusPermission(app, name, Status.Published))) { - return new StatusCodeResult(123); + return new ForbidResult(); } var command = new CreateContent { ContentId = Guid.NewGuid(), Data = request.ToCleaned(), Publish = publish }; - var context = await CommandBus.PublishAsync(command); - - var result = context.Result>(); - var response = ContentDto.FromCommand(command, result); + var response = await InvokeCommandAsync(app, name, command); return CreatedAtAction(nameof(GetContent), new { id = command.ContentId }, response); } @@ -308,10 +303,8 @@ namespace Squidex.Areas.Api.Controllers.Contents await contentQuery.ThrowIfSchemaNotExistsAsync(Context(), name); var command = new UpdateContent { ContentId = id, Data = request.ToCleaned(), AsDraft = asDraft }; - var context = await CommandBus.PublishAsync(command); - var result = context.Result(); - var response = result.Data; + var response = await InvokeCommandAsync(app, name, command); return Ok(response); } @@ -341,10 +334,8 @@ namespace Squidex.Areas.Api.Controllers.Contents await contentQuery.ThrowIfSchemaNotExistsAsync(Context(), name); var command = new PatchContent { ContentId = id, Data = request.ToCleaned(), AsDraft = asDraft }; - var context = await CommandBus.PublishAsync(command); - var result = context.Result(); - var response = result.Data; + var response = await InvokeCommandAsync(app, name, command); return Ok(response); } @@ -355,118 +346,33 @@ namespace Squidex.Areas.Api.Controllers.Contents /// The name of the app. /// The name of the schema. /// The id of the content item to publish. - /// The date and time when the content should be published. + /// The status request. /// /// 204 => Content published. /// 404 => Content, schema or app not found. - /// 400 => Content was already published. + /// 400 => Request is not valid. /// /// /// You can read the generated documentation for your app at /api/content/{appName}/docs. /// [HttpPut] - [Route("content/{app}/{name}/{id}/publish/")] - [ApiPermission(Permissions.AppContentsPublish)] - [ApiCosts(1)] - public async Task PublishContent(string app, string name, Guid id, string dueTime = null) - { - await contentQuery.ThrowIfSchemaNotExistsAsync(Context(), name); - - var command = CreateCommand(id, Status.Published, dueTime); - - await CommandBus.PublishAsync(command); - - return NoContent(); - } - - /// - /// Unpublish a content item. - /// - /// The name of the app. - /// The name of the schema. - /// The id of the content item to unpublish. - /// The date and time when the content should be unpublished. - /// - /// 204 => Content unpublished. - /// 404 => Content, schema or app not found. - /// 400 => Content was not published. - /// - /// - /// You can read the generated documentation for your app at /api/content/{appName}/docs. - /// - [HttpPut] - [Route("content/{app}/{name}/{id}/unpublish/")] - [ApiPermission(Permissions.AppContentsUnpublish)] - [ApiCosts(1)] - public async Task UnpublishContent(string app, string name, Guid id, string dueTime = null) - { - await contentQuery.ThrowIfSchemaNotExistsAsync(Context(), name); - - var command = CreateCommand(id, Status.Draft, dueTime); - - await CommandBus.PublishAsync(command); - - return NoContent(); - } - - /// - /// Archive a content item. - /// - /// The name of the app. - /// The name of the schema. - /// The id of the content item to archive. - /// The date and time when the content should be archived. - /// - /// 204 => Content archived. - /// 404 => Content, schema or app not found. - /// 400 => Content was already archived. - /// - /// - /// You can read the generated documentation for your app at /api/content/{appName}/docs. - /// - [HttpPut] - [Route("content/{app}/{name}/{id}/archive/")] - [ApiPermission(Permissions.AppContentsArchive)] + [Route("content/{app}/{name}/{id}/status/")] + [ApiPermission] [ApiCosts(1)] - public async Task ArchiveContent(string app, string name, Guid id, string dueTime = null) + public async Task PutContentStatus(string app, string name, Guid id, ChangeStatusDto request) { await contentQuery.ThrowIfSchemaNotExistsAsync(Context(), name); - var command = CreateCommand(id, Status.Archived, dueTime); - - await CommandBus.PublishAsync(command); - - return NoContent(); - } - - /// - /// Restore a content item. - /// - /// The name of the app. - /// The name of the schema. - /// The id of the content item to restore. - /// The date and time when the content should be restored. - /// - /// 204 => Content restored. - /// 404 => Content, schema or app not found. - /// 400 => Content was not archived. - /// - /// - /// You can read the generated documentation for your app at /api/content/{appName}/docs. - /// - [HttpPut] - [Route("content/{app}/{name}/{id}/restore/")] - [ApiPermission(Permissions.AppContentsRestore)] - [ApiCosts(1)] - public async Task RestoreContent(string app, string name, Guid id, string dueTime = null) - { - await contentQuery.ThrowIfSchemaNotExistsAsync(Context(), name); + if (!this.HasPermission(Helper.StatusPermission(app, name, Status.Published))) + { + return new ForbidResult(); + } - var command = CreateCommand(id, Status.Draft, dueTime); + var command = request.ToCommand(id); - await CommandBus.PublishAsync(command); + var response = await InvokeCommandAsync(app, name, command); - return NoContent(); + return Ok(response); } /// @@ -521,26 +427,19 @@ namespace Squidex.Areas.Api.Controllers.Contents var command = new DeleteContent { ContentId = id }; - await CommandBus.PublishAsync(command); + var response = await InvokeCommandAsync(app, name, command); - return NoContent(); + return Ok(response); } - private static ChangeContentStatus CreateCommand(Guid id, Status status, string dueTime) + private async Task InvokeCommandAsync(string app, string schema, ICommand command) { - Instant? dt = null; - - if (!string.IsNullOrWhiteSpace(dueTime)) - { - var parseResult = InstantPattern.General.Parse(dueTime); + var context = await CommandBus.PublishAsync(command); - if (parseResult.Success) - { - dt = parseResult.Value; - } - } + var result = context.Result(); + var response = ContentDto.FromContent(result, null, this, app, schema); - return new ChangeContentStatus { Status = status, ContentId = id, DueTime = dt }; + return response; } private QueryContext Context() @@ -551,5 +450,10 @@ namespace Squidex.Areas.Api.Controllers.Contents .WithLanguages(Request.Headers["X-Languages"]) .WithUnpublished(Request.Headers.ContainsKey("X-Unpublished")); } + + private bool ShouldProvideSurrogateKeys(ContentsDto response) + { + return controllerOptions.Value.EnableSurrogateKeys && response.Items.Length <= controllerOptions.Value.MaxItemsForSurrogateKeys; + } } } diff --git a/src/Squidex/Areas/Api/Controllers/Contents/Generator/SchemaSwaggerGenerator.cs b/src/Squidex/Areas/Api/Controllers/Contents/Generator/SchemaSwaggerGenerator.cs index b9703b584..4b7cd1997 100644 --- a/src/Squidex/Areas/Api/Controllers/Contents/Generator/SchemaSwaggerGenerator.cs +++ b/src/Squidex/Areas/Api/Controllers/Contents/Generator/SchemaSwaggerGenerator.cs @@ -178,8 +178,6 @@ namespace Squidex.Areas.Api.Controllers.Contents.Generator operation.Summary = $"Publish a {schemaName} content."; operation.AddResponse("204", $"{schemaName} content published."); - - AddSecurity(operation, Permissions.AppContentsPublish); }); } @@ -191,8 +189,6 @@ namespace Squidex.Areas.Api.Controllers.Contents.Generator operation.Summary = $"Unpublish a {schemaName} content."; operation.AddResponse("204", $"{schemaName} content unpublished."); - - AddSecurity(operation, Permissions.AppContentsUnpublish); }); } @@ -217,8 +213,6 @@ namespace Squidex.Areas.Api.Controllers.Contents.Generator operation.Summary = $"Restore a {schemaName} content."; operation.AddResponse("204", $"{schemaName} content restored."); - - AddSecurity(operation, Permissions.AppContentsRestore); }); } diff --git a/src/Squidex/Areas/Api/Controllers/Contents/Helper.cs b/src/Squidex/Areas/Api/Controllers/Contents/Helper.cs new file mode 100644 index 000000000..e65648c21 --- /dev/null +++ b/src/Squidex/Areas/Api/Controllers/Contents/Helper.cs @@ -0,0 +1,23 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschraenkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +using Squidex.Domain.Apps.Core.Contents; +using Squidex.Infrastructure.Security; +using Squidex.Shared; + +namespace Squidex.Areas.Api.Controllers.Contents +{ + public static class Helper + { + public static Permission StatusPermission(string app, string schema, Status status) + { + var id = Permissions.AppContentsStatus.Replace("{status}", status.ToString()); + + return Permissions.ForApp(id, app, schema); + } + } +} diff --git a/src/Squidex/Areas/Api/Controllers/Contents/Models/ChangeStatusDto.cs b/src/Squidex/Areas/Api/Controllers/Contents/Models/ChangeStatusDto.cs new file mode 100644 index 000000000..7a89789c9 --- /dev/null +++ b/src/Squidex/Areas/Api/Controllers/Contents/Models/ChangeStatusDto.cs @@ -0,0 +1,34 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschraenkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +using System; +using System.ComponentModel.DataAnnotations; +using NodaTime; +using Squidex.Domain.Apps.Core.Contents; +using Squidex.Domain.Apps.Entities.Contents.Commands; + +namespace Squidex.Areas.Api.Controllers.Contents.Models +{ + public sealed class ChangeStatusDto + { + /// + /// The new status. + /// + [Required] + public Status Status { get; set; } + + /// + /// The due time. + /// + public Instant? DueTime { get; set; } + + public ChangeContentStatus ToCommand(Guid id) + { + return new ChangeContentStatus { ContentId = id, Status = Status, DueTime = DueTime }; + } + } +} diff --git a/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentDto.cs b/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentDto.cs index 81b605a7d..55b02caeb 100644 --- a/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentDto.cs @@ -12,10 +12,9 @@ using Squidex.Domain.Apps.Core.Contents; using Squidex.Domain.Apps.Core.ConvertContent; using Squidex.Domain.Apps.Entities; using Squidex.Domain.Apps.Entities.Contents; -using Squidex.Domain.Apps.Entities.Contents.Commands; using Squidex.Infrastructure; -using Squidex.Infrastructure.Commands; using Squidex.Infrastructure.Reflection; +using Squidex.Shared; using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Contents.Models @@ -80,30 +79,11 @@ namespace Squidex.Areas.Api.Controllers.Contents.Models /// public long Version { get; set; } - public static ContentDto FromCommand(CreateContent command, EntityCreatedResult result) - { - var now = SystemClock.Instance.GetCurrentInstant(); - - var response = new ContentDto - { - Id = command.ContentId, - Data = result.IdOrValue, - Version = result.Version, - Created = now, - CreatedBy = command.Actor, - LastModified = now, - LastModifiedBy = command.Actor, - Status = command.Publish ? Status.Published : Status.Draft - }; - - return response; - } - - public static ContentDto FromContent(IContentEntity content, QueryContext context, ApiController controller, string app) + public static ContentDto FromContent(IContentEntity content, QueryContext context, ApiController controller, string app, string schema) { var response = SimpleMapper.Map(content, new ContentDto()); - if (context.Flatten) + if (context?.Flatten == true) { response.Data = content.Data?.ToFlatten(); response.DataDraft = content.DataDraft?.ToFlatten(); @@ -119,11 +99,58 @@ namespace Squidex.Areas.Api.Controllers.Contents.Models response.ScheduleJob = SimpleMapper.Map(content.ScheduleJob, new ScheduleJobDto()); } - return response.CreateLinks(controller, app); + return response.CreateLinks(controller, app, schema); } - private ContentDto CreateLinks(ApiController controller, object app) + private ContentDto CreateLinks(ApiController controller, string app, string schema) { + var values = new { app, name = schema, id = Id }; + + AddSelfLink(controller.Url(x => nameof(x.GetContent), values)); + + if (Version > 0) + { + var versioned = new { app, name = schema, id = Id, version = Version - 1 }; + + AddGetLink("prev", controller.Url(x => nameof(x.GetContentVersion), versioned)); + } + + if (IsPending) + { + if (controller.HasPermission(Permissions.AppContentsDiscard, app, schema)) + { + AddPutLink("changes/discard", controller.Url(x => nameof(x.DiscardChanges), values)); + } + + if (controller.HasPermission(Helper.StatusPermission(app, schema, Status.Published))) + { + AddPutLink("changes/publish", controller.Url(x => nameof(x.PutContentStatus), values)); + } + } + + if (controller.HasPermission(Permissions.AppContentsUpdate, app, schema)) + { + AddPutLink("update", controller.Url(x => nameof(x.PutContent), values)); + + if (Status == Status.Published) + { + AddPutLink("update/change", controller.Url(x => nameof(x.PutContent), values) + "?asDraft"); + } + } + + if (controller.HasPermission(Permissions.AppContentsDelete, app, schema)) + { + AddPutLink("delete", controller.Url(x => nameof(x.DeleteContent), values)); + } + + foreach (var next in StatusFlow.Next(Status)) + { + if (controller.HasPermission(Helper.StatusPermission(app, schema, next))) + { + AddPutLink($"status/{next}", controller.Url(x => nameof(x.PutContentStatus), values)); + } + } + return this; } } diff --git a/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentsDto.cs b/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentsDto.cs index edcb6caa8..a3a79ade2 100644 --- a/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentsDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentsDto.cs @@ -7,9 +7,11 @@ using System.Collections.Generic; using System.Linq; +using Squidex.Domain.Apps.Core.Contents; using Squidex.Domain.Apps.Entities; using Squidex.Domain.Apps.Entities.Contents; using Squidex.Infrastructure; +using Squidex.Shared; using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Contents.Models @@ -36,30 +38,47 @@ namespace Squidex.Areas.Api.Controllers.Contents.Models return Items.ToSurrogateKeys(); } - public static ContentsDto FromContents(IList contents, QueryContext context, ApiController controller, string app) + public static ContentsDto FromContents(IList contents, QueryContext context, ApiController controller, string app, string schema) { var result = new ContentsDto { Total = contents.Count, - Items = contents.Select(x => ContentDto.FromContent(x, context, controller, app)).ToArray() + Items = contents.Select(x => ContentDto.FromContent(x, context, controller, app, schema)).ToArray() }; - return result.CreateLinks(controller, app); + return result.CreateLinks(controller, app, schema); } - public static ContentsDto FromContents(IResultList contents, QueryContext context, ApiController controller, string app) + public static ContentsDto FromContents(IResultList contents, QueryContext context, ApiController controller, string app, string schema) { var result = new ContentsDto { Total = contents.Total, - Items = contents.Select(x => ContentDto.FromContent(x, context, controller, app)).ToArray() + Items = contents.Select(x => ContentDto.FromContent(x, context, controller, app, schema)).ToArray() }; - return result.CreateLinks(controller, app); + return result.CreateLinks(controller, app, schema); } - private ContentsDto CreateLinks(ApiController controller, string app) + private ContentsDto CreateLinks(ApiController controller, string app, string schema) { + if (schema != null) + { + var values = new { app, name = schema }; + + AddSelfLink(controller.Url(x => nameof(x.GetContents), values)); + + if (controller.HasPermission(Permissions.AppContentsCreate, app, schema)) + { + AddPostLink("create", controller.Url(x => nameof(x.PostContent), values)); + + if (controller.HasPermission(Helper.StatusPermission(app, schema, Status.Published))) + { + AddPostLink("create/publish", controller.Url(x => nameof(x.PostContent), values) + "?publish=true"); + } + } + } + return this; } } diff --git a/src/Squidex/app/features/content/pages/content/content-page.component.html b/src/Squidex/app/features/content/pages/content/content-page.component.html index 97b47dbc5..7438f1245 100644 --- a/src/Squidex/app/features/content/pages/content/content-page.component.html +++ b/src/Squidex/app/features/content/pages/content/content-page.component.html @@ -7,24 +7,21 @@ - + New Content - - Edit Content - - - Show Content - + + Content + - - @@ -48,35 +45,25 @@
- - - Discard changes - + + Discard changes + -
- - - Publish changes - - +
+ + + Publish changes + - - Publish - - - Unpublish - - - Archive - - - Restore + + Status to {{status}}
@@ -88,12 +75,12 @@
- - - diff --git a/src/Squidex/app/features/content/pages/content/content-page.component.ts b/src/Squidex/app/features/content/pages/content/content-page.component.ts index 228595a75..b16c3914b 100644 --- a/src/Squidex/app/features/content/pages/content/content-page.component.ts +++ b/src/Squidex/app/features/content/pages/content/content-page.component.ts @@ -24,6 +24,7 @@ import { EditContentForm, fadeAnimation, FieldDto, + hasAnyLink, ImmutableArray, LanguagesState, MessageBus, @@ -64,7 +65,7 @@ export class ContentPageComponent extends ResourceOwner implements CanComponentD constructor(apiUrl: ApiUrlConfig, authService: AuthService, public readonly appsState: AppsState, - private readonly contentsState: ContentsState, + public readonly contentsState: ContentsState, private readonly dialogs: DialogService, private readonly languagesState: LanguagesState, private readonly messageBus: MessageBus, @@ -174,29 +175,13 @@ export class ContentPageComponent extends ResourceOwner implements CanComponentD } private loadContent(data: any) { - this.contentForm.loadContent(data, this.content && this.content.status === 'Archived'); + this.contentForm.loadContent(data, this.content && !hasAnyLink(this.content, 'update')); } public discardChanges() { this.contentsState.discardChanges(this.content); } - public publish() { - this.changeContentItems('Publish', 'Published'); - } - - public unpublish() { - this.changeContentItems('Unpublish', 'Draft'); - } - - public archive() { - this.changeContentItems('Archive', 'Archived'); - } - - public restore() { - this.changeContentItems('Restore', 'Draft'); - } - public delete() { this.contentsState.deleteMany([this.content]).pipe(onErrorResumeNext()) .subscribe(() => { @@ -210,9 +195,9 @@ export class ContentPageComponent extends ResourceOwner implements CanComponentD .subscribe(); } - private changeContentItems(action: string, status: string) { - this.dueTimeSelector.selectDueTime(action).pipe( - switchMap(d => this.contentsState.changeStatus(this.content, action, status, d)), onErrorResumeNext()) + public changeStatus(status: string) { + this.dueTimeSelector.selectDueTime(status).pipe( + switchMap(d => this.contentsState.changeStatus(this.content, status, d)), onErrorResumeNext()) .subscribe(); } diff --git a/src/Squidex/app/features/content/pages/contents/contents-page.component.html b/src/Squidex/app/features/content/pages/contents/contents-page.component.html index 5cf558066..78723f4af 100644 --- a/src/Squidex/app/features/content/pages/contents/contents-page.component.html +++ b/src/Squidex/app/features/content/pages/contents/contents-page.component.html @@ -36,7 +36,7 @@
-
+
@@ -80,25 +80,13 @@
- {{selectionCount}} items selected:   + {{selectionCount}} items selected   - - - - - - - - - - diff --git a/src/Squidex/app/features/administration/pages/users/user-page.component.ts b/src/Squidex/app/features/administration/pages/users/user-page.component.ts index 83b2cef3d..e1bed115c 100644 --- a/src/Squidex/app/features/administration/pages/users/user-page.component.ts +++ b/src/Squidex/app/features/administration/pages/users/user-page.component.ts @@ -9,7 +9,7 @@ import { Component, OnInit } from '@angular/core'; import { FormBuilder } from '@angular/forms'; import { ActivatedRoute, Router } from '@angular/router'; -import { hasAnyLink, ResourceOwner } from '@app/shared'; +import { ResourceOwner } from '@app/shared'; import { CreateUserDto, @@ -47,7 +47,7 @@ export class UserPageComponent extends ResourceOwner implements OnInit { if (selectedUser) { this.userForm.load(selectedUser); - this.isEditable = hasAnyLink(this.user, 'update'); + this.isEditable = this.user.canUpdate; if (!this.isEditable) { this.userForm.form.disable(); diff --git a/src/Squidex/app/features/administration/pages/users/users-page.component.html b/src/Squidex/app/features/administration/pages/users/users-page.component.html index f71733085..3fe383d68 100644 --- a/src/Squidex/app/features/administration/pages/users/users-page.component.html +++ b/src/Squidex/app/features/administration/pages/users/users-page.component.html @@ -17,7 +17,7 @@ - + - diff --git a/src/Squidex/app/features/administration/services/event-consumers.service.spec.ts b/src/Squidex/app/features/administration/services/event-consumers.service.spec.ts index 33bb41306..6815d1093 100644 --- a/src/Squidex/app/features/administration/services/event-consumers.service.spec.ts +++ b/src/Squidex/app/features/administration/services/event-consumers.service.spec.ts @@ -8,7 +8,7 @@ import { HttpClientTestingModule, HttpTestingController } from '@angular/common/http/testing'; import { inject, TestBed } from '@angular/core/testing'; -import { ApiUrlConfig, Resource } from '@app/framework'; +import { ApiUrlConfig, Resource, ResourceLinks } from '@app/framework'; import { EventConsumerDto, @@ -151,16 +151,14 @@ describe('EventConsumersService', () => { }); export function createEventConsumer(id: number, suffix = '') { - const result = new EventConsumerDto( + const links: ResourceLinks = { + reset: { method: 'PUT', href: `/event-consumers/${id}/reset` } + }; + + return new EventConsumerDto(links, `event-consumer${id}`, true, true, `failure-${id}${suffix}`, `position-${id}${suffix}`); - - result._links['reset'] = { - method: 'PUT', href: `/event-consumers/${id}/reset` - }; - - return result; } \ No newline at end of file diff --git a/src/Squidex/app/features/administration/services/event-consumers.service.ts b/src/Squidex/app/features/administration/services/event-consumers.service.ts index 5c49b1980..18ebdc7ca 100644 --- a/src/Squidex/app/features/administration/services/event-consumers.service.ts +++ b/src/Squidex/app/features/administration/services/event-consumers.service.ts @@ -12,31 +12,41 @@ import { map } from 'rxjs/operators'; import { ApiUrlConfig, + hasAnyLink, pretifyError, Resource, - ResourceLinks, - withLinks + ResourceLinks } from '@app/shared'; export class EventConsumersDto { - public readonly _links: ResourceLinks = {}; + public readonly _links: ResourceLinks; constructor( - public readonly items: EventConsumerDto[] + public readonly items: EventConsumerDto[], links?: ResourceLinks ) { + this._links = links || {}; } } export class EventConsumerDto { - public readonly _links: ResourceLinks = {}; + public readonly _links: ResourceLinks; - constructor( + public readonly canStop: boolean; + public readonly canStart: boolean; + public readonly canRestart: boolean; + + constructor(links: ResourceLinks, public readonly name: string, public readonly isStopped?: boolean, public readonly isResetting?: boolean, public readonly error?: string, public readonly position?: string ) { + this._links = links; + + this.canStop = hasAnyLink(links, 'stop'); + this.canStart = hasAnyLink(links, 'start'); + this.canRestart = hasAnyLink(links, 'canReset'); } } @@ -52,10 +62,10 @@ export class EventConsumersService { const url = this.apiUrl.buildUrl('/api/event-consumers'); return this.http.get<{ items: any[] } & Resource>(url).pipe( - map(body => { - const eventConsumers = body.items.map(item => parseEventConsumer(item)); + map(({ items, _links }) => { + const eventConsumers = items.map(item => parseEventConsumer(item)); - return withLinks(new EventConsumersDto(eventConsumers), body); + return new EventConsumersDto(eventConsumers, _links); }), pretifyError('Failed to load event consumers. Please reload.')); } @@ -98,12 +108,11 @@ export class EventConsumersService { } function parseEventConsumer(response: any): EventConsumerDto { - return withLinks( - new EventConsumerDto( - response.name, - response.isStopped, - response.isResetting, - response.error, - response.position), - response); + return new EventConsumerDto( + response._links, + response.name, + response.isStopped, + response.isResetting, + response.error, + response.position); } diff --git a/src/Squidex/app/features/administration/services/users.service.spec.ts b/src/Squidex/app/features/administration/services/users.service.spec.ts index 825f962f6..028660711 100644 --- a/src/Squidex/app/features/administration/services/users.service.spec.ts +++ b/src/Squidex/app/features/administration/services/users.service.spec.ts @@ -8,7 +8,7 @@ import { HttpClientTestingModule, HttpTestingController } from '@angular/common/http/testing'; import { inject, TestBed } from '@angular/core/testing'; -import { ApiUrlConfig, Resource } from '@app/framework'; +import { ApiUrlConfig, Resource, ResourceLinks } from '@app/framework'; import { UserDto, @@ -227,7 +227,11 @@ describe('UsersService', () => { }); export function createUser(id: number, suffix = '') { - const result = new UserDto( + const links: ResourceLinks = { + update: { method: 'PUT', href: `/users/${id}` } + }; + + return new UserDto(links, `${id}`, `user${id}${suffix}@domain.com`, `user${id}${suffix}`, @@ -235,10 +239,4 @@ export function createUser(id: number, suffix = '') { `Permission${id}${suffix}` ], true); - - result._links['update'] = { - method: 'PUT', href: `/users/${id}` - }; - - return result; } \ No newline at end of file diff --git a/src/Squidex/app/features/administration/services/users.service.ts b/src/Squidex/app/features/administration/services/users.service.ts index b0165b9de..4992334f1 100644 --- a/src/Squidex/app/features/administration/services/users.service.ts +++ b/src/Squidex/app/features/administration/services/users.service.ts @@ -12,27 +12,38 @@ import { map } from 'rxjs/operators'; import { ApiUrlConfig, + hasAnyLink, pretifyError, Resource, ResourceLinks, - ResultSet, - withLinks + ResultSet } from '@app/shared'; export class UsersDto extends ResultSet { - public readonly _links: ResourceLinks = {}; + public get canCreate() { + return hasAnyLink(this._links, 'create'); + } } export class UserDto { - public readonly _links: ResourceLinks = {}; + public readonly _links: ResourceLinks; - constructor( + public readonly canLock: boolean; + public readonly canUnlock: boolean; + public readonly canUpdate: boolean; + + constructor(links: ResourceLinks, public readonly id: string, public readonly email: string, public readonly displayName: string, public readonly permissions: string[] = [], public readonly isLocked?: boolean ) { + this._links = links; + + this.canLock = hasAnyLink(links, 'lock'); + this.canUnlock = hasAnyLink(links, 'unlock'); + this.canUpdate = hasAnyLink(links, 'update'); } } @@ -62,10 +73,10 @@ export class UsersService { const url = this.apiUrl.buildUrl(`api/user-management?take=${take}&skip=${skip}&query=${query || ''}`); return this.http.get<{ total: number, items: any[] } & Resource>(url).pipe( - map(body => { - const users = body.items.map(item => parseUser(item)); + map(({ total, items, _links }) => { + const users = items.map(item => parseUser(item)); - return withLinks(new UsersDto(body.total, users), body); + return new UsersDto(total, users, _links); }), pretifyError('Failed to load users. Please reload.')); } @@ -128,12 +139,11 @@ export class UsersService { } function parseUser(response: any) { - return withLinks( - new UserDto( - response.id, - response.email, - response.displayName, - response.permissions, - response.isLocked), - response); + return new UserDto( + response._links, + response.id, + response.email, + response.displayName, + response.permissions, + response.isLocked); } \ No newline at end of file diff --git a/src/Squidex/app/features/administration/state/users.state.spec.ts b/src/Squidex/app/features/administration/state/users.state.spec.ts index 257bf4c72..90fd5321d 100644 --- a/src/Squidex/app/features/administration/state/users.state.spec.ts +++ b/src/Squidex/app/features/administration/state/users.state.spec.ts @@ -16,7 +16,6 @@ import { UsersService } from '@app/features/administration/internal'; - import { UsersState } from './users.state'; import { createUser } from './../services/users.service.spec'; diff --git a/src/Squidex/app/features/administration/state/users.state.ts b/src/Squidex/app/features/administration/state/users.state.ts index d638c5e0c..52a54333f 100644 --- a/src/Squidex/app/features/administration/state/users.state.ts +++ b/src/Squidex/app/features/administration/state/users.state.ts @@ -37,14 +37,17 @@ interface Snapshot { // The query to filter users. usersQuery?: string; - // The resource links. - links: ResourceLinks; - // Indicates if the users are loaded. isLoaded?: boolean; // The selected user. selectedUser?: UserDto | null; + + // Indicates if the user can create a user. + canCreate?: boolean; + + // The resource links. + _links?: ResourceLinks; } export type UsersList = ImmutableArray; @@ -68,15 +71,15 @@ export class UsersState extends State { this.changes.pipe(map(x => !!x.isLoaded), distinctUntilChanged()); - public links = - this.changes.pipe(map(x => x.links), + public canCreate = + this.changes.pipe(map(x => !!x.canCreate), distinctUntilChanged()); constructor( private readonly dialogs: DialogService, private readonly usersService: UsersService ) { - super({ users: ImmutableArray.empty(), usersPager: new Pager(0), links: {} }); + super({ users: ImmutableArray.empty(), usersPager: new Pager(0) }); } public select(id: string | null): Observable { @@ -116,7 +119,7 @@ export class UsersState extends State { this.snapshot.usersPager.pageSize, this.snapshot.usersPager.skip, this.snapshot.usersQuery).pipe( - tap(({ total, items, _links: links }) => { + tap(({ total, items, _links, canCreate }) => { if (isReload) { this.dialogs.notifyInfo('Users reloaded.'); } @@ -131,7 +134,7 @@ export class UsersState extends State { selectedUser = users.find(x => x.id === selectedUser!.id) || selectedUser; } - return { ...s, users, usersPager, selectedUser, isLoaded: true, links }; + return { ...s, users, usersPager, selectedUser, isLoaded: true, _links }; }); }), shareSubscribed(this.dialogs)); diff --git a/src/Squidex/app/features/content/pages/content/content-page.component.html b/src/Squidex/app/features/content/pages/content/content-page.component.html index 7438f1245..10c7441ff 100644 --- a/src/Squidex/app/features/content/pages/content/content-page.component.html +++ b/src/Squidex/app/features/content/pages/content/content-page.component.html @@ -17,11 +17,11 @@ - - @@ -45,13 +45,13 @@
- + Discard changes
- + Publish changes @@ -63,7 +63,7 @@
@@ -74,13 +74,12 @@
- - - + - diff --git a/src/Squidex/app/features/content/pages/content/content-page.component.ts b/src/Squidex/app/features/content/pages/content/content-page.component.ts index b16c3914b..bf83ec832 100644 --- a/src/Squidex/app/features/content/pages/content/content-page.component.ts +++ b/src/Squidex/app/features/content/pages/content/content-page.component.ts @@ -24,7 +24,6 @@ import { EditContentForm, fadeAnimation, FieldDto, - hasAnyLink, ImmutableArray, LanguagesState, MessageBus, @@ -175,7 +174,7 @@ export class ContentPageComponent extends ResourceOwner implements CanComponentD } private loadContent(data: any) { - this.contentForm.loadContent(data, this.content && !hasAnyLink(this.content, 'update')); + this.contentForm.loadContent(data, this.content && !this.content.canUpdate); } public discardChanges() { diff --git a/src/Squidex/app/features/content/pages/contents/contents-page.component.html b/src/Squidex/app/features/content/pages/contents/contents-page.component.html index 78723f4af..c419dfeb5 100644 --- a/src/Squidex/app/features/content/pages/contents/contents-page.component.html +++ b/src/Squidex/app/features/content/pages/contents/contents-page.component.html @@ -36,7 +36,7 @@
-
+
diff --git a/src/Squidex/app/features/content/pages/contents/contents-page.component.ts b/src/Squidex/app/features/content/pages/contents/contents-page.component.ts index 87084de78..7e58e14f3 100644 --- a/src/Squidex/app/features/content/pages/contents/contents-page.component.ts +++ b/src/Squidex/app/features/content/pages/contents/contents-page.component.ts @@ -16,7 +16,6 @@ import { ContentQueryStatus, ContentsState, FilterState, - hasAnyLink, ImmutableArray, LanguagesState, ModalModel, @@ -231,7 +230,7 @@ export class ContentsPageComponent extends ResourceOwner implements OnInit { } } - if (!hasAnyLink(content, 'delete')) { + if (!content.canDelete) { this.selectionCanDelete = false; } } else { diff --git a/src/Squidex/app/features/content/shared/content-item.component.html b/src/Squidex/app/features/content/shared/content-item.component.html index 71754a534..4c99f32eb 100644 --- a/src/Squidex/app/features/content/shared/content-item.component.html +++ b/src/Squidex/app/features/content/shared/content-item.component.html @@ -55,19 +55,10 @@
- - Publish + + Status to {{status}} - - Unpublish - - - Archive - - - Restore - - + Clone diff --git a/src/Squidex/app/features/content/shared/content-item.component.ts b/src/Squidex/app/features/content/shared/content-item.component.ts index 089bcbca2..9922a7f41 100644 --- a/src/Squidex/app/features/content/shared/content-item.component.ts +++ b/src/Squidex/app/features/content/shared/content-item.component.ts @@ -58,6 +58,9 @@ export class ContentItemComponent implements OnChanges { @Input() public schema: SchemaDetailsDto; + @Input() + public canClone: boolean; + @Input() public isReadOnly = false; diff --git a/src/Squidex/app/features/dashboard/pages/dashboard-page.component.html b/src/Squidex/app/features/dashboard/pages/dashboard-page.component.html index 0776d347c..5a9c1cd00 100644 --- a/src/Squidex/app/features/dashboard/pages/dashboard-page.component.html +++ b/src/Squidex/app/features/dashboard/pages/dashboard-page.component.html @@ -12,7 +12,7 @@
- +
diff --git a/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.ts b/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.ts index 7b7252549..8c88c9c8d 100644 --- a/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.ts +++ b/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.ts @@ -10,7 +10,6 @@ import { FormGroup } from '@angular/forms'; import { Form, - hasAnyLink, ImmutableArray, RuleDto, RuleElementDto, @@ -64,7 +63,7 @@ export class RuleWizardComponent implements AfterViewInit, OnInit { } public ngOnInit() { - this.isEditable = !this.rule || hasAnyLink(this.rule, 'update'); + this.isEditable = !this.rule || this.rule.canUpdate; if (this.mode === MODE_EDIT_ACTION) { this.step = 4; diff --git a/src/Squidex/app/features/rules/pages/rules/rules-page.component.html b/src/Squidex/app/features/rules/pages/rules/rules-page.component.html index 0e97c61f2..61064cc9e 100644 --- a/src/Squidex/app/features/rules/pages/rules/rules-page.component.html +++ b/src/Squidex/app/features/rules/pages/rules/rules-page.component.html @@ -12,7 +12,7 @@ - +
@@ -51,11 +51,11 @@ - +
- + Enable in UI - + Disable in UI - + Hide in API - + Show in API - +
diff --git a/src/Squidex/app/features/schemas/pages/schema/field.component.ts b/src/Squidex/app/features/schemas/pages/schema/field.component.ts index d591988f3..db2288385 100644 --- a/src/Squidex/app/features/schemas/pages/schema/field.component.ts +++ b/src/Squidex/app/features/schemas/pages/schema/field.component.ts @@ -13,7 +13,6 @@ import { DialogModel, EditFieldForm, fadeAnimation, - hasAnyLink, ImmutableArray, ModalModel, NestedFieldDto, @@ -61,7 +60,7 @@ export class FieldComponent implements OnChanges { public ngOnChanges(changes: SimpleChanges) { if (changes['field']) { - this.isEditable = hasAnyLink(this.field, 'update'); + this.isEditable = this.field.canUpdate; this.editForm.load(this.field.properties); } diff --git a/src/Squidex/app/features/schemas/pages/schema/schema-edit-form.component.ts b/src/Squidex/app/features/schemas/pages/schema/schema-edit-form.component.ts index 596fcc44f..2388ee42d 100644 --- a/src/Squidex/app/features/schemas/pages/schema/schema-edit-form.component.ts +++ b/src/Squidex/app/features/schemas/pages/schema/schema-edit-form.component.ts @@ -10,7 +10,6 @@ import { FormBuilder } from '@angular/forms'; import { EditSchemaForm, - hasAnyLink, SchemaDetailsDto, SchemasState } from '@app/shared'; @@ -38,7 +37,7 @@ export class SchemaEditFormComponent implements OnInit { } public ngOnInit() { - this.isEditable = hasAnyLink(this.schema, 'update'); + this.isEditable = this.schema.canUpdate; this.editForm.load(this.schema.properties); diff --git a/src/Squidex/app/features/schemas/pages/schema/schema-page.component.html b/src/Squidex/app/features/schemas/pages/schema/schema-page.component.html index 8a76a5c1c..334bd3430 100644 --- a/src/Squidex/app/features/schemas/pages/schema/schema-page.component.html +++ b/src/Squidex/app/features/schemas/pages/schema/schema-page.component.html @@ -11,10 +11,10 @@
- -
@@ -31,7 +31,7 @@ Edit Preview Urls - +
@@ -39,10 +39,11 @@ - +
- @@ -65,14 +66,14 @@
No field created yet. -
@@ -80,7 +81,7 @@
- diff --git a/src/Squidex/app/features/schemas/pages/schema/schema-preview-urls-form.component.ts b/src/Squidex/app/features/schemas/pages/schema/schema-preview-urls-form.component.ts index dea644b4d..b03111c4b 100644 --- a/src/Squidex/app/features/schemas/pages/schema/schema-preview-urls-form.component.ts +++ b/src/Squidex/app/features/schemas/pages/schema/schema-preview-urls-form.component.ts @@ -11,7 +11,6 @@ import { FormBuilder } from '@angular/forms'; import { AddPreviewUrlForm, ConfigurePreviewUrlsForm, - hasAnyLink, SchemaDetailsDto, SchemasState } from '@app/shared'; @@ -41,7 +40,7 @@ export class SchemaPreviewUrlsFormComponent implements OnInit { } public ngOnInit() { - this.isEditable = hasAnyLink(this.schema, 'update'); + this.isEditable = this.schema.canUpdateUrls; this.editForm.load(this.schema.previewUrls); diff --git a/src/Squidex/app/features/schemas/pages/schema/schema-scripts-form.component.ts b/src/Squidex/app/features/schemas/pages/schema/schema-scripts-form.component.ts index ceda622ca..2b6bab98a 100644 --- a/src/Squidex/app/features/schemas/pages/schema/schema-scripts-form.component.ts +++ b/src/Squidex/app/features/schemas/pages/schema/schema-scripts-form.component.ts @@ -10,7 +10,6 @@ import { FormBuilder } from '@angular/forms'; import { EditScriptsForm, - hasAnyLink, SchemaDetailsDto, SchemasState } from '@app/shared'; @@ -40,7 +39,7 @@ export class SchemaScriptsFormComponent implements OnInit { } public ngOnInit() { - this.isEditable = hasAnyLink(this.schema, 'update'); + this.isEditable = this.schema.canUpdateScripts; this.editForm.load(this.schema.scripts); diff --git a/src/Squidex/app/features/schemas/pages/schemas/schemas-page.component.html b/src/Squidex/app/features/schemas/pages/schemas/schemas-page.component.html index d3305eeb2..5aa97c034 100644 --- a/src/Squidex/app/features/schemas/pages/schemas/schemas-page.component.html +++ b/src/Squidex/app/features/schemas/pages/schemas/schemas-page.component.html @@ -8,11 +8,10 @@ - - + + @@ -79,7 +79,7 @@
@@ -29,7 +29,7 @@
@@ -50,7 +50,7 @@ -
+
diff --git a/src/Squidex/app/features/settings/pages/languages/language.component.html b/src/Squidex/app/features/settings/pages/languages/language.component.html index a446ca2c1..a58f2a5be 100644 --- a/src/Squidex/app/features/settings/pages/languages/language.component.html +++ b/src/Squidex/app/features/settings/pages/languages/language.component.html @@ -14,7 +14,7 @@