@resolution/atlassian-api-common 0.13.4 → 0.14.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.
@@ -1,4 +1,4 @@
1
- import type { CommonHttpClientFetchRequest, CommonHttpClientOptions } from "api-typescript-generator/openapi-client";
1
+ import type { CommonHttpClientFetchRequest, CommonHttpClientFetchResponse, CommonHttpClientOptions } from "api-typescript-generator/openapi-client";
2
2
  import { ApiError } from "../ApiError";
3
3
  import type { AtlassianProductName } from "./common";
4
4
  import { type ApiClientAceOptions } from "./createAceFetch";
@@ -32,6 +32,10 @@ export type ApiClientOptions<T extends AllOpenApiClientOptions> = T & {
32
32
  */
33
33
  shouldRetryOnError?: (error: ApiError, attemptNumber: number) => Promise<boolean> | boolean;
34
34
  };
35
+ /**
36
+ * Error format description: https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#status-codes
37
+ */
38
+ export declare function formatHttpErrorMessage(response: CommonHttpClientFetchResponse, request: CommonHttpClientFetchRequest): string;
35
39
  export declare function getCommonApiClientOptions<TOptions extends AllOpenApiClientOptions>(options: ApiClientOptions<TOptions> & {
36
40
  basePath?: string;
37
41
  }, productName: AtlassianProductName): Partial<CommonHttpClientOptions>;
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.createAsUserMethod = exports.createAsAppMethod = exports.getCommonApiClientOptions = void 0;
3
+ exports.createAsUserMethod = exports.createAsAppMethod = exports.getCommonApiClientOptions = exports.formatHttpErrorMessage = void 0;
4
4
  const ApiError_1 = require("../ApiError");
5
5
  const createAceFetch_1 = require("./createAceFetch");
6
6
  const createApFetch_1 = require("./createApFetch");
@@ -61,6 +61,7 @@ function formatHttpErrorMessage(response, request) {
61
61
  const url = new URL(response.url);
62
62
  return `HTTP Error ${request.method} ${url.pathname} ${response.status} (${response.statusText})${additionalDetails}`;
63
63
  }
64
+ exports.formatHttpErrorMessage = formatHttpErrorMessage;
64
65
  function getCommonApiClientOptions(options, productName) {
65
66
  const result = {
66
67
  fetch: getFetchByOptions(options, productName),
@@ -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;AAuClC;;;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"}
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;AAuClC;;;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,SAAgB,sBAAsB,CACpC,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;AA9BD,wDA8BC;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
@@ -1,5 +1,5 @@
1
1
  export { ApiError } from "./ApiError";
2
- export { createAsAppMethod, createAsUserMethod, getCommonApiClientOptions, type ApiClientOptions, } from "./fetch";
2
+ export { createAsAppMethod, createAsUserMethod, getCommonApiClientOptions, formatHttpErrorMessage, type ApiClientOptions, } 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,12 +1,13 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.retryOnNetworkAndInternalErrors = exports.getCommonApiClientOptions = exports.createAsUserMethod = exports.createAsAppMethod = exports.ApiError = void 0;
3
+ exports.retryOnNetworkAndInternalErrors = exports.formatHttpErrorMessage = 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
+ Object.defineProperty(exports, "formatHttpErrorMessage", { enumerable: true, get: function () { return fetch_1.formatHttpErrorMessage; } });
10
11
  var retryOnNetworkAndInternalErrors_1 = require("./retryOnNetworkAndInternalErrors");
11
12
  Object.defineProperty(exports, "retryOnNetworkAndInternalErrors", { enumerable: true, get: function () { return retryOnNetworkAndInternalErrors_1.retryOnNetworkAndInternalErrors; } });
12
13
  //# 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;AAY3B,qFAAoF;AAA3E,kJAAA,+BAA+B,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AACjB,iCAMiB;AALf,0GAAA,iBAAiB,OAAA;AACjB,2GAAA,kBAAkB,OAAA;AAClB,kHAAA,yBAAyB,OAAA;AACzB,+GAAA,sBAAsB,OAAA;AAYxB,qFAAoF;AAA3E,kJAAA,+BAA+B,OAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@resolution/atlassian-api-common",
3
- "version": "0.13.4",
3
+ "version": "0.14.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": "660c2bd8932c8efd427235c1e0b8955a234206b8"
46
+ "gitHead": "d6ac4b9c34c1f89ecd7ad433bc9be213b45fa23e"
47
47
  }