API reference

import { createStudio } from 'panelui-studio';

const studio = createStudio(config);

type SubmitFeedbackInput = {
  message: string;
  rating?: number;               // 1–5
  tags?: string[];               // up to 5
  screen?: string;
  appVersion?: string;
  build?: string;
  metadata?: Record<string, unknown>; // Pro and Max
  attachmentIds?: string[];      // 1 on Free, 3 on Pro and Max
  fields?: Record<string, string | number | boolean>; // Pro and Max
  country?: string;              // ISO-3166 alpha-2
};

type FormField = {
  key: string;
  label: string;
  type: 'text' | 'textarea' | 'choice' | 'checkbox' | 'rating';
  options: string[];             // for choice
  required: boolean;
};

type StartSupportInput = Omit<SubmitFeedbackInput, 'rating' | 'tags'>;

type Announcement = {
  id: string;
  title: string;
  body: string;
  cta: { label: string; url: string } | null;
  endsAt: string | null;
  seen: boolean;
  createdAt: string;
};

type SubmitFeedbackResult = {
  feedback: { id: string; number: number; status: FeedbackStatus; createdAt: string };
  warnings: string[];
};

type FeedbackStatus = 'new' | 'in_progress' | 'resolved' | 'archived';

type FeedbackSummary = {
  id: string;
  number: number;
  kind: 'feedback' | 'support';
  message: string;
  status: FeedbackStatus;
  createdAt: string;
  lastMessageAt: string | null;
  replies: number;
};

type ConversationMessage = {
  id: string;
  author: 'user' | 'developer';
  body: string;
  createdAt: string;
};

type ScreenshotInput =
  | { uri: string; contentType?: ScreenshotContentType; byteSize?: number }  // a file uri, or anything fetch reads
  | { file: Blob; contentType?: ScreenshotContentType; byteSize?: number }; // a File from <input type="file">, or any Blob

type ScreenshotContentType = 'image/png' | 'image/jpeg' | 'image/webp';

type DeviceContext = {
  platform?: 'ios' | 'android' | 'web' | 'other';
  osName?: string;
  osVersion?: string;
  model?: string;                // the browser and its major version on the web
  locale?: string;
  appVersion?: string;
  country?: string;              // ISO-3166 alpha-2
};

type StudioStorage = {
  getItem(key: string): Promise<string | null> | string | null;
  setItem(key: string, value: string): Promise<void> | void;
  removeItem(key: string): Promise<void> | void;
};