@atlaskit/link-create 0.9.1 → 0.10.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/link-create
 
+## 0.10.0
+
+### Minor Changes
+
+- [`dc546d1044a`](https://bitbucket.org/atlassian/atlassian-frontend/commits/dc546d1044a) - Update failure handler in link-create API to take Error instead of string, and fire analytics on failure
+
 ## 0.9.1
 
 ### Patch Changes

package/analytics.spec.yaml

@@ -83,3 +83,12 @@ events:
         objectType:
           type: string
           description: the type of created content
+
+  - object createFailed (linkCreate):
+      type: track
+      description: fired when the object creation fails
+      attributes:
+        <<: *PackageMetaDataContext
+        failureType:
+          type: string
+          description: the name of the failure

package/dist/cjs/common/utils/analytics/analytics.codegen.js

@@ -11,7 +11,7 @@ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/sli
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::6c4bc6f47b1cf9cb3a9a70cac9a93775>>
+ * @codegen <<SignedSource::50073590468fe2604f65d3e0b23d517b>>
  * @codegenCommand yarn workspace @atlaskit/link-create run codegen-analytics
  */
 

package/dist/cjs/controllers/callback-context/main.js

@@ -18,7 +18,7 @@ var LinkCreateCallbackContext = /*#__PURE__*/_react.default.createContext({});
 var LinkCreateCallbackProvider = function LinkCreateCallbackProvider(_ref) {
   var children = _ref.children,
     _onCreate = _ref.onCreate,
-    onFailure = _ref.onFailure,
+    _onFailure = _ref.onFailure,
     onCancel = _ref.onCancel;
   var _useAnalyticsEvents = (0, _analyticsNext.useAnalyticsEvents)(),
     createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
@@ -52,10 +52,29 @@ var LinkCreateCallbackProvider = function LinkCreateCallbackProvider(_ref) {
         }
         return onCreate;
       }(),
-      onFailure: onFailure,
+      onFailure: function () {
+        var _onFailure2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(error) {
+          return _regenerator.default.wrap(function _callee2$(_context2) {
+            while (1) switch (_context2.prev = _context2.next) {
+              case 0:
+                createAnalyticsEvent((0, _analytics.default)('track.object.createFailed.linkCreate', {
+                  failureType: error.name
+                })).fire(_constants.ANALYTICS_CHANNEL);
+                _onFailure && _onFailure(error);
+              case 2:
+              case "end":
+                return _context2.stop();
+            }
+          }, _callee2);
+        }));
+        function onFailure(_x2) {
+          return _onFailure2.apply(this, arguments);
+        }
+        return onFailure;
+      }(),
       onCancel: onCancel
     };
-  }, [onFailure, onCancel, createAnalyticsEvent, _onCreate]);
+  }, [_onFailure, onCancel, createAnalyticsEvent, _onCreate]);
   return /*#__PURE__*/_react.default.createElement(LinkCreateCallbackContext.Provider, {
     value: value
   }, children);

package/dist/cjs/ui/link-create/main.js

@@ -69,10 +69,10 @@ var LinkCreate = (0, _formContext.withLinkCreateFormContext)(function (_ref2) {
       return _ref3.apply(this, arguments);
     };
   }(), [onCreate, setFormErrorMessage]);
-  var handleFailure = (0, _react.useCallback)(function (errorMessage) {
+  var handleFailure = (0, _react.useCallback)(function (error) {
     // Set the form error message
-    setFormErrorMessage(errorMessage);
-    onFailure && onFailure(errorMessage);
+    setFormErrorMessage(error.message);
+    onFailure && onFailure(error);
   }, [onFailure, setFormErrorMessage]);
   return (0, _react2.jsx)("div", {
     "data-testid": testId

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/link-create",
-	"version": "0.9.1",
+	"version": "0.10.0",
 	"sideEffects": false
 }

package/dist/es2019/common/utils/analytics/analytics.codegen.js

@@ -3,7 +3,7 @@
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::6c4bc6f47b1cf9cb3a9a70cac9a93775>>
+ * @codegen <<SignedSource::50073590468fe2604f65d3e0b23d517b>>
  * @codegenCommand yarn workspace @atlaskit/link-create run codegen-analytics
  */
 

package/dist/es2019/controllers/callback-context/main.js

@@ -26,7 +26,12 @@ const LinkCreateCallbackProvider = ({
         await onCreate(result);
       }
     },
-    onFailure,
+    onFailure: async error => {
+      createAnalyticsEvent(createEventPayload('track.object.createFailed.linkCreate', {
+        failureType: error.name
+      })).fire(ANALYTICS_CHANNEL);
+      onFailure && onFailure(error);
+    },
     onCancel
   }), [onFailure, onCancel, createAnalyticsEvent, onCreate]);
   return /*#__PURE__*/React.createElement(LinkCreateCallbackContext.Provider, {

package/dist/es2019/ui/link-create/main.js

@@ -37,10 +37,10 @@ const LinkCreate = withLinkCreateFormContext(({
       await onCreate(result);
     }
   }, [onCreate, setFormErrorMessage]);
-  const handleFailure = useCallback(errorMessage => {
+  const handleFailure = useCallback(error => {
     // Set the form error message
-    setFormErrorMessage(errorMessage);
-    onFailure && onFailure(errorMessage);
+    setFormErrorMessage(error.message);
+    onFailure && onFailure(error);
   }, [onFailure, setFormErrorMessage]);
   return jsx("div", {
     "data-testid": testId

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/link-create",
-	"version": "0.9.1",
+	"version": "0.10.0",
 	"sideEffects": false
 }

package/dist/esm/common/utils/analytics/analytics.codegen.js

@@ -4,7 +4,7 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::6c4bc6f47b1cf9cb3a9a70cac9a93775>>
+ * @codegen <<SignedSource::50073590468fe2604f65d3e0b23d517b>>
  * @codegenCommand yarn workspace @atlaskit/link-create run codegen-analytics
  */
 

package/dist/esm/controllers/callback-context/main.js

@@ -8,7 +8,7 @@ var LinkCreateCallbackContext = /*#__PURE__*/React.createContext({});
 var LinkCreateCallbackProvider = function LinkCreateCallbackProvider(_ref) {
   var children = _ref.children,
     _onCreate = _ref.onCreate,
-    onFailure = _ref.onFailure,
+    _onFailure = _ref.onFailure,
     onCancel = _ref.onCancel;
   var _useAnalyticsEvents = useAnalyticsEvents(),
     createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
@@ -42,10 +42,29 @@ var LinkCreateCallbackProvider = function LinkCreateCallbackProvider(_ref) {
         }
         return onCreate;
       }(),
-      onFailure: onFailure,
+      onFailure: function () {
+        var _onFailure2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(error) {
+          return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+            while (1) switch (_context2.prev = _context2.next) {
+              case 0:
+                createAnalyticsEvent(createEventPayload('track.object.createFailed.linkCreate', {
+                  failureType: error.name
+                })).fire(ANALYTICS_CHANNEL);
+                _onFailure && _onFailure(error);
+              case 2:
+              case "end":
+                return _context2.stop();
+            }
+          }, _callee2);
+        }));
+        function onFailure(_x2) {
+          return _onFailure2.apply(this, arguments);
+        }
+        return onFailure;
+      }(),
       onCancel: onCancel
     };
-  }, [onFailure, onCancel, createAnalyticsEvent, _onCreate]);
+  }, [_onFailure, onCancel, createAnalyticsEvent, _onCreate]);
   return /*#__PURE__*/React.createElement(LinkCreateCallbackContext.Provider, {
     value: value
   }, children);

package/dist/esm/ui/link-create/main.js

@@ -58,10 +58,10 @@ var LinkCreate = withLinkCreateFormContext(function (_ref2) {
       return _ref3.apply(this, arguments);
     };
   }(), [onCreate, setFormErrorMessage]);
-  var handleFailure = useCallback(function (errorMessage) {
+  var handleFailure = useCallback(function (error) {
     // Set the form error message
-    setFormErrorMessage(errorMessage);
-    onFailure && onFailure(errorMessage);
+    setFormErrorMessage(error.message);
+    onFailure && onFailure(error);
   }, [onFailure, setFormErrorMessage]);
   return jsx("div", {
     "data-testid": testId

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/link-create",
-	"version": "0.9.1",
+	"version": "0.10.0",
 	"sideEffects": false
 }

package/dist/types/common/utils/analytics/analytics.codegen.d.ts

@@ -3,7 +3,7 @@
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::6c4bc6f47b1cf9cb3a9a70cac9a93775>>
+ * @codegen <<SignedSource::50073590468fe2604f65d3e0b23d517b>>
  * @codegenCommand yarn workspace @atlaskit/link-create run codegen-analytics
  */
 export type PackageMetaDataType = {
@@ -30,6 +30,9 @@ export type ObjectCreatedLinkCreateAttributesType = {
     objectId: string;
     objectType: string;
 };
+export type ObjectCreateFailedLinkCreateAttributesType = {
+    failureType: string;
+};
 type AnalyticsEventAttributes = {
     'screen.linkCreateScreen.viewed': LinkCreateScreenViewedAttributesType;
     'ui.button.clicked.create': ButtonClickedCreateAttributesType;
@@ -37,6 +40,7 @@ type AnalyticsEventAttributes = {
     'ui.modalDialog.closed.linkCreate': ModalDialogClosedLinkCreateAttributesType;
     'operational.linkCreate.unhandledErrorCaught': LinkCreateUnhandledErrorCaughtAttributesType;
     'track.object.created.linkCreate': ObjectCreatedLinkCreateAttributesType;
+    'track.object.createFailed.linkCreate': ObjectCreateFailedLinkCreateAttributesType;
 };
 declare function createEventPayload<K extends keyof AnalyticsEventAttributes>(eventKey: K, attributes: AnalyticsEventAttributes[K]): {
     eventType: string;

package/dist/types/controllers/callback-context/main.d.ts

@@ -8,7 +8,7 @@ interface LinkCreateCallbackProviderProps {
     /**
      * This callback for any errors
      */
-    onFailure?: (errorMessage: string) => void;
+    onFailure?: (error: Error) => void;
     /**
      * This callback for when the form was manually discarded by user
      */

package/dist/types-ts4.5/common/utils/analytics/analytics.codegen.d.ts

@@ -3,7 +3,7 @@
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::6c4bc6f47b1cf9cb3a9a70cac9a93775>>
+ * @codegen <<SignedSource::50073590468fe2604f65d3e0b23d517b>>
  * @codegenCommand yarn workspace @atlaskit/link-create run codegen-analytics
  */
 export type PackageMetaDataType = {
@@ -30,6 +30,9 @@ export type ObjectCreatedLinkCreateAttributesType = {
     objectId: string;
     objectType: string;
 };
+export type ObjectCreateFailedLinkCreateAttributesType = {
+    failureType: string;
+};
 type AnalyticsEventAttributes = {
     'screen.linkCreateScreen.viewed': LinkCreateScreenViewedAttributesType;
     'ui.button.clicked.create': ButtonClickedCreateAttributesType;
@@ -37,6 +40,7 @@ type AnalyticsEventAttributes = {
     'ui.modalDialog.closed.linkCreate': ModalDialogClosedLinkCreateAttributesType;
     'operational.linkCreate.unhandledErrorCaught': LinkCreateUnhandledErrorCaughtAttributesType;
     'track.object.created.linkCreate': ObjectCreatedLinkCreateAttributesType;
+    'track.object.createFailed.linkCreate': ObjectCreateFailedLinkCreateAttributesType;
 };
 declare function createEventPayload<K extends keyof AnalyticsEventAttributes>(eventKey: K, attributes: AnalyticsEventAttributes[K]): {
     eventType: string;

package/dist/types-ts4.5/controllers/callback-context/main.d.ts

@@ -8,7 +8,7 @@ interface LinkCreateCallbackProviderProps {
     /**
      * This callback for any errors
      */
-    onFailure?: (errorMessage: string) => void;
+    onFailure?: (error: Error) => void;
     /**
      * This callback for when the form was manually discarded by user
      */

package/example-helpers/mock-plugin-form.tsx

@@ -1,5 +1,7 @@
 import React, { useMemo } from 'react';
 
+import { OptionsType } from '@atlaskit/select';
+
 import {
   AsyncSelect,
   CreateForm,
@@ -7,8 +9,7 @@ import {
   TextField,
   useLinkCreateCallback,
   Validator,
-} from '@atlaskit/link-create';
-import { OptionsType } from '@atlaskit/select';
+} from '../src';
 
 interface pluginProps {
   shouldThrowError?: boolean;
@@ -54,7 +55,7 @@ export function MockPluginForm({ shouldThrowError }: pluginProps) {
       return exampleOptions;
     } catch (error) {
       if (error instanceof Error) {
-        onFailure && onFailure(error.message);
+        onFailure && onFailure(error);
       }
       return [];
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/link-create",
-  "version": "0.9.1",
+  "version": "0.10.0",
   "description": "The driver component of meta creation flow",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -54,7 +54,7 @@
   },
   "devDependencies": {
     "@af/visual-regression": "*",
-    "@atlaskit/link-test-helpers": "^4.1.0",
+    "@atlaskit/link-test-helpers": "^4.2.0",
     "@atlaskit/visual-regression": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
     "@testing-library/react": "^12.1.5",

package/report.api.md

@@ -108,7 +108,7 @@ export const LinkCreateCallbackProvider: React_2.FC<LinkCreateCallbackProviderPr
 interface LinkCreateCallbackProviderProps {
   onCancel?: () => void;
   onCreate?: (result: CreatePayload) => Promise<void> | void;
-  onFailure?: (errorMessage: string) => void;
+  onFailure?: (error: Error) => void;
 }
 
 // @public (undocumented)

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

@@ -0,0 +1,136 @@
+## API Report File for "@atlaskit/link-create"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+/// <reference types="react" />
+
+import { AsyncSelectProps as AsyncSelectProps_2 } from '@atlaskit/select';
+import { jsx } from '@emotion/react';
+import { MemoExoticComponent } from 'react';
+import { ModalDialogProps } from '@atlaskit/modal-dialog';
+import { OptionType } from '@atlaskit/select';
+import { default as React_2 } from 'react';
+import { ReactNode } from 'react';
+import { SpinnerProps } from '@atlaskit/spinner';
+import { TextFieldProps as TextFieldProps_2 } from '@atlaskit/textfield';
+
+// @public
+export function AsyncSelect<T = OptionType>({ label, name, validationHelpText, isRequired, testId, validators, defaultValue, ...rest }: AsyncSelectProps<T>): jsx.JSX.Element;
+
+// @public (undocumented)
+type AsyncSelectProps<T = OptionType> = AsyncSelectProps_2<T> & {
+    name: string;
+    label: string;
+    validationHelpText?: string;
+    testId?: string;
+    isRequired?: boolean;
+    validators?: Validator[];
+};
+
+// @public (undocumented)
+const ComposedLinkCreate: MemoExoticComponent<(props: LinkCreateWithModalProps) => jsx.JSX.Element>;
+export default ComposedLinkCreate;
+
+// @public (undocumented)
+export const CreateForm: <FormData_1 extends Record<string, any> = {}>({ children, testId, onSubmit, onCancel, isLoading, hideFooter, }: CreateFormProps<FormData_1>) => jsx.JSX.Element;
+
+// @public (undocumented)
+export function CreateFormLoader({ size }: Partial<SpinnerProps>): jsx.JSX.Element;
+
+// @public (undocumented)
+export interface CreateFormProps<FormData> {
+    // (undocumented)
+    children: ReactNode;
+    // (undocumented)
+    hideFooter?: boolean;
+    // (undocumented)
+    isLoading?: boolean;
+    // (undocumented)
+    onCancel?: () => void;
+    // (undocumented)
+    onSubmit: (data: FormData) => void;
+    // (undocumented)
+    testId?: string;
+}
+
+// @public
+export type CreatePayload = {
+    url: string;
+    objectId: string;
+    objectType: string;
+    data?: Record<string, unknown>;
+};
+
+// @public (undocumented)
+interface Group {
+    icon: string;
+    key: string;
+    label: string;
+}
+
+// @public (undocumented)
+export const LinkCreateCallbackProvider: React_2.FC<LinkCreateCallbackProviderProps>;
+
+// @public (undocumented)
+interface LinkCreateCallbackProviderProps {
+    onCancel?: () => void;
+    onCreate?: (result: CreatePayload) => Promise<void> | void;
+    onFailure?: (error: Error) => void;
+}
+
+// @public (undocumented)
+export interface LinkCreatePlugin {
+    form: ReactNode;
+    group: Group;
+    icon: string;
+    key: string;
+    label: string;
+}
+
+// @public (undocumented)
+export interface LinkCreateProps {
+    entityKey: string;
+    groupKey?: string;
+    onCancel?: () => void;
+    onCreate?: (payload: CreatePayload) => Promise<void> | void;
+    onFailure?: (error: unknown) => void;
+    // (undocumented)
+    plugins: LinkCreatePlugin[];
+    testId?: string;
+    triggeredFrom?: string;
+}
+
+// @public (undocumented)
+export interface LinkCreateWithModalProps extends LinkCreateProps, Partial<Pick<ModalDialogProps, 'onCloseComplete' | 'onOpenComplete'>> {
+    active?: boolean;
+    modalTitle?: string;
+}
+
+// @public
+export function TextField({ label, name, testId, validationHelpText, validators, defaultValue, isRequired, ...restProps }: TextFieldProps): jsx.JSX.Element;
+
+// @public (undocumented)
+type TextFieldProps = Omit<TextFieldProps_2, 'name'> & {
+    name: string;
+    label?: string;
+    validationHelpText?: string;
+    validators?: Validator[];
+};
+
+// @public (undocumented)
+export const useLinkCreateCallback: () => LinkCreateCallbackProviderProps;
+
+// @public (undocumented)
+export type Validator = {
+    isValid: (val: unknown) => boolean;
+    errorMessage: string;
+};
+
+// @public
+export type ValidatorMap = Record<string, Validator[]>;
+
+// (No @packageDocumentation comment for this package)
+
+```