-
Notifications
You must be signed in to change notification settings - Fork 183
/
NavResponse.ts
63 lines (52 loc) · 1.72 KB
/
NavResponse.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
/*
* Copyright 2020 The Kubernetes 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.
*/
import { Entity } from './entity'
import { Mode } from './mmr/types'
export interface Breadcrumb {
label: string
command?: string
}
/**
* A `NavResponse` is a collection of `MultiModalResponse` with menu navigation
*
*/
export type NavResponse = {
apiVersion: 'kui-shell/v1'
kind: 'NavResponse'
menus: Menu[]
links?: Link[]
breadcrumbs?: Breadcrumb[]
}
export type Menu = Label & MenuItems
type MenuItems = { items: Mode[] }
type Label = { label: string }
type Command = { command: string }
type Href = { href: string }
export type Link = Label & (Command | Href)
export function isLinkWithCommand(link: Link): link is Label & Command {
return (link as Label & Command).command !== undefined
}
export function isLinkWithHref(link: Link): link is Label & Href {
return (link as Label & Href).href !== undefined
}
export function isLink(link: Link): link is Link {
return isLinkWithHref(link) || isLinkWithCommand(link)
}
export function isNavResponse(entity: Entity): entity is NavResponse {
const nav = entity as NavResponse
return nav.apiVersion === 'kui-shell/v1' && nav.kind === 'NavResponse'
}
export default NavResponse