❤
npm
Sign UpSign In

@managed-api/confluence-cloud-core
TypeScript icon, indicating that this package has built-in type declarations

3.0.0 • Public • Published

Managed API for Confluence Cloud

Managed API for Confluence Cloud is an API Client for Confluence Cloud by Adaptavist primarily designed for the use in ScriptRunner Connect. You can read more about Managed APIs here.

This is a runtime agnostic version of the Managed API (with core suffix) that makes it easy to port it to any runtime you may want to use this Managed API on.

Platform specific ports

Supported API calls

Porting to other runtimes

While the primary reason for creating Managed APIs was to use them in ScriptRunner Connect runtime, then you can easily port them to any runtime of your choosing.

You can do so by extending the *Core Managed API class where you'll be asked to provide implementation for getPlatformImplementation function. In this implementation you have to specify how to perform buffer encoding/decoding operations and how to perform HTTP calls:

{
    buffer: {
        encode(input: string): ArrayBuffer;
        decode(input: ArrayBuffer): string;
    },
    performHttpCall(request: Request): Promise<Response>
}

Here is an example how to create a Node port of the Managed API:

import { ConfluenceCloudApiCore } from "@managed-api/confluence-cloud-core";
import { PlatformImplementation, Request, Response, Headers } from "@managed-api/commons-core";
import fetch from "node-fetch";

export class ConfluenceCloudApi extends ConfluenceCloudApiCore {
    constructor(private baseUrl: string, private authToken: string) {
        super();
    }

    protected getPlatformImplementation(): PlatformImplementation {
        return {
            buffer: {
                encode: (input) => Buffer.from(input, 'utf-8'),
                decode: (input) => Buffer.from(input).toString('utf-8')
            },
            performHttpCall: (request) => this.performHttpCall(request)
        };
    }
    
    private async performHttpCall(request: Request): Promise<Response> {
        const requestUrl = `${this.baseUrl}${request.url}`; // Substitute base URL
        request.headers.set('Authorization', `Basic ${this.authToken}`); // Substitute auth token
        const response = await fetch(requestUrl, {
            method: request.method,
            headers: request.headers as any,
            body: request.method.toLowerCase() !== 'get' ? Buffer.from((await request.arrayBuffer()) ?? new ArrayBuffer(0)) : undefined
        });

        const apiHeaders = new Headers();
        response.headers.forEach((value, key) => apiHeaders.append(key, value));

        const body = await response.arrayBuffer();

        return super.buildResponse(response.url, response.status, response.statusText, apiHeaders, body);
    }
}

Please note that the authentication handling details may not be accurate and serve as an example. If you wish to use these Managed APIs without having to concern yourself how to deal with and secure authentication details when working with APIs, then feel free to evaluate ScriptRunner Connect platform.

Contact

At this time Managed APIs are unlicensed and close sourced, but feel free to drop an email to eknoll@adaptavist.com for ideas, suggestions and improvements.

Changelog

3.0.0

  • Changed the following methods:

    • Content.Attachment.updateAttachmentProperties - Request body parameters got updated.
    • Content.Move.movePageToNewLocationRelativeToTargetPage - Path got fixed.
    • Content.Restriction.Group.getGroupStatus - groupName got replaced by groupId.
    • Content.Restriction.Group.addGroup - groupName got replaced by groupId.
    • Content.Restriction.Group.removeGroup - groupName got replaced by groupId.
    • UserGroup.deleteUserGroup - name parameter got replaced by id.
    • UserGroup.getUserGroupByName - Method was removed, alternative is UserGroup.getUserGroupById.
    • UserGroup.Member.getMembersByName - Method was removed, alternative is UserGroup.Member.getMembersById.
    • UserGroup.Member.getMembersById - expand parameter was added.
    • UserGroup.Member.addMemberByName - Method was removed, alternative is UserGroup.Member.addMemberById.
    • UserGroup.Member.removeMember - Method was removed, alternative is UserGroup.Member.removeMemberById.
    • LongRunningTask.getLongRunningTasks - Key parameter was added.
    • Search.searchUsers - sitePermissionTypeFilter parameter was added.
    • Template.getBlueprintTemplates - body.storage option was added to expand.
    • Template.getContentTemplates - body.storage option was added to expand.
    • User.getUsersWithIds - isExternalCollaborator option was added to expand, limit was removed.
    • User.getUserAccountIds - Method was removed.

  • The following methods are deprecated:

  • The following methods are added:

2.1.0

2.0.0

  • Breaking change: URL and query string parameters are now URL encoded, meaning if you encoded them explicitly before you have to remove your own encoding, otherwise they will get double encoded.

0.11.0

Copyright Adaptavist 2025 (c) All rights reserved

Readme

Keywords

none

Package Sidebar

Install

npm i @managed-api/confluence-cloud-core

Weekly Downloads

9

Version

3.0.0

License

UNLICENSED

Unpacked Size

1.19 MB

Total Files

876

Last publish

Collaborators

  • skitson
  • ratwal
  • mtapsi
  • jtrumm
  • ssarapov
  • theshumanator
  • eknoll
  • jsaks
  • adaptavist-horizon-dev
Try on RunKit
Report malware