Class RecipeRegistry

Queryable registry of reusable test pattern recipes.

Intent

Provide curated SAP Fiori test patterns to AI agents and human testers.

Capability

pramanAI.recipes

Example

const registry = new RecipeRegistry();
const aiRecipes = registry.forAI();

Index

Constructors

constructor

Methods

fromEntries forAI getTopRecipes search select selectByDomain selectByPriority

Constructors

constructor

new RecipeRegistry(): RecipeRegistry
Constructs a registry pre-seeded from the generated recipe list.

Returns RecipeRegistry
Example
```
const registry = new RecipeRegistry();
logger.info(registry.select({}).length);
```
- Defined in ai/recipe-registry.ts:68

Methods

`Static`fromEntries

fromEntries(
    entries: readonly {
        capabilities: string[];
        description: string;
        domain: string;
        id: string;
        name: string;
        pattern: string;
        priority:
            | "optional"
            | "essential"
            | "recommended"
            | "advanced"
            | "deprecated";
    }[],
): RecipeRegistry
Creates a registry seeded with an explicit list of entries.
Parameters
- entries: readonly {
      capabilities: string[];
      description: string;
      domain: string;
      id: string;
      name: string;
      pattern: string;
      priority:
          | "optional"
          | "essential"
          | "recommended"
          | "advanced"
          | "deprecated";
  }[]
  Recipe entries to seed the registry with.
Returns RecipeRegistry
A new RecipeRegistry instance containing the given entries.
Remarks
Use this factory in tests or plugins to provide a known set of recipes without modifying GENERATED_RECIPES.
Example
```
const registry = RecipeRegistry.fromEntries([authRecipe, navRecipe]);
```
- Defined in ai/recipe-registry.ts:87

forAI

forAI(): {
    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.

Returns {
    capabilities: string[];
    description: string;
    domain: string;
    id: string;
    name: string;
    pattern: string;
    priority:
        | "optional"
        | "essential"
        | "recommended"
        | "advanced"
        | "deprecated";
}[]
All recipe entries ordered by insertion.
- capabilities: string[]
  Capability IDs or refs this recipe uses.
- description: string
  One or two sentence explanation.
- domain: string
  Domain category for grouping.
- id: string
  Unique kebab-case identifier.
- name: string
  Short descriptive title.
- pattern: string
  Ready-to-use TypeScript code pattern.
- priority: "optional" | "essential" | "recommended" | "advanced" | "deprecated"
  Priority level for adoption guidance.
Remarks
Currently returns all registered entries. Future versions may apply token-budget-aware truncation or relevance scoring.
Example
```
const allRecipes = registry.forAI();
const prompt = JSON.stringify(allRecipes);
```
- Defined in ai/recipe-registry.ts:199

getTopRecipes

getTopRecipes(
    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 from the registry.
Parameters
- n: number
  Maximum number of recipes to return.
Returns {
    capabilities: string[];
    description: string;
    domain: string;
    id: string;
    name: string;
    pattern: string;
    priority:
        | "optional"
        | "essential"
        | "recommended"
        | "advanced"
        | "deprecated";
}[]
Up to n recipe entries.
- capabilities: string[]
  Capability IDs or refs this recipe uses.
- description: string
  One or two sentence explanation.
- domain: string
  Domain category for grouping.
- id: string
  Unique kebab-case identifier.
- name: string
  Short descriptive title.
- pattern: string
  Ready-to-use TypeScript code pattern.
- priority: "optional" | "essential" | "recommended" | "advanced" | "deprecated"
  Priority level for adoption guidance.
Remarks
Returns at most n entries in insertion order. If fewer than n recipes are registered, all registered entries are returned.
Example
```
const topThree = registry.getTopRecipes(3);
```
- Defined in ai/recipe-registry.ts:218

search

search(
    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 against name or description.
Parameters
- query: string
  Substring to search for.
Returns {
    capabilities: string[];
    description: string;
    domain: string;
    id: string;
    name: string;
    pattern: string;
    priority:
        | "optional"
        | "essential"
        | "recommended"
        | "advanced"
        | "deprecated";
}[]
Matching recipe entries.
- capabilities: string[]
  Capability IDs or refs this recipe uses.
- description: string
  One or two sentence explanation.
- domain: string
  Domain category for grouping.
- id: string
  Unique kebab-case identifier.
- name: string
  Short descriptive title.
- pattern: string
  Ready-to-use TypeScript code pattern.
- priority: "optional" | "essential" | "recommended" | "advanced" | "deprecated"
  Priority level for adoption guidance.
Remarks
Case-insensitive substring match. For semantic search, pass forAI() output directly to an LLM.
Example
```
const loginRecipes = registry.search('login');
const tableRecipes = registry.search('table');
```
- Defined in ai/recipe-registry.ts:175

select

select(
    filter: RecipeFilter,
): {
    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.
Parameters
- filter: RecipeFilter
  Optional category and/or role constraints.
Returns {
    capabilities: string[];
    description: string;
    domain: string;
    id: string;
    name: string;
    pattern: string;
    priority:
        | "optional"
        | "essential"
        | "recommended"
        | "advanced"
        | "deprecated";
}[]
Matching recipe entries.
- capabilities: string[]
  Capability IDs or refs this recipe uses.
- description: string
  One or two sentence explanation.
- domain: string
  Domain category for grouping.
- id: string
  Unique kebab-case identifier.
- name: string
  Short descriptive title.
- pattern: string
  Ready-to-use TypeScript code pattern.
- priority: "optional" | "essential" | "recommended" | "advanced" | "deprecated"
  Priority level for adoption guidance.
Remarks
All specified filter properties are AND-combined. An empty filter object returns all registered recipes.
Example
```
const uiRecipes = registry.select({ domain: 'ui5' });
const essential = registry.select({ domain: 'auth', priority: 'essential' });
```
- Defined in ai/recipe-registry.ts:117

selectByDomain

selectByDomain(
    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.
Parameters
- domain: string
  Domain string to filter by (e.g. 'ui5', 'table', 'auth').
Returns {
    capabilities: string[];
    description: string;
    domain: string;
    id: string;
    name: string;
    pattern: string;
    priority:
        | "optional"
        | "essential"
        | "recommended"
        | "advanced"
        | "deprecated";
}[]
Matching recipe entries.
- capabilities: string[]
  Capability IDs or refs this recipe uses.
- description: string
  One or two sentence explanation.
- domain: string
  Domain category for grouping.
- id: string
  Unique kebab-case identifier.
- name: string
  Short descriptive title.
- pattern: string
  Ready-to-use TypeScript code pattern.
- priority: "optional" | "essential" | "recommended" | "advanced" | "deprecated"
  Priority level for adoption guidance.
Example
```
const authRecipes = registry.selectByDomain('auth');
```
- Defined in ai/recipe-registry.ts:140

selectByPriority

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";
}[]
Returns recipes matching the given priority level.
Parameters
- priority: "optional" | "essential" | "recommended" | "advanced" | "deprecated"
  Priority level to filter by.
Returns {
    capabilities: string[];
    description: string;
    domain: string;
    id: string;
    name: string;
    pattern: string;
    priority:
        | "optional"
        | "essential"
        | "recommended"
        | "advanced"
        | "deprecated";
}[]
Matching recipe entries.
- capabilities: string[]
  Capability IDs or refs this recipe uses.
- description: string
  One or two sentence explanation.
- domain: string
  Domain category for grouping.
- id: string
  Unique kebab-case identifier.
- name: string
  Short descriptive title.
- pattern: string
  Ready-to-use TypeScript code pattern.
- priority: "optional" | "essential" | "recommended" | "advanced" | "deprecated"
  Priority level for adoption guidance.
Example
```
const essentialRecipes = registry.selectByPriority('essential');
```
- Defined in ai/recipe-registry.ts:155

Class RecipeRegistry

Intent

Capability

Example

Index

Constructors

Methods

Constructors

constructor

Returns RecipeRegistry

Example

Methods

StaticfromEntries

Parameters

Returns RecipeRegistry

Remarks

Example

forAI

Returns { capabilities: string[]; description: string; domain: string; id: string; name: string; pattern: 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"

Remarks

Example

getTopRecipes

Parameters

Returns { capabilities: string[]; description: string; domain: string; id: string; name: string; pattern: 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"

Remarks

Example

search

Parameters

Returns { capabilities: string[]; description: string; domain: string; id: string; name: string; pattern: 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"

Remarks

Example

select

Parameters

Returns { capabilities: string[]; description: string; domain: string; id: string; name: string; pattern: 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"

Remarks

Example

selectByDomain

Parameters

Returns { capabilities: string[]; description: string; domain: string; id: string; name: string; pattern: 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"

Example

selectByPriority

Parameters

Returns { capabilities: string[]; description: string; domain: string; id: string; name: string; pattern: string; priority: | "optional" | "essential" | "recommended" | "advanced" | "deprecated";}[]

capabilities: string[]

description: string

`Static`fromEntries

Returns {
capabilities: string[];
description: string;
domain: string;
id: string;
name: string;
pattern: string;
priority:
| "optional"
| "essential"
| "recommended"
| "advanced"
| "deprecated";
}[]

Returns {
capabilities: string[];
description: string;
domain: string;
id: string;
name: string;
pattern: string;
priority:
| "optional"
| "essential"
| "recommended"
| "advanced"
| "deprecated";
}[]

Returns {
capabilities: string[];
description: string;
domain: string;
id: string;
name: string;
pattern: string;
priority:
| "optional"
| "essential"
| "recommended"
| "advanced"
| "deprecated";
}[]

Returns {
capabilities: string[];
description: string;
domain: string;
id: string;
name: string;
pattern: string;
priority:
| "optional"
| "essential"
| "recommended"
| "advanced"
| "deprecated";
}[]

Returns {
capabilities: string[];
description: string;
domain: string;
id: string;
name: string;
pattern: string;
priority:
| "optional"
| "essential"
| "recommended"
| "advanced"
| "deprecated";
}[]

Returns {
capabilities: string[];
description: string;
domain: string;
id: string;
name: string;
pattern: string;
priority:
| "optional"
| "essential"
| "recommended"
| "advanced"
| "deprecated";
}[]