saltfish 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/LICENSE +34 -0
- package/README.md +633 -0
- package/dist/components/buttons/ExitButton.d.ts +9 -0
- package/dist/components/buttons/ExitButton.d.ts.map +1 -0
- package/dist/components/buttons/MinimizeButton.d.ts +11 -0
- package/dist/components/buttons/MinimizeButton.d.ts.map +1 -0
- package/dist/components/buttons/PlayPauseButton.d.ts +13 -0
- package/dist/components/buttons/PlayPauseButton.d.ts.map +1 -0
- package/dist/core/SaltfishPlayer.d.ts +154 -0
- package/dist/core/SaltfishPlayer.d.ts.map +1 -0
- package/dist/core/stateMachine.d.ts +119 -0
- package/dist/core/stateMachine.d.ts.map +1 -0
- package/dist/core/stateMachineConfig.d.ts +7 -0
- package/dist/core/stateMachineConfig.d.ts.map +1 -0
- package/dist/core/store.d.ts +27 -0
- package/dist/core/store.d.ts.map +1 -0
- package/dist/index.d.ts +127 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/managers/AnalyticsManager.d.ts +107 -0
- package/dist/managers/AnalyticsManager.d.ts.map +1 -0
- package/dist/managers/ButtonManager.d.ts +40 -0
- package/dist/managers/ButtonManager.d.ts.map +1 -0
- package/dist/managers/CursorManager.d.ts +143 -0
- package/dist/managers/CursorManager.d.ts.map +1 -0
- package/dist/managers/EventManager.d.ts +127 -0
- package/dist/managers/EventManager.d.ts.map +1 -0
- package/dist/managers/InteractionManager.d.ts +58 -0
- package/dist/managers/InteractionManager.d.ts.map +1 -0
- package/dist/managers/PlaylistManager.d.ts +42 -0
- package/dist/managers/PlaylistManager.d.ts.map +1 -0
- package/dist/managers/SessionManager.d.ts +56 -0
- package/dist/managers/SessionManager.d.ts.map +1 -0
- package/dist/managers/SessionRecordingManager.d.ts +52 -0
- package/dist/managers/SessionRecordingManager.d.ts.map +1 -0
- package/dist/managers/ShadowDOMManager.d.ts +35 -0
- package/dist/managers/ShadowDOMManager.d.ts.map +1 -0
- package/dist/managers/StepTimeoutManager.d.ts +38 -0
- package/dist/managers/StepTimeoutManager.d.ts.map +1 -0
- package/dist/managers/TransitionManager.d.ts +73 -0
- package/dist/managers/TransitionManager.d.ts.map +1 -0
- package/dist/managers/VideoManager.d.ts +231 -0
- package/dist/managers/VideoManager.d.ts.map +1 -0
- package/dist/observers/EventObserver.d.ts +52 -0
- package/dist/observers/EventObserver.d.ts.map +1 -0
- package/dist/observers/UIObserver.d.ts +43 -0
- package/dist/observers/UIObserver.d.ts.map +1 -0
- package/dist/patterns/Observer.d.ts +63 -0
- package/dist/patterns/Observer.d.ts.map +1 -0
- package/dist/patterns/PlayerStateSubject.d.ts +34 -0
- package/dist/patterns/PlayerStateSubject.d.ts.map +1 -0
- package/dist/player.js +8 -0
- package/dist/player.min.js +6 -0
- package/dist/saltfish-playlist-player.es.js +7202 -0
- package/dist/saltfish-playlist-player.umd.js +1 -0
- package/dist/styles/index.d.ts +14 -0
- package/dist/styles/index.d.ts.map +1 -0
- package/dist/types/index.d.ts +337 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types.d.ts +5 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/utils/ErrorHandler.d.ts +106 -0
- package/dist/utils/ErrorHandler.d.ts.map +1 -0
- package/dist/utils/PositionCalculator.d.ts +90 -0
- package/dist/utils/PositionCalculator.d.ts.map +1 -0
- package/dist/utils/deviceDetection.d.ts +90 -0
- package/dist/utils/deviceDetection.d.ts.map +1 -0
- package/dist/utils/dimensions.d.ts +26 -0
- package/dist/utils/dimensions.d.ts.map +1 -0
- package/dist/utils/logger.d.ts +35 -0
- package/dist/utils/logger.d.ts.map +1 -0
- package/dist/utils/mockManifest.d.ts +27 -0
- package/dist/utils/mockManifest.d.ts.map +1 -0
- package/package.json +87 -0
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Logging utility for the Saltfish playlist Player
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Log a message to the console if logging is enabled
|
|
6
|
+
* @param message - The message to log
|
|
7
|
+
* @param data - Optional data to log
|
|
8
|
+
*/
|
|
9
|
+
export declare function log(message: string, data?: any): void;
|
|
10
|
+
/**
|
|
11
|
+
* Log important information that should be visible in production
|
|
12
|
+
* Uses console.info which is preserved in production builds
|
|
13
|
+
* @param message - The information message to log
|
|
14
|
+
* @param data - Optional data to log
|
|
15
|
+
*/
|
|
16
|
+
export declare function info(message: string, data?: any): void;
|
|
17
|
+
/**
|
|
18
|
+
* Log a warning to the console if logging is enabled
|
|
19
|
+
* @param message - The warning message to log
|
|
20
|
+
* @param data - Optional data to log
|
|
21
|
+
*/
|
|
22
|
+
export declare function warn(message: string, data?: any): void;
|
|
23
|
+
/**
|
|
24
|
+
* Log an error to the console (always enabled)
|
|
25
|
+
* @param message - The error message to log
|
|
26
|
+
* @param data - Optional data to log
|
|
27
|
+
*/
|
|
28
|
+
export declare function error(message: string, data?: any): void;
|
|
29
|
+
/**
|
|
30
|
+
* Log debugging information if logging is enabled
|
|
31
|
+
* @param message - The debug message to log
|
|
32
|
+
* @param data - Optional data to log
|
|
33
|
+
*/
|
|
34
|
+
export declare function debug(message: string, data?: any): void;
|
|
35
|
+
//# sourceMappingURL=logger.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/utils/logger.ts"],"names":[],"mappings":"AAAA;;GAEG;AAKH;;;;GAIG;AACH,wBAAgB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,IAAI,CAQrD;AAED;;;;;GAKG;AACH,wBAAgB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,IAAI,CAMtD;AAED;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,IAAI,CAQtD;AAED;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,IAAI,CAMvD;AAED;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,IAAI,CAQvD"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { playlistManifest } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* A realistic mock manifest for development and testing purposes.
|
|
4
|
+
* Follows the playlistManifest interface structure with sample content.
|
|
5
|
+
*/
|
|
6
|
+
export declare const mockManifest2: playlistManifest;
|
|
7
|
+
/**
|
|
8
|
+
* Main mock manifest with 8 steps for initial development and testing.
|
|
9
|
+
*/
|
|
10
|
+
export declare const mockManifest: playlistManifest;
|
|
11
|
+
/**
|
|
12
|
+
* Injects the mock manifest into the window object to be used by the
|
|
13
|
+
* application instead of making a real API call.
|
|
14
|
+
* This is designed to mimic a real API response.
|
|
15
|
+
*/
|
|
16
|
+
export declare function injectMockManifest(useSecond?: boolean): void;
|
|
17
|
+
/**
|
|
18
|
+
* Creates a custom mock manifest based on provided overrides.
|
|
19
|
+
* Useful for testing specific scenarios.
|
|
20
|
+
*
|
|
21
|
+
* @param overrides - Partial playlistManifest to override default values
|
|
22
|
+
* @param useSecond - Whether to use the second manifest as the base
|
|
23
|
+
* @returns The customized manifest
|
|
24
|
+
*/
|
|
25
|
+
export declare function createCustomMockManifest(overrides: Partial<playlistManifest>, useSecond?: boolean): playlistManifest;
|
|
26
|
+
export default mockManifest;
|
|
27
|
+
//# sourceMappingURL=mockManifest.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"mockManifest.d.ts","sourceRoot":"","sources":["../../src/utils/mockManifest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C;;;GAGG;AACH,eAAO,MAAM,aAAa,EAAE,gBAiF3B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY,EAAE,gBAyI1B,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,UAAQ,GAAG,IAAI,CAK1D;AAED;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CACtC,SAAS,EAAE,OAAO,CAAC,gBAAgB,CAAC,EACpC,SAAS,UAAQ,GAChB,gBAAgB,CAOlB;AAED,eAAe,YAAY,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "saltfish",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "An interactive video-guided tour system for web applications",
|
|
5
|
+
"main": "dist/saltfish-playlist-player.umd.js",
|
|
6
|
+
"types": "dist/index.d.ts",
|
|
7
|
+
"files": [
|
|
8
|
+
"dist",
|
|
9
|
+
"README.md",
|
|
10
|
+
"LICENSE"
|
|
11
|
+
],
|
|
12
|
+
"exports": {
|
|
13
|
+
".": {
|
|
14
|
+
"import": "./dist/saltfish-playlist-player.es.js",
|
|
15
|
+
"require": "./dist/saltfish-playlist-player.umd.js",
|
|
16
|
+
"types": "./dist/index.d.ts"
|
|
17
|
+
},
|
|
18
|
+
"./cdn": "./dist/player.min.js"
|
|
19
|
+
},
|
|
20
|
+
"keywords": [
|
|
21
|
+
"onboarding",
|
|
22
|
+
"interactive-tour",
|
|
23
|
+
"video-guided",
|
|
24
|
+
"user-experience",
|
|
25
|
+
"tutorial",
|
|
26
|
+
"walkthrough",
|
|
27
|
+
"feature-introduction",
|
|
28
|
+
"widget",
|
|
29
|
+
"player",
|
|
30
|
+
"tour-guide"
|
|
31
|
+
],
|
|
32
|
+
"author": "Saltfish AB",
|
|
33
|
+
"repository": {
|
|
34
|
+
"type": "git",
|
|
35
|
+
"url": "https://github.com/Saltfish-AB/playlist-player.git"
|
|
36
|
+
},
|
|
37
|
+
"bugs": {
|
|
38
|
+
"url": "https://github.com/Saltfish-AB/playlist-player/issues"
|
|
39
|
+
},
|
|
40
|
+
"homepage": "https://github.com/Saltfish-AB/playlist-player#readme",
|
|
41
|
+
"license": "PROPRIETARY",
|
|
42
|
+
"scripts": {
|
|
43
|
+
"dev": "vite --host",
|
|
44
|
+
"dev:test": "vite --config vite.test.config.ts",
|
|
45
|
+
"build": "node scripts/build.js",
|
|
46
|
+
"build:test": "node scripts/build.js --test",
|
|
47
|
+
"build:prod": "node scripts/build.js",
|
|
48
|
+
"preview": "vite preview",
|
|
49
|
+
"test": "jest",
|
|
50
|
+
"test:watch": "jest --watch",
|
|
51
|
+
"test:coverage": "jest --coverage",
|
|
52
|
+
"test:e2e": "playwright test",
|
|
53
|
+
"test:e2e:ui": "playwright test --ui",
|
|
54
|
+
"test:e2e:video": "playwright test --project=chromium",
|
|
55
|
+
"test:e2e:debug": "playwright test --debug",
|
|
56
|
+
"test:report": "npx playwright show-report",
|
|
57
|
+
"lint": "eslint src --ext .ts,.tsx",
|
|
58
|
+
"prepublishOnly": "npm run build",
|
|
59
|
+
"prepare": "npm run build"
|
|
60
|
+
},
|
|
61
|
+
"dependencies": {
|
|
62
|
+
"@chakra-ui/react": "^3.15.0",
|
|
63
|
+
"@emotion/react": "^11.14.0",
|
|
64
|
+
"@emotion/styled": "^11.14.0",
|
|
65
|
+
"framer-motion": "^12.6.3",
|
|
66
|
+
"immer": "^10.0.3",
|
|
67
|
+
"react": "^19.0.0",
|
|
68
|
+
"react-dom": "^19.0.0",
|
|
69
|
+
"react-router-dom": "^7.4.1",
|
|
70
|
+
"zustand": "^4.4.7"
|
|
71
|
+
},
|
|
72
|
+
"devDependencies": {
|
|
73
|
+
"@playwright/test": "^1.41.2",
|
|
74
|
+
"@types/jest": "^29.5.11",
|
|
75
|
+
"@types/node": "^20.10.6",
|
|
76
|
+
"@typescript-eslint/eslint-plugin": "^6.16.0",
|
|
77
|
+
"@typescript-eslint/parser": "^6.16.0",
|
|
78
|
+
"eslint": "^8.56.0",
|
|
79
|
+
"jest": "^29.7.0",
|
|
80
|
+
"jest-environment-jsdom": "^29.7.0",
|
|
81
|
+
"terser": "^5.26.0",
|
|
82
|
+
"ts-jest": "^29.1.1",
|
|
83
|
+
"typescript": "^5.3.3",
|
|
84
|
+
"vite": "^5.0.10",
|
|
85
|
+
"vite-plugin-remove-console": "^2.2.0"
|
|
86
|
+
}
|
|
87
|
+
}
|