@atlaskit/util-service-support 6.3.4 → 6.4.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/util-service-support
 
+## 6.4.0
+
+### Minor Changes
+
+- [`302503d41b736`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/302503d41b736) -
+  Autofix: add explicit package exports (barrel removal)
+
+## 6.3.5
+
+### Patch Changes
+
+- [`6344a66774597`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/6344a66774597) -
+  Add optional reportTracingHeaders callback and extractTracingHeaders utility to
+  RequestServiceOptions for extracting tracing headers from responses
+
 ## 6.3.4
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -1,8 +1,6 @@
 {
 	"extends": "../../../../tsconfig.local-consumption.json",
 	"compilerOptions": {
-		"declaration": true,
-		"target": "es5",
 		"outDir": "../../../../../confluence/tsDist/@atlaskit__util-service-support",
 		"rootDir": "../",
 		"composite": true,

package/afm-products/tsconfig.json

@@ -1,8 +1,6 @@
 {
 	"extends": "../../../../tsconfig.local-consumption.json",
 	"compilerOptions": {
-		"declaration": true,
-		"target": "es5",
 		"outDir": "../../../../../tsDist/@atlaskit__util-service-support/app",
 		"rootDir": "../",
 		"composite": true,

package/dist/cjs/serviceUtils.js

@@ -4,13 +4,31 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.requestService = void 0;
+exports.requestService = exports.extractTracingHeaders = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _experienceTraceIdContext = require("@atlaskit/react-ufo/experience-trace-id-context");
 var _types = require("./types");
 var _shared = require("./shared");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+var TRACING_RESPONSE_HEADERS = ['x-trace-id', 'atl-request-id'];
+
+/**
+ * Extracts tracing headers (x-trace-id, atl-request-id) from a Response object.
+ * Returns only headers that are present in the response.
+ */
+var extractTracingHeaders = exports.extractTracingHeaders = function extractTracingHeaders(response) {
+  var headers = {};
+  for (var _i = 0, _TRACING_RESPONSE_HEA = TRACING_RESPONSE_HEADERS; _i < _TRACING_RESPONSE_HEA.length; _i++) {
+    var name = _TRACING_RESPONSE_HEA[_i];
+    var value = response.headers.get(name);
+    if (value) {
+      headers[name] = value;
+    }
+  }
+  return headers;
+};
+
 /**
  * @returns Promise containing the json response
  */
@@ -38,6 +56,12 @@ var _requestService = exports.requestService = function requestService(serviceCo
     credentials: credentials
   });
   return fetch(requestUrl, requestOptions).then(function (response) {
+    if (options !== null && options !== void 0 && options.reportTracingHeaders) {
+      var _tracingHeaders = extractTracingHeaders(response);
+      if (Object.keys(_tracingHeaders).length > 0) {
+        options.reportTracingHeaders(_tracingHeaders);
+      }
+    }
     if (response.status === 204) {
       return Promise.resolve();
     } else if (response.ok) {

package/dist/es2019/serviceUtils.js

@@ -1,6 +1,22 @@
 import { getActiveTraceHttpRequestHeaders } from '@atlaskit/react-ufo/experience-trace-id-context';
 import { buildCredentials } from './types';
 import { defaultRequestServiceOptions, buildUrl, buildHeaders } from './shared';
+const TRACING_RESPONSE_HEADERS = ['x-trace-id', 'atl-request-id'];
+
+/**
+ * Extracts tracing headers (x-trace-id, atl-request-id) from a Response object.
+ * Returns only headers that are present in the response.
+ */
+export const extractTracingHeaders = response => {
+  const headers = {};
+  for (const name of TRACING_RESPONSE_HEADERS) {
+    const value = response.headers.get(name);
+    if (value) {
+      headers[name] = value;
+    }
+  }
+  return headers;
+};
 
 /**
  * @returns Promise containing the json response
@@ -36,6 +52,12 @@ export const requestService = (serviceConfig, options) => {
     credentials
   };
   return fetch(requestUrl, requestOptions).then(response => {
+    if (options !== null && options !== void 0 && options.reportTracingHeaders) {
+      const tracingHeaders = extractTracingHeaders(response);
+      if (Object.keys(tracingHeaders).length > 0) {
+        options.reportTracingHeaders(tracingHeaders);
+      }
+    }
     if (response.status === 204) {
       return Promise.resolve();
     } else if (response.ok) {

package/dist/esm/serviceUtils.js

@@ -4,6 +4,23 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import { getActiveTraceHttpRequestHeaders } from '@atlaskit/react-ufo/experience-trace-id-context';
 import { buildCredentials } from './types';
 import { defaultRequestServiceOptions, buildUrl, buildHeaders } from './shared';
+var TRACING_RESPONSE_HEADERS = ['x-trace-id', 'atl-request-id'];
+
+/**
+ * Extracts tracing headers (x-trace-id, atl-request-id) from a Response object.
+ * Returns only headers that are present in the response.
+ */
+export var extractTracingHeaders = function extractTracingHeaders(response) {
+  var headers = {};
+  for (var _i = 0, _TRACING_RESPONSE_HEA = TRACING_RESPONSE_HEADERS; _i < _TRACING_RESPONSE_HEA.length; _i++) {
+    var name = _TRACING_RESPONSE_HEA[_i];
+    var value = response.headers.get(name);
+    if (value) {
+      headers[name] = value;
+    }
+  }
+  return headers;
+};
 
 /**
  * @returns Promise containing the json response
@@ -32,6 +49,12 @@ var _requestService = function requestService(serviceConfig, options) {
     credentials: credentials
   });
   return fetch(requestUrl, requestOptions).then(function (response) {
+    if (options !== null && options !== void 0 && options.reportTracingHeaders) {
+      var _tracingHeaders = extractTracingHeaders(response);
+      if (Object.keys(_tracingHeaders).length > 0) {
+        options.reportTracingHeaders(_tracingHeaders);
+      }
+    }
     if (response.status === 204) {
       return Promise.resolve();
     } else if (response.ok) {

package/dist/types/serviceUtils.d.ts

@@ -1,4 +1,9 @@
 import { type RequestServiceOptions, type ServiceConfig } from './types';
+/**
+ * Extracts tracing headers (x-trace-id, atl-request-id) from a Response object.
+ * Returns only headers that are present in the response.
+ */
+export declare const extractTracingHeaders: (response: Response) => Record<string, string>;
 /**
  * @returns Promise containing the json response
  */

package/dist/types/types.d.ts

@@ -76,5 +76,10 @@ export interface RequestServiceOptions {
     ignoreResponsePayload?: boolean;
     path?: string;
     queryParams?: KeyValues;
+    /**
+     * Optional callback invoked with tracing headers extracted from the response.
+     * Only exposes x-trace-id and atl-request-id headers.
+     */
+    reportTracingHeaders?: (headers: Record<string, string>) => void;
     requestInit?: RequestInit;
 }

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

@@ -1,4 +1,9 @@
 import { type RequestServiceOptions, type ServiceConfig } from './types';
+/**
+ * Extracts tracing headers (x-trace-id, atl-request-id) from a Response object.
+ * Returns only headers that are present in the response.
+ */
+export declare const extractTracingHeaders: (response: Response) => Record<string, string>;
 /**
  * @returns Promise containing the json response
  */

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

@@ -76,5 +76,10 @@ export interface RequestServiceOptions {
     ignoreResponsePayload?: boolean;
     path?: string;
     queryParams?: KeyValues;
+    /**
+     * Optional callback invoked with tracing headers extracted from the response.
+     * Only exposes x-trace-id and atl-request-id headers.
+     */
+    reportTracingHeaders?: (headers: Record<string, string>) => void;
     requestInit?: RequestInit;
 }

package/multipartServiceUtils/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@atlaskit/util-service-support/multipartServiceUtils",
+  "main": "../dist/cjs/multipartServiceUtils.js",
+  "module": "../dist/esm/multipartServiceUtils.js",
+  "module:es2019": "../dist/es2019/multipartServiceUtils.js",
+  "types": "../dist/types/multipartServiceUtils.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.9": {
+      "*": [
+        "../dist/types-ts4.5/multipartServiceUtils.d.ts"
+      ]
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/util-service-support",
-	"version": "6.3.4",
+	"version": "6.4.0",
 	"description": "A library of support classes for integrating React components with REST HTTP services",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -29,7 +29,7 @@
 	},
 	"dependencies": {
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/react-ufo": "^5.0.0",
+		"@atlaskit/react-ufo": "^5.20.0",
 		"@babel/runtime": "^7.0.0",
 		"meros": "^1.3.0"
 	},

package/tsconfig.json

@@ -1,11 +1,4 @@
 {
-  "extends": "../../../tsconfig.json",
-  "compilerOptions": {
-  },
-  "include": [
-    "./src/**/*.ts",
-    "./src/**/*.tsx",
-    "./docs/**/*.ts",
-    "./docs/**/*.tsx"
-  ]
+	"extends": "../../../tsconfig.json",
+	"include": ["./src/**/*.ts", "./src/**/*.tsx", "./docs/**/*.ts", "./docs/**/*.tsx"]
 }

package/afm-jira/tsconfig.json

@@ -1,34 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.jira.json",
-	"compilerOptions": {
-		"declaration": true,
-		"target": "es5",
-		"outDir": "../../../../../jira/tsDist/@atlaskit__util-service-support/app",
-		"rootDir": "../",
-		"composite": true,
-		"noCheck": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*",
-		"../src/**/examples/*",
-		"../src/**/examples/**/*",
-		"../src/**/*.stories.*",
-		"../src/**/stories/*",
-		"../src/**/stories/**/*"
-	],
-	"references": [
-		{
-			"path": "../../../platform/feature-flags/afm-jira/tsconfig.json"
-		},
-		{
-			"path": "../../../react-ufo/atlaskit/afm-jira/tsconfig.json"
-		}
-	]
-}