feat: add NestedObjectValueOf

.changelog/59.txt

@@ -0,0 +1,7 @@
+```release-note:dependency
+deps: bumps github.com/FrangipaneTeam/terraform-plugin-framework-supertypes from v0.1.0 to v0.2.0
+```
+
+```release-note:feature
+`Attributs` - Add `SuperListNestedAttributeOf`, `SuperSetNestedAttributeOf`, `SuperMapNestedAttributeOf` and `SuperSingleNestedAttributeOf` to create nested attributes with generic struct.
+```

go.mod

@@ -3,8 +3,13 @@ module github.com/FrangipaneTeam/terraform-plugin-framework-superschema
 go 1.20
 
 require (
+<<<<<<< HEAD
 	github.com/FrangipaneTeam/terraform-plugin-framework-supertypes v0.1.0
 	github.com/hashicorp/terraform-plugin-framework v1.4.2
+=======
+	github.com/FrangipaneTeam/terraform-plugin-framework-supertypes v0.2.0
+	github.com/hashicorp/terraform-plugin-framework v1.4.1
+>>>>>>> 404bec7 (feat: add NestedObjectValueOf)
 	github.com/hashicorp/terraform-plugin-framework-timeouts v0.4.1
 	github.com/iancoleman/strcase v0.3.0
 )

go.sum

@@ -1,5 +1,5 @@
-github.com/FrangipaneTeam/terraform-plugin-framework-supertypes v0.1.0 h1:QHcnFyAQy/yWcBargdCt8Eprnh7G7vOYOw7z/4LOlM8=
-github.com/FrangipaneTeam/terraform-plugin-framework-supertypes v0.1.0/go.mod h1:GGgBv/UI8efmEok0VJWSxp3m6GdkETqzJf5SWH83aDs=
+github.com/FrangipaneTeam/terraform-plugin-framework-supertypes v0.2.0 h1:lcJY8AEbpbYp/M/jPUdYZArsZKAkM2LECSYDfKOiIiQ=
+github.com/FrangipaneTeam/terraform-plugin-framework-supertypes v0.2.0/go.mod h1:Aux7edspqsudNKr9YFgCkAgUwFj44RyOV123XolOzjY=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -34,8 +34,8 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.7.2 h1:4jaiDzPyXQvSd7D0EjG45355tLlV3VOECpq10pLC+8s=
 github.com/stretchr/testify v1.7.2/go.mod h1:R6va5+xMeoiuVRoj+gSkQ7d3FALtqAAGI1FQKckRals=
+github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
 github.com/vmihailenco/msgpack/v5 v5.3.5 h1:5gO0H1iULLWGhs2H5tbAHIZTV8/cYafcFOr9znI5mJU=
 github.com/vmihailenco/msgpack/v5 v5.3.5/go.mod h1:7xyJ9e+0+9SaZT0Wt1RGleJXzli6Q/V5KbhBonMG9jc=
 github.com/vmihailenco/tagparser/v2 v2.0.0 h1:y09buUbR+b5aycVFQs/g70pqKVZNBmxwAhO7/IwNM9g=

superlist_nested_attribute.go

@@ -4,7 +4,7 @@ package superschema
 import (
 	"context"
 
-	"github.com/FrangipaneTeam/terraform-plugin-framework-supertypes"
+	supertypes "github.com/FrangipaneTeam/terraform-plugin-framework-supertypes"
 	schemaD "github.com/hashicorp/terraform-plugin-framework/datasource/schema"
 	schemaR "github.com/hashicorp/terraform-plugin-framework/resource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
@@ -160,3 +160,147 @@ func (s SuperListNestedAttribute) GetDataSource(ctx context.Context) schemaD.Att
 	a.MarkdownDescription = genDataSourceAttrDescription(ctx, a.MarkdownDescription, deprecationMessage, a.Validators)
 	return a
 }
+
+// * SuperTypeOf
+
+var _ Attribute = SuperListNestedAttributeOf[struct{}]{}
+
+type SuperListNestedAttributeOf[T any] struct {
+	Deprecated *Deprecated
+	Common     *schemaR.ListNestedAttribute
+	Resource   *schemaR.ListNestedAttribute
+	DataSource *schemaD.ListNestedAttribute
+	Attributes Attributes
+}
+
+// IsResource returns true if the attribute is a resource attribute.
+func (s SuperListNestedAttributeOf[T]) IsResource() bool {
+	return s.Resource != nil || s.Common != nil
+}
+
+// IsDataSource returns true if the attribute is a data source attribute.
+func (s SuperListNestedAttributeOf[T]) IsDataSource() bool {
+	return s.DataSource != nil || s.Common != nil
+}
+
+//nolint:dupl
+func (s SuperListNestedAttributeOf[T]) GetResource(ctx context.Context) schemaR.Attribute {
+	var (
+		common   schemaR.ListNestedAttribute
+		resource schemaR.ListNestedAttribute
+	)
+
+	if s.Common != nil {
+		common = *s.Common
+	}
+
+	if s.Resource != nil {
+		resource = *s.Resource
+	}
+
+	a := schemaR.ListNestedAttribute{
+		Required:            computeIsRequired(common, resource),
+		Optional:            computeIsOptional(common, resource),
+		Computed:            computeIsComputed(common, resource),
+		Sensitive:           computeIsSensitive(common, resource),
+		MarkdownDescription: computeMarkdownDescription(common, resource),
+		Description:         computeDescription(common, resource),
+		DeprecationMessage:  computeDeprecationMessage(common, resource),
+		NestedObject: schemaR.NestedAttributeObject{
+			Attributes: s.Attributes.process(ctx, resourceT).(map[string]schemaR.Attribute),
+		},
+	}
+
+	a.Validators = append(a.Validators, common.Validators...)
+	a.Validators = append(a.Validators, resource.Validators...)
+	a.PlanModifiers = append(a.PlanModifiers, common.PlanModifiers...)
+	a.PlanModifiers = append(a.PlanModifiers, resource.PlanModifiers...)
+
+	defaultVDescription := ""
+
+	if s.Common != nil {
+		if s.Common.CustomType != nil {
+			a.CustomType = s.Common.CustomType
+		}
+	}
+
+	if s.Resource != nil {
+		if s.Resource.Default != nil {
+			a.Default = s.Resource.Default
+			defaultVDescription = s.Resource.Default.MarkdownDescription(ctx)
+		}
+		if s.Resource.CustomType != nil {
+			a.CustomType = s.Resource.CustomType
+		}
+	}
+	// * If user has not provided a custom type, we will use the default supertypes
+	if a.CustomType == nil {
+		a.CustomType = supertypes.NewListNestedObjectTypeOf[T](ctx)
+	}
+
+	deprecationMessage := ""
+	if s.Deprecated != nil {
+		a.DeprecationMessage = s.Deprecated.DeprecationMessage
+		deprecationMessage = s.Deprecated.computeDeprecatedDocumentation()
+	}
+
+	a.MarkdownDescription = genResourceAttrDescription(ctx, a.MarkdownDescription, defaultVDescription, deprecationMessage, a.Validators, a.PlanModifiers)
+	return a
+}
+
+//nolint:dupl
+func (s SuperListNestedAttributeOf[T]) GetDataSource(ctx context.Context) schemaD.Attribute {
+	var (
+		common     schemaR.ListNestedAttribute
+		dataSource schemaD.ListNestedAttribute
+	)
+
+	if s.Common != nil {
+		common = *s.Common
+	}
+
+	if s.DataSource != nil {
+		dataSource = *s.DataSource
+	}
+
+	a := schemaD.ListNestedAttribute{
+		Required:            computeIsRequired(common, dataSource),
+		Optional:            computeIsOptional(common, dataSource),
+		Computed:            computeIsComputed(common, dataSource),
+		Sensitive:           computeIsSensitive(common, dataSource),
+		MarkdownDescription: computeMarkdownDescription(common, dataSource),
+		Description:         computeDescription(common, dataSource),
+		DeprecationMessage:  computeDeprecationMessage(common, dataSource),
+		NestedObject: schemaD.NestedAttributeObject{
+			Attributes: s.Attributes.process(ctx, dataSourceT).(map[string]schemaD.Attribute),
+		},
+	}
+
+	a.Validators = append(a.Validators, common.Validators...)
+	a.Validators = append(a.Validators, dataSource.Validators...)
+
+	if s.Common != nil {
+		if s.Common.CustomType != nil {
+			a.CustomType = s.Common.CustomType
+		}
+	}
+
+	if s.DataSource != nil {
+		if s.DataSource.CustomType != nil {
+			a.CustomType = s.DataSource.CustomType
+		}
+	}
+	// * If user has not provided a custom type, we will use the default supertypes
+	if a.CustomType == nil {
+		a.CustomType = supertypes.NewListNestedObjectTypeOf[T](ctx)
+	}
+
+	deprecationMessage := ""
+	if s.Deprecated != nil {
+		a.DeprecationMessage = s.Deprecated.DeprecationMessage
+		deprecationMessage = s.Deprecated.computeDeprecatedDocumentation()
+	}
+
+	a.MarkdownDescription = genDataSourceAttrDescription(ctx, a.MarkdownDescription, deprecationMessage, a.Validators)
+	return a
+}

supermap_nested_attribute.go

@@ -160,3 +160,147 @@ func (s SuperMapNestedAttribute) GetDataSource(ctx context.Context) schemaD.Attr
 	a.MarkdownDescription = genDataSourceAttrDescription(ctx, a.MarkdownDescription, deprecationMessage, a.Validators)
 	return a
 }
+
+// * SuperTypeOf
+
+var _ Attribute = SuperMapNestedAttributeOf[struct{}]{}
+
+type SuperMapNestedAttributeOf[T any] struct {
+	Deprecated *Deprecated
+	Common     *schemaR.MapNestedAttribute
+	Resource   *schemaR.MapNestedAttribute
+	DataSource *schemaD.MapNestedAttribute
+	Attributes Attributes
+}
+
+// IsResource returns true if the attribute is a resource attribute.
+func (s SuperMapNestedAttributeOf[T]) IsResource() bool {
+	return s.Resource != nil || s.Common != nil
+}
+
+// IsDataSource returns true if the attribute is a data source attribute.
+func (s SuperMapNestedAttributeOf[T]) IsDataSource() bool {
+	return s.DataSource != nil || s.Common != nil
+}
+
+//nolint:dupl
+func (s SuperMapNestedAttributeOf[T]) GetResource(ctx context.Context) schemaR.Attribute {
+	var (
+		common   schemaR.MapNestedAttribute
+		resource schemaR.MapNestedAttribute
+	)
+
+	if s.Common != nil {
+		common = *s.Common
+	}
+
+	if s.Resource != nil {
+		resource = *s.Resource
+	}
+
+	a := schemaR.MapNestedAttribute{
+		Required:            computeIsRequired(common, resource),
+		Optional:            computeIsOptional(common, resource),
+		Computed:            computeIsComputed(common, resource),
+		Sensitive:           computeIsSensitive(common, resource),
+		MarkdownDescription: computeMarkdownDescription(common, resource),
+		Description:         computeDescription(common, resource),
+		DeprecationMessage:  computeDeprecationMessage(common, resource),
+		NestedObject: schemaR.NestedAttributeObject{
+			Attributes: s.Attributes.process(ctx, resourceT).(map[string]schemaR.Attribute),
+		},
+	}
+
+	a.Validators = append(a.Validators, common.Validators...)
+	a.Validators = append(a.Validators, resource.Validators...)
+	a.PlanModifiers = append(a.PlanModifiers, common.PlanModifiers...)
+	a.PlanModifiers = append(a.PlanModifiers, resource.PlanModifiers...)
+
+	defaultVDescription := ""
+
+	if s.Common != nil {
+		if s.Common.CustomType != nil {
+			a.CustomType = s.Common.CustomType
+		}
+	}
+
+	if s.Resource != nil {
+		if s.Resource.Default != nil {
+			a.Default = s.Resource.Default
+			defaultVDescription = s.Resource.Default.MarkdownDescription(ctx)
+		}
+		if s.Resource.CustomType != nil {
+			a.CustomType = s.Resource.CustomType
+		}
+	}
+	// * If user has not provided a custom type, we will use the default supertypes
+	if a.CustomType == nil {
+		a.CustomType = supertypes.MapNestedObjectTypeOf[T]{}.MapType
+	}
+
+	deprecationMessage := ""
+	if s.Deprecated != nil {
+		a.DeprecationMessage = s.Deprecated.DeprecationMessage
+		deprecationMessage = s.Deprecated.computeDeprecatedDocumentation()
+	}
+
+	a.MarkdownDescription = genResourceAttrDescription(ctx, a.MarkdownDescription, defaultVDescription, deprecationMessage, a.Validators, a.PlanModifiers)
+	return a
+}
+
+//nolint:dupl
+func (s SuperMapNestedAttributeOf[T]) GetDataSource(ctx context.Context) schemaD.Attribute {
+	var (
+		common     schemaR.MapNestedAttribute
+		dataSource schemaD.MapNestedAttribute
+	)
+
+	if s.Common != nil {
+		common = *s.Common
+	}
+
+	if s.DataSource != nil {
+		dataSource = *s.DataSource
+	}
+
+	a := schemaD.MapNestedAttribute{
+		Required:            computeIsRequired(common, dataSource),
+		Optional:            computeIsOptional(common, dataSource),
+		Computed:            computeIsComputed(common, dataSource),
+		Sensitive:           computeIsSensitive(common, dataSource),
+		MarkdownDescription: computeMarkdownDescription(common, dataSource),
+		Description:         computeDescription(common, dataSource),
+		DeprecationMessage:  computeDeprecationMessage(common, dataSource),
+		NestedObject: schemaD.NestedAttributeObject{
+			Attributes: s.Attributes.process(ctx, dataSourceT).(map[string]schemaD.Attribute),
+		},
+	}
+
+	a.Validators = append(a.Validators, common.Validators...)
+	a.Validators = append(a.Validators, dataSource.Validators...)
+
+	if s.Common != nil {
+		if s.Common.CustomType != nil {
+			a.CustomType = s.Common.CustomType
+		}
+	}
+
+	if s.DataSource != nil {
+		if s.DataSource.CustomType != nil {
+			a.CustomType = s.DataSource.CustomType
+		}
+	}
+	// * If user has not provided a custom type, we will use the default supertypes
+	if a.CustomType == nil {
+		a.CustomType = supertypes.MapNestedObjectTypeOf[T]{}.MapType
+	}
+
+	deprecationMessage := ""
+	if s.Deprecated != nil {
+		a.DeprecationMessage = s.Deprecated.DeprecationMessage
+		deprecationMessage = s.Deprecated.computeDeprecatedDocumentation()
+	}
+
+	a.MarkdownDescription = genDataSourceAttrDescription(ctx, a.MarkdownDescription, deprecationMessage, a.Validators)
+	return a
+}