@loadstrike/loadstrike-sdk 1.0.20801 → 1.0.21101

package/dist/types/cluster.d.ts

@@ -1,5 +1,9 @@
 export interface ClusterScenarioDispatch {
     scenarioNames: string[];
+    commandId?: string;
+    agentRunToken?: string;
+    agentIndex?: number;
+    agentCount?: number;
 }
 export interface ClusterNodeResult {
     nodeId: string;
@@ -20,6 +24,10 @@ export interface ClusterCoordinatorOptions {
 }
 export declare class LocalClusterCoordinator {
     private readonly options;
+    /**
+     * Exposes the public constructor operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     constructor(options?: ClusterCoordinatorOptions);
     dispatch(agents: ClusterAgent[], scenarioNames: string[], assignmentOptions?: ClusterAssignmentOptions): Promise<{
         nodeResults: ClusterNodeResult[];
@@ -37,6 +45,9 @@ export interface ClusterAssignmentOptions {
     agentTargets?: Array<string[] | undefined>;
     agentWeights?: number[];
 }
+/**
+ * Exposes the plan agent scenario assignments operation. Use this when interacting with the SDK through this surface.
+ */
 export declare function planAgentScenarioAssignments(scenarioNames: string[], agentCount: number, options?: ClusterAssignmentOptions): string[][];
 export interface ClusterRunCommandMessage {
     commandId: string;
@@ -46,6 +57,7 @@ export interface ClusterRunCommandMessage {
     agentIndex: number;
     agentCount: number;
     targetScenarios: string[];
+    agentRunToken?: string;
     replySubject?: string;
 }
 export interface ClusterNodeStatsPayload {
@@ -91,8 +103,12 @@ export interface DistributedClusterDispatchResult {
 }
 export declare class DistributedClusterCoordinator {
     private readonly options;
+    /**
+     * Exposes the public constructor operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     constructor(options: DistributedClusterCoordinatorOptions);
-    dispatch(assignments: string[][]): Promise<DistributedClusterDispatchResult>;
+    dispatch(assignments: string[][], buildAgentRunToken?: (command: ClusterRunCommandMessage) => Promise<string>): Promise<DistributedClusterDispatchResult>;
     private buildRunSubject;
     private buildReplySubject;
     private natsEndpoint;
@@ -107,6 +123,10 @@ export interface DistributedClusterAgentOptions {
 export declare class DistributedClusterAgent {
     private readonly options;
     private commandConsumer;
+    /**
+     * Exposes the public constructor operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     constructor(options: DistributedClusterAgentOptions);
     dispose(): Promise<void>;
     pollAndExecuteOnce(execute: (dispatch: ClusterScenarioDispatch) => Promise<ClusterNodeResult> | ClusterNodeResult): Promise<boolean>;

package/dist/types/correlation.d.ts

@@ -18,11 +18,31 @@ export declare class TrackingPayloadBuilder {
     JsonSettings?: Record<string, unknown>;
     JsonConvertSettings?: Record<string, unknown>;
     private body;
+    /**
+     * Exposes the public constructor operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     constructor();
     get Body(): Uint8Array;
+    /**
+     * Sets the payload body on the builder.
+     * Use this when a tracking payload should be created from raw content.
+     */
     setBody(body: string | Uint8Array): void;
+    /**
+     * Sets the payload body on the builder.
+     * Use this when a tracking payload should be created from raw content.
+     */
     SetBody(body: string | Uint8Array): void;
+    /**
+     * Builds the configured payload or helper object.
+     * Use this when all builder inputs are ready to be materialized.
+     */
     build(): TrackingPayload;
+    /**
+     * Builds the configured payload or helper object.
+     * Use this when all builder inputs are ready to be materialized.
+     */
     Build(): TrackingPayload;
 }
 export declare class RedisCorrelationStoreOptions {
@@ -32,17 +52,49 @@ export declare class RedisCorrelationStoreOptions {
     EntryTtlSeconds: number;
     get EntryTtl(): number;
     set EntryTtl(value: number);
+    /**
+     * Exposes the public validate operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     validate(): void;
+    /**
+     * Exposes the public Validate operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     Validate(): void;
 }
 export declare class CorrelationStoreConfiguration {
     Kind: CorrelationStoreKind;
     Redis?: RedisCorrelationStoreOptions;
+    /**
+     * Creates an in-memory correlation store configuration.
+     * Use this when tracking state can stay local to the process.
+     */
     static inMemory(): CorrelationStoreConfiguration;
+    /**
+     * Creates an in-memory correlation store configuration.
+     * Use this when tracking state can stay local to the process.
+     */
     static InMemory(): CorrelationStoreConfiguration;
+    /**
+     * Creates a Redis-backed correlation store configuration.
+     * Use this when tracking state must survive across processes or cluster nodes.
+     */
     static redisStore(options: RedisCorrelationStoreOptions): CorrelationStoreConfiguration;
+    /**
+     * Creates a Redis-backed correlation store configuration.
+     * Use this when tracking state must survive across processes or cluster nodes.
+     */
     static RedisStore(options: RedisCorrelationStoreOptions): CorrelationStoreConfiguration;
+    /**
+     * Exposes the public validate operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     validate(): void;
+    /**
+     * Exposes the public Validate operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     Validate(): void;
 }
 export interface CorrelationEntry {
@@ -93,15 +145,55 @@ export declare class InMemoryCorrelationStore implements CorrelationStore {
     private readonly pendingByEventId;
     private readonly sourceOccurrences;
     private readonly destinationOccurrences;
+    /**
+     * Sets the current gauge value.
+     * Use this when the latest observed value should replace the previous one.
+     */
     set(entry: CorrelationEntry): void;
+    /**
+     * Exposes the public get operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     get(trackingId: string): CorrelationEntry | null;
+    /**
+     * Exposes the public delete operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     delete(trackingId: string): void;
+    /**
+     * Exposes the public all operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     all(): CorrelationEntry[];
+    /**
+     * Exposes the public collectExpired operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     collectExpired(nowMs?: number, maxCount?: number): CorrelationEntry[];
+    /**
+     * Exposes the public incrementSourceOccurrences operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     incrementSourceOccurrences(trackingId: string): number;
+    /**
+     * Exposes the public incrementDestinationOccurrences operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     incrementDestinationOccurrences(trackingId: string): number;
+    /**
+     * Exposes the public registerSource operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     registerSource(trackingId: string, sourceTimestampUtc: number): CorrelationEntry;
+    /**
+     * Exposes the public tryMatchDestination operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     tryMatchDestination(trackingId: string, destinationTimestampUtc: number): CorrelationEntry | null;
+    /**
+     * Exposes the public tryExpire operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     tryExpire(eventId: string): boolean;
 }
 type RedisLikeCorrelationClient = {
@@ -156,9 +248,25 @@ export declare class RedisCorrelationStore implements CorrelationStore {
 export declare class TrackingFieldSelector {
     readonly kind: "header" | "json";
     readonly path: string;
+    /**
+     * Exposes the public constructor operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     constructor(location: TrackingFieldLocation | "header" | "json", path: string);
+    /**
+     * Parses a selector or configuration expression.
+     * Use this when a tracking selector should be created from its text form.
+     */
     static parse(value: string): TrackingFieldSelector;
+    /**
+     * Parses a selector or configuration expression.
+     * Use this when a tracking selector should be created from its text form.
+     */
     static Parse(value: string): TrackingFieldSelector;
+    /**
+     * Attempts to parse a selector or configuration expression.
+     * Use this when invalid input should be handled without throwing.
+     */
     static tryParse(value: string): {
         success: true;
         selector: TrackingFieldSelector;
@@ -166,6 +274,10 @@ export declare class TrackingFieldSelector {
         success: false;
         selector: null;
     };
+    /**
+     * Attempts to parse a selector or configuration expression.
+     * Use this when invalid input should be handled without throwing.
+     */
     static TryParse(value: string): {
         success: true;
         selector: TrackingFieldSelector;
@@ -175,8 +287,20 @@ export declare class TrackingFieldSelector {
     };
     get Location(): "Header" | "Json";
     get Path(): string;
+    /**
+     * Extracts a value from the provided payload.
+     * Use this when a tracking selector should read data from a transport payload.
+     */
     extract(payload: TrackingPayload): string | null;
+    /**
+     * Exposes the public toString operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     toString(): string;
+    /**
+     * Exposes the public ToString operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     ToString(): string;
 }
 export interface CorrelationRuntimePlugin {
@@ -226,6 +350,10 @@ export declare class CrossPlatformTrackingRuntime {
     private duplicateDestinationCount;
     private totalLatencyMs;
     private readonly gathered;
+    /**
+     * Exposes the public constructor operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     constructor(options: CorrelationRuntimeOptions);
     onSourceProduced(payload: TrackingPayload, nowMs?: number): Promise<string | null>;
     onSourceProducedDetailed(payload: TrackingPayload, nowMs?: number): Promise<SourceProduceResult>;
@@ -235,6 +363,10 @@ export declare class CrossPlatformTrackingRuntime {
     sweepTimeoutEntries(nowMs?: number, batchSize?: number): Promise<CorrelationEntry[]>;
     getStats(): Promise<CorrelationRuntimeStats>;
     private resolveGatherKey;
+    /**
+     * Exposes the public isTimeoutCountedAsFailure operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     isTimeoutCountedAsFailure(): boolean;
     private resolveTrackingIdDisplay;
 }

package/dist/types/local.d.ts

@@ -24,12 +24,18 @@ export declare class LoadStrikeLocalClient {
     private readonly licensingApiBaseUrl;
     private readonly licenseValidationTimeoutMs;
     private readonly signingKeyCache;
+    /**
+     * Exposes the public constructor operation.
+     * Use this when the surrounding wrapper type makes this operation the clearest way to express your intent.
+     */
     constructor(options?: LoadStrikeLocalClientOptions);
     run(request: LoadStrikeRunRequest): Promise<LoadStrikeRunResponse>;
     acquireLicenseLease(request: LoadStrikeRunRequest): Promise<LicenseValidationSession>;
     releaseLicenseLease(session: LicenseValidationSession, request: LoadStrikeRunRequest): Promise<void>;
     private validateLicenseIfRequired;
     private verifySignedRunToken;
+    createAgentExecutionToken(controllerRunToken: string, sessionId: string, commandId: string, agentIndex: number, agentCount: number, targetScenarios: string[]): Promise<string>;
+    private verifySignedAgentExecutionToken;
     private getSigningKey;
     private sendRunTokenHeartbeat;
     private stopLicenseLeaseIfRequired;

package/dist/types/reporting.d.ts

@@ -15,9 +15,21 @@ declare function buildDotnetGroupedCorrelationSummaryHtml(rows: ReportRecord[],
 declare function buildDotnetUngroupedCorrelationSummaryHtml(rows: ReportRecord[], groupedChartKey: string): string;
 declare function buildDotnetPluginHints(plugin: ReportRecord): string;
 declare function buildDotnetHtmlTabs(nodeStats: ReportRecord): ReportTab[];
+/**
+ * Exposes the build dotnet txt report operation. Use this when interacting with the SDK through this surface.
+ */
 export declare function buildDotnetTxtReport(nodeStats: ReportRecord): string;
+/**
+ * Exposes the build dotnet csv report operation. Use this when interacting with the SDK through this surface.
+ */
 export declare function buildDotnetCsvReport(nodeStats: ReportRecord): string;
+/**
+ * Exposes the build dotnet markdown report operation. Use this when interacting with the SDK through this surface.
+ */
 export declare function buildDotnetMarkdownReport(nodeStats: ReportRecord): string;
+/**
+ * Exposes the build dotnet html report operation. Use this when interacting with the SDK through this surface.
+ */
 export declare function buildDotnetHtmlReport(nodeStats: ReportRecord): string;
 export declare const __loadstrikeTestExports: {
     buildDotnetFailedResponseContent: typeof buildDotnetFailedResponseContent;