@box/metadata-editor 1.67.6 → 1.69.0

package/dist/types/lib/components/metadata-instance-list/index.d.ts

@@ -1,3 +1,13 @@
-export * from './metadata-instance-list';
+export declare const MetadataInstanceList: {
+    ({ trackEvent, ...rest }: import('./types').MetadataInstanceListProps & {
+        trackEvent?: import('../../utils/analytics').TrackEventCallback;
+    }): import("react/jsx-runtime").JSX.Element;
+    displayName: string;
+};
+export declare const MetadataInstance: {
+    ({ trackEvent, ...rest }: import('./subcomponents/metadata-instance/types').MetadataInstanceProps & {
+        trackEvent?: import('../../utils/analytics').TrackEventCallback;
+    }): import("react/jsx-runtime").JSX.Element;
+    displayName: string;
+};
 export * from './subcomponents/metadata-instance-header/metadata-instance-header';
-export * from './subcomponents/metadata-instance/metadata-instance';

package/dist/types/lib/components/unsaved-changes-modal/types.d.ts

@@ -1,4 +1,5 @@
 import { ModalProps } from '@box/blueprint-web';
+import { TrackEventCallback } from '../../utils/analytics';
 export interface UnsavedChangesModalProps extends Pick<ModalProps, 'open' | 'defaultOpen'> {
     /**
      * Callback to be invoked when the user clicks the "Continue Editing" button or the (X) button.
@@ -14,4 +15,10 @@ export interface UnsavedChangesModalProps extends Pick<ModalProps, 'open' | 'def
      * closing the modal.
      */
     onDiscardChanges: () => void;
+    /**
+     * Optional analytics callback invoked when the modal is shown and when the user
+     * discards changes. The host is responsible for forwarding to its analytics pipeline
+     * and attaching any tags (e.g. `component`).
+     */
+    trackEvent?: TrackEventCallback;
 }

package/dist/types/lib/components/unsaved-changes-modal/unsaved-changes-modal.d.ts

@@ -1,2 +1,2 @@
 import { UnsavedChangesModalProps } from './types';
-export declare function UnsavedChangesModal({ onBackToEdit, onDiscardChanges, defaultOpen, open: propsOpen, }: UnsavedChangesModalProps): import("react/jsx-runtime").JSX.Element;
+export declare function UnsavedChangesModal({ onBackToEdit, onDiscardChanges, defaultOpen, open: propsOpen, trackEvent, }: UnsavedChangesModalProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/lib/test-utils/index.d.ts

@@ -1,5 +1,6 @@
 export * from './confidence-score-fixtures';
 export * from './formik-wrapper';
+export * from './mock-resize-observer';
 export * from './pending-promise';
 export * from './sample-data';
 export * from './test-utils';

package/dist/types/lib/test-utils/mock-resize-observer.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Registers a ResizeObserver mock for the current test suite.
+ * Call inside a describe block.
+ */
+export declare function mockResizeObserver(): void;

package/dist/types/lib/utils/analytics/analytics-context.d.ts

@@ -0,0 +1,12 @@
+import { default as React } from 'react';
+import { TrackEventCallback } from './events';
+export type AnalyticsContextValue = {
+    trackEvent: TrackEventCallback;
+};
+export declare const AnalyticsContext: React.Context<AnalyticsContextValue>;
+export interface AnalyticsContextProviderProps {
+    children: React.ReactNode;
+    trackEvent?: TrackEventCallback;
+}
+export declare const AnalyticsContextProvider: ({ children, trackEvent, }: AnalyticsContextProviderProps) => React.ReactElement;
+export declare const useMetadataEditorAnalytics: () => AnalyticsContextValue;

package/dist/types/lib/utils/analytics/events.d.ts

@@ -0,0 +1,9 @@
+export declare const EVENT_NAMES: {
+    readonly LOW_CONF_BADGE_HOVER: "metadata_editor_low_conf_badge_hover";
+    readonly LOW_CONF_ICON_HOVER_READ_MODE: "metadata_editor_low_conf_icon_hover_read_mode";
+    readonly AI_SUGGESTION_SHOWN: "metadata_editor_ai_suggestion_shown";
+    readonly UNSAVED_MODAL_SHOWN: "metadata_editor_unsaved_modal_shown";
+    readonly UNSAVED_MODAL_DISCARD: "metadata_editor_unsaved_modal_discard";
+    readonly AI_LOGO_BADGE_HOVER: "metadata_editor_conf_score_icon_hover";
+};
+export type TrackEventCallback = (eventName: string, data?: Record<string, unknown>) => void;

package/dist/types/lib/utils/analytics/index.d.ts

@@ -0,0 +1,3 @@
+export * from './events';
+export { AnalyticsContext, AnalyticsContextProvider, useMetadataEditorAnalytics, type AnalyticsContextProviderProps, type AnalyticsContextValue, } from './analytics-context';
+export { withAnalytics } from './with-analytics';

package/dist/types/lib/utils/analytics/with-analytics.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+import { TrackEventCallback } from './events';
+export declare function withAnalytics<P extends object>(Component: React.ComponentType<P>): {
+    ({ trackEvent, ...rest }: P & {
+        trackEvent?: TrackEventCallback;
+    }): import("react/jsx-runtime").JSX.Element;
+    displayName: string;
+};

package/package.json

@@ -1,12 +1,12 @@
 {
     "name": "@box/metadata-editor",
-    "version": "1.67.6",
+    "version": "1.69.0",
     "peerDependencies": {
         "@ariakit/react": "0.4.21",
         "@box/blueprint-web": "^14.18.0",
         "@box/blueprint-web-assets": "^4.115.4",
-        "@box/box-ai-agent-selector": "^1.40.6",
-        "@box/combobox-with-api": "^1.43.6",
+        "@box/box-ai-agent-selector": "^1.40.7",
+        "@box/combobox-with-api": "^1.43.7",
         "formik": "^2.0.3",
         "lodash": "^4.17.15",
         "react": "^17.0.0 || ^18.0.0",
@@ -18,7 +18,7 @@
         "@box/babel-plugin-target-attributes": "1.5.19",
         "@box/blueprint-web": "^14.18.0",
         "@box/blueprint-web-assets": "^4.115.4",
-        "@box/box-ai-agent-selector": "^1.40.6",
+        "@box/box-ai-agent-selector": "^1.40.7",
         "@box/storybook-utils": "^0.18.4",
         "@testing-library/react": "^15.0.6",
         "react": "^18.3.0",

package/dist/chunks/interactive-text.js

@@ -1,17 +0,0 @@
-import { Text as e, Tooltip as t } from "@box/blueprint-web";
-import { Focusable as n } from "@ariakit/react";
-import { jsx as r } from "react/jsx-runtime";
-import i from "clsx";
-import '../styles/interactive-text.css';var a = { interactiveText: "_interactiveText_1i8lr_1" }, o = ({ tooltipText: o, className: s, children: c, ...l }) => {
-	let { as: u = "span" } = l;
-	return /* @__PURE__ */ r(t, {
-		content: o,
-		children: /* @__PURE__ */ r(n, { render: /* @__PURE__ */ r(e, {
-			as: u,
-			className: i(a.interactiveText, s),
-			...l,
-			children: c
-		}) })
-	});
-};
-export { o as t };