@census-ai/census-sdk 0.5.4 → 0.5.6

package/dist/react/index.d.cts

@@ -15,6 +15,10 @@ interface CensusConfig {
      * @default "https://api.census.ai" or your custom domain
      */
     baseUrl?: string;
+    /**
+     * Project ID to scope all requests to
+     */
+    projectId?: string;
     /**
      * Enable debug logging
      * @default false
@@ -756,6 +760,10 @@ interface CensusProviderProps {
      * Base URL for the API
      */
     baseUrl?: string;
+    /**
+     * Project ID to scope all requests to
+     */
+    projectId?: string;
     /**
      * Enable debug mode
      */
@@ -804,6 +812,7 @@ interface GuideAnalyticsEvent {
 declare class CensusClient {
     private apiKey;
     private baseUrl;
+    private projectId;
     private debug;
     private currentUserId;
     constructor(config: CensusConfig);
@@ -1201,7 +1210,7 @@ interface CensusContextValue {
  * }
  * ```
  */
-declare function CensusProvider({ apiKey, baseUrl, debug, user, theme, children, }: CensusProviderProps): react_jsx_runtime.JSX.Element;
+declare function CensusProvider({ apiKey, baseUrl, projectId, debug, user, theme, children, }: CensusProviderProps): react_jsx_runtime.JSX.Element;
 /**
  * Hook to access the Census client directly.
  *
@@ -1733,6 +1742,12 @@ interface GuideBuilderProps {
      * Custom CSS class for the modal
      */
     className?: string;
+    /**
+     * Layout mode:
+     * - 'fullscreen' (default): Full-screen overlay with 3-column layout
+     * - 'docked': Fixed right sidebar (420px) so the host app remains visible
+     */
+    mode?: 'fullscreen' | 'docked';
 }
 /**
  * Guide Builder Component
@@ -1756,7 +1771,23 @@ interface GuideBuilderProps {
  * />
  * ```
  */
-declare function GuideBuilder({ isOpen: controlledIsOpen, onClose, guideId, onSave, onPublish, trigger, className, }: GuideBuilderProps): react_jsx_runtime.JSX.Element | null;
+declare function GuideBuilder({ isOpen: controlledIsOpen, onClose, guideId, onSave, onPublish, trigger, className, mode, }: GuideBuilderProps): react_jsx_runtime.JSX.Element | null;
+
+/**
+ * BuilderModeController
+ *
+ * Automatically activates the GuideBuilder in docked (right sidebar) mode
+ * when the URL contains `?census-builder=true`.
+ *
+ * Optionally loads an existing guide if `census-guide-id=<id>` is present.
+ *
+ * Rendered inside CensusProvider — no manual setup required.
+ *
+ * @example
+ * // Activate by navigating to:
+ * // https://your-app.com/some-page?census-builder=true&census-guide-id=abc-123
+ */
+declare function BuilderModeController(): react_jsx_runtime.JSX.Element | null;
 
 interface TooltipStepProps {
     /**
@@ -2116,4 +2147,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, 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$1 as HelpCenterProps, type HelpCenterTab$1 as HelpCenterTab, type HelpCenterTheme, 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 };
+export { type AdvanceTrigger, type Article, type ArticlesOptions, Backdrop, BannerStep, BuilderModeController, 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$1 as HelpCenterProps, type HelpCenterTab$1 as HelpCenterTab, type HelpCenterTheme, 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

@@ -15,6 +15,10 @@ interface CensusConfig {
      * @default "https://api.census.ai" or your custom domain
      */
     baseUrl?: string;
+    /**
+     * Project ID to scope all requests to
+     */
+    projectId?: string;
     /**
      * Enable debug logging
      * @default false
@@ -756,6 +760,10 @@ interface CensusProviderProps {
      * Base URL for the API
      */
     baseUrl?: string;
+    /**
+     * Project ID to scope all requests to
+     */
+    projectId?: string;
     /**
      * Enable debug mode
      */
@@ -804,6 +812,7 @@ interface GuideAnalyticsEvent {
 declare class CensusClient {
     private apiKey;
     private baseUrl;
+    private projectId;
     private debug;
     private currentUserId;
     constructor(config: CensusConfig);
@@ -1201,7 +1210,7 @@ interface CensusContextValue {
  * }
  * ```
  */
-declare function CensusProvider({ apiKey, baseUrl, debug, user, theme, children, }: CensusProviderProps): react_jsx_runtime.JSX.Element;
+declare function CensusProvider({ apiKey, baseUrl, projectId, debug, user, theme, children, }: CensusProviderProps): react_jsx_runtime.JSX.Element;
 /**
  * Hook to access the Census client directly.
  *
@@ -1733,6 +1742,12 @@ interface GuideBuilderProps {
      * Custom CSS class for the modal
      */
     className?: string;
+    /**
+     * Layout mode:
+     * - 'fullscreen' (default): Full-screen overlay with 3-column layout
+     * - 'docked': Fixed right sidebar (420px) so the host app remains visible
+     */
+    mode?: 'fullscreen' | 'docked';
 }
 /**
  * Guide Builder Component
@@ -1756,7 +1771,23 @@ interface GuideBuilderProps {
  * />
  * ```
  */
-declare function GuideBuilder({ isOpen: controlledIsOpen, onClose, guideId, onSave, onPublish, trigger, className, }: GuideBuilderProps): react_jsx_runtime.JSX.Element | null;
+declare function GuideBuilder({ isOpen: controlledIsOpen, onClose, guideId, onSave, onPublish, trigger, className, mode, }: GuideBuilderProps): react_jsx_runtime.JSX.Element | null;
+
+/**
+ * BuilderModeController
+ *
+ * Automatically activates the GuideBuilder in docked (right sidebar) mode
+ * when the URL contains `?census-builder=true`.
+ *
+ * Optionally loads an existing guide if `census-guide-id=<id>` is present.
+ *
+ * Rendered inside CensusProvider — no manual setup required.
+ *
+ * @example
+ * // Activate by navigating to:
+ * // https://your-app.com/some-page?census-builder=true&census-guide-id=abc-123
+ */
+declare function BuilderModeController(): react_jsx_runtime.JSX.Element | null;
 
 interface TooltipStepProps {
     /**
@@ -2116,4 +2147,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, 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$1 as HelpCenterProps, type HelpCenterTab$1 as HelpCenterTab, type HelpCenterTheme, 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 };
+export { type AdvanceTrigger, type Article, type ArticlesOptions, Backdrop, BannerStep, BuilderModeController, 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$1 as HelpCenterProps, type HelpCenterTab$1 as HelpCenterTab, type HelpCenterTheme, 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 };