@atlaskit/editor-card-provider 5.3.1 → 5.4.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @atlaskit/editor-card-provider
 
+## 5.4.0
+
+### Minor Changes
+
+- [`19da7355cd815`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/19da7355cd815) - -
+  Added a new `custom` environment to `EnvironmentsKeys`. Now, you can pass the `baseUrlOverride`
+  parameter to both `EditorCardProvider` and `CardClient` to access a service directly.
+
+  - Introduced a new `setHeaders` method in CardClient, allowing you to specify custom HTTP headers
+    for requests to the object-resolver service.
+  - `EditorCardProvider` now supports passing a custom `CardClient` instance, so you can use your
+    own client instead of the built-in one.
+
+  These changes provide more flexibility for configuring access to the object-resolver service,
+  including support for SSR and integration with custom infrastructures.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 5.3.1
 
 ### Patch Changes

package/dist/cjs/provider.js

@@ -133,7 +133,7 @@ var isJiraWorkItem = exports.isJiraWorkItem = function isJiraWorkItem(url) {
   return /\/browse\/((?:\w+)-(?:\d+))/i.test(url);
 };
 var EditorCardProvider = exports.EditorCardProvider = /*#__PURE__*/function (_ref) {
-  function EditorCardProvider(envKey, baseUrlOverride, product, onResolve) {
+  function EditorCardProvider(envKey, baseUrlOverride, product, onResolve, customCardClient) {
     var _this;
     (0, _classCallCheck2.default)(this, EditorCardProvider);
     _this = _callSuper(this, EditorCardProvider);
@@ -159,8 +159,8 @@ var EditorCardProvider = exports.EditorCardProvider = /*#__PURE__*/function (_re
         return setTimeout(callback, BATCH_WAIT_TIME);
       }
     });
-    _this.cardClient = new _linkProvider.CardClient(envKey, baseUrlOverride);
-    if (product) {
+    _this.cardClient = customCardClient !== null && customCardClient !== void 0 ? customCardClient : new _linkProvider.CardClient(envKey, baseUrlOverride);
+    if (!customCardClient && product) {
       _this.cardClient.setProduct(product);
     }
     return _this;

package/dist/es2019/provider.js

@@ -68,7 +68,7 @@ url.match(/\/wiki\/spaces\/(?<resourceContext>[^\/]+)\/calendars\/(?<resourceId>
 const isJiraIssueNavigator = url => url.match(/^https:\/\/.*?\/jira\/software|core\/(c\/)?projects\/[^\/]+?\/issues\/?/);
 export const isJiraWorkItem = url => /\/browse\/((?:\w+)-(?:\d+))/i.test(url);
 export class EditorCardProvider extends NodeDataProvider {
-  constructor(envKey, baseUrlOverride, product, onResolve) {
+  constructor(envKey, baseUrlOverride, product, onResolve, customCardClient) {
     super();
     _defineProperty(this, "getExperimentValue", (experimentName, parameterName, defaultValue) => {
       try {
@@ -88,8 +88,8 @@ export class EditorCardProvider extends NodeDataProvider {
     this.providersLoader = new DataLoader(keys => this.batchProviders(keys), {
       batchScheduleFn: callback => setTimeout(callback, BATCH_WAIT_TIME)
     });
-    this.cardClient = new CardClient(envKey, baseUrlOverride);
-    if (product) {
+    this.cardClient = customCardClient !== null && customCardClient !== void 0 ? customCardClient : new CardClient(envKey, baseUrlOverride);
+    if (!customCardClient && product) {
       this.cardClient.setProduct(product);
     }
   }

package/dist/esm/provider.js

@@ -126,7 +126,7 @@ export var isJiraWorkItem = function isJiraWorkItem(url) {
   return /\/browse\/((?:\w+)-(?:\d+))/i.test(url);
 };
 export var EditorCardProvider = /*#__PURE__*/function (_ref) {
-  function EditorCardProvider(envKey, baseUrlOverride, product, onResolve) {
+  function EditorCardProvider(envKey, baseUrlOverride, product, onResolve, customCardClient) {
     var _this;
     _classCallCheck(this, EditorCardProvider);
     _this = _callSuper(this, EditorCardProvider);
@@ -152,8 +152,8 @@ export var EditorCardProvider = /*#__PURE__*/function (_ref) {
         return setTimeout(callback, BATCH_WAIT_TIME);
       }
     });
-    _this.cardClient = new CardClient(envKey, baseUrlOverride);
-    if (product) {
+    _this.cardClient = customCardClient !== null && customCardClient !== void 0 ? customCardClient : new CardClient(envKey, baseUrlOverride);
+    if (!customCardClient && product) {
       _this.cardClient.setProduct(product);
     }
     return _this;

package/dist/types/provider.d.ts

@@ -2,6 +2,7 @@ import type { JSONNode } from '@atlaskit/editor-json-transformer';
 import { NodeDataProvider } from '@atlaskit/node-data-provider';
 import { type BlockCardAdf, type EmbedCardAdf, type CardAdf, type InlineCardAdf, type CardAppearance, type DatasourceAdf, type ProductType } from '@atlaskit/linking-common';
 import { type CardProvider } from './types';
+import { CardClient } from '@atlaskit/link-provider';
 import { type EnvironmentsKeys } from '@atlaskit/linking-common';
 import { type JsonLd } from '@atlaskit/json-ld-types';
 export declare const isJiraWorkItem: (url: string) => boolean;
@@ -16,7 +17,7 @@ export declare class EditorCardProvider extends NodeDataProvider<CardNode, JsonL
     private providersLoader;
     private cardClient;
     private onResolve;
-    constructor(envKey?: EnvironmentsKeys, baseUrlOverride?: string, product?: ProductType, onResolve?: (url: string) => void);
+    constructor(envKey?: EnvironmentsKeys, baseUrlOverride?: string, product?: ProductType, onResolve?: (url: string) => void, customCardClient?: CardClient);
     nodeDataKey(node: CardNode): string;
     fetchNodesData(nodes: CardNode[]): Promise<JsonLd.Response[]>;
     isNodeSupported(node: JSONNode): node is CardNode;

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

@@ -2,6 +2,7 @@ import type { JSONNode } from '@atlaskit/editor-json-transformer';
 import { NodeDataProvider } from '@atlaskit/node-data-provider';
 import { type BlockCardAdf, type EmbedCardAdf, type CardAdf, type InlineCardAdf, type CardAppearance, type DatasourceAdf, type ProductType } from '@atlaskit/linking-common';
 import { type CardProvider } from './types';
+import { CardClient } from '@atlaskit/link-provider';
 import { type EnvironmentsKeys } from '@atlaskit/linking-common';
 import { type JsonLd } from '@atlaskit/json-ld-types';
 export declare const isJiraWorkItem: (url: string) => boolean;
@@ -16,7 +17,7 @@ export declare class EditorCardProvider extends NodeDataProvider<CardNode, JsonL
     private providersLoader;
     private cardClient;
     private onResolve;
-    constructor(envKey?: EnvironmentsKeys, baseUrlOverride?: string, product?: ProductType, onResolve?: (url: string) => void);
+    constructor(envKey?: EnvironmentsKeys, baseUrlOverride?: string, product?: ProductType, onResolve?: (url: string) => void, customCardClient?: CardClient);
     nodeDataKey(node: CardNode): string;
     fetchNodesData(nodes: CardNode[]): Promise<JsonLd.Response[]>;
     isNodeSupported(node: JSONNode): node is CardNode;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-card-provider",
-	"version": "5.3.1",
+	"version": "5.4.0",
 	"description": "Contains the EditorCardProvider, for determining smart card behaviour in the editor.",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -37,7 +37,7 @@
 		"@atlaskit/json-ld-types": "^1.4.0",
 		"@atlaskit/link-client-extension": "^5.0.0",
 		"@atlaskit/link-extractors": "^2.4.0",
-		"@atlaskit/linking-common": "^9.2.0",
+		"@atlaskit/linking-common": "^9.3.0",
 		"@atlaskit/linking-types": "^14.0.0",
 		"@atlaskit/node-data-provider": "^4.5.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
@@ -46,7 +46,7 @@
 		"dataloader": "^2.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/link-provider": "^3.4.0",
+		"@atlaskit/link-provider": "^3.5.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {