forked from thaibault/clientnode
-
Notifications
You must be signed in to change notification settings - Fork 0
/
type.ts
350 lines (314 loc) · 10.5 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
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
// -*- coding: utf-8 -*-
/** @module type */
'use strict'
/* !
region header
[Project page](https://torben.website/clientnode)
Copyright Torben Sickert (info["~at~"]torben.website) 16.12.2012
License
-------
This library written by Torben Sickert stand under a creative commons
naming 3.0 unported license.
See https://creativecommons.org/licenses/by/3.0/deed.de
endregion
*/
// region imports
import {Matchers} from 'expect'
import JQuery from 'jquery'
import {Dirent as DirectoryEntry, Stats as FileStats} from 'fs'
import Tools, {BoundTools} from './index'
import {DefinedSymbol, ThrowSymbol, UndefinedSymbol} from './testHelper'
// endregion
// region exports
/// region helper
/* eslint-disable @typescript-eslint/no-explicit-any */
export type AnyFunction = (...parameters:Array<any>) => any
/* eslint-enable @typescript-eslint/no-explicit-any */
export type Unpacked<T> = T extends (infer U)[] ?
U :
T extends (...parameters:Array<unknown>) => infer U ?
U :
T extends Promise<infer U> ?
U :
T
export type FirstParameter<FunctionType extends AnyFunction> =
Parameters<FunctionType>[0]
export type SecondParameter<FunctionType extends AnyFunction> =
Parameters<FunctionType>[1]
export type ThirdParameter<FunctionType extends AnyFunction> =
Parameters<FunctionType>[2]
/* eslint-disable @typescript-eslint/no-explicit-any */
export type ParametersExceptFirst<FunctionType> = FunctionType extends
(parameter:any, ...additionalParameters:infer AdditionalParameters) =>
any ?
AdditionalParameters :
[]
/* eslint-enable @typescript-eslint/no-explicit-any */
export type FunctionTestTuple<FunctionType extends AnyFunction> =
[ReturnType<FunctionType>, ...Parameters<FunctionType>]
export type FunctionTestPromiseTuple<FunctionType extends AnyFunction> =
[ThenParameter<ReturnType<FunctionType>>, ...Parameters<FunctionType>]
export type FunctionTestPromiseRejectionTuple<
FunctionType extends AnyFunction
> = [Error, ...Parameters<FunctionType>]
export type BaseSelector<T = unknown, E = unknown> =
number|string|((target:T) => E)
export type Selector<T = unknown, E = unknown> =
Array<BaseSelector<T, E>>|BaseSelector<T, E>
export type TestSymbol =
typeof DefinedSymbol|typeof ThrowSymbol|typeof UndefinedSymbol
export type ThenParameter<Type> = Type extends PromiseLike<infer U> ? U : Type
export type ThenParameterRecursive<Type> =
Type extends PromiseLike<infer U> ? ThenParameterRecursive<U> : Type
export type ValueOf<Type> = Type[keyof Type]
export type RecursiveNonNullable<Type> = {
[Property in keyof Type]:Type[Property] extends (infer OtherType)[] ?
RecursiveNonNullable<OtherType>[] :
Type[Property] extends AnyFunction ?
NonNullable<Type[Property]> :
Type[Property] extends Mapping<unknown> ?
RecursiveNonNullable<Type[Property]> :
NonNullable<Type[Property]>
}
export type RecursivePartial<Type> =
Partial<Type> |
{
[Property in keyof Type]?:Type[Property] extends (infer OtherType)[] ?
RecursivePartial<OtherType>[] :
Type[Property] extends AnyFunction ?
Partial<Type[Property]> :
Type[Property] extends Mapping<unknown> ?
RecursivePartial<Type[Property]> :
Partial<Type[Property]>
}
export type FileTraversionResult = false|null|Promise<false|null|void>|void
export type TestMatchers<T extends void> = Matchers<T> & {not:Matchers<T>}
/// endregion
/// region native
export type ImportFunction =
(id:string) => Promise<ReturnType<typeof require>>
export type HTMLItem = Comment|Document|HTMLElement|Text
export type Primitive = boolean|null|number|string|undefined
// NOTE: Mapping cannot be used here to avoid circular references.
export type PlainObject<Type = Primitive> =
{[key:string]:Array<PlainObject<Type>|Type>|PlainObject<Type>|Type}
export interface ProxyHandler<T = unknown> {
deleteProperty:(target:T, key:string|symbol) => boolean
get:(target:T, key:string|symbol) => unknown
has:(target:T, key:string|symbol) => boolean
set:(target:T, key:string|symbol, value:unknown) => boolean
}
export type ProxyType<T = unknown> = T & {
__revoke__?:() => void
__target__:T
}
export interface CookieOptions {
domain:string
httpOnly:boolean
minimal:boolean
numberOfDaysUntilExpiration:number
path:string
sameSite:'Lax'|'None'|'Strict'|''
secure:boolean
}
//// region functions
export type UnknownFunction = (...parameters:Array<unknown>) => unknown
export type ArrayTransformer<T = unknown, R = unknown, P = unknown> = (
data:Array<T>, ...additionalParameter:Array<P>
) => Array<R>
export type SynchronousProcedureFunction = (...parameters:Array<unknown>) =>
void
export type AsynchronousProcedureFunction = (...parameters:Array<unknown>) =>
Promise<void>
export type ProcedureFunction =
AsynchronousProcedureFunction|SynchronousProcedureFunction
export type GetterFunction =
(keyOrValue:unknown, key:string|symbol, target:unknown) => unknown
export type SetterFunction =
(key:string|symbol, value:unknown, target:unknown) => unknown
//// endregion
/// endregion
/// region clientnode helper
export interface CheckReachabilityOptions {
expectedIntermediateStatusCodes:Array<number>|number
options:RequestInit
pollIntervallInSeconds:number
statusCodes:Array<number>|number
timeoutInSeconds:number
wait:boolean
}
export interface CompareOptions {
compareBlobs:boolean
deep:number
exceptionPrefixes:Array<string>
ignoreFunctions:boolean
properties:Array<string>|null
returnReasonIfNotEqual:boolean
}
export type Encoding =
'ascii' |
'base64' |
'binary' |
'hex' |
'latin1' |
'ucs2' |
'ucs-2' |
'utf8' |
'utf16le' |
'utf-8'
export interface File {
directoryPath:string
directoryEntry:DirectoryEntry|null
error:Error|null
name:string
path:string
stats:FileStats|null
}
export interface ProcessError extends Error {
parameters:Array<unknown>
returnCode:number
}
export type QueryParameters =
Array<Array<string>|string> & Mapping<Array<string>|string>
export interface TimeoutPromise extends Promise<boolean> {
clear:() => void
timeoutID:NodeJS.Timeout
}
export type Mapping<V = string, K extends string = string> = {
[key in K]:V
}
// NOTE: Mapping cannot be used here to avoid circular references.
export type ObjectMask = boolean|{[key:string]:boolean|ObjectMask}
export interface ObjectMaskConfiguration {
exclude?:ObjectMask
include?:ObjectMask
}
export type Evaluateable = {__evaluate__:string}|{__execute__:string}
export type RecursiveEvaluateable<Type> = Evaluateable|{
[Property in keyof Type]:(
Evaluateable|(Type[Property] extends (infer OtherType)[] ?
RecursiveEvaluateable<OtherType>[] :
Type[Property] extends Mapping<unknown> ?
RecursiveEvaluateable<Type[Property]> :
Evaluateable|Type[Property]
)
)
}
export interface PaginateOptions {
boundaryCount:number
disabled:boolean
hideNextButton:boolean
hidePrevButton:boolean
page:number
pageSize?:null|number
showFirstButton:boolean
showLastButton:boolean
siblingCount:number
total:number
}
export interface Page {
disabled:boolean
page?:number
selected:boolean
type:PageType
}
export type PageType =
'end-ellipsis'|'first'|'last'|'next'|'page'|'previous'|'start-ellipsis'
export interface Offset {
left:number
top:number
}
export interface Position extends Offset {
bottom:number
right:number
}
export type ProcessHandler =
(returnCode:unknown, ...parameters:Array<unknown>) => void
export interface ProcessCloseReason {
parameters:Array<unknown>
reason:unknown
}
export type ProcessCloseCallback = (reason:ProcessCloseReason) => void
export type ProcessErrorCallback = (reason:ProcessError) => void
export type RelativePosition = 'above'|'below'|'in'|'left'|'right'
export type TemplateFunction<Type = string> =
(...parameters:Array<unknown>) => Type
export interface CompilationResult<
T = string, N extends Array<string> = Array<string>
> {
error:null|string
originalScopeNames:N
scopeNameMapping:{[key in N[number]]:string}
scopeNames:Array<string>
templateFunction:TemplateFunction<T>
}
export interface EvaluationResult<Type = string> {
compileError:null|string
error:null|string
result:Type
runtimeError:null|string
}
export type LockCallbackFunction<Type = string> =
(description:string) => Promise<Type>|Type
/// endregion
/// region global scope
export type DomNodes<Type = string> =
Mapping<Type> &
{
hideJavaScriptEnabled:Type
parent?:Type
showJavaScriptEnabled:Type
window?:Type
}
export type $DomNodes<TElement = HTMLElement> = DomNodes<$T<TElement>>
export interface Options<Type = string> {
domNodes:DomNodes<Type>
domNodeSelectorInfix:null|string
domNodeSelectorPrefix:string
logging:boolean
name:string
}
export type $TStatic = JQueryStatic
export type $T<TElement = HTMLElement> = JQuery<TElement>
export interface $Global extends Window {
Babel?:{transform:(code:string, configuration:PlainObject) => {
code:string
}}
console:Console
dataLayer:Array<PlainObject>
$:$TStatic
}
export interface ToolsFunction<TElement = HTMLElement> {
class:typeof Tools
(...parameters:Array<unknown>):Tools<TElement>
}
export interface BoundToolsFunction<TElement = HTMLElement> {
(methodName:'normalizedClassNames'):BoundTools<TElement>
(methodName:'normalizedStyles'):BoundTools<TElement>
(methodName:'removeDirective', directiveName:string):$T<TElement>
(methodName:'style'):Mapping<number|string>
(methodName:'text'):string
(...parameters:Array<unknown>):BoundTools<TElement>
}
declare global {
interface JQuery<TElement = HTMLElement> {
Tools:BoundToolsFunction<TElement>
}
interface JQueryStatic {
document?:Document
global:$Global
location?:Location
Tools:ToolsFunction
}
}
/// endregion
export interface StringMarkOptions {
marker:((foundWord:string, markedTarget:Array<unknown>) => unknown)|string
normalizer:(value:unknown) => string
skipTagDelimitedParts:null|[string, string]
}
// endregion
// region vim modline
// vim: set tabstop=4 shiftwidth=4 expandtab:
// vim: foldmethod=marker foldmarker=region,endregion:
// endregion