@atlaskit/contextual-survey 3.0.3 → 3.1.0

package/dist/types-ts4.5/compiled/ContextualSurvey.d.ts

@@ -0,0 +1,40 @@
+import React from 'react';
+import { type FormValues } from '../types';
+export declare enum DismissTrigger {
+    AutoDismiss = "AUTO_DISMISS",
+    Manual = "MANUAL",
+    Finished = "FINISHED",
+    Unmount = "UNMOUNT"
+}
+export type OnDismissArgs = {
+    trigger: DismissTrigger;
+};
+interface Props {
+    /** Optional statement, to be used in conjunction with the question for the survey
+     * Example: "How strongly do you agree or disagree with this statement"
+     */
+    statement?: string;
+    /** Question used for the survey
+     * Example: "It is easy to find what I am looking for in Jira"
+     */
+    question: string;
+    /** Accessible label text for the survey text area */
+    textLabel?: string;
+    /** Text placeholder for the survey text area
+     * Example: "Tell us why"
+     */
+    textPlaceholder?: string;
+    /** Callback that is triggered when the survey should be dismissed */
+    onDismiss: (args: OnDismissArgs) => void;
+    /** Gets whether user has already signed up to the Atlassian Research Group list.
+     * If `true` is returned then the user will not be prompted to sign up to the Research Group.
+     */
+    getUserHasAnsweredMailingList: () => Promise<boolean>;
+    /** Callback that is triggered when the survey is submitted, it will get the survey data as a parameter */
+    onSubmit: (formValues: FormValues) => Promise<void>;
+    /** Callback that is triggered when the user clicks 'Yes' or 'No' to sign up to the Atlassian Research Group */
+    onMailingListAnswer: (answer: boolean) => Promise<void>;
+}
+export declare const AUTO_DISAPPEAR_DURATION: number;
+declare const _default: ({ question, statement, onDismiss, onSubmit, onMailingListAnswer, getUserHasAnsweredMailingList, textLabel, textPlaceholder, }: Props) => React.JSX.Element;
+export default _default;

package/dist/types-ts4.5/compiled/FeedbackAcknowledgement.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const _default: () => React.JSX.Element;
+export default _default;

package/dist/types-ts4.5/compiled/FeedbackScoreButtons.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+/**
+ * @jsxRuntime classic
+ * @jsx jsx
+ */
+interface Props {
+    onChange: (value: number) => void;
+    value: number | undefined;
+}
+declare const _default: ({ onChange, value }: Props) => JSX.Element;
+export default _default;

package/dist/types-ts4.5/compiled/SignUpPrompt.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+/**
+ * @jsxRuntime classic
+ * @jsx jsx
+ */
+interface Props {
+    onAnswer: (answer: boolean) => Promise<void>;
+}
+declare const _default: ({ onAnswer }: Props) => JSX.Element;
+export default _default;

package/dist/types-ts4.5/compiled/SignUpSuccess.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+interface Props {
+}
+declare const _default: ({}: Props) => React.JSX.Element;
+export default _default;

package/dist/types-ts4.5/compiled/SuccessContainer.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+interface Props {
+    children: React.ReactNode;
+}
+declare const _default: ({ children }: Props) => JSX.Element;
+export default _default;

package/dist/types-ts4.5/compiled/SurveyContainer.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+/**
+ * @jsxRuntime classic
+ * @jsx jsx
+ */
+interface Props {
+    children: React.ReactNode;
+    onDismiss: () => void;
+}
+declare const _default: ({ children, onDismiss }: Props) => JSX.Element;
+export default _default;

package/dist/types-ts4.5/compiled/SurveyForm.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import { type OnSubmitHandler } from '@atlaskit/form';
+import { type FormValues } from '../types';
+interface Props {
+    question: string;
+    statement?: string;
+    textPlaceholder: string;
+    textLabel: string;
+    onSubmit: OnSubmitHandler<FormValues>;
+}
+declare const _default: ({ question, statement, textPlaceholder, textLabel, onSubmit }: Props) => JSX.Element;
+export default _default;

package/dist/types-ts4.5/compiled/SurveyMarshal.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @jsxRuntime classic
+ * @jsx jsx
+ */
+import { type ReactNode } from 'react';
+type Props = {
+    /** Whether the form should be rendered */
+    shouldShow: boolean;
+    /** A function that returns Node to be rendered (`<ContextualSurvey/>`)
+     * Using a function as child so that the child node does
+     * not need to be evaluated if it is not mounted
+     */
+    children: () => ReactNode;
+};
+export default function SurveyMarshal(props: Props): JSX.Element;
+export {};

package/dist/types-ts4.5/compiled/useEscapeToDismiss.d.ts

@@ -0,0 +1,6 @@
+export declare const escape: number;
+type Args = {
+    onDismiss: () => void;
+};
+export default function useEscapeToDismiss({ onDismiss }: Args): void;
+export {};

package/dist/types-ts4.5/components/ContextualSurvey.d.ts

@@ -9,7 +9,7 @@ export declare enum DismissTrigger {
 export type OnDismissArgs = {
     trigger: DismissTrigger;
 };
-interface Props {
+export interface Props {
     /** Optional statement, to be used in conjunction with the question for the survey
      * Example: "How strongly do you agree or disagree with this statement"
      */

package/dist/types-ts4.5/components/SurveyMarshal.d.ts

@@ -4,7 +4,7 @@
  */
 import { type ReactNode } from 'react';
 import { jsx } from '@emotion/react';
-type Props = {
+export type Props = {
     /** Whether the form should be rendered */
     shouldShow: boolean;
     /** A function that returns Node to be rendered (`<ContextualSurvey/>`)
@@ -14,4 +14,3 @@ type Props = {
     children: () => ReactNode;
 };
 export default function SurveyMarshal(props: Props): jsx.JSX.Element;
-export {};

package/dist/types-ts4.5/fg-components.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+import { type Props as ContextualSurveyProps } from './components/ContextualSurvey';
+import { type Props as SurveyMarshalProps } from './components/SurveyMarshal';
+export declare const ContextualSurvey: (props: ContextualSurveyProps) => React.JSX.Element;
+export declare const SurveyMarshal: (props: SurveyMarshalProps) => React.JSX.Element;

package/dist/types-ts4.5/index.d.ts

@@ -1,3 +1,3 @@
-export { default as ContextualSurvey, DismissTrigger } from './components/ContextualSurvey';
-export type { OnDismissArgs } from './components/ContextualSurvey';
-export { default as SurveyMarshal } from './components/SurveyMarshal';
+export { DismissTrigger, type OnDismissArgs } from './components/ContextualSurvey';
+export { ContextualSurvey } from './fg-components';
+export { SurveyMarshal } from './fg-components';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/contextual-survey",
-	"version": "3.0.3",
+	"version": "3.1.0",
 	"description": "A React component used to ask the user for feedback",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -41,13 +41,16 @@
 		"@atlaskit/checkbox": "^17.0.0",
 		"@atlaskit/form": "^12.0.0",
 		"@atlaskit/heading": "^5.1.0",
-		"@atlaskit/icon": "^24.1.0",
-		"@atlaskit/primitives": "^14.1.0",
+		"@atlaskit/icon": "^25.0.0",
+		"@atlaskit/link": "^3.0.0",
+		"@atlaskit/platform-feature-flags": "^1.1.0",
+		"@atlaskit/primitives": "^14.2.0",
 		"@atlaskit/textarea": "^8.0.0",
 		"@atlaskit/theme": "^18.0.0",
-		"@atlaskit/tokens": "^4.3.0",
+		"@atlaskit/tokens": "^4.5.0",
 		"@atlaskit/tooltip": "^20.0.0",
 		"@babel/runtime": "^7.0.0",
+		"@compiled/react": "^0.18.2",
 		"@emotion/react": "^11.7.1",
 		"react-transition-group": "^4.4.1"
 	},
@@ -74,5 +77,10 @@
 				"spacing"
 			]
 		}
+	},
+	"platform-feature-flags": {
+		"platform_contextual_survey_enable_compiled_fg": {
+			"type": "boolean"
+		}
 	}
 }