[Schema Registry Avro] Prepare release (Azure#20315)

* [Schema Registry Avro] Prepare release

* rename to AvroEncoder

* update changelog entry

* more renames

Author: deyaaeldeen

sdk/schemaregistry/schema-registry-avro/CHANGELOG.md

@@ -1,19 +1,17 @@
 # Release History
 
-## 1.0.0-beta.6 (2022-02-09)
+## 1.0.0-beta.6 (2022-02-10)
 
 ### Features Added
 
 - The encoder APIs have been revamped to work on messages instead of buffers where the payload is the pure encoded-data. The schema ID became part of the content type of that message. This change will improve the experience of using this encoder with the other messaging clients (e.g. Event Hubs, Service Bus, and Event Grid clients). The encoder also supports decoding messages with payloads that follow the old format where the schema ID was part of the payload.
 - `decodeMessageData` now supports decoding using a different but compatible schema
 
 ### Breaking Changes
-- The `SchemaRegistryAvroSerializer` class has been renamed to `SchemaRegistryAvroEncoder`
+- The `SchemaRegistryAvroSerializer` class has been renamed to `AvroEncoder`
 - The `serialize` method has been renamed to `encodeMessageData` and it now returns a message
 - The `deserialize` method has been renamed to `decodeMessageData` and it now takes a message as input
 
-### Bugs Fixed
-
 ### Other Changes
 - The internal cache has been updated to be an LRU one with a max entries count of 128
 

sdk/schemaregistry/schema-registry-avro/README.md

@@ -31,7 +31,7 @@ npm install @azure/schema-registry-avro
 
 ## Key concepts
 
-### SchemaRegistryAvroEncoder
+### AvroEncoder
 
 Provides API to encode to and decode from Avro Binary Encoding wrapped in a message
 with a content type field containing the schema ID. Uses
@@ -76,13 +76,13 @@ This backward compatibility is temporary and will be removed in v1.0.0.
 const { DefaultAzureCredential } = require("@azure/identity");
 import { createEventDataAdapter } from "@azure/event-hubs";
 const { SchemaRegistryClient } = require("@azure/schema-registry");
-const { SchemaRegistryAvroEncoder } = require("@azure/schema-registry-avro");
+const { AvroEncoder } = require("@azure/schema-registry-avro");
 
 const client = new SchemaRegistryClient(
   "<fully qualified namespace>",
   new DefaultAzureCredential()
 );
-const encoder = new SchemaRegistryAvroEncoder(client, {
+const encoder = new AvroEncoder(client, {
   groupName: "<group>",
   messageAdapter: createEventDataAdapter(),
 });

sdk/schemaregistry/schema-registry-avro/review/schema-registry-avro.api.md

@@ -6,6 +6,20 @@
 
 import { SchemaRegistry } from '@azure/schema-registry';
 
+// @public
+export class AvroEncoder<MessageT = MessageWithMetadata> {
+    constructor(client: SchemaRegistry, options?: AvroEncoderOptions<MessageT>);
+    decodeMessageData(message: MessageT, options?: DecodeMessageDataOptions): Promise<unknown>;
+    encodeMessageData(value: unknown, schema: string): Promise<MessageT>;
+}
+
+// @public
+export interface AvroEncoderOptions<MessageT> {
+    autoRegisterSchemas?: boolean;
+    groupName?: string;
+    messageAdapter?: MessageAdapter<MessageT>;
+}
+
 // @public
 export interface DecodeMessageDataOptions {
     schema?: string;
@@ -23,20 +37,6 @@ export interface MessageWithMetadata {
     contentType: string;
 }
 
-// @public
-export class SchemaRegistryAvroEncoder<MessageT = MessageWithMetadata> {
-    constructor(client: SchemaRegistry, options?: SchemaRegistryAvroEncoderOptions<MessageT>);
-    decodeMessageData(message: MessageT, options?: DecodeMessageDataOptions): Promise<unknown>;
-    encodeMessageData(value: unknown, schema: string): Promise<MessageT>;
-}
-
-// @public
-export interface SchemaRegistryAvroEncoderOptions<MessageT> {
-    autoRegisterSchemas?: boolean;
-    groupName?: string;
-    messageAdapter?: MessageAdapter<MessageT>;
-}
-
 // (No @packageDocumentation comment for this package)
 
 ```

sdk/schemaregistry/schema-registry-avro/samples-dev/schemaRegistryAvroSample.ts

@@ -7,7 +7,7 @@
 
 import { DefaultAzureCredential } from "@azure/identity";
 import { SchemaRegistryClient, SchemaDescription } from "@azure/schema-registry";
-import { SchemaRegistryAvroEncoder } from "@azure/schema-registry-avro";
+import { AvroEncoder } from "@azure/schema-registry-avro";
 
 // Load the .env file if it exists
 import * as dotenv from "dotenv";
@@ -66,7 +66,7 @@ export async function main() {
   await client.registerSchema(schemaDescription);
 
   // Create a new encoder backed by the client
-  const encoder = new SchemaRegistryAvroEncoder(client, { groupName });
+  const encoder = new AvroEncoder(client, { groupName });
 
   // encode an object that matches the schema and put it in a message
   const value: User = { firstName: "Jane", lastName: "Doe" };

sdk/schemaregistry/schema-registry-avro/samples-dev/withEventHubsBufferedProducerClient.ts

@@ -7,7 +7,7 @@
 
 import { DefaultAzureCredential } from "@azure/identity";
 import { SchemaRegistryClient, SchemaDescription } from "@azure/schema-registry";
-import { SchemaRegistryAvroEncoder } from "@azure/schema-registry-avro";
+import { AvroEncoder } from "@azure/schema-registry-avro";
 import { EventHubBufferedProducerClient, createEventDataAdapter } from "@azure/event-hubs";
 
 // Load the .env file if it exists
@@ -74,7 +74,7 @@ export async function main() {
   await schemaRegistryClient.registerSchema(schemaDescription);
 
   // Create a new encoder backed by the client
-  const encoder = new SchemaRegistryAvroEncoder(schemaRegistryClient, {
+  const encoder = new AvroEncoder(schemaRegistryClient, {
     groupName,
     messageAdapter: createEventDataAdapter(),
   });

sdk/schemaregistry/schema-registry-avro/samples-dev/withEventHubsConsumerClient.ts

@@ -7,7 +7,7 @@
 
 import { DefaultAzureCredential } from "@azure/identity";
 import { SchemaRegistryClient, SchemaDescription } from "@azure/schema-registry";
-import { SchemaRegistryAvroEncoder } from "@azure/schema-registry-avro";
+import { AvroEncoder } from "@azure/schema-registry-avro";
 import {
   EventHubConsumerClient,
   earliestEventPosition,
@@ -74,7 +74,7 @@ export async function main() {
   await schemaRegistryClient.registerSchema(schemaDescription);
 
   // Create a new encoder backed by the client
-  const encoder = new SchemaRegistryAvroEncoder(schemaRegistryClient, {
+  const encoder = new AvroEncoder(schemaRegistryClient, {
     groupName,
     messageAdapter: createEventDataAdapter(),
   });

sdk/schemaregistry/schema-registry-avro/samples-dev/withEventHubsProducerClient.ts

@@ -7,7 +7,7 @@
 
 import { DefaultAzureCredential } from "@azure/identity";
 import { SchemaRegistryClient, SchemaDescription } from "@azure/schema-registry";
-import { SchemaRegistryAvroEncoder } from "@azure/schema-registry-avro";
+import { AvroEncoder } from "@azure/schema-registry-avro";
 import { EventHubProducerClient, createEventDataAdapter } from "@azure/event-hubs";
 
 // Load the .env file if it exists
@@ -73,7 +73,7 @@ export async function main() {
   await schemaRegistryClient.registerSchema(schemaDescription);
 
   // Create a new encoder backed by the client
-  const encoder = new SchemaRegistryAvroEncoder(schemaRegistryClient, {
+  const encoder = new AvroEncoder(schemaRegistryClient, {
     groupName,
     messageAdapter: createEventDataAdapter(),
   });

sdk/schemaregistry/schema-registry-avro/src/index.ts

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-export { SchemaRegistryAvroEncoder } from "./schemaRegistryAvroEncoder";
+export { AvroEncoder } from "./schemaRegistryAvroEncoder";
 
 export * from "./models";

sdk/schemaregistry/schema-registry-avro/src/models.ts

@@ -33,7 +33,7 @@ export interface MessageAdapter<MessageT> {
 /**
  * Options for Schema
  */
-export interface SchemaRegistryAvroEncoderOptions<MessageT> {
+export interface AvroEncoderOptions<MessageT> {
   /**
    * When true, register new schemas passed to encodeMessageData. Otherwise, and by
    * default, fail if schema has not already been registered.

sdk/schemaregistry/schema-registry-avro/src/schemaRegistryAvroEncoder.ts

@@ -8,7 +8,7 @@ import {
   DecodeMessageDataOptions,
   MessageAdapter,
   MessageWithMetadata,
-  SchemaRegistryAvroEncoderOptions,
+  AvroEncoderOptions,
 } from "./models";
 import { SchemaDescription, SchemaRegistry } from "@azure/schema-registry";
 import { isMessageWithMetadata } from "./utility";
@@ -32,14 +32,14 @@ const cacheOptions: LRUCacheOptions<string, any> = {
  * Avro encoder that obtains schemas from a schema registry and does not
  * pack schemas into its payloads.
  */
-export class SchemaRegistryAvroEncoder<MessageT = MessageWithMetadata> {
+export class AvroEncoder<MessageT = MessageWithMetadata> {
   /**
    * Creates a new encoder.
    *
    * @param client - Schema Registry where schemas are registered and obtained.
    *                 Usually this is a SchemaRegistryClient instance.
    */
-  constructor(client: SchemaRegistry, options?: SchemaRegistryAvroEncoderOptions<MessageT>) {
+  constructor(client: SchemaRegistry, options?: AvroEncoderOptions<MessageT>) {
     this.registry = client;
     this.schemaGroup = options?.groupName;
     this.autoRegisterSchemas = options?.autoRegisterSchemas ?? false;