@syntropysoft/syntropyfront 0.2.6 โ 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.
- package/LICENSE +204 -0
- package/README.md +65 -8
- package/dist/index.cjs +2750 -291
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +2750 -291
- package/dist/index.js.map +1 -1
- package/dist/index.min.js +1 -1
- package/dist/index.min.js.map +1 -1
- package/package.json +44 -11
package/LICENSE
ADDED
|
@@ -0,0 +1,204 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity granting the License.
|
|
13
|
+
|
|
14
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
15
|
+
other entities that control, are controlled by, or are under common
|
|
16
|
+
control with that entity. For the purposes of this definition,
|
|
17
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
18
|
+
direction or management of such entity, whether by contract or
|
|
19
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
20
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
21
|
+
|
|
22
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
23
|
+
exercising permissions granted by this License.
|
|
24
|
+
|
|
25
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
26
|
+
including but not limited to software source code, documentation
|
|
27
|
+
source, and configuration files.
|
|
28
|
+
|
|
29
|
+
"Object" form shall mean any form resulting from mechanical
|
|
30
|
+
transformation or translation of a Source form, including but
|
|
31
|
+
not limited to compiled object code, generated documentation,
|
|
32
|
+
and conversions to other media types.
|
|
33
|
+
|
|
34
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
35
|
+
Object form, made available under the License, as indicated by a
|
|
36
|
+
copyright notice that is included in or attached to the work
|
|
37
|
+
(an example is provided in the Appendix below).
|
|
38
|
+
|
|
39
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
40
|
+
form, that is based upon (or derived from) the Work and for which the
|
|
41
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
42
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
43
|
+
of this License, Derivative Works shall not include works that remain
|
|
44
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
45
|
+
the Work and Derivative Works thereof.
|
|
46
|
+
|
|
47
|
+
"Contribution" shall mean any work of authorship, including
|
|
48
|
+
the original version of the Work and any modifications or additions
|
|
49
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
50
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
51
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
52
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
53
|
+
means any form of electronic, verbal, or written communication sent
|
|
54
|
+
to the Licensor or its representatives, including but not limited to
|
|
55
|
+
communication on electronic mailing lists, source code control systems,
|
|
56
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
57
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
58
|
+
excluding communication that is conspicuously marked or otherwise
|
|
59
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
60
|
+
|
|
61
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
62
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
63
|
+
subsequently incorporated within the Work.
|
|
64
|
+
|
|
65
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
66
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
67
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
68
|
+
copyright license to use, reproduce, modify, merge, publish,
|
|
69
|
+
distribute, sublicense, and/or sell copies of the Work, and to
|
|
70
|
+
permit persons to whom the Work is furnished to do so, subject to
|
|
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.
|
|
75
|
+
|
|
76
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
77
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
78
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
79
|
+
(except as stated in this section) patent license to make, have made,
|
|
80
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
81
|
+
where such license applies only to those patent claims licensable
|
|
82
|
+
by such Contributor that are necessarily infringed by their
|
|
83
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
84
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
85
|
+
institute patent litigation against any entity (including a
|
|
86
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
87
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
88
|
+
or contributory patent infringement, then any patent licenses
|
|
89
|
+
granted to You under this License for that Work shall terminate
|
|
90
|
+
as of the date such litigation is filed.
|
|
91
|
+
|
|
92
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
93
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
94
|
+
modifications, and in Source or Object form, provided that You
|
|
95
|
+
meet the following conditions:
|
|
96
|
+
|
|
97
|
+
(a) You must give any other recipients of the Work or
|
|
98
|
+
Derivative Works a copy of this License; and
|
|
99
|
+
|
|
100
|
+
(b) You must cause any modified files to carry prominent notices
|
|
101
|
+
stating that You changed the files; and
|
|
102
|
+
|
|
103
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
104
|
+
that You distribute, all copyright, trademark, patent,
|
|
105
|
+
and attribution notices from the Source form of the Work,
|
|
106
|
+
excluding those notices that do not pertain to any part of
|
|
107
|
+
the Derivative Works; and
|
|
108
|
+
|
|
109
|
+
(d) If the Work includes a "NOTICE" file as part of its
|
|
110
|
+
distribution, then any Derivative Works that You distribute must
|
|
111
|
+
include a readable copy of the attribution notices contained
|
|
112
|
+
within such NOTICE file, excluding those notices that do not
|
|
113
|
+
pertain to any part of the Derivative Works, in at least one
|
|
114
|
+
of the following places: within a NOTICE file distributed
|
|
115
|
+
as part of the Derivative Works; within the Source form or
|
|
116
|
+
documentation, if provided along with the Derivative Works; or,
|
|
117
|
+
within a display generated by the Derivative Works, if and
|
|
118
|
+
wherever such third-party notices normally appear. The contents
|
|
119
|
+
of the NOTICE file are for informational purposes only and
|
|
120
|
+
do not modify the License. You may add Your own attribution
|
|
121
|
+
notices within Derivative Works that You distribute, alongside
|
|
122
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
123
|
+
that such additional attribution notices cannot be construed
|
|
124
|
+
as modifying the License.
|
|
125
|
+
|
|
126
|
+
You may add Your own copyright notice to Your modifications and
|
|
127
|
+
may provide additional or different license terms and conditions
|
|
128
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
129
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
130
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
131
|
+
the conditions stated in this License.
|
|
132
|
+
|
|
133
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
134
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
135
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
136
|
+
this License, without any additional terms or conditions.
|
|
137
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
138
|
+
the terms of any separate license agreement you may have executed
|
|
139
|
+
with Licensor regarding such Contributions.
|
|
140
|
+
|
|
141
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
142
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
143
|
+
except as required for reasonable and customary use in describing the
|
|
144
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
145
|
+
|
|
146
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
147
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
148
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
149
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
150
|
+
implied, including, without limitation, any warranties or conditions
|
|
151
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
152
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
153
|
+
appropriateness of using or redistributing the Work and assume any
|
|
154
|
+
risks associated with Your exercise of permissions under this License.
|
|
155
|
+
|
|
156
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
157
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
158
|
+
unless required by applicable law (such as deliberate and grossly
|
|
159
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
160
|
+
liable to You for damages, including any direct, indirect, special,
|
|
161
|
+
incidental, or consequential damages of any character arising as a
|
|
162
|
+
result of this License or out of the use or inability to use the
|
|
163
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
164
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
165
|
+
other commercial damages or losses), even if such Contributor
|
|
166
|
+
has been advised of the possibility of such damages.
|
|
167
|
+
|
|
168
|
+
9. Accepting Warranty or Additional Liability. When redistributing
|
|
169
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
170
|
+
and to charge a fee for, warranty, support, indemnity or other
|
|
171
|
+
liability obligations and/or rights consistent with this License.
|
|
172
|
+
However, in accepting such obligations, You may act only on Your
|
|
173
|
+
own behalf and on Your sole responsibility, not on behalf of any
|
|
174
|
+
other Contributor, and only if You agree to indemnify, defend,
|
|
175
|
+
and hold each Contributor harmless for any liability incurred by,
|
|
176
|
+
or claims asserted against, such Contributor by reason of your
|
|
177
|
+
accepting any such warranty or additional liability.
|
|
178
|
+
|
|
179
|
+
END OF TERMS AND CONDITIONS
|
|
180
|
+
|
|
181
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
182
|
+
|
|
183
|
+
To apply the Apache License to your work, attach the following
|
|
184
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
185
|
+
replaced with your own identifying information. (Don't include
|
|
186
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
187
|
+
comment syntax for the file format. We also recommend that a
|
|
188
|
+
file or class name and description of purpose be included on the
|
|
189
|
+
same page as the copyright notice for easier identification within
|
|
190
|
+
third-party archives.
|
|
191
|
+
|
|
192
|
+
Copyright [yyyy] [name of copyright owner]
|
|
193
|
+
|
|
194
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
195
|
+
you may not use this file except in compliance with the License.
|
|
196
|
+
You may obtain a copy of the License at
|
|
197
|
+
|
|
198
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
199
|
+
|
|
200
|
+
Unless required by applicable law or agreed to in writing, software
|
|
201
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
202
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
203
|
+
See the License for the specific language governing permissions and
|
|
204
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -12,17 +12,19 @@
|
|
|
12
12
|
|
|
13
13
|
<p align="center">
|
|
14
14
|
<a href="https://www.npmjs.com/package/@syntropysoft/syntropyfront"><img src="https://img.shields.io/npm/v/@syntropysoft/syntropyfront.svg" alt="NPM Version"></a>
|
|
15
|
-
<a href="https://github.com/Syntropysoft/
|
|
15
|
+
<a href="https://github.com/Syntropysoft/syntropyfront/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/@syntropysoft/syntropyfront.svg" alt="License"></a>
|
|
16
16
|
<a href="#"><img src="https://img.shields.io/badge/status-ready%20for%20production-brightgreen.svg" alt="Ready for Production"></a>
|
|
17
17
|
<a href="#"><img src="https://github.com/Syntropysoft/syntropyfront/workflows/CodeQL/badge.svg" alt="CodeQL"></a>
|
|
18
18
|
<a href="#"><img src="https://img.shields.io/badge/dependabot-enabled-brightgreen.svg" alt="Dependabot"></a>
|
|
19
|
-
<a href="#"><img src="https://img.shields.io/badge/mutation%20score-
|
|
20
|
-
<a href="#"><img src="https://img.shields.io/badge/test%20coverage-
|
|
19
|
+
<a href="#"><img src="https://img.shields.io/badge/mutation%20score-71.03%25-brightgreen.svg" alt="Mutation Score"></a>
|
|
20
|
+
<a href="#"><img src="https://img.shields.io/badge/test%20coverage-89.47%25-brightgreen.svg" alt="Test Coverage"></a>
|
|
21
|
+
<a href="#"><img src="https://img.shields.io/badge/bundle%20size-34%20KB-brightgreen.svg" alt="Bundle Size"></a>
|
|
22
|
+
<a href="https://socket.dev/npm/package/@syntropysoft/syntropyfront"><img src="https://socket.dev/api/badge/npm/package/@syntropysoft/syntropyfront" alt="Socket Badge"></a>
|
|
21
23
|
</p>
|
|
22
24
|
|
|
23
25
|
---
|
|
24
26
|
|
|
25
|
-
๐ **Observability library with automatic capture - Just 1 line of code!**
|
|
27
|
+
๐ **Observability library with automatic capture - Just 1 line of code! No dependencies!**
|
|
26
28
|
|
|
27
29
|
SyntropyFront automatically captures user interactions, errors, HTTP calls, and console logs, providing comprehensive observability for your web applications with minimal setup.
|
|
28
30
|
|
|
@@ -35,6 +37,8 @@ SyntropyFront automatically captures user interactions, errors, HTTP calls, and
|
|
|
35
37
|
- ๐พ **Smart storage** - Keeps the last N events (configurable)
|
|
36
38
|
- ๐ค **Flexible posting** - Posts errors to your endpoint or logs to console
|
|
37
39
|
- โก **Zero configuration** - Works out of the box with just an import
|
|
40
|
+
- ๐ฆ **Zero Dependencies** - 100% standalone, no runtime dependencies
|
|
41
|
+
- ๐ก๏ธ **Highly Resilient** - Automatic retry and persistent queuing
|
|
38
42
|
|
|
39
43
|
## ๐ Quick Start
|
|
40
44
|
|
|
@@ -100,6 +104,35 @@ syntropyFront.configure({
|
|
|
100
104
|
npm install @syntropysoft/syntropyfront
|
|
101
105
|
```
|
|
102
106
|
|
|
107
|
+
## ๐ **Performance Optimizations (v0.4.0)**
|
|
108
|
+
|
|
109
|
+
SyntropyFront has been optimized for maximum performance and minimal bundle size:
|
|
110
|
+
|
|
111
|
+
### **๐ฏ Testing Excellence**
|
|
112
|
+
- **Mutation Score**: **71.03%** (Total) / **80.02%** (Covered) verified with Stryker
|
|
113
|
+
- **Test Coverage**: **81.47% Branch Coverage** (90.07% Lines)
|
|
114
|
+
- **430+ Comprehensive Tests**: Covering all edge cases and resilience scenarios
|
|
115
|
+
- **Database Modules**: All modules now have 77-100% mutation score
|
|
116
|
+
- **Core Components**: 92.70% average mutation score across agent modules
|
|
117
|
+
|
|
118
|
+
### **๐ฆ Ultra-Lightweight Bundle**
|
|
119
|
+
- **Zero Runtime Dependencies**: No more external requirements.
|
|
120
|
+
- **Bundle Size**: **34 KB** minified (fully featured with offline support)
|
|
121
|
+
- **ES Module**: 80 KB (unminified)
|
|
122
|
+
- **Zero Runtime Dependencies**: Near-instant installation and minimal noise
|
|
123
|
+
|
|
124
|
+
### **๐ง Smart Dependency Management**
|
|
125
|
+
- **Clean Architecture**: All testing tools properly categorized as devDependencies
|
|
126
|
+
- **Dependabot Optimized**: Smart configuration prevents incompatible updates
|
|
127
|
+
- **Stable CI/CD**: Eliminated dependency conflicts and CI failures
|
|
128
|
+
- **Cross-Node Compatibility**: Full support for Node.js 18, 20, 22
|
|
129
|
+
|
|
130
|
+
### **โก Production Ready**
|
|
131
|
+
- **Zero Breaking Changes**: All existing code continues to work
|
|
132
|
+
- **Same API**: Identical usage patterns and configuration
|
|
133
|
+
- **Better Performance**: Optimized for production environments
|
|
134
|
+
- **Maintained Security**: All security benefits preserved
|
|
135
|
+
|
|
103
136
|
## ๐ฏ How It Works
|
|
104
137
|
|
|
105
138
|
SyntropyFront automatically:
|
|
@@ -445,7 +478,7 @@ src/core/
|
|
|
445
478
|
- **Single Responsibility Principle (SRP)**: Each class has one clear purpose
|
|
446
479
|
- **Dependency Injection**: Components receive dependencies through constructors
|
|
447
480
|
- **Declarative Error Handling**: Structured error responses with fallbacks
|
|
448
|
-
- **Comprehensive Testing**:
|
|
481
|
+
- **Comprehensive Testing**: 488 tests with 74.96% mutation score
|
|
449
482
|
- **Optimized Performance**: Timeouts optimized for faster execution
|
|
450
483
|
|
|
451
484
|
## ๐งช Testing & Quality
|
|
@@ -454,8 +487,8 @@ SyntropyFront maintains high code quality through comprehensive testing:
|
|
|
454
487
|
|
|
455
488
|
### Test Coverage & Mutation Testing
|
|
456
489
|
|
|
457
|
-
- **Mutation Score**:
|
|
458
|
-
- **Test Coverage**:
|
|
490
|
+
- **Mutation Score**: 74.96% - Our tests effectively detect code changes
|
|
491
|
+
- **Test Coverage**: 91.01% - Comprehensive unit test coverage
|
|
459
492
|
- **Key Components Performance**:
|
|
460
493
|
- `Agent.js`: 87.23% mutation score
|
|
461
494
|
- `ConfigurationManager.js`: 100% mutation score
|
|
@@ -465,6 +498,9 @@ SyntropyFront maintains high code quality through comprehensive testing:
|
|
|
465
498
|
- `BreadcrumbStore.js`: 95.00% mutation score
|
|
466
499
|
- `SerializationManager.js`: 100% mutation score
|
|
467
500
|
- `DatabaseTransactionManager.js`: 100% mutation score
|
|
501
|
+
- `DatabaseConfigManager.js`: 86.89% mutation score
|
|
502
|
+
- `DatabaseConnectionManager.js`: 85.96% mutation score
|
|
503
|
+
- `PersistentBufferManager.js`: 77.63% mutation score
|
|
468
504
|
|
|
469
505
|
### Testing Stack
|
|
470
506
|
|
|
@@ -486,6 +522,16 @@ npm run test:coverage
|
|
|
486
522
|
npm run test:mutation
|
|
487
523
|
```
|
|
488
524
|
|
|
525
|
+
|
|
526
|
+
## ๐ก๏ธ Security & Privacy
|
|
527
|
+
|
|
528
|
+
SyntropyFront is designed with security and transparency in mind:
|
|
529
|
+
|
|
530
|
+
- **Network Access**: Telemetry is sent **only** to the endpoint you configure via `configure({ fetch: { url: '...' } })`. By default, it only logs to the browser console.
|
|
531
|
+
- **No Third-Party Tracking**: We don't include any tracking or analytics scripts. Your data is yours.
|
|
532
|
+
- **PII Protection**: Breadcrumbs focus on technical context. We recommend using a custom `onError` handler to scrub sensitive data if necessary.
|
|
533
|
+
- **Zero Runtime Dependencies**: Minimizes the attack surface by not relying on external code at runtime.
|
|
534
|
+
|
|
489
535
|
## ๐ Debugging
|
|
490
536
|
|
|
491
537
|
SyntropyFront logs helpful information to the console:
|
|
@@ -498,7 +544,18 @@ SyntropyFront logs helpful information to the console:
|
|
|
498
544
|
|
|
499
545
|
## ๐ License
|
|
500
546
|
|
|
501
|
-
Apache 2.0
|
|
547
|
+
This project is licensed under the Apache License, Version 2.0 - see the [LICENSE](LICENSE) file for details.
|
|
548
|
+
|
|
549
|
+
**Apache License 2.0** - A permissive license that allows for:
|
|
550
|
+
- โ
Commercial use
|
|
551
|
+
- โ
Modification
|
|
552
|
+
- โ
Distribution
|
|
553
|
+
- โ
Patent use
|
|
554
|
+
- โ
Private use
|
|
555
|
+
|
|
556
|
+
The only requirement is that you include the original copyright notice and license text in any substantial portions of the software you distribute.
|
|
557
|
+
|
|
558
|
+
For more information, visit: https://www.apache.org/licenses/LICENSE-2.0
|
|
502
559
|
|
|
503
560
|
## ๐ค Contributing
|
|
504
561
|
|