@paubox/ui 1.18.2 → 1.19.1

package/package.json

@@ -2,7 +2,7 @@
   "name": "@paubox/ui",
   "author": "Paubox, Inc.",
   "description": "Paubox Component Library",
-  "version": "1.18.2",
+  "version": "1.19.1",
   "type": "module",
   "private": false,
   "publishConfig": {

package/src/index.d.ts

@@ -14,6 +14,7 @@ export * from './lib/Popper/Popper';
 export * from './lib/RadioButton/RadioButton';
 export * from './lib/RadioGroup/RadioGroup';
 export * from './lib/SearchBar/SearchBar';
+export * from './lib/SearchOmnibox/SearchOmnibox';
 export * from './lib/Table/Table';
 export * from './lib/Toggle/Toggle';
 export * from './lib/Tooltip/Tooltip';

package/src/lib/Inputs/index.d.ts

@@ -1,7 +1,6 @@
 export * from './AutoComplete';
 export * from './Input';
 export * from './MultiSelect';
-export * from './Search';
 export * from './MultiInput';
 export * from './Select';
 export * from './TextArea';

package/src/lib/SearchOmnibox/SearchOmnibox.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Identifier for which search bar in the dashboard a request originated from.
+ * Matches the `SearchBar` enum in pb_search (Rust) so the same string is wire-compatible
+ * for both `bar=` query params and request bodies.
+ */
+export type SearchBarKey = 'inbound_mail_log' | 'inbound_quarantine' | 'inbound_quarantine_history' | 'outbound_mail_log' | 'outbound_quarantine' | 'outbound_quarantine_history' | 'outbound_senders_encrypted' | 'outbound_senders_not_encrypted' | 'outbound_senders_inactive' | 'inbound_rulesets' | 'inbound_relays' | 'inbound_execprotect' | 'inbound_execprotect_notifications' | 'inbound_tags' | 'mail_archive' | 'mail_archive_excluded_users' | 'dlp_rules' | 'dlp_excluded_users' | 'email_api_mail_log' | 'email_api_settings' | 'email_api_webhooks' | 'paubox_forms' | 'users';
+export interface SearchOmniboxResult {
+    message_id: string;
+    customer_id: string;
+    from: string;
+    to: string[];
+    subject: string;
+    direction: string;
+    /** ISO 8601 */
+    timestamp: string;
+    /** Subject with matched terms wrapped in `<em>` (will be sanitized before render) */
+    highlight_subject?: string;
+    /** Body snippet with matched terms wrapped in `<em>` (will be sanitized before render) */
+    highlight_body?: string;
+}
+export interface SearchOmniboxProps {
+    /** Which search bar this represents — scopes Redis history and applies implicit OpenSearch filters */
+    bar: SearchBarKey;
+    /** Placeholder when input is empty (e.g. "Search mail log (try from:, to:, subject:)") */
+    placeholder?: string;
+    /**
+     * Base URL of the pb_search service (no trailing slash).
+     * Required when `mode='remote'` or `withHistory !== false`. Ignored otherwise.
+     */
+    pbSearchBaseUrl?: string;
+    /**
+     * Returns the current Bearer token to send to pb_search.
+     * Required when `mode='remote'` or `withHistory !== false`. Ignored otherwise.
+     */
+    getAuthToken?: () => Promise<string> | string;
+    /**
+     * 'remote' (default for mail bars) — autocomplete dropdown fetches results from pb_search.
+     * 'local' — autocomplete dropdown filters `localCandidates` client-side; recent searches still come from Redis (unless `withHistory` is false).
+     */
+    mode?: 'remote' | 'local';
+    /**
+     * Whether to use Redis-backed recent-search history. Defaults to `true`.
+     *
+     * When `false`:
+     * - No `/recent_searches` calls are made (no focus fetch, no prefix fetch, no record-on-pick, no delete)
+     * - The recent-searches dropdown view is suppressed (input must be non-empty for the dropdown to open)
+     * - Ghost-text tab autocomplete is disabled (it's sourced from recent searches)
+     *
+     * Set this to `false` for config / list pages that don't need per-user history.
+     * Pairs naturally with `mode='local'` to keep the component fully decoupled
+     * from pb_search.
+     */
+    withHistory?: boolean;
+    /** Remote mode: called when user clicks a result row in the dropdown. */
+    onResultClick?: (result: SearchOmniboxResult) => void;
+    /** Called when user presses Enter (or clicks the "All results" footer) to commit a full search. */
+    onSubmitFullSearch?: (query: string) => void;
+    /** Local mode only: candidate strings to filter against (e.g. ruleset names, usernames). */
+    localCandidates?: string[];
+    /** Local mode: fires when the (debounced) query changes; let the page filter its own table. */
+    onLocalQueryChange?: (query: string) => void;
+    /** Test id prefix; defaults to `search-omnibox`. */
+    testId?: string;
+    /** Optional initial query (e.g. when restoring from URL state). */
+    initialQuery?: string;
+}
+export declare const SearchOmnibox: ({ bar, placeholder, pbSearchBaseUrl, getAuthToken, mode, withHistory, onResultClick, onSubmitFullSearch, localCandidates, onLocalQueryChange, testId, initialQuery, }: SearchOmniboxProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/lib/Inputs/Search.d.ts

@@ -1,9 +0,0 @@
-export interface SearchProps extends React.InputHTMLAttributes<HTMLInputElement> {
-    sz?: 'sm' | 'lg';
-    clearable?: boolean;
-    loading: boolean;
-    setLoading?: (value: boolean) => void;
-    setSearchValue: (value: string) => void;
-}
-export declare const loadingWheelStyle: import("@emotion/react").SerializedStyles;
-export declare const Search: ({ loading, setLoading, setSearchValue, clearable, sz, ...props }: SearchProps) => import("@emotion/react/jsx-runtime").JSX.Element;