@atlaskit/link-datasource 0.15.1 → 0.16.1

package/examples-helpers/buildJiraIssuesTable.tsx

@@ -2,28 +2,26 @@ import React, { useMemo, useState } from 'react';
 
 import { mockDatasourceFetchRequests } from '@atlaskit/link-test-helpers/datasource';
 
-import { JiraIssuesTableView } from '../src/ui/jira-issues/tableView';
-import { JiraIssueDatasourceParameters } from '../src/ui/jira-issues/types';
+import { DatasourceTableView } from '../src/ui/datasourceTableView';
+import { JiraIssueDatasourceParameters } from '../src/ui/jira-issues-modal/types';
 
 mockDatasourceFetchRequests();
 
 export const ExampleJiraIssuesTableView = () => {
   const cloudId = 'some-cloud-id';
-  const parameterType = 'jql';
-  const parameterValue = 'some-jql';
 
   const [visibleColumnKeys, setVisibleColumnKeys] = useState<string[]>([]);
 
-  const parameters = useMemo<JiraIssueDatasourceParameters>(() => {
-    return {
+  const parameters = useMemo<JiraIssueDatasourceParameters>(
+    () => ({
       cloudId,
-      type: parameterType,
-      value: parameterValue,
-    };
-  }, [cloudId, parameterType, parameterValue]);
+      jql: 'some-jql',
+    }),
+    [cloudId],
+  );
 
   return (
-    <JiraIssuesTableView
+    <DatasourceTableView
       datasourceId={'some-datasource-id'}
       parameters={parameters}
       visibleColumnKeys={visibleColumnKeys}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/link-datasource",
-  "version": "0.15.1",
+  "version": "0.16.1",
   "description": "UI Components to support linking platform dataset feature",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -36,7 +36,7 @@
     "@atlaskit/image": "^1.1.0",
     "@atlaskit/link-client-extension": "^1.1.0",
     "@atlaskit/linking-common": "^2.12.0",
-    "@atlaskit/linking-types": "^1.6.0",
+    "@atlaskit/linking-types": "^2.0.0",
     "@atlaskit/lozenge": "^11.4.0",
     "@atlaskit/modal-dialog": "^12.5.0",
     "@atlaskit/pragmatic-drag-and-drop": "^0.18.0",
@@ -44,7 +44,7 @@
     "@atlaskit/pragmatic-drag-and-drop-hitbox": "^0.11.0",
     "@atlaskit/pragmatic-drag-and-drop-react-indicator": "^0.14.0",
     "@atlaskit/select": "^16.2.0",
-    "@atlaskit/smart-card": "^26.2.0",
+    "@atlaskit/smart-card": "^26.3.0",
     "@atlaskit/spinner": "^15.5.0",
     "@atlaskit/tag": "^11.5.0",
     "@atlaskit/textfield": "5.4.2",
@@ -66,7 +66,7 @@
     "@atlaskit/code": "^14.6.0",
     "@atlaskit/docs": "*",
     "@atlaskit/link-provider": "^1.6.0",
-    "@atlaskit/link-test-helpers": "^2.4.0",
+    "@atlaskit/link-test-helpers": "^3.0.0",
     "@atlaskit/ssr": "*",
     "@atlaskit/visual-regression": "*",
     "@atlaskit/webdriver-runner": "*",

package/report.api.md

@@ -20,17 +20,41 @@ import { InlineCardAdf } from '@atlaskit/linking-common/types';
 import { jsx } from '@emotion/react';
 
 // @public (undocumented)
-interface JiraIssueDatasourceParameters {
+export const DatasourceTableView: ({
+  datasourceId,
+  parameters,
+  visibleColumnKeys,
+  onVisibleColumnKeysChange,
+}: DatasourceTableViewProps) => jsx.JSX.Element;
+
+// @public (undocumented)
+interface DatasourceTableViewProps {
   // (undocumented)
-  cloudId: string;
+  datasourceId: string;
   // (undocumented)
-  type: JiraIssueDatasourceParameterType;
+  fields?: string[];
+  // (undocumented)
+  onVisibleColumnKeysChange?: (visibleColumnKeys: string[]) => void;
+  // (undocumented)
+  parameters: object;
   // (undocumented)
-  value: string;
+  visibleColumnKeys?: string[];
 }
 
 // @public (undocumented)
-type JiraIssueDatasourceParameterType = 'filter' | 'jql' | 'textQuery';
+type JiraIssueDatasourceParameters = {
+  cloudId: string;
+} & JiraIssueDatasourceParametersQuery;
+
+// @public (undocumented)
+type JiraIssueDatasourceParametersQuery = XOR<
+  {
+    jql: string;
+  },
+  {
+    filter: string;
+  }
+>;
 
 // @public (undocumented)
 export const JiraIssuesConfigModal: (
@@ -58,26 +82,13 @@ interface JiraIssuesConfigModalProps {
 }
 
 // @public (undocumented)
-export const JiraIssuesTableView: ({
-  datasourceId,
-  parameters,
-  visibleColumnKeys,
-  onVisibleColumnKeysChange,
-}: JiraIssuesTableViewProps) => jsx.JSX.Element;
-
-// @public (undocumented)
-interface JiraIssuesTableViewProps {
-  // (undocumented)
-  datasourceId: string;
-  // (undocumented)
-  fields?: string[];
-  // (undocumented)
-  onVisibleColumnKeysChange?: (visibleColumnKeys: string[]) => void;
-  // (undocumented)
-  parameters: JiraIssueDatasourceParameters;
-  // (undocumented)
-  visibleColumnKeys?: string[];
-}
+type XOR<T1, T2> =
+  | (T1 & {
+      [k in Exclude<keyof T2, keyof T1>]?: never;
+    })
+  | (T2 & {
+      [k in Exclude<keyof T1, keyof T2>]?: never;
+    });
 
 // (No @packageDocumentation comment for this package)
 ```

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

@@ -9,17 +9,33 @@ import { InlineCardAdf } from '@atlaskit/linking-common/types';
 import { jsx } from '@emotion/react';
 
 // @public (undocumented)
-interface JiraIssueDatasourceParameters {
+export const DatasourceTableView: ({ datasourceId, parameters, visibleColumnKeys, onVisibleColumnKeysChange, }: DatasourceTableViewProps) => jsx.JSX.Element;
+
+// @public (undocumented)
+interface DatasourceTableViewProps {
     // (undocumented)
-    cloudId: string;
+    datasourceId: string;
+    // (undocumented)
+    fields?: string[];
     // (undocumented)
-    type: JiraIssueDatasourceParameterType;
+    onVisibleColumnKeysChange?: (visibleColumnKeys: string[]) => void;
+    // (undocumented)
+    parameters: object;
     // (undocumented)
-    value: string;
+    visibleColumnKeys?: string[];
 }
 
 // @public (undocumented)
-type JiraIssueDatasourceParameterType = 'filter' | 'jql' | 'textQuery';
+type JiraIssueDatasourceParameters = {
+    cloudId: string;
+} & JiraIssueDatasourceParametersQuery;
+
+// @public (undocumented)
+type JiraIssueDatasourceParametersQuery = XOR<{
+    jql: string;
+}, {
+    filter: string;
+}>;
 
 // @public (undocumented)
 export const JiraIssuesConfigModal: (props: JiraIssuesConfigModalProps) => jsx.JSX.Element;
@@ -43,21 +59,11 @@ interface JiraIssuesConfigModalProps {
 }
 
 // @public (undocumented)
-export const JiraIssuesTableView: ({ datasourceId, parameters, visibleColumnKeys, onVisibleColumnKeysChange, }: JiraIssuesTableViewProps) => jsx.JSX.Element;
-
-// @public (undocumented)
-interface JiraIssuesTableViewProps {
-    // (undocumented)
-    datasourceId: string;
-    // (undocumented)
-    fields?: string[];
-    // (undocumented)
-    onVisibleColumnKeysChange?: (visibleColumnKeys: string[]) => void;
-    // (undocumented)
-    parameters: JiraIssueDatasourceParameters;
-    // (undocumented)
-    visibleColumnKeys?: string[];
-}
+type XOR<T1, T2> = (T1 & {
+    [k in Exclude<keyof T2, keyof T1>]?: never;
+}) | (T2 & {
+    [k in Exclude<keyof T1, keyof T2>]?: never;
+});
 
 // (No @packageDocumentation comment for this package)
 

package/dist/types/ui/jira-issues/tableView.d.ts

@@ -1,3 +0,0 @@
-import { jsx } from '@emotion/react';
-import { JiraIssuesTableViewProps } from './types';
-export declare const JiraIssuesTableView: ({ datasourceId, parameters, visibleColumnKeys, onVisibleColumnKeysChange, }: JiraIssuesTableViewProps) => jsx.JSX.Element;

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

@@ -1,14 +0,0 @@
-export interface JiraIssuesTableViewProps {
-    datasourceId: string;
-    parameters: JiraIssueDatasourceParameters;
-    fields?: string[];
-    onVisibleColumnKeysChange?: (visibleColumnKeys: string[]) => void;
-    visibleColumnKeys?: string[];
-}
-export type JiraIssueDatasourceParameterType = 'jql' | 'textQuery' | 'filter';
-export interface JiraIssueDatasourceParameters {
-    cloudId: string;
-    value: string;
-    type: JiraIssueDatasourceParameterType;
-}
-export type JiraIssueViewModes = 'issue' | 'count';

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

@@ -1,3 +0,0 @@
-import { jsx } from '@emotion/react';
-import { JiraIssuesTableViewProps } from './types';
-export declare const JiraIssuesTableView: ({ datasourceId, parameters, visibleColumnKeys, onVisibleColumnKeysChange, }: JiraIssuesTableViewProps) => jsx.JSX.Element;

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

@@ -1,14 +0,0 @@
-export interface JiraIssuesTableViewProps {
-    datasourceId: string;
-    parameters: JiraIssueDatasourceParameters;
-    fields?: string[];
-    onVisibleColumnKeysChange?: (visibleColumnKeys: string[]) => void;
-    visibleColumnKeys?: string[];
-}
-export type JiraIssueDatasourceParameterType = 'jql' | 'textQuery' | 'filter';
-export interface JiraIssueDatasourceParameters {
-    cloudId: string;
-    value: string;
-    type: JiraIssueDatasourceParameterType;
-}
-export type JiraIssueViewModes = 'issue' | 'count';