@embedreach/components 0.1.20 → 0.1.22

package/dist/index.d.ts

@@ -1,8 +1,207 @@
-import { default as ReachProvider } from './common/providers/ReachProvider';
-import { SegmentBuilder } from './common/components/automations/SegmentBuilder/SegmentBuilder';
+import { default as default_2 } from 'react';
+import { ForwardRefExoticComponent } from 'react';
+import { LucideProps } from 'lucide-react';
+import { RefAttributes } from 'react';
 
-export { ReachProvider }
+export declare const CreateAutomationModal: default_2.FC<CreateAutomationModalProps>;
 
-export { SegmentBuilder }
+declare interface CreateAutomationModalProps {
+    /**
+     * Optional callback when the segment builder is closed
+     * @param createdAutomation - The created automation id or false if the automation was not created, 'error' if there was an error
+     */
+    onClose?: (createdAutomation: string | false | 'error') => void;
+    /**
+     * Optional keys to override the default icon definitions
+     */
+    iconDefinitions?: IconDefinitionsType;
+}
+
+export declare const Engage: default_2.FC<{
+    iconDefinitions: IconDefinitionsType;
+}>;
+
+/**
+ * Represents the available features in our application.
+ * Each feature corresponds to a specific section of the marketing hub.
+ */
+declare type FeatureKey = 'measure' | 'measure-setup' | 'acquire-setup' | 'engage-segment-builder' | 'engage-automations-create-modal' | 'engage-automations-view-modal' | 'engage';
+
+declare const IconDefinitions: {
+    CloseButton: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    DropdownMenuTrigger: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    UserIcon: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    UsersIcon: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    UserEdit: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    ScheduleButton: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    SendButton: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    BackButton: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    NextButton: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    MergeField: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    PlusIcon: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    AlertCircleIcon: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    /**
+     * Types of automations
+     */
+    OneTimeBroadcast: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    PatronEntersList: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    DateMilestone: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    RealtimeActivity: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    /**
+     * Email and sms icons
+     */
+    EmailIcon: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    SmsIcon: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    /**
+     * Statistics icons
+     */
+    MessagesSent: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    LinksClicked: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    OpenRate: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    SpamComplies: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    TotalBounceRate: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+    UnsubscribeRate: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>>;
+};
+
+declare type IconDefinitionsType = typeof IconDefinitions;
+
+/**
+ * Complete SDK configuration interface
+ * @interface ReachConfig
+ */
+export declare interface ReachConfig {
+    theme?: ThemeConfig;
+    authToken: string;
+    tenantExternalId: string;
+    /** Event callbacks */
+    callbacks?: SDKCallbacks;
+    /** Initial feature to load */
+    feature?: FeatureKey;
+    /** Debug configuration */
+    debug?: boolean;
+    /** Initial language code (e.g., 'en', 'es', 'fr') */
+    language?: string;
+}
+
+export declare const ReachProvider: default_2.FC<ReachConfig & {
+    children?: default_2.ReactNode;
+}>;
+
+/**
+ * Callback function for requesting new token from parent
+ * @callback ReauthCallback@callback ReauthCallback
+ * @returns {Promise<string> | void} New JWT token or void if sending message from iframe
+ */
+declare type ReauthCallback = () => Promise<string> | void;
+
+/**
+ * Callback configuration for SDK events
+ * @interface SDKCallbacks
+ */
+declare interface SDKCallbacks {
+    /** Called when reauthentication is required */
+    onReauthRequested: ReauthCallback;
+    /** Called when tenant information is requested */
+    onTenantInformationRequested: () => void;
+}
+
+export declare const SegmentBuilder: default_2.FC<SegmentBuilderProps>;
+
+declare interface SegmentBuilderProps {
+    /**
+     * Optional callback when the segment builder is closed
+     * @param createdSegment - The created segment id or false if the segment was not created, 'error' if there was an error
+     */
+    onClose?: (createdSegment: string | false | 'error') => void;
+    /**
+     * Optionally pass in a segmentId to edit an existing segment
+     */
+    segmentId?: string;
+    /**
+     * Optional keys to override the default icon definitions
+     */
+    iconDefinitions?: IconDefinitionsType;
+}
+
+/**
+ * Theme initialization options that can be passed to ReachProvider
+ */
+export declare interface ThemeConfig {
+    /** Optional overrides for theme styles */
+    styles: Partial<ThemeStyles>;
+    /** Dark mode toggle */
+    darkMode?: boolean;
+}
+
+/**
+ * Theme styles incorporating shadcn variables
+ *
+ * Matches what we say in our dev docs here:
+ * https://docs.embedreach.com/sdk/customization
+ *
+ * @interface ThemeStyles
+ */
+declare interface ThemeStyles {
+    background?: string;
+    foreground?: string;
+    card?: string;
+    'card-foreground'?: string;
+    popover?: string;
+    'popover-foreground'?: string;
+    primary?: string;
+    'primary-foreground'?: string;
+    secondary?: string;
+    'secondary-foreground'?: string;
+    muted?: string;
+    'muted-foreground'?: string;
+    accent?: string;
+    'accent-foreground'?: string;
+    destructive?: string;
+    'destructive-foreground'?: string;
+    border?: string;
+    input?: string;
+    ring?: string;
+    'chart-1'?: string;
+    'chart-2'?: string;
+    'chart-3'?: string;
+    'chart-4'?: string;
+    'chart-5'?: string;
+    radius?: string;
+    'font-body'?: string;
+    'font-heading'?: string;
+}
+
+export declare const ViewAutomationModal: default_2.FC<ViewAutomationModalProps>;
+
+declare type ViewAutomationModalProps = {
+    /**
+     * The id of the automation to view
+     */
+    automationId?: string;
+    /**
+     * Optionally auto open the edit automation popup
+     */
+    autoOpenEditPopup?: boolean;
+    /**
+     * Optional keys to override the default icon definitions
+     */
+    iconDefinitions?: IconDefinitionsType;
+    /**
+     * Optional keys to override the default show back button
+     */
+    showBackButton?: boolean;
+    /**
+     * Optional logo url to display in the top left corner
+     */
+    logoUrl?: string;
+};
 
 export { }
+
+
+declare module 'i18next' {
+    interface CustomTypeOptions {
+        defaultNS: 'common';
+        resources: typeof defaultTranslations;
+    }
+}