@xiboplayer/utils 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/docs/README.md +61 -0
- package/package.json +36 -0
- package/src/cms-api.js +764 -0
- package/src/cms-api.test.js +803 -0
- package/src/config.js +288 -0
- package/src/config.test.js +473 -0
- package/src/event-emitter.js +77 -0
- package/src/event-emitter.test.js +432 -0
- package/src/fetch-retry.js +61 -0
- package/src/fetch-retry.test.js +108 -0
- package/src/index.js +6 -0
- package/src/logger.js +237 -0
- package/src/logger.test.js +477 -0
- package/vitest.config.js +8 -0
package/docs/README.md
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# @xiboplayer/utils Documentation
|
|
2
|
+
|
|
3
|
+
**Shared utilities for all Xibo Player packages.**
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
Common utilities:
|
|
8
|
+
|
|
9
|
+
- **Logger** - Structured logging
|
|
10
|
+
- **EventEmitter** - Pub/sub event bus
|
|
11
|
+
- **Config** - Configuration management
|
|
12
|
+
- **Helpers** - Utility functions
|
|
13
|
+
|
|
14
|
+
## Installation
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install @xiboplayer/utils
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
```javascript
|
|
23
|
+
import { Logger, EventEmitter } from '@xiboplayer/utils';
|
|
24
|
+
|
|
25
|
+
// Logger
|
|
26
|
+
const log = new Logger('MyModule');
|
|
27
|
+
log.info('Message', { data: 123 });
|
|
28
|
+
|
|
29
|
+
// EventEmitter
|
|
30
|
+
const emitter = new EventEmitter();
|
|
31
|
+
emitter.on('event', (data) => console.log(data));
|
|
32
|
+
emitter.emit('event', { foo: 'bar' });
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## API Reference
|
|
36
|
+
|
|
37
|
+
### Logger
|
|
38
|
+
|
|
39
|
+
```javascript
|
|
40
|
+
logger.debug(message, data)
|
|
41
|
+
logger.info(message, data)
|
|
42
|
+
logger.warn(message, data)
|
|
43
|
+
logger.error(message, data)
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### EventEmitter
|
|
47
|
+
|
|
48
|
+
```javascript
|
|
49
|
+
emitter.on(event, callback)
|
|
50
|
+
emitter.once(event, callback)
|
|
51
|
+
emitter.off(event, callback)
|
|
52
|
+
emitter.emit(event, data)
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Dependencies
|
|
56
|
+
|
|
57
|
+
None (zero dependencies)
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
**Package Version**: 1.0.0
|
package/package.json
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@xiboplayer/utils",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Shared utilities for Xibo Player packages",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "./src/index.js",
|
|
7
|
+
"exports": {
|
|
8
|
+
".": "./src/index.js",
|
|
9
|
+
"./logger": "./src/logger.js",
|
|
10
|
+
"./event-emitter": "./src/event-emitter.js",
|
|
11
|
+
"./config": "./src/config.js"
|
|
12
|
+
},
|
|
13
|
+
"dependencies": {},
|
|
14
|
+
"devDependencies": {
|
|
15
|
+
"vitest": "^2.0.0"
|
|
16
|
+
},
|
|
17
|
+
"keywords": [
|
|
18
|
+
"xibo",
|
|
19
|
+
"digital-signage",
|
|
20
|
+
"utilities",
|
|
21
|
+
"logger",
|
|
22
|
+
"event-emitter"
|
|
23
|
+
],
|
|
24
|
+
"author": "Pau Aliagas <linuxnow@gmail.com>",
|
|
25
|
+
"license": "AGPL-3.0-or-later",
|
|
26
|
+
"repository": {
|
|
27
|
+
"type": "git",
|
|
28
|
+
"url": "git+https://github.com/xibo-players/xiboplayer.git",
|
|
29
|
+
"directory": "packages/utils"
|
|
30
|
+
},
|
|
31
|
+
"scripts": {
|
|
32
|
+
"test": "vitest run",
|
|
33
|
+
"test:watch": "vitest",
|
|
34
|
+
"test:coverage": "vitest run --coverage"
|
|
35
|
+
}
|
|
36
|
+
}
|