zephyr-edge-contract/dist/lib/zephyr-global.d.ts

Edge contract for Zephyr

/**
 * Global Zephyr runtime namespace contract.
 *
 * This object is intended to live on `globalThis.__ZEPHYR__` and, in browser
 * environments, on `window.__ZEPHYR__`.
 */
export interface ZephyrGlobalNamespace {
    /** Schema version for the global namespace contract. */
    version: 1;
    /** Runtime feature namespaces managed by Zephyr packages. */
    runtime: ZephyrRuntimeNamespace;
}
export interface ZephyrRuntimeNamespace {
    /** Namespace reserved for zephyr-native-cache integrations. */
    nativeCache?: ZephyrNativeCacheNamespace;
    [namespace: string]: unknown;
}
export interface ZephyrNativeCacheNamespace {
    /** App-facing or internal control functions. */
    controls?: ZephyrNativeCacheControls;
    /** Runtime references kept for integrations/debugging. */
    refs?: ZephyrNativeCacheRefs;
    /** Runtime state snapshot metadata for integrations/debugging. */
    state?: ZephyrNativeCacheState;
}
export interface ZephyrNativeCacheControls {
    checkForUpdates?: (options?: unknown) => Promise<unknown>;
    startUpdatePolling?: (intervalMs?: number) => void;
    stopUpdatePolling?: () => void;
    clearCache?: () => Promise<void>;
    [key: string]: unknown;
}
export interface ZephyrNativeCacheRefs {
    cacheLayer?: unknown;
    bundleHashes?: Record<string, string>;
    [key: string]: unknown;
}
export interface ZephyrNativeCacheState {
    cacheEnabled?: boolean;
    forceCacheInDev?: boolean;
    pollIntervalMs?: number;
    pollingEnabled?: boolean;
    isPolling?: boolean;
    registeredAt?: number;
    lastPollAt?: number;
    lastPollChecked?: number;
    lastPollUpdated?: number;
    pendingUpdates?: string[];
    [key: string]: unknown;
}
declare global {
    var __ZEPHYR__: ZephyrGlobalNamespace | undefined;
    interface Window {
        __ZEPHYR__?: ZephyrGlobalNamespace;
    }
}
//# sourceMappingURL=zephyr-global.d.ts.map