/
base.ts
86 lines (74 loc) · 1.33 KB
/
base.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
import { type ManifestMeta } from "@kosko/common-utils";
/**
* @public
*/
export interface Result {
/**
* Generated manifests.
*/
manifests: Manifest[];
}
/**
* @public
*/
export interface ManifestPosition {
/**
* Path of the source file.
*/
path: string;
/**
* Index of the manifest in the source file.
*/
index: number[];
}
/**
* @public
*/
export interface Manifest {
/**
* Manifest position.
*/
position: ManifestPosition;
/**
* Manifest metadata. This value is undefined when data is not a valid
* Kubernetes object.
*/
metadata?: ManifestMeta;
/**
* Manifest data. The value could be undefined when a component is invalid.
*/
data: unknown;
/**
* Report an issue for a manifest. Please always use this method instead of
* directly modifying the `issues` array to ensure better error handling.
*/
report(issue: Issue): void;
/**
* Issues found in the manifest.
*/
issues: Issue[];
}
export {
/**
* @deprecated Use `Manifest` instead.
* @public
*/
Manifest as BaseManifest,
/**
* @deprecated Use `Manifest` instead.
* @public
*/
Manifest as ManifestToValidate
};
/**
* @public
*/
export type Severity = "error" | "warning";
/**
* @public
*/
export interface Issue {
severity: Severity;
message: string;
cause?: unknown;
}