@bloom-perf/yaml-pptr 2.0.2 → 3.1.0

package/dist/yaml/json-schema.d.ts

@@ -0,0 +1,6 @@
+/**
+ * JSON Schema (draft 2020-12) of the YAML configuration, generated from the
+ * zod schema used at runtime, so both always agree. Published as
+ * `dist/schema.json` for editors (completion, hover documentation, validation).
+ */
+export declare const buildJsonSchema: () => Record<string, unknown>;

package/dist/yaml/parser.d.ts

@@ -1,2 +1,2 @@
-import { RootYaml } from './validator';
+import { RootYaml } from './validator.js';
 export declare const parseYaml: (yamlContent: string) => RootYaml;

package/dist/yaml/resolver.d.ts

@@ -1,10 +1,19 @@
-import { YpLogger } from '../core/logger';
-import { Scenario } from '../core/model';
-import { RootYaml } from './validator';
-type EnvVarResolve = (arg: string) => string;
+import { YpLogger } from '../core/logger.js';
+import { Scenario } from '../core/model.js';
+import { RootYaml } from './validator.js';
+type EnvVarResolve = (name: string) => string;
+/**
+ * Transforms the validated YAML into the domain model and resolves
+ * environment variables:
+ * - `${VAR}` anywhere in URLs, selectors, typed texts and screenshot paths;
+ * - `$VAR` as the whole value of location, navigate, GOTO url and SCREENSHOT path;
+ * - `$VAR[workerIndex]` as the whole value of location and navigate.
+ *
+ * Resolved values are never logged: they may contain credentials.
+ */
 export declare class Resolver {
-    private envVarResolve;
-    private logger;
+    private readonly envVarResolve;
+    private readonly logger;
     constructor(envVarResolve: EnvVarResolve, logger?: YpLogger);
     resolve(yaml: RootYaml): {
         scenarios: Scenario[];
@@ -13,7 +22,10 @@ export declare class Resolver {
     private resolveStep;
     private resolveAction;
     private createNavigateAction;
-    private resolveUrlOrEnv;
-    private resolveStringOrEnv;
+    /** `$VAR` as the whole value, or `${VAR}` placeholders anywhere. */
+    private resolveWholeValueOrInterpolate;
+    /** Replaces `${VAR}` placeholders; `$${` produces a literal `${`. */
+    private interpolate;
+    private env;
 }
 export {};