@steppy/player 0.0.0-stage → 0.4.0

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.
Files changed (56) hide show
  1. package/LICENSE +202 -0
  2. package/NOTICE +9 -0
  3. package/README.md +190 -2
  4. package/THIRD_PARTY_LICENSES.txt +158 -0
  5. package/dist/steppy-cursor-legacy.js +2 -0
  6. package/dist/steppy-cursor-legacy.js.map +1 -0
  7. package/dist/steppy-player.js +5419 -0
  8. package/dist/steppy-player.js.map +1 -0
  9. package/dist/steppy-tour.js +2164 -0
  10. package/dist/steppy-tour.js.map +1 -0
  11. package/dist/steppy-video.js +472 -0
  12. package/dist/steppy-video.js.map +1 -0
  13. package/dist/types/cursor/animator.d.ts +135 -0
  14. package/dist/types/cursor/types.d.ts +61 -0
  15. package/dist/types/i18n/ui-strings.d.ts +48 -0
  16. package/dist/types/index.d.ts +10 -0
  17. package/dist/types/interaction/positioning.d.ts +22 -0
  18. package/dist/types/manifest/content.d.ts +24 -0
  19. package/dist/types/manifest/index.d.ts +3 -0
  20. package/dist/types/manifest/parse.d.ts +23 -0
  21. package/dist/types/manifest/schema.d.ts +2895 -0
  22. package/dist/types/steppy-guide.d.ts +195 -0
  23. package/dist/types/templates/base-styles.d.ts +15 -0
  24. package/dist/types/templates/controls.d.ts +17 -0
  25. package/dist/types/templates/index.d.ts +23 -0
  26. package/dist/types/templates/inline.d.ts +10 -0
  27. package/dist/types/templates/overlay.d.ts +10 -0
  28. package/dist/types/templates/sidebar.d.ts +19 -0
  29. package/dist/types/templates/types.d.ts +76 -0
  30. package/dist/types/tour/api.d.ts +54 -0
  31. package/dist/types/tour/contract.d.ts +54 -0
  32. package/dist/types/tour/dom.d.ts +43 -0
  33. package/dist/types/tour/engine.d.ts +157 -0
  34. package/dist/types/tour/events.d.ts +42 -0
  35. package/dist/types/tour/host.d.ts +153 -0
  36. package/dist/types/tour/index.d.ts +15 -0
  37. package/dist/types/tour/layer.d.ts +16 -0
  38. package/dist/types/tour/loader.d.ts +70 -0
  39. package/dist/types/tour/resolver.d.ts +30 -0
  40. package/dist/types/tour/routes.d.ts +40 -0
  41. package/dist/types/tour/signature.d.ts +16 -0
  42. package/dist/types/tour/storage.d.ts +28 -0
  43. package/dist/types/tour/strings.d.ts +42 -0
  44. package/dist/types/tour/styles.d.ts +13 -0
  45. package/dist/types/tour/templates.d.ts +47 -0
  46. package/dist/types/tour/tracker.d.ts +45 -0
  47. package/dist/types/tour/triggers.d.ts +52 -0
  48. package/dist/types/tour/validate.d.ts +82 -0
  49. package/dist/types/ui/markdown.d.ts +58 -0
  50. package/dist/types/ui/names.d.ts +18 -0
  51. package/dist/types/ui/placement.d.ts +59 -0
  52. package/dist/types/ui/strings.d.ts +31 -0
  53. package/dist/types/ui/tokens.d.ts +57 -0
  54. package/package.json +70 -4
  55. package/schema/README.md +19 -0
  56. package/schema/guide.schema.json +427 -0
package/schema/guide.schema.json ADDED
@@ -0,0 +1,427 @@
1
+ {
2
+ "$ref": "#/definitions/GuideManifest",
3
+ "definitions": {
4
+ "GuideManifest": {
5
+ "type": "object",
6
+ "properties": {
7
+ "version": {
8
+ "type": "string",
9
+ "pattern": "^\\d+\\.\\d+$"
10
+ },
11
+ "slug": {
12
+ "type": "string",
13
+ "minLength": 1
14
+ },
15
+ "mode": {
16
+ "type": "string",
17
+ "const": "interactive"
18
+ },
19
+ "role": {
20
+ "$ref": "#/definitions/GuideManifest/properties/slug"
21
+ },
22
+ "title": {
23
+ "type": "object",
24
+ "additionalProperties": {
25
+ "$ref": "#/definitions/GuideManifest/properties/slug"
26
+ },
27
+ "propertyNames": {
28
+ "minLength": 1
29
+ }
30
+ },
31
+ "locales": {
32
+ "type": "array",
33
+ "items": {
34
+ "$ref": "#/definitions/GuideManifest/properties/slug"
35
+ },
36
+ "minItems": 1
37
+ },
38
+ "defaultLocale": {
39
+ "$ref": "#/definitions/GuideManifest/properties/slug"
40
+ },
41
+ "layouts": {
42
+ "type": "array",
43
+ "items": {
44
+ "$ref": "#/definitions/GuideManifest/properties/slug"
45
+ }
46
+ },
47
+ "defaultLayout": {
48
+ "anyOf": [
49
+ {
50
+ "$ref": "#/definitions/GuideManifest/properties/slug"
51
+ },
52
+ {
53
+ "type": "null"
54
+ }
55
+ ]
56
+ },
57
+ "cursor": {
58
+ "type": "object",
59
+ "properties": {
60
+ "pre_action_ms": {
61
+ "type": "integer",
62
+ "exclusiveMinimum": 0
63
+ },
64
+ "action_ms": {
65
+ "type": "integer",
66
+ "exclusiveMinimum": 0
67
+ },
68
+ "post_action_ms": {
69
+ "type": "integer",
70
+ "minimum": 0
71
+ },
72
+ "travel_speed_px_per_ms": {
73
+ "type": "number",
74
+ "exclusiveMinimum": 0
75
+ },
76
+ "mode": {
77
+ "type": "string",
78
+ "enum": [
79
+ "arrow",
80
+ "hotspot",
81
+ "off"
82
+ ]
83
+ }
84
+ },
85
+ "required": [
86
+ "pre_action_ms",
87
+ "action_ms",
88
+ "post_action_ms",
89
+ "travel_speed_px_per_ms"
90
+ ],
91
+ "additionalProperties": false
92
+ },
93
+ "defaultTemplate": {
94
+ "type": "string",
95
+ "enum": [
96
+ "sidebar",
97
+ "overlay",
98
+ "inline"
99
+ ]
100
+ },
101
+ "steps": {
102
+ "type": "array",
103
+ "items": {
104
+ "type": "object",
105
+ "properties": {
106
+ "id": {
107
+ "$ref": "#/definitions/GuideManifest/properties/slug"
108
+ },
109
+ "index": {
110
+ "type": "integer",
111
+ "exclusiveMinimum": 0
112
+ },
113
+ "action": {
114
+ "type": "string",
115
+ "enum": [
116
+ "navigate",
117
+ "click",
118
+ "fill",
119
+ "fill-form",
120
+ "select",
121
+ "wait",
122
+ "wait-for",
123
+ "wait-for-text",
124
+ "scroll",
125
+ "hover",
126
+ "keyboard",
127
+ "assert",
128
+ "custom",
129
+ "login",
130
+ "auth0-login",
131
+ "capture",
132
+ "upload",
133
+ "select-option",
134
+ "confirm",
135
+ "fill-date",
136
+ "toggle",
137
+ "pick-date",
138
+ "pick-time",
139
+ "expand",
140
+ "call"
141
+ ]
142
+ },
143
+ "interactive": {
144
+ "type": "boolean"
145
+ },
146
+ "screenshotWhen": {
147
+ "type": "string",
148
+ "enum": [
149
+ "before",
150
+ "after"
151
+ ]
152
+ },
153
+ "waitAfter": {
154
+ "type": "integer",
155
+ "minimum": 0
156
+ },
157
+ "title": {
158
+ "type": "object",
159
+ "additionalProperties": {
160
+ "type": [
161
+ "string",
162
+ "null"
163
+ ]
164
+ },
165
+ "propertyNames": {
166
+ "minLength": 1
167
+ }
168
+ },
169
+ "text": {
170
+ "$ref": "#/definitions/GuideManifest/properties/steps/items/properties/title"
171
+ },
172
+ "subtitle": {
173
+ "$ref": "#/definitions/GuideManifest/properties/steps/items/properties/title"
174
+ },
175
+ "captures": {
176
+ "type": "object",
177
+ "additionalProperties": {
178
+ "type": "object",
179
+ "additionalProperties": {
180
+ "type": "object",
181
+ "properties": {
182
+ "frames": {
183
+ "type": "array",
184
+ "items": {
185
+ "type": "object",
186
+ "properties": {
187
+ "screenshot": {
188
+ "$ref": "#/definitions/GuideManifest/properties/slug"
189
+ },
190
+ "captureSize": {
191
+ "type": "object",
192
+ "properties": {
193
+ "width": {
194
+ "type": "number",
195
+ "exclusiveMinimum": 0
196
+ },
197
+ "height": {
198
+ "type": "number",
199
+ "exclusiveMinimum": 0
200
+ }
201
+ },
202
+ "required": [
203
+ "width",
204
+ "height"
205
+ ],
206
+ "additionalProperties": false
207
+ },
208
+ "cursor": {
209
+ "anyOf": [
210
+ {
211
+ "anyOf": [
212
+ {
213
+ "type": "object",
214
+ "properties": {
215
+ "kind": {
216
+ "type": "string",
217
+ "const": "click"
218
+ },
219
+ "target": {
220
+ "type": "object",
221
+ "properties": {
222
+ "selector": {
223
+ "$ref": "#/definitions/GuideManifest/properties/slug"
224
+ },
225
+ "bbox": {
226
+ "type": "object",
227
+ "properties": {
228
+ "x": {
229
+ "type": "number"
230
+ },
231
+ "y": {
232
+ "type": "number"
233
+ },
234
+ "width": {
235
+ "type": "number",
236
+ "exclusiveMinimum": 0
237
+ },
238
+ "height": {
239
+ "type": "number",
240
+ "exclusiveMinimum": 0
241
+ }
242
+ },
243
+ "required": [
244
+ "x",
245
+ "y",
246
+ "width",
247
+ "height"
248
+ ],
249
+ "additionalProperties": false
250
+ }
251
+ },
252
+ "required": [
253
+ "bbox"
254
+ ],
255
+ "additionalProperties": false
256
+ }
257
+ },
258
+ "required": [
259
+ "kind",
260
+ "target"
261
+ ],
262
+ "additionalProperties": false
263
+ },
264
+ {
265
+ "type": "object",
266
+ "properties": {
267
+ "kind": {
268
+ "type": "string",
269
+ "const": "hover"
270
+ },
271
+ "target": {
272
+ "$ref": "#/definitions/GuideManifest/properties/steps/items/properties/captures/additionalProperties/additionalProperties/properties/frames/items/properties/cursor/anyOf/0/anyOf/0/properties/target"
273
+ }
274
+ },
275
+ "required": [
276
+ "kind",
277
+ "target"
278
+ ],
279
+ "additionalProperties": false
280
+ },
281
+ {
282
+ "type": "object",
283
+ "properties": {
284
+ "kind": {
285
+ "type": "string",
286
+ "const": "type"
287
+ },
288
+ "target": {
289
+ "$ref": "#/definitions/GuideManifest/properties/steps/items/properties/captures/additionalProperties/additionalProperties/properties/frames/items/properties/cursor/anyOf/0/anyOf/0/properties/target"
290
+ },
291
+ "value": {
292
+ "type": "string"
293
+ }
294
+ },
295
+ "required": [
296
+ "kind",
297
+ "target"
298
+ ],
299
+ "additionalProperties": false
300
+ },
301
+ {
302
+ "type": "object",
303
+ "properties": {
304
+ "kind": {
305
+ "type": "string",
306
+ "const": "type-multi"
307
+ },
308
+ "targets": {
309
+ "type": "array",
310
+ "items": {
311
+ "type": "object",
312
+ "properties": {
313
+ "selector": {
314
+ "$ref": "#/definitions/GuideManifest/properties/slug"
315
+ },
316
+ "bbox": {
317
+ "$ref": "#/definitions/GuideManifest/properties/steps/items/properties/captures/additionalProperties/additionalProperties/properties/frames/items/properties/cursor/anyOf/0/anyOf/0/properties/target/properties/bbox"
318
+ },
319
+ "value": {
320
+ "type": "string"
321
+ }
322
+ },
323
+ "required": [
324
+ "bbox"
325
+ ],
326
+ "additionalProperties": false
327
+ },
328
+ "minItems": 1
329
+ }
330
+ },
331
+ "required": [
332
+ "kind",
333
+ "targets"
334
+ ],
335
+ "additionalProperties": false
336
+ }
337
+ ]
338
+ },
339
+ {
340
+ "type": "null"
341
+ }
342
+ ]
343
+ }
344
+ },
345
+ "required": [
346
+ "screenshot",
347
+ "captureSize",
348
+ "cursor"
349
+ ],
350
+ "additionalProperties": false
351
+ },
352
+ "minItems": 1
353
+ },
354
+ "content": {
355
+ "type": "object",
356
+ "properties": {
357
+ "title": {
358
+ "type": [
359
+ "string",
360
+ "null"
361
+ ]
362
+ },
363
+ "text": {
364
+ "type": "string"
365
+ },
366
+ "subtitle": {
367
+ "type": [
368
+ "string",
369
+ "null"
370
+ ]
371
+ }
372
+ },
373
+ "required": [
374
+ "title",
375
+ "text",
376
+ "subtitle"
377
+ ],
378
+ "additionalProperties": false
379
+ }
380
+ },
381
+ "required": [
382
+ "frames"
383
+ ],
384
+ "additionalProperties": false
385
+ },
386
+ "propertyNames": {
387
+ "minLength": 1
388
+ }
389
+ },
390
+ "propertyNames": {
391
+ "minLength": 1
392
+ }
393
+ }
394
+ },
395
+ "required": [
396
+ "id",
397
+ "index",
398
+ "action",
399
+ "interactive",
400
+ "screenshotWhen",
401
+ "waitAfter",
402
+ "text",
403
+ "captures"
404
+ ],
405
+ "additionalProperties": false
406
+ },
407
+ "minItems": 1
408
+ }
409
+ },
410
+ "required": [
411
+ "version",
412
+ "slug",
413
+ "mode",
414
+ "role",
415
+ "title",
416
+ "locales",
417
+ "defaultLocale",
418
+ "layouts",
419
+ "defaultLayout",
420
+ "cursor",
421
+ "steps"
422
+ ],
423
+ "additionalProperties": false
424
+ }
425
+ },
426
+ "$schema": "http://json-schema.org/draft-07/schema#"
427
+ }