arvo-core 0.0.2 → 1.0.1

package/CHANGELOG.md

@@ -3,3 +3,7 @@
 ## [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.1] - 2024-08-31
+
+- Update ArvoContract description
+

package/README.md

@@ -39,3 +39,10 @@ The package also includes utility functions for:
 - Creating ArvoEvents
 - Integrating with OpenTelemetry
 - TypeScript types for core components
+
+## 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).

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": "0.0.2",
+  "version": "1.0.1",
   "description": "This core package contains all the core classes and components of the Arvo Event Driven System",
   "main": "dist/index.js",
   "scripts": {

package/generate-changelog.sh

@@ -1,29 +0,0 @@
-#!/bin/bash
-
-# File name
-CHANGELOG_FILE="CHANGELOG.md"
-
-# Get current date
-CURRENT_DATE=$(date +"%Y-%m-%d")
-
-# Prompt for version
-read -p "Enter version number: " VERSION
-
-# Prompt for description
-read -p "Enter change description: " DESCRIPTION
-
-# Create or append to CHANGELOG.md
-if [ ! -f "$CHANGELOG_FILE" ]; then
-    echo "# Changelog" > "$CHANGELOG_FILE"
-    echo "" >> "$CHANGELOG_FILE"
-fi
-
-# Add new entry
-{
-    echo "## [$VERSION] - $CURRENT_DATE"
-    echo ""
-    echo "- $DESCRIPTION"
-    echo ""
-} >> "$CHANGELOG_FILE"
-
-echo "Changelog updated successfully!"