@atlaskit/link-client-extension 6.0.1 → 6.1.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/link-client-extension
 
+## 6.1.0
+
+### Minor Changes
+
+- [`ac7122966de24`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/ac7122966de24) -
+  Mark barrel exports as deprecated, update paths and add new entry points
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 6.0.1
 
 ### Patch Changes

package/dist/cjs/entry-points/data-source-client-extension-mocks.js

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "mockActionsDiscoveryEmptyResponse", {
+  enumerable: true,
+  get: function get() {
+    return _mocks.mockActionsDiscoveryEmptyResponse;
+  }
+});
+Object.defineProperty(exports, "mockActionsDiscoveryResponse", {
+  enumerable: true,
+  get: function get() {
+    return _mocks.mockActionsDiscoveryResponse;
+  }
+});
+Object.defineProperty(exports, "mockDatasourceDataNoActionsResponse", {
+  enumerable: true,
+  get: function get() {
+    return _mocks.mockDatasourceDataNoActionsResponse;
+  }
+});
+Object.defineProperty(exports, "mockDatasourceDataResponse", {
+  enumerable: true,
+  get: function get() {
+    return _mocks.mockDatasourceDataResponse;
+  }
+});
+Object.defineProperty(exports, "mockDatasourceDataResponseWithSchema", {
+  enumerable: true,
+  get: function get() {
+    return _mocks.mockDatasourceDataResponseWithSchema;
+  }
+});
+Object.defineProperty(exports, "mockDatasourceDetailsResponse", {
+  enumerable: true,
+  get: function get() {
+    return _mocks.mockDatasourceDetailsResponse;
+  }
+});
+Object.defineProperty(exports, "mockDatasourceResponse", {
+  enumerable: true,
+  get: function get() {
+    return _mocks.mockDatasourceDetailsResponse;
+  }
+});
+var _mocks = require("../services/use-data-source-client-extension/mocks");

package/dist/cjs/entry-points/data-source-response-types.js

@@ -0,0 +1 @@
+"use strict";

package/dist/cjs/entry-points/use-data-source-client-extension.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "DEFAULT_GET_DATASOURCE_DATA_PAGE_SIZE", {
+  enumerable: true,
+  get: function get() {
+    return _useDataSourceClientExtension.DEFAULT_GET_DATASOURCE_DATA_PAGE_SIZE;
+  }
+});
+Object.defineProperty(exports, "useDatasourceClientExtension", {
+  enumerable: true,
+  get: function get() {
+    return _useDataSourceClientExtension.useDatasourceClientExtension;
+  }
+});
+var _useDataSourceClientExtension = require("../services/use-data-source-client-extension");

package/dist/cjs/entry-points/use-smart-link-client-extension.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "useSmartLinkClientExtension", {
+  enumerable: true,
+  get: function get() {
+    return _useSmartLinkClientExtension.useSmartLinkClientExtension;
+  }
+});
+var _useSmartLinkClientExtension = require("../services/use-smart-link-client-extension");

package/dist/es2019/entry-points/data-source-client-extension-mocks.js

@@ -0,0 +1 @@
+export { mockDatasourceDetailsResponse as mockDatasourceResponse, mockDatasourceDetailsResponse, mockDatasourceDataResponse, mockDatasourceDataNoActionsResponse, mockDatasourceDataResponseWithSchema, mockActionsDiscoveryResponse, mockActionsDiscoveryEmptyResponse } from '../services/use-data-source-client-extension/mocks';

package/dist/es2019/entry-points/use-data-source-client-extension.js

@@ -0,0 +1 @@
+export { DEFAULT_GET_DATASOURCE_DATA_PAGE_SIZE, useDatasourceClientExtension } from '../services/use-data-source-client-extension';

package/dist/es2019/entry-points/use-smart-link-client-extension.js

@@ -0,0 +1 @@
+export { useSmartLinkClientExtension } from '../services/use-smart-link-client-extension';

package/dist/es2019/index.js

@@ -1,3 +1,7 @@
+/** @deprecated use @atlaskit/link-client-extension/use-smart-link-client-extension */
 export { useSmartLinkClientExtension } from './services/use-smart-link-client-extension';
+/** @deprecated use @atlaskit/link-client-extension/use-data-source-client-extension */
 export { DEFAULT_GET_DATASOURCE_DATA_PAGE_SIZE, useDatasourceClientExtension } from './services/use-data-source-client-extension';
-export { mockDatasourceDetailsResponse as mockDatasourceResponse, mockDatasourceDetailsResponse, mockDatasourceDataResponse, mockDatasourceDataNoActionsResponse, mockDatasourceDataResponseWithSchema, mockActionsDiscoveryResponse, mockActionsDiscoveryEmptyResponse } from './services/use-data-source-client-extension/mocks';
+/** @deprecated use @atlaskit/link-client-extension/data-source-client-extension/mocks */
+export { mockDatasourceDetailsResponse as mockDatasourceResponse, mockDatasourceDetailsResponse, mockDatasourceDataResponse, mockDatasourceDataNoActionsResponse, mockDatasourceDataResponseWithSchema, mockActionsDiscoveryResponse, mockActionsDiscoveryEmptyResponse } from './services/use-data-source-client-extension/mocks';
+/** @deprecated use @atlaskit/link-client-extension/use-data-source-client-extension/types */

package/dist/esm/entry-points/data-source-client-extension-mocks.js

@@ -0,0 +1 @@
+export { mockDatasourceDetailsResponse as mockDatasourceResponse, mockDatasourceDetailsResponse, mockDatasourceDataResponse, mockDatasourceDataNoActionsResponse, mockDatasourceDataResponseWithSchema, mockActionsDiscoveryResponse, mockActionsDiscoveryEmptyResponse } from '../services/use-data-source-client-extension/mocks';

package/dist/esm/entry-points/use-data-source-client-extension.js

@@ -0,0 +1 @@
+export { DEFAULT_GET_DATASOURCE_DATA_PAGE_SIZE, useDatasourceClientExtension } from '../services/use-data-source-client-extension';

package/dist/esm/entry-points/use-smart-link-client-extension.js

@@ -0,0 +1 @@
+export { useSmartLinkClientExtension } from '../services/use-smart-link-client-extension';

package/dist/esm/index.js

@@ -1,3 +1,7 @@
+/** @deprecated use @atlaskit/link-client-extension/use-smart-link-client-extension */
 export { useSmartLinkClientExtension } from './services/use-smart-link-client-extension';
+/** @deprecated use @atlaskit/link-client-extension/use-data-source-client-extension */
 export { DEFAULT_GET_DATASOURCE_DATA_PAGE_SIZE, useDatasourceClientExtension } from './services/use-data-source-client-extension';
-export { mockDatasourceDetailsResponse as mockDatasourceResponse, mockDatasourceDetailsResponse, mockDatasourceDataResponse, mockDatasourceDataNoActionsResponse, mockDatasourceDataResponseWithSchema, mockActionsDiscoveryResponse, mockActionsDiscoveryEmptyResponse } from './services/use-data-source-client-extension/mocks';
+/** @deprecated use @atlaskit/link-client-extension/data-source-client-extension/mocks */
+export { mockDatasourceDetailsResponse as mockDatasourceResponse, mockDatasourceDetailsResponse, mockDatasourceDataResponse, mockDatasourceDataNoActionsResponse, mockDatasourceDataResponseWithSchema, mockActionsDiscoveryResponse, mockActionsDiscoveryEmptyResponse } from './services/use-data-source-client-extension/mocks';
+/** @deprecated use @atlaskit/link-client-extension/use-data-source-client-extension/types */

package/dist/types/entry-points/data-source-client-extension-mocks.d.ts

@@ -0,0 +1 @@
+export { mockDatasourceDetailsResponse as mockDatasourceResponse, mockDatasourceDetailsResponse, mockDatasourceDataResponse, mockDatasourceDataNoActionsResponse, mockDatasourceDataResponseWithSchema, mockActionsDiscoveryResponse, mockActionsDiscoveryEmptyResponse, } from '../services/use-data-source-client-extension/mocks';

package/dist/types/entry-points/data-source-response-types.d.ts

@@ -0,0 +1 @@
+export type { JsonLdDatasourceResponse, DatasourceResolveResponse } from '../services/use-data-source-client-extension/types';

package/dist/types/entry-points/use-data-source-client-extension.d.ts

@@ -0,0 +1 @@
+export { DEFAULT_GET_DATASOURCE_DATA_PAGE_SIZE, useDatasourceClientExtension, } from '../services/use-data-source-client-extension';

package/dist/types/entry-points/use-smart-link-client-extension.d.ts

@@ -0,0 +1 @@
+export { useSmartLinkClientExtension } from '../services/use-smart-link-client-extension';

package/dist/types/index.d.ts

@@ -1,4 +1,8 @@
+/** @deprecated use @atlaskit/link-client-extension/use-smart-link-client-extension */
 export { useSmartLinkClientExtension } from './services/use-smart-link-client-extension';
+/** @deprecated use @atlaskit/link-client-extension/use-data-source-client-extension */
 export { DEFAULT_GET_DATASOURCE_DATA_PAGE_SIZE, useDatasourceClientExtension, } from './services/use-data-source-client-extension';
+/** @deprecated use @atlaskit/link-client-extension/data-source-client-extension/mocks */
 export { mockDatasourceDetailsResponse as mockDatasourceResponse, mockDatasourceDetailsResponse, mockDatasourceDataResponse, mockDatasourceDataNoActionsResponse, mockDatasourceDataResponseWithSchema, mockActionsDiscoveryResponse, mockActionsDiscoveryEmptyResponse, } from './services/use-data-source-client-extension/mocks';
-export type { JsonLdDatasourceResponse, DatasourceResolveResponse } from './types';
+/** @deprecated use @atlaskit/link-client-extension/use-data-source-client-extension/types */
+export type { JsonLdDatasourceResponse, DatasourceResolveResponse } from './services/use-data-source-client-extension/types';

package/dist/types/services/use-data-source-client-extension/index.d.ts

@@ -5,9 +5,9 @@ export declare const datasourceDataResponsePromiseCache: LRUMap<string, Promise<
 export declare const datasourceActionsPermissionsPromiseCache: LRUMap<string, Promise<ActionsServiceDiscoveryResponse>>;
 export declare const DEFAULT_GET_DATASOURCE_DATA_PAGE_SIZE = 20;
 export declare const useDatasourceClientExtension: () => {
-    getDatasourceDetails: (datasourceId: string, data: DatasourceDetailsRequest, force?: boolean) => Promise<DatasourceDetailsResponse>;
-    getDatasourceData: (datasourceId: string, data: DatasourceDataRequest, force?: boolean) => Promise<DatasourceDataResponse>;
-    getDatasourceActionsAndPermissions: (data: ActionsDiscoveryRequest, force?: boolean) => Promise<ActionsDiscoveryResponse>;
     executeAtomicAction: (data: AtomicActionExecuteRequest) => Promise<AtomicActionExecuteResponse<unknown>>;
+    getDatasourceActionsAndPermissions: (data: ActionsDiscoveryRequest, force?: boolean) => Promise<ActionsDiscoveryResponse>;
+    getDatasourceData: (datasourceId: string, data: DatasourceDataRequest, force?: boolean) => Promise<DatasourceDataResponse>;
+    getDatasourceDetails: (datasourceId: string, data: DatasourceDetailsRequest, force?: boolean) => Promise<DatasourceDetailsResponse>;
     invalidateDatasourceDataCacheByAri: (ari: string) => void;
 };

package/dist/types-ts4.5/entry-points/data-source-client-extension-mocks.d.ts

@@ -0,0 +1 @@
+export { mockDatasourceDetailsResponse as mockDatasourceResponse, mockDatasourceDetailsResponse, mockDatasourceDataResponse, mockDatasourceDataNoActionsResponse, mockDatasourceDataResponseWithSchema, mockActionsDiscoveryResponse, mockActionsDiscoveryEmptyResponse, } from '../services/use-data-source-client-extension/mocks';

package/dist/types-ts4.5/entry-points/data-source-response-types.d.ts

@@ -0,0 +1 @@
+export type { JsonLdDatasourceResponse, DatasourceResolveResponse } from '../services/use-data-source-client-extension/types';

package/dist/types-ts4.5/entry-points/use-data-source-client-extension.d.ts

@@ -0,0 +1 @@
+export { DEFAULT_GET_DATASOURCE_DATA_PAGE_SIZE, useDatasourceClientExtension, } from '../services/use-data-source-client-extension';

package/dist/types-ts4.5/entry-points/use-smart-link-client-extension.d.ts

@@ -0,0 +1 @@
+export { useSmartLinkClientExtension } from '../services/use-smart-link-client-extension';

package/dist/types-ts4.5/index.d.ts

@@ -1,4 +1,8 @@
+/** @deprecated use @atlaskit/link-client-extension/use-smart-link-client-extension */
 export { useSmartLinkClientExtension } from './services/use-smart-link-client-extension';
+/** @deprecated use @atlaskit/link-client-extension/use-data-source-client-extension */
 export { DEFAULT_GET_DATASOURCE_DATA_PAGE_SIZE, useDatasourceClientExtension, } from './services/use-data-source-client-extension';
+/** @deprecated use @atlaskit/link-client-extension/data-source-client-extension/mocks */
 export { mockDatasourceDetailsResponse as mockDatasourceResponse, mockDatasourceDetailsResponse, mockDatasourceDataResponse, mockDatasourceDataNoActionsResponse, mockDatasourceDataResponseWithSchema, mockActionsDiscoveryResponse, mockActionsDiscoveryEmptyResponse, } from './services/use-data-source-client-extension/mocks';
-export type { JsonLdDatasourceResponse, DatasourceResolveResponse } from './types';
+/** @deprecated use @atlaskit/link-client-extension/use-data-source-client-extension/types */
+export type { JsonLdDatasourceResponse, DatasourceResolveResponse } from './services/use-data-source-client-extension/types';

package/dist/types-ts4.5/services/use-data-source-client-extension/index.d.ts

@@ -5,9 +5,9 @@ export declare const datasourceDataResponsePromiseCache: LRUMap<string, Promise<
 export declare const datasourceActionsPermissionsPromiseCache: LRUMap<string, Promise<ActionsServiceDiscoveryResponse>>;
 export declare const DEFAULT_GET_DATASOURCE_DATA_PAGE_SIZE = 20;
 export declare const useDatasourceClientExtension: () => {
-    getDatasourceDetails: (datasourceId: string, data: DatasourceDetailsRequest, force?: boolean) => Promise<DatasourceDetailsResponse>;
-    getDatasourceData: (datasourceId: string, data: DatasourceDataRequest, force?: boolean) => Promise<DatasourceDataResponse>;
-    getDatasourceActionsAndPermissions: (data: ActionsDiscoveryRequest, force?: boolean) => Promise<ActionsDiscoveryResponse>;
     executeAtomicAction: (data: AtomicActionExecuteRequest) => Promise<AtomicActionExecuteResponse<unknown>>;
+    getDatasourceActionsAndPermissions: (data: ActionsDiscoveryRequest, force?: boolean) => Promise<ActionsDiscoveryResponse>;
+    getDatasourceData: (datasourceId: string, data: DatasourceDataRequest, force?: boolean) => Promise<DatasourceDataResponse>;
+    getDatasourceDetails: (datasourceId: string, data: DatasourceDetailsRequest, force?: boolean) => Promise<DatasourceDetailsResponse>;
     invalidateDatasourceDataCacheByAri: (ari: string) => void;
 };

package/link-client-extension.docs.tsx

@@ -0,0 +1,65 @@
+/**
+ * Testing structured MCP docs for review — ignore this file.
+ * Contact #dst-structured-content in Slack with questions.
+ */
+
+import path from 'path';
+
+import type { ComponentStructuredContentSource } from '@atlassian/structured-docs-types';
+
+import packageJson from './package.json';
+
+const packagePath = path.resolve(__dirname);
+
+const documentation: ComponentStructuredContentSource[] = [
+	{
+		name: 'useSmartLinkClientExtension',
+		description:
+			'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.',
+		status: 'general-availability',
+		import: {
+			name: 'useSmartLinkClientExtension',
+			package: '@atlaskit/link-client-extension',
+			type: 'named',
+			packagePath,
+			packageJson,
+		},
+		usageGuidelines: [
+			'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.',
+		],
+		contentGuidelines: [],
+		accessibilityGuidelines: [],
+		keywords: [
+			'link-client-extension',
+			'hooks',
+			'invoke',
+			'actions',
+			'useSmartLinkClientExtension',
+		],
+		categories: ['linking', 'interaction'],
+		examples: [],
+	},
+	{
+		name: 'useDatasourceClientExtension',
+		description:
+			'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.',
+		status: 'general-availability',
+		import: {
+			name: 'useDatasourceClientExtension',
+			package: '@atlaskit/link-client-extension',
+			type: 'named',
+			packagePath,
+			packageJson,
+		},
+		usageGuidelines: [
+			'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.',
+		],
+		contentGuidelines: [],
+		accessibilityGuidelines: [],
+		keywords: ['link-client-extension', 'hooks', 'datasource', 'useDatasourceClientExtension'],
+		categories: ['linking', 'data-display'],
+		examples: [],
+	},
+];
+
+export default documentation;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/link-client-extension",
-	"version": "6.0.1",
+	"version": "6.1.0",
 	"description": "Extension methods for linking platform client",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -36,21 +36,22 @@
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/json-ld-types": "^1.4.0",
+		"@atlaskit/json-ld-types": "^1.5.0",
 		"@atlaskit/linking-common": "^9.11.0",
-		"@atlaskit/linking-types": "^14.2.0",
+		"@atlaskit/linking-types": "^14.3.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@babel/runtime": "^7.0.0",
 		"lru_map": "^0.4.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/link-provider": "^4.3.0",
+		"@atlaskit/link-provider": "^4.4.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
-		"@atlaskit/link-test-helpers": "^9.1.0",
-		"@atlassian/feature-flags-test-utils": "^1.0.0",
+		"@atlaskit/link-test-helpers": "^10.2.0",
+		"@atlassian/feature-flags-test-utils": "^1.1.0",
 		"@atlassian/react-compiler-gating": "workspace:^",
+		"@atlassian/structured-docs-types": "workspace:^",
 		"@testing-library/react": "^16.3.0",
 		"react-dom": "^18.2.0",
 		"wait-for-expect": "^1.2.0"

package/use-data-source-client-extension/mocks/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/link-client-extension/use-data-source-client-extension/mocks",
+  "main": "../../dist/cjs/entry-points/data-source-client-extension-mocks.js",
+  "module": "../../dist/esm/entry-points/data-source-client-extension-mocks.js",
+  "module:es2019": "../../dist/es2019/entry-points/data-source-client-extension-mocks.js",
+  "sideEffects": false,
+  "types": "../../dist/types/entry-points/data-source-client-extension-mocks.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.9": {
+      "*": [
+        "../../dist/types-ts4.5/entry-points/data-source-client-extension-mocks.d.ts"
+      ]
+    }
+  }
+}

package/use-data-source-client-extension/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/link-client-extension/use-data-source-client-extension",
+  "main": "../dist/cjs/entry-points/use-data-source-client-extension.js",
+  "module": "../dist/esm/entry-points/use-data-source-client-extension.js",
+  "module:es2019": "../dist/es2019/entry-points/use-data-source-client-extension.js",
+  "sideEffects": false,
+  "types": "../dist/types/entry-points/use-data-source-client-extension.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.9": {
+      "*": [
+        "../dist/types-ts4.5/entry-points/use-data-source-client-extension.d.ts"
+      ]
+    }
+  }
+}

package/use-data-source-client-extension/types/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/link-client-extension/use-data-source-client-extension/types",
+  "main": "../../dist/cjs/entry-points/data-source-response-types.js",
+  "module": "../../dist/esm/entry-points/data-source-response-types.js",
+  "module:es2019": "../../dist/es2019/entry-points/data-source-response-types.js",
+  "sideEffects": false,
+  "types": "../../dist/types/entry-points/data-source-response-types.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.9": {
+      "*": [
+        "../../dist/types-ts4.5/entry-points/data-source-response-types.d.ts"
+      ]
+    }
+  }
+}

package/use-smart-link-client-extension/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/link-client-extension/use-smart-link-client-extension",
+  "main": "../dist/cjs/entry-points/use-smart-link-client-extension.js",
+  "module": "../dist/esm/entry-points/use-smart-link-client-extension.js",
+  "module:es2019": "../dist/es2019/entry-points/use-smart-link-client-extension.js",
+  "sideEffects": false,
+  "types": "../dist/types/entry-points/use-smart-link-client-extension.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.9": {
+      "*": [
+        "../dist/types-ts4.5/entry-points/use-smart-link-client-extension.d.ts"
+      ]
+    }
+  }
+}