Request Provider

The RequestProvider orchestrates out-bound API requests by integrating deduplication, multiple cache strategies, and Server-Side Rendering (SSR) states.

Instead of calling `$fetch` directly everywhere, Katlux uses the RequestProvider. It ensures that identical requests running simultaneously do not trigger multiple network calls (deduplication) and automatically proxies data into configured Cache Providers.

Commonly used by: Flat API ClientSide DataProvider, Flat API ServerSide DataProvider, and tree API data providers.

Optional configuration parameters passed when initializing a new RequestProvider.

Property	Type	Description
provider	ACacheProvider \| ECacheStrategy \| string	Sets the active persistence strategy using a built-in ECacheStrategy, a custom registered strategy name, or an ACacheProvider singleton instance.
lifetime	number	Sets the default tracking TTL assigned to generated cache entries in milliseconds.
tags	string[]	Optional list of associated tags for automatic registration with RequestProviderRegistry.
deduplicate	boolean	Enables/disables implicit request merging for overlapping API pulls.

Public methods and options available on the RequestProvider instance

Item	Type / Params	Description
setCacheProvider	(strategy: ECacheStrategy \| string \| ACacheProvider \| null)	Sets the active cache strategy (built-in ECacheStrategy, custom registered strategy name, or direct ACacheProvider instance)
setCacheLifetime	(ms: number)	Configures the duration for which successful requests should be cached
registerRequest	(url: string, options: IRequestOptions)	Executes the request. For non-GET with queue:true, enqueues the mutation into RequestQueue.
options.tags	string[]	Tag array. When a mutation finishes, RequestProviderRegistry refreshes all GET providers with these tags.
options.queue	boolean	When true for non-GET requests, enqueues the operation into RequestQueue for offline/manual flush.
options.label	string	Human-readable label for queued mutations displayed in offline queue UI.
clearCache	() => Promise<void>	Erases the cache entries specific to this RequestProvider instance
refresh	(hardRefresh: boolean = false)	Re-runs the last registered request. Cache will only be overridden if hardRefresh is true.
onDataReceived	(callback: Function)	Registers a callback to be triggered when data is successfully received by this provider.
setEncryption	(opts: IProviderEncryptionOptions)	Configures in-flight payload encryption & decryption via CWebCryptoEncryptionProvider or custom AEncryptionProvider. See Payload Encryption Guide.
options.encryption	IProviderEncryptionOptions	Per-request encryption override options.

Symbol	Category	Description
IRequestOptions	Interface	Per-request options configuration schema
RequestProviderRegistry	Class	Tag-based provider registry for automatic cache revalidation
RequestQueue	Class	Offline persistent queue for background mutation replay
IProviderEncryptionOptions	Interface	In-flight and data provider encryption options
CWebCryptoEncryptionProvider	Class	Hardware-accelerated Web Crypto cipher provider
ACacheProvider	Base Class	Base class for custom and built-in cache backends
Payload Encryption Guide	Guide	Architecture walkthrough and interactive cryptographic sandbox