@atlaskit/link-client-extension 6.1.0 → 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.
Files changed (59) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/dist/cjs/entry-points/data-source-client-extension-mocks.js +11 -6
  3. package/dist/cjs/index.js +11 -6
  4. package/dist/cjs/services/use-data-source-client-extension/index.js +28 -28
  5. package/dist/cjs/services/use-data-source-client-extension/mockActionsDiscoveryEmptyResponse.js +12 -0
  6. package/dist/cjs/services/use-data-source-client-extension/mockActionsDiscoveryResponse.js +76 -0
  7. package/dist/cjs/services/use-data-source-client-extension/mockDatasourceDataNoActionsResponse.js +125 -0
  8. package/dist/cjs/services/use-data-source-client-extension/mockDatasourceDataResponse.js +126 -0
  9. package/dist/cjs/services/use-data-source-client-extension/mockDatasourceDetailsResponse.js +79 -0
  10. package/dist/cjs/services/use-data-source-client-extension/mockExecuteActionResponse.js +11 -0
  11. package/dist/cjs/services/use-data-source-client-extension/mockExecuteActionResponseFailure.js +14 -0
  12. package/dist/cjs/services/use-data-source-client-extension/mocks.js +7 -405
  13. package/dist/cjs/services/use-smart-link-client-extension/index.js +17 -17
  14. package/dist/es2019/entry-points/data-source-client-extension-mocks.js +6 -1
  15. package/dist/es2019/index.js +6 -1
  16. package/dist/es2019/services/use-data-source-client-extension/mockActionsDiscoveryEmptyResponse.js +6 -0
  17. package/dist/es2019/services/use-data-source-client-extension/mockActionsDiscoveryResponse.js +70 -0
  18. package/dist/es2019/services/use-data-source-client-extension/mockDatasourceDataNoActionsResponse.js +119 -0
  19. package/dist/es2019/services/use-data-source-client-extension/mockDatasourceDataResponse.js +120 -0
  20. package/dist/es2019/services/use-data-source-client-extension/mockDatasourceDetailsResponse.js +73 -0
  21. package/dist/es2019/services/use-data-source-client-extension/mockExecuteActionResponse.js +5 -0
  22. package/dist/es2019/services/use-data-source-client-extension/mockExecuteActionResponseFailure.js +8 -0
  23. package/dist/es2019/services/use-data-source-client-extension/mocks.js +2 -400
  24. package/dist/esm/entry-points/data-source-client-extension-mocks.js +6 -1
  25. package/dist/esm/index.js +6 -1
  26. package/dist/esm/services/use-data-source-client-extension/index.js +28 -28
  27. package/dist/esm/services/use-data-source-client-extension/mockActionsDiscoveryEmptyResponse.js +6 -0
  28. package/dist/esm/services/use-data-source-client-extension/mockActionsDiscoveryResponse.js +70 -0
  29. package/dist/esm/services/use-data-source-client-extension/mockDatasourceDataNoActionsResponse.js +119 -0
  30. package/dist/esm/services/use-data-source-client-extension/mockDatasourceDataResponse.js +120 -0
  31. package/dist/esm/services/use-data-source-client-extension/mockDatasourceDetailsResponse.js +73 -0
  32. package/dist/esm/services/use-data-source-client-extension/mockExecuteActionResponse.js +5 -0
  33. package/dist/esm/services/use-data-source-client-extension/mockExecuteActionResponseFailure.js +8 -0
  34. package/dist/esm/services/use-data-source-client-extension/mocks.js +3 -401
  35. package/dist/esm/services/use-smart-link-client-extension/index.js +17 -17
  36. package/dist/types/entry-points/data-source-client-extension-mocks.d.ts +6 -1
  37. package/dist/types/entry-points/data-source-response-types.d.ts +1 -1
  38. package/dist/types/index.d.ts +7 -2
  39. package/dist/types/services/use-data-source-client-extension/mockActionsDiscoveryEmptyResponse.d.ts +2 -0
  40. package/dist/types/services/use-data-source-client-extension/mockActionsDiscoveryResponse.d.ts +2 -0
  41. package/dist/types/services/use-data-source-client-extension/mockDatasourceDataNoActionsResponse.d.ts +2 -0
  42. package/dist/types/services/use-data-source-client-extension/mockDatasourceDataResponse.d.ts +2 -0
  43. package/dist/types/services/use-data-source-client-extension/mockDatasourceDetailsResponse.d.ts +2 -0
  44. package/dist/types/services/use-data-source-client-extension/mockExecuteActionResponse.d.ts +2 -0
  45. package/dist/types/services/use-data-source-client-extension/mockExecuteActionResponseFailure.d.ts +2 -0
  46. package/dist/types/services/use-data-source-client-extension/mocks.d.ts +1 -8
  47. package/dist/types-ts4.5/entry-points/data-source-client-extension-mocks.d.ts +6 -1
  48. package/dist/types-ts4.5/entry-points/data-source-response-types.d.ts +1 -1
  49. package/dist/types-ts4.5/index.d.ts +7 -2
  50. package/dist/types-ts4.5/services/use-data-source-client-extension/mockActionsDiscoveryEmptyResponse.d.ts +2 -0
  51. package/dist/types-ts4.5/services/use-data-source-client-extension/mockActionsDiscoveryResponse.d.ts +2 -0
  52. package/dist/types-ts4.5/services/use-data-source-client-extension/mockDatasourceDataNoActionsResponse.d.ts +2 -0
  53. package/dist/types-ts4.5/services/use-data-source-client-extension/mockDatasourceDataResponse.d.ts +2 -0
  54. package/dist/types-ts4.5/services/use-data-source-client-extension/mockDatasourceDetailsResponse.d.ts +2 -0
  55. package/dist/types-ts4.5/services/use-data-source-client-extension/mockExecuteActionResponse.d.ts +2 -0
  56. package/dist/types-ts4.5/services/use-data-source-client-extension/mockExecuteActionResponseFailure.d.ts +2 -0
  57. package/dist/types-ts4.5/services/use-data-source-client-extension/mocks.d.ts +1 -8
  58. package/link-client-extension.docs.tsx +49 -47
  59. package/package.json +5 -4
@@ -5,61 +5,63 @@
5
5
 
6
6
  import path from 'path';
7
7
 
8
- import type { ComponentStructuredContentSource } from '@atlassian/structured-docs-types';
8
+ import type { StructuredContentSource } from '@atlassian/structured-docs-types/types';
9
9
 
10
10
  import packageJson from './package.json';
11
11
 
12
12
  const packagePath = path.resolve(__dirname);
13
13
 
14
- const documentation: ComponentStructuredContentSource[] = [
15
- {
16
- name: 'useSmartLinkClientExtension',
17
- description:
18
- '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.',
19
- status: 'general-availability',
20
- import: {
14
+ const documentation: StructuredContentSource = {
15
+ components: [
16
+ {
21
17
  name: 'useSmartLinkClientExtension',
22
- package: '@atlaskit/link-client-extension',
23
- type: 'named',
24
- packagePath,
25
- packageJson,
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: [],
26
42
  },
27
- usageGuidelines: [
28
- '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.',
29
- ],
30
- contentGuidelines: [],
31
- accessibilityGuidelines: [],
32
- keywords: [
33
- 'link-client-extension',
34
- 'hooks',
35
- 'invoke',
36
- 'actions',
37
- 'useSmartLinkClientExtension',
38
- ],
39
- categories: ['linking', 'interaction'],
40
- examples: [],
41
- },
42
- {
43
- name: 'useDatasourceClientExtension',
44
- description:
45
- '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.',
46
- status: 'general-availability',
47
- import: {
43
+ {
48
44
  name: 'useDatasourceClientExtension',
49
- package: '@atlaskit/link-client-extension',
50
- type: 'named',
51
- packagePath,
52
- packageJson,
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: [],
53
63
  },
54
- usageGuidelines: [
55
- '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.',
56
- ],
57
- contentGuidelines: [],
58
- accessibilityGuidelines: [],
59
- keywords: ['link-client-extension', 'hooks', 'datasource', 'useDatasourceClientExtension'],
60
- categories: ['linking', 'data-display'],
61
- examples: [],
62
- },
63
- ];
64
+ ],
65
+ };
64
66
 
65
67
  export default documentation;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/link-client-extension",
3
- "version": "6.1.0",
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",
@@ -37,8 +37,8 @@
37
37
  "atlaskit:src": "src/index.ts",
38
38
  "dependencies": {
39
39
  "@atlaskit/json-ld-types": "^1.5.0",
40
- "@atlaskit/linking-common": "^9.11.0",
41
- "@atlaskit/linking-types": "^14.3.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"
@@ -48,11 +48,12 @@
48
48
  "react": "^18.2.0"
49
49
  },
50
50
  "devDependencies": {
51
- "@atlaskit/link-test-helpers": "^10.2.0",
51
+ "@atlaskit/link-test-helpers": "^10.4.0",
52
52
  "@atlassian/feature-flags-test-utils": "^1.1.0",
53
53
  "@atlassian/react-compiler-gating": "workspace:^",
54
54
  "@atlassian/structured-docs-types": "workspace:^",
55
55
  "@testing-library/react": "^16.3.0",
56
+ "react": "^18.2.0",
56
57
  "react-dom": "^18.2.0",
57
58
  "wait-for-expect": "^1.2.0"
58
59
  },