@openmrs/esm-extensions/dist/store.d.ts

Coordinates extensions and extension points in the OpenMRS Frontend

import type { ConfigObject, ExtensionSlotConfig } from '@openmrs/esm-config';
import { type LifeCycles } from 'single-spa';
export interface ExtensionMeta {
    [_: string]: any;
}
export interface ExtensionRegistration {
    readonly name: string;
    load(): Promise<LifeCycles>;
    readonly moduleName: string;
    readonly meta: Readonly<ExtensionMeta>;
    readonly order?: number;
    readonly online?: boolean;
    readonly offline?: boolean;
    readonly privileges?: string | Array<string>;
    readonly featureFlag?: string;
}
export interface ExtensionInfo extends ExtensionRegistration {
    /**
     * The instances where the extension has been rendered using `renderExtension`.
     */
    instances: Array<ExtensionInstance>;
}
export interface ExtensionInstance {
    id: string;
    slotName: string;
    slotModuleName: string;
}
export interface ExtensionInternalStore {
    /** Slots indexed by name */
    slots: Record<string, ExtensionSlotInfo>;
    /** Extensions indexed by name */
    extensions: Record<string, ExtensionInfo>;
}
export interface ExtensionSlotInfo {
    /**
     * The module in which the extension slot exists. Undefined if the slot
     * hasn't been registered yet (but it has been attached or assigned to
     * an extension.
     */
    moduleName?: string;
    /** The name under which the extension slot has been registered. */
    name: string;
    /**
     * The set of extension IDs which have been attached to this slot using `attach`.
     * However, not all of these extension IDs should be rendered.
     * `assignedIds` is the set defining those.
     */
    attachedIds: Array<string>;
    /** The configuration provided for this slot. `null` if not yet loaded. */
    config: Omit<ExtensionSlotConfig, 'configuration'> | null;
}
export interface ExtensionStore {
    slots: Record<string, ExtensionSlotState>;
}
export interface ExtensionSlotState {
    moduleName?: string;
    assignedExtensions: Array<AssignedExtension>;
}
export interface AssignedExtension {
    readonly id: string;
    readonly name: string;
    readonly moduleName: string;
    readonly meta: Readonly<ExtensionMeta>;
    /** The extension's config. Note that this will be `null` until the slot is mounted. */
    readonly config: Readonly<ConfigObject> | null;
    readonly online?: boolean | object;
    readonly offline?: boolean | object;
    readonly featureFlag?: string;
}
/** @deprecated replaced with AssignedExtension */
export interface ConnectedExtension {
    readonly id: string;
    readonly name: string;
    readonly moduleName: string;
    readonly meta: Readonly<ExtensionMeta>;
    /** The extension's config. Note that this will be `null` until the slot is mounted. */
    readonly config: Readonly<ConfigObject> | null;
}
/**
 * This gets the extension system's internal store. It is subject
 * to change radically and without warning. It should not be used
 * outside esm-core.
 * @internal
 */
export declare const getExtensionInternalStore: () => import("zustand").StoreApi<ExtensionInternalStore>;
/** @internal */
export declare function updateInternalExtensionStore(updater: (state: ExtensionInternalStore) => ExtensionInternalStore): void;
/**
 * This returns a store that modules can use to get information about the
 * state of the extension system.
 */
export declare const getExtensionStore: () => import("zustand").StoreApi<ExtensionStore>;