Praman — Agent-First SAP UI5 Test Automation Plugin - v1.2.0
    Preparing search index...

    Interface AgenticCheckpointBeta

    Checkpoint state for long-running agentic test generation sessions.

    Beta — serialization format may change in minor releases.

    Serializable to JSON via JSON.stringify(). The JSON shape is:

    {
      "sessionId": "string (UUID recommended)",
      "currentStep": "number (0-based index)",
      "completedSteps": ["string[]"],
      "remainingSteps": ["string[]"],
      "state": { "arbitrary JSON-safe key/value pairs" },
      "timestamp": "string (ISO 8601)"
    }

    Persist with JSON.stringify(checkpoint) and restore with JSON.parse(stored) as AgenticCheckpoint. All fields are readonly — create a new object to update.

    The state record must only contain JSON-serializable values (no functions, Dates, or circular references).

    Enable resumable multi-step AI test generation workflows.

    const checkpoint: AgenticCheckpoint = {
      sessionId: 'sess-001',
      currentStep: 2,
      completedSteps: ['discover', 'plan'],
      remainingSteps: ['generate', 'validate'],
      state: { pageUrl: 'https://my.app/launchpad' },
      timestamp: new Date().toISOString(),
    };

    // Persist to disk
    await fs.writeFile('checkpoint.json', JSON.stringify(checkpoint));

    // Restore
    const restored = JSON.parse(await fs.readFile('checkpoint.json', 'utf8')) as AgenticCheckpoint;
    handler.saveCheckpoint(restored);
    interface AgenticCheckpoint {
        completedSteps: string[];
        currentStep: number;
        remainingSteps: string[];
        sessionId: string;
        state: Record<string, unknown>;
        timestamp: string;
    }
    Index

    Properties

    completedSteps currentStep remainingSteps sessionId state timestamp

    Properties

    completedSteps: string[]

    Ordered list of step names that have already completed.

    currentStep: number

    Index of the currently executing step (0-based).

    remainingSteps: string[]

    Ordered list of step names yet to execute.

    sessionId: string

    Unique session identifier (UUID recommended).

    state: Record<string, unknown>

    Arbitrary serializable step state (JSON-safe).

    timestamp: string

    ISO 8601 timestamp when this checkpoint was created.

    Settings

    Member Visibility

    On This Page

    Properties