@atlaskit/util-service-support 6.3.0 → 6.3.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/util-service-support
 
+## 6.3.2
+
+### Patch Changes
+
+- Updated dependencies
+
+## 6.3.1
+
+### Patch Changes
+
+- [#128616](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/128616)
+  [`6e9df3227a504`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/6e9df3227a504) -
+  Improve type safety of requestServiceMultipart API
+
 ## 6.3.0
 
 ### Minor Changes

package/afm-cc/tsconfig.json

@@ -4,7 +4,7 @@
         "declaration": true,
         "target": "es5",
         "composite": true,
-        "outDir": "../dist",
+        "outDir": "../../../../../confluence/tsDist/@atlaskit__util-service-support",
         "rootDir": "../"
     },
     "include": [

package/afm-townsquare/tsconfig.json

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

package/afm-volt/tsconfig.json

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

package/dist/cjs/index.js

@@ -35,7 +35,6 @@ Object.keys(_serviceResources).forEach(function (key) {
 });
 var serviceUtils = _interopRequireWildcard(require("./serviceUtils"));
 var multipartServiceUtils = _interopRequireWildcard(require("./multipartServiceUtils"));
-function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
-function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
 var utils = exports.utils = serviceUtils;
 var multipartUtils = exports.multipartUtils = multipartServiceUtils;

package/dist/cjs/multipartServiceUtils.js

@@ -22,6 +22,11 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
  * Make a request that **may** result in an HTTP multipart response from the server.
  * @returns an object with a parsed JSON body OR an object with the parts from
  * the HTTP multipart response.
+ *
+ * PartsType type parameter specifies the type of the response when the server response
+ * is multipart.
+ *
+ * BodyType specifies the type of the response when the server response is not multipart
  */
 var _requestServiceMultipart = exports.requestServiceMultipart = /*#__PURE__*/function () {
   var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(serviceConfig) {

package/dist/es2019/multipartServiceUtils.js

@@ -11,6 +11,11 @@ import { getActiveTraceHttpRequestHeaders } from '@atlaskit/react-ufo/experience
  * Make a request that **may** result in an HTTP multipart response from the server.
  * @returns an object with a parsed JSON body OR an object with the parts from
  * the HTTP multipart response.
+ *
+ * PartsType type parameter specifies the type of the response when the server response
+ * is multipart.
+ *
+ * BodyType specifies the type of the response when the server response is not multipart
  */
 export const requestServiceMultipart = async (serviceConfig, options = defaultRequestServiceOptions) => {
   const {
@@ -53,7 +58,7 @@ export const requestServiceMultipart = async (serviceConfig, options = defaultRe
     if (parts[Symbol.asyncIterator] < 'u') {
       // this lets us know that the response is multipart
       //
-      // 	((parts as PartsType)[Symbol.asyncIterator] as any) < 'u' came from the `meros` docs:
+      // 	((parts as PartsGenerator)[Symbol.asyncIterator] as any) < 'u' came from the `meros` docs:
       //	https://github.com/maraisr/meros/blob/dec4feaa24090b94e8ac42fab1aff38a1e521680/readme.md
       // 	Look for expand section `If the content-type is NOT a multipart, then meros will resolve with the response argument.`
       return {

package/dist/esm/multipartServiceUtils.js

@@ -16,6 +16,11 @@ import { getActiveTraceHttpRequestHeaders } from '@atlaskit/react-ufo/experience
  * Make a request that **may** result in an HTTP multipart response from the server.
  * @returns an object with a parsed JSON body OR an object with the parts from
  * the HTTP multipart response.
+ *
+ * PartsType type parameter specifies the type of the response when the server response
+ * is multipart.
+ *
+ * BodyType specifies the type of the response when the server response is not multipart
  */
 var _requestServiceMultipart = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(serviceConfig) {

package/dist/types/index.d.ts

@@ -4,3 +4,4 @@ import * as serviceUtils from './serviceUtils';
 import * as multipartServiceUtils from './multipartServiceUtils';
 export declare const utils: typeof serviceUtils;
 export declare const multipartUtils: typeof multipartServiceUtils;
+export type { RequestServiceResult, PartsGenerator, MultiPartFetchResult, BodyResult, } from './multipartServiceUtils';

package/dist/types/multipartServiceUtils.d.ts

@@ -1,14 +1,14 @@
 import { type RequestServiceOptions, type ServiceConfig } from './types';
-type PartsType = AsyncGenerator<Part<object, string>, unknown, unknown>;
-type MultiPartFetchResult = {
+export type PartsGenerator<PartsType> = AsyncGenerator<Part<PartsType, unknown>>;
+export type MultiPartFetchResult<PartsType> = {
     isMultipart: true;
-    parts: PartsType;
+    parts: PartsGenerator<PartsType>;
 };
-type BodyResult<T> = {
+export type BodyResult<T> = {
     isMultipart: false;
     body: T;
 };
-type RequestServiceResult<BodyType> = MultiPartFetchResult | BodyResult<BodyType>;
+export type RequestServiceResult<PartsType, BodyType> = MultiPartFetchResult<PartsType> | BodyResult<BodyType>;
 /** Copied from meros types, as there are difficulties with resolving the type in CI */
 export type Part<Body, Fallback> = {
     json: false;
@@ -24,6 +24,11 @@ type Options = Omit<RequestServiceOptions, 'ignoreResponsePayload'>;
  * Make a request that **may** result in an HTTP multipart response from the server.
  * @returns an object with a parsed JSON body OR an object with the parts from
  * the HTTP multipart response.
+ *
+ * PartsType type parameter specifies the type of the response when the server response
+ * is multipart.
+ *
+ * BodyType specifies the type of the response when the server response is not multipart
  */
-export declare const requestServiceMultipart: <T>(serviceConfig: ServiceConfig, options?: Options) => Promise<RequestServiceResult<T>>;
+export declare const requestServiceMultipart: <PartsType, BodyType>(serviceConfig: ServiceConfig, options?: Options) => Promise<RequestServiceResult<PartsType, BodyType>>;
 export {};

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

@@ -4,3 +4,4 @@ import * as serviceUtils from './serviceUtils';
 import * as multipartServiceUtils from './multipartServiceUtils';
 export declare const utils: typeof serviceUtils;
 export declare const multipartUtils: typeof multipartServiceUtils;
+export type { RequestServiceResult, PartsGenerator, MultiPartFetchResult, BodyResult, } from './multipartServiceUtils';

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

@@ -1,14 +1,14 @@
 import { type RequestServiceOptions, type ServiceConfig } from './types';
-type PartsType = AsyncGenerator<Part<object, string>, unknown, unknown>;
-type MultiPartFetchResult = {
+export type PartsGenerator<PartsType> = AsyncGenerator<Part<PartsType, unknown>>;
+export type MultiPartFetchResult<PartsType> = {
     isMultipart: true;
-    parts: PartsType;
+    parts: PartsGenerator<PartsType>;
 };
-type BodyResult<T> = {
+export type BodyResult<T> = {
     isMultipart: false;
     body: T;
 };
-type RequestServiceResult<BodyType> = MultiPartFetchResult | BodyResult<BodyType>;
+export type RequestServiceResult<PartsType, BodyType> = MultiPartFetchResult<PartsType> | BodyResult<BodyType>;
 /** Copied from meros types, as there are difficulties with resolving the type in CI */
 export type Part<Body, Fallback> = {
     json: false;
@@ -24,6 +24,11 @@ type Options = Omit<RequestServiceOptions, 'ignoreResponsePayload'>;
  * Make a request that **may** result in an HTTP multipart response from the server.
  * @returns an object with a parsed JSON body OR an object with the parts from
  * the HTTP multipart response.
+ *
+ * PartsType type parameter specifies the type of the response when the server response
+ * is multipart.
+ *
+ * BodyType specifies the type of the response when the server response is not multipart
  */
-export declare const requestServiceMultipart: <T>(serviceConfig: ServiceConfig, options?: Options) => Promise<RequestServiceResult<T>>;
+export declare const requestServiceMultipart: <PartsType, BodyType>(serviceConfig: ServiceConfig, options?: Options) => Promise<RequestServiceResult<PartsType, BodyType>>;
 export {};

package/package.json

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