arvo-core 1.1.1 → 1.1.3

package/dist/ArvoEvent/helpers.d.ts

@@ -22,6 +22,7 @@ import { ArvoEventData, CloudEventExtension, CreateArvoEvent } from './types';
  * - If no `datacontenttype` is provided, it defaults to `application/cloudevents+json;charset=UTF-8;profile=arvo`.
  * - If a non-compatible `datacontenttype` is provided, a warning will be logged to the span.
  * - The `source`, `subject`, `to`, `redirectto`, and `dataschema` fields are URI-encoded.
+ * - If no `to` (null, undefined or empty string) is provided, then the `type` value is used by default
  *
  * @example
  * const event = createArvoEvent(
@@ -31,7 +32,7 @@ import { ArvoEventData, CloudEventExtension, CreateArvoEvent } from './types';
  *     subject: 'example-subject',
  *     data: { key: 'value' }
  *   },
- *   { customExtension: 'value' },
+ *   { customextension: 'value' },
  * );
  */
 export declare const createArvoEvent: <TData extends ArvoEventData, TExtension extends CloudEventExtension, TType extends string>(event: CreateArvoEvent<TData, TType>, extensions?: TExtension) => ArvoEvent<TData, TExtension, TType>;

package/dist/ArvoEvent/helpers.js

@@ -32,6 +32,7 @@ var uuid_1 = require("uuid");
  * - If no `datacontenttype` is provided, it defaults to `application/cloudevents+json;charset=UTF-8;profile=arvo`.
  * - If a non-compatible `datacontenttype` is provided, a warning will be logged to the span.
  * - The `source`, `subject`, `to`, `redirectto`, and `dataschema` fields are URI-encoded.
+ * - If no `to` (null, undefined or empty string) is provided, then the `type` value is used by default
  *
  * @example
  * const event = createArvoEvent(
@@ -41,7 +42,7 @@ var uuid_1 = require("uuid");
  *     subject: 'example-subject',
  *     data: { key: 'value' }
  *   },
- *   { customExtension: 'value' },
+ *   { customextension: 'value' },
  * );
  */
 var createArvoEvent = function (event, extensions) {
@@ -70,7 +71,7 @@ var createArvoEvent = function (event, extensions) {
                 time: (_h = event.time) !== null && _h !== void 0 ? _h : (0, utils_1.createTimestamp)(),
                 source: encodeURI(event.source),
                 subject: encodeURI(event.subject),
-                to: event.to ? encodeURI(event.to) : null,
+                to: event.to ? encodeURI(event.to) : encodeURI(event.type),
                 redirectto: event.redirectto ? encodeURI(event.redirectto) : null,
                 dataschema: event.dataschema ? encodeURI(event.dataschema) : null,
             }, event.data, extensions);

package/dist/index.d.ts

@@ -6,7 +6,7 @@ import { exceptionToSpan, logToSpan, OTelNull, currentOpenTelemetryHeaders } fro
 import { OpenTelemetryHeaders, TelemetryLogLevel } from './OpenTelemetry/types';
 import { validateURI, cleanString } from './utils';
 import ArvoContract from './ArvoContract';
-import { createArvoContract, InferArvoContract } from './ArvoContract/helpers';
+import { createArvoContract, InferArvoContract as InferArvoContractType } from './ArvoContract/helpers';
 import { ArvoContractValidators } from './ArvoContract/validators';
 import { ArvoContractRecord, IArvoContract, ResolveArvoContractRecord, ArvoContractJSONSchema } from './ArvoContract/types';
 import ArvoContractLibrary from './ArvoContractLibrary';
@@ -23,6 +23,7 @@ import { ArvoOrchestrationSubjectContentSchema, ArvoOchestratorVersionSchema } f
 import { ArvoOrchestrationSubjectContent, ArvoOchestratorVersion } from './ArvoOrchestrationSubject/type';
 import ArvoEventHttp from './ArvoEventHttp';
 import { ArvoEventHttpConfig } from './ArvoEventHttp/types';
+import { InferArvoContract, InferArvoEvent } from './types';
 /**
  * Collection of Zod schemas for validating various aspects of Arvo events.
  * @property {z.ZodObject} CloudEventContextSchema - Schema for core CloudEvent properties.
@@ -89,4 +90,4 @@ declare const ArvoEventSchemas: {
         tracestate: string | null;
     }>;
 };
-export { ArvoEventHttpConfig, ArvoEventHttp, 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, };
+export { ArvoEventHttpConfig, ArvoEventHttp, ArvoEvent, createArvoEvent, ArvoDataContentType, ArvoEventData, CloudEventExtension, ArvoEventSchemas, CloudEventContext, ArvoExtension, OpenTelemetryExtension, CreateArvoEvent, exceptionToSpan, logToSpan, OpenTelemetryHeaders, TelemetryLogLevel, OTelNull, validateURI, cleanString, ArvoContract, createArvoContract, ArvoContractValidators, ArvoContractRecord, IArvoContract, ResolveArvoContractRecord, ArvoContractLibrary, createArvoContractLibrary, ArvoEventFactory, createArvoEventFactory, ArvoErrorSchema, currentOpenTelemetryHeaders, OpenInference, OpenInferenceSpanKind, ArvoExecution, ArvoExecutionSpanKind, ArvoContractJSONSchema, ArvoOrchestrationSubject, ArvoOrchestrationSubjectContentSchema, ArvoOchestratorVersionSchema, ArvoOrchestrationSubjectContent, ArvoOchestratorVersion, InferArvoEvent, InferArvoContract, InferArvoContractType, };

package/dist/types.d.ts

@@ -0,0 +1,71 @@
+import { z } from 'zod';
+import ArvoContract from './ArvoContract';
+import ArvoEvent from './ArvoEvent';
+import { ArvoExtension, OpenTelemetryExtension } from './ArvoEvent/types';
+/**
+ * A type utility that infers the structure of an ArvoEvent.
+ *
+ * @template T - The type to infer from, expected to be an ArvoEvent.
+ *
+ * @returns An object type that includes all properties of an ArvoEvent,
+ * including its data, extensions, and standard CloudEvents properties.
+ *
+ * @example
+ * type MyEvent = InferArvoEvent<ArvoEvent<{ message: string }, { customField: number }, 'my.event.type'>>;
+ * // MyEvent will have properties like id, source, data.message, customField, etc.
+ */
+export type InferArvoEvent<T> = T extends ArvoEvent<infer TData, infer TExtension, infer TType> ? {
+    /** Unique identifier of the event */
+    id: string;
+    /** Identifies the context in which an event happened */
+    source: string;
+    /** The version of the CloudEvents specification */
+    specversion: string;
+    /** Describes the type of event related to the originating occurrence */
+    type: TType;
+    /** Describes the subject of the event in the context of the event producer */
+    subject: string;
+    /** Content type of the data value */
+    datacontenttype: string;
+    /** A link to the schema that the data adheres to */
+    dataschema: string | null;
+    /** Event payload */
+    data: TData;
+    /** Timestamp of when the occurrence happened */
+    time: string;
+} & ArvoExtension & OpenTelemetryExtension & TExtension : never;
+/**
+ * Helper type to infer the TypeScript type from a Zod schema.
+ *
+ * @template T - The Zod schema type to infer from.
+ *
+ * @returns The TypeScript type that corresponds to the Zod schema.
+ *
+ * @example
+ * const mySchema = z.object({ name: z.string(), age: z.number() });
+ * type MyType = InferZodSchema<typeof mySchema>;
+ * // MyType will be { name: string; age: number; }
+ */
+type InferZodSchema<T> = T extends z.ZodTypeAny ? z.infer<T> : never;
+/**
+ * A type utility that infers the structure of an ArvoContract.
+ *
+ * @template T - The type to infer from, expected to be an ArvoContract.
+ *
+ * @returns An object type that includes the URI, accepted event type, and emitted event types of the contract.
+ *
+ * @example
+ * const myContract = new ArvoContract('my-uri', 'my-type', z.object({ input: z.string() }), {
+ *   'output.event': z.object({ result: z.number() })
+ * });
+ * type MyContractType = InferArvoContract<typeof myContract>;
+ * // MyContractType will have properties uri, accepts, and emits
+ */
+export type InferArvoContract<T extends ArvoContract<string, string, z.ZodTypeAny, Record<string, z.ZodTypeAny>>> = T extends ArvoContract<infer TUri, infer TType, infer TAcceptSchema, infer TEmits> ? {
+    uri: TUri;
+    accepts: InferArvoEvent<ArvoEvent<InferZodSchema<TAcceptSchema>, {}, TType>>;
+    emits: {
+        [K in keyof TEmits]: InferArvoEvent<ArvoEvent<InferZodSchema<TEmits[K]>, {}, K & string>>;
+    };
+} : never;
+export {};

package/dist/types.js

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

package/package.json

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