@james-infotrack/demo-recorder 0.1.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.
- package/CHANGELOG.md +143 -0
- package/LICENSE +21 -0
- package/README.md +181 -0
- package/dist/components/configEditor/configEditor.component.d.ts +8 -0
- package/dist/components/configEditor/configEditor.component.d.ts.map +1 -0
- package/dist/components/configEditor/index.d.ts +5 -0
- package/dist/components/configEditor/index.d.ts.map +1 -0
- package/dist/components/configEditor/jsonEditor.component.d.ts +8 -0
- package/dist/components/configEditor/jsonEditor.component.d.ts.map +1 -0
- package/dist/components/configEditor/livePreview.component.d.ts +8 -0
- package/dist/components/configEditor/livePreview.component.d.ts.map +1 -0
- package/dist/components/demoPlayer/demoPlayer.component.d.ts +15 -0
- package/dist/components/demoPlayer/demoPlayer.component.d.ts.map +1 -0
- package/dist/components/demoPlayer/index.d.ts +9 -0
- package/dist/components/demoPlayer/index.d.ts.map +1 -0
- package/dist/components/demoPlayer/playerControls.component.d.ts +12 -0
- package/dist/components/demoPlayer/playerControls.component.d.ts.map +1 -0
- package/dist/components/demoPlayer/playerControls.styles.d.ts +6 -0
- package/dist/components/demoPlayer/playerControls.styles.d.ts.map +1 -0
- package/dist/components/demoPlayer/spotlight.component.d.ts +7 -0
- package/dist/components/demoPlayer/spotlight.component.d.ts.map +1 -0
- package/dist/components/demoPlayer/stepTooltip.component.d.ts +10 -0
- package/dist/components/demoPlayer/stepTooltip.component.d.ts.map +1 -0
- package/dist/components/demoPlayer/stepTooltip.styles.d.ts +15 -0
- package/dist/components/demoPlayer/stepTooltip.styles.d.ts.map +1 -0
- package/dist/components/demoRecorder/demoRecorder.component.d.ts +11 -0
- package/dist/components/demoRecorder/demoRecorder.component.d.ts.map +1 -0
- package/dist/components/demoRecorder/index.d.ts +3 -0
- package/dist/components/demoRecorder/index.d.ts.map +1 -0
- package/dist/components/demoRecorder/recorderUI.component.d.ts +10 -0
- package/dist/components/demoRecorder/recorderUI.component.d.ts.map +1 -0
- package/dist/components/demoRecorder/recorderUI.styles.d.ts +8 -0
- package/dist/components/demoRecorder/recorderUI.styles.d.ts.map +1 -0
- package/dist/components/index.d.ts +5 -0
- package/dist/components/index.d.ts.map +1 -0
- package/dist/core/actionExecutor.core.d.ts +18 -0
- package/dist/core/actionExecutor.core.d.ts.map +1 -0
- package/dist/core/aiProcessor.core.d.ts +10 -0
- package/dist/core/aiProcessor.core.d.ts.map +1 -0
- package/dist/core/domChangeDetector.core.d.ts +22 -0
- package/dist/core/domChangeDetector.core.d.ts.map +1 -0
- package/dist/core/eventCapture.core.d.ts +22 -0
- package/dist/core/eventCapture.core.d.ts.map +1 -0
- package/dist/core/index.d.ts +6 -0
- package/dist/core/index.d.ts.map +1 -0
- package/dist/core/networkInterceptor.core.d.ts +22 -0
- package/dist/core/networkInterceptor.core.d.ts.map +1 -0
- package/dist/demo-recorder.css +1 -0
- package/dist/index.cjs.js +215 -0
- package/dist/index.d.ts +74 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.esm.js +9298 -0
- package/dist/models/actions.model.d.ts +2 -0
- package/dist/models/actions.model.d.ts.map +1 -0
- package/dist/models/config.model.d.ts +87 -0
- package/dist/models/config.model.d.ts.map +1 -0
- package/dist/models/events.model.d.ts +68 -0
- package/dist/models/events.model.d.ts.map +1 -0
- package/dist/models/index.d.ts +4 -0
- package/dist/models/index.d.ts.map +1 -0
- package/dist/styles.css +1 -0
- package/dist/utils/formInput.util.d.ts +17 -0
- package/dist/utils/formInput.util.d.ts.map +1 -0
- package/dist/utils/index.d.ts +6 -0
- package/dist/utils/index.d.ts.map +1 -0
- package/dist/utils/screenshot.util.d.ts +13 -0
- package/dist/utils/screenshot.util.d.ts.map +1 -0
- package/dist/utils/selector.util.d.ts +12 -0
- package/dist/utils/selector.util.d.ts.map +1 -0
- package/dist/utils/timing.util.d.ts +10 -0
- package/dist/utils/timing.util.d.ts.map +1 -0
- package/dist/utils/validation.util.d.ts +13 -0
- package/dist/utils/validation.util.d.ts.map +1 -0
- package/package.json +93 -0
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Demo Recorder Library - Main Entry Point
|
|
3
|
+
*
|
|
4
|
+
* Provides UI components and utilities for recording and playing back web application demos.
|
|
5
|
+
*
|
|
6
|
+
* @packageDocumentation
|
|
7
|
+
*/
|
|
8
|
+
import './styles/animations.styles.css';
|
|
9
|
+
/**
|
|
10
|
+
* ConfigEditor - Component for editing demo configurations
|
|
11
|
+
*
|
|
12
|
+
* Provides Monaco editor with validation, JSON schema support, and live preview
|
|
13
|
+
* of demo steps.
|
|
14
|
+
*
|
|
15
|
+
* @see https://example.com/docs/config-editor for more examples
|
|
16
|
+
*/
|
|
17
|
+
export { ConfigEditor, type ConfigEditorProps } from './components/configEditor';
|
|
18
|
+
/**
|
|
19
|
+
* DemoPlayer - Component for playing back recorded demos
|
|
20
|
+
*
|
|
21
|
+
* Executes recorded demo steps with visual feedback including spotlights and tooltips.
|
|
22
|
+
* Supports playback controls and speed adjustment.
|
|
23
|
+
*
|
|
24
|
+
* @see https://example.com/docs/demo-player for more examples
|
|
25
|
+
*/
|
|
26
|
+
export { DemoPlayer, type DemoPlayerProps } from './components/demoPlayer';
|
|
27
|
+
/**
|
|
28
|
+
* DemoRecorder - Component for recording user interactions
|
|
29
|
+
*
|
|
30
|
+
* Records browser events, DOM changes, and API calls to generate demo configurations.
|
|
31
|
+
* Requires an API key for AI-powered step generation.
|
|
32
|
+
*
|
|
33
|
+
* @see https://example.com/docs/demo-recorder for complete usage examples
|
|
34
|
+
*/
|
|
35
|
+
export { DemoRecorder, type DemoRecorderProps } from './components/demoRecorder';
|
|
36
|
+
/**
|
|
37
|
+
* DemoSummary - Summary of demo playback completion
|
|
38
|
+
*
|
|
39
|
+
* Contains statistics about how the user completed the demo.
|
|
40
|
+
*/
|
|
41
|
+
export type { DemoSummary } from './components/demoPlayer';
|
|
42
|
+
/**
|
|
43
|
+
* ActionConfig - Configuration for a demo action
|
|
44
|
+
*
|
|
45
|
+
* Represents an action to execute (click, input, navigate, API call, custom function, etc.)
|
|
46
|
+
*/
|
|
47
|
+
export type { ActionConfig } from './models/actions.model';
|
|
48
|
+
/**
|
|
49
|
+
* DemoConfig - Root configuration object for a collection of demos
|
|
50
|
+
*
|
|
51
|
+
* Contains metadata and an array of individual demo definitions.
|
|
52
|
+
*/
|
|
53
|
+
/**
|
|
54
|
+
* Demo - A single demo recording with multiple steps
|
|
55
|
+
*
|
|
56
|
+
* Represents a complete walkthrough of a user workflow.
|
|
57
|
+
*/
|
|
58
|
+
/**
|
|
59
|
+
* DemoStep - A single step in a demo sequence
|
|
60
|
+
*
|
|
61
|
+
* Describes an action to perform (click, input, navigate, etc.) and metadata about the step.
|
|
62
|
+
*/
|
|
63
|
+
export type { Demo, DemoConfig, DemoStep } from './models/config.model';
|
|
64
|
+
/**
|
|
65
|
+
* validateDemoConfig - Validates a demo configuration object
|
|
66
|
+
*
|
|
67
|
+
* Performs comprehensive validation of the demo configuration against the schema.
|
|
68
|
+
* Throws ValidationError if validation fails.
|
|
69
|
+
*
|
|
70
|
+
* @param config - The DemoConfig to validate
|
|
71
|
+
* @throws {ValidationError} If validation fails
|
|
72
|
+
*/
|
|
73
|
+
export { type ValidationError, validateDemoConfig, } from './utils/validation.util';
|
|
74
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,gCAAgC,CAAC;AAMxC;;;;;;;GAOG;AACH,OAAO,EAAE,YAAY,EAAE,KAAK,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAEjF;;;;;;;GAOG;AACH,OAAO,EAAE,UAAU,EAAE,KAAK,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC3E;;;;;;;GAOG;AACH,OAAO,EAAE,YAAY,EAAE,KAAK,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAMjF;;;;GAIG;AACH,YAAY,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D;;;;GAIG;AACH,YAAY,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC3D;;;;GAIG;AACH;;;;GAIG;AACH;;;;GAIG;AACH,YAAY,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAMxE;;;;;;;;GAQG;AACH,OAAO,EACL,KAAK,eAAe,EACpB,kBAAkB,GACnB,MAAM,yBAAyB,CAAC"}
|