@sentry/react-native 8.6.0 → 8.7.0

package/{dist/js/feedback/FeedbackWidget.types.d.ts → ts3.8/dist/js/feedback/FeedbackForm.types.d.ts}

@@ -1,299 +1,305 @@
-import type { FeedbackFormData } from '@sentry/core';
-import type { ImageStyle, TextStyle, ViewStyle } from 'react-native';
-/**
- * The props for the feedback form
- */
-export interface FeedbackWidgetProps extends FeedbackGeneralConfiguration, FeedbackTextConfiguration, FeedbackCallbacks, ImagePickerConfiguration {
-    styles?: FeedbackWidgetStyles;
-}
-/**
- * General feedback configuration
- */
-export interface FeedbackGeneralConfiguration {
-    /**
-     * Show the Sentry branding
-     *
-     * @default true
-     */
-    showBranding: boolean;
-    /**
-     * Should the email field be required?
-     */
-    isEmailRequired: boolean;
-    /**
-     * Should the email field be validated?
-     */
-    shouldValidateEmail: boolean;
-    /**
-     * Should the name field be required?
-     */
-    isNameRequired: boolean;
-    /**
-     * Should the email input field be visible? Note: email will still be collected if set via `Sentry.setUser()`
-     */
-    showEmail: boolean;
-    /**
-     * Should the name input field be visible? Note: name will still be collected if set via `Sentry.setUser()`
-     */
-    showName: boolean;
-    /**
-     * This flag determines whether the "Add Screenshot" button is displayed
-     * @default false
-     */
-    enableScreenshot: boolean;
-    /**
-     * This flag determines whether the "Take Screenshot" button is displayed
-     * @default false
-     */
-    enableTakeScreenshot?: boolean;
-    /**
-     * Enable auto-correct for text inputs.
-     *
-     * @default true
-     */
-    autoCorrect?: boolean;
-    /**
-     * Enable spell check for text inputs.
-     *
-     * @default true
-     */
-    spellCheck?: boolean;
-    /**
-     * Fill in email/name input fields with Sentry user context if it exists.
-     * The value of the email/name keys represent the properties of your user context.
-     */
-    useSentryUser?: {
-        email: string;
-        name: string;
-    };
-}
-/**
- * All of the different text labels that can be customized
- */
-export interface FeedbackTextConfiguration {
-    /**
-     * The label for the Feedback form cancel button that closes dialog
-     */
-    cancelButtonLabel: string;
-    /**
-     * The label for the Feedback form submit button that sends feedback
-     */
-    submitButtonLabel: string;
-    /**
-     * The title of the Feedback form
-     */
-    formTitle: string;
-    /**
-     * Label for the email input
-     */
-    emailLabel: string;
-    /**
-     * Placeholder text for Feedback email input
-     */
-    emailPlaceholder: string;
-    /**
-     * Label for the message input
-     */
-    messageLabel: string;
-    /**
-     * Placeholder text for Feedback message input
-     */
-    messagePlaceholder?: string;
-    /**
-     * Label for the name input
-     */
-    nameLabel: string;
-    /**
-     * Message after feedback was sent successfully
-     */
-    successMessageText: string;
-    /**
-     * Placeholder text for Feedback name input
-     */
-    namePlaceholder: string;
-    /**
-     * Text which indicates that a field is required
-     */
-    isRequiredLabel: string;
-    /**
-     * The label for the button that adds a screenshot
-     */
-    addScreenshotButtonLabel: string;
-    /**
-     * The label for the button that removes a screenshot
-     */
-    removeScreenshotButtonLabel: string;
-    /**
-     * The label for the button that shows the capture screenshot button
-     */
-    captureScreenshotButtonLabel?: string;
-    /**
-     * The title of the error dialog
-     */
-    errorTitle: string;
-    /**
-     * The error message when the form is invalid
-     */
-    formError: string;
-    /**
-     * The error message when the email is invalid
-     */
-    emailError: string;
-    /**
-     * The error message when the capture screenshot fails
-     */
-    captureScreenshotError: string;
-    /**
-     * Message when there is a generic error
-     */
-    genericError: string;
-}
-/**
- * The FeedbackButton text labels that can be customized
- */
-export interface FeedbackButtonTextConfiguration {
-    /**
-     * The label for the Feedback widget button that opens the dialog
-     */
-    triggerLabel?: string;
-    /**
-     * The aria label for the Feedback widget button that opens the dialog
-     */
-    triggerAriaLabel?: string;
-}
-/**
- * The ScreenshotButton text labels that can be customized
- */
-export interface ScreenshotButtonTextConfiguration {
-    /**
-     * The label for the Screenshot button
-     */
-    triggerLabel?: string;
-    /**
-     * The aria label for the Screenshot button
-     */
-    triggerAriaLabel?: string;
-}
-/**
- * The public callbacks available for the feedback integration
- */
-export interface FeedbackCallbacks {
-    /**
-     * Callback when form is opened
-     */
-    onFormOpen: () => void;
-    /**
-     * Callback when form is closed and not submitted
-     */
-    onFormClose: () => void;
-    /**
-     * Callback when a screenshot is added
-     */
-    onAddScreenshot: (addScreenshot: (uri: string) => void) => void;
-    /**
-     * Callback when feedback is successfully submitted
-     *
-     * After this you'll see a SuccessMessage on the screen for a moment.
-     */
-    onSubmitSuccess: (data: FeedbackFormData) => void;
-    /**
-     * Callback when feedback is unsuccessfully submitted
-     */
-    onSubmitError: (error: Error) => void;
-    /**
-     * Callback when the feedback form is submitted successfully, and the SuccessMessage is complete, or dismissed
-     */
-    onFormSubmitted: () => void;
-}
-/**
- * Image Picker configuration interface compatible with:
- * - `react-native-image-picker`: 7.2, 8.0
- * - `expo-image-picker`: 16.0`
- */
-export interface ImagePickerConfiguration {
-    imagePicker?: ImagePicker;
-}
-interface ImagePickerResponse {
-    assets?: ImagePickerAsset[];
-}
-interface ImagePickerAsset {
-    fileName?: string;
-    uri?: string;
-    base64?: string;
-}
-interface ExpoImageLibraryOptions {
-    mediaTypes?: 'images'[];
-    base64?: boolean;
-}
-interface ReactNativeImageLibraryOptions {
-    mediaType: 'photo';
-    includeBase64?: boolean;
-}
-export interface ImagePicker {
-    launchImageLibraryAsync?: (options?: ExpoImageLibraryOptions) => Promise<ImagePickerResponse>;
-    launchImageLibrary?: (options: ReactNativeImageLibraryOptions) => Promise<ImagePickerResponse>;
-}
-/**
- * The styles for the feedback form
- */
-export interface FeedbackWidgetStyles {
-    container?: ViewStyle;
-    title?: TextStyle;
-    label?: TextStyle;
-    input?: TextStyle;
-    textArea?: TextStyle;
-    submitButton?: ViewStyle;
-    submitText?: TextStyle;
-    cancelButton?: ViewStyle;
-    cancelText?: TextStyle;
-    screenshotButton?: ViewStyle;
-    screenshotContainer?: ViewStyle;
-    screenshotThumbnail?: ImageStyle;
-    screenshotText?: TextStyle;
-    takeScreenshotButton?: ViewStyle;
-    takeScreenshotText?: TextStyle;
-    titleContainer?: ViewStyle;
-    sentryLogo?: ImageStyle;
-}
-/**
- * The props for the feedback button
- */
-export interface FeedbackButtonProps extends FeedbackButtonTextConfiguration {
-    styles?: FeedbackButtonStyles;
-}
-/**
- * The styles for the feedback button
- */
-export interface FeedbackButtonStyles {
-    triggerButton?: ViewStyle;
-    triggerText?: TextStyle;
-    triggerIcon?: ImageStyle;
-}
-/**
- * The props for the screenshot button
- */
-export interface ScreenshotButtonProps extends ScreenshotButtonTextConfiguration {
-    styles?: ScreenshotButtonStyles;
-}
-/**
- * The styles for the screenshot button
- */
-export interface ScreenshotButtonStyles {
-    triggerButton?: ViewStyle;
-    triggerText?: TextStyle;
-    triggerIcon?: ImageStyle;
-}
-/**
- * The state of the feedback form
- */
-export interface FeedbackWidgetState {
-    isVisible: boolean;
-    name: string;
-    email: string;
-    description: string;
-    filename?: string;
-    attachment?: string | Uint8Array;
-    attachmentUri?: string;
-}
-export {};
-//# sourceMappingURL=FeedbackWidget.types.d.ts.map
+import type { FeedbackFormData } from '@sentry/core';
+import type { ImageStyle, TextStyle, ViewStyle } from 'react-native';
+/**
+ * The props for the feedback form
+ */
+export interface FeedbackFormProps extends FeedbackGeneralConfiguration, FeedbackTextConfiguration, FeedbackCallbacks, ImagePickerConfiguration {
+    styles?: FeedbackFormStyles;
+}
+/**
+ * General feedback configuration
+ */
+export interface FeedbackGeneralConfiguration {
+    /**
+     * Show the Sentry branding
+     *
+     * @default true
+     */
+    showBranding: boolean;
+    /**
+     * Should the email field be required?
+     */
+    isEmailRequired: boolean;
+    /**
+     * Should the email field be validated?
+     */
+    shouldValidateEmail: boolean;
+    /**
+     * Should the name field be required?
+     */
+    isNameRequired: boolean;
+    /**
+     * Should the email input field be visible? Note: email will still be collected if set via `Sentry.setUser()`
+     */
+    showEmail: boolean;
+    /**
+     * Should the name input field be visible? Note: name will still be collected if set via `Sentry.setUser()`
+     */
+    showName: boolean;
+    /**
+     * This flag determines whether the "Add Screenshot" button is displayed
+     * @default false
+     */
+    enableScreenshot: boolean;
+    /**
+     * This flag determines whether the "Take Screenshot" button is displayed
+     * @default false
+     */
+    enableTakeScreenshot?: boolean;
+    /**
+     * Enable auto-correct for text inputs.
+     *
+     * @default true
+     */
+    autoCorrect?: boolean;
+    /**
+     * Enable spell check for text inputs.
+     *
+     * @default true
+     */
+    spellCheck?: boolean;
+    /**
+     * Fill in email/name input fields with Sentry user context if it exists.
+     * The value of the email/name keys represent the properties of your user context.
+     */
+    useSentryUser?: {
+        email: string;
+        name: string;
+    };
+}
+/**
+ * All of the different text labels that can be customized
+ */
+export interface FeedbackTextConfiguration {
+    /**
+     * The label for the Feedback form cancel button that closes dialog
+     */
+    cancelButtonLabel: string;
+    /**
+     * The label for the Feedback form submit button that sends feedback
+     */
+    submitButtonLabel: string;
+    /**
+     * The title of the Feedback form
+     */
+    formTitle: string;
+    /**
+     * Label for the email input
+     */
+    emailLabel: string;
+    /**
+     * Placeholder text for Feedback email input
+     */
+    emailPlaceholder: string;
+    /**
+     * Label for the message input
+     */
+    messageLabel: string;
+    /**
+     * Placeholder text for Feedback message input
+     */
+    messagePlaceholder?: string;
+    /**
+     * Label for the name input
+     */
+    nameLabel: string;
+    /**
+     * Message after feedback was sent successfully
+     */
+    successMessageText: string;
+    /**
+     * Placeholder text for Feedback name input
+     */
+    namePlaceholder: string;
+    /**
+     * Text which indicates that a field is required
+     */
+    isRequiredLabel: string;
+    /**
+     * The label for the button that adds a screenshot
+     */
+    addScreenshotButtonLabel: string;
+    /**
+     * The label for the button that removes a screenshot
+     */
+    removeScreenshotButtonLabel: string;
+    /**
+     * The label for the button that shows the capture screenshot button
+     */
+    captureScreenshotButtonLabel?: string;
+    /**
+     * The title of the error dialog
+     */
+    errorTitle: string;
+    /**
+     * The error message when the form is invalid
+     */
+    formError: string;
+    /**
+     * The error message when the email is invalid
+     */
+    emailError: string;
+    /**
+     * The error message when the capture screenshot fails
+     */
+    captureScreenshotError: string;
+    /**
+     * Message when there is a generic error
+     */
+    genericError: string;
+}
+/**
+ * The FeedbackButton text labels that can be customized
+ */
+export interface FeedbackButtonTextConfiguration {
+    /**
+     * The label for the Feedback widget button that opens the dialog
+     */
+    triggerLabel?: string;
+    /**
+     * The aria label for the Feedback widget button that opens the dialog
+     */
+    triggerAriaLabel?: string;
+}
+/**
+ * The ScreenshotButton text labels that can be customized
+ */
+export interface ScreenshotButtonTextConfiguration {
+    /**
+     * The label for the Screenshot button
+     */
+    triggerLabel?: string;
+    /**
+     * The aria label for the Screenshot button
+     */
+    triggerAriaLabel?: string;
+}
+/**
+ * The public callbacks available for the feedback integration
+ */
+export interface FeedbackCallbacks {
+    /**
+     * Callback when form is opened
+     */
+    onFormOpen: () => void;
+    /**
+     * Callback when form is closed and not submitted
+     */
+    onFormClose: () => void;
+    /**
+     * Callback when a screenshot is added
+     */
+    onAddScreenshot: (addScreenshot: (uri: string) => void) => void;
+    /**
+     * Callback when feedback is successfully submitted
+     *
+     * After this you'll see a SuccessMessage on the screen for a moment.
+     */
+    onSubmitSuccess: (data: FeedbackFormData) => void;
+    /**
+     * Callback when feedback is unsuccessfully submitted
+     */
+    onSubmitError: (error: Error) => void;
+    /**
+     * Callback when the feedback form is submitted successfully, and the SuccessMessage is complete, or dismissed
+     */
+    onFormSubmitted: () => void;
+}
+/**
+ * Image Picker configuration interface compatible with:
+ * - `react-native-image-picker`: 7.2, 8.0
+ * - `expo-image-picker`: 16.0`
+ */
+export interface ImagePickerConfiguration {
+    imagePicker?: ImagePicker;
+}
+interface ImagePickerResponse {
+    assets?: ImagePickerAsset[];
+}
+interface ImagePickerAsset {
+    fileName?: string;
+    uri?: string;
+    base64?: string;
+}
+interface ExpoImageLibraryOptions {
+    mediaTypes?: 'images'[];
+    base64?: boolean;
+}
+interface ReactNativeImageLibraryOptions {
+    mediaType: 'photo';
+    includeBase64?: boolean;
+}
+export interface ImagePicker {
+    launchImageLibraryAsync?: (options?: ExpoImageLibraryOptions) => Promise<ImagePickerResponse>;
+    launchImageLibrary?: (options: ReactNativeImageLibraryOptions) => Promise<ImagePickerResponse>;
+}
+/**
+ * The styles for the feedback form
+ */
+export interface FeedbackFormStyles {
+    container?: ViewStyle;
+    title?: TextStyle;
+    label?: TextStyle;
+    input?: TextStyle;
+    textArea?: TextStyle;
+    submitButton?: ViewStyle;
+    submitText?: TextStyle;
+    cancelButton?: ViewStyle;
+    cancelText?: TextStyle;
+    screenshotButton?: ViewStyle;
+    screenshotContainer?: ViewStyle;
+    screenshotThumbnail?: ImageStyle;
+    screenshotText?: TextStyle;
+    takeScreenshotButton?: ViewStyle;
+    takeScreenshotText?: TextStyle;
+    titleContainer?: ViewStyle;
+    sentryLogo?: ImageStyle;
+}
+/**
+ * The props for the feedback button
+ */
+export interface FeedbackButtonProps extends FeedbackButtonTextConfiguration {
+    styles?: FeedbackButtonStyles;
+}
+/**
+ * The styles for the feedback button
+ */
+export interface FeedbackButtonStyles {
+    triggerButton?: ViewStyle;
+    triggerText?: TextStyle;
+    triggerIcon?: ImageStyle;
+}
+/**
+ * The props for the screenshot button
+ */
+export interface ScreenshotButtonProps extends ScreenshotButtonTextConfiguration {
+    styles?: ScreenshotButtonStyles;
+}
+/**
+ * The styles for the screenshot button
+ */
+export interface ScreenshotButtonStyles {
+    triggerButton?: ViewStyle;
+    triggerText?: TextStyle;
+    triggerIcon?: ImageStyle;
+}
+/**
+ * The state of the feedback form
+ */
+export interface FeedbackFormState {
+    isVisible: boolean;
+    name: string;
+    email: string;
+    description: string;
+    filename?: string;
+    attachment?: string | Uint8Array;
+    attachmentUri?: string;
+}
+/** @deprecated Use `FeedbackFormProps` instead. */
+export type FeedbackWidgetProps = FeedbackFormProps;
+/** @deprecated Use `FeedbackFormStyles` instead. */
+export type FeedbackWidgetStyles = FeedbackFormStyles;
+/** @deprecated Use `FeedbackFormState` instead. */
+export type FeedbackWidgetState = FeedbackFormState;
+export {};
+//# sourceMappingURL=FeedbackForm.types.d.ts.map

package/ts3.8/dist/js/feedback/{FeedbackWidgetManager.d.ts → FeedbackFormManager.d.ts}

@@ -15,14 +15,16 @@ declare abstract class FeedbackManager {
     static isFormVisible(): boolean;
 }
 /**
- * Provides functionality to show and hide the feedback widget.
+ * Provides functionality to show and hide the feedback form.
  */
-export declare class FeedbackWidgetManager extends FeedbackManager {
+export declare class FeedbackFormManager extends FeedbackManager {
     /**
      * Returns the name of the feedback component.
      */
     protected static get _feedbackComponentName(): string;
 }
+/** @deprecated Use `FeedbackFormManager` instead. */
+export declare const FeedbackWidgetManager: typeof FeedbackFormManager;
 /**
  * Provides functionality to show and hide the feedback button.
  */
@@ -41,9 +43,15 @@ export declare class ScreenshotButtonManager extends FeedbackManager {
      */
     protected static get _feedbackComponentName(): string;
 }
+declare const showFeedbackForm: () => void;
+declare const resetFeedbackFormManager: () => void;
+/** @deprecated Use `showFeedbackForm` instead. */
 declare const showFeedbackWidget: () => void;
+/** @deprecated Use `resetFeedbackFormManager` instead. */
 declare const resetFeedbackWidgetManager: () => void;
+/** @deprecated `showFeedbackButton` will be removed in a future major version. */
 declare const showFeedbackButton: () => void;
+/** @deprecated `hideFeedbackButton` will be removed in a future major version. */
 declare const hideFeedbackButton: () => void;
 declare const resetFeedbackButtonManager: () => void;
 declare const showScreenshotButton: () => void;
@@ -51,5 +59,5 @@ declare const hideScreenshotButton: () => void;
 declare const resetScreenshotButtonManager: () => void;
 declare const enableFeedbackOnShake: () => void;
 declare const disableFeedbackOnShake: () => void;
-export { showFeedbackButton, hideFeedbackButton, showFeedbackWidget, enableFeedbackOnShake, disableFeedbackOnShake, showScreenshotButton, hideScreenshotButton, resetFeedbackButtonManager, resetFeedbackWidgetManager, resetScreenshotButtonManager };
-//# sourceMappingURL=FeedbackWidgetManager.d.ts.map
+export { showFeedbackButton, hideFeedbackButton, showFeedbackForm, showFeedbackWidget, enableFeedbackOnShake, disableFeedbackOnShake, showScreenshotButton, hideScreenshotButton, resetFeedbackButtonManager, resetFeedbackFormManager, resetFeedbackWidgetManager, resetScreenshotButtonManager, };
+//# sourceMappingURL=FeedbackFormManager.d.ts.map