gotcha-feedback 1.1.12 → 1.2.0

package/LICENSE.FRAUNCES.txt

@@ -0,0 +1,115 @@
+===============================================================================
+MODIFICATION NOTICE (per OFL §4)
+===============================================================================
+
+gotcha-feedback ships a modified subset of the Fraunces typeface. The subset
+is limited to printable ASCII (U+0020-007E), optical size 9pt, weight 400
+(Regular), with kern and liga features retained and hinting removed. It is
+produced from the original Fraunces source using pyftsubset (fonttools).
+
+The subset is exposed under the CSS font-family name "Gotcha Fraunces" to
+satisfy OFL §1's Reserved Font Name requirement — we do not claim to
+distribute "Fraunces" itself.
+
+The original, unmodified Fraunces source is available at:
+https://github.com/undercasetype/Fraunces
+
+Upstream commit pinned: 7ccdec31c6028118dce3e47fe864e3744460371d
+
+The unabridged SIL Open Font License 1.1 follows below.
+
+===============================================================================
+
+Copyright 2018 The Fraunces Project Authors (https://github.com/undercasetype/Fraunces)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/README.md

@@ -57,6 +57,22 @@ function FeatureCard() {
 - **Accessible** - Full keyboard navigation and screen reader support
 - **Animated** - Smooth enter/exit animations with CSS transitions
 
+## Content Security Policy
+
+The SDK injects its stylesheet as an inline `<style>` tag and embeds its
+display font as a `data:` URL inside that stylesheet. If your site runs
+a strict CSP, you will need the following directives:
+
+- `style-src 'unsafe-inline'` (or a matching nonce) — the SDK injects
+  its own stylesheet at runtime.
+- `font-src data:` (or `font-src 'self' data:`) — the branded serif font
+  is embedded as a base64 data URL so the SDK makes **zero** third-party
+  font requests.
+
+The SDK makes no other external requests for fonts, analytics, or
+tracking. See `LICENSE.FRAUNCES.txt` for the bundled Fraunces subset
+license (OFL 1.1).
+
 ## Props
 
 ### GotchaProvider

package/dist/index.d.mts

@@ -65,6 +65,7 @@ interface SubmitResponsePayload {
     isBug?: boolean;
     screenshot?: string;
     user?: GotchaUser;
+    userEmail?: string;
     context?: SubmissionContext;
 }
 interface GotchaResponse {
@@ -172,6 +173,7 @@ interface GotchaThemeColors {
 }
 interface GotchaThemeTypography {
     fontFamily: string;
+    fontFamilyDisplay: string;
     fontSize: {
         xs: number;
         sm: number;
@@ -220,7 +222,7 @@ interface GotchaThemeConfig {
     animation?: Partial<GotchaThemeAnimation>;
 }
 /** Create a custom theme by merging partial overrides onto a preset */
-declare function createTheme(base: 'light' | 'dark', overrides: GotchaThemeConfig): GotchaThemeConfig;
+declare function createTheme(base: "light" | "dark", overrides: GotchaThemeConfig): GotchaThemeConfig;
 
 interface GotchaProviderProps {
     /** Your Gotcha API key */
@@ -235,16 +237,29 @@ interface GotchaProviderProps {
     disabled?: boolean;
     /** Default user metadata applied to all submissions */
     defaultUser?: GotchaUser;
+    /**
+     * Default submitter email applied to all <Gotcha /> instances under this
+     * provider. Per-instance `userEmail` prop wins when both are set. Used
+     * by the dashboard to send "we shipped what you asked for" notify-back.
+     */
+    defaultUserEmail?: string;
     /** Theme configuration overrides applied to all instances */
     themeConfig?: GotchaThemeConfig;
 }
-declare function GotchaProvider({ apiKey, children, baseUrl, debug, disabled, defaultUser, themeConfig, }: GotchaProviderProps): react_jsx_runtime.JSX.Element;
+declare function GotchaProvider({ apiKey, children, baseUrl, debug, disabled, defaultUser, defaultUserEmail, themeConfig, }: GotchaProviderProps): react_jsx_runtime.JSX.Element;
 
 interface GotchaProps {
     /** Unique identifier for this element */
     elementId: string;
     /** User metadata for segmentation */
     user?: GotchaUser;
+    /**
+     * Submitter's email address. When set, the dashboard can email the user
+     * a "we shipped what you asked for" note when their feedback hits the
+     * SHIPPED status. Pass only with explicit user consent — store no other
+     * PII in this field.
+     */
+    userEmail?: string;
     /** Feedback mode */
     mode?: ResponseMode;
     /** Show the text input in feedback mode (default: true) */
@@ -333,7 +348,7 @@ interface GotchaProps {
     /** Called on error */
     onError?: (error: GotchaError) => void;
 }
-declare function Gotcha({ elementId, user, mode, showText, showRating, voteLabels, options, allowMultiple, npsQuestion, npsFollowUp, npsFollowUpPlaceholder, npsLowLabel, npsHighLabel, enableBugFlag, bugFlagLabel, enableScreenshot, onePerUser, cooldownDays, hideAfterSubmitDays, showAfterSeconds, showAfterScrollPercent, showAfterVisits, followUp, animated, position, size, theme, customStyles, visible, showOnHover, touchBehavior, promptText, placeholder, submitText, thankYouMessage, onSubmit, onOpen, onClose, onError, }: GotchaProps): react_jsx_runtime.JSX.Element | null;
+declare function Gotcha({ elementId, user, userEmail, mode, showText, showRating, voteLabels, options, allowMultiple, npsQuestion, npsFollowUp, npsFollowUpPlaceholder, npsLowLabel, npsHighLabel, enableBugFlag, bugFlagLabel, enableScreenshot, onePerUser, cooldownDays, hideAfterSubmitDays, showAfterSeconds, showAfterScrollPercent, showAfterVisits, followUp, animated, position, size, theme, customStyles, visible, showOnHover, touchBehavior, promptText, placeholder, submitText, thankYouMessage, onSubmit, onOpen, onClose, onError, }: GotchaProps): react_jsx_runtime.JSX.Element | null;
 
 type ScoreVariant = 'stars' | 'number' | 'compact' | 'votes';
 interface GotchaScoreProps {

package/dist/index.d.ts

@@ -65,6 +65,7 @@ interface SubmitResponsePayload {
     isBug?: boolean;
     screenshot?: string;
     user?: GotchaUser;
+    userEmail?: string;
     context?: SubmissionContext;
 }
 interface GotchaResponse {
@@ -172,6 +173,7 @@ interface GotchaThemeColors {
 }
 interface GotchaThemeTypography {
     fontFamily: string;
+    fontFamilyDisplay: string;
     fontSize: {
         xs: number;
         sm: number;
@@ -220,7 +222,7 @@ interface GotchaThemeConfig {
     animation?: Partial<GotchaThemeAnimation>;
 }
 /** Create a custom theme by merging partial overrides onto a preset */
-declare function createTheme(base: 'light' | 'dark', overrides: GotchaThemeConfig): GotchaThemeConfig;
+declare function createTheme(base: "light" | "dark", overrides: GotchaThemeConfig): GotchaThemeConfig;
 
 interface GotchaProviderProps {
     /** Your Gotcha API key */
@@ -235,16 +237,29 @@ interface GotchaProviderProps {
     disabled?: boolean;
     /** Default user metadata applied to all submissions */
     defaultUser?: GotchaUser;
+    /**
+     * Default submitter email applied to all <Gotcha /> instances under this
+     * provider. Per-instance `userEmail` prop wins when both are set. Used
+     * by the dashboard to send "we shipped what you asked for" notify-back.
+     */
+    defaultUserEmail?: string;
     /** Theme configuration overrides applied to all instances */
     themeConfig?: GotchaThemeConfig;
 }
-declare function GotchaProvider({ apiKey, children, baseUrl, debug, disabled, defaultUser, themeConfig, }: GotchaProviderProps): react_jsx_runtime.JSX.Element;
+declare function GotchaProvider({ apiKey, children, baseUrl, debug, disabled, defaultUser, defaultUserEmail, themeConfig, }: GotchaProviderProps): react_jsx_runtime.JSX.Element;
 
 interface GotchaProps {
     /** Unique identifier for this element */
     elementId: string;
     /** User metadata for segmentation */
     user?: GotchaUser;
+    /**
+     * Submitter's email address. When set, the dashboard can email the user
+     * a "we shipped what you asked for" note when their feedback hits the
+     * SHIPPED status. Pass only with explicit user consent — store no other
+     * PII in this field.
+     */
+    userEmail?: string;
     /** Feedback mode */
     mode?: ResponseMode;
     /** Show the text input in feedback mode (default: true) */
@@ -333,7 +348,7 @@ interface GotchaProps {
     /** Called on error */
     onError?: (error: GotchaError) => void;
 }
-declare function Gotcha({ elementId, user, mode, showText, showRating, voteLabels, options, allowMultiple, npsQuestion, npsFollowUp, npsFollowUpPlaceholder, npsLowLabel, npsHighLabel, enableBugFlag, bugFlagLabel, enableScreenshot, onePerUser, cooldownDays, hideAfterSubmitDays, showAfterSeconds, showAfterScrollPercent, showAfterVisits, followUp, animated, position, size, theme, customStyles, visible, showOnHover, touchBehavior, promptText, placeholder, submitText, thankYouMessage, onSubmit, onOpen, onClose, onError, }: GotchaProps): react_jsx_runtime.JSX.Element | null;
+declare function Gotcha({ elementId, user, userEmail, mode, showText, showRating, voteLabels, options, allowMultiple, npsQuestion, npsFollowUp, npsFollowUpPlaceholder, npsLowLabel, npsHighLabel, enableBugFlag, bugFlagLabel, enableScreenshot, onePerUser, cooldownDays, hideAfterSubmitDays, showAfterSeconds, showAfterScrollPercent, showAfterVisits, followUp, animated, position, size, theme, customStyles, visible, showOnHover, touchBehavior, promptText, placeholder, submitText, thankYouMessage, onSubmit, onOpen, onClose, onError, }: GotchaProps): react_jsx_runtime.JSX.Element | null;
 
 type ScoreVariant = 'stars' | 'number' | 'compact' | 'votes';
 interface GotchaScoreProps {