@atlaskit/link-picker 1.7.0 → 1.7.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/link-picker
 
+## 1.7.1
+
+### Patch Changes
+
+- [`e900714203d`](https://bitbucket.org/atlassian/atlassian-frontend/commits/e900714203d) - Add "form submitted" analytics event.
+
 ## 1.7.0
 
 ### Minor Changes

package/dist/cjs/analytics.codegen.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Generates analytics utilities from the package analytics spec yaml
+ *
+ * @codegen <<SignedSource::0cc1b4d9c22b31491ded3e581114ab2c>>
+ * @codegenCommand yarn workspace @atlaskit/link-picker run codegen-analytics
+ */
+function createEventPayload(eventKey, attributes) {
+  var event = eventKey.split('.');
+  return {
+    eventType: 'ui',
+    actionSubject: event[0],
+    action: event[1],
+    actionSubjectId: event[2],
+    attributes: attributes
+  };
+}
+
+var _default = createEventPayload;
+exports.default = _default;

package/dist/cjs/common/constants.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.COMPONENT_NAME = exports.ANALYTICS_CHANNEL = void 0;
+var ANALYTICS_CHANNEL = 'media';
+exports.ANALYTICS_CHANNEL = ANALYTICS_CHANNEL;
+var COMPONENT_NAME = 'LinkPicker';
+exports.COMPONENT_NAME = COMPONENT_NAME;

package/dist/cjs/ui/index.js

@@ -15,6 +15,8 @@ var _analyticsNext = require("@atlaskit/analytics-next");
 
 var _reactLooselyLazy = require("react-loosely-lazy");
 
+var _constants = require("../common/constants");
+
 var _version = require("../version.json");
 
 var _errorBoundaryFallback = require("./error-boundary-fallback");
@@ -25,12 +27,10 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
 
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || (0, _typeof2.default)(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
-var COMPONENT_NAME = 'LinkPicker';
-var ANALYTICS_CHANNEL = 'media';
 var PACKAGE_DATA = {
   packageName: _version.name,
   packageVersion: _version.version,
-  componentName: COMPONENT_NAME
+  componentName: _constants.COMPONENT_NAME
 };
 var LazyLinkPicker = (0, _reactLooselyLazy.lazyForPaint)(function () {
   return Promise.resolve().then(function () {
@@ -39,7 +39,7 @@ var LazyLinkPicker = (0, _reactLooselyLazy.lazyForPaint)(function () {
 });
 var ComposedLinkPicker = /*#__PURE__*/(0, _react.memo)(function (props) {
   return /*#__PURE__*/_react.default.createElement(_analyticsNext.AnalyticsErrorBoundary, {
-    channel: ANALYTICS_CHANNEL,
+    channel: _constants.ANALYTICS_CHANNEL,
     data: PACKAGE_DATA,
     ErrorComponent: _errorBoundaryFallback.ErrorBoundaryFallback
   }, /*#__PURE__*/_react.default.createElement(_reactLooselyLazy.LazySuspense, {

package/dist/cjs/ui/link-picker/index.js

@@ -21,6 +21,8 @@ var _react2 = require("@emotion/react");
 
 var _reactIntlNext = require("react-intl-next");
 
+var _analyticsNext = require("@atlaskit/analytics-next");
+
 var _button = _interopRequireWildcard(require("@atlaskit/button"));
 
 var _form = require("@atlaskit/form");
@@ -31,6 +33,10 @@ var _tabs = _interopRequireWildcard(require("@atlaskit/tabs"));
 
 var _visuallyHidden = _interopRequireDefault(require("@atlaskit/visually-hidden"));
 
+var _analytics = _interopRequireDefault(require("../../analytics.codegen"));
+
+var _constants = require("../../common/constants");
+
 var _usePlugins2 = require("../../services/use-plugins");
 
 var _useSearchQuery = require("../../services/use-search-query");
@@ -116,6 +122,9 @@ function LinkPicker(_ref) {
       initUrl = _ref.url,
       initDisplayText = _ref.displayText;
 
+  var _useAnalyticsEvents = (0, _analyticsNext.useAnalyticsEvents)(),
+      createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
+
   var _useReducer = (0, _react.useReducer)(reducer, _objectSpread(_objectSpread({}, initState), {}, {
     url: (0, _url2.normalizeUrl)(initUrl) || '',
     displayText: initDisplayText || ''
@@ -217,6 +226,8 @@ function LinkPicker(_ref) {
     }
   }, [activeIndex, items]);
   var handleInsert = (0, _react.useCallback)(function (url, title, inputType) {
+    var event = createAnalyticsEvent((0, _analytics.default)('form.submitted.linkPicker', {}));
+    event.fire(_constants.ANALYTICS_CHANNEL);
     onSubmit(_objectSpread({
       url: url,
       displayText: displayText || null,
@@ -227,7 +238,7 @@ function LinkPicker(_ref) {
     }, inputType === 'manual' ? {
       rawUrl: state.url
     } : {}));
-  }, [displayText, onSubmit, state.url]);
+  }, [displayText, onSubmit, state.url, createAnalyticsEvent]);
   var handleSelected = (0, _react.useCallback)(function (objectId) {
     var selectedItem = items === null || items === void 0 ? void 0 : items.find(function (item) {
       return item.objectId === objectId;

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/link-picker",
-	"version": "1.7.0",
+	"version": "1.7.1",
 	"sideEffects": false
 }

package/dist/es2019/analytics.codegen.js

@@ -0,0 +1,20 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Generates analytics utilities from the package analytics spec yaml
+ *
+ * @codegen <<SignedSource::0cc1b4d9c22b31491ded3e581114ab2c>>
+ * @codegenCommand yarn workspace @atlaskit/link-picker run codegen-analytics
+ */
+function createEventPayload(eventKey, attributes) {
+  const event = eventKey.split('.');
+  return {
+    eventType: 'ui',
+    actionSubject: event[0],
+    action: event[1],
+    actionSubjectId: event[2],
+    attributes: attributes
+  };
+}
+
+export default createEventPayload;

package/dist/es2019/common/constants.js

@@ -0,0 +1,2 @@
+export const ANALYTICS_CHANNEL = 'media';
+export const COMPONENT_NAME = 'LinkPicker';

package/dist/es2019/ui/index.js

@@ -1,11 +1,10 @@
 import React, { memo } from 'react';
 import { AnalyticsErrorBoundary } from '@atlaskit/analytics-next';
 import { LazySuspense, lazyForPaint } from 'react-loosely-lazy';
+import { COMPONENT_NAME, ANALYTICS_CHANNEL } from '../common/constants';
 import { name as packageName, version as packageVersion } from '../version.json';
 import { ErrorBoundaryFallback } from './error-boundary-fallback';
 import { LoaderFallback } from './loader-fallback';
-const COMPONENT_NAME = 'LinkPicker';
-const ANALYTICS_CHANNEL = 'media';
 const PACKAGE_DATA = {
   packageName,
   packageVersion,

package/dist/es2019/ui/link-picker/index.js

@@ -4,11 +4,14 @@ import _extends from "@babel/runtime/helpers/extends";
 import { Fragment, useCallback, useLayoutEffect, useReducer } from 'react';
 import { jsx } from '@emotion/react';
 import { useIntl, FormattedMessage } from 'react-intl-next';
+import { useAnalyticsEvents } from '@atlaskit/analytics-next';
 import Button, { ButtonGroup } from '@atlaskit/button';
 import { FormFooter } from '@atlaskit/form';
 import EditorSearchIcon from '@atlaskit/icon/glyph/editor/search';
 import Tabs, { Tab, TabList } from '@atlaskit/tabs';
 import VisuallyHidden from '@atlaskit/visually-hidden';
+import createEventPayload from '../../analytics.codegen';
+import { ANALYTICS_CHANNEL } from '../../common/constants';
 import { usePlugins } from '../../services/use-plugins';
 import { useSearchQuery } from '../../services/use-search-query';
 import { messages } from './messages';
@@ -74,6 +77,9 @@ function LinkPicker({
 }) {
   var _queryState$query, _items$length, _errorFallback;
 
+  const {
+    createAnalyticsEvent
+  } = useAnalyticsEvents();
   const [state, dispatch] = useReducer(reducer, { ...initState,
     url: normalizeUrl(initUrl) || '',
     displayText: initDisplayText || ''
@@ -172,6 +178,8 @@ function LinkPicker({
     }
   }, [activeIndex, items]);
   const handleInsert = useCallback((url, title, inputType) => {
+    const event = createAnalyticsEvent(createEventPayload('form.submitted.linkPicker', {}));
+    event.fire(ANALYTICS_CHANNEL);
     onSubmit({
       url,
       displayText: displayText || null,
@@ -183,7 +191,7 @@ function LinkPicker({
         rawUrl: state.url
       } : {})
     });
-  }, [displayText, onSubmit, state.url]);
+  }, [displayText, onSubmit, state.url, createAnalyticsEvent]);
   const handleSelected = useCallback(objectId => {
     const selectedItem = items === null || items === void 0 ? void 0 : items.find(item => item.objectId === objectId);
 

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/link-picker",
-	"version": "1.7.0",
+	"version": "1.7.1",
 	"sideEffects": false
 }

package/dist/esm/analytics.codegen.js

@@ -0,0 +1,20 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Generates analytics utilities from the package analytics spec yaml
+ *
+ * @codegen <<SignedSource::0cc1b4d9c22b31491ded3e581114ab2c>>
+ * @codegenCommand yarn workspace @atlaskit/link-picker run codegen-analytics
+ */
+function createEventPayload(eventKey, attributes) {
+  var event = eventKey.split('.');
+  return {
+    eventType: 'ui',
+    actionSubject: event[0],
+    action: event[1],
+    actionSubjectId: event[2],
+    attributes: attributes
+  };
+}
+
+export default createEventPayload;

package/dist/esm/common/constants.js

@@ -0,0 +1,2 @@
+export var ANALYTICS_CHANNEL = 'media';
+export var COMPONENT_NAME = 'LinkPicker';

package/dist/esm/ui/index.js

@@ -1,11 +1,10 @@
 import React, { memo } from 'react';
 import { AnalyticsErrorBoundary } from '@atlaskit/analytics-next';
 import { LazySuspense, lazyForPaint } from 'react-loosely-lazy';
+import { COMPONENT_NAME, ANALYTICS_CHANNEL } from '../common/constants';
 import { name as packageName, version as packageVersion } from '../version.json';
 import { ErrorBoundaryFallback } from './error-boundary-fallback';
 import { LoaderFallback } from './loader-fallback';
-var COMPONENT_NAME = 'LinkPicker';
-var ANALYTICS_CHANNEL = 'media';
 var PACKAGE_DATA = {
   packageName: packageName,
   packageVersion: packageVersion,

package/dist/esm/ui/link-picker/index.js

@@ -10,11 +10,14 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 import { Fragment, useCallback, useLayoutEffect, useReducer } from 'react';
 import { jsx } from '@emotion/react';
 import { useIntl, FormattedMessage } from 'react-intl-next';
+import { useAnalyticsEvents } from '@atlaskit/analytics-next';
 import Button, { ButtonGroup } from '@atlaskit/button';
 import { FormFooter } from '@atlaskit/form';
 import EditorSearchIcon from '@atlaskit/icon/glyph/editor/search';
 import Tabs, { Tab, TabList } from '@atlaskit/tabs';
 import VisuallyHidden from '@atlaskit/visually-hidden';
+import createEventPayload from '../../analytics.codegen';
+import { ANALYTICS_CHANNEL } from '../../common/constants';
 import { usePlugins } from '../../services/use-plugins';
 import { useSearchQuery } from '../../services/use-search-query';
 import { messages } from './messages';
@@ -77,6 +80,9 @@ function LinkPicker(_ref) {
       initUrl = _ref.url,
       initDisplayText = _ref.displayText;
 
+  var _useAnalyticsEvents = useAnalyticsEvents(),
+      createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
+
   var _useReducer = useReducer(reducer, _objectSpread(_objectSpread({}, initState), {}, {
     url: normalizeUrl(initUrl) || '',
     displayText: initDisplayText || ''
@@ -178,6 +184,8 @@ function LinkPicker(_ref) {
     }
   }, [activeIndex, items]);
   var handleInsert = useCallback(function (url, title, inputType) {
+    var event = createAnalyticsEvent(createEventPayload('form.submitted.linkPicker', {}));
+    event.fire(ANALYTICS_CHANNEL);
     onSubmit(_objectSpread({
       url: url,
       displayText: displayText || null,
@@ -188,7 +196,7 @@ function LinkPicker(_ref) {
     }, inputType === 'manual' ? {
       rawUrl: state.url
     } : {}));
-  }, [displayText, onSubmit, state.url]);
+  }, [displayText, onSubmit, state.url, createAnalyticsEvent]);
   var handleSelected = useCallback(function (objectId) {
     var selectedItem = items === null || items === void 0 ? void 0 : items.find(function (item) {
       return item.objectId === objectId;

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/link-picker",
-	"version": "1.7.0",
+	"version": "1.7.1",
 	"sideEffects": false
 }

package/dist/types/analytics.codegen.d.ts

@@ -0,0 +1,20 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Generates analytics utilities from the package analytics spec yaml
+ *
+ * @codegen <<SignedSource::0cc1b4d9c22b31491ded3e581114ab2c>>
+ * @codegenCommand yarn workspace @atlaskit/link-picker run codegen-analytics
+ */
+declare type FormSubmittedLinkPickerAttributesType = {};
+declare type AnalyticsEventAttributes = {
+    'form.submitted.linkPicker': FormSubmittedLinkPickerAttributesType;
+};
+declare function createEventPayload<K extends keyof AnalyticsEventAttributes>(eventKey: K, attributes: AnalyticsEventAttributes[K]): {
+    eventType: string;
+    actionSubject: string;
+    action: string;
+    actionSubjectId: string;
+    attributes: AnalyticsEventAttributes[K];
+};
+export default createEventPayload;

package/dist/types/common/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const ANALYTICS_CHANNEL = "media";
+export declare const COMPONENT_NAME = "LinkPicker";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/link-picker",
-  "version": "1.7.0",
+  "version": "1.7.1",
   "description": "Standalone link picker",
   "author": "Atlassian Pty Ltd",
   "publishConfig": {
@@ -26,7 +26,8 @@
     ".": "./src/index.ts"
   },
   "scripts": {
-    "ak-postbuild": "ls -d dist/* | grep -v dist/types | xargs -n 1 copyfiles -u 1 -V src/**/*.svg"
+    "ak-postbuild": "ls -d dist/* | grep -v dist/types | xargs -n 1 copyfiles -u 1 -V src/**/*.svg",
+    "codegen-analytics": "ts-node --project ../../../tsconfig.node.json ./scripts/build/codegen-analytics"
   },
   "dependencies": {
     "@atlaskit/analytics-next": "^8.3.1",
@@ -52,6 +53,7 @@
     "react-intl-next": "npm:react-intl@^5.18.1"
   },
   "devDependencies": {
+    "@af/codegen": "*",
     "@atlaskit/activity-provider": "^2.3.2",
     "@atlaskit/docs": "*",
     "@atlaskit/link-test-helpers": "^1.4.0",
@@ -63,15 +65,19 @@
     "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
     "@atlassian/link-picker-atlassian-plugin": "^17.0.0",
     "@atlassian/link-picker-plugins": "^4.0.0",
+    "@atlassian/recent-work-client": "^1.5.0",
     "@atlassian/search-provider": "^2.3.0",
     "@testing-library/dom": "^7.7.3",
     "@testing-library/jest-dom": "^4.1.0",
     "@testing-library/react": "^8.0.1",
     "@testing-library/react-hooks": "^1.0.4",
     "@testing-library/user-event": "10.4.0",
+    "@types/js-yaml": "^3.12.5",
     "enzyme": "^3.10.0",
     "fetch-mock": "^8.0.0",
+    "js-yaml": "^3.13.1",
     "mockdate": "^3.0.2",
+    "prettier": "^2.1.1",
     "react-dom": "^16.8.0",
     "sinon": "^2.2.0",
     "typescript": "4.2.4"