valibot/library/src/actions/value/value.ts at b45e3edf57f6116bc48b4aedfba79802395e735b · open-circle/valibot · GitHub

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
import type {
  BaseIssue,
  BaseValidation,
  ErrorMessage,
} from '../../types/index.ts';
import { _addIssue, _sameValueZero, _stringify } from '../../utils/index.ts';
import type { ValueInput } from '../types.ts';

/**
 * Value issue interface.
 */
export interface ValueIssue<
  TInput extends ValueInput,
  TRequirement extends TInput,
> extends BaseIssue<TInput> {
  /**
   * The issue kind.
   */
  readonly kind: 'validation';
  /**
   * The issue type.
   */
  readonly type: 'value';
  /**
   * The expected property.
   */
  readonly expected: string;
  /**
   * The required value.
   */
  readonly requirement: TRequirement;
}

/**
 * Value action interface.
 */
export interface ValueAction<
  TInput extends ValueInput,
  TRequirement extends TInput,
  TMessage extends ErrorMessage<ValueIssue<TInput, TRequirement>> | undefined,
> extends BaseValidation<TInput, TInput, ValueIssue<TInput, TRequirement>> {
  /**
   * The action type.
   */
  readonly type: 'value';
  /**
   * The action reference.
   */
  readonly reference: typeof value;
  /**
   * The expected property.
   */
  readonly expects: string;
  /**
   * The required value.
   */
  readonly requirement: TRequirement;
  /**
   * The error message.
   */
  readonly message: TMessage;
}

/**
 * Creates a value validation action.
 *
 * @param requirement The required value.
 *
 * @returns A value action.
 */
export function value<
  TInput extends ValueInput,
  const TRequirement extends TInput,
>(requirement: TRequirement): ValueAction<TInput, TRequirement, undefined>;

/**
 * Creates a value validation action.
 *
 * @param requirement The required value.
 * @param message The error message.
 *
 * @returns A value action.
 */
export function value<
  TInput extends ValueInput,
  const TRequirement extends TInput,
  const TMessage extends
    | ErrorMessage<ValueIssue<TInput, TRequirement>>
    | undefined,
>(
  requirement: TRequirement,
  message: TMessage
): ValueAction<TInput, TRequirement, TMessage>;

// @__NO_SIDE_EFFECTS__
export function value(
  requirement: ValueInput,
  message?: ErrorMessage<ValueIssue<ValueInput, ValueInput>>
): ValueAction<
  ValueInput,
  ValueInput,
  ErrorMessage<ValueIssue<ValueInput, ValueInput>> | undefined
> {
  return {
    kind: 'validation',
    type: 'value',
    reference: value,
    async: false,
    expects:
      requirement instanceof Date
        ? requirement.toJSON()
        : _stringify(requirement),
    requirement,
    message,
    '~run'(dataset, config) {
      if (
        dataset.typed &&
        !(
          _sameValueZero(this.requirement, dataset.value) ||
          (this.requirement <= dataset.value &&
            this.requirement >= dataset.value)
        )
      ) {
        _addIssue(this, 'value', dataset, config, {
          received:
            dataset.value instanceof Date
              ? dataset.value.toJSON()
              : _stringify(dataset.value),
        });
      }
      return dataset;
    },
  };
}