fix: Add tracestate to the TransactionOptions TypeScript type (#3063

)

This is the options parameter to `apm.startTransaction(..., options)`.

Fixes: #3061

CHANGELOG.asciidoc

@@ -49,6 +49,9 @@ Notes:
 [float]
 ===== Bug fixes
 
+* Add `tracestate` to the `TransactionOptions` TypeScript type for
+  `apm.startTransaction(..., options)`. ({issues}3061[#3061])
+
 [float]
 ===== Chores
 

docs/agent-api.asciidoc

@@ -517,7 +517,9 @@ Sub-millisecond precision can be achieved using decimals.
 If not provided,
 the current time will be used
 
-** `childOf` +{type-string}+ The traceparent header received from a remote service.
+** `childOf` +{type-string}+ A W3C trace-context "traceparent" string, typically received from a remote service call.
+
+** `tracestate` +{type-string}+ A W3C trace-context "tracestate" string.
 
 ** `links` +{type-array}+ Span links.
 A transaction can refer to zero or more other transactions or spans (separate

index.d.ts

@@ -375,7 +375,10 @@ declare namespace apm {
 
   export interface TransactionOptions {
     startTime?: number;
+    // `childOf` is a W3C trace-context 'traceparent' string. Passing a
+    // Transaction or Span is deprecated.
     childOf?: Transaction | Span | string;
+    tracestate?: string; // A W3C trace-context 'tracestate' string.
     links?: Link[];
   }
 

test/types/index.ts

@@ -100,6 +100,8 @@ apm.startTransaction('foo', { startTime: 1 })
 apm.startTransaction('foo', 'type', { startTime: 1 })
 apm.startTransaction('foo', 'type', 'subtype', { startTime: 1 })
 apm.startTransaction('foo', 'type', 'subtype', 'action', { startTime: 1 })
+apm.startTransaction('foo', { childOf: '00-12345678901234567890123456789012-1234567890123456-01' })
+apm.startTransaction('foo', { tracestate: 'foo=42,bar=43' })
 apm.startTransaction('foo', { links: [{ context: '00-12345678901234567890123456789012-1234567890123456-01' }] })
 
 apm.setTransactionName('foo')