@atlaskit/link-client-extension 1.7.3 → 1.8.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/link-client-extension
 
+## 1.8.0
+
+### Minor Changes
+
+- [#42199](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/42199) [`896e6300360`](https://bitbucket.org/atlassian/atlassian-frontend/commits/896e6300360) - Add api to make GET request to related-urls endpoint
+
 ## 1.7.3
 
 ### Patch Changes

package/dist/cjs/services/use-data-source-client-extension/index.js

@@ -26,16 +26,16 @@ var useDatasourceClientExtension = exports.useDatasourceClientExtension = functi
   var resolverUrl = (0, _useResolverUrl.useResolverUrl)(client);
   var cachedRequest = /*#__PURE__*/function () {
     var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(datasourceId, data, url, lruMap, force) {
-      var dataWithSortedFields, cacheKey, responsePromise;
+      var cacheKeyData, cacheKey, responsePromise;
       return _regenerator.default.wrap(function _callee$(_context) {
         while (1) switch (_context.prev = _context.next) {
           case 0:
-            dataWithSortedFields = _objectSpread(_objectSpread({}, data), data.fields && {
+            cacheKeyData = _objectSpread(_objectSpread({}, data), 'fields' in data ? {
               fields: (0, _toConsumableArray2.default)(data.fields || []).sort()
-            });
+            } : {});
             cacheKey = JSON.stringify({
               datasourceId: datasourceId,
-              dataWithSortedFields: dataWithSortedFields
+              cacheKeyData: cacheKeyData
             });
             if (force) {
               lruMap.delete(cacheKey);

package/dist/cjs/services/use-smart-link-client-extension/index.js

@@ -20,7 +20,7 @@ var _useResolverUrl = require("../use-resolver-url");
  * @param cardClient
  */
 var useSmartLinkClientExtension = exports.useSmartLinkClientExtension = function useSmartLinkClientExtension(cardClient) {
-  var resolvedUrl = (0, _useResolverUrl.useResolverUrl)(cardClient);
+  var resolverUrl = (0, _useResolverUrl.useResolverUrl)(cardClient);
   var invoke = (0, _react.useCallback)( /*#__PURE__*/function () {
     var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(data) {
       var errorBody;
@@ -29,7 +29,7 @@ var useSmartLinkClientExtension = exports.useSmartLinkClientExtension = function
           case 0:
             _context.prev = 0;
             _context.next = 3;
-            return (0, _linkingCommon.request)('post', "".concat(resolvedUrl, "/invoke"), data, undefined, [200, 201, 202, 203, 204]);
+            return (0, _linkingCommon.request)('post', "".concat(resolverUrl, "/invoke"), data, undefined, [200, 201, 202, 203, 204]);
           case 3:
             return _context.abrupt("return", _context.sent);
           case 6:
@@ -59,10 +59,32 @@ var useSmartLinkClientExtension = exports.useSmartLinkClientExtension = function
     return function (_x) {
       return _ref.apply(this, arguments);
     };
-  }(), [resolvedUrl]);
+  }(), [resolverUrl]);
+  var relatedUrls = (0, _react.useCallback)( /*#__PURE__*/function () {
+    var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(url) {
+      return _regenerator.default.wrap(function _callee2$(_context2) {
+        while (1) switch (_context2.prev = _context2.next) {
+          case 0:
+            _context2.next = 2;
+            return (0, _linkingCommon.request)('get', "".concat(resolverUrl, "/related-urls?url=").concat(encodeURIComponent(url)), undefined, {
+              'Cache-Control': 'private'
+            }, [200]);
+          case 2:
+            return _context2.abrupt("return", _context2.sent);
+          case 3:
+          case "end":
+            return _context2.stop();
+        }
+      }, _callee2);
+    }));
+    return function (_x2) {
+      return _ref2.apply(this, arguments);
+    };
+  }(), [resolverUrl]);
   return (0, _react.useMemo)(function () {
     return {
-      invoke: invoke
+      invoke: invoke,
+      relatedUrls: relatedUrls
     };
-  }, [invoke]);
+  }, [invoke, relatedUrls]);
 };

package/dist/es2019/services/use-data-source-client-extension/index.js

@@ -15,16 +15,16 @@ export const useDatasourceClientExtension = () => {
   } = useSmartLinkContext();
   const resolverUrl = useResolverUrl(client);
   const cachedRequest = async (datasourceId, data, url, lruMap, force) => {
-    const dataWithSortedFields = {
+    const cacheKeyData = {
       ...data,
       // Sort fields to use cached version of response regardless of the order
-      ...(data.fields && {
+      ...('fields' in data ? {
         fields: [...(data.fields || [])].sort()
-      })
+      } : {})
     };
     const cacheKey = JSON.stringify({
       datasourceId,
-      dataWithSortedFields
+      cacheKeyData
     });
     if (force) {
       lruMap.delete(cacheKey);

package/dist/es2019/services/use-smart-link-client-extension/index.js

@@ -12,10 +12,10 @@ import { useResolverUrl } from '../use-resolver-url';
  * @param cardClient
  */
 export const useSmartLinkClientExtension = cardClient => {
-  const resolvedUrl = useResolverUrl(cardClient);
+  const resolverUrl = useResolverUrl(cardClient);
   const invoke = useCallback(async data => {
     try {
-      return await request('post', `${resolvedUrl}/invoke`, data, undefined, [200, 201, 202, 203, 204]);
+      return await request('post', `${resolverUrl}/invoke`, data, undefined, [200, 201, 202, 203, 204]);
     } catch (err) {
       // checking if the error is a Response type
       // since we already had a few HOTs caused by comparing with instanceOf',
@@ -28,8 +28,14 @@ export const useSmartLinkClientExtension = cardClient => {
       }
       throw err;
     }
-  }, [resolvedUrl]);
+  }, [resolverUrl]);
+  const relatedUrls = useCallback(async url => {
+    return await request('get', `${resolverUrl}/related-urls?url=${encodeURIComponent(url)}`, undefined, {
+      'Cache-Control': 'private'
+    }, [200]);
+  }, [resolverUrl]);
   return useMemo(() => ({
-    invoke
-  }), [invoke]);
+    invoke,
+    relatedUrls
+  }), [invoke, relatedUrls]);
 };

package/dist/esm/services/use-data-source-client-extension/index.js

@@ -19,16 +19,16 @@ export var useDatasourceClientExtension = function useDatasourceClientExtension(
   var resolverUrl = useResolverUrl(client);
   var cachedRequest = /*#__PURE__*/function () {
     var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(datasourceId, data, url, lruMap, force) {
-      var dataWithSortedFields, cacheKey, responsePromise;
+      var cacheKeyData, cacheKey, responsePromise;
       return _regeneratorRuntime.wrap(function _callee$(_context) {
         while (1) switch (_context.prev = _context.next) {
           case 0:
-            dataWithSortedFields = _objectSpread(_objectSpread({}, data), data.fields && {
+            cacheKeyData = _objectSpread(_objectSpread({}, data), 'fields' in data ? {
               fields: _toConsumableArray(data.fields || []).sort()
-            });
+            } : {});
             cacheKey = JSON.stringify({
               datasourceId: datasourceId,
-              dataWithSortedFields: dataWithSortedFields
+              cacheKeyData: cacheKeyData
             });
             if (force) {
               lruMap.delete(cacheKey);

package/dist/esm/services/use-smart-link-client-extension/index.js

@@ -14,7 +14,7 @@ import { useResolverUrl } from '../use-resolver-url';
  * @param cardClient
  */
 export var useSmartLinkClientExtension = function useSmartLinkClientExtension(cardClient) {
-  var resolvedUrl = useResolverUrl(cardClient);
+  var resolverUrl = useResolverUrl(cardClient);
   var invoke = useCallback( /*#__PURE__*/function () {
     var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(data) {
       var errorBody;
@@ -23,7 +23,7 @@ export var useSmartLinkClientExtension = function useSmartLinkClientExtension(ca
           case 0:
             _context.prev = 0;
             _context.next = 3;
-            return request('post', "".concat(resolvedUrl, "/invoke"), data, undefined, [200, 201, 202, 203, 204]);
+            return request('post', "".concat(resolverUrl, "/invoke"), data, undefined, [200, 201, 202, 203, 204]);
           case 3:
             return _context.abrupt("return", _context.sent);
           case 6:
@@ -53,10 +53,32 @@ export var useSmartLinkClientExtension = function useSmartLinkClientExtension(ca
     return function (_x) {
       return _ref.apply(this, arguments);
     };
-  }(), [resolvedUrl]);
+  }(), [resolverUrl]);
+  var relatedUrls = useCallback( /*#__PURE__*/function () {
+    var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(url) {
+      return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+        while (1) switch (_context2.prev = _context2.next) {
+          case 0:
+            _context2.next = 2;
+            return request('get', "".concat(resolverUrl, "/related-urls?url=").concat(encodeURIComponent(url)), undefined, {
+              'Cache-Control': 'private'
+            }, [200]);
+          case 2:
+            return _context2.abrupt("return", _context2.sent);
+          case 3:
+          case "end":
+            return _context2.stop();
+        }
+      }, _callee2);
+    }));
+    return function (_x2) {
+      return _ref2.apply(this, arguments);
+    };
+  }(), [resolverUrl]);
   return useMemo(function () {
     return {
-      invoke: invoke
+      invoke: invoke,
+      relatedUrls: relatedUrls
     };
-  }, [invoke]);
+  }, [invoke, relatedUrls]);
 };

package/dist/types/services/use-smart-link-client-extension/index.d.ts

@@ -10,4 +10,5 @@ import { InvokeRequest, InvokeResponse } from '@atlaskit/linking-types/smart-lin
  */
 export declare const useSmartLinkClientExtension: (cardClient: CardClient) => {
     invoke: (data: InvokeRequest) => Promise<InvokeResponse>;
+    relatedUrls: <TResponse>(url: string) => Promise<TResponse>;
 };

package/dist/types-ts4.5/services/use-smart-link-client-extension/index.d.ts

@@ -10,4 +10,5 @@ import { InvokeRequest, InvokeResponse } from '@atlaskit/linking-types/smart-lin
  */
 export declare const useSmartLinkClientExtension: (cardClient: CardClient) => {
     invoke: (data: InvokeRequest) => Promise<InvokeResponse>;
+    relatedUrls: <TResponse>(url: string) => Promise<TResponse>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/link-client-extension",
-  "version": "1.7.3",
+  "version": "1.8.0",
   "description": "Extension methods for linking platform client",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -34,7 +34,7 @@
     ".": "./src/index.ts"
   },
   "dependencies": {
-    "@atlaskit/linking-common": "^4.11.0",
+    "@atlaskit/linking-common": "^4.12.0",
     "@atlaskit/linking-types": "^8.4.0",
     "@babel/runtime": "^7.0.0",
     "json-ld-types": "^3.9.1",

package/report.api.md

@@ -72,6 +72,7 @@ export const useDatasourceClientExtension: () => {
 // @public
 export const useSmartLinkClientExtension: (cardClient: CardClient) => {
   invoke: (data: InvokeRequest) => Promise<InvokeResponse>;
+  relatedUrls: <TResponse>(url: string) => Promise<TResponse>;
 };
 
 // (No @packageDocumentation comment for this package)

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

@@ -53,6 +53,7 @@ export const useDatasourceClientExtension: () => {
 // @public
 export const useSmartLinkClientExtension: (cardClient: CardClient) => {
     invoke: (data: InvokeRequest) => Promise<InvokeResponse>;
+    relatedUrls: <TResponse>(url: string) => Promise<TResponse>;
 };
 
 // (No @packageDocumentation comment for this package)