Enhance docs (#108)

* Update kafkajs README and sr example

* Minor formatting

Author: rayokota

README.md

@@ -23,11 +23,9 @@ pace with core Apache Kafka and components of the [Confluent Platform](https://w
 
 This library leverages the work and concepts from two popular Apache Kafka JavaScript clients: [node-rdkafka](https://github.com/Blizzard/node-rdkafka) and [KafkaJS](https://github.com/tulios/kafkajs). The core is heavily based on the node-rdkafka library, which uses our own [librdkafka](https://github.com/confluentinc/librdkafka) library for core client functionality. However, we leverage a promisified API and a more idiomatic interface, similar to the one in KafkaJS, making it easy for developers to migrate and adopt this client depending on the patterns and interface they prefer. We're very happy to have been able to leverage the excellent work of the many authors of these libraries!
 
-### This library is currently in limited-availability - it is supported for all usage but for the schema-registry client.
+### This library is currently in limited-availability
 
-To use **Schema Registry**, use the existing [kafkajs/confluent-schema-registry](https://github.com/kafkajs/confluent-schema-registry) library that is compatible with this library. For a simple schema registry example, see [sr.js](https://github.com/confluentinc/confluent-kafka-javascript/blob/dev_early_access_development_branch/examples/kafkajs/sr.js).
-
-**DISCLAIMER:** Although it is compatible with **confluent-kafka-javascript**, Confluent does not own or maintain kafkajs/confluent-schema-registry, and the use and functionality of the library should be considered "as is".
+To use **Schema Registry**, use the existing [@confluentinc/schemaregistry](https://www.npmjs.com/package/@confluentinc/schemaregistry) library that is compatible with this library. For a simple schema registry example, see [sr.js](https://github.com/confluentinc/confluent-kafka-javascript/blob/dev_early_access_development_branch/examples/kafkajs/sr.js).
 
 
 ## Requirements

examples/kafkajs/sr.js

@@ -1,11 +1,11 @@
 // require('kafkajs') is replaced with require('@confluentinc/kafka-javascript').KafkaJS.
 const { Kafka } = require('@confluentinc/kafka-javascript').KafkaJS;
 
-// Note: The kafkajs/confluent-schema-registry will need to be installed separately to run this example,
+// Note: The @confluentinc/schemaregistry will need to be installed separately to run this example,
 //       as it isn't a dependency of confluent-kafka-javascript.
-const { SchemaRegistry, SchemaType } = require('@kafkajs/confluent-schema-registry');
+const { SchemaRegistryClient, SerdeType, AvroSerializer, AvroDeserializer} = require('@confluentinc/schemaregistry');
 
-const registry = new SchemaRegistry({ host: '<fill>' })
+const registry = new SchemaRegistryClient({ baseURLs: ['<fill>'] })
 const kafka = new Kafka({
     kafkaJS: {
         brokers: ['<fill>'],
@@ -17,11 +17,12 @@ const kafka = new Kafka({
         },
     }
 });
+
 let consumer = kafka.consumer({
-  kafkaJS: {
-    groupId: "test-group",
-    fromBeginning: true,
-  },
+    kafkaJS: {
+        groupId: "test-group",
+        fromBeginning: true,
+    },
 });
 let producer = kafka.producer();
 
@@ -43,40 +44,42 @@ const schemaB = {
 };
 
 const topicName = 'test-topic';
+const subjectName = topicName + '-value';
 
 const run = async () => {
     // Register schemaB.
     await registry.register(
+        'avro-b',
         {
-            type: SchemaType.AVRO,
+            schemaType: 'AVRO',
             schema: JSON.stringify(schemaB),
-        },
-        { subject: 'Avro:B' },
+        }
     );
-    const response = await registry.api.Subject.latestVersion({ subject: 'Avro:B' });
-    const { version } = JSON.parse(response.responseData);
+    const response = await registry.getLatestSchemaMetadata('avro-b');
+    const version = response.version
 
     // Register schemaA, which references schemaB.
-    const { id } = await registry.register(
+    const id = await registry.register(
+        subjectName,
         {
-            type: SchemaType.AVRO,
+            schemaType: 'AVRO',
             schema: JSON.stringify(schemaA),
             references: [
                 {
                     name: 'test.B',
-                    subject: 'Avro:B',
+                    subject: 'avro-b',
                     version,
                 },
             ],
-        },
-        { subject: 'Avro:A' },
+        }
     )
 
     // Produce a message with schemaA.
     await producer.connect()
+    const ser = new AvroSerializer(registry, SerdeType.VALUE, { useLatestVersion: true });
     const outgoingMessage = {
         key: 'key',
-        value: await registry.encode(id, { id: 1, b: { id: 2 } })
+        value: await ser.serialize(topicName, { id: 1, b: { id: 2 } }),
     }
     await producer.send({
         topic: topicName,
@@ -90,11 +93,12 @@ const run = async () => {
     await consumer.subscribe({ topic: topicName })
 
     let messageRcvd = false;
+    const deser = new AvroDeserializer(registry, SerdeType.VALUE, {});
     await consumer.run({
         eachMessage: async ({ message }) => {
             const decodedMessage = {
                 ...message,
-                value: await registry.decode(message.value)
+                value: await deser.deserialize(topicName, message.value)
             };
             console.log("Consumer received message.\nBefore decoding: " + JSON.stringify(message) + "\nAfter decoding: " + JSON.stringify(decodedMessage));
             messageRcvd = true;

schemaregistry/rest-service.ts

@@ -13,7 +13,7 @@ import { RestError } from './rest-error';
 export interface BasicAuthCredentials {
   credentialsSource: 'USER_INFO' | 'URL' | 'SASL_INHERIT',
   userInfo?: string,
-  saslInfo?: SaslInfo
+  sasl?: SaslInfo
 }
 
 export interface SaslInfo {
@@ -75,13 +75,13 @@ export class RestService {
           this.setAuth(toBase64(basicAuthCredentials.userInfo!));
           break;
         case 'SASL_INHERIT':
-          if (!basicAuthCredentials.saslInfo) {
+          if (!basicAuthCredentials.sasl) {
             throw new Error('Sasl info not provided');
           }
-          if (basicAuthCredentials.saslInfo.mechanism?.toUpperCase() === 'GSSAPI') {
+          if (basicAuthCredentials.sasl.mechanism?.toUpperCase() === 'GSSAPI') {
             throw new Error('SASL_INHERIT support PLAIN and SCRAM SASL mechanisms only');
           }
-          this.setAuth(toBase64(`${basicAuthCredentials.saslInfo.username}:${basicAuthCredentials.saslInfo.password}`));
+          this.setAuth(toBase64(`${basicAuthCredentials.sasl.username}:${basicAuthCredentials.sasl.password}`));
           break;
         case 'URL':
           if (!basicAuthCredentials.userInfo) {

schemaregistry/rules/encryption/tink/bytes.ts

@@ -130,7 +130,7 @@ export function fromBase64(encoded: string, opt_webSafe?: boolean): Uint8Array {
  * @param bytes - the byte array input
  * @param opt_webSafe - True indicates we should use the alternative
  *     alphabet, which does not require escaping for use in URLs.
- * @returns base64 - output
+ * @returns base64 output
  */
 export function toBase64(bytes: Uint8Array, opt_webSafe?: boolean): string {
   const encoded = window

schemaregistry/serde/json-util.ts

@@ -12,7 +12,7 @@ import { deepStrictEqual } from 'assert';
  * Generate JSON schema from value.
  *
  * @param value - Value.
- * @returns - JSON schema.
+ * @returns JSON schema.
  */
 export function generateSchema(value: any): any {
   switch (true) {

schemaregistry/serde/wildcard-matcher.ts

@@ -18,7 +18,7 @@
  *
  * @param str             - the string to match on
  * @param wildcardMatcher - the wildcard string to match against
- * @returns true - if the string matches the wildcard string
+ * @returns true if the string matches the wildcard string
  */
 export function match(str: string, wildcardMatcher: string): boolean {
   let re = wildcardToRegexp(wildcardMatcher, '.')