pocket-id-pocket-id-2/backend/internal/model/audit_log.go

package model

import (
	"database/sql/driver"
	"encoding/json"

	"github.com/pocket-id/pocket-id/backend/internal/utils"
)

type AuditLog struct {
	Base

	Event     AuditLogEvent `sortable:"true" filterable:"true"`
	IpAddress *string       `sortable:"true"`
	Country   string        `sortable:"true"`
	City      string        `sortable:"true"`
	UserAgent string        `sortable:"true"`
	Username  string        `gorm:"-"`
	Data      AuditLogData

	UserID string `filterable:"true"`
	User   User
}

type AuditLogData map[string]string //nolint:recvcheck

type AuditLogEvent string //nolint:recvcheck

const (
	AuditLogEventSignIn                     AuditLogEvent = "SIGN_IN"
	AuditLogEventOneTimeAccessTokenSignIn   AuditLogEvent = "TOKEN_SIGN_IN"
	AuditLogEventAccountCreated             AuditLogEvent = "ACCOUNT_CREATED"
	AuditLogEventClientAuthorization        AuditLogEvent = "CLIENT_AUTHORIZATION"
	AuditLogEventNewClientAuthorization     AuditLogEvent = "NEW_CLIENT_AUTHORIZATION"
	AuditLogEventDeviceCodeAuthorization    AuditLogEvent = "DEVICE_CODE_AUTHORIZATION"
	AuditLogEventNewDeviceCodeAuthorization AuditLogEvent = "NEW_DEVICE_CODE_AUTHORIZATION"
	AuditLogEventPasskeyAdded               AuditLogEvent = "PASSKEY_ADDED"
	AuditLogEventPasskeyRemoved             AuditLogEvent = "PASSKEY_REMOVED"
)

// Scan and Value methods for GORM to handle the custom type

func (e *AuditLogEvent) Scan(value any) error {
	*e = AuditLogEvent(value.(string))
	return nil
}

func (e AuditLogEvent) Value() (driver.Value, error) {
	return string(e), nil
}

func (d *AuditLogData) Scan(value any) error {
	return utils.UnmarshalJSONFromDatabase(d, value)
}

func (d AuditLogData) Value() (driver.Value, error) {
	return json.Marshal(d)
}