v5.17.0

- *Enhancement:* The `Common`-project related code-generated artefacts have all been updated to leverage `global using` and file scoped namespace declarations. - A new [`GlobalUsings.cs`](./templates/Beef.Template.Solution/content/Company.AppName.Common/GlobalUsings.cs) will need to be manually added to existing `Common` projects to enable; see [this](./templates/Beef.Template.Solution/content/Company.AppName.Common/GlobalUsings.cs) for an example and alter the last two namespaces accordingly. - The `*.Common.csproj` will need to be manually updated to include `<LangVersion>Preview</LangVersion>` and `<ImplicitUsings>true</ImplicitUsings>`.
Avanade · Oct 16, 2024 · 0abecdb · 0abecdb
1 parent 063d954
commit 0abecdb
Show file tree

Hide file tree

Showing 139 changed files with 4,250 additions and 5,039 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 Represents the **NuGet** versions.
 
+## v5.17.0
+- *Enhancement:* The `Common`-project related code-generated artefacts have all been updated to leverage `global using` and file scoped namespace declarations.
+  - A new [`GlobalUsings.cs`](./templates/Beef.Template.Solution/content/Company.AppName.Common/GlobalUsings.cs) will need to be manually added to existing `Common` projects to enable; see [this](./templates/Beef.Template.Solution/content/Company.AppName.Common/GlobalUsings.cs) for an example and alter the last two namespaces accordingly. 
+  - The `*.Common.csproj` will need to be manually updated to include `<LangVersion>Preview</LangVersion>` and `<ImplicitUsings>true</ImplicitUsings>`.
+
 ## v5.16.2
 - *Fixed:* `Operation.AuthEntity` and `Operation.AuthOperation` updated to code-gen the `Manager`-based authorization (`ExecutionContent.UserIsAuthorized`) invocation.
 - *Fixed:* Code-generation logging/auditing of endpoints updated to also include the authorization configuration.

diff --git a/Common.targets b/Common.targets
@@ -1,6 +1,6 @@
 <Project>
 	<PropertyGroup>
-		<Version>5.16.2</Version>
+		<Version>5.17.0</Version>
 		<LangVersion>preview</LangVersion>
 		<Authors>Avanade</Authors>
 		<Company>Avanade</Company>

diff --git a/docs/Entity-CodeGeneration-Config.md b/docs/Entity-CodeGeneration-Config.md
@@ -35,8 +35,9 @@ Category | Description
 [`OData`](#OData) | Provides the _OData Data-layer_ configuration.
 [`HttpAgent`](#HttpAgent) | Provides the _HTTP Agent Data-layer_ configuration.
 [`gRPC`](#gRPC) | Provides the _gRPC_ configuration.
-[`Path`](#Path) | Provides the _Path (Directory)_ configuration for the generated artefacts.
-[`Namespace`](#Namespace) | Provides the _.NET Namespace_ configuration for the generated artefacts.
+[`Path`](#Path) | Provides the _Path (Directory)_ configuration.
+[`Namespace`](#Namespace) | Provides the _.NET Namespace_ configuration.
+[`Auth`](#Auth) | Provides the _Authorization_ configuration.
 [`Collections`](#Collections) | Provides related child (hierarchical) configuration.
 
 The properties with a bold name are those that are more typically used (considered more important).
@@ -188,7 +189,7 @@ Property | Description
 <br/>
 
 ## Path
-Provides the _Path (Directory)_ configuration for the generated artefacts.
+Provides the _Path (Directory)_ configuration.
 
 Property | Description
 -|-
@@ -200,7 +201,7 @@ Property | Description
 <br/>
 
 ## Namespace
-Provides the _.NET Namespace_ configuration for the generated artefacts.
+Provides the _.NET Namespace_ configuration.
 
 Property | Description
 -|-
@@ -211,6 +212,18 @@ Property | Description
 
 <br/>
 
+## Auth
+Provides the _Authorization_ configuration.
+
+Property | Description
+-|-
+`authActionCreate` | The default `Operation.AuthAction` for an `Operation.Type` of `Create`.<br/>&dagger; Defaults to `Create`.
+`authActionRead` | The default `Operation.AuthAction` for an `Operation.Type` of `Get` or `GetColl`.<br/>&dagger; Defaults to `Read`.
+`authActionUpdate` | The default `Operation.AuthAction` for an `Operation.Type` of `Update`.<br/>&dagger; Defaults to `Update`.
+`authActionDelete` | The default `Operation.AuthAction` for an `Operation.Type` of `Delete`.<br/>&dagger; Defaults to `Delete`.
+
+<br/>
+
 ## Collections
 Provides related child (hierarchical) configuration.
 

diff --git a/samples/Cdr.Banking/Cdr.Banking.Business/Data/Model/Generated/Account.cs b/samples/Cdr.Banking/Cdr.Banking.Business/Data/Model/Generated/Account.cs
@@ -2,91 +2,90 @@
  * This file is automatically generated; any changes will be lost. 
  */
 
-namespace Cdr.Banking.Business.Data.Model
+namespace Cdr.Banking.Business.Data.Model;
+
+/// <summary>
+/// Represents the Account model for data persistence model.
+/// </summary>
+public partial class Account : IIdentifier<string>
 {
     /// <summary>
-    /// Represents the Account model for data persistence model.
-    /// </summary>
-    public partial class Account : IIdentifier<string>
-    {
-        /// <summary>
-        /// Gets or sets the identifier.
-        /// </summary>
-        public string? Id { get; set; }
-
-        /// <summary>
-        /// Gets or sets the Creation Date.
-        /// </summary>
-        public DateTime CreationDate { get; set; }
-
-        /// <summary>
-        /// Gets or sets the Display Name.
-        /// </summary>
-        public string? DisplayName { get; set; }
-
-        /// <summary>
-        /// Gets or sets the Nickname.
-        /// </summary>
-        public string? Nickname { get; set; }
-
-        /// <summary>
-        /// Gets or sets the Open Status.
-        /// </summary>
-        public string? OpenStatus { get; set; }
-
-        /// <summary>
-        /// Indicates whether Is Owned.
-        /// </summary>
-        public bool IsOwned { get; set; }
-
-        /// <summary>
-        /// Gets or sets the Masked Number.
-        /// </summary>
-        public string? MaskedNumber { get; set; }
-
-        /// <summary>
-        /// Gets or sets the Product Category.
-        /// </summary>
-        public string? ProductCategory { get; set; }
-
-        /// <summary>
-        /// Gets or sets the Product Name.
-        /// </summary>
-        public string? ProductName { get; set; }
-
-        /// <summary>
-        /// Gets or sets the Bsb.
-        /// </summary>
-        public string? Bsb { get; set; }
-
-        /// <summary>
-        /// Gets or sets the Account Number.
-        /// </summary>
-        public string? AccountNumber { get; set; }
-
-        /// <summary>
-        /// Gets or sets the Bundle Name.
-        /// </summary>
-        public string? BundleName { get; set; }
-
-        /// <summary>
-        /// Gets or sets the Specific Account U Type.
-        /// </summary>
-        public string? SpecificAccountUType { get; set; }
-
-        /// <summary>
-        /// Gets or sets the Term Deposit.
-        /// </summary>
-        public TermDepositAccount? TermDeposit { get; set; }
-
-        /// <summary>
-        /// Gets or sets the Credit Card.
-        /// </summary>
-        public CreditCardAccount? CreditCard { get; set; }
-
-        /// <summary>
-        /// Gets or sets the Balance.
-        /// </summary>
-        public Balance? Balance { get; set; }
-    }
-}
+    /// Gets or sets the identifier.
+    /// </summary>
+    public string? Id { get; set; }
+
+    /// <summary>
+    /// Gets or sets the Creation Date.
+    /// </summary>
+    public DateTime CreationDate { get; set; }
+
+    /// <summary>
+    /// Gets or sets the Display Name.
+    /// </summary>
+    public string? DisplayName { get; set; }
+
+    /// <summary>
+    /// Gets or sets the Nickname.
+    /// </summary>
+    public string? Nickname { get; set; }
+
+    /// <summary>
+    /// Gets or sets the Open Status.
+    /// </summary>
+    public string? OpenStatus { get; set; }
+
+    /// <summary>
+    /// Indicates whether Is Owned.
+    /// </summary>
+    public bool IsOwned { get; set; }
+
+    /// <summary>
+    /// Gets or sets the Masked Number.
+    /// </summary>
+    public string? MaskedNumber { get; set; }
+
+    /// <summary>
+    /// Gets or sets the Product Category.
+    /// </summary>
+    public string? ProductCategory { get; set; }
+
+    /// <summary>
+    /// Gets or sets the Product Name.
+    /// </summary>
+    public string? ProductName { get; set; }
+
+    /// <summary>
+    /// Gets or sets the Bsb.
+    /// </summary>
+    public string? Bsb { get; set; }
+
+    /// <summary>
+    /// Gets or sets the Account Number.
+    /// </summary>
+    public string? AccountNumber { get; set; }
+
+    /// <summary>
+    /// Gets or sets the Bundle Name.
+    /// </summary>
+    public string? BundleName { get; set; }
+
+    /// <summary>
+    /// Gets or sets the Specific Account U Type.
+    /// </summary>
+    public string? SpecificAccountUType { get; set; }
+
+    /// <summary>
+    /// Gets or sets the Term Deposit.
+    /// </summary>
+    public TermDepositAccount? TermDeposit { get; set; }
+
+    /// <summary>
+    /// Gets or sets the Credit Card.
+    /// </summary>
+    public CreditCardAccount? CreditCard { get; set; }
+
+    /// <summary>
+    /// Gets or sets the Balance.
+    /// </summary>
+    public Balance? Balance { get; set; }
+}
diff --git a/samples/Cdr.Banking/Cdr.Banking.Business/Data/Model/Generated/AccountUType.cs b/samples/Cdr.Banking/Cdr.Banking.Business/Data/Model/Generated/AccountUType.cs
@@ -2,15 +2,14 @@
  * This file is automatically generated; any changes will be lost. 
  */
 
-namespace Cdr.Banking.Business.Data.Model
-{
-    /// <summary>
-    /// Represents the Account U Type model.
-    /// </summary>
-    public partial class AccountUType : ReferenceDataBase<Guid> { }
+namespace Cdr.Banking.Business.Data.Model;
 
-    /// <summary>
-    /// Represents the <see cref="AccountUType"/> collection.
-    /// </summary>
-    public partial class AccountUTypeCollection : List<AccountUType> { }
-}
+/// <summary>
+/// Represents the Account U Type model.
+/// </summary>
+public partial class AccountUType : ReferenceDataBase<Guid> { }
+
+/// <summary>
+/// Represents the <see cref="AccountUType"/> collection.
+/// </summary>
+public partial class AccountUTypeCollection : List<AccountUType> { }
diff --git a/samples/Cdr.Banking/Cdr.Banking.Business/Data/Model/Generated/Balance.cs b/samples/Cdr.Banking/Cdr.Banking.Business/Data/Model/Generated/Balance.cs
@@ -2,41 +2,40 @@
  * This file is automatically generated; any changes will be lost. 
  */
 
-namespace Cdr.Banking.Business.Data.Model
+namespace Cdr.Banking.Business.Data.Model;
+
+/// <summary>
+/// Represents the Balance model.
+/// </summary>
+public partial class Balance
 {
     /// <summary>
-    /// Represents the Balance model.
+    /// Gets or sets the Current Balance.
     /// </summary>
-    public partial class Balance
-    {
-        /// <summary>
-        /// Gets or sets the Current Balance.
-        /// </summary>
-        public decimal CurrentBalance { get; set; }
+    public decimal CurrentBalance { get; set; }
 
-        /// <summary>
-        /// Gets or sets the Available Balance.
-        /// </summary>
-        public decimal AvailableBalance { get; set; }
+    /// <summary>
+    /// Gets or sets the Available Balance.
+    /// </summary>
+    public decimal AvailableBalance { get; set; }
 
-        /// <summary>
-        /// Gets or sets the Credit Limit.
-        /// </summary>
-        public decimal CreditLimit { get; set; }
+    /// <summary>
+    /// Gets or sets the Credit Limit.
+    /// </summary>
+    public decimal CreditLimit { get; set; }
 
-        /// <summary>
-        /// Gets or sets the Amortised Limit.
-        /// </summary>
-        public decimal AmortisedLimit { get; set; }
+    /// <summary>
+    /// Gets or sets the Amortised Limit.
+    /// </summary>
+    public decimal AmortisedLimit { get; set; }
 
-        /// <summary>
-        /// Gets or sets the Currency.
-        /// </summary>
-        public string? Currency { get; set; }
+    /// <summary>
+    /// Gets or sets the Currency.
+    /// </summary>
+    public string? Currency { get; set; }
 
-        /// <summary>
-        /// Gets or sets the Purses.
-        /// </summary>
-        public BalancePurseCollection? Purses { get; set; }
-    }
-}
+    /// <summary>
+    /// Gets or sets the Purses.
+    /// </summary>
+    public BalancePurseCollection? Purses { get; set; }
+}
diff --git a/samples/Cdr.Banking/Cdr.Banking.Business/Data/Model/Generated/BalancePurse.cs b/samples/Cdr.Banking/Cdr.Banking.Business/Data/Model/Generated/BalancePurse.cs
@@ -2,26 +2,25 @@
  * This file is automatically generated; any changes will be lost. 
  */
 
-namespace Cdr.Banking.Business.Data.Model
+namespace Cdr.Banking.Business.Data.Model;
+
+/// <summary>
+/// Represents the <see cref="Balance"/> Purse model.
+/// </summary>
+public partial class BalancePurse
 {
     /// <summary>
-    /// Represents the <see cref="Balance"/> Purse model.
+    /// Gets or sets the Amount.
     /// </summary>
-    public partial class BalancePurse
-    {
-        /// <summary>
-        /// Gets or sets the Amount.
-        /// </summary>
-        public decimal Amount { get; set; }
-
-        /// <summary>
-        /// Gets or sets the Currency.
-        /// </summary>
-        public string? Currency { get; set; }
-    }
+    public decimal Amount { get; set; }
 
     /// <summary>
-    /// Represents the <see cref="BalancePurse"/> collection.
+    /// Gets or sets the Currency.
     /// </summary>
-    public partial class BalancePurseCollection : List<BalancePurse> { }
-}
+    public string? Currency { get; set; }
+}
+
+/// <summary>
+/// Represents the <see cref="BalancePurse"/> collection.
+/// </summary>
+public partial class BalancePurseCollection : List<BalancePurse> { }