Function defineConfig

Parameters

• base: {
      ai?: {
          anthropicApiKey?: string;
          apiKey?: string;
          apiVersion?: string;
          deployment?: string;
          endpoint?: unknown;
          includeAriaSnapshot?: boolean;
          maxTokens?: number;
          model?: string;
          provider?: unknown;
          temperature?: number;
      };
      auth?: {
          baseUrl?: unknown;
          client?: string;
          language?: string;
          password?: string;
          strategy?: unknown;
          username?: string;
      };
      captureFailureArtifacts?: boolean;
      controlDiscoveryTimeout?: number;
      controlTreeCapture?: {
          enabled?: boolean;
          maxControls?: number;
          maxDepth?: number;
      };
      defaultMatchSubclasses?: boolean;
      discoveryStrategies?: ("direct-id" | "recordreplay" | "registry")[];
      ignoreAutoWaitUrls?: string[];
      interactionStrategy?: "ui5-native" | "dom-first" | "opa5";
      logLevel?: "error" | "debug" | "warn" | "info" | "verbose";
      odataTracing?: { enabled?: boolean; urlPatterns?: string[] };
      opa5?: { autoWait?: boolean; debug?: boolean; interactionTimeout?: number };
      overlays?: { enabled?: boolean };
      preferVisibleControls?: boolean;
      selectors?: {
          defaultTimeout?: number;
          preferVisibleControls?: boolean;
          skipStabilityWait?: boolean;
      };
      skipPostFillWait?: boolean;
      skipStabilityWait?: boolean;
      telemetry?: {
          batchTimeout?: number;
          connectionString?: string;
          endpoint?: string;
          exporter?: "otlp"
          | "azure-monitor"
          | "jaeger";
          maxQueueSize?: number;
          metrics?: boolean;
          openTelemetry?: boolean;
          protocol?: "http" | "grpc";
          resourceAttributes?: Record<string, string>;
          serviceName?: string;
      };
      ui5WaitTimeout?: number;
  }

  Base config input applied in every environment.

  • Optionalai?: {
        anthropicApiKey?: string;
        apiKey?: string;
        apiVersion?: string;
        deployment?: string;
        endpoint?: unknown;
        includeAriaSnapshot?: boolean;
        maxTokens?: number;
        model?: string;
        provider?: unknown;
        temperature?: number;
    }

    • OptionalanthropicApiKey?: string

    • OptionalapiKey?: string

    • OptionalapiVersion?: string

    • Optionaldeployment?: string

    • Optionalendpoint?: unknown

    • OptionalincludeAriaSnapshot?: boolean

      Include an aria snapshot in pramanAI.buildContext() output (Playwright 1.60+). On unless set to false.

    • OptionalmaxTokens?: number

    • Optionalmodel?: string

    • Optionalprovider?: unknown

    • Optionaltemperature?: number

  • Optionalauth?: {
        baseUrl?: unknown;
        client?: string;
        language?: string;
        password?: string;
        strategy?: unknown;
        username?: string;
    }

    • OptionalbaseUrl?: unknown

    • Optionalclient?: string

    • Optionallanguage?: string

    • Optionalpassword?: string

    • Optionalstrategy?: unknown

      Auth strategy for SAP login.

      Remarks

      • basic: On-premise form-based login (onprem-strategy)
      • btp-saml: BTP Cloud SAML via IAS (cloud-saml-strategy)
      • office365: Microsoft 365 / Azure AD SSO (office365-strategy)
      • custom: User-provided login function

      For API-based, certificate, or multi-tenant auth, see the authentication guide — these are configured programmatically.

    • Optionalusername?: string

  • OptionalcaptureFailureArtifacts?: boolean

    Whether to auto-capture diagnostic artifacts (screenshot, control tree, page context) on test failure.

    Remarks

    When true (default), the failure artifacts fixture automatically attaches a screenshot (PNG), UI5 control tree snapshot (JSON), and page metadata (JSON) to the test report on any test failure. Set to false to disable.

  • OptionalcontrolDiscoveryTimeout?: number

  • OptionalcontrolTreeCapture?: { enabled?: boolean; maxControls?: number; maxDepth?: number }

  • OptionaldefaultMatchSubclasses?: boolean

    Default value for matchSubclasses on selectors that don't specify it.

  • OptionaldiscoveryStrategies?: ("direct-id" | "recordreplay" | "registry")[]

  • OptionalignoreAutoWaitUrls?: string[]

  • OptionalinteractionStrategy?: "ui5-native" | "dom-first" | "opa5"

  • OptionallogLevel?: "error" | "debug" | "warn" | "info" | "verbose"

  • OptionalodataTracing?: { enabled?: boolean; urlPatterns?: string[] }

  • Optionalopa5?: { autoWait?: boolean; debug?: boolean; interactionTimeout?: number }

  • Optionaloverlays?: { enabled?: boolean }

    • Optionalenabled?: boolean

      Whether to register the built-in overlay rules.

      Remarks

      The built-ins are detect-only — they never dismiss anything. Disable this to register nothing automatically and drive overlays.register() yourself.

  • OptionalpreferVisibleControls?: boolean

  • Optionalselectors?: {
        defaultTimeout?: number;
        preferVisibleControls?: boolean;
        skipStabilityWait?: boolean;
    }

    • OptionaldefaultTimeout?: number

      Deprecated

      Use top-level controlDiscoveryTimeout instead.

    • OptionalpreferVisibleControls?: boolean

    • OptionalskipStabilityWait?: boolean

  • OptionalskipPostFillWait?: boolean

    When true, fill() will not call waitForUI5() after entering text. Useful for rapid sequential fills where intermediate stability waits are unnecessary.

  • OptionalskipStabilityWait?: boolean

  • Optionaltelemetry?: {
        batchTimeout?: number;
        connectionString?: string;
        endpoint?: string;
        exporter?: "otlp" | "azure-monitor" | "jaeger";
        maxQueueSize?: number;
        metrics?: boolean;
        openTelemetry?: boolean;
        protocol?: "http" | "grpc";
        resourceAttributes?: Record<string, string>;
        serviceName?: string;
    }

    • OptionalbatchTimeout?: number

    • OptionalconnectionString?: string

      Azure Monitor connection string. Required when exporter is 'azure-monitor'.

    • Optionalendpoint?: string

    • Optionalexporter?: "otlp" | "azure-monitor" | "jaeger"

    • OptionalmaxQueueSize?: number

    • Optionalmetrics?: boolean

    • OptionalopenTelemetry?: boolean

    • Optionalprotocol?: "http" | "grpc"

    • OptionalresourceAttributes?: Record<string, string>

    • OptionalserviceName?: string

  • Optionalui5WaitTimeout?: number

• Optionalenvironments: Record<
      string,
      Partial<
          {
              ai?: {
                  anthropicApiKey?: string;
                  apiKey?: string;
                  apiVersion?: string;
                  deployment?: string;
                  endpoint?: unknown;
                  includeAriaSnapshot?: boolean;
                  maxTokens?: number;
                  model?: string;
                  provider?: unknown;
                  temperature?: number;
              };
              auth?: {
                  baseUrl?: unknown;
                  client?: string;
                  language?: string;
                  password?: string;
                  strategy?: unknown;
                  username?: string;
              };
              captureFailureArtifacts?: boolean;
              controlDiscoveryTimeout?: number;
              controlTreeCapture?: {
                  enabled?: boolean;
                  maxControls?: number;
                  maxDepth?: number;
              };
              defaultMatchSubclasses?: boolean;
              discoveryStrategies?: ("direct-id" | "recordreplay" | "registry")[];
              ignoreAutoWaitUrls?: string[];
              interactionStrategy?: "ui5-native" | "dom-first" | "opa5";
              logLevel?: "error" | "debug" | "warn" | "info" | "verbose";
              odataTracing?: { enabled?: boolean; urlPatterns?: string[] };
              opa5?: {
                  autoWait?: boolean;
                  debug?: boolean;
                  interactionTimeout?: number;
              };
              overlays?: { enabled?: boolean };
              preferVisibleControls?: boolean;
              selectors?: {
                  defaultTimeout?: number;
                  preferVisibleControls?: boolean;
                  skipStabilityWait?: boolean;
              };
              skipPostFillWait?: boolean;
              skipStabilityWait?: boolean;
              telemetry?: {
                  batchTimeout?: number;
                  connectionString?: string;
                  endpoint?: string;
                  exporter?: "otlp"
                  | "azure-monitor"
                  | "jaeger";
                  maxQueueSize?: number;
                  metrics?: boolean;
                  openTelemetry?: boolean;
                  protocol?: "http" | "grpc";
                  resourceAttributes?: Record<string, string>;
                  serviceName?: string;
              };
              ui5WaitTimeout?: number;
          },
      >,
  >

  Optional map of environment names to partial config overrides. The active environment is read from PRAMAN_ENV first, then NODE_ENV.