arvo-core 1.0.1 → 1.0.3

package/CHANGELOG.md

@@ -3,7 +3,12 @@
 ## [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
+
+## [1.0.2] - 2024-08-31
 
 - Update ArvoContract description
 
+## [1.0.3] - 2024-08-31
+
+- Making type in ArvoEvent a generic string for better type control
+

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

@@ -33,13 +33,13 @@ export default class ArvoContract<T extends string = string, TAccepts extends Ar
     get uri(): T;
     /**
      * Gets the accepted record type and schema.
-     * @returns {Readonly<TAccepts>} The frozen accepts object.
+     * @returns {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.
+     * @returns {Record<ExtractEventType<TEmits>, TEmits>} A frozen record of all emitted events.
      */
     get emits(): Record<ExtractEventType<TEmits>, TEmits>;
     /**
@@ -47,7 +47,7 @@ export default class ArvoContract<T extends string = string, TAccepts extends Ar
      * Use this when you need to access a single emitted event by its type.
      * @template U - The type of the emit record to retrieve.
      * @param {U} type - The type of the emit record.
-     * @returns {Readonly<Extract<TEmits, { type: U }>>} The emit record.
+     * @returns {Extract<TEmits, { type: U }>} The emit record.
      * @throws {Error} If the emit type is not found in the contract.
      */
     getEmit<U extends ExtractEventType<TEmits>>(type: U): Extract<TEmits, {

package/dist/ArvoContract/index.js

@@ -37,7 +37,7 @@ var ArvoContract = /** @class */ (function () {
     Object.defineProperty(ArvoContract.prototype, "accepts", {
         /**
          * Gets the accepted record type and schema.
-         * @returns {Readonly<TAccepts>} The frozen accepts object.
+         * @returns {TAccepts} The frozen accepts object.
          */
         get: function () {
             return Object.freeze(this._accepts);
@@ -49,7 +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.
+         * @returns {Record<ExtractEventType<TEmits>, TEmits>} A frozen record of all emitted events.
          */
         get: function () {
             return Object.freeze(this._emits.reduce(function (acc, emit) {
@@ -66,7 +66,7 @@ var ArvoContract = /** @class */ (function () {
      * Use this when you need to access a single emitted event by its type.
      * @template U - The type of the emit record to retrieve.
      * @param {U} type - The type of the emit record.
-     * @returns {Readonly<Extract<TEmits, { type: U }>>} The emit record.
+     * @returns {Extract<TEmits, { type: U }>} The emit record.
      * @throws {Error} If the emit type is not found in the contract.
      */
     ArvoContract.prototype.getEmit = function (type) {

package/dist/ArvoEvent/helpers.d.ts

@@ -9,6 +9,7 @@ import { ArvoEventData, CloudEventExtension, CreateArvoEvent } from './types';
  *
  * @template TData - The type of the event data, extending ArvoEventData.
  * @template TExtension - The type of the cloud event extension, extending CloudEventExtension.
+ * @template TType - The type name of the event
  *
  * @param {CreateArvoEvent<TData>} event - The event data and metadata to create the ArvoEvent.
  * @param {TExtension} [extensions] - Optional cloud event extensions.
@@ -37,4 +38,4 @@ import { ArvoEventData, CloudEventExtension, CreateArvoEvent } from './types';
  *   telemetryContext
  * );
  */
-export declare const createArvoEvent: <TData extends ArvoEventData, TExtension extends CloudEventExtension>(event: CreateArvoEvent<TData>, extensions?: TExtension, telemetry?: TelemetryContext) => ArvoEvent<TData, TExtension>;
+export declare const createArvoEvent: <TData extends ArvoEventData, TExtension extends CloudEventExtension, TType extends string>(event: CreateArvoEvent<TData, TType>, extensions?: TExtension, telemetry?: TelemetryContext) => ArvoEvent<TData, TExtension>;

package/dist/ArvoEvent/helpers.js

@@ -17,6 +17,7 @@ var uuid_1 = require("uuid");
  *
  * @template TData - The type of the event data, extending ArvoEventData.
  * @template TExtension - The type of the cloud event extension, extending CloudEventExtension.
+ * @template TType - The type name of the event
  *
  * @param {CreateArvoEvent<TData>} event - The event data and metadata to create the ArvoEvent.
  * @param {TExtension} [extensions] - Optional cloud event extensions.

package/dist/ArvoEvent/index.d.ts

@@ -3,12 +3,13 @@ import { ArvoEventData, ArvoExtension, CloudEventContext, CloudEventExtension, O
  * Represents an ArvoEvent, which extends the CloudEvent specification.
  * @template TData - The type of the event data, extending ArvoEventData.
  * @template TExtension - The type of additional extensions, extending CloudEventExtension.
+ * @template TType - The type name of the event
  */
-export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExtension extends CloudEventExtension = CloudEventExtension> {
+export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExtension extends CloudEventExtension = CloudEventExtension, TType extends string = string> {
     readonly id: string;
     readonly source: string;
     readonly specversion: string;
-    readonly type: string;
+    readonly type: TType;
     readonly subject: string;
     readonly datacontenttype: string;
     readonly dataschema: string | null;
@@ -36,7 +37,7 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
             id: string;
             source: string;
             specversion: string;
-            type: string;
+            type: TType;
             subject: string;
             datacontenttype: string;
             dataschema: string | null;
@@ -77,7 +78,7 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
         'cloudevents.event_source': string;
         'cloudevents.event_spec_version': string;
         'cloudevents.event_subject': string;
-        'cloudevents.event_type': string;
+        'cloudevents.event_type': string | TType;
         'cloudevents.event_time': string;
         'cloudevents.event_datacontenttype': string;
         'cloudevents.event_dataschema': string;

package/dist/ArvoEvent/index.js

@@ -17,6 +17,7 @@ var OpenTelemetry_1 = require("../OpenTelemetry");
  * Represents an ArvoEvent, which extends the CloudEvent specification.
  * @template TData - The type of the event data, extending ArvoEventData.
  * @template TExtension - The type of additional extensions, extending CloudEventExtension.
+ * @template TType - The type name of the event
  */
 var ArvoEvent = /** @class */ (function () {
     /**

package/dist/ArvoEvent/types.d.ts

@@ -23,8 +23,9 @@ export type OpenTelemetryExtension = z.infer<typeof OpenTelemetryExtensionSchema
 /**
  * Represents the input parameters for creating an ArvoEvent.
  * @template TData - The type of the event data, extending ArvoEventData.
+ * @template TType - The type name of the event
  */
-export type CreateArvoEvent<TData extends ArvoEventData> = {
+export type CreateArvoEvent<TData extends ArvoEventData, TType extends string> = {
     /** Unique identifier of the event. Must be a non-empty string. If not provided, a UUID will be generated. */
     id?: string;
     /** Timestamp of when the occurrence happened. Must be in ISO 8601 format with timezone offset. */
@@ -34,7 +35,7 @@ export type CreateArvoEvent<TData extends ArvoEventData> = {
     /** The version of the CloudEvents specification used. Must be '1.0' for this version. */
     specversion?: '1.0';
     /** Describes the type of event. Should be prefixed with a reverse-DNS name. */
-    type: string;
+    type: TType;
     /** Identifies the subject of the event. For Arvo, this must be the Process Id. */
     subject: string;
     /** Content type of the data value. Must include 'application/cloudevents+json' or

package/package.json

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