/** @see https://github.com/webcomponents-cg/community-protocols/blob/main/proposals/context.md */ import { type Memo } from '@zeix/cause-effect'; import type { ComponentProps, EffectDescriptor } from '../types'; /** * A context key. * * A context key can be any type of object, including strings and symbols. The * Context type brands the key type with the `__context__` property that * carries the type of the value the context references. */ type Context = K & { __context__: V; }; /** * An unknown context type */ type UnknownContext = Context; /** * A helper type which can extract a Context value type from a Context type */ type ContextType = T extends Context ? V : never; /** * A callback which is provided by a context requester and is called with the value satisfying the request. * This callback can be called multiple times by context providers as the requested value is changed. */ type ContextCallback = (value: V, unsubscribe?: () => void) => void; declare global { interface HTMLElementEventMap { /** * A 'context-request' event can be emitted by any element which desires * a context value to be injected by an external provider. */ 'context-request': ContextRequestEvent; } } /** * The `provideContexts` helper type in `FactoryContext`. * * Attaches a `context-request` listener to the host, providing the listed * property values as context to descendant consumers. Returns an `EffectDescriptor`. */ type ProvideContextsHelper

= (contexts: Array) => EffectDescriptor; /** * The `requestContext` helper type in `FactoryContext`. * * Dispatches a `context-request` event from the host and returns a `Memo` * that tracks the provider's value. Falls back to `fallback` if no provider responds. * For use inside `expose()` as a property initializer. */ type RequestContextHelper = (context: Context T>, fallback: T) => Memo; declare const CONTEXT_REQUEST = "context-request"; /** * Class for context-request events * * An event fired by a context requester to signal it desires a named context. * * A provider should inspect the `context` property of the event to determine if it has a value that can * satisfy the request, calling the `callback` with the requested value if so. * * If the requested context event contains a truthy `subscribe` value, then a provider can call the callback * multiple times if the value is changed, if this is the case the provider should pass an `unsubscribe` * function to the callback which requesters can invoke to indicate they no longer wish to receive these updates. * * @class ContextRequestEvent * @extends {Event} * * @property {T} context - context key * @property {ContextCallback>} callback - callback function for value getter and unsubscribe function * @property {boolean} [subscribe=false] - whether to subscribe to context changes */ declare class ContextRequestEvent extends Event { readonly context: T; readonly callback: ContextCallback>; readonly subscribe: boolean; constructor(context: T, callback: ContextCallback>, subscribe?: boolean); } /** * Create a typed context key. * * The Context type brands the key type with the `__context__` property that * carries the type of the value the context references. This helper function * creates a properly typed context key from a plain value. * * @since 2.0.2 * @param {string} key - The context key (typically a string) * @returns {Context} A typed context key * * @example * ```ts * const themeContext = createContext<() => string>('theme') * const countContext = createContext<() => number>('count') * ``` */ declare const createContext: (key: string) => Context; /** * Create a `provideContexts` helper bound to a specific component host. * * Returns a function that takes a `contexts` array and returns an `EffectDescriptor`. * When activated, attaches a `context-request` listener to `host`; provides a * getter `() => host[context]` for each matching context key. * * @since 2.0 * @param {HTMLElement & P} host - The component host element * @returns {ProvideContextsHelper

} Bound `provideContexts` function for the given host */ declare const makeProvideContexts:

(host: HTMLElement & P) => ProvideContextsHelper

; /** * Create a `requestContext` helper bound to a specific component host. * * Returns a function that dispatches a `context-request` event from `host` * and wraps the resolved getter in a `Memo`. If no provider responds, * the Memo returns `fallback`. For use inside `expose()` as a property initializer. * * @since 2.0 * @param {HTMLElement & P} host - The component host element * @returns {RequestContextHelper} Bound `requestContext` function for the given host */ declare const makeRequestContext:

(host: HTMLElement & P) => RequestContextHelper; export { CONTEXT_REQUEST, type Context, type ContextCallback, ContextRequestEvent, type ContextType, createContext, makeProvideContexts, makeRequestContext, type ProvideContextsHelper, type RequestContextHelper, type UnknownContext, };