-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathbind_options.go
More file actions
152 lines (136 loc) · 4.16 KB
/
bind_options.go
File metadata and controls
152 lines (136 loc) · 4.16 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
// Copyright 2025 The Rivaas Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package app
import (
"fmt"
"rivaas.dev/binding"
"rivaas.dev/validation"
)
// bindConfig holds unified configuration for Bind operations.
// It combines binding and validation options into a single configuration.
type bindConfig struct {
// Binding behavior
strict bool // Reject unknown fields
skipValidation bool // Skip validation step
// Validation behavior
partial bool // Partial validation (PATCH)
presence validation.PresenceMap // Field presence tracking
// Pass-through options for advanced use
bindingOpts []binding.Option
validationOpts []validation.Option
}
// BindOption configures Bind behavior.
// BindOptions can be passed to [Context.Bind], [Context.MustBind], [Bind], and [MustBind].
type BindOption func(*bindConfig)
// WithStrict rejects unknown JSON fields during binding.
// Use this to catch typos and API drift early.
//
// Example:
//
// req, err := app.Bind[CreateUserRequest](c, app.WithStrict())
//
// Equivalent to the old BindAndValidateStrict method.
func WithStrict() BindOption {
return func(cfg *bindConfig) {
cfg.strict = true
}
}
// WithPartial enables partial validation for PATCH requests.
// Only fields present in the request body are validated.
// The "required" constraint is ignored for absent fields.
//
// Example:
//
// req, err := app.Bind[UpdateUserRequest](c, app.WithPartial())
func WithPartial() BindOption {
return func(cfg *bindConfig) {
cfg.partial = true
}
}
// WithoutValidation skips the validation step.
// Use when you only need binding, or will validate separately.
//
// Example:
//
// req, err := app.Bind[Request](c, app.WithoutValidation())
//
// Equivalent to using [Context.BindOnly] or [BindOnly].
func WithoutValidation() BindOption {
return func(cfg *bindConfig) {
cfg.skipValidation = true
}
}
// WithPresence explicitly sets the presence map.
// Usually auto-detected from JSON body; use this for custom scenarios.
//
// Example:
//
// pm, _ := validation.ComputePresence(rawJSON)
// req, err := app.Bind[Request](c, app.WithPresence(pm))
func WithPresence(pm validation.PresenceMap) BindOption {
return func(cfg *bindConfig) {
cfg.presence = pm
}
}
// WithBindingOptions passes options directly to the binding package.
// Use for advanced binding configuration.
//
// Example:
//
// req, err := app.Bind[Request](c,
// app.WithBindingOptions(
// binding.WithTimeLayouts("2006-01-02"),
// binding.WithMaxDepth(16),
// ),
// )
func WithBindingOptions(opts ...binding.Option) BindOption {
return func(cfg *bindConfig) {
cfg.bindingOpts = append(cfg.bindingOpts, opts...)
}
}
// WithValidationOptions passes options directly to the validation package.
// Use for advanced validation configuration.
//
// Example:
//
// req, err := app.Bind[Request](c,
// app.WithValidationOptions(
// validation.WithStrategy(validation.StrategyTags),
// validation.WithMaxErrors(10),
// ),
// )
func WithValidationOptions(opts ...validation.Option) BindOption {
return func(cfg *bindConfig) {
cfg.validationOpts = append(cfg.validationOpts, opts...)
}
}
// applyBindOptions creates a bindConfig with default values and applies the given options.
// Returns an error if any option is nil.
func applyBindOptions(opts []BindOption) (*bindConfig, error) {
cfg := &bindConfig{
strict: false,
skipValidation: false,
partial: false,
presence: nil,
bindingOpts: nil,
validationOpts: nil,
}
for i, opt := range opts {
if opt == nil {
return nil, fmt.Errorf("app: bind option at index %d cannot be nil", i)
}
opt(cfg)
}
return cfg, nil
}