@wippy-fe/types-global-proxy

TypeScript ambient declarations for the Wippy iframe proxy globals.

Installation

npm install -D @wippy-fe/types-global-proxy

What it declares

• window.getWippyApi() — returns Promise<ProxyApiInstance>
• window.$W.* — lazy async accessors for config, api, host, on, state, ws, loadWebComponent
• window.__WIPPY_APP_CONFIG__ — AppConfig
• window.__WIPPY_APP_API__ — ProxyApiInstance
• window.__WIPPY_PROXY_CONFIG__ — ProxyConfig

Exported types

ProxyApiInstance, AppConfig, AppFeatures, AppCustomization, StateApi, ProxyWsApi, WsMessage, WsCommand, Artifact, PageApi, UploadApi, ApiRoutes, and all WebSocket message/topic types.

Usage

Add to your tsconfig.json:

{
  "compilerOptions": {
    "types": ["@wippy-fe/types-global-proxy"]
  }
}

Or use a triple-slash reference:

/// <reference types="@wippy-fe/types-global-proxy" />