@wippy-fe/types-global-proxy 0.0.17 → 0.0.19

package/index.d.ts

@@ -4,21 +4,6 @@ import { ConfirmationOptions } from 'primevue/confirmationoptions';
 import { ToastMessageOptions } from 'primevue/toast';
 import * as tailwindcss_types_config from 'tailwindcss/types/config';
 
-var session = {
-	type: "non-persistent"
-};
-var history = "browser";
-var env = {
-	APP_API_URL: "",
-	APP_AUTH_API_URL: "",
-	APP_WEBSOCKET_URL: ""
-};
-var featureRS = {
-	session: session,
-	history: history,
-	env: env
-};
-
 var chat = {
 	emptyState: {
 		title: "No chat session selected",
@@ -101,7 +86,6 @@ var textRS = {
 	keeper: keeper
 };
 
-type I18NFeatureTypes = typeof featureRS;
 type I18NTextTypes = typeof textRS;
 
 /**
@@ -187,30 +171,50 @@ type ApiRoutesOverride = {
     };
 };
 
-interface AppFeatures extends I18NFeatureTypes {
-    /**
-     * If to remember auth details or not
-     */
-    session: {
-        type: 'non-persistent' | 'cookie';
-    };
-    history: 'browser' | 'hash';
-    env: {
-        APP_API_URL: string;
-        APP_AUTH_API_URL: string;
-        APP_WEBSOCKET_URL: string;
-    };
-    axiosDefaults?: Partial<AxiosDefaults>;
-    routePrefix?: string;
+interface IconDef {
+    body: string;
+    width: number;
+    height: number;
+}
+interface CssVariablesMap {
+    [key: string]: string | Record<string, string> | undefined;
+    '@dark'?: Record<string, string>;
+    '@light'?: Record<string, string>;
+}
+interface AppAuthConfig {
+    token: string;
+    expiresAt: string;
+}
+interface ThemingScope {
+    cssVariables?: CssVariablesMap;
+    customCSS?: string;
+    /** @deprecated Use `iconSets` instead */
+    icons?: Record<string, IconDef>;
+    /** Named icon collections. Each key is an Iconify prefix. */
+    iconSets?: Record<string, Record<string, IconDef>>;
+}
+interface HostThemingScope extends ThemingScope {
+    i18n?: Partial<I18NTextTypes>;
+}
+interface ChildrenThemingScope {
+    cssVariables?: CssVariablesMap;
+    customCSS?: string;
+}
+interface AppCustomization {
+    customCSS?: string;
+    cssVariables?: CssVariablesMap;
+    i18n?: Partial<I18NTextTypes>;
+    /** @deprecated Use `iconSets` instead. Icons registered under the 'custom' prefix. */
+    icons?: Record<string, IconDef>;
+    /** Named icon collections. Each key is an Iconify prefix, value is a map of icon name → definition. */
+    iconSets?: Record<string, Record<string, IconDef>>;
+}
+interface HostConfig {
     showAdmin?: boolean;
     allowSelectModel?: boolean;
     startNavOpen?: boolean;
     hideNavBar?: boolean;
     disableRightPanel?: boolean;
-    /**
-     * Hide the session selector dropdown in chat views
-     * @default false
-     */
     hideSessionSelector?: boolean;
     additionalNavItems?: Array<PageApi.Page>;
     chat?: {
@@ -221,67 +225,61 @@ interface AppFeatures extends I18NFeatureTypes {
         };
     };
     apiRoutes?: ApiRoutesOverride;
-    /**
-     * Additional HTML tags to whitelist in the sanitizer.
-     * Map of tag name to allowed attribute names.
-     * 'class' is always implicitly allowed for every tag.
-     */
-    allowAdditionalTags?: Record<string, string[]>;
-    /**
-     * LRU cache configuration for child iframe state preservation.
-     * @default { maxPages: 50, maxSizePerPage: 2097152 }
-     */
     stateCache?: {
-        /** Maximum number of page/artifact state buckets to keep. @default 50 */
         maxPages?: number;
-        /** Maximum JSON-serialized size per page in bytes. @default 2097152 (2 MB) */
         maxSizePerPage?: number;
     };
+    allowAdditionalTags?: Record<string, string[]>;
+    session?: {
+        type: 'non-persistent' | 'cookie';
+    };
+    history?: 'browser' | 'hash';
 }
-interface AppAuthConfig {
-    token: string;
-    expiresAt: string;
-}
-interface CssVariablesMap {
-    [key: string]: string | Record<string, string> | undefined;
-    '@dark'?: Record<string, string>;
-    '@light'?: Record<string, string>;
+interface AppContext {
+    resourceId: string;
+    resourceType: 'page' | 'artifact';
+    route?: string;
+    parentResourceId?: string;
+    nestingDepth?: number;
+    layoutPanelId?: string;
+    layoutId?: string;
+    extensions?: Record<string, unknown>;
 }
-interface AppCustomization {
-    customCSS?: string;
-    cssVariables?: CssVariablesMap;
-    i18n?: Partial<I18NTextTypes>;
-    icons?: Record<string, {
-        body: string;
-        width: number;
-        height: number;
-    }>;
-}
-type DeepPartial<T> = T extends object ? {
-    [P in keyof T]?: DeepPartial<T[P]>;
-} : T;
-interface AppConfigOverrides {
-    customization?: Partial<AppCustomization>;
-    feature?: DeepPartial<AppFeatures>;
+interface AppEnv {
+    APP_API_URL: string;
+    APP_AUTH_API_URL: string;
+    APP_WEBSOCKET_URL: string;
 }
 interface AppConfig {
-    artifactId?: string;
-    /**
-     * Starting app or artifact/page path
-     */
-    path?: string;
-    /**
-     * App features like history mode, session type, etc.
-     */
-    feature?: AppFeatures;
-    /**
-     * Auth configuration
-     */
+    $schema: string;
     auth: AppAuthConfig;
-    /**
-     * App customization like i18n texts, css variables, custom css, etc.
-     */
-    customization?: AppCustomization;
+    env: AppEnv;
+    axiosDefaults?: Partial<AxiosDefaults>;
+    routePrefix?: string;
+    theming: {
+        global?: ThemingScope;
+        host?: HostThemingScope;
+        children?: ChildrenThemingScope;
+    };
+    hostConfig: HostConfig;
+    context: AppContext;
+}
+interface ChildAppConfig {
+    $schema: string;
+    auth: AppAuthConfig;
+    env: AppEnv;
+    axiosDefaults?: Partial<AxiosDefaults>;
+    routePrefix?: string;
+    apiRoutes?: ApiRoutesOverride;
+    customization: AppCustomization;
+    context: AppContext;
+    configOverrides?: AppConfigOverrides;
+}
+interface AppConfigOverrides {
+    customization?: Partial<AppCustomization>;
+    axiosDefaults?: Partial<AxiosDefaults>;
+    routePrefix?: string;
+    apiRoutes?: ApiRoutesOverride;
 }
 
 declare namespace PageApi {
@@ -752,6 +750,37 @@ type Events = {
 };
 declare function createEvents(): <T extends string>(topicPattern: T, callback: T extends KnownTopics ? Events[T] : Events["@message"]) => nanoevents.Unsubscribe;
 
+declare const LogLevel: {
+    readonly Emergency: 0;
+    readonly Alert: 1;
+    readonly Critical: 2;
+    readonly Error: 3;
+    readonly Warning: 4;
+    readonly Notice: 5;
+    readonly Info: 6;
+    readonly Debug: 7;
+};
+type LogLevelValue = typeof LogLevel[keyof typeof LogLevel];
+interface Breadcrumb {
+    category?: string;
+    message?: string;
+    data?: Record<string, unknown>;
+    level?: LogLevelValue;
+    type?: 'default' | 'http' | 'navigation' | 'user' | 'error';
+    timestamp?: number;
+}
+interface LoggerApi {
+    debug: (message: string, data?: Record<string, unknown>) => void;
+    info: (message: string, data?: Record<string, unknown>) => void;
+    warn: (message: string, data?: Record<string, unknown>) => void;
+    error: (message: string, data?: Record<string, unknown>) => void;
+    captureException: (error: unknown, extra?: Record<string, unknown>) => void;
+    captureMessage: (message: string, level?: LogLevelValue, extra?: Record<string, unknown>) => void;
+    addBreadcrumb: (breadcrumb: Breadcrumb) => void;
+    setContext: (name: string, data: Record<string, unknown> | null) => void;
+    setTag: (key: string, value: string | null) => void;
+}
+
 interface StateApiOptions {
     /** Override the default page-level scope. Used by web components with persist-key or nested artifacts. */
     scope?: string;
@@ -796,7 +825,7 @@ interface FormResult {
 }
 type LimitedConfirmationOptions = Omit<ConfirmationOptions, 'target' | 'appendTo' | 'onShow' | 'onHide'>;
 interface ProxyApiInstance {
-    config: AppConfig;
+    config: ChildAppConfig;
     /** @deprecated, use `host` instead */
     iframe: {
         toast: (message: ToastMessageOptions) => void;
@@ -843,6 +872,7 @@ interface ProxyApiInstance {
         submit: (data: FormData | Record<string, unknown>) => Promise<FormResult>;
     };
     on: ReturnType<typeof createEvents>;
+    logger: LoggerApi;
     state: StateApi;
     ws: ProxyWsApi;
     loadWebComponent: (componentId: string, tagName?: string) => Promise<void>;
@@ -866,6 +896,7 @@ interface ProxyConfig {
         iconifyIcons: boolean;
         refreshWhenVisible: boolean;
         historyPolyfill: boolean;
+        errorCapture: boolean;
     };
 }
 
@@ -876,7 +907,7 @@ declare const GLOBAL_API_PROVIDER: "__WIPPY_APP_API__";
 declare const GLOBAL_WEB_COMPONENT_CACHE: "__WIPPY_WEB_COMPONENT_CACHE__";
 declare global {
     interface Window {
-        [GLOBAL_CONFIG_VAR]: AppConfig;
+        [GLOBAL_CONFIG_VAR]: AppConfig | ChildAppConfig;
         [GLOBAL_API_PROVIDER]: ProxyApiInstance;
         [GLOBAL_PROXY_CONFIG_VAR]?: ProxyConfig;
         [GLOBAL_CONFIG_OVERRIDES_VAR]?: AppConfigOverrides;
@@ -923,7 +954,7 @@ declare global {
          */
         initWippyApi: () => Promise<ProxyApiInstance>;
         $W: {
-            config: () => Promise<AppConfig>;
+            config: () => Promise<ChildAppConfig>;
             instance: () => Promise<ProxyApiInstance>;
             api: () => Promise<ProxyApiInstance['api']>;
             /** @deprecated Use `$W.api` instead */
@@ -932,6 +963,7 @@ declare global {
             /** @deprecated Use `$W.host` instead */
             iframe: () => Promise<ProxyApiInstance['host']>;
             on: () => Promise<ProxyApiInstance['on']>;
+            logger: () => Promise<ProxyApiInstance['logger']>;
             state: () => Promise<ProxyApiInstance['state']>;
             ws: () => Promise<ProxyApiInstance['ws']>;
             loadWebComponent: () => Promise<ProxyApiInstance['loadWebComponent']>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wippy-fe/types-global-proxy",
-  "version": "0.0.17",
+  "version": "0.0.19",
   "description": "Global type declarations for Wippy iframe proxy (window.getWippyApi, $W, etc.)",
   "license": "UNLICENSED",
   "types": "index.d.ts"