@atlaskit/contextual-survey 2.1.3 → 2.1.5

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/contextual-survey
 
+## 2.1.5
+
+### Patch Changes
+
+- [`8cc2f888c83`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8cc2f888c83) - Upgrade Typescript from `4.3.5` to `4.5.5`
+
+## 2.1.4
+
+### Patch Changes
+
+- [`8d4228767b0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8d4228767b0) - Upgrade Typescript from `4.2.4` to `4.3.5`.
+
 ## 2.1.3
 
 ### Patch Changes

package/constants/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/constants.js",
   "module:es2019": "../dist/es2019/constants.js",
   "sideEffects": false,
-  "types": "../dist/types/constants.d.ts"
+  "types": "../dist/types/constants.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/constants.d.ts"
+      ]
+    }
+  }
 }

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/contextual-survey",
-	"version": "2.1.3",
+	"version": "2.1.5",
 	"sideEffects": false
 }

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/contextual-survey",
-	"version": "2.1.3",
+	"version": "2.1.5",
 	"sideEffects": false
 }

package/dist/esm/components/ContextualSurvey.js

@@ -1,6 +1,6 @@
-import _regeneratorRuntime from "@babel/runtime/regenerator";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
 import React, { useCallback, useEffect, useRef, useState } from 'react';
 import FeedbackAcknowledgement from './FeedbackAcknowledgement';
 import SignUpPrompt from './SignUpPrompt';

package/dist/esm/components/SignUpPrompt.js

@@ -1,10 +1,11 @@
 import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
-import _regeneratorRuntime from "@babel/runtime/regenerator";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 
 var _templateObject, _templateObject2;
 
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+
 /** @jsx jsx */
 import { useCallback, useState } from 'react';
 import { css, jsx } from '@emotion/core';

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/contextual-survey",
-	"version": "2.1.3",
+	"version": "2.1.5",
 	"sideEffects": false
 }

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

@@ -0,0 +1,40 @@
+/// <reference types="react" />
+import { FormValues } from '../types';
+export declare enum DismissTrigger {
+    AutoDismiss = "AUTO_DISMISS",
+    Manual = "MANUAL",
+    Finished = "FINISHED",
+    Unmount = "UNMOUNT"
+}
+export declare 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) => JSX.Element;
+export default _default;

package/dist/types-ts4.0/components/FeedbackAcknowledgement.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+declare const _default: () => JSX.Element;
+export default _default;

package/dist/types-ts4.0/components/FeedbackScoreButtons.d.ts

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

package/dist/types-ts4.0/components/SignUpPrompt.d.ts

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

package/dist/types-ts4.0/components/SignUpSuccess.d.ts

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

package/dist/types-ts4.0/components/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.0/components/SurveyContainer.d.ts

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

package/dist/types-ts4.0/components/SurveyForm.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import { OnSubmitHandler } from '@atlaskit/form';
+import { 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.0/components/SurveyMarshal.d.ts

@@ -0,0 +1,13 @@
+/** @jsx jsx */
+import { ReactNode } from 'react';
+declare 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.0/components/useEscapeToDismiss.d.ts

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

package/dist/types-ts4.0/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const surveyInnerWidth: number;
+export declare const surveyOffset: number;

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

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

package/dist/types-ts4.0/types.d.ts

@@ -0,0 +1,5 @@
+export declare type FormValues = {
+    feedbackScore: number;
+    canContact: boolean;
+    writtenFeedback: string;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/contextual-survey",
-  "version": "2.1.3",
+  "version": "2.1.5",
   "description": "A React component used to ask the user for feedback",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -12,6 +12,13 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "dist/types-ts4.0/*"
+      ]
+    }
+  },
   "sideEffects": false,
   "atlaskit:src": "src/index.ts",
   "atlassian": {
@@ -28,7 +35,7 @@
     "@atlaskit/form": "^8.5.0",
     "@atlaskit/icon": "^21.10.0",
     "@atlaskit/textarea": "^4.3.0",
-    "@atlaskit/theme": "^12.1.0",
+    "@atlaskit/theme": "^12.2.0",
     "@atlaskit/tokens": "^0.10.0",
     "@atlaskit/tooltip": "^17.5.0",
     "@babel/runtime": "^7.0.0",
@@ -42,8 +49,8 @@
     "@atlaskit/checkbox": "^12.1.0",
     "@atlaskit/docs": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
-    "@testing-library/react": "^8.0.1",
-    "typescript": "4.2.4"
+    "@testing-library/react": "^12.1.5",
+    "typescript": "4.5.5"
   },
   "keywords": [
     "atlaskit",

package/report.api.md

@@ -0,0 +1,74 @@
+## API Report File for "@atlaskit/contextual-survey"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+<!--
+	Generated API Report version: 2.0
+-->
+
+[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+```ts
+/// <reference types="react" />
+
+import { ReactNode } from 'react';
+
+// @public (undocumented)
+export const ContextualSurvey: ({
+  question,
+  statement,
+  onDismiss,
+  onSubmit,
+  onMailingListAnswer,
+  getUserHasAnsweredMailingList,
+  textLabel,
+  textPlaceholder,
+}: Props) => JSX.Element;
+
+// @public (undocumented)
+export enum DismissTrigger {
+  // (undocumented)
+  AutoDismiss = 'AUTO_DISMISS',
+  // (undocumented)
+  Finished = 'FINISHED',
+  // (undocumented)
+  Manual = 'MANUAL',
+  // (undocumented)
+  Unmount = 'UNMOUNT',
+}
+
+// @public (undocumented)
+type FormValues = {
+  feedbackScore: number;
+  canContact: boolean;
+  writtenFeedback: string;
+};
+
+// @public (undocumented)
+export type OnDismissArgs = {
+  trigger: DismissTrigger;
+};
+
+// @public (undocumented)
+interface Props {
+  getUserHasAnsweredMailingList: () => Promise<boolean>;
+  onDismiss: (args: OnDismissArgs) => void;
+  onMailingListAnswer: (answer: boolean) => Promise<void>;
+  onSubmit: (formValues: FormValues) => Promise<void>;
+  question: string;
+  statement?: string;
+  textLabel?: string;
+  textPlaceholder?: string;
+}
+
+// @public (undocumented)
+type Props_2 = {
+  shouldShow: boolean;
+  children: () => ReactNode;
+};
+
+// @public (undocumented)
+export function SurveyMarshal(props: Props_2): JSX.Element;
+
+// (No @packageDocumentation comment for this package)
+```

package/types/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/types.js",
   "module:es2019": "../dist/es2019/types.js",
   "sideEffects": false,
-  "types": "../dist/types/types.d.ts"
+  "types": "../dist/types/types.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/types.d.ts"
+      ]
+    }
+  }
 }