customsession

type AdditionalFieldDefinition struct {
	Name         string             `json:"name"`
	Type         FieldType          `json:"type"`
	Required     bool               `json:"required"`
	DefaultValue any                `json:"defaultValue,omitempty"`
	Validator    func(val any) bool `json:"-"`
}

type AdditionalFieldsConfig struct {
	UserFields    []AdditionalFieldDefinition `json:"userFields"`
	SessionFields []AdditionalFieldDefinition `json:"sessionFields"`
}

type Config struct {
	// TransformFunc is an optional custom callback for dynamic session payload transformation.
	TransformFunc TransformSessionFunc

	// MutateListDeviceSessions controls whether session transformation is applied to GET /multi-session/list-device-sessions.
	// Default: false
	MutateListDeviceSessions bool

	// UserAdditionalFields contains definitions for dynamic fields on User entities.
	UserAdditionalFields []AdditionalFieldDefinition

	// SessionAdditionalFields contains definitions for dynamic fields on Session entities.
	SessionAdditionalFields []AdditionalFieldDefinition

	// FilterUnregisteredFields controls whether extra fields not explicitly registered in UserAdditionalFields/SessionAdditionalFields are omitted from response JSON.
	// Default: false
	FilterUnregisteredFields bool
}

type CustomSessionData struct {
	User    *entity.User    `json:"user"`
	Session *entity.Session `json:"session"`
	plugin.ExtraContainer
}

type FieldType string

type MemoryRepository struct {
	// contains filtered or unexported fields
}

type Option func(*Config)

type Plugin struct {
	// contains filtered or unexported fields
}

type Repository interface {
	// GetCustomUserFields retrieves dynamic additional fields associated with a specific user ID.
	//
	// Function:
	//   Called during session transformation or user retrieval to load persisted extra metadata.
	//
	// Storage:
	//   Database (GORM / SQL) or Redis Cache-Aside.
	//
	// Arguments:
	//   - ctx: Request cancellation context.
	//   - userID: Unique identifier of the target user.
	//
	// Returns:
	//   - map[string]any: Key-value map of dynamic user fields.
	//   - error: Database query error if execution fails.
	//
	// Example SQL:
	//   SELECT extra_fields FROM users WHERE id = $1 LIMIT 1;
	GetCustomUserFields(ctx context.Context, userID string) (map[string]any, error)

	// SaveCustomUserFields persists dynamic additional fields for a specific user ID.
	//
	// Function:
	//   Called when updating or initializing dynamic user attributes.
	//
	// Storage:
	//   Database (GORM / SQL).
	//
	// Arguments:
	//   - ctx: Request cancellation context.
	//   - userID: Unique identifier of the target user.
	//   - fields: Key-value map of dynamic extra fields to persist.
	//
	// Returns:
	//   - error: Database execution error if update fails.
	//
	// Example SQL:
	//   UPDATE users SET extra_fields = $2 WHERE id = $1;
	SaveCustomUserFields(ctx context.Context, userID string, fields map[string]any) error

	// GetCustomSessionFields retrieves dynamic additional fields associated with a specific session ID.
	//
	// Function:
	//   Called during session payload transformation to load custom session metadata.
	//
	// Storage:
	//   Database (GORM / SQL) or Redis Cache-Aside.
	//
	// Arguments:
	//   - ctx: Request cancellation context.
	//   - sessionID: Unique identifier of the target active session.
	//
	// Returns:
	//   - map[string]any: Key-value map of dynamic session fields.
	//   - error: Database query error if execution fails.
	//
	// Example SQL:
	//   SELECT extra_fields FROM sessions WHERE id = $1 LIMIT 1;
	GetCustomSessionFields(ctx context.Context, sessionID string) (map[string]any, error)

	// SaveCustomSessionFields persists dynamic additional fields for a specific session ID.
	//
	// Function:
	//   Called when storing dynamic session attributes during sign-in or session updates.
	//
	// Storage:
	//   Database (GORM / SQL).
	//
	// Arguments:
	//   - ctx: Request cancellation context.
	//   - sessionID: Unique identifier of the target active session.
	//   - fields: Key-value map of dynamic extra fields to persist.
	//
	// Returns:
	//   - error: Database execution error if update fails.
	//
	// Example SQL:
	//   UPDATE sessions SET extra_fields = $2 WHERE id = $1;
	SaveCustomSessionFields(ctx context.Context, sessionID string, fields map[string]any) error
}

type TransformEventPayload struct {
	// SessionData is the initial session and user payload before transformation.
	SessionData *dto.SessionData `json:"sessionData"`

	// TransformedData is the resulting payload produced by TransformSessionFunc.
	TransformedData any `json:"transformedData,omitempty"`

	// Request is the active HTTP request triggering the transformation.
	Request *http.Request `json:"-"`

	// Err contains any error encountered during transformation processing.
	Err error `json:"error,omitempty"`
}

type TransformSessionFunc func(ctx context.Context, sessionData *dto.SessionData, req *http.Request) (any, error)