arvo-core 1.0.29 → 1.1.0

package/CHANGELOG.md

@@ -52,3 +52,7 @@
 
 - Added SonarCloud integration for code scanning
 
+## [1.1.0] - 2024-09-20
+
+- Added support for Arvo orchestration subject management
+

package/README.md

@@ -1,3 +1,7 @@
+[![SonarCloud](https://sonarcloud.io/images/project_badges/sonarcloud-white.svg)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+
+
 # Arvo
 
 ## What is Arvo
@@ -86,3 +90,18 @@ This package is available under the MIT License. For more details, refer to the
 ## Change Logs
 
 For a detailed list of changes and updates, please refer to the [document](CHANGELOG.md) file.
+
+### SonarCloud Metrics
+
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=bugs)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=coverage)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+

package/dist/ArvoContract/helpers.d.ts

@@ -12,7 +12,7 @@ export type InferArvoContract<T> = T extends IArvoContract<infer S, infer U, inf
  *
  * @template TContract - The type of the contract specification.
  *
- * @param contractSpec - The contract specification object.
+ * @param contract - The contract specification object.
  *   This should include the URI, accepts, and emits properties as defined in IArvoContract.
  *
  * @returns The created ArvoContract instance.

package/dist/ArvoContract/helpers.js

@@ -13,7 +13,7 @@ var _1 = __importDefault(require("."));
  *
  * @template TContract - The type of the contract specification.
  *
- * @param contractSpec - The contract specification object.
+ * @param contract - The contract specification object.
  *   This should include the URI, accepts, and emits properties as defined in IArvoContract.
  *
  * @returns The created ArvoContract instance.

package/dist/ArvoEvent/index.d.ts

@@ -91,7 +91,7 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
      * This field represents the intended recipient or destination of the event.
      * @returns The value of the 'to' field.
      *
-     * @remark
+     * @remarks
      * This is a convenience getter for the data in `this.extensions.to` as this
      * is an ArvoEvent object which natively defines this extension on the CloudEvent
      * spec.
@@ -102,7 +102,7 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
      * This field contains access control information for the event.
      * @returns The value of the 'accesscontrol' field.
      *
-     * @remark
+     * @remarks
      * This is a convenience getter for the data in `this.extensions.accesscontrol` as this
      * is an ArvoEvent object which natively defines this extension on the CloudEvent
      * spec.
@@ -113,7 +113,7 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
      * This field indicate an alternative destination for the event.
      * @returns The value of the 'redirectto' field.
      *
-     * @remark
+     * @remarks
      * This is a convenience getter for the data in `this.extensions.redirectto` as this
      * is an ArvoEvent object which natively defines this extension on the CloudEvent
      * spec.
@@ -124,7 +124,7 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
      * This field contains information about the execution units associated with the event.
      * @returns The value of the 'executionunits' field.
      *
-     * @remark
+     * @remarks
      * This is a convenience getter for the data in `this.extensions.executionunits` as this
      * is an ArvoEvent object which natively defines this extension on the CloudEvent
      * spec.
@@ -135,7 +135,7 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
      * This field contains the W3C Trace Context traceparent header.
      * @returns The value of the 'traceparent' field.
      *
-     * @remark
+     * @remarks
      * This is a convenience getter for the data in `this.extensions.traceparent` as this
      * is an ArvoEvent object which natively defines this extension on the CloudEvent
      * spec.
@@ -146,7 +146,7 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
      * This field contains the W3C Trace Context tracestate header.
      * @returns The value of the 'tracestate' field, or undefined if not set.
      *
-     * @remark
+     * @remarks
      * This is a convenience getter for the data in `this.extensions.tracestate` as this
      * is an ArvoEvent object which natively defines this extension on the CloudEvent
      * spec.

package/dist/ArvoEvent/index.js

@@ -129,7 +129,7 @@ var ArvoEvent = /** @class */ (function () {
          * This field represents the intended recipient or destination of the event.
          * @returns The value of the 'to' field.
          *
-         * @remark
+         * @remarks
          * This is a convenience getter for the data in `this.extensions.to` as this
          * is an ArvoEvent object which natively defines this extension on the CloudEvent
          * spec.
@@ -146,7 +146,7 @@ var ArvoEvent = /** @class */ (function () {
          * This field contains access control information for the event.
          * @returns The value of the 'accesscontrol' field.
          *
-         * @remark
+         * @remarks
          * This is a convenience getter for the data in `this.extensions.accesscontrol` as this
          * is an ArvoEvent object which natively defines this extension on the CloudEvent
          * spec.
@@ -163,7 +163,7 @@ var ArvoEvent = /** @class */ (function () {
          * This field indicate an alternative destination for the event.
          * @returns The value of the 'redirectto' field.
          *
-         * @remark
+         * @remarks
          * This is a convenience getter for the data in `this.extensions.redirectto` as this
          * is an ArvoEvent object which natively defines this extension on the CloudEvent
          * spec.
@@ -180,7 +180,7 @@ var ArvoEvent = /** @class */ (function () {
          * This field contains information about the execution units associated with the event.
          * @returns The value of the 'executionunits' field.
          *
-         * @remark
+         * @remarks
          * This is a convenience getter for the data in `this.extensions.executionunits` as this
          * is an ArvoEvent object which natively defines this extension on the CloudEvent
          * spec.
@@ -197,7 +197,7 @@ var ArvoEvent = /** @class */ (function () {
          * This field contains the W3C Trace Context traceparent header.
          * @returns The value of the 'traceparent' field.
          *
-         * @remark
+         * @remarks
          * This is a convenience getter for the data in `this.extensions.traceparent` as this
          * is an ArvoEvent object which natively defines this extension on the CloudEvent
          * spec.
@@ -214,7 +214,7 @@ var ArvoEvent = /** @class */ (function () {
          * This field contains the W3C Trace Context tracestate header.
          * @returns The value of the 'tracestate' field, or undefined if not set.
          *
-         * @remark
+         * @remarks
          * This is a convenience getter for the data in `this.extensions.tracestate` as this
          * is an ArvoEvent object which natively defines this extension on the CloudEvent
          * spec.

package/dist/ArvoOrchestrationSubject/index.d.ts

@@ -0,0 +1,36 @@
+import { ArvoOchestratorVersion, ArvoOrchestrationSubjectContent } from "./type";
+/**
+ * Handles the creation and parsing of Arvo orchestration subjects.
+ */
+export default class ArvoOrchestrationSubject {
+    /**
+     * Creates a new Arvo orchestration subject.
+     *
+     * @param param - Parameters for creating the subject
+     * @param param.orchestrator - Name of the orchestrator
+     * @param param.version - Version of the orchestrator
+     * @param param.initiator - Initiator of the orchestration
+     * @returns A base64 encoded string representing the orchestration subject
+     */
+    static new(param: {
+        orchestator: string;
+        version: ArvoOchestratorVersion;
+        initiator: string;
+    }): string;
+    /**
+     * Creates an Arvo orchestration subject from the provided content.
+     *
+     * @param param - The orchestration subject content
+     * @returns A base64 encoded string representing the orchestration subject
+     * @throws Error if the provided content is invalid or if compression fails
+     */
+    static create(param: ArvoOrchestrationSubjectContent): string;
+    /**
+     * Parses a base64 encoded Arvo orchestration subject string.
+     *
+     * @param subject - The base64 encoded subject string to parse
+     * @returns The parsed ArvoOrchestrationSubjectContent
+     * @throws Error if parsing or validation fails
+     */
+    static parse(subject: string): ArvoOrchestrationSubjectContent;
+}

package/dist/ArvoOrchestrationSubject/index.js

@@ -0,0 +1,102 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var schema_1 = require("./schema");
+var zlib = __importStar(require("zlib"));
+var utils_1 = require("../utils");
+var uuid_1 = require("uuid");
+/**
+ * Handles the creation and parsing of Arvo orchestration subjects.
+ */
+var ArvoOrchestrationSubject = /** @class */ (function () {
+    function ArvoOrchestrationSubject() {
+    }
+    /**
+     * Creates a new Arvo orchestration subject.
+     *
+     * @param param - Parameters for creating the subject
+     * @param param.orchestrator - Name of the orchestrator
+     * @param param.version - Version of the orchestrator
+     * @param param.initiator - Initiator of the orchestration
+     * @returns A base64 encoded string representing the orchestration subject
+     */
+    ArvoOrchestrationSubject.new = function (param) {
+        return ArvoOrchestrationSubject.create({
+            orchestrator: {
+                name: param.orchestator,
+                version: param.version,
+            },
+            execution: {
+                id: (0, uuid_1.v4)(),
+                initiator: param.initiator
+            }
+        });
+    };
+    /**
+     * Creates an Arvo orchestration subject from the provided content.
+     *
+     * @param param - The orchestration subject content
+     * @returns A base64 encoded string representing the orchestration subject
+     * @throws Error if the provided content is invalid or if compression fails
+     */
+    ArvoOrchestrationSubject.create = function (param) {
+        try {
+            var validationResult = schema_1.ArvoOrchestrationSubjectContentSchema.safeParse(param);
+            if (!validationResult.success) {
+                throw new Error("Invalid ArvoOrchestrationContextType: ".concat(validationResult.error));
+            }
+            var jsonString = JSON.stringify(param);
+            var compressed = zlib.deflateSync(jsonString);
+            return compressed.toString('base64');
+        }
+        catch (e) {
+            throw new Error((0, utils_1.cleanString)("\n        Error creating orchestration subject string from the provided context. \n        Error -> ".concat(e.message, "  \n        Context -> ").concat(JSON.stringify(param, null, 2), "\n      ")));
+        }
+    };
+    /**
+     * Parses a base64 encoded Arvo orchestration subject string.
+     *
+     * @param subject - The base64 encoded subject string to parse
+     * @returns The parsed ArvoOrchestrationSubjectContent
+     * @throws Error if parsing or validation fails
+     */
+    ArvoOrchestrationSubject.parse = function (subject) {
+        try {
+            var compressed = Buffer.from(subject, 'base64');
+            var jsonString = zlib.inflateSync(compressed).toString();
+            var parsed = JSON.parse(jsonString);
+            var validationResult = schema_1.ArvoOrchestrationSubjectContentSchema.safeParse(parsed);
+            if (!validationResult.success) {
+                throw new Error("Invalid ArvoOrchestrationContextType: ".concat(validationResult.error));
+            }
+            return parsed;
+        }
+        catch (e) {
+            throw new Error((0, utils_1.cleanString)("\n        Error parsing orchestration subject string to the context. \n        Error -> ".concat(e.message, "  \n        subject -> ").concat(subject, "\n      ")));
+        }
+    };
+    return ArvoOrchestrationSubject;
+}());
+exports.default = ArvoOrchestrationSubject;

package/dist/ArvoOrchestrationSubject/schema.d.ts

@@ -0,0 +1,42 @@
+import { z } from "zod";
+export declare const ArvoOchestratorVersionSchema: z.ZodEffects<z.ZodString, string, string>;
+export declare const ArvoOrchestrationSubjectContentSchema: z.ZodObject<{
+    orchestrator: z.ZodObject<{
+        name: z.ZodEffects<z.ZodString, string, string>;
+        version: z.ZodEffects<z.ZodString, string, string>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        version: string;
+    }, {
+        name: string;
+        version: string;
+    }>;
+    execution: z.ZodObject<{
+        id: z.ZodEffects<z.ZodString, string, string>;
+        initiator: z.ZodEffects<z.ZodString, string, string>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        initiator: string;
+    }, {
+        id: string;
+        initiator: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    orchestrator: {
+        name: string;
+        version: string;
+    };
+    execution: {
+        id: string;
+        initiator: string;
+    };
+}, {
+    orchestrator: {
+        name: string;
+        version: string;
+    };
+    execution: {
+        id: string;
+        initiator: string;
+    };
+}>;

package/dist/ArvoOrchestrationSubject/schema.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArvoOrchestrationSubjectContentSchema = exports.ArvoOchestratorVersionSchema = void 0;
+var zod_1 = require("zod");
+// Zod schema for ArvoOchestratorVersion
+exports.ArvoOchestratorVersionSchema = zod_1.z
+    .string()
+    .regex(/^\d+\.\d+\.\d+$/, 'Invalid version format')
+    .refine(function (value) { return !value.includes(';'); }, 'Version must not contain semicolon')
+    .describe('Semantic version of the Arvo Orchestrator in the format X.Y.Z');
+// Zod schema for ArvoOrchestrationSubjectContent
+exports.ArvoOrchestrationSubjectContentSchema = zod_1.z.object({
+    orchestrator: zod_1.z.object({
+        name: zod_1.z
+            .string()
+            .regex(/^[a-z0-9]+(\.[a-z0-9]+)+\.[a-z0-9]+$/, 'Orchestrator name should be prefixed with a reverse-DNS name')
+            .refine(function (value) { return !value.includes(';'); }, 'Orchestrator name must not contain semicolon')
+            .describe('Name of the orchestrator'),
+        version: exports.ArvoOchestratorVersionSchema,
+    })
+        .describe('Information about the orchestrator'),
+    execution: zod_1.z.object({
+        id: zod_1.z
+            .string()
+            .min(1, 'ID must be a non-empty string')
+            .refine(function (value) { return !value.includes(';'); }, 'ID must not contain semicolon')
+            .describe('Unique identifier for the execution'),
+        initiator: zod_1.z
+            .string()
+            .regex(/^[a-z0-9]+(\.[a-z0-9]+)+\.[a-z0-9]+$/, 'Orchestration initiator should be prefixed with a reverse-DNS name')
+            .refine(function (value) { return !value.includes(';'); }, 'Initiator must not contain semicolon')
+            .describe('Entity or process that initiated the execution'),
+    }).describe('Details about the current execution'),
+}).describe('Context information for Arvo orchestration');

package/dist/ArvoOrchestrationSubject/type.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Represents the version of the Arvo Orchestrator.
+ *
+ * @remark
+ * The version follows the Semantic Versioning format: MAJOR.MINOR.PATCH
+ * **Note**: The string must not contain ';'
+ *
+ * @example
+ * "1.0.0", "2.3.1", "0.5.2"
+ */
+export type ArvoOchestratorVersion = `${number}.${number}.${number}`;
+/**
+ * Represents the content for Arvo orchestration subject.
+ * This type provides information about the orchestrator and the current execution.
+ */
+export type ArvoOrchestrationSubjectContent = {
+    /**
+     * Information about the orchestrator.
+     */
+    orchestrator: {
+        /**
+         * The name of the orchestrator.
+         *
+         * @remark
+         * Should be prefixed with a reverse-DNS name.
+         * **Note**: The string must not contain ';'
+         *
+         * @example
+         * "com.example.myorchestrator"
+         */
+        name: string;
+        /**
+         * The version of the orchestrator.
+         */
+        version: ArvoOchestratorVersion;
+    };
+    /**
+     * Details about the current execution.
+     */
+    execution: {
+        /**
+         * A unique identifier for the execution.
+         *
+         * @remark
+         * Should be a non-empty string. The recomendation
+         * is to use uuid v4 to generate these ids.
+         * **Note**: The string must not contain ';'
+         *
+         * @example
+         * "abc123", "execution-2023-05-15-001"
+         */
+        id: string;
+        /**
+         * The entity or process that initiated the execution.
+         *
+         * @remark
+         * Should be prefixed with a reverse-DNS name.
+         * **Note**: The string must not contain ';'
+         *
+         * @example
+         * "com.example.initiator-service"
+         */
+        initiator: string;
+    };
+};

package/dist/ArvoOrchestrationSubject/type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/OpenTelemetry/index.d.ts

@@ -7,8 +7,6 @@ export declare const ArvoCoreTracer: import("@opentelemetry/api").Tracer;
 /**
  * Logs a message to a span with additional parameters.
  * @param params - The parameters for the log message.
- * @param params.level - The log level of the message.
- * @param params.message - The main content of the log message.
  * @param span - The span to log the message to. If not provided, the active span is used.
  *               If no active span is available, the message is logged to the console.
  */

package/dist/OpenTelemetry/index.js

@@ -24,8 +24,6 @@ exports.ArvoCoreTracer = api_1.trace.getTracer(pkg.name, pkg.version);
 /**
  * Logs a message to a span with additional parameters.
  * @param params - The parameters for the log message.
- * @param params.level - The log level of the message.
- * @param params.message - The main content of the log message.
  * @param span - The span to log the message to. If not provided, the active span is used.
  *               If no active span is available, the message is logged to the console.
  */

package/dist/index.d.ts

@@ -18,6 +18,9 @@ import OpenInference from './OpenTelemetry/OpenInference';
 import ArvoExecution from './OpenTelemetry/ArvoExecution';
 import { ArvoExecutionSpanKind } from './OpenTelemetry/ArvoExecution/types';
 import { OpenInferenceSpanKind } from './OpenTelemetry/OpenInference/types';
+import ArvoOrchestrationSubject from './ArvoOrchestrationSubject';
+import { ArvoOrchestrationSubjectContentSchema, ArvoOchestratorVersionSchema } from './ArvoOrchestrationSubject/schema';
+import { ArvoOrchestrationSubjectContent, ArvoOchestratorVersion } from './ArvoOrchestrationSubject/type';
 /**
  * Collection of Zod schemas for validating various aspects of Arvo events.
  * @property {z.ZodObject} CloudEventContextSchema - Schema for core CloudEvent properties.
@@ -84,4 +87,4 @@ declare const ArvoEventSchemas: {
         tracestate: string | null;
     }>;
 };
-export { ArvoEvent, createArvoEvent, ArvoDataContentType, ArvoEventData, CloudEventExtension, ArvoEventSchemas, CloudEventContext, ArvoExtension, OpenTelemetryExtension, CreateArvoEvent, exceptionToSpan, logToSpan, OpenTelemetryHeaders, TelemetryLogLevel, OTelNull, validateURI, cleanString, ArvoContract, createArvoContract, ArvoContractValidators, ArvoContractRecord, InferArvoContract, IArvoContract, ResolveArvoContractRecord, ArvoContractLibrary, createArvoContractLibrary, ArvoEventFactory, createArvoEventFactory, ArvoErrorSchema, currentOpenTelemetryHeaders, OpenInference, OpenInferenceSpanKind, ArvoExecution, ArvoExecutionSpanKind, ArvoContractJSONSchema, };
+export { ArvoEvent, createArvoEvent, ArvoDataContentType, ArvoEventData, CloudEventExtension, ArvoEventSchemas, CloudEventContext, ArvoExtension, OpenTelemetryExtension, CreateArvoEvent, exceptionToSpan, logToSpan, OpenTelemetryHeaders, TelemetryLogLevel, OTelNull, validateURI, cleanString, ArvoContract, createArvoContract, ArvoContractValidators, ArvoContractRecord, InferArvoContract, IArvoContract, ResolveArvoContractRecord, ArvoContractLibrary, createArvoContractLibrary, ArvoEventFactory, createArvoEventFactory, ArvoErrorSchema, currentOpenTelemetryHeaders, OpenInference, OpenInferenceSpanKind, ArvoExecution, ArvoExecutionSpanKind, ArvoContractJSONSchema, ArvoOrchestrationSubject, ArvoOrchestrationSubjectContentSchema, ArvoOchestratorVersionSchema, ArvoOrchestrationSubjectContent, ArvoOchestratorVersion, };

package/dist/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ArvoExecutionSpanKind = exports.ArvoExecution = exports.OpenInferenceSpanKind = exports.OpenInference = exports.currentOpenTelemetryHeaders = exports.ArvoErrorSchema = exports.createArvoEventFactory = exports.ArvoEventFactory = exports.createArvoContractLibrary = exports.ArvoContractLibrary = exports.ArvoContractValidators = exports.createArvoContract = exports.ArvoContract = exports.cleanString = exports.validateURI = exports.OTelNull = exports.logToSpan = exports.exceptionToSpan = exports.ArvoEventSchemas = exports.ArvoDataContentType = exports.createArvoEvent = exports.ArvoEvent = void 0;
+exports.ArvoOchestratorVersionSchema = exports.ArvoOrchestrationSubjectContentSchema = exports.ArvoOrchestrationSubject = exports.ArvoExecutionSpanKind = exports.ArvoExecution = exports.OpenInferenceSpanKind = exports.OpenInference = exports.currentOpenTelemetryHeaders = exports.ArvoErrorSchema = exports.createArvoEventFactory = exports.ArvoEventFactory = exports.createArvoContractLibrary = exports.ArvoContractLibrary = exports.ArvoContractValidators = exports.createArvoContract = exports.ArvoContract = exports.cleanString = exports.validateURI = exports.OTelNull = exports.logToSpan = exports.exceptionToSpan = exports.ArvoEventSchemas = exports.ArvoDataContentType = exports.createArvoEvent = exports.ArvoEvent = void 0;
 var ArvoEvent_1 = __importDefault(require("./ArvoEvent"));
 exports.ArvoEvent = ArvoEvent_1.default;
 var schema_1 = require("./ArvoEvent/schema");
@@ -42,6 +42,11 @@ var types_1 = require("./OpenTelemetry/ArvoExecution/types");
 Object.defineProperty(exports, "ArvoExecutionSpanKind", { enumerable: true, get: function () { return types_1.ArvoExecutionSpanKind; } });
 var types_2 = require("./OpenTelemetry/OpenInference/types");
 Object.defineProperty(exports, "OpenInferenceSpanKind", { enumerable: true, get: function () { return types_2.OpenInferenceSpanKind; } });
+var ArvoOrchestrationSubject_1 = __importDefault(require("./ArvoOrchestrationSubject"));
+exports.ArvoOrchestrationSubject = ArvoOrchestrationSubject_1.default;
+var schema_3 = require("./ArvoOrchestrationSubject/schema");
+Object.defineProperty(exports, "ArvoOrchestrationSubjectContentSchema", { enumerable: true, get: function () { return schema_3.ArvoOrchestrationSubjectContentSchema; } });
+Object.defineProperty(exports, "ArvoOchestratorVersionSchema", { enumerable: true, get: function () { return schema_3.ArvoOchestratorVersionSchema; } });
 /**
  * Collection of Zod schemas for validating various aspects of Arvo events.
  * @property {z.ZodObject} CloudEventContextSchema - Schema for core CloudEvent properties.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arvo-core",
-  "version": "1.0.29",
+  "version": "1.1.0",
   "description": "This core package contains all the core classes and components of the Arvo Event Driven System",
   "main": "dist/index.js",
   "scripts": {
@@ -41,12 +41,14 @@
     "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
     "typedoc": "^0.26.6",
+    "typedoc-github-theme": "^0.1.2",
     "typedoc-plugin-zod": "^1.2.1",
     "typescript": "^5.5.4"
   },
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
     "uuid": "^10.0.0",
+    "zlib": "^1.0.5",
     "zod": "^3.23.8",
     "zod-to-json-schema": "^3.23.2"
   }