confluence.js 1.6.2 → 1.7.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.
Files changed (178) hide show
  1. package/.prettierrc +8 -3
  2. package/CHANGELOG.md +8 -0
  3. package/README.md +16 -0
  4. package/out/api/models/addContentRestriction.d.ts +8 -3
  5. package/out/api/models/appDescriptor.d.ts +6 -3
  6. package/out/api/models/asyncContentBody.d.ts +2 -2
  7. package/out/api/models/attachment.d.ts +1 -0
  8. package/out/api/models/attachmentUpdate.d.ts +1 -1
  9. package/out/api/models/auditRecordCreate.d.ts +6 -2
  10. package/out/api/models/content.d.ts +2 -0
  11. package/out/api/models/contentBlueprintDraft.d.ts +2 -1
  12. package/out/api/models/contentCreate.d.ts +1 -0
  13. package/out/api/models/contentRestrictionUpdate.d.ts +8 -3
  14. package/out/api/models/contentTemplateUpdate.d.ts +4 -1
  15. package/out/api/models/contentUpdate.d.ts +1 -0
  16. package/out/api/models/labeledContentType.js +1 -1
  17. package/out/api/models/labeledContentType.js.map +1 -1
  18. package/out/api/models/lifecycle.d.ts +6 -2
  19. package/out/api/parameters/addLabelsToContent.d.ts +2 -1
  20. package/out/api/parameters/createContent.d.ts +12 -3
  21. package/out/api/parameters/createContent.js +13 -4
  22. package/out/api/parameters/createContent.js.map +1 -1
  23. package/out/api/parameters/createRelationship.d.ts +4 -1
  24. package/out/api/parameters/createUserProperty.d.ts +2 -2
  25. package/out/api/parameters/delete.d.ts +4 -1
  26. package/out/api/parameters/deleteRelationship.d.ts +8 -5
  27. package/out/api/parameters/deleteUserProperty.d.ts +2 -2
  28. package/out/api/parameters/findSourcesForTarget.d.ts +2 -1
  29. package/out/api/parameters/findTargetFromSource.d.ts +2 -1
  30. package/out/api/parameters/getAttachments.d.ts +12 -3
  31. package/out/api/parameters/getAttachments.js +13 -4
  32. package/out/api/parameters/getAttachments.js.map +1 -1
  33. package/out/api/parameters/getAvailableContentStates.d.ts +1 -1
  34. package/out/api/parameters/getContent.d.ts +16 -4
  35. package/out/api/parameters/getContent.js +13 -4
  36. package/out/api/parameters/getContent.js.map +1 -1
  37. package/out/api/parameters/getContentById.d.ts +12 -3
  38. package/out/api/parameters/getContentById.js +13 -4
  39. package/out/api/parameters/getContentById.js.map +1 -1
  40. package/out/api/parameters/getContentProperties.d.ts +4 -2
  41. package/out/api/parameters/getContentProperty.d.ts +10 -8
  42. package/out/api/parameters/getContentTemplates.d.ts +4 -1
  43. package/out/api/parameters/getContentVersion.d.ts +2 -1
  44. package/out/api/parameters/getContentVersions.d.ts +2 -1
  45. package/out/api/parameters/getDescendantsOfType.d.ts +12 -3
  46. package/out/api/parameters/getDescendantsOfType.js +13 -4
  47. package/out/api/parameters/getDescendantsOfType.js.map +1 -1
  48. package/out/api/parameters/getHistoryForContent.d.ts +2 -1
  49. package/out/api/parameters/getLabelsForContent.d.ts +2 -1
  50. package/out/api/parameters/getRelationship.d.ts +6 -2
  51. package/out/api/parameters/getSpaces.d.ts +10 -3
  52. package/out/api/parameters/removeGroupById.d.ts +2 -2
  53. package/out/api/parameters/removeGroupByName.d.ts +2 -2
  54. package/out/api/parameters/removeModules.d.ts +2 -1
  55. package/out/api/parameters/restoreContentVersion.d.ts +2 -1
  56. package/out/api/parameters/search.d.ts +2 -2
  57. package/out/api/parameters/updateAttachmentProperties.d.ts +15 -15
  58. package/out/api/parameters/updateUserProperty.d.ts +2 -2
  59. package/out/api/space.js +1 -0
  60. package/out/api/space.js.map +1 -1
  61. package/out/clients/baseClient.d.ts +0 -1
  62. package/out/clients/baseClient.js +2 -2
  63. package/out/clients/baseClient.js.map +1 -1
  64. package/out/clients/confluenceClient.d.ts +2 -0
  65. package/out/clients/confluenceClient.js +3 -2
  66. package/out/clients/confluenceClient.js.map +1 -1
  67. package/out/clients/serverClient.d.ts +2 -1
  68. package/out/clients/serverClient.js +3 -3
  69. package/out/clients/serverClient.js.map +1 -1
  70. package/out/config.d.ts +7 -7
  71. package/out/server/models/content.d.ts +2 -0
  72. package/out/server/parameters/createAuditRecord.d.ts +6 -2
  73. package/out/server/parameters/getAttachments.d.ts +12 -3
  74. package/out/server/parameters/getAttachments.js +13 -4
  75. package/out/server/parameters/getAttachments.js.map +1 -1
  76. package/out/services/authenticationService/authenticationService.js +1 -1
  77. package/out/services/authenticationService/authenticationService.js.map +1 -1
  78. package/out/services/authenticationService/authentications/createJWTAuthentication.js +1 -1
  79. package/out/services/authenticationService/authentications/createJWTAuthentication.js.map +1 -1
  80. package/out/services/authenticationService/base64Encoder.d.ts +1 -3
  81. package/out/services/authenticationService/base64Encoder.js +3 -5
  82. package/out/services/authenticationService/base64Encoder.js.map +1 -1
  83. package/out/utilityTypes.d.ts +5 -1
  84. package/package.json +20 -19
  85. package/src/api/audit.ts +9 -9
  86. package/src/api/content.ts +8 -8
  87. package/src/api/contentAttachments.ts +10 -10
  88. package/src/api/contentBody.ts +6 -6
  89. package/src/api/contentChildrenAndDescendants.ts +11 -11
  90. package/src/api/contentComments.ts +2 -2
  91. package/src/api/contentContentState.ts +10 -10
  92. package/src/api/contentLabels.ts +7 -7
  93. package/src/api/contentMacroBody.ts +6 -6
  94. package/src/api/contentPermissions.ts +4 -4
  95. package/src/api/contentProperties.ts +11 -11
  96. package/src/api/contentRestrictions.ts +26 -26
  97. package/src/api/contentStates.ts +12 -12
  98. package/src/api/contentVersions.ts +6 -6
  99. package/src/api/contentWatches.ts +11 -11
  100. package/src/api/dynamicModules.ts +1 -1
  101. package/src/api/experimental.ts +9 -9
  102. package/src/api/group.ts +18 -18
  103. package/src/api/inlineTasks.ts +1 -1
  104. package/src/api/labelInfo.ts +2 -2
  105. package/src/api/longRunningTask.ts +2 -2
  106. package/src/api/models/addContentRestriction.ts +8 -3
  107. package/src/api/models/appDescriptor.ts +6 -3
  108. package/src/api/models/asyncContentBody.ts +2 -2
  109. package/src/api/models/attachment.ts +1 -0
  110. package/src/api/models/attachmentContainer.ts +1 -1
  111. package/src/api/models/attachmentUpdate.ts +1 -1
  112. package/src/api/models/auditRecordCreate.ts +6 -2
  113. package/src/api/models/content.ts +2 -0
  114. package/src/api/models/contentBlueprintDraft.ts +2 -1
  115. package/src/api/models/contentCreate.ts +1 -0
  116. package/src/api/models/contentRestrictionUpdate.ts +8 -3
  117. package/src/api/models/contentTemplateUpdate.ts +4 -1
  118. package/src/api/models/contentUpdate.ts +1 -0
  119. package/src/api/models/lifecycle.ts +6 -2
  120. package/src/api/parameters/addLabelsToContent.ts +2 -1
  121. package/src/api/parameters/createContent.ts +12 -3
  122. package/src/api/parameters/createRelationship.ts +4 -1
  123. package/src/api/parameters/createUserProperty.ts +2 -2
  124. package/src/api/parameters/delete.ts +4 -1
  125. package/src/api/parameters/deleteRelationship.ts +8 -5
  126. package/src/api/parameters/deleteUserProperty.ts +2 -2
  127. package/src/api/parameters/findSourcesForTarget.ts +2 -1
  128. package/src/api/parameters/findTargetFromSource.ts +2 -1
  129. package/src/api/parameters/getAttachments.ts +12 -3
  130. package/src/api/parameters/getAvailableContentStates.ts +1 -1
  131. package/src/api/parameters/getContent.ts +16 -4
  132. package/src/api/parameters/getContentById.ts +12 -3
  133. package/src/api/parameters/getContentProperties.ts +4 -2
  134. package/src/api/parameters/getContentProperty.ts +10 -8
  135. package/src/api/parameters/getContentTemplates.ts +4 -1
  136. package/src/api/parameters/getContentVersion.ts +2 -1
  137. package/src/api/parameters/getContentVersions.ts +2 -1
  138. package/src/api/parameters/getDescendantsOfType.ts +12 -3
  139. package/src/api/parameters/getHistoryForContent.ts +2 -1
  140. package/src/api/parameters/getLabelsForContent.ts +2 -1
  141. package/src/api/parameters/getRelationship.ts +6 -2
  142. package/src/api/parameters/getSpaces.ts +10 -3
  143. package/src/api/parameters/removeGroupById.ts +2 -2
  144. package/src/api/parameters/removeGroupByName.ts +2 -2
  145. package/src/api/parameters/removeModules.ts +2 -1
  146. package/src/api/parameters/restoreContentVersion.ts +2 -1
  147. package/src/api/parameters/search.ts +2 -2
  148. package/src/api/parameters/updateAttachmentProperties.ts +15 -15
  149. package/src/api/parameters/updateUserProperty.ts +2 -2
  150. package/src/api/relation.ts +8 -8
  151. package/src/api/search.ts +7 -7
  152. package/src/api/settings.ts +12 -12
  153. package/src/api/space.ts +8 -7
  154. package/src/api/spacePermissions.ts +5 -5
  155. package/src/api/spaceProperties.ts +10 -10
  156. package/src/api/spaceSettings.ts +4 -4
  157. package/src/api/template.ts +10 -10
  158. package/src/api/themes.ts +1 -1
  159. package/src/api/users.ts +13 -13
  160. package/src/clients/baseClient.ts +4 -4
  161. package/src/clients/confluenceClient.ts +8 -0
  162. package/src/clients/serverClient.ts +7 -1
  163. package/src/config.ts +19 -11
  164. package/src/server/audit.ts +9 -9
  165. package/src/server/content.ts +49 -49
  166. package/src/server/contentBody.ts +2 -2
  167. package/src/server/group.ts +2 -2
  168. package/src/server/longTask.ts +1 -1
  169. package/src/server/models/content.ts +2 -0
  170. package/src/server/parameters/createAuditRecord.ts +6 -2
  171. package/src/server/parameters/getAttachments.ts +12 -3
  172. package/src/server/parameters/updateAttachmentData.ts +1 -1
  173. package/src/server/search.ts +2 -2
  174. package/src/server/space.ts +16 -16
  175. package/src/server/user.ts +7 -7
  176. package/src/services/authenticationService/authentications/createJWTAuthentication.ts +1 -4
  177. package/src/services/authenticationService/base64Encoder.ts +5 -5
  178. package/src/utilityTypes.ts +7 -1
@@ -42,7 +42,7 @@ export class User {
42
42
  /** Get information about the current logged-in user. */
43
43
  async getCurrentUser<T = Models.User>(
44
44
  parameters: Parameters.GetCurrentUser | undefined,
45
- callback: Callback<T>
45
+ callback: Callback<T>,
46
46
  ): Promise<void>;
47
47
  /** Get information about the current logged-in user. */
48
48
  async getCurrentUser<T = Models.User>(parameters?: Parameters.GetCurrentUser, callback?: never): Promise<T>;
@@ -64,12 +64,12 @@ export class User {
64
64
  /** Get a paginated collection of groups that the given user is a member of */
65
65
  async getGroupMembershipsForUser<T = Pagination<Models.Group>>(
66
66
  parameters: Parameters.GetGroups | undefined,
67
- callback: Callback<T>
67
+ callback: Callback<T>,
68
68
  ): Promise<void>;
69
69
  /** Get a paginated collection of groups that the given user is a member of */
70
70
  async getGroupMembershipsForUser<T = Pagination<Models.Group>>(
71
71
  parameters?: Parameters.GetGroups,
72
- callback?: never
72
+ callback?: never,
73
73
  ): Promise<T>;
74
74
  async getGroupMembershipsForUser<T = Pagination<Models.Group>>(
75
75
  parameters?: Parameters.GetGroups,
@@ -99,7 +99,7 @@ export class User {
99
99
  */
100
100
  async getContentWatchStatus<T = Models.UserWatch>(
101
101
  parameters: Parameters.GetContentWatchStatus,
102
- callback: Callback<T>
102
+ callback: Callback<T>,
103
103
  ): Promise<void>;
104
104
  /**
105
105
  * Get information about whether a user is watching a specified content.
@@ -110,7 +110,7 @@ export class User {
110
110
  */
111
111
  async getContentWatchStatus<T = Models.UserWatch>(
112
112
  parameters: Parameters.GetContentWatchStatus,
113
- callback?: never
113
+ callback?: never,
114
114
  ): Promise<T>;
115
115
  async getContentWatchStatus<T = Models.UserWatch>(
116
116
  parameters: Parameters.GetContentWatchStatus,
@@ -169,7 +169,7 @@ export class User {
169
169
  */
170
170
  async removeContentWatcher<T = void>(
171
171
  parameters: Parameters.RemoveContentWatcher,
172
- callback: Callback<T>
172
+ callback: Callback<T>,
173
173
  ): Promise<void>;
174
174
  /**
175
175
  * Delete an existing watcher for the given user and content id.
@@ -204,7 +204,7 @@ export class User {
204
204
  */
205
205
  async isWatchingSpace<T = Models.UserWatch>(
206
206
  parameters: Parameters.IsWatchingSpace,
207
- callback: Callback<T>
207
+ callback: Callback<T>,
208
208
  ): Promise<void>;
209
209
  /**
210
210
  * Get information about whether a user is watching a specified space.
@@ -8,10 +8,7 @@ export function createJWTAuthentication(
8
8
  url: string;
9
9
  },
10
10
  ) {
11
- const {
12
- method,
13
- url,
14
- } = requestData;
11
+ const { method, url } = requestData;
15
12
 
16
13
  const now = Math.floor(Date.now() / 1000);
17
14
  const expire = now + 180;
@@ -1,7 +1,5 @@
1
1
  /* eslint-disable */
2
- /**
3
- * @copyright The code was taken from the portal http://www.webtoolkit.info/javascript-base64.html
4
- */
2
+ /** @copyright The code was taken from the portal http://www.webtoolkit.info/javascript-base64.html */
5
3
 
6
4
  export namespace Base64Encoder {
7
5
  const base64Sequence = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=';
@@ -16,7 +14,7 @@ export namespace Base64Encoder {
16
14
 
17
15
  if (c < 128) {
18
16
  utftext += String.fromCharCode(c);
19
- } else if ((c > 127) && (c < 2048)) {
17
+ } else if (c > 127 && c < 2048) {
20
18
  utftext += String.fromCharCode((c >> 6) | 192);
21
19
 
22
20
  utftext += String.fromCharCode((c & 63) | 128);
@@ -61,7 +59,9 @@ export namespace Base64Encoder {
61
59
  enc4 = 64;
62
60
  }
63
61
 
64
- output += `${base64Sequence.charAt(enc1)}${base64Sequence.charAt(enc2)}${base64Sequence.charAt(enc3)}${base64Sequence.charAt(enc4)}`;
62
+ output += `${base64Sequence.charAt(enc1)}${base64Sequence.charAt(enc2)}${base64Sequence.charAt(
63
+ enc3,
64
+ )}${base64Sequence.charAt(enc4)}`;
65
65
  }
66
66
 
67
67
  return output;
@@ -2,6 +2,12 @@ export namespace UtilityTypes {
2
2
  /** Mark some properties which only the former including as optional and set the value to never */
3
3
  export type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never };
4
4
 
5
- /** get the XOR type which could make 2 types exclude each other */
5
+ /** Get the XOR type which could make 2 types exclude each other */
6
6
  export type XOR<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
7
+
8
+ /** Get the XOR type which could make 3 types exclude each other */
9
+ export type XOR3<T, U, V> = XOR<T, XOR<U, V>>;
10
+
11
+ /** Get the XOR type which could make 4 types exclude each other */
12
+ export type XOR4<T, U, V, W> = XOR<T, XOR3<U, V, W>>;
7
13
  }