@atlaskit/util-service-support 6.3.2 → 6.3.3

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/util-service-support
 
+## 6.3.3
+
+### Patch Changes
+
+- [`0fdcb6f2f96fd`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0fdcb6f2f96fd) -
+  Sorted type and interface props to improve Atlaskit docs
+- Updated dependencies
+
 ## 6.3.2
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -1,27 +1,33 @@
 {
-    "extends": "../../../../tsconfig.entry-points.confluence.json",
-    "compilerOptions": {
-        "declaration": true,
-        "target": "es5",
-        "composite": true,
-        "outDir": "../../../../../confluence/tsDist/@atlaskit__util-service-support",
-        "rootDir": "../"
-    },
-    "include": [
-        "../src/**/*.ts",
-        "../src/**/*.tsx"
-    ],
-    "exclude": [
-        "../src/**/__tests__/*",
-        "../src/**/*.test.*",
-        "../src/**/test.*"
-    ],
-    "references": [
-        {
-            "path": "../../../platform/feature-flags/afm-cc/tsconfig.json"
-        },
-        {
-            "path": "../../../react-ufo/atlaskit/afm-cc/tsconfig.json"
-        }
-    ]
+	"extends": "../../../../tsconfig.entry-points.confluence.json",
+	"compilerOptions": {
+		"declaration": true,
+		"target": "es5",
+		"outDir": "../../../../../confluence/tsDist/@atlaskit__util-service-support",
+		"rootDir": "../",
+		"composite": 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-cc/tsconfig.json"
+		},
+		{
+			"path": "../../../react-ufo/atlaskit/afm-cc/tsconfig.json"
+		}
+	]
 }

package/afm-dev-agents/tsconfig.json

@@ -0,0 +1,33 @@
+{
+	"extends": "../../../../tsconfig.entry-points.dev-agents.json",
+	"compilerOptions": {
+		"declaration": true,
+		"target": "es5",
+		"outDir": "../../../../../dev-agents/tsDist/@atlaskit__util-service-support/app",
+		"rootDir": "../",
+		"composite": 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-dev-agents/tsconfig.json"
+		},
+		{
+			"path": "../../../react-ufo/atlaskit/afm-dev-agents/tsconfig.json"
+		}
+	]
+}

package/afm-jira/tsconfig.json

@@ -14,7 +14,13 @@
 	"exclude": [
 		"../src/**/__tests__/*",
 		"../src/**/*.test.*",
-		"../src/**/test.*"
+		"../src/**/test.*",
+		"../src/**/examples.*",
+		"../src/**/examples/*",
+		"../src/**/examples/**/*",
+		"../src/**/*.stories.*",
+		"../src/**/stories/*",
+		"../src/**/stories/**/*"
 	],
 	"references": [
 		{

package/afm-passionfruit/tsconfig.json

@@ -0,0 +1,33 @@
+{
+	"extends": "../../../../tsconfig.entry-points.passionfruit.json",
+	"compilerOptions": {
+		"declaration": true,
+		"target": "es5",
+		"outDir": "../../../../../passionfruit/tsDist/@atlaskit__util-service-support/app",
+		"rootDir": "../",
+		"composite": 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-passionfruit/tsconfig.json"
+		},
+		{
+			"path": "../../../react-ufo/atlaskit/afm-passionfruit/tsconfig.json"
+		}
+	]
+}

package/afm-post-office/tsconfig.json

@@ -14,7 +14,13 @@
 	"exclude": [
 		"../src/**/__tests__/*",
 		"../src/**/*.test.*",
-		"../src/**/test.*"
+		"../src/**/test.*",
+		"../src/**/examples.*",
+		"../src/**/examples/*",
+		"../src/**/examples/**/*",
+		"../src/**/*.stories.*",
+		"../src/**/stories/*",
+		"../src/**/stories/**/*"
 	],
 	"references": [
 		{

package/afm-rovo-extension/tsconfig.json

@@ -0,0 +1,33 @@
+{
+	"extends": "../../../../tsconfig.entry-points.rovo-extension.json",
+	"compilerOptions": {
+		"declaration": true,
+		"target": "es5",
+		"outDir": "../../../../../rovo-extension/tsDist/@atlaskit__util-service-support/app",
+		"rootDir": "../",
+		"composite": 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-rovo-extension/tsconfig.json"
+		},
+		{
+			"path": "../../../react-ufo/atlaskit/afm-rovo-extension/tsconfig.json"
+		}
+	]
+}

package/afm-townsquare/tsconfig.json

@@ -14,7 +14,13 @@
 	"exclude": [
 		"../src/**/__tests__/*",
 		"../src/**/*.test.*",
-		"../src/**/test.*"
+		"../src/**/test.*",
+		"../src/**/examples.*",
+		"../src/**/examples/*",
+		"../src/**/examples/**/*",
+		"../src/**/*.stories.*",
+		"../src/**/stories/*",
+		"../src/**/stories/**/*"
 	],
 	"references": [
 		{

package/afm-volt/tsconfig.json

@@ -14,7 +14,13 @@
 	"exclude": [
 		"../src/**/__tests__/*",
 		"../src/**/*.test.*",
-		"../src/**/test.*"
+		"../src/**/test.*",
+		"../src/**/examples.*",
+		"../src/**/examples/*",
+		"../src/**/examples/**/*",
+		"../src/**/*.stories.*",
+		"../src/**/stories/*",
+		"../src/**/stories/**/*"
 	],
 	"references": [
 		{

package/build/tsconfig.json

@@ -12,6 +12,12 @@
   "exclude": [
     "../src/**/__tests__/*",
     "../src/**/*.test.*",
-    "../src/**/test.*"
+    "../src/**/test.*",
+    "../src/**/examples.*",
+    "../src/**/examples/*",
+    "../src/**/examples/**/*",
+    "../src/**/*.stories.*",
+    "../src/**/stories/*",
+    "../src/**/stories/**/*"
   ]
-}
+}

package/dist/types/multipartServiceUtils.d.ts

@@ -5,19 +5,19 @@ export type MultiPartFetchResult<PartsType> = {
     parts: PartsGenerator<PartsType>;
 };
 export type BodyResult<T> = {
-    isMultipart: false;
     body: T;
+    isMultipart: false;
 };
 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;
-    headers: Record<string, string>;
     body: Fallback;
-} | {
-    json: true;
     headers: Record<string, string>;
+    json: false;
+} | {
     body: Body;
+    headers: Record<string, string>;
+    json: true;
 };
 type Options = Omit<RequestServiceOptions, 'ignoreResponsePayload'>;
 /**

package/dist/types/types.d.ts

@@ -1,8 +1,4 @@
 export interface OnProviderChange<R, E, I> {
-    /**
-     * Normal callback on a search result, or updated search result.
-     */
-    result(result: R): void;
     /**
      * When something goes wrong, e.g. underlying service is not available.
      */
@@ -17,6 +13,10 @@ export interface OnProviderChange<R, E, I> {
      * eventually be fulfilled.
      */
     notReady?(): void;
+    /**
+     * Normal callback on a search result, or updated search result.
+     */
+    result(result: R): void;
 }
 /**
  * Defines a typical Resource.
@@ -49,9 +49,9 @@ export interface KeyValues {
     [index: string]: any;
 }
 export interface SecurityOptions {
-    params?: KeyValues;
     headers?: KeyValues;
     omitCredentials?: boolean;
+    params?: KeyValues;
 }
 export declare const buildCredentials: (secOptions?: SecurityOptions) => "omit" | "include";
 /**
@@ -68,13 +68,13 @@ export interface SecurityProvider {
     (): SecurityOptions;
 }
 export interface ServiceConfig {
-    url: string;
-    securityProvider?: SecurityProvider;
     refreshedSecurityProvider?: RefreshSecurityProvider;
+    securityProvider?: SecurityProvider;
+    url: string;
 }
 export interface RequestServiceOptions {
+    ignoreResponsePayload?: boolean;
     path?: string;
     queryParams?: KeyValues;
     requestInit?: RequestInit;
-    ignoreResponsePayload?: boolean;
 }

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

@@ -5,19 +5,19 @@ export type MultiPartFetchResult<PartsType> = {
     parts: PartsGenerator<PartsType>;
 };
 export type BodyResult<T> = {
-    isMultipart: false;
     body: T;
+    isMultipart: false;
 };
 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;
-    headers: Record<string, string>;
     body: Fallback;
-} | {
-    json: true;
     headers: Record<string, string>;
+    json: false;
+} | {
     body: Body;
+    headers: Record<string, string>;
+    json: true;
 };
 type Options = Omit<RequestServiceOptions, 'ignoreResponsePayload'>;
 /**

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

@@ -1,8 +1,4 @@
 export interface OnProviderChange<R, E, I> {
-    /**
-     * Normal callback on a search result, or updated search result.
-     */
-    result(result: R): void;
     /**
      * When something goes wrong, e.g. underlying service is not available.
      */
@@ -17,6 +13,10 @@ export interface OnProviderChange<R, E, I> {
      * eventually be fulfilled.
      */
     notReady?(): void;
+    /**
+     * Normal callback on a search result, or updated search result.
+     */
+    result(result: R): void;
 }
 /**
  * Defines a typical Resource.
@@ -49,9 +49,9 @@ export interface KeyValues {
     [index: string]: any;
 }
 export interface SecurityOptions {
-    params?: KeyValues;
     headers?: KeyValues;
     omitCredentials?: boolean;
+    params?: KeyValues;
 }
 export declare const buildCredentials: (secOptions?: SecurityOptions) => "omit" | "include";
 /**
@@ -68,13 +68,13 @@ export interface SecurityProvider {
     (): SecurityOptions;
 }
 export interface ServiceConfig {
-    url: string;
-    securityProvider?: SecurityProvider;
     refreshedSecurityProvider?: RefreshSecurityProvider;
+    securityProvider?: SecurityProvider;
+    url: string;
 }
 export interface RequestServiceOptions {
+    ignoreResponsePayload?: boolean;
     path?: string;
     queryParams?: KeyValues;
     requestInit?: RequestInit;
-    ignoreResponsePayload?: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/util-service-support",
-	"version": "6.3.2",
+	"version": "6.3.3",
 	"description": "A library of support classes for integrating React components with REST HTTP services",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -35,15 +35,14 @@
 	},
 	"dependencies": {
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/react-ufo": "^4.0.0",
+		"@atlaskit/react-ufo": "^4.4.0",
 		"@babel/runtime": "^7.0.0",
 		"meros": "^1.3.0"
 	},
 	"devDependencies": {
 		"es6-promise": "^4.0.5",
 		"fetch-mock": "^8.0.0",
-		"sinon": "^2.2.0",
-		"typescript": "~5.4.2"
+		"sinon": "^2.2.0"
 	},
 	"keywords": [
 		"fabric",

package/serviceResources/package.json

@@ -5,7 +5,7 @@
   "module:es2019": "../dist/es2019/serviceResources.js",
   "types": "../dist/types/serviceResources.d.ts",
   "typesVersions": {
-    ">=4.5 <5.4": {
+    ">=4.5 <5.9": {
       "*": [
         "../dist/types-ts4.5/serviceResources.d.ts"
       ]

package/serviceUtils/package.json

@@ -5,7 +5,7 @@
   "module:es2019": "../dist/es2019/serviceUtils.js",
   "types": "../dist/types/serviceUtils.d.ts",
   "typesVersions": {
-    ">=4.5 <5.4": {
+    ">=4.5 <5.9": {
       "*": [
         "../dist/types-ts4.5/serviceUtils.d.ts"
       ]

package/types/package.json

@@ -5,7 +5,7 @@
   "module:es2019": "../dist/es2019/types.js",
   "types": "../dist/types/types.d.ts",
   "typesVersions": {
-    ">=4.5 <5.4": {
+    ">=4.5 <5.9": {
       "*": [
         "../dist/types-ts4.5/types.d.ts"
       ]