confluence.js 1.3.1 → 1.5.0

package/src/api/parameters/removeContentState.ts

@@ -0,0 +1,4 @@
+export interface RemoveContentState {
+  /** The Id of the content whose content state is to be set. */
+  contentId: string;
+}

package/src/api/parameters/searchGroups.ts

@@ -5,4 +5,9 @@ export interface SearchGroups {
   start?: number;
   /** The maximum number of groups to return per page. Note, this is restricted to a maximum limit of 200 groups. */
   limit?: number;
+  /**
+   * Whether to include total size parameter in the results. Note, fetching total size property is an expensive
+   * operation; use it if your use case needs this value.
+   */
+  shouldReturnTotalSize?: boolean;
 }

package/src/api/parameters/setContentState.ts

@@ -0,0 +1,8 @@
+export interface SetContentState {
+  /** The Id of the content whose content state is to be set. */
+  contentId: string;
+  /** The Id of the content */
+  contentStateId?: number;
+  name?: string;
+  color?: string;
+}

package/src/api/parameters/updateAttachmentData.ts

@@ -1,8 +1,11 @@
-import { AttachmentUpdate } from '../models';
+import { CreateAttachments } from './createAttachments';
 
-export interface UpdateAttachmentData extends AttachmentUpdate {
+export interface UpdateAttachmentData {
   /** The ID of the content that the attachment is attached to. */
   id: string;
   /** The ID of the attachment to update. */
   attachmentId: string;
+
+  /** Attachment data to update. */
+  attachment: CreateAttachments.Attachment;
 }

package/src/api/parameters/updateAttachmentProperties.ts

@@ -1,4 +1,15 @@
-import { AttachmentUpdate } from '../models';
+import {
+  AttachmentMetadata,
+  Container,
+  Content,
+  ContentChildren,
+  ContentChildType,
+  ContentHistory,
+  GenericLinks,
+  OperationCheckResult,
+  Space,
+  Version,
+} from '../models';
 
 export interface UpdateAttachmentProperties {
   /** The ID of the content that the attachment is attached to. */
@@ -6,5 +17,51 @@ export interface UpdateAttachmentProperties {
   /** The ID of the attachment to update. */
   attachmentId: string;
 
-  body: AttachmentUpdate;
+  /** @deprecated Use `update` property instead. */
+  body?: UpdateAttachmentProperties.Properties;
+
+  update?: UpdateAttachmentProperties.Properties;
+}
+
+export namespace UpdateAttachmentProperties {
+  export interface Properties {
+    [key: string]: any;
+
+    id: string;
+    type: 'page' | 'blogpost' | 'attachment' | 'content' | string;
+    status: 'current' | 'draft' | string;
+    title?: string;
+    space?: Space;
+    history?: ContentHistory;
+    version: Partial<Version>;
+    ancestors?: Content[];
+    operations?: OperationCheckResult[];
+    children?: ContentChildren;
+    childTypes?: ContentChildType;
+    descendants?: ContentChildren;
+    container?: Container;
+    body?: any;
+    restrictions?: any;
+    metadata?: Partial<AttachmentMetadata>;
+    macroRenderedOutput?: any;
+    extensions?: any;
+    _expandable?: {
+      'childTypes': string;
+      'container': string;
+      'metadata': string;
+      'operations': string;
+      'children': string;
+      'restrictions': string;
+      'history': string;
+      'ancestors': string;
+      'body': string;
+      'version': string;
+      'descendants': string;
+      'space': string;
+      'extensions': string;
+      'schedulePublishDate': string;
+      'macroRenderedOutput': string
+    };
+    _links?: GenericLinks;
+  }
 }

package/src/api/parameters/updateUserProperty.ts

@@ -0,0 +1,11 @@
+import { UserPropertyUpdate } from '../models';
+
+export interface UpdateUserProperty extends UserPropertyUpdate {
+  /**
+   * The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For
+   * example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
+   */
+  userId: string;
+  /** The key of the user property. */
+  key: string;
+}

package/src/api/relation.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { RequestConfig } from '../requestConfig';
 
 export class Relation {

package/src/api/search.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { RequestConfig } from '../requestConfig';
 
 export class Search {

package/src/api/settings.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { RequestConfig } from '../requestConfig';
 
 export class Settings {
@@ -230,4 +230,26 @@ export class Settings {
 
     return this.client.sendRequest(config, callback);
   }
+
+  /** Gets Content State settings for a space */
+  async getContentStateSettings<T = Models.ContentStateSettings>(
+    parameters: Parameters.GetContentStateSettings,
+    callback: Callback<T>
+  ): Promise<void>;
+  /** Gets Content State settings for a space */
+  async getContentStateSettings<T = Models.ContentStateSettings>(
+    parameters: Parameters.GetContentStateSettings,
+    callback?: never
+  ): Promise<T>;
+  async getContentStateSettings<T = Models.ContentStateSettings>(
+    parameters: Parameters.GetContentStateSettings,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/space/${parameters.spaceKey}/state/settings`,
+      method: 'GET',
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
 }

package/src/api/space.ts

@@ -1,7 +1,8 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
+import { paramSerializer } from '../paramSerializer';
 import { RequestConfig } from '../requestConfig';
 
 export class Space {
@@ -31,7 +32,7 @@ export class Space {
       url: '/api/space',
       method: 'GET',
       params: {
-        spaceKey: () => parameters?.spaceKey?.map((key) => `spaceKey=${key}`).join('&'),
+        spaceKey: paramSerializer('spaceKey', parameters?.spaceKey),
         spaceId: parameters?.spaceId,
         type: parameters?.type,
         status: parameters?.status,
@@ -129,6 +130,9 @@ export class Space {
     const config: RequestConfig = {
       url: `/api/space/${parameters.spaceKey}`,
       method: 'GET',
+      params: {
+        expand: parameters.expand,
+      },
     };
 
     return this.client.sendRequest(config, callback);

package/src/api/spacePermissions.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { RequestConfig } from '../requestConfig';
 
 export class SpacePermissions {

package/src/api/spaceProperties.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { RequestConfig } from '../requestConfig';
 
 export class SpaceProperties {

package/src/api/spaceSettings.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { RequestConfig } from '../requestConfig';
 
 export class SpaceSettings {

package/src/api/template.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { RequestConfig } from '../requestConfig';
 
 export class Template {

package/src/api/themes.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { RequestConfig } from '../requestConfig';
 
 export class Themes {

package/src/api/users.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { RequestConfig } from '../requestConfig';
 
 export class Users {
@@ -119,7 +119,7 @@ export class Users {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
    */
-  async getGroupMembershipsForUser<T = Models.GroupArray>(
+  async getGroupMembershipsForUser<T = Models.GroupArrayWithLinks>(
     parameters: Parameters.GetGroupMembershipsForUser,
     callback: Callback<T>
   ): Promise<void>;
@@ -129,11 +129,11 @@ export class Users {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
    */
-  async getGroupMembershipsForUser<T = Models.GroupArray>(
+  async getGroupMembershipsForUser<T = Models.GroupArrayWithLinks>(
     parameters: Parameters.GetGroupMembershipsForUser,
     callback?: never
   ): Promise<T>;
-  async getGroupMembershipsForUser<T = Models.GroupArray>(
+  async getGroupMembershipsForUser<T = Models.GroupArrayWithLinks>(
     parameters: Parameters.GetGroupMembershipsForUser,
     callback?: Callback<T>,
   ): Promise<void | T> {

package/src/clients/baseClient.ts

@@ -1,9 +1,9 @@
-import axios, { AxiosInstance } from 'axios';
-import type { Client } from './client';
+import { AuthenticationService } from '../services/authenticationService';
 import type { Callback } from '../callback';
+import type { Client } from './client';
 import type { Config } from '../config';
-import { AuthenticationService } from '../services/authenticationService';
 import type { RequestConfig } from '../requestConfig';
+import axios, { AxiosInstance } from 'axios';
 
 const ATLASSIAN_TOKEN_CHECK_FLAG = 'X-Atlassian-Token';
 const ATLASSIAN_TOKEN_CHECK_NOCHECK_VALUE = 'no-check';
@@ -116,6 +116,8 @@ export class BaseClient implements Client {
 
       return responseHandler(response.data);
     } catch (e: any) {
+      const err = this.config.newErrorHandling && e.isAxiosError ? e.response.data : e;
+
       const callbackErrorHandler = callback && ((error: Config.Error) => callback(error));
       const defaultErrorHandler = (error: Error) => {
         throw error;
@@ -123,9 +125,9 @@ export class BaseClient implements Client {
 
       const errorHandler = callbackErrorHandler ?? defaultErrorHandler;
 
-      this.config.middlewares?.onError?.(e);
+      this.config.middlewares?.onError?.(err);
 
-      return errorHandler(e);
+      return errorHandler(err);
     }
   }
 }

package/src/clients/confluenceClient.ts

@@ -1,11 +1,13 @@
 import { BaseClient } from './baseClient';
 import {
+  Analytics,
   Audit,
   Content,
   ContentAttachments,
   ContentBody,
   ContentChildrenAndDescendants,
   ContentComments,
+  ContentContentState,
   ContentLabels,
   ContentMacroBody,
   ContentPermissions,
@@ -32,12 +34,14 @@ import {
 } from '../api';
 
 export class ConfluenceClient extends BaseClient {
+  analytics = new Analytics(this);
   audit = new Audit(this);
   content = new Content(this);
   contentAttachments = new ContentAttachments(this);
   contentBody = new ContentBody(this);
   contentChildrenAndDescendants = new ContentChildrenAndDescendants(this);
   contentComments = new ContentComments(this);
+  contentContentState = new ContentContentState(this);
   contentLabels = new ContentLabels(this);
   contentMacroBody = new ContentMacroBody(this);
   contentPermissions = new ContentPermissions(this);

package/src/config.ts

@@ -13,6 +13,8 @@ export interface Config {
    * Adds `'X-Atlassian-Token': 'no-check'` to each request header
    */
   noCheckAtlassianToken?: boolean;
+  /** Enable new API error handling. `false` by default. */
+  newErrorHandling?: boolean;
 }
 
 export namespace Config {
@@ -23,11 +25,13 @@ export namespace Config {
 
   export type Authentication = UtilityTypes.XOR<{
     jwt: Authentication.JWT;
+  }, UtilityTypes.XOR<{
+    personalAccessToken: Authentication.PersonalAccessToken;
   }, UtilityTypes.XOR<{
     basic: Authentication.Basic;
   }, {
     oauth2: Authentication.OAuth2;
-  }>>;
+  }>>>;
 
   export interface Middlewares {
     onError?: Config.Middlewares.OnErrorHandler;
@@ -40,10 +44,12 @@ export namespace Config {
   }
 
   export namespace Authentication {
+    export type PersonalAccessToken = string;
+
     export type JWT = {
       /** The key from the app descriptor. */
       issuer: string;
-      /** The sharedsecret key received during the app installation handshake */
+      /** The shared secret key received during the app installation handshake */
       secret: string;
       /** Token expiry time (default 3 minutes after issuing) */
       expiryTimeSeconds?: number;

package/src/index.ts

@@ -2,8 +2,12 @@ export * from './clients';
 export * from './config';
 export * from './requestConfig';
 export * from './callback';
+export * from './pagination';
+export * from './utilityTypes';
 
 export * as Api from './api';
 export * as Server from './server';
 export * as Models from './api/models';
 export * as Parameters from './api/parameters';
+export * as ServerModels from './server/models';
+export * as ServerParameters from './server/parameters';

package/src/paramSerializer.ts

@@ -0,0 +1,15 @@
+export function paramSerializer(key: string, values?: string | string[]) {
+  if (typeof values === 'string') {
+    return () => `${key}=${values}`;
+  }
+
+  if (!values) {
+    return undefined;
+  }
+
+  if (!values.length) {
+    return '';
+  }
+
+  return () => values.map(value => `${key}=${value}`).join('&');
+}

package/src/server/audit.ts

@@ -1,9 +1,9 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
-import { RequestConfig } from '../requestConfig';
+import { Client } from '../clients';
 import { Pagination } from '../pagination';
+import { RequestConfig } from '../requestConfig';
 
 export class Audit {
   constructor(private client: Client) {}

package/src/server/content.ts

@@ -1,9 +1,9 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
-import { RequestConfig } from '../requestConfig';
+import { Client } from '../clients';
 import { Pagination } from '../pagination';
+import { RequestConfig } from '../requestConfig';
 
 export class Content {
   constructor(private client: Client) {}

package/src/server/contentBody.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { RequestConfig } from '../requestConfig';
 
 export class ContentBody {

package/src/server/group.ts

@@ -1,9 +1,9 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
-import { RequestConfig } from '../requestConfig';
+import { Client } from '../clients';
 import { Pagination } from '../pagination';
+import { RequestConfig } from '../requestConfig';
 
 export class Group {
   constructor(private client: Client) {}

package/src/server/longTask.ts

@@ -1,9 +1,9 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
-import { RequestConfig } from '../requestConfig';
+import { Client } from '../clients';
 import { Pagination } from '../pagination';
+import { RequestConfig } from '../requestConfig';
 
 export class LongTask {
   constructor(private client: Client) {}

package/src/server/models/content.ts

@@ -1,12 +1,12 @@
-import { Space } from './space';
-import { ContentHistory } from './contentHistory';
-import { Version } from './version';
-import { OperationCheckResult } from './operationCheckResult';
-import { ContentChildren } from './contentChildren';
-import { ContentChildType } from './contentChildType';
 import { Container } from './container';
 import { ContentBody } from './contentBody';
+import { ContentChildren } from './contentChildren';
+import { ContentChildType } from './contentChildType';
+import { ContentHistory } from './contentHistory';
 import { ContentRestriction } from './contentRestriction';
+import { OperationCheckResult } from './operationCheckResult';
+import { Space } from './space';
+import { Version } from './version';
 
 /** Base object for all content types. */
 export interface Content {

package/src/server/models/contentChildren.ts

@@ -1,5 +1,5 @@
-import { Pagination } from '../../pagination';
 import { Content } from './content';
+import { Pagination } from '../../pagination';
 
 export interface ContentChildren {
   attachment?: Pagination<Content>;

package/src/server/models/contentHistory.ts

@@ -1,6 +1,6 @@
-import { Version } from './version';
-import { UsersUserKeys } from './usersUserKeys';
 import { User } from './user';
+import { UsersUserKeys } from './usersUserKeys';
+import { Version } from './version';
 
 export interface ContentHistory {
   latest: boolean;

package/src/server/models/contentLookAndFeel.ts

@@ -1,5 +1,5 @@
-import { ScreenLookAndFeel } from './screenLookAndFeel';
 import { ContainerLookAndFeel } from './containerLookAndFeel';
+import { ScreenLookAndFeel } from './screenLookAndFeel';
 
 export interface ContentLookAndFeel {
   screen: ScreenLookAndFeel;

package/src/server/models/contentRestriction.ts

@@ -1,6 +1,6 @@
-import { UserArray } from './userArray';
-import { GroupArray } from './groupArray';
 import { Content } from './content';
+import { GroupArray } from './groupArray';
+import { UserArray } from './userArray';
 
 export interface ContentRestriction {
   operation: string;

package/src/server/models/lookAndFeel.ts

@@ -1,6 +1,6 @@
-import { MenusLookAndFeel } from './menusLookAndFeel';
-import { HeaderLookAndFeel } from './headerLookAndFeel';
 import { ContentLookAndFeel } from './contentLookAndFeel';
+import { HeaderLookAndFeel } from './headerLookAndFeel';
+import { MenusLookAndFeel } from './menusLookAndFeel';
 
 export interface LookAndFeel {
   headings: {

package/src/server/models/searchResult.ts

@@ -1,6 +1,6 @@
-import { Content } from './content';
-import { ContainerSummary } from './containerSummary';
 import { Breadcrumb } from './breadcrumb';
+import { ContainerSummary } from './containerSummary';
+import { Content } from './content';
 
 export interface SearchResult {
   content: Content;

package/src/server/models/space.ts

@@ -1,12 +1,12 @@
-import { Icon } from './icon';
-import { SpaceDescription } from './spaceDescription';
 import { Content } from './content';
+import { Icon } from './icon';
 import { LabelArray } from './labelArray';
+import { LookAndFeel } from './lookAndFeel';
 import { OperationCheckResult } from './operationCheckResult';
+import { SpaceDescription } from './spaceDescription';
 import { SpacePermission } from './spacePermission';
 import { SpaceSettings } from './spaceSettings';
 import { Theme } from './theme';
-import { LookAndFeel } from './lookAndFeel';
 
 export interface Space {
   id: number;

package/src/server/models/spacePermission.ts

@@ -1,6 +1,6 @@
-import { User } from './user';
 import { Group } from './group';
 import { OperationCheckResult } from './operationCheckResult';
+import { User } from './user';
 
 /**
  * This object represents a permission for given space. Permissions consist of* at least one operation object with an

package/src/server/models/user.ts

@@ -1,7 +1,7 @@
 import { Icon } from './icon';
 import { OperationCheckResult } from './operationCheckResult';
-import { UserDetails } from './userDetails';
 import { Space } from './space';
+import { UserDetails } from './userDetails';
 
 export interface User {
   type: string;

package/src/server/models/version.ts

@@ -1,5 +1,5 @@
-import { User } from './user';
 import { Content } from './content';
+import { User } from './user';
 import { UsersUserKeys } from './usersUserKeys';
 
 export interface Version {

package/src/server/search.ts

@@ -1,9 +1,9 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
-import { RequestConfig } from '../requestConfig';
+import { Client } from '../clients';
 import { Pagination } from '../pagination';
+import { RequestConfig } from '../requestConfig';
 
 export class Search {
   constructor(private client: Client) {}

package/src/server/space.ts

@@ -1,9 +1,9 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
-import { RequestConfig } from '../requestConfig';
+import { Client } from '../clients';
 import { Pagination } from '../pagination';
+import { RequestConfig } from '../requestConfig';
 
 export class Space {
   constructor(private client: Client) {}

package/src/server/user.ts

@@ -1,9 +1,9 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
-import { RequestConfig } from '../requestConfig';
+import { Client } from '../clients';
 import { Pagination } from '../pagination';
+import { RequestConfig } from '../requestConfig';
 
 export class User {
   constructor(private client: Client) {}