@opencx/widget 2.0.0

package/dist/react-lib/providers/ClientProvider.d.ts

@@ -0,0 +1,7 @@
+import { ApiClient } from '../../core/client';
+import { default as React } from 'react';
+declare const useClient: () => ApiClient;
+declare function ClientProvider({ children }: {
+    children: React.ReactNode;
+}): React.JSX.Element | null;
+export { useClient, ClientProvider };

package/dist/react-lib/providers/ConfigDataProvider.d.ts

@@ -0,0 +1,62 @@
+import { default as React, ReactNode } from 'react';
+import { WidgetOptions, WidgetThemeOptions } from '../types';
+import { useAxiosInstance } from '../hooks';
+import { ComponentRegistry } from './componentRegistry';
+declare function useNormalizeOptions(data: WidgetOptions): {
+    bot: {
+        id: string | null;
+        name: string;
+        is_ai: boolean;
+        profile_picture?: string | null | undefined;
+    };
+    apiUrl: string;
+    socketUrl: string;
+    language: "en" | "ar" | "nl" | "fr" | "de" | "pt";
+    botToken: string;
+    headers: Record<string, string>;
+    pathParams: Record<string, string>;
+    queryParams: Record<string, string>;
+    user: import('../types').UserObject;
+    theme: WidgetThemeOptions & Partial<WidgetThemeOptions>;
+    soundEffectFiles: {
+        messageArrived: string;
+    };
+    collectUserData: boolean;
+    defaultSettings: {
+        persistSession: boolean;
+        useSoundEffects: boolean;
+    };
+    token: string;
+    initialMessages: string[];
+    settings?: {
+        persistSession?: boolean;
+        useSoundEffects?: boolean;
+    };
+    debug?: boolean;
+    assets?: {
+        organizationLogo?: string;
+    };
+    components?: import('../types').ComponentType[];
+};
+export type NormalizedWidgetOptions = ReturnType<typeof useNormalizeOptions>;
+type WidgetSettings = {
+    persistSession: boolean;
+    useSoundEffects: boolean;
+};
+interface ConfigData extends ReturnType<typeof useNormalizeOptions> {
+    http: ReturnType<typeof useAxiosInstance>;
+    botToken: string;
+    componentStore: ComponentRegistry;
+    widgetSettings: WidgetSettings | null;
+    setSettings: (settings: Partial<WidgetSettings>) => void;
+    defaultSettings: WidgetSettings;
+    soundEffectFiles: {
+        messageArrived: string;
+    };
+}
+declare const useConfigData: () => ConfigData;
+export declare function ConfigDataProvider({ children, data, }: {
+    data: WidgetOptions;
+    children: ReactNode;
+}): React.JSX.Element;
+export { useConfigData };

package/dist/react-lib/providers/ContactProvider.d.ts

@@ -0,0 +1,58 @@
+import { default as React, ReactNode } from 'react';
+import { UserObject } from '../types';
+declare const useContact: () => {
+    creatingContactState: {
+        loading: boolean;
+        error?: undefined;
+        value?: undefined;
+    } | {
+        loading: false;
+        error: Error;
+        value?: undefined;
+    } | {
+        loading: true;
+        error?: Error | undefined;
+        value?: {
+            email: string | null;
+            id: string;
+            name: string | null;
+            avatar_url: string | null;
+            created_at: string;
+        } | null | undefined;
+    } | {
+        loading: false;
+        error?: undefined;
+        value: {
+            email: string | null;
+            id: string;
+            name: string | null;
+            avatar_url: string | null;
+            created_at: string;
+        } | null;
+    };
+    createContactAsync: (user: UserObject) => Promise<{
+        email: string | null;
+        id: string;
+        name: string | null;
+        avatar_url: string | null;
+        created_at: string;
+    } | null>;
+    contact: {
+        email: string | null;
+        id: string;
+        name: string | null;
+        avatar_url: string | null;
+        created_at: string;
+    } | null;
+    shouldCollectData: {
+        should: boolean;
+        reason: string;
+    } | {
+        should: boolean;
+        reason?: undefined;
+    };
+};
+declare function ContactProvider({ children }: {
+    children: ReactNode;
+}): React.JSX.Element;
+export { ContactProvider, useContact };

package/dist/react-lib/providers/LocalesProvider.d.ts

@@ -0,0 +1,11 @@
+import { LangType } from '../locales';
+import { TranslationKeysType } from '@react/locales/en.locale';
+import { default as React } from 'react';
+declare const useLocale: () => {
+    get: (key: TranslationKeysType, pfx?: string) => string;
+    lang: LangType;
+};
+declare function LocaleProvider({ children }: {
+    children: React.ReactNode;
+}): React.JSX.Element;
+export { LocaleProvider, useLocale };

package/dist/react-lib/providers/componentRegistry.d.ts

@@ -0,0 +1,13 @@
+import { ComponentType, OptionsType } from '../types';
+/**
+ * this a singleton  class helps me to easily control the components present/available in the widget.
+ * it also manages the various types of components to be added along the way.
+ */
+export declare class ComponentRegistry {
+    components: ComponentType[];
+    constructor(opts: OptionsType);
+    register(com: ComponentType): this;
+    private get;
+    private getOrFallback;
+    getComponent(key: string, getFallback?: boolean): import('react').ElementType<any, keyof import("react").JSX.IntrinsicElements> | undefined;
+}

package/dist/react-lib/providers/use-widget-sfx.d.ts

@@ -0,0 +1,7 @@
+declare function useWidgetSoundEffects(): {
+    messageArrivedSound: {
+        play: () => void;
+        stop: () => void;
+    };
+};
+export { useWidgetSoundEffects };

package/dist/react-lib/providers/usePreludeData.d.ts

@@ -0,0 +1,2 @@
+declare function usePreludeData(): import('swr').SWRResponse<import('../../core/types/prelude').PreludeData | undefined, any, any>;
+export { usePreludeData };

package/dist/react-lib/types/components.d.ts

@@ -0,0 +1,10 @@
+import { default as React } from 'react';
+import { BotMessageType } from '@core/types/messages';
+export type ComponentProps<TData> = BotMessageType<TData>;
+export type ComponentType = {
+    key: string;
+    component: React.ElementType;
+};
+export type OptionsType = {
+    components?: ComponentType[];
+};

package/dist/react-lib/types/index.d.ts

@@ -0,0 +1,6 @@
+import { ComponentProps } from './components';
+export * from './options';
+export * from './components';
+export type DefaultTextComponentProps = ComponentProps<{
+    message: string;
+}>;

package/dist/react-lib/types/options.d.ts

@@ -0,0 +1,43 @@
+import { LangType } from '../locales';
+import { ComponentType } from './components';
+export type UserObject = {
+    external_id?: string;
+    name?: string;
+    email?: string;
+    phone?: string;
+    customData?: Record<string, string>;
+    avatarUrl?: string;
+};
+export interface WidgetThemeOptions {
+    primaryColor: string;
+    triggerOffset: string;
+}
+export type WidgetOptions = {
+    token: string;
+    headers?: Record<string, string>;
+    queryParams?: Record<string, string>;
+    pathParams?: Record<string, string>;
+    initialMessages: string[];
+    apiUrl?: string;
+    theme?: Partial<WidgetThemeOptions>;
+    settings?: {
+        persistSession?: boolean;
+        useSoundEffects?: boolean;
+    };
+    collectUserData?: boolean;
+    soundEffectFiles?: {
+        messageArrived?: string;
+    };
+    socketUrl?: string;
+    debug?: boolean;
+    language?: LangType;
+    user?: UserObject;
+    assets?: {
+        organizationLogo?: string;
+    };
+    bot?: {
+        name?: string;
+        avatarUrl?: string;
+    };
+    components?: ComponentType[];
+};

package/dist/react-lib/utils/create-safe-context.d.ts

@@ -0,0 +1 @@
+export declare function createSafeContext<TDdata>(init?: TDdata): readonly [() => TDdata & ({} | null), import('react').Provider<TDdata>];

package/dist/react-lib/utils/debug.d.ts

@@ -0,0 +1,2 @@
+declare function debug(...args: unknown[]): void;
+export { debug };

package/dist/react-lib/utils/getters.d.ts

@@ -0,0 +1,24 @@
+import { ChatHistoryMessageType } from '../../core/types';
+interface DayOfficeHours {
+    from: string;
+    to: string;
+}
+export declare const workingDays: readonly ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday", "WeekDays", "Everyday"];
+export type PreludeData = {
+    initial_questions: string[];
+    ai_enabled: boolean;
+    office_hours: WorkingHours;
+    office_hours_timezone: string;
+    organization_name: string;
+};
+type Day = (typeof workingDays)[number];
+export type WorkingHours = {
+    [K in Day]: DayOfficeHours;
+};
+export type InitialData = {
+    logo: string;
+    faq: [];
+    initial_questions: string[];
+    history: ChatHistoryMessageType[];
+};
+export {};

package/dist/react-lib/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './getters';

package/dist/react.cjs

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-DQmRZV3b.cjs"),a=["monday","tuesday","wednesday","thursday","friday","saturday","sunday","WeekDays","Everyday"];function u(t,o){const{http:s}=e.useConfigData();return e._default(async()=>s.apis.upvote(t).then(o),[s.options,t,o])}function n(t,o){const{http:s}=e.useConfigData();return e._default(async()=>s.apis.downvote(t).then(o),[s.options,t])}exports.WidgetRoot=e.WidgetRoot;exports.useChat=e.useChat;exports.useConfigData=e.useConfigData;exports.useContact=e.useContact;exports.useLocale=e.useLocale;exports.usePreludeData=e.usePreludeData;exports.useUploadFiles=e.useUploadFiles;exports.useWidgetSoundEffects=e.useWidgetSoundEffects;exports.useDownvote=n;exports.useUpvote=u;exports.workingDays=a;
+//# sourceMappingURL=react.cjs.map

package/dist/react.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"react.cjs","sources":["../react-lib/utils/getters.ts","../react-lib/hooks/useVote.ts"],"sourcesContent":["import { ChatHistoryMessageType } from \"@core/types\";\n\ninterface DayOfficeHours {\n  from: string;\n  to: string;\n}\n\nexport const workingDays = [\n  \"monday\",\n  \"tuesday\",\n  \"wednesday\",\n  \"thursday\",\n  \"friday\",\n  \"saturday\",\n  \"sunday\",\n  \"WeekDays\",\n  \"Everyday\",\n] as const;\n\nexport type PreludeData = {\n  initial_questions: string[];\n  ai_enabled: boolean;\n  office_hours: WorkingHours;\n  office_hours_timezone: string;\n  organization_name: string;\n};\n\ntype Day = (typeof workingDays)[number];\n\nexport type WorkingHours = {\n  [K in Day]: DayOfficeHours;\n};\n\nexport type InitialData = {\n  logo: string;\n  faq: [];\n  initial_questions: string[];\n  history: ChatHistoryMessageType[];\n};\n","import { useConfigData } from \"@react/providers/ConfigDataProvider\";\nimport useAsyncFn from \"react-use/lib/useAsyncFn\";\n\nexport function useUpvote(id: string, onSuccess?: () => void) {\n  const { http } = useConfigData();\n  return useAsyncFn(\n    async () => http.apis.upvote(id).then(onSuccess),\n    [http.options, id, onSuccess],\n  );\n}\n\nexport function useDownvote(id: string, onSuccess?: () => void) {\n  const { http } = useConfigData();\n  return useAsyncFn(\n    async () => http.apis.downvote(id).then(onSuccess),\n    [http.options, id],\n  );\n}\n"],"names":["workingDays","useUpvote","id","onSuccess","http","useConfigData","useAsyncFn","useDownvote"],"mappings":"wHAOaA,EAAc,CACzB,SACA,UACA,YACA,WACA,SACA,WACA,SACA,WACA,UACF,ECdgB,SAAAC,EAAUC,EAAYC,EAAwB,CACtD,KAAA,CAAE,KAAAC,GAASC,EAAAA,gBACV,OAAAC,EAAA,SACL,SAAYF,EAAK,KAAK,OAAOF,CAAE,EAAE,KAAKC,CAAS,EAC/C,CAACC,EAAK,QAASF,EAAIC,CAAS,CAAA,CAEhC,CAEgB,SAAAI,EAAYL,EAAYC,EAAwB,CACxD,KAAA,CAAE,KAAAC,GAASC,EAAAA,gBACV,OAAAC,EAAA,SACL,SAAYF,EAAK,KAAK,SAASF,CAAE,EAAE,KAAKC,CAAS,EACjD,CAACC,EAAK,QAASF,CAAE,CAAA,CAErB"}

package/dist/react.d.ts

@@ -0,0 +1,2 @@
+export * from './react-lib/index'
+export {}

package/dist/react.js

@@ -0,0 +1,41 @@
+import { u as e, _ as o } from "./index-C11ivBh5.js";
+import { W as i, e as f, a as c, d as h, b as l, h as v, l as D } from "./index-C11ivBh5.js";
+const u = [
+  "monday",
+  "tuesday",
+  "wednesday",
+  "thursday",
+  "friday",
+  "saturday",
+  "sunday",
+  "WeekDays",
+  "Everyday"
+];
+function d(t, s) {
+  const { http: a } = e();
+  return o(
+    async () => a.apis.upvote(t).then(s),
+    [a.options, t, s]
+  );
+}
+function r(t, s) {
+  const { http: a } = e();
+  return o(
+    async () => a.apis.downvote(t).then(s),
+    [a.options, t]
+  );
+}
+export {
+  i as WidgetRoot,
+  f as useChat,
+  e as useConfigData,
+  c as useContact,
+  r as useDownvote,
+  h as useLocale,
+  l as usePreludeData,
+  v as useUploadFiles,
+  d as useUpvote,
+  D as useWidgetSoundEffects,
+  u as workingDays
+};
+//# sourceMappingURL=react.js.map

package/dist/react.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"react.js","sources":["../react-lib/utils/getters.ts","../react-lib/hooks/useVote.ts"],"sourcesContent":["import { ChatHistoryMessageType } from \"@core/types\";\n\ninterface DayOfficeHours {\n  from: string;\n  to: string;\n}\n\nexport const workingDays = [\n  \"monday\",\n  \"tuesday\",\n  \"wednesday\",\n  \"thursday\",\n  \"friday\",\n  \"saturday\",\n  \"sunday\",\n  \"WeekDays\",\n  \"Everyday\",\n] as const;\n\nexport type PreludeData = {\n  initial_questions: string[];\n  ai_enabled: boolean;\n  office_hours: WorkingHours;\n  office_hours_timezone: string;\n  organization_name: string;\n};\n\ntype Day = (typeof workingDays)[number];\n\nexport type WorkingHours = {\n  [K in Day]: DayOfficeHours;\n};\n\nexport type InitialData = {\n  logo: string;\n  faq: [];\n  initial_questions: string[];\n  history: ChatHistoryMessageType[];\n};\n","import { useConfigData } from \"@react/providers/ConfigDataProvider\";\nimport useAsyncFn from \"react-use/lib/useAsyncFn\";\n\nexport function useUpvote(id: string, onSuccess?: () => void) {\n  const { http } = useConfigData();\n  return useAsyncFn(\n    async () => http.apis.upvote(id).then(onSuccess),\n    [http.options, id, onSuccess],\n  );\n}\n\nexport function useDownvote(id: string, onSuccess?: () => void) {\n  const { http } = useConfigData();\n  return useAsyncFn(\n    async () => http.apis.downvote(id).then(onSuccess),\n    [http.options, id],\n  );\n}\n"],"names":["workingDays","useUpvote","id","onSuccess","http","useConfigData","useAsyncFn","useDownvote"],"mappings":";;AAOO,MAAMA,IAAc;AAAA,EACzB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;ACdgB,SAAAC,EAAUC,GAAYC,GAAwB;AACtD,QAAA,EAAE,MAAAC,MAASC;AACV,SAAAC;AAAAA,IACL,YAAYF,EAAK,KAAK,OAAOF,CAAE,EAAE,KAAKC,CAAS;AAAA,IAC/C,CAACC,EAAK,SAASF,GAAIC,CAAS;AAAA,EAAA;AAEhC;AAEgB,SAAAI,EAAYL,GAAYC,GAAwB;AACxD,QAAA,EAAE,MAAAC,MAASC;AACV,SAAAC;AAAAA,IACL,YAAYF,EAAK,KAAK,SAASF,CAAE,EAAE,KAAKC,CAAS;AAAA,IACjD,CAACC,EAAK,SAASF,CAAE;AAAA,EAAA;AAErB;"}

package/dist/src/@components/BotMessage.d.ts

@@ -0,0 +1,9 @@
+import { BotMessageType } from '../../core/types';
+import { default as React } from 'react';
+interface BotMessageProps<W extends React.ElementType> {
+    message: BotMessageType;
+    Wrapper?: W;
+    wrapperProps?: Omit<React.ComponentProps<W>, "children">;
+}
+export declare function BotMessage<W extends React.ElementType>({ message, Wrapper, wrapperProps, }: BotMessageProps<W>): React.JSX.Element | null;
+export {};

package/dist/src/@components/BotMessageWrapper.d.ts

@@ -0,0 +1,7 @@
+import { default as React } from 'react';
+import { BotMessageType } from '@core/types/messages';
+export declare function BotResponseWrapper({ children, agent, className, }: {
+    children: React.ReactNode;
+    agent: BotMessageType["agent"];
+    className?: string;
+}): React.JSX.Element;

package/dist/src/@components/ChatEvent.component.d.ts

@@ -0,0 +1,9 @@
+import { MessageTypeEnum } from '../../core/types';
+import { ComponentProps } from '../../react-lib/types';
+import { default as React } from 'react';
+type ChatEventComponentProps = ComponentProps<{
+    event: MessageTypeEnum;
+    message: string;
+}>;
+declare function ChatEventComponent(props: ChatEventComponentProps): React.JSX.Element;
+export { ChatEventComponent, MessageTypeEnum, type ChatEventComponentProps };

package/dist/src/@components/Fallback.component.d.ts

@@ -0,0 +1,8 @@
+import { ComponentProps } from '../../react-lib/types';
+import { default as React } from 'react';
+type Props = ComponentProps<unknown>;
+/**
+ * The Basic Fallback component (Rendered when Debug is True and the component key is not found)
+ */
+export declare function FallbackComponent(props: Props): React.JSX.Element;
+export {};

package/dist/src/@components/Loading.component.d.ts

@@ -0,0 +1,2 @@
+import { default as React } from 'react';
+export declare function BotLoadingComponent(): React.JSX.Element;

package/dist/src/@components/OpenLogoSvg.d.ts

@@ -0,0 +1,4 @@
+import { default as React } from 'react';
+export declare function OpenLogoSvg({ className }: {
+    className?: string;
+}): React.JSX.Element;

package/dist/src/@components/Text.component.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+import { DefaultTextComponentProps } from '../../react-lib/types';
+export declare function BotTextResponse({ data, id, type, attachments, }: DefaultTextComponentProps): React.JSX.Element;

package/dist/src/@components/index.d.ts

@@ -0,0 +1,6 @@
+export * from './Text.component';
+export * from './Loading.component';
+export * from './Fallback.component';
+export * from './BotMessageWrapper';
+export * from './BotMessage';
+export * from './ChatEvent.component';

package/dist/src/@components/markdown.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+import { default as ReactMarkdown } from 'react-markdown';
+export declare const MemoizedReactMarkdown: React.MemoExoticComponent<typeof ReactMarkdown>;

package/dist/src/components/MotionDiv.d.ts

@@ -0,0 +1,18 @@
+import { default as React, ComponentProps } from 'react';
+import { motion, Target } from 'framer-motion';
+type MotionProps = ComponentProps<typeof motion.div>;
+type AnimationDirection = "right" | "left" | "up" | "down";
+type MotionDivProps = MotionProps & {
+    fadeIn?: AnimationDirection;
+    distance?: number;
+    snapExit?: boolean;
+    overrides?: Overrides;
+};
+type Overrides = {
+    initial?: Target;
+    animate?: Target;
+    exit?: Target;
+};
+export declare const ANIMATION_DISTANCE_PX = 10;
+declare const MotionDiv: React.ForwardRefExoticComponent<Omit<MotionDivProps, "ref"> & React.RefAttributes<HTMLDivElement>>;
+export { MotionDiv };

package/dist/src/components/RenderFile.d.ts

@@ -0,0 +1,7 @@
+import { default as React } from 'react';
+import { ChatAttachmentType } from '../../core/types';
+type Props = {
+    attachment: ChatAttachmentType;
+};
+export declare function RenderAttachment({ attachment }: Props): React.JSX.Element;
+export {};

package/dist/src/components/avatar.d.ts

@@ -0,0 +1,6 @@
+import * as React from "react";
+import * as AvatarPrimitive from "@radix-ui/react-avatar";
+declare const Avatar: React.ForwardRefExoticComponent<Omit<AvatarPrimitive.AvatarProps & React.RefAttributes<HTMLSpanElement>, "ref"> & React.RefAttributes<HTMLSpanElement>>;
+declare const AvatarImage: React.ForwardRefExoticComponent<Omit<AvatarPrimitive.AvatarImageProps & React.RefAttributes<HTMLImageElement>, "ref"> & React.RefAttributes<HTMLImageElement>>;
+declare const AvatarFallback: React.ForwardRefExoticComponent<Omit<AvatarPrimitive.AvatarFallbackProps & React.RefAttributes<HTMLSpanElement>, "ref"> & React.RefAttributes<HTMLSpanElement>>;
+export { Avatar, AvatarImage, AvatarFallback };

package/dist/src/components/button.d.ts

@@ -0,0 +1,11 @@
+import { VariantProps } from 'class-variance-authority';
+import * as React from "react";
+declare const buttonVariants: (props?: ({
+    variant?: "link" | "default" | "outline" | "destructive" | "secondary" | "ghost" | null | undefined;
+    size?: "default" | "icon" | "sm" | "lg" | "fit" | null | undefined;
+} & import('class-variance-authority/dist/types').ClassProp) | undefined) => string;
+export interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement>, VariantProps<typeof buttonVariants> {
+    asChild?: boolean;
+}
+declare const Button: React.ForwardRefExoticComponent<ButtonProps & React.RefAttributes<HTMLButtonElement>>;
+export { Button, buttonVariants };