arvo-core 2.2.1 → 2.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/ArvoContract/errors.d.ts +10 -0
- package/dist/ArvoContract/errors.js +36 -0
- package/dist/OpenTelemetry/index.d.ts +41 -2
- package/dist/OpenTelemetry/index.js +52 -2
- package/dist/index.d.ts +2 -1
- package/dist/index.js +3 -1
- package/package.json +1 -1
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Custom error class representing a violation of an ArvoContract.
|
|
3
|
+
*/
|
|
4
|
+
export declare class ArvoContractViolationError extends Error {
|
|
5
|
+
/**
|
|
6
|
+
* Creates an instance of ArvoContractViolationError.
|
|
7
|
+
* @param {string} [message='ArvoContract violated'] - The error message. Default is 'ArvoContract violated'.
|
|
8
|
+
*/
|
|
9
|
+
constructor(message?: string);
|
|
10
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __extends = (this && this.__extends) || (function () {
|
|
3
|
+
var extendStatics = function (d, b) {
|
|
4
|
+
extendStatics = Object.setPrototypeOf ||
|
|
5
|
+
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
6
|
+
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
7
|
+
return extendStatics(d, b);
|
|
8
|
+
};
|
|
9
|
+
return function (d, b) {
|
|
10
|
+
if (typeof b !== "function" && b !== null)
|
|
11
|
+
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
12
|
+
extendStatics(d, b);
|
|
13
|
+
function __() { this.constructor = d; }
|
|
14
|
+
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
15
|
+
};
|
|
16
|
+
})();
|
|
17
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
+
exports.ArvoContractViolationError = void 0;
|
|
19
|
+
/**
|
|
20
|
+
* Custom error class representing a violation of an ArvoContract.
|
|
21
|
+
*/
|
|
22
|
+
var ArvoContractViolationError = /** @class */ (function (_super) {
|
|
23
|
+
__extends(ArvoContractViolationError, _super);
|
|
24
|
+
/**
|
|
25
|
+
* Creates an instance of ArvoContractViolationError.
|
|
26
|
+
* @param {string} [message='ArvoContract violated'] - The error message. Default is 'ArvoContract violated'.
|
|
27
|
+
*/
|
|
28
|
+
function ArvoContractViolationError(message) {
|
|
29
|
+
if (message === void 0) { message = 'ArvoContract violated'; }
|
|
30
|
+
var _this = _super.call(this, message) || this;
|
|
31
|
+
_this.name = 'ArvoContractViolationError';
|
|
32
|
+
return _this;
|
|
33
|
+
}
|
|
34
|
+
return ArvoContractViolationError;
|
|
35
|
+
}(Error));
|
|
36
|
+
exports.ArvoContractViolationError = ArvoContractViolationError;
|
|
@@ -9,12 +9,51 @@ export declare class ArvoOpenTelemetry {
|
|
|
9
9
|
private static instance;
|
|
10
10
|
private constructor();
|
|
11
11
|
/**
|
|
12
|
-
* Gets the instance of ArvoOpenTelemetry
|
|
13
|
-
*
|
|
12
|
+
* Gets or creates the singleton instance of ArvoOpenTelemetry.
|
|
13
|
+
* This method ensures only one instance of ArvoOpenTelemetry exists throughout the application.
|
|
14
|
+
*
|
|
15
|
+
* @param {Object} [config] - Optional configuration object for initializing the instance
|
|
16
|
+
* @param {Tracer} [config.tracer] - Optional custom OpenTelemetry tracer instance.
|
|
17
|
+
* If not provided, defaults to a tracer with name 'arvo-instrumentation'
|
|
18
|
+
*
|
|
19
|
+
* @returns {ArvoOpenTelemetry} The singleton instance of ArvoOpenTelemetry
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* // Get instance with default tracer
|
|
23
|
+
* const telemetry = ArvoOpenTelemetry.getInstance();
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* // Get instance with custom tracer
|
|
27
|
+
* const customTracer = trace.getTracer('custom-tracer', '2.0.0');
|
|
28
|
+
* const telemetry = ArvoOpenTelemetry.getInstance({ tracer: customTracer });
|
|
29
|
+
*
|
|
30
|
+
* @remarks
|
|
31
|
+
* The tracer configuration is only applied when creating a new instance.
|
|
32
|
+
* Subsequent calls with different tracer configurations will not modify the existing instance.
|
|
14
33
|
*/
|
|
15
34
|
static getInstance(config?: {
|
|
16
35
|
tracer?: Tracer;
|
|
17
36
|
}): ArvoOpenTelemetry;
|
|
37
|
+
/**
|
|
38
|
+
* Forces a reinitialization of the ArvoOpenTelemetry instance.
|
|
39
|
+
* Use this method with caution as it will affect all existing traces and spans.
|
|
40
|
+
*
|
|
41
|
+
* @param {Object} config - Configuration object for reinitializing the instance
|
|
42
|
+
* @param {Tracer} [config.tracer] - Optional custom OpenTelemetry tracer instance
|
|
43
|
+
* @param {boolean} [config.force=false] - If true, skips active span checks
|
|
44
|
+
*
|
|
45
|
+
* @throws {Error} If there are active spans and force is not set to true
|
|
46
|
+
* @throws {Error} If called before instance initialization
|
|
47
|
+
*
|
|
48
|
+
* @example
|
|
49
|
+
* // Safe reinitialization
|
|
50
|
+
* const customTracer = trace.getTracer('new-tracer', '2.0.0');
|
|
51
|
+
* ArvoOpenTelemetry.reinitialize({ tracer: customTracer });
|
|
52
|
+
*/
|
|
53
|
+
static reinitialize(config: {
|
|
54
|
+
tracer?: Tracer;
|
|
55
|
+
force?: boolean;
|
|
56
|
+
}): void;
|
|
18
57
|
/**
|
|
19
58
|
* Creates and manages an active span for a given operation. This function provides two modes of operation:
|
|
20
59
|
* 1. Automatic span management (default): Handles span lifecycle, status, and error recording
|
|
@@ -39,8 +39,27 @@ var ArvoOpenTelemetry = /** @class */ (function () {
|
|
|
39
39
|
this.tracer = tracer !== null && tracer !== void 0 ? tracer : api_1.trace.getTracer('arvo-instrumentation', '1.0.0');
|
|
40
40
|
}
|
|
41
41
|
/**
|
|
42
|
-
* Gets the instance of ArvoOpenTelemetry
|
|
43
|
-
*
|
|
42
|
+
* Gets or creates the singleton instance of ArvoOpenTelemetry.
|
|
43
|
+
* This method ensures only one instance of ArvoOpenTelemetry exists throughout the application.
|
|
44
|
+
*
|
|
45
|
+
* @param {Object} [config] - Optional configuration object for initializing the instance
|
|
46
|
+
* @param {Tracer} [config.tracer] - Optional custom OpenTelemetry tracer instance.
|
|
47
|
+
* If not provided, defaults to a tracer with name 'arvo-instrumentation'
|
|
48
|
+
*
|
|
49
|
+
* @returns {ArvoOpenTelemetry} The singleton instance of ArvoOpenTelemetry
|
|
50
|
+
*
|
|
51
|
+
* @example
|
|
52
|
+
* // Get instance with default tracer
|
|
53
|
+
* const telemetry = ArvoOpenTelemetry.getInstance();
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* // Get instance with custom tracer
|
|
57
|
+
* const customTracer = trace.getTracer('custom-tracer', '2.0.0');
|
|
58
|
+
* const telemetry = ArvoOpenTelemetry.getInstance({ tracer: customTracer });
|
|
59
|
+
*
|
|
60
|
+
* @remarks
|
|
61
|
+
* The tracer configuration is only applied when creating a new instance.
|
|
62
|
+
* Subsequent calls with different tracer configurations will not modify the existing instance.
|
|
44
63
|
*/
|
|
45
64
|
ArvoOpenTelemetry.getInstance = function (config) {
|
|
46
65
|
if (ArvoOpenTelemetry.instance === null) {
|
|
@@ -48,6 +67,37 @@ var ArvoOpenTelemetry = /** @class */ (function () {
|
|
|
48
67
|
}
|
|
49
68
|
return ArvoOpenTelemetry.instance;
|
|
50
69
|
};
|
|
70
|
+
/**
|
|
71
|
+
* Forces a reinitialization of the ArvoOpenTelemetry instance.
|
|
72
|
+
* Use this method with caution as it will affect all existing traces and spans.
|
|
73
|
+
*
|
|
74
|
+
* @param {Object} config - Configuration object for reinitializing the instance
|
|
75
|
+
* @param {Tracer} [config.tracer] - Optional custom OpenTelemetry tracer instance
|
|
76
|
+
* @param {boolean} [config.force=false] - If true, skips active span checks
|
|
77
|
+
*
|
|
78
|
+
* @throws {Error} If there are active spans and force is not set to true
|
|
79
|
+
* @throws {Error} If called before instance initialization
|
|
80
|
+
*
|
|
81
|
+
* @example
|
|
82
|
+
* // Safe reinitialization
|
|
83
|
+
* const customTracer = trace.getTracer('new-tracer', '2.0.0');
|
|
84
|
+
* ArvoOpenTelemetry.reinitialize({ tracer: customTracer });
|
|
85
|
+
*/
|
|
86
|
+
ArvoOpenTelemetry.reinitialize = function (config) {
|
|
87
|
+
if (!ArvoOpenTelemetry.instance) {
|
|
88
|
+
throw new Error('Cannot reinitialize before initialization. Call getInstance first.');
|
|
89
|
+
}
|
|
90
|
+
// Check for active spans unless force is true
|
|
91
|
+
if (!config.force) {
|
|
92
|
+
var activeSpan = api_1.trace.getActiveSpan();
|
|
93
|
+
if (activeSpan) {
|
|
94
|
+
throw new Error('Cannot reinitialize while spans are active. ' +
|
|
95
|
+
'Either end all spans or use force: true (not recommended)');
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
// Create new instance
|
|
99
|
+
ArvoOpenTelemetry.instance = new ArvoOpenTelemetry(config.tracer);
|
|
100
|
+
};
|
|
51
101
|
/**
|
|
52
102
|
* Creates and manages an active span for a given operation. This function provides two modes of operation:
|
|
53
103
|
* 1. Automatic span management (default): Handles span lifecycle, status, and error recording
|
package/dist/index.d.ts
CHANGED
|
@@ -28,6 +28,7 @@ import { isWildCardArvoSematicVersion, WildCardArvoSemanticVersion } from './Arv
|
|
|
28
28
|
import { createSimpleArvoContract } from './ArvoContract/SimpleArvoContract';
|
|
29
29
|
import { SimpleArvoContract } from './ArvoContract/SimpleArvoContract/types';
|
|
30
30
|
import { ArvoOrchestratorEventFactory } from './ArvoEventFactory/Orchestrator';
|
|
31
|
+
import { ArvoContractViolationError } from './ArvoContract/errors';
|
|
31
32
|
/**
|
|
32
33
|
* Collection of Zod schemas for validating various aspects of Arvo events.
|
|
33
34
|
* @property {z.ZodObject} CloudEventContextSchema - Schema for core CloudEvent properties.
|
|
@@ -102,4 +103,4 @@ declare const ArvoEventSchema: {
|
|
|
102
103
|
parentSubject$$: string | null;
|
|
103
104
|
}>;
|
|
104
105
|
};
|
|
105
|
-
export { ArvoEvent, createArvoEvent, ArvoDataContentType, ArvoEventData, CloudEventExtension, ArvoEventSchema, CloudEventContext, ArvoExtension, OpenTelemetryExtension, CreateArvoEvent, exceptionToSpan, logToSpan, OpenTelemetryHeaders, TelemetryLogLevel, OTelNull, validateURI, cleanString, ArvoContract, createArvoContract, ArvoContractValidators, ArvoContractRecord, IArvoContract, ResolveArvoContractRecord, ArvoEventFactory, createArvoEventFactory, currentOpenTelemetryHeaders, OpenInference, OpenInferenceSpanKind, ArvoExecution, ArvoExecutionSpanKind, ArvoContractJSONSchema, ArvoOrchestrationSubject, ArvoOrchestrationSubjectContent, ArvoSemanticVersion, InferArvoEvent, createArvoOrchestratorContract, ICreateArvoOrchestratorContract, ArvoOrchestratorEventTypeGen, EventDataschemaUtil, ArvoOrchestrationSubjectContentSchema, ArvoSemanticVersionSchema, ArvoErrorSchema, ArvoErrorType, compareSemanticVersions, parseSemanticVersion, createSimpleArvoContract, ArvoOrchestratorContract, VersionedArvoContract, InferVersionedArvoContract, isWildCardArvoSematicVersion, WildCardArvoSemanticVersion, isValidArvoSemanticVersion, SimpleArvoContract, ArvoOrchestratorEventFactory, createArvoOrchestratorEventFactory, ArvoOpenTelemetry, };
|
|
106
|
+
export { ArvoEvent, createArvoEvent, ArvoDataContentType, ArvoEventData, CloudEventExtension, ArvoEventSchema, CloudEventContext, ArvoExtension, OpenTelemetryExtension, CreateArvoEvent, exceptionToSpan, logToSpan, OpenTelemetryHeaders, TelemetryLogLevel, OTelNull, validateURI, cleanString, ArvoContract, ArvoContractViolationError, createArvoContract, ArvoContractValidators, ArvoContractRecord, IArvoContract, ResolveArvoContractRecord, ArvoEventFactory, createArvoEventFactory, currentOpenTelemetryHeaders, OpenInference, OpenInferenceSpanKind, ArvoExecution, ArvoExecutionSpanKind, ArvoContractJSONSchema, ArvoOrchestrationSubject, ArvoOrchestrationSubjectContent, ArvoSemanticVersion, InferArvoEvent, createArvoOrchestratorContract, ICreateArvoOrchestratorContract, ArvoOrchestratorEventTypeGen, EventDataschemaUtil, ArvoOrchestrationSubjectContentSchema, ArvoSemanticVersionSchema, ArvoErrorSchema, ArvoErrorType, compareSemanticVersions, parseSemanticVersion, createSimpleArvoContract, ArvoOrchestratorContract, VersionedArvoContract, InferVersionedArvoContract, isWildCardArvoSematicVersion, WildCardArvoSemanticVersion, isValidArvoSemanticVersion, SimpleArvoContract, ArvoOrchestratorEventFactory, createArvoOrchestratorEventFactory, ArvoOpenTelemetry, };
|
package/dist/index.js
CHANGED
|
@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
3
3
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
4
|
};
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
exports.ArvoOpenTelemetry = exports.createArvoOrchestratorEventFactory = exports.ArvoOrchestratorEventFactory = exports.isValidArvoSemanticVersion = exports.WildCardArvoSemanticVersion = exports.isWildCardArvoSematicVersion = exports.VersionedArvoContract = exports.createSimpleArvoContract = exports.parseSemanticVersion = exports.compareSemanticVersions = exports.ArvoErrorSchema = exports.ArvoSemanticVersionSchema = exports.ArvoOrchestrationSubjectContentSchema = exports.EventDataschemaUtil = exports.ArvoOrchestratorEventTypeGen = exports.createArvoOrchestratorContract = exports.ArvoOrchestrationSubject = exports.ArvoExecutionSpanKind = exports.ArvoExecution = exports.OpenInferenceSpanKind = exports.OpenInference = exports.currentOpenTelemetryHeaders = exports.createArvoEventFactory = exports.ArvoEventFactory = exports.ArvoContractValidators = exports.createArvoContract = exports.ArvoContract = exports.cleanString = exports.validateURI = exports.OTelNull = exports.logToSpan = exports.exceptionToSpan = exports.ArvoEventSchema = exports.ArvoDataContentType = exports.createArvoEvent = exports.ArvoEvent = void 0;
|
|
6
|
+
exports.ArvoOpenTelemetry = exports.createArvoOrchestratorEventFactory = exports.ArvoOrchestratorEventFactory = exports.isValidArvoSemanticVersion = exports.WildCardArvoSemanticVersion = exports.isWildCardArvoSematicVersion = exports.VersionedArvoContract = exports.createSimpleArvoContract = exports.parseSemanticVersion = exports.compareSemanticVersions = exports.ArvoErrorSchema = exports.ArvoSemanticVersionSchema = exports.ArvoOrchestrationSubjectContentSchema = exports.EventDataschemaUtil = exports.ArvoOrchestratorEventTypeGen = exports.createArvoOrchestratorContract = exports.ArvoOrchestrationSubject = exports.ArvoExecutionSpanKind = exports.ArvoExecution = exports.OpenInferenceSpanKind = exports.OpenInference = exports.currentOpenTelemetryHeaders = exports.createArvoEventFactory = exports.ArvoEventFactory = exports.ArvoContractValidators = exports.createArvoContract = exports.ArvoContractViolationError = exports.ArvoContract = exports.cleanString = exports.validateURI = exports.OTelNull = exports.logToSpan = exports.exceptionToSpan = exports.ArvoEventSchema = exports.ArvoDataContentType = exports.createArvoEvent = exports.ArvoEvent = void 0;
|
|
7
7
|
var ArvoEvent_1 = __importDefault(require("./ArvoEvent"));
|
|
8
8
|
exports.ArvoEvent = ArvoEvent_1.default;
|
|
9
9
|
var schema_1 = require("./ArvoEvent/schema");
|
|
@@ -63,6 +63,8 @@ var SimpleArvoContract_1 = require("./ArvoContract/SimpleArvoContract");
|
|
|
63
63
|
Object.defineProperty(exports, "createSimpleArvoContract", { enumerable: true, get: function () { return SimpleArvoContract_1.createSimpleArvoContract; } });
|
|
64
64
|
var Orchestrator_1 = require("./ArvoEventFactory/Orchestrator");
|
|
65
65
|
Object.defineProperty(exports, "ArvoOrchestratorEventFactory", { enumerable: true, get: function () { return Orchestrator_1.ArvoOrchestratorEventFactory; } });
|
|
66
|
+
var errors_1 = require("./ArvoContract/errors");
|
|
67
|
+
Object.defineProperty(exports, "ArvoContractViolationError", { enumerable: true, get: function () { return errors_1.ArvoContractViolationError; } });
|
|
66
68
|
/**
|
|
67
69
|
* Collection of Zod schemas for validating various aspects of Arvo events.
|
|
68
70
|
* @property {z.ZodObject} CloudEventContextSchema - Schema for core CloudEvent properties.
|