@atlaskit/link-datasource 1.20.0 → 1.22.0

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

@@ -1,4 +1,4 @@
-import { DatasourceDataResponseItem, DatasourceParameters, DatasourceResponseSchemaProperty, DatasourceTableStatusType } from '@atlaskit/linking-types';
+import { DatasourceDataResponseItem, DatasourceMeta, DatasourceParameters, DatasourceResponseSchemaProperty, DatasourceTableStatusType } from '@atlaskit/linking-types';
 export interface onNextPageProps {
     isSchemaFromData?: boolean;
     shouldRequestFirstPage?: boolean;
@@ -34,6 +34,8 @@ export interface DatasourceTableState {
     destinationObjectTypes: string[];
     /** Used as an indicated of which provider type is being used - originates from ORS */
     extensionKey?: string;
+    /** Auth info used to connect to the provider account. */
+    authDetails?: DatasourceMeta['auth'];
 }
 export interface DatasourceTableStateProps {
     /** Unique identifier for which type of datasource is being rendered and for making its requests */

package/dist/types/index.d.ts

@@ -2,6 +2,7 @@ export { default as JiraIssuesConfigModal } from './ui/jira-issues-modal';
 export { default as AssetsConfigModal } from './ui/assets-modal';
 export { default as DatasourceTableView } from './ui/datasource-table-view';
 export { default as JSMAssetsConfigModal } from './ui/assets-modal';
+export { buildDatasourceAdf } from './common/utils/adf';
 export type { JiraIssuesDatasourceAdf, JiraIssueDatasourceParameters, } from './ui/jira-issues-modal/types';
 export type { AssetsDatasourceAdf, AssetsDatasourceParameters, } from './ui/assets-modal/types';
 export { JIRA_LIST_OF_LINKS_DATASOURCE_ID } from './ui/jira-issues-modal';

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

@@ -1,6 +1,6 @@
 import type { UIAnalyticsEvent } from '@atlaskit/analytics-next';
 import { DatasourceAdf, DatasourceAdfView, InlineCardAdf } from '@atlaskit/linking-common/types';
-export interface AssetsDatasourceParameters {
+export interface AssetsDatasourceParameters extends Record<string, unknown> {
     workspaceId: string;
     aql: string;
     schemaId: string;

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

@@ -54,4 +54,24 @@ export declare const loadingErrorMessages: {
         description: string;
         defaultMessage: string;
     };
+    authScreenHeaderText: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    authScreenDescriptionText: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    learnMoreAboutSmartLinks: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    authConnectButtonText: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
 };

package/dist/types/ui/common/error-state/provider-auth-required-svg.d.ts

@@ -0,0 +1,3 @@
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+export declare const ProviderAuthRequiredSVG: () => jsx.JSX.Element;

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

@@ -0,0 +1,9 @@
+import { jsx } from '@emotion/react';
+import { DatasourceMeta } from '@atlaskit/linking-types';
+interface ProviderAuthRequiredProps {
+    auth: DatasourceMeta['auth'];
+    onAuthSuccess: () => void;
+    onAuthError: () => void;
+}
+export declare const ProviderAuthRequired: ({ auth, onAuthSuccess, onAuthError, }: ProviderAuthRequiredProps) => jsx.JSX.Element;
+export {};

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

@@ -19,26 +19,7 @@ export interface Site {
     displayName: string;
     url: string;
 }
-export interface JiraIssuesDatasourceAdf extends DatasourceAdf {
-    attrs: {
-        url?: string;
-        datasource: {
-            id: string;
-            parameters: JiraIssueDatasourceParameters;
-            views: [
-                {
-                    type: 'table';
-                    properties?: {
-                        columns: {
-                            key: string;
-                            width?: number;
-                        }[];
-                    };
-                }
-            ];
-        };
-    };
-}
+export type JiraIssuesDatasourceAdf = DatasourceAdf<JiraIssueDatasourceParameters>;
 export interface JiraIssuesConfigModalProps {
     /** Unique identifier for which type of datasource is being rendered and for making its requests */
     datasourceId: string;

package/dist/types-ts4.5/common/utils/adf.d.ts

@@ -0,0 +1,2 @@
+import { Datasource, DatasourceAdf } from '@atlaskit/linking-common/types';
+export declare const buildDatasourceAdf: <P extends Record<string, unknown>>(datasource: Datasource<P>, url?: string) => DatasourceAdf<P>;

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

@@ -1,4 +1,4 @@
-import { DatasourceDataResponseItem, DatasourceParameters, DatasourceResponseSchemaProperty, DatasourceTableStatusType } from '@atlaskit/linking-types';
+import { DatasourceDataResponseItem, DatasourceMeta, DatasourceParameters, DatasourceResponseSchemaProperty, DatasourceTableStatusType } from '@atlaskit/linking-types';
 export interface onNextPageProps {
     isSchemaFromData?: boolean;
     shouldRequestFirstPage?: boolean;
@@ -34,6 +34,8 @@ export interface DatasourceTableState {
     destinationObjectTypes: string[];
     /** Used as an indicated of which provider type is being used - originates from ORS */
     extensionKey?: string;
+    /** Auth info used to connect to the provider account. */
+    authDetails?: DatasourceMeta['auth'];
 }
 export interface DatasourceTableStateProps {
     /** Unique identifier for which type of datasource is being rendered and for making its requests */

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

@@ -2,6 +2,7 @@ export { default as JiraIssuesConfigModal } from './ui/jira-issues-modal';
 export { default as AssetsConfigModal } from './ui/assets-modal';
 export { default as DatasourceTableView } from './ui/datasource-table-view';
 export { default as JSMAssetsConfigModal } from './ui/assets-modal';
+export { buildDatasourceAdf } from './common/utils/adf';
 export type { JiraIssuesDatasourceAdf, JiraIssueDatasourceParameters, } from './ui/jira-issues-modal/types';
 export type { AssetsDatasourceAdf, AssetsDatasourceParameters, } from './ui/assets-modal/types';
 export { JIRA_LIST_OF_LINKS_DATASOURCE_ID } from './ui/jira-issues-modal';

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

@@ -1,6 +1,6 @@
 import type { UIAnalyticsEvent } from '@atlaskit/analytics-next';
 import { DatasourceAdf, DatasourceAdfView, InlineCardAdf } from '@atlaskit/linking-common/types';
-export interface AssetsDatasourceParameters {
+export interface AssetsDatasourceParameters extends Record<string, unknown> {
     workspaceId: string;
     aql: string;
     schemaId: string;

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

@@ -54,4 +54,24 @@ export declare const loadingErrorMessages: {
         description: string;
         defaultMessage: string;
     };
+    authScreenHeaderText: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    authScreenDescriptionText: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    learnMoreAboutSmartLinks: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    authConnectButtonText: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
 };

package/dist/types-ts4.5/ui/common/error-state/provider-auth-required-svg.d.ts

@@ -0,0 +1,3 @@
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+export declare const ProviderAuthRequiredSVG: () => jsx.JSX.Element;

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

@@ -0,0 +1,9 @@
+import { jsx } from '@emotion/react';
+import { DatasourceMeta } from '@atlaskit/linking-types';
+interface ProviderAuthRequiredProps {
+    auth: DatasourceMeta['auth'];
+    onAuthSuccess: () => void;
+    onAuthError: () => void;
+}
+export declare const ProviderAuthRequired: ({ auth, onAuthSuccess, onAuthError, }: ProviderAuthRequiredProps) => jsx.JSX.Element;
+export {};

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

@@ -19,26 +19,7 @@ export interface Site {
     displayName: string;
     url: string;
 }
-export interface JiraIssuesDatasourceAdf extends DatasourceAdf {
-    attrs: {
-        url?: string;
-        datasource: {
-            id: string;
-            parameters: JiraIssueDatasourceParameters;
-            views: [
-                {
-                    type: 'table';
-                    properties?: {
-                        columns: {
-                            key: string;
-                            width?: number;
-                        }[];
-                    };
-                }
-            ];
-        };
-    };
-}
+export type JiraIssuesDatasourceAdf = DatasourceAdf<JiraIssueDatasourceParameters>;
 export interface JiraIssuesConfigModalProps {
     /** Unique identifier for which type of datasource is being rendered and for making its requests */
     datasourceId: string;

package/examples-helpers/buildJiraIssuesTable.tsx

@@ -1,24 +1,33 @@
-import React, { useCallback, useMemo, useState } from 'react';
+import React, { useCallback, useEffect, useMemo, useState } from 'react';
 
+import { IntlProvider } from 'react-intl-next';
+
+import { SmartCardProvider } from '@atlaskit/link-provider';
 import {
   defaultInitialVisibleColumnKeys,
   mockDatasourceFetchRequests,
 } from '@atlaskit/link-test-helpers/datasource';
+import { DatasourceParameters } from '@atlaskit/linking-types';
 
 import { DatasourceTableView } from '../src';
 import { ColumnSizesMap } from '../src/ui/issue-like-table/types';
 import { JiraIssueDatasourceParameters } from '../src/ui/jira-issues-modal/types';
 
-mockDatasourceFetchRequests();
+import SmartLinkClient from './smartLinkCustomClient';
+
+interface JiraIssuesTableViewProps {
+  parameters?: DatasourceParameters;
+  mockDatasourceFetchRequest?: boolean;
+}
 
-export const ExampleJiraIssuesTableView = () => {
-  const cloudId = 'some-cloud-id';
+const JiraIssuesTableView = ({ parameters }: JiraIssuesTableViewProps) => {
+  const cloudId = parameters?.cloudId || 'some-cloud-id';
 
   const [visibleColumnKeys, setVisibleColumnKeys] = useState<string[]>(
     defaultInitialVisibleColumnKeys,
   );
 
-  const parameters = useMemo<JiraIssueDatasourceParameters>(
+  const datasourceParameters = useMemo<JiraIssueDatasourceParameters>(
     () => ({
       cloudId,
       jql: 'some-jql',
@@ -42,7 +51,7 @@ export const ExampleJiraIssuesTableView = () => {
   return (
     <DatasourceTableView
       datasourceId={'some-datasource-id'}
-      parameters={parameters}
+      parameters={datasourceParameters}
       visibleColumnKeys={visibleColumnKeys}
       onVisibleColumnKeysChange={setVisibleColumnKeys}
       columnCustomSizes={columnCustomSizes}
@@ -50,3 +59,22 @@ export const ExampleJiraIssuesTableView = () => {
     />
   );
 };
+
+export const ExampleJiraIssuesTableView = ({
+  parameters,
+  mockDatasourceFetchRequest = true,
+}: JiraIssuesTableViewProps) => {
+  useEffect(() => {
+    if (mockDatasourceFetchRequest) {
+      mockDatasourceFetchRequests();
+    }
+  }, [mockDatasourceFetchRequest]);
+
+  return (
+    <IntlProvider locale="en">
+      <SmartCardProvider client={new SmartLinkClient()}>
+        <JiraIssuesTableView parameters={parameters} />
+      </SmartCardProvider>
+    </IntlProvider>
+  );
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/link-datasource",
-  "version": "1.20.0",
+  "version": "1.22.0",
   "description": "UI Components to support linking platform dataset feature",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -35,8 +35,8 @@
     "@atlaskit/avatar": "^21.4.0",
     "@atlaskit/avatar-group": "^9.5.0",
     "@atlaskit/badge": "^15.2.0",
-    "@atlaskit/button": "^17.2.0",
-    "@atlaskit/dropdown-menu": "^12.2.0",
+    "@atlaskit/button": "^17.3.0",
+    "@atlaskit/dropdown-menu": "^12.3.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
     "@atlaskit/empty-state": "^7.5.0",
     "@atlaskit/form": "^9.0.3",
@@ -53,6 +53,7 @@
     "@atlaskit/linking-types": "^8.6.0",
     "@atlaskit/lozenge": "^11.6.0",
     "@atlaskit/modal-dialog": "^12.10.0",
+    "@atlaskit/outbound-auth-flow-client": "^3.4.5",
     "@atlaskit/platform-feature-flags": "^0.2.4",
     "@atlaskit/pragmatic-drag-and-drop": "^0.25.0",
     "@atlaskit/pragmatic-drag-and-drop-hitbox": "^0.12.0",