@atlaskit/link-datasource 2.9.3 → 2.9.5

package/dist/esm/ui/issue-like-table/table-cell-content/index.js

@@ -1,34 +1,27 @@
 import React from 'react';
 import { useIntl } from 'react-intl-next';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { Box, xcss } from '@atlaskit/primitives';
 import Tooltip from '@atlaskit/tooltip';
 import { useDatasourceItem } from '../../../state';
 import { stringifyType } from '../render-type';
 import { TruncateTextTag } from '../truncate-text-tag';
-export var TableCellContent = function TableCellContent(_ref) {
-  var _rowData$columnKey;
+var truncateTextStyles = xcss({
+  textOverflow: 'ellipsis',
+  overflow: 'hidden',
+  width: '100%'
+});
+var TooltipWrapper = function TooltipWrapper(_ref) {
   var columnKey = _ref.columnKey,
-    columnType = _ref.columnType,
-    id = _ref.id,
-    renderItem = _ref.renderItem,
-    wrappedColumnKeys = _ref.wrappedColumnKeys;
+    _ref$datasourceTypeWi = _ref.datasourceTypeWithValues,
+    type = _ref$datasourceTypeWi.type,
+    values = _ref$datasourceTypeWi.values,
+    wrappedColumnKeys = _ref.wrappedColumnKeys,
+    children = _ref.children;
   var intl = useIntl();
-  var rowData = useDatasourceItem({
-    id: id
-  });
-  if (!rowData || !columnKey || !rowData[columnKey]) {
-    return /*#__PURE__*/React.createElement(React.Fragment, null);
-  }
-
-  // Need to make sure we keep falsy values like 0 and '', as well as the boolean false.
-  var value = (_rowData$columnKey = rowData[columnKey]) === null || _rowData$columnKey === void 0 ? void 0 : _rowData$columnKey.data;
-  var values = Array.isArray(value) ? value : [value];
-  var renderedValues = renderItem({
-    type: columnType,
-    values: values
-  });
   var stringifiedContent = values.map(function (value) {
     return stringifyType({
-      type: columnType,
+      type: type,
       value: value
     }, intl.formatMessage, intl.formatDate);
   }).filter(function (value) {
@@ -41,7 +34,89 @@ export var TableCellContent = function TableCellContent(_ref) {
       tag: TruncateTextTag,
       content: stringifiedContent,
       testId: "issues-table-cell-tooltip"
-    }, renderedValues);
+    }, children);
   }
-  return /*#__PURE__*/React.createElement(React.Fragment, null, renderedValues);
+  return /*#__PURE__*/React.createElement(React.Fragment, null, children);
+};
+var ReadOnlyCell = function ReadOnlyCell(_ref2) {
+  var _rowData$columnKey;
+  var id = _ref2.id,
+    columnType = _ref2.columnType,
+    _ref2$wrappedColumnKe = _ref2.wrappedColumnKeys,
+    wrappedColumnKeys = _ref2$wrappedColumnKe === void 0 ? [] : _ref2$wrappedColumnKe,
+    renderItem = _ref2.renderItem,
+    columnKey = _ref2.columnKey;
+  var rowData = useDatasourceItem({
+    id: id
+  });
+  if (!rowData || !columnKey || !rowData[columnKey]) {
+    return /*#__PURE__*/React.createElement(React.Fragment, null);
+  }
+
+  // Need to make sure we keep falsy values like 0 and '', as well as the boolean false.
+  var value = (_rowData$columnKey = rowData[columnKey]) === null || _rowData$columnKey === void 0 ? void 0 : _rowData$columnKey.data;
+  var values = Array.isArray(value) ? value : [value];
+  var datasourceTypeWithValues = {
+    type: columnType,
+    values: values
+  };
+  return /*#__PURE__*/React.createElement(TooltipWrapper, {
+    columnKey: columnKey,
+    datasourceTypeWithValues: datasourceTypeWithValues,
+    wrappedColumnKeys: wrappedColumnKeys
+  }, renderItem(datasourceTypeWithValues));
+};
+var InlineEditableCell = function InlineEditableCell(_ref3) {
+  var _rowData$columnKey2;
+  var id = _ref3.id,
+    columnKey = _ref3.columnKey,
+    columnType = _ref3.columnType,
+    renderItem = _ref3.renderItem,
+    wrappedColumnKeys = _ref3.wrappedColumnKeys;
+  var rowData = useDatasourceItem({
+    id: id
+  });
+  if (!rowData || !columnKey || !rowData[columnKey]) {
+    return /*#__PURE__*/React.createElement(React.Fragment, null);
+  }
+
+  // Need to make sure we keep falsy values like 0 and '', as well as the boolean false.
+  var value = (_rowData$columnKey2 = rowData[columnKey]) === null || _rowData$columnKey2 === void 0 ? void 0 : _rowData$columnKey2.data;
+  var values = Array.isArray(value) ? value : [value];
+  var datasourceTypeWithValues = {
+    type: columnType,
+    values: values
+  };
+  return /*#__PURE__*/React.createElement(TooltipWrapper, {
+    columnKey: columnKey,
+    datasourceTypeWithValues: datasourceTypeWithValues,
+    wrappedColumnKeys: wrappedColumnKeys
+  }, /*#__PURE__*/React.createElement(Box, {
+    testId: 'inline-edit-read-view',
+    paddingInline: 'space.100',
+    paddingBlock: 'space.050',
+    xcss: truncateTextStyles
+  }, renderItem(datasourceTypeWithValues)));
+};
+export var TableCellContent = function TableCellContent(_ref4) {
+  var columnKey = _ref4.columnKey,
+    columnType = _ref4.columnType,
+    id = _ref4.id,
+    renderItem = _ref4.renderItem,
+    wrappedColumnKeys = _ref4.wrappedColumnKeys;
+  // eslint-disable-next-line @atlaskit/platform/ensure-feature-flag-prefix
+  var renderedContent = fg('platform-datasources-enable-two-way-sync') ? /*#__PURE__*/React.createElement(InlineEditableCell, {
+    id: id,
+    columnKey: columnKey,
+    columnType: columnType,
+    renderItem: renderItem,
+    wrappedColumnKeys: wrappedColumnKeys
+  }) : /*#__PURE__*/React.createElement(ReadOnlyCell, {
+    id: id,
+    columnKey: columnKey,
+    columnType: columnType,
+    wrappedColumnKeys: wrappedColumnKeys,
+    renderItem: renderItem
+  });
+  return renderedContent;
 };

package/dist/types/state/actions/index.d.ts

@@ -0,0 +1,87 @@
+import { type Action } from 'react-sweet-state';
+import { useDatasourceClientExtension } from '@atlaskit/link-client-extension';
+import type { ActionsDiscoveryRequest, AtomicActionInterface } from '@atlaskit/linking-types';
+type IntegrationKey = string;
+type FieldKey = string;
+/**
+ * Atomic actions available for an integration (by field)
+ * @example
+ * ```ts
+ *	{
+ *		jira: {
+ *			summary: {
+ *				actionKey: 'atlassian:issue:update:summary',
+ *				type: 'string',
+ *				description: 'Update issue summary',
+ *			}
+ *		}
+ *	}
+ * ```
+ */
+type IntegrationActions = Record<IntegrationKey, Record<FieldKey, Pick<AtomicActionInterface, 'actionKey' | 'type' | 'description'>>>;
+/**
+ * Permissions available for a target
+ */
+type TargetPermissions = Record<FieldKey, {
+    isEditable: boolean;
+}>;
+/**
+ * User permissions for actions on target (ARI) properties
+ * @example
+ * ```ts
+ *	{
+ *		'ari:cloud:jira:63cecfe3-16fa-4ee1-8e8d-047cc4b18980:issue/1': {
+ *			summary: {
+ *				isEditable: true
+ *			}
+ *		}
+ *	}
+ * ```
+ */
+type ARI = string;
+type Permissions = Record<ARI, TargetPermissions>;
+export interface ActionsStoreState {
+    actionsByIntegration: IntegrationActions;
+    permissions: Permissions;
+}
+interface Client {
+    getDatasourceActionsAndPermissions: ReturnType<typeof useDatasourceClientExtension>['getDatasourceActionsAndPermissions'];
+}
+export declare const actions: {
+    discoverActions: (api: Client, request: ActionsDiscoveryRequest) => Action<ActionsStoreState>;
+};
+export declare const ActionsStore: import("react-sweet-state").Store<ActionsStoreState, {
+    discoverActions: (api: Client, request: ActionsDiscoveryRequest) => Action<ActionsStoreState>;
+}>;
+export declare const useDiscoverActions: () => {
+    discoverActions: (request: ActionsDiscoveryRequest) => void | Promise<void>;
+};
+/**
+ * Retrieves the action schema for a given ARI + fieldKey + integrationKey
+ */
+export declare const useAtomicUpdateActionSchema: import("react-sweet-state").HookFunction<Pick<AtomicActionInterface, "actionKey" | "type" | "description"> | undefined, import("react-sweet-state").BoundActions<ActionsStoreState, {
+    discoverActions: (api: Client, request: ActionsDiscoveryRequest) => Action<ActionsStoreState>;
+}>, {
+    ari: string;
+    fieldKey: string;
+    integrationKey: string;
+}>;
+/**
+ * Given an ARI + fieldKey + integrationKey
+ * Returns an executable action that updates a field on the entity if the user has permissions to do so
+ *
+ * @example
+ * ```tsx
+ * const { execute } = useExecuteAtomicAction({ ari, fieldKey: 'summary', integrationKey: 'jira' });
+ *
+ * return <button onClick={() => execute('New summary')}>Update summary</button>;
+ * ```
+ */
+export declare const useExecuteAtomicAction: ({ ari, fieldKey, integrationKey, }: {
+    ari: string;
+    fieldKey: string;
+    integrationKey: string;
+}) => {
+    execute: (value: AtomicActionInterface['type']) => void;
+} | null;
+export {};

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

@@ -1,21 +1,26 @@
 /// <reference types="react" />
 import { type Action } from 'react-sweet-state';
-import { type DatasourceDataResponseItem } from '@atlaskit/linking-types';
+import type { DatasourceDataResponseItem } from '@atlaskit/linking-types';
+type UniqueIdentifier = string;
 export interface State {
-    items: Record<string, DatasourceDataResponseItem>;
+    items: Record<UniqueIdentifier, {
+        integrationKey: string | undefined;
+        data: DatasourceDataResponseItem;
+    }>;
 }
 export declare const actions: {
-    onAddItems: (items: DatasourceDataResponseItem[]) => Action<State, void, string[]>;
+    onAddItems: (items: DatasourceDataResponseItem[], integrationKey: string | undefined) => Action<State, void, string[]>;
 };
 export declare const Store: import("react-sweet-state").Store<State, {
-    onAddItems: (items: DatasourceDataResponseItem[]) => Action<State, void, string[]>;
+    onAddItems: (items: DatasourceDataResponseItem[], integrationKey: string | undefined) => Action<State, void, string[]>;
 }>;
 export declare const useDatasourceItem: import("react-sweet-state").HookStateFunction<DatasourceDataResponseItem | undefined, {
     id: string;
 }>;
 export declare const useDatasourceActions: import("react-sweet-state").HookActionsFunction<import("react-sweet-state").BoundActions<State, {
-    onAddItems: (items: DatasourceDataResponseItem[]) => Action<State, void, string[]>;
+    onAddItems: (items: DatasourceDataResponseItem[], integrationKey: string | undefined) => Action<State, void, string[]>;
 }>>;
 export declare const StoreContainer: ({ children }: {
     children: JSX.Element;
 }) => JSX.Element;
+export {};

package/dist/types/ui/issue-like-table/styled.d.ts

@@ -22,3 +22,7 @@ export declare const TableCell: import("@emotion/styled").StyledComponent<{
     theme?: import("@emotion/react").Theme | undefined;
     as?: import("react").ElementType<any> | undefined;
 }, import("react").DetailedHTMLProps<import("react").TdHTMLAttributes<HTMLTableDataCellElement>, HTMLTableDataCellElement>, {}>;
+export declare const InlineEditableTableCell: import("@emotion/styled").StyledComponent<{
+    theme?: import("@emotion/react").Theme | undefined;
+    as?: import("react").ElementType<any> | undefined;
+}, import("react").DetailedHTMLProps<import("react").TdHTMLAttributes<HTMLTableDataCellElement>, HTMLTableDataCellElement>, {}>;

package/dist/types/ui/issue-like-table/table-cell-content/index.d.ts

@@ -1,9 +1,10 @@
 /// <reference types="react" />
+import { type DatasourceType } from '@atlaskit/linking-types';
 import { type TableViewPropsRenderType } from '../types';
 interface TableCellContentProps {
     id: string;
-    columnKey: string | null;
-    columnType: string;
+    columnKey: string;
+    columnType: DatasourceType['type'];
     /** Used to retrieve cell content from the store */
     renderItem: TableViewPropsRenderType;
     wrappedColumnKeys: string[] | undefined;

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

@@ -0,0 +1,87 @@
+import { type Action } from 'react-sweet-state';
+import { useDatasourceClientExtension } from '@atlaskit/link-client-extension';
+import type { ActionsDiscoveryRequest, AtomicActionInterface } from '@atlaskit/linking-types';
+type IntegrationKey = string;
+type FieldKey = string;
+/**
+ * Atomic actions available for an integration (by field)
+ * @example
+ * ```ts
+ *	{
+ *		jira: {
+ *			summary: {
+ *				actionKey: 'atlassian:issue:update:summary',
+ *				type: 'string',
+ *				description: 'Update issue summary',
+ *			}
+ *		}
+ *	}
+ * ```
+ */
+type IntegrationActions = Record<IntegrationKey, Record<FieldKey, Pick<AtomicActionInterface, 'actionKey' | 'type' | 'description'>>>;
+/**
+ * Permissions available for a target
+ */
+type TargetPermissions = Record<FieldKey, {
+    isEditable: boolean;
+}>;
+/**
+ * User permissions for actions on target (ARI) properties
+ * @example
+ * ```ts
+ *	{
+ *		'ari:cloud:jira:63cecfe3-16fa-4ee1-8e8d-047cc4b18980:issue/1': {
+ *			summary: {
+ *				isEditable: true
+ *			}
+ *		}
+ *	}
+ * ```
+ */
+type ARI = string;
+type Permissions = Record<ARI, TargetPermissions>;
+export interface ActionsStoreState {
+    actionsByIntegration: IntegrationActions;
+    permissions: Permissions;
+}
+interface Client {
+    getDatasourceActionsAndPermissions: ReturnType<typeof useDatasourceClientExtension>['getDatasourceActionsAndPermissions'];
+}
+export declare const actions: {
+    discoverActions: (api: Client, request: ActionsDiscoveryRequest) => Action<ActionsStoreState>;
+};
+export declare const ActionsStore: import("react-sweet-state").Store<ActionsStoreState, {
+    discoverActions: (api: Client, request: ActionsDiscoveryRequest) => Action<ActionsStoreState>;
+}>;
+export declare const useDiscoverActions: () => {
+    discoverActions: (request: ActionsDiscoveryRequest) => void | Promise<void>;
+};
+/**
+ * Retrieves the action schema for a given ARI + fieldKey + integrationKey
+ */
+export declare const useAtomicUpdateActionSchema: import("react-sweet-state").HookFunction<Pick<AtomicActionInterface, "actionKey" | "type" | "description"> | undefined, import("react-sweet-state").BoundActions<ActionsStoreState, {
+    discoverActions: (api: Client, request: ActionsDiscoveryRequest) => Action<ActionsStoreState>;
+}>, {
+    ari: string;
+    fieldKey: string;
+    integrationKey: string;
+}>;
+/**
+ * Given an ARI + fieldKey + integrationKey
+ * Returns an executable action that updates a field on the entity if the user has permissions to do so
+ *
+ * @example
+ * ```tsx
+ * const { execute } = useExecuteAtomicAction({ ari, fieldKey: 'summary', integrationKey: 'jira' });
+ *
+ * return <button onClick={() => execute('New summary')}>Update summary</button>;
+ * ```
+ */
+export declare const useExecuteAtomicAction: ({ ari, fieldKey, integrationKey, }: {
+    ari: string;
+    fieldKey: string;
+    integrationKey: string;
+}) => {
+    execute: (value: AtomicActionInterface['type']) => void;
+} | null;
+export {};

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

@@ -1,21 +1,26 @@
 /// <reference types="react" />
 import { type Action } from 'react-sweet-state';
-import { type DatasourceDataResponseItem } from '@atlaskit/linking-types';
+import type { DatasourceDataResponseItem } from '@atlaskit/linking-types';
+type UniqueIdentifier = string;
 export interface State {
-    items: Record<string, DatasourceDataResponseItem>;
+    items: Record<UniqueIdentifier, {
+        integrationKey: string | undefined;
+        data: DatasourceDataResponseItem;
+    }>;
 }
 export declare const actions: {
-    onAddItems: (items: DatasourceDataResponseItem[]) => Action<State, void, string[]>;
+    onAddItems: (items: DatasourceDataResponseItem[], integrationKey: string | undefined) => Action<State, void, string[]>;
 };
 export declare const Store: import("react-sweet-state").Store<State, {
-    onAddItems: (items: DatasourceDataResponseItem[]) => Action<State, void, string[]>;
+    onAddItems: (items: DatasourceDataResponseItem[], integrationKey: string | undefined) => Action<State, void, string[]>;
 }>;
 export declare const useDatasourceItem: import("react-sweet-state").HookStateFunction<DatasourceDataResponseItem | undefined, {
     id: string;
 }>;
 export declare const useDatasourceActions: import("react-sweet-state").HookActionsFunction<import("react-sweet-state").BoundActions<State, {
-    onAddItems: (items: DatasourceDataResponseItem[]) => Action<State, void, string[]>;
+    onAddItems: (items: DatasourceDataResponseItem[], integrationKey: string | undefined) => Action<State, void, string[]>;
 }>>;
 export declare const StoreContainer: ({ children }: {
     children: JSX.Element;
 }) => JSX.Element;
+export {};

package/dist/types-ts4.5/ui/issue-like-table/styled.d.ts

@@ -22,3 +22,7 @@ export declare const TableCell: import("@emotion/styled").StyledComponent<{
     theme?: import("@emotion/react").Theme | undefined;
     as?: import("react").ElementType<any> | undefined;
 }, import("react").DetailedHTMLProps<import("react").TdHTMLAttributes<HTMLTableDataCellElement>, HTMLTableDataCellElement>, {}>;
+export declare const InlineEditableTableCell: import("@emotion/styled").StyledComponent<{
+    theme?: import("@emotion/react").Theme | undefined;
+    as?: import("react").ElementType<any> | undefined;
+}, import("react").DetailedHTMLProps<import("react").TdHTMLAttributes<HTMLTableDataCellElement>, HTMLTableDataCellElement>, {}>;

package/dist/types-ts4.5/ui/issue-like-table/table-cell-content/index.d.ts

@@ -1,9 +1,10 @@
 /// <reference types="react" />
+import { type DatasourceType } from '@atlaskit/linking-types';
 import { type TableViewPropsRenderType } from '../types';
 interface TableCellContentProps {
     id: string;
-    columnKey: string | null;
-    columnType: string;
+    columnKey: string;
+    columnType: DatasourceType['type'];
     /** Used to retrieve cell content from the store */
     renderItem: TableViewPropsRenderType;
     wrappedColumnKeys: string[] | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/link-datasource",
-	"version": "2.9.3",
+	"version": "2.9.5",
 	"description": "UI Components to support linking platform dataset feature",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -41,7 +41,7 @@
 		"@atlaskit/avatar-group": "^9.9.0",
 		"@atlaskit/badge": "^16.3.0",
 		"@atlaskit/button": "^19.1.0",
-		"@atlaskit/datetime-picker": "^13.7.0",
+		"@atlaskit/datetime-picker": "^13.8.0",
 		"@atlaskit/dropdown-menu": "^12.15.0",
 		"@atlaskit/editor-prosemirror": "5.0.1",
 		"@atlaskit/empty-state": "^7.9.0",
@@ -54,7 +54,7 @@
 		"@atlaskit/jql-ast": "^3.3.0",
 		"@atlaskit/jql-editor": "^4.4.0",
 		"@atlaskit/jql-editor-autocomplete-rest": "^2.0.0",
-		"@atlaskit/link-client-extension": "^1.11.0",
+		"@atlaskit/link-client-extension": "^1.12.0",
 		"@atlaskit/linking-common": "^5.8.0",
 		"@atlaskit/linking-types": "^8.12.0",
 		"@atlaskit/logo": "^14.1.0",
@@ -98,7 +98,7 @@
 		"@af/integration-testing": "*",
 		"@af/visual-regression": "*",
 		"@atlaskit/link-provider": "^1.14.0",
-		"@atlaskit/link-test-helpers": "^7.0.0",
+		"@atlaskit/link-test-helpers": "^7.1.0",
 		"@atlaskit/ssr": "*",
 		"@atlaskit/visual-regression": "*",
 		"@atlassian/feature-flags-test-utils": "^0.2.0",
@@ -155,6 +155,9 @@
 		"enable_datasource_react_sweet_state": {
 			"type": "boolean"
 		},
+		"platform-datasources-enable-two-way-sync": {
+			"type": "boolean"
+		},
 		"platform.linking-platform.datasource.add-timezone-header": {
 			"type": "boolean",
 			"referenceOnly": "true"