@atlaskit/link-client-extension 6.1.0 → 7.0.0

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 (62) hide show
  1. package/CHANGELOG.md +35 -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/link-client-extension.docs.tsx +49 -47
  48. package/package.json +8 -15
  49. package/use-data-source-client-extension/mocks/package.json +1 -8
  50. package/use-data-source-client-extension/package.json +1 -8
  51. package/use-data-source-client-extension/types/package.json +1 -8
  52. package/use-smart-link-client-extension/package.json +1 -8
  53. package/dist/types-ts4.5/entry-points/data-source-client-extension-mocks.d.ts +0 -1
  54. package/dist/types-ts4.5/entry-points/data-source-response-types.d.ts +0 -1
  55. package/dist/types-ts4.5/entry-points/use-data-source-client-extension.d.ts +0 -1
  56. package/dist/types-ts4.5/entry-points/use-smart-link-client-extension.d.ts +0 -1
  57. package/dist/types-ts4.5/index.d.ts +0 -8
  58. package/dist/types-ts4.5/services/use-data-source-client-extension/index.d.ts +0 -13
  59. package/dist/types-ts4.5/services/use-data-source-client-extension/mocks.d.ts +0 -9
  60. package/dist/types-ts4.5/services/use-data-source-client-extension/types.d.ts +0 -13
  61. package/dist/types-ts4.5/services/use-resolver-url/index.d.ts +0 -2
  62. package/dist/types-ts4.5/services/use-smart-link-client-extension/index.d.ts +0 -13
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/link-client-extension",
3
- "version": "6.1.0",
3
+ "version": "7.0.0",
4
4
  "description": "Extension methods for linking platform client",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -25,34 +25,27 @@
25
25
  "module": "dist/esm/index.js",
26
26
  "module:es2019": "dist/es2019/index.js",
27
27
  "types": "dist/types/index.d.ts",
28
- "typesVersions": {
29
- ">=4.5 <4.9": {
30
- "*": [
31
- "dist/types-ts4.5/*",
32
- "dist/types-ts4.5/index.d.ts"
33
- ]
34
- }
35
- },
36
28
  "sideEffects": false,
37
29
  "atlaskit:src": "src/index.ts",
38
30
  "dependencies": {
39
- "@atlaskit/json-ld-types": "^1.5.0",
40
- "@atlaskit/linking-common": "^9.11.0",
41
- "@atlaskit/linking-types": "^14.3.0",
42
- "@atlaskit/platform-feature-flags": "^1.1.0",
31
+ "@atlaskit/json-ld-types": "^2.0.0",
32
+ "@atlaskit/linking-common": "^10.0.0",
33
+ "@atlaskit/linking-types": "^15.0.0",
34
+ "@atlaskit/platform-feature-flags": "^2.0.0",
43
35
  "@babel/runtime": "^7.0.0",
44
36
  "lru_map": "^0.4.1"
45
37
  },
46
38
  "peerDependencies": {
47
- "@atlaskit/link-provider": "^4.4.0",
39
+ "@atlaskit/link-provider": "^5.0.0",
48
40
  "react": "^18.2.0"
49
41
  },
50
42
  "devDependencies": {
51
- "@atlaskit/link-test-helpers": "^10.2.0",
43
+ "@atlaskit/link-test-helpers": "^11.0.0",
52
44
  "@atlassian/feature-flags-test-utils": "^1.1.0",
53
45
  "@atlassian/react-compiler-gating": "workspace:^",
54
46
  "@atlassian/structured-docs-types": "workspace:^",
55
47
  "@testing-library/react": "^16.3.0",
48
+ "react": "^18.2.0",
56
49
  "react-dom": "^18.2.0",
57
50
  "wait-for-expect": "^1.2.0"
58
51
  },
@@ -4,12 +4,5 @@
4
4
  "module": "../../dist/esm/entry-points/data-source-client-extension-mocks.js",
5
5
  "module:es2019": "../../dist/es2019/entry-points/data-source-client-extension-mocks.js",
6
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
- }
7
+ "types": "../../dist/types/entry-points/data-source-client-extension-mocks.d.ts"
15
8
  }
@@ -4,12 +4,5 @@
4
4
  "module": "../dist/esm/entry-points/use-data-source-client-extension.js",
5
5
  "module:es2019": "../dist/es2019/entry-points/use-data-source-client-extension.js",
6
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
- }
7
+ "types": "../dist/types/entry-points/use-data-source-client-extension.d.ts"
15
8
  }
@@ -4,12 +4,5 @@
4
4
  "module": "../../dist/esm/entry-points/data-source-response-types.js",
5
5
  "module:es2019": "../../dist/es2019/entry-points/data-source-response-types.js",
6
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
- }
7
+ "types": "../../dist/types/entry-points/data-source-response-types.d.ts"
15
8
  }
@@ -4,12 +4,5 @@
4
4
  "module": "../dist/esm/entry-points/use-smart-link-client-extension.js",
5
5
  "module:es2019": "../dist/es2019/entry-points/use-smart-link-client-extension.js",
6
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
- }
7
+ "types": "../dist/types/entry-points/use-smart-link-client-extension.d.ts"
15
8
  }
@@ -1 +0,0 @@
1
- export { mockDatasourceDetailsResponse as mockDatasourceResponse, mockDatasourceDetailsResponse, mockDatasourceDataResponse, mockDatasourceDataNoActionsResponse, mockDatasourceDataResponseWithSchema, mockActionsDiscoveryResponse, mockActionsDiscoveryEmptyResponse, } from '../services/use-data-source-client-extension/mocks';
@@ -1 +0,0 @@
1
- export type { JsonLdDatasourceResponse, DatasourceResolveResponse } from '../services/use-data-source-client-extension/types';
@@ -1 +0,0 @@
1
- export { DEFAULT_GET_DATASOURCE_DATA_PAGE_SIZE, useDatasourceClientExtension, } from '../services/use-data-source-client-extension';
@@ -1 +0,0 @@
1
- export { useSmartLinkClientExtension } from '../services/use-smart-link-client-extension';
@@ -1,8 +0,0 @@
1
- /** @deprecated use @atlaskit/link-client-extension/use-smart-link-client-extension */
2
- export { useSmartLinkClientExtension } from './services/use-smart-link-client-extension';
3
- /** @deprecated use @atlaskit/link-client-extension/use-data-source-client-extension */
4
- export { DEFAULT_GET_DATASOURCE_DATA_PAGE_SIZE, useDatasourceClientExtension, } from './services/use-data-source-client-extension';
5
- /** @deprecated use @atlaskit/link-client-extension/data-source-client-extension/mocks */
6
- export { mockDatasourceDetailsResponse as mockDatasourceResponse, mockDatasourceDetailsResponse, mockDatasourceDataResponse, mockDatasourceDataNoActionsResponse, mockDatasourceDataResponseWithSchema, mockActionsDiscoveryResponse, mockActionsDiscoveryEmptyResponse, } from './services/use-data-source-client-extension/mocks';
7
- /** @deprecated use @atlaskit/link-client-extension/use-data-source-client-extension/types */
8
- export type { JsonLdDatasourceResponse, DatasourceResolveResponse } from './services/use-data-source-client-extension/types';
@@ -1,13 +0,0 @@
1
- import { LRUMap } from 'lru_map';
2
- import type { ActionsDiscoveryRequest, ActionsDiscoveryResponse, ActionsServiceDiscoveryResponse, AtomicActionExecuteRequest, AtomicActionExecuteResponse, DatasourceDataRequest, DatasourceDataResponse, DatasourceDetailsRequest, DatasourceDetailsResponse } from '@atlaskit/linking-types';
3
- export declare const datasourceDetailsResponsePromiseCache: LRUMap<string, Promise<DatasourceDetailsResponse>>;
4
- export declare const datasourceDataResponsePromiseCache: LRUMap<string, Promise<DatasourceDataResponse>>;
5
- export declare const datasourceActionsPermissionsPromiseCache: LRUMap<string, Promise<ActionsServiceDiscoveryResponse>>;
6
- export declare const DEFAULT_GET_DATASOURCE_DATA_PAGE_SIZE = 20;
7
- export declare const useDatasourceClientExtension: () => {
8
- executeAtomicAction: (data: AtomicActionExecuteRequest) => Promise<AtomicActionExecuteResponse<unknown>>;
9
- getDatasourceActionsAndPermissions: (data: ActionsDiscoveryRequest, force?: boolean) => Promise<ActionsDiscoveryResponse>;
10
- getDatasourceData: (datasourceId: string, data: DatasourceDataRequest, force?: boolean) => Promise<DatasourceDataResponse>;
11
- getDatasourceDetails: (datasourceId: string, data: DatasourceDetailsRequest, force?: boolean) => Promise<DatasourceDetailsResponse>;
12
- invalidateDatasourceDataCacheByAri: (ari: string) => void;
13
- };
@@ -1,9 +0,0 @@
1
- import { type ActionsDiscoveryResponse, type ActionsServiceDiscoveryResponse, type AtomicActionExecuteResponse, type DatasourceDataResponse, type DatasourceDetailsResponse } from '@atlaskit/linking-types';
2
- export declare const mockDatasourceDataResponse: DatasourceDataResponse;
3
- export declare const mockDatasourceDataNoActionsResponse: DatasourceDataResponse;
4
- export declare const mockDatasourceDetailsResponse: DatasourceDetailsResponse;
5
- export declare const mockDatasourceDataResponseWithSchema: DatasourceDataResponse;
6
- export declare const mockActionsDiscoveryResponse: ActionsDiscoveryResponse;
7
- export declare const mockActionsDiscoveryEmptyResponse: ActionsServiceDiscoveryResponse;
8
- export declare const mockExecuteActionResponse: AtomicActionExecuteResponse;
9
- export declare const mockExecuteActionResponseFailure: AtomicActionExecuteResponse;
@@ -1,13 +0,0 @@
1
- import { type JsonLd } from '@atlaskit/json-ld-types';
2
- import type { DatasourceParameters } from '@atlaskit/linking-types';
3
- export interface JsonLdDatasourceResponse extends JsonLd.Response {
4
- datasources?: DatasourceResolveResponse[];
5
- }
6
- export type DatasourceResolveResponse = {
7
- ari?: string;
8
- description?: string;
9
- id: string;
10
- key?: string;
11
- name?: string;
12
- parameters: DatasourceParameters;
13
- };
@@ -1,2 +0,0 @@
1
- import type { CardClient } from '@atlaskit/link-provider';
2
- export declare const useResolverUrl: (cardClient: CardClient) => string;
@@ -1,13 +0,0 @@
1
- import type { CardClient } from '@atlaskit/link-provider';
2
- import { type InvokeRequest, type InvokeResponse } from '@atlaskit/linking-types/smart-link-actions';
3
- /**
4
- * useSmartLinkClientExtension
5
- *
6
- * This hook extends the usage of @atlaskit/link-provider CardClient
7
- * for smart links.
8
- *
9
- * @param cardClient
10
- */
11
- export declare const useSmartLinkClientExtension: (cardClient: CardClient) => {
12
- invoke: (data: InvokeRequest) => Promise<InvokeResponse>;
13
- };