confluent-schema-registry 3.3.2

package/release/CHANGELOG.md

@@ -0,0 +1,166 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [3.3.0] - 2022-10-04
+
+### Added
+
+- 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
+
+This version is non-breaking for the overwhelming majority of users.
+
+When creating an instance of SchemaRegistry for Protobuf without the [`messageName`
+parameter](https://kafkajs.github.io/confluent-schema-registry/docs/usage#protobuf-1)
+confluent-schema-registry would, under certain circumstances, default
+to the wrong message type in the schema. Specifically, instead of defaulting to
+the first message type in the schema it would erroneously default to the first
+message type that did not define a nested type.
+
+**If you were relying on this behavior may need to either**:
+
+* Start passing [the `messageName` parameter](https://kafkajs.github.io/confluent-schema-registry/docs/usage#protobuf-1) instead of relying on the default behavior
+* Update your schemas and re-ingest messages accordingly
+
+See issue [#112](https://github.com/kafkajs/confluent-schema-registry/issues/112) for
+more info
+
+### Added
+
+- Allow setting HTTP agent [#108](https://github.com/kafkajs/confluent-schema-registry/pull/108)
+
+### Fixed
+
+- Fix default nested Protobuf type [#113](https://github.com/kafkajs/confluent-schema-registry/pull/113)
+
+## [2.0.1] - 2021-04-02
+
+- Fix export of SchemaType [#100](https://github.com/kafkajs/confluent-schema-registry/pull/100)
+
+## [2.0.0] - 2021-02-28
+
+This version adds support for Protobuf and JSON Schema, in addition to the already
+supported Avro format!
+
+See [Migrating to v2](https://kafkajs.github.io/confluent-schema-registry/docs/v2)
+for information on how to adapt your application to the new API. For most users,
+the change should be rather minor.
+
+Big thanks to @dskatz22 and @Malkiz for their significant contributions!
+
+### Added
+
+- Support Protobuf and JSON Schema [#93](https://github.com/kafkajs/confluent-schema-registry/pull/93)
+
+## [1.0.6] - 2020-07-02
+
+### Added
+
+- Support pre registered schemas by adding method `getRegistryIdBySchema` [#58](https://github.com/kafkajs/confluent-schema-registry/pull/58)
+
+## [1.0.5] - 2020-03-18
+
+### Added
+
+- Prevent Unnecessary Requests on Cache Misses [#48](https://github.com/kafkajs/confluent-schema-registry/pull/48)
+
+## [1.0.4] - 2020-03-07
+
+### Added
+
+- Support ForSchemaOption to call avro.Type.forSchema() [#47](https://github.com/kafkajs/confluent-schema-registry/pull/47)
+
+## [1.0.3] - 2020-02-11
+
+### Added
+
+- Support sharing of types between protocols [#43](https://github.com/kafkajs/confluent-schema-registry/pull/43)
+
+### Fixed
+
+- Fix SchemaRegistry host port [#40](https://github.com/kafkajs/confluent-schema-registry/pull/40)
+- Add string as possible type for subject version [#38](https://github.com/kafkajs/confluent-schema-registry/pull/38)
+
+## [1.0.2] - 2019-11-28
+
+### Added
+
+- Allow for specifying subjects explicitly [#19](https://github.com/kafkajs/confluent-schema-registry/pull/19)
+
+### Fixed
+
+- Fix `@types/jest` issue [#29](https://github.com/kafkajs/confluent-schema-registry/pull/29)
+- Fix `es-abstract` version issue [28](https://github.com/kafkajs/confluent-schema-registry/pull/28)
+
+## [1.0.1] - 2019-10-25
+
+### Added
+
+- Added the schema compatibility remaining constants [#14](https://github.com/kafkajs/confluent-schema-registry/pull/14)
+- Added method to fetch latest schema id by subject [#17](https://github.com/kafkajs/confluent-schema-registry/issues/17)
+- Added method to get the schemaID based on subject [#18](https://github.com/kafkajs/confluent-schema-registry/pull/18)
+- Support basic auth authentication [#21](https://github.com/kafkajs/confluent-schema-registry/pull/21)
+
+## [1.0.0] - 2019-09-13
+
+### Changed
+
+- See `0.2.0` version
+
+## [0.2.0] - 2019-09-13
+
+### Changed
+
+- Version `0.1.0` didn't transpile the Typescript files
+
+## [0.1.0] - 2019-09-12
+
+### Added
+
+- Encode, decode and sync operations

package/release/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Erik Engervall (erik.engervall@gmail.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/release/README.md

@@ -0,0 +1,44 @@
+# confluent-schema-registry
+
+`@kafkajs/confluent-schema-registry` 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 and Confluent's [wire format](https://docs.confluent.io/current/schema-registry/docs/serializer-formatter.html#wire-format).
+
+[![Build Status](https://dev.azure.com/tulios/ConfluentSchemaRegistry/_apis/build/status/kafkajs.confluent-schema-registry?branchName=master)](https://dev.azure.com/tulios/ConfluentSchemaRegistry/_build/latest?definitionId=3&branchName=master)
+
+## Getting started
+
+```sh
+npm install @kafkajs/confluent-schema-registry
+# yarn add @kafkajs/confluent-schema-registry
+```
+
+```javascript
+const { Kafka } = require('kafkajs')
+const { SchemaRegistry } = require('@kafkajs/confluent-schema-registry')
+
+const kafka = new Kafka({ clientId: 'my-app', brokers: ['kafka1:9092'] })
+const registry = new SchemaRegistry({ host: 'http://registry:8081/' })
+const consumer = kafka.consumer({ groupId: 'test-group' })
+
+const run = async () => {
+  await consumer.connect()
+  await consumer.subscribe({ topic: 'test-topic', fromBeginning: true })
+
+  await consumer.run({
+    eachMessage: async ({ topic, partition, message }) => {
+      const decodedKey = await registry.decode(message.key)
+      const decodedValue = await registry.decode(message.value)
+      console.log({ decodedKey, decodedValue })
+    },
+  })
+}
+
+run().catch(console.error)
+```
+
+## Documentation
+
+Learn more about using [KafkaJS Confluent Schema registry on the official site!](https://kafkajs.github.io/confluent-schema-registry/)
+
+## License
+
+See [LICENSE](https://github.com/kafkajs/confluent-schema-registry/blob/master/LICENSE) for more details.

package/release/dist/@types.d.ts

@@ -0,0 +1,93 @@
+/// <reference types="node" />
+import { Resolver, ForSchemaOptions, Type } from 'avsc';
+import { ValidateFunction } from './JsonSchema';
+import Ajv from 'ajv';
+export declare enum SchemaType {
+    AVRO = "AVRO",
+    JSON = "JSON",
+    PROTOBUF = "PROTOBUF",
+    UNKNOWN = "UNKNOWN"
+}
+export interface SchemaHelper {
+    validate(schema: Schema): void;
+    getSubject(confluentSchema: ConfluentSchema, schema: Schema, separator: string): ConfluentSubject;
+    toConfluentSchema(data: SchemaResponse): ConfluentSchema;
+    updateOptionsFromSchemaReferences(referencedSchemas: ConfluentSchema[], options?: ProtocolOptions): ProtocolOptions;
+}
+export declare type AvroOptions = Partial<ForSchemaOptions> & {
+    referencedSchemas?: AvroConfluentSchema[];
+};
+export declare type JsonOptions = ConstructorParameters<typeof Ajv>[0] & {
+    ajvInstance?: {
+        addSchema: Ajv['addSchema'];
+        compile: (schema: any) => ValidateFunction;
+    };
+    referencedSchemas?: JsonConfluentSchema[];
+};
+export declare type ProtoOptions = {
+    messageName?: string;
+    referencedSchemas?: ProtoConfluentSchema[];
+};
+export interface LegacyOptions {
+    forSchemaOptions?: AvroOptions;
+}
+export interface ProtocolOptions {
+    [SchemaType.AVRO]?: AvroOptions;
+    [SchemaType.JSON]?: JsonOptions;
+    [SchemaType.PROTOBUF]?: ProtoOptions;
+}
+export declare type SchemaRegistryAPIClientOptions = ProtocolOptions | LegacyOptions;
+export interface Schema {
+    toBuffer(payload: object): Buffer;
+    fromBuffer(buffer: Buffer, resolver?: Resolver, noCheck?: boolean): any;
+    isValid(payload: object, opts?: {
+        errorHook: (path: Array<string>, value: any, type?: any) => void;
+    }): boolean;
+}
+export interface RawAvroSchema {
+    name: string;
+    namespace?: string;
+    type: 'record';
+    fields: any[];
+}
+export interface AvroSchema extends Schema, RawAvroSchema, Pick<Type, 'equals' | 'createResolver'> {
+}
+export interface ConfluentSubject {
+    name: string;
+}
+export interface AvroConfluentSchema {
+    type: SchemaType.AVRO;
+    schema: string | RawAvroSchema;
+    references?: SchemaReference[];
+}
+export declare type SchemaReference = {
+    name: string;
+    subject: string;
+    version: number;
+};
+export interface ProtoConfluentSchema {
+    type: SchemaType.PROTOBUF;
+    schema: string;
+    references?: SchemaReference[];
+}
+export interface JsonConfluentSchema {
+    type: SchemaType.JSON;
+    schema: string;
+    references?: SchemaReference[];
+}
+export interface SchemaResponse {
+    schema: string;
+    schemaType: string;
+    references?: SchemaReference[];
+}
+export declare type ConfluentSchema = AvroConfluentSchema | ProtoConfluentSchema | JsonConfluentSchema;
+declare global {
+    namespace jest {
+        interface Matchers<R, T = {}> {
+            toMatchConfluentEncodedPayload(args: {
+                registryId: number;
+                payload: Buffer;
+            }): R;
+        }
+    }
+}

package/release/dist/@types.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var SchemaType;
+(function (SchemaType) {
+    SchemaType["AVRO"] = "AVRO";
+    SchemaType["JSON"] = "JSON";
+    SchemaType["PROTOBUF"] = "PROTOBUF";
+    SchemaType["UNKNOWN"] = "UNKNOWN";
+})(SchemaType = exports.SchemaType || (exports.SchemaType = {}));
+//# sourceMappingURL=@types.js.map

package/release/dist/@types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"@types.js","sourceRoot":"","sources":["../src/@types.ts"],"names":[],"mappings":";;AAIA,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,2BAAa,CAAA;IACb,2BAAa,CAAA;IACb,mCAAqB,CAAA;IACrB,iCAAmB,CAAA;AACrB,CAAC,EALW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAKrB"}

package/release/dist/AvroHelper.d.ts

@@ -0,0 +1,12 @@
+import { AvroSchema, RawAvroSchema, AvroOptions, ConfluentSchema, SchemaHelper, ConfluentSubject, ProtocolOptions, AvroConfluentSchema } from './@types';
+import avro from 'avsc';
+import { SchemaResponse } from './@types';
+export default class AvroHelper implements SchemaHelper {
+    private getRawAvroSchema;
+    getAvroSchema(schema: ConfluentSchema | RawAvroSchema, opts?: AvroOptions): avro.Type;
+    validate(avroSchema: AvroSchema): void;
+    getSubject(schema: AvroConfluentSchema, avroSchema: AvroSchema, separator: string): ConfluentSubject;
+    private isRawAvroSchema;
+    toConfluentSchema(data: SchemaResponse): AvroConfluentSchema;
+    updateOptionsFromSchemaReferences(referencedSchemas: AvroConfluentSchema[], options?: ProtocolOptions): ProtocolOptions;
+}

package/release/dist/AvroHelper.js

@@ -0,0 +1,67 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const errors_1 = require("./errors");
+const avsc_1 = __importDefault(require("avsc"));
+const _types_1 = require("./@types");
+class AvroHelper {
+    getRawAvroSchema(schema) {
+        return (typeof schema.schema === 'string'
+            ? JSON.parse(schema.schema)
+            : schema.schema);
+    }
+    getAvroSchema(schema, opts) {
+        const rawSchema = this.isRawAvroSchema(schema)
+            ? schema
+            : this.getRawAvroSchema(schema);
+        // @ts-ignore TODO: Fix typings for Schema...
+        const addReferencedSchemas = (userHook) => (schema, opts) => {
+            var _a;
+            const avroOpts = opts;
+            (_a = avroOpts === null || avroOpts === void 0 ? void 0 : avroOpts.referencedSchemas) === null || _a === void 0 ? void 0 : _a.forEach(subSchema => {
+                const rawSubSchema = this.getRawAvroSchema(subSchema);
+                avroOpts.typeHook = userHook;
+                avsc_1.default.Type.forSchema(rawSubSchema, avroOpts);
+            });
+            if (userHook) {
+                return userHook(schema, opts);
+            }
+        };
+        const avroSchema = avsc_1.default.Type.forSchema(rawSchema, {
+            ...opts,
+            typeHook: addReferencedSchemas(opts === null || opts === void 0 ? void 0 : opts.typeHook),
+        });
+        return avroSchema;
+    }
+    validate(avroSchema) {
+        if (!avroSchema.name) {
+            throw new errors_1.ConfluentSchemaRegistryArgumentError(`Invalid name: ${avroSchema.name}`);
+        }
+    }
+    getSubject(schema, 
+    // @ts-ignore
+    avroSchema, separator) {
+        const rawSchema = this.getRawAvroSchema(schema);
+        if (!rawSchema.namespace) {
+            throw new errors_1.ConfluentSchemaRegistryArgumentError(`Invalid namespace: ${rawSchema.namespace}`);
+        }
+        const subject = {
+            name: [rawSchema.namespace, rawSchema.name].join(separator),
+        };
+        return subject;
+    }
+    isRawAvroSchema(schema) {
+        const asRawAvroSchema = schema;
+        return asRawAvroSchema.name != null && asRawAvroSchema.type != null;
+    }
+    toConfluentSchema(data) {
+        return { type: _types_1.SchemaType.AVRO, schema: data.schema, references: data.references };
+    }
+    updateOptionsFromSchemaReferences(referencedSchemas, options = {}) {
+        return { ...options, [_types_1.SchemaType.AVRO]: { ...options[_types_1.SchemaType.AVRO], referencedSchemas } };
+    }
+}
+exports.default = AvroHelper;
+//# sourceMappingURL=AvroHelper.js.map

package/release/dist/AvroHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AvroHelper.js","sourceRoot":"","sources":["../src/AvroHelper.ts"],"names":[],"mappings":";;;;;AAUA,qCAA+D;AAC/D,gDAA2D;AAC3D,qCAAqD;AAGrD,MAAqB,UAAU;IACrB,gBAAgB,CAAC,MAAuB;QAC9C,OAAO,CAAC,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ;YACvC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC;YAC3B,CAAC,CAAC,MAAM,CAAC,MAAM,CAAkB,CAAA;IACrC,CAAC;IAEM,aAAa,CAAC,MAAuC,EAAE,IAAkB;QAC9E,MAAM,SAAS,GAAkB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC;YAC3D,CAAC,CAAC,MAAM;YACR,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAA;QACjC,6CAA6C;QAE7C,MAAM,oBAAoB,GAAG,CAAC,QAAmB,EAAY,EAAE,CAAC,CAC9D,MAAmB,EACnB,IAAsB,EACtB,EAAE;;YACF,MAAM,QAAQ,GAAG,IAAmB,CAAA;YACpC,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,iBAAiB,0CAAE,OAAO,CAAC,SAAS,CAAC,EAAE;gBAC/C,MAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAA;gBACrD,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAA;gBAC5B,cAAI,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAA;YAC7C,CAAC,EAAC;YACF,IAAI,QAAQ,EAAE;gBACZ,OAAO,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;aAC9B;QACH,CAAC,CAAA;QAED,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE;YAChD,GAAG,IAAI;YACP,QAAQ,EAAE,oBAAoB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,CAAC;SAC/C,CAAC,CAAA;QAEF,OAAO,UAAU,CAAA;IACnB,CAAC;IAEM,QAAQ,CAAC,UAAsB;QACpC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;YACpB,MAAM,IAAI,6CAAoC,CAAC,iBAAiB,UAAU,CAAC,IAAI,EAAE,CAAC,CAAA;SACnF;IACH,CAAC;IAEM,UAAU,CACf,MAA2B;IAC3B,aAAa;IACb,UAAsB,EACtB,SAAiB;QAEjB,MAAM,SAAS,GAAkB,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAA;QAE9D,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE;YACxB,MAAM,IAAI,6CAAoC,CAAC,sBAAsB,SAAS,CAAC,SAAS,EAAE,CAAC,CAAA;SAC5F;QAED,MAAM,OAAO,GAAqB;YAChC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;SAC5D,CAAA;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAEO,eAAe,CAAC,MAAuC;QAC7D,MAAM,eAAe,GAAG,MAAuB,CAAA;QAC/C,OAAO,eAAe,CAAC,IAAI,IAAI,IAAI,IAAI,eAAe,CAAC,IAAI,IAAI,IAAI,CAAA;IACrE,CAAC;IAEM,iBAAiB,CAAC,IAAoB;QAC3C,OAAO,EAAE,IAAI,EAAE,mBAAU,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAA;IACpF,CAAC;IAED,iCAAiC,CAC/B,iBAAwC,EACxC,UAA2B,EAAE;QAE7B,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC,mBAAU,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,mBAAU,CAAC,IAAI,CAAC,EAAE,iBAAiB,EAAE,EAAE,CAAA;IAC9F,CAAC;CACF;AA3ED,6BA2EC"}

package/release/dist/JsonHelper.d.ts

@@ -0,0 +1,7 @@
+import { Schema, SchemaHelper, ConfluentSubject, SchemaResponse, ProtocolOptions, JsonConfluentSchema } from './@types';
+export default class JsonHelper implements SchemaHelper {
+    validate(_schema: Schema): void;
+    getSubject(_confluentSchema: JsonConfluentSchema, _schema: Schema, _separator: string): ConfluentSubject;
+    toConfluentSchema(data: SchemaResponse): JsonConfluentSchema;
+    updateOptionsFromSchemaReferences(referencedSchemas: JsonConfluentSchema[], options?: ProtocolOptions): ProtocolOptions;
+}

package/release/dist/JsonHelper.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const _types_1 = require("./@types");
+const errors_1 = require("./errors");
+class JsonHelper {
+    validate(_schema) {
+        return;
+    }
+    getSubject(_confluentSchema, _schema, _separator) {
+        throw new errors_1.ConfluentSchemaRegistryError('not implemented yet');
+    }
+    toConfluentSchema(data) {
+        return { type: _types_1.SchemaType.JSON, schema: data.schema, references: data.references };
+    }
+    updateOptionsFromSchemaReferences(referencedSchemas, options = {}) {
+        return { ...options, [_types_1.SchemaType.JSON]: { ...options[_types_1.SchemaType.JSON], referencedSchemas } };
+    }
+}
+exports.default = JsonHelper;
+//# sourceMappingURL=JsonHelper.js.map

package/release/dist/JsonHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JsonHelper.js","sourceRoot":"","sources":["../src/JsonHelper.ts"],"names":[],"mappings":";;AAAA,qCAQiB;AACjB,qCAAuD;AAEvD,MAAqB,UAAU;IACtB,QAAQ,CAAC,OAAe;QAC7B,OAAM;IACR,CAAC;IAEM,UAAU,CACf,gBAAqC,EACrC,OAAe,EACf,UAAkB;QAElB,MAAM,IAAI,qCAA4B,CAAC,qBAAqB,CAAC,CAAA;IAC/D,CAAC;IAEM,iBAAiB,CAAC,IAAoB;QAC3C,OAAO,EAAE,IAAI,EAAE,mBAAU,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAA;IACpF,CAAC;IAED,iCAAiC,CAC/B,iBAAwC,EACxC,UAA2B,EAAE;QAE7B,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC,mBAAU,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,mBAAU,CAAC,IAAI,CAAC,EAAE,iBAAiB,EAAE,EAAE,CAAA;IAC9F,CAAC;CACF;AAvBD,6BAuBC"}

package/release/dist/JsonSchema.d.ts

@@ -0,0 +1,31 @@
+/// <reference types="node" />
+import { Schema, JsonOptions, JsonConfluentSchema } from './@types';
+interface BaseAjvValidationError {
+    data?: unknown;
+    schema?: unknown;
+}
+interface OldAjvValidationError extends BaseAjvValidationError {
+    dataPath: string;
+    instancePath?: string;
+}
+interface NewAjvValidationError extends BaseAjvValidationError {
+    instancePath: string;
+}
+declare type AjvValidationError = OldAjvValidationError | NewAjvValidationError;
+export interface ValidateFunction {
+    (this: any, data: any): boolean;
+    errors?: null | AjvValidationError[];
+}
+export default class JsonSchema implements Schema {
+    private validate;
+    constructor(schema: JsonConfluentSchema, opts?: JsonOptions);
+    private getJsonSchema;
+    private validatePayload;
+    toBuffer(payload: object): Buffer;
+    fromBuffer(buffer: Buffer): any;
+    isValid(payload: object, opts?: {
+        errorHook: (path: Array<string>, value: any, type?: any) => void;
+    }): boolean;
+    private isOldAjvValidationError;
+}
+export {};

package/release/dist/JsonSchema.js

@@ -0,0 +1,58 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ajv_1 = __importDefault(require("ajv"));
+const errors_1 = require("./errors");
+class JsonSchema {
+    constructor(schema, opts) {
+        this.validate = this.getJsonSchema(schema, opts);
+    }
+    getJsonSchema(schema, opts) {
+        var _a;
+        const ajv = (_a = opts === null || opts === void 0 ? void 0 : opts.ajvInstance) !== null && _a !== void 0 ? _a : new ajv_1.default(opts);
+        const referencedSchemas = opts === null || opts === void 0 ? void 0 : opts.referencedSchemas;
+        if (referencedSchemas) {
+            referencedSchemas.forEach(rawSchema => {
+                const $schema = JSON.parse(rawSchema.schema);
+                ajv.addSchema($schema, $schema['$id']);
+            });
+        }
+        const validate = ajv.compile(JSON.parse(schema.schema));
+        return validate;
+    }
+    validatePayload(payload) {
+        const paths = [];
+        if (!this.isValid(payload, { errorHook: path => paths.push(path) })) {
+            throw new errors_1.ConfluentSchemaRegistryValidationError('invalid payload', paths);
+        }
+    }
+    toBuffer(payload) {
+        this.validatePayload(payload);
+        return Buffer.from(JSON.stringify(payload));
+    }
+    fromBuffer(buffer) {
+        const payload = JSON.parse(buffer.toString());
+        this.validatePayload(payload);
+        return payload;
+    }
+    isValid(payload, opts) {
+        var _a;
+        if (!this.validate(payload)) {
+            if (opts === null || opts === void 0 ? void 0 : opts.errorHook) {
+                for (const err of (_a = this.validate.errors) !== null && _a !== void 0 ? _a : []) {
+                    const path = this.isOldAjvValidationError(err) ? err.dataPath : err.instancePath;
+                    opts === null || opts === void 0 ? void 0 : opts.errorHook([path], err.data, err.schema);
+                }
+            }
+            return false;
+        }
+        return true;
+    }
+    isOldAjvValidationError(error) {
+        return error.dataPath != null;
+    }
+}
+exports.default = JsonSchema;
+//# sourceMappingURL=JsonSchema.js.map

package/release/dist/JsonSchema.js.map

@@ -0,0 +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;IAEM,OAAO,CACZ,OAAe,EACf,IAA2E;;QAE3E,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,UAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,mCAAE,EAAE,EAAE;oBAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAA;oBAChF,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,CAAC,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,EAAC;iBAC9C;aACF;YACD,OAAO,KAAK,CAAA;SACb;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAEO,uBAAuB,CAAC,KAAyB;QACvD,OAAQ,KAA+B,CAAC,QAAQ,IAAI,IAAI,CAAA;IAC1D,CAAC;CACF;AAzDD,6BAyDC"}

package/release/dist/ProtoHelper.d.ts

@@ -0,0 +1,7 @@
+import { Schema, SchemaHelper, ConfluentSubject, SchemaResponse, ProtocolOptions, ProtoConfluentSchema } from './@types';
+export default class ProtoHelper implements SchemaHelper {
+    validate(_schema: Schema): void;
+    getSubject(_confluentSchema: ProtoConfluentSchema, _schema: Schema, _separator: string): ConfluentSubject;
+    toConfluentSchema(data: SchemaResponse): ProtoConfluentSchema;
+    updateOptionsFromSchemaReferences(referencedSchemas: ProtoConfluentSchema[], options?: ProtocolOptions): ProtocolOptions;
+}

package/release/dist/ProtoHelper.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const _types_1 = require("./@types");
+const errors_1 = require("./errors");
+class ProtoHelper {
+    validate(_schema) {
+        return;
+    }
+    getSubject(_confluentSchema, _schema, _separator) {
+        throw new errors_1.ConfluentSchemaRegistryError('not implemented yet');
+    }
+    toConfluentSchema(data) {
+        return { type: _types_1.SchemaType.PROTOBUF, schema: data.schema, references: data.references };
+    }
+    updateOptionsFromSchemaReferences(referencedSchemas, options = {}) {
+        return {
+            ...options,
+            [_types_1.SchemaType.PROTOBUF]: { ...options[_types_1.SchemaType.PROTOBUF], referencedSchemas },
+        };
+    }
+}
+exports.default = ProtoHelper;
+//# sourceMappingURL=ProtoHelper.js.map

package/release/dist/ProtoHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProtoHelper.js","sourceRoot":"","sources":["../src/ProtoHelper.ts"],"names":[],"mappings":";;AAAA,qCAQiB;AACjB,qCAAuD;AAEvD,MAAqB,WAAW;IACvB,QAAQ,CAAC,OAAe;QAC7B,OAAM;IACR,CAAC;IAEM,UAAU,CACf,gBAAsC,EACtC,OAAe,EACf,UAAkB;QAElB,MAAM,IAAI,qCAA4B,CAAC,qBAAqB,CAAC,CAAA;IAC/D,CAAC;IAEM,iBAAiB,CAAC,IAAoB;QAC3C,OAAO,EAAE,IAAI,EAAE,mBAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAA;IACxF,CAAC;IAED,iCAAiC,CAC/B,iBAAyC,EACzC,UAA2B,EAAE;QAE7B,OAAO;YACL,GAAG,OAAO;YACV,CAAC,mBAAU,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,mBAAU,CAAC,QAAQ,CAAC,EAAE,iBAAiB,EAAE;SAC9E,CAAA;IACH,CAAC;CACF;AA1BD,8BA0BC"}

package/release/dist/ProtoSchema.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="node" />
+import { Schema, ProtoOptions, ProtoConfluentSchema } from './@types';
+export default class ProtoSchema implements Schema {
+    private message;
+    constructor(schema: ProtoConfluentSchema, opts?: ProtoOptions);
+    private getNestedTypeName;
+    private getTypeName;
+    private trimStart;
+    toBuffer(payload: object): Buffer;
+    fromBuffer(buffer: Buffer): any;
+    isValid(payload: object, opts?: {
+        errorHook: (path: Array<string>, value: any, type?: any) => void;
+    }): boolean;
+}