arvo-core
Version:
The core Arvo package which provides application tier core primitives and contract system for building production-grade event-driven application. Provides ArvoEvent (CloudEvents-compliant), ArvoContract for type-safe service interfaces, event factories, O
112 lines (111 loc) • 8.03 kB
TypeScript
import ArvoContract from './ArvoContract';
import { createArvoContract } from './ArvoContract/helpers';
import ArvoEvent from './ArvoEvent';
import { createArvoEvent } from './ArvoEvent/helpers';
import { ArvoDataContentType } from './ArvoEvent/schema';
import { ArvoEventData, ArvoExtension, CloudEventContext, CloudEventExtension, CreateArvoEvent, OpenTelemetryExtension } from './ArvoEvent/types';
import { ArvoOpenTelemetry, OTelNull, currentOpenTelemetryHeaders, exceptionToSpan, getOtelHeaderFromSpan, logToSpan } from './OpenTelemetry';
import { OpenTelemetryHeaders, TelemetryLogLevel } from './OpenTelemetry/types';
import { EventDataschemaUtil, cleanString, compareSemanticVersions, createArvoError, parseSemanticVersion, validateURI } from './utils';
import { createSimpleArvoContract } from './ArvoContract/SimpleArvoContract';
import { SimpleArvoContract } from './ArvoContract/SimpleArvoContract/types';
import { VersionedArvoContract } from './ArvoContract/VersionedArvoContract';
import { WildCardArvoSemanticVersion, isWildCardArvoSematicVersion } from './ArvoContract/WildCardArvoSemanticVersion';
import { ArvoContractJSONSchema, ArvoContractParam, ArvoContractRecord, ResolveArvoContractRecord } from './ArvoContract/types';
import { ArvoContractValidators } from './ArvoContract/validators';
import { ArvoEventIdObject, ArvoEventIdObjectSchema, createArvoEventId, parseArvoEventId } from './ArvoEvent/id';
import ArvoEventFactory from './ArvoEventFactory';
import { ArvoOrchestratorEventFactory } from './ArvoEventFactory/Orchestrator';
import { createArvoEventFactory, createArvoOrchestratorEventFactory } from './ArvoEventFactory/helpers';
import ArvoOrchestrationSubject from './ArvoOrchestrationSubject';
import { ArvoOrchestrationSubjectContentSchema } from './ArvoOrchestrationSubject/schema';
import { ArvoOrchestrationSubjectContent } from './ArvoOrchestrationSubject/type';
import { createArvoOrchestratorContract } from './ArvoOrchestratorContract';
import { ArvoOrchestratorEventTypeGen } from './ArvoOrchestratorContract/typegen';
import { ArvoOrchestratorContract, CreateArvoOrchestratorContractParam } from './ArvoOrchestratorContract/types';
import { ArvoExecution, ArvoExecutionSpanKind } from './OpenTelemetry/ArvoExecution';
import { OpenInference, OpenInferenceSpanKind } from './OpenTelemetry/OpenInference';
import { ViolationError, ViolationErrorParam, isViolationError } from './errors';
import { ArvoErrorSchema, ArvoSemanticVersionSchema, isValidArvoSemanticVersion } from './schema';
import { ArvoErrorType, ArvoSemanticVersion, InferArvoEvent, InferVersionedArvoContract } from './types';
/**
* Collection of Zod schemas for validating various aspects of Arvo events.
* @property {z.ZodObject} CloudEventContextSchema - Schema for core CloudEvent properties.
* @property {z.ZodRecord} CloudEventExtensionSchema - Schema for custom CloudEvent extensions.
* @property {z.ZodRecord} ArvoDataSchema - Schema for Arvo event data payload.
* @property {z.ZodObject} ArvoExtensionSchema - Schema for Arvo-specific CloudEvent extensions.
* @property {z.ZodObject} OpenTelemetryExtensionSchema - Schema for OpenTelemetry extensions.
* @property {z.ZodObject} OrchestrationInitEventBaseSchema - The base schema for the orchestrator init events.
*/
declare const ArvoEventSchema: {
CloudEventContextSchema: import("zod").ZodObject<{
id: import("zod").ZodString;
time: import("zod").ZodString;
source: import("zod").ZodEffects<import("zod").ZodString, string, string>;
specversion: import("zod").ZodEffects<import("zod").ZodString, "1.0", string>;
type: import("zod").ZodString;
subject: import("zod").ZodEffects<import("zod").ZodString, string, string>;
datacontenttype: import("zod").ZodDefault<import("zod").ZodEffects<import("zod").ZodString, string, string>>;
dataschema: import("zod").ZodNullable<import("zod").ZodEffects<import("zod").ZodString, string, string>>;
}, "strip", import("zod").ZodTypeAny, {
type: string;
id: string;
time: string;
source: string;
specversion: "1.0";
subject: string;
datacontenttype: string;
dataschema: string | null;
}, {
type: string;
id: string;
time: string;
source: string;
specversion: string;
subject: string;
dataschema: string | null;
datacontenttype?: string | undefined;
}>;
CloudEventExtensionSchema: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnion<[import("zod").ZodString, import("zod").ZodBoolean, import("zod").ZodNumber, import("zod").ZodNull]>>;
ArvoDataSchema: import("zod").ZodEffects<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>, Record<string, any>, Record<string, any>>;
ArvoExtensionSchema: import("zod").ZodObject<{
to: import("zod").ZodNullable<import("zod").ZodEffects<import("zod").ZodString, string, string>>;
accesscontrol: import("zod").ZodNullable<import("zod").ZodString>;
redirectto: import("zod").ZodNullable<import("zod").ZodEffects<import("zod").ZodString, string, string>>;
executionunits: import("zod").ZodNullable<import("zod").ZodNumber>;
parentid: import("zod").ZodNullable<import("zod").ZodString>;
domain: import("zod").ZodNullable<import("zod").ZodString>;
}, "strip", import("zod").ZodTypeAny, {
to: string | null;
accesscontrol: string | null;
redirectto: string | null;
executionunits: number | null;
parentid: string | null;
domain: string | null;
}, {
to: string | null;
accesscontrol: string | null;
redirectto: string | null;
executionunits: number | null;
parentid: string | null;
domain: string | null;
}>;
OpenTelemetryExtensionSchema: import("zod").ZodObject<{
traceparent: import("zod").ZodNullable<import("zod").ZodString>;
tracestate: import("zod").ZodNullable<import("zod").ZodString>;
}, "strip", import("zod").ZodTypeAny, {
traceparent: string | null;
tracestate: string | null;
}, {
traceparent: string | null;
tracestate: string | null;
}>;
OrchestrationInitEventBaseSchema: import("zod").ZodObject<{
parentSubject$$: import("zod").ZodNullable<import("zod").ZodString>;
}, "strip", import("zod").ZodTypeAny, {
parentSubject$$: string | null;
}, {
parentSubject$$: string | null;
}>;
};
export { ArvoEvent, createArvoEvent, ArvoDataContentType, ArvoEventData, CloudEventExtension, ArvoEventSchema, CloudEventContext, ArvoExtension, OpenTelemetryExtension, CreateArvoEvent, exceptionToSpan, logToSpan, OpenTelemetryHeaders, TelemetryLogLevel, OTelNull, validateURI, cleanString, ArvoContract, createArvoContract, ArvoContractValidators, ArvoContractRecord, ArvoContractParam as IArvoContract, ResolveArvoContractRecord, ArvoEventFactory, createArvoEventFactory, currentOpenTelemetryHeaders, OpenInference, OpenInferenceSpanKind, ArvoExecution, ArvoExecutionSpanKind, ArvoContractJSONSchema, ArvoOrchestrationSubject, ArvoOrchestrationSubjectContent, ArvoSemanticVersion, InferArvoEvent, createArvoOrchestratorContract, CreateArvoOrchestratorContractParam as ICreateArvoOrchestratorContract, ArvoOrchestratorEventTypeGen, EventDataschemaUtil, ArvoOrchestrationSubjectContentSchema, ArvoSemanticVersionSchema, ArvoErrorSchema, ArvoErrorType, compareSemanticVersions, parseSemanticVersion, createSimpleArvoContract, ArvoOrchestratorContract, VersionedArvoContract, InferVersionedArvoContract, isWildCardArvoSematicVersion, WildCardArvoSemanticVersion, isValidArvoSemanticVersion, SimpleArvoContract, ArvoOrchestratorEventFactory, createArvoOrchestratorEventFactory, ArvoOpenTelemetry, ViolationError, ViolationErrorParam, createArvoError, createArvoEventId, parseArvoEventId, ArvoEventIdObjectSchema, ArvoEventIdObject, isViolationError, getOtelHeaderFromSpan, };