diff --git a/Squidex.ruleset b/Squidex.ruleset index 055510070..5aae5da01 100644 --- a/Squidex.ruleset +++ b/Squidex.ruleset @@ -63,6 +63,7 @@ + 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.Domain.Apps.Core.Model/Contents/Status2.cs b/src/Squidex.Domain.Apps.Core.Model/Contents/Status2.cs new file mode 100644 index 000000000..3e684bbe7 --- /dev/null +++ b/src/Squidex.Domain.Apps.Core.Model/Contents/Status2.cs @@ -0,0 +1,46 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschränkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +using Squidex.Infrastructure; +using System; + +namespace Squidex.Domain.Apps.Core.Contents +{ + public struct Status2 : IEquatable + { + public static readonly Status2 Published = new Status2("Published"); + + public string Name { get; } + + public Status2(string name) + { + Guard.NotNullOrEmpty(name, nameof(name)); + + Name = name; + } + + public override bool Equals(object obj) + { + return obj is Status2 status && Equals(status); + } + + public bool Equals(Status2 other) + { + return Name.Equals(other.Name); + } + + public override int GetHashCode() + { + return base.GetHashCode(); + } + + public override string ToString() + { + return Name; + } + } +} 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.Core.Operations/Scripting/JintUser.cs b/src/Squidex.Domain.Apps.Core.Operations/Scripting/JintUser.cs index 3d2177d4b..d32a234bd 100644 --- a/src/Squidex.Domain.Apps.Core.Operations/Scripting/JintUser.cs +++ b/src/Squidex.Domain.Apps.Core.Operations/Scripting/JintUser.cs @@ -48,9 +48,9 @@ namespace Squidex.Domain.Apps.Core.Scripting private static ObjectWrapper CreateUser(Engine engine, string id, bool isClient, string email, string name, IEnumerable allClaims) { var claims = - allClaims.GroupBy(x => x.Type) + allClaims.GroupBy(x => x.Type.Split(ClaimSeparators).Last()) .ToDictionary( - x => x.Key.Split(ClaimSeparators).Last(), + x => x.Key, x => x.Select(y => y.Value).ToArray()); return new ObjectWrapper(engine, new { id, isClient, email, name, claims }); diff --git a/src/Squidex.Domain.Apps.Entities.MongoDb/Contents/MongoContentRepository.cs b/src/Squidex.Domain.Apps.Entities.MongoDb/Contents/MongoContentRepository.cs index 5dd3020e7..aa24583e6 100644 --- a/src/Squidex.Domain.Apps.Entities.MongoDb/Contents/MongoContentRepository.cs +++ b/src/Squidex.Domain.Apps.Entities.MongoDb/Contents/MongoContentRepository.cs @@ -36,6 +36,11 @@ namespace Squidex.Domain.Apps.Entities.MongoDb.Contents private readonly string typeContentDeleted; private readonly MongoContentCollection contents; + static MongoContentRepository() + { + StatusSerializer.Register(); + } + public MongoContentRepository(IMongoDatabase database, IAppProvider appProvider, IJsonSerializer serializer, ITextIndexer indexer, TypeNameRegistry typeNameRegistry) { Guard.NotNull(appProvider, nameof(appProvider)); @@ -64,7 +69,6 @@ namespace Squidex.Domain.Apps.Entities.MongoDb.Contents { Guard.NotNull(app, nameof(app)); Guard.NotNull(schema, nameof(schema)); - Guard.NotNull(status, nameof(status)); Guard.NotNull(query, nameof(query)); using (Profiler.TraceMethod("QueryAsyncByQuery")) @@ -83,9 +87,8 @@ namespace Squidex.Domain.Apps.Entities.MongoDb.Contents public async Task> QueryAsync(IAppEntity app, ISchemaEntity schema, Status[] status, HashSet ids, bool includeDraft = true) { Guard.NotNull(app, nameof(app)); - Guard.NotNull(schema, nameof(schema)); - Guard.NotNull(status, nameof(status)); Guard.NotNull(ids, nameof(ids)); + Guard.NotNull(schema, nameof(schema)); using (Profiler.TraceMethod("QueryAsyncByIds")) { @@ -96,7 +99,6 @@ namespace Squidex.Domain.Apps.Entities.MongoDb.Contents public async Task> QueryAsync(IAppEntity app, Status[] status, HashSet ids, bool includeDraft = true) { Guard.NotNull(app, nameof(app)); - Guard.NotNull(status, nameof(status)); Guard.NotNull(ids, nameof(ids)); using (Profiler.TraceMethod("QueryAsyncByIdsWithoutSchema")) @@ -109,7 +111,6 @@ namespace Squidex.Domain.Apps.Entities.MongoDb.Contents { Guard.NotNull(app, nameof(app)); Guard.NotNull(schema, nameof(schema)); - Guard.NotNull(status, nameof(status)); using (Profiler.TraceMethod()) { diff --git a/src/Squidex.Domain.Apps.Entities.MongoDb/Contents/StatusSerializer.cs b/src/Squidex.Domain.Apps.Entities.MongoDb/Contents/StatusSerializer.cs new file mode 100644 index 000000000..0b9bf91f0 --- /dev/null +++ b/src/Squidex.Domain.Apps.Entities.MongoDb/Contents/StatusSerializer.cs @@ -0,0 +1,39 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschraenkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +using System.Threading; +using MongoDB.Bson.Serialization; +using MongoDB.Bson.Serialization.Serializers; +using Squidex.Domain.Apps.Core.Contents; + +namespace Squidex.Domain.Apps.Entities.MongoDb.Contents +{ + public sealed class StatusSerializer : SerializerBase + { + private static volatile int isRegistered; + + public static void Register() + { + if (Interlocked.Increment(ref isRegistered) == 1) + { + BsonSerializer.RegisterSerializer(new StatusSerializer()); + } + } + + public override Status2 Deserialize(BsonDeserializationContext context, BsonDeserializationArgs args) + { + var value = context.Reader.ReadString(); + + return new Status2(value); + } + + public override void Serialize(BsonSerializationContext context, BsonSerializationArgs args, Status2 value) + { + context.Writer.WriteString(value.Name); + } + } +} diff --git a/src/Squidex.Domain.Apps.Entities.MongoDb/Contents/Visitors/FilterFactory.cs b/src/Squidex.Domain.Apps.Entities.MongoDb/Contents/Visitors/FilterFactory.cs index bbed5d51f..1dd0b1500 100644 --- a/src/Squidex.Domain.Apps.Entities.MongoDb/Contents/Visitors/FilterFactory.cs +++ b/src/Squidex.Domain.Apps.Entities.MongoDb/Contents/Visitors/FilterFactory.cs @@ -162,7 +162,11 @@ namespace Squidex.Domain.Apps.Entities.MongoDb.Contents.Visitors } filters.Add(Filter.Ne(x => x.IsDeleted, true)); - filters.Add(Filter.In(x => x.Status, status)); + + if (status != null) + { + filters.Add(Filter.In(x => x.Status, status)); + } if (ids != null && ids.Count > 0) { diff --git a/src/Squidex.Domain.Apps.Entities/Apps/AppGrain.cs b/src/Squidex.Domain.Apps.Entities/Apps/AppGrain.cs index 63ac53ab9..eceb7bfa5 100644 --- a/src/Squidex.Domain.Apps.Entities/Apps/AppGrain.cs +++ b/src/Squidex.Domain.Apps.Entities/Apps/AppGrain.cs @@ -60,11 +60,13 @@ namespace Squidex.Domain.Apps.Entities.Apps switch (command) { case CreateApp createApp: - return CreateAsync(createApp, c => + return CreateReturn(createApp, c => { GuardApp.CanCreate(c); Create(c); + + return Snapshot; }); case AssignContributor assignContributor: @@ -74,111 +76,137 @@ namespace Squidex.Domain.Apps.Entities.Apps AssignContributor(c, !Snapshot.Contributors.ContainsKey(assignContributor.ContributorId)); - return EntityCreatedResult.Create(c.ContributorId, Version); + return Snapshot; }); case RemoveContributor removeContributor: - return UpdateAsync(removeContributor, c => + return UpdateReturn(removeContributor, c => { GuardAppContributors.CanRemove(Snapshot.Contributors, c); RemoveContributor(c); + + return Snapshot; }); case AttachClient attachClient: - return UpdateAsync(attachClient, c => + return UpdateReturn(attachClient, c => { GuardAppClients.CanAttach(Snapshot.Clients, c); AttachClient(c); + + return Snapshot; }); case UpdateClient updateClient: - return UpdateAsync(updateClient, c => + return UpdateReturn(updateClient, c => { GuardAppClients.CanUpdate(Snapshot.Clients, c, Snapshot.Roles); UpdateClient(c); + + return Snapshot; }); case RevokeClient revokeClient: - return UpdateAsync(revokeClient, c => + return UpdateReturn(revokeClient, c => { GuardAppClients.CanRevoke(Snapshot.Clients, c); RevokeClient(c); + + return Snapshot; }); case AddLanguage addLanguage: - return UpdateAsync(addLanguage, c => + return UpdateReturn(addLanguage, c => { GuardAppLanguages.CanAdd(Snapshot.LanguagesConfig, c); AddLanguage(c); + + return Snapshot; }); case RemoveLanguage removeLanguage: - return UpdateAsync(removeLanguage, c => + return UpdateReturn(removeLanguage, c => { GuardAppLanguages.CanRemove(Snapshot.LanguagesConfig, c); RemoveLanguage(c); + + return Snapshot; }); case UpdateLanguage updateLanguage: - return UpdateAsync(updateLanguage, c => + return UpdateReturn(updateLanguage, c => { GuardAppLanguages.CanUpdate(Snapshot.LanguagesConfig, c); UpdateLanguage(c); + + return Snapshot; }); case AddRole addRole: - return UpdateAsync(addRole, c => + return UpdateReturn(addRole, c => { GuardAppRoles.CanAdd(Snapshot.Roles, c); AddRole(c); + + return Snapshot; }); case DeleteRole deleteRole: - return UpdateAsync(deleteRole, c => + return UpdateReturn(deleteRole, c => { GuardAppRoles.CanDelete(Snapshot.Roles, c, Snapshot.Contributors, Snapshot.Clients); DeleteRole(c); + + return Snapshot; }); case UpdateRole updateRole: - return UpdateAsync(updateRole, c => + return UpdateReturn(updateRole, c => { GuardAppRoles.CanUpdate(Snapshot.Roles, c); UpdateRole(c); + + return Snapshot; }); case AddPattern addPattern: - return UpdateAsync(addPattern, c => + return UpdateReturn(addPattern, c => { GuardAppPatterns.CanAdd(Snapshot.Patterns, c); AddPattern(c); + + return Snapshot; }); case DeletePattern deletePattern: - return UpdateAsync(deletePattern, c => + return UpdateReturn(deletePattern, c => { GuardAppPatterns.CanDelete(Snapshot.Patterns, c); DeletePattern(c); + + return Snapshot; }); case UpdatePattern updatePattern: - return UpdateAsync(updatePattern, c => + return UpdateReturn(updatePattern, c => { GuardAppPatterns.CanUpdate(Snapshot.Patterns, c); UpdatePattern(c); + + return Snapshot; }); case ChangePlan changePlan: 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.Domain.Apps.Entities/Apps/Invitation/InviteUserCommandMiddleware.cs b/src/Squidex.Domain.Apps.Entities/Apps/Invitation/InviteUserCommandMiddleware.cs index 0bf99f271..7bde0a4cd 100644 --- a/src/Squidex.Domain.Apps.Entities/Apps/Invitation/InviteUserCommandMiddleware.cs +++ b/src/Squidex.Domain.Apps.Entities/Apps/Invitation/InviteUserCommandMiddleware.cs @@ -35,9 +35,9 @@ namespace Squidex.Domain.Apps.Entities.Apps.Invitation await next(); - if (assignContributor.IsCreated && context.PlainResult is EntityCreatedResult id) + if (assignContributor.IsCreated && context.PlainResult is IAppEntity app) { - context.Complete(new InvitedResult { Id = id }); + context.Complete(new InvitedResult { App = app }); } return; diff --git a/src/Squidex.Domain.Apps.Entities/Apps/Invitation/InvitedResult.cs b/src/Squidex.Domain.Apps.Entities/Apps/Invitation/InvitedResult.cs index 695be0a4b..45c6df7b9 100644 --- a/src/Squidex.Domain.Apps.Entities/Apps/Invitation/InvitedResult.cs +++ b/src/Squidex.Domain.Apps.Entities/Apps/Invitation/InvitedResult.cs @@ -5,12 +5,10 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== -using Squidex.Infrastructure.Commands; - namespace Squidex.Domain.Apps.Entities.Apps.Invitation { public sealed class InvitedResult { - public EntityCreatedResult Id { get; set; } + public IAppEntity App { get; set; } } } diff --git a/src/Squidex.Domain.Apps.Entities/Apps/RoleExtensions.cs b/src/Squidex.Domain.Apps.Entities/Apps/RoleExtensions.cs index 0e0eddad9..f6464d5dc 100644 --- a/src/Squidex.Domain.Apps.Entities/Apps/RoleExtensions.cs +++ b/src/Squidex.Domain.Apps.Entities/Apps/RoleExtensions.cs @@ -55,7 +55,7 @@ namespace Squidex.Domain.Apps.Entities.Apps { return id; } - })); + }).Where(x => x != "common")); } } } diff --git a/src/Squidex.Domain.Apps.Entities/Assets/AssetCommandMiddleware.cs b/src/Squidex.Domain.Apps.Entities/Assets/AssetCommandMiddleware.cs index 5c93059f2..e45e02645 100644 --- a/src/Squidex.Domain.Apps.Entities/Assets/AssetCommandMiddleware.cs +++ b/src/Squidex.Domain.Apps.Entities/Assets/AssetCommandMiddleware.cs @@ -10,6 +10,7 @@ using System.Collections.Generic; using System.Security.Cryptography; using System.Threading.Tasks; using Orleans; +using Squidex.Domain.Apps.Core.Tags; using Squidex.Domain.Apps.Entities.Assets.Commands; using Squidex.Domain.Apps.Entities.Tags; using Squidex.Infrastructure; @@ -24,25 +25,28 @@ namespace Squidex.Domain.Apps.Entities.Assets private readonly IAssetQueryService assetQuery; private readonly IAssetThumbnailGenerator assetThumbnailGenerator; private readonly IEnumerable> tagGenerators; + private readonly ITagService tagService; public AssetCommandMiddleware( IGrainFactory grainFactory, IAssetQueryService assetQuery, IAssetStore assetStore, IAssetThumbnailGenerator assetThumbnailGenerator, - IEnumerable> tagGenerators) + IEnumerable> tagGenerators, + ITagService tagService) : base(grainFactory) { Guard.NotNull(assetStore, nameof(assetStore)); Guard.NotNull(assetQuery, nameof(assetQuery)); Guard.NotNull(assetThumbnailGenerator, nameof(assetThumbnailGenerator)); Guard.NotNull(tagGenerators, nameof(tagGenerators)); + Guard.NotNull(tagService, nameof(tagService)); this.assetStore = assetStore; this.assetQuery = assetQuery; this.assetThumbnailGenerator = assetThumbnailGenerator; - this.tagGenerators = tagGenerators; + this.tagService = tagService; } public override async Task HandleAsync(CommandContext context, Func next) @@ -56,9 +60,8 @@ namespace Squidex.Domain.Apps.Entities.Assets createAsset.Tags = new HashSet(); } - createAsset.ImageInfo = await assetThumbnailGenerator.GetImageInfoAsync(createAsset.File.OpenRead()); - - createAsset.FileHash = await UploadAsync(context, createAsset.File); + await EnrichWithImageInfosAsync(createAsset); + await EnrichWithHashAndUploadAsync(createAsset, context); try { @@ -70,13 +73,9 @@ namespace Squidex.Domain.Apps.Entities.Assets { if (IsDuplicate(createAsset, existing)) { - result = new AssetCreatedResult( - existing.Id, - existing.Tags, - existing.Version, - existing.FileVersion, - existing.FileHash, - true); + var denormalizedTags = await tagService.DenormalizeTagsAsync(createAsset.AppId.Id, TagGroups.Assets, existing.Tags); + + result = new AssetCreatedResult(existing, true, new HashSet(denormalizedTags.Values)); } break; @@ -89,17 +88,11 @@ namespace Squidex.Domain.Apps.Entities.Assets tagGenerator.GenerateTags(createAsset, createAsset.Tags); } - var commandResult = (AssetSavedResult)await ExecuteCommandAsync(createAsset); + var asset = (IAssetEntity)await ExecuteCommandAsync(createAsset); - result = new AssetCreatedResult( - createAsset.AssetId, - createAsset.Tags, - commandResult.Version, - commandResult.FileVersion, - commandResult.FileHash, - false); + result = new AssetCreatedResult(asset, false, createAsset.Tags); - await assetStore.CopyAsync(context.ContextId.ToString(), createAsset.AssetId.ToString(), result.FileVersion, null); + await assetStore.CopyAsync(context.ContextId.ToString(), createAsset.AssetId.ToString(), asset.FileVersion, null); } context.Complete(result); @@ -114,16 +107,16 @@ namespace Squidex.Domain.Apps.Entities.Assets case UpdateAsset updateAsset: { - updateAsset.ImageInfo = await assetThumbnailGenerator.GetImageInfoAsync(updateAsset.File.OpenRead()); + await EnrichWithImageInfosAsync(updateAsset); + await EnrichWithHashAndUploadAsync(updateAsset, context); - updateAsset.FileHash = await UploadAsync(context, updateAsset.File); try { - var result = (AssetSavedResult)await ExecuteCommandAsync(updateAsset); + var result = (AssetResult)await ExecuteAndAdjustTagsAsync(updateAsset); context.Complete(result); - await assetStore.CopyAsync(context.ContextId.ToString(), updateAsset.AssetId.ToString(), result.FileVersion, null); + await assetStore.CopyAsync(context.ContextId.ToString(), updateAsset.AssetId.ToString(), result.Asset.FileVersion, null); } finally { @@ -133,29 +126,54 @@ namespace Squidex.Domain.Apps.Entities.Assets break; } + case AssetCommand command: + { + var result = await ExecuteAndAdjustTagsAsync(command); + + context.Complete(result); + + break; + } + default: await base.HandleAsync(context, next); + break; } } + private async Task ExecuteAndAdjustTagsAsync(AssetCommand command) + { + var result = await ExecuteCommandAsync(command); + + if (result is IAssetEntity asset) + { + var denormalizedTags = await tagService.DenormalizeTagsAsync(asset.AppId.Id, TagGroups.Assets, asset.Tags); + + return new AssetResult(asset, new HashSet(denormalizedTags.Values)); + } + + return result; + } + private static bool IsDuplicate(CreateAsset createAsset, IAssetEntity asset) { return asset != null && asset.FileName == createAsset.File.FileName && asset.FileSize == createAsset.File.FileSize; } - private async Task UploadAsync(CommandContext context, AssetFile file) + private async Task EnrichWithImageInfosAsync(UploadAssetCommand command) { - string hash; + command.ImageInfo = await assetThumbnailGenerator.GetImageInfoAsync(command.File.OpenRead()); + } - using (var hashStream = new HasherStream(file.OpenRead(), HashAlgorithmName.SHA256)) + private async Task EnrichWithHashAndUploadAsync(UploadAssetCommand command, CommandContext context) + { + using (var hashStream = new HasherStream(command.File.OpenRead(), HashAlgorithmName.SHA256)) { await assetStore.UploadAsync(context.ContextId.ToString(), hashStream); - hash = $"{hashStream.GetHashStringAndReset()}{file.FileName}{file.FileSize}".Sha256Base64(); + command.FileHash = $"{hashStream.GetHashStringAndReset()}{command.File.FileName}{command.File.FileSize}".Sha256Base64(); } - - return hash; } } } diff --git a/src/Squidex.Domain.Apps.Entities/Assets/AssetCreatedResult.cs b/src/Squidex.Domain.Apps.Entities/Assets/AssetCreatedResult.cs index de8da5f23..9ccc00763 100644 --- a/src/Squidex.Domain.Apps.Entities/Assets/AssetCreatedResult.cs +++ b/src/Squidex.Domain.Apps.Entities/Assets/AssetCreatedResult.cs @@ -5,30 +5,17 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== -using System; using System.Collections.Generic; -using Squidex.Infrastructure.Commands; namespace Squidex.Domain.Apps.Entities.Assets { - public sealed class AssetCreatedResult : EntityCreatedResult + public sealed class AssetCreatedResult : AssetResult { - public HashSet Tags { get; } - - public long FileVersion { get; } - - public string FileHash { get; } - public bool IsDuplicate { get; } - public AssetCreatedResult(Guid id, HashSet tags, long version, long fileVersion, string fileHash, bool isDuplicate) - : base(id, version) + public AssetCreatedResult(IAssetEntity asset, bool isDuplicate, HashSet tags) + : base(asset, tags) { - Tags = tags; - - FileVersion = fileVersion; - FileHash = fileHash; - IsDuplicate = isDuplicate; } } diff --git a/src/Squidex.Domain.Apps.Entities/Assets/AssetGrain.cs b/src/Squidex.Domain.Apps.Entities/Assets/AssetGrain.cs index b16b18ae4..c76515200 100644 --- a/src/Squidex.Domain.Apps.Entities/Assets/AssetGrain.cs +++ b/src/Squidex.Domain.Apps.Entities/Assets/AssetGrain.cs @@ -51,16 +51,27 @@ namespace Squidex.Domain.Apps.Entities.Assets Create(c, tagIds); - return new AssetSavedResult(Version, Snapshot.FileVersion, Snapshot.FileHash); + return Snapshot; }); case UpdateAsset updateRule: - return UpdateAsync(updateRule, c => + return UpdateReturn(updateRule, c => { GuardAsset.CanUpdate(c); Update(c); - return new AssetSavedResult(Version, Snapshot.FileVersion, Snapshot.FileHash); + return Snapshot; + }); + case AnnotateAsset annotateAsset: + return UpdateReturnAsync(annotateAsset, async c => + { + GuardAsset.CanAnnotate(c, Snapshot.FileName, Snapshot.Slug); + + var tagIds = await NormalizeTagsAsync(Snapshot.AppId.Id, c.Tags); + + Annotate(c, tagIds); + + return Snapshot; }); case DeleteAsset deleteAsset: return UpdateAsync(deleteAsset, async c => @@ -71,15 +82,6 @@ namespace Squidex.Domain.Apps.Entities.Assets Delete(c); }); - case AnnotateAsset annotateAsset: - return UpdateAsync(annotateAsset, async c => - { - GuardAsset.CanAnnotate(c, Snapshot.FileName, Snapshot.Slug); - - var tagIds = await NormalizeTagsAsync(Snapshot.AppId.Id, c.Tags); - - Annotate(c, tagIds); - }); default: throw new NotSupportedException(); } diff --git a/src/Squidex.Domain.Apps.Entities/Assets/AssetResult.cs b/src/Squidex.Domain.Apps.Entities/Assets/AssetResult.cs new file mode 100644 index 000000000..b43713da5 --- /dev/null +++ b/src/Squidex.Domain.Apps.Entities/Assets/AssetResult.cs @@ -0,0 +1,25 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschraenkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +using System.Collections.Generic; + +namespace Squidex.Domain.Apps.Entities.Assets +{ + public class AssetResult + { + public IAssetEntity Asset { get; } + + public HashSet Tags { get; } + + public AssetResult(IAssetEntity asset, HashSet tags) + { + Asset = asset; + + Tags = tags; + } + } +} diff --git a/src/Squidex.Domain.Apps.Entities/Assets/AssetSavedResult.cs b/src/Squidex.Domain.Apps.Entities/Assets/AssetSavedResult.cs deleted file mode 100644 index a43e109cc..000000000 --- a/src/Squidex.Domain.Apps.Entities/Assets/AssetSavedResult.cs +++ /dev/null @@ -1,25 +0,0 @@ -// ========================================================================== -// Squidex Headless CMS -// ========================================================================== -// Copyright (c) Squidex UG (haftungsbeschränkt) -// All rights reserved. Licensed under the MIT license. -// ========================================================================== - -using Squidex.Infrastructure.Commands; - -namespace Squidex.Domain.Apps.Entities.Assets -{ - public class AssetSavedResult : EntitySavedResult - { - public long FileVersion { get; } - - public string FileHash { get; } - - public AssetSavedResult(long version, long fileVersion, string fileHash) - : base(version) - { - FileVersion = fileVersion; - FileHash = fileHash; - } - } -} diff --git a/src/Squidex.Domain.Apps.Entities/Assets/Commands/CreateAsset.cs b/src/Squidex.Domain.Apps.Entities/Assets/Commands/CreateAsset.cs index 9c49e67bd..8e869ba40 100644 --- a/src/Squidex.Domain.Apps.Entities/Assets/Commands/CreateAsset.cs +++ b/src/Squidex.Domain.Apps.Entities/Assets/Commands/CreateAsset.cs @@ -8,22 +8,15 @@ using System; using System.Collections.Generic; using Squidex.Infrastructure; -using Squidex.Infrastructure.Assets; namespace Squidex.Domain.Apps.Entities.Assets.Commands { - public sealed class CreateAsset : AssetCommand, IAppCommand + public sealed class CreateAsset : UploadAssetCommand, IAppCommand { public NamedId AppId { get; set; } - public AssetFile File { get; set; } - - public ImageInfo ImageInfo { get; set; } - public HashSet Tags { get; set; } - public string FileHash { get; set; } - public CreateAsset() { AssetId = Guid.NewGuid(); diff --git a/src/Squidex.Domain.Apps.Entities/Assets/Commands/UpdateAsset.cs b/src/Squidex.Domain.Apps.Entities/Assets/Commands/UpdateAsset.cs index 1c998ac7a..16197164d 100644 --- a/src/Squidex.Domain.Apps.Entities/Assets/Commands/UpdateAsset.cs +++ b/src/Squidex.Domain.Apps.Entities/Assets/Commands/UpdateAsset.cs @@ -5,16 +5,9 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== -using Squidex.Infrastructure.Assets; - namespace Squidex.Domain.Apps.Entities.Assets.Commands { - public sealed class UpdateAsset : AssetCommand + public sealed class UpdateAsset : UploadAssetCommand { - public AssetFile File { get; set; } - - public ImageInfo ImageInfo { get; set; } - - public string FileHash { get; set; } } } diff --git a/src/Squidex.Domain.Apps.Entities/Assets/Commands/UploadAssetCommand.cs b/src/Squidex.Domain.Apps.Entities/Assets/Commands/UploadAssetCommand.cs new file mode 100644 index 000000000..5ef0652cd --- /dev/null +++ b/src/Squidex.Domain.Apps.Entities/Assets/Commands/UploadAssetCommand.cs @@ -0,0 +1,20 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschraenkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +using Squidex.Infrastructure.Assets; + +namespace Squidex.Domain.Apps.Entities.Assets.Commands +{ + public abstract class UploadAssetCommand : AssetCommand + { + public AssetFile File { get; set; } + + public ImageInfo ImageInfo { get; set; } + + public string FileHash { get; set; } + } +} diff --git a/src/Squidex.Domain.Apps.Entities/Comments/CommentsGrain.cs b/src/Squidex.Domain.Apps.Entities/Comments/CommentsGrain.cs index e95b25248..e50cc05f4 100644 --- a/src/Squidex.Domain.Apps.Entities/Comments/CommentsGrain.cs +++ b/src/Squidex.Domain.Apps.Entities/Comments/CommentsGrain.cs @@ -73,7 +73,7 @@ namespace Squidex.Domain.Apps.Entities.Comments switch (command) { case CreateComment createComment: - return UpsertAsync(createComment, c => + return UpsertReturn(createComment, c => { GuardComments.CanCreate(c); @@ -83,7 +83,7 @@ namespace Squidex.Domain.Apps.Entities.Comments }); case UpdateComment updateComment: - return UpsertAsync(updateComment, c => + return Upsert(updateComment, c => { GuardComments.CanUpdate(events, c); @@ -91,7 +91,7 @@ namespace Squidex.Domain.Apps.Entities.Comments }); case DeleteComment deleteComment: - return UpsertAsync(deleteComment, c => + return Upsert(deleteComment, c => { GuardComments.CanDelete(events, c); diff --git a/src/Squidex.Domain.Apps.Entities/Contents/ContentDataChangedResult.cs b/src/Squidex.Domain.Apps.Entities/Contents/ContentDataChangedResult.cs deleted file mode 100644 index 9f3eda547..000000000 --- a/src/Squidex.Domain.Apps.Entities/Contents/ContentDataChangedResult.cs +++ /dev/null @@ -1,23 +0,0 @@ -// ========================================================================== -// Squidex Headless CMS -// ========================================================================== -// Copyright (c) Squidex UG (haftungsbeschränkt) -// All rights reserved. Licensed under the MIT license. -// ========================================================================== - -using Squidex.Domain.Apps.Core.Contents; -using Squidex.Infrastructure.Commands; - -namespace Squidex.Domain.Apps.Entities.Contents -{ - public sealed class ContentDataChangedResult : EntitySavedResult - { - public NamedContentData Data { get; } - - public ContentDataChangedResult(NamedContentData data, long version) - : base(version) - { - Data = data; - } - } -} diff --git a/src/Squidex.Domain.Apps.Entities/Contents/ContentGrain.cs b/src/Squidex.Domain.Apps.Entities/Contents/ContentGrain.cs index 5adf76236..baae5d2dd 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 Snapshot; }); 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,18 @@ namespace Squidex.Domain.Apps.Entities.Contents throw; } } + + return Snapshot; + }); + + case DiscardChanges discardChanges: + return UpdateReturn(discardChanges, c => + { + GuardContent.CanDiscardChanges(Snapshot.IsPending, c); + + DiscardChanges(c); + + return Snapshot; }); case DeleteContent deleteContent: @@ -171,14 +183,6 @@ namespace Squidex.Domain.Apps.Entities.Contents Delete(c); }); - case DiscardChanges discardChanges: - return UpdateAsync(discardChanges, c => - { - GuardContent.CanDiscardChanges(Snapshot.IsPending, c); - - DiscardChanges(c); - }); - default: throw new NotSupportedException(); } @@ -220,7 +224,7 @@ namespace Squidex.Domain.Apps.Entities.Contents } } - return new ContentDataChangedResult(newData, Version); + return Snapshot; } public void Create(CreateContent command) diff --git a/src/Squidex.Domain.Apps.Entities/Contents/ContentQueryService.cs b/src/Squidex.Domain.Apps.Entities/Contents/ContentQueryService.cs index f51138b5e..5d93788fe 100644 --- a/src/Squidex.Domain.Apps.Entities/Contents/ContentQueryService.cs +++ b/src/Squidex.Domain.Apps.Entities/Contents/ContentQueryService.cs @@ -33,10 +33,7 @@ namespace Squidex.Domain.Apps.Entities.Contents { public sealed class ContentQueryService : IContentQueryService { - private static readonly Status[] StatusAll = { Status.Archived, Status.Draft, Status.Published }; - private static readonly Status[] StatusArchived = { Status.Archived }; private static readonly Status[] StatusPublishedOnly = { Status.Published }; - private static readonly Status[] StatusPublishedDraft = { Status.Published, Status.Draft }; private readonly IContentRepository contentRepository; private readonly IContentVersionLoader contentVersionLoader; private readonly IAppProvider appProvider; @@ -93,7 +90,7 @@ namespace Squidex.Domain.Apps.Entities.Contents { var isVersioned = version > EtagVersion.Empty; - var status = GetFindStatus(context); + var status = GetStatus(context); var content = isVersioned ? @@ -119,7 +116,7 @@ namespace Squidex.Domain.Apps.Entities.Contents using (Profiler.TraceMethod()) { - var status = GetQueryStatus(context); + var status = GetStatus(context); IResultList contents; @@ -145,7 +142,7 @@ namespace Squidex.Domain.Apps.Entities.Contents using (Profiler.TraceMethod()) { - var status = GetQueryStatus(context); + var status = GetStatus(context); List result; @@ -217,7 +214,7 @@ namespace Squidex.Domain.Apps.Entities.Contents result.Data = result.Data.ConvertName2Name(schema.SchemaDef, converters); } - if (result.DataDraft != null && (context.ApiStatus == StatusForApi.PublishedDraft || context.IsFrontendClient)) + if (result.DataDraft != null && (context.ApiStatus == StatusForApi.All || context.IsFrontendClient)) { result.DataDraft = result.DataDraft.ConvertName2Name(schema.SchemaDef, converters); } @@ -340,15 +337,11 @@ namespace Squidex.Domain.Apps.Entities.Contents return permissions.Allows(permission); } - private static Status[] GetFindStatus(QueryContext context) + private static Status[] GetStatus(QueryContext context) { - if (context.IsFrontendClient) + if (context.IsFrontendClient || context.ApiStatus == StatusForApi.All) { - return StatusAll; - } - else if (context.ApiStatus == StatusForApi.PublishedDraft) - { - return StatusPublishedDraft; + return null; } else { @@ -356,32 +349,6 @@ namespace Squidex.Domain.Apps.Entities.Contents } } - private static Status[] GetQueryStatus(QueryContext context) - { - if (context.IsFrontendClient) - { - switch (context.FrontendStatus) - { - case StatusForFrontend.Archived: - return StatusArchived; - case StatusForFrontend.PublishedOnly: - return StatusPublishedOnly; - default: - return StatusPublishedDraft; - } - } - else - { - switch (context.ApiStatus) - { - case StatusForApi.PublishedDraft: - return StatusPublishedDraft; - default: - return StatusPublishedOnly; - } - } - } - private Task> QueryAsync(QueryContext context, IReadOnlyList ids, Status[] status) { return contentRepository.QueryAsync(context.App, status, new HashSet(ids), ShouldIncludeDraft(context)); @@ -409,7 +376,7 @@ namespace Squidex.Domain.Apps.Entities.Contents private static bool ShouldIncludeDraft(QueryContext context) { - return context.ApiStatus == StatusForApi.PublishedDraft || context.IsFrontendClient; + return context.ApiStatus == StatusForApi.All || context.IsFrontendClient; } } } diff --git a/src/Squidex.Domain.Apps.Entities/Contents/IContentWorkflow.cs b/src/Squidex.Domain.Apps.Entities/Contents/IContentWorkflow.cs new file mode 100644 index 000000000..06738ec71 --- /dev/null +++ b/src/Squidex.Domain.Apps.Entities/Contents/IContentWorkflow.cs @@ -0,0 +1,24 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschraenkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +using System.Threading.Tasks; +using Squidex.Domain.Apps.Core.Contents; +using Squidex.Domain.Apps.Entities.Schemas; + +namespace Squidex.Domain.Apps.Entities.Contents +{ + public interface IContentWorkflow + { + Task GetInitialStatusAsync(ISchemaEntity schema); + + Task IsValidNextStatus(IContentEntity content, Status2 next); + + Task GetNextsAsync(IContentEntity content); + + Task GetAllAsync(ISchemaEntity schema); + } +} diff --git a/src/Squidex.Domain.Apps.Entities/Contents/StatusForApi.cs b/src/Squidex.Domain.Apps.Entities/Contents/StatusForApi.cs index 4d17ea6a6..e58b4c098 100644 --- a/src/Squidex.Domain.Apps.Entities/Contents/StatusForApi.cs +++ b/src/Squidex.Domain.Apps.Entities/Contents/StatusForApi.cs @@ -10,6 +10,6 @@ namespace Squidex.Domain.Apps.Entities.Contents public enum StatusForApi { PublishedOnly, - PublishedDraft, + All, } } diff --git a/src/Squidex.Domain.Apps.Entities/QueryContext.cs b/src/Squidex.Domain.Apps.Entities/QueryContext.cs index c6c552be9..094e56e3d 100644 --- a/src/Squidex.Domain.Apps.Entities/QueryContext.cs +++ b/src/Squidex.Domain.Apps.Entities/QueryContext.cs @@ -27,8 +27,6 @@ namespace Squidex.Domain.Apps.Entities public StatusForApi ApiStatus { get; private set; } - public StatusForFrontend FrontendStatus { get; private set; } - public IReadOnlyCollection AssetUrlsToResolve { get; private set; } public IReadOnlyCollection Languages { get; private set; } @@ -49,7 +47,7 @@ namespace Squidex.Domain.Apps.Entities public QueryContext WithUnpublished(bool unpublished) { - return WithApiStatus(unpublished ? StatusForApi.PublishedDraft : StatusForApi.PublishedOnly); + return WithApiStatus(unpublished ? StatusForApi.All : StatusForApi.PublishedOnly); } public QueryContext WithApiStatus(StatusForApi status) @@ -57,21 +55,6 @@ namespace Squidex.Domain.Apps.Entities return Clone(c => c.ApiStatus = status); } - public QueryContext WithFrontendStatus(StatusForFrontend status) - { - return Clone(c => c.FrontendStatus = status); - } - - public QueryContext WithFrontendStatus(string status) - { - if (status != null && Enum.TryParse(status, out var result)) - { - return WithFrontendStatus(result); - } - - return this; - } - public QueryContext WithAssetUrlsToResolve(IEnumerable fieldNames) { if (fieldNames != null) diff --git a/src/Squidex.Domain.Apps.Entities/Rules/RuleGrain.cs b/src/Squidex.Domain.Apps.Entities/Rules/RuleGrain.cs index f6073a4f6..a44d6144d 100644 --- a/src/Squidex.Domain.Apps.Entities/Rules/RuleGrain.cs +++ b/src/Squidex.Domain.Apps.Entities/Rules/RuleGrain.cs @@ -41,35 +41,43 @@ namespace Squidex.Domain.Apps.Entities.Rules switch (command) { case CreateRule createRule: - return CreateAsync(createRule, async c => + return CreateReturnAsync(createRule, async c => { await GuardRule.CanCreate(c, appProvider); Create(c); + + return Snapshot; }); case UpdateRule updateRule: - return UpdateAsync(updateRule, async c => + return UpdateReturnAsync(updateRule, async c => { await GuardRule.CanUpdate(c, Snapshot.AppId.Id, appProvider); Update(c); + + return Snapshot; }); case EnableRule enableRule: - return UpdateAsync(enableRule, c => + return UpdateReturn(enableRule, c => { GuardRule.CanEnable(c, Snapshot.RuleDef); Enable(c); + + return Snapshot; }); case DisableRule disableRule: - return UpdateAsync(disableRule, c => + return UpdateReturn(disableRule, c => { GuardRule.CanDisable(c, Snapshot.RuleDef); Disable(c); + + return Snapshot; }); case DeleteRule deleteRule: - return UpdateAsync(deleteRule, c => + return Update(deleteRule, c => { GuardRule.CanDelete(deleteRule); 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..92ccf8142 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,18 +98,30 @@ 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) { throw new DomainException("Schema field is already disabled."); } - if (!field.IsForApi()) + if (!field.IsForApi(true)) { throw new DomainException("UI field cannot be disabled."); } @@ -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.Domain.Apps.Entities/Schemas/SchemaGrain.cs b/src/Squidex.Domain.Apps.Entities/Schemas/SchemaGrain.cs index 44e96fa7f..f1d2ae8c5 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 UpdateReturn(addField, c => { GuardSchemaField.CanAdd(Snapshot.SchemaDef, c); @@ -65,139 +65,171 @@ namespace Squidex.Domain.Apps.Entities.Schemas id = ((IArrayField)Snapshot.SchemaDef.FieldsById[c.ParentFieldId.Value]).FieldsByName[c.Name].Id; } - return EntityCreatedResult.Create(id, Version); + return Snapshot; }); case CreateSchema createSchema: - return CreateAsync(createSchema, async c => + return CreateReturnAsync(createSchema, async c => { await GuardSchema.CanCreate(c, appProvider); Create(c); + + return Snapshot; }); case SynchronizeSchema synchronizeSchema: - return UpdateAsync(synchronizeSchema, c => + return UpdateReturn(synchronizeSchema, c => { GuardSchema.CanSynchronize(c); Synchronize(c); + + return Snapshot; }); case DeleteField deleteField: - return UpdateAsync(deleteField, c => + return UpdateReturn(deleteField, c => { GuardSchemaField.CanDelete(Snapshot.SchemaDef, deleteField); DeleteField(c); + + return Snapshot; }); case LockField lockField: - return UpdateAsync(lockField, c => + return UpdateReturn(lockField, c => { GuardSchemaField.CanLock(Snapshot.SchemaDef, lockField); LockField(c); + + return Snapshot; }); case HideField hideField: - return UpdateAsync(hideField, c => + return UpdateReturn(hideField, c => { GuardSchemaField.CanHide(Snapshot.SchemaDef, c); HideField(c); + + return Snapshot; }); case ShowField showField: - return UpdateAsync(showField, c => + return UpdateReturn(showField, c => { GuardSchemaField.CanShow(Snapshot.SchemaDef, c); ShowField(c); + + return Snapshot; }); case DisableField disableField: - return UpdateAsync(disableField, c => + return UpdateReturn(disableField, c => { GuardSchemaField.CanDisable(Snapshot.SchemaDef, c); DisableField(c); + + return Snapshot; }); case EnableField enableField: - return UpdateAsync(enableField, c => + return UpdateReturn(enableField, c => { GuardSchemaField.CanEnable(Snapshot.SchemaDef, c); EnableField(c); + + return Snapshot; }); case UpdateField updateField: - return UpdateAsync(updateField, c => + return UpdateReturn(updateField, c => { GuardSchemaField.CanUpdate(Snapshot.SchemaDef, c); UpdateField(c); + + return Snapshot; }); case ReorderFields reorderFields: - return UpdateAsync(reorderFields, c => + return UpdateReturn(reorderFields, c => { GuardSchema.CanReorder(Snapshot.SchemaDef, c); Reorder(c); + + return Snapshot; }); case UpdateSchema updateSchema: - return UpdateAsync(updateSchema, c => + return UpdateReturn(updateSchema, c => { GuardSchema.CanUpdate(Snapshot.SchemaDef, c); Update(c); + + return Snapshot; }); case PublishSchema publishSchema: - return UpdateAsync(publishSchema, c => + return UpdateReturn(publishSchema, c => { GuardSchema.CanPublish(Snapshot.SchemaDef, c); Publish(c); + + return Snapshot; }); case UnpublishSchema unpublishSchema: - return UpdateAsync(unpublishSchema, c => + return UpdateReturn(unpublishSchema, c => { GuardSchema.CanUnpublish(Snapshot.SchemaDef, c); Unpublish(c); + + return Snapshot; }); case ConfigureScripts configureScripts: - return UpdateAsync(configureScripts, c => + return UpdateReturn(configureScripts, c => { GuardSchema.CanConfigureScripts(Snapshot.SchemaDef, c); ConfigureScripts(c); + + return Snapshot; }); case ChangeCategory changeCategory: - return UpdateAsync(changeCategory, c => + return UpdateReturn(changeCategory, c => { GuardSchema.CanChangeCategory(Snapshot.SchemaDef, c); ChangeCategory(c); + + return Snapshot; }); case ConfigurePreviewUrls configurePreviewUrls: - return UpdateAsync(configurePreviewUrls, c => + return UpdateReturn(configurePreviewUrls, c => { GuardSchema.CanConfigurePreviewUrls(c); ConfigurePreviewUrls(c); + + return Snapshot; }); case DeleteSchema deleteSchema: - return UpdateAsync(deleteSchema, c => + return Update(deleteSchema, c => { GuardSchema.CanDelete(Snapshot.SchemaDef, c); 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.Infrastructure/CollectionExtensions.cs b/src/Squidex.Infrastructure/CollectionExtensions.cs index 76be0fd06..cfe546a24 100644 --- a/src/Squidex.Infrastructure/CollectionExtensions.cs +++ b/src/Squidex.Infrastructure/CollectionExtensions.cs @@ -13,6 +13,14 @@ namespace Squidex.Infrastructure { public static class CollectionExtensions { + public static void AddRange(this ICollection target, IEnumerable source) + { + foreach (var value in source) + { + target.Add(value); + } + } + public static IEnumerable Shuffle(this IEnumerable enumerable) { var random = new Random(); diff --git a/src/Squidex.Infrastructure/Commands/DomainObjectGrainBase.cs b/src/Squidex.Infrastructure/Commands/DomainObjectGrainBase.cs index 5c3b0d717..23f482b77 100644 --- a/src/Squidex.Infrastructure/Commands/DomainObjectGrainBase.cs +++ b/src/Squidex.Infrastructure/Commands/DomainObjectGrainBase.cs @@ -93,7 +93,7 @@ namespace Squidex.Infrastructure.Commands return InvokeAsync(command, handler, Mode.Create); } - protected Task CreateReturnAsync(TCommand command, Func handler) where TCommand : class, IAggregateCommand + protected Task CreateReturn(TCommand command, Func handler) where TCommand : class, IAggregateCommand { return InvokeAsync(command, handler?.ToAsync(), Mode.Create); } @@ -103,7 +103,7 @@ namespace Squidex.Infrastructure.Commands return InvokeAsync(command, handler.ToDefault(), Mode.Create); } - protected Task CreateAsync(TCommand command, Action handler) where TCommand : class, IAggregateCommand + protected Task Create(TCommand command, Action handler) where TCommand : class, IAggregateCommand { return InvokeAsync(command, handler?.ToDefault()?.ToAsync(), Mode.Create); } @@ -113,7 +113,7 @@ namespace Squidex.Infrastructure.Commands return InvokeAsync(command, handler, Mode.Update); } - protected Task UpdateAsync(TCommand command, Func handler) where TCommand : class, IAggregateCommand + protected Task UpdateReturn(TCommand command, Func handler) where TCommand : class, IAggregateCommand { return InvokeAsync(command, handler?.ToAsync(), Mode.Update); } @@ -123,7 +123,7 @@ namespace Squidex.Infrastructure.Commands return InvokeAsync(command, handler?.ToDefault(), Mode.Update); } - protected Task UpdateAsync(TCommand command, Action handler) where TCommand : class, IAggregateCommand + protected Task Update(TCommand command, Action handler) where TCommand : class, IAggregateCommand { return InvokeAsync(command, handler?.ToDefault()?.ToAsync(), Mode.Update); } @@ -133,7 +133,7 @@ namespace Squidex.Infrastructure.Commands return InvokeAsync(command, handler, Mode.Upsert); } - protected Task UpsertAsync(TCommand command, Func handler) where TCommand : class, IAggregateCommand + protected Task UpsertReturn(TCommand command, Func handler) where TCommand : class, IAggregateCommand { return InvokeAsync(command, handler?.ToAsync(), Mode.Upsert); } @@ -143,7 +143,7 @@ namespace Squidex.Infrastructure.Commands return InvokeAsync(command, handler?.ToDefault(), Mode.Upsert); } - protected Task UpsertAsync(TCommand command, Action handler) where TCommand : class, IAggregateCommand + protected Task Upsert(TCommand command, Action handler) where TCommand : class, IAggregateCommand { return InvokeAsync(command, handler?.ToDefault()?.ToAsync(), Mode.Upsert); } 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.Shared/Permissions.cs b/src/Squidex.Shared/Permissions.cs index 964925efb..7118a0604 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"; @@ -79,7 +77,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"; @@ -108,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"; @@ -117,14 +113,10 @@ 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 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.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..ab63f14f8 --- /dev/null +++ b/src/Squidex.Web/PermissionExtensions.cs @@ -0,0 +1,76 @@ +// ========================================================================== +// 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.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 Permissions(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, PermissionSet permissions = null) + { + 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) + { + return httpContext.HasPermission(Shared.Permissions.ForApp(id, app, schema), permissions); + } + + public static bool HasPermission(this ApiController controller, Permission permission, PermissionSet permissions = null) + { + return controller.HttpContext.HasPermission(permission, permissions); + } + + public static bool HasPermission(this ApiController controller, string id, string app = "*", string schema = "*", PermissionSet permissions = null) + { + 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.HasPermission(Shared.Permissions.ForApp(id, app, schema), permissions); + } + } +} diff --git a/src/Squidex.Web/Pipeline/AppResolver.cs b/src/Squidex.Web/Pipeline/AppResolver.cs index cc0ae853b..97e4e8f1e 100644 --- a/src/Squidex.Web/Pipeline/AppResolver.cs +++ b/src/Squidex.Web/Pipeline/AppResolver.cs @@ -65,7 +65,10 @@ namespace Squidex.Web.Pipeline { var identity = user.Identities.First(); - identity.AddClaim(new Claim(ClaimTypes.Role, role)); + if (!string.IsNullOrWhiteSpace(role)) + { + identity.AddClaim(new Claim(ClaimTypes.Role, role)); + } foreach (var permission in permissions) { diff --git a/src/Squidex.Web/Resource.cs b/src/Squidex.Web/Resource.cs new file mode 100644 index 000000000..d3eba847d --- /dev/null +++ b/src/Squidex.Web/Resource.cs @@ -0,0 +1,61 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschränkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +using Newtonsoft.Json; +using Squidex.Infrastructure; +using System.Collections.Generic; +using System.ComponentModel.DataAnnotations; + +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, "GET", href); + } + + public void AddPatchLink(string rel, string href) + { + AddLink(rel, "PATCH", href); + } + + public void AddPostLink(string rel, string href) + { + AddLink(rel, "POST", href); + } + + public void AddPutLink(string rel, string href) + { + AddLink(rel, "PUT", href); + } + + public void AddDeleteLink(string rel, string href) + { + AddLink(rel, "DELETE", href); + } + + 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/Users/Models/UserCreatedDto.cs b/src/Squidex.Web/ResourceLink.cs similarity index 57% rename from src/Squidex/Areas/Api/Controllers/Users/Models/UserCreatedDto.cs rename to src/Squidex.Web/ResourceLink.cs index 090d81023..964610e7d 100644 --- a/src/Squidex/Areas/Api/Controllers/Users/Models/UserCreatedDto.cs +++ b/src/Squidex.Web/ResourceLink.cs @@ -7,20 +7,16 @@ using System.ComponentModel.DataAnnotations; -namespace Squidex.Areas.Api.Controllers.Users.Models +namespace Squidex.Web { - public sealed class UserCreatedDto + public class ResourceLink { - /// - /// The id of the user. - /// [Required] - public string Id { get; set; } + [Display(Description = "The link url.")] + public string Href { get; set; } - /// - /// Additional permissions for the user. - /// [Required] - public string[] Permissions { get; set; } + [Display(Description = "The link method.")] + public string Method { get; set; } } } diff --git a/src/Squidex.Web/UrlHelperExtensions.cs b/src/Squidex.Web/UrlHelperExtensions.cs new file mode 100644 index 000000000..27f00a1d9 --- /dev/null +++ b/src/Squidex.Web/UrlHelperExtensions.cs @@ -0,0 +1,44 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschränkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +using Microsoft.AspNetCore.Mvc; +using System; + +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/Config/Swagger/ErrorDtoProcessor.cs b/src/Squidex/Areas/Api/Config/Swagger/ErrorDtoProcessor.cs new file mode 100644 index 000000000..f04099cb5 --- /dev/null +++ b/src/Squidex/Areas/Api/Config/Swagger/ErrorDtoProcessor.cs @@ -0,0 +1,70 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschraenkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +using System; +using System.Linq; +using System.Threading.Tasks; +using NJsonSchema; +using NSwag; +using NSwag.SwaggerGeneration.Processors; +using NSwag.SwaggerGeneration.Processors.Contexts; +using Squidex.ClientLibrary.Management; +using Squidex.Pipeline.Swagger; + +namespace Squidex.Areas.Api.Config.Swagger +{ + public sealed class ErrorDtoProcessor : IDocumentProcessor + { + public async Task ProcessAsync(DocumentProcessorContext context) + { + var errorSchema = await GetErrorSchemaAsync(context); + + foreach (var operation in context.Document.Paths.Values.SelectMany(x => x.Values)) + { + AddErrorResponses(operation, errorSchema); + + CleanupResponses(operation); + } + } + + private static void AddErrorResponses(SwaggerOperation operation, JsonSchema4 errorSchema) + { + if (!operation.Responses.ContainsKey("500")) + { + operation.AddResponse("500", "Operation failed", errorSchema); + } + + foreach (var (code, response) in operation.Responses) + { + if (code != "404" && code.StartsWith("4", StringComparison.OrdinalIgnoreCase) && response.Schema == null) + { + response.Schema = errorSchema; + } + } + } + + private static void CleanupResponses(SwaggerOperation operation) + { + foreach (var (code, response) in operation.Responses.ToList()) + { + if (string.IsNullOrWhiteSpace(response.Description) || + response.Description?.Contains("=>") == true || + response.Description?.Contains("=>") == true) + { + operation.Responses.Remove(code); + } + } + } + + private Task GetErrorSchemaAsync(DocumentProcessorContext context) + { + var errorType = typeof(ErrorDto); + + return context.SchemaGenerator.GenerateWithReferenceAsync(errorType, Enumerable.Empty(), context.SchemaResolver); + } + } +} diff --git a/src/Squidex/Areas/Api/Config/Swagger/FixProcessor.cs b/src/Squidex/Areas/Api/Config/Swagger/FixProcessor.cs index 83106901f..0131711f9 100644 --- a/src/Squidex/Areas/Api/Config/Swagger/FixProcessor.cs +++ b/src/Squidex/Areas/Api/Config/Swagger/FixProcessor.cs @@ -13,7 +13,7 @@ using Squidex.Infrastructure.Tasks; namespace Squidex.Areas.Api.Config.Swagger { - public class FixProcessor : IOperationProcessor + public sealed class FixProcessor : IOperationProcessor { private static readonly JsonSchema4 StringSchema = new JsonSchema4 { Type = JsonObjectType.String }; diff --git a/src/Squidex/Areas/Api/Config/Swagger/SecurityProcessor.cs b/src/Squidex/Areas/Api/Config/Swagger/SecurityProcessor.cs index a09e9c9f0..8dfa61f6e 100644 --- a/src/Squidex/Areas/Api/Config/Swagger/SecurityProcessor.cs +++ b/src/Squidex/Areas/Api/Config/Swagger/SecurityProcessor.cs @@ -15,7 +15,7 @@ using Squidex.Web; namespace Squidex.Areas.Api.Config.Swagger { - public class SecurityProcessor : SecurityDefinitionAppender + public sealed class SecurityProcessor : SecurityDefinitionAppender { public SecurityProcessor(IOptions urlOptions) : base(Constants.SecurityDefinition, Enumerable.Empty(), CreateOAuthSchema(urlOptions.Value)) @@ -24,26 +24,33 @@ namespace Squidex.Areas.Api.Config.Swagger private static SwaggerSecurityScheme CreateOAuthSchema(UrlsOptions urlOptions) { - var securityScheme = new SwaggerSecurityScheme(); + var security = new SwaggerSecurityScheme + { + Type = SwaggerSecuritySchemeType.OAuth2 + }; var tokenUrl = urlOptions.BuildUrl($"{Constants.IdentityServerPrefix}/connect/token", false); - securityScheme.TokenUrl = tokenUrl; + security.TokenUrl = tokenUrl; - var securityDocs = NSwagHelper.LoadDocs("security"); - var securityText = securityDocs.Replace("", tokenUrl); + SetupDescription(security, tokenUrl); - securityScheme.Description = securityText; - - securityScheme.Type = SwaggerSecuritySchemeType.OAuth2; - securityScheme.Flow = SwaggerOAuth2Flow.Application; + security.Flow = SwaggerOAuth2Flow.Application; - securityScheme.Scopes = new Dictionary + security.Scopes = new Dictionary { [Constants.ApiScope] = "Read and write access to the API" }; - return securityScheme; + return security; + } + + private static void SetupDescription(SwaggerSecurityScheme securityScheme, string tokenUrl) + { + var securityDocs = NSwagHelper.LoadDocs("security"); + var securityText = securityDocs.Replace("", tokenUrl); + + securityScheme.Description = securityText; } } } diff --git a/src/Squidex/Areas/Api/Config/Swagger/SwaggerServices.cs b/src/Squidex/Areas/Api/Config/Swagger/SwaggerServices.cs index ddccd616c..f3b32121f 100644 --- a/src/Squidex/Areas/Api/Config/Swagger/SwaggerServices.cs +++ b/src/Squidex/Areas/Api/Config/Swagger/SwaggerServices.cs @@ -22,6 +22,9 @@ namespace Squidex.Areas.Api.Config.Swagger { public static void AddMySwaggerSettings(this IServiceCollection services) { + services.AddSingletonAs() + .As(); + services.AddSingletonAs() .As(); diff --git a/src/Squidex/Areas/Api/Config/Swagger/XmlResponseTypesProcessor.cs b/src/Squidex/Areas/Api/Config/Swagger/XmlResponseTypesProcessor.cs index 6d969c204..fedc54045 100644 --- a/src/Squidex/Areas/Api/Config/Swagger/XmlResponseTypesProcessor.cs +++ b/src/Squidex/Areas/Api/Config/Swagger/XmlResponseTypesProcessor.cs @@ -5,16 +5,13 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== -using System.Linq; +using System; using System.Text.RegularExpressions; using System.Threading.Tasks; using NJsonSchema.Infrastructure; using NSwag; using NSwag.SwaggerGeneration.Processors; using NSwag.SwaggerGeneration.Processors.Contexts; -using Squidex.Pipeline.Swagger; - -#pragma warning disable RECS0033 // Convert 'if' to '||' expression namespace Squidex.Areas.Api.Config.Swagger { @@ -26,46 +23,33 @@ namespace Squidex.Areas.Api.Config.Swagger { var operation = context.OperationDescription.Operation; - var returnsDescription = await context.MethodInfo.GetXmlDocumentationTagAsync("returns") ?? string.Empty; + var returnsDescription = await context.MethodInfo.GetXmlDocumentationTagAsync("returns"); - foreach (Match match in ResponseRegex.Matches(returnsDescription)) + if (!string.IsNullOrWhiteSpace(returnsDescription)) { - var statusCode = match.Groups["Code"].Value; - - if (!operation.Responses.TryGetValue(statusCode, out var response)) + foreach (Match match in ResponseRegex.Matches(returnsDescription)) { - response = new SwaggerResponse(); + var statusCode = match.Groups["Code"].Value; - operation.Responses[statusCode] = response; - } + if (!operation.Responses.TryGetValue(statusCode, out var response)) + { + response = new SwaggerResponse(); - response.Description = match.Groups["Description"].Value; - } + operation.Responses[statusCode] = response; + } - await AddInternalErrorResponseAsync(context, operation); + var description = match.Groups["Description"].Value; - CleanupResponses(operation); + if (description.Contains("=>")) + { + throw new InvalidOperationException("Description not formatted correcly."); + } - return true; - } - - private static async Task AddInternalErrorResponseAsync(OperationProcessorContext context, SwaggerOperation operation) - { - if (!operation.Responses.ContainsKey("500")) - { - operation.AddResponse("500", "Operation failed", await context.SchemaGenerator.GetErrorDtoSchemaAsync(context.SchemaResolver)); - } - } - - private static void CleanupResponses(SwaggerOperation operation) - { - foreach (var (code, response) in operation.Responses.ToList()) - { - if (string.IsNullOrWhiteSpace(response.Description) || response.Description?.Contains("=>") == true) - { - operation.Responses.Remove(code); + response.Description = description; } } + + return true; } } } \ No newline at end of file diff --git a/src/Squidex/Areas/Api/Controllers/Apps/AppClientsController.cs b/src/Squidex/Areas/Api/Controllers/Apps/AppClientsController.cs index a17673252..b89697d26 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/AppClientsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/AppClientsController.cs @@ -5,11 +5,11 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== -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; @@ -41,12 +41,12 @@ namespace Squidex.Areas.Api.Controllers.Apps /// [HttpGet] [Route("apps/{app}/clients/")] - [ProducesResponseType(typeof(ClientDto[]), 200)] + [ProducesResponseType(typeof(ClientsDto), 200)] [ApiPermission(Permissions.AppClientsRead)] [ApiCosts(0)] public IActionResult GetClients(string app) { - var response = App.Clients.Select(ClientDto.FromKvp).ToArray(); + var response = ClientsDto.FromApp(App, this); Response.Headers[HeaderNames.ETag] = App.Version.ToString(); @@ -60,6 +60,7 @@ namespace Squidex.Areas.Api.Controllers.Apps /// Client object that needs to be added to the app. /// /// 201 => Client generated. + /// 400 => Client request not valid. /// 404 => App not found. /// /// @@ -68,16 +69,14 @@ namespace Squidex.Areas.Api.Controllers.Apps /// [HttpPost] [Route("apps/{app}/clients/")] - [ProducesResponseType(typeof(ClientDto), 201)] + [ProducesResponseType(typeof(ClientsDto), 200)] [ApiPermission(Permissions.AppClientsCreate)] [ApiCosts(1)] public async Task PostClient(string app, [FromBody] CreateClientDto request) { var command = request.ToCommand(); - await CommandBus.PublishAsync(command); - - var response = ClientDto.FromCommand(command); + var response = await InvokeCommandAsync(command); return CreatedAtAction(nameof(GetClients), new { app }, response); } @@ -86,10 +85,10 @@ namespace Squidex.Areas.Api.Controllers.Apps /// Updates an app client. /// /// The name of the app. - /// The id of the client that must be updated. + /// The id of the client that must be updated. /// Client object that needs to be updated. /// - /// 204 => Client updated. + /// 200 => Client updated. /// 400 => Client request not valid. /// 404 => Client or app not found. /// @@ -97,37 +96,53 @@ namespace Squidex.Areas.Api.Controllers.Apps /// Only the display name can be changed, create a new client if necessary. /// [HttpPut] - [Route("apps/{app}/clients/{clientId}/")] + [Route("apps/{app}/clients/{id}/")] + [ProducesResponseType(typeof(ClientsDto), 200)] [ApiPermission(Permissions.AppClientsUpdate)] [ApiCosts(1)] - public async Task PutClient(string app, string clientId, [FromBody] UpdateClientDto request) + public async Task PutClient(string app, string id, [FromBody] UpdateClientDto request) { - await CommandBus.PublishAsync(request.ToCommand(clientId)); + var command = request.ToCommand(id); + + var response = await InvokeCommandAsync(command); - return NoContent(); + return Ok(response); } /// /// Revoke an app client. /// /// The name of the app. - /// The id of the client that must be deleted. + /// The id of the client that must be deleted. /// - /// 204 => Client revoked. + /// 200 => Client revoked. /// 404 => Client or app not found. /// /// /// The application that uses this client credentials cannot access the API after it has been revoked. /// [HttpDelete] - [Route("apps/{app}/clients/{clientId}/")] + [Route("apps/{app}/clients/{id}/")] + [ProducesResponseType(typeof(ClientsDto), 200)] [ApiPermission(Permissions.AppClientsDelete)] [ApiCosts(1)] - public async Task DeleteClient(string app, string clientId) + public async Task DeleteClient(string app, string id) { - await CommandBus.PublishAsync(new RevokeClient { Id = clientId }); + var command = new RevokeClient { Id = 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 = ClientsDto.FromApp(result, this); - return NoContent(); + return response; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/AppContributorsController.cs b/src/Squidex/Areas/Api/Controllers/Apps/AppContributorsController.cs index 98187cf77..021afa123 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/AppContributorsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/AppContributorsController.cs @@ -9,6 +9,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.Domain.Apps.Entities.Apps.Invitation; using Squidex.Domain.Apps.Entities.Apps.Services; @@ -47,7 +48,7 @@ namespace Squidex.Areas.Api.Controllers.Apps [ApiCosts(0)] public IActionResult GetContributors(string app) { - var response = ContributorsDto.FromApp(App, appPlansProvider); + var response = ContributorsDto.FromApp(App, appPlansProvider, this, false); Response.Headers[HeaderNames.ETag] = App.Version.ToString(); @@ -60,14 +61,13 @@ 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. /// [HttpPost] [Route("apps/{app}/contributors/")] - [ProducesResponseType(typeof(ContributorAssignedDto), 201)] - [ProducesResponseType(typeof(ErrorDto), 400)] + [ProducesResponseType(typeof(ContributorsDto), 200)] [ApiPermission(Permissions.AppContributorsAssign)] [ApiCosts(1)] public async Task PostContributor(string app, [FromBody] AssignContributorDto request) @@ -75,18 +75,18 @@ namespace Squidex.Areas.Api.Controllers.Apps var command = request.ToCommand(); var context = await CommandBus.PublishAsync(command); - var response = (ContributorAssignedDto)null; + var response = (ContributorsDto)null; - if (context.PlainResult is EntityCreatedResult idOrValue) + if (context.PlainResult is IAppEntity newApp) { - response = ContributorAssignedDto.FromId(idOrValue.IdOrValue, false); + response = ContributorsDto.FromApp(newApp, appPlansProvider, this, false); } else if (context.PlainResult is InvitedResult invited) { - response = ContributorAssignedDto.FromId(invited.Id.IdOrValue, true); + response = ContributorsDto.FromApp(invited.App, appPlansProvider, this, true); } - return Ok(response); + return CreatedAtAction(nameof(GetContributors), new { app }, response); } /// @@ -95,20 +95,32 @@ namespace Squidex.Areas.Api.Controllers.Apps /// The name of the app. /// The id of the contributor. /// - /// 204 => User removed from app. + /// 200 => User removed from app. /// 400 => User is not assigned to the app. /// 404 => Contributor or app not found. /// [HttpDelete] [Route("apps/{app}/contributors/{id}/")] - [ProducesResponseType(typeof(ErrorDto), 400)] + [ProducesResponseType(typeof(ContributorsDto), 200)] [ApiPermission(Permissions.AppContributorsRevoke)] [ApiCosts(1)] public async Task DeleteContributor(string app, string id) { - await CommandBus.PublishAsync(new RemoveContributor { ContributorId = id }); + var command = new RemoveContributor { ContributorId = 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 = ContributorsDto.FromApp(result, appPlansProvider, this, false); - return NoContent(); + return response; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/AppLanguagesController.cs b/src/Squidex/Areas/Api/Controllers/Apps/AppLanguagesController.cs index 17ce8c320..03064da7b 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,17 +64,14 @@ namespace Squidex.Areas.Api.Controllers.Apps /// [HttpPost] [Route("apps/{app}/languages/")] - [ProducesResponseType(typeof(AppLanguageDto), 201)] - [ProducesResponseType(typeof(ErrorDto), 400)] + [ProducesResponseType(typeof(AppLanguagesDto), 201)] [ApiPermission(Permissions.AppLanguagesCreate)] [ApiCosts(1)] public async Task PostLanguage(string app, [FromBody] AddLanguageDto request) { var command = request.ToCommand(); - await CommandBus.PublishAsync(command); - - var response = AppLanguageDto.FromCommand(command); + var response = await InvokeCommandAsync(command); return CreatedAtAction(nameof(GetLanguages), new { app }, response); } @@ -85,19 +83,22 @@ 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)] [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(command); - return NoContent(); + return Ok(response); } /// @@ -106,18 +107,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(command); + + return Ok(response); + } + + private async Task InvokeCommandAsync(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/AppPatternsController.cs b/src/Squidex/Areas/Api/Controllers/Apps/AppPatternsController.cs index fd4fac1c5..022a20cab 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)] - [ApiPermission(Permissions.AppPatternsRead)] + [ProducesResponseType(typeof(PatternsDto), 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 = PatternsDto.FromApp(App, this); Response.Headers[HeaderNames.ETag] = App.Version.ToString(); @@ -66,16 +66,14 @@ namespace Squidex.Areas.Api.Controllers.Apps /// [HttpPost] [Route("apps/{app}/patterns/")] - [ProducesResponseType(typeof(AppPatternDto), 201)] + [ProducesResponseType(typeof(PatternsDto), 200)] [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); } @@ -87,20 +85,22 @@ namespace Squidex.Areas.Api.Controllers.Apps /// The id of the pattern to be updated. /// Pattern to be updated for the app. /// - /// 204 => Pattern updated. + /// 200 => Pattern updated. /// 400 => Pattern request not valid. /// 404 => Pattern or app not found. /// [HttpPut] [Route("apps/{app}/patterns/{id}/")] - [ProducesResponseType(typeof(AppPatternDto), 201)] + [ProducesResponseType(typeof(PatternsDto), 200)] [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 +109,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 +117,26 @@ namespace Squidex.Areas.Api.Controllers.Apps /// [HttpDelete] [Route("apps/{app}/patterns/{id}/")] + [ProducesResponseType(typeof(PatternsDto), 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 = PatternsDto.FromApp(result, this); - return NoContent(); + return response; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/AppRolesController.cs b/src/Squidex/Areas/Api/Controllers/Apps/AppRolesController.cs index e146c90b3..d51daaf2d 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/AppRolesController.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/AppRolesController.cs @@ -47,7 +47,7 @@ namespace Squidex.Areas.Api.Controllers.Apps [ApiCosts(0)] public IActionResult GetRoles(string app) { - var response = RolesDto.FromApp(App); + var response = RolesDto.FromApp(App, this); Response.Headers[HeaderNames.ETag] = App.Version.ToString(); @@ -82,64 +82,81 @@ namespace Squidex.Areas.Api.Controllers.Apps /// The name of the app. /// Role object that needs to be added to the app. /// - /// 200 => User assigned to app. + /// 201 => User assigned to app. /// 400 => Role name already in use. /// 404 => App not found. /// [HttpPost] [Route("apps/{app}/roles/")] - [ProducesResponseType(typeof(ErrorDto), 400)] + [ProducesResponseType(typeof(RolesDto), 200)] [ApiPermission(Permissions.AppRolesCreate)] [ApiCosts(1)] public async Task PostRole(string app, [FromBody] AddRoleDto request) { - await CommandBus.PublishAsync(request.ToCommand()); + var command = request.ToCommand(); + + var response = await InvokeCommandAsync(command); - return NoContent(); + return CreatedAtAction(nameof(GetRoles), new { app }, response); } /// /// 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. /// - /// 204 => Role updated. + /// 200 => Role updated. /// 400 => Role request not valid. /// 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) { - await CommandBus.PublishAsync(request.ToCommand(role)); + var command = request.ToCommand(name); + + var response = await InvokeCommandAsync(command); - return NoContent(); + return Ok(response); } /// /// Remove role from app. /// /// The name of the app. - /// The name of the role. + /// The name of the role. /// - /// 204 => Role deleted. + /// 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}/")] - [ProducesResponseType(typeof(ErrorDto), 400)] + [Route("apps/{app}/roles/{name}/")] + [ProducesResponseType(typeof(RolesDto), 200)] [ApiPermission(Permissions.AppRolesDelete)] [ApiCosts(1)] - public async Task DeleteRole(string app, string role) + public async Task DeleteRole(string app, string name) { - await CommandBus.PublishAsync(new DeleteRole { Name = role }); + var command = new DeleteRole { Name = name }; + + 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 = RolesDto.FromApp(result, this); - return NoContent(); + return response; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/AppsController.cs b/src/Squidex/Areas/Api/Controllers/Apps/AppsController.cs index 4219f42dd..1d2b9c26a 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/AppsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/AppsController.cs @@ -5,12 +5,12 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== -using System; 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; +using Squidex.Domain.Apps.Entities.Apps; using Squidex.Domain.Apps.Entities.Apps.Commands; using Squidex.Domain.Apps.Entities.Apps.Services; using Squidex.Infrastructure; @@ -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 apps = await appProvider.GetUserApps(userOrClientId, userPermissions); - var response = entities.ToArray(a => AppDto.FromApp(a, userOrClientId, userPermissions, appPlansProvider)); + var response = apps.ToArray(a => AppDto.FromApp(a, userOrClientId, userPermissions, appPlansProvider, this)); Response.Headers[HeaderNames.ETag] = response.ToManyEtag(); @@ -84,17 +84,18 @@ namespace Squidex.Areas.Api.Controllers.Apps /// [HttpPost] [Route("apps/")] - [ProducesResponseType(typeof(AppCreatedDto), 201)] - [ProducesResponseType(typeof(ErrorDto), 400)] - [ProducesResponseType(typeof(ErrorDto), 409)] + [ProducesResponseType(typeof(AppDto), 201)] [ApiPermission] [ApiCosts(1)] public async Task PostApp([FromBody] CreateAppDto request) { var context = await CommandBus.PublishAsync(request.ToCommand()); - var result = context.Result>(); - var response = AppCreatedDto.FromResult(request.Name, result, appPlansProvider); + var userOrClientId = HttpContext.User.UserOrClientId(); + var userPermissions = HttpContext.Permissions(); + + var result = context.Result(); + var response = AppDto.FromApp(result, userOrClientId, userPermissions, appPlansProvider, this); return CreatedAtAction(nameof(GetApps), response); } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppCreatedDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/AppCreatedDto.cs deleted file mode 100644 index 38e6adae1..000000000 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppCreatedDto.cs +++ /dev/null @@ -1,59 +0,0 @@ -// ========================================================================== -// Squidex Headless CMS -// ========================================================================== -// Copyright (c) Squidex UG (haftungsbeschränkt) -// 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.Services; -using Squidex.Infrastructure.Commands; - -namespace Squidex.Areas.Api.Controllers.Apps.Models -{ - public sealed class AppCreatedDto - { - /// - /// Id of the created entity. - /// - [Required] - public string Id { get; set; } - - /// - /// The permission level of the user. - /// - public string[] Permissions { get; set; } - - /// - /// The new version of the entity. - /// - public long Version { get; set; } - - /// - /// Gets the current plan name. - /// - public string PlanName { get; set; } - - /// - /// Gets the next plan name. - /// - public string PlanUpgrade { get; set; } - - public static AppCreatedDto FromResult(string name, EntityCreatedResult result, IAppPlansProvider apps) - { - var response = new AppCreatedDto - { - Id = result.IdOrValue.ToString(), - Permissions = Role.CreateOwner(name).Permissions.ToIds().ToArray(), - PlanName = apps.GetPlan(null)?.Name, - PlanUpgrade = apps.GetPlanUpgrade(null)?.Name, - Version = result.Version - }; - - return response; - } - } -} diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/AppDto.cs index 7fe96d7bc..6d706dc30 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/AppDto.cs @@ -9,17 +9,23 @@ 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.Ping; +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; 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. @@ -51,7 +57,17 @@ 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. + /// + public bool CanAccessApi { get; set; } + + /// + /// Indicates if the user can access at least one content. + /// + public bool CanAccessContent { get; set; } /// /// Gets the current plan name. @@ -63,7 +79,27 @@ 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 = GetPermissions(app, userId, userPermissions); + + var result = SimpleMapper.Map(app, new AppDto()); + + result.Permissions = permissions.ToIds(); + result.PlanName = plans.GetPlanForApp(app)?.Name; + + result.CanAccessApi = controller.HasPermission(AllPermissions.AppApi, app.Name, "*", permissions); + result.CanAccessContent = controller.HasPermission(AllPermissions.AppContentsRead, app.Name, "*", permissions); + + if (controller.HasPermission(AllPermissions.AppPlansChange, app.Name)) + { + result.PlanUpgrade = plans.GetPlanUpgradeForApp(app)?.Name; + } + + return result.CreateLinks(controller, permissions); + } + + private static PermissionSet GetPermissions(IAppEntity app, string userId, PermissionSet userPermissions) { var permissions = new List(); @@ -77,13 +113,81 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models permissions.AddRange(userPermissions.ToAppPermissions(app.Name)); } - var response = SimpleMapper.Map(app, new AppDto()); + return new PermissionSet(permissions); + } + + private AppDto CreateLinks(ApiController controller, PermissionSet permissions) + { + var values = new { app = Name }; + + AddGetLink("ping", controller.Url(x => nameof(x.GetAppPing), values)); + + if (controller.HasPermission(AllPermissions.AppDelete, Name, permissions: permissions)) + { + AddDeleteLink("delete", controller.Url(x => nameof(x.DeleteApp), values)); + } + + if (controller.HasPermission(AllPermissions.AppAssetsRead, Name, permissions: permissions)) + { + AddGetLink("assets", controller.Url(x => nameof(x.GetAssets), values)); + } + + if (controller.HasPermission(AllPermissions.AppBackupsRead, Name, permissions: permissions)) + { + AddGetLink("backups", controller.Url(x => nameof(x.GetBackups), values)); + } + + if (controller.HasPermission(AllPermissions.AppClientsRead, Name, permissions: permissions)) + { + AddGetLink("clients", controller.Url(x => nameof(x.GetClients), values)); + } + + if (controller.HasPermission(AllPermissions.AppContributorsRead, Name, permissions: permissions)) + { + AddGetLink("contributors", controller.Url(x => nameof(x.GetContributors), values)); + } + + if (controller.HasPermission(AllPermissions.AppCommon, Name, permissions: permissions)) + { + AddGetLink("languages", controller.Url(x => nameof(x.GetLanguages), values)); + } + + if (controller.HasPermission(AllPermissions.AppCommon, Name, permissions: permissions)) + { + AddGetLink("patterns", controller.Url(x => nameof(x.GetPatterns), values)); + } + + if (controller.HasPermission(AllPermissions.AppPlansRead, Name, permissions: permissions)) + { + AddGetLink("plans", controller.Url(x => nameof(x.GetPlans), values)); + } - response.Permissions = permissions.ToArray(x => x.Id); - response.PlanName = plans.GetPlanForApp(app)?.Name; - response.PlanUpgrade = plans.GetPlanUpgradeForApp(app)?.Name; + if (controller.HasPermission(AllPermissions.AppRolesRead, Name, permissions: permissions)) + { + AddGetLink("roles", controller.Url(x => nameof(x.GetRoles), values)); + } + + if (controller.HasPermission(AllPermissions.AppRulesRead, Name, permissions: permissions)) + { + AddGetLink("rules", controller.Url(x => nameof(x.GetRules), values)); + } + + if (controller.HasPermission(AllPermissions.AppCommon, Name, permissions: permissions)) + { + AddGetLink("schemas", controller.Url(x => nameof(x.GetSchemas), values)); + } + + if (controller.HasPermission(AllPermissions.AppSchemasCreate, Name, permissions: permissions)) + { + AddPostLink("schemas/create", controller.Url(x => nameof(x.PostSchema), values)); + } + + if (controller.HasPermission(AllPermissions.AppAssetsCreate, Name, permissions: permissions)) + { + AddPostLink("assets/create", controller.Url(x => nameof(x.PostSchema), values)); + } - return response; + return this; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppLanguageDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/AppLanguageDto.cs index 62501e4c2..85f6ef7ce 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 result.CreateLinks(controller, app); } - private static AppLanguageDto FromLanguage(LanguageConfig x, IAppEntity app) + private AppLanguageDto CreateLinks(ApiController controller, IAppEntity app) { - return SimpleMapper.Map(x.Language, - new AppLanguageDto + var values = new { app = app.Name, language = Iso2Code }; + + if (!IsMaster) + { + if (controller.HasPermission(Permissions.AppLanguagesUpdate, app.Name)) { - IsMaster = x == app.LanguagesConfig.Master, - IsOptional = x.IsOptional, - Fallback = x.LanguageFallbacks.ToArray() - }); + AddPutLink("update", controller.Url(x => nameof(x.PutLanguage), values)); + } + + if (controller.HasPermission(Permissions.AppLanguagesDelete, app.Name) && app.LanguagesConfig.Count > 1) + { + AddDeleteLink("delete", controller.Url(x => nameof(x.DeleteLanguage), values)); + } + } + + return this; } } } 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..77580f5e9 --- /dev/null +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/AppLanguagesDto.cs @@ -0,0 +1,53 @@ +// ========================================================================== +// 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.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 result.CreateLinks(controller, app.Name); + } + + private AppLanguagesDto CreateLinks(ApiController controller, string app) + { + var values = new { app }; + + AddSelfLink(controller.Url(x => nameof(x.GetLanguages), values)); + + if (controller.HasPermission(Permissions.AppLanguagesCreate, app)) + { + AddPostLink("create", controller.Url(x => nameof(x.PostLanguage), values)); + } + + return this; + } + } +} diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/ClientDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/ClientDto.cs index 75d6b8da3..a7a344251 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/ClientDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/ClientDto.cs @@ -5,16 +5,15 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== -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 Roles = Squidex.Domain.Apps.Core.Apps.Role; +using Squidex.Shared; +using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Apps.Models { - public sealed class ClientDto + public sealed class ClientDto : Resource { /// /// The client id. @@ -39,14 +38,28 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models /// public string Role { get; set; } - public static ClientDto FromKvp(KeyValuePair kvp) + public static ClientDto FromClient(string id, AppClient client, ApiController controller, string app) { - return SimpleMapper.Map(kvp.Value, new ClientDto { Id = kvp.Key }); + var result = SimpleMapper.Map(client, new ClientDto { Id = id }); + + return result.CreateLinks(controller, app); } - public static ClientDto FromCommand(AttachClient command) + private ClientDto CreateLinks(ApiController controller, string app) { - return SimpleMapper.Map(command, new ClientDto { Name = command.Id, Role = Roles.Editor }); + var values = new { app, id = Id }; + + if (controller.HasPermission(Permissions.AppClientsUpdate, app)) + { + AddPutLink("update", controller.Url(x => nameof(x.PutClient), values)); + } + + if (controller.HasPermission(Permissions.AppClientsDelete, app)) + { + AddDeleteLink("delete", controller.Url(x => nameof(x.DeleteClient), values)); + } + + return this; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/ClientsDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/ClientsDto.cs new file mode 100644 index 000000000..7116e99f2 --- /dev/null +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/ClientsDto.cs @@ -0,0 +1,48 @@ +// ========================================================================== +// 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.Shared; +using Squidex.Web; + +namespace Squidex.Areas.Api.Controllers.Apps.Models +{ + public sealed class ClientsDto : Resource + { + /// + /// The clients. + /// + [Required] + public ClientDto[] Items { get; set; } + + public static ClientsDto FromApp(IAppEntity app, ApiController controller) + { + var result = new ClientsDto + { + Items = app.Clients.Select(x => ClientDto.FromClient(x.Key, x.Value, controller, app.Name)).ToArray() + }; + + return result.CreateLinks(controller, app.Name); + } + + private ClientsDto CreateLinks(ApiController controller, string app) + { + var values = new { app }; + + AddSelfLink(controller.Url(x => nameof(x.GetClients), values)); + + if (controller.HasPermission(Permissions.AppClientsCreate, app)) + { + AddPostLink("create", controller.Url(x => nameof(x.PostClient), values)); + } + + return this; + } + } +} diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorDto.cs index 42ea190e5..4929ed76b 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorDto.cs @@ -6,10 +6,12 @@ // ========================================================================== using System.ComponentModel.DataAnnotations; +using Squidex.Shared; +using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Apps.Models { - public sealed class ContributorDto + public sealed class ContributorDto : Resource { /// /// The id of the user that contributes to the app. @@ -21,5 +23,30 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models /// The role of the contributor. /// public string Role { get; set; } + + public static ContributorDto FromIdAndRole(string id, string role, ApiController controller, string app) + { + var result = new ContributorDto { ContributorId = id, Role = role }; + + return result.CreateLinks(controller, app); + } + + private ContributorDto CreateLinks(ApiController controller, string app) + { + if (!controller.IsUser(ContributorId)) + { + if (controller.HasPermission(Permissions.AppContributorsAssign, app)) + { + AddPostLink("update", controller.Url(x => nameof(x.PostContributor), new { app })); + } + + if (controller.HasPermission(Permissions.AppContributorsRevoke, app)) + { + AddDeleteLink("delete", controller.Url(x => nameof(x.DeleteContributor), new { app, id = ContributorId })); + } + } + + 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 e482b1a69..9d8baf5e3 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorsDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorsDto.cs @@ -6,32 +6,68 @@ // ========================================================================== using System.ComponentModel.DataAnnotations; +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 { - public sealed class ContributorsDto + public sealed class ContributorsDto : Resource { /// /// The contributors. /// [Required] - public ContributorDto[] Contributors { get; set; } + public ContributorDto[] Items { get; set; } /// /// The maximum number of allowed contributors. /// public int MaxContributors { get; set; } - public static ContributorsDto FromApp(IAppEntity app, IAppPlansProvider plans) + /// + /// The metadata. + /// + [JsonProperty("_meta")] + public ContributorsMetadata Metadata { get; set; } + + public static ContributorsDto FromApp(IAppEntity app, IAppPlansProvider plans, ApiController controller, bool isInvited) { - var plan = plans.GetPlanForApp(app); + var contributors = app.Contributors.ToArray(x => ContributorDto.FromIdAndRole(x.Key, x.Value, controller, app.Name)); + + var result = new ContributorsDto + { + Items = contributors, + }; + + if (isInvited) + { + result.Metadata = new ContributorsMetadata + { + IsInvited = isInvited.ToString() + }; + } + + result.MaxContributors = plans.GetPlanForApp(app).MaxContributors; + + return result.CreateLinks(controller, app.Name); + } + + private ContributorsDto CreateLinks(ApiController controller, string app) + { + var values = new { app }; + + AddSelfLink(controller.Url(x => nameof(x.GetContributors), values)); - var contributors = app.Contributors.ToArray(x => new ContributorDto { ContributorId = x.Key, Role = x.Value }); + if (controller.HasPermission(Permissions.AppContributorsAssign, app) && (MaxContributors < 0 || Items.Length < MaxContributors)) + { + AddPostLink("create", controller.Url(x => nameof(x.PostContributor), values)); + } - return new ContributorsDto { Contributors = contributors, MaxContributors = plan.MaxContributors }; + return this; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorsMetadata.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorsMetadata.cs new file mode 100644 index 000000000..0d0950441 --- /dev/null +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorsMetadata.cs @@ -0,0 +1,17 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschraenkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +namespace Squidex.Areas.Api.Controllers.Apps.Models +{ + public sealed class ContributorsMetadata + { + /// + /// Indicates whether the user has been invited. + /// + public string IsInvited { get; set; } + } +} diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppPatternDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/PatternDto.cs similarity index 53% rename from src/Squidex/Areas/Api/Controllers/Apps/Models/AppPatternDto.cs rename to src/Squidex/Areas/Api/Controllers/Apps/Models/PatternDto.cs index ad8efa50f..1377aee3e 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/AppPatternDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/PatternDto.cs @@ -6,20 +6,20 @@ // ========================================================================== 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.Shared; +using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Apps.Models { - public sealed class AppPatternDto + 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. @@ -38,14 +38,28 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models /// public string Message { get; set; } - public static AppPatternDto FromKvp(KeyValuePair kvp) + public static PatternDto 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 PatternDto { Id = id }); + + return result.CreateLinks(controller, app); } - public static AppPatternDto FromCommand(AddPattern command) + private PatternDto CreateLinks(ApiController controller, string app) { - return SimpleMapper.Map(command, new AppPatternDto()); + 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/PatternsDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/PatternsDto.cs new file mode 100644 index 000000000..ca9a2605a --- /dev/null +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/PatternsDto.cs @@ -0,0 +1,48 @@ +// ========================================================================== +// 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.Shared; +using Squidex.Web; + +namespace Squidex.Areas.Api.Controllers.Apps.Models +{ + public sealed class PatternsDto : Resource + { + /// + /// The patterns. + /// + [Required] + public PatternDto[] Items { get; set; } + + public static PatternsDto FromApp(IAppEntity app, ApiController controller) + { + var result = new PatternsDto + { + Items = app.Patterns.Select(x => PatternDto.FromPattern(x.Key, x.Value, controller, app.Name)).ToArray() + }; + + return result.CreateLinks(controller, app.Name); + } + + 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 2c833707b..f703c3cf5 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/RoleDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/RoleDto.cs @@ -5,16 +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. @@ -32,23 +33,51 @@ 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. /// [Required] public IEnumerable Permissions { get; set; } - public static RoleDto FromRole(Role role, IAppEntity app) + public static RoleDto FromRole(Role role, IAppEntity app, ApiController controller) { var permissions = role.Permissions.WithoutApp(app.Name); - return new RoleDto + 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 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 64390c625..b43c32041 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/RolesDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/RolesDto.cs @@ -8,22 +8,41 @@ 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 RolesDto + public sealed class RolesDto : Resource { /// - /// The app roles. + /// The roles. /// [Required] - public RoleDto[] Roles { get; set; } + public RoleDto[] Items { get; set; } - public static RolesDto FromApp(IAppEntity app) + public static RolesDto FromApp(IAppEntity app, ApiController controller) { - var roles = app.Roles.Values.Select(x => RoleDto.FromRole(x, app)).ToArray(); + var result = new RolesDto + { + Items = app.Roles.Values.Select(x => RoleDto.FromRole(x, app, controller)).OrderBy(x => x.Name).ToArray() + }; - return new RolesDto { Roles = roles }; + return result.CreateLinks(controller, app.Name); + } + + 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/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/AssetContentController.cs b/src/Squidex/Areas/Api/Controllers/Assets/AssetContentController.cs index 8d947d64c..48c0dc0e0 100644 --- a/src/Squidex/Areas/Api/Controllers/Assets/AssetContentController.cs +++ b/src/Squidex/Areas/Api/Controllers/Assets/AssetContentController.cs @@ -74,18 +74,18 @@ namespace Squidex.Areas.Api.Controllers.Assets [FromQuery] int? quality = null, [FromQuery] string mode = null) { - IAssetEntity entity; + IAssetEntity asset; if (Guid.TryParse(idOrSlug, out var guid)) { - entity = await assetRepository.FindAssetAsync(guid); + asset = await assetRepository.FindAssetAsync(guid); } else { - entity = await assetRepository.FindAssetBySlugAsync(App.Id, idOrSlug); + asset = await assetRepository.FindAssetBySlugAsync(App.Id, idOrSlug); } - return DeliverAsset(entity, version, width, height, quality, mode, dl); + return DeliverAsset(asset, version, width, height, quality, mode, dl); } /// @@ -115,25 +115,25 @@ namespace Squidex.Areas.Api.Controllers.Assets [FromQuery] int? quality = null, [FromQuery] string mode = null) { - var entity = await assetRepository.FindAssetAsync(id); + var asset = await assetRepository.FindAssetAsync(id); - return DeliverAsset(entity, version, width, height, quality, mode, dl); + return DeliverAsset(asset, version, width, height, quality, mode, dl); } - private IActionResult DeliverAsset(IAssetEntity entity, long version, int? width, int? height, int? quality, string mode, int download = 1) + private IActionResult DeliverAsset(IAssetEntity asset, long version, int? width, int? height, int? quality, string mode, int download = 1) { - if (entity == null || entity.FileVersion < version || width == 0 || height == 0 || quality == 0) + if (asset == null || asset.FileVersion < version || width == 0 || height == 0 || quality == 0) { return NotFound(); } - Response.Headers[HeaderNames.ETag] = entity.FileVersion.ToString(); + Response.Headers[HeaderNames.ETag] = asset.FileVersion.ToString(); var handler = new Func(async bodyStream => { - var assetId = entity.Id.ToString(); + var assetId = asset.Id.ToString(); - if (entity.IsImage && (width.HasValue || height.HasValue || quality.HasValue)) + if (asset.IsImage && (width.HasValue || height.HasValue || quality.HasValue)) { var assetSuffix = $"{width}_{height}_{mode}"; @@ -144,7 +144,7 @@ namespace Squidex.Areas.Api.Controllers.Assets try { - await assetStore.DownloadAsync(assetId, entity.FileVersion, assetSuffix, bodyStream); + await assetStore.DownloadAsync(assetId, asset.FileVersion, assetSuffix, bodyStream); } catch (AssetNotFoundException) { @@ -156,7 +156,7 @@ namespace Squidex.Areas.Api.Controllers.Assets { using (Profiler.Trace("ResizeDownload")) { - await assetStore.DownloadAsync(assetId, entity.FileVersion, null, sourceStream); + await assetStore.DownloadAsync(assetId, asset.FileVersion, null, sourceStream); sourceStream.Position = 0; } @@ -168,7 +168,7 @@ namespace Squidex.Areas.Api.Controllers.Assets using (Profiler.Trace("ResizeUpload")) { - await assetStore.UploadAsync(assetId, entity.FileVersion, assetSuffix, destinationStream); + await assetStore.UploadAsync(assetId, asset.FileVersion, assetSuffix, destinationStream); destinationStream.Position = 0; } @@ -180,17 +180,17 @@ namespace Squidex.Areas.Api.Controllers.Assets } else { - await assetStore.DownloadAsync(assetId, entity.FileVersion, null, bodyStream); + await assetStore.DownloadAsync(assetId, asset.FileVersion, null, bodyStream); } }); if (download == 1) { - return new FileCallbackResult(entity.MimeType, entity.FileName, true, handler); + return new FileCallbackResult(asset.MimeType, asset.FileName, true, handler); } else { - return new FileCallbackResult(entity.MimeType, null, true, handler); + return new FileCallbackResult(asset.MimeType, null, true, handler); } } diff --git a/src/Squidex/Areas/Api/Controllers/Assets/AssetsController.cs b/src/Squidex/Areas/Api/Controllers/Assets/AssetsController.cs index 041adcdde..965056fbe 100644 --- a/src/Squidex/Areas/Api/Controllers/Assets/AssetsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Assets/AssetsController.cs @@ -105,14 +105,14 @@ namespace Squidex.Areas.Api.Controllers.Assets var assets = await assetQuery.QueryAsync(context, Q.Empty.WithODataQuery(Request.QueryString.ToString()).WithIds(ids)); - var response = AssetsDto.FromAssets(assets); + var response = AssetsDto.FromAssets(assets, this, app); 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); } @@ -135,21 +135,21 @@ namespace Squidex.Areas.Api.Controllers.Assets { var context = Context(); - var entity = await assetQuery.FindAssetAsync(context, id); + var asset = await assetQuery.FindAssetAsync(context, id); - if (entity == null) + if (asset == null) { return NotFound(); } - var response = AssetDto.FromAsset(entity); + var response = AssetDto.FromAsset(asset, this, app); if (controllerOptions.Value.EnableSurrogateKeys) { - Response.Headers["Surrogate-Key"] = entity.Id.ToString(); + Response.Headers["Surrogate-Key"] = asset.Id.ToString(); } - Response.Headers[HeaderNames.ETag] = entity.Version.ToString(); + Response.Headers[HeaderNames.ETag] = asset.Version.ToString(); return Ok(response); } @@ -169,8 +169,7 @@ namespace Squidex.Areas.Api.Controllers.Assets /// [HttpPost] [Route("apps/{app}/assets/")] - [ProducesResponseType(typeof(AssetCreatedDto), 201)] - [ProducesResponseType(typeof(ErrorDto), 400)] + [ProducesResponseType(typeof(AssetDto), 200)] [AssetRequestSizeLimit] [ApiPermission(Permissions.AppAssetsCreate)] [ApiCosts(1)] @@ -179,12 +178,13 @@ namespace Squidex.Areas.Api.Controllers.Assets var assetFile = await CheckAssetFileAsync(file); var command = new CreateAsset { File = assetFile }; + var context = await CommandBus.PublishAsync(command); var result = context.Result(); - var response = AssetCreatedDto.FromCommand(command, result); + var response = AssetDto.FromAsset(result.Asset, this, app, result.Tags, result.IsDuplicate); - return StatusCode(201, response); + return CreatedAtAction(nameof(GetAsset), new { app, id = response.Id }, response); } /// @@ -194,7 +194,7 @@ namespace Squidex.Areas.Api.Controllers.Assets /// The id of the asset. /// The file to upload. /// - /// 201 => Asset updated. + /// 200 => Asset updated. /// 404 => Asset or app not found. /// 400 => Asset exceeds the maximum size. /// @@ -203,8 +203,7 @@ namespace Squidex.Areas.Api.Controllers.Assets /// [HttpPut] [Route("apps/{app}/assets/{id}/content/")] - [ProducesResponseType(typeof(AssetReplacedDto), 201)] - [ProducesResponseType(typeof(ErrorDto), 400)] + [ProducesResponseType(typeof(AssetDto), 200)] [ApiPermission(Permissions.AppAssetsUpdate)] [ApiCosts(1)] public async Task PutAssetContent(string app, Guid id, [SwaggerIgnore] List file) @@ -212,12 +211,10 @@ namespace Squidex.Areas.Api.Controllers.Assets var assetFile = await CheckAssetFileAsync(file); var command = new UpdateAsset { File = assetFile, AssetId = id }; - var context = await CommandBus.PublishAsync(command); - var result = context.Result(); - var response = AssetReplacedDto.FromCommand(command, result); + var response = await InvokeCommandAsync(app, command); - return StatusCode(201, response); + return Ok(response); } /// @@ -227,21 +224,23 @@ namespace Squidex.Areas.Api.Controllers.Assets /// The id of the asset. /// The asset object that needs to updated. /// - /// 204 => Asset updated. + /// 200 => Asset updated. /// 400 => Asset name not valid. /// 404 => Asset or app not found. /// [HttpPut] [Route("apps/{app}/assets/{id}/")] - [ProducesResponseType(typeof(ErrorDto), 400)] + [ProducesResponseType(typeof(AssetDto), 200)] [AssetRequestSizeLimit] [ApiPermission(Permissions.AppAssetsUpdate)] [ApiCosts(1)] public async Task PutAsset(string app, Guid id, [FromBody] AnnotateAssetDto request) { - await CommandBus.PublishAsync(request.ToCommand(id)); + var command = request.ToCommand(id); - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -250,7 +249,7 @@ namespace Squidex.Areas.Api.Controllers.Assets /// The name of the app. /// The id of the asset to delete. /// - /// 204 => Asset has been deleted. + /// 204 => Asset deleted. /// 404 => Asset or app not found. /// [HttpDelete] @@ -264,6 +263,16 @@ namespace Squidex.Areas.Api.Controllers.Assets return NoContent(); } + private async Task InvokeCommandAsync(string app, ICommand command) + { + var context = await CommandBus.PublishAsync(command); + + var result = context.Result(); + var response = AssetDto.FromAsset(result.Asset, this, app, result.Tags); + + return response; + } + private async Task CheckAssetFileAsync(IReadOnlyList file) { if (file.Count != 1) diff --git a/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetCreatedDto.cs b/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetCreatedDto.cs deleted file mode 100644 index da76057c0..000000000 --- a/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetCreatedDto.cs +++ /dev/null @@ -1,108 +0,0 @@ -// ========================================================================== -// Squidex Headless CMS -// ========================================================================== -// Copyright (c) Squidex UG (haftungsbeschränkt) -// All rights reserved. Licensed under the MIT license. -// ========================================================================== - -using System; -using System.Collections.Generic; -using System.ComponentModel.DataAnnotations; -using Squidex.Domain.Apps.Entities.Assets; -using Squidex.Domain.Apps.Entities.Assets.Commands; -using Squidex.Infrastructure; - -namespace Squidex.Areas.Api.Controllers.Assets.Models -{ - public sealed class AssetCreatedDto - { - /// - /// The id of the asset. - /// - public Guid Id { get; set; } - - /// - /// The file type. - /// - [Required] - public string FileType { get; set; } - - /// - /// The file name. - /// - [Required] - public string FileName { get; set; } - - /// - /// The slug. - /// - [Required] - public string Slug { get; set; } - - /// - /// The mime type. - /// - [Required] - public string MimeType { get; set; } - - /// - /// The default tags. - /// - [Required] - public HashSet Tags { get; set; } - - /// - /// The size of the file in bytes. - /// - public long FileSize { get; set; } - - /// - /// The version of the file. - /// - public long FileVersion { get; set; } - - /// - /// Determines of the created file is an image. - /// - public bool IsImage { get; set; } - - /// - /// The width of the image in pixels if the asset is an image. - /// - public int? PixelWidth { get; set; } - - /// - /// The height of the image in pixels if the asset is an image. - /// - public int? PixelHeight { get; set; } - - /// - /// Indicates if the asset has been already uploaded. - /// - public bool IsDuplicate { get; set; } - - /// - /// The version of the asset. - /// - public long Version { get; set; } - - public static AssetCreatedDto FromCommand(CreateAsset command, AssetCreatedResult result) - { - return new AssetCreatedDto - { - Id = result.IdOrValue, - FileName = command.File.FileName, - FileSize = command.File.FileSize, - FileType = command.File.FileName.FileType(), - FileVersion = result.FileVersion, - MimeType = command.File.MimeType, - IsImage = command.ImageInfo != null, - IsDuplicate = result.IsDuplicate, - PixelWidth = command.ImageInfo?.PixelWidth, - PixelHeight = command.ImageInfo?.PixelHeight, - Tags = result.Tags, - Version = result.Version - }; - } - } -} diff --git a/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetDto.cs b/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetDto.cs index 1053302be..ec0e68899 100644 --- a/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetDto.cs @@ -8,15 +8,17 @@ using System; using System.Collections.Generic; using System.ComponentModel.DataAnnotations; +using Newtonsoft.Json; using NodaTime; using Squidex.Domain.Apps.Entities.Assets; using Squidex.Infrastructure; using Squidex.Infrastructure.Reflection; +using Squidex.Shared; using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Assets.Models { - public sealed class AssetDto : IGenerateETag + public sealed class AssetDto : Resource, IGenerateETag { /// /// The id of the asset. @@ -110,9 +112,54 @@ namespace Squidex.Areas.Api.Controllers.Assets.Models /// public long Version { get; set; } - public static AssetDto FromAsset(IAssetEntity asset) + /// + /// The metadata. + /// + [JsonProperty("_meta")] + public AssetMetadata Metadata { get; set; } + + public static AssetDto FromAsset(IAssetEntity asset, ApiController controller, string app, HashSet tags = null, bool isDuplicate = false) { - return SimpleMapper.Map(asset, new AssetDto { FileType = asset.FileName.FileType() }); + var response = SimpleMapper.Map(asset, new AssetDto { FileType = asset.FileName.FileType() }); + + if (tags != null) + { + response.Tags = tags; + } + + if (isDuplicate) + { + response.Metadata = new AssetMetadata { IsDuplicate = "true" }; + } + + return CreateLinks(response, controller, app); + } + + private static AssetDto CreateLinks(AssetDto response, ApiController controller, string app) + { + var values = new { app, id = response.Id }; + + response.AddSelfLink(controller.Url(x => nameof(x.GetAsset), values)); + + if (controller.HasPermission(Permissions.AppAssetsUpdate)) + { + response.AddPutLink("update", controller.Url(x => nameof(x.PutAsset), values)); + response.AddPutLink("upload", controller.Url(x => nameof(x.PutAssetContent), values)); + } + + if (controller.HasPermission(Permissions.AppAssetsDelete)) + { + response.AddDeleteLink("delete", controller.Url(x => nameof(x.DeleteAsset), values)); + } + + response.AddGetLink("content", controller.Url(x => nameof(x.GetAssetContent), new { id = response.Id, version = response.FileVersion })); + + if (!string.IsNullOrWhiteSpace(response.Slug)) + { + response.AddGetLink("content/slug", controller.Url(x => nameof(x.GetAssetContentBySlug), new { app, idOrSlug = response.Slug, version = response.Version })); + } + + return response; } } } diff --git a/src/Squidex.Domain.Apps.Entities/Contents/StatusForFrontend.cs b/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetMetadata.cs similarity index 61% rename from src/Squidex.Domain.Apps.Entities/Contents/StatusForFrontend.cs rename to src/Squidex/Areas/Api/Controllers/Assets/Models/AssetMetadata.cs index b29257b0c..71f8e9065 100644 --- a/src/Squidex.Domain.Apps.Entities/Contents/StatusForFrontend.cs +++ b/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetMetadata.cs @@ -5,12 +5,13 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== -namespace Squidex.Domain.Apps.Entities.Contents +namespace Squidex.Areas.Api.Controllers.Assets.Models { - public enum StatusForFrontend + public sealed class AssetMetadata { - PublishedDraft, - PublishedOnly, - Archived + /// + /// Indicates whether the asset is a duplicate. + /// + public string IsDuplicate { get; set; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetReplacedDto.cs b/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetReplacedDto.cs deleted file mode 100644 index e65faf494..000000000 --- a/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetReplacedDto.cs +++ /dev/null @@ -1,74 +0,0 @@ -// ========================================================================== -// Squidex Headless CMS -// ========================================================================== -// Copyright (c) Squidex UG (haftungsbeschränkt) -// All rights reserved. Licensed under the MIT license. -// ========================================================================== - -using System.ComponentModel.DataAnnotations; -using Squidex.Domain.Apps.Entities.Assets; -using Squidex.Domain.Apps.Entities.Assets.Commands; - -namespace Squidex.Areas.Api.Controllers.Assets.Models -{ - public sealed class AssetReplacedDto - { - /// - /// The mime type. - /// - [Required] - public string MimeType { get; set; } - - /// - /// The file hash. - /// - [Required] - public string FileHash { get; set; } - - /// - /// The size of the file in bytes. - /// - public long FileSize { get; set; } - - /// - /// The version of the file. - /// - public long FileVersion { get; set; } - - /// - /// Determines of the created file is an image. - /// - public bool IsImage { get; set; } - - /// - /// The width of the image in pixels if the asset is an image. - /// - public int? PixelWidth { get; set; } - - /// - /// The height of the image in pixels if the asset is an image. - /// - public int? PixelHeight { get; set; } - - /// - /// The version of the asset. - /// - public long Version { get; set; } - - public static AssetReplacedDto FromCommand(UpdateAsset command, AssetSavedResult result) - { - var response = new AssetReplacedDto - { - FileSize = command.File.FileSize, - FileVersion = result.FileVersion, - MimeType = command.File.MimeType, - IsImage = command.ImageInfo != null, - PixelWidth = command.ImageInfo?.PixelWidth, - PixelHeight = command.ImageInfo?.PixelHeight, - Version = result.Version - }; - - return response; - } - } -} diff --git a/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetsDto.cs b/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetsDto.cs index 6e81fa113..f6ceca82d 100644 --- a/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetsDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetsDto.cs @@ -9,25 +9,59 @@ using System.ComponentModel.DataAnnotations; using System.Linq; using Squidex.Domain.Apps.Entities.Assets; using Squidex.Infrastructure; +using Squidex.Shared; +using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Assets.Models { - public sealed class AssetsDto + public sealed class AssetsDto : Resource { + /// + /// The total number of assets. + /// + public long Total { get; set; } + /// /// The assets. /// [Required] public AssetDto[] Items { get; set; } - /// - /// The total number of assets. - /// - public long Total { get; set; } + public string ToEtag() + { + return Items.ToManyEtag(Total); + } - public static AssetsDto FromAssets(IResultList assets) + public string ToSurrogateKeys() { - return new AssetsDto { Total = assets.Total, Items = assets.Select(AssetDto.FromAsset).ToArray() }; + return Items.ToSurrogateKeys(); + } + + public static AssetsDto FromAssets(IResultList assets, ApiController controller, string app) + { + var response = new AssetsDto + { + Total = assets.Total, + Items = assets.Select(x => AssetDto.FromAsset(x, controller, app)).ToArray() + }; + + return CreateLinks(response, controller, app); + } + + private static AssetsDto CreateLinks(AssetsDto response, ApiController controller, string app) + { + var values = new { app }; + + response.AddSelfLink(controller.Url(x => nameof(x.GetAssets), values)); + + if (controller.HasPermission(Permissions.AppAssetsCreate)) + { + response.AddPostLink("create", controller.Url(x => nameof(x.PostAsset), values)); + } + + response.AddGetLink("tags", controller.Url(x => nameof(x.GetTags), values)); + + return response; } } } 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..8f39a7140 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 result.CreateLinks(controller, app); + } + + private BackupJobDto CreateLinks(ApiController controller, string app) + { + var values = new { app, id = Id }; + + if (controller.HasPermission(Permissions.AppBackupsDelete, app)) + { + AddDeleteLink("delete", controller.Url(x => nameof(x.DeleteBackup), values)); + } + + return this; } } } 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..d533a5030 --- /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 result.CreateLinks(controller, app); + } + + private BackupJobsDto CreateLinks(ApiController controller, string app) + { + var values = new { app }; + + AddSelfLink(controller.Url(x => nameof(x.GetBackups), values)); + + if (controller.HasPermission(Permissions.AppBackupsCreate, app)) + { + AddPostLink("create", controller.Url(x => nameof(x.PostBackup), values)); + } + + return this; + } + } +} 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/Comments/CommentsController.cs b/src/Squidex/Areas/Api/Controllers/Comments/CommentsController.cs index 5603ec207..6125003f5 100644 --- a/src/Squidex/Areas/Api/Controllers/Comments/CommentsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Comments/CommentsController.cs @@ -76,7 +76,6 @@ namespace Squidex.Areas.Api.Controllers.Comments [HttpPost] [Route("apps/{app}/comments/{commentsId}")] [ProducesResponseType(typeof(EntityCreatedDto), 201)] - [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppCommon)] [ApiCosts(0)] public async Task PostComment(string app, Guid commentsId, [FromBody] UpsertCommentDto request) @@ -104,7 +103,6 @@ namespace Squidex.Areas.Api.Controllers.Comments /// [HttpPut] [Route("apps/{app}/comments/{commentsId}/{commentId}")] - [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppCommon)] [ApiCosts(0)] public async Task PutComment(string app, Guid commentsId, Guid commentId, [FromBody] UpsertCommentDto request) @@ -126,7 +124,6 @@ namespace Squidex.Areas.Api.Controllers.Comments /// [HttpDelete] [Route("apps/{app}/comments/{commentsId}/{commentId}")] - [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppCommon)] [ApiCosts(0)] public async Task DeleteComment(string app, Guid commentsId, Guid commentId) diff --git a/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs b/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs index fc1e9e63f..675833005 100644 --- a/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Contents/ContentsController.cs @@ -6,13 +6,10 @@ // ========================================================================== using System; -using System.Linq; 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; @@ -21,7 +18,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 @@ -111,7 +107,6 @@ namespace Squidex.Areas.Api.Controllers.Contents /// /// The name of the app. /// The optional ids of the content to fetch. - /// The requested status, only for frontend client. /// /// 200 => Contents retrieved. /// 404 => App not found. @@ -121,26 +116,22 @@ namespace Squidex.Areas.Api.Controllers.Contents /// [HttpGet] [Route("content/{app}/")] + [ProducesResponseType(typeof(ContentsDto), 200)] [ApiPermission] [ApiCosts(1)] - public async Task GetAllContents(string app, [FromQuery] string ids, [FromQuery] string status = null) + public async Task GetAllContents(string app, [FromQuery] string ids) { - var context = Context().WithFrontendStatus(status); - - var result = await contentQuery.QueryAsync(context, Q.Empty.WithIds(ids).Ids); + var context = Context(); + var contents = 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(contents.Count, contents, context, this, app, null); 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); } @@ -151,7 +142,6 @@ namespace Squidex.Areas.Api.Controllers.Contents /// The name of the app. /// The name of the schema. /// The optional ids of the content to fetch. - /// The requested status, only for frontend client. /// /// 200 => Contents retrieved. /// 404 => Schema or app not found. @@ -161,26 +151,22 @@ namespace Squidex.Areas.Api.Controllers.Contents /// [HttpGet] [Route("content/{app}/{name}/")] + [ProducesResponseType(typeof(ContentsDto), 200)] [ApiPermission] [ApiCosts(1)] - public async Task GetContents(string app, string name, [FromQuery] string ids = null, [FromQuery] string status = null) + public async Task GetContents(string app, string name, [FromQuery] string ids = null) { - var context = Context().WithFrontendStatus(status); - - var result = await contentQuery.QueryAsync(context, name, Q.Empty.WithIds(ids).WithODataQuery(Request.QueryString.ToString())); + var context = Context(); + var contents = 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(contents.Total, contents, context, this, app, name); - if (controllerOptions.Value.EnableSurrogateKeys && response.Items.Length <= controllerOptions.Value.MaxItemsForSurrogateKeys) + if (ShouldProvideSurrogateKeys(response)) { - 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); } @@ -200,6 +186,7 @@ namespace Squidex.Areas.Api.Controllers.Contents /// [HttpGet] [Route("content/{app}/{name}/{id}/")] + [ProducesResponseType(typeof(ContentsDto), 200)] [ApiPermission] [ApiCosts(1)] public async Task GetContent(string app, string name, Guid id) @@ -207,7 +194,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, name); if (controllerOptions.Value.EnableSurrogateKeys) { @@ -243,7 +230,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, name); if (controllerOptions.Value.EnableSurrogateKeys) { @@ -272,25 +259,21 @@ namespace Squidex.Areas.Api.Controllers.Contents /// [HttpPost] [Route("content/{app}/{name}/")] + [ProducesResponseType(typeof(ContentsDto), 200)] [ApiPermission(Permissions.AppContentsCreate)] [ApiCosts(1)] public async Task PostContent(string app, string name, [FromBody] NamedContentData request, [FromQuery] bool publish = false) { await contentQuery.ThrowIfSchemaNotExistsAsync(Context(), name); - var publishPermission = Permissions.ForApp(Permissions.AppContentsPublish, app, name); - - if (publish && !User.Permissions().Includes(publishPermission)) + 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); } @@ -313,6 +296,7 @@ namespace Squidex.Areas.Api.Controllers.Contents /// [HttpPut] [Route("content/{app}/{name}/{id}/")] + [ProducesResponseType(typeof(ContentsDto), 200)] [ApiPermission(Permissions.AppContentsUpdate)] [ApiCosts(1)] public async Task PutContent(string app, string name, Guid id, [FromBody] NamedContentData request, [FromQuery] bool asDraft = false) @@ -320,10 +304,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); } @@ -346,6 +328,7 @@ namespace Squidex.Areas.Api.Controllers.Contents /// [HttpPatch] [Route("content/{app}/{name}/{id}/")] + [ProducesResponseType(typeof(ContentsDto), 200)] [ApiPermission(Permissions.AppContentsUpdate)] [ApiCosts(1)] public async Task PatchContent(string app, string name, Guid id, [FromBody] NamedContentData request, [FromQuery] bool asDraft = false) @@ -353,10 +336,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); } @@ -367,118 +348,34 @@ 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. - /// - /// 204 => Content published. - /// 404 => Content, schema or app not found. - /// 400 => Content was already published. - /// - /// - /// 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. + /// The status request. /// - /// 204 => Content unpublished. + /// 200 => Content published. /// 404 => Content, schema or app not found. - /// 400 => Content was not 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}/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/")] + [ProducesResponseType(typeof(ContentsDto), 200)] + [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); } /// @@ -488,7 +385,7 @@ namespace Squidex.Areas.Api.Controllers.Contents /// The name of the schema. /// The id of the content item to discard changes. /// - /// 204 => Content restored. + /// 200 => Content restored. /// 404 => Content, schema or app not found. /// 400 => Content was not archived. /// @@ -497,17 +394,18 @@ namespace Squidex.Areas.Api.Controllers.Contents /// [HttpPut] [Route("content/{app}/{name}/{id}/discard/")] + [ProducesResponseType(typeof(ContentsDto), 200)] [ApiPermission(Permissions.AppContentsDiscard)] [ApiCosts(1)] - public async Task DiscardChanges(string app, string name, Guid id) + public async Task DiscardDraft(string app, string name, Guid id) { await contentQuery.ThrowIfSchemaNotExistsAsync(Context(), name); var command = new DiscardChanges { ContentId = id }; - await CommandBus.PublishAsync(command); + var response = await InvokeCommandAsync(app, name, command); - return NoContent(); + return Ok(response); } /// @@ -517,7 +415,7 @@ namespace Squidex.Areas.Api.Controllers.Contents /// The name of the schema. /// The id of the content item to delete. /// - /// 204 => Content has been deleted. + /// 204 => Content deleted. /// 404 => Content, schema or app not found. /// /// @@ -538,21 +436,14 @@ namespace Squidex.Areas.Api.Controllers.Contents return NoContent(); } - 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() @@ -563,5 +454,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..4aad54547 100644 --- a/src/Squidex/Areas/Api/Controllers/Contents/Generator/SchemaSwaggerGenerator.cs +++ b/src/Squidex/Areas/Api/Controllers/Contents/Generator/SchemaSwaggerGenerator.cs @@ -32,6 +32,7 @@ namespace Squidex.Areas.Api.Controllers.Contents.Generator private readonly string schemaName; private readonly string schemaType; private readonly string appPath; + private readonly JsonSchema4 statusSchema; private readonly string appName; static SchemaSwaggerGenerator() @@ -46,6 +47,7 @@ namespace Squidex.Areas.Api.Controllers.Contents.Generator string appPath, Schema schema, SchemaResolver schemaResolver, + JsonSchema4 statusSchema, PartitionResolver partitionResolver) { this.document = document; @@ -53,6 +55,8 @@ namespace Squidex.Areas.Api.Controllers.Contents.Generator this.appName = appName; this.appPath = appPath; + this.statusSchema = statusSchema; + schemaPath = schema.Name; schemaName = schema.DisplayName(); schemaType = schema.TypeName(); @@ -72,15 +76,13 @@ namespace Squidex.Areas.Api.Controllers.Contents.Generator var schemaOperations = new List { - GenerateSchemaQueryOperation(), - GenerateSchemaCreateOperation(), + GenerateSchemaGetsOperation(), GenerateSchemaGetOperation(), + GenerateSchemaCreateOperation(), GenerateSchemaUpdateOperation(), - GenerateSchemaPatchOperation(), - GenerateSchemaPublishOperation(), - GenerateSchemaUnpublishOperation(), - GenerateSchemaArchiveOperation(), - GenerateSchemaRestoreOperation(), + GenerateSchemaUpdatePatchOperation(), + GenerateSchemaStatusOperation(), + GenerateSchemaDiscardOperation(), GenerateSchemaDeleteOperation() }; @@ -90,11 +92,12 @@ namespace Squidex.Areas.Api.Controllers.Contents.Generator } } - private SwaggerPathItem GenerateSchemaQueryOperation() + private SwaggerPathItem GenerateSchemaGetsOperation() { return AddOperation(SwaggerOperationMethod.Get, null, $"{appPath}/{schemaPath}", operation => { operation.OperationId = $"Query{schemaType}Contents"; + operation.Summary = $"Queries {schemaName} contents."; operation.Description = SchemaQueryDescription; @@ -103,7 +106,8 @@ namespace Squidex.Areas.Api.Controllers.Contents.Generator operation.AddQueryParameter("$skip", JsonObjectType.Number, "Optional number of contents to skip."); operation.AddQueryParameter("$filter", JsonObjectType.String, "Optional OData filter."); operation.AddQueryParameter("$search", JsonObjectType.String, "Optional OData full text search."); - operation.AddQueryParameter("orderby", JsonObjectType.String, "Optional OData order definition."); + operation.AddQueryParameter("$orderby", JsonObjectType.String, "Optional OData order definition."); + operation.AddQueryParameter("$orderby", JsonObjectType.String, "Optional OData order definition."); operation.AddResponse("200", $"{schemaName} content retrieved.", CreateContentsSchema(schemaName, contentSchema)); @@ -116,6 +120,7 @@ namespace Squidex.Areas.Api.Controllers.Contents.Generator return AddOperation(SwaggerOperationMethod.Get, schemaName, $"{appPath}/{schemaPath}/{{id}}", operation => { operation.OperationId = $"Get{schemaType}Content"; + operation.Summary = $"Get a {schemaName} content."; operation.AddResponse("200", $"{schemaName} content found.", contentSchema); @@ -129,12 +134,14 @@ namespace Squidex.Areas.Api.Controllers.Contents.Generator return AddOperation(SwaggerOperationMethod.Post, null, $"{appPath}/{schemaPath}", operation => { operation.OperationId = $"Create{schemaType}Content"; + operation.Summary = $"Create a {schemaName} content."; operation.AddBodyParameter("data", dataSchema, SchemaBodyDescription); operation.AddQueryParameter("publish", JsonObjectType.Boolean, "Set to true to autopublish content."); - operation.AddResponse("201", $"{schemaName} content created.", contentSchema); + operation.AddResponse("200", $"{schemaName} content created.", contentSchema); + operation.AddResponse("400", "Content data valid."); AddSecurity(operation, Permissions.AppContentsCreate); }); @@ -145,80 +152,64 @@ namespace Squidex.Areas.Api.Controllers.Contents.Generator return AddOperation(SwaggerOperationMethod.Put, schemaName, $"{appPath}/{schemaPath}/{{id}}", operation => { operation.OperationId = $"Update{schemaType}Content"; + operation.Summary = $"Update a {schemaName} content."; operation.AddBodyParameter("data", dataSchema, SchemaBodyDescription); - operation.AddResponse("200", $"{schemaName} content updated.", dataSchema); + operation.AddResponse("200", $"{schemaName} content updated.", contentSchema); + operation.AddResponse("400", "Content data valid."); AddSecurity(operation, Permissions.AppContentsUpdate); }); } - private SwaggerPathItem GenerateSchemaPatchOperation() + private SwaggerPathItem GenerateSchemaUpdatePatchOperation() { return AddOperation(SwaggerOperationMethod.Patch, schemaName, $"{appPath}/{schemaPath}/{{id}}", operation => { operation.OperationId = $"Path{schemaType}Content"; + operation.Summary = $"Patch a {schemaName} content."; operation.AddBodyParameter("data", dataSchema, SchemaBodyDescription); - operation.AddResponse("200", $"{schemaName} content patched.", dataSchema); + operation.AddResponse("200", $"{schemaName} content patched.", contentSchema); + operation.AddResponse("400", "Status change not valid."); AddSecurity(operation, Permissions.AppContentsUpdate); }); } - private SwaggerPathItem GenerateSchemaPublishOperation() + private SwaggerPathItem GenerateSchemaStatusOperation() { - return AddOperation(SwaggerOperationMethod.Put, schemaName, $"{appPath}/{schemaPath}/{{id}}/publish", operation => + return AddOperation(SwaggerOperationMethod.Put, schemaName, $"{appPath}/{schemaPath}/{{id}}/status", operation => { - operation.OperationId = $"Publish{schemaType}Content"; - operation.Summary = $"Publish a {schemaName} content."; + operation.OperationId = $"Change{schemaType}ContentStatus"; - operation.AddResponse("204", $"{schemaName} content published."); + operation.Summary = $"Change status of {schemaName} content."; - AddSecurity(operation, Permissions.AppContentsPublish); - }); - } + operation.AddBodyParameter("request", statusSchema, "The request to change content status."); - private SwaggerPathItem GenerateSchemaUnpublishOperation() - { - return AddOperation(SwaggerOperationMethod.Put, schemaName, $"{appPath}/{schemaPath}/{{id}}/unpublish", operation => - { - operation.OperationId = $"Unpublish{schemaType}Content"; - operation.Summary = $"Unpublish a {schemaName} content."; - - operation.AddResponse("204", $"{schemaName} content unpublished."); + operation.AddResponse("204", $"{schemaName} content status changed.", contentSchema); + operation.AddResponse("400", "Content data valid."); - AddSecurity(operation, Permissions.AppContentsUnpublish); + AddSecurity(operation, Permissions.AppContentsStatus); }); } - private SwaggerPathItem GenerateSchemaArchiveOperation() + private SwaggerPathItem GenerateSchemaDiscardOperation() { - return AddOperation(SwaggerOperationMethod.Put, schemaName, $"{appPath}/{schemaPath}/{{id}}/archive", operation => + return AddOperation(SwaggerOperationMethod.Put, schemaName, $"{appPath}/{schemaPath}/{{id}}/discard", operation => { - operation.OperationId = $"Archive{schemaType}Content"; - operation.Summary = $"Archive a {schemaName} content."; - - operation.AddResponse("204", $"{schemaName} content restored."); - - AddSecurity(operation, Permissions.AppContentsRead); - }); - } + operation.OperationId = $"Discard{schemaType}Content"; - private SwaggerPathItem GenerateSchemaRestoreOperation() - { - return AddOperation(SwaggerOperationMethod.Put, schemaName, $"{appPath}/{schemaPath}/{{id}}/restore", operation => - { - operation.OperationId = $"Restore{schemaType}Content"; - operation.Summary = $"Restore a {schemaName} content."; + operation.Summary = $"Discard changes of {schemaName} content."; - operation.AddResponse("204", $"{schemaName} content restored."); + operation.AddResponse("400", "No pending draft."); + operation.AddResponse("200", $"{schemaName} content status changed.", contentSchema); - AddSecurity(operation, Permissions.AppContentsRestore); + AddSecurity(operation, Permissions.AppContentsDiscard); }); } @@ -227,6 +218,7 @@ namespace Squidex.Areas.Api.Controllers.Contents.Generator return AddOperation(SwaggerOperationMethod.Delete, schemaName, $"{appPath}/{schemaPath}/{{id}}/", operation => { operation.OperationId = $"Delete{schemaType}Content"; + operation.Summary = $"Delete a {schemaName} content."; operation.AddResponse("204", $"{schemaName} content deleted."); diff --git a/src/Squidex/Areas/Api/Controllers/Contents/Generator/SchemasSwaggerGenerator.cs b/src/Squidex/Areas/Api/Controllers/Contents/Generator/SchemasSwaggerGenerator.cs index e2e7a8d2c..7ea592429 100644 --- a/src/Squidex/Areas/Api/Controllers/Contents/Generator/SchemasSwaggerGenerator.cs +++ b/src/Squidex/Areas/Api/Controllers/Contents/Generator/SchemasSwaggerGenerator.cs @@ -18,6 +18,7 @@ using NSwag.SwaggerGeneration; using NSwag.SwaggerGeneration.Processors; using NSwag.SwaggerGeneration.Processors.Contexts; using Squidex.Areas.Api.Config.Swagger; +using Squidex.Areas.Api.Controllers.Contents.Models; using Squidex.Domain.Apps.Entities.Apps; using Squidex.Domain.Apps.Entities.Schemas; using Squidex.Infrastructure; @@ -32,6 +33,7 @@ namespace Squidex.Areas.Api.Controllers.Contents.Generator private readonly SwaggerDocumentSettings settings = new SwaggerDocumentSettings(); private SwaggerJsonSchemaGenerator schemaGenerator; private SwaggerDocument document; + private JsonSchema4 statusSchema; private JsonSchemaResolver schemaResolver; public SchemasSwaggerGenerator(IOptions urlOptions, IEnumerable documentProcessors) @@ -53,9 +55,9 @@ namespace Squidex.Areas.Api.Controllers.Contents.Generator schemaGenerator = new SwaggerJsonSchemaGenerator(settings); schemaResolver = new SwaggerSchemaResolver(document, settings); - GenerateSchemasOperations(schemas, app); + statusSchema = await GenerateStatusSchemaAsync(); - await GenerateDefaultErrorsAsync(); + GenerateSchemasOperations(schemas, app); var context = new DocumentProcessorContext(document, @@ -73,25 +75,23 @@ namespace Squidex.Areas.Api.Controllers.Contents.Generator return document; } - private void GenerateSchemasOperations(IEnumerable schemas, IAppEntity app) + private Task GenerateStatusSchemaAsync() { - var appBasePath = $"/content/{app.Name}"; + var errorType = typeof(ChangeStatusDto); - foreach (var schema in schemas.Select(x => x.SchemaDef).Where(x => x.IsPublished)) - { - new SchemaSwaggerGenerator(document, app.Name, appBasePath, schema, AppendSchema, app.PartitionResolver()).GenerateSchemaOperations(); - } + return schemaGenerator.GenerateWithReferenceAsync(errorType, Enumerable.Empty(), schemaResolver); } - private async Task GenerateDefaultErrorsAsync() + private void GenerateSchemasOperations(IEnumerable schemas, IAppEntity app) { - const string errorDescription = "Operation failed with internal server error."; - - var errorDtoSchema = await schemaGenerator.GetErrorDtoSchemaAsync(schemaResolver); + var appBasePath = $"/content/{app.Name}"; - foreach (var operation in document.Paths.Values.SelectMany(x => x.Values)) + foreach (var schema in schemas.Select(x => x.SchemaDef).Where(x => x.IsPublished)) { - operation.Responses.Add("500", new SwaggerResponse { Description = errorDescription, Schema = errorDtoSchema }); + var partition = app.PartitionResolver(); + + new SchemaSwaggerGenerator(document, app.Name, appBasePath, schema, AppendSchema, statusSchema, partition) + .GenerateSchemaOperations(); } } 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/Apps/Models/ContributorAssignedDto.cs b/src/Squidex/Areas/Api/Controllers/Contents/Models/ChangeStatusDto.cs similarity index 52% rename from src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorAssignedDto.cs rename to src/Squidex/Areas/Api/Controllers/Contents/Models/ChangeStatusDto.cs index 871fcc6e9..7a89789c9 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorAssignedDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Contents/Models/ChangeStatusDto.cs @@ -5,26 +5,30 @@ // 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.Apps.Models +namespace Squidex.Areas.Api.Controllers.Contents.Models { - public sealed class ContributorAssignedDto + public sealed class ChangeStatusDto { /// - /// The id of the user that has been assigned as contributor. + /// The new status. /// [Required] - public string ContributorId { get; set; } + public Status Status { get; set; } /// - /// Indicates if the user was created. + /// The due time. /// - public bool IsCreated { get; set; } + public Instant? DueTime { get; set; } - public static ContributorAssignedDto FromId(string id, bool isCreated) + public ChangeContentStatus ToCommand(Guid id) { - return new ContributorAssignedDto { ContributorId = id, IsCreated = isCreated }; + 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 5e896298b..b2db0db33 100644 --- a/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentDto.cs @@ -12,15 +12,14 @@ 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 { - public sealed class ContentDto : IGenerateETag + public sealed class ContentDto : Resource, IGenerateETag { /// /// The if of the content item. @@ -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) + 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,7 +99,61 @@ namespace Squidex.Areas.Api.Controllers.Contents.Models response.ScheduleJob = SimpleMapper.Map(content.ScheduleJob, new ScheduleJobDto()); } - return response; + return response.CreateLinks(controller, app, schema); + } + + 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("draft/discard", controller.Url(x => nameof(x.DiscardDraft), values)); + } + + if (controller.HasPermission(Helper.StatusPermission(app, schema, Status.Published))) + { + AddPutLink("draft/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("draft/propose", controller.Url(x => nameof(x.PutContent), values) + "?asDraft=true"); + } + + AddPatchLink("patch", controller.Url(x => nameof(x.PatchContent), values)); + } + + if (controller.HasPermission(Permissions.AppContentsDelete, app, schema)) + { + AddDeleteLink("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 12c19cd9c..9f664880e 100644 --- a/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentsDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Contents/Models/ContentsDto.cs @@ -5,9 +5,19 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== +using System.Collections.Generic; +using System.ComponentModel.DataAnnotations; +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 { - public sealed class ContentsDto + public sealed class ContentsDto : Resource { /// /// The total number of content items. @@ -17,6 +27,61 @@ namespace Squidex.Areas.Api.Controllers.Contents.Models /// /// The content items. /// + [Required] public ContentDto[] Items { get; set; } + + /// + /// The possible statuses. + /// + [Required] + public string[] Statuses { get; set; } + + public string ToEtag() + { + return Items.ToManyEtag(Total); + } + + public string ToSurrogateKeys() + { + return Items.ToSurrogateKeys(); + } + + public static ContentsDto FromContents(long total, IEnumerable contents, QueryContext context, + ApiController controller, + string app, + string schema) + { + var result = new ContentsDto + { + Total = total, + Items = contents.Select(x => ContentDto.FromContent(x, context, controller, app, schema)).ToArray(), + }; + + result.Statuses = new string[] { "Archived", "Draft", "Published" }; + + return result.CreateLinks(controller, app, schema); + } + + 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/Areas/Api/Controllers/EventConsumers/EventConsumersController.cs b/src/Squidex/Areas/Api/Controllers/EventConsumers/EventConsumersController.cs index 1369eb9c7..47977f2c5 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 eventConsumers = await GetGrain().GetConsumersAsync(); - var response = entities.Value.OrderBy(x => x.Name).Select(EventConsumerDto.FromEventConsumerInfo).ToArray(); + var response = EventConsumersDto.FromResults(eventConsumers.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 eventConsumer = await GetGrain().StartAsync(name); - return NoContent(); + var response = EventConsumerDto.FromEventConsumerInfo(eventConsumer.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 eventConsumer = await GetGrain().StopAsync(name); + + var response = EventConsumerDto.FromEventConsumerInfo(eventConsumer.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 eventConsumer = await GetGrain().ResetAsync(name); + + var response = EventConsumerDto.FromEventConsumerInfo(eventConsumer.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..e40d6d196 100644 --- a/src/Squidex/Areas/Api/Controllers/EventConsumers/Models/EventConsumerDto.cs +++ b/src/Squidex/Areas/Api/Controllers/EventConsumers/Models/EventConsumerDto.cs @@ -7,10 +7,12 @@ using Squidex.Infrastructure.EventSourcing; using Squidex.Infrastructure.Reflection; +using Squidex.Shared; +using Squidex.Web; namespace Squidex.Areas.Api.Controllers.EventConsumers.Models { - public sealed class EventConsumerDto + public sealed class EventConsumerDto : Resource { public bool IsStopped { get; set; } @@ -22,9 +24,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) { - return SimpleMapper.Map(eventConsumerInfo, new EventConsumerDto()); + var result = SimpleMapper.Map(eventConsumerInfo, new EventConsumerDto()); + + return result.CreateLinks(controller); + } + + private EventConsumerDto CreateLinks(ApiController controller) + { + if (controller.HasPermission(Permissions.AdminEventsManage)) + { + var values = new { name = Name }; + + if (!IsResetting) + { + AddPutLink("reset", controller.Url(x => nameof(x.ResetEventConsumer), values)); + } + + if (IsStopped) + { + AddPutLink("start", controller.Url(x => nameof(x.StartEventConsumer), values)); + } + else + { + AddPutLink("stop", controller.Url(x => nameof(x.StopEventConsumer), values)); + } + } + + return this; } } } 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..65f11e289 --- /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 result.CreateLinks(controller); + } + + private EventConsumersDto CreateLinks(ApiController controller) + { + AddSelfLink(controller.Url(c => nameof(c.GetEventConsumers))); + + return this; + } + } +} diff --git a/src/Squidex/Areas/Api/Controllers/History/HistoryController.cs b/src/Squidex/Areas/Api/Controllers/History/HistoryController.cs index f4cff725a..cb2b1ecde 100644 --- a/src/Squidex/Areas/Api/Controllers/History/HistoryController.cs +++ b/src/Squidex/Areas/Api/Controllers/History/HistoryController.cs @@ -46,9 +46,9 @@ namespace Squidex.Areas.Api.Controllers.History [ApiCosts(0.1)] public async Task GetHistory(string app, string channel) { - var entities = await historyService.QueryByChannelAsync(AppId, channel, 100); + var events = await historyService.QueryByChannelAsync(AppId, channel, 100); - var response = entities.ToArray(HistoryEventDto.FromHistoryEvent); + var response = events.ToArray(HistoryEventDto.FromHistoryEvent); return Ok(response); } diff --git a/src/Squidex/Areas/Api/Controllers/News/Service/FeaturesService.cs b/src/Squidex/Areas/Api/Controllers/News/Service/FeaturesService.cs index 310edd238..9b1641946 100644 --- a/src/Squidex/Areas/Api/Controllers/News/Service/FeaturesService.cs +++ b/src/Squidex/Areas/Api/Controllers/News/Service/FeaturesService.cs @@ -43,9 +43,9 @@ namespace Squidex.Areas.Api.Controllers.News.Service if (client != null && version < FeatureVersion) { - var entities = await client.GetAsync(filter: $"data/version/iv gt {version}", context: Flatten); + var features = await client.GetAsync(filter: $"data/version/iv gt {version}", context: Flatten); - result.Features.AddRange(entities.Items.Select(x => x.Data)); + result.Features.AddRange(features.Items.Select(x => x.Data)); } return result; diff --git a/src/Squidex/Areas/Api/Controllers/Plans/AppPlansController.cs b/src/Squidex/Areas/Api/Controllers/Plans/AppPlansController.cs index 9490a4f48..a14f220a3 100644 --- a/src/Squidex/Areas/Api/Controllers/Plans/AppPlansController.cs +++ b/src/Squidex/Areas/Api/Controllers/Plans/AppPlansController.cs @@ -71,10 +71,9 @@ namespace Squidex.Areas.Api.Controllers.Plans [HttpPut] [Route("apps/{app}/plan/")] [ProducesResponseType(typeof(PlanChangedDto), 200)] - [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/Rules/Models/RuleDto.cs b/src/Squidex/Areas/Api/Controllers/Rules/Models/RuleDto.cs index 4ee256530..39ec2ff60 100644 --- a/src/Squidex/Areas/Api/Controllers/Rules/Models/RuleDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Rules/Models/RuleDto.cs @@ -14,11 +14,12 @@ using Squidex.Domain.Apps.Core.Rules; using Squidex.Domain.Apps.Entities.Rules; using Squidex.Infrastructure; using Squidex.Infrastructure.Reflection; +using Squidex.Shared; using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Rules.Models { - public sealed class RuleDto : IGenerateETag + public sealed class RuleDto : Resource, IGenerateETag { /// /// The id of the rule. @@ -70,19 +71,48 @@ namespace Squidex.Areas.Api.Controllers.Rules.Models [JsonConverter(typeof(RuleActionConverter))] public RuleAction Action { get; set; } - public static RuleDto FromRule(IRuleEntity rule) + public static RuleDto FromRule(IRuleEntity rule, ApiController controller, string app) { - var response = new RuleDto(); + var result = new RuleDto(); - SimpleMapper.Map(rule, response); - SimpleMapper.Map(rule.RuleDef, response); + SimpleMapper.Map(rule, result); + SimpleMapper.Map(rule.RuleDef, result); if (rule.RuleDef.Trigger != null) { - response.Trigger = RuleTriggerDtoFactory.Create(rule.RuleDef.Trigger); + result.Trigger = RuleTriggerDtoFactory.Create(rule.RuleDef.Trigger); } - return response; + return result.CreateLinks(controller, app); + } + + private RuleDto CreateLinks(ApiController controller, string app) + { + var values = new { app, id = Id }; + + if (controller.HasPermission(Permissions.AppRulesDisable, app)) + { + if (IsEnabled) + { + AddPutLink("disable", controller.Url(x => nameof(x.DisableRule), values)); + } + else + { + AddPutLink("enable", controller.Url(x => nameof(x.EnableRule), values)); + } + } + + if (controller.HasPermission(Permissions.AppRulesUpdate)) + { + AddPutLink("update", controller.Url(x => nameof(x.PutRule), values)); + } + + if (controller.HasPermission(Permissions.AppRulesDelete)) + { + AddDeleteLink("delete", controller.Url(x => nameof(x.DeleteRule), values)); + } + + return this; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Rules/Models/RuleEventDto.cs b/src/Squidex/Areas/Api/Controllers/Rules/Models/RuleEventDto.cs index f577f405a..a513495ab 100644 --- a/src/Squidex/Areas/Api/Controllers/Rules/Models/RuleEventDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Rules/Models/RuleEventDto.cs @@ -11,10 +11,11 @@ using NodaTime; using Squidex.Domain.Apps.Core.HandleRules; using Squidex.Domain.Apps.Entities.Rules; using Squidex.Infrastructure.Reflection; +using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Rules.Models { - public sealed class RuleEventDto + public sealed class RuleEventDto : Resource { /// /// The id of the event. @@ -63,14 +64,28 @@ namespace Squidex.Areas.Api.Controllers.Rules.Models /// public RuleJobResult JobResult { get; set; } - public static RuleEventDto FromRuleEvent(IRuleEventEntity ruleEvent) + public static RuleEventDto FromRuleEvent(IRuleEventEntity ruleEvent, ApiController controller, string app) { - var response = new RuleEventDto(); + var result = new RuleEventDto(); - SimpleMapper.Map(ruleEvent, response); - SimpleMapper.Map(ruleEvent.Job, response); + SimpleMapper.Map(ruleEvent, result); + SimpleMapper.Map(ruleEvent.Job, result); - return response; + return result.CreateLinks(controller, app); + } + + private RuleEventDto CreateLinks(ApiController controller, string app) + { + var values = new { app, id = Id }; + + AddPutLink("update", controller.Url(x => nameof(x.PutEvent), values)); + + if (NextAttempt.HasValue) + { + AddDeleteLink("delete", controller.Url(x => nameof(x.DeleteEvent), values)); + } + + return this; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Rules/Models/RuleEventsDto.cs b/src/Squidex/Areas/Api/Controllers/Rules/Models/RuleEventsDto.cs index ef320b78d..d0f382f98 100644 --- a/src/Squidex/Areas/Api/Controllers/Rules/Models/RuleEventsDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Rules/Models/RuleEventsDto.cs @@ -9,10 +9,11 @@ using System.Collections.Generic; using System.ComponentModel.DataAnnotations; using System.Linq; using Squidex.Domain.Apps.Entities.Rules; +using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Rules.Models { - public sealed class RuleEventsDto + public sealed class RuleEventsDto : Resource { /// /// The rule events. @@ -25,9 +26,22 @@ namespace Squidex.Areas.Api.Controllers.Rules.Models /// public long Total { get; set; } - public static RuleEventsDto FromRuleEvents(IReadOnlyList items, long total) + public static RuleEventsDto FromRuleEvents(IReadOnlyList items, long total, ApiController controller, string app) { - return new RuleEventsDto { Total = total, Items = items.Select(RuleEventDto.FromRuleEvent).ToArray() }; + var result = new RuleEventsDto + { + Total = total, + Items = items.Select(x => RuleEventDto.FromRuleEvent(x, controller, app)).ToArray() + }; + + return result.CreateLinks(controller, app); + } + + private RuleEventsDto CreateLinks(ApiController controller, string app) + { + AddSelfLink(controller.Url(x => nameof(x.GetEvents), new { app })); + + return this; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Rules/Models/RulesDto.cs b/src/Squidex/Areas/Api/Controllers/Rules/Models/RulesDto.cs new file mode 100644 index 000000000..c13c163fb --- /dev/null +++ b/src/Squidex/Areas/Api/Controllers/Rules/Models/RulesDto.cs @@ -0,0 +1,59 @@ +// ========================================================================== +// 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.Rules; +using Squidex.Shared; +using Squidex.Web; + +namespace Squidex.Areas.Api.Controllers.Rules.Models +{ + public sealed class RulesDto : Resource + { + /// + /// The rules. + /// + [Required] + public RuleDto[] Items { get; set; } + + public string GenerateEtag() + { + return Items.ToManyEtag(0); + } + + public static RulesDto FromRules(IEnumerable items, ApiController controller, string app) + { + var result = new RulesDto + { + Items = items.Select(x => RuleDto.FromRule(x, controller, app)).ToArray() + }; + + return result.CreateLinks(controller, app); + } + + private RulesDto CreateLinks(ApiController controller, string app) + { + var values = new { app }; + + AddSelfLink(controller.Url(x => nameof(x.GetRules), values)); + + if (controller.HasPermission(Permissions.AppRulesCreate, app)) + { + AddPostLink("create", controller.Url(x => nameof(x.PostRule), values)); + } + + if (controller.HasPermission(Permissions.AppRulesEvents, app)) + { + AddGetLink("events", controller.Url(x => nameof(x.GetEvents), values)); + } + + return this; + } + } +} diff --git a/src/Squidex/Areas/Api/Controllers/Rules/RulesController.cs b/src/Squidex/Areas/Api/Controllers/Rules/RulesController.cs index b657ef1cf..c6213c93b 100644 --- a/src/Squidex/Areas/Api/Controllers/Rules/RulesController.cs +++ b/src/Squidex/Areas/Api/Controllers/Rules/RulesController.cs @@ -15,6 +15,7 @@ using NodaTime; using Squidex.Areas.Api.Controllers.Rules.Models; using Squidex.Domain.Apps.Core.HandleRules; using Squidex.Domain.Apps.Entities; +using Squidex.Domain.Apps.Entities.Rules; using Squidex.Domain.Apps.Entities.Rules.Commands; using Squidex.Domain.Apps.Entities.Rules.Repositories; using Squidex.Infrastructure; @@ -76,16 +77,16 @@ namespace Squidex.Areas.Api.Controllers.Rules /// [HttpGet] [Route("apps/{app}/rules/")] - [ProducesResponseType(typeof(RuleDto[]), 200)] + [ProducesResponseType(typeof(RulesDto), 200)] [ApiPermission(Permissions.AppRulesRead)] [ApiCosts(1)] public async Task GetRules(string app) { - var entities = await appProvider.GetRulesAsync(AppId); + var rules = await appProvider.GetRulesAsync(AppId); - var response = entities.Select(RuleDto.FromRule).ToArray(); + var response = RulesDto.FromRules(rules, this, app); - Response.Headers[HeaderNames.ETag] = response.ToManyEtag(0); + Response.Headers[HeaderNames.ETag] = response.GenerateEtag(); return Ok(response); } @@ -102,16 +103,14 @@ namespace Squidex.Areas.Api.Controllers.Rules /// [HttpPost] [Route("apps/{app}/rules/")] - [ProducesResponseType(typeof(EntityCreatedDto), 201)] - [ProducesResponseType(typeof(ErrorDto), 400)] + [ProducesResponseType(typeof(RuleDto), 201)] [ApiPermission(Permissions.AppRulesCreate)] [ApiCosts(1)] public async Task PostRule(string app, [FromBody] CreateRuleDto 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 CreatedAtAction(nameof(GetRules), new { app }, response); } @@ -123,7 +122,7 @@ namespace Squidex.Areas.Api.Controllers.Rules /// The id of the rule to update. /// The rule object that needs to be added to the app. /// - /// 204 => Rule updated. + /// 200 => Rule updated. /// 400 => Rule is not valid. /// 404 => Rule or app not found. /// @@ -132,14 +131,16 @@ namespace Squidex.Areas.Api.Controllers.Rules /// [HttpPut] [Route("apps/{app}/rules/{id}/")] - [ProducesResponseType(typeof(ErrorDto), 400)] + [ProducesResponseType(typeof(RuleDto), 400)] [ApiPermission(Permissions.AppRulesUpdate)] [ApiCosts(1)] public async Task PutRule(string app, Guid id, [FromBody] UpdateRuleDto request) { - await CommandBus.PublishAsync(request.ToCommand(id)); + var command = request.ToCommand(id); - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -148,19 +149,22 @@ namespace Squidex.Areas.Api.Controllers.Rules /// The name of the app. /// The id of the rule to enable. /// - /// 204 => Rule enabled. + /// 200 => Rule enabled. /// 400 => Rule already enabled. /// 404 => Rule or app not found. /// [HttpPut] [Route("apps/{app}/rules/{id}/enable/")] + [ProducesResponseType(typeof(RuleDto), 200)] [ApiPermission(Permissions.AppRulesDisable)] [ApiCosts(1)] public async Task EnableRule(string app, Guid id) { - await CommandBus.PublishAsync(new EnableRule { RuleId = id }); + var command = new EnableRule { RuleId = id }; - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -169,19 +173,22 @@ namespace Squidex.Areas.Api.Controllers.Rules /// The name of the app. /// The id of the rule to disable. /// - /// 204 => Rule disabled. + /// 200 => Rule disabled. /// 400 => Rule already disabled. /// 404 => Rule or app not found. /// [HttpPut] [Route("apps/{app}/rules/{id}/disable/")] + [ProducesResponseType(typeof(RuleDto), 200)] [ApiPermission(Permissions.AppRulesDisable)] [ApiCosts(1)] public async Task DisableRule(string app, Guid id) { - await CommandBus.PublishAsync(new DisableRule { RuleId = id }); + var command = new DisableRule { RuleId = id }; - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -190,7 +197,7 @@ namespace Squidex.Areas.Api.Controllers.Rules /// The name of the app. /// The id of the rule to delete. /// - /// 204 => Rule has been deleted. + /// 204 => Rule deleted. /// 404 => Rule or app not found. /// [HttpDelete] @@ -226,7 +233,7 @@ namespace Squidex.Areas.Api.Controllers.Rules await Task.WhenAll(taskForItems, taskForCount); - var response = RuleEventsDto.FromRuleEvents(taskForItems.Result, taskForCount.Result); + var response = RuleEventsDto.FromRuleEvents(taskForItems.Result, taskForCount.Result, this, app); return Ok(response); } @@ -237,7 +244,7 @@ namespace Squidex.Areas.Api.Controllers.Rules /// The name of the app. /// The event to enqueue. /// - /// 200 => Rule enqueued. + /// 204 => Rule enqueued. /// 404 => App or rule event not found. /// [HttpPut] @@ -246,9 +253,9 @@ namespace Squidex.Areas.Api.Controllers.Rules [ApiCosts(0)] public async Task PutEvent(string app, Guid id) { - var entity = await ruleEventsRepository.FindAsync(id); + var ruleEvent = await ruleEventsRepository.FindAsync(id); - if (entity == null) + if (ruleEvent == null) { return NotFound(); } @@ -264,7 +271,7 @@ namespace Squidex.Areas.Api.Controllers.Rules /// The name of the app. /// The event to enqueue. /// - /// 200 => Rule deqeued. + /// 204 => Rule deqeued. /// 404 => App or rule event not found. /// [HttpDelete] @@ -273,9 +280,9 @@ namespace Squidex.Areas.Api.Controllers.Rules [ApiCosts(0)] public async Task DeleteEvent(string app, Guid id) { - var entity = await ruleEventsRepository.FindAsync(id); + var ruleEvent = await ruleEventsRepository.FindAsync(id); - if (entity == null) + if (ruleEvent == null) { return NotFound(); } @@ -284,5 +291,15 @@ namespace Squidex.Areas.Api.Controllers.Rules return NoContent(); } + + private async Task InvokeCommandAsync(string app, ICommand command) + { + var context = await CommandBus.PublishAsync(command); + + var result = context.Result(); + var response = RuleDto.FromRule(result, this, app); + + return response; + } } } \ No newline at end of file diff --git a/src/Squidex/Areas/Api/Controllers/Schemas/Models/FieldDto.cs b/src/Squidex/Areas/Api/Controllers/Schemas/Models/FieldDto.cs index d9eab980f..bc583bb03 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,56 @@ 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("disable", controller.Url(x => nameof(x.DisableField), values)); + } + + if (Properties is ArrayFieldPropertiesDto) + { + var parentValues = new { app, name = schema, parentId = FieldId }; + + AddPostLink("fields/add", controller.Url(x => nameof(x.PostNestedField), parentValues)); + + AddPutLink("fields/order", controller.Url(x => nameof(x.PutNestedFieldOrdering), parentValues)); + } + + 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 a6ed2b46b..716dc5ad0 100644 --- a/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDetailsDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemaDetailsDto.cs @@ -5,49 +5,21 @@ // 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.Shared; +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,54 +36,21 @@ 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(); + 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) { @@ -144,10 +83,27 @@ namespace Squidex.Areas.Api.Controllers.Schemas.Models } } - response.Fields.Add(fieldDto); + result.Fields.Add(fieldDto); } - return response; + 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 f66d64d23..35fafd420 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. @@ -38,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. @@ -77,15 +79,65 @@ 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() }; + 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 response; + result.CreateLinks(controller, app); + + return result; + } + + 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)) + { + AddGetLink("contents", controller.Url(x => nameof(x.GetContents), values)); + } + + 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("fields/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 new file mode 100644 index 000000000..596c80d07 --- /dev/null +++ b/src/Squidex/Areas/Api/Controllers/Schemas/Models/SchemasDto.cs @@ -0,0 +1,53 @@ +// ========================================================================== +// 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.Shared; +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) + { + 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/SchemaFieldsController.cs b/src/Squidex/Areas/Api/Controllers/Schemas/SchemaFieldsController.cs index 74a36f916..6c50117dc 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,14 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPost] [Route("apps/{app}/schemas/{name}/fields/")] - [ProducesResponseType(typeof(EntityCreatedDto), 201)] - [ProducesResponseType(typeof(ErrorDto), 409)] - [ProducesResponseType(typeof(ErrorDto), 400)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [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 +68,14 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPost] [Route("apps/{app}/schemas/{name}/fields/{parentId:long}/nested/")] - [ProducesResponseType(typeof(EntityCreatedDto), 201)] - [ProducesResponseType(typeof(ErrorDto), 409)] - [ProducesResponseType(typeof(ErrorDto), 400)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [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 +87,22 @@ 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 reordered. /// 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(ErrorDto), 400)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [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 +113,22 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The parent field id. /// The request that contains the field ids. /// - /// 204 => Schema fields reorderd. + /// 200 => Schema fields reordered. /// 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(ErrorDto), 400)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [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); + + var response = await InvokeCommandAsync(app, command); - return NoContent(); + return Ok(response); } /// @@ -140,20 +139,22 @@ 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(ErrorDto), 400)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [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); + + var response = await InvokeCommandAsync(app, command); - return NoContent(); + return Ok(response); } /// @@ -165,20 +166,22 @@ 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(ErrorDto), 400)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [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 +191,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 +200,16 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{id:long}/lock/")] - [ProducesResponseType(typeof(ErrorDto), 400)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [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 }; + + var response = await InvokeCommandAsync(app, command); - return NoContent(); + return Ok(response); } /// @@ -215,7 +220,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 +229,16 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{parentId:long}/nested/{id:long}/lock/")] - [ProducesResponseType(typeof(ErrorDto), 400)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [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 }; + + var response = await InvokeCommandAsync(app, command); - return NoContent(); + return Ok(response); } /// @@ -241,7 +248,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 +257,16 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{id:long}/hide/")] - [ProducesResponseType(typeof(ErrorDto), 400)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [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 +277,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 +286,16 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{parentId:long}/nested/{id:long}/hide/")] - [ProducesResponseType(typeof(ErrorDto), 400)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [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 }; + + var response = await InvokeCommandAsync(app, command); - return NoContent(); + return Ok(response); } /// @@ -294,7 +305,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 +314,16 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{id:long}/show/")] - [ProducesResponseType(typeof(ErrorDto), 400)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [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 }; + + var response = await InvokeCommandAsync(app, command); - return NoContent(); + return Ok(response); } /// @@ -321,7 +334,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. /// @@ -330,14 +343,16 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{parentId:long}/nested/{id:long}/show/")] - [ProducesResponseType(typeof(ErrorDto), 400)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ApiPermission(Permissions.AppSchemasUpdate)] [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 +362,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 +371,16 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{id:long}/enable/")] - [ProducesResponseType(typeof(ErrorDto), 400)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [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 }; + + var response = await InvokeCommandAsync(app, command); - return NoContent(); + return Ok(response); } /// @@ -374,7 +391,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 +400,16 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{parentId:long}/nested/{id:long}/enable/")] - [ProducesResponseType(typeof(ErrorDto), 400)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [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 +419,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 +428,16 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{id:long}/disable/")] - [ProducesResponseType(typeof(ErrorDto), 400)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [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 }; + + var response = await InvokeCommandAsync(app, command); - return NoContent(); + return Ok(response); } /// @@ -427,7 +448,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 +457,16 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPut] [Route("apps/{app}/schemas/{name}/fields/{parentId:long}/nested/{id:long}/disable/")] - [ProducesResponseType(typeof(ErrorDto), 400)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [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 }; + + var response = await InvokeCommandAsync(app, command); - return NoContent(); + return Ok(response); } /// @@ -453,19 +476,22 @@ 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)] [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,19 +502,32 @@ 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)] [ApiPermission(Permissions.AppSchemasUpdate)] [ApiCosts(1)] public async Task DeleteNestedField(string app, string name, long parentId, long id) { - await CommandBus.PublishAsync(new DeleteField { ParentFieldId = parentId, FieldId = id }); + var command = new DeleteField { ParentFieldId = parentId, FieldId = id }; + + 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 = SchemaDetailsDto.FromSchemaWithDetails(result, this, app); - return NoContent(); + 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 1fb64ec83..67e807a45 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; @@ -44,16 +43,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(SchemaDto.FromSchema); + var response = SchemasDto.FromSchemas(schemas, this, app); - Response.Headers[HeaderNames.ETag] = response.ToManyEtag(); + Response.Headers[HeaderNames.ETag] = response.ToEtag(); return Ok(response); } @@ -74,25 +73,25 @@ namespace Squidex.Areas.Api.Controllers.Schemas [ApiCosts(0)] public async Task GetSchema(string app, string name) { - ISchemaEntity entity; + ISchemaEntity schema; if (Guid.TryParse(name, out var id)) { - entity = await appProvider.GetSchemaAsync(AppId, id); + schema = await appProvider.GetSchemaAsync(AppId, id); } else { - entity = await appProvider.GetSchemaAsync(AppId, name); + schema = await appProvider.GetSchemaAsync(AppId, name); } - if (entity == null || entity.IsDeleted) + if (schema == null || schema.IsDeleted) { return NotFound(); } - var response = SchemaDetailsDto.FromSchema(entity); + var response = SchemaDetailsDto.FromSchemaWithDetails(schema, this, app); - Response.Headers[HeaderNames.ETag] = entity.Version.ToString(); + Response.Headers[HeaderNames.ETag] = schema.Version.ToString(); return Ok(response); } @@ -109,18 +108,14 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// [HttpPost] [Route("apps/{app}/schemas/")] - [ProducesResponseType(typeof(EntityCreatedDto), 201)] - [ProducesResponseType(typeof(ErrorDto), 400)] - [ProducesResponseType(typeof(ErrorDto), 409)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [ApiPermission(Permissions.AppSchemasCreate)] [ApiCosts(1)] 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); } @@ -132,19 +127,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. /// 400 => Schema properties are not valid. /// 404 => Schema or app not found. /// [HttpPut] [Route("apps/{app}/schemas/{name}/")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [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 +152,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. /// 400 => Schema properties are not valid. /// 404 => Schema or app not found. /// [HttpPut] [Route("apps/{app}/schemas/{name}/sync")] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [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 +177,21 @@ 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)] [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,40 +201,46 @@ 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)] [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); } /// - /// Update the scripts of a schema. + /// Update the scripts. /// /// The name of the app. /// 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)] [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) { - await CommandBus.PublishAsync(request.ToCommand()); + var command = request.ToCommand(); - return NoContent(); + var response = await InvokeCommandAsync(app, command); + + return Ok(response); } /// @@ -239,20 +249,22 @@ 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(ErrorDto), 400)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [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 +273,22 @@ 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(ErrorDto), 400)] + [ProducesResponseType(typeof(SchemaDetailsDto), 200)] [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); } /// @@ -283,7 +297,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas /// The name of the app. /// The name of the schema to delete. /// - /// 204 => Schema has been deleted. + /// 204 => Schema deleted. /// 404 => Schema or app not found. /// [HttpDelete] @@ -296,5 +310,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/Areas/Api/Controllers/Statistics/UsagesController.cs b/src/Squidex/Areas/Api/Controllers/Statistics/UsagesController.cs index d7a7f4eaa..5a6271099 100644 --- a/src/Squidex/Areas/Api/Controllers/Statistics/UsagesController.cs +++ b/src/Squidex/Areas/Api/Controllers/Statistics/UsagesController.cs @@ -127,9 +127,9 @@ namespace Squidex.Areas.Api.Controllers.Statistics return BadRequest(); } - var entities = await usageTracker.QueryAsync(AppId.ToString(), fromDate.Date, toDate.Date); + var usages = await usageTracker.QueryAsync(AppId.ToString(), fromDate.Date, toDate.Date); - var response = entities.ToDictionary(x => x.Key, x => x.Value.Select(CallsUsageDto.FromUsage).ToArray()); + var response = usages.ToDictionary(x => x.Key, x => x.Value.Select(CallsUsageDto.FromUsage).ToArray()); return Ok(response); } @@ -181,9 +181,9 @@ namespace Squidex.Areas.Api.Controllers.Statistics return BadRequest(); } - var entities = await assetStatsRepository.QueryAsync(AppId, fromDate.Date, toDate.Date); + var usages = await assetStatsRepository.QueryAsync(AppId, fromDate.Date, toDate.Date); - var models = entities.Select(StorageUsageDto.FromStats).ToArray(); + var models = usages.Select(StorageUsageDto.FromStats).ToArray(); return Ok(models); } diff --git a/src/Squidex/Areas/Api/Controllers/UI/UIController.cs b/src/Squidex/Areas/Api/Controllers/UI/UIController.cs index e66c8feb8..e07d9f23e 100644 --- a/src/Squidex/Areas/Api/Controllers/UI/UIController.cs +++ b/src/Squidex/Areas/Api/Controllers/UI/UIController.cs @@ -27,9 +27,7 @@ namespace Squidex.Areas.Api.Controllers.UI private readonly MyUIOptions uiOptions; private readonly IGrainFactory grainFactory; - public UIController(ICommandBus commandBus, - IOptions uiOptions, - IGrainFactory grainFactory) + public UIController(ICommandBus commandBus, IOptions uiOptions, IGrainFactory grainFactory) : base(commandBus) { this.uiOptions = uiOptions.Value; 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/ResourcesDto.cs b/src/Squidex/Areas/Api/Controllers/Users/Models/ResourcesDto.cs new file mode 100644 index 000000000..0b5fa32b2 --- /dev/null +++ b/src/Squidex/Areas/Api/Controllers/Users/Models/ResourcesDto.cs @@ -0,0 +1,45 @@ +// ========================================================================== +// 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.Areas.Api.Controllers.Languages; +using Squidex.Areas.Api.Controllers.Ping; +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(); + + result.AddGetLink("ping", controller.Url(x => nameof(x.GetPing))); + + if (controller.HasPermission(Permissions.AdminEventsRead)) + { + result.AddGetLink("admin/events", controller.Url(x => nameof(x.GetEventConsumers))); + } + + if (controller.HasPermission(Permissions.AdminRestore)) + { + 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))); + } + + result.AddGetLink("languages", controller.Url(x => nameof(x.GetLanguages))); + + return result; + } + } +} 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/UserDto.cs b/src/Squidex/Areas/Api/Controllers/Users/Models/UserDto.cs index 8a2a5a2d4..81260dd3f 100644 --- a/src/Squidex/Areas/Api/Controllers/Users/Models/UserDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Users/Models/UserDto.cs @@ -9,10 +9,12 @@ using System.Collections.Generic; using System.ComponentModel.DataAnnotations; using Squidex.Infrastructure.Reflection; using Squidex.Shared.Users; +using Squidex.Web; +using AllPermissions = Squidex.Shared.Permissions; namespace Squidex.Areas.Api.Controllers.Users.Models { - public sealed class UserDto + public sealed class UserDto : Resource { /// /// The id of the user. @@ -44,11 +46,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 permissions = user.Permissions().ToIds(); + var userPermssions = user.Permissions().ToIds(); + var userName = user.DisplayName(); - return SimpleMapper.Map(user, new UserDto { DisplayName = user.DisplayName(), Permissions = permissions }); + var result = SimpleMapper.Map(user, new UserDto { DisplayName = userName, Permissions = userPermssions }); + + return result.CreateLinks(controller); + } + + private UserDto CreateLinks(ApiController controller) + { + var values = new { id = Id }; + + if (controller is UserManagementController) + { + AddSelfLink(controller.Url(c => nameof(c.GetUser), values)); + } + else + { + AddSelfLink(controller.Url(c => nameof(c.GetUser), values)); + } + + if (!controller.IsUser(Id)) + { + if (controller.HasPermission(AllPermissions.AdminUsersLock) && !IsLocked) + { + AddPutLink("lock", controller.Url(c => nameof(c.LockUser), values)); + } + + if (controller.HasPermission(AllPermissions.AdminUsersUnlock) && IsLocked) + { + AddPutLink("unlock", controller.Url(c => nameof(c.UnlockUser), values)); + } + } + + if (controller.HasPermission(AllPermissions.AdminUsersUpdate)) + { + AddPutLink("update", controller.Url(c => nameof(c.PutUser), values)); + } + + AddGetLink("picture", controller.Url(c => nameof(c.GetUserPicture), values)); + + return this; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Users/Models/UsersDto.cs b/src/Squidex/Areas/Api/Controllers/Users/Models/UsersDto.cs index 2d83ff47d..c8a2937b1 100644 --- a/src/Squidex/Areas/Api/Controllers/Users/Models/UsersDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Users/Models/UsersDto.cs @@ -5,9 +5,16 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== +using System.Collections.Generic; +using System.ComponentModel.DataAnnotations; +using System.Linq; +using Squidex.Domain.Users; +using Squidex.Shared; +using Squidex.Web; + namespace Squidex.Areas.Api.Controllers.Users.Models { - public sealed class UsersDto + public sealed class UsersDto : Resource { /// /// The total number of users. @@ -17,6 +24,30 @@ namespace Squidex.Areas.Api.Controllers.Users.Models /// /// The users. /// + [Required] 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 result.CreateLinks(controller); + } + + private UsersDto CreateLinks(ApiController controller) + { + AddSelfLink(controller.Url(c => nameof(c.GetUsers))); + + if (controller.HasPermission(Permissions.AdminUsersCreate)) + { + AddPostLink("create", controller.Url(c => nameof(c.PostUser))); + } + + return this; + } } } diff --git a/src/Squidex/Areas/Api/Controllers/Users/UserManagementController.cs b/src/Squidex/Areas/Api/Controllers/Users/UserManagementController.cs index 7d547be14..4225171db 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; @@ -35,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) { @@ -43,89 +41,89 @@ 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); } [HttpGet] [Route("user-management/{id}/")] + [ProducesResponseType(typeof(UserDto), 201)] [ApiPermission(Permissions.AdminUsersRead)] public async Task GetUser(string id) { - var entity = await userManager.FindByIdWithClaimsAsync(id); + var user = await userManager.FindByIdWithClaimsAsync(id); - if (entity == null) + if (user == null) { return NotFound(); } - var response = UserDto.FromUser(entity); + var response = UserDto.FromUser(user, this); return Ok(response); } [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 response = new UserCreatedDto { Id = user.Id }; + var response = UserDto.FromUser(user, 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 user = await userManager.UpdateAsync(id, request.ToValues()); + + var response = UserDto.FromUser(user, 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) { - if (IsSelf(id)) + if (this.IsUser(id)) { throw new ValidationException("Locking user failed.", new ValidationError("You cannot lock yourself.")); } - await userManager.LockAsync(id); + var user = await userManager.LockAsync(id); - return NoContent(); + var response = UserDto.FromUser(user, this); + + return Ok(response); } [HttpPut] [Route("user-management/{id}/unlock/")] + [ProducesResponseType(typeof(UserDto), 201)] [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.")); } - await userManager.UnlockAsync(id); + var user = await userManager.UnlockAsync(id); - return NoContent(); - } - - private bool IsSelf(string id) - { - var subject = User.OpenIdSubject(); + var response = UserDto.FromUser(user, this); - return string.Equals(subject, id, StringComparison.OrdinalIgnoreCase); + return Ok(response); } } } diff --git a/src/Squidex/Areas/Api/Controllers/Users/UsersController.cs b/src/Squidex/Areas/Api/Controllers/Users/UsersController.cs index 36c556adb..597dc64de 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("/")] + [ProducesResponseType(typeof(ResourcesDto), 200)] + [ApiPermission] + public IActionResult GetUserResources() + { + var response = ResourcesDto.FromController(this); + + return Ok(response); + } + /// /// Get users by query. /// @@ -68,17 +85,17 @@ namespace Squidex.Areas.Api.Controllers.Users /// [HttpGet] [Route("users/")] - [ProducesResponseType(typeof(PublicUserDto[]), 200)] + [ProducesResponseType(typeof(UserDto[]), 200)] [ApiPermission] public async Task GetUsers(string query) { try { - var entities = await userResolver.QueryByEmailAsync(query); + var users = await userResolver.QueryByEmailAsync(query); - var models = entities.Where(x => !x.IsHidden()).Select(UserDto.FromUser).ToArray(); + var response = users.Where(x => !x.IsHidden()).Select(x => UserDto.FromUser(x, this)).ToArray(); - return Ok(models); + return Ok(response); } catch (Exception ex) { @@ -100,7 +117,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) { @@ -110,7 +127,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/Pipeline/Swagger/NSwagHelper.cs b/src/Squidex/Pipeline/Swagger/NSwagHelper.cs index 385a2b48f..edeb39d1f 100644 --- a/src/Squidex/Pipeline/Swagger/NSwagHelper.cs +++ b/src/Squidex/Pipeline/Swagger/NSwagHelper.cs @@ -8,11 +8,8 @@ using System; using System.Collections.Generic; using System.IO; -using System.Linq; -using System.Threading.Tasks; using Microsoft.AspNetCore.Http; using NJsonSchema; -using NJsonSchema.Generation; using NSwag; using Squidex.Web; @@ -69,13 +66,6 @@ namespace Squidex.Pipeline.Swagger return document; } - public static async Task GetErrorDtoSchemaAsync(this JsonSchemaGenerator schemaGenerator, JsonSchemaResolver resolver) - { - var errorType = typeof(ErrorDto); - - return await schemaGenerator.GenerateWithReferenceAsync(errorType, Enumerable.Empty(), resolver); - } - public static void AddQueryParameter(this SwaggerOperation operation, string name, JsonObjectType type, string description = null) { var parameter = new SwaggerParameter { Type = type, Name = name, Kind = SwaggerParameterKind.Query }; 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/administration-area.component.html b/src/Squidex/app/features/administration/administration-area.component.html index c3b623cdb..658062f67 100644 --- a/src/Squidex/app/features/administration/administration-area.component.html +++ b/src/Squidex/app/features/administration/administration-area.component.html @@ -2,17 +2,17 @@
    -
  • +
  • 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/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/event-consumers/event-consumers-page.component.html b/src/Squidex/app/features/administration/pages/event-consumers/event-consumers-page.component.html index 6664745ac..fda0b38f3 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/pages/users/user-page.component.html b/src/Squidex/app/features/administration/pages/users/user-page.component.html index b9d1bdb51..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 @@ -15,12 +15,14 @@ - - - - + + + + + + @@ -50,7 +52,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..c848d5d5d 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,9 +24,9 @@ import { templateUrl: './user-page.component.html' }) export class UserPageComponent extends ResourceOwner implements OnInit { - public canUpdate = false; + public isEditable = false; - public user?: { user: UserDto, isCurrentUser: boolean }; + public user?: UserDto; public userForm = new UserForm(this.formBuilder); constructor( @@ -45,17 +45,24 @@ export class UserPageComponent extends ResourceOwner implements OnInit { this.user = selectedUser!; if (selectedUser) { - this.userForm.load(selectedUser.user); + this.isEditable = this.user.canUpdate; + + this.userForm.load(selectedUser); + this.userForm.setEnabled(this.isEditable); } })); } public save() { + if (!this.isEditable) { + return; + } + const value = this.userForm.submit(); 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..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 @@ -12,15 +12,18 @@ -
- + + + + + @@ -48,32 +51,24 @@
- - + + 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/event-consumers.service.spec.ts b/src/Squidex/app/features/administration/services/event-consumers.service.spec.ts index 5eacb6d62..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,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, ResourceLinks } 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,118 @@ 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 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}`); +} \ 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..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,19 +12,41 @@ import { map } from 'rxjs/operators'; import { ApiUrlConfig, - Model, - pretifyError + hasAnyLink, + pretifyError, + Resource, + ResourceLinks } from '@app/shared'; -export class EventConsumerDto extends Model { +export class EventConsumersDto { + public readonly _links: ResourceLinks; + constructor( + public readonly items: EventConsumerDto[], links?: ResourceLinks + ) { + this._links = links || {}; + } +} + +export class EventConsumerDto { + public readonly _links: ResourceLinks; + + 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 ) { - super(); + this._links = links; + + this.canStop = hasAnyLink(links, 'stop'); + this.canStart = hasAnyLink(links, 'start'); + this.canRestart = hasAnyLink(links, 'canReset'); } } @@ -36,42 +58,61 @@ export class EventConsumersService { ) { } - public getEventConsumers(): Observable { + public getEventConsumers(): Observable { const url = this.apiUrl.buildUrl('/api/event-consumers'); - return this.http.get(url).pipe( - map(body => { - const eventConsumers = body.map(item => - new EventConsumerDto( - item.name, - item.isStopped, - item.isResetting, - item.error, - item.position)); - - return eventConsumers; + return this.http.get<{ items: any[] } & Resource>(url).pipe( + map(({ items, _links }) => { + const eventConsumers = items.map(item => parseEventConsumer(item)); + + return new EventConsumersDto(eventConsumers, _links); }), 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']; + + 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 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 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 ee74d079f..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 } from '@app/framework'; +import { ApiUrlConfig, Resource, ResourceLinks } 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,107 @@ 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 links: ResourceLinks = { + update: { method: 'PUT', href: `/users/${id}` } + }; + + return new UserDto(links, + `${id}`, + `user${id}${suffix}@domain.com`, + `user${id}${suffix}`, + [ + `Permission${id}${suffix}` + ], + true); +} \ 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 a657eee38..4992334f1 100644 --- a/src/Squidex/app/features/administration/services/users.service.ts +++ b/src/Squidex/app/features/administration/services/users.service.ts @@ -12,26 +12,38 @@ import { map } from 'rxjs/operators'; import { ApiUrlConfig, - Model, + hasAnyLink, pretifyError, + Resource, + ResourceLinks, ResultSet } from '@app/shared'; -export class UsersDto extends ResultSet {} +export class UsersDto extends ResultSet { + public get canCreate() { + return hasAnyLink(this._links, 'create'); + } +} -export class UserDto extends Model { - constructor( +export class UserDto { + public readonly _links: ResourceLinks; + + 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 ) { - super(); - } + this._links = links; - public with(value: Partial): UserDto { - return this.clone(value); + this.canLock = hasAnyLink(links, 'lock'); + this.canUnlock = hasAnyLink(links, 'unlock'); + this.canUpdate = hasAnyLink(links, 'update'); } } @@ -60,17 +72,11 @@ 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( - 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); + return this.http.get<{ total: number, items: any[] } & Resource>(url).pipe( + map(({ total, items, _links }) => { + const users = items.map(item => parseUser(item)); + + return new UsersDto(total, users, _links); }), pretifyError('Failed to load users. Please reload.')); } @@ -78,16 +84,9 @@ export class UsersService { public getUser(id: string): Observable { const url = this.apiUrl.buildUrl(`api/user-management/${id}`); - return this.http.get(url).pipe( + 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.')); } @@ -95,38 +94,56 @@ export class UsersService { public postUser(dto: CreateUserDto): Observable { const url = this.apiUrl.buildUrl('api/user-management'); - return this.http.post(url, dto).pipe( + 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 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/event-consumers.state.spec.ts b/src/Squidex/app/features/administration/state/event-consumers.state.spec.ts index 4a69ffbeb..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 @@ -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 event 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..671adbbdc 100644 --- a/src/Squidex/app/features/administration/state/event-consumers.state.ts +++ b/src/Squidex/app/features/administration/state/event-consumers.state.ts @@ -7,7 +7,7 @@ import { Injectable } from '@angular/core'; import { Observable } from 'rxjs'; -import { distinctUntilChanged, map, tap } from 'rxjs/operators'; +import { tap } from 'rxjs/operators'; import { DialogService, @@ -31,12 +31,10 @@ type EventConsumersList = ImmutableArray; @Injectable() export class EventConsumersState extends State { public eventConsumers = - this.changes.pipe(map(x => x.eventConsumers), - distinctUntilChanged()); + this.project(x => x.eventConsumers); public isLoaded = - this.changes.pipe(map(x => !!x.isLoaded), - distinctUntilChanged()); + this.project(x => !!x.isLoaded); constructor( private readonly dialogs: DialogService, @@ -51,12 +49,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 +64,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 +72,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 +80,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 +94,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 c2a912ecd..90fd5321d 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,31 +16,27 @@ import { UsersService } from '@app/features/administration/internal'; -import { SnapshotUser, UsersState } from './users.state'; +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 oldUsers = new UsersDto(200, [user1, user2]); - const newUser = new UserDto('id3', 'mail3@mail.de', 'name3', ['Permission3'], false); + const newUser = createUser(3); - 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(() => { @@ -50,14 +46,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(oldUsers)).verifiable(); 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([user1, user2]); expect(usersState.snapshot.usersPager.numberOfItems).toEqual(200); expect(usersState.snapshot.isLoaded).toBeTruthy(); @@ -66,7 +59,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(oldUsers)).verifiable(); usersState.load(true).subscribe(); @@ -77,26 +70,26 @@ 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(oldUsers)).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({ isCurrentUser: false, user: newUsers[0] }); + expect(usersState.snapshot.selectedUser).toEqual(newUsers[0]); }); 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(oldUsers)).verifiable(Times.exactly(2)); usersService.setup(x => x.getUsers(10, 10, undefined)) .returns(() => of(new UsersDto(200, []))).verifiable(); @@ -121,38 +114,38 @@ describe('UsersState', () => { describe('Updates', () => { beforeEach(() => { usersService.setup(x => x.getUsers(10, 0, undefined)) - .returns(() => of(new UsersDto(200, oldUsers))).verifiable(); + .returns(() => of(oldUsers)).verifiable(); usersState.load().subscribe(); }); it('should return user on select and not load when already loaded', () => { - let selectedUser: SnapshotUser; + let selectedUser: UserDto; - usersState.select('id1').subscribe(x => { + usersState.select(user1.id).subscribe(x => { selectedUser = x!; }); - expect(selectedUser!.user).toEqual(oldUsers[0]); - expect(usersState.snapshot.selectedUser).toEqual({ isCurrentUser: false, user: oldUsers[0] }); + expect(selectedUser!).toEqual(user1); + expect(usersState.snapshot.selectedUser).toEqual(user1); }); 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 +159,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!; @@ -176,47 +169,50 @@ describe('UsersState', () => { expect(usersState.snapshot.selectedUser).toBeNull(); }); - it('should mark as locked when locked', () => { - usersService.setup(x => x.lockUser('id1')) - .returns(() => of({})).verifiable(); + it('should update user and selected user when locked', () => { + const updated = createUser(2, '_new'); - usersState.select('id1').subscribe(); - usersState.lock(oldUsers[0]).subscribe(); + usersService.setup(x => x.lockUser(user2)) + .returns(() => of(updated)).verifiable(); - const user_1 = usersState.snapshot.users.at(0); + usersState.select(user2.id).subscribe(); + usersState.lock(user2).subscribe(); - expect(user_1.user.isLocked).toBeTruthy(); - expect(user_1).toBe(usersState.snapshot.selectedUser!); + const user2New = usersState.snapshot.users.at(1); + + expect(user2New).toBe(usersState.snapshot.selectedUser!); }); - it('should unmark as locked when unlocked', () => { - usersService.setup(x => x.unlockUser('id2')) - .returns(() => of({})).verifiable(); + it('should update user and selected user when unlocked', () => { + const updated = createUser(2, '_new'); + + usersService.setup(x => x.unlockUser(user2)) + .returns(() => of(updated)).verifiable(); - usersState.select('id2').subscribe(); - usersState.unlock(oldUsers[1]).subscribe(); + usersState.select(user2.id).subscribe(); + usersState.unlock(user2).subscribe(); - const user_1 = usersState.snapshot.users.at(1); + const user2New = usersState.snapshot.users.at(1); - expect(user_1.user.isLocked).toBeFalsy(); - expect(user_1).toBe(usersState.snapshot.selectedUser!); + expect(user2New).toEqual(updated); + expect(user2New).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'] }; - 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 user2New = usersState.snapshot.users.at(1); - 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).toBe(usersState.snapshot.selectedUser!); + expect(user2New).toEqual(updated); + expect(user2New).toBe(usersState.snapshot.selectedUser!); }); it('should add user to snapshot when created', () => { @@ -227,11 +223,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, 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 7de907b24..773f441a7 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, 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,39 +40,40 @@ interface Snapshot { isLoaded?: boolean; // The selected user. - selectedUser?: SnapshotUser | null; + selectedUser?: UserDto | null; + + // Indicates if the user can create a user. + canCreate?: boolean; } -export type UsersList = ImmutableArray; +export type UsersList = ImmutableArray; export type UsersResult = { total: number, users: UsersList }; @Injectable() export class UsersState extends State { public users = - this.changes.pipe(map(x => x.users), - distinctUntilChanged()); + this.project(x => x.users); public usersPager = - this.changes.pipe(map(x => x.usersPager), - distinctUntilChanged()); + this.project(x => x.usersPager); public selectedUser = - this.changes.pipe(map(x => x.selectedUser), - distinctUntilChanged()); + this.project(x => x.selectedUser); public isLoaded = - this.changes.pipe(map(x => !!x.isLoaded), - distinctUntilChanged()); + this.project(x => !!x.isLoaded); + + public canCreate = + this.project(x => !!x.canCreate); 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 +86,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 { @@ -118,22 +110,28 @@ export class UsersState extends State { this.snapshot.usersPager.pageSize, this.snapshot.usersPager.skip, this.snapshot.usersQuery).pipe( - tap(({ total, items }) => { + tap(({ total, items, canCreate }) => { if (isReload) { this.dialogs.notifyInfo('Users reloaded.'); } 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 }; + return { ...s, + canCreate, + isLoaded: true, + selectedUser, + users, + usersPager + }; }); }), shareSubscribed(this.dialogs)); @@ -143,7 +141,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 }; @@ -153,8 +151,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)), + return this.usersService.putUser(user, request).pipe( tap(updated => { this.replaceUser(updated); }), @@ -162,8 +159,7 @@ export class UsersState extends State { } public lock(user: UserDto): Observable { - return this.usersService.lockUser(user.id).pipe( - map(() => setLocked(user, true)), + return this.usersService.lockUser(user).pipe( tap(updated => { this.replaceUser(updated); }), @@ -171,8 +167,7 @@ export class UsersState extends State { } public unlock(user: UserDto): Observable { - return this.usersService.unlockUser(user.id).pipe( - map(() => setLocked(user, false)), + return this.usersService.unlockUser(user).pipe( tap(updated => { this.replaceUser(updated); }), @@ -199,30 +194,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/features/assets/pages/assets-filters-page.component.html b/src/Squidex/app/features/assets/pages/assets-filters-page.component.html index f6c48e822..7d8cb432f 100644 --- a/src/Squidex/app/features/assets/pages/assets-filters-page.component.html +++ b/src/Squidex/app/features/assets/pages/assets-filters-page.component.html @@ -28,16 +28,28 @@
-

Saved queries

+
+

Saved queries

- - - {{query.name}} + + + + + {{query.name}} + + + + + + - - - - + +
+ Search for assets and use icon in search form to save query for all contributors. +
+ + +
\ No newline at end of file diff --git a/src/Squidex/app/features/assets/pages/assets-filters-page.component.scss b/src/Squidex/app/features/assets/pages/assets-filters-page.component.scss index fbb752506..bc0b6a3e7 100644 --- a/src/Squidex/app/features/assets/pages/assets-filters-page.component.scss +++ b/src/Squidex/app/features/assets/pages/assets-filters-page.component.scss @@ -1,2 +1,6 @@ @import '_vars'; -@import '_mixins'; \ No newline at end of file +@import '_mixins'; + +.text-muted { + text-decoration: none; +} \ No newline at end of file diff --git a/src/Squidex/app/features/assets/pages/assets-page.component.html b/src/Squidex/app/features/assets/pages/assets-page.component.html index d169e27fe..a16cf64f0 100644 --- a/src/Squidex/app/features/assets/pages/assets-page.component.html +++ b/src/Squidex/app/features/assets/pages/assets-page.component.html @@ -25,7 +25,7 @@
- - + 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}}
@@ -87,12 +74,11 @@
- - - + + 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..fd4afb1a6 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 @@ -64,7 +64,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, @@ -124,7 +124,7 @@ export class ContentPageComponent extends ResourceOwner implements CanComponentD this.saveContent(true, false); } - public saveAsProposal() { + public saveAsDraft() { this.saveContent(false, true); } @@ -132,23 +132,27 @@ export class ContentPageComponent extends ResourceOwner implements CanComponentD this.saveContent(false, false); } - private saveContent(publish: boolean, asProposal: boolean) { - if (this.content && this.content.status === 'Archived') { - return; - } - + private saveContent(publish: boolean, asDraft: boolean) { const value = this.contentForm.submit(); if (value) { if (this.content) { - if (asProposal) { - this.contentsState.proposeUpdate(this.content, value) + if (asDraft) { + if (this.content && !this.content.canDraftPropose) { + return; + } + + this.contentsState.proposeDraft(this.content, value) .subscribe(() => { this.contentForm.submitCompleted({ noReset: true }); }, error => { this.contentForm.submitFailed(error); }); } else { + if (this.content && !this.content.canUpdate) { + return; + } + this.contentsState.update(this.content, value) .subscribe(() => { this.contentForm.submitCompleted({ noReset: true }); @@ -157,6 +161,10 @@ export class ContentPageComponent extends ResourceOwner implements CanComponentD }); } } else { + if ((publish && !this.contentsState.snapshot.canCreate) || (!publish && !this.contentsState.snapshot.canCreateAndPublish)) { + return; + } + this.contentsState.create(value, publish) .subscribe(() => { this.back(); @@ -174,27 +182,12 @@ 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.contentForm.setEnabled(!this.content || this.content.canUpdate); } 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'); + this.contentsState.discardDraft(this.content); } public delete() { @@ -206,13 +199,13 @@ export class ContentPageComponent extends ResourceOwner implements CanComponentD public publishChanges() { this.dueTimeSelector.selectDueTime('Publish').pipe( - switchMap(d => this.contentsState.publishChanges(this.content, d)), onErrorResumeNext()) + switchMap(d => this.contentsState.publishDraft(this.content, d)), onErrorResumeNext()) .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(); } @@ -227,13 +220,12 @@ export class ContentPageComponent extends ResourceOwner implements CanComponentD if (compare) { if (this.contentFormCompare === null) { this.contentFormCompare = new EditContentForm(this.schema, this.languages); - this.contentFormCompare.form.disable(); } - const isArchive = this.content && this.content.status === 'Archived'; + this.contentFormCompare.loadContent(dto.payload); + this.contentFormCompare.setEnabled(false); - this.contentFormCompare.loadContent(dto.payload, true); - this.contentForm.loadContent(this.content.dataDraft, isArchive); + this.loadContent(this.content.dataDraft); } else { if (this.contentFormCompare) { this.contentFormCompare = null; diff --git a/src/Squidex/app/features/content/pages/contents/contents-filters-page.component.html b/src/Squidex/app/features/content/pages/contents/contents-filters-page.component.html index 224f33408..ea615ec67 100644 --- a/src/Squidex/app/features/content/pages/contents/contents-filters-page.component.html +++ b/src/Squidex/app/features/content/pages/contents/contents-filters-page.component.html @@ -12,17 +12,39 @@
-

Saved queries

+

Status Queries

- {{query.name}} - - - -
+ +
+ +
+

Saved queries

+ + + + + + {{query.name}} + + + + + + + + +
+ Search for contents and use icon in search form to save query for all contributors. +
+ + +
\ No newline at end of file diff --git a/src/Squidex/app/features/content/pages/contents/contents-filters-page.component.scss b/src/Squidex/app/features/content/pages/contents/contents-filters-page.component.scss index fbb752506..00bb31427 100644 --- a/src/Squidex/app/features/content/pages/contents/contents-filters-page.component.scss +++ b/src/Squidex/app/features/content/pages/contents/contents-filters-page.component.scss @@ -1,2 +1,6 @@ @import '_vars'; -@import '_mixins'; \ No newline at end of file +@import '_mixins'; + +.text-muted { + pointer-events: none; +} \ No newline at end of file diff --git a/src/Squidex/app/features/content/pages/contents/contents-filters-page.component.ts b/src/Squidex/app/features/content/pages/contents/contents-filters-page.component.ts index 4779955c7..5a0ff774a 100644 --- a/src/Squidex/app/features/content/pages/contents/contents-filters-page.component.ts +++ b/src/Squidex/app/features/content/pages/contents/contents-filters-page.component.ts @@ -24,7 +24,7 @@ export class ContentsFiltersPageComponent extends ResourceOwner implements OnIni public schemaQueries: Queries; constructor( - private readonly contentsState: ContentsState, + public readonly contentsState: ContentsState, private readonly schemasState: SchemasState, private readonly uiState: UIState ) { 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..eae57a6f3 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 @@ -2,18 +2,12 @@ - - Archive - - - - Contents - + Contents
-
+
- @@ -80,25 +71,13 @@
- {{selectionCount}} items selected:   + {{selectionCount}} items selected   - - - - - - - -
@@ -37,12 +38,12 @@
-
- +
diff --git a/src/Squidex/app/features/schemas/pages/schema/field-wizard.component.html b/src/Squidex/app/features/schemas/pages/schema/field-wizard.component.html index 1b4866640..cf9681be6 100644 --- a/src/Squidex/app/features/schemas/pages/schema/field-wizard.component.html +++ b/src/Squidex/app/features/schemas/pages/schema/field-wizard.component.html @@ -65,6 +65,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 @@
-
+
@@ -87,7 +91,10 @@ -
+
@@ -95,7 +102,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,14 @@ export class FieldFormComponent { public selectedTab = 0; + public ngAfterViewInit() { + if (!this.isEditable) { + this.editForm.disable(); + } else { + this.editForm.enable(); + } + } + 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..b25b815ae 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 @@ -28,6 +28,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 +37,10 @@ export class SchemaEditFormComponent implements OnInit { } public ngOnInit() { + this.isEditable = this.schema.canUpdate; + this.editForm.load(this.schema.properties); + this.editForm.setEnabled(this.isEditable); } public emitComplete() { @@ -43,6 +48,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..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,20 +31,25 @@ Edit Preview Urls -
- - - Clone - + +
+ + + Clone + + -
- - - Delete - + +
+ + + Delete + +
@@ -61,13 +66,14 @@
No field created yet. -
@@ -75,7 +81,7 @@
- diff --git a/src/Squidex/app/features/schemas/pages/schema/schema-page.component.ts b/src/Squidex/app/features/schemas/pages/schema/schema-page.component.ts index abc5b1f46..d9957a1f0 100644 --- a/src/Squidex/app/features/schemas/pages/schema/schema-page.component.ts +++ b/src/Squidex/app/features/schemas/pages/schema/schema-page.component.ts @@ -87,7 +87,7 @@ export class SchemaPageComponent extends ResourceOwner implements OnInit { } public sortFields(fields: FieldDto[]) { - this.schemasState.sortFields(this.schema, fields).subscribe(); + this.schemasState.orderFields(this.schema, fields).subscribe(); } public trackByField(index: number, field: FieldDto) { 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..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 @@ -31,6 +31,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 +40,13 @@ export class SchemaPreviewUrlsFormComponent implements OnInit { } public ngOnInit() { + this.isEditable = this.schema.canUpdateUrls; + this.editForm.load(this.schema.previewUrls); + + if (!this.isEditable) { + return; + } } public emitComplete() { @@ -50,6 +58,10 @@ export class SchemaPreviewUrlsFormComponent implements OnInit { } public add() { + if (!this.isEditable) { + return; + } + const value = this.addForm.submit(); if (value) { @@ -60,6 +72,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..9b5d7a2ec 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 @@ -30,6 +30,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 +39,10 @@ export class SchemaScriptsFormComponent implements OnInit { } public ngOnInit() { + this.isEditable = this.schema.canUpdateScripts; + this.editForm.load(this.schema.scripts); + this.editForm.setEnabled(this.isEditable); } public emitComplete() { @@ -49,6 +54,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/features/schemas/pages/schemas/schemas-page.component.html b/src/Squidex/app/features/schemas/pages/schemas/schemas-page.component.html index a1b82746f..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 @@ -6,12 +6,17 @@ - - + + + + +
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..94ade6d25 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 @@ - @@ -52,7 +52,7 @@ Duration:
-
+
{{backup.started | sqxFromNow}}
@@ -78,7 +78,8 @@
-
@@ -29,6 +29,7 @@
- + - {{userInfo.user.displayName}} + {{user.displayName}} - {{userInfo.user.email}} + {{user.email}} - - - - - - - - + +
- + + @@ -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 295624cc9..5f27a6cf9 100644 --- a/src/Squidex/app/features/content/shared/content-item.component.ts +++ b/src/Squidex/app/features/content/shared/content-item.component.ts @@ -41,16 +41,7 @@ export class ContentItemComponent implements OnChanges { public delete = new EventEmitter(); @Output() - public archive = new EventEmitter(); - - @Output() - public restore = new EventEmitter(); - - @Output() - public publish = new EventEmitter(); - - @Output() - public unpublish = new EventEmitter(); + public statusChange = new EventEmitter(); @Output() public selectedChange = new EventEmitter(); @@ -67,6 +58,9 @@ export class ContentItemComponent implements OnChanges { @Input() public schema: SchemaDetailsDto; + @Input() + public canClone: boolean; + @Input() public isReadOnly = false; @@ -80,13 +74,14 @@ export class ContentItemComponent implements OnChanges { public content: ContentDto; public patchForm: PatchContentForm; + public patchAllowed = false; public dropdown = new ModalModel(); public values: any[] = []; public get isDirty() { - return this.patchForm.form.dirty; + return this.patchForm && this.patchForm.form.dirty; } constructor( @@ -96,8 +91,14 @@ export class ContentItemComponent implements OnChanges { } public ngOnChanges(changes: SimpleChanges) { + if (changes['content']) { + this.patchAllowed = !this.isReadOnly && this.content.canUpdate; + } + if (changes['schema'] || changes['language']) { - this.patchForm = new PatchContentForm(this.schema, this.language); + if (this.patchAllowed) { + this.patchForm = new PatchContentForm(this.schema, this.language); + } } if (changes['content'] || changes['language']) { @@ -106,6 +107,10 @@ export class ContentItemComponent implements OnChanges { } public save() { + if (!this.content.canUpdate) { + return; + } + const value = this.patchForm.submit(); if (value) { @@ -132,20 +137,8 @@ export class ContentItemComponent implements OnChanges { this.delete.emit(); } - public emitPublish() { - this.publish.emit(); - } - - public emitUnpublish() { - this.unpublish.emit(); - } - - public emitArchive() { - this.archive.emit(); - } - - public emitRestore() { - this.unpublish.emit(); + public emitChangeStatus(status: string) { + this.statusChange.emit(status); } public emitClone() { diff --git a/src/Squidex/app/features/content/shared/contents-selector.component.html b/src/Squidex/app/features/content/shared/contents-selector.component.html index d8010ea54..e4698264a 100644 --- a/src/Squidex/app/features/content/shared/contents-selector.component.html +++ b/src/Squidex/app/features/content/shared/contents-selector.component.html @@ -11,11 +11,9 @@
- diff --git a/src/Squidex/app/features/content/shared/contents-selector.component.ts b/src/Squidex/app/features/content/shared/contents-selector.component.ts index 3a7d11597..656df7c16 100644 --- a/src/Squidex/app/features/content/shared/contents-selector.component.ts +++ b/src/Squidex/app/features/content/shared/contents-selector.component.ts @@ -8,9 +8,7 @@ import { Component, EventEmitter, Input, OnInit, Output } from '@angular/core'; import { - CONTENT_STATUSES, ContentDto, - ContentQueryStatus, FilterState, LanguageDto, ManualContentsState, @@ -48,8 +46,6 @@ export class ContentsSelectorComponent implements OnInit { public filter = new FilterState(); - public statuses = CONTENT_STATUSES; - public selectedItems: { [id: string]: ContentDto; } = {}; public selectionCount = 0; @@ -74,10 +70,6 @@ export class ContentsSelectorComponent implements OnInit { this.contentsState.search(this.filter.apiFilter); } - public filterStatus(status: ContentQueryStatus) { - this.contentsState.filterStatus(status); - } - public goNext() { this.contentsState.goNext(); } 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..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/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/rules/pages/rules/rule-wizard.component.html b/src/Squidex/app/features/rules/pages/rules/rule-wizard.component.html index 422b0a98f..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 c9b1a77a2..6c47ce087 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,7 +5,7 @@ * 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 { @@ -26,7 +26,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 +35,8 @@ export class RuleWizardComponent implements OnInit { public triggerType: string; public trigger: any = {}; + public isEditable: boolean; + public step = 1; @Output() @@ -61,6 +63,8 @@ export class RuleWizardComponent implements OnInit { } public ngOnInit() { + this.isEditable = !this.rule || this.rule.canUpdate; + if (this.mode === MODE_EDIT_ACTION) { this.step = 4; @@ -74,6 +78,12 @@ export class RuleWizardComponent implements OnInit { } } + public ngAfterViewInit() { + this.actionForm.setEnabled(this.isEditable); + + this.triggerForm.setEnabled(this.isEditable); + } + public emitComplete() { this.complete.emit(); } @@ -132,6 +142,10 @@ export class RuleWizardComponent implements OnInit { } private updateTrigger() { + if (!this.isEditable) { + return; + } + this.rulesState.updateTrigger(this.rule, this.trigger) .subscribe(() => { this.emitComplete(); @@ -143,6 +157,10 @@ export class RuleWizardComponent implements OnInit { } private updateAction() { + if (!this.isEditable) { + 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..29ee47512 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/features/settings/pages/languages/language.component.html b/src/Squidex/app/features/settings/pages/languages/language.component.html index d8dc7dccd..a58f2a5be 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 +60,7 @@
- +
diff --git a/src/Squidex/app/shared/components/markdown-editor.component.ts b/src/Squidex/app/shared/components/markdown-editor.component.ts index 237f33a6c..2197c1fdd 100644 --- a/src/Squidex/app/shared/components/markdown-editor.component.ts +++ b/src/Squidex/app/shared/components/markdown-editor.component.ts @@ -78,6 +78,10 @@ export class MarkdownEditorComponent extends StatefulControlComponent { + if (this.isDisabled) { + return; + } + this.assetsDialog.show(); } @@ -201,7 +205,7 @@ export class MarkdownEditorComponent extends StatefulControlComponent 0) { @@ -220,6 +224,10 @@ export class MarkdownEditorComponent extends StatefulControlComponent { if (Types.is(asset, AssetDto)) { - replaceText(`![${asset.fileName}](${asset.url} '${asset.fileName}')`); + replaceText(`![${asset.fileName}](${asset.contentUrl} '${asset.fileName}')`); } }, error => { if (!Types.is(error, UploadCanceled)) { diff --git a/src/Squidex/app/shared/components/permission.directive.ts b/src/Squidex/app/shared/components/permission.directive.ts deleted file mode 100644 index 540b16c2f..000000000 --- a/src/Squidex/app/shared/components/permission.directive.ts +++ /dev/null @@ -1,133 +0,0 @@ -/* - * Squidex Headless CMS - * - * @license - * Copyright (c) Squidex UG (haftungsbeschränkt). All rights reserved. - */ - -import { ChangeDetectorRef, Directive, Input, OnChanges, OnInit, TemplateRef, ViewContainerRef } from '@angular/core'; - -import { - AppDto, - AppsState, - AuthService, - Permission, - ResourceOwner, - SchemaDto, - SchemasState -} from '@app/shared/internal'; - -@Directive({ - selector: '[sqxPermission]' -}) -export class PermissionDirective extends ResourceOwner implements OnChanges, OnInit { - private viewCreated = false; - - @Input('sqxPermissionApp') - public app?: AppDto; - - @Input('sqxPermissionSchema') - public schema?: SchemaDto; - - @Input('sqxPermission') - public permissions: string; - - constructor( - private readonly authService: AuthService, - private readonly appsState: AppsState, - private readonly changeDetector: ChangeDetectorRef, - private readonly schemasState: SchemasState, - private readonly templateRef: TemplateRef, - private readonly viewContainer: ViewContainerRef - ) { - super(); - } - - public ngOnInit() { - this.own( - this.appsState.selectedApp.subscribe(app => { - if (app && !this.app) { - this.update(app, this.schemasState.snapshot.selectedSchema); - } - })); - - this.own( - this.schemasState.selectedSchema.subscribe(schema => { - if (schema && !this.schema) { - this.update(this.appsState.snapshot.selectedApp, schema); - } - })); - } - - public ngOnChanges() { - this.update(this.appsState.snapshot.selectedApp, this.schemasState.snapshot.selectedSchema); - } - - private update(app?: AppDto | null, schema?: SchemaDto | null) { - if (this.app) { - app = this.app; - } - - if (this.schema) { - schema = this.schema; - } - - let permissions = this.permissions; - - let show = false; - - if (permissions) { - let include = permissions[0] === '?'; - - if (include) { - permissions = permissions.substr(1); - } - - const array = permissions.split(';'); - - for (let id of array) { - if (app) { - id = id.replace('{app}', app.name); - } - - if (schema) { - id = id.replace('{name}', schema.name); - } - - const permission = new Permission(id); - - if (include) { - if (app && permission.includedIn(app.permissions)) { - show = true; - } - - if (!show) { - show = permission.includedIn(this.authService.user!.permissions); - } - } else { - if (app && permission.allowedBy(app.permissions)) { - show = true; - } - - if (!show) { - show = permission.allowedBy(this.authService.user!.permissions); - } - } - - if (show) { - break; - } - } - } - - if (show && !this.viewCreated) { - this.viewContainer.createEmbeddedView(this.templateRef); - this.viewCreated = true; - } else if (!show && this.viewCreated) { - this.viewContainer.clear(); - this.viewCreated = false; - } - - this.changeDetector.markForCheck(); - } -} \ No newline at end of file diff --git a/src/Squidex/app/shared/components/pipes.ts b/src/Squidex/app/shared/components/pipes.ts index 32027bcc0..11abdf943 100644 --- a/src/Squidex/app/shared/components/pipes.ts +++ b/src/Squidex/app/shared/components/pipes.ts @@ -13,6 +13,7 @@ import { map } from 'rxjs/operators'; import { ApiUrlConfig, + AssetDto, formatHistoryMessage, HistoryEventDto, MathHelper, @@ -215,8 +216,8 @@ export class UserPictureRefPipe extends UserAsyncPipe implements PipeTransform { pure: true }) export class AssetUrlPipe implements PipeTransform { - public transform(asset: { url: any }): string { - return `${asset.url}?q=${MathHelper.guid()}`; + public transform(asset: AssetDto): string { + return `${asset.contentUrl}&sq=${MathHelper.guid()}`; } } @@ -225,13 +226,8 @@ export class AssetUrlPipe implements PipeTransform { pure: true }) export class AssetPreviewUrlPipe implements PipeTransform { - constructor( - private readonly apiUrl: ApiUrlConfig - ) { - } - - public transform(asset: { id: any, fileVersion: number }): string { - return this.apiUrl.buildUrl(`api/assets/${asset.id}?version=${asset.fileVersion}`); + public transform(asset: AssetDto): string { + return asset.contentUrl; } } diff --git a/src/Squidex/app/shared/components/rich-editor.component.html b/src/Squidex/app/shared/components/rich-editor.component.html index 36cb40d19..44a1469e8 100644 --- a/src/Squidex/app/shared/components/rich-editor.component.html +++ b/src/Squidex/app/shared/components/rich-editor.component.html @@ -1,4 +1,4 @@ -
+
diff --git a/src/Squidex/app/shared/components/rich-editor.component.ts b/src/Squidex/app/shared/components/rich-editor.component.ts index 1f9ea859d..fe2362bac 100644 --- a/src/Squidex/app/shared/components/rich-editor.component.ts +++ b/src/Squidex/app/shared/components/rich-editor.component.ts @@ -78,6 +78,10 @@ export class RichEditorComponent extends StatefulControlComponent i } private showSelector = () => { + if (this.isDisabled) { + return; + } + this.assetsDialog.show(); } @@ -98,7 +102,7 @@ export class RichEditorComponent extends StatefulControlComponent i this.assetUploader.uploadFile(file) .subscribe(asset => { if (Types.is(asset, AssetDto)) { - success(asset.url); + success(asset.contentUrl); } }, error => { if (!Types.is(error, UploadCanceled)) { @@ -186,7 +190,7 @@ export class RichEditorComponent extends StatefulControlComponent i let content = ''; for (let asset of assets) { - content += `${asset.fileName}`; + content += `${asset.fileName}`; } if (content.length > 0) { @@ -216,7 +220,7 @@ export class RichEditorComponent extends StatefulControlComponent i this.assetUploader.uploadFile(file) .subscribe(asset => { if (Types.is(asset, AssetDto)) { - replaceText(`${asset.fileName}`); + replaceText(`${asset.fileName}`); } }, error => { if (!Types.is(error, UploadCanceled)) { diff --git a/src/Squidex/app/shared/components/schema-category.component.html b/src/Squidex/app/shared/components/schema-category.component.html index ee0a6cb79..406e91f13 100644 --- a/src/Squidex/app/shared/components/schema-category.component.html +++ b/src/Squidex/app/shared/components/schema-category.component.html @@ -1,4 +1,4 @@ -
+
@@ -8,36 +8,36 @@

{{snapshot.displayName}} ({{snapshot.schemasFiltered.length}})

-
+ + + {{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..e0d7dc6df 100644 --- a/src/Squidex/app/shared/components/schema-category.component.ts +++ b/src/Squidex/app/shared/components/schema-category.component.ts @@ -41,7 +41,7 @@ export class SchemaCategoryComponent extends StatefulComponent implements public name: string; @Input() - public isReadonly: boolean; + public forContent: boolean; @Input() public routeSingletonToContent = false; @@ -96,7 +96,7 @@ export class SchemaCategoryComponent extends StatefulComponent implements if (query) { isOpen = true; } else { - isOpen = this.localStore.get(`schema-category.${this.name}`) !== 'false'; + isOpen = !this.localStore.getBoolean(this.configKey()); } this.next(s => ({ ...s, isOpen, schemasFiltered, schemasForCategory })); @@ -122,7 +122,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 || schema.canReadContents); } public changeCategory(schema: SchemaDto) { @@ -137,10 +137,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/components/search-form.component.html b/src/Squidex/app/shared/components/search-form.component.html index 5347b37c8..de394f927 100644 --- a/src/Squidex/app/shared/components/search-form.component.html +++ b/src/Squidex/app/shared/components/search-form.component.html @@ -68,17 +68,6 @@ (ngModelChange)="filter.setOrder($event)" />
- -
-
-
- - -
-
-
Read more about filtering in the Documentation. diff --git a/src/Squidex/app/shared/components/search-form.component.ts b/src/Squidex/app/shared/components/search-form.component.ts index 27021e930..d62b3e57a 100644 --- a/src/Squidex/app/shared/components/search-form.component.ts +++ b/src/Squidex/app/shared/components/search-form.component.ts @@ -39,15 +39,6 @@ export class SearchFormComponent implements OnInit { @Input() public filter: FilterState; - @Input() - public statuses: { [status: string]: string }; - - @Input() - public status: string; - - @Output() - public statusChange = new EventEmitter(); - @Input() public schemaName = ''; diff --git a/src/Squidex/app/shared/declarations.ts b/src/Squidex/app/shared/declarations.ts index 7d5d57367..829dc1d85 100644 --- a/src/Squidex/app/shared/declarations.ts +++ b/src/Squidex/app/shared/declarations.ts @@ -20,7 +20,6 @@ export * from './components/history.component'; export * from './components/history-list.component'; export * from './components/language-selector.component'; export * from './components/markdown-editor.component'; -export * from './components/permission.directive'; export * from './components/pipes'; export * from './components/rich-editor.component'; export * from './components/schema-category.component'; diff --git a/src/Squidex/app/shared/module.ts b/src/Squidex/app/shared/module.ts index 76e0cbc5e..19fb7f461 100644 --- a/src/Squidex/app/shared/module.ts +++ b/src/Squidex/app/shared/module.ts @@ -64,7 +64,6 @@ import { NewsService, PatternsService, PatternsState, - PermissionDirective, PlansService, PlansState, RichEditorComponent, @@ -123,7 +122,6 @@ import { HistoryMessagePipe, LanguageSelectorComponent, MarkdownEditorComponent, - PermissionDirective, SchemaCategoryComponent, UserDtoPicture, UserIdPicturePipe, @@ -155,7 +153,6 @@ import { HistoryMessagePipe, LanguageSelectorComponent, MarkdownEditorComponent, - PermissionDirective, RichEditorComponent, RouterModule, SchemaCategoryComponent, diff --git a/src/Squidex/app/shared/services/app-languages.service.spec.ts b/src/Squidex/app/shared/services/app-languages.service.spec.ts index e9c57425a..06c3cbb87 100644 --- a/src/Squidex/app/shared/services/app-languages.service.spec.ts +++ b/src/Squidex/app/shared/services/app-languages.service.spec.ts @@ -13,7 +13,10 @@ import { ApiUrlConfig, AppLanguageDto, AppLanguagesDto, + AppLanguagesPayload, AppLanguagesService, + Resource, + ResourceLinks, Version } from '@app/shared/internal'; @@ -51,33 +54,13 @@ describe('AppLanguagesService', () => { expect(req.request.method).toEqual('GET'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush([ - { - iso2Code: 'en', - englishName: 'English', - isMaster: true, - isOptional: true, - fallback: ['de', 'en'] - }, - { - iso2Code: 'it', - isMaster: false, - isOptional: false, - englishName: 'Italian' - } - ], { + req.flush(languagesResponse('en', 'de', 'it'), { headers: { etag: '2' } }); - expect(languages!).toEqual({ - payload: [ - new AppLanguageDto('en', 'English', true, true, ['de', 'en']), - new AppLanguageDto('it', 'Italian', false, false, []) - ], - version: new Version('2') - }); + expect(languages!).toEqual({payload: createLanguages('en', 'de', 'it'), version: new Version('2') }); })); it('should make post request to add language', @@ -85,10 +68,10 @@ describe('AppLanguagesService', () => { const dto = { language: 'de' }; - let language: AppLanguageDto; + let languages: AppLanguagesDto; appLanguagesService.postLanguage('my-app', dto, version).subscribe(result => { - language = result.payload; + languages = result; }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/languages'); @@ -96,14 +79,13 @@ describe('AppLanguagesService', () => { expect(req.request.method).toEqual('POST'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({ - iso2Code: 'de', - isMaster: false, - isOptional: false, - englishName: 'German' + req.flush(languagesResponse('en', 'de', 'it'), { + headers: { + etag: '2' + } }); - expect(language!).toEqual(new AppLanguageDto('de', 'German', false, false, [])); + expect(languages!).toEqual({payload: createLanguages('en', 'de', 'it'), version: new Version('2') }); })); it('should make put request to make master language', @@ -111,26 +93,93 @@ describe('AppLanguagesService', () => { const dto = { isMaster: true }; - appLanguagesService.putLanguage('my-app', 'de', dto, version).subscribe(); + const resource: Resource = { + _links: { + update: { method: 'PUT', href: 'api/apps/my-app/languages/de' } + } + }; + + let languages: AppLanguagesDto; + + appLanguagesService.putLanguage('my-app', resource, dto, version).subscribe(result => { + languages = result; + }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/languages/de'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({}); + req.flush(languagesResponse('en', 'de', 'it'), { + headers: { + etag: '2' + } + }); + + expect(languages!).toEqual({payload: createLanguages('en', 'de', 'it'), version: new Version('2') }); })); it('should make delete request to remove language', inject([AppLanguagesService, HttpTestingController], (appLanguagesService: AppLanguagesService, httpMock: HttpTestingController) => { - appLanguagesService.deleteLanguage('my-app', 'de', version).subscribe(); + const resource: Resource = { + _links: { + delete: { method: 'DELETE', href: 'api/apps/my-app/languages/de' } + } + }; + + let languages: AppLanguagesDto; + + appLanguagesService.deleteLanguage('my-app', resource, version).subscribe(result => { + languages = result; + }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/languages/de'); expect(req.request.method).toEqual('DELETE'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({}); + req.flush(languagesResponse('en', 'de', 'it'), { + headers: { + etag: '2' + } + }); + + expect(languages!).toEqual({payload: createLanguages('en', 'de', 'it'), version: new Version('2') }); })); -}); \ No newline at end of file + + function languagesResponse(...codes: string[]) { + return { + items: codes.map((code, i) => ({ + iso2Code: code, + englishName: code, + isMaster: i === 0, + isOptional: i % 2 === 1, + fallback: codes.filter(x => x !== code), + _links: { + update: { method: 'PUT', href: `/languages/${code}` } + } + })), + _links: { + create: { method: 'POST', href: '/languages' } + } + }; + } +}); + +export function createLanguages(...codes: string[]): AppLanguagesPayload { + return { + items: codes.map((code, i) => createLanguage(code, codes, i)), + _links: { + create: { method: 'POST', href: '/languages' } + }, + canCreate: true + }; +} +function createLanguage(code: string, codes: string[], i: number) { + const links: ResourceLinks = { + update: { method: 'PUT', href: `/languages/${code}` } + }; + + return new AppLanguageDto(links, code, code, i === 0, i % 2 === 1, codes.filter(x => x !== code)); +} \ No newline at end of file diff --git a/src/Squidex/app/shared/services/app-languages.service.ts b/src/Squidex/app/shared/services/app-languages.service.ts index 8df82330c..23a7a486e 100644 --- a/src/Squidex/app/shared/services/app-languages.service.ts +++ b/src/Squidex/app/shared/services/app-languages.service.ts @@ -13,36 +13,41 @@ import { tap } from 'rxjs/operators'; import { AnalyticsService, ApiUrlConfig, + hasAnyLink, HTTP, mapVersioned, - Model, pretifyError, + Resource, + ResourceLinks, Version, Versioned } from '@app/framework'; -import { LanguageDto } from './languages.service'; +export type AppLanguagesDto = Versioned; +export type AppLanguagesPayload = { + readonly items: AppLanguageDto[]; -export type AppLanguagesDto = Versioned; + readonly canCreate: boolean; +} & Resource; + +export class AppLanguageDto { + public readonly _links: ResourceLinks; + + public readonly canUpdate: boolean; + public readonly canDelete: boolean; -export class AppLanguageDto extends Model { constructor( + links: ResourceLinks, public readonly iso2Code: string, public readonly englishName: string, public readonly isMaster: boolean, public readonly isOptional: boolean, public readonly fallback: string[] ) { - super(); - } + this._links = links; - public static fromLanguage(language: LanguageDto, isMaster = false, isOptional = false, fallback: string[] = []) { - return new AppLanguageDto( - language.iso2Code, - language.englishName, - isMaster, - isOptional, - fallback); + this.canUpdate = hasAnyLink(links, 'update'); + this.canDelete = hasAnyLink(links, 'delete'); } } @@ -68,36 +73,19 @@ export class AppLanguagesService { public getLanguages(appName: string): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/languages`); - return HTTP.getVersioned(this.http, url).pipe( + return HTTP.getVersioned(this.http, url).pipe( mapVersioned(({ body }) => { - const items: any[] = body; - - const languages = items.map(item => - new AppLanguageDto( - item.iso2Code, - item.englishName, - item.isMaster, - item.isOptional, - item.fallback || [])); - - return languages; + return parseLanguages(body); }), pretifyError('Failed to load languages. Please reload.')); } - public postLanguage(appName: string, dto: AddAppLanguageDto, version: Version): Observable> { + public postLanguage(appName: string, dto: AddAppLanguageDto, version: Version): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/languages`); - return HTTP.postVersioned(this.http, url, dto, version).pipe( + return HTTP.postVersioned(this.http, url, dto, version).pipe( mapVersioned(({ body }) => { - const language = new AppLanguageDto( - body.iso2Code, - body.englishName, - body.isMaster, - body.isOptional, - body.fallback || []); - - return language; + return parseLanguages(body); }), tap(() => { this.analytics.trackEvent('Language', 'Added', appName); @@ -105,23 +93,49 @@ export class AppLanguagesService { pretifyError('Failed to add language. Please reload.')); } - public putLanguage(appName: string, languageCode: string, dto: UpdateAppLanguageDto, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/languages/${languageCode}`); + public putLanguage(appName: string, resource: Resource, dto: UpdateAppLanguageDto, 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 parseLanguages(body); + }), tap(() => { this.analytics.trackEvent('Language', 'Updated', appName); }), pretifyError('Failed to change language. Please reload.')); } - public deleteLanguage(appName: string, languageCode: string, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/languages/${languageCode}`); + public deleteLanguage(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 parseLanguages(body); + }), tap(() => { this.analytics.trackEvent('Language', 'Deleted', appName); }), pretifyError('Failed to add language. Please reload.')); } +} + +function parseLanguages(response: any) { + const raw: any[] = response.items; + + const items = raw.map(item => + new AppLanguageDto(item._links, + item.iso2Code, + item.englishName, + item.isMaster, + item.isOptional, + item.fallback || [])); + + const _links = response._links; + + return { items, _links, canCreate: hasAnyLink(_links, 'create') }; } \ No newline at end of file diff --git a/src/Squidex/app/shared/services/apps.service.spec.ts b/src/Squidex/app/shared/services/apps.service.spec.ts index 65d86a946..4c02fbc8e 100644 --- a/src/Squidex/app/shared/services/apps.service.spec.ts +++ b/src/Squidex/app/shared/services/apps.service.spec.ts @@ -11,11 +11,11 @@ import { inject, TestBed } from '@angular/core/testing'; import { AnalyticsService, ApiUrlConfig, - AppCreatedDto, AppDto, AppsService, DateTime, - Permission + Resource, + ResourceLinks } from '@app/shared/internal'; describe('AppsService', () => { @@ -51,31 +51,11 @@ describe('AppsService', () => { expect(req.request.headers.get('If-Match')).toBeNull(); req.flush([ - { - id: '123', - name: 'name1', - permissions: ['Owner'], - created: '2016-01-01', - lastModified: '2016-02-02', - planName: 'Free', - planUpgrade: 'Basic' - }, - { - id: '456', - name: 'name2', - permissions: ['Owner'], - created: '2017-01-01', - lastModified: '2017-02-02', - planName: 'Basic', - planUpgrade: 'Enterprise' - } + appResponse(12), + appResponse(13) ]); - expect(apps!).toEqual( - [ - new AppDto('123', 'name1', [new Permission('Owner')], DateTime.parseISO('2016-01-01'), DateTime.parseISO('2016-02-02'), 'Free', 'Basic'), - new AppDto('456', 'name2', [new Permission('Owner')], DateTime.parseISO('2017-01-01'), DateTime.parseISO('2017-02-02'), 'Basic', 'Enterprise') - ]); + expect(apps!).toEqual([createApp(12), createApp(13)]); })); it('should make post request to create app', @@ -83,7 +63,7 @@ describe('AppsService', () => { const dto = { name: 'new-app' }; - let app: AppCreatedDto; + let app: AppDto; appsService.postApp(dto).subscribe(result => { app = result; @@ -94,25 +74,21 @@ describe('AppsService', () => { expect(req.request.method).toEqual('POST'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush({ - id: '123', - permissions: ['Reader'], - planName: 'Basic', - planUpgrade: 'Enterprise' - }); + req.flush(appResponse(12)); - expect(app!).toEqual({ - id: '123', - permissions: ['Reader'], - planName: 'Basic', - planUpgrade: 'Enterprise' - }); + expect(app!).toEqual(createApp(12)); })); it('should make delete request to archive app', - inject([AppsService, HttpTestingController], (appsService: AppsService, httpMock: HttpTestingController) => { + inject([AppsService, HttpTestingController], (appsService: AppsService, httpMock: HttpTestingController) => { - appsService.deleteApp('my-app').subscribe(); + const resource: Resource = { + _links: { + delete: { method: 'DELETE', href: '/api/apps/my-app' } + } + }; + + appsService.deleteApp(resource).subscribe(); const req = httpMock.expectOne('http://service/p/api/apps/my-app'); @@ -121,4 +97,37 @@ describe('AppsService', () => { req.flush({}); })); -}); \ No newline at end of file + + function appResponse(id: number, suffix = '') { + return { + id: `id${id}`, + name: `name${id}${suffix}`, + permissions: ['Owner'], + 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', + planUpgrade: 'Basic', + _links: { + schemas: { method: 'GET', href: '/schemas' } + } + }; + } +}); + +export function createApp(id: number, suffix = '') { + const links: ResourceLinks = { + schemas: { method: 'GET', href: '/schemas' } + }; + + return new AppDto(links, + `id${id}`, `name${id}${suffix}`, + ['Owner'], + 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', + 'Basic'); +} \ No newline at end of file diff --git a/src/Squidex/app/shared/services/apps.service.ts b/src/Squidex/app/shared/services/apps.service.ts index c80d71dc4..9ed139d17 100644 --- a/src/Squidex/app/shared/services/apps.service.ts +++ b/src/Squidex/app/shared/services/apps.service.ts @@ -14,22 +14,55 @@ import { AnalyticsService, ApiUrlConfig, DateTime, - Model, - Permission, - pretifyError + hasAnyLink, + pretifyError, + Resource, + ResourceLinks } from '@app/framework'; -export class AppDto extends Model { - constructor( +export class AppDto { + public readonly _links: ResourceLinks; + + public readonly canCreateSchema: boolean; + public readonly canDelete: boolean; + public readonly canReadAssets: boolean; + public readonly canReadBackups: boolean; + public readonly canReadClients: boolean; + public readonly canReadContributors: boolean; + public readonly canReadLanguages: boolean; + public readonly canReadPatterns: boolean; + public readonly canReadPlans: boolean; + public readonly canReadRoles: boolean; + public readonly canReadRules: boolean; + public readonly canReadSchemas: boolean; + public readonly canUploadAssets: boolean; + + constructor(links: ResourceLinks, public readonly id: string, public readonly name: string, - public readonly permissions: Permission[], + public readonly permissions: string[], public readonly created: DateTime, public readonly lastModified: DateTime, + public readonly canAccessApi: boolean, + public readonly canAccessContent: boolean, public readonly planName?: string, public readonly planUpgrade?: string ) { - super(); + this._links = links; + + this.canCreateSchema = hasAnyLink(links, 'schemas/create'); + this.canDelete = hasAnyLink(links, 'delete'); + this.canReadAssets = hasAnyLink(links, 'assets'); + this.canReadBackups = hasAnyLink(links, 'backups'); + this.canReadClients = hasAnyLink(links, 'clients'); + this.canReadContributors = hasAnyLink(links, 'contributors'); + this.canReadLanguages = hasAnyLink(links, 'languages'); + this.canReadPatterns = hasAnyLink(links, 'patterns'); + this.canReadPlans = hasAnyLink(links, 'plans'); + this.canReadRoles = hasAnyLink(links, 'roles'); + this.canReadRules = hasAnyLink(links, 'rules'); + this.canReadSchemas = hasAnyLink(links, 'schemas'); + this.canUploadAssets = hasAnyLink(links, 'assets/create'); } } @@ -38,13 +71,6 @@ export interface CreateAppDto { readonly template?: string; } -export interface AppCreatedDto { - readonly id: string; - readonly permissions: string[]; - readonly planName?: string; - readonly planUpgrade?: string; -} - @Injectable() export class AppsService { constructor( @@ -59,41 +85,48 @@ export class AppsService { return this.http.get(url).pipe( map(body => { - const apps = body.map(item => { - const permissions = (item.permissions).map(x => new Permission(x)); - - return new AppDto( - item.id, - item.name, - permissions, - DateTime.parseISO(item.created), - DateTime.parseISO(item.lastModified), - item.planName, - item.planUpgrade); - }); + const apps = body.map(item => parseApp(item)); return apps; }), pretifyError('Failed to load apps. Please reload.')); } - public postApp(dto: CreateAppDto): Observable { + 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); + }), tap(() => { this.analytics.trackEvent('App', 'Created', dto.name); }), pretifyError('Failed to create app. Please reload.')); } - public deleteApp(appName: string): Observable { - const url = this.apiUrl.buildUrl(`api/apps/${appName}`); + public deleteApp(resource: Resource): Observable { + const link = resource._links['delete']; + + const url = this.apiUrl.buildUrl(link.href); - return this.http.delete(url).pipe( + return this.http.request(link.method, url).pipe( tap(() => { - this.analytics.trackEvent('App', 'Archived', appName); + this.analytics.trackEvent('App', 'Archived'); }), pretifyError('Failed to archive app. Please reload.')); } -} \ No newline at end of file +} + +function parseApp(response: any) { + return new AppDto(response._links, + response.id, + response.name, + response.permissions, + DateTime.parseISO_UTC(response.created), + DateTime.parseISO_UTC(response.lastModified), + response.canAccessApi, + response.canAccessContent, + response.planName, + response.planUpgrade); +} diff --git a/src/Squidex/app/shared/services/assets.service.spec.ts b/src/Squidex/app/shared/services/assets.service.spec.ts index b6919e6ea..abcea523e 100644 --- a/src/Squidex/app/shared/services/assets.service.spec.ts +++ b/src/Squidex/app/shared/services/assets.service.spec.ts @@ -12,64 +12,14 @@ import { AnalyticsService, ApiUrlConfig, AssetDto, - AssetReplacedDto, AssetsDto, AssetsService, DateTime, ErrorDto, - Version, - Versioned + Resource, + ResourceLinks, + Version } from '@app/shared/internal'; -import { AssetUploadedDto } from './assets.service'; - -describe('AssetDto', () => { - const creation = DateTime.today(); - const creator = 'not-me'; - const modified = DateTime.now(); - const modifier = 'me'; - const version = new Version('1'); - const newVersion = new Version('2'); - - it('should update tag property and user info when annnoting', () => { - const update = { fileName: 'New-Name.png' }; - - const asset_1 = new AssetDto('1', creator, creator, creation, creation, 'Name.png', 'Hash', 'png', 1, 1, 'image/png', false, false, 1, 1, 'name.png', [], 'url', version); - const asset_2 = asset_1.annnotate(update, modifier, newVersion, modified); - - expect(asset_2.fileName).toEqual(update.fileName); - expect(asset_2.tags).toEqual([]); - expect(asset_2.slug).toEqual(asset_1.slug); - expect(asset_2.lastModified).toEqual(modified); - expect(asset_2.lastModifiedBy).toEqual(modifier); - expect(asset_2.version).toEqual(newVersion); - }); - - it('should update file properties when uploading', () => { - const update = { - fileHash: 'Hash New', - fileSize: 1024, - fileVersion: 12, - mimeType: 'image/png', - isImage: true, - pixelWidth: 1024, - pixelHeight: 2048 - }; - - const asset_1 = new AssetDto('1', creator, creator, creation, creation, 'Name.png', 'Hash', 'png', 1, 1, 'image/png', false, false, 1, 1, 'name.png', [], 'url', version); - const asset_2 = asset_1.update(update, modifier, newVersion, modified); - - expect(asset_2.fileHash).toEqual(update.fileHash); - expect(asset_2.fileSize).toEqual(update.fileSize); - expect(asset_2.fileVersion).toEqual(update.fileVersion); - expect(asset_2.mimeType).toEqual(update.mimeType); - expect(asset_2.isImage).toBeTruthy(); - expect(asset_2.pixelWidth).toEqual(update.pixelWidth); - expect(asset_2.pixelHeight).toEqual(update.pixelHeight); - expect(asset_2.lastModified).toEqual(modified); - expect(asset_2.lastModifiedBy).toEqual(modifier); - expect(asset_2.version).toEqual(newVersion); - }); -}); describe('AssetsService', () => { const version = new Version('1'); @@ -133,85 +83,16 @@ describe('AssetsService', () => { req.flush({ total: 10, items: [ - { - id: 'id1', - created: '2016-12-12T10:10', - createdBy: 'Created1', - lastModified: '2017-12-12T10:10', - lastModifiedBy: 'LastModifiedBy1', - fileName: 'My Asset1.png', - fileHash: 'My Hash1', - fileType: 'png', - fileSize: 1024, - fileVersion: 2000, - mimeType: 'image/png', - isImage: true, - pixelWidth: 1024, - pixelHeight: 2048, - slug: 'my-asset1.png', - tags: undefined, - version: 11 - }, - { - id: 'id2', - created: '2016-10-12T10:10', - createdBy: 'Created2', - lastModified: '2017-10-12T10:10', - lastModifiedBy: 'LastModifiedBy2', - fileName: 'My Asset2.png', - fileHash: 'My Hash1', - fileType: 'png', - fileSize: 1024, - fileVersion: 2000, - mimeType: 'image/png', - isImage: true, - pixelWidth: 1024, - pixelHeight: 2048, - slug: 'my-asset2.png', - tags: ['tag1', 'tag2'], - version: 22 - } + assetResponse(12), + assetResponse(13) ] }); expect(assets!).toEqual( new AssetsDto(10, [ - new AssetDto( - 'id1', 'Created1', 'LastModifiedBy1', - DateTime.parseISO_UTC('2016-12-12T10:10'), - DateTime.parseISO_UTC('2017-12-12T10:10'), - 'My Asset1.png', - 'My Hash1', - 'png', - 1024, - 2000, - 'image/png', - false, - true, - 1024, - 2048, - 'my-asset1.png', - [], - 'http://service/p/api/assets/id1', - new Version('11')), - new AssetDto('id2', 'Created2', 'LastModifiedBy2', - DateTime.parseISO_UTC('2016-10-12T10:10'), - DateTime.parseISO_UTC('2017-10-12T10:10'), - 'My Asset2.png', - 'My Hash1', - 'png', - 1024, - 2000, - 'image/png', - false, - true, - 1024, - 2048, - 'my-asset2.png', - ['tag1', 'tag2'], - 'http://service/p/api/assets/id2', - new Version('22')) - ])); + createAsset(12), + createAsset(13) + ])); })); it('should make get request to get asset', @@ -228,48 +109,9 @@ describe('AssetsService', () => { expect(req.request.method).toEqual('GET'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush({ - id: 'id1', - created: '2016-12-12T10:10', - createdBy: 'Created1', - lastModified: '2017-12-12T10:10', - lastModifiedBy: 'LastModifiedBy1', - fileName: 'My Asset1.png', - fileHash: 'My Hash1', - fileType: 'png', - fileSize: 1024, - fileVersion: 2000, - mimeType: 'image/png', - isImage: true, - pixelWidth: 1024, - pixelHeight: 2048, - slug: 'my-asset1.png', - tags: ['tag1', 'tag2'] - }, { - headers: { - etag: '2' - } - }); + req.flush(assetResponse(12)); - expect(asset!).toEqual( - new AssetDto( - 'id1', 'Created1', 'LastModifiedBy1', - DateTime.parseISO_UTC('2016-12-12T10:10'), - DateTime.parseISO_UTC('2017-12-12T10:10'), - 'My Asset1.png', - 'My Hash1', - 'png', - 1024, - 2000, - 'image/png', - false, - true, - 1024, - 2048, - 'my-asset1.png', - ['tag1', 'tag2'], - 'http://service/p/api/assets/id1', - new Version('2'))); + expect(asset!).toEqual(createAsset(12)); })); it('should append query to find by name', @@ -314,10 +156,10 @@ describe('AssetsService', () => { it('should make post request to create asset', inject([AssetsService, HttpTestingController], (assetsService: AssetsService, httpMock: HttpTestingController) => { - let asset: Versioned; + let asset: AssetDto; assetsService.uploadFile('my-app', null!).subscribe(result => { - asset = >result; + asset = result; }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/assets'); @@ -325,54 +167,19 @@ describe('AssetsService', () => { expect(req.request.method).toEqual('POST'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush({ - id: 'id1', - fileName: 'My Asset1.png', - fileHash: 'My Hash1', - fileType: 'png', - fileSize: 1024, - fileVersion: 2, - mimeType: 'image/png', - isDuplicate: true, - isImage: true, - pixelWidth: 1024, - pixelHeight: 2048, - slug: 'my-asset1.png', - tags: ['tag1', 'tag2'] - }, { - headers: { - etag: '1' - } - }); + req.flush(assetResponse(12)); - expect(asset!).toEqual({ - payload: { - id: 'id1', - fileName: 'My Asset1.png', - fileHash: 'My Hash1', - fileType: 'png', - fileSize: 1024, - fileVersion: 2, - mimeType: 'image/png', - isDuplicate: true, - isImage: true, - pixelWidth: 1024, - pixelHeight: 2048, - slug: 'my-asset1.png', - tags: ['tag1', 'tag2'] - }, - version - }); + expect(asset!).toEqual(createAsset(12)); })); it('should return proper error when upload failed with 413', inject([AssetsService, HttpTestingController], (assetsService: AssetsService, httpMock: HttpTestingController) => { - let asset: Versioned; + let asset: AssetDto; let error: ErrorDto; assetsService.uploadFile('my-app', null!).subscribe(result => { - asset = >result; + asset = result; }, e => { error = e; }); @@ -391,10 +198,16 @@ describe('AssetsService', () => { it('should make put request to replace asset content', inject([AssetsService, HttpTestingController], (assetsService: AssetsService, httpMock: HttpTestingController) => { - let asset: AssetReplacedDto; + const resource: Resource = { + _links: { + upload: { method: 'PUT', href: 'api/apps/my-app/assets/123/content' } + } + }; + + let asset: AssetDto; - assetsService.replaceFile('my-app', '123', null!, version).subscribe(result => { - asset = (>result).payload; + assetsService.replaceFile('my-app', resource, null!, version).subscribe(result => { + asset = result; }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/assets/123/content'); @@ -402,35 +215,29 @@ describe('AssetsService', () => { expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({ - fileHash: 'Hash New', - fileSize: 1024, - fileVersion: 12, - mimeType: 'image/png', - isImage: true, - pixelWidth: 1024, - pixelHeight: 2048 + req.flush(assetResponse(123), { + headers: { + etag: '1' + } }); - expect(asset!).toEqual({ - fileHash: 'Hash New', - fileSize: 1024, - fileVersion: 12, - mimeType: 'image/png', - isImage: true, - pixelWidth: 1024, - pixelHeight: 2048 - }); + expect(asset!).toEqual(createAsset(123)); })); it('should return proper error when replace failed with 413', inject([AssetsService, HttpTestingController], (assetsService: AssetsService, httpMock: HttpTestingController) => { - let asset: AssetReplacedDto; + const resource: Resource = { + _links: { + upload: { method: 'PUT', href: 'api/apps/my-app/assets/123/content' } + } + }; + + let asset: AssetDto; let error: ErrorDto; - assetsService.replaceFile('my-app', '123', null!, version).subscribe(result => { - asset = (>result).payload; + assetsService.replaceFile('my-app', resource, null!, version).subscribe(result => { + asset = result; }, e => { error = e; }); @@ -451,20 +258,42 @@ describe('AssetsService', () => { const dto = { fileName: 'New-Name.png' }; - assetsService.putAsset('my-app', '123', dto, version).subscribe(); + const resource: Resource = { + _links: { + update: { method: 'PUT', href: 'api/apps/my-app/assets/123' } + } + }; + + let asset: AssetDto; + + assetsService.putAsset('my-app', resource, dto, version).subscribe(result => { + asset = result; + }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/assets/123'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({}); + req.flush(assetResponse(123), { + headers: { + etag: '1' + } + }); + + expect(asset!).toEqual(createAsset(123)); })); it('should make delete request to delete asset', inject([AssetsService, HttpTestingController], (assetsService: AssetsService, httpMock: HttpTestingController) => { - assetsService.deleteAsset('my-app', '123', version).subscribe(); + const resource: Resource = { + _links: { + delete: { method: 'DELETE', href: 'api/apps/my-app/assets/123' } + } + }; + + assetsService.deleteAsset('my-app', resource, version).subscribe(); const req = httpMock.expectOne('http://service/p/api/apps/my-app/assets/123'); @@ -473,4 +302,59 @@ describe('AssetsService', () => { req.flush({}); })); -}); \ No newline at end of file + + function assetResponse(id: number, suffix = '') { + return { + id: `id${id}`, + created: `${id % 1000 + 2000}-12-12T10:10:00`, + createdBy: `creator-${id}`, + lastModified: `${id % 1000 + 2000}-11-11T10:10:00`, + lastModifiedBy: `modifier-${id}`, + fileName: `My Name${id}${suffix}.png`, + fileHash: `My Hash${id}${suffix}`, + fileType: 'png', + fileSize: id * 2, + fileVersion: id * 4, + mimeType: 'image/png', + isImage: true, + pixelWidth: id * 3, + pixelHeight: id * 5, + slug: `my-name${id}${suffix}.png`, + tags: ['tag1', 'tag2'], + version: id, + _links: { + update: { method: 'PUT', href: `/assets/${id}` } + }, + _meta: { + isDuplicate: 'true' + } + }; + } +}); + +export function createAsset(id: number, tags?: string[], suffix = '') { + const links: ResourceLinks = { + update: { method: 'PUT', href: `/assets/${id}` } + }; + + const meta = { + isDuplicate: 'true' + }; + + return new AssetDto(links, meta, + `id${id}`, + 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', + id * 2, + id * 4, + 'image/png', + true, + id * 3, + id * 5, + `my-name${id}${suffix}.png`, + tags || ['tag1', 'tag2'], + new Version(`${id}`)); +} \ No newline at end of file diff --git a/src/Squidex/app/shared/services/assets.service.ts b/src/Squidex/app/shared/services/assets.service.ts index 463eb7943..8fd9e0fbd 100644 --- a/src/Squidex/app/shared/services/assets.service.ts +++ b/src/Squidex/app/shared/services/assets.service.ts @@ -15,63 +15,70 @@ import { ApiUrlConfig, DateTime, ErrorDto, + hasAnyLink, HTTP, - Model, + Metadata, pretifyError, + Resource, + ResourceLinks, ResultSet, Types, Version, - Versioned, - versioned + Versioned } from '@app/framework'; -export class AssetsDto extends ResultSet { } +export class AssetsDto extends ResultSet { + public get canCreate() { + return hasAnyLink(this._links, 'create'); + } +} + +export class AssetDto { + public readonly _meta: Metadata = {}; + + public readonly _links: ResourceLinks; + + public readonly canDelete: boolean; + public readonly canPreview: boolean; + public readonly canUpdate: boolean; + public readonly canUpload: boolean; -export class AssetDto extends Model { - public get canPreview() { - return this.isImage || (this.mimeType === 'image/svg+xml' && this.fileSize < 100 * 1024); + public get isDuplicate() { + return this._meta && this._meta['isDuplicate'] === 'true'; } - constructor( + public get contentUrl() { + return this._links['content'].href; + } + + constructor(links: ResourceLinks, meta: Metadata, 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, public readonly fileSize: number, public readonly fileVersion: number, public readonly mimeType: string, - public readonly isDuplicate: boolean, public readonly isImage: boolean, public readonly pixelWidth: number | null | undefined, public readonly pixelHeight: number | null | undefined, public readonly slug: string, public readonly tags: string[], - public readonly url: string, public readonly version: Version ) { - super(); - } + this.canPreview = this.isImage || (this.mimeType === 'image/svg+xml' && this.fileSize < 100 * 1024); - public update(update: AssetReplacedDto, user: string, version: Version, now?: DateTime): AssetDto { - return this.with({ - ...update, - lastModified: now || DateTime.now(), - lastModifiedBy: user, - version - }); - } + this._links = links; + + this.canDelete = hasAnyLink(links, 'delete'); + this.canUpdate = hasAnyLink(links, 'update'); + this.canUpload = hasAnyLink(links, 'upload'); - public annnotate(update: AnnotateAssetDto, user: string, version: Version, now?: DateTime): AssetDto { - return this.with({ - ...update, - lastModified: now || DateTime.now(), - lastModifiedBy: user, - version - }, true); + this._meta = meta; } } @@ -81,25 +88,6 @@ export interface AnnotateAssetDto { readonly tags?: string[]; } -export interface AssetReplacedDto { - readonly fileHash: string; - readonly fileSize: number; - readonly fileVersion: number; - readonly mimeType: string; - readonly isImage: boolean; - readonly pixelWidth?: number | null; - readonly pixelHeight?: number | null; -} - -export interface AssetUploadedDto extends AssetReplacedDto { - readonly id: string; - readonly fileName: string; - readonly fileType: string; - readonly slug: string; - readonly isDuplicate: boolean; - readonly tags?: string[]; -} - @Injectable() export class AssetsService { constructor( @@ -149,48 +137,21 @@ export class AssetsService { const url = this.apiUrl.buildUrl(`api/apps/${appName}/assets?${fullQuery}`); - return HTTP.getVersioned(this.http, url).pipe( - map(({ payload }) => { - const body = payload.body; + return this.http.get<{ total: number, items: any[] } & Resource>(url).pipe( + map(({ total, items, _links }) => { + const assets = items.map(item => parseAsset(item)); - const items: any[] = body.items; - - const assets = new AssetsDto(body.total, items.map(item => { - const assetUrl = this.apiUrl.buildUrl(`api/assets/${item.id}`); - - return new AssetDto( - item.id, - item.createdBy, - item.lastModifiedBy, - DateTime.parseISO_UTC(item.created), - DateTime.parseISO_UTC(item.lastModified), - item.fileName, - item.fileHash, - item.fileType, - item.fileSize, - item.fileVersion, - item.mimeType, - false, - item.isImage, - item.pixelWidth, - item.pixelHeight, - item.slug, - item.tags || [], - assetUrl, - new Version(item.version.toString())); - })); - - return assets; + return new AssetsDto(total, assets, _links); }), pretifyError('Failed to load assets. Please reload.')); } - public uploadFile(appName: string, file: File): Observable> { + public uploadFile(appName: string, file: File): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/assets`); 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), @@ -200,9 +161,7 @@ export class AssetsService { return percentDone; } else if (Types.is(event, HttpResponse)) { - const response: any = event.body; - - return versioned(new Version(event.headers.get('etag')!), response); + return parseAsset(event.body); } else { throw 'Invalid'; } @@ -225,40 +184,21 @@ 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( - map(({ version, payload }) => { + return HTTP.getVersioned(this.http, url).pipe( + map(({ payload }) => { const body = payload.body; - const assetUrl = this.apiUrl.buildUrl(`api/assets/${body.id}`); - - return new AssetDto( - body.id, - body.createdBy, - body.lastModifiedBy, - DateTime.parseISO_UTC(body.created), - DateTime.parseISO_UTC(body.lastModified), - body.fileName, - body.fileHash, - body.fileType, - body.fileSize, - body.fileVersion, - body.mimeType, - false, - body.isImage, - body.pixelWidth, - body.pixelHeight, - body.slug, - body.tags || [], - assetUrl, - version); + return parseAsset(body); }), pretifyError('Failed to load assets. Please reload.')); } - public replaceFile(appName: string, id: string, file: File, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/assets/${id}/content`); + public replaceFile(appName: string, asset: Resource, file: File, version: Version): Observable { + const link = asset._links['upload']; + + const url = this.apiUrl.buildUrl(link.href); - const req = new HttpRequest('PUT', url, getFormData(file), { headers: new HttpHeaders().set('If-Match', version.value), reportProgress: true }); + const req = new HttpRequest(link.method, url, getFormData(file), { headers: new HttpHeaders().set('If-Match', version.value), reportProgress: true }); return this.http.request(req).pipe( filter(event => @@ -270,9 +210,7 @@ export class AssetsService { return percentDone; } else if (Types.is(event, HttpResponse)) { - const response: any = event.body; - - return versioned(new Version(event.headers.get('etag')!), response); + return parseAsset(event.body); } else { throw 'Invalid'; } @@ -292,22 +230,29 @@ export class AssetsService { pretifyError('Failed to replace asset. Please reload.')); } - public deleteAsset(appName: string, id: string, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/assets/${id}`); + public putAsset(appName: string, asset: Resource, dto: AnnotateAssetDto, version: Version): Observable { + const link = asset._links['update']; - return HTTP.deleteVersioned(this.http, url, version).pipe( + const url = this.apiUrl.buildUrl(link.href); + + return HTTP.requestVersioned(this.http, link.method, url, version, dto).pipe( + map(({ payload }) => { + return parseAsset(payload.body); + }), tap(() => { - this.analytics.trackEvent('Analytics', 'Deleted', appName); + this.analytics.trackEvent('Analytics', 'Updated', appName); }), - pretifyError('Failed to delete asset. Please reload.')); + pretifyError('Failed to update asset. Please reload.')); } - public putAsset(appName: string, id: string, dto: AnnotateAssetDto, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/assets/${id}`); + public deleteAsset(appName: string, asset: Resource, version: Version): Observable> { + const link = asset._links['delete']; + + 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( tap(() => { - this.analytics.trackEvent('Analytics', 'Updated', appName); + this.analytics.trackEvent('Analytics', 'Deleted', appName); }), pretifyError('Failed to delete asset. Please reload.')); } @@ -319,4 +264,23 @@ function getFormData(file: File) { formData.append('file', file); return formData; +} + +function parseAsset(response: any) { + return new AssetDto(response._links, response._meta, + response.id, + DateTime.parseISO_UTC(response.created), response.createdBy, + DateTime.parseISO_UTC(response.lastModified), response.lastModifiedBy, + response.fileName, + response.fileHash, + response.fileType, + response.fileSize, + response.fileVersion, + response.mimeType, + response.isImage, + response.pixelWidth, + response.pixelHeight, + response.slug, + response.tags || [], + new Version(response.version.toString())); } \ No newline at end of file diff --git a/src/Squidex/app/shared/services/auth.service.ts b/src/Squidex/app/shared/services/auth.service.ts index d5d70da60..d168850a4 100644 --- a/src/Squidex/app/shared/services/auth.service.ts +++ b/src/Squidex/app/shared/services/auth.service.ts @@ -16,15 +16,9 @@ import { WebStorageStateStore } from 'oidc-client'; -import { - ApiUrlConfig, - Permission, - Types -} from '@app/framework'; +import { ApiUrlConfig, Types } from '@app/framework'; export class Profile { - public readonly permissions: Permission[]; - public get id(): string { return this.user.profile['sub']; } @@ -56,19 +50,6 @@ export class Profile { constructor( public readonly user: User ) { - const permissions = this.user.profile['urn:squidex:permissions']; - - if (Types.isArrayOfString(permissions)) { - this.permissions = permissions.map(x => new Permission(x)); - } else if (Types.isString(permissions)) { - this.permissions = [new Permission(permissions)]; - } else { - this.permissions = []; - } - - if (this.user.profile['role'] === 'ADMINISTRATOR') { - this.permissions.push( new Permission('squidex.admin')); - } } } diff --git a/src/Squidex/app/shared/services/backups.service.spec.ts b/src/Squidex/app/shared/services/backups.service.spec.ts index f4f51683b..11f7d81fe 100644 --- a/src/Squidex/app/shared/services/backups.service.spec.ts +++ b/src/Squidex/app/shared/services/backups.service.spec.ts @@ -12,8 +12,10 @@ import { AnalyticsService, ApiUrlConfig, BackupDto, + BackupsDto, BackupsService, DateTime, + Resource, RestoreDto } from '@app/shared/internal'; @@ -38,7 +40,7 @@ describe('BackupsService', () => { it('should make get request to get backups', inject([BackupsService, HttpTestingController], (backupsService: BackupsService, httpMock: HttpTestingController) => { - let backups: BackupDto[]; + let backups: BackupsDto; backupsService.getBackups('my-app').subscribe(result => { backups = result; @@ -49,14 +51,15 @@ describe('BackupsService', () => { expect(req.request.method).toEqual('GET'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush([ - { + req.flush({ + items: [{ id: '1', started: '2017-02-03', stopped: '2017-02-04', handledEvents: 13, handledAssets: 17, - status: 'Failed' + status: 'Failed', + _links: {} }, { id: '2', @@ -64,15 +67,16 @@ describe('BackupsService', () => { stopped: null, handledEvents: 23, handledAssets: 27, - status: 'Completed' - } - ]); + status: 'Completed', + _links: {} + }] + }); expect(backups!).toEqual( - [ - new BackupDto('1', DateTime.parseISO_UTC('2017-02-03'), DateTime.parseISO_UTC('2017-02-04'), 13, 17, 'Failed'), - new BackupDto('2', DateTime.parseISO_UTC('2018-02-03'), null, 23, 27, 'Completed') - ]); + new BackupsDto([ + new BackupDto({}, '1', DateTime.parseISO_UTC('2017-02-03'), DateTime.parseISO_UTC('2017-02-04'), 13, 17, 'Failed'), + new BackupDto({}, '2', DateTime.parseISO_UTC('2018-02-03'), null, 23, 27, 'Completed') + ])); })); it('should make get request to get restore', @@ -184,7 +188,13 @@ describe('BackupsService', () => { it('should make delete request to remove language', inject([BackupsService, HttpTestingController], (backupsService: BackupsService, httpMock: HttpTestingController) => { - backupsService.deleteBackup('my-app', '1').subscribe(); + const resource: Resource = { + _links: { + delete: { method: 'DELETE', href: '/api/apps/my-app/backups/1' } + } + }; + + backupsService.deleteBackup('my-app', resource).subscribe(); const req = httpMock.expectOne('http://service/p/api/apps/my-app/backups/1'); diff --git a/src/Squidex/app/shared/services/backups.service.ts b/src/Squidex/app/shared/services/backups.service.ts index b45dea288..492290d84 100644 --- a/src/Squidex/app/shared/services/backups.service.ts +++ b/src/Squidex/app/shared/services/backups.service.ts @@ -14,13 +14,35 @@ import { AnalyticsService, ApiUrlConfig, DateTime, - Model, + hasAnyLink, pretifyError, + Resource, + ResourceLinks, + ResultSet, Types } from '@app/framework'; -export class BackupDto extends Model { +export class BackupsDto extends ResultSet { + public readonly _links: ResourceLinks; + + constructor(items: BackupDto[], links?: {}) { + super(items.length, items); + + this._links = links || {}; + } + + public get canCreate() { + return hasAnyLink(this._links, 'create'); + } +} + +export class BackupDto { + public readonly _links: ResourceLinks; + + public readonly canDelete: boolean; + constructor( + links: ResourceLinks, public readonly id: string, public readonly started: DateTime, public readonly stopped: DateTime | null, @@ -28,11 +50,13 @@ export class BackupDto extends Model { public readonly handledAssets: number, public readonly status: string ) { - super(); + this._links = links; + + this.canDelete = hasAnyLink(links, 'delete'); } } -export class RestoreDto extends Model { +export class RestoreDto { constructor( public readonly url: string, public readonly started: DateTime, @@ -40,7 +64,6 @@ export class RestoreDto extends Model { public readonly status: string, public readonly log: string[] ) { - super(); } } @@ -58,21 +81,14 @@ export class BackupsService { ) { } - public getBackups(appName: string): Observable { + public getBackups(appName: string): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/backups`); - return this.http.get(url).pipe( - map(body => { - const backups = body.map(item => - new BackupDto( - item.id, - DateTime.parseISO_UTC(item.started), - item.stopped ? DateTime.parseISO_UTC(item.stopped) : null, - item.handledEvents, - item.handledAssets, - item.status)); - - return backups; + return this.http.get<{ items: any[], _links: {} } & Resource>(url).pipe( + map(({ items, _links }) => { + const backups = items.map(item => parseBackup(item)); + + return new BackupsDto(backups, _links); }), pretifyError('Failed to load backups.')); } @@ -80,14 +96,9 @@ 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 = new RestoreDto( - body.url, - DateTime.parseISO_UTC(body.started), - body.stopped ? DateTime.parseISO_UTC(body.stopped) : null, - body.status, - body.log); + const restore = parseRestore(body); return restore; }), @@ -121,13 +132,34 @@ export class BackupsService { pretifyError('Failed to start restore.')); } - public deleteBackup(appName: string, id: string): Observable { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/backups/${id}`); + public deleteBackup(appName: string, resource: Resource): Observable { + const link = resource._links['delete']; + + const url = this.apiUrl.buildUrl(link.href); - return this.http.delete(url).pipe( + return this.http.request(link.method, url).pipe( tap(() => { this.analytics.trackEvent('Backup', 'Deleted', appName); }), pretifyError('Failed to delete backup.')); } +} + +function parseRestore(response: any) { + return new RestoreDto( + response.url, + DateTime.parseISO_UTC(response.started), + response.stopped ? DateTime.parseISO_UTC(response.stopped) : null, + response.status, + response.log); +} + +function parseBackup(response: any) { + return new BackupDto(response._links, + response.id, + DateTime.parseISO_UTC(response.started), + response.stopped ? DateTime.parseISO_UTC(response.stopped) : null, + response.handledEvents, + response.handledAssets, + response.status); } \ No newline at end of file diff --git a/src/Squidex/app/shared/services/clients.service.spec.ts b/src/Squidex/app/shared/services/clients.service.spec.ts index 02afa3486..8454db530 100644 --- a/src/Squidex/app/shared/services/clients.service.spec.ts +++ b/src/Squidex/app/shared/services/clients.service.spec.ts @@ -14,7 +14,10 @@ import { ApiUrlConfig, ClientDto, ClientsDto, + ClientsPayload, ClientsService, + Resource, + ResourceLinks, Version } from '@app/shared/internal'; @@ -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', @@ -134,11 +154,11 @@ describe('ClientsService', () => { let accessTokenDto: AccessTokenDto; - clientsService.createToken('my-app', new ClientDto('myClientId', 'myClient', 'mySecret', 'Editor')).subscribe(result => { + clientsService.createToken('my-app', createClient(13)).subscribe(result => { accessTokenDto = result; }); - const body = 'grant_type=client_credentials&scope=squidex-api&client_id=my-app:myClientId&client_secret=mySecret'; + const body = 'grant_type=client_credentials&scope=squidex-api&client_id=my-app:id13&client_secret=secret13'; const req = httpMock.expectOne('http://service/p/identity-server/connect/token'); @@ -149,4 +169,39 @@ describe('ClientsService', () => { expect(accessTokenDto!).toEqual(new AccessTokenDto('token1', 'type1')); })); -}); \ No newline at end of file + + function clientsResponse(...ids: number[]) { + return { + items: ids.map(id => ({ + id: `id${id}`, + name: `Client ${id}`, + role: `Role${id}`, + secret: `secret${id}`, + _links: { + update: { method: 'PUT', href: `/clients/id${id}` } + } + })), + _links: { + create: { method: 'POST', href: '/clients' } + } + }; + } +}); + +export function createClients(...ids: number[]): ClientsPayload { + return { + items: ids.map(id => createClient(id)), + _links: { + create: { method: 'POST', href: '/clients' } + }, + canCreate: true + }; +} + +export function createClient(id: number) { + const links: ResourceLinks = { + update: { method: 'PUT', href: `/clients/id${id}` } + }; + + return new ClientDto(links, `id${id}`, `Client ${id}`, `secret${id}`, `Role${id}`); +} \ 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..8bb895877 100644 --- a/src/Squidex/app/shared/services/clients.service.ts +++ b/src/Squidex/app/shared/services/clients.service.ts @@ -13,24 +13,40 @@ import { map, tap } from 'rxjs/operators'; import { AnalyticsService, ApiUrlConfig, + hasAnyLink, HTTP, mapVersioned, - Model, pretifyError, + Resource, + ResourceLinks, Version, Versioned } from '@app/framework'; -export type ClientsDto = Versioned; +export type ClientsDto = Versioned; +export type ClientsPayload = { + readonly items: ClientDto[]; + + readonly canCreate: boolean; +} & Resource; + +export class ClientDto { + public readonly _links: ResourceLinks; + + public readonly canUpdate: boolean; + public readonly canRevoke: boolean; -export class ClientDto extends Model { constructor( + links: ResourceLinks, public readonly id: string, public readonly name: string, public readonly secret: string, - public readonly role = 'Developer' + public readonly role: string ) { - super(); + this._links = links; + + this.canUpdate = hasAnyLink(links, 'update'); + this.canRevoke = hasAnyLink(links, 'delete'); } } @@ -63,34 +79,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 +99,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']; + + 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(({ body }) => { + return parseClients(body); + }), tap(() => { this.analytics.trackEvent('Client', 'Deleted', appName); }), @@ -135,4 +146,19 @@ export class ClientsService { }), pretifyError('Failed to create token. Please retry.')); } +} + +function parseClients(response: any): ClientsPayload { + const raw: any[] = response.items; + + const items = raw.map(item => + new ClientDto(item._links, + item.id, + item.name || item.id, + item.secret, + item.role)); + + const _links = response._links; + + return { items, _links, canCreate: hasAnyLink(_links, 'create') }; } \ No newline at end of file diff --git a/src/Squidex/app/shared/services/contents.service.spec.ts b/src/Squidex/app/shared/services/contents.service.spec.ts index 5ee15f7fd..7c5e8880b 100644 --- a/src/Squidex/app/shared/services/contents.service.spec.ts +++ b/src/Squidex/app/shared/services/contents.service.spec.ts @@ -15,6 +15,8 @@ import { ContentsDto, ContentsService, DateTime, + Resource, + ResourceLinks, ScheduleDto, Version, Versioned @@ -45,11 +47,11 @@ describe('ContentsService', () => { let contents: ContentsDto; - contentsService.getContents('my-app', 'my-schema', 17, 13, undefined, undefined, 'Archived').subscribe(result => { + contentsService.getContents('my-app', 'my-schema', 17, 13, undefined, undefined, ['Draft', 'Published']).subscribe(result => { contents = result; }); - const req = httpMock.expectOne('http://service/p/api/content/my-app/my-schema?$top=17&$skip=13&status=Archived'); + const req = httpMock.expectOne('http://service/p/api/content/my-app/my-schema?$top=17&$skip=13&status=Draft&status=Published'); expect(req.request.method).toEqual('GET'); expect(req.request.headers.get('If-Match')).toBeNull(); @@ -57,56 +59,17 @@ describe('ContentsService', () => { req.flush({ total: 10, items: [ - { - id: 'id1', - status: 'Published', - created: '2016-12-12T10:10', - createdBy: 'Created1', - lastModified: '2017-12-12T10:10', - lastModifiedBy: 'LastModifiedBy1', - scheduleJob: { - status: 'Draft', - scheduledBy: 'Scheduler1', - dueTime: '2018-12-12T10:10' - }, - isPending: true, - version: 11, - data: {}, - dataDraft: {} - }, - { - id: 'id2', - status: 'Published', - created: '2016-10-12T10:10', - createdBy: 'Created2', - lastModified: '2017-10-12T10:10', - lastModifiedBy: 'LastModifiedBy2', - version: 22, - data: {}, - dataDraft: {} - } - ] + contentResponse(12), + contentResponse(13) + ], + statuses: ['Draft', 'Published'] }); expect(contents!).toEqual( - new ContentsDto(10, [ - new ContentDto('id1', 'Published', - DateTime.parseISO_UTC('2016-12-12T10:10'), 'Created1', - DateTime.parseISO_UTC('2017-12-12T10:10'), 'LastModifiedBy1', - new ScheduleDto('Draft', 'Scheduler1', DateTime.parseISO_UTC('2018-12-12T10:10')), - true, - {}, - {}, - new Version('11')), - new ContentDto('id2', 'Published', - DateTime.parseISO_UTC('2016-10-12T10:10'), 'Created2', - DateTime.parseISO_UTC('2017-10-12T10:10'), 'LastModifiedBy2', - null, - false, - {}, - {}, - new Version('22')) - ])); + new ContentsDto(['Draft', 'Published'], 10, [ + createContent(12), + createContent(13) + ])); })); it('should append query to get request as search', @@ -114,7 +77,7 @@ describe('ContentsService', () => { contentsService.getContents('my-app', 'my-schema', 17, 13, 'my-query').subscribe(); - const req = httpMock.expectOne('http://service/p/api/content/my-app/my-schema?$search="my-query"&$top=17&$skip=13&status=PublishedDraft'); + const req = httpMock.expectOne('http://service/p/api/content/my-app/my-schema?$search="my-query"&$top=17&$skip=13'); expect(req.request.method).toEqual('GET'); expect(req.request.headers.get('If-Match')).toBeNull(); @@ -127,7 +90,7 @@ describe('ContentsService', () => { contentsService.getContents('my-app', 'my-schema', 17, 13, undefined, ['id1', 'id2']).subscribe(); - const req = httpMock.expectOne('http://service/p/api/content/my-app/my-schema?$top=17&$skip=13&ids=id1,id2&status=PublishedDraft'); + const req = httpMock.expectOne('http://service/p/api/content/my-app/my-schema?$top=17&$skip=13&ids=id1,id2'); expect(req.request.method).toEqual('GET'); expect(req.request.headers.get('If-Match')).toBeNull(); @@ -140,7 +103,7 @@ describe('ContentsService', () => { contentsService.getContents('my-app', 'my-schema', 17, 13, '$filter=my-filter').subscribe(); - const req = httpMock.expectOne('http://service/p/api/content/my-app/my-schema?$filter=my-filter&$top=17&$skip=13&status=PublishedDraft'); + const req = httpMock.expectOne('http://service/p/api/content/my-app/my-schema?$filter=my-filter&$top=17&$skip=13'); expect(req.request.method).toEqual('GET'); expect(req.request.headers.get('If-Match')).toBeNull(); @@ -162,36 +125,9 @@ describe('ContentsService', () => { expect(req.request.method).toEqual('GET'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush({ - id: 'id1', - status: 'Published', - created: '2016-12-12T10:10', - createdBy: 'Created1', - lastModified: '2017-12-12T10:10', - lastModifiedBy: 'LastModifiedBy1', - scheduleJob: { - status: 'Draft', - scheduledBy: 'Scheduler1', - dueTime: '2018-12-12T10:10' - }, - isPending: true, - data: {}, - dataDraft: {} - }, { - headers: { - etag: '2' - } - }); + req.flush(contentResponse(12)); - expect(content!).toEqual( - new ContentDto('id1', 'Published', - DateTime.parseISO_UTC('2016-12-12T10:10'), 'Created1', - DateTime.parseISO_UTC('2017-12-12T10:10'), 'LastModifiedBy1', - new ScheduleDto('Draft', 'Scheduler1', DateTime.parseISO_UTC('2018-12-12T10:10')), - true, - {}, - {}, - new Version('2'))); + expect(content!).toEqual(createContent(12)); })); it('should make post request to create content', @@ -210,30 +146,9 @@ describe('ContentsService', () => { expect(req.request.method).toEqual('POST'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush({ - id: 'id1', - status: 'Published', - created: '2016-12-12T10:10', - createdBy: 'Created1', - lastModified: '2017-12-12T10:10', - lastModifiedBy: 'LastModifiedBy1', - isPending: false, - data: {} - }, { - headers: { - etag: '2' - } - }); + req.flush(contentResponse(12)); - expect(content!).toEqual( - new ContentDto('id1', 'Published', - DateTime.parseISO_UTC('2016-12-12T10:10'), 'Created1', - DateTime.parseISO_UTC('2017-12-12T10:10'), 'LastModifiedBy1', - null, - false, - null, - {}, - new Version('2'))); + expect(content!).toEqual(createContent(12)); })); it('should make get request to get versioned content data', @@ -262,14 +177,26 @@ describe('ContentsService', () => { const dto = {}; - contentsService.putContent('my-app', 'my-schema', 'content1', dto, true, version).subscribe(); + const resource: Resource = { + _links: { + update: { method: 'PUT', href: '/api/content/my-app/my-schema/content1?asDraft=true' } + } + }; + + let content: ContentDto; + + contentsService.putContent('my-app', resource, dto, version).subscribe(result => { + content = result; + }); const req = httpMock.expectOne('http://service/p/api/content/my-app/my-schema/content1?asDraft=true'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toBe(version.value); - req.flush({}); + req.flush(contentResponse(12)); + + expect(content!).toEqual(createContent(12)); })); it('should make patch request to update content', @@ -277,61 +204,140 @@ describe('ContentsService', () => { const dto = {}; - contentsService.patchContent('my-app', 'my-schema', 'content1', dto, version).subscribe(); + const resource: Resource = { + _links: { + patch: { method: 'PATCH', href: '/api/content/my-app/my-schema/content1' } + } + }; + + let content: ContentDto; + + contentsService.patchContent('my-app', resource, dto, version).subscribe(result => { + content = result; + }); const req = httpMock.expectOne('http://service/p/api/content/my-app/my-schema/content1'); expect(req.request.method).toEqual('PATCH'); expect(req.request.headers.get('If-Match')).toBe(version.value); - req.flush({}); + req.flush(contentResponse(12)); + + expect(content!).toEqual(createContent(12)); })); - it('should make put request to discard changes', + it('should make put request to discard draft', inject([ContentsService, HttpTestingController], (contentsService: ContentsService, httpMock: HttpTestingController) => { - contentsService.discardChanges('my-app', 'my-schema', 'content1', version).subscribe(); + const resource: Resource = { + _links: { + ['draft/discard']: { method: 'PUT', href: '/api/content/my-app/my-schema/content1/discard' } + } + }; + + let content: ContentDto; + + contentsService.discardDraft('my-app', resource, version).subscribe(result => { + content = result; + }); const req = httpMock.expectOne('http://service/p/api/content/my-app/my-schema/content1/discard'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toBe(version.value); - req.flush({}); + req.flush(contentResponse(12)); + + expect(content!).toEqual(createContent(12)); })); - it('should make put request to change content status', + it('should make put request to propose draft', inject([ContentsService, HttpTestingController], (contentsService: ContentsService, httpMock: HttpTestingController) => { - contentsService.changeContentStatus('my-app', 'my-schema', 'content1', 'publish', null, version).subscribe(); + const dto = {}; - const req = httpMock.expectOne('http://service/p/api/content/my-app/my-schema/content1/publish'); + const resource: Resource = { + _links: { + ['draft/propose']: { method: 'PUT', href: '/api/content/my-app/my-schema/content1/status' } + } + }; + + let content: ContentDto; + + contentsService.proposeDraft('my-app', resource, dto, version).subscribe(result => { + content = result; + }); + + const req = httpMock.expectOne('http://service/p/api/content/my-app/my-schema/content1/status'); expect(req.request.method).toEqual('PUT'); - expect(req.request.headers.get('If-Match')).toEqual(version.value); + expect(req.request.headers.get('If-Match')).toBe(version.value); - req.flush({}); + req.flush(contentResponse(12)); + + expect(content!).toEqual(createContent(12)); })); - it('should make put request with due time when status change is scheduled', + it('should make put request to publish draft', inject([ContentsService, HttpTestingController], (contentsService: ContentsService, httpMock: HttpTestingController) => { - const dueTime = '2016-12-12T10:10:00'; + const resource: Resource = { + _links: { + ['draft/publish']: { method: 'PUT', href: '/api/content/my-app/my-schema/content1/status' } + } + }; - contentsService.changeContentStatus('my-app', 'my-schema', 'content1', 'publish', dueTime, version).subscribe(); + let content: ContentDto; - const req = httpMock.expectOne('http://service/p/api/content/my-app/my-schema/content1/publish?dueTime=2016-12-12T10:10:00'); + contentsService.publishDraft('my-app', resource, null, version).subscribe(result => { + content = result; + }); + + const req = httpMock.expectOne('http://service/p/api/content/my-app/my-schema/content1/status'); + + expect(req.request.method).toEqual('PUT'); + expect(req.request.headers.get('If-Match')).toBe(version.value); + + req.flush(contentResponse(12)); + + expect(content!).toEqual(createContent(12)); + })); + + it('should make put request to change content status', + inject([ContentsService, HttpTestingController], (contentsService: ContentsService, httpMock: HttpTestingController) => { + + const resource: Resource = { + _links: { + ['status/published']: { method: 'PUT', href: '/api/content/my-app/my-schema/content1/status' } + } + }; + + let content: ContentDto; + + contentsService.putStatus('my-app', resource, 'published', '2016-12-12T10:10:00', version).subscribe(result => { + content = result; + }); + + const req = httpMock.expectOne('http://service/p/api/content/my-app/my-schema/content1/status'); expect(req.request.method).toEqual('PUT'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({}); + req.flush(contentResponse(12)); + + expect(content!).toEqual(createContent(12)); })); it('should make delete request to delete content', inject([ContentsService, HttpTestingController], (contentsService: ContentsService, httpMock: HttpTestingController) => { - contentsService.deleteContent('my-app', 'my-schema', 'content1', version).subscribe(); + const resource: Resource = { + _links: { + delete: { method: 'DELETE', href: '/api/content/my-app/my-schema/content1' } + } + }; + + contentsService.deleteContent('my-app', resource, version).subscribe(); const req = httpMock.expectOne('http://service/p/api/content/my-app/my-schema/content1'); @@ -340,4 +346,44 @@ describe('ContentsService', () => { req.flush({}); })); -}); \ No newline at end of file + + function contentResponse(id: number) { + return { + id: `id${id}`, + status: `Status${id}`, + created: `${id % 1000 + 2000}-12-12T10:10:00`, + createdBy: `creator-${id}`, + lastModified: `${id % 1000 + 2000}-11-11T10:10:00`, + lastModifiedBy: `modifier-${id}`, + scheduleJob: { + status: 'Draft', + scheduledBy: `Scheduler${id}`, + dueTime: `${id % 1000 + 2000}-11-11T10:10:00` + }, + isPending: true, + data: {}, + dataDraft: {}, + version: `${id}`, + _links: { + update: { method: 'PUT', href: `/contents/id${id}` } + } + }; + } +}); + +export function createContent(id: number, suffix = '') { + const links: ResourceLinks = { + update: { method: 'PUT', href: `/contents/id${id}` } + }; + + return new ContentDto(links, + `id${id}`, + `Status${id}${suffix}`, + 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 ScheduleDto('Draft', `Scheduler${id}`, DateTime.parseISO_UTC(`${id % 1000 + 2000}-11-11T10:10:00`)), + true, + {}, + {}, + new Version(`${id}`)); +} \ 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..fae6b1927 100644 --- a/src/Squidex/app/shared/services/contents.service.ts +++ b/src/Squidex/app/shared/services/contents.service.ts @@ -14,29 +14,57 @@ import { AnalyticsService, ApiUrlConfig, DateTime, + hasAnyLink, HTTP, mapVersioned, - Model, pretifyError, + Resource, + ResourceLinks, ResultSet, Version, Versioned } from '@app/framework'; -export class ScheduleDto extends Model { +export class ScheduleDto { constructor( public readonly status: string, public readonly scheduledBy: string, public readonly dueTime: DateTime ) { - super(); } } -export class ContentsDto extends ResultSet { } - -export class ContentDto extends Model { +export class ContentsDto extends ResultSet { constructor( + public readonly statuses: string[], + total: number, + items: ContentDto[], + links?: ResourceLinks + ) { + super(total, items, links); + } + + public get canCreate() { + return hasAnyLink(this._links, 'create'); + } + + public get canCreateAndPublish() { + return hasAnyLink(this._links, 'create/publish'); + } +} + +export class ContentDto { + public readonly _links: ResourceLinks; + + public readonly statusUpdates: string[]; + + public readonly canDelete: boolean; + public readonly canDraftDiscard: boolean; + public readonly canDraftPropose: boolean; + public readonly canDraftPublish: boolean; + public readonly canUpdate: boolean; + + constructor(links: ResourceLinks, public readonly id: string, public readonly status: string, public readonly created: DateTime, @@ -49,16 +77,18 @@ export class ContentDto extends Model { public readonly dataDraft: object, public readonly version: Version ) { - super(); - } + this._links = links; + + this.canDelete = hasAnyLink(links, 'delete'); + this.canDraftDiscard = hasAnyLink(links, 'draft/discard'); + this.canDraftPropose = hasAnyLink(links, 'draft/propose'); + this.canDraftPublish = hasAnyLink(links, 'draft/publish'); + this.canUpdate = hasAnyLink(links, 'update'); - public with(value: Partial): ContentDto { - return this.clone(value); + this.statusUpdates = Object.keys(links).filter(x => x.startsWith('status/')).map(x => x.substr(7)); } } -export type ContentQueryStatus = 'Archived' | 'PublishedOnly' | 'PublishedDraft'; - @Injectable() export class ContentsService { constructor( @@ -68,7 +98,7 @@ export class ContentsService { ) { } - public getContents(appName: string, schemaName: string, take: number, skip: number, query?: string, ids?: string[], status: ContentQueryStatus = 'PublishedDraft'): Observable { + public getContents(appName: string, schemaName: string, take: number, skip: number, query?: string, ids?: string[], status?: string[]): Observable { const queryParts: string[] = []; if (query && query.length > 0) { @@ -94,37 +124,20 @@ export class ContentsService { } if (status) { - queryParts.push(`status=${status}`); + for (let s of status) { + queryParts.push(`status=${s}`); + } } const fullQuery = queryParts.join('&'); const url = this.apiUrl.buildUrl(`/api/content/${appName}/${schemaName}?${fullQuery}`); - return HTTP.getVersioned(this.http, url).pipe( - map(({ payload }) => { - const body = payload.body; - - const items: any[] = body.items; - - const contents = new ContentsDto(body.total, items.map(item => - new ContentDto( - item.id, - item.status, - DateTime.parseISO_UTC(item.created), item.createdBy, - DateTime.parseISO_UTC(item.lastModified), item.lastModifiedBy, - item.scheduleJob - ? new ScheduleDto( - item.scheduleJob.status, - item.scheduleJob.scheduledBy, - DateTime.parseISO_UTC(item.scheduleJob.dueTime)) - : null, - item.isPending === true, - item.data, - item.dataDraft, - new Version(item.version.toString())))); - - return contents; + return this.http.get<{ total: number, items: [], statuses: string[] } & Resource>(url).pipe( + map(({ total, items, statuses, _links }) => { + const contents = items.map(x => parseContent(x)); + + return new ContentsDto(statuses, total, contents, _links); }), pretifyError('Failed to load contents. Please reload.')); } @@ -132,27 +145,9 @@ 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( - map(({ version, payload }) => { - const body = payload.body; - - const content = new ContentDto( - body.id, - body.status, - DateTime.parseISO_UTC(body.created), body.createdBy, - DateTime.parseISO_UTC(body.lastModified), body.lastModifiedBy, - body.scheduleJob - ? new ScheduleDto( - body.scheduleJob.status, - body.scheduleJob.scheduledBy, - DateTime.parseISO_UTC(body.scheduleJob.dueTime)) - : null, - body.isPending === true, - body.data, - body.dataDraft, - version); - - return content; + return HTTP.getVersioned(this.http, url).pipe( + map(({ payload }) => { + return parseContent(payload.body); }), pretifyError('Failed to load content. Please reload.')); } @@ -160,7 +155,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,22 +165,9 @@ 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( - map(({ version, payload }) => { - const body = payload.body; - - const content = new ContentDto( - body.id, - body.status, - DateTime.parseISO_UTC(body.created), body.createdBy, - DateTime.parseISO_UTC(body.lastModified), body.lastModifiedBy, - null, - body.isPending, - null, - body.data, - version); - - return content; + return HTTP.postVersioned(this.http, url, dto).pipe( + map(({ payload }) => { + return parseContent(payload.body); }), tap(() => { this.analytics.trackEvent('Content', 'Created', appName); @@ -193,12 +175,14 @@ export class ContentsService { pretifyError('Failed to create content. Please reload.')); } - public putContent(appName: string, schemaName: string, id: string, dto: any, asDraft: boolean, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`/api/content/${appName}/${schemaName}/${id}?asDraft=${asDraft}`); + public putContent(appName: string, resource: Resource, dto: any, version: Version): Observable { + const link = resource._links['update']; + + const url = this.apiUrl.buildUrl(link.href); return HTTP.putVersioned(this.http, url, dto, version).pipe( - mapVersioned(payload => { - return payload.body; + map(({ payload }) => { + return parseContent(payload.body); }), tap(() => { this.analytics.trackEvent('Content', 'Updated', appName); @@ -206,12 +190,14 @@ export class ContentsService { pretifyError('Failed to update content. Please reload.')); } - public patchContent(appName: string, schemaName: string, id: string, dto: any, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`/api/content/${appName}/${schemaName}/${id}`); + public patchContent(appName: string, resource: Resource, dto: any, version: Version): Observable { + const link = resource._links['patch']; - return HTTP.patchVersioned(this.http, url, dto, version).pipe( - mapVersioned(payload => { - return payload.body; + const url = this.apiUrl.buildUrl(link.href); + + return HTTP.requestVersioned(this.http, link.method, url, version, dto).pipe( + map(({ payload }) => { + return parseContent(payload.body); }), tap(() => { this.analytics.trackEvent('Content', 'Updated', appName); @@ -219,37 +205,93 @@ export class ContentsService { pretifyError('Failed to update content. Please reload.')); } - public discardChanges(appName: string, schemaName: string, id: string, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`/api/content/${appName}/${schemaName}/${id}/discard`); + public discardDraft(appName: string, resource: Resource, version: Version): Observable { + const link = resource._links['draft/discard']; - 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 parseContent(payload.body); + }), tap(() => { this.analytics.trackEvent('Content', 'Discarded', appName); }), - pretifyError('Failed to discard changes. Please reload.')); + pretifyError('Failed to discard draft. Please reload.')); } - public deleteContent(appName: string, schemaName: string, id: string, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`/api/content/${appName}/${schemaName}/${id}`); + public proposeDraft(appName: string, resource: Resource, dto: any, version: Version): Observable { + const link = resource._links['draft/propose']; + + const url = this.apiUrl.buildUrl(link.href); - return HTTP.deleteVersioned(this.http, url, version).pipe( + return HTTP.putVersioned(this.http, url, dto, version).pipe( + map(({ payload }) => { + return parseContent(payload.body); + }), tap(() => { - this.analytics.trackEvent('Content', 'Deleted', appName); + this.analytics.trackEvent('Content', 'Updated', appName); }), - pretifyError('Failed to delete content. Please reload.')); + pretifyError('Failed to propose draft. Please reload.')); } - public changeContentStatus(appName: string, schemaName: string, id: string, action: string, dueTime: string | null, version: Version): Observable> { - let url = this.apiUrl.buildUrl(`/api/content/${appName}/${schemaName}/${id}/${action}`); + public publishDraft(appName: string, resource: Resource, dueTime: string | null, version: Version): Observable { + const link = resource._links['draft/publish']; - if (dueTime) { - url += `?dueTime=${dueTime}`; - } + const url = this.apiUrl.buildUrl(link.href); + + return HTTP.requestVersioned(this.http, link.method, url, version, { status: 'Published', dueTime }).pipe( + map(({ payload }) => { + return parseContent(payload.body); + }), + tap(() => { + this.analytics.trackEvent('Content', 'Discarded', appName); + }), + pretifyError('Failed to publish draft. Please reload.')); + } + + public putStatus(appName: string, resource: Resource, status: string, dueTime: string | null, version: Version): Observable { + const link = resource._links[`status/${status}`]; - return HTTP.putVersioned(this.http, url, {}, version).pipe( + const url = this.apiUrl.buildUrl(link.href); + + return HTTP.requestVersioned(this.http, link.method, url, version, { status, dueTime }).pipe( + map(({ payload }) => { + return parseContent(payload.body); + }), tap(() => { this.analytics.trackEvent('Content', 'Archived', appName); }), - pretifyError(`Failed to ${action} content. Please reload.`)); + pretifyError(`Failed to ${status} content. Please reload.`)); } + + public deleteContent(appName: string, resource: Resource, version: Version): Observable> { + const link = resource._links['delete']; + + const url = this.apiUrl.buildUrl(link.href); + + return HTTP.requestVersioned(this.http, link.method, url, version).pipe( + tap(() => { + this.analytics.trackEvent('Content', 'Deleted', appName); + }), + pretifyError('Failed to delete content. Please reload.')); + } +} + +function parseContent(response: any) { + return new ContentDto(response._links, + response.id, + response.status, + DateTime.parseISO_UTC(response.created), response.createdBy, + DateTime.parseISO_UTC(response.lastModified), response.lastModifiedBy, + response.scheduleJob + ? new ScheduleDto( + response.scheduleJob.status, + response.scheduleJob.scheduledBy, + DateTime.parseISO_UTC(response.scheduleJob.dueTime)) + : null, + response.isPending === true, + response.data, + response.dataDraft, + new Version(response.version.toString())); } \ No newline at end of file diff --git a/src/Squidex/app/shared/services/contributors.service.spec.ts b/src/Squidex/app/shared/services/contributors.service.spec.ts index 930f1b9c0..250d4bba0 100644 --- a/src/Squidex/app/shared/services/contributors.service.spec.ts +++ b/src/Squidex/app/shared/services/contributors.service.spec.ts @@ -11,10 +11,12 @@ import { inject, TestBed } from '@angular/core/testing'; import { AnalyticsService, ApiUrlConfig, - ContributorAssignedDto, ContributorDto, ContributorsDto, + ContributorsPayload, ContributorsService, + Resource, + ResourceLinks, Version } from '@app/shared/internal'; @@ -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,81 @@ 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 { + items: 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 { + items: ids.map(id => createContributor(id)), + maxContributors: ids.length * 13, + _links: { + create: { method: 'POST', href: '/contributors' } + }, + _meta: { + isInvited: 'true' + }, + canCreate: true + }; +} + +export function createContributor(id: number) { + const links: ResourceLinks = { + update: { method: 'PUT', href: `/contributors/id${id}` } + }; + + return new ContributorDto(links, `id${id}`, id % 2 === 0 ? 'Owner' : 'Developer'); +} \ 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..a7cdeac72 100644 --- a/src/Squidex/app/shared/services/contributors.service.ts +++ b/src/Squidex/app/shared/services/contributors.service.ts @@ -13,31 +13,41 @@ import { tap } from 'rxjs/operators'; import { AnalyticsService, ApiUrlConfig, + hasAnyLink, HTTP, mapVersioned, - Model, pretifyError, + Resource, + ResourceLinks, Version, Versioned } from '@app/framework'; -export type ContributorsDto = Versioned<{ - readonly contributors: ContributorDto[], - readonly maxContributors: number -}>; +export type ContributorsDto = Versioned; +export type ContributorsPayload = { + readonly items: ContributorDto[]; + + readonly maxContributors: number; + + readonly canCreate: boolean; +} & Resource; + +export class ContributorDto { + public readonly _links: ResourceLinks; + + public readonly canUpdate: boolean; + public readonly canRevoke: boolean; -export class ContributorDto extends Model { constructor( + links: ResourceLinks, public readonly contributorId: string, public readonly role: string ) { - super(); - } -} + this._links = links; -export interface ContributorAssignedDto { - readonly contributorId: string; - readonly isCreated?: boolean; + this.canUpdate = hasAnyLink(links, 'update'); + this.canRevoke = hasAnyLink(links, 'delete'); + } } export interface AssignContributorDto { @@ -58,29 +68,19 @@ export class ContributorsService { public getContributors(appName: string): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/contributors`); - return HTTP.getVersioned(this.http, url).pipe( - 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 HTTP.getVersioned(this.http, url).pipe( + mapVersioned(({ body }) => { + 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; + mapVersioned(({ body }) => { + return parseContributors(body); }), tap(() => { this.analytics.trackEvent('Contributor', 'Configured', appName); @@ -88,13 +88,33 @@ 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.requestVersioned(this.http, link.method, url, version).pipe( + mapVersioned(payload => { + const body = payload.body; - return HTTP.deleteVersioned(this.http, url, version).pipe( + return parseContributors(body); + }), tap(() => { this.analytics.trackEvent('Contributor', 'Deleted', appName); }), pretifyError('Failed to delete contributors. Please reload.')); } +} + +function parseContributors(response: any) { + const raw: any[] = response.items; + + const items = raw.map(item => + new ContributorDto(item._links, + item.contributorId, + item.role)); + + const { maxContributors, _links, _meta } = response; + + return { items, maxContributors, _links, _meta, canCreate: hasAnyLink(_links, 'create') }; } \ No newline at end of file diff --git a/src/Squidex/app/shared/services/patterns.service.spec.ts b/src/Squidex/app/shared/services/patterns.service.spec.ts index 8454db9da..ce6342108 100644 --- a/src/Squidex/app/shared/services/patterns.service.spec.ts +++ b/src/Squidex/app/shared/services/patterns.service.spec.ts @@ -13,7 +13,10 @@ import { ApiUrlConfig, PatternDto, PatternsDto, + PatternsPayload, PatternsService, + Resource, + ResourceLinks, Version } from '@app/shared/internal'; @@ -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,93 @@ 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 => ({ + id: `id${id}`, + name: `Name${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 => createPattern(id)), + _links: { + create: { method: 'POST', href: '/patterns' } + }, + canCreate: true + }; +} + +export function createPattern(id: number) { + const links: ResourceLinks = { + update: { method: 'PUT', href: `/patterns/id${id}` } + }; + + return new PatternDto(links, `id${id}`, `Name${id}`, `Pattern${id}`, `Message${id}`); +} \ 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..7776dcaf0 100644 --- a/src/Squidex/app/shared/services/patterns.service.ts +++ b/src/Squidex/app/shared/services/patterns.service.ts @@ -13,24 +13,42 @@ import { tap } from 'rxjs/operators'; import { AnalyticsService, ApiUrlConfig, + hasAnyLink, HTTP, mapVersioned, - Model, pretifyError, + Resource, + ResourceLinks, Version, Versioned } from '@app/framework'; -export type PatternsDto = Versioned; +export type PatternsDto = Versioned; +export type PatternsPayload = { + readonly items: PatternDto[], + + readonly canCreate: boolean; +} & Resource; + +export class PatternDto { + public readonly _links: ResourceLinks = {}; + + public readonly canDelete: boolean; + public readonly canUpdate: boolean; -export class PatternDto extends Model { constructor( + links: ResourceLinks, public readonly id: string, public readonly name: string, public readonly pattern: string, public readonly message?: string ) { - super(); + this._links = links; + + this.canDelete = hasAnyLink(links, 'delete'); + this.canUpdate = hasAnyLink(links, 'update'); + + Object.freeze(this); } } @@ -52,35 +70,19 @@ 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; - - 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( + 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 +90,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']; + + 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(({ body }) => { + return parsePatterns(body); + }), tap(() => { this.analytics.trackEvent('Patterns', 'Configured', appName); }), pretifyError('Failed to remove pattern. Please reload.')); } +} + +function parsePatterns(response: any) { + const raw: any[] = response.items; + + const items = raw.map(item => + new PatternDto(item._links, + item.id, + item.name, + item.pattern, + item.message)); + + const _links = response._links; + + return { items, _links, canCreate: hasAnyLink(_links, 'create') }; } \ No newline at end of file diff --git a/src/Squidex/app/shared/services/plans.service.ts b/src/Squidex/app/shared/services/plans.service.ts index 1d295fc6c..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(); } } @@ -63,7 +61,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 +91,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.spec.ts b/src/Squidex/app/shared/services/roles.service.spec.ts index 687e9e305..be8d1bd93 100644 --- a/src/Squidex/app/shared/services/roles.service.spec.ts +++ b/src/Squidex/app/shared/services/roles.service.spec.ts @@ -11,8 +11,11 @@ import { inject, TestBed } from '@angular/core/testing'; import { AnalyticsService, ApiUrlConfig, + Resource, + ResourceLinks, RoleDto, RolesDto, + RolesPayload, RolesService, Version } from '@app/shared/internal'; @@ -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,94 @@ 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}`], + isDefaultRole: id % 2 === 0, + _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 => createRole(id)), + _links: { + create: { method: 'POST', href: '/roles' } + }, + canCreate: true + }; +} + +export function createRole(id: number) { + const links: ResourceLinks = { + update: { method: 'PUT', href: `/roles/id${id}` } + }; + + return new RoleDto(links, `name${id}`, id * 2, id * 3, [`permission${id}`], id % 2 === 0); +} \ 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 ac1c27a39..7fa11d194 100644 --- a/src/Squidex/app/shared/services/roles.service.ts +++ b/src/Squidex/app/shared/services/roles.service.ts @@ -13,24 +13,41 @@ import { tap } from 'rxjs/operators'; import { AnalyticsService, ApiUrlConfig, + hasAnyLink, HTTP, mapVersioned, - Model, pretifyError, + Resource, + ResourceLinks, Version, Versioned } from '@app/framework'; -export type RolesDto = Versioned; +export type RolesDto = Versioned; +export type RolesPayload = { + readonly items: RoleDto[]; + + readonly canCreate: boolean; +} & Resource; + +export class RoleDto { + public readonly _links: ResourceLinks; + + public readonly canDelete: boolean; + public readonly canUpdate: boolean; -export class RoleDto extends Model { constructor( + links: ResourceLinks, public readonly name: string, public readonly numClients: number, public readonly numContributors: number, - public readonly permissions: string[] + public readonly permissions: string[], + public readonly isDefaultRole: boolean ) { - super(); + this._links = links; + + this.canDelete = hasAnyLink(links, 'delete'); + this.canUpdate = hasAnyLink(links, 'update'); } } @@ -54,30 +71,19 @@ 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; - - 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; + return HTTP.postVersioned(this.http, url, dto, version).pipe( + mapVersioned(({ body }) => { + return parseRoles(body); }), tap(() => { this.analytics.trackEvent('Role', 'Created', appName); @@ -85,20 +91,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']; - 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 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']; + + 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(({ body }) => { + return parseRoles(body); + }), tap(() => { this.analytics.trackEvent('Role', 'Deleted', appName); }), @@ -111,4 +127,20 @@ export class RolesService { return this.http.get(url).pipe( pretifyError('Failed to load permissions. Please reload.')); } +} + +export function parseRoles(response: any) { + const raw: any[] = response.items; + + const items = raw.map(item => + new RoleDto(item._links, + item.name, + item.numClients, + item.numContributors, + item.permissions, + item.isDefaultRole)); + + const _links = response._links; + + return { items, _links, canCreate: hasAnyLink(_links, 'create') }; } \ No newline at end of file diff --git a/src/Squidex/app/shared/services/rules.service.spec.ts b/src/Squidex/app/shared/services/rules.service.spec.ts index 7cc53c635..99c00490a 100644 --- a/src/Squidex/app/shared/services/rules.service.spec.ts +++ b/src/Squidex/app/shared/services/rules.service.spec.ts @@ -13,16 +13,17 @@ import { AnalyticsService, ApiUrlConfig, DateTime, + Resource, + ResourceLinks, RuleDto, RuleElementDto, RuleElementPropertyDto, RuleEventDto, RuleEventsDto, + RulesDto, RulesService, - Version, - Versioned + Version } from '@app/shared/internal'; -import { RuleCreatedDto } from './rules.service'; describe('RulesService', () => { const version = new Version('1'); @@ -107,7 +108,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 +119,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([ + createRule(12), + createRule(13) + ])); })); it('should make post request to create rule', @@ -179,7 +149,7 @@ describe('RulesService', () => { } }; - let rule: Versioned; + let rule: RuleDto; rulesService.postRule('my-app', dto).subscribe(result => { rule = result; @@ -190,18 +160,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 +181,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'); @@ -281,48 +288,28 @@ describe('RulesService', () => { req.flush({ total: 20, items: [ - { - id: 'id1', - created: '2017-12-12T10:10', - eventName: 'event1', - nextAttempt: '2017-12-12T12:10', - jobResult: 'Failed', - lastDump: 'dump1', - numCalls: 1, - description: 'url1', - result: 'Failed' - }, - { - id: 'id2', - created: '2017-12-13T10:10', - eventName: 'event2', - nextAttempt: '2017-12-13T12:10', - jobResult: 'Failed', - lastDump: 'dump2', - numCalls: 2, - description: 'url2', - result: 'Failed' - } + ruleEventResponse(1), + ruleEventResponse(2) ] }); expect(rules!).toEqual( new RuleEventsDto(20, [ - new RuleEventDto('id1', - DateTime.parseISO_UTC('2017-12-12T10:10'), - DateTime.parseISO_UTC('2017-12-12T12:10'), - 'event1', 'url1', 'dump1', 'Failed', 'Failed', 1), - new RuleEventDto('id2', - DateTime.parseISO_UTC('2017-12-13T10:10'), - DateTime.parseISO_UTC('2017-12-13T12:10'), - 'event2', 'url2', 'dump2', 'Failed', 'Failed', 2) + createRuleEvent(1), + createRuleEvent(2) ])); })); 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 +322,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 +337,87 @@ describe('RulesService', () => { req.flush({}); })); -}); \ No newline at end of file + + function ruleEventResponse(id: number, suffix = '') { + return { + id: `id${id}`, + created: `${id % 1000 + 2000}-12-12T10:10:00`, + eventName: `event${id}${suffix}`, + nextAttempt: `${id % 1000 + 2000}-11-11T10:10`, + jobResult: `Failed${id}${suffix}`, + lastDump: `dump${id}${suffix}`, + numCalls: id, + description: `url${id}${suffix}`, + result: `Failed${id}${suffix}`, + _links: { + update: { method: 'PUT', href: `/rules/events/${id}` } + } + }; + } + + 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 createRuleEvent(id: number, suffix = '') { + const links: ResourceLinks = { + update: { method: 'PUT', href: `/rules/events/${id}` } + }; + + return new RuleEventDto(links, `id${id}`, + DateTime.parseISO_UTC(`${id % 1000 + 2000}-12-12T10:10:00`), + DateTime.parseISO_UTC(`${id % 1000 + 2000}-11-11T10:10:00`), + `event${id}${suffix}`, + `url${id}${suffix}`, + `dump${id}${suffix}`, + `Failed${id}${suffix}`, + `Failed${id}${suffix}`, + id); +} + +export function createRule(id: number, suffix = '') { + const links: ResourceLinks = { + update: { method: 'PUT', href: `/rules/${id}` } + }; + + return new RuleDto(links, + `id${id}`, + 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}`), + 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}`); +} \ 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..5c42f7dec 100644 --- a/src/Squidex/app/shared/services/rules.service.ts +++ b/src/Squidex/app/shared/services/rules.service.ts @@ -14,13 +14,14 @@ import { AnalyticsService, ApiUrlConfig, DateTime, + hasAnyLink, HTTP, - mapVersioned, Model, pretifyError, + Resource, + ResourceLinks, ResultSet, - Version, - Versioned + Version } from '@app/framework'; export const ALL_TRIGGERS = { @@ -74,13 +75,35 @@ export class RuleElementPropertyDto { } } -export class RuleDto extends Model { +export class RulesDto extends ResultSet { + public get canCreate() { + return hasAnyLink(this._links, 'create'); + } + + public get canReadEvents() { + return hasAnyLink(this._links, 'events'); + } + + constructor(items: RuleDto[], links?: {}) { + super(items.length, items, links); + } +} + +export class RuleDto { + public readonly _links: ResourceLinks; + + public readonly canDelete: boolean; + public readonly canDisable: boolean; + public readonly canEnable: boolean; + public readonly canUpdate: boolean; + constructor( + links: ResourceLinks, 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 version: Version, public readonly isEnabled: boolean, public readonly trigger: any, @@ -88,14 +111,26 @@ export class RuleDto extends Model { public readonly action: any, public readonly actionType: string ) { - super(); + this._links = links; + + this.canDelete = hasAnyLink(links, 'delete'); + this.canDisable = hasAnyLink(links, 'disable'); + this.canEnable = hasAnyLink(links, 'enable'); + this.canUpdate = hasAnyLink(links, 'update'); } } -export class RuleEventsDto extends ResultSet { } +export class RuleEventsDto extends ResultSet { + public readonly _links: ResourceLinks; +} export class RuleEventDto extends Model { - constructor( + public readonly _links: ResourceLinks; + + public readonly canDelete: boolean; + public readonly canUpdate: boolean; + + constructor(links: ResourceLinks, public readonly id: string, public readonly created: DateTime, public readonly nextAttempt: DateTime | null, @@ -107,6 +142,11 @@ export class RuleEventDto extends Model { public readonly numCalls: number ) { super(); + + this._links = links; + + this.canDelete = hasAnyLink(links, 'delete'); + this.canUpdate = hasAnyLink(links, 'update'); } } @@ -115,10 +155,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; @@ -134,7 +170,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; @@ -167,77 +203,82 @@ 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; + return this.http.get<{ items: [] } & Resource>(url).pipe( + map(({ items, _links }) => { + const rules = items.map(item => parseRule(item)); - 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; + return new RulesDto(rules, _links); }), 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']; + + 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(({ 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( tap(() => { this.analytics.trackEvent('Rule', 'Deleted', appName); }), @@ -247,14 +288,14 @@ 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; const items: any[] = body.items; const ruleEvents = new RuleEventsDto(body.total, items.map(item => - new RuleEventDto( + new RuleEventDto(item._links, item.id, DateTime.parseISO_UTC(item.created), item.nextAttempt ? DateTime.parseISO_UTC(item.nextAttempt) : null, @@ -270,23 +311,40 @@ 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']; + + const url = this.apiUrl.buildUrl(link.href); - return HTTP.deleteVersioned(this.http, url).pipe( + 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(response: any) { + return new RuleDto(response._links, + response.id, + DateTime.parseISO_UTC(response.created), response.createdBy, + DateTime.parseISO_UTC(response.lastModified), response.lastModifiedBy, + new Version(response.version.toString()), + response.isEnabled, + response.trigger, + response.trigger.triggerType, + response.action, + response.action.actionType); } \ No newline at end of file diff --git a/src/Squidex/app/shared/services/schemas.service.spec.ts b/src/Squidex/app/shared/services/schemas.service.spec.ts index 21e69270d..cec206ce2 100644 --- a/src/Squidex/app/shared/services/schemas.service.spec.ts +++ b/src/Squidex/app/shared/services/schemas.service.spec.ts @@ -13,20 +13,21 @@ import { ApiUrlConfig, createProperties, DateTime, - FieldDto, NestedFieldDto, + Resource, + ResourceLinks, 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 +55,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 +66,26 @@ 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) + ], + _links: { + create: { method: 'POST', href: '/schemas' } + } + }); + + expect(schemas!).toEqual({ + canCreate: true, + items: [ + createSchema(12), + createSchema(13) + ], + _links: { + create: { method: 'POST', href: '/schemas' } + } + }); })); it('should make get request to get schema', @@ -129,200 +102,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 +116,7 @@ describe('SchemasService', () => { const dto = { name: 'name' }; - let schema: Versioned; + let schema: SchemaDetailsDto; schemasService.postSchema('my-app', dto).subscribe(result => { schema = result; @@ -341,20 +127,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 +141,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 +172,30 @@ describe('SchemasService', () => { const dto = {}; - schemasService.putScripts('my-app', 'my-schema', dto, version).subscribe(); + const resource: Resource = { + _links: { + ['update/scripts']: { 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 +203,30 @@ describe('SchemasService', () => { const dto = {}; - schemasService.putCategory('my-app', 'my-schema', dto, version).subscribe(); + const resource: Resource = { + _links: { + ['update/category']: { 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 +234,30 @@ describe('SchemasService', () => { const dto = {}; - schemasService.putPreviewUrls('my-app', 'my-schema', dto, version).subscribe(); + const resource: Resource = { + _links: { + ['update/urls']: { 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 +265,16 @@ describe('SchemasService', () => { const dto = { name: 'name', partitioning: 'invariant', properties: createProperties('Number') }; - let field: FieldDto; + const resource: Resource = { + _links: { + ['fields/add']: { 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,278 +282,319 @@ 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 }); + req.flush(schemaDetailsResponse(12), { + headers: { + etag: '2' + } + }); - expect(field!).toEqual(new NestedFieldDto(123, dto.name, dto.properties, 13)); + expect(schema!).toEqual(createSchemaDetails(12, versionNew)); })); - it('should make put request to update field', + it('should make put request to update field ordering', inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { - const dto = { properties: createProperties('Number') }; + const dto = [1, 2, 3]; - schemasService.putField('my-app', 'my-schema', 1, dto, undefined, version).subscribe(); + const resource: Resource = { + _links: { + ['fields/order']: { method: 'PUT', href: '/api/apps/my-app/schemas/my-schema/fields/ordering' } + } + }; - const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/1'); + let schema: SchemaDetailsDto; - 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({}); - })); - - it('should make put request to update field ordering', - inject([SchemasService, HttpTestingController], (schemasService: SchemasService, httpMock: HttpTestingController) => { - - const dto = [1, 2, 3]; - - schemasService.putFieldOrdering('my-app', 'my-schema', dto, undefined, 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/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 dto = [1, 2, 3]; - - schemasService.putFieldOrdering('my-app', 'my-schema', dto, 13, version).subscribe(); - - const req = httpMock.expectOne('http://service/p/api/apps/my-app/schemas/my-schema/fields/13/nested/ordering'); - - 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 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 +603,262 @@ 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' + }, + _links: {} + }, + { + fieldId: 102, + name: 'field102', + isLocked: true, + isHidden: true, + isDisabled: true, + properties: { + fieldType: 'Number' + }, + _links: {} + } + ], + _links: {} + }, + { + fieldId: 12, + name: 'field12', + isLocked: true, + isHidden: true, + isDisabled: true, + partitioning: 'language', + properties: { + fieldType: 'Assets' + }, + _links: {} + }, + { + fieldId: 13, + name: 'field13', + isLocked: true, + isHidden: true, + isDisabled: true, + partitioning: 'language', + properties: { + fieldType: 'Boolean' + }, + _links: {} + }, + { + fieldId: 14, + name: 'field14', + isLocked: true, + isHidden: true, + isDisabled: true, + partitioning: 'language', + properties: { + fieldType: 'DateTime' + }, + _links: {} + }, + { + fieldId: 15, + name: 'field15', + isLocked: true, + isHidden: true, + isDisabled: true, + partitioning: 'language', + properties: { + fieldType: 'Geolocation' + }, + _links: {} + }, + { + fieldId: 16, + name: 'field16', + isLocked: true, + isHidden: true, + isDisabled: true, + partitioning: 'language', + properties: { + fieldType: 'Json' + }, + _links: {} + }, + { + fieldId: 17, + name: 'field17', + isLocked: true, + isHidden: true, + isDisabled: true, + partitioning: 'language', + properties: { + fieldType: 'Number' + }, + _links: {} + }, + { + fieldId: 18, + name: 'field18', + isLocked: true, + isHidden: true, + isDisabled: true, + partitioning: 'language', + properties: { + fieldType: 'References' + }, + _links: {} + }, + { + fieldId: 19, + name: 'field19', + isLocked: true, + isHidden: true, + isDisabled: true, + partitioning: 'language', + properties: { + fieldType: 'String' + }, + _links: {} + }, + { + fieldId: 20, + name: 'field20', + isLocked: true, + isHidden: true, + isDisabled: true, + partitioning: 'language', + properties: { + fieldType: 'Tags' + }, + _links: {} + } + ], + scripts: { + query: '', + create: '', + change: '', + delete: '', + update: '' + }, + _links: { + update: { method: 'PUT', href: `/schemas/${id}` } + } + }; + } +}); + +export function createSchema(id: number, suffix = '') { + const links: ResourceLinks = { + update: { method: 'PUT', href: `/schemas/${id}` } + }; + + return new SchemaDto(links, + `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}`)); +} + +export function createSchemaDetails(id: number, version: Version, suffix = '') { + const links: ResourceLinks = { + update: { method: 'PUT', href: `/schemas/${id}` } + }; + + return new SchemaDetailsDto(links, + `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' + }); +} \ 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 11172cf8b..d2f6f7517 100644 --- a/src/Squidex/app/shared/services/schemas.service.ts +++ b/src/Squidex/app/shared/services/schemas.service.ts @@ -14,10 +14,11 @@ import { AnalyticsService, ApiUrlConfig, DateTime, + hasAnyLink, HTTP, - mapVersioned, - Model, pretifyError, + Resource, + ResourceLinks, StringHelper, Version, Versioned @@ -25,12 +26,29 @@ import { import { createProperties, FieldPropertiesDto } from './schemas.types'; -export class SchemaDto extends Model { - public get displayName() { - return StringHelper.firstNonEmpty(this.properties.label, this.name); - } +export type SchemasDto = { + readonly items: SchemaDto[]; - constructor( + readonly canCreate: boolean; +} & Resource; + +export class SchemaDto { + public readonly _links: ResourceLinks; + + public readonly canAddField: boolean; + public readonly canDelete: boolean; + public readonly canOrderFields: boolean; + public readonly canPublish: boolean; + public readonly canReadContents: boolean; + public readonly canUnpublish: boolean; + public readonly canUpdate: boolean; + public readonly canUpdateCategory: boolean; + public readonly canUpdateScripts: boolean; + public readonly canUpdateUrls: boolean; + + public readonly displayName: string; + + constructor(links: ResourceLinks, public readonly id: string, public readonly name: string, public readonly category: string, @@ -43,7 +61,20 @@ export class SchemaDto extends Model { public readonly lastModifiedBy: string, public readonly version: Version ) { - super(); + this._links = links; + + this.canAddField = hasAnyLink(links, 'fields/add'); + this.canDelete = hasAnyLink(links, 'delete'); + this.canOrderFields = hasAnyLink(links, 'fields/order'); + this.canPublish = hasAnyLink(links, 'publish'); + this.canReadContents = hasAnyLink(links, 'contents'); + this.canUnpublish = hasAnyLink(links, 'unpublish'); + this.canUpdate = hasAnyLink(links, 'update'); + this.canUpdateCategory = hasAnyLink(links, 'update/category'); + this.canUpdateScripts = hasAnyLink(links, 'update/scripts'); + this.canUpdateUrls = hasAnyLink(links, 'update/urls'); + + this.displayName = StringHelper.firstNonEmpty(this.properties.label, this.name); } } @@ -51,7 +82,7 @@ export class SchemaDetailsDto extends SchemaDto { public listFields: RootFieldDto[]; public listFieldsEditable: RootFieldDto[]; - constructor(id: string, name: string, category: string, + constructor(links: ResourceLinks, id: string, name: string, category: string, properties: SchemaPropertiesDto, isSingleton: boolean, isPublished: boolean, @@ -64,34 +95,38 @@ export class SchemaDetailsDto extends SchemaDto { public readonly scripts = {}, public readonly previewUrls = {} ) { - super(id, name, category, properties, isSingleton, isPublished, created, createdBy, lastModified, lastModifiedBy, version); - - this.onCloned(); - } + super(links, id, name, category, properties, isSingleton, isPublished, created, createdBy, lastModified, lastModifiedBy, version); - protected onCloned() { - if (this.fields) { - let fields = this.fields.filter(x => x.properties.isListField && x.properties.isContentField); + if (fields) { + let listFields = 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 readonly canAddField: boolean; + public readonly canDelete: boolean; + public readonly canDisable: boolean; + public readonly canEnable: boolean; + public readonly canHide: boolean; + public readonly canLock: boolean; + public readonly canOrderFields: boolean; + public readonly canShow: boolean; + public readonly canUpdate: boolean; + public get isInlineEditable(): boolean { return !this.isDisabled && this.properties['inlineEditable'] === true; } @@ -104,7 +139,7 @@ export class FieldDto extends Model { return this.properties.placeholder || ''; } - constructor( + constructor(links: ResourceLinks, public readonly fieldId: number, public readonly name: string, public readonly properties: FieldPropertiesDto, @@ -112,7 +147,17 @@ export class FieldDto extends Model { public readonly isHidden: boolean = false, public readonly isDisabled: boolean = false ) { - super(); + this._links = links; + + this.canAddField = hasAnyLink(links, 'fields/add'); + this.canDelete = hasAnyLink(links, 'delete'); + this.canDisable = hasAnyLink(links, 'disable'); + this.canEnable = hasAnyLink(links, 'enable'); + this.canOrderFields = hasAnyLink(links, 'fields/order'); + this.canHide = hasAnyLink(links, 'hide'); + this.canLock = hasAnyLink(links, 'lock'); + this.canShow = hasAnyLink(links, 'show'); + this.canUpdate = hasAnyLink(links, 'update'); } } @@ -133,36 +178,28 @@ export class RootFieldDto extends FieldDto { return this.isLocalizable && this.isString && (this.properties.editor === 'Input' || this.properties.editor === 'Textarea'); } - constructor(fieldId: number, name: string, properties: FieldPropertiesDto, + constructor(links: ResourceLinks, fieldId: number, name: string, properties: FieldPropertiesDto, public readonly partitioning: string, isLocked: boolean = false, isHidden: boolean = false, isDisabled: boolean = false, public readonly nested: NestedFieldDto[] = [] ) { - super(fieldId, name, properties, isLocked, isHidden, isDisabled); - } - - public with(value: Partial): RootFieldDto { - return this.clone(value); + super(links, fieldId, name, properties, isLocked, isHidden, isDisabled); } } -const NONE_FIELD = new RootFieldDto(-1, '', createProperties('String'), 'invariant'); +const NONE_FIELD = new RootFieldDto({}, -1, '', createProperties('String'), 'invariant'); const NONE_FIELDS = [NONE_FIELD]; export class NestedFieldDto extends FieldDto { - constructor(fieldId: number, name: string, properties: FieldPropertiesDto, + constructor(links: ResourceLinks, fieldId: number, name: string, properties: FieldPropertiesDto, public readonly parentId: number, isLocked: boolean = false, isHidden: boolean = false, isDisabled: boolean = false ) { - super(fieldId, name, properties, isLocked, isHidden, isDisabled); - } - - public with(value: Partial): NestedFieldDto { - return this.clone(value); + super(links, fieldId, name, properties, isLocked, isHidden, isDisabled); } } @@ -176,7 +213,7 @@ export class SchemaPropertiesDto { export interface AddFieldDto { readonly name: string; - readonly partitioning: string; + readonly partitioning?: string; readonly properties: FieldPropertiesDto; } @@ -187,10 +224,6 @@ export interface CreateSchemaDto { readonly isSingleton?: boolean; } -export interface SchemaCreatedDto { - readonly id: string; -} - export interface UpdateSchemaCategoryDto { readonly name?: string; } @@ -213,192 +246,137 @@ 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( + 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; + return parseSchemas(payload.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( + 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!), + return HTTP.postVersioned(this.http, url, dto).pipe( + 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}`); - - return HTTP.deleteVersioned(this.http, url, version).pipe( - tap(() => { - this.analytics.trackEvent('Schema', 'Deleted', appName); - }), - pretifyError('Failed to delete schema. Please reload.')); - } + public putScripts(appName: string, resource: Resource, dto: {}, version: Version): Observable { + const link = resource._links['update/scripts']; - public putScripts(appName: string, schemaName: string, dto: {}, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/schemas/${schemaName}/scripts`); + 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', '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']; - 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(({ 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['update/category']; + + 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['update/urls']; + + 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', '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']; - 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, {}).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']; - 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, {}).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['fields/add']; - 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 +384,210 @@ 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['fields/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, { fieldIds: 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']; - 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(({ 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']; + + 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', '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']; + + 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', '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']; - 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', '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']; + + 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( + 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 parseSchemas(response: any) { + const raw: any[] = response.items; + + const items = raw.map(item => + new SchemaDto(item._links, + 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()))); + + const _links = response._links; + + return { items, _links, canCreate: hasAnyLink(_links, 'create') }; +} + +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._links, + nestedItem.fieldId, + nestedItem.name, + nestedPropertiesDto, + item.fieldId, + nestedItem.isLocked, + nestedItem.isHidden, + nestedItem.isDisabled); + }); + } + + return new RootFieldDto(item._links, + 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 new SchemaDetailsDto(response._links, + 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 || {}); } \ No newline at end of file diff --git a/src/Squidex/app/shared/services/users.service.spec.ts b/src/Squidex/app/shared/services/users.service.spec.ts index f3881dd7a..eff088d1f 100644 --- a/src/Squidex/app/shared/services/users.service.spec.ts +++ b/src/Squidex/app/shared/services/users.service.spec.ts @@ -13,6 +13,7 @@ import { UserDto, UsersService } from '@app/shared/internal'; +import { ResourcesDto } from './users.service'; describe('UsersService', () => { beforeEach(() => { @@ -113,4 +114,31 @@ describe('UsersService', () => { expect(user!).toEqual(new UserDto('123', 'User1')); })); + + it('should make get request to get resources', + inject([UsersService, HttpTestingController], (usersService: UsersService, httpMock: HttpTestingController) => { + + let resources: ResourcesDto; + + usersService.getResources().subscribe(result => { + resources = result; + }); + + const req = httpMock.expectOne('http://service/p/api'); + + expect(req.request.method).toEqual('GET'); + expect(req.request.headers.get('If-Match')).toBeNull(); + + req.flush({ + _links: { + schemas: { method: 'GET', href: '/api/schemas' } + } + }); + + const expected = new ResourcesDto({ + schemas: { method: 'GET', href: '/api/schemas' } + }); + + expect(resources!).toEqual(expected); + })); }); \ No newline at end of file diff --git a/src/Squidex/app/shared/services/users.service.ts b/src/Squidex/app/shared/services/users.service.ts index 4a6462eb1..6f4d4c1da 100644 --- a/src/Squidex/app/shared/services/users.service.ts +++ b/src/Squidex/app/shared/services/users.service.ts @@ -10,7 +10,11 @@ import { Injectable } from '@angular/core'; import { Observable } from 'rxjs'; import { map } from 'rxjs/operators'; -import { ApiUrlConfig, pretifyError } from '@app/framework'; +import { + ApiUrlConfig, + pretifyError, + ResourceLinks +} from '@app/framework'; export class UserDto { constructor( @@ -20,6 +24,14 @@ export class UserDto { } } +export class ResourcesDto { + public readonly _links: ResourceLinks; + + constructor(links: ResourceLinks) { + this._links = links; + } +} + @Injectable() export class UsersService { constructor( @@ -56,4 +68,14 @@ export class UsersService { }), pretifyError('Failed to load user. Please reload.')); } + + public getResources(): Observable { + const url = this.apiUrl.buildUrl(`api`); + + return this.http.get<{ _links: {} }>(url).pipe( + map(({ _links }) => { + return new ResourcesDto(_links); + }), + pretifyError('Failed to load user. Please reload.')); + } } \ No newline at end of file diff --git a/src/Squidex/app/shared/state/_test-helpers.ts b/src/Squidex/app/shared/state/_test-helpers.ts index d6a1c8f62..16ead2cef 100644 --- a/src/Squidex/app/shared/state/_test-helpers.ts +++ b/src/Squidex/app/shared/state/_test-helpers.ts @@ -31,6 +31,9 @@ appsState.setup(x => x.appName) appsState.setup(x => x.selectedApp) .returns(() => of({ name: app })); +appsState.setup(x => x.selectedValidApp) + .returns(() => of({ name: app })); + const authService = Mock.ofType(); authService.setup(x => x.user) diff --git a/src/Squidex/app/shared/state/apps.state.spec.ts b/src/Squidex/app/shared/state/apps.state.spec.ts index aedec3170..68e1c71c8 100644 --- a/src/Squidex/app/shared/state/apps.state.spec.ts +++ b/src/Squidex/app/shared/state/apps.state.spec.ts @@ -12,20 +12,16 @@ import { AppDto, AppsService, AppsState, - DateTime, - DialogService, - Permission + DialogService } from '@app/shared/internal'; -describe('AppsState', () => { - const now = DateTime.now(); +import { createApp } from '../services/apps.service.spec'; - const oldApps = [ - new AppDto('id1', 'old-name1', [new Permission('Owner')], now, now), - new AppDto('id2', 'old-name2', [new Permission('Owner')], now, now) - ]; +describe('AppsState', () => { + const app1 = createApp(1); + const app2 = createApp(2); - const newApp = new AppDto('id3', 'new-name', [new Permission('Owner')], now, now); + const newApp = createApp(3); let dialogs: IMock; let appsService: IMock; @@ -37,7 +33,7 @@ describe('AppsState', () => { appsService = Mock.ofType(); appsService.setup(x => x.getApps()) - .returns(() => of(oldApps)).verifiable(); + .returns(() => of([app1, app2])).verifiable(); appsState = new AppsState(appsService.object, dialogs.object); appsState.load().subscribe(); @@ -48,18 +44,18 @@ describe('AppsState', () => { }); it('should load apps', () => { - expect(appsState.snapshot.apps.values).toEqual(oldApps); + expect(appsState.snapshot.apps.values).toEqual([app1, app2]); }); it('should select app', () => { let selectedApp: AppDto; - appsState.select(oldApps[0].name).subscribe(x => { + appsState.select(app1.name).subscribe(x => { selectedApp = x!; }); - expect(selectedApp!).toBe(oldApps[0]); - expect(appsState.snapshot.selectedApp).toBe(oldApps[0]); + expect(selectedApp!).toBe(app1); + expect(appsState.snapshot.selectedApp).toBe(app1); }); it('should return null on select when unselecting user', () => { @@ -88,46 +84,46 @@ describe('AppsState', () => { const request = { ...newApp }; appsService.setup(x => x.postApp(request)) - .returns(() => of({ ...newApp, permissions: ['Owner'] })).verifiable(); + .returns(() => of(newApp)).verifiable(); - appsState.create(request, now).subscribe(); + appsState.create(request).subscribe(); - expect(appsState.snapshot.apps.values).toEqual([newApp, ...oldApps]); + expect(appsState.snapshot.apps.values).toEqual([app1, app2, newApp]); }); it('should remove app from snapshot when archived', () => { const request = { ...newApp }; appsService.setup(x => x.postApp(request)) - .returns(() => of({ ...newApp, permissions: ['Owner'] })).verifiable(); + .returns(() => of(newApp)).verifiable(); - appsService.setup(x => x.deleteApp(newApp.name)) + appsService.setup(x => x.deleteApp(newApp)) .returns(() => of({})).verifiable(); - appsState.create(request, now).subscribe(); + appsState.create(request).subscribe(); const appsAfterCreate = appsState.snapshot.apps.values; - appsState.delete(newApp.name).subscribe(); + appsState.delete(newApp).subscribe(); const appsAfterDelete = appsState.snapshot.apps.values; - expect(appsAfterCreate).toEqual([newApp, ...oldApps]); - expect(appsAfterDelete).toEqual(oldApps); + expect(appsAfterCreate).toEqual([app1, app2, newApp]); + expect(appsAfterDelete).toEqual([app1, app2]); }); - it('should selected app from snapshot when archived', () => { + it('should remove selected app from snapshot when archived', () => { const request = { ...newApp }; appsService.setup(x => x.postApp(request)) - .returns(() => of({ ...newApp, permissions: ['Owner'] })).verifiable(); + .returns(() => of(newApp)).verifiable(); - appsService.setup(x => x.deleteApp(newApp.name)) + appsService.setup(x => x.deleteApp(newApp)) .returns(() => of({})).verifiable(); - appsState.create(request, now).subscribe(); + appsState.create(request).subscribe(); appsState.select(newApp.name).subscribe(); - appsState.delete(newApp.name).subscribe(); + appsState.delete(newApp).subscribe(); expect(appsState.snapshot.selectedApp).toBeNull(); }); diff --git a/src/Squidex/app/shared/state/apps.state.ts b/src/Squidex/app/shared/state/apps.state.ts index 888a8338f..194c310f2 100644 --- a/src/Squidex/app/shared/state/apps.state.ts +++ b/src/Squidex/app/shared/state/apps.state.ts @@ -7,19 +7,16 @@ import { Injectable } from '@angular/core'; import { Observable, of } from 'rxjs'; -import { distinctUntilChanged, map, tap } from 'rxjs/operators'; +import { distinctUntilChanged, filter, map, tap } from 'rxjs/operators'; import { - DateTime, DialogService, ImmutableArray, - Permission, shareSubscribed, State } from '@app/framework'; import { - AppCreatedDto, AppDto, AppsService, CreateAppDto @@ -43,12 +40,18 @@ export class AppsState extends State { return this.snapshot.selectedApp ? this.snapshot.selectedApp.name : ''; } - public selectedApp = - this.changes.pipe(map(s => s.selectedApp), - distinctUntilChanged(sameApp)); + public get selectedAppState() { + return this.snapshot.selectedApp; + } public apps = - this.changes.pipe(map(s => s.apps), + this.project(s => s.apps); + + public selectedApp = + this.project(s => s.selectedApp, sameApp); + + public selectedValidApp = + this.selectedApp.pipe(filter(x => !!x), map(x => x), distinctUntilChanged()); constructor( @@ -82,9 +85,8 @@ export class AppsState extends State { shareSubscribed(this.dialogs)); } - public create(request: CreateAppDto, now?: DateTime): Observable { + public create(request: CreateAppDto): Observable { return this.appsService.postApp(request).pipe( - map(payload => createApp(request, payload, now)), tap(created => { this.next(s => { const apps = s.apps.push(created).sortByStringAsc(x => x.name); @@ -95,32 +97,21 @@ export class AppsState extends State { shareSubscribed(this.dialogs, { silent: true })); } - public delete(name: string): Observable { - return this.appsService.deleteApp(name).pipe( + public delete(app: AppDto): Observable { + return this.appsService.deleteApp(app).pipe( tap(() => { this.next(s => { - const apps = s.apps.filter(x => x.name !== name); + const apps = s.apps.filter(x => x.name !== app.name); - const selectedApp = s.selectedApp && s.selectedApp.name === name ? null : s.selectedApp; + const selectedApp = + s.selectedApp && + s.selectedApp.name === app.name ? + null : + s.selectedApp; return { ...s, apps, selectedApp }; }); }), shareSubscribed(this.dialogs)); } -} - -function createApp(request: CreateAppDto, response: AppCreatedDto, now?: DateTime) { - now = now || DateTime.now(); - - const app = new AppDto( - response.id, - request.name, - response.permissions.map(x => new Permission(x)), - now, - now, - response.planName, - response.planUpgrade); - - return app; } \ 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 4a20d808e..c3a185314 100644 --- a/src/Squidex/app/shared/state/asset-uploader.state.spec.ts +++ b/src/Squidex/app/shared/state/asset-uploader.state.spec.ts @@ -10,61 +10,35 @@ import { onErrorResumeNext } from 'rxjs/operators'; import { IMock, Mock } from 'typemoq'; import { - ApiUrlConfig, AssetDto, - AssetReplacedDto, AssetsService, AssetUploaderState, DialogService, ofForever, - Types, - Version, - versioned + Types } from '@app/shared/internal'; +import { createAsset } from './../services/assets.service.spec'; + import { TestValues } from './_test-helpers'; -describe('AssetsState', () => { +describe('AssetUploaderState', () => { const { app, - appsState, - authService, - modified, - modifier, - version + appsState } = TestValues; let assetsService: IMock; let dialogs: IMock; let assetUploader: AssetUploaderState; - const asset = new AssetDto('id1', - modifier, - modifier, - modified, - modified, - 'my-asset', - 'my-hash', - 'png', - 100, - 1, - 'image/png', - true, - true, - 800, - 600, - 'my-slug', - [], - 'http://url/api/assets/id1', - version); + const asset = createAsset(1); beforeEach(() => { dialogs = Mock.ofType(); - const apiUrl = new ApiUrlConfig('http://url'); - assetsService = Mock.ofType(); - assetUploader = new AssetUploaderState(appsState.object, apiUrl, assetsService.object, authService.object, dialogs.object); + assetUploader = new AssetUploaderState(appsState.object, assetsService.object, dialogs.object); }); afterEach(() => { @@ -77,7 +51,7 @@ describe('AssetsState', () => { assetsService.setup(x => x.uploadFile(app, file)) .returns(() => never()).verifiable(); - assetUploader.uploadFile(file, undefined, modified).subscribe(); + assetUploader.uploadFile(file).subscribe(); const upload = assetUploader.snapshot.uploads.at(0); @@ -91,7 +65,7 @@ describe('AssetsState', () => { assetsService.setup(x => x.uploadFile(app, file)) .returns(() => ofForever(10, 20)).verifiable(); - assetUploader.uploadFile(file, undefined, modified).subscribe(); + assetUploader.uploadFile(file).subscribe(); const upload = assetUploader.snapshot.uploads.at(0); @@ -105,7 +79,7 @@ describe('AssetsState', () => { assetsService.setup(x => x.uploadFile(app, file)) .returns(() => throwError('Error')).verifiable(); - assetUploader.uploadFile(file, undefined, modified).pipe(onErrorResumeNext()).subscribe(); + assetUploader.uploadFile(file).pipe(onErrorResumeNext()).subscribe(); const upload = assetUploader.snapshot.uploads.at(0); @@ -117,11 +91,11 @@ describe('AssetsState', () => { const file: File = { name: 'my-file' }; assetsService.setup(x => x.uploadFile(app, file)) - .returns(() => of(10, 20, versioned(version, { ...asset }))).verifiable(); + .returns(() => of(10, 20, asset)).verifiable(); let uploadedAsset: AssetDto; - assetUploader.uploadFile(file, undefined, modified).subscribe(dto => { + assetUploader.uploadFile(file).subscribe(dto => { if (Types.is(dto, AssetDto)) { uploadedAsset = dto; } @@ -139,10 +113,10 @@ describe('AssetsState', () => { it('should create initial state when uploading asset', () => { const file: File = { name: 'my-file' }; - assetsService.setup(x => x.replaceFile(app, asset.id, file, asset.version)) + assetsService.setup(x => x.replaceFile(app, asset, file, asset.version)) .returns(() => never()).verifiable(); - assetUploader.uploadAsset(asset, file, modified).subscribe(); + assetUploader.uploadAsset(asset, file).subscribe(); const upload = assetUploader.snapshot.uploads.at(0); @@ -153,10 +127,10 @@ describe('AssetsState', () => { it('should update progress when uploading asset makes progress', () => { const file: File = { name: 'my-file' }; - assetsService.setup(x => x.replaceFile(app, asset.id, file, asset.version)) + assetsService.setup(x => x.replaceFile(app, asset, file, asset.version)) .returns(() => ofForever(10, 20)).verifiable(); - assetUploader.uploadAsset(asset, file, modified).subscribe(); + assetUploader.uploadAsset(asset, file).subscribe(); const upload = assetUploader.snapshot.uploads.at(0); @@ -167,10 +141,10 @@ describe('AssetsState', () => { it('should update status when uploading asset failed', () => { const file: File = { name: 'my-file' }; - assetsService.setup(x => x.replaceFile(app, asset.id, file, asset.version)) + assetsService.setup(x => x.replaceFile(app, asset, file, asset.version)) .returns(() => throwError('Error')).verifiable(); - assetUploader.uploadAsset(asset, file, modified).pipe(onErrorResumeNext()).subscribe(); + assetUploader.uploadAsset(asset, file).pipe(onErrorResumeNext()).subscribe(); const upload = assetUploader.snapshot.uploads.at(0); @@ -181,25 +155,14 @@ describe('AssetsState', () => { it('should update status when uploading asset completes', () => { const file: File = { name: 'my-file' }; - let update: AssetReplacedDto = { - isImage: true, - mimeType: 'image/jpeg', - pixelWidth: 800, - pixelHeight: 600, - fileHash: 'my-hash2', - fileSize: 200, - fileVersion: 2 - }; - - const newVersion = new Version('2'); - const newAsset = asset.update(update, modifier, newVersion, modified); + let updated = createAsset(1, undefined, '_new'); - assetsService.setup(x => x.replaceFile(app, asset.id, file, asset.version)) - .returns(() => of(10, 20, versioned(newVersion, update))).verifiable(); + assetsService.setup(x => x.replaceFile(app, asset, file, asset.version)) + .returns(() => of(10, 20, updated)).verifiable(); let uploadedAsset: AssetDto; - assetUploader.uploadAsset(asset, file, modified).subscribe(dto => { + assetUploader.uploadAsset(asset, file).subscribe(dto => { if (Types.is(dto, AssetDto)) { uploadedAsset = dto; } @@ -209,6 +172,6 @@ describe('AssetsState', () => { expect(upload.status).toBe('Completed'); expect(upload.progress).toBe(100); - expect(uploadedAsset!).toEqual(newAsset); + expect(uploadedAsset!).toEqual(updated); }); }); \ No newline at end of file diff --git a/src/Squidex/app/shared/state/asset-uploader.state.ts b/src/Squidex/app/shared/state/asset-uploader.state.ts index 3f393df34..4b16ade66 100644 --- a/src/Squidex/app/shared/state/asset-uploader.state.ts +++ b/src/Squidex/app/shared/state/asset-uploader.state.ts @@ -7,21 +7,17 @@ import { Injectable } from '@angular/core'; import { Observable, Subject } from 'rxjs'; -import { distinctUntilChanged, map, publishReplay, refCount, takeUntil } from 'rxjs/operators'; +import { map, publishReplay, refCount, takeUntil } from 'rxjs/operators'; import { - ApiUrlConfig, - DateTime, DialogService, ImmutableArray, MathHelper, State, - Types, - Versioned + Types } from '@app/framework'; -import { AssetDto, AssetsService, AssetUploadedDto } from './../services/assets.service'; -import { AuthService } from './../services/auth.service'; +import { AssetDto, AssetsService } from './../services/assets.service'; import { AppsState } from './apps.state'; import { AssetsState } from './assets.state'; @@ -55,14 +51,11 @@ type UploadResult = AssetDto | number; @Injectable() export class AssetUploaderState extends State { public uploads = - this.changes.pipe(map(x => x.uploads), - distinctUntilChanged()); + this.project(x => x.uploads); constructor( private readonly appsState: AppsState, - private readonly apiUrl: ApiUrlConfig, private readonly assetsService: AssetsService, - private readonly authService: AuthService, private readonly dialogs: DialogService ) { super({ uploads: ImmutableArray.empty() }); @@ -78,12 +71,10 @@ export class AssetUploaderState extends State { }); } - public uploadFile(file: File, target?: AssetsState, now?: DateTime): Observable { + public uploadFile(file: File, target?: AssetsState): Observable { const stream = this.assetsService.uploadFile(this.appName, file); - return this.upload(stream, MathHelper.guid(), file, response => { - const asset = createAsset(response, this.apiUrl, this.user, now); - + return this.upload(stream, MathHelper.guid(), file, asset => { if (asset.isDuplicate) { this.dialogs.notifyError('Asset has already been uploaded.'); } else if (target) { @@ -94,17 +85,13 @@ export class AssetUploaderState extends State { }); } - public uploadAsset(asset: AssetDto, file: File, now?: DateTime): Observable { - const stream = this.assetsService.replaceFile(this.appName, asset.id, file, asset.version); - - return this.upload(stream, asset.id, file, ({ version, payload }) => { - const newAsset = asset.update(payload, this.user, version, now); + public uploadAsset(asset: AssetDto, file: File): Observable { + const stream = this.assetsService.replaceFile(this.appName, asset, file, asset.version); - return newAsset; - }); + return this.upload(stream, asset.id, file); } - private upload(source: Observable, id: string, file: File, complete: ((completion: T) => AssetDto)) { + private upload(source: Observable, id: string, file: File, complete?: ((completion: AssetDto) => AssetDto)) { let upload = { id, name: file.name, progress: 1, status: 'Running', cancel: new Subject() }; this.addUpload(upload); @@ -114,7 +101,11 @@ export class AssetUploaderState extends State { if (Types.isNumber(event)) { return event; } else { - return complete(event); + if (complete) { + return complete(event); + } else { + return event; + } } }), publishReplay(), refCount()); @@ -170,37 +161,4 @@ export class AssetUploaderState extends State { private get appName() { return this.appsState.appName; } - - private get user() { - return this.authService.user!.token; - } -} - -function createAsset({ payload, version }: Versioned, apiUrl: ApiUrlConfig, user: string, now?: DateTime) { - const assetUrl = apiUrl.buildUrl(`api/assets/${payload.id}`); - - now = now || DateTime.now(); - - const asset = new AssetDto( - payload.id, - user, - user, - now, - now, - payload.fileName, - payload.fileHash, - payload.fileType, - payload.fileSize, - payload.fileVersion, - payload.mimeType, - payload.isDuplicate, - payload.isImage, - payload.pixelWidth, - payload.pixelHeight, - payload.slug, - payload.tags || [], - assetUrl, - version); - - return asset; } \ No newline at end of file diff --git a/src/Squidex/app/shared/state/assets.state.spec.ts b/src/Squidex/app/shared/state/assets.state.spec.ts index 17f604219..f8df2c6d7 100644 --- a/src/Squidex/app/shared/state/assets.state.spec.ts +++ b/src/Squidex/app/shared/state/assets.state.spec.ts @@ -9,7 +9,6 @@ import { of } from 'rxjs'; import { IMock, It, Mock, Times } from 'typemoq'; import { - AssetDto, AssetsDto, AssetsService, AssetsState, @@ -17,26 +16,22 @@ import { versioned } from '@app/shared/internal'; +import { createAsset } from './../services/assets.service.spec'; + import { TestValues } from './_test-helpers'; describe('AssetsState', () => { const { app, appsState, - creation, - creator, - modified, - modifier, newVersion, version } = TestValues; - const oldAssets = [ - new AssetDto('id1', creator, creator, creation, creation, 'name1', 'hash1', 'type1', 1, 1, 'mime1', false, false, null, null, 'slug1', ['tag1', 'shared'], 'url1', version), - new AssetDto('id2', creator, creator, creation, creation, 'name2', 'hash2', 'type2', 2, 2, 'mime2', false, false, null, null, 'slug2', ['tag2', 'shared'], 'url2', version) - ]; + const asset1 = createAsset(1, ['tag1', 'shared']); + const asset2 = createAsset(2, ['tag2', 'shared']); - const newAsset = new AssetDto('id1', modifier, modifier, modified, modified, 'name3', 'hash3', 'type3', 3, 3, 'mime3', false, true, 0, 0, 'slug3', ['new'], 'url3', version); + const newAsset = createAsset(3, ['new']); let dialogs: IMock; let assetsService: IMock; @@ -46,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); }); @@ -55,15 +53,12 @@ describe('AssetsState', () => { describe('Loading', () => { it('should load assets', () => { - assetsService.setup(x => x.getAssets(app, 30, 0, undefined, [])) - .returns(() => of(new AssetsDto(200, oldAssets))).verifiable(); - - 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().subscribe(); - expect(assetsState.snapshot.assets.values).toEqual(oldAssets); + expect(assetsState.snapshot.assets.values).toEqual([asset1, asset2]); expect(assetsState.snapshot.assetsPager.numberOfItems).toEqual(200); expect(assetsState.snapshot.isLoaded).toBeTruthy(); @@ -71,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, oldAssets))); - - 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(); @@ -85,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(); @@ -107,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(); @@ -116,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(); @@ -125,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(); @@ -135,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(); @@ -146,11 +142,8 @@ describe('AssetsState', () => { describe('Updates', () => { beforeEach(() => { - assetsService.setup(x => x.getAssets(app, 30, 0, undefined, [])) - .returns(() => of(new AssetsDto(200, oldAssets))).verifiable(); - - 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(); }); @@ -158,7 +151,7 @@ describe('AssetsState', () => { it('should add asset to snapshot when created', () => { assetsState.add(newAsset); - expect(assetsState.snapshot.assets.values).toEqual([newAsset, ...oldAssets]); + expect(assetsState.snapshot.assets.values).toEqual([newAsset, asset1, asset2]); expect(assetsState.snapshot.assetsPager.numberOfItems).toBe(201); }); @@ -169,20 +162,22 @@ describe('AssetsState', () => { expect(assetsState.snapshot.tags).toEqual({ tag1: 1, tag2: 1, shared: 2, new: 2 }); }); - it('should update properties when updated', () => { - assetsState.update(newAsset); + it('should update asset when updated', () => { + const update = createAsset(1, ['new'], '_new'); + + assetsState.update(update); - const asset_1 = assetsState.snapshot.assets.at(0); + const newAsset1 = assetsState.snapshot.assets.at(0); - expect(asset_1).toBe(newAsset); + expect(newAsset1).toEqual(update); expect(assetsState.snapshot.tags).toEqual({ tag2: 1, shared: 1, new: 1 }); }); it('should remove asset from snapshot when deleted', () => { - assetsService.setup(x => x.deleteAsset(app, oldAssets[0].id, version)) + assetsService.setup(x => x.deleteAsset(app, asset1, version)) .returns(() => of(versioned(newVersion))); - assetsState.delete(oldAssets[0]).subscribe(); + assetsState.delete(asset1).subscribe(); expect(assetsState.snapshot.assets.values.length).toBe(1); expect(assetsState.snapshot.assetsPager.numberOfItems).toBe(199); diff --git a/src/Squidex/app/shared/state/assets.state.ts b/src/Squidex/app/shared/state/assets.state.ts index 66d726c6b..09eeabc0a 100644 --- a/src/Squidex/app/shared/state/assets.state.ts +++ b/src/Squidex/app/shared/state/assets.state.ts @@ -7,9 +7,10 @@ import { Injectable } from '@angular/core'; import { combineLatest, Observable } from 'rxjs'; -import { distinctUntilChanged, map, tap } from 'rxjs/operators'; +import { tap } from 'rxjs/operators'; import { + compareStringsAsc, DialogService, ImmutableArray, Pager, @@ -38,37 +39,36 @@ interface Snapshot { // Indicates if the assets are loaded. isLoaded?: boolean; + + // Indicates if the user can create assets. + canCreate?: boolean; } @Injectable() export class AssetsState extends State { public tags = - this.changes.pipe(map(x => x.tags), - distinctUntilChanged(), map(x => sort(x))); + this.project2(x => x.tags, x => sort(x)); public tagsNames = - this.tags.pipe( - distinctUntilChanged(), map(x => x.map(t => t.name))); + this.project2(x => x.tags, x => Object.keys(x)); public selectedTagNames = - this.changes.pipe( - distinctUntilChanged(), map(x => Object.keys(x.tagsSelected))); + this.project2(x => x.tagsSelected, x => Object.keys(x)); public assets = - this.changes.pipe(map(x => x.assets), - distinctUntilChanged()); + this.project(x => x.assets); public assetsQuery = - this.changes.pipe(map(x => x.assetsQuery), - distinctUntilChanged()); + this.project(x => x.assetsQuery); public assetsPager = - this.changes.pipe(map(x => x.assetsPager), - distinctUntilChanged()); + this.project(x => x.assetsPager); public isLoaded = - this.changes.pipe(map(x => !!x.isLoaded), - distinctUntilChanged()); + this.project(x => !!x.isLoaded); + + public canCreate = + this.project(x => !!x.canCreate); constructor( private readonly appsState: AppsState, @@ -95,7 +95,7 @@ export class AssetsState extends State { Object.keys(this.snapshot.tagsSelected)), this.assetsService.getTags(this.appName) ).pipe( - tap(([ { items, total }, tags ]) => { + tap(([ { items, total, canCreate }, tags ]) => { if (isReload) { this.dialogs.notifyInfo('Assets reloaded.'); } @@ -104,7 +104,7 @@ export class AssetsState extends State { const assets = ImmutableArray.of(items); const assetsPager = s.assetsPager.setCount(total); - return { ...s, assets, assetsPager, isLoaded: true, tags }; + return { ...s, assets, assetsPager, isLoaded: true, tags, canCreate }; }); }), shareSubscribed(this.dialogs)); @@ -124,7 +124,7 @@ export class AssetsState extends State { } public delete(asset: AssetDto): Observable { - return this.assetsService.deleteAsset(this.appName, asset.id, asset.version).pipe( + return this.assetsService.deleteAsset(this.appName, asset, asset.version).pipe( tap(() => { return this.next(s => { const assets = s.assets.filter(x => x.id !== asset.id); @@ -251,17 +251,7 @@ function removeTags(previous: AssetDto, tags: { [x: string]: number; }, tagsSele } function sort(tags: { [name: string]: number }) { - return Object.keys(tags).sort((a, b) => { - if (a < b) { - return -1; - } - if (a > b) { - return 1; - } - return 0; - }).map(key => { - return { name: key, count: tags[key] }; - }); + return Object.keys(tags).sort(compareStringsAsc).map(name => ({ name, count: tags[name] })); } @Injectable() diff --git a/src/Squidex/app/shared/state/backups.state.spec.ts b/src/Squidex/app/shared/state/backups.state.spec.ts index db6bcfccd..948589f35 100644 --- a/src/Squidex/app/shared/state/backups.state.spec.ts +++ b/src/Squidex/app/shared/state/backups.state.spec.ts @@ -11,6 +11,7 @@ import { IMock, It, Mock, Times } from 'typemoq'; import { BackupDto, + BackupsDto, BackupsService, BackupsState, DateTime, @@ -25,10 +26,8 @@ describe('BackupsState', () => { appsState } = TestValues; - const oldBackups = [ - new BackupDto('id1', DateTime.now(), null, 1, 1, 'Started'), - new BackupDto('id2', DateTime.now(), null, 2, 2, 'Started') - ]; + const backup1 = new BackupDto({}, 'id1', DateTime.now(), null, 1, 1, 'Started'); + const backup2 = new BackupDto({}, 'id2', DateTime.now(), null, 2, 2, 'Started'); let dialogs: IMock; let backupsService: IMock; @@ -48,11 +47,11 @@ describe('BackupsState', () => { describe('Loading', () => { it('should load backups', () => { backupsService.setup(x => x.getBackups(app)) - .returns(() => of(oldBackups)).verifiable(); + .returns(() => of(new BackupsDto([backup1, backup2]))).verifiable(); backupsState.load().subscribe(); - expect(backupsState.snapshot.backups.values).toEqual(oldBackups); + expect(backupsState.snapshot.backups.values).toEqual([backup1, backup2]); expect(backupsState.snapshot.isLoaded).toBeTruthy(); dialogs.verify(x => x.notifyInfo(It.isAnyString()), Times.never()); @@ -60,7 +59,7 @@ describe('BackupsState', () => { it('should show notification on load when reload is true', () => { backupsService.setup(x => x.getBackups(app)) - .returns(() => of(oldBackups)).verifiable(); + .returns(() => of(new BackupsDto([backup1, backup2]))).verifiable(); backupsState.load(true, false).subscribe(); @@ -95,7 +94,7 @@ describe('BackupsState', () => { describe('Updates', () => { beforeEach(() => { backupsService.setup(x => x.getBackups(app)) - .returns(() => of(oldBackups)).verifiable(); + .returns(() => of(new BackupsDto([backup1, backup2]))).verifiable(); backupsState.load().subscribe(); }); @@ -112,10 +111,10 @@ describe('BackupsState', () => { }); it('should not remove backup from snapshot', () => { - backupsService.setup(x => x.deleteBackup(app, oldBackups[0].id)) + backupsService.setup(x => x.deleteBackup(app, backup1)) .returns(() => of({})).verifiable(); - backupsState.delete(oldBackups[0]).subscribe(); + backupsState.delete(backup1).subscribe(); expect(backupsState.snapshot.backups.length).toBe(2); diff --git a/src/Squidex/app/shared/state/backups.state.ts b/src/Squidex/app/shared/state/backups.state.ts index 3d0644413..a74e5ac6a 100644 --- a/src/Squidex/app/shared/state/backups.state.ts +++ b/src/Squidex/app/shared/state/backups.state.ts @@ -7,7 +7,7 @@ import { Injectable } from '@angular/core'; import { Observable } from 'rxjs'; -import { distinctUntilChanged, map, tap } from 'rxjs/operators'; +import { tap } from 'rxjs/operators'; import { DialogService, @@ -26,6 +26,9 @@ interface Snapshot { // Indicates if the backups are loaded. isLoaded?: boolean; + + // Indicates if the user can create new backups. + canCreate?: boolean; } type BackupsList = ImmutableArray; @@ -33,16 +36,16 @@ type BackupsList = ImmutableArray; @Injectable() export class BackupsState extends State { public backups = - this.changes.pipe(map(x => x.backups), - distinctUntilChanged()); + this.project(x => x.backups); public maxBackupsReached = - this.changes.pipe(map(x => x.backups.length >= 10), - distinctUntilChanged()); + this.project(x => x.backups.length >= 10); public isLoaded = - this.changes.pipe(map(x => !!x.isLoaded), - distinctUntilChanged()); + this.project(x => !!x.isLoaded); + + public canCreate = + this.project(x => !!x.canCreate); constructor( private readonly appsState: AppsState, @@ -58,15 +61,15 @@ export class BackupsState extends State { } return this.backupsService.getBackups(this.appName).pipe( - tap(items => { + tap(({ items, canCreate }) => { if (isReload && !silent) { this.dialogs.notifyInfo('Backups reloaded.'); } + const backups = ImmutableArray.of(items); this.next(s => { - const backups = ImmutableArray.of(items); - return { ...s, backups, isLoaded: true }; + return { ...s, backups, isLoaded: true, canCreate }; }); }), shareSubscribed(this.dialogs, { silent })); @@ -81,7 +84,7 @@ export class BackupsState extends State { } public delete(backup: BackupDto): Observable { - return this.backupsService.deleteBackup(this.appsState.appName, backup.id).pipe( + return this.backupsService.deleteBackup(this.appsState.appName, backup).pipe( tap(() => { this.dialogs.notifyInfo('Backup is about to be deleted.'); }), diff --git a/src/Squidex/app/shared/state/clients.state.spec.ts b/src/Squidex/app/shared/state/clients.state.spec.ts index 3199673cb..ef3b902d2 100644 --- a/src/Squidex/app/shared/state/clients.state.spec.ts +++ b/src/Squidex/app/shared/state/clients.state.spec.ts @@ -9,13 +9,15 @@ import { of } from 'rxjs'; import { IMock, It, Mock, Times } from 'typemoq'; import { - ClientDto, + ClientsPayload, ClientsService, ClientsState, DialogService, versioned } from '@app/shared/internal'; +import { createClients } from '../services/clients.service.spec'; + import { TestValues } from './_test-helpers'; describe('ClientsState', () => { @@ -26,10 +28,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 +52,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,58 +79,60 @@ 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.version).toEqual(newVersion); + expectNewClients(updated); }); - it('should update properties when role updated', () => { - const request = { role: 'Owner' }; + it('should update clients when role updated', () => { + const updated = createClients(1, 2, 3); - clientsService.setup(x => x.putClient(app, oldClients[0].id, request, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + const request = { role: 'Owner' }; - clientsState.update(oldClients[0], request).subscribe(); + clientsService.setup(x => x.putClient(app, oldClients.items[0], request, version)) + .returns(() => of(versioned(newVersion, updated))).verifiable(); - const client_1 = clientsState.snapshot.clients.at(0); + clientsState.update(oldClients.items[0], request).subscribe(); - expect(client_1.name).toBe('name1'); - expect(client_1.role).toBe('Owner'); - expect(clientsState.snapshot.version).toEqual(newVersion); + expectNewClients(updated); }); - it('should update properties when name updated', () => { - const request = { name: 'NewName' }; + it('should update clients when name updated', () => { + const updated = createClients(1, 2, 3); - clientsService.setup(x => x.putClient(app, oldClients[0].id, request, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + const request = { name: 'NewName' }; - clientsState.update(oldClients[0], request).subscribe(); + clientsService.setup(x => x.putClient(app, oldClients.items[0], request, version)) + .returns(() => of(versioned(newVersion, updated))).verifiable(); - const client_1 = clientsState.snapshot.clients.at(0); + clientsState.update(oldClients.items[0], request).subscribe(); - expect(client_1.name).toBe('NewName'); - expect(client_1.role).toBe('Developer'); - expect(clientsState.snapshot.version).toEqual(newVersion); + expectNewClients(updated); }); - it('should remove client from snapshot when revoked', () => { - clientsService.setup(x => x.deleteClient(app, oldClients[0].id, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + it('should update clients when client revoked', () => { + const updated = createClients(1, 2, 3); - clientsState.revoke(oldClients[0]).subscribe(); + clientsService.setup(x => x.deleteClient(app, oldClients.items[0], version)) + .returns(() => of(versioned(newVersion, updated))).verifiable(); - expect(clientsState.snapshot.clients.values).toEqual([oldClients[1]]); - expect(clientsState.snapshot.version).toEqual(newVersion); + 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 9eeb90603..377e845d3 100644 --- a/src/Squidex/app/shared/state/clients.state.ts +++ b/src/Squidex/app/shared/state/clients.state.ts @@ -9,13 +9,11 @@ import { Injectable } from '@angular/core'; import { Observable } from 'rxjs'; -import { distinctUntilChanged, map, tap } from 'rxjs/operators'; +import { tap } from 'rxjs/operators'; import { DialogService, ImmutableArray, - mapVersioned, - shareMapSubscribed, shareSubscribed, State, Version @@ -25,6 +23,7 @@ import { AppsState } from './apps.state'; import { ClientDto, + ClientsPayload, ClientsService, CreateClientDto, UpdateClientDto @@ -39,6 +38,9 @@ interface Snapshot { // Indicates if the clients are loaded. isLoaded?: boolean; + + // Indicates if the user can create new clients. + canCreate?: boolean; } type ClientsList = ImmutableArray; @@ -46,19 +48,20 @@ type ClientsList = ImmutableArray; @Injectable() export class ClientsState extends State { public clients = - this.changes.pipe(map(x => x.clients), - distinctUntilChanged()); + this.project(x => x.clients); public isLoaded = - this.changes.pipe(map(x => !!x.isLoaded), - distinctUntilChanged()); + this.project(x => !!x.isLoaded); + + public canCreate = + this.project(x => !!x.canCreate); 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: Version.EMPTY }); } public load(isReload = false): Observable { @@ -72,50 +75,43 @@ 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 { canCreate, items } = payload; + + const clients = ImmutableArray.of(items); + + this.next(s => { + return { ...s, clients, isLoaded: true, version, canCreate }; + }); } private get appName() { @@ -125,7 +121,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/comments.state.ts b/src/Squidex/app/shared/state/comments.state.ts index 42bc497c5..d18940012 100644 --- a/src/Squidex/app/shared/state/comments.state.ts +++ b/src/Squidex/app/shared/state/comments.state.ts @@ -6,7 +6,7 @@ */ import { Observable } from 'rxjs'; -import { distinctUntilChanged, map, tap } from 'rxjs/operators'; +import { map, tap } from 'rxjs/operators'; import { DateTime, @@ -35,12 +35,10 @@ type CommentsList = ImmutableArray; export class CommentsState extends State { public comments = - this.changes.pipe(map(x => x.comments), - distinctUntilChanged()); + this.project(x => x.comments); public isLoaded = - this.changes.pipe(map(x => !!x.isLoaded), - distinctUntilChanged()); + this.project(x => !!x.isLoaded); constructor( private readonly appsState: AppsState, diff --git a/src/Squidex/app/shared/state/contents.forms.spec.ts b/src/Squidex/app/shared/state/contents.forms.spec.ts index aba250b7a..935b47266 100644 --- a/src/Squidex/app/shared/state/contents.forms.spec.ts +++ b/src/Squidex/app/shared/state/contents.forms.spec.ts @@ -370,9 +370,9 @@ describe('StringField', () => { }); function createSchema(properties: SchemaPropertiesDto, index = 1, fields: RootFieldDto[]) { - return new SchemaDetailsDto('id' + index, 'schema' + index, '', properties, false, true, null!, null!, null!, null!, null!, fields); + return new SchemaDetailsDto({}, 'id' + index, 'schema' + index, '', properties, false, true, null!, null!, null!, null!, null!, fields); } function createField(properties: FieldPropertiesDto, index = 1, partitioning = 'languages') { - return new RootFieldDto(index, 'field' + index, properties, partitioning); + return new RootFieldDto({}, index, 'field' + index, properties, partitioning); } \ No newline at end of file diff --git a/src/Squidex/app/shared/state/contents.forms.ts b/src/Squidex/app/shared/state/contents.forms.ts index b5c1e1134..f74cc0d4d 100644 --- a/src/Squidex/app/shared/state/contents.forms.ts +++ b/src/Squidex/app/shared/state/contents.forms.ts @@ -408,7 +408,7 @@ export class EditContentForm extends Form { } } - public loadContent(value: any, disable: boolean) { + public loadContent(value: any) { for (let field of this.schema.fields) { if (field.isArray && field.nested.length > 0) { const fieldForm = this.form.get(field.name); @@ -445,12 +445,6 @@ export class EditContentForm extends Form { } super.load(value); - - if (disable) { - this.disable(); - } else { - this.enable(); - } } protected enable() { diff --git a/src/Squidex/app/shared/state/contents.state.ts b/src/Squidex/app/shared/state/contents.state.ts index 090fbe09b..96ad17f18 100644 --- a/src/Squidex/app/shared/state/contents.state.ts +++ b/src/Squidex/app/shared/state/contents.state.ts @@ -7,10 +7,9 @@ import { Injectable } from '@angular/core'; import { forkJoin, Observable, of } from 'rxjs'; -import { catchError, distinctUntilChanged, map, switchMap, tap } from 'rxjs/operators'; +import { catchError, switchMap, tap } from 'rxjs/operators'; import { - DateTime, DialogService, ErrorDto, ImmutableArray, @@ -21,12 +20,11 @@ import { Versioned } from '@app/framework'; -import { AuthService } from './../services/auth.service'; import { SchemaDto } from './../services/schemas.service'; import { AppsState } from './apps.state'; import { SchemasState } from './schemas.state'; -import { ContentDto, ContentQueryStatus, ContentsService, ScheduleDto } from './../services/contents.service'; +import { ContentDto, ContentsService } from './../services/contents.service'; interface Snapshot { // The current comments. @@ -41,18 +39,18 @@ interface Snapshot { // Indicates if the contents are loaded. isLoaded?: boolean; - // Indicates which status is shown. - status: ContentQueryStatus; + // The statuses. + statuses?: string[]; // The selected content. selectedContent?: ContentDto | null; -} -export const CONTENT_STATUSES = { - 'PublishedDraft': 'Published and Drafts (Default)', - 'PublishedOnly': 'Published only', - 'Archived': 'Archived' -}; + // Indicates if the user can create a content. + canCreate?: boolean; + + // Indicates if the user can create and publish a content. + canCreateAndPublish?: boolean; +} function sameContent(lhs: ContentDto, rhs?: ContentDto): boolean { return lhs === rhs || (!!lhs && !!rhs && lhs.id === rhs.id && lhs.version === rhs.version); @@ -60,40 +58,38 @@ function sameContent(lhs: ContentDto, rhs?: ContentDto): boolean { export abstract class ContentsStateBase extends State { public selectedContent = - this.changes.pipe(map(x => x.selectedContent), - distinctUntilChanged(sameContent)); + this.project(x => x.selectedContent, sameContent); public contents = - this.changes.pipe(map(x => x.contents), - distinctUntilChanged()); + this.project(x => x.contents); public contentsPager = - this.changes.pipe(map(x => x.contentsPager), - distinctUntilChanged()); + this.project(x => x.contentsPager); public contentsQuery = - this.changes.pipe(map(x => x.contentsQuery), - distinctUntilChanged()); + this.project(x => x.contentsQuery); public isLoaded = - this.changes.pipe(map(x => !!x.isLoaded), - distinctUntilChanged()); + this.project(x => !!x.isLoaded); + + public canCreate = + this.project(x => !!x.canCreate); + + public canCreateAndPublish = + this.project(x => !!x.canCreateAndPublish); - public isArchive = - this.changes.pipe(map(x => x.status === 'Archived'), - distinctUntilChanged()); + public canCreateAny = + this.project(x => !!x.canCreate || !!x.canCreateAndPublish); - public status = - this.changes.pipe(map(x => x.status), - distinctUntilChanged()); + public statusQueries = + this.project2(x => x.statuses, x => buildQueries(x)); constructor( private readonly appsState: AppsState, - private readonly authState: AuthService, private readonly contentsService: ContentsService, private readonly dialogs: DialogService ) { - super({ contents: ImmutableArray.of(), contentsPager: new Pager(0), status: 'PublishedDraft' }); + super({ contents: ImmutableArray.of(), contentsPager: new Pager(0) }); } public select(id: string | null): Observable { @@ -136,9 +132,8 @@ export abstract class ContentsStateBase extends State { return this.contentsService.getContents(this.appName, this.schemaName, this.snapshot.contentsPager.pageSize, this.snapshot.contentsPager.skip, - this.snapshot.contentsQuery, undefined, - this.snapshot.status).pipe( - tap(({ total, items }) => { + this.snapshot.contentsQuery, undefined).pipe( + tap(({ total, items, canCreate, canCreateAndPublish, statuses }) => { if (isReload) { this.dialogs.notifyInfo('Contents reloaded.'); } @@ -147,13 +142,23 @@ export abstract class ContentsStateBase extends State { const contents = ImmutableArray.of(items); const contentsPager = s.contentsPager.setCount(total); + statuses = s.statuses || statuses; + let selectedContent = s.selectedContent; if (selectedContent) { selectedContent = contents.find(x => x.id === selectedContent!.id) || selectedContent; } - return { ...s, contents, contentsPager, selectedContent, isLoaded: true }; + return { ...s, + canCreate, + canCreateAndPublish, + contents, + contentsPager, + isLoaded: true, + selectedContent, + statuses + }; }); })); } @@ -173,10 +178,10 @@ export abstract class ContentsStateBase extends State { shareSubscribed(this.dialogs)); } - public changeManyStatus(contents: ContentDto[], action: string, dueTime: string | null): Observable { + public changeManyStatus(contents: ContentDto[], status: string, dueTime: string | null): Observable { return forkJoin( contents.map(c => - this.contentsService.changeContentStatus(this.appName, this.schemaName, c.id, action, dueTime, c.version).pipe( + this.contentsService.putStatus(this.appName, c, status, dueTime, c.version).pipe( catchError(error => of(error))))).pipe( tap(results => { const error = results.find(x => x instanceof ErrorDto); @@ -194,7 +199,7 @@ export abstract class ContentsStateBase extends State { public deleteMany(contents: ContentDto[]): Observable { return forkJoin( contents.map(c => - this.contentsService.deleteContent(this.appName, this.schemaName, c.id, c.version).pipe( + this.contentsService.deleteContent(this.appName, c, c.version).pipe( catchError(error => of(error))))).pipe( tap(results => { const error = results.find(x => x instanceof ErrorDto); @@ -209,15 +214,8 @@ export abstract class ContentsStateBase extends State { shareSubscribed(this.dialogs, { silent: true })); } - public publishChanges(content: ContentDto, dueTime: string | null, now?: DateTime): Observable { - return this.contentsService.changeContentStatus(this.appName, this.schemaName, content.id, 'Publish', dueTime, content.version).pipe( - map(({ version }) => { - if (dueTime) { - return changeScheduleStatus(content, 'Published', dueTime, this.user, version, now); - } else { - return confirmChanges(content, this.user, version, now); - } - }), + public publishDraft(content: ContentDto, dueTime: string | null): Observable { + return this.contentsService.publishDraft(this.appName, content, dueTime, content.version).pipe( tap(updated => { this.dialogs.notifyInfo('Content updated successfully.'); @@ -226,15 +224,8 @@ export abstract class ContentsStateBase extends State { shareSubscribed(this.dialogs)); } - public changeStatus(content: ContentDto, action: string, status: string, dueTime: string | null, now?: DateTime): Observable { - return this.contentsService.changeContentStatus(this.appName, this.schemaName, content.id, action, dueTime, content.version).pipe( - map(({ version }) => { - if (dueTime) { - return changeScheduleStatus(content, status, dueTime, this.user, version, now); - } else { - return changeStatus(content, status, this.user, version, now); - } - }), + public changeStatus(content: ContentDto, status: string, dueTime: string | null): Observable { + return this.contentsService.putStatus(this.appName, content, status, dueTime, content.version).pipe( tap(updated => { this.dialogs.notifyInfo('Content updated successfully.'); @@ -243,9 +234,8 @@ export abstract class ContentsStateBase extends State { shareSubscribed(this.dialogs)); } - public update(content: ContentDto, request: any, now?: DateTime): Observable { - return this.contentsService.putContent(this.appName, this.schemaName, content.id, request, false, content.version).pipe( - map(({ payload, version }) => updateData(content, payload, this.user, version, now)), + public update(content: ContentDto, request: any): Observable { + return this.contentsService.putContent(this.appName, content, request, content.version).pipe( tap(updated => { this.dialogs.notifyInfo('Content updated successfully.'); @@ -254,9 +244,8 @@ export abstract class ContentsStateBase extends State { shareSubscribed(this.dialogs)); } - public proposeUpdate(content: ContentDto, request: any, now?: DateTime): Observable { - return this.contentsService.putContent(this.appName, this.schemaName, content.id, request, true, content.version).pipe( - map(({ payload, version }) => updateDataDraft(content, payload, this.user, version, now)), + public proposeDraft(content: ContentDto, request: any): Observable { + return this.contentsService.proposeDraft(this.appName, content, request, content.version).pipe( tap(updated => { this.dialogs.notifyInfo('Content updated successfully.'); @@ -265,9 +254,8 @@ export abstract class ContentsStateBase extends State { shareSubscribed(this.dialogs)); } - public discardChanges(content: ContentDto, now?: DateTime): Observable { - return this.contentsService.discardChanges(this.appName, this.schemaName, content.id, content.version).pipe( - map(({ version }) => discardChanges(content, this.user, version, now)), + public discardDraft(content: ContentDto): Observable { + return this.contentsService.discardDraft(this.appName, content, content.version).pipe( tap(updated => { this.dialogs.notifyInfo('Content updated successfully.'); @@ -276,9 +264,8 @@ export abstract class ContentsStateBase extends State { shareSubscribed(this.dialogs)); } - public patch(content: ContentDto, request: any, now?: DateTime): Observable { - return this.contentsService.patchContent(this.appName, this.schemaName, content.id, request, content.version).pipe( - map(({ payload, version }) => updateData(content, payload, this.user, version, now)), + public patch(content: ContentDto, request: any): Observable { + return this.contentsService.patchContent(this.appName, content, request, content.version).pipe( tap(updated => { this.dialogs.notifyInfo('Content updated successfully.'); @@ -291,21 +278,20 @@ export abstract class ContentsStateBase extends State { if (!oldVersion || !oldVersion.eq(content.version)) { return this.next(s => { const contents = s.contents.replaceBy('id', content); - const selectedContent = s.selectedContent && s.selectedContent.id === content.id ? content : s.selectedContent; + + const selectedContent = + s.selectedContent && + s.selectedContent.id === content.id ? + content : + s.selectedContent; return { ...s, contents, selectedContent }; }); } } - public filterStatus(status: ContentQueryStatus): Observable { - this.next(s => ({ ...s, contentsPager: new Pager(0), contentsQuery: undefined, status })); - - return this.loadInternal(); - } - - public search(query?: string): Observable { - this.next(s => ({ ...s, contentsPager: new Pager(0), contentsQuery: query })); + public search(contentsQuery?: string): Observable { + this.next(s => ({ ...s, contentsPager: new Pager(0), contentsQuery })); return this.loadInternal(); } @@ -331,19 +317,15 @@ export abstract class ContentsStateBase extends State { return this.appsState.appName; } - private get user() { - return this.authState.user!.token; - } - protected abstract get schemaName(): string; } @Injectable() export class ContentsState extends ContentsStateBase { - constructor(appsState: AppsState, authState: AuthService, contentsService: ContentsService, dialogs: DialogService, + constructor(appsState: AppsState, contentsService: ContentsService, dialogs: DialogService, private readonly schemasState: SchemasState ) { - super(appsState, authState, contentsService, dialogs); + super(appsState, contentsService, dialogs); } protected get schemaName() { @@ -356,9 +338,9 @@ export class ManualContentsState extends ContentsStateBase { public schema: SchemaDto; constructor( - appsState: AppsState, authState: AuthService, contentsService: ContentsService, dialogs: DialogService + appsState: AppsState, contentsService: ContentsService, dialogs: DialogService ) { - super(appsState, authState, contentsService, dialogs); + super(appsState, contentsService, dialogs); } protected get schemaName() { @@ -366,55 +348,10 @@ export class ManualContentsState extends ContentsStateBase { } } -const changeScheduleStatus = (content: ContentDto, status: string, dueTime: string, user: string, version: Version, now?: DateTime) => - content.with({ - scheduleJob: new ScheduleDto(status, user, DateTime.parseISO_UTC(dueTime)), - lastModified: now || DateTime.now(), - lastModifiedBy: user, - version - }); - -const changeStatus = (content: ContentDto, status: string, user: string, version: Version, now?: DateTime) => - content.with({ - status, - scheduleJob: null, - lastModified: now || DateTime.now(), - lastModifiedBy: user, - version - }); - -const updateData = (content: ContentDto, data: any, user: string, version: Version, now?: DateTime) => - content.with({ - data, - dataDraft: data, - lastModified: now || DateTime.now(), - lastModifiedBy: user, - version - }); - -const updateDataDraft = (content: ContentDto, data: any, user: string, version: Version, now?: DateTime) => - content.with({ - isPending: true, - dataDraft: data, - lastModified: now || DateTime.now(), - lastModifiedBy: user, - version - }); - -const confirmChanges = (content: ContentDto, user: string, version: Version, now?: DateTime) => - content.with({ - isPending: false, - data: content.dataDraft, - lastModified: now || DateTime.now(), - lastModifiedBy: user, - version - }); - -const discardChanges = (content: ContentDto, user: string, version: Version, now?: DateTime) => - content.with({ - isPending: false, - dataDraft: content.data, - lastModified: now || DateTime.now(), - lastModifiedBy: user, - version - }); +function buildQueries(x: string[] | undefined): { name: string; filter: string; }[] { + return x ? x.map(s => buildQuery(s)) : []; +} + +function buildQuery(s: string) { + return ({ name: s, filter: `$filter=status eq '${s}'` }); +} diff --git a/src/Squidex/app/shared/state/contributors.state.spec.ts b/src/Squidex/app/shared/state/contributors.state.spec.ts index f103f4bad..25a7fd2ac 100644 --- a/src/Squidex/app/shared/state/contributors.state.spec.ts +++ b/src/Squidex/app/shared/state/contributors.state.spec.ts @@ -9,29 +9,26 @@ import { of } from 'rxjs'; import { IMock, It, Mock, Times } from 'typemoq'; import { - ContributorDto, + ContributorsPayload, 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 +38,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 +48,13 @@ 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.isMaxReached).toBeFalsy(); + expect(contributorsState.snapshot.contributors.values).toEqual(oldContributors.items); 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,62 +75,39 @@ 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(5, 6); - 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.version).toEqual(newVersion); + expectNewContributors(updated); }); - it('should update contributor in snapshot when assigned and already added', () => { - const newContributor = new ContributorDto(modifier, 'Owner'); + it('should update contributors when contribution revoked', () => { + const updated = createContributors(5, 6); - const request = { ...newContributor }; - const response = { contributorId: newContributor.contributorId, isCreated: true }; + contributorsService.setup(x => x.deleteContributor(app, oldContributors.items[0], version)) + .returns(() => of(versioned(newVersion, updated))).verifiable(); - contributorsService.setup(x => x.postContributor(app, request, version)) - .returns(() => of(versioned(newVersion, response))).verifiable(); - - contributorsState.assign(request).subscribe(); + contributorsState.revoke(oldContributors.items[0]).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); + expectNewContributors(updated); }); - it('should remove contributor from snapshot when revoked', () => { - contributorsService.setup(x => x.deleteContributor(app, oldContributors[0].contributorId, version)) - .returns(() => of(versioned(newVersion))).verifiable(); - - contributorsState.revoke(oldContributors[0]).subscribe(); - - expect(contributorsState.snapshot.contributors.values).toEqual([ - { isCurrentUser: true, contributor: oldContributors[1] } - ]); + 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 be7a8c83b..cfcd6d80f 100644 --- a/src/Squidex/app/shared/state/contributors.state.ts +++ b/src/Squidex/app/shared/state/contributors.state.ts @@ -7,7 +7,7 @@ import { Injectable } from '@angular/core'; import { Observable, throwError } from 'rxjs'; -import { catchError, distinctUntilChanged, map, tap } from 'rxjs/operators'; +import { catchError, tap } from 'rxjs/operators'; import { DialogService, @@ -23,27 +23,16 @@ 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; - // Indicates if the maximum number of contributors are reached. - isMaxReached?: boolean; - // Indicates if the contributors are loaded. isLoaded?: boolean; @@ -52,35 +41,33 @@ interface Snapshot { // The app version. version: Version; + + // Indicates if the user can add a contributor. + canCreate?: boolean; } -type ContributorsList = ImmutableArray; +type ContributorsList = ImmutableArray; @Injectable() export class ContributorsState extends State { public contributors = - this.changes.pipe(map(x => x.contributors), - distinctUntilChanged()); - - public isMaxReached = - this.changes.pipe(map(x => x.isMaxReached), - distinctUntilChanged()); + this.project(x => x.contributors); public isLoaded = - this.changes.pipe(map(x => !!x.isLoaded), - distinctUntilChanged()); + this.project(x => !!x.isLoaded); public maxContributors = - this.changes.pipe(map(x => x.maxContributors), - distinctUntilChanged()); + this.project(x => x.maxContributors); + + public canCreate = + this.project(x => !!x.canCreate); 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: Version.EMPTY, maxContributors: -1 }); } public load(isReload = false): Observable { @@ -94,19 +81,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 +104,18 @@ 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)); - } - - 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)); - } + shareMapSubscribed(this.dialogs, x => x.payload._meta && x.payload._meta['isInvited'] === '1')); } - private replaceContributors(contributors: ImmutableArray, version: Version, maxContributors?: number) { + private replaceContributors(version: Version, payload: ContributorsPayload) { this.next(s => { - maxContributors = maxContributors || s.maxContributors; + const { canCreate, items, maxContributors } = payload; - const isLoaded = true; - const isMaxReached = maxContributors > 0 && maxContributors <= contributors.length; + const contributors = ImmutableArray.of(items); - return { ...s, contributors, maxContributors, isLoaded, isMaxReached, version }; + return { ...s, contributors, maxContributors, isLoaded: true, version, canCreate }; }); } @@ -154,15 +123,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/src/Squidex/app/shared/state/filter.state.ts b/src/Squidex/app/shared/state/filter.state.ts index 769b5d882..f3adedc2c 100644 --- a/src/Squidex/app/shared/state/filter.state.ts +++ b/src/Squidex/app/shared/state/filter.state.ts @@ -6,7 +6,7 @@ */ import { Observable } from 'rxjs'; -import { distinctUntilChanged, map } from 'rxjs/internal/operators'; +import { distinctUntilChanged } from 'rxjs/internal/operators'; import { State, Types } from '@app/framework'; @@ -45,20 +45,16 @@ export class FilterState extends State { private readonly sortModes: { [key: string]: Observable } = {}; public query = - this.changes.pipe(map(x => x.query), - distinctUntilChanged()); + this.project(x => x.query); public order = - this.changes.pipe(map(x => x.order), - distinctUntilChanged()); + this.project(x => x.order); public filter = - this.changes.pipe(map(x => x.filter), - distinctUntilChanged()); + this.project(x => x.filter); public fullText = - this.changes.pipe(map(x => x.fullText), - distinctUntilChanged()); + this.project(x => x.fullText); public get apiFilter() { return this.snapshot.query; @@ -74,7 +70,7 @@ export class FilterState extends State { let result = this.sortModes[key]; if (!result) { - result = this.changes.pipe(map(x => sortMode(x, field)), distinctUntilChanged()); + result = this.project(x => sortMode(x, field)), distinctUntilChanged(); this.sortModes[key] = result; } diff --git a/src/Squidex/app/shared/state/languages.state.spec.ts b/src/Squidex/app/shared/state/languages.state.spec.ts index 3a4f6dc50..cdbf7662d 100644 --- a/src/Squidex/app/shared/state/languages.state.spec.ts +++ b/src/Squidex/app/shared/state/languages.state.spec.ts @@ -9,7 +9,7 @@ import { of } from 'rxjs'; import { IMock, It, Mock, Times } from 'typemoq'; import { - AppLanguageDto, + AppLanguagesPayload, AppLanguagesService, DialogService, ImmutableArray, @@ -19,6 +19,8 @@ import { versioned } from '@app/shared/internal'; +import { createLanguages } from '../services/app-languages.service.spec'; + import { TestValues } from './_test-helpers'; describe('LanguagesState', () => { @@ -34,10 +36,7 @@ describe('LanguagesState', () => { const languageIT = new LanguageDto('it', 'Italian'); const languageES = new LanguageDto('es', 'Spanish'); - const oldLanguages = [ - AppLanguageDto.fromLanguage(languageEN, true), - AppLanguageDto.fromLanguage(languageDE, false, true, [languageEN.iso2Code]) - ]; + const oldLanguages = createLanguages('en', 'de'); let dialogs: IMock; let languagesService: IMock; @@ -72,12 +71,12 @@ describe('LanguagesState', () => { expect(languagesState.snapshot.languages.values).toEqual([ { - language: oldLanguages[0], - fallbackLanguages: ImmutableArray.empty(), - fallbackLanguagesNew: ImmutableArray.of([oldLanguages[1]]) + language: oldLanguages.items[0], + fallbackLanguages: ImmutableArray.of([oldLanguages.items[1]]), + fallbackLanguagesNew: ImmutableArray.empty() }, { - language: oldLanguages[1], - fallbackLanguages: ImmutableArray.of([oldLanguages[0]]), + language: oldLanguages.items[1], + fallbackLanguages: ImmutableArray.of([oldLanguages.items[0]]), fallbackLanguagesNew: ImmutableArray.empty() } ]); @@ -102,74 +101,51 @@ describe('LanguagesState', () => { languagesState.load().subscribe(); }); - it('should add language to snapshot when assigned', () => { - const newLanguage = new AppLanguageDto(languageIT.iso2Code, languageIT.englishName, false, false, []); + it('should update languages when language added', () => { + const updated = createLanguages('de'); languagesService.setup(x => x.postLanguage(app, It.isAny(), version)) - .returns(() => of(versioned(newVersion, newLanguage))).verifiable(); + .returns(() => of(versioned(newVersion, updated))).verifiable(); languagesState.add(languageIT).subscribe(); - expect(languagesState.snapshot.languages.values).toEqual([ - { - language: oldLanguages[0], - fallbackLanguages: ImmutableArray.empty(), - fallbackLanguagesNew: ImmutableArray.of([oldLanguages[1], newLanguage]) - }, { - language: oldLanguages[1], - fallbackLanguages: ImmutableArray.of([oldLanguages[0]]), - fallbackLanguagesNew: ImmutableArray.of([newLanguage]) - }, { - language: newLanguage, - fallbackLanguages: ImmutableArray.of(), - fallbackLanguagesNew: ImmutableArray.of([oldLanguages[0], oldLanguages[1]]) - } - ]); - expect(languagesState.snapshot.allLanguagesNew.values).toEqual([languageES]); - expect(languagesState.snapshot.version).toEqual(newVersion); + expectNewLanguages(updated); }); - it('should update language in snapshot when updated', () => { - const request = { isMaster: true, isOptional: false, fallback: [] }; + it('should update languages when language updated', () => { + const updated = createLanguages('de'); - languagesService.setup(x => x.putLanguage(app, oldLanguages[1].iso2Code, request, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + const request = { isMaster: true, isOptional: false, fallback: [] }; - languagesState.update(oldLanguages[1], request).subscribe(); + languagesService.setup(x => x.putLanguage(app, oldLanguages.items[1], request, version)) + .returns(() => of(versioned(newVersion, updated))).verifiable(); - const newLanguage1 = AppLanguageDto.fromLanguage(languageDE, true); - const newLanguage2 = AppLanguageDto.fromLanguage(languageEN); + languagesState.update(oldLanguages.items[1], request).subscribe(); - expect(languagesState.snapshot.languages.values).toEqual([ - { - language: newLanguage1, - fallbackLanguages: ImmutableArray.empty(), - fallbackLanguagesNew: ImmutableArray.of([newLanguage2]) - }, { - language: newLanguage2, - fallbackLanguages: ImmutableArray.empty(), - fallbackLanguagesNew: ImmutableArray.of([newLanguage1]) - } - ]); - expect(languagesState.snapshot.allLanguagesNew.values).toEqual([languageIT, languageES]); - expect(languagesState.snapshot.version).toEqual(newVersion); + expectNewLanguages(updated); }); - it('should remove language from snapshot when deleted', () => { - languagesService.setup(x => x.deleteLanguage(app, oldLanguages[1].iso2Code, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + it('should update languages when language deleted', () => { + const updated = createLanguages('de'); - languagesState.remove(oldLanguages[1]).subscribe(); + languagesService.setup(x => x.deleteLanguage(app, oldLanguages.items[1], version)) + .returns(() => of(versioned(newVersion, updated))).verifiable(); + languagesState.remove(oldLanguages.items[1]).subscribe(); + + expectNewLanguages(updated); + }); + + function expectNewLanguages(updated: AppLanguagesPayload) { expect(languagesState.snapshot.languages.values).toEqual([ { - language: oldLanguages[0], + language: updated.items[0], fallbackLanguages: ImmutableArray.empty(), fallbackLanguagesNew: ImmutableArray.empty() } ]); - expect(languagesState.snapshot.allLanguagesNew.values).toEqual([languageDE, languageIT, languageES]); + expect(languagesState.snapshot.allLanguagesNew.values).toEqual([languageEN, languageIT, languageES]); expect(languagesState.snapshot.version).toEqual(newVersion); - }); + } }); }); \ No newline at end of file diff --git a/src/Squidex/app/shared/state/languages.state.ts b/src/Squidex/app/shared/state/languages.state.ts index a3fe30386..7f1a77f27 100644 --- a/src/Squidex/app/shared/state/languages.state.ts +++ b/src/Squidex/app/shared/state/languages.state.ts @@ -7,12 +7,11 @@ import { Injectable } from '@angular/core'; import { forkJoin, Observable } from 'rxjs'; -import { distinctUntilChanged, map, tap } from 'rxjs/operators'; +import { map, tap } from 'rxjs/operators'; import { DialogService, ImmutableArray, - mapVersioned, shareMapSubscribed, shareSubscribed, State, @@ -21,6 +20,7 @@ import { import { AppLanguageDto, + AppLanguagesPayload, AppLanguagesService, UpdateAppLanguageDto } from './../services/app-languages.service'; @@ -40,9 +40,6 @@ interface SnapshotLanguage { } interface Snapshot { - // the configured languages as plan format. - plainLanguages: AppLanguagesList; - // All supported languages. allLanguages: LanguageList; @@ -57,6 +54,9 @@ interface Snapshot { // Indicates if the languages are loaded. isLoaded?: boolean; + + // Inedicates if the user can add a language. + canCreate?: boolean; } type AppLanguagesList = ImmutableArray; @@ -66,16 +66,16 @@ type LanguageResultList = ImmutableArray; @Injectable() export class LanguagesState extends State { public languages = - this.changes.pipe(map(x => x.languages), - distinctUntilChanged()); + this.project(x => x.languages); public newLanguages = - this.changes.pipe(map(x => x.allLanguagesNew), - distinctUntilChanged()); + this.project(x => x.allLanguagesNew); public isLoaded = - this.changes.pipe(map(x => !!x.isLoaded), - distinctUntilChanged()); + this.project(x => !!x.isLoaded); + + public canCreate = + this.project(x => !!x.canCreate); constructor( private readonly appLanguagesService: AppLanguagesService, @@ -84,11 +84,10 @@ export class LanguagesState extends State { private readonly languagesService: LanguagesService ) { super({ - plainLanguages: ImmutableArray.empty(), allLanguages: ImmutableArray.empty(), allLanguagesNew: ImmutableArray.empty(), languages: ImmutableArray.empty(), - version: new Version('') + version: Version.EMPTY }); } @@ -110,64 +109,47 @@ export class LanguagesState extends State { const sorted = ImmutableArray.of(allLanguages).sortByStringAsc(x => x.englishName); - this.replaceLanguages(ImmutableArray.of(languages.payload), languages.version, sorted); + this.replaceLanguages(languages.payload, languages.version, sorted); }), shareSubscribed(this.dialogs)); } - public add(language: LanguageDto): Observable { + public add(language: LanguageDto): Observable { return this.appLanguagesService.postLanguage(this.appName, { language: language.iso2Code }, this.version).pipe( tap(({ version, payload }) => { - const languages = this.snapshot.plainLanguages.push(payload).sortByStringAsc(x => x.englishName); - - this.replaceLanguages(languages, version); + this.replaceLanguages(payload, version); }), shareMapSubscribed(this.dialogs, x => x.payload)); } public remove(language: AppLanguageDto): Observable { - return this.appLanguagesService.deleteLanguage(this.appName, language.iso2Code, this.version).pipe( - tap(({ version }) => { - const languages = this.snapshot.plainLanguages.filter(x => x.iso2Code !== language.iso2Code); - - this.replaceLanguages(languages, version); + return this.appLanguagesService.deleteLanguage(this.appName, language, this.version).pipe( + tap(({ version, payload }) => { + this.replaceLanguages(payload, version); }), shareSubscribed(this.dialogs)); } - public update(language: AppLanguageDto, request: UpdateAppLanguageDto): Observable { - return this.appLanguagesService.putLanguage(this.appName, language.iso2Code, request, this.version).pipe( - mapVersioned(() => update(language, request)), + public update(language: AppLanguageDto, request: UpdateAppLanguageDto): Observable { + return this.appLanguagesService.putLanguage(this.appName, language, request, this.version).pipe( tap(({ version, payload }) => { - const languages = this.snapshot.plainLanguages.map(x => { - if (x.iso2Code === language.iso2Code) { - return payload; - } else if (x.isMaster && request.isMaster) { - return update(x, { isMaster: false }); - } else { - return x; - } - }); - - this.replaceLanguages(languages, version); + this.replaceLanguages(payload, version); }), shareMapSubscribed(this.dialogs, x => x.payload)); } - private replaceLanguages(languages: AppLanguagesList, version: Version, allLanguages?: LanguageList) { + private replaceLanguages(payload: AppLanguagesPayload, version: Version, allLanguages?: LanguageList) { this.next(s => { allLanguages = allLanguages || s.allLanguages; + const { canCreate, items } = payload; + + const languages = ImmutableArray.of(items); + return { ...s, - languages: languages.sort((a, b) => { - if (a.isMaster === b.isMaster) { - return a.englishName.localeCompare(b.englishName); - } else { - return (a.isMaster ? 0 : 1) - (b.isMaster ? 0 : 1); - } - }).map(x => this.createLanguage(x, languages)), - plainLanguages: languages, + canCreate, + languages: languages.map(x => this.createLanguage(x, languages)), allLanguages: allLanguages, allLanguagesNew: allLanguages.filter(x => !languages.find(l => l.iso2Code === x.iso2Code)), isLoaded: true, @@ -191,7 +173,7 @@ export class LanguagesState extends State { ImmutableArray.of( language.fallback .map(l => languages.find(x => x.iso2Code === l)).filter(x => !!x) - .map(x => x)), + .map(l => l!)), fallbackLanguagesNew: languages .filter(l => @@ -200,7 +182,4 @@ export class LanguagesState extends State { .sortByStringAsc(x => x.englishName) }; } -} - -const update = (language: AppLanguageDto, request: UpdateAppLanguageDto) => - language.with(request); \ No newline at end of file +} \ No newline at end of file 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..5d6d742d0 100644 --- a/src/Squidex/app/shared/state/patterns.state.ts +++ b/src/Squidex/app/shared/state/patterns.state.ts @@ -7,12 +7,11 @@ import { Injectable } from '@angular/core'; import { Observable } from 'rxjs'; -import { distinctUntilChanged, map, tap } from 'rxjs/operators'; +import { tap } from 'rxjs/operators'; import { DialogService, ImmutableArray, - mapVersioned, shareMapSubscribed, shareSubscribed, State, @@ -24,6 +23,7 @@ import { AppsState } from './apps.state'; import { EditPatternDto, PatternDto, + PatternsPayload, PatternsService } from './../services/patterns.service'; @@ -36,6 +36,9 @@ interface Snapshot { // Indicates if the patterns are loaded. isLoaded?: boolean; + + // Indicates if patterns can be created. + canCreate?: boolean; } type PatternsList = ImmutableArray; @@ -43,19 +46,20 @@ type PatternsList = ImmutableArray; @Injectable() export class PatternsState extends State { public patterns = - this.changes.pipe(map(x => x.patterns), - distinctUntilChanged()); + this.project(x => x.patterns); public isLoaded = - this.changes.pipe(map(x => !!x.isLoaded), - distinctUntilChanged()); + this.project(x => !!x.isLoaded); + + public canCreate = + this.project(x => !!x.canCreate); constructor( private readonly patternsService: PatternsService, private readonly appsState: AppsState, private readonly dialogs: DialogService ) { - super({ patterns: ImmutableArray.empty(), version: new Version('') }); + super({ patterns: ImmutableArray.empty(), version: Version.EMPTY }); } public load(isReload = false): Observable { @@ -69,52 +73,45 @@ 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); + + const { canCreate } = payload; + + this.next(s => { + return { ...s, patterns, isLoaded: true, version, canCreate }; + }); + } + private get appName() { return this.appsState.appName; } @@ -122,7 +119,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..db532caf0 100644 --- a/src/Squidex/app/shared/state/plans.state.ts +++ b/src/Squidex/app/shared/state/plans.state.ts @@ -7,7 +7,7 @@ import { Injectable } from '@angular/core'; import { Observable } from 'rxjs'; -import { distinctUntilChanged, map, tap } from 'rxjs/operators'; +import { tap } from 'rxjs/operators'; import { DialogService, @@ -52,24 +52,19 @@ interface Snapshot { @Injectable() export class PlansState extends State { public plans = - this.changes.pipe(map(x => x.plans), - distinctUntilChanged()); + this.project(x => x.plans); public isOwner = - this.changes.pipe(map(x => !!x.isOwner), - distinctUntilChanged()); + this.project(x => !!x.isOwner); public isLoaded = - this.changes.pipe(map(x => !!x.isLoaded), - distinctUntilChanged()); + this.project(x => !!x.isLoaded); public isDisabled = - this.changes.pipe(map(x => !x.isOwner), - distinctUntilChanged()); + this.project(x => !x.isOwner); public hasPortal = - this.changes.pipe(map(x => x.hasPortal), - distinctUntilChanged()); + this.project(x => x.hasPortal); public window = window; @@ -79,7 +74,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..87daf6b53 100644 --- a/src/Squidex/app/shared/state/roles.state.ts +++ b/src/Squidex/app/shared/state/roles.state.ts @@ -7,13 +7,11 @@ import { Injectable } from '@angular/core'; import { Observable } from 'rxjs'; -import { distinctUntilChanged, map, tap } from 'rxjs/operators'; +import { tap } from 'rxjs/operators'; import { DialogService, ImmutableArray, - mapVersioned, - shareMapSubscribed, shareSubscribed, State, Version @@ -24,6 +22,7 @@ import { AppsState } from './apps.state'; import { CreateRoleDto, RoleDto, + RolesPayload, RolesService, UpdateRoleDto } from './../services/roles.service'; @@ -37,6 +36,9 @@ interface Snapshot { // Indicates if the roles are loaded. isLoaded?: boolean; + + // Indicates if the user can add a role. + canCreate?: boolean; } type RolesList = ImmutableArray; @@ -44,19 +46,20 @@ type RolesList = ImmutableArray; @Injectable() export class RolesState extends State { public roles = - this.changes.pipe(map(x => x.roles), - distinctUntilChanged()); + this.project(x => x.roles); public isLoaded = - this.changes.pipe(map(x => !!x.isLoaded), - distinctUntilChanged()); + this.project(x => !!x.isLoaded); + + public canCreate = + this.project(x => !!x.canCreate); constructor( private readonly rolesService: RolesService, private readonly appsState: AppsState, private readonly dialogs: DialogService ) { - super({ roles: ImmutableArray.empty(), version: new Version('') }); + super({ roles: ImmutableArray.empty(), version: Version.EMPTY }); } public load(isReload = false): Observable { @@ -70,50 +73,43 @@ 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 { canCreate, items } = payload; - return { ...s, roles, version }; - }); - }), - shareMapSubscribed(this.dialogs, x => x.payload)); + const roles = ImmutableArray.of(items); + + this.next(s => { + return { ...s, roles, isLoaded: true, version, canCreate }; + }); } private get appName() { @@ -123,7 +119,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 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..cd0ebcab6 100644 --- a/src/Squidex/app/shared/state/rule-events.state.spec.ts +++ b/src/Squidex/app/shared/state/rule-events.state.spec.ts @@ -9,14 +9,14 @@ import { of } from 'rxjs'; import { IMock, It, Mock, Times } from 'typemoq'; import { - DateTime, DialogService, - RuleEventDto, RuleEventsDto, RuleEventsState, RulesService } from '@app/shared/internal'; +import { createRuleEvent } from '../services/rules.service.spec'; + import { TestValues } from './_test-helpers'; describe('RuleEventsState', () => { @@ -26,8 +26,8 @@ describe('RuleEventsState', () => { } = TestValues; const oldRuleEvents = [ - new RuleEventDto('id1', DateTime.now(), null, 'event1', 'description', 'dump1', 'result1', 'result1', 1), - new RuleEventDto('id2', DateTime.now(), null, 'event2', 'description', 'dump2', 'result2', 'result2', 2) + createRuleEvent(1), + createRuleEvent(2) ]; let dialogs: IMock; @@ -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..6b8823029 100644 --- a/src/Squidex/app/shared/state/rule-events.state.ts +++ b/src/Squidex/app/shared/state/rule-events.state.ts @@ -7,7 +7,7 @@ import { Injectable } from '@angular/core'; import { Observable } from 'rxjs'; -import { distinctUntilChanged, map, tap } from 'rxjs/operators'; +import { tap } from 'rxjs/operators'; import { DialogService, @@ -35,16 +35,13 @@ interface Snapshot { @Injectable() export class RuleEventsState extends State { public ruleEvents = - this.changes.pipe(map(x => x.ruleEvents), - distinctUntilChanged()); + this.project(x => x.ruleEvents); public ruleEventsPager = - this.changes.pipe(map(x => x.ruleEventsPager), - distinctUntilChanged()); + this.project(x => x.ruleEventsPager); public isLoaded = - this.changes.pipe(map(x => !!x.isLoaded), - distinctUntilChanged()); + this.project(x => !!x.isLoaded); constructor( private readonly appsState: AppsState, @@ -82,7 +79,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 +87,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..bc344ad4d 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([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([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([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..8e5ed5f2a 100644 --- a/src/Squidex/app/shared/state/rules.state.ts +++ b/src/Squidex/app/shared/state/rules.state.ts @@ -7,23 +7,18 @@ import { Injectable } from '@angular/core'; import { Observable } from 'rxjs'; -import { distinctUntilChanged, map, tap } from 'rxjs/operators'; +import { tap } from 'rxjs/operators'; import { - DateTime, DialogService, ImmutableArray, shareSubscribed, - State, - Version, - Versioned + State } from '@app/framework'; -import { AuthService} from './../services/auth.service'; import { AppsState } from './apps.state'; import { - RuleCreatedDto, RuleDto, RulesService, UpsertRuleDto @@ -35,6 +30,12 @@ interface Snapshot { // Indicates if the rules are loaded. isLoaded?: boolean; + + // Indicates if the user can create rules. + canCreate?: boolean; + + // Indicates if the user can read events. + canReadEvents?: boolean; } type RulesList = ImmutableArray; @@ -42,16 +43,19 @@ type RulesList = ImmutableArray; @Injectable() export class RulesState extends State { public rules = - this.changes.pipe(map(x => x.rules), - distinctUntilChanged()); + this.project(x => x.rules); public isLoaded = - this.changes.pipe(map(x => !!x.isLoaded), - distinctUntilChanged()); + this.project(x => !!x.isLoaded); + + public canCreate = + this.project(x => !!x.canCreate); + + public canReadEvents = + this.project(x => !!x.canReadEvents); constructor( private readonly appsState: AppsState, - private readonly authState: AuthService, private readonly dialogs: DialogService, private readonly rulesService: RulesService ) { @@ -64,23 +68,22 @@ export class RulesState extends State { } return this.rulesService.getRules(this.appName).pipe( - tap(payload => { + tap(({ items, canCreate, canReadEvents }) => { 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, canCreate, canReadEvents }; }); }), 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 +95,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 +106,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 +149,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/src/Squidex/app/shared/state/schemas.state.spec.ts b/src/Squidex/app/shared/state/schemas.state.spec.ts index 5b084eab0..0f0315218 100644 --- a/src/Squidex/app/shared/state/schemas.state.spec.ts +++ b/src/Squidex/app/shared/state/schemas.state.spec.ts @@ -5,56 +5,46 @@ * 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, + FieldDto, 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 = { + canCreate: true, + 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 +54,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,9 +68,9 @@ 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 }); + expect(schemasState.snapshot.categories).toEqual({ 'category1': false, 'category2': false }); schemasService.verifyAll(); }); @@ -92,9 +82,9 @@ 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 }); + expect(schemasState.snapshot.categories).toEqual({ 'category1': false, 'category2': false, 'category3': true }); schemasService.verifyAll(); }); @@ -122,38 +112,38 @@ describe('SchemasState', () => { it('should add category', () => { schemasState.addCategory('category3'); - expect(schemasState.snapshot.categories).toEqual({ 'category1': false, 'category2': false, 'category3': true, '': true }); + expect(schemasState.snapshot.categories).toEqual({ 'category1': false, 'category2': false, 'category3': true }); }); it('should remove category', () => { schemasState.removeCategory('category1'); - expect(schemasState.snapshot.categories).toEqual({ 'category2': false, '': true }); + expect(schemasState.snapshot.categories).toEqual({ 'category2': false }); }); 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 +171,326 @@ 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(); + let newField: FieldDto; - const schema_1 = schemasState.snapshot.schemas.at(1); + schemasState.addField(schema1, request).subscribe(result => { + newField = result; + }); - expect(schema_1.fields).toEqual([field1, field2, newField]); - expectToBeModified(schema_1); - }); - - it('should add field and update user info when nested field added', () => { - const request = { ...field1 }; - - const newField = new NestedFieldDto(3, '3', createProperties('String'), 2); - - schemasService.setup(x => x.postField(app, schema.name, It.isAny(), 2, version)) - .returns(() => of(versioned(newVersion, newField))).verifiable(); + const schema1New = schemasState.snapshot.schemas.at(0); - schemasState.addField(schema, request, field2, modified).subscribe(); - - const schema_1 = schemasState.snapshot.schemas.at(1); - - expect(schema_1.fields[1].nested).toEqual([nested1, nested2, newField]); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); + expect(newField!).toBeDefined(); }); - 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(); + it('should update schema and selected schema when nested field added', () => { + const request = { ...schema.fields[0].nested[0] }; - schemasState.deleteField(schema, field1, modified).subscribe(); + const updated = createSchemaDetails(1, newVersion, '-new'); - const schema_1 = schemasState.snapshot.schemas.at(1); + schemasService.setup(x => x.postField(app, schema.fields[0], It.isAny(), version)) + .returns(() => of(updated)).verifiable(); - expect(schema_1.fields).toEqual([field2]); - expectToBeModified(schema_1); - }); + let newField: FieldDto; - 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(); - - schemasState.deleteField(schema, nested1, modified).subscribe(); + schemasState.addField(schema1, request, schema.fields[0]).subscribe(result => { + newField = result; + }); - 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); + expect(newField!).toBeDefined(); }); - 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(); - - schemasState.sortFields(schema, [field2, field1], undefined, modified).subscribe(); + it('should update schema and selected schema when field removed', () => { + const updated = createSchemaDetails(1, newVersion, '-new'); - const schema_1 = schemasState.snapshot.schemas.at(1); + schemasService.setup(x => x.deleteField(app, schema.fields[0], version)) + .returns(() => of(updated)).verifiable(); - expect(schema_1.fields).toEqual([field2, field1]); - expectToBeModified(schema_1); - }); - - 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.deleteField(schema1, schema.fields[0]).subscribe(); - schemasState.sortFields(schema, [nested2, nested1], field2, modified).subscribe(); + const schema1New = schemasState.snapshot.schemas.at(0); - 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 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, schema1, [schema.fields[1].fieldId, schema.fields[2].fieldId], version)) + .returns(() => of(updated)).verifiable(); - schemasState.updateField(schema, field1, request, modified).subscribe(); + schemasState.orderFields(schema1, [schema.fields[1], schema.fields[2]]).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 nested fields sorted', () => { + const updated = createSchemaDetails(1, newVersion, '-new'); - schemasService.setup(x => x.putField(app, schema.name, nested1.fieldId, request, 2, 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, nested1, request, modified).subscribe(); + schemasState.orderFields(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[1].nested[0].properties).toBe(request.properties); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); }); - 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); + it('should update schema and selected schema when field updated', () => { + const updated = createSchemaDetails(1, newVersion, '-new'); - expect(schema_1.fields[0].isHidden).toBeTruthy(); - expectToBeModified(schema_1); - }); + const request = { ...schema.fields[0] }; - 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(); + schemasService.setup(x => x.putField(app, schema.fields[0], request, version)) + .returns(() => of(updated)).verifiable(); - schemasState.hideField(schema, nested1, modified).subscribe(); + schemasState.updateField(schema1, schema.fields[0], request).subscribe(); - const schema_1 = schemasState.snapshot.schemas.at(1); + const schema1New = schemasState.snapshot.schemas.at(0); - expect(schema_1.fields[1].nested[0].isHidden).toBeTruthy(); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); }); - 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))); + it('should update schema and selected schema when field hidden', () => { + const updated = createSchemaDetails(1, newVersion, '-new'); - schemasState.disableField(schema, field1, modified).subscribe(); + schemasService.setup(x => x.hideField(app, schema.fields[0], version)) + .returns(() => of(updated)).verifiable(); - const schema_1 = schemasState.snapshot.schemas.at(1); + schemasState.hideField(schema1, schema.fields[0]).subscribe(); - expect(schema_1.fields[0].isDisabled).toBeTruthy(); - expectToBeModified(schema_1); - }); - - 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 schema1New = schemasState.snapshot.schemas.at(0); - const schema_1 = schemasState.snapshot.schemas.at(1); - - expect(schema_1.fields[1].nested[0].isDisabled).toBeTruthy(); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); }); - 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(); - - schemasState.lockField(schema, field1, modified).subscribe(); + it('should update schema and selected schema when field disabled', () => { + const updated = createSchemaDetails(1, newVersion, '-new'); - const schema_1 = schemasState.snapshot.schemas.at(1); + schemasService.setup(x => x.disableField(app, schema.fields[0], version)) + .returns(() => of(updated)); - expect(schema_1.fields[0].isLocked).toBeTruthy(); - expectToBeModified(schema_1); - }); - - 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(); + 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[1].nested[0].isLocked).toBeTruthy(); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); }); - 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(); - - schemasState.showField(schema, field2, modified).subscribe(); + it('should update schema and selected schema when field locked', () => { + const updated = createSchemaDetails(1, newVersion, '-new'); - const schema_1 = schemasState.snapshot.schemas.at(1); + schemasService.setup(x => x.lockField(app, schema.fields[0], version)) + .returns(() => of(updated)).verifiable(); - expect(schema_1.fields[1].isHidden).toBeFalsy(); - expectToBeModified(schema_1); - }); + schemasState.lockField(schema1, schema.fields[0]).subscribe(); - 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(); + const schema1New = schemasState.snapshot.schemas.at(0); - schemasState.showField(schema, nested2, modified).subscribe(); - - const schema_1 = schemasState.snapshot.schemas.at(1); - - expect(schema_1.fields[1].nested[1].isHidden).toBeFalsy(); - expectToBeModified(schema_1); + expect(schema1New).toEqual(updated); + expect(schemasState.snapshot.selectedSchema).toEqual(updated); }); - 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(); + it('should update schema and selected schema when field shown', () => { + const updated = createSchemaDetails(1, newVersion, '-new'); + + schemasService.setup(x => x.showField(app, schema.fields[0], version)) + .returns(() => of(updated)).verifiable(); - schemasState.enableField(schema, field2, modified).subscribe(); + schemasState.showField(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].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..131fc1ad2 100644 --- a/src/Squidex/app/shared/state/schemas.state.ts +++ b/src/Squidex/app/shared/state/schemas.state.ts @@ -7,22 +7,18 @@ import { Injectable } from '@angular/core'; import { Observable, of } from 'rxjs'; -import { catchError, distinctUntilChanged, map, tap } from 'rxjs/operators'; +import { catchError, tap } from 'rxjs/operators'; import { - DateTime, + compareStringsAsc, DialogService, ImmutableArray, - mapVersioned, 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,10 +48,15 @@ interface Snapshot { // The selected schema. selectedSchema?: SchemaDetailsDto | null; + + // Indicates if the user can create a schema. + canCreate?: boolean; } export type SchemasList = ImmutableArray; +export type Categories = { [name: string]: boolean }; + function sameSchema(lhs: SchemaDetailsDto | null, rhs?: SchemaDetailsDto | null): boolean { return lhs === rhs || (!!lhs && !!rhs && lhs.id === rhs.id && lhs.version === rhs.version); } @@ -70,29 +67,26 @@ export class SchemasState extends State { return this.snapshot.selectedSchema ? this.snapshot.selectedSchema.name : ''; } - public selectedSchema = - this.changes.pipe(map(x => x.selectedSchema), - distinctUntilChanged(sameSchema)); - public categories = - this.changes.pipe(map(x => ImmutableArray.of(Object.keys(x.categories)).sortByStringAsc(s => s)), - distinctUntilChanged()); + this.project2(x => x.categories, x => sortedCategoryNames(x)); + + public selectedSchema = + this.project(x => x.selectedSchema, sameSchema); public schemas = - this.changes.pipe(map(x => x.schemas), - distinctUntilChanged()); + this.project(x => x.schemas); public publishedSchemas = - this.changes.pipe(map(x => x.schemas.filter(s => s.isPublished)), - distinctUntilChanged()); + this.project2(x => x.schemas, x => x.filter(s => s.isPublished)); public isLoaded = - this.changes.pipe(map(x => !!x.isLoaded), - distinctUntilChanged()); + this.project(x => !!x.isLoaded); + + public canCreate = + this.project(x => !!x.canCreate); constructor( private readonly appsState: AppsState, - private readonly authState: AuthService, private readonly dialogs: DialogService, private readonly schemasService: SchemasService ) { @@ -124,37 +118,38 @@ export class SchemasState extends State { } return this.schemasService.getSchemas(this.appName).pipe( - tap(payload => { + tap(({ items, canCreate }) => { if (isReload) { this.dialogs.notifyInfo('Schemas reloaded.'); } return this.next(s => { - const schemas = ImmutableArray.of(payload).sortByStringAsc(x => x.displayName); + const schemas = ImmutableArray.of(items).sortByStringAsc(x => x.displayName); const categories = buildCategories(s.categories, schemas); - return { ...s, schemas, isLoaded: true, categories }; + return { ...s, schemas, isLoaded: true, categories, canCreate }; }); }), 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); - return { ...s, schemas }; + const categories = buildCategories(s.categories, schemas); + + return { ...s, schemas, categories }; }); }), shareSubscribed(this.dialogs, { silent: true })); } 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 +177,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 orderFields(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 +318,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 x.fields.find(f => f.fieldId === parent.fieldId)!.nested.find(f => f.name === request.name)!; + } else { + return x.fields.find(f => f.name === request.name)!; } } @@ -398,12 +345,10 @@ function buildCategories(categories: { [name: string]: boolean }, schemas?: Sche } } - categories[''] = true; - return categories; } -function addCategory(categories: { [name: string]: boolean }, category: string) { +function addCategory(categories: Categories, category: string) { categories = { ...categories }; categories[category] = true; @@ -411,7 +356,7 @@ function addCategory(categories: { [name: string]: boolean }, category: string) return categories; } -function removeCategory(categories: { [name: string]: boolean }, category: string) { +function removeCategory(categories: Categories, category: string) { categories = { ...categories }; delete categories[category]; @@ -419,121 +364,10 @@ function removeCategory(categories: { [name: string]: boolean }, category: strin 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; +function sortedCategoryNames(categories: Categories) { + const names = Object.keys(categories); + + names.sort(compareStringsAsc); + + return names; } \ No newline at end of file diff --git a/src/Squidex/app/shared/state/ui.state.spec.ts b/src/Squidex/app/shared/state/ui.state.spec.ts index 3502b656a..0e7e75de3 100644 --- a/src/Squidex/app/shared/state/ui.state.spec.ts +++ b/src/Squidex/app/shared/state/ui.state.spec.ts @@ -8,7 +8,13 @@ import { of } from 'rxjs'; import { IMock, It, Mock, Times } from 'typemoq'; -import { UIService, UIState } from '@app/shared/internal'; +import { + ResourceLinks, + ResourcesDto, + UIService, + UIState, + UsersService +} from '@app/shared/internal'; import { TestValues } from './_test-helpers'; @@ -30,6 +36,13 @@ describe('UIState', () => { canCreateApps: true }; + const resources: ResourceLinks = { + ['admin/events']: { method: 'GET', href: '/api/events' }, + ['admin/restore']: { method: 'GET', href: '/api/restore' }, + ['admin/users']: { method: 'GET', href: '/api/users' } + }; + + let usersService: IMock; let uiService: IMock; let uiState: UIState; @@ -48,7 +61,12 @@ describe('UIState', () => { uiService.setup(x => x.deleteSetting(app, It.isAnyString())) .returns(() => of({})); - uiState = new UIState(appsState.object, uiService.object); + usersService = Mock.ofType(); + + usersService.setup(x => x.getResources()) + .returns(() => of(new ResourcesDto(resources))); + + uiState = new UIState(appsState.object, uiService.object, usersService.object); }); it('should load settings', () => { @@ -58,6 +76,10 @@ describe('UIState', () => { mapSize: 1024, canCreateApps: true }); + + expect(uiState.snapshot.canReadEvents).toBeTruthy(); + expect(uiState.snapshot.canReadUsers).toBeTruthy(); + expect(uiState.snapshot.canRestore).toBeTruthy(); }); it('should add value to snapshot when set', () => { diff --git a/src/Squidex/app/shared/state/ui.state.ts b/src/Squidex/app/shared/state/ui.state.ts index b9e1402c8..0ba4c169e 100644 --- a/src/Squidex/app/shared/state/ui.state.ts +++ b/src/Squidex/app/shared/state/ui.state.ts @@ -8,12 +8,18 @@ import { Injectable } from '@angular/core'; import { distinctUntilChanged, map } from 'rxjs/operators'; -import { State, Types } from '@app/framework'; +import { + hasAnyLink, + State, + Types +} from '@app/framework'; import { AppsState } from './apps.state'; import { UIService, UISettingsDto } from './../services/ui.service'; +import { UsersService } from './../services/users.service'; + interface Snapshot { // All common settings. settingsCommon: object & any; @@ -23,13 +29,36 @@ interface Snapshot { // The merged settings of app and common settings. settings: object & any; + + // Indicates if the user can read events. + canReadEvents?: boolean; + + // Indicates if the user can read users. + canReadUsers?: boolean; + + // Indicates if the user can restore backups. + canRestore?: boolean; + + // Indicates if the user can use at least one admin resource. + canUserAdminResource?: boolean; } @Injectable() export class UIState extends State { public settings = - this.changes.pipe(map(x => x.settings), - distinctUntilChanged()); + this.project(x => x.settings); + + public canReadEvents = + this.project(x => !!x.canReadEvents); + + public canReadUsers = + this.project(x => !!x.canReadUsers); + + public canRestore = + this.project(x => !!x.canRestore); + + public canUserAdminResource = + this.project(x => !!x.canRestore || !!x.canReadUsers || !!x.canReadEvents); public get(path: string, defaultValue: T) { return this.settings.pipe(map(x => this.getValue(x, path, defaultValue)), @@ -38,16 +67,16 @@ export class UIState extends State { constructor( private readonly appsState: AppsState, - private readonly uiService: UIService + private readonly uiService: UIService, + private readonly usersService: UsersService ) { - super({ settings: { }, settingsCommon: { }, settingsApp: { } }); + super({ settings: {}, settingsCommon: {}, settingsApp: {} }); + this.loadResources(); this.loadCommon(); - appsState.selectedApp.subscribe(app => { - if (app) { - this.load(); - } + appsState.selectedValidApp.subscribe(app => { + this.load(); }); } @@ -67,6 +96,17 @@ export class UIState extends State { }); } + private loadResources() { + this.usersService.getResources() + .subscribe(payload => { + this.next(s => ({ ...s, + canReadEvents: hasAnyLink(payload, 'admin/events'), + canReadUsers: hasAnyLink(payload, 'admin/users'), + canRestore: hasAnyLink(payload, 'admin/restore') + })); + }); + } + public set(path: string, value: any) { const { key, current, root } = this.getContainer(path); @@ -151,11 +191,11 @@ export class UIState extends State { function updateAppSettings(state: Snapshot, settingsApp: object & any) { const { settingsCommon } = state; - return { settings: { ...settingsCommon, ...settingsApp }, settingsApp, settingsCommon }; + return { ...state, settings: { ...settingsCommon, ...settingsApp }, settingsApp, settingsCommon }; } function updateCommonSettings(state: Snapshot, settingsCommon: object & any) { const { settingsApp } = state; - return { settings: { ...settingsCommon, ...settingsApp }, settingsApp, settingsCommon }; + return { ...state, settings: { ...settingsCommon, ...settingsApp }, settingsApp, settingsCommon }; } \ No newline at end of file diff --git a/src/Squidex/app/shell/pages/app/left-menu.component.html b/src/Squidex/app/shell/pages/app/left-menu.component.html index 96a44de7d..7bacd4188 100644 --- a/src/Squidex/app/shell/pages/app/left-menu.component.html +++ b/src/Squidex/app/shell/pages/app/left-menu.component.html @@ -1,30 +1,30 @@ -
    -
  • +
      +
    • Schemas
      • -
    • +
    • Content
      • -
    • +
    • Assets
      • -
    • +
    • Rules
      • -
    • +
    • Settings
      • -
    • +
    • API
       diff --git a/src/Squidex/app/shell/pages/app/left-menu.component.ts b/src/Squidex/app/shell/pages/app/left-menu.component.ts index b4f9a93ad..7e95e7496 100644 --- a/src/Squidex/app/shell/pages/app/left-menu.component.ts +++ b/src/Squidex/app/shell/pages/app/left-menu.component.ts @@ -16,7 +16,8 @@ import { AppsState } from '@app/shared'; changeDetection: ChangeDetectionStrategy.OnPush }) export class LeftMenuComponent { - constructor(public readonly appsState: AppsState + constructor( + public readonly appsState: AppsState ) { } } \ No newline at end of file diff --git a/src/Squidex/app/shell/pages/internal/apps-menu.component.html b/src/Squidex/app/shell/pages/internal/apps-menu.component.html index a2ac8b300..d78bbfb5e 100644 --- a/src/Squidex/app/shell/pages/internal/apps-menu.component.html +++ b/src/Squidex/app/shell/pages/internal/apps-menu.component.html @@ -38,19 +38,17 @@
      • - - -
    • -
      - - -
      -
      • -       + +
    • +
      + + +
      +
    diff --git a/src/Squidex/app/shell/pages/internal/profile-menu.component.html b/src/Squidex/app/shell/pages/internal/profile-menu.component.html index 5e5e87bef..0af7fdd5d 100644 --- a/src/Squidex/app/shell/pages/internal/profile-menu.component.html +++ b/src/Squidex/app/shell/pages/internal/profile-menu.component.html @@ -17,7 +17,7 @@
    - + Administration diff --git a/src/Squidex/app/shell/pages/internal/profile-menu.component.ts b/src/Squidex/app/shell/pages/internal/profile-menu.component.ts index 214a8249e..70c774d99 100644 --- a/src/Squidex/app/shell/pages/internal/profile-menu.component.ts +++ b/src/Squidex/app/shell/pages/internal/profile-menu.component.ts @@ -12,7 +12,8 @@ import { AuthService, fadeAnimation, ModalModel, - StatefulComponent + StatefulComponent, + UIState } from '@app/shared'; interface State { @@ -35,6 +36,7 @@ export class ProfileMenuComponent extends StatefulComponent implements On public modalMenu = new ModalModel(); constructor(changeDetector: ChangeDetectorRef, apiUrl: ApiUrlConfig, + public readonly uiState: UIState, private readonly authService: AuthService ) { super(changeDetector, { diff --git a/tests/Squidex.Domain.Apps.Core.Tests/Operations/Scripting/JintUserTests.cs b/tests/Squidex.Domain.Apps.Core.Tests/Operations/Scripting/JintUserTests.cs index e91b0dc96..25bc436ec 100644 --- a/tests/Squidex.Domain.Apps.Core.Tests/Operations/Scripting/JintUserTests.cs +++ b/tests/Squidex.Domain.Apps.Core.Tests/Operations/Scripting/JintUserTests.cs @@ -75,8 +75,8 @@ namespace Squidex.Domain.Apps.Core.Operations.Scripting { var identity = new ClaimsIdentity(); - identity.AddClaim(new Claim("claim1", "1a")); - identity.AddClaim(new Claim("claim1", "1b")); + identity.AddClaim(new Claim("prefix1.claim1", "1a")); + identity.AddClaim(new Claim("prefix2.claim1", "1b")); identity.AddClaim(new Claim("claim2", "2a")); identity.AddClaim(new Claim("claim2", "2b")); 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/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/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(); diff --git a/tests/Squidex.Domain.Apps.Entities.Tests/Apps/RoleExtensionsTests.cs b/tests/Squidex.Domain.Apps.Entities.Tests/Apps/RoleExtensionsTests.cs index 5cb8fb01b..cfd3c06af 100644 --- a/tests/Squidex.Domain.Apps.Entities.Tests/Apps/RoleExtensionsTests.cs +++ b/tests/Squidex.Domain.Apps.Entities.Tests/Apps/RoleExtensionsTests.cs @@ -67,5 +67,14 @@ namespace Squidex.Domain.Apps.Entities.Apps Assert.Equal(Permission.Any, result.First().Id); } + + [Fact] + public void Should_remove_common_permission() + { + var source = new PermissionSet("squidex.apps.my-app.common"); + var result = source.WithoutApp("my-app"); + + Assert.Empty(result); + } } } 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 d26a8335c..00f6856ed 100644 --- a/tests/Squidex.Domain.Apps.Entities.Tests/Assets/AssetCommandMiddlewareTests.cs +++ b/tests/Squidex.Domain.Apps.Entities.Tests/Assets/AssetCommandMiddlewareTests.cs @@ -54,19 +54,23 @@ namespace Squidex.Domain.Apps.Entities.Assets A.CallTo(() => assetQuery.QueryByHashAsync(AppId, A.Ignored)) .Returns(new List()); - A.CallTo(() => tagService.NormalizeTagsAsync(AppId, TagGroups.Assets, A>.Ignored, A>.Ignored)) - .Returns(new Dictionary()); + A.CallTo(() => tagService.DenormalizeTagsAsync(AppId, TagGroups.Assets, A>.Ignored)) + .Returns(new Dictionary + { + ["1"] = "foundTag1", + ["2"] = "foundTag2" + }); A.CallTo(() => grainFactory.GetGrain(Id, null)) .Returns(asset); - sut = new AssetCommandMiddleware(grainFactory, assetQuery, assetStore, assetThumbnailGenerator, new[] { tagGenerator }); + sut = new AssetCommandMiddleware(grainFactory, assetQuery, assetStore, assetThumbnailGenerator, new[] { tagGenerator }, tagService); } [Fact] public async Task Create_should_create_domain_object() { - var command = new CreateAsset { AssetId = assetId, File = file }; + var command = CreateCommand(new CreateAsset { AssetId = assetId, File = file }); var context = CreateContextForCommand(command); SetupTags(command); @@ -76,9 +80,11 @@ 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", command.Tags); + Assert.Contains("tag2", command.Tags); + + Assert.Equal(new HashSet { "tag1", "tag2" }, result.Tags); AssertAssetHasBeenUploaded(0, context.ContextId); AssertAssetImageChecked(); @@ -87,7 +93,7 @@ namespace Squidex.Domain.Apps.Entities.Assets [Fact] public async Task Create_should_calculate_hash() { - var command = new CreateAsset { AssetId = assetId, File = file }; + var command = CreateCommand(new CreateAsset { AssetId = assetId, File = file }); var context = CreateContextForCommand(command); SetupImageInfo(); @@ -100,7 +106,7 @@ namespace Squidex.Domain.Apps.Entities.Assets [Fact] public async Task Create_should_return_duplicate_result_if_file_with_same_hash_found() { - var command = new CreateAsset { AssetId = assetId, File = file }; + var command = CreateCommand(new CreateAsset { AssetId = assetId, File = file }); var context = CreateContextForCommand(command); SetupSameHashAsset(file.FileName, file.FileSize, out _); @@ -108,13 +114,15 @@ namespace Squidex.Domain.Apps.Entities.Assets await sut.HandleAsync(context); - Assert.True(context.Result().IsDuplicate); + var result = context.Result(); + + Assert.True(result.IsDuplicate); } [Fact] public async Task Create_should_not_return_duplicate_result_if_file_with_same_hash_but_other_name_found() { - var command = new CreateAsset { AssetId = assetId, File = file }; + var command = CreateCommand(new CreateAsset { AssetId = assetId, File = file }); var context = CreateContextForCommand(command); SetupSameHashAsset("other-name", file.FileSize, out _); @@ -122,13 +130,31 @@ namespace Squidex.Domain.Apps.Entities.Assets await sut.HandleAsync(context); - Assert.False(context.Result().IsDuplicate); + var result = context.Result(); + + Assert.False(result.IsDuplicate); + } + + [Fact] + public async Task Create_should_resolve_tag_names_for_duplicate() + { + var command = CreateCommand(new CreateAsset { AssetId = assetId, File = file }); + var context = CreateContextForCommand(command); + + SetupSameHashAsset(file.FileName, file.FileSize, out _); + SetupImageInfo(); + + await sut.HandleAsync(context); + + var result = context.Result(); + + Assert.Equal(new HashSet { "foundTag1", "foundTag2" }, result.Tags); } [Fact] public async Task Create_should_not_return_duplicate_result_if_file_with_same_hash_but_other_size_found() { - var command = new CreateAsset { AssetId = assetId, File = file }; + var command = CreateCommand(new CreateAsset { AssetId = assetId, File = file }); var context = CreateContextForCommand(command); SetupSameHashAsset(file.FileName, 12345, out _); @@ -142,7 +168,7 @@ namespace Squidex.Domain.Apps.Entities.Assets [Fact] public async Task Update_should_update_domain_object() { - var command = new UpdateAsset { AssetId = assetId, File = file }; + var command = CreateCommand(new UpdateAsset { AssetId = assetId, File = file }); var context = CreateContextForCommand(command); SetupImageInfo(); @@ -158,7 +184,7 @@ namespace Squidex.Domain.Apps.Entities.Assets [Fact] public async Task Update_should_calculate_hash() { - var command = new UpdateAsset { AssetId = assetId, File = file }; + var command = CreateCommand(new UpdateAsset { AssetId = assetId, File = file }); var context = CreateContextForCommand(command); SetupImageInfo(); @@ -170,6 +196,40 @@ namespace Squidex.Domain.Apps.Entities.Assets Assert.True(command.FileHash.Length > 10); } + [Fact] + public async Task Update_should_resolve_tags() + { + var command = CreateCommand(new UpdateAsset { AssetId = assetId, File = file }); + var context = CreateContextForCommand(command); + + SetupImageInfo(); + + await ExecuteCreateAsync(); + + await sut.HandleAsync(context); + + var result = context.Result(); + + Assert.Equal(new HashSet { "foundTag1", "foundTag2" }, result.Tags); + } + + [Fact] + public async Task AnnotateAsset_should_resolve_tags() + { + var command = CreateCommand(new AnnotateAsset { AssetId = assetId, FileName = "newName" }); + var context = CreateContextForCommand(command); + + SetupImageInfo(); + + await ExecuteCreateAsync(); + + await sut.HandleAsync(context); + + var result = context.Result(); + + Assert.Equal(new HashSet { "foundTag1", "foundTag2" }, result.Tags); + } + private Task ExecuteCreateAsync() { return asset.ExecuteAsync(CreateCommand(new CreateAsset { AssetId = Id, File = file })); diff --git a/tests/Squidex.Domain.Apps.Entities.Tests/Assets/AssetGrainTests.cs b/tests/Squidex.Domain.Apps.Entities.Tests/Assets/AssetGrainTests.cs index 8ef290b23..89c85d927 100644 --- a/tests/Squidex.Domain.Apps.Entities.Tests/Assets/AssetGrainTests.cs +++ b/tests/Squidex.Domain.Apps.Entities.Tests/Assets/AssetGrainTests.cs @@ -62,7 +62,7 @@ namespace Squidex.Domain.Apps.Entities.Assets var result = await sut.ExecuteAsync(CreateAssetCommand(command)); - result.ShouldBeEquivalent(new AssetSavedResult(0, 0, fileHash)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(0, sut.Snapshot.FileVersion); Assert.Equal(fileHash, sut.Snapshot.FileHash); @@ -94,7 +94,7 @@ namespace Squidex.Domain.Apps.Entities.Assets var result = await sut.ExecuteAsync(CreateAssetCommand(command)); - result.ShouldBeEquivalent(new AssetSavedResult(1, 1, fileHash)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(1, sut.Snapshot.FileVersion); Assert.Equal(fileHash, sut.Snapshot.FileHash); @@ -123,7 +123,7 @@ namespace Squidex.Domain.Apps.Entities.Assets var result = await sut.ExecuteAsync(CreateAssetCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(1)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal("My New Image.png", sut.Snapshot.FileName); @@ -142,7 +142,7 @@ namespace Squidex.Domain.Apps.Entities.Assets var result = await sut.ExecuteAsync(CreateAssetCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(1)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal("my-new-image.png", sut.Snapshot.Slug); @@ -161,7 +161,7 @@ namespace Squidex.Domain.Apps.Entities.Assets var result = await sut.ExecuteAsync(CreateAssetCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(1)); + result.ShouldBeEquivalent(sut.Snapshot); LastEvents .ShouldHaveSameEvents( diff --git a/tests/Squidex.Domain.Apps.Entities.Tests/Contents/ContentGrainTests.cs b/tests/Squidex.Domain.Apps.Entities.Tests/Contents/ContentGrainTests.cs index cac8a1954..f5a96de1b 100644 --- a/tests/Squidex.Domain.Apps.Entities.Tests/Contents/ContentGrainTests.cs +++ b/tests/Squidex.Domain.Apps.Entities.Tests/Contents/ContentGrainTests.cs @@ -122,7 +122,7 @@ namespace Squidex.Domain.Apps.Entities.Contents var result = await sut.ExecuteAsync(CreateContentCommand(command)); - result.ShouldBeEquivalent(EntityCreatedResult.Create(data, 0)); + result.ShouldBeEquivalent(sut.Snapshot); LastEvents .ShouldHaveSameEvents( @@ -142,7 +142,7 @@ namespace Squidex.Domain.Apps.Entities.Contents var result = await sut.ExecuteAsync(CreateContentCommand(command)); - result.ShouldBeEquivalent(EntityCreatedResult.Create(data, 1)); + result.ShouldBeEquivalent(sut.Snapshot); LastEvents .ShouldHaveSameEvents( @@ -173,7 +173,7 @@ namespace Squidex.Domain.Apps.Entities.Contents var result = await sut.ExecuteAsync(CreateContentCommand(command)); - result.ShouldBeEquivalent(new ContentDataChangedResult(otherData, 1)); + result.ShouldBeEquivalent(sut.Snapshot); LastEvents .ShouldHaveSameEvents( @@ -194,7 +194,7 @@ namespace Squidex.Domain.Apps.Entities.Contents var result = await sut.ExecuteAsync(CreateContentCommand(command)); - result.ShouldBeEquivalent(new ContentDataChangedResult(otherData, 2)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.True(sut.Snapshot.IsPending); @@ -216,7 +216,7 @@ namespace Squidex.Domain.Apps.Entities.Contents var result = await sut.ExecuteAsync(CreateContentCommand(command)); - result.ShouldBeEquivalent(new ContentDataChangedResult(data, 0)); + result.ShouldBeEquivalent(sut.Snapshot); LastEvents .ShouldHaveSameEvents( @@ -246,7 +246,7 @@ namespace Squidex.Domain.Apps.Entities.Contents var result = await sut.ExecuteAsync(CreateContentCommand(command)); - result.ShouldBeEquivalent(new ContentDataChangedResult(patched, 1)); + result.ShouldBeEquivalent(sut.Snapshot); LastEvents .ShouldHaveSameEvents( @@ -267,7 +267,7 @@ namespace Squidex.Domain.Apps.Entities.Contents var result = await sut.ExecuteAsync(CreateContentCommand(command)); - result.ShouldBeEquivalent(new ContentDataChangedResult(otherData, 2)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.True(sut.Snapshot.IsPending); @@ -289,7 +289,7 @@ namespace Squidex.Domain.Apps.Entities.Contents var result = await sut.ExecuteAsync(CreateContentCommand(command)); - result.ShouldBeEquivalent(new ContentDataChangedResult(data, 0)); + result.ShouldBeEquivalent(sut.Snapshot); LastEvents .ShouldHaveSameEvents( @@ -301,7 +301,7 @@ namespace Squidex.Domain.Apps.Entities.Contents } [Fact] - public async Task ChangedStatus_should_create_events_and_update_state() + public async Task ChangeStatus_should_create_events_and_update_state() { var command = new ChangeContentStatus { Status = Status.Published }; @@ -309,7 +309,7 @@ namespace Squidex.Domain.Apps.Entities.Contents var result = await sut.ExecuteAsync(CreateContentCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(1)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(Status.Published, sut.Snapshot.Status); @@ -323,7 +323,7 @@ namespace Squidex.Domain.Apps.Entities.Contents } [Fact] - public async Task ChangedStatus_should_create_events_and_update_state_when_archived() + public async Task ChangeStatus_should_create_events_and_update_state_when_archived() { var command = new ChangeContentStatus { Status = Status.Archived }; @@ -331,7 +331,7 @@ namespace Squidex.Domain.Apps.Entities.Contents var result = await sut.ExecuteAsync(CreateContentCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(1)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(Status.Archived, sut.Snapshot.Status); @@ -345,7 +345,7 @@ namespace Squidex.Domain.Apps.Entities.Contents } [Fact] - public async Task ChangedStatus_should_create_events_and_update_state_when_unpublished() + public async Task ChangeStatus_should_create_events_and_update_state_when_unpublished() { var command = new ChangeContentStatus { Status = Status.Draft }; @@ -354,7 +354,7 @@ namespace Squidex.Domain.Apps.Entities.Contents var result = await sut.ExecuteAsync(CreateContentCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(2)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(Status.Draft, sut.Snapshot.Status); @@ -368,7 +368,7 @@ namespace Squidex.Domain.Apps.Entities.Contents } [Fact] - public async Task ChangedStatus_should_create_events_and_update_state_when_restored() + public async Task ChangeStatus_should_create_events_and_update_state_when_restored() { var command = new ChangeContentStatus { Status = Status.Draft }; @@ -377,7 +377,7 @@ namespace Squidex.Domain.Apps.Entities.Contents var result = await sut.ExecuteAsync(CreateContentCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(2)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(Status.Draft, sut.Snapshot.Status); @@ -391,7 +391,7 @@ namespace Squidex.Domain.Apps.Entities.Contents } [Fact] - public async Task ChangedStatus_should_create_proposal_events_and_update_state() + public async Task ChangeStatus_should_create_proposal_events_and_update_state() { var command = new ChangeContentStatus { Status = Status.Published }; @@ -401,7 +401,7 @@ namespace Squidex.Domain.Apps.Entities.Contents var result = await sut.ExecuteAsync(CreateContentCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(3)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.False(sut.Snapshot.IsPending); @@ -425,7 +425,7 @@ namespace Squidex.Domain.Apps.Entities.Contents var result = await sut.ExecuteAsync(CreateContentCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(1)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(Status.Draft, sut.Snapshot.Status); Assert.Equal(Status.Published, sut.Snapshot.ScheduleJob.Status); @@ -450,7 +450,7 @@ namespace Squidex.Domain.Apps.Entities.Contents var result = await sut.ExecuteAsync(CreateContentCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(2)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Null(sut.Snapshot.ScheduleJob); diff --git a/tests/Squidex.Domain.Apps.Entities.Tests/Contents/ContentQueryServiceTests.cs b/tests/Squidex.Domain.Apps.Entities.Tests/Contents/ContentQueryServiceTests.cs index b0e29dabd..9ca83efa0 100644 --- a/tests/Squidex.Domain.Apps.Entities.Tests/Contents/ContentQueryServiceTests.cs +++ b/tests/Squidex.Domain.Apps.Entities.Tests/Contents/ContentQueryServiceTests.cs @@ -54,6 +54,12 @@ namespace Squidex.Domain.Apps.Entities.Contents private readonly QueryContext context; private readonly ContentQueryService sut; + public static IEnumerable ApiStatusTests = new[] + { + new object[] { StatusForApi.PublishedOnly, 0, new[] { Status.Published } }, + new object[] { StatusForApi.All, 1, null } + }; + public ContentQueryServiceTests() { user = new ClaimsPrincipal(identity); @@ -187,31 +193,17 @@ namespace Squidex.Domain.Apps.Entities.Contents await Assert.ThrowsAsync(async () => await sut.FindContentAsync(ctx, schemaId.Name, contentId)); } - public static IEnumerable SingleDataFrontend = new[] - { - new object[] { StatusForFrontend.PublishedOnly, new[] { Status.Archived, Status.Draft, Status.Published } }, - new object[] { StatusForFrontend.PublishedDraft, new[] { Status.Archived, Status.Draft, Status.Published } }, - new object[] { StatusForFrontend.Archived, new[] { Status.Archived, Status.Draft, Status.Published } }, - }; - - public static IEnumerable SingleDataApi = new[] - { - new object[] { StatusForApi.PublishedOnly, 0, new[] { Status.Published } }, - new object[] { StatusForApi.PublishedDraft, 1, new[] { Status.Published, Status.Draft } } - }; - - [Theory] - [MemberData(nameof(SingleDataFrontend))] - public async Task Should_return_single_content_for_frontend_without_transform(StatusForFrontend request, Status[] status) + [Fact] + public async Task Should_return_single_content_for_frontend_without_transform() { var content = CreateContent(contentId); SetupClaims(isFrontend: true); SetupSchemaFound(); SetupScripting(contentId); - SetupContent(status, content, includeDraft: true); + SetupContent(null, content, includeDraft: true); - var ctx = context.WithFrontendStatus(request); + var ctx = context; var result = await sut.FindContentAsync(ctx, schemaId.Name, contentId); @@ -223,7 +215,7 @@ namespace Squidex.Domain.Apps.Entities.Contents } [Theory] - [MemberData(nameof(SingleDataApi))] + [MemberData(nameof(ApiStatusTests))] public async Task Should_return_single_content_for_api_with_transform(StatusForApi request, int includeDraft, Status[] status) { var content = CreateContent(contentId); @@ -275,9 +267,8 @@ namespace Squidex.Domain.Apps.Entities.Contents await Assert.ThrowsAsync(() => sut.QueryAsync(ctx, schemaId.Name, Q.Empty)); } - [Theory] - [MemberData(nameof(ManyDataFrontend))] - public async Task Should_query_contents_by_query_for_frontend_without_transform(StatusForFrontend request, Status[] status) + [Fact] + public async Task Should_query_contents_by_query_for_frontend_without_transform() { const int count = 5, total = 200; @@ -286,9 +277,9 @@ namespace Squidex.Domain.Apps.Entities.Contents SetupClaims(isFrontend: true); SetupSchemaFound(); SetupScripting(contentId); - SetupContents(status, count, total, content, inDraft: true, includeDraft: true); + SetupContents(null, count, total, content, inDraft: true, includeDraft: true); - var ctx = context.WithFrontendStatus(request); + var ctx = context; var result = await sut.QueryAsync(ctx, schemaId.Name, Q.Empty); @@ -302,7 +293,7 @@ namespace Squidex.Domain.Apps.Entities.Contents } [Theory] - [MemberData(nameof(ManyDataApi))] + [MemberData(nameof(ApiStatusTests))] public async Task Should_query_contents_by_query_for_api_and_transform(StatusForApi request, int includeDraft, Status[] status) { const int count = 5, total = 200; @@ -338,22 +329,8 @@ namespace Squidex.Domain.Apps.Entities.Contents await Assert.ThrowsAsync(() => sut.QueryAsync(context, schemaId.Name, query)); } - public static IEnumerable ManyDataFrontend = new[] - { - new object[] { StatusForFrontend.PublishedOnly, new[] { Status.Published } }, - new object[] { StatusForFrontend.PublishedDraft, new[] { Status.Published, Status.Draft } }, - new object[] { StatusForFrontend.Archived, new[] { Status.Archived } } - }; - - public static IEnumerable ManyDataApi = new[] - { - new object[] { StatusForApi.PublishedOnly, 0, new[] { Status.Published } }, - new object[] { StatusForApi.PublishedDraft, 1, new[] { Status.Published, Status.Draft } } - }; - - [Theory] - [MemberData(nameof(ManyDataFrontend))] - public async Task Should_query_contents_by_id_for_frontend_and_transform(StatusForFrontend request, Status[] status) + [Fact] + public async Task Should_query_contents_by_id_for_frontend_and_transform() { const int count = 5, total = 200; @@ -362,9 +339,9 @@ namespace Squidex.Domain.Apps.Entities.Contents SetupClaims(isFrontend: true); SetupSchemaFound(); SetupScripting(ids.ToArray()); - SetupContents(status, total, ids, includeDraft: true); + SetupContents(null, total, ids, includeDraft: true); - var ctx = context.WithFrontendStatus(request); + var ctx = context; var result = await sut.QueryAsync(ctx, schemaId.Name, Q.Empty.WithIds(ids)); @@ -376,7 +353,7 @@ namespace Squidex.Domain.Apps.Entities.Contents } [Theory] - [MemberData(nameof(ManyDataApi))] + [MemberData(nameof(ApiStatusTests))] public async Task Should_query_contents_by_id_for_api_and_transform(StatusForApi request, int includeDraft, Status[] status) { const int count = 5, total = 200; @@ -399,9 +376,8 @@ namespace Squidex.Domain.Apps.Entities.Contents .MustHaveHappened(count, Times.Exactly); } - [Theory] - [MemberData(nameof(ManyDataFrontend))] - public async Task Should_query_all_contents_by_id_for_frontend_and_transform(StatusForFrontend request, Status[] status) + [Fact] + public async Task Should_query_all_contents_by_id_for_frontend_and_transform() { const int count = 5; @@ -410,9 +386,9 @@ namespace Squidex.Domain.Apps.Entities.Contents SetupClaims(isFrontend: true); SetupSchemaFound(); SetupScripting(ids.ToArray()); - SetupContents(status, ids, includeDraft: true); + SetupContents(null, ids, includeDraft: true); - var ctx = context.WithFrontendStatus(request); + var ctx = context; var result = await sut.QueryAsync(ctx, ids); @@ -423,7 +399,7 @@ namespace Squidex.Domain.Apps.Entities.Contents } [Theory] - [MemberData(nameof(ManyDataApi))] + [MemberData(nameof(ApiStatusTests))] public async Task Should_query_all_contents_by_id_for_api_and_transform(StatusForApi request, int includeDraft, Status[] status) { const int count = 5; diff --git a/tests/Squidex.Domain.Apps.Entities.Tests/Contents/MongoDb/StatusSerializerTests.cs b/tests/Squidex.Domain.Apps.Entities.Tests/Contents/MongoDb/StatusSerializerTests.cs new file mode 100644 index 000000000..ce50fc208 --- /dev/null +++ b/tests/Squidex.Domain.Apps.Entities.Tests/Contents/MongoDb/StatusSerializerTests.cs @@ -0,0 +1,51 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschraenkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +using MongoDB.Bson; +using MongoDB.Bson.IO; +using MongoDB.Bson.Serialization; +using Squidex.Domain.Apps.Core.Contents; +using Squidex.Domain.Apps.Entities.MongoDb.Contents; +using Xunit; + +namespace Squidex.Domain.Apps.Entities.Contents.MongoDb +{ + public sealed class StatusSerializerTests + { + private sealed class TestObject + { + public Status2 Status { get; set; } + } + + [Fact] + public void Should_serialize_and_deserialize_status() + { + StatusSerializer.Register(); + + var source = new TestObject + { + Status = new Status2("Published") + }; + + var document = new BsonDocument(); + + using (var writer = new BsonDocumentWriter(document)) + { + BsonSerializer.Serialize(writer, source); + + writer.Flush(); + } + + using (var reader = new BsonDocumentReader(document)) + { + var result = BsonSerializer.Deserialize(reader); + + Assert.Equal(source.Status, result.Status); + } + } + } +} 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); 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); diff --git a/tests/Squidex.Domain.Apps.Entities.Tests/TestHelpers/AExtensions.cs b/tests/Squidex.Domain.Apps.Entities.Tests/TestHelpers/AExtensions.cs index ba4628463..e038caead 100644 --- a/tests/Squidex.Domain.Apps.Entities.Tests/TestHelpers/AExtensions.cs +++ b/tests/Squidex.Domain.Apps.Entities.Tests/TestHelpers/AExtensions.cs @@ -19,6 +19,11 @@ namespace Squidex.Domain.Apps.Entities.TestHelpers public static T[] Is(this INegatableArgumentConstraintManager that, params T[] values) { + if (values == null) + { + return that.IsNull(); + } + return that.IsSameSequenceAs(values); } } diff --git a/tests/Squidex.Infrastructure.Tests/Commands/DomainObjectGrainTests.cs b/tests/Squidex.Infrastructure.Tests/Commands/DomainObjectGrainTests.cs index dcca158c0..aaba71d95 100644 --- a/tests/Squidex.Infrastructure.Tests/Commands/DomainObjectGrainTests.cs +++ b/tests/Squidex.Infrastructure.Tests/Commands/DomainObjectGrainTests.cs @@ -38,13 +38,13 @@ namespace Squidex.Infrastructure.Commands switch (command) { case CreateAuto createAuto: - return CreateAsync(createAuto, c => + return Create(createAuto, c => { RaiseEvent(new ValueChanged { Value = c.Value }); }); case CreateCustom createCustom: - return CreateReturnAsync(createCustom, c => + return CreateReturn(createCustom, c => { RaiseEvent(new ValueChanged { Value = c.Value }); @@ -52,13 +52,13 @@ namespace Squidex.Infrastructure.Commands }); case UpdateAuto updateAuto: - return UpdateAsync(updateAuto, c => + return Update(updateAuto, c => { RaiseEvent(new ValueChanged { Value = c.Value }); }); case UpdateCustom updateCustom: - return UpdateAsync(updateCustom, c => + return UpdateReturn(updateCustom, c => { RaiseEvent(new ValueChanged { Value = c.Value }); diff --git a/tests/Squidex.Infrastructure.Tests/Commands/LogSnapshotDomainObjectGrainTests.cs b/tests/Squidex.Infrastructure.Tests/Commands/LogSnapshotDomainObjectGrainTests.cs index 2940c5bf3..aecbb6bf8 100644 --- a/tests/Squidex.Infrastructure.Tests/Commands/LogSnapshotDomainObjectGrainTests.cs +++ b/tests/Squidex.Infrastructure.Tests/Commands/LogSnapshotDomainObjectGrainTests.cs @@ -40,13 +40,13 @@ namespace Squidex.Infrastructure.Commands switch (command) { case CreateAuto createAuto: - return CreateAsync(createAuto, c => + return Create(createAuto, c => { RaiseEvent(new ValueChanged { Value = c.Value }); }); case CreateCustom createCustom: - return CreateReturnAsync(createCustom, c => + return CreateReturn(createCustom, c => { RaiseEvent(new ValueChanged { Value = c.Value }); @@ -54,13 +54,13 @@ namespace Squidex.Infrastructure.Commands }); case UpdateAuto updateAuto: - return UpdateAsync(updateAuto, c => + return Update(updateAuto, c => { RaiseEvent(new ValueChanged { Value = c.Value }); }); case UpdateCustom updateCustom: - return UpdateAsync(updateCustom, c => + return UpdateReturn(updateCustom, c => { RaiseEvent(new ValueChanged { Value = c.Value }); diff --git a/tests/Squidex.Infrastructure.Tests/TestHelpers/MyDomainObject.cs b/tests/Squidex.Infrastructure.Tests/TestHelpers/MyDomainObject.cs index 2202d2b1b..78c6a3ddb 100644 --- a/tests/Squidex.Infrastructure.Tests/TestHelpers/MyDomainObject.cs +++ b/tests/Squidex.Infrastructure.Tests/TestHelpers/MyDomainObject.cs @@ -26,13 +26,13 @@ namespace Squidex.Infrastructure.TestHelpers switch (command) { case CreateAuto createAuto: - return CreateAsync(createAuto, c => + return Create(createAuto, c => { RaiseEvent(new ValueChanged { Value = c.Value }); }); case CreateCustom createCustom: - return CreateReturnAsync(createCustom, c => + return CreateReturn(createCustom, c => { RaiseEvent(new ValueChanged { Value = c.Value }); @@ -40,13 +40,13 @@ namespace Squidex.Infrastructure.TestHelpers }); case UpdateAuto updateAuto: - return UpdateAsync(updateAuto, c => + return Update(updateAuto, c => { RaiseEvent(new ValueChanged { Value = c.Value }); }); case UpdateCustom updateCustom: - return UpdateAsync(updateCustom, c => + return UpdateReturn(updateCustom, c => { RaiseEvent(new ValueChanged { Value = c.Value }); 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);