@servicetitan/journey 2.1.0 → 3.0.0

package/dist/core/runtime.d.ts

@@ -1,13 +1,25 @@
-import { type AppRequestTimeouts } from './endpoint-policy';
-import type { JourneyDef, JourneyEvent, JourneySink, JourneyState, JourneyStepOptions, JourneyStepRef, JourneyStepTarget, Outcome, StepHandle, TagValue } from './types';
+import { type SlowRequestConfig } from './endpoint-policy';
+import type { RequestPolicyConfig } from './request-policy';
+import { type JourneyDef, type JourneyEngine, type JourneyEvent, type JourneySink, type JourneyState, type JourneyStepOptions, type JourneyStepTarget, type Outcome, type StepHandle, type StepRecord, type TagValue } from './types';
 /** @internal Private — not part of the public package API. */
 export interface JourneyRuntimeOptions {
+    /**
+     * DevTools label for this engine copy (`__stJourney.getDebugState().runtimes`).
+     * Auto-assigned `runtime-N` from the current `__stJourney` registration count
+     * when omitted at `registerJourneyRuntime`.
+     */
+    id?: string;
     /** Initial sinks. Defaults to `[]` — package bootstrap installs Datadog on the module runtime. */
     sinks?: readonly JourneySink[];
-    requestTimeouts?: AppRequestTimeouts;
+    slowRequests?: SlowRequestConfig;
+    /** Cap recorded steps; default 50. */
+    maxSteps?: number;
+    /** Default timeout when JourneyDef.timeoutMs is omitted. 0 disables idle countdown. */
+    defaultJourneyIdleMs?: number;
 }
 /** @internal Read-only snapshot for DevTools (`__stJourney.getDebugState`; empty unless debugging). */
 export interface JourneyRuntimeDebugSnapshot {
+    id: string;
     openJourneys: readonly {
         name: string;
         team: string;
@@ -22,12 +34,20 @@ export interface JourneyRuntimeDebugSnapshot {
             outcome: 'good' | 'bad';
             durationMs: number;
             reason?: string;
+            attributedRequestKeys?: readonly string[];
         }[];
     }[];
     activeStep: {
         journey: string;
         name: string;
     } | null;
+    /** Which shared policy knobs this runtime overrode (false = inherit global). */
+    policyOverlay: {
+        slowRequests: boolean;
+        httpAbortedRequests: boolean;
+        httpClientErrorRequests: boolean;
+        autoAttributeRequests: boolean;
+    };
 }
 /**
  * @internal Private — not part of the public package API.
@@ -36,25 +56,45 @@ export interface JourneyRuntimeDebugSnapshot {
  * bind to the module runtime. Prefer `resetJourney()` in tests.
  */
 export interface JourneyRuntime {
-    getRequestTimeouts(): AppRequestTimeouts;
-    setRequestTimeouts(next: AppRequestTimeouts): void;
+    /** DevTools id for this engine copy. Auto `runtime-N` when registered without an id. */
+    readonly id: string;
+    getSlowRequests(): SlowRequestConfig;
+    setSlowRequests(next: SlowRequestConfig): void;
+    getMaxSteps(): number;
+    setMaxSteps(next: number): void;
+    getDefaultJourneyIdleMs(): number;
+    setDefaultJourneyIdleMs(next: number): void;
     setSinks(next: readonly JourneySink[]): void;
+    /** First `configureJourney({ sinks })` on this runtime wins. Returns false if already set. */
+    trySetConfiguredSinks(next: readonly JourneySink[]): boolean;
     addSink(sink: JourneySink): void;
     emit(payload: JourneyEvent): void;
+    setPolicyOverlay(next: {
+        slowRequests?: SlowRequestConfig;
+        httpAbortedRequests?: RequestPolicyConfig;
+        httpClientErrorRequests?: RequestPolicyConfig;
+        autoAttributeRequests?: boolean;
+    }): void;
+    getAutoAttributeRequests(): boolean;
+    getHttpAbortedRequestsPolicy(): RequestPolicyConfig;
+    getHttpClientErrorRequestsPolicy(): RequestPolicyConfig;
     getOpenJourney(name: string): JourneyState | undefined;
     /** @internal DevTools snapshot of open journeys / ambient step. */
     getDebugSnapshot(): JourneyRuntimeDebugSnapshot;
-    firstOpenJourney(names: readonly string[]): string | null;
+    firstOpenJourneyName(names: readonly string[]): string | null;
     setJourneyTags(name: string | null, tags: Record<string, TagValue>): void;
-    startJourney(def: JourneyDef): void;
-    failJourneyNow(journey: JourneyState, reason: string): void;
-    failJourney(name: string, reason: string): void;
+    startJourney(config: JourneyDef): void;
+    failJourney(journey: JourneyState, reason: string): void;
     completeJourney(name: string | null, tags?: Record<string, TagValue>): void;
-    excludeJourney(name: string): void;
-    activeJourneyStep(): JourneyStepRef | null;
+    completeJourneyState(journey: JourneyState, tags?: Record<string, TagValue>): void;
+    excludeJourney(journey: JourneyState): void;
+    updateOpenJourney(config: JourneyDef): void;
+    activeJourneyStep(): StepRecord | null;
     journeyStep<T>(journey: JourneyStepTarget, stepName: string, fn: (step: StepHandle) => T | Promise<T>, opts?: JourneyStepOptions): Promise<T>;
     journeyMountStep<T>(journey: JourneyStepTarget, stepName: string, fn: (step: StepHandle) => T | Promise<T>, opts?: JourneyStepOptions): Promise<T>;
-    reportBackendRequest(step: JourneyStepRef | undefined, status: number | undefined, durationMs: number, requestKey: string): void;
+    reportBackendRequest(step: StepRecord | undefined, status: number | undefined, durationMs: number, requestKey: string): void;
+    /** True when this request key is ignored for the step's journey (never changes verdict). */
+    shouldIgnoreRequest(journey: JourneyState, key: string): boolean;
     /** Close open journeys, clear ambient steps, restore default timeouts/sinks. */
     reset(options?: JourneyRuntimeOptions): void;
 }
@@ -70,9 +110,19 @@ export declare function createJourneyRuntime(options?: JourneyRuntimeOptions): J
  */
 export declare const moduleRuntime: JourneyRuntime;
 /**
- * @internal Accidentally exported — removing it is a breaking change, so it stays
- * for compatibility. Not part of the supported public API.
- * Reset the module engine (open journeys, ambient steps, sinks, request thresholds).
+ * True when this bundle can fail/exclude/report the journey: stamped engine, or
+ * this runtime's own unstamped object. False for a foreign older-copy journey.
+ */
+export declare function canRouteHttpToJourney(journey: JourneyState): boolean;
+/**
+ * @internal Prefer the creating engine on a journey (MFE `step.stamp()` on a host transport).
+ * Falls back to this bundle's module runtime only when this runtime owns the object.
+ * Unstamped foreign journeys (older package copies) are a no-op so a same-named
+ * host journey is not deleted from this map.
+ */
+export declare function resolveJourneyEngine(journey: JourneyState): JourneyEngine;
+/**
+ * @internal Reset the module engine (open journeys, ambient steps, sinks, slow-request thresholds).
  * Intended for tests — call in `beforeEach` / `afterEach` instead of manual cleanup.
  */
 export declare function resetJourney(options?: JourneyRuntimeOptions): void;

package/dist/core/runtime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../../src/core/runtime.ts"],"names":[],"mappings":"AAAA,OAAO,EAGH,KAAK,kBAAkB,EAC1B,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EACR,UAAU,EACV,YAAY,EACZ,WAAW,EACX,YAAY,EAEZ,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,OAAO,EACP,UAAU,EAEV,QAAQ,EACX,MAAM,SAAS,CAAC;AAiBjB,8DAA8D;AAC9D,MAAM,WAAW,qBAAqB;IAClC,kGAAkG;IAClG,KAAK,CAAC,EAAE,SAAS,WAAW,EAAE,CAAC;IAC/B,eAAe,CAAC,EAAE,kBAAkB,CAAC;CACxC;AAED,uGAAuG;AACvG,MAAM,WAAW,2BAA2B;IACxC,YAAY,EAAE,SAAS;QACnB,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,OAAO,CAAC;QACjB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QACtB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAC/B,aAAa,EAAE,SAAS,MAAM,EAAE,CAAC;QACjC,KAAK,EAAE,SAAS;YACZ,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC;YACxB,UAAU,EAAE,MAAM,CAAC;YACnB,MAAM,CAAC,EAAE,MAAM,CAAC;SACnB,EAAE,CAAC;KACP,EAAE,CAAC;IACJ,UAAU,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;CACxD;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC3B,kBAAkB,IAAI,kBAAkB,CAAC;IACzC,kBAAkB,CAAC,IAAI,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEnD,QAAQ,CAAC,IAAI,EAAE,SAAS,WAAW,EAAE,GAAG,IAAI,CAAC;IAC7C,OAAO,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,CAAC;IACjC,IAAI,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI,CAAC;IAElC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAAC;IACvD,mEAAmE;IACnE,gBAAgB,IAAI,2BAA2B,CAAC;IAChD,gBAAgB,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,GAAG,IAAI,CAAC;IAC1D,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC;IAC1E,YAAY,CAAC,GAAG,EAAE,UAAU,GAAG,IAAI,CAAC;IACpC,cAAc,CAAC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5D,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAChD,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC;IAC5E,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,iBAAiB,IAAI,cAAc,GAAG,IAAI,CAAC;IAC3C,WAAW,CAAC,CAAC,EACT,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EACxC,IAAI,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,CAAC,CAAC,CAAC;IACd,gBAAgB,CAAC,CAAC,EACd,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EACxC,IAAI,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,CAAC,CAAC,CAAC;IAEd,oBAAoB,CAChB,IAAI,EAAE,cAAc,GAAG,SAAS,EAChC,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,GACnB,IAAI,CAAC;IAER,gFAAgF;IAChF,KAAK,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;CAChD;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,GAAE,qBAA0B,GAAG,cAAc,CAkZxF;AAED;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,cAAuC,CAAC;AAEpE;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAElE"}
+{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../../src/core/runtime.ts"],"names":[],"mappings":"AAQA,OAAO,EAGH,KAAK,iBAAiB,EACzB,MAAM,mBAAmB,CAAC;AAa3B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAEH,KAAK,UAAU,EACf,KAAK,aAAa,EAClB,KAAK,YAAY,EAEjB,KAAK,WAAW,EAChB,KAAK,YAAY,EAEjB,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,OAAO,EACZ,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,QAAQ,EAChB,MAAM,SAAS,CAAC;AAoBjB,8DAA8D;AAC9D,MAAM,WAAW,qBAAqB;IAClC;;;;OAIG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,kGAAkG;IAClG,KAAK,CAAC,EAAE,SAAS,WAAW,EAAE,CAAC;IAC/B,YAAY,CAAC,EAAE,iBAAiB,CAAC;IACjC,sCAAsC;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,uFAAuF;IACvF,oBAAoB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,uGAAuG;AACvG,MAAM,WAAW,2BAA2B;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,SAAS;QACnB,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,OAAO,CAAC;QACjB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QACtB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAC/B,aAAa,EAAE,SAAS,MAAM,EAAE,CAAC;QACjC,KAAK,EAAE,SAAS;YACZ,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC;YACxB,UAAU,EAAE,MAAM,CAAC;YACnB,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,qBAAqB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;SAC7C,EAAE,CAAC;KACP,EAAE,CAAC;IACJ,UAAU,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IACrD,gFAAgF;IAChF,aAAa,EAAE;QACX,YAAY,EAAE,OAAO,CAAC;QACtB,mBAAmB,EAAE,OAAO,CAAC;QAC7B,uBAAuB,EAAE,OAAO,CAAC;QACjC,qBAAqB,EAAE,OAAO,CAAC;KAClC,CAAC;CACL;AAiBD;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC3B,wFAAwF;IACxF,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,eAAe,IAAI,iBAAiB,CAAC;IACrC,eAAe,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAC/C,WAAW,IAAI,MAAM,CAAC;IACtB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,uBAAuB,IAAI,MAAM,CAAC;IAClC,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C,QAAQ,CAAC,IAAI,EAAE,SAAS,WAAW,EAAE,GAAG,IAAI,CAAC;IAC7C,8FAA8F;IAC9F,qBAAqB,CAAC,IAAI,EAAE,SAAS,WAAW,EAAE,GAAG,OAAO,CAAC;IAC7D,OAAO,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,CAAC;IACjC,IAAI,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI,CAAC;IAElC,gBAAgB,CAAC,IAAI,EAAE;QACnB,YAAY,CAAC,EAAE,iBAAiB,CAAC;QACjC,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;QAC1C,uBAAuB,CAAC,EAAE,mBAAmB,CAAC;QAC9C,qBAAqB,CAAC,EAAE,OAAO,CAAC;KACnC,GAAG,IAAI,CAAC;IACT,wBAAwB,IAAI,OAAO,CAAC;IACpC,4BAA4B,IAAI,mBAAmB,CAAC;IACpD,gCAAgC,IAAI,mBAAmB,CAAC;IAExD,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAAC;IACvD,mEAAmE;IACnE,gBAAgB,IAAI,2BAA2B,CAAC;IAChD,oBAAoB,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,GAAG,IAAI,CAAC;IAC9D,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC;IAC1E,YAAY,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI,CAAC;IACvC,WAAW,CAAC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACzD,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC;IAC5E,oBAAoB,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC;IACnF,cAAc,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI,CAAC;IAC5C,iBAAiB,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI,CAAC;IAE5C,iBAAiB,IAAI,UAAU,GAAG,IAAI,CAAC;IACvC,WAAW,CAAC,CAAC,EACT,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EACxC,IAAI,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,CAAC,CAAC,CAAC;IACd,gBAAgB,CAAC,CAAC,EACd,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EACxC,IAAI,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,CAAC,CAAC,CAAC;IAEd,oBAAoB,CAChB,IAAI,EAAE,UAAU,GAAG,SAAS,EAC5B,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,GACnB,IAAI,CAAC;IACR,4FAA4F;IAC5F,mBAAmB,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAEjE,gFAAgF;IAChF,KAAK,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;CAChD;AA6BD;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,GAAE,qBAA0B,GAAG,cAAc,CAkmBxF;AAED;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,cAAuC,CAAC;AAiBpE;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAIpE;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,YAAY,GAAG,aAAa,CA4BzE;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAElE"}