@atlaskit/link-datasource 0.27.3 → 0.27.4

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,11 @@
1
1
  # @atlaskit/link-datasource
2
2
 
3
+ ## 0.27.4
4
+
5
+ ### Patch Changes
6
+
7
+ - [`45562e99798`](https://bitbucket.org/atlassian/atlassian-frontend/commits/45562e99798) - Added cmdbService, useAssetsClient hook and useValidateAqlText hook
8
+
3
9
  ## 0.27.3
4
10
 
5
11
  ### Patch Changes
@@ -0,0 +1,70 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ Object.defineProperty(exports, "__esModule", {
5
+ value: true
6
+ });
7
+ exports.useAssetsClient = void 0;
8
+ var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
9
+ var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
10
+ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
11
+ var _react = require("react");
12
+ var _cmdbService = require("../services/cmdbService");
13
+ // TODO: Pass in localhost:3000 for testing locally - remember to remove this code after
14
+ // You must also have a proxy server running to forward requests from http://localhost:3000 to a JSM premium url
15
+ var useAssetsClient = function useAssetsClient(hostname) {
16
+ var _useState = (0, _react.useState)(),
17
+ _useState2 = (0, _slicedToArray2.default)(_useState, 2),
18
+ objectSchemas = _useState2[0],
19
+ setObjectSchemas = _useState2[1];
20
+ var _useState3 = (0, _react.useState)(),
21
+ _useState4 = (0, _slicedToArray2.default)(_useState3, 2),
22
+ workspaceId = _useState4[0],
23
+ setWorkspaceId = _useState4[1];
24
+ var _useState5 = (0, _react.useState)(),
25
+ _useState6 = (0, _slicedToArray2.default)(_useState5, 2),
26
+ error = _useState6[0],
27
+ setError = _useState6[1];
28
+ (0, _react.useEffect)(function () {
29
+ (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
30
+ var _workspaceId, objectSchemasResponse;
31
+ return _regenerator.default.wrap(function _callee$(_context) {
32
+ while (1) switch (_context.prev = _context.next) {
33
+ case 0:
34
+ _context.prev = 0;
35
+ _context.next = 3;
36
+ return (0, _cmdbService.getWorkspaceId)(hostname);
37
+ case 3:
38
+ _workspaceId = _context.sent;
39
+ _context.next = 6;
40
+ return (0, _cmdbService.fetchObjectSchemas)(_workspaceId, hostname);
41
+ case 6:
42
+ objectSchemasResponse = _context.sent;
43
+ setWorkspaceId(_workspaceId);
44
+ setObjectSchemas(objectSchemasResponse.values);
45
+ _context.next = 14;
46
+ break;
47
+ case 11:
48
+ _context.prev = 11;
49
+ _context.t0 = _context["catch"](0);
50
+ if (_context.t0 instanceof Error) {
51
+ setError(_context.t0);
52
+ } else {
53
+ setError(new Error('Unexpected error occured'));
54
+ // eslint-disable-next-line no-console
55
+ console.error(_context.t0);
56
+ }
57
+ case 14:
58
+ case "end":
59
+ return _context.stop();
60
+ }
61
+ }, _callee, null, [[0, 11]]);
62
+ }))();
63
+ }, [hostname]);
64
+ return {
65
+ workspaceId: workspaceId,
66
+ objectSchemas: objectSchemas,
67
+ error: error
68
+ };
69
+ };
70
+ exports.useAssetsClient = useAssetsClient;
@@ -0,0 +1,48 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ Object.defineProperty(exports, "__esModule", {
5
+ value: true
6
+ });
7
+ exports.useValidateAqlText = void 0;
8
+ var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
9
+ var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
10
+ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
11
+ var _react = require("react");
12
+ var _cmdbService = require("../services/cmdbService");
13
+ var useValidateAqlText = function useValidateAqlText(workspaceId, hostname) {
14
+ var _useState = (0, _react.useState)(false),
15
+ _useState2 = (0, _slicedToArray2.default)(_useState, 2),
16
+ isLoading = _useState2[0],
17
+ setIsLoading = _useState2[1];
18
+ var validateAqlText = (0, _react.useCallback)( /*#__PURE__*/function () {
19
+ var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(aql) {
20
+ var validateAqlResponse;
21
+ return _regenerator.default.wrap(function _callee$(_context) {
22
+ while (1) switch (_context.prev = _context.next) {
23
+ case 0:
24
+ setIsLoading(true);
25
+ _context.next = 3;
26
+ return (0, _cmdbService.validateAql)(workspaceId, {
27
+ qlQuery: aql
28
+ }, hostname);
29
+ case 3:
30
+ validateAqlResponse = _context.sent;
31
+ setIsLoading(false);
32
+ return _context.abrupt("return", validateAqlResponse.isValid);
33
+ case 6:
34
+ case "end":
35
+ return _context.stop();
36
+ }
37
+ }, _callee);
38
+ }));
39
+ return function (_x) {
40
+ return _ref.apply(this, arguments);
41
+ };
42
+ }(), [hostname, workspaceId]);
43
+ return {
44
+ validateAqlText: validateAqlText,
45
+ isLoading: isLoading
46
+ };
47
+ };
48
+ exports.useValidateAqlText = useValidateAqlText;
@@ -0,0 +1,53 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ Object.defineProperty(exports, "__esModule", {
5
+ value: true
6
+ });
7
+ exports.validateAql = exports.getWorkspaceId = exports.fetchObjectSchemas = void 0;
8
+ var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
9
+ var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
10
+ var _linkingCommon = require("@atlaskit/linking-common");
11
+ var getWorkspaceId = /*#__PURE__*/function () {
12
+ var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(hostname) {
13
+ var _workspaceDetailsResp;
14
+ var url, workspaceDetailsResponse;
15
+ return _regenerator.default.wrap(function _callee$(_context) {
16
+ while (1) switch (_context.prev = _context.next) {
17
+ case 0:
18
+ url = "".concat(hostname || '', "/rest/servicedesk/cmdb/latest/workspace");
19
+ _context.next = 3;
20
+ return (0, _linkingCommon.request)('get', url, undefined, undefined, [200, 201, 202, 203, 204]);
21
+ case 3:
22
+ workspaceDetailsResponse = _context.sent;
23
+ if ((_workspaceDetailsResp = workspaceDetailsResponse.results) !== null && _workspaceDetailsResp !== void 0 && _workspaceDetailsResp.length) {
24
+ _context.next = 6;
25
+ break;
26
+ }
27
+ throw new Error('No workspace results found');
28
+ case 6:
29
+ return _context.abrupt("return", workspaceDetailsResponse.results[0].id);
30
+ case 7:
31
+ case "end":
32
+ return _context.stop();
33
+ }
34
+ }, _callee);
35
+ }));
36
+ return function getWorkspaceId(_x) {
37
+ return _ref.apply(this, arguments);
38
+ };
39
+ }();
40
+ exports.getWorkspaceId = getWorkspaceId;
41
+ var validateAql = function validateAql(workspaceId, data, hostname) {
42
+ var url = "".concat(hostname || '', "/gateway/api/jsm/assets/workspace/").concat(workspaceId, "/v1/aql/validate");
43
+ return (0, _linkingCommon.request)('post', url, {
44
+ qlQuery: data.qlQuery,
45
+ context: 'SMART_LINKS'
46
+ }, undefined, [200, 201, 202, 203, 204]);
47
+ };
48
+ exports.validateAql = validateAql;
49
+ var fetchObjectSchemas = function fetchObjectSchemas(workspaceId, hostname) {
50
+ var url = "".concat(hostname || '', "/gateway/api/jsm/assets/workspace/").concat(workspaceId, "/v1/objectschema/list?maxResults=100");
51
+ return (0, _linkingCommon.request)('get', url, undefined, undefined, [200, 201, 202, 203, 204]);
52
+ };
53
+ exports.fetchObjectSchemas = fetchObjectSchemas;
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/link-datasource",
3
- "version": "0.27.3",
3
+ "version": "0.27.4",
4
4
  "sideEffects": false
5
5
  }
@@ -0,0 +1,32 @@
1
+ import { useEffect, useState } from 'react';
2
+ import { fetchObjectSchemas, getWorkspaceId } from '../services/cmdbService';
3
+ // TODO: Pass in localhost:3000 for testing locally - remember to remove this code after
4
+ // You must also have a proxy server running to forward requests from http://localhost:3000 to a JSM premium url
5
+ export const useAssetsClient = hostname => {
6
+ const [objectSchemas, setObjectSchemas] = useState();
7
+ const [workspaceId, setWorkspaceId] = useState();
8
+ const [error, setError] = useState();
9
+ useEffect(() => {
10
+ (async () => {
11
+ try {
12
+ const workspaceId = await getWorkspaceId(hostname);
13
+ const objectSchemasResponse = await fetchObjectSchemas(workspaceId, hostname);
14
+ setWorkspaceId(workspaceId);
15
+ setObjectSchemas(objectSchemasResponse.values);
16
+ } catch (err) {
17
+ if (err instanceof Error) {
18
+ setError(err);
19
+ } else {
20
+ setError(new Error('Unexpected error occured'));
21
+ // eslint-disable-next-line no-console
22
+ console.error(err);
23
+ }
24
+ }
25
+ })();
26
+ }, [hostname]);
27
+ return {
28
+ workspaceId,
29
+ objectSchemas,
30
+ error
31
+ };
32
+ };
@@ -0,0 +1,17 @@
1
+ import { useCallback, useState } from 'react';
2
+ import { validateAql } from '../services/cmdbService';
3
+ export const useValidateAqlText = (workspaceId, hostname) => {
4
+ const [isLoading, setIsLoading] = useState(false);
5
+ const validateAqlText = useCallback(async aql => {
6
+ setIsLoading(true);
7
+ const validateAqlResponse = await validateAql(workspaceId, {
8
+ qlQuery: aql
9
+ }, hostname);
10
+ setIsLoading(false);
11
+ return validateAqlResponse.isValid;
12
+ }, [hostname, workspaceId]);
13
+ return {
14
+ validateAqlText,
15
+ isLoading
16
+ };
17
+ };
@@ -0,0 +1,21 @@
1
+ import { request } from '@atlaskit/linking-common';
2
+ export const getWorkspaceId = async hostname => {
3
+ var _workspaceDetailsResp;
4
+ const url = `${hostname || ''}/rest/servicedesk/cmdb/latest/workspace`;
5
+ const workspaceDetailsResponse = await request('get', url, undefined, undefined, [200, 201, 202, 203, 204]);
6
+ if (!((_workspaceDetailsResp = workspaceDetailsResponse.results) !== null && _workspaceDetailsResp !== void 0 && _workspaceDetailsResp.length)) {
7
+ throw new Error('No workspace results found');
8
+ }
9
+ return workspaceDetailsResponse.results[0].id;
10
+ };
11
+ export const validateAql = (workspaceId, data, hostname) => {
12
+ const url = `${hostname || ''}/gateway/api/jsm/assets/workspace/${workspaceId}/v1/aql/validate`;
13
+ return request('post', url, {
14
+ qlQuery: data.qlQuery,
15
+ context: 'SMART_LINKS'
16
+ }, undefined, [200, 201, 202, 203, 204]);
17
+ };
18
+ export const fetchObjectSchemas = (workspaceId, hostname) => {
19
+ const url = `${hostname || ''}/gateway/api/jsm/assets/workspace/${workspaceId}/v1/objectschema/list?maxResults=100`;
20
+ return request('get', url, undefined, undefined, [200, 201, 202, 203, 204]);
21
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/link-datasource",
3
- "version": "0.27.3",
3
+ "version": "0.27.4",
4
4
  "sideEffects": false
5
5
  }
@@ -0,0 +1,62 @@
1
+ import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
2
+ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
3
+ import _regeneratorRuntime from "@babel/runtime/regenerator";
4
+ import { useEffect, useState } from 'react';
5
+ import { fetchObjectSchemas, getWorkspaceId } from '../services/cmdbService';
6
+ // TODO: Pass in localhost:3000 for testing locally - remember to remove this code after
7
+ // You must also have a proxy server running to forward requests from http://localhost:3000 to a JSM premium url
8
+ export var useAssetsClient = function useAssetsClient(hostname) {
9
+ var _useState = useState(),
10
+ _useState2 = _slicedToArray(_useState, 2),
11
+ objectSchemas = _useState2[0],
12
+ setObjectSchemas = _useState2[1];
13
+ var _useState3 = useState(),
14
+ _useState4 = _slicedToArray(_useState3, 2),
15
+ workspaceId = _useState4[0],
16
+ setWorkspaceId = _useState4[1];
17
+ var _useState5 = useState(),
18
+ _useState6 = _slicedToArray(_useState5, 2),
19
+ error = _useState6[0],
20
+ setError = _useState6[1];
21
+ useEffect(function () {
22
+ _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
23
+ var _workspaceId, objectSchemasResponse;
24
+ return _regeneratorRuntime.wrap(function _callee$(_context) {
25
+ while (1) switch (_context.prev = _context.next) {
26
+ case 0:
27
+ _context.prev = 0;
28
+ _context.next = 3;
29
+ return getWorkspaceId(hostname);
30
+ case 3:
31
+ _workspaceId = _context.sent;
32
+ _context.next = 6;
33
+ return fetchObjectSchemas(_workspaceId, hostname);
34
+ case 6:
35
+ objectSchemasResponse = _context.sent;
36
+ setWorkspaceId(_workspaceId);
37
+ setObjectSchemas(objectSchemasResponse.values);
38
+ _context.next = 14;
39
+ break;
40
+ case 11:
41
+ _context.prev = 11;
42
+ _context.t0 = _context["catch"](0);
43
+ if (_context.t0 instanceof Error) {
44
+ setError(_context.t0);
45
+ } else {
46
+ setError(new Error('Unexpected error occured'));
47
+ // eslint-disable-next-line no-console
48
+ console.error(_context.t0);
49
+ }
50
+ case 14:
51
+ case "end":
52
+ return _context.stop();
53
+ }
54
+ }, _callee, null, [[0, 11]]);
55
+ }))();
56
+ }, [hostname]);
57
+ return {
58
+ workspaceId: workspaceId,
59
+ objectSchemas: objectSchemas,
60
+ error: error
61
+ };
62
+ };
@@ -0,0 +1,40 @@
1
+ import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
2
+ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
3
+ import _regeneratorRuntime from "@babel/runtime/regenerator";
4
+ import { useCallback, useState } from 'react';
5
+ import { validateAql } from '../services/cmdbService';
6
+ export var useValidateAqlText = function useValidateAqlText(workspaceId, hostname) {
7
+ var _useState = useState(false),
8
+ _useState2 = _slicedToArray(_useState, 2),
9
+ isLoading = _useState2[0],
10
+ setIsLoading = _useState2[1];
11
+ var validateAqlText = useCallback( /*#__PURE__*/function () {
12
+ var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(aql) {
13
+ var validateAqlResponse;
14
+ return _regeneratorRuntime.wrap(function _callee$(_context) {
15
+ while (1) switch (_context.prev = _context.next) {
16
+ case 0:
17
+ setIsLoading(true);
18
+ _context.next = 3;
19
+ return validateAql(workspaceId, {
20
+ qlQuery: aql
21
+ }, hostname);
22
+ case 3:
23
+ validateAqlResponse = _context.sent;
24
+ setIsLoading(false);
25
+ return _context.abrupt("return", validateAqlResponse.isValid);
26
+ case 6:
27
+ case "end":
28
+ return _context.stop();
29
+ }
30
+ }, _callee);
31
+ }));
32
+ return function (_x) {
33
+ return _ref.apply(this, arguments);
34
+ };
35
+ }(), [hostname, workspaceId]);
36
+ return {
37
+ validateAqlText: validateAqlText,
38
+ isLoading: isLoading
39
+ };
40
+ };
@@ -0,0 +1,43 @@
1
+ import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
2
+ import _regeneratorRuntime from "@babel/runtime/regenerator";
3
+ import { request } from '@atlaskit/linking-common';
4
+ export var getWorkspaceId = /*#__PURE__*/function () {
5
+ var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(hostname) {
6
+ var _workspaceDetailsResp;
7
+ var url, workspaceDetailsResponse;
8
+ return _regeneratorRuntime.wrap(function _callee$(_context) {
9
+ while (1) switch (_context.prev = _context.next) {
10
+ case 0:
11
+ url = "".concat(hostname || '', "/rest/servicedesk/cmdb/latest/workspace");
12
+ _context.next = 3;
13
+ return request('get', url, undefined, undefined, [200, 201, 202, 203, 204]);
14
+ case 3:
15
+ workspaceDetailsResponse = _context.sent;
16
+ if ((_workspaceDetailsResp = workspaceDetailsResponse.results) !== null && _workspaceDetailsResp !== void 0 && _workspaceDetailsResp.length) {
17
+ _context.next = 6;
18
+ break;
19
+ }
20
+ throw new Error('No workspace results found');
21
+ case 6:
22
+ return _context.abrupt("return", workspaceDetailsResponse.results[0].id);
23
+ case 7:
24
+ case "end":
25
+ return _context.stop();
26
+ }
27
+ }, _callee);
28
+ }));
29
+ return function getWorkspaceId(_x) {
30
+ return _ref.apply(this, arguments);
31
+ };
32
+ }();
33
+ export var validateAql = function validateAql(workspaceId, data, hostname) {
34
+ var url = "".concat(hostname || '', "/gateway/api/jsm/assets/workspace/").concat(workspaceId, "/v1/aql/validate");
35
+ return request('post', url, {
36
+ qlQuery: data.qlQuery,
37
+ context: 'SMART_LINKS'
38
+ }, undefined, [200, 201, 202, 203, 204]);
39
+ };
40
+ export var fetchObjectSchemas = function fetchObjectSchemas(workspaceId, hostname) {
41
+ var url = "".concat(hostname || '', "/gateway/api/jsm/assets/workspace/").concat(workspaceId, "/v1/objectschema/list?maxResults=100");
42
+ return request('get', url, undefined, undefined, [200, 201, 202, 203, 204]);
43
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/link-datasource",
3
- "version": "0.27.3",
3
+ "version": "0.27.4",
4
4
  "sideEffects": false
5
5
  }
@@ -0,0 +1,6 @@
1
+ import { ObjectSchema } from '../types/assets/types';
2
+ export declare const useAssetsClient: (hostname?: string) => {
3
+ workspaceId: string | undefined;
4
+ objectSchemas: ObjectSchema[] | undefined;
5
+ error: Error | undefined;
6
+ };
@@ -0,0 +1,4 @@
1
+ export declare const useValidateAqlText: (workspaceId: string, hostname?: string) => {
2
+ validateAqlText: (aql: string) => Promise<boolean>;
3
+ isLoading: boolean;
4
+ };
@@ -0,0 +1,6 @@
1
+ import { AqlValidateResponse, FetchObjectSchemasResponse } from '../types/assets/types';
2
+ export declare const getWorkspaceId: (hostname?: string) => Promise<string>;
3
+ export declare const validateAql: (workspaceId: string, data: {
4
+ qlQuery: string;
5
+ }, hostname?: string) => Promise<AqlValidateResponse>;
6
+ export declare const fetchObjectSchemas: (workspaceId: string, hostname?: string) => Promise<FetchObjectSchemasResponse>;
@@ -0,0 +1,23 @@
1
+ export interface GetWorkspaceDetailsResponse {
2
+ results: [
3
+ {
4
+ id: string;
5
+ }
6
+ ];
7
+ }
8
+ export interface ObjectSchema {
9
+ id?: string;
10
+ name?: string;
11
+ }
12
+ export interface FetchObjectSchemasResponse {
13
+ startAt: number;
14
+ maxResults: number;
15
+ total: number;
16
+ values: ObjectSchema[];
17
+ isLast: boolean;
18
+ }
19
+ export interface AqlValidateResponse {
20
+ isValid: boolean;
21
+ errorMessages: string[];
22
+ errors: {};
23
+ }
@@ -0,0 +1,6 @@
1
+ import { ObjectSchema } from '../types/assets/types';
2
+ export declare const useAssetsClient: (hostname?: string) => {
3
+ workspaceId: string | undefined;
4
+ objectSchemas: ObjectSchema[] | undefined;
5
+ error: Error | undefined;
6
+ };
@@ -0,0 +1,4 @@
1
+ export declare const useValidateAqlText: (workspaceId: string, hostname?: string) => {
2
+ validateAqlText: (aql: string) => Promise<boolean>;
3
+ isLoading: boolean;
4
+ };
@@ -0,0 +1,6 @@
1
+ import { AqlValidateResponse, FetchObjectSchemasResponse } from '../types/assets/types';
2
+ export declare const getWorkspaceId: (hostname?: string) => Promise<string>;
3
+ export declare const validateAql: (workspaceId: string, data: {
4
+ qlQuery: string;
5
+ }, hostname?: string) => Promise<AqlValidateResponse>;
6
+ export declare const fetchObjectSchemas: (workspaceId: string, hostname?: string) => Promise<FetchObjectSchemasResponse>;
@@ -0,0 +1,23 @@
1
+ export interface GetWorkspaceDetailsResponse {
2
+ results: [
3
+ {
4
+ id: string;
5
+ }
6
+ ];
7
+ }
8
+ export interface ObjectSchema {
9
+ id?: string;
10
+ name?: string;
11
+ }
12
+ export interface FetchObjectSchemasResponse {
13
+ startAt: number;
14
+ maxResults: number;
15
+ total: number;
16
+ values: ObjectSchema[];
17
+ isLast: boolean;
18
+ }
19
+ export interface AqlValidateResponse {
20
+ isValid: boolean;
21
+ errorMessages: string[];
22
+ errors: {};
23
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/link-datasource",
3
- "version": "0.27.3",
3
+ "version": "0.27.4",
4
4
  "description": "UI Components to support linking platform dataset feature",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -1,100 +0,0 @@
1
- ## API Report File for "@atlaskit/link-datasource"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- /// <reference types="react" />
8
-
9
- import { DatasourceAdf } from '@atlaskit/linking-common/types';
10
- import { DatasourceAdfTableView } from '@atlaskit/linking-common/types';
11
- import { DatasourceAdfView } from '@atlaskit/linking-common/types';
12
- import { InlineCardAdf } from '@atlaskit/linking-common/types';
13
-
14
- export { DatasourceAdf }
15
-
16
- export { DatasourceAdfTableView }
17
-
18
- export { DatasourceAdfView }
19
-
20
- // @public (undocumented)
21
- export const DatasourceTableView: (props: DatasourceTableViewProps) => JSX.Element;
22
-
23
- // @public (undocumented)
24
- interface DatasourceTableViewProps {
25
- // (undocumented)
26
- datasourceId: string;
27
- // (undocumented)
28
- fields?: string[];
29
- // (undocumented)
30
- onVisibleColumnKeysChange?: (visibleColumnKeys: string[]) => void;
31
- // (undocumented)
32
- parameters: object;
33
- // (undocumented)
34
- visibleColumnKeys?: string[];
35
- }
36
-
37
- // @public (undocumented)
38
- export const JIRA_LIST_OF_LINKS_DATASOURCE_ID = "d8b75300-dfda-4519-b6cd-e49abbd50401";
39
-
40
- // @public (undocumented)
41
- export type JiraIssueDatasourceParameters = {
42
- cloudId: string;
43
- } & JiraIssueDatasourceParametersQuery;
44
-
45
- // @public (undocumented)
46
- type JiraIssueDatasourceParametersQuery = XOR<{
47
- jql: string;
48
- }, {
49
- filter: string;
50
- }>;
51
-
52
- // @public (undocumented)
53
- export const JiraIssuesConfigModal: (props: JiraIssuesConfigModalProps) => JSX.Element;
54
-
55
- // @public (undocumented)
56
- interface JiraIssuesConfigModalProps {
57
- // (undocumented)
58
- datasourceId: string;
59
- // (undocumented)
60
- onCancel: () => void;
61
- // (undocumented)
62
- onInsert: (adf: InlineCardAdf | JiraIssuesDatasourceAdf) => void;
63
- // (undocumented)
64
- parameters?: JiraIssueDatasourceParameters;
65
- // (undocumented)
66
- visibleColumnKeys?: string[];
67
- }
68
-
69
- // @public (undocumented)
70
- export interface JiraIssuesDatasourceAdf extends DatasourceAdf {
71
- // (undocumented)
72
- attrs: {
73
- url?: string;
74
- datasource: {
75
- id: string;
76
- parameters: JiraIssueDatasourceParameters;
77
- views: [
78
- {
79
- type: 'table';
80
- properties?: {
81
- columns: {
82
- key: string;
83
- }[];
84
- };
85
- }
86
- ];
87
- };
88
- };
89
- }
90
-
91
- // @public (undocumented)
92
- type XOR<T1, T2> = (T1 & {
93
- [k in Exclude<keyof T2, keyof T1>]?: never;
94
- }) | (T2 & {
95
- [k in Exclude<keyof T1, keyof T2>]?: never;
96
- });
97
-
98
- // (No @packageDocumentation comment for this package)
99
-
100
- ```