@magemetrics/ai 0.11.3 → 0.11.4

package/dist/react/index.d.ts

@@ -214,6 +214,15 @@ declare type ConfigurableChatComponentProps = {
     appearance?: AppearanceConfig;
 };
 
+/** Context usage — the modal reuses an ancestor `MageMetricsContextProvider`. */
+declare type ContextManagedModalProps = ManagedModalInnerProps & {
+    apiKey?: never;
+    externalJwt?: never;
+    apiUrl?: never;
+    components?: never;
+    applicationName?: never;
+};
+
 /** @deprecated This type is no longer used and will be removed in a future version. */
 declare type ControlledModalProps = {
     visible: boolean;
@@ -450,23 +459,18 @@ declare type MageMetricsPublicContextProviderProps = PropsWithChildren<Pick<Mage
 
 export declare const ManagedModal: React.FC<ManagedModalProps>;
 
-declare type ManagedModalBaseProps = ModalProps & {
-    /** API key for authenticating with the MageMetrics service */
-    apiKey: string;
-    /** External JWT token for user authentication */
-    externalJwt: string;
-    /** Base URL for the MageMetrics API */
-    apiUrl: string;
+/**
+ * Props shared by both standalone and context-aware usage of `ManagedModal`.
+ * These are the props that `ManagedModalInner` actually consumes — they have
+ * nothing to do with provider initialisation.
+ */
+declare type ManagedModalInnerProps = ModalProps & {
     /** Whether to disable canvas functionality in conversations */
     disableCanvas?: boolean;
     /** Whether to render data freshness info in the conversation header */
     showDataFreshness?: boolean;
     /** Where to persist modal state (localStorage, queryParam, or none) */
     persist?: PersistenceOptions;
-    /** Custom component overrides for extending functionality */
-    components?: Components;
-    /** Application name to associate with flows created through this modal */
-    applicationName?: string;
     /**
      * Appearance configuration for customizing the visual style.
      * Includes brand colors and modal-specific styling options.
@@ -479,10 +483,7 @@ declare type ManagedModalBaseProps = ModalProps & {
     };
 };
 
-/**
- * Props for ManagedModal component.
- */
-declare type ManagedModalProps = ManagedModalBaseProps;
+declare type ManagedModalProps = StandaloneManagedModalProps | ContextManagedModalProps;
 
 declare const MessagesContainer: default_2.FC;
 
@@ -610,6 +611,32 @@ export declare const StandaloneDataTable: React.FC<{
     onStateChange?: (state: DataTableState) => void;
 }>;
 
+/**
+ * Props for ManagedModal component.
+ *
+ * When rendered inside a `MageMetricsContextProvider`, the modal reuses the
+ * parent context instead of creating a duplicate. In that case `apiKey`,
+ * `externalJwt`, `apiUrl`, `components`, and `applicationName` must **not**
+ * be passed (they are inherited from the parent provider).
+ *
+ * When rendered standalone (no parent context), `apiKey`, `externalJwt`, and
+ * `apiUrl` are **required**, and `components`/`applicationName` may optionally
+ * be provided.
+ */
+/** Standalone usage — the modal creates its own `MageMetricsContextProvider`. */
+declare type StandaloneManagedModalProps = ManagedModalInnerProps & {
+    /** API key for authenticating with the MageMetrics service */
+    apiKey: string;
+    /** External JWT token for user authentication */
+    externalJwt: string;
+    /** Base URL for the MageMetrics API */
+    apiUrl: string;
+    /** Custom component overrides for extending functionality */
+    components?: Components;
+    /** Application name to associate with flows created through this modal */
+    applicationName?: string;
+};
+
 declare type StartOptions = DisplayControlProps & {
     /** Label text displayed above the chat launcher input */
     label?: string;
@@ -1083,22 +1110,13 @@ withTitle: boolean;
 exportingEnabled?: boolean;
 } & RefAttributes<HTMLDivElement>>;
 
-export declare type WebComponentManagedModalProps = ManagedModalProps & {
+export declare type WebComponentManagedModalProps = StandaloneManagedModalProps & {
     enableCsvDownload: boolean;
 };
 
 export { }
 
 
-declare module "react" {
-    namespace JSX {
-        interface IntrinsicElements {
-            "magemetrics-ai": WebComponentManagedModalProps;
-        }
-    }
-}
-
-
 declare module "react" {
     namespace JSX {
         interface IntrinsicElements {