neuron-inspector 1.2.1 → 1.3.0

package/dist/collections/encoding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"encoding.js","sourceRoot":"","sources":["../../src/collections/encoding.ts"],"names":[],"mappings":"AAAA,iFAAiF;AAEjF,MAAM,UAAU,QAAQ,CAAC,IAAY;IACnC,MAAM,KAAK,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC7C,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,MAAM,EAAE,CAAC;QAC9C,MAAM,IAAI,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC;AACtB,CAAC;AAED,+FAA+F;AAC/F,MAAM,UAAU,UAAU,CAAC,OAAe;IACxC,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC1C,MAAM,MAAM,GAAG,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAChE,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;IAC5B,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE;QAAE,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IACxE,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACzC,CAAC"}

package/dist/collections/executor.d.ts

@@ -1,4 +1,5 @@
-import type { Collection, Environment, Folder, Endpoint, HttpExecutor, ResolverStep, AssertionEvaluator, AssertionResult, ScenarioStep, ScriptRunner } from "./types.js";
+import type { Collection, Environment, Folder, Endpoint, HttpExecutor, ResolverStep, AssertionEvaluator, AssertionResult, AssertionTarget, Assertion, PollConfig, ScenarioStep, ScriptRunner } from "./types.js";
+import type { ResolverContext } from "./types.js";
 export interface EndpointResult {
     endpoint: {
         method: string;
@@ -8,6 +9,8 @@ export interface EndpointResult {
     request: {
         url: string;
         method: string;
+        headers?: Record<string, string>;
+        body?: string;
     };
     response: {
         status: number;
@@ -44,18 +47,73 @@ export interface CollectionRunResult {
     total_failed: number;
     total_errors: number;
 }
+export interface PollAttempt {
+    attempt: number;
+    status: number;
+    timing: {
+        total_ms: number;
+        ttfb_ms: number;
+    };
+    until: AssertionResult[];
+    satisfied: boolean;
+    body?: unknown;
+    error?: string;
+}
+export interface ScenarioStepResult extends EndpointResult {
+    step: number;
+    ref: string;
+    poll?: {
+        satisfied: boolean;
+        attempts: PollAttempt[];
+        max_attempts: number;
+        interval_ms: number;
+    };
+}
 export interface ScenarioResult {
     scenario: string;
     collection: string;
     environment: string;
-    steps: (EndpointResult & {
-        step: number;
-        ref: string;
-    })[];
+    steps: ScenarioStepResult[];
     passed: boolean;
     halted_at?: number;
     extracted: Record<string, string>;
+    /** True when at least one secret input was masked out of this result. */
+    masked?: boolean;
 }
+/** Live progress for a scenario run. Every payload is already masked. */
+export type ScenarioEvent = {
+    type: "run_start";
+    scenario: string;
+    environment: string;
+    total_steps: number;
+} | {
+    type: "step_start";
+    step: number;
+    ref: string;
+    method: string;
+    path: string;
+} | {
+    type: "poll_attempt";
+    step: number;
+    ref: string;
+    attempt: PollAttempt;
+    max_attempts: number;
+} | {
+    type: "step_done";
+    step: number;
+    result: ScenarioStepResult;
+} | {
+    type: "run_done";
+    passed: boolean;
+    halted_at?: number;
+};
+/**
+ * Resolve {{var}} in each assertion's `expect` (each element for array expects)
+ * with the same resolver chain as requests. A value that was a single
+ * template and resolves to the string form of a non-string actual (e.g.
+ * "42" vs 42) takes the actual's type, since templates always yield strings.
+ */
+export declare function resolveAssertionTemplates(assertions: Assertion[], target: AssertionTarget, pipeline: ResolverStep[], context: ResolverContext): Assertion[];
 export declare function executeEndpoint(opts: {
     collection: Collection;
     environment: Environment;
@@ -66,6 +124,12 @@ export declare function executeEndpoint(opts: {
     assertionEvaluator: AssertionEvaluator;
     scriptRunner?: ScriptRunner;
     extracted?: Record<string, string>;
+    /** Run-time input values (declared `inputs`). */
+    inputs?: Record<string, string>;
+    /** Name of the environment actually in use (defaults to the collection's active one). */
+    environmentName?: string;
+    /** Called with each value extracted under a `mask: true` rule. */
+    onSecret?: (value: string) => void;
 }): Promise<EndpointResult>;
 export declare function executeFolder(opts: {
     folderKey: string;
@@ -77,6 +141,9 @@ export declare function executeFolder(opts: {
     assertionEvaluator: AssertionEvaluator;
     scriptRunner?: ScriptRunner;
     extracted?: Record<string, string>;
+    environmentName?: string;
+    inputs?: Record<string, string>;
+    onSecret?: (value: string) => void;
 }): Promise<FolderResult>;
 export declare function executeCollection(opts: {
     collectionId: string;
@@ -86,7 +153,38 @@ export declare function executeCollection(opts: {
     pipeline: ResolverStep[];
     assertionEvaluator: AssertionEvaluator;
     scriptRunner?: ScriptRunner;
+    environmentName?: string;
+    inputs?: Record<string, string>;
+    onSecret?: (value: string) => void;
 }): Promise<CollectionRunResult>;
+/**
+ * Resolve a scenario step ref. Accepted forms, tried in order:
+ *   "folder/<endpoint name>"
+ *   "folder/METHOD /path"   (method is case-insensitive)
+ * Folder keys may themselves contain "/", so the longest matching folder wins.
+ * More than one matching endpoint is an error, never a guess.
+ */
+export declare function resolveStepRef(collection: Collection, ref: string): {
+    folderKey: string;
+    folder: Folder;
+    endpoint: Endpoint;
+} | {
+    error: string;
+};
+export declare const POLL_DEFAULTS: {
+    interval_ms: number;
+    max_attempts: number;
+};
+export declare const POLL_LIMITS: {
+    min_interval_ms: number;
+    max_interval_ms: number;
+    max_attempts: number;
+};
+export declare function normalizePoll(poll: PollConfig): {
+    until: Assertion[];
+    interval_ms: number;
+    max_attempts: number;
+};
 export declare function executeScenario(opts: {
     scenarioKey: string;
     steps: ScenarioStep[];
@@ -97,4 +195,15 @@ export declare function executeScenario(opts: {
     pipeline: ResolverStep[];
     assertionEvaluator: AssertionEvaluator;
     scriptRunner?: ScriptRunner;
+    /** Name of the environment in use (the one passed to the run, not just the active one). */
+    environmentName?: string;
+    inputs?: Record<string, string>;
+    /** Secret values to mask in the result and in every event (plus any `mask: true` extracts). */
+    secrets?: string[];
+    /** Live progress. Payloads are masked. */
+    onEvent?: (event: ScenarioEvent) => void;
+    /** Injectable for tests. */
+    sleep?: (ms: number) => Promise<void>;
+    /** Stop between steps/attempts when this returns true. */
+    isCancelled?: () => boolean;
 }): Promise<ScenarioResult>;