@resolution/atlassian-api-common 0.12.4 → 0.13.0
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/lib/fetch/index.d.ts +20 -1
- package/lib/fetch/index.js +8 -2
- package/lib/fetch/index.js.map +1 -1
- package/lib/index.d.ts +1 -0
- package/lib/index.js +3 -1
- package/lib/index.js.map +1 -1
- package/lib/retryOnNetworkAndInternalErrors.d.ts +4 -0
- package/lib/retryOnNetworkAndInternalErrors.js +19 -0
- package/lib/retryOnNetworkAndInternalErrors.js.map +1 -0
- package/package.json +2 -2
package/lib/fetch/index.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import type { CommonHttpClientOptions } from "api-typescript-generator/openapi-client";
|
|
1
|
+
import type { CommonHttpClientFetchRequest, CommonHttpClientOptions } from "api-typescript-generator/openapi-client";
|
|
2
|
+
import { ApiError } from "../ApiError";
|
|
2
3
|
import type { AtlassianProductName } from "./common";
|
|
3
4
|
import { type ApiClientAceOptions } from "./createAceFetch";
|
|
4
5
|
import { type ApiClientApOptions } from "./createApFetch";
|
|
@@ -12,6 +13,24 @@ export type ApiClientOptions<T extends AllOpenApiClientOptions> = T & {
|
|
|
12
13
|
* Custom validation error handler.
|
|
13
14
|
*/
|
|
14
15
|
handleValidationError?(error: Error): void;
|
|
16
|
+
/**
|
|
17
|
+
* Custom deprecation warning logger.
|
|
18
|
+
*/
|
|
19
|
+
logDeprecationWarning?(params: {
|
|
20
|
+
/**
|
|
21
|
+
* Either operation method name in case if it's not part of the service, or service name and operation method
|
|
22
|
+
* name separated by a dot.
|
|
23
|
+
*
|
|
24
|
+
* Examples: `users.getUserById`, `getSystemConfig`
|
|
25
|
+
*/
|
|
26
|
+
operationName: string;
|
|
27
|
+
path: string;
|
|
28
|
+
method: CommonHttpClientFetchRequest["method"];
|
|
29
|
+
}): void;
|
|
30
|
+
/**
|
|
31
|
+
* Determine whether to retry the request on error.
|
|
32
|
+
*/
|
|
33
|
+
shouldRetryOnError?: (error: ApiError, attemptNumber: number) => boolean;
|
|
15
34
|
};
|
|
16
35
|
export declare function getCommonApiClientOptions<TOptions extends AllOpenApiClientOptions>(options: ApiClientOptions<TOptions> & {
|
|
17
36
|
basePath?: string;
|
package/lib/fetch/index.js
CHANGED
|
@@ -73,10 +73,16 @@ function getCommonApiClientOptions(options, productName) {
|
|
|
73
73
|
if (options.basePath !== undefined) {
|
|
74
74
|
result.preprocessRequest = (request) => Promise.resolve(Object.assign(Object.assign({}, request), { path: options.basePath + request.path }));
|
|
75
75
|
}
|
|
76
|
-
if (
|
|
77
|
-
|
|
76
|
+
if (options.logDeprecationWarning !== undefined) {
|
|
77
|
+
result.logDeprecationWarning = options.logDeprecationWarning;
|
|
78
|
+
}
|
|
79
|
+
if (options.handleValidationError !== undefined) {
|
|
78
80
|
result.handleValidationError = options.handleValidationError;
|
|
79
81
|
}
|
|
82
|
+
if (options.shouldRetryOnError !== undefined) {
|
|
83
|
+
result.shouldRetryOnError =
|
|
84
|
+
options.shouldRetryOnError;
|
|
85
|
+
}
|
|
80
86
|
return result;
|
|
81
87
|
}
|
|
82
88
|
exports.getCommonApiClientOptions = getCommonApiClientOptions;
|
package/lib/fetch/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/fetch/index.ts"],"names":[],"mappings":";;;AAMA,0CAAuC;AAEvC,qDAA4E;AAC5E,mDAAyE;AACzE,+EAGuC;AACvC,+DAG+B;AAC/B,uFAG2C;AAC3C,qEAKkC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/fetch/index.ts"],"names":[],"mappings":";;;AAMA,0CAAuC;AAEvC,qDAA4E;AAC5E,mDAAyE;AACzE,+EAGuC;AACvC,+DAG+B;AAC/B,uFAG2C;AAC3C,qEAKkC;AAoClC;;;GAGG;AACH,SAAS,iBAAiB,CACxB,OAAgC,EAChC,WAAiC;IAEjC,IAAI,UAAU,IAAI,OAAO,EAAE,CAAC;QAC1B,OAAO,IAAA,yCAAmB,EAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IACnD,CAAC;SAAM,IAAI,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,OAAO,IAAA,+BAAc,EAAC,OAAO,CAAC,CAAC;IACjC,CAAC;SAAM,IAAI,IAAI,IAAI,OAAO,EAAE,CAAC;QAC3B,OAAO,IAAA,6BAAa,EAAC,OAAO,CAAC,CAAC;IAChC,CAAC;SAAM,IAAI,aAAa,IAAI,OAAO,EAAE,CAAC;QACpC,OAAO,IAAA,mDAA0B,EAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;SAAM,IAAI,mBAAmB,IAAI,OAAO,EAAE,CAAC;QAC1C,OAAO,IAAA,yDAAgC,EAAC,OAAO,CAAC,CAAC;IACnD,CAAC;SAAM,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC;QAC9B,OAAO,IAAA,yDAA2B,EAAC,OAAO,CAAC,CAAC;IAC9C,CAAC;SAAM,IAAI,sBAAsB,IAAI,OAAO,EAAE,CAAC;QAC7C,OAAO,IAAA,iEAA+B,EAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;AACjD,CAAC;AAED;;GAEG;AACH,SAAS,sBAAsB,CAC7B,QAAuC,EACvC,OAAqC;IAErC,IAAI,iBAAiB,GAAG,EAAE,CAAC;IAC3B,IACE,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM;QAC7B,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ;QACtC,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,EAC3B,CAAC;QACD,IACE,eAAe,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI;YACrC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,EAC/C,CAAC;YACD,iBAAiB,IAAI,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzE,CAAC;QACD,IACE,QAAQ,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI;YAC9B,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,QAAQ;YAC7C,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,IAAI,EAClC,CAAC;YACD,iBAAiB;gBACf,IAAI;oBACJ,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;yBACtC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,KAAK,EAAE,CAAC;yBACzC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjB,CAAC;IACH,CAAC;IACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAClC,OAAO,cAAc,OAAO,CAAC,MAAM,IAAI,GAAG,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,IAAI,iBAAiB,EAAE,CAAC;AACxH,CAAC;AAED,SAAgB,yBAAyB,CAGvC,OAA2D,EAC3D,WAAiC;IAEjC,MAAM,MAAM,GAAqC;QAC/C,KAAK,EAAE,iBAAiB,CAAC,OAAO,EAAE,WAAW,CAAC;QAC9C,sBAAsB;QACtB,UAAU,EAAE,mBAAQ;KACrB,CAAC;IACF,IAAI,SAAS,IAAI,OAAO,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1D,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IACnC,CAAC;IACD,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACnC,MAAM,CAAC,iBAAiB,GAAG,CAAC,OAAO,EAAE,EAAE,CACrC,OAAO,CAAC,OAAO,iCACV,OAAO,KACV,IAAI,EAAE,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,IAAI,IACrC,CAAC;IACP,CAAC;IACD,IAAI,OAAO,CAAC,qBAAqB,KAAK,SAAS,EAAE,CAAC;QAChD,MAAM,CAAC,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAC/D,CAAC;IACD,IAAI,OAAO,CAAC,qBAAqB,KAAK,SAAS,EAAE,CAAC;QAChD,MAAM,CAAC,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAC/D,CAAC;IACD,IAAI,OAAO,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;QAC7C,MAAM,CAAC,kBAAkB;YACvB,OAAO,CAAC,kBAAsD,CAAC;IACnE,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAhCD,8DAgCC;AASD,SAAgB,iBAAiB;IAG/B,OAAO,SAAS,WAAW;QACzB,IAAI,CAAC,CAAC,UAAU,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC9D,MAAM,IAAI,KAAK,CACb,kEAAkE,CACnE,CAAC;QACJ,CAAC;QACD,OAAO,IAAK,IAAI,CAAC,WAAsB,iCAClC,IAAI,CAAC,OAAO,KACf,KAAK,EAAE,IAAI,EACX,aAAa,EAAE,SAAS,IACf,CAAC;IACd,CAAC,CAAC;AACJ,CAAC;AAfD,8CAeC;AAED,SAAgB,kBAAkB;IAGhC,OAAO,SAAS,YAAY,CAE1B,aAAsB;QAEtB,IAAI,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,UAAU,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC9D,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC5E,CAAC;QACD,OAAO,IAAK,IAAI,CAAC,WAAsB,iCAClC,IAAI,CAAC,OAAO,KACf,aAAa,EACb,KAAK,EAAE,KAAK,IACH,CAAC;IACd,CAAC,CAAC;AACJ,CAAC;AArBD,gDAqBC"}
|
package/lib/index.d.ts
CHANGED
|
@@ -6,3 +6,4 @@ export { ApiClientForgeApiOptions } from "./fetch/createForgeApiFetch";
|
|
|
6
6
|
export { ApiClientForgeApiExternalOptions } from "./fetch/createForgeApiExternalFetch";
|
|
7
7
|
export { ApiClientForgeApiWithProviderOptions } from "./fetch/createForgeApiWithProviderFetch";
|
|
8
8
|
export { ApiClientForgeBridgeJiraOptions, ApiClientForgeBridgeConfluenceOptions, } from "./fetch/createForgeBridgeFetch";
|
|
9
|
+
export { retryOnNetworkAndInternalErrors } from "./retryOnNetworkAndInternalErrors";
|
package/lib/index.js
CHANGED
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.getCommonApiClientOptions = exports.createAsUserMethod = exports.createAsAppMethod = exports.ApiError = void 0;
|
|
3
|
+
exports.retryOnNetworkAndInternalErrors = exports.getCommonApiClientOptions = exports.createAsUserMethod = exports.createAsAppMethod = exports.ApiError = void 0;
|
|
4
4
|
var ApiError_1 = require("./ApiError");
|
|
5
5
|
Object.defineProperty(exports, "ApiError", { enumerable: true, get: function () { return ApiError_1.ApiError; } });
|
|
6
6
|
var fetch_1 = require("./fetch");
|
|
7
7
|
Object.defineProperty(exports, "createAsAppMethod", { enumerable: true, get: function () { return fetch_1.createAsAppMethod; } });
|
|
8
8
|
Object.defineProperty(exports, "createAsUserMethod", { enumerable: true, get: function () { return fetch_1.createAsUserMethod; } });
|
|
9
9
|
Object.defineProperty(exports, "getCommonApiClientOptions", { enumerable: true, get: function () { return fetch_1.getCommonApiClientOptions; } });
|
|
10
|
+
var retryOnNetworkAndInternalErrors_1 = require("./retryOnNetworkAndInternalErrors");
|
|
11
|
+
Object.defineProperty(exports, "retryOnNetworkAndInternalErrors", { enumerable: true, get: function () { return retryOnNetworkAndInternalErrors_1.retryOnNetworkAndInternalErrors; } });
|
|
10
12
|
//# sourceMappingURL=index.js.map
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AACjB,iCAKiB;AAJf,0GAAA,iBAAiB,OAAA;AACjB,2GAAA,kBAAkB,OAAA;AAClB,kHAAA,yBAAyB,OAAA"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AACjB,iCAKiB;AAJf,0GAAA,iBAAiB,OAAA;AACjB,2GAAA,kBAAkB,OAAA;AAClB,kHAAA,yBAAyB,OAAA;AAY3B,qFAAoF;AAA3E,kJAAA,+BAA+B,OAAA"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.retryOnNetworkAndInternalErrors = void 0;
|
|
4
|
+
const ApiError_1 = require("./ApiError");
|
|
5
|
+
/**
|
|
6
|
+
* An implementation of the shouldRetryOnError function that retries on network and internal errors.
|
|
7
|
+
*/
|
|
8
|
+
function retryOnNetworkAndInternalErrors(error, attemptNumber) {
|
|
9
|
+
if (!(error instanceof ApiError_1.ApiError)) {
|
|
10
|
+
return false;
|
|
11
|
+
}
|
|
12
|
+
if (attemptNumber >= 3) {
|
|
13
|
+
return false;
|
|
14
|
+
}
|
|
15
|
+
return (!error.response ||
|
|
16
|
+
(error.response.status >= 500 && error.response.status < 600));
|
|
17
|
+
}
|
|
18
|
+
exports.retryOnNetworkAndInternalErrors = retryOnNetworkAndInternalErrors;
|
|
19
|
+
//# sourceMappingURL=retryOnNetworkAndInternalErrors.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"retryOnNetworkAndInternalErrors.js","sourceRoot":"","sources":["../src/retryOnNetworkAndInternalErrors.ts"],"names":[],"mappings":";;;AAAA,yCAAsC;AAEtC;;GAEG;AACH,SAAgB,+BAA+B,CAC7C,KAAY,EACZ,aAAqB;IAErB,IAAI,CAAC,CAAC,KAAK,YAAY,mBAAQ,CAAC,EAAE,CAAC;QACjC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,aAAa,IAAI,CAAC,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,CACL,CAAC,KAAK,CAAC,QAAQ;QACf,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC,CAC9D,CAAC;AACJ,CAAC;AAdD,0EAcC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@resolution/atlassian-api-common",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.13.0",
|
|
4
4
|
"description": "Shared code across different implementations of Atlassian API Clients.",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -43,5 +43,5 @@
|
|
|
43
43
|
"publishConfig": {
|
|
44
44
|
"access": "public"
|
|
45
45
|
},
|
|
46
|
-
"gitHead": "
|
|
46
|
+
"gitHead": "efae5401ad76d0470aad8744f460e11dce3083b5"
|
|
47
47
|
}
|