@atlaskit/link-client-extension 0.3.0 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,22 @@
1
1
  # @atlaskit/link-client-extension
2
2
 
3
+ ## 0.4.1
4
+
5
+ ### Patch Changes
6
+
7
+ - [`2e01c9c74b5`](https://bitbucket.org/atlassian/atlassian-frontend/commits/2e01c9c74b5) - DUMMY remove before merging to master; dupe adf-schema via adf-utils
8
+ - Updated dependencies
9
+
10
+ ## 0.4.0
11
+
12
+ ### Minor Changes
13
+
14
+ - [`d19a6e77d60`](https://bitbucket.org/atlassian/atlassian-frontend/commits/d19a6e77d60) - Adds new hook useDatasourceClientExtension to fetch data for link datasources
15
+
16
+ ### Patch Changes
17
+
18
+ - Updated dependencies
19
+
3
20
  ## 0.3.0
4
21
 
5
22
  ### Minor Changes
package/dist/cjs/index.js CHANGED
@@ -3,10 +3,17 @@
3
3
  Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
+ Object.defineProperty(exports, "useDatasourceClientExtension", {
7
+ enumerable: true,
8
+ get: function get() {
9
+ return _useDataSourceClientExtension.useDatasourceClientExtension;
10
+ }
11
+ });
6
12
  Object.defineProperty(exports, "useSmartLinkClientExtension", {
7
13
  enumerable: true,
8
14
  get: function get() {
9
15
  return _useSmartLinkClientExtension.useSmartLinkClientExtension;
10
16
  }
11
17
  });
12
- var _useSmartLinkClientExtension = require("./services/use-smart-link-client-extension");
18
+ var _useSmartLinkClientExtension = require("./services/use-smart-link-client-extension");
19
+ var _useDataSourceClientExtension = require("./services/use-data-source-client-extension");
@@ -0,0 +1,25 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.useDatasourceClientExtension = void 0;
7
+ var _react = require("react");
8
+ var _linkingCommon = require("@atlaskit/linking-common");
9
+ var _useResolverUrl = require("../use-resolver-url");
10
+ var useDatasourceClientExtension = function useDatasourceClientExtension(cardClient) {
11
+ var resolverUrl = (0, _useResolverUrl.useResolverUrl)(cardClient);
12
+ var getDatasourceDetails = (0, _react.useCallback)(function (datasourceId, data) {
13
+ return (0, _linkingCommon.request)('post', "".concat(resolverUrl, "/datasource/").concat(datasourceId, "/fetch/details"), data, undefined, [200, 201, 202, 203, 204]);
14
+ }, [resolverUrl]);
15
+ var getDatasourceData = (0, _react.useCallback)(function (datasourceId, data) {
16
+ return (0, _linkingCommon.request)('post', "".concat(resolverUrl, "/datasource/").concat(datasourceId, "/fetch/data"), data, undefined, [200, 201, 202, 203, 204]);
17
+ }, [resolverUrl]);
18
+ return (0, _react.useMemo)(function () {
19
+ return {
20
+ getDatasourceDetails: getDatasourceDetails,
21
+ getDatasourceData: getDatasourceData
22
+ };
23
+ }, [getDatasourceDetails, getDatasourceData]);
24
+ };
25
+ exports.useDatasourceClientExtension = useDatasourceClientExtension;
@@ -0,0 +1,83 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.mockDatasourceResponse = exports.mockDatasourceDataResponse = void 0;
7
+ var mockDatasourceDataResponse = {
8
+ data: [{
9
+ id: 'EDM-12',
10
+ description: 'Design datasource feature',
11
+ createdAt: '2023-01-22T01:30:00.000-05:00',
12
+ assigned: {
13
+ displayName: 'Sasha'
14
+ },
15
+ state: 'IN PROGRESS'
16
+ }, {
17
+ id: 'EDM-14',
18
+ description: 'Implement datasource feature',
19
+ createdAt: '2023-03-01T01:30:00.000-05:00',
20
+ assigned: {
21
+ displayName: 'Hana'
22
+ },
23
+ state: 'TO DO'
24
+ }, {
25
+ id: 'EDM-15',
26
+ description: 'Add Jira Provider',
27
+ createdAt: '2023-03-31T01:30:00.000-05:00',
28
+ assigned: {
29
+ displayName: 'Princey'
30
+ },
31
+ state: 'TO DO'
32
+ }, {
33
+ id: 'EDM-16',
34
+ description: 'Plan team party',
35
+ createdAt: '2023-05-01T01:30:00.000-05:00',
36
+ assigned: {
37
+ displayName: 'Nidhin'
38
+ },
39
+ state: 'TO DO'
40
+ }],
41
+ nextPageCursor: 'c3RhcnRBdD01'
42
+ };
43
+ exports.mockDatasourceDataResponse = mockDatasourceDataResponse;
44
+ var mockDatasourceResponse = {
45
+ ari: 'ari:cloud:linking-platform:datasource/12e74246-a3f1-46c1-9fd9-8d952aa9f12f',
46
+ id: '12e74246-a3f1-46c1-9fd9-8d952aa9f12f',
47
+ name: 'JQL Datasource',
48
+ description: 'Fetches Issues using JQL',
49
+ parameters: [{
50
+ key: 'cloudId',
51
+ type: 'string',
52
+ description: 'Cloud Id'
53
+ }, {
54
+ key: 'jql',
55
+ type: 'string',
56
+ description: 'JQL query to retrieve list of issues'
57
+ }],
58
+ schema: {
59
+ properties: [{
60
+ key: 'id',
61
+ type: 'string',
62
+ title: 'Id'
63
+ }, {
64
+ key: 'description',
65
+ type: 'link',
66
+ title: 'Description'
67
+ }, {
68
+ key: 'createdAt',
69
+ type: 'date',
70
+ title: 'Created At'
71
+ }, {
72
+ key: 'assigned',
73
+ type: 'user',
74
+ title: 'Assignee'
75
+ }, {
76
+ key: 'state',
77
+ type: 'status',
78
+ title: 'Status'
79
+ }],
80
+ defaultProperties: ['id', 'description', 'assigned', 'state']
81
+ }
82
+ };
83
+ exports.mockDatasourceResponse = mockDatasourceResponse;
@@ -1,15 +1,16 @@
1
1
  "use strict";
2
2
 
3
3
  var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ var _typeof = require("@babel/runtime/helpers/typeof");
4
5
  Object.defineProperty(exports, "__esModule", {
5
6
  value: true
6
7
  });
7
8
  exports.useSmartLinkClientExtension = void 0;
8
- var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
9
9
  var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
10
10
  var _react = require("react");
11
11
  var _linkingCommon = require("@atlaskit/linking-common");
12
12
  var _useResolverUrl = require("../use-resolver-url");
13
+ function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return exports; }; var exports = {}, Op = Object.prototype, hasOwn = Op.hasOwnProperty, defineProperty = Object.defineProperty || function (obj, key, desc) { obj[key] = desc.value; }, $Symbol = "function" == typeof Symbol ? Symbol : {}, iteratorSymbol = $Symbol.iterator || "@@iterator", asyncIteratorSymbol = $Symbol.asyncIterator || "@@asyncIterator", toStringTagSymbol = $Symbol.toStringTag || "@@toStringTag"; function define(obj, key, value) { return Object.defineProperty(obj, key, { value: value, enumerable: !0, configurable: !0, writable: !0 }), obj[key]; } try { define({}, ""); } catch (err) { define = function define(obj, key, value) { return obj[key] = value; }; } function wrap(innerFn, outerFn, self, tryLocsList) { var protoGenerator = outerFn && outerFn.prototype instanceof Generator ? outerFn : Generator, generator = Object.create(protoGenerator.prototype), context = new Context(tryLocsList || []); return defineProperty(generator, "_invoke", { value: makeInvokeMethod(innerFn, self, context) }), generator; } function tryCatch(fn, obj, arg) { try { return { type: "normal", arg: fn.call(obj, arg) }; } catch (err) { return { type: "throw", arg: err }; } } exports.wrap = wrap; var ContinueSentinel = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var IteratorPrototype = {}; define(IteratorPrototype, iteratorSymbol, function () { return this; }); var getProto = Object.getPrototypeOf, NativeIteratorPrototype = getProto && getProto(getProto(values([]))); NativeIteratorPrototype && NativeIteratorPrototype !== Op && hasOwn.call(NativeIteratorPrototype, iteratorSymbol) && (IteratorPrototype = NativeIteratorPrototype); var Gp = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(IteratorPrototype); function defineIteratorMethods(prototype) { ["next", "throw", "return"].forEach(function (method) { define(prototype, method, function (arg) { return this._invoke(method, arg); }); }); } function AsyncIterator(generator, PromiseImpl) { function invoke(method, arg, resolve, reject) { var record = tryCatch(generator[method], generator, arg); if ("throw" !== record.type) { var result = record.arg, value = result.value; return value && "object" == _typeof(value) && hasOwn.call(value, "__await") ? PromiseImpl.resolve(value.__await).then(function (value) { invoke("next", value, resolve, reject); }, function (err) { invoke("throw", err, resolve, reject); }) : PromiseImpl.resolve(value).then(function (unwrapped) { result.value = unwrapped, resolve(result); }, function (error) { return invoke("throw", error, resolve, reject); }); } reject(record.arg); } var previousPromise; defineProperty(this, "_invoke", { value: function value(method, arg) { function callInvokeWithMethodAndArg() { return new PromiseImpl(function (resolve, reject) { invoke(method, arg, resolve, reject); }); } return previousPromise = previousPromise ? previousPromise.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(innerFn, self, context) { var state = "suspendedStart"; return function (method, arg) { if ("executing" === state) throw new Error("Generator is already running"); if ("completed" === state) { if ("throw" === method) throw arg; return doneResult(); } for (context.method = method, context.arg = arg;;) { var delegate = context.delegate; if (delegate) { var delegateResult = maybeInvokeDelegate(delegate, context); if (delegateResult) { if (delegateResult === ContinueSentinel) continue; return delegateResult; } } if ("next" === context.method) context.sent = context._sent = context.arg;else if ("throw" === context.method) { if ("suspendedStart" === state) throw state = "completed", context.arg; context.dispatchException(context.arg); } else "return" === context.method && context.abrupt("return", context.arg); state = "executing"; var record = tryCatch(innerFn, self, context); if ("normal" === record.type) { if (state = context.done ? "completed" : "suspendedYield", record.arg === ContinueSentinel) continue; return { value: record.arg, done: context.done }; } "throw" === record.type && (state = "completed", context.method = "throw", context.arg = record.arg); } }; } function maybeInvokeDelegate(delegate, context) { var methodName = context.method, method = delegate.iterator[methodName]; if (undefined === method) return context.delegate = null, "throw" === methodName && delegate.iterator.return && (context.method = "return", context.arg = undefined, maybeInvokeDelegate(delegate, context), "throw" === context.method) || "return" !== methodName && (context.method = "throw", context.arg = new TypeError("The iterator does not provide a '" + methodName + "' method")), ContinueSentinel; var record = tryCatch(method, delegate.iterator, context.arg); if ("throw" === record.type) return context.method = "throw", context.arg = record.arg, context.delegate = null, ContinueSentinel; var info = record.arg; return info ? info.done ? (context[delegate.resultName] = info.value, context.next = delegate.nextLoc, "return" !== context.method && (context.method = "next", context.arg = undefined), context.delegate = null, ContinueSentinel) : info : (context.method = "throw", context.arg = new TypeError("iterator result is not an object"), context.delegate = null, ContinueSentinel); } function pushTryEntry(locs) { var entry = { tryLoc: locs[0] }; 1 in locs && (entry.catchLoc = locs[1]), 2 in locs && (entry.finallyLoc = locs[2], entry.afterLoc = locs[3]), this.tryEntries.push(entry); } function resetTryEntry(entry) { var record = entry.completion || {}; record.type = "normal", delete record.arg, entry.completion = record; } function Context(tryLocsList) { this.tryEntries = [{ tryLoc: "root" }], tryLocsList.forEach(pushTryEntry, this), this.reset(!0); } function values(iterable) { if (iterable) { var iteratorMethod = iterable[iteratorSymbol]; if (iteratorMethod) return iteratorMethod.call(iterable); if ("function" == typeof iterable.next) return iterable; if (!isNaN(iterable.length)) { var i = -1, next = function next() { for (; ++i < iterable.length;) { if (hasOwn.call(iterable, i)) return next.value = iterable[i], next.done = !1, next; } return next.value = undefined, next.done = !0, next; }; return next.next = next; } } return { next: doneResult }; } function doneResult() { return { value: undefined, done: !0 }; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, defineProperty(Gp, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), defineProperty(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, toStringTagSymbol, "GeneratorFunction"), exports.isGeneratorFunction = function (genFun) { var ctor = "function" == typeof genFun && genFun.constructor; return !!ctor && (ctor === GeneratorFunction || "GeneratorFunction" === (ctor.displayName || ctor.name)); }, exports.mark = function (genFun) { return Object.setPrototypeOf ? Object.setPrototypeOf(genFun, GeneratorFunctionPrototype) : (genFun.__proto__ = GeneratorFunctionPrototype, define(genFun, toStringTagSymbol, "GeneratorFunction")), genFun.prototype = Object.create(Gp), genFun; }, exports.awrap = function (arg) { return { __await: arg }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, asyncIteratorSymbol, function () { return this; }), exports.AsyncIterator = AsyncIterator, exports.async = function (innerFn, outerFn, self, tryLocsList, PromiseImpl) { void 0 === PromiseImpl && (PromiseImpl = Promise); var iter = new AsyncIterator(wrap(innerFn, outerFn, self, tryLocsList), PromiseImpl); return exports.isGeneratorFunction(outerFn) ? iter : iter.next().then(function (result) { return result.done ? result.value : iter.next(); }); }, defineIteratorMethods(Gp), define(Gp, toStringTagSymbol, "Generator"), define(Gp, iteratorSymbol, function () { return this; }), define(Gp, "toString", function () { return "[object Generator]"; }), exports.keys = function (val) { var object = Object(val), keys = []; for (var key in object) { keys.push(key); } return keys.reverse(), function next() { for (; keys.length;) { var key = keys.pop(); if (key in object) return next.value = key, next.done = !1, next; } return next.done = !0, next; }; }, exports.values = values, Context.prototype = { constructor: Context, reset: function reset(skipTempReset) { if (this.prev = 0, this.next = 0, this.sent = this._sent = undefined, this.done = !1, this.delegate = null, this.method = "next", this.arg = undefined, this.tryEntries.forEach(resetTryEntry), !skipTempReset) for (var name in this) { "t" === name.charAt(0) && hasOwn.call(this, name) && !isNaN(+name.slice(1)) && (this[name] = undefined); } }, stop: function stop() { this.done = !0; var rootRecord = this.tryEntries[0].completion; if ("throw" === rootRecord.type) throw rootRecord.arg; return this.rval; }, dispatchException: function dispatchException(exception) { if (this.done) throw exception; var context = this; function handle(loc, caught) { return record.type = "throw", record.arg = exception, context.next = loc, caught && (context.method = "next", context.arg = undefined), !!caught; } for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i], record = entry.completion; if ("root" === entry.tryLoc) return handle("end"); if (entry.tryLoc <= this.prev) { var hasCatch = hasOwn.call(entry, "catchLoc"), hasFinally = hasOwn.call(entry, "finallyLoc"); if (hasCatch && hasFinally) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } else if (hasCatch) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); } else { if (!hasFinally) throw new Error("try statement without catch or finally"); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } } } }, abrupt: function abrupt(type, arg) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc <= this.prev && hasOwn.call(entry, "finallyLoc") && this.prev < entry.finallyLoc) { var finallyEntry = entry; break; } } finallyEntry && ("break" === type || "continue" === type) && finallyEntry.tryLoc <= arg && arg <= finallyEntry.finallyLoc && (finallyEntry = null); var record = finallyEntry ? finallyEntry.completion : {}; return record.type = type, record.arg = arg, finallyEntry ? (this.method = "next", this.next = finallyEntry.finallyLoc, ContinueSentinel) : this.complete(record); }, complete: function complete(record, afterLoc) { if ("throw" === record.type) throw record.arg; return "break" === record.type || "continue" === record.type ? this.next = record.arg : "return" === record.type ? (this.rval = this.arg = record.arg, this.method = "return", this.next = "end") : "normal" === record.type && afterLoc && (this.next = afterLoc), ContinueSentinel; }, finish: function finish(finallyLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.finallyLoc === finallyLoc) return this.complete(entry.completion, entry.afterLoc), resetTryEntry(entry), ContinueSentinel; } }, catch: function _catch(tryLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc === tryLoc) { var record = entry.completion; if ("throw" === record.type) { var thrown = record.arg; resetTryEntry(entry); } return thrown; } } throw new Error("illegal catch attempt"); }, delegateYield: function delegateYield(iterable, resultName, nextLoc) { return this.delegate = { iterator: values(iterable), resultName: resultName, nextLoc: nextLoc }, "next" === this.method && (this.arg = undefined), ContinueSentinel; } }, exports; }
13
14
  /**
14
15
  * useSmartLinkClientExtension
15
16
  *
@@ -21,9 +22,9 @@ var _useResolverUrl = require("../use-resolver-url");
21
22
  var useSmartLinkClientExtension = function useSmartLinkClientExtension(cardClient) {
22
23
  var resolvedUrl = (0, _useResolverUrl.useResolverUrl)(cardClient);
23
24
  var invoke = (0, _react.useCallback)( /*#__PURE__*/function () {
24
- var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(data) {
25
+ var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(data) {
25
26
  var response;
26
- return _regenerator.default.wrap(function _callee$(_context) {
27
+ return _regeneratorRuntime().wrap(function _callee$(_context) {
27
28
  while (1) {
28
29
  switch (_context.prev = _context.next) {
29
30
  case 0:
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/link-client-extension",
3
- "version": "0.3.0",
3
+ "version": "0.4.1",
4
4
  "sideEffects": false
5
5
  }
@@ -1 +1,2 @@
1
- export { useSmartLinkClientExtension } from './services/use-smart-link-client-extension';
1
+ export { useSmartLinkClientExtension } from './services/use-smart-link-client-extension';
2
+ export { useDatasourceClientExtension } from './services/use-data-source-client-extension';
@@ -0,0 +1,12 @@
1
+ import { useCallback, useMemo } from 'react';
2
+ import { request } from '@atlaskit/linking-common';
3
+ import { useResolverUrl } from '../use-resolver-url';
4
+ export const useDatasourceClientExtension = cardClient => {
5
+ const resolverUrl = useResolverUrl(cardClient);
6
+ const getDatasourceDetails = useCallback((datasourceId, data) => request('post', `${resolverUrl}/datasource/${datasourceId}/fetch/details`, data, undefined, [200, 201, 202, 203, 204]), [resolverUrl]);
7
+ const getDatasourceData = useCallback((datasourceId, data) => request('post', `${resolverUrl}/datasource/${datasourceId}/fetch/data`, data, undefined, [200, 201, 202, 203, 204]), [resolverUrl]);
8
+ return useMemo(() => ({
9
+ getDatasourceDetails,
10
+ getDatasourceData
11
+ }), [getDatasourceDetails, getDatasourceData]);
12
+ };
@@ -0,0 +1,75 @@
1
+ export const mockDatasourceDataResponse = {
2
+ data: [{
3
+ id: 'EDM-12',
4
+ description: 'Design datasource feature',
5
+ createdAt: '2023-01-22T01:30:00.000-05:00',
6
+ assigned: {
7
+ displayName: 'Sasha'
8
+ },
9
+ state: 'IN PROGRESS'
10
+ }, {
11
+ id: 'EDM-14',
12
+ description: 'Implement datasource feature',
13
+ createdAt: '2023-03-01T01:30:00.000-05:00',
14
+ assigned: {
15
+ displayName: 'Hana'
16
+ },
17
+ state: 'TO DO'
18
+ }, {
19
+ id: 'EDM-15',
20
+ description: 'Add Jira Provider',
21
+ createdAt: '2023-03-31T01:30:00.000-05:00',
22
+ assigned: {
23
+ displayName: 'Princey'
24
+ },
25
+ state: 'TO DO'
26
+ }, {
27
+ id: 'EDM-16',
28
+ description: 'Plan team party',
29
+ createdAt: '2023-05-01T01:30:00.000-05:00',
30
+ assigned: {
31
+ displayName: 'Nidhin'
32
+ },
33
+ state: 'TO DO'
34
+ }],
35
+ nextPageCursor: 'c3RhcnRBdD01'
36
+ };
37
+ export const mockDatasourceResponse = {
38
+ ari: 'ari:cloud:linking-platform:datasource/12e74246-a3f1-46c1-9fd9-8d952aa9f12f',
39
+ id: '12e74246-a3f1-46c1-9fd9-8d952aa9f12f',
40
+ name: 'JQL Datasource',
41
+ description: 'Fetches Issues using JQL',
42
+ parameters: [{
43
+ key: 'cloudId',
44
+ type: 'string',
45
+ description: 'Cloud Id'
46
+ }, {
47
+ key: 'jql',
48
+ type: 'string',
49
+ description: 'JQL query to retrieve list of issues'
50
+ }],
51
+ schema: {
52
+ properties: [{
53
+ key: 'id',
54
+ type: 'string',
55
+ title: 'Id'
56
+ }, {
57
+ key: 'description',
58
+ type: 'link',
59
+ title: 'Description'
60
+ }, {
61
+ key: 'createdAt',
62
+ type: 'date',
63
+ title: 'Created At'
64
+ }, {
65
+ key: 'assigned',
66
+ type: 'user',
67
+ title: 'Assignee'
68
+ }, {
69
+ key: 'state',
70
+ type: 'status',
71
+ title: 'Status'
72
+ }],
73
+ defaultProperties: ['id', 'description', 'assigned', 'state']
74
+ }
75
+ };
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/link-client-extension",
3
- "version": "0.3.0",
3
+ "version": "0.4.1",
4
4
  "sideEffects": false
5
5
  }
package/dist/esm/index.js CHANGED
@@ -1 +1,2 @@
1
- export { useSmartLinkClientExtension } from './services/use-smart-link-client-extension';
1
+ export { useSmartLinkClientExtension } from './services/use-smart-link-client-extension';
2
+ export { useDatasourceClientExtension } from './services/use-data-source-client-extension';
@@ -0,0 +1,18 @@
1
+ import { useCallback, useMemo } from 'react';
2
+ import { request } from '@atlaskit/linking-common';
3
+ import { useResolverUrl } from '../use-resolver-url';
4
+ export var useDatasourceClientExtension = function useDatasourceClientExtension(cardClient) {
5
+ var resolverUrl = useResolverUrl(cardClient);
6
+ var getDatasourceDetails = useCallback(function (datasourceId, data) {
7
+ return request('post', "".concat(resolverUrl, "/datasource/").concat(datasourceId, "/fetch/details"), data, undefined, [200, 201, 202, 203, 204]);
8
+ }, [resolverUrl]);
9
+ var getDatasourceData = useCallback(function (datasourceId, data) {
10
+ return request('post', "".concat(resolverUrl, "/datasource/").concat(datasourceId, "/fetch/data"), data, undefined, [200, 201, 202, 203, 204]);
11
+ }, [resolverUrl]);
12
+ return useMemo(function () {
13
+ return {
14
+ getDatasourceDetails: getDatasourceDetails,
15
+ getDatasourceData: getDatasourceData
16
+ };
17
+ }, [getDatasourceDetails, getDatasourceData]);
18
+ };
@@ -0,0 +1,75 @@
1
+ export var mockDatasourceDataResponse = {
2
+ data: [{
3
+ id: 'EDM-12',
4
+ description: 'Design datasource feature',
5
+ createdAt: '2023-01-22T01:30:00.000-05:00',
6
+ assigned: {
7
+ displayName: 'Sasha'
8
+ },
9
+ state: 'IN PROGRESS'
10
+ }, {
11
+ id: 'EDM-14',
12
+ description: 'Implement datasource feature',
13
+ createdAt: '2023-03-01T01:30:00.000-05:00',
14
+ assigned: {
15
+ displayName: 'Hana'
16
+ },
17
+ state: 'TO DO'
18
+ }, {
19
+ id: 'EDM-15',
20
+ description: 'Add Jira Provider',
21
+ createdAt: '2023-03-31T01:30:00.000-05:00',
22
+ assigned: {
23
+ displayName: 'Princey'
24
+ },
25
+ state: 'TO DO'
26
+ }, {
27
+ id: 'EDM-16',
28
+ description: 'Plan team party',
29
+ createdAt: '2023-05-01T01:30:00.000-05:00',
30
+ assigned: {
31
+ displayName: 'Nidhin'
32
+ },
33
+ state: 'TO DO'
34
+ }],
35
+ nextPageCursor: 'c3RhcnRBdD01'
36
+ };
37
+ export var mockDatasourceResponse = {
38
+ ari: 'ari:cloud:linking-platform:datasource/12e74246-a3f1-46c1-9fd9-8d952aa9f12f',
39
+ id: '12e74246-a3f1-46c1-9fd9-8d952aa9f12f',
40
+ name: 'JQL Datasource',
41
+ description: 'Fetches Issues using JQL',
42
+ parameters: [{
43
+ key: 'cloudId',
44
+ type: 'string',
45
+ description: 'Cloud Id'
46
+ }, {
47
+ key: 'jql',
48
+ type: 'string',
49
+ description: 'JQL query to retrieve list of issues'
50
+ }],
51
+ schema: {
52
+ properties: [{
53
+ key: 'id',
54
+ type: 'string',
55
+ title: 'Id'
56
+ }, {
57
+ key: 'description',
58
+ type: 'link',
59
+ title: 'Description'
60
+ }, {
61
+ key: 'createdAt',
62
+ type: 'date',
63
+ title: 'Created At'
64
+ }, {
65
+ key: 'assigned',
66
+ type: 'user',
67
+ title: 'Assignee'
68
+ }, {
69
+ key: 'state',
70
+ type: 'status',
71
+ title: 'Status'
72
+ }],
73
+ defaultProperties: ['id', 'description', 'assigned', 'state']
74
+ }
75
+ };
@@ -1,5 +1,6 @@
1
+ import _typeof from "@babel/runtime/helpers/typeof";
1
2
  import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
2
- import _regeneratorRuntime from "@babel/runtime/regenerator";
3
+ function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return exports; }; var exports = {}, Op = Object.prototype, hasOwn = Op.hasOwnProperty, defineProperty = Object.defineProperty || function (obj, key, desc) { obj[key] = desc.value; }, $Symbol = "function" == typeof Symbol ? Symbol : {}, iteratorSymbol = $Symbol.iterator || "@@iterator", asyncIteratorSymbol = $Symbol.asyncIterator || "@@asyncIterator", toStringTagSymbol = $Symbol.toStringTag || "@@toStringTag"; function define(obj, key, value) { return Object.defineProperty(obj, key, { value: value, enumerable: !0, configurable: !0, writable: !0 }), obj[key]; } try { define({}, ""); } catch (err) { define = function define(obj, key, value) { return obj[key] = value; }; } function wrap(innerFn, outerFn, self, tryLocsList) { var protoGenerator = outerFn && outerFn.prototype instanceof Generator ? outerFn : Generator, generator = Object.create(protoGenerator.prototype), context = new Context(tryLocsList || []); return defineProperty(generator, "_invoke", { value: makeInvokeMethod(innerFn, self, context) }), generator; } function tryCatch(fn, obj, arg) { try { return { type: "normal", arg: fn.call(obj, arg) }; } catch (err) { return { type: "throw", arg: err }; } } exports.wrap = wrap; var ContinueSentinel = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var IteratorPrototype = {}; define(IteratorPrototype, iteratorSymbol, function () { return this; }); var getProto = Object.getPrototypeOf, NativeIteratorPrototype = getProto && getProto(getProto(values([]))); NativeIteratorPrototype && NativeIteratorPrototype !== Op && hasOwn.call(NativeIteratorPrototype, iteratorSymbol) && (IteratorPrototype = NativeIteratorPrototype); var Gp = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(IteratorPrototype); function defineIteratorMethods(prototype) { ["next", "throw", "return"].forEach(function (method) { define(prototype, method, function (arg) { return this._invoke(method, arg); }); }); } function AsyncIterator(generator, PromiseImpl) { function invoke(method, arg, resolve, reject) { var record = tryCatch(generator[method], generator, arg); if ("throw" !== record.type) { var result = record.arg, value = result.value; return value && "object" == _typeof(value) && hasOwn.call(value, "__await") ? PromiseImpl.resolve(value.__await).then(function (value) { invoke("next", value, resolve, reject); }, function (err) { invoke("throw", err, resolve, reject); }) : PromiseImpl.resolve(value).then(function (unwrapped) { result.value = unwrapped, resolve(result); }, function (error) { return invoke("throw", error, resolve, reject); }); } reject(record.arg); } var previousPromise; defineProperty(this, "_invoke", { value: function value(method, arg) { function callInvokeWithMethodAndArg() { return new PromiseImpl(function (resolve, reject) { invoke(method, arg, resolve, reject); }); } return previousPromise = previousPromise ? previousPromise.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(innerFn, self, context) { var state = "suspendedStart"; return function (method, arg) { if ("executing" === state) throw new Error("Generator is already running"); if ("completed" === state) { if ("throw" === method) throw arg; return doneResult(); } for (context.method = method, context.arg = arg;;) { var delegate = context.delegate; if (delegate) { var delegateResult = maybeInvokeDelegate(delegate, context); if (delegateResult) { if (delegateResult === ContinueSentinel) continue; return delegateResult; } } if ("next" === context.method) context.sent = context._sent = context.arg;else if ("throw" === context.method) { if ("suspendedStart" === state) throw state = "completed", context.arg; context.dispatchException(context.arg); } else "return" === context.method && context.abrupt("return", context.arg); state = "executing"; var record = tryCatch(innerFn, self, context); if ("normal" === record.type) { if (state = context.done ? "completed" : "suspendedYield", record.arg === ContinueSentinel) continue; return { value: record.arg, done: context.done }; } "throw" === record.type && (state = "completed", context.method = "throw", context.arg = record.arg); } }; } function maybeInvokeDelegate(delegate, context) { var methodName = context.method, method = delegate.iterator[methodName]; if (undefined === method) return context.delegate = null, "throw" === methodName && delegate.iterator.return && (context.method = "return", context.arg = undefined, maybeInvokeDelegate(delegate, context), "throw" === context.method) || "return" !== methodName && (context.method = "throw", context.arg = new TypeError("The iterator does not provide a '" + methodName + "' method")), ContinueSentinel; var record = tryCatch(method, delegate.iterator, context.arg); if ("throw" === record.type) return context.method = "throw", context.arg = record.arg, context.delegate = null, ContinueSentinel; var info = record.arg; return info ? info.done ? (context[delegate.resultName] = info.value, context.next = delegate.nextLoc, "return" !== context.method && (context.method = "next", context.arg = undefined), context.delegate = null, ContinueSentinel) : info : (context.method = "throw", context.arg = new TypeError("iterator result is not an object"), context.delegate = null, ContinueSentinel); } function pushTryEntry(locs) { var entry = { tryLoc: locs[0] }; 1 in locs && (entry.catchLoc = locs[1]), 2 in locs && (entry.finallyLoc = locs[2], entry.afterLoc = locs[3]), this.tryEntries.push(entry); } function resetTryEntry(entry) { var record = entry.completion || {}; record.type = "normal", delete record.arg, entry.completion = record; } function Context(tryLocsList) { this.tryEntries = [{ tryLoc: "root" }], tryLocsList.forEach(pushTryEntry, this), this.reset(!0); } function values(iterable) { if (iterable) { var iteratorMethod = iterable[iteratorSymbol]; if (iteratorMethod) return iteratorMethod.call(iterable); if ("function" == typeof iterable.next) return iterable; if (!isNaN(iterable.length)) { var i = -1, next = function next() { for (; ++i < iterable.length;) { if (hasOwn.call(iterable, i)) return next.value = iterable[i], next.done = !1, next; } return next.value = undefined, next.done = !0, next; }; return next.next = next; } } return { next: doneResult }; } function doneResult() { return { value: undefined, done: !0 }; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, defineProperty(Gp, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), defineProperty(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, toStringTagSymbol, "GeneratorFunction"), exports.isGeneratorFunction = function (genFun) { var ctor = "function" == typeof genFun && genFun.constructor; return !!ctor && (ctor === GeneratorFunction || "GeneratorFunction" === (ctor.displayName || ctor.name)); }, exports.mark = function (genFun) { return Object.setPrototypeOf ? Object.setPrototypeOf(genFun, GeneratorFunctionPrototype) : (genFun.__proto__ = GeneratorFunctionPrototype, define(genFun, toStringTagSymbol, "GeneratorFunction")), genFun.prototype = Object.create(Gp), genFun; }, exports.awrap = function (arg) { return { __await: arg }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, asyncIteratorSymbol, function () { return this; }), exports.AsyncIterator = AsyncIterator, exports.async = function (innerFn, outerFn, self, tryLocsList, PromiseImpl) { void 0 === PromiseImpl && (PromiseImpl = Promise); var iter = new AsyncIterator(wrap(innerFn, outerFn, self, tryLocsList), PromiseImpl); return exports.isGeneratorFunction(outerFn) ? iter : iter.next().then(function (result) { return result.done ? result.value : iter.next(); }); }, defineIteratorMethods(Gp), define(Gp, toStringTagSymbol, "Generator"), define(Gp, iteratorSymbol, function () { return this; }), define(Gp, "toString", function () { return "[object Generator]"; }), exports.keys = function (val) { var object = Object(val), keys = []; for (var key in object) { keys.push(key); } return keys.reverse(), function next() { for (; keys.length;) { var key = keys.pop(); if (key in object) return next.value = key, next.done = !1, next; } return next.done = !0, next; }; }, exports.values = values, Context.prototype = { constructor: Context, reset: function reset(skipTempReset) { if (this.prev = 0, this.next = 0, this.sent = this._sent = undefined, this.done = !1, this.delegate = null, this.method = "next", this.arg = undefined, this.tryEntries.forEach(resetTryEntry), !skipTempReset) for (var name in this) { "t" === name.charAt(0) && hasOwn.call(this, name) && !isNaN(+name.slice(1)) && (this[name] = undefined); } }, stop: function stop() { this.done = !0; var rootRecord = this.tryEntries[0].completion; if ("throw" === rootRecord.type) throw rootRecord.arg; return this.rval; }, dispatchException: function dispatchException(exception) { if (this.done) throw exception; var context = this; function handle(loc, caught) { return record.type = "throw", record.arg = exception, context.next = loc, caught && (context.method = "next", context.arg = undefined), !!caught; } for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i], record = entry.completion; if ("root" === entry.tryLoc) return handle("end"); if (entry.tryLoc <= this.prev) { var hasCatch = hasOwn.call(entry, "catchLoc"), hasFinally = hasOwn.call(entry, "finallyLoc"); if (hasCatch && hasFinally) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } else if (hasCatch) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); } else { if (!hasFinally) throw new Error("try statement without catch or finally"); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } } } }, abrupt: function abrupt(type, arg) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc <= this.prev && hasOwn.call(entry, "finallyLoc") && this.prev < entry.finallyLoc) { var finallyEntry = entry; break; } } finallyEntry && ("break" === type || "continue" === type) && finallyEntry.tryLoc <= arg && arg <= finallyEntry.finallyLoc && (finallyEntry = null); var record = finallyEntry ? finallyEntry.completion : {}; return record.type = type, record.arg = arg, finallyEntry ? (this.method = "next", this.next = finallyEntry.finallyLoc, ContinueSentinel) : this.complete(record); }, complete: function complete(record, afterLoc) { if ("throw" === record.type) throw record.arg; return "break" === record.type || "continue" === record.type ? this.next = record.arg : "return" === record.type ? (this.rval = this.arg = record.arg, this.method = "return", this.next = "end") : "normal" === record.type && afterLoc && (this.next = afterLoc), ContinueSentinel; }, finish: function finish(finallyLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.finallyLoc === finallyLoc) return this.complete(entry.completion, entry.afterLoc), resetTryEntry(entry), ContinueSentinel; } }, catch: function _catch(tryLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc === tryLoc) { var record = entry.completion; if ("throw" === record.type) { var thrown = record.arg; resetTryEntry(entry); } return thrown; } } throw new Error("illegal catch attempt"); }, delegateYield: function delegateYield(iterable, resultName, nextLoc) { return this.delegate = { iterator: values(iterable), resultName: resultName, nextLoc: nextLoc }, "next" === this.method && (this.arg = undefined), ContinueSentinel; } }, exports; }
3
4
  import { useCallback, useMemo } from 'react';
4
5
  import { request } from '@atlaskit/linking-common';
5
6
  import { useResolverUrl } from '../use-resolver-url';
@@ -15,9 +16,9 @@ import { useResolverUrl } from '../use-resolver-url';
15
16
  export var useSmartLinkClientExtension = function useSmartLinkClientExtension(cardClient) {
16
17
  var resolvedUrl = useResolverUrl(cardClient);
17
18
  var invoke = useCallback( /*#__PURE__*/function () {
18
- var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(data) {
19
+ var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(data) {
19
20
  var response;
20
- return _regeneratorRuntime.wrap(function _callee$(_context) {
21
+ return _regeneratorRuntime().wrap(function _callee$(_context) {
21
22
  while (1) {
22
23
  switch (_context.prev = _context.next) {
23
24
  case 0:
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/link-client-extension",
3
- "version": "0.3.0",
3
+ "version": "0.4.1",
4
4
  "sideEffects": false
5
5
  }
@@ -1 +1,2 @@
1
1
  export { useSmartLinkClientExtension } from './services/use-smart-link-client-extension';
2
+ export { useDatasourceClientExtension } from './services/use-data-source-client-extension';
@@ -0,0 +1,6 @@
1
+ import type { CardClient } from '@atlaskit/link-provider';
2
+ import type { DatasourceDataRequest, DatasourceDataResponse, DatasourceParameters, DatasourceResponse } from '@atlaskit/linking-types';
3
+ export declare const useDatasourceClientExtension: (cardClient: CardClient) => {
4
+ getDatasourceDetails: (datasourceId: string, data: DatasourceParameters) => Promise<DatasourceResponse>;
5
+ getDatasourceData: (datasourceId: string, data: DatasourceDataRequest) => Promise<DatasourceDataResponse>;
6
+ };
@@ -0,0 +1,3 @@
1
+ import type { DatasourceDataResponse, DatasourceResponse } from '@atlaskit/linking-types';
2
+ export declare const mockDatasourceDataResponse: DatasourceDataResponse;
3
+ export declare const mockDatasourceResponse: DatasourceResponse;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/link-client-extension",
3
- "version": "0.3.0",
3
+ "version": "0.4.1",
4
4
  "description": "Extension methods for linking platform client",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -27,11 +27,11 @@
27
27
  },
28
28
  "dependencies": {
29
29
  "@atlaskit/linking-common": "^2.4.0",
30
- "@atlaskit/linking-types": "^0.3.0",
30
+ "@atlaskit/linking-types": "^0.4.0",
31
31
  "@babel/runtime": "^7.0.0"
32
32
  },
33
33
  "peerDependencies": {
34
- "@atlaskit/link-provider": "^1.5.0",
34
+ "@atlaskit/link-provider": "^1.5.3",
35
35
  "react": "^16.8.0"
36
36
  },
37
37
  "devDependencies": {
package/report.api.md CHANGED
@@ -16,9 +16,25 @@
16
16
 
17
17
  ```ts
18
18
  import type { CardClient } from '@atlaskit/link-provider';
19
+ import type { DatasourceDataRequest } from '@atlaskit/linking-types';
20
+ import type { DatasourceDataResponse } from '@atlaskit/linking-types';
21
+ import type { DatasourceParameters } from '@atlaskit/linking-types';
22
+ import type { DatasourceResponse } from '@atlaskit/linking-types';
19
23
  import type { InvokeRequest } from '@atlaskit/linking-types/smart-link-actions';
20
24
  import type { InvokeResponse } from '@atlaskit/linking-types/smart-link-actions';
21
25
 
26
+ // @public (undocumented)
27
+ export const useDatasourceClientExtension: (cardClient: CardClient) => {
28
+ getDatasourceDetails: (
29
+ datasourceId: string,
30
+ data: DatasourceParameters,
31
+ ) => Promise<DatasourceResponse>;
32
+ getDatasourceData: (
33
+ datasourceId: string,
34
+ data: DatasourceDataRequest,
35
+ ) => Promise<DatasourceDataResponse>;
36
+ };
37
+
22
38
  // @public
23
39
  export const useSmartLinkClientExtension: (cardClient: CardClient) => {
24
40
  invoke: (data: InvokeRequest) => Promise<InvokeResponse>;
@@ -35,7 +51,7 @@ export const useSmartLinkClientExtension: (cardClient: CardClient) => {
35
51
 
36
52
  ```json
37
53
  {
38
- "@atlaskit/link-provider": "^1.5.0",
54
+ "@atlaskit/link-provider": "^1.5.3",
39
55
  "react": "^16.8.0"
40
56
  }
41
57
  ```
@@ -5,9 +5,19 @@
5
5
  ```ts
6
6
 
7
7
  import type { CardClient } from '@atlaskit/link-provider';
8
+ import type { DatasourceDataRequest } from '@atlaskit/linking-types';
9
+ import type { DatasourceDataResponse } from '@atlaskit/linking-types';
10
+ import type { DatasourceParameters } from '@atlaskit/linking-types';
11
+ import type { DatasourceResponse } from '@atlaskit/linking-types';
8
12
  import type { InvokeRequest } from '@atlaskit/linking-types/smart-link-actions';
9
13
  import type { InvokeResponse } from '@atlaskit/linking-types/smart-link-actions';
10
14
 
15
+ // @public (undocumented)
16
+ export const useDatasourceClientExtension: (cardClient: CardClient) => {
17
+ getDatasourceDetails: (datasourceId: string, data: DatasourceParameters) => Promise<DatasourceResponse>;
18
+ getDatasourceData: (datasourceId: string, data: DatasourceDataRequest) => Promise<DatasourceDataResponse>;
19
+ };
20
+
11
21
  // @public
12
22
  export const useSmartLinkClientExtension: (cardClient: CardClient) => {
13
23
  invoke: (data: InvokeRequest) => Promise<InvokeResponse>;