@atlaskit/link-datasource 0.14.4

package/examples-helpers/setupDatasourcesMocks.ts

@@ -0,0 +1,199 @@
+import fetchMock from 'fetch-mock/cjs/client';
+
+import {
+  DatasourceDataResponseItem,
+  DatasourceResponseSchemaProperty,
+  IconType,
+  LinkType,
+  StatusType,
+  StringType,
+  TagType,
+  UserType,
+} from '@atlaskit/linking-types';
+
+import { mockJiraData } from './mockJiraData';
+
+const columns: DatasourceResponseSchemaProperty[] = [
+  {
+    key: 'id',
+    title: '',
+    type: 'string',
+    isIdentity: true,
+  },
+  {
+    key: 'key',
+    title: 'Key',
+    type: 'link',
+  },
+  {
+    key: 'type',
+    type: 'icon',
+    title: 'Type',
+  },
+  {
+    key: 'summary',
+    title: 'Summary',
+    type: 'link',
+  },
+  {
+    key: 'assignee',
+    title: 'Assignee',
+    type: 'user',
+  },
+  {
+    key: 'priority',
+    title: 'P',
+    type: 'icon',
+  },
+  {
+    key: 'labels',
+    title: 'Labels',
+    type: 'tag',
+    isList: true,
+  },
+  {
+    key: 'status',
+    title: 'Status',
+    type: 'status',
+  },
+  {
+    key: 'created',
+    title: 'Created',
+    type: 'string',
+  },
+  {
+    key: 'due',
+    title: 'Due Date',
+    type: 'string',
+  },
+  ...new Array<DatasourceResponseSchemaProperty>(100)
+    .fill({
+      key: 'due',
+      title: 'Due Date',
+      type: 'string',
+    })
+    .map((prop, i) => ({ ...prop, key: prop.key + i, title: prop.title + i })),
+];
+
+const initialVisibleColumnKeys: string[] = [
+  // Order of actual columns is in different order is on purpose
+  // To demonstrate that this list is a king
+  'type',
+  'key',
+  'summary',
+  'assignee',
+  'priority',
+  'labels',
+  'status',
+  'created',
+];
+
+export const MOCK_DATASOURCE_ID = 'some-datasource-id';
+
+interface FetchMockRequestDetails {
+  body: string;
+  credentials: string;
+  headers: object;
+  method: string;
+}
+
+export const setupDatasourcesMocks = (
+  datasourceId: string = MOCK_DATASOURCE_ID,
+) => {
+  fetchMock.post(
+    `/gateway/api/object-resolver/datasource/${datasourceId}/fetch/details`,
+    async () =>
+      new Promise(resolve => {
+        setTimeout(() => {
+          resolve({
+            ari: 'ari:cloud:linking-platform:datasource/12e74246-a3f1-46c1-9fd9-8d952aa9f12f',
+            id: '12e74246-a3f1-46c1-9fd9-8d952aa9f12f',
+            name: 'JQL Datasource',
+            description: 'Fetches Issues using JQL',
+            parameters: [
+              {
+                key: 'cloudId',
+                type: 'string',
+                description: 'Cloud Id',
+              },
+              {
+                key: 'jql',
+                type: 'string',
+                description: 'JQL query to retrieve list of issues',
+              },
+            ],
+            schema: {
+              properties: columns,
+              defaultProperties: initialVisibleColumnKeys,
+            },
+          });
+        }, 300);
+      }),
+  );
+
+  let numberOfLoads = 0;
+  const getItems = (cloudId: string = '', maxItems = 99) => ({
+    data: mockJiraData.data
+      .slice(0, maxItems)
+      .map((item): DatasourceDataResponseItem => {
+        return {
+          // Fake identifier attribute that needs to be flat primitive value.
+          // Adding number of pages to make all issueNumbers unique
+          id: (item.issueNumber + numberOfLoads) as StringType['value'],
+          type: {
+            source: item.type.source,
+            label: item.type.label,
+          } as IconType['value'],
+          key: {
+            url: item.link,
+            text: item.issueNumber + numberOfLoads,
+            linkType: 'key',
+          } as LinkType['value'],
+          summary: {
+            url: item.link,
+            text: `[${cloudId}] ${item.summary}`,
+          } as LinkType['value'],
+          assignee: {
+            displayName: item.assignee?.displayName,
+            avatarSource: item.assignee?.source,
+          } as UserType['value'],
+          priority: {
+            source: item.priority.source,
+            label: item.priority.label,
+          } as IconType['value'],
+          status: {
+            text: item.status.text,
+            status: item.status.status,
+          } as StatusType['value'],
+          created: item.created as StringType['value'],
+          due: item.due as StringType['value'],
+          labels: item.labels as TagType['value'][],
+        };
+      }),
+    totalIssues: mockJiraData.totalIssues,
+    nextPageCursor:
+      numberOfLoads < 4 && maxItems > 1 ? 'c3RhcnRBdD01' : undefined,
+  });
+
+  fetchMock.post(
+    `/gateway/api/object-resolver/datasource/${datasourceId}/fetch/data`,
+    async (url: string, details: FetchMockRequestDetails) => {
+      const requestBody = JSON.parse(details.body);
+      const {
+        parameters: { cloudId },
+      } = requestBody;
+      return new Promise(resolve => {
+        setTimeout(() => {
+          // special case to return only one item to show smart-card rendering path
+          if (cloudId === '11111') {
+            resolve(getItems(cloudId, 1));
+            return;
+          }
+          resolve(getItems(cloudId));
+        }, numberOfLoads++ * 1000);
+      });
+    },
+  );
+};
+
+setupDatasourcesMocks();

package/examples-helpers/setupModalExampleMocks.ts

@@ -0,0 +1,32 @@
+import fetchMock from 'fetch-mock/cjs/client';
+
+import { mockAutoCompleteData } from './mockAutocompleteData';
+import { mockSiteData } from './mockJiraAvailableSites';
+import { mockSuggestionData } from './mockSuggestionData';
+
+export const setupModalExampleMocks = () => {
+  fetchMock.mock('/gateway/api/available-sites', async () =>
+    Promise.resolve({ sites: mockSiteData }),
+  );
+
+  // /gateway/api/ex/jira/:cloudId//rest/api/latest/jql/autocompletedata
+  fetchMock.mock(
+    /\/gateway\/api\/ex\/jira\/.+\/\/rest\/api\/latest\/jql\/autocompletedata/g,
+    async () =>
+      new Promise(resolve => {
+        setTimeout(() => resolve(mockAutoCompleteData), 150);
+      }),
+  );
+
+  // /gateway/api/ex/jira/:cloudId//rest/api/latest/jql/autocompletedata/suggestions?fieldName=:fieldName&fieldValue=:fieldValue
+  fetchMock.mock(
+    /\/gateway\/api\/ex\/jira\/.+\/\/rest\/api\/latest\/jql\/autocompletedata\/suggestions\?.+/g,
+    async () =>
+      new Promise(resolve => {
+        setTimeout(() => resolve(mockSuggestionData), 150);
+      }),
+  );
+};
+
+// Calling it on module level once for any number of imports
+setupModalExampleMocks();

package/examples-helpers/smartLinkCustomClient.ts

@@ -0,0 +1,26 @@
+import { JsonLd } from 'json-ld-types';
+
+import { CardClient } from '@atlaskit/link-provider';
+
+import { mockJqlSmartLinkData } from './mockJqlSmartLinkData';
+import { mocks } from './mockSmartLinkData';
+
+const jqlUrlRegExp = /.+[jql=].+/;
+
+class SmartLinkClient extends CardClient {
+  fetchData(url: string): Promise<JsonLd.Response> {
+    switch (url) {
+      case 'https://product-fabric.atlassian.net/browse/EDM-5941':
+      case 'https://product-fabric.atlassian.net/browse/EDM-5591':
+        return Promise.resolve(mocks.resolved);
+      case 'https://link-that-does-not-resolve.com':
+        return Promise.reject(`Can't resolve from ${url}`);
+      case jqlUrlRegExp.test(url) ? url : undefined:
+        return Promise.resolve(mockJqlSmartLinkData.resolved);
+      default:
+        return Promise.resolve(mocks.unauthorized);
+    }
+  }
+}
+
+export default SmartLinkClient;

package/package.json

@@ -0,0 +1,118 @@
+{
+  "name": "@atlaskit/link-datasource",
+  "version": "0.14.4",
+  "description": "UI Components to support linking platform dataset feature",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
+  "author": "Atlassian Pty Ltd",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "module:es2019": "dist/es2019/index.js",
+  "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "dist/types-ts4.5/*",
+        "dist/types-ts4.5/index.d.ts"
+      ]
+    }
+  },
+  "sideEffects": false,
+  "atlaskit:src": "src/index.ts",
+  "atlassian": {
+    "team": "Linking Platform",
+    "inPublicMirror": false,
+    "releaseModel": "continuous"
+  },
+  "dependencies": {
+    "@atlaskit/avatar": "^21.3.0",
+    "@atlaskit/button": "^16.7.0",
+    "@atlaskit/dropdown-menu": "^11.9.0",
+    "@atlaskit/heading": "^1.3.0",
+    "@atlaskit/icon": "^21.12.0",
+    "@atlaskit/icon-object": "^6.3.0",
+    "@atlaskit/image": "^1.1.0",
+    "@atlaskit/link-client-extension": "^1.1.0",
+    "@atlaskit/linking-common": "^2.10.0",
+    "@atlaskit/linking-types": "^1.6.0",
+    "@atlaskit/lozenge": "^11.4.0",
+    "@atlaskit/modal-dialog": "^12.5.0",
+    "@atlaskit/pragmatic-drag-and-drop": "^0.18.0",
+    "@atlaskit/pragmatic-drag-and-drop-autoscroll": "^0.5.0",
+    "@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.1.0",
+    "@atlaskit/spinner": "^15.5.0",
+    "@atlaskit/tag": "^11.5.0",
+    "@atlaskit/textfield": "5.4.2",
+    "@atlaskit/theme": "^12.5.0",
+    "@atlaskit/tokens": "^1.4.0",
+    "@atlassianlabs/jql-editor": "^1.2.0",
+    "@atlassianlabs/jql-editor-autocomplete-rest": "^1.0.1",
+    "@babel/runtime": "^7.0.0",
+    "@emotion/react": "^11.7.1",
+    "@emotion/styled": "^11.0.0",
+    "react-error-boundary": "^3.1.3",
+    "tiny-invariant": "^1.2.0"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0",
+    "react-intl-next": "npm:react-intl@^5.18.1"
+  },
+  "devDependencies": {
+    "@atlaskit/code": "^14.6.0",
+    "@atlaskit/docs": "*",
+    "@atlaskit/link-provider": "^1.6.0",
+    "@atlaskit/link-test-helpers": "^2.3.0",
+    "@atlaskit/ssr": "*",
+    "@atlaskit/visual-regression": "*",
+    "@atlaskit/webdriver-runner": "*",
+    "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
+    "@testing-library/dom": "^8.17.1",
+    "@testing-library/react": "^12.1.5",
+    "@testing-library/react-hooks": "^8.0.1",
+    "fetch-mock": "^8.0.0",
+    "jest-fetch-mock": "^3.0.3",
+    "json-ld-types": "3.7.0",
+    "react-dom": "^16.8.0",
+    "typescript": "~4.9.5",
+    "wait-for-expect": "^1.2.0"
+  },
+  "techstack": {
+    "@atlassian/frontend": {
+      "import-structure": [
+        "atlassian-conventions"
+      ],
+      "circular-dependencies": [
+        "file-and-folder-level"
+      ]
+    },
+    "@repo/internal": {
+      "dom-events": "use-bind-event-listener",
+      "analytics": [
+        "analytics-next"
+      ],
+      "theming": [
+        "react-context",
+        "tokens"
+      ],
+      "ui-components": [
+        "lite-mode"
+      ],
+      "deprecation": [
+        "no-deprecated-imports"
+      ],
+      "styling": [
+        "static",
+        "emotion"
+      ]
+    }
+  },
+  "af:exports": {
+    ".": "./src/index.ts"
+  },
+  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
+}

package/report.api.md

@@ -0,0 +1,98 @@
+<!-- API Report Version: 2.3 -->
+
+## API Report File for "@atlaskit/link-datasource"
+
+> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+### Table of contents
+
+- [Main Entry Types](#main-entry-types)
+- [Peer Dependencies](#peer-dependencies)
+
+### Main Entry Types
+
+<!--SECTION START: Main Entry Types-->
+
+```ts
+import { DatasourceAdf } from '@atlaskit/linking-common/types';
+import { InlineCardAdf } from '@atlaskit/linking-common/types';
+import { jsx } from '@emotion/react';
+
+// @public (undocumented)
+interface JiraIssueDatasourceParameters {
+  // (undocumented)
+  cloudId: string;
+  // (undocumented)
+  type: JiraIssueDatasourceParameterType;
+  // (undocumented)
+  value: string;
+}
+
+// @public (undocumented)
+type JiraIssueDatasourceParameterType = 'filter' | 'jql' | 'textQuery';
+
+// @public (undocumented)
+export const JiraIssuesConfigModal: (
+  props: JiraIssuesConfigModalProps,
+) => jsx.JSX.Element;
+
+// @public (undocumented)
+interface JiraIssuesConfigModalProps {
+  // (undocumented)
+  datasourceId: string;
+  // (undocumented)
+  onCancel: () => void;
+  // (undocumented)
+  onInsert: (adf: DatasourceAdf | InlineCardAdf) => void;
+  // (undocumented)
+  onUpdateParameters: (
+    parameters: Partial<JiraIssueDatasourceParameters>,
+  ) => void;
+  // (undocumented)
+  onVisibleColumnKeysChange: (visibleColumnKeys: string[]) => void;
+  // (undocumented)
+  parameters?: JiraIssueDatasourceParameters;
+  // (undocumented)
+  visibleColumnKeys?: string[];
+}
+
+// @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[];
+}
+
+// (No @packageDocumentation comment for this package)
+```
+
+<!--SECTION END: Main Entry Types-->
+
+### Peer Dependencies
+
+<!--SECTION START: Peer Dependencies-->
+
+```json
+{
+  "react": "^16.8.0",
+  "react-intl-next": "npm:react-intl@^5.18.1"
+}
+```
+
+<!--SECTION END: Peer Dependencies-->

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

@@ -0,0 +1,64 @@
+## API Report File for "@atlaskit/link-datasource"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { DatasourceAdf } from '@atlaskit/linking-common/types';
+import { InlineCardAdf } from '@atlaskit/linking-common/types';
+import { jsx } from '@emotion/react';
+
+// @public (undocumented)
+interface JiraIssueDatasourceParameters {
+    // (undocumented)
+    cloudId: string;
+    // (undocumented)
+    type: JiraIssueDatasourceParameterType;
+    // (undocumented)
+    value: string;
+}
+
+// @public (undocumented)
+type JiraIssueDatasourceParameterType = 'filter' | 'jql' | 'textQuery';
+
+// @public (undocumented)
+export const JiraIssuesConfigModal: (props: JiraIssuesConfigModalProps) => jsx.JSX.Element;
+
+// @public (undocumented)
+interface JiraIssuesConfigModalProps {
+    // (undocumented)
+    datasourceId: string;
+    // (undocumented)
+    onCancel: () => void;
+    // (undocumented)
+    onInsert: (adf: DatasourceAdf | InlineCardAdf) => void;
+    // (undocumented)
+    onUpdateParameters: (parameters: Partial<JiraIssueDatasourceParameters>) => void;
+    // (undocumented)
+    onVisibleColumnKeysChange: (visibleColumnKeys: string[]) => void;
+    // (undocumented)
+    parameters?: JiraIssueDatasourceParameters;
+    // (undocumented)
+    visibleColumnKeys?: string[];
+}
+
+// @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[];
+}
+
+// (No @packageDocumentation comment for this package)
+
+```