@e2e-dev/decision 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,5 @@
+@e2e-dev/decision
+Copyright 2026 TesterArmy, Inc.
+
+This product includes software developed at TesterArmy, Inc.
+(https://tester.army).

package/README.md

@@ -0,0 +1,41 @@
+# @e2e-dev/decision
+
+Run `agent.act` and `agent.assert` through a decision model instead of an LLM:
+any AI SDK decision model that answers `choice` questions with probability
+distributions (e.g. TypeSafe Jev), plus a small language model that writes
+field values when the decision model picks `type`. Needs `ai` 7, version 7.0.128 or
+later.
+
+```ts
+import type { E2EConfig } from 'e2e';
+import { decisionExecutor } from '@e2e-dev/decision';
+import { typeSafeAi } from '@ai-sdk/typesafe-ai';
+import { openrouter } from '@openrouter/ai-sdk-provider';
+
+export default {
+  agents: {
+    default: {
+      executor: decisionExecutor({
+        model: typeSafeAi.decisionModel('jev-latest'),
+        textModel: openrouter('inception/mercury-2.5'),
+      }),
+    },
+  },
+} satisfies E2EConfig;
+```
+
+Set `agents.default.executor` in the e2e config. Tests stay plain natural
+language, with no params needed. One `experimental_decide` call per action
+asks the operation plus one target question per operation; operations with a
+single target dispatch without a question. The text model is also the agent's
+judgment tier (`waitFor`, `extract`); without a text model or a configured agent
+`model`, `type` is never offered.
+
+The runner authorizes every dispatched action and records every model call
+against the step budget. Secrets stay declared handles filled only through
+`typeSecret`; password fields never reach the text model. `minProbability`
+and `minConfidence` gates are off by default. A `done`/`failed` claim passes
+an independent fresh-screen check before it concludes the step.
+
+See the [decision models guide](https://e2e.tester.army/docs/decision-models)
+for setup, gates, and limits (no vision, no `navigate`, the 255-choice cap).

package/dist/.build.json

@@ -0,0 +1 @@
+{"version":"0.1.0"}

package/dist/api-key.d.ts

@@ -0,0 +1,7 @@
+import { AgentError } from 'e2e/agent';
+/**
+ * MODEL_UNAVAILABLE for a missing API key, naming the environment variable
+ * from the SDK's own message when it names one. Only that identifier is
+ * kept, never the rest of the text.
+ */
+export declare function missingKey(role: 'decision' | 'field-text', error: Error): AgentError;

package/dist/api-key.js

@@ -0,0 +1,13 @@
+import { AgentError } from 'e2e/agent';
+/**
+ * MODEL_UNAVAILABLE for a missing API key, naming the environment variable
+ * from the SDK's own message when it names one. Only that identifier is
+ * kept, never the rest of the text.
+ */
+export function missingKey(role, error) {
+    const variable = /\bthe ([A-Z][A-Z0-9_]*) environment variable\b/.exec(error.message)?.[1];
+    const message = variable === undefined
+        ? `Set the ${role} model API key.`
+        : `Set ${variable} to the ${role} model API key.`;
+    return new AgentError('MODEL_UNAVAILABLE', message);
+}

package/dist/decide.d.ts

@@ -0,0 +1,22 @@
+import type { StepExecutorContext } from 'e2e';
+import * as ai from 'ai';
+import type { DecisionRequest } from './questions.ts';
+import type { DecisionExecutorOptions } from './types.ts';
+/**
+ * The SDK's decide call, or INVALID_CONFIG when the installed `ai` predates
+ * it. Read off the namespace so an older `ai` still loads this module and
+ * the user gets the version to install instead of a link error.
+ */
+export declare function requireDecide(): typeof ai.experimental_decide;
+/** One gated answer: the chosen option, its probability, and the provider confidence. */
+export interface Decision {
+    readonly choice: string;
+    readonly probability: number;
+    readonly confidence: number;
+}
+/**
+ * Makes one decide call under the step budget and returns the answers.
+ * This is the only file that touches the SDK decide API, so a rename
+ * there stays a one-file change.
+ */
+export declare function decide(ctx: StepExecutorContext, model: DecisionExecutorOptions['model'], request: DecisionRequest): Promise<Record<string, Decision>>;

package/dist/decide.js

@@ -0,0 +1,101 @@
+import { AgentError, isAgentError } from 'e2e/agent';
+import { ConfigurationError } from 'e2e/engine';
+import * as ai from 'ai';
+import { InvalidArgumentError, InvalidResponseDataError, JSONParseError, LoadAPIKeyError, TypeValidationError, } from 'ai';
+import { missingKey } from './api-key.js';
+/**
+ * The SDK's decide call, or INVALID_CONFIG when the installed `ai` predates
+ * it. Read off the namespace so an older `ai` still loads this module and
+ * the user gets the version to install instead of a link error.
+ */
+export function requireDecide() {
+    const found = ai.experimental_decide;
+    if (typeof found !== 'function') {
+        throw new ConfigurationError('INVALID_CONFIG', 'decisionExecutor() needs ai 7.0.128 or later; update the ai package');
+    }
+    return found;
+}
+/**
+ * Makes one decide call under the step budget and returns the answers.
+ * This is the only file that touches the SDK decide API, so a rename
+ * there stays a one-file change.
+ */
+export async function decide(ctx, model, request) {
+    ctx.signal.throwIfAborted();
+    const started = performance.now();
+    const startedAt = new Date().toISOString();
+    let inputTokens;
+    let outputTokens;
+    let modelId = model.modelId;
+    let providerMetadata;
+    let answers;
+    try {
+        const call = { model, state: request.state, questions: request.questions };
+        const result = await requireDecide()({
+            ...call,
+            maxRetries: 0,
+            abortSignal: ctx.signal,
+        });
+        ctx.signal.throwIfAborted();
+        inputTokens = result.usage.inputTokens;
+        outputTokens = result.usage.outputTokens;
+        modelId = result.response.modelId;
+        providerMetadata = result.providerMetadata;
+        answers = result.answers;
+    }
+    catch (error) {
+        throw decideError(error, ctx.signal);
+    }
+    finally {
+        ctx.budgets.recordModelCall({
+            provider: model.provider,
+            modelId,
+            startedAt,
+            durationMs: performance.now() - started,
+            ...(inputTokens === undefined ? {} : { inputTokens }),
+            ...(outputTokens === undefined ? {} : { outputTokens }),
+        });
+    }
+    const decisions = {};
+    for (const [id, answer] of Object.entries(answers)) {
+        decisions[id] = { ...selected(answer), confidence: reportedConfidence(providerMetadata, id) };
+    }
+    return decisions;
+}
+/** The chosen option and its probability; anything without a valid distribution is MODEL_OUTPUT_INVALID. */
+function selected(answer) {
+    if (answer === undefined || answer.type !== 'choice' || answer.probabilities === undefined) {
+        throw new AgentError('MODEL_OUTPUT_INVALID', 'The decision model returned an answer without a choice distribution.');
+    }
+    const probability = answer.choice === undefined ? 0 : (answer.probabilities[answer.choice] ?? 0);
+    if (!Number.isFinite(probability) || probability < 0 || probability > 1) {
+        throw new AgentError('MODEL_OUTPUT_INVALID', 'The decision model returned a probability outside [0, 1].');
+    }
+    return { choice: answer.choice ?? '', probability };
+}
+/** Provider-reported confidence for one question, or 0 when absent. */
+function reportedConfidence(metadata, id) {
+    for (const section of Object.values(metadata ?? {})) {
+        const confidence = section['confidence'];
+        if (confidence !== null && typeof confidence === 'object' && !Array.isArray(confidence)) {
+            const value = confidence[id];
+            if (typeof value === 'number' && Number.isFinite(value))
+                return value;
+        }
+    }
+    return 0;
+}
+/** Maps SDK failures onto the runner error codes without echoing provider text. */
+function decideError(error, signal) {
+    signal.throwIfAborted();
+    if (isAgentError(error))
+        return error;
+    if (LoadAPIKeyError.isInstance(error))
+        return missingKey('decision', error);
+    if (InvalidArgumentError.isInstance(error))
+        return error;
+    if (InvalidResponseDataError.isInstance(error) || TypeValidationError.isInstance(error) || JSONParseError.isInstance(error)) {
+        return new AgentError('MODEL_OUTPUT_INVALID', 'The decision model returned an invalid answer.');
+    }
+    return new AgentError('MODEL_PROVIDER_FAILED', 'The decision model call failed.');
+}

package/dist/elements.d.ts

@@ -0,0 +1,49 @@
+import type { ExecutorNode, StepExecutorContext } from 'e2e';
+/** Operations the executor offers on elements. */
+export type Operation = 'tap' | 'type' | 'typeSecret' | 'submit' | 'select' | 'check';
+/** Viewport and history controls, always offered when the engine declares the verb. */
+export type Control = 'scroll_up' | 'scroll_down' | 'back';
+/** Terminal choices: the step claims completion, reports a product failure, or gives up. */
+export type Terminal = 'done' | 'failed' | 'blocked';
+/** One row of the element table the decision model reads. */
+export interface Element {
+    readonly index: string;
+    readonly role: string;
+    readonly label: string;
+    readonly value?: string;
+    readonly checked?: boolean;
+    readonly expanded?: boolean;
+    readonly operations: readonly Operation[];
+}
+/** A bound target. `run` calls `ctx.actions`; the model only ever names the key. */
+export interface Target {
+    readonly description: string;
+    /** Text for `type`, the secret name for `typeSecret`, nothing otherwise. */
+    run(argument?: string): Promise<void>;
+    /** Native-select option label, set only for `select` options; names the choice criterion. */
+    readonly optionLabel?: string;
+}
+export interface ActionSpace {
+    readonly elements: readonly Element[];
+    /** Per operation: target key -> bound target. Only operations with at least one target appear. */
+    readonly targets: ReadonlyMap<Operation, ReadonlyMap<string, Target>>;
+    readonly controls: ReadonlyMap<Control, Target>;
+    /** Elements left out to stay under the per-question cap; scrolling can bring them into view. */
+    readonly omitted: number;
+    /** Non-interactive page text from the tree, without node ids, clipped to 6000 chars. */
+    readonly pageText: string;
+    /** Stable hash of path, tree content with node ids removed, and which nodes are in view. */
+    readonly fingerprint: string;
+}
+/** The parts of an observation the action space reads. */
+interface SpaceObservation {
+    readonly path?: string;
+    readonly viewport: {
+        readonly width: number;
+        readonly height: number;
+    };
+    readonly tree: ExecutorNode;
+}
+/** Builds the element table and bound targets from the newest observation. */
+export declare function actionSpace(ctx: StepExecutorContext, observation: SpaceObservation, canType: boolean): ActionSpace;
+export {};