Shared Objects Parent Package Readme

The shared-objects parent package provides a centralized space for creating and sharing standardized objects, particularly those that require schema validation and deserialization from JSON-like structures. This readme provides an overview of the purpose of the package, its components, and how developers can leverage it to ensure consistent data structures across various projects and repositories.

Table of Contents

• Introduction
• Packages
• Usage
  • Installation
  • Creating Shared Objects
  • Schema Validation and Deserialization
• Contributing
• License

Introduction

The shared-objects package serves as a hub for creating and sharing standardized object types across multiple code bases, repositories, and projects. Its primary purpose is to provide a cohesive and organized approach to managing objects that need to be de-serialized from JSON-like structures and subsequently validated against predefined schemas. One of the core objects provided by the package is the NormalizedSubscription interface, which exemplifies the schema validation and deserialization process.

Packages

The shared-objects parent package consists of two major sub-packages, each serving a specific purpose:

1. @nesn/commons-shared-objects-normalized-subscription: This package defines the NormalizedSubscription TypeScript interface and its corresponding JSONSchema. It acts as a model for creating other shared objects that require similar schema validation and deserialization processes.

2. @nesn/commons-shared-objects-schema-validator: This package offers a validation utility based on the Ajv library. It enables developers to validate data against defined JSON schemas, providing a consistent and reliable way to ensure data integrity across projects.

Usage

Installation

To use the shared object packages in your projects, you can install them via npm:

npm install @nesn/commons-shared-objects-normalized-subscription
npm install @nesn/commons-shared-objects-schema-validator

Creating Shared Objects

The shared-objects package encourages the creation of standardized object types that require schema validation and deserialization. These objects serve as templates for maintaining consistent data structures. The NormalizedSubscription interface is a prime example of such an object type, but developers are welcome to create additional shared objects as needed.

Schema Validation and Deserialization

The @nesn/commons-shared-objects-schema-validator package provides the validateObjectAgainstSchema utility, which enables developers to validate data against predefined JSON schemas. This utility is particularly useful when working with objects like the NormalizedSubscription interface, ensuring that data adheres to specified schemas.

Contributing

Contributions to the shared-objects parent package are encouraged and appreciated. Whether it's adding new shared object types, improving schema validation utilities, or enhancing the documentation, your contributions will help maintain the consistency and quality of shared objects across different projects.

License

The shared-objects parent package and its sub-packages are released under the MIT License. You can find the full license text in the respective package.json files.