Merge pull request #19625 from abpframework/nolayers

Add GlobalFeatureConfigurator and ModuleExtensionConfigurator to nolayers template

templates/app-nolayers/aspnet-core/MyCompanyName.MyProjectName.Blazor.Server.Mongo/MyProjectNameGlobalFeatureConfigurator.cs

@@ -0,0 +1,19 @@
+using Volo.Abp.Threading;
+
+namespace MyCompanyName.MyProjectName;
+
+public static class MyProjectNameGlobalFeatureConfigurator
+{
+    private static readonly OneTimeRunner OneTimeRunner = new OneTimeRunner();
+
+    public static void Configure()
+    {
+        OneTimeRunner.Run(() =>
+        {
+            /* You can configure (enable/disable) global features of the used modules here.
+             * Please refer to the documentation to learn more about the Global Features System:
+             * https://docs.abp.io/en/abp/latest/Global-Features
+             */
+        });
+    }
+}

templates/app-nolayers/aspnet-core/MyCompanyName.MyProjectName.Blazor.Server.Mongo/MyProjectNameModule.cs

@@ -154,6 +154,9 @@ public override void PreConfigureServices(ServiceConfigurationContext context)
         {
             options.IsBlazorWebApp = true;
         });
+
+        MyProjectNameGlobalFeatureConfigurator.Configure();
+        MyProjectNameModuleExtensionConfigurator.Configure();
     }
 
     public override void ConfigureServices(ServiceConfigurationContext context)

templates/app-nolayers/aspnet-core/MyCompanyName.MyProjectName.Blazor.Server.Mongo/MyProjectNameModuleExtensionConfigurator.cs

@@ -0,0 +1,68 @@
+using Volo.Abp.Threading;
+
+namespace MyCompanyName.MyProjectName;
+
+public static class MyProjectNameModuleExtensionConfigurator
+{
+    private static readonly OneTimeRunner OneTimeRunner = new OneTimeRunner();
+
+    public static void Configure()
+    {
+        OneTimeRunner.Run(() =>
+        {
+            ConfigureExistingProperties();
+            ConfigureExtraProperties();
+        });
+    }
+
+    private static void ConfigureExistingProperties()
+    {
+        /* You can change max lengths for properties of the
+         * entities defined in the modules used by your application.
+         *
+         * Example: Change user and role name max lengths
+
+           AbpUserConsts.MaxNameLength = 99;
+           IdentityRoleConsts.MaxNameLength = 99;
+
+         * Notice: It is not suggested to change property lengths
+         * unless you really need it. Go with the standard values wherever possible.
+         *
+         * If you are using EF Core, you will need to run the add-migration command after your changes.
+         */
+    }
+
+    private static void ConfigureExtraProperties()
+    {
+        /* You can configure extra properties for the
+         * entities defined in the modules used by your application.
+         *
+         * This class can be used to define these extra properties
+         * with a high level, easy to use API.
+         *
+         * Example: Add a new property to the user entity of the identity module
+
+           ObjectExtensionManager.Instance.Modules()
+              .ConfigureIdentity(identity =>
+              {
+                  identity.ConfigureUser(user =>
+                  {
+                      user.AddOrUpdateProperty<string>( //property type: string
+                          "SocialSecurityNumber", //property name
+                          property =>
+                          {
+                              //validation rules
+                              property.Attributes.Add(new RequiredAttribute());
+                              property.Attributes.Add(new StringLengthAttribute(64) {MinimumLength = 4});
+
+                              //...other configurations for this property
+                          }
+                      );
+                  });
+              });
+
+         * See the documentation for more:
+         * https://docs.abp.io/en/abp/latest/Module-Entity-Extensions
+         */
+    }
+}

templates/app-nolayers/aspnet-core/MyCompanyName.MyProjectName.Blazor.Server/Data/MyProjectNameDbContextFactory.cs

@@ -11,6 +11,7 @@ public MyProjectNameDbContext CreateDbContext(string[] args)
         // https://www.npgsql.org/efcore/release-notes/6.0.html#opting-out-of-the-new-timestamp-mapping-logic
         AppContext.SetSwitch("Npgsql.EnableLegacyTimestampBehavior", true);
 //</TEMPLATE-REMOVE>
+        MyProjectNameEfCoreEntityExtensionMappings.Configure();
 
         var configuration = BuildConfiguration();
 

templates/app-nolayers/aspnet-core/MyCompanyName.MyProjectName.Blazor.Server/Data/MyProjectNameEfCoreEntityExtensionMappings.cs

@@ -0,0 +1,41 @@
+using Volo.Abp.Threading;
+
+namespace MyCompanyName.MyProjectName.Data;
+
+public static class MyProjectNameEfCoreEntityExtensionMappings
+{
+    private static readonly OneTimeRunner OneTimeRunner = new OneTimeRunner();
+
+    public static void Configure()
+    {
+        MyProjectNameGlobalFeatureConfigurator.Configure();
+        MyProjectNameModuleExtensionConfigurator.Configure();
+
+        OneTimeRunner.Run(() =>
+        {
+            /* You can configure extra properties for the
+             * entities defined in the modules used by your application.
+             *
+             * This class can be used to map these extra properties to table fields in the database.
+             *
+             * USE THIS CLASS ONLY TO CONFIGURE EF CORE RELATED MAPPING.
+             * USE MyProjectNameModuleExtensionConfigurator CLASS (in the Domain.Shared project)
+             * FOR A HIGH LEVEL API TO DEFINE EXTRA PROPERTIES TO ENTITIES OF THE USED MODULES
+             *
+             * Example: Map a property to a table field:
+
+                 ObjectExtensionManager.Instance
+                     .MapEfCoreProperty<IdentityUser, string>(
+                         "MyProperty",
+                         (entityBuilder, propertyBuilder) =>
+                         {
+                             propertyBuilder.HasMaxLength(128);
+                         }
+                     );
+
+             * See the documentation for more:
+             * https://docs.abp.io/en/abp/latest/Customizing-Application-Modules-Extending-Entities
+             */
+        });
+    }
+}

templates/app-nolayers/aspnet-core/MyCompanyName.MyProjectName.Blazor.Server/MyProjectNameGlobalFeatureConfigurator.cs

@@ -0,0 +1,19 @@
+using Volo.Abp.Threading;
+
+namespace MyCompanyName.MyProjectName;
+
+public static class MyProjectNameGlobalFeatureConfigurator
+{
+    private static readonly OneTimeRunner OneTimeRunner = new OneTimeRunner();
+
+    public static void Configure()
+    {
+        OneTimeRunner.Run(() =>
+        {
+            /* You can configure (enable/disable) global features of the used modules here.
+             * Please refer to the documentation to learn more about the Global Features System:
+             * https://docs.abp.io/en/abp/latest/Global-Features
+             */
+        });
+    }
+}

templates/app-nolayers/aspnet-core/MyCompanyName.MyProjectName.Blazor.Server/MyProjectNameModule.cs

@@ -156,6 +156,10 @@ public override void PreConfigureServices(ServiceConfigurationContext context)
         {
             options.IsBlazorWebApp = true;
         });
+
+        MyProjectNameGlobalFeatureConfigurator.Configure();
+        MyProjectNameModuleExtensionConfigurator.Configure();
+        MyProjectNameEfCoreEntityExtensionMappings.Configure();
     }
 
     public override void ConfigureServices(ServiceConfigurationContext context)

templates/app-nolayers/aspnet-core/MyCompanyName.MyProjectName.Blazor.Server/MyProjectNameModuleExtensionConfigurator.cs

@@ -0,0 +1,68 @@
+using Volo.Abp.Threading;
+
+namespace MyCompanyName.MyProjectName;
+
+public static class MyProjectNameModuleExtensionConfigurator
+{
+    private static readonly OneTimeRunner OneTimeRunner = new OneTimeRunner();
+
+    public static void Configure()
+    {
+        OneTimeRunner.Run(() =>
+        {
+            ConfigureExistingProperties();
+            ConfigureExtraProperties();
+        });
+    }
+
+    private static void ConfigureExistingProperties()
+    {
+        /* You can change max lengths for properties of the
+         * entities defined in the modules used by your application.
+         *
+         * Example: Change user and role name max lengths
+
+           AbpUserConsts.MaxNameLength = 99;
+           IdentityRoleConsts.MaxNameLength = 99;
+
+         * Notice: It is not suggested to change property lengths
+         * unless you really need it. Go with the standard values wherever possible.
+         *
+         * If you are using EF Core, you will need to run the add-migration command after your changes.
+         */
+    }
+
+    private static void ConfigureExtraProperties()
+    {
+        /* You can configure extra properties for the
+         * entities defined in the modules used by your application.
+         *
+         * This class can be used to define these extra properties
+         * with a high level, easy to use API.
+         *
+         * Example: Add a new property to the user entity of the identity module
+
+           ObjectExtensionManager.Instance.Modules()
+              .ConfigureIdentity(identity =>
+              {
+                  identity.ConfigureUser(user =>
+                  {
+                      user.AddOrUpdateProperty<string>( //property type: string
+                          "SocialSecurityNumber", //property name
+                          property =>
+                          {
+                              //validation rules
+                              property.Attributes.Add(new RequiredAttribute());
+                              property.Attributes.Add(new StringLengthAttribute(64) {MinimumLength = 4});
+
+                              //...other configurations for this property
+                          }
+                      );
+                  });
+              });
+
+         * See the documentation for more:
+         * https://docs.abp.io/en/abp/latest/Module-Entity-Extensions
+         */
+    }
+}

templates/app-nolayers/aspnet-core/MyCompanyName.MyProjectName.Blazor.WebAssembly/Server/Data/MyProjectNameDbContextFactory.cs

@@ -11,7 +11,8 @@ public MyProjectNameDbContext CreateDbContext(string[] args)
         // https://www.npgsql.org/efcore/release-notes/6.0.html#opting-out-of-the-new-timestamp-mapping-logic
         AppContext.SetSwitch("Npgsql.EnableLegacyTimestampBehavior", true);
 //</TEMPLATE-REMOVE>
-
+        MyProjectNameEfCoreEntityExtensionMappings.Configure();
+
         var configuration = BuildConfiguration();
 
         var builder = new DbContextOptionsBuilder<MyProjectNameDbContext>()

templates/app-nolayers/aspnet-core/MyCompanyName.MyProjectName.Blazor.WebAssembly/Server/Data/MyProjectNameEfCoreEntityExtensionMappings.cs

@@ -0,0 +1,41 @@
+using Volo.Abp.Threading;
+
+namespace MyCompanyName.MyProjectName.Data;
+
+public static class MyProjectNameEfCoreEntityExtensionMappings
+{
+    private static readonly OneTimeRunner OneTimeRunner = new OneTimeRunner();
+
+    public static void Configure()
+    {
+        MyProjectNameGlobalFeatureConfigurator.Configure();
+        MyProjectNameModuleExtensionConfigurator.Configure();
+
+        OneTimeRunner.Run(() =>
+        {
+            /* You can configure extra properties for the
+             * entities defined in the modules used by your application.
+             *
+             * This class can be used to map these extra properties to table fields in the database.
+             *
+             * USE THIS CLASS ONLY TO CONFIGURE EF CORE RELATED MAPPING.
+             * USE MyProjectNameModuleExtensionConfigurator CLASS (in the Domain.Shared project)
+             * FOR A HIGH LEVEL API TO DEFINE EXTRA PROPERTIES TO ENTITIES OF THE USED MODULES
+             *
+             * Example: Map a property to a table field:
+
+                 ObjectExtensionManager.Instance
+                     .MapEfCoreProperty<IdentityUser, string>(
+                         "MyProperty",
+                         (entityBuilder, propertyBuilder) =>
+                         {
+                             propertyBuilder.HasMaxLength(128);
+                         }
+                     );
+
+             * See the documentation for more:
+             * https://docs.abp.io/en/abp/latest/Customizing-Application-Modules-Extending-Entities
+             */
+        });
+    }
+}

templates/app-nolayers/aspnet-core/MyCompanyName.MyProjectName.Blazor.WebAssembly/Server/MyProjectNameHostModule.cs

@@ -138,6 +138,8 @@ public override void PreConfigureServices(ServiceConfigurationContext context)
                     serverBuilder.AddProductionEncryptionAndSigningCertificate("openiddict.pfx", "00000000-0000-0000-0000-000000000000");
                 });
             }
+
+            MyProjectNameEfCoreEntityExtensionMappings.Configure();
         }
 
         public override void ConfigureServices(ServiceConfigurationContext context)

templates/app-nolayers/aspnet-core/MyCompanyName.MyProjectName.Blazor.WebAssembly/Shared/MyProjectNameContractsModule.cs

@@ -25,6 +25,12 @@ namespace MyCompanyName.MyProjectName;
 )]
 public class MyProjectNameContractsModule : AbpModule
 {
+    public override void PreConfigureServices(ServiceConfigurationContext context)
+    {
+        MyProjectNameGlobalFeatureConfigurator.Configure();
+        MyProjectNameModuleExtensionConfigurator.Configure();
+    }
+
     public override void ConfigureServices(ServiceConfigurationContext context)
     {
         Configure<AbpVirtualFileSystemOptions>(options =>

templates/app-nolayers/aspnet-core/MyCompanyName.MyProjectName.Blazor.WebAssembly/Shared/MyProjectNameGlobalFeatureConfigurator.cs

@@ -0,0 +1,19 @@
+using Volo.Abp.Threading;
+
+namespace MyCompanyName.MyProjectName;
+
+public static class MyProjectNameGlobalFeatureConfigurator
+{
+    private static readonly OneTimeRunner OneTimeRunner = new OneTimeRunner();
+
+    public static void Configure()
+    {
+        OneTimeRunner.Run(() =>
+        {
+            /* You can configure (enable/disable) global features of the used modules here.
+             * Please refer to the documentation to learn more about the Global Features System:
+             * https://docs.abp.io/en/abp/latest/Global-Features
+             */
+        });
+    }
+}