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

    Variable capabilitiesConst

    capabilities: {
        byCategory: (
            category:
                | "ui5"
                | "auth"
                | "navigate"
                | "table"
                | "dialog"
                | "date"
                | "odata"
                | "fe"
                | "intent"
                | "flp"
                | "shell"
                | "footer"
                | "ai"
                | "data"
                | "assert",
        ) => {
            aiSteering?: string;
            async?: boolean;
            category: | "ui5"
            | "auth"
            | "navigate"
            | "table"
            | "dialog"
            | "date"
            | "odata"
            | "fe"
            | "intent"
            | "flp"
            | "shell"
            | "footer"
            | "ai"
            | "data"
            | "assert";
            controlTypes?: string[];
            description: string;
            id: string;
            intent?: string;
            name: string;
            priority: "fixture"
            | "namespace"
            | "implementation";
            qualifiedName: string;
            registryVersion: 1;
            sapModule?: string;
            usageExample: string;
        }[];
        byNamespace: (
            namespace: string,
        ) => {
            aiSteering?: string;
            async?: boolean;
            category:
                | "ui5"
                | "auth"
                | "navigate"
                | "table"
                | "dialog"
                | "date"
                | "odata"
                | "fe"
                | "intent"
                | "flp"
                | "shell"
                | "footer"
                | "ai"
                | "data"
                | "assert";
            controlTypes?: string[];
            description: string;
            id: string;
            intent?: string;
            name: string;
            priority: "fixture"
            | "namespace"
            | "implementation";
            qualifiedName: string;
            registryVersion: 1;
            sapModule?: string;
            usageExample: string;
        }[];
        describe: (name: string) => string | undefined;
        find: (
            query: string,
        ) => {
            aiSteering?: string;
            async?: boolean;
            category:
                | "ui5"
                | "auth"
                | "navigate"
                | "table"
                | "dialog"
                | "date"
                | "odata"
                | "fe"
                | "intent"
                | "flp"
                | "shell"
                | "footer"
                | "ai"
                | "data"
                | "assert";
            controlTypes?: string[];
            description: string;
            id: string;
            intent?: string;
            name: string;
            priority: "fixture"
            | "namespace"
            | "implementation";
            qualifiedName: string;
            registryVersion: 1;
            sapModule?: string;
            usageExample: string;
        }[];
        findByName: (
            name: string,
        ) =>
            | {
                aiSteering?: string;
                async?: boolean;
                category: | "ui5"
                | "auth"
                | "navigate"
                | "table"
                | "dialog"
                | "date"
                | "odata"
                | "fe"
                | "intent"
                | "flp"
                | "shell"
                | "footer"
                | "ai"
                | "data"
                | "assert";
                controlTypes?: string[];
                description: string;
                id: string;
                intent?: string;
                name: string;
                priority: "fixture"
                | "namespace"
                | "implementation";
                qualifiedName: string;
                registryVersion: 1;
                sapModule?: string;
                usageExample: string;
            }
            | undefined;
        forAI: () => CapabilitiesJSON;
        forControl: (
            controlType: string,
        ) => {
            aiSteering?: string;
            async?: boolean;
            category:
                | "ui5"
                | "auth"
                | "navigate"
                | "table"
                | "dialog"
                | "date"
                | "odata"
                | "fe"
                | "intent"
                | "flp"
                | "shell"
                | "footer"
                | "ai"
                | "data"
                | "assert";
            controlTypes?: string[];
            description: string;
            id: string;
            intent?: string;
            name: string;
            priority: "fixture"
            | "namespace"
            | "implementation";
            qualifiedName: string;
            registryVersion: 1;
            sapModule?: string;
            usageExample: string;
        }[];
        forProvider: (provider: "claude" | "openai" | "gemini") => string;
        get: (
            id: string,
        ) =>
            | {
                aiSteering?: string;
                async?: boolean;
                category: | "ui5"
                | "auth"
                | "navigate"
                | "table"
                | "dialog"
                | "date"
                | "odata"
                | "fe"
                | "intent"
                | "flp"
                | "shell"
                | "footer"
                | "ai"
                | "data"
                | "assert";
                controlTypes?: string[];
                description: string;
                id: string;
                intent?: string;
                name: string;
                priority: "fixture"
                | "namespace"
                | "implementation";
                qualifiedName: string;
                registryVersion: 1;
                sapModule?: string;
                usageExample: string;
            }
            | undefined;
        getCategories: () => readonly (
            | "ui5"
            | "auth"
            | "navigate"
            | "table"
            | "dialog"
            | "date"
            | "odata"
            | "fe"
            | "intent"
            | "flp"
            | "shell"
            | "footer"
            | "ai"
            | "data"
            | "assert"
        )[];
        getStatistics: () => CapabilityStats;
        has: (name: string) => boolean;
        list: () => {
            aiSteering?: string;
            async?: boolean;
            category: | "ui5"
            | "auth"
            | "navigate"
            | "table"
            | "dialog"
            | "date"
            | "odata"
            | "fe"
            | "intent"
            | "flp"
            | "shell"
            | "footer"
            | "ai"
            | "data"
            | "assert";
            controlTypes?: string[];
            description: string;
            id: string;
            intent?: string;
            name: string;
            priority: "fixture"
            | "namespace"
            | "implementation";
            qualifiedName: string;
            registryVersion: 1;
            sapModule?: string;
            usageExample: string;
        }[];
        listByPriority: (
            priority: "fixture" | "namespace" | "implementation",
        ) => {
            aiSteering?: string;
            async?: boolean;
            category:
                | "ui5"
                | "auth"
                | "navigate"
                | "table"
                | "dialog"
                | "date"
                | "odata"
                | "fe"
                | "intent"
                | "flp"
                | "shell"
                | "footer"
                | "ai"
                | "data"
                | "assert";
            controlTypes?: string[];
            description: string;
            id: string;
            intent?: string;
            name: string;
            priority: "fixture"
            | "namespace"
            | "implementation";
            qualifiedName: string;
            registryVersion: 1;
            sapModule?: string;
            usageExample: string;
        }[];
        listFixtures: () => {
            aiSteering?: string;
            async?: boolean;
            category: | "ui5"
            | "auth"
            | "navigate"
            | "table"
            | "dialog"
            | "date"
            | "odata"
            | "fe"
            | "intent"
            | "flp"
            | "shell"
            | "footer"
            | "ai"
            | "data"
            | "assert";
            controlTypes?: string[];
            description: string;
            id: string;
            intent?: string;
            name: string;
            priority: "fixture"
            | "namespace"
            | "implementation";
            qualifiedName: string;
            registryVersion: 1;
            sapModule?: string;
            usageExample: string;
        }[];
        registry: CapabilityRegistry;
        toJSON: () => CapabilitiesJSON;
    } = ...

    Consumer-facing capabilities introspection API.

    Type Declaration

    • ReadonlybyCategory: (
          category:
              | "ui5"
              | "auth"
              | "navigate"
              | "table"
              | "dialog"
              | "date"
              | "odata"
              | "fe"
              | "intent"
              | "flp"
              | "shell"
              | "footer"
              | "ai"
              | "data"
              | "assert",
      ) => {
          aiSteering?: string;
          async?: boolean;
          category: | "ui5"
          | "auth"
          | "navigate"
          | "table"
          | "dialog"
          | "date"
          | "odata"
          | "fe"
          | "intent"
          | "flp"
          | "shell"
          | "footer"
          | "ai"
          | "data"
          | "assert";
          controlTypes?: string[];
          description: string;
          id: string;
          intent?: string;
          name: string;
          priority: "fixture"
          | "namespace"
          | "implementation";
          qualifiedName: string;
          registryVersion: 1;
          sapModule?: string;
          usageExample: string;
      }[]

      Returns capabilities matching the given category.

    • ReadonlybyNamespace: (
          namespace: string,
      ) => {
          aiSteering?: string;
          async?: boolean;
          category:
              | "ui5"
              | "auth"
              | "navigate"
              | "table"
              | "dialog"
              | "date"
              | "odata"
              | "fe"
              | "intent"
              | "flp"
              | "shell"
              | "footer"
              | "ai"
              | "data"
              | "assert";
          controlTypes?: string[];
          description: string;
          id: string;
          intent?: string;
          name: string;
          priority: "fixture"
          | "namespace"
          | "implementation";
          qualifiedName: string;
          registryVersion: 1;
          sapModule?: string;
          usageExample: string;
      }[]

      Returns capabilities matching the given namespace prefix.

    • Readonlydescribe: (name: string) => string | undefined

      Returns a human-readable description of a named capability.

    • Readonlyfind: (
          query: string,
      ) => {
          aiSteering?: string;
          async?: boolean;
          category:
              | "ui5"
              | "auth"
              | "navigate"
              | "table"
              | "dialog"
              | "date"
              | "odata"
              | "fe"
              | "intent"
              | "flp"
              | "shell"
              | "footer"
              | "ai"
              | "data"
              | "assert";
          controlTypes?: string[];
          description: string;
          id: string;
          intent?: string;
          name: string;
          priority: "fixture"
          | "namespace"
          | "implementation";
          qualifiedName: string;
          registryVersion: 1;
          sapModule?: string;
          usageExample: string;
      }[]

      Searches capabilities by substring match on name or description.

    • ReadonlyfindByName: (
          name: string,
      ) =>
          | {
              aiSteering?: string;
              async?: boolean;
              category: | "ui5"
              | "auth"
              | "navigate"
              | "table"
              | "dialog"
              | "date"
              | "odata"
              | "fe"
              | "intent"
              | "flp"
              | "shell"
              | "footer"
              | "ai"
              | "data"
              | "assert";
              controlTypes?: string[];
              description: string;
              id: string;
              intent?: string;
              name: string;
              priority: "fixture"
              | "namespace"
              | "implementation";
              qualifiedName: string;
              registryVersion: 1;
              sapModule?: string;
              usageExample: string;
          }
          | undefined

      Returns the first entry matching the given name, or undefined.

    • ReadonlyforAI: () => CapabilitiesJSON

      Returns structured JSON optimised for AI agent consumption.

    • ReadonlyforControl: (
          controlType: string,
      ) => {
          aiSteering?: string;
          async?: boolean;
          category:
              | "ui5"
              | "auth"
              | "navigate"
              | "table"
              | "dialog"
              | "date"
              | "odata"
              | "fe"
              | "intent"
              | "flp"
              | "shell"
              | "footer"
              | "ai"
              | "data"
              | "assert";
          controlTypes?: string[];
          description: string;
          id: string;
          intent?: string;
          name: string;
          priority: "fixture"
          | "namespace"
          | "implementation";
          qualifiedName: string;
          registryVersion: 1;
          sapModule?: string;
          usageExample: string;
      }[]

      Returns capabilities relevant to a specific UI5 control type.

    • ReadonlyforProvider: (provider: "claude" | "openai" | "gemini") => string

      Returns capabilities formatted for a specific AI provider.

    • Readonlyget: (
          id: string,
      ) =>
          | {
              aiSteering?: string;
              async?: boolean;
              category: | "ui5"
              | "auth"
              | "navigate"
              | "table"
              | "dialog"
              | "date"
              | "odata"
              | "fe"
              | "intent"
              | "flp"
              | "shell"
              | "footer"
              | "ai"
              | "data"
              | "assert";
              controlTypes?: string[];
              description: string;
              id: string;
              intent?: string;
              name: string;
              priority: "fixture"
              | "namespace"
              | "implementation";
              qualifiedName: string;
              registryVersion: 1;
              sapModule?: string;
              usageExample: string;
          }
          | undefined

      Looks up a capability by its kebab-case ID.

    • ReadonlygetCategories: () => readonly (
          | "ui5"
          | "auth"
          | "navigate"
          | "table"
          | "dialog"
          | "date"
          | "odata"
          | "fe"
          | "intent"
          | "flp"
          | "shell"
          | "footer"
          | "ai"
          | "data"
          | "assert"
      )[]

      Returns unique category names across all registered capabilities.

    • ReadonlygetStatistics: () => CapabilityStats

      Returns a statistical summary of the registry.

    • Readonlyhas: (name: string) => boolean

      Returns true if a capability with the given name is registered.

    • Readonlylist: () => {
          aiSteering?: string;
          async?: boolean;
          category: | "ui5"
          | "auth"
          | "navigate"
          | "table"
          | "dialog"
          | "date"
          | "odata"
          | "fe"
          | "intent"
          | "flp"
          | "shell"
          | "footer"
          | "ai"
          | "data"
          | "assert";
          controlTypes?: string[];
          description: string;
          id: string;
          intent?: string;
          name: string;
          priority: "fixture"
          | "namespace"
          | "implementation";
          qualifiedName: string;
          registryVersion: 1;
          sapModule?: string;
          usageExample: string;
      }[]

      Returns all registered capability entries.

    • ReadonlylistByPriority: (
          priority: "fixture" | "namespace" | "implementation",
      ) => {
          aiSteering?: string;
          async?: boolean;
          category:
              | "ui5"
              | "auth"
              | "navigate"
              | "table"
              | "dialog"
              | "date"
              | "odata"
              | "fe"
              | "intent"
              | "flp"
              | "shell"
              | "footer"
              | "ai"
              | "data"
              | "assert";
          controlTypes?: string[];
          description: string;
          id: string;
          intent?: string;
          name: string;
          priority: "fixture"
          | "namespace"
          | "implementation";
          qualifiedName: string;
          registryVersion: 1;
          sapModule?: string;
          usageExample: string;
      }[]

      Returns entries matching the given priority tier.

    • ReadonlylistFixtures: () => {
          aiSteering?: string;
          async?: boolean;
          category: | "ui5"
          | "auth"
          | "navigate"
          | "table"
          | "dialog"
          | "date"
          | "odata"
          | "fe"
          | "intent"
          | "flp"
          | "shell"
          | "footer"
          | "ai"
          | "data"
          | "assert";
          controlTypes?: string[];
          description: string;
          id: string;
          intent?: string;
          name: string;
          priority: "fixture"
          | "namespace"
          | "implementation";
          qualifiedName: string;
          registryVersion: 1;
          sapModule?: string;
          usageExample: string;
      }[]

      Returns entries with priority === 'fixture' (Playwright best practice).

    • registry: CapabilityRegistry

      The underlying registry instance (for advanced usage like register()).

    • ReadonlytoJSON: () => CapabilitiesJSON

      Exports the full registry as structured JSON.

    Provide drop-in parity with mk's capabilities object.

    pramanAI.capabilities

    import { capabilities } from 'playwright-praman';

    if (capabilities.has('clickButton')) {
      const cap = capabilities.findByName('clickButton');
    }

    Settings

    Member Visibility