@resolution/atlassian-api-common 0.5.4 → 0.5.6

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 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.5.6](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.5.5...v0.5.6) (2024-07-05)
7
+
8
+
9
+ ### Bug Fixes
10
+
11
+ * confluence api constructor options, improve docs ([194e14f](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/194e14fe351b6a17a442105f6b27931ee7e6cf27))
12
+
13
+
14
+
15
+
16
+
6
17
  ## [0.5.4](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.5.3...v0.5.4) (2024-07-02)
7
18
 
8
19
 
@@ -2,6 +2,8 @@ import type { CommonHttpClientFetchRequest, CommonHttpClientFetchResponse } from
2
2
  import type { AddOn } from "atlassian-connect-express";
3
3
  /**
4
4
  * ACE-based API client options.
5
+ *
6
+ * @category API Client Constructor Options
5
7
  */
6
8
  export interface ApiClientAceOptions {
7
9
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"createAceFetch.js","sourceRoot":"","sources":["../../src/fetch/createAceFetch.ts"],"names":[],"mappings":";;;AAOA,qCAAiD;AAoBjD;;GAEG;AACH,SAAgB,cAAc,CAAC,EAC7B,GAAG,EACH,SAAS,EACT,aAAa,GACO;IACpB,IAAI,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC;IAC9D,IAAI,aAAa,EAAE,CAAC;QAClB,UAAU,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;IAC3D,CAAC;IAED,SAAS,WAAW,CAAmB,KAAQ;QAC7C,OAAO,KAAK,CAAC,WAAW,EAAkB,CAAC;IAC7C,CAAC;IAED,SAAS,OAAO,CAAC,MAAc;QAC7B,OAAO,IAAI,IAAI,CAAC;YACd,MAAM,CAAC,MAAM,CAAC,KAAK,CACjB,MAAM,CAAC,UAAU,EACjB,MAAM,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CACtC;SACF,CAAC,CAAC;IACL,CAAC;IAED,OAAO,SAAS,QAAQ,CACtB,GAAQ,EACR,OAAqC;QAErC,MAAM,eAAe,GAAG,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACpD,IAAI,eAAe,KAAK,SAAS,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;YACnE,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,CAAC,MAAM,mBAAmB,CAAC,CAAC;QACxD,CAAC;QAED,MAAM,UAAU,GAAG,eAAe,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,eAAe,CAAC;QAE1E,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,cAAc,GAClB,EAAE,CAAC;YAEL,IACE,OAAO,CAAC,OAAO,CAAC,8BAAqB,CAAC,KAAK,SAAS;gBACpD,OAAO,CAAC,OAAO,CAAC,8BAAqB,CAAC,CAAC,QAAQ,CAC7C,qBAAqB,CACtB,KAAK,IAAI,EACV,CAAC;gBACD,cAAc,CAAC,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;YAClD,CAAC;iBAAM,CAAC;gBACN,cAAc,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;YACrC,CAAC;YAED,mEAAmE;YACnE,UAAU,CAAC,UAAU,CAAC,+BAElB,GAAG,EAAE,GAAG,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,MAAM,EAAE,EACnC,OAAO,EAAE,OAAO,CAAC,OAAO,IACrB,cAAc,KACjB,cAAc,EAAE,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAC7C,QAAQ,EAAE,IAAI,KAEhB,CACE,KAAwB,EACxB,QAAyB,EACzB,IAAsB,EACtB,EAAE;gBACF,IAAI,KAAK,EAAE,CAAC;oBACV,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC;gBAED,OAAO,CAAC;oBACN,GAAG,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI;oBAC9B,OAAO,EAAE,QAAQ,CAAC,OAAiC;oBACnD,MAAM,EAAE,QAAQ,CAAC,UAAU;oBAC3B,UAAU,EAAE,QAAQ,CAAC,aAAa;oBAClC,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;oBAC9C,EAAE,EAAE,QAAQ,CAAC,UAAU,IAAI,GAAG,IAAI,QAAQ,CAAC,UAAU,GAAG,GAAG;oBAC3D,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,IAAc,CAAC,EAAE;iBACtD,CAAC,CAAC;YACL,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAhFD,wCAgFC"}
1
+ {"version":3,"file":"createAceFetch.js","sourceRoot":"","sources":["../../src/fetch/createAceFetch.ts"],"names":[],"mappings":";;;AAOA,qCAAiD;AAsBjD;;GAEG;AACH,SAAgB,cAAc,CAAC,EAC7B,GAAG,EACH,SAAS,EACT,aAAa,GACO;IACpB,IAAI,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC;IAC9D,IAAI,aAAa,EAAE,CAAC;QAClB,UAAU,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;IAC3D,CAAC;IAED,SAAS,WAAW,CAAmB,KAAQ;QAC7C,OAAO,KAAK,CAAC,WAAW,EAAkB,CAAC;IAC7C,CAAC;IAED,SAAS,OAAO,CAAC,MAAc;QAC7B,OAAO,IAAI,IAAI,CAAC;YACd,MAAM,CAAC,MAAM,CAAC,KAAK,CACjB,MAAM,CAAC,UAAU,EACjB,MAAM,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CACtC;SACF,CAAC,CAAC;IACL,CAAC;IAED,OAAO,SAAS,QAAQ,CACtB,GAAQ,EACR,OAAqC;QAErC,MAAM,eAAe,GAAG,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACpD,IAAI,eAAe,KAAK,SAAS,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;YACnE,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,CAAC,MAAM,mBAAmB,CAAC,CAAC;QACxD,CAAC;QAED,MAAM,UAAU,GAAG,eAAe,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,eAAe,CAAC;QAE1E,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,cAAc,GAClB,EAAE,CAAC;YAEL,IACE,OAAO,CAAC,OAAO,CAAC,8BAAqB,CAAC,KAAK,SAAS;gBACpD,OAAO,CAAC,OAAO,CAAC,8BAAqB,CAAC,CAAC,QAAQ,CAC7C,qBAAqB,CACtB,KAAK,IAAI,EACV,CAAC;gBACD,cAAc,CAAC,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;YAClD,CAAC;iBAAM,CAAC;gBACN,cAAc,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;YACrC,CAAC;YAED,mEAAmE;YACnE,UAAU,CAAC,UAAU,CAAC,+BAElB,GAAG,EAAE,GAAG,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,MAAM,EAAE,EACnC,OAAO,EAAE,OAAO,CAAC,OAAO,IACrB,cAAc,KACjB,cAAc,EAAE,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAC7C,QAAQ,EAAE,IAAI,KAEhB,CACE,KAAwB,EACxB,QAAyB,EACzB,IAAsB,EACtB,EAAE;gBACF,IAAI,KAAK,EAAE,CAAC;oBACV,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC;gBAED,OAAO,CAAC;oBACN,GAAG,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI;oBAC9B,OAAO,EAAE,QAAQ,CAAC,OAAiC;oBACnD,MAAM,EAAE,QAAQ,CAAC,UAAU;oBAC3B,UAAU,EAAE,QAAQ,CAAC,aAAa;oBAClC,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;oBAC9C,EAAE,EAAE,QAAQ,CAAC,UAAU,IAAI,GAAG,IAAI,QAAQ,CAAC,UAAU,GAAG,GAAG;oBAC3D,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,IAAc,CAAC,EAAE;iBACtD,CAAC,CAAC;YACL,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAhFD,wCAgFC"}
@@ -1,6 +1,8 @@
1
1
  import type { CommonHttpClientFetchRequest, CommonHttpClientFetchResponse } from "api-typescript-generator/openapi-client";
2
2
  /**
3
3
  * AP-based API client options.
4
+ *
5
+ * @category API Client Constructor Options
4
6
  */
5
7
  export interface ApiClientApOptions {
6
8
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"createApFetch.js","sourceRoot":"","sources":["../../src/fetch/createApFetch.ts"],"names":[],"mappings":";;;;;;;;;;;;AAMA,qCAAkE;AAYlE;;GAEG;AACH,SAAgB,aAAa,CAAC,EAAE,EAAE,EAAsB;IACtD,SAAS,cAAc,CACrB,GAAmB;QAEnB,OAAO,MAAM,CAAC,WAAW,CACvB,GAAG;aACA,qBAAqB,EAAE;aACvB,KAAK,CAAC,MAAM,CAAC;aACb,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aACpB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;aACnC,MAAM,CAAC,CAAC,KAAK,EAA6B,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;aAC5D,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;aACxB,GAAG,CACF,CAAC,UAAU,EAAE,EAAE,CACb;YACE,UAAU,CAAC,WAAW,EAAE;YACxB,GAAG,CAAC,iBAAiB,CAAC,UAAU,CAAC;SACzB,CACb;aACA,MAAM,CACL,CAAC,WAAW,EAAmC,EAAE,CAC/C,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAC1B,CACJ,CAAC;IACJ,CAAC;IAED,SAAS,aAAa,CAAC,EACrB,GAAG,EACH,IAAI,EACJ,OAAO,GAKR;QACC,MAAM,OAAO,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;QACpC,OAAO;YACL,GAAG,EAAE,GAAG,CAAC,WAAW;YACpB,OAAO;YACP,MAAM,EAAE,GAAG,CAAC,MAAM;YAClB,UAAU,EAAE,GAAG,CAAC,UAAU;YAC1B,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;YAC9C,EAAE,EAAE,GAAG,CAAC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,GAAG,GAAG;YACzC,IAAI,EACF,OAAO,CAAC,8BAAqB,CAAC,KAAK,SAAS;gBAC5C,IAAA,wBAAe,EAAC,OAAO,CAAC,8BAAqB,CAAC,CAAC;gBAC7C,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE;gBAC9D,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE;SAC/C,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;IACtC,OAAO,SAAe,OAAO,CAC3B,GAAQ,EACR,OAAqC;;YAErC,IAAI,CAAC;gBACH,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC;oBACrC,GAAG,EAAE,GAAG,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,MAAM,EAAE;oBACnC,IAAI,EAAE,OAAO,CAAC,MAAM;oBACpB,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,8BAAqB,CAAC;oBACnD,IAAI,EAAE,OAAO,CAAC,IAAI;oBAClB,OAAO,EAAE,OAAO,CAAC,OAAuC;oBACxD,KAAK,EAAE,OAAO,CAAC,KAAK,KAAK,aAAa;oBACtC,gBAAgB,EAAE,IAAI;iBACvB,CAAC,CAAC;gBACH,OAAO,aAAa,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;YAC/C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IACE,OAAO,KAAK,KAAK,QAAQ;oBACzB,KAAK;oBACL,KAAK,IAAI,KAAK;oBACd,KAAK,IAAI,KAAK,EACd,CAAC;oBACD,uDAAuD;oBACvD,8KAA8K;oBAC9K,uEAAuE;oBACvE,4KAA4K;oBAC5K,4KAA4K;oBAC5K,4KAA4K;oBAC5K,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,KAGpB,CAAC;oBACF,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;wBACzB,MAAM,GAAG,CAAC;oBACZ,CAAC;oBACD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;wBAC5B,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;oBACvB,CAAC;oBACD,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBACrB,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;oBAC3C,CAAC;oBACD,OAAO,aAAa,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;gBACpD,CAAC;gBACD,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;KAAA,CAAC;AACJ,CAAC;AAlGD,sCAkGC"}
1
+ {"version":3,"file":"createApFetch.js","sourceRoot":"","sources":["../../src/fetch/createApFetch.ts"],"names":[],"mappings":";;;;;;;;;;;;AAMA,qCAAkE;AAclE;;GAEG;AACH,SAAgB,aAAa,CAAC,EAAE,EAAE,EAAsB;IACtD,SAAS,cAAc,CACrB,GAAmB;QAEnB,OAAO,MAAM,CAAC,WAAW,CACvB,GAAG;aACA,qBAAqB,EAAE;aACvB,KAAK,CAAC,MAAM,CAAC;aACb,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aACpB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;aACnC,MAAM,CAAC,CAAC,KAAK,EAA6B,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;aAC5D,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;aACxB,GAAG,CACF,CAAC,UAAU,EAAE,EAAE,CACb;YACE,UAAU,CAAC,WAAW,EAAE;YACxB,GAAG,CAAC,iBAAiB,CAAC,UAAU,CAAC;SACzB,CACb;aACA,MAAM,CACL,CAAC,WAAW,EAAmC,EAAE,CAC/C,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAC1B,CACJ,CAAC;IACJ,CAAC;IAED,SAAS,aAAa,CAAC,EACrB,GAAG,EACH,IAAI,EACJ,OAAO,GAKR;QACC,MAAM,OAAO,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;QACpC,OAAO;YACL,GAAG,EAAE,GAAG,CAAC,WAAW;YACpB,OAAO;YACP,MAAM,EAAE,GAAG,CAAC,MAAM;YAClB,UAAU,EAAE,GAAG,CAAC,UAAU;YAC1B,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;YAC9C,EAAE,EAAE,GAAG,CAAC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,GAAG,GAAG;YACzC,IAAI,EACF,OAAO,CAAC,8BAAqB,CAAC,KAAK,SAAS;gBAC5C,IAAA,wBAAe,EAAC,OAAO,CAAC,8BAAqB,CAAC,CAAC;gBAC7C,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE;gBAC9D,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE;SAC/C,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;IACtC,OAAO,SAAe,OAAO,CAC3B,GAAQ,EACR,OAAqC;;YAErC,IAAI,CAAC;gBACH,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC;oBACrC,GAAG,EAAE,GAAG,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,MAAM,EAAE;oBACnC,IAAI,EAAE,OAAO,CAAC,MAAM;oBACpB,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,8BAAqB,CAAC;oBACnD,IAAI,EAAE,OAAO,CAAC,IAAI;oBAClB,OAAO,EAAE,OAAO,CAAC,OAAuC;oBACxD,KAAK,EAAE,OAAO,CAAC,KAAK,KAAK,aAAa;oBACtC,gBAAgB,EAAE,IAAI;iBACvB,CAAC,CAAC;gBACH,OAAO,aAAa,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;YAC/C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IACE,OAAO,KAAK,KAAK,QAAQ;oBACzB,KAAK;oBACL,KAAK,IAAI,KAAK;oBACd,KAAK,IAAI,KAAK,EACd,CAAC;oBACD,uDAAuD;oBACvD,8KAA8K;oBAC9K,uEAAuE;oBACvE,4KAA4K;oBAC5K,4KAA4K;oBAC5K,4KAA4K;oBAC5K,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,KAGpB,CAAC;oBACF,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;wBACzB,MAAM,GAAG,CAAC;oBACZ,CAAC;oBACD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;wBAC5B,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;oBACvB,CAAC;oBACD,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBACrB,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;oBAC3C,CAAC;oBACD,OAAO,aAAa,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;gBACpD,CAAC;gBACD,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;KAAA,CAAC;AACJ,CAAC;AAlGD,sCAkGC"}
@@ -2,6 +2,8 @@ import type { fetch as externalFetch } from "@forge/api";
2
2
  import type { CommonHttpClientFetchRequest, CommonHttpClientFetchResponse } from "api-typescript-generator/openapi-client";
3
3
  /**
4
4
  * Options for creating a Forge API fetch function.
5
+ *
6
+ * @category API Client Constructor Options
5
7
  */
6
8
  export interface ApiClientForgeApiExternalOptions {
7
9
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"createForgeApiExternalFetch.js","sourceRoot":"","sources":["../../src/fetch/createForgeApiExternalFetch.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAQA,qCAAkE;AAgBlE,SAAgB,2BAA2B,CAAC,EAC1C,KAAK,GAC4B;IACjC,OAAO,SAAe,gBAAgB,CACpC,GAAQ,EACR,OAAqC;;;YAErC,MAAW,YAAY,UAAK,OAAO,EAA7B,EAAmB,CAAU,CAAC;YACpC,MAAM,WAAW,GAAgB,YAAY,CAAC;YAC9C,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,kCACtC,WAAW,KACd,OAAO,EAAE,OAAO,CAAC,OAAiC;gBAClD,mCAAmC;gBACnC,IAAI,EAAE,OAAO,CAAC,IAAa,IAC3B,CAAC;YACH,MAAM,IAAI,GAAsC,IAAA,wBAAe,EAC7D,MAAA,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,8BAAqB,CAAC,mCAAI,EAAE,CAClD;gBACC,CAAC,CAAC;oBACE,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE;iBAC5B;gBACH,CAAC,CAAC;oBACE,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,IAAI,IAAI,CAAC,CAAC,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;iBAC/C,CAAC;YACN,MAAM,OAAO,GAAoC,EAAE,CAAC;YACpD,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBACtC,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACvB,CAAC,CAAC,CAAC;YACH,IACE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,IAAI;gBAC3C,cAAc,IAAI,QAAQ,CAAC,OAAO,EAClC,CAAC;gBACD,OAAO,CAAC,YAAY,CAAC,GACnB,QAAQ,CAAC,OAGV,CAAC,YAAY,EAAE,CAAC;YACnB,CAAC;YACD,OAAO;gBACL,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,IAAI;gBACJ,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE;gBACnB,OAAO;gBACP,EAAE,EAAE,QAAQ,CAAC,EAAE;gBACf,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;aAC/C,CAAC;;KACH,CAAC;AACJ,CAAC;AAlDD,kEAkDC"}
1
+ {"version":3,"file":"createForgeApiExternalFetch.js","sourceRoot":"","sources":["../../src/fetch/createForgeApiExternalFetch.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAQA,qCAAkE;AAkBlE,SAAgB,2BAA2B,CAAC,EAC1C,KAAK,GAC4B;IACjC,OAAO,SAAe,gBAAgB,CACpC,GAAQ,EACR,OAAqC;;;YAErC,MAAW,YAAY,UAAK,OAAO,EAA7B,EAAmB,CAAU,CAAC;YACpC,MAAM,WAAW,GAAgB,YAAY,CAAC;YAC9C,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,kCACtC,WAAW,KACd,OAAO,EAAE,OAAO,CAAC,OAAiC;gBAClD,mCAAmC;gBACnC,IAAI,EAAE,OAAO,CAAC,IAAa,IAC3B,CAAC;YACH,MAAM,IAAI,GAAsC,IAAA,wBAAe,EAC7D,MAAA,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,8BAAqB,CAAC,mCAAI,EAAE,CAClD;gBACC,CAAC,CAAC;oBACE,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE;iBAC5B;gBACH,CAAC,CAAC;oBACE,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,IAAI,IAAI,CAAC,CAAC,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;iBAC/C,CAAC;YACN,MAAM,OAAO,GAAoC,EAAE,CAAC;YACpD,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBACtC,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACvB,CAAC,CAAC,CAAC;YACH,IACE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,IAAI;gBAC3C,cAAc,IAAI,QAAQ,CAAC,OAAO,EAClC,CAAC;gBACD,OAAO,CAAC,YAAY,CAAC,GACnB,QAAQ,CAAC,OAGV,CAAC,YAAY,EAAE,CAAC;YACnB,CAAC;YACD,OAAO;gBACL,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,IAAI;gBACJ,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE;gBACnB,OAAO;gBACP,EAAE,EAAE,QAAQ,CAAC,EAAE;gBACf,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;aAC/C,CAAC;;KACH,CAAC;AACJ,CAAC;AAlDD,kEAkDC"}
@@ -2,6 +2,8 @@ import type * as ForgeApi from "@forge/api";
2
2
  import type { CommonHttpClientFetchRequest, CommonHttpClientFetchResponse } from "api-typescript-generator/openapi-client";
3
3
  /**
4
4
  * Forge-based API client options.
5
+ *
6
+ * @category API Client Constructor Options
5
7
  */
6
8
  export interface ApiClientForgeApiOptions {
7
9
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"createForgeApiFetch.js","sourceRoot":"","sources":["../../src/fetch/createForgeApiFetch.ts"],"names":[],"mappings":";;;;;;;;;;;;AAQA,qCAAkE;AAgBlE;;GAEG;AACH,SAAgB,mBAAmB,CAAC,EAClC,QAAQ,EACR,KAAK,GACoB;IACzB,OAAO,SAAe,aAAa,CACjC,GAAQ,EACR,OAAqC;;;YAErC,MAAM,QAAQ,GAAG,MAAM,CACrB,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,CAC7C,CAAC,WAAW,CAAC,QAAQ,CAAC,kBAAkB,CAAC,GAAG,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,kCACpE,OAAO;gBACV,yGAAyG;gBACzG,IAAI,EAAE,OAAO,CAAC,IAAa,IAC3B,CAAC;YACH,MAAM,IAAI,GAAsC,IAAA,wBAAe,EAC7D,MAAA,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,8BAAqB,CAAC,mCAAI,EAAE,CAClD;gBACC,CAAC,CAAC;oBACE,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE;iBAC5B;gBACH,CAAC,CAAC;oBACE,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,IAAI,IAAI,CAAC,CAAC,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;iBAC/C,CAAC;YACN,MAAM,OAAO,GAAoC,EAAE,CAAC;YACpD,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBACtC,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACvB,CAAC,CAAC,CAAC;YACH,IACE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,IAAI;gBAC3C,cAAc,IAAI,QAAQ,CAAC,OAAO,EAClC,CAAC;gBACD,OAAO,CAAC,YAAY,CAAC,GACnB,QAAQ,CAAC,OAGV,CAAC,YAAY,EAAE,CAAC;YACnB,CAAC;YACD,OAAO;gBACL,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,IAAI;gBACJ,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE;gBACnB,OAAO;gBACP,EAAE,EAAE,QAAQ,CAAC,EAAE;gBACf,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;aAC/C,CAAC;;KACH,CAAC;AACJ,CAAC;AAlDD,kDAkDC"}
1
+ {"version":3,"file":"createForgeApiFetch.js","sourceRoot":"","sources":["../../src/fetch/createForgeApiFetch.ts"],"names":[],"mappings":";;;;;;;;;;;;AAQA,qCAAkE;AAkBlE;;GAEG;AACH,SAAgB,mBAAmB,CAAC,EAClC,QAAQ,EACR,KAAK,GACoB;IACzB,OAAO,SAAe,aAAa,CACjC,GAAQ,EACR,OAAqC;;;YAErC,MAAM,QAAQ,GAAG,MAAM,CACrB,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,CAC7C,CAAC,WAAW,CAAC,QAAQ,CAAC,kBAAkB,CAAC,GAAG,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,kCACpE,OAAO;gBACV,yGAAyG;gBACzG,IAAI,EAAE,OAAO,CAAC,IAAa,IAC3B,CAAC;YACH,MAAM,IAAI,GAAsC,IAAA,wBAAe,EAC7D,MAAA,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,8BAAqB,CAAC,mCAAI,EAAE,CAClD;gBACC,CAAC,CAAC;oBACE,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE;iBAC5B;gBACH,CAAC,CAAC;oBACE,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,IAAI,IAAI,CAAC,CAAC,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;iBAC/C,CAAC;YACN,MAAM,OAAO,GAAoC,EAAE,CAAC;YACpD,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBACtC,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACvB,CAAC,CAAC,CAAC;YACH,IACE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,IAAI;gBAC3C,cAAc,IAAI,QAAQ,CAAC,OAAO,EAClC,CAAC;gBACD,OAAO,CAAC,YAAY,CAAC,GACnB,QAAQ,CAAC,OAGV,CAAC,YAAY,EAAE,CAAC;YACnB,CAAC;YACD,OAAO;gBACL,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,IAAI;gBACJ,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE;gBACnB,OAAO;gBACP,EAAE,EAAE,QAAQ,CAAC,EAAE;gBACf,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;aAC/C,CAAC;;KACH,CAAC;AACJ,CAAC;AAlDD,kDAkDC"}
@@ -1,10 +1,20 @@
1
1
  import type { requestConfluence, requestJira } from "@forge/bridge";
2
2
  import type { CommonHttpClientFetchRequest, CommonHttpClientFetchResponse } from "api-typescript-generator/openapi-client";
3
- export type JiraApiClientForgeBridgeOptions = {
3
+ /**
4
+ * Forge-based frontend API client options for JIRA.
5
+ *
6
+ * @category API Client Constructor Options
7
+ */
8
+ export type ApiClientForgeBridgeJiraOptions = {
4
9
  requestJira: typeof requestJira;
5
10
  };
6
- export type ConfluenceApiClientForgeBridgeOptions = {
11
+ /**
12
+ * Forge-based frontend API client options for Confluence.
13
+ *
14
+ * @category API Client Constructor Options
15
+ */
16
+ export type ApiClientForgeBridgeConfluenceOptions = {
7
17
  requestConfluence: typeof requestConfluence;
8
18
  };
9
- export declare const createJiraForgeBridgeFetch: ({ requestJira, }: JiraApiClientForgeBridgeOptions) => (url: URL, request: CommonHttpClientFetchRequest) => Promise<CommonHttpClientFetchResponse>;
10
- export declare const createConfluenceForgeBridgeFetch: ({ requestConfluence, }: ConfluenceApiClientForgeBridgeOptions) => (url: URL, request: CommonHttpClientFetchRequest) => Promise<CommonHttpClientFetchResponse>;
19
+ export declare const createJiraForgeBridgeFetch: ({ requestJira, }: ApiClientForgeBridgeJiraOptions) => (url: URL, request: CommonHttpClientFetchRequest) => Promise<CommonHttpClientFetchResponse>;
20
+ export declare const createConfluenceForgeBridgeFetch: ({ requestConfluence, }: ApiClientForgeBridgeConfluenceOptions) => (url: URL, request: CommonHttpClientFetchRequest) => Promise<CommonHttpClientFetchResponse>;
@@ -1 +1 @@
1
- {"version":3,"file":"createForgeBridgeFetch.js","sourceRoot":"","sources":["../../src/fetch/createForgeBridgeFetch.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAQA,0CAAwE;AAUjE,MAAM,0BAA0B,GAAG,CAAC,EACzC,WAAW,GACqB,EAAE,EAAE,CACpC,sBAAsB,CAAC,EAAE,aAAa,EAAE,WAAW,EAAE,CAAC,CAAC;AAH5C,QAAA,0BAA0B,8BAGkB;AAElD,MAAM,gCAAgC,GAAG,CAAC,EAC/C,iBAAiB,GACqB,EAAE,EAAE,CAC1C,sBAAsB,CAAC,EAAE,aAAa,EAAE,iBAAiB,EAAE,CAAC,CAAC;AAHlD,QAAA,gCAAgC,oCAGkB;AAQ/D,SAAS,sBAAsB,CAAC,EAC9B,aAAa,GACe;IAC5B,OAAO,SAAe,gBAAgB,CACpC,GAAQ,EACR,OAAqC;;;YAErC,MAAW,YAAY,UAAK,OAAO,EAA7B,EAAmB,CAAU,CAAC;YACpC,MAAM,WAAW,GAAgB,YAAY,CAAC;YAC9C,MAAM,QAAQ,GAAG,MAAM,aAAa,CAClC,GAAG,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,MAAM,EAAE,EAC9B,WAAW,CACZ,CAAC;YACF,MAAM,IAAI,GAAsC,IAAA,uBAAe,EAC7D,MAAA,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,6BAAqB,CAAC,mCAAI,EAAE,CAClD;gBACC,CAAC,CAAC;oBACE,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE;iBAC5B;gBACH,CAAC,CAAC;oBACE,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE;iBAC5B,CAAC;YACN,MAAM,OAAO,GAAoC,EAAE,CAAC;YACpD,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBACtC,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACvB,CAAC,CAAC,CAAC;YACH,IACE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,IAAI;gBAC3C,cAAc,IAAI,QAAQ,CAAC,OAAO,EAClC,CAAC;gBACD,OAAO,CAAC,YAAY,CAAC,GACnB,QAAQ,CAAC,OAGV,CAAC,YAAY,EAAE,CAAC;YACnB,CAAC;YACD,OAAO;gBACL,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,IAAI;gBACJ,GAAG,EAAE,QAAQ,CAAC,GAAG;gBACjB,OAAO;gBACP,EAAE,EAAE,QAAQ,CAAC,EAAE;gBACf,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;aAC/C,CAAC;;KACH,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"createForgeBridgeFetch.js","sourceRoot":"","sources":["../../src/fetch/createForgeBridgeFetch.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAQA,0CAAwE;AAoBjE,MAAM,0BAA0B,GAAG,CAAC,EACzC,WAAW,GACqB,EAAE,EAAE,CACpC,sBAAsB,CAAC,EAAE,aAAa,EAAE,WAAW,EAAE,CAAC,CAAC;AAH5C,QAAA,0BAA0B,8BAGkB;AAElD,MAAM,gCAAgC,GAAG,CAAC,EAC/C,iBAAiB,GACqB,EAAE,EAAE,CAC1C,sBAAsB,CAAC,EAAE,aAAa,EAAE,iBAAiB,EAAE,CAAC,CAAC;AAHlD,QAAA,gCAAgC,oCAGkB;AAQ/D,SAAS,sBAAsB,CAAC,EAC9B,aAAa,GACe;IAC5B,OAAO,SAAe,gBAAgB,CACpC,GAAQ,EACR,OAAqC;;;YAErC,MAAW,YAAY,UAAK,OAAO,EAA7B,EAAmB,CAAU,CAAC;YACpC,MAAM,WAAW,GAAgB,YAAY,CAAC;YAC9C,MAAM,QAAQ,GAAG,MAAM,aAAa,CAClC,GAAG,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,MAAM,EAAE,EAC9B,WAAW,CACZ,CAAC;YACF,MAAM,IAAI,GAAsC,IAAA,uBAAe,EAC7D,MAAA,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,6BAAqB,CAAC,mCAAI,EAAE,CAClD;gBACC,CAAC,CAAC;oBACE,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE;iBAC5B;gBACH,CAAC,CAAC;oBACE,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE;iBAC5B,CAAC;YACN,MAAM,OAAO,GAAoC,EAAE,CAAC;YACpD,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBACtC,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACvB,CAAC,CAAC,CAAC;YACH,IACE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,IAAI;gBAC3C,cAAc,IAAI,QAAQ,CAAC,OAAO,EAClC,CAAC;gBACD,OAAO,CAAC,YAAY,CAAC,GACnB,QAAQ,CAAC,OAGV,CAAC,YAAY,EAAE,CAAC;YACnB,CAAC;YACD,OAAO;gBACL,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,IAAI;gBACJ,GAAG,EAAE,QAAQ,CAAC,GAAG;gBACjB,OAAO;gBACP,EAAE,EAAE,QAAQ,CAAC,EAAE;gBACf,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;aAC/C,CAAC;;KACH,CAAC;AACJ,CAAC"}
@@ -3,8 +3,8 @@ import { type ApiClientAceOptions } from "./createAceFetch";
3
3
  import { type ApiClientApOptions } from "./createApFetch";
4
4
  import { type ApiClientForgeApiExternalOptions } from "./createForgeApiExternalFetch";
5
5
  import { type ApiClientForgeApiOptions } from "./createForgeApiFetch";
6
- import { type ConfluenceApiClientForgeBridgeOptions, type JiraApiClientForgeBridgeOptions } from "./createForgeBridgeFetch";
7
- export type AllOpenApiClientOptions = ApiClientAceOptions | ApiClientApOptions | ApiClientForgeApiOptions | JiraApiClientForgeBridgeOptions | ConfluenceApiClientForgeBridgeOptions | ApiClientForgeApiExternalOptions;
6
+ import { type ApiClientForgeBridgeConfluenceOptions, type ApiClientForgeBridgeJiraOptions } from "./createForgeBridgeFetch";
7
+ export type AllOpenApiClientOptions = ApiClientAceOptions | ApiClientApOptions | ApiClientForgeApiOptions | ApiClientForgeBridgeJiraOptions | ApiClientForgeBridgeConfluenceOptions | ApiClientForgeApiExternalOptions;
8
8
  export declare function getApiClientOptions<TOptions extends AllOpenApiClientOptions>(options: TOptions & {
9
9
  basePath?: string;
10
10
  }): Partial<CommonHttpClientOptions>;
package/lib/index.d.ts CHANGED
@@ -4,4 +4,4 @@ export { ApiClientAceOptions } from "./fetch/createAceFetch";
4
4
  export { ApiClientApOptions } from "./fetch/createApFetch";
5
5
  export { ApiClientForgeApiOptions } from "./fetch/createForgeApiFetch";
6
6
  export { ApiClientForgeApiExternalOptions } from "./fetch/createForgeApiExternalFetch";
7
- export { JiraApiClientForgeBridgeOptions, ConfluenceApiClientForgeBridgeOptions, } from "./fetch/createForgeBridgeFetch";
7
+ export { ApiClientForgeBridgeJiraOptions, ApiClientForgeBridgeConfluenceOptions, } from "./fetch/createForgeBridgeFetch";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@resolution/atlassian-api-common",
3
- "version": "0.5.4",
3
+ "version": "0.5.6",
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": "d6160f68543aec22f2c70f6d29207d2a7bd6401b"
46
+ "gitHead": "9a70419c9407c741e7eff7c92f67ea0f5690af57"
47
47
  }