feat: implement people api

This commit is contained in:
2026-06-01 11:30:02 -04:00
parent f581951019
commit 4fb7e476c1
3 changed files with 322 additions and 0 deletions
+210
View File
@@ -0,0 +1,210 @@
package provider
import (
"context"
"fmt"
"github.com/hashicorp/terraform-plugin-framework/path"
"github.com/hashicorp/terraform-plugin-framework/resource"
"github.com/hashicorp/terraform-plugin-framework/resource/schema"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/booldefault"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/immich-app/terraform-provider-immich/internal/client"
)
// Ensure the implementation satisfies the expected interfaces.
var _ resource.Resource = &personResource{}
var _ resource.ResourceWithImportState = &personResource{}
func NewPersonResource() resource.Resource {
return &personResource{}
}
// personResource defines the resource implementation.
type personResource struct {
client *client.Client
}
// personResourceModel describes the resource data model.
type personResourceModel struct {
ID types.String `tfsdk:"id"`
Name types.String `tfsdk:"name"`
BirthDate types.String `tfsdk:"birth_date"`
IsHidden types.Bool `tfsdk:"is_hidden"`
IsFavorite types.Bool `tfsdk:"is_favorite"`
}
func (r *personResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
resp.TypeName = req.ProviderTypeName + "_person"
}
func (r *personResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {
resp.Schema = schema.Schema{
MarkdownDescription: "Manages an Immich person. Note: Persons are usually created automatically by Immich facial recognition. This resource is used to update their details.",
Attributes: map[string]schema.Attribute{
"id": schema.StringAttribute{
Required: true,
MarkdownDescription: "Unique identifier for the person.",
PlanModifiers: []planmodifier.String{
stringplanmodifier.RequiresReplace(),
},
},
"name": schema.StringAttribute{
Optional: true,
Computed: true,
MarkdownDescription: "Name of the person.",
},
"birth_date": schema.StringAttribute{
Optional: true,
Computed: true,
MarkdownDescription: "Birth date of the person (ISO 8601).",
},
"is_hidden": schema.BoolAttribute{
Optional: true,
Computed: true,
Default: booldefault.StaticBool(false),
MarkdownDescription: "Whether the person is hidden from the UI.",
},
"is_favorite": schema.BoolAttribute{
Optional: true,
Computed: true,
Default: booldefault.StaticBool(false),
MarkdownDescription: "Whether the person is marked as a favorite.",
},
},
}
}
func (r *personResource) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse) {
if req.ProviderData == nil {
return
}
client, ok := req.ProviderData.(*client.Client)
if !ok {
resp.Diagnostics.AddError(
"Unexpected Resource Configure Type",
fmt.Sprintf("Expected *client.Client, got: %T. Please report this issue to the provider developers.", req.ProviderData),
)
return
}
r.client = client
}
func (r *personResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
// Persons are not created via POST /people, but usually discovered.
// We'll treat Create as an Update if the person exists.
var data personResourceModel
resp.Diagnostics.Append(req.Plan.Get(ctx, &data)...)
if resp.Diagnostics.HasError() {
return
}
isHidden := data.IsHidden.ValueBool()
isFavorite := data.IsFavorite.ValueBool()
updateReq := client.UpdatePersonRequest{
Name: data.Name.ValueString(),
BirthDate: data.BirthDate.ValueString(),
IsHidden: &isHidden,
IsFavorite: &isFavorite,
}
person, err := r.client.UpdatePerson(data.ID.ValueString(), updateReq)
if err != nil {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to update person, got error: %s", err))
return
}
data.Name = types.StringValue(person.Name)
data.BirthDate = types.StringValue(person.BirthDate)
data.IsHidden = types.BoolValue(person.IsHidden)
data.IsFavorite = types.BoolValue(person.IsFavorite)
resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
}
func (r *personResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) {
var data personResourceModel
resp.Diagnostics.Append(req.State.Get(ctx, &data)...)
if resp.Diagnostics.HasError() {
return
}
person, err := r.client.GetPerson(data.ID.ValueString())
if err != nil {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to read person, got error: %s", err))
return
}
data.Name = types.StringValue(person.Name)
data.BirthDate = types.StringValue(person.BirthDate)
data.IsHidden = types.BoolValue(person.IsHidden)
data.IsFavorite = types.BoolValue(person.IsFavorite)
resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
}
func (r *personResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) {
var data personResourceModel
resp.Diagnostics.Append(req.Plan.Get(ctx, &data)...)
if resp.Diagnostics.HasError() {
return
}
isHidden := data.IsHidden.ValueBool()
isFavorite := data.IsFavorite.ValueBool()
updateReq := client.UpdatePersonRequest{
Name: data.Name.ValueString(),
BirthDate: data.BirthDate.ValueString(),
IsHidden: &isHidden,
IsFavorite: &isFavorite,
}
person, err := r.client.UpdatePerson(data.ID.ValueString(), updateReq)
if err != nil {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to update person, got error: %s", err))
return
}
data.Name = types.StringValue(person.Name)
data.BirthDate = types.StringValue(person.BirthDate)
data.IsHidden = types.BoolValue(person.IsHidden)
data.IsFavorite = types.BoolValue(person.IsFavorite)
resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
}
func (r *personResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) {
// Deleting a person in Immich usually just removes the person record, faces remain.
var data personResourceModel
resp.Diagnostics.Append(req.State.Get(ctx, &data)...)
if resp.Diagnostics.HasError() {
return
}
err := r.client.DeletePerson(data.ID.ValueString())
if err != nil {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to delete person, got error: %s", err))
return
}
}
func (r *personResource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse) {
resource.ImportStatePassthroughID(ctx, path.Root("id"), req, resp)
}
+1
View File
@@ -93,6 +93,7 @@ func (p *immichProvider) Resources(ctx context.Context) []func() resource.Resour
NewSystemConfigResource,
NewLibraryResource,
NewActivityResource,
NewPersonResource,
}
}