@zoho_apptics/apptics-js-sdk 1.0.2 → 2.0.0-beta.1

package/dist/esm/feedback/ui.d.ts

@@ -0,0 +1,63 @@
+import type { FeedbackOpenOptions as PublicFeedbackOpenOptions, FeedbackType, SendFeedbackOptions } from '../types.js';
+export declare function sendFeedback(options?: SendFeedbackOptions): Promise<void>;
+export declare function feedbackFormOpen(options?: PublicFeedbackOpenOptions): void;
+/**
+ * Sets the form's theme, for a page with its own light and dark modes: 'auto' follows the
+ * operating system, which is not what such a page shows. Restyles a form or recording timer that
+ * is open now, and every one opened after; Apptics.init()'s feedback_theme only sets the first.
+ */
+export declare function setFeedbackTheme(theme: 'light' | 'dark' | 'auto'): void;
+export declare function feedbackFormClose(): void;
+/** What the form is built with, from the options feedbackFormOpen() was given. */
+export interface FeedbackOpenOptions {
+    type?: FeedbackType;
+    message?: string;
+    includeLog?: boolean;
+    includeDyninfo?: boolean;
+    isAnonymous?: boolean;
+    attachments?: FileList | File[] | null;
+    logFiles?: FileList | File[] | null;
+}
+export interface FeedbackUI {
+    feedbackUIHtml: string;
+    timerHtml: string;
+    typeObj: Record<string, FeedbackType>;
+    uploadFileAry: File[];
+    fileInput: HTMLInputElement | null;
+    selectedFiles: DataTransfer | null;
+    isScaled: boolean;
+    isHidden: boolean;
+    timerDisplay: HTMLElement | null;
+    recordButton: HTMLElement | null;
+    TOTAL_TIME: number;
+    remainingTime: number;
+    isRecording: boolean;
+    timerInterval: ReturnType<typeof setInterval> | null;
+    uploadTotalSize: number;
+    MaxFileSize: number;
+    /** What the last feedbackFormOpen() asked for; the form reads it as it is built. */
+    _opts: FeedbackOpenOptions;
+    init(opts?: FeedbackOpenOptions): void;
+    updateLeftCount(): void;
+    handleStatusmsg(isSuccess?: boolean, stsmsg?: string): void;
+    handleErrorQuartzEvent(event: Event): void;
+    bindQuartzEvent(event: Event): void;
+    close(): void;
+    /** Escape closes the form; listened for from open to close. */
+    onEscape(e: KeyboardEvent): void;
+    toggleWindowAnimation(): void;
+    fileAttachment(): void;
+    elementCreator<K extends keyof HTMLElementTagNameMap>(elType: K): HTMLElementTagNameMap[K];
+    fileLimitExceeded(limitReached: boolean, filesLengthReached?: boolean): void;
+    removeFileFromList(elem: HTMLElement): void;
+    formatFileSize(bytes: number): string;
+    toggleRecording(): void;
+    startRecording(): void;
+    stopRecording(): void;
+    submitRecording(): void;
+    updateTimer(): void;
+    updateDisplay(): void;
+    validateFeedbackField(): void;
+    getVisibleErrorCount(elements: NodeListOf<Element> | Element[]): number;
+}
+export declare const feedback: FeedbackUI;