arvo-core 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -3,3 +3,8 @@
 ## [1.0.0] - 2024-08-31
 
 - Finalised the first release version of the core. This contains core class such as ArvoEvent, ArvoContract, and ArvoContractLibrary. Moreover, this release contains utility functions for string manipulation, validation and OpenTelemetry
+
+## [1.0.2] - 2024-08-31
+
+- Update ArvoContract description
+

package/README.md

@@ -1,3 +1,5 @@
+
+
 # Arvo
 
 ## What is Arvo
@@ -24,10 +26,32 @@ Whether you're building a small microservice or a large-scale distributed system
 
 This core package defines primitive types and utility functions to help you quickly start building interesting and robust event-driven applications.
 
-At its core, Arvo has only two main data structures:
+## Documentation & Resources
+
+
+| Source          | Link                   |
+| --------------- | ------------------------ 
+| Package         | https://www.npmjs.com/package/arvo-core?activeTab=readme  |
+| Github          | https://github.com/SaadAhmad123/arvo-core                 |
+| Documenation    | https://saadahmad123.github.io/arvo-core/index.html       |
+
+
+## Installation
+
+You can install the core package via `npm` or `yarn`
+
+```bash
+npm install arvo-core
+```
+```bash
+yarn add arvo-core
+```
+
 
 ## Components
 
+At its core, Arvo has only three main data structures:
+
 - [ArvoEvent](src/ArvoEvent/README.md) aims to provide a extendible variant of the open-source CloudEvent spec-ed object to define all the event in the system.
 - [ArvoContract](src/ArvoContract/README.md) is a basic class to define and impose contracts between services, ensuring trust in decoupled systems during build and development.
 - [ArvoContractLibrary](src/ArvoContractLibrary/README.md) is a utility class designed to manage and access multiple ArvoContract instances efficiently.
@@ -36,13 +60,24 @@ At its core, Arvo has only two main data structures:
 
 The package also includes utility functions for:
 
-- Creating ArvoEvents
+- Creating ArvoEvents, ArvoContracts, and contract libraries
 - Integrating with OpenTelemetry
 - TypeScript types for core components
 
+## Getting Started
+
+To start using Arvo in your project:
+
+- Install the package as shown in the Installation section.
+- Import the necessary components:
+```javascript
+import { createArvoEvent, createArvoContract, createArvoContractLibrary } from 'arvo-core';
+```
+- Begin defining your events and contracts using the provided classes.
+
 ## License
 
 This package is available under the MIT License. For more details, refer to the [LICENSE.md](LICENSE.md) file in the project repository.
 
 ## Change Logs
-See the package change logs [here](CHANGELOG.md).
+For a detailed list of changes and updates, please refer to the [document](CHANGELOG.md) file.

package/dist/ArvoContract/index.d.ts

@@ -19,17 +19,27 @@ export default class ArvoContract<T extends string = string, TAccepts extends Ar
     private readonly _uri;
     private readonly _accepts;
     private readonly _emits;
+    /** (Optional) The Contract description */
     readonly description: string | null;
     /**
      * Creates an instance of ArvoContract.
      * @param {IArvoContract<T, TAccepts, TEmits>} params - The contract parameters.
      */
     constructor(params: IArvoContract<T, TAccepts, TEmits>);
+    /**
+     * Gets the URI of the contract.
+     * @returns {T} The contract's URI.
+     */
     get uri(): T;
+    /**
+     * Gets the accepted record type and schema.
+     * @returns {Readonly<TAccepts>} The frozen accepts object.
+     */
     get accepts(): TAccepts;
     /**
      * Gets all emitted event types and schemas as a readonly record.
      * Use this when you need to access all emitted events at once.
+     * @returns {Readonly<Record<ExtractEventType<TEmits>, TEmits>>} A frozen record of all emitted events.
      */
     get emits(): Record<ExtractEventType<TEmits>, TEmits>;
     /**
@@ -89,7 +99,7 @@ export default class ArvoContract<T extends string = string, TAccepts extends Ar
      * This method provides a way to represent the contract's structure and validation rules
      * in a format that conforms to the JSON Schema specification.
      *
-     * @returns An object representing the contract in JSON Schema format, including:
+     * @returns {Object} An object representing the contract in JSON Schema format, including:
      *   - uri: The contract's URI
      *   - description: The contract's description (if available)
      *   - accepts: An object containing the accepted input type and its JSON Schema representation

package/dist/ArvoContract/index.js

@@ -24,6 +24,10 @@ var ArvoContract = /** @class */ (function () {
         Object.freeze(this);
     }
     Object.defineProperty(ArvoContract.prototype, "uri", {
+        /**
+         * Gets the URI of the contract.
+         * @returns {T} The contract's URI.
+         */
         get: function () {
             return this._uri;
         },
@@ -31,6 +35,10 @@ var ArvoContract = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(ArvoContract.prototype, "accepts", {
+        /**
+         * Gets the accepted record type and schema.
+         * @returns {Readonly<TAccepts>} The frozen accepts object.
+         */
         get: function () {
             return Object.freeze(this._accepts);
         },
@@ -41,6 +49,7 @@ var ArvoContract = /** @class */ (function () {
         /**
          * Gets all emitted event types and schemas as a readonly record.
          * Use this when you need to access all emitted events at once.
+         * @returns {Readonly<Record<ExtractEventType<TEmits>, TEmits>>} A frozen record of all emitted events.
          */
         get: function () {
             return Object.freeze(this._emits.reduce(function (acc, emit) {
@@ -145,7 +154,7 @@ var ArvoContract = /** @class */ (function () {
      * This method provides a way to represent the contract's structure and validation rules
      * in a format that conforms to the JSON Schema specification.
      *
-     * @returns An object representing the contract in JSON Schema format, including:
+     * @returns {Object} An object representing the contract in JSON Schema format, including:
      *   - uri: The contract's URI
      *   - description: The contract's description (if available)
      *   - accepts: An object containing the accepted input type and its JSON Schema representation

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arvo-core",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "This core package contains all the core classes and components of the Arvo Event Driven System",
   "main": "dist/index.js",
   "scripts": {