Incorrect documentation for registering Avro schema using AVSC file

[joshjluo]

Issue description

The documentation for registering an Avro schema using an AVSC file shows the following:

const { SchemaType, readAVSCAsync, avdlToAVSCAsync } = require('@kafkajs/confluent-schema-registry')

// From an avsc file
const schema = await readAVSCAsync('path/to/schema.avsc')
const { id } = await registry.register({ type: SchemaType.AVRO, schema }) // { id: 2 }

When attempting to do this with Typescript, Typescript shows the following error with schema:

Type 'RawAvroSchema' is not assignable to type 'string'.

Steps to reproduce the issue

1. Create a schema.avsc file. For example,

{
  "type": "string",
  "name": "name"
}

2. Read and register the schema according to the documentation

const { SchemaType, readAVSCAsync } = require('@kafkajs/confluent-schema-registry')

const schema = await readAVSCAsync('path/to/schema.avsc')
const { id } = await registry.register({ type: SchemaType.AVRO, schema })

3. Observe the error caused by schema.

Type 'RawAvroSchema' is not assignable to type 'string'.

Potential Solution

I believe the documentation should say something like

const { SchemaType, readAVSCAsync, avdlToAVSCAsync } = require('@kafkajs/confluent-schema-registry')

const schema = await readAVSCAsync('path/to/schema.avsc')
const { id } = await registry.register(schema)

based on getConfluentSchema() in SchemaRegistry.ts.

[USSliberty]

In my case this error was throwing since I was using pure Node.js:

ResponseError: Confluent_Schema_Registry - Cannot deserialize value of type `java.lang.String` from Object value (token `JsonToken.START_OBJECT`)

@joshjluo Potential Solution did the trick!

[silverwind]

Also ran into this and this fix worked.