@webotme/react-native 0.1.1

package/src/types.ts

@@ -0,0 +1,151 @@
+/**
+ * Public type surface for @webotme/react-native.
+ *
+ * The `Native*` types mirror the `screenContext` contract documented at
+ * /docs -> "Native & mobile apps". Send them and the same AutoFlow engine that
+ * guides the web widget will guide your app.
+ */
+
+export type WebotMeButton = {
+  id?: string;
+  text?: string;
+  accessibilityLabel?: string;
+  disabled?: boolean;
+};
+
+export type WebotMeField = {
+  id?: string;
+  label?: string;
+  placeholder?: string;
+  name?: string;
+  type?: string;
+  value?: string;
+  required?: boolean;
+  options?: string[];
+};
+
+export type WebotMeLink = {
+  id?: string;
+  text?: string;
+  route?: string;
+};
+
+export type WebotMeList = {
+  label?: string;
+  items?: string[];
+};
+
+/**
+ * A snapshot of the screen the user is currently on. AutoFlow reads this
+ * instead of a DOM, which is what lets it pick the right next action.
+ */
+export type WebotMeScreenContext = {
+  name?: string;
+  title?: string;
+  visibleText?: string[];
+  buttons?: WebotMeButton[];
+  forms?: WebotMeField[];
+  links?: WebotMeLink[];
+  alerts?: string[];
+  lists?: WebotMeList[];
+};
+
+export type WebotMeMessage = {
+  id: string;
+  from: "user" | "bot";
+  text: string;
+  createdAt: number;
+  /** Present when the server attached a native action (AutoFlow). */
+  action?: WebotMeAction;
+  pending?: boolean;
+  failed?: boolean;
+};
+
+export type WebotMeAction =
+  | { type: "navigate"; data: { url: string }; label?: string }
+  | { type: "click"; data: { selector?: string; text?: string; section?: string }; label?: string }
+  | { type: "fill"; data: { label?: string; selector?: string; text: string; currentValue?: string }; label?: string }
+  | { type: "checkout"; data: { url: string }; label?: string };
+
+/** Pending multi-step workflow from server. */
+export type WebotMePendingWorkflow = {
+  goal: string;
+  plan: string[];
+  done?: string[];
+};
+
+export type WebotMeAutoTask = {
+  goal: string;
+  plan: string[];
+  done?: string[];
+};
+
+/** Error codes returned by POST /native-chat/v1 (stable across versions). */
+export type WebotMeErrorCode =
+  | "INVALID_REQUEST"
+  | "UNAUTHORIZED"
+  | "FORBIDDEN"
+  | "BOT_NOT_FOUND"
+  | "RATE_LIMITED"
+  | "PLAN_LIMIT_REACHED"
+  | "AI_UNAVAILABLE"
+  | "INTERNAL_ERROR"
+  | "NETWORK_ERROR";
+
+export class WebotMeError extends Error {
+  code: WebotMeErrorCode;
+  status?: number;
+
+  constructor(code: WebotMeErrorCode, message: string, status?: number) {
+    super(message);
+    this.name = "WebotMeError";
+    this.code = code;
+    this.status = status;
+  }
+}
+
+export type WebotMeCapabilities = {
+  chat: boolean;
+  screenContext: boolean;
+  autoFlow: boolean;
+  fileUpload: boolean;
+  voice: boolean;
+};
+
+export type WebotMeContract = {
+  version: string;
+  botId: string;
+  endpoints: Record<string, string>;
+  capabilities: WebotMeCapabilities;
+};
+
+export type WebotMeTheme = {
+  primary?: string;
+  background?: string;
+  surface?: string;
+  text?: string;
+  muted?: string;
+  radius?: number;
+};
+
+export type WebotMeConfig = {
+  /** Bot ID from the WebotMe dashboard. */
+  botId: string;
+  /** Backend base URL, e.g. https://your-api.com (never localhost on device). */
+  apiBaseUrl: string;
+  /**
+   * Frontend base URL that serves the shareable chat page, e.g.
+   * https://your-frontend.com. Required by the WebView widget; falls back to
+   * apiBaseUrl when omitted.
+   */
+  chatBaseUrl?: string;
+  /** Stable visitor id. Generated and persisted when omitted. */
+  userId?: string;
+  theme?: WebotMeTheme;
+  /** Shown above the first bot message. */
+  welcome?: string;
+  /** Send this screen context with every message. */
+  screenContext?: WebotMeScreenContext;
+  /** Milliseconds before a send is treated as failed. Default 30000. */
+  timeoutMs?: number;
+};