-
Notifications
You must be signed in to change notification settings - Fork 8.2k
/
type.ts
128 lines (107 loc) · 4.04 KB
/
type.ts
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
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you 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.
*/
import { SchemaTypeError, ValidationError } from '../errors';
import { AnySchema, internals, ValidationErrorItem } from '../internals';
import { Reference } from '../references';
export interface TypeOptions<T> {
defaultValue?: T | Reference<T> | (() => T);
validate?: (value: T) => string | void;
}
export abstract class Type<V> {
// This is just to enable the `TypeOf` helper, and because TypeScript would
// fail if it wasn't initialized we use a "trick" to which basically just
// sets the value to `null` while still keeping the type.
public readonly type: V = null! as V;
// used for the `isConfigSchema` typeguard
public readonly __isKbnConfigSchemaType = true;
/**
* Internal "schema" backed by Joi.
* @type {Schema}
*/
protected readonly internalSchema: AnySchema;
protected constructor(schema: AnySchema, options: TypeOptions<V> = {}) {
if (options.defaultValue !== undefined) {
schema = schema.optional();
// If default value is a function, then we must provide description for it.
if (typeof options.defaultValue === 'function') {
schema = schema.default(options.defaultValue, 'Type default value');
} else {
schema = schema.default(
Reference.isReference(options.defaultValue)
? options.defaultValue.getSchema()
: options.defaultValue
);
}
}
if (options.validate) {
schema = schema.custom(options.validate);
}
// Attach generic error handler only if it hasn't been attached yet since
// only the last error handler is counted.
const schemaFlags = (schema.describe().flags as Record<string, any>) || {};
if (schemaFlags.error === undefined) {
schema = schema.error(([error]) => this.onError(error));
}
this.internalSchema = schema;
}
public validate(value: any, context: Record<string, any> = {}, namespace?: string): V {
const { value: validatedValue, error } = internals.validate(value, this.internalSchema, {
context,
presence: 'required',
});
if (error) {
throw new ValidationError(error as any, namespace);
}
return validatedValue;
}
/**
* @internal
*/
public getSchema() {
return this.internalSchema;
}
protected handleError(
type: string,
context: Record<string, any>,
path: string[]
): string | SchemaTypeError | void {
return undefined;
}
private onError(error: SchemaTypeError | ValidationErrorItem): SchemaTypeError {
if (error instanceof SchemaTypeError) {
return error;
}
const { context = {}, type, path, message } = error;
const errorHandleResult = this.handleError(type, context, path);
if (errorHandleResult instanceof SchemaTypeError) {
return errorHandleResult;
}
// If error handler just defines error message, then wrap it into proper
// `SchemaTypeError` instance.
if (typeof errorHandleResult === 'string') {
return new SchemaTypeError(errorHandleResult, path);
}
// If error is produced by the custom validator, just extract source message
// from context and wrap it into `SchemaTypeError` instance.
if (type === 'any.custom') {
return new SchemaTypeError(context.message, path);
}
return new SchemaTypeError(message || type, path);
}
}