@fluidframework/app-insights-logger 2.1.0-281041 → 2.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.
Files changed (3) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/README.md +60 -23
  3. package/package.json +5 -5
package/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # @fluid-internal/app-insights-logger
2
2
 
3
+ ## 2.1.0
4
+
5
+ Dependency updates only.
6
+
3
7
  ## 2.0.0-rc.5.0.0
4
8
 
5
9
  ### Minor Changes
package/README.md CHANGED
@@ -11,11 +11,19 @@ You create an App Insights Instance and then configure your applications to send
11
11
  This could be general machine related health being automatically reported to the instance when you install a logging program on your service’s machines or custom metrics that you manually configure your applications to send. Keep in mind this logger is intended for use with browser based web applications, not pure nodeJS.
12
12
  In our case, we are sending custom metrics. [Learn more about Azure App Insights with their docs](https://learn.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview?tabs=net)
13
13
 
14
- <!-- AUTO-GENERATED-CONTENT:START (README_INSTALLATION_SECTION:includeHeading=TRUE&devDependency=FALSE) -->
14
+ <!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README_HEADER) -->
15
15
 
16
16
  <!-- prettier-ignore-start -->
17
17
  <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
18
18
 
19
+ ## Using Fluid Framework libraries
20
+
21
+ When taking a dependency on a Fluid Framework library's public APIs, we recommend using a `^` (caret) version range, such as `^1.3.4`.
22
+ While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
23
+ library consumers should always prefer `^`.
24
+
25
+ If using any of Fluid Framework's unstable APIs (for example, its `beta` APIs), we recommend using a more constrained version range, such as `~`.
26
+
19
27
  ## Installation
20
28
 
21
29
  To get started, install the package by running the following command:
@@ -24,6 +32,19 @@ To get started, install the package by running the following command:
24
32
  npm i @fluidframework/app-insights-logger
25
33
  ```
26
34
 
35
+ ## Importing from this package
36
+
37
+ This package leverages [package.json exports](https://nodejs.org/api/packages.html#exports) to separate its APIs by support level.
38
+ For more information on the related support guarantees, see [API Support Levels](https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels).
39
+
40
+ To access the `public` ([SemVer](https://semver.org/)) APIs, import via `@fluidframework/app-insights-logger` like normal.
41
+
42
+ To access the `beta` APIs, import via `@fluidframework/app-insights-logger/beta`.
43
+
44
+ ## API Documentation
45
+
46
+ API documentation for **@fluidframework/app-insights-logger** is available at <https://fluidframework.com/docs/apis/app-insights-logger>.
47
+
27
48
  <!-- prettier-ignore-end -->
28
49
 
29
50
  <!-- AUTO-GENERATED-CONTENT:END -->
@@ -81,37 +102,54 @@ From the Azure web portal, navigate to your app insights instance. Now, go to th
81
102
  | where customDimensions.name == "performance"
82
103
  ```
83
104
 
84
- <!-- AUTO-GENERATED-CONTENT:START (README_API_DOCS_SECTION:includeHeading=TRUE) -->
105
+ <!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README_FOOTER) -->
85
106
 
86
107
  <!-- prettier-ignore-start -->
108
+ <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
87
109
 
88
- <!-- This section is automatically generated. To update it, make the appropriate changes to docs/md-magic.config.js or the embedded content, then run 'npm run build:md-magic' in the docs folder. -->
110
+ ## Minimum Client Requirements
89
111
 
90
- <!-- prettier-ignore-end -->
112
+ These are the platform requirements for the current version of Fluid Framework Client Packages.
113
+ These requirements err on the side of being too strict since within a major version they can be relaxed over time, but not made stricter.
114
+ For Long Term Support (LTS) versions this can require supporting these platforms for several years.
91
115
 
92
- <!-- AUTO-GENERATED-CONTENT:END -->
116
+ It is likely that other configurations will work, but they are not supported: if they stop working, we do not consider that a bug.
117
+ If you would benefit from support for something not listed here, file an issue and the product team will evaluate your request.
118
+ When making such a request please include if the configuration already works (and thus the request is just that it becomes officially supported), or if changes are required to get it working.
93
119
 
94
- <!-- AUTO-GENERATED-CONTENT:START (README_HELP_SECTION:includeHeading=TRUE) -->
120
+ ### Supported Runtimes
95
121
 
96
- <!-- prettier-ignore-start -->
97
- <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
122
+ - NodeJs ^20.10.0 except that we will drop support for it [when NodeJs 20 loses its upstream support on 2026-04-30](https://github.com/nodejs/release#release-schedule), and will support a newer LTS version of NodeJS (22) at least 1 year before 20 is end-of-life. This same policy applies to NodeJS 22 when it is end of life (2027-04-30).
123
+ - Modern browsers supporting the es2022 standard library: in response to asks we can add explicit support for using babel to polyfill to target specific standards or runtimes (meaning we can avoid/remove use of things that don't polyfill robustly, but otherwise target modern standards).
98
124
 
99
- ## Help
125
+ ### Supported Tools
100
126
 
101
- Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).
127
+ - TypeScript 5.4:
128
+ - All [`strict`](https://www.typescriptlang.org/tsconfig) options are supported.
129
+ - [`strictNullChecks`](https://www.typescriptlang.org/tsconfig) is required.
130
+ - [Configuration options deprecated in 5.0](https://github.com/microsoft/TypeScript/issues/51909) are not supported.
131
+ - `exactOptionalPropertyTypes` is currently not fully supported.
132
+ If used, narrowing members of Fluid Framework types types using `in`, `Reflect.has`, `Object.hasOwn` or `Object.prototype.hasOwnProperty` should be avoided as they may incorrectly exclude `undefined` from the possible values in some cases.
133
+ - [webpack](https://webpack.js.org/) 5
134
+ - We are not intending to be prescriptive about what bundler to use.
135
+ Other bundlers which can handle ES Modules should work, but webpack is the only one we actively test.
102
136
 
103
- Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
104
-
105
- Thank you!
137
+ ### Module Resolution
106
138
 
107
- <!-- prettier-ignore-end -->
139
+ [`Node16`, `NodeNext`, or `Bundler`](https://www.typescriptlang.org/tsconfig#moduleResolution) resolution should be used with TypeScript compilerOptions to follow the [Node.js v12+ ESM Resolution and Loading algorithm](https://nodejs.github.io/nodejs.dev/en/api/v20/esm/#resolution-and-loading-algorithm).
140
+ Node10 resolution is not supported as it does not support Fluid Framework's API structuring pattern that is used to distinguish stable APIs from those that are in development.
108
141
 
109
- <!-- AUTO-GENERATED-CONTENT:END -->
142
+ ### Module Formats
110
143
 
111
- <!-- AUTO-GENERATED-CONTENT:START (README_CONTRIBUTION_GUIDELINES_SECTION:includeHeading=TRUE) -->
144
+ - ES Modules:
145
+ ES Modules are the preferred way to consume our client packages (including in NodeJs) and consuming our client packages from ES Modules is fully supported.
146
+ - CommonJs:
147
+ Consuming our client packages as CommonJs is supported only in NodeJS and only for the cases listed below.
148
+ This is done to accommodate some workflows without good ES Module support.
149
+ If you have a workflow you would like included in this list, file an issue.
150
+ Once this list of workflows motivating CommonJS support is empty, we may drop support for CommonJS one year after notice of the change is posted here.
112
151
 
113
- <!-- prettier-ignore-start -->
114
- <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
152
+ - Testing with Jest (which lacks [stable ESM support](https://jestjs.io/docs/ecmascript-modules) due to [unstable APIs in NodeJs](https://github.com/nodejs/node/issues/37648))
115
153
 
116
154
  ## Contribution Guidelines
117
155
 
@@ -131,14 +169,13 @@ This project may contain Microsoft trademarks or logos for Microsoft projects, p
131
169
  Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
132
170
  Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
133
171
 
134
- <!-- prettier-ignore-end -->
172
+ ## Help
135
173
 
136
- <!-- AUTO-GENERATED-CONTENT:END -->
174
+ Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).
137
175
 
138
- <!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) -->
176
+ Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
139
177
 
140
- <!-- prettier-ignore-start -->
141
- <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
178
+ Thank you!
142
179
 
143
180
  ## Trademark
144
181
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/app-insights-logger",
3
- "version": "2.1.0-281041",
3
+ "version": "2.1.0",
4
4
  "description": "Contains a Fluid logging client that sends telemetry events to Azure App Insights",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -47,17 +47,17 @@
47
47
  "main": "lib/index.js",
48
48
  "types": "lib/public.d.ts",
49
49
  "dependencies": {
50
- "@fluidframework/core-interfaces": "2.1.0-281041",
50
+ "@fluidframework/core-interfaces": "~2.1.0",
51
51
  "@microsoft/applicationinsights-web": "^2.8.11",
52
52
  "@ungap/structured-clone": "^1.2.0"
53
53
  },
54
54
  "devDependencies": {
55
55
  "@arethetypeswrong/cli": "^0.15.2",
56
56
  "@biomejs/biome": "~1.8.3",
57
- "@fluid-internal/mocha-test-setup": "2.1.0-281041",
58
- "@fluid-tools/build-cli": "^0.40.0",
57
+ "@fluid-internal/mocha-test-setup": "~2.1.0",
58
+ "@fluid-tools/build-cli": "^0.41.0",
59
59
  "@fluidframework/build-common": "^2.0.3",
60
- "@fluidframework/build-tools": "^0.40.0",
60
+ "@fluidframework/build-tools": "^0.41.0",
61
61
  "@microsoft/api-extractor": "^7.45.1",
62
62
  "@types/mocha": "^9.1.1",
63
63
  "@types/node": "^18.19.0",