@atlaskit/feedback-collector 16.1.1 → 16.2.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/feedback-collector
 
+## 16.2.0
+
+### Minor Changes
+
+- [`84e6b9695a7ca`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/84e6b9695a7ca) -
+  Update i18n NPM package versions for discovery,navigation,web-platform,bitbucket,policy-platform
+  (Group 14)
+
+## 16.1.2
+
+### Patch Changes
+
+- [`309a7bd882781`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/309a7bd882781) -
+  Add a dialogRef prop for accessing the rendered feedback dialog container.
+
 ## 16.1.1
 
 ### Patch Changes

package/compass.yml

@@ -0,0 +1,38 @@
+configVersion: 1
+id: ari:cloud:compass:a436116f-02ce-4520-8fbb-7301462a1674:component/c5751cc6-3513-4070-9deb-af31e86aed34/fe21e46f-8b63-46b4-8cc3-129bb0608c8c
+name: '@atlaskit/feedback-collector'
+ownerId: ari:cloud:identity::team/03bf8f0a-185e-4feb-b203-cdac6446ed01 # Otter
+labels:
+  - platform-code
+  - platform-afm
+typeId: OTHER
+fields:
+  tier: 4
+  lifecycle: Active
+  isMonorepoProject: true
+links:
+  - name: Root Repository
+    type: REPOSITORY
+    url: https://bitbucket.org/atlassian/atlassian-frontend-monorepo/src/master
+  - name: Slack Channel
+    type: CHAT_CHANNEL
+    url: https://atlassian.enterprise.slack.com/archives/C07HSDQ3E9H # #help-allowances-platform
+  - name: Feedback Collector
+    type: REPOSITORY
+    url: https://bitbucket.org/atlassian/atlassian-frontend-monorepo/src/master/platform/packages/web-platform/feedback-collector
+customFields:
+  - name: Department
+    type: text
+    value: Eng - Otter - Platform Services
+  - name: Technical Owner
+    type: user
+    value: ari:cloud:identity::user/712020:e6c80c36-bd14-432b-8fbf-a1a1a6dd2ab0 # Ankush Maheshwari
+  - name: Required Reviewers Opt In
+    type: boolean
+    value: true
+  - name: Reviewer Selection Mechanism
+    type: text
+    value: random(2)
+  - name: Required Reviewer Approvals
+    type: number
+    value: 1

package/dist/cjs/components/FeedbackCollector.js

@@ -164,7 +164,7 @@ var FeedbackCollector = exports.default = /*#__PURE__*/function (_Component) {
   }, {
     key: "getPackageVersion",
     value: function getPackageVersion() {
-      return "16.1.0" || 'Unknown, at least 11.0.0';
+      return "16.1.2" || 'Unknown, at least 11.0.0';
     }
   }, {
     key: "getEntitlementInformation",
@@ -493,6 +493,7 @@ var FeedbackCollector = exports.default = /*#__PURE__*/function (_Component) {
         customTextAreaLabel: this.props.customTextAreaLabel,
         customFeedbackOptions: this.props.customFeedbackOptions,
         shouldReturnFocusRef: this.props.shouldReturnFocusRef,
+        dialogRef: this.props.dialogRef,
         disableSubmitButton: this.props.disableSubmitButton
       }, (0, _platformFeatureFlags.fg)('jfp_a11y_team_feedback_collector_nested_elements') && {
         enrolInResearchLink: this.props.enrolInResearchLink,

package/dist/cjs/components/FeedbackForm.js

@@ -65,6 +65,7 @@ var FeedbackForm = function FeedbackForm(_ref2) {
     _ref2$customFeedbackO = _ref2.customFeedbackOptions,
     customFeedbackOptions = _ref2$customFeedbackO === void 0 ? [] : _ref2$customFeedbackO,
     shouldReturnFocusRef = _ref2.shouldReturnFocusRef,
+    dialogRef = _ref2.dialogRef,
     disableSubmitButton = _ref2.disableSubmitButton,
     _ref2$showRequiredFie = _ref2.showRequiredFieldsSummary,
     showRequiredFieldsSummary = _ref2$showRequiredFie === void 0 ? true : _ref2$showRequiredFie;
@@ -180,6 +181,7 @@ var FeedbackForm = function FeedbackForm(_ref2) {
   // eslint-disable-next-line @atlaskit/design-system/use-primitives-text
   _react.default.createElement("p", null, formatMessage(_messages.messages.feedbackIsAnonymous));
   return /*#__PURE__*/_react.default.createElement(_modalDialog.default, {
+    ref: dialogRef,
     shouldCloseOnOverlayClick: false,
     onClose: onClose,
     testId: "feedbackCollectorModalDialog",

package/dist/es2019/components/FeedbackCollector.js

@@ -92,7 +92,7 @@ export default class FeedbackCollector extends Component {
     return FeedbackCollector.defaultProps.url;
   }
   getPackageVersion() {
-    return "16.1.0" || 'Unknown, at least 11.0.0';
+    return "16.1.2" || 'Unknown, at least 11.0.0';
   }
   async getEntitlementInformation() {
     var _entitlementDetails, _entitlementDetails2, _productName, _entitlement, _productEntitlement;
@@ -330,6 +330,7 @@ export default class FeedbackCollector extends Component {
       customTextAreaLabel: this.props.customTextAreaLabel,
       customFeedbackOptions: this.props.customFeedbackOptions,
       shouldReturnFocusRef: this.props.shouldReturnFocusRef,
+      dialogRef: this.props.dialogRef,
       disableSubmitButton: this.props.disableSubmitButton
     }, fg('jfp_a11y_team_feedback_collector_nested_elements') && {
       enrolInResearchLink: this.props.enrolInResearchLink,

package/dist/es2019/components/FeedbackForm.js

@@ -47,6 +47,7 @@ const FeedbackForm = ({
   customTextAreaLabel,
   customFeedbackOptions = [],
   shouldReturnFocusRef,
+  dialogRef,
   disableSubmitButton,
   showRequiredFieldsSummary = true
 }) => {
@@ -141,6 +142,7 @@ const FeedbackForm = ({
   // eslint-disable-next-line @atlaskit/design-system/use-primitives-text
   React.createElement("p", null, formatMessage(messages.feedbackIsAnonymous));
   return /*#__PURE__*/React.createElement(Modal, {
+    ref: dialogRef,
     shouldCloseOnOverlayClick: false,
     onClose: onClose,
     testId: "feedbackCollectorModalDialog",

package/dist/esm/components/FeedbackCollector.js

@@ -155,7 +155,7 @@ var FeedbackCollector = /*#__PURE__*/function (_Component) {
   }, {
     key: "getPackageVersion",
     value: function getPackageVersion() {
-      return "16.1.0" || 'Unknown, at least 11.0.0';
+      return "16.1.2" || 'Unknown, at least 11.0.0';
     }
   }, {
     key: "getEntitlementInformation",
@@ -484,6 +484,7 @@ var FeedbackCollector = /*#__PURE__*/function (_Component) {
         customTextAreaLabel: this.props.customTextAreaLabel,
         customFeedbackOptions: this.props.customFeedbackOptions,
         shouldReturnFocusRef: this.props.shouldReturnFocusRef,
+        dialogRef: this.props.dialogRef,
         disableSubmitButton: this.props.disableSubmitButton
       }, fg('jfp_a11y_team_feedback_collector_nested_elements') && {
         enrolInResearchLink: this.props.enrolInResearchLink,

package/dist/esm/components/FeedbackForm.js

@@ -56,6 +56,7 @@ var FeedbackForm = function FeedbackForm(_ref2) {
     _ref2$customFeedbackO = _ref2.customFeedbackOptions,
     customFeedbackOptions = _ref2$customFeedbackO === void 0 ? [] : _ref2$customFeedbackO,
     shouldReturnFocusRef = _ref2.shouldReturnFocusRef,
+    dialogRef = _ref2.dialogRef,
     disableSubmitButton = _ref2.disableSubmitButton,
     _ref2$showRequiredFie = _ref2.showRequiredFieldsSummary,
     showRequiredFieldsSummary = _ref2$showRequiredFie === void 0 ? true : _ref2$showRequiredFie;
@@ -171,6 +172,7 @@ var FeedbackForm = function FeedbackForm(_ref2) {
   // eslint-disable-next-line @atlaskit/design-system/use-primitives-text
   React.createElement("p", null, formatMessage(messages.feedbackIsAnonymous));
   return /*#__PURE__*/React.createElement(Modal, {
+    ref: dialogRef,
     shouldCloseOnOverlayClick: false,
     onClose: onClose,
     testId: "feedbackCollectorModalDialog",

package/dist/types/components/FeedbackCollector.d.ts

@@ -118,6 +118,8 @@ export interface Props {
     customFeedbackOptions?: OptionType[];
     /** Optional ref to return focus to after feedback form is closed */
     shouldReturnFocusRef?: React.RefObject<HTMLElement>;
+    /** Ref to the rendered feedback dialog container */
+    dialogRef?: React.RefObject<HTMLElement>;
     /** Disable submit button to allow custom content to handle validation */
     disableSubmitButton?: boolean;
     /** Optional to show or hide the required fields summary */

package/dist/types/components/FeedbackForm.d.ts

@@ -53,6 +53,8 @@ interface Props {
     customFeedbackOptions?: OptionType[];
     /** React Ref to focus on close */
     shouldReturnFocusRef?: React.RefObject<HTMLElement>;
+    /** Ref to the rendered feedback dialog container */
+    dialogRef?: React.RefObject<HTMLElement>;
     /** Disable submit button to allow custom content to handle validation */
     disableSubmitButton?: boolean;
     /** Optional to show or hide the required fields summary */

package/feedback-collector.docs.tsx

@@ -0,0 +1,74 @@
+/**
+ * Structured MCP docs for `@atlaskit/feedback-collector`.
+ */
+
+import path from 'path';
+
+import type { StructuredContentSource } from '@atlassian/structured-docs-types/types';
+
+import packageJson from './package.json';
+
+const packagePath = path.resolve(__dirname);
+
+const documentation: StructuredContentSource = {
+	package: {
+		package: '@atlaskit/feedback-collector',
+		packagePath,
+		packageJson,
+		overview:
+			'A component that collects feedback across Atlassian products. It provides a consistent way for users to submit feedback, including bug reports and feature requests.',
+	},
+	components: [
+		{
+			name: 'FeedbackCollector',
+			description: 'The main component for collecting user feedback.',
+			status: 'general-availability',
+			import: {
+				name: 'default',
+				package: '@atlaskit/feedback-collector',
+				type: 'default',
+				packagePath,
+				packageJson,
+			},
+			usageGuidelines: [
+				'Use `FeedbackCollector` to trigger a feedback form from your application.',
+				'Provide `onClose` and `onSubmit` handlers to manage the feedback flow.',
+			],
+			keywords: ['feedback', 'collector', 'atlassian'],
+			categories: ['web-platform'],
+			examples: [
+				{
+					name: 'Feedback collector',
+					description: 'Basic usage of FeedbackCollector.',
+					source: path.resolve(packagePath, './examples/02-feedback-collector.tsx'),
+				},
+			],
+		},
+		{
+			name: 'FeedbackButton',
+			description: 'A button component used to trigger the feedback collector.',
+			status: 'general-availability',
+			import: {
+				name: 'FeedbackButton',
+				package: '@atlaskit/feedback-collector',
+				type: 'named',
+				packagePath,
+				packageJson,
+			},
+			usageGuidelines: [
+				'Use `FeedbackButton` to provide a consistent trigger for the feedback collector.',
+			],
+			keywords: ['feedback', 'button', 'trigger'],
+			categories: ['web-platform'],
+			examples: [
+				{
+					name: 'Feedback button',
+					description: 'Basic usage of FeedbackButton.',
+					source: path.resolve(packagePath, './examples/03-feedback-button.tsx'),
+				},
+			],
+		},
+	],
+};
+
+export default documentation;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/feedback-collector",
-	"version": "16.1.1",
+	"version": "16.2.0",
 	"description": "A component that collects feedback across Atlassian products.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -24,20 +24,20 @@
 		"access": "public"
 	},
 	"dependencies": {
-		"@atlaskit/afm-i18n-platform-web-platform-feedback-collector": "2.161.0",
-		"@atlaskit/button": "^24.1.0",
-		"@atlaskit/checkbox": "^18.0.0",
-		"@atlaskit/flag": "^18.0.0",
-		"@atlaskit/form": "^16.0.0",
-		"@atlaskit/icon": "^36.0.0",
-		"@atlaskit/link": "^4.0.0",
-		"@atlaskit/modal-dialog": "^16.0.0",
+		"@atlaskit/afm-i18n-platform-web-platform-feedback-collector": "2.180.0",
+		"@atlaskit/button": "^24.3.0",
+		"@atlaskit/checkbox": "^18.1.0",
+		"@atlaskit/flag": "^18.1.0",
+		"@atlaskit/form": "^16.1.0",
+		"@atlaskit/icon": "^36.2.0",
+		"@atlaskit/link": "^4.1.0",
+		"@atlaskit/modal-dialog": "^16.1.0",
 		"@atlaskit/platform-feature-flags": "^2.0.0",
-		"@atlaskit/section-message": "^9.1.0",
-		"@atlaskit/select": "^22.1.0",
-		"@atlaskit/textarea": "^9.0.0",
-		"@atlaskit/tokens": "^15.0.0",
-		"@atlaskit/visually-hidden": "^4.0.0",
+		"@atlaskit/section-message": "^9.2.0",
+		"@atlaskit/select": "^22.3.0",
+		"@atlaskit/textarea": "^9.1.0",
+		"@atlaskit/tokens": "^15.4.0",
+		"@atlaskit/visually-hidden": "^4.1.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {