@loadstrike/loadstrike-sdk 0.1.0

package/dist/types/correlation.d.ts

@@ -0,0 +1,234 @@
+export type TrackingFieldLocation = "Header" | "Json";
+export type CorrelationStoreKind = "InMemory" | "Redis";
+export interface TrackingPayload {
+    headers?: Record<string, string>;
+    body?: unknown;
+    producedUtc?: string;
+    consumedUtc?: string;
+    contentType?: string;
+    messagePayloadType?: string;
+    jsonSettings?: Record<string, unknown>;
+    jsonConvertSettings?: Record<string, unknown>;
+    getBodyAsUtf8?: () => string;
+}
+export declare class TrackingPayloadBuilder {
+    readonly Headers: Record<string, string>;
+    ContentType?: string;
+    MessagePayloadType?: string;
+    JsonSettings?: Record<string, unknown>;
+    JsonConvertSettings?: Record<string, unknown>;
+    private body;
+    constructor();
+    get Body(): Uint8Array;
+    setBody(body: string | Uint8Array): void;
+    SetBody(body: string | Uint8Array): void;
+    build(): TrackingPayload;
+    Build(): TrackingPayload;
+}
+export declare class RedisCorrelationStoreOptions {
+    ConnectionString: string;
+    Database: number;
+    KeyPrefix: string;
+    EntryTtlSeconds: number;
+    get EntryTtl(): number;
+    set EntryTtl(value: number);
+    validate(): void;
+    Validate(): void;
+}
+export declare class CorrelationStoreConfiguration {
+    Kind: CorrelationStoreKind;
+    Redis?: RedisCorrelationStoreOptions;
+    static inMemory(): CorrelationStoreConfiguration;
+    static InMemory(): CorrelationStoreConfiguration;
+    static redisStore(options: RedisCorrelationStoreOptions): CorrelationStoreConfiguration;
+    static RedisStore(options: RedisCorrelationStoreOptions): CorrelationStoreConfiguration;
+    validate(): void;
+    Validate(): void;
+}
+export interface CorrelationEntry {
+    trackingId: string;
+    eventId?: string;
+    sourceTimestampUtc?: number;
+    destinationTimestampUtc?: number | null;
+    producedUtc: number;
+    payload: TrackingPayload;
+}
+export interface GatheredRow {
+    total: number;
+    matched: number;
+    timedOut: number;
+}
+export interface SourceProduceResult {
+    trackingId: string;
+    eventId: string;
+    sourceTimestampUtc: number;
+    duplicateSource: boolean;
+}
+export interface DestinationConsumeResult {
+    trackingId: string;
+    eventId: string;
+    sourceTimestampUtc: number;
+    destinationTimestampUtc: number;
+    gatherKey: string;
+    matched: boolean;
+    duplicateDestination: boolean;
+    latencyMs: number;
+    message: string;
+}
+export interface CorrelationStore {
+    set(entry: CorrelationEntry): Promise<void> | void;
+    get(trackingId: string): Promise<CorrelationEntry | null> | CorrelationEntry | null;
+    delete(trackingId: string): Promise<void> | void;
+    all(): Promise<CorrelationEntry[]> | CorrelationEntry[];
+    collectExpired(nowMs?: number, maxCount?: number): Promise<CorrelationEntry[]> | CorrelationEntry[];
+    incrementSourceOccurrences(trackingId: string): Promise<number> | number;
+    incrementDestinationOccurrences(trackingId: string): Promise<number> | number;
+    registerSource(trackingId: string, sourceTimestampUtc: number): Promise<CorrelationEntry> | CorrelationEntry;
+    tryMatchDestination(trackingId: string, destinationTimestampUtc: number): Promise<CorrelationEntry | null> | CorrelationEntry | null;
+    tryExpire(eventId: string): Promise<boolean> | boolean;
+    close?(): Promise<void> | void;
+}
+export declare class InMemoryCorrelationStore implements CorrelationStore {
+    private readonly pendingByTrackingId;
+    private readonly pendingByEventId;
+    private readonly sourceOccurrences;
+    private readonly destinationOccurrences;
+    set(entry: CorrelationEntry): void;
+    get(trackingId: string): CorrelationEntry | null;
+    delete(trackingId: string): void;
+    all(): CorrelationEntry[];
+    collectExpired(nowMs?: number, maxCount?: number): CorrelationEntry[];
+    incrementSourceOccurrences(trackingId: string): number;
+    incrementDestinationOccurrences(trackingId: string): number;
+    registerSource(trackingId: string, sourceTimestampUtc: number): CorrelationEntry;
+    tryMatchDestination(trackingId: string, destinationTimestampUtc: number): CorrelationEntry | null;
+    tryExpire(eventId: string): boolean;
+}
+type RedisLikeCorrelationClient = {
+    set?: (key: string, value: string) => Promise<unknown>;
+    get?: (key: string) => Promise<string | null>;
+    del?: (key: string) => Promise<unknown>;
+    keys?: (pattern: string) => Promise<string[]>;
+    close?: () => Promise<void>;
+};
+export declare class RedisCorrelationStore implements CorrelationStore {
+    private readonly fallback;
+    private readonly prefix;
+    private readonly pendingIndexKey;
+    private readonly entryTtlMs;
+    private readonly now;
+    private readonly fallbackExpiry;
+    private readonly client;
+    constructor(client?: RedisLikeCorrelationClient | null, prefix?: string, options?: {
+        entryTtlMs?: number;
+        now?: () => number;
+    });
+    static fromOptions(options: RedisCorrelationStoreOptions, runNamespace: string): RedisCorrelationStore;
+    set(entry: CorrelationEntry): Promise<void>;
+    get(trackingId: string): Promise<CorrelationEntry | null>;
+    delete(trackingId: string): Promise<void>;
+    all(): Promise<CorrelationEntry[]>;
+    collectExpired(nowMs?: number, maxCount?: number): Promise<CorrelationEntry[]>;
+    incrementSourceOccurrences(trackingId: string): Promise<number>;
+    incrementDestinationOccurrences(trackingId: string): Promise<number>;
+    registerSource(trackingId: string, sourceTimestampUtc: number): Promise<CorrelationEntry>;
+    tryMatchDestination(trackingId: string, destinationTimestampUtc: number): Promise<CorrelationEntry | null>;
+    tryExpire(eventId: string): Promise<boolean>;
+    close(): Promise<void>;
+    private trackFallbackExpiry;
+    private incrementCounter;
+    private readPendingIndexIds;
+    private writePendingIndexIds;
+    private appendPendingIndexId;
+    private removePendingIndexId;
+    private readQueue;
+    private writeQueue;
+    private enqueuePendingId;
+    private removePendingQueueId;
+    private readEntry;
+    private writeEntry;
+    private deleteEventKey;
+    private getQueueKey;
+    private getEventKey;
+    private getSourceOccurrencesKey;
+    private getDestinationOccurrencesKey;
+}
+export declare class TrackingFieldSelector {
+    readonly kind: "header" | "json";
+    readonly path: string;
+    constructor(location: TrackingFieldLocation | "header" | "json", path: string);
+    static parse(value: string): TrackingFieldSelector;
+    static Parse(value: string): TrackingFieldSelector;
+    static tryParse(value: string): {
+        success: true;
+        selector: TrackingFieldSelector;
+    } | {
+        success: false;
+        selector: null;
+    };
+    static TryParse(value: string): {
+        success: true;
+        selector: TrackingFieldSelector;
+    } | {
+        success: false;
+        selector: null;
+    };
+    get Location(): "Header" | "Json";
+    get Path(): string;
+    extract(payload: TrackingPayload): string | null;
+    toString(): string;
+    ToString(): string;
+}
+export interface CorrelationRuntimePlugin {
+    onProduced?: (trackingId: string, payload: TrackingPayload) => void | Promise<void>;
+    onMatched?: (trackingId: string, source: TrackingPayload, destination: TrackingPayload, latencyMs: number) => void | Promise<void>;
+    onTimeout?: (trackingId: string, source: TrackingPayload) => void | Promise<void>;
+}
+export interface CorrelationRuntimeOptions {
+    sourceTrackingField: string;
+    destinationTrackingField?: string;
+    destinationGatherByField?: string;
+    correlationTimeoutMs?: number;
+    timeoutCountsAsFailure?: boolean;
+    store?: CorrelationStore;
+    plugins?: CorrelationRuntimePlugin[];
+}
+export interface CorrelationRuntimeStats {
+    producedCount: number;
+    consumedCount: number;
+    matchedCount: number;
+    timeoutCount: number;
+    duplicateSourceCount: number;
+    duplicateDestinationCount: number;
+    inflightCount: number;
+    averageLatencyMs: number;
+    gathered: Record<string, GatheredRow>;
+}
+export declare class CrossPlatformTrackingRuntime {
+    private readonly sourceSelector;
+    private readonly destinationSelector;
+    private readonly gatherSelector;
+    private readonly timeoutMs;
+    private readonly timeoutCountsAsFailure;
+    private readonly store;
+    private readonly plugins;
+    private producedCount;
+    private consumedCount;
+    private matchedCount;
+    private timeoutCount;
+    private duplicateSourceCount;
+    private duplicateDestinationCount;
+    private totalLatencyMs;
+    private readonly gathered;
+    constructor(options: CorrelationRuntimeOptions);
+    onSourceProduced(payload: TrackingPayload, nowMs?: number): Promise<string | null>;
+    onSourceProducedDetailed(payload: TrackingPayload, nowMs?: number): Promise<SourceProduceResult>;
+    onDestinationConsumed(payload: TrackingPayload, nowMs?: number): Promise<boolean>;
+    onDestinationConsumedDetailed(payload: TrackingPayload, nowMs?: number): Promise<DestinationConsumeResult>;
+    sweepTimeouts(nowMs?: number, batchSize?: number): Promise<number>;
+    sweepTimeoutEntries(nowMs?: number, batchSize?: number): Promise<CorrelationEntry[]>;
+    getStats(): Promise<CorrelationRuntimeStats>;
+    private resolveGatherKey;
+    isTimeoutCountedAsFailure(): boolean;
+}
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1,13 @@
+export type { LoadStrikeDateValue, LoadStrikeObject, LoadStrikeRunContext as LoadStrikeContractRunContext, LoadStrikeScenarioSpec, LoadStrikeLoadSimulationSpec, LoadStrikeThresholdSpec, LoadStrikeTrackingConfigurationSpec, LoadStrikeCorrelationStoreSpec, LoadStrikeRedisCorrelationStoreSpec, LoadStrikeEndpointSpec, LoadStrikeHttpEndpointOptions, LoadStrikeHttpAuthOptions, LoadStrikeHttpOAuth2ClientCredentialsOptions, LoadStrikeKafkaEndpointOptions, LoadStrikeKafkaSaslOptions, LoadStrikeRabbitMqEndpointOptions, LoadStrikeNatsEndpointOptions, LoadStrikeRedisStreamsEndpointOptions, LoadStrikeAzureEventHubsEndpointOptions, LoadStrikeDelegateEndpointOptions, LoadStrikePushDiffusionEndpointOptions, LoadStrikeReportingSinkSpec, LoadStrikeInfluxDbSinkOptions, LoadStrikeTimescaleDbSinkOptions, LoadStrikeGrafanaLokiSinkOptions, LoadStrikeDatadogSinkOptions, LoadStrikeSplunkSinkOptions, LoadStrikeOtelCollectorSinkOptions, LoadStrikeWebhookSinkOptions, LoadStrikeWorkerPluginSpec, LoadStrikeRunRequest, LoadStrikeRunResponse, LoadStrikeNodeStatsDto, LoadStrikeNodeInfoDto, LoadStrikeTestInfoDto, LoadStrikeScenarioStatsDto, LoadStrikeStepStatsDto, LoadStrikeMeasurementStatsDto, LoadStrikeRequestStatsDto, LoadStrikeLatencyStatsDto, LoadStrikeDataTransferStatsDto, LoadStrikeStatusCodeStatsDto, LoadStrikeMetricStatsDto, LoadStrikeCounterStatsDto, LoadStrikeGaugeStatsDto, LoadStrikeThresholdResultDto, LoadStrikePluginDataDto, LoadStrikePluginDataTableDto, LoadStrikePayloadDto, LoadStrikeProducedMessageRequestDto, LoadStrikeProducedMessageResultDto, LoadStrikeConsumedMessageDto, LoadStrikeWebhookEnvelope, LoadStrikePluginCallbackResponse } from "./contracts.js";
+export { DEFAULT_LICENSING_API_BASE_URL, LoadStrikeLocalClient } from "./local.js";
+export type { LicenseValidationSession, LoadStrikeLocalClientOptions } from "./local.js";
+export { CrossPlatformScenarioConfigurator, ScenarioTrackingExtensions, LoadStrikeContext, LoadStrikePluginData, LoadStrikePluginDataTable, LoadStrikeReportData, LoadStrikeNodeType, LoadStrikeReportFormat, LoadStrikeResponse, LoadStrikeLogLevel, LoadStrikeScenarioOperation, LoadStrikeOperationType, LoadStrikeRunner, LoadStrikeScenario, LoadStrikeSimulation, LoadStrikeMetric, LoadStrikeCounter, LoadStrikeGauge, LoadStrikeStep, LoadStrikeThreshold } from "./runtime.js";
+export type { ILoadStrikeReportingSink, ILoadStrikeWorkerPlugin, LoadStrikeRunResult, LoadStrikeNodeStats, LoadStrikeReportingSink, LoadStrikeRuntimePolicy, LoadStrikeRunnerOptions, LoadStrikeRunContext as LoadStrikeRuntimeContext, LoadStrikeRunContext, LoadStrikeBaseContext, LoadStrikeCounterStats, LoadStrikeDataTransferStats, LoadStrikeGaugeStats, LoadStrikeLogger, LoadStrikeLoadSimulationStats, LoadStrikeMeasurementStats, LoadStrikeMetricStats, LoadStrikeNodeInfo, LoadStrikeMetricValue, LoadStrikeRandom, LoadStrikeReply, LoadStrikeLatencyCount, LoadStrikeLatencyStats, LoadStrikeLoadSimulation, LoadStrikeScenarioInfo, LoadStrikeScenarioInitContext, LoadStrikeScenarioPartition, LoadStrikeScenarioStartInfo, LoadStrikeScenarioContext, LoadStrikeScenarioStats, LoadStrikeTestInfo, LoadStrikeScenarioRuntime, LoadStrikeSessionStartInfo, LoadStrikeSinkSession, LoadStrikeSinkError, LoadStrikeStatusCodeStats, LoadStrikeThresholdResult, LoadStrikeThresholdPredicateContext, CrossPlatformTrackingConfiguration, LoadStrikeStepReply, LoadStrikeStepStats, LoadStrikeStepRuntime, LoadStrikeThresholdOptions, LoadStrikeRequestStats, LoadStrikeWorkerPlugin } from "./runtime.js";
+export { CorrelationStoreConfiguration, CrossPlatformTrackingRuntime, InMemoryCorrelationStore, RedisCorrelationStoreOptions, RedisCorrelationStore, TrackingPayloadBuilder, TrackingFieldSelector } from "./correlation.js";
+export type { CorrelationEntry, DestinationConsumeResult, GatheredRow, CorrelationStoreKind, CorrelationRuntimeOptions, CorrelationRuntimePlugin, CorrelationRuntimeStats, CorrelationStore, SourceProduceResult, TrackingFieldLocation, TrackingPayload } from "./correlation.js";
+export { EndpointAdapterFactory, TrafficEndpointDefinition, HttpEndpointDefinition, KafkaEndpointDefinition, KafkaSaslOptions, RabbitMqEndpointDefinition, NatsEndpointDefinition, RedisStreamsEndpointDefinition, AzureEventHubsEndpointDefinition, DelegateStreamEndpointDefinition, PushDiffusionEndpointDefinition, HttpOAuth2ClientCredentialsOptions, HttpAuthOptions } from "./transports.js";
+export type { EndpointAdapter, EndpointDefinition, EndpointDefinitionInput, EndpointKind, EndpointMode, DotNetDelegateEndpointOptions, DotNetEndpointDefinition, DotNetHttpAuthOptions, DotNetHttpEndpointOptions, DotNetHttpOAuth2ClientCredentialsOptions, HttpAuthMode, HttpAuthType, HttpRequestBodyType, HttpResponseSource, HttpTrackingPayloadSource, KafkaSaslMechanismType, KafkaSecurityProtocolType, HttpEndpointOptions, KafkaEndpointOptions, RabbitMqEndpointOptions, NatsEndpointOptions, RedisStreamsEndpointOptions, AzureEventHubsEndpointOptions, PushDiffusionEndpointOptions, TrackingFieldSelectorInput, TrackingRunMode, TrafficEndpointKind, TrafficEndpointMode, ProducedMessageRequest, ProducedMessageResult, ConsumedMessage, DelegateConsumeAsync, DelegateConsumeStreamHandler, DelegateEndpointOptions } from "./transports.js";
+export { DistributedClusterAgent, DistributedClusterCoordinator, LocalClusterCoordinator, planAgentScenarioAssignments } from "./cluster.js";
+export type { ClusterAgent, ClusterNodeResult, ClusterNodeStatsPayload, ClusterAssignmentOptions, ClusterRunCommandMessage, ClusterRunResultMessage, ClusterScenarioDispatch, DistributedClusterAgentOptions, DistributedClusterCoordinatorOptions, DistributedClusterDispatchResult } from "./cluster.js";
+export { CompositeReportingSink, ConsoleReportingSink, DatadogReportingSink, DatadogReportingSinkOptions, GrafanaLokiReportingSink, GrafanaLokiReportingSinkOptions, InfluxDbReportingSink, InfluxDbReportingSinkOptions, MemoryReportingSink, OtelCollectorReportingSink, OtelCollectorReportingSinkOptions, SplunkReportingSink, SplunkReportingSinkOptions, TimescaleDbReportingSink, TimescaleDbReportingSinkOptions } from "./sinks.js";
+export type { DatadogSinkOptions, GrafanaLokiSinkOptions, InfluxDbSinkOptions, OtelCollectorSinkOptions, SplunkSinkOptions, TimescaleDbSinkOptions } from "./sinks.js";

package/dist/types/local.d.ts

@@ -0,0 +1,30 @@
+import type { LoadStrikeRunRequest, LoadStrikeRunResponse } from "./contracts.js";
+export interface LoadStrikeLocalClientOptions {
+    licensingApiBaseUrl?: string;
+    licenseValidationTimeoutMs?: number;
+}
+export interface LicenseValidationSession {
+    runToken?: string;
+    sessionId?: string;
+    deviceHash?: string;
+    machineName?: string;
+    environmentClassification?: number;
+    heartbeatTimer?: ReturnType<typeof setInterval>;
+}
+export declare const DEFAULT_LICENSING_API_BASE_URL = "https://licensing.loadstrike.com";
+export declare class LoadStrikeLocalClient {
+    private readonly licensingApiBaseUrl;
+    private readonly licenseValidationTimeoutMs;
+    private readonly signingKeyCache;
+    constructor(options?: LoadStrikeLocalClientOptions);
+    run(request: LoadStrikeRunRequest): Promise<LoadStrikeRunResponse>;
+    acquireLicenseLease(request: LoadStrikeRunRequest): Promise<LicenseValidationSession>;
+    releaseLicenseLease(session: LicenseValidationSession, request: LoadStrikeRunRequest): Promise<void>;
+    private validateLicenseIfRequired;
+    private verifySignedRunToken;
+    private getSigningKey;
+    private sendRunTokenHeartbeat;
+    private stopLicenseLeaseIfRequired;
+    private postLicensingRequest;
+    private getLicensingRequest;
+}

package/dist/types/reporting.d.ts

@@ -0,0 +1,6 @@
+type ReportRecord = Record<string, any>;
+export declare function buildDotnetTxtReport(nodeStats: ReportRecord): string;
+export declare function buildDotnetCsvReport(nodeStats: ReportRecord): string;
+export declare function buildDotnetMarkdownReport(nodeStats: ReportRecord): string;
+export declare function buildDotnetHtmlReport(nodeStats: ReportRecord): string;
+export {};