@resolution/atlassian-api-common 0.5.11 → 0.6.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/CHANGELOG.md +11 -0
- package/lib/fetch/index.d.ts +7 -1
- package/lib/fetch/index.js +7 -3
- package/lib/fetch/index.js.map +1 -1
- package/lib/index.d.ts +1 -1
- package/lib/index.js +2 -2
- package/lib/index.js.map +1 -1
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,17 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# [0.6.0](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.5.11...v0.6.0) (2024-08-19)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Features
|
|
10
|
+
|
|
11
|
+
* ability to customize validation error handling ([3eb0e04](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/3eb0e04d3a72fb787419d1c5b7440563ff1b2fb8))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
6
17
|
## [0.5.11](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.5.10...v0.5.11) (2024-08-12)
|
|
7
18
|
|
|
8
19
|
|
package/lib/fetch/index.d.ts
CHANGED
|
@@ -5,7 +5,13 @@ import { type ApiClientForgeApiExternalOptions } from "./createForgeApiExternalF
|
|
|
5
5
|
import { type ApiClientForgeApiOptions } from "./createForgeApiFetch";
|
|
6
6
|
import { type ApiClientForgeBridgeConfluenceOptions, type ApiClientForgeBridgeJiraOptions } from "./createForgeBridgeFetch";
|
|
7
7
|
export type AllOpenApiClientOptions = ApiClientAceOptions | ApiClientApOptions | ApiClientForgeApiOptions | ApiClientForgeBridgeJiraOptions | ApiClientForgeBridgeConfluenceOptions | ApiClientForgeApiExternalOptions;
|
|
8
|
-
export
|
|
8
|
+
export type ApiClientOptions<T extends AllOpenApiClientOptions> = T & {
|
|
9
|
+
/**
|
|
10
|
+
* Custom validation error handler.
|
|
11
|
+
*/
|
|
12
|
+
handleValidationError?(error: Error): void;
|
|
13
|
+
};
|
|
14
|
+
export declare function getCommonApiClientOptions<TOptions extends AllOpenApiClientOptions>(options: ApiClientOptions<TOptions> & {
|
|
9
15
|
basePath?: string;
|
|
10
16
|
}): Partial<CommonHttpClientOptions>;
|
|
11
17
|
type CommonApiClientOptions = ApiClientAceOptions | ApiClientApOptions | ApiClientForgeApiOptions | ApiClientForgeApiExternalOptions;
|
package/lib/fetch/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.createAsUserMethod = exports.createAsAppMethod = exports.
|
|
3
|
+
exports.createAsUserMethod = exports.createAsAppMethod = exports.getCommonApiClientOptions = void 0;
|
|
4
4
|
const ApiError_1 = require("../ApiError");
|
|
5
5
|
const createAceFetch_1 = require("./createAceFetch");
|
|
6
6
|
const createApFetch_1 = require("./createApFetch");
|
|
@@ -56,7 +56,7 @@ function formatHttpErrorMessage(response) {
|
|
|
56
56
|
}
|
|
57
57
|
return `HTTP Error ${response.status} (${response.statusText})${additionalDetails}`;
|
|
58
58
|
}
|
|
59
|
-
function
|
|
59
|
+
function getCommonApiClientOptions(options) {
|
|
60
60
|
const result = {
|
|
61
61
|
fetch: getFetchByOptions(options),
|
|
62
62
|
formatHttpErrorMessage,
|
|
@@ -68,9 +68,13 @@ function getApiClientOptions(options) {
|
|
|
68
68
|
if (options.basePath !== undefined) {
|
|
69
69
|
result.preprocessRequest = (request) => Promise.resolve(Object.assign(Object.assign({}, request), { path: options.basePath + request.path }));
|
|
70
70
|
}
|
|
71
|
+
if ("handleValidationError" in options &&
|
|
72
|
+
options.handleValidationError !== undefined) {
|
|
73
|
+
result.handleValidationError = options.handleValidationError;
|
|
74
|
+
}
|
|
71
75
|
return result;
|
|
72
76
|
}
|
|
73
|
-
exports.
|
|
77
|
+
exports.getCommonApiClientOptions = getCommonApiClientOptions;
|
|
74
78
|
function createAsAppMethod() {
|
|
75
79
|
return function asAppMethod() {
|
|
76
80
|
if (!("forgeApi" in this.options) && !("ace" in this.options)) {
|
package/lib/fetch/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/fetch/index.ts"],"names":[],"mappings":";;;AAKA,0CAAuC;AACvC,qDAA4E;AAC5E,mDAAyE;AACzE,+EAGuC;AACvC,+DAG+B;AAC/B,qEAKkC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/fetch/index.ts"],"names":[],"mappings":";;;AAKA,0CAAuC;AACvC,qDAA4E;AAC5E,mDAAyE;AACzE,+EAGuC;AACvC,+DAG+B;AAC/B,qEAKkC;AAiBlC;;;GAGG;AACH,SAAS,iBAAiB,CAAC,OAAgC;IACzD,IAAI,UAAU,IAAI,OAAO,EAAE,CAAC;QAC1B,OAAO,IAAA,yCAAmB,EAAC,OAAO,CAAC,CAAC;IACtC,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;IACD,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;AACjD,CAAC;AAED;;GAEG;AACH,SAAS,sBAAsB,CAAC,QAAuC;IACrE,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,OAAO,cAAc,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,IAAI,iBAAiB,EAAE,CAAC;AACtF,CAAC;AAED,SAAgB,yBAAyB,CAGvC,OAA2D;IAE3D,MAAM,MAAM,GAAqC;QAC/C,KAAK,EAAE,iBAAiB,CAAC,OAAO,CAAC;QACjC,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,IACE,uBAAuB,IAAI,OAAO;QAClC,OAAO,CAAC,qBAAqB,KAAK,SAAS,EAC3C,CAAC;QACD,MAAM,CAAC,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAC/D,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AA3BD,8DA2BC;AAQD,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,aAAqB;QAErB,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
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export { ApiError } from "./ApiError";
|
|
2
|
-
export { createAsAppMethod, createAsUserMethod,
|
|
2
|
+
export { createAsAppMethod, createAsUserMethod, getCommonApiClientOptions, } from "./fetch";
|
|
3
3
|
export { ApiClientAceOptions } from "./fetch/createAceFetch";
|
|
4
4
|
export { ApiClientApOptions } from "./fetch/createApFetch";
|
|
5
5
|
export { ApiClientForgeApiOptions } from "./fetch/createForgeApiFetch";
|
package/lib/index.js
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
3
|
+
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
|
-
Object.defineProperty(exports, "
|
|
9
|
+
Object.defineProperty(exports, "getCommonApiClientOptions", { enumerable: true, get: function () { return fetch_1.getCommonApiClientOptions; } });
|
|
10
10
|
//# 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,iCAIiB;AAHf,0GAAA,iBAAiB,OAAA;AACjB,2GAAA,kBAAkB,OAAA;AAClB,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AACjB,iCAIiB;AAHf,0GAAA,iBAAiB,OAAA;AACjB,2GAAA,kBAAkB,OAAA;AAClB,kHAAA,yBAAyB,OAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@resolution/atlassian-api-common",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.6.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": "8f0bfd1da416a986dd8f483369cd1ca6dae5fc1c"
|
|
47
47
|
}
|