@azure/schema-registry-json 1.0.0-alpha.20230809.1

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Microsoft
+
+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/README.md

@@ -0,0 +1,167 @@
+# Azure Schema Registry Json Serializer client library for JavaScript
+
+Azure Schema Registry is a schema repository service hosted by Azure Event Hubs,
+providing schema storage, versioning, and management. This package provides an
+Json serializer capable of serializing and deserializing payloads containing
+Json-serialized data.
+
+Key links:
+
+- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/schemaregistry/schema-registry-json)
+- [Package (npm)](https://www.npmjs.com/package/@azure/schema-registry-json)
+- [API Reference Documentation](https://aka.ms/schemaregistryjson-js-api)
+- [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/schemaregistry/schema-registry-json/samples)
+
+## Getting started
+
+- [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule)
+
+### Prerequisites
+
+- An [Azure subscription][azure_sub]
+- An existing [Schema Registry resource](https://aka.ms/schemaregistry)
+
+### Install the `@azure/schema-registry-json` package
+
+Install the Azure Text Analytics client library for JavaScript with `npm`:
+
+```bash
+npm install @azure/schema-registry-json
+```
+
+## Key concepts
+
+### JsonSerializer
+
+Provides API to serialize to and deserialize from JSON wrapped in a message
+with a content type field containing the schema ID. Uses
+`SchemaRegistryClient` from the [@azure/schema-registry](https://www.npmjs.com/package/@azure/schema-registry) package
+to get schema IDs from schema definition or vice versa. The provided API has internal cache to avoid calling the schema registry service when possible.
+
+### Messages
+
+By default, the serializer will create messages structured as follows:
+
+- `data`: a byte array containing JSON data.
+
+- `contentType`: a string of the following format `application/json+<Schema ID>` where
+  the `application/json` part signals that this message has a Json-serialized payload
+  and the `<Schema Id>` part is the Schema ID the Schema Registry service assigned
+  to the schema used to serialize this payload.
+
+Not all messaging services are supporting the same message structure. To enable
+integration with such services, the serializer can act on custom message structures
+by setting the `messageAdapter` option in the constructor with a corresponding
+message producer and consumer. Azure messaging client libraries export default
+adapters for their message types.
+
+## Examples
+
+### Serialize and deserialize an `@azure/event-hubs`'s `EventData`
+
+```javascript
+const { DefaultAzureCredential } = require("@azure/identity");
+const { createEventDataAdapter } = require("@azure/event-hubs");
+const { SchemaRegistryClient } = require("@azure/schema-registry");
+const { JsonSerializer } = require("@azure/schema-registry-json");
+
+const client = new SchemaRegistryClient(
+  "<fully qualified namespace>",
+  new DefaultAzureCredential()
+);
+const serializer = new JsonSerializer(client, {
+  groupName: "<group>",
+  messageAdapter: createEventDataAdapter(),
+});
+
+// Example Json schema
+const schema = JSON.stringify({  
+  $schema: "http://json-schema.org/draft-04/schema#",
+  $id: "person",
+  title: "Student",
+  description: "A student in the class",
+  type: "object",
+  properties: {
+    name: {
+      type: "string",
+      description: "The name of the student",
+    },
+  },
+  required: ["name"]
+});
+
+// Example value that matches the Json schema above
+const value = { name: "Bob" };
+
+// Serialize value to a message
+const message = await serializer.serialize(value, schema);
+
+// Deserialize a message to value
+const deserializedValue = await serializer.deserialize(message);
+```
+
+The serializer doesn't check whether the deserialized value matches the schema 
+but provides an option to implement such validation. The application can pass a 
+validation callback function as one of the options to the deserialize method where schema validation can be implemented.
+To see how the validation might be implemented, please checkout the [`schemaRegistryJsonWithValidation`](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/schemaregistry/schema-registry-json/samples-dev/schemaRegistryJsonWithValidation.ts)
+sample.
+
+## Troubleshooting
+
+The Json serializer communicates with the [Schema Registry][schema_registry] service as needed to register or query schemas and those service calls could throw a [RestError][resterror]. Furthermore, errors of type `Error` will be thrown when serialization or deserialization fails. The `cause` property will contain the underlying error that was thrown from the JSON parser.
+
+### Logging
+
+Enabling logging may help uncover useful information about failures. In order to
+see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment
+variable to `info`. Alternatively, logging can be enabled at runtime by calling
+`setLogLevel` in the `@azure/logger`:
+
+```javascript
+const { setLogLevel } = require("@azure/logger");
+
+setLogLevel("info");
+```
+
+## Next steps
+
+Please take a look at the
+[samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/schemaregistry/schema-registry-json/samples)
+directory for detailed examples on how to use this library.
+
+## Contributing
+
+This project welcomes contributions and suggestions. Most contributions require
+you to agree to a Contributor License Agreement (CLA) declaring that you have
+the right to, and actually do, grant us the rights to use your contribution. For
+details, visit https://cla.microsoft.com.
+
+When you submit a pull request, a CLA-bot will automatically determine whether
+you need to provide a CLA and decorate the PR appropriately (e.g., label,
+comment). Simply follow the instructions provided by the bot. You will only need
+to do this once across all repos using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of
+Conduct](https://opensource.microsoft.com/codeofconduct/). For more information
+see the [Code of Conduct
+FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact
+[opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional
+questions or comments.
+
+If you'd like to contribute to this library, please read the [contributing
+guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to
+learn more about how to build and test the code.
+
+## Related projects
+
+- [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js)
+
+![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fschemaregistry%2Fschema-registry-json%2FREADME.png)
+
+[azure_cli]: https://docs.microsoft.com/cli/azure
+[azure_sub]: https://azure.microsoft.com/free/
+[azure_portal]: https://portal.azure.com
+[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity
+[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential
+[resterror]: https://docs.microsoft.com/javascript/api/@azure/core-rest-pipeline/resterror?view=azure-node-latest
+[schema_registry]: https://docs.microsoft.com/javascript/api/overview/azure/schema-registry-readme?view=azure-node-latest

package/dist/index.js

@@ -0,0 +1,217 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var schemaRegistry = require('@azure/schema-registry');
+var LRUCache = require('lru-cache');
+var logger$1 = require('@azure/logger');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var LRUCache__default = /*#__PURE__*/_interopDefaultLegacy(LRUCache);
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+function isMessageContent(message) {
+    const castMessage = message;
+    return castMessage.data !== undefined && castMessage.contentType !== undefined;
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/** @internal */
+function wrapError(f, message) {
+    let result;
+    try {
+        result = f();
+    }
+    catch (cause) {
+        throw errorWithCause(message, cause);
+    }
+    return result;
+}
+/** @internal */
+function errorWithCause(message, cause) {
+    return new Error(message, 
+    // TS v4.6 and below do not yet recognize the cause option in the Error constructor
+    // see https://medium.com/ovrsea/power-up-your-node-js-debugging-and-error-handling-with-the-new-error-cause-feature-4136c563126a
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    { cause });
+}
+
+// Copyright (c) Microsoft Corporation.
+/**
+ * The \@azure/logger configuration for the schema-registry-json package.
+ */
+const logger = logger$1.createClientLogger("schema-registry-json");
+
+// Copyright (c) Microsoft Corporation.
+const jsonMimeType = "application/json";
+const encoder = new TextEncoder();
+const decoder = new TextDecoder();
+function getSchemaObject(schema) {
+    return wrapError(() => JSON.parse(schema), `Parsing Json schema failed:\n\n\t${schema}\n\nSee 'cause' for more details.`);
+}
+const cacheOptions = {
+    max: 128,
+    /**
+     * This is needed in order to specify `sizeCalculation` but we do not intend
+     * to limit the size just yet.
+     */
+    maxSize: Number.MAX_VALUE,
+    sizeCalculation: (_value, key) => {
+        return key.length;
+    },
+};
+/**
+ * Json serializer that obtains schemas from a schema registry and does not
+ * pack schemas into its payloads.
+ */
+class JsonSerializer {
+    /**
+     * Creates a new serializer.
+     *
+     * @param client - Schema Registry where schemas are registered and obtained.
+     *                 Usually this is a SchemaRegistryClient instance.
+     */
+    constructor(client, options) {
+        this.cacheIdByDefinition = new LRUCache__default["default"](cacheOptions);
+        this.cacheById = new LRUCache__default["default"](cacheOptions);
+        this.registry = client;
+        this.schemaGroup = options === null || options === void 0 ? void 0 : options.groupName;
+        this.messageAdapter = options === null || options === void 0 ? void 0 : options.messageAdapter;
+    }
+    /**
+     * serializes the value parameter according to the input schema and creates a message
+     * with the serialized data.
+     *
+     * @param value - The value to serialize.
+     * @param schema - The Json schema to use.
+     * @returns A new message with the serialized value. The structure of message is
+     * constrolled by the message factory option.
+     * @throws {@link Error}
+     * Thrown if the schema can not be parsed or the value does not match the schema.
+     */
+    async serialize(value, schema) {
+        const entry = await this.getSchemaByDefinition(schema);
+        const data = wrapError(() => encoder.encode(JSON.stringify(value)), `Json serialization failed. See 'cause' for more details. Schema ID: ${entry.id}`);
+        const contentType = `${jsonMimeType}+${entry.id}`;
+        return this.messageAdapter
+            ? this.messageAdapter.produce({
+                contentType,
+                data,
+            })
+            : /**
+               * If no message consumer was provided, then a MessageContent will be
+               * returned. This should work because the MessageT type parameter defaults
+               * to MessageContent.
+               */
+                {
+                    data,
+                    contentType,
+                };
+    }
+    /**
+     * Deserializes the payload of the message using the schema ID in the content type
+     * field if no schema was provided.
+     *
+     * @param message - The message with the payload to be deserialized.
+     * @returns The deserialized value.
+     * @throws {@link Error}
+     * Thrown if the deserialization failed, e.g. because reader and writer schemas are incompatible.
+     */
+    async deserialize(message, options) {
+        const { data, contentType } = convertMessage(message, this.messageAdapter);
+        const schemaId = getSchemaId(contentType);
+        const schema = await this.getSchemaById(schemaId);
+        const returnedMessage = wrapError(() => JSON.parse(decoder.decode(data)), `Json deserialization failed with schema ID (${schemaId}). See 'cause' for more details.`);
+        const validate = options === null || options === void 0 ? void 0 : options.validateCallback;
+        if (validate) {
+            wrapError(() => validate(returnedMessage, schema), `Json validation failed. See 'cause' for more details. Schema ID: ${schemaId}`);
+        }
+        return returnedMessage;
+    }
+    async getSchemaById(schemaId) {
+        const cached = this.cacheById.get(schemaId);
+        if (cached) {
+            return cached;
+        }
+        const schemaResponse = await this.registry.getSchema(schemaId);
+        if (!schemaResponse) {
+            throw new Error(`Schema with ID '${schemaId}' not found.`);
+        }
+        if (!schemaResponse.properties.format.match(/^json$/i)) {
+            throw new Error(`Schema with ID '${schemaResponse.properties.id}' has format '${schemaResponse.properties.format}', not 'json'.`);
+        }
+        return this.cache(schemaResponse.definition, schemaId).schema;
+    }
+    async getSchemaByDefinition(definition) {
+        const schemaId = this.cacheIdByDefinition.get(definition);
+        if (schemaId) {
+            return { id: schemaId, schema: definition };
+        }
+        if (!this.schemaGroup) {
+            throw new Error("Schema group must have been specified in the constructor options when the client was created in order to serialize.");
+        }
+        const schemaObj = getSchemaObject(definition);
+        const description = {
+            groupName: this.schemaGroup,
+            name: getSchemaName(schemaObj),
+            format: schemaRegistry.KnownSchemaFormats.Json,
+            definition,
+        };
+        let id;
+        try {
+            id = (await this.registry.getSchemaProperties(description)).id;
+        }
+        catch (e) {
+            if (e.statusCode === 404) {
+                throw errorWithCause(`Schema '${description.name}' not found in registry group '${description.groupName}', or not found to have matching definition.`, e);
+            }
+            else {
+                throw e;
+            }
+        }
+        return this.cache(definition, id);
+    }
+    cache(schema, id) {
+        const entry = { schema, id };
+        this.cacheIdByDefinition.set(schema, id);
+        this.cacheById.set(id, schema);
+        logger.verbose(`Cache entry added or updated. Total number of entries: ${this.cacheIdByDefinition.size}; Total schema length ${this.cacheIdByDefinition.calculatedSize}`);
+        return entry;
+    }
+}
+function getSchemaId(contentType) {
+    const contentTypeParts = contentType.split("+");
+    if (contentTypeParts.length !== 2) {
+        throw new Error("Content type was not in the expected format of MIME type + schema ID");
+    }
+    if (contentTypeParts[0] !== jsonMimeType) {
+        throw new Error(`Received content of type ${contentTypeParts[0]} but an json serializer may only be used on content that is of '${jsonMimeType}' type`);
+    }
+    return contentTypeParts[1];
+}
+function convertMessage(message, adapter) {
+    const messageConsumer = adapter === null || adapter === void 0 ? void 0 : adapter.consume;
+    if (messageConsumer) {
+        return messageConsumer(message);
+    }
+    else if (isMessageContent(message)) {
+        return message;
+    }
+    else {
+        throw new Error(`Expected either a message adapter to be provided to the serializer or the input message to have data and contentType fields`);
+    }
+}
+function getSchemaName(schema) {
+    const id = schema.$id || schema.id;
+    if (!id) {
+        throw new Error("Schema must have an ID.");
+    }
+    return id;
+}
+
+exports.JsonSerializer = JsonSerializer;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/utility.ts","../src/errors.ts","../src/logger.ts","../src/jsonSerializer.ts"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { MessageContent } from \"./models\";\n\nexport function isMessageContent(message: unknown): message is MessageContent {\n  const castMessage = message as MessageContent;\n  return castMessage.data !== undefined && castMessage.contentType !== undefined;\n}\n","// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/** @internal */\nexport function wrapError<T>(f: () => T, message: string): T {\n  let result: T;\n  try {\n    result = f();\n  } catch (cause) {\n    throw errorWithCause(message, cause as Error);\n  }\n  return result;\n}\n\n/** @internal */\nexport function errorWithCause(message: string, cause: Error): Error {\n  return new Error(\n    message,\n    // TS v4.6 and below do not yet recognize the cause option in the Error constructor\n    // see https://medium.com/ovrsea/power-up-your-node-js-debugging-and-error-handling-with-the-new-error-cause-feature-4136c563126a\n    // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n    // @ts-ignore\n    { cause }\n  );\n}\n","// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { createClientLogger } from \"@azure/logger\";\n\n/**\n * The \\@azure/logger configuration for the schema-registry-json package.\n */\nexport const logger = createClientLogger(\"schema-registry-json\");\n","// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport {\n  DeserializeOptions,\n  JsonSerializerOptions,\n  MessageAdapter,\n  MessageContent,\n} from \"./models\";\nimport { KnownSchemaFormats, SchemaDescription, SchemaRegistry } from \"@azure/schema-registry\";\nimport { isMessageContent } from \"./utility\";\nimport { errorWithCause, wrapError } from \"./errors\";\nimport LRUCache from \"lru-cache\";\nimport LRUCacheOptions = LRUCache.Options;\nimport { logger } from \"./logger\";\n\nconst jsonMimeType = \"application/json\";\nconst encoder = new TextEncoder();\nconst decoder = new TextDecoder();\n\ninterface CacheEntry {\n  /** Schema ID */\n  id: string;\n  /** Schema string */\n  schema: string;\n}\ninterface SchemaObject {\n  id?: string;\n  $id?: string;\n  $schema?: string;\n}\nfunction getSchemaObject(schema: string): SchemaObject {\n  return wrapError(\n    () => JSON.parse(schema),\n    `Parsing Json schema failed:\\n\\n\\t${schema}\\n\\nSee 'cause' for more details.`\n  );\n}\n\nconst cacheOptions: LRUCacheOptions<string, any> = {\n  max: 128,\n  /**\n   * This is needed in order to specify `sizeCalculation` but we do not intend\n   * to limit the size just yet.\n   */\n  maxSize: Number.MAX_VALUE,\n  sizeCalculation: (_value: any, key: string) => {\n    return key.length;\n  },\n};\n\n/**\n * Json serializer that obtains schemas from a schema registry and does not\n * pack schemas into its payloads.\n */\nexport class JsonSerializer<MessageT = MessageContent> {\n  /**\n   * Creates a new serializer.\n   *\n   * @param client - Schema Registry where schemas are registered and obtained.\n   *                 Usually this is a SchemaRegistryClient instance.\n   */\n  constructor(client: SchemaRegistry, options?: JsonSerializerOptions<MessageT>) {\n    this.registry = client;\n    this.schemaGroup = options?.groupName;\n    this.messageAdapter = options?.messageAdapter;\n  }\n\n  private readonly schemaGroup?: string;\n  private readonly registry: SchemaRegistry;\n  private readonly messageAdapter?: MessageAdapter<MessageT>;\n  private readonly cacheIdByDefinition = new LRUCache<string, string>(cacheOptions);\n  private readonly cacheById = new LRUCache<string, string>(cacheOptions);\n\n  /**\n   * serializes the value parameter according to the input schema and creates a message\n   * with the serialized data.\n   *\n   * @param value - The value to serialize.\n   * @param schema - The Json schema to use.\n   * @returns A new message with the serialized value. The structure of message is\n   * constrolled by the message factory option.\n   * @throws {@link Error}\n   * Thrown if the schema can not be parsed or the value does not match the schema.\n   */\n  async serialize(value: unknown, schema: string): Promise<MessageT> {\n    const entry = await this.getSchemaByDefinition(schema);\n    const data = wrapError(\n      () => encoder.encode(JSON.stringify(value)),\n      `Json serialization failed. See 'cause' for more details. Schema ID: ${entry.id}`\n    );\n    const contentType = `${jsonMimeType}+${entry.id}`;\n    return this.messageAdapter\n      ? this.messageAdapter.produce({\n          contentType,\n          data,\n        })\n      : /**\n         * If no message consumer was provided, then a MessageContent will be\n         * returned. This should work because the MessageT type parameter defaults\n         * to MessageContent.\n         */\n        ({\n          data,\n          contentType,\n        } as MessageContent as unknown as MessageT);\n  }\n\n  /**\n   * Deserializes the payload of the message using the schema ID in the content type\n   * field if no schema was provided.\n   *\n   * @param message - The message with the payload to be deserialized.\n   * @returns The deserialized value.\n   * @throws {@link Error}\n   * Thrown if the deserialization failed, e.g. because reader and writer schemas are incompatible.\n   */\n  async deserialize(message: MessageT, options?: DeserializeOptions): Promise<unknown> {\n    const { data, contentType } = convertMessage(message, this.messageAdapter);\n    const schemaId = getSchemaId(contentType);\n    const schema = await this.getSchemaById(schemaId);\n    const returnedMessage = wrapError(\n      () => JSON.parse(decoder.decode(data)),\n      `Json deserialization failed with schema ID (${schemaId}). See 'cause' for more details.`\n    );\n    const validate = options?.validateCallback;\n    if (validate) {\n      wrapError(\n        () => validate(returnedMessage, schema),\n        `Json validation failed. See 'cause' for more details. Schema ID: ${schemaId}`\n      );\n    }\n    return returnedMessage;\n  }\n\n  private async getSchemaById(schemaId: string): Promise<string> {\n    const cached = this.cacheById.get(schemaId);\n    if (cached) {\n      return cached;\n    }\n    const schemaResponse = await this.registry.getSchema(schemaId);\n    if (!schemaResponse) {\n      throw new Error(`Schema with ID '${schemaId}' not found.`);\n    }\n\n    if (!schemaResponse.properties.format.match(/^json$/i)) {\n      throw new Error(\n        `Schema with ID '${schemaResponse.properties.id}' has format '${schemaResponse.properties.format}', not 'json'.`\n      );\n    }\n    return this.cache(schemaResponse.definition, schemaId).schema;\n  }\n\n  private async getSchemaByDefinition(definition: string): Promise<CacheEntry> {\n    const schemaId = this.cacheIdByDefinition.get(definition);\n    if (schemaId) {\n      return { id: schemaId, schema: definition };\n    }\n    if (!this.schemaGroup) {\n      throw new Error(\n        \"Schema group must have been specified in the constructor options when the client was created in order to serialize.\"\n      );\n    }\n    const schemaObj = getSchemaObject(definition);\n    const description: SchemaDescription = {\n      groupName: this.schemaGroup,\n      name: getSchemaName(schemaObj),\n      format: KnownSchemaFormats.Json,\n      definition,\n    };\n    let id: string;\n\n    try {\n      id = (await this.registry.getSchemaProperties(description)).id;\n    } catch (e) {\n      if ((e as any).statusCode === 404) {\n        throw errorWithCause(\n          `Schema '${description.name}' not found in registry group '${description.groupName}', or not found to have matching definition.`,\n          e as Error\n        );\n      } else {\n        throw e;\n      }\n    }\n\n    return this.cache(definition, id);\n  }\n\n  private cache(schema: string, id: string): CacheEntry {\n    const entry = { schema, id };\n    this.cacheIdByDefinition.set(schema, id);\n    this.cacheById.set(id, schema);\n    logger.verbose(\n      `Cache entry added or updated. Total number of entries: ${this.cacheIdByDefinition.size}; Total schema length ${this.cacheIdByDefinition.calculatedSize}`\n    );\n    return entry;\n  }\n}\n\nfunction getSchemaId(contentType: string): string {\n  const contentTypeParts = contentType.split(\"+\");\n  if (contentTypeParts.length !== 2) {\n    throw new Error(\"Content type was not in the expected format of MIME type + schema ID\");\n  }\n  if (contentTypeParts[0] !== jsonMimeType) {\n    throw new Error(\n      `Received content of type ${contentTypeParts[0]} but an json serializer may only be used on content that is of '${jsonMimeType}' type`\n    );\n  }\n  return contentTypeParts[1];\n}\n\nfunction convertMessage<MessageT>(\n  message: MessageT,\n  adapter?: MessageAdapter<MessageT>\n): MessageContent {\n  const messageConsumer = adapter?.consume;\n  if (messageConsumer) {\n    return messageConsumer(message);\n  } else if (isMessageContent(message)) {\n    return message;\n  } else {\n    throw new Error(\n      `Expected either a message adapter to be provided to the serializer or the input message to have data and contentType fields`\n    );\n  }\n}\n\nfunction getSchemaName(schema: SchemaObject): string {\n  const id = schema.$id || schema.id;\n  if (!id) {\n    throw new Error(\"Schema must have an ID.\");\n  }\n  return id;\n}\n"],"names":["createClientLogger","LRUCache","KnownSchemaFormats"],"mappings":";;;;;;;;;;;;AAAA;AACA;AAIM,SAAU,gBAAgB,CAAC,OAAgB,EAAA;IAC/C,MAAM,WAAW,GAAG,OAAyB,CAAC;IAC9C,OAAO,WAAW,CAAC,IAAI,KAAK,SAAS,IAAI,WAAW,CAAC,WAAW,KAAK,SAAS,CAAC;AACjF;;ACRA;AACA;AAEA;AACgB,SAAA,SAAS,CAAI,CAAU,EAAE,OAAe,EAAA;AACtD,IAAA,IAAI,MAAS,CAAC;IACd,IAAI;QACF,MAAM,GAAG,CAAC,EAAE,CAAC;AACd,KAAA;AAAC,IAAA,OAAO,KAAK,EAAE;AACd,QAAA,MAAM,cAAc,CAAC,OAAO,EAAE,KAAc,CAAC,CAAC;AAC/C,KAAA;AACD,IAAA,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;AACgB,SAAA,cAAc,CAAC,OAAe,EAAE,KAAY,EAAA;IAC1D,OAAO,IAAI,KAAK,CACd,OAAO;;;;;IAKP,EAAE,KAAK,EAAE,CACV,CAAC;AACJ;;ACxBA;AAKA;;AAEG;AACI,MAAM,MAAM,GAAGA,2BAAkB,CAAC,sBAAsB,CAAC;;ACRhE;AAgBA,MAAM,YAAY,GAAG,kBAAkB,CAAC;AACxC,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;AAClC,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;AAalC,SAAS,eAAe,CAAC,MAAc,EAAA;AACrC,IAAA,OAAO,SAAS,CACd,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EACxB,CAAA,iCAAA,EAAoC,MAAM,CAAA,iCAAA,CAAmC,CAC9E,CAAC;AACJ,CAAC;AAED,MAAM,YAAY,GAAiC;AACjD,IAAA,GAAG,EAAE,GAAG;AACR;;;AAGG;IACH,OAAO,EAAE,MAAM,CAAC,SAAS;AACzB,IAAA,eAAe,EAAE,CAAC,MAAW,EAAE,GAAW,KAAI;QAC5C,OAAO,GAAG,CAAC,MAAM,CAAC;KACnB;CACF,CAAC;AAEF;;;AAGG;MACU,cAAc,CAAA;AACzB;;;;;AAKG;IACH,WAAY,CAAA,MAAsB,EAAE,OAAyC,EAAA;AAS5D,QAAA,IAAA,CAAA,mBAAmB,GAAG,IAAIC,4BAAQ,CAAiB,YAAY,CAAC,CAAC;AACjE,QAAA,IAAA,CAAA,SAAS,GAAG,IAAIA,4BAAQ,CAAiB,YAAY,CAAC,CAAC;AATtE,QAAA,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC;QACvB,IAAI,CAAC,WAAW,GAAG,OAAO,KAAA,IAAA,IAAP,OAAO,KAAP,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,OAAO,CAAE,SAAS,CAAC;QACtC,IAAI,CAAC,cAAc,GAAG,OAAO,KAAA,IAAA,IAAP,OAAO,KAAP,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,OAAO,CAAE,cAAc,CAAC;KAC/C;AAQD;;;;;;;;;;AAUG;AACH,IAAA,MAAM,SAAS,CAAC,KAAc,EAAE,MAAc,EAAA;QAC5C,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;QACvD,MAAM,IAAI,GAAG,SAAS,CACpB,MAAM,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAC3C,CAAuE,oEAAA,EAAA,KAAK,CAAC,EAAE,CAAE,CAAA,CAClF,CAAC;QACF,MAAM,WAAW,GAAG,CAAG,EAAA,YAAY,IAAI,KAAK,CAAC,EAAE,CAAA,CAAE,CAAC;QAClD,OAAO,IAAI,CAAC,cAAc;AACxB,cAAE,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;gBAC1B,WAAW;gBACX,IAAI;aACL,CAAC;AACJ;;;;AAIK;AACF,gBAAA;oBACC,IAAI;oBACJ,WAAW;iBAC8B,CAAC;KACjD;AAED;;;;;;;;AAQG;AACH,IAAA,MAAM,WAAW,CAAC,OAAiB,EAAE,OAA4B,EAAA;AAC/D,QAAA,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;AAC3E,QAAA,MAAM,QAAQ,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAClD,MAAM,eAAe,GAAG,SAAS,CAC/B,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EACtC,CAA+C,4CAAA,EAAA,QAAQ,CAAkC,gCAAA,CAAA,CAC1F,CAAC;QACF,MAAM,QAAQ,GAAG,OAAO,KAAA,IAAA,IAAP,OAAO,KAAP,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,OAAO,CAAE,gBAAgB,CAAC;AAC3C,QAAA,IAAI,QAAQ,EAAE;AACZ,YAAA,SAAS,CACP,MAAM,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC,EACvC,CAAA,iEAAA,EAAoE,QAAQ,CAAA,CAAE,CAC/E,CAAC;AACH,SAAA;AACD,QAAA,OAAO,eAAe,CAAC;KACxB;IAEO,MAAM,aAAa,CAAC,QAAgB,EAAA;QAC1C,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAC5C,QAAA,IAAI,MAAM,EAAE;AACV,YAAA,OAAO,MAAM,CAAC;AACf,SAAA;QACD,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC/D,IAAI,CAAC,cAAc,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,mBAAmB,QAAQ,CAAA,YAAA,CAAc,CAAC,CAAC;AAC5D,SAAA;QAED,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE;AACtD,YAAA,MAAM,IAAI,KAAK,CACb,CAAmB,gBAAA,EAAA,cAAc,CAAC,UAAU,CAAC,EAAE,CAAA,cAAA,EAAiB,cAAc,CAAC,UAAU,CAAC,MAAM,CAAA,cAAA,CAAgB,CACjH,CAAC;AACH,SAAA;AACD,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC;KAC/D;IAEO,MAAM,qBAAqB,CAAC,UAAkB,EAAA;QACpD,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;AAC1D,QAAA,IAAI,QAAQ,EAAE;YACZ,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;AAC7C,SAAA;AACD,QAAA,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;AACrB,YAAA,MAAM,IAAI,KAAK,CACb,qHAAqH,CACtH,CAAC;AACH,SAAA;AACD,QAAA,MAAM,SAAS,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC;AAC9C,QAAA,MAAM,WAAW,GAAsB;YACrC,SAAS,EAAE,IAAI,CAAC,WAAW;AAC3B,YAAA,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC;YAC9B,MAAM,EAAEC,iCAAkB,CAAC,IAAI;YAC/B,UAAU;SACX,CAAC;AACF,QAAA,IAAI,EAAU,CAAC;QAEf,IAAI;AACF,YAAA,EAAE,GAAG,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,WAAW,CAAC,EAAE,EAAE,CAAC;AAChE,SAAA;AAAC,QAAA,OAAO,CAAC,EAAE;AACV,YAAA,IAAK,CAAS,CAAC,UAAU,KAAK,GAAG,EAAE;AACjC,gBAAA,MAAM,cAAc,CAClB,CAAW,QAAA,EAAA,WAAW,CAAC,IAAI,CAAA,+BAAA,EAAkC,WAAW,CAAC,SAAS,CAAA,4CAAA,CAA8C,EAChI,CAAU,CACX,CAAC;AACH,aAAA;AAAM,iBAAA;AACL,gBAAA,MAAM,CAAC,CAAC;AACT,aAAA;AACF,SAAA;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;KACnC;IAEO,KAAK,CAAC,MAAc,EAAE,EAAU,EAAA;AACtC,QAAA,MAAM,KAAK,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QAC7B,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACzC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;AAC/B,QAAA,MAAM,CAAC,OAAO,CACZ,CAA0D,uDAAA,EAAA,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAA,sBAAA,EAAyB,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAA,CAAE,CAC1J,CAAC;AACF,QAAA,OAAO,KAAK,CAAC;KACd;AACF,CAAA;AAED,SAAS,WAAW,CAAC,WAAmB,EAAA;IACtC,MAAM,gBAAgB,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAChD,IAAA,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE;AACjC,QAAA,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAC;AACzF,KAAA;AACD,IAAA,IAAI,gBAAgB,CAAC,CAAC,CAAC,KAAK,YAAY,EAAE;AACxC,QAAA,MAAM,IAAI,KAAK,CACb,CAAA,yBAAA,EAA4B,gBAAgB,CAAC,CAAC,CAAC,CAAmE,gEAAA,EAAA,YAAY,CAAQ,MAAA,CAAA,CACvI,CAAC;AACH,KAAA;AACD,IAAA,OAAO,gBAAgB,CAAC,CAAC,CAAC,CAAC;AAC7B,CAAC;AAED,SAAS,cAAc,CACrB,OAAiB,EACjB,OAAkC,EAAA;IAElC,MAAM,eAAe,GAAG,OAAO,KAAA,IAAA,IAAP,OAAO,KAAP,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,OAAO,CAAE,OAAO,CAAC;AACzC,IAAA,IAAI,eAAe,EAAE;AACnB,QAAA,OAAO,eAAe,CAAC,OAAO,CAAC,CAAC;AACjC,KAAA;AAAM,SAAA,IAAI,gBAAgB,CAAC,OAAO,CAAC,EAAE;AACpC,QAAA,OAAO,OAAO,CAAC;AAChB,KAAA;AAAM,SAAA;AACL,QAAA,MAAM,IAAI,KAAK,CACb,CAAA,2HAAA,CAA6H,CAC9H,CAAC;AACH,KAAA;AACH,CAAC;AAED,SAAS,aAAa,CAAC,MAAoB,EAAA;IACzC,MAAM,EAAE,GAAG,MAAM,CAAC,GAAG,IAAI,MAAM,CAAC,EAAE,CAAC;IACnC,IAAI,CAAC,EAAE,EAAE;AACP,QAAA,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;AAC5C,KAAA;AACD,IAAA,OAAO,EAAE,CAAC;AACZ;;;;"}

package/dist-esm/src/errors.js

@@ -0,0 +1,23 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/** @internal */
+export function wrapError(f, message) {
+    let result;
+    try {
+        result = f();
+    }
+    catch (cause) {
+        throw errorWithCause(message, cause);
+    }
+    return result;
+}
+/** @internal */
+export function errorWithCause(message, cause) {
+    return new Error(message, 
+    // TS v4.6 and below do not yet recognize the cause option in the Error constructor
+    // see https://medium.com/ovrsea/power-up-your-node-js-debugging-and-error-handling-with-the-new-error-cause-feature-4136c563126a
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    { cause });
+}
+//# sourceMappingURL=errors.js.map

package/dist-esm/src/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,gBAAgB;AAChB,MAAM,UAAU,SAAS,CAAI,CAAU,EAAE,OAAe;IACtD,IAAI,MAAS,CAAC;IACd,IAAI;QACF,MAAM,GAAG,CAAC,EAAE,CAAC;KACd;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,cAAc,CAAC,OAAO,EAAE,KAAc,CAAC,CAAC;KAC/C;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,cAAc,CAAC,OAAe,EAAE,KAAY;IAC1D,OAAO,IAAI,KAAK,CACd,OAAO;IACP,mFAAmF;IACnF,iIAAiI;IACjI,6DAA6D;IAC7D,aAAa;IACb,EAAE,KAAK,EAAE,CACV,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/** @internal */\nexport function wrapError<T>(f: () => T, message: string): T {\n  let result: T;\n  try {\n    result = f();\n  } catch (cause) {\n    throw errorWithCause(message, cause as Error);\n  }\n  return result;\n}\n\n/** @internal */\nexport function errorWithCause(message: string, cause: Error): Error {\n  return new Error(\n    message,\n    // TS v4.6 and below do not yet recognize the cause option in the Error constructor\n    // see https://medium.com/ovrsea/power-up-your-node-js-debugging-and-error-handling-with-the-new-error-cause-feature-4136c563126a\n    // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n    // @ts-ignore\n    { cause }\n  );\n}\n"]}

package/dist-esm/src/index.js

@@ -0,0 +1,5 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+export { JsonSerializer } from "./jsonSerializer";
+export * from "./models";
+//# sourceMappingURL=index.js.map

package/dist-esm/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,cAAc,UAAU,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nexport { JsonSerializer } from \"./jsonSerializer\";\n\nexport * from \"./models\";\n"]}

package/dist-esm/src/jsonSerializer.js

@@ -0,0 +1,173 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+import { KnownSchemaFormats } from "@azure/schema-registry";
+import { isMessageContent } from "./utility";
+import { errorWithCause, wrapError } from "./errors";
+import LRUCache from "lru-cache";
+import { logger } from "./logger";
+const jsonMimeType = "application/json";
+const encoder = new TextEncoder();
+const decoder = new TextDecoder();
+function getSchemaObject(schema) {
+    return wrapError(() => JSON.parse(schema), `Parsing Json schema failed:\n\n\t${schema}\n\nSee 'cause' for more details.`);
+}
+const cacheOptions = {
+    max: 128,
+    /**
+     * This is needed in order to specify `sizeCalculation` but we do not intend
+     * to limit the size just yet.
+     */
+    maxSize: Number.MAX_VALUE,
+    sizeCalculation: (_value, key) => {
+        return key.length;
+    },
+};
+/**
+ * Json serializer that obtains schemas from a schema registry and does not
+ * pack schemas into its payloads.
+ */
+export class JsonSerializer {
+    /**
+     * Creates a new serializer.
+     *
+     * @param client - Schema Registry where schemas are registered and obtained.
+     *                 Usually this is a SchemaRegistryClient instance.
+     */
+    constructor(client, options) {
+        this.cacheIdByDefinition = new LRUCache(cacheOptions);
+        this.cacheById = new LRUCache(cacheOptions);
+        this.registry = client;
+        this.schemaGroup = options === null || options === void 0 ? void 0 : options.groupName;
+        this.messageAdapter = options === null || options === void 0 ? void 0 : options.messageAdapter;
+    }
+    /**
+     * serializes the value parameter according to the input schema and creates a message
+     * with the serialized data.
+     *
+     * @param value - The value to serialize.
+     * @param schema - The Json schema to use.
+     * @returns A new message with the serialized value. The structure of message is
+     * constrolled by the message factory option.
+     * @throws {@link Error}
+     * Thrown if the schema can not be parsed or the value does not match the schema.
+     */
+    async serialize(value, schema) {
+        const entry = await this.getSchemaByDefinition(schema);
+        const data = wrapError(() => encoder.encode(JSON.stringify(value)), `Json serialization failed. See 'cause' for more details. Schema ID: ${entry.id}`);
+        const contentType = `${jsonMimeType}+${entry.id}`;
+        return this.messageAdapter
+            ? this.messageAdapter.produce({
+                contentType,
+                data,
+            })
+            : /**
+               * If no message consumer was provided, then a MessageContent will be
+               * returned. This should work because the MessageT type parameter defaults
+               * to MessageContent.
+               */
+                {
+                    data,
+                    contentType,
+                };
+    }
+    /**
+     * Deserializes the payload of the message using the schema ID in the content type
+     * field if no schema was provided.
+     *
+     * @param message - The message with the payload to be deserialized.
+     * @returns The deserialized value.
+     * @throws {@link Error}
+     * Thrown if the deserialization failed, e.g. because reader and writer schemas are incompatible.
+     */
+    async deserialize(message, options) {
+        const { data, contentType } = convertMessage(message, this.messageAdapter);
+        const schemaId = getSchemaId(contentType);
+        const schema = await this.getSchemaById(schemaId);
+        const returnedMessage = wrapError(() => JSON.parse(decoder.decode(data)), `Json deserialization failed with schema ID (${schemaId}). See 'cause' for more details.`);
+        const validate = options === null || options === void 0 ? void 0 : options.validateCallback;
+        if (validate) {
+            wrapError(() => validate(returnedMessage, schema), `Json validation failed. See 'cause' for more details. Schema ID: ${schemaId}`);
+        }
+        return returnedMessage;
+    }
+    async getSchemaById(schemaId) {
+        const cached = this.cacheById.get(schemaId);
+        if (cached) {
+            return cached;
+        }
+        const schemaResponse = await this.registry.getSchema(schemaId);
+        if (!schemaResponse) {
+            throw new Error(`Schema with ID '${schemaId}' not found.`);
+        }
+        if (!schemaResponse.properties.format.match(/^json$/i)) {
+            throw new Error(`Schema with ID '${schemaResponse.properties.id}' has format '${schemaResponse.properties.format}', not 'json'.`);
+        }
+        return this.cache(schemaResponse.definition, schemaId).schema;
+    }
+    async getSchemaByDefinition(definition) {
+        const schemaId = this.cacheIdByDefinition.get(definition);
+        if (schemaId) {
+            return { id: schemaId, schema: definition };
+        }
+        if (!this.schemaGroup) {
+            throw new Error("Schema group must have been specified in the constructor options when the client was created in order to serialize.");
+        }
+        const schemaObj = getSchemaObject(definition);
+        const description = {
+            groupName: this.schemaGroup,
+            name: getSchemaName(schemaObj),
+            format: KnownSchemaFormats.Json,
+            definition,
+        };
+        let id;
+        try {
+            id = (await this.registry.getSchemaProperties(description)).id;
+        }
+        catch (e) {
+            if (e.statusCode === 404) {
+                throw errorWithCause(`Schema '${description.name}' not found in registry group '${description.groupName}', or not found to have matching definition.`, e);
+            }
+            else {
+                throw e;
+            }
+        }
+        return this.cache(definition, id);
+    }
+    cache(schema, id) {
+        const entry = { schema, id };
+        this.cacheIdByDefinition.set(schema, id);
+        this.cacheById.set(id, schema);
+        logger.verbose(`Cache entry added or updated. Total number of entries: ${this.cacheIdByDefinition.size}; Total schema length ${this.cacheIdByDefinition.calculatedSize}`);
+        return entry;
+    }
+}
+function getSchemaId(contentType) {
+    const contentTypeParts = contentType.split("+");
+    if (contentTypeParts.length !== 2) {
+        throw new Error("Content type was not in the expected format of MIME type + schema ID");
+    }
+    if (contentTypeParts[0] !== jsonMimeType) {
+        throw new Error(`Received content of type ${contentTypeParts[0]} but an json serializer may only be used on content that is of '${jsonMimeType}' type`);
+    }
+    return contentTypeParts[1];
+}
+function convertMessage(message, adapter) {
+    const messageConsumer = adapter === null || adapter === void 0 ? void 0 : adapter.consume;
+    if (messageConsumer) {
+        return messageConsumer(message);
+    }
+    else if (isMessageContent(message)) {
+        return message;
+    }
+    else {
+        throw new Error(`Expected either a message adapter to be provided to the serializer or the input message to have data and contentType fields`);
+    }
+}
+function getSchemaName(schema) {
+    const id = schema.$id || schema.id;
+    if (!id) {
+        throw new Error("Schema must have an ID.");
+    }
+    return id;
+}
+//# sourceMappingURL=jsonSerializer.js.map

package/dist-esm/src/jsonSerializer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonSerializer.js","sourceRoot":"","sources":["../../src/jsonSerializer.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAQlC,OAAO,EAAE,kBAAkB,EAAqC,MAAM,wBAAwB,CAAC;AAC/F,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrD,OAAO,QAAQ,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,MAAM,YAAY,GAAG,kBAAkB,CAAC;AACxC,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;AAClC,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;AAalC,SAAS,eAAe,CAAC,MAAc;IACrC,OAAO,SAAS,CACd,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EACxB,oCAAoC,MAAM,mCAAmC,CAC9E,CAAC;AACJ,CAAC;AAED,MAAM,YAAY,GAAiC;IACjD,GAAG,EAAE,GAAG;IACR;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC,SAAS;IACzB,eAAe,EAAE,CAAC,MAAW,EAAE,GAAW,EAAE,EAAE;QAC5C,OAAO,GAAG,CAAC,MAAM,CAAC;IACpB,CAAC;CACF,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,cAAc;IACzB;;;;;OAKG;IACH,YAAY,MAAsB,EAAE,OAAyC;QAS5D,wBAAmB,GAAG,IAAI,QAAQ,CAAiB,YAAY,CAAC,CAAC;QACjE,cAAS,GAAG,IAAI,QAAQ,CAAiB,YAAY,CAAC,CAAC;QATtE,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC;QACvB,IAAI,CAAC,WAAW,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,CAAC;QACtC,IAAI,CAAC,cAAc,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,CAAC;IAChD,CAAC;IAQD;;;;;;;;;;OAUG;IACH,KAAK,CAAC,SAAS,CAAC,KAAc,EAAE,MAAc;QAC5C,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;QACvD,MAAM,IAAI,GAAG,SAAS,CACpB,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAC3C,uEAAuE,KAAK,CAAC,EAAE,EAAE,CAClF,CAAC;QACF,MAAM,WAAW,GAAG,GAAG,YAAY,IAAI,KAAK,CAAC,EAAE,EAAE,CAAC;QAClD,OAAO,IAAI,CAAC,cAAc;YACxB,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;gBAC1B,WAAW;gBACX,IAAI;aACL,CAAC;YACJ,CAAC,CAAC;;;;iBAIG;gBACF;oBACC,IAAI;oBACJ,WAAW;iBAC8B,CAAC;IAClD,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,WAAW,CAAC,OAAiB,EAAE,OAA4B;QAC/D,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAC3E,MAAM,QAAQ,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAClD,MAAM,eAAe,GAAG,SAAS,CAC/B,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EACtC,+CAA+C,QAAQ,kCAAkC,CAC1F,CAAC;QACF,MAAM,QAAQ,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,gBAAgB,CAAC;QAC3C,IAAI,QAAQ,EAAE;YACZ,SAAS,CACP,GAAG,EAAE,CAAC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC,EACvC,oEAAoE,QAAQ,EAAE,CAC/E,CAAC;SACH;QACD,OAAO,eAAe,CAAC;IACzB,CAAC;IAEO,KAAK,CAAC,aAAa,CAAC,QAAgB;QAC1C,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC5C,IAAI,MAAM,EAAE;YACV,OAAO,MAAM,CAAC;SACf;QACD,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC/D,IAAI,CAAC,cAAc,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,mBAAmB,QAAQ,cAAc,CAAC,CAAC;SAC5D;QAED,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE;YACtD,MAAM,IAAI,KAAK,CACb,mBAAmB,cAAc,CAAC,UAAU,CAAC,EAAE,iBAAiB,cAAc,CAAC,UAAU,CAAC,MAAM,gBAAgB,CACjH,CAAC;SACH;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC;IAChE,CAAC;IAEO,KAAK,CAAC,qBAAqB,CAAC,UAAkB;QACpD,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC1D,IAAI,QAAQ,EAAE;YACZ,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;SAC7C;QACD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YACrB,MAAM,IAAI,KAAK,CACb,qHAAqH,CACtH,CAAC;SACH;QACD,MAAM,SAAS,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC;QAC9C,MAAM,WAAW,GAAsB;YACrC,SAAS,EAAE,IAAI,CAAC,WAAW;YAC3B,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC;YAC9B,MAAM,EAAE,kBAAkB,CAAC,IAAI;YAC/B,UAAU;SACX,CAAC;QACF,IAAI,EAAU,CAAC;QAEf,IAAI;YACF,EAAE,GAAG,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC;SAChE;QAAC,OAAO,CAAC,EAAE;YACV,IAAK,CAAS,CAAC,UAAU,KAAK,GAAG,EAAE;gBACjC,MAAM,cAAc,CAClB,WAAW,WAAW,CAAC,IAAI,kCAAkC,WAAW,CAAC,SAAS,8CAA8C,EAChI,CAAU,CACX,CAAC;aACH;iBAAM;gBACL,MAAM,CAAC,CAAC;aACT;SACF;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IACpC,CAAC;IAEO,KAAK,CAAC,MAAc,EAAE,EAAU;QACtC,MAAM,KAAK,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QAC7B,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACzC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAC/B,MAAM,CAAC,OAAO,CACZ,0DAA0D,IAAI,CAAC,mBAAmB,CAAC,IAAI,yBAAyB,IAAI,CAAC,mBAAmB,CAAC,cAAc,EAAE,CAC1J,CAAC;QACF,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAED,SAAS,WAAW,CAAC,WAAmB;IACtC,MAAM,gBAAgB,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAChD,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAC;KACzF;IACD,IAAI,gBAAgB,CAAC,CAAC,CAAC,KAAK,YAAY,EAAE;QACxC,MAAM,IAAI,KAAK,CACb,4BAA4B,gBAAgB,CAAC,CAAC,CAAC,mEAAmE,YAAY,QAAQ,CACvI,CAAC;KACH;IACD,OAAO,gBAAgB,CAAC,CAAC,CAAC,CAAC;AAC7B,CAAC;AAED,SAAS,cAAc,CACrB,OAAiB,EACjB,OAAkC;IAElC,MAAM,eAAe,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,CAAC;IACzC,IAAI,eAAe,EAAE;QACnB,OAAO,eAAe,CAAC,OAAO,CAAC,CAAC;KACjC;SAAM,IAAI,gBAAgB,CAAC,OAAO,CAAC,EAAE;QACpC,OAAO,OAAO,CAAC;KAChB;SAAM;QACL,MAAM,IAAI,KAAK,CACb,6HAA6H,CAC9H,CAAC;KACH;AACH,CAAC;AAED,SAAS,aAAa,CAAC,MAAoB;IACzC,MAAM,EAAE,GAAG,MAAM,CAAC,GAAG,IAAI,MAAM,CAAC,EAAE,CAAC;IACnC,IAAI,CAAC,EAAE,EAAE;QACP,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;KAC5C;IACD,OAAO,EAAE,CAAC;AACZ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport {\n  DeserializeOptions,\n  JsonSerializerOptions,\n  MessageAdapter,\n  MessageContent,\n} from \"./models\";\nimport { KnownSchemaFormats, SchemaDescription, SchemaRegistry } from \"@azure/schema-registry\";\nimport { isMessageContent } from \"./utility\";\nimport { errorWithCause, wrapError } from \"./errors\";\nimport LRUCache from \"lru-cache\";\nimport LRUCacheOptions = LRUCache.Options;\nimport { logger } from \"./logger\";\n\nconst jsonMimeType = \"application/json\";\nconst encoder = new TextEncoder();\nconst decoder = new TextDecoder();\n\ninterface CacheEntry {\n  /** Schema ID */\n  id: string;\n  /** Schema string */\n  schema: string;\n}\ninterface SchemaObject {\n  id?: string;\n  $id?: string;\n  $schema?: string;\n}\nfunction getSchemaObject(schema: string): SchemaObject {\n  return wrapError(\n    () => JSON.parse(schema),\n    `Parsing Json schema failed:\\n\\n\\t${schema}\\n\\nSee 'cause' for more details.`\n  );\n}\n\nconst cacheOptions: LRUCacheOptions<string, any> = {\n  max: 128,\n  /**\n   * This is needed in order to specify `sizeCalculation` but we do not intend\n   * to limit the size just yet.\n   */\n  maxSize: Number.MAX_VALUE,\n  sizeCalculation: (_value: any, key: string) => {\n    return key.length;\n  },\n};\n\n/**\n * Json serializer that obtains schemas from a schema registry and does not\n * pack schemas into its payloads.\n */\nexport class JsonSerializer<MessageT = MessageContent> {\n  /**\n   * Creates a new serializer.\n   *\n   * @param client - Schema Registry where schemas are registered and obtained.\n   *                 Usually this is a SchemaRegistryClient instance.\n   */\n  constructor(client: SchemaRegistry, options?: JsonSerializerOptions<MessageT>) {\n    this.registry = client;\n    this.schemaGroup = options?.groupName;\n    this.messageAdapter = options?.messageAdapter;\n  }\n\n  private readonly schemaGroup?: string;\n  private readonly registry: SchemaRegistry;\n  private readonly messageAdapter?: MessageAdapter<MessageT>;\n  private readonly cacheIdByDefinition = new LRUCache<string, string>(cacheOptions);\n  private readonly cacheById = new LRUCache<string, string>(cacheOptions);\n\n  /**\n   * serializes the value parameter according to the input schema and creates a message\n   * with the serialized data.\n   *\n   * @param value - The value to serialize.\n   * @param schema - The Json schema to use.\n   * @returns A new message with the serialized value. The structure of message is\n   * constrolled by the message factory option.\n   * @throws {@link Error}\n   * Thrown if the schema can not be parsed or the value does not match the schema.\n   */\n  async serialize(value: unknown, schema: string): Promise<MessageT> {\n    const entry = await this.getSchemaByDefinition(schema);\n    const data = wrapError(\n      () => encoder.encode(JSON.stringify(value)),\n      `Json serialization failed. See 'cause' for more details. Schema ID: ${entry.id}`\n    );\n    const contentType = `${jsonMimeType}+${entry.id}`;\n    return this.messageAdapter\n      ? this.messageAdapter.produce({\n          contentType,\n          data,\n        })\n      : /**\n         * If no message consumer was provided, then a MessageContent will be\n         * returned. This should work because the MessageT type parameter defaults\n         * to MessageContent.\n         */\n        ({\n          data,\n          contentType,\n        } as MessageContent as unknown as MessageT);\n  }\n\n  /**\n   * Deserializes the payload of the message using the schema ID in the content type\n   * field if no schema was provided.\n   *\n   * @param message - The message with the payload to be deserialized.\n   * @returns The deserialized value.\n   * @throws {@link Error}\n   * Thrown if the deserialization failed, e.g. because reader and writer schemas are incompatible.\n   */\n  async deserialize(message: MessageT, options?: DeserializeOptions): Promise<unknown> {\n    const { data, contentType } = convertMessage(message, this.messageAdapter);\n    const schemaId = getSchemaId(contentType);\n    const schema = await this.getSchemaById(schemaId);\n    const returnedMessage = wrapError(\n      () => JSON.parse(decoder.decode(data)),\n      `Json deserialization failed with schema ID (${schemaId}). See 'cause' for more details.`\n    );\n    const validate = options?.validateCallback;\n    if (validate) {\n      wrapError(\n        () => validate(returnedMessage, schema),\n        `Json validation failed. See 'cause' for more details. Schema ID: ${schemaId}`\n      );\n    }\n    return returnedMessage;\n  }\n\n  private async getSchemaById(schemaId: string): Promise<string> {\n    const cached = this.cacheById.get(schemaId);\n    if (cached) {\n      return cached;\n    }\n    const schemaResponse = await this.registry.getSchema(schemaId);\n    if (!schemaResponse) {\n      throw new Error(`Schema with ID '${schemaId}' not found.`);\n    }\n\n    if (!schemaResponse.properties.format.match(/^json$/i)) {\n      throw new Error(\n        `Schema with ID '${schemaResponse.properties.id}' has format '${schemaResponse.properties.format}', not 'json'.`\n      );\n    }\n    return this.cache(schemaResponse.definition, schemaId).schema;\n  }\n\n  private async getSchemaByDefinition(definition: string): Promise<CacheEntry> {\n    const schemaId = this.cacheIdByDefinition.get(definition);\n    if (schemaId) {\n      return { id: schemaId, schema: definition };\n    }\n    if (!this.schemaGroup) {\n      throw new Error(\n        \"Schema group must have been specified in the constructor options when the client was created in order to serialize.\"\n      );\n    }\n    const schemaObj = getSchemaObject(definition);\n    const description: SchemaDescription = {\n      groupName: this.schemaGroup,\n      name: getSchemaName(schemaObj),\n      format: KnownSchemaFormats.Json,\n      definition,\n    };\n    let id: string;\n\n    try {\n      id = (await this.registry.getSchemaProperties(description)).id;\n    } catch (e) {\n      if ((e as any).statusCode === 404) {\n        throw errorWithCause(\n          `Schema '${description.name}' not found in registry group '${description.groupName}', or not found to have matching definition.`,\n          e as Error\n        );\n      } else {\n        throw e;\n      }\n    }\n\n    return this.cache(definition, id);\n  }\n\n  private cache(schema: string, id: string): CacheEntry {\n    const entry = { schema, id };\n    this.cacheIdByDefinition.set(schema, id);\n    this.cacheById.set(id, schema);\n    logger.verbose(\n      `Cache entry added or updated. Total number of entries: ${this.cacheIdByDefinition.size}; Total schema length ${this.cacheIdByDefinition.calculatedSize}`\n    );\n    return entry;\n  }\n}\n\nfunction getSchemaId(contentType: string): string {\n  const contentTypeParts = contentType.split(\"+\");\n  if (contentTypeParts.length !== 2) {\n    throw new Error(\"Content type was not in the expected format of MIME type + schema ID\");\n  }\n  if (contentTypeParts[0] !== jsonMimeType) {\n    throw new Error(\n      `Received content of type ${contentTypeParts[0]} but an json serializer may only be used on content that is of '${jsonMimeType}' type`\n    );\n  }\n  return contentTypeParts[1];\n}\n\nfunction convertMessage<MessageT>(\n  message: MessageT,\n  adapter?: MessageAdapter<MessageT>\n): MessageContent {\n  const messageConsumer = adapter?.consume;\n  if (messageConsumer) {\n    return messageConsumer(message);\n  } else if (isMessageContent(message)) {\n    return message;\n  } else {\n    throw new Error(\n      `Expected either a message adapter to be provided to the serializer or the input message to have data and contentType fields`\n    );\n  }\n}\n\nfunction getSchemaName(schema: SchemaObject): string {\n  const id = schema.$id || schema.id;\n  if (!id) {\n    throw new Error(\"Schema must have an ID.\");\n  }\n  return id;\n}\n"]}

package/dist-esm/src/logger.js

@@ -0,0 +1,8 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+import { createClientLogger } from "@azure/logger";
+/**
+ * The \@azure/logger configuration for the schema-registry-json package.
+ */
+export const logger = createClientLogger("schema-registry-json");
+//# sourceMappingURL=logger.js.map

package/dist-esm/src/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAEnD;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,kBAAkB,CAAC,sBAAsB,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { createClientLogger } from \"@azure/logger\";\n\n/**\n * The \\@azure/logger configuration for the schema-registry-json package.\n */\nexport const logger = createClientLogger(\"schema-registry-json\");\n"]}

package/dist-esm/src/models.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+export {};
+//# sourceMappingURL=models.js.map

package/dist-esm/src/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * A message that contains binary data and a content type.\n */\nexport interface MessageContent {\n  /**\n   * The message's binary data\n   */\n  data: Uint8Array;\n  /**\n   * The message's content type\n   */\n  contentType: string;\n}\n\n/**\n * MessageAdapter is an interface that converts to/from a concrete message type\n * to a MessageContent\n */\nexport interface MessageAdapter<MessageT> {\n  /**\n   * defines how to create a message from a payload and a content type\n   */\n  produce: (messageContent: MessageContent) => MessageT;\n  /**\n   * defines how to access the payload and the content type of a message\n   */\n  consume: (message: MessageT) => MessageContent;\n}\n\n/**\n * Options for Schema\n */\nexport interface JsonSerializerOptions<MessageT> {\n  /**\n   * The group name to be used when registering/looking up a schema. Must be specified\n   * if `serialize` will be called.\n   */\n  groupName?: string;\n  /**\n   * Message Adapter enables the serializer to produce and consume custom messages.\n   */\n  messageAdapter?: MessageAdapter<MessageT>;\n}\n\n/**\n * The options to the deserialize method.\n */\nexport interface DeserializeOptions {\n  /**\n   * Validate the value against the schema. Raise an error if the validation is not successful.\n   */\n  validateCallback?: (value: unknown, schema: string) => void;\n}\n"]}

package/dist-esm/src/utility.js

@@ -0,0 +1,7 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+export function isMessageContent(message) {
+    const castMessage = message;
+    return castMessage.data !== undefined && castMessage.contentType !== undefined;
+}
+//# sourceMappingURL=utility.js.map

package/dist-esm/src/utility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utility.js","sourceRoot":"","sources":["../../src/utility.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAIlC,MAAM,UAAU,gBAAgB,CAAC,OAAgB;IAC/C,MAAM,WAAW,GAAG,OAAyB,CAAC;IAC9C,OAAO,WAAW,CAAC,IAAI,KAAK,SAAS,IAAI,WAAW,CAAC,WAAW,KAAK,SAAS,CAAC;AACjF,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { MessageContent } from \"./models\";\n\nexport function isMessageContent(message: unknown): message is MessageContent {\n  const castMessage = message as MessageContent;\n  return castMessage.data !== undefined && castMessage.contentType !== undefined;\n}\n"]}

package/package.json

@@ -0,0 +1,115 @@
+{
+  "name": "@azure/schema-registry-json",
+  "version": "1.0.0-alpha.20230809.1",
+  "description": "Schema Registry JSON Serializer Library with typescript type definitions for node.js and browser.",
+  "sdk-type": "client",
+  "main": "dist/index.js",
+  "module": "dist-esm/src/index.js",
+  "types": "types/schema-registry-json.d.ts",
+  "scripts": {
+    "audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit",
+    "build:browser": "tsc -p . && rollup -c rollup.test.config.js 2>&1",
+    "build:node": "tsc -p . && dev-tool run bundle --browser-test=false",
+    "build:samples": "echo Obsolete.",
+    "build:test": "tsc -p . && rollup -c rollup.test.config.js 2>&1",
+    "build": "npm run clean && tsc -p . && dev-tool run bundle && api-extractor run --local",
+    "check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
+    "clean": "rimraf dist dist-* temp types *.tgz *.log",
+    "execute:samples": "dev-tool samples run samples-dev",
+    "extract-api": "tsc -p . && api-extractor run --local",
+    "format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
+    "integration-test:browser": "dev-tool run test:browser",
+    "integration-test:node": "dev-tool run test:node-js-input -- --timeout 5000000 'dist-esm/test/**/*.spec.js'",
+    "integration-test": "npm run integration-test:node && npm run integration-test:browser",
+    "lint:fix": "eslint package.json api-extractor.json README.md src test --ext .ts,.javascript,.js --fix --fix-type [problem,suggestion]",
+    "lint": "eslint package.json api-extractor.json README.md src test --ext .ts,.javascript,.js",
+    "pack": "npm pack 2>&1",
+    "test:browser": "npm run build:test && npm run unit-test:browser && npm run integration-test:browser",
+    "test:node": "npm run build:test && npm run unit-test:node && npm run integration-test:node",
+    "test": "npm run build:test && npm run unit-test && npm run integration-test",
+    "unit-test:browser": "dev-tool run test:browser",
+    "unit-test:node": "dev-tool run test:node-ts-input -- --timeout 1200000 \"test/{,!(browser)/**/}*.spec.ts\"",
+    "unit-test": "npm run unit-test:node && npm run unit-test:browser"
+  },
+  "files": [
+    "dist/",
+    "dist-esm/src/",
+    "types/schema-registry-json.d.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "repository": "github:Azure/azure-sdk-for-js",
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "keywords": [
+    "azure",
+    "cloud",
+    "typescript"
+  ],
+  "author": "Microsoft Corporation",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Azure/azure-sdk-for-js/issues"
+  },
+  "homepage": "https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/schemaregistry/schema-registry-json/",
+  "sideEffects": false,
+  "prettier": "@azure/eslint-plugin-azure-sdk/prettier.json",
+  "//sampleConfiguration": {
+    "disableDocsMs": true,
+    "productName": "Azure Schema Registry",
+    "productSlugs": [
+      "azure",
+      "azure-schema-registry-json"
+    ],
+    "requiredResources": {
+      "Azure Schema Registry resource": "https://aka.ms/schemaregistry"
+    }
+  },
+  "dependencies": {
+    "@azure/logger": "^1.0.0",
+    "@azure/schema-registry": "1.3.0-beta.1",
+    "lru-cache": "^7.4.1",
+    "tslib": "^2.2.0"
+  },
+  "devDependencies": {
+    "@azure/core-util": "^1.3.0",
+    "@azure/dev-tool": ">=1.0.0-alpha <1.0.0-alphb",
+    "@azure/eslint-plugin-azure-sdk": ">=3.0.0-alpha <3.0.0-alphb",
+    "@azure/event-hubs": "^5.8.0",
+    "@azure/identity": "^2.0.1",
+    "@azure/test-utils": ">=1.0.0-alpha <1.0.0-alphb",
+    "@azure-tools/test-credential": "^1.0.0",
+    "@azure-tools/test-recorder": "^3.0.0",
+    "@microsoft/api-extractor": "^7.31.1",
+    "@rollup/plugin-commonjs": "^24.0.0",
+    "@rollup/plugin-inject": "^5.0.0",
+    "@types/ajv": "^1.0.0",
+    "@types/mocha": "^7.0.2",
+    "@types/node": "^16.0.0",
+    "ajv": "^8.12.0",
+    "cross-env": "^7.0.2",
+    "dotenv": "^16.0.0",
+    "eslint": "^8.0.0",
+    "karma": "^6.2.0",
+    "karma-chrome-launcher": "^3.0.0",
+    "karma-coverage": "^2.0.0",
+    "karma-env-preprocessor": "^0.1.1",
+    "karma-firefox-launcher": "^1.1.0",
+    "karma-json-preprocessor": "^0.3.3",
+    "karma-json-to-file-reporter": "^1.0.1",
+    "karma-junit-reporter": "^2.0.1",
+    "karma-mocha": "^2.0.1",
+    "karma-mocha-reporter": "^2.2.5",
+    "karma-sourcemap-loader": "^0.3.8",
+    "karma-source-map-support": "~1.4.0",
+    "mocha": "^7.1.1",
+    "mocha-junit-reporter": "^2.0.0",
+    "nyc": "^15.0.0",
+    "prettier": "^2.5.1",
+    "rimraf": "^3.0.0",
+    "rollup": "^2.0.0",
+    "source-map-support": "^0.5.9",
+    "typescript": "~5.0.0"
+  }
+}

package/types/schema-registry-json.d.ts

@@ -0,0 +1,101 @@
+import { SchemaRegistry } from '@azure/schema-registry';
+
+/**
+ * The options to the deserialize method.
+ */
+export declare interface DeserializeOptions {
+    /**
+     * Validate the value against the schema. Raise an error if the validation is not successful.
+     */
+    validateCallback?: (value: unknown, schema: string) => void;
+}
+
+/**
+ * Json serializer that obtains schemas from a schema registry and does not
+ * pack schemas into its payloads.
+ */
+export declare class JsonSerializer<MessageT = MessageContent> {
+    /**
+     * Creates a new serializer.
+     *
+     * @param client - Schema Registry where schemas are registered and obtained.
+     *                 Usually this is a SchemaRegistryClient instance.
+     */
+    constructor(client: SchemaRegistry, options?: JsonSerializerOptions<MessageT>);
+    private readonly schemaGroup?;
+    private readonly registry;
+    private readonly messageAdapter?;
+    private readonly cacheIdByDefinition;
+    private readonly cacheById;
+    /**
+     * serializes the value parameter according to the input schema and creates a message
+     * with the serialized data.
+     *
+     * @param value - The value to serialize.
+     * @param schema - The Json schema to use.
+     * @returns A new message with the serialized value. The structure of message is
+     * constrolled by the message factory option.
+     * @throws {@link Error}
+         * Thrown if the schema can not be parsed or the value does not match the schema.
+         */
+     serialize(value: unknown, schema: string): Promise<MessageT>;
+     /**
+      * Deserializes the payload of the message using the schema ID in the content type
+      * field if no schema was provided.
+      *
+      * @param message - The message with the payload to be deserialized.
+      * @returns The deserialized value.
+      * @throws {@link Error}
+          * Thrown if the deserialization failed, e.g. because reader and writer schemas are incompatible.
+          */
+      deserialize(message: MessageT, options?: DeserializeOptions): Promise<unknown>;
+      private getSchemaById;
+      private getSchemaByDefinition;
+      private cache;
+     }
+
+     /**
+      * Options for Schema
+      */
+     export declare interface JsonSerializerOptions<MessageT> {
+         /**
+          * The group name to be used when registering/looking up a schema. Must be specified
+          * if `serialize` will be called.
+          */
+         groupName?: string;
+         /**
+          * Message Adapter enables the serializer to produce and consume custom messages.
+          */
+         messageAdapter?: MessageAdapter<MessageT>;
+     }
+
+     /**
+      * MessageAdapter is an interface that converts to/from a concrete message type
+      * to a MessageContent
+      */
+     export declare interface MessageAdapter<MessageT> {
+         /**
+          * defines how to create a message from a payload and a content type
+          */
+         produce: (messageContent: MessageContent) => MessageT;
+         /**
+          * defines how to access the payload and the content type of a message
+          */
+         consume: (message: MessageT) => MessageContent;
+     }
+
+     /**
+      * A message that contains binary data and a content type.
+      */
+     export declare interface MessageContent {
+         /**
+          * The message's binary data
+          */
+         data: Uint8Array;
+         /**
+          * The message's content type
+          */
+         contentType: string;
+     }
+
+     export { }