@salesforce/b2c-tooling-sdk / scaffold / ScaffoldRegistry

Class: ScaffoldRegistry

Defined in: packages/b2c-tooling-sdk/src/scaffold/registry.ts:144

Scaffold registry for discovering and managing scaffolds

Constructors

Constructor

new ScaffoldRegistry(options?): ScaffoldRegistry

Defined in: packages/b2c-tooling-sdk/src/scaffold/registry.ts:150

Parameters

options?

ScaffoldRegistryOptions

Returns

ScaffoldRegistry

Methods

addProviders()

addProviders(providers): void

Defined in: packages/b2c-tooling-sdk/src/scaffold/registry.ts:160

Add scaffold providers to the registry for discovery. Providers are appended to the existing list and evaluated in priority order. Clears the cache to ensure new scaffolds are discovered on next query.

Parameters

providers

ScaffoldProvider[]

Array of scaffold providers to add

Returns

void

---

addTransformers()

addTransformers(transformers): void

Defined in: packages/b2c-tooling-sdk/src/scaffold/registry.ts:171

Add scaffold transformers to the registry. Transformers are applied to all scaffolds during discovery after deduplication. Clears the cache to ensure transformers are reapplied on the next getScaffolds() call.

Parameters

transformers

ScaffoldTransformer[]

Array of scaffold transformers to add

Returns

void

---

clearCache()

clearCache(): void

Defined in: packages/b2c-tooling-sdk/src/scaffold/registry.ts:179

Clear the scaffold cache

Returns

void

---

getScaffold()

getScaffold(id, options): Promise<Scaffold | null>

Defined in: packages/b2c-tooling-sdk/src/scaffold/registry.ts:266

Get a specific scaffold by ID

Parameters

id

string

Scaffold ID

options

ScaffoldDiscoveryOptions = {}

Discovery options

Returns

Promise<Scaffold | null>

Scaffold or null if not found

---

getScaffolds()

getScaffolds(options): Promise<Scaffold[]>

Defined in: packages/b2c-tooling-sdk/src/scaffold/registry.ts:188

Get all scaffolds from all sources

Parameters

options

ScaffoldDiscoveryOptions = {}

Discovery options

Returns

Promise<Scaffold[]>

Array of scaffolds (deduplicated by name, later sources override earlier)

---

searchScaffolds()

searchScaffolds(query, options): Promise<Scaffold[]>

Defined in: packages/b2c-tooling-sdk/src/scaffold/registry.ts:277

Search scaffolds by query

Parameters

query

string

Search query

options

ScaffoldDiscoveryOptions = {}

Additional discovery options

Returns

Promise<Scaffold[]>

Matching scaffolds