autotel-aws 0.13.13 → 0.13.14

package/dist/step-functions.d.cts

@@ -1,145 +1,89 @@
-import { TraceContext } from 'autotel';
-import { SpanContext } from '@opentelemetry/api';
-
-/**
- * Step Functions instrumentation
- *
- * Provides semantic helpers for tracing AWS Step Functions operations
- * with context propagation for distributed tracing across state machines.
- *
- * @example Start workflow with trace context
- * ```typescript
- * import { StepFunctionsExecutor, injectTraceContext } from 'autotel-aws/step-functions';
- * import { SFNClient } from '@aws-sdk/client-sfn';
- *
- * const sfn = new SFNClient({});
- * const executor = new StepFunctionsExecutor(sfn, {
- *   stateMachineArn: 'arn:aws:states:us-east-1:123456789:stateMachine:OrderProcessor'
- * });
- *
- * // Start execution with automatic trace context injection
- * const result = await executor.startExecution({
- *   input: { orderId: '123', items: [...] },
- *   name: 'order-123-execution'
- * });
- * ```
- *
- * @example Extract context in Lambda invoked by Step Functions
- * ```typescript
- * import { extractStepFunctionsContext } from 'autotel-aws/step-functions';
- * import { wrapHandler } from 'autotel-aws/lambda';
- *
- * export const handler = wrapHandler(async (event) => {
- *   // Extract trace context from Step Functions input
- *   const parentContext = extractStepFunctionsContext(event);
- *
- *   // Process the order (without the trace context fields)
- *   const { orderId, items } = event;
- *   await processOrder(orderId, items);
- *
- *   return { status: 'completed' };
- * });
- * ```
- *
- * @example Activity worker with context propagation
- * ```typescript
- * import { StepFunctionsActivityWorker } from 'autotel-aws/step-functions';
- *
- * const worker = new StepFunctionsActivityWorker(sfn, {
- *   activityArn: 'arn:aws:states:us-east-1:123456789:activity:ProcessPayment'
- * });
- *
- * // Worker extracts trace context and creates child spans
- * await worker.poll(async (input, taskToken, ctx) => {
- *   ctx.setAttribute('payment.amount', input.amount);
- *   const result = await processPayment(input);
- *   return result;
- * });
- * ```
- */
+import { TraceContext } from "autotel";
+import { SpanContext } from "@opentelemetry/api";
 
+//#region src/step-functions/index.d.ts
 /**
  * Step Functions operation configuration
  */
 interface TraceStepFunctionConfig {
-    /**
-     * State machine ARN
-     * Sets `aws.stepfunctions.state_machine_arn` attribute.
-     */
-    stateMachineArn: string;
-    /**
-     * Operation type
-     * Used to generate the span name: `stepfunctions.{operation}`
-     * @default 'execute'
-     */
-    operation?: 'StartExecution' | 'DescribeExecution' | 'StopExecution' | 'ListExecutions' | 'SendTaskSuccess' | 'SendTaskFailure' | 'execute';
+  /**
+   * State machine ARN
+   * Sets `aws.stepfunctions.state_machine_arn` attribute.
+   */
+  stateMachineArn: string;
+  /**
+   * Operation type
+   * Used to generate the span name: `stepfunctions.{operation}`
+   * @default 'execute'
+   */
+  operation?: 'StartExecution' | 'DescribeExecution' | 'StopExecution' | 'ListExecutions' | 'SendTaskSuccess' | 'SendTaskFailure' | 'execute';
 }
 /**
  * Configuration for StepFunctionsExecutor
  */
 interface StepFunctionsExecutorConfig {
-    /**
-     * State machine ARN
-     */
-    stateMachineArn: string;
-    /**
-     * Inject W3C Trace Context into execution input
-     * @default true
-     */
-    injectTraceContext?: boolean;
-    /**
-     * Optional service name for tracing
-     */
-    service?: string;
+  /**
+   * State machine ARN
+   */
+  stateMachineArn: string;
+  /**
+   * Inject W3C Trace Context into execution input
+   * @default true
+   */
+  injectTraceContext?: boolean;
+  /**
+   * Optional service name for tracing
+   */
+  service?: string;
 }
 /**
  * Execution input with optional trace context
  */
 interface ExecutionInput<T = Record<string, unknown>> {
-    /**
-     * The input data for the execution
-     */
-    input: T;
-    /**
-     * Optional execution name (must be unique within 90 days)
-     */
-    name?: string;
-    /**
-     * Optional trace ID for idempotency
-     */
-    traceHeader?: string;
+  /**
+   * The input data for the execution
+   */
+  input: T;
+  /**
+   * Optional execution name (must be unique within 90 days)
+   */
+  name?: string;
+  /**
+   * Optional trace ID for idempotency
+   */
+  traceHeader?: string;
 }
 /**
  * Configuration for StepFunctionsActivityWorker
  */
 interface StepFunctionsActivityWorkerConfig {
-    /**
-     * Activity ARN
-     */
-    activityArn: string;
-    /**
-     * Worker name for identification
-     */
-    workerName?: string;
-    /**
-     * Extract trace context from activity input
-     * @default true
-     */
-    extractTraceContext?: boolean;
-    /**
-     * Optional service name for tracing
-     */
-    service?: string;
+  /**
+   * Activity ARN
+   */
+  activityArn: string;
+  /**
+   * Worker name for identification
+   */
+  workerName?: string;
+  /**
+   * Extract trace context from activity input
+   * @default true
+   */
+  extractTraceContext?: boolean;
+  /**
+   * Optional service name for tracing
+   */
+  service?: string;
 }
 /**
  * Trace context fields injected into Step Functions input
  */
 interface TraceContextFields {
-    _traceContext?: {
-        traceparent: string;
-        tracestate?: string;
-        baggage?: string;
-    };
+  _traceContext?: {
+    traceparent: string;
+    tracestate?: string;
+    baggage?: string;
+  };
 }
 /**
  * Inject W3C Trace Context into Step Functions execution input
@@ -277,70 +221,70 @@ declare function traceStepFunction(config: TraceStepFunctionConfig): <TArgs exte
  * ```
  */
 declare class StepFunctionsExecutor<TClient extends {
-    send: (command: any) => Promise<any>;
+  send: (command: any) => Promise<any>;
 } = any> {
-    private client;
-    private config;
-    private stateMachineName;
-    constructor(client: TClient, config: StepFunctionsExecutorConfig);
-    /**
-     * Start a new execution of the state machine
-     *
-     * @param execution - Execution input and optional name
-     * @returns Promise with execution ARN and start date
-     */
-    startExecution<T extends Record<string, unknown>>(execution: ExecutionInput<T>): Promise<{
-        executionArn?: string;
-        startDate?: Date;
-    }>;
-    /**
-     * Start a synchronous execution (Express workflows only)
-     *
-     * @param execution - Execution input and optional name
-     * @returns Promise with execution result including output
-     */
-    startSyncExecution<T extends Record<string, unknown>>(execution: ExecutionInput<T>): Promise<{
-        executionArn?: string;
-        status?: 'SUCCEEDED' | 'FAILED' | 'TIMED_OUT';
-        output?: string;
-        error?: string;
-        cause?: string;
-        billingDetails?: {
-            billedMemoryUsedInMB?: number;
-            billedDurationInMilliseconds?: number;
-        };
-    }>;
-    /**
-     * Describe an execution
-     *
-     * @param executionArn - ARN of the execution to describe
-     * @returns Promise with execution details
-     */
-    describeExecution(executionArn: string): Promise<{
-        executionArn?: string;
-        stateMachineArn?: string;
-        name?: string;
-        status?: string;
-        startDate?: Date;
-        stopDate?: Date;
-        input?: string;
-        output?: string;
-        error?: string;
-        cause?: string;
-    }>;
-    /**
-     * Stop an execution
-     *
-     * @param executionArn - ARN of the execution to stop
-     * @param options - Optional error and cause for the stop
-     * @returns Promise with stop date
-     */
-    stopExecution(executionArn: string, options?: {
-        error?: string;
-        cause?: string;
-    }): Promise<{
-        stopDate?: Date;
-    }>;
+  private client;
+  private config;
+  private stateMachineName;
+  constructor(client: TClient, config: StepFunctionsExecutorConfig);
+  /**
+   * Start a new execution of the state machine
+   *
+   * @param execution - Execution input and optional name
+   * @returns Promise with execution ARN and start date
+   */
+  startExecution<T extends Record<string, unknown>>(execution: ExecutionInput<T>): Promise<{
+    executionArn?: string;
+    startDate?: Date;
+  }>;
+  /**
+   * Start a synchronous execution (Express workflows only)
+   *
+   * @param execution - Execution input and optional name
+   * @returns Promise with execution result including output
+   */
+  startSyncExecution<T extends Record<string, unknown>>(execution: ExecutionInput<T>): Promise<{
+    executionArn?: string;
+    status?: 'SUCCEEDED' | 'FAILED' | 'TIMED_OUT';
+    output?: string;
+    error?: string;
+    cause?: string;
+    billingDetails?: {
+      billedMemoryUsedInMB?: number;
+      billedDurationInMilliseconds?: number;
+    };
+  }>;
+  /**
+   * Describe an execution
+   *
+   * @param executionArn - ARN of the execution to describe
+   * @returns Promise with execution details
+   */
+  describeExecution(executionArn: string): Promise<{
+    executionArn?: string;
+    stateMachineArn?: string;
+    name?: string;
+    status?: string;
+    startDate?: Date;
+    stopDate?: Date;
+    input?: string;
+    output?: string;
+    error?: string;
+    cause?: string;
+  }>;
+  /**
+   * Stop an execution
+   *
+   * @param executionArn - ARN of the execution to stop
+   * @param options - Optional error and cause for the stop
+   * @returns Promise with stop date
+   */
+  stopExecution(executionArn: string, options?: {
+    error?: string;
+    cause?: string;
+  }): Promise<{
+    stopDate?: Date;
+  }>;
 }
 /**
  * Step Functions Activity Worker with trace context extraction
@@ -389,35 +333,36 @@ declare class StepFunctionsExecutor<TClient extends {
  * ```
  */
 declare class StepFunctionsActivityWorker<TClient extends {
-    send: (command: any) => Promise<any>;
+  send: (command: any) => Promise<any>;
 } = any> {
-    private client;
-    private config;
-    private activityName;
-    constructor(client: TClient, config: StepFunctionsActivityWorkerConfig);
-    /**
-     * Poll for an activity task and process it
-     *
-     * @param processor - Function to process the task input
-     * @returns Promise that resolves when the task is processed
-     */
-    poll<TInput extends Record<string, unknown>, TOutput>(processor: (input: TInput, taskToken: string, ctx: TraceContext) => Promise<TOutput>): Promise<void>;
-    /**
-     * Send a task heartbeat
-     *
-     * For long-running activities, send heartbeats to prevent timeout.
-     *
-     * @param taskToken - The task token from GetActivityTask
-     */
-    sendHeartbeat(taskToken: string): Promise<void>;
-    /**
-     * Send task failure
-     *
-     * @param taskToken - The task token from GetActivityTask
-     * @param error - Error code
-     * @param cause - Error cause description
-     */
-    sendFailure(taskToken: string, error: string, cause?: string): Promise<void>;
+  private client;
+  private config;
+  private activityName;
+  constructor(client: TClient, config: StepFunctionsActivityWorkerConfig);
+  /**
+   * Poll for an activity task and process it
+   *
+   * @param processor - Function to process the task input
+   * @returns Promise that resolves when the task is processed
+   */
+  poll<TInput extends Record<string, unknown>, TOutput>(processor: (input: TInput, taskToken: string, ctx: TraceContext) => Promise<TOutput>): Promise<void>;
+  /**
+   * Send a task heartbeat
+   *
+   * For long-running activities, send heartbeats to prevent timeout.
+   *
+   * @param taskToken - The task token from GetActivityTask
+   */
+  sendHeartbeat(taskToken: string): Promise<void>;
+  /**
+   * Send task failure
+   *
+   * @param taskToken - The task token from GetActivityTask
+   * @param error - Error code
+   * @param cause - Error cause description
+   */
+  sendFailure(taskToken: string, error: string, cause?: string): Promise<void>;
 }
-
-export { type ExecutionInput, StepFunctionsActivityWorker, type StepFunctionsActivityWorkerConfig, StepFunctionsExecutor, type StepFunctionsExecutorConfig, type TraceStepFunctionConfig, extractStepFunctionsContext, injectTraceContext, stripTraceContext, traceStepFunction };
+//#endregion
+export { ExecutionInput, StepFunctionsActivityWorker, StepFunctionsActivityWorkerConfig, StepFunctionsExecutor, StepFunctionsExecutorConfig, TraceStepFunctionConfig, extractStepFunctionsContext, injectTraceContext, stripTraceContext, traceStepFunction };
+//# sourceMappingURL=step-functions.d.cts.map

package/dist/step-functions.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"step-functions.d.cts","names":[],"sources":["../src/step-functions/index.ts"],"mappings":";;;;;;;UAsEiB,uBAAA;EA+Hf;;;;EA1HA,eAAA;EAkKc;;;;AAEF;EA7JZ,SAAS;AAAA;;;;UAaM,2BAAA;EAuMd;;;EAnMD,eAAA;EAiM0C;;;;EA3L1C,kBAAA;EA6LO;AAAA;AA0CT;EAlOE,OAAA;AAAA;;;;UAMe,cAAA,KAAmB,MAAA;EAgOe;;;EA5NjD,KAAA,EAAO,CAAC;EA6NsB;;;EAxN9B,IAAA;EAsNwB;;;EAjNxB,WAAA;AAAA;;;;UAMe,iCAAA;EA6MR;;;EAzMP,WAAA;EAyMsC;AAAA;AAiExC;EArQE,UAAA;EAqQgC;;;;EA/PhC,mBAAA;EAyR4B;;;EApR5B,OAAA;AAAA;;;;UAMQ,kBAAA;EACR,aAAA;IACE,WAAA;IACA,UAAA;IACA,OAAA;EAAA;AAAA;;;;;;;;;;;;;;;;;;;;;;;iBA8BY,kBAAA,WAA6B,MAAA,mBAC3C,KAAA,EAAO,CAAA,GACN,CAAA,GAAI,kBAAA;;;;;;;;;;;;;;;;;;;;;;iBAuCS,2BAAA,CACd,KAAA,YACC,WAAW;;;;;;;;;;;;;;;;iBAqDE,iBAAA,WAA4B,MAAA,mBAC1C,KAAA,EAAO,CAAA,GACN,IAAA,CAAK,CAAA;AA6VsB;AAmF9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAnF8B,iBAnTd,iBAAA,CAAkB,MAAA,EAAQ,uBAAA,sCAItC,EAAA,GAAK,GAAA,EAAK,YAAA,SAAqB,IAAA,EAAM,KAAA,KAAU,OAAA,CAAQ,OAAA,UAClD,IAAA,EAAM,KAAA,KAAU,OAAA,CAAQ,OAAA;;;;;;;;;;;;;;;;;;AA2gBrB;;;;;;;;;;;;;;;;;;;;;;;cA1cC,qBAAA;EAEO,IAAA,GAAO,OAAA,UAAiB,OAAA;AAAA;EAAA,QAElC,MAAA;EAAA,QACA,MAAA;EAAA,QAEA,gBAAA;cAEI,MAAA,EAAQ,OAAA,EAAS,MAAA,EAAQ,2BAAA;;;;;;;EAgB/B,cAAA,WAAyB,MAAA,mBAC7B,SAAA,EAAW,cAAA,CAAe,CAAA,IACzB,OAAA;IACD,YAAA;IACA,SAAA,GAAY,IAAA;EAAA;;;;;;;EAwDR,kBAAA,WAA6B,MAAA,mBACjC,SAAA,EAAW,cAAA,CAAe,CAAA,IACzB,OAAA;IACD,YAAA;IACA,MAAA;IACA,MAAA;IACA,KAAA;IACA,KAAA;IACA,cAAA;MACE,oBAAA;MACA,4BAAA;IAAA;EAAA;;;;;;;EA8EE,iBAAA,CAAkB,YAAA,WAAuB,OAAA;IAC7C,YAAA;IACA,eAAA;IACA,IAAA;IACA,MAAA;IACA,SAAA,GAAY,IAAA;IACZ,QAAA,GAAW,IAAA;IACX,KAAA;IACA,MAAA;IACA,KAAA;IACA,KAAA;EAAA;;;;;;;;EAmDI,aAAA,CACJ,YAAA,UACA,OAAA;IAAY,KAAA;IAAgB,KAAA;EAAA,IAC3B,OAAA;IAAU,QAAA,GAAW,IAAA;EAAA;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAmFb,2BAAA;EAEO,IAAA,GAAO,OAAA,UAAiB,OAAA;AAAA;EAAA,QAElC,MAAA;EAAA,QACA,MAAA;EAAA,QAEA,YAAA;cAEI,MAAA,EAAQ,OAAA,EAAS,MAAA,EAAQ,iCAAA;;;;;;;EAgB/B,IAAA,gBAAoB,MAAA,4BACxB,SAAA,GACE,KAAA,EAAO,MAAA,EACP,SAAA,UACA,GAAA,EAAK,YAAA,KACF,OAAA,CAAQ,OAAA,IACZ,OAAA;;;;;;;;EA6EG,aAAA,CAAc,SAAA,WAAoB,OAAA;;;;;;;;EA0BlC,WAAA,CACJ,SAAA,UACA,KAAA,UACA,KAAA,YACC,OAAA;AAAA"}