@commercetools-frontend/actions-global 21.0.0 → 21.3.4

package/dist/commercetools-frontend-actions-global.cjs.dev.js

@@ -37,7 +37,7 @@ var _Object$defineProperty__default = /*#__PURE__*/_interopDefault(_Object$defin
 var isNumber__default = /*#__PURE__*/_interopDefault(isNumber);
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "21.0.0";
+var version = "21.3.4";
 
 function ownKeys$1(object, enumerableOnly) { var keys = _Object$keys__default["default"](object); if (_Object$getOwnPropertySymbols__default["default"]) { var symbols = _Object$getOwnPropertySymbols__default["default"](object); enumerableOnly && (symbols = _filterInstanceProperty__default["default"](symbols).call(symbols, function (sym) { return _Object$getOwnPropertyDescriptor__default["default"](object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
@@ -138,13 +138,6 @@ function hideAllPageNotifications() {
 function ownKeys(object, enumerableOnly) { var keys = _Object$keys__default["default"](object); if (_Object$getOwnPropertySymbols__default["default"]) { var symbols = _Object$getOwnPropertySymbols__default["default"](object); enumerableOnly && (symbols = _filterInstanceProperty__default["default"](symbols).call(symbols, function (sym) { return _Object$getOwnPropertyDescriptor__default["default"](object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var _context, _context2; var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? _forEachInstanceProperty__default["default"](_context = ownKeys(Object(source), !0)).call(_context, function (key) { _defineProperty(target, key, source[key]); }) : _Object$getOwnPropertyDescriptors__default["default"] ? _Object$defineProperties__default["default"](target, _Object$getOwnPropertyDescriptors__default["default"](source)) : _forEachInstanceProperty__default["default"](_context2 = ownKeys(Object(source))).call(_context2, function (key) { _Object$defineProperty__default["default"](target, key, _Object$getOwnPropertyDescriptor__default["default"](source, key)); }); } return target; }
-// a speficic notification.
-// Example:
-//   const showSuccessNotification = useShowNotification({
-//     domain: NOTIFICATION_DOMAINS.SIDE,
-//     kind: NOTIFICATION_KINDS_SIDE.success,
-//   });
-//   showSuccessNotification({ text: "All good!" });
 
 function useShowNotification(notificationFragment) {
   var dispatch = reactRedux.useDispatch();
@@ -154,9 +147,13 @@ function useShowNotification(notificationFragment) {
   }, [dispatch, notificationFragment]);
 }
 
-// Example:
-//   const showApiErrorNotification = useShowApiErrorNotification();
-//   showApiErrorNotification({ errors });
+/**
+ * Dispatch an API error notification.
+ *
+ * @example
+ * const showApiErrorNotification = useShowApiErrorNotification();
+ * showApiErrorNotification({ errors });
+ */
 
 function useShowApiErrorNotification() {
   var dispatch = reactRedux.useDispatch();
@@ -165,9 +162,13 @@ function useShowApiErrorNotification() {
   }, [dispatch]);
 }
 
-// Example:
-//   const showUnexpectedErrorNotification = useShowUnexpectedErrorNotification();
-//   showUnexpectedErrorNotification({ error });
+/**
+ * Dispatch an unexpected error notification.
+ *
+ * @example
+ * const showUnexpectedErrorNotification = useShowUnexpectedErrorNotification();
+ * showUnexpectedErrorNotification({ errors });
+ */
 
 function useShowUnexpectedErrorNotification() {
   var dispatch = reactRedux.useDispatch();

package/dist/commercetools-frontend-actions-global.cjs.prod.js

@@ -35,7 +35,7 @@ var _Object$defineProperty__default = /*#__PURE__*/_interopDefault(_Object$defin
 var isNumber__default = /*#__PURE__*/_interopDefault(isNumber);
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "21.0.0";
+var version = "21.3.4";
 
 function ownKeys$1(object, enumerableOnly) { var keys = _Object$keys__default["default"](object); if (_Object$getOwnPropertySymbols__default["default"]) { var symbols = _Object$getOwnPropertySymbols__default["default"](object); enumerableOnly && (symbols = _filterInstanceProperty__default["default"](symbols).call(symbols, function (sym) { return _Object$getOwnPropertyDescriptor__default["default"](object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
@@ -129,13 +129,6 @@ function hideAllPageNotifications() {
 function ownKeys(object, enumerableOnly) { var keys = _Object$keys__default["default"](object); if (_Object$getOwnPropertySymbols__default["default"]) { var symbols = _Object$getOwnPropertySymbols__default["default"](object); enumerableOnly && (symbols = _filterInstanceProperty__default["default"](symbols).call(symbols, function (sym) { return _Object$getOwnPropertyDescriptor__default["default"](object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var _context, _context2; var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? _forEachInstanceProperty__default["default"](_context = ownKeys(Object(source), !0)).call(_context, function (key) { _defineProperty(target, key, source[key]); }) : _Object$getOwnPropertyDescriptors__default["default"] ? _Object$defineProperties__default["default"](target, _Object$getOwnPropertyDescriptors__default["default"](source)) : _forEachInstanceProperty__default["default"](_context2 = ownKeys(Object(source))).call(_context2, function (key) { _Object$defineProperty__default["default"](target, key, _Object$getOwnPropertyDescriptor__default["default"](source, key)); }); } return target; }
-// a speficic notification.
-// Example:
-//   const showSuccessNotification = useShowNotification({
-//     domain: NOTIFICATION_DOMAINS.SIDE,
-//     kind: NOTIFICATION_KINDS_SIDE.success,
-//   });
-//   showSuccessNotification({ text: "All good!" });
 
 function useShowNotification(notificationFragment) {
   var dispatch = reactRedux.useDispatch();
@@ -145,9 +138,13 @@ function useShowNotification(notificationFragment) {
   }, [dispatch, notificationFragment]);
 }
 
-// Example:
-//   const showApiErrorNotification = useShowApiErrorNotification();
-//   showApiErrorNotification({ errors });
+/**
+ * Dispatch an API error notification.
+ *
+ * @example
+ * const showApiErrorNotification = useShowApiErrorNotification();
+ * showApiErrorNotification({ errors });
+ */
 
 function useShowApiErrorNotification() {
   var dispatch = reactRedux.useDispatch();
@@ -156,9 +153,13 @@ function useShowApiErrorNotification() {
   }, [dispatch]);
 }
 
-// Example:
-//   const showUnexpectedErrorNotification = useShowUnexpectedErrorNotification();
-//   showUnexpectedErrorNotification({ error });
+/**
+ * Dispatch an unexpected error notification.
+ *
+ * @example
+ * const showUnexpectedErrorNotification = useShowUnexpectedErrorNotification();
+ * showUnexpectedErrorNotification({ errors });
+ */
 
 function useShowUnexpectedErrorNotification() {
   var dispatch = reactRedux.useDispatch();

package/dist/commercetools-frontend-actions-global.esm.js

@@ -18,7 +18,7 @@ import { useCallback } from 'react';
 import { useDispatch } from 'react-redux';
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "21.0.0";
+var version = "21.3.4";
 
 function ownKeys$1(object, enumerableOnly) { var keys = _Object$keys(object); if (_Object$getOwnPropertySymbols) { var symbols = _Object$getOwnPropertySymbols(object); enumerableOnly && (symbols = _filterInstanceProperty(symbols).call(symbols, function (sym) { return _Object$getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
@@ -119,13 +119,6 @@ function hideAllPageNotifications() {
 function ownKeys(object, enumerableOnly) { var keys = _Object$keys(object); if (_Object$getOwnPropertySymbols) { var symbols = _Object$getOwnPropertySymbols(object); enumerableOnly && (symbols = _filterInstanceProperty(symbols).call(symbols, function (sym) { return _Object$getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var _context, _context2; var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? _forEachInstanceProperty(_context = ownKeys(Object(source), !0)).call(_context, function (key) { _defineProperty(target, key, source[key]); }) : _Object$getOwnPropertyDescriptors ? _Object$defineProperties(target, _Object$getOwnPropertyDescriptors(source)) : _forEachInstanceProperty(_context2 = ownKeys(Object(source))).call(_context2, function (key) { _Object$defineProperty(target, key, _Object$getOwnPropertyDescriptor(source, key)); }); } return target; }
-// a speficic notification.
-// Example:
-//   const showSuccessNotification = useShowNotification({
-//     domain: NOTIFICATION_DOMAINS.SIDE,
-//     kind: NOTIFICATION_KINDS_SIDE.success,
-//   });
-//   showSuccessNotification({ text: "All good!" });
 
 function useShowNotification(notificationFragment) {
   var dispatch = useDispatch();
@@ -135,9 +128,13 @@ function useShowNotification(notificationFragment) {
   }, [dispatch, notificationFragment]);
 }
 
-// Example:
-//   const showApiErrorNotification = useShowApiErrorNotification();
-//   showApiErrorNotification({ errors });
+/**
+ * Dispatch an API error notification.
+ *
+ * @example
+ * const showApiErrorNotification = useShowApiErrorNotification();
+ * showApiErrorNotification({ errors });
+ */
 
 function useShowApiErrorNotification() {
   var dispatch = useDispatch();
@@ -146,9 +143,13 @@ function useShowApiErrorNotification() {
   }, [dispatch]);
 }
 
-// Example:
-//   const showUnexpectedErrorNotification = useShowUnexpectedErrorNotification();
-//   showUnexpectedErrorNotification({ error });
+/**
+ * Dispatch an unexpected error notification.
+ *
+ * @example
+ * const showUnexpectedErrorNotification = useShowUnexpectedErrorNotification();
+ * showUnexpectedErrorNotification({ errors });
+ */
 
 function useShowUnexpectedErrorNotification() {
   var dispatch = useDispatch();

package/dist/declarations/src/actions/handle-action-error.d.ts

@@ -11,5 +11,17 @@ declare type ApiError = {
 };
 export declare type ActionError = Error | ApiError;
 export declare type DispatchActionError = ThunkDispatch<null, null, ReturnType<typeof showApiErrorNotification> | ReturnType<typeof showUnexpectedErrorNotification>>;
-export default function handleActionError(error: ActionError): (dispatch: DispatchActionError) => import("@commercetools-frontend/notifications").TAddNotificationAction<Pick<import("..").TApiErrorNotification, "id">> | null;
+export default function handleActionError(error: ActionError): (dispatch: DispatchActionError) => import("@commercetools-frontend/notifications").TAddNotificationAction<import("@commercetools-frontend/constants").TAppNotificationOfDomain & {
+    kind: import("@commercetools-frontend/constants").TAppNotificationKindPage;
+} & {
+    id: number;
+    text?: undefined;
+    values?: import("@commercetools-frontend/constants").TAppNotificationValuesApiError<{}> | undefined;
+} & import("@commercetools-frontend/notifications").TNotification> | import("@commercetools-frontend/notifications").TAddNotificationAction<import("@commercetools-frontend/constants").TAppNotificationOfDomain & {
+    kind: import("@commercetools-frontend/constants").TAppNotificationKindPage;
+} & {
+    id: number;
+    text?: undefined;
+    values?: import("@commercetools-frontend/constants").TAppNotificationValuesUnexpectedError | undefined;
+} & import("@commercetools-frontend/notifications").TNotification> | null;
 export {};

package/dist/declarations/src/actions/show-api-error-notification.d.ts

@@ -1,2 +1,8 @@
-import type { TApiErrorNotification, TApiErrorNotificationOptions } from '../types';
-export default function showApiErrorNotification({ errors, }: TApiErrorNotificationOptions): import("@commercetools-frontend/notifications").TAddNotificationAction<Pick<TApiErrorNotification, "id">>;
+import type { TApiErrorNotificationOptions } from '../types';
+export default function showApiErrorNotification({ errors, }: TApiErrorNotificationOptions): import("@commercetools-frontend/notifications").TAddNotificationAction<import("@commercetools-frontend/constants").TAppNotificationOfDomain & {
+    kind: import("@commercetools-frontend/constants").TAppNotificationKindPage;
+} & {
+    id: number;
+    text?: undefined;
+    values?: import("@commercetools-frontend/constants").TAppNotificationValuesApiError<{}> | undefined;
+} & import("@commercetools-frontend/notifications").TNotification>;

package/dist/declarations/src/actions/show-notification.d.ts

@@ -1,3 +1,3 @@
-import type { TNotificationMetaOptions } from '@commercetools-frontend/notifications';
+import type { TNotificationMetaOptions, TNotification } from '@commercetools-frontend/notifications';
 import type { TShowNotification } from '../types';
-export default function showNotification<Notification extends TShowNotification>(notification: Notification, meta?: TNotificationMetaOptions): import("@commercetools-frontend/notifications").TAddNotificationAction<Pick<Notification, "id">>;
+export default function showNotification<Notification extends TShowNotification>(notification: Notification, meta?: TNotificationMetaOptions): import("@commercetools-frontend/notifications").TAddNotificationAction<Notification & TNotification>;

package/dist/declarations/src/actions/show-unexpected-error-notification.d.ts

@@ -1,3 +1,8 @@
 import type { TAppNotificationValuesUnexpectedError } from '@commercetools-frontend/constants';
-import type { TUnexpectedErrorNotification } from '../types';
-export default function showUnexpectedErrorNotification({ errorId, }?: TAppNotificationValuesUnexpectedError): import("@commercetools-frontend/notifications").TAddNotificationAction<Pick<TUnexpectedErrorNotification, "id">>;
+export default function showUnexpectedErrorNotification({ errorId, }?: TAppNotificationValuesUnexpectedError): import("@commercetools-frontend/notifications").TAddNotificationAction<import("@commercetools-frontend/constants").TAppNotificationOfDomain & {
+    kind: import("@commercetools-frontend/constants").TAppNotificationKindPage;
+} & {
+    id: number;
+    text?: undefined;
+    values?: TAppNotificationValuesUnexpectedError | undefined;
+} & import("@commercetools-frontend/notifications").TNotification>;

package/dist/declarations/src/hooks/use-on-action-error.d.ts

@@ -1,2 +1,14 @@
 import type { ActionError } from '../actions/handle-action-error';
-export default function useOnActionError(): (error: ActionError) => (dispatch: import("../actions/handle-action-error").DispatchActionError) => import("@commercetools-frontend/notifications").TAddNotificationAction<Pick<import("..").TApiErrorNotification, "id">> | null;
+export default function useOnActionError(): (error: ActionError) => (dispatch: import("../actions/handle-action-error").DispatchActionError) => import("@commercetools-frontend/notifications").TAddNotificationAction<import("@commercetools-frontend/constants").TAppNotificationOfDomain & {
+    kind: import("@commercetools-frontend/constants").TAppNotificationKindPage;
+} & {
+    id: number;
+    text?: undefined;
+    values?: import("@commercetools-frontend/constants").TAppNotificationValuesApiError<{}> | undefined;
+} & import("@commercetools-frontend/notifications").TNotification> | import("@commercetools-frontend/notifications").TAddNotificationAction<import("@commercetools-frontend/constants").TAppNotificationOfDomain & {
+    kind: import("@commercetools-frontend/constants").TAppNotificationKindPage;
+} & {
+    id: number;
+    text?: undefined;
+    values?: import("@commercetools-frontend/constants").TAppNotificationValuesUnexpectedError | undefined;
+} & import("@commercetools-frontend/notifications").TNotification> | null;

package/dist/declarations/src/hooks/use-show-api-error-notification.d.ts

@@ -1,2 +1,8 @@
 import type { TApiErrorNotificationOptions } from '../types';
-export default function useShowApiErrorNotification(): (options: TApiErrorNotificationOptions) => import("@commercetools-frontend/notifications").TAddNotificationAction<Pick<import("../types").TApiErrorNotification, "id">>;
+export default function useShowApiErrorNotification(): (options: TApiErrorNotificationOptions) => import("@commercetools-frontend/notifications").TAddNotificationAction<import("@commercetools-frontend/constants").TAppNotificationOfDomain & {
+    kind: import("@commercetools-frontend/constants").TAppNotificationKindPage;
+} & {
+    id: number;
+    text?: undefined;
+    values?: import("@commercetools-frontend/constants").TAppNotificationValuesApiError<{}> | undefined;
+} & import("@commercetools-frontend/notifications").TNotification>;

package/dist/declarations/src/hooks/use-show-notification.d.ts

@@ -1,3 +1,6 @@
-import type { TNotificationMetaOptions } from '@commercetools-frontend/notifications';
+import type { TNotificationMetaOptions, TAddNotificationAction, TNotification } from '@commercetools-frontend/notifications';
 import type { TShowNotification } from '../types';
-export default function useShowNotification<Notification extends TShowNotification>(notificationFragment?: Partial<Notification>): (content: Notification, meta?: TNotificationMetaOptions | undefined) => import("@commercetools-frontend/notifications").TAddNotificationAction<Pick<Notification, "id">>;
+declare type TNotificationHook<Notification extends TShowNotification> = (content: Notification, meta?: TNotificationMetaOptions) => TAddNotificationAction<Notification & TNotification>;
+declare function useShowNotification<Notification extends TShowNotification>(): TNotificationHook<Notification>;
+declare function useShowNotification<Notification extends TShowNotification>(notificationFragment: Partial<Notification>): TNotificationHook<Notification>;
+export default useShowNotification;

package/dist/declarations/src/hooks/use-show-unexpected-error-notification.d.ts

@@ -1,2 +1,8 @@
 import type { TAppNotificationValuesUnexpectedError } from '@commercetools-frontend/constants';
-export default function useShowUnexpectedErrorNotification(): (options: TAppNotificationValuesUnexpectedError) => import("@commercetools-frontend/notifications").TAddNotificationAction<Pick<import("..").TUnexpectedErrorNotification, "id">>;
+export default function useShowUnexpectedErrorNotification(): (options: TAppNotificationValuesUnexpectedError) => import("@commercetools-frontend/notifications").TAddNotificationAction<import("@commercetools-frontend/constants").TAppNotificationOfDomain & {
+    kind: import("@commercetools-frontend/constants").TAppNotificationKindPage;
+} & {
+    id: number;
+    text?: undefined;
+    values?: TAppNotificationValuesUnexpectedError | undefined;
+} & import("@commercetools-frontend/notifications").TNotification>;

package/dist/declarations/src/types.d.ts

@@ -1,16 +1,15 @@
-import type { TNotification } from '@commercetools-frontend/notifications';
 import type { TAppNotification, TAppNotificationDomain, TAppNotificationKind, TAppNotificationApiError, TAppNotificationValuesApiError, TAppNotificationValuesUnexpectedError } from '@commercetools-frontend/constants';
-export declare type TShowNotification = TNotification & {
+export declare type TShowNotification = {
     domain: TAppNotificationDomain;
     kind: TAppNotificationKind;
     text?: string;
 };
-export declare type TApiErrorNotification = TNotification & TAppNotification<{
+export declare type TApiErrorNotification = TAppNotification<{
     domain: 'page';
     kind: 'api-error';
     values: TAppNotificationValuesApiError;
 }>;
-export declare type TUnexpectedErrorNotification = TNotification & TAppNotification<{
+export declare type TUnexpectedErrorNotification = TAppNotification<{
     domain: 'page';
     kind: 'unexpected-error';
     values: TAppNotificationValuesUnexpectedError;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools-frontend/actions-global",
-  "version": "21.0.0",
+  "version": "21.3.4",
   "description": "Global redux actions for a MC application",
   "bugs": "https://github.com/commercetools/merchant-center-application-kit/issues",
   "repository": {
@@ -18,21 +18,21 @@
   "module": "dist/commercetools-frontend-actions-global.esm.js",
   "files": ["dist", "package.json", "LICENSE", "README.md"],
   "dependencies": {
-    "@babel/runtime": "^7.16.7",
-    "@babel/runtime-corejs3": "^7.16.8",
-    "@commercetools-frontend/browser-history": "21.0.0",
-    "@commercetools-frontend/constants": "21.0.0",
-    "@commercetools-frontend/notifications": "21.0.0",
-    "@commercetools-frontend/sentry": "21.0.0",
-    "@types/lodash": "^4.14.178",
-    "@types/react": "^17.0.38",
-    "@types/react-redux": "^7.1.22",
+    "@babel/runtime": "^7.17.9",
+    "@babel/runtime-corejs3": "^7.17.9",
+    "@commercetools-frontend/browser-history": "21.3.4",
+    "@commercetools-frontend/constants": "21.3.4",
+    "@commercetools-frontend/notifications": "21.3.4",
+    "@commercetools-frontend/sentry": "21.3.4",
+    "@types/lodash": "^4.14.181",
+    "@types/react": "^17.0.44",
+    "@types/react-redux": "^7.1.23",
     "lodash": "4.17.21",
     "redux-thunk": "2.4.1"
   },
   "devDependencies": {
     "react": "17.0.2",
-    "react-redux": "7.2.6",
+    "react-redux": "7.2.8",
     "redux": "4.1.2"
   },
   "peerDependencies": {