@atlaskit/link-datasource 1.10.3 → 1.11.0

package/dist/esm/ui/assets-modal/modal/render-assets-content/index.js

@@ -12,7 +12,8 @@ export var RenderAssetsContent = function RenderAssetsContent(props) {
     loadDatasourceDetails = props.loadDatasourceDetails,
     columns = props.columns,
     defaultVisibleColumnKeys = props.defaultVisibleColumnKeys,
-    onVisibleColumnKeysChange = props.onVisibleColumnKeysChange;
+    onVisibleColumnKeysChange = props.onVisibleColumnKeysChange,
+    modalRenderInstanceId = props.modalRenderInstanceId;
   var resolvedWithNoResults = status === 'resolved' && !responseItems.length;
   var issueLikeDataTableView = useMemo(function () {
     return /*#__PURE__*/React.createElement(IssueLikeDataTableView, {
@@ -24,9 +25,10 @@ export var RenderAssetsContent = function RenderAssetsContent(props) {
       visibleColumnKeys: visibleColumnKeys || defaultVisibleColumnKeys,
       onNextPage: onNextPage,
       onLoadDatasourceDetails: loadDatasourceDetails,
-      onVisibleColumnKeysChange: onVisibleColumnKeysChange
+      onVisibleColumnKeysChange: onVisibleColumnKeysChange,
+      parentContainerRenderInstanceId: modalRenderInstanceId
     });
-  }, [columns, defaultVisibleColumnKeys, hasNextPage, loadDatasourceDetails, onNextPage, onVisibleColumnKeysChange, responseItems, status, visibleColumnKeys]);
+  }, [columns, defaultVisibleColumnKeys, hasNextPage, loadDatasourceDetails, onNextPage, onVisibleColumnKeysChange, responseItems, status, visibleColumnKeys, modalRenderInstanceId]);
   if (status === 'rejected') {
     return /*#__PURE__*/React.createElement(ModalLoadingError, null);
   } else if (status === 'empty') {

package/dist/esm/ui/assets-modal/search-container/index.js

@@ -2,6 +2,7 @@ import _extends from "@babel/runtime/helpers/extends";
 /** @jsx jsx */
 import { jsx } from '@emotion/react';
 import Form from '@atlaskit/form';
+import { useDatasourceAnalyticsEvents } from '../../../analytics';
 import { AqlSearchInput } from './aql-search-input';
 import { AssetsObjectSchemaSelect } from './object-schema-select';
 import { FormContainer, FormRowContainer, SchemaSelectContainer } from './styled';
@@ -13,10 +14,13 @@ export var AssetsSearchContainer = function AssetsSearchContainer(props) {
     initialSearchData = props.initialSearchData,
     modalTitle = props.modalTitle,
     isSearching = props.isSearching;
+  var _useDatasourceAnalyti = useDatasourceAnalyticsEvents(),
+    fireEvent = _useDatasourceAnalyti.fireEvent;
   var onFormSubmit = function onFormSubmit(searchFormValues) {
     var aql = searchFormValues.aql,
       objectSchema = searchFormValues.objectSchema;
     if (objectSchema) {
+      fireEvent('ui.aqlEditor.searched', {});
       // Pass the validated aql and object schema back to modal
       onSearch(aql, objectSchema.value);
     }

package/dist/esm/ui/assets-modal/search-container/object-schema-select/index.js

@@ -1,6 +1,7 @@
 import _extends from "@babel/runtime/helpers/extends";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 var _excluded = ["onChange", "onFocus"];
 import _regeneratorRuntime from "@babel/runtime/regenerator";
@@ -8,18 +9,25 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 /** @jsx jsx */
 
+import { useEffect, useState } from 'react';
 import { jsx } from '@emotion/react';
 import debounce from 'debounce-promise';
 import { useIntl } from 'react-intl-next';
 import { Field } from '@atlaskit/form';
 import { AsyncSelect } from '@atlaskit/select';
 import { layers } from '@atlaskit/theme/constants';
+import { useDatasourceAnalyticsEvents } from '../../../../analytics';
 import { useObjectSchemas } from '../../../../hooks/useObjectSchemas';
 import { objectSchemaKey } from '../../../../types/assets/types';
 import { FieldContainer } from '../styled';
 import { objectSchemaSelectMessages } from './messages';
 import { objectSchemaToSelectOption } from './utils';
 export var SEARCH_DEBOUNCE_MS = 350;
+var mapObjectSchemasToOptions = function mapObjectSchemasToOptions(objectSchemas) {
+  return objectSchemas ? objectSchemas.map(function (objectSchema) {
+    return objectSchemaToSelectOption(objectSchema);
+  }) : [];
+};
 
 /**
  * Rendering a `<Select>` in a `<Modal>` results in the select options getting cut off by the bottom of the modal and
@@ -40,34 +48,72 @@ export var AssetsObjectSchemaSelect = function AssetsObjectSchemaSelect(_ref) {
     workspaceId = _ref.workspaceId,
     _ref$classNamePrefix = _ref.classNamePrefix,
     classNamePrefix = _ref$classNamePrefix === void 0 ? 'assets-datasource-modal--object-schema-select' : _ref$classNamePrefix;
+  var _useState = useState(null),
+    _useState2 = _slicedToArray(_useState, 2),
+    defaultOptions = _useState2[0],
+    setDefaultOptions = _useState2[1];
+  var _useDatasourceAnalyti = useDatasourceAnalyticsEvents(),
+    fireEvent = _useDatasourceAnalyti.fireEvent;
   var _useIntl = useIntl(),
     formatMessage = _useIntl.formatMessage;
   var _useObjectSchemas = useObjectSchemas(workspaceId),
     fetchObjectSchemas = _useObjectSchemas.fetchObjectSchemas,
     objectSchemasLoading = _useObjectSchemas.objectSchemasLoading;
   var selectedObjectSchema = value ? objectSchemaToSelectOption(value) : undefined;
+  useEffect(function () {
+    var fetchInitialData = /*#__PURE__*/function () {
+      var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
+        var _yield$fetchObjectSch, objectSchemas, totalObjectSchemas;
+        return _regeneratorRuntime.wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              _context.next = 2;
+              return fetchObjectSchemas('');
+            case 2:
+              _yield$fetchObjectSch = _context.sent;
+              objectSchemas = _yield$fetchObjectSch.objectSchemas;
+              totalObjectSchemas = _yield$fetchObjectSch.totalObjectSchemas;
+              // We only want to send modal ready event once after we've fetched the schema count
+              fireEvent('ui.modal.ready.datasource', {
+                schemasCount: totalObjectSchemas !== null && totalObjectSchemas !== void 0 ? totalObjectSchemas : 0,
+                instancesCount: null
+              });
+              setDefaultOptions(mapObjectSchemasToOptions(objectSchemas));
+            case 7:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee);
+      }));
+      return function fetchInitialData() {
+        return _ref2.apply(this, arguments);
+      };
+    }();
+    if (defaultOptions === null) {
+      fetchInitialData();
+    }
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
   var loadOptions = /*#__PURE__*/function () {
-    var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(inputValue) {
-      var objectSchemas, options;
-      return _regeneratorRuntime.wrap(function _callee$(_context) {
-        while (1) switch (_context.prev = _context.next) {
+    var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(inputValue) {
+      var _yield$fetchObjectSch2, objectSchemas;
+      return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+        while (1) switch (_context2.prev = _context2.next) {
           case 0:
-            _context.next = 2;
+            _context2.next = 2;
             return fetchObjectSchemas(inputValue);
           case 2:
-            objectSchemas = _context.sent;
-            options = objectSchemas ? objectSchemas.map(function (objectSchema) {
-              return objectSchemaToSelectOption(objectSchema);
-            }) : [];
-            return _context.abrupt("return", options);
+            _yield$fetchObjectSch2 = _context2.sent;
+            objectSchemas = _yield$fetchObjectSch2.objectSchemas;
+            return _context2.abrupt("return", mapObjectSchemasToOptions(objectSchemas));
           case 5:
           case "end":
-            return _context.stop();
+            return _context2.stop();
         }
-      }, _callee);
+      }, _callee2);
     }));
     return function loadOptions(_x) {
-      return _ref2.apply(this, arguments);
+      return _ref3.apply(this, arguments);
     };
   }();
   var debouncedLoadOptions = debounce(loadOptions, SEARCH_DEBOUNCE_MS);
@@ -83,17 +129,16 @@ export var AssetsObjectSchemaSelect = function AssetsObjectSchemaSelect(_ref) {
     validate: function validate(value) {
       return validateSchema(value);
     }
-  }, function (_ref3) {
-    var _ref3$fieldProps = _ref3.fieldProps,
-      _onChange = _ref3$fieldProps.onChange,
-      onFocus = _ref3$fieldProps.onFocus,
-      restFieldProps = _objectWithoutProperties(_ref3$fieldProps, _excluded);
+  }, function (_ref4) {
+    var _ref4$fieldProps = _ref4.fieldProps,
+      _onChange = _ref4$fieldProps.onChange,
+      onFocus = _ref4$fieldProps.onFocus,
+      restFieldProps = _objectWithoutProperties(_ref4$fieldProps, _excluded);
     return jsx(AsyncSelect, _extends({
       autoFocus: true,
       classNamePrefix: classNamePrefix,
       isLoading: objectSchemasLoading,
-      defaultOptions: true // setting to true causes the loadOptions to be called on mount
-      ,
+      defaultOptions: defaultOptions !== null && defaultOptions !== void 0 ? defaultOptions : [],
       isSearchable: true,
       loadOptions: debouncedLoadOptions,
       placeholder: formatMessage(objectSchemaSelectMessages.placeholder),

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

@@ -216,7 +216,8 @@ export var PlainJiraIssuesConfigModal = function PlainJiraIssuesConfigModal(prop
               });
               setAvailableSites(sortedAvailableSites);
               fireEvent('ui.modal.ready.datasource', {
-                instancesCount: sortedAvailableSites.length
+                instancesCount: sortedAvailableSites.length,
+                schemasCount: null
               });
             case 6:
             case "end":

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

@@ -3,7 +3,7 @@
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::24da75a4acd4c592c9cfed50e9897853>>
+ * @codegen <<SignedSource::7e783b41141644b6a0df41de5ab456df>>
  * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen link-datasource
  */
 export type PackageMetaDataType = {
@@ -18,7 +18,8 @@ export type AnalyticsContextAttributesType = {
 };
 export type DatasourceModalDialogViewedAttributesType = {};
 export type ModalReadyDatasourceAttributesType = {
-    instancesCount: number;
+    instancesCount: number | null;
+    schemasCount: number | null;
 };
 export type JqlEditorSearchedAttributesType = {};
 export type FormSubmittedBasicSearchAttributesType = {};
@@ -81,6 +82,7 @@ export type LinkViewedCountAttributesType = {
     totalItemCount: number;
     extensionKey: string | null;
 };
+export type AqlEditorSearchedAttributesType = {};
 export type AnalyticsEventAttributes = {
     /**
      * Fires when user sees modal dialog. */
@@ -130,5 +132,8 @@ export type AnalyticsEventAttributes = {
     /**
      * Fired when the datasource results are displayed as link( smart-link) in count mode. */
     'ui.link.viewed.count': LinkViewedCountAttributesType;
+    /**
+     * Fired when search is initiated via the search icon or enter key press for aql editor input field. */
+    'ui.aqlEditor.searched': AqlEditorSearchedAttributesType;
 };
 export type EventKey = keyof AnalyticsEventAttributes;

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

@@ -5,7 +5,8 @@ export declare enum DatasourceAction {
     INSTANCE_UPDATED = "instance updated",
     QUERY_UPDATED = "query updated",
     DISPLAY_VIEW_CHANGED = "display view changed",
-    NEXT_PAGE_SCROLLED = "next page scrolled"
+    NEXT_PAGE_SCROLLED = "next page scrolled",
+    SCHEMA_UPDATED = "schema updated"
 }
 export declare enum DatasourceDisplay {
     DATASOURCE_TABLE = "datasource_table",

package/dist/types/hooks/useObjectSchemas.d.ts

@@ -1,8 +1,10 @@
 import { ObjectSchema } from '../types/assets/types';
+export type FetchObjectSchemasDetails = Pick<UseObjectSchemasState, 'objectSchemas' | 'totalObjectSchemas'>;
 export type UseObjectSchemasState = {
     objectSchemasLoading: boolean;
     objectSchemasError: Error | undefined;
     objectSchemas: ObjectSchema[] | undefined;
-    fetchObjectSchemas: (query: string) => Promise<ObjectSchema[] | undefined>;
+    totalObjectSchemas: number | undefined;
+    fetchObjectSchemas: (query: string) => Promise<FetchObjectSchemasDetails>;
 };
 export declare const useObjectSchemas: (workspaceId: string) => UseObjectSchemasState;

package/dist/types/ui/assets-modal/modal/render-assets-content/index.d.ts

@@ -13,5 +13,6 @@ export interface RenderAssetsContentProps {
     columns: DatasourceResponseSchemaProperty[];
     defaultVisibleColumnKeys: string[];
     onVisibleColumnKeysChange: (visibleColumnKeys: string[]) => void;
+    modalRenderInstanceId: string;
 }
 export declare const RenderAssetsContent: (props: RenderAssetsContentProps) => JSX.Element;

package/dist/types/ui/assets-modal/search-container/index.d.ts

@@ -2,7 +2,7 @@
 /** @jsx jsx */
 import { jsx } from '@emotion/react';
 import type { ObjectSchema } from '../../../types/assets/types';
-type InitialSearchData = {
+export type InitialSearchData = {
     objectSchema?: ObjectSchema;
     aql?: string;
 };
@@ -14,4 +14,3 @@ export interface SearchContainerProps {
     isSearching: boolean;
 }
 export declare const AssetsSearchContainer: (props: SearchContainerProps) => jsx.JSX.Element;
-export {};

package/dist/types/ui/assets-modal/types.d.ts

@@ -1,3 +1,4 @@
+import type { UIAnalyticsEvent } from '@atlaskit/analytics-next';
 import { DatasourceAdf, DatasourceAdfView, InlineCardAdf } from '@atlaskit/linking-common/types';
 export interface AssetsDatasourceParameters {
     workspaceId: string;
@@ -19,5 +20,5 @@ export interface AssetsConfigModalProps {
     visibleColumnKeys?: string[];
     parameters?: AssetsDatasourceParameters;
     onCancel: () => void;
-    onInsert: (adf: InlineCardAdf | AssetsDatasourceAdf) => void;
+    onInsert: (adf: InlineCardAdf | AssetsDatasourceAdf, analyticsEvent?: UIAnalyticsEvent) => void;
 }

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

@@ -3,7 +3,7 @@
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::24da75a4acd4c592c9cfed50e9897853>>
+ * @codegen <<SignedSource::7e783b41141644b6a0df41de5ab456df>>
  * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen link-datasource
  */
 export type PackageMetaDataType = {
@@ -18,7 +18,8 @@ export type AnalyticsContextAttributesType = {
 };
 export type DatasourceModalDialogViewedAttributesType = {};
 export type ModalReadyDatasourceAttributesType = {
-    instancesCount: number;
+    instancesCount: number | null;
+    schemasCount: number | null;
 };
 export type JqlEditorSearchedAttributesType = {};
 export type FormSubmittedBasicSearchAttributesType = {};
@@ -81,6 +82,7 @@ export type LinkViewedCountAttributesType = {
     totalItemCount: number;
     extensionKey: string | null;
 };
+export type AqlEditorSearchedAttributesType = {};
 export type AnalyticsEventAttributes = {
     /**
      * Fires when user sees modal dialog. */
@@ -130,5 +132,8 @@ export type AnalyticsEventAttributes = {
     /**
      * Fired when the datasource results are displayed as link( smart-link) in count mode. */
     'ui.link.viewed.count': LinkViewedCountAttributesType;
+    /**
+     * Fired when search is initiated via the search icon or enter key press for aql editor input field. */
+    'ui.aqlEditor.searched': AqlEditorSearchedAttributesType;
 };
 export type EventKey = keyof AnalyticsEventAttributes;

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

@@ -5,7 +5,8 @@ export declare enum DatasourceAction {
     INSTANCE_UPDATED = "instance updated",
     QUERY_UPDATED = "query updated",
     DISPLAY_VIEW_CHANGED = "display view changed",
-    NEXT_PAGE_SCROLLED = "next page scrolled"
+    NEXT_PAGE_SCROLLED = "next page scrolled",
+    SCHEMA_UPDATED = "schema updated"
 }
 export declare enum DatasourceDisplay {
     DATASOURCE_TABLE = "datasource_table",

package/dist/types-ts4.5/hooks/useObjectSchemas.d.ts

@@ -1,8 +1,10 @@
 import { ObjectSchema } from '../types/assets/types';
+export type FetchObjectSchemasDetails = Pick<UseObjectSchemasState, 'objectSchemas' | 'totalObjectSchemas'>;
 export type UseObjectSchemasState = {
     objectSchemasLoading: boolean;
     objectSchemasError: Error | undefined;
     objectSchemas: ObjectSchema[] | undefined;
-    fetchObjectSchemas: (query: string) => Promise<ObjectSchema[] | undefined>;
+    totalObjectSchemas: number | undefined;
+    fetchObjectSchemas: (query: string) => Promise<FetchObjectSchemasDetails>;
 };
 export declare const useObjectSchemas: (workspaceId: string) => UseObjectSchemasState;

package/dist/types-ts4.5/ui/assets-modal/modal/render-assets-content/index.d.ts

@@ -13,5 +13,6 @@ export interface RenderAssetsContentProps {
     columns: DatasourceResponseSchemaProperty[];
     defaultVisibleColumnKeys: string[];
     onVisibleColumnKeysChange: (visibleColumnKeys: string[]) => void;
+    modalRenderInstanceId: string;
 }
 export declare const RenderAssetsContent: (props: RenderAssetsContentProps) => JSX.Element;

package/dist/types-ts4.5/ui/assets-modal/search-container/index.d.ts

@@ -2,7 +2,7 @@
 /** @jsx jsx */
 import { jsx } from '@emotion/react';
 import type { ObjectSchema } from '../../../types/assets/types';
-type InitialSearchData = {
+export type InitialSearchData = {
     objectSchema?: ObjectSchema;
     aql?: string;
 };
@@ -14,4 +14,3 @@ export interface SearchContainerProps {
     isSearching: boolean;
 }
 export declare const AssetsSearchContainer: (props: SearchContainerProps) => jsx.JSX.Element;
-export {};

package/dist/types-ts4.5/ui/assets-modal/types.d.ts

@@ -1,3 +1,4 @@
+import type { UIAnalyticsEvent } from '@atlaskit/analytics-next';
 import { DatasourceAdf, DatasourceAdfView, InlineCardAdf } from '@atlaskit/linking-common/types';
 export interface AssetsDatasourceParameters {
     workspaceId: string;
@@ -19,5 +20,5 @@ export interface AssetsConfigModalProps {
     visibleColumnKeys?: string[];
     parameters?: AssetsDatasourceParameters;
     onCancel: () => void;
-    onInsert: (adf: InlineCardAdf | AssetsDatasourceAdf) => void;
+    onInsert: (adf: InlineCardAdf | AssetsDatasourceAdf, analyticsEvent?: UIAnalyticsEvent) => void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/link-datasource",
-  "version": "1.10.3",
+  "version": "1.11.0",
   "description": "UI Components to support linking platform dataset feature",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/report.api.md

@@ -34,7 +34,10 @@ interface AssetsConfigModalProps {
   // (undocumented)
   onCancel: () => void;
   // (undocumented)
-  onInsert: (adf: AssetsDatasourceAdf | InlineCardAdf) => void;
+  onInsert: (
+    adf: AssetsDatasourceAdf | InlineCardAdf,
+    analyticsEvent?: UIAnalyticsEvent,
+  ) => void;
   // (undocumented)
   parameters?: AssetsDatasourceParameters;
   // (undocumented)

package/tmp/api-report-tmp.d.ts

@@ -22,7 +22,7 @@ interface AssetsConfigModalProps {
     // (undocumented)
     onCancel: () => void;
     // (undocumented)
-    onInsert: (adf: AssetsDatasourceAdf | InlineCardAdf) => void;
+    onInsert: (adf: AssetsDatasourceAdf | InlineCardAdf, analyticsEvent?: UIAnalyticsEvent) => void;
     // (undocumented)
     parameters?: AssetsDatasourceParameters;
     // (undocumented)