@atlaskit/share 3.5.2 → 3.5.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/share",
-  "version": "3.5.2",
+  "version": "3.5.3",
   "description": "Fabric Share Element",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -12,6 +12,13 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "dist/types-ts4.0/*"
+      ]
+    }
+  },
   "atlaskit:src": "src/index.ts",
   "atlassian": {
     "team": "People and Teams Collective",
@@ -45,7 +52,7 @@
     "@atlaskit/tokens": "^0.10.0",
     "@atlaskit/tooltip": "^17.5.0",
     "@atlaskit/ufo": "^0.1.0",
-    "@atlaskit/user-picker": "^9.3.0",
+    "@atlaskit/user-picker": "^9.4.0",
     "@atlaskit/util-service-support": "^6.1.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1",
@@ -60,7 +67,7 @@
   },
   "devDependencies": {
     "@atlaskit/docs": "^9.0.0",
-    "@atlaskit/editor-test-helpers": "^17.1.0",
+    "@atlaskit/editor-test-helpers": "^17.2.0",
     "@atlaskit/flag": "^14.7.0",
     "@atlaskit/section-message": "^6.2.0",
     "@atlaskit/select": "^15.7.0",
@@ -71,7 +78,7 @@
     "enzyme-adapter-react-16": "^1.15.1",
     "enzyme-react-intl": "^2.0.6",
     "react": "^16.8.0",
-    "typescript": "4.3.5"
+    "typescript": "4.5.5"
   },
   "keywords": [
     "ui",

package/report.api.md

@@ -1,6 +1,10 @@
-## API Report File for "@atlaskit/share".
+## API Report File for "@atlaskit/share"
 
-> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+<!--
+	Generated API Report version: 2.0
+-->
 
 [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
 
@@ -19,55 +23,64 @@ import { TriggerProps } from '@atlaskit/popup';
 import type { Value } from '@atlaskit/smart-user-picker';
 import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
 
-export declare const ADMIN_NOTIFIED = 'admin-notified';
+// @public (undocumented)
+export const ADMIN_NOTIFIED = 'admin-notified';
 
-declare type Comment_2 = {
+// @public (undocumented)
+type Comment_2 = {
   format: 'plain_text' | 'adf';
   value: string;
 };
 export { Comment_2 as Comment };
 
-export declare type ConfigResponse = {
+// @public (undocumented)
+export type ConfigResponse = {
   disableSharingToEmails?: boolean;
 };
 
-export declare type Content = {
+// @public (undocumented)
+export type Content = {
   ari: string;
   link: string;
   title: string;
   type: string;
 };
 
-export declare class CopyLinkButton extends React_2.Component<Props, State> {
-  private autoDismiss;
-  private inputRef;
+// @public (undocumented)
+export class CopyLinkButton extends React_2.Component<Props, State> {
+  // (undocumented)
+  componentWillUnmount(): void;
+  // (undocumented)
+  render(): jsx.JSX.Element;
+  // (undocumented)
+  renderTriggerButton: (triggerProps: TriggerProps) => jsx.JSX.Element;
+  // (undocumented)
   state: {
     shouldShowCopiedMessage: boolean;
   };
-  componentWillUnmount(): void;
-  private clearAutoDismiss;
-  private handleClick;
-  private handleDismissCopiedMessage;
-  renderTriggerButton: (triggerProps: TriggerProps) => jsx.JSX.Element;
-  render(): jsx.JSX.Element;
 }
 
-export declare type DialogContentState = {
+// @public (undocumented)
+export type DialogContentState = {
   users: OptionData[];
   comment: Comment_2;
 };
 
-export declare type DialogPlacement = Placement;
+// @public (undocumented)
+export type DialogPlacement = Placement;
 
-export declare type Flag = {
+// @public (undocumented)
+export type Flag = {
   appearance: 'success';
   title: MessageDescriptor;
   type: FlagType;
 };
 
-export declare type FlagType = 'object-shared' | 'admin-notified';
+// @public (undocumented)
+export type FlagType = 'object-shared' | 'admin-notified';
 
-export declare type FormChildrenArgs<T> = {
+// @public (undocumented)
+export type FormChildrenArgs<T> = {
   formProps: React.DetailedHTMLProps<
     React.FormHTMLAttributes<HTMLFormElement>,
     HTMLFormElement
@@ -75,42 +88,51 @@ export declare type FormChildrenArgs<T> = {
   getValues: () => T;
 };
 
-declare type Integration = {
+// @public (undocumented)
+type Integration = {
   type: string;
   Icon: React.ComponentType;
   Content: React.ComponentType<IntegrationContentProps>;
 };
 
-declare type IntegrationContentProps = {
+// @public (undocumented)
+type IntegrationContentProps = {
   onClose: () => void;
   changeTab?: (index: TabType) => void;
 };
 
-declare type IntegrationMode = 'tabs' | 'split' | 'off';
+// @public (undocumented)
+type IntegrationMode = 'tabs' | 'split' | 'off';
 
-export declare type KeysOfType<T, TProp> = {
+// @public (undocumented)
+export type KeysOfType<T, TProp> = {
   [P in keyof T]: T[P] extends TProp ? P : never;
 }[keyof T];
 
-export declare type MessageDescriptor = {
+// @public (undocumented)
+export type MessageDescriptor = {
   id: string;
   description: string;
   defaultMessage: string;
 };
 
-export declare type MetaData = {
+// @public (undocumented)
+export type MetaData = {
   productId: string;
   atlOriginId: string;
   shareeAction?: 'view' | 'edit';
 };
 
-export declare const OBJECT_SHARED = 'object-shared';
+// @public (undocumented)
+export const OBJECT_SHARED = 'object-shared';
 
-export declare type OriginAnalyticAttributes = {
+// @public (undocumented)
+export type OriginAnalyticAttributes = {
   hasGeneratedId: boolean;
 };
 
-export declare type OriginTracing = {
+// @public (undocumented)
+export type OriginTracing = {
   id: string;
   addToUrl: (link: string) => string;
   toAnalyticsAttributes: (
@@ -118,20 +140,23 @@ export declare type OriginTracing = {
   ) => OriginTracingWithIdGenerated | OriginTracingForSubSequentEvents;
 };
 
-export declare type OriginTracingFactory = () => OriginTracing;
+// @public (undocumented)
+export type OriginTracingFactory = () => OriginTracing;
 
-export declare type OriginTracingForSubSequentEvents = {
+// @public (undocumented)
+export type OriginTracingForSubSequentEvents = {
   originId: string;
   originProduct: string;
 };
 
-export declare type OriginTracingWithIdGenerated = {
+// @public (undocumented)
+export type OriginTracingWithIdGenerated = {
   originIdGenerated: string;
   originProduct: string;
 };
 
-/** Product ID (Canonical ID) in ARI of the share request */
-export declare type ProductId =
+// @public
+export type ProductId =
   | 'bitbucket'
   | 'confluence'
   | 'jira-addon'
@@ -144,9 +169,11 @@ export declare type ProductId =
   | 'jira-unknown'
   | 'trello';
 
-export declare type ProductName = 'jira' | 'confluence';
+// @public (undocumented)
+export type ProductName = 'jira' | 'confluence';
 
-declare type Props = {
+// @public (undocumented)
+type Props = {
   onLinkCopy?: (link: string) => void;
   link: string;
   isDisabled?: boolean;
@@ -157,7 +184,8 @@ declare type Props = {
   iconBefore?: ReactElement;
 };
 
-export declare type RenderCustomTriggerButton = (
+// @public (undocumented)
+export type RenderCustomTriggerButton = (
   args: {
     error?: ShareError;
     isDisabled?: boolean;
@@ -167,27 +195,30 @@ export declare type RenderCustomTriggerButton = (
   triggerProps: TriggerProps,
 ) => React.ReactNode;
 
-export declare type ShareButtonStyle =
-  | 'icon-only'
-  | 'icon-with-text'
-  | 'text-only';
+// @public (undocumented)
+export type ShareButtonStyle = 'icon-only' | 'icon-with-text' | 'text-only';
 
-declare interface ShareClient {
+// @public (undocumented)
+interface ShareClient {
+  // (undocumented)
+  getConfig(cloudId: string): Promise<ConfigResponse>;
+  // (undocumented)
   share(
     content: Content,
     recipients: User[],
     metadata: MetaData,
     comment?: Comment_2,
   ): Promise<ShareResponse>;
-  getConfig(cloudId: string): Promise<ConfigResponse>;
 }
 
-export declare type ShareContentState = {
+// @public (undocumented)
+export type ShareContentState = {
   users: User[];
   comment?: Comment_2;
 };
 
-export declare const ShareDialogContainer: React_2.ForwardRefExoticComponent<
+// @public (undocumented)
+export const ShareDialogContainer: React_2.ForwardRefExoticComponent<
   Pick<
     Omit<
       WithAnalyticsEventsProps & ShareDialogContainerProps,
@@ -257,125 +288,43 @@ export declare const ShareDialogContainer: React_2.ForwardRefExoticComponent<
     React_2.RefAttributes<any>
 >;
 
-export declare type ShareDialogContainerProps = {
+// @public (undocumented)
+export type ShareDialogContainerProps = {
   onTriggerButtonClick?: () => void;
   onDialogOpen?: () => void;
   onDialogClose?: () => void;
   isAutoOpenDialog?: boolean;
-  /** Share service client implementation that gets share configs and performs share.
-   * Optional, a default one is provided. */
   shareClient?: ShareClient;
-  /** URL Shortener service client implementation that may shorten links for copy.
-   * Optional, a default one is provided. */
   urlShortenerClient?: UrlShortenerClient;
-  /** Data provided to the `urlShortenerClient` to shorten the shared URL.
-   * If it is not provided, the link will not be shortened.
-   * If link shortening fails, the full URL will be shared instead. */
   shortLinkData?: ShortenRequest;
-  /** Cloud ID of the instance.
-   * Note: we assume this props is stable. */
   cloudId: string;
-  /** Organisation ID of the instance. */
   orgId?: string;
-  /** Placement of the modal to the trigger button. */
   dialogPlacement?: DialogPlacement;
-  /**
-   * Z-index that the popup should be displayed in.
-   * This is passed to the portal component.
-   * Defaults to `layers.modal()` from `@atlaskit/theme`.
-   */
   dialogZIndex?: number;
-  /** Transform function to provide custom formatted copy link.
-   * Optional, a default one is provided. */
   formatCopyLink?: (origin: OriginTracing, link: string) => string;
-  /** Function used to load users options asynchronously. Not needed if smart user picker is enabled. */
   loadUserOptions?: LoadOptions;
-  /** Factory function to generate new Origin Tracing instance. */
   originTracingFactory: OriginTracingFactory;
-  /** Product ID (Canonical ID) in ARI of the share request.
-   * Note: we assume this props is stable. */
   productId: ProductId;
-  /** Render function for a custom Share Dialog Trigger Button. */
   renderCustomTriggerButton?: RenderCustomTriggerButton;
-  /** Atlassian Resource Identifier of a Site resource to be shared. */
   shareAri: string;
-  /** Content Type of the resource to be shared. It will also affect on the successful share message in the flag. A pre-defined list as follows:*/
-  /** blogpost */
-  /** board */
-  /** calendar */
-  /** draft */
-  /** filter */
-  /** issue */
-  /** media */
-  /** page */
-  /** project */
-  /** pullrequest */
-  /** question */
-  /** report */
-  /** repository */
-  /** request */
-  /** roadmap */
-  /** site */
-  /** space */
-  /** Any other unlisted type will have a default message of "Link shared". */
   shareContentType: string;
-  /** Link of the resource to be shared (should NOT includes origin tracing).
-   * Optional, the current page URL is used by default. */
   shareLink?: string;
-  /** Title of the resource to be shared that will be sent in notifications. */
   shareTitle: string;
-  /** Title of the share modal. */
   shareFormTitle?: React.ReactNode;
-  /** Copy for helper message to be displayed under share form input box. */
   shareFormHelperMessage?: string;
-  /** To enable closing the modal on escape key press. */
   shouldCloseOnEscapePress?: boolean;
-  /**
-   * Callback function for showing successful share flag(s) with a parameter providing details of the flag, including the type of the message with a localized default title
-   * This package has an opinion on showing flag(s) upon successful share, and Flag system is NOT provided. Instead, showFlag prop is available for this purpose.
-   */
   showFlags: (flags: Array<Flag>) => void;
-  /**
-   * Power the user picker with smarts. To enable smart user picker, the following props are used:
-   * - `product`: 'jira' or 'confluence'
-   * - `loggedInAccountId`: if not provided, defaults to obtaining from request context
-   * - `cloudId`
-   */
   enableSmartUserPicker?: boolean;
-  /**
-   * The userId of the sharer. If not provided, smart user picker
-   * defaults it to the value 'Context'
-   * which will tell the recommendation service to extract the
-   * value from the request context.
-   */
   loggedInAccountId?: string;
-  /** Appearance of the share modal trigger button  */
   triggerButtonAppearance?: Appearance;
-  /** Share button Icon */
   triggerButtonIcon?: React.ComponentType<IconProps>;
-  /** Style of the share modal trigger button. */
   triggerButtonStyle?: ShareButtonStyle;
-  /** Position of the tooltip on share modal trigger button. */
   triggerButtonTooltipPosition?: TooltipPosition;
-  /** Custom text of the tooltip on share modal trigger button. */
   triggerButtonTooltipText?: React.ReactNode;
-  /** Message to be appended to the modal. */
   bottomMessage?: React.ReactNode;
-  /** @deprecated Use the `shortLinkData` prop instead.
-   *
-   * Whether we should use the Atlassian Url Shortener or not.
-   * Note that all products may not be supported. */
   useUrlShortener?: boolean;
-  /** Action that will be performed by the recipient when he/she receives the notification. */
   shareeAction?: 'view' | 'edit';
-  /**
-   * Optional, this prop can be `jira` or `confluence`. Default value is `confluence`.
-   * We use this prop to control different text messages in UI.
-   */
   product?: ProductName;
-  /**
-   * Footer for the share dialog.
-   */
   customFooter?: React.ReactNode;
   onUserSelectionChange?: (value: Value) => void;
   shareFieldsFooter?: React.ReactNode;
@@ -383,71 +332,84 @@ export declare type ShareDialogContainerProps = {
   isPublicLink?: boolean;
   integrationMode?: IntegrationMode;
   shareIntegrations?: Array<Integration>;
-  /**
-   * Optionally sets a tabIndex value if you need to set focus
-   */
   tabIndex?: number;
   copyTooltipText?: string;
 };
 
-export declare type ShareError = {
+// @public (undocumented)
+export type ShareError = {
   message: string;
 };
 
-export declare type ShareRequest = (
+// @public (undocumented)
+export type ShareRequest = (
   content: Content,
   recipients: User[],
   metadata: MetaData,
   comment?: Comment_2,
 ) => Promise<ShareResponse>;
 
-export declare type ShareResponse = {
+// @public (undocumented)
+export type ShareResponse = {
   shareRequestId: string;
 };
 
-declare interface ShortenRequest {
+// @public (undocumented)
+interface ShortenRequest {
+  // (undocumented)
   cloudId?: string;
-  product: string;
-  type: string;
+  // (undocumented)
   params: Record<string, string>;
+  // (undocumented)
+  product: string;
+  // (undocumented)
   query?: string;
+  // (undocumented)
+  type: string;
 }
 
-declare interface ShortenResponse {
+// @public (undocumented)
+interface ShortenResponse {
+  // (undocumented)
   shortUrl: string;
 }
 
-declare type State = {
+// @public (undocumented)
+type State = {
   shouldShowCopiedMessage: boolean;
 };
 
-declare enum TabType {
+// @public (undocumented)
+enum TabType {
+  // (undocumented)
   default = 0,
+  // (undocumented)
   Slack = 1,
 }
 
-export declare type TooltipPosition =
-  | 'top'
-  | 'right'
-  | 'bottom'
-  | 'left'
-  | 'mouse';
+// @public (undocumented)
+export type TooltipPosition = 'top' | 'right' | 'bottom' | 'left' | 'mouse';
 
-declare interface UrlShortenerClient {
+// @public (undocumented)
+interface UrlShortenerClient {
+  // (undocumented)
   shorten(data: ShortenRequest): Promise<ShortenResponse>;
 }
 
-export declare type User = UserWithId | UserWithEmail;
+// @public (undocumented)
+export type User = UserWithId | UserWithEmail;
 
-export declare type UserWithEmail = {
+// @public (undocumented)
+export type UserWithEmail = {
   type: 'user';
   email: string;
 };
 
-export declare type UserWithId = {
+// @public (undocumented)
+export type UserWithId = {
   type: 'user' | 'group' | 'team';
   id: string;
 };
 
-export {};
+// (No @packageDocumentation comment for this package)
 ```