Praman — AI-First SAP UI5 Test Automation Platform - v1.0.1
    Preparing search index...

    Interface CapabilityEntry

    A single entry in the capability registry exposed to AI agents.

    Generated entries are produced by npm run generate:capabilities and written to capability-registry.generated.ts. Manual entries can be registered via CapabilityRegistry.register().

    Describe a Praman API capability for AI-driven test generation.

    AI agent context, test scaffolding.

    Any Praman module that exposes a test helper.

    const entry: CapabilityEntry = {
      id: 'click-button',
      name: 'clickButton',
      description: 'Clicks a UI5 button by selector',
      category: 'interaction',
      intent: 'click',
      sapModule: 'sap.m.Button',
      usage_example: "await ui5.click({ id: 'submitBtn' })",
      registryVersion: 1,
    };
    interface CapabilityEntry {
        category: string;
        description: string;
        id: string;
        intent?: string;
        name: string;
        priority?: "fixture" | "namespace" | "implementation";
        registryVersion: number;
        sapModule?: string;
        usage_example: string;
    }
    Index

    Properties

    category description id intent? name priority? registryVersion sapModule? usage_example

    Properties

    category: string

    Logical grouping for filtering (e.g. 'interaction', 'navigation').

    description: string

    One-sentence description of what this capability does.

    id: string

    Unique kebab-case identifier for this capability.

    intent?: string

    Optional intent tag from TSDoc @intent.

    name: string

    Human-readable function or method name.

    priority?: "fixture" | "namespace" | "implementation"

    Priority tier for API surface stratification.

    • 'fixture' — Primary Playwright fixture (recommended for consumers)
    • 'namespace' — Secondary utility / handler export
    • 'implementation' — Internal implementation detail
    registryVersion: number

    Registry schema version for forward compatibility.

    sapModule?: string

    Optional SAP UI5 module tag from TSDoc @sapModule.

    usage_example: string

    Ready-to-run usage example string.

    Settings

    Member Visibility

    On This Page

    Properties