@atlaskit/link-datasource 2.9.0 → 2.9.1

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

@@ -7,6 +7,7 @@ export interface Site {
     url: string;
 }
 export type DisplayViewModes = 'table' | 'inline';
+export type OnInsertFunction<ADF> = (adf: ADF, analyticsEvent?: UIAnalyticsEvent) => void;
 export type ConfigModalProps<ADF, Parameters> = {
     /** Unique identifier for which type of datasource is being rendered and for making its requests */
     datasourceId: string;
@@ -17,7 +18,7 @@ export type ConfigModalProps<ADF, Parameters> = {
     /** Callback function to be invoked when the modal is closed either via cancel button click, esc keydown, or modal blanket click */
     onCancel: () => void;
     /** Callback function to be invoked when the insert issues button is clicked */
-    onInsert: (adf: ADF, analyticsEvent?: UIAnalyticsEvent) => void;
+    onInsert: OnInsertFunction<ADF>;
     /**
      * The view mode that the modal will show on open:
      * - Table = Displays a list of links in table format

package/dist/types-ts4.5/ui/common/modal/datasource-context/index.d.ts

@@ -1,30 +1,27 @@
 import React, { type PropsWithChildren } from 'react';
-import { type UIAnalyticsEvent } from '@atlaskit/analytics-next';
 import { type DatasourceAdf, type InlineCardAdf } from '@atlaskit/linking-common';
 import type { DatasourceParameters } from '@atlaskit/linking-types';
+import { type OnInsertFunction } from '../../../../common/types';
 import { type DatasourceTableState } from '../../../../hooks/useDatasourceTableState';
 import type { ColumnSizesMap } from '../../../issue-like-table/types';
 import { type ColumnResizeProps } from '../datasources-table-in-modal-preview/use-column-resize';
 import { type ColumnVisibilityProps } from '../datasources-table-in-modal-preview/use-column-visibility';
 import { type ColumnWrappingProps } from '../datasources-table-in-modal-preview/use-column-wrapping';
-type DatasourceContextStore = ColumnVisibilityProps & ColumnWrappingProps & ColumnResizeProps & {
-    datasourceId: string;
-    isValidParameters: (params: DatasourceParameters | undefined) => boolean;
+type DatasourceContextValue<Parameters extends DatasourceParameters = DatasourceParameters> = ColumnVisibilityProps & ColumnWrappingProps & ColumnResizeProps & Pick<DatasourceContextProviderProps<Parameters>, 'datasourceId' | 'onInsert' | 'isValidParameters'> & {
     tableState: DatasourceTableState;
     visibleColumnKeys?: string[];
-    parameters: DatasourceParameters | undefined;
-    setParameters: React.Dispatch<React.SetStateAction<DatasourceParameters | undefined>>;
-    onInsert: (adf: InlineCardAdf | DatasourceAdf<any>, analyticsEvent?: UIAnalyticsEvent) => void;
+    parameters: Parameters | undefined;
+    setParameters: React.Dispatch<React.SetStateAction<Parameters | undefined>>;
 };
-export type Props = PropsWithChildren<{
+type DatasourceContextProviderProps<Parameters extends DatasourceParameters> = PropsWithChildren<{
     datasourceId: string;
     isValidParameters: (params: DatasourceParameters | undefined) => boolean;
-    initialParameters: DatasourceParameters | undefined;
+    initialParameters: Parameters | undefined;
     initialVisibleColumnKeys?: string[] | undefined;
     initialWrappedColumnKeys?: string[] | undefined;
     initialColumnCustomSizes?: ColumnSizesMap | undefined;
-    onInsert: (adf: InlineCardAdf | DatasourceAdf<any>, analyticsEvent?: UIAnalyticsEvent) => void;
+    onInsert: OnInsertFunction<InlineCardAdf | DatasourceAdf<Parameters>>;
 }>;
-export declare const DatasourceContextProvider: ({ children, datasourceId, isValidParameters, initialParameters, initialVisibleColumnKeys, initialColumnCustomSizes, initialWrappedColumnKeys, onInsert, }: Props) => JSX.Element;
-export declare const useDatasourceContext: () => DatasourceContextStore;
+export declare const DatasourceContextProvider: <Parameters extends DatasourceParameters>({ children, datasourceId, isValidParameters, initialParameters, initialVisibleColumnKeys, initialColumnCustomSizes, initialWrappedColumnKeys, onInsert, }: DatasourceContextProviderProps<Parameters>) => JSX.Element;
+export declare const useDatasourceContext: <Parameters extends DatasourceParameters>() => DatasourceContextValue<Parameters>;
 export {};

package/dist/types-ts4.5/ui/common/modal/datasource-modal/createDatasourceModal.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @jsxRuntime classic
+ * @jsx jsx
+ */
+import React from 'react';
+import { jsx } from '@emotion/react';
+import { type DatasourceAdf, type InlineCardAdf } from '@atlaskit/linking-common';
+import { type DatasourceParameters } from '@atlaskit/linking-types';
+import { type ConfigModalProps } from '../../../../common/types';
+export type ConnectedConfigModalProps<Parameters extends DatasourceParameters> = Omit<ConfigModalProps<DatasourceAdf<Parameters> | InlineCardAdf, Parameters>, 'onInsert' | 'parameters'>;
+export declare const createDatasourceModal: <Parameters extends DatasourceParameters>({ isValidParameters, dataProvider, component: ModalContent, }: {
+    isValidParameters: (params: DatasourceParameters | undefined) => boolean;
+    dataProvider: string;
+    component: React.ComponentType<ConnectedConfigModalProps<Parameters>>;
+}) => (props: ConfigModalProps<DatasourceAdf<Parameters> | InlineCardAdf, DatasourceParameters | Parameters>) => jsx.JSX.Element;

package/dist/types-ts4.5/ui/common/modal/insert-button/index.d.ts

@@ -4,9 +4,11 @@
  */
 import { type PropsWithChildren } from 'react';
 import { jsx } from '@emotion/react';
-export type InsertButtonProps = PropsWithChildren<{
+import { type DatasourceParameters } from '@atlaskit/linking-types';
+export type InsertButtonProps<Parameters extends DatasourceParameters> = PropsWithChildren<{
     testId: string;
     url: string | undefined;
     getAnalyticsPayload: () => Record<string, any>;
+    overwriteParameters?: (parameters: Parameters) => Parameters;
 }>;
-export declare const InsertButton: ({ testId, url, getAnalyticsPayload, children }: InsertButtonProps) => jsx.JSX.Element;
+export declare const InsertButton: <Parameters extends DatasourceParameters>({ testId, url, getAnalyticsPayload, overwriteParameters, children, }: InsertButtonProps<Parameters>) => jsx.JSX.Element;

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

@@ -1,5 +1,4 @@
-/// <reference types="react" />
 import { jsx } from '@emotion/react';
-import { type ConfluenceSearchConfigModalProps } from '../types';
-export declare const PlainConfluenceSearchConfigModal: (props: ConfluenceSearchConfigModalProps) => jsx.JSX.Element;
-export declare const ConfluenceSearchConfigModal: import("react").ForwardRefExoticComponent<ConfluenceSearchConfigModalProps & import("@atlaskit/analytics-next").WithContextProps & import("react").RefAttributes<any>>;
+import { type ConfluenceSearchConfigModalProps, type ConnectedConfluenceSearchConfigModalProps } from '../types';
+export declare const PlainConfluenceSearchConfigModal: (props: ConnectedConfluenceSearchConfigModalProps) => jsx.JSX.Element;
+export declare const ConfluenceSearchConfigModal: (props: ConfluenceSearchConfigModalProps) => jsx.JSX.Element;

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

@@ -1,11 +1,16 @@
 import { type DatasourceAdf, type InlineCardAdf } from '@atlaskit/linking-common/types';
-import type { DatasourceParameters } from '@atlaskit/linking-types';
+import { type DatasourceParameters } from '@atlaskit/linking-types';
 import { type ConfigModalProps } from '../../common/types';
+import { type ConnectedConfigModalProps } from '../common/modal/datasource-modal/createDatasourceModal';
 import { type DateRangeType } from '../common/modal/popup-select/types';
 export interface ConfluenceSearchConfigModalProps extends ConfigModalProps<InlineCardAdf | ConfluenceSearchDatasourceAdf, DatasourceParameters | ConfluenceSearchDatasourceParameters> {
     disableDisplayDropdown?: boolean;
     overrideParameters?: Pick<ConfluenceSearchDatasourceParameters, 'entityTypes'>;
 }
+export interface ConnectedConfluenceSearchConfigModalProps extends ConnectedConfigModalProps<ConfluenceSearchDatasourceParameters> {
+    disableDisplayDropdown?: boolean;
+    overrideParameters?: Pick<ConfluenceSearchDatasourceParameters, 'entityTypes'>;
+}
 export type ConfluenceSearchDatasourceParameters = {
     cloudId: string;
     searchString?: string;

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

@@ -1,3 +1,3 @@
-/// <reference types="react" />
-import type { JiraConfigModalProps } from '../types';
-export declare const JiraIssuesConfigModal: import("react").ForwardRefExoticComponent<JiraConfigModalProps & import("@atlaskit/analytics-next").WithContextProps & import("react").RefAttributes<any>>;
+import { jsx } from '@emotion/react';
+import { type JiraConfigModalProps } from '../types';
+export declare const JiraIssuesConfigModal: (props: JiraConfigModalProps) => jsx.JSX.Element;

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

@@ -1,6 +1,7 @@
 import { type DatasourceAdf, type InlineCardAdf } from '@atlaskit/linking-common/types';
 import { type DatasourceParameters } from '@atlaskit/linking-types';
 import { type ConfigModalProps } from '../../common/types';
+import { type ConnectedConfigModalProps } from '../common/modal/datasource-modal/createDatasourceModal';
 type XOR<T1, T2> = (T1 & {
     [k in Exclude<keyof T2, keyof T1>]?: never;
 }) | (T2 & {
@@ -17,4 +18,6 @@ export type JiraIssueDatasourceParameters = {
 export type JiraIssuesDatasourceAdf = DatasourceAdf<JiraIssueDatasourceParameters>;
 export interface JiraConfigModalProps extends ConfigModalProps<InlineCardAdf | DatasourceAdf, DatasourceParameters | JiraIssueDatasourceParameters> {
 }
+export interface ConnectedJiraConfigModalProps extends ConnectedConfigModalProps<JiraIssueDatasourceParameters> {
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/link-datasource",
-	"version": "2.9.0",
+	"version": "2.9.1",
 	"description": "UI Components to support linking platform dataset feature",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",