@makinbakin/sdk 0.0.0-bootstrap.0 → 0.0.1-rc.10

package/hooks/index.d.ts

@@ -1,25 +1,74 @@
 /**
- * `@bakin/sdk/hooks` — React hooks plugin authors can use.
+ * `@makinbakin/sdk/hooks` — React hooks plugin authors can use.
  *
  * Three groups, all re-exports so plugins have one import path:
  *   1. Bakin-wide hooks from `src/hooks/*` (SSE, search, query-state, debug, etc.)
  *   2. Cross-plugin hooks from `plugins/team/hooks/*` (agent data)
  *   3. Cross-plugin hooks from `plugins/workflows/hooks/*` (notification channels)
  */
-export { useAssets, useTrash } from '../_internal/app/hooks/use-assets';
+/** Access the global Zustand store for SSE-driven content state. */
 export { useContentStore } from '../_internal/app/hooks/use-content-store';
+/** Sync a nav item's badge to a derived value; the recommended provider glue. */
+export { useNavBadge } from '../_internal/app/hooks/use-nav-badge';
+/** Read/toggle the global debug (X-Ray) flag. */
 export { useDebug } from '../_internal/app/hooks/use-debug';
+/** Guard a form against unmounting while submission is in flight. */
 export { useFormGuard } from '../_internal/app/hooks/use-form-guard';
+/** Subscribe to runtime connection status (online/offline, last heartbeat). */
 export { useRuntimeStatus } from '../_internal/app/hooks/use-runtime-status';
-export { useQueryState, useQueryArrayState } from '../_internal/app/hooks/use-query-state';
-export { useScheduleJobs, useRunHistory } from '../_internal/app/hooks/use-schedule';
+/** Bind a single component-state value to a URL query param. */
+export { useQueryState } from '../_internal/app/hooks/use-query-state';
+/** Bind a multi-value (array) component state to a URL query param. */
+export { useQueryArrayState } from '../_internal/app/hooks/use-query-state';
+/** List scheduled jobs with live updates. */
+export { useScheduleJobs } from '../_internal/app/hooks/use-schedule';
+/** Fetch run history for a scheduled job. */
+export { useRunHistory } from '../_internal/app/hooks/use-schedule';
 export type { ScheduleJob, RunEntry } from '../_internal/app/hooks/use-schedule';
-export { useSearch, reorderBySearchResults } from '../_internal/app/hooks/use-search';
+/** Hybrid full-text + semantic search across plugins with facet filtering. */
+export { useSearch } from '../_internal/app/hooks/use-search';
+/** Re-rank a local list to match the order returned by a search query. */
+export { reorderBySearchResults } from '../_internal/app/hooks/use-search';
 export type { SearchResult, SearchResponse, UseSearchOptions, UseSearchReturn } from '../_internal/app/hooks/use-search';
+/** Read sidebar open/closed state and toggle helper. */
 export { useSidebar } from '../_internal/app/hooks/use-sidebar';
+/** Subscribe to a Server-Sent Events endpoint with auto-reconnect. */
 export { useSSE } from '../_internal/app/hooks/use-sse';
-export { toast, useToastStore } from '../_internal/app/hooks/use-toast';
+/** Fire a toast notification (success/error/info). */
+export { toast } from '../_internal/app/hooks/use-toast';
+/** Subscribe to the toast store for custom toast UIs. */
+export { useToastStore } from '../_internal/app/hooks/use-toast';
+/** Imperatively resize a vertical pane via mouse drag handle. */
 export { useVerticalResize } from '../_internal/app/hooks/use-vertical-resize';
-export { useAgentStore, useAgent, useAgentList, useAgentColor, useAgentDisplayName, useAgentIds, useMainAgentId, usePackageState, hexToMuted, } from '../_internal/plugins/team/hooks/use-agent-store';
-export { useNotificationChannels, getChannelLabel, getChannelInitials, } from '../_internal/plugins/workflows/hooks/use-notification-channels';
-export { useRouter, usePathname, useSearchParams, useParams } from './router';
+/** Access the agent registry store (Zustand). */
+export { useAgentStore } from '../_internal/plugins/team/hooks/use-agent-store';
+/** Look up a single agent by ID. */
+export { useAgent } from '../_internal/plugins/team/hooks/use-agent-store';
+/** List all registered agents. */
+export { useAgentList } from '../_internal/plugins/team/hooks/use-agent-store';
+/** Get an agent's brand color (hex string). */
+export { useAgentColor } from '../_internal/plugins/team/hooks/use-agent-store';
+/** Get an agent's display name (fallback to ID). */
+export { useAgentDisplayName } from '../_internal/plugins/team/hooks/use-agent-store';
+/** List all registered agent IDs. */
+export { useAgentIds } from '../_internal/plugins/team/hooks/use-agent-store';
+/** Get the ID of the designated main/orchestrator agent. */
+export { useMainAgentId } from '../_internal/plugins/team/hooks/use-agent-store';
+/** Read agent-package install state (managed/adopted/unmanaged). */
+export { usePackageState } from '../_internal/plugins/team/hooks/use-agent-store';
+/** Convert a hex color to a muted variant for backgrounds. */
+export { hexToMuted } from '../_internal/plugins/team/hooks/use-agent-store';
+/** List configured notification channels (Discord, Slack, email, etc.). */
+export { useNotificationChannels } from '../_internal/plugins/workflows/hooks/use-notification-channels';
+/** Get a human-readable label for a channel ID. */
+export { getChannelLabel } from '../_internal/plugins/workflows/hooks/use-notification-channels';
+/** Get initials for a channel (e.g. "Discord" → "D"). */
+export { getChannelInitials } from '../_internal/plugins/workflows/hooks/use-notification-channels';
+/** Access the TanStack Router instance for imperative navigation. */
+export { useRouter } from './router';
+/** Current URL pathname (Next.js-shape compatible). */
+export { usePathname } from './router';
+/** Current URL search params as a URLSearchParams instance. */
+export { useSearchParams } from './router';
+/** Current route's typed path parameters. */
+export { useParams } from './router';