@atlaskit/smart-card 18.0.10 → 18.0.11

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @atlaskit/smart-card
 
+## 18.0.11
+
+### Patch Changes
+
+- [`ec98e2d8ebc`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ec98e2d8ebc) - feat: Expose `useSmartLinkReload` hook.
+
+  ### Example Usage
+
+  As a consumer if you want to be able to reload the data backing a Smart Link, you may do:
+
+  ```tsx
+  export const MyComponent = () => {
+    const reloader = useSmartLinkReload(url, analytics);
+
+    return (
+      <MyInterfaceItem>
+        <Card />
+        <Button text="Retry" onClick={reloader} />
+      </MyInterfaceItem>
+    );
+  };
+  ```
+
 ## 18.0.10
 
 ### Patch Changes

package/dist/cjs/hooks.js

@@ -9,5 +9,13 @@ Object.defineProperty(exports, "useSmartLinkActions", {
     return _useSmartLinkActions.useSmartLinkActions;
   }
 });
+Object.defineProperty(exports, "useSmartLinkReload", {
+  enumerable: true,
+  get: function get() {
+    return _useSmartLinkReload.useSmartLinkReload;
+  }
+});
+
+var _useSmartLinkActions = require("./state/hooks-external/useSmartLinkActions");
 
-var _useSmartLinkActions = require("./state/hooks-external/useSmartLinkActions");
+var _useSmartLinkReload = require("./state/hooks-external/useSmartLinkReload");

package/dist/cjs/state/hooks-external/useSmartLinkReload.js

@@ -0,0 +1,32 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useSmartLinkReload = useSmartLinkReload;
+
+var _react = require("react");
+
+var _uuid = _interopRequireDefault(require("uuid"));
+
+var _actions = require("../actions");
+
+var _analytics = require("../analytics");
+
+/**
+ * Exposes a programmatic way to reload the data being used to render a Smart Link.
+ * @param
+ * @returns
+ */
+function useSmartLinkReload(_ref) {
+  var url = _ref.url,
+      analyticsHandler = _ref.analyticsHandler;
+  var id = (0, _react.useMemo)(function () {
+    return (0, _uuid.default)();
+  }, []);
+  var linkAnalytics = (0, _analytics.useSmartLinkAnalytics)(analyticsHandler);
+  var linkActions = (0, _actions.useSmartCardActions)(id, url, linkAnalytics);
+  return linkActions.reload;
+}

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/smart-card",
-	"version": "18.0.10",
+	"version": "18.0.11",
 	"sideEffects": false
 }

package/dist/es2019/hooks.js

@@ -1 +1,2 @@
-export { useSmartLinkActions } from './state/hooks-external/useSmartLinkActions';
+export { useSmartLinkActions } from './state/hooks-external/useSmartLinkActions';
+export { useSmartLinkReload } from './state/hooks-external/useSmartLinkReload';

package/dist/es2019/state/hooks-external/useSmartLinkReload.js

@@ -0,0 +1,19 @@
+import { useMemo } from 'react';
+import uuid from 'uuid';
+import { useSmartCardActions as useLinkActions } from '../actions';
+import { useSmartLinkAnalytics as useLinkAnalytics } from '../analytics';
+
+/**
+ * Exposes a programmatic way to reload the data being used to render a Smart Link.
+ * @param
+ * @returns
+ */
+export function useSmartLinkReload({
+  url,
+  analyticsHandler
+}) {
+  const id = useMemo(() => uuid(), []);
+  const linkAnalytics = useLinkAnalytics(analyticsHandler);
+  const linkActions = useLinkActions(id, url, linkAnalytics);
+  return linkActions.reload;
+}

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/smart-card",
-	"version": "18.0.10",
+	"version": "18.0.11",
 	"sideEffects": false
 }

package/dist/esm/hooks.js

@@ -1 +1,2 @@
-export { useSmartLinkActions } from './state/hooks-external/useSmartLinkActions';
+export { useSmartLinkActions } from './state/hooks-external/useSmartLinkActions';
+export { useSmartLinkReload } from './state/hooks-external/useSmartLinkReload';

package/dist/esm/state/hooks-external/useSmartLinkReload.js

@@ -0,0 +1,20 @@
+import { useMemo } from 'react';
+import uuid from 'uuid';
+import { useSmartCardActions as useLinkActions } from '../actions';
+import { useSmartLinkAnalytics as useLinkAnalytics } from '../analytics';
+
+/**
+ * Exposes a programmatic way to reload the data being used to render a Smart Link.
+ * @param
+ * @returns
+ */
+export function useSmartLinkReload(_ref) {
+  var url = _ref.url,
+      analyticsHandler = _ref.analyticsHandler;
+  var id = useMemo(function () {
+    return uuid();
+  }, []);
+  var linkAnalytics = useLinkAnalytics(analyticsHandler);
+  var linkActions = useLinkActions(id, url, linkAnalytics);
+  return linkActions.reload;
+}

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/smart-card",
-	"version": "18.0.10",
+	"version": "18.0.11",
 	"sideEffects": false
 }

package/dist/types/hooks.d.ts

@@ -1 +1,2 @@
 export { useSmartLinkActions } from './state/hooks-external/useSmartLinkActions';
+export { useSmartLinkReload } from './state/hooks-external/useSmartLinkReload';

package/dist/types/state/hooks-external/useSmartLinkReload.d.ts

@@ -0,0 +1,19 @@
+import type { AnalyticsHandler } from '../../utils/types';
+export interface UseSmartLinkReloadOpts {
+    /**
+     * Smart Link URL for which the reload will be invoked.
+     * @example https://start.atlassian.com
+     */
+    url: string;
+    /**
+     * Callback for sending analytics events.
+     * @description Accepts an analytics payload and fires it to a system.
+     */
+    analyticsHandler: AnalyticsHandler;
+}
+/**
+ * Exposes a programmatic way to reload the data being used to render a Smart Link.
+ * @param
+ * @returns
+ */
+export declare function useSmartLinkReload({ url, analyticsHandler, }: UseSmartLinkReloadOpts): () => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/smart-card",
-  "version": "18.0.10",
+  "version": "18.0.11",
   "description": "Smart card component",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"