Releases: MrRefactoring/confluence.js
Releases · MrRefactoring/confluence.js
v2.1.0
Deprecations ⚠️
- Package dependencies:
- Replaced deprecated
atlassian-jwt
with@atlassian/atlassian-jwt
.
- Replaced deprecated
- Content APIs:
- Deprecated all content-related methods due to Confluence API changes:
content.getContent
,content.createContent
,content.getContentById
,content.updateContent
,content.deleteContent
content.getHistoryForContent
,contentAttachments.getAttachments
,contentBody.convertContentBody
contentChildrenAndDescendants.getContentChildren
,contentChildrenAndDescendants.getContentChildrenByType
ContentComments
,contentLabels.getLabelsForContent
,ContentProperties
contentVersions.getContentVersions
,contentVersions.getContentVersion
- Deprecated all content-related methods due to Confluence API changes:
- Group APIs:
- Deprecated group-related methods:
group.removeGroup
,group.getGroupByQueryParam
,group.getGroupByName
group.getMembersByQueryParam
,group.getGroupMembers
- Deprecated group-related methods:
- Other APIs:
- Deprecated
InlineTasks
,SpaceProperties
,users.getBulkUserMigration
- Deprecated content restriction methods:
contentRestrictions.getContentRestrictionStatusForGroup
contentRestrictions.addGroupToContentRestriction
contentRestrictions.removeGroupByName
- Deprecated
settings.setLookAndFeelSettings
- Deprecated space-related methods:
space.getSpaces
,space.getSpace
,space.getContentForSpace
,space.getContentByTypeForSpace
- Deprecated
New Features ✨
- New endpoints:
- Added
contentBody.bulkAsyncConvertContentBodyResponse
andcontentBody.bulkAsyncConvertContentBodyRequest
- Added
contentStates.getContentsWithState
method - Introduced new
UserProperties
API
- Added
- API improvements:
- Added
status
property tocontentAttachments.downloadAttachment
- Added
key
property tolongRunningTask.getTasks
- Added
sitePermissionTypeFilter
property tosearch.searchUser
- Added
alias
property to bothspace.createSpace
andspace.createPrivateSpace
- #145 Added
start
andlimit
properties tocontentChildrenAndDescendants.getContentChildren
. Thanks to @javierbrea for requesting this feature.
- Added
API Changes 🔄
- Experimental methods moved:
- Moved experimental user property methods to
userProperties
namespace:getUserProperties
,getUserProperty
,createUserProperty
,updateUserProperty
,deleteUserProperty
- Moved experimental user property methods to
- Parameter fixes:
- Simplified
group.removeGroupById
parameters (no longer requiresoperationKey
andgroupId
)
- Simplified
Other Changes
- Package structure:
- Reordered
exports
inpackage.json
for better module resolution
- Reordered
v2.0.0
Breaking Changes ⚠️
- Deprecated APIs removed: APIs marked as deprecated in v1.x have been removed.
- Server API removed: Server-related code and support are no longer included.
- Node.js version: Minimum supported version is now Node 20.
- Upgrade your environment if using Node < 20.
Major Improvements ✨
- Dual CJS/ESM support: Added ESM (ECMAScript Modules) support alongside existing CommonJS.
- Use
import
(ESM) orrequire
(CJS) — both work. - ESM entry point:
dist/esm/index.js
(via"module"
field inpackage.json
).
- Use
- Testing: Replaced
ava
withvitest
for faster, modern testing. - Security: Fixed JWT expiry time handling.
- Tokens now respect configured TTL consistently.
Other Changes
- Telemetry: All telemetry/tracking code has been removed.
- No data is collected by the package.
Release v1.7.4
Release v1.7.3
[1.7.3] - 2024-03-04
- Dependencies updated
- Expand properties added for few endpoints
Release v1.7.2
Changes in this version:
- Implemented automatic GitHub release and tag creation in the CI pipeline. This enhancement, addressed in issue #133, automates the process of creating GitHub releases and tags corresponding to new versions, streamlining the release process.
- Thanks to Joe Ennever, the
searchContentByCQL
method has been enhanced with anexpand
property. This addition, merged in pull request #134, allows for more flexible and detailed content queries in the Confluence API.
v1.7.0
apiPrefix
was added to the code for allowing to use of custom API prefix for all clients. Thanks to Petr Plenkov for the pull request.
v1.6.3
atlas_doc_format
added to some models. Thanks to Andrew McClenaghan for the pull request.
v1.6.2
- Badge fixed
- Dependencies updated
v1.6.1
AuthenticationService
added to export facade. Thanks to Andrew McClenaghan for this improvement.
v1.6.0
Cloud API:
asyncConvertContentBodyRequest
method added toContentBody
API.asyncConvertContentBodyResponse
method added toContentBody
API.ContentContentState
API are deprecated. UseContentStates
instead.getAndConvertMacroBodyByMacroId
method added toContentMacroBody
API.getAndAsyncConvertMacroBodyByMacroId
method added toContentMacroBody
API.registerModules
method was fixed by adding a body to the request.DynamicModules
API.- Other fixes and improvements. (like
expand
property adding).