@lorikeetai/react-native-sdk 1.2.0 → 2.0.0-alpha.2

package/dist/index.d.ts

@@ -1,51 +1,169 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import * as react from 'react';
-import { WebViewProps, WebViewMessageEvent, WebView } from 'react-native-webview';
-import { Customisations } from '@lorikeetai/web-sdk/types';
-import { StyleProp, TextStyle } from 'react-native';
-
+import { StyleProp, TextStyle } from "react-native";
+import { WebView, WebViewMessageEvent, WebViewProps } from "react-native-webview";
+//#region src/conversation-metadata.d.ts
+type ConversationMetadata = Record<string, unknown>;
+//#endregion
+//#region src/customisations.d.ts
+interface ViewportCustomisations {
+  borderRadius?: string;
+  default_open?: boolean;
+  height?: string;
+  topClearance?: string;
+  width?: string;
+}
+interface Customisations {
+  avatarUrl?: string;
+  botName?: string;
+  desktop?: ViewportCustomisations;
+  hideHeader?: boolean;
+  linkTarget?: '_blank' | '_parent';
+  logoUrl?: string;
+  messages?: {
+    failOver?: string;
+    unavailable?: string;
+    escalated?: string;
+  };
+  mobile?: ViewportCustomisations;
+  mode?: 'controlled' | 'uncontrolled';
+  rootElement?: {
+    border?: string;
+    borderRadius?: string;
+    zIndex?: number;
+    bottom?: string;
+    right?: string;
+    size?: string;
+  };
+  showVerboseTimestamps?: boolean;
+  theme?: CustomisationTheme;
+  title?: string;
+  useSubtleBranding?: boolean;
+}
+interface CustomisationTheme {
+  background?: string;
+  backgroundColor?: string;
+  brandAccentColor?: string;
+  brandColor?: string;
+  colorMode?: 'light' | 'dark';
+  fontFamily?: string;
+  fontUrl?: string;
+  headerBackground?: string;
+  inverseTextColor?: string;
+  linkColor?: string;
+  linkHoverColor?: string;
+  secondaryBrandColor?: string;
+  subtleBrandColor?: string;
+  textColor?: string;
+}
+//#endregion
+//#region src/events.d.ts
+type LorikeetWidgetEvent = {
+  type: 'ready';
+} | {
+  type: 'ticket_created';
+  ticketId: string;
+} | {
+  type: 'customer_message';
+} | {
+  type: 'agent_message';
+  markUnread?: boolean;
+} | {
+  type: 'close';
+  reason?: 'ended_by_customer' | 'minimised';
+} | {
+  type: 'conversation_ended';
+} | {
+  type: 'new_chat';
+} | {
+  type: 'persist_ticket_id';
+  ticketId: string;
+} | {
+  type: 'persist_session';
+  session: string;
+} | {
+  type: 'logged_out';
+} | {
+  type: 'logout_failed';
+} | {
+  type: 'error';
+  error: string;
+} | {
+  type: 'preload_complete';
+  clientStart: boolean;
+  lazyTicketCreationEnabled: boolean;
+};
+type LorikeetWidgetEventType = 'agent_message' | 'close' | 'conversation_ended' | 'customer_message' | 'error' | 'logged_out' | 'logout_failed' | 'new_chat' | 'persist_session' | 'persist_ticket_id' | 'preload_complete' | 'ready' | 'ticket_created';
+//#endregion
+//#region src/types.d.ts
 interface LorikeetInitOptions {
-    api_base?: string;
-    customisations?: Customisations;
-    public_key: string;
+  api_base?: string;
+  customisations?: Customisations;
+  metadata?: ConversationMetadata;
+  public_key: string;
 }
 type LorikeetWidgetWebViewProps = {
-    uri: string;
-    baseUrl?: string;
-    webviewProps?: WebViewProps;
+  uri: string;
+  baseUrl?: string;
+  webviewProps?: WebViewProps;
+  onEvent?: (event: LorikeetWidgetEvent) => void;
 };
 type LorikeetWidgetHeaderProps = {
-    title: string;
-    style?: StyleProp<TextStyle>;
-    icon?: React.ReactNode;
-    onIconPress?: () => void;
+  title: string;
+  style?: StyleProp<TextStyle>;
+  icon?: React.ReactNode;
+  onIconPress?: () => void;
+};
+type LorikeetWidgetHandle = {
+  getConversation: () => {
+    minimised: boolean;
+    session?: string;
+    ticketId?: string;
+  } | null;
+  logout: () => void;
+  reopen: () => void;
 };
 type LorikeetWidgetViewProps = {
-    publicKey: string;
-    baseUrl?: string;
-    authToken: string;
-    onWebViewMessage?: (event: WebViewMessageEvent) => void;
-    customisations?: Customisations;
-    styles?: {
-        header?: StyleProp<TextStyle>;
-    };
+  publicKey: string;
+  baseUrl?: string;
+  authToken: string;
+  onWebViewMessage?: (event: WebViewMessageEvent) => void;
+  onEvent?: (event: LorikeetWidgetEvent) => void;
+  customisations?: Customisations;
+  styles?: {
+    header?: StyleProp<TextStyle>;
+  };
+  ticketId?: string;
+  session?: string;
+  metadata?: ConversationMetadata;
+  webviewProps?: WebViewProps;
 };
-
-declare const LorikeetWidgetWebView: react.ForwardRefExoticComponent<LorikeetWidgetWebViewProps & react.RefAttributes<WebView<{}>>>;
-declare const LorikeetWidgetHeader: ({ title, style, icon, onIconPress, }: LorikeetWidgetHeaderProps) => react_jsx_runtime.JSX.Element;
-declare function LorikeetWidgetView({ publicKey, baseUrl, authToken, customisations, styles, onWebViewMessage, }: LorikeetWidgetViewProps): react_jsx_runtime.JSX.Element | null;
-
+//#endregion
+//#region src/widget.d.ts
+declare const LorikeetWidgetWebView: import("react").ForwardRefExoticComponent<LorikeetWidgetWebViewProps & import("react").RefAttributes<WebView<{}>>>;
+declare const LorikeetWidgetHeader: ({ title, style, icon, onIconPress }: LorikeetWidgetHeaderProps) => import("react").JSX.Element;
+declare const LorikeetWidgetView: import("react").ForwardRefExoticComponent<LorikeetWidgetViewProps & import("react").RefAttributes<LorikeetWidgetHandle>>;
+//#endregion
+//#region src/client.d.ts
 declare class LorikeetClient {
-    baseUrl: string;
-    customisations: Customisations | null;
-    publicKey: string;
-    constructor({ customisations, api_base, public_key }: LorikeetInitOptions);
-    getWebviewUrl: ({ customer_email, customer_name, token, ticket_id, }: {
-        customer_email?: string;
-        customer_name?: string;
-        token: string;
-        ticket_id?: string;
-    }) => string;
+  baseUrl: string;
+  customisations: Customisations | null;
+  metadata: ConversationMetadata | null;
+  publicKey: string;
+  constructor({ customisations, api_base, metadata, public_key }: LorikeetInitOptions);
+  getWebviewUrl: ({ customer_email, customer_name, token, ticket_id, session }: {
+    customer_email?: string;
+    customer_name?: string;
+    session?: string;
+    ticket_id?: string;
+    token: string;
+  }) => string;
+  getLogoutUrl: () => string;
 }
-
-export { LorikeetClient, type LorikeetInitOptions, LorikeetWidgetHeader, type LorikeetWidgetHeaderProps, LorikeetWidgetView, type LorikeetWidgetViewProps, LorikeetWidgetWebView, type LorikeetWidgetWebViewProps };
+//#endregion
+//#region src/errors.d.ts
+declare const LORIKEET_ERROR_CODES: readonly ["MISSING_TOKEN", "CORRUPT_TOKEN_DATA", "DECRYPT_FAILED", "EXPIRED_TOKEN", "MALFORMED_TOKEN", "MISSING_PUBLIC_KEY", "UNKNOWN_PUBLIC_KEY", "CUSTOMER_ID_CONFLICT", "CUSTOMER_ID_MISSING", "FATAL_ERROR", "INVALID_SESSION", "DOMAIN_NOT_ALLOWED", "TICKET_NOT_FOUND"];
+type LorikeetErrorCode = (typeof LORIKEET_ERROR_CODES)[number];
+declare function isUnusableConversationCode(code: string): boolean;
+declare function isUnusableConversation(message: unknown): boolean;
+//#endregion
+export { type CustomisationTheme, type Customisations, LORIKEET_ERROR_CODES, LorikeetClient, type LorikeetErrorCode, type LorikeetInitOptions, type LorikeetWidgetEvent, type LorikeetWidgetEventType, type LorikeetWidgetHandle, LorikeetWidgetHeader, type LorikeetWidgetHeaderProps, LorikeetWidgetView, type LorikeetWidgetViewProps, LorikeetWidgetWebView, type LorikeetWidgetWebViewProps, isUnusableConversation, isUnusableConversationCode };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/conversation-metadata.ts","../src/customisations.ts","../src/events.ts","../src/types.ts","../src/widget.tsx","../src/client.ts","../src/errors.ts"],"mappings":";;;KAEY,uBAAuB;;;UCezB;EAER;EACA;EAEA;EAEA;EACA;;UAGe;EAEf;EACA;EACA,UAAU;EAEV;EAEA;EACA;EACA;IAEE;IAEA;IAMA;;EAEF,SAAS;EACT;EAOA;IACE;IACA;IACA;IACA;IACA;IAEA;;EAGF;EACA,QAAQ;EACR;EAEA;;UAGe;EAMf;EACA;EAEA;EACA;EAEA;EACA;EAQA;EAKA;EAEA;EAEA;EACA;EACA;EACA;EACA;;;;KC9FU;EAEN;;EAKA;EAAwB;;EAExB;;EAUA;EAAuB;;EASvB;EAAe;;EAOf;;EAKA;;EAKA;EAA2B;;EAE3B;EAAyB;;EAczB;;EAUA;;EAEA;EAAe;;EAYf;EACA;EACA;;KAIM;;;UCnGK;EAIf;EAIA,iBAAiB;EAKjB,WAAW;EAIX;;KAGU;EAIV;EAIA;EAIA,eAAe;EASf,WAAW,OAAO;;KAGR;EAIV;EAIA,QAAQ,UAAU;EAIlB,OAAO,MAAM;EAIb;;KAQU;EAwBV;IACE;IACA;IACA;;EA4BF;EAaA;;KAGU;EAIV;EAIA;EAIA;EAQA,oBAAoB,OAAO;EAK3B,WAAW,OAAO;EAIlB,iBAAiB;EAIjB;IACE,SAAS,UAAU;;EASrB;EAMA;EAMA,WAAW;EAOX,eAAe;;;;cCtHJ,uCAAqB,0BAAA,6CAAA,cAAA;cA2HrB,yBAAwB,OAAA,OAAA,MAAA,eAKlC,8CAAyB,IAAA;cAYf,oCAAkB,0BAAA,0CAAA,cAAA;;;cCjOlB;EACX;EACA,gBAAgB;EAChB,UAAU;EACV;EAEY,cACV,gBACA,UACA,UACA,cACC;EAeH,kBAAiB,gBAAA,eAAA,OAAA,WAAA;IAOf;IACA;IACA;IACA;IACA;;EAmDF;;;;cCxFW;KAgBD,4BAA4B;iBAexB,2BAA2B;iBAK3B,uBAAuB"}