confluent-schema-registry 3.3.5 → 3.6.2

package/CHANGELOG.md

@@ -9,7 +9,48 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
--field for error validation , and the issue of failing
+- Support [schema references](https://docs.confluent.io/platform/current/schema-registry/serdes-develop/index.html#schema-references) for Avro, Protocol Buffer, and JSON schema [#197](https://github.com/kafkajs/confluent-schema-registry/pull/197)
+
+### Fixed
+
+- Fix Apicurio compatibility with register function [#201](https://github.com/kafkajs/confluent-schema-registry/pull/201)
+
+## [3.2.1] - 2022-01-28
+
+### Fixed
+
+- Don't swallow error message from client-side errors from registry requests [#176](https://github.com/kafkajs/confluent-schema-registry/pull/176)
+
+## [3.2.0] - 2021-11-22
+
+### Added
+
+- Add reader schema option when decoding Avro messages [#166](https://github.com/kafkajs/confluent-schema-registry/pull/166)
+
+## [3.1.1] - 2021-11-03
+
+### Fixed
+
+- Support backwards incompatible changes in Ajv 8 when passing in Ajv instance in JSON Schema options [#163](https://github.com/kafkajs/confluent-schema-registry/pull/163)
+
+## [3.1.0] - 2021-11-03
+
+### Added
+
+- Allow passing in Ajv instance in JSON Schema options [#133](https://github.com/kafkajs/confluent-schema-registry/pull/133)
+
+### Fixed
+
+- Fix backwards compatibility with older Schema Registry versions [#158](https://github.com/kafkajs/confluent-schema-registry/pull/158)
+
+### Fixed
+
+- Fix gateway config for when setting HTTP agent [#127](https://github.com/kafkajs/confluent-schema-registry/pull/127)
+
+## [3.0.1] - 2021-06-11
+### Fixed
+
+- Fix gateway config for when setting HTTP agent [#127](https://github.com/kafkajs/confluent-schema-registry/pull/127)
 
 ## [3.0.0] - 2021-05-20
 

package/bin/avdlToAVSC.sh

@@ -6,4 +6,4 @@ if [ -z "${avdl_path}" ]; then
   exit;
 fi
 
-docker run --rm -v ${PWD}:/share coderfi/avro-tools:1.7.7 idl2schemata ${avdl_path} tmp && cat tmp/${avsc_name}.avsc
+docker run --rm -v "$(pwd)":/avro kpnnl/avro-tools:1.12.0 idl2schemata ${avdl_path} tmp && cat tmp/${avsc_name}.avsc

package/dist/JsonSchema.js

@@ -42,7 +42,7 @@ class JsonSchema {
             if (opts === null || opts === void 0 ? void 0 : opts.errorHook) {
                 for (const err of this.validate.errors) {
                     const path = this.isOldAjvValidationError(err) ? err.dataPath : err.instancePath;
-                    opts === null || opts === void 0 ? void 0 : opts.errorHook([path], err.data, err.schema);
+                    opts.errorHook([err], err.data, err.schema);
                 }
             }
             return false;

package/dist/JsonSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"JsonSchema.js","sourceRoot":"","sources":["../src/JsonSchema.ts"],"names":[],"mappings":";;;;;AACA,8CAAqB;AACrB,qCAAiE;AAoBjE,MAAqB,UAAU;IAG7B,YAAY,MAA2B,EAAE,IAAkB;QACzD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IAClD,CAAC;IAEO,aAAa,CAAC,MAA2B,EAAE,IAAkB;;QACnE,MAAM,GAAG,SAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,mCAAI,IAAI,aAAG,CAAC,IAAI,CAAC,CAAA;QAC9C,MAAM,iBAAiB,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,iBAAiB,CAAA;QACjD,IAAI,iBAAiB,EAAE;YACrB,iBAAiB,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;gBACpC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;gBAC5C,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA;YACxC,CAAC,CAAC,CAAA;SACH;QACD,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAA;QACvD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAEO,eAAe,CAAC,OAAY;QAClC,MAAM,KAAK,GAAe,EAAE,CAAA;QAC5B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE;YACnE,MAAM,IAAI,+CAAsC,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAA;SAC3E;IACH,CAAC;IAEM,QAAQ,CAAC,OAAe;QAC7B,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAA;QAC7B,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;IAC7C,CAAC;IAEM,UAAU,CAAC,MAAc;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAA;QAC7C,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAA;QAC7B,OAAO,OAAO,CAAA;IAChB,CAAC;IACM,OAAO,CAAC,OAAe,EAAE,IAA2E;QACzG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC3B,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE;gBAC9D,KAAK,MAAM,GAAG,IAAK,IAAI,CAAC,QAAQ,CAAC,MAAc,EAAE;oBAC/C,MAAM,IAAI,GAAG,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC;oBACjF,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,CAAC,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE;iBAC/C;aACF;YACD,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,uBAAuB,CAAC,KAAyB;QACvD,OAAQ,KAA+B,CAAC,QAAQ,IAAI,IAAI,CAAA;IAC1D,CAAC;CACF;AArDD,6BAqDC"}
+{"version":3,"file":"JsonSchema.js","sourceRoot":"","sources":["../src/JsonSchema.ts"],"names":[],"mappings":";;;;;AACA,8CAAqB;AACrB,qCAAiE;AAoBjE,MAAqB,UAAU;IAG7B,YAAY,MAA2B,EAAE,IAAkB;QACzD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IAClD,CAAC;IAEO,aAAa,CAAC,MAA2B,EAAE,IAAkB;;QACnE,MAAM,GAAG,SAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,mCAAI,IAAI,aAAG,CAAC,IAAI,CAAC,CAAA;QAC9C,MAAM,iBAAiB,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,iBAAiB,CAAA;QACjD,IAAI,iBAAiB,EAAE;YACrB,iBAAiB,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;gBACpC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;gBAC5C,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA;YACxC,CAAC,CAAC,CAAA;SACH;QACD,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAA;QACvD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAEO,eAAe,CAAC,OAAY;QAClC,MAAM,KAAK,GAAe,EAAE,CAAA;QAC5B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE;YACnE,MAAM,IAAI,+CAAsC,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAA;SAC3E;IACH,CAAC;IAEM,QAAQ,CAAC,OAAe;QAC7B,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAA;QAC7B,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;IAC7C,CAAC;IAEM,UAAU,CAAC,MAAc;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAA;QAC7C,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAA;QAC7B,OAAO,OAAO,CAAA;IAChB,CAAC;IACM,OAAO,CAAC,OAAe,EAAE,IAA2E;QACzG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC3B,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE;gBAC9D,KAAK,MAAM,GAAG,IAAK,IAAI,CAAC,QAAQ,CAAC,MAAc,EAAE;oBAC/C,MAAM,IAAI,GAAG,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC;oBACjF,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;iBAC7C;aACF;YACD,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,uBAAuB,CAAC,KAAyB;QACvD,OAAQ,KAA+B,CAAC,QAAQ,IAAI,IAAI,CAAA;IAC1D,CAAC;CACF;AArDD,6BAqDC"}

package/dockest-error.json

@@ -1,11 +1,7 @@
 {
   "errorPayload": {
-    "trap": "unhandledRejection",
-    "reason": {
-      "payload": {},
-      "name": "DockestError"
-    },
-    "promise": {}
+    "trap": "SIGINT",
+    "signal": "SIGINT"
   },
-  "timestamp": "2024-09-03T14:42:35.241Z"
+  "timestamp": "2024-12-18T22:39:59.117Z"
 }

package/jest.setup.ts

@@ -1,8 +1,12 @@
 import { MAGIC_BYTE } from './src/wireEncoder'
 import decode from './src/wireDecoder'
+import { MatcherFunction } from 'expect'
 
-const toMatchConfluentEncodedPayload = context => (received, { payload: expectedPayload }) => {
-  const { printExpected, printReceived, printWithType } = context.utils
+const toMatchConfluentEncodedPayload: MatcherFunction<[{ payload: Buffer }]> = function(
+  received,
+  { payload: expectedPayload },
+) {
+  const { printExpected, printReceived, printWithType } = this.utils
 
   if (!Buffer.isBuffer(expectedPayload)) {
     const error = [
@@ -13,16 +17,17 @@ const toMatchConfluentEncodedPayload = context => (received, { payload: expected
     throw new Error(error)
   }
 
-  const { magicByte, payload } = decode(received)
+  const { magicByte, payload } = decode(received as Buffer)
   const expectedMessage = decode(expectedPayload)
 
   if (!Buffer.isBuffer(received)) {
     return {
       pass: false,
-      message: () => [
-        'Received value must be a Buffer',
-        printWithType('Received', received, printReceived),
-      ],
+      message: () =>
+        [
+          'Received value must be a Buffer',
+          printWithType('Received', received, printReceived),
+        ].join('\n'),
     }
   }
 
@@ -40,7 +45,7 @@ const toMatchConfluentEncodedPayload = context => (received, { payload: expected
   }
 
   return {
-    pass: context.equals(payload, expectedMessage.payload),
+    pass: this.equals(payload, expectedMessage.payload),
     message: () =>
       [
         'expected payload',
@@ -52,9 +57,14 @@ const toMatchConfluentEncodedPayload = context => (received, { payload: expected
 }
 
 expect.extend({
-  toMatchConfluentEncodedPayload(...args) {
-    // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
-    // @ts-ignore
-    return toMatchConfluentEncodedPayload(this)(...args)
-  },
+  toMatchConfluentEncodedPayload,
 })
+
+declare global {
+  // eslint-disable-next-line @typescript-eslint/no-namespace
+  namespace jest {
+    interface Matchers<R, T = {}> {
+      toMatchConfluentEncodedPayload(args: { registryId: number; payload: Buffer }): R
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "confluent-schema-registry",
-  "version": "3.3.5",
+  "version": "3.6.2",
   "main": "dist/index.js",
   "description": "ConfluentSchemaRegistry is a library that makes it easier to interact with the Confluent schema registry, it provides convenient methods to encode, decode and register new schemas using the Apache Avro serialization format.",
   "keywords": [
@@ -17,40 +17,34 @@
     "build:watch": "rm -rf ./dist && tsc --watch",
     "test:unit:watch": "yarn test:unit --watch",
     "test:unit": "jest",
-    "test": "ts-node ./dockest.ts",
-    "test:debug": "ts-node ./dockest.ts debug",
+    "test": "docker compose up -d --wait schemaRegistry && jest",
     "lint": "eslint './src/**/*.ts'",
+    "check:types": "tsc --noEmit",
     "format": "yarn lint --fix"
   },
   "dependencies": {
     "ajv": "^7.1.0",
     "avsc": ">= 5.4.13 < 6",
-    "mappersmith": ">= 2.30.1 < 3",
-    "protobufjs": "^6.11.4"
+    "mappersmith": ">= 2.44.0 < 3",
+    "protobufjs": ">= 6.11.4 < 8"
   },
   "devDependencies": {
-    "@types/execa": "^2.0.0",
-    "@types/fs-extra": "^8.0.0",
-    "@types/jest": "^25.2.1",
-    "@types/node": "^12.7.3",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^18.19.70",
     "@types/prettier": "^1.18.2",
-    "@types/uuid": "^3.4.5",
     "@typescript-eslint/eslint-plugin": "^2.1.0",
     "@typescript-eslint/parser": "^2.1.0",
     "@typescript-eslint/typescript-estree": "^2.1.0",
     "ajv8": "npm:ajv@^8.6.3",
-    "dockest": "^2.1.0",
     "eslint": "^6.3.0",
     "eslint-config-prettier": "^6.1.0",
     "eslint-plugin-no-only-tests": "^2.3.1",
     "eslint-plugin-prettier": "^3.1.0",
-    "execa": "^2.0.4",
-    "fs-extra": "^8.1.0",
-    "jest": "^25.2.7",
+    "jest": "^29.7.0",
     "prettier": "^1.18.2",
-    "ts-jest": "^24.0.2",
+    "ts-jest": "^29.2.5",
     "ts-node": "^8.3.0",
-    "typescript": "^3.6.2",
-    "uuid": "^3.3.3"
+    "typescript": "^5.7.3",
+    "uuid": "^11.0.5"
   }
 }

package/src/@types.ts

@@ -23,10 +23,12 @@ export type AvroOptions = Partial<ForSchemaOptions> & {
 }
 
 export type JsonOptions = ConstructorParameters<typeof Ajv>[0] & {
-  ajvInstance?: {
-    addSchema: Ajv['addSchema']
-    compile: (schema: any) => ValidateFunction
-  }
+  ajvInstance?:
+    | {
+        addSchema: Ajv['addSchema']
+        compile: (schema: any) => ValidateFunction
+      }
+    | Ajv
   referencedSchemas?: JsonConfluentSchema[]
 }
 export type ProtoOptions = { messageName?: string; referencedSchemas?: ProtoConfluentSchema[] }
@@ -94,12 +96,3 @@ export interface SchemaResponse {
 }
 
 export type ConfluentSchema = AvroConfluentSchema | ProtoConfluentSchema | JsonConfluentSchema
-
-declare global {
-  // eslint-disable-next-line @typescript-eslint/no-namespace
-  namespace jest {
-    interface Matchers<R, T = {}> {
-      toMatchConfluentEncodedPayload(args: { registryId: number; payload: Buffer }): R
-    }
-  }
-}

package/src/AvroHelper.ts

@@ -12,7 +12,7 @@ import { ConfluentSchemaRegistryArgumentError } from './errors'
 import avro, { ForSchemaOptions, Schema, Type } from 'avsc'
 import { SchemaResponse, SchemaType } from './@types'
 
-type TypeHook = (schema: Schema, opts: ForSchemaOptions) => Type
+type TypeHook = (schema: Schema, opts: ForSchemaOptions) => Type | undefined
 export default class AvroHelper implements SchemaHelper {
   private getRawAvroSchema(schema: ConfluentSchema): RawAvroSchema {
     return (typeof schema.schema === 'string'
@@ -57,8 +57,7 @@ export default class AvroHelper implements SchemaHelper {
 
   public getSubject(
     schema: AvroConfluentSchema,
-    // @ts-ignore
-    avroSchema: AvroSchema,
+    _avroSchema: AvroSchema,
     separator: string,
   ): ConfluentSubject {
     const rawSchema: RawAvroSchema = this.getRawAvroSchema(schema)

package/src/JsonSchema.ts

@@ -5,6 +5,7 @@ import { ConfluentSchemaRegistryValidationError } from './errors'
 interface BaseAjvValidationError {
   data?: unknown
   schema?: unknown
+  message?: string
 }
 interface OldAjvValidationError extends BaseAjvValidationError {
   dataPath: string
@@ -41,8 +42,15 @@ export default class JsonSchema implements Schema {
   }
 
   private validatePayload(payload: any) {
-    const paths: string[][] = []
-    if (!this.isValid(payload, { errorHook: path => paths.push(path) })) {
+    const paths: any[] = []
+
+    if (
+      !this.isValid(payload, {
+        errorHook: (path, message) => {
+          paths.push({ path, message })
+        },
+      })
+    ) {
       throw new ConfluentSchemaRegistryValidationError('invalid payload', paths)
     }
   }
@@ -57,19 +65,23 @@ export default class JsonSchema implements Schema {
     this.validatePayload(payload)
     return payload
   }
-  public isValid(payload: object, opts?: { errorHook: (path: Array<string>, value: any, type?: any) => void }): boolean {  
-    if (!this.validate(payload)) {  
-      if (opts === null || opts === void 0 ? void 0 : opts.errorHook) {
-        for (const err of (this.validate.errors as any)) {  
-          const path = this.isOldAjvValidationError(err) ? err.dataPath : err.instancePath;  
-          opts?.errorHook([path], err.data, err.schema);  
-        }  
-      }  
-      return false;  
-    }  
-    return true;  
-  }  
-  
+
+  public isValid(
+    payload: object,
+    opts?: { errorHook: (path: Array<string>, value: any, type?: any) => void },
+  ): boolean {
+    if (!this.validate(payload)) {
+      if (opts?.errorHook) {
+        for (const err of this.validate.errors as AjvValidationError[]) {
+          const path = this.isOldAjvValidationError(err) ? err.dataPath : err.instancePath
+          opts.errorHook([path], err.message ?? err.data, err.schema)
+        }
+        return false
+      }
+    }
+    return true
+  }
+
   private isOldAjvValidationError(error: AjvValidationError): error is OldAjvValidationError {
     return (error as OldAjvValidationError).dataPath != null
   }

package/src/SchemaRegistry.json.spec.ts

@@ -1,6 +1,8 @@
 import SchemaRegistry, { RegisteredSchema } from './SchemaRegistry'
 import API from './api'
 import { JsonConfluentSchema, SchemaType } from './@types'
+import Ajv from 'ajv'
+import { ConfluentSchemaRegistryValidationError } from './errors'
 
 const REGISTRY_HOST = 'http://localhost:8982'
 const schemaRegistryAPIClientArgs = { host: REGISTRY_HOST }
@@ -100,8 +102,13 @@ describe('SchemaRegistry', () => {
   let api
 
   beforeEach(async () => {
+    const options = {
+      [SchemaType.JSON]: {
+        allErrors: true,
+      },
+    }
     api = API(schemaRegistryAPIClientArgs)
-    schemaRegistry = new SchemaRegistry(schemaRegistryArgs)
+    schemaRegistry = new SchemaRegistry(schemaRegistryArgs, options)
   })
 
   describe('when register', () => {
@@ -161,6 +168,16 @@ describe('SchemaRegistry', () => {
 
         expect(resultObj).toEqual(obj)
       })
+
+      it('should return error message', async () => {
+        const obj = { id2a: 'sdfsdfsdf', level2a: 1 }
+        try {
+          await schemaRegistry.encode(registeredSchema.id, obj)
+        } catch (ex) {
+          expect(ex.paths[0].message).toBeDefined()
+          expect(ex.paths[0].message).toEqual('should be number')
+        }
+      })
     })
 
     describe('with multiple reference', () => {

package/src/SchemaRegistry.newApi.spec.ts

@@ -587,7 +587,7 @@ describe('SchemaRegistry - new Api', () => {
           } catch (error) {
             expect(error).toBeInstanceOf(ConfluentSchemaRegistryValidationError)
             expect(error.message).toEqual('invalid payload')
-            expect(error.paths).toEqual([['/fullName']])
+            expect(error.paths[0].path).toEqual(['/fullName'])
           }
         },
       )

package/src/SchemaRegistry.spec.ts

@@ -250,3 +250,18 @@ describe('SchemaRegistry - old AVRO api', () => {
     })
   })
 })
+
+describe('SchemaRegistry - Custom Middleware', () => {
+  const customMiddleware = jest.fn()
+
+  const schemaRegistry = new SchemaRegistry({
+    ...schemaRegistryArgs,
+    middlewares: [customMiddleware],
+  })
+
+  it('should have called the custom middleware', async () => {
+    await schemaRegistry.register(personSchema)
+
+    expect(customMiddleware).toHaveBeenCalled()
+  })
+})

package/src/SchemaRegistry.ts

@@ -3,7 +3,7 @@ import { Response } from 'mappersmith'
 
 import { encode, MAGIC_BYTE } from './wireEncoder'
 import decode from './wireDecoder'
-import { COMPATIBILITY, DEFAULT_SEPERATOR } from './constants'
+import { COMPATIBILITY, DEFAULT_SEPARATOR } from './constants'
 import API, { SchemaRegistryAPIClientArgs, SchemaRegistryAPIClient } from './api'
 import Cache from './cache'
 import {
@@ -46,13 +46,13 @@ interface Opts {
 interface AvroDecodeOptions {
   readerSchema?: RawAvroSchema | AvroSchema | Schema
 }
-interface DecodeOptions {
+export interface DecodeOptions {
   [SchemaType.AVRO]?: AvroDecodeOptions
 }
 
 const DEFAULT_OPTS = {
   compatibility: COMPATIBILITY.BACKWARD,
-  separator: DEFAULT_SEPERATOR,
+  separator: DEFAULT_SEPARATOR,
 }
 export default class SchemaRegistry {
   private api: SchemaRegistryAPIClient
@@ -62,10 +62,10 @@ export default class SchemaRegistry {
   public cache: Cache
 
   constructor(
-    { auth, clientId, host, retry, agent }: SchemaRegistryAPIClientArgs,
+    { auth, clientId, host, retry, agent, middlewares }: SchemaRegistryAPIClientArgs,
     options?: SchemaRegistryAPIClientOptions,
   ) {
-    this.api = API({ auth, clientId, host, retry, agent })
+    this.api = API({ auth, clientId, host, retry, agent, middlewares })
     this.cache = new Cache()
     this.options = options
   }
@@ -138,7 +138,7 @@ export default class SchemaRegistry {
         )
       }
     } catch (error) {
-      if (error.status !== 404) {
+      if (!error || typeof error !== 'object' || !('status' in error) || error.status !== 404) {
         throw error
       } else {
         isFirstTimeRegistration = true
@@ -355,7 +355,7 @@ export default class SchemaRegistry {
 
       return id
     } catch (error) {
-      if (error.status && error.status === 404) {
+      if (error && typeof error === 'object' && 'status' in error && error.status === 404) {
         throw new ConfluentSchemaRegistryError(error)
       }
 
@@ -370,18 +370,17 @@ export default class SchemaRegistry {
     return id
   }
 
-  private getSchemaOriginRequest(registryId: number) {
+  private async getSchemaOriginRequest(registryId: number): Promise<Response> {
     // ensure that cache-misses result in a single origin request
-    if (this.cacheMissRequests[registryId]) {
-      return this.cacheMissRequests[registryId]
-    } else {
-      const request = this.api.Schema.find({ id: registryId }).finally(() => {
-        delete this.cacheMissRequests[registryId]
-      })
+    const req = this.cacheMissRequests[registryId]
+    if (req) return req
 
-      this.cacheMissRequests[registryId] = request
+    const request = this.api.Schema.find({ id: registryId }).finally(() => {
+      delete this.cacheMissRequests[registryId]
+    })
 
-      return request
-    }
+    this.cacheMissRequests[registryId] = request
+
+    return request
   }
 }

package/src/api/index.spec.ts

@@ -1,7 +1,27 @@
+import { Middleware } from 'mappersmith'
 import API from '.'
 import { mockClient, install, uninstall } from 'mappersmith/test'
 
-const client = API({ clientId: 'test-client', host: 'http://example.com' })
+const customMiddleware: Middleware = jest.fn(() => {
+  return {
+    async request(request) {
+      return request.enhance({
+        headers: {
+          Authorization: 'Bearer Random',
+        },
+      })
+    },
+    async response(next) {
+      return next()
+    },
+  }
+})
+
+const client = API({
+  clientId: 'test-client',
+  host: 'http://example.com',
+  middlewares: [customMiddleware],
+})
 const mock = mockClient<typeof client>(client)
   .resource('Schema')
   .method('find')
@@ -14,10 +34,12 @@ describe('API Client', () => {
 
   afterEach(() => uninstall())
 
-  it('should include a user agent header', async () => {
+  it('should include a user agent header and call custom middleware', async () => {
     const response = await client.Schema.find({ id: 'abc' })
 
     expect(mock.callsCount()).toBe(1)
     expect(response.request().header('User-Agent')).not.toBeUndefined()
+    expect(response.request().header('Authorization')).toBe('Bearer Random')
+    expect(customMiddleware).toHaveBeenCalled()
   })
 })

package/src/api/index.ts

@@ -1,5 +1,11 @@
 import { Agent } from 'http'
-import forge, { Authorization, Client, Options, GatewayConfiguration } from 'mappersmith'
+import forge, {
+  Authorization,
+  Client,
+  GatewayConfiguration,
+  Middleware,
+  ManifestOptions,
+} from 'mappersmith'
 import RetryMiddleware, { RetryMiddlewareOptions } from 'mappersmith/middleware/retry/v2'
 import BasicAuthMiddleware from 'mappersmith/middleware/basic-auth'
 
@@ -23,6 +29,7 @@ export interface SchemaRegistryAPIClientArgs {
   retry?: Partial<RetryMiddlewareOptions>
   /** HTTP Agent that will be passed to underlying API calls */
   agent?: Agent
+  middlewares?: Middleware[]
 }
 
 // TODO: Improve typings
@@ -48,10 +55,11 @@ export default ({
   host,
   retry = {},
   agent,
+  middlewares = [],
 }: SchemaRegistryAPIClientArgs): SchemaRegistryAPIClient => {
   const clientId = userClientId || DEFAULT_API_CLIENT_ID
   // FIXME: ResourcesType typings is not exposed by mappersmith
-  const manifest: Options<any> = {
+  const manifest: ManifestOptions<any> = {
     clientId,
     ignoreGlobalMiddleware: true,
     host,
@@ -61,6 +69,7 @@ export default ({
       RetryMiddleware(Object.assign(DEFAULT_RETRY, retry)),
       errorMiddleware,
       ...(auth ? [BasicAuthMiddleware(auth)] : []),
+      ...middlewares,
     ],
     resources: {
       Schema: {

package/src/api/middleware/errorMiddleware.ts

@@ -30,7 +30,7 @@ const errorMiddleware: Middleware = ({ clientId }) => ({
     new Promise((resolve, reject) =>
       next()
         .then(resolve)
-        .catch((response: Response) => reject(new ResponseError(clientId, response))),
+        .catch((response: Response) => reject(new ResponseError(clientId ?? '', response))),
     ),
 })
 

package/src/constants.ts

@@ -8,6 +8,6 @@ export enum COMPATIBILITY {
   FULL_TRANSITIVE = 'FULL_TRANSITIVE',
 }
 
-export const DEFAULT_SEPERATOR = '.'
+export const DEFAULT_SEPARATOR = '.'
 
 export const DEFAULT_API_CLIENT_ID = 'Confluent_Schema_Registry'

package/src/index.ts

@@ -1,4 +1,5 @@
-export { default as SchemaRegistry } from './SchemaRegistry'
+import { default as SchemaRegistry, DecodeOptions } from './SchemaRegistry'
+export { SchemaRegistry, DecodeOptions }
 export * from './utils'
 export { SchemaType } from './@types'
 export { COMPATIBILITY } from './constants'

package/src/schemaTypeResolver.ts

@@ -96,6 +96,7 @@ export const schemaFromConfluentSchema = (
 
     return schema
   } catch (err) {
-    throw new ConfluentSchemaRegistryArgumentError(err.message)
+    if (err instanceof Error) throw new ConfluentSchemaRegistryArgumentError(err.message)
+    throw err
   }
 }