@appium/types 0.16.0 → 0.16.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -6
- package/build/lib/action.d.ts +25 -1
- package/build/lib/action.d.ts.map +1 -1
- package/build/lib/action.js.map +1 -1
- package/lib/action.ts +32 -1
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -2,7 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
> A collection of TypeScript type declarations used across various [Appium](https://github.com/appium/appium) packages.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
> [!WARNING]
|
|
6
|
+
> This is a work-in-progress; expect breaking changes!
|
|
6
7
|
|
|
7
8
|
## Install
|
|
8
9
|
|
|
@@ -10,11 +11,10 @@
|
|
|
10
11
|
npm install @appium/types -D
|
|
11
12
|
```
|
|
12
13
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
-
|
|
16
|
-
-
|
|
17
|
-
- `lib/appium-config.ts` is generated by this package from `@appium/schema`, but is under version control to avoid chicken-or-egg build problems.
|
|
14
|
+
> [!NOTE]
|
|
15
|
+
> - The sources are `.ts` files, _not_ `.d.ts` files. This allows other packages in the root TypeScript "project" to define a dependency upon this one, and enables incremental builds an "watch" mode.
|
|
16
|
+
> - If there is a way to switch to `.d.ts` files and configure this package to work in our "project" context _without_ needing to actually "emit" anything, then we should do that instead. Help accepted!
|
|
17
|
+
> - `lib/appium-config.ts` is generated by this package from `@appium/schema`, but is under version control to avoid chicken-or-egg build problems.
|
|
18
18
|
|
|
19
19
|
## License
|
|
20
20
|
|
package/build/lib/action.d.ts
CHANGED
|
@@ -49,6 +49,18 @@ export type PointerDownAction = {
|
|
|
49
49
|
type: 'pointerDown';
|
|
50
50
|
button: number;
|
|
51
51
|
};
|
|
52
|
+
/**
|
|
53
|
+
* @group Actions
|
|
54
|
+
*/
|
|
55
|
+
export type ScrollAction = {
|
|
56
|
+
type: 'scroll';
|
|
57
|
+
x: number;
|
|
58
|
+
y: number;
|
|
59
|
+
deltaX: number;
|
|
60
|
+
deltaY: number;
|
|
61
|
+
duration?: number;
|
|
62
|
+
origin?: 'viewport' | Element;
|
|
63
|
+
};
|
|
52
64
|
/**
|
|
53
65
|
* @group Actions
|
|
54
66
|
*/
|
|
@@ -61,6 +73,10 @@ export type KeyAction = PauseAction | KeyDownAction | KeyUpAction;
|
|
|
61
73
|
* @group Actions
|
|
62
74
|
*/
|
|
63
75
|
export type PointerAction = PauseAction | PointerMoveAction | PointerUpAction | PointerDownAction;
|
|
76
|
+
/**
|
|
77
|
+
* @group Actions
|
|
78
|
+
*/
|
|
79
|
+
export type WheelAction = PauseAction | ScrollAction;
|
|
64
80
|
/**
|
|
65
81
|
* @group Actions
|
|
66
82
|
*/
|
|
@@ -95,7 +111,15 @@ export type PointerActionSequence = {
|
|
|
95
111
|
/**
|
|
96
112
|
* @group Actions
|
|
97
113
|
*/
|
|
98
|
-
export type
|
|
114
|
+
export type WheelActionSequence = {
|
|
115
|
+
type: 'wheel';
|
|
116
|
+
id: string;
|
|
117
|
+
actions: WheelAction[];
|
|
118
|
+
};
|
|
119
|
+
/**
|
|
120
|
+
* @group Actions
|
|
121
|
+
*/
|
|
122
|
+
export type ActionSequence = NullActionSequence | KeyActionSequence | PointerActionSequence | WheelActionSequence;
|
|
99
123
|
/**
|
|
100
124
|
* @group Actions
|
|
101
125
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../lib/action.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAC,OAAO,EAAC,MAAM,QAAQ,CAAC;AAE/B;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,GAAG,GAAG,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,GAAG,GAAG,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,aAAa,CAAC;IACpB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,WAAW,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,WAAW,GAAG,aAAa,GAAG,WAAW,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,WAAW,GAAG,iBAAiB,GAAG,eAAe,GAAG,iBAAiB,CAAC;AAElG;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,UAAU,EAAE,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,KAAK,CAAC;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,SAAS,EAAE,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,WAAW,EAAE,OAAO,GAAG,KAAK,GAAG,OAAO,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,SAAS,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,UAAU,CAAC,EAAE,iBAAiB,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,
|
|
1
|
+
{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../lib/action.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAC,OAAO,EAAC,MAAM,QAAQ,CAAC;AAE/B;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,GAAG,GAAG,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,GAAG,GAAG,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,aAAa,CAAC;IACpB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,QAAQ,CAAC;IACf,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,WAAW,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,WAAW,GAAG,aAAa,GAAG,WAAW,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,WAAW,GAAG,iBAAiB,GAAG,eAAe,GAAG,iBAAiB,CAAC;AAElG;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG,YAAY,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,UAAU,EAAE,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,KAAK,CAAC;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,SAAS,EAAE,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,WAAW,EAAE,OAAO,GAAG,KAAK,GAAG,OAAO,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,SAAS,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,UAAU,CAAC,EAAE,iBAAiB,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,OAAO,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,WAAW,EAAE,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GACtB,kBAAkB,GAClB,iBAAiB,GACjB,qBAAqB,GACrB,mBAAmB,CAAC;AAExB;;GAEG;AACH,oBAAY,GAAG;IACb,IAAI,WAAW;IACf,MAAM,WAAW;IACjB,IAAI,WAAW;IACf,SAAS,WAAW;IACpB,GAAG,WAAW;IACd,KAAK,WAAW;IAChB,MAAM,WAAW;IACjB,KAAK,WAAW;IAChB,KAAK,WAAW;IAChB,OAAO,WAAW;IAClB,GAAG,WAAW;IACd,KAAK,WAAW;IAChB,MAAM,WAAW;IACjB,KAAK,WAAW;IAChB,OAAO,WAAW;IAClB,SAAS,WAAW;IACpB,GAAG,WAAW;IACd,IAAI,WAAW;IACf,IAAI,WAAW;IACf,EAAE,WAAW;IACb,KAAK,WAAW;IAChB,IAAI,WAAW;IACf,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,SAAS,WAAW;IACpB,MAAM,WAAW;IACjB,OAAO,WAAW;IAClB,OAAO,WAAW;IAClB,OAAO,WAAW;IAClB,OAAO,WAAW;IAClB,OAAO,WAAW;IAClB,OAAO,WAAW;IAClB,OAAO,WAAW;IAClB,OAAO,WAAW;IAClB,OAAO,WAAW;IAClB,OAAO,WAAW;IAClB,QAAQ,WAAW;IACnB,GAAG,WAAW;IACd,SAAS,WAAW;IACpB,QAAQ,WAAW;IACnB,OAAO,WAAW;IAClB,MAAM,WAAW;IACjB,EAAE,WAAW;IACb,EAAE,WAAW;IACb,EAAE,WAAW;IACb,EAAE,WAAW;IACb,EAAE,WAAW;IACb,EAAE,WAAW;IACb,EAAE,WAAW;IACb,EAAE,WAAW;IACb,EAAE,WAAW;IACb,GAAG,WAAW;IACd,GAAG,WAAW;IACd,GAAG,WAAW;IACd,IAAI,WAAW;IACf,cAAc,WAAW;IACzB,OAAO,WAAW;IAClB,SAAS,WAAW;IACpB,KAAK,WAAW;IAChB,MAAM,WAAW;IACjB,QAAQ,WAAW;IACnB,UAAU,WAAW;IACrB,KAAK,WAAW;IAChB,MAAM,WAAW;IACjB,WAAW,WAAW;IACtB,SAAS,WAAW;IACpB,YAAY,WAAW;IACvB,WAAW,WAAW;IACtB,QAAQ,WAAW;IACnB,QAAQ,WAAW;CACpB"}
|
package/build/lib/action.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"action.js","sourceRoot":"","sources":["../../lib/action.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;
|
|
1
|
+
{"version":3,"file":"action.js","sourceRoot":"","sources":["../../lib/action.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AA6IH;;GAEG;AACH,IAAY,GAuEX;AAvED,WAAY,GAAG;IACb,sBAAe,CAAA;IACf,wBAAiB,CAAA;IACjB,sBAAe,CAAA;IACf,2BAAoB,CAAA;IACpB,qBAAc,CAAA;IACd,uBAAgB,CAAA;IAChB,wBAAiB,CAAA;IACjB,uBAAgB,CAAA;IAChB,uBAAgB,CAAA;IAChB,yBAAkB,CAAA;IAClB,qBAAc,CAAA;IACd,uBAAgB,CAAA;IAChB,wBAAiB,CAAA;IACjB,uBAAgB,CAAA;IAChB,yBAAkB,CAAA;IAClB,2BAAoB,CAAA;IACpB,qBAAc,CAAA;IACd,sBAAe,CAAA;IACf,sBAAe,CAAA;IACf,oBAAa,CAAA;IACb,uBAAgB,CAAA;IAChB,sBAAe,CAAA;IACf,wBAAiB,CAAA;IACjB,wBAAiB,CAAA;IACjB,2BAAoB,CAAA;IACpB,wBAAiB,CAAA;IACjB,yBAAkB,CAAA;IAClB,yBAAkB,CAAA;IAClB,yBAAkB,CAAA;IAClB,yBAAkB,CAAA;IAClB,yBAAkB,CAAA;IAClB,yBAAkB,CAAA;IAClB,yBAAkB,CAAA;IAClB,yBAAkB,CAAA;IAClB,yBAAkB,CAAA;IAClB,yBAAkB,CAAA;IAClB,0BAAmB,CAAA;IACnB,qBAAc,CAAA;IACd,2BAAoB,CAAA;IACpB,0BAAmB,CAAA;IACnB,yBAAkB,CAAA;IAClB,wBAAiB,CAAA;IACjB,oBAAa,CAAA;IACb,oBAAa,CAAA;IACb,oBAAa,CAAA;IACb,oBAAa,CAAA;IACb,oBAAa,CAAA;IACb,oBAAa,CAAA;IACb,oBAAa,CAAA;IACb,oBAAa,CAAA;IACb,oBAAa,CAAA;IACb,qBAAc,CAAA;IACd,qBAAc,CAAA;IACd,qBAAc,CAAA;IACd,sBAAe,CAAA;IACf,gCAAyB,CAAA;IACzB,yBAAkB,CAAA;IAClB,2BAAoB,CAAA;IACpB,uBAAgB,CAAA;IAChB,wBAAiB,CAAA;IACjB,0BAAmB,CAAA;IACnB,4BAAqB,CAAA;IACrB,uBAAgB,CAAA;IAChB,wBAAiB,CAAA;IACjB,6BAAsB,CAAA;IACtB,2BAAoB,CAAA;IACpB,8BAAuB,CAAA;IACvB,6BAAsB,CAAA;IACtB,0BAAmB,CAAA;IACnB,0BAAmB,CAAA;AACrB,CAAC,EAvEW,GAAG,mBAAH,GAAG,QAuEd"}
|
package/lib/action.ts
CHANGED
|
@@ -57,6 +57,19 @@ export type PointerDownAction = {
|
|
|
57
57
|
button: number;
|
|
58
58
|
};
|
|
59
59
|
|
|
60
|
+
/**
|
|
61
|
+
* @group Actions
|
|
62
|
+
*/
|
|
63
|
+
export type ScrollAction = {
|
|
64
|
+
type: 'scroll';
|
|
65
|
+
x: number;
|
|
66
|
+
y: number;
|
|
67
|
+
deltaX: number;
|
|
68
|
+
deltaY: number;
|
|
69
|
+
duration?: number;
|
|
70
|
+
origin?: 'viewport' | Element;
|
|
71
|
+
};
|
|
72
|
+
|
|
60
73
|
/**
|
|
61
74
|
* @group Actions
|
|
62
75
|
*/
|
|
@@ -72,6 +85,11 @@ export type KeyAction = PauseAction | KeyDownAction | KeyUpAction;
|
|
|
72
85
|
*/
|
|
73
86
|
export type PointerAction = PauseAction | PointerMoveAction | PointerUpAction | PointerDownAction;
|
|
74
87
|
|
|
88
|
+
/**
|
|
89
|
+
* @group Actions
|
|
90
|
+
*/
|
|
91
|
+
export type WheelAction = PauseAction | ScrollAction;
|
|
92
|
+
|
|
75
93
|
/**
|
|
76
94
|
* @group Actions
|
|
77
95
|
*/
|
|
@@ -110,7 +128,20 @@ export type PointerActionSequence = {
|
|
|
110
128
|
/**
|
|
111
129
|
* @group Actions
|
|
112
130
|
*/
|
|
113
|
-
export type
|
|
131
|
+
export type WheelActionSequence = {
|
|
132
|
+
type: 'wheel';
|
|
133
|
+
id: string;
|
|
134
|
+
actions: WheelAction[];
|
|
135
|
+
};
|
|
136
|
+
|
|
137
|
+
/**
|
|
138
|
+
* @group Actions
|
|
139
|
+
*/
|
|
140
|
+
export type ActionSequence =
|
|
141
|
+
| NullActionSequence
|
|
142
|
+
| KeyActionSequence
|
|
143
|
+
| PointerActionSequence
|
|
144
|
+
| WheelActionSequence;
|
|
114
145
|
|
|
115
146
|
/**
|
|
116
147
|
* @group Actions
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@appium/types",
|
|
3
|
-
"version": "0.16.
|
|
3
|
+
"version": "0.16.2",
|
|
4
4
|
"description": "Various type declarations used across Appium",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"automation",
|
|
@@ -39,11 +39,11 @@
|
|
|
39
39
|
},
|
|
40
40
|
"dependencies": {
|
|
41
41
|
"@appium/schema": "^0.5.0",
|
|
42
|
-
"@appium/tsconfig": "^0.
|
|
42
|
+
"@appium/tsconfig": "^0.3.3",
|
|
43
43
|
"@types/express": "4.17.21",
|
|
44
44
|
"@types/npmlog": "7.0.0",
|
|
45
45
|
"@types/ws": "8.5.10",
|
|
46
|
-
"type-fest": "4.
|
|
46
|
+
"type-fest": "4.10.1"
|
|
47
47
|
},
|
|
48
48
|
"engines": {
|
|
49
49
|
"node": "^14.17.0 || ^16.13.0 || >=18.0.0",
|
|
@@ -52,5 +52,5 @@
|
|
|
52
52
|
"publishConfig": {
|
|
53
53
|
"access": "public"
|
|
54
54
|
},
|
|
55
|
-
"gitHead": "
|
|
55
|
+
"gitHead": "d44e66977c4fd7eb4587d9064594e2be5d311034"
|
|
56
56
|
}
|