npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@managed-api/confluence-cloud-v2-core

v2.1.0

Published

Adaptavist Managed API for Confluence Cloud v2

Downloads

252

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

ratwalratwalskitsonskitsonmtapsimtapsijtrummjtrummtheshumanatortheshumanatorssarapovssarapovadaptavist-horizon-devadaptavist-horizon-devjsaksjsakseknolleknoll

Keywords

Readme

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-v2-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 [email protected] for ideas, suggestions and improvements.

Changelog

2.1.0

  • Updated OpenApi Specification.

    • Added new fields include-labels, include-properties, include-operations, include-versions and include-version to Attachment.getAttachmentById.
    • Added new field purge toAttachment.deleteAttachment.
    • Added new field purge toCustomContent.deleteCustomContent.
    • Added new field version to Comment.Attachment.getComments.
    • Added new fields include-labels, include-properties, include-operations, include-versions, include-version and include-favorited-by-current-user-status to CustomContent.getCustomContentById.
    • Added new fields draft and purge to BlogPost.deleteBlogPost.
    • Added new fields draft and purge to Page.deletePage.
    • Added new field root-level to Page.createPage.
    • Added new fields include-labels, include-properties, include-operations, include-versions, include-version, include-likes, and include-favorited-by-current-user-status to Page.getPageById.
    • Added new fields favorited-by and not-favorited-by to Space.getSpaces.
    • Added new fields include-labels, include-properties, include-operationsand include-permissions to Space.getSpaceById.
    • Added new fields include-properties, include-operations, include-versions, include-version and include-likes to Comment.Footer.getCommentById.
    • Added new fields include-properties, include-operations, include-versions, include-version and include-likes to Comment.Inline.getCommentById.
    • Added new field body-format to Task.updateTask.
    • Removed deleted from status in BlogPost.updateBlogPost.
    • Added new field ownerId to Page.updatePage.
    • Attachment definition got changed to AttachmentSingle.
    • New properties in PageSingle definition.
    • New properties in PageBulk definition.

  • Added support for the following Comment.CustomContent method:

  • Added support for the following Whiteboard methods:

    • Create whiteboard that can be used as Whiteboard.createWhiteboard or All.getWhiteboard.
    • Get whiteboard by id that can be used as Whiteboard.getWhiteboardById or All.getWhiteboardById.
    • Delete whiteboard that can be used as Whiteboard.deleteWhiteboard or All.deleteWhiteboard.

  • Added support for the following Content.Property.Whiteboard methods:

  • Added support for the following Ancestor method:

  • Fixed following methods:

    • Get footer comments that can be used as Comment.Footer.getComments or All.getFooterComments.
    • updateComment that can be used as Comment.Footer.updateComment or All.updateFooterComment.
    • deleteComment that can be used as Comment.Footer.deleteComment or All.deleteFooterComment.
    • getCommentById that can be used as Comment.Inline.getCommentById or All.getInlineCommentById.
    • updateComment that can be used as Comment.Inline.updateComment or All.updateInlineComment.
    • deleteComment that can be used as Comment.Inline.deleteComment or All.deleteInlineComment.

  • The following methods are deprecated:

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.

1.0.0

  • Added support for the following Attachment methods:

    • Get attachments that can be used as Attachment.getAttachments or All.getAttachments.
    • Get attachment by id that can be used as Attachment.getAttachmentById or All.getAttachmentByIds.
    • Delete attachment that can be used as Attachment.deleteAttachment or All.deleteAttachment.

  • Added support for the following Attachment.BlogPost method:

  • Added support for the following Attachment.CustomContent method:

  • Added support for the following Attachment.Label method:

  • Added support for the following Attachment.Page method:

  • Added support for the following Ancestor method:

  • Added support for the following BlogPost methods:

  • Added support for the following Children methods:

  • Added support for the following Comment.Attachment method:

  • Added support for the following Comment.Footer.Page method:

  • Added support for the following Comment.Inline.Page method:

  • Added support for the following Comment.Footer.BlogPost method:

  • Added support for the following Comment.Inline.BlogPost method:

  • Added support for the following Comment.Footer methods:

    • Get footer comments that can be used as Comment.Footer.getComments or All.getFooterComments.
    • Create footer comment that can be used as Comment.Footer.createComment or All.createFooterComment.
    • getCommentById that can be used as Comment.Footer.getCommentById or All.getFooterCommentById.
    • updateComment that can be used as Comment.Footer.updateComment or All.updateFooterComment.
    • deleteComment that can be used as Comment.Footer.deleteComment or All.deleteFooterComment.
    • Get children footer comments that can be used as Comment.Footer.getChildrenComments or All.getChildrenFooterComments.

  • Added support for the following Comment.Inline methods:

    • Get inline comments that can be used as Comment.Inline.getComments or All.getInlineComments.
    • Create inline comment that can be used as Comment.Inline.createComment or All.createInlineComment.
    • getCommentById that can be used as Comment.Inline.getCommentById or All.getInlineCommentById.
    • updateComment that can be used as Comment.Inline.updateComment or All.updateInlineComment.
    • deleteComment that can be used as Comment.Inline.deleteComment or All.deleteInlineComment.
    • Get children inline comments that can be used as Comment.Inline.getChildrenComments or All.getChildrenInlineComments.

  • Added support for the following Content method:

  • Added support for the following Content.Property.Attachment methods:

  • Added support for the following Content.Property.BlogPost methods:

  • Added support for the following Content.Property.CustomContent methods:

  • Added support for the following Content.Property.Page methods:

  • Added support for the following Content.Property.Comment methods:

  • Added support for the following CustomContent.BlogPost method:

  • Added support for the following CustomContent methods:

  • Added support for the following CustomContent.Page method:

  • Added support for the following CustomContent.Space method:

  • Added support for the following Label.Attachment method:

  • Added support for the following Label.BlogPost method:

  • Added support for the following Label.CustomContent method:

  • Added support for the following Label.Page method:

  • Added support for the following Label method:

    • Get labels that can be used as Label.getLabels or All.getLabels.

  • Added support for the following Label.Space methods:

  • Added support for the following Like.BlogPost methods:

  • Added support for the following Like.Page methods: