@atlaskit/link-client-extension 0.1.0

package/CHANGELOG.md

@@ -0,0 +1 @@
+# @atlaskit/link-client-extension

package/LICENSE.md

@@ -0,0 +1,13 @@
+Copyright 2022 Atlassian Pty Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,12 @@
+# LinkClientExtension
+
+Linking Platform's Client extension
+
+## Usage
+
+```
+import { useSmartLinkClientExtension } from '@atlaskit/link-client-extension/smart-link';`
+
+const cardClient = new CardClient();
+const clientExtension = useSmartLinkClientExtension(client)
+```

package/dist/cjs/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "useSmartLinkClientExtension", {
+  enumerable: true,
+  get: function get() {
+    return _useSmartLinkClientExtension.useSmartLinkClientExtension;
+  }
+});
+var _useSmartLinkClientExtension = require("./services/use-smart-link-client-extension");

package/dist/cjs/services/use-resolver-url/index.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useResolverUrl = void 0;
+var _react = require("react");
+var _linkingCommon = require("@atlaskit/linking-common");
+var useResolverUrl = function useResolverUrl(cardClient) {
+  return (0, _react.useMemo)(function () {
+    return (0, _linkingCommon.getResolverUrl)(cardClient === null || cardClient === void 0 ? void 0 : cardClient.envKey, cardClient === null || cardClient === void 0 ? void 0 : cardClient.baseUrlOverride);
+  }, [cardClient === null || cardClient === void 0 ? void 0 : cardClient.baseUrlOverride, cardClient === null || cardClient === void 0 ? void 0 : cardClient.envKey]);
+};
+exports.useResolverUrl = useResolverUrl;

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

@@ -0,0 +1,52 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useSmartLinkClientExtension = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _react = require("react");
+var _linkingCommon = require("@atlaskit/linking-common");
+var _useResolverUrl = require("../use-resolver-url");
+/**
+ * useSmartLinkClientExtension
+ *
+ * This hook extends the usage of @atlaskit/link-provider CardClient
+ * for smart links.
+ *
+ * @param cardClient
+ */
+var useSmartLinkClientExtension = function useSmartLinkClientExtension(cardClient) {
+  var resolvedUrl = (0, _useResolverUrl.useResolverUrl)(cardClient);
+  var invoke = (0, _react.useCallback)( /*#__PURE__*/function () {
+    var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(data) {
+      var response;
+      return _regenerator.default.wrap(function _callee$(_context) {
+        while (1) {
+          switch (_context.prev = _context.next) {
+            case 0:
+              _context.next = 2;
+              return (0, _linkingCommon.request)('post', "".concat(resolvedUrl, "/invoke"), data, undefined, [200, 204]);
+            case 2:
+              response = _context.sent;
+              return _context.abrupt("return", response);
+            case 4:
+            case "end":
+              return _context.stop();
+          }
+        }
+      }, _callee);
+    }));
+    return function (_x) {
+      return _ref.apply(this, arguments);
+    };
+  }(), [resolvedUrl]);
+  return (0, _react.useMemo)(function () {
+    return {
+      invoke: invoke
+    };
+  }, [invoke]);
+};
+exports.useSmartLinkClientExtension = useSmartLinkClientExtension;

package/dist/cjs/version.json

@@ -0,0 +1,5 @@
+{
+	"name": "@atlaskit/link-client-extension",
+	"version": "0.1.0",
+	"sideEffects": false
+}

package/dist/es2019/index.js

@@ -0,0 +1 @@
+export { useSmartLinkClientExtension } from './services/use-smart-link-client-extension';

package/dist/es2019/services/use-resolver-url/index.js

@@ -0,0 +1,3 @@
+import { useMemo } from 'react';
+import { getResolverUrl } from '@atlaskit/linking-common';
+export const useResolverUrl = cardClient => useMemo(() => getResolverUrl(cardClient === null || cardClient === void 0 ? void 0 : cardClient.envKey, cardClient === null || cardClient === void 0 ? void 0 : cardClient.baseUrlOverride), [cardClient === null || cardClient === void 0 ? void 0 : cardClient.baseUrlOverride, cardClient === null || cardClient === void 0 ? void 0 : cardClient.envKey]);

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

@@ -0,0 +1,22 @@
+import { useCallback, useMemo } from 'react';
+import { request } from '@atlaskit/linking-common';
+import { useResolverUrl } from '../use-resolver-url';
+
+/**
+ * useSmartLinkClientExtension
+ *
+ * This hook extends the usage of @atlaskit/link-provider CardClient
+ * for smart links.
+ *
+ * @param cardClient
+ */
+export const useSmartLinkClientExtension = cardClient => {
+  const resolvedUrl = useResolverUrl(cardClient);
+  const invoke = useCallback(async data => {
+    const response = await request('post', `${resolvedUrl}/invoke`, data, undefined, [200, 204]);
+    return response;
+  }, [resolvedUrl]);
+  return useMemo(() => ({
+    invoke
+  }), [invoke]);
+};

package/dist/es2019/version.json

@@ -0,0 +1,5 @@
+{
+	"name": "@atlaskit/link-client-extension",
+	"version": "0.1.0",
+	"sideEffects": false
+}

package/dist/esm/index.js

@@ -0,0 +1 @@
+export { useSmartLinkClientExtension } from './services/use-smart-link-client-extension';

package/dist/esm/services/use-resolver-url/index.js

@@ -0,0 +1,7 @@
+import { useMemo } from 'react';
+import { getResolverUrl } from '@atlaskit/linking-common';
+export var useResolverUrl = function useResolverUrl(cardClient) {
+  return useMemo(function () {
+    return getResolverUrl(cardClient === null || cardClient === void 0 ? void 0 : cardClient.envKey, cardClient === null || cardClient === void 0 ? void 0 : cardClient.baseUrlOverride);
+  }, [cardClient === null || cardClient === void 0 ? void 0 : cardClient.baseUrlOverride, cardClient === null || cardClient === void 0 ? void 0 : cardClient.envKey]);
+};

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

@@ -0,0 +1,45 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+import { useCallback, useMemo } from 'react';
+import { request } from '@atlaskit/linking-common';
+import { useResolverUrl } from '../use-resolver-url';
+
+/**
+ * useSmartLinkClientExtension
+ *
+ * This hook extends the usage of @atlaskit/link-provider CardClient
+ * for smart links.
+ *
+ * @param cardClient
+ */
+export var useSmartLinkClientExtension = function useSmartLinkClientExtension(cardClient) {
+  var resolvedUrl = useResolverUrl(cardClient);
+  var invoke = useCallback( /*#__PURE__*/function () {
+    var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(data) {
+      var response;
+      return _regeneratorRuntime.wrap(function _callee$(_context) {
+        while (1) {
+          switch (_context.prev = _context.next) {
+            case 0:
+              _context.next = 2;
+              return request('post', "".concat(resolvedUrl, "/invoke"), data, undefined, [200, 204]);
+            case 2:
+              response = _context.sent;
+              return _context.abrupt("return", response);
+            case 4:
+            case "end":
+              return _context.stop();
+          }
+        }
+      }, _callee);
+    }));
+    return function (_x) {
+      return _ref.apply(this, arguments);
+    };
+  }(), [resolvedUrl]);
+  return useMemo(function () {
+    return {
+      invoke: invoke
+    };
+  }, [invoke]);
+};

package/dist/esm/version.json

@@ -0,0 +1,5 @@
+{
+	"name": "@atlaskit/link-client-extension",
+	"version": "0.1.0",
+	"sideEffects": false
+}

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export { useSmartLinkClientExtension } from './services/use-smart-link-client-extension';

package/dist/types/services/use-resolver-url/index.d.ts

@@ -0,0 +1,2 @@
+import type { CardClient } from '@atlaskit/link-provider';
+export declare const useResolverUrl: (cardClient: CardClient) => string;

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

@@ -0,0 +1,16 @@
+import type { CardClient } from '@atlaskit/link-provider';
+import type { InvokeActionRequest, InvokeActionResponse } from '@atlaskit/linking-types/smart-link-actions';
+/**
+ * useSmartLinkClientExtension
+ *
+ * This hook extends the usage of @atlaskit/link-provider CardClient
+ * for smart links.
+ *
+ * @param cardClient
+ */
+export declare const useSmartLinkClientExtension: (cardClient: CardClient) => {
+    invoke: <T>(data: InvokeActionRequest) => Promise<InvokeActionResponse | {
+        message?: string | undefined;
+        errorCode?: string | undefined;
+    }>;
+};

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@atlaskit/link-client-extension",
+  "version": "0.1.0",
+  "description": "Extension methods for linking platform client",
+  "author": "Atlassian Pty Ltd",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "atlassian": {
+    "team": "Linking Platform",
+    "inPublicMirror": false,
+    "releaseModel": "continuous",
+    "website": {
+      "name": "LinkClientExtension"
+    }
+  },
+  "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "module:es2019": "dist/es2019/index.js",
+  "types": "dist/types/index.d.ts",
+  "sideEffects": false,
+  "atlaskit:src": "src/index.ts",
+  "af:exports": {
+    ".": "./src/index.ts"
+  },
+  "dependencies": {
+    "@atlaskit/linking-common": "^2.3.0",
+    "@atlaskit/linking-types": "^0.2.0",
+    "@babel/runtime": "^7.0.0"
+  },
+  "peerDependencies": {
+    "@atlaskit/link-provider": "^1.5.0",
+    "react": "^16.8.0"
+  },
+  "devDependencies": {
+    "@atlaskit/docs": "*",
+    "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
+    "@testing-library/react": "^12.1.5",
+    "@testing-library/react-hooks": "^8.0.1",
+    "react-dom": "^16.8.0",
+    "typescript": "4.5.5",
+    "wait-for-expect": "^1.2.0"
+  },
+  "techstack": {
+    "@atlassian/frontend": {
+      "code-structure": [
+        "tangerine-next"
+      ],
+      "import-structure": [
+        "atlassian-conventions"
+      ],
+      "circular-dependencies": [
+        "file-and-folder-level"
+      ]
+    },
+    "@repo/internal": {
+      "dom-events": "use-bind-event-listener",
+      "analytics": [
+        "analytics-next"
+      ],
+      "design-tokens": [
+        "color"
+      ],
+      "theming": [
+        "react-context"
+      ],
+      "ui-components": [
+        "lite-mode"
+      ],
+      "deprecation": [
+        "no-deprecated-imports"
+      ],
+      "styling": [
+        "static",
+        "emotion"
+      ]
+    }
+  },
+  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
+}

package/report.api.md

@@ -0,0 +1,49 @@
+<!-- API Report Version: 2.3 -->
+
+## API Report File for "@atlaskit/link-client-extension"
+
+> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+### Table of contents
+
+- [Main Entry Types](#main-entry-types)
+- [Peer Dependencies](#peer-dependencies)
+
+### Main Entry Types
+
+<!--SECTION START: Main Entry Types-->
+
+```ts
+import type { CardClient } from '@atlaskit/link-provider';
+import type { InvokeActionRequest } from '@atlaskit/linking-types/smart-link-actions';
+import type { InvokeActionResponse } from '@atlaskit/linking-types/smart-link-actions';
+
+// @public
+export const useSmartLinkClientExtension: (cardClient: CardClient) => {
+  invoke: <T>(data: InvokeActionRequest) => Promise<
+    | InvokeActionResponse
+    | {
+        message?: string | undefined;
+        errorCode?: string | undefined;
+      }
+  >;
+};
+
+// (No @packageDocumentation comment for this package)
+```
+
+<!--SECTION END: Main Entry Types-->
+
+### Peer Dependencies
+
+<!--SECTION START: Peer Dependencies-->
+
+```json
+{
+  "@atlaskit/link-provider": "^1.5.0",
+  "react": "^16.8.0"
+}
+```
+
+<!--SECTION END: Peer Dependencies-->

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

@@ -0,0 +1,21 @@
+## API Report File for "@atlaskit/link-client-extension"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { CardClient } from '@atlaskit/link-provider';
+import type { InvokeActionRequest } from '@atlaskit/linking-types/smart-link-actions';
+import type { InvokeActionResponse } from '@atlaskit/linking-types/smart-link-actions';
+
+// @public
+export const useSmartLinkClientExtension: (cardClient: CardClient) => {
+    invoke: <T>(data: InvokeActionRequest) => Promise<InvokeActionResponse | {
+        message?: string | undefined;
+        errorCode?: string | undefined;
+    }>;
+};
+
+// (No @packageDocumentation comment for this package)
+
+```