@shuffleio/shuffle-mcps 0.0.3 → 0.0.5

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import React$1 from 'react';
+import React$1, { ReactNode } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 
 /**
  * Local Singul Library - Helpers
@@ -83,7 +84,26 @@ interface AppAuthentication {
     };
 }
 interface ShuffleMCPProps {
-    authToken: string;
+    /**
+     * Shuffle API key. Used as the `Authorization: Bearer` header on every
+     * request the component makes (`/api/v1/apps/authentication`,
+     * `/api/v1/apps`) AND forwarded into the OAuth handoff URL as `&auth=`.
+     * This is the canonical credential — pass it once.
+     */
+    apiKey?: string;
+    /**
+     * @deprecated Use `apiKey` instead. Kept for backwards compatibility — if
+     * `apiKey` is set, it is used for the redirect handoff too. If you only
+     * provide `authToken` it is still forwarded into the auth URL but no API
+     * calls will be made.
+     */
+    authToken?: string;
+    /**
+     * Optional Shuffle organization ID. When provided, every API call this
+     * component makes (Shuffle backend + Singul gateway) will include an
+     * `Org-Id: <orgId>` header so the request is scoped to that org.
+     */
+    orgId?: string;
     placeholder?: string;
     layout?: 'list' | 'grid';
     gridColumns?: number | {
@@ -107,8 +127,6 @@ interface ShuffleMCPProps {
     initialFilterQuery?: string;
     /** Number of results per search (default: 15) */
     hitsPerPage?: number;
-    /** API key for fetching authenticated apps from the auth endpoint */
-    apiKey?: string;
     /** Base URL for backend API calls (default: https://shuffler.io) */
     apiBaseUrl?: string;
     /** Path appended to apiBaseUrl to fetch authenticated apps (default: /api/v1/apps/authentication) */
@@ -160,4 +178,322 @@ interface ShuffleMCPHandle {
 }
 declare const ShuffleMCP: React$1.ForwardRefExoticComponent<ShuffleMCPProps & React$1.RefAttributes<ShuffleMCPHandle>>;
 
-export { type AlgoliaSearchApp, type AppAuthentication, type AppSelectedEvent, type CustomStyles, ShuffleMCP, type ShuffleMCPHandle, type ShuffleMCPProps, ShuffleMCP as default };
+/**
+ * AppDetailDrawer — Shows app detail content (header, auth, MCP chat, API viewer)
+ * inside a drawer. Used from alluvial diagrams and the app search drawer.
+ *
+ * Accepts either an app name (fetches data) or pre-loaded app info.
+ */
+/**
+ * Singul standard actions catalog, keyed by lowercase category fragment.
+ * Mirrors the canonical action names exposed by https://singul.io —
+ * each name becomes the `{action}` segment in `POST /api/{action}`.
+ * Fields shown here are starter parameters; the full schema lives on
+ * the Singul side and is editable in the curl preview below.
+ */
+interface AppDetailDrawerProps {
+    open: boolean;
+    onClose: () => void;
+    /** App name to load */
+    appName: string | null;
+    /** Anchor side */
+    anchor?: 'left' | 'right';
+    /** Width in px */
+    width?: number;
+    /** Called when drawer closes so parent can refresh data */
+    onRefresh?: () => void;
+    /** When set, replaces the Activate button with "+ Add" and calls this on click */
+    onAddToCanvas?: (appInfo: {
+        name: string;
+        icon: string;
+        algoliaId: string | null;
+    }) => void;
+    /** Whether the current user is authenticated. Defaults to true. */
+    isAuthenticated?: boolean;
+    /** Host app's currently active org id. If different from the library's tracked org,
+     *  an `Org-Id` header is injected into the Singul curl preview. */
+    activeOrgId?: string | null;
+}
+declare function AppDetailDrawer({ open, onClose, appName, anchor, width, onRefresh, onAddToCanvas, isAuthenticated, activeOrgId, }: AppDetailDrawerProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * AppSearchDrawer — Reusable drawer for searching apps.
+ * Selecting an app opens the AppDetailDrawer for full configuration.
+ */
+interface ConnectionPathApp {
+    name: string;
+    icon: string;
+    hasValidAuth?: boolean;
+    isActiveOnly?: boolean;
+}
+interface AppSearchDrawerProps {
+    open: boolean;
+    onClose: () => void;
+    initialQuery?: string;
+    title?: string;
+    subtitle?: string;
+    anchor?: 'left' | 'right';
+    width?: number;
+    /** Show the Shuffle Pipelines banner above search results */
+    showPipelinesBanner?: boolean;
+    /** If provided, selecting an app calls this instead of opening AppDetailDrawer */
+    onQuickSelect?: (app: {
+        name: string;
+        icon: string;
+        categories: string[];
+        id: string | null;
+    }) => void;
+    /** If provided, called before default behavior. Return true to prevent opening detail drawer. */
+    onSelectOverride?: (app: {
+        name: string;
+        icon: string;
+        categories: string[];
+    }) => boolean;
+    /** Called when the detail drawer closes, with the app name that was being configured */
+    onDetailClose?: (appName: string) => void;
+    /** When set, replaces Activate with "+ Add" in the detail drawer */
+    onAddToCanvas?: (appInfo: {
+        name: string;
+        icon: string;
+        algoliaId: string | null;
+    }) => void;
+    /** When set, apps matching this category are sorted to the top in user's apps */
+    priorityCategory?: string;
+    /** Apps currently in the connection path diagram — shown first in the drawer */
+    connectionPathApps?: ConnectionPathApp[];
+    /** Apps to pin at the top of the ShuffleMCP search results (deduped by name). */
+    pinnedApps?: Array<{
+        name: string;
+        image_url: string;
+        categories?: string[];
+        objectID?: string;
+    }>;
+}
+declare function AppSearchDrawer({ open, onClose, initialQuery, title, subtitle, anchor, width, showPipelinesBanner, onQuickSelect, onSelectOverride, onDetailClose, onAddToCanvas, priorityCategory, connectionPathApps, pinnedApps, }: AppSearchDrawerProps): react_jsx_runtime.JSX.Element;
+
+declare function ShufflePipelinesBanner(): react_jsx_runtime.JSX.Element;
+
+/**
+ * AppTitleHeader — Standalone title/header card for an app.
+ *
+ * Shows avatar (with valid-auth border), name, Verified/Pending chip,
+ * categories, and either an "Activate/Deactivate" or "+ Add" action.
+ *
+ * Pure presentational component — pass in already-resolved props.
+ */
+interface AppTitleHeaderProps {
+    /** Display name of the app (will be capitalized via CSS). */
+    name: string;
+    /** Image URL for the app icon. */
+    image?: string;
+    /** Whether at least one valid authentication exists. */
+    hasValidAuth?: boolean;
+    /** Whether at least one auth entry exists (valid or not). */
+    hasAnyAuth?: boolean;
+    /** Whether the host is authenticated — controls Verified/Pending chip + Activate button visibility. */
+    isAuthenticated?: boolean;
+    /** App categories to display as chips. */
+    categories?: string[];
+    /** Activation state — `null` hides the Activate button. */
+    isActivated?: boolean | null;
+    /** Whether activation toggle is in-flight. */
+    activateLoading?: boolean;
+    /** Called when user clicks Activate/Deactivate. */
+    onActivateToggle?: () => void;
+    /** When provided, replaces the Activate button with "+ Add". */
+    onAdd?: () => void;
+}
+declare function AppTitleHeader({ name, image, hasValidAuth, hasAnyAuth, isAuthenticated, categories, isActivated, activateLoading, onActivateToggle, onAdd, }: AppTitleHeaderProps): react_jsx_runtime.JSX.Element;
+
+interface AppAuthSectionProps {
+    /** Display name (used in copy when no auth exists). */
+    displayName: string;
+    /** Algolia app object — required to render the AuthCard. */
+    algoliaApp: AlgoliaSearchApp | null;
+    /** Resolved app id (Algolia objectID). When missing the card is hidden. */
+    resolvedAlgoliaId: string | null;
+    /** Auth state object from useAppAuth. */
+    authState: any;
+    /** Whether the card is expanded. */
+    expanded: boolean;
+    onToggle: () => void;
+    /** Number of matching auth entries — drives the subtitle copy. */
+    authCount: number;
+    /** Whether the host is authenticated (no Cloud session = hide form). */
+    isAuthenticated?: boolean;
+    /** Auth entries already filtered to this app. */
+    matchingEntries: any[];
+    onAuthChange: any;
+    onTestConnection: (appId: string, authId?: string) => any;
+    onSaveAuth: (appId: string, credentials: Record<string, string>) => Promise<boolean>;
+    onRefreshAuth: () => void;
+}
+declare function AppAuthSection({ displayName, algoliaApp, resolvedAlgoliaId, authState, expanded, onToggle, authCount, isAuthenticated, matchingEntries, onAuthChange, onTestConnection, onSaveAuth, onRefreshAuth, }: AppAuthSectionProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * TryMcpSection — Standalone "Try MCP" block.
+ *
+ * Wraps the heading + AppMcpChat. Pass in the resolved app props.
+ */
+interface TryMcpSectionProps {
+    appName: string;
+    /** Image URL used as the chat avatar. */
+    appIcon?: string;
+    /** Resolved app id (Algolia objectID or Shuffle id). */
+    appId: string;
+    /** App categories — used to pick suggested actions. */
+    categories?: string[];
+}
+declare function TryMcpSection({ appName, appIcon, appId, categories }: TryMcpSectionProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * SingulActionsPreview — Standalone "Try individual actions" block.
+ *
+ * Renders the action picker (grouped by category), curl/python toggle,
+ * editable snippet, Play button (calls Shuffle Tools `execute_python` or
+ * the http app `curl` action) and a response area that streams in.
+ *
+ * Self-contained — pass in the app name + categories. Optionally pass
+ * `activeOrgId` so multi-org curl previews include the right Org-Id header.
+ */
+declare const SingulActionsPreview: ({ appName, categories, activeOrgId, }: {
+    appName: string;
+    categories?: string[];
+    activeOrgId?: string | null;
+}) => react_jsx_runtime.JSX.Element;
+
+/**
+ * useAppLookup — Resolve an app's display name, image, categories,
+ * canonical Algolia objectID and matching auth entries from just
+ * an app name (or id).
+ *
+ * Used by the standalone section components (Authentication, Try MCP,
+ * Try individual actions) so consumers only need to pass `appName`.
+ *
+ * Resolution order:
+ *  1. Algolia `appsearch` index (best-effort, may 429)
+ *  2. /api/v1/apps fallback (private + activated apps)
+ *  3. /api/v1/apps/:id/config to enrich with auth schema
+ */
+
+interface AppLookupResult {
+    loading: boolean;
+    displayName: string;
+    image: string;
+    categories: string[];
+    /** Canonical Algolia objectID (or Shuffle private app id). */
+    algoliaId: string | null;
+    /** Synthesized AlgoliaSearchApp suitable for AppAuthCard. */
+    algoliaApp: AlgoliaSearchApp | null;
+    /** Auth entries matching this app name. */
+    matchingEntries: any[];
+    hasValidAuth: boolean;
+    hasAnyAuth: boolean;
+    authCount: number;
+    authState: any;
+    handleAuthChange: any;
+    handleTestConnection: (appId: string, authId?: string) => any;
+    handleSaveAuth: (appId: string, credentials: Record<string, string>) => Promise<boolean>;
+    refreshAuth: () => void;
+}
+declare function useAppLookup(appName: string | null): AppLookupResult;
+
+interface IntegrationStatusProps {
+    collapsed: boolean;
+    /** When provided, only show integrations whose name is in this list */
+    filterApps?: string[];
+    /** When provided, the Add button calls this instead of navigating to /onboarding */
+    onAddClick?: () => void;
+    /** Icon size override (default: 26) */
+    iconSize?: number;
+    /** When provided, hovering an icon shows a cross-out button that calls this with the app name */
+    onDisable?: (name: string) => void;
+    /** Set of app names that are currently disabled */
+    disabledApps?: Set<string>;
+    /** Show all integrations without truncation */
+    showAll?: boolean;
+    /** Hide the Add Integration button */
+    hideAddButton?: boolean;
+    /** Hide the "Integrations" section header */
+    hideHeader?: boolean;
+    /** When set, apps matching this category are sorted to the top */
+    priorityCategory?: string;
+}
+/** Fire this event from anywhere to make all IntegrationStatus instances re-fetch. */
+declare const refreshAllIntegrationStatus: () => void;
+declare const IntegrationStatus: ({ collapsed, filterApps, onAddClick, iconSize, onDisable, disabledApps, showAll, hideAddButton, hideHeader, priorityCategory }: IntegrationStatusProps) => react_jsx_runtime.JSX.Element;
+
+type AuthStatus = 'pending' | 'testing' | 'connected' | 'error';
+interface AppAuthState {
+    systemId: string;
+    status: AuthStatus;
+    credentials: Record<string, string>;
+    errorMessage?: string;
+    successMessage?: string;
+    warningMessage?: string;
+    workflowId?: string;
+    executionId?: string;
+    errorCode?: number;
+}
+interface ApiAuthEntry {
+    id?: string;
+    label?: string;
+    app: {
+        id: string;
+        name: string;
+        large_image?: string;
+    };
+    active?: boolean;
+    created?: number;
+    edited?: number;
+    validation?: {
+        valid: boolean;
+        error?: string;
+        last_valid?: number;
+    };
+}
+
+declare function useAppAuth(): {
+    authStates: Record<string, AppAuthState>;
+    authenticatedApps: ApiAuthEntry[];
+    loading: boolean;
+    handleAuthChange: (systemId: string, credentials: Record<string, string>) => void;
+    handleTestConnection: (systemId: string, authenticationId?: string) => Promise<void>;
+    handleSaveAuth: (appId: string, credentials: Record<string, string>, appName?: string) => Promise<boolean>;
+    refreshAuth: () => Promise<void>;
+};
+
+interface AppDetailContextType {
+    openApp: (appName: string) => void;
+    closeApp: () => void;
+    currentAppName: string | null;
+    isOpen: boolean;
+}
+declare const AppDetailProvider: ({ children }: {
+    children: ReactNode;
+}) => react_jsx_runtime.JSX.Element;
+declare const useAppDetail: () => AppDetailContextType;
+
+declare const API_CONFIG: {
+    readonly baseUrl: string;
+    version: string;
+    readonly apiKey: string | null;
+    setApiKey(key: string | null): void;
+};
+declare const getApiUrl: (endpoint: string) => string;
+declare const getAuthHeader: (overrideOrgId?: string | null) => Record<string, string>;
+
+/**
+ * Tiny toast facade — library version. The host app can replace this by
+ * setting a custom impl via setToastImpl(). Falls back to console.warn.
+ */
+type ToastArg = {
+    title?: string;
+    description?: string;
+    variant?: 'default' | 'destructive';
+};
+type ToastFn = (arg: ToastArg) => void;
+declare function setToastImpl(fn: ToastFn): void;
+declare const toast: ToastFn;
+
+export { API_CONFIG, type AlgoliaSearchApp, AppAuthSection, type AppAuthSectionProps, type AppAuthentication, AppDetailDrawer, AppDetailProvider, type AppLookupResult, AppSearchDrawer, type AppSelectedEvent, AppTitleHeader, type AppTitleHeaderProps, type CustomStyles, IntegrationStatus, ShuffleMCP, type ShuffleMCPHandle, type ShuffleMCPProps, ShufflePipelinesBanner, SingulActionsPreview, TryMcpSection, type TryMcpSectionProps, ShuffleMCP as default, getApiUrl, getAuthHeader, refreshAllIntegrationStatus, setToastImpl, toast, useAppAuth, useAppDetail, useAppLookup };