@atlaskit/util-service-support 6.0.5 → 6.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +18 -0
- package/build/tsconfig.json +6 -2
- package/dist/cjs/index.js +5 -1
- package/dist/cjs/serviceUtils.js +5 -10
- package/dist/cjs/version.json +1 -1
- package/dist/es2019/serviceUtils.js +3 -5
- package/dist/es2019/version.json +1 -1
- package/dist/esm/serviceUtils.js +5 -7
- package/dist/esm/version.json +1 -1
- package/package.json +8 -7
- package/report.api.md +127 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,23 @@
|
|
|
1
1
|
# @atlaskit/util-service-support
|
|
2
2
|
|
|
3
|
+
## 6.1.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`8d4228767b0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8d4228767b0) - Upgrade Typescript from `4.2.4` to `4.3.5`.
|
|
8
|
+
|
|
9
|
+
## 6.1.1
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- [`cb2392f6d33`](https://bitbucket.org/atlassian/atlassian-frontend/commits/cb2392f6d33) - Upgrade to TypeScript 4.2.4
|
|
14
|
+
|
|
15
|
+
## 6.1.0
|
|
16
|
+
|
|
17
|
+
### Minor Changes
|
|
18
|
+
|
|
19
|
+
- [`19d72473dfb`](https://bitbucket.org/atlassian/atlassian-frontend/commits/19d72473dfb) - Remove unused polyfills
|
|
20
|
+
|
|
3
21
|
## 6.0.5
|
|
4
22
|
|
|
5
23
|
### Patch Changes
|
package/build/tsconfig.json
CHANGED
package/dist/cjs/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var _typeof = require("@babel/runtime/helpers/typeof");
|
|
4
4
|
|
|
5
5
|
Object.defineProperty(exports, "__esModule", {
|
|
6
6
|
value: true
|
|
@@ -40,5 +40,9 @@ Object.keys(_serviceResources).forEach(function (key) {
|
|
|
40
40
|
|
|
41
41
|
var serviceUtils = _interopRequireWildcard(require("./serviceUtils"));
|
|
42
42
|
|
|
43
|
+
function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
|
|
44
|
+
|
|
45
|
+
function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
|
|
46
|
+
|
|
43
47
|
var utils = serviceUtils;
|
|
44
48
|
exports.utils = utils;
|
package/dist/cjs/serviceUtils.js
CHANGED
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
|
|
3
|
-
var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard");
|
|
4
|
-
|
|
5
3
|
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
|
6
4
|
|
|
7
5
|
Object.defineProperty(exports, "__esModule", {
|
|
@@ -11,24 +9,21 @@ exports.requestService = void 0;
|
|
|
11
9
|
|
|
12
10
|
var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
|
|
13
11
|
|
|
14
|
-
var URL = _interopRequireWildcard(require("url"));
|
|
15
|
-
|
|
16
|
-
var _urlSearchParams = _interopRequireDefault(require("url-search-params"));
|
|
17
|
-
|
|
18
12
|
var _types = require("./types");
|
|
19
13
|
|
|
20
|
-
function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object);
|
|
14
|
+
function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
|
|
21
15
|
|
|
22
|
-
function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]
|
|
16
|
+
function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
|
|
23
17
|
|
|
24
|
-
var URLSearchParams = _urlSearchParams.default.default || _urlSearchParams.default;
|
|
25
18
|
var defaultRequestServiceOptions = {};
|
|
26
19
|
|
|
27
20
|
var buildUrl = function buildUrl(baseUrl) {
|
|
28
21
|
var path = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
|
|
29
22
|
var queryParams = arguments.length > 2 ? arguments[2] : undefined;
|
|
30
23
|
var secOptions = arguments.length > 3 ? arguments[3] : undefined;
|
|
31
|
-
var searchParam = new URLSearchParams(URL.
|
|
24
|
+
var searchParam = new URLSearchParams( // For relative urls, the URL class requires base to be set. It's ignored if a url is not relative.
|
|
25
|
+
// Since we only care about search params it is fine to have any base url here.
|
|
26
|
+
new URL(baseUrl, 'https://BASE_FALLBACK').search || undefined);
|
|
32
27
|
baseUrl = baseUrl.split('?')[0];
|
|
33
28
|
|
|
34
29
|
if (queryParams) {
|
package/dist/cjs/version.json
CHANGED
|
@@ -1,12 +1,10 @@
|
|
|
1
|
-
import * as URL from 'url';
|
|
2
|
-
import USP from 'url-search-params'; // IE, Safari, Mobile Chrome, Mobile Safari
|
|
3
|
-
|
|
4
1
|
import { buildCredentials } from './types';
|
|
5
|
-
const URLSearchParams = USP.default || USP;
|
|
6
2
|
const defaultRequestServiceOptions = {};
|
|
7
3
|
|
|
8
4
|
const buildUrl = (baseUrl, path = '', queryParams, secOptions) => {
|
|
9
|
-
const searchParam = new URLSearchParams(URL.
|
|
5
|
+
const searchParam = new URLSearchParams( // For relative urls, the URL class requires base to be set. It's ignored if a url is not relative.
|
|
6
|
+
// Since we only care about search params it is fine to have any base url here.
|
|
7
|
+
new URL(baseUrl, 'https://BASE_FALLBACK').search || undefined);
|
|
10
8
|
baseUrl = baseUrl.split('?')[0];
|
|
11
9
|
|
|
12
10
|
if (queryParams) {
|
package/dist/es2019/version.json
CHANGED
package/dist/esm/serviceUtils.js
CHANGED
|
@@ -1,21 +1,19 @@
|
|
|
1
1
|
import _defineProperty from "@babel/runtime/helpers/defineProperty";
|
|
2
2
|
|
|
3
|
-
function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object);
|
|
3
|
+
function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
|
|
4
4
|
|
|
5
|
-
function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]
|
|
6
|
-
|
|
7
|
-
import * as URL from 'url';
|
|
8
|
-
import USP from 'url-search-params'; // IE, Safari, Mobile Chrome, Mobile Safari
|
|
5
|
+
function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
|
|
9
6
|
|
|
10
7
|
import { buildCredentials } from './types';
|
|
11
|
-
var URLSearchParams = USP.default || USP;
|
|
12
8
|
var defaultRequestServiceOptions = {};
|
|
13
9
|
|
|
14
10
|
var buildUrl = function buildUrl(baseUrl) {
|
|
15
11
|
var path = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
|
|
16
12
|
var queryParams = arguments.length > 2 ? arguments[2] : undefined;
|
|
17
13
|
var secOptions = arguments.length > 3 ? arguments[3] : undefined;
|
|
18
|
-
var searchParam = new URLSearchParams(URL.
|
|
14
|
+
var searchParam = new URLSearchParams( // For relative urls, the URL class requires base to be set. It's ignored if a url is not relative.
|
|
15
|
+
// Since we only care about search params it is fine to have any base url here.
|
|
16
|
+
new URL(baseUrl, 'https://BASE_FALLBACK').search || undefined);
|
|
19
17
|
baseUrl = baseUrl.split('?')[0];
|
|
20
18
|
|
|
21
19
|
if (queryParams) {
|
package/dist/esm/version.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/util-service-support",
|
|
3
|
-
"version": "6.
|
|
3
|
+
"version": "6.1.2",
|
|
4
4
|
"description": "A library of support classes for integrating React components with REST HTTP services",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -15,22 +15,22 @@
|
|
|
15
15
|
"atlaskit:src": "src/index.ts",
|
|
16
16
|
"atlassian": {
|
|
17
17
|
"deprecatedAutoEntryPoints": true,
|
|
18
|
-
"releaseModel": "continuous"
|
|
18
|
+
"releaseModel": "continuous",
|
|
19
|
+
"team": "UIP: Monorepo"
|
|
19
20
|
},
|
|
20
21
|
"config": {
|
|
21
22
|
"access": "public"
|
|
22
23
|
},
|
|
23
24
|
"dependencies": {
|
|
24
|
-
"@babel/runtime": "^7.0.0"
|
|
25
|
-
"url": "^0.11.0",
|
|
26
|
-
"url-search-params": "^0.10.0"
|
|
25
|
+
"@babel/runtime": "^7.0.0"
|
|
27
26
|
},
|
|
28
27
|
"devDependencies": {
|
|
29
28
|
"@atlaskit/docs": "*",
|
|
29
|
+
"@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
|
|
30
30
|
"es6-promise": "^4.0.5",
|
|
31
31
|
"fetch-mock": "^8.0.0",
|
|
32
32
|
"sinon": "^2.2.0",
|
|
33
|
-
"typescript": "3.
|
|
33
|
+
"typescript": "4.3.5"
|
|
34
34
|
},
|
|
35
35
|
"keywords": [
|
|
36
36
|
"fabric",
|
|
@@ -41,5 +41,6 @@
|
|
|
41
41
|
"@atlassian/frontend": {
|
|
42
42
|
"tree-shaking": []
|
|
43
43
|
}
|
|
44
|
-
}
|
|
44
|
+
},
|
|
45
|
+
"prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
|
|
45
46
|
}
|
package/report.api.md
ADDED
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
## API Report File for "@atlaskit/util-service-support".
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export declare abstract class AbstractResource<Q, R, E, I, O>
|
|
9
|
+
implements Provider<Q, R, E, I, O> {
|
|
10
|
+
private lastResult;
|
|
11
|
+
private listeners;
|
|
12
|
+
abstract filter(query?: Q, options?: O): void;
|
|
13
|
+
subscribe(onChange: OnProviderChange<R, E, I>): void;
|
|
14
|
+
unsubscribe(onChange: OnProviderChange<R, E, I>): void;
|
|
15
|
+
protected notifyResult(result: R): void;
|
|
16
|
+
protected notifyError(error: E): void;
|
|
17
|
+
protected notifyInfo(info: I): void;
|
|
18
|
+
protected notifyNotReady(): void;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
export declare const buildCredentials: (
|
|
22
|
+
secOptions?: SecurityOptions | undefined,
|
|
23
|
+
) => 'omit' | 'include';
|
|
24
|
+
|
|
25
|
+
export declare interface KeyValues {
|
|
26
|
+
[index: string]: any;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
export declare interface OnProviderChange<R, E, I> {
|
|
30
|
+
/**
|
|
31
|
+
* Normal callback on a search result, or updated search result.
|
|
32
|
+
*/
|
|
33
|
+
result(result: R): void;
|
|
34
|
+
/**
|
|
35
|
+
* When something goes wrong, e.g. underlying service is not available.
|
|
36
|
+
*/
|
|
37
|
+
error?(error: E): void;
|
|
38
|
+
/**
|
|
39
|
+
* Information to display, e.g. due to slow searches, initial message, etc.
|
|
40
|
+
*/
|
|
41
|
+
info?(info: I): void;
|
|
42
|
+
/**
|
|
43
|
+
* Notifies if the Resource is not ready and won't respond to searches
|
|
44
|
+
* in a timely manner. Note searches that occur while not ready Will
|
|
45
|
+
* eventually be fulfilled.
|
|
46
|
+
*/
|
|
47
|
+
notReady?(): void;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Defines a typical Resource.
|
|
52
|
+
*
|
|
53
|
+
* Q = query type
|
|
54
|
+
* R = result type
|
|
55
|
+
* E = error type
|
|
56
|
+
* I = info type
|
|
57
|
+
* O = options that filter can accept
|
|
58
|
+
*/
|
|
59
|
+
export declare interface Provider<Q, R, E, I, O> {
|
|
60
|
+
/**
|
|
61
|
+
* Results are returned to the OnSearchResult
|
|
62
|
+
* in the subscriber.
|
|
63
|
+
*
|
|
64
|
+
* There may not be a 1-on-1 relationship between a search
|
|
65
|
+
* and a callback.
|
|
66
|
+
*
|
|
67
|
+
* For example, multiple queries may result in one callback if the
|
|
68
|
+
* responses are out of order (i.e. old responses are dropped). Or
|
|
69
|
+
* multiple callbacks may be fired, for example if the underlying data
|
|
70
|
+
* set to search has changed, the last search may be executed again
|
|
71
|
+
* with updated results.
|
|
72
|
+
*/
|
|
73
|
+
filter(query?: Q, options?: O): void;
|
|
74
|
+
subscribe(onChange: OnProviderChange<R, E, I>): void;
|
|
75
|
+
unsubscribe(onChange: OnProviderChange<R, E, I>): void;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* Returns a promise to a SecurityOptions that has just been forcibly refreshed with a
|
|
80
|
+
* new token. Will be used for single retry per request if a 401 is returned.
|
|
81
|
+
*/
|
|
82
|
+
export declare interface RefreshSecurityProvider {
|
|
83
|
+
(): Promise<SecurityOptions>;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* @returns Promise containing the json response
|
|
88
|
+
*/
|
|
89
|
+
declare const requestService: <T>(
|
|
90
|
+
serviceConfig: ServiceConfig,
|
|
91
|
+
options?: RequestServiceOptions | undefined,
|
|
92
|
+
) => Promise<T>;
|
|
93
|
+
|
|
94
|
+
export declare interface RequestServiceOptions {
|
|
95
|
+
path?: string;
|
|
96
|
+
queryParams?: KeyValues;
|
|
97
|
+
requestInit?: RequestInit;
|
|
98
|
+
ignoreResponsePayload?: boolean;
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
export declare interface SecurityOptions {
|
|
102
|
+
params?: KeyValues;
|
|
103
|
+
headers?: KeyValues;
|
|
104
|
+
omitCredentials?: boolean;
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
/**
|
|
108
|
+
* Returns the current SecurityOptions for the mentions service.
|
|
109
|
+
*/
|
|
110
|
+
export declare interface SecurityProvider {
|
|
111
|
+
(): SecurityOptions;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
export declare interface ServiceConfig {
|
|
115
|
+
url: string;
|
|
116
|
+
securityProvider?: SecurityProvider;
|
|
117
|
+
refreshedSecurityProvider?: RefreshSecurityProvider;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
declare namespace serviceUtils {
|
|
121
|
+
export { requestService };
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
export declare const utils: typeof serviceUtils;
|
|
125
|
+
|
|
126
|
+
export {};
|
|
127
|
+
```
|