@atlaskit/link-datasource 0.31.3 → 0.32.0

package/dist/esm/ui/jira-issues-modal/modal/index.js

@@ -1,16 +1,22 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _extends from "@babel/runtime/helpers/extends";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 /** @jsx jsx */
 import { useCallback, useEffect, useMemo, useState } from 'react';
 import { css, jsx } from '@emotion/react';
 import { FormattedMessage, FormattedNumber, useIntl } from 'react-intl-next';
+import { withAnalyticsContext } from '@atlaskit/analytics-next';
 import Button from '@atlaskit/button/standard-button';
 import Modal, { ModalBody, ModalFooter, ModalHeader, ModalTitle, ModalTransition } from '@atlaskit/modal-dialog';
 import { B400, N0, N40, N800 } from '@atlaskit/theme/colors';
+import { useDatasourceAnalyticsEvents } from '../../../analytics';
 import { useDatasourceTableState } from '../../../hooks/useDatasourceTableState';
 import { getAvailableJiraSites } from '../../../services/getAvailableJiraSites';
+import { name as packageName, version as packageVersion } from '../../../version.json';
 import { AccessRequired } from '../../common/error-state/access-required';
 import { ModalLoadingError } from '../../common/error-state/modal-loading-error';
 import { NoResults } from '../../common/error-state/no-results';
@@ -45,7 +51,7 @@ var issueCountStyles = css({
 var smartLinkContainerStyles = css({
   paddingLeft: '1px'
 });
-export var JiraIssuesConfigModal = function JiraIssuesConfigModal(props) {
+export var PlainJiraIssuesConfigModal = function PlainJiraIssuesConfigModal(props) {
   var datasourceId = props.datasourceId,
     initialParameters = props.parameters,
     initialVisibleColumnKeys = props.visibleColumnKeys,
@@ -94,6 +100,8 @@ export var JiraIssuesConfigModal = function JiraIssuesConfigModal(props) {
     totalCount = _useDatasourceTableSt.totalCount;
   var _useIntl = useIntl(),
     formatMessage = _useIntl.formatMessage;
+  var _useDatasourceAnalyti = useDatasourceAnalyticsEvents(),
+    fireEvent = _useDatasourceAnalyti.fireEvent;
   var selectedJiraSite = useMemo(function () {
     return availableSites.find(function (jiraSite) {
       return jiraSite.cloudId === cloudId;
@@ -103,6 +111,9 @@ export var JiraIssuesConfigModal = function JiraIssuesConfigModal(props) {
   var jqlUrl = selectedJiraSite && jql && "".concat(selectedJiraSite.url, "/issues/?jql=").concat(encodeURI(jql));
   var isInsertDisabled = !isParametersSet || status === 'rejected' || status === 'unauthorized' || status === 'loading' || resolvedWithNoResults;
   var shouldShowIssueCount = !!totalCount && totalCount !== 1 && currentViewMode === 'issue';
+  useEffect(function () {
+    fireEvent('screen.datasourceModalDialog.viewed', {});
+  }, [fireEvent]);
   useEffect(function () {
     var newVisibleColumnKeys = !initialVisibleColumnKeys || (initialVisibleColumnKeys || []).length === 0 ? defaultVisibleColumnKeys : initialVisibleColumnKeys;
     setVisibleColumnKeys(newVisibleColumnKeys);
@@ -119,7 +130,10 @@ export var JiraIssuesConfigModal = function JiraIssuesConfigModal(props) {
             case 2:
               jiraSites = _context.sent;
               setAvailableSites(jiraSites);
-            case 4:
+              fireEvent('ui.modal.ready.datasource', {
+                instancesCount: jiraSites.length
+              });
+            case 5:
             case "end":
               return _context.stop();
           }
@@ -130,7 +144,7 @@ export var JiraIssuesConfigModal = function JiraIssuesConfigModal(props) {
       };
     }();
     void fetchSiteDisplayNames();
-  }, []);
+  }, [fireEvent]);
   useEffect(function () {
     if (!cloudId && selectedJiraSite) {
       setCloudId(selectedJiraSite.cloudId);
@@ -315,4 +329,16 @@ export var JiraIssuesConfigModal = function JiraIssuesConfigModal(props) {
     isDisabled: isInsertDisabled,
     testId: 'jira-jql-datasource-modal--insert-button'
   }, jsx(FormattedMessage, modalMessages.insertIssuesButtonText)))));
-};
+};
+var analyticsContextAttributes = {
+  dataProvider: 'jira-issues'
+};
+var analyticsContextData = {
+  packageName: packageName,
+  packageVersion: packageVersion,
+  source: 'datasourceConfigModal'
+};
+var contextData = _objectSpread(_objectSpread({}, analyticsContextData), {}, {
+  attributes: _objectSpread({}, analyticsContextAttributes)
+});
+export var JiraIssuesConfigModal = withAnalyticsContext(contextData)(PlainJiraIssuesConfigModal);

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/link-datasource",
-	"version": "0.31.3",
+	"version": "0.32.0",
 	"sideEffects": false
 }

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

@@ -0,0 +1 @@
+export declare const EVENT_CHANNEL = "media";

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

@@ -0,0 +1,49 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Generates Typescript types for analytics events from analytics.spec.yaml
+ *
+ * @codegen <<SignedSource::75446f307933096c01c4784a1d7f2aa9>>
+ * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen link-datasource
+ */
+export type PackageMetaDataType = {
+    packageName: '@atlaskit/link-datasource';
+    packageVersion: string;
+};
+export type AnalyticsContextType = {
+    source: 'datasourceConfigModal' | 'datasourceConfluenceEditor';
+};
+export type AnalyticsContextAttributesType = {
+    dataProvider: 'jira-issues';
+};
+export type DatasourceModalDialogViewedAttributesType = {};
+export type ModalReadyDatasourceAttributesType = {
+    instancesCount: number;
+};
+export type JqlEditorSearchedAttributesType = {};
+export type FormSubmittedBasicSearchAttributesType = {};
+export type EmptyResultShownDatasourceAttributesType = {};
+export type ErrorShownAttributesType = {
+    reason: 'network' | 'access';
+};
+export type AnalyticsEventAttributes = {
+    /**
+     * Fires when user sees modal dialog. */
+    'screen.datasourceModalDialog.viewed': DatasourceModalDialogViewedAttributesType;
+    /**
+     * Fires when the datasource modal is ready for searching and displaying search results. */
+    'ui.modal.ready.datasource': ModalReadyDatasourceAttributesType;
+    /**
+     * Fires when search is initiated via the search icon or enter key press for jql editor input field. */
+    'ui.jqlEditor.searched': JqlEditorSearchedAttributesType;
+    /**
+     * Fires when search is initiated via the search icon or enter key press from the basic input textfield. */
+    'ui.form.submitted.basicSearch': FormSubmittedBasicSearchAttributesType;
+    /**
+     * Fires when datasource results are empty. */
+    'ui.emptyResult.shown.datasource': EmptyResultShownDatasourceAttributesType;
+    /**
+     * Fires when datasource errors state is shown. */
+    'ui.error.shown': ErrorShownAttributesType;
+};
+export type EventKey = keyof AnalyticsEventAttributes;

package/dist/types/analytics/generated/create-event-payload.d.ts

@@ -0,0 +1,27 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Generates Typescript types for analytics events from analytics.spec.yaml
+ *
+ * @codegen <<SignedSource::819168596ba17484cadda969f8ecf82d>>
+ * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen link-datasource
+ */
+import { AnalyticsEventAttributes, EventKey } from './analytics.types';
+type OptionalIfUndefined<T> = undefined extends T ? [param?: T] : [param: T];
+export type EventPayloadAttributes<K extends EventKey> = OptionalIfUndefined<AnalyticsEventAttributes[K]>;
+type EventTypes = 'ui' | 'track' | 'operational' | 'screen';
+type ScreenEventPayload<K extends EventKey> = {
+    eventType: 'screen';
+    name: string;
+    action: 'viewed';
+    attributes?: AnalyticsEventAttributes[K];
+};
+type EventPayload<K extends EventKey> = {
+    eventType: Omit<EventTypes, 'screen'>;
+    actionSubject: string;
+    action: string;
+    actionSubjectId?: string;
+    attributes?: AnalyticsEventAttributes[K];
+};
+declare const createEventPayload: <K extends keyof AnalyticsEventAttributes>(eventKey: K, ...[attributes]: OptionalIfUndefined<AnalyticsEventAttributes[K]>) => ScreenEventPayload<K> | EventPayload<K>;
+export default createEventPayload;

package/dist/types/analytics/generated/use-analytics-events.d.ts

@@ -0,0 +1,3 @@
+export declare const useAnalyticsEvents: () => {
+    fireEvent: <K extends keyof import("./analytics.types").AnalyticsEventAttributes>(params_0: K, ...params_1: undefined extends import("./analytics.types").AnalyticsEventAttributes[K] ? [param?: import("./analytics.types").AnalyticsEventAttributes[K] | undefined] : [param: import("./analytics.types").AnalyticsEventAttributes[K]]) => void;
+};

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

@@ -0,0 +1,4 @@
+export { EVENT_CHANNEL } from './constants';
+export declare const useDatasourceAnalyticsEvents: () => {
+    fireEvent: <K extends keyof import("./generated/analytics.types").AnalyticsEventAttributes>(params_0: K, ...params_1: undefined extends import("./generated/analytics.types").AnalyticsEventAttributes[K] ? [param?: import("./generated/analytics.types").AnalyticsEventAttributes[K] | undefined] : [param: import("./generated/analytics.types").AnalyticsEventAttributes[K]]) => void;
+};

package/dist/types/ui/common/error-state/access-required.d.ts

@@ -1,4 +1,3 @@
-/** @jsx jsx */
 import { jsx } from '@emotion/react';
 interface AccessRequiredProps {
     siteName?: string;

package/dist/types/ui/common/error-state/loading-error.d.ts

@@ -1,4 +1,3 @@
-/** @jsx jsx */
 import { jsx } from '@emotion/react';
 interface LoadingErrorProps {
     onRefresh?: () => void;

package/dist/types/ui/common/error-state/modal-loading-error.d.ts

@@ -1,4 +1,3 @@
-/** @jsx jsx */
 import { jsx } from '@emotion/react';
 interface ModalLoadingErrorProps {
     url?: string;

package/dist/types/ui/common/error-state/no-results.d.ts

@@ -1,4 +1,3 @@
-/** @jsx jsx */
 import { jsx } from '@emotion/react';
 interface NoResultsProps {
     onRefresh?: () => void;

package/dist/types/ui/jira-issues-modal/modal/index.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="react" />
 import { jsx } from '@emotion/react';
 import { JiraIssuesConfigModalProps } from '../types';
-export declare const JiraIssuesConfigModal: (props: JiraIssuesConfigModalProps) => jsx.JSX.Element;
+export declare const PlainJiraIssuesConfigModal: (props: JiraIssuesConfigModalProps) => jsx.JSX.Element;
+export declare const JiraIssuesConfigModal: import("react").ForwardRefExoticComponent<JiraIssuesConfigModalProps & import("@atlaskit/analytics-next").WithContextProps & import("react").RefAttributes<any>>;

package/dist/types-ts4.5/analytics/constants.d.ts

@@ -0,0 +1 @@
+export declare const EVENT_CHANNEL = "media";

package/dist/types-ts4.5/analytics/generated/analytics.types.d.ts

@@ -0,0 +1,49 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Generates Typescript types for analytics events from analytics.spec.yaml
+ *
+ * @codegen <<SignedSource::75446f307933096c01c4784a1d7f2aa9>>
+ * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen link-datasource
+ */
+export type PackageMetaDataType = {
+    packageName: '@atlaskit/link-datasource';
+    packageVersion: string;
+};
+export type AnalyticsContextType = {
+    source: 'datasourceConfigModal' | 'datasourceConfluenceEditor';
+};
+export type AnalyticsContextAttributesType = {
+    dataProvider: 'jira-issues';
+};
+export type DatasourceModalDialogViewedAttributesType = {};
+export type ModalReadyDatasourceAttributesType = {
+    instancesCount: number;
+};
+export type JqlEditorSearchedAttributesType = {};
+export type FormSubmittedBasicSearchAttributesType = {};
+export type EmptyResultShownDatasourceAttributesType = {};
+export type ErrorShownAttributesType = {
+    reason: 'network' | 'access';
+};
+export type AnalyticsEventAttributes = {
+    /**
+     * Fires when user sees modal dialog. */
+    'screen.datasourceModalDialog.viewed': DatasourceModalDialogViewedAttributesType;
+    /**
+     * Fires when the datasource modal is ready for searching and displaying search results. */
+    'ui.modal.ready.datasource': ModalReadyDatasourceAttributesType;
+    /**
+     * Fires when search is initiated via the search icon or enter key press for jql editor input field. */
+    'ui.jqlEditor.searched': JqlEditorSearchedAttributesType;
+    /**
+     * Fires when search is initiated via the search icon or enter key press from the basic input textfield. */
+    'ui.form.submitted.basicSearch': FormSubmittedBasicSearchAttributesType;
+    /**
+     * Fires when datasource results are empty. */
+    'ui.emptyResult.shown.datasource': EmptyResultShownDatasourceAttributesType;
+    /**
+     * Fires when datasource errors state is shown. */
+    'ui.error.shown': ErrorShownAttributesType;
+};
+export type EventKey = keyof AnalyticsEventAttributes;

package/dist/types-ts4.5/analytics/generated/create-event-payload.d.ts

@@ -0,0 +1,31 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Generates Typescript types for analytics events from analytics.spec.yaml
+ *
+ * @codegen <<SignedSource::819168596ba17484cadda969f8ecf82d>>
+ * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen link-datasource
+ */
+import { AnalyticsEventAttributes, EventKey } from './analytics.types';
+type OptionalIfUndefined<T> = undefined extends T ? [
+    param?: T
+] : [
+    param: T
+];
+export type EventPayloadAttributes<K extends EventKey> = OptionalIfUndefined<AnalyticsEventAttributes[K]>;
+type EventTypes = 'ui' | 'track' | 'operational' | 'screen';
+type ScreenEventPayload<K extends EventKey> = {
+    eventType: 'screen';
+    name: string;
+    action: 'viewed';
+    attributes?: AnalyticsEventAttributes[K];
+};
+type EventPayload<K extends EventKey> = {
+    eventType: Omit<EventTypes, 'screen'>;
+    actionSubject: string;
+    action: string;
+    actionSubjectId?: string;
+    attributes?: AnalyticsEventAttributes[K];
+};
+declare const createEventPayload: <K extends keyof AnalyticsEventAttributes>(eventKey: K, ...[attributes]: OptionalIfUndefined<AnalyticsEventAttributes[K]>) => ScreenEventPayload<K> | EventPayload<K>;
+export default createEventPayload;

package/dist/types-ts4.5/analytics/generated/use-analytics-events.d.ts

@@ -0,0 +1,7 @@
+export declare const useAnalyticsEvents: () => {
+    fireEvent: <K extends keyof import("./analytics.types").AnalyticsEventAttributes>(params_0: K, ...params_1: undefined extends import("./analytics.types").AnalyticsEventAttributes[K] ? [
+        param?: import("./analytics.types").AnalyticsEventAttributes[K] | undefined
+    ] : [
+        param: import("./analytics.types").AnalyticsEventAttributes[K]
+    ]) => void;
+};

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

@@ -0,0 +1,8 @@
+export { EVENT_CHANNEL } from './constants';
+export declare const useDatasourceAnalyticsEvents: () => {
+    fireEvent: <K extends keyof import("./generated/analytics.types").AnalyticsEventAttributes>(params_0: K, ...params_1: undefined extends import("./generated/analytics.types").AnalyticsEventAttributes[K] ? [
+        param?: import("./generated/analytics.types").AnalyticsEventAttributes[K] | undefined
+    ] : [
+        param: import("./generated/analytics.types").AnalyticsEventAttributes[K]
+    ]) => void;
+};

package/dist/types-ts4.5/ui/common/error-state/access-required.d.ts

@@ -1,4 +1,3 @@
-/** @jsx jsx */
 import { jsx } from '@emotion/react';
 interface AccessRequiredProps {
     siteName?: string;

package/dist/types-ts4.5/ui/common/error-state/loading-error.d.ts

@@ -1,4 +1,3 @@
-/** @jsx jsx */
 import { jsx } from '@emotion/react';
 interface LoadingErrorProps {
     onRefresh?: () => void;

package/dist/types-ts4.5/ui/common/error-state/modal-loading-error.d.ts

@@ -1,4 +1,3 @@
-/** @jsx jsx */
 import { jsx } from '@emotion/react';
 interface ModalLoadingErrorProps {
     url?: string;

package/dist/types-ts4.5/ui/common/error-state/no-results.d.ts

@@ -1,4 +1,3 @@
-/** @jsx jsx */
 import { jsx } from '@emotion/react';
 interface NoResultsProps {
     onRefresh?: () => void;

package/dist/types-ts4.5/ui/jira-issues-modal/modal/index.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="react" />
 import { jsx } from '@emotion/react';
 import { JiraIssuesConfigModalProps } from '../types';
-export declare const JiraIssuesConfigModal: (props: JiraIssuesConfigModalProps) => jsx.JSX.Element;
+export declare const PlainJiraIssuesConfigModal: (props: JiraIssuesConfigModalProps) => jsx.JSX.Element;
+export declare const JiraIssuesConfigModal: import("react").ForwardRefExoticComponent<JiraIssuesConfigModalProps & import("@atlaskit/analytics-next").WithContextProps & import("react").RefAttributes<any>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/link-datasource",
-  "version": "0.31.3",
+  "version": "0.32.0",
   "description": "UI Components to support linking platform dataset feature",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -26,7 +26,11 @@
     "inPublicMirror": false,
     "releaseModel": "continuous"
   },
+  "scripts": {
+    "analytics:codegen": "yarn workspace @atlassian/analytics-tooling run analytics:codegen link-datasource --output ./src/analytics/generated"
+  },
   "dependencies": {
+    "@atlaskit/analytics-next": "^9.1.3",
     "@atlaskit/avatar": "^21.3.0",
     "@atlaskit/button": "^16.8.0",
     "@atlaskit/dropdown-menu": "^11.11.0",
@@ -76,6 +80,7 @@
     "@testing-library/dom": "^8.17.1",
     "@testing-library/react": "^12.1.5",
     "@testing-library/react-hooks": "^8.0.1",
+    "@testing-library/user-event": "^14.4.3",
     "fetch-mock": "^8.0.0",
     "jest-fetch-mock": "^3.0.3",
     "json-ld-types": "3.8.0",