@syntropysoft/syntropyfront 0.4.2 → 0.4.4
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/CODE_OF_CONDUCT.md +46 -0
- package/CONTRIBUTING.md +73 -0
- package/LICENSE +25 -27
- package/NOTICE +2 -0
- package/README.md +1 -1
- package/SECURITY.md +25 -0
- package/package.json +23 -28
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
|
6
|
+
|
|
7
|
+
## Our Standards
|
|
8
|
+
|
|
9
|
+
Examples of behavior that contributes to creating a positive environment include:
|
|
10
|
+
|
|
11
|
+
* Using welcoming and inclusive language
|
|
12
|
+
* Being respectful of differing viewpoints and experiences
|
|
13
|
+
* Gracefully accepting constructive criticism
|
|
14
|
+
* Focusing on what is best for the community
|
|
15
|
+
* Showing empathy towards other community members
|
|
16
|
+
|
|
17
|
+
Examples of unacceptable behavior by participants include:
|
|
18
|
+
|
|
19
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
|
|
20
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
|
21
|
+
* Public or private harassment
|
|
22
|
+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
|
|
23
|
+
* Other conduct which could reasonably be considered inappropriate in a professional setting
|
|
24
|
+
|
|
25
|
+
## Our Responsibilities
|
|
26
|
+
|
|
27
|
+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
|
|
28
|
+
|
|
29
|
+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
|
|
30
|
+
|
|
31
|
+
## Scope
|
|
32
|
+
|
|
33
|
+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
|
|
34
|
+
|
|
35
|
+
## Enforcement
|
|
36
|
+
|
|
37
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at gabriel70@gmail.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
|
|
38
|
+
|
|
39
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
|
|
40
|
+
|
|
41
|
+
## Attribution
|
|
42
|
+
|
|
43
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html][version]
|
|
44
|
+
|
|
45
|
+
[homepage]: https://www.contributor-covenant.org
|
|
46
|
+
[version]: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# Contributing to SyntropyFront
|
|
2
|
+
|
|
3
|
+
Thank you for your interest in contributing to SyntropyFront! We welcome contributions from the community to help make this observability library even better.
|
|
4
|
+
|
|
5
|
+
## Development Workflow
|
|
6
|
+
|
|
7
|
+
### Prerequisites
|
|
8
|
+
|
|
9
|
+
- Node.js >= 20.0.0
|
|
10
|
+
- pnpm
|
|
11
|
+
|
|
12
|
+
### Setup
|
|
13
|
+
|
|
14
|
+
1. Clone the repository:
|
|
15
|
+
```bash
|
|
16
|
+
git clone https://github.com/Syntropysoft/syntropyfront.git
|
|
17
|
+
cd syntropyfront
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
2. Install dependencies:
|
|
21
|
+
```bash
|
|
22
|
+
pnpm install
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### Running Tests
|
|
26
|
+
|
|
27
|
+
We maintain high quality through extensive testing. Please ensure all tests pass before submitting a pull request.
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
# Run all tests
|
|
31
|
+
pnpm test
|
|
32
|
+
|
|
33
|
+
# Run tests with coverage
|
|
34
|
+
pnpm run test:coverage
|
|
35
|
+
|
|
36
|
+
# Run mutation testing (Stryker)
|
|
37
|
+
pnpm run test:mutation
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Linting
|
|
41
|
+
|
|
42
|
+
We use ESLint to maintain code style and quality.
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
# Run linter
|
|
46
|
+
pnpm run lint
|
|
47
|
+
|
|
48
|
+
# Fix linting issues automatically
|
|
49
|
+
pnpm run lint:fix
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Building
|
|
53
|
+
|
|
54
|
+
To build the library:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
pnpm run build
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Pull Request Process
|
|
61
|
+
|
|
62
|
+
1. Create a new branch for your feature or bug fix.
|
|
63
|
+
2. Ensure your code follows the existing style and is well-tested.
|
|
64
|
+
3. Update the `README.md` or documentation if applicable.
|
|
65
|
+
4. Submit a pull request with a clear description of the changes.
|
|
66
|
+
|
|
67
|
+
## Code of Conduct
|
|
68
|
+
|
|
69
|
+
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
|
|
70
|
+
|
|
71
|
+
## License
|
|
72
|
+
|
|
73
|
+
By contributing, you agree that your contributions will be licensed under the [Apache License 2.0](LICENSE).
|
package/LICENSE
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
|
|
1
2
|
Apache License
|
|
2
3
|
Version 2.0, January 2004
|
|
3
4
|
http://www.apache.org/licenses/
|
|
@@ -9,7 +10,8 @@
|
|
|
9
10
|
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
11
|
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
12
|
|
|
12
|
-
"Licensor" shall mean the copyright owner or entity
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
13
15
|
|
|
14
16
|
"Legal Entity" shall mean the union of the acting entity and all
|
|
15
17
|
other entities that control, are controlled by, or are under common
|
|
@@ -37,7 +39,7 @@
|
|
|
37
39
|
(an example is provided in the Appendix below).
|
|
38
40
|
|
|
39
41
|
"Derivative Works" shall mean any work, whether in Source or Object
|
|
40
|
-
form, that is based
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
41
43
|
editorial revisions, annotations, elaborations, or other modifications
|
|
42
44
|
represent, as a whole, an original work of authorship. For the purposes
|
|
43
45
|
of this License, Derivative Works shall not include works that remain
|
|
@@ -65,13 +67,9 @@
|
|
|
65
67
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
66
68
|
this License, each Contributor hereby grants to You a perpetual,
|
|
67
69
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
68
|
-
copyright license to
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
the following conditions:
|
|
72
|
-
|
|
73
|
-
The above copyright notice and this permission notice shall be
|
|
74
|
-
included in all copies or substantial portions of the Work.
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
75
73
|
|
|
76
74
|
3. Grant of Patent License. Subject to the terms and conditions of
|
|
77
75
|
this License, each Contributor hereby grants to You a perpetual,
|
|
@@ -101,17 +99,17 @@
|
|
|
101
99
|
stating that You changed the files; and
|
|
102
100
|
|
|
103
101
|
(c) You must retain, in the Source form of any Derivative Works
|
|
104
|
-
that You distribute, all copyright, trademark,
|
|
105
|
-
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
106
104
|
excluding those notices that do not pertain to any part of
|
|
107
105
|
the Derivative Works; and
|
|
108
106
|
|
|
109
|
-
(d) If the Work includes a "NOTICE" file as part of its
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
110
108
|
distribution, then any Derivative Works that You distribute must
|
|
111
109
|
include a readable copy of the attribution notices contained
|
|
112
110
|
within such NOTICE file, excluding those notices that do not
|
|
113
111
|
pertain to any part of the Derivative Works, in at least one
|
|
114
|
-
of the following places: within a NOTICE file distributed
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
115
113
|
as part of the Derivative Works; within the Source form or
|
|
116
114
|
documentation, if provided along with the Derivative Works; or,
|
|
117
115
|
within a display generated by the Derivative Works, if and
|
|
@@ -123,7 +121,7 @@
|
|
|
123
121
|
that such additional attribution notices cannot be construed
|
|
124
122
|
as modifying the License.
|
|
125
123
|
|
|
126
|
-
You may add Your own copyright
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
127
125
|
may provide additional or different license terms and conditions
|
|
128
126
|
for use, reproduction, or distribution of Your modifications, or
|
|
129
127
|
for any such Derivative Works as a whole, provided Your use,
|
|
@@ -165,16 +163,16 @@
|
|
|
165
163
|
other commercial damages or losses), even if such Contributor
|
|
166
164
|
has been advised of the possibility of such damages.
|
|
167
165
|
|
|
168
|
-
9. Accepting Warranty or Additional Liability.
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
169
167
|
the Work or Derivative Works thereof, You may choose to offer,
|
|
170
|
-
and
|
|
171
|
-
liability obligations and/or rights consistent with this
|
|
172
|
-
However, in accepting such obligations, You may act only
|
|
173
|
-
own behalf and on Your sole responsibility, not on behalf
|
|
174
|
-
other Contributor, and only if You agree to indemnify,
|
|
175
|
-
and hold each Contributor harmless for any liability
|
|
176
|
-
or claims asserted against, such Contributor by reason
|
|
177
|
-
accepting any such warranty or additional liability.
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
178
176
|
|
|
179
177
|
END OF TERMS AND CONDITIONS
|
|
180
178
|
|
|
@@ -186,10 +184,10 @@
|
|
|
186
184
|
the brackets!) The text should be enclosed in the appropriate
|
|
187
185
|
comment syntax for the file format. We also recommend that a
|
|
188
186
|
file or class name and description of purpose be included on the
|
|
189
|
-
same page as the copyright notice for easier
|
|
190
|
-
third-party archives.
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
191
189
|
|
|
192
|
-
Copyright
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
193
191
|
|
|
194
192
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
195
193
|
you may not use this file except in compliance with the License.
|
|
@@ -201,4 +199,4 @@
|
|
|
201
199
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
202
200
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
203
201
|
See the License for the specific language governing permissions and
|
|
204
|
-
limitations under the License.
|
|
202
|
+
limitations under the License.
|
package/NOTICE
ADDED
package/README.md
CHANGED
|
@@ -104,7 +104,7 @@ syntropyFront.configure({
|
|
|
104
104
|
pnpm add @syntropysoft/syntropyfront
|
|
105
105
|
```
|
|
106
106
|
|
|
107
|
-
## 🚀 **Quality & Performance (v0.4.
|
|
107
|
+
## 🚀 **Quality & Performance (v0.4.4)**
|
|
108
108
|
|
|
109
109
|
SyntropyFront has been optimized for maximum performance and minimal bundle size:
|
|
110
110
|
|
package/SECURITY.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
## Supported Versions
|
|
4
|
+
|
|
5
|
+
Only the latest version of SyntropyFront is supported for security updates.
|
|
6
|
+
|
|
7
|
+
| Version | Supported |
|
|
8
|
+
| ------- | ------------------ |
|
|
9
|
+
| >= 0.4.x| :white_check_mark: |
|
|
10
|
+
| < 0.4.0 | :x: |
|
|
11
|
+
|
|
12
|
+
## Reporting a Vulnerability
|
|
13
|
+
|
|
14
|
+
We take the security of SyntropyFront seriously. If you believe you have found a security vulnerability, please report it to us as soon as possible.
|
|
15
|
+
|
|
16
|
+
**Please do not report security vulnerabilities through public GitHub issues.**
|
|
17
|
+
|
|
18
|
+
Instead, please report vulnerabilities by emailing Gabriel Alejandro Gomez at gabriel70@gmail.com.
|
|
19
|
+
|
|
20
|
+
When reporting a vulnerability, please include:
|
|
21
|
+
- A clear description of the vulnerability.
|
|
22
|
+
- Steps to reproduce the issue.
|
|
23
|
+
- Potential impact.
|
|
24
|
+
|
|
25
|
+
We will acknowledge your report within 48 hours and provide a timeline for addressing the issue. We appreciate your efforts to keep the project and its users secure.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@syntropysoft/syntropyfront",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.4",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "🚀 Observability library with automatic capture - Just 1 line of code! Automatically captures clicks, errors, HTTP calls, and console logs with flexible error handling.",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
"exports": {
|
|
10
10
|
".": {
|
|
11
11
|
"import": "./dist/index.js",
|
|
12
|
-
"require": "./dist/index.
|
|
12
|
+
"require": "./dist/index.cjs",
|
|
13
13
|
"types": "./dist/index.d.ts"
|
|
14
14
|
},
|
|
15
15
|
"./package.json": "./package.json"
|
|
@@ -17,24 +17,12 @@
|
|
|
17
17
|
"files": [
|
|
18
18
|
"dist",
|
|
19
19
|
"README.md",
|
|
20
|
-
"LICENSE"
|
|
20
|
+
"LICENSE",
|
|
21
|
+
"NOTICE",
|
|
22
|
+
"CONTRIBUTING.md",
|
|
23
|
+
"SECURITY.md",
|
|
24
|
+
"CODE_OF_CONDUCT.md"
|
|
21
25
|
],
|
|
22
|
-
"scripts": {
|
|
23
|
-
"build": "rollup -c",
|
|
24
|
-
"build:watch": "rollup -c -w",
|
|
25
|
-
"dev": "pnpm run build:watch",
|
|
26
|
-
"test": "jest",
|
|
27
|
-
"test:watch": "jest --watch",
|
|
28
|
-
"test:coverage": "jest --config jest.config.coverage.cjs",
|
|
29
|
-
"test:mutation": "stryker run",
|
|
30
|
-
"test:mutation:watch": "stryker run",
|
|
31
|
-
"test:mutation:quick": "stryker run stryker.quick.conf.json",
|
|
32
|
-
"clean": "rm -rf dist",
|
|
33
|
-
"lint": "eslint src --ext .js",
|
|
34
|
-
"lint:fix": "eslint src --ext .js --fix",
|
|
35
|
-
"postbuild": "cp src/index.d.ts dist/index.d.ts",
|
|
36
|
-
"prepublishOnly": "pnpm run clean && pnpm run build && pnpm test"
|
|
37
|
-
},
|
|
38
26
|
"keywords": [
|
|
39
27
|
"frontend",
|
|
40
28
|
"frontend-monitoring",
|
|
@@ -116,17 +104,24 @@
|
|
|
116
104
|
"jest-environment-jsdom": "^30.2.0",
|
|
117
105
|
"rollup": "^4.59.0"
|
|
118
106
|
},
|
|
119
|
-
"pnpm": {
|
|
120
|
-
"overrides": {
|
|
121
|
-
"serialize-javascript": "^7.0.3"
|
|
122
|
-
},
|
|
123
|
-
"ignoredBuiltDependencies": [
|
|
124
|
-
"unrs-resolver"
|
|
125
|
-
]
|
|
126
|
-
},
|
|
127
107
|
"browserslist": [
|
|
128
108
|
"> 1%",
|
|
129
109
|
"last 2 versions",
|
|
130
110
|
"not dead"
|
|
131
|
-
]
|
|
111
|
+
],
|
|
112
|
+
"scripts": {
|
|
113
|
+
"build": "rollup -c",
|
|
114
|
+
"build:watch": "rollup -c -w",
|
|
115
|
+
"dev": "pnpm run build:watch",
|
|
116
|
+
"test": "jest",
|
|
117
|
+
"test:watch": "jest --watch",
|
|
118
|
+
"test:coverage": "jest --config jest.config.coverage.cjs",
|
|
119
|
+
"test:mutation": "stryker run",
|
|
120
|
+
"test:mutation:watch": "stryker run",
|
|
121
|
+
"test:mutation:quick": "stryker run stryker.quick.conf.json",
|
|
122
|
+
"clean": "rm -rf dist",
|
|
123
|
+
"lint": "eslint src --ext .js",
|
|
124
|
+
"lint:fix": "eslint src --ext .js --fix",
|
|
125
|
+
"postbuild": "cp src/index.d.ts dist/index.d.ts"
|
|
126
|
+
}
|
|
132
127
|
}
|