@atlaskit/link-client-extension 6.0.1 → 6.1.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 +20 -0
- package/dist/cjs/entry-points/data-source-client-extension-mocks.js +53 -0
- package/dist/cjs/entry-points/data-source-response-types.js +1 -0
- package/dist/cjs/entry-points/use-data-source-client-extension.js +18 -0
- package/dist/cjs/entry-points/use-smart-link-client-extension.js +12 -0
- package/dist/cjs/index.js +11 -6
- package/dist/cjs/services/use-data-source-client-extension/index.js +28 -28
- package/dist/cjs/services/use-data-source-client-extension/mockActionsDiscoveryEmptyResponse.js +12 -0
- package/dist/cjs/services/use-data-source-client-extension/mockActionsDiscoveryResponse.js +76 -0
- package/dist/cjs/services/use-data-source-client-extension/mockDatasourceDataNoActionsResponse.js +125 -0
- package/dist/cjs/services/use-data-source-client-extension/mockDatasourceDataResponse.js +126 -0
- package/dist/cjs/services/use-data-source-client-extension/mockDatasourceDetailsResponse.js +79 -0
- package/dist/cjs/services/use-data-source-client-extension/mockExecuteActionResponse.js +11 -0
- package/dist/cjs/services/use-data-source-client-extension/mockExecuteActionResponseFailure.js +14 -0
- package/dist/cjs/services/use-data-source-client-extension/mocks.js +7 -405
- package/dist/cjs/services/use-smart-link-client-extension/index.js +17 -17
- package/dist/es2019/entry-points/data-source-client-extension-mocks.js +6 -0
- package/dist/es2019/entry-points/data-source-response-types.js +0 -0
- package/dist/es2019/entry-points/use-data-source-client-extension.js +1 -0
- package/dist/es2019/entry-points/use-smart-link-client-extension.js +1 -0
- package/dist/es2019/index.js +10 -1
- package/dist/es2019/services/use-data-source-client-extension/mockActionsDiscoveryEmptyResponse.js +6 -0
- package/dist/es2019/services/use-data-source-client-extension/mockActionsDiscoveryResponse.js +70 -0
- package/dist/es2019/services/use-data-source-client-extension/mockDatasourceDataNoActionsResponse.js +119 -0
- package/dist/es2019/services/use-data-source-client-extension/mockDatasourceDataResponse.js +120 -0
- package/dist/es2019/services/use-data-source-client-extension/mockDatasourceDetailsResponse.js +73 -0
- package/dist/es2019/services/use-data-source-client-extension/mockExecuteActionResponse.js +5 -0
- package/dist/es2019/services/use-data-source-client-extension/mockExecuteActionResponseFailure.js +8 -0
- package/dist/es2019/services/use-data-source-client-extension/mocks.js +2 -400
- package/dist/esm/entry-points/data-source-client-extension-mocks.js +6 -0
- package/dist/esm/entry-points/data-source-response-types.js +0 -0
- package/dist/esm/entry-points/use-data-source-client-extension.js +1 -0
- package/dist/esm/entry-points/use-smart-link-client-extension.js +1 -0
- package/dist/esm/index.js +10 -1
- package/dist/esm/services/use-data-source-client-extension/index.js +28 -28
- package/dist/esm/services/use-data-source-client-extension/mockActionsDiscoveryEmptyResponse.js +6 -0
- package/dist/esm/services/use-data-source-client-extension/mockActionsDiscoveryResponse.js +70 -0
- package/dist/esm/services/use-data-source-client-extension/mockDatasourceDataNoActionsResponse.js +119 -0
- package/dist/esm/services/use-data-source-client-extension/mockDatasourceDataResponse.js +120 -0
- package/dist/esm/services/use-data-source-client-extension/mockDatasourceDetailsResponse.js +73 -0
- package/dist/esm/services/use-data-source-client-extension/mockExecuteActionResponse.js +5 -0
- package/dist/esm/services/use-data-source-client-extension/mockExecuteActionResponseFailure.js +8 -0
- package/dist/esm/services/use-data-source-client-extension/mocks.js +3 -401
- package/dist/esm/services/use-smart-link-client-extension/index.js +17 -17
- package/dist/types/entry-points/data-source-client-extension-mocks.d.ts +6 -0
- package/dist/types/entry-points/data-source-response-types.d.ts +1 -0
- package/dist/types/entry-points/use-data-source-client-extension.d.ts +1 -0
- package/dist/types/entry-points/use-smart-link-client-extension.d.ts +1 -0
- package/dist/types/index.d.ts +11 -2
- package/dist/types/services/use-data-source-client-extension/index.d.ts +3 -3
- package/dist/types/services/use-data-source-client-extension/mockActionsDiscoveryEmptyResponse.d.ts +2 -0
- package/dist/types/services/use-data-source-client-extension/mockActionsDiscoveryResponse.d.ts +2 -0
- package/dist/types/services/use-data-source-client-extension/mockDatasourceDataNoActionsResponse.d.ts +2 -0
- package/dist/types/services/use-data-source-client-extension/mockDatasourceDataResponse.d.ts +2 -0
- package/dist/types/services/use-data-source-client-extension/mockDatasourceDetailsResponse.d.ts +2 -0
- package/dist/types/services/use-data-source-client-extension/mockExecuteActionResponse.d.ts +2 -0
- package/dist/types/services/use-data-source-client-extension/mockExecuteActionResponseFailure.d.ts +2 -0
- package/dist/types/services/use-data-source-client-extension/mocks.d.ts +1 -8
- package/dist/types-ts4.5/entry-points/data-source-client-extension-mocks.d.ts +6 -0
- package/dist/types-ts4.5/entry-points/data-source-response-types.d.ts +1 -0
- package/dist/types-ts4.5/entry-points/use-data-source-client-extension.d.ts +1 -0
- package/dist/types-ts4.5/entry-points/use-smart-link-client-extension.d.ts +1 -0
- package/dist/types-ts4.5/index.d.ts +11 -2
- package/dist/types-ts4.5/services/use-data-source-client-extension/index.d.ts +3 -3
- package/dist/types-ts4.5/services/use-data-source-client-extension/mockActionsDiscoveryEmptyResponse.d.ts +2 -0
- package/dist/types-ts4.5/services/use-data-source-client-extension/mockActionsDiscoveryResponse.d.ts +2 -0
- package/dist/types-ts4.5/services/use-data-source-client-extension/mockDatasourceDataNoActionsResponse.d.ts +2 -0
- package/dist/types-ts4.5/services/use-data-source-client-extension/mockDatasourceDataResponse.d.ts +2 -0
- package/dist/types-ts4.5/services/use-data-source-client-extension/mockDatasourceDetailsResponse.d.ts +2 -0
- package/dist/types-ts4.5/services/use-data-source-client-extension/mockExecuteActionResponse.d.ts +2 -0
- package/dist/types-ts4.5/services/use-data-source-client-extension/mockExecuteActionResponseFailure.d.ts +2 -0
- package/dist/types-ts4.5/services/use-data-source-client-extension/mocks.d.ts +1 -8
- package/link-client-extension.docs.tsx +67 -0
- package/package.json +9 -7
- package/use-data-source-client-extension/mocks/package.json +15 -0
- package/use-data-source-client-extension/package.json +15 -0
- package/use-data-source-client-extension/types/package.json +15 -0
- package/use-smart-link-client-extension/package.json +15 -0
- /package/dist/cjs/{types.js → services/use-data-source-client-extension/types.js} +0 -0
- /package/dist/es2019/{types.js → services/use-data-source-client-extension/types.js} +0 -0
- /package/dist/esm/{types.js → services/use-data-source-client-extension/types.js} +0 -0
- /package/dist/types/{types.d.ts → services/use-data-source-client-extension/types.d.ts} +0 -0
- /package/dist/types-ts4.5/{types.d.ts → services/use-data-source-client-extension/types.d.ts} +0 -0
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Testing structured MCP docs for review — ignore this file.
|
|
3
|
+
* Contact #dst-structured-content in Slack with questions.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
import path from 'path';
|
|
7
|
+
|
|
8
|
+
import type { StructuredContentSource } from '@atlassian/structured-docs-types/types';
|
|
9
|
+
|
|
10
|
+
import packageJson from './package.json';
|
|
11
|
+
|
|
12
|
+
const packagePath = path.resolve(__dirname);
|
|
13
|
+
|
|
14
|
+
const documentation: StructuredContentSource = {
|
|
15
|
+
components: [
|
|
16
|
+
{
|
|
17
|
+
name: 'useSmartLinkClientExtension',
|
|
18
|
+
description:
|
|
19
|
+
'Hook that extends the CardClient from link-provider with Smart Link action invocation. Accepts a CardClient and returns an invoke function to call Smart Link actions (e.g. custom actions) via the resolver.',
|
|
20
|
+
status: 'general-availability',
|
|
21
|
+
import: {
|
|
22
|
+
name: 'useSmartLinkClientExtension',
|
|
23
|
+
package: '@atlaskit/link-client-extension',
|
|
24
|
+
type: 'named',
|
|
25
|
+
packagePath,
|
|
26
|
+
packageJson,
|
|
27
|
+
},
|
|
28
|
+
usageGuidelines: [
|
|
29
|
+
'Use when you need to invoke Smart Link actions (POST to resolver /invoke) from custom UI. Pass the client from useSmartLinkContext; use the returned invoke for action execution.',
|
|
30
|
+
],
|
|
31
|
+
contentGuidelines: [],
|
|
32
|
+
accessibilityGuidelines: [],
|
|
33
|
+
keywords: [
|
|
34
|
+
'link-client-extension',
|
|
35
|
+
'hooks',
|
|
36
|
+
'invoke',
|
|
37
|
+
'actions',
|
|
38
|
+
'useSmartLinkClientExtension',
|
|
39
|
+
],
|
|
40
|
+
categories: ['linking', 'interaction'],
|
|
41
|
+
examples: [],
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
name: 'useDatasourceClientExtension',
|
|
45
|
+
description:
|
|
46
|
+
'Hook that provides methods to fetch datasource details, datasource data (paginated), and actions discovery. Uses the Smart Link context client and caches responses. Required for rendering datasource tables or custom datasource UI.',
|
|
47
|
+
status: 'general-availability',
|
|
48
|
+
import: {
|
|
49
|
+
name: 'useDatasourceClientExtension',
|
|
50
|
+
package: '@atlaskit/link-client-extension',
|
|
51
|
+
type: 'named',
|
|
52
|
+
packagePath,
|
|
53
|
+
packageJson,
|
|
54
|
+
},
|
|
55
|
+
usageGuidelines: [
|
|
56
|
+
'Use when building UI that loads or displays datasource data (e.g. list of links from Jira, Confluence, Assets). Must be used inside SmartCardProvider. Use getDatasourceDetails, getDatasourceData, and getActionsDiscovery as needed.',
|
|
57
|
+
],
|
|
58
|
+
contentGuidelines: [],
|
|
59
|
+
accessibilityGuidelines: [],
|
|
60
|
+
keywords: ['link-client-extension', 'hooks', 'datasource', 'useDatasourceClientExtension'],
|
|
61
|
+
categories: ['linking', 'data-display'],
|
|
62
|
+
examples: [],
|
|
63
|
+
},
|
|
64
|
+
],
|
|
65
|
+
};
|
|
66
|
+
|
|
67
|
+
export default documentation;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/link-client-extension",
|
|
3
|
-
"version": "6.
|
|
3
|
+
"version": "6.1.1",
|
|
4
4
|
"description": "Extension methods for linking platform client",
|
|
5
5
|
"author": "Atlassian Pty Ltd",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -36,22 +36,24 @@
|
|
|
36
36
|
"sideEffects": false,
|
|
37
37
|
"atlaskit:src": "src/index.ts",
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"@atlaskit/json-ld-types": "^1.
|
|
40
|
-
"@atlaskit/linking-common": "^9.
|
|
41
|
-
"@atlaskit/linking-types": "^14.
|
|
39
|
+
"@atlaskit/json-ld-types": "^1.5.0",
|
|
40
|
+
"@atlaskit/linking-common": "^9.12.0",
|
|
41
|
+
"@atlaskit/linking-types": "^14.4.0",
|
|
42
42
|
"@atlaskit/platform-feature-flags": "^1.1.0",
|
|
43
43
|
"@babel/runtime": "^7.0.0",
|
|
44
44
|
"lru_map": "^0.4.1"
|
|
45
45
|
},
|
|
46
46
|
"peerDependencies": {
|
|
47
|
-
"@atlaskit/link-provider": "^4.
|
|
47
|
+
"@atlaskit/link-provider": "^4.4.0",
|
|
48
48
|
"react": "^18.2.0"
|
|
49
49
|
},
|
|
50
50
|
"devDependencies": {
|
|
51
|
-
"@atlaskit/link-test-helpers": "^
|
|
52
|
-
"@atlassian/feature-flags-test-utils": "^1.
|
|
51
|
+
"@atlaskit/link-test-helpers": "^10.4.0",
|
|
52
|
+
"@atlassian/feature-flags-test-utils": "^1.1.0",
|
|
53
53
|
"@atlassian/react-compiler-gating": "workspace:^",
|
|
54
|
+
"@atlassian/structured-docs-types": "workspace:^",
|
|
54
55
|
"@testing-library/react": "^16.3.0",
|
|
56
|
+
"react": "^18.2.0",
|
|
55
57
|
"react-dom": "^18.2.0",
|
|
56
58
|
"wait-for-expect": "^1.2.0"
|
|
57
59
|
},
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@atlaskit/link-client-extension/use-data-source-client-extension/mocks",
|
|
3
|
+
"main": "../../dist/cjs/entry-points/data-source-client-extension-mocks.js",
|
|
4
|
+
"module": "../../dist/esm/entry-points/data-source-client-extension-mocks.js",
|
|
5
|
+
"module:es2019": "../../dist/es2019/entry-points/data-source-client-extension-mocks.js",
|
|
6
|
+
"sideEffects": false,
|
|
7
|
+
"types": "../../dist/types/entry-points/data-source-client-extension-mocks.d.ts",
|
|
8
|
+
"typesVersions": {
|
|
9
|
+
">=4.5 <5.9": {
|
|
10
|
+
"*": [
|
|
11
|
+
"../../dist/types-ts4.5/entry-points/data-source-client-extension-mocks.d.ts"
|
|
12
|
+
]
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@atlaskit/link-client-extension/use-data-source-client-extension",
|
|
3
|
+
"main": "../dist/cjs/entry-points/use-data-source-client-extension.js",
|
|
4
|
+
"module": "../dist/esm/entry-points/use-data-source-client-extension.js",
|
|
5
|
+
"module:es2019": "../dist/es2019/entry-points/use-data-source-client-extension.js",
|
|
6
|
+
"sideEffects": false,
|
|
7
|
+
"types": "../dist/types/entry-points/use-data-source-client-extension.d.ts",
|
|
8
|
+
"typesVersions": {
|
|
9
|
+
">=4.5 <5.9": {
|
|
10
|
+
"*": [
|
|
11
|
+
"../dist/types-ts4.5/entry-points/use-data-source-client-extension.d.ts"
|
|
12
|
+
]
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@atlaskit/link-client-extension/use-data-source-client-extension/types",
|
|
3
|
+
"main": "../../dist/cjs/entry-points/data-source-response-types.js",
|
|
4
|
+
"module": "../../dist/esm/entry-points/data-source-response-types.js",
|
|
5
|
+
"module:es2019": "../../dist/es2019/entry-points/data-source-response-types.js",
|
|
6
|
+
"sideEffects": false,
|
|
7
|
+
"types": "../../dist/types/entry-points/data-source-response-types.d.ts",
|
|
8
|
+
"typesVersions": {
|
|
9
|
+
">=4.5 <5.9": {
|
|
10
|
+
"*": [
|
|
11
|
+
"../../dist/types-ts4.5/entry-points/data-source-response-types.d.ts"
|
|
12
|
+
]
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@atlaskit/link-client-extension/use-smart-link-client-extension",
|
|
3
|
+
"main": "../dist/cjs/entry-points/use-smart-link-client-extension.js",
|
|
4
|
+
"module": "../dist/esm/entry-points/use-smart-link-client-extension.js",
|
|
5
|
+
"module:es2019": "../dist/es2019/entry-points/use-smart-link-client-extension.js",
|
|
6
|
+
"sideEffects": false,
|
|
7
|
+
"types": "../dist/types/entry-points/use-smart-link-client-extension.d.ts",
|
|
8
|
+
"typesVersions": {
|
|
9
|
+
">=4.5 <5.9": {
|
|
10
|
+
"*": [
|
|
11
|
+
"../dist/types-ts4.5/entry-points/use-smart-link-client-extension.d.ts"
|
|
12
|
+
]
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
}
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/dist/types-ts4.5/{types.d.ts → services/use-data-source-client-extension/types.d.ts}
RENAMED
|
File without changes
|