@botonic/plugin-flow-builder/src/webview/types.ts

Use Flow Builder to show your contents

import { FlowBuilderJSONVersion } from '../types'

export enum WebviewContentType {
  TEXT = 'webview-text',
  IMAGE = 'webview-image',
}

export type WebviewContentsResponse = (
  | WebviewTextContent
  | WebviewImageContent
)[]

export interface WebviewTextContent {
  code: string
  type: WebviewContentType.TEXT
  content: {
    text: { message: string; locale: string }[]
  }
}

export interface WebviewImageContent {
  code: string
  type: WebviewContentType.IMAGE
  content: {
    image: { file: string; locale: string }[]
  }
}

export type MapContentsType = Record<string, string>

export interface UseWebviewContentsProps<T extends MapContentsType> {
  apiUrl?: string
  version?: FlowBuilderJSONVersion
  botId: string
  webviewId: string
  providerId: string
  locale: string
  mapContents: Record<keyof T, string>
}

export interface UseWebviewContents<T extends MapContentsType> {
  isLoading: boolean
  error: boolean
  webviewContentsContext: WebviewContentsContextType<T>
}

export interface WebviewContentsContextType<T extends MapContentsType> {
  getTextContent: (code: string) => string
  getImageSrc: (code: string) => string
  setCurrentLocale: (locale: string) => void
  contents: Record<keyof T, string>
}