Variable recipes`Const`

recipes: {
    describe: (name: string) => string | undefined;
    find: (
        query: string,
    ) => {
        capabilities: string[];
        description: string;
        domain: string;
        id: string;
        name: string;
        pattern: string;
        priority:
            | "optional"
            | "essential"
            | "recommended"
            | "advanced"
            | "deprecated";
    }[];
    forAI: () => {
        capabilities: string[];
        description: string;
        domain: string;
        id: string;
        name: string;
        pattern: string;
        priority: | "optional"
        | "essential"
        | "recommended"
        | "advanced"
        | "deprecated";
    }[];
    forCapability: (
        capability: string,
    ) => {
        capabilities: string[];
        description: string;
        domain: string;
        id: string;
        name: string;
        pattern: string;
        priority:
            | "optional"
            | "essential"
            | "recommended"
            | "advanced"
            | "deprecated";
    }[];
    forDomain: (
        domain: string,
    ) => {
        capabilities: string[];
        description: string;
        domain: string;
        id: string;
        name: string;
        pattern: string;
        priority:
            | "optional"
            | "essential"
            | "recommended"
            | "advanced"
            | "deprecated";
    }[];
    forProcess: (
        process: string,
    ) => {
        capabilities: string[];
        description: string;
        domain: string;
        id: string;
        name: string;
        pattern: string;
        priority:
            | "optional"
            | "essential"
            | "recommended"
            | "advanced"
            | "deprecated";
    }[];
    getDomains: () => string[];
    getSteps: (name: string) => string | undefined;
    getTopRecipes: (
        n: number,
    ) => {
        capabilities: string[];
        description: string;
        domain: string;
        id: string;
        name: string;
        pattern: string;
        priority:
            | "optional"
            | "essential"
            | "recommended"
            | "advanced"
            | "deprecated";
    }[];
    has: (name: string) => boolean;
    list: () => {
        capabilities: string[];
        description: string;
        domain: string;
        id: string;
        name: string;
        pattern: string;
        priority: | "optional"
        | "essential"
        | "recommended"
        | "advanced"
        | "deprecated";
    }[];
    registry: RecipeRegistry;
    search: (
        query: string,
    ) => {
        capabilities: string[];
        description: string;
        domain: string;
        id: string;
        name: string;
        pattern: string;
        priority:
            | "optional"
            | "essential"
            | "recommended"
            | "advanced"
            | "deprecated";
    }[];
    select: (
        filter: {
            domain?: string;
            priority?:
                | "optional"
                | "essential"
                | "recommended"
                | "advanced"
                | "deprecated";
        },
    ) => {
        capabilities: string[];
        description: string;
        domain: string;
        id: string;
        name: string;
        pattern: string;
        priority: | "optional"
        | "essential"
        | "recommended"
        | "advanced"
        | "deprecated";
    }[];
    selectByDomain: (
        domain: string,
    ) => {
        capabilities: string[];
        description: string;
        domain: string;
        id: string;
        name: string;
        pattern: string;
        priority:
            | "optional"
            | "essential"
            | "recommended"
            | "advanced"
            | "deprecated";
    }[];
    selectByPriority: (
        priority:
            | "optional"
            | "essential"
            | "recommended"
            | "advanced"
            | "deprecated",
    ) => {
        capabilities: string[];
        description: string;
        domain: string;
        id: string;
        name: string;
        pattern: string;
        priority: | "optional"
        | "essential"
        | "recommended"
        | "advanced"
        | "deprecated";
    }[];
    toJSON: () => readonly {
        capabilities: string[];
        description: string;
        domain: string;
        id: string;
        name: string;
        pattern: string;
        priority: | "optional"
        | "essential"
        | "recommended"
        | "advanced"
        | "deprecated";
    }[];
    validate: (name: string) => { valid: boolean };
} = ...

Consumer-facing recipes introspection API.

Type Declaration

Readonlydescribe: (name: string) => string | undefined
Returns a human-readable description of a named recipe.
Readonlyfind: (
    query: string,
) => {
    capabilities: string[];
    description: string;
    domain: string;
    id: string;
    name: string;
    pattern: string;
    priority:
        | "optional"
        | "essential"
        | "recommended"
        | "advanced"
        | "deprecated";
}[]
Searches recipes by substring match on name or description.
ReadonlyforAI: () => {
    capabilities: string[];
    description: string;
    domain: string;
    id: string;
    name: string;
    pattern: string;
    priority: | "optional"
    | "essential"
    | "recommended"
    | "advanced"
    | "deprecated";
}[]
Returns all recipes in an AI-agent-friendly format.
ReadonlyforCapability: (
    capability: string,
) => {
    capabilities: string[];
    description: string;
    domain: string;
    id: string;
    name: string;
    pattern: string;
    priority:
        | "optional"
        | "essential"
        | "recommended"
        | "advanced"
        | "deprecated";
}[]
Returns recipes associated with a specific capability.
ReadonlyforDomain: (
    domain: string,
) => {
    capabilities: string[];
    description: string;
    domain: string;
    id: string;
    name: string;
    pattern: string;
    priority:
        | "optional"
        | "essential"
        | "recommended"
        | "advanced"
        | "deprecated";
}[]
Returns recipes relevant to a specific SAP domain.
ReadonlyforProcess: (
    process: string,
) => {
    capabilities: string[];
    description: string;
    domain: string;
    id: string;
    name: string;
    pattern: string;
    priority:
        | "optional"
        | "essential"
        | "recommended"
        | "advanced"
        | "deprecated";
}[]
Returns recipes for a specific business process.
ReadonlygetDomains: () => string[]
Returns unique domain names across all registered recipes.
ReadonlygetSteps: (name: string) => string | undefined
Returns the pattern code for a named recipe, or undefined.
ReadonlygetTopRecipes: (
    n: number,
) => {
    capabilities: string[];
    description: string;
    domain: string;
    id: string;
    name: string;
    pattern: string;
    priority:
        | "optional"
        | "essential"
        | "recommended"
        | "advanced"
        | "deprecated";
}[]
Returns the top n recipes by insertion order.
Readonlyhas: (name: string) => boolean
Returns true if a recipe with the given name exists.
Readonlylist: () => {
    capabilities: string[];
    description: string;
    domain: string;
    id: string;
    name: string;
    pattern: string;
    priority: | "optional"
    | "essential"
    | "recommended"
    | "advanced"
    | "deprecated";
}[]
Returns all registered recipe entries.
registry: RecipeRegistry
The underlying registry instance (for advanced usage like fromEntries()).
Readonlysearch: (
    query: string,
) => {
    capabilities: string[];
    description: string;
    domain: string;
    id: string;
    name: string;
    pattern: string;
    priority:
        | "optional"
        | "essential"
        | "recommended"
        | "advanced"
        | "deprecated";
}[]
Searches recipes by substring match on name or description.
Readonlyselect: (
    filter: {
        domain?: string;
        priority?:
            | "optional"
            | "essential"
            | "recommended"
            | "advanced"
            | "deprecated";
    },
) => {
    capabilities: string[];
    description: string;
    domain: string;
    id: string;
    name: string;
    pattern: string;
    priority: | "optional"
    | "essential"
    | "recommended"
    | "advanced"
    | "deprecated";
}[]
Returns recipes matching the given filter criteria.
ReadonlyselectByDomain: (
    domain: string,
) => {
    capabilities: string[];
    description: string;
    domain: string;
    id: string;
    name: string;
    pattern: string;
    priority:
        | "optional"
        | "essential"
        | "recommended"
        | "advanced"
        | "deprecated";
}[]
Returns recipes matching the given domain.
ReadonlyselectByPriority: (
    priority:
        | "optional"
        | "essential"
        | "recommended"
        | "advanced"
        | "deprecated",
) => {
    capabilities: string[];
    description: string;
    domain: string;
    id: string;
    name: string;
    pattern: string;
    priority: | "optional"
    | "essential"
    | "recommended"
    | "advanced"
    | "deprecated";
}[]
Returns recipes matching the given priority level.
ReadonlytoJSON: () => readonly {
    capabilities: string[];
    description: string;
    domain: string;
    id: string;
    name: string;
    pattern: string;
    priority: | "optional"
    | "essential"
    | "recommended"
    | "advanced"
    | "deprecated";
}[]
Exports all recipes as a JSON-serializable array.
Readonlyvalidate: (name: string) => { valid: boolean }
Validates that a recipe name exists.

Intent

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

Capability

pramanAI.recipes

Example

import { recipes } from 'playwright-praman';

const essential = recipes.selectByPriority('essential');
const all = recipes.forAI();

Variable recipes`Const`

Type Declaration

`Readonly`describe: (name: string) => string | undefined

`Readonly`forAI: () => {
    capabilities: string[];
    description: string;
    domain: string;
    id: string;
    name: string;
    pattern: string;
    priority: | "optional"
    | "essential"
    | "recommended"
    | "advanced"
    | "deprecated";
}[]

`Readonly`getDomains: () => string[]

`Readonly`getSteps: (name: string) => string | undefined

`Readonly`has: (name: string) => boolean

`Readonly`list: () => {
    capabilities: string[];
    description: string;
    domain: string;
    id: string;
    name: string;
    pattern: string;
    priority: | "optional"
    | "essential"
    | "recommended"
    | "advanced"
    | "deprecated";
}[]

registry: RecipeRegistry

`Readonly`toJSON: () => readonly {
    capabilities: string[];
    description: string;
    domain: string;
    id: string;
    name: string;
    pattern: string;
    priority: | "optional"
    | "essential"
    | "recommended"
    | "advanced"
    | "deprecated";
}[]

`Readonly`validate: (name: string) => { valid: boolean }

Intent

Capability

Example

Settings

Variable recipesConst

Type Declaration

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

Readonlyfind: ( query: string,) => { capabilities: string[]; description: string; domain: string; id: string; name: string; pattern: string; priority: | "optional" | "essential" | "recommended" | "advanced" | "deprecated";}[]

ReadonlyforAI: () => { capabilities: string[]; description: string; domain: string; id: string; name: string; pattern: string; priority: | "optional" | "essential" | "recommended" | "advanced" | "deprecated";}[]

ReadonlyforCapability: ( capability: string,) => { capabilities: string[]; description: string; domain: string; id: string; name: string; pattern: string; priority: | "optional" | "essential" | "recommended" | "advanced" | "deprecated";}[]

ReadonlyforDomain: ( domain: string,) => { capabilities: string[]; description: string; domain: string; id: string; name: string; pattern: string; priority: | "optional" | "essential" | "recommended" | "advanced" | "deprecated";}[]

ReadonlyforProcess: ( process: string,) => { capabilities: string[]; description: string; domain: string; id: string; name: string; pattern: string; priority: | "optional" | "essential" | "recommended" | "advanced" | "deprecated";}[]

ReadonlygetDomains: () => string[]

ReadonlygetSteps: (name: string) => string | undefined

ReadonlygetTopRecipes: ( n: number,) => { capabilities: string[]; description: string; domain: string; id: string; name: string; pattern: string; priority: | "optional" | "essential" | "recommended" | "advanced" | "deprecated";}[]

Readonlyhas: (name: string) => boolean

Readonlylist: () => { capabilities: string[]; description: string; domain: string; id: string; name: string; pattern: string; priority: | "optional" | "essential" | "recommended" | "advanced" | "deprecated";}[]

registry: RecipeRegistry

Readonlysearch: ( query: string,) => { capabilities: string[]; description: string; domain: string; id: string; name: string; pattern: string; priority: | "optional" | "essential" | "recommended" | "advanced" | "deprecated";}[]

ReadonlyselectByDomain: ( domain: string,) => { capabilities: string[]; description: string; domain: string; id: string; name: string; pattern: string; priority: | "optional" | "essential" | "recommended" | "advanced" | "deprecated";}[]

ReadonlytoJSON: () => readonly { capabilities: string[]; description: string; domain: string; id: string; name: string; pattern: string; priority: | "optional" | "essential" | "recommended" | "advanced" | "deprecated";}[]

Readonlyvalidate: (name: string) => { valid: boolean }

Intent

Capability

Example

Settings

Variable recipes`Const`

`Readonly`describe: (name: string) => string | undefined

`Readonly`find: (
query: string,
) => {
capabilities: string[];
description: string;
domain: string;
id: string;
name: string;
pattern: string;
priority:
| "optional"
| "essential"
| "recommended"
| "advanced"
| "deprecated";
}[]

`Readonly`forAI: () => {
capabilities: string[];
description: string;
domain: string;
id: string;
name: string;
pattern: string;
priority: | "optional"
| "essential"
| "recommended"
| "advanced"
| "deprecated";
}[]

`Readonly`forCapability: (
capability: string,
) => {
capabilities: string[];
description: string;
domain: string;
id: string;
name: string;
pattern: string;
priority:
| "optional"
| "essential"
| "recommended"
| "advanced"
| "deprecated";
}[]

`Readonly`forDomain: (
domain: string,
) => {
capabilities: string[];
description: string;
domain: string;
id: string;
name: string;
pattern: string;
priority:
| "optional"
| "essential"
| "recommended"
| "advanced"
| "deprecated";
}[]

`Readonly`forProcess: (
process: string,
) => {
capabilities: string[];
description: string;
domain: string;
id: string;
name: string;
pattern: string;
priority:
| "optional"
| "essential"
| "recommended"
| "advanced"
| "deprecated";
}[]

`Readonly`getDomains: () => string[]

`Readonly`getSteps: (name: string) => string | undefined

`Readonly`getTopRecipes: (
n: number,
) => {
capabilities: string[];
description: string;
domain: string;
id: string;
name: string;
pattern: string;
priority:
| "optional"
| "essential"
| "recommended"
| "advanced"
| "deprecated";
}[]

`Readonly`has: (name: string) => boolean

`Readonly`list: () => {
capabilities: string[];
description: string;
domain: string;
id: string;
name: string;
pattern: string;
priority: | "optional"
| "essential"
| "recommended"
| "advanced"
| "deprecated";
}[]

`Readonly`search: (
query: string,
) => {
capabilities: string[];
description: string;
domain: string;
id: string;
name: string;
pattern: string;
priority:
| "optional"
| "essential"
| "recommended"
| "advanced"
| "deprecated";
}[]

`Readonly`selectByDomain: (
domain: string,
) => {
capabilities: string[];
description: string;
domain: string;
id: string;
name: string;
pattern: string;
priority:
| "optional"
| "essential"
| "recommended"
| "advanced"
| "deprecated";
}[]

`Readonly`toJSON: () => readonly {
capabilities: string[];
description: string;
domain: string;
id: string;
name: string;
pattern: string;
priority: | "optional"
| "essential"
| "recommended"
| "advanced"
| "deprecated";
}[]

`Readonly`validate: (name: string) => { valid: boolean }