@resolution/atlassian-api-common 0.4.1 → 0.4.4

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.
Files changed (6) hide show
  1. package/CHANGELOG.md +97 -0
  2. package/README.md +5 -0
  3. package/lib/fetch/index.d.ts +3 -1
  4. package/lib/fetch/index.js +3 -0
  5. package/lib/fetch/index.js.map +1 -1
  6. package/package.json +5 -3
package/CHANGELOG.md ADDED
@@ -0,0 +1,97 @@
1
+ # Change Log
2
+
3
+ All notable changes to this project will be documented in this file.
4
+ See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
+
6
+ ## [0.4.4](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.4.3...v0.4.4) (2024-06-11)
7
+
8
+
9
+ ### Bug Fixes
10
+
11
+ * add license information to all packages ([d771640](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/d771640b39b4e9b8901a5d93bf8bec77496c957d))
12
+
13
+
14
+
15
+
16
+
17
+ ## [0.4.2](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.4.1...v0.4.2) (2024-06-11)
18
+
19
+
20
+ ### Bug Fixes
21
+
22
+ * add base path to confluence v2 API ([8b1965c](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/8b1965ca84d55dd4bf9600c36006d7d61e8e2fcd))
23
+ * add links to JIRA/Confluence documentation ([64c19b2](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/64c19b2b0d1685c0d64639c6a44314a253ad5529))
24
+
25
+
26
+
27
+
28
+
29
+ ## [0.4.1](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.4.0...v0.4.1) (2024-06-10)
30
+
31
+
32
+ ### Bug Fixes
33
+
34
+ * remove previous file versions when building ([3ff3a0a](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/3ff3a0a8dde8376aa551fd66d0b4ed1ac040ac79))
35
+
36
+
37
+
38
+
39
+
40
+ # 0.4.0 (2024-06-10)
41
+
42
+
43
+ ### Bug Fixes
44
+
45
+ * don't stringify the request body twice ([3252a78](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/3252a78b8bd63b4606c7acb8000b930b8b27218e))
46
+
47
+
48
+ ### Features
49
+
50
+ * first confluence API version ([d580ceb](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/d580cebbab7334f2290c08a307bea5eed8a372a5))
51
+ * first version with JiraSoftwareApi ([e941fd3](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/e941fd304be3eb7fa59232cb13722c81b0a9c202))
52
+ * initial version ([5c1e2d2](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/5c1e2d295fb3efe134ae9629fd6b5f00dc83d151))
53
+ * update confluence api client, set v2 explicitly ([7c7cba2](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/7c7cba22f48e3fb25d532717cf77a912fed2d5ee))
54
+
55
+
56
+
57
+
58
+
59
+ # [0.3.0](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/@resolution/atlassian-api-common@0.2.0...@resolution/atlassian-api-common@0.3.0) (2024-06-07)
60
+
61
+
62
+ ### Features
63
+
64
+ * first confluence API version ([d580ceb](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/d580cebbab7334f2290c08a307bea5eed8a372a5))
65
+
66
+
67
+
68
+
69
+
70
+ # [0.2.0](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/@resolution/atlassian-api-common@0.1.1...@resolution/atlassian-api-common@0.2.0) (2024-06-04)
71
+
72
+
73
+ ### Features
74
+
75
+ * first version with JiraSoftwareApi ([e941fd3](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/e941fd304be3eb7fa59232cb13722c81b0a9c202))
76
+
77
+
78
+
79
+
80
+
81
+ ## [0.1.1](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/@resolution/atlassian-api-common@0.1.0...@resolution/atlassian-api-common@0.1.1) (2024-05-30)
82
+
83
+
84
+ ### Bug Fixes
85
+
86
+ * don't stringify the request body twice ([3252a78](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/3252a78b8bd63b4606c7acb8000b930b8b27218e))
87
+
88
+
89
+
90
+
91
+
92
+ # 0.1.0 (2024-05-28)
93
+
94
+
95
+ ### Features
96
+
97
+ * initial version ([5c1e2d2](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/5c1e2d295fb3efe134ae9629fd6b5f00dc83d151))
package/README.md CHANGED
@@ -3,3 +3,8 @@
3
3
  This package contains common code for Atlassian OpenAPI-based clients.
4
4
 
5
5
  It is not intended to be used directly, but rather as a dependency of other Atlassian OpenAPI-based clients.
6
+
7
+
8
+ ## License
9
+
10
+ This repository is licensed under the [MIT License](./LICENSE.md).
package/lib/fetch/index.d.ts CHANGED
@@ -5,7 +5,9 @@ import { type ApiClientForgeApiExternalOptions } from "./createForgeApiExternalF
5
5
  import { type ApiClientForgeApiOptions } from "./createForgeApiFetch";
6
6
  import { type ConfluenceApiClientForgeBridgeOptions, type JiraApiClientForgeBridgeOptions } from "./createForgeBridgeFetch";
7
7
  export type AllOpenApiClientOptions = ApiClientAceOptions | ApiClientApOptions | ApiClientForgeApiOptions | JiraApiClientForgeBridgeOptions | ConfluenceApiClientForgeBridgeOptions | ApiClientForgeApiExternalOptions;
8
- export declare function getApiClientOptions<TOptions extends AllOpenApiClientOptions>(options: TOptions): Partial<CommonHttpClientOptions>;
8
+ export declare function getApiClientOptions<TOptions extends AllOpenApiClientOptions>(options: TOptions & {
9
+ basePath?: string;
10
+ }): Partial<CommonHttpClientOptions>;
9
11
  type CommonApiClientOptions = ApiClientAceOptions | ApiClientApOptions | ApiClientForgeApiOptions | ApiClientForgeApiExternalOptions;
10
12
  export declare function createAsAppMethod<TClass extends new (options: CommonApiClientOptions) => unknown>(): () => InstanceType<TClass>;
11
13
  export declare function createAsUserMethod<TClass extends new (options: CommonApiClientOptions) => unknown>(): (userAccountId: string) => InstanceType<TClass>;
package/lib/fetch/index.js CHANGED
@@ -65,6 +65,9 @@ function getApiClientOptions(options) {
65
65
  if ("baseUrl" in options && options.baseUrl !== undefined) {
66
66
  result.baseUrl = options.baseUrl;
67
67
  }
68
+ if (options.basePath !== undefined) {
69
+ result.preprocessRequest = (request) => Promise.resolve(Object.assign(Object.assign({}, request), { path: options.basePath + request.path }));
70
+ }
68
71
  return result;
69
72
  }
70
73
  exports.getApiClientOptions = getApiClientOptions;
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;AAUlC;;;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,mBAAmB,CACjC,OAAiB;IAEjB,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,OAAO,MAAM,CAAC;AAChB,CAAC;AAZD,kDAYC;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"}
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;AAUlC;;;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,mBAAmB,CACjC,OAAyC;IAEzC,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,OAAO,MAAM,CAAC;AAChB,CAAC;AAnBD,kDAmBC;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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@resolution/atlassian-api-common",
3
- "version": "0.4.1",
3
+ "version": "0.4.4",
4
4
  "description": "Shared code across different implementations of Atlassian API Clients.",
5
5
  "main": "lib/index.js",
6
6
  "scripts": {
@@ -9,7 +9,9 @@
9
9
  },
10
10
  "files": [
11
11
  "lib",
12
- "README.md"
12
+ "README.md",
13
+ "CHANGELOG.md",
14
+ "LICENSE.md"
13
15
  ],
14
16
  "repository": {
15
17
  "type": "git",
@@ -40,5 +42,5 @@
40
42
  "publishConfig": {
41
43
  "access": "public"
42
44
  },
43
- "gitHead": "4b7d1d7e5223f9f2e2d2d3cc141e972b51b1646d"
45
+ "gitHead": "50f8d6611b4048dff84c30c74887058eabf0466b"
44
46
  }