@census-ai/census-sdk 0.3.0 → 0.4.2

package/dist/react/index.d.cts

@@ -107,7 +107,7 @@ interface Article {
     read_time_minutes: number | null;
     published_at: string | null;
     sort_order: number;
-    content?: unknown;
+    content?: string;
     content_html?: string;
     features?: {
         id: string;
@@ -115,6 +115,36 @@ interface Article {
         slug: string;
     };
 }
+/**
+ * A feature within a feature group
+ */
+interface Feature {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    status: string;
+    article_count: number;
+}
+/**
+ * A feature group containing features
+ */
+interface FeatureGroup {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    color: string | null;
+    features: Feature[];
+    feature_count: number;
+    article_count: number;
+}
+/**
+ * Response from feature groups endpoint
+ */
+interface FeatureGroupsResponse {
+    feature_groups: FeatureGroup[];
+}
 /**
  * Options for fetching articles
  */
@@ -628,6 +658,70 @@ interface RequestsProps {
      */
     onRequestClick?: (request: Request) => void;
 }
+/**
+ * Available tabs in the HelpCenter component
+ */
+type HelpCenterTab = 'articles' | 'requests';
+/**
+ * Props for the HelpCenter component
+ */
+interface HelpCenterProps {
+    /**
+     * Which tabs to show. Order determines tab order.
+     * @default ['articles', 'requests']
+     *
+     * @example
+     * // Show both tabs
+     * tabs={['articles', 'requests']}
+     *
+     * // Articles only (e.g., documentation page)
+     * tabs={['articles']}
+     *
+     * // Requests only (e.g., feedback page)
+     * tabs={['requests']}
+     */
+    tabs?: HelpCenterTab[];
+    /**
+     * Default tab to show on load
+     * @default First tab in the tabs array
+     */
+    defaultTab?: HelpCenterTab;
+    /**
+     * Custom labels for tabs
+     * @default { articles: 'Articles', requests: 'My Requests' }
+     */
+    tabLabels?: Partial<Record<HelpCenterTab, string>>;
+    /**
+     * Show search bar in articles tab
+     * @default true
+     */
+    showSearch?: boolean;
+    /**
+     * Show category filters in articles tab
+     * @default true
+     */
+    showCategories?: boolean;
+    /**
+     * Theme customization
+     */
+    theme?: CensusTheme;
+    /**
+     * Custom CSS class
+     */
+    className?: string;
+    /**
+     * Callback when an article is viewed
+     */
+    onArticleView?: (article: Article) => void;
+    /**
+     * Callback when a request is clicked
+     */
+    onRequestClick?: (request: Request) => void;
+    /**
+     * Callback when the active tab changes
+     */
+    onTabChange?: (tab: HelpCenterTab) => void;
+}
 /**
  * Props for the CensusProvider component
  */
@@ -779,6 +873,21 @@ declare class CensusClient {
      * ```
      */
     getArticle(slugOrId: string): Promise<Article | null>;
+    /**
+     * Fetch feature groups with their features.
+     * Used by the HelpCenter component for navigation.
+     *
+     * @returns Feature groups with features and article counts
+     *
+     * @example
+     * ```typescript
+     * const { feature_groups } = await census.getFeatureGroups();
+     * feature_groups.forEach(group => {
+     *   console.log(group.name, group.features.length);
+     * });
+     * ```
+     */
+    getFeatureGroups(): Promise<FeatureGroupsResponse>;
     /**
      * Fetch the current user's submitted requests (feedback, bugs, feature requests).
      * Requires a user to be identified first.
@@ -1229,6 +1338,42 @@ declare function useArticle(slugOrId: string): {
     error: Error | null;
     refetch: () => Promise<void>;
 };
+/**
+ * Hook for fetching feature groups with their features.
+ * Used by the HelpCenter component for navigation.
+ *
+ * @returns Object with feature groups data and loading state
+ *
+ * @example
+ * ```tsx
+ * function FeatureNav() {
+ *   const { featureGroups, isLoading } = useFeatureGroups();
+ *
+ *   if (isLoading) return <p>Loading...</p>;
+ *
+ *   return (
+ *     <nav>
+ *       {featureGroups.map(group => (
+ *         <div key={group.id}>
+ *           <h3>{group.name}</h3>
+ *           <ul>
+ *             {group.features.map(feature => (
+ *               <li key={feature.id}>{feature.name}</li>
+ *             ))}
+ *           </ul>
+ *         </div>
+ *       ))}
+ *     </nav>
+ *   );
+ * }
+ * ```
+ */
+declare function useFeatureGroups(): {
+    featureGroups: FeatureGroup[];
+    isLoading: boolean;
+    error: Error | null;
+    refetch: () => Promise<void>;
+};
 /**
  * Hook for fetching the current user's submitted requests.
  *
@@ -1521,6 +1666,26 @@ declare function KnowledgeBase({ showSearch, showCategories, defaultCategory, th
  */
 declare function Requests({ status, type, limit, className, showEmptyState, onRequestClick, }: RequestsProps): react_jsx_runtime.JSX.Element | null;
 
+/**
+ * Unified help center component with left navigation showing feature groups.
+ *
+ * @example
+ * ```tsx
+ * import { HelpCenter } from '@census-ai/census-sdk/react';
+ *
+ * function HelpPage() {
+ *   return (
+ *     <HelpCenter
+ *       tabs={['articles', 'requests']}
+ *       showSearch
+ *     />
+ *   );
+ * }
+ * ```
+ */
+declare function HelpCenter({ tabs, defaultTab, tabLabels, showSearch, showCategories: _showCategories, // Reserved for future use
+theme: themeProp, className, onArticleView, onRequestClick, onTabChange, }: HelpCenterProps): react_jsx_runtime.JSX.Element;
+
 /**
  * Props for the GuideBuilder component
  */
@@ -1936,4 +2101,4 @@ interface GuideRendererProps {
  */
 declare function GuideRenderer({ guide, onComplete, onDismiss, onStepChange, onCustomAction, globalStyle, startStep, zIndex, }: GuideRendererProps): react_jsx_runtime.JSX.Element | null;
 
-export { type AdvanceTrigger, type Article, type ArticlesOptions, Backdrop, BannerStep, CensusProvider, type CensusProviderProps, type CensusTheme, type CreateGuideOptions, type CreateGuideStepOptions, FeedbackButton, type FeedbackButtonProps, type FeedbackOptions, type FeedbackType, type Guide, GuideBuilder, type GuideFormType, GuideRenderer, type GuideStatus, type GuideStep, type GuideStepAdvanceConfig, type GuideStepDisplayConfig, type GuideStepRichContent, type GuideStepStyleConfig, type GuideStepType, type GuideTriggerType, type GuidesOptions, type GuidesResponse, HotspotStep, KnowledgeBase, type KnowledgeBaseProps, ModalStep, type Position, type Request, Requests, type RequestsOptions, type RequestsProps, type SelectorStrategy, SlideoutStep, StepButtons, StepContent, type TooltipPosition, TooltipStep, type UpdateGuideOptions, type UpdateGuideStepOptions, type UserIdentity, useArticle, useArticles, useCensus, useCensusContext, useFeedback, useGuideBuilder, useGuideRenderer, useGuides, useIdentify, useRequests, useTrack };
+export { type AdvanceTrigger, type Article, type ArticlesOptions, Backdrop, BannerStep, CensusProvider, type CensusProviderProps, type CensusTheme, type CreateGuideOptions, type CreateGuideStepOptions, type Feature, type FeatureGroup, type FeatureGroupsResponse, FeedbackButton, type FeedbackButtonProps, type FeedbackOptions, type FeedbackType, type Guide, GuideBuilder, type GuideFormType, GuideRenderer, type GuideStatus, type GuideStep, type GuideStepAdvanceConfig, type GuideStepDisplayConfig, type GuideStepRichContent, type GuideStepStyleConfig, type GuideStepType, type GuideTriggerType, type GuidesOptions, type GuidesResponse, HelpCenter, type HelpCenterProps, type HelpCenterTab, HotspotStep, KnowledgeBase, type KnowledgeBaseProps, ModalStep, type Position, type Request, Requests, type RequestsOptions, type RequestsProps, type SelectorStrategy, SlideoutStep, StepButtons, StepContent, type TooltipPosition, TooltipStep, type UpdateGuideOptions, type UpdateGuideStepOptions, type UserIdentity, useArticle, useArticles, useCensus, useCensusContext, useFeatureGroups, useFeedback, useGuideBuilder, useGuideRenderer, useGuides, useIdentify, useRequests, useTrack };

package/dist/react/index.d.ts

@@ -107,7 +107,7 @@ interface Article {
     read_time_minutes: number | null;
     published_at: string | null;
     sort_order: number;
-    content?: unknown;
+    content?: string;
     content_html?: string;
     features?: {
         id: string;
@@ -115,6 +115,36 @@ interface Article {
         slug: string;
     };
 }
+/**
+ * A feature within a feature group
+ */
+interface Feature {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    status: string;
+    article_count: number;
+}
+/**
+ * A feature group containing features
+ */
+interface FeatureGroup {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    color: string | null;
+    features: Feature[];
+    feature_count: number;
+    article_count: number;
+}
+/**
+ * Response from feature groups endpoint
+ */
+interface FeatureGroupsResponse {
+    feature_groups: FeatureGroup[];
+}
 /**
  * Options for fetching articles
  */
@@ -628,6 +658,70 @@ interface RequestsProps {
      */
     onRequestClick?: (request: Request) => void;
 }
+/**
+ * Available tabs in the HelpCenter component
+ */
+type HelpCenterTab = 'articles' | 'requests';
+/**
+ * Props for the HelpCenter component
+ */
+interface HelpCenterProps {
+    /**
+     * Which tabs to show. Order determines tab order.
+     * @default ['articles', 'requests']
+     *
+     * @example
+     * // Show both tabs
+     * tabs={['articles', 'requests']}
+     *
+     * // Articles only (e.g., documentation page)
+     * tabs={['articles']}
+     *
+     * // Requests only (e.g., feedback page)
+     * tabs={['requests']}
+     */
+    tabs?: HelpCenterTab[];
+    /**
+     * Default tab to show on load
+     * @default First tab in the tabs array
+     */
+    defaultTab?: HelpCenterTab;
+    /**
+     * Custom labels for tabs
+     * @default { articles: 'Articles', requests: 'My Requests' }
+     */
+    tabLabels?: Partial<Record<HelpCenterTab, string>>;
+    /**
+     * Show search bar in articles tab
+     * @default true
+     */
+    showSearch?: boolean;
+    /**
+     * Show category filters in articles tab
+     * @default true
+     */
+    showCategories?: boolean;
+    /**
+     * Theme customization
+     */
+    theme?: CensusTheme;
+    /**
+     * Custom CSS class
+     */
+    className?: string;
+    /**
+     * Callback when an article is viewed
+     */
+    onArticleView?: (article: Article) => void;
+    /**
+     * Callback when a request is clicked
+     */
+    onRequestClick?: (request: Request) => void;
+    /**
+     * Callback when the active tab changes
+     */
+    onTabChange?: (tab: HelpCenterTab) => void;
+}
 /**
  * Props for the CensusProvider component
  */
@@ -779,6 +873,21 @@ declare class CensusClient {
      * ```
      */
     getArticle(slugOrId: string): Promise<Article | null>;
+    /**
+     * Fetch feature groups with their features.
+     * Used by the HelpCenter component for navigation.
+     *
+     * @returns Feature groups with features and article counts
+     *
+     * @example
+     * ```typescript
+     * const { feature_groups } = await census.getFeatureGroups();
+     * feature_groups.forEach(group => {
+     *   console.log(group.name, group.features.length);
+     * });
+     * ```
+     */
+    getFeatureGroups(): Promise<FeatureGroupsResponse>;
     /**
      * Fetch the current user's submitted requests (feedback, bugs, feature requests).
      * Requires a user to be identified first.
@@ -1229,6 +1338,42 @@ declare function useArticle(slugOrId: string): {
     error: Error | null;
     refetch: () => Promise<void>;
 };
+/**
+ * Hook for fetching feature groups with their features.
+ * Used by the HelpCenter component for navigation.
+ *
+ * @returns Object with feature groups data and loading state
+ *
+ * @example
+ * ```tsx
+ * function FeatureNav() {
+ *   const { featureGroups, isLoading } = useFeatureGroups();
+ *
+ *   if (isLoading) return <p>Loading...</p>;
+ *
+ *   return (
+ *     <nav>
+ *       {featureGroups.map(group => (
+ *         <div key={group.id}>
+ *           <h3>{group.name}</h3>
+ *           <ul>
+ *             {group.features.map(feature => (
+ *               <li key={feature.id}>{feature.name}</li>
+ *             ))}
+ *           </ul>
+ *         </div>
+ *       ))}
+ *     </nav>
+ *   );
+ * }
+ * ```
+ */
+declare function useFeatureGroups(): {
+    featureGroups: FeatureGroup[];
+    isLoading: boolean;
+    error: Error | null;
+    refetch: () => Promise<void>;
+};
 /**
  * Hook for fetching the current user's submitted requests.
  *
@@ -1521,6 +1666,26 @@ declare function KnowledgeBase({ showSearch, showCategories, defaultCategory, th
  */
 declare function Requests({ status, type, limit, className, showEmptyState, onRequestClick, }: RequestsProps): react_jsx_runtime.JSX.Element | null;
 
+/**
+ * Unified help center component with left navigation showing feature groups.
+ *
+ * @example
+ * ```tsx
+ * import { HelpCenter } from '@census-ai/census-sdk/react';
+ *
+ * function HelpPage() {
+ *   return (
+ *     <HelpCenter
+ *       tabs={['articles', 'requests']}
+ *       showSearch
+ *     />
+ *   );
+ * }
+ * ```
+ */
+declare function HelpCenter({ tabs, defaultTab, tabLabels, showSearch, showCategories: _showCategories, // Reserved for future use
+theme: themeProp, className, onArticleView, onRequestClick, onTabChange, }: HelpCenterProps): react_jsx_runtime.JSX.Element;
+
 /**
  * Props for the GuideBuilder component
  */
@@ -1936,4 +2101,4 @@ interface GuideRendererProps {
  */
 declare function GuideRenderer({ guide, onComplete, onDismiss, onStepChange, onCustomAction, globalStyle, startStep, zIndex, }: GuideRendererProps): react_jsx_runtime.JSX.Element | null;
 
-export { type AdvanceTrigger, type Article, type ArticlesOptions, Backdrop, BannerStep, CensusProvider, type CensusProviderProps, type CensusTheme, type CreateGuideOptions, type CreateGuideStepOptions, FeedbackButton, type FeedbackButtonProps, type FeedbackOptions, type FeedbackType, type Guide, GuideBuilder, type GuideFormType, GuideRenderer, type GuideStatus, type GuideStep, type GuideStepAdvanceConfig, type GuideStepDisplayConfig, type GuideStepRichContent, type GuideStepStyleConfig, type GuideStepType, type GuideTriggerType, type GuidesOptions, type GuidesResponse, HotspotStep, KnowledgeBase, type KnowledgeBaseProps, ModalStep, type Position, type Request, Requests, type RequestsOptions, type RequestsProps, type SelectorStrategy, SlideoutStep, StepButtons, StepContent, type TooltipPosition, TooltipStep, type UpdateGuideOptions, type UpdateGuideStepOptions, type UserIdentity, useArticle, useArticles, useCensus, useCensusContext, useFeedback, useGuideBuilder, useGuideRenderer, useGuides, useIdentify, useRequests, useTrack };
+export { type AdvanceTrigger, type Article, type ArticlesOptions, Backdrop, BannerStep, CensusProvider, type CensusProviderProps, type CensusTheme, type CreateGuideOptions, type CreateGuideStepOptions, type Feature, type FeatureGroup, type FeatureGroupsResponse, FeedbackButton, type FeedbackButtonProps, type FeedbackOptions, type FeedbackType, type Guide, GuideBuilder, type GuideFormType, GuideRenderer, type GuideStatus, type GuideStep, type GuideStepAdvanceConfig, type GuideStepDisplayConfig, type GuideStepRichContent, type GuideStepStyleConfig, type GuideStepType, type GuideTriggerType, type GuidesOptions, type GuidesResponse, HelpCenter, type HelpCenterProps, type HelpCenterTab, HotspotStep, KnowledgeBase, type KnowledgeBaseProps, ModalStep, type Position, type Request, Requests, type RequestsOptions, type RequestsProps, type SelectorStrategy, SlideoutStep, StepButtons, StepContent, type TooltipPosition, TooltipStep, type UpdateGuideOptions, type UpdateGuideStepOptions, type UserIdentity, useArticle, useArticles, useCensus, useCensusContext, useFeatureGroups, useFeedback, useGuideBuilder, useGuideRenderer, useGuides, useIdentify, useRequests, useTrack };