@crimson-education/browser-logger 2.0.2-cognito.1 → 2.0.2-cognito.2

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.
Files changed (2) hide show
  1. package/README.md +10 -3
  2. package/package.json +5 -3
package/README.md CHANGED
@@ -1,6 +1,10 @@
1
1
  # Crimson Education Browser Logger
2
2
 
3
- An abstract logger and reporting utility for browser environments
3
+ An abstract logger and reporting utility for browser environments.
4
+
5
+ This library contains a number of reporters that is will send analytics to.
6
+
7
+ These must be enabled by calling `Logger.init()`, as seen below.
4
8
 
5
9
  ## Install
6
10
 
@@ -16,15 +20,18 @@ yarn add @crimson-education/browser-logger
16
20
 
17
21
  ## Usage
18
22
 
19
- ### Initialise
23
+ ### Initialize
20
24
 
21
25
  ```ts
22
26
  import * as Logger from '@crimson-education/browser-logger';
23
27
 
24
28
  Logger.init({
25
- service: 'browser-project',
29
+ service: 'test-project',
26
30
  environment: config.environment,
27
31
  version: config.version,
32
+ defaultMetadata: {
33
+ application: 'test',
34
+ },
28
35
 
29
36
  datadog: {
30
37
  applicationId: config.datadogApplicationId,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@crimson-education/browser-logger",
3
- "version": "2.0.2-cognito.1",
3
+ "version": "2.0.2-cognito.2",
4
4
  "description": "An abstract logger and reporting utility for browser environments",
5
5
  "scripts": {
6
6
  "prepack": "npm run build",
@@ -27,8 +27,7 @@
27
27
  },
28
28
  "homepage": "https://github.com/crimson-education/browser-logger#readme",
29
29
  "dependencies": {
30
- "@aws-amplify/analytics": "^5.2.1",
31
- "@aws-amplify/auth": "^4.4.3",
30
+ "@aws-amplify/analytics": "^5.2.22",
32
31
  "@datadog/browser-logs": "^4.4.0",
33
32
  "@datadog/browser-rum": "^4.4.0"
34
33
  },
@@ -43,6 +42,9 @@
43
42
  "ts-jest": "^27.1.1",
44
43
  "typescript": "^4.1.2"
45
44
  },
45
+ "peerDependencies": {
46
+ "@aws-amplify/auth": "^4.6.8"
47
+ },
46
48
  "files": [
47
49
  "lib",
48
50
  "src"