Skip to main content

Interface: CapabilityEntry

Defined in: src/ai/types.ts:186

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

Remarks​

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

Intent​

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

Capability​

AI agent context, test scaffolding.

Sap Module​

Any Praman module that exposes a test helper.

Example​

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,
};

Properties​

category​

readonly category: string

Defined in: src/ai/types.ts:194

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

description​

readonly description: string

Defined in: src/ai/types.ts:192

One-sentence description of what this capability does.

id​

readonly id: string

Defined in: src/ai/types.ts:188

Unique kebab-case identifier for this capability.

intent?​

readonly optional intent: string

Defined in: src/ai/types.ts:196

Optional intent tag from TSDoc @intent.

name​

readonly name: string

Defined in: src/ai/types.ts:190

Human-readable function or method name.

priority?​

readonly optional priority: "fixture" | "namespace" | "implementation"

Defined in: src/ai/types.ts:211

Priority tier for API surface stratification.

Remarks​

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

registryVersion​

readonly registryVersion: number

Defined in: src/ai/types.ts:202

Registry schema version for forward compatibility.

sapModule?​

readonly optional sapModule: string

Defined in: src/ai/types.ts:198

Optional SAP UI5 module tag from TSDoc @sapModule.

usage_example​

readonly usage_example: string

Defined in: src/ai/types.ts:200

Ready-to-run usage example string.