forked from sassoftware/restaf
-
Notifications
You must be signed in to change notification settings - Fork 0
/
main-types.js
177 lines (151 loc) · 2.87 KB
/
main-types.js
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/**
* @description Main
*/
/**
* Initialize restaf instance
* @category restaf/core
*/
/**
* Examples
* @category examples
*/
/**
* Cas functions
* @category restaf/cas
*/
/**
* restaflib cas
* @category restaflib/cas
*/
/**
* restaflib compute
* @category restaflib/compute
*/
/**
* restaflib reports
* @category restaflib/report
*/
/**
* restaflib MAS
* @category restaflibmas
*/
/**
* restaflib Job Execution
* @category restaflib/jes
*/
/**
* restaflib Utility
* @category restaflib/util
*/
/**
* restaf store.
* @typedef {object} store
*/
/**
* authflow
* @typedef {"password"|"code"|"server"|"token"} authflow
*/
/**
* authType
* @typedef {"password"|"code"|"server"|"token"} authType
*/
/**
* tokenType
* @typedef {"bearer"} tokenType
*/
/**
* Code logon payload
* @typedef {object} logonPayloadCode
* @property {"code"|"server"} authType
* @property {URL} host
* @property {string=} token Useful when CORS is set *
* @property {tokenType=} bearer
*/
/**
* Password logon payload
* @typedef {object} logonPayloadPassword
* @property {"password"} authType
* @property {string} host
* @property {string} user
* @property {string} password
* @property {string} clientID
* @property {string} clientSecret
*/
/**
* Token logon payload
* @typedef {object} logonPayloadToken
* @property {"token"} authType
* @property {string} host
* @property {string} token
* @property {string} bearer
*/
/**
* restaf links
* @typedef {object} rafLink
*/
/**
* Link for a specific rel
* @typedef {object} rafLinkRel
*/
/**
* restaf object
* @typedef {object} rafObject
*/
// ######
// Cas arguments
// ######
/**
* payload for cas actions
* @typedef {object} actionPayload
* @property {string} actionName
* @property {object} actionParameter
*/
/**
* computeSummary from computeSummary
* @typedef {object} computeSummary
*/
/**
* Authflow
* @typedef {"password"|"code"|"server"|"token"} Authflow
*/
/**
* AuthType
* @typedef {"password"|"code"|"server"|"token"} authType
*/
/**
* Code logon payload
* @typedef {object} logonPayloadCode
* @property {"code"|"server"} authType
* @property {URL} host
* @property {string} token optional
* @property {"Bearer"} bearer optional
*/
/**
* Password logon payload
* @typedef {object} logonPayloadPassword
* @property {"password"} authType
* @property {string} host
* @property {string} token optional
* @property {string} bearer optional
*/
/**
* Token logon payload
* @typedef {object} logonPayloadToken
* @property {"token"} authType
* @property {string} host
* @property {string} token optional
* @property {string} bearer optional
*/
// ######
// Cas arguments
// ######
/**
* payload for cas actions
* @typedef {object} actionPayload
* @property {string} actionName
* @property {object} actionParameter
*/
/**
* computeSummary from computeSummary
* @typedef {object} computeSummary
*/