@azure/event-hubs 5.8.0-beta.1 → 5.8.0

package/CHANGELOG.md

@@ -1,5 +1,40 @@
 # Release History
 
+## 5.8.0 (2022-05-10)
+
+### Breaking Changes
+
+- The `enableIdempotentPartitions` flag has been renamed to `enableIdempotentRetries`
+
+## 5.8.0-beta.3 (2022-04-05)
+
+### Breaking Changes
+- `MessageWithMetadata` has been renamed to `MessageContent`.
+- `MessageContent`'s `body` has been renamed to `data`.
+- `MessageAdapter`'s `consumeMessage` and `produceMessage` have been renamed to `consume` and `produce`.
+
+### Bugs Fixed
+- The Uint8Array payload was being stringified first before it gets sent which caused the receiver to treat it as an object instead of a Uint8Array. This is now fixed and Uint8Array is being treated the same as a Buffer.
+- The hashing algorithm used to map partition keys to IDs in the buffered producer is no longer sensitive to the endianness of the local machine [Issue #21190](https://github.com/Azure/azure-sdk-for-js/issues/21190).
+
+### Other Changes
+
+- Updated our `@azure/core-tracing` dependency to the latest version (1.0.0). There are no changes from the previous beta; however, please see below for changes from the previous minor version:
+  - Notable changes include Removal of `@opentelemetry/api` as a transitive dependency and ensuring that the active context is properly propagated.
+  - Customers who would like to continue using OpenTelemetry driven tracing should visit our [OpenTelemetry Instrumentation](https://www.npmjs.com/package/@azure/opentelemetry-instrumentation-azure-sdk) package for instructions.
+
+## 5.8.0-beta.2 (2022-03-11)
+
+### Bugs Fixed
+
+- `createEventDataAdapter` is updated so that `consumeMessage` returns the original binary payload instead of the Buffer representation of it.
+
+### Other Changes
+
+- Updated our `@azure/core-tracing` dependency to the latest version (1.0.0-preview.14)
+  - Notable changes include Removal of `@opentelemetry/api` as a transitive dependency and ensuring that the active context is properly propagated.
+  - Customers who would like to continue using OpenTelemetry driven tracing should visit our [OpenTelemetry Instrumentation](https://www.npmjs.com/package/@azure/opentelemetry-instrumentation-azure-sdk) package for instructions.
+
 ## 5.8.0-beta.1 (2022-02-08)
 
 ### Features Added

package/README.md

@@ -50,6 +50,53 @@ npm install @types/node
 
 You also need to enable `compilerOptions.allowSyntheticDefaultImports` in your tsconfig.json. Note that if you have enabled `compilerOptions.esModuleInterop`, `allowSyntheticDefaultImports` is enabled by default. See [TypeScript's compiler options handbook](https://www.typescriptlang.org/docs/handbook/compiler-options.html) for more information.
 
+### JavaScript Bundle
+
+To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling).
+
+In addition to what is described there, this library also needs additional polyfills for the following NodeJS core built-in modules in order to work properly in the browsers:
+
+- `buffer`
+- `os`
+- `path`
+- `process`
+
+For example, if you are using Webpack v5, you can install the following dev dependencies
+
+- `npm install --save-dev buffer os-browserify path-browserify process`
+
+then add the following into your webpack.config.js
+
+```diff
+ const path = require("path");
++const webpack = require("webpack");
+
+ module.exports = {
+   entry: "./src/index.ts",
+@@ -12,8 +13,21 @@ module.exports = {
+       },
+     ],
+   },
++  plugins: [
++    new webpack.ProvidePlugin({
++      process: "process/browser",
++    }),
++    new webpack.ProvidePlugin({
++      Buffer: ["buffer", "Buffer"],
++    }),
++  ],
+   resolve: {
+     extensions: [".ts", ".js"],
++    fallback: {
++      buffer: require.resolve("buffer/"),
++      os: require.resolve("os-browserify"),
++      path: require.resolve("path-browserify"),
++    },
+   },
+```
+
+Please consult the documentation of your favorite bundler for more information on using polyfills.
+
 ### Authenticate the client
 
 Interaction with Event Hubs starts with either an instance of the