@atlaskit/share 3.2.3 → 3.2.6

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/share
 
+## 3.2.6
+
+### Patch Changes
+
+- [`c58555a28e7`](https://bitbucket.org/atlassian/atlassian-frontend/commits/c58555a28e7) - Make the share component a functional component to work with storybook
+
+## 3.2.5
+
+### Patch Changes
+
+- [`0a61837e1ff`](https://bitbucket.org/atlassian/atlassian-frontend/commits/0a61837e1ff) - Bump patch version of smart-user-picker to support right context key for org ID
+
+## 3.2.4
+
+### Patch Changes
+
+- [`facf0749321`](https://bitbucket.org/atlassian/atlassian-frontend/commits/facf0749321) - improve FE analytics by ignoring 401, 403 and 429 status code
+
 ## 3.2.3
 
 ### Patch Changes

package/dist/cjs/components/ShareDialogContainer.js

@@ -47,6 +47,8 @@ var _i18n = require("../i18n");
 
 var _analytics = require("./analytics/analytics");
 
+var _ufoExperienceHelper = require("./analytics/ufoExperienceHelper");
+
 var _ufoExperiences = require("./analytics/ufoExperiences");
 
 var _ErrorBoundary = _interopRequireDefault(require("./ErrorBoundary"));
@@ -155,11 +157,7 @@ var ShareDialogContainerInternal = /*#__PURE__*/function (_React$Component) {
                   });
                 }
 
-                _ufoExperiences.renderShareDialogExp.failure({
-                  metadata: {
-                    error: errObj
-                  }
-                });
+                (0, _ufoExperienceHelper.isValidFailedExperience)(_ufoExperiences.renderShareDialogExp, errObj);
 
               case 15:
               case "end":

package/dist/cjs/components/ShareDialogWithTrigger.js

@@ -49,6 +49,8 @@ var _types = require("../types");
 
 var _analytics = require("./analytics/analytics");
 
+var _ufoExperienceHelper = require("./analytics/ufoExperienceHelper");
+
 var _ufoExperiences = require("./analytics/ufoExperiences");
 
 var _lazy = _interopRequireDefault(require("./LazyShareForm/lazy"));
@@ -309,14 +311,7 @@ var ShareDialogWithTriggerInternal = /*#__PURE__*/function (_React$PureComponent
           }
         });
 
-        _ufoExperiences.shareSubmitExp.failure({
-          metadata: {
-            error: {
-              message: err.message,
-              name: err.name
-            }
-          }
-        });
+        (0, _ufoExperienceHelper.isValidFailedExperience)(_ufoExperiences.shareSubmitExp, err);
       });
     });
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "handleFormDismiss", function (data) {

package/dist/cjs/components/analytics/analytics.js

@@ -19,7 +19,7 @@ var buildAttributes = function buildAttributes() {
   var attributes = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
   return _objectSpread({
     packageName: "@atlaskit/share",
-    packageVersion: "3.2.3"
+    packageVersion: "3.2.6"
   }, attributes);
 };
 

package/dist/cjs/components/analytics/ufoExperienceHelper.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isValidFailedExperience = void 0;
+var ignoredErrorStatusCode = [401, 403, 429];
+
+var isValidFailedExperience = function isValidFailedExperience(experience, error) {
+  var errorStatusCode = error.code || error.status || error.statusCode;
+
+  if (ignoredErrorStatusCode.includes(parseInt(errorStatusCode))) {
+    experience.abort({
+      metadata: {
+        error: error
+      }
+    });
+    return;
+  }
+
+  experience.failure({
+    metadata: {
+      error: error
+    }
+  });
+};
+
+exports.isValidFailedExperience = isValidFailedExperience;

package/dist/cjs/version.json

@@ -1,4 +1,4 @@
 {
 	"name": "@atlaskit/share",
-	"version": "3.2.3"
+	"version": "3.2.6"
 }

package/dist/es2019/components/ShareDialogContainer.js

@@ -9,6 +9,7 @@ import { AtlassianUrlShortenerClient } from '../clients/AtlassianUrlShortenerCli
 import { ShareServiceClient } from '../clients/ShareServiceClient';
 import { messages } from '../i18n';
 import { CHANNEL_ID, copyLinkButtonClicked, errorEncountered, shortUrlGenerated, shortUrlRequested } from './analytics/analytics';
+import { isValidFailedExperience } from './analytics/ufoExperienceHelper';
 import { renderShareDialogExp } from './analytics/ufoExperiences';
 import ErrorBoundary from './ErrorBoundary';
 import MessagesIntlProvider from './MessagesIntlProvider';
@@ -83,11 +84,7 @@ export class ShareDialogContainerInternal extends React.Component {
             };
           }
 
-          renderShareDialogExp.failure({
-            metadata: {
-              error: errObj
-            }
-          });
+          isValidFailedExperience(renderShareDialogExp, errObj);
         }
       });
     });

package/dist/es2019/components/ShareDialogWithTrigger.js

@@ -14,6 +14,7 @@ import { OBJECT_SHARED } from '../types';
 import { cancelShare, CHANNEL_ID, copyLinkButtonClicked, formShareSubmitted, screenEvent, shareSplitButtonEvent, shareTabClicked, shareTriggerButtonClicked // type TabSubjectIdType,
 } from './analytics/analytics'; // eslint-disable-next-line no-duplicate-imports
 
+import { isValidFailedExperience } from './analytics/ufoExperienceHelper';
 import { renderShareDialogExp, shareSubmitExp } from './analytics/ufoExperiences';
 import LazyShareFormLazy from './LazyShareForm/lazy';
 import ShareButton from './ShareButton';
@@ -259,14 +260,7 @@ export class ShareDialogWithTriggerInternal extends React.PureComponent {
             message: err.message
           }
         });
-        shareSubmitExp.failure({
-          metadata: {
-            error: {
-              message: err.message,
-              name: err.name
-            }
-          }
-        });
+        isValidFailedExperience(shareSubmitExp, err);
       });
     });
 

package/dist/es2019/components/analytics/analytics.js

@@ -2,7 +2,7 @@ import { isEmail, isTeam, isUser } from '@atlaskit/smart-user-picker';
 
 const buildAttributes = (attributes = {}) => ({
   packageName: "@atlaskit/share",
-  packageVersion: "3.2.3",
+  packageVersion: "3.2.6",
   ...attributes
 });
 

package/dist/es2019/components/analytics/ufoExperienceHelper.js

@@ -0,0 +1,19 @@
+const ignoredErrorStatusCode = [401, 403, 429];
+export const isValidFailedExperience = (experience, error) => {
+  const errorStatusCode = error.code || error.status || error.statusCode;
+
+  if (ignoredErrorStatusCode.includes(parseInt(errorStatusCode))) {
+    experience.abort({
+      metadata: {
+        error
+      }
+    });
+    return;
+  }
+
+  experience.failure({
+    metadata: {
+      error
+    }
+  });
+};

package/dist/es2019/version.json

@@ -1,4 +1,4 @@
 {
 	"name": "@atlaskit/share",
-	"version": "3.2.3"
+	"version": "3.2.6"
 }

package/dist/esm/clients/AtlassianUrlShortenerClient.js

@@ -1,7 +1,7 @@
-import _regeneratorRuntime from "@babel/runtime/regenerator";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
 export var AtlassianUrlShortenerClient = /*#__PURE__*/function () {
   function AtlassianUrlShortenerClient() {
     _classCallCheck(this, AtlassianUrlShortenerClient);

package/dist/esm/components/ShareDialogContainer.js

@@ -1,4 +1,3 @@
-import _regeneratorRuntime from "@babel/runtime/regenerator";
 import _extends from "@babel/runtime/helpers/extends";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
@@ -8,6 +7,7 @@ import _inherits from "@babel/runtime/helpers/inherits";
 import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
 import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
 
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
@@ -27,6 +27,7 @@ import { AtlassianUrlShortenerClient } from '../clients/AtlassianUrlShortenerCli
 import { ShareServiceClient } from '../clients/ShareServiceClient';
 import { messages } from '../i18n';
 import { CHANNEL_ID, copyLinkButtonClicked, errorEncountered, shortUrlGenerated, shortUrlRequested } from './analytics/analytics';
+import { isValidFailedExperience } from './analytics/ufoExperienceHelper';
 import { renderShareDialogExp } from './analytics/ufoExperiences';
 import ErrorBoundary from './ErrorBoundary';
 import MessagesIntlProvider from './MessagesIntlProvider';
@@ -123,11 +124,7 @@ export var ShareDialogContainerInternal = /*#__PURE__*/function (_React$Componen
                   });
                 }
 
-                renderShareDialogExp.failure({
-                  metadata: {
-                    error: errObj
-                  }
-                });
+                isValidFailedExperience(renderShareDialogExp, errObj);
 
               case 15:
               case "end":

package/dist/esm/components/ShareDialogWithTrigger.js

@@ -32,6 +32,7 @@ import { OBJECT_SHARED } from '../types';
 import { cancelShare, CHANNEL_ID, copyLinkButtonClicked, formShareSubmitted, screenEvent, shareSplitButtonEvent, shareTabClicked, shareTriggerButtonClicked // type TabSubjectIdType,
 } from './analytics/analytics'; // eslint-disable-next-line no-duplicate-imports
 
+import { isValidFailedExperience } from './analytics/ufoExperienceHelper';
 import { renderShareDialogExp, shareSubmitExp } from './analytics/ufoExperiences';
 import LazyShareFormLazy from './LazyShareForm/lazy';
 import ShareButton from './ShareButton';
@@ -286,14 +287,7 @@ export var ShareDialogWithTriggerInternal = /*#__PURE__*/function (_React$PureCo
           }
         });
 
-        shareSubmitExp.failure({
-          metadata: {
-            error: {
-              message: err.message,
-              name: err.name
-            }
-          }
-        });
+        isValidFailedExperience(shareSubmitExp, err);
       });
     });
 

package/dist/esm/components/analytics/analytics.js

@@ -10,7 +10,7 @@ var buildAttributes = function buildAttributes() {
   var attributes = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
   return _objectSpread({
     packageName: "@atlaskit/share",
-    packageVersion: "3.2.3"
+    packageVersion: "3.2.6"
   }, attributes);
 };
 

package/dist/esm/components/analytics/ufoExperienceHelper.js

@@ -0,0 +1,19 @@
+var ignoredErrorStatusCode = [401, 403, 429];
+export var isValidFailedExperience = function isValidFailedExperience(experience, error) {
+  var errorStatusCode = error.code || error.status || error.statusCode;
+
+  if (ignoredErrorStatusCode.includes(parseInt(errorStatusCode))) {
+    experience.abort({
+      metadata: {
+        error: error
+      }
+    });
+    return;
+  }
+
+  experience.failure({
+    metadata: {
+      error: error
+    }
+  });
+};

package/dist/esm/version.json

@@ -1,4 +1,4 @@
 {
 	"name": "@atlaskit/share",
-	"version": "3.2.3"
+	"version": "3.2.6"
 }

package/dist/types/components/analytics/ufoExperienceHelper.d.ts

@@ -0,0 +1,2 @@
+import { UFOExperience } from '@atlaskit/ufo';
+export declare const isValidFailedExperience: (experience: UFOExperience, error: any) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/share",
-  "version": "3.2.3",
+  "version": "3.2.6",
   "description": "Fabric Share Element",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -37,7 +37,7 @@
     "@atlaskit/icon": "^21.10.0",
     "@atlaskit/popup": "^1.3.0",
     "@atlaskit/portal": "^4.0.0",
-    "@atlaskit/smart-user-picker": "^5.1.0",
+    "@atlaskit/smart-user-picker": "^5.1.2",
     "@atlaskit/spinner": "^15.1.4",
     "@atlaskit/tabs": "^13.2.3",
     "@atlaskit/textarea": "^4.3.0",
@@ -45,7 +45,7 @@
     "@atlaskit/tokens": "^0.10.0",
     "@atlaskit/tooltip": "^17.5.0",
     "@atlaskit/ufo": "^0.1.0",
-    "@atlaskit/user-picker": "^9.1.0",
+    "@atlaskit/user-picker": "^9.2.0",
     "@atlaskit/util-service-support": "^6.1.0",
     "@babel/runtime": "^7.0.0",
     "fast-deep-equal": "^3.1.1",
@@ -61,7 +61,7 @@
   "devDependencies": {
     "@atlaskit/docs": "^9.0.0",
     "@atlaskit/editor-test-helpers": "^17.0.0",
-    "@atlaskit/flag": "^14.5.0",
+    "@atlaskit/flag": "^14.6.0",
     "@atlaskit/section-message": "^6.0.0",
     "@atlaskit/select": "^15.3.0",
     "@atlaskit/toggle": "^12.4.0",

package/report.api.md

@@ -0,0 +1,313 @@
+## API Report File for "@atlaskit/share"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+/// <reference types="react" />
+
+import type { Appearance } from '@atlaskit/button/types';
+import type { IconProps } from '@atlaskit/icon';
+import type { LoadOptions } from '@atlaskit/smart-user-picker';
+import { OptionData } from '@atlaskit/smart-user-picker';
+import type { Placement } from '@atlaskit/popper';
+import { default as React_2 } from 'react';
+import type { TriggerProps } from '@atlaskit/popup';
+import type { Value } from '@atlaskit/smart-user-picker';
+import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
+
+// @public (undocumented)
+export const ADMIN_NOTIFIED = 'admin-notified';
+
+// @public (undocumented)
+type Comment_2 = {
+  format: 'plain_text' | 'adf';
+  value: string;
+};
+export { Comment_2 as Comment };
+
+// @public (undocumented)
+export type ConfigResponse = {
+  disableSharingToEmails?: boolean;
+};
+
+// @public (undocumented)
+export type Content = {
+  ari: string;
+  link: string;
+  title: string;
+  type: string;
+};
+
+// @public (undocumented)
+export type DialogContentState = {
+  users: OptionData[];
+  comment: Comment_2;
+};
+
+// @public (undocumented)
+export type DialogPlacement = Placement;
+
+// @public (undocumented)
+export type Flag = {
+  appearance: 'success';
+  title: MessageDescriptor;
+  type: FlagType;
+};
+
+// @public (undocumented)
+export type FlagType = 'object-shared' | 'admin-notified';
+
+// @public (undocumented)
+export type FormChildrenArgs<T> = {
+  formProps: React.DetailedHTMLProps<
+    React.FormHTMLAttributes<HTMLFormElement>,
+    HTMLFormElement
+  >;
+  getValues: () => T;
+};
+
+// @public (undocumented)
+export type KeysOfType<T, TProp> = {
+  [P in keyof T]: T[P] extends TProp ? P : never;
+}[keyof T];
+
+// @public (undocumented)
+export type MessageDescriptor = {
+  id: string;
+  description: string;
+  defaultMessage: string;
+};
+
+// @public (undocumented)
+export type MetaData = {
+  productId: string;
+  atlOriginId: string;
+  shareeAction?: 'view' | 'edit';
+};
+
+// @public (undocumented)
+export const OBJECT_SHARED = 'object-shared';
+
+// @public (undocumented)
+export type OriginAnalyticAttributes = {
+  hasGeneratedId: boolean;
+};
+
+// @public (undocumented)
+export type OriginTracing = {
+  id: string;
+  addToUrl: (link: string) => string;
+  toAnalyticsAttributes: (
+    attrs: OriginAnalyticAttributes,
+  ) => OriginTracingWithIdGenerated | OriginTracingForSubSequentEvents;
+};
+
+// @public (undocumented)
+export type OriginTracingFactory = () => OriginTracing;
+
+// @public (undocumented)
+export type OriginTracingForSubSequentEvents = {
+  originId: string;
+  originProduct: string;
+};
+
+// @public (undocumented)
+export type OriginTracingWithIdGenerated = {
+  originIdGenerated: string;
+  originProduct: string;
+};
+
+// @public
+export type ProductId =
+  | 'bitbucket'
+  | 'confluence'
+  | 'jira-addon'
+  | 'jira-core'
+  | 'jira-platform'
+  | 'jira-polaris'
+  | 'jira-portfolio'
+  | 'jira-servicedesk'
+  | 'jira-software'
+  | 'jira-unknown'
+  | 'trello';
+
+// @public (undocumented)
+export type ProductName = 'jira' | 'confluence';
+
+// @public (undocumented)
+export type RenderCustomTriggerButton = (
+  args: {
+    error?: ShareError;
+    isDisabled?: boolean;
+    isSelected?: boolean;
+    onClick: () => void;
+  },
+  triggerProps: TriggerProps,
+) => React.ReactNode;
+
+// @public (undocumented)
+export type ShareButtonStyle = 'icon-only' | 'icon-with-text' | 'text-only';
+
+// @public (undocumented)
+export type ShareContentState = {
+  users: User[];
+  comment?: Comment_2;
+};
+
+// @public (undocumented)
+export const ShareDialogContainer: React_2.ForwardRefExoticComponent<
+  Pick<
+    Omit<
+      WithAnalyticsEventsProps & ShareDialogContainerProps,
+      keyof WithAnalyticsEventsProps
+    >,
+    | 'onTriggerButtonClick'
+    | 'isAutoOpenDialog'
+    | 'shouldCloseOnEscapePress'
+    | 'dialogPlacement'
+    | 'loadUserOptions'
+    | 'onDialogOpen'
+    | 'onDialogClose'
+    | 'onUserSelectionChange'
+    | 'renderCustomTriggerButton'
+    | 'shareContentType'
+    | 'shareFormTitle'
+    | 'shareFormHelperMessage'
+    | 'showFlags'
+    | 'loggedInAccountId'
+    | 'triggerButtonAppearance'
+    | 'triggerButtonIcon'
+    | 'triggerButtonStyle'
+    | 'triggerButtonTooltipPosition'
+    | 'triggerButtonTooltipText'
+    | 'cloudId'
+    | 'bottomMessage'
+    | 'customFooter'
+    | 'isCopyDisabled'
+    | 'isPublicLink'
+    | 'integrationMode'
+    | 'shareFieldsFooter'
+    | 'shareIntegrations'
+    | 'shareAri'
+    | 'tabIndex'
+    | 'copyTooltipText'
+    | 'dialogZIndex'
+    | 'orgId'
+    | 'shareClient'
+    | 'urlShortenerClient'
+    | 'shortLinkData'
+    | 'formatCopyLink'
+    | 'originTracingFactory'
+    | 'productId'
+    | 'shareLink'
+    | 'shareTitle'
+    | 'useUrlShortener'
+  > &
+    Partial<
+      Pick<
+        Omit<
+          WithAnalyticsEventsProps & ShareDialogContainerProps,
+          keyof WithAnalyticsEventsProps
+        >,
+        'enableSmartUserPicker' | 'product' | 'shareeAction'
+      >
+    > &
+    Partial<
+      Pick<
+        {
+          enableSmartUserPicker: boolean;
+          shareeAction: 'view' | 'edit';
+          product: string;
+        },
+        never
+      >
+    > &
+    React_2.RefAttributes<any>
+>;
+
+// @public (undocumented)
+export type ShareDialogContainerProps = {
+  onTriggerButtonClick?: () => void;
+  onDialogOpen?: () => void;
+  onDialogClose?: () => void;
+  isAutoOpenDialog?: boolean;
+  shareClient?: ShareClient;
+  urlShortenerClient?: UrlShortenerClient;
+  shortLinkData?: ShortenRequest;
+  cloudId: string;
+  orgId?: string;
+  dialogPlacement?: DialogPlacement;
+  dialogZIndex?: number;
+  formatCopyLink?: (origin: OriginTracing, link: string) => string;
+  loadUserOptions?: LoadOptions;
+  originTracingFactory: OriginTracingFactory;
+  productId: ProductId;
+  renderCustomTriggerButton?: RenderCustomTriggerButton;
+  shareAri: string;
+  shareContentType: string;
+  shareLink?: string;
+  shareTitle: string;
+  shareFormTitle?: React.ReactNode;
+  shareFormHelperMessage?: string;
+  shouldCloseOnEscapePress?: boolean;
+  showFlags: (flags: Array<Flag>) => void;
+  enableSmartUserPicker?: boolean;
+  loggedInAccountId?: string;
+  triggerButtonAppearance?: Appearance;
+  triggerButtonIcon?: React.ComponentType<IconProps>;
+  triggerButtonStyle?: ShareButtonStyle;
+  triggerButtonTooltipPosition?: TooltipPosition;
+  triggerButtonTooltipText?: React.ReactNode;
+  bottomMessage?: React.ReactNode;
+  useUrlShortener?: boolean;
+  shareeAction?: 'view' | 'edit';
+  product?: ProductName;
+  customFooter?: React.ReactNode;
+  onUserSelectionChange?: (value: Value) => void;
+  shareFieldsFooter?: React.ReactNode;
+  isCopyDisabled?: boolean;
+  isPublicLink?: boolean;
+  integrationMode?: IntegrationMode;
+  shareIntegrations?: Array<Integration>;
+  tabIndex?: number;
+  copyTooltipText?: string;
+};
+
+// @public (undocumented)
+export type ShareError = {
+  message: string;
+};
+
+// @public (undocumented)
+export type ShareRequest = (
+  content: Content,
+  recipients: User[],
+  metadata: MetaData,
+  comment?: Comment_2,
+) => Promise<ShareResponse>;
+
+// @public (undocumented)
+export type ShareResponse = {
+  shareRequestId: string;
+};
+
+// @public (undocumented)
+export type TooltipPosition = 'top' | 'right' | 'bottom' | 'left' | 'mouse';
+
+// @public (undocumented)
+export type User = UserWithId | UserWithEmail;
+
+// @public (undocumented)
+export type UserWithEmail = {
+  type: 'user';
+  email: string;
+};
+
+// @public (undocumented)
+export type UserWithId = {
+  type: 'user' | 'group' | 'team';
+  id: string;
+};
+
+// (No @packageDocumentation comment for this package)
+```