@atlaskit/smart-card 23.0.0 → 23.0.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/smart-card
 
+## 23.0.1
+
+### Patch Changes
+
+- [`3b30fc47274`](https://bitbucket.org/atlassian/atlassian-frontend/commits/3b30fc47274) - Smart Link card state fix relating to an issue with returning old state if url changes to the one already present in the store.
+
 ## 23.0.0
 
 ### Patch Changes

package/dist/cjs/state/store/index.js

@@ -20,20 +20,22 @@ function useSmartCardState(url) {
       store = _useSmartLinkContext.store; // Initially, card state should be pending and 'empty'.
 
 
-  var _useState = (0, _react.useState)((0, _linkingCommon.getUrl)(store, url)),
+  var newCardState = (0, _linkingCommon.getUrl)(store, url);
+
+  var _useState = (0, _react.useState)(newCardState),
       _useState2 = (0, _slicedToArray2.default)(_useState, 2),
-      state = _useState2[0],
-      setState = _useState2[1]; // Selector for initial and subsequent states.
+      setCardState = _useState2[1]; // Selector for initial and subsequent states.
 
 
   (0, _react.useEffect)(function () {
     var unsubscribe = store.subscribe(function () {
-      setState((0, _linkingCommon.getUrl)(store, url));
+      // forcing re-renders when the store changes
+      setCardState((0, _linkingCommon.getUrl)(store, url));
     });
     return function () {
       return unsubscribe();
     };
-  }, [url, store]); // State for use in view components.
+  }, [url, store]); // Returning fresh state for use in view components. Added as a part of the fix in EDM-4422.
 
-  return state;
+  return newCardState;
 }

package/dist/cjs/utils/mocks.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.waitFor = exports.mocks = exports.mockContext = exports.mockAnalytics = exports.fakeResponse = exports.fakeFactory = void 0;
+exports.waitFor = exports.mocks = exports.mockContext = exports.mockByUrl = exports.mockAnalytics = exports.fakeResponse = exports.fakeFactory = void 0;
 
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
@@ -33,6 +33,40 @@ var mockContext = {
   schema: 'http://schema.org/'
 };
 exports.mockContext = mockContext;
+
+var mockByUrl = function mockByUrl(url) {
+  return {
+    meta: {
+      visibility: 'public',
+      access: 'granted',
+      auth: [],
+      definitionId: 'd1',
+      key: 'object-provider'
+    },
+    data: {
+      '@context': {
+        '@vocab': 'https://www.w3.org/ns/activitystreams#',
+        atlassian: 'https://schema.atlassian.com/ns/vocabulary#',
+        schema: 'http://schema.org/'
+      },
+      '@type': 'Object',
+      name: url,
+      summary: 'Here is your serving of cheese: 🧀',
+      'schema:potentialAction': {
+        '@id': 'comment',
+        '@type': 'CommentAction',
+        identifier: 'object-provider',
+        name: 'Comment'
+      },
+      preview: {
+        href: 'https://www.ilovecheese.com'
+      },
+      url: url
+    }
+  };
+};
+
+exports.mockByUrl = mockByUrl;
 var mocks = {
   success: {
     meta: {
@@ -174,13 +208,13 @@ var fakeFactory = function fakeFactory(implementation, implementationPost, imple
     (0, _createClass2.default)(CustomClient, [{
       key: "fetchData",
       value: function () {
-        var _fetchData = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
+        var _fetchData = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(url) {
           return _regenerator.default.wrap(function _callee$(_context) {
             while (1) {
               switch (_context.prev = _context.next) {
                 case 0:
                   _context.next = 2;
-                  return implementation();
+                  return implementation(url);
 
                 case 2:
                   return _context.abrupt("return", _context.sent);
@@ -193,7 +227,7 @@ var fakeFactory = function fakeFactory(implementation, implementationPost, imple
           }, _callee);
         }));
 
-        function fetchData() {
+        function fetchData(_x) {
           return _fetchData.apply(this, arguments);
         }
 

package/dist/cjs/version.json

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

package/dist/es2019/state/store/index.js

@@ -6,14 +6,16 @@ export function useSmartCardState(url) {
     store
   } = useSmartLinkContext(); // Initially, card state should be pending and 'empty'.
 
-  const [state, setState] = useState(getUrl(store, url)); // Selector for initial and subsequent states.
+  const newCardState = getUrl(store, url);
+  const [, setCardState] = useState(newCardState); // Selector for initial and subsequent states.
 
   useEffect(() => {
     const unsubscribe = store.subscribe(() => {
-      setState(getUrl(store, url));
+      // forcing re-renders when the store changes
+      setCardState(getUrl(store, url));
     });
     return () => unsubscribe();
-  }, [url, store]); // State for use in view components.
+  }, [url, store]); // Returning fresh state for use in view components. Added as a part of the fix in EDM-4422.
 
-  return state;
+  return newCardState;
 }

package/dist/es2019/utils/mocks.js

@@ -4,6 +4,37 @@ export const mockContext = {
   atlassian: 'https://schema.atlassian.com/ns/vocabulary#',
   schema: 'http://schema.org/'
 };
+export const mockByUrl = url => {
+  return {
+    meta: {
+      visibility: 'public',
+      access: 'granted',
+      auth: [],
+      definitionId: 'd1',
+      key: 'object-provider'
+    },
+    data: {
+      '@context': {
+        '@vocab': 'https://www.w3.org/ns/activitystreams#',
+        atlassian: 'https://schema.atlassian.com/ns/vocabulary#',
+        schema: 'http://schema.org/'
+      },
+      '@type': 'Object',
+      name: url,
+      summary: 'Here is your serving of cheese: 🧀',
+      'schema:potentialAction': {
+        '@id': 'comment',
+        '@type': 'CommentAction',
+        identifier: 'object-provider',
+        name: 'Comment'
+      },
+      preview: {
+        href: 'https://www.ilovecheese.com'
+      },
+      url: url
+    }
+  };
+};
 export const mocks = {
   success: {
     meta: {
@@ -125,8 +156,8 @@ export const mocks = {
 };
 export const fakeResponse = () => Promise.resolve(mocks.success);
 export const fakeFactory = (implementation, implementationPost, implementationPrefetch) => class CustomClient extends CardClient {
-  async fetchData() {
-    return await implementation();
+  async fetchData(url) {
+    return await implementation(url);
   }
 
   async postData() {

package/dist/es2019/version.json

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

package/dist/esm/state/store/index.js

@@ -7,20 +7,22 @@ export function useSmartCardState(url) {
       store = _useSmartLinkContext.store; // Initially, card state should be pending and 'empty'.
 
 
-  var _useState = useState(getUrl(store, url)),
+  var newCardState = getUrl(store, url);
+
+  var _useState = useState(newCardState),
       _useState2 = _slicedToArray(_useState, 2),
-      state = _useState2[0],
-      setState = _useState2[1]; // Selector for initial and subsequent states.
+      setCardState = _useState2[1]; // Selector for initial and subsequent states.
 
 
   useEffect(function () {
     var unsubscribe = store.subscribe(function () {
-      setState(getUrl(store, url));
+      // forcing re-renders when the store changes
+      setCardState(getUrl(store, url));
     });
     return function () {
       return unsubscribe();
     };
-  }, [url, store]); // State for use in view components.
+  }, [url, store]); // Returning fresh state for use in view components. Added as a part of the fix in EDM-4422.
 
-  return state;
+  return newCardState;
 }

package/dist/esm/utils/mocks.js

@@ -16,6 +16,37 @@ export var mockContext = {
   atlassian: 'https://schema.atlassian.com/ns/vocabulary#',
   schema: 'http://schema.org/'
 };
+export var mockByUrl = function mockByUrl(url) {
+  return {
+    meta: {
+      visibility: 'public',
+      access: 'granted',
+      auth: [],
+      definitionId: 'd1',
+      key: 'object-provider'
+    },
+    data: {
+      '@context': {
+        '@vocab': 'https://www.w3.org/ns/activitystreams#',
+        atlassian: 'https://schema.atlassian.com/ns/vocabulary#',
+        schema: 'http://schema.org/'
+      },
+      '@type': 'Object',
+      name: url,
+      summary: 'Here is your serving of cheese: 🧀',
+      'schema:potentialAction': {
+        '@id': 'comment',
+        '@type': 'CommentAction',
+        identifier: 'object-provider',
+        name: 'Comment'
+      },
+      preview: {
+        href: 'https://www.ilovecheese.com'
+      },
+      url: url
+    }
+  };
+};
 export var mocks = {
   success: {
     meta: {
@@ -153,13 +184,13 @@ export var fakeFactory = function fakeFactory(implementation, implementationPost
     _createClass(CustomClient, [{
       key: "fetchData",
       value: function () {
-        var _fetchData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
+        var _fetchData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(url) {
           return _regeneratorRuntime.wrap(function _callee$(_context) {
             while (1) {
               switch (_context.prev = _context.next) {
                 case 0:
                   _context.next = 2;
-                  return implementation();
+                  return implementation(url);
 
                 case 2:
                   return _context.abrupt("return", _context.sent);
@@ -172,7 +203,7 @@ export var fakeFactory = function fakeFactory(implementation, implementationPost
           }, _callee);
         }));
 
-        function fetchData() {
+        function fetchData(_x) {
           return _fetchData.apply(this, arguments);
         }
 

package/dist/esm/version.json

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

package/dist/types/utils/mocks.d.ts

@@ -4,6 +4,7 @@ export declare const mockContext: {
     readonly atlassian: "https://schema.atlassian.com/ns/vocabulary#";
     readonly schema: "http://schema.org/";
 };
+export declare const mockByUrl: (url: string) => JsonLd.Response<JsonLd.Data.BaseData>;
 export declare const mocks: {
     success: JsonLd.Response<JsonLd.Data.BaseData>;
     notFound: JsonLd.Response<JsonLd.Data.BaseData>;

package/dist/types-ts4.0/utils/mocks.d.ts

@@ -4,6 +4,7 @@ export declare const mockContext: {
     readonly atlassian: "https://schema.atlassian.com/ns/vocabulary#";
     readonly schema: "http://schema.org/";
 };
+export declare const mockByUrl: (url: string) => JsonLd.Response<JsonLd.Data.BaseData>;
 export declare const mocks: {
     success: JsonLd.Response<JsonLd.Data.BaseData>;
     notFound: JsonLd.Response<JsonLd.Data.BaseData>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/smart-card",
-  "version": "23.0.0",
+  "version": "23.0.1",
   "description": "Smart card component",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -15,7 +15,8 @@
   "typesVersions": {
     ">=4.0 <4.5": {
       "*": [
-        "dist/types-ts4.0/*"
+        "dist/types-ts4.0/*",
+        "dist/types-ts4.0/index.d.ts"
       ]
     }
   },

package/report.api.md

@@ -1,4 +1,4 @@
-<!-- API Report Version: 2.2 -->
+<!-- API Report Version: 2.3 -->
 
 ## API Report File for "@atlaskit/smart-card"